@wix/papyrus 1.0.19 → 1.0.21

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 (46) hide show
  1. package/build/cjs/index.d.ts +8 -3
  2. package/build/cjs/index.js +41 -27
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/meta.d.ts +4 -2
  5. package/build/cjs/meta.js +41 -26
  6. package/build/cjs/meta.js.map +1 -1
  7. package/build/cjs/schemas.d.ts +4 -1
  8. package/build/cjs/schemas.js +41 -25
  9. package/build/cjs/schemas.js.map +1 -1
  10. package/build/es/index.d.mts +8 -0
  11. package/build/es/index.mjs +8 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/es/meta.d.mts +4 -0
  14. package/build/es/meta.mjs +8 -0
  15. package/build/es/meta.mjs.map +1 -0
  16. package/build/es/package.json +3 -0
  17. package/build/es/schemas.d.mts +4 -0
  18. package/build/es/schemas.mjs +8 -0
  19. package/build/es/schemas.mjs.map +1 -0
  20. package/build/internal/cjs/index.d.ts +8 -0
  21. package/build/internal/cjs/meta.d.ts +4 -0
  22. package/build/internal/cjs/schemas.d.ts +4 -0
  23. package/build/internal/es/index.d.mts +8 -0
  24. package/build/internal/es/meta.d.mts +4 -0
  25. package/build/internal/es/schemas.d.mts +4 -0
  26. package/package.json +31 -24
  27. package/build/cjs/context.d.ts +0 -1
  28. package/build/cjs/context.js +0 -28
  29. package/build/cjs/context.js.map +0 -1
  30. package/build/es/context.d.ts +0 -1
  31. package/build/es/context.js +0 -2
  32. package/build/es/context.js.map +0 -1
  33. package/build/es/index.d.ts +0 -3
  34. package/build/es/index.js +0 -4
  35. package/build/es/index.js.map +0 -1
  36. package/build/es/meta.d.ts +0 -2
  37. package/build/es/meta.js +0 -3
  38. package/build/es/meta.js.map +0 -1
  39. package/build/es/schemas.d.ts +0 -1
  40. package/build/es/schemas.js +0 -2
  41. package/build/es/schemas.js.map +0 -1
  42. package/context/package.json +0 -7
  43. package/type-bundles/context.bundle.d.ts +0 -986
  44. package/type-bundles/index.bundle.d.ts +0 -3694
  45. package/type-bundles/meta.bundle.d.ts +0 -2057
  46. package/type-bundles/schemas.bundle.d.ts +0 -2460
