@wix/auto_sdk_calendar_schedules 1.0.45 → 1.0.47

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 (121) hide show
  1. package/build/{internal/cjs/src/calendar-v3-schedule-schedules.universal.d.ts → cjs/calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.ts} +129 -415
  2. package/build/cjs/index.d.ts +108 -1
  3. package/build/cjs/index.js +700 -15
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/meta.d.ts +497 -1
  6. package/build/cjs/meta.js +328 -15
  7. package/build/cjs/meta.js.map +1 -1
  8. package/build/{cjs/src/calendar-v3-schedule-schedules.universal.d.ts → es/calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.mts} +129 -415
  9. package/build/es/index.d.mts +108 -0
  10. package/build/es/index.mjs +656 -0
  11. package/build/es/index.mjs.map +1 -0
  12. package/build/es/meta.d.mts +497 -0
  13. package/build/es/meta.mjs +300 -0
  14. package/build/es/meta.mjs.map +1 -0
  15. package/build/internal/{es/src/calendar-v3-schedule-schedules.universal.d.ts → cjs/calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.ts} +129 -415
  16. package/build/internal/cjs/index.d.ts +108 -1
  17. package/build/internal/cjs/index.js +700 -15
  18. package/build/internal/cjs/index.js.map +1 -1
  19. package/build/internal/cjs/meta.d.ts +497 -1
  20. package/build/internal/cjs/meta.js +328 -15
  21. package/build/internal/cjs/meta.js.map +1 -1
  22. package/build/{es/src/calendar-v3-schedule-schedules.universal.d.ts → internal/es/calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.mts} +129 -415
  23. package/build/internal/es/index.d.mts +108 -0
  24. package/build/internal/es/index.mjs +656 -0
  25. package/build/internal/es/index.mjs.map +1 -0
  26. package/build/internal/es/meta.d.mts +497 -0
  27. package/build/internal/es/meta.mjs +300 -0
  28. package/build/internal/es/meta.mjs.map +1 -0
  29. package/package.json +9 -8
  30. package/build/cjs/index.typings.d.ts +0 -1
  31. package/build/cjs/index.typings.js +0 -18
  32. package/build/cjs/index.typings.js.map +0 -1
  33. package/build/cjs/src/calendar-v3-schedule-schedules.context.d.ts +0 -30
  34. package/build/cjs/src/calendar-v3-schedule-schedules.context.js +0 -48
  35. package/build/cjs/src/calendar-v3-schedule-schedules.context.js.map +0 -1
  36. package/build/cjs/src/calendar-v3-schedule-schedules.http.d.ts +0 -53
  37. package/build/cjs/src/calendar-v3-schedule-schedules.http.js +0 -255
  38. package/build/cjs/src/calendar-v3-schedule-schedules.http.js.map +0 -1
  39. package/build/cjs/src/calendar-v3-schedule-schedules.meta.d.ts +0 -23
  40. package/build/cjs/src/calendar-v3-schedule-schedules.meta.js +0 -123
  41. package/build/cjs/src/calendar-v3-schedule-schedules.meta.js.map +0 -1
  42. package/build/cjs/src/calendar-v3-schedule-schedules.public.d.ts +0 -86
  43. package/build/cjs/src/calendar-v3-schedule-schedules.public.js +0 -96
  44. package/build/cjs/src/calendar-v3-schedule-schedules.public.js.map +0 -1
  45. package/build/cjs/src/calendar-v3-schedule-schedules.types.d.ts +0 -1414
  46. package/build/cjs/src/calendar-v3-schedule-schedules.types.js +0 -208
  47. package/build/cjs/src/calendar-v3-schedule-schedules.types.js.map +0 -1
  48. package/build/cjs/src/calendar-v3-schedule-schedules.universal.js +0 -579
  49. package/build/cjs/src/calendar-v3-schedule-schedules.universal.js.map +0 -1
  50. package/build/es/index.d.ts +0 -1
  51. package/build/es/index.js +0 -2
  52. package/build/es/index.js.map +0 -1
  53. package/build/es/index.typings.d.ts +0 -1
  54. package/build/es/index.typings.js +0 -2
  55. package/build/es/index.typings.js.map +0 -1
  56. package/build/es/meta.d.ts +0 -1
  57. package/build/es/meta.js +0 -2
  58. package/build/es/meta.js.map +0 -1
  59. package/build/es/src/calendar-v3-schedule-schedules.context.d.ts +0 -30
  60. package/build/es/src/calendar-v3-schedule-schedules.context.js +0 -30
  61. package/build/es/src/calendar-v3-schedule-schedules.context.js.map +0 -1
  62. package/build/es/src/calendar-v3-schedule-schedules.http.d.ts +0 -53
  63. package/build/es/src/calendar-v3-schedule-schedules.http.js +0 -247
  64. package/build/es/src/calendar-v3-schedule-schedules.http.js.map +0 -1
  65. package/build/es/src/calendar-v3-schedule-schedules.meta.d.ts +0 -23
  66. package/build/es/src/calendar-v3-schedule-schedules.meta.js +0 -92
  67. package/build/es/src/calendar-v3-schedule-schedules.meta.js.map +0 -1
  68. package/build/es/src/calendar-v3-schedule-schedules.public.d.ts +0 -86
  69. package/build/es/src/calendar-v3-schedule-schedules.public.js +0 -73
  70. package/build/es/src/calendar-v3-schedule-schedules.public.js.map +0 -1
  71. package/build/es/src/calendar-v3-schedule-schedules.types.d.ts +0 -1414
  72. package/build/es/src/calendar-v3-schedule-schedules.types.js +0 -205
  73. package/build/es/src/calendar-v3-schedule-schedules.types.js.map +0 -1
  74. package/build/es/src/calendar-v3-schedule-schedules.universal.js +0 -548
  75. package/build/es/src/calendar-v3-schedule-schedules.universal.js.map +0 -1
  76. package/build/internal/cjs/index.typings.d.ts +0 -1
  77. package/build/internal/cjs/index.typings.js +0 -18
  78. package/build/internal/cjs/index.typings.js.map +0 -1
  79. package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.d.ts +0 -30
  80. package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.js +0 -48
  81. package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.js.map +0 -1
  82. package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.d.ts +0 -53
  83. package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.js +0 -255
  84. package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.js.map +0 -1
  85. package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.d.ts +0 -23
  86. package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.js +0 -123
  87. package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.js.map +0 -1
  88. package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.d.ts +0 -86
  89. package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.js +0 -96
  90. package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.js.map +0 -1
  91. package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.d.ts +0 -1414
  92. package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js +0 -208
  93. package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js.map +0 -1
  94. package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js +0 -579
  95. package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js.map +0 -1
  96. package/build/internal/es/index.d.ts +0 -1
  97. package/build/internal/es/index.js +0 -2
  98. package/build/internal/es/index.js.map +0 -1
  99. package/build/internal/es/index.typings.d.ts +0 -1
  100. package/build/internal/es/index.typings.js +0 -2
  101. package/build/internal/es/index.typings.js.map +0 -1
  102. package/build/internal/es/meta.d.ts +0 -1
  103. package/build/internal/es/meta.js +0 -2
  104. package/build/internal/es/meta.js.map +0 -1
  105. package/build/internal/es/src/calendar-v3-schedule-schedules.context.d.ts +0 -30
  106. package/build/internal/es/src/calendar-v3-schedule-schedules.context.js +0 -30
  107. package/build/internal/es/src/calendar-v3-schedule-schedules.context.js.map +0 -1
  108. package/build/internal/es/src/calendar-v3-schedule-schedules.http.d.ts +0 -53
  109. package/build/internal/es/src/calendar-v3-schedule-schedules.http.js +0 -247
  110. package/build/internal/es/src/calendar-v3-schedule-schedules.http.js.map +0 -1
  111. package/build/internal/es/src/calendar-v3-schedule-schedules.meta.d.ts +0 -23
  112. package/build/internal/es/src/calendar-v3-schedule-schedules.meta.js +0 -92
  113. package/build/internal/es/src/calendar-v3-schedule-schedules.meta.js.map +0 -1
  114. package/build/internal/es/src/calendar-v3-schedule-schedules.public.d.ts +0 -86
  115. package/build/internal/es/src/calendar-v3-schedule-schedules.public.js +0 -73
  116. package/build/internal/es/src/calendar-v3-schedule-schedules.public.js.map +0 -1
  117. package/build/internal/es/src/calendar-v3-schedule-schedules.types.d.ts +0 -1414
  118. package/build/internal/es/src/calendar-v3-schedule-schedules.types.js +0 -205
  119. package/build/internal/es/src/calendar-v3-schedule-schedules.types.js.map +0 -1
  120. package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js +0 -548
  121. package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js.map +0 -1
