Skip to content

Commit 247da96

Browse files
authored
build(codegen): updating SDK (#1029)
Co-authored-by: ct-sdks[bot] <153784748+ct-sdks[bot]@users.noreply.github.com>
1 parent 7567e63 commit 247da96

22 files changed

Lines changed: 162 additions & 93 deletions

File tree

packages/platform-sdk/src/generated/client/carts/by-project-key-in-store-key-by-store-key-carts-by-id-request-builder.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyCartsByIDRequestBuilder {
5252
)
5353
}
5454
/**
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.
5656
*/
5757
public head(methodArgs?: {
5858
headers?: {

packages/platform-sdk/src/generated/client/payments/by-project-key-me-payments-by-id-request-builder.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export class ByProjectKeyMePaymentsByIDRequestBuilder {
2020
}
2121
) {}
2222
/**
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.
2424
*/
2525
public get(methodArgs?: {
2626
queryArgs?: {
@@ -46,7 +46,7 @@ export class ByProjectKeyMePaymentsByIDRequestBuilder {
4646
)
4747
}
4848
/**
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.
5050
*/
5151
public head(methodArgs?: {
5252
headers?: {
@@ -67,8 +67,8 @@ export class ByProjectKeyMePaymentsByIDRequestBuilder {
6767
)
6868
}
6969
/**
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).
7272
*
7373
*/
7474
public post(methodArgs: {
@@ -98,8 +98,8 @@ export class ByProjectKeyMePaymentsByIDRequestBuilder {
9898
)
9999
}
100100
/**
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).
103103
*
104104
*/
105105
public delete(methodArgs: {

packages/platform-sdk/src/generated/client/payments/by-project-key-me-payments-request-builder.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export class ByProjectKeyMePaymentsRequestBuilder {
3737
}
3838

3939
/**
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.
4141
*/
4242
public get(methodArgs?: {
4343
queryArgs?: {
@@ -68,7 +68,7 @@ export class ByProjectKeyMePaymentsRequestBuilder {
6868
)
6969
}
7070
/**
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.
7272
*/
7373
public head(methodArgs?: {
7474
queryArgs?: {
@@ -94,7 +94,7 @@ export class ByProjectKeyMePaymentsRequestBuilder {
9494
)
9595
}
9696
/**
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.
9898
* Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message.
9999
*
100100
*/

packages/platform-sdk/src/generated/client/payments/by-project-key-payments-by-id-request-builder.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class ByProjectKeyPaymentsByIDRequestBuilder {
1919
baseUri?: string
2020
}
2121
) {}
22+
/**
23+
* Retrieves a Payment with the provided `id`.
24+
*/
2225
public get(methodArgs?: {
2326
queryArgs?: {
2427
expand?: string | string[]
@@ -43,7 +46,7 @@ export class ByProjectKeyPaymentsByIDRequestBuilder {
4346
)
4447
}
4548
/**
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.
4750
*/
4851
public head(methodArgs?: {
4952
headers?: {
@@ -63,6 +66,9 @@ export class ByProjectKeyPaymentsByIDRequestBuilder {
6366
this.args.executeRequest
6467
)
6568
}
69+
/**
70+
* Updates a Payment in the Project using one or more [update actions](/../api/projects/payments#update-actions).
71+
*/
6672
public post(methodArgs: {
6773
queryArgs?: {
6874
expand?: string | string[]
@@ -89,6 +95,9 @@ export class ByProjectKeyPaymentsByIDRequestBuilder {
8995
this.args.executeRequest
9096
)
9197
}
98+
/**
99+
* Deletes a Payment in the Project.
100+
*/
92101
public delete(methodArgs: {
93102
queryArgs: {
94103
dataErasure?: boolean

packages/platform-sdk/src/generated/client/payments/by-project-key-payments-key-by-key-request-builder.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class ByProjectKeyPaymentsKeyByKeyRequestBuilder {
1919
baseUri?: string
2020
}
2121
) {}
22+
/**
23+
* Retrieves a Payment with the provided `key`.
24+
*/
2225
public get(methodArgs?: {
2326
queryArgs?: {
2427
expand?: string | string[]
@@ -43,7 +46,7 @@ export class ByProjectKeyPaymentsKeyByKeyRequestBuilder {
4346
)
4447
}
4548
/**
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.
4750
*/
4851
public head(methodArgs?: {
4952
headers?: {
@@ -63,6 +66,9 @@ export class ByProjectKeyPaymentsKeyByKeyRequestBuilder {
6366
this.args.executeRequest
6467
)
6568
}
69+
/**
70+
* Updates a Payment in the Project using one or more [update actions](/../api/projects/payments#update-actions).
71+
*/
6672
public post(methodArgs: {
6773
queryArgs?: {
6874
expand?: string | string[]
@@ -89,6 +95,9 @@ export class ByProjectKeyPaymentsKeyByKeyRequestBuilder {
8995
this.args.executeRequest
9096
)
9197
}
98+
/**
99+
* Deletes a Payment in the Project.
100+
*/
92101
public delete(methodArgs: {
93102
queryArgs: {
94103
dataErasure?: boolean

packages/platform-sdk/src/generated/client/payments/by-project-key-payments-request-builder.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ export class ByProjectKeyPaymentsRequestBuilder {
4949
})
5050
}
5151

52+
/**
53+
* Retrieves all Payments in the Project.
54+
*/
5255
public get(methodArgs?: {
5356
queryArgs?: {
5457
expand?: string | string[]
@@ -78,7 +81,7 @@ export class ByProjectKeyPaymentsRequestBuilder {
7881
)
7982
}
8083
/**
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.
8285
*/
8386
public head(methodArgs?: {
8487
queryArgs?: {
@@ -104,6 +107,7 @@ export class ByProjectKeyPaymentsRequestBuilder {
104107
)
105108
}
106109
/**
110+
* Creates a Payment in the Project.
107111
* Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message.
108112
*
109113
*/

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
2222
}
2323
) {}
2424
/**
25+
* Retrieves a ShoppingList with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit).
26+
*
2527
* 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.
2628
*
2729
*/
@@ -50,7 +52,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
5052
)
5153
}
5254
/**
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).
5456
*
5557
*/
5658
public head(methodArgs?: {
@@ -73,6 +75,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
7375
)
7476
}
7577
/**
78+
* Updates a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/shoppingLists#update-actions).
7679
* 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.
7780
*
7881
*/
@@ -104,6 +107,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
104107
)
105108
}
106109
/**
110+
* Deletes a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit).
111+
*
107112
* 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.
108113
*
109114
*/

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
2222
}
2323
) {}
2424
/**
25+
* Retrieves a ShoppingList with the provided `key` in a [BusinessUnit](ctp:api:type:BusinessUnit).
2526
* 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.
2627
*
2728
*/
@@ -50,7 +51,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
5051
)
5152
}
5253
/**
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).
5455
*
5556
*/
5657
public head(methodArgs?: {
@@ -73,7 +74,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
7374
)
7475
}
7576
/**
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.
7779
*
7880
*/
7981
public post(methodArgs: {
@@ -104,6 +106,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
104106
)
105107
}
106108
/**
109+
* Deletes a ShoppingList in a [BusinessUnit](ctp:api:type:BusinessUnit).
110+
*
107111
* 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.
108112
*
109113
*/

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
5555
)
5656
}
5757

58+
/**
59+
* Retrieves all ShoppingLists in a [BusinessUnit](ctp:api:type:BusinessUnit).
60+
*/
5861
public get(methodArgs?: {
5962
queryArgs?: {
6063
expand?: string | string[]
@@ -85,7 +88,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
8588
)
8689
}
8790
/**
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).
8992
*
9093
*/
9194
public head(methodArgs?: {

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder {
2222
}
2323
) {}
2424
/**
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.
2626
*
2727
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
2828
*
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.
3232
*
3333
*/
3434
public get(methodArgs?: {
@@ -56,13 +56,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder {
5656
)
5757
}
5858
/**
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.
6060
*
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:
6262
*
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.
6666
*
6767
*/
6868
public head(methodArgs?: {
@@ -85,13 +85,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder {
8585
)
8686
}
8787
/**
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.
8989
*
9090
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
9191
*
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.
9595
*
9696
*/
9797
public post(methodArgs: {
@@ -122,13 +122,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDRequestBuilder {
122122
)
123123
}
124124
/**
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.
126126
*
127127
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
128128
*
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.
132132
*
133133
*/
134134
public delete(methodArgs: {

0 commit comments

Comments
 (0)