@@ -1,2057 +0,0 @@
1
- /** Document is the main entity of DocumentService. */
2
- interface Document$1 {
3
- /**
4
- * Document ID.
5
- * @readonly
6
- */
7
- id?: string | null;
8
- /**
9
- * Represents the time this Document was created.
10
- * @readonly
11
- */
12
- createdDate?: Date;
13
- /**
14
- * Represents the time this Document was last updated.
15
- * @readonly
16
- */
17
- updatedDate?: Date;
18
- /**
19
- * Document render status.
20
- * @readonly
21
- */
22
- renderStatus?: RenderStatus$1;
23
- /**
24
- * URL to download document. Returned only when Document is in `READY` state.
25
- * @readonly
26
- */
27
- downloadUrl?: string | null;
28
- /** Template ID. When this parameter used the document will be rendered with this template default settings */
29
- templateId?: string | null;
30
- /** Unique per tenant external ID, for example order number. Used to retrieve Document later. */
31
- externalId?: string | null;
32
- /** Unique per tenant template external ID, for example ticket definition ID. Used to lookup corresponding template & template settings. */
33
- templateSettingsExternalId?: string | null;
34
- /** Template settings ID. */
35
- templateSettingsId?: string | null;
36
- /** The app slug of the template */
37
- appSlug?: string | null;
38
- /** The type of the template. */
39
- templateType?: string | null;
40
- /** Document content that is injected into template. */
41
- content?: DocumentContent$1;
42
- /** Number of hours after which document will be eventually expired and its content erased. */
43
- expiresInHours?: number;
44
- /**
45
- * Represents the time this document becomes expired.
46
- * @readonly
47
- */
48
- expirationDate?: Date;
49
- /** Document format. Defaults to `PDF`. */
50
- format?: Format$1;
51
- /**
52
- * Whether the link to the uploaded document is public or private.
53
- * For public document static URL will be returned.
54
- * For private document temporary URL will be generated by DocumentService.DownloadDocument.
55
- */
56
- public?: boolean | null;
57
- /** Optional filename (without extension) to be used for the downloadable document. */
58
- fileName?: string | null;
59
- /** Client defined content checksum. Can be used for content comparison. */
60
- contentChecksum?: string | null;
61
- /** Rendering notification config. */
62
- renderDelayedEventConfig?: RenderDelayedEventConfig$1;
63
- }
64
- declare enum RenderStatus$1 {
65
- UNKNOWN = "UNKNOWN",
66
- /** Document was accepted and is waiting to be rendered. */
67
- ACCEPTED = "ACCEPTED",
68
- /** Rendering is in progress. */
69
- RENDERING = "RENDERING",
70
- /** Rendering finished successfully and document is ready to download. */
71
- READY = "READY",
72
- /** Rendering failed. */
73
- FAILED = "FAILED",
74
- /** Rendered document expired and is no longer available for download. */
75
- EXPIRED = "EXPIRED"
76
- }
77
- interface DocumentContent$1 {
78
- /** Document pages. Each page is reference as $page. */
79
- pages?: Record<string, any>[] | null;
80
- /** Other document content referenced by $content variable */
81
- content?: Record<string, any> | null;
82
- /** ISO 639-1 language code of content (used in translations). */
83
- language?: string;
84
- /** IETF BCP 47 language tag (e.g. en-US). */
85
- locale?: string | null;
86
- }
87
- declare enum Format$1 {
88
- UNKNOWN = "UNKNOWN",
89
- PDF = "PDF"
90
- }
91
- declare enum WixMpClientVersion$1 {
92
- UNKNOWN = "UNKNOWN",
93
- MP_V1 = "MP_V1",
94
- MP_V2 = "MP_V2"
95
- }
96
- interface RenderDelayedEventConfig$1 {
97
- /**
98
- * Controls DocumentRenderDelayed action event sending.
99
- * Event will be sent after time_in_queue_minutes if document render status is ACCEPTED/RENDERING.
100
- */
101
- timeInQueueMinutes?: number;
102
- }
103
- interface GetDownloadPageRequest$1 {
104
- file: string | null;
105
- }
106
- interface RawHttpResponse$1 {
107
- body?: Uint8Array;
108
- statusCode?: number | null;
109
- headers?: HeadersEntry$1[];
110
- }
111
- interface HeadersEntry$1 {
112
- key?: string;
113
- value?: string;
114
- }
115
- interface CreateDocumentRequest$1 {
116
- /** Document to be created */
117
- document?: Document$1;
118
- }
119
- interface CreateDocumentResponse$1 {
120
- /** The created Document */
121
- document?: Document$1;
122
- }
123
- interface GetDocumentRequest$1 {
124
- /** ID of the Document to retrieve */
125
- documentId: string;
126
- fields?: RequestedFields$1[];
127
- }
128
- declare enum RequestedFields$1 {
129
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
130
- /** Include `documentContent` in the response. */
131
- DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
132
- }
133
- interface GetDocumentResponse$1 {
134
- /** The retrieved Document */
135
- document?: Document$1;
136
- }
137
- interface DeleteDocumentRequest$1 {
138
- /** ID of the Document to delete */
139
- documentId: string;
140
- }
141
- interface DeleteDocumentResponse$1 {
142
- /** Deleted document. */
143
- document?: Document$1;
144
- }
145
- interface QueryDocumentRequest$1 {
146
- /** WQL expression */
147
- query: QueryV2$3;
148
- fields?: RequestedFields$1[];
149
- }
150
- interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {
151
- /** Paging options to limit and skip the number of items. */
152
- paging?: Paging$3;
153
- /** 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`. */
154
- cursorPaging?: CursorPaging$3;
155
- /**
156
- * Filter object.
157
- *
158
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
159
- */
160
- filter?: Record<string, any> | null;
161
- /**
162
- * Sort object.
163
- *
164
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
165
- */
166
- sort?: Sorting$3[];
167
- /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
168
- fields?: string[];
169
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
170
- fieldsets?: string[];
171
- }
172
- /** @oneof */
173
- interface QueryV2PagingMethodOneOf$3 {
174
- /** Paging options to limit and skip the number of items. */
175
- paging?: Paging$3;
176
- /** 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`. */
177
- cursorPaging?: CursorPaging$3;
178
- }
179
- interface Sorting$3 {
180
- /** Name of the field to sort by. */
181
- fieldName?: string;
182
- /** Sort order. */
183
- order?: SortOrder$3;
184
- }
185
- declare enum SortOrder$3 {
186
- ASC = "ASC",
187
- DESC = "DESC"
188
- }
189
- interface Paging$3 {
190
- /** Number of items to load. */
191
- limit?: number | null;
192
- /** Number of items to skip in the current sort order. */
193
- offset?: number | null;
194
- }
195
- interface CursorPaging$3 {
196
- /** Maximum number of items to return in the results. */
197
- limit?: number | null;
198
- /**
199
- * Pointer to the next or previous page in the list of results.
200
- *
201
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
202
- * Not relevant for the first request.
203
- */
204
- cursor?: string | null;
205
- }
206
- interface QueryDocumentResponse$1 {
207
- /** The retrieved Documents */
208
- documents?: Document$1[];
209
- /** Query results' metadata */
210
- metadata?: PagingMetadataV2$3;
211
- }
212
- interface PagingMetadataV2$3 {
213
- /** Number of items returned in the response. */
214
- count?: number | null;
215
- /** Offset that was requested. */
216
- offset?: number | null;
217
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
218
- total?: number | null;
219
- /** Flag that indicates the server failed to calculate the `total` field. */
220
- tooManyToCount?: boolean | null;
221
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
222
- cursors?: Cursors$3;
223
- }
224
- interface Cursors$3 {
225
- /** Cursor string pointing to the next page in the list of results. */
226
- next?: string | null;
227
- /** Cursor pointing to the previous page in the list of results. */
228
- prev?: string | null;
229
- }
230
- interface UpdateDocumentRequest$1 {
231
- /**
232
- * Document ID.
233
- * @readonly
234
- */
235
- id: string | null;
236
- /** Document render status. */
237
- renderStatus?: RenderStatus$1;
238
- /** Rendered document file. */
239
- file?: DocumentFile$1;
240
- /** Rendered document source HTML file. */
241
- sourceFile?: DocumentFile$1;
242
- }
243
- interface DocumentFile$1 {
244
- /** File ID. */
245
- fileId?: string | null;
246
- /** File URL. Defined only for public documents. */
247
- staticUrl?: string | null;
248
- /** File path. */
249
- filePath?: string | null;
250
- }
251
- interface UpdateDocumentResponse$1 {
252
- /** The created Document */
253
- document?: Document$1;
254
- }
255
- interface DownloadDocumentRequest$1 {
256
- /** ID of the Document to retrieve */
257
- documentId: string;
258
- /** URL expiration time. Only relevant for private documents. */
259
- urlExpirationInSeconds?: number | null;
260
- }
261
- interface DownloadDocumentResponse$1 {
262
- /** Download URL. */
263
- downloadUrl?: string;
264
- /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
265
- expirationDate?: Date;
266
- }
267
- interface GetDownloadUrlRequest$1 extends GetDownloadUrlRequestDocumentOneOf$1 {
268
- /** ID of the Document to retrieve */
269
- documentId?: string | null;
270
- /** ID of the Document to retrieve */
271
- externalId?: string | null;
272
- /** Signed file token */
273
- fileToken?: string | null;
274
- /** URL expiration time. Only relevant for private documents. */
275
- urlExpirationInSeconds?: number | null;
276
- }
277
- /** @oneof */
278
- interface GetDownloadUrlRequestDocumentOneOf$1 {
279
- /** ID of the Document to retrieve */
280
- documentId?: string | null;
281
- /** ID of the Document to retrieve */
282
- externalId?: string | null;
283
- /** Signed file token */
284
- fileToken?: string | null;
285
- }
286
- interface GetDownloadUrlResponse$1 {
287
- /** Download URL. */
288
- downloadUrl?: string | null;
289
- /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
290
- expirationDate?: Date;
291
- /** Document ID. */
292
- documentId?: string | null;
293
- /** Document render status. */
294
- renderStatus?: RenderStatus$1;
295
- /** Download URL. */
296
- downloadPageUrl?: string | null;
297
- }
298
- interface DownloadDocumentSourceRequest$1 {
299
- /** ID of the Document to retrieve */
300
- documentId: string;
301
- }
302
- interface DownloadDocumentSourceResponse$1 {
303
- /** Download URL. Expires after 10 minutes. */
304
- downloadUrl?: string;
305
- }
306
- interface HeadersEntryNonNullableFields$1 {
307
- key: string;
308
- value: string;
309
- }
310
- interface RawHttpResponseNonNullableFields$1 {
311
- body: Uint8Array;
312
- headers: HeadersEntryNonNullableFields$1[];
313
- }
314
- interface DocumentContentNonNullableFields$1 {
315
- language: string;
316
- }
317
- interface TemplateSettingsOverrideNonNullableFields$1 {
318
- pageIndices: number[];
319
- }
320
- interface PageSettingsNonNullableFields$1 {
321
- pageIndices: number[];
322
- }
323
- interface RenderDelayedEventConfigNonNullableFields$1 {
324
- timeInQueueMinutes: number;
325
- }
326
- interface DocumentNonNullableFields$1 {
327
- renderStatus: RenderStatus$1;
328
- content?: DocumentContentNonNullableFields$1;
329
- expiresInHours: number;
330
- format: Format$1;
331
- templateSettings: TemplateSettingsOverrideNonNullableFields$1[];
332
- pageSettings: PageSettingsNonNullableFields$1[];
333
- wixMpClientVersion: WixMpClientVersion$1;
334
- renderDelayedEventConfig?: RenderDelayedEventConfigNonNullableFields$1;
335
- }
336
- interface CreateDocumentResponseNonNullableFields$1 {
337
- document?: DocumentNonNullableFields$1;
338
- }
339
- interface GetDocumentResponseNonNullableFields$1 {
340
- document?: DocumentNonNullableFields$1;
341
- }
342
- interface DeleteDocumentResponseNonNullableFields$1 {
343
- document?: DocumentNonNullableFields$1;
344
- }
345
- interface QueryDocumentResponseNonNullableFields$1 {
346
- documents: DocumentNonNullableFields$1[];
347
- }
348
- interface UpdateDocumentResponseNonNullableFields$1 {
349
- document?: DocumentNonNullableFields$1;
350
- }
351
- interface DownloadDocumentResponseNonNullableFields$1 {
352
- downloadUrl: string;
353
- }
354
- interface GetDownloadUrlResponseNonNullableFields$1 {
355
- renderStatus: RenderStatus$1;
356
- }
357
- interface DownloadDocumentSourceResponseNonNullableFields$1 {
358
- downloadUrl: string;
359
- }
360
-
361
- /** Document is the main entity of DocumentService. */
362
- interface Document {
363
- /**
364
- * Document ID.
365
- * @readonly
366
- */
367
- _id?: string | null;
368
- /**
369
- * Represents the time this Document was created.
370
- * @readonly
371
- */
372
- _createdDate?: Date;
373
- /**
374
- * Represents the time this Document was last updated.
375
- * @readonly
376
- */
377
- _updatedDate?: Date;
378
- /**
379
- * Document render status.
380
- * @readonly
381
- */
382
- renderStatus?: RenderStatus;
383
- /**
384
- * URL to download document. Returned only when Document is in `READY` state.
385
- * @readonly
386
- */
387
- downloadUrl?: string | null;
388
- /** Template ID. When this parameter used the document will be rendered with this template default settings */
389
- templateId?: string | null;
390
- /** Unique per tenant external ID, for example order number. Used to retrieve Document later. */
391
- externalId?: string | null;
392
- /** Unique per tenant template external ID, for example ticket definition ID. Used to lookup corresponding template & template settings. */
393
- templateSettingsExternalId?: string | null;
394
- /** Template settings ID. */
395
- templateSettingsId?: string | null;
396
- /** The app slug of the template */
397
- appSlug?: string | null;
398
- /** The type of the template. */
399
- templateType?: string | null;
400
- /** Document content that is injected into template. */
401
- content?: DocumentContent;
402
- /** Number of hours after which document will be eventually expired and its content erased. */
403
- expiresInHours?: number;
404
- /**
405
- * Represents the time this document becomes expired.
406
- * @readonly
407
- */
408
- expirationDate?: Date;
409
- /** Document format. Defaults to `PDF`. */
410
- format?: Format;
411
- /**
412
- * Whether the link to the uploaded document is public or private.
413
- * For public document static URL will be returned.
414
- * For private document temporary URL will be generated by DocumentService.DownloadDocument.
415
- */
416
- public?: boolean | null;
417
- /** Optional filename (without extension) to be used for the downloadable document. */
418
- fileName?: string | null;
419
- /** Client defined content checksum. Can be used for content comparison. */
420
- contentChecksum?: string | null;
421
- /** Rendering notification config. */
422
- renderDelayedEventConfig?: RenderDelayedEventConfig;
423
- }
424
- declare enum RenderStatus {
425
- UNKNOWN = "UNKNOWN",
426
- /** Document was accepted and is waiting to be rendered. */
427
- ACCEPTED = "ACCEPTED",
428
- /** Rendering is in progress. */
429
- RENDERING = "RENDERING",
430
- /** Rendering finished successfully and document is ready to download. */
431
- READY = "READY",
432
- /** Rendering failed. */
433
- FAILED = "FAILED",
434
- /** Rendered document expired and is no longer available for download. */
435
- EXPIRED = "EXPIRED"
436
- }
437
- interface DocumentContent {
438
- /** Document pages. Each page is reference as $page. */
439
- pages?: Record<string, any>[] | null;
440
- /** Other document content referenced by $content variable */
441
- content?: Record<string, any> | null;
442
- /** ISO 639-1 language code of content (used in translations). */
443
- language?: string;
444
- /** IETF BCP 47 language tag (e.g. en-US). */
445
- locale?: string | null;
446
- }
447
- declare enum Format {
448
- UNKNOWN = "UNKNOWN",
449
- PDF = "PDF"
450
- }
451
- declare enum WixMpClientVersion {
452
- UNKNOWN = "UNKNOWN",
453
- MP_V1 = "MP_V1",
454
- MP_V2 = "MP_V2"
455
- }
456
- interface RenderDelayedEventConfig {
457
- /**
458
- * Controls DocumentRenderDelayed action event sending.
459
- * Event will be sent after time_in_queue_minutes if document render status is ACCEPTED/RENDERING.
460
- */
461
- timeInQueueMinutes?: number;
462
- }
463
- interface GetDownloadPageRequest {
464
- file: string | null;
465
- }
466
- interface RawHttpResponse {
467
- body?: Uint8Array;
468
- statusCode?: number | null;
469
- headers?: HeadersEntry[];
470
- }
471
- interface HeadersEntry {
472
- key?: string;
473
- value?: string;
474
- }
475
- interface CreateDocumentRequest {
476
- /** Document to be created */
477
- document?: Document;
478
- }
479
- interface CreateDocumentResponse {
480
- /** The created Document */
481
- document?: Document;
482
- }
483
- interface GetDocumentRequest {
484
- /** ID of the Document to retrieve */
485
- documentId: string;
486
- fields?: RequestedFields[];
487
- }
488
- declare enum RequestedFields {
489
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
490
- /** Include `documentContent` in the response. */
491
- DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
492
- }
493
- interface GetDocumentResponse {
494
- /** The retrieved Document */
495
- document?: Document;
496
- }
497
- interface DeleteDocumentRequest {
498
- /** ID of the Document to delete */
499
- documentId: string;
500
- }
501
- interface DeleteDocumentResponse {
502
- /** Deleted document. */
503
- document?: Document;
504
- }
505
- interface QueryDocumentRequest {
506
- /** WQL expression */
507
- query: QueryV2$2;
508
- fields?: RequestedFields[];
509
- }
510
- interface QueryV2$2 extends QueryV2PagingMethodOneOf$2 {
511
- /** Paging options to limit and skip the number of items. */
512
- paging?: Paging$2;
513
- /** 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`. */
514
- cursorPaging?: CursorPaging$2;
515
- /**
516
- * Filter object.
517
- *
518
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
519
- */
520
- filter?: Record<string, any> | null;
521
- /**
522
- * Sort object.
523
- *
524
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
525
- */
526
- sort?: Sorting$2[];
527
- /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
528
- fields?: string[];
529
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
530
- fieldsets?: string[];
531
- }
532
- /** @oneof */
533
- interface QueryV2PagingMethodOneOf$2 {
534
- /** Paging options to limit and skip the number of items. */
535
- paging?: Paging$2;
536
- /** 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`. */
537
- cursorPaging?: CursorPaging$2;
538
- }
539
- interface Sorting$2 {
540
- /** Name of the field to sort by. */
541
- fieldName?: string;
542
- /** Sort order. */
543
- order?: SortOrder$2;
544
- }
545
- declare enum SortOrder$2 {
546
- ASC = "ASC",
547
- DESC = "DESC"
548
- }
549
- interface Paging$2 {
550
- /** Number of items to load. */
551
- limit?: number | null;
552
- /** Number of items to skip in the current sort order. */
553
- offset?: number | null;
554
- }
555
- interface CursorPaging$2 {
556
- /** Maximum number of items to return in the results. */
557
- limit?: number | null;
558
- /**
559
- * Pointer to the next or previous page in the list of results.
560
- *
561
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
562
- * Not relevant for the first request.
563
- */
564
- cursor?: string | null;
565
- }
566
- interface QueryDocumentResponse {
567
- /** The retrieved Documents */
568
- documents?: Document[];
569
- /** Query results' metadata */
570
- metadata?: PagingMetadataV2$2;
571
- }
572
- interface PagingMetadataV2$2 {
573
- /** Number of items returned in the response. */
574
- count?: number | null;
575
- /** Offset that was requested. */
576
- offset?: number | null;
577
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
578
- total?: number | null;
579
- /** Flag that indicates the server failed to calculate the `total` field. */
580
- tooManyToCount?: boolean | null;
581
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
582
- cursors?: Cursors$2;
583
- }
584
- interface Cursors$2 {
585
- /** Cursor string pointing to the next page in the list of results. */
586
- next?: string | null;
587
- /** Cursor pointing to the previous page in the list of results. */
588
- prev?: string | null;
589
- }
590
- interface UpdateDocumentRequest {
591
- /**
592
- * Document ID.
593
- * @readonly
594
- */
595
- _id: string | null;
596
- /** Document render status. */
597
- renderStatus?: RenderStatus;
598
- /** Rendered document file. */
599
- file?: DocumentFile;
600
- /** Rendered document source HTML file. */
601
- sourceFile?: DocumentFile;
602
- }
603
- interface DocumentFile {
604
- /** File ID. */
605
- fileId?: string | null;
606
- /** File URL. Defined only for public documents. */
607
- staticUrl?: string | null;
608
- /** File path. */
609
- filePath?: string | null;
610
- }
611
- interface UpdateDocumentResponse {
612
- /** The created Document */
613
- document?: Document;
614
- }
615
- interface DownloadDocumentRequest {
616
- /** ID of the Document to retrieve */
617
- documentId: string;
618
- /** URL expiration time. Only relevant for private documents. */
619
- urlExpirationInSeconds?: number | null;
620
- }
621
- interface DownloadDocumentResponse {
622
- /** Download URL. */
623
- downloadUrl?: string;
624
- /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
625
- expirationDate?: Date;
626
- }
627
- interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
628
- /** ID of the Document to retrieve */
629
- documentId?: string | null;
630
- /** ID of the Document to retrieve */
631
- externalId?: string | null;
632
- /** Signed file token */
633
- fileToken?: string | null;
634
- /** URL expiration time. Only relevant for private documents. */
635
- urlExpirationInSeconds?: number | null;
636
- }
637
- /** @oneof */
638
- interface GetDownloadUrlRequestDocumentOneOf {
639
- /** ID of the Document to retrieve */
640
- documentId?: string | null;
641
- /** ID of the Document to retrieve */
642
- externalId?: string | null;
643
- /** Signed file token */
644
- fileToken?: string | null;
645
- }
646
- interface GetDownloadUrlResponse {
647
- /** Download URL. */
648
- downloadUrl?: string | null;
649
- /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
650
- expirationDate?: Date;
651
- /** Document ID. */
652
- documentId?: string | null;
653
- /** Document render status. */
654
- renderStatus?: RenderStatus;
655
- /** Download URL. */
656
- downloadPageUrl?: string | null;
657
- }
658
- interface DownloadDocumentSourceRequest {
659
- /** ID of the Document to retrieve */
660
- documentId: string;
661
- }
662
- interface DownloadDocumentSourceResponse {
663
- /** Download URL. Expires after 10 minutes. */
664
- downloadUrl?: string;
665
- }
666
- interface HeadersEntryNonNullableFields {
667
- key: string;
668
- value: string;
669
- }
670
- interface RawHttpResponseNonNullableFields {
671
- body: Uint8Array;
672
- headers: HeadersEntryNonNullableFields[];
673
- }
674
- interface DocumentContentNonNullableFields {
675
- language: string;
676
- }
677
- interface TemplateSettingsOverrideNonNullableFields {
678
- pageIndices: number[];
679
- }
680
- interface PageSettingsNonNullableFields {
681
- pageIndices: number[];
682
- }
683
- interface RenderDelayedEventConfigNonNullableFields {
684
- timeInQueueMinutes: number;
685
- }
686
- interface DocumentNonNullableFields {
687
- renderStatus: RenderStatus;
688
- content?: DocumentContentNonNullableFields;
689
- expiresInHours: number;
690
- format: Format;
691
- templateSettings: TemplateSettingsOverrideNonNullableFields[];
692
- pageSettings: PageSettingsNonNullableFields[];
693
- wixMpClientVersion: WixMpClientVersion;
694
- renderDelayedEventConfig?: RenderDelayedEventConfigNonNullableFields;
695
- }
696
- interface CreateDocumentResponseNonNullableFields {
697
- document?: DocumentNonNullableFields;
698
- }
699
- interface GetDocumentResponseNonNullableFields {
700
- document?: DocumentNonNullableFields;
701
- }
702
- interface DeleteDocumentResponseNonNullableFields {
703
- document?: DocumentNonNullableFields;
704
- }
705
- interface QueryDocumentResponseNonNullableFields {
706
- documents: DocumentNonNullableFields[];
707
- }
708
- interface UpdateDocumentResponseNonNullableFields {
709
- document?: DocumentNonNullableFields;
710
- }
711
- interface DownloadDocumentResponseNonNullableFields {
712
- downloadUrl: string;
713
- }
714
- interface GetDownloadUrlResponseNonNullableFields {
715
- renderStatus: RenderStatus;
716
- }
717
- interface DownloadDocumentSourceResponseNonNullableFields {
718
- downloadUrl: string;
719
- }
720
-
721
- type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
722
- getUrl: (context: any) => string;
723
- httpMethod: K;
724
- path: string;
725
- pathParams: M;
726
- __requestType: T;
727
- __originalRequestType: S;
728
- __responseType: Q;
729
- __originalResponseType: R;
730
- };
731
- declare function getDownloadPage(): __PublicMethodMetaInfo$1<'GET', {}, GetDownloadPageRequest, GetDownloadPageRequest$1, RawHttpResponse & RawHttpResponseNonNullableFields, RawHttpResponse$1 & RawHttpResponseNonNullableFields$1>;
732
- declare function createDocument(): __PublicMethodMetaInfo$1<'POST', {}, CreateDocumentRequest, CreateDocumentRequest$1, CreateDocumentResponse & CreateDocumentResponseNonNullableFields, CreateDocumentResponse$1 & CreateDocumentResponseNonNullableFields$1>;
733
- declare function getDocument(): __PublicMethodMetaInfo$1<'GET', {
734
- documentId: string;
735
- }, GetDocumentRequest, GetDocumentRequest$1, GetDocumentResponse & GetDocumentResponseNonNullableFields, GetDocumentResponse$1 & GetDocumentResponseNonNullableFields$1>;
736
- declare function deleteDocument(): __PublicMethodMetaInfo$1<'DELETE', {
737
- documentId: string;
738
- }, DeleteDocumentRequest, DeleteDocumentRequest$1, DeleteDocumentResponse & DeleteDocumentResponseNonNullableFields, DeleteDocumentResponse$1 & DeleteDocumentResponseNonNullableFields$1>;
739
- declare function queryDocument(): __PublicMethodMetaInfo$1<'POST', {}, QueryDocumentRequest, QueryDocumentRequest$1, QueryDocumentResponse & QueryDocumentResponseNonNullableFields, QueryDocumentResponse$1 & QueryDocumentResponseNonNullableFields$1>;
740
- declare function updateDocument(): __PublicMethodMetaInfo$1<'PATCH', {
741
- id: string;
742
- }, UpdateDocumentRequest, UpdateDocumentRequest$1, UpdateDocumentResponse & UpdateDocumentResponseNonNullableFields, UpdateDocumentResponse$1 & UpdateDocumentResponseNonNullableFields$1>;
743
- declare function downloadDocument(): __PublicMethodMetaInfo$1<'GET', {
744
- documentId: string;
745
- }, DownloadDocumentRequest, DownloadDocumentRequest$1, DownloadDocumentResponse & DownloadDocumentResponseNonNullableFields, DownloadDocumentResponse$1 & DownloadDocumentResponseNonNullableFields$1>;
746
- declare function getDownloadUrl(): __PublicMethodMetaInfo$1<'GET', {}, GetDownloadUrlRequest, GetDownloadUrlRequest$1, GetDownloadUrlResponse & GetDownloadUrlResponseNonNullableFields, GetDownloadUrlResponse$1 & GetDownloadUrlResponseNonNullableFields$1>;
747
- declare function downloadDocumentSource(): __PublicMethodMetaInfo$1<'GET', {
748
- documentId: string;
749
- }, DownloadDocumentSourceRequest, DownloadDocumentSourceRequest$1, DownloadDocumentSourceResponse & DownloadDocumentSourceResponseNonNullableFields, DownloadDocumentSourceResponse$1 & DownloadDocumentSourceResponseNonNullableFields$1>;
750
-
751
- declare const meta_d_createDocument: typeof createDocument;
752
- declare const meta_d_deleteDocument: typeof deleteDocument;
753
- declare const meta_d_downloadDocument: typeof downloadDocument;
754
- declare const meta_d_downloadDocumentSource: typeof downloadDocumentSource;
755
- declare const meta_d_getDocument: typeof getDocument;
756
- declare const meta_d_getDownloadPage: typeof getDownloadPage;
757
- declare const meta_d_getDownloadUrl: typeof getDownloadUrl;
758
- declare const meta_d_queryDocument: typeof queryDocument;
759
- declare const meta_d_updateDocument: typeof updateDocument;
760
- declare namespace meta_d {
761
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta_d_createDocument as createDocument, meta_d_deleteDocument as deleteDocument, meta_d_downloadDocument as downloadDocument, meta_d_downloadDocumentSource as downloadDocumentSource, meta_d_getDocument as getDocument, meta_d_getDownloadPage as getDownloadPage, meta_d_getDownloadUrl as getDownloadUrl, meta_d_queryDocument as queryDocument, meta_d_updateDocument as updateDocument };
762
- }
763
-
764
- interface TemplateSettings$1 {
765
- /**
766
- * Auto generated ID.
767
- * @format GUID
768
- * @readonly
769
- */
770
- id?: string | null;
771
- /**
772
- * Wix app definition ID.
773
- * @minLength 1
774
- * @maxLength 20
775
- */
776
- appSlug?: string | null;
777
- /**
778
- * The type of the template.
779
- * @minLength 1
780
- * @maxLength 20
781
- */
782
- templateType?: string | null;
783
- /**
784
- * The id of the template.
785
- * @minLength 1
786
- * @maxLength 20
787
- */
788
- templateId?: string | null;
789
- /**
790
- * Template settings external ID. For example ticket definition ID.
791
- * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
792
- * @minLength 1
793
- * @maxLength 100
794
- */
795
- externalId?: string | null;
796
- /**
797
- * Date settings were created.
798
- * @readonly
799
- */
800
- createdDate?: Date | null;
801
- /**
802
- * Date settings were updated.
803
- * @readonly
804
- */
805
- updatedDate?: Date | null;
806
- /** @maxSize 10 */
807
- settingGroups?: SettingsGroup$1[];
808
- /** Paper size */
809
- paperSize?: PaperSizeWithLiterals$1;
810
- pageOverflow?: PageOverflowWithLiterals$1;
811
- }
812
- interface TextSetting$1 {
813
- /**
814
- * Font family class name
815
- * @maxLength 20
816
- */
817
- fontFamily?: string | null;
818
- /**
819
- * Font style class names
820
- * @maxSize 10
821
- * @maxLength 20
822
- */
823
- fontStyle?: string[];
824
- /**
825
- * Text alignment class name
826
- * @maxLength 20
827
- */
828
- textAlignment?: string | null;
829
- /**
830
- * Text color hex code
831
- * @minLength 7
832
- * @maxLength 7
833
- */
834
- textColor?: string | null;
835
- /**
836
- * Font size
837
- * @min 1
838
- */
839
- fontSize?: number | null;
840
- /** Text content setting */
841
- textContent?: TextContent$1[];
842
- }
843
- interface TextContent$1 {
844
- /**
845
- * @minLength 3
846
- * @maxLength 50
847
- */
848
- id?: string;
849
- /** @maxLength 500 */
850
- value?: string | null;
851
- visible?: boolean;
852
- }
853
- interface ImageSetting$1 {
854
- /** Wix media Image */
855
- image?: Image;
856
- /** Image resizing mode */
857
- resize?: ResizeOptionWithLiterals$1;
858
- }
859
- interface Image {
860
- /** WixMedia image ID. */
861
- id?: string;
862
- /** Image URL. */
863
- url?: string;
864
- /**
865
- * Original image height.
866
- * @readonly
867
- */
868
- height?: number;
869
- /**
870
- * Original image width.
871
- * @readonly
872
- */
873
- width?: number;
874
- /** Image alt text. */
875
- altText?: string | null;
876
- /**
877
- * Image filename.
878
- * @readonly
879
- */
880
- filename?: string | null;
881
- }
882
- interface FocalPoint {
883
- /** X-coordinate of the focal point. */
884
- x?: number;
885
- /** Y-coordinate of the focal point. */
886
- y?: number;
887
- /** crop by height */
888
- height?: number | null;
889
- /** crop by width */
890
- width?: number | null;
891
- }
892
- declare enum ResizeOption$1 {
893
- /** Automatically resizes full image to fit image field */
894
- FIT = "FIT",
895
- /** Enables user to manually crop image to fit image field */
896
- CROP = "CROP"
897
- }
898
- /** @enumType */
899
- type ResizeOptionWithLiterals$1 = ResizeOption$1 | 'FIT' | 'CROP';
900
- interface SelectSetting$1 {
901
- /** Selected value */
902
- value?: string | null;
903
- /**
904
- * Color hex code
905
- * @minLength 7
906
- * @maxLength 7
907
- */
908
- primaryColor?: string | null;
909
- /**
910
- * Color hex code
911
- * @minLength 7
912
- * @maxLength 7
913
- */
914
- secondaryColor?: string | null;
915
- /** Size */
916
- size?: number | null;
917
- }
918
- interface BackgroundSetting$1 {
919
- /**
920
- * Color of the background hex code
921
- * @minLength 7
922
- * @maxLength 9
923
- */
924
- color?: string | null;
925
- /** Wix media Image */
926
- image?: Image;
927
- }
928
- interface SettingsGroup$1 {
929
- /**
930
- * Id of the control group
931
- * @minLength 5
932
- * @maxLength 50
933
- */
934
- groupId?: string;
935
- /**
936
- * Display settings.
937
- * @maxSize 20
938
- */
939
- display?: Record<string, boolean>;
940
- /**
941
- * Texts settings.
942
- * @maxSize 20
943
- */
944
- texts?: Record<string, TextSetting$1>;
945
- /**
946
- * Images settings.
947
- * @maxSize 10
948
- */
949
- images?: Record<string, ImageSetting$1>;
950
- /**
951
- * Select option settings.
952
- * @maxSize 20
953
- */
954
- selects?: Record<string, SelectSetting$1>;
955
- /**
956
- * Backgrounds settings.
957
- * @maxSize 20
958
- */
959
- backgrounds?: Record<string, BackgroundSetting$1>;
960
- }
961
- declare enum PaperSize$1 {
962
- A4_PORTRAIT = "A4_PORTRAIT",
963
- A4_LANDSCAPE = "A4_LANDSCAPE"
964
- }
965
- /** @enumType */
966
- type PaperSizeWithLiterals$1 = PaperSize$1 | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
967
- declare enum PageOverflow$1 {
968
- CONTENT_HIDDEN = "CONTENT_HIDDEN",
969
- CONTENT_BREAK = "CONTENT_BREAK"
970
- }
971
- /** @enumType */
972
- type PageOverflowWithLiterals$1 = PageOverflow$1 | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
973
- interface CreateTemplateSettingsRequest {
974
- /** Settings to be created. */
975
- settings?: TemplateSettings$1;
976
- }
977
- interface CreateTemplateSettingsResponse {
978
- /** Created settings. */
979
- settings?: TemplateSettings$1;
980
- }
981
- interface BulkCreateTemplateSettingsRequest {
982
- /**
983
- * Settings to be created.
984
- * @minSize 1
985
- * @maxSize 100
986
- */
987
- settings?: TemplateSettings$1[];
988
- }
989
- interface BulkCreateTemplateSettingsResponse {
990
- /** Created settings */
991
- settings?: TemplateSettings$1[];
992
- }
993
- interface UpsertTemplateSettingsRequest$1 {
994
- /** Settings to be upserted. */
995
- settings?: TemplateSettings$1;
996
- }
997
- interface UpsertTemplateSettingsResponse$1 {
998
- /** Upserted settings. */
999
- settings?: TemplateSettings$1;
1000
- }
1001
- interface GetTemplateSettingsRequest {
1002
- /**
1003
- * Settings ID.
1004
- * @format GUID
1005
- */
1006
- templateSettingsId?: string;
1007
- }
1008
- interface GetTemplateSettingsResponse {
1009
- /** Retrieved settings. */
1010
- settings?: TemplateSettings$1;
1011
- }
1012
- interface UpdateTemplateSettingsRequest {
1013
- /** Template Settings to be updated. */
1014
- settings?: TemplateSettings$1;
1015
- }
1016
- interface UpdateTemplateSettingsResponse {
1017
- /** Updated settings. */
1018
- settings?: TemplateSettings$1;
1019
- }
1020
- interface DeleteTemplateSettingsRequest {
1021
- /**
1022
- * Settings ID.
1023
- * @format GUID
1024
- */
1025
- templateSettingsId?: string;
1026
- }
1027
- interface DeleteTemplateSettingsResponse {
1028
- /** Deleted settings. */
1029
- settings?: TemplateSettings$1;
1030
- }
1031
- interface QueryTemplateSettingsRequest$1 {
1032
- /** Generic query object. */
1033
- query: QueryV2$1;
1034
- }
1035
- interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
1036
- /** Paging options to limit and offset the number of items. */
1037
- paging?: Paging$1;
1038
- /** 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`. */
1039
- cursorPaging?: CursorPaging$1;
1040
- /**
1041
- * Filter object.
1042
- *
1043
- * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
1044
- */
1045
- filter?: Record<string, any> | null;
1046
- /**
1047
- * Sort object.
1048
- *
1049
- * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
1050
- */
1051
- sort?: Sorting$1[];
1052
- /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
1053
- fields?: string[];
1054
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
1055
- fieldsets?: string[];
1056
- }
1057
- /** @oneof */
1058
- interface QueryV2PagingMethodOneOf$1 {
1059
- /** Paging options to limit and offset the number of items. */
1060
- paging?: Paging$1;
1061
- /** 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`. */
1062
- cursorPaging?: CursorPaging$1;
1063
- }
1064
- interface Sorting$1 {
1065
- /**
1066
- * Name of the field to sort by.
1067
- * @maxLength 512
1068
- */
1069
- fieldName?: string;
1070
- /** Sort order. */
1071
- order?: SortOrderWithLiterals$1;
1072
- /**
1073
- * Origin point for geo-distance sorting on a GEO field
1074
- * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
1075
- */
1076
- origin?: AddressLocation$1;
1077
- }
1078
- declare enum SortOrder$1 {
1079
- ASC = "ASC",
1080
- DESC = "DESC"
1081
- }
1082
- /** @enumType */
1083
- type SortOrderWithLiterals$1 = SortOrder$1 | 'ASC' | 'DESC';
1084
- interface AddressLocation$1 {
1085
- /** Address latitude. */
1086
- latitude?: number | null;
1087
- /** Address longitude. */
1088
- longitude?: number | null;
1089
- }
1090
- interface Paging$1 {
1091
- /** Number of items to load. */
1092
- limit?: number | null;
1093
- /** Number of items to skip in the current sort order. */
1094
- offset?: number | null;
1095
- }
1096
- interface CursorPaging$1 {
1097
- /**
1098
- * Maximum number of items to return in the results.
1099
- * @max 100
1100
- */
1101
- limit?: number | null;
1102
- /**
1103
- * Pointer to the next or previous page in the list of results.
1104
- *
1105
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1106
- * Not relevant for the first request.
1107
- * @maxLength 16000
1108
- */
1109
- cursor?: string | null;
1110
- }
1111
- interface QueryTemplateSettingsResponse$1 {
1112
- /** Template settings results. */
1113
- settings?: TemplateSettings$1[];
1114
- /** Query result's metadata. */
1115
- metadata?: PagingMetadataV2$1;
1116
- }
1117
- interface PagingMetadataV2$1 {
1118
- /** Number of items returned in the response. */
1119
- count?: number | null;
1120
- /** Offset that was requested. */
1121
- offset?: number | null;
1122
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1123
- total?: number | null;
1124
- /** Flag that indicates the server failed to calculate the `total` field. */
1125
- tooManyToCount?: boolean | null;
1126
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1127
- cursors?: Cursors$1;
1128
- }
1129
- interface Cursors$1 {
1130
- /**
1131
- * Cursor string pointing to the next page in the list of results.
1132
- * @maxLength 16000
1133
- */
1134
- next?: string | null;
1135
- /**
1136
- * Cursor pointing to the previous page in the list of results.
1137
- * @maxLength 16000
1138
- */
1139
- prev?: string | null;
1140
- }
1141
- interface ResolveTemplateSettingsRequest$1 {
1142
- /**
1143
- * The id of the settings.
1144
- * @format GUID
1145
- */
1146
- templateSettingsId?: string | null;
1147
- /**
1148
- * External ID.
1149
- * @maxLength 100
1150
- */
1151
- templateSettingsExternalId?: string | null;
1152
- /**
1153
- * The type of the template. Used to resolve default settings.
1154
- * @minLength 1
1155
- * @maxLength 20
1156
- */
1157
- templateType: string | null;
1158
- /**
1159
- * Wix app slug.
1160
- * @minLength 1
1161
- * @maxLength 20
1162
- */
1163
- appSlug: string | null;
1164
- /**
1165
- * The id of template.
1166
- * @minLength 1
1167
- * @maxLength 20
1168
- */
1169
- templateId?: string | null;
1170
- }
1171
- interface ResolveTemplateSettingsResponse$1 {
1172
- /** Retrieved settings. */
1173
- settings?: TemplateSettings$1;
1174
- }
1175
- interface GetTemplateControlsRequest {
1176
- }
1177
- interface GetTemplateControlsResponse {
1178
- templateControls?: TemplateControls;
1179
- }
1180
- interface TemplateControls {
1181
- /**
1182
- * The name of the template
1183
- * @maxLength 50
1184
- */
1185
- templateName?: string;
1186
- /**
1187
- * The controls groups configuration
1188
- * @minSize 1
1189
- * @maxSize 10
1190
- */
1191
- controlGroups?: ControlGroup[];
1192
- }
1193
- /** Represents control groups on the left side of the UI */
1194
- interface ControlGroup {
1195
- /**
1196
- * @minLength 3
1197
- * @maxLength 50
1198
- */
1199
- groupId?: string;
1200
- /**
1201
- * @minLength 3
1202
- * @maxLength 50
1203
- */
1204
- icon?: string;
1205
- /**
1206
- * @minLength 3
1207
- * @maxLength 100
1208
- */
1209
- labelKey?: string;
1210
- /**
1211
- * @minLength 3
1212
- * @maxLength 100
1213
- */
1214
- titleKey?: string;
1215
- /**
1216
- * @minLength 3
1217
- * @maxLength 100
1218
- */
1219
- descriptionKey?: string;
1220
- /** @maxLength 100 */
1221
- linkKey?: string | null;
1222
- /** @maxLength 50 */
1223
- linkUrl?: string | null;
1224
- /** @maxLength 100 */
1225
- tooltipKey?: string | null;
1226
- /**
1227
- * Display controls
1228
- * @maxSize 20
1229
- */
1230
- display?: DisplayControl[];
1231
- /**
1232
- * Text controls
1233
- * @maxSize 20
1234
- */
1235
- texts?: TextControl[];
1236
- /**
1237
- * Image controls
1238
- * @maxSize 10
1239
- */
1240
- images?: ImageControl[];
1241
- /**
1242
- * Select controls
1243
- * @maxSize 20
1244
- */
1245
- selects?: SelectControl[];
1246
- /**
1247
- * Background controls
1248
- * @maxSize 20
1249
- */
1250
- backgrounds?: BackgroundControl[];
1251
- }
1252
- interface DisplayControl {
1253
- /**
1254
- * The id of the setting
1255
- * @maxLength 50
1256
- */
1257
- id?: string;
1258
- /**
1259
- * Optional label key for translations
1260
- * @maxLength 100
1261
- */
1262
- labelKey?: string | null;
1263
- /** Default setting for this control */
1264
- default?: boolean;
1265
- }
1266
- interface TextControl {
1267
- /**
1268
- * The id of the setting
1269
- * @maxLength 50
1270
- */
1271
- id?: string;
1272
- /**
1273
- * Optional label key for translations
1274
- * @maxLength 100
1275
- */
1276
- labelKey?: string | null;
1277
- /** Default setting for this control */
1278
- default?: TextSetting$1;
1279
- /**
1280
- * Text properties
1281
- * @maxSize 5
1282
- */
1283
- textProperties?: TextPropertyControl[];
1284
- /** @maxSize 10 */
1285
- textContent?: TextContentControl[];
1286
- }
1287
- interface TextPropertyControl {
1288
- /**
1289
- * One of "fontFamily", "fontStyle", "fontSize", "textAlignment"
1290
- * @maxLength 15
1291
- */
1292
- type?: string;
1293
- /**
1294
- * Optional label key for translations
1295
- * @maxLength 100
1296
- */
1297
- labelKey?: string | null;
1298
- /**
1299
- * List of possible options. Used for "fontFamily", "fontStyle", "textAlignment"
1300
- * @maxSize 50
1301
- */
1302
- options?: ValueOption[];
1303
- /** Optional range of the value. Used for "fontSize" */
1304
- range?: Range;
1305
- }
1306
- interface ValueOption {
1307
- /**
1308
- * The label key for translations
1309
- * @maxLength 100
1310
- */
1311
- labelKey?: string;
1312
- /**
1313
- * The value
1314
- * @maxLength 20
1315
- */
1316
- value?: string;
1317
- }
1318
- interface Range {
1319
- /** Minimum value. */
1320
- min?: number | null;
1321
- /** Maximum value. */
1322
- max?: number | null;
1323
- }
1324
- interface TextContentControl {
1325
- /**
1326
- * @minLength 3
1327
- * @maxLength 50
1328
- */
1329
- id?: string;
1330
- /**
1331
- * @minLength 3
1332
- * @maxLength 100
1333
- */
1334
- labelKey?: string | null;
1335
- /** @max 1000 */
1336
- maxLength?: number | null;
1337
- }
1338
- interface ImageControl {
1339
- /**
1340
- * The id of the setting
1341
- * @maxLength 50
1342
- */
1343
- id?: string;
1344
- /**
1345
- * Optional label key for translations
1346
- * @maxLength 100
1347
- */
1348
- labelKey?: string | null;
1349
- /** Default setting for this control */
1350
- default?: ImageSetting$1;
1351
- /**
1352
- * Optional description key for translations
1353
- * @maxLength 100
1354
- */
1355
- descriptionKey?: string | null;
1356
- /** Enable logo builder support */
1357
- showLogoBuilder?: boolean;
1358
- }
1359
- interface SelectControl {
1360
- /**
1361
- * The id of the setting
1362
- * @maxLength 50
1363
- */
1364
- id?: string;
1365
- /**
1366
- * Optional label key for translations
1367
- * @maxLength 100
1368
- */
1369
- labelKey?: string | null;
1370
- /** Default setting for this control */
1371
- default?: SelectSetting$1;
1372
- /**
1373
- * List of possible options
1374
- * @minSize 1
1375
- * @maxSize 20
1376
- */
1377
- options?: ValueOption[];
1378
- /** Allows to use primary colour setting from template designer */
1379
- showPrimaryColorPicker?: boolean;
1380
- /** Allows to use secondary colour setting from template designer */
1381
- showSecondaryColorPicker?: boolean;
1382
- /** Allows to use size setting from template designer. */
1383
- showSize?: boolean;
1384
- /** Optional range of the size value. */
1385
- sizeRange?: Range;
1386
- }
1387
- interface BackgroundControl {
1388
- /**
1389
- * The id of the setting
1390
- * @maxLength 50
1391
- */
1392
- id?: string;
1393
- /**
1394
- * Optional label key for translations
1395
- * @maxLength 100
1396
- */
1397
- labelKey?: string | null;
1398
- /** Default setting for this control */
1399
- default?: BackgroundSetting$1;
1400
- /** Allows to use colour setting from template designer */
1401
- showColorPicker?: boolean;
1402
- /** Allows to use image setting from template designer */
1403
- showImagePicker?: boolean;
1404
- /** Enables background opacity control */
1405
- opacityEnabled?: boolean | null;
1406
- /** Enables background image opacity control */
1407
- imageOpacityEnabled?: boolean | null;
1408
- /**
1409
- * Default media manager folder with background images
1410
- * @maxLength 256
1411
- */
1412
- mediaRootFolder?: string | null;
1413
- }
1414
- interface GetTemplateRegistryRequest {
1415
- }
1416
- interface GetTemplateRegistryResponse {
1417
- templateRegistry?: TemplateRegistry;
1418
- }
1419
- interface TemplateRegistry {
1420
- /**
1421
- * Templates.
1422
- * @minSize 1
1423
- * @maxSize 1000
1424
- */
1425
- templates?: WixAppTemplate[];
1426
- }
1427
- /** Defines a template and it's styles. */
1428
- interface WixAppTemplate {
1429
- /** Wix App Id */
1430
- wixAppId?: string;
1431
- /** App Slug */
1432
- appSlug?: string;
1433
- /**
1434
- * Template type.
1435
- * @minLength 1
1436
- * @maxLength 20
1437
- */
1438
- templateType?: string;
1439
- /**
1440
- * Templates
1441
- * @minSize 1
1442
- * @maxSize 1000
1443
- */
1444
- templates?: TemplateStyle[];
1445
- /**
1446
- * Short artifact name (key from template-statics-config.json.erb)
1447
- * @minLength 3
1448
- * @maxLength 64
1449
- * @format SYSTEM_SLUG
1450
- */
1451
- templateArtifactName?: string | null;
1452
- /**
1453
- * Local path
1454
- * @minLength 1
1455
- * @maxLength 200
1456
- * @readonly
1457
- */
1458
- localPath?: string | null;
1459
- /**
1460
- * Statics URL
1461
- * @minLength 1
1462
- * @maxLength 200
1463
- * @readonly
1464
- */
1465
- staticsUrl?: string | null;
1466
- }
1467
- /**
1468
- * Defines a template style.
1469
- *
1470
- * Path to TemplateControls json file:
1471
- * papyrus-templates-lib/
1472
- * src/
1473
- * templates/
1474
- * {app_slug}/
1475
- * {template_type}/
1476
- * {id}/
1477
- * controls.json
1478
- */
1479
- interface TemplateStyle {
1480
- /**
1481
- * The id of the template.
1482
- * @minLength 1
1483
- * @maxLength 20
1484
- */
1485
- id?: string;
1486
- /**
1487
- * Determines which template should be used if user did not choose it yet.
1488
- * Only single template per wix_app_id can be default.
1489
- */
1490
- default?: boolean;
1491
- /** Determines if template cannot be selected for a new entity. */
1492
- inactive?: boolean;
1493
- /** Paper size */
1494
- paperSize?: PaperSizeWithLiterals$1;
1495
- pageOverflow?: PageOverflowWithLiterals$1;
1496
- }
1497
- interface DomainEvent extends DomainEventBodyOneOf {
1498
- createdEvent?: EntityCreatedEvent;
1499
- updatedEvent?: EntityUpdatedEvent;
1500
- deletedEvent?: EntityDeletedEvent;
1501
- actionEvent?: ActionEvent;
1502
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1503
- id?: string;
1504
- /**
1505
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1506
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1507
- */
1508
- entityFqdn?: string;
1509
- /**
1510
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
1511
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1512
- */
1513
- slug?: string;
1514
- /** ID of the entity associated with the event. */
1515
- entityId?: string;
1516
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1517
- eventTime?: Date | null;
1518
- /**
1519
- * Whether the event was triggered as a result of a privacy regulation application
1520
- * (for example, GDPR).
1521
- */
1522
- triggeredByAnonymizeRequest?: boolean | null;
1523
- /** If present, indicates the action that triggered the event. */
1524
- originatedFrom?: string | null;
1525
- /**
1526
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
1527
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1528
- */
1529
- entityEventSequence?: string | null;
1530
- }
1531
- /** @oneof */
1532
- interface DomainEventBodyOneOf {
1533
- createdEvent?: EntityCreatedEvent;
1534
- updatedEvent?: EntityUpdatedEvent;
1535
- deletedEvent?: EntityDeletedEvent;
1536
- actionEvent?: ActionEvent;
1537
- }
1538
- interface EntityCreatedEvent {
1539
- entityAsJson?: string;
1540
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1541
- restoreInfo?: RestoreInfo;
1542
- }
1543
- interface RestoreInfo {
1544
- deletedDate?: Date | null;
1545
- }
1546
- interface EntityUpdatedEvent {
1547
- /**
1548
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1549
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1550
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1551
- */
1552
- currentEntityAsJson?: string;
1553
- }
1554
- interface EntityDeletedEvent {
1555
- /** Entity that was deleted. */
1556
- deletedEntityAsJson?: string | null;
1557
- }
1558
- interface ActionEvent {
1559
- bodyAsJson?: string;
1560
- }
1561
- interface MessageEnvelope {
1562
- /**
1563
- * App instance ID.
1564
- * @format GUID
1565
- */
1566
- instanceId?: string | null;
1567
- /**
1568
- * Event type.
1569
- * @maxLength 150
1570
- */
1571
- eventType?: string;
1572
- /** The identification type and identity data. */
1573
- identity?: IdentificationData;
1574
- /** Stringify payload. */
1575
- data?: string;
1576
- /** Details related to the account */
1577
- accountInfo?: AccountInfo;
1578
- }
1579
- interface IdentificationData extends IdentificationDataIdOneOf {
1580
- /**
1581
- * ID of a site visitor that has not logged in to the site.
1582
- * @format GUID
1583
- */
1584
- anonymousVisitorId?: string;
1585
- /**
1586
- * ID of a site visitor that has logged in to the site.
1587
- * @format GUID
1588
- */
1589
- memberId?: string;
1590
- /**
1591
- * ID of a Wix user (site owner, contributor, etc.).
1592
- * @format GUID
1593
- */
1594
- wixUserId?: string;
1595
- /**
1596
- * ID of an app.
1597
- * @format GUID
1598
- */
1599
- appId?: string;
1600
- /** @readonly */
1601
- identityType?: WebhookIdentityTypeWithLiterals;
1602
- }
1603
- /** @oneof */
1604
- interface IdentificationDataIdOneOf {
1605
- /**
1606
- * ID of a site visitor that has not logged in to the site.
1607
- * @format GUID
1608
- */
1609
- anonymousVisitorId?: string;
1610
- /**
1611
- * ID of a site visitor that has logged in to the site.
1612
- * @format GUID
1613
- */
1614
- memberId?: string;
1615
- /**
1616
- * ID of a Wix user (site owner, contributor, etc.).
1617
- * @format GUID
1618
- */
1619
- wixUserId?: string;
1620
- /**
1621
- * ID of an app.
1622
- * @format GUID
1623
- */
1624
- appId?: string;
1625
- }
1626
- declare enum WebhookIdentityType {
1627
- UNKNOWN = "UNKNOWN",
1628
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1629
- MEMBER = "MEMBER",
1630
- WIX_USER = "WIX_USER",
1631
- APP = "APP"
1632
- }
1633
- /** @enumType */
1634
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1635
- interface AccountInfo {
1636
- /**
1637
- * ID of the Wix account associated with the event.
1638
- * @format GUID
1639
- */
1640
- accountId?: string | null;
1641
- /**
1642
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
1643
- * @format GUID
1644
- */
1645
- parentAccountId?: string | null;
1646
- /**
1647
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
1648
- * @format GUID
1649
- */
1650
- siteId?: string | null;
1651
- }
1652
- /** @docsIgnore */
1653
- type UpsertTemplateSettingsApplicationErrors = {
1654
- code?: 'INVALID_TEMPLATE_SETTINGS';
1655
- description?: string;
1656
- data?: Record<string, any>;
1657
- };
1658
- /** @docsIgnore */
1659
- type ResolveTemplateSettingsApplicationErrors = {
1660
- code?: 'TEMPLATE_NOT_FOUND';
1661
- description?: string;
1662
- data?: Record<string, any>;
1663
- };
1664
-
1665
- declare global {
1666
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
1667
- interface SymbolConstructor {
1668
- readonly observable: symbol;
1669
- }
1670
- }
1671
-
1672
- declare global {
1673
- interface ContextualClient {
1674
- }
1675
- }
1676
- declare global {
1677
- /**
1678
- * A global interface to set the exposure toggle for the SDK.
1679
- * @example
1680
- * ```ts
1681
- * declare global {
1682
- * interface SDKExposureToggle {
1683
- * alpha: true;
1684
- * }
1685
- * }
1686
- */
1687
- interface SDKExposureToggle {
1688
- }
1689
- }
1690
-
1691
- declare global {
1692
- /**
1693
- * A global interface to set the type mode for the SDK.
1694
- * @example
1695
- * ```ts
1696
- * declare global {
1697
- * interface SDKTypeMode {
1698
- * strict: true;
1699
- * }
1700
- * }
1701
- */
1702
- interface SDKTypeMode {
1703
- }
1704
- }
1705
-
1706
- interface TemplateSettings {
1707
- /**
1708
- * Auto generated ID.
1709
- * @format GUID
1710
- * @readonly
1711
- */
1712
- _id?: string | null;
1713
- /**
1714
- * Wix app definition ID.
1715
- * @minLength 1
1716
- * @maxLength 20
1717
- */
1718
- appSlug?: string | null;
1719
- /**
1720
- * The type of the template.
1721
- * @minLength 1
1722
- * @maxLength 20
1723
- */
1724
- templateType?: string | null;
1725
- /**
1726
- * The id of the template.
1727
- * @minLength 1
1728
- * @maxLength 20
1729
- */
1730
- templateId?: string | null;
1731
- /**
1732
- * Template settings external ID. For example ticket definition ID.
1733
- * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
1734
- * @minLength 1
1735
- * @maxLength 100
1736
- */
1737
- externalId?: string | null;
1738
- /**
1739
- * Date settings were created.
1740
- * @readonly
1741
- */
1742
- _createdDate?: Date | null;
1743
- /**
1744
- * Date settings were updated.
1745
- * @readonly
1746
- */
1747
- _updatedDate?: Date | null;
1748
- /** @maxSize 10 */
1749
- settingGroups?: SettingsGroup[];
1750
- /** Paper size */
1751
- paperSize?: PaperSizeWithLiterals;
1752
- pageOverflow?: PageOverflowWithLiterals;
1753
- }
1754
- interface TextSetting {
1755
- /**
1756
- * Font family class name
1757
- * @maxLength 20
1758
- */
1759
- fontFamily?: string | null;
1760
- /**
1761
- * Font style class names
1762
- * @maxSize 10
1763
- * @maxLength 20
1764
- */
1765
- fontStyle?: string[];
1766
- /**
1767
- * Text alignment class name
1768
- * @maxLength 20
1769
- */
1770
- textAlignment?: string | null;
1771
- /**
1772
- * Text color hex code
1773
- * @minLength 7
1774
- * @maxLength 7
1775
- */
1776
- textColor?: string | null;
1777
- /**
1778
- * Font size
1779
- * @min 1
1780
- */
1781
- fontSize?: number | null;
1782
- /** Text content setting */
1783
- textContent?: TextContent[];
1784
- }
1785
- interface TextContent {
1786
- /**
1787
- * @minLength 3
1788
- * @maxLength 50
1789
- */
1790
- _id?: string;
1791
- /** @maxLength 500 */
1792
- value?: string | null;
1793
- visible?: boolean;
1794
- }
1795
- interface ImageSetting {
1796
- /** Wix media Image */
1797
- image?: string;
1798
- /** Image resizing mode */
1799
- resize?: ResizeOptionWithLiterals;
1800
- }
1801
- declare enum ResizeOption {
1802
- /** Automatically resizes full image to fit image field */
1803
- FIT = "FIT",
1804
- /** Enables user to manually crop image to fit image field */
1805
- CROP = "CROP"
1806
- }
1807
- /** @enumType */
1808
- type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
1809
- interface SelectSetting {
1810
- /** Selected value */
1811
- value?: string | null;
1812
- /**
1813
- * Color hex code
1814
- * @minLength 7
1815
- * @maxLength 7
1816
- */
1817
- primaryColor?: string | null;
1818
- /**
1819
- * Color hex code
1820
- * @minLength 7
1821
- * @maxLength 7
1822
- */
1823
- secondaryColor?: string | null;
1824
- /** Size */
1825
- size?: number | null;
1826
- }
1827
- interface BackgroundSetting {
1828
- /**
1829
- * Color of the background hex code
1830
- * @minLength 7
1831
- * @maxLength 9
1832
- */
1833
- color?: string | null;
1834
- /** Wix media Image */
1835
- image?: string;
1836
- }
1837
- interface SettingsGroup {
1838
- /**
1839
- * Id of the control group
1840
- * @minLength 5
1841
- * @maxLength 50
1842
- */
1843
- groupId?: string;
1844
- /**
1845
- * Display settings.
1846
- * @maxSize 20
1847
- */
1848
- display?: Record<string, boolean>;
1849
- /**
1850
- * Texts settings.
1851
- * @maxSize 20
1852
- */
1853
- texts?: Record<string, TextSetting>;
1854
- /**
1855
- * Images settings.
1856
- * @maxSize 10
1857
- */
1858
- images?: Record<string, ImageSetting>;
1859
- /**
1860
- * Select option settings.
1861
- * @maxSize 20
1862
- */
1863
- selects?: Record<string, SelectSetting>;
1864
- /**
1865
- * Backgrounds settings.
1866
- * @maxSize 20
1867
- */
1868
- backgrounds?: Record<string, BackgroundSetting>;
1869
- }
1870
- declare enum PaperSize {
1871
- A4_PORTRAIT = "A4_PORTRAIT",
1872
- A4_LANDSCAPE = "A4_LANDSCAPE"
1873
- }
1874
- /** @enumType */
1875
- type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
1876
- declare enum PageOverflow {
1877
- CONTENT_HIDDEN = "CONTENT_HIDDEN",
1878
- CONTENT_BREAK = "CONTENT_BREAK"
1879
- }
1880
- /** @enumType */
1881
- type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
1882
- interface UpsertTemplateSettingsRequest {
1883
- /** Settings to be upserted. */
1884
- settings?: TemplateSettings;
1885
- }
1886
- interface UpsertTemplateSettingsResponse {
1887
- /** Upserted settings. */
1888
- settings?: TemplateSettings;
1889
- }
1890
- interface QueryTemplateSettingsRequest {
1891
- /** Generic query object. */
1892
- query: QueryV2;
1893
- }
1894
- interface QueryV2 extends QueryV2PagingMethodOneOf {
1895
- /** Paging options to limit and offset the number of items. */
1896
- paging?: Paging;
1897
- /** 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`. */
1898
- cursorPaging?: CursorPaging;
1899
- /**
1900
- * Filter object.
1901
- *
1902
- * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
1903
- */
1904
- filter?: Record<string, any> | null;
1905
- /**
1906
- * Sort object.
1907
- *
1908
- * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
1909
- */
1910
- sort?: Sorting[];
1911
- /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
1912
- fields?: string[];
1913
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
1914
- fieldsets?: string[];
1915
- }
1916
- /** @oneof */
1917
- interface QueryV2PagingMethodOneOf {
1918
- /** Paging options to limit and offset the number of items. */
1919
- paging?: Paging;
1920
- /** 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`. */
1921
- cursorPaging?: CursorPaging;
1922
- }
1923
- interface Sorting {
1924
- /**
1925
- * Name of the field to sort by.
1926
- * @maxLength 512
1927
- */
1928
- fieldName?: string;
1929
- /** Sort order. */
1930
- order?: SortOrderWithLiterals;
1931
- /**
1932
- * Origin point for geo-distance sorting on a GEO field
1933
- * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
1934
- */
1935
- origin?: AddressLocation;
1936
- }
1937
- declare enum SortOrder {
1938
- ASC = "ASC",
1939
- DESC = "DESC"
1940
- }
1941
- /** @enumType */
1942
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1943
- interface AddressLocation {
1944
- /** Address latitude. */
1945
- latitude?: number | null;
1946
- /** Address longitude. */
1947
- longitude?: number | null;
1948
- }
1949
- interface Paging {
1950
- /** Number of items to load. */
1951
- limit?: number | null;
1952
- /** Number of items to skip in the current sort order. */
1953
- offset?: number | null;
1954
- }
1955
- interface CursorPaging {
1956
- /**
1957
- * Maximum number of items to return in the results.
1958
- * @max 100
1959
- */
1960
- limit?: number | null;
1961
- /**
1962
- * Pointer to the next or previous page in the list of results.
1963
- *
1964
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1965
- * Not relevant for the first request.
1966
- * @maxLength 16000
1967
- */
1968
- cursor?: string | null;
1969
- }
1970
- interface QueryTemplateSettingsResponse {
1971
- /** Template settings results. */
1972
- settings?: TemplateSettings[];
1973
- /** Query result's metadata. */
1974
- metadata?: PagingMetadataV2;
1975
- }
1976
- interface PagingMetadataV2 {
1977
- /** Number of items returned in the response. */
1978
- count?: number | null;
1979
- /** Offset that was requested. */
1980
- offset?: number | null;
1981
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1982
- total?: number | null;
1983
- /** Flag that indicates the server failed to calculate the `total` field. */
1984
- tooManyToCount?: boolean | null;
1985
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1986
- cursors?: Cursors;
1987
- }
1988
- interface Cursors {
1989
- /**
1990
- * Cursor string pointing to the next page in the list of results.
1991
- * @maxLength 16000
1992
- */
1993
- next?: string | null;
1994
- /**
1995
- * Cursor pointing to the previous page in the list of results.
1996
- * @maxLength 16000
1997
- */
1998
- prev?: string | null;
1999
- }
2000
- interface ResolveTemplateSettingsRequest {
2001
- /**
2002
- * The id of the settings.
2003
- * @format GUID
2004
- */
2005
- templateSettingsId?: string | null;
2006
- /**
2007
- * External ID.
2008
- * @maxLength 100
2009
- */
2010
- templateSettingsExternalId?: string | null;
2011
- /**
2012
- * The type of the template. Used to resolve default settings.
2013
- * @minLength 1
2014
- * @maxLength 20
2015
- */
2016
- templateType: string | null;
2017
- /**
2018
- * Wix app slug.
2019
- * @minLength 1
2020
- * @maxLength 20
2021
- */
2022
- appSlug: string | null;
2023
- /**
2024
- * The id of template.
2025
- * @minLength 1
2026
- * @maxLength 20
2027
- */
2028
- templateId?: string | null;
2029
- }
2030
- interface ResolveTemplateSettingsResponse {
2031
- /** Retrieved settings. */
2032
- settings?: TemplateSettings;
2033
- }
2034
-
2035
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2036
- getUrl: (context: any) => string;
2037
- httpMethod: K;
2038
- path: string;
2039
- pathParams: M;
2040
- __requestType: T;
2041
- __originalRequestType: S;
2042
- __responseType: Q;
2043
- __originalResponseType: R;
2044
- };
2045
- declare function upsertTemplateSettings(): __PublicMethodMetaInfo<'POST', {}, UpsertTemplateSettingsRequest, UpsertTemplateSettingsRequest$1, UpsertTemplateSettingsResponse, UpsertTemplateSettingsResponse$1>;
2046
- declare function queryTemplateSettings(): __PublicMethodMetaInfo<'POST', {}, QueryTemplateSettingsRequest, QueryTemplateSettingsRequest$1, QueryTemplateSettingsResponse, QueryTemplateSettingsResponse$1>;
2047
- declare function resolveTemplateSettings(): __PublicMethodMetaInfo<'GET', {}, ResolveTemplateSettingsRequest, ResolveTemplateSettingsRequest$1, ResolveTemplateSettingsResponse, ResolveTemplateSettingsResponse$1>;
2048
-
2049
- type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
2050
- declare const meta_queryTemplateSettings: typeof queryTemplateSettings;
2051
- declare const meta_resolveTemplateSettings: typeof resolveTemplateSettings;
2052
- declare const meta_upsertTemplateSettings: typeof upsertTemplateSettings;
2053
- declare namespace meta {
2054
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation$1 as AddressLocationOriginal, type BackgroundControl as BackgroundControlOriginal, type BackgroundSetting$1 as BackgroundSettingOriginal, type BulkCreateTemplateSettingsRequest as BulkCreateTemplateSettingsRequestOriginal, type BulkCreateTemplateSettingsResponse as BulkCreateTemplateSettingsResponseOriginal, type ControlGroup as ControlGroupOriginal, type CreateTemplateSettingsRequest as CreateTemplateSettingsRequestOriginal, type CreateTemplateSettingsResponse as CreateTemplateSettingsResponseOriginal, type CursorPaging$1 as CursorPagingOriginal, type Cursors$1 as CursorsOriginal, type DeleteTemplateSettingsRequest as DeleteTemplateSettingsRequestOriginal, type DeleteTemplateSettingsResponse as DeleteTemplateSettingsResponseOriginal, type DisplayControl as DisplayControlOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FocalPoint as FocalPointOriginal, type GetTemplateControlsRequest as GetTemplateControlsRequestOriginal, type GetTemplateControlsResponse as GetTemplateControlsResponseOriginal, type GetTemplateRegistryRequest as GetTemplateRegistryRequestOriginal, type GetTemplateRegistryResponse as GetTemplateRegistryResponseOriginal, type GetTemplateSettingsRequest as GetTemplateSettingsRequestOriginal, type GetTemplateSettingsResponse as GetTemplateSettingsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImageControl as ImageControlOriginal, type Image as ImageOriginal, type ImageSetting$1 as ImageSettingOriginal, type MessageEnvelope as MessageEnvelopeOriginal, PageOverflow$1 as PageOverflowOriginal, type PageOverflowWithLiterals$1 as PageOverflowWithLiteralsOriginal, type PagingMetadataV2$1 as PagingMetadataV2Original, type Paging$1 as PagingOriginal, PaperSize$1 as PaperSizeOriginal, type PaperSizeWithLiterals$1 as PaperSizeWithLiteralsOriginal, type QueryTemplateSettingsRequest$1 as QueryTemplateSettingsRequestOriginal, type QueryTemplateSettingsResponse$1 as QueryTemplateSettingsResponseOriginal, type QueryV2$1 as QueryV2Original, type QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOfOriginal, type Range as RangeOriginal, ResizeOption$1 as ResizeOptionOriginal, type ResizeOptionWithLiterals$1 as ResizeOptionWithLiteralsOriginal, type ResolveTemplateSettingsApplicationErrors as ResolveTemplateSettingsApplicationErrorsOriginal, type ResolveTemplateSettingsRequest$1 as ResolveTemplateSettingsRequestOriginal, type ResolveTemplateSettingsResponse$1 as ResolveTemplateSettingsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type SelectControl as SelectControlOriginal, type SelectSetting$1 as SelectSettingOriginal, type SettingsGroup$1 as SettingsGroupOriginal, SortOrder$1 as SortOrderOriginal, type SortOrderWithLiterals$1 as SortOrderWithLiteralsOriginal, type Sorting$1 as SortingOriginal, type TemplateControls as TemplateControlsOriginal, type TemplateRegistry as TemplateRegistryOriginal, type TemplateSettings$1 as TemplateSettingsOriginal, type TemplateStyle as TemplateStyleOriginal, type TextContentControl as TextContentControlOriginal, type TextContent$1 as TextContentOriginal, type TextControl as TextControlOriginal, type TextPropertyControl as TextPropertyControlOriginal, type TextSetting$1 as TextSettingOriginal, type UpdateTemplateSettingsRequest as UpdateTemplateSettingsRequestOriginal, type UpdateTemplateSettingsResponse as UpdateTemplateSettingsResponseOriginal, type UpsertTemplateSettingsApplicationErrors as UpsertTemplateSettingsApplicationErrorsOriginal, type UpsertTemplateSettingsRequest$1 as UpsertTemplateSettingsRequestOriginal, type UpsertTemplateSettingsResponse$1 as UpsertTemplateSettingsResponseOriginal, type ValueOption as ValueOptionOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixAppTemplate as WixAppTemplateOriginal, type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_queryTemplateSettings as queryTemplateSettings, meta_resolveTemplateSettings as resolveTemplateSettings, meta_upsertTemplateSettings as upsertTemplateSettings };
2055
- }
2056
-
2057
- export { meta_d as documents, meta as templates };