@wix/auto_sdk_papyrus_documents 1.0.0 → 1.0.2

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 (49) hide show
  1. package/build/cjs/index.d.ts +18 -18
  2. package/build/cjs/index.js +173 -156
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +552 -528
  5. package/build/cjs/index.typings.js +136 -127
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +536 -525
  8. package/build/cjs/meta.js +125 -114
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +26 -22
  11. package/build/cjs/schemas.js +317 -271
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +18 -18
  14. package/build/es/index.mjs +173 -156
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +552 -528
  17. package/build/es/index.typings.mjs +136 -127
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +536 -525
  20. package/build/es/meta.mjs +125 -114
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +26 -22
  23. package/build/es/schemas.mjs +317 -271
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +18 -18
  26. package/build/internal/cjs/index.typings.d.ts +616 -523
  27. package/build/internal/cjs/meta.d.ts +642 -516
  28. package/build/internal/cjs/schemas.d.ts +26 -22
  29. package/build/internal/es/index.d.mts +18 -18
  30. package/build/internal/es/index.typings.d.mts +616 -523
  31. package/build/internal/es/meta.d.mts +642 -516
  32. package/build/internal/es/schemas.d.mts +26 -22
  33. package/package.json +4 -4
  34. package/build/internal/cjs/index.js +0 -1101
  35. package/build/internal/cjs/index.js.map +0 -1
  36. package/build/internal/cjs/index.typings.js +0 -863
  37. package/build/internal/cjs/index.typings.js.map +0 -1
  38. package/build/internal/cjs/meta.js +0 -705
  39. package/build/internal/cjs/meta.js.map +0 -1
  40. package/build/internal/cjs/schemas.js +0 -658
  41. package/build/internal/cjs/schemas.js.map +0 -1
  42. package/build/internal/es/index.mjs +0 -1050
  43. package/build/internal/es/index.mjs.map +0 -1
  44. package/build/internal/es/index.typings.mjs +0 -817
  45. package/build/internal/es/index.typings.mjs.map +0 -1
  46. package/build/internal/es/meta.mjs +0 -658
  47. package/build/internal/es/meta.mjs.map +0 -1
  48. package/build/internal/es/schemas.mjs +0 -602
  49. package/build/internal/es/schemas.mjs.map +0 -1
@@ -1,4 +1,4 @@
1
- import { GetDownloadPageRequest as GetDownloadPageRequest$1, RawHttpResponse as RawHttpResponse$1, RedirectToDocumentRequest as RedirectToDocumentRequest$1, CreateDocumentRequest as CreateDocumentRequest$1, CreateDocumentResponse as CreateDocumentResponse$1, GetDocumentRequest as GetDocumentRequest$1, GetDocumentResponse as GetDocumentResponse$1, DeleteDocumentRequest as DeleteDocumentRequest$1, DeleteDocumentResponse as DeleteDocumentResponse$1, QueryDocumentRequest as QueryDocumentRequest$1, QueryDocumentResponse as QueryDocumentResponse$1, UpdateDocumentRequest as UpdateDocumentRequest$1, UpdateDocumentResponse as UpdateDocumentResponse$1, DownloadDocumentRequest as DownloadDocumentRequest$1, DownloadDocumentResponse as DownloadDocumentResponse$1, GetDownloadUrlRequest as GetDownloadUrlRequest$1, GetDownloadUrlResponse as GetDownloadUrlResponse$1, DownloadDocumentSourceRequest as DownloadDocumentSourceRequest$1, DownloadDocumentSourceResponse as DownloadDocumentSourceResponse$1 } from './index.typings.mjs';
1
+ import { CreateDocumentRequest as CreateDocumentRequest$1, CreateDocumentResponse as CreateDocumentResponse$1, GetDocumentRequest as GetDocumentRequest$1, GetDocumentResponse as GetDocumentResponse$1, DeleteDocumentRequest as DeleteDocumentRequest$1, DeleteDocumentResponse as DeleteDocumentResponse$1, QueryDocumentRequest as QueryDocumentRequest$1, QueryDocumentResponse as QueryDocumentResponse$1, UpdateDocumentRequest as UpdateDocumentRequest$1, UpdateDocumentResponse as UpdateDocumentResponse$1, DownloadDocumentRequest as DownloadDocumentRequest$1, DownloadDocumentResponse as DownloadDocumentResponse$1, GetDownloadUrlRequest as GetDownloadUrlRequest$1, GetDownloadUrlResponse as GetDownloadUrlResponse$1, DownloadDocumentSourceRequest as DownloadDocumentSourceRequest$1, DownloadDocumentSourceResponse as DownloadDocumentSourceResponse$1, GetDownloadPageRequest as GetDownloadPageRequest$1, RawHttpResponse as RawHttpResponse$1, RedirectToDocumentRequest as RedirectToDocumentRequest$1 } from './index.typings.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /** Document is the main entity of DocumentService. */
@@ -99,6 +99,25 @@ interface Document {
99
99
  * @immutable
100
100
  */
101
101
  public?: boolean | null;
102
+ /**
103
+ * Template settings override per content page.
104
+ * @internal
105
+ * @immutable
106
+ * @deprecated
107
+ */
108
+ templateSettings?: TemplateSettingsOverride[];
109
+ /**
110
+ * Whether WixMP storage is enabled.
111
+ * @internal
112
+ * @immutable
113
+ */
114
+ wixMpStorageEnabled?: boolean | null;
115
+ /**
116
+ * Template settings override per content page.
117
+ * @internal
118
+ * @immutable
119
+ */
120
+ pageSettings?: PageSettings[];
102
121
  /**
103
122
  * Optional filename (without extension) to be used for the downloadable document.
104
123
  * @minLength 1
@@ -112,6 +131,12 @@ interface Document {
112
131
  * @immutable
113
132
  */
114
133
  contentChecksum?: string | null;
134
+ /**
135
+ * Whether WixMP v1 Java Client is used.
136
+ * @internal
137
+ * @readonly
138
+ */
139
+ wixMpClientVersion?: WixMpClientVersionWithLiterals;
115
140
  /** Rendering notification config. */
116
141
  renderDelayedEventConfig?: RenderDelayedEventConfig;
117
142
  /**
@@ -119,6 +144,13 @@ interface Document {
119
144
  * @readonly
120
145
  */
121
146
  sizeInBytes?: number | null;
147
+ /**
148
+ * Debug options. When used:
149
+ * - Document status changes FAILED if the first attempt to render fails.
150
+ * @internal
151
+ * @immutable
152
+ */
153
+ debugOptions?: DebugOptions;
122
154
  }
