@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.js';
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.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /** Document is the main entity of DocumentService. */
@@ -235,258 +235,328 @@ interface DebugOptions {
235
235
  */
236
236
  staticsVersionOverride?: string | null;
237
237
  }
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>;
238
+ interface DocumentRenderDelayed {
239
+ /** Document that is being rendered. */
240
+ document?: Document;
255
241
  }
256
- interface TemplateSettings {
242
+ interface CreateDocumentRequest {
243
+ /** Document to be created */
244
+ document?: Document;
245
+ }
246
+ interface CreateDocumentResponse {
247
+ /** The created Document */
248
+ document?: Document;
249
+ }
250
+ interface GetDocumentRequest {
257
251
  /**
258
- * Auto generated ID.
252
+ * ID of the Document to retrieve
259
253
  * @format GUID
260
- * @readonly
261
- */
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
254
  */
274
- templateType?: string | null;
255
+ documentId: string;
256
+ /** @maxSize 1 */
257
+ fields?: RequestedFieldsWithLiterals[];
258
+ }
259
+ declare enum RequestedFields {
260
+ /** Include `documentContent` in the response. */
261
+ DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
262
+ }
263
+ /** @enumType */
264
+ type RequestedFieldsWithLiterals = RequestedFields | 'DOCUMENT_CONTENT';
265
+ interface GetDocumentResponse {
266
+ /** The retrieved Document */
267
+ document?: Document;
268
+ }
269
+ interface DeleteDocumentRequest {
275
270
  /**
276
- * The id of the template.
277
- * @minLength 1
278
- * @maxLength 20
271
+ * ID of the Document to delete
272
+ * @format GUID
279
273
  */
280
- templateId?: string | null;
274
+ documentId: string;
275
+ }
276
+ interface DeleteDocumentResponse {
277
+ /** Deleted document. */
278
+ document?: Document;
279
+ }
280
+ interface DeleteDocumentByExternalIdRequest {
281
281
  /**
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)
282
+ * External ID of the Document to delete
284
283
  * @minLength 1
285
284
  * @maxLength 100
286
285
  */
287
- externalId?: string | null;
286
+ externalId?: string;
287
+ }
288
+ interface DeleteDocumentByExternalIdResponse {
289
+ /** Deleted document. */
290
+ document?: Document;
291
+ }
292
+ interface QueryDocumentRequest {
293
+ /** WQL expression */
294
+ query: QueryV2;
295
+ /** @maxSize 1 */
296
+ fields?: RequestedFieldsWithLiterals[];
297
+ }
298
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
299
+ /** Paging options to limit and offset the number of items. */
300
+ paging?: Paging;
301
+ /** 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`. */
302
+ cursorPaging?: CursorPaging;
288
303
  /**
289
- * Date settings were created.
290
- * @readonly
304
+ * Filter object.
305
+ *
306
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
291
307
  */
292
- createdDate?: Date | null;
308
+ filter?: Record<string, any> | null;
293
309
  /**
294
- * Date settings were updated.
295
- * @readonly
310
+ * Sort object.
311
+ *
312
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
296
313
  */
297
- updatedDate?: Date | null;
298
- /** @maxSize 10 */
299
- settingGroups?: SettingsGroup[];
300
- /** Paper size */
301
- paperSize?: PaperSizeWithLiterals;
302
- pageOverflow?: PageOverflowWithLiterals;
314
+ sort?: Sorting[];
315
+ /** 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. */
316
+ fields?: string[];
317
+ /** 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. */
318
+ fieldsets?: string[];
303
319
  }
