@gradientedge/commercetools-utils 6.6.0 → 6.7.0

package/dist/mjs/types/models/recurring-order.d.ts

@@ -1,263 +1,623 @@
-import { BaseResource, CreatedBy, IReference, IResourceIdentifier, LastModifiedBy } from './common.js';
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { BusinessUnitKeyReference } from './business-unit.js';
 import { CartReference, CartResourceIdentifier } from './cart.js';
+import { BaseResource, CreatedBy, IReference, IResourceIdentifier, LastModifiedBy } from './common.js';
+import { CustomerReference } from './customer.js';
 import { OrderReference } from './order.js';
-import { BusinessUnitKeyReference } from './business-unit.js';
+import { RecurrencePolicyReference, RecurrencePolicyResourceIdentifier, RecurrencePolicySchedule } from './recurrence-policy.js';
 import { StateReference, StateResourceIdentifier } from './state.js';
-import { CustomerReference } from './customer.js';
+import { StoreKeyReference } from './store.js';
 import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
-import { RecurrencePolicySchedule } from './recurrence-policy.js';
 /**
- * Represents a recurring order that automates the reordering process for a customer.
+ *	Information about recurring orders and frequencies.
+ *
  */
+export interface CustomLineItemRecurrenceInfo {
+    /**
+     *	[Reference](ctp:api:type:Reference) to a RecurrencePolicy.
+     *
+     *
+     */
+    readonly recurrencePolicy: RecurrencePolicyReference;
+}
+/**
+ *	Information about recurring orders and frequencies.
+ *
+ */
+export interface CustomLineItemRecurrenceInfoDraft {
+    /**
+     *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a RecurrencePolicy.
+     *
+     *
+     */
+    readonly recurrencePolicy: RecurrencePolicyResourceIdentifier;
+}
+/**
+ *	Information about recurring orders and frequencies.
+ *
+ */
+export interface LineItemRecurrenceInfo {
+    /**
+     *	[Reference](ctp:api:type:Reference) to a RecurrencePolicy.
+     *
+     *
+     */
+    readonly recurrencePolicy: RecurrencePolicyReference;
+    /**
+     *	Indicates how the price of a line item will be selected during order creation.
+     *
+     *
+     */
+    readonly priceSelectionMode: PriceSelectionMode;
+}
+/**
+ *	Information about recurring orders and frequencies.
+ *
+ */
+export interface LineItemRecurrenceInfoDraft {
+    /**
+     *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a RecurrencePolicy.
+     *
+     *
+     */
+    readonly recurrencePolicy: RecurrencePolicyResourceIdentifier;
+    /**
+     *	Determines how the price of a line item will be selected during order creation.
+     *
+     *
+     */
+    readonly priceSelectionMode: PriceSelectionMode;
+}
+/**
+ *	Indicates how the price of a [Line Item](ctp:api:type:LineItem) or [Custom Line Item](ctp:api:type:CustomLineItem) is selected during Order creation.
+ *
+ */
+export declare enum PriceSelectionModeValues {
+    Dynamic = "Dynamic",
+    Fixed = "Fixed"
+}
+export type PriceSelectionMode = 'Dynamic' | 'Fixed' | (string & {});
 export interface RecurringOrder extends BaseResource {
     /**
-     * Unique identifier of the RecurringOrder.
+     *	Unique identifier of the RecurringOrder.
+     *
+     *
      */
     readonly id: string;
     /**
-     * Current version of the RecurringOrder.
+     *	User-defined unique identifier of the RecurringOrder.
+     *
+     *
      */
-    readonly version: number;
+    readonly key?: string;
     /**
-     * User-defined unique identifier for the RecurringOrder.
+     *	Current version of the RecurringOrder.
+     *
+     *
      */
-    readonly key?: string;
+    readonly version: number;
     /**
-     * Reference to the Cart for a RecurringOrder.
+     *	[Reference](ctp:api:type:Reference) to the Cart for a RecurringOrder.
+     *	The referenced Cart will have the `RecurringOrder` [CartOrigin](ctp:api:type:CartOrigin).
+     *
+     *
      */
     readonly cart: CartReference;
     /**
-     * Reference to the Order that generated this RecurringOrder.
+     *	[Reference](ctp:api:type:Reference) to the original [Order](ctp:api:type:Order) that generated this RecurringOrder.
+     *
+     *
      */
-    readonly originOrder?: OrderReference;
+    readonly originOrder: OrderReference;
     /**
-     * Date and time (UTC) the RecurringOrder starts creating new orders.
+     *	Date and time (UTC) when the RecurringOrder starts creating new Orders.
+     *
+     *
      */
     readonly startsAt: string;
     /**
-     * Date and time (UTC) the RecurringOrder resumes subsequent order creation after it is unpaused.
+     *	Date and time (UTC) when the RecurringOrder resumes creating Orders after being unpaused.
+     *
+     *
      */
     readonly resumesAt?: string;
     /**
-     * Date and time (UTC) the RecurringOrder expires.
+     *	Date and time (UTC) when the RecurringOrder expires.
+     *
+     *
      */
     readonly expiresAt?: string;
     /**
-     * Date and time (UTC) when the last order was created from this RecurringOrder.
+     *	Date and time (UTC) when the last Order was created from this RecurringOrder.
+     *
+     *
      */
     readonly lastOrderAt?: string;
     /**
-     * Date and time (UTC) when the next order will be created from this RecurringOrder.
+     *	Date and time (UTC) when the next Order will be created from this RecurringOrder.
+     *
+     *
      */
     readonly nextOrderAt?: string;
     /**
-     * Information about current and future skips of this RecurringOrder.
+     *	Information about current and future skips for this RecurringOrder.
+     *
+     *
      */
     readonly skipConfiguration?: SkipConfiguration;
     /**
-     * Reference to a Business Unit the RecurringOrder belongs to.
+     *	[Reference](ctp:api:type:Reference) to a Store.
+     *
+     *
+     */
+    readonly store?: StoreKeyReference;
+    /**
+     *	[Reference](ctp:api:type:Reference) to the Business Unit that the RecurringOrder belongs to.
+     *
+     *
      */
     readonly businessUnit?: BusinessUnitKeyReference;
     /**
-     * State of the RecurringOrder in a custom workflow.
+     *	[State](ctp:api:type:State) of the RecurringOrder in a custom workflow.
+     *
+     *
      */
     readonly state?: StateReference;
     /**
-     * Current state of the RecurringOrder.
+     *	Current state of the RecurringOrder.
+     *
+     *
      */
     readonly recurringOrderState: RecurringOrderState;
     /**
-     * Schedule of the RecurringOrder.
+     *	Schedule of the RecurringOrder.
+     *
+     *
      */
     readonly schedule: RecurrencePolicySchedule;
     /**
-     * The Customer that the RecurringOrder belongs to.
+     *	The [Customer](ctp:api:type:Customer) that the RecurringOrder belongs to.
+     *
+     *
      */
     readonly customer?: CustomerReference;
     /**
-     * Email address of the Customer that the RecurringOrder belongs to.
+     *	Email address of the Customer that the RecurringOrder belongs to.
+     *
+     *
      */
     readonly customerEmail?: string;
     /**
-     * Custom Fields of the RecurringOrder.
+     *	Custom Fields of the RecurringOrder.
+     *
+     *
      */
     readonly custom?: CustomFields;
     /**
-     * IDs and references that created the RecurringOrder.
+     *	Date and time (UTC) when the RecurringOrder was created.
+     *
+     *
      */
-    readonly createdBy?: CreatedBy;
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) when the RecurringOrder was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
     /**
-     * IDs and references that last modified the RecurringOrder.
+     *	IDs and references that last modified the RecurringOrder.
+     *
+     *
      */
     readonly lastModifiedBy?: LastModifiedBy;
