@wix/auto_sdk_ecom_abandoned-checkouts 1.0.27 → 1.0.28

package/build/cjs/{ecom-v1-abandoned-checkout-abandoned-checkouts.universal-BBg7__GU.d.ts → ecom-v1-abandoned-checkout-abandoned-checkouts.universal-Dsp5bm2y.d.ts}

@@ -441,29 +441,35 @@ interface Cursors {
     prev?: string | null;
 }
 interface SearchAbandonedCheckoutsRequest {
-    /** WQL query expression. */
+    /** Search options. */
     search?: Search;
 }
 interface Search extends SearchPagingMethodOneOf {
-    /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
+    /** Paging options to limit and offset the number of items. */
     paging?: CommonPaging;
-    /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or sort. */
     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 object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      * @maxSize 4
      */
     sort?: CommonSorting[];
-    /** free text to match in searchable fields */
+    /** Free text to match in searchable fields. */
     search?: SearchDetails;
 }
 /** @oneof */
 interface SearchPagingMethodOneOf {
-    /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
+    /** Paging options to limit and offset the number of items. */
     paging?: CommonPaging;
-    /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or sort. */
     cursorPaging?: CommonCursorPaging;
 }
 interface CommonSorting {
@@ -484,26 +490,26 @@ declare enum CommonSortOrder {
 /** @enumType */
 type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
 interface SearchDetails {
-    /** boolean search mode */
+    /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
     mode?: ModeWithLiterals;
     /**
-     * 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 the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
      * @maxLength 100
      * @maxSize 20
      */
     fields?: string[];
-    /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
     fuzzy?: boolean;
 }
 declare enum Mode {
-    /** Any */
+    /** At least one of the search terms must be present. */
     OR = "OR",
-    /** All */
+    /** All search terms must be present. */
     AND = "AND"
 }
 /** @enumType */
@@ -1039,7 +1045,7 @@ interface AbandonedCheckoutSearchSpec extends SearchSpec {
 type CommonSearchWithEntityContext = Search$1<AbandonedCheckout, AbandonedCheckoutSearchSpec>;
 type AbandonedCheckoutSearch = {
     /**
-    Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort'
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or sort.
     */
     cursorPaging?: {
         /**
@@ -1056,11 +1062,15 @@ type AbandonedCheckoutSearch = {
         cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
     };
     /**
-    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 object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
     */
     filter?: CommonSearchWithEntityContext['filter'] | null;
     /**
-    Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
     @maxSize: 4
     */
     sort?: {
@@ -1075,26 +1085,26 @@ type AbandonedCheckoutSearch = {
         order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
     }[];
     /**
-    free text to match in searchable fields
+    Free text to match in searchable fields.
     */
     search?: {
         /**
-      boolean search mode
+      Search mode. Defines the search logic for combining multiple terms in the `expression`.
       */
         mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
         /**
-      search term or expression
+      Search term or expression.
       @maxLength: 100
       */
         expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
         /**
-      fields to search in. if empty - server will search in own default fields
+      Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
       @maxLength: 100,
       @maxSize: 20
       */
         fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
         /**
-      flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
+      Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions.
       */
         fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
     };

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { A as AbandonedCheckout, a as AbandonedCheckoutsQueryBuilder, b as AbandonedCheckoutSearch, S as SearchAbandonedCheckoutsResponse, R as RawHttpResponse, c as AbandonedCheckoutCreatedEnvelope, d as AbandonedCheckoutDeletedEnvelope, e as AbandonedCheckoutRecoveredEnvelope, f as AbandonedCheckoutUpdatedEnvelope } from './ecom-v1-abandoned-checkout-abandoned-checkouts.universal-BBg7__GU.js';
-export { q as AbandonedCheckoutRecovered, al as AbandonedCheckoutSearchSpec, ak as AbandonedCheckoutsQueryResult, ad as ActionEvent, n as Activity, g as ActivityType, am as AddAbandonedCheckoutActivityOptions, Y as AddAbandonedCheckoutActivityRequest, Z as AddAbandonedCheckoutActivityResponse, ai as BaseEventMetadata, B as BuyerInfo, a3 as Cancel, o as CartAbandonedEvent, p as CartRecoveredEvent, O as CommonCursorPaging, X as CommonCursors, N as CommonPaging, U as CommonPagingMetadataV2, C as CommonSortOrder, K as CommonSorting, a2 as Complete, w as CursorPaging, z as Cursors, D as DeleteAbandonedCheckoutRequest, s as DeleteAbandonedCheckoutResponse, a7 as DomainEvent, a8 as DomainEventBodyOneOf, ae as Empty, a9 as EntityCreatedEvent, ac as EntityDeletedEvent, ab as EntityUpdatedEvent, aj as EventMetadata, F as FullAddressContactDetails, G as GetAbandonedCheckoutRequest, r as GetAbandonedCheckoutResponse, a6 as HeadersEntry, ag as IdentificationData, ah as IdentificationDataIdOneOf, I as Identity, af as MessageEnvelope, M as Mode, m as MultiCurrencyPrice, P as Paging, y as PagingMetadataV2, Q as QueryAbandonedCheckoutsRequest, x as QueryAbandonedCheckoutsResponse, t as QueryV2, u as QueryV2PagingMethodOneOf, a5 as RedirectToCheckoutRequest, a4 as Reschedule, aa as RestoreInfo, H as Search, E as SearchAbandonedCheckoutsRequest, L as SearchDetails, J as SearchPagingMethodOneOf, i as SortOrder, v as Sorting, h as Status, _ as Task, a0 as TaskAction, a1 as TaskActionActionOneOf, $ as TaskKey, T as Totals, j as V1BuyerInfo, k as V1BuyerInfoIdOneOf, l as VatId, V as VatType, W as WebhookIdentityType } from './ecom-v1-abandoned-checkout-abandoned-checkouts.universal-BBg7__GU.js';
+import { A as AbandonedCheckout, a as AbandonedCheckoutsQueryBuilder, b as AbandonedCheckoutSearch, S as SearchAbandonedCheckoutsResponse, R as RawHttpResponse, c as AbandonedCheckoutCreatedEnvelope, d as AbandonedCheckoutDeletedEnvelope, e as AbandonedCheckoutRecoveredEnvelope, f as AbandonedCheckoutUpdatedEnvelope } from './ecom-v1-abandoned-checkout-abandoned-checkouts.universal-Dsp5bm2y.js';
+export { q as AbandonedCheckoutRecovered, al as AbandonedCheckoutSearchSpec, ak as AbandonedCheckoutsQueryResult, ad as ActionEvent, n as Activity, g as ActivityType, am as AddAbandonedCheckoutActivityOptions, Y as AddAbandonedCheckoutActivityRequest, Z as AddAbandonedCheckoutActivityResponse, ai as BaseEventMetadata, B as BuyerInfo, a3 as Cancel, o as CartAbandonedEvent, p as CartRecoveredEvent, O as CommonCursorPaging, X as CommonCursors, N as CommonPaging, U as CommonPagingMetadataV2, C as CommonSortOrder, K as CommonSorting, a2 as Complete, w as CursorPaging, z as Cursors, D as DeleteAbandonedCheckoutRequest, s as DeleteAbandonedCheckoutResponse, a7 as DomainEvent, a8 as DomainEventBodyOneOf, ae as Empty, a9 as EntityCreatedEvent, ac as EntityDeletedEvent, ab as EntityUpdatedEvent, aj as EventMetadata, F as FullAddressContactDetails, G as GetAbandonedCheckoutRequest, r as GetAbandonedCheckoutResponse, a6 as HeadersEntry, ag as IdentificationData, ah as IdentificationDataIdOneOf, I as Identity, af as MessageEnvelope, M as Mode, m as MultiCurrencyPrice, P as Paging, y as PagingMetadataV2, Q as QueryAbandonedCheckoutsRequest, x as QueryAbandonedCheckoutsResponse, t as QueryV2, u as QueryV2PagingMethodOneOf, a5 as RedirectToCheckoutRequest, a4 as Reschedule, aa as RestoreInfo, H as Search, E as SearchAbandonedCheckoutsRequest, L as SearchDetails, J as SearchPagingMethodOneOf, i as SortOrder, v as Sorting, h as Status, _ as Task, a0 as TaskAction, a1 as TaskActionActionOneOf, $ as TaskKey, T as Totals, j as V1BuyerInfo, k as V1BuyerInfoIdOneOf, l as VatId, V as VatType, W as WebhookIdentityType } from './ecom-v1-abandoned-checkout-abandoned-checkouts.universal-Dsp5bm2y.js';
 
 type AbandonedCheckoutNonNullablePaths = `_id` | `status` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `buyerInfo.userId` | `contactDetails.vatId._id` | `contactDetails.vatId.type` | `currency` | `totalPrice.amount` | `totalPrice.convertedAmount` | `totalPrice.formattedAmount` | `totalPrice.formattedConvertedAmount` | `activities` | `activities.${number}.type` | `checkoutUrl` | `subtotalPrice.amount` | `subtotalPrice.convertedAmount` | `subtotalPrice.formattedAmount` | `subtotalPrice.formattedConvertedAmount`;
 declare function getAbandonedCheckout$1(httpClient: HttpClient): GetAbandonedCheckoutSignature;
@@ -37,7 +37,7 @@ declare function searchAbandonedCheckouts$1(httpClient: HttpClient): SearchAband
 interface SearchAbandonedCheckoutsSignature {
     /**
      * Retrieves a list of abandoned checkouts, given the provided paging, filtering, search details and sorting. Up to 100 abandoned checkouts can be returned per request.
-     * @param - WQL query expression.
+     * @param - Search options.
      */
     (search: AbandonedCheckoutSearch): Promise<NonNullablePaths<SearchAbandonedCheckoutsResponse, {
         [P in AbandonedCheckoutNonNullablePaths]: `abandonedCheckouts.${number}.${P}`;