@wix/auto_sdk_bookings_booking-policies 1.0.91 → 1.0.92

package/build/internal/cjs/index.typings.d.ts

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /**
  * A booking policy is a set of rules that determine how customers can book a
@@ -2003,7 +2003,104 @@ interface BookingPoliciesQueryBuilder {
  * @fqn wix.bookings.v1.BookingPoliciesService.QueryBookingPolicies
  * @requiredField query
  */
-declare function typedQueryBookingPolicies(query: CursorQuery): Promise<NonNullablePaths<QueryBookingPoliciesResponse, `bookingPolicies` | `bookingPolicies.${number}.customPolicyDescription.enabled` | `bookingPolicies.${number}.customPolicyDescription.description` | `bookingPolicies.${number}.limitEarlyBookingPolicy.enabled` | `bookingPolicies.${number}.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicies.${number}.limitLateBookingPolicy.enabled` | `bookingPolicies.${number}.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicies.${number}.bookAfterStartPolicy.enabled` | `bookingPolicies.${number}.cancellationPolicy.enabled` | `bookingPolicies.${number}.cancellationPolicy.limitLatestCancellation` | `bookingPolicies.${number}.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicies.${number}.reschedulePolicy.enabled` | `bookingPolicies.${number}.reschedulePolicy.limitLatestReschedule` | `bookingPolicies.${number}.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicies.${number}.waitlistPolicy.enabled` | `bookingPolicies.${number}.waitlistPolicy.capacity` | `bookingPolicies.${number}.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicies.${number}.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicies.${number}.cancellationFeePolicy.enabled` | `bookingPolicies.${number}.saveCreditCardPolicy.enabled`, 5>>;
+declare function typedQueryBookingPolicies(query: BookingPolicyQuery): Promise<NonNullablePaths<QueryBookingPoliciesResponse, `bookingPolicies` | `bookingPolicies.${number}.customPolicyDescription.enabled` | `bookingPolicies.${number}.customPolicyDescription.description` | `bookingPolicies.${number}.limitEarlyBookingPolicy.enabled` | `bookingPolicies.${number}.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicies.${number}.limitLateBookingPolicy.enabled` | `bookingPolicies.${number}.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicies.${number}.bookAfterStartPolicy.enabled` | `bookingPolicies.${number}.cancellationPolicy.enabled` | `bookingPolicies.${number}.cancellationPolicy.limitLatestCancellation` | `bookingPolicies.${number}.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicies.${number}.reschedulePolicy.enabled` | `bookingPolicies.${number}.reschedulePolicy.limitLatestReschedule` | `bookingPolicies.${number}.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicies.${number}.waitlistPolicy.enabled` | `bookingPolicies.${number}.waitlistPolicy.capacity` | `bookingPolicies.${number}.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicies.${number}.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicies.${number}.cancellationFeePolicy.enabled` | `bookingPolicies.${number}.saveCreditCardPolicy.enabled`, 5>>;
+interface BookingPolicyQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id'];
+            operators: ['$eq', '$in', '$ne'];
+            sort: 'BOTH';
+        },
+        {
+            fields: [
+                'customPolicyDescription.description',
+                'intakeFormPolicy.formId',
+                'name'
+            ];
+            operators: ['$begins', '$eq', '$ne'];
+            sort: 'BOTH';
+        },
+        {
+            fields: [
+                'bookAfterStartPolicy.enabled',
+                'cancellationPolicy.enabled',
+                'cancellationPolicy.limitLatestCancellation',
+                'customPolicyDescription.enabled',
+                'default',
+                'limitEarlyBookingPolicy.enabled',
+                'limitLateBookingPolicy.enabled',
+                'reschedulePolicy.enabled',
+                'reschedulePolicy.limitLatestReschedule',
+                'resourcesPolicy.autoAssignAllowed',
+                'resourcesPolicy.enabled',
+                'waitlistPolicy.enabled'
+            ];
+            operators: ['$eq', '$ne'];
+            sort: 'BOTH';
+        },
+        {
+            fields: [
+                'cancellationPolicy.latestCancellationInMinutes',
+                'limitEarlyBookingPolicy.earliestBookingInMinutes',
+                'limitLateBookingPolicy.latestBookingInMinutes',
+                'participantsPolicy.maxParticipantsPerBooking',
+                'reschedulePolicy.latestRescheduleInMinutes',
+                'waitlistPolicy.capacity',
+                'waitlistPolicy.reservationTimeInMinutes'
+            ];
+            operators: ['$eq', '$gt', '$gte', '$in', '$lt', '$lte', '$ne', '$nin'];
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<BookingPolicy, BookingPolicyQuerySpec>;
+type BookingPolicyQuery = {
+    /**
+    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?: {
+        /**
+      Number of items to load.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      You can get 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 in the following format:
+    `"filter" : {
+    "fieldName1": "value1",
+    "fieldName2":{"$operator":"value2"}
+    }`
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object in the following format:
+    `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    @maxSize: 10
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * Counts booking policies, given the provided filtering.
  *
@@ -2025,4 +2122,4 @@ interface CountBookingPoliciesOptions {
     filter?: Record<string, any> | null;
 }
 
-export { type ActionEvent, type Address, type AddressHint, type Asset, type BaseEventMetadata, type BookAfterStartPolicy, type BookingPoliciesQueryBuilder, type BookingPoliciesQueryResult, type BookingPolicy, type BookingPolicyCreatedEnvelope, type BookingPolicyDefaultBookingPolicySetEnvelope, type BookingPolicyDeletedEnvelope, type BookingPolicyUpdatedEnvelope, type BusinessSchedule, type CancellationFeePolicy, type CancellationPolicy, type CancellationWindow, type CancellationWindowFeeOneOf, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, CompletionRequirement, type CompletionRequirementWithLiterals, type ConsentPolicy, type CountBookingPoliciesOptions, type CountBookingPoliciesRequest, type CountBookingPoliciesResponse, type CreateBookingPolicyRequest, type CreateBookingPolicyResponse, type CreateBookingPolicyValidationErrors, type CreateMissingDefaultPolicyRequest, type CreateMissingDefaultPolicyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomOptions, DayOfWeek, type DayOfWeekWithLiterals, type DefaultBookingPolicySet, type DeleteBookingPolicyApplicationErrors, type DeleteBookingPolicyRequest, type DeleteBookingPolicyResponse, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GeoCoordinates, type GetBookingPolicyRequest, type GetBookingPolicyResponse, type GetStrictestBookingPolicyRequest, type GetStrictestBookingPolicyResponse, type IdentificationData, type IdentificationDataIdOneOf, type IntakeFormPolicy, type LimitEarlyBookingPolicy, type LimitLateBookingPolicy, type Locale, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type Money, type Multilingual, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type ParticipantsPolicy, type PicassoAssigned, type PicassoUnassigned, PlacementType, type PlacementTypeWithLiterals, type PolicyDescription, type Properties, type PropertiesChange, type QueryBookingPoliciesRequest, type QueryBookingPoliciesResponse, type RankingOptions, RankingOrder, type RankingOrderWithLiterals, type ReschedulePolicy, ResolutionMethod, type ResolutionMethodWithLiterals, type ResourcesPolicy, type RestoreInfo, type SaveCreditCardPolicy, type ServiceProvisioned, type ServiceRemoved, type SetDefaultBookingPolicyRequest, type SetDefaultBookingPolicyResponse, type SiteCloned, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePropertiesEvent, type SitePropertiesNotification, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, SortingMethodType, type SortingMethodTypeWithLiterals, type SpecialHourPeriod, type StaffSortingPolicy, type StaffSortingPolicyOptionsOneOf, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SupportedLanguage, type TimePeriod, Timing, type TimingWithLiterals, type Translation, type UpdateAllPoliciesRequest, type UpdateAllPoliciesResponse, type UpdateBookingPolicy, type UpdateBookingPolicyRequest, type UpdateBookingPolicyResponse, type UpdateBookingPolicyValidationErrors, type V4SiteCreated, type WaitlistPolicy, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, countBookingPolicies, createBookingPolicy, deleteBookingPolicy, getBookingPolicy, getStrictestBookingPolicy, onBookingPolicyCreated, onBookingPolicyDefaultBookingPolicySet, onBookingPolicyDeleted, onBookingPolicyUpdated, queryBookingPolicies, setDefaultBookingPolicy, typedQueryBookingPolicies, updateBookingPolicy };
+export { type ActionEvent, type Address, type AddressHint, type Asset, type BaseEventMetadata, type BookAfterStartPolicy, type BookingPoliciesQueryBuilder, type BookingPoliciesQueryResult, type BookingPolicy, type BookingPolicyCreatedEnvelope, type BookingPolicyDefaultBookingPolicySetEnvelope, type BookingPolicyDeletedEnvelope, type BookingPolicyQuery, type BookingPolicyQuerySpec, type BookingPolicyUpdatedEnvelope, type BusinessSchedule, type CancellationFeePolicy, type CancellationPolicy, type CancellationWindow, type CancellationWindowFeeOneOf, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, type CommonQueryWithEntityContext, CompletionRequirement, type CompletionRequirementWithLiterals, type ConsentPolicy, type CountBookingPoliciesOptions, type CountBookingPoliciesRequest, type CountBookingPoliciesResponse, type CreateBookingPolicyRequest, type CreateBookingPolicyResponse, type CreateBookingPolicyValidationErrors, type CreateMissingDefaultPolicyRequest, type CreateMissingDefaultPolicyResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomOptions, DayOfWeek, type DayOfWeekWithLiterals, type DefaultBookingPolicySet, type DeleteBookingPolicyApplicationErrors, type DeleteBookingPolicyRequest, type DeleteBookingPolicyResponse, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GeoCoordinates, type GetBookingPolicyRequest, type GetBookingPolicyResponse, type GetStrictestBookingPolicyRequest, type GetStrictestBookingPolicyResponse, type IdentificationData, type IdentificationDataIdOneOf, type IntakeFormPolicy, type LimitEarlyBookingPolicy, type LimitLateBookingPolicy, type Locale, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type Money, type Multilingual, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type ParticipantsPolicy, type PicassoAssigned, type PicassoUnassigned, PlacementType, type PlacementTypeWithLiterals, type PolicyDescription, type Properties, type PropertiesChange, type QueryBookingPoliciesRequest, type QueryBookingPoliciesResponse, type RankingOptions, RankingOrder, type RankingOrderWithLiterals, type ReschedulePolicy, ResolutionMethod, type ResolutionMethodWithLiterals, type ResourcesPolicy, type RestoreInfo, type SaveCreditCardPolicy, type ServiceProvisioned, type ServiceRemoved, type SetDefaultBookingPolicyRequest, type SetDefaultBookingPolicyResponse, type SiteCloned, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePropertiesEvent, type SitePropertiesNotification, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, SortingMethodType, type SortingMethodTypeWithLiterals, type SpecialHourPeriod, type StaffSortingPolicy, type StaffSortingPolicyOptionsOneOf, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SupportedLanguage, type TimePeriod, Timing, type TimingWithLiterals, type Translation, type UpdateAllPoliciesRequest, type UpdateAllPoliciesResponse, type UpdateBookingPolicy, type UpdateBookingPolicyRequest, type UpdateBookingPolicyResponse, type UpdateBookingPolicyValidationErrors, type V4SiteCreated, type WaitlistPolicy, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, countBookingPolicies, createBookingPolicy, deleteBookingPolicy, getBookingPolicy, getStrictestBookingPolicy, onBookingPolicyCreated, onBookingPolicyDefaultBookingPolicySet, onBookingPolicyDeleted, onBookingPolicyUpdated, queryBookingPolicies, setDefaultBookingPolicy, typedQueryBookingPolicies, updateBookingPolicy };