@wix/auto_sdk_restaurants_operation-groups 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.context.d.ts +15 -0
  11. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.context.js +20 -0
  12. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.context.js.map +1 -0
  13. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.http.d.ts +44 -0
  14. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.http.js +423 -0
  15. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.http.js.map +1 -0
  16. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.meta.d.ts +31 -0
  17. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.meta.js +237 -0
  18. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.meta.js.map +1 -0
  19. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.public.d.ts +110 -0
  20. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.public.js +75 -0
  21. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.public.js.map +1 -0
  22. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.types.d.ts +588 -0
  23. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.types.js +17 -0
  24. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.types.js.map +1 -0
  25. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.universal.d.ts +882 -0
  26. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.universal.js +503 -0
  27. package/build/cjs/src/restaurants-v1-operation-group-operation-groups.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/restaurants-v1-operation-group-operation-groups.context.d.ts +15 -0
  39. package/build/es/src/restaurants-v1-operation-group-operation-groups.context.js +15 -0
  40. package/build/es/src/restaurants-v1-operation-group-operation-groups.context.js.map +1 -0
  41. package/build/es/src/restaurants-v1-operation-group-operation-groups.http.d.ts +44 -0
  42. package/build/es/src/restaurants-v1-operation-group-operation-groups.http.js +409 -0
  43. package/build/es/src/restaurants-v1-operation-group-operation-groups.http.js.map +1 -0
  44. package/build/es/src/restaurants-v1-operation-group-operation-groups.meta.d.ts +31 -0
  45. package/build/es/src/restaurants-v1-operation-group-operation-groups.meta.js +200 -0
  46. package/build/es/src/restaurants-v1-operation-group-operation-groups.meta.js.map +1 -0
  47. package/build/es/src/restaurants-v1-operation-group-operation-groups.public.d.ts +110 -0
  48. package/build/es/src/restaurants-v1-operation-group-operation-groups.public.js +59 -0
  49. package/build/es/src/restaurants-v1-operation-group-operation-groups.public.js.map +1 -0
  50. package/build/es/src/restaurants-v1-operation-group-operation-groups.types.d.ts +588 -0
  51. package/build/es/src/restaurants-v1-operation-group-operation-groups.types.js +14 -0
  52. package/build/es/src/restaurants-v1-operation-group-operation-groups.types.js.map +1 -0
  53. package/build/es/src/restaurants-v1-operation-group-operation-groups.universal.d.ts +882 -0
  54. package/build/es/src/restaurants-v1-operation-group-operation-groups.universal.js +466 -0
  55. package/build/es/src/restaurants-v1-operation-group-operation-groups.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.context.d.ts +15 -0
  66. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.context.js +20 -0
  67. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.context.js.map +1 -0
  68. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.http.d.ts +44 -0
  69. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.http.js +423 -0
  70. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.http.js.map +1 -0
  71. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.meta.d.ts +31 -0
  72. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.meta.js +237 -0
  73. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.meta.js.map +1 -0
  74. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.public.d.ts +110 -0
  75. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.public.js +75 -0
  76. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.public.js.map +1 -0
  77. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.types.d.ts +588 -0
  78. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.types.js +17 -0
  79. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.types.js.map +1 -0
  80. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.universal.d.ts +882 -0
  81. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.universal.js +503 -0
  82. package/build/internal/cjs/src/restaurants-v1-operation-group-operation-groups.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.context.d.ts +15 -0
  93. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.context.js +15 -0
  94. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.context.js.map +1 -0
  95. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.http.d.ts +44 -0
  96. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.http.js +409 -0
  97. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.http.js.map +1 -0
  98. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.meta.d.ts +31 -0
  99. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.meta.js +200 -0
  100. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.meta.js.map +1 -0
  101. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.public.d.ts +110 -0
  102. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.public.js +59 -0
  103. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.public.js.map +1 -0
  104. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.types.d.ts +588 -0
  105. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.types.js +14 -0
  106. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.types.js.map +1 -0
  107. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.universal.d.ts +882 -0
  108. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.universal.js +466 -0
  109. package/build/internal/es/src/restaurants-v1-operation-group-operation-groups.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,882 @@
