@wix/auto_sdk_pricing-plans_orders 1.0.89 → 1.0.90

package/build/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { GetOrderRequest as GetOrderRequest$1, GetOrderResponse as GetOrderResponse$1, ListOrdersRequest as ListOrdersRequest$1, ListOrdersResponse as ListOrdersResponse$1, PostponeEndDateRequest as PostponeEndDateRequest$1, PostponeEndDateResponse as PostponeEndDateResponse$1, CancelOrderRequest as CancelOrderRequest$1, CancelOrderResponse as CancelOrderResponse$1, MarkAsPaidRequest as MarkAsPaidRequest$1, MarkAsPaidResponse as MarkAsPaidResponse$1, PauseOrderRequest as PauseOrderRequest$1, PauseOrderResponse as PauseOrderResponse$1, ResumeOrderRequest as ResumeOrderRequest$1, ResumeOrderResponse as ResumeOrderResponse$1, MemberGetOrderRequest as MemberGetOrderRequest$1, MemberGetOrderResponse as MemberGetOrderResponse$1, MemberListOrdersRequest as MemberListOrdersRequest$1, MemberListOrdersResponse as MemberListOrdersResponse$1, RequestCancellationRequest as RequestCancellationRequest$1, RequestCancellationResponse as RequestCancellationResponse$1, CreateOnlineOrderRequest as CreateOnlineOrderRequest$1, CreateOnlineOrderResponse as CreateOnlineOrderResponse$1, CreateOfflineOrderRequest as CreateOfflineOrderRequest$1, CreateOfflineOrderResponse as CreateOfflineOrderResponse$1, GetOnlineOrderPreviewRequest as GetOnlineOrderPreviewRequest$1, GetOnlineOrderPreviewResponse as GetOnlineOrderPreviewResponse$1, GetOfflineOrderPreviewRequest as GetOfflineOrderPreviewRequest$1, GetOfflineOrderPreviewResponse as GetOfflineOrderPreviewResponse$1, GetPricePreviewRequest as GetPricePreviewRequest$1, GetPricePreviewResponse as GetPricePreviewResponse$1 } from './index.typings.js';
+import { MemberGetOrderRequest as MemberGetOrderRequest$1, MemberGetOrderResponse as MemberGetOrderResponse$1, MemberListOrdersRequest as MemberListOrdersRequest$1, MemberListOrdersResponse as MemberListOrdersResponse$1, RequestCancellationRequest as RequestCancellationRequest$1, RequestCancellationResponse as RequestCancellationResponse$1, CreateOnlineOrderRequest as CreateOnlineOrderRequest$1, CreateOnlineOrderResponse as CreateOnlineOrderResponse$1, CreateOfflineOrderRequest as CreateOfflineOrderRequest$1, CreateOfflineOrderResponse as CreateOfflineOrderResponse$1, GetOnlineOrderPreviewRequest as GetOnlineOrderPreviewRequest$1, GetOnlineOrderPreviewResponse as GetOnlineOrderPreviewResponse$1, GetOfflineOrderPreviewRequest as GetOfflineOrderPreviewRequest$1, GetOfflineOrderPreviewResponse as GetOfflineOrderPreviewResponse$1, GetPricePreviewRequest as GetPricePreviewRequest$1, GetPricePreviewResponse as GetPricePreviewResponse$1, GetOrderRequest as GetOrderRequest$1, GetOrderResponse as GetOrderResponse$1, ListOrdersRequest as ListOrdersRequest$1, ListOrdersResponse as ListOrdersResponse$1, PostponeEndDateRequest as PostponeEndDateRequest$1, PostponeEndDateResponse as PostponeEndDateResponse$1, CancelOrderRequest as CancelOrderRequest$1, CancelOrderResponse as CancelOrderResponse$1, MarkAsPaidRequest as MarkAsPaidRequest$1, MarkAsPaidResponse as MarkAsPaidResponse$1, PauseOrderRequest as PauseOrderRequest$1, PauseOrderResponse as PauseOrderResponse$1, ResumeOrderRequest as ResumeOrderRequest$1, ResumeOrderResponse as ResumeOrderResponse$1 } from './index.typings.js';
 import '@wix/sdk-types';
 
 /**
@@ -637,35 +637,7 @@ interface ActionEvent {
 }
 interface Empty {
 }
-interface OrderPurchased {
-    /** Order that was paid for. If a free or an offline order, the order that was created. */
-    order?: Order;
-}
-interface OrderStarted {
-    /** Order that reached its `startDate`. */
-    order?: Order;
-}
-/**
- * Triggered at the start of a new payment cycle for an existing order.
- *
- * This webhook does not trigger at the initial start of an offline order.
- */
-interface OrderCycleStarted {
-    /** Order whose new cycle started. */
-    order?: Order;
-    /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
-    cycleNumber?: number;
-}
-/** Emitted when a recurring order is canceled for the next payment cycle */
-interface OrderAutoRenewCanceled {
-    /** Order that is canceled, effective at the end of the current payment cycle. */
-    order?: Order;
-}
-interface OrderEnded {
-    /** Order that ended. */
-    order?: Order;
-}
-interface GetOrderRequest {
+interface MemberGetOrderRequest {
     /**
      * Order ID.
      * @format GUID
@@ -688,44 +660,31 @@ declare enum Set {
 }
 /** @enumType */
 type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
-interface GetOrderResponse {
-    /** Order. */
+interface MemberGetOrderResponse {
+    /** Requested order. */
     order?: Order;
 }
-interface ListOrdersRequest {
-    /**
-     * Filter by a buyer's member ID, from the Members API.
-     * @format GUID
-     */
-    buyerIds?: string[];
+interface MemberListOrdersRequest {
     /**
-     * Filter by plan IDs, from the Plans API.
+     * Filter by plan IDs.
      * @format GUID
      */
     planIds?: string[];
-    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
+    /** Filter for orders where auto renewal was canceled. */
     autoRenewCanceled?: boolean | null;
     /** Filter by order status. */
     orderStatuses?: OrderStatusWithLiterals[];
     /** Filter by payment status. */
     paymentStatuses?: PaymentStatusWithLiterals[];
     /**
-     * Number of orders to return. See Sorting and Paging for more information.
-     *
-     * Max: `50`
+     * Limit the number of pricing plans returned. Default limit is 50.
      * @min 1
      * @max 50
      */
     limit?: number | null;
-    /** Number of orders to skip in the current sort order. */
+    /** Number of entries to offset. */
     offset?: number | null;
-    /**
-     * Sort order.
-     *
-     * Use `ASC` for ascending order or `DESC` for descending order.
-     *
-     * Default: `DESC`.
-     */
+    /** Sorting direction (defaults to ASC) and field to sort by. */
     sorting?: Sorting;
     /**
      * Predefined set of fields to return.
@@ -749,8 +708,8 @@ declare enum SortOrder {
 }
 /** @enumType */
 type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-interface ListOrdersResponse {
-    /** List of orders. */
+interface MemberListOrdersResponse {
+    /** Requested orders. */
     orders?: Order[];
     /** Object containing paging-related data (number of orders returned, offset). */
     pagingMetadata?: PagingMetadataV2;
@@ -779,7 +738,11 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface OrdersQueryOrdersRequest {
+/**
+ * TODO: Write orders filter and sort docs page
+ * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
+ */
+interface QueryOrdersRequest {
     /** Query filter. */
     query?: QueryV2;
 }
@@ -833,84 +796,22 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface OrdersQueryOrdersResponse {
-    /** Retrieved orders. */
+interface QueryOrdersResponse {
+    /** Order data. */
     plans?: Order[];
     /** Paging-related data (number of orders returned, offset). */
     pagingMetadata?: PagingMetadataV2;
 }
-interface GetOrdersStatsRequest {
-}
-interface GetOrdersStatsResponse {
-    /** Total number of orders. */
-    totalOrderCount?: number;
-    /** Number of active orders. */
-    activeOrderCount?: number;
-}
-interface GetAvailableOrderActionsRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    id?: string;
-}
-interface GetAvailableOrderActionsResponse {
-    /** Whether the order can be suspended. */
-    suspendable?: boolean;
-    /** If the order cannot be suspended, a reason is returned here. */
-    notSuspendableReason?: ReasonNotSuspendableWithLiterals;
-    /** Whether the order can be canceled by the buyer. */
-    cancelableByBuyer?: boolean;
-}
-declare enum ReasonNotSuspendable {
-    /** Undefined reason. */
-    UNDEFINED = "UNDEFINED",
-    /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
-    PENDING = "PENDING",
-    /** Trial orders can't be suspended. */
-    TRIAL = "TRIAL",
-    /** Canceled orders can't be suspended. */
-    CANCELED = "CANCELED",
-    /** Ended orders can't be suspended. */
-    ENDED = "ENDED",
-    /** Paid for orders with future start dates can't be suspended. */
-    NOT_STARTED = "NOT_STARTED",
-    /** Order is already suspended. */
-    ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
-    /** Orders based on recurring payments using older stripe versions can't be suspended. */
-    OLD_STRIPE = "OLD_STRIPE"
-}
-/** @enumType */
-type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
-interface PostponeEndDateRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    id: string;
-    /**
-     * New end date and time.
-     *
-     * Must be later than the current end date and time.
-     */
-    endDate: Date | null;
-}
-interface PostponeEndDateResponse {
-}
-interface OrderEndDatePostponed {
-    /** Order whose `endDate` was postponed. */
-    order?: Order;
-}
-interface CancelOrderRequest {
+interface RequestCancellationRequest {
     /**
      * Order ID.
      * @format GUID
      */
     id: string;
-    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
+    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
     effectiveAt: CancellationEffectiveAtWithLiterals;
 }
-interface CancelOrderResponse {
+interface RequestCancellationResponse {
 }
 /**
  * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
@@ -921,111 +822,6 @@ interface OrderCanceled {
     /** Canceled order. */
     order?: Order;
 }
-interface MarkAsPaidRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    id: string;
-}
-interface MarkAsPaidResponse {
-}
-interface OrderMarkedAsPaid {
-    /** Order that was marked as paid. */
-    order?: Order;
-}
-interface PauseOrderRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    id: string;
-}
-interface PauseOrderResponse {
-}
-interface OrderPaused {
-    /** Paused order. */
-    order?: Order;
-}
-interface BulkPauseOrderRequest {
-    /**
-     * List of Order IDs.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    ids?: string[];
-    /** Set to true to return Order entity in response. */
-    returnFullEntity?: boolean;
-}
-interface BulkPauseOrderResponse {
-    /** Orders that were paused. */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkOrderResult {
-    /** Item metadata */
-    itemMetadata?: ItemMetadata;
-    /** The order. */
-    order?: Order;
-}
-interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
-interface ResumeOrderRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    id: string;
-}
-interface ResumeOrderResponse {
-}
-interface OrderResumed {
-    /** Resumed order. */
-    order?: Order;
-}
-interface BulkResumeOrderRequest {
-    /**
-     * List of Order IDs.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    ids?: string[];
-    /** Set to true to return Order entity in response. */
-    returnFullEntity?: boolean;
-}
-interface BulkResumeOrderResponse {
-    /** Orders that were resumed. */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
 interface MessageEnvelope {
     /**
      * App instance ID.
@@ -1098,93 +894,16 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-interface MemberGetOrderRequest {
+interface CreateOnlineOrderRequest {
     /**
-     * Order ID.
+     * Plan ID.
      * @format GUID
      */
-    id: string;
+    planId: string;
     /**
-     * Predefined set of fields to return.
+     * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
      *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    fieldSet?: SetWithLiterals;
-}
-interface MemberGetOrderResponse {
-    /** Requested order. */
-    order?: Order;
-}
-interface MemberListOrdersRequest {
-    /**
-     * Filter by plan IDs.
-     * @format GUID
-     */
-    planIds?: string[];
-    /** Filter for orders where auto renewal was canceled. */
-    autoRenewCanceled?: boolean | null;
-    /** Filter by order status. */
-    orderStatuses?: OrderStatusWithLiterals[];
-    /** Filter by payment status. */
-    paymentStatuses?: PaymentStatusWithLiterals[];
-    /**
-     * Limit the number of pricing plans returned. Default limit is 50.
-     * @min 1
-     * @max 50
-     */
-    limit?: number | null;
-    /** Number of entries to offset. */
-    offset?: number | null;
-    /** Sorting direction (defaults to ASC) and field to sort by. */
-    sorting?: Sorting;
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    fieldSet?: SetWithLiterals;
-}
-interface MemberListOrdersResponse {
-    /** Requested orders. */
-    orders?: Order[];
-    /** Object containing paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-/**
- * TODO: Write orders filter and sort docs page
- * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
- */
-interface QueryOrdersRequest {
-    /** Query filter. */
-    query?: QueryV2;
-}
-interface QueryOrdersResponse {
-    /** Order data. */
-    plans?: Order[];
-    /** Paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-interface RequestCancellationRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    id: string;
-    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
-    effectiveAt: CancellationEffectiveAtWithLiterals;
-}
-interface RequestCancellationResponse {
-}
-interface CreateOnlineOrderRequest {
-    /**
-     * Plan ID.
-     * @format GUID
-     */
-    planId: string;
-    /**
-     * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
-     *
-     * Default: Current date and time.
+     * Default: Current date and time.
      */
     startDate?: Date | null;
     /**
@@ -1302,188 +1021,469 @@ interface CreateOfflineOrderResponse {
     /** Order. */
     order?: Order;
 }
-interface CreateExternalOrderRequest {
+interface CreateExternalOrderRequest {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    planId?: string;
+    /**
+     * Form submission id that was submitted together with the order
+     * @format GUID
+     */
+    submissionId?: string | null;
+}
+interface CreateExternalOrderResponse {
+    /** Created order */
+    order?: Order;
+}
+interface GetOnlineOrderPreviewRequest {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     *
+     * Default: Current date and time.
+     */
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+}
+interface GetOnlineOrderPreviewResponse {
+    /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
+    order?: Order;
+    /** Whether the member has already reached purchase limit for the order's plan. */
+    purchaseLimitExceeded?: boolean;
+}
+interface GetGuestOnlineOrderPreviewRequest {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    planId?: string;
+    /**
+     * Start date for the ordered plan.
+     *
+     * Default: Current date
+     */
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /**
+     * Email for checkout
+     * @format EMAIL
+     */
+    email?: string;
+}
+interface GetGuestOnlineOrderPreviewResponse {
+    /** Will be missing if limit is exceeded */
+    order?: Order;
+    /**
+     * Whether the purchase limit has already been reached for this plan by this email.
+     * Always false for plans without purchase limits.
+     */
+    purchaseLimitExceeded?: boolean;
+}
+interface GetOfflineOrderPreviewRequest {
+    /**
+     * ID of the plan of the previewed order, from the Plans API.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Member ID of the buyer the previewed order is for, from the Members API.
+     * @format GUID
+     */
+    memberId: string;
+    /**
+     * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     *
+     * Default: Current date and time.
+     */
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+}
+interface GetOfflineOrderPreviewResponse {
+    /** The previewed order, as if the plan had been ordered. */
+    order?: Order;
+    /**
+     * Whether this previewed order would exceed the permitted amount of purchases available
+     * for this plan for this buyer.
+     *
+     * Always `false` for plans that do not have purchase limits.
+     */
+    purchaseLimitExceeded?: boolean;
+}
+interface GetPricePreviewRequest {
+    /**
+     * ID of plan to preview.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+}
+interface GetPricePreviewResponse {
+    /**
+     * __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
+     * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
+     * @replacedBy prices
+     * @targetRemovalDate 2022-10-01
+     */
+    price?: PriceDetails;
+    /** Pricing details. */
+    prices?: SpannedPrice[];
+}
+interface ChangeStartDateRequest {
+    /**
+     * Draft order ID.
+     * @format GUID
+     */
+    orderId?: string;
+    /** New valid from date (timestamp). */
+    startDate?: Date | null;
+}
+interface ChangeStartDateResponse {
+    /** Updated draft order. */
+    order?: Order;
+}
+interface OrderStartDateChanged {
+    /** Order whose `startDate` changed. */
+    order?: Order;
+}
+interface ApplyCouponRequest {
+    /**
+     * Draft order ID.
+     * @format GUID
+     */
+    orderId?: string;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string;
+}
+interface ApplyCouponResponse {
+    /** Order with applied coupon and recalculated tax. */
+    order?: Order;
+}
+interface SetSubmissionRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    orderId?: string;
+    /**
+     * Submission ID.
+     * @format GUID
+     */
+    submissionId?: string;
+}
+interface SetSubmissionResponse {
+    /** Order with submission id */
+    order?: Order;
+}
+interface OrderPurchased {
+    /** Order that was paid for. If a free or an offline order, the order that was created. */
+    order?: Order;
+}
+interface OrderStarted {
+    /** Order that reached its `startDate`. */
+    order?: Order;
+}
+/**
+ * Triggered at the start of a new payment cycle for an existing order.
+ *
+ * This webhook does not trigger at the initial start of an offline order.
+ */
+interface OrderCycleStarted {
+    /** Order whose new cycle started. */
+    order?: Order;
+    /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
+    cycleNumber?: number;
+}
+/** Emitted when a recurring order is canceled for the next payment cycle */
+interface OrderAutoRenewCanceled {
+    /** Order that is canceled, effective at the end of the current payment cycle. */
+    order?: Order;
+}
+interface OrderEnded {
+    /** Order that ended. */
+    order?: Order;
+}
+interface GetOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+interface GetOrderResponse {
+    /** Order. */
+    order?: Order;
+}
+interface ListOrdersRequest {
+    /**
+     * Filter by a buyer's member ID, from the Members API.
+     * @format GUID
+     */
+    buyerIds?: string[];
+    /**
+     * Filter by plan IDs, from the Plans API.
+     * @format GUID
+     */
+    planIds?: string[];
+    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
+    autoRenewCanceled?: boolean | null;
+    /** Filter by order status. */
+    orderStatuses?: OrderStatusWithLiterals[];
+    /** Filter by payment status. */
+    paymentStatuses?: PaymentStatusWithLiterals[];
+    /**
+     * Number of orders to return. See Sorting and Paging for more information.
+     *
+     * Max: `50`
+     * @min 1
+     * @max 50
+     */
+    limit?: number | null;
+    /** Number of orders to skip in the current sort order. */
+    offset?: number | null;
+    /**
+     * Sort order.
+     *
+     * Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `DESC`.
+     */
+    sorting?: Sorting;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+interface ListOrdersResponse {
+    /** List of orders. */
+    orders?: Order[];
+    /** Object containing paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface OrdersQueryOrdersRequest {
+    /** Query filter. */
+    query?: QueryV2;
+}
+interface OrdersQueryOrdersResponse {
+    /** Retrieved orders. */
+    plans?: Order[];
+    /** Paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface GetOrdersStatsRequest {
+}
+interface GetOrdersStatsResponse {
+    /** Total number of orders. */
+    totalOrderCount?: number;
+    /** Number of active orders. */
+    activeOrderCount?: number;
+}
+interface GetAvailableOrderActionsRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id?: string;
+}
+interface GetAvailableOrderActionsResponse {
+    /** Whether the order can be suspended. */
+    suspendable?: boolean;
+    /** If the order cannot be suspended, a reason is returned here. */
+    notSuspendableReason?: ReasonNotSuspendableWithLiterals;
+    /** Whether the order can be canceled by the buyer. */
+    cancelableByBuyer?: boolean;
+}
+declare enum ReasonNotSuspendable {
+    /** Undefined reason. */
+    UNDEFINED = "UNDEFINED",
+    /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
+    PENDING = "PENDING",
+    /** Trial orders can't be suspended. */
+    TRIAL = "TRIAL",
+    /** Canceled orders can't be suspended. */
+    CANCELED = "CANCELED",
+    /** Ended orders can't be suspended. */
+    ENDED = "ENDED",
+    /** Paid for orders with future start dates can't be suspended. */
+    NOT_STARTED = "NOT_STARTED",
+    /** Order is already suspended. */
+    ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
+    /** Orders based on recurring payments using older stripe versions can't be suspended. */
+    OLD_STRIPE = "OLD_STRIPE"
+}
+/** @enumType */
+type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
+interface PostponeEndDateRequest {
     /**
-     * Plan ID.
+     * Order ID.
      * @format GUID
      */
-    planId?: string;
+    id: string;
     /**
-     * Form submission id that was submitted together with the order
-     * @format GUID
+     * New end date and time.
+     *
+     * Must be later than the current end date and time.
      */
-    submissionId?: string | null;
+    endDate: Date | null;
 }
-interface CreateExternalOrderResponse {
-    /** Created order */
+interface PostponeEndDateResponse {
+}
+interface OrderEndDatePostponed {
+    /** Order whose `endDate` was postponed. */
     order?: Order;
 }
-interface GetOnlineOrderPreviewRequest {
+interface CancelOrderRequest {
     /**
-     * Plan ID.
+     * Order ID.
      * @format GUID
      */
-    planId: string;
-    /**
-     * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
-     *
-     * Default: Current date and time.
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
+    id: string;
+    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
+    effectiveAt: CancellationEffectiveAtWithLiterals;
 }
-interface GetOnlineOrderPreviewResponse {
-    /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
-    order?: Order;
-    /** Whether the member has already reached purchase limit for the order's plan. */
-    purchaseLimitExceeded?: boolean;
+interface CancelOrderResponse {
 }
-interface GetGuestOnlineOrderPreviewRequest {
+interface MarkAsPaidRequest {
     /**
-     * Plan ID.
+     * Order ID.
      * @format GUID
      */
-    planId?: string;
-    /**
-     * Start date for the ordered plan.
-     *
-     * Default: Current date
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
-    /**
-     * Email for checkout
-     * @format EMAIL
-     */
-    email?: string;
+    id: string;
 }
-interface GetGuestOnlineOrderPreviewResponse {
-    /** Will be missing if limit is exceeded */
+interface MarkAsPaidResponse {
+}
+interface OrderMarkedAsPaid {
+    /** Order that was marked as paid. */
     order?: Order;
-    /**
-     * Whether the purchase limit has already been reached for this plan by this email.
-     * Always false for plans without purchase limits.
-     */
-    purchaseLimitExceeded?: boolean;
 }
-interface GetOfflineOrderPreviewRequest {
-    /**
-     * ID of the plan of the previewed order, from the Plans API.
-     * @format GUID
-     */
-    planId: string;
+interface PauseOrderRequest {
     /**
-     * Member ID of the buyer the previewed order is for, from the Members API.
+     * Order ID.
      * @format GUID
      */
-    memberId: string;
-    /**
-     * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
-     *
-     * Default: Current date and time.
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply, from the Coupons API.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
+    id: string;
 }
-interface GetOfflineOrderPreviewResponse {
-    /** The previewed order, as if the plan had been ordered. */
+interface PauseOrderResponse {
+}
+interface OrderPaused {
+    /** Paused order. */
     order?: Order;
-    /**
-     * Whether this previewed order would exceed the permitted amount of purchases available
-     * for this plan for this buyer.
-     *
-     * Always `false` for plans that do not have purchase limits.
-     */
-    purchaseLimitExceeded?: boolean;
 }
-interface GetPricePreviewRequest {
+interface BulkPauseOrderRequest {
     /**
-     * ID of plan to preview.
+     * List of Order IDs.
      * @format GUID
+     * @minSize 1
+     * @maxSize 100
      */
-    planId: string;
-    /**
-     * Coupon code to apply, from the Coupons API.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
-}
-interface GetPricePreviewResponse {
-    /**
-     * __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
-     * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
-     * @replacedBy prices
-     * @targetRemovalDate 2022-10-01
-     */
-    price?: PriceDetails;
-    /** Pricing details. */
-    prices?: SpannedPrice[];
+    ids?: string[];
+    /** Set to true to return Order entity in response. */
+    returnFullEntity?: boolean;
 }
-interface ChangeStartDateRequest {
-    /**
-     * Draft order ID.
-     * @format GUID
-     */
-    orderId?: string;
-    /** New valid from date (timestamp). */
-    startDate?: Date | null;
+interface BulkPauseOrderResponse {
+    /** Orders that were paused. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
 }
-interface ChangeStartDateResponse {
-    /** Updated draft order. */
+interface BulkOrderResult {
+    /** Item metadata */
+    itemMetadata?: ItemMetadata;
+    /** The order. */
     order?: Order;
 }
-interface OrderStartDateChanged {
-    /** Order whose `startDate` changed. */
-    order?: Order;
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
 }
-interface ApplyCouponRequest {
-    /**
-     * Draft order ID.
-     * @format GUID
-     */
-    orderId?: string;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string;
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
 }
-interface ApplyCouponResponse {
-    /** Order with applied coupon and recalculated tax. */
-    order?: Order;
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
 }
-interface SetSubmissionRequest {
+interface ResumeOrderRequest {
     /**
      * Order ID.
      * @format GUID
      */
-    orderId?: string;
+    id: string;
+}
+interface ResumeOrderResponse {
+}
+interface OrderResumed {
+    /** Resumed order. */
+    order?: Order;
+}
+interface BulkResumeOrderRequest {
     /**
-     * Submission ID.
+     * List of Order IDs.
      * @format GUID
+     * @minSize 1
+     * @maxSize 100
      */
-    submissionId?: string;
+    ids?: string[];
+    /** Set to true to return Order entity in response. */
+    returnFullEntity?: boolean;
 }
-interface SetSubmissionResponse {
-    /** Order with submission id */
-    order?: Order;
+interface BulkResumeOrderResponse {
+    /** Orders that were resumed. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
 }
 /** @docsIgnore */
 type CreateOnlineOrderApplicationErrors = {
@@ -1792,6 +1792,18 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
     __responseType: Q;
     __originalResponseType: R;
 };
+declare function memberGetOrder(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, MemberGetOrderRequest$1, MemberGetOrderRequest, MemberGetOrderResponse$1, MemberGetOrderResponse>;
+declare function memberListOrders(): __PublicMethodMetaInfo<'GET', {}, MemberListOrdersRequest$1, MemberListOrdersRequest, MemberListOrdersResponse$1, MemberListOrdersResponse>;
+declare function requestCancellation(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, RequestCancellationRequest$1, RequestCancellationRequest, RequestCancellationResponse$1, RequestCancellationResponse>;
+declare function createOnlineOrder(): __PublicMethodMetaInfo<'POST', {}, CreateOnlineOrderRequest$1, CreateOnlineOrderRequest, CreateOnlineOrderResponse$1, CreateOnlineOrderResponse>;
+declare function createOfflineOrder(): __PublicMethodMetaInfo<'POST', {}, CreateOfflineOrderRequest$1, CreateOfflineOrderRequest, CreateOfflineOrderResponse$1, CreateOfflineOrderResponse>;
+declare function getOnlineOrderPreview(): __PublicMethodMetaInfo<'POST', {}, GetOnlineOrderPreviewRequest$1, GetOnlineOrderPreviewRequest, GetOnlineOrderPreviewResponse$1, GetOnlineOrderPreviewResponse>;
+declare function getOfflineOrderPreview(): __PublicMethodMetaInfo<'POST', {}, GetOfflineOrderPreviewRequest$1, GetOfflineOrderPreviewRequest, GetOfflineOrderPreviewResponse$1, GetOfflineOrderPreviewResponse>;
+declare function getPricePreview(): __PublicMethodMetaInfo<'POST', {}, GetPricePreviewRequest$1, GetPricePreviewRequest, GetPricePreviewResponse$1, GetPricePreviewResponse>;
 declare function managementGetOrder(): __PublicMethodMetaInfo<'GET', {
     id: string;
 }, GetOrderRequest$1, GetOrderRequest, GetOrderResponse$1, GetOrderResponse>;
@@ -1811,17 +1823,5 @@ declare function pauseOrder(): __PublicMethodMetaInfo<'POST', {
 declare function resumeOrder(): __PublicMethodMetaInfo<'POST', {
     id: string;
 }, ResumeOrderRequest$1, ResumeOrderRequest, ResumeOrderResponse$1, ResumeOrderResponse>;
-declare function memberGetOrder(): __PublicMethodMetaInfo<'GET', {
-    id: string;
-}, MemberGetOrderRequest$1, MemberGetOrderRequest, MemberGetOrderResponse$1, MemberGetOrderResponse>;
-declare function memberListOrders(): __PublicMethodMetaInfo<'GET', {}, MemberListOrdersRequest$1, MemberListOrdersRequest, MemberListOrdersResponse$1, MemberListOrdersResponse>;
-declare function requestCancellation(): __PublicMethodMetaInfo<'POST', {
-    id: string;
-}, RequestCancellationRequest$1, RequestCancellationRequest, RequestCancellationResponse$1, RequestCancellationResponse>;
-declare function createOnlineOrder(): __PublicMethodMetaInfo<'POST', {}, CreateOnlineOrderRequest$1, CreateOnlineOrderRequest, CreateOnlineOrderResponse$1, CreateOnlineOrderResponse>;
-declare function createOfflineOrder(): __PublicMethodMetaInfo<'POST', {}, CreateOfflineOrderRequest$1, CreateOfflineOrderRequest, CreateOfflineOrderResponse$1, CreateOfflineOrderResponse>;
-declare function getOnlineOrderPreview(): __PublicMethodMetaInfo<'POST', {}, GetOnlineOrderPreviewRequest$1, GetOnlineOrderPreviewRequest, GetOnlineOrderPreviewResponse$1, GetOnlineOrderPreviewResponse>;
-declare function getOfflineOrderPreview(): __PublicMethodMetaInfo<'POST', {}, GetOfflineOrderPreviewRequest$1, GetOfflineOrderPreviewRequest, GetOfflineOrderPreviewResponse$1, GetOfflineOrderPreviewResponse>;
-declare function getPricePreview(): __PublicMethodMetaInfo<'POST', {}, GetPricePreviewRequest$1, GetPricePreviewRequest, GetPricePreviewResponse$1, GetPricePreviewResponse>;
 
 export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type ApplyCouponRequest as ApplyCouponRequestOriginal, type ApplyCouponResponse as ApplyCouponResponseOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkPauseOrderRequest as BulkPauseOrderRequestOriginal, type BulkPauseOrderResponse as BulkPauseOrderResponseOriginal, type BulkResumeOrderRequest as BulkResumeOrderRequestOriginal, type BulkResumeOrderResponse as BulkResumeOrderResponseOriginal, type Buyer as BuyerOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, CancellationCause as CancellationCauseOriginal, type CancellationCauseWithLiterals as CancellationCauseWithLiteralsOriginal, CancellationEffectiveAt as CancellationEffectiveAtOriginal, type CancellationEffectiveAtWithLiterals as CancellationEffectiveAtWithLiteralsOriginal, type Cancellation as CancellationOriginal, type Captcha as CaptchaOriginal, type ChangeStartDateRequest as ChangeStartDateRequestOriginal, type ChangeStartDateResponse as ChangeStartDateResponseOriginal, type Coupon as CouponOriginal, type CouponsError as CouponsErrorOriginal, type CreateExternalOrderRequest as CreateExternalOrderRequestOriginal, type CreateExternalOrderResponse as CreateExternalOrderResponseOriginal, type CreateGuestOnlineOrderRequest as CreateGuestOnlineOrderRequestOriginal, type CreateGuestOnlineOrderResponse as CreateGuestOnlineOrderResponseOriginal, type CreateOfflineOrderApplicationErrors as CreateOfflineOrderApplicationErrorsOriginal, type CreateOfflineOrderRequest as CreateOfflineOrderRequestOriginal, type CreateOfflineOrderResponse as CreateOfflineOrderResponseOriginal, type CreateOfflineOrderValidationErrors as CreateOfflineOrderValidationErrorsOriginal, type CreateOnlineOrderApplicationErrors as CreateOnlineOrderApplicationErrorsOriginal, type CreateOnlineOrderRequest as CreateOnlineOrderRequestOriginal, type CreateOnlineOrderResponse as CreateOnlineOrderResponseOriginal, type CreateOnlineOrderValidationErrors as CreateOnlineOrderValidationErrorsOriginal, type CurrentCycle as CurrentCycleOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Duration as DurationOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type Fee as FeeOriginal, type FormData as FormDataOriginal, type GetAvailableOrderActionsRequest as GetAvailableOrderActionsRequestOriginal, type GetAvailableOrderActionsResponse as GetAvailableOrderActionsResponseOriginal, type GetGuestOnlineOrderPreviewRequest as GetGuestOnlineOrderPreviewRequestOriginal, type GetGuestOnlineOrderPreviewResponse as GetGuestOnlineOrderPreviewResponseOriginal, type GetOfflineOrderPreviewApplicationErrors as GetOfflineOrderPreviewApplicationErrorsOriginal, type GetOfflineOrderPreviewRequest as GetOfflineOrderPreviewRequestOriginal, type GetOfflineOrderPreviewResponse as GetOfflineOrderPreviewResponseOriginal, type GetOfflineOrderPreviewValidationErrors as GetOfflineOrderPreviewValidationErrorsOriginal, type GetOnlineOrderPreviewApplicationErrors as GetOnlineOrderPreviewApplicationErrorsOriginal, type GetOnlineOrderPreviewRequest as GetOnlineOrderPreviewRequestOriginal, type GetOnlineOrderPreviewResponse as GetOnlineOrderPreviewResponseOriginal, type GetOnlineOrderPreviewValidationErrors as GetOnlineOrderPreviewValidationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetOrdersStatsRequest as GetOrdersStatsRequestOriginal, type GetOrdersStatsResponse as GetOrdersStatsResponseOriginal, type GetPricePreviewApplicationErrors as GetPricePreviewApplicationErrorsOriginal, type GetPricePreviewRequest as GetPricePreviewRequestOriginal, type GetPricePreviewResponse as GetPricePreviewResponseOriginal, type Guest as GuestOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type ListOrdersRequest as ListOrdersRequestOriginal, type ListOrdersResponse as ListOrdersResponseOriginal, type MarkAsPaidRequest as MarkAsPaidRequestOriginal, type MarkAsPaidResponse as MarkAsPaidResponseOriginal, type MemberGetOrderRequest as MemberGetOrderRequestOriginal, type MemberGetOrderResponse as MemberGetOrderResponseOriginal, type MemberListOrdersRequest as MemberListOrdersRequestOriginal, type MemberListOrdersResponse as MemberListOrdersResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type OnBehalf as OnBehalfOriginal, type OrderAutoRenewCanceled as OrderAutoRenewCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderCycle as OrderCycleOriginal, type OrderCycleStarted as OrderCycleStartedOriginal, type OrderEndDatePostponed as OrderEndDatePostponedOriginal, type OrderEnded as OrderEndedOriginal, type OrderMarkedAsPaid as OrderMarkedAsPaidOriginal, OrderMethod as OrderMethodOriginal, type OrderMethodWithLiterals as OrderMethodWithLiteralsOriginal, type Order as OrderOriginal, type OrderPaused as OrderPausedOriginal, type OrderPurchased as OrderPurchasedOriginal, type OrderResumed as OrderResumedOriginal, type OrderStartDateChanged as OrderStartDateChangedOriginal, type OrderStarted as OrderStartedOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, OrderType as OrderTypeOriginal, type OrderTypeWithLiterals as OrderTypeWithLiteralsOriginal, type OrdersQueryOrdersRequest as OrdersQueryOrdersRequestOriginal, type OrdersQueryOrdersResponse as OrdersQueryOrdersResponseOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PauseOrderRequest as PauseOrderRequestOriginal, type PauseOrderResponse as PauseOrderResponseOriginal, type PausePeriod as PausePeriodOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, PeriodUnit as PeriodUnitOriginal, type PeriodUnitWithLiterals as PeriodUnitWithLiteralsOriginal, type PostponeEndDateRequest as PostponeEndDateRequestOriginal, type PostponeEndDateResponse as PostponeEndDateResponseOriginal, type PriceDetails as PriceDetailsOriginal, type PriceDetailsPricingModelOneOf as PriceDetailsPricingModelOneOfOriginal, type PriceDuration as PriceDurationOriginal, type Price as PriceOriginal, type PricingDetails as PricingDetailsOriginal, type PricingDetailsPricingModelOneOf as PricingDetailsPricingModelOneOfOriginal, type QueryOrdersRequest as QueryOrdersRequestOriginal, type QueryOrdersResponse as QueryOrdersResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, ReasonNotSuspendable as ReasonNotSuspendableOriginal, type ReasonNotSuspendableWithLiterals as ReasonNotSuspendableWithLiteralsOriginal, type Recurrence as RecurrenceOriginal, type RequestCancellationRequest as RequestCancellationRequestOriginal, type RequestCancellationResponse as RequestCancellationResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type ResumeOrderRequest as ResumeOrderRequestOriginal, type ResumeOrderResponse as ResumeOrderResponseOriginal, Set as SetOriginal, type SetSubmissionRequest as SetSubmissionRequestOriginal, type SetSubmissionResponse as SetSubmissionResponseOriginal, type SetWithLiterals as SetWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SpannedPrice as SpannedPriceOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type Tax as TaxOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };