@wix/auto_sdk_papyrus_documents 1.0.7 → 1.0.8

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