@wix/auto_sdk_calendar_schedules 1.0.96 → 1.0.98

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

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /**
  * A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
@@ -451,6 +451,15 @@ interface ParticipantNotification {
      * @maxLength 5000
      */
     message?: string | null;
+    /**
+     * Information about the delivery channels used to send the notification.
+     * For example, `{"channels": "SMS" }`, `{"channels": "EMAIL" }`, or `{"channels": "EMAIL, SMS" }`.
+     *
+     * Max: 10 keys
+     * Max key length: 64 characters
+     * Max value length: 1000 characters
+     */
+    metadata?: Record<string, string>;
 }
 interface UpdateScheduleResponse {
     /** Updated schedule. */
@@ -1708,7 +1717,53 @@ interface SchedulesQueryBuilder {
  * @fqn wix.calendar.schedules.v3.SchedulesService.QuerySchedules
  * @requiredField query
  */
-declare function typedQuerySchedules(query: CursorQuery, options?: QuerySchedulesOptions): Promise<NonNullablePaths<QuerySchedulesResponse, `schedules` | `schedules.${number}.status` | `schedules.${number}.defaultLocation.type` | `schedules.${number}.defaultConferencingDetails.type`, 5>>;
+declare function typedQuerySchedules(query: ScheduleQuery, options?: QuerySchedulesOptions): Promise<NonNullablePaths<QuerySchedulesResponse, `schedules` | `schedules.${number}.status` | `schedules.${number}.defaultLocation.type` | `schedules.${number}.defaultConferencingDetails.type`, 5>>;
+interface ScheduleQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id', 'appId', 'externalId', 'status'];
+            operators: ['$eq', '$in'];
+            sort: 'NONE';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Schedule, ScheduleQuerySpec>;
+type ScheduleQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`.
+    */
+    cursorPaging?: {
+        /**
+      Number of schedules to return.
+    
+      Min: `1`
+      Max: `100`
+      Default: `50`
+      @min: 1,
+      @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.
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+    See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+    for more information.
+  
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+  
+    For a detailed list of supported filters, see Supported Filters.
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+};
 /**
  * Creates a schedule.
  *
@@ -1927,4 +1982,4 @@ interface CancelScheduleOptions {
     participantNotification?: ParticipantNotification;
 }
 
-export { type ActionEvent, type Address, type AddressHint, type Asset, type BaseEventMetadata, type BusinessSchedule, type CancelScheduleApplicationErrors, type CancelScheduleOptions, type CancelScheduleRequest, type CancelScheduleResponse, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, type CloneScheduleRequest, type CloneScheduleResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type ConferencingDetails, type ConsentPolicy, type CreateScheduleOptions, type CreateScheduleRequest, type CreateScheduleResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, DayOfWeek, type DayOfWeekWithLiterals, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GeoCoordinates, type GetScheduleOptions, type GetScheduleRequest, type GetScheduleResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type Locale, type Location, LocationType, type LocationTypeWithLiterals, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type Multilingual, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type ParticipantNotification, type Permission, type PicassoAssigned, type PicassoUnassigned, PlacementType, type PlacementTypeWithLiterals, type Properties, type PropertiesChange, type QuerySchedulesOptions, type QuerySchedulesRequest, type QuerySchedulesResponse, RequestedFields, type RequestedFieldsWithLiterals, ResolutionMethod, type ResolutionMethodWithLiterals, type RestoreInfo, Role, type RoleWithLiterals, type Schedule, type ScheduleCancelled, type ScheduleCancelledEnvelope, type ScheduleCloned, type ScheduleClonedEnvelope, type ScheduleCreatedEnvelope, type ScheduleUpdatedEnvelope, type ScheduleUpdatedWithMetadata, type SchedulesQueryBuilder, type SchedulesQueryResult, type ServiceProvisioned, type ServiceRemoved, 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, type SpecialHourPeriod, State, type StateWithLiterals, Status, type StatusWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SupportedLanguage, type TimePeriod, type Translation, Trigger, type TriggerWithLiterals, Type, type TypeWithLiterals, type UpdateSchedule, type UpdateScheduleApplicationErrors, type UpdateScheduleOptions, type UpdateScheduleRequest, type UpdateScheduleResponse, type V4SiteCreated, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, cancelSchedule, createSchedule, getSchedule, onScheduleCancelled, onScheduleCloned, onScheduleCreated, onScheduleUpdated, querySchedules, typedQuerySchedules, updateSchedule };
+export { type ActionEvent, type Address, type AddressHint, type Asset, type BaseEventMetadata, type BusinessSchedule, type CancelScheduleApplicationErrors, type CancelScheduleOptions, type CancelScheduleRequest, type CancelScheduleResponse, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, type CloneScheduleRequest, type CloneScheduleResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, type ConferencingDetails, type ConsentPolicy, type CreateScheduleOptions, type CreateScheduleRequest, type CreateScheduleResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, DayOfWeek, type DayOfWeekWithLiterals, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GeoCoordinates, type GetScheduleOptions, type GetScheduleRequest, type GetScheduleResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type Locale, type Location, LocationType, type LocationTypeWithLiterals, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type Multilingual, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type ParticipantNotification, type Permission, type PicassoAssigned, type PicassoUnassigned, PlacementType, type PlacementTypeWithLiterals, type Properties, type PropertiesChange, type QuerySchedulesOptions, type QuerySchedulesRequest, type QuerySchedulesResponse, RequestedFields, type RequestedFieldsWithLiterals, ResolutionMethod, type ResolutionMethodWithLiterals, type RestoreInfo, Role, type RoleWithLiterals, type Schedule, type ScheduleCancelled, type ScheduleCancelledEnvelope, type ScheduleCloned, type ScheduleClonedEnvelope, type ScheduleCreatedEnvelope, type ScheduleQuery, type ScheduleQuerySpec, type ScheduleUpdatedEnvelope, type ScheduleUpdatedWithMetadata, type SchedulesQueryBuilder, type SchedulesQueryResult, type ServiceProvisioned, type ServiceRemoved, 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, type SpecialHourPeriod, State, type StateWithLiterals, Status, type StatusWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SupportedLanguage, type TimePeriod, type Translation, Trigger, type TriggerWithLiterals, Type, type TypeWithLiterals, type UpdateSchedule, type UpdateScheduleApplicationErrors, type UpdateScheduleOptions, type UpdateScheduleRequest, type UpdateScheduleResponse, type V4SiteCreated, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, cancelSchedule, createSchedule, getSchedule, onScheduleCancelled, onScheduleCloned, onScheduleCreated, onScheduleUpdated, querySchedules, typedQuerySchedules, updateSchedule };