@documenso/sdk-typescript 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (211) hide show
  1. package/FUNCTIONS.md +3 -1
  2. package/README.md +76 -69
  3. package/docs/sdks/directlink/README.md +7 -7
  4. package/docs/sdks/documensofields/README.md +184 -96
  5. package/docs/sdks/documensorecipients/README.md +162 -54
  6. package/docs/sdks/documents/README.md +26 -22
  7. package/docs/sdks/fields/README.md +491 -10
  8. package/docs/sdks/recipients/README.md +461 -10
  9. package/docs/sdks/templates/README.md +31 -17
  10. package/funcs/documentsDelete.d.ts +1 -1
  11. package/funcs/documentsDelete.d.ts.map +1 -1
  12. package/funcs/documentsDelete.js +1 -2
  13. package/funcs/documentsDelete.js.map +1 -1
  14. package/funcs/documentsFieldsDelete.d.ts +1 -1
  15. package/funcs/documentsFieldsDelete.d.ts.map +1 -1
  16. package/funcs/documentsFieldsDelete.js +1 -2
  17. package/funcs/documentsFieldsDelete.js.map +1 -1
  18. package/funcs/{fieldsGet.d.ts → documentsFieldsGet.d.ts} +4 -4
  19. package/funcs/documentsFieldsGet.d.ts.map +1 -0
  20. package/funcs/{recipientsGet.js → documentsFieldsGet.js} +10 -10
  21. package/funcs/documentsFieldsGet.js.map +1 -0
  22. package/funcs/documentsRecipientsDelete.d.ts +1 -1
  23. package/funcs/documentsRecipientsDelete.d.ts.map +1 -1
  24. package/funcs/documentsRecipientsDelete.js +1 -2
  25. package/funcs/documentsRecipientsDelete.js.map +1 -1
  26. package/funcs/{recipientsGet.d.ts → documentsRecipientsGet.d.ts} +4 -4
  27. package/funcs/documentsRecipientsGet.d.ts.map +1 -0
  28. package/funcs/documentsRecipientsGet.js +116 -0
  29. package/funcs/documentsRecipientsGet.js.map +1 -0
  30. package/funcs/documentsRedistribute.d.ts +1 -1
  31. package/funcs/documentsRedistribute.d.ts.map +1 -1
  32. package/funcs/documentsRedistribute.js +1 -2
  33. package/funcs/documentsRedistribute.js.map +1 -1
  34. package/funcs/templatesDelete.d.ts +1 -1
  35. package/funcs/templatesDelete.d.ts.map +1 -1
  36. package/funcs/templatesDelete.js +1 -2
  37. package/funcs/templatesDelete.js.map +1 -1
  38. package/funcs/templatesDirectLinkDelete.d.ts +1 -1
  39. package/funcs/templatesDirectLinkDelete.d.ts.map +1 -1
  40. package/funcs/templatesDirectLinkDelete.js +1 -2
  41. package/funcs/templatesDirectLinkDelete.js.map +1 -1
  42. package/funcs/templatesFieldsDelete.d.ts +1 -1
  43. package/funcs/templatesFieldsDelete.d.ts.map +1 -1
  44. package/funcs/templatesFieldsDelete.js +1 -2
  45. package/funcs/templatesFieldsDelete.js.map +1 -1
  46. package/funcs/templatesFieldsGet.d.ts +16 -0
  47. package/funcs/templatesFieldsGet.d.ts.map +1 -0
  48. package/funcs/{fieldsGet.js → templatesFieldsGet.js} +9 -9
  49. package/funcs/templatesFieldsGet.js.map +1 -0
  50. package/funcs/templatesRecipientsDelete.d.ts +1 -1
  51. package/funcs/templatesRecipientsDelete.d.ts.map +1 -1
  52. package/funcs/templatesRecipientsDelete.js +1 -2
  53. package/funcs/templatesRecipientsDelete.js.map +1 -1
  54. package/funcs/templatesRecipientsGet.d.ts +16 -0
  55. package/funcs/templatesRecipientsGet.d.ts.map +1 -0
  56. package/funcs/templatesRecipientsGet.js +116 -0
  57. package/funcs/templatesRecipientsGet.js.map +1 -0
  58. package/jsr.json +1 -1
  59. package/lib/config.d.ts +4 -4
  60. package/lib/config.d.ts.map +1 -1
  61. package/lib/config.js +4 -4
  62. package/lib/config.js.map +1 -1
  63. package/lib/schemas.d.ts +1 -1
  64. package/lib/schemas.d.ts.map +1 -1
  65. package/lib/schemas.js +4 -1
  66. package/lib/schemas.js.map +1 -1
  67. package/models/operations/documentdeletedocument.d.ts +28 -0
  68. package/models/operations/documentdeletedocument.d.ts.map +1 -1
  69. package/models/operations/documentdeletedocument.js +28 -1
  70. package/models/operations/documentdeletedocument.js.map +1 -1
  71. package/models/operations/documentresenddocument.d.ts +28 -0
  72. package/models/operations/documentresenddocument.d.ts.map +1 -1
  73. package/models/operations/documentresenddocument.js +28 -1
  74. package/models/operations/documentresenddocument.js.map +1 -1
  75. package/models/operations/fielddeletedocumentfield.d.ts +28 -0
  76. package/models/operations/fielddeletedocumentfield.d.ts.map +1 -1
  77. package/models/operations/fielddeletedocumentfield.js +28 -1
  78. package/models/operations/fielddeletedocumentfield.js.map +1 -1
  79. package/models/operations/fielddeletetemplatefield.d.ts +28 -0
  80. package/models/operations/fielddeletetemplatefield.d.ts.map +1 -1
  81. package/models/operations/fielddeletetemplatefield.js +28 -1
  82. package/models/operations/fielddeletetemplatefield.js.map +1 -1
  83. package/models/operations/{fieldgetfield.d.ts → fieldgetdocumentfield.d.ts} +142 -142
  84. package/models/operations/fieldgetdocumentfield.d.ts.map +1 -0
  85. package/models/operations/fieldgetdocumentfield.js +817 -0
  86. package/models/operations/fieldgetdocumentfield.js.map +1 -0
  87. package/models/operations/fieldgettemplatefield.d.ts +774 -0
  88. package/models/operations/fieldgettemplatefield.d.ts.map +1 -0
  89. package/models/operations/fieldgettemplatefield.js +819 -0
  90. package/models/operations/fieldgettemplatefield.js.map +1 -0
  91. package/models/operations/index.d.ts +4 -2
  92. package/models/operations/index.d.ts.map +1 -1
  93. package/models/operations/index.js +4 -2
  94. package/models/operations/index.js.map +1 -1
  95. package/models/operations/recipientdeletedocumentrecipient.d.ts +28 -0
  96. package/models/operations/recipientdeletedocumentrecipient.d.ts.map +1 -1
  97. package/models/operations/recipientdeletedocumentrecipient.js +28 -1
  98. package/models/operations/recipientdeletedocumentrecipient.js.map +1 -1
  99. package/models/operations/recipientdeletetemplaterecipient.d.ts +28 -0
  100. package/models/operations/recipientdeletetemplaterecipient.d.ts.map +1 -1
  101. package/models/operations/recipientdeletetemplaterecipient.js +28 -1
  102. package/models/operations/recipientdeletetemplaterecipient.js.map +1 -1
  103. package/models/operations/recipientgetdocumentrecipient.d.ts +1041 -0
  104. package/models/operations/recipientgetdocumentrecipient.d.ts.map +1 -0
  105. package/models/operations/recipientgetdocumentrecipient.js +1038 -0
  106. package/models/operations/recipientgetdocumentrecipient.js.map +1 -0
  107. package/models/operations/recipientgettemplaterecipient.d.ts +1041 -0
  108. package/models/operations/recipientgettemplaterecipient.d.ts.map +1 -0
  109. package/models/operations/recipientgettemplaterecipient.js +1039 -0
  110. package/models/operations/recipientgettemplaterecipient.js.map +1 -0
  111. package/models/operations/templatedeletetemplate.d.ts +28 -0
  112. package/models/operations/templatedeletetemplate.d.ts.map +1 -1
  113. package/models/operations/templatedeletetemplate.js +28 -1
  114. package/models/operations/templatedeletetemplate.js.map +1 -1
  115. package/models/operations/templatedeletetemplatedirectlink.d.ts +28 -0
  116. package/models/operations/templatedeletetemplatedirectlink.d.ts.map +1 -1
  117. package/models/operations/templatedeletetemplatedirectlink.js +28 -1
  118. package/models/operations/templatedeletetemplatedirectlink.js.map +1 -1
  119. package/package.json +5 -1
  120. package/sdk/directlink.d.ts +1 -1
  121. package/sdk/directlink.d.ts.map +1 -1
  122. package/sdk/documensofields.d.ts +21 -14
  123. package/sdk/documensofields.d.ts.map +1 -1
  124. package/sdk/documensofields.js +29 -19
  125. package/sdk/documensofields.js.map +1 -1
  126. package/sdk/documensorecipients.d.ts +21 -14
  127. package/sdk/documensorecipients.d.ts.map +1 -1
  128. package/sdk/documensorecipients.js +29 -19
  129. package/sdk/documensorecipients.js.map +1 -1
  130. package/sdk/documents.d.ts +6 -6
  131. package/sdk/documents.d.ts.map +1 -1
  132. package/sdk/documents.js +4 -4
  133. package/sdk/documents.js.map +1 -1
  134. package/sdk/fields.d.ts +35 -3
  135. package/sdk/fields.d.ts.map +1 -1
  136. package/sdk/fields.js +51 -4
  137. package/sdk/fields.js.map +1 -1
  138. package/sdk/recipients.d.ts +35 -3
  139. package/sdk/recipients.d.ts.map +1 -1
  140. package/sdk/recipients.js +51 -4
  141. package/sdk/recipients.js.map +1 -1
  142. package/sdk/sdk.d.ts +0 -6
  143. package/sdk/sdk.d.ts.map +1 -1
  144. package/sdk/sdk.js +0 -8
  145. package/sdk/sdk.js.map +1 -1
  146. package/sdk/templates.d.ts +5 -5
  147. package/sdk/templates.d.ts.map +1 -1
  148. package/sdk/templates.js +4 -4
  149. package/sdk/templates.js.map +1 -1
  150. package/src/funcs/documentsDelete.ts +3 -4
  151. package/src/funcs/documentsFieldsDelete.ts +3 -4
  152. package/src/funcs/{fieldsGet.ts → documentsFieldsGet.ts} +11 -10
  153. package/src/funcs/documentsRecipientsDelete.ts +6 -4
  154. package/src/funcs/{recipientsGet.ts → documentsRecipientsGet.ts} +15 -10
  155. package/src/funcs/documentsRedistribute.ts +3 -4
  156. package/src/funcs/templatesDelete.ts +3 -4
  157. package/src/funcs/templatesDirectLinkDelete.ts +6 -4
  158. package/src/funcs/templatesFieldsDelete.ts +3 -4
  159. package/src/funcs/templatesFieldsGet.ts +147 -0
  160. package/src/funcs/templatesRecipientsDelete.ts +6 -4
  161. package/src/funcs/templatesRecipientsGet.ts +152 -0
  162. package/src/lib/config.ts +4 -4
  163. package/src/lib/schemas.ts +5 -0
  164. package/src/models/operations/documentdeletedocument.ts +65 -0
  165. package/src/models/operations/documentresenddocument.ts +65 -0
  166. package/src/models/operations/fielddeletedocumentfield.ts +66 -0
  167. package/src/models/operations/fielddeletetemplatefield.ts +66 -0
  168. package/src/models/operations/{fieldgetfield.ts → fieldgetdocumentfield.ts} +337 -282
  169. package/src/models/operations/fieldgettemplatefield.ts +1697 -0
  170. package/src/models/operations/index.ts +4 -2
  171. package/src/models/operations/recipientdeletedocumentrecipient.ts +74 -0
  172. package/src/models/operations/recipientdeletetemplaterecipient.ts +74 -0
  173. package/src/models/operations/recipientgetdocumentrecipient.ts +2235 -0
  174. package/src/models/operations/recipientgettemplaterecipient.ts +2251 -0
  175. package/src/models/operations/templatedeletetemplate.ts +65 -0
  176. package/src/models/operations/templatedeletetemplatedirectlink.ts +74 -0
  177. package/src/sdk/directlink.ts +1 -1
  178. package/src/sdk/documensofields.ts +47 -29
  179. package/src/sdk/documensorecipients.ts +47 -29
  180. package/src/sdk/documents.ts +10 -10
  181. package/src/sdk/fields.ts +93 -6
  182. package/src/sdk/recipients.ts +93 -6
  183. package/src/sdk/sdk.ts +0 -12
  184. package/src/sdk/templates.ts +9 -11
  185. package/.devcontainer/README.md +0 -30
  186. package/.devcontainer/devcontainer.json +0 -45
  187. package/docs/sdks/documensotemplatesfields/README.md +0 -456
  188. package/docs/sdks/documensotemplatesrecipients/README.md +0 -440
  189. package/funcs/fieldsGet.d.ts.map +0 -1
  190. package/funcs/fieldsGet.js.map +0 -1
  191. package/funcs/recipientsGet.d.ts.map +0 -1
  192. package/funcs/recipientsGet.js.map +0 -1
  193. package/local-openapi.json +0 -21024
  194. package/models/operations/fieldgetfield.d.ts.map +0 -1
  195. package/models/operations/fieldgetfield.js +0 -820
  196. package/models/operations/fieldgetfield.js.map +0 -1
  197. package/models/operations/recipientgetrecipient.d.ts +0 -1041
  198. package/models/operations/recipientgetrecipient.d.ts.map +0 -1
  199. package/models/operations/recipientgetrecipient.js +0 -1033
  200. package/models/operations/recipientgetrecipient.js.map +0 -1
  201. package/sdk/documensotemplatesfields.d.ts +0 -37
  202. package/sdk/documensotemplatesfields.d.ts.map +0 -1
  203. package/sdk/documensotemplatesfields.js +0 -59
  204. package/sdk/documensotemplatesfields.js.map +0 -1
  205. package/sdk/documensotemplatesrecipients.d.ts +0 -37
  206. package/sdk/documensotemplatesrecipients.d.ts.map +0 -1
  207. package/sdk/documensotemplatesrecipients.js +0 -59
  208. package/sdk/documensotemplatesrecipients.js.map +0 -1
  209. package/src/models/operations/recipientgetrecipient.ts +0 -2060
  210. package/src/sdk/documensotemplatesfields.ts +0 -96
  211. package/src/sdk/documensotemplatesrecipients.ts +0 -96
