@papierapi/sdk 0.1.0

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 (22) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +450 -0
  3. package/dist/chunk-JDUUPLUG.js +984 -0
  4. package/dist/chunk-JDUUPLUG.js.map +7 -0
  5. package/dist/client.d.ts +469 -0
  6. package/dist/errors.d.ts +20 -0
  7. package/dist/index.d.ts +3 -0
  8. package/dist/index.js +343 -0
  9. package/dist/index.js.map +7 -0
  10. package/dist/internal/contracts/common.d.ts +108 -0
  11. package/dist/internal/contracts/dispatch.d.ts +979 -0
  12. package/dist/internal/contracts/fax.d.ts +49 -0
  13. package/dist/internal/contracts/index.d.ts +7 -0
  14. package/dist/internal/contracts/letter.d.ts +292 -0
  15. package/dist/internal/contracts/mcp.d.ts +395 -0
  16. package/dist/internal/contracts/platform.d.ts +424 -0
  17. package/dist/internal/contracts/rest.d.ts +1656 -0
  18. package/dist/operations.d.ts +1563 -0
  19. package/dist/operations.js +7 -0
  20. package/dist/operations.js.map +7 -0
  21. package/examples/get-dispatch.ts +13 -0
  22. package/package.json +68 -0
package/dist/internal/contracts/fax.d.ts ADDED
@@ -0,0 +1,49 @@
1
+ import { z } from "zod";
2
+ export declare const E164Schema: z.ZodString;
3
+ export declare const FaxRecipientSchema: z.ZodObject<{
4
+ fax_number_e164: z.ZodString;
5
+ name: z.ZodOptional<z.ZodString>;
6
+ company: z.ZodOptional<z.ZodString>;
7
+ recipient_reference: z.ZodOptional<z.ZodString>;
8
+ }, z.core.$strict>;
9
+ export type FaxRecipient = z.infer<typeof FaxRecipientSchema>;
10
+ export declare const FaxOptionsSchema: z.ZodObject<{
11
+ max_attempts: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>]>>;
12
+ scheduled_at: z.ZodOptional<z.ZodISODateTime>;
13
+ purpose: z.ZodEnum<{
14
+ transactional: "transactional";
15
+ contractual: "contractual";
16
+ support: "support";
17
+ other: "other";
18
+ }>;
19
+ consent_reference: z.ZodOptional<z.ZodString>;
20
+ }, z.core.$strict>;
21
+ export type FaxOptions = z.infer<typeof FaxOptionsSchema>;
22
+ export declare const CreateFaxDraftSchema: z.ZodObject<{
23
+ sender_profile_id: z.ZodString;
24
+ recipient: z.ZodObject<{
25
+ fax_number_e164: z.ZodString;
26
+ name: z.ZodOptional<z.ZodString>;
27
+ company: z.ZodOptional<z.ZodString>;
28
+ recipient_reference: z.ZodOptional<z.ZodString>;
29
+ }, z.core.$strict>;
30
+ document_id: z.ZodString;
31
+ cover: z.ZodDefault<z.ZodObject<{
32
+ enabled: z.ZodBoolean;
33
+ subject: z.ZodOptional<z.ZodString>;
34
+ note: z.ZodOptional<z.ZodString>;
35
+ }, z.core.$strict>>;
36
+ options: z.ZodObject<{
37
+ max_attempts: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>]>>;
38
+ scheduled_at: z.ZodOptional<z.ZodISODateTime>;
39
+ purpose: z.ZodEnum<{
40
+ transactional: "transactional";
41
+ contractual: "contractual";
42
+ support: "support";
43
+ other: "other";
44
+ }>;
45
+ consent_reference: z.ZodOptional<z.ZodString>;
46
+ }, z.core.$strict>;
47
+ metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
48
+ }, z.core.$strict>;
49
+ export type CreateFaxDraft = z.infer<typeof CreateFaxDraftSchema>;
package/dist/internal/contracts/index.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ export * from "./common.js";
2
+ export * from "./dispatch.js";
3
+ export * from "./fax.js";
4
+ export * from "./letter.js";
5
+ export * from "./mcp.js";
6
+ export * from "./platform.js";
7
+ export * from "./rest.js";
package/dist/internal/contracts/letter.d.ts ADDED
@@ -0,0 +1,292 @@
1
+ import { z } from "zod";
2
+ export declare const GermanStreetRecipientSchema: z.ZodObject<{
3
+ type: z.ZodDefault<z.ZodLiteral<"street">>;
4
+ company: z.ZodOptional<z.ZodString>;
5
+ name: z.ZodString;
6
+ attention: z.ZodOptional<z.ZodString>;
7
+ additional_line: z.ZodOptional<z.ZodString>;
8
+ street: z.ZodString;
9
+ house_number: z.ZodString;
10
+ postal_code: z.ZodString;
11
+ city: z.ZodString;
12
+ country: z.ZodLiteral<"DE">;
13
+ }, z.core.$strict>;
14
+ export declare const GermanPostBoxRecipientSchema: z.ZodObject<{
15
+ type: z.ZodLiteral<"post_box">;
16
+ company: z.ZodOptional<z.ZodString>;
17
+ name: z.ZodString;
18
+ attention: z.ZodOptional<z.ZodString>;
19
+ post_box: z.ZodString;
20
+ postal_code: z.ZodString;
21
+ city: z.ZodString;
22
+ country: z.ZodLiteral<"DE">;
23
+ }, z.core.$strict>;
24
+ export declare const GermanPostalRecipientSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
25
+ type: z.ZodDefault<z.ZodLiteral<"street">>;
26
+ company: z.ZodOptional<z.ZodString>;
27
+ name: z.ZodString;
28
+ attention: z.ZodOptional<z.ZodString>;
29
+ additional_line: z.ZodOptional<z.ZodString>;
30
+ street: z.ZodString;
31
+ house_number: z.ZodString;
32
+ postal_code: z.ZodString;
33
+ city: z.ZodString;
34
+ country: z.ZodLiteral<"DE">;
35
+ }, z.core.$strict>, z.ZodObject<{
36
+ type: z.ZodLiteral<"post_box">;
37
+ company: z.ZodOptional<z.ZodString>;
38
+ name: z.ZodString;
39
+ attention: z.ZodOptional<z.ZodString>;
40
+ post_box: z.ZodString;
41
+ postal_code: z.ZodString;
42
+ city: z.ZodString;
43
+ country: z.ZodLiteral<"DE">;
44
+ }, z.core.$strict>], "type">;
45
+ export type GermanPostalRecipient = z.infer<typeof GermanPostalRecipientSchema>;
46
+ export declare const LetterBlockSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
47
+ type: z.ZodLiteral<"paragraph">;
48
+ text: z.ZodString;
49
+ style: z.ZodDefault<z.ZodEnum<{
50
+ normal: "normal";
51
+ emphasis: "emphasis";
52
+ }>>;
53
+ }, z.core.$strict>, z.ZodObject<{
54
+ type: z.ZodLiteral<"heading">;
55
+ text: z.ZodString;
56
+ level: z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>;
57
+ }, z.core.$strict>, z.ZodObject<{
58
+ type: z.ZodLiteral<"list">;
59
+ ordered: z.ZodDefault<z.ZodBoolean>;
60
+ items: z.ZodArray<z.ZodString>;
61
+ }, z.core.$strict>, z.ZodObject<{
62
+ type: z.ZodLiteral<"table">;
63
+ columns: z.ZodArray<z.ZodString>;
64
+ rows: z.ZodArray<z.ZodArray<z.ZodString>>;
65
+ }, z.core.$strict>, z.ZodObject<{
66
+ type: z.ZodLiteral<"spacer">;
67
+ millimeters: z.ZodNumber;
68
+ }, z.core.$strict>, z.ZodObject<{
69
+ type: z.ZodLiteral<"closing">;
70
+ text: z.ZodString;
71
+ }, z.core.$strict>, z.ZodObject<{
72
+ type: z.ZodLiteral<"signature_placeholder">;
73
+ height_mm: z.ZodNumber;
74
+ }, z.core.$strict>], "type">;
75
+ export type LetterBlock = z.infer<typeof LetterBlockSchema>;
76
+ export declare const StructuredLetterContentSchema: z.ZodObject<{
77
+ locale: z.ZodDefault<z.ZodEnum<{
78
+ "de-DE": "de-DE";
79
+ "en-DE": "en-DE";
80
+ }>>;
81
+ date: z.ZodISODate;
82
+ reference_lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
83
+ label: z.ZodString;
84
+ value: z.ZodString;
85
+ }, z.core.$strict>>>;
86
+ subject: z.ZodString;
87
+ salutation: z.ZodOptional<z.ZodString>;
88
+ blocks: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
89
+ type: z.ZodLiteral<"paragraph">;
90
+ text: z.ZodString;
91
+ style: z.ZodDefault<z.ZodEnum<{
92
+ normal: "normal";
93
+ emphasis: "emphasis";
94
+ }>>;
95
+ }, z.core.$strict>, z.ZodObject<{
96
+ type: z.ZodLiteral<"heading">;
97
+ text: z.ZodString;
98
+ level: z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>;
99
+ }, z.core.$strict>, z.ZodObject<{
100
+ type: z.ZodLiteral<"list">;
101
+ ordered: z.ZodDefault<z.ZodBoolean>;
102
+ items: z.ZodArray<z.ZodString>;
103
+ }, z.core.$strict>, z.ZodObject<{
104
+ type: z.ZodLiteral<"table">;
105
+ columns: z.ZodArray<z.ZodString>;
106
+ rows: z.ZodArray<z.ZodArray<z.ZodString>>;
107
+ }, z.core.$strict>, z.ZodObject<{
108
+ type: z.ZodLiteral<"spacer">;
109
+ millimeters: z.ZodNumber;
110
+ }, z.core.$strict>, z.ZodObject<{
111
+ type: z.ZodLiteral<"closing">;
112
+ text: z.ZodString;
113
+ }, z.core.$strict>, z.ZodObject<{
114
+ type: z.ZodLiteral<"signature_placeholder">;
115
+ height_mm: z.ZodNumber;
116
+ }, z.core.$strict>], "type">>;
117
+ closing: z.ZodOptional<z.ZodString>;
118
+ signatory: z.ZodOptional<z.ZodString>;
119
+ }, z.core.$strict>;
120
+ export type StructuredLetterContent = z.infer<typeof StructuredLetterContentSchema>;
121
+ export declare const LetterSourceSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
122
+ mode: z.ZodLiteral<"structured">;
123
+ content: z.ZodObject<{
124
+ locale: z.ZodDefault<z.ZodEnum<{
125
+ "de-DE": "de-DE";
126
+ "en-DE": "en-DE";
127
+ }>>;
128
+ date: z.ZodISODate;
129
+ reference_lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
130
+ label: z.ZodString;
131
+ value: z.ZodString;
132
+ }, z.core.$strict>>>;
133
+ subject: z.ZodString;
134
+ salutation: z.ZodOptional<z.ZodString>;
135
+ blocks: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
136
+ type: z.ZodLiteral<"paragraph">;
137
+ text: z.ZodString;
138
+ style: z.ZodDefault<z.ZodEnum<{
139
+ normal: "normal";
140
+ emphasis: "emphasis";
141
+ }>>;
142
+ }, z.core.$strict>, z.ZodObject<{
143
+ type: z.ZodLiteral<"heading">;
144
+ text: z.ZodString;
145
+ level: z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>;
146
+ }, z.core.$strict>, z.ZodObject<{
147
+ type: z.ZodLiteral<"list">;
148
+ ordered: z.ZodDefault<z.ZodBoolean>;
149
+ items: z.ZodArray<z.ZodString>;
150
+ }, z.core.$strict>, z.ZodObject<{
151
+ type: z.ZodLiteral<"table">;
152
+ columns: z.ZodArray<z.ZodString>;
153
+ rows: z.ZodArray<z.ZodArray<z.ZodString>>;
154
+ }, z.core.$strict>, z.ZodObject<{
155
+ type: z.ZodLiteral<"spacer">;
156
+ millimeters: z.ZodNumber;
157
+ }, z.core.$strict>, z.ZodObject<{
158
+ type: z.ZodLiteral<"closing">;
159
+ text: z.ZodString;
160
+ }, z.core.$strict>, z.ZodObject<{
161
+ type: z.ZodLiteral<"signature_placeholder">;
162
+ height_mm: z.ZodNumber;
163
+ }, z.core.$strict>], "type">>;
164
+ closing: z.ZodOptional<z.ZodString>;
165
+ signatory: z.ZodOptional<z.ZodString>;
166
+ }, z.core.$strict>;
167
+ }, z.core.$strict>, z.ZodObject<{
168
+ mode: z.ZodLiteral<"raw_pdf">;
169
+ document_id: z.ZodString;
170
+ }, z.core.$strict>], "mode">;
171
+ export declare const LetterOptionsSchema: z.ZodObject<{
172
+ print: z.ZodEnum<{
173
+ grayscale: "grayscale";
174
+ color: "color";
175
+ }>;
176
+ duplex: z.ZodBoolean;
177
+ service: z.ZodEnum<{
178
+ standard: "standard";
179
+ registered_insertion: "registered_insertion";
180
+ registered_signature: "registered_signature";
181
+ }>;
182
+ criticality: z.ZodDefault<z.ZodEnum<{
183
+ normal: "normal";
184
+ high: "high";
185
+ }>>;
186
+ layout_profile: z.ZodDefault<z.ZodEnum<{
187
+ de_business_window_a: "de_business_window_a";
188
+ de_business_window_b: "de_business_window_b";
189
+ de_business_no_window: "de_business_no_window";
190
+ }>>;
191
+ }, z.core.$strict>;
192
+ export type LetterOptions = z.infer<typeof LetterOptionsSchema>;
193
+ export declare const CreateLetterDraftSchema: z.ZodObject<{
194
+ sender_profile_id: z.ZodString;
195
+ recipient: z.ZodDiscriminatedUnion<[z.ZodObject<{
196
+ type: z.ZodDefault<z.ZodLiteral<"street">>;
197
+ company: z.ZodOptional<z.ZodString>;
198
+ name: z.ZodString;
199
+ attention: z.ZodOptional<z.ZodString>;
200
+ additional_line: z.ZodOptional<z.ZodString>;
201
+ street: z.ZodString;
202
+ house_number: z.ZodString;
203
+ postal_code: z.ZodString;
204
+ city: z.ZodString;
205
+ country: z.ZodLiteral<"DE">;
206
+ }, z.core.$strict>, z.ZodObject<{
207
+ type: z.ZodLiteral<"post_box">;
208
+ company: z.ZodOptional<z.ZodString>;
209
+ name: z.ZodString;
210
+ attention: z.ZodOptional<z.ZodString>;
211
+ post_box: z.ZodString;
212
+ postal_code: z.ZodString;
213
+ city: z.ZodString;
214
+ country: z.ZodLiteral<"DE">;
215
+ }, z.core.$strict>], "type">;
216
+ source: z.ZodDiscriminatedUnion<[z.ZodObject<{
217
+ mode: z.ZodLiteral<"structured">;
218
+ content: z.ZodObject<{
219
+ locale: z.ZodDefault<z.ZodEnum<{
220
+ "de-DE": "de-DE";
221
+ "en-DE": "en-DE";
222
+ }>>;
223
+ date: z.ZodISODate;
224
+ reference_lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
225
+ label: z.ZodString;
226
+ value: z.ZodString;
227
+ }, z.core.$strict>>>;
228
+ subject: z.ZodString;
229
+ salutation: z.ZodOptional<z.ZodString>;
230
+ blocks: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
231
+ type: z.ZodLiteral<"paragraph">;
232
+ text: z.ZodString;
233
+ style: z.ZodDefault<z.ZodEnum<{
234
+ normal: "normal";
235
+ emphasis: "emphasis";
236
+ }>>;
237
+ }, z.core.$strict>, z.ZodObject<{
238
+ type: z.ZodLiteral<"heading">;
239
+ text: z.ZodString;
240
+ level: z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>;
241
+ }, z.core.$strict>, z.ZodObject<{
242
+ type: z.ZodLiteral<"list">;
243
+ ordered: z.ZodDefault<z.ZodBoolean>;
244
+ items: z.ZodArray<z.ZodString>;
245
+ }, z.core.$strict>, z.ZodObject<{
246
+ type: z.ZodLiteral<"table">;
247
+ columns: z.ZodArray<z.ZodString>;
248
+ rows: z.ZodArray<z.ZodArray<z.ZodString>>;
249
+ }, z.core.$strict>, z.ZodObject<{
250
+ type: z.ZodLiteral<"spacer">;
251
+ millimeters: z.ZodNumber;
252
+ }, z.core.$strict>, z.ZodObject<{
253
+ type: z.ZodLiteral<"closing">;
254
+ text: z.ZodString;
255
+ }, z.core.$strict>, z.ZodObject<{
256
+ type: z.ZodLiteral<"signature_placeholder">;
257
+ height_mm: z.ZodNumber;
258
+ }, z.core.$strict>], "type">>;
259
+ closing: z.ZodOptional<z.ZodString>;
260
+ signatory: z.ZodOptional<z.ZodString>;
261
+ }, z.core.$strict>;
262
+ }, z.core.$strict>, z.ZodObject<{
263
+ mode: z.ZodLiteral<"raw_pdf">;
264
+ document_id: z.ZodString;
265
+ }, z.core.$strict>], "mode">;
266
+ attachments: z.ZodDefault<z.ZodArray<z.ZodObject<{
267
+ document_id: z.ZodString;
268
+ }, z.core.$strict>>>;
269
+ options: z.ZodObject<{
270
+ print: z.ZodEnum<{
271
+ grayscale: "grayscale";
272
+ color: "color";
273
+ }>;
274
+ duplex: z.ZodBoolean;
275
+ service: z.ZodEnum<{
276
+ standard: "standard";
277
+ registered_insertion: "registered_insertion";
278
+ registered_signature: "registered_signature";
279
+ }>;
280
+ criticality: z.ZodDefault<z.ZodEnum<{
281
+ normal: "normal";
282
+ high: "high";
283
+ }>>;
284
+ layout_profile: z.ZodDefault<z.ZodEnum<{
285
+ de_business_window_a: "de_business_window_a";
286
+ de_business_window_b: "de_business_window_b";
287
+ de_business_no_window: "de_business_no_window";
288
+ }>>;
289
+ }, z.core.$strict>;
290
+ metadata: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
291
+ }, z.core.$strict>;
292
+ export type CreateLetterDraft = z.infer<typeof CreateLetterDraftSchema>;