123
155
  declare enum RenderStatus {
124
156
  UNKNOWN = "UNKNOWN",
@@ -235,258 +267,351 @@ interface DebugOptions {
235
267
  */
236
268
  staticsVersionOverride?: string | null;
237
269
  }
238
- interface RenderDocumentRequest {
239
- /** Template settings. */
240
- templateSettings?: TemplateSettings;
241
- /** Document content. */
242
- content?: DocumentContent;
243
- /** Output format, defaults to PDF. */
244
- outputFormat?: RenderFormatWithLiterals;
245
- /**
246
- * Overrides papyrusTemplatesStaticsUrl: "//static.parastorage.com/services/papyrus-templates-statics/${version_override}/"
247
- * @maxLength 100
248
- */
249
- versionOverride?: string | null;
250
- /**
251
- * Overrides static versions for the statics config.
252
- * @maxSize 10
253
- */
254
- staticOverrides?: Record<string, string>;
270
+ interface DocumentRenderDelayed {
271
+ /** Document that is being rendered. */
272
+ document?: Document;
255
273
  }
256
- interface TemplateSettings {
274
+ interface CreateDocumentRequest {
275
+ /** Document to be created */
276
+ document?: Document;
277
+ }
278
+ interface CreateDocumentResponse {
279
+ /** The created Document */
280
+ document?: Document;
281
+ }
282
+ interface GetDocumentRequest {
257
283
  /**
258
- * Auto generated ID.
284
+ * ID of the Document to retrieve
259
285
  * @format GUID
260
- * @readonly
261
286
  */
262
- id?: string | null;
263
- /**
264
- * Wix app definition ID.
265
- * @minLength 1
266
- * @maxLength 20
267
- */
268
- appSlug?: string | null;
269
- /**
270
- * The type of the template.
271
- * @minLength 1
272
- * @maxLength 20
273
- */
274
- templateType?: string | null;
287
+ documentId: string;
288
+ /** @maxSize 1 */
289
+ fields?: RequestedFieldsWithLiterals[];
290
+ }
291
+ declare enum RequestedFields {
292
+ /** Include `documentContent` in the response. */
293
+ DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
294
+ }
295
+ /** @enumType */
296
+ type RequestedFieldsWithLiterals = RequestedFields | 'DOCUMENT_CONTENT';
297
+ interface GetDocumentResponse {
298
+ /** The retrieved Document */
299
+ document?: Document;
300
+ }
301
+ interface DeleteDocumentRequest {
275
302
  /**
276
- * The id of the template.
277
- * @minLength 1
278
- * @maxLength 20
303
+ * ID of the Document to delete
304
+ * @format GUID
279
305
  */
280
- templateId?: string | null;
306
+ documentId: string;
307
+ }
308
+ interface DeleteDocumentResponse {
309
+ /** Deleted document. */
310
+ document?: Document;
311
+ }
312
+ interface DeleteDocumentByExternalIdRequest {
281
313
  /**
282
- * Template settings external ID. For example ticket definition ID.
283
- * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
314
+ * External ID of the Document to delete
284
315
  * @minLength 1
285
316
  * @maxLength 100
286
317
  */
287
- externalId?: string | null;
318
+ externalId?: string;
319
+ }
320
+ interface DeleteDocumentByExternalIdResponse {
321
+ /** Deleted document. */
322
+ document?: Document;
323
+ }
324
+ interface QueryDocumentRequest {
325
+ /** WQL expression */
326
+ query: QueryV2;
327
+ /** @maxSize 1 */
328
+ fields?: RequestedFieldsWithLiterals[];
329
+ }
330
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
331
+ /** Paging options to limit and offset the number of items. */
332
+ paging?: Paging;
333
+ /** 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`. */
334
+ cursorPaging?: CursorPaging;
288
335
  /**
289
- * Date settings were created.
290
- * @readonly
336
+ * Filter object.
337
+ *
338
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
291
339
  */
292
- createdDate?: Date | null;
340
+ filter?: Record<string, any> | null;
293
341
  /**
294
- * Date settings were updated.
295
- * @readonly
342
+ * Sort object.
343
+ *
344
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
296
345
  */
297
- updatedDate?: Date | null;
298
- /** @maxSize 10 */
299
- settingGroups?: SettingsGroup[];
300
- /** Paper size */
301
- paperSize?: PaperSizeWithLiterals;
302
- pageOverflow?: PageOverflowWithLiterals;
346
+ sort?: Sorting[];
347
+ /** 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. */
348
+ fields?: string[];
349
+ /** 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. */
350
+ fieldsets?: string[];
303
351
  }
304
- interface TextSetting {
352
+ /** @oneof */
353
+ interface QueryV2PagingMethodOneOf {
354
+ /** Paging options to limit and offset the number of items. */
355
+ paging?: Paging;
356
+ /** 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`. */
357
+ cursorPaging?: CursorPaging;
358
+ }
359
+ interface Sorting {
305
360
  /**
306
- * Font family class name
307
- * @maxLength 20
361
+ * Name of the field to sort by.
362
+ * @maxLength 512
308
363
  */
309
- fontFamily?: string | null;
364
+ fieldName?: string;
365
+ /** Sort order. */
366
+ order?: SortOrderWithLiterals;
310
367
  /**
311
- * Font style class names
368
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
369
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
370
+ *
371
+ * If multiple filters are provided, they are combined with AND operator.
372
+ *
373
+ * Example:
374
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
375
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
376
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
377
+ * @internal
312
378
  * @maxSize 10
313
- * @maxLength 20
314
379
  */
315
- fontStyle?: string[];
380
+ selectItemsBy?: Record<string, any>[] | null;
316
381
  /**
317
- * Text alignment class name
318
- * @maxLength 20
382
+ * Origin point for geo-distance sorting on a GEO field
383
+ * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
319
384
  */
320
- textAlignment?: string | null;
385
+ origin?: AddressLocation;
386
+ }
387
+ declare enum SortOrder {
388
+ ASC = "ASC",
389
+ DESC = "DESC"
390
+ }
391
+ /** @enumType */
392
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
393
+ interface AddressLocation {
394
+ /** Address latitude. */
395
+ latitude?: number | null;
396
+ /** Address longitude. */
397
+ longitude?: number | null;
398
+ }
399
+ interface Paging {
400
+ /** Number of items to load. */
401
+ limit?: number | null;
402
+ /** Number of items to skip in the current sort order. */
403
+ offset?: number | null;
404
+ }
405
+ interface CursorPaging {
321
406
  /**
322
- * Text color hex code
323
- * @minLength 7
324
- * @maxLength 7
407
+ * Maximum number of items to return in the results.
408
+ * @max 100
325
409
  */
326
- textColor?: string | null;
410
+ limit?: number | null;
327
411
  /**
328
- * Font size
329
- * @min 1
412
+ * Pointer to the next or previous page in the list of results.
413
+ *
414
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
415
+ * Not relevant for the first request.
416
+ * @maxLength 16000
330
417
  */
331
- fontSize?: number | null;
332
- /** Text content setting */
333
- textContent?: TextContent[];
418
+ cursor?: string | null;
334
419
  }
335
- interface TextContent {
420
+ interface QueryDocumentResponse {
421
+ /** The retrieved Documents */
422
+ documents?: Document[];
423
+ /** Query results' metadata */
424
+ metadata?: PagingMetadataV2;
425
+ }
426
+ interface PagingMetadataV2 {
427
+ /** Number of items returned in the response. */
428
+ count?: number | null;
429
+ /** Offset that was requested. */
430
+ offset?: number | null;
431
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
432
+ total?: number | null;
433
+ /** Flag that indicates the server failed to calculate the `total` field. */
434
+ tooManyToCount?: boolean | null;
435
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
436
+ cursors?: Cursors;
336
437
  /**
337
- * @minLength 3
338
- * @maxLength 50
438
+ * Indicates if there are more results after the current page.
439
+ * If `true`, another page of results can be retrieved.
440
+ * If `false`, this is the last page.
441
+ * @internal
339
442
  */
340
- id?: string;
341
- /** @maxLength 500 */
342
- value?: string | null;
343
- visible?: boolean;
344
- }
345
- interface ImageSetting {
346
- /** Wix media Image */
347
- image?: Image;
348
- /** Image resizing mode */
349
- resize?: ResizeOptionWithLiterals;
443
+ hasNext?: boolean | null;
350
444
  }
351
- interface Image {
352
- /** WixMedia image ID. */
353
- id?: string;
354
- /** Image URL. */
355
- url?: string;
445
+ interface Cursors {
356
446
  /**
357
- * Original image height.
358
- * @readonly
447
+ * Cursor string pointing to the next page in the list of results.
448
+ * @maxLength 16000
359
449
  */
360
- height?: number;
450
+ next?: string | null;
361
451
  /**
362
- * Original image width.
363
- * @readonly
452
+ * Cursor pointing to the previous page in the list of results.
453
+ * @maxLength 16000
364
454
  */
365
- width?: number;
366
- /** Image alt text. */
367
- altText?: string | null;
455
+ prev?: string | null;
456
+ }
457
+ interface UpdateDocumentRequest {
368
458
  /**
369
- * Image filename.
459
+ * Document ID.
460
+ * @format GUID
370
461
  * @readonly
371
462
  */
372
- filename?: string | null;
463
+ id: string | null;
464
+ /** Document render status. */
465
+ renderStatus?: RenderStatusWithLiterals;
466
+ /** Rendered document file. */
467
+ file?: DocumentFile;
468
+ /** Rendered document source HTML file. */
469
+ sourceFile?: DocumentFile;
373
470
  }
374
- interface FocalPoint {
375
- /** X-coordinate of the focal point. */
376
- x?: number;
377
- /** Y-coordinate of the focal point. */
378
- y?: number;
379
- /** crop by height */
380
- height?: number | null;
381
- /** crop by width */
382
- width?: number | null;
471
+ interface DocumentFile {
472
+ /** File ID. */
473
+ fileId?: string | null;
474
+ /** File URL. Defined only for public documents. */
475
+ staticUrl?: string | null;
476
+ /** File path. */
477
+ filePath?: string | null;
478
+ /** Size in bytes. */
479
+ sizeInBytes?: number | null;
383
480
  }
384
- declare enum ResizeOption {
385
- /** Automatically resizes full image to fit image field */
386
- FIT = "FIT",
387
- /** Enables user to manually crop image to fit image field */
388
- CROP = "CROP"
481
+ interface UpdateDocumentResponse {
482
+ /** The created Document */
483
+ document?: Document;
389
484
  }
390
- /** @enumType */
391
- type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
392
- interface SelectSetting {
393
- /** Selected value */
394
- value?: string | null;
485
+ interface DocumentRendered {
486
+ /** Rendered document */
487
+ document?: Document;
488
+ }
489
+ interface DocumentRenderFailed {
490
+ /** Document that failed to render */
491
+ document?: Document;
492
+ }
493
+ interface DownloadDocumentRequest {
395
494
  /**
396
- * Color hex code
397
- * @minLength 7
398
- * @maxLength 7
495
+ * ID of the Document to retrieve
496
+ * @format GUID
399
497
  */
400
- primaryColor?: string | null;
498
+ documentId: string;
401
499
  /**
402
- * Color hex code
403
- * @minLength 7
404
- * @maxLength 7
500
+ * URL expiration time. Only relevant for private documents.
501
+ * @min 600
502
+ * @max 86400
405
503
  */
406
- secondaryColor?: string | null;
407
- /** Size */
408
- size?: number | null;
409
- }
410
- interface BackgroundSetting {
504
+ urlExpirationInSeconds?: number | null;
411
505
  /**
412
- * Color of the background hex code
413
- * @minLength 7
414
- * @maxLength 9
506
+ * Whether the link downloads the file or opens the file in the browser.
507
+ * Default: `ATTACHMENT`
415
508
  */
416
- color?: string | null;
417
- /** Wix media Image */
418
- image?: Image;
509
+ contentDisposition?: ContentDispositionWithLiterals;
419
510
  }
420
- interface SettingsGroup {
511
+ declare enum ContentDisposition {
512
+ /** @internal */
513
+ UNKNOWN_CONTENT_DISPOSITION = "UNKNOWN_CONTENT_DISPOSITION",
514
+ /** The link downloads the file. */
515
+ ATTACHMENT = "ATTACHMENT",
516
+ /** The link opens the file in the browser. */
517
+ INLINE = "INLINE"
518
+ }
519
+ /** @enumType */
520
+ type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
521
+ interface DownloadDocumentResponse {
522
+ /** Download URL. */
523
+ downloadUrl?: string;
524
+ /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
525
+ expirationDate?: Date | null;
526
+ }
527
+ interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
421
528
  /**
422
- * Id of the control group
423
- * @minLength 5
424
- * @maxLength 50
529
+ * ID of the Document to retrieve
530
+ * @format GUID
425
531
  */
426
- groupId?: string;
532
+ documentId?: string | null;
427
533
  /**
428
- * Display settings.
429
- * @maxSize 20
534
+ * ID of the Document to retrieve
535
+ * @minLength 1
536
+ * @maxLength 100
430
537
  */
431
- display?: Record<string, boolean>;
538
+ externalId?: string | null;
432
539
  /**
433
- * Texts settings.
434
- * @maxSize 20
540
+ * Signed file token
541
+ * @minLength 1
542
+ * @maxLength 500
435
543
  */
436
- texts?: Record<string, TextSetting>;
544
+ fileToken?: string | null;
437
545
  /**
438
- * Images settings.
439
- * @maxSize 10
546
+ * URL expiration time. Only relevant for private documents.
547
+ * @min 600
548
+ * @max 86400
440
549
  */
441
- images?: Record<string, ImageSetting>;
550
+ urlExpirationInSeconds?: number | null;
551
+ /** @maxLength 100 */
552
+ downloadButtonText?: string | null;
442
553
  /**
443
- * Select option settings.
444
- * @maxSize 20
554
+ * Whether the link downloads the file or opens the file in the browser.
555
+ * Default: `ATTACHMENT`
445
556
  */
446
- selects?: Record<string, SelectSetting>;
557
+ contentDisposition?: ContentDispositionWithLiterals;
558
+ }
559
+ /** @oneof */
560
+ interface GetDownloadUrlRequestDocumentOneOf {
447
561
  /**
448
- * Backgrounds settings.
449
- * @maxSize 20
562
+ * ID of the Document to retrieve
563
+ * @format GUID
450
564
  */
451
- backgrounds?: Record<string, BackgroundSetting>;
452
- }
453
- declare enum PaperSize {
454
- A4_PORTRAIT = "A4_PORTRAIT",
455
- A4_LANDSCAPE = "A4_LANDSCAPE"
456
- }
457
- /** @enumType */
458
- type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
459
- declare enum PageOverflow {
460
- CONTENT_HIDDEN = "CONTENT_HIDDEN",
461
- CONTENT_BREAK = "CONTENT_BREAK"
462
- }
463
- /** @enumType */
464
- type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
465
- declare enum RenderFormat {
466
- /** content-type: application/pdf */
467
- PDF = "PDF",
468
- /** content-type: text/html */
469
- HTML = "HTML"
470
- }
471
- /** @enumType */
472
- type RenderFormatWithLiterals = RenderFormat | 'PDF' | 'HTML';
473
- interface RawHttpResponse {
474
- body?: Uint8Array;
475
- statusCode?: number | null;
476
- headers?: HeadersEntry[];
477
- }
478
- interface HeadersEntry {
479
- key?: string;
480
- value?: string;
565
+ documentId?: string | null;
566
+ /**
567
+ * ID of the Document to retrieve
568
+ * @minLength 1
569
+ * @maxLength 100
570
+ */
571
+ externalId?: string | null;
572
+ /**
573
+ * Signed file token
574
+ * @minLength 1
575
+ * @maxLength 500
576
+ */
577
+ fileToken?: string | null;
481
578
  }
482
- interface RenderDocumentByIdRequest {
579
+ interface GetDownloadUrlResponse {
580
+ /** Download URL. */
581
+ downloadUrl?: string | null;
582
+ /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
583
+ expirationDate?: Date | null;
483
584
  /**
484
585
  * Document ID.
485
586
  * @format GUID
486
587
  */
487
588
  documentId?: string | null;
488
- /** Output format, defaults to PDF. */
489
- outputFormat?: RenderFormatWithLiterals;
589
+ /** Document render status. */
590
+ renderStatus?: RenderStatusWithLiterals;
591
+ /** Download URL. */
592
+ downloadPageUrl?: string | null;
593
+ /**
594
+ * Client defined content checksum. Can be used for content comparison.
595
+ * @minLength 1
596
+ * @maxLength 64
597
+ */
598
+ contentChecksum?: string | null;
599
+ }
600
+ interface DownloadDocumentSourceRequest {
601
+ /**
602
+ * ID of the Document to retrieve
603
+ * @format GUID
604
+ */
605
+ documentId: string;
606
+ /**
607
+ * Whether the link downloads the file or opens the file in the browser.
608
+ * Default: `ATTACHMENT`
609
+ */
610
+ contentDisposition?: ContentDispositionWithLiterals;
611
+ }
612
+ interface DownloadDocumentSourceResponse {
613
+ /** Download URL. Expires after 10 minutes. */
614
+ downloadUrl?: string;
490
615
  }
491
616
  interface DomainEvent extends DomainEventBodyOneOf {
492
617
  createdEvent?: EntityCreatedEvent;
@@ -517,7 +642,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
517
642
  /** If present, indicates the action that triggered the event. */
518
643
  originatedFrom?: string | null;
519
644
  /**
520
- * 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.
645
+ * 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.
521
646
  * 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.
522
647
  */
523
648
  entityEventSequence?: string | null;
@@ -531,8 +656,18 @@ interface DomainEventBodyOneOf {
531
656
  }
532
657
  interface EntityCreatedEvent {
533
658
  entityAsJson?: string;
659
+ /**
660
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
661
+ * @internal
662
+ */
663
+ triggeredByUndelete?: boolean | null;
534
664
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
535
665
  restoreInfo?: RestoreInfo;
666
+ /**
667
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
668
+ * @internal
669
+ */
670
+ additionalMetadataAsJson?: string | null;
536
671
  }
537
672
  interface RestoreInfo {
538
673
  deletedDate?: Date | null;
@@ -544,444 +679,435 @@ interface EntityUpdatedEvent {
544
679
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
545
680
  */
546
681
  currentEntityAsJson?: string;
682
+ /**
683
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
684
+ * wont populate it / have any reference to it in the API.
685
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
686
+ * the developer should send only the new (current) entity.
687
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
688
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
689
+ * @internal
690
+ * @deprecated
691
+ */
692
+ previousEntityAsJson?: string | null;
693
+ /**
694
+ * Map of fully qualified field paths to their previous values for fields that changed.
695
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
696
+ * @internal
697
+ */
698
+ modifiedFields?: Record<string, any>;
699
+ /**
700
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
701
+ * @internal
702
+ */
703
+ additionalMetadataAsJson?: string | null;
547
704
  }
548
705
  interface EntityDeletedEvent {
706
+ /**
707
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
708
+ * @internal
709
+ */
710
+ movedToTrash?: boolean | null;
549
711
  /** Entity that was deleted. */
550
712
  deletedEntityAsJson?: string | null;
713
+ /**
714
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
715
+ * @internal
716
+ */
717
+ additionalMetadataAsJson?: string | null;
551
718
  }
552
719
  interface ActionEvent {
553
720
  bodyAsJson?: string;
554
721
  }
555
722
  interface Empty {
556
723
  }
557
- interface GetRendererInfoRequest {
558
- }
559
- interface GetRendererInfoResponse {
560
- /** Renderer info */
561
- info?: Record<string, string>;
724
+ interface MessageEnvelope {
725
+ /**
726
+ * App instance ID.
727
+ * @format GUID
728
+ */
729
+ instanceId?: string | null;
730
+ /**
731
+ * Event type.
732
+ * @maxLength 150
733
+ */
734
+ eventType?: string;
735
+ /** The identification type and identity data. */
736
+ identity?: IdentificationData;
737
+ /** Stringify payload. */
738
+ data?: string;
739
+ /** Details related to the account */
740
+ accountInfo?: AccountInfo;
562
741
  }
563
- interface GetCachedHtmlRequest {
742
+ interface IdentificationData extends IdentificationDataIdOneOf {
564
743
  /**
565
- * Html Access Key.
566
- * @maxLength 100
744
+ * ID of a site visitor that has not logged in to the site.
745
+ * @format GUID
567
746
  */
568
- htmlAccessKey?: string;
747
+ anonymousVisitorId?: string;
569
748
  /**
570
- * Meta Site Id.
749
+ * ID of a site visitor that has logged in to the site.
571
750
  * @format GUID
572
751
  */
573
- metaSiteId?: string | null;
574
- }
575
- interface GetDownloadPageRequest {
576
- /** @maxLength 1000 */
577
- file: string | null;
578
- }
579
- interface RedirectToDocumentRequest {
580
- /** @maxLength 1000 */
581
- file: string | null;
582
- }
583
- interface DocumentRenderDelayed {
584
- /** Document that is being rendered. */
585
- document?: Document;
586
- }
587
- interface CreateDocumentRequest {
588
- /** Document to be created */
589
- document?: Document;
590
- }
591
- interface CreateDocumentResponse {
592
- /** The created Document */
593
- document?: Document;
594
- }
595
- interface GetDocumentRequest {
752
+ memberId?: string;
596
753
  /**
597
- * ID of the Document to retrieve
754
+ * ID of a Wix user (site owner, contributor, etc.).
598
755
  * @format GUID
599
756
  */
600
- documentId: string;
601
- /** @maxSize 1 */
602
- fields?: RequestedFieldsWithLiterals[];
603
- }
604
- declare enum RequestedFields {
605
- /** Include `documentContent` in the response. */
606
- DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
607
- }
608
- /** @enumType */
609
- type RequestedFieldsWithLiterals = RequestedFields | 'DOCUMENT_CONTENT';
610
- interface GetDocumentResponse {
611
- /** The retrieved Document */
612
- document?: Document;
613
- }
614
- interface DeleteDocumentRequest {
757
+ wixUserId?: string;
615
758
  /**
616
- * ID of the Document to delete
759
+ * ID of an app.
617
760
  * @format GUID
618
761
  */
619
- documentId: string;
620
- }
621
- interface DeleteDocumentResponse {
622
- /** Deleted document. */
623
- document?: Document;
762
+ appId?: string;
763
+ /** @readonly */
764
+ identityType?: WebhookIdentityTypeWithLiterals;
624
765
  }
625
- interface DeleteDocumentByExternalIdRequest {
766
+ /** @oneof */
767
+ interface IdentificationDataIdOneOf {
626
768
  /**
627
- * External ID of the Document to delete
628
- * @minLength 1
629
- * @maxLength 100
769
+ * ID of a site visitor that has not logged in to the site.
770
+ * @format GUID
630
771
  */
631
- externalId?: string;
632
- }
633
- interface DeleteDocumentByExternalIdResponse {
634
- /** Deleted document. */
635
- document?: Document;
636
- }
637
- interface QueryDocumentRequest {
638
- /** WQL expression */
639
- query: QueryV2;
640
- /** @maxSize 1 */
641
- fields?: RequestedFieldsWithLiterals[];
642
- }
643
- interface QueryV2 extends QueryV2PagingMethodOneOf {
644
- /** Paging options to limit and offset the number of items. */
645
- paging?: Paging;
646
- /** 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`. */
647
- cursorPaging?: CursorPaging;
772
+ anonymousVisitorId?: string;
648
773
  /**
649
- * Filter object.
650
- *
651
- * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
774
+ * ID of a site visitor that has logged in to the site.
775
+ * @format GUID
652
776
  */
653
- filter?: Record<string, any> | null;
777
+ memberId?: string;
654
778
  /**
655
- * Sort object.
656
- *
657
- * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
779
+ * ID of a Wix user (site owner, contributor, etc.).
780
+ * @format GUID
658
781
  */
659
- sort?: Sorting[];
660
- /** 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. */
661
- fields?: string[];
662
- /** 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. */
663
- fieldsets?: string[];
664
- }
665
- /** @oneof */
666
- interface QueryV2PagingMethodOneOf {
667
- /** Paging options to limit and offset the number of items. */
668
- paging?: Paging;
669
- /** 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`. */
670
- cursorPaging?: CursorPaging;
671
- }
672
- interface Sorting {
782
+ wixUserId?: string;
673
783
  /**
674
- * Name of the field to sort by.
675
- * @maxLength 512
784
+ * ID of an app.
785
+ * @format GUID
676
786
  */
677
- fieldName?: string;
678
- /** Sort order. */
679
- order?: SortOrderWithLiterals;
787
+ appId?: string;
680
788
  }
681
- declare enum SortOrder {
682
- ASC = "ASC",
683
- DESC = "DESC"
789
+ declare enum WebhookIdentityType {
790
+ UNKNOWN = "UNKNOWN",
791
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
792
+ MEMBER = "MEMBER",
793
+ WIX_USER = "WIX_USER",
794
+ APP = "APP"
684
795
  }
685
796
  /** @enumType */
686
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
687
- interface Paging {
688
- /** Number of items to load. */
689
- limit?: number | null;
690
- /** Number of items to skip in the current sort order. */
691
- offset?: number | null;
692
- }
693
- interface CursorPaging {
797
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
798
+ interface AccountInfo {
694
799
  /**
695
- * Maximum number of items to return in the results.
696
- * @max 100
800
+ * ID of the Wix account associated with the event.
801
+ * @format GUID
697
802
  */
698
- limit?: number | null;
803
+ accountId?: string | null;
699
804
  /**
700
- * Pointer to the next or previous page in the list of results.
701
- *
702
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
703
- * Not relevant for the first request.
704
- * @maxLength 16000
805
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
806
+ * @format GUID
705
807
  */
706
- cursor?: string | null;
808
+ parentAccountId?: string | null;
809
+ /**
810
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
811
+ * @format GUID
812
+ */
813
+ siteId?: string | null;
707
814
  }
708
- interface QueryDocumentResponse {
709
- /** The retrieved Documents */
710
- documents?: Document[];
711
- /** Query results' metadata */
712
- metadata?: PagingMetadataV2;
815
+ interface GetDownloadPageRequest {
816
+ /** @maxLength 1000 */
817
+ file: string | null;
713
818
  }
714
- interface PagingMetadataV2 {
715
- /** Number of items returned in the response. */
716
- count?: number | null;
717
- /** Offset that was requested. */
718
- offset?: number | null;
719
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
720
- total?: number | null;
721
- /** Flag that indicates the server failed to calculate the `total` field. */
722
- tooManyToCount?: boolean | null;
723
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
724
- cursors?: Cursors;
819
+ interface RawHttpResponse {
820
+ body?: Uint8Array;
821
+ statusCode?: number | null;
822
+ headers?: HeadersEntry[];
725
823
  }
726
- interface Cursors {
824
+ interface HeadersEntry {
825
+ key?: string;
826
+ value?: string;
827
+ }
828
+ interface RedirectToDocumentRequest {
829
+ /** @maxLength 1000 */
830
+ file: string | null;
831
+ }
832
+ interface RenderDocumentRequest {
833
+ /** Template settings. */
834
+ templateSettings?: TemplateSettings;
835
+ /** Document content. */
836
+ content?: DocumentContent;
837
+ /** Output format, defaults to PDF. */
838
+ outputFormat?: RenderFormatWithLiterals;
727
839
  /**
728
- * Cursor string pointing to the next page in the list of results.
729
- * @maxLength 16000
840
+ * Overrides papyrusTemplatesStaticsUrl: "//static.parastorage.com/services/papyrus-templates-statics/${version_override}/"
841
+ * @maxLength 100
730
842
  */
731
- next?: string | null;
843
+ versionOverride?: string | null;
732
844
  /**
733
- * Cursor pointing to the previous page in the list of results.
734
- * @maxLength 16000
845
+ * Overrides static versions for the statics config.
846
+ * @maxSize 10
735
847
  */
736
- prev?: string | null;
848
+ staticOverrides?: Record<string, string>;
737
849
  }
738
- interface UpdateDocumentRequest {
850
+ interface TemplateSettings {
739
851
  /**
740
- * Document ID.
852
+ * Auto generated ID.
741
853
  * @format GUID
742
854
  * @readonly
743
855
  */
744
- id: string | null;
745
- /** Document render status. */
746
- renderStatus?: RenderStatusWithLiterals;
747
- /** Rendered document file. */
748
- file?: DocumentFile;
749
- /** Rendered document source HTML file. */
750
- sourceFile?: DocumentFile;
751
- }
752
- interface DocumentFile {
753
- /** File ID. */
754
- fileId?: string | null;
755
- /** File URL. Defined only for public documents. */
756
- staticUrl?: string | null;
757
- /** File path. */
758
- filePath?: string | null;
759
- /** Size in bytes. */
760
- sizeInBytes?: number | null;
761
- }
762
- interface UpdateDocumentResponse {
763
- /** The created Document */
764
- document?: Document;
765
- }
766
- interface DocumentRendered {
767
- /** Rendered document */
768
- document?: Document;
769
- }
770
- interface DocumentRenderFailed {
771
- /** Document that failed to render */
772
- document?: Document;
773
- }
774
- interface DownloadDocumentRequest {
775
- /**
776
- * ID of the Document to retrieve
777
- * @format GUID
778
- */
779
- documentId: string;
856
+ id?: string | null;
780
857
  /**
781
- * URL expiration time. Only relevant for private documents.
782
- * @min 600
783
- * @max 86400
858
+ * Wix app definition ID.
859
+ * @minLength 1
860
+ * @maxLength 20
784
861
  */
785
- urlExpirationInSeconds?: number | null;
862
+ appSlug?: string | null;
786
863
  /**
787
- * Whether the link downloads the file or opens the file in the browser.
788
- * Default: `ATTACHMENT`
864
+ * The type of the template.
865
+ * @minLength 1
866
+ * @maxLength 20
789
867
  */
790
- contentDisposition?: ContentDispositionWithLiterals;
791
- }
792
- declare enum ContentDisposition {
793
- /** The link downloads the file. */
794
- ATTACHMENT = "ATTACHMENT",
795
- /** The link opens the file in the browser. */
796
- INLINE = "INLINE"
797
- }
798
- /** @enumType */
799
- type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
800
- interface DownloadDocumentResponse {
801
- /** Download URL. */
802
- downloadUrl?: string;
803
- /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
804
- expirationDate?: Date | null;
805
- }
806
- interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
868
+ templateType?: string | null;
807
869
  /**
808
- * ID of the Document to retrieve
809
- * @format GUID
870
+ * The id of the template.
871
+ * @minLength 1
872
+ * @maxLength 20
810
873
  */
811
- documentId?: string | null;
874
+ templateId?: string | null;
812
875
  /**
813
- * ID of the Document to retrieve
876
+ * Template settings external ID. For example ticket definition ID.
877
+ * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
814
878
  * @minLength 1
815
879
  * @maxLength 100
816
880
  */
817
881
  externalId?: string | null;
818
882
  /**
819
- * Signed file token
820
- * @minLength 1
821
- * @maxLength 500
883
+ * Date settings were created.
884
+ * @readonly
885
+ */
886
+ createdDate?: Date | null;
887
+ /**
888
+ * Date settings were updated.
889
+ * @readonly
890
+ */
891
+ updatedDate?: Date | null;
892
+ /** @maxSize 10 */
893
+ settingGroups?: SettingsGroup[];
894
+ /** Paper size */
895
+ paperSize?: PaperSizeWithLiterals;
896
+ pageOverflow?: PageOverflowWithLiterals;
897
+ }
898
+ interface TextSetting {
899
+ /**
900
+ * Font family class name
901
+ * @maxLength 20
902
+ */
903
+ fontFamily?: string | null;
904
+ /**
905
+ * Font style class names
906
+ * @maxSize 10
907
+ * @maxLength 20
908
+ */
909
+ fontStyle?: string[];
910
+ /**
911
+ * Text alignment class name
912
+ * @maxLength 20
822
913
  */
823
- fileToken?: string | null;
914
+ textAlignment?: string | null;
824
915
  /**
825
- * URL expiration time. Only relevant for private documents.
826
- * @min 600
827
- * @max 86400
916
+ * Text color hex code
917
+ * @minLength 7
918
+ * @maxLength 7
828
919
  */
829
- urlExpirationInSeconds?: number | null;
830
- /** @maxLength 100 */
831
- downloadButtonText?: string | null;
920
+ textColor?: string | null;
832
921
  /**
833
- * Whether the link downloads the file or opens the file in the browser.
834
- * Default: `ATTACHMENT`
922
+ * Font size
923
+ * @min 1
835
924
  */
836
- contentDisposition?: ContentDispositionWithLiterals;
925
+ fontSize?: number | null;
926
+ /** Text content setting */
927
+ textContent?: TextContent[];
837
928
  }
838
- /** @oneof */
839
- interface GetDownloadUrlRequestDocumentOneOf {
929
+ interface TextContent {
840
930
  /**
841
- * ID of the Document to retrieve
842
- * @format GUID
931
+ * @minLength 3
932
+ * @maxLength 50
843
933
  */
844
- documentId?: string | null;
934
+ id?: string;
935
+ /** @maxLength 500 */
936
+ value?: string | null;
937
+ visible?: boolean;
938
+ }
939
+ interface ImageSetting {
940
+ /** Wix media Image */
941
+ image?: Image;
942
+ /** Image resizing mode */
943
+ resize?: ResizeOptionWithLiterals;
944
+ }
945
+ interface Image {
946
+ /** WixMedia image ID. */
947
+ id?: string;
948
+ /** Image URL. */
949
+ url?: string;
845
950
  /**
846
- * ID of the Document to retrieve
847
- * @minLength 1
848
- * @maxLength 100
951
+ * Original image height.
952
+ * @readonly
849
953
  */
850
- externalId?: string | null;
954
+ height?: number;
851
955
  /**
852
- * Signed file token
853
- * @minLength 1
854
- * @maxLength 500
956
+ * Original image width.
957
+ * @readonly
855
958
  */
856
- fileToken?: string | null;
857
- }
858
- interface GetDownloadUrlResponse {
859
- /** Download URL. */
860
- downloadUrl?: string | null;
861
- /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
862
- expirationDate?: Date | null;
959
+ width?: number;
960
+ /** Image alt text. */
961
+ altText?: string | null;
863
962
  /**
864
- * Document ID.
865
- * @format GUID
963
+ * Image URL expiration date (when relevant).
964
+ * @internal
965
+ * @readonly
866
966
  */
867
- documentId?: string | null;
868
- /** Document render status. */
869
- renderStatus?: RenderStatusWithLiterals;
870
- /** Download URL. */
871
- downloadPageUrl?: string | null;
967
+ urlExpirationDate?: Date | null;
872
968
  /**
873
- * Client defined content checksum. Can be used for content comparison.
874
- * @minLength 1
875
- * @maxLength 64
969
+ * Image filename.
970
+ * @readonly
876
971
  */
877
- contentChecksum?: string | null;
878
- }
879
- interface DownloadDocumentSourceRequest {
972
+ filename?: string | null;
880
973
  /**
881
- * ID of the Document to retrieve
882
- * @format GUID
974
+ * Image size in bytes.
975
+ * @internal
976
+ * @readonly
977
+ * @format DECIMAL_VALUE
883
978
  */
884
- documentId: string;
979
+ sizeInBytes?: string | null;
885
980
  /**
886
- * Whether the link downloads the file or opens the file in the browser.
887
- * Default: `ATTACHMENT`
981
+ * Focal point of the image.
982
+ * @internal
888
983
  */
889
- contentDisposition?: ContentDispositionWithLiterals;
984
+ focalPoint?: FocalPoint;
890
985
  }
891
- interface DownloadDocumentSourceResponse {
892
- /** Download URL. Expires after 10 minutes. */
893
- downloadUrl?: string;
986
+ interface FocalPoint {
987
+ /** X-coordinate of the focal point. */
988
+ x?: number;
989
+ /** Y-coordinate of the focal point. */
990
+ y?: number;
991
+ /** crop by height */
992
+ height?: number | null;
993
+ /** crop by width */
994
+ width?: number | null;
894
995
  }
895
- interface MessageEnvelope {
996
+ declare enum ResizeOption {
997
+ /** Automatically resizes full image to fit image field */
998
+ FIT = "FIT",
999
+ /** Enables user to manually crop image to fit image field */
1000
+ CROP = "CROP"
1001
+ }
1002
+ /** @enumType */
1003
+ type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
1004
+ interface SelectSetting {
1005
+ /** Selected value */
1006
+ value?: string | null;
896
1007
  /**
897
- * App instance ID.
898
- * @format GUID
1008
+ * Color hex code
1009
+ * @minLength 7
1010
+ * @maxLength 7
899
1011
  */
900
- instanceId?: string | null;
1012
+ primaryColor?: string | null;
901
1013
  /**
902
- * Event type.
903
- * @maxLength 150
1014
+ * Color hex code
1015
+ * @minLength 7
1016
+ * @maxLength 7
904
1017
  */
905
- eventType?: string;
906
- /** The identification type and identity data. */
907
- identity?: IdentificationData;
908
- /** Stringify payload. */
909
- data?: string;
910
- /** Details related to the account */
911
- accountInfo?: AccountInfo;
1018
+ secondaryColor?: string | null;
1019
+ /** Size */
1020
+ size?: number | null;
912
1021
  }
913
- interface IdentificationData extends IdentificationDataIdOneOf {
914
- /**
915
- * ID of a site visitor that has not logged in to the site.
916
- * @format GUID
917
- */
918
- anonymousVisitorId?: string;
1022
+ interface BackgroundSetting {
919
1023
  /**
920
- * ID of a site visitor that has logged in to the site.
921
- * @format GUID
1024
+ * Color of the background hex code
1025
+ * @minLength 7
1026
+ * @maxLength 9
922
1027
  */
923
- memberId?: string;
1028
+ color?: string | null;
1029
+ /** Wix media Image */
1030
+ image?: Image;
1031
+ }
1032
+ interface SettingsGroup {
924
1033
  /**
925
- * ID of a Wix user (site owner, contributor, etc.).
926
- * @format GUID
1034
+ * Id of the control group
1035
+ * @minLength 5
1036
+ * @maxLength 50
927
1037
  */
928
- wixUserId?: string;
1038
+ groupId?: string;
929
1039
  /**
930
- * ID of an app.
931
- * @format GUID
1040
+ * Display settings.
1041
+ * @maxSize 20
932
1042
  */
933
- appId?: string;
934
- /** @readonly */
935
- identityType?: WebhookIdentityTypeWithLiterals;
936
- }
937
- /** @oneof */
938
- interface IdentificationDataIdOneOf {
1043
+ display?: Record<string, boolean>;
939
1044
  /**
940
- * ID of a site visitor that has not logged in to the site.
941
- * @format GUID
1045
+ * Texts settings.
1046
+ * @maxSize 20
942
1047
  */
943
- anonymousVisitorId?: string;
1048
+ texts?: Record<string, TextSetting>;
944
1049
  /**
945
- * ID of a site visitor that has logged in to the site.
946
- * @format GUID
1050
+ * Images settings.
1051
+ * @maxSize 10
947
1052
  */
948
- memberId?: string;
1053
+ images?: Record<string, ImageSetting>;
949
1054
  /**
950
- * ID of a Wix user (site owner, contributor, etc.).
951
- * @format GUID
1055
+ * Select option settings.
1056
+ * @maxSize 20
952
1057
  */
953
- wixUserId?: string;
1058
+ selects?: Record<string, SelectSetting>;
954
1059
  /**
955
- * ID of an app.
956
- * @format GUID
1060
+ * Backgrounds settings.
1061
+ * @maxSize 20
957
1062
  */
958
- appId?: string;
1063
+ backgrounds?: Record<string, BackgroundSetting>;
959
1064
  }
960
- declare enum WebhookIdentityType {
961
- UNKNOWN = "UNKNOWN",
962
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
963
- MEMBER = "MEMBER",
964
- WIX_USER = "WIX_USER",
965
- APP = "APP"
1065
+ declare enum PaperSize {
1066
+ A4_PORTRAIT = "A4_PORTRAIT",
1067
+ A4_LANDSCAPE = "A4_LANDSCAPE"
966
1068
  }
967
1069
  /** @enumType */
968
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
969
- interface AccountInfo {
1070
+ type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
1071
+ declare enum PageOverflow {
1072
+ CONTENT_HIDDEN = "CONTENT_HIDDEN",
1073
+ CONTENT_BREAK = "CONTENT_BREAK"
1074
+ }
1075
+ /** @enumType */
1076
+ type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
1077
+ declare enum RenderFormat {
1078
+ /** content-type: application/pdf */
1079
+ PDF = "PDF",
1080
+ /** content-type: text/html */
1081
+ HTML = "HTML"
1082
+ }
1083
+ /** @enumType */
1084
+ type RenderFormatWithLiterals = RenderFormat | 'PDF' | 'HTML';
1085
+ interface RenderDocumentByIdRequest {
970
1086
  /**
971
- * ID of the Wix account associated with the event.
1087
+ * Document ID.
972
1088
  * @format GUID
973
1089
  */
974
- accountId?: string | null;
1090
+ documentId?: string | null;
1091
+ /** Output format, defaults to PDF. */
1092
+ outputFormat?: RenderFormatWithLiterals;
1093
+ }
1094
+ interface GetRendererInfoRequest {
1095
+ }
1096
+ interface GetRendererInfoResponse {
1097
+ /** Renderer info */
1098
+ info?: Record<string, string>;
1099
+ }
1100
+ interface GetCachedHtmlRequest {
975
1101
  /**
976
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
977
- * @format GUID
1102
+ * Html Access Key.
1103
+ * @maxLength 100
978
1104
  */
979
- parentAccountId?: string | null;
1105
+ htmlAccessKey?: string;
980
1106
  /**
981
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
1107
+ * Meta Site Id.
982
1108
  * @format GUID
983
1109
  */
984
- siteId?: string | null;
1110
+ metaSiteId?: string | null;
985
1111
  }
986
1112
  /** @docsIgnore */
987
1113
  type DownloadDocumentApplicationErrors = {
@@ -1006,8 +1132,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1006
1132
  __responseType: Q;
1007
1133
  __originalResponseType: R;
1008
1134
  };
1009
- declare function getDownloadPage(): __PublicMethodMetaInfo<'GET', {}, GetDownloadPageRequest$1, GetDownloadPageRequest, RawHttpResponse$1, RawHttpResponse>;
1010
- declare function redirectToDocument(): __PublicMethodMetaInfo<'GET', {}, RedirectToDocumentRequest$1, RedirectToDocumentRequest, RawHttpResponse$1, RawHttpResponse>;
1011
1135
  declare function createDocument(): __PublicMethodMetaInfo<'POST', {}, CreateDocumentRequest$1, CreateDocumentRequest, CreateDocumentResponse$1, CreateDocumentResponse>;
1012
1136
  declare function getDocument(): __PublicMethodMetaInfo<'GET', {
1013
1137
  documentId: string;
@@ -1026,5 +1150,7 @@ declare function getDownloadUrl(): __PublicMethodMetaInfo<'GET', {}, GetDownload
1026
1150
  declare function downloadDocumentSource(): __PublicMethodMetaInfo<'GET', {
1027
1151
  documentId: string;
1028
1152
  }, DownloadDocumentSourceRequest$1, DownloadDocumentSourceRequest, DownloadDocumentSourceResponse$1, DownloadDocumentSourceResponse>;
1153
+ declare function getDownloadPage(): __PublicMethodMetaInfo<'GET', {}, GetDownloadPageRequest$1, GetDownloadPageRequest, RawHttpResponse$1, RawHttpResponse>;
1154
+ declare function redirectToDocument(): __PublicMethodMetaInfo<'GET', {}, RedirectToDocumentRequest$1, RedirectToDocumentRequest, RawHttpResponse$1, RawHttpResponse>;
1029
1155
 
1030
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type BackgroundSetting as BackgroundSettingOriginal, ContentDisposition as ContentDispositionOriginal, type ContentDispositionWithLiterals as ContentDispositionWithLiteralsOriginal, type CreateDocumentRequest as CreateDocumentRequestOriginal, type CreateDocumentResponse as CreateDocumentResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DebugOptions as DebugOptionsOriginal, type DeleteDocumentByExternalIdRequest as DeleteDocumentByExternalIdRequestOriginal, type DeleteDocumentByExternalIdResponse as DeleteDocumentByExternalIdResponseOriginal, type DeleteDocumentRequest as DeleteDocumentRequestOriginal, type DeleteDocumentResponse as DeleteDocumentResponseOriginal, type DocumentContent as DocumentContentOriginal, type DocumentFile as DocumentFileOriginal, type Document as DocumentOriginal, type DocumentRenderDelayed as DocumentRenderDelayedOriginal, type DocumentRenderFailed as DocumentRenderFailedOriginal, type DocumentRendered as DocumentRenderedOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadDocumentApplicationErrors as DownloadDocumentApplicationErrorsOriginal, type DownloadDocumentRequest as DownloadDocumentRequestOriginal, type DownloadDocumentResponse as DownloadDocumentResponseOriginal, type DownloadDocumentSourceApplicationErrors as DownloadDocumentSourceApplicationErrorsOriginal, type DownloadDocumentSourceRequest as DownloadDocumentSourceRequestOriginal, type DownloadDocumentSourceResponse as DownloadDocumentSourceResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FocalPoint as FocalPointOriginal, Format as FormatOriginal, type FormatWithLiterals as FormatWithLiteralsOriginal, type GetCachedHtmlRequest as GetCachedHtmlRequestOriginal, type GetDocumentRequest as GetDocumentRequestOriginal, type GetDocumentResponse as GetDocumentResponseOriginal, type GetDownloadPageRequest as GetDownloadPageRequestOriginal, type GetDownloadUrlRequestDocumentOneOf as GetDownloadUrlRequestDocumentOneOfOriginal, type GetDownloadUrlRequest as GetDownloadUrlRequestOriginal, type GetDownloadUrlResponse as GetDownloadUrlResponseOriginal, type GetRendererInfoRequest as GetRendererInfoRequestOriginal, type GetRendererInfoResponse as GetRendererInfoResponseOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImageSetting as ImageSettingOriginal, type MessageEnvelope as MessageEnvelopeOriginal, PageOverflow as PageOverflowOriginal, type PageOverflowWithLiterals as PageOverflowWithLiteralsOriginal, type PageSettings as PageSettingsOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, PaperSize as PaperSizeOriginal, type PaperSizeWithLiterals as PaperSizeWithLiteralsOriginal, type QueryDocumentRequest as QueryDocumentRequestOriginal, type QueryDocumentResponse as QueryDocumentResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RawHttpResponse as RawHttpResponseOriginal, type RedirectToDocumentRequest as RedirectToDocumentRequestOriginal, type RenderDelayedEventConfig as RenderDelayedEventConfigOriginal, type RenderDocumentByIdRequest as RenderDocumentByIdRequestOriginal, type RenderDocumentRequest as RenderDocumentRequestOriginal, RenderFormat as RenderFormatOriginal, type RenderFormatWithLiterals as RenderFormatWithLiteralsOriginal, RenderStatus as RenderStatusOriginal, type RenderStatusWithLiterals as RenderStatusWithLiteralsOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, ResizeOption as ResizeOptionOriginal, type ResizeOptionWithLiterals as ResizeOptionWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SelectSetting as SelectSettingOriginal, type SettingsGroup as SettingsGroupOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type TemplateSettings as TemplateSettingsOriginal, type TemplateSettingsOverride as TemplateSettingsOverrideOriginal, type TextContent as TextContentOriginal, type TextSetting as TextSettingOriginal, type UpdateDocumentRequest as UpdateDocumentRequestOriginal, type UpdateDocumentResponse as UpdateDocumentResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WixMpClientVersion as WixMpClientVersionOriginal, type WixMpClientVersionWithLiterals as WixMpClientVersionWithLiteralsOriginal, type __PublicMethodMetaInfo, createDocument, deleteDocument, downloadDocument, downloadDocumentSource, getDocument, getDownloadPage, getDownloadUrl, queryDocument, redirectToDocument, updateDocument };
1156
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type BackgroundSetting as BackgroundSettingOriginal, ContentDisposition as ContentDispositionOriginal, type ContentDispositionWithLiterals as ContentDispositionWithLiteralsOriginal, type CreateDocumentRequest as CreateDocumentRequestOriginal, type CreateDocumentResponse as CreateDocumentResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DebugOptions as DebugOptionsOriginal, type DeleteDocumentByExternalIdRequest as DeleteDocumentByExternalIdRequestOriginal, type DeleteDocumentByExternalIdResponse as DeleteDocumentByExternalIdResponseOriginal, type DeleteDocumentRequest as DeleteDocumentRequestOriginal, type DeleteDocumentResponse as DeleteDocumentResponseOriginal, type DocumentContent as DocumentContentOriginal, type DocumentFile as DocumentFileOriginal, type Document as DocumentOriginal, type DocumentRenderDelayed as DocumentRenderDelayedOriginal, type DocumentRenderFailed as DocumentRenderFailedOriginal, type DocumentRendered as DocumentRenderedOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadDocumentApplicationErrors as DownloadDocumentApplicationErrorsOriginal, type DownloadDocumentRequest as DownloadDocumentRequestOriginal, type DownloadDocumentResponse as DownloadDocumentResponseOriginal, type DownloadDocumentSourceApplicationErrors as DownloadDocumentSourceApplicationErrorsOriginal, type DownloadDocumentSourceRequest as DownloadDocumentSourceRequestOriginal, type DownloadDocumentSourceResponse as DownloadDocumentSourceResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FocalPoint as FocalPointOriginal, Format as FormatOriginal, type FormatWithLiterals as FormatWithLiteralsOriginal, type GetCachedHtmlRequest as GetCachedHtmlRequestOriginal, type GetDocumentRequest as GetDocumentRequestOriginal, type GetDocumentResponse as GetDocumentResponseOriginal, type GetDownloadPageRequest as GetDownloadPageRequestOriginal, type GetDownloadUrlRequestDocumentOneOf as GetDownloadUrlRequestDocumentOneOfOriginal, type GetDownloadUrlRequest as GetDownloadUrlRequestOriginal, type GetDownloadUrlResponse as GetDownloadUrlResponseOriginal, type GetRendererInfoRequest as GetRendererInfoRequestOriginal, type GetRendererInfoResponse as GetRendererInfoResponseOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImageSetting as ImageSettingOriginal, type MessageEnvelope as MessageEnvelopeOriginal, PageOverflow as PageOverflowOriginal, type PageOverflowWithLiterals as PageOverflowWithLiteralsOriginal, type PageSettings as PageSettingsOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, PaperSize as PaperSizeOriginal, type PaperSizeWithLiterals as PaperSizeWithLiteralsOriginal, type QueryDocumentRequest as QueryDocumentRequestOriginal, type QueryDocumentResponse as QueryDocumentResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RawHttpResponse as RawHttpResponseOriginal, type RedirectToDocumentRequest as RedirectToDocumentRequestOriginal, type RenderDelayedEventConfig as RenderDelayedEventConfigOriginal, type RenderDocumentByIdRequest as RenderDocumentByIdRequestOriginal, type RenderDocumentRequest as RenderDocumentRequestOriginal, RenderFormat as RenderFormatOriginal, type RenderFormatWithLiterals as RenderFormatWithLiteralsOriginal, RenderStatus as RenderStatusOriginal, type RenderStatusWithLiterals as RenderStatusWithLiteralsOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, ResizeOption as ResizeOptionOriginal, type ResizeOptionWithLiterals as ResizeOptionWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SelectSetting as SelectSettingOriginal, type SettingsGroup as SettingsGroupOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type TemplateSettings as TemplateSettingsOriginal, type TemplateSettingsOverride as TemplateSettingsOverrideOriginal, type TextContent as TextContentOriginal, type TextSetting as TextSettingOriginal, type UpdateDocumentRequest as UpdateDocumentRequestOriginal, type UpdateDocumentResponse as UpdateDocumentResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WixMpClientVersion as WixMpClientVersionOriginal, type WixMpClientVersionWithLiterals as WixMpClientVersionWithLiteralsOriginal, type __PublicMethodMetaInfo, createDocument, deleteDocument, downloadDocument, downloadDocumentSource, getDocument, getDownloadPage, getDownloadUrl, queryDocument, redirectToDocument, updateDocument };