@@ -11,6 +11,13 @@ export type TemplateDeleteTemplateRequestBody = {
11
11
  templateId: number;
12
12
  };
13
13
 
14
+ /**
15
+ * Successful response
16
+ */
17
+ export type TemplateDeleteTemplateResponseBody = {
18
+ success: boolean;
19
+ };
20
+
14
21
  /** @internal */
15
22
  export const TemplateDeleteTemplateRequestBody$inboundSchema: z.ZodType<
16
23
  TemplateDeleteTemplateRequestBody,
@@ -67,3 +74,61 @@ export function templateDeleteTemplateRequestBodyFromJSON(
67
74
  `Failed to parse 'TemplateDeleteTemplateRequestBody' from JSON`,
68
75
  );
69
76
  }
77
+
78
+ /** @internal */
79
+ export const TemplateDeleteTemplateResponseBody$inboundSchema: z.ZodType<
80
+ TemplateDeleteTemplateResponseBody,
81
+ z.ZodTypeDef,
82
+ unknown
83
+ > = z.object({
84
+ success: z.boolean(),
85
+ });
86
+
87
+ /** @internal */
88
+ export type TemplateDeleteTemplateResponseBody$Outbound = {
89
+ success: boolean;
90
+ };
91
+
92
+ /** @internal */
93
+ export const TemplateDeleteTemplateResponseBody$outboundSchema: z.ZodType<
94
+ TemplateDeleteTemplateResponseBody$Outbound,
95
+ z.ZodTypeDef,
96
+ TemplateDeleteTemplateResponseBody
97
+ > = z.object({
98
+ success: z.boolean(),
99
+ });
100
+
101
+ /**
102
+ * @internal
103
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
104
+ */
105
+ export namespace TemplateDeleteTemplateResponseBody$ {
106
+ /** @deprecated use `TemplateDeleteTemplateResponseBody$inboundSchema` instead. */
107
+ export const inboundSchema = TemplateDeleteTemplateResponseBody$inboundSchema;
108
+ /** @deprecated use `TemplateDeleteTemplateResponseBody$outboundSchema` instead. */
109
+ export const outboundSchema =
110
+ TemplateDeleteTemplateResponseBody$outboundSchema;
111
+ /** @deprecated use `TemplateDeleteTemplateResponseBody$Outbound` instead. */
112
+ export type Outbound = TemplateDeleteTemplateResponseBody$Outbound;
113
+ }
114
+
115
+ export function templateDeleteTemplateResponseBodyToJSON(
116
+ templateDeleteTemplateResponseBody: TemplateDeleteTemplateResponseBody,
117
+ ): string {
118
+ return JSON.stringify(
119
+ TemplateDeleteTemplateResponseBody$outboundSchema.parse(
120
+ templateDeleteTemplateResponseBody,
121
+ ),
122
+ );
123
+ }
124
+
125
+ export function templateDeleteTemplateResponseBodyFromJSON(
126
+ jsonString: string,
127
+ ): SafeParseResult<TemplateDeleteTemplateResponseBody, SDKValidationError> {
128
+ return safeParse(
129
+ jsonString,
130
+ (x) =>
131
+ TemplateDeleteTemplateResponseBody$inboundSchema.parse(JSON.parse(x)),
132
+ `Failed to parse 'TemplateDeleteTemplateResponseBody' from JSON`,
133
+ );
134
+ }
@@ -11,6 +11,13 @@ export type TemplateDeleteTemplateDirectLinkRequestBody = {
11
11
  templateId: number;
12
12
  };
