@wix/auto_sdk_calendar_schedule-time-frames 1.0.14 → 1.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/{internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts → calendar-v3-schedule-time-frame-schedule-time-frames.universal-Bmaxv3bl.d.mts} +56 -163
  2. package/build/{cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts → calendar-v3-schedule-time-frame-schedule-time-frames.universal-Bmaxv3bl.d.ts} +56 -163
  3. package/build/index.d.mts +40 -0
  4. package/build/index.d.ts +40 -0
  5. package/build/index.js +290 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +259 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts → calendar-v3-schedule-time-frame-schedule-time-frames.universal-Bmaxv3bl.d.mts} +56 -163
  10. package/build/{es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts → internal/calendar-v3-schedule-time-frame-schedule-time-frames.universal-Bmaxv3bl.d.ts} +56 -163
  11. package/build/internal/index.d.mts +40 -0
  12. package/build/internal/index.d.ts +40 -0
  13. package/build/internal/index.js +290 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +259 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +156 -0
  18. package/build/internal/meta.d.ts +156 -0
  19. package/build/internal/meta.js +172 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +144 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +156 -0
  24. package/build/meta.d.ts +156 -0
  25. package/build/meta.js +172 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +144 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.d.ts +0 -14
  40. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js +0 -22
  41. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js.map +0 -1
  42. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.d.ts +0 -10
  43. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js +0 -113
  44. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js.map +0 -1
  45. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.d.ts +0 -16
  46. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js +0 -66
  47. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js.map +0 -1
  48. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.d.ts +0 -31
  49. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js +0 -40
  50. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js.map +0 -1
  51. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.d.ts +0 -559
  52. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js +0 -46
  53. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js.map +0 -1
  54. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js +0 -195
  55. package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.d.ts +0 -14
  67. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js +0 -14
  68. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js.map +0 -1
  69. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.d.ts +0 -10
  70. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js +0 -108
  71. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js.map +0 -1
  72. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.d.ts +0 -16
  73. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js +0 -38
  74. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js.map +0 -1
  75. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.d.ts +0 -31
  76. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js +0 -30
  77. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js.map +0 -1
  78. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.d.ts +0 -559
  79. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js +0 -43
  80. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js.map +0 -1
  81. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js +0 -167
  82. package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.d.ts +0 -14
  93. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js +0 -22
  94. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js.map +0 -1
  95. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.d.ts +0 -10
  96. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js +0 -113
  97. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js.map +0 -1
  98. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.d.ts +0 -16
  99. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js +0 -66
  100. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js.map +0 -1
  101. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.d.ts +0 -31
  102. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js +0 -40
  103. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js.map +0 -1
  104. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.d.ts +0 -559
  105. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js +0 -46
  106. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js.map +0 -1
  107. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js +0 -195
  108. package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.d.ts +0 -14
  119. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js +0 -14
  120. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js.map +0 -1
  121. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.d.ts +0 -10
  122. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js +0 -108
  123. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js.map +0 -1
  124. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.d.ts +0 -16
  125. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js +0 -38
  126. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js.map +0 -1
  127. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.d.ts +0 -31
  128. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js +0 -30
  129. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js.map +0 -1
  130. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.d.ts +0 -559
  131. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js +0 -43
  132. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js.map +0 -1
  133. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js +0 -167
  134. package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js.map +0 -1
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/calendar-v3-schedule-time-frame-schedule-time-frames.public.ts","../src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.ts","../src/calendar-v3-schedule-time-frame-schedule-time-frames.http.ts","../src/calendar-v3-schedule-time-frame-schedule-time-frames.context.ts"],"sourcesContent":["import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { EventDefinition, HttpClient } from '@wix/sdk-types';\nimport {\n GetScheduleTimeFrameOptions,\n ListScheduleTimeFramesOptions,\n ListScheduleTimeFramesResponse,\n ScheduleTimeFrame,\n ScheduleTimeFrameUpdatedEnvelope,\n getScheduleTimeFrame as universalGetScheduleTimeFrame,\n listScheduleTimeFrames as universalListScheduleTimeFrames,\n} from './calendar-v3-schedule-time-frame-schedule-time-frames.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/calendar' };\n\nexport function getScheduleTimeFrame(\n httpClient: HttpClient\n): GetScheduleTimeFrameSignature {\n return (_id: string, options?: GetScheduleTimeFrameOptions) =>\n universalGetScheduleTimeFrame(\n _id,\n options,\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface GetScheduleTimeFrameSignature {\n /**\n * Retrieves a schedule time frame by schedule ID.\n * @param - [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)\n * ID for which to retrieve the schedule time frame.\n * @returns Retrieved schedule time frame.\n */\n (\n _id: string,\n options?: GetScheduleTimeFrameOptions | undefined\n ): Promise<ScheduleTimeFrame>;\n}\n\nexport function listScheduleTimeFrames(\n httpClient: HttpClient\n): ListScheduleTimeFramesSignature {\n return (ids: string[], options?: ListScheduleTimeFramesOptions) =>\n universalListScheduleTimeFrames(\n ids,\n options,\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface ListScheduleTimeFramesSignature {\n /**\n * Retrieves a list of schedule time frames by schedule IDs.\n *\n *\n * Sorted by schedule ID in ascending order.\n * @param - IDs of the schedules for which to retrieve schedule time frames.\n *\n * Min: 1 schedule ID\n * Max: 100 schedule IDs\n */\n (\n ids: string[],\n options?: ListScheduleTimeFramesOptions | undefined\n ): Promise<ListScheduleTimeFramesResponse>;\n}\n\nexport const onScheduleTimeFrameUpdated = EventDefinition(\n 'wix.calendar.v3.schedule_time_frame_updated',\n true,\n (event: ScheduleTimeFrameUpdatedEnvelope) =>\n renameKeysFromRESTResponseToSDKResponse(\n transformPaths(event, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'entity.firstEventStartDate.utcDate' },\n { path: 'entity.lastEventEndDate.utcDate' },\n { path: 'entity.adjustedFirstEventStartDate.utcDate' },\n { path: 'entity.adjustedLastEventEndDate.utcDate' },\n { path: 'metadata.eventTime' },\n ],\n },\n ])\n )\n)<ScheduleTimeFrameUpdatedEnvelope>();\n\nexport {\n ActionEvent,\n Address,\n AddressHint,\n BaseEventMetadata,\n BusinessSchedule,\n Categories,\n ChangeContext,\n ChangeContextPayloadOneOf,\n ConsentPolicy,\n DayOfWeek,\n DomainEvent,\n DomainEventBodyOneOf,\n Empty,\n EntityCreatedEvent,\n EntityDeletedEvent,\n EntityUpdatedEvent,\n EventMetadata,\n GeoCoordinates,\n GetScheduleTimeFrameOptions,\n GetScheduleTimeFrameRequest,\n GetScheduleTimeFrameResponse,\n IdentificationData,\n IdentificationDataIdOneOf,\n ListScheduleTimeFramesOptions,\n ListScheduleTimeFramesRequest,\n ListScheduleTimeFramesResponse,\n Locale,\n MessageEnvelope,\n Multilingual,\n PlacementType,\n Properties,\n PropertiesChange,\n ResolutionMethod,\n RestoreInfo,\n ScheduleTimeFrame,\n ScheduleTimeFrameUpdatedEnvelope,\n SiteCloned,\n SiteCreated,\n SitePropertiesEvent,\n SitePropertiesNotification,\n SpecialHourPeriod,\n Status,\n SupportedLanguage,\n TimePeriod,\n Translation,\n WebhookIdentityType,\n ZonedDate,\n} from './calendar-v3-schedule-time-frame-schedule-time-frames.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixCalendarV3ScheduleTimeFrame from './calendar-v3-schedule-time-frame-schedule-time-frames.http.js';\n\n/**\n * Information about the start and end dates of the first and last\n * [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)\n * that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)\n * and whether any events follow an unlimited repetition pattern.\n */\nexport interface ScheduleTimeFrame {\n /**\n * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)\n * to which the time frame belongs.\n * @format GUID\n * @readonly\n */\n _id?: string | null;\n /**\n * Information about the presence of recurring events within the schedule.\n *\n * Supported values:\n * + `NONE`: No [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) are scheduled within the schedule.\n * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.\n * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.\n * @readonly\n */\n status?: StatusWithLiterals;\n /**\n * Start date of the first [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)\n * within the schedule. Identical to `event.start.localDate`. Available only if\n * `status` is set to `FINITE` or `INFINITE`.\n * @readonly\n */\n firstEventStartDate?: ZonedDate;\n /**\n * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)\n * belonging to the schedule. Identical to `event.end.localDate`. Available only if\n * `status` is set to `FINITE`.\n * @readonly\n */\n lastEventEndDate?: ZonedDate;\n /**\n * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)\n * belonging to the schedule, adjusted to `timeZone` of the\n * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)\n * or the `timeZone` specified in the request.\n * Identical to `event.adjustedStart.localDate`.\n * @readonly\n */\n adjustedFirstEventStartDate?: ZonedDate;\n /**\n * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)\n * belonging to the schedule, adjusted to `timeZone` of the\n * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)\n * or the `timeZone` specified in the request.\n * Identical to `event.adjustedEnd.localDate`.\n * @readonly\n */\n adjustedLastEventEndDate?: ZonedDate;\n /**\n * Revision number, which increments by 1 each time the schedule time frame is updated.\n * @readonly\n */\n revision?: string | null;\n}\n\nexport enum Status {\n UNKNOWN_STATUS = 'UNKNOWN_STATUS',\n /** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */\n NONE = 'NONE',\n /** There are no recurring events or all recurring events belonging to the schedule have a defined end date. */\n FINITE = 'FINITE',\n /** At least one recurring event belonging to the schedule has an unlimited repetition pattern (no end date). */\n INFINITE = 'INFINITE',\n}\n\n/** @enumType */\nexport type StatusWithLiterals =\n | Status\n | 'UNKNOWN_STATUS'\n | 'NONE'\n | 'FINITE'\n | 'INFINITE';\n\n/** A date time with a time zone, having the UTC offset and date determined by the server. */\nexport interface ZonedDate {\n /**\n * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).\n * For example, `2024-01-30T13:30:00`.\n * Wix Calendar APIs ignore seconds.\n * @format LOCAL_DATE_TIME\n */\n localDate?: string | null;\n /**\n * Time zone in\n * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).\n * For example, `America/New_York`.\n * @readonly\n */\n timeZone?: string | null;\n /**\n * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).\n * For example, `2024-01-30T13:30:00`.\n * Not available for adjusted date fields.\n * @readonly\n */\n utcDate?: Date | null;\n}\n\nexport interface GetScheduleTimeFrameRequest {\n /**\n * [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)\n * ID for which to retrieve the schedule time frame.\n * @format GUID\n */\n _id: string | null;\n /**\n * Time zone for adjusting the times of the returned schedule time frame.\n *\n * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)\n */\n timeZone?: string | null;\n}\n\nexport interface GetScheduleTimeFrameResponse {\n /** Retrieved schedule time frame. */\n scheduleTimeFrame?: ScheduleTimeFrame;\n}\n\nexport interface ListScheduleTimeFramesRequest {\n /**\n * IDs of the schedules for which to retrieve schedule time frames.\n *\n * Min: 1 schedule ID\n * Max: 100 schedule IDs\n * @minSize 1\n * @maxSize 100\n * @format GUID\n */\n ids: string[];\n /**\n * Time zone for adjusting the times of the returned schedule time frames.\n *\n * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)\n */\n timeZone?: string | null;\n}\n\nexport interface ListScheduleTimeFramesResponse {\n /** Retrieved schedule time frames. */\n scheduleTimeFrames?: ScheduleTimeFrame[];\n}\n\n/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */\nexport interface SitePropertiesNotification {\n /** The site ID for which this update notification applies. */\n metasiteId?: string;\n /** The actual update event. */\n event?: SitePropertiesEvent;\n /**\n * A convenience set of mappings from the MetaSite ID to its constituent services.\n * @maxSize 500\n */\n translations?: Translation[];\n /** Context of the notification */\n changeContext?: ChangeContext;\n}\n\n/** The actual update event for a particular notification. */\nexport interface SitePropertiesEvent {\n /** Version of the site's properties represented by this update. */\n version?: number;\n /** Set of properties that were updated - corresponds to the fields in \"properties\". */\n fields?: string[];\n /** Updated properties. */\n properties?: Properties;\n}\n\nexport interface Properties {\n /** Site categories. */\n categories?: Categories;\n /** Site locale. */\n locale?: Locale;\n /**\n * Site language.\n *\n * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n */\n language?: string | null;\n /**\n * Site currency format used to bill customers.\n *\n * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n paymentCurrency?: string | null;\n /** Timezone in `America/New_York` format. */\n timeZone?: string | null;\n /** Email address. */\n email?: string | null;\n /** Phone number. */\n phone?: string | null;\n /** Fax number. */\n fax?: string | null;\n /** Address. */\n address?: Address;\n /** Site display name. */\n siteDisplayName?: string | null;\n /** Business name. */\n businessName?: string | null;\n /** Path to the site's logo in Wix Media (without Wix Media base URL). */\n logo?: string | null;\n /** Site description. */\n description?: string | null;\n /**\n * Business schedule. Regular and exceptional time periods when the business is open or the service is available.\n *\n * __Note:__ Not supported by Wix Bookings.\n */\n businessSchedule?: BusinessSchedule;\n /** Supported languages of a site and the primary language. */\n multilingual?: Multilingual;\n /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */\n consentPolicy?: ConsentPolicy;\n /**\n * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.\n *\n * Site business type.\n */\n businessConfig?: string | null;\n /** External site URL that uses Wix as its headless business solution. */\n externalSiteUrl?: string | null;\n /** Track clicks analytics. */\n trackClicksAnalytics?: boolean;\n}\n\nexport interface Categories {\n /** Primary site category. */\n primary?: string;\n /**\n * Secondary site category.\n * @maxSize 50\n */\n secondary?: string[];\n /** Business Term Id */\n businessTermId?: string | null;\n}\n\nexport interface Locale {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */\n country?: string;\n}\n\nexport interface Address {\n /** Street name. */\n street?: string;\n /** City name. */\n city?: string;\n /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string;\n /** State. */\n state?: string;\n /**\n * Zip or postal code.\n * @maxLength 20\n */\n zip?: string;\n /** Extra information to be displayed in the address. */\n hint?: AddressHint;\n /** Whether this address represents a physical location. */\n isPhysical?: boolean;\n /** Google-formatted version of this address. */\n googleFormattedAddress?: string;\n /** Street number. */\n streetNumber?: string;\n /** Apartment number. */\n apartmentNumber?: string;\n /** Geographic coordinates of location. */\n coordinates?: GeoCoordinates;\n}\n\n/**\n * Extra information on displayed addresses.\n * This is used for display purposes. Used to add additional data about the address, such as \"In the passage\".\n * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.\n */\nexport interface AddressHint {\n /** Extra text displayed next to, or instead of, the actual address. */\n text?: string;\n /** Where the extra text should be displayed. */\n placement?: PlacementTypeWithLiterals;\n}\n\n/** Where the extra text should be displayed: before, after or instead of the actual address. */\nexport enum PlacementType {\n BEFORE = 'BEFORE',\n AFTER = 'AFTER',\n REPLACE = 'REPLACE',\n}\n\n/** @enumType */\nexport type PlacementTypeWithLiterals =\n | PlacementType\n | 'BEFORE'\n | 'AFTER'\n | 'REPLACE';\n\n/** Geocoordinates for a particular address. */\nexport interface GeoCoordinates {\n /** Latitude of the location. Must be between -90 and 90. */\n latitude?: number;\n /** Longitude of the location. Must be between -180 and 180. */\n longitude?: number;\n}\n\n/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */\nexport interface BusinessSchedule {\n /**\n * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.\n * @maxSize 100\n */\n periods?: TimePeriod[];\n /**\n * Exceptions to the business's regular hours. The business can be open or closed during the exception.\n * @maxSize 100\n */\n specialHourPeriod?: SpecialHourPeriod[];\n}\n\n/** Weekly recurring time periods when the business is regularly open or the service is available. */\nexport interface TimePeriod {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeekWithLiterals;\n /**\n * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n */\n openTime?: string;\n /** Day of the week the period ends on. */\n closeDay?: DayOfWeekWithLiterals;\n /**\n * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\n * midnight at the end of the specified day.\n *\n * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.\n */\n closeTime?: string;\n}\n\n/** Enumerates the days of the week. */\nexport enum DayOfWeek {\n MONDAY = 'MONDAY',\n TUESDAY = 'TUESDAY',\n WEDNESDAY = 'WEDNESDAY',\n THURSDAY = 'THURSDAY',\n FRIDAY = 'FRIDAY',\n SATURDAY = 'SATURDAY',\n SUNDAY = 'SUNDAY',\n}\n\n/** @enumType */\nexport type DayOfWeekWithLiterals =\n | DayOfWeek\n | 'MONDAY'\n | 'TUESDAY'\n | 'WEDNESDAY'\n | 'THURSDAY'\n | 'FRIDAY'\n | 'SATURDAY'\n | 'SUNDAY';\n\n/** Exception to the business's regular hours. The business can be open or closed during the exception. */\nexport interface SpecialHourPeriod {\n /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */\n endDate?: string;\n /**\n * Whether the business is closed (or the service is not available) during the exception.\n *\n * Default: `true`.\n */\n isClosed?: boolean;\n /** Additional info about the exception. For example, \"We close earlier on New Year's Eve.\" */\n comment?: string;\n}\n\nexport interface Multilingual {\n /**\n * Supported languages list.\n * @maxSize 200\n */\n supportedLanguages?: SupportedLanguage[];\n /** Whether to redirect to user language. */\n autoRedirect?: boolean;\n}\n\nexport interface SupportedLanguage {\n /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */\n languageCode?: string;\n /** Locale. */\n locale?: Locale;\n /** Whether the supported language is the primary language for the site. */\n isPrimary?: boolean;\n /** Language icon. */\n countryCode?: string;\n /** How the language will be resolved. For internal use. */\n resolutionMethod?: ResolutionMethodWithLiterals;\n /** Whether the supported language is the primary language for site visitors. */\n isVisitorPrimary?: boolean | null;\n}\n\nexport enum ResolutionMethod {\n QUERY_PARAM = 'QUERY_PARAM',\n SUBDOMAIN = 'SUBDOMAIN',\n SUBDIRECTORY = 'SUBDIRECTORY',\n}\n\n/** @enumType */\nexport type ResolutionMethodWithLiterals =\n | ResolutionMethod\n | 'QUERY_PARAM'\n | 'SUBDOMAIN'\n | 'SUBDIRECTORY';\n\nexport interface ConsentPolicy {\n /** Whether the site uses cookies that are essential to site operation. Always `true`. */\n essential?: boolean | null;\n /** Whether the site uses cookies that affect site performance and other functional measurements. */\n functional?: boolean | null;\n /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */\n analytics?: boolean | null;\n /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */\n advertising?: boolean | null;\n /** CCPA compliance flag. */\n dataToThirdParty?: boolean | null;\n}\n\n/** A single mapping from the MetaSite ID to a particular service. */\nexport interface Translation {\n /** The service type. */\n serviceType?: string;\n /** The application definition ID; this only applies to services of type ThirdPartyApps. */\n appDefId?: string;\n /** The instance ID of the service. */\n instanceId?: string;\n}\n\nexport interface ChangeContext extends ChangeContextPayloadOneOf {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned;\n}\n\n/** @oneof */\nexport interface ChangeContextPayloadOneOf {\n /** Properties were updated. */\n propertiesChange?: PropertiesChange;\n /** Default properties were created on site creation. */\n siteCreated?: SiteCreated;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned;\n}\n\nexport interface PropertiesChange {}\n\nexport interface SiteCreated {\n /** Origin template site id. */\n originTemplateId?: string | null;\n}\n\nexport interface SiteCloned {\n /** Origin site id. */\n originMetaSiteId?: string;\n}\n\nexport interface Empty {}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n _id?: string;\n /**\n * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n */\n entityFqdn?: string;\n /**\n * Event action name, placed at the top level to make it easier for users to dispatch messages.\n * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n */\n entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n entity?: string;\n}\n\nexport interface RestoreInfo {\n deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n /**\n * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n */\n currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n /** Entity that was deleted. */\n deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n body?: string;\n}\n\nexport interface MessageEnvelope {\n /**\n * App instance ID.\n * @format GUID\n */\n instanceId?: string | null;\n /**\n * Event type.\n * @maxLength 150\n */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n /** Stringify payload. */\n data?: string;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n /**\n * ID of a site visitor that has not logged in to the site.\n * @format GUID\n */\n anonymousVisitorId?: string;\n /**\n * ID of a site visitor that has logged in to the site.\n * @format GUID\n */\n memberId?: string;\n /**\n * ID of a Wix user (site owner, contributor, etc.).\n * @format GUID\n */\n wixUserId?: string;\n /**\n * ID of an app.\n * @format GUID\n */\n appId?: string;\n /** @readonly */\n identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n /**\n * ID of a site visitor that has not logged in to the site.\n * @format GUID\n */\n anonymousVisitorId?: string;\n /**\n * ID of a site visitor that has logged in to the site.\n * @format GUID\n */\n memberId?: string;\n /**\n * ID of a Wix user (site owner, contributor, etc.).\n * @format GUID\n */\n wixUserId?: string;\n /**\n * ID of an app.\n * @format GUID\n */\n appId?: string;\n}\n\nexport enum WebhookIdentityType {\n UNKNOWN = 'UNKNOWN',\n ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n MEMBER = 'MEMBER',\n WIX_USER = 'WIX_USER',\n APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n | WebhookIdentityType\n | 'UNKNOWN'\n | 'ANONYMOUS_VISITOR'\n | 'MEMBER'\n | 'WIX_USER'\n | 'APP';\n\nexport interface BaseEventMetadata {\n /**\n * App instance ID.\n * @format GUID\n */\n instanceId?: string | null;\n /**\n * Event type.\n * @maxLength 150\n */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData;\n}\n\nexport interface EventMetadata extends BaseEventMetadata {\n /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n _id?: string;\n /**\n * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n */\n entityFqdn?: string;\n /**\n * Event action name, placed at the top level to make it easier for users to dispatch messages.\n * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n */\n slug?: string;\n /** ID of the entity associated with the event. */\n entityId?: string;\n /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n eventTime?: Date | null;\n /**\n * Whether the event was triggered as a result of a privacy regulation application\n * (for example, GDPR).\n */\n triggeredByAnonymizeRequest?: boolean | null;\n /** If present, indicates the action that triggered the event. */\n originatedFrom?: string | null;\n /**\n * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n */\n entityEventSequence?: string | null;\n}\n\nexport interface ScheduleTimeFrameUpdatedEnvelope {\n entity: ScheduleTimeFrame;\n metadata: EventMetadata;\n}\n\n/**\n * Triggered when a schedule's time frame is updated, indicating a new first or\n * last event or a change in the recurrence period, such as an extension or\n * reduction.\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Read Calendar - Including PI\n * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI\n * @permissionScope Manage Calendars\n * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Read Bookings Calendar Availability\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR\n * @permissionScope Read Calendar\n * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Read bookings calendar - including participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS\n * @permissionScope Read Bookings Calendar\n * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES\n * @permissionId CALENDAR.SCHEDULE_READ\n * @webhook\n * @eventType wix.calendar.v3.schedule_time_frame_updated\n * @slug updated\n */\nexport declare function onScheduleTimeFrameUpdated(\n handler: (event: ScheduleTimeFrameUpdatedEnvelope) => void | Promise<void>\n): void;\n\ntype ScheduleTimeFrameNonNullablePaths = `status`;\n\n/**\n * Retrieves a schedule time frame by schedule ID.\n * @param _id - [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)\n * ID for which to retrieve the schedule time frame.\n * @public\n * @requiredField _id\n * @permissionId CALENDAR.SCHEDULE_READ\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Read Calendar - Including PI\n * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI\n * @permissionScope Manage Calendars\n * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Read Bookings Calendar Availability\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR\n * @permissionScope Read Calendar\n * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Read bookings calendar - including participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS\n * @permissionScope Read Bookings Calendar\n * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @returns Retrieved schedule time frame.\n * @fqn wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.GetScheduleTimeFrame\n */\nexport async function getScheduleTimeFrame(\n _id: string,\n options?: GetScheduleTimeFrameOptions\n): Promise<\n NonNullablePaths<ScheduleTimeFrame, ScheduleTimeFrameNonNullablePaths>\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[2] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({\n id: _id,\n timeZone: options?.timeZone,\n });\n\n const reqOpts =\n ambassadorWixCalendarV3ScheduleTimeFrame.getScheduleTimeFrame(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)\n ?.scheduleTimeFrame!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: { id: '$[0]', timeZone: '$[1].timeZone' },\n singleArgumentUnchanged: false,\n },\n ['_id', 'options']\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n\nexport interface GetScheduleTimeFrameOptions {\n /**\n * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.\n *\n * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)\n */\n timeZone?: string | null;\n}\n\n/**\n * Retrieves a list of schedule time frames by schedule IDs.\n *\n *\n * Sorted by schedule ID in ascending order.\n * @param ids - IDs of the schedules for which to retrieve schedule time frames.\n *\n * Min: 1 schedule ID\n * Max: 100 schedule IDs\n * @public\n * @requiredField ids\n * @permissionId CALENDAR.SCHEDULE_READ\n * @permissionScope Read Bookings - Public Data\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC\n * @permissionScope Read Calendar - Including PI\n * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI\n * @permissionScope Manage Calendars\n * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE\n * @permissionScope Manage Bookings\n * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS\n * @permissionScope Read Bookings - Including Participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE\n * @permissionScope Read Bookings - all read permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS\n * @permissionScope Read Bookings Calendar Availability\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR\n * @permissionScope Read Calendar\n * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC\n * @permissionScope Manage Bookings - all permissions\n * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS\n * @permissionScope Read bookings calendar - including participants\n * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS\n * @permissionScope Read Bookings Calendar\n * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES\n * @applicableIdentity APP\n * @applicableIdentity VISITOR\n * @fqn wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.ListScheduleTimeFrames\n */\nexport async function listScheduleTimeFrames(\n ids: string[],\n options?: ListScheduleTimeFramesOptions\n): Promise<\n NonNullablePaths<\n ListScheduleTimeFramesResponse,\n {\n [P in ScheduleTimeFrameNonNullablePaths]: `scheduleTimeFrames.${number}.${P}`;\n }[ScheduleTimeFrameNonNullablePaths]\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[2] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({\n ids: ids,\n timeZone: options?.timeZone,\n });\n\n const reqOpts =\n ambassadorWixCalendarV3ScheduleTimeFrame.listScheduleTimeFrames(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: { ids: '$[0]', timeZone: '$[1].timeZone' },\n singleArgumentUnchanged: false,\n },\n ['ids', 'options']\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n\nexport interface ListScheduleTimeFramesOptions {\n /**\n * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.\n *\n * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)\n */\n timeZone?: string | null;\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixCalendarScheduletimeframesV3ScheduleTimeFramesServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'api._api_base_domain_': [\n {\n srcPath: '/schedule-timeframes-3',\n destPath: '',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/_api/calendar/v3/schedules/timeframe',\n destPath: '/v3/schedules/timeframe',\n },\n ],\n _: [\n {\n srcPath: '/_api/calendar/v3/schedules/timeframe',\n destPath: '/v3/schedules/timeframe',\n },\n ],\n 'manage._base_domain_': [\n {\n srcPath: '/_api/calendar/v3/schedules/timeframe',\n destPath: '/v3/schedules/timeframe',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/calendar/v3/schedules/timeframe',\n destPath: '/v3/schedules/timeframe',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_calendar_schedule-time-frames';\n\n/** Retrieves a schedule time frame by schedule ID. */\nexport function getScheduleTimeFrame(\n payload: object\n): RequestOptionsFactory<any> {\n function __getScheduleTimeFrame({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.calendar.v3.schedule_time_frame',\n method: 'GET' as any,\n methodFqn:\n 'wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.GetScheduleTimeFrame',\n packageName: PACKAGE_NAME,\n url: resolveWixCalendarScheduletimeframesV3ScheduleTimeFramesServiceUrl({\n protoPath: '/v3/schedules/timeframe/{id}',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'scheduleTimeFrame.firstEventStartDate.utcDate' },\n { path: 'scheduleTimeFrame.lastEventEndDate.utcDate' },\n { path: 'scheduleTimeFrame.adjustedFirstEventStartDate.utcDate' },\n { path: 'scheduleTimeFrame.adjustedLastEventEndDate.utcDate' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __getScheduleTimeFrame;\n}\n\n/**\n * Retrieves a list of schedule time frames by schedule IDs.\n *\n *\n * Sorted by schedule ID in ascending order.\n */\nexport function listScheduleTimeFrames(\n payload: object\n): RequestOptionsFactory<any> {\n function __listScheduleTimeFrames({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.calendar.v3.schedule_time_frame',\n method: 'GET' as any,\n methodFqn:\n 'wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.ListScheduleTimeFrames',\n packageName: PACKAGE_NAME,\n url: resolveWixCalendarScheduletimeframesV3ScheduleTimeFramesServiceUrl({\n protoPath: '/v3/schedules/timeframe',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n transformResponse: (payload: any) =>\n transformPaths(payload, [\n {\n transformFn: transformRESTTimestampToSDKTimestamp,\n paths: [\n { path: 'scheduleTimeFrames.firstEventStartDate.utcDate' },\n { path: 'scheduleTimeFrames.lastEventEndDate.utcDate' },\n {\n path: 'scheduleTimeFrames.adjustedFirstEventStartDate.utcDate',\n },\n { path: 'scheduleTimeFrames.adjustedLastEventEndDate.utcDate' },\n ],\n },\n ]),\n };\n\n return metadata;\n }\n\n return __listScheduleTimeFrames;\n}\n","import {\n getScheduleTimeFrame as publicGetScheduleTimeFrame,\n listScheduleTimeFrames as publicListScheduleTimeFrames,\n} from './calendar-v3-schedule-time-frame-schedule-time-frames.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { createEventModule } from '@wix/sdk-runtime/event-definition-modules';\nimport {\n BuildRESTFunction,\n MaybeContext,\n BuildEventDefinition,\n} from '@wix/sdk-types';\nimport { onScheduleTimeFrameUpdated as publicOnScheduleTimeFrameUpdated } from './calendar-v3-schedule-time-frame-schedule-time-frames.public.js';\n\nexport const getScheduleTimeFrame: MaybeContext<\n BuildRESTFunction<typeof publicGetScheduleTimeFrame> &\n typeof publicGetScheduleTimeFrame\n> = /*#__PURE__*/ createRESTModule(publicGetScheduleTimeFrame);\nexport const listScheduleTimeFrames: MaybeContext<\n BuildRESTFunction<typeof publicListScheduleTimeFrames> &\n typeof publicListScheduleTimeFrames\n> = /*#__PURE__*/ createRESTModule(publicListScheduleTimeFrames);\n/**\n * Triggered when a schedule's time frame is updated, indicating a new first or\n * last event or a change in the recurrence period, such as an extension or\n * reduction.\n */\nexport const onScheduleTimeFrameUpdated: BuildEventDefinition<\n typeof publicOnScheduleTimeFrameUpdated\n> = createEventModule(publicOnScheduleTimeFrameUpdated);\n\nexport {\n Status,\n PlacementType,\n DayOfWeek,\n ResolutionMethod,\n WebhookIdentityType,\n} from './calendar-v3-schedule-time-frame-schedule-time-frames.universal.js';\nexport {\n ScheduleTimeFrame,\n ZonedDate,\n GetScheduleTimeFrameRequest,\n GetScheduleTimeFrameResponse,\n ListScheduleTimeFramesRequest,\n ListScheduleTimeFramesResponse,\n SitePropertiesNotification,\n SitePropertiesEvent,\n Properties,\n Categories,\n Locale,\n Address,\n AddressHint,\n GeoCoordinates,\n BusinessSchedule,\n TimePeriod,\n SpecialHourPeriod,\n Multilingual,\n SupportedLanguage,\n ConsentPolicy,\n Translation,\n ChangeContext,\n ChangeContextPayloadOneOf,\n PropertiesChange,\n SiteCreated,\n SiteCloned,\n Empty,\n DomainEvent,\n DomainEventBodyOneOf,\n EntityCreatedEvent,\n RestoreInfo,\n EntityUpdatedEvent,\n EntityDeletedEvent,\n ActionEvent,\n MessageEnvelope,\n IdentificationData,\n IdentificationDataIdOneOf,\n BaseEventMetadata,\n EventMetadata,\n ScheduleTimeFrameUpdatedEnvelope,\n GetScheduleTimeFrameOptions,\n ListScheduleTimeFramesOptions,\n} from './calendar-v3-schedule-time-frame-schedule-time-frames.universal.js';\n"],"mappings":";AAAA,SAAS,2CAAAA,gDAA+C;AACxD,SAAS,wCAAAC,6CAA4C;AACrD,SAAS,kBAAAC,uBAAsB;AAC/B,SAAS,uBAAmC;;;ACH5C,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,mEACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,qBACd,SAC4B;AAC5B,WAAS,uBAAuB,EAAE,KAAK,GAAQ;AAC7C,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,mEAAmE;AAAA,QACtE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACC,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,gDAAgD;AAAA,YACxD,EAAE,MAAM,6CAA6C;AAAA,YACrD,EAAE,MAAM,wDAAwD;AAAA,YAChE,EAAE,MAAM,qDAAqD;AAAA,UAC/D;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAQO,SAAS,uBACd,SAC4B;AAC5B,WAAS,yBAAyB,EAAE,KAAK,GAAQ;AAC/C,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,mEAAmE;AAAA,QACtE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,iDAAiD;AAAA,YACzD,EAAE,MAAM,8CAA8C;AAAA,YACtD;AAAA,cACE,MAAM;AAAA,YACR;AAAA,YACA,EAAE,MAAM,sDAAsD;AAAA,UAChE;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADxDO,IAAK,SAAL,kBAAKC,YAAL;AACL,EAAAA,QAAA,oBAAiB;AAEjB,EAAAA,QAAA,UAAO;AAEP,EAAAA,QAAA,YAAS;AAET,EAAAA,QAAA,cAAW;AAPD,SAAAA;AAAA,GAAA;AAqOL,IAAK,gBAAL,kBAAKC,mBAAL;AACL,EAAAA,eAAA,YAAS;AACT,EAAAA,eAAA,WAAQ;AACR,EAAAA,eAAA,aAAU;AAHA,SAAAA;AAAA,GAAA;AAwDL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,aAAU;AACV,EAAAA,WAAA,eAAY;AACZ,EAAAA,WAAA,cAAW;AACX,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,cAAW;AACX,EAAAA,WAAA,YAAS;AAPC,SAAAA;AAAA,GAAA;AA8DL,IAAK,mBAAL,kBAAKC,sBAAL;AACL,EAAAA,kBAAA,iBAAc;AACd,EAAAA,kBAAA,eAAY;AACZ,EAAAA,kBAAA,kBAAe;AAHL,SAAAA;AAAA,GAAA;AA4ML,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AA2IZ,eAAsBC,sBACpB,KACA,SAGA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD,IAAI;AAAA,IACJ,UAAU,SAAS;AAAA,EACrB,CAAC;AAED,QAAM,UACqC,qBAAqB,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI,GACtD;AAAA,EACN,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,IAAI,QAAQ,UAAU,gBAAgB;AAAA,QAClE,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,OAAO,SAAS;AAAA,IACnB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAiDA,eAAsBC,wBACpB,KACA,SAQA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,IACA,UAAU,SAAS;AAAA,EACrB,CAAC;AAED,QAAM,UACqC,uBAAuB,OAAO;AAEzE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,KAAK,QAAQ,UAAU,gBAAgB;AAAA,QACnE,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,OAAO,SAAS;AAAA,IACnB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;ADh3BO,SAASC,sBACd,YAC+B;AAC/B,SAAO,CAAC,KAAa,YACnBA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAeO,SAASC,wBACd,YACiC;AACjC,SAAO,CAAC,KAAe,YACrBA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAmBO,IAAM,6BAA6B;AAAA,EACxC;AAAA,EACA;AAAA,EACA,CAAC,UACCC;AAAA,IACEC,gBAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAaC;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,qCAAqC;AAAA,UAC7C,EAAE,MAAM,kCAAkC;AAAA,UAC1C,EAAE,MAAM,6CAA6C;AAAA,UACrD,EAAE,MAAM,0CAA0C;AAAA,UAClD,EAAE,MAAM,qBAAqB;AAAA,QAC/B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAAoC;;;AGpFpC,SAAS,wBAAwB;AACjC,SAAS,yBAAyB;AAQ3B,IAAMC,wBAGK,iCAAiBA,qBAA0B;AACtD,IAAMC,0BAGK,iCAAiBA,uBAA4B;AAMxD,IAAMC,8BAET,kBAAkB,0BAAgC;","names":["renameKeysFromRESTResponseToSDKResponse","transformRESTTimestampToSDKTimestamp","transformPaths","payload","Status","PlacementType","DayOfWeek","ResolutionMethod","WebhookIdentityType","getScheduleTimeFrame","listScheduleTimeFrames","getScheduleTimeFrame","listScheduleTimeFrames","renameKeysFromRESTResponseToSDKResponse","transformPaths","transformRESTTimestampToSDKTimestamp","getScheduleTimeFrame","listScheduleTimeFrames","onScheduleTimeFrameUpdated"]}
@@ -1,11 +1,10 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
1
  /**
3
2
  * Information about the start and end dates of the first and last
4
3
  * [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
5
4
  * that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
6
5
  * and whether any events follow an unlimited repetition pattern.
7
6
  */
8
- export interface ScheduleTimeFrame {
7
+ interface ScheduleTimeFrame {
9
8
  /**
10
9
  * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
11
10
  * to which the time frame belongs.
@@ -61,7 +60,7 @@ export interface ScheduleTimeFrame {
61
60
  */
62
61
  revision?: string | null;
63
62
  }
64
- export declare enum Status {
63
+ declare enum Status {
65
64
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
66
65
  /** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */
67
66
  NONE = "NONE",
@@ -71,9 +70,9 @@ export declare enum Status {
71
70
  INFINITE = "INFINITE"
72
71
  }
73
72
  /** @enumType */
74
- export type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'NONE' | 'FINITE' | 'INFINITE';
73
+ type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'NONE' | 'FINITE' | 'INFINITE';
75
74
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
76
- export interface ZonedDate {
75
+ interface ZonedDate {
77
76
  /**
78
77
  * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
79
78
  * For example, `2024-01-30T13:30:00`.
@@ -96,7 +95,7 @@ export interface ZonedDate {
96
95
  */
97
96
  utcDate?: Date | null;
98
97
  }
99
- export interface GetScheduleTimeFrameRequest {
98
+ interface GetScheduleTimeFrameRequest {
100
99
  /**
101
100
  * [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
102
101
  * ID for which to retrieve the schedule time frame.
@@ -110,11 +109,11 @@ export interface GetScheduleTimeFrameRequest {
110
109
  */
111
110
  timeZone?: string | null;
112
111
  }
113
- export interface GetScheduleTimeFrameResponse {
112
+ interface GetScheduleTimeFrameResponse {
114
113
  /** Retrieved schedule time frame. */
115
114
  scheduleTimeFrame?: ScheduleTimeFrame;
116
115
  }
117
- export interface ListScheduleTimeFramesRequest {
116
+ interface ListScheduleTimeFramesRequest {
118
117
  /**
119
118
  * IDs of the schedules for which to retrieve schedule time frames.
120
119
  *
@@ -132,12 +131,12 @@ export interface ListScheduleTimeFramesRequest {
132
131
  */
133
132
  timeZone?: string | null;
134
133
  }
135
- export interface ListScheduleTimeFramesResponse {
134
+ interface ListScheduleTimeFramesResponse {
136
135
  /** Retrieved schedule time frames. */
137
136
  scheduleTimeFrames?: ScheduleTimeFrame[];
138
137
  }
139
138
  /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
140
- export interface SitePropertiesNotification {
139
+ interface SitePropertiesNotification {
141
140
  /** The site ID for which this update notification applies. */
142
141
  metasiteId?: string;
143
142
  /** The actual update event. */
@@ -151,7 +150,7 @@ export interface SitePropertiesNotification {
151
150
  changeContext?: ChangeContext;
152
151
  }
153
152
  /** The actual update event for a particular notification. */
154
- export interface SitePropertiesEvent {
153
+ interface SitePropertiesEvent {
155
154
  /** Version of the site's properties represented by this update. */
156
155
  version?: number;
157
156
  /** Set of properties that were updated - corresponds to the fields in "properties". */
@@ -159,7 +158,7 @@ export interface SitePropertiesEvent {
159
158
  /** Updated properties. */
160
159
  properties?: Properties;
161
160
  }
162
- export interface Properties {
161
+ interface Properties {
163
162
  /** Site categories. */
164
163
  categories?: Categories;
165
164
  /** Site locale. */
@@ -215,7 +214,7 @@ export interface Properties {
215
214
  /** Track clicks analytics. */
216
215
  trackClicksAnalytics?: boolean;
217
216
  }
218
- export interface Categories {
217
+ interface Categories {
219
218
  /** Primary site category. */
220
219
  primary?: string;
221
220
  /**
@@ -226,13 +225,13 @@ export interface Categories {
226
225
  /** Business Term Id */
227
226
  businessTermId?: string | null;
228
227
  }
229
- export interface Locale {
228
+ interface Locale {
230
229
  /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
231
230
  languageCode?: string;
232
231
  /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
233
232
  country?: string;
234
233
  }
235
- export interface Address {
234
+ interface Address {
236
235
  /** Street name. */
237
236
  street?: string;
238
237
  /** City name. */
@@ -264,29 +263,29 @@ export interface Address {
264
263
  * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
265
264
  * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
266
265
  */
267
- export interface AddressHint {
266
+ interface AddressHint {
268
267
  /** Extra text displayed next to, or instead of, the actual address. */
269
268
  text?: string;
270
269
  /** Where the extra text should be displayed. */
271
270
  placement?: PlacementTypeWithLiterals;
272
271
  }
273
272
  /** Where the extra text should be displayed: before, after or instead of the actual address. */
274
- export declare enum PlacementType {
273
+ declare enum PlacementType {
275
274
  BEFORE = "BEFORE",
276
275
  AFTER = "AFTER",
277
276
  REPLACE = "REPLACE"
278
277
  }
279
278
  /** @enumType */
280
- export type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
279
+ type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
281
280
  /** Geocoordinates for a particular address. */
282
- export interface GeoCoordinates {
281
+ interface GeoCoordinates {
283
282
  /** Latitude of the location. Must be between -90 and 90. */
284
283
  latitude?: number;
285
284
  /** Longitude of the location. Must be between -180 and 180. */
286
285
  longitude?: number;
287
286
  }
288
287
  /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
289
- export interface BusinessSchedule {
288
+ interface BusinessSchedule {
290
289
  /**
291
290
  * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
292
291
  * @maxSize 100
@@ -299,7 +298,7 @@ export interface BusinessSchedule {
299
298
  specialHourPeriod?: SpecialHourPeriod[];
300
299
  }
301
300
  /** Weekly recurring time periods when the business is regularly open or the service is available. */
302
- export interface TimePeriod {
301
+ interface TimePeriod {
303
302
  /** Day of the week the period starts on. */
304
303
  openDay?: DayOfWeekWithLiterals;
305
304
  /**
@@ -318,7 +317,7 @@ export interface TimePeriod {
318
317
  closeTime?: string;
319
318
  }
320
319
  /** Enumerates the days of the week. */
321
- export declare enum DayOfWeek {
320
+ declare enum DayOfWeek {
322
321
  MONDAY = "MONDAY",
323
322
  TUESDAY = "TUESDAY",
324
323
  WEDNESDAY = "WEDNESDAY",
@@ -328,9 +327,9 @@ export declare enum DayOfWeek {
328
327
  SUNDAY = "SUNDAY"
329
328
  }
330
329
  /** @enumType */
331
- export type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
330
+ type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
332
331
  /** Exception to the business's regular hours. The business can be open or closed during the exception. */
333
- export interface SpecialHourPeriod {
332
+ interface SpecialHourPeriod {
334
333
  /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
335
334
  startDate?: string;
336
335
  /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
@@ -344,7 +343,7 @@ export interface SpecialHourPeriod {
344
343
  /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
345
344
  comment?: string;
346
345
  }
347
- export interface Multilingual {
346
+ interface Multilingual {
348
347
  /**
349
348
  * Supported languages list.
350
349
  * @maxSize 200
@@ -353,7 +352,7 @@ export interface Multilingual {
353
352
  /** Whether to redirect to user language. */
354
353
  autoRedirect?: boolean;
355
354
  }
356
- export interface SupportedLanguage {
355
+ interface SupportedLanguage {
357
356
  /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
358
357
  languageCode?: string;
359
358
  /** Locale. */
@@ -364,15 +363,17 @@ export interface SupportedLanguage {
364
363
  countryCode?: string;
365
364
  /** How the language will be resolved. For internal use. */
366
365
  resolutionMethod?: ResolutionMethodWithLiterals;
366
+ /** Whether the supported language is the primary language for site visitors. */
367
+ isVisitorPrimary?: boolean | null;
367
368
  }
368
- export declare enum ResolutionMethod {
369
+ declare enum ResolutionMethod {
369
370
  QUERY_PARAM = "QUERY_PARAM",
370
371
  SUBDOMAIN = "SUBDOMAIN",
371
372
  SUBDIRECTORY = "SUBDIRECTORY"
372
373
  }
373
374
  /** @enumType */
374
- export type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
375
- export interface ConsentPolicy {
375
+ type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
376
+ interface ConsentPolicy {
376
377
  /** Whether the site uses cookies that are essential to site operation. Always `true`. */
377
378
  essential?: boolean | null;
378
379
  /** Whether the site uses cookies that affect site performance and other functional measurements. */
@@ -385,7 +386,7 @@ export interface ConsentPolicy {
385
386
  dataToThirdParty?: boolean | null;
386
387
  }
387
388
  /** A single mapping from the MetaSite ID to a particular service. */
388
- export interface Translation {
389
+ interface Translation {
389
390
  /** The service type. */
390
391
  serviceType?: string;
391
392
  /** The application definition ID; this only applies to services of type ThirdPartyApps. */
@@ -393,7 +394,7 @@ export interface Translation {
393
394
  /** The instance ID of the service. */
394
395
  instanceId?: string;
395
396
  }
396
- export interface ChangeContext extends ChangeContextPayloadOneOf {
397
+ interface ChangeContext extends ChangeContextPayloadOneOf {
397
398
  /** Properties were updated. */
398
399
  propertiesChange?: PropertiesChange;
399
400
  /** Default properties were created on site creation. */
@@ -402,7 +403,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
402
403
  siteCloned?: SiteCloned;
403
404
  }
404
405
  /** @oneof */
405
- export interface ChangeContextPayloadOneOf {
406
+ interface ChangeContextPayloadOneOf {
406
407
  /** Properties were updated. */
407
408
  propertiesChange?: PropertiesChange;
408
409
  /** Default properties were created on site creation. */
@@ -410,19 +411,19 @@ export interface ChangeContextPayloadOneOf {
410
411
  /** Properties were cloned on site cloning. */
411
412
  siteCloned?: SiteCloned;
412
413
  }
413
- export interface PropertiesChange {
414
+ interface PropertiesChange {
414
415
  }
415
- export interface SiteCreated {
416
+ interface SiteCreated {
416
417
  /** Origin template site id. */
417
418
  originTemplateId?: string | null;
418
419
  }
419
- export interface SiteCloned {
420
+ interface SiteCloned {
420
421
  /** Origin site id. */
421
422
  originMetaSiteId?: string;
422
423
  }
423
- export interface Empty {
424
+ interface Empty {
424
425
  }
425
- export interface DomainEvent extends DomainEventBodyOneOf {
426
+ interface DomainEvent extends DomainEventBodyOneOf {
426
427
  createdEvent?: EntityCreatedEvent;
427
428
  updatedEvent?: EntityUpdatedEvent;
428
429
  deletedEvent?: EntityDeletedEvent;
@@ -457,19 +458,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
457
458
  entityEventSequence?: string | null;
458
459
  }
459
460
  /** @oneof */
460
- export interface DomainEventBodyOneOf {
461
+ interface DomainEventBodyOneOf {
461
462
  createdEvent?: EntityCreatedEvent;
462
463
  updatedEvent?: EntityUpdatedEvent;
463
464
  deletedEvent?: EntityDeletedEvent;
464
465
  actionEvent?: ActionEvent;
465
466
  }
466
- export interface EntityCreatedEvent {
467
+ interface EntityCreatedEvent {
467
468
  entity?: string;
468
469
  }
469
- export interface RestoreInfo {
470
+ interface RestoreInfo {
470
471
  deletedDate?: Date | null;
471
472
  }
472
- export interface EntityUpdatedEvent {
473
+ interface EntityUpdatedEvent {
473
474
  /**
474
475
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
475
476
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -477,14 +478,14 @@ export interface EntityUpdatedEvent {
477
478
  */
478
479
  currentEntity?: string;
479
480
  }
480
- export interface EntityDeletedEvent {
481
+ interface EntityDeletedEvent {
481
482
  /** Entity that was deleted. */
482
483
  deletedEntity?: string | null;
483
484
  }
484
- export interface ActionEvent {
485
+ interface ActionEvent {
485
486
  body?: string;
486
487
  }
487
- export interface MessageEnvelope {
488
+ interface MessageEnvelope {
488
489
  /**
489
490
  * App instance ID.
490
491
  * @format GUID
@@ -500,7 +501,7 @@ export interface MessageEnvelope {
500
501
  /** Stringify payload. */
501
502
  data?: string;
502
503
  }
503
- export interface IdentificationData extends IdentificationDataIdOneOf {
504
+ interface IdentificationData extends IdentificationDataIdOneOf {
504
505
  /**
505
506
  * ID of a site visitor that has not logged in to the site.
506
507
  * @format GUID
@@ -525,7 +526,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
525
526
  identityType?: WebhookIdentityTypeWithLiterals;
526
527
  }
527
528
  /** @oneof */
528
- export interface IdentificationDataIdOneOf {
529
+ interface IdentificationDataIdOneOf {
529
530
  /**
530
531
  * ID of a site visitor that has not logged in to the site.
531
532
  * @format GUID
@@ -547,7 +548,7 @@ export interface IdentificationDataIdOneOf {
547
548
  */
548
549
  appId?: string;
549
550
  }
550
- export declare enum WebhookIdentityType {
551
+ declare enum WebhookIdentityType {
551
552
  UNKNOWN = "UNKNOWN",
552
553
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
553
554
  MEMBER = "MEMBER",
@@ -555,8 +556,8 @@ export declare enum WebhookIdentityType {
555
556
  APP = "APP"
556
557
  }
557
558
  /** @enumType */
558
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
559
- export interface BaseEventMetadata {
559
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
560
+ interface BaseEventMetadata {
560
561
  /**
561
562
  * App instance ID.
562
563
  * @format GUID
@@ -570,7 +571,7 @@ export interface BaseEventMetadata {
570
571
  /** The identification type and identity data. */
571
572
  identity?: IdentificationData;
572
573
  }
573
- export interface EventMetadata extends BaseEventMetadata {
574
+ interface EventMetadata extends BaseEventMetadata {
574
575
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
575
576
  _id?: string;
576
577
  /**
@@ -600,79 +601,11 @@ export interface EventMetadata extends BaseEventMetadata {
600
601
  */
601
602
  entityEventSequence?: string | null;
602
603
  }
603
- export interface ScheduleTimeFrameUpdatedEnvelope {
604
+ interface ScheduleTimeFrameUpdatedEnvelope {
604
605
  entity: ScheduleTimeFrame;
605
606
  metadata: EventMetadata;
606
607
  }
607
- /**
608
- * Triggered when a schedule's time frame is updated, indicating a new first or
609
- * last event or a change in the recurrence period, such as an extension or
610
- * reduction.
611
- * @permissionScope Read Bookings - Public Data
612
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
613
- * @permissionScope Read Calendar - Including PI
614
- * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
615
- * @permissionScope Manage Calendars
616
- * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
617
- * @permissionScope Manage Bookings
618
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
619
- * @permissionScope Read Bookings - Including Participants
620
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
621
- * @permissionScope Read Bookings - all read permissions
622
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
623
- * @permissionScope Read Bookings Calendar Availability
624
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
625
- * @permissionScope Read Calendar
626
- * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
627
- * @permissionScope Manage Bookings - all permissions
628
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
629
- * @permissionScope Read bookings calendar - including participants
630
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
631
- * @permissionScope Read Bookings Calendar
632
- * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
633
- * @permissionId CALENDAR.SCHEDULE_READ
634
- * @webhook
635
- * @eventType wix.calendar.v3.schedule_time_frame_updated
636
- * @slug updated
637
- */
638
- export declare function onScheduleTimeFrameUpdated(handler: (event: ScheduleTimeFrameUpdatedEnvelope) => void | Promise<void>): void;
639
- type ScheduleTimeFrameNonNullablePaths = `status`;
640
- /**
641
- * Retrieves a schedule time frame by schedule ID.
642
- * @param _id - [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
643
- * ID for which to retrieve the schedule time frame.
644
- * @public
645
- * @requiredField _id
646
- * @permissionId CALENDAR.SCHEDULE_READ
647
- * @permissionScope Read Bookings - Public Data
648
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
649
- * @permissionScope Read Calendar - Including PI
650
- * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
651
- * @permissionScope Manage Calendars
652
- * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
653
- * @permissionScope Manage Bookings
654
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
655
- * @permissionScope Read Bookings - Including Participants
656
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
657
- * @permissionScope Read Bookings - all read permissions
658
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
659
- * @permissionScope Read Bookings Calendar Availability
660
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
661
- * @permissionScope Read Calendar
662
- * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
663
- * @permissionScope Manage Bookings - all permissions
664
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
665
- * @permissionScope Read bookings calendar - including participants
666
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
667
- * @permissionScope Read Bookings Calendar
668
- * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
669
- * @applicableIdentity APP
670
- * @applicableIdentity VISITOR
671
- * @returns Retrieved schedule time frame.
672
- * @fqn wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.GetScheduleTimeFrame
673
- */
674
- export declare function getScheduleTimeFrame(_id: string, options?: GetScheduleTimeFrameOptions): Promise<NonNullablePaths<ScheduleTimeFrame, ScheduleTimeFrameNonNullablePaths>>;
675
- export interface GetScheduleTimeFrameOptions {
608
+ interface GetScheduleTimeFrameOptions {
676
609
  /**
677
610
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
678
611
  *
@@ -680,48 +613,7 @@ export interface GetScheduleTimeFrameOptions {
680
613
  */
681
614
  timeZone?: string | null;
682
615
  }
683
- /**
684
- * Retrieves a list of schedule time frames by schedule IDs.
685
- *
686
- *
687
- * Sorted by schedule ID in ascending order.
688
- * @param ids - IDs of the schedules for which to retrieve schedule time frames.
689
- *
690
- * Min: 1 schedule ID
691
- * Max: 100 schedule IDs
692
- * @public
693
- * @requiredField ids
694
- * @permissionId CALENDAR.SCHEDULE_READ
695
- * @permissionScope Read Bookings - Public Data
696
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
697
- * @permissionScope Read Calendar - Including PI
698
- * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
699
- * @permissionScope Manage Calendars
700
- * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
701
- * @permissionScope Manage Bookings
702
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
703
- * @permissionScope Read Bookings - Including Participants
704
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
705
- * @permissionScope Read Bookings - all read permissions
706
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
707
- * @permissionScope Read Bookings Calendar Availability
708
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
709
- * @permissionScope Read Calendar
710
- * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
711
- * @permissionScope Manage Bookings - all permissions
712
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
713
- * @permissionScope Read bookings calendar - including participants
714
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
715
- * @permissionScope Read Bookings Calendar
716
- * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
717
- * @applicableIdentity APP
718
- * @applicableIdentity VISITOR
719
- * @fqn wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.ListScheduleTimeFrames
720
- */
721
- export declare function listScheduleTimeFrames(ids: string[], options?: ListScheduleTimeFramesOptions): Promise<NonNullablePaths<ListScheduleTimeFramesResponse, {
722
- [P in ScheduleTimeFrameNonNullablePaths]: `scheduleTimeFrames.${number}.${P}`;
723
- }[ScheduleTimeFrameNonNullablePaths]>>;
724
- export interface ListScheduleTimeFramesOptions {
616
+ interface ListScheduleTimeFramesOptions {
725
617
  /**
726
618
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
727
619
  *
@@ -729,4 +621,5 @@ export interface ListScheduleTimeFramesOptions {
729
621
  */
730
622
  timeZone?: string | null;
731
623
  }
732
- export {};
624
+
625
+ export { type Address as A, type BusinessSchedule as B, type Categories as C, DayOfWeek as D, type Empty as E, type EntityDeletedEvent as F, type GetScheduleTimeFrameOptions as G, type ActionEvent as H, type MessageEnvelope as I, type IdentificationData as J, type IdentificationDataIdOneOf as K, type ListScheduleTimeFramesOptions as L, type Multilingual as M, type BaseEventMetadata as N, type EventMetadata as O, PlacementType as P, ResolutionMethod as R, type ScheduleTimeFrame as S, type TimePeriod as T, WebhookIdentityType as W, type ZonedDate as Z, type ListScheduleTimeFramesResponse as a, type ScheduleTimeFrameUpdatedEnvelope as b, Status as c, type GetScheduleTimeFrameRequest as d, type GetScheduleTimeFrameResponse as e, type ListScheduleTimeFramesRequest as f, type SitePropertiesNotification as g, type SitePropertiesEvent as h, type Properties as i, type Locale as j, type AddressHint as k, type GeoCoordinates as l, type SpecialHourPeriod as m, type SupportedLanguage as n, type ConsentPolicy as o, type Translation as p, type ChangeContext as q, type ChangeContextPayloadOneOf as r, type PropertiesChange as s, type SiteCreated as t, type SiteCloned as u, type DomainEvent as v, type DomainEventBodyOneOf as w, type EntityCreatedEvent as x, type RestoreInfo as y, type EntityUpdatedEvent as z };