@voltade/envoy-sdk 1.3.0 → 1.3.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 (51) hide show
  1. package/README.md +536 -64
  2. package/dist/client.d.ts +5 -1
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +2 -1
  5. package/dist/client.js.map +1 -1
  6. package/dist/resources/base-resource.d.ts +9 -0
  7. package/dist/resources/base-resource.d.ts.map +1 -0
  8. package/dist/resources/base-resource.js +9 -0
  9. package/dist/resources/base-resource.js.map +1 -0
  10. package/dist/resources/campaigns/index.d.ts +123 -0
  11. package/dist/resources/campaigns/index.d.ts.map +1 -0
  12. package/dist/resources/campaigns/index.js +159 -0
  13. package/dist/resources/campaigns/index.js.map +1 -0
  14. package/dist/resources/campaigns/types.d.ts +757 -0
  15. package/dist/resources/campaigns/types.d.ts.map +1 -0
  16. package/dist/resources/campaigns/types.js +132 -0
  17. package/dist/resources/campaigns/types.js.map +1 -0
  18. package/dist/resources/companies/index.d.ts +1 -7
  19. package/dist/resources/companies/index.d.ts.map +1 -1
  20. package/dist/resources/companies/index.js +1 -8
  21. package/dist/resources/companies/index.js.map +1 -1
  22. package/dist/resources/companies/types.d.ts +14 -14
  23. package/dist/resources/company-members/index.d.ts +1 -8
  24. package/dist/resources/company-members/index.d.ts.map +1 -1
  25. package/dist/resources/company-members/index.js +1 -8
  26. package/dist/resources/company-members/index.js.map +1 -1
  27. package/dist/resources/contacts/index.d.ts +1 -8
  28. package/dist/resources/contacts/index.d.ts.map +1 -1
  29. package/dist/resources/contacts/index.js +1 -8
  30. package/dist/resources/contacts/index.js.map +1 -1
  31. package/dist/resources/conversations/index.d.ts +1 -8
  32. package/dist/resources/conversations/index.d.ts.map +1 -1
  33. package/dist/resources/conversations/index.js +1 -8
  34. package/dist/resources/conversations/index.js.map +1 -1
  35. package/dist/resources/conversations/types.d.ts +67 -67
  36. package/dist/resources/inboxes/index.d.ts +1 -8
  37. package/dist/resources/inboxes/index.d.ts.map +1 -1
  38. package/dist/resources/inboxes/index.js +1 -8
  39. package/dist/resources/inboxes/index.js.map +1 -1
  40. package/dist/resources/inboxes/types.d.ts +12 -12
  41. package/dist/resources/index.d.ts +1 -0
  42. package/dist/resources/index.d.ts.map +1 -1
  43. package/dist/resources/index.js +1 -0
  44. package/dist/resources/index.js.map +1 -1
  45. package/dist/resources/orders/index.d.ts +1 -8
  46. package/dist/resources/orders/index.d.ts.map +1 -1
  47. package/dist/resources/orders/index.js +1 -8
  48. package/dist/resources/orders/index.js.map +1 -1
  49. package/dist/resources/orders/types.d.ts +116 -116
  50. package/dist/resources/webhooks/types.d.ts +753 -753
  51. package/package.json +1 -1
package/dist/resources/orders/types.d.ts CHANGED
@@ -9,14 +9,14 @@ export declare const OrderLineItemSchema: z.ZodObject<{
9
9
  description: z.ZodOptional<z.ZodString>;
10
10
  line_total: z.ZodOptional<z.ZodNumber>;
11
11
  }, "strip", z.ZodTypeAny, {
12
+ description?: string | undefined;
12
13
  part_number?: string | undefined;
13
14
  quantity?: number | undefined;
14
- description?: string | undefined;
15
15
  line_total?: number | undefined;
16
16
  }, {
17
+ description?: string | undefined;
17
18
  part_number?: string | undefined;
18
19
  quantity?: number | undefined;
19
- description?: string | undefined;
20
20
  line_total?: number | undefined;
21
21
  }>;
