@wix/auto_sdk_ecom_order-fulfillments 1.0.0 → 1.0.2

package/build/cjs/src/ecom-v1-fulfillments-order-fulfillments.types.d.ts

@@ -1,5 +1,9 @@
 export interface OrderWithFulfillments {
-    /** Order ID. */
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     orderId?: string;
     /** Fulfillments associated with the order. */
     fulfillments?: Fulfillment[];
@@ -12,6 +16,7 @@ export interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
     customInfo?: CustomFulfillmentInfo;
     /**
      * Fulfillment ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -20,10 +25,13 @@ export interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
      * @readonly
      */
     createdDate?: Date | null;
-    /** Line items being fulfilled. */
+    /**
+     * Line items being fulfilled.
+     * @maxSize 300
+     */
     lineItems?: FulfillmentLineItem[];
     /**
-     * Fulfillment status.
+     * *Optional.** Fulfillment status.
      *
      * Supported values:
      * + `"Pending"`
@@ -31,6 +39,8 @@ export interface Fulfillment extends FulfillmentFulfillmentInfoOneOf {
      * + `"Ready"`
      * + `"In_Delivery"`
      * + `"Fulfilled"`
+     * @minLength 1
+     * @maxLength 100
      */
     status?: string | null;
     /** Fulfillment handling complete. */
@@ -44,7 +54,10 @@ export interface FulfillmentFulfillmentInfoOneOf {
     customInfo?: CustomFulfillmentInfo;
 }
 export interface FulfillmentLineItem {
-    /** Line item ID (mirrors the ID of the order line item). */
+    /**
+     * Line item ID (mirrors the ID of the order line item).
+     * @format GUID
+     */
     id?: string;
     /**
      * Line item quantity.
@@ -53,11 +66,17 @@ export interface FulfillmentLineItem {
      *
      * Min: `1`
      * Max: `100000`
+     * @min 1
+     * @max 100000
      */
     quantity?: number | null;
 }
 export interface FulfillmentTrackingInfo {
-    /** Shipping/delivery tracking number. */
+    /**
+     * Shipping/delivery tracking number.
+     * @minLength 1
+     * @maxLength 100
+     */
     trackingNumber?: string | null;
     /**
      * Shipping provider. Using one of the following shipping providers will allow for auto-filling the tracking link:
@@ -66,19 +85,35 @@ export interface FulfillmentTrackingInfo {
      * * `'usps'`
      * * `'dhl'`
      * * `'canadaPost'`
+     * @minLength 1
+     * @maxLength 100
      */
     shippingProvider?: string | null;
-    /** Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation. */
+    /**
+     * Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation.
+     * @minLength 1
+     * @maxLength 2048
+     * @format WEB_URL
+     */
     trackingLink?: string | null;
 }
 export interface CustomFulfillmentInfo {
-    /** Custom fulfillment info in key:value form. */
+    /**
+     * Custom fulfillment info in key:value form.
+     * @maxSize 100
+     */
     fieldsData?: Record<string, string>;
 }
 export interface FulfillmentCreated {
-    /** Order ID (auto generated upon order creation). */
+    /**
+     * Order ID (auto generated upon order creation).
+     * @format GUID
+     */
     orderId?: string;
-    /** ID of the newly created fulfillment. */
+    /**
+     * ID of the newly created fulfillment.
+     * @format GUID
+     */
     fulfillmentId?: string;
     /** Fulfillment creation date and time. */
     dateCreated?: Date | null;
@@ -91,7 +126,10 @@ export interface FulfillmentCreated {
 }
 /** Buyer Info */
 export interface BuyerInfo {
-    /** Wix customer ID */
+    /**
+     * Wix customer ID
+     * @format GUID
+     */
     id?: string | null;
     /**
      * Deprecated (use identityType instead)
@@ -143,7 +181,11 @@ export declare enum FulfillmentStatus {
     PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
 }
 export interface V2FulfillmentTrackingInfo {
-    /** Tracking number. */
+    /**
+     * Tracking number.
+     * @minLength 1
+     * @maxLength 100
+     */
     trackingNumber?: string;
     /**
      * Shipping provider. Using the following shipping providers will allow for autofilling the tracking link:
@@ -152,29 +194,52 @@ export interface V2FulfillmentTrackingInfo {
      * * `usps`
      * * `dhl`
      * * `canadaPost`
+     * @minLength 1
+     * @maxLength 100
      */
     shippingProvider?: string;
-    /** Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation. */
+    /**
+     * Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation.
+     * @minLength 1
+     * @maxLength 2048
+     * @format WEB_URL
+     */
     trackingLink?: string | null;
 }
 export interface FulfillmentUpdated {
-    /** Order ID (auto generated upon order creation). */
+    /**
+     * Order ID (auto generated upon order creation).
+     * @format GUID
+     */
     orderId?: string;
-    /** ID of the updated fulfillment. */
+    /**
+     * ID of the updated fulfillment.
+     * @format GUID
+     */
     fulfillmentId?: string;
     /** Fulfillment tracking information. */
     trackingInfo?: V2FulfillmentTrackingInfo;
 }
 export interface FulfillmentDeleted {
-    /** Order ID (auto generated upon order creation). */
+    /**
+     * Order ID (auto generated upon order creation).
+     * @format GUID
+     */
     orderId?: string;
-    /** ID of the deleted fulfillment. */
+    /**
+     * ID of the deleted fulfillment.
+     * @format GUID
+     */
     fulfillmentId?: string;
     /** Order fulfillment status. */
     fulfillmentStatus?: FulfillmentStatus;
 }
 export interface ListFulfillmentsForSingleOrderRequest {
-    /** Order ID for which to retrieve fulfillments. */
+    /**
+     * Order ID for which to retrieve fulfillments.
+     * @minLength 1
+     * @maxLength 100
+     */
     orderId: string;
 }
 export interface ListFulfillmentsForSingleOrderResponse {
@@ -182,7 +247,11 @@ export interface ListFulfillmentsForSingleOrderResponse {
     orderWithFulfillments?: OrderWithFulfillments;
 }
 export interface ListFulfillmentsForMultipleOrdersRequest {
-    /** List of order IDs for which to retrieve fulfillments. */
+    /**
+     * List of order IDs for which to retrieve fulfillments.
+     * @minSize 1
+     * @maxSize 100
+     */
     orderIds: string[];
 }
 export interface ListFulfillmentsForMultipleOrdersResponse {
@@ -212,9 +281,16 @@ export interface UpdateFulfillmentResponse {
     orderWithFulfillments?: OrderWithFulfillments;
 }
 export interface DeleteFulfillmentRequest {
-    /** Order ID. */
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     orderId: string;
-    /** ID of the fulfillment to delete. */
+    /**
+     * ID of the fulfillment to delete.
+     * @format GUID
+     */
     fulfillmentId: string;
 }
 export interface DeleteFulfillmentResponse {
@@ -222,13 +298,24 @@ export interface DeleteFulfillmentResponse {
     orderWithFulfillments?: OrderWithFulfillments;
 }
 export interface BulkCreateFulfillmentRequest {
-    /** List of order IDs and their associated fulfillments. */
+    /**
+     * List of order IDs and their associated fulfillments.
+     * @minSize 1
+     * @maxSize 100
+     */
     ordersWithFulfillments: BulkCreateOrderWithFulfillments[];
 }
 export interface BulkCreateOrderWithFulfillments {
-    /** Order ID. */
+    /**
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     orderId?: string;
-    /** Fulfillments associated with the order. */
+    /**
+     * Fulfillments associated with the order.
+     * @minSize 1
+     */
     fulfillments?: Fulfillment[];
 }
 export interface BulkCreateFulfillmentResponse {
@@ -341,9 +428,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -351,26 +444,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

package/build/cjs/src/ecom-v1-fulfillments-order-fulfillments.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecom-v1-fulfillments-order-fulfillments.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-fulfillments-order-fulfillments.types.ts"],"names":[],"mappings":";;;AAoIA,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,kBAAkB;IAClB,iCAAiB,CAAA;IACjB,cAAc;IACd,mCAAmB,CAAA;AACrB,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,oDAA+B,CAAA;IAC/B;;;OAGG;IACH,4CAAuB,CAAA;IACvB,wBAAwB;IACxB,0CAAqB,CAAA;IACrB,yDAAyD;IACzD,gEAA2C,CAAA;AAC7C,CAAC,EAZW,iBAAiB,iCAAjB,iBAAiB,QAY5B;AAuQD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"ecom-v1-fulfillments-order-fulfillments.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-fulfillments-order-fulfillments.types.ts"],"names":[],"mappings":";;;AA0KA,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uEAAuD,CAAA;IACvD,kBAAkB;IAClB,iCAAiB,CAAA;IACjB,cAAc;IACd,mCAAmB,CAAA;AACrB,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,oDAA+B,CAAA;IAC/B;;;OAGG;IACH,4CAAuB,CAAA;IACvB,wBAAwB;IACxB,0CAAqB,CAAA;IACrB,yDAAyD;IACzD,gEAA2C,CAAA;AAC7C,CAAC,EAZW,iBAAiB,iCAAjB,iBAAiB,QAY5B;AAsVD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}