304
- interface TextSetting {
305
- /**
306
- * Font family class name
307
- * @maxLength 20
308
- */
309
- fontFamily?: string | null;
320
+ /** @oneof */
321
+ interface QueryV2PagingMethodOneOf {
322
+ /** Paging options to limit and offset the number of items. */
323
+ paging?: Paging;
324
+ /** 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`. */
325
+ cursorPaging?: CursorPaging;
326
+ }
327
+ interface Sorting {
310
328
  /**
311
- * Font style class names
312
- * @maxSize 10
313
- * @maxLength 20
329
+ * Name of the field to sort by.
330
+ * @maxLength 512
314
331
  */
315
- fontStyle?: string[];
332
+ fieldName?: string;
333
+ /** Sort order. */
334
+ order?: SortOrderWithLiterals;
316
335
  /**
317
- * Text alignment class name
318
- * @maxLength 20
336
+ * Origin point for geo-distance sorting on a GEO field
337
+ * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
319
338
  */
320
- textAlignment?: string | null;
339
+ origin?: AddressLocation;
340
+ }
341
+ declare enum SortOrder {
342
+ ASC = "ASC",
343
+ DESC = "DESC"
344
+ }
345
+ /** @enumType */
346
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
347
+ interface AddressLocation {
348
+ /** Address latitude. */
349
+ latitude?: number | null;
350
+ /** Address longitude. */
351
+ longitude?: number | null;
352
+ }
353
+ interface Paging {
354
+ /** Number of items to load. */
355
+ limit?: number | null;
356
+ /** Number of items to skip in the current sort order. */
357
+ offset?: number | null;
358
+ }
359
+ interface CursorPaging {
321
360
  /**
322
- * Text color hex code
323
- * @minLength 7
324
- * @maxLength 7
361
+ * Maximum number of items to return in the results.
362
+ * @max 100
325
363
  */
326
- textColor?: string | null;
364
+ limit?: number | null;
327
365
  /**
328
- * Font size
329
- * @min 1
366
+ * Pointer to the next or previous page in the list of results.
367
+ *
368
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
369
+ * Not relevant for the first request.
370
+ * @maxLength 16000
330
371
  */
331
- fontSize?: number | null;
332
- /** Text content setting */
333
- textContent?: TextContent[];
372
+ cursor?: string | null;
334
373
  }
335
- interface TextContent {
336
- /**
337
- * @minLength 3
338
- * @maxLength 50
339
- */
340
- id?: string;
341
- /** @maxLength 500 */
342
- value?: string | null;
343
- visible?: boolean;
374
+ interface QueryDocumentResponse {
375
+ /** The retrieved Documents */
376
+ documents?: Document[];
377
+ /** Query results' metadata */
378
+ metadata?: PagingMetadataV2;
344
379
  }
345
- interface ImageSetting {
346
- /** Wix media Image */
347
- image?: Image;
348
- /** Image resizing mode */
349
- resize?: ResizeOptionWithLiterals;
380
+ interface PagingMetadataV2 {
381
+ /** Number of items returned in the response. */
382
+ count?: number | null;
383
+ /** Offset that was requested. */
384
+ offset?: number | null;
385
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
386
+ total?: number | null;
387
+ /** Flag that indicates the server failed to calculate the `total` field. */
388
+ tooManyToCount?: boolean | null;
389
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
390
+ cursors?: Cursors;
350
391
  }
351
- interface Image {
352
- /** WixMedia image ID. */
353
- id?: string;
354
- /** Image URL. */
355
- url?: string;
392
+ interface Cursors {
356
393
  /**
357
- * Original image height.
358
- * @readonly
394
+ * Cursor string pointing to the next page in the list of results.
395
+ * @maxLength 16000
359
396
  */
360
- height?: number;
397
+ next?: string | null;
361
398
  /**
362
- * Original image width.
363
- * @readonly
399
+ * Cursor pointing to the previous page in the list of results.
400
+ * @maxLength 16000
364
401
  */
365
- width?: number;
366
- /** Image alt text. */
367
- altText?: string | null;
402
+ prev?: string | null;
403
+ }
404
+ interface UpdateDocumentRequest {
368
405
  /**
369
- * Image filename.
406
+ * Document ID.
407
+ * @format GUID
370
408
  * @readonly
371
409
  */
372
- filename?: string | null;
410
+ id: string | null;
411
+ /** Document render status. */
412
+ renderStatus?: RenderStatusWithLiterals;
413
+ /** Rendered document file. */
414
+ file?: DocumentFile;
415
+ /** Rendered document source HTML file. */
416
+ sourceFile?: DocumentFile;
373
417
  }
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;
418
+ interface DocumentFile {
419
+ /** File ID. */
420
+ fileId?: string | null;
421
+ /** File URL. Defined only for public documents. */
422
+ staticUrl?: string | null;
423
+ /** File path. */
424
+ filePath?: string | null;
425
+ /** Size in bytes. */
426
+ sizeInBytes?: number | null;
383
427
  }
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"
428
+ interface UpdateDocumentResponse {
429
+ /** The created Document */
430
+ document?: Document;
389
431
  }
390
- /** @enumType */
391
- type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
392
- interface SelectSetting {
393
- /** Selected value */
394
- value?: string | null;
432
+ interface DocumentRendered {
433
+ /** Rendered document */
434
+ document?: Document;
435
+ }
436
+ interface DocumentRenderFailed {
437
+ /** Document that failed to render */
438
+ document?: Document;
439
+ }
440
+ interface DownloadDocumentRequest {
395
441
  /**
396
- * Color hex code
397
- * @minLength 7
398
- * @maxLength 7
442
+ * ID of the Document to retrieve
443
+ * @format GUID
399
444
  */
400
- primaryColor?: string | null;
445
+ documentId: string;
401
446
  /**
402
- * Color hex code
403
- * @minLength 7
404
- * @maxLength 7
447
+ * URL expiration time. Only relevant for private documents.
448
+ * @min 600
449
+ * @max 86400
405
450
  */
406
- secondaryColor?: string | null;
407
- /** Size */
408
- size?: number | null;
409
- }
410
- interface BackgroundSetting {
451
+ urlExpirationInSeconds?: number | null;
411
452
  /**
412
- * Color of the background hex code
413
- * @minLength 7
414
- * @maxLength 9
453
+ * Whether the link downloads the file or opens the file in the browser.
454
+ * Default: `ATTACHMENT`
415
455
  */
416
- color?: string | null;
417
- /** Wix media Image */
418
- image?: Image;
456
+ contentDisposition?: ContentDispositionWithLiterals;
419
457
  }
420
- interface SettingsGroup {
458
+ declare enum ContentDisposition {
459
+ /** The link downloads the file. */
460
+ ATTACHMENT = "ATTACHMENT",
461
+ /** The link opens the file in the browser. */
462
+ INLINE = "INLINE"
463
+ }
464
+ /** @enumType */
465
+ type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
466
+ interface DownloadDocumentResponse {
467
+ /** Download URL. */
468
+ downloadUrl?: string;
469
+ /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
470
+ expirationDate?: Date | null;
471
+ }
472
+ interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
421
473
  /**
422
- * Id of the control group
423
- * @minLength 5
424
- * @maxLength 50
474
+ * ID of the Document to retrieve
475
+ * @format GUID
425
476
  */
426
- groupId?: string;
477
+ documentId?: string | null;
427
478
  /**
428
- * Display settings.
429
- * @maxSize 20
479
+ * ID of the Document to retrieve
480
+ * @minLength 1
481
+ * @maxLength 100
430
482
  */
431
- display?: Record<string, boolean>;
483
+ externalId?: string | null;
432
484
  /**
433
- * Texts settings.
434
- * @maxSize 20
485
+ * Signed file token
486
+ * @minLength 1
487
+ * @maxLength 500
435
488
  */
436
- texts?: Record<string, TextSetting>;
489
+ fileToken?: string | null;
437
490
  /**
438
- * Images settings.
439
- * @maxSize 10
491
+ * URL expiration time. Only relevant for private documents.
492
+ * @min 600
493
+ * @max 86400
440
494
  */
441
- images?: Record<string, ImageSetting>;
495
+ urlExpirationInSeconds?: number | null;
496
+ /** @maxLength 100 */
497
+ downloadButtonText?: string | null;
442
498
  /**
443
- * Select option settings.
444
- * @maxSize 20
499
+ * Whether the link downloads the file or opens the file in the browser.
500
+ * Default: `ATTACHMENT`
445
501
  */
446
- selects?: Record<string, SelectSetting>;
502
+ contentDisposition?: ContentDispositionWithLiterals;
503
+ }
504
+ /** @oneof */
505
+ interface GetDownloadUrlRequestDocumentOneOf {
447
506
  /**
448
- * Backgrounds settings.
449
- * @maxSize 20
507
+ * ID of the Document to retrieve
508
+ * @format GUID
450
509
  */
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;
510
+ documentId?: string | null;
511
+ /**
512
+ * ID of the Document to retrieve
513
+ * @minLength 1
514
+ * @maxLength 100
515
+ */
516
+ externalId?: string | null;
517
+ /**
518
+ * Signed file token
519
+ * @minLength 1
520
+ * @maxLength 500
521
+ */
522
+ fileToken?: string | null;
481
523
  }
482
- interface RenderDocumentByIdRequest {
524
+ interface GetDownloadUrlResponse {
525
+ /** Download URL. */
526
+ downloadUrl?: string | null;
527
+ /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
528
+ expirationDate?: Date | null;
483
529
  /**
484
530
  * Document ID.
485
531
  * @format GUID
486
532
  */
487
533
  documentId?: string | null;
488
- /** Output format, defaults to PDF. */
489
- outputFormat?: RenderFormatWithLiterals;
534
+ /** Document render status. */
535
+ renderStatus?: RenderStatusWithLiterals;
536
+ /** Download URL. */
537
+ downloadPageUrl?: string | null;
538
+ /**
539
+ * Client defined content checksum. Can be used for content comparison.
540
+ * @minLength 1
541
+ * @maxLength 64
542
+ */
543
+ contentChecksum?: string | null;
544
+ }
545
+ interface DownloadDocumentSourceRequest {
546
+ /**
547
+ * ID of the Document to retrieve
548
+ * @format GUID
549
+ */
550
+ documentId: string;
551
+ /**
552
+ * Whether the link downloads the file or opens the file in the browser.
553
+ * Default: `ATTACHMENT`
554
+ */
555
+ contentDisposition?: ContentDispositionWithLiterals;
556
+ }
557
+ interface DownloadDocumentSourceResponse {
558
+ /** Download URL. Expires after 10 minutes. */
559
+ downloadUrl?: string;
490
560
  }
491
561
  interface DomainEvent extends DomainEventBodyOneOf {
492
562
  createdEvent?: EntityCreatedEvent;
@@ -517,7 +587,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
517
587
  /** If present, indicates the action that triggered the event. */
518
588
  originatedFrom?: string | null;
519
589
  /**
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.
590
+ * 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
591
  * 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
592
  */
523
593
  entityEventSequence?: string | null;
@@ -554,434 +624,375 @@ interface ActionEvent {
554
624
  }
555
625
  interface Empty {
556
626
  }
557
- interface GetRendererInfoRequest {
558
- }
559
- interface GetRendererInfoResponse {
560
- /** Renderer info */
561
- info?: Record<string, string>;
562
- }
563
- interface GetCachedHtmlRequest {
564
- /**
565
- * Html Access Key.
566
- * @maxLength 100
567
- */
568
- htmlAccessKey?: string;
569
- /**
570
- * Meta Site Id.
571
- * @format GUID
572
- */
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 {
596
- /**
597
- * ID of the Document to retrieve
598
- * @format GUID
599
- */
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 {
627
+ interface MessageEnvelope {
615
628
  /**
616
- * ID of the Document to delete
629
+ * App instance ID.
617
630
  * @format GUID
618
631
  */
619
- documentId: string;
620
- }
621
- interface DeleteDocumentResponse {
622
- /** Deleted document. */
623
- document?: Document;
624
- }
625
- interface DeleteDocumentByExternalIdRequest {
632
+ instanceId?: string | null;
626
633
  /**
627
- * External ID of the Document to delete
628
- * @minLength 1
629
- * @maxLength 100
634
+ * Event type.
635
+ * @maxLength 150
630
636
  */
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[];
637
+ eventType?: string;
638
+ /** The identification type and identity data. */
639
+ identity?: IdentificationData;
640
+ /** Stringify payload. */
641
+ data?: string;
642
+ /** Details related to the account */
643
+ accountInfo?: AccountInfo;
642
644
  }
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;
645
+ interface IdentificationData extends IdentificationDataIdOneOf {
648
646
  /**
649
- * Filter object.
650
- *
651
- * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
647
+ * ID of a site visitor that has not logged in to the site.
648
+ * @format GUID
652
649
  */
653
- filter?: Record<string, any> | null;
650
+ anonymousVisitorId?: string;
654
651
  /**
655
- * Sort object.
656
- *
657
- * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
652
+ * ID of a site visitor that has logged in to the site.
653
+ * @format GUID
658
654
  */
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[];
655
+ memberId?: string;
656
+ /**
657
+ * ID of a Wix user (site owner, contributor, etc.).
658
+ * @format GUID
659
+ */
660
+ wixUserId?: string;
661
+ /**
662
+ * ID of an app.
663
+ * @format GUID
664
+ */
665
+ appId?: string;
666
+ /** @readonly */
667
+ identityType?: WebhookIdentityTypeWithLiterals;
664
668
  }
665
669
  /** @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 {
670
+ interface IdentificationDataIdOneOf {
673
671
  /**
674
- * Name of the field to sort by.
675
- * @maxLength 512
672
+ * ID of a site visitor that has not logged in to the site.
673
+ * @format GUID
676
674
  */
677
- fieldName?: string;
678
- /** Sort order. */
679
- order?: SortOrderWithLiterals;
680
- }
681
- declare enum SortOrder {
682
- ASC = "ASC",
683
- DESC = "DESC"
684
- }
685
- /** @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 {
675
+ anonymousVisitorId?: string;
694
676
  /**
695
- * Maximum number of items to return in the results.
696
- * @max 100
677
+ * ID of a site visitor that has logged in to the site.
678
+ * @format GUID
697
679
  */
698
- limit?: number | null;
680
+ memberId?: string;
699
681
  /**
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
682
+ * ID of a Wix user (site owner, contributor, etc.).
683
+ * @format GUID
705
684
  */
706
- cursor?: string | null;
707
- }
708
- interface QueryDocumentResponse {
709
- /** The retrieved Documents */
710
- documents?: Document[];
711
- /** Query results' metadata */
712
- metadata?: PagingMetadataV2;
685
+ wixUserId?: string;
686
+ /**
687
+ * ID of an app.
688
+ * @format GUID
689
+ */
690
+ appId?: string;
713
691
  }
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;
692
+ declare enum WebhookIdentityType {
693
+ UNKNOWN = "UNKNOWN",
694
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
695
+ MEMBER = "MEMBER",
696
+ WIX_USER = "WIX_USER",
697
+ APP = "APP"
725
698
  }
726
- interface Cursors {
699
+ /** @enumType */
700
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
701
+ interface AccountInfo {
727
702
  /**
728
- * Cursor string pointing to the next page in the list of results.
729
- * @maxLength 16000
703
+ * ID of the Wix account associated with the event.
704
+ * @format GUID
730
705
  */
731
- next?: string | null;
706
+ accountId?: string | null;
732
707
  /**
733
- * Cursor pointing to the previous page in the list of results.
734
- * @maxLength 16000
708
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
709
+ * @format GUID
735
710
  */
736
- prev?: string | null;
737
- }
738
- interface UpdateDocumentRequest {
711
+ parentAccountId?: string | null;
739
712
  /**
740
- * Document ID.
713
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
741
714
  * @format GUID
742
- * @readonly
743
715
  */
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;
716
+ siteId?: string | null;
751
717
  }
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;
718
+ interface GetDownloadPageRequest {
719
+ /** @maxLength 1000 */
720
+ file: string | null;
761
721
  }
762
- interface UpdateDocumentResponse {
763
- /** The created Document */
764
- document?: Document;
722
+ interface RawHttpResponse {
723
+ body?: Uint8Array;
724
+ statusCode?: number | null;
725
+ headers?: HeadersEntry[];
765
726
  }
766
- interface DocumentRendered {
767
- /** Rendered document */
768
- document?: Document;
727
+ interface HeadersEntry {
728
+ key?: string;
729
+ value?: string;
769
730
  }
770
- interface DocumentRenderFailed {
771
- /** Document that failed to render */
772
- document?: Document;
731
+ interface RedirectToDocumentRequest {
732
+ /** @maxLength 1000 */
733
+ file: string | null;
773
734
  }
774
- interface DownloadDocumentRequest {
735
+ interface RenderDocumentRequest {
736
+ /** Template settings. */
737
+ templateSettings?: TemplateSettings;
738
+ /** Document content. */
739
+ content?: DocumentContent;
740
+ /** Output format, defaults to PDF. */
741
+ outputFormat?: RenderFormatWithLiterals;
775
742
  /**
776
- * ID of the Document to retrieve
743
+ * Overrides papyrusTemplatesStaticsUrl: "//static.parastorage.com/services/papyrus-templates-statics/${version_override}/"
744
+ * @maxLength 100
745
+ */
746
+ versionOverride?: string | null;
747
+ /**
748
+ * Overrides static versions for the statics config.
749
+ * @maxSize 10
750
+ */
751
+ staticOverrides?: Record<string, string>;
752
+ }
753
+ interface TemplateSettings {
754
+ /**
755
+ * Auto generated ID.
777
756
  * @format GUID
757
+ * @readonly
778
758
  */
779
- documentId: string;
759
+ id?: string | null;
780
760
  /**
781
- * URL expiration time. Only relevant for private documents.
782
- * @min 600
783
- * @max 86400
761
+ * Wix app definition ID.
762
+ * @minLength 1
763
+ * @maxLength 20
784
764
  */
785
- urlExpirationInSeconds?: number | null;
765
+ appSlug?: string | null;
786
766
  /**
787
- * Whether the link downloads the file or opens the file in the browser.
788
- * Default: `ATTACHMENT`
767
+ * The type of the template.
768
+ * @minLength 1
769
+ * @maxLength 20
789
770
  */
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 {
771
+ templateType?: string | null;
807
772
  /**
808
- * ID of the Document to retrieve
809
- * @format GUID
773
+ * The id of the template.
774
+ * @minLength 1
775
+ * @maxLength 20
810
776
  */
811
- documentId?: string | null;
777
+ templateId?: string | null;
812
778
  /**
813
- * ID of the Document to retrieve
779
+ * Template settings external ID. For example ticket definition ID.
780
+ * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
814
781
  * @minLength 1
815
782
  * @maxLength 100
816
783
  */
817
784
  externalId?: string | null;
818
785
  /**
819
- * Signed file token
820
- * @minLength 1
821
- * @maxLength 500
786
+ * Date settings were created.
787
+ * @readonly
822
788
  */
823
- fileToken?: string | null;
789
+ createdDate?: Date | null;
824
790
  /**
825
- * URL expiration time. Only relevant for private documents.
826
- * @min 600
827
- * @max 86400
791
+ * Date settings were updated.
792
+ * @readonly
793
+ */
794
+ updatedDate?: Date | null;
795
+ /** @maxSize 10 */
796
+ settingGroups?: SettingsGroup[];
797
+ /** Paper size */
798
+ paperSize?: PaperSizeWithLiterals;
799
+ pageOverflow?: PageOverflowWithLiterals;
800
+ }
801
+ interface TextSetting {
802
+ /**
803
+ * Font family class name
804
+ * @maxLength 20
828
805
  */
829
- urlExpirationInSeconds?: number | null;
830
- /** @maxLength 100 */
831
- downloadButtonText?: string | null;
806
+ fontFamily?: string | null;
832
807
  /**
833
- * Whether the link downloads the file or opens the file in the browser.
834
- * Default: `ATTACHMENT`
808
+ * Font style class names
809
+ * @maxSize 10
810
+ * @maxLength 20
835
811
  */
836
- contentDisposition?: ContentDispositionWithLiterals;
837
- }
838
- /** @oneof */
839
- interface GetDownloadUrlRequestDocumentOneOf {
812
+ fontStyle?: string[];
840
813
  /**
841
- * ID of the Document to retrieve
842
- * @format GUID
814
+ * Text alignment class name
815
+ * @maxLength 20
843
816
  */
844
- documentId?: string | null;
817
+ textAlignment?: string | null;
845
818
  /**
846
- * ID of the Document to retrieve
847
- * @minLength 1
848
- * @maxLength 100
819
+ * Text color hex code
820
+ * @minLength 7
821
+ * @maxLength 7
849
822
  */
850
- externalId?: string | null;
823
+ textColor?: string | null;
851
824
  /**
852
- * Signed file token
853
- * @minLength 1
854
- * @maxLength 500
825
+ * Font size
826
+ * @min 1
855
827
  */
856
- fileToken?: string | null;
828
+ fontSize?: number | null;
829
+ /** Text content setting */
830
+ textContent?: TextContent[];
857
831
  }
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;
832
+ interface TextContent {
863
833
  /**
864
- * Document ID.
865
- * @format GUID
834
+ * @minLength 3
835
+ * @maxLength 50
866
836
  */
867
- documentId?: string | null;
868
- /** Document render status. */
869
- renderStatus?: RenderStatusWithLiterals;
870
- /** Download URL. */
871
- downloadPageUrl?: string | null;
837
+ id?: string;
838
+ /** @maxLength 500 */
839
+ value?: string | null;
840
+ visible?: boolean;
841
+ }
842
+ interface ImageSetting {
843
+ /** Wix media Image */
844
+ image?: Image;
845
+ /** Image resizing mode */
846
+ resize?: ResizeOptionWithLiterals;
847
+ }
848
+ interface Image {
849
+ /** WixMedia image ID. */
850
+ id?: string;
851
+ /** Image URL. */
852
+ url?: string;
872
853
  /**
873
- * Client defined content checksum. Can be used for content comparison.
874
- * @minLength 1
875
- * @maxLength 64
854
+ * Original image height.
855
+ * @readonly
876
856
  */
877
- contentChecksum?: string | null;
878
- }
879
- interface DownloadDocumentSourceRequest {
857
+ height?: number;
880
858
  /**
881
- * ID of the Document to retrieve
882
- * @format GUID
859
+ * Original image width.
860
+ * @readonly
883
861
  */
884
- documentId: string;
862
+ width?: number;
863
+ /** Image alt text. */
864
+ altText?: string | null;
885
865
  /**
886
- * Whether the link downloads the file or opens the file in the browser.
887
- * Default: `ATTACHMENT`
866
+ * Image filename.
867
+ * @readonly
888
868
  */
889
- contentDisposition?: ContentDispositionWithLiterals;
869
+ filename?: string | null;
890
870
  }
891
- interface DownloadDocumentSourceResponse {
892
- /** Download URL. Expires after 10 minutes. */
893
- downloadUrl?: string;
871
+ interface FocalPoint {
872
+ /** X-coordinate of the focal point. */
873
+ x?: number;
874
+ /** Y-coordinate of the focal point. */
875
+ y?: number;
876
+ /** crop by height */
877
+ height?: number | null;
878
+ /** crop by width */
879
+ width?: number | null;
894
880
  }
895
- interface MessageEnvelope {
881
+ declare enum ResizeOption {
882
+ /** Automatically resizes full image to fit image field */
883
+ FIT = "FIT",
884
+ /** Enables user to manually crop image to fit image field */
885
+ CROP = "CROP"
886
+ }
887
+ /** @enumType */
888
+ type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
889
+ interface SelectSetting {
890
+ /** Selected value */
891
+ value?: string | null;
896
892
  /**
897
- * App instance ID.
898
- * @format GUID
893
+ * Color hex code
894
+ * @minLength 7
895
+ * @maxLength 7
899
896
  */
900
- instanceId?: string | null;
897
+ primaryColor?: string | null;
901
898
  /**
902
- * Event type.
903
- * @maxLength 150
899
+ * Color hex code
900
+ * @minLength 7
901
+ * @maxLength 7
904
902
  */
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;
903
+ secondaryColor?: string | null;
904
+ /** Size */
905
+ size?: number | null;
912
906
  }
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;
907
+ interface BackgroundSetting {
919
908
  /**
920
- * ID of a site visitor that has logged in to the site.
921
- * @format GUID
909
+ * Color of the background hex code
910
+ * @minLength 7
911
+ * @maxLength 9
922
912
  */
923
- memberId?: string;
913
+ color?: string | null;
914
+ /** Wix media Image */
915
+ image?: Image;
916
+ }
917
+ interface SettingsGroup {
924
918
  /**
925
- * ID of a Wix user (site owner, contributor, etc.).
926
- * @format GUID
919
+ * Id of the control group
920
+ * @minLength 5
921
+ * @maxLength 50
927
922
  */
928
- wixUserId?: string;
923
+ groupId?: string;
929
924
  /**
930
- * ID of an app.
931
- * @format GUID
925
+ * Display settings.
926
+ * @maxSize 20
932
927
  */
933
- appId?: string;
934
- /** @readonly */
935
- identityType?: WebhookIdentityTypeWithLiterals;
936
- }
937
- /** @oneof */
938
- interface IdentificationDataIdOneOf {
928
+ display?: Record<string, boolean>;
939
929
  /**
940
- * ID of a site visitor that has not logged in to the site.
941
- * @format GUID
930
+ * Texts settings.
931
+ * @maxSize 20
942
932
  */
943
- anonymousVisitorId?: string;
933
+ texts?: Record<string, TextSetting>;
944
934
  /**
945
- * ID of a site visitor that has logged in to the site.
946
- * @format GUID
935
+ * Images settings.
936
+ * @maxSize 10
947
937
  */
948
- memberId?: string;
938
+ images?: Record<string, ImageSetting>;
949
939
  /**
950
- * ID of a Wix user (site owner, contributor, etc.).
951
- * @format GUID
940
+ * Select option settings.
941
+ * @maxSize 20
952
942
  */
953
- wixUserId?: string;
943
+ selects?: Record<string, SelectSetting>;
954
944
  /**
955
- * ID of an app.
956
- * @format GUID
945
+ * Backgrounds settings.
946
+ * @maxSize 20
957
947
  */
958
- appId?: string;
948
+ backgrounds?: Record<string, BackgroundSetting>;
959
949
  }
960
- declare enum WebhookIdentityType {
961
- UNKNOWN = "UNKNOWN",
962
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
963
- MEMBER = "MEMBER",
964
- WIX_USER = "WIX_USER",
965
- APP = "APP"
950
+ declare enum PaperSize {
951
+ A4_PORTRAIT = "A4_PORTRAIT",
952
+ A4_LANDSCAPE = "A4_LANDSCAPE"
966
953
  }
967
954
  /** @enumType */
968
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
969
- interface AccountInfo {
955
+ type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
956
+ declare enum PageOverflow {
957
+ CONTENT_HIDDEN = "CONTENT_HIDDEN",
958
+ CONTENT_BREAK = "CONTENT_BREAK"
959
+ }
960
+ /** @enumType */
961
+ type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
962
+ declare enum RenderFormat {
963
+ /** content-type: application/pdf */
964
+ PDF = "PDF",
965
+ /** content-type: text/html */
966
+ HTML = "HTML"
967
+ }
968
+ /** @enumType */
969
+ type RenderFormatWithLiterals = RenderFormat | 'PDF' | 'HTML';
970
+ interface RenderDocumentByIdRequest {
970
971
  /**
971
- * ID of the Wix account associated with the event.
972
+ * Document ID.
972
973
  * @format GUID
973
974
  */
974
- accountId?: string | null;
975
+ documentId?: string | null;
976
+ /** Output format, defaults to PDF. */
977
+ outputFormat?: RenderFormatWithLiterals;
978
+ }
979
+ interface GetRendererInfoRequest {
980
+ }
981
+ interface GetRendererInfoResponse {
982
+ /** Renderer info */
983
+ info?: Record<string, string>;
984
+ }
985
+ interface GetCachedHtmlRequest {
975
986
  /**
976
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
977
- * @format GUID
987
+ * Html Access Key.
988
+ * @maxLength 100
978
989
  */
979
- parentAccountId?: string | null;
990
+ htmlAccessKey?: string;
980
991
  /**
981
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
992
+ * Meta Site Id.
982
993
  * @format GUID
983
994
  */
984
- siteId?: string | null;
995
+ metaSiteId?: string | null;
985
996
  }
986
997
  /** @docsIgnore */
987
998
  type DownloadDocumentApplicationErrors = {
@@ -1006,8 +1017,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1006
1017
  __responseType: Q;
1007
1018
  __originalResponseType: R;
1008
1019
  };
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
1020
  declare function createDocument(): __PublicMethodMetaInfo<'POST', {}, CreateDocumentRequest$1, CreateDocumentRequest, CreateDocumentResponse$1, CreateDocumentResponse>;
1012
1021
  declare function getDocument(): __PublicMethodMetaInfo<'GET', {
1013
1022
  documentId: string;
@@ -1026,5 +1035,7 @@ declare function getDownloadUrl(): __PublicMethodMetaInfo<'GET', {}, GetDownload
1026
1035
  declare function downloadDocumentSource(): __PublicMethodMetaInfo<'GET', {
1027
1036
  documentId: string;
1028
1037
  }, DownloadDocumentSourceRequest$1, DownloadDocumentSourceRequest, DownloadDocumentSourceResponse$1, DownloadDocumentSourceResponse>;
1038
+ declare function getDownloadPage(): __PublicMethodMetaInfo<'GET', {}, GetDownloadPageRequest$1, GetDownloadPageRequest, RawHttpResponse$1, RawHttpResponse>;
1039
+ declare function redirectToDocument(): __PublicMethodMetaInfo<'GET', {}, RedirectToDocumentRequest$1, RedirectToDocumentRequest, RawHttpResponse$1, RawHttpResponse>;
1029
1040
 
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 };
1041
+ 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 };