@wix/auto_sdk_papyrus_documents 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/build/cjs/index.d.ts +18 -18
  2. package/build/cjs/index.js +173 -156
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +552 -528
  5. package/build/cjs/index.typings.js +136 -127
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +536 -525
  8. package/build/cjs/meta.js +125 -114
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/schemas.d.ts +26 -22
  11. package/build/cjs/schemas.js +317 -271
  12. package/build/cjs/schemas.js.map +1 -1
  13. package/build/es/index.d.mts +18 -18
  14. package/build/es/index.mjs +173 -156
  15. package/build/es/index.mjs.map +1 -1
  16. package/build/es/index.typings.d.mts +552 -528
  17. package/build/es/index.typings.mjs +136 -127
  18. package/build/es/index.typings.mjs.map +1 -1
  19. package/build/es/meta.d.mts +536 -525
  20. package/build/es/meta.mjs +125 -114
  21. package/build/es/meta.mjs.map +1 -1
  22. package/build/es/schemas.d.mts +26 -22
  23. package/build/es/schemas.mjs +317 -271
  24. package/build/es/schemas.mjs.map +1 -1
  25. package/build/internal/cjs/index.d.ts +18 -18
  26. package/build/internal/cjs/index.typings.d.ts +616 -523
  27. package/build/internal/cjs/meta.d.ts +642 -516
  28. package/build/internal/cjs/schemas.d.ts +26 -22
  29. package/build/internal/es/index.d.mts +18 -18
  30. package/build/internal/es/index.typings.d.mts +616 -523
  31. package/build/internal/es/meta.d.mts +642 -516
  32. package/build/internal/es/schemas.d.mts +26 -22
  33. package/package.json +4 -4
  34. package/build/internal/cjs/index.js +0 -1101
  35. package/build/internal/cjs/index.js.map +0 -1
  36. package/build/internal/cjs/index.typings.js +0 -863
  37. package/build/internal/cjs/index.typings.js.map +0 -1
  38. package/build/internal/cjs/meta.js +0 -705
  39. package/build/internal/cjs/meta.js.map +0 -1
  40. package/build/internal/cjs/schemas.js +0 -658
  41. package/build/internal/cjs/schemas.js.map +0 -1
  42. package/build/internal/es/index.mjs +0 -1050
  43. package/build/internal/es/index.mjs.map +0 -1
  44. package/build/internal/es/index.typings.mjs +0 -817
  45. package/build/internal/es/index.typings.mjs.map +0 -1
  46. package/build/internal/es/meta.mjs +0 -658
  47. package/build/internal/es/meta.mjs.map +0 -1
  48. package/build/internal/es/schemas.mjs +0 -602
  49. package/build/internal/es/schemas.mjs.map +0 -1
@@ -235,235 +235,328 @@ interface DebugOptions {
235
235
  */
236
236
  staticsVersionOverride?: string | null;
237
237
  }