22
22
  export declare const OrderMetadataSchema: z.ZodObject<{
@@ -26,28 +26,28 @@ export declare const OrderMetadataSchema: z.ZodObject<{
26
26
  description: z.ZodOptional<z.ZodString>;
27
27
  line_total: z.ZodOptional<z.ZodNumber>;
28
28
  }, "strip", z.ZodTypeAny, {
29
+ description?: string | undefined;
29
30
  part_number?: string | undefined;
30
31
  quantity?: number | undefined;
31
- description?: string | undefined;
32
32
  line_total?: number | undefined;
33
33
  }, {
34
+ description?: string | undefined;
34
35
  part_number?: string | undefined;
35
36
  quantity?: number | undefined;
36
- description?: string | undefined;
37
37
  line_total?: number | undefined;
38
38
  }>, "many">>;
39
39
  }, "strip", z.ZodTypeAny, {
40
40
  line_items?: {
41
+ description?: string | undefined;
41
42
  part_number?: string | undefined;
42
43
  quantity?: number | undefined;
43
- description?: string | undefined;
44
44
  line_total?: number | undefined;
45
45
  }[] | undefined;
46
46
  }, {
47
47
  line_items?: {
48
+ description?: string | undefined;
48
49
  part_number?: string | undefined;
49
50
  quantity?: number | undefined;
50
- description?: string | undefined;
51
51
  line_total?: number | undefined;
52
52
  }[] | undefined;
53
53
  }>;
@@ -69,28 +69,28 @@ export declare const UpsertOrderParamsSchema: z.ZodObject<{
69
69
  description: z.ZodOptional<z.ZodString>;
70
70
  line_total: z.ZodOptional<z.ZodNumber>;
71
71
  }, "strip", z.ZodTypeAny, {
72
+ description?: string | undefined;
72
73
  part_number?: string | undefined;
73
74
  quantity?: number | undefined;
74
- description?: string | undefined;
75
75
  line_total?: number | undefined;
76
76
  }, {
77
+ description?: string | undefined;
77
78
  part_number?: string | undefined;
78
79
  quantity?: number | undefined;
79
- description?: string | undefined;
80
80
  line_total?: number | undefined;
81
81
  }>, "many">>;
82
82
  }, "strip", z.ZodTypeAny, {
83
83
  line_items?: {
84
+ description?: string | undefined;
84
85
  part_number?: string | undefined;
85
86
  quantity?: number | undefined;
86
- description?: string | undefined;
87
87
  line_total?: number | undefined;
88
88
  }[] | undefined;
89
89
  }, {
90
90
  line_items?: {
91
+ description?: string | undefined;
91
92
  part_number?: string | undefined;
92
93
  quantity?: number | undefined;
93
- description?: string | undefined;
94
94
  line_total?: number | undefined;
95
95
  }[] | undefined;
96
96
  }>>;
