@wix/auto_sdk_ecom_orders 1.0.301 → 1.0.302

package/build/es/meta.d.mts

@@ -1,4 +1,4 @@
-import { dX as ImportOrderRequest$1, I as ImportOrderResponse$1, dY as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, dZ as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, e1 as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, e5 as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, e6 as RecordManuallyCollectedPaymentRequest$1, e9 as RecordManuallyCollectedPaymentResponse$1, ea as MarkOrderAsPaidRequest$1, eb as MarkOrderAsPaidResponse$1, ec as BulkMarkOrdersAsPaidRequest$1, ed as BulkMarkOrdersAsPaidResponse$1, ei as GetRefundabilityStatusRequest$1, ej as GetRefundabilityStatusResponse$1, em as CreatePaymentGatewayOrderRequest$1, eo as CreatePaymentGatewayOrderResponse$1, ep as ChargeMembershipsRequest$1, es as ChargeMembershipsResponse$1, et as TriggerRefundRequest$1, eD as TriggerRefundResponse$1, fc as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fd as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gx as GetOrderRequest$1, gy as GetOrderResponse$1, gK as SearchOrdersRequest$1, l as SearchOrdersResponse$1, gO as CreateOrderRequest$1, gS as CreateOrderResponse$1, gT as UpdateOrderRequest$1, gU as UpdateOrderResponse$1, gV as BulkUpdateOrdersRequest$1, q as BulkUpdateOrdersResponse$1, ho as UpdateOrderLineItemRequest$1, hp as UpdateOrderLineItemResponse$1, hQ as AddActivityRequest$1, hT as AddActivityResponse$1, hU as AddActivitiesRequest$1, r as AddActivitiesResponse$1, hV as UpdateActivityRequest$1, hW as UpdateActivityResponse$1, hX as DeleteActivityRequest$1, hY as DeleteActivityResponse$1, i2 as CancelOrderRequest$1, t as CancelOrderResponse$1, i3 as UpdateOrderStatusRequest$1, i4 as UpdateOrderStatusResponse$1, iu as AggregateOrdersRequest$1, iv as AggregateOrdersResponse$1, iz as BulkUpdateOrderTagsRequest$1, w as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-DjY_97wS.mjs';
+import { dX as ImportOrderRequest$1, I as ImportOrderResponse$1, dY as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, dZ as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, e1 as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, e5 as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, e6 as RecordManuallyCollectedPaymentRequest$1, e9 as RecordManuallyCollectedPaymentResponse$1, ea as MarkOrderAsPaidRequest$1, eb as MarkOrderAsPaidResponse$1, ec as BulkMarkOrdersAsPaidRequest$1, ed as BulkMarkOrdersAsPaidResponse$1, ei as GetRefundabilityStatusRequest$1, ej as GetRefundabilityStatusResponse$1, em as CreatePaymentGatewayOrderRequest$1, eo as CreatePaymentGatewayOrderResponse$1, ep as ChargeMembershipsRequest$1, es as ChargeMembershipsResponse$1, et as TriggerRefundRequest$1, eD as TriggerRefundResponse$1, fc as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fd as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gx as GetOrderRequest$1, gy as GetOrderResponse$1, gK as SearchOrdersRequest$1, l as SearchOrdersResponse$1, gO as CreateOrderRequest$1, gS as CreateOrderResponse$1, gT as UpdateOrderRequest$1, gU as UpdateOrderResponse$1, gV as BulkUpdateOrdersRequest$1, q as BulkUpdateOrdersResponse$1, ho as UpdateOrderLineItemRequest$1, hp as UpdateOrderLineItemResponse$1, hQ as AddActivityRequest$1, hT as AddActivityResponse$1, hU as AddActivitiesRequest$1, r as AddActivitiesResponse$1, hV as UpdateActivityRequest$1, hW as UpdateActivityResponse$1, hX as DeleteActivityRequest$1, hY as DeleteActivityResponse$1, i2 as CancelOrderRequest$1, t as CancelOrderResponse$1, i3 as UpdateOrderStatusRequest$1, i4 as UpdateOrderStatusResponse$1, iu as AggregateOrdersRequest$1, iv as AggregateOrdersResponse$1, iz as BulkUpdateOrderTagsRequest$1, w as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-DXaSk34p.mjs';
 import '@wix/sdk-types';
 
 /**
@@ -155,7 +155,7 @@ interface Order {
     /**
      * Custom field data for the order object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
@@ -174,7 +174,7 @@ interface Order {
     /**
      * Order tags.
      *
-     * [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
+     * [Tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
      */
     tags?: Tags;
     /**
@@ -247,7 +247,7 @@ interface OrderLineItem {
     itemType?: ItemType;
     /**
      * Fulfiller ID. Field is empty when the line item is self-fulfilled.
-     * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
+     * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-fulfillments/list-fulfillments-for-single-order).
      * @format GUID
      */
     fulfillerId?: string | null;
@@ -344,7 +344,7 @@ interface OrderLineItem {
     /**
      * Custom extended fields for the line item object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
@@ -1165,7 +1165,8 @@ declare enum FulfillmentStatus {
     NOT_FULFILLED = "NOT_FULFILLED",
     /**
      * All of the order items are fulfilled or the order was manually marked as fulfilled.
-     * Orders without shipping info are fulfilled automatically.
+     * Paid orders without shipping info are fulfilled automatically.
+     * Manually marking an order as fulfilled doesn't create a [fulfillment](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-fulfillments/introduction). Instead, an `ORDER_FULFILLED` activity is added to the order's `activities`.
      */
     FULFILLED = "FULFILLED",
     /** Some, but not all, of the order items are fulfilled. */
@@ -2464,9 +2465,9 @@ declare enum ActivityType {
     ORDER_PLACED = "ORDER_PLACED",
     /** Order payment was completed and confirmed. */
     ORDER_PAID = "ORDER_PAID",
-    /** Order items were marked as fulfilled (shipped or ready for pickup). */
+    /** Order was manually marked as fulfilled, for example, in the site dashboard. The activity's `createdDate` is the date and time the order was marked as fulfilled. */
     ORDER_FULFILLED = "ORDER_FULFILLED",
-    /** Order fulfillment status was changed to not fulfilled. */
+    /** Order was manually marked as not fulfilled, for example, in the site dashboard. */
     ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
     /** Order was canceled by merchant or customer. */
     ORDER_CANCELED = "ORDER_CANCELED",
@@ -2592,9 +2593,9 @@ declare enum OrderActivityTypeEnumActivityType {
     ORDER_PLACED = "ORDER_PLACED",
     /** Order payment was completed and confirmed. */
     ORDER_PAID = "ORDER_PAID",
-    /** Order items were marked as fulfilled (shipped or ready for pickup). */
+    /** Order was manually marked as fulfilled, for example, in the site dashboard. The activity's `createdDate` is the date and time the order was marked as fulfilled. */
     ORDER_FULFILLED = "ORDER_FULFILLED",
-    /** Order fulfillment status was changed to not fulfilled. */
+    /** Order was manually marked as not fulfilled, for example, in the site dashboard. */
     ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
     /** Order was canceled by merchant or customer. */
     ORDER_CANCELED = "ORDER_CANCELED",
@@ -3435,15 +3436,27 @@ interface PaymentStatusUpdated {
     /** The previous status (before the update) */
     previousPaymentStatus?: PaymentStatusEnumPaymentStatusWithLiterals;
 }
-/** Triggered when the fulfillment status of an order is updated */
+/**
+ * Triggered when an order's fulfillment status changes.
+ *
+ * The status changes when the order is manually marked as fulfilled or not fulfilled, when its fulfillments are created, updated, or deleted, or when an edit to the order changes the status. It isn't triggered when the status changes because of a payment, an approval, a rejection, or a cancellation, for example, when an order without shipping info is paid.
+ */
 interface FulfillmentStatusUpdated {
-    /** The order that was updated */
+    /** Updated order. */
     order?: Order;
-    /** The previous status (before the update) */
+    /** Order's fulfillment status before the change. */
     previousFulfillmentStatus?: FulfillmentStatusWithLiterals;
-    /** the new status (after the update) */
+    /** Order's fulfillment status after the change. */
     newFulfillmentStatus?: FulfillmentStatusWithLiterals;
-    /** the action that caused this update */
+    /**
+     * What changed the fulfillment status.
+     *
+     * Supported values:
+     * + `"markAsFulfilled"`: The order was manually marked as fulfilled, for example, in the site dashboard.
+     * + `"markAsUnfulfilled"`: The order was manually marked as not fulfilled.
+     * + `"fulfillmentsUpdated"`: A fulfillment was created, updated, or deleted.
+     * + `"orderUpdated"`: The order was edited and the change affected the status.
+     */
     action?: string;
 }
 interface OrderCanceledEventOrderCanceled {
@@ -6210,19 +6223,19 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
-     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
      */
     cursorPaging?: CursorPaging;
     /**
      * Filter object.
      *
-     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     * Learn more about [filtering](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
      */
     filter?: Record<string, any> | null;
     /**
      * List of sort objects.
      *
-     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#sorting).
      * @maxSize 4
      */
     sort?: Sorting[];
@@ -6232,7 +6245,7 @@ interface CursorSearchPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
-     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
      */
     cursorPaging?: CursorPaging;
 }