@wix/auto_sdk_bookings_resources 1.0.21 → 1.0.22
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.
- package/build/{internal/cjs/src/bookings-resources-v2-resource-resources.universal.d.ts → bookings-resources-v2-resource-resources.universal-BvcAlBYB.d.mts} +139 -403
- package/build/{cjs/src/bookings-resources-v2-resource-resources.universal.d.ts → bookings-resources-v2-resource-resources.universal-BvcAlBYB.d.ts} +139 -403
- package/build/{cjs/src/bookings-resources-v2-resource-resources.public.d.ts → index.d.mts} +40 -18
- package/build/{internal/cjs/src/bookings-resources-v2-resource-resources.public.d.ts → index.d.ts} +40 -18
- package/build/index.js +883 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +837 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/bookings-resources-v2-resource-resources.universal.d.ts → bookings-resources-v2-resource-resources.universal-BvcAlBYB.d.mts} +139 -403
- package/build/{es/src/bookings-resources-v2-resource-resources.universal.d.ts → internal/bookings-resources-v2-resource-resources.universal-BvcAlBYB.d.ts} +139 -403
- package/build/{es/src/bookings-resources-v2-resource-resources.public.d.ts → internal/index.d.mts} +40 -18
- package/build/internal/{es/src/bookings-resources-v2-resource-resources.public.d.ts → index.d.ts} +40 -18
- package/build/internal/index.js +883 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +837 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/bookings-resources-v2-resource-resources.types.d.ts → internal/meta.d.mts} +124 -348
- package/build/internal/{cjs/src/bookings-resources-v2-resource-resources.types.d.ts → meta.d.ts} +124 -348
- package/build/internal/meta.js +559 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +524 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/bookings-resources-v2-resource-resources.types.d.ts → meta.d.mts} +124 -348
- package/build/{internal/es/src/bookings-resources-v2-resource-resources.types.d.ts → meta.d.ts} +124 -348
- package/build/meta.js +559 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +524 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -33
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/bookings-resources-v2-resource-resources.context.d.ts +0 -29
- package/build/cjs/src/bookings-resources-v2-resource-resources.context.js +0 -43
- package/build/cjs/src/bookings-resources-v2-resource-resources.context.js.map +0 -1
- package/build/cjs/src/bookings-resources-v2-resource-resources.http.d.ts +0 -96
- package/build/cjs/src/bookings-resources-v2-resource-resources.http.js +0 -446
- package/build/cjs/src/bookings-resources-v2-resource-resources.http.js.map +0 -1
- package/build/cjs/src/bookings-resources-v2-resource-resources.meta.d.ts +0 -27
- package/build/cjs/src/bookings-resources-v2-resource-resources.meta.js +0 -199
- package/build/cjs/src/bookings-resources-v2-resource-resources.meta.js.map +0 -1
- package/build/cjs/src/bookings-resources-v2-resource-resources.public.js +0 -106
- package/build/cjs/src/bookings-resources-v2-resource-resources.public.js.map +0 -1
- package/build/cjs/src/bookings-resources-v2-resource-resources.types.js +0 -104
- package/build/cjs/src/bookings-resources-v2-resource-resources.types.js.map +0 -1
- package/build/cjs/src/bookings-resources-v2-resource-resources.universal.js +0 -591
- package/build/cjs/src/bookings-resources-v2-resource-resources.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -33
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/bookings-resources-v2-resource-resources.context.d.ts +0 -29
- package/build/es/src/bookings-resources-v2-resource-resources.context.js +0 -29
- package/build/es/src/bookings-resources-v2-resource-resources.context.js.map +0 -1
- package/build/es/src/bookings-resources-v2-resource-resources.http.d.ts +0 -96
- package/build/es/src/bookings-resources-v2-resource-resources.http.js +0 -434
- package/build/es/src/bookings-resources-v2-resource-resources.http.js.map +0 -1
- package/build/es/src/bookings-resources-v2-resource-resources.meta.d.ts +0 -27
- package/build/es/src/bookings-resources-v2-resource-resources.meta.js +0 -164
- package/build/es/src/bookings-resources-v2-resource-resources.meta.js.map +0 -1
- package/build/es/src/bookings-resources-v2-resource-resources.public.js +0 -83
- package/build/es/src/bookings-resources-v2-resource-resources.public.js.map +0 -1
- package/build/es/src/bookings-resources-v2-resource-resources.types.js +0 -101
- package/build/es/src/bookings-resources-v2-resource-resources.types.js.map +0 -1
- package/build/es/src/bookings-resources-v2-resource-resources.universal.js +0 -556
- package/build/es/src/bookings-resources-v2-resource-resources.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -33
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.context.d.ts +0 -29
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.context.js +0 -43
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.context.js.map +0 -1
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.http.d.ts +0 -96
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.http.js +0 -446
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.http.js.map +0 -1
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.meta.d.ts +0 -27
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.meta.js +0 -199
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.meta.js.map +0 -1
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.public.js +0 -106
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.public.js.map +0 -1
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.types.js +0 -104
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.types.js.map +0 -1
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.universal.js +0 -591
- package/build/internal/cjs/src/bookings-resources-v2-resource-resources.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -33
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/bookings-resources-v2-resource-resources.context.d.ts +0 -29
- package/build/internal/es/src/bookings-resources-v2-resource-resources.context.js +0 -29
- package/build/internal/es/src/bookings-resources-v2-resource-resources.context.js.map +0 -1
- package/build/internal/es/src/bookings-resources-v2-resource-resources.http.d.ts +0 -96
- package/build/internal/es/src/bookings-resources-v2-resource-resources.http.js +0 -434
- package/build/internal/es/src/bookings-resources-v2-resource-resources.http.js.map +0 -1
- package/build/internal/es/src/bookings-resources-v2-resource-resources.meta.d.ts +0 -27
- package/build/internal/es/src/bookings-resources-v2-resource-resources.meta.js +0 -164
- package/build/internal/es/src/bookings-resources-v2-resource-resources.meta.js.map +0 -1
- package/build/internal/es/src/bookings-resources-v2-resource-resources.public.js +0 -83
- package/build/internal/es/src/bookings-resources-v2-resource-resources.public.js.map +0 -1
- package/build/internal/es/src/bookings-resources-v2-resource-resources.types.js +0 -101
- package/build/internal/es/src/bookings-resources-v2-resource-resources.types.js.map +0 -1
- package/build/internal/es/src/bookings-resources-v2-resource-resources.universal.js +0 -556
- package/build/internal/es/src/bookings-resources-v2-resource-resources.universal.js.map +0 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { SearchSpec, Search } from '@wix/sdk-types';
|
|
2
|
+
|
|
2
3
|
/**
|
|
3
4
|
* A resource represents an entity, such as a room or a staff member, that can be
|
|
4
5
|
* scheduled for use in a *booking*
|
|
@@ -6,7 +7,7 @@ import { Search as SearchSdkType, NonNullablePaths, SearchSpec } from '@wix/sdk-
|
|
|
6
7
|
* The availability of a resource is tracked to ensure that it
|
|
7
8
|
* can be allocated at a requested time slot and to prevent double bookings.
|
|
8
9
|
*/
|
|
9
|
-
|
|
10
|
+
interface Resource extends ResourceCompositionDetailsOneOf {
|
|
10
11
|
/**
|
|
11
12
|
* Resource ID.
|
|
12
13
|
* @format GUID
|
|
@@ -70,9 +71,9 @@ export interface Resource extends ResourceCompositionDetailsOneOf {
|
|
|
70
71
|
extendedFields?: ExtendedFields;
|
|
71
72
|
}
|
|
72
73
|
/** @oneof */
|
|
73
|
-
|
|
74
|
+
interface ResourceCompositionDetailsOneOf {
|
|
74
75
|
}
|
|
75
|
-
|
|
76
|
+
interface WorkingHoursSchedule {
|
|
76
77
|
/**
|
|
77
78
|
* ID of the working hour *schedule*
|
|
78
79
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
|
|
@@ -87,7 +88,7 @@ export interface WorkingHoursSchedule {
|
|
|
87
88
|
*/
|
|
88
89
|
shared?: boolean | null;
|
|
89
90
|
}
|
|
90
|
-
|
|
91
|
+
interface SingleResource {
|
|
91
92
|
/**
|
|
92
93
|
* Schedule details that specify the working hours and locations of this resource.
|
|
93
94
|
*
|
|
@@ -112,7 +113,7 @@ export interface SingleResource {
|
|
|
112
113
|
*/
|
|
113
114
|
eventsSchedule?: Schedule;
|
|
114
115
|
}
|
|
115
|
-
|
|
116
|
+
interface V2WorkingHoursSchedules {
|
|
116
117
|
/**
|
|
117
118
|
* Schedules specifying the working hours of the resource. Currently, only a single schedule is supported.
|
|
118
119
|
* @maxSize 1
|
|
@@ -120,7 +121,7 @@ export interface V2WorkingHoursSchedules {
|
|
|
120
121
|
values?: Schedule[];
|
|
121
122
|
}
|
|
122
123
|
/** Deprecated and subject to removal */
|
|
123
|
-
|
|
124
|
+
interface Schedule {
|
|
124
125
|
/**
|
|
125
126
|
* Schedule ID. See [Schedules API](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) for more information.
|
|
126
127
|
* @format GUID
|
|
@@ -134,7 +135,7 @@ export interface Schedule {
|
|
|
134
135
|
*/
|
|
135
136
|
shared?: boolean | null;
|
|
136
137
|
}
|
|
137
|
-
|
|
138
|
+
interface LocationOptions {
|
|
138
139
|
/**
|
|
139
140
|
* Whether the resource is available in all *business locations*
|
|
140
141
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations#backend-modules_bookings_services_location-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations#location-types)).
|
|
@@ -148,7 +149,7 @@ export interface LocationOptions {
|
|
|
148
149
|
/** Details of resource availability in specific locations. */
|
|
149
150
|
specificLocationOptions?: SpecificLocation;
|
|
150
151
|
}
|
|
151
|
-
|
|
152
|
+
interface SpecificLocation {
|
|
152
153
|
/**
|
|
153
154
|
* Whether the resource is available in *business locations*
|
|
154
155
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations#backend-modules_bookings_services_location-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations#location-types)).
|
|
@@ -168,7 +169,7 @@ export interface SpecificLocation {
|
|
|
168
169
|
*/
|
|
169
170
|
businessLocations?: BusinessLocation[];
|
|
170
171
|
}
|
|
171
|
-
|
|
172
|
+
interface BusinessLocation {
|
|
172
173
|
/**
|
|
173
174
|
* ID of the business *location*
|
|
174
175
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
@@ -176,14 +177,14 @@ export interface BusinessLocation {
|
|
|
176
177
|
*/
|
|
177
178
|
locationId?: string | null;
|
|
178
179
|
}
|
|
179
|
-
|
|
180
|
+
interface WorkingHoursSchedules {
|
|
180
181
|
/**
|
|
181
182
|
* Schedules specifying the working hours of the resource. Currently, only a single schedule is supported.
|
|
182
183
|
* @maxSize 1
|
|
183
184
|
*/
|
|
184
185
|
values?: WorkingHoursSchedule[];
|
|
185
186
|
}
|
|
186
|
-
|
|
187
|
+
interface EventsSchedule {
|
|
187
188
|
/**
|
|
188
189
|
* ID of the event *schedule*
|
|
189
190
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)).
|
|
@@ -191,13 +192,11 @@ export interface EventsSchedule {
|
|
|
191
192
|
*/
|
|
192
193
|
scheduleId?: string | null;
|
|
193
194
|
}
|
|
194
|
-
|
|
195
|
+
declare enum ManagementType {
|
|
195
196
|
/** The resource is managed by a Wix user. */
|
|
196
197
|
WIX_USER = "WIX_USER"
|
|
197
198
|
}
|
|
198
|
-
|
|
199
|
-
export type ManagementTypeWithLiterals = ManagementType | 'WIX_USER';
|
|
200
|
-
export interface ExtendedFields {
|
|
199
|
+
interface ExtendedFields {
|
|
201
200
|
/**
|
|
202
201
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
203
202
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -208,15 +207,15 @@ export interface ExtendedFields {
|
|
|
208
207
|
*/
|
|
209
208
|
namespaces?: Record<string, Record<string, any>>;
|
|
210
209
|
}
|
|
211
|
-
|
|
210
|
+
interface CreateResourceRequest {
|
|
212
211
|
/** Resource to create. */
|
|
213
212
|
resource: Resource;
|
|
214
213
|
}
|
|
215
|
-
|
|
214
|
+
interface CreateResourceResponse {
|
|
216
215
|
/** Created resource. */
|
|
217
216
|
resource?: Resource;
|
|
218
217
|
}
|
|
219
|
-
|
|
218
|
+
interface BulkCreateResourcesRequest {
|
|
220
219
|
/**
|
|
221
220
|
* Resources to create.
|
|
222
221
|
* @maxSize 50
|
|
@@ -229,19 +228,19 @@ export interface BulkCreateResourcesRequest {
|
|
|
229
228
|
*/
|
|
230
229
|
returnEntity?: boolean;
|
|
231
230
|
}
|
|
232
|
-
|
|
231
|
+
interface BulkCreateResourcesResponse {
|
|
233
232
|
/** The result of each resource creation. */
|
|
234
233
|
results?: BulkResourceResult[];
|
|
235
234
|
/** Create statistics. */
|
|
236
235
|
bulkActionMetadata?: BulkActionMetadata;
|
|
237
236
|
}
|
|
238
|
-
|
|
237
|
+
interface BulkResourceResult {
|
|
239
238
|
/** Item metadata. */
|
|
240
239
|
itemMetadata?: ItemMetadata;
|
|
241
240
|
/** The resulting resource after the bulk operation. */
|
|
242
241
|
item?: Resource;
|
|
243
242
|
}
|
|
244
|
-
|
|
243
|
+
interface ItemMetadata {
|
|
245
244
|
/**
|
|
246
245
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
247
246
|
* @format GUID
|
|
@@ -254,7 +253,7 @@ export interface ItemMetadata {
|
|
|
254
253
|
/** Details about the error in case of failure. */
|
|
255
254
|
error?: ApplicationError;
|
|
256
255
|
}
|
|
257
|
-
|
|
256
|
+
interface ApplicationError {
|
|
258
257
|
/** Error code. */
|
|
259
258
|
code?: string;
|
|
260
259
|
/** Description of the error. */
|
|
@@ -262,7 +261,7 @@ export interface ApplicationError {
|
|
|
262
261
|
/** Data related to the error. */
|
|
263
262
|
data?: Record<string, any> | null;
|
|
264
263
|
}
|
|
265
|
-
|
|
264
|
+
interface BulkActionMetadata {
|
|
266
265
|
/** Number of items that were successfully processed. */
|
|
267
266
|
totalSuccesses?: number;
|
|
268
267
|
/** Number of items that couldn't be processed. */
|
|
@@ -270,29 +269,29 @@ export interface BulkActionMetadata {
|
|
|
270
269
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
271
270
|
undetailedFailures?: number;
|
|
272
271
|
}
|
|
273
|
-
|
|
272
|
+
interface GetResourceRequest {
|
|
274
273
|
/**
|
|
275
274
|
* ID of the resource to retrieve.
|
|
276
275
|
* @format GUID
|
|
277
276
|
*/
|
|
278
277
|
resourceId: string;
|
|
279
278
|
}
|
|
280
|
-
|
|
279
|
+
interface GetResourceResponse {
|
|
281
280
|
/** Retrieved resource. */
|
|
282
281
|
resource?: Resource;
|
|
283
282
|
}
|
|
284
|
-
|
|
283
|
+
interface GetDeletedResourceRequest {
|
|
285
284
|
/**
|
|
286
285
|
* ID of the deleted resource to retrieve from the trash bin.
|
|
287
286
|
* @format GUID
|
|
288
287
|
*/
|
|
289
288
|
resourceId?: string;
|
|
290
289
|
}
|
|
291
|
-
|
|
290
|
+
interface GetDeletedResourceResponse {
|
|
292
291
|
/** Retrieved resource. */
|
|
293
292
|
resource?: Resource;
|
|
294
293
|
}
|
|
295
|
-
|
|
294
|
+
interface ListDeletedResourcesRequest {
|
|
296
295
|
/**
|
|
297
296
|
* IDs of the resources to retrieve.
|
|
298
297
|
* @format GUID
|
|
@@ -302,7 +301,7 @@ export interface ListDeletedResourcesRequest {
|
|
|
302
301
|
/** Paging details, allowing you specify a limit and a cursor. */
|
|
303
302
|
paging?: CursorPaging;
|
|
304
303
|
}
|
|
305
|
-
|
|
304
|
+
interface CursorPaging {
|
|
306
305
|
/**
|
|
307
306
|
* Maximum number of items to return in the results.
|
|
308
307
|
* @max 100
|
|
@@ -317,13 +316,13 @@ export interface CursorPaging {
|
|
|
317
316
|
*/
|
|
318
317
|
cursor?: string | null;
|
|
319
318
|
}
|
|
320
|
-
|
|
319
|
+
interface ListDeletedResourcesResponse {
|
|
321
320
|
/** Retrieved resources. */
|
|
322
321
|
resources?: Resource[];
|
|
323
322
|
/** Paging metadata. */
|
|
324
323
|
pagingMetadata?: CursorPagingMetadata;
|
|
325
324
|
}
|
|
326
|
-
|
|
325
|
+
interface CursorPagingMetadata {
|
|
327
326
|
/** Number of items returned in the response. */
|
|
328
327
|
count?: number | null;
|
|
329
328
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -336,7 +335,7 @@ export interface CursorPagingMetadata {
|
|
|
336
335
|
*/
|
|
337
336
|
hasNext?: boolean | null;
|
|
338
337
|
}
|
|
339
|
-
|
|
338
|
+
interface Cursors {
|
|
340
339
|
/**
|
|
341
340
|
* Cursor string pointing to the next page in the list of results.
|
|
342
341
|
* @maxLength 16000
|
|
@@ -348,44 +347,44 @@ export interface Cursors {
|
|
|
348
347
|
*/
|
|
349
348
|
prev?: string | null;
|
|
350
349
|
}
|
|
351
|
-
|
|
350
|
+
interface RemoveResourceFromTrashBinRequest {
|
|
352
351
|
/**
|
|
353
352
|
* ID of the resource to permanently delete from the trash bin.
|
|
354
353
|
* @format GUID
|
|
355
354
|
*/
|
|
356
355
|
resourceId?: string;
|
|
357
356
|
}
|
|
358
|
-
|
|
357
|
+
interface RemoveResourceFromTrashBinResponse {
|
|
359
358
|
}
|
|
360
|
-
|
|
359
|
+
interface RestoreResourceFromTrashBinRequest {
|
|
361
360
|
/**
|
|
362
361
|
* ID of the resource to restore from the trash bin.
|
|
363
362
|
* @format GUID
|
|
364
363
|
*/
|
|
365
364
|
resourceId?: string;
|
|
366
365
|
}
|
|
367
|
-
|
|
366
|
+
interface RestoreResourceFromTrashBinResponse {
|
|
368
367
|
/** Restored resource. */
|
|
369
368
|
resource?: Resource;
|
|
370
369
|
}
|
|
371
|
-
|
|
370
|
+
interface UpdateResourceRequest {
|
|
372
371
|
/** Resource to update. */
|
|
373
372
|
resource: Resource;
|
|
374
373
|
}
|
|
375
|
-
|
|
374
|
+
interface UpdateResourceResponse {
|
|
376
375
|
/** Updated resource. */
|
|
377
376
|
resource?: Resource;
|
|
378
377
|
}
|
|
379
|
-
|
|
378
|
+
interface DeleteResourceRequest {
|
|
380
379
|
/**
|
|
381
380
|
* ID of the resource to delete.
|
|
382
381
|
* @format GUID
|
|
383
382
|
*/
|
|
384
383
|
resourceId: string;
|
|
385
384
|
}
|
|
386
|
-
|
|
385
|
+
interface DeleteResourceResponse {
|
|
387
386
|
}
|
|
388
|
-
|
|
387
|
+
interface BulkDeleteResourcesRequest {
|
|
389
388
|
/**
|
|
390
389
|
* IDs of the resources to delete.
|
|
391
390
|
* @format GUID
|
|
@@ -393,13 +392,13 @@ export interface BulkDeleteResourcesRequest {
|
|
|
393
392
|
*/
|
|
394
393
|
ids: string[];
|
|
395
394
|
}
|
|
396
|
-
|
|
395
|
+
interface BulkDeleteResourcesResponse {
|
|
397
396
|
/** The result of each resource removal. */
|
|
398
397
|
results?: BulkResourceResult[];
|
|
399
398
|
/** Delete statistics. */
|
|
400
399
|
bulkActionMetadata?: BulkActionMetadata;
|
|
401
400
|
}
|
|
402
|
-
|
|
401
|
+
interface SearchResourcesRequest {
|
|
403
402
|
/**
|
|
404
403
|
* Search condition. Refer to the *supported filters article*
|
|
405
404
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
|
|
@@ -407,7 +406,7 @@ export interface SearchResourcesRequest {
|
|
|
407
406
|
*/
|
|
408
407
|
search?: CursorSearch;
|
|
409
408
|
}
|
|
410
|
-
|
|
409
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
411
410
|
/**
|
|
412
411
|
* Cursor pointing to page of results.
|
|
413
412
|
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
@@ -440,14 +439,14 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
440
439
|
timeZone?: string | null;
|
|
441
440
|
}
|
|
442
441
|
/** @oneof */
|
|
443
|
-
|
|
442
|
+
interface CursorSearchPagingMethodOneOf {
|
|
444
443
|
/**
|
|
445
444
|
* Cursor pointing to page of results.
|
|
446
445
|
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
447
446
|
*/
|
|
448
447
|
cursorPaging?: CursorPaging;
|
|
449
448
|
}
|
|
450
|
-
|
|
449
|
+
interface Sorting {
|
|
451
450
|
/**
|
|
452
451
|
* Name of the field to sort by.
|
|
453
452
|
* @maxLength 512
|
|
@@ -456,13 +455,13 @@ export interface Sorting {
|
|
|
456
455
|
/** Sort order. */
|
|
457
456
|
order?: SortOrderWithLiterals;
|
|
458
457
|
}
|
|
459
|
-
|
|
458
|
+
declare enum SortOrder {
|
|
460
459
|
ASC = "ASC",
|
|
461
460
|
DESC = "DESC"
|
|
462
461
|
}
|
|
463
462
|
/** @enumType */
|
|
464
|
-
|
|
465
|
-
|
|
463
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
464
|
+
interface Aggregation extends AggregationKindOneOf {
|
|
466
465
|
/** Value aggregation */
|
|
467
466
|
value?: ValueAggregation;
|
|
468
467
|
/** Range aggregation */
|
|
@@ -494,7 +493,7 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
494
493
|
groupBy?: GroupByAggregation;
|
|
495
494
|
}
|
|
496
495
|
/** @oneof */
|
|
497
|
-
|
|
496
|
+
interface AggregationKindOneOf {
|
|
498
497
|
/** Value aggregation */
|
|
499
498
|
value?: ValueAggregation;
|
|
500
499
|
/** Range aggregation */
|
|
@@ -506,44 +505,44 @@ export interface AggregationKindOneOf {
|
|
|
506
505
|
/** Nested aggregation */
|
|
507
506
|
nested?: NestedAggregation;
|
|
508
507
|
}
|
|
509
|
-
|
|
508
|
+
interface RangeBucket {
|
|
510
509
|
/** Inclusive lower bound of the range. Required if to is not given */
|
|
511
510
|
from?: number | null;
|
|
512
511
|
/** Exclusive upper bound of the range. Required if from is not given */
|
|
513
512
|
to?: number | null;
|
|
514
513
|
}
|
|
515
|
-
|
|
514
|
+
declare enum SortType {
|
|
516
515
|
/** Should sort by number of matches */
|
|
517
516
|
COUNT = "COUNT",
|
|
518
517
|
/** Should sort by value of the field alphabetically */
|
|
519
518
|
VALUE = "VALUE"
|
|
520
519
|
}
|
|
521
520
|
/** @enumType */
|
|
522
|
-
|
|
523
|
-
|
|
521
|
+
type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
522
|
+
declare enum SortDirection {
|
|
524
523
|
/** Should sort in descending order */
|
|
525
524
|
DESC = "DESC",
|
|
526
525
|
/** Should sort in ascending order */
|
|
527
526
|
ASC = "ASC"
|
|
528
527
|
}
|
|
529
528
|
/** @enumType */
|
|
530
|
-
|
|
531
|
-
|
|
529
|
+
type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
530
|
+
declare enum MissingValues {
|
|
532
531
|
/** Should missing values be excluded from the aggregation results */
|
|
533
532
|
EXCLUDE = "EXCLUDE",
|
|
534
533
|
/** Should missing values be included in the aggregation results */
|
|
535
534
|
INCLUDE = "INCLUDE"
|
|
536
535
|
}
|
|
537
536
|
/** @enumType */
|
|
538
|
-
|
|
539
|
-
|
|
537
|
+
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
538
|
+
interface IncludeMissingValuesOptions {
|
|
540
539
|
/**
|
|
541
540
|
* Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
542
541
|
* @maxLength 20
|
|
543
542
|
*/
|
|
544
543
|
addToBucket?: string;
|
|
545
544
|
}
|
|
546
|
-
|
|
545
|
+
declare enum ScalarType {
|
|
547
546
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
548
547
|
/** Count of distinct values */
|
|
549
548
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
@@ -553,8 +552,8 @@ export declare enum ScalarType {
|
|
|
553
552
|
MAX = "MAX"
|
|
554
553
|
}
|
|
555
554
|
/** @enumType */
|
|
556
|
-
|
|
557
|
-
|
|
555
|
+
type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
556
|
+
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
558
557
|
/** Options for including missing values */
|
|
559
558
|
includeOptions?: IncludeMissingValuesOptions;
|
|
560
559
|
/** Should sort by number of matches or value of the field */
|
|
@@ -567,11 +566,11 @@ export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
|
567
566
|
missingValues?: MissingValuesWithLiterals;
|
|
568
567
|
}
|
|
569
568
|
/** @oneof */
|
|
570
|
-
|
|
569
|
+
interface ValueAggregationOptionsOneOf {
|
|
571
570
|
/** Options for including missing values */
|
|
572
571
|
includeOptions?: IncludeMissingValuesOptions;
|
|
573
572
|
}
|
|
574
|
-
|
|
573
|
+
declare enum NestedAggregationType {
|
|
575
574
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
576
575
|
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
577
576
|
VALUE = "VALUE",
|
|
@@ -583,23 +582,23 @@ export declare enum NestedAggregationType {
|
|
|
583
582
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
584
583
|
}
|
|
585
584
|
/** @enumType */
|
|
586
|
-
|
|
587
|
-
|
|
585
|
+
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
586
|
+
interface RangeAggregation {
|
|
588
587
|
/**
|
|
589
588
|
* List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
|
|
590
589
|
* @maxSize 50
|
|
591
590
|
*/
|
|
592
591
|
buckets?: RangeBucket[];
|
|
593
592
|
}
|
|
594
|
-
|
|
593
|
+
interface ScalarAggregation {
|
|
595
594
|
/** Define the operator for the scalar aggregation */
|
|
596
595
|
type?: ScalarTypeWithLiterals;
|
|
597
596
|
}
|
|
598
|
-
|
|
597
|
+
interface DateHistogramAggregation {
|
|
599
598
|
/** Interval for date histogram aggregation */
|
|
600
599
|
interval?: IntervalWithLiterals;
|
|
601
600
|
}
|
|
602
|
-
|
|
601
|
+
declare enum Interval {
|
|
603
602
|
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
604
603
|
/** Yearly interval */
|
|
605
604
|
YEAR = "YEAR",
|
|
@@ -617,8 +616,8 @@ export declare enum Interval {
|
|
|
617
616
|
SECOND = "SECOND"
|
|
618
617
|
}
|
|
619
618
|
/** @enumType */
|
|
620
|
-
|
|
621
|
-
|
|
619
|
+
type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
620
|
+
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
622
621
|
/** Value aggregation */
|
|
623
622
|
value?: ValueAggregation;
|
|
624
623
|
/** Range aggregation */
|
|
@@ -641,7 +640,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
|
641
640
|
fieldPath?: string;
|
|
642
641
|
}
|
|
643
642
|
/** @oneof */
|
|
644
|
-
|
|
643
|
+
interface NestedAggregationItemKindOneOf {
|
|
645
644
|
/** Value aggregation */
|
|
646
645
|
value?: ValueAggregation;
|
|
647
646
|
/** Range aggregation */
|
|
@@ -651,7 +650,7 @@ export interface NestedAggregationItemKindOneOf {
|
|
|
651
650
|
/** Date histogram aggregation */
|
|
652
651
|
dateHistogram?: DateHistogramAggregation;
|
|
653
652
|
}
|
|
654
|
-
|
|
653
|
+
declare enum AggregationType {
|
|
655
654
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
656
655
|
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
657
656
|
VALUE = "VALUE",
|
|
@@ -665,9 +664,9 @@ export declare enum AggregationType {
|
|
|
665
664
|
NESTED = "NESTED"
|
|
666
665
|
}
|
|
667
666
|
/** @enumType */
|
|
668
|
-
|
|
667
|
+
type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
669
668
|
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
670
|
-
|
|
669
|
+
interface NestedAggregation {
|
|
671
670
|
/**
|
|
672
671
|
* Flattened list of aggregations, where each next aggregation is nested within previous one
|
|
673
672
|
* @minSize 2
|
|
@@ -675,7 +674,7 @@ export interface NestedAggregation {
|
|
|
675
674
|
*/
|
|
676
675
|
nestedAggregations?: NestedAggregationItem[];
|
|
677
676
|
}
|
|
678
|
-
|
|
677
|
+
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
679
678
|
/** Value aggregation configuration */
|
|
680
679
|
value?: ValueAggregation;
|
|
681
680
|
/**
|
|
@@ -690,11 +689,11 @@ export interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
|
690
689
|
fieldPath?: string;
|
|
691
690
|
}
|
|
692
691
|
/** @oneof */
|
|
693
|
-
|
|
692
|
+
interface GroupByAggregationKindOneOf {
|
|
694
693
|
/** Value aggregation configuration */
|
|
695
694
|
value?: ValueAggregation;
|
|
696
695
|
}
|
|
697
|
-
|
|
696
|
+
interface SearchDetails {
|
|
698
697
|
/** Defines how separate search terms in `expression` are combined */
|
|
699
698
|
mode?: ModeWithLiterals;
|
|
700
699
|
/**
|
|
@@ -711,15 +710,15 @@ export interface SearchDetails {
|
|
|
711
710
|
/** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
712
711
|
fuzzy?: boolean;
|
|
713
712
|
}
|
|
714
|
-
|
|
713
|
+
declare enum Mode {
|
|
715
714
|
/** Any of the search terms must be present */
|
|
716
715
|
OR = "OR",
|
|
717
716
|
/** All search terms must be present */
|
|
718
717
|
AND = "AND"
|
|
719
718
|
}
|
|
720
719
|
/** @enumType */
|
|
721
|
-
|
|
722
|
-
|
|
720
|
+
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
721
|
+
interface SearchResourcesResponse {
|
|
723
722
|
/** Retrieved resources. */
|
|
724
723
|
resources?: Resource[];
|
|
725
724
|
/** Paging metadata. */
|
|
@@ -727,14 +726,14 @@ export interface SearchResourcesResponse {
|
|
|
727
726
|
/** Aggregation results. */
|
|
728
727
|
aggregationData?: AggregationData;
|
|
729
728
|
}
|
|
730
|
-
|
|
729
|
+
interface AggregationData {
|
|
731
730
|
/**
|
|
732
731
|
* key = aggregation name (as derived from search request)
|
|
733
732
|
* @maxSize 10000
|
|
734
733
|
*/
|
|
735
734
|
results?: AggregationResults[];
|
|
736
735
|
}
|
|
737
|
-
|
|
736
|
+
interface ValueAggregationResult {
|
|
738
737
|
/**
|
|
739
738
|
* Value of the field
|
|
740
739
|
* @maxLength 100
|
|
@@ -743,7 +742,7 @@ export interface ValueAggregationResult {
|
|
|
743
742
|
/** Count of entities with this value */
|
|
744
743
|
count?: number;
|
|
745
744
|
}
|
|
746
|
-
|
|
745
|
+
interface RangeAggregationResult {
|
|
747
746
|
/** Inclusive lower bound of the range */
|
|
748
747
|
from?: number | null;
|
|
749
748
|
/** Exclusive upper bound of the range */
|
|
@@ -751,7 +750,7 @@ export interface RangeAggregationResult {
|
|
|
751
750
|
/** Count of entities in this range */
|
|
752
751
|
count?: number;
|
|
753
752
|
}
|
|
754
|
-
|
|
753
|
+
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
755
754
|
/** Value aggregation results */
|
|
756
755
|
values?: ValueResults;
|
|
757
756
|
/** Range aggregation results */
|
|
@@ -772,7 +771,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
|
|
|
772
771
|
fieldPath?: string;
|
|
773
772
|
}
|
|
774
773
|
/** @oneof */
|
|
775
|
-
|
|
774
|
+
interface NestedAggregationResultsResultOneOf {
|
|
776
775
|
/** Value aggregation results */
|
|
777
776
|
values?: ValueResults;
|
|
778
777
|
/** Range aggregation results */
|
|
@@ -780,27 +779,27 @@ export interface NestedAggregationResultsResultOneOf {
|
|
|
780
779
|
/** Scalar aggregation results */
|
|
781
780
|
scalar?: AggregationResultsScalarResult;
|
|
782
781
|
}
|
|
783
|
-
|
|
782
|
+
interface ValueResults {
|
|
784
783
|
/**
|
|
785
784
|
* List of value aggregations
|
|
786
785
|
* @maxSize 250
|
|
787
786
|
*/
|
|
788
787
|
results?: ValueAggregationResult[];
|
|
789
788
|
}
|
|
790
|
-
|
|
789
|
+
interface RangeResults {
|
|
791
790
|
/**
|
|
792
791
|
* List of ranges returned in same order as requested
|
|
793
792
|
* @maxSize 50
|
|
794
793
|
*/
|
|
795
794
|
results?: RangeAggregationResult[];
|
|
796
795
|
}
|
|
797
|
-
|
|
796
|
+
interface AggregationResultsScalarResult {
|
|
798
797
|
/** Type of scalar aggregation */
|
|
799
798
|
type?: ScalarTypeWithLiterals;
|
|
800
799
|
/** Value of the scalar aggregation */
|
|
801
800
|
value?: number;
|
|
802
801
|
}
|
|
803
|
-
|
|
802
|
+
interface NestedValueAggregationResult {
|
|
804
803
|
/**
|
|
805
804
|
* Value of the field
|
|
806
805
|
* @maxLength 1000
|
|
@@ -809,7 +808,7 @@ export interface NestedValueAggregationResult {
|
|
|
809
808
|
/** Nested aggregations */
|
|
810
809
|
nestedResults?: NestedAggregationResults;
|
|
811
810
|
}
|
|
812
|
-
|
|
811
|
+
interface ValueResult {
|
|
813
812
|
/**
|
|
814
813
|
* Value of the field
|
|
815
814
|
* @maxLength 1000
|
|
@@ -818,7 +817,7 @@ export interface ValueResult {
|
|
|
818
817
|
/** Count of entities with this value */
|
|
819
818
|
count?: number | null;
|
|
820
819
|
}
|
|
821
|
-
|
|
820
|
+
interface RangeResult {
|
|
822
821
|
/** Inclusive lower bound of the range */
|
|
823
822
|
from?: number | null;
|
|
824
823
|
/** Exclusive upper bound of the range */
|
|
@@ -826,11 +825,11 @@ export interface RangeResult {
|
|
|
826
825
|
/** Count of entities in this range */
|
|
827
826
|
count?: number | null;
|
|
828
827
|
}
|
|
829
|
-
|
|
828
|
+
interface ScalarResult {
|
|
830
829
|
/** Value of the scalar aggregation */
|
|
831
830
|
value?: number;
|
|
832
831
|
}
|
|
833
|
-
|
|
832
|
+
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
834
833
|
/** Value aggregation result */
|
|
835
834
|
value?: ValueResult;
|
|
836
835
|
/** Range aggregation result */
|
|
@@ -841,7 +840,7 @@ export interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
|
841
840
|
dateHistogram?: ValueResult;
|
|
842
841
|
}
|
|
843
842
|
/** @oneof */
|
|
844
|
-
|
|
843
|
+
interface NestedResultValueResultOneOf {
|
|
845
844
|
/** Value aggregation result */
|
|
846
845
|
value?: ValueResult;
|
|
847
846
|
/** Range aggregation result */
|
|
@@ -851,11 +850,11 @@ export interface NestedResultValueResultOneOf {
|
|
|
851
850
|
/** Date histogram aggregation result */
|
|
852
851
|
dateHistogram?: ValueResult;
|
|
853
852
|
}
|
|
854
|
-
|
|
853
|
+
interface Results {
|
|
855
854
|
/** List of nested aggregations */
|
|
856
855
|
results?: Record<string, NestedResultValue>;
|
|
857
856
|
}
|
|
858
|
-
|
|
857
|
+
interface DateHistogramResult {
|
|
859
858
|
/**
|
|
860
859
|
* Date in ISO 8601 format
|
|
861
860
|
* @maxLength 100
|
|
@@ -864,14 +863,14 @@ export interface DateHistogramResult {
|
|
|
864
863
|
/** Count of documents in the bucket */
|
|
865
864
|
count?: number;
|
|
866
865
|
}
|
|
867
|
-
|
|
866
|
+
interface GroupByValueResults {
|
|
868
867
|
/**
|
|
869
868
|
* List of value aggregations
|
|
870
869
|
* @maxSize 1000
|
|
871
870
|
*/
|
|
872
871
|
results?: NestedValueAggregationResult[];
|
|
873
872
|
}
|
|
874
|
-
|
|
873
|
+
interface DateHistogramResults {
|
|
875
874
|
/**
|
|
876
875
|
* List of date histogram aggregations
|
|
877
876
|
* @maxSize 200
|
|
@@ -882,14 +881,14 @@ export interface DateHistogramResults {
|
|
|
882
881
|
* Results of `NESTED` aggregation type in a flattened form
|
|
883
882
|
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
884
883
|
*/
|
|
885
|
-
|
|
884
|
+
interface NestedResults {
|
|
886
885
|
/**
|
|
887
886
|
* List of nested aggregations
|
|
888
887
|
* @maxSize 1000
|
|
889
888
|
*/
|
|
890
889
|
results?: Results[];
|
|
891
890
|
}
|
|
892
|
-
|
|
891
|
+
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
893
892
|
/** Value aggregation results */
|
|
894
893
|
values?: ValueResults;
|
|
895
894
|
/** Range aggregation results */
|
|
@@ -916,7 +915,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
|
916
915
|
fieldPath?: string;
|
|
917
916
|
}
|
|
918
917
|
/** @oneof */
|
|
919
|
-
|
|
918
|
+
interface AggregationResultsResultOneOf {
|
|
920
919
|
/** Value aggregation results */
|
|
921
920
|
values?: ValueResults;
|
|
922
921
|
/** Range aggregation results */
|
|
@@ -930,7 +929,7 @@ export interface AggregationResultsResultOneOf {
|
|
|
930
929
|
/** Nested aggregation results */
|
|
931
930
|
nested?: NestedResults;
|
|
932
931
|
}
|
|
933
|
-
|
|
932
|
+
interface QueryResourcesRequest {
|
|
934
933
|
/**
|
|
935
934
|
* Query for retrieving resources. Refer to the *supported filters article*
|
|
936
935
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
|
|
@@ -938,7 +937,7 @@ export interface QueryResourcesRequest {
|
|
|
938
937
|
*/
|
|
939
938
|
query?: CursorQuery;
|
|
940
939
|
}
|
|
941
|
-
|
|
940
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
942
941
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
943
942
|
cursorPaging?: CursorPaging;
|
|
944
943
|
/**
|
|
@@ -958,17 +957,17 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
958
957
|
sort?: Sorting[];
|
|
959
958
|
}
|
|
960
959
|
/** @oneof */
|
|
961
|
-
|
|
960
|
+
interface CursorQueryPagingMethodOneOf {
|
|
962
961
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
963
962
|
cursorPaging?: CursorPaging;
|
|
964
963
|
}
|
|
965
|
-
|
|
964
|
+
interface QueryResourcesResponse {
|
|
966
965
|
/** Retrieved resources. */
|
|
967
966
|
resources?: Resource[];
|
|
968
967
|
/** Paging metadata. */
|
|
969
968
|
pagingMetadata?: CursorPagingMetadata;
|
|
970
969
|
}
|
|
971
|
-
|
|
970
|
+
interface CountResourcesRequest {
|
|
972
971
|
/**
|
|
973
972
|
* Filter to base the count on. Refer to the *supported filters article*
|
|
974
973
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
|
|
@@ -982,11 +981,11 @@ export interface CountResourcesRequest {
|
|
|
982
981
|
*/
|
|
983
982
|
search?: SearchDetails;
|
|
984
983
|
}
|
|
985
|
-
|
|
984
|
+
interface CountResourcesResponse {
|
|
986
985
|
/** Total number of resources matching the filter. */
|
|
987
986
|
count?: number;
|
|
988
987
|
}
|
|
989
|
-
|
|
988
|
+
interface FixResourceSchedulesRequest {
|
|
990
989
|
/**
|
|
991
990
|
* ID of the resource to fix schedules for.
|
|
992
991
|
* @format GUID
|
|
@@ -995,15 +994,15 @@ export interface FixResourceSchedulesRequest {
|
|
|
995
994
|
/** Working hour schedule that must be set for this resource. */
|
|
996
995
|
workingHoursSchedule?: Schedule;
|
|
997
996
|
}
|
|
998
|
-
|
|
997
|
+
interface FixResourceSchedulesResponse {
|
|
999
998
|
/** Updated resource. */
|
|
1000
999
|
resource?: Resource;
|
|
1001
1000
|
}
|
|
1002
|
-
|
|
1001
|
+
interface ReindexTenantRequest {
|
|
1003
1002
|
}
|
|
1004
|
-
|
|
1003
|
+
interface ReindexTenantResponse {
|
|
1005
1004
|
}
|
|
1006
|
-
|
|
1005
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1007
1006
|
createdEvent?: EntityCreatedEvent;
|
|
1008
1007
|
updatedEvent?: EntityUpdatedEvent;
|
|
1009
1008
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1038,19 +1037,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1038
1037
|
entityEventSequence?: string | null;
|
|
1039
1038
|
}
|
|
1040
1039
|
/** @oneof */
|
|
1041
|
-
|
|
1040
|
+
interface DomainEventBodyOneOf {
|
|
1042
1041
|
createdEvent?: EntityCreatedEvent;
|
|
1043
1042
|
updatedEvent?: EntityUpdatedEvent;
|
|
1044
1043
|
deletedEvent?: EntityDeletedEvent;
|
|
1045
1044
|
actionEvent?: ActionEvent;
|
|
1046
1045
|
}
|
|
1047
|
-
|
|
1046
|
+
interface EntityCreatedEvent {
|
|
1048
1047
|
entity?: string;
|
|
1049
1048
|
}
|
|
1050
|
-
|
|
1049
|
+
interface RestoreInfo {
|
|
1051
1050
|
deletedDate?: Date | null;
|
|
1052
1051
|
}
|
|
1053
|
-
|
|
1052
|
+
interface EntityUpdatedEvent {
|
|
1054
1053
|
/**
|
|
1055
1054
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1056
1055
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1058,16 +1057,16 @@ export interface EntityUpdatedEvent {
|
|
|
1058
1057
|
*/
|
|
1059
1058
|
currentEntity?: string;
|
|
1060
1059
|
}
|
|
1061
|
-
|
|
1060
|
+
interface EntityDeletedEvent {
|
|
1062
1061
|
/** Entity that was deleted. */
|
|
1063
1062
|
deletedEntity?: string | null;
|
|
1064
1063
|
}
|
|
1065
|
-
|
|
1064
|
+
interface ActionEvent {
|
|
1066
1065
|
body?: string;
|
|
1067
1066
|
}
|
|
1068
|
-
|
|
1067
|
+
interface Empty {
|
|
1069
1068
|
}
|
|
1070
|
-
|
|
1069
|
+
interface MessageEnvelope {
|
|
1071
1070
|
/**
|
|
1072
1071
|
* App instance ID.
|
|
1073
1072
|
* @format GUID
|
|
@@ -1083,7 +1082,7 @@ export interface MessageEnvelope {
|
|
|
1083
1082
|
/** Stringify payload. */
|
|
1084
1083
|
data?: string;
|
|
1085
1084
|
}
|
|
1086
|
-
|
|
1085
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1087
1086
|
/**
|
|
1088
1087
|
* ID of a site visitor that has not logged in to the site.
|
|
1089
1088
|
* @format GUID
|
|
@@ -1108,7 +1107,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1108
1107
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1109
1108
|
}
|
|
1110
1109
|
/** @oneof */
|
|
1111
|
-
|
|
1110
|
+
interface IdentificationDataIdOneOf {
|
|
1112
1111
|
/**
|
|
1113
1112
|
* ID of a site visitor that has not logged in to the site.
|
|
1114
1113
|
* @format GUID
|
|
@@ -1130,7 +1129,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1130
1129
|
*/
|
|
1131
1130
|
appId?: string;
|
|
1132
1131
|
}
|
|
1133
|
-
|
|
1132
|
+
declare enum WebhookIdentityType {
|
|
1134
1133
|
UNKNOWN = "UNKNOWN",
|
|
1135
1134
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1136
1135
|
MEMBER = "MEMBER",
|
|
@@ -1138,8 +1137,8 @@ export declare enum WebhookIdentityType {
|
|
|
1138
1137
|
APP = "APP"
|
|
1139
1138
|
}
|
|
1140
1139
|
/** @enumType */
|
|
1141
|
-
|
|
1142
|
-
|
|
1140
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1141
|
+
interface BaseEventMetadata {
|
|
1143
1142
|
/**
|
|
1144
1143
|
* App instance ID.
|
|
1145
1144
|
* @format GUID
|
|
@@ -1153,7 +1152,7 @@ export interface BaseEventMetadata {
|
|
|
1153
1152
|
/** The identification type and identity data. */
|
|
1154
1153
|
identity?: IdentificationData;
|
|
1155
1154
|
}
|
|
1156
|
-
|
|
1155
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1157
1156
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1158
1157
|
_id?: string;
|
|
1159
1158
|
/**
|
|
@@ -1183,102 +1182,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1183
1182
|
*/
|
|
1184
1183
|
entityEventSequence?: string | null;
|
|
1185
1184
|
}
|
|
1186
|
-
|
|
1185
|
+
interface ResourceCreatedEnvelope {
|
|
1187
1186
|
entity: Resource;
|
|
1188
1187
|
metadata: EventMetadata;
|
|
1189
1188
|
}
|
|
1190
|
-
|
|
1191
|
-
* Triggered when a resource is created.
|
|
1192
|
-
* @webhook
|
|
1193
|
-
* @eventType wix.bookings.resources.v2.resource_created
|
|
1194
|
-
* @serviceIdentifier wix.bookings.resources.v2.ResourcesService
|
|
1195
|
-
* @slug created
|
|
1196
|
-
* @documentationMaturity preview
|
|
1197
|
-
*/
|
|
1198
|
-
export declare function onResourceCreated(handler: (event: ResourceCreatedEnvelope) => void | Promise<void>): void;
|
|
1199
|
-
export interface ResourceDeletedEnvelope {
|
|
1189
|
+
interface ResourceDeletedEnvelope {
|
|
1200
1190
|
metadata: EventMetadata;
|
|
1201
1191
|
}
|
|
1202
|
-
|
|
1203
|
-
* Triggered when a resource is deleted.
|
|
1204
|
-
* @webhook
|
|
1205
|
-
* @eventType wix.bookings.resources.v2.resource_deleted
|
|
1206
|
-
* @serviceIdentifier wix.bookings.resources.v2.ResourcesService
|
|
1207
|
-
* @slug deleted
|
|
1208
|
-
* @documentationMaturity preview
|
|
1209
|
-
*/
|
|
1210
|
-
export declare function onResourceDeleted(handler: (event: ResourceDeletedEnvelope) => void | Promise<void>): void;
|
|
1211
|
-
export interface ResourceUpdatedEnvelope {
|
|
1192
|
+
interface ResourceUpdatedEnvelope {
|
|
1212
1193
|
entity: Resource;
|
|
1213
1194
|
metadata: EventMetadata;
|
|
1214
1195
|
}
|
|
1215
|
-
|
|
1216
|
-
* Triggered when a resource is updated.
|
|
1217
|
-
* @webhook
|
|
1218
|
-
* @eventType wix.bookings.resources.v2.resource_updated
|
|
1219
|
-
* @serviceIdentifier wix.bookings.resources.v2.ResourcesService
|
|
1220
|
-
* @slug updated
|
|
1221
|
-
* @documentationMaturity preview
|
|
1222
|
-
*/
|
|
1223
|
-
export declare function onResourceUpdated(handler: (event: ResourceUpdatedEnvelope) => void | Promise<void>): void;
|
|
1224
|
-
type ResourceNonNullablePaths = `workingHoursSchedules.values` | `locationOptions.specificLocationOptions.businessLocations`;
|
|
1225
|
-
/**
|
|
1226
|
-
* Creates a new resource.
|
|
1227
|
-
*
|
|
1228
|
-
*
|
|
1229
|
-
* ## Connected schedules
|
|
1230
|
-
*
|
|
1231
|
-
* A new event *schedule*
|
|
1232
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/wix-bookings-integration) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/wix-bookings-integration))
|
|
1233
|
-
* is automatically created for the resource.
|
|
1234
|
-
*
|
|
1235
|
-
* ## Locations
|
|
1236
|
-
*
|
|
1237
|
-
* If you don't specify `locationOptions`, Wix Bookings automatically sets
|
|
1238
|
-
* `locationOptions.availableInAllLocations` to `true`.
|
|
1239
|
-
*
|
|
1240
|
-
* If you specify 1 business location ID in `locationOptions.specificLocationOptions.businessLocations`,
|
|
1241
|
-
* you must specify `locationOptions.specificLocationOptions.availableInBusinessLocations`
|
|
1242
|
-
* as `true`. Currently, you can specify only a single business location.
|
|
1243
|
-
* @param resource - Resource to create.
|
|
1244
|
-
* @public
|
|
1245
|
-
* @documentationMaturity preview
|
|
1246
|
-
* @requiredField resource
|
|
1247
|
-
* @requiredField resource.name
|
|
1248
|
-
* @permissionId BOOKINGS.RESOURCE_CREATE
|
|
1249
|
-
* @permissionScope Manage Bookings
|
|
1250
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1251
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1252
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1253
|
-
* @applicableIdentity APP
|
|
1254
|
-
* @returns Created resource.
|
|
1255
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.CreateResource
|
|
1256
|
-
*/
|
|
1257
|
-
export declare function createResource(resource: NonNullablePaths<Resource, `name`>): Promise<NonNullablePaths<Resource, ResourceNonNullablePaths>>;
|
|
1258
|
-
/**
|
|
1259
|
-
* Creates up to 50 resources.
|
|
1260
|
-
*
|
|
1261
|
-
*
|
|
1262
|
-
* Refer to *Create Resource*
|
|
1263
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/create-resource) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/create-resource))
|
|
1264
|
-
* for more details.
|
|
1265
|
-
* @param resources - Resources to create.
|
|
1266
|
-
* @public
|
|
1267
|
-
* @documentationMaturity preview
|
|
1268
|
-
* @requiredField resources
|
|
1269
|
-
* @requiredField resources.name
|
|
1270
|
-
* @permissionId BOOKINGS.RESOURCE_CREATE
|
|
1271
|
-
* @permissionScope Manage Bookings
|
|
1272
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1273
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1274
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1275
|
-
* @applicableIdentity APP
|
|
1276
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.BulkCreateResources
|
|
1277
|
-
*/
|
|
1278
|
-
export declare function bulkCreateResources(resources: NonNullablePaths<Resource, `name`>[], options?: BulkCreateResourcesOptions): Promise<NonNullablePaths<BulkCreateResourcesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
1279
|
-
[P in ResourceNonNullablePaths]: `results.${number}.item.${P}`;
|
|
1280
|
-
}[ResourceNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
1281
|
-
export interface BulkCreateResourcesOptions {
|
|
1196
|
+
interface BulkCreateResourcesOptions {
|
|
1282
1197
|
/**
|
|
1283
1198
|
* Whether to include the created resources in the response.
|
|
1284
1199
|
*
|
|
@@ -1286,52 +1201,7 @@ export interface BulkCreateResourcesOptions {
|
|
|
1286
1201
|
*/
|
|
1287
1202
|
returnEntity?: boolean;
|
|
1288
1203
|
}
|
|
1289
|
-
|
|
1290
|
-
* Retrieves a resource.
|
|
1291
|
-
* @param resourceId - ID of the resource to retrieve.
|
|
1292
|
-
* @public
|
|
1293
|
-
* @documentationMaturity preview
|
|
1294
|
-
* @requiredField resourceId
|
|
1295
|
-
* @permissionId BOOKINGS.RESOURCE_READ
|
|
1296
|
-
* @permissionScope Read Bookings - Public Data
|
|
1297
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1298
|
-
* @permissionScope Manage Bookings
|
|
1299
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1300
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1301
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1302
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1303
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1304
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1305
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1306
|
-
* @applicableIdentity APP
|
|
1307
|
-
* @applicableIdentity VISITOR
|
|
1308
|
-
* @returns Retrieved resource.
|
|
1309
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.GetResource
|
|
1310
|
-
*/
|
|
1311
|
-
export declare function getResource(resourceId: string): Promise<NonNullablePaths<Resource, ResourceNonNullablePaths>>;
|
|
1312
|
-
/**
|
|
1313
|
-
* Updates a resource.
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1316
|
-
* Each time the resource is updated, `revision` increments by 1. You must include the current revision of the resource when updating it.
|
|
1317
|
-
* This ensures you're working with the latest service information and prevents unintended overwrites.
|
|
1318
|
-
* @param _id - Resource ID.
|
|
1319
|
-
* @public
|
|
1320
|
-
* @documentationMaturity preview
|
|
1321
|
-
* @requiredField _id
|
|
1322
|
-
* @requiredField resource
|
|
1323
|
-
* @requiredField resource.revision
|
|
1324
|
-
* @permissionId BOOKINGS.RESOURCE_UPDATE
|
|
1325
|
-
* @permissionScope Manage Bookings
|
|
1326
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1327
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1328
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1329
|
-
* @applicableIdentity APP
|
|
1330
|
-
* @returns Updated resource.
|
|
1331
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.UpdateResource
|
|
1332
|
-
*/
|
|
1333
|
-
export declare function updateResource(_id: string, resource: NonNullablePaths<UpdateResource, `revision`>): Promise<NonNullablePaths<Resource, ResourceNonNullablePaths>>;
|
|
1334
|
-
export interface UpdateResource {
|
|
1204
|
+
interface UpdateResource {
|
|
1335
1205
|
/**
|
|
1336
1206
|
* Resource ID.
|
|
1337
1207
|
* @format GUID
|
|
@@ -1394,81 +1264,7 @@ export interface UpdateResource {
|
|
|
1394
1264
|
/** Extensions enabling users to save custom data related to the resource. */
|
|
1395
1265
|
extendedFields?: ExtendedFields;
|
|
1396
1266
|
}
|
|
1397
|
-
|
|
1398
|
-
* Deletes a resource.
|
|
1399
|
-
*
|
|
1400
|
-
*
|
|
1401
|
-
* Deleting a resource cancels its event schedule and all its working hour
|
|
1402
|
-
* schedules that aren't shared with another resource. Learn more about
|
|
1403
|
-
* _how Bookings uses the Calendar APIs_
|
|
1404
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/wix-bookings-integration) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/wix-bookings-integration)).
|
|
1405
|
-
* @param resourceId - ID of the resource to delete.
|
|
1406
|
-
* @public
|
|
1407
|
-
* @documentationMaturity preview
|
|
1408
|
-
* @requiredField resourceId
|
|
1409
|
-
* @permissionId BOOKINGS.RESOURCE_DELETE
|
|
1410
|
-
* @permissionScope Manage Bookings
|
|
1411
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1412
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1413
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1414
|
-
* @applicableIdentity APP
|
|
1415
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.DeleteResource
|
|
1416
|
-
*/
|
|
1417
|
-
export declare function deleteResource(resourceId: string): Promise<void>;
|
|
1418
|
-
/**
|
|
1419
|
-
* Deletes multiple resources.
|
|
1420
|
-
*
|
|
1421
|
-
*
|
|
1422
|
-
* Refer to *Delete Resource*
|
|
1423
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/delete-resource) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/delete-resource))
|
|
1424
|
-
* for more details.
|
|
1425
|
-
* @param ids - IDs of the resources to delete.
|
|
1426
|
-
* @public
|
|
1427
|
-
* @documentationMaturity preview
|
|
1428
|
-
* @requiredField ids
|
|
1429
|
-
* @permissionId BOOKINGS.RESOURCE_DELETE
|
|
1430
|
-
* @permissionScope Manage Bookings
|
|
1431
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1432
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1433
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1434
|
-
* @applicableIdentity APP
|
|
1435
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.BulkDeleteResources
|
|
1436
|
-
*/
|
|
1437
|
-
export declare function bulkDeleteResources(ids: string[]): Promise<NonNullablePaths<BulkDeleteResourcesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
1438
|
-
[P in ResourceNonNullablePaths]: `results.${number}.item.${P}`;
|
|
1439
|
-
}[ResourceNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
1440
|
-
/**
|
|
1441
|
-
* Retrieves a list of resources matching the provided search criteria.
|
|
1442
|
-
*
|
|
1443
|
-
*
|
|
1444
|
-
* Refer to the *supported filters article*
|
|
1445
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
|
|
1446
|
-
* for a complete list of supported filters and sorting options.
|
|
1447
|
-
* @param search - Search condition. Refer to the *supported filters article*
|
|
1448
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
|
|
1449
|
-
* for a complete list of supported filters and sorting options.
|
|
1450
|
-
* @public
|
|
1451
|
-
* @documentationMaturity preview
|
|
1452
|
-
* @requiredField search
|
|
1453
|
-
* @permissionId BOOKINGS.RESOURCE_READ
|
|
1454
|
-
* @permissionScope Read Bookings - Public Data
|
|
1455
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1456
|
-
* @permissionScope Manage Bookings
|
|
1457
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1458
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1459
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1460
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1461
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1462
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1463
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1464
|
-
* @applicableIdentity APP
|
|
1465
|
-
* @applicableIdentity VISITOR
|
|
1466
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.SearchResources
|
|
1467
|
-
*/
|
|
1468
|
-
export declare function searchResources(search: ResourceSearch): Promise<NonNullablePaths<SearchResourcesResponse, {
|
|
1469
|
-
[P in ResourceNonNullablePaths]: `resources.${number}.${P}`;
|
|
1470
|
-
}[ResourceNonNullablePaths] | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`>>;
|
|
1471
|
-
export interface ResourceSearchSpec extends SearchSpec {
|
|
1267
|
+
interface ResourceSearchSpec extends SearchSpec {
|
|
1472
1268
|
aggregatable: [
|
|
1473
1269
|
'_createdDate',
|
|
1474
1270
|
'_id',
|
|
@@ -1510,8 +1306,8 @@ export interface ResourceSearchSpec extends SearchSpec {
|
|
|
1510
1306
|
}
|
|
1511
1307
|
];
|
|
1512
1308
|
}
|
|
1513
|
-
|
|
1514
|
-
|
|
1309
|
+
type CommonSearchWithEntityContext = Search<Resource, ResourceSearchSpec>;
|
|
1310
|
+
type ResourceSearch = {
|
|
1515
1311
|
/**
|
|
1516
1312
|
Cursor pointing to page of results.
|
|
1517
1313
|
When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
@@ -1633,41 +1429,6 @@ export type ResourceSearch = {
|
|
|
1633
1429
|
*/
|
|
1634
1430
|
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
1635
1431
|
};
|
|
1636
|
-
/**
|
|
1637
|
-
* Creates a query to retrieve a list of resources.
|
|
1638
|
-
*
|
|
1639
|
-
* The `queryResources()` function builds a query to retrieve a list of resources and returns a `ResourcesQueryBuilder` object.
|
|
1640
|
-
*
|
|
1641
|
-
* The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/resources-query-builder/find) function.
|
|
1642
|
-
*
|
|
1643
|
-
* You can refine the query by chaining `ResourcesQueryBuilder` functions onto the query. `ResourcesQueryBuilder` functions enable you to sort, filter, and control the results that `queryResources()` returns.
|
|
1644
|
-
*
|
|
1645
|
-
* `queryResources()` runs with the following `ResourcesQueryBuilder` default that you can override:
|
|
1646
|
-
*
|
|
1647
|
-
* + `limit` is `50`.
|
|
1648
|
-
* + Sorted by `id` in ascending order.
|
|
1649
|
-
*
|
|
1650
|
-
* The functions that are chained to `queryResources()` are applied in the order they are called. For example, if you apply `ascending("typeId")` and then `ascending("name")`, the results are sorted first by the `"typeId"`, and then, if there are multiple results with the same `"typeId"`, the items are sorted by `"name"`.
|
|
1651
|
-
*
|
|
1652
|
-
* The following `ResourcesQueryBuilder` functions are supported for the `queryResources()` function. For a full description of the resource object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/resources-query-result/items) property in `ResourcesQueryResult`.
|
|
1653
|
-
* @public
|
|
1654
|
-
* @documentationMaturity preview
|
|
1655
|
-
* @permissionScope Read Bookings - Public Data
|
|
1656
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1657
|
-
* @permissionScope Manage Bookings
|
|
1658
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1659
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1660
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1661
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1662
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1663
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1664
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1665
|
-
* @permissionId BOOKINGS.RESOURCE_READ
|
|
1666
|
-
* @applicableIdentity APP
|
|
1667
|
-
* @applicableIdentity VISITOR
|
|
1668
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.QueryResources
|
|
1669
|
-
*/
|
|
1670
|
-
export declare function queryResources(): ResourcesQueryBuilder;
|
|
1671
1432
|
interface QueryCursorResult {
|
|
1672
1433
|
cursors: Cursors;
|
|
1673
1434
|
hasNext: () => boolean;
|
|
@@ -1675,13 +1436,13 @@ interface QueryCursorResult {
|
|
|
1675
1436
|
length: number;
|
|
1676
1437
|
pageSize: number;
|
|
1677
1438
|
}
|
|
1678
|
-
|
|
1439
|
+
interface ResourcesQueryResult extends QueryCursorResult {
|
|
1679
1440
|
items: Resource[];
|
|
1680
1441
|
query: ResourcesQueryBuilder;
|
|
1681
1442
|
next: () => Promise<ResourcesQueryResult>;
|
|
1682
1443
|
prev: () => Promise<ResourcesQueryResult>;
|
|
1683
1444
|
}
|
|
1684
|
-
|
|
1445
|
+
interface ResourcesQueryBuilder {
|
|
1685
1446
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1686
1447
|
* @param value - Value to compare against.
|
|
1687
1448
|
* @documentationMaturity preview
|
|
@@ -1745,33 +1506,7 @@ export interface ResourcesQueryBuilder {
|
|
|
1745
1506
|
/** @documentationMaturity preview */
|
|
1746
1507
|
find: () => Promise<ResourcesQueryResult>;
|
|
1747
1508
|
}
|
|
1748
|
-
|
|
1749
|
-
* Counts resources according to given criteria.
|
|
1750
|
-
*
|
|
1751
|
-
*
|
|
1752
|
-
* Refer to the *supported filters article*
|
|
1753
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
|
|
1754
|
-
* for a complete list of supported filters and sorting options.
|
|
1755
|
-
* @public
|
|
1756
|
-
* @documentationMaturity preview
|
|
1757
|
-
* @param options - Filter to base the count on. See *the supported filters article* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting)) for a complete list of filtering options.
|
|
1758
|
-
* @permissionId BOOKINGS.RESOURCE_READ
|
|
1759
|
-
* @permissionScope Read Bookings - Public Data
|
|
1760
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1761
|
-
* @permissionScope Manage Bookings
|
|
1762
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1763
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1764
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1765
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1766
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1767
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1768
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1769
|
-
* @applicableIdentity APP
|
|
1770
|
-
* @applicableIdentity VISITOR
|
|
1771
|
-
* @fqn wix.bookings.resources.v2.ResourcesService.CountResources
|
|
1772
|
-
*/
|
|
1773
|
-
export declare function countResources(options?: CountResourcesOptions): Promise<NonNullablePaths<CountResourcesResponse, `count`>>;
|
|
1774
|
-
export interface CountResourcesOptions {
|
|
1509
|
+
interface CountResourcesOptions {
|
|
1775
1510
|
/**
|
|
1776
1511
|
* Filter to base the count on. Refer to the *supported filters article*
|
|
1777
1512
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resources-v2/filtering-and-sorting))
|
|
@@ -1785,4 +1520,5 @@ export interface CountResourcesOptions {
|
|
|
1785
1520
|
*/
|
|
1786
1521
|
search?: SearchDetails;
|
|
1787
1522
|
}
|
|
1788
|
-
|
|
1523
|
+
|
|
1524
|
+
export { type RestoreResourceFromTrashBinRequest as $, AggregationType as A, type BulkCreateResourcesOptions as B, type CountResourcesOptions as C, type ItemMetadata as D, type EventsSchedule as E, type ApplicationError as F, type BulkActionMetadata as G, type GetResourceRequest as H, Interval as I, type GetResourceResponse as J, type GetDeletedResourceRequest as K, type LocationOptions as L, ManagementType as M, NestedAggregationType as N, type GetDeletedResourceResponse as O, type ListDeletedResourcesRequest as P, type CursorPaging as Q, type Resource as R, type SearchResourcesResponse as S, type ListDeletedResourcesResponse as T, type UpdateResource as U, type V2WorkingHoursSchedules as V, WebhookIdentityType as W, type CursorPagingMetadata as X, type Cursors as Y, type RemoveResourceFromTrashBinRequest as Z, type RemoveResourceFromTrashBinResponse as _, type BulkCreateResourcesResponse as a, type MessageEnvelope as a$, type RestoreResourceFromTrashBinResponse as a0, type UpdateResourceRequest as a1, type UpdateResourceResponse as a2, type DeleteResourceRequest as a3, type DeleteResourceResponse as a4, type BulkDeleteResourcesRequest as a5, type SearchResourcesRequest as a6, type CursorSearch as a7, type CursorSearchPagingMethodOneOf as a8, type Sorting as a9, type ScalarResult as aA, type NestedResultValue as aB, type NestedResultValueResultOneOf as aC, type Results as aD, type DateHistogramResult as aE, type GroupByValueResults as aF, type DateHistogramResults as aG, type NestedResults as aH, type AggregationResults as aI, type AggregationResultsResultOneOf as aJ, type QueryResourcesRequest as aK, type CursorQuery as aL, type CursorQueryPagingMethodOneOf as aM, type QueryResourcesResponse as aN, type CountResourcesRequest as aO, type FixResourceSchedulesRequest as aP, type FixResourceSchedulesResponse as aQ, type ReindexTenantRequest as aR, type ReindexTenantResponse as aS, type DomainEvent as aT, type DomainEventBodyOneOf as aU, type EntityCreatedEvent as aV, type RestoreInfo as aW, type EntityUpdatedEvent as aX, type EntityDeletedEvent as aY, type ActionEvent as aZ, type Empty as a_, type Aggregation as aa, type AggregationKindOneOf as ab, type RangeBucket as ac, type IncludeMissingValuesOptions as ad, type ValueAggregation as ae, type ValueAggregationOptionsOneOf as af, type RangeAggregation as ag, type ScalarAggregation as ah, type DateHistogramAggregation as ai, type NestedAggregationItem as aj, type NestedAggregationItemKindOneOf as ak, type NestedAggregation as al, type GroupByAggregation as am, type GroupByAggregationKindOneOf as an, type SearchDetails as ao, type AggregationData as ap, type ValueAggregationResult as aq, type RangeAggregationResult as ar, type NestedAggregationResults as as, type NestedAggregationResultsResultOneOf as at, type ValueResults as au, type RangeResults as av, type AggregationResultsScalarResult as aw, type NestedValueAggregationResult as ax, type ValueResult as ay, type RangeResult as az, type BulkDeleteResourcesResponse as b, type IdentificationData as b0, type IdentificationDataIdOneOf as b1, type BaseEventMetadata as b2, type EventMetadata as b3, type ResourceSearchSpec as b4, type ResourcesQueryResult as b5, type ResourceSearch as c, type ResourcesQueryBuilder as d, type CountResourcesResponse as e, type ResourceCreatedEnvelope as f, type ResourceDeletedEnvelope as g, type ResourceUpdatedEnvelope as h, SortOrder as i, SortType as j, SortDirection as k, MissingValues as l, ScalarType as m, Mode as n, type ResourceCompositionDetailsOneOf as o, type WorkingHoursSchedule as p, type SingleResource as q, type Schedule as r, type SpecificLocation as s, type BusinessLocation as t, type WorkingHoursSchedules as u, type ExtendedFields as v, type CreateResourceRequest as w, type CreateResourceResponse as x, type BulkCreateResourcesRequest as y, type BulkResourceResult as z };
|