@wix/auto_sdk_pricing-plans_orders 1.0.76 → 1.0.77

package/build/cjs/meta.d.ts

@@ -398,6 +398,19 @@ interface Price {
      */
     proration?: string;
 }
+interface Fee {
+    /**
+     * Fee name
+     * @minLength 1
+     * @maxLength 40
+     */
+    name?: string;
+    /**
+     * Amount of fee to be charged
+     * @decimalValue options { lt:1000000000000, gt:0.000, maxScale:3 }
+     */
+    amount?: string;
+}
 declare enum OrderType {
     /** Undefined order type. */
     UNDEFINED = "UNDEFINED",
@@ -528,6 +541,19 @@ interface CurrentCycle {
     /** End date and time for the current payment cycle. */
     endedDate?: Date | null;
 }
+/** Order cycle start and end dates take into account free trial days and suspensions */
+interface OrderCycle {
+    /**
+     * Index of this cycle in the order.
+     *
+     * `0` when order is in a free trial period. In all other cases, the index starts with `1`.
+     */
+    index?: number;
+    /** Start date and time for this order cycle. */
+    startedDate?: Date | null;
+    /** End date and time for this order cycle. */
+    endedDate?: Date | null;
+}
 interface FormData {
     /**
      * ID of the order form ([REST](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction)) associated with the plan at checkout.
@@ -545,6 +571,100 @@ interface FormData {
      */
     submissionData?: Record<string, any>;
 }
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+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 {
     /**
      * Order ID.
@@ -659,6 +779,109 @@ interface Cursors {
      */
     prev?: string | null;
 }
+interface OrdersQueryOrdersRequest {
+    /** Query filter. */
+    query?: QueryV2;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+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 {
     /**
      * Order ID.
@@ -674,6 +897,10 @@ interface PostponeEndDateRequest {
 }
 interface PostponeEndDateResponse {
 }
+interface OrderEndDatePostponed {
+    /** Order whose `endDate` was postponed. */
+    order?: Order;
+}
 interface CancelOrderRequest {
     /**
      * Order ID.
@@ -685,6 +912,15 @@ interface CancelOrderRequest {
 }
 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 {
     /**
      * Order ID.
@@ -694,6 +930,10 @@ interface MarkAsPaidRequest {
 }
 interface MarkAsPaidResponse {
 }
+interface OrderMarkedAsPaid {
+    /** Order that was marked as paid. */
+    order?: Order;
+}
 interface PauseOrderRequest {
     /**
      * Order ID.
@@ -703,6 +943,59 @@ interface PauseOrderRequest {
 }
 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.
@@ -712,6 +1005,99 @@ interface ResumeOrderRequest {
 }
 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.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
 interface MemberGetOrderRequest {
     /**
      * Order ID.
@@ -764,6 +1150,20 @@ interface MemberListOrdersResponse {
     /** 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.
@@ -814,6 +1214,55 @@ interface CreateOnlineOrderResponse {
     /** Created online order. */
     order?: Order;
 }
+interface CouponsError {
+    /** Coupon code. */
+    couponCode?: string;
+    /** Plan ID. */
+    planId?: string;
+}
+interface CreateGuestOnlineOrderRequest {
+    /**
+     * 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;
+    /** 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;
+}
+interface Captcha {
+    /** Token from captcha */
+    token?: string;
+}
+interface Guest {
+    /**
+     * Email for checkout
+     * @format EMAIL
+     */
+    email?: string;
+}
+interface CreateGuestOnlineOrderResponse {
+    /** Order. */
+    order?: Order;
+}
 interface CreateOfflineOrderRequest {
     /**
      * ID of the plan being ordered, from the Plans API.
@@ -853,6 +1302,22 @@ interface CreateOfflineOrderResponse {
     /** Order. */
     order?: Order;
 }
+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.
@@ -878,6 +1343,39 @@ interface GetOnlineOrderPreviewResponse {
     /** 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.
@@ -937,6 +1435,352 @@ interface GetPricePreviewResponse {
     /** 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;
+}
+/** @docsIgnore */
+type CreateOnlineOrderApplicationErrors = {
+    code?: 'MEMBER_REQUIRED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'archived_plan';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'member_not_found';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'purchases_limit_reached';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'buyer_can_not_pick_future_start_date';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'invalid_start_date';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'accept_payment_feature_missing';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'meta_site_id_missing';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ERROR_COUPON_IS_DISABLED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_USAGE_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_HAS_EXPIRED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_DOES_NOT_EXIST';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_INVALID_SUBTOTAL';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'undefined_not_allowed';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_STATE';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CreateOnlineOrderValidationErrors = {
+    ruleName?: 'UNKNOWN_ORDER_METHOD';
+} | {
+    ruleName?: 'RECURRING_POS_UNSUPPORTED';
+} | {
+    ruleName?: 'invalid_sort_field';
+};
+/** @docsIgnore */
+type CreateOfflineOrderApplicationErrors = {
+    code?: 'PRICING_PLANS_NOT_INSTALLED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'meta_site_id_missing';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ERROR_COUPON_IS_DISABLED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_USAGE_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_HAS_EXPIRED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_DOES_NOT_EXIST';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_INVALID_SUBTOTAL';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'undefined_not_allowed';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_STATE';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CreateOfflineOrderValidationErrors = {
+    ruleName?: 'MEMBER_DOESNT_EXIST';
+} | {
+    ruleName?: 'invalid_sort_field';
+};
+/** @docsIgnore */
+type GetOnlineOrderPreviewApplicationErrors = {
+    code?: 'PRICING_PLANS_NOT_INSTALLED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ERROR_COUPON_IS_DISABLED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_USAGE_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_HAS_EXPIRED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_DOES_NOT_EXIST';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_INVALID_SUBTOTAL';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'undefined_not_allowed';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_STATE';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetOnlineOrderPreviewValidationErrors = {
+    ruleName?: 'invalid_sort_field';
+};
+/** @docsIgnore */
+type GetOfflineOrderPreviewApplicationErrors = {
+    code?: 'PRICING_PLANS_NOT_INSTALLED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ERROR_COUPON_IS_DISABLED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_USAGE_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_HAS_EXPIRED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_DOES_NOT_EXIST';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_INVALID_SUBTOTAL';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'undefined_not_allowed';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_STATE';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetOfflineOrderPreviewValidationErrors = {
+    ruleName?: 'invalid_sort_field';
+};
+/** @docsIgnore */
+type GetPricePreviewApplicationErrors = {
+    code?: 'ERROR_COUPON_IS_DISABLED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_USAGE_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_HAS_EXPIRED';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_DOES_NOT_EXIST';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'ERROR_INVALID_SUBTOTAL';
+    description?: string;
+    data?: CouponsError;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'MISSING_BUSINESS_ADDRESS_STATE';
+    description?: string;
+    data?: Record<string, any>;
+};
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -980,4 +1824,4 @@ declare function getOnlineOrderPreview(): __PublicMethodMetaInfo<'POST', {}, Get
 declare function getOfflineOrderPreview(): __PublicMethodMetaInfo<'POST', {}, GetOfflineOrderPreviewRequest$1, GetOfflineOrderPreviewRequest, GetOfflineOrderPreviewResponse$1, GetOfflineOrderPreviewResponse>;
 declare function getPricePreview(): __PublicMethodMetaInfo<'POST', {}, GetPricePreviewRequest$1, GetPricePreviewRequest, GetPricePreviewResponse$1, GetPricePreviewResponse>;
 
-export { type __PublicMethodMetaInfo, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };
+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 };