mailmeteor 0.0.3 → 0.0.5

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 (58) hide show
  1. package/dist/index.cjs +431 -137
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.ts +1637 -481
  4. package/dist/index.mjs +431 -137
  5. package/dist/index.mjs.map +1 -1
  6. package/dist/types/generated-sdk/client/client.gen.d.ts.map +1 -1
  7. package/dist/types/generated-sdk/client/types.gen.d.ts.map +1 -1
  8. package/dist/types/generated-sdk/client/utils.gen.d.ts.map +1 -1
  9. package/dist/types/generated-sdk/core/auth.gen.d.ts.map +1 -1
  10. package/dist/types/generated-sdk/core/bodySerializer.gen.d.ts.map +1 -1
  11. package/dist/types/generated-sdk/core/params.gen.d.ts.map +1 -1
  12. package/dist/types/generated-sdk/core/pathSerializer.gen.d.ts.map +1 -1
  13. package/dist/types/generated-sdk/core/queryKeySerializer.gen.d.ts.map +1 -1
  14. package/dist/types/generated-sdk/core/serverSentEvents.gen.d.ts.map +1 -1
  15. package/dist/types/generated-sdk/core/types.gen.d.ts.map +1 -1
  16. package/dist/types/generated-sdk/core/utils.gen.d.ts.map +1 -1
  17. package/dist/types/generated-sdk/index.d.ts +2 -2
  18. package/dist/types/generated-sdk/index.d.ts.map +1 -1
  19. package/dist/types/generated-sdk/sdk.gen.d.ts +189 -71
  20. package/dist/types/generated-sdk/sdk.gen.d.ts.map +1 -1
  21. package/dist/types/generated-sdk/types.gen.d.ts +1393 -467
  22. package/dist/types/generated-sdk/types.gen.d.ts.map +1 -1
  23. package/dist/types/index.d.ts +5 -1
  24. package/dist/types/index.d.ts.map +1 -1
  25. package/package.json +1 -1
  26. package/dist/generated-sdk/client/client.gen.d.ts +0 -3
  27. package/dist/generated-sdk/client/client.gen.d.ts.map +0 -1
  28. package/dist/generated-sdk/client/index.d.ts +0 -9
  29. package/dist/generated-sdk/client/index.d.ts.map +0 -1
  30. package/dist/generated-sdk/client/types.gen.d.ts +0 -118
  31. package/dist/generated-sdk/client/types.gen.d.ts.map +0 -1
  32. package/dist/generated-sdk/client/utils.gen.d.ts +0 -34
  33. package/dist/generated-sdk/client/utils.gen.d.ts.map +0 -1
  34. package/dist/generated-sdk/client.gen.d.ts +0 -13
  35. package/dist/generated-sdk/client.gen.d.ts.map +0 -1
  36. package/dist/generated-sdk/core/auth.gen.d.ts +0 -19
  37. package/dist/generated-sdk/core/auth.gen.d.ts.map +0 -1
  38. package/dist/generated-sdk/core/bodySerializer.gen.d.ts +0 -26
  39. package/dist/generated-sdk/core/bodySerializer.gen.d.ts.map +0 -1
  40. package/dist/generated-sdk/core/params.gen.d.ts +0 -44
  41. package/dist/generated-sdk/core/params.gen.d.ts.map +0 -1
  42. package/dist/generated-sdk/core/pathSerializer.gen.d.ts +0 -34
  43. package/dist/generated-sdk/core/pathSerializer.gen.d.ts.map +0 -1
  44. package/dist/generated-sdk/core/queryKeySerializer.gen.d.ts +0 -19
  45. package/dist/generated-sdk/core/queryKeySerializer.gen.d.ts.map +0 -1
  46. package/dist/generated-sdk/core/serverSentEvents.gen.d.ts +0 -72
  47. package/dist/generated-sdk/core/serverSentEvents.gen.d.ts.map +0 -1
  48. package/dist/generated-sdk/core/types.gen.d.ts +0 -79
  49. package/dist/generated-sdk/core/types.gen.d.ts.map +0 -1
  50. package/dist/generated-sdk/core/utils.gen.d.ts +0 -20
  51. package/dist/generated-sdk/core/utils.gen.d.ts.map +0 -1
  52. package/dist/generated-sdk/index.d.ts +0 -4
  53. package/dist/generated-sdk/index.d.ts.map +0 -1
  54. package/dist/generated-sdk/sdk.gen.d.ts +0 -112
  55. package/dist/generated-sdk/sdk.gen.d.ts.map +0 -1
  56. package/dist/generated-sdk/types.gen.d.ts +0 -426
  57. package/dist/generated-sdk/types.gen.d.ts.map +0 -1
  58. package/dist/index.d.ts.map +0 -1
@@ -14,6 +14,389 @@ export type ErrorResponse = {
14
14
  message: string;
15
15
  code?: 'url_invalid' | 'authentication_required' | 'rate_limit' | 'resource_missing' | 'resource_conflict' | 'resource_exhausted' | 'resource_already_exists' | 'resource_action_required' | 'account_verification_required' | 'account_unauthorized' | 'account_blocked' | 'parameter_missing' | 'parameter_invalid' | 'esp_unsupported' | 'unknown_error' | 'api_error' | 'quota_exceeded' | 'sender_missing_service' | 'sender_insufficient_permission' | 'admin_role_required' | 'TEST_ERROR';
16
16
  };
