You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/carts/by-project-key-in-store-key-by-store-key-carts-by-id-request-builder.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder {
52
52
)
53
53
}
54
54
/**
55
-
* Checks if a Cart exists for the provided `id` in a Store. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
55
+
* Checks if a Cart exists with the provided `id` in a Store. Returns a `200 OK` status if the Cart exists or [Not Found](/../api/errors#404-not-found) otherwise.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/payments/by-project-key-me-payments-by-id-request-builder.ts
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ export class ByProjectKeyMePaymentsByIDRequestBuilder {
20
20
}
21
21
){}
22
22
/**
23
-
* Returns a [Payment](/projects/me-payments#mypayment) for a given `id`.
23
+
* Retrieves a [Payment](/projects/me-payments#mypayment) with the provided `id` for the authenticated Customer or anonymous user.
24
24
*/
25
25
publicget(methodArgs?: {
26
26
queryArgs?: {
@@ -46,7 +46,7 @@ export class ByProjectKeyMePaymentsByIDRequestBuilder {
46
46
)
47
47
}
48
48
/**
49
-
* Checks if a [Payment](/projects/me-payments#mypayment) exists with the provided `id`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.
49
+
* Checks if a [Payment](/projects/me-payments#mypayment) exists with the provided `id` for the authenticated Customer or anonymous user. Returns a `200 OK` status if the Payment exists, or [Not Found](/../api/errors#404-not-found) otherwise.
50
50
*/
51
51
publichead(methodArgs?: {
52
52
headers?: {
@@ -67,8 +67,8 @@ export class ByProjectKeyMePaymentsByIDRequestBuilder {
67
67
)
68
68
}
69
69
/**
70
-
* Updates a [Payment](/projects/me-payments#mypayment) for a given `id`.
71
-
* You can only update a [Payment](/projects/me-payments#mypayment) if it has no [Transactions](ctp:api:type:Transaction).
70
+
* Updates a [Payment](/projects/me-payments#mypayment) for the authenticated Customer or anonymous user using one or more [update actions](/../api/projects/me-payments#update-actions).
71
+
* You can only update a Payment if it has no [Transactions](ctp:api:type:Transaction).
72
72
*
73
73
*/
74
74
publicpost(methodArgs: {
@@ -98,8 +98,8 @@ export class ByProjectKeyMePaymentsByIDRequestBuilder {
98
98
)
99
99
}
100
100
/**
101
-
* Deletes the [Payment](/projects/me-payments#mypayment) for a given `id`.
102
-
* You can only delete a [Payment](/projects/me-payments#mypayment) if it has no [Transactions](ctp:api:type:Transaction).
101
+
* Deletes a [Payment](/projects/me-payments#mypayment) with the provided `id` for the authenticated Customer or anonymous user.
102
+
* You can only delete a Payment if it has no [Transactions](ctp:api:type:Transaction).
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/payments/by-project-key-me-payments-request-builder.ts
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ export class ByProjectKeyMePaymentsRequestBuilder {
37
37
}
38
38
39
39
/**
40
-
* Returns all [Payments](/projects/me-payments#mypayment) that match a given Query Predicate.
40
+
* Retrieves all [Payments](/projects/me-payments#mypayment) for the authenticated Customer or anonymous user.
41
41
*/
42
42
publicget(methodArgs?: {
43
43
queryArgs?: {
@@ -68,7 +68,7 @@ export class ByProjectKeyMePaymentsRequestBuilder {
68
68
)
69
69
}
70
70
/**
71
-
* Checks if a [Payment](/projects/me-payments#mypayment) exists for the provided query predicate. Returns a `200 OK` status if any Payments match the query predicate, or a `404 Not Found` otherwise.
71
+
* Checks if one or more [Payments](/projects/me-payments#mypayment) exist for the provided query predicate for the authenticated Customer or anonymous user. Returns a `200 OK` status if any Payments match the query predicate, or [Not Found](/../api/errors#404-not-found) otherwise.
72
72
*/
73
73
publichead(methodArgs?: {
74
74
queryArgs?: {
@@ -94,7 +94,7 @@ export class ByProjectKeyMePaymentsRequestBuilder {
94
94
)
95
95
}
96
96
/**
97
-
* Creates a [Payment](/projects/me-payments#mypayment) for the Customer or an anonymous user.
97
+
* Creates a [Payment](/projects/me-payments#mypayment) for the authenticated Customer or anonymous user.
98
98
* Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/payments/by-project-key-payments-by-id-request-builder.ts
+10-1Lines changed: 10 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,9 @@ export class ByProjectKeyPaymentsByIDRequestBuilder {
19
19
baseUri?: string
20
20
}
21
21
){}
22
+
/**
23
+
* Retrieves a Payment with the provided `id`.
24
+
*/
22
25
publicget(methodArgs?: {
23
26
queryArgs?: {
24
27
expand?: string|string[]
@@ -43,7 +46,7 @@ export class ByProjectKeyPaymentsByIDRequestBuilder {
43
46
)
44
47
}
45
48
/**
46
-
* Checks if a Payment exists with the provided `id`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.
49
+
* Checks if a Payment exists with the provided `id`. Returns a `200 OK` status if the Payment exists, or [Not Found](/../api/errors#404-not-found) otherwise.
47
50
*/
48
51
publichead(methodArgs?: {
49
52
headers?: {
@@ -63,6 +66,9 @@ export class ByProjectKeyPaymentsByIDRequestBuilder {
63
66
this.args.executeRequest
64
67
)
65
68
}
69
+
/**
70
+
* Updates a Payment in the Project using one or more [update actions](/../api/projects/payments#update-actions).
71
+
*/
66
72
publicpost(methodArgs: {
67
73
queryArgs?: {
68
74
expand?: string|string[]
@@ -89,6 +95,9 @@ export class ByProjectKeyPaymentsByIDRequestBuilder {
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/payments/by-project-key-payments-key-by-key-request-builder.ts
+10-1Lines changed: 10 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,9 @@ export class ByProjectKeyPaymentsKeyByKeyRequestBuilder {
19
19
baseUri?: string
20
20
}
21
21
){}
22
+
/**
23
+
* Retrieves a Payment with the provided `key`.
24
+
*/
22
25
publicget(methodArgs?: {
23
26
queryArgs?: {
24
27
expand?: string|string[]
@@ -43,7 +46,7 @@ export class ByProjectKeyPaymentsKeyByKeyRequestBuilder {
43
46
)
44
47
}
45
48
/**
46
-
* Checks if a Payment exists with the provided `key`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise.
49
+
* Checks if a Payment exists with the provided `key`. Returns a `200 OK` status if the Payment exists, or [Not Found](/../api/errors#404-not-found) otherwise.
47
50
*/
48
51
publichead(methodArgs?: {
49
52
headers?: {
@@ -63,6 +66,9 @@ export class ByProjectKeyPaymentsKeyByKeyRequestBuilder {
63
66
this.args.executeRequest
64
67
)
65
68
}
69
+
/**
70
+
* Updates a Payment in the Project using one or more [update actions](/../api/projects/payments#update-actions).
71
+
*/
66
72
publicpost(methodArgs: {
67
73
queryArgs?: {
68
74
expand?: string|string[]
@@ -89,6 +95,9 @@ export class ByProjectKeyPaymentsKeyByKeyRequestBuilder {
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/payments/by-project-key-payments-request-builder.ts
+5-1Lines changed: 5 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -49,6 +49,9 @@ export class ByProjectKeyPaymentsRequestBuilder {
49
49
})
50
50
}
51
51
52
+
/**
53
+
* Retrieves all Payments in the Project.
54
+
*/
52
55
publicget(methodArgs?: {
53
56
queryArgs?: {
54
57
expand?: string|string[]
@@ -78,7 +81,7 @@ export class ByProjectKeyPaymentsRequestBuilder {
78
81
)
79
82
}
80
83
/**
81
-
* Checks if one or more Payments exist for the provided query predicate. Returns a `200 OK` status if any Payments match the query predicate, or a `404 Not Found` otherwise.
84
+
* Checks if one or more Payments exist for the provided query predicate. Returns a `200 OK` status if any Payments match the query predicate, or [Not Found](/../api/errors#404-not-found) otherwise.
82
85
*/
83
86
publichead(methodArgs?: {
84
87
queryArgs?: {
@@ -104,6 +107,7 @@ export class ByProjectKeyPaymentsRequestBuilder {
104
107
)
105
108
}
106
109
/**
110
+
* Creates a Payment in the Project.
107
111
* Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/shopping-lists/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-shopping-lists-by-id-request-builder.ts
+6-1Lines changed: 6 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
22
22
}
23
23
){}
24
24
/**
25
+
* Retrieves a ShoppingList with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit).
26
+
*
25
27
* If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
26
28
*
27
29
*/
@@ -50,7 +52,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
50
52
)
51
53
}
52
54
/**
53
-
* Checks if a ShoppingList exists with the provided `id`. Returns a `200 OK` if the ShoppingList exists; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
55
+
* Checks if a ShoppingList exists with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` if the ShoppingList exists; otherwise, returns [Not Found](/../api/errors#404-not-found).
54
56
*
55
57
*/
56
58
publichead(methodArgs?: {
@@ -73,6 +75,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
73
75
)
74
76
}
75
77
/**
78
+
* Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/shoppingLists#update-actions).
76
79
* If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
77
80
*
78
81
*/
@@ -104,6 +107,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
104
107
)
105
108
}
106
109
/**
110
+
* Deletes a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit).
111
+
*
107
112
* If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/shopping-lists/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-shopping-lists-key-by-key-request-builder.ts
+6-2Lines changed: 6 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
22
22
}
23
23
){}
24
24
/**
25
+
* Retrieves a ShoppingList with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit).
25
26
* If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
26
27
*
27
28
*/
@@ -50,7 +51,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
50
51
)
51
52
}
52
53
/**
53
-
* Checks if a ShoppingList exists with the provided `key`. Returns a `200 OK` if the ShoppingList exists; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
54
+
* Checks if a ShoppingList exists with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` if the ShoppingList exists; otherwise, returns [Not Found](/../api/errors#404-not-found).
54
55
*
55
56
*/
56
57
publichead(methodArgs?: {
@@ -73,7 +74,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
73
74
)
74
75
}
75
76
/**
76
-
* If the Shopping List exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
77
+
* Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/shoppingLists#update-actions).
78
+
* If the ShoppingList exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
77
79
*
78
80
*/
79
81
publicpost(methodArgs: {
@@ -104,6 +106,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
104
106
)
105
107
}
106
108
/**
109
+
* Deletes a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit).
110
+
*
107
111
* If the ShoppingList exists in the Project but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/shopping-lists/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-shopping-lists-request-builder.ts
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,9 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
55
55
)
56
56
}
57
57
58
+
/**
59
+
* Retrieves all ShoppingLists in a [BusinessUnit](ctp:api:type:BusinessUnit).
60
+
*/
58
61
publicget(methodArgs?: {
59
62
queryArgs?: {
60
63
expand?: string|string[]
@@ -85,7 +88,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
85
88
)
86
89
}
87
90
/**
88
-
* Checks if one or more ShoppingLists exist for the provided query predicate. Returns a `200 OK` if any ShoppingLists match the Query Predicate; otherwise, returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
91
+
* Checks if one or more ShoppingLists exist for the provided query predicate in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` if any ShoppingLists match the query predicate; otherwise, returns [Not Found](/../api/errors#404-not-found).
Copy file name to clipboardExpand all lines: packages/platform-sdk/src/generated/client/shopping-lists/by-project-key-in-store-key-by-store-key-me-shopping-lists-by-id-request-builder.ts
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder {
22
22
}
23
23
){}
24
24
/**
25
-
* Returns a ShoppingList for a given `id` in a Store. Returns `200 OK` status if successful.
25
+
* Retrieves a ShoppingList with the provided `id` for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store). Returns `200 OK` status if successful.
26
26
*
27
27
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
28
28
*
29
-
* - If no ShoppingList matches the given `id` in a Store.
30
-
* - If a ShoppingList matches the given `id` but does not have a `store` specified, or the `store` field references a different Store.
31
-
* - If a ShoppingList matches the given `id` in a Store but does not contain either an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope, or a `customer` with `id` value that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope.
29
+
* - If no ShoppingList matches the provided `id` in a Store.
30
+
* - If a ShoppingList matches the provided `id` but does not have a `store` specified, or the `store` field references a different Store.
31
+
* - If a ShoppingList matches the provided `id` in a Store but does not contain either an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope, or a `customer` with `id` value that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope.
32
32
*
33
33
*/
34
34
publicget(methodArgs?: {
@@ -56,13 +56,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder {
56
56
)
57
57
}
58
58
/**
59
-
* Checks if a ShoppingList exists with the provided `id` in a Store. Returns a `200 OK` status if successful.
59
+
* Checks if a ShoppingList exists with the provided `id` for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store). Returns a `200 OK` status if successful.
60
60
*
61
-
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
61
+
* A [Not Found](/../api/errors#404-not-found) error is returned in the following scenarios:
62
62
*
63
-
* - If no ShoppingList matches the given `id` in a Store.
64
-
* - If a ShoppingList matches the given `id` but does not have a `store` specified, or the `store` field references a different Store.
65
-
* - If a ShoppingList matches the given `id` in a Store but does not contain either an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope, or a `customer` with `id` value that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope.
63
+
* - If no ShoppingList matches the provided `id` in a Store.
64
+
* - If a ShoppingList matches the provided `id` but does not have a `store` specified, or the `store` field references a different Store.
65
+
* - If a ShoppingList matches the provided `id` in a Store but does not contain either an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope, or a `customer` with `id` value that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope.
66
66
*
67
67
*/
68
68
publichead(methodArgs?: {
@@ -85,13 +85,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder {
85
85
)
86
86
}
87
87
/**
88
-
* Updates a ShoppingList for a given `id` in a Store. Returns a `200 OK` status if successful.
88
+
* Updates a ShoppingList for the authenticated Customer or anonymous user in a [Store](ctp:api:type:Store) using one or more [update actions](/../api/projects/me-shoppingLists#update-actions). Returns a `200 OK` status if successful.
89
89
*
90
90
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
91
91
*
92
-
* - If no ShoppingList matches the given `id` in a Store.
93
-
* - If a ShoppingList matches the given `id` but does not have a `store` specified, or the `store` field references a different Store.
94
-
* - If a ShoppingList matches the given `id` in a Store but does not contain either an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope, or a `customer` with `id` value that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope.
92
+
* - If no ShoppingList matches the provided `id` in a Store.
93
+
* - If a ShoppingList matches the provided `id` but does not have a `store` specified, or the `store` field references a different Store.
94
+
* - If a ShoppingList matches the provided `id` in a Store but does not contain either an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope, or a `customer` with `id` value that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope.
95
95
*
96
96
*/
97
97
publicpost(methodArgs: {
@@ -122,13 +122,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder {
122
122
)
123
123
}
124
124
/**
125
-
* Deletes the ShoppingList for a given `id` in a Store. Returns a `200 OK` status if successful.
125
+
* Deletes a ShoppingList in a [Store](ctp:api:type:Store). Returns a `200 OK` status if successful.
126
126
*
127
127
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
128
128
*
129
-
* - If no ShoppingList matches the given `id` in a Store.
130
-
* - If a ShoppingList matches the given `id` but does not have a `store` specified, or the `store` field references a different Store.
131
-
* - If a ShoppingList matches the given `id` in a Store but does not contain either an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope, or a `customer` with `id` value that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope.
129
+
* - If no ShoppingList matches the provided `id` in a Store.
130
+
* - If a ShoppingList matches the provided `id` but does not have a `store` specified, or the `store` field references a different Store.
131
+
* - If a ShoppingList matches the provided `id` in a Store but does not contain either an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope, or a `customer` with `id` value that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope.
0 commit comments