@wix/auto_sdk_bookings_attendance 1.0.14 → 1.0.15

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 (129) hide show
  1. package/build/{es/src/bookings-v2-attendance-attendance.types.d.ts → bookings-v2-attendance-attendance.universal-BKW7diO6.d.mts} +125 -48
  2. package/build/{cjs/src/bookings-v2-attendance-attendance.types.d.ts → bookings-v2-attendance-attendance.universal-BKW7diO6.d.ts} +125 -48
  3. package/build/{internal/cjs/src/bookings-v2-attendance-attendance.public.d.ts → index.d.mts} +15 -10
  4. package/build/{cjs/src/bookings-v2-attendance-attendance.public.d.ts → index.d.ts} +15 -10
  5. package/build/index.js +461 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +431 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/bookings-v2-attendance-attendance.types.d.ts → bookings-v2-attendance-attendance.universal-BKW7diO6.d.mts} +125 -48
  10. package/build/internal/{es/src/bookings-v2-attendance-attendance.types.d.ts → bookings-v2-attendance-attendance.universal-BKW7diO6.d.ts} +125 -48
  11. package/build/internal/{es/src/bookings-v2-attendance-attendance.public.d.ts → index.d.mts} +15 -10
  12. package/build/{es/src/bookings-v2-attendance-attendance.public.d.ts → internal/index.d.ts} +15 -10
  13. package/build/internal/index.js +461 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +431 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +259 -0
  18. package/build/internal/meta.d.ts +259 -0
  19. package/build/internal/meta.js +339 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +309 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +259 -0
  24. package/build/meta.d.ts +259 -0
  25. package/build/meta.js +339 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +309 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  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/bookings-v2-attendance-attendance.context.d.ts +0 -8
  40. package/build/cjs/src/bookings-v2-attendance-attendance.context.js +0 -14
  41. package/build/cjs/src/bookings-v2-attendance-attendance.context.js.map +0 -1
  42. package/build/cjs/src/bookings-v2-attendance-attendance.http.d.ts +0 -58
  43. package/build/cjs/src/bookings-v2-attendance-attendance.http.js +0 -288
  44. package/build/cjs/src/bookings-v2-attendance-attendance.http.js.map +0 -1
  45. package/build/cjs/src/bookings-v2-attendance-attendance.meta.d.ts +0 -18
  46. package/build/cjs/src/bookings-v2-attendance-attendance.meta.js +0 -104
  47. package/build/cjs/src/bookings-v2-attendance-attendance.meta.js.map +0 -1
  48. package/build/cjs/src/bookings-v2-attendance-attendance.public.js +0 -34
  49. package/build/cjs/src/bookings-v2-attendance-attendance.public.js.map +0 -1
  50. package/build/cjs/src/bookings-v2-attendance-attendance.types.js +0 -31
  51. package/build/cjs/src/bookings-v2-attendance-attendance.types.js.map +0 -1
  52. package/build/cjs/src/bookings-v2-attendance-attendance.universal.d.ts +0 -590
  53. package/build/cjs/src/bookings-v2-attendance-attendance.universal.js +0 -302
  54. package/build/cjs/src/bookings-v2-attendance-attendance.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/src/bookings-v2-attendance-attendance.context.d.ts +0 -8
  65. package/build/es/src/bookings-v2-attendance-attendance.context.js +0 -8
  66. package/build/es/src/bookings-v2-attendance-attendance.context.js.map +0 -1
  67. package/build/es/src/bookings-v2-attendance-attendance.http.d.ts +0 -58
  68. package/build/es/src/bookings-v2-attendance-attendance.http.js +0 -281
  69. package/build/es/src/bookings-v2-attendance-attendance.http.js.map +0 -1
  70. package/build/es/src/bookings-v2-attendance-attendance.meta.d.ts +0 -18
  71. package/build/es/src/bookings-v2-attendance-attendance.meta.js +0 -74
  72. package/build/es/src/bookings-v2-attendance-attendance.meta.js.map +0 -1
  73. package/build/es/src/bookings-v2-attendance-attendance.public.js +0 -24
  74. package/build/es/src/bookings-v2-attendance-attendance.public.js.map +0 -1
  75. package/build/es/src/bookings-v2-attendance-attendance.types.js +0 -28
  76. package/build/es/src/bookings-v2-attendance-attendance.types.js.map +0 -1
  77. package/build/es/src/bookings-v2-attendance-attendance.universal.d.ts +0 -590
  78. package/build/es/src/bookings-v2-attendance-attendance.universal.js +0 -272
  79. package/build/es/src/bookings-v2-attendance-attendance.universal.js.map +0 -1
  80. package/build/internal/cjs/index.d.ts +0 -1
  81. package/build/internal/cjs/index.js +0 -18
  82. package/build/internal/cjs/index.js.map +0 -1
  83. package/build/internal/cjs/index.typings.d.ts +0 -1
  84. package/build/internal/cjs/index.typings.js +0 -18
  85. package/build/internal/cjs/index.typings.js.map +0 -1
  86. package/build/internal/cjs/meta.d.ts +0 -1
  87. package/build/internal/cjs/meta.js +0 -18
  88. package/build/internal/cjs/meta.js.map +0 -1
  89. package/build/internal/cjs/src/bookings-v2-attendance-attendance.context.d.ts +0 -8
  90. package/build/internal/cjs/src/bookings-v2-attendance-attendance.context.js +0 -14
  91. package/build/internal/cjs/src/bookings-v2-attendance-attendance.context.js.map +0 -1
  92. package/build/internal/cjs/src/bookings-v2-attendance-attendance.http.d.ts +0 -58
  93. package/build/internal/cjs/src/bookings-v2-attendance-attendance.http.js +0 -288
  94. package/build/internal/cjs/src/bookings-v2-attendance-attendance.http.js.map +0 -1
  95. package/build/internal/cjs/src/bookings-v2-attendance-attendance.meta.d.ts +0 -18
  96. package/build/internal/cjs/src/bookings-v2-attendance-attendance.meta.js +0 -104
  97. package/build/internal/cjs/src/bookings-v2-attendance-attendance.meta.js.map +0 -1
  98. package/build/internal/cjs/src/bookings-v2-attendance-attendance.public.js +0 -34
  99. package/build/internal/cjs/src/bookings-v2-attendance-attendance.public.js.map +0 -1
  100. package/build/internal/cjs/src/bookings-v2-attendance-attendance.types.js +0 -31
  101. package/build/internal/cjs/src/bookings-v2-attendance-attendance.types.js.map +0 -1
  102. package/build/internal/cjs/src/bookings-v2-attendance-attendance.universal.d.ts +0 -590
  103. package/build/internal/cjs/src/bookings-v2-attendance-attendance.universal.js +0 -302
  104. package/build/internal/cjs/src/bookings-v2-attendance-attendance.universal.js.map +0 -1
  105. package/build/internal/es/index.d.ts +0 -1
  106. package/build/internal/es/index.js +0 -2
  107. package/build/internal/es/index.js.map +0 -1
  108. package/build/internal/es/index.typings.d.ts +0 -1
  109. package/build/internal/es/index.typings.js +0 -2
  110. package/build/internal/es/index.typings.js.map +0 -1
  111. package/build/internal/es/meta.d.ts +0 -1
  112. package/build/internal/es/meta.js +0 -2
  113. package/build/internal/es/meta.js.map +0 -1
  114. package/build/internal/es/src/bookings-v2-attendance-attendance.context.d.ts +0 -8
  115. package/build/internal/es/src/bookings-v2-attendance-attendance.context.js +0 -8
  116. package/build/internal/es/src/bookings-v2-attendance-attendance.context.js.map +0 -1
  117. package/build/internal/es/src/bookings-v2-attendance-attendance.http.d.ts +0 -58
  118. package/build/internal/es/src/bookings-v2-attendance-attendance.http.js +0 -281
  119. package/build/internal/es/src/bookings-v2-attendance-attendance.http.js.map +0 -1
  120. package/build/internal/es/src/bookings-v2-attendance-attendance.meta.d.ts +0 -18
  121. package/build/internal/es/src/bookings-v2-attendance-attendance.meta.js +0 -74
  122. package/build/internal/es/src/bookings-v2-attendance-attendance.meta.js.map +0 -1
  123. package/build/internal/es/src/bookings-v2-attendance-attendance.public.js +0 -24
  124. package/build/internal/es/src/bookings-v2-attendance-attendance.public.js.map +0 -1
  125. package/build/internal/es/src/bookings-v2-attendance-attendance.types.js +0 -28
  126. package/build/internal/es/src/bookings-v2-attendance-attendance.types.js.map +0 -1
  127. package/build/internal/es/src/bookings-v2-attendance-attendance.universal.d.ts +0 -590
  128. package/build/internal/es/src/bookings-v2-attendance-attendance.universal.js +0 -272
  129. package/build/internal/es/src/bookings-v2-attendance-attendance.universal.js.map +0 -1
