build(codegen): updating SDK (#1139)

Co-authored-by: ct-sdks[bot] <153784748+ct-sdks[bot]@users.noreply.github.com>

Author: ct-sdks[bot]

.changeset/changes_api.md

@@ -8,7 +8,10 @@
 <summary>Added Type(s)</summary>
 
 - added type `RecurringOrderDeletedMessage`
+- added type `RecurringOrderExpiresAtSetMessage`
 - added type `RecurringOrderDeletedMessagePayload`
+- added type `RecurringOrderExpiresAtSetMessagePayload`
+- added type `RecurringOrderSetExpiresAtAction`
 </details>
 
 <details>
@@ -17,3 +20,9 @@
 - added method `apiRoot.withProjectKey().recurringOrders().withId().delete()`
 - added method `apiRoot.withProjectKey().recurringOrders().withKey().delete()`
 </details>
+
+<details>
+<summary>Added Property(s)</summary>
+
+- added property `expiresAt` to type `RecurringOrderDraft`
+</details>

changes.md

@@ -4,7 +4,10 @@
 <summary>Added Type(s)</summary>
 
 - added type `RecurringOrderDeletedMessage`
+- added type `RecurringOrderExpiresAtSetMessage`
 - added type `RecurringOrderDeletedMessagePayload`
+- added type `RecurringOrderExpiresAtSetMessagePayload`
+- added type `RecurringOrderSetExpiresAtAction`
 </details>
 
 <details>
@@ -14,6 +17,12 @@
 - added method `apiRoot.withProjectKey().recurringOrders().withKey().delete()`
 </details>
 
+<details>
+<summary>Added Property(s)</summary>
+
+- added property `expiresAt` to type `RecurringOrderDraft`
+</details>
+
 **History changes**
 
 <details>

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

@@ -110,10 +110,11 @@ export class ByProjectKeyRecurringOrdersRequestBuilder {
   }
   /**
    *	Creates a Recurring Order in the Project.
-   *	The Cart is validated to ensure that it is convertible to an [Order](ctp:api:type:Order). If validation fails, an error is returned.
-   *
    *	Produces the [RecurringOrderCreated](ctp:api:type:RecurringOrderCreatedMessage) message.
    *
+   *	The Cart is validated to ensure that it is convertible to an [Order](ctp:api:type:Order). If the validation fails, an error is returned.
+   *	If the expiration date has been reached when the [Recurring Order](ctp:api:type:RecurringOrder) is processed, its [RecurringOrderState](ctp:api:type:RecurringOrderState) will be updated to `Expired`, and no Order will be created.
+   *
    *	If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Recurring Order creation may still successfully complete after the error is returned.
    *	If you receive this error, you should verify the status of the Recurring Order by querying a unique identifier supplied during the creation request, such as the key.
    *

packages/platform-sdk/src/generated/models/message.ts

@@ -392,6 +392,7 @@ export type Message =
   | RecurringOrderCustomTypeRemovedMessage
   | RecurringOrderCustomTypeSetMessage
   | RecurringOrderDeletedMessage
+  | RecurringOrderExpiresAtSetMessage
   | RecurringOrderKeySetMessage
   | RecurringOrderScheduleSetMessage
   | RecurringOrderStartsAtSetMessage
@@ -20053,6 +20054,82 @@ export interface RecurringOrderDeletedMessage extends IMessage {
    */
   readonly recurringOrder: RecurringOrder
 }
+/**
+ *	Generated after a successful [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+ *
+ */
+export interface RecurringOrderExpiresAtSetMessage extends IMessage {
+  readonly type: 'RecurringOrderExpiresAtSet'
+  /**
+   *	Unique identifier of the Message. Can be used to track which Messages have been processed.
+   *
+   */
+  readonly id: string
+  /**
+   *	Version of a resource. In case of Messages, this is always `1`.
+   *
+   */
+  readonly version: number
+  /**
+   *	Date and time (UTC) the Message was generated.
+   *
+   */
+  readonly createdAt: string
+  /**
+   *	Value of `createdAt`.
+   *
+   */
+  readonly lastModifiedAt: string
+  /**
+   *	IDs and references that last modified the Message.
+   *
+   *
+   */
+  readonly lastModifiedBy?: LastModifiedBy
+  /**
+   *	IDs and references that created the Message.
+   *
+   *
+   */
+  readonly createdBy?: CreatedBy
+  /**
+   *	Message number in relation to other Messages for a given resource. The `sequenceNumber` of the next Message for the resource is the successor of the `sequenceNumber` of the current Message. Meaning, the `sequenceNumber` of the next Message equals the `sequenceNumber` of the current Message + 1.
+   *	`sequenceNumber` can be used to ensure that Messages are processed in the correct order for a particular resource.
+   *
+   *
+   */
+  readonly sequenceNumber: number
+  /**
+   *	[Reference](ctp:api:type:Reference) to the resource on which the change or action was performed.
+   *
+   *
+   */
+  readonly resource: Reference
+  /**
+   *	Version of the resource on which the change or action was performed.
+   *
+   *
+   */
+  readonly resourceVersion: number
+  /**
+   *	User-provided identifiers of the resource, such as `key` or `externalId`. Only present if the resource has such identifiers.
+   *
+   *
+   */
+  readonly resourceUserProvidedIdentifiers?: UserProvidedIdentifiers
+  /**
+   *	Expiration date and time of the Recurring Order after the [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+   *
+   *
+   */
+  readonly newExpiresAt: string
+  /**
+   *	Expiration date and time of the Recurring Order before the [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+   *
+   *
+   */
+  readonly oldExpiresAt: string
+}
 /**
  *	Generated after a successful [Set Key](ctp:api:type:RecurringOrderSetKeyAction) update action.
  *
@@ -23523,6 +23600,7 @@ export type MessagePayload =
   | RecurringOrderCustomTypeRemovedMessagePayload
   | RecurringOrderCustomTypeSetMessagePayload
   | RecurringOrderDeletedMessagePayload
+  | RecurringOrderExpiresAtSetMessagePayload
   | RecurringOrderKeySetMessagePayload
   | RecurringOrderScheduleSetMessagePayload
   | RecurringOrderStartsAtSetMessagePayload
@@ -28732,6 +28810,26 @@ export interface RecurringOrderDeletedMessagePayload extends IMessagePayload {
    */
   readonly recurringOrder: RecurringOrder
 }
+/**
+ *	Generated after a successful [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+ *
+ */
+export interface RecurringOrderExpiresAtSetMessagePayload
+  extends IMessagePayload {
+  readonly type: 'RecurringOrderExpiresAtSet'
+  /**
+   *	Expiration date and time of the Recurring Order after the [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+   *
+   *
+   */
+  readonly newExpiresAt: string
+  /**
+   *	Expiration date and time of the Recurring Order before the [Set Expires At](ctp:api:type:RecurringOrderSetExpiresAtAction) update action.
+   *
+   *
+   */
+  readonly oldExpiresAt: string
+}
 /**
  *	Generated after a successful [Set Key](ctp:api:type:RecurringOrderSetKeyAction) update action.
  *

packages/platform-sdk/src/generated/models/recurring-order.ts

@@ -269,6 +269,12 @@ export interface RecurringOrderDraft {
    *
    */
   readonly startsAt: string
+  /**
+   *	Date and time (UTC) when the RecurringOrder will expire.
+   *
+   *
+   */
+  readonly expiresAt?: string
   /**
    *	State for the RecurringOrder in a custom workflow.
    *
@@ -453,6 +459,7 @@ export interface RecurringOrderUpdate {
 export type RecurringOrderUpdateAction =
   | RecurringOrderSetCustomFieldAction
   | RecurringOrderSetCustomTypeAction
+  | RecurringOrderSetExpiresAtAction
   | RecurringOrderSetKeyAction
   | RecurringOrderSetOrderSkipConfigurationAction
   | RecurringOrderSetScheduleAction
@@ -568,6 +575,22 @@ export interface RecurringOrderSetCustomTypeAction
    */
   readonly fields?: FieldContainer
 }
+/**
+ *	Setting the expiration date and time generates the [RecurringOrderExpiresAtSet](ctp:api:type:RecurringOrderExpiresAtSetMessage) Message.
+ *
+ */
+export interface RecurringOrderSetExpiresAtAction
+  extends IRecurringOrderUpdateAction {
+  readonly action: 'setExpiresAt'
+  /**
+   *	Date and time (UTC) the Recurring Order should expire. If empty, any existing value will be removed.
+   *
+   *	If the date or time is extended or removed when the [RecurringOrderState](ctp:api:type:RecurringOrderState) is `Expired`, the state will be updated to `Active`.
+   *
+   *
+   */
+  readonly expiresAt?: string
+}
 /**
  *	This update action generates the [RecurringOrderKeySet](ctp:api:type:RecurringOrderKeySetMessage) Message.
  *
@@ -593,7 +616,7 @@ export interface RecurringOrderSetOrderSkipConfigurationAction
    */
   readonly skipConfiguration?: SkipConfigurationDraft
   /**
-   *	Date and time (UTC) the Recurring Order will resume and start to generate new orders.
+   *	Date and time (UTC) the Recurring Order will expire and stop generating new orders.
    *
    *
    */

references.txt

@@ -440,3 +440,4 @@ e4973c1b97c71699c2945d476161cd47eded2e6d
 48cdda09a82127b5745d64a6b889a500a31139d8
 315719fe14a0aa4f14761fe5e768ad59b1a8a3e4
 09f7ffec9d7cad1549201cafbf8da0170de93a9a
+ae6bd28bc66a9ad876c323a54026e34e4f26c475