17
+ export type CurrentOrganizationParams = {
18
+ user_id: string;
19
+ };
20
+ export type CurrentOrganizationResponse200 = {
21
+ current_organization_id: string | null;
22
+ };
23
+ export type CurrentOrganizationBody = {
24
+ organization_id?: string | null;
25
+ };
26
+ export type WatchMailboxBody = {
27
+ provider?: 'gmail' | 'outlook';
28
+ force?: boolean;
29
+ };
30
+ export type WatchMailboxParams = {
31
+ user_id: string;
32
+ };
33
+ export type ActionIdParams = {
34
+ user_id: string;
35
+ action_id: string;
36
+ };
37
+ export type MembersQuery = {
38
+ limit?: number;
39
+ starting_after?: string;
40
+ };
41
+ export type MembersParams = {
42
+ organization_id: string;
43
+ };
44
+ export type MembersResponse200 = Array<{
45
+ email: string;
46
+ name?: string;
47
+ profile_picture_url?: string;
48
+ role: 'admin' | 'member';
49
+ /**
50
+ * Creation date
51
+ */
52
+ created_at: string;
53
+ /**
54
+ * Last Update date
55
+ */
56
+ updated_at?: string;
57
+ id: string;
58
+ organization_id: string;
59
+ object: 'organization_member';
60
+ }>;
61
+ export type MembersBody = {
62
+ email: string;
63
+ role: 'admin' | 'member';
64
+ };
65
+ export type MembersResponse201 = {
66
+ email: string;
67
+ name?: string;
68
+ profile_picture_url?: string;
69
+ role: 'admin' | 'member';
70
+ /**
71
+ * Creation date
72
+ */
73
+ created_at: string;
74
+ /**
75
+ * Last Update date
76
+ */
77
+ updated_at?: string;
78
+ id: string;
79
+ organization_id: string;
80
+ object: 'organization_member';
81
+ };
82
+ export type MemberIdBody = {
83
+ role: 'admin' | 'member';
84
+ };
85
+ export type MemberIdParams = {
86
+ organization_id: string;
87
+ member_id: string;
88
+ };
89
+ export type MemberIdResponse200 = {
90
+ email: string;
91
+ name?: string;
92
+ profile_picture_url?: string;
93
+ role: 'admin' | 'member';
94
+ /**
95
+ * Creation date
96
+ */
97
+ created_at: string;
98
+ /**
99
+ * Last Update date
100
+ */
101
+ updated_at?: string;
102
+ id: string;
103
+ organization_id: string;
104
+ object: 'organization_member';
105
+ };
106
+ export type OrganizationsResponse200 = Array<{
107
+ name: string;
108
+ owner: string;
109
+ /**
110
+ * Creation date
111
+ */
112
+ created_at: string;
113
+ /**
114
+ * Last Update date
115
+ */
116
+ updated_at?: string;
117
+ id: string;
118
+ object: 'organization';
119
+ }>;
120
+ export type OrganizationsBody = {
121
+ name: string;
122
+ };
123
+ export type OrganizationsResponse201 = {
124
+ name: string;
125
+ owner: string;
126
+ /**
127
+ * Creation date
128
+ */
129
+ created_at: string;
130
+ /**
131
+ * Last Update date
132
+ */
133
+ updated_at?: string;
134
+ id: string;
135
+ object: 'organization';
136
+ };
137
+ export type OrganizationIdParams = {
138
+ organization_id: string;
139
+ };
140
+ export type OrganizationIdResponse200 = {
141
+ name: string;
142
+ owner: string;
143
+ /**
144
+ * Creation date
145
+ */
146
+ created_at: string;
147
+ /**
148
+ * Last Update date
149
+ */
150
+ updated_at?: string;
151
+ id: string;
152
+ object: 'organization';
153
+ };
154
+ export type OrganizationIdBody = {
155
+ name?: string;
156
+ };
157
+ export type ContactListsBody = {
158
+ owner: string;
159
+ name: string;
160
+ metadata?: {
161
+ [key: string]: string;
162
+ };
163
+ };
164
+ export type ContactListsResponse201 = {
165
+ owner: string;
166
+ name: string;
167
+ created_at: number;
168
+ updated_at?: number;
169
+ deleted?: boolean;
170
+ deleted_at?: number;
171
+ metadata?: {
172
+ [key: string]: string;
173
+ };
174
+ id: string;
175
+ object: 'contact_list';
176
+ };
177
+ export type ContactListIdParams = {
178
+ contact_list_id: string;
179
+ };
180
+ export type ContactListIdResponse200 = {
181
+ owner: string;
182
+ name: string;
183
+ created_at: number;
184
+ updated_at?: number;
185
+ deleted?: boolean;
186
+ deleted_at?: number;
187
+ metadata?: {
188
+ [key: string]: string;
189
+ };
190
+ id: string;
191
+ object: 'contact_list';
192
+ };
193
+ export type ContactListIdBody = {
194
+ remove_contacts?: boolean;
195
+ };
196
+ export type ContactsBody = {
197
+ owner: string;
198
+ contact_list?: string;
199
+ };
200
+ export type ContactsResponse201 = {
201
+ owner: string;
202
+ email: string;
203
+ domain: string;
204
+ created_at: number;
205
+ updated_at?: number;
206
+ deleted?: boolean;
207
+ deleted_at?: number;
208
+ blocked?: boolean;
209
+ blocked_at?: number;
210
+ unsubscribed?: boolean;
211
+ unsubscribed_at?: number;
212
+ contact_lists?: Array<string>;
213
+ properties?: {
214
+ [key: string]: string;
215
+ };
216
+ notes?: string;
217
+ metadata?: {
218
+ [key: string]: string;
219
+ };
220
+ id: string;
221
+ object: 'contact';
222
+ };
223
+ export type BatchBody = {
224
+ contacts: Array<{
225
+ owner: string;
226
+ email: string;
227
+ blocked?: boolean;
228
+ unsubscribed?: boolean;
229
+ contact_lists?: Array<string>;
230
+ properties?: {
231
+ [key: string]: string;
232
+ };
233
+ notes?: string;
234
+ metadata?: {
235
+ [key: string]: string;
236
+ };
237
+ }>;
238
+ };
239
+ export type BatchResponse201 = {
240
+ ok: true;
241
+ status: 'done';
242
+ message: string;
243
+ };
244
+ export type BatchResponse202 = {
245
+ ok: true;
246
+ status: 'running';
247
+ message: string;
248
+ };
249
+ export type BatchLegacyBody = unknown;
250
+ export type BatchLegacyResponse201 = unknown;
251
+ export type ContactIdParams = {
252
+ contact_id: string;
253
+ };
254
+ export type ContactIdResponse200 = {
255
+ owner: string;
256
+ email: string;
257
+ domain: string;
258
+ created_at: number;
259
+ updated_at?: number;
260
+ deleted?: boolean;
261
+ deleted_at?: number;
262
+ blocked?: boolean;
263
+ blocked_at?: number;
264
+ unsubscribed?: boolean;
265
+ unsubscribed_at?: number;
266
+ contact_lists?: Array<string>;
267
+ properties?: {
268
+ [key: string]: string;
269
+ };
270
+ notes?: string;
271
+ metadata?: {
272
+ [key: string]: string;
273
+ };
274
+ id: string;
275
+ object: 'contact';
276
+ };
277
+ export type ContactIdBody = {
278
+ blocked?: boolean;
279
+ unsubscribed?: boolean;
280
+ contact_lists?: Array<string>;
281
+ properties?: {
282
+ [key: string]: string;
283
+ };
284
+ notes?: string;
285
+ metadata?: {
286
+ [key: string]: string;
287
+ };
288
+ };
289
+ export type BlockParams = {
290
+ contact_id: string;
291
+ };
292
+ export type BlockResponse200 = {
293
+ owner: string;
294
+ email: string;
295
+ domain: string;
296
+ created_at: number;
297
+ updated_at?: number;
298
+ deleted?: boolean;
299
+ deleted_at?: number;
300
+ blocked?: boolean;
301
+ blocked_at?: number;
302
+ unsubscribed?: boolean;
303
+ unsubscribed_at?: number;
304
+ contact_lists?: Array<string>;
305
+ properties?: {
306
+ [key: string]: string;
307
+ };
308
+ notes?: string;
309
+ metadata?: {
310
+ [key: string]: string;
311
+ };
312
+ id: string;
313
+ object: 'contact';
314
+ };
315
+ export type UnblockParams = {
316
+ contact_id: string;
317
+ };
318
+ export type UnblockResponse200 = {
319
+ owner: string;
320
+ email: string;
321
+ domain: string;
322
+ created_at: number;
323
+ updated_at?: number;
324
+ deleted?: boolean;
325
+ deleted_at?: number;
326
+ blocked?: boolean;
327
+ blocked_at?: number;
328
+ unsubscribed?: boolean;
329
+ unsubscribed_at?: number;
330
+ contact_lists?: Array<string>;
331
+ properties?: {
332
+ [key: string]: string;
333
+ };
334
+ notes?: string;
335
+ metadata?: {
336
+ [key: string]: string;
337
+ };
338
+ id: string;
339
+ object: 'contact';
340
+ };
341
+ export type ResubscribeParams = {
342
+ contact_id: string;
343
+ };
344
+ export type ResubscribeResponse200 = {
345
+ owner: string;
346
+ email: string;
347
+ domain: string;
348
+ created_at: number;
349
+ updated_at?: number;
350
+ deleted?: boolean;
351
+ deleted_at?: number;
352
+ blocked?: boolean;
353
+ blocked_at?: number;
354
+ unsubscribed?: boolean;
355
+ unsubscribed_at?: number;
356
+ contact_lists?: Array<string>;
357
+ properties?: {
358
+ [key: string]: string;
359
+ };
360
+ notes?: string;
361
+ metadata?: {
362
+ [key: string]: string;
363
+ };
364
+ id: string;
365
+ object: 'contact';
366
+ };
367
+ export type ContactsQuery = {
368
+ owner: string;
369
+ limit?: number;
370
+ email?: string;
371
+ unsubscribed?: boolean | null;
372
+ contact_list?: string;
373
+ };
374
+ export type ContactsResponse200 = {
375
+ object: 'list';
376
+ data: Array<{
377
+ owner: string;
378
+ email: string;
379
+ domain: string;
380
+ created_at: number;
381
+ updated_at?: number;
382
+ deleted?: boolean;
383
+ deleted_at?: number;
384
+ blocked?: boolean;
385
+ blocked_at?: number;
386
+ unsubscribed?: boolean;
387
+ unsubscribed_at?: number;
388
+ contact_lists?: Array<string>;
389
+ properties?: {
390
+ [key: string]: string;
391
+ };
392
+ notes?: string;
393
+ metadata?: {
394
+ [key: string]: string;
395
+ };
396
+ id: string;
397
+ object: 'contact';
398
+ }>;
399
+ };
17
400
  export type AddonsResponse200 = {
18
401
  senders?: {
19
402
  included_per_seat: number;
@@ -112,471 +495,252 @@ export type PricesResponse200 = {
112
495
  year: number;
113
496
  };
114
497
  };
115
- export type CurrentResponse200 = {
116
- current_organization_id: string | null;
117
- };
118
- export type CurrentBody = {
119
- organization_id?: string | null;
498
+ export type OpenapiJsonResponse200 = unknown;
499
+ export type UsersGetCurrentOrganizationData = {
500
+ body?: never;
501
+ path: {
502
+ userId: string;
503
+ };
504
+ query?: never;
505
+ url: '/users/{userId}/current_organization';
120
506
  };
121
- export type OrganizationsResponse200 = Array<{
122
- name: string;
123
- owner: string;
507
+ export type UsersGetCurrentOrganizationErrors = {
124
508
  /**
125
- * Creation date
509
+ * Error response
126
510
  */
127
- created_at: string;
511
+ default: ErrorResponse;
512
+ };
513
+ export type UsersGetCurrentOrganizationError = UsersGetCurrentOrganizationErrors[keyof UsersGetCurrentOrganizationErrors];
514
+ export type UsersGetCurrentOrganizationResponses = {
128
515
  /**
129
- * Last Update date
516
+ * Response
130
517
  */
131
- updated_at?: string;
132
- id: string;
133
- object: 'organization';
134
- }>;
135
- export type OrganizationsBody = {
136
- name: string;
518
+ 200: {
519
+ current_organization_id: string | null;
520
+ };
137
521
  };
138
- export type OrganizationsResponse201 = {
139
- name: string;
140
- owner: string;
522
+ export type UsersGetCurrentOrganizationResponse = UsersGetCurrentOrganizationResponses[keyof UsersGetCurrentOrganizationResponses];
523
+ export type UsersSetCurrentOrganizationData = {
524
+ body?: {
525
+ organization_id?: string | null;
526
+ };
527
+ path: {
528
+ user_id: string;
529
+ };
530
+ query?: never;
531
+ url: '/users/{user_id}/current_organization';
532
+ };
533
+ export type UsersSetCurrentOrganizationErrors = {
141
534
  /**
142
- * Creation date
535
+ * Error response
143
536
  */
144
- created_at: string;
537
+ default: ErrorResponse;
538
+ };
539
+ export type UsersSetCurrentOrganizationError = UsersSetCurrentOrganizationErrors[keyof UsersSetCurrentOrganizationErrors];
540
+ export type UsersSetCurrentOrganizationResponses = {
145
541
  /**
146
- * Last Update date
542
+ * Response
147
543
  */
148
- updated_at?: string;
149
- id: string;
150
- object: 'organization';
151
- };
152
- export type OrganizationIdParams = {
153
- organization_id: string;
544
+ 200: {
545
+ current_organization_id: string | null;
546
+ };
154
547
  };
155
- export type OrganizationIdResponse200 = {
156
- name: string;
157
- owner: string;
158
- /**
159
- * Creation date
160
- */
161
- created_at: string;
162
- /**
163
- * Last Update date
164
- */
165
- updated_at?: string;
166
- id: string;
167
- object: 'organization';
168
- };
169
- export type OrganizationIdBody = {
170
- name?: string;
171
- };
172
- export type MembersQuery = {
173
- limit?: number;
174
- starting_after?: string;
175
- };
176
- export type MembersParams = {
177
- organization_id: string;
548
+ export type UsersSetCurrentOrganizationResponse = UsersSetCurrentOrganizationResponses[keyof UsersSetCurrentOrganizationResponses];
549
+ export type UsersWatchMailboxData = {
550
+ body?: {
551
+ provider?: 'gmail' | 'outlook';
552
+ force?: boolean;
553
+ };
554
+ path: {
555
+ user_id: string;
556
+ };
557
+ query?: never;
558
+ url: '/users/{user_id}/watch_mailbox';
178
559
  };
179
- export type MembersResponse200 = Array<{
180
- email: string;
181
- name?: string;
182
- profile_picture_url?: string;
183
- role: 'admin' | 'member';
184
- /**
185
- * Creation date
186
- */
187
- created_at: string;
560
+ export type UsersWatchMailboxErrors = {
188
561
  /**
189
- * Last Update date
562
+ * Error response
190
563
  */
191
- updated_at?: string;
192
- id: string;
193
- organization_id: string;
194
- object: 'organization_member';
195
- }>;
196
- export type MembersBody = {
197
- email: string;
198
- role: 'admin' | 'member';
564
+ default: ErrorResponse;
199
565
  };
200
- export type MembersResponse201 = {
201
- email: string;
202
- name?: string;
203
- profile_picture_url?: string;
204
- role: 'admin' | 'member';
205
- /**
206
- * Creation date
207
- */
208
- created_at: string;
566
+ export type UsersWatchMailboxError = UsersWatchMailboxErrors[keyof UsersWatchMailboxErrors];
567
+ export type UsersWatchMailboxResponses = {
209
568
  /**
210
- * Last Update date
569
+ * Response
211
570
  */
212
- updated_at?: string;
213
- id: string;
214
- organization_id: string;
215
- object: 'organization_member';
216
- };
217
- export type MemberIdBody = {
218
- role: 'admin' | 'member';
571
+ 204: void;
219
572
  };
220
- export type MemberIdParams = {
221
- organization_id: string;
222
- member_id: string;
573
+ export type UsersWatchMailboxResponse = UsersWatchMailboxResponses[keyof UsersWatchMailboxResponses];
574
+ export type UsersDeleteActionData = {
575
+ body?: never;
576
+ path: {
577
+ user_id: string;
578
+ action_id: string;
579
+ };
580
+ query?: never;
581
+ url: '/users/{user_id}/actions/{action_id}';
223
582
  };
224
- export type MemberIdResponse200 = {
225
- email: string;
226
- name?: string;
227
- profile_picture_url?: string;
228
- role: 'admin' | 'member';
583
+ export type UsersDeleteActionErrors = {
229
584
  /**
230
- * Creation date
585
+ * Error response
231
586
  */
232
- created_at: string;
587
+ default: ErrorResponse;
588
+ };
589
+ export type UsersDeleteActionError = UsersDeleteActionErrors[keyof UsersDeleteActionErrors];
590
+ export type UsersDeleteActionResponses = {
233
591
  /**
234
- * Last Update date
592
+ * Response
235
593
  */
236
- updated_at?: string;
237
- id: string;
238
- organization_id: string;
239
- object: 'organization_member';
594
+ 204: void;
240
595
  };
241
- export type OpenapiJsonResponse200 = unknown;
242
- export type BillingAddonsGetAddonsData = {
596
+ export type UsersDeleteActionResponse = UsersDeleteActionResponses[keyof UsersDeleteActionResponses];
597
+ export type OrganizationMemberListData = {
243
598
  body?: never;
244
- path?: never;
245
- query?: never;
246
- url: '/billing/addons';
599
+ path: {
600
+ organization_id: string;
601
+ };
602
+ query?: {
603
+ limit?: number;
604
+ starting_after?: string;
605
+ };
606
+ url: '/organizations/{organization_id}/members';
247
607
  };
248
- export type BillingAddonsGetAddonsErrors = {
608
+ export type OrganizationMemberListErrors = {
249
609
  /**
250
610
  * Error response
251
611
  */
252
612
  default: ErrorResponse;
253
613
  };
254
- export type BillingAddonsGetAddonsError = BillingAddonsGetAddonsErrors[keyof BillingAddonsGetAddonsErrors];
255
- export type BillingAddonsGetAddonsResponses = {
614
+ export type OrganizationMemberListError = OrganizationMemberListErrors[keyof OrganizationMemberListErrors];
615
+ export type OrganizationMemberListResponses = {
256
616
  /**
257
617
  * Response
258
618
  */
259
- 200: {
260
- senders?: {
261
- included_per_seat: number;
262
- included_total: number;
263
- used: number;
264
- extra: {
265
- price_amount: number;
266
- currency: string;
267
- quantity_per_addon: number;
268
- interval: 'day' | 'week' | 'month' | 'year';
269
- subscribed: number;
270
- } | null;
271
- };
272
- email_warmups?: {
273
- included_per_seat: number;
274
- included_total: number;
275
- used: number;
276
- extra: {
277
- price_amount: number;
278
- currency: string;
279
- quantity_per_addon: number;
280
- interval: 'day' | 'week' | 'month' | 'year';
281
- subscribed: number;
282
- } | null;
283
- };
284
- };
619
+ 200: Array<{
620
+ email: string;
621
+ name?: string;
622
+ profile_picture_url?: string;
623
+ role: 'admin' | 'member';
624
+ /**
625
+ * Creation date
626
+ */
627
+ created_at: string;
628
+ /**
629
+ * Last Update date
630
+ */
631
+ updated_at?: string;
632
+ id: string;
633
+ organization_id: string;
634
+ object: 'organization_member';
635
+ }>;
285
636
  };
286
- export type BillingAddonsGetAddonsResponse = BillingAddonsGetAddonsResponses[keyof BillingAddonsGetAddonsResponses];
287
- export type BillingAddonsPreviewUpdateData = {
637
+ export type OrganizationMemberListResponse = OrganizationMemberListResponses[keyof OrganizationMemberListResponses];
638
+ export type OrganizationMemberCreateData = {
288
639
  body?: {
289
- quantity: number;
640
+ email: string;
641
+ role: 'admin' | 'member';
290
642
  };
291
643
  path: {
292
- addon: 'senders' | 'email_warmups';
644
+ organization_id: string;
293
645
  };
294
646
  query?: never;
295
- url: '/billing/addons/{addon}/preview';
647
+ url: '/organizations/{organization_id}/members';
296
648
  };
297
- export type BillingAddonsPreviewUpdateErrors = {
649
+ export type OrganizationMemberCreateErrors = {
298
650
  /**
299
651
  * Error response
300
652
  */
301
653
  default: ErrorResponse;
302
654
  };
303
- export type BillingAddonsPreviewUpdateError = BillingAddonsPreviewUpdateErrors[keyof BillingAddonsPreviewUpdateErrors];
304
- export type BillingAddonsPreviewUpdateResponses = {
655
+ export type OrganizationMemberCreateError = OrganizationMemberCreateErrors[keyof OrganizationMemberCreateErrors];
656
+ export type OrganizationMemberCreateResponses = {
305
657
  /**
306
658
  * Response
307
659
  */
308
- 200: {
309
- discount_percents: Array<number>;
310
- total_excluding_tax: number;
311
- total: number;
312
- amount_due: number;
313
- added_from_balance: number;
314
- consumed_balance: number;
315
- credited_to_balance: number;
660
+ 201: {
661
+ email: string;
662
+ name?: string;
663
+ profile_picture_url?: string;
664
+ role: 'admin' | 'member';
665
+ /**
666
+ * Creation date
667
+ */
668
+ created_at: string;
669
+ /**
670
+ * Last Update date
671
+ */
672
+ updated_at?: string;
673
+ id: string;
674
+ organization_id: string;
675
+ object: 'organization_member';
316
676
  };
317
677
  };
318
- export type BillingAddonsPreviewUpdateResponse = BillingAddonsPreviewUpdateResponses[keyof BillingAddonsPreviewUpdateResponses];
319
- export type BillingAddonsGetAddonUsagesData = {
678
+ export type OrganizationMemberCreateResponse = OrganizationMemberCreateResponses[keyof OrganizationMemberCreateResponses];
679
+ export type OrganizationMemberDeleteData = {
320
680
  body?: never;
321
681
  path: {
322
- addon: 'senders' | 'email_warmups';
682
+ organization_id: string;
683
+ member_id: string;
323
684
  };
324
685
  query?: never;
325
- url: '/billing/addons/{addon}';
686
+ url: '/organizations/{organization_id}/members/{member_id}';
326
687
  };
327
- export type BillingAddonsGetAddonUsagesErrors = {
688
+ export type OrganizationMemberDeleteErrors = {
328
689
  /**
329
690
  * Error response
330
691
  */
331
692
  default: ErrorResponse;
332
693
  };
333
- export type BillingAddonsGetAddonUsagesError = BillingAddonsGetAddonUsagesErrors[keyof BillingAddonsGetAddonUsagesErrors];
334
- export type BillingAddonsGetAddonUsagesResponses = {
694
+ export type OrganizationMemberDeleteError = OrganizationMemberDeleteErrors[keyof OrganizationMemberDeleteErrors];
695
+ export type OrganizationMemberDeleteResponses = {
335
696
  /**
336
697
  * Response
337
698
  */
338
- 200: Array<{
339
- id: string;
340
- email: string;
341
- usage: number;
342
- }>;
699
+ 204: void;
343
700
  };
344
- export type BillingAddonsGetAddonUsagesResponse = BillingAddonsGetAddonUsagesResponses[keyof BillingAddonsGetAddonUsagesResponses];
345
- export type BillingAddonsUpdateData = {
701
+ export type OrganizationMemberDeleteResponse = OrganizationMemberDeleteResponses[keyof OrganizationMemberDeleteResponses];
702
+ export type OrganizationMemberUpdateData = {
346
703
  body?: {
347
- quantity: number;
704
+ role: 'admin' | 'member';
348
705
  };
349
706
  path: {
350
- addon: 'senders' | 'email_warmups';
707
+ organization_id: string;
708
+ member_id: string;
351
709
  };
352
710
  query?: never;
353
- url: '/billing/addons/{addon}';
711
+ url: '/organizations/{organization_id}/members/{member_id}';
354
712
  };
355
- export type BillingAddonsUpdateErrors = {
713
+ export type OrganizationMemberUpdateErrors = {
356
714
  /**
357
715
  * Error response
358
716
  */
359
717
  default: ErrorResponse;
360
718
  };
361
- export type BillingAddonsUpdateError = BillingAddonsUpdateErrors[keyof BillingAddonsUpdateErrors];
362
- export type BillingAddonsUpdateResponses = {
719
+ export type OrganizationMemberUpdateError = OrganizationMemberUpdateErrors[keyof OrganizationMemberUpdateErrors];
720
+ export type OrganizationMemberUpdateResponses = {
363
721
  /**
364
722
  * Response
365
723
  */
366
724
  200: {
367
- status: 'confirmation_required' | 'success' | 'payment_failed';
368
- client_secret?: string;
369
- failure_code?: string;
725
+ email: string;
726
+ name?: string;
727
+ profile_picture_url?: string;
728
+ role: 'admin' | 'member';
729
+ /**
730
+ * Creation date
731
+ */
732
+ created_at: string;
733
+ /**
734
+ * Last Update date
735
+ */
736
+ updated_at?: string;
737
+ id: string;
738
+ organization_id: string;
739
+ object: 'organization_member';
370
740
  };
371
741
  };
372
- export type BillingAddonsUpdateResponse = BillingAddonsUpdateResponses[keyof BillingAddonsUpdateResponses];
373
- export type BillingSubscriptionGetData = {
374
- body?: never;
375
- path?: never;
376
- query?: never;
377
- url: '/billing/subscription';
378
- };
379
- export type BillingSubscriptionGetErrors = {
380
- /**
381
- * Error response
382
- */
383
- default: ErrorResponse;
384
- };
385
- export type BillingSubscriptionGetError = BillingSubscriptionGetErrors[keyof BillingSubscriptionGetErrors];
386
- export type BillingSubscriptionGetResponses = {
387
- /**
388
- * Response
389
- */
390
- 200: {
391
- id: string;
392
- created_at: number;
393
- current_period_start: number;
394
- current_period_end: number;
395
- quantity: number;
396
- currency: string;
397
- amount: number | null;
398
- discount_percentage?: number | null;
399
- name: string | null;
400
- billing_period: 'day' | 'week' | 'month' | 'year' | null;
401
- plan: 'free' | 'starter' | 'pro' | 'premium' | 'business' | null;
402
- default_payment_method: {
403
- type: string;
404
- brand?: string | null;
405
- last4: string | null;
406
- exp_month: number | null;
407
- exp_year: number | null;
408
- bank_name?: string | null;
409
- } | null;
410
- addons: {
411
- senders?: {
412
- quantity: number;
413
- };
414
- email_warmups?: {
415
- quantity: number;
416
- };
417
- };
418
- } | null;
419
- };
420
- export type BillingSubscriptionGetResponse = BillingSubscriptionGetResponses[keyof BillingSubscriptionGetResponses];
421
- export type BillingSubscriptionUpdateData = {
422
- body?: {
423
- plan: 'free' | 'starter' | 'pro' | 'premium' | 'business';
424
- billing_period: 'month' | 'year';
425
- };
426
- path?: never;
427
- query?: never;
428
- url: '/billing/subscription';
429
- };
430
- export type BillingSubscriptionUpdateErrors = {
431
- /**
432
- * Error response
433
- */
434
- default: ErrorResponse;
435
- };
436
- export type BillingSubscriptionUpdateError = BillingSubscriptionUpdateErrors[keyof BillingSubscriptionUpdateErrors];
437
- export type BillingSubscriptionUpdateResponses = {
438
- /**
439
- * Response
440
- */
441
- 200: {
442
- status: 'confirmation_required' | 'success' | 'payment_failed';
443
- client_secret?: string;
444
- failure_code?: string;
445
- };
446
- };
447
- export type BillingSubscriptionUpdateResponse = BillingSubscriptionUpdateResponses[keyof BillingSubscriptionUpdateResponses];
448
- export type BillingSubscriptionPreviewUpdateData = {
449
- body?: {
450
- plan: 'free' | 'starter' | 'pro' | 'premium' | 'business';
451
- billing_period: 'month' | 'year';
452
- };
453
- path?: never;
454
- query?: never;
455
- url: '/billing/subscription/preview';
456
- };
457
- export type BillingSubscriptionPreviewUpdateErrors = {
458
- /**
459
- * Error response
460
- */
461
- default: ErrorResponse;
462
- };
463
- export type BillingSubscriptionPreviewUpdateError = BillingSubscriptionPreviewUpdateErrors[keyof BillingSubscriptionPreviewUpdateErrors];
464
- export type BillingSubscriptionPreviewUpdateResponses = {
465
- /**
466
- * Response
467
- */
468
- 200: {
469
- discount_percents: Array<number>;
470
- total_excluding_tax: number;
471
- total: number;
472
- amount_due: number;
473
- added_from_balance: number;
474
- consumed_balance: number;
475
- credited_to_balance: number;
476
- lines: Array<{
477
- amount: number;
478
- billing_period: 'day' | 'week' | 'month' | 'year';
479
- proration: boolean;
480
- plan?: 'free' | 'starter' | 'pro' | 'premium' | 'business';
481
- addon?: 'senders' | 'email_warmups';
482
- }>;
483
- next_renewal: number;
484
- total_tax_amounts: Array<{
485
- amount: number;
486
- }>;
487
- };
488
- };
489
- export type BillingSubscriptionPreviewUpdateResponse = BillingSubscriptionPreviewUpdateResponses[keyof BillingSubscriptionPreviewUpdateResponses];
490
- export type BillingGetPricesData = {
491
- body?: never;
492
- path?: never;
493
- query: {
494
- currency: string;
495
- };
496
- url: '/billing/prices';
497
- };
498
- export type BillingGetPricesErrors = {
499
- /**
500
- * Error response
501
- */
502
- default: ErrorResponse;
503
- };
504
- export type BillingGetPricesError = BillingGetPricesErrors[keyof BillingGetPricesErrors];
505
- export type BillingGetPricesResponses = {
506
- /**
507
- * Response
508
- */
509
- 200: {
510
- free?: {
511
- month: number;
512
- year: number;
513
- };
514
- starter?: {
515
- month: number;
516
- year: number;
517
- };
518
- pro?: {
519
- month: number;
520
- year: number;
521
- };
522
- premium?: {
523
- month: number;
524
- year: number;
525
- };
526
- business?: {
527
- month: number;
528
- year: number;
529
- };
530
- };
531
- };
532
- export type BillingGetPricesResponse = BillingGetPricesResponses[keyof BillingGetPricesResponses];
533
- export type OrganizationGetCurrentData = {
534
- body?: never;
535
- path?: never;
536
- query?: never;
537
- url: '/organizations/current';
538
- };
539
- export type OrganizationGetCurrentErrors = {
540
- /**
541
- * Error response
542
- */
543
- default: ErrorResponse;
544
- };
545
- export type OrganizationGetCurrentError = OrganizationGetCurrentErrors[keyof OrganizationGetCurrentErrors];
546
- export type OrganizationGetCurrentResponses = {
547
- /**
548
- * Response
549
- */
550
- 200: {
551
- current_organization_id: string | null;
552
- };
553
- };
554
- export type OrganizationGetCurrentResponse = OrganizationGetCurrentResponses[keyof OrganizationGetCurrentResponses];
555
- export type OrganizationSetCurrentData = {
556
- body?: {
557
- organization_id?: string | null;
558
- };
559
- path?: never;
560
- query?: never;
561
- url: '/organizations/current';
562
- };
563
- export type OrganizationSetCurrentErrors = {
564
- /**
565
- * Error response
566
- */
567
- default: ErrorResponse;
568
- };
569
- export type OrganizationSetCurrentError = OrganizationSetCurrentErrors[keyof OrganizationSetCurrentErrors];
570
- export type OrganizationSetCurrentResponses = {
571
- /**
572
- * Response
573
- */
574
- 200: {
575
- current_organization_id: string | null;
576
- };
577
- };
578
- export type OrganizationSetCurrentResponse = OrganizationSetCurrentResponses[keyof OrganizationSetCurrentResponses];
579
- export type OrganizationListData = {
742
+ export type OrganizationMemberUpdateResponse = OrganizationMemberUpdateResponses[keyof OrganizationMemberUpdateResponses];
743
+ export type OrganizationListData = {
580
744
  body?: never;
581
745
  path?: never;
582
746
  query?: never;
@@ -738,152 +902,914 @@ export type OrganizationUpdateResponses = {
738
902
  };
739
903
  };
740
904
  export type OrganizationUpdateResponse = OrganizationUpdateResponses[keyof OrganizationUpdateResponses];
741
- export type OrganizationMemberListData = {
742
- body?: never;
743
- path: {
744
- organization_id: string;
745
- };
746
- query?: {
747
- limit?: number;
748
- starting_after?: string;
905
+ export type ContactListsCreateData = {
906
+ body?: {
907
+ owner: string;
908
+ name: string;
909
+ metadata?: {
910
+ [key: string]: string;
911
+ };
749
912
  };
750
- url: '/organizations/{organization_id}/members';
913
+ path?: never;
914
+ query?: never;
915
+ url: '/contact_lists';
751
916
  };
752
- export type OrganizationMemberListErrors = {
917
+ export type ContactListsCreateErrors = {
753
918
  /**
754
919
  * Error response
755
920
  */
756
921
  default: ErrorResponse;
757
922
  };
758
- export type OrganizationMemberListError = OrganizationMemberListErrors[keyof OrganizationMemberListErrors];
759
- export type OrganizationMemberListResponses = {
923
+ export type ContactListsCreateError = ContactListsCreateErrors[keyof ContactListsCreateErrors];
924
+ export type ContactListsCreateResponses = {
760
925
  /**
761
926
  * Response
762
927
  */
763
- 200: Array<{
764
- email: string;
765
- name?: string;
766
- profile_picture_url?: string;
767
- role: 'admin' | 'member';
768
- /**
769
- * Creation date
770
- */
771
- created_at: string;
772
- /**
773
- * Last Update date
774
- */
775
- updated_at?: string;
928
+ 201: {
929
+ owner: string;
930
+ name: string;
931
+ created_at: number;
932
+ updated_at?: number;
933
+ deleted?: boolean;
934
+ deleted_at?: number;
935
+ metadata?: {
936
+ [key: string]: string;
937
+ };
776
938
  id: string;
777
- organization_id: string;
778
- object: 'organization_member';
779
- }>;
939
+ object: 'contact_list';
940
+ };
780
941
  };
781
- export type OrganizationMemberListResponse = OrganizationMemberListResponses[keyof OrganizationMemberListResponses];
782
- export type OrganizationMemberCreateData = {
942
+ export type ContactListsCreateResponse = ContactListsCreateResponses[keyof ContactListsCreateResponses];
943
+ export type ContactListsRemoveData = {
783
944
  body?: {
784
- email: string;
785
- role: 'admin' | 'member';
945
+ remove_contacts?: boolean;
786
946
  };
787
947
  path: {
788
- organization_id: string;
948
+ contact_list_id: string;
789
949
  };
790
950
  query?: never;
791
- url: '/organizations/{organization_id}/members';
951
+ url: '/contact_lists/{contact_list_id}';
792
952
  };
793
- export type OrganizationMemberCreateErrors = {
953
+ export type ContactListsRemoveErrors = {
794
954
  /**
795
955
  * Error response
796
956
  */
797
957
  default: ErrorResponse;
798
958
  };
799
- export type OrganizationMemberCreateError = OrganizationMemberCreateErrors[keyof OrganizationMemberCreateErrors];
800
- export type OrganizationMemberCreateResponses = {
959
+ export type ContactListsRemoveError = ContactListsRemoveErrors[keyof ContactListsRemoveErrors];
960
+ export type ContactListsRemoveResponses = {
801
961
  /**
802
962
  * Response
803
963
  */
804
- 201: {
805
- email: string;
806
- name?: string;
807
- profile_picture_url?: string;
808
- role: 'admin' | 'member';
809
- /**
810
- * Creation date
811
- */
812
- created_at: string;
813
- /**
814
- * Last Update date
815
- */
816
- updated_at?: string;
817
- id: string;
818
- organization_id: string;
819
- object: 'organization_member';
964
+ 200: {
965
+ owner: string;
966
+ name: string;
967
+ created_at: number;
968
+ updated_at?: number;
969
+ deleted?: boolean;
970
+ deleted_at?: number;
971
+ metadata?: {
972
+ [key: string]: string;
973
+ };
974
+ id: string;
975
+ object: 'contact_list';
820
976
  };
821
977
  };
822
- export type OrganizationMemberCreateResponse = OrganizationMemberCreateResponses[keyof OrganizationMemberCreateResponses];
823
- export type OrganizationMemberDeleteData = {
978
+ export type ContactListsRemoveResponse = ContactListsRemoveResponses[keyof ContactListsRemoveResponses];
979
+ export type ContactListsRetrieveData = {
824
980
  body?: never;
825
981
  path: {
826
- organization_id: string;
827
- member_id: string;
982
+ contact_list_id: string;
828
983
  };
829
984
  query?: never;
830
- url: '/organizations/{organization_id}/members/{member_id}';
985
+ url: '/contact_lists/{contact_list_id}';
831
986
  };
832
- export type OrganizationMemberDeleteErrors = {
987
+ export type ContactListsRetrieveErrors = {
833
988
  /**
834
989
  * Error response
835
990
  */
836
991
  default: ErrorResponse;
837
992
  };
838
- export type OrganizationMemberDeleteError = OrganizationMemberDeleteErrors[keyof OrganizationMemberDeleteErrors];
839
- export type OrganizationMemberDeleteResponses = {
993
+ export type ContactListsRetrieveError = ContactListsRetrieveErrors[keyof ContactListsRetrieveErrors];
994
+ export type ContactListsRetrieveResponses = {
995
+ /**
996
+ * Response
997
+ */
998
+ 200: {
999
+ owner: string;
1000
+ name: string;
1001
+ created_at: number;
1002
+ updated_at?: number;
1003
+ deleted?: boolean;
1004
+ deleted_at?: number;
1005
+ metadata?: {
1006
+ [key: string]: string;
1007
+ };
1008
+ id: string;
1009
+ object: 'contact_list';
1010
+ };
1011
+ };
1012
+ export type ContactListsRetrieveResponse = ContactListsRetrieveResponses[keyof ContactListsRetrieveResponses];
1013
+ export type ContactListsUpdateData = {
1014
+ body?: {
1015
+ name: string;
1016
+ metadata?: {
1017
+ [key: string]: string;
1018
+ };
1019
+ };
1020
+ path: {
1021
+ contact_list_id: string;
1022
+ };
1023
+ query?: never;
1024
+ url: '/contact_lists/{contact_list_id}';
1025
+ };
1026
+ export type ContactListsUpdateErrors = {
1027
+ /**
1028
+ * Error response
1029
+ */
1030
+ default: ErrorResponse;
1031
+ };
1032
+ export type ContactListsUpdateError = ContactListsUpdateErrors[keyof ContactListsUpdateErrors];
1033
+ export type ContactListsUpdateResponses = {
1034
+ /**
1035
+ * Response
1036
+ */
1037
+ 200: {
1038
+ owner: string;
1039
+ name: string;
1040
+ created_at: number;
1041
+ updated_at?: number;
1042
+ deleted?: boolean;
1043
+ deleted_at?: number;
1044
+ metadata?: {
1045
+ [key: string]: string;
1046
+ };
1047
+ id: string;
1048
+ object: 'contact_list';
1049
+ };
1050
+ };
1051
+ export type ContactListsUpdateResponse = ContactListsUpdateResponses[keyof ContactListsUpdateResponses];
1052
+ export type ContactsDelAllData = {
1053
+ body?: {
1054
+ owner: string;
1055
+ contact_list?: string;
1056
+ };
1057
+ path?: never;
1058
+ query?: never;
1059
+ url: '/contacts';
1060
+ };
1061
+ export type ContactsDelAllErrors = {
1062
+ /**
1063
+ * Error response
1064
+ */
1065
+ default: ErrorResponse;
1066
+ };
1067
+ export type ContactsDelAllError = ContactsDelAllErrors[keyof ContactsDelAllErrors];
1068
+ export type ContactsDelAllResponses = {
840
1069
  /**
841
1070
  * Response
842
1071
  */
843
1072
  204: void;
844
1073
  };
845
- export type OrganizationMemberDeleteResponse = OrganizationMemberDeleteResponses[keyof OrganizationMemberDeleteResponses];
846
- export type OrganizationMemberUpdateData = {
1074
+ export type ContactsDelAllResponse = ContactsDelAllResponses[keyof ContactsDelAllResponses];
1075
+ export type ContactsListData = {
1076
+ body?: never;
1077
+ path?: never;
1078
+ query: {
1079
+ owner: string;
1080
+ limit?: number;
1081
+ email?: string;
1082
+ unsubscribed?: boolean | null;
1083
+ contact_list?: string;
1084
+ };
1085
+ url: '/contacts';
1086
+ };
1087
+ export type ContactsListErrors = {
1088
+ /**
1089
+ * Error response
1090
+ */
1091
+ default: ErrorResponse;
1092
+ };
1093
+ export type ContactsListError = ContactsListErrors[keyof ContactsListErrors];
1094
+ export type ContactsListResponses = {
1095
+ /**
1096
+ * Response
1097
+ */
1098
+ 200: {
1099
+ object: 'list';
1100
+ data: Array<{
1101
+ owner: string;
1102
+ email: string;
1103
+ domain: string;
1104
+ created_at: number;
1105
+ updated_at?: number;
1106
+ deleted?: boolean;
1107
+ deleted_at?: number;
1108
+ blocked?: boolean;
1109
+ blocked_at?: number;
1110
+ unsubscribed?: boolean;
1111
+ unsubscribed_at?: number;
1112
+ contact_lists?: Array<string>;
1113
+ properties?: {
1114
+ [key: string]: string;
1115
+ };
1116
+ notes?: string;
1117
+ metadata?: {
1118
+ [key: string]: string;
1119
+ };
1120
+ id: string;
1121
+ object: 'contact';
1122
+ }>;
1123
+ };
1124
+ };
1125
+ export type ContactsListResponse = ContactsListResponses[keyof ContactsListResponses];
1126
+ export type ContactsCreateData = {
847
1127
  body?: {
848
- role: 'admin' | 'member';
1128
+ owner: string;
1129
+ email: string;
1130
+ blocked?: boolean;
1131
+ unsubscribed?: boolean;
1132
+ contact_lists?: Array<string>;
1133
+ properties?: {
1134
+ [key: string]: string;
1135
+ };
1136
+ notes?: string;
1137
+ metadata?: {
1138
+ [key: string]: string;
1139
+ };
1140
+ };
1141
+ path?: never;
1142
+ query?: never;
1143
+ url: '/contacts';
1144
+ };
1145
+ export type ContactsCreateErrors = {
1146
+ /**
1147
+ * Error response
1148
+ */
1149
+ default: ErrorResponse;
1150
+ };
1151
+ export type ContactsCreateError = ContactsCreateErrors[keyof ContactsCreateErrors];
1152
+ export type ContactsCreateResponses = {
1153
+ /**
1154
+ * Response
1155
+ */
1156
+ 201: {
1157
+ owner: string;
1158
+ email: string;
1159
+ domain: string;
1160
+ created_at: number;
1161
+ updated_at?: number;
1162
+ deleted?: boolean;
1163
+ deleted_at?: number;
1164
+ blocked?: boolean;
1165
+ blocked_at?: number;
1166
+ unsubscribed?: boolean;
1167
+ unsubscribed_at?: number;
1168
+ contact_lists?: Array<string>;
1169
+ properties?: {
1170
+ [key: string]: string;
1171
+ };
1172
+ notes?: string;
1173
+ metadata?: {
1174
+ [key: string]: string;
1175
+ };
1176
+ id: string;
1177
+ object: 'contact';
1178
+ };
1179
+ };
1180
+ export type ContactsCreateResponse = ContactsCreateResponses[keyof ContactsCreateResponses];
1181
+ export type ContactsBatchCreateData = {
1182
+ body?: {
1183
+ contacts: Array<{
1184
+ owner: string;
1185
+ email: string;
1186
+ blocked?: boolean;
1187
+ unsubscribed?: boolean;
1188
+ contact_lists?: Array<string>;
1189
+ properties?: {
1190
+ [key: string]: string;
1191
+ };
1192
+ notes?: string;
1193
+ metadata?: {
1194
+ [key: string]: string;
1195
+ };
1196
+ }>;
1197
+ };
1198
+ path?: never;
1199
+ query?: never;
1200
+ url: '/contacts/batch';
1201
+ };
1202
+ export type ContactsBatchCreateErrors = {
1203
+ /**
1204
+ * Error response
1205
+ */
1206
+ default: ErrorResponse;
1207
+ };
1208
+ export type ContactsBatchCreateError = ContactsBatchCreateErrors[keyof ContactsBatchCreateErrors];
1209
+ export type ContactsBatchCreateResponses = {
1210
+ /**
1211
+ * Response
1212
+ */
1213
+ 201: {
1214
+ ok: true;
1215
+ status: 'done';
1216
+ message: string;
1217
+ };
1218
+ /**
1219
+ * Response
1220
+ */
1221
+ 202: {
1222
+ ok: true;
1223
+ status: 'running';
1224
+ message: string;
849
1225
  };
1226
+ };
1227
+ export type ContactsBatchCreateResponse = ContactsBatchCreateResponses[keyof ContactsBatchCreateResponses];
1228
+ export type ContactsBatchCreate2Data = {
1229
+ body?: unknown;
1230
+ path?: never;
1231
+ query?: never;
1232
+ url: '/contacts/batch_legacy';
1233
+ };
1234
+ export type ContactsBatchCreate2Errors = {
1235
+ /**
1236
+ * Error response
1237
+ */
1238
+ default: ErrorResponse;
1239
+ };
1240
+ export type ContactsBatchCreate2Error = ContactsBatchCreate2Errors[keyof ContactsBatchCreate2Errors];
1241
+ export type ContactsBatchCreate2Responses = {
1242
+ /**
1243
+ * Response
1244
+ */
1245
+ 201: unknown;
1246
+ };
1247
+ export type ContactsDelData = {
1248
+ body?: never;
850
1249
  path: {
851
- organization_id: string;
852
- member_id: string;
1250
+ contact_id: string;
853
1251
  };
854
1252
  query?: never;
855
- url: '/organizations/{organization_id}/members/{member_id}';
1253
+ url: '/contacts/{contact_id}';
856
1254
  };
857
- export type OrganizationMemberUpdateErrors = {
1255
+ export type ContactsDelErrors = {
858
1256
  /**
859
1257
  * Error response
860
1258
  */
861
1259
  default: ErrorResponse;
862
1260
  };
863
- export type OrganizationMemberUpdateError = OrganizationMemberUpdateErrors[keyof OrganizationMemberUpdateErrors];
864
- export type OrganizationMemberUpdateResponses = {
1261
+ export type ContactsDelError = ContactsDelErrors[keyof ContactsDelErrors];
1262
+ export type ContactsDelResponses = {
865
1263
  /**
866
1264
  * Response
867
1265
  */
868
1266
  200: {
1267
+ owner: string;
869
1268
  email: string;
870
- name?: string;
871
- profile_picture_url?: string;
872
- role: 'admin' | 'member';
873
- /**
874
- * Creation date
875
- */
876
- created_at: string;
877
- /**
878
- * Last Update date
879
- */
880
- updated_at?: string;
1269
+ domain: string;
1270
+ created_at: number;
1271
+ updated_at?: number;
1272
+ deleted?: boolean;
1273
+ deleted_at?: number;
1274
+ blocked?: boolean;
1275
+ blocked_at?: number;
1276
+ unsubscribed?: boolean;
1277
+ unsubscribed_at?: number;
1278
+ contact_lists?: Array<string>;
1279
+ properties?: {
1280
+ [key: string]: string;
1281
+ };
1282
+ notes?: string;
1283
+ metadata?: {
1284
+ [key: string]: string;
1285
+ };
881
1286
  id: string;
882
- organization_id: string;
883
- object: 'organization_member';
1287
+ object: 'contact';
884
1288
  };
885
1289
  };
886
- export type OrganizationMemberUpdateResponse = OrganizationMemberUpdateResponses[keyof OrganizationMemberUpdateResponses];
1290
+ export type ContactsDelResponse = ContactsDelResponses[keyof ContactsDelResponses];
1291
+ export type ContactsRetrieveData = {
1292
+ body?: never;
1293
+ path: {
1294
+ contact_id: string;
1295
+ };
1296
+ query?: never;
1297
+ url: '/contacts/{contact_id}';
1298
+ };
1299
+ export type ContactsRetrieveErrors = {
1300
+ /**
1301
+ * Error response
1302
+ */
1303
+ default: ErrorResponse;
1304
+ };
1305
+ export type ContactsRetrieveError = ContactsRetrieveErrors[keyof ContactsRetrieveErrors];
1306
+ export type ContactsRetrieveResponses = {
1307
+ /**
1308
+ * Response
1309
+ */
1310
+ 200: {
1311
+ owner: string;
1312
+ email: string;
1313
+ domain: string;
1314
+ created_at: number;
1315
+ updated_at?: number;
1316
+ deleted?: boolean;
1317
+ deleted_at?: number;
1318
+ blocked?: boolean;
1319
+ blocked_at?: number;
1320
+ unsubscribed?: boolean;
1321
+ unsubscribed_at?: number;
1322
+ contact_lists?: Array<string>;
1323
+ properties?: {
1324
+ [key: string]: string;
1325
+ };
1326
+ notes?: string;
1327
+ metadata?: {
1328
+ [key: string]: string;
1329
+ };
1330
+ id: string;
1331
+ object: 'contact';
1332
+ };
1333
+ };
1334
+ export type ContactsRetrieveResponse = ContactsRetrieveResponses[keyof ContactsRetrieveResponses];
1335
+ export type ContactsUpdateData = {
1336
+ body?: {
1337
+ blocked?: boolean;
1338
+ unsubscribed?: boolean;
1339
+ contact_lists?: Array<string>;
1340
+ properties?: {
1341
+ [key: string]: string;
1342
+ };
1343
+ notes?: string;
1344
+ metadata?: {
1345
+ [key: string]: string;
1346
+ };
1347
+ };
1348
+ path: {
1349
+ contact_id: string;
1350
+ };
1351
+ query?: never;
1352
+ url: '/contacts/{contact_id}';
1353
+ };
1354
+ export type ContactsUpdateErrors = {
1355
+ /**
1356
+ * Error response
1357
+ */
1358
+ default: ErrorResponse;
1359
+ };
1360
+ export type ContactsUpdateError = ContactsUpdateErrors[keyof ContactsUpdateErrors];
1361
+ export type ContactsUpdateResponses = {
1362
+ /**
1363
+ * Response
1364
+ */
1365
+ 200: {
1366
+ owner: string;
1367
+ email: string;
1368
+ domain: string;
1369
+ created_at: number;
1370
+ updated_at?: number;
1371
+ deleted?: boolean;
1372
+ deleted_at?: number;
1373
+ blocked?: boolean;
1374
+ blocked_at?: number;
1375
+ unsubscribed?: boolean;
1376
+ unsubscribed_at?: number;
1377
+ contact_lists?: Array<string>;
1378
+ properties?: {
1379
+ [key: string]: string;
1380
+ };
1381
+ notes?: string;
1382
+ metadata?: {
1383
+ [key: string]: string;
1384
+ };
1385
+ id: string;
1386
+ object: 'contact';
1387
+ };
1388
+ };
1389
+ export type ContactsUpdateResponse = ContactsUpdateResponses[keyof ContactsUpdateResponses];
1390
+ export type ContactsBlockData = {
1391
+ body?: never;
1392
+ path: {
1393
+ contact_id: string;
1394
+ };
1395
+ query?: never;
1396
+ url: '/contacts/{contact_id}/block';
1397
+ };
1398
+ export type ContactsBlockErrors = {
1399
+ /**
1400
+ * Error response
1401
+ */
1402
+ default: ErrorResponse;
1403
+ };
1404
+ export type ContactsBlockError = ContactsBlockErrors[keyof ContactsBlockErrors];
1405
+ export type ContactsBlockResponses = {
1406
+ /**
1407
+ * Response
1408
+ */
1409
+ 200: {
1410
+ owner: string;
1411
+ email: string;
1412
+ domain: string;
1413
+ created_at: number;
1414
+ updated_at?: number;
1415
+ deleted?: boolean;
1416
+ deleted_at?: number;
1417
+ blocked?: boolean;
1418
+ blocked_at?: number;
1419
+ unsubscribed?: boolean;
1420
+ unsubscribed_at?: number;
1421
+ contact_lists?: Array<string>;
1422
+ properties?: {
1423
+ [key: string]: string;
1424
+ };
1425
+ notes?: string;
1426
+ metadata?: {
1427
+ [key: string]: string;
1428
+ };
1429
+ id: string;
1430
+ object: 'contact';
1431
+ };
1432
+ };
1433
+ export type ContactsBlockResponse = ContactsBlockResponses[keyof ContactsBlockResponses];
1434
+ export type ContactsUnblockData = {
1435
+ body?: never;
1436
+ path: {
1437
+ contact_id: string;
1438
+ };
1439
+ query?: never;
1440
+ url: '/contacts/{contact_id}/unblock';
1441
+ };
1442
+ export type ContactsUnblockErrors = {
1443
+ /**
1444
+ * Error response
1445
+ */
1446
+ default: ErrorResponse;
1447
+ };
1448
+ export type ContactsUnblockError = ContactsUnblockErrors[keyof ContactsUnblockErrors];
1449
+ export type ContactsUnblockResponses = {
1450
+ /**
1451
+ * Response
1452
+ */
1453
+ 200: {
1454
+ owner: string;
1455
+ email: string;
1456
+ domain: string;
1457
+ created_at: number;
1458
+ updated_at?: number;
1459
+ deleted?: boolean;
1460
+ deleted_at?: number;
1461
+ blocked?: boolean;
1462
+ blocked_at?: number;
1463
+ unsubscribed?: boolean;
1464
+ unsubscribed_at?: number;
1465
+ contact_lists?: Array<string>;
1466
+ properties?: {
1467
+ [key: string]: string;
1468
+ };
1469
+ notes?: string;
1470
+ metadata?: {
1471
+ [key: string]: string;
1472
+ };
1473
+ id: string;
1474
+ object: 'contact';
1475
+ };
1476
+ };
1477
+ export type ContactsUnblockResponse = ContactsUnblockResponses[keyof ContactsUnblockResponses];
1478
+ export type ContactsResubscribeData = {
1479
+ body?: never;
1480
+ path: {
1481
+ contact_id: string;
1482
+ };
1483
+ query?: never;
1484
+ url: '/contacts/{contact_id}/resubscribe';
1485
+ };
1486
+ export type ContactsResubscribeErrors = {
1487
+ /**
1488
+ * Error response
1489
+ */
1490
+ default: ErrorResponse;
1491
+ };
1492
+ export type ContactsResubscribeError = ContactsResubscribeErrors[keyof ContactsResubscribeErrors];
1493
+ export type ContactsResubscribeResponses = {
1494
+ /**
1495
+ * Response
1496
+ */
1497
+ 200: {
1498
+ owner: string;
1499
+ email: string;
1500
+ domain: string;
1501
+ created_at: number;
1502
+ updated_at?: number;
1503
+ deleted?: boolean;
1504
+ deleted_at?: number;
1505
+ blocked?: boolean;
1506
+ blocked_at?: number;
1507
+ unsubscribed?: boolean;
1508
+ unsubscribed_at?: number;
1509
+ contact_lists?: Array<string>;
1510
+ properties?: {
1511
+ [key: string]: string;
1512
+ };
1513
+ notes?: string;
1514
+ metadata?: {
1515
+ [key: string]: string;
1516
+ };
1517
+ id: string;
1518
+ object: 'contact';
1519
+ };
1520
+ };
1521
+ export type ContactsResubscribeResponse = ContactsResubscribeResponses[keyof ContactsResubscribeResponses];
1522
+ export type BillingAddonsGetAddonsData = {
1523
+ body?: never;
1524
+ path?: never;
1525
+ query?: never;
1526
+ url: '/billing/addons';
1527
+ };
1528
+ export type BillingAddonsGetAddonsErrors = {
1529
+ /**
1530
+ * Error response
1531
+ */
1532
+ default: ErrorResponse;
1533
+ };
1534
+ export type BillingAddonsGetAddonsError = BillingAddonsGetAddonsErrors[keyof BillingAddonsGetAddonsErrors];
1535
+ export type BillingAddonsGetAddonsResponses = {
1536
+ /**
1537
+ * Response
1538
+ */
1539
+ 200: {
1540
+ senders?: {
1541
+ included_per_seat: number;
1542
+ included_total: number;
1543
+ used: number;
1544
+ extra: {
1545
+ price_amount: number;
1546
+ currency: string;
1547
+ quantity_per_addon: number;
1548
+ interval: 'day' | 'week' | 'month' | 'year';
1549
+ subscribed: number;
1550
+ } | null;
1551
+ };
1552
+ email_warmups?: {
1553
+ included_per_seat: number;
1554
+ included_total: number;
1555
+ used: number;
1556
+ extra: {
1557
+ price_amount: number;
1558
+ currency: string;
1559
+ quantity_per_addon: number;
1560
+ interval: 'day' | 'week' | 'month' | 'year';
1561
+ subscribed: number;
1562
+ } | null;
1563
+ };
1564
+ };
1565
+ };
1566
+ export type BillingAddonsGetAddonsResponse = BillingAddonsGetAddonsResponses[keyof BillingAddonsGetAddonsResponses];
1567
+ export type BillingAddonsPreviewUpdateData = {
1568
+ body?: {
1569
+ quantity: number;
1570
+ };
1571
+ path: {
1572
+ addon: 'senders' | 'email_warmups';
1573
+ };
1574
+ query?: never;
1575
+ url: '/billing/addons/{addon}/preview';
1576
+ };
1577
+ export type BillingAddonsPreviewUpdateErrors = {
1578
+ /**
1579
+ * Error response
1580
+ */
1581
+ default: ErrorResponse;
1582
+ };
1583
+ export type BillingAddonsPreviewUpdateError = BillingAddonsPreviewUpdateErrors[keyof BillingAddonsPreviewUpdateErrors];
1584
+ export type BillingAddonsPreviewUpdateResponses = {
1585
+ /**
1586
+ * Response
1587
+ */
1588
+ 200: {
1589
+ discount_percents: Array<number>;
1590
+ total_excluding_tax: number;
1591
+ total: number;
1592
+ amount_due: number;
1593
+ added_from_balance: number;
1594
+ consumed_balance: number;
1595
+ credited_to_balance: number;
1596
+ };
1597
+ };
1598
+ export type BillingAddonsPreviewUpdateResponse = BillingAddonsPreviewUpdateResponses[keyof BillingAddonsPreviewUpdateResponses];
1599
+ export type BillingAddonsGetAddonUsagesData = {
1600
+ body?: never;
1601
+ path: {
1602
+ addon: 'senders' | 'email_warmups';
1603
+ };
1604
+ query?: never;
1605
+ url: '/billing/addons/{addon}';
1606
+ };
1607
+ export type BillingAddonsGetAddonUsagesErrors = {
1608
+ /**
1609
+ * Error response
1610
+ */
1611
+ default: ErrorResponse;
1612
+ };
1613
+ export type BillingAddonsGetAddonUsagesError = BillingAddonsGetAddonUsagesErrors[keyof BillingAddonsGetAddonUsagesErrors];
1614
+ export type BillingAddonsGetAddonUsagesResponses = {
1615
+ /**
1616
+ * Response
1617
+ */
1618
+ 200: Array<{
1619
+ id: string;
1620
+ email: string;
1621
+ usage: number;
1622
+ }>;
1623
+ };
1624
+ export type BillingAddonsGetAddonUsagesResponse = BillingAddonsGetAddonUsagesResponses[keyof BillingAddonsGetAddonUsagesResponses];
1625
+ export type BillingAddonsUpdateData = {
1626
+ body?: {
1627
+ quantity: number;
1628
+ };
1629
+ path: {
1630
+ addon: 'senders' | 'email_warmups';
1631
+ };
1632
+ query?: never;
1633
+ url: '/billing/addons/{addon}';
1634
+ };
1635
+ export type BillingAddonsUpdateErrors = {
1636
+ /**
1637
+ * Error response
1638
+ */
1639
+ default: ErrorResponse;
1640
+ };
1641
+ export type BillingAddonsUpdateError = BillingAddonsUpdateErrors[keyof BillingAddonsUpdateErrors];
1642
+ export type BillingAddonsUpdateResponses = {
1643
+ /**
1644
+ * Response
1645
+ */
1646
+ 200: {
1647
+ status: 'confirmation_required' | 'success' | 'payment_failed';
1648
+ client_secret?: string;
1649
+ failure_code?: string;
1650
+ };
1651
+ };
1652
+ export type BillingAddonsUpdateResponse = BillingAddonsUpdateResponses[keyof BillingAddonsUpdateResponses];
1653
+ export type BillingSubscriptionGetData = {
1654
+ body?: never;
1655
+ path?: never;
1656
+ query?: never;
1657
+ url: '/billing/subscription';
1658
+ };
1659
+ export type BillingSubscriptionGetErrors = {
1660
+ /**
1661
+ * Error response
1662
+ */
1663
+ default: ErrorResponse;
1664
+ };
1665
+ export type BillingSubscriptionGetError = BillingSubscriptionGetErrors[keyof BillingSubscriptionGetErrors];
1666
+ export type BillingSubscriptionGetResponses = {
1667
+ /**
1668
+ * Response
1669
+ */
1670
+ 200: {
1671
+ id: string;
1672
+ created_at: number;
1673
+ current_period_start: number;
1674
+ current_period_end: number;
1675
+ quantity: number;
1676
+ currency: string;
1677
+ amount: number | null;
1678
+ discount_percentage?: number | null;
1679
+ name: string | null;
1680
+ billing_period: 'day' | 'week' | 'month' | 'year' | null;
1681
+ plan: 'free' | 'starter' | 'pro' | 'premium' | 'business' | null;
1682
+ default_payment_method: {
1683
+ type: string;
1684
+ brand?: string | null;
1685
+ last4: string | null;
1686
+ exp_month: number | null;
1687
+ exp_year: number | null;
1688
+ bank_name?: string | null;
1689
+ } | null;
1690
+ addons: {
1691
+ senders?: {
1692
+ quantity: number;
1693
+ };
1694
+ email_warmups?: {
1695
+ quantity: number;
1696
+ };
1697
+ };
1698
+ } | null;
1699
+ };
1700
+ export type BillingSubscriptionGetResponse = BillingSubscriptionGetResponses[keyof BillingSubscriptionGetResponses];
1701
+ export type BillingSubscriptionUpdateData = {
1702
+ body?: {
1703
+ plan: 'free' | 'starter' | 'pro' | 'premium' | 'business';
1704
+ billing_period: 'month' | 'year';
1705
+ };
1706
+ path?: never;
1707
+ query?: never;
1708
+ url: '/billing/subscription';
1709
+ };
1710
+ export type BillingSubscriptionUpdateErrors = {
1711
+ /**
1712
+ * Error response
1713
+ */
1714
+ default: ErrorResponse;
1715
+ };
1716
+ export type BillingSubscriptionUpdateError = BillingSubscriptionUpdateErrors[keyof BillingSubscriptionUpdateErrors];
1717
+ export type BillingSubscriptionUpdateResponses = {
1718
+ /**
1719
+ * Response
1720
+ */
1721
+ 200: {
1722
+ status: 'confirmation_required' | 'success' | 'payment_failed';
1723
+ client_secret?: string;
1724
+ failure_code?: string;
1725
+ };
1726
+ };
1727
+ export type BillingSubscriptionUpdateResponse = BillingSubscriptionUpdateResponses[keyof BillingSubscriptionUpdateResponses];
1728
+ export type BillingSubscriptionPreviewUpdateData = {
1729
+ body?: {
1730
+ plan: 'free' | 'starter' | 'pro' | 'premium' | 'business';
1731
+ billing_period: 'month' | 'year';
1732
+ };
1733
+ path?: never;
1734
+ query?: never;
1735
+ url: '/billing/subscription/preview';
1736
+ };
1737
+ export type BillingSubscriptionPreviewUpdateErrors = {
1738
+ /**
1739
+ * Error response
1740
+ */
1741
+ default: ErrorResponse;
1742
+ };
1743
+ export type BillingSubscriptionPreviewUpdateError = BillingSubscriptionPreviewUpdateErrors[keyof BillingSubscriptionPreviewUpdateErrors];
1744
+ export type BillingSubscriptionPreviewUpdateResponses = {
1745
+ /**
1746
+ * Response
1747
+ */
1748
+ 200: {
1749
+ discount_percents: Array<number>;
1750
+ total_excluding_tax: number;
1751
+ total: number;
1752
+ amount_due: number;
1753
+ added_from_balance: number;
1754
+ consumed_balance: number;
1755
+ credited_to_balance: number;
1756
+ lines: Array<{
1757
+ amount: number;
1758
+ billing_period: 'day' | 'week' | 'month' | 'year';
1759
+ proration: boolean;
1760
+ plan?: 'free' | 'starter' | 'pro' | 'premium' | 'business';
1761
+ addon?: 'senders' | 'email_warmups';
1762
+ }>;
1763
+ next_renewal: number;
1764
+ total_tax_amounts: Array<{
1765
+ amount: number;
1766
+ }>;
1767
+ };
1768
+ };
1769
+ export type BillingSubscriptionPreviewUpdateResponse = BillingSubscriptionPreviewUpdateResponses[keyof BillingSubscriptionPreviewUpdateResponses];
1770
+ export type BillingGetPricesData = {
1771
+ body?: never;
1772
+ path?: never;
1773
+ query: {
1774
+ currency: string;
1775
+ };
1776
+ url: '/billing/prices';
1777
+ };
1778
+ export type BillingGetPricesErrors = {
1779
+ /**
1780
+ * Error response
1781
+ */
1782
+ default: ErrorResponse;
1783
+ };
1784
+ export type BillingGetPricesError = BillingGetPricesErrors[keyof BillingGetPricesErrors];
1785
+ export type BillingGetPricesResponses = {
1786
+ /**
1787
+ * Response
1788
+ */
1789
+ 200: {
1790
+ free?: {
1791
+ month: number;
1792
+ year: number;
1793
+ };
1794
+ starter?: {
1795
+ month: number;
1796
+ year: number;
1797
+ };
1798
+ pro?: {
1799
+ month: number;
1800
+ year: number;
1801
+ };
1802
+ premium?: {
1803
+ month: number;
1804
+ year: number;
1805
+ };
1806
+ business?: {
1807
+ month: number;
1808
+ year: number;
1809
+ };
1810
+ };
1811
+ };
1812
+ export type BillingGetPricesResponse = BillingGetPricesResponses[keyof BillingGetPricesResponses];
887
1813
  export type GetOpenapiJsonData = {
888
1814
  body?: never;
889
1815
  path?: never;