@wix/auto_sdk_bookings_attendance 1.0.4 → 1.0.6

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