@wix/auto_sdk_pricing-plans_orders 1.0.106 → 1.0.107

package/build/cjs/index.typings.d.ts

@@ -1106,83 +1106,6 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
-interface MemberGetOrderRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    _id: string;
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    fieldSet?: SetWithLiterals;
-}
-interface MemberGetOrderResponse {
-    /** Requested order. */
-    order?: Order;
-}
-interface MemberListOrdersRequest {
-    /**
-     * Filter by plan IDs.
-     * @format GUID
-     */
-    planIds?: string[];
-    /** Filter for orders where auto renewal was canceled. */
-    autoRenewCanceled?: boolean | null;
-    /** Filter by order status. */
-    orderStatuses?: OrderStatusWithLiterals[];
-    /** Filter by payment status. */
-    paymentStatuses?: PaymentStatusWithLiterals[];
-    /**
-     * Limit the number of pricing plans returned. Default limit is 50.
-     * @min 1
-     * @max 50
-     */
-    limit?: number | null;
-    /** Number of entries to offset. */
-    offset?: number | null;
-    /** Sorting direction (defaults to ASC) and field to sort by. */
-    sorting?: Sorting;
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    fieldSet?: SetWithLiterals;
-}
-interface MemberListOrdersResponse {
-    /** Requested orders. */
-    orders?: Order[];
-    /** Object containing paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-/**
- * TODO: Write orders filter and sort docs page
- * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
- */
-interface QueryOrdersRequest {
-    /** Query filter. */
-    query?: QueryV2;
-}
-interface QueryOrdersResponse {
-    /** Order data. */
-    plans?: Order[];
-    /** Paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-interface RequestCancellationRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    _id: string;
-    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
-    effectiveAt: CancellationEffectiveAtWithLiterals;
-}
-interface RequestCancellationResponse {
-}
 interface CreateOnlineOrderRequest {
     /**
      * Plan ID.
@@ -1486,6 +1409,83 @@ interface SetSubmissionResponse {
     /** Order with submission id */
     order?: Order;
 }
+interface MemberGetOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    _id: string;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+interface MemberGetOrderResponse {
+    /** Requested order. */
+    order?: Order;
+}
+interface MemberListOrdersRequest {
+    /**
+     * Filter by plan IDs.
+     * @format GUID
+     */
+    planIds?: string[];
+    /** Filter for orders where auto renewal was canceled. */
+    autoRenewCanceled?: boolean | null;
+    /** Filter by order status. */
+    orderStatuses?: OrderStatusWithLiterals[];
+    /** Filter by payment status. */
+    paymentStatuses?: PaymentStatusWithLiterals[];
+    /**
+     * Limit the number of pricing plans returned. Default limit is 50.
+     * @min 1
+     * @max 50
+     */
+    limit?: number | null;
+    /** Number of entries to offset. */
+    offset?: number | null;
+    /** Sorting direction (defaults to ASC) and field to sort by. */
+    sorting?: Sorting;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+interface MemberListOrdersResponse {
+    /** Requested orders. */
+    orders?: Order[];
+    /** Object containing paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+/**
+ * TODO: Write orders filter and sort docs page
+ * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
+ */
+interface QueryOrdersRequest {
+    /** Query filter. */
+    query?: QueryV2;
+}
+interface QueryOrdersResponse {
+    /** Order data. */
+    plans?: Order[];
+    /** Paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface RequestCancellationRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    _id: string;
+    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
+    effectiveAt: CancellationEffectiveAtWithLiterals;
+}
+interface RequestCancellationResponse {
+}
 /** @docsIgnore */
 type CreateOnlineOrderApplicationErrors = {
     code?: 'MEMBER_REQUIRED';
@@ -2310,87 +2310,6 @@ declare function pauseOrder(_id: string): Promise<void>;
  * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
  */
 declare function resumeOrder(_id: string): Promise<void>;
-/**
- * Retrieves an order for the currently logged-in member by ID.
- * @param _id - Order ID.
- * @public
- * @requiredField _id
- * @param options - Options for getting a logged-in member's order.
- * @permissionId PRICING_PLANS.READ_OWN_ORDERS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @returns Requested order.
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
- */
-declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, `_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.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `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`, 6>>;
-interface MemberGetOrderOptions {
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    fieldSet?: SetWithLiterals;
-}
-/**
- * Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
- * @public
- * @param options - Filtering, sorting, and pagination options.
- * @permissionId PRICING_PLANS.READ_OWN_ORDERS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
- */
-declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
-interface MemberListOrdersOptions {
-    /**
-     * Filter by plan IDs.
-     * @format GUID
-     */
-    planIds?: string[];
-    /** Filter for orders where auto renewal was canceled. */
-    autoRenewCanceled?: boolean | null;
-    /** Filter by order status. */
-    orderStatuses?: OrderStatusWithLiterals[];
-    /** Filter by payment status. */
-    paymentStatuses?: PaymentStatusWithLiterals[];
-    /**
-     * Limit the number of pricing plans returned. Default limit is 50.
-     * @min 1
-     * @max 50
-     */
-    limit?: number | null;
-    /** Number of entries to offset. */
-    offset?: number | null;
-    /** Sorting direction (defaults to ASC) and field to sort by. */
-    sorting?: Sorting;
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    fieldSet?: SetWithLiterals;
-}
-/**
- * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
- *
- * There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
- *
- * Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
- *
- * >**Note:**
- * >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
- * @param _id - Order ID.
- * @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
- * @public
- * @requiredField _id
- * @requiredField effectiveAt
- * @param options - Options for requesting a cancellation.
- * @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
- */
-declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
 /**
  * Creates an online order for a site member.
  *
@@ -2585,5 +2504,86 @@ interface GetPricePreviewOptions {
      */
     couponCode?: string | null;
 }
+/**
+ * Retrieves an order for the currently logged-in member by ID.
+ * @param _id - Order ID.
+ * @public
+ * @requiredField _id
+ * @param options - Options for getting a logged-in member's order.
+ * @permissionId PRICING_PLANS.READ_OWN_ORDERS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns Requested order.
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
+ */
+declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, `_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.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `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`, 6>>;
+interface MemberGetOrderOptions {
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+/**
+ * Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
+ * @public
+ * @param options - Filtering, sorting, and pagination options.
+ * @permissionId PRICING_PLANS.READ_OWN_ORDERS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
+ */
+declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
+interface MemberListOrdersOptions {
+    /**
+     * Filter by plan IDs.
+     * @format GUID
+     */
+    planIds?: string[];
+    /** Filter for orders where auto renewal was canceled. */
+    autoRenewCanceled?: boolean | null;
+    /** Filter by order status. */
+    orderStatuses?: OrderStatusWithLiterals[];
+    /** Filter by payment status. */
+    paymentStatuses?: PaymentStatusWithLiterals[];
+    /**
+     * Limit the number of pricing plans returned. Default limit is 50.
+     * @min 1
+     * @max 50
+     */
+    limit?: number | null;
+    /** Number of entries to offset. */
+    offset?: number | null;
+    /** Sorting direction (defaults to ASC) and field to sort by. */
+    sorting?: Sorting;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+/**
+ * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
+ *
+ * There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
+ *
+ * Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
+ *
+ * >**Note:**
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @param _id - Order ID.
+ * @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
+ * @public
+ * @requiredField _id
+ * @requiredField effectiveAt
+ * @param options - Options for requesting a cancellation.
+ * @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
+ */
+declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
 
 export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type OrdersQueryOrdersRequest, type OrdersQueryOrdersResponse, type Paging, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, type QueryOrdersRequest, type QueryOrdersResponse, type QueryV2, type QueryV2PagingMethodOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };