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