@subnoto/api-client 2.5.3 → 2.5.5
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
|
@@ -4,6 +4,186 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
+
"/public/authentication/create-iframe-token": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
get?: never;
|
|
15
|
+
put?: never;
|
|
16
|
+
/**
|
|
17
|
+
* create-iframe-token
|
|
18
|
+
* @description Create an iframe token for embedding the sign flow for a specific envelope and signer.
|
|
19
|
+
*/
|
|
20
|
+
post: {
|
|
21
|
+
parameters: {
|
|
22
|
+
query?: never;
|
|
23
|
+
header?: never;
|
|
24
|
+
path?: never;
|
|
25
|
+
cookie?: never;
|
|
26
|
+
};
|
|
27
|
+
requestBody: {
|
|
28
|
+
content: {
|
|
29
|
+
"application/json": {
|
|
30
|
+
/** @description The UUID of the workspace. */
|
|
31
|
+
workspaceUuid: string;
|
|
32
|
+
/** @description The UUID of the envelope. */
|
|
33
|
+
envelopeUuid: string;
|
|
34
|
+
/**
|
|
35
|
+
* Format: email
|
|
36
|
+
* @description The signer email address.
|
|
37
|
+
*/
|
|
38
|
+
signerEmail: string;
|
|
39
|
+
};
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
responses: {
|
|
43
|
+
/** @description Default Response */
|
|
44
|
+
200: {
|
|
45
|
+
headers: {
|
|
46
|
+
[name: string]: unknown;
|
|
47
|
+
};
|
|
48
|
+
content: {
|
|
49
|
+
"application/json": {
|
|
50
|
+
/** @description The iframe token (prefix sit.) to use in the embed sign URL hash. */
|
|
51
|
+
iframeToken: string;
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
|
+
};
|
|
55
|
+
/** @description Default Response */
|
|
56
|
+
400: {
|
|
57
|
+
headers: {
|
|
58
|
+
[name: string]: unknown;
|
|
59
|
+
};
|
|
60
|
+
content: {
|
|
61
|
+
"application/json": {
|
|
62
|
+
/** @description HTTP status code */
|
|
63
|
+
statusCode: number;
|
|
64
|
+
error: {
|
|
65
|
+
/**
|
|
66
|
+
* @description The error code
|
|
67
|
+
* @enum {string}
|
|
68
|
+
*/
|
|
69
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "SIGNER_NOT_IN_ENVELOPE" | "INVALID_REQUEST_FORMAT";
|
|
70
|
+
/** @description The error message */
|
|
71
|
+
message: string;
|
|
72
|
+
/** @description A suggestion to resolve the error */
|
|
73
|
+
suggestion: string;
|
|
74
|
+
/** @description A URL to the documentation */
|
|
75
|
+
documentationUrl: string;
|
|
76
|
+
};
|
|
77
|
+
/** @description The unique identifier of the request */
|
|
78
|
+
requestId: string;
|
|
79
|
+
/** @description The timestamp of the response */
|
|
80
|
+
timestamp: string;
|
|
81
|
+
/** @description The path of the request */
|
|
82
|
+
path: string;
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
/** @description Default Response */
|
|
87
|
+
401: {
|
|
88
|
+
headers: {
|
|
89
|
+
[name: string]: unknown;
|
|
90
|
+
};
|
|
91
|
+
content: {
|
|
92
|
+
"application/json": {
|
|
93
|
+
/** @description HTTP status code */
|
|
94
|
+
statusCode: number;
|
|
95
|
+
error: {
|
|
96
|
+
/**
|
|
97
|
+
* @description The error code
|
|
98
|
+
* @enum {string}
|
|
99
|
+
*/
|
|
100
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
101
|
+
/** @description The error message */
|
|
102
|
+
message: string;
|
|
103
|
+
/** @description A suggestion to resolve the error */
|
|
104
|
+
suggestion: string;
|
|
105
|
+
/** @description A URL to the documentation */
|
|
106
|
+
documentationUrl: string;
|
|
107
|
+
};
|
|
108
|
+
/** @description The unique identifier of the request */
|
|
109
|
+
requestId: string;
|
|
110
|
+
/** @description The timestamp of the response */
|
|
111
|
+
timestamp: string;
|
|
112
|
+
/** @description The path of the request */
|
|
113
|
+
path: string;
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
/** @description Default Response */
|
|
118
|
+
403: {
|
|
119
|
+
headers: {
|
|
120
|
+
[name: string]: unknown;
|
|
121
|
+
};
|
|
122
|
+
content: {
|
|
123
|
+
"application/json": {
|
|
124
|
+
/** @description HTTP status code */
|
|
125
|
+
statusCode: number;
|
|
126
|
+
error: {
|
|
127
|
+
/**
|
|
128
|
+
* @description The error code
|
|
129
|
+
* @enum {string}
|
|
130
|
+
*/
|
|
131
|
+
code: "AUTHORIZATION_ERROR" | "FEATURE_NOT_IN_CURRENT_PLAN" | "INVALID_REQUEST_FORMAT";
|
|
132
|
+
/** @description The error message */
|
|
133
|
+
message: string;
|
|
134
|
+
/** @description A suggestion to resolve the error */
|
|
135
|
+
suggestion: string;
|
|
136
|
+
/** @description A URL to the documentation */
|
|
137
|
+
documentationUrl: string;
|
|
138
|
+
};
|
|
139
|
+
/** @description The unique identifier of the request */
|
|
140
|
+
requestId: string;
|
|
141
|
+
/** @description The timestamp of the response */
|
|
142
|
+
timestamp: string;
|
|
143
|
+
/** @description The path of the request */
|
|
144
|
+
path: string;
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
/** @description Default Response */
|
|
149
|
+
500: {
|
|
150
|
+
headers: {
|
|
151
|
+
[name: string]: unknown;
|
|
152
|
+
};
|
|
153
|
+
content: {
|
|
154
|
+
"application/json": {
|
|
155
|
+
/** @description HTTP status code */
|
|
156
|
+
statusCode: number;
|
|
157
|
+
error: {
|
|
158
|
+
/**
|
|
159
|
+
* @description The error code
|
|
160
|
+
* @enum {string}
|
|
161
|
+
*/
|
|
162
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
163
|
+
/** @description The error message */
|
|
164
|
+
message: string;
|
|
165
|
+
/** @description A suggestion to resolve the error */
|
|
166
|
+
suggestion: string;
|
|
167
|
+
/** @description A URL to the documentation */
|
|
168
|
+
documentationUrl: string;
|
|
169
|
+
};
|
|
170
|
+
/** @description The unique identifier of the request */
|
|
171
|
+
requestId: string;
|
|
172
|
+
/** @description The timestamp of the response */
|
|
173
|
+
timestamp: string;
|
|
174
|
+
/** @description The path of the request */
|
|
175
|
+
path: string;
|
|
176
|
+
};
|
|
177
|
+
};
|
|
178
|
+
};
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
delete?: never;
|
|
182
|
+
options?: never;
|
|
183
|
+
head?: never;
|
|
184
|
+
patch?: never;
|
|
185
|
+
trace?: never;
|
|
186
|
+
};
|
|
7
187
|
"/public/contact/create": {
|
|
8
188
|
parameters: {
|
|
9
189
|
query?: never;
|
|
@@ -2861,6 +3041,12 @@ export interface paths {
|
|
|
2861
3041
|
workspaceUuid: string;
|
|
2862
3042
|
/** @description The UUID of the envelope to send. */
|
|
2863
3043
|
envelopeUuid: string;
|
|
3044
|
+
/**
|
|
3045
|
+
* @description When "email" (default), invitation emails are sent; when "none", no emails are sent and link medium is set to "none".
|
|
3046
|
+
* @default email
|
|
3047
|
+
* @enum {string}
|
|
3048
|
+
*/
|
|
3049
|
+
distributionMethod?: "email" | "none";
|
|
2864
3050
|
/**
|
|
2865
3051
|
* @deprecated
|
|
2866
3052
|
* @description Deprecated. Use the update envelope endpoint to set this; value is ignored when sending. Whether to use the user's name or by default the company name as the sender name.
|
|
@@ -5112,6 +5298,7 @@ export interface components {
|
|
|
5112
5298
|
export type $defs = Record<string, never>;
|
|
5113
5299
|
export type operations = Record<string, never>;
|
|
5114
5300
|
export enum ApiPaths {
|
|
5301
|
+
PostPublicAuthenticationCreateiframe_token = "/public/authentication/create-iframe-token",
|
|
5115
5302
|
PostPublicContactCreate = "/public/contact/create",
|
|
5116
5303
|
PostPublicContactList = "/public/contact/list",
|
|
5117
5304
|
PostPublicContactDelete = "/public/contact/delete",
|