@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
@@ -17,7 +17,8 @@ export * from "./fieldcreatetemplatefield.js";
17
17
  export * from "./fieldcreatetemplatefields.js";
18
18
  export * from "./fielddeletedocumentfield.js";
19
19
  export * from "./fielddeletetemplatefield.js";
20
- export * from "./fieldgetfield.js";
20
+ export * from "./fieldgetdocumentfield.js";
21
+ export * from "./fieldgettemplatefield.js";
21
22
  export * from "./fieldupdatedocumentfield.js";
22
23
  export * from "./fieldupdatedocumentfields.js";
23
24
  export * from "./fieldupdatetemplatefield.js";
@@ -28,7 +29,8 @@ export * from "./recipientcreatetemplaterecipient.js";
28
29
  export * from "./recipientcreatetemplaterecipients.js";
29
30
  export * from "./recipientdeletedocumentrecipient.js";
30
31
  export * from "./recipientdeletetemplaterecipient.js";
31
- export * from "./recipientgetrecipient.js";
32
+ export * from "./recipientgetdocumentrecipient.js";
33
+ export * from "./recipientgettemplaterecipient.js";
32
34
  export * from "./recipientupdatedocumentrecipient.js";
33
35
  export * from "./recipientupdatedocumentrecipients.js";
34
36
  export * from "./recipientupdatetemplaterecipient.js";
@@ -11,6 +11,13 @@ export type RecipientDeleteDocumentRecipientRequestBody = {
11
11
  recipientId: number;
12
12
  };
13
13
 
14
+ /**
15
+ * Successful response
16
+ */
17
+ export type RecipientDeleteDocumentRecipientResponseBody = {
18
+ success: boolean;
19
+ };
20
+
14
21
  /** @internal */
15
22
  export const RecipientDeleteDocumentRecipientRequestBody$inboundSchema:
16
23
  z.ZodType<
@@ -77,3 +84,70 @@ export function recipientDeleteDocumentRecipientRequestBodyFromJSON(
77
84
  `Failed to parse 'RecipientDeleteDocumentRecipientRequestBody' from JSON`,
78
85
  );
79
86
  }
87
+
88
+ /** @internal */
89
+ export const RecipientDeleteDocumentRecipientResponseBody$inboundSchema:
90
+ z.ZodType<
91
+ RecipientDeleteDocumentRecipientResponseBody,
92
+ z.ZodTypeDef,
93
+ unknown
94
+ > = z.object({
95
+ success: z.boolean(),
96
+ });
97
+
98
+ /** @internal */
99
+ export type RecipientDeleteDocumentRecipientResponseBody$Outbound = {
100
+ success: boolean;
101
+ };
102
+
103
+ /** @internal */
104
+ export const RecipientDeleteDocumentRecipientResponseBody$outboundSchema:
105
+ z.ZodType<
106
+ RecipientDeleteDocumentRecipientResponseBody$Outbound,
107
+ z.ZodTypeDef,
108
+ RecipientDeleteDocumentRecipientResponseBody
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 RecipientDeleteDocumentRecipientResponseBody$ {
118
+ /** @deprecated use `RecipientDeleteDocumentRecipientResponseBody$inboundSchema` instead. */
119
+ export const inboundSchema =
120
+ RecipientDeleteDocumentRecipientResponseBody$inboundSchema;
121
+ /** @deprecated use `RecipientDeleteDocumentRecipientResponseBody$outboundSchema` instead. */
122
+ export const outboundSchema =
123
+ RecipientDeleteDocumentRecipientResponseBody$outboundSchema;
124
+ /** @deprecated use `RecipientDeleteDocumentRecipientResponseBody$Outbound` instead. */
125
+ export type Outbound = RecipientDeleteDocumentRecipientResponseBody$Outbound;
126
+ }
127
+
128
+ export function recipientDeleteDocumentRecipientResponseBodyToJSON(
129
+ recipientDeleteDocumentRecipientResponseBody:
130
+ RecipientDeleteDocumentRecipientResponseBody,
131
+ ): string {
132
+ return JSON.stringify(
133
+ RecipientDeleteDocumentRecipientResponseBody$outboundSchema.parse(
134
+ recipientDeleteDocumentRecipientResponseBody,
135
+ ),
136
+ );
137
+ }
138
+
139
+ export function recipientDeleteDocumentRecipientResponseBodyFromJSON(
140
+ jsonString: string,
141
+ ): SafeParseResult<
142
+ RecipientDeleteDocumentRecipientResponseBody,
143
+ SDKValidationError
144
+ > {
145
+ return safeParse(
146
+ jsonString,
147
+ (x) =>
148
+ RecipientDeleteDocumentRecipientResponseBody$inboundSchema.parse(
149
+ JSON.parse(x),
150
+ ),
151
+ `Failed to parse 'RecipientDeleteDocumentRecipientResponseBody' from JSON`,
152
+ );
153
+ }
@@ -11,6 +11,13 @@ export type RecipientDeleteTemplateRecipientRequestBody = {
11
11
  recipientId: number;
12
12
  };