1
+ /**
2
+ * An operation group is a aggregation of operations that each one of them point to a different location.
3
+ * Each operation group has different ordering page.
4
+ */
5
+ export interface OperationGroup {
6
+ /**
7
+ * OperationsGroup ID.
8
+ * @format GUID
9
+ * @readonly
10
+ */
11
+ _id?: string | null;
12
+ /**
13
+ * Revision number, which increments by 1 each time the OperationsGroup is updated.
14
+ * To prevent conflicting changes,
15
+ * the current revision must be passed when updating the OperationsGroup.
16
+ *
17
+ * Ignored when creating a OperationsGroup.
18
+ * @readonly
19
+ */
20
+ revision?: string | null;
21
+ /**
22
+ * Date and time the OperationsGroup was created.
23
+ * @readonly
24
+ */
25
+ _createdDate?: Date | null;
26
+ /**
27
+ * Date and time the OperationsGroup was last updated.
28
+ * @readonly
29
+ */
30
+ _updatedDate?: Date | null;
31
+ /**
32
+ * The name of the operations group
33
+ * @minLength 1
34
+ * @maxLength 500
35
+ */
36
+ name?: string | null;
37
+ /** Data Extensions */
38
+ extendedFields?: ExtendedFields;
39
+ /** Tags */
40
+ tags?: Tags;
41
+ }
42
+ export interface ExtendedFields {
43
+ /**
44
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
45
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
46
+ *
47
+ * You can only access fields for which you have the appropriate permissions.
48
+ *
49
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
50
+ */
51
+ namespaces?: Record<string, Record<string, any>>;
52
+ }
53
+ /**
54
+ * Common object for tags.
55
+ * Should be use as in this example:
56
+ * message Foo {
57
+ * string id = 1;
58
+ * ...
59
+ * Tags tags = 5
60
+ * }
61
+ *
62
+ * example of taggable entity
63
+ * {
64
+ * id: "123"
65
+ * tags: {
66
+ * tags: {
67
+ * tag_ids:["11","22"]
68
+ * },
69
+ * private_tags: {
70
+ * tag_ids: ["33", "44"]
71
+ * }
72
+ * }
73
+ * }
74
+ */
75
+ export interface Tags {
76
+ /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
77
+ privateTags?: TagList;
78
+ /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
79
+ tags?: TagList;
80
+ }
81
+ export interface TagList {
82
+ /**
83
+ * List of tag IDs
84
+ * @maxSize 100
85
+ * @maxLength 5
86
+ */
87
+ tagIds?: string[];
88
+ }
89
+ export interface CreateOperationGroupRequest {
90
+ /** OperationGroup to be created. */
91
+ operationGroup: OperationGroup;
92
+ }
93
+ export interface CreateOperationGroupResponse {
94
+ /** The created OperationGroup. */
95
+ operationGroup?: OperationGroup;
96
+ }
97
+ export interface GetOperationGroupRequest {
98
+ /**
99
+ * ID of the OperationGroup to retrieve.
100
+ * @format GUID
101
+ */
102
+ operationGroupId: string;
103
+ }
104
+ export interface GetOperationGroupResponse {
105
+ /** The requested OperationGroup. */
106
+ operationGroup?: OperationGroup;
107
+ }
108
+ export interface UpdateOperationGroupRequest {
109
+ /** OperationGroup to be updated, may be partial. */
110
+ operationGroup: OperationGroup;
111
+ }
112
+ export interface UpdateOperationGroupResponse {
113
+ /** Updated OperationGroup. */
114
+ operationGroup?: OperationGroup;
115
+ }
116
+ export interface DeleteOperationGroupRequest {
117
+ /**
118
+ * Id of the OperationGroup to delete.
119
+ * @format GUID
120
+ */
121
+ operationGroupId: string;
122
+ }
123
+ export interface DeleteOperationGroupResponse {
124
+ }
125
+ export interface QueryOperationGroupsRequest {
126
+ /** WQL expression. */
127
+ query?: CursorQuery;
128
+ }
129
+ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
130
+ /** 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`. */
131
+ cursorPaging?: CursorPaging;
132
+ /**
133
+ * Filter object in the following format:
134
+ * `"filter" : {
135
+ * "fieldName1": "value1",
136
+ * "fieldName2":{"$operator":"value2"}
137
+ * }`
138
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
139
+ */
140
+ filter?: Record<string, any> | null;
141
+ /**
142
+ * Sort object in the following format:
143
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
144
+ * @maxSize 5
145
+ */
146
+ sort?: Sorting[];
147
+ }
148
+ /** @oneof */
149
+ export interface CursorQueryPagingMethodOneOf {
150
+ /** 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`. */
151
+ cursorPaging?: CursorPaging;
152
+ }
153
+ export interface Sorting {
154
+ /**
155
+ * Name of the field to sort by.
156
+ * @maxLength 512
157
+ */
158
+ fieldName?: string;
159
+ /** Sort order. */
160
+ order?: SortOrder;
161
+ }
162
+ export declare enum SortOrder {
163
+ ASC = "ASC",
164
+ DESC = "DESC"
165
+ }
166
+ export interface CursorPaging {
167
+ /**
168
+ * Maximum number of items to return in the results.
169
+ * @max 100
170
+ */
171
+ limit?: number | null;
172
+ /**
173
+ * Pointer to the next or previous page in the list of results.
174
+ *
175
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
176
+ * Not relevant for the first request.
177
+ * @maxLength 16000
178
+ */
179
+ cursor?: string | null;
180
+ }
181
+ export interface QueryOperationGroupsResponse {
182
+ /** List of OperationGroups. */
183
+ operationGroups?: OperationGroup[];
184
+ /** Paging metadata */
185
+ pagingMetadata?: CursorPagingMetadata;
186
+ }
187
+ export interface CursorPagingMetadata {
188
+ /** Number of items returned in the response. */
189
+ count?: number | null;
190
+ /** Cursor strings that point to the next page, previous page, or both. */
191
+ cursors?: Cursors;
192
+ /**
193
+ * Whether there are more pages to retrieve following the current page.
194
+ *
195
+ * + `true`: Another page of results can be retrieved.
196
+ * + `false`: This is the last page.
197
+ */
198
+ hasNext?: boolean | null;
199
+ }
200
+ export interface Cursors {
201
+ /**
202
+ * Cursor string pointing to the next page in the list of results.
203
+ * @maxLength 16000
204
+ */
205
+ next?: string | null;
206
+ /**
207
+ * Cursor pointing to the previous page in the list of results.
208
+ * @maxLength 16000
209
+ */
210
+ prev?: string | null;
211
+ }
212
+ export interface UpdateExtendedFieldsRequest {
213
+ /** ID of the entity to update. */
214
+ _id: string;
215
+ /** Identifier for the app whose extended fields are being updated. */
216
+ namespace: string;
217
+ /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
218
+ namespaceData: Record<string, any> | null;
219
+ }
220
+ export interface UpdateExtendedFieldsResponse {
221
+ /** Updated OperationGroup. */
222
+ operationGroup?: OperationGroup;
223
+ }
224
+ export interface BulkCreateOperationGroupsRequest {
225
+ /**
226
+ * List of OperationGroups to be created
227
+ * @minSize 1
228
+ * @maxSize 100
229
+ */
230
+ operationGroups: OperationGroup[];
231
+ /** set to `true` if you wish to receive back the created OperationGroups in the response */
232
+ returnEntity?: boolean;
233
+ }
234
+ export interface BulkCreateOperationGroupsResponse {
235
+ /**
236
+ * List of the bulk create operation results including the OperationGroups and metadata.
237
+ * @minSize 1
238
+ * @maxSize 100
239
+ */
240
+ results?: BulkOperationGroupResult[];
241
+ /** Metadata regarding the bulk create operation */
242
+ bulkActionMetadata?: BulkActionMetadata;
243
+ }
244
+ export interface ItemMetadata {
245
+ /**
246
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
247
+ * @format GUID
248
+ */
249
+ _id?: string | null;
250
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
251
+ originalIndex?: number;
252
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
253
+ success?: boolean;
254
+ /** Details about the error in case of failure. */
255
+ error?: ApplicationError;
256
+ }
257
+ export interface ApplicationError {
258
+ /** Error code. */
259
+ code?: string;
260
+ /** Description of the error. */
261
+ description?: string;
262
+ /** Data related to the error. */
263
+ data?: Record<string, any> | null;
264
+ }
265
+ export interface BulkOperationGroupResult {
266
+ /** Metadata regarding the specific single create operation */
267
+ itemMetadata?: ItemMetadata;
268
+ /** Only exists if `returnEntity` was set to true in the request */
269
+ item?: OperationGroup;
270
+ }
271
+ export interface BulkActionMetadata {
272
+ /** Number of items that were successfully processed. */
273
+ totalSuccesses?: number;
274
+ /** Number of items that couldn't be processed. */
275
+ totalFailures?: number;
276
+ /** Number of failures without details because detailed failure threshold was exceeded. */
277
+ undetailedFailures?: number;
278
+ }
279
+ export interface BulkUpdateOperationGroupsRequest {
280
+ /**
281
+ * List of OperationGroups to be updated.
282
+ * @minSize 1
283
+ * @maxSize 100
284
+ */
285
+ operationGroups: MaskedOperationGroup[];
286
+ /** set to `true` if you wish to receive back the updated OperationGroups in the response */
287
+ returnEntity?: boolean;
288
+ }
289
+ export interface MaskedOperationGroup {
290
+ /** OperationGroup to be updated, may be partial */
291
+ operationGroup?: OperationGroup;
292
+ }
293
+ export interface BulkUpdateOperationGroupsResponse {
294
+ /**
295
+ * Results
296
+ * @minSize 1
297
+ * @maxSize 100
298
+ */
299
+ results?: BulkUpdateOperationGroupsResponseBulkOperationGroupResult[];
300
+ /** Metadata regarding the bulk update operation */
301
+ bulkActionMetadata?: BulkActionMetadata;
302
+ }
303
+ export interface BulkUpdateOperationGroupsResponseBulkOperationGroupResult {
304
+ /** Metadata regarding the specific single update operation */
305
+ itemMetadata?: ItemMetadata;
306
+ /** Only exists if `returnEntity` was set to true in the request */
307
+ item?: OperationGroup;
308
+ }
309
+ export interface BulkDeleteOperationGroupsRequest {
310
+ /**
311
+ * OperationGroup ids to be deleted
312
+ * @minSize 1
313
+ * @maxSize 100
314
+ * @format GUID
315
+ */
316
+ operationGroupIds: string[];
317
+ }
318
+ export interface BulkDeleteOperationGroupsResponse {
319
+ /**
320
+ * Results
321
+ * @minSize 1
322
+ * @maxSize 100
323
+ */
324
+ results?: BulkDeleteOperationGroupsResponseBulkOperationGroupResult[];
325
+ /** Metadata regarding the bulk delete operation */
326
+ bulkActionMetadata?: BulkActionMetadata;
327
+ }
328
+ export interface BulkDeleteOperationGroupsResponseBulkOperationGroupResult {
329
+ /** Metadata regarding the specific single delete operation */
330
+ itemMetadata?: ItemMetadata;
331
+ }
332
+ export interface BulkUpdateOperationGroupTagsRequest {
333
+ /**
334
+ * List of NileProtoTagsEntities that their tags will update.
335
+ * @minSize 1
336
+ * @maxSize 100
337
+ * @format GUID
338
+ */
339
+ ids: string[];
340
+ /** List of Tags to assign */
341
+ assignTags?: Tags;
342
+ /** List of Tags to unAssign */
343
+ unassignTags?: Tags;
344
+ }
345
+ export interface BulkUpdateOperationGroupTagsResponse {
346
+ /**
347
+ * Results
348
+ * @minSize 1
349
+ * @maxSize 100
350
+ */
351
+ results?: BulkUpdateOperationGroupTagsResult[];
352
+ /** Metadata regarding the bulk update operation */
353
+ bulkActionMetadata?: BulkActionMetadata;
354
+ }
355
+ export interface BulkUpdateOperationGroupTagsResult {
356
+ /** Metadata regarding the specific single update operation */
357
+ itemMetadata?: ItemMetadata;
358
+ }
359
+ export interface BulkUpdateOperationGroupTagsByFilterRequest {
360
+ /** Filter */
361
+ filter: Record<string, any> | null;
362
+ /** List of Tags to assign */
363
+ assignTags?: Tags;
364
+ /** List of Tags to unAssign */
365
+ unassignTags?: Tags;
366
+ }
367
+ export interface BulkUpdateOperationGroupTagsByFilterResponse {
368
+ /**
369
+ * Job ID
370
+ * @format GUID
371
+ */
372
+ jobId?: string;
373
+ }
374
+ export interface DomainEvent extends DomainEventBodyOneOf {
375
+ createdEvent?: EntityCreatedEvent;
376
+ updatedEvent?: EntityUpdatedEvent;
377
+ deletedEvent?: EntityDeletedEvent;
378
+ actionEvent?: ActionEvent;
379
+ /**
380
+ * Unique event ID.
381
+ * Allows clients to ignore duplicate webhooks.
382
+ */
383
+ _id?: string;
384
+ /**
385
+ * Assumes actions are also always typed to an entity_type
386
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
387
+ */
388
+ entityFqdn?: string;
389
+ /**
390
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
391
+ * This is although the created/updated/deleted notion is duplication of the oneof types
392
+ * Example: created/updated/deleted/started/completed/email_opened
393
+ */
394
+ slug?: string;
395
+ /** ID of the entity associated with the event. */
396
+ entityId?: string;
397
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
398
+ eventTime?: Date | null;
399
+ /**
400
+ * Whether the event was triggered as a result of a privacy regulation application
401
+ * (for example, GDPR).
402
+ */
403
+ triggeredByAnonymizeRequest?: boolean | null;
404
+ /** If present, indicates the action that triggered the event. */
405
+ originatedFrom?: string | null;
406
+ /**
407
+ * A sequence number defining the order of updates to the underlying entity.
408
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
409
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
410
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
411
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
412
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
413
+ */
414
+ entityEventSequence?: string | null;
415
+ }
416
+ /** @oneof */
417
+ export interface DomainEventBodyOneOf {
418
+ createdEvent?: EntityCreatedEvent;
419
+ updatedEvent?: EntityUpdatedEvent;
420
+ deletedEvent?: EntityDeletedEvent;
421
+ actionEvent?: ActionEvent;
422
+ }
423
+ export interface EntityCreatedEvent {
424
+ entity?: string;
425
+ }
426
+ export interface RestoreInfo {
427
+ deletedDate?: Date | null;
428
+ }
429
+ export interface EntityUpdatedEvent {
430
+ /**
431
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
432
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
433
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
434
+ */
435
+ currentEntity?: string;
436
+ }
437
+ export interface EntityDeletedEvent {
438
+ /** Entity that was deleted */
439
+ deletedEntity?: string | null;
440
+ }
441
+ export interface ActionEvent {
442
+ body?: string;
443
+ }
444
+ export interface MessageEnvelope {
445
+ /**
446
+ * App instance ID.
447
+ * @format GUID
448
+ */
449
+ instanceId?: string | null;
450
+ /**
451
+ * Event type.
452
+ * @maxLength 150
453
+ */
454
+ eventType?: string;
455
+ /** The identification type and identity data. */
456
+ identity?: IdentificationData;
457
+ /** Stringify payload. */
458
+ data?: string;
459
+ }
460
+ export interface IdentificationData extends IdentificationDataIdOneOf {
461
+ /**
462
+ * ID of a site visitor that has not logged in to the site.
463
+ * @format GUID
464
+ */
465
+ anonymousVisitorId?: string;
466
+ /**
467
+ * ID of a site visitor that has logged in to the site.
468
+ * @format GUID
469
+ */
470
+ memberId?: string;
471
+ /**
472
+ * ID of a Wix user (site owner, contributor, etc.).
473
+ * @format GUID
474
+ */
475
+ wixUserId?: string;
476
+ /**
477
+ * ID of an app.
478
+ * @format GUID
479
+ */
480
+ appId?: string;
481
+ /** @readonly */
482
+ identityType?: WebhookIdentityType;
483
+ }
484
+ /** @oneof */
485
+ export interface IdentificationDataIdOneOf {
486
+ /**
487
+ * ID of a site visitor that has not logged in to the site.
488
+ * @format GUID
489
+ */
490
+ anonymousVisitorId?: string;
491
+ /**
492
+ * ID of a site visitor that has logged in to the site.
493
+ * @format GUID
494
+ */
495
+ memberId?: string;
496
+ /**
497
+ * ID of a Wix user (site owner, contributor, etc.).
498
+ * @format GUID
499
+ */
500
+ wixUserId?: string;
501
+ /**
502
+ * ID of an app.
503
+ * @format GUID
504
+ */
505
+ appId?: string;
506
+ }
507
+ export declare enum WebhookIdentityType {
508
+ UNKNOWN = "UNKNOWN",
509
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
510
+ MEMBER = "MEMBER",
511
+ WIX_USER = "WIX_USER",
512
+ APP = "APP"
513
+ }
514
+ interface TagListNonNullableFields {
515
+ tagIds: string[];
516
+ }
517
+ interface TagsNonNullableFields {
518
+ privateTags?: TagListNonNullableFields;
519
+ tags?: TagListNonNullableFields;
520
+ }
521
+ export interface OperationGroupNonNullableFields {
522
+ tags?: TagsNonNullableFields;
523
+ }
524
+ export interface CreateOperationGroupResponseNonNullableFields {
525
+ operationGroup?: OperationGroupNonNullableFields;
526
+ }
527
+ export interface GetOperationGroupResponseNonNullableFields {
528
+ operationGroup?: OperationGroupNonNullableFields;
529
+ }
530
+ export interface UpdateOperationGroupResponseNonNullableFields {
531
+ operationGroup?: OperationGroupNonNullableFields;
532
+ }
533
+ export interface QueryOperationGroupsResponseNonNullableFields {
534
+ operationGroups: OperationGroupNonNullableFields[];
535
+ }
536
+ export interface UpdateExtendedFieldsResponseNonNullableFields {
537
+ operationGroup?: OperationGroupNonNullableFields;
538
+ }
539
+ interface ApplicationErrorNonNullableFields {
540
+ code: string;
541
+ description: string;
542
+ }
543
+ interface ItemMetadataNonNullableFields {
544
+ originalIndex: number;
545
+ success: boolean;
546
+ error?: ApplicationErrorNonNullableFields;
547
+ }
548
+ interface BulkOperationGroupResultNonNullableFields {
549
+ itemMetadata?: ItemMetadataNonNullableFields;
550
+ item?: OperationGroupNonNullableFields;
551
+ }
552
+ interface BulkActionMetadataNonNullableFields {
553
+ totalSuccesses: number;
554
+ totalFailures: number;
555
+ undetailedFailures: number;
556
+ }
557
+ export interface BulkCreateOperationGroupsResponseNonNullableFields {
558
+ results: BulkOperationGroupResultNonNullableFields[];
559
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
560
+ }
561
+ interface BulkUpdateOperationGroupsResponseBulkOperationGroupResultNonNullableFields {
562
+ itemMetadata?: ItemMetadataNonNullableFields;
563
+ item?: OperationGroupNonNullableFields;
564
+ }
565
+ export interface BulkUpdateOperationGroupsResponseNonNullableFields {
566
+ results: BulkUpdateOperationGroupsResponseBulkOperationGroupResultNonNullableFields[];
567
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
568
+ }
569
+ interface BulkDeleteOperationGroupsResponseBulkOperationGroupResultNonNullableFields {
570
+ itemMetadata?: ItemMetadataNonNullableFields;
571
+ }
572
+ export interface BulkDeleteOperationGroupsResponseNonNullableFields {
573
+ results: BulkDeleteOperationGroupsResponseBulkOperationGroupResultNonNullableFields[];
574
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
575
+ }
576
+ interface BulkUpdateOperationGroupTagsResultNonNullableFields {
577
+ itemMetadata?: ItemMetadataNonNullableFields;
578
+ }
579
+ export interface BulkUpdateOperationGroupTagsResponseNonNullableFields {
580
+ results: BulkUpdateOperationGroupTagsResultNonNullableFields[];
581
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
582
+ }
583
+ export interface BulkUpdateOperationGroupTagsByFilterResponseNonNullableFields {
584
+ jobId: string;
585
+ }
586
+ /**
587
+ * Creates a OperationGroup.
588
+ * @param operationGroup - OperationGroup to be created.
589
+ * @public
590
+ * @documentationMaturity preview
591
+ * @requiredField operationGroup
592
+ * @permissionId RESTAURANTS.OPERATION_GROUP_CREATE
593
+ * @permissionScope Manage Restaurants - all permissions
594
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
595
+ * @applicableIdentity APP
596
+ * @returns The created OperationGroup.
597
+ * @fqn wix.restaurants.v1.OperationGroupService.CreateOperationGroup
598
+ */
599
+ export declare function createOperationGroup(operationGroup: OperationGroup): Promise<OperationGroup & OperationGroupNonNullableFields>;
600
+ /**
601
+ * Retrieves a OperationGroup.
602
+ * @param operationGroupId - ID of the OperationGroup to retrieve.
603
+ * @public
604
+ * @documentationMaturity preview
605
+ * @requiredField operationGroupId
606
+ * @permissionId RESTAURANTS.OPERATION_GROUP_READ
607
+ * @permissionScope Manage Restaurants - all permissions
608
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
609
+ * @applicableIdentity APP
610
+ * @returns The requested OperationGroup.
611
+ * @fqn wix.restaurants.v1.OperationGroupService.GetOperationGroup
612
+ */
613
+ export declare function getOperationGroup(operationGroupId: string): Promise<OperationGroup & OperationGroupNonNullableFields>;
614
+ /**
615
+ * Updates a OperationGroup.
616
+ *
617
+ *
618
+ * Each time the OperationGroup is updated,
619
+ * `revision` increments by 1.
620
+ * The current `revision` must be passed when updating the OperationGroup.
621
+ * This ensures you're working with the latest OperationGroup
622
+ * and prevents unintended overwrites.
623
+ * @param _id - OperationsGroup ID.
624
+ * @public
625
+ * @documentationMaturity preview
626
+ * @requiredField _id
627
+ * @requiredField operationGroup
628
+ * @requiredField operationGroup.revision
629
+ * @permissionId RESTAURANTS.OPERATION_GROUP_UPDATE
630
+ * @permissionScope Manage Restaurants - all permissions
631
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
632
+ * @applicableIdentity APP
633
+ * @returns Updated OperationGroup.
634
+ * @fqn wix.restaurants.v1.OperationGroupService.UpdateOperationGroup
635
+ */
636
+ export declare function updateOperationGroup(_id: string | null, operationGroup: UpdateOperationGroup): Promise<OperationGroup & OperationGroupNonNullableFields>;
637
+ export interface UpdateOperationGroup {
638
+ /**
639
+ * OperationsGroup ID.
640
+ * @format GUID
641
+ * @readonly
642
+ */
643
+ _id?: string | null;
644
+ /**
645
+ * Revision number, which increments by 1 each time the OperationsGroup is updated.
646
+ * To prevent conflicting changes,
647
+ * the current revision must be passed when updating the OperationsGroup.
648
+ *
649
+ * Ignored when creating a OperationsGroup.
650
+ * @readonly
651
+ */
652
+ revision?: string | null;
653
+ /**
654
+ * Date and time the OperationsGroup was created.
655
+ * @readonly
656
+ */
657
+ _createdDate?: Date | null;
658
+ /**
659
+ * Date and time the OperationsGroup was last updated.
660
+ * @readonly
661
+ */
662
+ _updatedDate?: Date | null;
663
+ /**
664
+ * The name of the operations group
665
+ * @minLength 1
666
+ * @maxLength 500
667
+ */
668
+ name?: string | null;
669
+ /** Data Extensions */
670
+ extendedFields?: ExtendedFields;
671
+ /** Tags */
672
+ tags?: Tags;
673
+ }
674
+ /**
675
+ * Deletes a OperationGroup.
676
+ *
677
+ *
678
+ * Deleting a OperationGroup permanently removes them from the OperationGroup List.
679
+ * @param operationGroupId - Id of the OperationGroup to delete.
680
+ * @public
681
+ * @documentationMaturity preview
682
+ * @requiredField operationGroupId
683
+ * @permissionId RESTAURANTS.OPERATION_GROUP_DELETE
684
+ * @permissionScope Manage Restaurants - all permissions
685
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
686
+ * @applicableIdentity APP
687
+ * @fqn wix.restaurants.v1.OperationGroupService.DeleteOperationGroup
688
+ */
689
+ export declare function deleteOperationGroup(operationGroupId: string): Promise<void>;
690
+ /**
691
+ * Retrieves a list of OperationGroups.
692
+ * @public
693
+ * @documentationMaturity preview
694
+ * @permissionScope Manage Restaurants - all permissions
695
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
696
+ * @permissionId RESTAURANTS.OPERATION_GROUP_READ
697
+ * @applicableIdentity APP
698
+ * @fqn wix.restaurants.v1.OperationGroupService.QueryOperationGroups
699
+ */
700
+ export declare function queryOperationGroups(): OperationGroupsQueryBuilder;
701
+ interface QueryCursorResult {
702
+ cursors: Cursors;
703
+ hasNext: () => boolean;
704
+ hasPrev: () => boolean;
705
+ length: number;
706
+ pageSize: number;
707
+ }
708
+ export interface OperationGroupsQueryResult extends QueryCursorResult {
709
+ items: OperationGroup[];
710
+ query: OperationGroupsQueryBuilder;
711
+ next: () => Promise<OperationGroupsQueryResult>;
712
+ prev: () => Promise<OperationGroupsQueryResult>;
713
+ }
714
+ export interface OperationGroupsQueryBuilder {
715
+ /** @param propertyName - Property whose value is compared with `value`.
716
+ * @param value - Value to compare against.
717
+ * @documentationMaturity preview
718
+ */
719
+ eq: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => OperationGroupsQueryBuilder;
720
+ /** @param propertyName - Property whose value is compared with `value`.
721
+ * @param value - Value to compare against.
722
+ * @documentationMaturity preview
723
+ */
724
+ ne: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => OperationGroupsQueryBuilder;
725
+ /** @param propertyName - Property whose value is compared with `value`.
726
+ * @param value - Value to compare against.
727
+ * @documentationMaturity preview
728
+ */
729
+ ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => OperationGroupsQueryBuilder;
730
+ /** @param propertyName - Property whose value is compared with `value`.
731
+ * @param value - Value to compare against.
732
+ * @documentationMaturity preview
733
+ */
734
+ gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => OperationGroupsQueryBuilder;
735
+ /** @param propertyName - Property whose value is compared with `value`.
736
+ * @param value - Value to compare against.
737
+ * @documentationMaturity preview
738
+ */
739
+ le: (propertyName: '_createdDate' | '_updatedDate', value: any) => OperationGroupsQueryBuilder;
740
+ /** @param propertyName - Property whose value is compared with `value`.
741
+ * @param value - Value to compare against.
742
+ * @documentationMaturity preview
743
+ */
744
+ lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => OperationGroupsQueryBuilder;
745
+ /** @param propertyName - Property whose value is compared with `string`.
746
+ * @param string - String to compare against. Case-insensitive.
747
+ * @documentationMaturity preview
748
+ */
749
+ startsWith: (propertyName: '_id', value: string) => OperationGroupsQueryBuilder;
750
+ /** @param propertyName - Property whose value is compared with `values`.
751
+ * @param values - List of values to compare against.
752
+ * @documentationMaturity preview
753
+ */
754
+ hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any[]) => OperationGroupsQueryBuilder;
755
+ /** @documentationMaturity preview */
756
+ in: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => OperationGroupsQueryBuilder;
757
+ /** @documentationMaturity preview */
758
+ exists: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: boolean) => OperationGroupsQueryBuilder;
759
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
760
+ * @documentationMaturity preview
761
+ */
762
+ ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate'>) => OperationGroupsQueryBuilder;
763
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
764
+ * @documentationMaturity preview
765
+ */
766
+ descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate'>) => OperationGroupsQueryBuilder;
767
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
768
+ * @documentationMaturity preview
769
+ */
770
+ limit: (limit: number) => OperationGroupsQueryBuilder;
771
+ /** @param cursor - A pointer to specific record
772
+ * @documentationMaturity preview
773
+ */
774
+ skipTo: (cursor: string) => OperationGroupsQueryBuilder;
775
+ /** @documentationMaturity preview */
776
+ find: () => Promise<OperationGroupsQueryResult>;
777
+ }
778
+ /**
779
+ * Updates extended fields of a OperationGroup without incrementing revision
780
+ * @param _id - ID of the entity to update.
781
+ * @param namespace - Identifier for the app whose extended fields are being updated.
782
+ * @public
783
+ * @documentationMaturity preview
784
+ * @requiredField _id
785
+ * @requiredField namespace
786
+ * @requiredField options
787
+ * @requiredField options.namespaceData
788
+ * @permissionId RESTAURANTS.OPERATION_GROUP_UPDATE
789
+ * @permissionScope Manage Restaurants - all permissions
790
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
791
+ * @applicableIdentity APP
792
+ * @fqn wix.restaurants.v1.OperationGroupService.UpdateExtendedFields
793
+ */
794
+ export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
795
+ export interface UpdateExtendedFieldsOptions {
796
+ /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
797
+ namespaceData: Record<string, any> | null;
798
+ }
799
+ /**
800
+ * Create multiple OperationGroups in a single request. Works synchronously.
801
+ * @param operationGroups - List of OperationGroups to be created
802
+ * @public
803
+ * @documentationMaturity preview
804
+ * @requiredField operationGroups
805
+ * @permissionId RESTAURANTS.OPERATION_GROUP_CREATE
806
+ * @permissionScope Manage Restaurants - all permissions
807
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
808
+ * @applicableIdentity APP
809
+ * @fqn wix.restaurants.v1.OperationGroupService.BulkCreateOperationGroups
810
+ */
811
+ export declare function bulkCreateOperationGroups(operationGroups: OperationGroup[], options?: BulkCreateOperationGroupsOptions): Promise<BulkCreateOperationGroupsResponse & BulkCreateOperationGroupsResponseNonNullableFields>;
812
+ export interface BulkCreateOperationGroupsOptions {
813
+ /** set to `true` if you wish to receive back the created OperationGroups in the response */
814
+ returnEntity?: boolean;
815
+ }
816
+ /**
817
+ * Update multiple OperationGroups in a single request. Works synchronously.
818
+ * @param operationGroups - List of OperationGroups to be updated.
819
+ * @public
820
+ * @documentationMaturity preview
821
+ * @requiredField operationGroups
822
+ * @requiredField operationGroups.operationGroup.revision
823
+ * @permissionId RESTAURANTS.OPERATION_GROUP_UPDATE
824
+ * @permissionScope Manage Restaurants - all permissions
825
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
826
+ * @applicableIdentity APP
827
+ * @fqn wix.restaurants.v1.OperationGroupService.BulkUpdateOperationGroups
828
+ */
829
+ export declare function bulkUpdateOperationGroups(operationGroups: MaskedOperationGroup[], options?: BulkUpdateOperationGroupsOptions): Promise<BulkUpdateOperationGroupsResponse & BulkUpdateOperationGroupsResponseNonNullableFields>;
830
+ export interface BulkUpdateOperationGroupsOptions {
831
+ /** set to `true` if you wish to receive back the updated OperationGroups in the response */
832
+ returnEntity?: boolean;
833
+ }
834
+ /**
835
+ * Delete multiple OperationGroups in a single request. Works synchronously.
836
+ * @param operationGroupIds - OperationGroup ids to be deleted
837
+ * @public
838
+ * @documentationMaturity preview
839
+ * @requiredField operationGroupIds
840
+ * @permissionId RESTAURANTS.OPERATION_GROUP_DELETE
841
+ * @permissionScope Manage Restaurants - all permissions
842
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
843
+ * @applicableIdentity APP
844
+ * @fqn wix.restaurants.v1.OperationGroupService.BulkDeleteOperationGroups
845
+ */
846
+ export declare function bulkDeleteOperationGroups(operationGroupIds: string[]): Promise<BulkDeleteOperationGroupsResponse & BulkDeleteOperationGroupsResponseNonNullableFields>;
847
+ /**
848
+ * Synchronously update tags on multiple OperationGroups, by list of operation group ids
849
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
850
+ * @param ids - List of NileProtoTagsEntities that their tags will update.
851
+ * @public
852
+ * @documentationMaturity preview
853
+ * @requiredField ids
854
+ * @permissionId RESTAURANTS.OPERATION_GROUP_UPDATE_TAGS
855
+ * @fqn wix.restaurants.v1.OperationGroupService.BulkUpdateOperationGroupTags
856
+ */
857
+ export declare function bulkUpdateOperationGroupTags(ids: string[], options?: BulkUpdateOperationGroupTagsOptions): Promise<BulkUpdateOperationGroupTagsResponse & BulkUpdateOperationGroupTagsResponseNonNullableFields>;
858
+ export interface BulkUpdateOperationGroupTagsOptions {
859
+ /** List of Tags to assign */
860
+ assignTags?: Tags;
861
+ /** List of Tags to unAssign */
862
+ unassignTags?: Tags;
863
+ }
864
+ /**
865
+ * Asynchronously update tags on multiple OperationGroups, by provided filter
866
+ * An empty filter will update all OperationGroups
867
+ * A tag that appears both in the list of assign and unassign tags, will be assigned
868
+ * @param filter - Filter
869
+ * @public
870
+ * @documentationMaturity preview
871
+ * @requiredField filter
872
+ * @permissionId RESTAURANTS.OPERATION_GROUP_UPDATE_TAGS
873
+ * @fqn wix.restaurants.v1.OperationGroupService.BulkUpdateOperationGroupTagsByFilter
874
+ */
875
+ export declare function bulkUpdateOperationGroupTagsByFilter(filter: Record<string, any> | null, options?: BulkUpdateOperationGroupTagsByFilterOptions): Promise<BulkUpdateOperationGroupTagsByFilterResponse & BulkUpdateOperationGroupTagsByFilterResponseNonNullableFields>;
876
+ export interface BulkUpdateOperationGroupTagsByFilterOptions {
877
+ /** List of Tags to assign */
878
+ assignTags?: Tags;
879
+ /** List of Tags to unAssign */
880
+ unassignTags?: Tags;
881
+ }
882
+ export {};