238
- interface RenderDocumentRequest {
239
- /** Template settings. */
240
- templateSettings?: TemplateSettings;
241
- /** Document content. */
242
- content?: DocumentContent;
243
- /** Output format, defaults to PDF. */
244
- outputFormat?: RenderFormatWithLiterals;
245
- /**
246
- * Overrides papyrusTemplatesStaticsUrl: "//static.parastorage.com/services/papyrus-templates-statics/${version_override}/"
247
- * @maxLength 100
248
- */
249
- versionOverride?: string | null;
250
- /**
251
- * Overrides static versions for the statics config.
252
- * @maxSize 10
253
- */
254
- staticOverrides?: Record<string, string>;
238
+ interface DocumentRenderDelayed {
239
+ /** Document that is being rendered. */
240
+ document?: Document;
255
241
  }
256
- interface TemplateSettings {
242
+ interface CreateDocumentRequest {
243
+ /** Document to be created */
244
+ document?: Document;
245
+ }
246
+ interface CreateDocumentResponse {
247
+ /** The created Document */
248
+ document?: Document;
249
+ }
250
+ interface GetDocumentRequest {
257
251
  /**
258
- * Auto generated ID.
252
+ * ID of the Document to retrieve
259
253
  * @format GUID
260
- * @readonly
261
254
  */
262
- _id?: string | null;
255
+ documentId: string;
256
+ /** @maxSize 1 */
257
+ fields?: RequestedFieldsWithLiterals[];
258
+ }
259
+ declare enum RequestedFields {
260
+ /** Include `documentContent` in the response. */
261
+ DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
262
+ }
263
+ /** @enumType */
264
+ type RequestedFieldsWithLiterals = RequestedFields | 'DOCUMENT_CONTENT';
265
+ interface GetDocumentResponse {
266
+ /** The retrieved Document */
267
+ document?: Document;
268
+ }
269
+ interface DeleteDocumentRequest {
263
270
  /**
264
- * Wix app definition ID.
265
- * @minLength 1
266
- * @maxLength 20
271
+ * ID of the Document to delete
272
+ * @format GUID
267
273
  */
268
- appSlug?: string | null;
274
+ documentId: string;
275
+ }
276
+ interface DeleteDocumentResponse {
277
+ /** Deleted document. */
278
+ document?: Document;
279
+ }
280
+ interface DeleteDocumentByExternalIdRequest {
269
281
  /**
270
- * The type of the template.
282
+ * External ID of the Document to delete
271
283
  * @minLength 1
272
- * @maxLength 20
284
+ * @maxLength 100
273
285
  */
274
- templateType?: string | null;
286
+ externalId?: string;
287
+ }
288
+ interface DeleteDocumentByExternalIdResponse {
289
+ /** Deleted document. */
290
+ document?: Document;
291
+ }
292
+ interface QueryDocumentRequest {
293
+ /** WQL expression */
294
+ query: QueryV2;
295
+ /** @maxSize 1 */
296
+ fields?: RequestedFieldsWithLiterals[];
297
+ }
298
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
299
+ /** Paging options to limit and offset the number of items. */
300
+ paging?: Paging;
301
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
302
+ cursorPaging?: CursorPaging;
275
303
  /**
276
- * The id of the template.
277
- * @minLength 1
278
- * @maxLength 20
304
+ * Filter object.
305
+ *
306
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
279
307
  */
280
- templateId?: string | null;
308
+ filter?: Record<string, any> | null;
281
309
  /**
282
- * Template settings external ID. For example ticket definition ID.
283
- * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
284
- * @minLength 1
285
- * @maxLength 100
310
+ * Sort object.
311
+ *
312
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
286
313
  */
287
- externalId?: string | null;
314
+ sort?: Sorting[];
315
+ /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
316
+ fields?: string[];
317
+ /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
318
+ fieldsets?: string[];
319
+ }
320
+ /** @oneof */
321
+ interface QueryV2PagingMethodOneOf {
322
+ /** Paging options to limit and offset the number of items. */
323
+ paging?: Paging;
324
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
325
+ cursorPaging?: CursorPaging;
326
+ }
327
+ interface Sorting {
288
328
  /**
289
- * Date settings were created.
290
- * @readonly
329
+ * Name of the field to sort by.
330
+ * @maxLength 512
291
331
  */
292
- _createdDate?: Date | null;
332
+ fieldName?: string;
333
+ /** Sort order. */
334
+ order?: SortOrderWithLiterals;
293
335
  /**
294
- * Date settings were updated.
295
- * @readonly
336
+ * Origin point for geo-distance sorting on a GEO field
337
+ * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
296
338
  */
297
- _updatedDate?: Date | null;
298
- /** @maxSize 10 */
299
- settingGroups?: SettingsGroup[];
300
- /** Paper size */
301
- paperSize?: PaperSizeWithLiterals;
302
- pageOverflow?: PageOverflowWithLiterals;
339
+ origin?: AddressLocation;
303
340
  }
304
- interface TextSetting {
305
- /**
306
- * Font family class name
307
- * @maxLength 20
308
- */
309
- fontFamily?: string | null;
341
+ declare enum SortOrder {
342
+ ASC = "ASC",
343
+ DESC = "DESC"
344
+ }
345
+ /** @enumType */
346
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
347
+ interface AddressLocation {
348
+ /** Address latitude. */
349
+ latitude?: number | null;
350
+ /** Address longitude. */
351
+ longitude?: number | null;
352
+ }
353
+ interface Paging {
354
+ /** Number of items to load. */
355
+ limit?: number | null;
356
+ /** Number of items to skip in the current sort order. */
357
+ offset?: number | null;
358
+ }
359
+ interface CursorPaging {
310
360
  /**
311
- * Font style class names
312
- * @maxSize 10
313
- * @maxLength 20
361
+ * Maximum number of items to return in the results.
362
+ * @max 100
314
363
  */
315
- fontStyle?: string[];
364
+ limit?: number | null;
316
365
  /**
317
- * Text alignment class name
318
- * @maxLength 20
366
+ * Pointer to the next or previous page in the list of results.
367
+ *
368
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
369
+ * Not relevant for the first request.
370
+ * @maxLength 16000
319
371
  */
320
- textAlignment?: string | null;
372
+ cursor?: string | null;
373
+ }
374
+ interface QueryDocumentResponse {
375
+ /** The retrieved Documents */
376
+ documents?: Document[];
377
+ /** Query results' metadata */
378
+ metadata?: PagingMetadataV2;
379
+ }
380
+ interface PagingMetadataV2 {
381
+ /** Number of items returned in the response. */
382
+ count?: number | null;
383
+ /** Offset that was requested. */
384
+ offset?: number | null;
385
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
386
+ total?: number | null;
387
+ /** Flag that indicates the server failed to calculate the `total` field. */
388
+ tooManyToCount?: boolean | null;
389
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
390
+ cursors?: Cursors;
391
+ }
392
+ interface Cursors {
321
393
  /**
322
- * Text color hex code
323
- * @minLength 7
324
- * @maxLength 7
394
+ * Cursor string pointing to the next page in the list of results.
395
+ * @maxLength 16000
325
396
  */
326
- textColor?: string | null;
397
+ next?: string | null;
327
398
  /**
328
- * Font size
329
- * @min 1
399
+ * Cursor pointing to the previous page in the list of results.
400
+ * @maxLength 16000
330
401
  */
331
- fontSize?: number | null;
332
- /** Text content setting */
333
- textContent?: TextContent[];
402
+ prev?: string | null;
334
403
  }
335
- interface TextContent {
404
+ interface UpdateDocumentRequest {
336
405
  /**
337
- * @minLength 3
338
- * @maxLength 50
406
+ * Document ID.
407
+ * @format GUID
408
+ * @readonly
339
409
  */
340
- _id?: string;
341
- /** @maxLength 500 */
342
- value?: string | null;
343
- visible?: boolean;
410
+ _id: string | null;
411
+ /** Document render status. */
412
+ renderStatus?: RenderStatusWithLiterals;
413
+ /** Rendered document file. */
414
+ file?: DocumentFile;
415
+ /** Rendered document source HTML file. */
416
+ sourceFile?: DocumentFile;
344
417
  }
345
- interface ImageSetting {
346
- /** Wix media Image */
347
- image?: string;
348
- /** Image resizing mode */
349
- resize?: ResizeOptionWithLiterals;
418
+ interface DocumentFile {
419
+ /** File ID. */
420
+ fileId?: string | null;
421
+ /** File URL. Defined only for public documents. */
422
+ staticUrl?: string | null;
423
+ /** File path. */
424
+ filePath?: string | null;
425
+ /** Size in bytes. */
426
+ sizeInBytes?: number | null;
350
427
  }
351
- interface FocalPoint {
352
- /** X-coordinate of the focal point. */
353
- x?: number;
354
- /** Y-coordinate of the focal point. */
355
- y?: number;
356
- /** crop by height */
357
- height?: number | null;
358
- /** crop by width */
359
- width?: number | null;
428
+ interface UpdateDocumentResponse {
429
+ /** The created Document */
430
+ document?: Document;
360
431
  }
361
- declare enum ResizeOption {
362
- /** Automatically resizes full image to fit image field */
363
- FIT = "FIT",
364
- /** Enables user to manually crop image to fit image field */
365
- CROP = "CROP"
432
+ interface DocumentRendered {
433
+ /** Rendered document */
434
+ document?: Document;
366
435
  }
367
- /** @enumType */
368
- type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
369
- interface SelectSetting {
370
- /** Selected value */
371
- value?: string | null;
436
+ interface DocumentRenderFailed {
437
+ /** Document that failed to render */
438
+ document?: Document;
439
+ }
440
+ interface DownloadDocumentRequest {
372
441
  /**
373
- * Color hex code
374
- * @minLength 7
375
- * @maxLength 7
442
+ * ID of the Document to retrieve
443
+ * @format GUID
444
+ */
445
+ documentId: string;
446
+ /**
447
+ * URL expiration time. Only relevant for private documents.
448
+ * @min 600
449
+ * @max 86400
376
450
  */
377
- primaryColor?: string | null;
451
+ urlExpirationInSeconds?: number | null;
378
452
  /**
379
- * Color hex code
380
- * @minLength 7
381
- * @maxLength 7
453
+ * Whether the link downloads the file or opens the file in the browser.
454
+ * Default: `ATTACHMENT`
382
455
  */
383
- secondaryColor?: string | null;
384
- /** Size */
385
- size?: number | null;
456
+ contentDisposition?: ContentDispositionWithLiterals;
386
457
  }
387
- interface BackgroundSetting {
458
+ declare enum ContentDisposition {
459
+ /** The link downloads the file. */
460
+ ATTACHMENT = "ATTACHMENT",
461
+ /** The link opens the file in the browser. */
462
+ INLINE = "INLINE"
463
+ }
464
+ /** @enumType */
465
+ type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
466
+ interface DownloadDocumentResponse {
467
+ /** Download URL. */
468
+ downloadUrl?: string;
469
+ /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
470
+ expirationDate?: Date | null;
471
+ }
472
+ interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
388
473
  /**
389
- * Color of the background hex code
390
- * @minLength 7
391
- * @maxLength 9
474
+ * ID of the Document to retrieve
475
+ * @format GUID
392
476
  */
393
- color?: string | null;
394
- /** Wix media Image */
395
- image?: string;
396
- }
397
- interface SettingsGroup {
477
+ documentId?: string | null;
398
478
  /**
399
- * Id of the control group
400
- * @minLength 5
401
- * @maxLength 50
479
+ * ID of the Document to retrieve
480
+ * @minLength 1
481
+ * @maxLength 100
402
482
  */
403
- groupId?: string;
483
+ externalId?: string | null;
404
484
  /**
405
- * Display settings.
406
- * @maxSize 20
485
+ * Signed file token
486
+ * @minLength 1
487
+ * @maxLength 500
407
488
  */
408
- display?: Record<string, boolean>;
489
+ fileToken?: string | null;
409
490
  /**
410
- * Texts settings.
411
- * @maxSize 20
491
+ * URL expiration time. Only relevant for private documents.
492
+ * @min 600
493
+ * @max 86400
412
494
  */
413
- texts?: Record<string, TextSetting>;
495
+ urlExpirationInSeconds?: number | null;
496
+ /** @maxLength 100 */
497
+ downloadButtonText?: string | null;
414
498
  /**
415
- * Images settings.
416
- * @maxSize 10
499
+ * Whether the link downloads the file or opens the file in the browser.
500
+ * Default: `ATTACHMENT`
417
501
  */
418
- images?: Record<string, ImageSetting>;
502
+ contentDisposition?: ContentDispositionWithLiterals;
503
+ }
504
+ /** @oneof */
505
+ interface GetDownloadUrlRequestDocumentOneOf {
419
506
  /**
420
- * Select option settings.
421
- * @maxSize 20
507
+ * ID of the Document to retrieve
508
+ * @format GUID
422
509
  */
423
- selects?: Record<string, SelectSetting>;
510
+ documentId?: string | null;
424
511
  /**
425
- * Backgrounds settings.
426
- * @maxSize 20
512
+ * ID of the Document to retrieve
513
+ * @minLength 1
514
+ * @maxLength 100
427
515
  */
428
- backgrounds?: Record<string, BackgroundSetting>;
429
- }
430
- declare enum PaperSize {
431
- A4_PORTRAIT = "A4_PORTRAIT",
432
- A4_LANDSCAPE = "A4_LANDSCAPE"
433
- }
434
- /** @enumType */
435
- type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
436
- declare enum PageOverflow {
437
- CONTENT_HIDDEN = "CONTENT_HIDDEN",
438
- CONTENT_BREAK = "CONTENT_BREAK"
439
- }
440
- /** @enumType */
441
- type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
442
- declare enum RenderFormat {
443
- /** content-type: application/pdf */
444
- PDF = "PDF",
445
- /** content-type: text/html */
446
- HTML = "HTML"
447
- }
448
- /** @enumType */
449
- type RenderFormatWithLiterals = RenderFormat | 'PDF' | 'HTML';
450
- interface RawHttpResponse {
451
- body?: Uint8Array;
452
- statusCode?: number | null;
453
- headers?: HeadersEntry[];
454
- }
455
- interface HeadersEntry {
456
- key?: string;
457
- value?: string;
516
+ externalId?: string | null;
517
+ /**
518
+ * Signed file token
519
+ * @minLength 1
520
+ * @maxLength 500
521
+ */
522
+ fileToken?: string | null;
458
523
  }
459
- interface RenderDocumentByIdRequest {
524
+ interface GetDownloadUrlResponse {
525
+ /** Download URL. */
526
+ downloadUrl?: string | null;
527
+ /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
528
+ expirationDate?: Date | null;
460
529
  /**
461
530
  * Document ID.
462
531
  * @format GUID
463
532
  */
464
533
  documentId?: string | null;
465
- /** Output format, defaults to PDF. */
466
- outputFormat?: RenderFormatWithLiterals;
534
+ /** Document render status. */
535
+ renderStatus?: RenderStatusWithLiterals;
536
+ /** Download URL. */
537
+ downloadPageUrl?: string | null;
538
+ /**
539
+ * Client defined content checksum. Can be used for content comparison.
540
+ * @minLength 1
541
+ * @maxLength 64
542
+ */
543
+ contentChecksum?: string | null;
544
+ }
545
+ interface DownloadDocumentSourceRequest {
546
+ /**
547
+ * ID of the Document to retrieve
548
+ * @format GUID
549
+ */
550
+ documentId: string;
551
+ /**
552
+ * Whether the link downloads the file or opens the file in the browser.
553
+ * Default: `ATTACHMENT`
554
+ */
555
+ contentDisposition?: ContentDispositionWithLiterals;
556
+ }
557
+ interface DownloadDocumentSourceResponse {
558
+ /** Download URL. Expires after 10 minutes. */
559
+ downloadUrl?: string;
467
560
  }
468
561
  interface DomainEvent extends DomainEventBodyOneOf {
469
562
  createdEvent?: EntityCreatedEvent;
@@ -494,7 +587,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
494
587
  /** If present, indicates the action that triggered the event. */
495
588
  originatedFrom?: string | null;
496
589
  /**
497
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
590
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
498
591
  * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
499
592
  */
500
593
  entityEventSequence?: string | null;
@@ -529,434 +622,352 @@ interface ActionEvent {
529
622
  }
530
623
  interface Empty {
531
624
  }
532
- interface GetRendererInfoRequest {
533
- }
534
- interface GetRendererInfoResponse {
535
- /** Renderer info */
536
- info?: Record<string, string>;
537
- }
538
- interface GetCachedHtmlRequest {
539
- /**
540
- * Html Access Key.
541
- * @maxLength 100
542
- */
543
- htmlAccessKey?: string;
625
+ interface MessageEnvelope {
544
626
  /**
545
- * Meta Site Id.
627
+ * App instance ID.
546
628
  * @format GUID
547
629
  */
548
- metaSiteId?: string | null;
549
- }
550
- interface GetDownloadPageRequest {
551
- /** @maxLength 1000 */
552
- file: string | null;
553
- }
554
- interface RedirectToDocumentRequest {
555
- /** @maxLength 1000 */
556
- file: string | null;
557
- }
558
- interface DocumentRenderDelayed {
559
- /** Document that is being rendered. */
560
- document?: Document;
561
- }
562
- interface CreateDocumentRequest {
563
- /** Document to be created */
564
- document?: Document;
565
- }
566
- interface CreateDocumentResponse {
567
- /** The created Document */
568
- document?: Document;
569
- }
570
- interface GetDocumentRequest {
630
+ instanceId?: string | null;
571
631
  /**
572
- * ID of the Document to retrieve
573
- * @format GUID
632
+ * Event type.
633
+ * @maxLength 150
574
634
  */
575
- documentId: string;
576
- /** @maxSize 1 */
577
- fields?: RequestedFieldsWithLiterals[];
578
- }
579
- declare enum RequestedFields {
580
- /** Include `documentContent` in the response. */
581
- DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
582
- }
583
- /** @enumType */
584
- type RequestedFieldsWithLiterals = RequestedFields | 'DOCUMENT_CONTENT';
585
- interface GetDocumentResponse {
586
- /** The retrieved Document */
587
- document?: Document;
635
+ eventType?: string;
636
+ /** The identification type and identity data. */
637
+ identity?: IdentificationData;
638
+ /** Stringify payload. */
639
+ data?: string;
640
+ /** Details related to the account */
641
+ accountInfo?: AccountInfo;
588
642
  }
589
- interface DeleteDocumentRequest {
643
+ interface IdentificationData extends IdentificationDataIdOneOf {
590
644
  /**
591
- * ID of the Document to delete
645
+ * ID of a site visitor that has not logged in to the site.
592
646
  * @format GUID
593
647
  */
594
- documentId: string;
595
- }
596
- interface DeleteDocumentResponse {
597
- /** Deleted document. */
598
- document?: Document;
599
- }
600
- interface DeleteDocumentByExternalIdRequest {
648
+ anonymousVisitorId?: string;
601
649
  /**
602
- * External ID of the Document to delete
603
- * @minLength 1
604
- * @maxLength 100
650
+ * ID of a site visitor that has logged in to the site.
651
+ * @format GUID
605
652
  */
606
- externalId?: string;
607
- }
608
- interface DeleteDocumentByExternalIdResponse {
609
- /** Deleted document. */
610
- document?: Document;
611
- }
612
- interface QueryDocumentRequest {
613
- /** WQL expression */
614
- query: QueryV2;
615
- /** @maxSize 1 */
616
- fields?: RequestedFieldsWithLiterals[];
617
- }
618
- interface QueryV2 extends QueryV2PagingMethodOneOf {
619
- /** Paging options to limit and offset the number of items. */
620
- paging?: Paging;
621
- /** 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`. */
622
- cursorPaging?: CursorPaging;
623
- /**
624
- * Filter object.
625
- *
626
- * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
653
+ memberId?: string;
654
+ /**
655
+ * ID of a Wix user (site owner, contributor, etc.).
656
+ * @format GUID
627
657
  */
628
- filter?: Record<string, any> | null;
658
+ wixUserId?: string;
629
659
  /**
630
- * Sort object.
631
- *
632
- * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
660
+ * ID of an app.
661
+ * @format GUID
633
662
  */
634
- sort?: Sorting[];
635
- /** 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. */
636
- fields?: string[];
637
- /** 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. */
638
- fieldsets?: string[];
663
+ appId?: string;
664
+ /** @readonly */
665
+ identityType?: WebhookIdentityTypeWithLiterals;
639
666
  }
640
667
  /** @oneof */
641
- interface QueryV2PagingMethodOneOf {
642
- /** Paging options to limit and offset the number of items. */
643
- paging?: Paging;
644
- /** 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`. */
645
- cursorPaging?: CursorPaging;
646
- }
647
- interface Sorting {
668
+ interface IdentificationDataIdOneOf {
648
669
  /**
649
- * Name of the field to sort by.
650
- * @maxLength 512
670
+ * ID of a site visitor that has not logged in to the site.
671
+ * @format GUID
651
672
  */
652
- fieldName?: string;
653
- /** Sort order. */
654
- order?: SortOrderWithLiterals;
655
- }
656
- declare enum SortOrder {
657
- ASC = "ASC",
658
- DESC = "DESC"
659
- }
660
- /** @enumType */
661
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
662
- interface Paging {
663
- /** Number of items to load. */
664
- limit?: number | null;
665
- /** Number of items to skip in the current sort order. */
666
- offset?: number | null;
667
- }
668
- interface CursorPaging {
673
+ anonymousVisitorId?: string;
669
674
  /**
670
- * Maximum number of items to return in the results.
671
- * @max 100
675
+ * ID of a site visitor that has logged in to the site.
676
+ * @format GUID
672
677
  */
673
- limit?: number | null;
678
+ memberId?: string;
674
679
  /**
675
- * Pointer to the next or previous page in the list of results.
676
- *
677
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
678
- * Not relevant for the first request.
679
- * @maxLength 16000
680
+ * ID of a Wix user (site owner, contributor, etc.).
681
+ * @format GUID
680
682
  */
681
- cursor?: string | null;
682
- }
683
- interface QueryDocumentResponse {
684
- /** The retrieved Documents */
685
- documents?: Document[];
686
- /** Query results' metadata */
687
- metadata?: PagingMetadataV2;
683
+ wixUserId?: string;
684
+ /**
685
+ * ID of an app.
686
+ * @format GUID
687
+ */
688
+ appId?: string;
688
689
  }
689
- interface PagingMetadataV2 {
690
- /** Number of items returned in the response. */
691
- count?: number | null;
692
- /** Offset that was requested. */
693
- offset?: number | null;
694
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
695
- total?: number | null;
696
- /** Flag that indicates the server failed to calculate the `total` field. */
697
- tooManyToCount?: boolean | null;
698
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
699
- cursors?: Cursors;
690
+ declare enum WebhookIdentityType {
691
+ UNKNOWN = "UNKNOWN",
692
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
693
+ MEMBER = "MEMBER",
694
+ WIX_USER = "WIX_USER",
695
+ APP = "APP"
700
696
  }
701
- interface Cursors {
697
+ /** @enumType */
698
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
699
+ interface AccountInfo {
702
700
  /**
703
- * Cursor string pointing to the next page in the list of results.
704
- * @maxLength 16000
701
+ * ID of the Wix account associated with the event.
702
+ * @format GUID
705
703
  */
706
- next?: string | null;
704
+ accountId?: string | null;
707
705
  /**
708
- * Cursor pointing to the previous page in the list of results.
709
- * @maxLength 16000
706
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
707
+ * @format GUID
710
708
  */
711
- prev?: string | null;
712
- }
713
- interface UpdateDocumentRequest {
709
+ parentAccountId?: string | null;
714
710
  /**
715
- * Document ID.
711
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
716
712
  * @format GUID
717
- * @readonly
718
713
  */
719
- _id: string | null;
720
- /** Document render status. */
721
- renderStatus?: RenderStatusWithLiterals;
722
- /** Rendered document file. */
723
- file?: DocumentFile;
724
- /** Rendered document source HTML file. */
725
- sourceFile?: DocumentFile;
714
+ siteId?: string | null;
726
715
  }
727
- interface DocumentFile {
728
- /** File ID. */
729
- fileId?: string | null;
730
- /** File URL. Defined only for public documents. */
731
- staticUrl?: string | null;
732
- /** File path. */
733
- filePath?: string | null;
734
- /** Size in bytes. */
735
- sizeInBytes?: number | null;
716
+ interface GetDownloadPageRequest {
717
+ /** @maxLength 1000 */
718
+ file: string | null;
736
719
  }
737
- interface UpdateDocumentResponse {
738
- /** The created Document */
739
- document?: Document;
720
+ interface RawHttpResponse {
721
+ body?: Uint8Array;
722
+ statusCode?: number | null;
723
+ headers?: HeadersEntry[];
740
724
  }
741
- interface DocumentRendered {
742
- /** Rendered document */
743
- document?: Document;
725
+ interface HeadersEntry {
726
+ key?: string;
727
+ value?: string;
744
728
  }
745
- interface DocumentRenderFailed {
746
- /** Document that failed to render */
747
- document?: Document;
729
+ interface RedirectToDocumentRequest {
730
+ /** @maxLength 1000 */
731
+ file: string | null;
748
732
  }
749
- interface DownloadDocumentRequest {
750
- /**
751
- * ID of the Document to retrieve
752
- * @format GUID
753
- */
754
- documentId: string;
733
+ interface RenderDocumentRequest {
734
+ /** Template settings. */
735
+ templateSettings?: TemplateSettings;
736
+ /** Document content. */
737
+ content?: DocumentContent;
738
+ /** Output format, defaults to PDF. */
739
+ outputFormat?: RenderFormatWithLiterals;
755
740
  /**
756
- * URL expiration time. Only relevant for private documents.
757
- * @min 600
758
- * @max 86400
741
+ * Overrides papyrusTemplatesStaticsUrl: "//static.parastorage.com/services/papyrus-templates-statics/${version_override}/"
742
+ * @maxLength 100
759
743
  */
760
- urlExpirationInSeconds?: number | null;
744
+ versionOverride?: string | null;
761
745
  /**
762
- * Whether the link downloads the file or opens the file in the browser.
763
- * Default: `ATTACHMENT`
746
+ * Overrides static versions for the statics config.
747
+ * @maxSize 10
764
748
  */
765
- contentDisposition?: ContentDispositionWithLiterals;
766
- }
767
- declare enum ContentDisposition {
768
- /** The link downloads the file. */
769
- ATTACHMENT = "ATTACHMENT",
770
- /** The link opens the file in the browser. */
771
- INLINE = "INLINE"
772
- }
773
- /** @enumType */
774
- type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
775
- interface DownloadDocumentResponse {
776
- /** Download URL. */
777
- downloadUrl?: string;
778
- /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
779
- expirationDate?: Date | null;
749
+ staticOverrides?: Record<string, string>;
780
750
  }
781
- interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
751
+ interface TemplateSettings {
782
752
  /**
783
- * ID of the Document to retrieve
753
+ * Auto generated ID.
784
754
  * @format GUID
755
+ * @readonly
785
756
  */
786
- documentId?: string | null;
757
+ _id?: string | null;
787
758
  /**
788
- * ID of the Document to retrieve
759
+ * Wix app definition ID.
789
760
  * @minLength 1
790
- * @maxLength 100
761
+ * @maxLength 20
791
762
  */
792
- externalId?: string | null;
763
+ appSlug?: string | null;
793
764
  /**
794
- * Signed file token
765
+ * The type of the template.
795
766
  * @minLength 1
796
- * @maxLength 500
767
+ * @maxLength 20
797
768
  */
798
- fileToken?: string | null;
769
+ templateType?: string | null;
799
770
  /**
800
- * URL expiration time. Only relevant for private documents.
801
- * @min 600
802
- * @max 86400
771
+ * The id of the template.
772
+ * @minLength 1
773
+ * @maxLength 20
803
774
  */
804
- urlExpirationInSeconds?: number | null;
805
- /** @maxLength 100 */
806
- downloadButtonText?: string | null;
775
+ templateId?: string | null;
807
776
  /**
808
- * Whether the link downloads the file or opens the file in the browser.
809
- * Default: `ATTACHMENT`
777
+ * Template settings external ID. For example ticket definition ID.
778
+ * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
779
+ * @minLength 1
780
+ * @maxLength 100
810
781
  */
811
- contentDisposition?: ContentDispositionWithLiterals;
812
- }
813
- /** @oneof */
814
- interface GetDownloadUrlRequestDocumentOneOf {
782
+ externalId?: string | null;
815
783
  /**
816
- * ID of the Document to retrieve
817
- * @format GUID
784
+ * Date settings were created.
785
+ * @readonly
818
786
  */
819
- documentId?: string | null;
787
+ _createdDate?: Date | null;
820
788
  /**
821
- * ID of the Document to retrieve
822
- * @minLength 1
823
- * @maxLength 100
789
+ * Date settings were updated.
790
+ * @readonly
824
791
  */
825
- externalId?: string | null;
792
+ _updatedDate?: Date | null;
793
+ /** @maxSize 10 */
794
+ settingGroups?: SettingsGroup[];
795
+ /** Paper size */
796
+ paperSize?: PaperSizeWithLiterals;
797
+ pageOverflow?: PageOverflowWithLiterals;
798
+ }
799
+ interface TextSetting {
800
+ /**
801
+ * Font family class name
802
+ * @maxLength 20
803
+ */
804
+ fontFamily?: string | null;
826
805
  /**
827
- * Signed file token
828
- * @minLength 1
829
- * @maxLength 500
806
+ * Font style class names
807
+ * @maxSize 10
808
+ * @maxLength 20
830
809
  */
831
- fileToken?: string | null;
832
- }
833
- interface GetDownloadUrlResponse {
834
- /** Download URL. */
835
- downloadUrl?: string | null;
836
- /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
837
- expirationDate?: Date | null;
810
+ fontStyle?: string[];
838
811
  /**
839
- * Document ID.
840
- * @format GUID
812
+ * Text alignment class name
813
+ * @maxLength 20
841
814
  */
842
- documentId?: string | null;
843
- /** Document render status. */
844
- renderStatus?: RenderStatusWithLiterals;
845
- /** Download URL. */
846
- downloadPageUrl?: string | null;
815
+ textAlignment?: string | null;
847
816
  /**
848
- * Client defined content checksum. Can be used for content comparison.
849
- * @minLength 1
850
- * @maxLength 64
817
+ * Text color hex code
818
+ * @minLength 7
819
+ * @maxLength 7
851
820
  */
852
- contentChecksum?: string | null;
853
- }
854
- interface DownloadDocumentSourceRequest {
821
+ textColor?: string | null;
855
822
  /**
856
- * ID of the Document to retrieve
857
- * @format GUID
823
+ * Font size
824
+ * @min 1
858
825
  */
859
- documentId: string;
826
+ fontSize?: number | null;
827
+ /** Text content setting */
828
+ textContent?: TextContent[];
829
+ }
830
+ interface TextContent {
860
831
  /**
861
- * Whether the link downloads the file or opens the file in the browser.
862
- * Default: `ATTACHMENT`
832
+ * @minLength 3
833
+ * @maxLength 50
863
834
  */
864
- contentDisposition?: ContentDispositionWithLiterals;
835
+ _id?: string;
836
+ /** @maxLength 500 */
837
+ value?: string | null;
838
+ visible?: boolean;
865
839
  }
866
- interface DownloadDocumentSourceResponse {
867
- /** Download URL. Expires after 10 minutes. */
868
- downloadUrl?: string;
840
+ interface ImageSetting {
841
+ /** Wix media Image */
842
+ image?: string;
843
+ /** Image resizing mode */
844
+ resize?: ResizeOptionWithLiterals;
869
845
  }
870
- interface MessageEnvelope {
846
+ interface FocalPoint {
847
+ /** X-coordinate of the focal point. */
848
+ x?: number;
849
+ /** Y-coordinate of the focal point. */
850
+ y?: number;
851
+ /** crop by height */
852
+ height?: number | null;
853
+ /** crop by width */
854
+ width?: number | null;
855
+ }
856
+ declare enum ResizeOption {
857
+ /** Automatically resizes full image to fit image field */
858
+ FIT = "FIT",
859
+ /** Enables user to manually crop image to fit image field */
860
+ CROP = "CROP"
861
+ }
862
+ /** @enumType */
863
+ type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
864
+ interface SelectSetting {
865
+ /** Selected value */
866
+ value?: string | null;
871
867
  /**
872
- * App instance ID.
873
- * @format GUID
868
+ * Color hex code
869
+ * @minLength 7
870
+ * @maxLength 7
874
871
  */
875
- instanceId?: string | null;
872
+ primaryColor?: string | null;
876
873
  /**
877
- * Event type.
878
- * @maxLength 150
874
+ * Color hex code
875
+ * @minLength 7
876
+ * @maxLength 7
879
877
  */
880
- eventType?: string;
881
- /** The identification type and identity data. */
882
- identity?: IdentificationData;
883
- /** Stringify payload. */
884
- data?: string;
885
- /** Details related to the account */
886
- accountInfo?: AccountInfo;
878
+ secondaryColor?: string | null;
879
+ /** Size */
880
+ size?: number | null;
887
881
  }
888
- interface IdentificationData extends IdentificationDataIdOneOf {
889
- /**
890
- * ID of a site visitor that has not logged in to the site.
891
- * @format GUID
892
- */
893
- anonymousVisitorId?: string;
882
+ interface BackgroundSetting {
894
883
  /**
895
- * ID of a site visitor that has logged in to the site.
896
- * @format GUID
884
+ * Color of the background hex code
885
+ * @minLength 7
886
+ * @maxLength 9
897
887
  */
898
- memberId?: string;
888
+ color?: string | null;
889
+ /** Wix media Image */
890
+ image?: string;
891
+ }
892
+ interface SettingsGroup {
899
893
  /**
900
- * ID of a Wix user (site owner, contributor, etc.).
901
- * @format GUID
894
+ * Id of the control group
895
+ * @minLength 5
896
+ * @maxLength 50
902
897
  */
903
- wixUserId?: string;
898
+ groupId?: string;
904
899
  /**
905
- * ID of an app.
906
- * @format GUID
900
+ * Display settings.
901
+ * @maxSize 20
907
902
  */
908
- appId?: string;
909
- /** @readonly */
910
- identityType?: WebhookIdentityTypeWithLiterals;
911
- }
912
- /** @oneof */
913
- interface IdentificationDataIdOneOf {
903
+ display?: Record<string, boolean>;
914
904
  /**
915
- * ID of a site visitor that has not logged in to the site.
916
- * @format GUID
905
+ * Texts settings.
906
+ * @maxSize 20
917
907
  */
918
- anonymousVisitorId?: string;
908
+ texts?: Record<string, TextSetting>;
919
909
  /**
920
- * ID of a site visitor that has logged in to the site.
921
- * @format GUID
910
+ * Images settings.
911
+ * @maxSize 10
922
912
  */
923
- memberId?: string;
913
+ images?: Record<string, ImageSetting>;
924
914
  /**
925
- * ID of a Wix user (site owner, contributor, etc.).
926
- * @format GUID
915
+ * Select option settings.
916
+ * @maxSize 20
927
917
  */
928
- wixUserId?: string;
918
+ selects?: Record<string, SelectSetting>;
929
919
  /**
930
- * ID of an app.
931
- * @format GUID
920
+ * Backgrounds settings.
921
+ * @maxSize 20
932
922
  */
933
- appId?: string;
923
+ backgrounds?: Record<string, BackgroundSetting>;
934
924
  }
935
- declare enum WebhookIdentityType {
936
- UNKNOWN = "UNKNOWN",
937
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
938
- MEMBER = "MEMBER",
939
- WIX_USER = "WIX_USER",
940
- APP = "APP"
925
+ declare enum PaperSize {
926
+ A4_PORTRAIT = "A4_PORTRAIT",
927
+ A4_LANDSCAPE = "A4_LANDSCAPE"
941
928
  }
942
929
  /** @enumType */
943
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
944
- interface AccountInfo {
930
+ type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
931
+ declare enum PageOverflow {
932
+ CONTENT_HIDDEN = "CONTENT_HIDDEN",
933
+ CONTENT_BREAK = "CONTENT_BREAK"
934
+ }
935
+ /** @enumType */
936
+ type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
937
+ declare enum RenderFormat {
938
+ /** content-type: application/pdf */
939
+ PDF = "PDF",
940
+ /** content-type: text/html */
941
+ HTML = "HTML"
942
+ }
943
+ /** @enumType */
944
+ type RenderFormatWithLiterals = RenderFormat | 'PDF' | 'HTML';
945
+ interface RenderDocumentByIdRequest {
945
946
  /**
946
- * ID of the Wix account associated with the event.
947
+ * Document ID.
947
948
  * @format GUID
948
949
  */
949
- accountId?: string | null;
950
+ documentId?: string | null;
951
+ /** Output format, defaults to PDF. */
952
+ outputFormat?: RenderFormatWithLiterals;
953
+ }
954
+ interface GetRendererInfoRequest {
955
+ }
956
+ interface GetRendererInfoResponse {
957
+ /** Renderer info */
958
+ info?: Record<string, string>;
959
+ }
960
+ interface GetCachedHtmlRequest {
950
961
  /**
951
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
952
- * @format GUID
962
+ * Html Access Key.
963
+ * @maxLength 100
953
964
  */
954
- parentAccountId?: string | null;
965
+ htmlAccessKey?: string;
955
966
  /**
956
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
967
+ * Meta Site Id.
957
968
  * @format GUID
958
969
  */
959
- siteId?: string | null;
970
+ metaSiteId?: string | null;
960
971
  }
961
972
  /** @docsIgnore */
962
973
  type DownloadDocumentApplicationErrors = {
@@ -1011,7 +1022,7 @@ interface EventMetadata extends BaseEventMetadata {
1011
1022
  /** If present, indicates the action that triggered the event. */
1012
1023
  originatedFrom?: string | null;
1013
1024
  /**
1014
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1025
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
1015
1026
  * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1016
1027
  */
1017
1028
  entityEventSequence?: string | null;
@@ -1029,7 +1040,9 @@ interface DocumentCreatedEnvelope {
1029
1040
  entity: Document;
1030
1041
  metadata: EventMetadata;
1031
1042
  }
1032
- /** @permissionScope Manage Stores
1043
+ /** @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1044
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
1045
+ * @permissionScope Manage Stores
1033
1046
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1034
1047
  * @permissionScope Manage form submissions.
1035
1048
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
@@ -1055,7 +1068,9 @@ declare function onDocumentCreated(handler: (event: DocumentCreatedEnvelope) =>
1055
1068
  interface DocumentDeletedEnvelope {
1056
1069
  metadata: EventMetadata;
1057
1070
  }
1058
- /** @permissionScope Manage Stores
1071
+ /** @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1072
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
1073
+ * @permissionScope Manage Stores
1059
1074
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1060
1075
  * @permissionScope Manage form submissions.
1061
1076
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
@@ -1084,6 +1099,8 @@ interface DocumentRenderDelayedEnvelope {
1084
1099
  }
1085
1100
  /**
1086
1101
  * Event is sent after specific time if configured and RenderStatus is ACCEPTED/RENDERING.
1102
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1103
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
1087
1104
  * @permissionScope Manage Stores
1088
1105
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1089
1106
  * @permissionScope Manage form submissions.
@@ -1111,7 +1128,9 @@ interface DocumentRenderFailedEnvelope {
1111
1128
  data: DocumentRenderFailed;
1112
1129
  metadata: EventMetadata;
1113
1130
  }
1114
- /** @permissionScope Manage Stores
1131
+ /** @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1132
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
1133
+ * @permissionScope Manage Stores
1115
1134
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1116
1135
  * @permissionScope Manage form submissions.
1117
1136
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
@@ -1138,7 +1157,9 @@ interface DocumentRenderedEnvelope {
1138
1157
  data: DocumentRendered;
1139
1158
  metadata: EventMetadata;
1140
1159
  }
1141
- /** @permissionScope Manage Stores
1160
+ /** @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1161
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
1162
+ * @permissionScope Manage Stores
1142
1163
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1143
1164
  * @permissionScope Manage form submissions.
1144
1165
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
@@ -1165,7 +1186,9 @@ interface DocumentUpdatedEnvelope {
1165
1186
  entity: Document;
1166
1187
  metadata: EventMetadata;
1167
1188
  }
1168
- /** @permissionScope Manage Stores
1189
+ /** @permissionScope Manage_Wix_Rentals_App_Forms_submissions
1190
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
1191
+ * @permissionScope Manage Stores
1169
1192
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1170
1193
  * @permissionScope Manage form submissions.
1171
1194
  * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
@@ -1188,22 +1211,6 @@ interface DocumentUpdatedEnvelope {
1188
1211
  * @slug updated
1189
1212
  */
1190
1213
  declare function onDocumentUpdated(handler: (event: DocumentUpdatedEnvelope) => void | Promise<void>): void;
1191
- /**
1192
- * Get Document.
1193
- * @public
1194
- * @requiredField file
1195
- * @permissionId PAPYRUS.DOWNLOAD_DOCUMENT
1196
- * @fqn wix.papyrus.v1.DownloadPageController.GetDownloadPage
1197
- */
1198
- declare function getDownloadPage(file: string | null): Promise<RawHttpResponse>;
1199
- /**
1200
- * Get Document.
1201
- * @public
1202
- * @requiredField file
1203
- * @permissionId PAPYRUS.DOWNLOAD_DOCUMENT
1204
- * @fqn wix.papyrus.v1.DownloadPageController.RedirectToDocument
1205
- */
1206
- declare function redirectToDocument(file: string | null): Promise<RawHttpResponse>;
1207
1214
  /**
1208
1215
  * Creates a new Document
1209
1216
  * @public
@@ -1329,14 +1336,15 @@ type DocumentQuery = {
1329
1336
  Sort order.
1330
1337
  */
1331
1338
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
1339
+ /**
1340
+ Origin point for geo-distance sorting on a GEO field
1341
+ results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
1342
+ */
1343
+ origin?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['origin'];
1332
1344
  }[];
1333
1345
  };
1334
1346
  declare const utils: {
1335
- query: {
1336
- QueryBuilder: () => _wix_sdk_types.QueryBuilder<Document, DocumentQuerySpec, DocumentQuery>;
1337
- Filter: _wix_sdk_types.FilterFactory<Document, DocumentQuerySpec>;
1338
- Sort: _wix_sdk_types.SortFactory<DocumentQuerySpec>;
1339
- };
1347
+ query: _wix_sdk_types.QueryHelpers<Document, DocumentQuerySpec, DocumentQuery>;
1340
1348
  };
1341
1349
  /**
1342
1350
  * Updates Document. Currently supports only render_status, file_id and static_url updates.
@@ -1461,5 +1469,21 @@ interface DownloadDocumentSourceOptions {
1461
1469
  */
1462
1470
  contentDisposition?: ContentDispositionWithLiterals;
1463
1471
  }
1472
+ /**
1473
+ * Get Document.
1474
+ * @public
1475
+ * @requiredField file
1476
+ * @permissionId PAPYRUS.DOWNLOAD_DOCUMENT
1477
+ * @fqn wix.papyrus.v1.DownloadPageController.GetDownloadPage
1478
+ */
1479
+ declare function getDownloadPage(file: string | null): Promise<RawHttpResponse>;
1480
+ /**
1481
+ * Get Document.
1482
+ * @public
1483
+ * @requiredField file
1484
+ * @permissionId PAPYRUS.DOWNLOAD_DOCUMENT
1485
+ * @fqn wix.papyrus.v1.DownloadPageController.RedirectToDocument
1486
+ */
1487
+ declare function redirectToDocument(file: string | null): Promise<RawHttpResponse>;
1464
1488
 
1465
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type BackgroundSetting, type BaseEventMetadata, type CommonQueryWithEntityContext, ContentDisposition, type ContentDispositionWithLiterals, type CreateDocumentOptions, type CreateDocumentRequest, type CreateDocumentResponse, type CursorPaging, type Cursors, type DebugOptions, type DeleteDocumentByExternalIdRequest, type DeleteDocumentByExternalIdResponse, type DeleteDocumentRequest, type DeleteDocumentResponse, type Document, type DocumentContent, type DocumentCreatedEnvelope, type DocumentDeletedEnvelope, type DocumentFile, type DocumentQuery, type DocumentQuerySpec, type DocumentRenderDelayed, type DocumentRenderDelayedEnvelope, type DocumentRenderFailed, type DocumentRenderFailedEnvelope, type DocumentRendered, type DocumentRenderedEnvelope, type DocumentUpdatedEnvelope, type DocumentsQueryBuilder, type DocumentsQueryResult, type DomainEvent, type DomainEventBodyOneOf, type DownloadDocumentApplicationErrors, type DownloadDocumentOptions, type DownloadDocumentRequest, type DownloadDocumentResponse, type DownloadDocumentSourceApplicationErrors, type DownloadDocumentSourceOptions, type DownloadDocumentSourceRequest, type DownloadDocumentSourceResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type FocalPoint, Format, type FormatWithLiterals, type GetCachedHtmlRequest, type GetDocumentOptions, type GetDocumentRequest, type GetDocumentResponse, type GetDownloadPageRequest, type GetDownloadUrlOptions, type GetDownloadUrlOptionsDocumentOneOf, type GetDownloadUrlRequest, type GetDownloadUrlRequestDocumentOneOf, type GetDownloadUrlResponse, type GetRendererInfoRequest, type GetRendererInfoResponse, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ImageSetting, type MessageEnvelope, PageOverflow, type PageOverflowWithLiterals, type PageSettings, type Paging, type PagingMetadataV2, PaperSize, type PaperSizeWithLiterals, type QueryDocumentOptions, type QueryDocumentRequest, type QueryDocumentResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RawHttpResponse, type RedirectToDocumentRequest, type RenderDelayedEventConfig, type RenderDocumentByIdRequest, type RenderDocumentRequest, RenderFormat, type RenderFormatWithLiterals, RenderStatus, type RenderStatusWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, ResizeOption, type ResizeOptionWithLiterals, type RestoreInfo, type SelectSetting, type SettingsGroup, SortOrder, type SortOrderWithLiterals, type Sorting, type TemplateSettings, type TemplateSettingsOverride, type TextContent, type TextSetting, type UpdateDocumentOptions, type UpdateDocumentRequest, type UpdateDocumentResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WixMpClientVersion, type WixMpClientVersionWithLiterals, createDocument, deleteDocument, downloadDocument, downloadDocumentSource, getDocument, getDownloadPage, getDownloadUrl, onDocumentCreated, onDocumentDeleted, onDocumentRenderDelayed, onDocumentRenderFailed, onDocumentRendered, onDocumentUpdated, queryDocument, redirectToDocument, typedQueryDocument, updateDocument, utils };
1489
+ export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type BackgroundSetting, type BaseEventMetadata, type CommonQueryWithEntityContext, ContentDisposition, type ContentDispositionWithLiterals, type CreateDocumentOptions, type CreateDocumentRequest, type CreateDocumentResponse, type CursorPaging, type Cursors, type DebugOptions, type DeleteDocumentByExternalIdRequest, type DeleteDocumentByExternalIdResponse, type DeleteDocumentRequest, type DeleteDocumentResponse, type Document, type DocumentContent, type DocumentCreatedEnvelope, type DocumentDeletedEnvelope, type DocumentFile, type DocumentQuery, type DocumentQuerySpec, type DocumentRenderDelayed, type DocumentRenderDelayedEnvelope, type DocumentRenderFailed, type DocumentRenderFailedEnvelope, type DocumentRendered, type DocumentRenderedEnvelope, type DocumentUpdatedEnvelope, type DocumentsQueryBuilder, type DocumentsQueryResult, type DomainEvent, type DomainEventBodyOneOf, type DownloadDocumentApplicationErrors, type DownloadDocumentOptions, type DownloadDocumentRequest, type DownloadDocumentResponse, type DownloadDocumentSourceApplicationErrors, type DownloadDocumentSourceOptions, type DownloadDocumentSourceRequest, type DownloadDocumentSourceResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type FocalPoint, Format, type FormatWithLiterals, type GetCachedHtmlRequest, type GetDocumentOptions, type GetDocumentRequest, type GetDocumentResponse, type GetDownloadPageRequest, type GetDownloadUrlOptions, type GetDownloadUrlOptionsDocumentOneOf, type GetDownloadUrlRequest, type GetDownloadUrlRequestDocumentOneOf, type GetDownloadUrlResponse, type GetRendererInfoRequest, type GetRendererInfoResponse, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ImageSetting, type MessageEnvelope, PageOverflow, type PageOverflowWithLiterals, type PageSettings, type Paging, type PagingMetadataV2, PaperSize, type PaperSizeWithLiterals, type QueryDocumentOptions, type QueryDocumentRequest, type QueryDocumentResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RawHttpResponse, type RedirectToDocumentRequest, type RenderDelayedEventConfig, type RenderDocumentByIdRequest, type RenderDocumentRequest, RenderFormat, type RenderFormatWithLiterals, RenderStatus, type RenderStatusWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, ResizeOption, type ResizeOptionWithLiterals, type RestoreInfo, type SelectSetting, type SettingsGroup, SortOrder, type SortOrderWithLiterals, type Sorting, type TemplateSettings, type TemplateSettingsOverride, type TextContent, type TextSetting, type UpdateDocumentOptions, type UpdateDocumentRequest, type UpdateDocumentResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WixMpClientVersion, type WixMpClientVersionWithLiterals, createDocument, deleteDocument, downloadDocument, downloadDocumentSource, getDocument, getDownloadPage, getDownloadUrl, onDocumentCreated, onDocumentDeleted, onDocumentRenderDelayed, onDocumentRenderFailed, onDocumentRendered, onDocumentUpdated, queryDocument, redirectToDocument, typedQueryDocument, updateDocument, utils };