@@ -1,1414 +0,0 @@
1
- /**
2
- * A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3
- * associated with a specific entity, such as a
4
- * [Bookings service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object),
5
- * or [Bookings resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
6
- * Schedules can also serve as templates for the events they manage, setting
7
- * default values like a default location.
8
- */
9
- export interface Schedule {
10
- /**
11
- * Schedule ID.
12
- * @format GUID
13
- * @readonly
14
- */
15
- id?: string | null;
16
- /**
17
- * External ID. You can't update the external ID.
18
- *
19
- * If the schedule belongs to a Bookings staff member, identical to the ID of
20
- * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
21
- * If the schedule belongs to a Bookings service, identical to the ID of
22
- * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
23
- * @format GUID
24
- * @immutable
25
- */
26
- externalId?: string | null;
27
- /**
28
- * Schedule name.
29
- *
30
- * Min: 1 character
31
- * Max: 200 characters
32
- * @minLength 1
33
- * @maxLength 200
34
- */
35
- name?: string | null;
36
- /**
37
- * Schedule status.
38
- *
39
- * Supported values:
40
- * - `ACTIVE`: You can add events to the schedule or update its fields.
41
- * - `CANCELLED`: You can't add events to the schedule or update its fields.
42
- *
43
- * Default: `ACTIVE`
44
- * @readonly
45
- */
46
- status?: StatusWithLiterals;
47
- /**
48
- * Time zone the schedule is associated with in
49
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
50
- * For example, `America/New_York`.
51
- *
52
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
53
- *
54
- * Min: 1 character
55
- * Max: 150 characters
56
- * @minLength 1
57
- * @maxLength 150
58
- */
59
- timeZone?: string | null;
60
- /**
61
- * Whether the schedule's `timeZone` is automatically synced from
62
- * `timeZone` of the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
63
- *
64
- * Default: `true`
65
- */
66
- businessTimeZoneEnabled?: boolean | null;
67
- /**
68
- * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
69
- * that are added to the schedule.
70
- *
71
- * Min: 1 character
72
- * Max: 200 characters
73
- * @minLength 1
74
- * @maxLength 200
75
- */
76
- defaultTitle?: string | null;
77
- /**
78
- * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
79
- * that are added to the schedule.
80
- */
81
- defaultLocation?: Location;
82
- /**
83
- * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
84
- * that are added to the schedule.
85
- *
86
- * Min: `0`
87
- */
88
- defaultCapacity?: number | null;
89
- /**
90
- * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
91
- * that are added to the schedule.
92
- * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
93
- */
94
- defaultConferencingDetails?: ConferencingDetails;
95
- /**
96
- * ID of the app that's associated with the schedule. You can't update `appId`.
97
- * If you want to create a schedule and ensure its associated events appear
98
- * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
99
- * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
100
- * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
101
- * @format GUID
102
- * @immutable
103
- */
104
- appId?: string | null;
105
- /**
106
- * List of permissions associated with the schedule. Refer to the
107
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
108
- * for more information.
109
- *
110
- * Max: 1 permission
111
- * @maxSize 1
112
- */
113
- permissions?: Permission[];
114
- /** Extensions enabling applications or users to save custom data related to the schedule. */
115
- extendedFields?: ExtendedFields;
116
- /**
117
- * Revision number, which increments by 1 each time the schedule is updated.
118
- * To prevent conflicting changes, the current revision must be passed when updating the schedule.
119
- * Ignored when creating a schedule.
120
- * @readonly
121
- */
122
- revision?: string | null;
123
- /**
124
- * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
125
- * @readonly
126
- */
127
- createdDate?: Date | null;
128
- /**
129
- * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
130
- * @readonly
131
- */
132
- updatedDate?: Date | null;
133
- }
134
- export declare enum Status {
135
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
136
- /** You can add events to the schedule or update its fields. */
137
- ACTIVE = "ACTIVE",
138
- /** You can't add events to the schedule or update its fields. */
139
- CANCELLED = "CANCELLED"
140
- }
141
- /** @enumType */
142
- export type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'CANCELLED';
143
- export interface Location {
144
- /**
145
- * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
146
- * ID. Available only for `BUSINESS` locations.
147
- * @format GUID
148
- */
149
- id?: string | null;
150
- /**
151
- * Location type.
152
- *
153
- * Supported values:
154
- * + `BUSINESS`: The event is held at a business location.
155
- * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
156
- * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
157
- */
158
- type?: LocationTypeWithLiterals;
159
- /**
160
- * Location name. For `BUSINESS` locations, it's identical to the
161
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
162
- * `name`.
163
- *
164
- * Min: 1 character
165
- * Max: 150 characters
166
- * @minLength 1
167
- * @maxLength 150
168
- */
169
- name?: string | null;
170
- /**
171
- * Location address. For `BUSINESS` locations, it's identical to the
172
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
173
- * `formattedAddress`.
174
- * @minLength 1
175
- * @maxLength 300
176
- */
177
- address?: string | null;
178
- }
179
- export declare enum LocationType {
180
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
181
- /** The event is held at a business location. */
182
- BUSINESS = "BUSINESS",
183
- /** The event is held at the customer's location, such as their home or office. */
184
- CUSTOMER = "CUSTOMER",
185
- /** The event is held at an address or venue not tied to the business or customer. */
186
- CUSTOM = "CUSTOM"
187
- }
188
- /** @enumType */
189
- export type LocationTypeWithLiterals = LocationType | 'UNKNOWN_TYPE' | 'BUSINESS' | 'CUSTOMER' | 'CUSTOM';
190
- export interface ConferencingDetails {
191
- /** Conference type. For example, `Zoom`. */
192
- type?: TypeWithLiterals;
193
- /**
194
- * URL used by the host to start the conference.
195
- *
196
- * Min: 1 character
197
- * Max: 2000 characters
198
- * @minLength 1
199
- * @maxLength 2000
200
- */
201
- hostUrl?: string | null;
202
- /**
203
- * URL used by a guest to join the conference.
204
- *
205
- * Min: 1 character
206
- * Max: 2000 characters
207
- * @minLength 1
208
- * @maxLength 2000
209
- */
210
- guestUrl?: string | null;
211
- /**
212
- * Conference password.
213
- *
214
- * Min: 1 character
215
- * Max: 100 characters
216
- * @minLength 1
217
- * @maxLength 100
218
- */
219
- password?: string | null;
220
- /**
221
- * Conference ID in an external system.
222
- *
223
- * Min: 1 character
224
- * Max: 150 characters
225
- * @minLength 1
226
- * @maxLength 150
227
- */
228
- externalId?: string | null;
229
- }
230
- export declare enum Type {
231
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
232
- ZOOM = "ZOOM",
233
- CUSTOM = "CUSTOM"
234
- }
235
- /** @enumType */
236
- export type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'ZOOM' | 'CUSTOM';
237
- export interface Permission {
238
- /**
239
- * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
240
- * granted the permission.
241
- */
242
- identity?: CommonIdentificationData;
243
- /**
244
- * Permission role.
245
- *
246
- * Supported values:
247
- * + `WRITER`: Full read and write access.
248
- * + `COMMENTER`: Full read access, write access limited to `event.notes`.
249
- */
250
- role?: RoleWithLiterals;
251
- }
252
- export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
253
- /**
254
- * ID of a Wix user. For example, the site owner or a
255
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
256
- * @format GUID
257
- */
258
- wixUserId?: string;
259
- }
260
- /** @oneof */
261
- export interface CommonIdentificationDataIdOneOf {
262
- /**
263
- * ID of a Wix user. For example, the site owner or a
264
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
265
- * @format GUID
266
- */
267
- wixUserId?: string;
268
- }
269
- export declare enum IdentityType {
270
- UNKNOWN = "UNKNOWN",
271
- WIX_USER = "WIX_USER"
272
- }
273
- /** @enumType */
274
- export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'WIX_USER';
275
- export declare enum Role {
276
- UNKNOWN_ROLE = "UNKNOWN_ROLE",
277
- /** Full read and write access. */
278
- WRITER = "WRITER",
279
- /** Full read access, write access limited to `event.notes`. */
280
- COMMENTER = "COMMENTER"
281
- }
282
- /** @enumType */
283
- export type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'WRITER' | 'COMMENTER';
284
- export interface ExtendedFields {
285
- /**
286
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
287
- * The value of each key is structured according to the schema defined when the extended fields were configured.
288
- *
289
- * You can only access fields for which you have the appropriate permissions.
290
- *
291
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
292
- */
293
- namespaces?: Record<string, Record<string, any>>;
294
- }
295
- export interface GetScheduleRequest {
296
- /**
297
- * ID of the schedule to retrieve.
298
- * @format GUID
299
- */
300
- scheduleId: string | null;
301
- /**
302
- * Information about which fields containing personal data to return. Refer to the
303
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
304
- * for more information.
305
- *
306
- * Supported values:
307
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
308
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
309
- *
310
- * Max: 1 field
311
- * Default: No personal data is returned.
312
- * @maxSize 1
313
- */
314
- fields?: RequestedFieldsWithLiterals[];
315
- }
316
- export declare enum RequestedFields {
317
- UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
318
- /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
319
- PI_FIELDS = "PI_FIELDS",
320
- /** Returns only fields containing your own personal data. */
321
- OWN_PI_FIELDS = "OWN_PI_FIELDS"
322
- }
323
- /** @enumType */
324
- export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELDS' | 'PI_FIELDS' | 'OWN_PI_FIELDS';
325
- export interface GetScheduleResponse {
326
- /** Retrieved schedule. */
327
- schedule?: Schedule;
328
- }
329
- export interface QuerySchedulesRequest {
330
- /** Query containing filters and paging. */
331
- query?: CursorQuery;
332
- /**
333
- * Information about which fields containing personal data to return. Refer to the
334
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
335
- * for more information.
336
- *
337
- * Supported values:
338
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
339
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
340
- *
341
- * Max: 1 field
342
- * Default: No personal data is returned.
343
- * @maxSize 1
344
- */
345
- fields?: RequestedFieldsWithLiterals[];
346
- }
347
- /** TODO Diverge */
348
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
349
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
350
- cursorPaging?: CursorPaging;
351
- /**
352
- * Filter object.
353
- * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
354
- * for more information.
355
- *
356
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
357
- *
358
- * For a detailed list of supported filters, see Supported Filters.
359
- */
360
- filter?: Record<string, any> | null;
361
- }
362
- /** @oneof */
363
- export interface CursorQueryPagingMethodOneOf {
364
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
365
- cursorPaging?: CursorPaging;
366
- }
367
- /** TODO Diverge */
368
- export interface CursorPaging {
369
- /**
370
- * Number of schedules to return.
371
- *
372
- * Min: `1`
373
- * Max: `100`
374
- * Default: `50`
375
- * @min 1
376
- * @max 100
377
- */
378
- limit?: number | null;
379
- /**
380
- * Pointer to the next or previous page in the list of results.
381
- *
382
- * You can get the relevant cursor token
383
- * from the `pagingMetadata` object in the previous call's response.
384
- * Not relevant for the first request.
385
- */
386
- cursor?: string | null;
387
- }
388
- export interface QuerySchedulesResponse {
389
- /** Retrieved schedules matching the provided query. */
390
- schedules?: Schedule[];
391
- /** Paging metadata. */
392
- pagingMetadata?: CursorPagingMetadata;
393
- }
394
- /** TODO Diverge */
395
- export interface CursorPagingMetadata {
396
- /** Number of schedules returned in the current page of the response. */
397
- count?: number | null;
398
- /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
399
- cursors?: Cursors;
400
- /**
401
- * Indicates if there are more results after the current page.
402
- * If `true`, another page of results can be retrieved.
403
- * If `false`, this is the last page.
404
- */
405
- hasNext?: boolean | null;
406
- }
407
- export interface Cursors {
408
- /** Cursor pointing to next page in the list of results. */
409
- next?: string | null;
410
- /** Cursor pointing to previous page in the list of results. */
411
- prev?: string | null;
412
- }
413
- export interface CreateScheduleRequest {
414
- /** Schedule to create. */
415
- schedule: Schedule;
416
- /**
417
- * Idempotency key guaranteeing that you don't create the same schedule more
418
- * than once.
419
- * @format GUID
420
- */
421
- idempotencyKey?: string | null;
422
- }
423
- export interface CreateScheduleResponse {
424
- /** Created schedule. */
425
- schedule?: Schedule;
426
- }
427
- export interface UpdateScheduleRequest {
428
- /** Schedule to update. */
429
- schedule: Schedule;
430
- /**
431
- * Information about whether participants of the schedule's updated events are
432
- * notified and the message they receive.
433
- */
434
- participantNotification?: ParticipantNotification;
435
- }
436
- export interface ParticipantNotification {
437
- /**
438
- * Whether to notify the participants about changes made to the schedule or event.
439
- *
440
- * Default: `false`
441
- */
442
- notifyParticipants?: boolean | null;
443
- /**
444
- * Message to send.
445
- *
446
- * Min: 1 character
447
- * Max: 5000 characters
448
- * @minLength 1
449
- * @maxLength 5000
450
- */
451
- message?: string | null;
452
- }
453
- export interface UpdateScheduleResponse {
454
- /** Updated schedule. */
455
- schedule?: Schedule;
456
- }
457
- /** `PRIVATE` until we'll have standard events metadata from Infra. */
458
- export interface ScheduleUpdatedWithMetadata {
459
- /** The updated schedule. */
460
- schedule?: Schedule;
461
- /** Whether to notify participants regarding the changes. */
462
- participantNotification?: ParticipantNotification;
463
- }
464
- export interface CloneScheduleRequest {
465
- /**
466
- * ID of the schedule to clone.
467
- * @format GUID
468
- */
469
- scheduleId?: string | null;
470
- /** Fields to override in the cloned schedule. */
471
- schedule?: Schedule;
472
- }
473
- export interface CloneScheduleResponse {
474
- /** Cloned schedule. */
475
- schedule?: Schedule;
476
- }
477
- export interface ScheduleCloned {
478
- /** New cloned schedule. */
479
- schedule?: Schedule;
480
- /** The clone trigger. */
481
- trigger?: TriggerWithLiterals;
482
- /**
483
- * The original Meta Site ID if different.
484
- * @format GUID
485
- */
486
- originalMetaSiteId?: string | null;
487
- /**
488
- * The original schedule ID if different.
489
- * @format GUID
490
- */
491
- originalScheduleId?: string | null;
492
- }
493
- export declare enum Trigger {
494
- /** Schedule cloned using the `CloneSchedule` API. */
495
- SCHEDULE_CLONED = "SCHEDULE_CLONED",
496
- /** Site duplicated from the same account. */
497
- SITE_DUPLICATED_FROM_SAME_ACCOUNT = "SITE_DUPLICATED_FROM_SAME_ACCOUNT",
498
- /** Site duplicated from a different account. */
499
- SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT = "SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT",
500
- /** Site created from template. */
501
- SITE_CREATED_FROM_TEMPLATE = "SITE_CREATED_FROM_TEMPLATE",
502
- /** Other. */
503
- OTHER = "OTHER"
504
- }
505
- /** @enumType */
506
- export type TriggerWithLiterals = Trigger | 'SCHEDULE_CLONED' | 'SITE_DUPLICATED_FROM_SAME_ACCOUNT' | 'SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT' | 'SITE_CREATED_FROM_TEMPLATE' | 'OTHER';
507
- export interface CancelScheduleRequest {
508
- /**
509
- * ID of the schedule to cancel.
510
- * @format GUID
511
- */
512
- scheduleId: string | null;
513
- /**
514
- * Whether to preserve future events with participants.
515
- * Default: `false`.
516
- */
517
- preserveFutureEventsWithParticipants?: boolean | null;
518
- /**
519
- * Information about whether participants of the schedule's updated events are
520
- * notified and the message they receive.
521
- */
522
- participantNotification?: ParticipantNotification;
523
- }
524
- export interface CancelScheduleResponse {
525
- /** Canceled schedule. */
526
- schedule?: Schedule;
527
- }
528
- export interface ScheduleCancelled {
529
- /** Canceled schedule. */
530
- schedule?: Schedule;
531
- /** Whether future events with participants were preserved. */
532
- preserveFutureEventsWithParticipants?: boolean | null;
533
- }
534
- export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
535
- /** Emitted on a meta site creation. */
536
- siteCreated?: SiteCreated;
537
- /** Emitted on a meta site transfer completion. */
538
- siteTransferred?: SiteTransferred;
539
- /** Emitted on a meta site deletion. */
540
- siteDeleted?: SiteDeleted;
541
- /** Emitted on a meta site restoration. */
542
- siteUndeleted?: SiteUndeleted;
543
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
544
- sitePublished?: SitePublished;
545
- /** Emitted on a meta site unpublish. */
546
- siteUnpublished?: SiteUnpublished;
547
- /** Emitted when meta site is marked as template. */
548
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
549
- /** Emitted when meta site is marked as a WixSite. */
550
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
551
- /** Emitted when an application is provisioned (installed). */
552
- serviceProvisioned?: ServiceProvisioned;
553
- /** Emitted when an application is removed (uninstalled). */
554
- serviceRemoved?: ServiceRemoved;
555
- /** Emitted when meta site name (URL slug) is changed. */
556
- siteRenamedPayload?: SiteRenamed;
557
- /** Emitted when meta site was permanently deleted. */
558
- hardDeleted?: SiteHardDeleted;
559
- /** Emitted on a namespace change. */
560
- namespaceChanged?: NamespaceChanged;
561
- /** Emitted when Studio is attached. */
562
- studioAssigned?: StudioAssigned;
563
- /** Emitted when Studio is detached. */
564
- studioUnassigned?: StudioUnassigned;
565
- /**
566
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
567
- * the actual URL.
568
- *
569
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
570
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
571
- */
572
- urlChanged?: SiteUrlChanged;
573
- /** Site is marked as PurgedExternally */
574
- sitePurgedExternally?: SitePurgedExternally;
575
- /** Emitted when Odeditor is attached. */
576
- odeditorAssigned?: OdeditorAssigned;
577
- /** Emitted when Odeditor is detached. */
578
- odeditorUnassigned?: OdeditorUnassigned;
579
- /** Emitted when Picasso is attached. */
580
- picassoAssigned?: PicassoAssigned;
581
- /** Emitted when Picasso is detached. */
582
- picassoUnassigned?: PicassoUnassigned;
583
- /**
584
- * A meta site id.
585
- * @format GUID
586
- */
587
- metaSiteId?: string;
588
- /** A meta site version. Monotonically increasing. */
589
- version?: string;
590
- /** A timestamp of the event. */
591
- timestamp?: string;
592
- /**
593
- * TODO(meta-site): Change validation once validations are disabled for consumers
594
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
595
- * @maxSize 4000
596
- */
597
- assets?: Asset[];
598
- }
599
- /** @oneof */
600
- export interface MetaSiteSpecialEventPayloadOneOf {
601
- /** Emitted on a meta site creation. */
602
- siteCreated?: SiteCreated;
603
- /** Emitted on a meta site transfer completion. */
604
- siteTransferred?: SiteTransferred;
605
- /** Emitted on a meta site deletion. */
606
- siteDeleted?: SiteDeleted;
607
- /** Emitted on a meta site restoration. */
608
- siteUndeleted?: SiteUndeleted;
609
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
610
- sitePublished?: SitePublished;
611
- /** Emitted on a meta site unpublish. */
612
- siteUnpublished?: SiteUnpublished;
613
- /** Emitted when meta site is marked as template. */
614
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
615
- /** Emitted when meta site is marked as a WixSite. */
616
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
617
- /** Emitted when an application is provisioned (installed). */
618
- serviceProvisioned?: ServiceProvisioned;
619
- /** Emitted when an application is removed (uninstalled). */
620
- serviceRemoved?: ServiceRemoved;
621
- /** Emitted when meta site name (URL slug) is changed. */
622
- siteRenamedPayload?: SiteRenamed;
623
- /** Emitted when meta site was permanently deleted. */
624
- hardDeleted?: SiteHardDeleted;
625
- /** Emitted on a namespace change. */
626
- namespaceChanged?: NamespaceChanged;
627
- /** Emitted when Studio is attached. */
628
- studioAssigned?: StudioAssigned;
629
- /** Emitted when Studio is detached. */
630
- studioUnassigned?: StudioUnassigned;
631
- /**
632
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
633
- * the actual URL.
634
- *
635
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
636
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
637
- */
638
- urlChanged?: SiteUrlChanged;
639
- /** Site is marked as PurgedExternally */
640
- sitePurgedExternally?: SitePurgedExternally;
641
- /** Emitted when Odeditor is attached. */
642
- odeditorAssigned?: OdeditorAssigned;
643
- /** Emitted when Odeditor is detached. */
644
- odeditorUnassigned?: OdeditorUnassigned;
645
- /** Emitted when Picasso is attached. */
646
- picassoAssigned?: PicassoAssigned;
647
- /** Emitted when Picasso is detached. */
648
- picassoUnassigned?: PicassoUnassigned;
649
- }
650
- export interface Asset {
651
- /**
652
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
653
- * @maxLength 36
654
- */
655
- appDefId?: string;
656
- /**
657
- * An instance id. For legacy reasons may be UUID or a string.
658
- * @maxLength 200
659
- */
660
- instanceId?: string;
661
- /** An application state. */
662
- state?: StateWithLiterals;
663
- }
664
- export declare enum State {
665
- UNKNOWN = "UNKNOWN",
666
- ENABLED = "ENABLED",
667
- DISABLED = "DISABLED",
668
- PENDING = "PENDING",
669
- DEMO = "DEMO"
670
- }
671
- /** @enumType */
672
- export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
673
- export interface SiteCreated {
674
- /**
675
- * A template identifier (empty if not created from a template).
676
- * @maxLength 36
677
- */
678
- originTemplateId?: string;
679
- /**
680
- * An account id of the owner.
681
- * @format GUID
682
- */
683
- ownerId?: string;
684
- /** A context in which meta site was created. */
685
- context?: SiteCreatedContextWithLiterals;
686
- /**
687
- * A meta site id from which this site was created.
688
- *
689
- * In case of a creation from a template it's a template id.
690
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
691
- * @format GUID
692
- */
693
- originMetaSiteId?: string | null;
694
- /**
695
- * A meta site name (URL slug).
696
- * @maxLength 20
697
- */
698
- siteName?: string;
699
- /** A namespace. */
700
- namespace?: NamespaceWithLiterals;
701
- }
702
- export declare enum SiteCreatedContext {
703
- /** A valid option, we don't expose all reasons why site might be created. */
704
- OTHER = "OTHER",
705
- /** A meta site was created from template. */
706
- FROM_TEMPLATE = "FROM_TEMPLATE",
707
- /** A meta site was created by copying of the transfferred meta site. */
708
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
709
- /** A copy of existing meta site. */
710
- DUPLICATE = "DUPLICATE",
711
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
712
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
713
- /** deprecated A meta site was created for Flash editor. */
714
- FLASH = "FLASH"
715
- }
716
- /** @enumType */
717
- export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
718
- export declare enum Namespace {
719
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
720
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
721
- WIX = "WIX",
722
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
723
- SHOUT_OUT = "SHOUT_OUT",
724
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
725
- ALBUMS = "ALBUMS",
726
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
727
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
728
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
729
- HOTELS = "HOTELS",
730
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
731
- CLUBS = "CLUBS",
732
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
733
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
734
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
735
- DEV_SITE = "DEV_SITE",
736
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
737
- LOGOS = "LOGOS",
738
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
739
- VIDEO_MAKER = "VIDEO_MAKER",
740
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
741
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
742
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
743
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
744
- /**
745
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
746
- *
747
- * Meta site with this namespace will *not* be shown in a user's site list by default.
748
- */
749
- HTML_DRAFT = "HTML_DRAFT",
750
- /**
751
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
752
- * Will be accessible from Site List and will not have a website app.
753
- * Once the user attaches a site, the site will become a regular wixsite.
754
- */
755
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
756
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
757
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
758
- /** It is to be used in the Business First efforts. */
759
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
760
- /** Bookings business flow with no site. */
761
- ANYWHERE = "ANYWHERE",
762
- /** Namespace for Headless Backoffice with no editor */
763
- HEADLESS = "HEADLESS",
764
- /**
765
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
766
- * The site will be used for account level CSM feature for enterprise
767
- */
768
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
769
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
770
- RISE = "RISE",
771
- /**
772
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
773
- * There's a blank site behind the scene but it's blank).
774
- * The Mobile company will be the owner of this namespace.
775
- */
776
- BRANDED_FIRST = "BRANDED_FIRST",
777
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
778
- NOWNIA = "NOWNIA",
779
- /**
780
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
781
- * The Partners company owns this namespace.
782
- */
783
- UGC_TEMPLATE = "UGC_TEMPLATE",
784
- /** Codux Headless Sites */
785
- CODUX = "CODUX",
786
- /** Bobb - AI Design Creator. */
787
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
788
- /**
789
- * Shared Blog Site is a unique single site across Enterprise account,
790
- * This site will hold all Blog posts related to the Marketing product.
791
- */
792
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
793
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
794
- STANDALONE_FORMS = "STANDALONE_FORMS",
795
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
796
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
797
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
798
- MIMIR = "MIMIR"
799
- }
800
- /** @enumType */
801
- export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
802
- /** Site transferred to another user. */
803
- export interface SiteTransferred {
804
- /**
805
- * A previous owner id (user that transfers meta site).
806
- * @format GUID
807
- */
808
- oldOwnerId?: string;
809
- /**
810
- * A new owner id (user that accepts meta site).
811
- * @format GUID
812
- */
813
- newOwnerId?: string;
814
- }
815
- /** Soft deletion of the meta site. Could be restored. */
816
- export interface SiteDeleted {
817
- /** A deletion context. */
818
- deleteContext?: DeleteContext;
819
- }
820
- export interface DeleteContext {
821
- /** When the meta site was deleted. */
822
- dateDeleted?: Date | null;
823
- /** A status. */
824
- deleteStatus?: DeleteStatusWithLiterals;
825
- /**
826
- * A reason (flow).
827
- * @maxLength 255
828
- */
829
- deleteOrigin?: string;
830
- /**
831
- * A service that deleted it.
832
- * @maxLength 255
833
- */
834
- initiatorId?: string | null;
835
- }
836
- export declare enum DeleteStatus {
837
- UNKNOWN = "UNKNOWN",
838
- TRASH = "TRASH",
839
- DELETED = "DELETED",
840
- PENDING_PURGE = "PENDING_PURGE",
841
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
842
- }
843
- /** @enumType */
844
- export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
845
- /** Restoration of the meta site. */
846
- export interface SiteUndeleted {
847
- }
848
- /** First publish of a meta site. Or subsequent publish after unpublish. */
849
- export interface SitePublished {
850
- }
851
- export interface SiteUnpublished {
852
- /**
853
- * A list of URLs previously associated with the meta site.
854
- * @maxLength 4000
855
- * @maxSize 10000
856
- */
857
- urls?: string[];
858
- }
859
- export interface SiteMarkedAsTemplate {
860
- }
861
- export interface SiteMarkedAsWixSite {
862
- }
863
- /**
864
- * Represents a service provisioned a site.
865
- *
866
- * Note on `origin_instance_id`:
867
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
868
- * This is because of the following scenario:
869
- *
870
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
871
- * such as a product catalog. When you create a site from this template, you inherit this
872
- * default product catalog. However, if the template's product catalog is modified,
873
- * your site will retain the catalog as it was at the time of site creation. This ensures that
874
- * your site remains consistent with what you initially received and does not include any
875
- * changes made to the original template afterward.
876
- * To ensure this, the TPA on the template gets a new instance_id.
877
- */
878
- export interface ServiceProvisioned {
879
- /**
880
- * Either UUID or EmbeddedServiceType.
881
- * @maxLength 36
882
- */
883
- appDefId?: string;
884
- /**
885
- * Not only UUID. Something here could be something weird.
886
- * @maxLength 36
887
- */
888
- instanceId?: string;
889
- /**
890
- * An instance id from which this instance is originated.
891
- * @maxLength 36
892
- */
893
- originInstanceId?: string;
894
- /**
895
- * A version.
896
- * @maxLength 500
897
- */
898
- version?: string | null;
899
- /**
900
- * The origin meta site id
901
- * @format GUID
902
- */
903
- originMetaSiteId?: string | null;
904
- }
905
- export interface ServiceRemoved {
906
- /**
907
- * Either UUID or EmbeddedServiceType.
908
- * @maxLength 36
909
- */
910
- appDefId?: string;
911
- /**
912
- * Not only UUID. Something here could be something weird.
913
- * @maxLength 36
914
- */
915
- instanceId?: string;
916
- /**
917
- * A version.
918
- * @maxLength 500
919
- */
920
- version?: string | null;
921
- }
922
- /** Rename of the site. Meaning, free public url has been changed as well. */
923
- export interface SiteRenamed {
924
- /**
925
- * A new meta site name (URL slug).
926
- * @maxLength 20
927
- */
928
- newSiteName?: string;
929
- /**
930
- * A previous meta site name (URL slug).
931
- * @maxLength 255
932
- */
933
- oldSiteName?: string;
934
- }
935
- /**
936
- * Hard deletion of the meta site.
937
- *
938
- * Could not be restored. Therefore it's desirable to cleanup data.
939
- */
940
- export interface SiteHardDeleted {
941
- /** A deletion context. */
942
- deleteContext?: DeleteContext;
943
- }
944
- export interface NamespaceChanged {
945
- /** A previous namespace. */
946
- oldNamespace?: NamespaceWithLiterals;
947
- /** A new namespace. */
948
- newNamespace?: NamespaceWithLiterals;
949
- }
950
- /** Assigned Studio editor */
951
- export interface StudioAssigned {
952
- }
953
- /** Unassigned Studio editor */
954
- export interface StudioUnassigned {
955
- }
956
- /**
957
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
958
- *
959
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
960
- * with sites and its urls, you need to listen to another topic/event. Read about it:
961
- *
962
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
963
- */
964
- export interface SiteUrlChanged {
965
- }
966
- /**
967
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
968
- * Consumed by other teams to remove relevant data.
969
- */
970
- export interface SitePurgedExternally {
971
- /**
972
- * @maxLength 2048
973
- * @maxSize 100
974
- * @deprecated
975
- * @targetRemovalDate 2025-04-15
976
- */
977
- appDefId?: string[];
978
- }
979
- /** Assigned Odeditor */
980
- export interface OdeditorAssigned {
981
- }
982
- /** Unassigned Odeditor */
983
- export interface OdeditorUnassigned {
984
- }
985
- /** Assigned Picasso editor */
986
- export interface PicassoAssigned {
987
- }
988
- /** Unassigned Picasso */
989
- export interface PicassoUnassigned {
990
- }
991
- export interface Empty {
992
- }
993
- /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
994
- export interface SitePropertiesNotification {
995
- /** The site ID for which this update notification applies. */
996
- metasiteId?: string;
997
- /** The actual update event. */
998
- event?: SitePropertiesEvent;
999
- /**
1000
- * A convenience set of mappings from the MetaSite ID to its constituent services.
1001
- * @maxSize 500
1002
- */
1003
- translations?: Translation[];
1004
- /** Context of the notification */
1005
- changeContext?: ChangeContext;
1006
- }
1007
- /** The actual update event for a particular notification. */
1008
- export interface SitePropertiesEvent {
1009
- /** Version of the site's properties represented by this update. */
1010
- version?: number;
1011
- /** Set of properties that were updated - corresponds to the fields in "properties". */
1012
- fields?: string[];
1013
- /** Updated properties. */
1014
- properties?: Properties;
1015
- }
1016
- export interface Properties {
1017
- /** Site categories. */
1018
- categories?: Categories;
1019
- /** Site locale. */
1020
- locale?: Locale;
1021
- /**
1022
- * Site language.
1023
- *
1024
- * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1025
- */
1026
- language?: string | null;
1027
- /**
1028
- * Site currency format used to bill customers.
1029
- *
1030
- * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1031
- */
1032
- paymentCurrency?: string | null;
1033
- /** Timezone in `America/New_York` format. */
1034
- timeZone?: string | null;
1035
- /** Email address. */
1036
- email?: string | null;
1037
- /** Phone number. */
1038
- phone?: string | null;
1039
- /** Fax number. */
1040
- fax?: string | null;
1041
- /** Address. */
1042
- address?: Address;
1043
- /** Site display name. */
1044
- siteDisplayName?: string | null;
1045
- /** Business name. */
1046
- businessName?: string | null;
1047
- /** Path to the site's logo in Wix Media (without Wix Media base URL). */
1048
- logo?: string | null;
1049
- /** Site description. */
1050
- description?: string | null;
1051
- /**
1052
- * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
1053
- *
1054
- * __Note:__ Not supported by Wix Bookings.
1055
- */
1056
- businessSchedule?: BusinessSchedule;
1057
- /** Supported languages of a site and the primary language. */
1058
- multilingual?: Multilingual;
1059
- /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
1060
- consentPolicy?: ConsentPolicy;
1061
- /**
1062
- * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
1063
- *
1064
- * Site business type.
1065
- */
1066
- businessConfig?: string | null;
1067
- /** External site URL that uses Wix as its headless business solution. */
1068
- externalSiteUrl?: string | null;
1069
- /** Track clicks analytics. */
1070
- trackClicksAnalytics?: boolean;
1071
- }
1072
- export interface Categories {
1073
- /** Primary site category. */
1074
- primary?: string;
1075
- /**
1076
- * Secondary site category.
1077
- * @maxSize 50
1078
- */
1079
- secondary?: string[];
1080
- /** Business Term Id */
1081
- businessTermId?: string | null;
1082
- }
1083
- export interface Locale {
1084
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1085
- languageCode?: string;
1086
- /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
1087
- country?: string;
1088
- }
1089
- export interface Address {
1090
- /** Street name. */
1091
- street?: string;
1092
- /** City name. */
1093
- city?: string;
1094
- /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
1095
- country?: string;
1096
- /** State. */
1097
- state?: string;
1098
- /**
1099
- * Zip or postal code.
1100
- * @maxLength 20
1101
- */
1102
- zip?: string;
1103
- /** Extra information to be displayed in the address. */
1104
- hint?: AddressHint;
1105
- /** Whether this address represents a physical location. */
1106
- isPhysical?: boolean;
1107
- /** Google-formatted version of this address. */
1108
- googleFormattedAddress?: string;
1109
- /** Street number. */
1110
- streetNumber?: string;
1111
- /** Apartment number. */
1112
- apartmentNumber?: string;
1113
- /** Geographic coordinates of location. */
1114
- coordinates?: GeoCoordinates;
1115
- }
1116
- /**
1117
- * Extra information on displayed addresses.
1118
- * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
1119
- * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
1120
- */
1121
- export interface AddressHint {
1122
- /** Extra text displayed next to, or instead of, the actual address. */
1123
- text?: string;
1124
- /** Where the extra text should be displayed. */
1125
- placement?: PlacementTypeWithLiterals;
1126
- }
1127
- /** Where the extra text should be displayed: before, after or instead of the actual address. */
1128
- export declare enum PlacementType {
1129
- BEFORE = "BEFORE",
1130
- AFTER = "AFTER",
1131
- REPLACE = "REPLACE"
1132
- }
1133
- /** @enumType */
1134
- export type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
1135
- /** Geocoordinates for a particular address. */
1136
- export interface GeoCoordinates {
1137
- /** Latitude of the location. Must be between -90 and 90. */
1138
- latitude?: number;
1139
- /** Longitude of the location. Must be between -180 and 180. */
1140
- longitude?: number;
1141
- }
1142
- /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
1143
- export interface BusinessSchedule {
1144
- /**
1145
- * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
1146
- * @maxSize 100
1147
- */
1148
- periods?: TimePeriod[];
1149
- /**
1150
- * Exceptions to the business's regular hours. The business can be open or closed during the exception.
1151
- * @maxSize 100
1152
- */
1153
- specialHourPeriod?: SpecialHourPeriod[];
1154
- }
1155
- /** Weekly recurring time periods when the business is regularly open or the service is available. */
1156
- export interface TimePeriod {
1157
- /** Day of the week the period starts on. */
1158
- openDay?: DayOfWeekWithLiterals;
1159
- /**
1160
- * 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
1161
- * midnight at the end of the specified day.
1162
- */
1163
- openTime?: string;
1164
- /** Day of the week the period ends on. */
1165
- closeDay?: DayOfWeekWithLiterals;
1166
- /**
1167
- * 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
1168
- * midnight at the end of the specified day.
1169
- *
1170
- * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
1171
- */
1172
- closeTime?: string;
1173
- }
1174
- /** Enumerates the days of the week. */
1175
- export declare enum DayOfWeek {
1176
- MONDAY = "MONDAY",
1177
- TUESDAY = "TUESDAY",
1178
- WEDNESDAY = "WEDNESDAY",
1179
- THURSDAY = "THURSDAY",
1180
- FRIDAY = "FRIDAY",
1181
- SATURDAY = "SATURDAY",
1182
- SUNDAY = "SUNDAY"
1183
- }
1184
- /** @enumType */
1185
- export type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
1186
- /** Exception to the business's regular hours. The business can be open or closed during the exception. */
1187
- export interface SpecialHourPeriod {
1188
- /** 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). */
1189
- startDate?: string;
1190
- /** 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). */
1191
- endDate?: string;
1192
- /**
1193
- * Whether the business is closed (or the service is not available) during the exception.
1194
- *
1195
- * Default: `true`.
1196
- */
1197
- isClosed?: boolean;
1198
- /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
1199
- comment?: string;
1200
- }
1201
- export interface Multilingual {
1202
- /**
1203
- * Supported languages list.
1204
- * @maxSize 200
1205
- */
1206
- supportedLanguages?: SupportedLanguage[];
1207
- /** Whether to redirect to user language. */
1208
- autoRedirect?: boolean;
1209
- }
1210
- export interface SupportedLanguage {
1211
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1212
- languageCode?: string;
1213
- /** Locale. */
1214
- locale?: Locale;
1215
- /** Whether the supported language is the primary language for the site. */
1216
- isPrimary?: boolean;
1217
- /** Language icon. */
1218
- countryCode?: string;
1219
- /** How the language will be resolved. For internal use. */
1220
- resolutionMethod?: ResolutionMethodWithLiterals;
1221
- /** Whether the supported language is the primary language for site visitors. */
1222
- isVisitorPrimary?: boolean | null;
1223
- }
1224
- export declare enum ResolutionMethod {
1225
- QUERY_PARAM = "QUERY_PARAM",
1226
- SUBDOMAIN = "SUBDOMAIN",
1227
- SUBDIRECTORY = "SUBDIRECTORY"
1228
- }
1229
- /** @enumType */
1230
- export type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
1231
- export interface ConsentPolicy {
1232
- /** Whether the site uses cookies that are essential to site operation. Always `true`. */
1233
- essential?: boolean | null;
1234
- /** Whether the site uses cookies that affect site performance and other functional measurements. */
1235
- functional?: boolean | null;
1236
- /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
1237
- analytics?: boolean | null;
1238
- /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
1239
- advertising?: boolean | null;
1240
- /** CCPA compliance flag. */
1241
- dataToThirdParty?: boolean | null;
1242
- }
1243
- /** A single mapping from the MetaSite ID to a particular service. */
1244
- export interface Translation {
1245
- /** The service type. */
1246
- serviceType?: string;
1247
- /** The application definition ID; this only applies to services of type ThirdPartyApps. */
1248
- appDefId?: string;
1249
- /** The instance ID of the service. */
1250
- instanceId?: string;
1251
- }
1252
- export interface ChangeContext extends ChangeContextPayloadOneOf {
1253
- /** Properties were updated. */
1254
- propertiesChange?: PropertiesChange;
1255
- /** Default properties were created on site creation. */
1256
- siteCreated?: V4SiteCreated;
1257
- /** Properties were cloned on site cloning. */
1258
- siteCloned?: SiteCloned;
1259
- }
1260
- /** @oneof */
1261
- export interface ChangeContextPayloadOneOf {
1262
- /** Properties were updated. */
1263
- propertiesChange?: PropertiesChange;
1264
- /** Default properties were created on site creation. */
1265
- siteCreated?: V4SiteCreated;
1266
- /** Properties were cloned on site cloning. */
1267
- siteCloned?: SiteCloned;
1268
- }
1269
- export interface PropertiesChange {
1270
- }
1271
- export interface V4SiteCreated {
1272
- /** Origin template site id. */
1273
- originTemplateId?: string | null;
1274
- }
1275
- export interface SiteCloned {
1276
- /** Origin site id. */
1277
- originMetaSiteId?: string;
1278
- }
1279
- export interface DomainEvent extends DomainEventBodyOneOf {
1280
- createdEvent?: EntityCreatedEvent;
1281
- updatedEvent?: EntityUpdatedEvent;
1282
- deletedEvent?: EntityDeletedEvent;
1283
- actionEvent?: ActionEvent;
1284
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1285
- id?: string;
1286
- /**
1287
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1288
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1289
- */
1290
- entityFqdn?: string;
1291
- /**
1292
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
1293
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1294
- */
1295
- slug?: string;
1296
- /** ID of the entity associated with the event. */
1297
- entityId?: string;
1298
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1299
- eventTime?: Date | null;
1300
- /**
1301
- * Whether the event was triggered as a result of a privacy regulation application
1302
- * (for example, GDPR).
1303
- */
1304
- triggeredByAnonymizeRequest?: boolean | null;
1305
- /** If present, indicates the action that triggered the event. */
1306
- originatedFrom?: string | null;
1307
- /**
1308
- * 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.
1309
- * 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.
1310
- */
1311
- entityEventSequence?: string | null;
1312
- }
1313
- /** @oneof */
1314
- export interface DomainEventBodyOneOf {
1315
- createdEvent?: EntityCreatedEvent;
1316
- updatedEvent?: EntityUpdatedEvent;
1317
- deletedEvent?: EntityDeletedEvent;
1318
- actionEvent?: ActionEvent;
1319
- }
1320
- export interface EntityCreatedEvent {
1321
- entityAsJson?: string;
1322
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1323
- restoreInfo?: RestoreInfo;
1324
- }
1325
- export interface RestoreInfo {
1326
- deletedDate?: Date | null;
1327
- }
1328
- export interface EntityUpdatedEvent {
1329
- /**
1330
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1331
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1332
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1333
- */
1334
- currentEntityAsJson?: string;
1335
- }
1336
- export interface EntityDeletedEvent {
1337
- /** Entity that was deleted. */
1338
- deletedEntityAsJson?: string | null;
1339
- }
1340
- export interface ActionEvent {
1341
- bodyAsJson?: string;
1342
- }
1343
- export interface MessageEnvelope {
1344
- /**
1345
- * App instance ID.
1346
- * @format GUID
1347
- */
1348
- instanceId?: string | null;
1349
- /**
1350
- * Event type.
1351
- * @maxLength 150
1352
- */
1353
- eventType?: string;
1354
- /** The identification type and identity data. */
1355
- identity?: IdentificationData;
1356
- /** Stringify payload. */
1357
- data?: string;
1358
- }
1359
- export interface IdentificationData extends IdentificationDataIdOneOf {
1360
- /**
1361
- * ID of a site visitor that has not logged in to the site.
1362
- * @format GUID
1363
- */
1364
- anonymousVisitorId?: string;
1365
- /**
1366
- * ID of a site visitor that has logged in to the site.
1367
- * @format GUID
1368
- */
1369
- memberId?: string;
1370
- /**
1371
- * ID of a Wix user (site owner, contributor, etc.).
1372
- * @format GUID
1373
- */
1374
- wixUserId?: string;
1375
- /**
1376
- * ID of an app.
1377
- * @format GUID
1378
- */
1379
- appId?: string;
1380
- /** @readonly */
1381
- identityType?: WebhookIdentityTypeWithLiterals;
1382
- }
1383
- /** @oneof */
1384
- export interface IdentificationDataIdOneOf {
1385
- /**
1386
- * ID of a site visitor that has not logged in to the site.
1387
- * @format GUID
1388
- */
1389
- anonymousVisitorId?: string;
1390
- /**
1391
- * ID of a site visitor that has logged in to the site.
1392
- * @format GUID
1393
- */
1394
- memberId?: string;
1395
- /**
1396
- * ID of a Wix user (site owner, contributor, etc.).
1397
- * @format GUID
1398
- */
1399
- wixUserId?: string;
1400
- /**
1401
- * ID of an app.
1402
- * @format GUID
1403
- */
1404
- appId?: string;
1405
- }
1406
- export declare enum WebhookIdentityType {
1407
- UNKNOWN = "UNKNOWN",
1408
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1409
- MEMBER = "MEMBER",
1410
- WIX_USER = "WIX_USER",
1411
- APP = "APP"
1412
- }
1413
- /** @enumType */
1414
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';