13
13
 
14
+ /**
15
+ * Successful response
16
+ */
17
+ export type TemplateDeleteTemplateDirectLinkResponseBody = {
18
+ success: boolean;
19
+ };
20
+
14
21
  /** @internal */
15
22
  export const TemplateDeleteTemplateDirectLinkRequestBody$inboundSchema:
16
23
  z.ZodType<
@@ -77,3 +84,70 @@ export function templateDeleteTemplateDirectLinkRequestBodyFromJSON(
77
84
  `Failed to parse 'TemplateDeleteTemplateDirectLinkRequestBody' from JSON`,
78
85
  );
79
86
  }
87
+
88
+ /** @internal */
89
+ export const TemplateDeleteTemplateDirectLinkResponseBody$inboundSchema:
90
+ z.ZodType<
91
+ TemplateDeleteTemplateDirectLinkResponseBody,
92
+ z.ZodTypeDef,
93
+ unknown
94
+ > = z.object({
95
+ success: z.boolean(),
96
+ });
97
+
98
+ /** @internal */
99
+ export type TemplateDeleteTemplateDirectLinkResponseBody$Outbound = {
100
+ success: boolean;
101
+ };
102
+
103
+ /** @internal */
104
+ export const TemplateDeleteTemplateDirectLinkResponseBody$outboundSchema:
105
+ z.ZodType<
106
+ TemplateDeleteTemplateDirectLinkResponseBody$Outbound,
107
+ z.ZodTypeDef,
108
+ TemplateDeleteTemplateDirectLinkResponseBody
109
+ > = z.object({
110
+ success: z.boolean(),
111
+ });
112
+
113
+ /**
114
+ * @internal
115
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
116
+ */
117
+ export namespace TemplateDeleteTemplateDirectLinkResponseBody$ {
118
+ /** @deprecated use `TemplateDeleteTemplateDirectLinkResponseBody$inboundSchema` instead. */
119
+ export const inboundSchema =
120
+ TemplateDeleteTemplateDirectLinkResponseBody$inboundSchema;
121
+ /** @deprecated use `TemplateDeleteTemplateDirectLinkResponseBody$outboundSchema` instead. */
122
+ export const outboundSchema =
123
+ TemplateDeleteTemplateDirectLinkResponseBody$outboundSchema;
124
+ /** @deprecated use `TemplateDeleteTemplateDirectLinkResponseBody$Outbound` instead. */
125
+ export type Outbound = TemplateDeleteTemplateDirectLinkResponseBody$Outbound;
126
+ }
127
+
128
+ export function templateDeleteTemplateDirectLinkResponseBodyToJSON(
129
+ templateDeleteTemplateDirectLinkResponseBody:
130
+ TemplateDeleteTemplateDirectLinkResponseBody,
131
+ ): string {
132
+ return JSON.stringify(
133
+ TemplateDeleteTemplateDirectLinkResponseBody$outboundSchema.parse(
134
+ templateDeleteTemplateDirectLinkResponseBody,
135
+ ),
136
+ );
137
+ }
138
+
139
+ export function templateDeleteTemplateDirectLinkResponseBodyFromJSON(
140
+ jsonString: string,
141
+ ): SafeParseResult<
142
+ TemplateDeleteTemplateDirectLinkResponseBody,
143
+ SDKValidationError
144
+ > {
145
+ return safeParse(
146
+ jsonString,
147
+ (x) =>
148
+ TemplateDeleteTemplateDirectLinkResponseBody$inboundSchema.parse(
149
+ JSON.parse(x),
150
+ ),
151
+ `Failed to parse 'TemplateDeleteTemplateDirectLinkResponseBody' from JSON`,
152
+ );
153
+ }
@@ -36,7 +36,7 @@ export class DirectLink extends ClientSDK {
36
36
  async delete(
37
37
  request: operations.TemplateDeleteTemplateDirectLinkRequestBody,
38
38
  options?: RequestOptions,
39
- ): Promise<any> {
39
+ ): Promise<operations.TemplateDeleteTemplateDirectLinkResponseBody> {
40
40
  return unwrapAsync(templatesDirectLinkDelete(
41
41
  this,
42
42
  request,
@@ -2,27 +2,28 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
- import { documentsFieldsCreate } from "../funcs/documentsFieldsCreate.js";
6
- import { documentsFieldsCreateMany } from "../funcs/documentsFieldsCreateMany.js";
7
- import { documentsFieldsDelete } from "../funcs/documentsFieldsDelete.js";
8
- import { documentsFieldsUpdate } from "../funcs/documentsFieldsUpdate.js";
9
- import { documentsFieldsUpdateMany } from "../funcs/documentsFieldsUpdateMany.js";
5
+ import { templatesFieldsCreate } from "../funcs/templatesFieldsCreate.js";
6
+ import { templatesFieldsCreateMany } from "../funcs/templatesFieldsCreateMany.js";
7
+ import { templatesFieldsDelete } from "../funcs/templatesFieldsDelete.js";
8
+ import { templatesFieldsGet } from "../funcs/templatesFieldsGet.js";
9
+ import { templatesFieldsUpdate } from "../funcs/templatesFieldsUpdate.js";
10
+ import { templatesFieldsUpdateMany } from "../funcs/templatesFieldsUpdateMany.js";
10
11
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
11
12
  import * as operations from "../models/operations/index.js";
12
13
  import { unwrapAsync } from "../types/fp.js";
13
14
 
14
15
  export class DocumensoFields extends ClientSDK {
15
16
  /**
16
- * Create document field
17
+ * Create template field
17
18
  *
18
19
  * @remarks
19
- * Create a single field for a document.
20
+ * Create a single field for a template.
20
21
  */
21
22
  async create(
22
- request: operations.FieldCreateDocumentFieldRequestBody,
23
+ request: operations.FieldCreateTemplateFieldRequestBody,
23
24
  options?: RequestOptions,
24
- ): Promise<operations.FieldCreateDocumentFieldResponseBody> {
25
- return unwrapAsync(documentsFieldsCreate(
25
+ ): Promise<operations.FieldCreateTemplateFieldResponseBody> {
26
+ return unwrapAsync(templatesFieldsCreate(
26
27
  this,
27
28
  request,
28
29
  options,
@@ -30,16 +31,33 @@ export class DocumensoFields extends ClientSDK {
30
31
  }
31
32
 
32
33
  /**
33
- * Create document fields
34
+ * Get template field
34
35
  *
35
36
  * @remarks
36
- * Create multiple fields for a document.
37
+ * Returns a single field. If you want to retrieve all the fields for a template, use the "Get Template" endpoint.
38
+ */
39
+ async get(
40
+ request: operations.FieldGetTemplateFieldRequest,
41
+ options?: RequestOptions,
42
+ ): Promise<operations.FieldGetTemplateFieldResponseBody> {
43
+ return unwrapAsync(templatesFieldsGet(
44
+ this,
45
+ request,
46
+ options,
47
+ ));
48
+ }
49
+
50
+ /**
51
+ * Create template fields
52
+ *
53
+ * @remarks
54
+ * Create multiple fields for a template.
37
55
  */
38
56
  async createMany(
39
- request: operations.FieldCreateDocumentFieldsRequestBody,
57
+ request: operations.FieldCreateTemplateFieldsRequestBody,
40
58
  options?: RequestOptions,
41
- ): Promise<operations.FieldCreateDocumentFieldsResponseBody> {
42
- return unwrapAsync(documentsFieldsCreateMany(
59
+ ): Promise<operations.FieldCreateTemplateFieldsResponseBody> {
60
+ return unwrapAsync(templatesFieldsCreateMany(
43
61
  this,
44
62
  request,
45
63
  options,
@@ -47,16 +65,16 @@ export class DocumensoFields extends ClientSDK {
47
65
  }
48
66
 
49
67
  /**
50
- * Update document field
68
+ * Update template field
51
69
  *
52
70
  * @remarks
53
- * Update a single field for a document.
71
+ * Update a single field for a template.
54
72
  */
55
73
  async update(
56
- request: operations.FieldUpdateDocumentFieldRequestBody,
74
+ request: operations.FieldUpdateTemplateFieldRequestBody,
57
75
  options?: RequestOptions,
58
- ): Promise<operations.FieldUpdateDocumentFieldResponseBody> {
59
- return unwrapAsync(documentsFieldsUpdate(
76
+ ): Promise<operations.FieldUpdateTemplateFieldResponseBody> {
77
+ return unwrapAsync(templatesFieldsUpdate(
60
78
  this,
61
79
  request,
62
80
  options,
@@ -64,16 +82,16 @@ export class DocumensoFields extends ClientSDK {
64
82
  }
65
83
 
66
84
  /**
67
- * Update document fields
85
+ * Update template fields
68
86
  *
69
87
  * @remarks
70
- * Update multiple fields for a document.
88
+ * Update multiple fields for a template.
71
89
  */
72
90
  async updateMany(
73
- request: operations.FieldUpdateDocumentFieldsRequestBody,
91
+ request: operations.FieldUpdateTemplateFieldsRequestBody,
74
92
  options?: RequestOptions,
75
- ): Promise<operations.FieldUpdateDocumentFieldsResponseBody> {
76
- return unwrapAsync(documentsFieldsUpdateMany(
93
+ ): Promise<operations.FieldUpdateTemplateFieldsResponseBody> {
94
+ return unwrapAsync(templatesFieldsUpdateMany(
77
95
  this,
78
96
  request,
79
97
  options,
@@ -81,13 +99,13 @@ export class DocumensoFields extends ClientSDK {
81
99
  }
82
100
 
83
101
  /**
84
- * Delete document field
102
+ * Delete template field
85
103
  */
86
104
  async delete(
87
- request: operations.FieldDeleteDocumentFieldRequestBody,
105
+ request: operations.FieldDeleteTemplateFieldRequestBody,
88
106
  options?: RequestOptions,
89
- ): Promise<any> {
90
- return unwrapAsync(documentsFieldsDelete(
107
+ ): Promise<operations.FieldDeleteTemplateFieldResponseBody> {
108
+ return unwrapAsync(templatesFieldsDelete(
91
109
  this,
92
110
  request,
93
111
  options,
@@ -2,27 +2,45 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
- import { documentsRecipientsCreate } from "../funcs/documentsRecipientsCreate.js";
6
- import { documentsRecipientsCreateMany } from "../funcs/documentsRecipientsCreateMany.js";
7
- import { documentsRecipientsDelete } from "../funcs/documentsRecipientsDelete.js";
8
- import { documentsRecipientsUpdate } from "../funcs/documentsRecipientsUpdate.js";
9
- import { documentsRecipientsUpdateMany } from "../funcs/documentsRecipientsUpdateMany.js";
5
+ import { templatesRecipientsCreate } from "../funcs/templatesRecipientsCreate.js";
6
+ import { templatesRecipientsCreateMany } from "../funcs/templatesRecipientsCreateMany.js";
7
+ import { templatesRecipientsDelete } from "../funcs/templatesRecipientsDelete.js";
8
+ import { templatesRecipientsGet } from "../funcs/templatesRecipientsGet.js";
9
+ import { templatesRecipientsUpdate } from "../funcs/templatesRecipientsUpdate.js";
10
+ import { templatesRecipientsUpdateMany } from "../funcs/templatesRecipientsUpdateMany.js";
10
11
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
11
12
  import * as operations from "../models/operations/index.js";
12
13
  import { unwrapAsync } from "../types/fp.js";
13
14
 
14
15
  export class DocumensoRecipients extends ClientSDK {
15
16
  /**
16
- * Create document recipient
17
+ * Get template recipient
17
18
  *
18
19
  * @remarks
19
- * Create a single recipient for a document.
20
+ * Returns a single recipient. If you want to retrieve all the recipients for a template, use the "Get Template" endpoint.
21
+ */
22
+ async get(
23
+ request: operations.RecipientGetTemplateRecipientRequest,
24
+ options?: RequestOptions,
25
+ ): Promise<operations.RecipientGetTemplateRecipientResponseBody> {
26
+ return unwrapAsync(templatesRecipientsGet(
27
+ this,
28
+ request,
29
+ options,
30
+ ));
31
+ }
32
+
33
+ /**
34
+ * Create template recipient
35
+ *
36
+ * @remarks
37
+ * Create a single recipient for a template.
20
38
  */
21
39
  async create(
22
- request: operations.RecipientCreateDocumentRecipientRequestBody,
40
+ request: operations.RecipientCreateTemplateRecipientRequestBody,
23
41
  options?: RequestOptions,
24
- ): Promise<operations.RecipientCreateDocumentRecipientResponseBody> {
25
- return unwrapAsync(documentsRecipientsCreate(
42
+ ): Promise<operations.RecipientCreateTemplateRecipientResponseBody> {
43
+ return unwrapAsync(templatesRecipientsCreate(
26
44
  this,
27
45
  request,
28
46
  options,
@@ -30,16 +48,16 @@ export class DocumensoRecipients extends ClientSDK {
30
48
  }
31
49
 
32
50
  /**
33
- * Create document recipients
51
+ * Create template recipients
34
52
  *
35
53
  * @remarks
36
- * Create multiple recipients for a document.
54
+ * Create multiple recipients for a template.
37
55
  */
38
56
  async createMany(
39
- request: operations.RecipientCreateDocumentRecipientsRequestBody,
57
+ request: operations.RecipientCreateTemplateRecipientsRequestBody,
40
58
  options?: RequestOptions,
41
- ): Promise<operations.RecipientCreateDocumentRecipientsResponseBody> {
42
- return unwrapAsync(documentsRecipientsCreateMany(
59
+ ): Promise<operations.RecipientCreateTemplateRecipientsResponseBody> {
60
+ return unwrapAsync(templatesRecipientsCreateMany(
43
61
  this,
44
62
  request,
45
63
  options,
@@ -47,16 +65,16 @@ export class DocumensoRecipients extends ClientSDK {
47
65
  }
48
66
 
49
67
  /**
50
- * Update document recipient
68
+ * Update template recipient
51
69
  *
52
70
  * @remarks
53
- * Update a single recipient for a document.
71
+ * Update a single recipient for a template.
54
72
  */
55
73
  async update(
56
- request: operations.RecipientUpdateDocumentRecipientRequestBody,
74
+ request: operations.RecipientUpdateTemplateRecipientRequestBody,
57
75
  options?: RequestOptions,
58
- ): Promise<operations.RecipientUpdateDocumentRecipientResponseBody> {
59
- return unwrapAsync(documentsRecipientsUpdate(
76
+ ): Promise<operations.RecipientUpdateTemplateRecipientResponseBody> {
77
+ return unwrapAsync(templatesRecipientsUpdate(
60
78
  this,
61
79
  request,
62
80
  options,
@@ -64,16 +82,16 @@ export class DocumensoRecipients extends ClientSDK {
64
82
  }
65
83
 
66
84
  /**
67
- * Update document recipients
85
+ * Update template recipients
68
86
  *
69
87
  * @remarks
70
- * Update multiple recipients for a document.
88
+ * Update multiple recipients for a template.
71
89
  */
72
90
  async updateMany(
73
- request: operations.RecipientUpdateDocumentRecipientsRequestBody,
91
+ request: operations.RecipientUpdateTemplateRecipientsRequestBody,
74
92
  options?: RequestOptions,
75
- ): Promise<operations.RecipientUpdateDocumentRecipientsResponseBody> {
76
- return unwrapAsync(documentsRecipientsUpdateMany(
93
+ ): Promise<operations.RecipientUpdateTemplateRecipientsResponseBody> {
94
+ return unwrapAsync(templatesRecipientsUpdateMany(
77
95
  this,
78
96
  request,
79
97
  options,
@@ -81,13 +99,13 @@ export class DocumensoRecipients extends ClientSDK {
81
99
  }
82
100
 
83
101
  /**
84
- * Delete document recipient
102
+ * Delete template recipient
85
103
  */
86
104
  async delete(
87
- request: operations.RecipientDeleteDocumentRecipientRequestBody,
105
+ request: operations.RecipientDeleteTemplateRecipientRequestBody,
88
106
  options?: RequestOptions,
89
- ): Promise<any> {
90
- return unwrapAsync(documentsRecipientsDelete(
107
+ ): Promise<operations.RecipientDeleteTemplateRecipientResponseBody> {
108
+ return unwrapAsync(templatesRecipientsDelete(
91
109
  this,
92
110
  request,
93
111
  options,
@@ -14,18 +14,18 @@ import { documentsUpdate } from "../funcs/documentsUpdate.js";
14
14
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
15
15
  import * as operations from "../models/operations/index.js";
16
16
  import { unwrapAsync } from "../types/fp.js";
17
- import { DocumensoFields } from "./documensofields.js";
18
- import { DocumensoRecipients } from "./documensorecipients.js";
17
+ import { Fields } from "./fields.js";
18
+ import { Recipients } from "./recipients.js";
19
19
 
20
20
  export class Documents extends ClientSDK {
21
- private _fields?: DocumensoFields;
22
- get fields(): DocumensoFields {
23
- return (this._fields ??= new DocumensoFields(this._options));
21
+ private _fields?: Fields;
22
+ get fields(): Fields {
23
+ return (this._fields ??= new Fields(this._options));
24
24
  }
25
25
 
26
- private _recipients?: DocumensoRecipients;
27
- get recipients(): DocumensoRecipients {
28
- return (this._recipients ??= new DocumensoRecipients(this._options));
26
+ private _recipients?: Recipients;
27
+ get recipients(): Recipients {
28
+ return (this._recipients ??= new Recipients(this._options));
29
29
  }
30
30
 
31
31
  /**
@@ -99,7 +99,7 @@ export class Documents extends ClientSDK {
99
99
  async delete(
100
100
  request: operations.DocumentDeleteDocumentRequestBody,
101
101
  options?: RequestOptions,
102
- ): Promise<any> {
102
+ ): Promise<operations.DocumentDeleteDocumentResponseBody> {
103
103
  return unwrapAsync(documentsDelete(
104
104
  this,
105
105
  request,
@@ -150,7 +150,7 @@ export class Documents extends ClientSDK {
150
150
  async redistribute(
151
151
  request: operations.DocumentResendDocumentRequestBody,
152
152
  options?: RequestOptions,
153
- ): Promise<any> {
153
+ ): Promise<operations.DocumentResendDocumentResponseBody> {
154
154
  return unwrapAsync(documentsRedistribute(
155
155
  this,
156
156
  request,
package/src/sdk/fields.ts CHANGED
@@ -2,23 +2,110 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
- import { fieldsGet } from "../funcs/fieldsGet.js";
5
+ import { documentsFieldsCreate } from "../funcs/documentsFieldsCreate.js";
6
+ import { documentsFieldsCreateMany } from "../funcs/documentsFieldsCreateMany.js";
7
+ import { documentsFieldsDelete } from "../funcs/documentsFieldsDelete.js";
8
+ import { documentsFieldsGet } from "../funcs/documentsFieldsGet.js";
9
+ import { documentsFieldsUpdate } from "../funcs/documentsFieldsUpdate.js";
10
+ import { documentsFieldsUpdateMany } from "../funcs/documentsFieldsUpdateMany.js";
6
11
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
7
12
  import * as operations from "../models/operations/index.js";
8
13
  import { unwrapAsync } from "../types/fp.js";
9
14
 
10
15
  export class Fields extends ClientSDK {
11
16
  /**
12
- * Get field
17
+ * Get document field
13
18
  *
14
19
  * @remarks
15
- * Returns a single field. If you want to retrieve all the fields for a document or template, use the "Get Document" or "Get Template" request.
20
+ * Returns a single field. If you want to retrieve all the fields for a document, use the "Get Document" endpoint.
16
21
  */
17
22
  async get(
18
- request: operations.FieldGetFieldRequest,
23
+ request: operations.FieldGetDocumentFieldRequest,
19
24
  options?: RequestOptions,
20
- ): Promise<operations.FieldGetFieldResponseBody> {
21
- return unwrapAsync(fieldsGet(
25
+ ): Promise<operations.FieldGetDocumentFieldResponseBody> {
26
+ return unwrapAsync(documentsFieldsGet(
27
+ this,
28
+ request,
29
+ options,
30
+ ));
31
+ }
32
+
33
+ /**
34
+ * Create document field
35
+ *
36
+ * @remarks
37
+ * Create a single field for a document.
38
+ */
39
+ async create(
40
+ request: operations.FieldCreateDocumentFieldRequestBody,
41
+ options?: RequestOptions,
42
+ ): Promise<operations.FieldCreateDocumentFieldResponseBody> {
43
+ return unwrapAsync(documentsFieldsCreate(
44
+ this,
45
+ request,
46
+ options,
47
+ ));
48
+ }
49
+
50
+ /**
51
+ * Create document fields
52
+ *
53
+ * @remarks
54
+ * Create multiple fields for a document.
55
+ */
56
+ async createMany(
57
+ request: operations.FieldCreateDocumentFieldsRequestBody,
58
+ options?: RequestOptions,
59
+ ): Promise<operations.FieldCreateDocumentFieldsResponseBody> {
60
+ return unwrapAsync(documentsFieldsCreateMany(
61
+ this,
62
+ request,
63
+ options,
64
+ ));
65
+ }
66
+
67
+ /**
68
+ * Update document field
69
+ *
70
+ * @remarks
71
+ * Update a single field for a document.
72
+ */
73
+ async update(
74
+ request: operations.FieldUpdateDocumentFieldRequestBody,
75
+ options?: RequestOptions,
76
+ ): Promise<operations.FieldUpdateDocumentFieldResponseBody> {
77
+ return unwrapAsync(documentsFieldsUpdate(
78
+ this,
79
+ request,
80
+ options,
81
+ ));
82
+ }
83
+
84
+ /**
85
+ * Update document fields
86
+ *
87
+ * @remarks
88
+ * Update multiple fields for a document.
89
+ */
90
+ async updateMany(
91
+ request: operations.FieldUpdateDocumentFieldsRequestBody,
92
+ options?: RequestOptions,
93
+ ): Promise<operations.FieldUpdateDocumentFieldsResponseBody> {
94
+ return unwrapAsync(documentsFieldsUpdateMany(
95
+ this,
96
+ request,
97
+ options,
98
+ ));
99
+ }
100
+
101
+ /**
102
+ * Delete document field
103
+ */
104
+ async delete(
105
+ request: operations.FieldDeleteDocumentFieldRequestBody,
106
+ options?: RequestOptions,
107
+ ): Promise<operations.FieldDeleteDocumentFieldResponseBody> {
108
+ return unwrapAsync(documentsFieldsDelete(
22
109
  this,
23
110
  request,
24
111
  options,