@subnoto/api-client 2.2.0 → 2.3.1
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.
|
Binary file
|
package/package.json
CHANGED
|
@@ -1723,214 +1723,6 @@ export interface paths {
|
|
|
1723
1723
|
patch?: never;
|
|
1724
1724
|
trace?: never;
|
|
1725
1725
|
};
|
|
1726
|
-
"/public/envelope/create": {
|
|
1727
|
-
parameters: {
|
|
1728
|
-
query?: never;
|
|
1729
|
-
header?: never;
|
|
1730
|
-
path?: never;
|
|
1731
|
-
cookie?: never;
|
|
1732
|
-
};
|
|
1733
|
-
get?: never;
|
|
1734
|
-
put?: never;
|
|
1735
|
-
/**
|
|
1736
|
-
* create
|
|
1737
|
-
* @description Create an envelope and the first document placeholder. Optionally accepts a small file directly (max 10 MB) in the request body. If a file is provided, it will be processed and uploaded directly. Otherwise, returns upload parameters for document upload.
|
|
1738
|
-
*/
|
|
1739
|
-
post: {
|
|
1740
|
-
parameters: {
|
|
1741
|
-
query?: never;
|
|
1742
|
-
header?: never;
|
|
1743
|
-
path?: never;
|
|
1744
|
-
cookie?: never;
|
|
1745
|
-
};
|
|
1746
|
-
requestBody: {
|
|
1747
|
-
content: {
|
|
1748
|
-
"application/json": {
|
|
1749
|
-
/** @description The UUID of the workspace to create the envelope in. */
|
|
1750
|
-
workspaceUuid: string;
|
|
1751
|
-
/** @description The title of the envelope being created. */
|
|
1752
|
-
envelopeTitle: string;
|
|
1753
|
-
/**
|
|
1754
|
-
* Format: base64
|
|
1755
|
-
* @description Base64-encoded PDF file data (max 10 MB). If provided, the file will be processed and uploaded directly, and presignedS3Params will not be returned.
|
|
1756
|
-
*/
|
|
1757
|
-
file?: string;
|
|
1758
|
-
};
|
|
1759
|
-
};
|
|
1760
|
-
};
|
|
1761
|
-
responses: {
|
|
1762
|
-
/** @description Default Response */
|
|
1763
|
-
200: {
|
|
1764
|
-
headers: {
|
|
1765
|
-
[name: string]: unknown;
|
|
1766
|
-
};
|
|
1767
|
-
content: {
|
|
1768
|
-
"application/json": {
|
|
1769
|
-
/** @description The unique identifier of the created envelope. */
|
|
1770
|
-
envelopeUuid: string;
|
|
1771
|
-
/** @description The unique identifier of the first document. */
|
|
1772
|
-
documentUuid: string;
|
|
1773
|
-
/** @description Upload parameters for document upload. Only returned when no file is provided in the request. */
|
|
1774
|
-
presignedS3Params?: {
|
|
1775
|
-
/** @description The URL for uploading the document. */
|
|
1776
|
-
url: string;
|
|
1777
|
-
/** @description Fields required for the upload. */
|
|
1778
|
-
fields: {
|
|
1779
|
-
/** @description The bucket name. */
|
|
1780
|
-
bucket: string;
|
|
1781
|
-
/** @description The object key. */
|
|
1782
|
-
key: string;
|
|
1783
|
-
/** @description The content type. */
|
|
1784
|
-
"content-type": string;
|
|
1785
|
-
/** @description The algorithm. */
|
|
1786
|
-
"x-amz-algorithm": string;
|
|
1787
|
-
/** @description The credential. */
|
|
1788
|
-
"x-amz-credential": string;
|
|
1789
|
-
/** @description The date. */
|
|
1790
|
-
"x-amz-date": string;
|
|
1791
|
-
/** @description The policy. */
|
|
1792
|
-
policy: string;
|
|
1793
|
-
/** @description The signature. */
|
|
1794
|
-
"x-amz-signature": string;
|
|
1795
|
-
};
|
|
1796
|
-
};
|
|
1797
|
-
/** @description The key in base64 for the document revision. */
|
|
1798
|
-
revisionEncryptionKey: string;
|
|
1799
|
-
};
|
|
1800
|
-
};
|
|
1801
|
-
};
|
|
1802
|
-
/** @description Default Response */
|
|
1803
|
-
400: {
|
|
1804
|
-
headers: {
|
|
1805
|
-
[name: string]: unknown;
|
|
1806
|
-
};
|
|
1807
|
-
content: {
|
|
1808
|
-
"application/json": {
|
|
1809
|
-
/** @description HTTP status code */
|
|
1810
|
-
statusCode: number;
|
|
1811
|
-
error: {
|
|
1812
|
-
/**
|
|
1813
|
-
* @description The error code
|
|
1814
|
-
* @enum {string}
|
|
1815
|
-
*/
|
|
1816
|
-
code: "WORKSPACE_NOT_FOUND" | "INVALID_FILE_DATA" | "FILE_SIZE_EXCEEDED" | "INVALID_PDF" | "INVALID_REQUEST_FORMAT";
|
|
1817
|
-
/** @description The error message */
|
|
1818
|
-
message: string;
|
|
1819
|
-
/** @description A suggestion to resolve the error */
|
|
1820
|
-
suggestion: string;
|
|
1821
|
-
/** @description A URL to the documentation */
|
|
1822
|
-
documentationUrl: string;
|
|
1823
|
-
};
|
|
1824
|
-
/** @description The unique identifier of the request */
|
|
1825
|
-
requestId: string;
|
|
1826
|
-
/** @description The timestamp of the response */
|
|
1827
|
-
timestamp: string;
|
|
1828
|
-
/** @description The path of the request */
|
|
1829
|
-
path: string;
|
|
1830
|
-
};
|
|
1831
|
-
};
|
|
1832
|
-
};
|
|
1833
|
-
/** @description Default Response */
|
|
1834
|
-
401: {
|
|
1835
|
-
headers: {
|
|
1836
|
-
[name: string]: unknown;
|
|
1837
|
-
};
|
|
1838
|
-
content: {
|
|
1839
|
-
"application/json": {
|
|
1840
|
-
/** @description HTTP status code */
|
|
1841
|
-
statusCode: number;
|
|
1842
|
-
error: {
|
|
1843
|
-
/**
|
|
1844
|
-
* @description The error code
|
|
1845
|
-
* @enum {string}
|
|
1846
|
-
*/
|
|
1847
|
-
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1848
|
-
/** @description The error message */
|
|
1849
|
-
message: string;
|
|
1850
|
-
/** @description A suggestion to resolve the error */
|
|
1851
|
-
suggestion: string;
|
|
1852
|
-
/** @description A URL to the documentation */
|
|
1853
|
-
documentationUrl: string;
|
|
1854
|
-
};
|
|
1855
|
-
/** @description The unique identifier of the request */
|
|
1856
|
-
requestId: string;
|
|
1857
|
-
/** @description The timestamp of the response */
|
|
1858
|
-
timestamp: string;
|
|
1859
|
-
/** @description The path of the request */
|
|
1860
|
-
path: string;
|
|
1861
|
-
};
|
|
1862
|
-
};
|
|
1863
|
-
};
|
|
1864
|
-
/** @description Default Response */
|
|
1865
|
-
403: {
|
|
1866
|
-
headers: {
|
|
1867
|
-
[name: string]: unknown;
|
|
1868
|
-
};
|
|
1869
|
-
content: {
|
|
1870
|
-
"application/json": {
|
|
1871
|
-
/** @description HTTP status code */
|
|
1872
|
-
statusCode: number;
|
|
1873
|
-
error: {
|
|
1874
|
-
/**
|
|
1875
|
-
* @description The error code
|
|
1876
|
-
* @enum {string}
|
|
1877
|
-
*/
|
|
1878
|
-
code: "AUTHORIZATION_ERROR" | "FEATURE_NOT_IN_CURRENT_PLAN" | "INVALID_REQUEST_FORMAT";
|
|
1879
|
-
/** @description The error message */
|
|
1880
|
-
message: string;
|
|
1881
|
-
/** @description A suggestion to resolve the error */
|
|
1882
|
-
suggestion: string;
|
|
1883
|
-
/** @description A URL to the documentation */
|
|
1884
|
-
documentationUrl: string;
|
|
1885
|
-
};
|
|
1886
|
-
/** @description The unique identifier of the request */
|
|
1887
|
-
requestId: string;
|
|
1888
|
-
/** @description The timestamp of the response */
|
|
1889
|
-
timestamp: string;
|
|
1890
|
-
/** @description The path of the request */
|
|
1891
|
-
path: string;
|
|
1892
|
-
};
|
|
1893
|
-
};
|
|
1894
|
-
};
|
|
1895
|
-
/** @description Default Response */
|
|
1896
|
-
500: {
|
|
1897
|
-
headers: {
|
|
1898
|
-
[name: string]: unknown;
|
|
1899
|
-
};
|
|
1900
|
-
content: {
|
|
1901
|
-
"application/json": {
|
|
1902
|
-
/** @description HTTP status code */
|
|
1903
|
-
statusCode: number;
|
|
1904
|
-
error: {
|
|
1905
|
-
/**
|
|
1906
|
-
* @description The error code
|
|
1907
|
-
* @enum {string}
|
|
1908
|
-
*/
|
|
1909
|
-
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1910
|
-
/** @description The error message */
|
|
1911
|
-
message: string;
|
|
1912
|
-
/** @description A suggestion to resolve the error */
|
|
1913
|
-
suggestion: string;
|
|
1914
|
-
/** @description A URL to the documentation */
|
|
1915
|
-
documentationUrl: string;
|
|
1916
|
-
};
|
|
1917
|
-
/** @description The unique identifier of the request */
|
|
1918
|
-
requestId: string;
|
|
1919
|
-
/** @description The timestamp of the response */
|
|
1920
|
-
timestamp: string;
|
|
1921
|
-
/** @description The path of the request */
|
|
1922
|
-
path: string;
|
|
1923
|
-
};
|
|
1924
|
-
};
|
|
1925
|
-
};
|
|
1926
|
-
};
|
|
1927
|
-
};
|
|
1928
|
-
delete?: never;
|
|
1929
|
-
options?: never;
|
|
1930
|
-
head?: never;
|
|
1931
|
-
patch?: never;
|
|
1932
|
-
trace?: never;
|
|
1933
|
-
};
|
|
1934
1726
|
"/public/envelope/create-from-file": {
|
|
1935
1727
|
parameters: {
|
|
1936
1728
|
query?: never;
|
|
@@ -1960,6 +1752,8 @@ export interface paths {
|
|
|
1960
1752
|
envelopeTitle: string;
|
|
1961
1753
|
/** @description The file to upload (PDF or Word document, max 50MB). */
|
|
1962
1754
|
file: unknown;
|
|
1755
|
+
/** @description Enable Smart Anchor detection. Set to 'true' to detect and process Smart Anchors in the PDF. Defaults to false. */
|
|
1756
|
+
detectSmartAnchors?: string;
|
|
1963
1757
|
};
|
|
1964
1758
|
};
|
|
1965
1759
|
};
|
|
@@ -3381,177 +3175,6 @@ export interface paths {
|
|
|
3381
3175
|
patch?: never;
|
|
3382
3176
|
trace?: never;
|
|
3383
3177
|
};
|
|
3384
|
-
"/public/envelope/complete-document-upload": {
|
|
3385
|
-
parameters: {
|
|
3386
|
-
query?: never;
|
|
3387
|
-
header?: never;
|
|
3388
|
-
path?: never;
|
|
3389
|
-
cookie?: never;
|
|
3390
|
-
};
|
|
3391
|
-
get?: never;
|
|
3392
|
-
put?: never;
|
|
3393
|
-
/**
|
|
3394
|
-
* complete-document-upload
|
|
3395
|
-
* @description Verify uploaded document, validate as PDF, generate a small preview image, and persist it.
|
|
3396
|
-
*/
|
|
3397
|
-
post: {
|
|
3398
|
-
parameters: {
|
|
3399
|
-
query?: never;
|
|
3400
|
-
header?: never;
|
|
3401
|
-
path?: never;
|
|
3402
|
-
cookie?: never;
|
|
3403
|
-
};
|
|
3404
|
-
requestBody: {
|
|
3405
|
-
content: {
|
|
3406
|
-
"application/json": {
|
|
3407
|
-
workspaceUuid: string;
|
|
3408
|
-
envelopeUuid: string;
|
|
3409
|
-
documentUuid: string;
|
|
3410
|
-
};
|
|
3411
|
-
};
|
|
3412
|
-
};
|
|
3413
|
-
responses: {
|
|
3414
|
-
/** @description Default Response */
|
|
3415
|
-
200: {
|
|
3416
|
-
headers: {
|
|
3417
|
-
[name: string]: unknown;
|
|
3418
|
-
};
|
|
3419
|
-
content: {
|
|
3420
|
-
"application/json": Record<string, never>;
|
|
3421
|
-
};
|
|
3422
|
-
};
|
|
3423
|
-
/** @description Default Response */
|
|
3424
|
-
400: {
|
|
3425
|
-
headers: {
|
|
3426
|
-
[name: string]: unknown;
|
|
3427
|
-
};
|
|
3428
|
-
content: {
|
|
3429
|
-
"application/json": {
|
|
3430
|
-
/** @description HTTP status code */
|
|
3431
|
-
statusCode: number;
|
|
3432
|
-
error: {
|
|
3433
|
-
/**
|
|
3434
|
-
* @description The error code
|
|
3435
|
-
* @enum {string}
|
|
3436
|
-
*/
|
|
3437
|
-
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "DOCUMENT_NOT_FOUND" | "DOCUMENT_REVISION_NOT_FOUND" | "DOCUMENT_INVALID" | "DOCUMENT_PREVIEW_GENERATION_FAILED" | "INVALID_REQUEST_FORMAT";
|
|
3438
|
-
/** @description The error message */
|
|
3439
|
-
message: string;
|
|
3440
|
-
/** @description A suggestion to resolve the error */
|
|
3441
|
-
suggestion: string;
|
|
3442
|
-
/** @description A URL to the documentation */
|
|
3443
|
-
documentationUrl: string;
|
|
3444
|
-
};
|
|
3445
|
-
/** @description The unique identifier of the request */
|
|
3446
|
-
requestId: string;
|
|
3447
|
-
/** @description The timestamp of the response */
|
|
3448
|
-
timestamp: string;
|
|
3449
|
-
/** @description The path of the request */
|
|
3450
|
-
path: string;
|
|
3451
|
-
};
|
|
3452
|
-
};
|
|
3453
|
-
};
|
|
3454
|
-
/** @description Default Response */
|
|
3455
|
-
401: {
|
|
3456
|
-
headers: {
|
|
3457
|
-
[name: string]: unknown;
|
|
3458
|
-
};
|
|
3459
|
-
content: {
|
|
3460
|
-
"application/json": {
|
|
3461
|
-
/** @description HTTP status code */
|
|
3462
|
-
statusCode: number;
|
|
3463
|
-
error: {
|
|
3464
|
-
/**
|
|
3465
|
-
* @description The error code
|
|
3466
|
-
* @enum {string}
|
|
3467
|
-
*/
|
|
3468
|
-
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3469
|
-
/** @description The error message */
|
|
3470
|
-
message: string;
|
|
3471
|
-
/** @description A suggestion to resolve the error */
|
|
3472
|
-
suggestion: string;
|
|
3473
|
-
/** @description A URL to the documentation */
|
|
3474
|
-
documentationUrl: string;
|
|
3475
|
-
};
|
|
3476
|
-
/** @description The unique identifier of the request */
|
|
3477
|
-
requestId: string;
|
|
3478
|
-
/** @description The timestamp of the response */
|
|
3479
|
-
timestamp: string;
|
|
3480
|
-
/** @description The path of the request */
|
|
3481
|
-
path: string;
|
|
3482
|
-
};
|
|
3483
|
-
};
|
|
3484
|
-
};
|
|
3485
|
-
/** @description Default Response */
|
|
3486
|
-
403: {
|
|
3487
|
-
headers: {
|
|
3488
|
-
[name: string]: unknown;
|
|
3489
|
-
};
|
|
3490
|
-
content: {
|
|
3491
|
-
"application/json": {
|
|
3492
|
-
/** @description HTTP status code */
|
|
3493
|
-
statusCode: number;
|
|
3494
|
-
error: {
|
|
3495
|
-
/**
|
|
3496
|
-
* @description The error code
|
|
3497
|
-
* @enum {string}
|
|
3498
|
-
*/
|
|
3499
|
-
code: "AUTHORIZATION_ERROR" | "FEATURE_NOT_IN_CURRENT_PLAN" | "INVALID_REQUEST_FORMAT";
|
|
3500
|
-
/** @description The error message */
|
|
3501
|
-
message: string;
|
|
3502
|
-
/** @description A suggestion to resolve the error */
|
|
3503
|
-
suggestion: string;
|
|
3504
|
-
/** @description A URL to the documentation */
|
|
3505
|
-
documentationUrl: string;
|
|
3506
|
-
};
|
|
3507
|
-
/** @description The unique identifier of the request */
|
|
3508
|
-
requestId: string;
|
|
3509
|
-
/** @description The timestamp of the response */
|
|
3510
|
-
timestamp: string;
|
|
3511
|
-
/** @description The path of the request */
|
|
3512
|
-
path: string;
|
|
3513
|
-
};
|
|
3514
|
-
};
|
|
3515
|
-
};
|
|
3516
|
-
/** @description Default Response */
|
|
3517
|
-
500: {
|
|
3518
|
-
headers: {
|
|
3519
|
-
[name: string]: unknown;
|
|
3520
|
-
};
|
|
3521
|
-
content: {
|
|
3522
|
-
"application/json": {
|
|
3523
|
-
/** @description HTTP status code */
|
|
3524
|
-
statusCode: number;
|
|
3525
|
-
error: {
|
|
3526
|
-
/**
|
|
3527
|
-
* @description The error code
|
|
3528
|
-
* @enum {string}
|
|
3529
|
-
*/
|
|
3530
|
-
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3531
|
-
/** @description The error message */
|
|
3532
|
-
message: string;
|
|
3533
|
-
/** @description A suggestion to resolve the error */
|
|
3534
|
-
suggestion: string;
|
|
3535
|
-
/** @description A URL to the documentation */
|
|
3536
|
-
documentationUrl: string;
|
|
3537
|
-
};
|
|
3538
|
-
/** @description The unique identifier of the request */
|
|
3539
|
-
requestId: string;
|
|
3540
|
-
/** @description The timestamp of the response */
|
|
3541
|
-
timestamp: string;
|
|
3542
|
-
/** @description The path of the request */
|
|
3543
|
-
path: string;
|
|
3544
|
-
};
|
|
3545
|
-
};
|
|
3546
|
-
};
|
|
3547
|
-
};
|
|
3548
|
-
};
|
|
3549
|
-
delete?: never;
|
|
3550
|
-
options?: never;
|
|
3551
|
-
head?: never;
|
|
3552
|
-
patch?: never;
|
|
3553
|
-
trace?: never;
|
|
3554
|
-
};
|
|
3555
3178
|
"/public/envelope/get-document": {
|
|
3556
3179
|
parameters: {
|
|
3557
3180
|
query?: never;
|
|
@@ -5089,7 +4712,6 @@ export enum ApiPaths {
|
|
|
5089
4712
|
PostPublicEnvelopeAddattachment = "/public/envelope/add-attachment",
|
|
5090
4713
|
PostPublicEnvelopeAddblocks = "/public/envelope/add-blocks",
|
|
5091
4714
|
PostPublicEnvelopeAddrecipients = "/public/envelope/add-recipients",
|
|
5092
|
-
PostPublicEnvelopeCreate = "/public/envelope/create",
|
|
5093
4715
|
PostPublicEnvelopeCreatefrom_file = "/public/envelope/create-from-file",
|
|
5094
4716
|
PostPublicEnvelopeCreatefrom_template = "/public/envelope/create-from-template",
|
|
5095
4717
|
PostPublicEnvelopeDeleteattachment = "/public/envelope/delete-attachment",
|
|
@@ -5098,7 +4720,6 @@ export enum ApiPaths {
|
|
|
5098
4720
|
PostPublicEnvelopeDeleterecipients = "/public/envelope/delete-recipients",
|
|
5099
4721
|
PostPublicEnvelopeSend = "/public/envelope/send",
|
|
5100
4722
|
PostPublicEnvelopeSign = "/public/envelope/sign",
|
|
5101
|
-
PostPublicEnvelopeCompletedocument_upload = "/public/envelope/complete-document-upload",
|
|
5102
4723
|
PostPublicEnvelopeGetdocument = "/public/envelope/get-document",
|
|
5103
4724
|
PostPublicEnvelopeGet = "/public/envelope/get",
|
|
5104
4725
|
PostPublicEnvelopeGetproof = "/public/envelope/get-proof",
|