@wix/auto_sdk_bookings_resources 1.0.21 → 1.0.23
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/package.json +0 -3
- 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,3 +1,6 @@
|
|
|
1
|
+
import { w as CreateResourceRequest$1, x as CreateResourceResponse$1, y as BulkCreateResourcesRequest$1, a as BulkCreateResourcesResponse$1, H as GetResourceRequest$1, J as GetResourceResponse$1, a1 as UpdateResourceRequest$1, a2 as UpdateResourceResponse$1, a3 as DeleteResourceRequest$1, a4 as DeleteResourceResponse$1, a5 as BulkDeleteResourcesRequest$1, b as BulkDeleteResourcesResponse$1, a6 as SearchResourcesRequest$1, S as SearchResourcesResponse$1, aK as QueryResourcesRequest$1, aN as QueryResourcesResponse$1, aO as CountResourcesRequest$1, e as CountResourcesResponse$1 } from './bookings-resources-v2-resource-resources.universal-BvcAlBYB.mjs';
|
|
2
|
+
import '@wix/sdk-types';
|
|
3
|
+
|
|
1
4
|
/**
|
|
2
5
|
* A resource represents an entity, such as a room or a staff member, that can be
|
|
3
6
|
* scheduled for use in a *booking*
|
|
@@ -5,7 +8,7 @@
|
|
|
5
8
|
* The availability of a resource is tracked to ensure that it
|
|
6
9
|
* can be allocated at a requested time slot and to prevent double bookings.
|
|
7
10
|
*/
|
|
8
|
-
|
|
11
|
+
interface Resource extends ResourceCompositionDetailsOneOf {
|
|
9
12
|
/**
|
|
10
13
|
* Resource ID.
|
|
11
14
|
* @format GUID
|
|
@@ -69,9 +72,9 @@ export interface Resource extends ResourceCompositionDetailsOneOf {
|
|
|
69
72
|
extendedFields?: ExtendedFields;
|
|
70
73
|
}
|
|
71
74
|
/** @oneof */
|
|
72
|
-
|
|
75
|
+
interface ResourceCompositionDetailsOneOf {
|
|
73
76
|
}
|
|
74
|
-
|
|
77
|
+
interface WorkingHoursSchedule {
|
|
75
78
|
/**
|
|
76
79
|
* ID of the working hour *schedule*
|
|
77
80
|
* ([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)).
|
|
@@ -86,54 +89,7 @@ export interface WorkingHoursSchedule {
|
|
|
86
89
|
*/
|
|
87
90
|
shared?: boolean | null;
|
|
88
91
|
}
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* Schedule details that specify the working hours and locations of this resource.
|
|
92
|
-
*
|
|
93
|
-
* When this field is missing or empty, the resource is assumed to be available
|
|
94
|
-
* around the clock (24/7) at the locations specified in `locationOptions`. When
|
|
95
|
-
* both `workingHoursSchedules` and `locationOptions` are set,
|
|
96
|
-
* `workingHoursSchedules` takes precedence.
|
|
97
|
-
*/
|
|
98
|
-
workingHoursSchedules?: V2WorkingHoursSchedules;
|
|
99
|
-
/**
|
|
100
|
-
* Information about the location where the resource is available.
|
|
101
|
-
*
|
|
102
|
-
* If you don't specify `locationOptions`, Wix Bookings automatically sets
|
|
103
|
-
* `{"availableInAllLocations": true}`.
|
|
104
|
-
*/
|
|
105
|
-
locationOptions?: LocationOptions;
|
|
106
|
-
/**
|
|
107
|
-
* Schedule containing the *events*
|
|
108
|
-
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction))
|
|
109
|
-
* for which the resource has been booked.
|
|
110
|
-
* @readonly
|
|
111
|
-
*/
|
|
112
|
-
eventsSchedule?: Schedule;
|
|
113
|
-
}
|
|
114
|
-
export interface V2WorkingHoursSchedules {
|
|
115
|
-
/**
|
|
116
|
-
* Schedules specifying the working hours of the resource. Currently, only a single schedule is supported.
|
|
117
|
-
* @maxSize 1
|
|
118
|
-
*/
|
|
119
|
-
values?: Schedule[];
|
|
120
|
-
}
|
|
121
|
-
/** Deprecated and subject to removal */
|
|
122
|
-
export interface Schedule {
|
|
123
|
-
/**
|
|
124
|
-
* Schedule ID. See [Schedules API](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) for more information.
|
|
125
|
-
* @format GUID
|
|
126
|
-
*/
|
|
127
|
-
scheduleId?: string | null;
|
|
128
|
-
/**
|
|
129
|
-
* Whether this schedule is used by multiple resources or unique for this resource.
|
|
130
|
-
*
|
|
131
|
-
* `true` if it is a shared schedule (for example from a business or location), `false` this is a custom schedule specific to the resource.
|
|
132
|
-
* Default: `false`.
|
|
133
|
-
*/
|
|
134
|
-
shared?: boolean | null;
|
|
135
|
-
}
|
|
136
|
-
export interface LocationOptions {
|
|
92
|
+
interface LocationOptions {
|
|
137
93
|
/**
|
|
138
94
|
* Whether the resource is available in all *business locations*
|
|
139
95
|
* ([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)).
|
|
@@ -147,7 +103,7 @@ export interface LocationOptions {
|
|
|
147
103
|
/** Details of resource availability in specific locations. */
|
|
148
104
|
specificLocationOptions?: SpecificLocation;
|
|
149
105
|
}
|
|
150
|
-
|
|
106
|
+
interface SpecificLocation {
|
|
151
107
|
/**
|
|
152
108
|
* Whether the resource is available in *business locations*
|
|
153
109
|
* ([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)).
|
|
@@ -167,7 +123,7 @@ export interface SpecificLocation {
|
|
|
167
123
|
*/
|
|
168
124
|
businessLocations?: BusinessLocation[];
|
|
169
125
|
}
|
|
170
|
-
|
|
126
|
+
interface BusinessLocation {
|
|
171
127
|
/**
|
|
172
128
|
* ID of the business *location*
|
|
173
129
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
|
|
@@ -175,14 +131,14 @@ export interface BusinessLocation {
|
|
|
175
131
|
*/
|
|
176
132
|
locationId?: string | null;
|
|
177
133
|
}
|
|
178
|
-
|
|
134
|
+
interface WorkingHoursSchedules {
|
|
179
135
|
/**
|
|
180
136
|
* Schedules specifying the working hours of the resource. Currently, only a single schedule is supported.
|
|
181
137
|
* @maxSize 1
|
|
182
138
|
*/
|
|
183
139
|
values?: WorkingHoursSchedule[];
|
|
184
140
|
}
|
|
185
|
-
|
|
141
|
+
interface EventsSchedule {
|
|
186
142
|
/**
|
|
187
143
|
* ID of the event *schedule*
|
|
188
144
|
* ([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)).
|
|
@@ -190,13 +146,7 @@ export interface EventsSchedule {
|
|
|
190
146
|
*/
|
|
191
147
|
scheduleId?: string | null;
|
|
192
148
|
}
|
|
193
|
-
|
|
194
|
-
/** The resource is managed by a Wix user. */
|
|
195
|
-
WIX_USER = "WIX_USER"
|
|
196
|
-
}
|
|
197
|
-
/** @enumType */
|
|
198
|
-
export type ManagementTypeWithLiterals = ManagementType | 'WIX_USER';
|
|
199
|
-
export interface ExtendedFields {
|
|
149
|
+
interface ExtendedFields {
|
|
200
150
|
/**
|
|
201
151
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
202
152
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -207,15 +157,15 @@ export interface ExtendedFields {
|
|
|
207
157
|
*/
|
|
208
158
|
namespaces?: Record<string, Record<string, any>>;
|
|
209
159
|
}
|
|
210
|
-
|
|
160
|
+
interface CreateResourceRequest {
|
|
211
161
|
/** Resource to create. */
|
|
212
162
|
resource: Resource;
|
|
213
163
|
}
|
|
214
|
-
|
|
164
|
+
interface CreateResourceResponse {
|
|
215
165
|
/** Created resource. */
|
|
216
166
|
resource?: Resource;
|
|
217
167
|
}
|
|
218
|
-
|
|
168
|
+
interface BulkCreateResourcesRequest {
|
|
219
169
|
/**
|
|
220
170
|
* Resources to create.
|
|
221
171
|
* @maxSize 50
|
|
@@ -228,19 +178,19 @@ export interface BulkCreateResourcesRequest {
|
|
|
228
178
|
*/
|
|
229
179
|
returnEntity?: boolean;
|
|
230
180
|
}
|
|
231
|
-
|
|
181
|
+
interface BulkCreateResourcesResponse {
|
|
232
182
|
/** The result of each resource creation. */
|
|
233
183
|
results?: BulkResourceResult[];
|
|
234
184
|
/** Create statistics. */
|
|
235
185
|
bulkActionMetadata?: BulkActionMetadata;
|
|
236
186
|
}
|
|
237
|
-
|
|
187
|
+
interface BulkResourceResult {
|
|
238
188
|
/** Item metadata. */
|
|
239
189
|
itemMetadata?: ItemMetadata;
|
|
240
190
|
/** The resulting resource after the bulk operation. */
|
|
241
191
|
item?: Resource;
|
|
242
192
|
}
|
|
243
|
-
|
|
193
|
+
interface ItemMetadata {
|
|
244
194
|
/**
|
|
245
195
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
246
196
|
* @format GUID
|
|
@@ -253,7 +203,7 @@ export interface ItemMetadata {
|
|
|
253
203
|
/** Details about the error in case of failure. */
|
|
254
204
|
error?: ApplicationError;
|
|
255
205
|
}
|
|
256
|
-
|
|
206
|
+
interface ApplicationError {
|
|
257
207
|
/** Error code. */
|
|
258
208
|
code?: string;
|
|
259
209
|
/** Description of the error. */
|
|
@@ -261,7 +211,7 @@ export interface ApplicationError {
|
|
|
261
211
|
/** Data related to the error. */
|
|
262
212
|
data?: Record<string, any> | null;
|
|
263
213
|
}
|
|
264
|
-
|
|
214
|
+
interface BulkActionMetadata {
|
|
265
215
|
/** Number of items that were successfully processed. */
|
|
266
216
|
totalSuccesses?: number;
|
|
267
217
|
/** Number of items that couldn't be processed. */
|
|
@@ -269,39 +219,18 @@ export interface BulkActionMetadata {
|
|
|
269
219
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
270
220
|
undetailedFailures?: number;
|
|
271
221
|
}
|
|
272
|
-
|
|
222
|
+
interface GetResourceRequest {
|
|
273
223
|
/**
|
|
274
224
|
* ID of the resource to retrieve.
|
|
275
225
|
* @format GUID
|
|
276
226
|
*/
|
|
277
227
|
resourceId: string;
|
|
278
228
|
}
|
|
279
|
-
|
|
229
|
+
interface GetResourceResponse {
|
|
280
230
|
/** Retrieved resource. */
|
|
281
231
|
resource?: Resource;
|
|
282
232
|
}
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* ID of the deleted resource to retrieve from the trash bin.
|
|
286
|
-
* @format GUID
|
|
287
|
-
*/
|
|
288
|
-
resourceId?: string;
|
|
289
|
-
}
|
|
290
|
-
export interface GetDeletedResourceResponse {
|
|
291
|
-
/** Retrieved resource. */
|
|
292
|
-
resource?: Resource;
|
|
293
|
-
}
|
|
294
|
-
export interface ListDeletedResourcesRequest {
|
|
295
|
-
/**
|
|
296
|
-
* IDs of the resources to retrieve.
|
|
297
|
-
* @format GUID
|
|
298
|
-
* @maxSize 100
|
|
299
|
-
*/
|
|
300
|
-
resourceIds?: string[];
|
|
301
|
-
/** Paging details, allowing you specify a limit and a cursor. */
|
|
302
|
-
paging?: CursorPaging;
|
|
303
|
-
}
|
|
304
|
-
export interface CursorPaging {
|
|
233
|
+
interface CursorPaging {
|
|
305
234
|
/**
|
|
306
235
|
* Maximum number of items to return in the results.
|
|
307
236
|
* @max 100
|
|
@@ -316,13 +245,7 @@ export interface CursorPaging {
|
|
|
316
245
|
*/
|
|
317
246
|
cursor?: string | null;
|
|
318
247
|
}
|
|
319
|
-
|
|
320
|
-
/** Retrieved resources. */
|
|
321
|
-
resources?: Resource[];
|
|
322
|
-
/** Paging metadata. */
|
|
323
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
324
|
-
}
|
|
325
|
-
export interface CursorPagingMetadata {
|
|
248
|
+
interface CursorPagingMetadata {
|
|
326
249
|
/** Number of items returned in the response. */
|
|
327
250
|
count?: number | null;
|
|
328
251
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -335,7 +258,7 @@ export interface CursorPagingMetadata {
|
|
|
335
258
|
*/
|
|
336
259
|
hasNext?: boolean | null;
|
|
337
260
|
}
|
|
338
|
-
|
|
261
|
+
interface Cursors {
|
|
339
262
|
/**
|
|
340
263
|
* Cursor string pointing to the next page in the list of results.
|
|
341
264
|
* @maxLength 16000
|
|
@@ -347,44 +270,24 @@ export interface Cursors {
|
|
|
347
270
|
*/
|
|
348
271
|
prev?: string | null;
|
|
349
272
|
}
|
|
350
|
-
|
|
351
|
-
/**
|
|
352
|
-
* ID of the resource to permanently delete from the trash bin.
|
|
353
|
-
* @format GUID
|
|
354
|
-
*/
|
|
355
|
-
resourceId?: string;
|
|
356
|
-
}
|
|
357
|
-
export interface RemoveResourceFromTrashBinResponse {
|
|
358
|
-
}
|
|
359
|
-
export interface RestoreResourceFromTrashBinRequest {
|
|
360
|
-
/**
|
|
361
|
-
* ID of the resource to restore from the trash bin.
|
|
362
|
-
* @format GUID
|
|
363
|
-
*/
|
|
364
|
-
resourceId?: string;
|
|
365
|
-
}
|
|
366
|
-
export interface RestoreResourceFromTrashBinResponse {
|
|
367
|
-
/** Restored resource. */
|
|
368
|
-
resource?: Resource;
|
|
369
|
-
}
|
|
370
|
-
export interface UpdateResourceRequest {
|
|
273
|
+
interface UpdateResourceRequest {
|
|
371
274
|
/** Resource to update. */
|
|
372
275
|
resource: Resource;
|
|
373
276
|
}
|
|
374
|
-
|
|
277
|
+
interface UpdateResourceResponse {
|
|
375
278
|
/** Updated resource. */
|
|
376
279
|
resource?: Resource;
|
|
377
280
|
}
|
|
378
|
-
|
|
281
|
+
interface DeleteResourceRequest {
|
|
379
282
|
/**
|
|
380
283
|
* ID of the resource to delete.
|
|
381
284
|
* @format GUID
|
|
382
285
|
*/
|
|
383
286
|
resourceId: string;
|
|
384
287
|
}
|
|
385
|
-
|
|
288
|
+
interface DeleteResourceResponse {
|
|
386
289
|
}
|
|
387
|
-
|
|
290
|
+
interface BulkDeleteResourcesRequest {
|
|
388
291
|
/**
|
|
389
292
|
* IDs of the resources to delete.
|
|
390
293
|
* @format GUID
|
|
@@ -392,13 +295,13 @@ export interface BulkDeleteResourcesRequest {
|
|
|
392
295
|
*/
|
|
393
296
|
ids: string[];
|
|
394
297
|
}
|
|
395
|
-
|
|
298
|
+
interface BulkDeleteResourcesResponse {
|
|
396
299
|
/** The result of each resource removal. */
|
|
397
300
|
results?: BulkResourceResult[];
|
|
398
301
|
/** Delete statistics. */
|
|
399
302
|
bulkActionMetadata?: BulkActionMetadata;
|
|
400
303
|
}
|
|
401
|
-
|
|
304
|
+
interface SearchResourcesRequest {
|
|
402
305
|
/**
|
|
403
306
|
* Search condition. Refer to the *supported filters article*
|
|
404
307
|
* ([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))
|
|
@@ -406,7 +309,7 @@ export interface SearchResourcesRequest {
|
|
|
406
309
|
*/
|
|
407
310
|
search?: CursorSearch;
|
|
408
311
|
}
|
|
409
|
-
|
|
312
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
410
313
|
/**
|
|
411
314
|
* Cursor pointing to page of results.
|
|
412
315
|
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
@@ -439,14 +342,14 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
439
342
|
timeZone?: string | null;
|
|
440
343
|
}
|
|
441
344
|
/** @oneof */
|
|
442
|
-
|
|
345
|
+
interface CursorSearchPagingMethodOneOf {
|
|
443
346
|
/**
|
|
444
347
|
* Cursor pointing to page of results.
|
|
445
348
|
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
446
349
|
*/
|
|
447
350
|
cursorPaging?: CursorPaging;
|
|
448
351
|
}
|
|
449
|
-
|
|
352
|
+
interface Sorting {
|
|
450
353
|
/**
|
|
451
354
|
* Name of the field to sort by.
|
|
452
355
|
* @maxLength 512
|
|
@@ -455,13 +358,13 @@ export interface Sorting {
|
|
|
455
358
|
/** Sort order. */
|
|
456
359
|
order?: SortOrderWithLiterals;
|
|
457
360
|
}
|
|
458
|
-
|
|
361
|
+
declare enum SortOrder {
|
|
459
362
|
ASC = "ASC",
|
|
460
363
|
DESC = "DESC"
|
|
461
364
|
}
|
|
462
365
|
/** @enumType */
|
|
463
|
-
|
|
464
|
-
|
|
366
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
367
|
+
interface Aggregation extends AggregationKindOneOf {
|
|
465
368
|
/** Value aggregation */
|
|
466
369
|
value?: ValueAggregation;
|
|
467
370
|
/** Range aggregation */
|
|
@@ -493,7 +396,7 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
493
396
|
groupBy?: GroupByAggregation;
|
|
494
397
|
}
|
|
495
398
|
/** @oneof */
|
|
496
|
-
|
|
399
|
+
interface AggregationKindOneOf {
|
|
497
400
|
/** Value aggregation */
|
|
498
401
|
value?: ValueAggregation;
|
|
499
402
|
/** Range aggregation */
|
|
@@ -505,44 +408,44 @@ export interface AggregationKindOneOf {
|
|
|
505
408
|
/** Nested aggregation */
|
|
506
409
|
nested?: NestedAggregation;
|
|
507
410
|
}
|
|
508
|
-
|
|
411
|
+
interface RangeBucket {
|
|
509
412
|
/** Inclusive lower bound of the range. Required if to is not given */
|
|
510
413
|
from?: number | null;
|
|
511
414
|
/** Exclusive upper bound of the range. Required if from is not given */
|
|
512
415
|
to?: number | null;
|
|
513
416
|
}
|
|
514
|
-
|
|
417
|
+
declare enum SortType {
|
|
515
418
|
/** Should sort by number of matches */
|
|
516
419
|
COUNT = "COUNT",
|
|
517
420
|
/** Should sort by value of the field alphabetically */
|
|
518
421
|
VALUE = "VALUE"
|
|
519
422
|
}
|
|
520
423
|
/** @enumType */
|
|
521
|
-
|
|
522
|
-
|
|
424
|
+
type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
425
|
+
declare enum SortDirection {
|
|
523
426
|
/** Should sort in descending order */
|
|
524
427
|
DESC = "DESC",
|
|
525
428
|
/** Should sort in ascending order */
|
|
526
429
|
ASC = "ASC"
|
|
527
430
|
}
|
|
528
431
|
/** @enumType */
|
|
529
|
-
|
|
530
|
-
|
|
432
|
+
type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
433
|
+
declare enum MissingValues {
|
|
531
434
|
/** Should missing values be excluded from the aggregation results */
|
|
532
435
|
EXCLUDE = "EXCLUDE",
|
|
533
436
|
/** Should missing values be included in the aggregation results */
|
|
534
437
|
INCLUDE = "INCLUDE"
|
|
535
438
|
}
|
|
536
439
|
/** @enumType */
|
|
537
|
-
|
|
538
|
-
|
|
440
|
+
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
441
|
+
interface IncludeMissingValuesOptions {
|
|
539
442
|
/**
|
|
540
443
|
* Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
541
444
|
* @maxLength 20
|
|
542
445
|
*/
|
|
543
446
|
addToBucket?: string;
|
|
544
447
|
}
|
|
545
|
-
|
|
448
|
+
declare enum ScalarType {
|
|
546
449
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
547
450
|
/** Count of distinct values */
|
|
548
451
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
@@ -552,8 +455,8 @@ export declare enum ScalarType {
|
|
|
552
455
|
MAX = "MAX"
|
|
553
456
|
}
|
|
554
457
|
/** @enumType */
|
|
555
|
-
|
|
556
|
-
|
|
458
|
+
type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
459
|
+
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
557
460
|
/** Options for including missing values */
|
|
558
461
|
includeOptions?: IncludeMissingValuesOptions;
|
|
559
462
|
/** Should sort by number of matches or value of the field */
|
|
@@ -566,11 +469,11 @@ export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
|
566
469
|
missingValues?: MissingValuesWithLiterals;
|
|
567
470
|
}
|
|
568
471
|
/** @oneof */
|
|
569
|
-
|
|
472
|
+
interface ValueAggregationOptionsOneOf {
|
|
570
473
|
/** Options for including missing values */
|
|
571
474
|
includeOptions?: IncludeMissingValuesOptions;
|
|
572
475
|
}
|
|
573
|
-
|
|
476
|
+
declare enum NestedAggregationType {
|
|
574
477
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
575
478
|
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
576
479
|
VALUE = "VALUE",
|
|
@@ -582,23 +485,23 @@ export declare enum NestedAggregationType {
|
|
|
582
485
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
583
486
|
}
|
|
584
487
|
/** @enumType */
|
|
585
|
-
|
|
586
|
-
|
|
488
|
+
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
489
|
+
interface RangeAggregation {
|
|
587
490
|
/**
|
|
588
491
|
* 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
|
|
589
492
|
* @maxSize 50
|
|
590
493
|
*/
|
|
591
494
|
buckets?: RangeBucket[];
|
|
592
495
|
}
|
|
593
|
-
|
|
496
|
+
interface ScalarAggregation {
|
|
594
497
|
/** Define the operator for the scalar aggregation */
|
|
595
498
|
type?: ScalarTypeWithLiterals;
|
|
596
499
|
}
|
|
597
|
-
|
|
500
|
+
interface DateHistogramAggregation {
|
|
598
501
|
/** Interval for date histogram aggregation */
|
|
599
502
|
interval?: IntervalWithLiterals;
|
|
600
503
|
}
|
|
601
|
-
|
|
504
|
+
declare enum Interval {
|
|
602
505
|
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
603
506
|
/** Yearly interval */
|
|
604
507
|
YEAR = "YEAR",
|
|
@@ -616,8 +519,8 @@ export declare enum Interval {
|
|
|
616
519
|
SECOND = "SECOND"
|
|
617
520
|
}
|
|
618
521
|
/** @enumType */
|
|
619
|
-
|
|
620
|
-
|
|
522
|
+
type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
523
|
+
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
621
524
|
/** Value aggregation */
|
|
622
525
|
value?: ValueAggregation;
|
|
623
526
|
/** Range aggregation */
|
|
@@ -640,7 +543,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
|
640
543
|
fieldPath?: string;
|
|
641
544
|
}
|
|
642
545
|
/** @oneof */
|
|
643
|
-
|
|
546
|
+
interface NestedAggregationItemKindOneOf {
|
|
644
547
|
/** Value aggregation */
|
|
645
548
|
value?: ValueAggregation;
|
|
646
549
|
/** Range aggregation */
|
|
@@ -650,7 +553,7 @@ export interface NestedAggregationItemKindOneOf {
|
|
|
650
553
|
/** Date histogram aggregation */
|
|
651
554
|
dateHistogram?: DateHistogramAggregation;
|
|
652
555
|
}
|
|
653
|
-
|
|
556
|
+
declare enum AggregationType {
|
|
654
557
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
655
558
|
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
656
559
|
VALUE = "VALUE",
|
|
@@ -664,9 +567,9 @@ export declare enum AggregationType {
|
|
|
664
567
|
NESTED = "NESTED"
|
|
665
568
|
}
|
|
666
569
|
/** @enumType */
|
|
667
|
-
|
|
570
|
+
type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
668
571
|
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
669
|
-
|
|
572
|
+
interface NestedAggregation {
|
|
670
573
|
/**
|
|
671
574
|
* Flattened list of aggregations, where each next aggregation is nested within previous one
|
|
672
575
|
* @minSize 2
|
|
@@ -674,7 +577,7 @@ export interface NestedAggregation {
|
|
|
674
577
|
*/
|
|
675
578
|
nestedAggregations?: NestedAggregationItem[];
|
|
676
579
|
}
|
|
677
|
-
|
|
580
|
+
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
678
581
|
/** Value aggregation configuration */
|
|
679
582
|
value?: ValueAggregation;
|
|
680
583
|
/**
|
|
@@ -689,11 +592,11 @@ export interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
|
689
592
|
fieldPath?: string;
|
|
690
593
|
}
|
|
691
594
|
/** @oneof */
|
|
692
|
-
|
|
595
|
+
interface GroupByAggregationKindOneOf {
|
|
693
596
|
/** Value aggregation configuration */
|
|
694
597
|
value?: ValueAggregation;
|
|
695
598
|
}
|
|
696
|
-
|
|
599
|
+
interface SearchDetails {
|
|
697
600
|
/** Defines how separate search terms in `expression` are combined */
|
|
698
601
|
mode?: ModeWithLiterals;
|
|
699
602
|
/**
|
|
@@ -710,15 +613,15 @@ export interface SearchDetails {
|
|
|
710
613
|
/** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
711
614
|
fuzzy?: boolean;
|
|
712
615
|
}
|
|
713
|
-
|
|
616
|
+
declare enum Mode {
|
|
714
617
|
/** Any of the search terms must be present */
|
|
715
618
|
OR = "OR",
|
|
716
619
|
/** All search terms must be present */
|
|
717
620
|
AND = "AND"
|
|
718
621
|
}
|
|
719
622
|
/** @enumType */
|
|
720
|
-
|
|
721
|
-
|
|
623
|
+
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
624
|
+
interface SearchResourcesResponse {
|
|
722
625
|
/** Retrieved resources. */
|
|
723
626
|
resources?: Resource[];
|
|
724
627
|
/** Paging metadata. */
|
|
@@ -726,14 +629,14 @@ export interface SearchResourcesResponse {
|
|
|
726
629
|
/** Aggregation results. */
|
|
727
630
|
aggregationData?: AggregationData;
|
|
728
631
|
}
|
|
729
|
-
|
|
632
|
+
interface AggregationData {
|
|
730
633
|
/**
|
|
731
634
|
* key = aggregation name (as derived from search request)
|
|
732
635
|
* @maxSize 10000
|
|
733
636
|
*/
|
|
734
637
|
results?: AggregationResults[];
|
|
735
638
|
}
|
|
736
|
-
|
|
639
|
+
interface ValueAggregationResult {
|
|
737
640
|
/**
|
|
738
641
|
* Value of the field
|
|
739
642
|
* @maxLength 100
|
|
@@ -742,7 +645,7 @@ export interface ValueAggregationResult {
|
|
|
742
645
|
/** Count of entities with this value */
|
|
743
646
|
count?: number;
|
|
744
647
|
}
|
|
745
|
-
|
|
648
|
+
interface RangeAggregationResult {
|
|
746
649
|
/** Inclusive lower bound of the range */
|
|
747
650
|
from?: number | null;
|
|
748
651
|
/** Exclusive upper bound of the range */
|
|
@@ -750,7 +653,7 @@ export interface RangeAggregationResult {
|
|
|
750
653
|
/** Count of entities in this range */
|
|
751
654
|
count?: number;
|
|
752
655
|
}
|
|
753
|
-
|
|
656
|
+
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
754
657
|
/** Value aggregation results */
|
|
755
658
|
values?: ValueResults;
|
|
756
659
|
/** Range aggregation results */
|
|
@@ -771,7 +674,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
|
|
|
771
674
|
fieldPath?: string;
|
|
772
675
|
}
|
|
773
676
|
/** @oneof */
|
|
774
|
-
|
|
677
|
+
interface NestedAggregationResultsResultOneOf {
|
|
775
678
|
/** Value aggregation results */
|
|
776
679
|
values?: ValueResults;
|
|
777
680
|
/** Range aggregation results */
|
|
@@ -779,27 +682,27 @@ export interface NestedAggregationResultsResultOneOf {
|
|
|
779
682
|
/** Scalar aggregation results */
|
|
780
683
|
scalar?: AggregationResultsScalarResult;
|
|
781
684
|
}
|
|
782
|
-
|
|
685
|
+
interface ValueResults {
|
|
783
686
|
/**
|
|
784
687
|
* List of value aggregations
|
|
785
688
|
* @maxSize 250
|
|
786
689
|
*/
|
|
787
690
|
results?: ValueAggregationResult[];
|
|
788
691
|
}
|
|
789
|
-
|
|
692
|
+
interface RangeResults {
|
|
790
693
|
/**
|
|
791
694
|
* List of ranges returned in same order as requested
|
|
792
695
|
* @maxSize 50
|
|
793
696
|
*/
|
|
794
697
|
results?: RangeAggregationResult[];
|
|
795
698
|
}
|
|
796
|
-
|
|
699
|
+
interface AggregationResultsScalarResult {
|
|
797
700
|
/** Type of scalar aggregation */
|
|
798
701
|
type?: ScalarTypeWithLiterals;
|
|
799
702
|
/** Value of the scalar aggregation */
|
|
800
703
|
value?: number;
|
|
801
704
|
}
|
|
802
|
-
|
|
705
|
+
interface NestedValueAggregationResult {
|
|
803
706
|
/**
|
|
804
707
|
* Value of the field
|
|
805
708
|
* @maxLength 1000
|
|
@@ -808,7 +711,7 @@ export interface NestedValueAggregationResult {
|
|
|
808
711
|
/** Nested aggregations */
|
|
809
712
|
nestedResults?: NestedAggregationResults;
|
|
810
713
|
}
|
|
811
|
-
|
|
714
|
+
interface ValueResult {
|
|
812
715
|
/**
|
|
813
716
|
* Value of the field
|
|
814
717
|
* @maxLength 1000
|
|
@@ -817,7 +720,7 @@ export interface ValueResult {
|
|
|
817
720
|
/** Count of entities with this value */
|
|
818
721
|
count?: number | null;
|
|
819
722
|
}
|
|
820
|
-
|
|
723
|
+
interface RangeResult {
|
|
821
724
|
/** Inclusive lower bound of the range */
|
|
822
725
|
from?: number | null;
|
|
823
726
|
/** Exclusive upper bound of the range */
|
|
@@ -825,11 +728,11 @@ export interface RangeResult {
|
|
|
825
728
|
/** Count of entities in this range */
|
|
826
729
|
count?: number | null;
|
|
827
730
|
}
|
|
828
|
-
|
|
731
|
+
interface ScalarResult {
|
|
829
732
|
/** Value of the scalar aggregation */
|
|
830
733
|
value?: number;
|
|
831
734
|
}
|
|
832
|
-
|
|
735
|
+
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
833
736
|
/** Value aggregation result */
|
|
834
737
|
value?: ValueResult;
|
|
835
738
|
/** Range aggregation result */
|
|
@@ -840,7 +743,7 @@ export interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
|
840
743
|
dateHistogram?: ValueResult;
|
|
841
744
|
}
|
|
842
745
|
/** @oneof */
|
|
843
|
-
|
|
746
|
+
interface NestedResultValueResultOneOf {
|
|
844
747
|
/** Value aggregation result */
|
|
845
748
|
value?: ValueResult;
|
|
846
749
|
/** Range aggregation result */
|
|
@@ -850,11 +753,11 @@ export interface NestedResultValueResultOneOf {
|
|
|
850
753
|
/** Date histogram aggregation result */
|
|
851
754
|
dateHistogram?: ValueResult;
|
|
852
755
|
}
|
|
853
|
-
|
|
756
|
+
interface Results {
|
|
854
757
|
/** List of nested aggregations */
|
|
855
758
|
results?: Record<string, NestedResultValue>;
|
|
856
759
|
}
|
|
857
|
-
|
|
760
|
+
interface DateHistogramResult {
|
|
858
761
|
/**
|
|
859
762
|
* Date in ISO 8601 format
|
|
860
763
|
* @maxLength 100
|
|
@@ -863,14 +766,14 @@ export interface DateHistogramResult {
|
|
|
863
766
|
/** Count of documents in the bucket */
|
|
864
767
|
count?: number;
|
|
865
768
|
}
|
|
866
|
-
|
|
769
|
+
interface GroupByValueResults {
|
|
867
770
|
/**
|
|
868
771
|
* List of value aggregations
|
|
869
772
|
* @maxSize 1000
|
|
870
773
|
*/
|
|
871
774
|
results?: NestedValueAggregationResult[];
|
|
872
775
|
}
|
|
873
|
-
|
|
776
|
+
interface DateHistogramResults {
|
|
874
777
|
/**
|
|
875
778
|
* List of date histogram aggregations
|
|
876
779
|
* @maxSize 200
|
|
@@ -881,14 +784,14 @@ export interface DateHistogramResults {
|
|
|
881
784
|
* Results of `NESTED` aggregation type in a flattened form
|
|
882
785
|
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
883
786
|
*/
|
|
884
|
-
|
|
787
|
+
interface NestedResults {
|
|
885
788
|
/**
|
|
886
789
|
* List of nested aggregations
|
|
887
790
|
* @maxSize 1000
|
|
888
791
|
*/
|
|
889
792
|
results?: Results[];
|
|
890
793
|
}
|
|
891
|
-
|
|
794
|
+
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
892
795
|
/** Value aggregation results */
|
|
893
796
|
values?: ValueResults;
|
|
894
797
|
/** Range aggregation results */
|
|
@@ -915,7 +818,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
|
915
818
|
fieldPath?: string;
|
|
916
819
|
}
|
|
917
820
|
/** @oneof */
|
|
918
|
-
|
|
821
|
+
interface AggregationResultsResultOneOf {
|
|
919
822
|
/** Value aggregation results */
|
|
920
823
|
values?: ValueResults;
|
|
921
824
|
/** Range aggregation results */
|
|
@@ -929,7 +832,7 @@ export interface AggregationResultsResultOneOf {
|
|
|
929
832
|
/** Nested aggregation results */
|
|
930
833
|
nested?: NestedResults;
|
|
931
834
|
}
|
|
932
|
-
|
|
835
|
+
interface QueryResourcesRequest {
|
|
933
836
|
/**
|
|
934
837
|
* Query for retrieving resources. Refer to the *supported filters article*
|
|
935
838
|
* ([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))
|
|
@@ -937,7 +840,7 @@ export interface QueryResourcesRequest {
|
|
|
937
840
|
*/
|
|
938
841
|
query?: CursorQuery;
|
|
939
842
|
}
|
|
940
|
-
|
|
843
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
941
844
|
/** 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`. */
|
|
942
845
|
cursorPaging?: CursorPaging;
|
|
943
846
|
/**
|
|
@@ -957,17 +860,17 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
957
860
|
sort?: Sorting[];
|
|
958
861
|
}
|
|
959
862
|
/** @oneof */
|
|
960
|
-
|
|
863
|
+
interface CursorQueryPagingMethodOneOf {
|
|
961
864
|
/** 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`. */
|
|
962
865
|
cursorPaging?: CursorPaging;
|
|
963
866
|
}
|
|
964
|
-
|
|
867
|
+
interface QueryResourcesResponse {
|
|
965
868
|
/** Retrieved resources. */
|
|
966
869
|
resources?: Resource[];
|
|
967
870
|
/** Paging metadata. */
|
|
968
871
|
pagingMetadata?: CursorPagingMetadata;
|
|
969
872
|
}
|
|
970
|
-
|
|
873
|
+
interface CountResourcesRequest {
|
|
971
874
|
/**
|
|
972
875
|
* Filter to base the count on. Refer to the *supported filters article*
|
|
973
876
|
* ([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))
|
|
@@ -981,162 +884,35 @@ export interface CountResourcesRequest {
|
|
|
981
884
|
*/
|
|
982
885
|
search?: SearchDetails;
|
|
983
886
|
}
|
|
984
|
-
|
|
887
|
+
interface CountResourcesResponse {
|
|
985
888
|
/** Total number of resources matching the filter. */
|
|
986
889
|
count?: number;
|
|
987
890
|
}
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
}
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
entityFqdn?: string;
|
|
1017
|
-
/**
|
|
1018
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1019
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1020
|
-
*/
|
|
1021
|
-
slug?: string;
|
|
1022
|
-
/** ID of the entity associated with the event. */
|
|
1023
|
-
entityId?: string;
|
|
1024
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1025
|
-
eventTime?: Date | null;
|
|
1026
|
-
/**
|
|
1027
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1028
|
-
* (for example, GDPR).
|
|
1029
|
-
*/
|
|
1030
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1031
|
-
/** If present, indicates the action that triggered the event. */
|
|
1032
|
-
originatedFrom?: string | null;
|
|
1033
|
-
/**
|
|
1034
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1035
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1036
|
-
*/
|
|
1037
|
-
entityEventSequence?: string | null;
|
|
1038
|
-
}
|
|
1039
|
-
/** @oneof */
|
|
1040
|
-
export interface DomainEventBodyOneOf {
|
|
1041
|
-
createdEvent?: EntityCreatedEvent;
|
|
1042
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1043
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1044
|
-
actionEvent?: ActionEvent;
|
|
1045
|
-
}
|
|
1046
|
-
export interface EntityCreatedEvent {
|
|
1047
|
-
entityAsJson?: string;
|
|
1048
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1049
|
-
restoreInfo?: RestoreInfo;
|
|
1050
|
-
}
|
|
1051
|
-
export interface RestoreInfo {
|
|
1052
|
-
deletedDate?: Date | null;
|
|
1053
|
-
}
|
|
1054
|
-
export interface EntityUpdatedEvent {
|
|
1055
|
-
/**
|
|
1056
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1057
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1058
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1059
|
-
*/
|
|
1060
|
-
currentEntityAsJson?: string;
|
|
1061
|
-
}
|
|
1062
|
-
export interface EntityDeletedEvent {
|
|
1063
|
-
/** Entity that was deleted. */
|
|
1064
|
-
deletedEntityAsJson?: string | null;
|
|
1065
|
-
}
|
|
1066
|
-
export interface ActionEvent {
|
|
1067
|
-
bodyAsJson?: string;
|
|
1068
|
-
}
|
|
1069
|
-
export interface Empty {
|
|
1070
|
-
}
|
|
1071
|
-
export interface MessageEnvelope {
|
|
1072
|
-
/**
|
|
1073
|
-
* App instance ID.
|
|
1074
|
-
* @format GUID
|
|
1075
|
-
*/
|
|
1076
|
-
instanceId?: string | null;
|
|
1077
|
-
/**
|
|
1078
|
-
* Event type.
|
|
1079
|
-
* @maxLength 150
|
|
1080
|
-
*/
|
|
1081
|
-
eventType?: string;
|
|
1082
|
-
/** The identification type and identity data. */
|
|
1083
|
-
identity?: IdentificationData;
|
|
1084
|
-
/** Stringify payload. */
|
|
1085
|
-
data?: string;
|
|
1086
|
-
}
|
|
1087
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1088
|
-
/**
|
|
1089
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1090
|
-
* @format GUID
|
|
1091
|
-
*/
|
|
1092
|
-
anonymousVisitorId?: string;
|
|
1093
|
-
/**
|
|
1094
|
-
* ID of a site visitor that has logged in to the site.
|
|
1095
|
-
* @format GUID
|
|
1096
|
-
*/
|
|
1097
|
-
memberId?: string;
|
|
1098
|
-
/**
|
|
1099
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1100
|
-
* @format GUID
|
|
1101
|
-
*/
|
|
1102
|
-
wixUserId?: string;
|
|
1103
|
-
/**
|
|
1104
|
-
* ID of an app.
|
|
1105
|
-
* @format GUID
|
|
1106
|
-
*/
|
|
1107
|
-
appId?: string;
|
|
1108
|
-
/** @readonly */
|
|
1109
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1110
|
-
}
|
|
1111
|
-
/** @oneof */
|
|
1112
|
-
export interface IdentificationDataIdOneOf {
|
|
1113
|
-
/**
|
|
1114
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1115
|
-
* @format GUID
|
|
1116
|
-
*/
|
|
1117
|
-
anonymousVisitorId?: string;
|
|
1118
|
-
/**
|
|
1119
|
-
* ID of a site visitor that has logged in to the site.
|
|
1120
|
-
* @format GUID
|
|
1121
|
-
*/
|
|
1122
|
-
memberId?: string;
|
|
1123
|
-
/**
|
|
1124
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1125
|
-
* @format GUID
|
|
1126
|
-
*/
|
|
1127
|
-
wixUserId?: string;
|
|
1128
|
-
/**
|
|
1129
|
-
* ID of an app.
|
|
1130
|
-
* @format GUID
|
|
1131
|
-
*/
|
|
1132
|
-
appId?: string;
|
|
1133
|
-
}
|
|
1134
|
-
export declare enum WebhookIdentityType {
|
|
1135
|
-
UNKNOWN = "UNKNOWN",
|
|
1136
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1137
|
-
MEMBER = "MEMBER",
|
|
1138
|
-
WIX_USER = "WIX_USER",
|
|
1139
|
-
APP = "APP"
|
|
1140
|
-
}
|
|
1141
|
-
/** @enumType */
|
|
1142
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
891
|
+
|
|
892
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
893
|
+
getUrl: (context: any) => string;
|
|
894
|
+
httpMethod: K;
|
|
895
|
+
path: string;
|
|
896
|
+
pathParams: M;
|
|
897
|
+
__requestType: T;
|
|
898
|
+
__originalRequestType: S;
|
|
899
|
+
__responseType: Q;
|
|
900
|
+
__originalResponseType: R;
|
|
901
|
+
};
|
|
902
|
+
declare function createResource(): __PublicMethodMetaInfo<'POST', {}, CreateResourceRequest$1, CreateResourceRequest, CreateResourceResponse$1, CreateResourceResponse>;
|
|
903
|
+
declare function bulkCreateResources(): __PublicMethodMetaInfo<'POST', {}, BulkCreateResourcesRequest$1, BulkCreateResourcesRequest, BulkCreateResourcesResponse$1, BulkCreateResourcesResponse>;
|
|
904
|
+
declare function getResource(): __PublicMethodMetaInfo<'GET', {
|
|
905
|
+
resourceId: string;
|
|
906
|
+
}, GetResourceRequest$1, GetResourceRequest, GetResourceResponse$1, GetResourceResponse>;
|
|
907
|
+
declare function updateResource(): __PublicMethodMetaInfo<'PATCH', {
|
|
908
|
+
resourceId: string;
|
|
909
|
+
}, UpdateResourceRequest$1, UpdateResourceRequest, UpdateResourceResponse$1, UpdateResourceResponse>;
|
|
910
|
+
declare function deleteResource(): __PublicMethodMetaInfo<'DELETE', {
|
|
911
|
+
resourceId: string;
|
|
912
|
+
}, DeleteResourceRequest$1, DeleteResourceRequest, DeleteResourceResponse$1, DeleteResourceResponse>;
|
|
913
|
+
declare function bulkDeleteResources(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteResourcesRequest$1, BulkDeleteResourcesRequest, BulkDeleteResourcesResponse$1, BulkDeleteResourcesResponse>;
|
|
914
|
+
declare function searchResources(): __PublicMethodMetaInfo<'POST', {}, SearchResourcesRequest$1, SearchResourcesRequest, SearchResourcesResponse$1, SearchResourcesResponse>;
|
|
915
|
+
declare function queryResources(): __PublicMethodMetaInfo<'POST', {}, QueryResourcesRequest$1, QueryResourcesRequest, QueryResourcesResponse$1, QueryResourcesResponse>;
|
|
916
|
+
declare function countResources(): __PublicMethodMetaInfo<'POST', {}, CountResourcesRequest$1, CountResourcesRequest, CountResourcesResponse$1, CountResourcesResponse>;
|
|
917
|
+
|
|
918
|
+
export { type __PublicMethodMetaInfo, bulkCreateResources, bulkDeleteResources, countResources, createResource, deleteResource, getResource, queryResources, searchResources, updateResource };
|