@@ -1,590 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- /**
3
- * The `attendance` object represents the attendance information
4
- * for a booked session, such as:
5
- *
6
- * + Did anyone attend the session?
7
- * + How many people attended the session?
8
- *
9
- * The number of session `attendance` objects available depends on the booking type:
10
- * + Appointment bookings have 1 `attendance` object per appointment session.
11
- * + Class bookings have 1 `attendance` object for each session of the class. The number of sessions for a class is defined in Schedule and Sessions `schedule.capacity` property.
12
- * + Course bookings have an `attendance` object for each session of the course. For example, if there are 12 sessions in a course, there are 12 `attendance` objects. The number of sessions for a class is defined in Schedule and Sessions `schedule.capacity` property.
13
- */
14
- export interface Attendance {
15
- /**
16
- * ID of the `attendance` object.
17
- * @format GUID
18
- * @readonly
19
- */
20
- _id?: string | null;
21
- /**
22
- * Corresponding booking ID.
23
- * @format GUID
24
- */
25
- bookingId?: string | null;
26
- /** Corresponding session ID. */
27
- sessionId?: string | null;
28
- /** Status indicating if any participants attended the session. */
29
- status?: AttendanceStatusWithLiterals;
30
- /**
31
- * Total number of participants that attended the session. By default, the number
32
- * of attendees is set to `1`, but you can set a number to greater than `1` if multiple
33
- * participants attended.
34
- *
35
- * Do not set to `0` to indicate that no one attended the session. Instead, set the `status` field to `NOT_ATTENDED`.
36
- *
37
- * Default: 1
38
- */
39
- numberOfAttendees?: number;
40
- }
41
- export declare enum AttendanceStatus {
42
- /** There is no available attendance information. */
43
- NOT_SET = "NOT_SET",
44
- /** At least a single participant attended the session. */
45
- ATTENDED = "ATTENDED",
46
- /** No participants attended the session. */
47
- NOT_ATTENDED = "NOT_ATTENDED"
48
- }
49
- /** @enumType */
50
- export type AttendanceStatusWithLiterals = AttendanceStatus | 'NOT_SET' | 'ATTENDED' | 'NOT_ATTENDED';
51
- export interface GetAttendanceRequest {
52
- /**
53
- * ID of the attendance object to retrieve.
54
- * @format GUID
55
- */
56
- attendanceId: string;
57
- }
58
- export interface GetAttendanceResponse {
59
- /** Retrieved attendance. */
60
- attendance?: Attendance;
61
- }
62
- export interface SetAttendanceRequest {
63
- /** Attendance to create or update. */
64
- attendance: Attendance;
65
- /** Information about whether to send a message to a customer after their attendance was set. */
66
- participantNotification?: ParticipantNotification;
67
- }
68
- export interface ParticipantNotification {
69
- /**
70
- * Specify whether to send the message about the changes to the customer.
71
- *
72
- * Default: `false`
73
- */
74
- notifyParticipants?: boolean | null;
75
- /**
76
- * Optional custom message to send to the participants about the changes to the booking.
77
- * @minLength 1
78
- * @maxLength 5000
79
- */
80
- message?: string | null;
81
- }
82
- export interface SetAttendanceResponse {
83
- /** Created or updated attendance. */
84
- attendance?: Attendance;
85
- }
86
- export interface AttendanceMarkedAsNotAttended {
87
- /** The attendance information for a booked session that you want to create or update. */
88
- attendance?: Attendance;
89
- /** Information about whether to send a message to a customer after their attendance was set. */
90
- participantNotification?: ParticipantNotification;
91
- }
92
- export interface BulkSetAttendanceRequest {
93
- returnFullEntity?: boolean;
94
- /**
95
- * List of attendance details for booking sessions to create or update.
96
- * @maxSize 8
97
- */
98
- attendanceDetails?: AttendanceDetails[];
99
- }
100
- export interface AttendanceDetails {
101
- /** Created or updated attendance information for a booking session. */
102
- attendance?: Attendance;
103
- /** Information about whether to send a message to the customer after their attendance was set. */
104
- participantNotification?: ParticipantNotification;
105
- }
106
- export interface BulkSetAttendanceResponse {
107
- /**
108
- * List of created or updated `attendance` objects.
109
- * @minSize 1
110
- * @maxSize 8
111
- */
112
- results?: BulkAttendanceResult[];
113
- /** Information about the total number of successes and failures for the Bulk Set Attendance call. */
114
- bulkActionMetadata?: BulkActionMetadata;
115
- }
116
- export interface BulkAttendanceResult {
117
- /** Created or updated `attendance` object. */
118
- item?: Attendance;
119
- /** Metadata for the created or updated `attendance` object. */
120
- itemMetadata?: ItemMetadata;
121
- }
122
- export interface ItemMetadata {
123
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
124
- _id?: string | null;
125
- /** Index of the item within the request array. Allows for correlation between request and response items. */
126
- originalIndex?: number;
127
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
128
- success?: boolean;
129
- /** Details about the error in case of failure. */
130
- error?: ApplicationError;
131
- }
132
- export interface ApplicationError {
133
- /** Error code. */
134
- code?: string;
135
- /** Description of the error. */
136
- description?: string;
137
- /** Data related to the error. */
138
- data?: Record<string, any> | null;
139
- }
140
- export interface BulkActionMetadata {
141
- /** Number of items that were successfully processed. */
142
- totalSuccesses?: number;
143
- /** Number of items that couldn't be processed. */
144
- totalFailures?: number;
145
- /** Number of failures without details because detailed failure threshold was exceeded. */
146
- undetailedFailures?: number;
147
- }
148
- export interface QueryAttendanceRequest {
149
- /** Query options. */
150
- query: QueryV2;
151
- }
152
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
153
- /**
154
- * Cursor token pointing to a page of results. In the first request,
155
- * specify `cursorPaging.limit`. For following requests, specify the
156
- * retrieved `cursorPaging.cursor` token and not `query.filter` or
157
- * `query.sort`.
158
- */
159
- cursorPaging?: CursorPaging;
160
- /**
161
- * Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
162
- *
163
- * For a detailed list of supported fields and operators, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).
164
- *
165
- * Max: 1 filter
166
- */
167
- filter?: Record<string, any> | null;
168
- /**
169
- * Sort object in the following format:
170
- * `[ {"fieldName":"sortField1","order":"ASC"}, {"fieldName":"sortField2","order":"DESC"} ]`
171
- *
172
- * For details about sorting, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).
173
- */
174
- sort?: Sorting[];
175
- }
176
- /** @oneof */
177
- export interface QueryV2PagingMethodOneOf {
178
- /**
179
- * Cursor token pointing to a page of results. In the first request,
180
- * specify `cursorPaging.limit`. For following requests, specify the
181
- * retrieved `cursorPaging.cursor` token and not `query.filter` or
182
- * `query.sort`.
183
- */
184
- cursorPaging?: CursorPaging;
185
- }
186
- export interface Sorting {
187
- /** Name of the field to sort by. */
188
- fieldName?: string;
189
- /** Sort order. */
190
- order?: SortOrderWithLiterals;
191
- }
192
- /**
193
- * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
194
- *
195
- * Default: `ASC`.
196
- */
197
- export declare enum SortOrder {
198
- ASC = "ASC",
199
- DESC = "DESC"
200
- }
201
- /** @enumType */
202
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
203
- export interface Paging {
204
- /** Number of items to load. */
205
- limit?: number | null;
206
- /** Number of items to skip in the current sort order. */
207
- offset?: number | null;
208
- }
209
- export interface CursorPaging {
210
- /**
211
- * Number of `Attendance` objects to return.
212
- *
213
- * Default: `50`
214
- * Maximum: `1000`
215
- * @max 1000
216
- */
217
- limit?: number | null;
218
- /**
219
- * Pointer to the next or previous page in the list of results.
220
- *
221
- * You can get the relevant cursor token
222
- * from the `pagingMetadata` object in the previous call's response.
223
- *
224
- * Not relevant for the first request.
225
- */
226
- cursor?: string | null;
227
- }
228
- /** List of objects that contain attendance information. */
229
- export interface QueryAttendanceResponse {
230
- /** List of `attendance` objects that contain attendance information for a booked session. */
231
- attendances?: Attendance[];
232
- /** Metadata for the paged set of results. */
233
- pagingMetadata?: CursorPagingMetadata;
234
- }
235
- /** This is the preferred message for cursor-paging enabled services */
236
- export interface CursorPagingMetadata {
237
- /** Use these cursors to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
238
- cursors?: Cursors;
239
- /**
240
- * Indicates if there are more results after the current page.
241
- * If `true`, another page of results can be retrieved.
242
- * If `false`, this is the last page.
243
- */
244
- hasNext?: boolean | null;
245
- }
246
- export interface Cursors {
247
- /** Cursor pointing to next page in the list of results. */
248
- next?: string | null;
249
- /** Cursor pointing to previous page in the list of results. */
250
- prev?: string | null;
251
- }
252
- export interface DomainEvent extends DomainEventBodyOneOf {
253
- createdEvent?: EntityCreatedEvent;
254
- updatedEvent?: EntityUpdatedEvent;
255
- deletedEvent?: EntityDeletedEvent;
256
- actionEvent?: ActionEvent;
257
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
258
- _id?: string;
259
- /**
260
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
261
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
262
- */
263
- entityFqdn?: string;
264
- /**
265
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
266
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
267
- */
268
- slug?: string;
269
- /** ID of the entity associated with the event. */
270
- entityId?: string;
271
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
272
- eventTime?: Date | null;
273
- /**
274
- * Whether the event was triggered as a result of a privacy regulation application
275
- * (for example, GDPR).
276
- */
277
- triggeredByAnonymizeRequest?: boolean | null;
278
- /** If present, indicates the action that triggered the event. */
279
- originatedFrom?: string | null;
280
- /**
281
- * 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.
282
- * 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.
283
- */
284
- entityEventSequence?: string | null;
285
- }
286
- /** @oneof */
287
- export interface DomainEventBodyOneOf {
288
- createdEvent?: EntityCreatedEvent;
289
- updatedEvent?: EntityUpdatedEvent;
290
- deletedEvent?: EntityDeletedEvent;
291
- actionEvent?: ActionEvent;
292
- }
293
- export interface EntityCreatedEvent {
294
- entity?: string;
295
- }
296
- export interface RestoreInfo {
297
- deletedDate?: Date | null;
298
- }
299
- export interface EntityUpdatedEvent {
300
- /**
301
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
302
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
303
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
304
- */
305
- currentEntity?: string;
306
- }
307
- export interface EntityDeletedEvent {
308
- /** Entity that was deleted. */
309
- deletedEntity?: string | null;
310
- }
311
- export interface ActionEvent {
312
- body?: string;
313
- }
314
- export interface MessageEnvelope {
315
- /**
316
- * App instance ID.
317
- * @format GUID
318
- */
319
- instanceId?: string | null;
320
- /**
321
- * Event type.
322
- * @maxLength 150
323
- */
324
- eventType?: string;
325
- /** The identification type and identity data. */
326
- identity?: IdentificationData;
327
- /** Stringify payload. */
328
- data?: string;
329
- }
330
- export interface IdentificationData extends IdentificationDataIdOneOf {
331
- /**
332
- * ID of a site visitor that has not logged in to the site.
333
- * @format GUID
334
- */
335
- anonymousVisitorId?: string;
336
- /**
337
- * ID of a site visitor that has logged in to the site.
338
- * @format GUID
339
- */
340
- memberId?: string;
341
- /**
342
- * ID of a Wix user (site owner, contributor, etc.).
343
- * @format GUID
344
- */
345
- wixUserId?: string;
346
- /**
347
- * ID of an app.
348
- * @format GUID
349
- */
350
- appId?: string;
351
- /** @readonly */
352
- identityType?: WebhookIdentityTypeWithLiterals;
353
- }
354
- /** @oneof */
355
- export interface IdentificationDataIdOneOf {
356
- /**
357
- * ID of a site visitor that has not logged in to the site.
358
- * @format GUID
359
- */
360
- anonymousVisitorId?: string;
361
- /**
362
- * ID of a site visitor that has logged in to the site.
363
- * @format GUID
364
- */
365
- memberId?: string;
366
- /**
367
- * ID of a Wix user (site owner, contributor, etc.).
368
- * @format GUID
369
- */
370
- wixUserId?: string;
371
- /**
372
- * ID of an app.
373
- * @format GUID
374
- */
375
- appId?: string;
376
- }
377
- export declare enum WebhookIdentityType {
378
- UNKNOWN = "UNKNOWN",
379
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
380
- MEMBER = "MEMBER",
381
- WIX_USER = "WIX_USER",
382
- APP = "APP"
383
- }
384
- /** @enumType */
385
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
386
- type AttendanceNonNullablePaths = `status` | `numberOfAttendees`;
387
- /**
388
- * Retrieves attendance information.
389
- * @param attendanceId - ID of the attendance object to retrieve.
390
- * @public
391
- * @documentationMaturity preview
392
- * @requiredField attendanceId
393
- * @permissionId BOOKINGS.ATTENDANCE_READ
394
- * @permissionScope Manage Stores
395
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
396
- * @permissionScope Manage Bookings Services and Settings
397
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
398
- * @permissionScope Manage Bookings
399
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
400
- * @permissionScope Read Bookings - Including Participants
401
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
402
- * @permissionScope Read Bookings - all read permissions
403
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
404
- * @permissionScope Manage Bookings - all permissions
405
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
406
- * @applicableIdentity APP
407
- * @applicableIdentity VISITOR
408
- * @returns Retrieved attendance.
409
- * @fqn com.wixpress.bookings.attendance.v2.AttendanceService.GetAttendance
410
- */
411
- export declare function getAttendance(attendanceId: string): Promise<NonNullablePaths<Attendance, AttendanceNonNullablePaths>>;
412
- /**
413
- * Sets or updates attendance information for a booking session. This
414
- * information is stored in an `attendance` object.
415
- *
416
- * If an `attendance` object already exists for the session, it's updated.
417
- * Otherwise, a new object is created.
418
- *
419
- * By default, `numberOfAttendees` is set to `1`, but you can specify a higher
420
- * number if multiple participants attended. Do not set `numberOfAttendees` to
421
- * `0` to indicate no attendance, instead specify `{"status": "NOT_ATTENDED"}`.
422
- *
423
- * Validation guidelines:
424
- *
425
- * + The call succeeds for mismatches between `numberOfAttendees`
426
- * and `status`. For example, make sure that your code doesn't specify
427
- * `{"status": "NOT_ATTENDED"}` with `{"numberOfAttendees": 5}`.
428
- * + The API also allows `numberOfAttendees` to exceed the booking's
429
- * `numberOfParticipants`. Use higher values only when scenarios like
430
- * walk-ins justify the exception.
431
- * @param attendance - Attendance to create or update.
432
- * @public
433
- * @documentationMaturity preview
434
- * @requiredField attendance
435
- * @requiredField attendance.bookingId
436
- * @requiredField attendance.status
437
- * @param options - Options to use when setting an attendance.
438
- * @permissionId BOOKINGS.ATTENDANCE_SET
439
- * @permissionScope Manage Bookings
440
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
441
- * @permissionScope Manage Bookings - all permissions
442
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
443
- * @applicableIdentity APP
444
- * @fqn com.wixpress.bookings.attendance.v2.AttendanceService.SetAttendance
445
- */
446
- export declare function setAttendance(attendance: NonNullablePaths<Attendance, `bookingId` | `status`>, options?: SetAttendanceOptions): Promise<NonNullablePaths<SetAttendanceResponse, {
447
- [P in AttendanceNonNullablePaths]: `attendance.${P}`;
448
- }[AttendanceNonNullablePaths]>>;
449
- export interface SetAttendanceOptions {
450
- /** Information about whether to send a message to a customer after their attendance was set. */
451
- participantNotification?: ParticipantNotification;
452
- }
453
- /**
454
- * Sets or updates attendance information for multiple booking sessions.
455
- *
456
- *
457
- * Refer to Set Attendance for detailed behavior of individual attendance
458
- * entries.
459
- *
460
- * The call fails entirely if any entry in `attendanceDetails` is missing a
461
- * required field.
462
- *
463
- * If attendance details are provided for a non-existent session, the call
464
- * succeeds for valid sessions while marking the unavailable session as a
465
- * failure in the response.
466
- * @public
467
- * @documentationMaturity preview
468
- * @param options - Options to use when setting multiple attendances in bulk.
469
- * @permissionId BOOKINGS.ATTENDANCE_SET
470
- * @permissionScope Manage Bookings
471
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
472
- * @permissionScope Manage Bookings - all permissions
473
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
474
- * @applicableIdentity APP
475
- * @fqn com.wixpress.bookings.attendance.v2.AttendanceService.BulkSetAttendance
476
- */
477
- export declare function bulkSetAttendance(options?: BulkSetAttendanceOptions): Promise<NonNullablePaths<BulkSetAttendanceResponse, `results` | {
478
- [P in AttendanceNonNullablePaths]: `results.${number}.item.${P}`;
479
- }[AttendanceNonNullablePaths] | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
480
- export interface BulkSetAttendanceOptions {
481
- returnFullEntity?: boolean;
482
- /**
483
- * List of attendance details for booking sessions to create or update.
484
- * @maxSize 8
485
- */
486
- attendanceDetails?: AttendanceDetails[];
487
- }
488
- /**
489
- * Creates a query to retrieve a list of attendances.
490
- *
491
- * The `queryAttendances()` function builds a query to retrieve a list of attendances and returns a `AttendancesQueryBuilder` object.
492
- *
493
- * The returned object contains the query definition, which is typically used to call the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/bookings/attendance/attendances-query-builder/find) function.
494
- *
495
- * You can refine the query by chaining `AttendancesQueryBuilder` functions onto the query. `AttendancesQueryBuilder` functions enable you to sort, filter, and control the results that `queryAttendances()` returns.
496
- *
497
- * `queryAttendances()` uses the following `AttendancesQueryBuilder` default values that you can override:
498
- *
499
- * + `limit` is `50`.
500
- * + Sorted by `id` in ascending order.
501
- *
502
- * The functions that are chained to `queryAttendances()` are applied in the order they are called. For example, if you apply `ascending("status")` and then `ascending("numberOfAttendees")`, the results are sorted first by the `"status"`, and then, if there are multiple results with the same `"status"`, the items are sorted by `"numberOfAttendees"`.
503
- *
504
- * The following `AttendancesQueryBuilder` functions are supported for the `queryAttendances()` function. For a full description of the tip settings object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/bookings/attendance/attendances-query-result/items) property in `AttendancesQueryResult`.
505
- * @public
506
- * @documentationMaturity preview
507
- * @permissionScope Manage Stores
508
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
509
- * @permissionScope Manage Bookings Services and Settings
510
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
511
- * @permissionScope Manage Bookings
512
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
513
- * @permissionScope Read Bookings - Including Participants
514
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
515
- * @permissionScope Read Bookings - all read permissions
516
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
517
- * @permissionScope Manage Bookings - all permissions
518
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
519
- * @permissionId BOOKINGS.ATTENDANCE_READ
520
- * @applicableIdentity APP
521
- * @applicableIdentity VISITOR
522
- * @fqn com.wixpress.bookings.attendance.v2.AttendanceService.QueryAttendance
523
- */
524
- export declare function queryAttendance(): AttendancesQueryBuilder;
525
- interface QueryCursorResult {
526
- cursors: Cursors;
527
- hasNext: () => boolean;
528
- hasPrev: () => boolean;
529
- length: number;
530
- pageSize: number;
531
- }
532
- export interface AttendancesQueryResult extends QueryCursorResult {
533
- items: Attendance[];
534
- query: AttendancesQueryBuilder;
535
- next: () => Promise<AttendancesQueryResult>;
536
- prev: () => Promise<AttendancesQueryResult>;
537
- }
538
- export interface AttendancesQueryBuilder {
539
- /** @param propertyName - Property whose value is compared with `value`.
540
- * @param value - Value to compare against.
541
- * @documentationMaturity preview
542
- */
543
- eq: (propertyName: '_id' | 'bookingId' | 'sessionId' | 'status' | 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
544
- /** @param propertyName - Property whose value is compared with `value`.
545
- * @param value - Value to compare against.
546
- * @documentationMaturity preview
547
- */
548
- ne: (propertyName: '_id' | 'bookingId' | 'sessionId' | 'status' | 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
549
- /** @param propertyName - Property whose value is compared with `value`.
550
- * @param value - Value to compare against.
551
- * @documentationMaturity preview
552
- */
553
- ge: (propertyName: 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
554
- /** @param propertyName - Property whose value is compared with `value`.
555
- * @param value - Value to compare against.
556
- * @documentationMaturity preview
557
- */
558
- gt: (propertyName: 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
559
- /** @param propertyName - Property whose value is compared with `value`.
560
- * @param value - Value to compare against.
561
- * @documentationMaturity preview
562
- */
563
- le: (propertyName: 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
564
- /** @param propertyName - Property whose value is compared with `value`.
565
- * @param value - Value to compare against.
566
- * @documentationMaturity preview
567
- */
568
- lt: (propertyName: 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
569
- /** @documentationMaturity preview */
570
- in: (propertyName: '_id' | 'bookingId' | 'sessionId' | 'status' | 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
571
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
572
- * @documentationMaturity preview
573
- */
574
- ascending: (...propertyNames: Array<'_id' | 'bookingId' | 'sessionId' | 'status' | 'numberOfAttendees'>) => AttendancesQueryBuilder;
575
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
576
- * @documentationMaturity preview
577
- */
578
- descending: (...propertyNames: Array<'numberOfAttendees'>) => AttendancesQueryBuilder;
579
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
580
- * @documentationMaturity preview
581
- */
582
- limit: (limit: number) => AttendancesQueryBuilder;
583
- /** @param cursor - A pointer to specific record
584
- * @documentationMaturity preview
585
- */
586
- skipTo: (cursor: string) => AttendancesQueryBuilder;
587
- /** @documentationMaturity preview */
588
- find: () => Promise<AttendancesQueryResult>;
589
- }
590
- export {};