@wix/auto_sdk_ecom_abandoned-checkouts 1.0.1 → 1.0.2

package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts

@@ -1,13 +1,22 @@
 export interface AbandonedCheckout {
-    /** Abandoned checkout ID. */
+    /**
+     * Abandoned checkout ID.
+     * @format GUID
+     */
     id?: string;
     /** Date and time the abandoned checkout was created. */
     createdDate?: Date | null;
     /** Date and time the abandoned checkout was updated. */
     updatedDate?: Date | null;
-    /** The associated checkout ID. */
+    /**
+     * The associated checkout ID.
+     * @format GUID
+     */
     checkoutId?: string | null;
-    /** The associated cart ID. */
+    /**
+     * The associated cart ID.
+     * @format GUID
+     */
     cartId?: string | null;
     /** Status of the abandoned checkout. */
     status?: Status;
@@ -20,22 +29,31 @@ export interface AbandonedCheckout {
     buyerInfo?: V1BuyerInfo;
     /** Contact details. */
     contactDetails?: FullAddressContactDetails;
-    /** The store's currency. */
+    /**
+     * The store's currency.
+     * @format CURRENCY
+     */
     currency?: string;
-    /** Currency the buyer used in checkout. */
+    /**
+     * Currency the buyer used in checkout.
+     * @format CURRENCY
+     */
     conversionCurrency?: string | null;
     /** Total price after discounts, gift cards, and tax. */
     totalPrice?: MultiCurrencyPrice;
     /**
      * List of all automation activities performed by [Wix Automations](https://dev.wix.com/docs/rest/business-management/automations/introduction) regarding the abandoned checkout.
-     * Wix Automations updates the `activities` field for each actvity in the automation flow. Only relevant if the site owner set up
+     * Wix Automations updates the `activities` field for each activity in the automation flow. Only relevant if the site owner set up
      * [automations in the Dashboard](https://support.wix.com/en/article/wix-automations-creating-an-automation-with-the-new-builder#step-1-create-a-new-automation). Read more about `activities` in
      * the [introduction](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/abandoned-checkout/introduction).
      */
     activities?: Activity[];
     /** Date and time the abandoned checkout was recovered. */
     checkoutRecoveredDate?: Date | null;
-    /** Checkout URL. */
+    /**
+     * Checkout URL.
+     * @format WEB_URL
+     */
     checkoutUrl?: string;
     /** Subtotal price of all line items, before discounts and before tax. */
     subtotalPrice?: MultiCurrencyPrice;
@@ -63,38 +81,73 @@ export declare enum Status {
 }
 /** Buyer information. */
 export interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
-    /** Visitor ID (if the site visitor is **not** a site member). */
+    /**
+     * Visitor ID (if the site visitor is **not** a site member).
+     * @format GUID
+     */
     visitorId?: string;
-    /** Member ID (if the site visitor is a site member). */
+    /**
+     * Member ID (if the site visitor is a site member).
+     * @format GUID
+     */
     memberId?: string;
-    /** User ID (if the site visitor is a site owner or collaborator). */
+    /**
+     * User ID (if the site visitor is a site owner or collaborator).
+     * @format GUID
+     */
     userId?: string;
     /**
      * Contact ID. For more information, see the [Contacts API](https://dev.wix.com/docs/rest/api-reference/contacts/introduction).
+     * @format GUID
      * @readonly
      */
     contactId?: string | null;
-    /** Buyer email address. */
+    /**
+     * Buyer email address.
+     * @maxLength 50
+     * @format EMAIL
+     */
     email?: string | null;
 }
 /** @oneof */
 export interface V1BuyerInfoIdOneOf {
-    /** Visitor ID (if the site visitor is **not** a site member). */
+    /**
+     * Visitor ID (if the site visitor is **not** a site member).
+     * @format GUID
+     */
     visitorId?: string;
-    /** Member ID (if the site visitor is a site member). */
+    /**
+     * Member ID (if the site visitor is a site member).
+     * @format GUID
+     */
     memberId?: string;
-    /** User ID (if the site visitor is a site owner or collaborator). */
+    /**
+     * User ID (if the site visitor is a site owner or collaborator).
+     * @format GUID
+     */
     userId?: string;
 }
 /** Full contact details for an address */
 export interface FullAddressContactDetails {
-    /** First name. */
+    /**
+     * First name.
+     * @maxLength 100
+     */
     firstName?: string | null;
-    /** Last name. */
+    /**
+     * Last name.
+     * @maxLength 100
+     */
     lastName?: string | null;
-    /** Phone number. */
+    /**
+     * Phone number.
+     * @format PHONE
+     */
     phone?: string | null;
-    /** Company name. */
+    /**
+     * Company name.
+     * @maxLength 1000
+     */
     company?: string | null;
     /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
     vatId?: VatId;
@@ -120,11 +173,15 @@ export declare enum VatType {
     CNPJ = "CNPJ"
 }
 export interface MultiCurrencyPrice {
-    /** Amount. */
+    /**
+     * Amount.
+     * @decimalValue options { gte:0, lte:1000000000000000 }
+     */
     amount?: string;
     /**
      * Converted amount.
      * @readonly
+     * @decimalValue options { gte:0, lte:1000000000000000 }
      */
     convertedAmount?: string;
     /**
@@ -145,6 +202,7 @@ export interface Activity {
     type?: ActivityType;
 }
 export interface CartAbandonedEvent {
+    /** @format GUID */
     cartId?: string;
     /**
      * Time the cart was created
@@ -164,17 +222,30 @@ export interface CartAbandonedEvent {
     couponId?: string;
     /** Subtotal of all line items in cart, not before shipping and taxes */
     totals?: Totals;
-    /** Checkout URL - checkout with the abandoned cart details */
+    /**
+     * Checkout URL - checkout with the abandoned cart details
+     * @format WEB_URL
+     */
     checkoutUrl?: string;
 }
 export interface BuyerInfo {
-    /** Wix customer ID */
+    /**
+     * Wix customer ID
+     * @format GUID
+     */
     id?: string;
     /** Customer information */
     identityType?: Identity;
-    /** Customer's email address */
+    /**
+     * Customer's email address
+     * @maxLength 50
+     * @format EMAIL
+     */
     email?: string | null;
-    /** Customer's phone number */
+    /**
+     * Customer's phone number
+     * @format PHONE
+     */
     phone?: string | null;
     /** Customer's first name */
     firstName?: string | null;
@@ -192,14 +263,21 @@ export declare enum Identity {
     CONTACT = "CONTACT"
 }
 export interface Totals {
-    /** Subtotal of all line items in cart, without shipping and taxes */
+    /**
+     * Subtotal of all line items in cart, without shipping and taxes
+     * @max 999999999.99
+     */
     subtotal?: number | null;
-    /** Total cart price */
+    /**
+     * Total cart price
+     * @max 999999999.99
+     */
     total?: number | null;
     /** Formatted total cart price includes currency symbol */
     formattedTotal?: string;
 }
 export interface CartRecoveredEvent {
+    /** @format GUID */
     cartId?: string;
     /**
      * Time the cart was recovered
@@ -217,8 +295,16 @@ export interface CartRecoveredEvent {
      */
     abandonedTime?: Date | null;
 }
+/** Triggered when an abandoned checkout is recovered (the customer completes the checkout). */
+export interface AbandonedCheckoutRecovered {
+    /** The abandoned checkout that was recovered. */
+    abandonedCheckout?: AbandonedCheckout;
+}
 export interface GetAbandonedCheckoutRequest {
-    /** Abandoned checkout ID. */
+    /**
+     * Abandoned checkout ID.
+     * @format GUID
+     */
     abandonedCheckoutId: string;
 }
 export interface GetAbandonedCheckoutResponse {
@@ -226,7 +312,10 @@ export interface GetAbandonedCheckoutResponse {
     abandonedCheckout?: AbandonedCheckout;
 }
 export interface DeleteAbandonedCheckoutRequest {
-    /** Id of the abandoned checkout to delete */
+    /**
+     * Id of the abandoned checkout to delete
+     * @format GUID
+     */
     abandonedCheckoutId: string;
 }
 export interface DeleteAbandonedCheckoutResponse {
@@ -265,7 +354,10 @@ export interface QueryV2PagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -281,13 +373,17 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -315,9 +411,15 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface SearchAbandonedCheckoutsRequest {
@@ -331,7 +433,10 @@ export interface Search extends SearchPagingMethodOneOf {
     cursorPaging?: CommonCursorPaging;
     /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
     filter?: Record<string, any> | null;
-    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    /**
+     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+     * @maxSize 4
+     */
     sort?: CommonSorting[];
     /** free text to match in searchable fields */
     search?: SearchDetails;
@@ -344,7 +449,10 @@ export interface SearchPagingMethodOneOf {
     cursorPaging?: CommonCursorPaging;
 }
 export interface CommonSorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 40
+     */
     fieldName?: string;
     /** Sort order. */
     order?: CommonSortOrder;
@@ -358,9 +466,16 @@ export declare enum CommonSortOrder {
 export interface SearchDetails {
     /** boolean search mode */
     mode?: Mode;
-    /** search term or expression */
+    /**
+     * search term or expression
+     * @maxLength 100
+     */
     expression?: string | null;
-    /** fields to search in. if empty - server will search in own default fields */
+    /**
+     * fields to search in. if empty - server will search in own default fields
+     * @maxLength 100
+     * @maxSize 20
+     */
     fields?: string[];
     /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
     fuzzy?: boolean;
@@ -372,13 +487,19 @@ export declare enum Mode {
     AND = "AND"
 }
 export interface CommonPaging {
-    /** Number of items to load. */
+    /**
+     * Number of items to load.
+     * @max 100
+     */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
 export interface CommonCursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
@@ -413,7 +534,10 @@ export interface CommonCursors {
     prev?: string | null;
 }
 export interface AddAbandonedCheckoutActivityRequest {
-    /** Id of the abandoned checkout to update */
+    /**
+     * Id of the abandoned checkout to update
+     * @format GUID
+     */
     abandonedCheckoutId: string | null;
     /** The type of the activity to add */
     activityType?: ActivityType;
@@ -452,9 +576,15 @@ export interface Reschedule {
     payload?: string | null;
 }
 export interface RedirectToCheckoutRequest {
-    /** abandoned checkout id */
+    /**
+     * ID of the abandoned checkout.
+     * @format GUID
+     */
     abandonedCheckoutId: string;
-    /** Identifier of the metaSite this checkout uses */
+    /**
+     * Metasite ID of the site associated with the abandoned checkout.
+     * @format GUID
+     */
     metasiteId: string;
 }
 export interface RawHttpResponse {
@@ -540,14 +670,16 @@ export interface ActionEvent {
 }
 export interface Empty {
 }
-/** Triggered when an abandoned checkout is recovered (the customer completes the checkout). */
-export interface AbandonedCheckoutRecovered {
-    abandonedCheckout?: AbandonedCheckout;
-}
 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;
@@ -555,26 +687,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-abandoned-checkout-abandoned-checkouts.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecom-v1-abandoned-checkout-abandoned-checkouts.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.ts"],"names":[],"mappings":";;;AA2CA,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB,uBAAuB;IACvB,6CAA6B,CAAA;IAC7B,iBAAiB;IACjB,uCAAuB,CAAA;IACvB,kBAAkB;IAClB,yCAAyB,CAAA;IACzB,sBAAsB;IACtB,iDAAiC,CAAA;IACjC,yBAAyB;IACzB,uDAAuC,CAAA;IACvC,oBAAoB;IACpB,6CAA6B,CAAA;AAC/B,CAAC,EAbW,YAAY,4BAAZ,YAAY,QAavB;AAED,wCAAwC;AACxC,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,iBAAiB;IACjB,iCAAuB,CAAA;IACvB,iBAAiB;IACjB,iCAAuB,CAAA;AACzB,CAAC,EALW,MAAM,sBAAN,MAAM,QAKjB;AAwDD,qBAAqB;AACrB,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,uBAAP,OAAO,QAMlB;AAoED,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,iCAAiC;IACjC,2BAAe,CAAA;IACf,4BAA4B;IAC5B,6BAAiB,CAAA;IACjB,gCAAgC;IAChC,+BAAmB,CAAA;IACnB,2CAA2C;IAC3C,+BAAmB,CAAA;AACrB,CAAC,EATW,QAAQ,wBAAR,QAAQ,QASnB;AA0FD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAsFD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,uBAAuB;IACvB,8BAAW,CAAA;IACX,wBAAwB;IACxB,gCAAa,CAAA;AACf,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAaD,IAAY,IAKX;AALD,WAAY,IAAI;IACd,UAAU;IACV,iBAAS,CAAA;IACT,UAAU;IACV,mBAAW,CAAA;AACb,CAAC,EALW,IAAI,oBAAJ,IAAI,QAKf;AA0OD,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-abandoned-checkout-abandoned-checkouts.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.ts"],"names":[],"mappings":";;;AA6DA,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB,uBAAuB;IACvB,6CAA6B,CAAA;IAC7B,iBAAiB;IACjB,uCAAuB,CAAA;IACvB,kBAAkB;IAClB,yCAAyB,CAAA;IACzB,sBAAsB;IACtB,iDAAiC,CAAA;IACjC,yBAAyB;IACzB,uDAAuC,CAAA;IACvC,oBAAoB;IACpB,6CAA6B,CAAA;AAC/B,CAAC,EAbW,YAAY,4BAAZ,YAAY,QAavB;AAED,wCAAwC;AACxC,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,iBAAiB;IACjB,iCAAuB,CAAA;IACvB,iBAAiB;IACjB,iCAAuB,CAAA;AACzB,CAAC,EALW,MAAM,sBAAN,MAAM,QAKjB;AA2FD,qBAAqB;AACrB,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,uBAAP,OAAO,QAMlB;AAsFD,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,iCAAiC;IACjC,2BAAe,CAAA;IACf,4BAA4B;IAC5B,6BAAiB,CAAA;IACjB,gCAAgC;IAChC,+BAAmB,CAAA;IACnB,2CAA2C;IAC3C,+BAAmB,CAAA;AACrB,CAAC,EATW,QAAQ,wBAAR,QAAQ,QASnB;AAgHD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAsGD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,uBAAuB;IACvB,8BAAW,CAAA;IACX,wBAAwB;IACxB,gCAAa,CAAA;AACf,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAoBD,IAAY,IAKX;AALD,WAAY,IAAI;IACd,UAAU;IACV,iBAAS,CAAA;IACT,UAAU;IACV,mBAAW,CAAA;AACb,CAAC,EALW,IAAI,oBAAJ,IAAI,QAKf;AAkRD,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"}