@wix/auto_sdk_pricing-plans_orders 1.0.65 → 1.0.67

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { ManagementGetOrderOptions, GetOrderResponse, ManagementListOrdersOptions, ListOrdersResponse, CancellationEffectiveAtWithLiterals, MemberGetOrderOptions, Order, MemberListOrdersOptions, MemberListOrdersResponse, CreateOnlineOrderOptions, CreateOnlineOrderResponse, CreateOnlineOrderApplicationErrors, CreateOnlineOrderValidationErrors, CreateOfflineOrderOptions, CreateOfflineOrderResponse, CreateOfflineOrderApplicationErrors, CreateOfflineOrderValidationErrors, GetOnlineOrderPreviewOptions, GetOnlineOrderPreviewResponse, GetOnlineOrderPreviewApplicationErrors, GetOnlineOrderPreviewValidationErrors, GetOfflineOrderPreviewOptions, GetOfflineOrderPreviewResponse, GetOfflineOrderPreviewApplicationErrors, GetOfflineOrderPreviewValidationErrors, GetPricePreviewOptions, GetPricePreviewResponse, GetPricePreviewApplicationErrors, OrderAutoRenewCanceledEnvelope, OrderCanceledEnvelope, OrderCycleStartedEnvelope, OrderEndDatePostponedEnvelope, OrderEndedEnvelope, OrderMarkedAsPaidEnvelope, OrderPausedEnvelope, OrderPurchasedEnvelope, OrderResumedEnvelope, OrderStartedEnvelope, OrderUpdatedEnvelope, OrderCreatedEnvelope, OrderStartDateChangedEnvelope } from './index.typings.js';
 export { ActionEvent, ApplicationError, ApplyCouponRequest, ApplyCouponResponse, BaseEventMetadata, BulkActionMetadata, BulkOrderResult, BulkPauseOrderRequest, BulkPauseOrderResponse, BulkResumeOrderRequest, BulkResumeOrderResponse, Buyer, CancelOrderRequest, CancelOrderResponse, Cancellation, CancellationCause, CancellationEffectiveAt, Captcha, ChangeStartDateRequest, ChangeStartDateResponse, Coupon, CouponsError, CreateExternalOrderRequest, CreateExternalOrderResponse, CreateGuestOnlineOrderRequest, CreateGuestOnlineOrderResponse, CreateOfflineOrderRequest, CreateOnlineOrderRequest, CurrentCycle, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, Duration, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Fee, FormData, GetAvailableOrderActionsRequest, GetAvailableOrderActionsResponse, GetGuestOnlineOrderPreviewRequest, GetGuestOnlineOrderPreviewResponse, GetOfflineOrderPreviewRequest, GetOnlineOrderPreviewRequest, GetOrderRequest, GetOrdersStatsRequest, GetOrdersStatsResponse, GetPricePreviewRequest, Guest, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ListOrdersRequest, MarkAsPaidRequest, MarkAsPaidResponse, MemberGetOrderRequest, MemberGetOrderResponse, MemberListOrdersRequest, MessageEnvelope, OnBehalf, OrderAutoRenewCanceled, OrderCanceled, OrderCycle, OrderCycleStarted, OrderEndDatePostponed, OrderEnded, OrderMarkedAsPaid, OrderMethod, OrderPaused, OrderPurchased, OrderResumed, OrderStartDateChanged, OrderStarted, OrderStatus, OrderType, OrdersQueryOrdersRequest, OrdersQueryOrdersResponse, Paging, PagingMetadataV2, PauseOrderRequest, PauseOrderResponse, PausePeriod, PaymentStatus, PeriodUnit, PostponeEndDateRequest, PostponeEndDateResponse, Price, PriceDetails, PriceDetailsPricingModelOneOf, PriceDuration, PricingDetails, PricingDetailsPricingModelOneOf, QueryOrdersRequest, QueryOrdersResponse, QueryV2, QueryV2PagingMethodOneOf, ReasonNotSuspendable, Recurrence, RequestCancellationRequest, RequestCancellationResponse, RestoreInfo, ResumeOrderRequest, ResumeOrderResponse, Set, SetSubmissionRequest, SetSubmissionResponse, SortOrder, Sorting, SpannedPrice, Status, Tax, WebhookIdentityType } from './index.typings.js';
 