13
13
 
14
+ /**
15
+ * Successful response
16
+ */
17
+ export type RecipientDeleteTemplateRecipientResponseBody = {
18
+ success: boolean;
19
+ };
20
+
14
21
  /** @internal */
15
22
  export const RecipientDeleteTemplateRecipientRequestBody$inboundSchema:
16
23
  z.ZodType<
@@ -77,3 +84,70 @@ export function recipientDeleteTemplateRecipientRequestBodyFromJSON(
77
84
  `Failed to parse 'RecipientDeleteTemplateRecipientRequestBody' from JSON`,
78
85
  );
79
86
  }
87
+
88
+ /** @internal */
89
+ export const RecipientDeleteTemplateRecipientResponseBody$inboundSchema:
90
+ z.ZodType<
91
+ RecipientDeleteTemplateRecipientResponseBody,
92
+ z.ZodTypeDef,
93
+ unknown
94
+ > = z.object({
95
+ success: z.boolean(),
96
+ });
97
+
98
+ /** @internal */
99
+ export type RecipientDeleteTemplateRecipientResponseBody$Outbound = {
100
+ success: boolean;
101
+ };
102
+
103
+ /** @internal */
104
+ export const RecipientDeleteTemplateRecipientResponseBody$outboundSchema:
105
+ z.ZodType<
106
+ RecipientDeleteTemplateRecipientResponseBody$Outbound,
107
+ z.ZodTypeDef,
108
+ RecipientDeleteTemplateRecipientResponseBody
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 RecipientDeleteTemplateRecipientResponseBody$ {
118
+ /** @deprecated use `RecipientDeleteTemplateRecipientResponseBody$inboundSchema` instead. */
119
+ export const inboundSchema =
120
+ RecipientDeleteTemplateRecipientResponseBody$inboundSchema;
121
+ /** @deprecated use `RecipientDeleteTemplateRecipientResponseBody$outboundSchema` instead. */
122
+ export const outboundSchema =
123
+ RecipientDeleteTemplateRecipientResponseBody$outboundSchema;
124
+ /** @deprecated use `RecipientDeleteTemplateRecipientResponseBody$Outbound` instead. */
125
+ export type Outbound = RecipientDeleteTemplateRecipientResponseBody$Outbound;
126
+ }
127
+
128
+ export function recipientDeleteTemplateRecipientResponseBodyToJSON(
129
+ recipientDeleteTemplateRecipientResponseBody:
130
+ RecipientDeleteTemplateRecipientResponseBody,
131
+ ): string {
132
+ return JSON.stringify(
133
+ RecipientDeleteTemplateRecipientResponseBody$outboundSchema.parse(
134
+ recipientDeleteTemplateRecipientResponseBody,
135
+ ),
136
+ );
137
+ }
138
+
139
+ export function recipientDeleteTemplateRecipientResponseBodyFromJSON(
140
+ jsonString: string,
141
+ ): SafeParseResult<
142
+ RecipientDeleteTemplateRecipientResponseBody,
143
+ SDKValidationError
144
+ > {
145
+ return safeParse(
146
+ jsonString,
147
+ (x) =>
148
+ RecipientDeleteTemplateRecipientResponseBody$inboundSchema.parse(
149
+ JSON.parse(x),
150
+ ),
151
+ `Failed to parse 'RecipientDeleteTemplateRecipientResponseBody' from JSON`,
152
+ );
153
+ }