@@ -100,6 +100,14 @@ export declare const UpsertOrderParamsSchema: z.ZodObject<{
100
100
  source_id: string;
101
101
  source: string;
102
102
  name?: string | undefined;
103
+ metadata?: {
104
+ line_items?: {
105
+ description?: string | undefined;
106
+ part_number?: string | undefined;
107
+ quantity?: number | undefined;
108
+ line_total?: number | undefined;
109
+ }[] | undefined;
110
+ } | undefined;
103
111
  created_at?: string | undefined;
104
112
  custom_attributes?: Record<string, unknown> | undefined;
105
113
  company_id?: number | undefined;
@@ -109,18 +117,18 @@ export declare const UpsertOrderParamsSchema: z.ZodObject<{
109
117
  fulfillment_status?: string | undefined;
110
118
  order_url?: string | undefined;
111
119
  notes?: string | undefined;
120
+ }, {
121
+ source_id: string;
122
+ source: string;
123
+ name?: string | undefined;
112
124
  metadata?: {
113
125
  line_items?: {
126
+ description?: string | undefined;
114
127
  part_number?: string | undefined;
115
128
  quantity?: number | undefined;
116
- description?: string | undefined;
117
129
  line_total?: number | undefined;
118
130
  }[] | undefined;
119
131
  } | undefined;
120
- }, {
121
- source_id: string;
122
- source: string;
123
- name?: string | undefined;
124
132
  created_at?: string | undefined;
125
133
  custom_attributes?: Record<string, unknown> | undefined;
126
134
  company_id?: number | undefined;
@@ -130,14 +138,6 @@ export declare const UpsertOrderParamsSchema: z.ZodObject<{
130
138
  fulfillment_status?: string | undefined;
131
139
  order_url?: string | undefined;
132
140
  notes?: string | undefined;
133
- metadata?: {
134
- line_items?: {
135
- part_number?: string | undefined;
136
- quantity?: number | undefined;
137
- description?: string | undefined;
138
- line_total?: number | undefined;
139
- }[] | undefined;
140
- } | undefined;
141
141
  }>;
142
142
  export declare const UpsertOrderRequestSchema: z.ZodObject<{
143
143
  order: z.ZodObject<{
@@ -158,28 +158,28 @@ export declare const UpsertOrderRequestSchema: z.ZodObject<{
158
158
  description: z.ZodOptional<z.ZodString>;
159
159
  line_total: z.ZodOptional<z.ZodNumber>;
160
160
  }, "strip", z.ZodTypeAny, {
161
+ description?: string | undefined;
161
162
  part_number?: string | undefined;
162
163
  quantity?: number | undefined;
163
- description?: string | undefined;
164
164
  line_total?: number | undefined;
165
165
  }, {
166
+ description?: string | undefined;
166
167
  part_number?: string | undefined;
167
168
  quantity?: number | undefined;
168
- description?: string | undefined;
169
169
  line_total?: number | undefined;
170
170
  }>, "many">>;
171
171
  }, "strip", z.ZodTypeAny, {
172
172
  line_items?: {
173
+ description?: string | undefined;
173
174
  part_number?: string | undefined;
174
175
  quantity?: number | undefined;
175
- description?: string | undefined;
176
176
  line_total?: number | undefined;
177
177
  }[] | undefined;
178
178
  }, {
179
179
  line_items?: {
180
+ description?: string | undefined;
180
181
  part_number?: string | undefined;
181
182
  quantity?: number | undefined;
182
- description?: string | undefined;
183
183
  line_total?: number | undefined;
184
184
  }[] | undefined;
185
185
  }>>;
@@ -189,6 +189,14 @@ export declare const UpsertOrderRequestSchema: z.ZodObject<{
189
189
  source_id: string;
190
190
  source: string;
191
191
  name?: string | undefined;
192
+ metadata?: {
193
+ line_items?: {
194
+ description?: string | undefined;
195
+ part_number?: string | undefined;
196
+ quantity?: number | undefined;
197
+ line_total?: number | undefined;
198
+ }[] | undefined;
199
+ } | undefined;
192
200
  created_at?: string | undefined;
193
201
  custom_attributes?: Record<string, unknown> | undefined;
194
202
  company_id?: number | undefined;
@@ -198,18 +206,18 @@ export declare const UpsertOrderRequestSchema: z.ZodObject<{
198
206
  fulfillment_status?: string | undefined;
199
207
  order_url?: string | undefined;
200
208
  notes?: string | undefined;
209
+ }, {
210
+ source_id: string;
211
+ source: string;
212
+ name?: string | undefined;
201
213
  metadata?: {
202
214
  line_items?: {
215
+ description?: string | undefined;
203
216
  part_number?: string | undefined;
204
217
  quantity?: number | undefined;
205
- description?: string | undefined;
206
218
  line_total?: number | undefined;
207
219
  }[] | undefined;
208
220
  } | undefined;
209
- }, {
210
- source_id: string;
211
- source: string;
212
- name?: string | undefined;
213
221
  created_at?: string | undefined;
214
222
  custom_attributes?: Record<string, unknown> | undefined;
215
223
  company_id?: number | undefined;
@@ -219,20 +227,20 @@ export declare const UpsertOrderRequestSchema: z.ZodObject<{
219
227
  fulfillment_status?: string | undefined;
220
228
  order_url?: string | undefined;
221
229
  notes?: string | undefined;
230
+ }>;
231
+ }, "strip", z.ZodTypeAny, {
232
+ order: {
233
+ source_id: string;
234
+ source: string;
235
+ name?: string | undefined;
222
236
  metadata?: {
223
237
  line_items?: {
238
+ description?: string | undefined;
224
239
  part_number?: string | undefined;
225
240
  quantity?: number | undefined;
226
- description?: string | undefined;
227
241
  line_total?: number | undefined;
228
242
  }[] | undefined;
229
243
  } | undefined;
230
- }>;
231
- }, "strip", z.ZodTypeAny, {
232
- order: {
233
- source_id: string;
234
- source: string;
235
- name?: string | undefined;
236
244
  created_at?: string | undefined;
237
245
  custom_attributes?: Record<string, unknown> | undefined;
238
246
  company_id?: number | undefined;
@@ -242,20 +250,20 @@ export declare const UpsertOrderRequestSchema: z.ZodObject<{
242
250
  fulfillment_status?: string | undefined;
243
251
  order_url?: string | undefined;
244
252
  notes?: string | undefined;
253
+ };
254
+ }, {
255
+ order: {
256
+ source_id: string;
257
+ source: string;
258
+ name?: string | undefined;
245
259
  metadata?: {
246
260
  line_items?: {
261
+ description?: string | undefined;
247
262
  part_number?: string | undefined;
248
263
  quantity?: number | undefined;
249
- description?: string | undefined;
250
264
  line_total?: number | undefined;
251
265
  }[] | undefined;
252
266
  } | undefined;
253
- };
254
- }, {
255
- order: {
256
- source_id: string;
257
- source: string;
258
- name?: string | undefined;
259
267
  created_at?: string | undefined;
260
268
  custom_attributes?: Record<string, unknown> | undefined;
261
269
  company_id?: number | undefined;
@@ -265,14 +273,6 @@ export declare const UpsertOrderRequestSchema: z.ZodObject<{
265
273
  fulfillment_status?: string | undefined;
266
274
  order_url?: string | undefined;
267
275
  notes?: string | undefined;
268
- metadata?: {
269
- line_items?: {
270
- part_number?: string | undefined;
271
- quantity?: number | undefined;
272
- description?: string | undefined;
273
- line_total?: number | undefined;
274
- }[] | undefined;
275
- } | undefined;
276
276
  };
277
277
  }>;
278
278
  export declare const UpsertOrderResponsePayloadSchema: z.ZodObject<{
@@ -295,28 +295,28 @@ export declare const UpsertOrderResponsePayloadSchema: z.ZodObject<{
295
295
  description: z.ZodOptional<z.ZodString>;
296
296
  line_total: z.ZodOptional<z.ZodNumber>;
297
297
  }, "strip", z.ZodTypeAny, {
298
+ description?: string | undefined;
298
299
  part_number?: string | undefined;
299
300
  quantity?: number | undefined;
300
- description?: string | undefined;
301
301
  line_total?: number | undefined;
302
302
  }, {
303
+ description?: string | undefined;
303
304
  part_number?: string | undefined;
304
305
  quantity?: number | undefined;
305
- description?: string | undefined;
306
306
  line_total?: number | undefined;
307
307
  }>, "many">>;
308
308
  }, "strip", z.ZodTypeAny, {
309
309
  line_items?: {
310
+ description?: string | undefined;
310
311
  part_number?: string | undefined;
311
312
  quantity?: number | undefined;
312
- description?: string | undefined;
313
313
  line_total?: number | undefined;
314
314
  }[] | undefined;
315
315
  }, {
316
316
  line_items?: {
317
+ description?: string | undefined;
317
318
  part_number?: string | undefined;
318
319
  quantity?: number | undefined;
319
- description?: string | undefined;
320
320
  line_total?: number | undefined;
321
321
  }[] | undefined;
322
322
  }>>;
@@ -326,10 +326,18 @@ export declare const UpsertOrderResponsePayloadSchema: z.ZodObject<{
326
326
  }, "strip", z.ZodTypeAny, {
327
327
  id: number;
328
328
  created_at: string;
329
- source_id: string;
330
329
  updated_at: string;
330
+ source_id: string;
331
331
  source: string;
332
332
  name?: string | undefined;
333
+ metadata?: {
334
+ line_items?: {
335
+ description?: string | undefined;
336
+ part_number?: string | undefined;
337
+ quantity?: number | undefined;
338
+ line_total?: number | undefined;
339
+ }[] | undefined;
340
+ } | undefined;
333
341
  custom_attributes?: Record<string, unknown> | undefined;
334
342
  company_id?: number | undefined;
335
343
  total_amount?: number | undefined;
@@ -338,22 +346,22 @@ export declare const UpsertOrderResponsePayloadSchema: z.ZodObject<{
338
346
  fulfillment_status?: string | undefined;
339
347
  order_url?: string | undefined;
340
348
  notes?: string | undefined;
341
- metadata?: {
342
- line_items?: {
343
- part_number?: string | undefined;
344
- quantity?: number | undefined;
345
- description?: string | undefined;
346
- line_total?: number | undefined;
347
- }[] | undefined;
348
- } | undefined;
349
349
  contact_name?: string | undefined;
350
350
  }, {
351
351
  id: number;
352
352
  created_at: string;
353
- source_id: string;
354
353
  updated_at: string;
354
+ source_id: string;
355
355
  source: string;
356
356
  name?: string | undefined;
357
+ metadata?: {
358
+ line_items?: {
359
+ description?: string | undefined;
360
+ part_number?: string | undefined;
361
+ quantity?: number | undefined;
362
+ line_total?: number | undefined;
363
+ }[] | undefined;
364
+ } | undefined;
357
365
  custom_attributes?: Record<string, unknown> | undefined;
358
366
  company_id?: number | undefined;
359
367
  total_amount?: number | undefined;
@@ -362,14 +370,6 @@ export declare const UpsertOrderResponsePayloadSchema: z.ZodObject<{
362
370
  fulfillment_status?: string | undefined;
363
371
  order_url?: string | undefined;
364
372
  notes?: string | undefined;
365
- metadata?: {
366
- line_items?: {
367
- part_number?: string | undefined;
368
- quantity?: number | undefined;
369
- description?: string | undefined;
370
- line_total?: number | undefined;
371
- }[] | undefined;
372
- } | undefined;
373
373
  contact_name?: string | undefined;
374
374
  }>;
375
375
  export declare const UpsertOrderResponseSchema: z.ZodObject<{
@@ -393,28 +393,28 @@ export declare const UpsertOrderResponseSchema: z.ZodObject<{
393
393
  description: z.ZodOptional<z.ZodString>;
394
394
  line_total: z.ZodOptional<z.ZodNumber>;
395
395
  }, "strip", z.ZodTypeAny, {
396
+ description?: string | undefined;
396
397
  part_number?: string | undefined;
397
398
  quantity?: number | undefined;
398
- description?: string | undefined;
399
399
  line_total?: number | undefined;
400
400
  }, {
401
+ description?: string | undefined;
401
402
  part_number?: string | undefined;
402
403
  quantity?: number | undefined;
403
- description?: string | undefined;
404
404
  line_total?: number | undefined;
405
405
  }>, "many">>;
406
406
  }, "strip", z.ZodTypeAny, {
407
407
  line_items?: {
408
+ description?: string | undefined;
408
409
  part_number?: string | undefined;
409
410
  quantity?: number | undefined;
410
- description?: string | undefined;
411
411
  line_total?: number | undefined;
412
412
  }[] | undefined;
413
413
  }, {
414
414
  line_items?: {
415
+ description?: string | undefined;
415
416
  part_number?: string | undefined;
416
417
  quantity?: number | undefined;
417
- description?: string | undefined;
418
418
  line_total?: number | undefined;
419
419
  }[] | undefined;
420
420
  }>>;
@@ -424,10 +424,18 @@ export declare const UpsertOrderResponseSchema: z.ZodObject<{
424
424
  }, "strip", z.ZodTypeAny, {
425
425
  id: number;
426
426
  created_at: string;
427
- source_id: string;
428
427
  updated_at: string;
428
+ source_id: string;
429
429
  source: string;
430
430
  name?: string | undefined;
431
+ metadata?: {
432
+ line_items?: {
433
+ description?: string | undefined;
434
+ part_number?: string | undefined;
435
+ quantity?: number | undefined;
436
+ line_total?: number | undefined;
437
+ }[] | undefined;
438
+ } | undefined;
431
439
  custom_attributes?: Record<string, unknown> | undefined;
432
440
  company_id?: number | undefined;
433
441
  total_amount?: number | undefined;
@@ -436,22 +444,22 @@ export declare const UpsertOrderResponseSchema: z.ZodObject<{
436
444
  fulfillment_status?: string | undefined;
437
445
  order_url?: string | undefined;
438
446
  notes?: string | undefined;
439
- metadata?: {
440
- line_items?: {
441
- part_number?: string | undefined;
442
- quantity?: number | undefined;
443
- description?: string | undefined;
444
- line_total?: number | undefined;
445
- }[] | undefined;
446
- } | undefined;
447
447
  contact_name?: string | undefined;
448
448
  }, {
449
449
  id: number;
450
450
  created_at: string;
451
- source_id: string;
452
451
  updated_at: string;
452
+ source_id: string;
453
453
  source: string;
454
454
  name?: string | undefined;
455
+ metadata?: {
456
+ line_items?: {
457
+ description?: string | undefined;
458
+ part_number?: string | undefined;
459
+ quantity?: number | undefined;
460
+ line_total?: number | undefined;
461
+ }[] | undefined;
462
+ } | undefined;
455
463
  custom_attributes?: Record<string, unknown> | undefined;
456
464
  company_id?: number | undefined;
457
465
  total_amount?: number | undefined;
@@ -460,24 +468,24 @@ export declare const UpsertOrderResponseSchema: z.ZodObject<{
460
468
  fulfillment_status?: string | undefined;
461
469
  order_url?: string | undefined;
462
470
  notes?: string | undefined;
463
- metadata?: {
464
- line_items?: {
465
- part_number?: string | undefined;
466
- quantity?: number | undefined;
467
- description?: string | undefined;
468
- line_total?: number | undefined;
469
- }[] | undefined;
470
- } | undefined;
471
471
  contact_name?: string | undefined;
472
472
  }>;
473
473
  }, "strip", z.ZodTypeAny, {
474
474
  payload: {
475
475
  id: number;
476
476
  created_at: string;
477
- source_id: string;
478
477
  updated_at: string;
478
+ source_id: string;
479
479
  source: string;
480
480
  name?: string | undefined;
481
+ metadata?: {
482
+ line_items?: {
483
+ description?: string | undefined;
484
+ part_number?: string | undefined;
485
+ quantity?: number | undefined;
486
+ line_total?: number | undefined;
487
+ }[] | undefined;
488
+ } | undefined;
481
489
  custom_attributes?: Record<string, unknown> | undefined;
482
490
  company_id?: number | undefined;
483
491
  total_amount?: number | undefined;
@@ -486,24 +494,24 @@ export declare const UpsertOrderResponseSchema: z.ZodObject<{
486
494
  fulfillment_status?: string | undefined;
487
495
  order_url?: string | undefined;
488
496
  notes?: string | undefined;
489
- metadata?: {
490
- line_items?: {
491
- part_number?: string | undefined;
492
- quantity?: number | undefined;
493
- description?: string | undefined;
494
- line_total?: number | undefined;
495
- }[] | undefined;
496
- } | undefined;
497
497
  contact_name?: string | undefined;
498
498
  };
499
499
  }, {
500
500
  payload: {
501
501
  id: number;
502
502
  created_at: string;
503
- source_id: string;
504
503
  updated_at: string;
504
+ source_id: string;
505
505
  source: string;
506
506
  name?: string | undefined;
507
+ metadata?: {
508
+ line_items?: {
509
+ description?: string | undefined;
510
+ part_number?: string | undefined;
511
+ quantity?: number | undefined;
512
+ line_total?: number | undefined;
513
+ }[] | undefined;
514
+ } | undefined;
507
515
  custom_attributes?: Record<string, unknown> | undefined;
508
516
  company_id?: number | undefined;
509
517
  total_amount?: number | undefined;
@@ -512,14 +520,6 @@ export declare const UpsertOrderResponseSchema: z.ZodObject<{
512
520
  fulfillment_status?: string | undefined;
513
521
  order_url?: string | undefined;
514
522
  notes?: string | undefined;
515
- metadata?: {
516
- line_items?: {
517
- part_number?: string | undefined;
518
- quantity?: number | undefined;
519
- description?: string | undefined;
520
- line_total?: number | undefined;
521
- }[] | undefined;
522
- } | undefined;
523
523
  contact_name?: string | undefined;
524
524
  };
525
525
  }>;