+type OrderNonNullablePaths = `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.subscription.cycleDuration.unit` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.coupon.code` | `pricing.prices.${number}.price.coupon.amount` | `pricing.prices.${number}.price.coupon._id` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.tax.name` | `pricing.prices.${number}.price.tax.includedInPrice` | `pricing.prices.${number}.price.tax.rate` | `pricing.prices.${number}.price.tax.amount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`;
 declare function managementGetOrder$1(httpClient: HttpClient): ManagementGetOrderSignature;
 interface ManagementGetOrderSignature {
     /**
@@ -9,7 +10,9 @@ interface ManagementGetOrderSignature {
      * @param - Order ID.
      * @param - Options to use when getting an order.
      */
-    (_id: string, options?: ManagementGetOrderOptions | undefined): Promise<GetOrderResponse>;
+    (_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[OrderNonNullablePaths]>>;
 }
 declare function managementListOrders$1(httpClient: HttpClient): ManagementListOrdersSignature;
 interface ManagementListOrdersSignature {
@@ -20,7 +23,9 @@ interface ManagementListOrdersSignature {
      * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
      * @param - Filtering, sorting, and pagination options.
      */
-    (options?: ManagementListOrdersOptions | undefined): Promise<ListOrdersResponse>;
+    (options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, {
+        [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
+    }[OrderNonNullablePaths]>>;
 }
 declare function postponeEndDate$1(httpClient: HttpClient): PostponeEndDateSignature;
 interface PostponeEndDateSignature {
@@ -119,7 +124,7 @@ interface MemberGetOrderSignature {
      * @param - Options for getting a logged-in member's order.
      * @returns Requested order.
      */
-    (_id: string, options?: MemberGetOrderOptions | undefined): Promise<Order>;
+    (_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
 }
 declare function memberListOrders$1(httpClient: HttpClient): MemberListOrdersSignature;
 interface MemberListOrdersSignature {
@@ -127,7 +132,9 @@ interface MemberListOrdersSignature {
      * Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
      * @param - Filtering, sorting, and pagination options.
      */
-    (options?: MemberListOrdersOptions | undefined): Promise<MemberListOrdersResponse>;
+    (options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, {
+        [P in OrderNonNullablePaths]: `orders.${number}.${P}`;
+    }[OrderNonNullablePaths]>>;
 }
 declare function requestCancellation$1(httpClient: HttpClient): RequestCancellationSignature;
 interface RequestCancellationSignature {
@@ -156,9 +163,11 @@ interface CreateOnlineOrderSignature {
      * When an online order is created, but payment hasn't been processed, its status is set to `DRAFT`. After the payment has been processed, if the start date is in the future the order's status is set to `PENDING`. Otherwise, it's set to `ACTIVE`.
      * @param - Plan ID.
      */
-    (planId: string, options?: CreateOnlineOrderOptions | undefined): Promise<CreateOnlineOrderResponse & {
-        __applicationErrorsType?: CreateOnlineOrderApplicationErrors | undefined;
-        __validationErrorsType?: CreateOnlineOrderValidationErrors | undefined;
+    (planId: string, options?: NonNullablePaths<CreateOnlineOrderOptions, `onBehalf.memberId`>): Promise<NonNullablePaths<CreateOnlineOrderResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[OrderNonNullablePaths]> & {
+        __applicationErrorsType?: CreateOnlineOrderApplicationErrors;
+        __validationErrorsType?: CreateOnlineOrderValidationErrors;
     }>;
 }
 declare function createOfflineOrder$1(httpClient: HttpClient): CreateOfflineOrderSignature;
@@ -185,9 +194,11 @@ interface CreateOfflineOrderSignature {
      * @param - ID of the member ordering the plan, from the Members API.
      * @param - Options for creating an offline order.
      */
-    (planId: string, memberId: string, options?: CreateOfflineOrderOptions | undefined): Promise<CreateOfflineOrderResponse & {
-        __applicationErrorsType?: CreateOfflineOrderApplicationErrors | undefined;
-        __validationErrorsType?: CreateOfflineOrderValidationErrors | undefined;
+    (planId: string, memberId: string, options?: CreateOfflineOrderOptions): Promise<NonNullablePaths<CreateOfflineOrderResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[OrderNonNullablePaths]> & {
+        __applicationErrorsType?: CreateOfflineOrderApplicationErrors;
+        __validationErrorsType?: CreateOfflineOrderValidationErrors;
     }>;
 }
 declare function getOnlineOrderPreview$1(httpClient: HttpClient): GetOnlineOrderPreviewSignature;
@@ -200,9 +211,11 @@ interface GetOnlineOrderPreviewSignature {
      * This method must be called using the site member identity ([SDK](https://dev.wix.com/docs/sdk/articles/get-started/about-identities#site-member) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#site-member)). Therefore, [Wix apps](https://dev.wix.com/docs/build-apps) can't currently call this method using REST.
      * @param - Plan ID.
      */
-    (planId: string, options?: GetOnlineOrderPreviewOptions | undefined): Promise<GetOnlineOrderPreviewResponse & {
-        __applicationErrorsType?: GetOnlineOrderPreviewApplicationErrors | undefined;
-        __validationErrorsType?: GetOnlineOrderPreviewValidationErrors | undefined;
+    (planId: string, options?: GetOnlineOrderPreviewOptions): Promise<NonNullablePaths<GetOnlineOrderPreviewResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[OrderNonNullablePaths] | `purchaseLimitExceeded`> & {
+        __applicationErrorsType?: GetOnlineOrderPreviewApplicationErrors;
+        __validationErrorsType?: GetOnlineOrderPreviewValidationErrors;
     }>;
 }
 declare function getOfflineOrderPreview$1(httpClient: HttpClient): GetOfflineOrderPreviewSignature;
@@ -223,9 +236,11 @@ interface GetOfflineOrderPreviewSignature {
      * @param - Options for previewing the offline order.
      * @param - ID of the plan of the previewed order.
      */
-    (planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions | undefined): Promise<GetOfflineOrderPreviewResponse & {
-        __applicationErrorsType?: GetOfflineOrderPreviewApplicationErrors | undefined;
-        __validationErrorsType?: GetOfflineOrderPreviewValidationErrors | undefined;
+    (planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions): Promise<NonNullablePaths<GetOfflineOrderPreviewResponse, {
+        [P in OrderNonNullablePaths]: `order.${P}`;
+    }[OrderNonNullablePaths] | `purchaseLimitExceeded`> & {
+        __applicationErrorsType?: GetOfflineOrderPreviewApplicationErrors;
+        __validationErrorsType?: GetOfflineOrderPreviewValidationErrors;
     }>;
 }
 declare function getPricePreview$1(httpClient: HttpClient): GetPricePreviewSignature;
@@ -242,8 +257,8 @@ interface GetPricePreviewSignature {
      * @param - ID of plan to preview.
      * @param - Options for getting a price preview.
      */
-    (planId: string, options?: GetPricePreviewOptions | undefined): Promise<GetPricePreviewResponse & {
-        __applicationErrorsType?: GetPricePreviewApplicationErrors | undefined;
+    (planId: string, options?: GetPricePreviewOptions): Promise<NonNullablePaths<GetPricePreviewResponse, `price.subscription.cycleDuration.unit` | `price.subtotal` | `price.discount` | `price.tax.name` | `price.tax.includedInPrice` | `price.tax.rate` | `price.tax.amount` | `price.total` | `price.planPrice` | `price.currency` | `price.coupon.code` | `price.coupon.amount` | `price.coupon._id` | `prices` | `prices.${number}.duration.cycleFrom` | `prices.${number}.price.subtotal` | `prices.${number}.price.coupon.code` | `prices.${number}.price.coupon.amount` | `prices.${number}.price.coupon._id` | `prices.${number}.price.discount` | `prices.${number}.price.tax.name` | `prices.${number}.price.tax.includedInPrice` | `prices.${number}.price.tax.rate` | `prices.${number}.price.tax.amount` | `prices.${number}.price.total` | `prices.${number}.price.currency` | `prices.${number}.price.proration`> & {
+        __applicationErrorsType?: GetPricePreviewApplicationErrors;
     }>;
 }
 declare const onOrderAutoRenewCanceled$1: EventDefinition<OrderAutoRenewCanceledEnvelope, "wix.pricing_plans.v2.order_auto_renew_canceled">;