@wix/auto_sdk_pricing-plans_orders 1.0.127 → 1.0.128

package/build/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { 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, MemberGetOrderRequest as MemberGetOrderRequest$1, MemberGetOrderResponse as MemberGetOrderResponse$1, MemberListOrdersRequest as MemberListOrdersRequest$1, MemberListOrdersResponse as MemberListOrdersResponse$1, RequestCancellationRequest as RequestCancellationRequest$1, RequestCancellationResponse as RequestCancellationResponse$1 } from './index.typings.js';
+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, 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, MemberGetOrderRequest as MemberGetOrderRequest$1, MemberGetOrderResponse as MemberGetOrderResponse$1, MemberListOrdersRequest as MemberListOrdersRequest$1, MemberListOrdersResponse as MemberListOrdersResponse$1, RequestCancellationRequest as RequestCancellationRequest$1, RequestCancellationResponse as RequestCancellationResponse$1 } from './index.typings.js';
 import '@wix/sdk-types';
 
 /**
@@ -637,315 +637,345 @@ interface ActionEvent {
 }
 interface Empty {
 }
-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.
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
-    /** Provided if checkout is initiated on buyer's behalf. */
-    onBehalf?: OnBehalf;
-    /**
-     * Submission ID of the form submitted with this order.
-     * @format GUID
-     */
-    submissionId?: string | null;
+interface OrderPurchased {
+    /** Order that was paid for. If a free or an offline order, the order that was created. */
+    order?: Order;
 }
