@wix/auto_sdk_ecom_local-delivery-options 1.0.32 → 1.0.34

package/build/internal/es/index.typings.d.mts

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
     zipConfig?: ZipCodeConfig;
@@ -836,7 +836,66 @@ interface LocalDeliveryOptionsQueryBuilder {
  * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.QueryLocalDeliveryOptions
  * @requiredField query
  */
-declare function typedQueryLocalDeliveryOptions(query: QueryV2): Promise<NonNullablePaths<QueryLocalDeliveryOptionsResponse, `localDeliveryOptions` | `localDeliveryOptions.${number}.radiusConfig.radius` | `localDeliveryOptions.${number}.radiusConfig.lengthUnit`, 5>>;
+declare function typedQueryLocalDeliveryOptions(query: LocalDeliveryOptionQuery): Promise<NonNullablePaths<QueryLocalDeliveryOptionsResponse, `localDeliveryOptions` | `localDeliveryOptions.${number}.radiusConfig.radius` | `localDeliveryOptions.${number}.radiusConfig.lengthUnit`, 5>>;
+interface LocalDeliveryOptionQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['deliveryRegionIds'];
+            operators: ['$hasAll', '$hasSome'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['_id', 'areaName', 'estimatedDeliveryTime'];
+            operators: '*';
+            sort: 'NONE';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<LocalDeliveryOption, LocalDeliveryOptionQuerySpec>;
+type LocalDeliveryOptionQuery = {
+    /**
+    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?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | 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?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /** @param _id - LocalDeliveryOptionId - unique identifier of local delivery option
  * @public
  * @documentationMaturity preview
@@ -1159,4 +1218,4 @@ interface RemoveDeliveryRegionOptions {
     revision?: string | null;
 }
 
-export { type ActionEvent, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddressLocation, type BulkCreateLocalDeliveryOptionApplicationErrors, type BulkCreateLocalDeliveryOptionRequest, type BulkCreateLocalDeliveryOptionResponse, type BulkDeleteLocalDeliveryOptionRequest, type BulkDeleteLocalDeliveryOptionResponse, type BulkUpdateLocalDeliveryOptionRequest, type BulkUpdateLocalDeliveryOptionResponse, type Condition, ConditionType, type ConditionTypeWithLiterals, type ConditionalRates, type CreateLocalDeliveryOptionApplicationErrors, type CreateLocalDeliveryOptionRequest, type CreateLocalDeliveryOptionResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomAreaConfig, DayOfWeek, type DayOfWeekWithLiterals, type DaySlot, type Days, type DeleteLocalDeliveryOptionOptions, type DeleteLocalDeliveryOptionRequest, type DeleteLocalDeliveryOptionResponse, type Destination, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetLocalDeliveryOptionOptions, type GetLocalDeliveryOptionRequest, type GetLocalDeliveryOptionResponse, type IdentificationData, type IdentificationDataIdOneOf, LengthUnit, type LengthUnitWithLiterals, type ListLocalDeliveryOptionsRequest, type ListLocalDeliveryOptionsResponse, type LocalDeliveryAddress, type LocalDeliveryOption, type LocalDeliveryOptionConfigOneOf, type LocalDeliveryOptionError, type LocalDeliveryOptionsQueryBuilder, type LocalDeliveryOptionsQueryResult, LogicalOperator, type LogicalOperatorWithLiterals, type MessageEnvelope, type Paging, type QueryLocalDeliveryOptionsRequest, type QueryLocalDeliveryOptionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RadiusConfig, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RestoreInfo, type ScheduledDelivery, SortOrder, type SortOrderWithLiterals, type Sorting, type TimeOfDay, type TimePoint, type TimeSlot, type TimeWindow, type UpdateLocalDeliveryOption, type UpdateLocalDeliveryOptionRequest, type UpdateLocalDeliveryOptionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type ZipCodeConfig, addDeliveryRegion, bulkCreateLocalDeliveryOption, bulkDeleteLocalDeliveryOption, bulkUpdateLocalDeliveryOption, createLocalDeliveryOption, deleteLocalDeliveryOption, getLocalDeliveryOption, listLocalDeliveryOptions, queryLocalDeliveryOptions, removeDeliveryRegion, typedQueryLocalDeliveryOptions, updateLocalDeliveryOption };
+export { type ActionEvent, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddressLocation, type BulkCreateLocalDeliveryOptionApplicationErrors, type BulkCreateLocalDeliveryOptionRequest, type BulkCreateLocalDeliveryOptionResponse, type BulkDeleteLocalDeliveryOptionRequest, type BulkDeleteLocalDeliveryOptionResponse, type BulkUpdateLocalDeliveryOptionRequest, type BulkUpdateLocalDeliveryOptionResponse, type CommonQueryWithEntityContext, type Condition, ConditionType, type ConditionTypeWithLiterals, type ConditionalRates, type CreateLocalDeliveryOptionApplicationErrors, type CreateLocalDeliveryOptionRequest, type CreateLocalDeliveryOptionResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomAreaConfig, DayOfWeek, type DayOfWeekWithLiterals, type DaySlot, type Days, type DeleteLocalDeliveryOptionOptions, type DeleteLocalDeliveryOptionRequest, type DeleteLocalDeliveryOptionResponse, type Destination, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetLocalDeliveryOptionOptions, type GetLocalDeliveryOptionRequest, type GetLocalDeliveryOptionResponse, type IdentificationData, type IdentificationDataIdOneOf, LengthUnit, type LengthUnitWithLiterals, type ListLocalDeliveryOptionsRequest, type ListLocalDeliveryOptionsResponse, type LocalDeliveryAddress, type LocalDeliveryOption, type LocalDeliveryOptionConfigOneOf, type LocalDeliveryOptionError, type LocalDeliveryOptionQuery, type LocalDeliveryOptionQuerySpec, type LocalDeliveryOptionsQueryBuilder, type LocalDeliveryOptionsQueryResult, LogicalOperator, type LogicalOperatorWithLiterals, type MessageEnvelope, type Paging, type QueryLocalDeliveryOptionsRequest, type QueryLocalDeliveryOptionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RadiusConfig, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RestoreInfo, type ScheduledDelivery, SortOrder, type SortOrderWithLiterals, type Sorting, type TimeOfDay, type TimePoint, type TimeSlot, type TimeWindow, type UpdateLocalDeliveryOption, type UpdateLocalDeliveryOptionRequest, type UpdateLocalDeliveryOptionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type ZipCodeConfig, addDeliveryRegion, bulkCreateLocalDeliveryOption, bulkDeleteLocalDeliveryOption, bulkUpdateLocalDeliveryOption, createLocalDeliveryOption, deleteLocalDeliveryOption, getLocalDeliveryOption, listLocalDeliveryOptions, queryLocalDeliveryOptions, removeDeliveryRegion, typedQueryLocalDeliveryOptions, updateLocalDeliveryOption };