@wix/auto_sdk_papyrus_documents 1.0.11 → 1.0.13

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