Skip to content

Commit 67cca40

Browse files
build(codegen): updating SDK (#1030)
Co-authored-by: ct-sdks[bot] <153784748+ct-sdks[bot]@users.noreply.github.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
1 parent 573c5f9 commit 67cca40

19 files changed

Lines changed: 99 additions & 35 deletions

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ export class ByProjectKeyOrdersEditsByIDRequestBuilder {
3030
})
3131
}
3232

33+
/**
34+
* Retrieves an OrderEdit with the provided `id`.
35+
*/
3336
public get(methodArgs?: {
3437
queryArgs?: {
3538
expand?: string | string[]
@@ -74,6 +77,9 @@ export class ByProjectKeyOrdersEditsByIDRequestBuilder {
7477
this.args.executeRequest
7578
)
7679
}
80+
/**
81+
* Updates an OrderEdit in the Project using one or more [update actions](/../api/projects/order-edits#update-actions).
82+
*/
7783
public post(methodArgs: {
7884
queryArgs?: {
7985
expand?: string | string[]
@@ -100,6 +106,9 @@ export class ByProjectKeyOrdersEditsByIDRequestBuilder {
100106
this.args.executeRequest
101107
)
102108
}
109+
/**
110+
* Deletes an OrderEdit in the Project.
111+
*/
103112
public delete(methodArgs: {
104113
queryArgs: {
105114
version: number

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class ByProjectKeyOrdersEditsKeyByKeyRequestBuilder {
1919
baseUri?: string
2020
}
2121
) {}
22+
/**
23+
* Retrieves an OrderEdit with the provided `key`.
24+
*/
2225
public get(methodArgs?: {
2326
queryArgs?: {
2427
expand?: string | string[]
@@ -63,6 +66,9 @@ export class ByProjectKeyOrdersEditsKeyByKeyRequestBuilder {
6366
this.args.executeRequest
6467
)
6568
}
69+
/**
70+
* Updates an OrderEdit in the Project using one or more [update actions](/../api/projects/order-edits#update-actions).
71+
*/
6672
public post(methodArgs: {
6773
queryArgs?: {
6874
expand?: string | string[]
@@ -89,6 +95,9 @@ export class ByProjectKeyOrdersEditsKeyByKeyRequestBuilder {
8995
this.args.executeRequest
9096
)
9197
}
98+
/**
99+
* Deletes an OrderEdit in the Project.
100+
*/
92101
public delete(methodArgs: {
93102
queryArgs: {
94103
version: number

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ export class ByProjectKeyOrdersEditsRequestBuilder {
4949
})
5050
}
5151

52+
/**
53+
* Retrieves OrderEdits in the Project.
54+
*/
5255
public get(methodArgs?: {
5356
queryArgs?: {
5457
expand?: string | string[]
@@ -104,6 +107,7 @@ export class ByProjectKeyOrdersEditsRequestBuilder {
104107
)
105108
}
106109
/**
110+
* Creates an OrderEdit in the Project.
107111
* You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.
108112
*
109113
* You can only create an Order Edit if the [InventoryMode](/projects/carts#inventorymode) of the Order and its [LineItems](/projects/carts#lineitem) is `None`.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ export class ByProjectKeyOrdersImportRequestBuilder {
1919
}
2020
) {}
2121
/**
22+
* Creates an Order without needing to create a Cart first.
2223
* Importing an Order produces the [Order Imported](ctp:api:type:OrderImportedMessage) Message.
2324
*
2425
* Specific Error Codes:

packages/platform-sdk/src/generated/client/orders/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-orders-by-id-request-builder.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
2222
}
2323
) {}
2424
/**
25-
* If the Order 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.
25+
* Retrieves an Order with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit).
26+
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested Business Unit, this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
2627
*
2728
*/
2829
public get(methodArgs?: {
@@ -50,7 +51,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
5051
)
5152
}
5253
/**
53-
* Checks if an Order exists with the provided `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
54+
* Checks if an Order exists with the provided `id` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
5455
*/
5556
public head(methodArgs?: {
5657
headers?: {
@@ -72,7 +73,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
7273
)
7374
}
7475
/**
75-
* If the Order 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.
76+
* Updates an Order in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/orders#update-actions).
77+
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested Business Unit, this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
7678
*
7779
*/
7880
public post(methodArgs: {

packages/platform-sdk/src/generated/client/orders/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-orders-order-number-by-order-number-request-builder.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
2222
}
2323
) {}
2424
/**
25+
* Retrieves an Order with the provided `orderNumber` in a [BusinessUnit](ctp:api:type:BusinessUnit).
2526
* If the Order 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.
2627
*
2728
*/
@@ -50,7 +51,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
5051
)
5152
}
5253
/**
53-
* Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
54+
* Checks if an Order exists with the provided `orderNumber` in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise.
5455
*/
5556
public head(methodArgs?: {
5657
headers?: {
@@ -72,7 +73,8 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
7273
)
7374
}
7475
/**
75-
* If the Order 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.
76+
* Updates an Order in a [BusinessUnit](ctp:api:type:BusinessUnit) using one or more [update actions](/../api/projects/orders#update-actions).
77+
* If the Order exists in the [Project](ctp:api:type:Project) but does not reference the requested Business Unit, this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
7678
*
7779
*/
7880
public post(methodArgs: {

packages/platform-sdk/src/generated/client/orders/by-project-key-as-associate-by-associate-id-in-business-unit-key-by-business-unit-key-orders-request-builder.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
6767
)
6868
}
6969

70+
/**
71+
* Retrieves Orders in a [BusinessUnit](ctp:api:type:BusinessUnit).
72+
*/
7073
public get(methodArgs?: {
7174
queryArgs?: {
7275
expand?: string | string[]
@@ -97,7 +100,7 @@ export class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnit
97100
)
98101
}
99102
/**
100-
* Checks if one or more Orders exist for the provided query predicate. Returns a `200 OK` status if any Orders match the query predicate, or a `404 Not Found` otherwise.
103+
* Checks if one or more Orders exist with provided query predicate in a [BusinessUnit](ctp:api:type:BusinessUnit). Returns a `200 OK` status if any Orders match the query predicate, or a `404 Not Found` otherwise.
101104
*/
102105
public head(methodArgs?: {
103106
queryArgs?: {

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder {
2121
}
2222
) {}
2323
/**
24-
* Returns an Order for a given `id` in a Store. Returns a `200 OK` status if successful.
24+
* Retrieves an Order with the provided `id` in a [Store](ctp:api:type:Store) for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
2525
*
2626
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
2727
*
28-
* - If no Order exists in the Store for the given `id`.
29-
* - If the Order exists but does not have a `store` specified, or the `store` field references a different Store.
30-
* - If the Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
28+
* - If no Orders exists in the Store with the provided `id`.
29+
* - If an Order exists but does not have a `store` specified, or the `store` field references a different Store.
30+
* - If an Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
3131
*
3232
*/
3333
public get(methodArgs?: {
@@ -54,13 +54,13 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDRequestBuilder {
5454
)
5555
}
5656
/**
57-
* Checks if an Order exists with the provided `id` in a Store. Returns a `200 OK` status if successful.
57+
* Checks if an Order exists with the provided `id` in a [Store](ctp:api:type:Store) for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
5858
*
59-
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
59+
* A [Not Found](/../api/errors#404-not-found) error is returned in the following scenarios:
6060
*
61-
* - If no Order exists in the Store for the given `id`.
62-
* - If the Order exists but does not have a `store` specified, or the `store` field references a different Store.
63-
* - If the Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
61+
* - If no Order exists in the Store with the provided `id`.
62+
* - If an Order exists but does not have a `store` specified, or the `store` field references a different Store.
63+
* - If an Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
6464
*
6565
*/
6666
public head(methodArgs?: {

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

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,12 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder {
3535
}
3636

3737
/**
38-
* Returns all Orders in a Store that match a given Query Predicate and contain either a `customerId` that matches the [customer_id:{id}](/scopes#composable-commerce-oauth) scope, or an `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
38+
* Retrieves Orders in a [Store](ctp:api:type:Store) for the authenticated Customer or anonymous user.
39+
*
40+
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
41+
*
42+
* - If no Orders exist that match the provided query predicate.
43+
* - If an Order exists but does not have a `customerId` that matches the [customer:{id}](/scopes#composable-commerce-oauth) scope, or `anonymousId` that matches the [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
3944
*
4045
*/
4146
public get(methodArgs?: {
@@ -67,9 +72,9 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder {
6772
)
6873
}
6974
/**
70-
* Checks if one or more Orders exist for the provided query predicate in a Store. Returns a `200 OK` status if successful.
75+
* Checks if one or more Orders exist for the provided query predicate in a [Store](ctp:api:type:Store) for the authenticated Customer or anonymous user. Returns a `200 OK` status if successful.
7176
*
72-
* A [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error is returned in the following scenarios:
77+
* A [Not Found](/../api/errors#404-not-found) error is returned in the following scenarios:
7378
*
7479
* - If no Orders exist in the Store that match the Query Predicate.
7580
* - If an Order matches the Query Predicate, but no `store` is specified, or the `store` field references a different Store.
@@ -101,7 +106,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyMeOrdersRequestBuilder {
101106
}
102107
/**
103108
*
104-
* Creates an Order in a Store from a Cart for the Customer or anonymous user. The `customerId` or `anonymousId` field on the Order is automatically set based on the [customer:{id}](/scopes#composable-commerce-oauth) or [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
109+
* Creates an Order from a Cart in a [Store](ctp:api:type:Store) for the Customer or anonymous user. The `customerId` or `anonymousId` field on the Order is automatically set based on the [customer:{id}](/scopes#composable-commerce-oauth) or [anonymous_id:{id}](/scopes#composable-commerce-oauth) scope.
105110
*
106111
* The Cart must have a [shipping address set](ctp:api:type:CartSetShippingAddressAction) for taxes to be calculated. When creating [B2B Orders](/associates-overview#b2b-resources), the Customer must have the `CreateMyOrdersFromMyCarts` [Permission](ctp:api:type:Permission).
107112
*

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder {
2121
}
2222
) {}
2323
/**
24+
* Retrieves an Order with the provided `id` in a [Store](ctp:api:type:Store).
2425
* If the Order exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
2526
*
2627
*/
@@ -48,7 +49,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder {
4849
)
4950
}
5051
/**
51-
* Checks if an Order exists with the provided `id`. Returns a `200 OK` status if the Order exists or [Not Found](/../api/errors#404-not-found) otherwise.
52+
* Checks if an Order exists with the provided `id` in a [Store](ctp:api:type:Store). Returns a `200 OK` status if the Order exists or [Not Found](/../api/errors#404-not-found) otherwise.
5253
*/
5354
public head(methodArgs?: {
5455
headers?: {
@@ -69,6 +70,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder {
6970
)
7071
}
7172
/**
73+
* Updates an Order in a [Store](ctp:api:type:Store) using one or more [update actions](/../api/projects/orders#update-actions).
7274
* If the Order exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
7375
*
7476
*/
@@ -99,6 +101,7 @@ export class ByProjectKeyInStoreKeyByStoreKeyOrdersByIDRequestBuilder {
99101
)
100102
}
101103
/**
104+
* Deletes an Order in a [Store](ctp:api:type:Store).
102105
* If the Order exists in the Project but does not have a `store` specified, or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
103106
*
104107
* Deleting an Order produces the [OrderDeleted](ctp:api:type:OrderDeletedMessage) Message.

0 commit comments

Comments
 (0)