@keystrokehq/docusign 0.0.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.
- package/README.md +248 -0
- package/dist/_official/index.d.mts +3 -0
- package/dist/_official/index.mjs +3 -0
- package/dist/_runtime/index.d.mts +1 -0
- package/dist/_runtime/index.mjs +1 -0
- package/dist/account-custom-fields.d.mts +65 -0
- package/dist/account-custom-fields.mjs +63 -0
- package/dist/account-stamps.d.mts +164 -0
- package/dist/account-stamps.mjs +144 -0
- package/dist/account-tabs.d.mts +90 -0
- package/dist/account-tabs.mjs +80 -0
- package/dist/account.d.mts +233 -0
- package/dist/account.mjs +207 -0
- package/dist/admin.d.mts +18 -0
- package/dist/admin.mjs +20 -0
- package/dist/auth.d.mts +37 -0
- package/dist/auth.mjs +53 -0
- package/dist/bcc-archive.d.mts +64 -0
- package/dist/bcc-archive.mjs +70 -0
- package/dist/billing.d.mts +217 -0
- package/dist/billing.mjs +208 -0
- package/dist/brands.d.mts +192 -0
- package/dist/brands.mjs +157 -0
- package/dist/bulk-send.d.mts +137 -0
- package/dist/bulk-send.mjs +115 -0
- package/dist/chunked-uploads.d.mts +78 -0
- package/dist/chunked-uploads.mjs +74 -0
- package/dist/click.d.mts +18 -0
- package/dist/click.mjs +20 -0
- package/dist/client.d.mts +47 -0
- package/dist/client.mjs +286 -0
- package/dist/clm.d.mts +18 -0
- package/dist/clm.mjs +20 -0
- package/dist/cloud-storage.d.mts +122 -0
- package/dist/cloud-storage.mjs +115 -0
- package/dist/connect.d.mts +252 -0
- package/dist/connect.mjs +217 -0
- package/dist/connection.d.mts +2 -0
- package/dist/connection.mjs +3 -0
- package/dist/contacts.d.mts +80 -0
- package/dist/contacts.mjs +79 -0
- package/dist/enote.d.mts +44 -0
- package/dist/enote.mjs +45 -0
- package/dist/envelope-attachments.d.mts +86 -0
- package/dist/envelope-attachments.mjs +76 -0
- package/dist/envelope-custom-fields.d.mts +166 -0
- package/dist/envelope-custom-fields.mjs +92 -0
- package/dist/envelope-documents.d.mts +271 -0
- package/dist/envelope-documents.mjs +219 -0
- package/dist/envelope-email.d.mts +65 -0
- package/dist/envelope-email.mjs +60 -0
- package/dist/envelope-lock.d.mts +65 -0
- package/dist/envelope-lock.mjs +60 -0
- package/dist/envelope-logs.d.mts +126 -0
- package/dist/envelope-logs.mjs +126 -0
- package/dist/envelope-notifications.d.mts +47 -0
- package/dist/envelope-notifications.mjs +44 -0
- package/dist/envelope-recipients.d.mts +171 -0
- package/dist/envelope-recipients.mjs +136 -0
- package/dist/envelope-tabs.d.mts +52 -0
- package/dist/envelope-tabs.mjs +49 -0
- package/dist/envelope-views.d.mts +99 -0
- package/dist/envelope-views.mjs +88 -0
- package/dist/envelope-workflow.d.mts +208 -0
- package/dist/envelope-workflow.mjs +176 -0
- package/dist/envelopes.d.mts +430 -0
- package/dist/envelopes.mjs +190 -0
- package/dist/errors.d.mts +48 -0
- package/dist/errors.mjs +76 -0
- package/dist/events.d.mts +192 -0
- package/dist/events.mjs +146 -0
- package/dist/factory-wViQTjgN.mjs +8 -0
- package/dist/groups.d.mts +191 -0
- package/dist/groups.mjs +146 -0
- package/dist/index.d.mts +1 -0
- package/dist/index.mjs +1 -0
- package/dist/integration-CmRztL9R.mjs +229 -0
- package/dist/integration-DqwHRkRh.d.mts +73 -0
- package/dist/messaging.d.mts +1 -0
- package/dist/messaging.mjs +1 -0
- package/dist/monitor.d.mts +18 -0
- package/dist/monitor.mjs +20 -0
- package/dist/notary.d.mts +129 -0
- package/dist/notary.mjs +122 -0
- package/dist/operation-helpers-BMTArRh9.mjs +102 -0
- package/dist/permission-profiles.d.mts +78 -0
- package/dist/permission-profiles.mjs +70 -0
- package/dist/power-forms.d.mts +51 -0
- package/dist/power-forms.mjs +62 -0
- package/dist/provider-app-CWp1SuI4.d.mts +88 -0
- package/dist/rooms.d.mts +18 -0
- package/dist/rooms.mjs +28 -0
- package/dist/schemas/index.d.mts +581 -0
- package/dist/schemas/index.mjs +309 -0
- package/dist/shared-DTUCJayR.mjs +27 -0
- package/dist/signing-groups.d.mts +139 -0
- package/dist/signing-groups.mjs +117 -0
- package/dist/template-custom-fields.d.mts +199 -0
- package/dist/template-custom-fields.mjs +107 -0
- package/dist/template-documents.d.mts +132 -0
- package/dist/template-documents.mjs +109 -0
- package/dist/template-lock.d.mts +65 -0
- package/dist/template-lock.mjs +60 -0
- package/dist/template-sharing.d.mts +129 -0
- package/dist/template-sharing.mjs +108 -0
- package/dist/template-workflow.d.mts +184 -0
- package/dist/template-workflow.mjs +152 -0
- package/dist/templates.d.mts +158 -0
- package/dist/templates.mjs +110 -0
- package/dist/triggers.d.mts +43 -0
- package/dist/triggers.mjs +91 -0
- package/dist/user-authorizations.d.mts +129 -0
- package/dist/user-authorizations.mjs +133 -0
- package/dist/user-custom-settings.d.mts +81 -0
- package/dist/user-custom-settings.mjs +69 -0
- package/dist/user-profile.d.mts +109 -0
- package/dist/user-profile.mjs +106 -0
- package/dist/user-signatures.d.mts +208 -0
- package/dist/user-signatures.mjs +180 -0
- package/dist/users.d.mts +128 -0
- package/dist/users.mjs +98 -0
- package/dist/verification.d.mts +19 -0
- package/dist/verification.mjs +59 -0
- package/dist/workspaces.d.mts +173 -0
- package/dist/workspaces.mjs +143 -0
- package/package.json +291 -0
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import * as _keystrokehq_core0 from "@keystrokehq/core";
|
|
3
|
+
import * as _keystrokehq_core_credential_set0 from "@keystrokehq/core/credential-set";
|
|
4
|
+
|
|
5
|
+
//#region src/user-signatures.d.ts
|
|
6
|
+
declare const addOrUpdateUserSignature: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
7
|
+
userId: z.ZodString;
|
|
8
|
+
userSignatures: z.ZodArray<z.ZodObject<{
|
|
9
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
10
|
+
}, z.core.$catchall<z.ZodUnknown>>>;
|
|
11
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
12
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
13
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
14
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
15
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
16
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
17
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
18
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
19
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
20
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
21
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
22
|
+
declare const addUserSignatureAndInitialsImages: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
23
|
+
userId: z.ZodString;
|
|
24
|
+
userSignatures: z.ZodArray<z.ZodObject<{
|
|
25
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
26
|
+
}, z.core.$catchall<z.ZodUnknown>>>;
|
|
27
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
28
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
29
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
30
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
31
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
32
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
33
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
34
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
35
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
36
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
37
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
38
|
+
declare const retrieveUserSignatureDefinitions: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
39
|
+
userId: z.ZodString;
|
|
40
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
41
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
42
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
43
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
44
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
45
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
46
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
47
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
48
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
49
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
50
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
51
|
+
declare const retrieveUserSignatureInformation: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
52
|
+
userId: z.ZodString;
|
|
53
|
+
signatureId: z.ZodString;
|
|
54
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
55
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
56
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
57
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
58
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
59
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
60
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
61
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
62
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
63
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
64
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
65
|
+
declare const retrieveUserSignatureImage: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
66
|
+
userId: z.ZodString;
|
|
67
|
+
signatureId: z.ZodString;
|
|
68
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
69
|
+
contentType: z.ZodOptional<z.ZodString>;
|
|
70
|
+
contentDisposition: z.ZodOptional<z.ZodString>;
|
|
71
|
+
status: z.ZodNumber;
|
|
72
|
+
body: z.ZodString;
|
|
73
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
74
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
75
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
76
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
77
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
78
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
79
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
80
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
81
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
82
|
+
declare const setUserSignatureImage: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
83
|
+
userId: z.ZodString;
|
|
84
|
+
signatureId: z.ZodString;
|
|
85
|
+
image: z.ZodString;
|
|
86
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
87
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
88
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
89
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
90
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
91
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
92
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
93
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
94
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
95
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
96
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
97
|
+
declare const updateUserSignatureById: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
98
|
+
userId: z.ZodString;
|
|
99
|
+
signatureId: z.ZodString;
|
|
100
|
+
signature: z.ZodObject<{
|
|
101
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
102
|
+
}, z.core.$catchall<z.ZodUnknown>>;
|
|
103
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
104
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
105
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
106
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
107
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
108
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
109
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
110
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
111
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
112
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
113
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
114
|
+
declare const retrieveUserInitialsImageForEnvelopes: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
115
|
+
userId: z.ZodString;
|
|
116
|
+
signatureId: z.ZodString;
|
|
117
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
118
|
+
contentType: z.ZodOptional<z.ZodString>;
|
|
119
|
+
contentDisposition: z.ZodOptional<z.ZodString>;
|
|
120
|
+
status: z.ZodNumber;
|
|
121
|
+
body: z.ZodString;
|
|
122
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
123
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
124
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
125
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
126
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
127
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
128
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
129
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
130
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
131
|
+
declare const deleteUserInitialsOrSignatureImage: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
132
|
+
userId: z.ZodString;
|
|
133
|
+
signatureId: z.ZodString;
|
|
134
|
+
imageType: z.ZodOptional<z.ZodEnum<{
|
|
135
|
+
signature_image: "signature_image";
|
|
136
|
+
initials_image: "initials_image";
|
|
137
|
+
}>>;
|
|
138
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
139
|
+
success: z.ZodBoolean;
|
|
140
|
+
}, z.core.$strip>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
141
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
142
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
143
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
144
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
145
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
146
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
147
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
148
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
149
|
+
declare const removeUserSignatureInformation: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
150
|
+
userId: z.ZodString;
|
|
151
|
+
signatureId: z.ZodString;
|
|
152
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
153
|
+
success: z.ZodBoolean;
|
|
154
|
+
}, z.core.$strip>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
155
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
156
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
157
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
158
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
159
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
160
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
161
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
162
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
163
|
+
declare const setInitialsImageForAccountlessSigner: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
164
|
+
envelopeId: z.ZodString;
|
|
165
|
+
recipientId: z.ZodString;
|
|
166
|
+
image: z.ZodString;
|
|
167
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
168
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
169
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
170
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
171
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
172
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
173
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
174
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
175
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
176
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
177
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
178
|
+
declare const setSignatureImageForNoAccountSigner: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
179
|
+
envelopeId: z.ZodString;
|
|
180
|
+
recipientId: z.ZodString;
|
|
181
|
+
image: z.ZodString;
|
|
182
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
183
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
184
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
185
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
186
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
187
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
188
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
189
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
190
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
191
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
192
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
193
|
+
declare const deleteSignatureForCaptiveRecipients: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
194
|
+
envelopeId: z.ZodString;
|
|
195
|
+
recipientId: z.ZodString;
|
|
196
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
197
|
+
success: z.ZodBoolean;
|
|
198
|
+
}, z.core.$strip>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
199
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
200
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
201
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
202
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
203
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
204
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
205
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
206
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
207
|
+
//#endregion
|
|
208
|
+
export { addOrUpdateUserSignature, addUserSignatureAndInitialsImages, deleteSignatureForCaptiveRecipients, deleteUserInitialsOrSignatureImage, removeUserSignatureInformation, retrieveUserInitialsImageForEnvelopes, retrieveUserSignatureDefinitions, retrieveUserSignatureImage, retrieveUserSignatureInformation, setInitialsImageForAccountlessSigner, setSignatureImageForNoAccountSigner, setUserSignatureImage, updateUserSignatureById };
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
import { docusignGenericObjectSchema, docusignLooseObjectSchema, docusignSuccessSchema } from "./schemas/index.mjs";
|
|
2
|
+
import { r as defineRestOperation, t as defineBinaryOperation } from "./operation-helpers-BMTArRh9.mjs";
|
|
3
|
+
import { z } from "zod";
|
|
4
|
+
|
|
5
|
+
//#region src/user-signatures.ts
|
|
6
|
+
/**
|
|
7
|
+
* User signatures and initials. Covers PLAN.md § 6.23.
|
|
8
|
+
*/
|
|
9
|
+
const userId = z.object({ userId: z.string().min(1) });
|
|
10
|
+
const userSignature = userId.extend({ signatureId: z.string().min(1) });
|
|
11
|
+
const binaryResponseSchema = docusignLooseObjectSchema({
|
|
12
|
+
contentType: z.string().optional(),
|
|
13
|
+
contentDisposition: z.string().optional(),
|
|
14
|
+
status: z.number(),
|
|
15
|
+
body: z.string()
|
|
16
|
+
});
|
|
17
|
+
const addOrUpdateUserSignature = defineRestOperation({
|
|
18
|
+
id: "add_or_update_user_signature",
|
|
19
|
+
slug: "DOCUSIGN_ADD_OR_UPDATE_USER_SIGNATURE",
|
|
20
|
+
name: "Add Or Update User Signature",
|
|
21
|
+
description: "Add or update user signature definitions.",
|
|
22
|
+
needsApproval: true,
|
|
23
|
+
method: "POST",
|
|
24
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures`,
|
|
25
|
+
input: userId.extend({ userSignatures: z.array(docusignLooseObjectSchema()).min(1) }),
|
|
26
|
+
output: docusignGenericObjectSchema,
|
|
27
|
+
body: (input) => ({ userSignatures: input.userSignatures })
|
|
28
|
+
});
|
|
29
|
+
const addUserSignatureAndInitialsImages = defineRestOperation({
|
|
30
|
+
id: "add_user_signature_and_initials_images",
|
|
31
|
+
slug: "DOCUSIGN_ADD_USER_SIGNATURE_AND_INITIALS_IMAGES",
|
|
32
|
+
name: "Add User Signature And Initials Images",
|
|
33
|
+
description: "Add signature and initials images for a user.",
|
|
34
|
+
needsApproval: true,
|
|
35
|
+
method: "PUT",
|
|
36
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures`,
|
|
37
|
+
input: userId.extend({ userSignatures: z.array(docusignLooseObjectSchema()).min(1) }),
|
|
38
|
+
output: docusignGenericObjectSchema,
|
|
39
|
+
body: (input) => ({ userSignatures: input.userSignatures })
|
|
40
|
+
});
|
|
41
|
+
const retrieveUserSignatureDefinitions = defineRestOperation({
|
|
42
|
+
id: "retrieve_user_signature_definitions",
|
|
43
|
+
slug: "DOCUSIGN_RETRIEVE_USER_SIGNATURE_DEFINITIONS",
|
|
44
|
+
name: "Retrieve User Signature Definitions",
|
|
45
|
+
description: "List signature definitions on a user.",
|
|
46
|
+
method: "GET",
|
|
47
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures`,
|
|
48
|
+
input: userId,
|
|
49
|
+
output: docusignGenericObjectSchema
|
|
50
|
+
});
|
|
51
|
+
const retrieveUserSignatureInformation = defineRestOperation({
|
|
52
|
+
id: "retrieve_user_signature_information",
|
|
53
|
+
slug: "DOCUSIGN_RETRIEVE_USER_SIGNATURE_INFORMATION",
|
|
54
|
+
name: "Retrieve User Signature Information",
|
|
55
|
+
description: "Retrieve information about a specific signature on a user.",
|
|
56
|
+
method: "GET",
|
|
57
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures/${ctx.encode(String(ctx.input.signatureId))}`,
|
|
58
|
+
input: userSignature,
|
|
59
|
+
output: docusignGenericObjectSchema
|
|
60
|
+
});
|
|
61
|
+
const retrieveUserSignatureImage = defineBinaryOperation({
|
|
62
|
+
id: "retrieve_user_signature_image",
|
|
63
|
+
slug: "DOCUSIGN_RETRIEVE_USER_SIGNATURE_IMAGE",
|
|
64
|
+
name: "Retrieve User Signature Image",
|
|
65
|
+
description: "Download the signature image for a user.",
|
|
66
|
+
method: "GET",
|
|
67
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures/${ctx.encode(String(ctx.input.signatureId))}/signature_image`,
|
|
68
|
+
input: userSignature,
|
|
69
|
+
accept: "image/png",
|
|
70
|
+
output: binaryResponseSchema
|
|
71
|
+
});
|
|
72
|
+
const setUserSignatureImage = defineRestOperation({
|
|
73
|
+
id: "set_user_signature_image",
|
|
74
|
+
slug: "DOCUSIGN_SET_USER_SIGNATURE_IMAGE",
|
|
75
|
+
name: "Set User Signature Image",
|
|
76
|
+
description: "Upload a new signature image for a user.",
|
|
77
|
+
needsApproval: true,
|
|
78
|
+
method: "PUT",
|
|
79
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures/${ctx.encode(String(ctx.input.signatureId))}/signature_image`,
|
|
80
|
+
input: userSignature.extend({ image: z.string().min(1) }),
|
|
81
|
+
output: docusignGenericObjectSchema,
|
|
82
|
+
body: (input) => ({ image: input.image })
|
|
83
|
+
});
|
|
84
|
+
const updateUserSignatureById = defineRestOperation({
|
|
85
|
+
id: "update_user_signature_by_id",
|
|
86
|
+
slug: "DOCUSIGN_UPDATE_USER_SIGNATURE_BY_ID",
|
|
87
|
+
name: "Update User Signature By Id",
|
|
88
|
+
description: "Update a single signature definition on a user.",
|
|
89
|
+
needsApproval: true,
|
|
90
|
+
method: "PUT",
|
|
91
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures/${ctx.encode(String(ctx.input.signatureId))}`,
|
|
92
|
+
input: userSignature.extend({ signature: docusignLooseObjectSchema() }),
|
|
93
|
+
output: docusignGenericObjectSchema,
|
|
94
|
+
body: (input) => input.signature
|
|
95
|
+
});
|
|
96
|
+
const retrieveUserInitialsImageForEnvelopes = defineBinaryOperation({
|
|
97
|
+
id: "retrieve_user_initials_image_for_envelopes",
|
|
98
|
+
slug: "DOCUSIGN_RETRIEVE_USER_INITIALS_IMAGE_FOR_ENVELOPES",
|
|
99
|
+
name: "Retrieve User Initials Image",
|
|
100
|
+
description: "Download the initials image for a user.",
|
|
101
|
+
method: "GET",
|
|
102
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures/${ctx.encode(String(ctx.input.signatureId))}/initials_image`,
|
|
103
|
+
input: userSignature,
|
|
104
|
+
accept: "image/png",
|
|
105
|
+
output: binaryResponseSchema
|
|
106
|
+
});
|
|
107
|
+
const deleteUserInitialsOrSignatureImage = defineRestOperation({
|
|
108
|
+
id: "delete_user_initials_or_signature_image",
|
|
109
|
+
slug: "DOCUSIGN_DELETE_USER_INITIALS_OR_SIGNATURE_IMAGE",
|
|
110
|
+
name: "Delete User Initials Or Signature Image",
|
|
111
|
+
description: "Delete a user signature or initials image.",
|
|
112
|
+
needsApproval: true,
|
|
113
|
+
method: "DELETE",
|
|
114
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures/${ctx.encode(String(ctx.input.signatureId))}/${ctx.encode(String(ctx.input.imageType ?? "signature_image"))}`,
|
|
115
|
+
input: userSignature.extend({ imageType: z.enum(["signature_image", "initials_image"]).optional() }),
|
|
116
|
+
output: docusignSuccessSchema,
|
|
117
|
+
transformResponse: () => ({ success: true })
|
|
118
|
+
});
|
|
119
|
+
const removeUserSignatureInformation = defineRestOperation({
|
|
120
|
+
id: "remove_user_signature_information",
|
|
121
|
+
slug: "DOCUSIGN_REMOVE_USER_SIGNATURE_INFORMATION",
|
|
122
|
+
name: "Remove User Signature Information",
|
|
123
|
+
description: "Remove all signature information for a user.",
|
|
124
|
+
needsApproval: true,
|
|
125
|
+
method: "DELETE",
|
|
126
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}/signatures/${ctx.encode(String(ctx.input.signatureId))}`,
|
|
127
|
+
input: userSignature,
|
|
128
|
+
output: docusignSuccessSchema,
|
|
129
|
+
transformResponse: () => ({ success: true })
|
|
130
|
+
});
|
|
131
|
+
const setInitialsImageForAccountlessSigner = defineRestOperation({
|
|
132
|
+
id: "set_initials_image_for_accountless_signer",
|
|
133
|
+
slug: "DOCUSIGN_SET_INITIALS_IMAGE_FOR_ACCOUNTLESS_SIGNER",
|
|
134
|
+
name: "Set Initials For Accountless Signer",
|
|
135
|
+
description: "Set initials image for an accountless signer (captive recipient).",
|
|
136
|
+
needsApproval: true,
|
|
137
|
+
method: "PUT",
|
|
138
|
+
path: (ctx) => `/envelopes/${ctx.encode(String(ctx.input.envelopeId))}/recipients/${ctx.encode(String(ctx.input.recipientId))}/initials_image`,
|
|
139
|
+
input: z.object({
|
|
140
|
+
envelopeId: z.string().min(1),
|
|
141
|
+
recipientId: z.string().min(1),
|
|
142
|
+
image: z.string().min(1)
|
|
143
|
+
}),
|
|
144
|
+
output: docusignGenericObjectSchema,
|
|
145
|
+
body: (input) => ({ image: input.image })
|
|
146
|
+
});
|
|
147
|
+
const setSignatureImageForNoAccountSigner = defineRestOperation({
|
|
148
|
+
id: "set_signature_image_for_no_account_signer",
|
|
149
|
+
slug: "DOCUSIGN_SET_SIGNATURE_IMAGE_FOR_NO_ACCOUNT_SIGNER",
|
|
150
|
+
name: "Set Signature For No-Account Signer",
|
|
151
|
+
description: "Set signature image for a captive recipient.",
|
|
152
|
+
needsApproval: true,
|
|
153
|
+
method: "PUT",
|
|
154
|
+
path: (ctx) => `/envelopes/${ctx.encode(String(ctx.input.envelopeId))}/recipients/${ctx.encode(String(ctx.input.recipientId))}/signature_image`,
|
|
155
|
+
input: z.object({
|
|
156
|
+
envelopeId: z.string().min(1),
|
|
157
|
+
recipientId: z.string().min(1),
|
|
158
|
+
image: z.string().min(1)
|
|
159
|
+
}),
|
|
160
|
+
output: docusignGenericObjectSchema,
|
|
161
|
+
body: (input) => ({ image: input.image })
|
|
162
|
+
});
|
|
163
|
+
const deleteSignatureForCaptiveRecipients = defineRestOperation({
|
|
164
|
+
id: "delete_signature_for_captive_recipients",
|
|
165
|
+
slug: "DOCUSIGN_DELETE_SIGNATURE_FOR_CAPTIVE_RECIPIENTS",
|
|
166
|
+
name: "Delete Signature For Captive Recipients",
|
|
167
|
+
description: "Delete signature images for captive recipients on an envelope.",
|
|
168
|
+
needsApproval: true,
|
|
169
|
+
method: "DELETE",
|
|
170
|
+
path: (ctx) => `/envelopes/${ctx.encode(String(ctx.input.envelopeId))}/recipients/${ctx.encode(String(ctx.input.recipientId))}/signature_image`,
|
|
171
|
+
input: z.object({
|
|
172
|
+
envelopeId: z.string().min(1),
|
|
173
|
+
recipientId: z.string().min(1)
|
|
174
|
+
}),
|
|
175
|
+
output: docusignSuccessSchema,
|
|
176
|
+
transformResponse: () => ({ success: true })
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
//#endregion
|
|
180
|
+
export { addOrUpdateUserSignature, addUserSignatureAndInitialsImages, deleteSignatureForCaptiveRecipients, deleteUserInitialsOrSignatureImage, removeUserSignatureInformation, retrieveUserInitialsImageForEnvelopes, retrieveUserSignatureDefinitions, retrieveUserSignatureImage, retrieveUserSignatureInformation, setInitialsImageForAccountlessSigner, setSignatureImageForNoAccountSigner, setUserSignatureImage, updateUserSignatureById };
|
package/dist/users.d.mts
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import * as _keystrokehq_core0 from "@keystrokehq/core";
|
|
3
|
+
import * as _keystrokehq_core_credential_set0 from "@keystrokehq/core/credential-set";
|
|
4
|
+
|
|
5
|
+
//#region src/users.d.ts
|
|
6
|
+
declare const listUsersForAccount: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
7
|
+
startPosition: z.ZodOptional<z.ZodNumber>;
|
|
8
|
+
count: z.ZodOptional<z.ZodNumber>;
|
|
9
|
+
additionalInfo: z.ZodOptional<z.ZodBoolean>;
|
|
10
|
+
email: z.ZodOptional<z.ZodString>;
|
|
11
|
+
emailSubstring: z.ZodOptional<z.ZodString>;
|
|
12
|
+
groupId: z.ZodOptional<z.ZodString>;
|
|
13
|
+
status: z.ZodOptional<z.ZodString>;
|
|
14
|
+
userNameSubstring: z.ZodOptional<z.ZodString>;
|
|
15
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
16
|
+
resultSetSize: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
|
|
17
|
+
totalSetSize: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
|
|
18
|
+
startPosition: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
|
|
19
|
+
endPosition: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
|
|
20
|
+
nextUri: z.ZodOptional<z.ZodString>;
|
|
21
|
+
previousUri: z.ZodOptional<z.ZodString>;
|
|
22
|
+
users: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
23
|
+
userId: z.ZodOptional<z.ZodString>;
|
|
24
|
+
userName: z.ZodOptional<z.ZodString>;
|
|
25
|
+
email: z.ZodOptional<z.ZodString>;
|
|
26
|
+
userStatus: z.ZodOptional<z.ZodString>;
|
|
27
|
+
userType: z.ZodOptional<z.ZodString>;
|
|
28
|
+
firstName: z.ZodOptional<z.ZodString>;
|
|
29
|
+
lastName: z.ZodOptional<z.ZodString>;
|
|
30
|
+
}, z.core.$catchall<z.ZodUnknown>>>>;
|
|
31
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
32
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
33
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
34
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
35
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
36
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
37
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
38
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
39
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
40
|
+
declare const addNewUsersToASpecifiedAccount: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
41
|
+
newUsers: z.ZodArray<z.ZodObject<{
|
|
42
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
43
|
+
}, z.core.$catchall<z.ZodUnknown>>>;
|
|
44
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
45
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
46
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
47
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
48
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
49
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
50
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
51
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
52
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
53
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
54
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
55
|
+
declare const getUserInformationById: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
56
|
+
userId: z.ZodString;
|
|
57
|
+
additionalInfo: z.ZodOptional<z.ZodBoolean>;
|
|
58
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
59
|
+
userId: z.ZodOptional<z.ZodString>;
|
|
60
|
+
userName: z.ZodOptional<z.ZodString>;
|
|
61
|
+
email: z.ZodOptional<z.ZodString>;
|
|
62
|
+
userStatus: z.ZodOptional<z.ZodString>;
|
|
63
|
+
userType: z.ZodOptional<z.ZodString>;
|
|
64
|
+
firstName: z.ZodOptional<z.ZodString>;
|
|
65
|
+
lastName: z.ZodOptional<z.ZodString>;
|
|
66
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
67
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
68
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
69
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
70
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
71
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
72
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
73
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
74
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
75
|
+
declare const updateUserInformationForSpecifiedUser: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
76
|
+
userId: z.ZodString;
|
|
77
|
+
user: z.ZodObject<{
|
|
78
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
79
|
+
}, z.core.$catchall<z.ZodUnknown>>;
|
|
80
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
81
|
+
userId: z.ZodOptional<z.ZodString>;
|
|
82
|
+
userName: z.ZodOptional<z.ZodString>;
|
|
83
|
+
email: z.ZodOptional<z.ZodString>;
|
|
84
|
+
userStatus: z.ZodOptional<z.ZodString>;
|
|
85
|
+
userType: z.ZodOptional<z.ZodString>;
|
|
86
|
+
firstName: z.ZodOptional<z.ZodString>;
|
|
87
|
+
lastName: z.ZodOptional<z.ZodString>;
|
|
88
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
89
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
90
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
91
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
92
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
93
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
94
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
95
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
96
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
97
|
+
declare const changeUsersInAccount: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
98
|
+
users: z.ZodArray<z.ZodObject<{
|
|
99
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
100
|
+
}, z.core.$catchall<z.ZodUnknown>>>;
|
|
101
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
102
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
103
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
104
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
105
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
106
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
107
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
108
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
109
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
110
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
111
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
112
|
+
declare const closeUsersInAccount: _keystrokehq_core0.Operation<z.ZodObject<{
|
|
113
|
+
users: z.ZodArray<z.ZodObject<{
|
|
114
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
115
|
+
}, z.core.$catchall<z.ZodUnknown>>>;
|
|
116
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
117
|
+
[x: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
|
|
118
|
+
}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"docusign", z.ZodObject<{
|
|
119
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
120
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
121
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
122
|
+
}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
|
|
123
|
+
DOCUSIGN_ACCESS_TOKEN: z.ZodString;
|
|
124
|
+
DOCUSIGN_ACCOUNT_ID: z.ZodString;
|
|
125
|
+
DOCUSIGN_BASE_URI: z.ZodURL;
|
|
126
|
+
}, z.core.$strip>>[] | undefined>], undefined>;
|
|
127
|
+
//#endregion
|
|
128
|
+
export { addNewUsersToASpecifiedAccount, changeUsersInAccount, closeUsersInAccount, getUserInformationById, listUsersForAccount, updateUserInformationForSpecifiedUser };
|
package/dist/users.mjs
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { docusignGenericObjectSchema, docusignListPaginationInputSchema, docusignLooseObjectSchema, docusignUserListSchema, docusignUserSchema } from "./schemas/index.mjs";
|
|
2
|
+
import { r as defineRestOperation } from "./operation-helpers-BMTArRh9.mjs";
|
|
3
|
+
import { z } from "zod";
|
|
4
|
+
|
|
5
|
+
//#region src/users.ts
|
|
6
|
+
/**
|
|
7
|
+
* Account users. Covers PLAN.md § 6.22.
|
|
8
|
+
*/
|
|
9
|
+
const userId = z.object({ userId: z.string().min(1) });
|
|
10
|
+
const listUsersForAccount = defineRestOperation({
|
|
11
|
+
id: "list_users_for_account",
|
|
12
|
+
slug: "DOCUSIGN_LIST_USERS_FOR_ACCOUNT",
|
|
13
|
+
name: "List Users For Account",
|
|
14
|
+
description: "List users on the DocuSign account.",
|
|
15
|
+
method: "GET",
|
|
16
|
+
path: "/users",
|
|
17
|
+
input: docusignListPaginationInputSchema.extend({
|
|
18
|
+
additionalInfo: z.boolean().optional(),
|
|
19
|
+
email: z.string().optional(),
|
|
20
|
+
emailSubstring: z.string().optional(),
|
|
21
|
+
groupId: z.string().optional(),
|
|
22
|
+
status: z.string().optional(),
|
|
23
|
+
userNameSubstring: z.string().optional()
|
|
24
|
+
}),
|
|
25
|
+
output: docusignUserListSchema,
|
|
26
|
+
query: (input) => ({
|
|
27
|
+
start_position: input.startPosition,
|
|
28
|
+
count: input.count,
|
|
29
|
+
additional_info: input.additionalInfo,
|
|
30
|
+
email: input.email,
|
|
31
|
+
email_substring: input.emailSubstring,
|
|
32
|
+
group_id: input.groupId,
|
|
33
|
+
status: input.status,
|
|
34
|
+
user_name_substring: input.userNameSubstring
|
|
35
|
+
})
|
|
36
|
+
});
|
|
37
|
+
const addNewUsersToASpecifiedAccount = defineRestOperation({
|
|
38
|
+
id: "add_new_users_to_a_specified_account",
|
|
39
|
+
slug: "DOCUSIGN_ADD_NEW_USERS_TO_A_SPECIFIED_ACCOUNT",
|
|
40
|
+
name: "Add New Users",
|
|
41
|
+
description: "Invite new users to the account.",
|
|
42
|
+
needsApproval: true,
|
|
43
|
+
method: "POST",
|
|
44
|
+
path: "/users",
|
|
45
|
+
input: z.object({ newUsers: z.array(docusignLooseObjectSchema()).min(1) }),
|
|
46
|
+
output: docusignGenericObjectSchema,
|
|
47
|
+
body: (input) => ({ newUsers: input.newUsers })
|
|
48
|
+
});
|
|
49
|
+
const getUserInformationById = defineRestOperation({
|
|
50
|
+
id: "get_user_information_by_id",
|
|
51
|
+
slug: "DOCUSIGN_GET_USER_INFORMATION_BY_ID",
|
|
52
|
+
name: "Get User Information By Id",
|
|
53
|
+
description: "Retrieve a single user on the account.",
|
|
54
|
+
method: "GET",
|
|
55
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}`,
|
|
56
|
+
input: userId.extend({ additionalInfo: z.boolean().optional() }),
|
|
57
|
+
output: docusignUserSchema,
|
|
58
|
+
query: (input) => ({ additional_info: input.additionalInfo })
|
|
59
|
+
});
|
|
60
|
+
const updateUserInformationForSpecifiedUser = defineRestOperation({
|
|
61
|
+
id: "update_user_information_for_specified_user",
|
|
62
|
+
slug: "DOCUSIGN_UPDATE_USER_INFORMATION_FOR_SPECIFIED_USER",
|
|
63
|
+
name: "Update User Information",
|
|
64
|
+
description: "Update a single user on the account.",
|
|
65
|
+
needsApproval: true,
|
|
66
|
+
method: "PUT",
|
|
67
|
+
path: (ctx) => `/users/${ctx.encode(String(ctx.input.userId))}`,
|
|
68
|
+
input: userId.extend({ user: docusignLooseObjectSchema() }),
|
|
69
|
+
output: docusignUserSchema,
|
|
70
|
+
body: (input) => input.user
|
|
71
|
+
});
|
|
72
|
+
const changeUsersInAccount = defineRestOperation({
|
|
73
|
+
id: "change_users_in_account",
|
|
74
|
+
slug: "DOCUSIGN_CHANGE_USERS_IN_ACCOUNT",
|
|
75
|
+
name: "Change Users In Account",
|
|
76
|
+
description: "Batch update users on the account.",
|
|
77
|
+
needsApproval: true,
|
|
78
|
+
method: "PUT",
|
|
79
|
+
path: "/users",
|
|
80
|
+
input: z.object({ users: z.array(docusignLooseObjectSchema()).min(1) }),
|
|
81
|
+
output: docusignGenericObjectSchema,
|
|
82
|
+
body: (input) => ({ users: input.users })
|
|
83
|
+
});
|
|
84
|
+
const closeUsersInAccount = defineRestOperation({
|
|
85
|
+
id: "close_users_in_account",
|
|
86
|
+
slug: "DOCUSIGN_CLOSE_USERS_IN_ACCOUNT",
|
|
87
|
+
name: "Close Users In Account",
|
|
88
|
+
description: "Close (deactivate) users on the account.",
|
|
89
|
+
needsApproval: true,
|
|
90
|
+
method: "DELETE",
|
|
91
|
+
path: "/users",
|
|
92
|
+
input: z.object({ users: z.array(docusignLooseObjectSchema()).min(1) }),
|
|
93
|
+
output: docusignGenericObjectSchema,
|
|
94
|
+
body: (input) => ({ users: input.users })
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
//#endregion
|
|
98
|
+
export { addNewUsersToASpecifiedAccount, changeUsersInAccount, closeUsersInAccount, getUserInformationById, listUsersForAccount, updateUserInformationForSpecifiedUser };
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { WebhookRequest } from "@keystrokehq/core";
|
|
2
|
+
|
|
3
|
+
//#region src/verification.d.ts
|
|
4
|
+
interface VerifyDocusignConnectRequestInput {
|
|
5
|
+
readonly headers: Readonly<Record<string, string | undefined>>;
|
|
6
|
+
readonly rawBody: string;
|
|
7
|
+
readonly secrets: readonly string[];
|
|
8
|
+
}
|
|
9
|
+
declare function computeDocusignConnectSignature(secret: string, rawBody: string): string;
|
|
10
|
+
declare function verifyDocusignConnectRequest(input: VerifyDocusignConnectRequestInput): boolean;
|
|
11
|
+
/**
|
|
12
|
+
* Parse a JSON-format Connect envelope-publish payload. Throws on invalid
|
|
13
|
+
* JSON; callers should have already verified the HMAC signature.
|
|
14
|
+
*/
|
|
15
|
+
declare function parseDocusignConnectEvent(rawBody: string): unknown;
|
|
16
|
+
/** Narrow a `WebhookRequest` into the shape this module needs. */
|
|
17
|
+
declare function verifyDocusignConnectWebhookRequest(request: Pick<WebhookRequest, 'headers' | 'rawBody'>, secrets: readonly string[]): boolean;
|
|
18
|
+
//#endregion
|
|
19
|
+
export { VerifyDocusignConnectRequestInput, computeDocusignConnectSignature, parseDocusignConnectEvent, verifyDocusignConnectRequest, verifyDocusignConnectWebhookRequest };
|