@wix/pricing-plans 1.0.30 → 1.0.32

package/build/es/src/pricing-plans-v2-order.universal.d.ts

@@ -167,6 +167,11 @@ export interface Order {
      * @readonly
      */
     _updatedDate?: Date;
+    /**
+     * Information about the form submitted during the plan's checkout.
+     * @readonly
+     */
+    formData?: FormData;
 }
 export interface Buyer {
     /**
@@ -491,13 +496,18 @@ export interface OrderCycle {
     endedDate?: Date;
 }
 export interface FormData {
-    /** Reference to the form which was used to gather additional data in checkout. */
+    /**
+     * ID of a plan's checkout form.
+     *
+     * Learn more about [forms](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction).
+     */
     formId?: string | null;
-    /** Reference to the submission of the form. */
+    /** ID of a submission to the plan's checkout form. Every time a visitor completes the checkout process for a plan, a new submission is created. */
     submissionId?: string | null;
     /**
-     * Data submitted to the form at checkout.
-     * This field is only returned when `FieldSet.FULL` is specified when fetching the data
+     * Data submitted to the plan's checkout form.
+     *
+     * This field is returned when a method's `fieldset` is set to `FULL`.
      * @readonly
      */
     submissionData?: Record<string, any>;
@@ -1169,6 +1179,574 @@ export interface BulkResumeOrderResponse {
     results?: BulkOrderResult[];
     bulkActionMetadata?: BulkActionMetadata;
 }
+export interface MemberGetOrderResponseNonNullableFields {
+    order?: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    };
+}
+export interface MemberListOrdersResponseNonNullableFields {
+    orders: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    }[];
+}
+export interface CreateOfflineOrderResponseNonNullableFields {
+    order?: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    };
+}
+export interface GetOfflineOrderPreviewResponseNonNullableFields {
+    order?: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    };
+    purchaseLimitExceeded: boolean;
+}
+export interface GetPricePreviewResponseNonNullableFields {
+    price?: {
+        subscription?: {
+            cycleDuration?: {
+                unit: PeriodUnit;
+            };
+        };
+        singlePaymentForDuration?: {
+            unit: PeriodUnit;
+        };
+        subtotal: string;
+        discount: string;
+        tax?: {
+            name: string;
+            includedInPrice: boolean;
+            rate: string;
+            amount: string;
+        };
+        total: string;
+        planPrice: string;
+        currency: string;
+        coupon?: {
+            code: string;
+            amount: string;
+            _id: string;
+        };
+    };
+    prices: {
+        duration?: {
+            cycleFrom: number;
+        };
+        price?: {
+            subtotal: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            currency: string;
+            proration: string;
+        };
+    }[];
+}
+export interface GetOrderResponseNonNullableFields {
+    order?: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    };
+}
+export interface ListOrdersResponseNonNullableFields {
+    orders: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    }[];
+}
 /**
  * Gets an order by ID for the currently logged-in member.
  *
@@ -1180,7 +1758,7 @@ export interface BulkResumeOrderResponse {
  * @applicableIdentity MEMBER
  * @returns Requested order.
  */
-export declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<Order>;
+export declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<Order & NonNullable<MemberGetOrderResponseNonNullableFields>['order']>;
 export interface MemberGetOrderOptions {
     fieldSet?: Set;
 }
@@ -1192,7 +1770,7 @@ export interface MemberGetOrderOptions {
  * @param options - Filtering, sorting, and pagination options.
  * @applicableIdentity MEMBER
  */
-export declare function memberListOrders(options?: MemberListOrdersOptions): Promise<MemberListOrdersResponse>;
+export declare function memberListOrders(options?: MemberListOrdersOptions): Promise<MemberListOrdersResponse & MemberListOrdersResponseNonNullableFields>;
 export interface MemberListOrdersOptions {
     /** Filter by plan IDs. */
     planIds?: string[];
@@ -1296,7 +1874,6 @@ export declare function requestCancellation(_id: string, effectiveAt: Cancellati
  * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
  * - The order's last payment status is set to `"NOT_APPLICABLE"`.
  * @public
- * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
  * @param options - Options for creating an offline order.
@@ -1305,7 +1882,7 @@ export declare function requestCancellation(_id: string, effectiveAt: Cancellati
  * @applicableIdentity APP
  * @returns Fulfilled - The order of the plan.
  */
-export declare function createOfflineOrder(planId: string, options: CreateOfflineOrderOptions): Promise<CreateOfflineOrderResponse>;
+export declare function createOfflineOrder(planId: string, options?: CreateOfflineOrderOptions): Promise<CreateOfflineOrderResponse & CreateOfflineOrderResponseNonNullableFields>;
 export interface CreateOfflineOrderOptions {
     /**
      * ID of the member ordering the plan.
@@ -1341,7 +1918,6 @@ export interface CreateOfflineOrderOptions {
  *
  * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](#getpricepreview) function.
  * @public
- * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
  * @param options - Options for previewing the offline order.
@@ -1350,7 +1926,7 @@ export interface CreateOfflineOrderOptions {
  * @applicableIdentity APP
  * @returns Fulfilled - A preview of the order.
  */
-export declare function getOfflineOrderPreview(planId: string, options: GetOfflineOrderPreviewOptions): Promise<GetOfflineOrderPreviewResponse>;
+export declare function getOfflineOrderPreview(planId: string, options?: GetOfflineOrderPreviewOptions): Promise<GetOfflineOrderPreviewResponse & GetOfflineOrderPreviewResponseNonNullableFields>;
 export interface GetOfflineOrderPreviewOptions {
     /**
      * Member ID for the buyer who might order the plan offline.
@@ -1385,7 +1961,7 @@ export interface GetOfflineOrderPreviewOptions {
  * @applicableIdentity VISITOR
  * @returns Fulfilled - A preview of the pricing for the order.
  */
-export declare function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise<GetPricePreviewResponse>;
+export declare function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise<GetPricePreviewResponse & GetPricePreviewResponseNonNullableFields>;
 export interface GetPricePreviewOptions {
     /** Coupon code to apply.  */
     couponCode?: string | null;
@@ -1402,7 +1978,7 @@ export interface GetPricePreviewOptions {
  * @permissionScope SCOPE.PRICING-PLANS.READ-ORDERS
  * @applicableIdentity APP
  */
-export declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<GetOrderResponse>;
+export declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<GetOrderResponse & GetOrderResponseNonNullableFields>;
 export interface ManagementGetOrderOptions {
     fieldSet?: Set;
 }
@@ -1418,7 +1994,7 @@ export interface ManagementGetOrderOptions {
  * @permissionScope SCOPE.PRICING-PLANS.READ-ORDERS
  * @applicableIdentity APP
  */
-export declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<ListOrdersResponse>;
+export declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<ListOrdersResponse & ListOrdersResponseNonNullableFields>;
 export interface ManagementListOrdersOptions {
     /** Filter by specific member IDs of buyers who ordered a pricing plan. */
     buyerIds?: string[];

package/build/es/src/pricing-plans-v2-order.universal.js

@@ -379,7 +379,6 @@ export function requestCancellation(_id, effectiveAt) {
  * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
  * - The order's last payment status is set to `"NOT_APPLICABLE"`.
  * @public
- * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
  * @param options - Options for creating an offline order.
@@ -450,7 +449,6 @@ export function createOfflineOrder(planId, options) {
  *
  * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](#getpricepreview) function.
  * @public
- * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
  * @param options - Options for previewing the offline order.