+    /**
+     *	IDs and references that created the RecurringOrder.
+     *
+     *
+     */
+    readonly createdBy?: CreatedBy;
 }
 /**
- * Draft for creating a RecurringOrder.
+ *	Recurring Orders are automatically assigned the Store and/or Business Unit from the associated Cart.
+ *
  */
 export interface RecurringOrderDraft {
     /**
-     * User-defined unique identifier of the RecurringOrder.
+     *	User-defined unique identifier of the [RecurringOrder](ctp:api:type:RecurringOrder).
+     *
+     *
      */
-    key?: string;
+    readonly key?: string;
     /**
-     * ResourceIdentifier to the Cart from which the RecurringOrder is created.
+     *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Cart from which the RecurringOrder is created.
+     *
+     *
      */
-    cart: CartResourceIdentifier;
+    readonly cart: CartResourceIdentifier;
     /**
-     * Current version of the referenced Cart.
+     *	Current version of the referenced [Cart](ctp:api:type:Cart).
+     *
+     *
      */
-    cartVersion: number;
+    readonly cartVersion: number;
     /**
-     * Date and time (UTC) the RecurringOrder will start.
+     *	Date and time (UTC) when the RecurringOrder will start.
+     *
+     *
      */
-    startsAt: string;
+    readonly startsAt: string;
     /**
-     * State for the RecurringOrder in a custom workflow.
+     *	State for the RecurringOrder in a custom workflow.
+     *
+     *
      */
-    state?: StateResourceIdentifier;
+    readonly state?: StateResourceIdentifier;
     /**
-     * Custom Fields to be added to the RecurringOrder.
+     *	Custom Fields for the RecurringOrder.
+     *
+     *
      */
-    custom?: CustomFieldsDraft;
+    readonly custom?: CustomFieldsDraft;
 }
 /**
- * Response containing a paged list of RecurringOrders.
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [RecurringOrder](ctp:api:type:RecurringOrder).
+ *
  */
 export interface RecurringOrderPagedQueryResponse {
     /**
-     * Number of results requested.
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
      */
-    limit: number;
+    readonly limit: number;
     /**
-     * Number of elements skipped.
+     *	Number of [elements skipped](/../api/general-concepts#offset).
+     *
+     *
      */
-    offset: number;
+    readonly offset: number;
     /**
-     * Actual number of results returned.
+     *	Actual number of results returned.
+     *
+     *
      */
-    count: number;
+    readonly count: number;
     /**
-     * Total number of results matching the query.
+     *	Total number of results matching the query.
+     *	This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+     *	This field is returned by default.
+     *	For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
+     *	When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
+     *
+     *
      */
-    total?: number;
+    readonly total?: number;
     /**
-     * RecurringOrders matching the query.
+     *	[RecurringOrders](ctp:api:type:RecurringOrder) matching the query.
+     *
+     *
      */
-    results: RecurringOrder[];
+    readonly results: RecurringOrder[];
 }
 /**
- * Reference to a RecurringOrder.
+ *	[Reference](ctp:api:type:Reference) to a [RecurringOrder](ctp:api:type:RecurringOrder).
+ *
  */
 export interface RecurringOrderReference extends IReference {
     readonly typeId: 'recurring-order';
+    /**
+     *	Unique identifier of the referenced [RecurringOrder](ctp:api:type:RecurringOrder).
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Contains the representation of the expanded RecurringOrder.
+     *	Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for RecurringOrders.
+     *
+     *
+     */
     readonly obj?: RecurringOrder;
 }
 /**
- * ResourceIdentifier to a RecurringOrder.
+ *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [RecurringOrder](ctp:api:type:RecurringOrder). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
+ *
  */
 export interface RecurringOrderResourceIdentifier extends IResourceIdentifier {
     readonly typeId: 'recurring-order';
+    /**
+     *	Unique identifier of the referenced [RecurringOrder](ctp:api:type:RecurringOrder). Required if `key` is absent.
+     *
+     *
+     */
     readonly id?: string;
+    /**
+     *	User-defined unique identifier of the referenced [RecurringOrder](ctp:api:type:RecurringOrder). Required if `id` is absent.
+     *
+     *
+     */
     readonly key?: string;
 }
 /**
- * States of a RecurringOrder.
+ *	Indicates the state of the [RecurringOrder](ctp:api:type:RecurringOrder).
+ *
  */