-interface OnBehalf {
-    /**
-     * Member ID.
-     * @format GUID
-     */
-    memberId?: string;
-    /** Method by which checkout is initiated. */
-    orderMethod?: OrderMethodWithLiterals;
+interface OrderStarted {
+    /** Order that reached its `startDate`. */
+    order?: Order;
 }
-interface CreateOnlineOrderResponse {
-    /** Created online 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;
 }
-interface CouponsError {
-    /** Coupon code. */
-    couponCode?: string;
-    /** Plan ID. */
-    planId?: string;
+/** 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 CreateGuestOnlineOrderRequest {
+interface OrderEnded {
+    /** Order that ended. */
+    order?: Order;
+}
+interface GetOrderRequest {
     /**
-     * Plan ID.
+     * Order ID.
      * @format GUID
      */
-    planId?: string;
+    id: string;
     /**
-     * Start date for the ordered plan.
+     * Predefined set of fields to return.
      *
-     * Default: Current date
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
-    /** Captcha data to prove you are not a robot */
-    captcha?: Captcha;
-    /** Visitor info */
-    guest?: Guest;
-    /**
-     * Form submission id that was submitted together with the order
-     * @format GUID
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
      */
-    submissionId?: string | null;
-}
-interface Captcha {
-    /** Token from captcha */
-    token?: string;
+    fieldSet?: SetWithLiterals;
 }
-interface Guest {
-    /**
-     * Email for checkout
-     * @format EMAIL
-     */
-    email?: string;
+declare enum Set {
+    /** Same behavior as `BASIC`.` */
+    UNKNOWN_SET = "UNKNOWN_SET",
+    /** Doesn't return any order form submission data. */
+    BASIC = "BASIC",
+    /** Returns all order form submission data. */
+    FULL = "FULL"
 }
-interface CreateGuestOnlineOrderResponse {
+/** @enumType */
+type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
+interface GetOrderResponse {
     /** Order. */
     order?: Order;
 }
-interface CreateOfflineOrderRequest {
+interface ListOrdersRequest {
     /**
-     * ID of the plan being ordered, from the Plans API.
+     * Filter by a buyer's member ID, from the Members API.
      * @format GUID
      */
-    planId: string;
+    buyerIds?: string[];
     /**
-     * ID of the member ordering the plan, from the Members API.
+     * Filter by plan IDs, from the Plans API.
      * @format GUID
      */
-    memberId: string;
+    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[];
     /**
-     * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     * Number of orders to return. See Sorting and Paging for more information.
      *
-     * Default: Current date and time.
+     * Max: `50`
+     * @min 1
+     * @max 50
      */
-    startDate?: Date | null;
+    limit?: number | null;
+    /** Number of orders to skip in the current sort order. */
+    offset?: number | null;
     /**
-     * Whether the order is paid.
+     * Sort order.
      *
-     * Default: `false`
-     */
-    paid?: boolean | null;
-    /**
-     * Coupon code to apply, from the Coupons API.
-     * @minLength 1
-     * @maxLength 20
+     * Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `DESC`.
      */
-    couponCode?: string | null;
+    sorting?: Sorting;
     /**
-     * Form submission ID that was submitted with the order.
-     * @format GUID
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
      */
-    submissionId?: string | null;
-}
-interface CreateOfflineOrderResponse {
-    /** Order. */
-    order?: Order;
+    fieldSet?: SetWithLiterals;
 }
-interface CreateExternalOrderRequest {
+interface Sorting {
     /**
-     * Plan ID.
-     * @format GUID
+     * Name of the field to sort by.
+     * @maxLength 512
      */
-    planId?: string;
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
     /**
-     * Form submission id that was submitted together with the order
-     * @format GUID
+     * Origin point for geo-distance sorting on a GEO field
+     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
      */
-    submissionId?: string | null;
+    origin?: AddressLocation;
 }
-interface CreateExternalOrderResponse {
-    /** Created order */
-    order?: Order;
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
 }
-interface GetOnlineOrderPreviewRequest {
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface ListOrdersResponse {
+    /** List of orders. */
+    orders?: Order[];
+    /** Object containing paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
     /**
-     * Plan ID.
-     * @format GUID
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
      */
-    planId: string;
+    next?: string | null;
     /**
-     * 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.
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
      */
-    startDate?: Date | null;
+    prev?: string | null;
+}
+interface GetOrdersStatsRequest {
+}
+interface GetOrdersStatsResponse {
+    /** Total number of orders. */
+    totalOrderCount?: number;
+    /** Number of active orders. */
+    activeOrderCount?: number;
+}
+interface GetAvailableOrderActionsRequest {
     /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
+     * Order ID.
+     * @format GUID
      */
-    couponCode?: string | null;
+    id?: string;
 }
-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 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;
 }
-interface GetGuestOnlineOrderPreviewRequest {
+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;
     /**
-     * Start date for the ordered plan.
+     * New end date and time.
      *
-     * Default: Current date
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
-    /**
-     * Email for checkout
-     * @format EMAIL
+     * Must be later than the current end date and time.
      */
-    email?: string;
+    endDate: Date | null;
 }
-interface GetGuestOnlineOrderPreviewResponse {
-    /** Will be missing if limit is exceeded */
+interface PostponeEndDateResponse {
+}
+interface OrderEndDatePostponed {
+    /** Order whose `endDate` was postponed. */
     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 {
+interface CancelOrderRequest {
     /**
-     * ID of the plan of the previewed order, from the Plans API.
+     * Order ID.
      * @format GUID
      */
-    planId: string;
+    id: string;
+    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
+    effectiveAt: CancellationEffectiveAtWithLiterals;
+}
+interface CancelOrderResponse {
+}
+/**
+ * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
+ *
+ * To determine the specific reason of the cancellation check `order.cancellation.cause` field.
+ */
+interface OrderCanceled {
+    /** Canceled order. */
+    order?: Order;
+}
+interface MarkAsPaidRequest {
     /**
-     * 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 MarkAsPaidResponse {
+}
+interface OrderMarkedAsPaid {
+    /** Order that was marked as paid. */
     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 PauseOrderRequest {
     /**
-     * ID of plan to preview.
+     * Order ID.
      * @format GUID
      */
-    planId: string;
-    /**
-     * Coupon code to apply, from the Coupons API.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
+    id: string;
 }
-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 PauseOrderResponse {
 }
-interface ChangeStartDateRequest {
+interface OrderPaused {
+    /** Paused order. */
+    order?: Order;
+}
+interface BulkPauseOrderRequest {
     /**
-     * Draft order ID.
+     * List of Order IDs.
      * @format GUID
+     * @minSize 1
+     * @maxSize 100
      */
-    orderId?: string;
-    /** New valid from date (timestamp). */
-    startDate?: Date | null;
+    ids?: string[];
+    /** Set to true to return Order entity in response. */
+    returnFullEntity?: boolean;
 }
-interface ChangeStartDateResponse {
-    /** Updated draft order. */
-    order?: Order;
+interface BulkPauseOrderResponse {
+    /** Orders that were paused. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
 }
-interface OrderStartDateChanged {
-    /** Order whose `startDate` changed. */
+interface BulkOrderResult {
+    /** Item metadata */
+    itemMetadata?: ItemMetadata;
+    /** The order. */
     order?: Order;
 }
-interface ApplyCouponRequest {
+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 {
     /**
-     * Draft order ID.
+     * Order ID.
      * @format GUID
      */
-    orderId?: string;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string;
+    id: string;
 }
-interface ApplyCouponResponse {
-    /** Order with applied coupon and recalculated tax. */
+interface ResumeOrderResponse {
+}
+interface OrderResumed {
+    /** Resumed order. */
     order?: Order;
 }
-interface SetSubmissionRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    orderId?: string;
+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;
 }
 interface MessageEnvelope {
     /**
@@ -1038,345 +1068,315 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
-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;
+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.
+     */
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /** Provided if checkout is initiated on buyer's behalf. */
+    onBehalf?: OnBehalf;
+    /**
+     * Submission ID of the form submitted with this order.
+     * @format GUID
+     */
+    submissionId?: string | null;
 }
-/**
- * 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;
+interface OnBehalf {
+    /**
+     * Member ID.
+     * @format GUID
+     */
+    memberId?: string;
+    /** Method by which checkout is initiated. */
+    orderMethod?: OrderMethodWithLiterals;
 }
-/** 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. */
+interface CreateOnlineOrderResponse {
+    /** Created online order. */
     order?: Order;
 }
-interface OrderEnded {
-    /** Order that ended. */
-    order?: Order;
+interface CouponsError {
+    /** Coupon code. */
+    couponCode?: string;
+    /** Plan ID. */
+    planId?: string;
 }
-interface GetOrderRequest {
+interface CreateGuestOnlineOrderRequest {
     /**
-     * Order ID.
+     * Plan ID.
      * @format GUID
      */
-    id: string;
+    planId?: string;
     /**
-     * Predefined set of fields to return.
+     * Start date for the ordered plan.
      *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     * Default: Current date
      */
-    fieldSet?: SetWithLiterals;
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /** Captcha data to prove you are not a robot */
+    captcha?: Captcha;
+    /** Visitor info */
+    guest?: Guest;
+    /**
+     * Form submission id that was submitted together with the order
+     * @format GUID
+     */
+    submissionId?: string | null;
 }
-declare enum Set {
-    /** Same behavior as `BASIC`.` */
-    UNKNOWN_SET = "UNKNOWN_SET",
-    /** Doesn't return any order form submission data. */
-    BASIC = "BASIC",
-    /** Returns all order form submission data. */
-    FULL = "FULL"
+interface Captcha {
+    /** Token from captcha */
+    token?: string;
 }
-/** @enumType */
-type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
-interface GetOrderResponse {
+interface Guest {
+    /**
+     * Email for checkout
+     * @format EMAIL
+     */
+    email?: string;
+}
+interface CreateGuestOnlineOrderResponse {
     /** Order. */
     order?: Order;
 }
-interface ListOrdersRequest {
+interface CreateOfflineOrderRequest {
     /**
-     * Filter by a buyer's member ID, from the Members API.
+     * ID of the plan being ordered, from the Plans API.
      * @format GUID
      */
-    buyerIds?: string[];
+    planId: string;
     /**
-     * Filter by plan IDs, from the Plans API.
+     * ID of the member ordering the plan, from the Members 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[];
+    memberId: string;
     /**
-     * Number of orders to return. See Sorting and Paging for more information.
+     * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
      *
-     * Max: `50`
-     * @min 1
-     * @max 50
+     * Default: Current date and time.
      */
-    limit?: number | null;
-    /** Number of orders to skip in the current sort order. */
-    offset?: number | null;
+    startDate?: Date | null;
     /**
-     * Sort order.
-     *
-     * Use `ASC` for ascending order or `DESC` for descending order.
+     * Whether the order is paid.
      *
-     * Default: `DESC`.
+     * Default: `false`
      */
-    sorting?: Sorting;
+    paid?: boolean | null;
     /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
      */
-    fieldSet?: SetWithLiterals;
+    couponCode?: string | null;
+    /**
+     * Form submission ID that was submitted with the order.
+     * @format GUID
+     */
+    submissionId?: string | null;
 }
-interface Sorting {
+interface CreateOfflineOrderResponse {
+    /** Order. */
+    order?: Order;
+}
+interface CreateExternalOrderRequest {
     /**
-     * Name of the field to sort by.
-     * @maxLength 512
+     * Plan ID.
+     * @format GUID
      */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
+    planId?: string;
     /**
-     * Origin point for geo-distance sorting on a GEO field
-     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+     * Form submission id that was submitted together with the order
+     * @format GUID
      */
-    origin?: AddressLocation;
-}
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
+    submissionId?: string | null;
 }
-/** @enumType */
-type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-interface AddressLocation {
-    /** Address latitude. */
-    latitude?: number | null;
-    /** Address longitude. */
-    longitude?: number | null;
+interface CreateExternalOrderResponse {
+    /** Created order */
+    order?: Order;
 }
-interface ListOrdersResponse {
-    /** List of orders. */
-    orders?: Order[];
-    /** Object containing paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
+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 PagingMetadataV2 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
+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 Cursors {
+interface GetGuestOnlineOrderPreviewRequest {
     /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
+     * Plan ID.
+     * @format GUID
      */
-    next?: string | null;
+    planId?: string;
     /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
+     * Start date for the ordered plan.
+     *
+     * Default: Current date
      */
-    prev?: string | null;
-}
-interface GetOrdersStatsRequest {
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /**
+     * Email for checkout
+     * @format EMAIL
+     */
+    email?: string;
 }
-interface GetOrdersStatsResponse {
-    /** Total number of orders. */
-    totalOrderCount?: number;
-    /** Number of active orders. */
-    activeOrderCount?: number;
+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 GetAvailableOrderActionsRequest {
+interface GetOfflineOrderPreviewRequest {
     /**
-     * Order ID.
+     * ID of the plan of the previewed order, from the Plans API.
      * @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 {
+    planId: string;
     /**
-     * Order ID.
+     * Member ID of the buyer the previewed order is for, from the Members API.
      * @format GUID
      */
-    id: string;
+    memberId: string;
     /**
-     * New end date and time.
+     * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
      *
-     * Must be later than the current end date and time.
+     * Default: Current date and time.
      */
-    endDate: Date | null;
-}
-interface PostponeEndDateResponse {
-}
-interface OrderEndDatePostponed {
-    /** Order whose `endDate` was postponed. */
-    order?: Order;
-}
-interface CancelOrderRequest {
+    startDate?: Date | null;
     /**
-     * Order ID.
-     * @format GUID
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
      */
-    id: string;
-    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
-    effectiveAt: CancellationEffectiveAtWithLiterals;
-}
-interface CancelOrderResponse {
+    couponCode?: string | null;
 }
-/**
- * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
- *
- * To determine the specific reason of the cancellation check `order.cancellation.cause` field.
- */
-interface OrderCanceled {
-    /** Canceled order. */
+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 MarkAsPaidRequest {
+interface GetPricePreviewRequest {
     /**
-     * Order ID.
+     * ID of plan to preview.
      * @format GUID
      */
-    id: string;
-}
-interface MarkAsPaidResponse {
+    planId: string;
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
 }
-interface OrderMarkedAsPaid {
-    /** Order that was marked as paid. */
-    order?: Order;
+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 PauseOrderRequest {
+interface ChangeStartDateRequest {
     /**
-     * Order ID.
+     * Draft order ID.
      * @format GUID
      */
-    id: string;
+    orderId?: string;
+    /** New valid from date (timestamp). */
+    startDate?: Date | null;
 }
-interface PauseOrderResponse {
+interface ChangeStartDateResponse {
+    /** Updated draft order. */
+    order?: Order;
 }
-interface OrderPaused {
-    /** Paused order. */
+interface OrderStartDateChanged {
+    /** Order whose `startDate` changed. */
     order?: Order;
 }
-interface BulkPauseOrderRequest {
+interface ApplyCouponRequest {
     /**
-     * List of Order IDs.
+     * Draft order ID.
      * @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;
+    orderId?: string;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string;
 }
-interface BulkOrderResult {
-    /** Item metadata */
-    itemMetadata?: ItemMetadata;
-    /** The order. */
+interface ApplyCouponResponse {
+    /** Order with applied coupon and recalculated tax. */
     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 {
+interface SetSubmissionRequest {
     /**
      * Order ID.
      * @format GUID
      */
-    id: string;
-}
-interface ResumeOrderResponse {
-}
-interface OrderResumed {
-    /** Resumed order. */
-    order?: Order;
-}
-interface BulkResumeOrderRequest {
+    orderId?: string;
     /**
-     * List of Order IDs.
+     * Submission ID.
      * @format GUID
-     * @minSize 1
-     * @maxSize 100
      */
-    ids?: string[];
-    /** Set to true to return Order entity in response. */
-    returnFullEntity?: boolean;
+    submissionId?: string;
 }
-interface BulkResumeOrderResponse {
-    /** Orders that were resumed. */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
+interface SetSubmissionResponse {
+    /** Order with submission id */
+    order?: Order;
 }
 interface MemberGetOrderRequest {
     /**
@@ -1748,11 +1748,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
     __responseType: Q;
     __originalResponseType: R;
 };
-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>;
@@ -1772,6 +1767,11 @@ declare function pauseOrder(): __PublicMethodMetaInfo<'POST', {
 declare function resumeOrder(): __PublicMethodMetaInfo<'POST', {
     id: string;
 }, ResumeOrderRequest$1, ResumeOrderRequest, ResumeOrderResponse$1, ResumeOrderResponse>;
+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 memberGetOrder(): __PublicMethodMetaInfo<'GET', {
     id: string;
 }, MemberGetOrderRequest$1, MemberGetOrderRequest, MemberGetOrderResponse$1, MemberGetOrderResponse>;