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