-export declare enum RecurringOrderState {
+export declare enum RecurringOrderStateValues {
     Active = "Active",
-    Paused = "Paused",
+    Canceled = "Canceled",
     Expired = "Expired",
-    Canceled = "Canceled"
+    Failed = "Failed",
+    Paused = "Paused"
+}
+export type RecurringOrderState = 'Active' | 'Canceled' | 'Expired' | 'Failed' | 'Paused' | (string & {});
+/**
+ *	Defines the new state for the Recurring Order—for possible values, see [RecurringOrderActive](ctp:api:type:RecurringOrderActive), [RecurringOrderPaused](ctp:api:type:RecurringOrderPaused), [RecurringOrderExpired](ctp:api:type:RecurringOrderExpired), and [RecurringOrderCanceled](ctp:api:type:RecurringOrderCanceled).
+ *
+ */
+export type RecurringOrderStateDraft = RecurringOrderActive | RecurringOrderCanceled | RecurringOrderExpired | RecurringOrderPaused;
+export interface IRecurringOrderStateDraft {
+    /**
+     *
+     */
+    readonly type: string;
+}
+/**
+ *	Changes the Recurring Order state to active.
+ *
+ */
+export interface RecurringOrderActive extends IRecurringOrderStateDraft {
+    readonly type: 'active';
+    /**
+     *	If set, the Recurring Order will automatically resume at the date and time (UTC) specified.
+     *
+     *
+     */
+    readonly resumesAt?: string;
+}
+/**
+ *	Changes the Recurring Order state to canceled.
+ *
+ */
+export interface RecurringOrderCanceled extends IRecurringOrderStateDraft {
+    readonly type: 'canceled';
+    /**
+     *	The reason for the cancelation.
+     *
+     *
+     */
+    readonly reason?: string;
+}
+/**
+ *	Changes the Recurring Order state to expired.
+ *
+ */
+export interface RecurringOrderExpired extends IRecurringOrderStateDraft {
+    readonly type: 'expired';
 }
 /**
- * Defines how the next orders are going to be skipped.
+ *	Changes the Recurring Order state to paused.
+ *
  */
-export interface SkipConfiguration {
+export interface RecurringOrderPaused extends IRecurringOrderStateDraft {
+    readonly type: 'paused';
+}
+export interface RecurringOrderUpdate {
+    /**
+     *	Expected version of the RecurringOrder on which the changes should be applied.
+     *	If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
+     *
+     *
+     */
+    readonly version: number;
     /**
-     * Type of skip configuration.
+     *	Update actions to be performed on the RecurringOrder.
+     *
+     *
      */
+    readonly actions: RecurringOrderUpdateAction[];
+}
+export type RecurringOrderUpdateAction = RecurringOrderSetCustomFieldAction | RecurringOrderSetCustomTypeAction | RecurringOrderSetKeyAction | RecurringOrderSetOrderSkipConfigurationAction | RecurringOrderSetScheduleAction | RecurringOrderSetStartsAtAction | RecurringOrderSetStateAction | RecurringOrderTransitionStateAction;
+export interface IRecurringOrderUpdateAction {
+    /**
+     *
+     */
+    readonly action: string;
+}
+/**
+ *	Defines how the next orders are going to be skipped.
+ *
+ */
+export type SkipConfiguration = Counter;
+export interface ISkipConfiguration {
+    /**
+     *
+     */
+    readonly type: string;
+}
+/**
+ *	Configuration to track skips for a [RecurringOrder](ctp:api:type:RecurringOrder).
+ *
+ */
+export interface Counter extends ISkipConfiguration {
     readonly type: 'counter';
     /**
-     * Amount of orders that are going to be skipped.
+     *	Number of Orders that will be skipped.
+     *
+     *
      */
     readonly totalToSkip: number;
     /**
-     * Amount of orders that were already skipped.
+     *	Number of Orders that were already skipped.
+     *
+     *
      */
     readonly skipped: number;
     /**
-     * Date and time (UTC) when the last order creation was skipped.
+     *	Date and time (UTC) when the last Order creation was skipped.
+     *
+     *
      */
     readonly lastSkippedAt?: string;
 }
 /**
- * Configuration that uses a counter to track the amount of orders that will be skipped.
+ *	Defines how the next orders are going to be skipped.
+ *
  */
-export interface SkipConfigurationDraft {
+export type SkipConfigurationDraft = CounterDraft;
+export interface ISkipConfigurationDraft {
     /**
-     * Type of skip configuration.
+     *
      */
+    readonly type: string;
+}
+/**
+ *	Configuration that uses a counter to track the number of Orders that will be skipped.
+ *
+ */
+export interface CounterDraft extends ISkipConfigurationDraft {
     readonly type: 'counter';
     /**
-     * Amount of orders that are going to be skipped.
+     *	Number of Orders that will be skipped.
+     *
+     *
      */
     readonly totalToSkip: number;
 }
 /**
- * Modes for selecting the price of a line item during order creation.
+ *	Adding a Custom Field to a Recurring Order generates the [RecurringOrderCustomFieldAdded](ctp:api:type:RecurringOrderCustomFieldAddedMessage) Message, removing one generates the [RecurringOrderCustomFieldRemoved](ctp:api:type:RecurringOrderCustomFieldRemovedMessage) Message, and updating an existing one generates the [RecurringOrderCustomFieldChanged](ctp:api:type:RecurringOrderCustomFieldChangedMessage) Message.
+ *
  */
-export declare enum PriceSelectionMode {
-    Fixed = "Fixed",
-    Dynamic = "Dynamic"
+export interface RecurringOrderSetCustomFieldAction extends IRecurringOrderUpdateAction {
+    readonly action: 'setCustomField';
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
 }
 /**
- * Update action for RecurringOrder.
+ *	Adding or updating a Custom Type on a Recurring Order generates the [RecurringOrderCustomTypeSet](ctp:api:type:RecurringOrderCustomTypeSetMessage) Message, removing one generates the [RecurringOrderCustomTypeRemoved](ctp:api:type:RecurringOrderCustomTypeRemovedMessage) Message.
+ *
  */
-export type RecurringOrderUpdateAction = RecurringOrderSetKeyAction | RecurringOrderTransitionStateAction | RecurringOrderSetRecurringOrderStateAction | RecurringOrderSetCustomFieldAction | RecurringOrderSetCustomTypeAction | RecurringOrderSetSkipConfigurationAction;
+export interface RecurringOrderSetCustomTypeAction extends IRecurringOrderUpdateAction {
+    readonly action: 'setCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the RecurringOrder with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the RecurringOrder.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the RecurringOrder.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
 /**
- * Update action to set the key of a RecurringOrder.
+ *	This update action generates the [RecurringOrderKeySet](ctp:api:type:RecurringOrderKeySetMessage) Message.
+ *
  */
-export interface RecurringOrderSetKeyAction {
+export interface RecurringOrderSetKeyAction extends IRecurringOrderUpdateAction {
     readonly action: 'setKey';
+    /**
+     *	Value to set.
+     *	If empty, any existing key will be removed.
+     *
+     *
+     */
     readonly key?: string;
 }
-/**
- * Update action to transition the state of a RecurringOrder.
- */
-export interface RecurringOrderTransitionStateAction {
-    readonly action: 'transitionState';
-    readonly state: StateResourceIdentifier;
-    readonly force?: boolean;
+export interface RecurringOrderSetOrderSkipConfigurationAction extends IRecurringOrderUpdateAction {
+    readonly action: 'setOrderSkipConfiguration';
+    /**
+     *	Configuration for skipping the next orders of the [Recurring Order](ctp:api:type:RecurringOrder).
+     *
+     *
+     */
+    readonly skipConfiguration?: SkipConfigurationDraft;
+    /**
+     *	Date and time (UTC) the Recurring Order will resume and start to generate new orders.
+     *
+     *
+     */
+    readonly updatedExpiresAt?: string;
 }
 /**
- * Update action to set the RecurringOrderState.
+ *	To set the [schedule](ctp:api:type:RecurrencePolicySchedule), the [Recurring Order](ctp:api:type:RecurringOrder) must be active, with no active [Skip Configuration](ctp:api:type:SkipConfiguration) and with available prices for all Cart items for the new schedule.
+ *	Setting the schedule generates the [RecurringOrderScheduleSet](ctp:api:type:RecurringOrderScheduleSetMessage) Message.
+ *
  */
-export interface RecurringOrderSetRecurringOrderStateAction {
-    readonly action: 'setRecurringOrderState';
-    readonly recurringOrderState: RecurringOrderState;
+export interface RecurringOrderSetScheduleAction extends IRecurringOrderUpdateAction {
+    readonly action: 'setSchedule';
+    /**
+     *	Value to set.
+     *
+     */
+    readonly recurrencePolicy: RecurrencePolicyResourceIdentifier;
 }
 /**
- * Update action to set a custom field.
+ *	To set the start date and time, the [Recurring Order](ctp:api:type:RecurringOrder) must not have been started yet.
+ *	Setting the start date and time generates the [RecurringOrderStartsAtSet](ctp:api:type:RecurringOrderStartsAtSetMessage) Message.
+ *
  */
-export interface RecurringOrderSetCustomFieldAction {
-    readonly action: 'setCustomField';
-    readonly name: string;
-    readonly value?: any;
+export interface RecurringOrderSetStartsAtAction extends IRecurringOrderUpdateAction {
+    readonly action: 'setStartsAt';
+    /**
+     *	Date and time (UTC) the [Recurring Order](ctp:api:type:RecurringOrder) should be started. The date and time must be in the future.
+     *
+     */
+    readonly startsAt: string;
 }
 /**
- * Update action to set the custom type and fields.
+ *	Setting the [RecurringOrderState](ctp:api:type:RecurringOrderState) generates the [RecurringOrderStateChanged](ctp:api:type:RecurringOrderStateChangedMessage) Message.
+ *
  */
-export interface RecurringOrderSetCustomTypeAction {
-    readonly action: 'setCustomType';
-    readonly type?: TypeResourceIdentifier;
-    readonly fields?: FieldContainer;
+export interface RecurringOrderSetStateAction extends IRecurringOrderUpdateAction {
+    readonly action: 'setRecurringOrderState';
+    /**
+     *	New state of the RecurringOrder.
+     *
+     *
+     */
+    readonly recurringOrderState: RecurringOrderStateDraft;
 }
 /**
- * Update action to set the skip configuration.
+ *	If the existing [State](ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State.
+ *	If `transitions` is not set, no validation is performed.
+ *
+ *	This update action produces the [Recurring Order State Transition](ctp:api:type:RecurringOrderStateTransitionMessage) Message.
+ *
  */
-export interface RecurringOrderSetSkipConfigurationAction {
-    readonly action: 'setOrderSkipConfiguration';
-    readonly skipConfiguration: SkipConfigurationDraft;
-    readonly updatedExpiresAt?: string;
+export interface RecurringOrderTransitionStateAction extends IRecurringOrderUpdateAction {
+    readonly action: 'transitionState';
+    /**
+     *	Value to set.
+     *	If there is no State yet, the new State must be an initial State.
+     *
+     *
+     */
+    readonly state: StateResourceIdentifier;
+    /**
+     *	Set to `true` to turn off validation.
+     *
+     *
+     */
+    readonly force?: boolean;
 }
 //# sourceMappingURL=recurring-order.d.ts.map