mailmeteor 0.0.3 → 0.0.4
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.
- package/dist/index.cjs +270 -151
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +860 -514
- package/dist/index.mjs +270 -151
- package/dist/index.mjs.map +1 -1
- package/dist/types/generated-sdk/client/client.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/client/types.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/client/utils.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/core/auth.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/core/params.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/core/types.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/core/utils.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/index.d.ts +2 -2
- package/dist/types/generated-sdk/index.d.ts.map +1 -1
- package/dist/types/generated-sdk/sdk.gen.d.ts +111 -71
- package/dist/types/generated-sdk/sdk.gen.d.ts.map +1 -1
- package/dist/types/generated-sdk/types.gen.d.ts +741 -489
- package/dist/types/generated-sdk/types.gen.d.ts.map +1 -1
- package/dist/types/index.d.ts +4 -1
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/generated-sdk/client/client.gen.d.ts +0 -3
- package/dist/generated-sdk/client/client.gen.d.ts.map +0 -1
- package/dist/generated-sdk/client/index.d.ts +0 -9
- package/dist/generated-sdk/client/index.d.ts.map +0 -1
- package/dist/generated-sdk/client/types.gen.d.ts +0 -118
- package/dist/generated-sdk/client/types.gen.d.ts.map +0 -1
- package/dist/generated-sdk/client/utils.gen.d.ts +0 -34
- package/dist/generated-sdk/client/utils.gen.d.ts.map +0 -1
- package/dist/generated-sdk/client.gen.d.ts +0 -13
- package/dist/generated-sdk/client.gen.d.ts.map +0 -1
- package/dist/generated-sdk/core/auth.gen.d.ts +0 -19
- package/dist/generated-sdk/core/auth.gen.d.ts.map +0 -1
- package/dist/generated-sdk/core/bodySerializer.gen.d.ts +0 -26
- package/dist/generated-sdk/core/bodySerializer.gen.d.ts.map +0 -1
- package/dist/generated-sdk/core/params.gen.d.ts +0 -44
- package/dist/generated-sdk/core/params.gen.d.ts.map +0 -1
- package/dist/generated-sdk/core/pathSerializer.gen.d.ts +0 -34
- package/dist/generated-sdk/core/pathSerializer.gen.d.ts.map +0 -1
- package/dist/generated-sdk/core/queryKeySerializer.gen.d.ts +0 -19
- package/dist/generated-sdk/core/queryKeySerializer.gen.d.ts.map +0 -1
- package/dist/generated-sdk/core/serverSentEvents.gen.d.ts +0 -72
- package/dist/generated-sdk/core/serverSentEvents.gen.d.ts.map +0 -1
- package/dist/generated-sdk/core/types.gen.d.ts +0 -79
- package/dist/generated-sdk/core/types.gen.d.ts.map +0 -1
- package/dist/generated-sdk/core/utils.gen.d.ts +0 -20
- package/dist/generated-sdk/core/utils.gen.d.ts.map +0 -1
- package/dist/generated-sdk/index.d.ts +0 -4
- package/dist/generated-sdk/index.d.ts.map +0 -1
- package/dist/generated-sdk/sdk.gen.d.ts +0 -112
- package/dist/generated-sdk/sdk.gen.d.ts.map +0 -1
- package/dist/generated-sdk/types.gen.d.ts +0 -426
- package/dist/generated-sdk/types.gen.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
|
@@ -14,6 +14,185 @@ 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
|
+
};
|
|
17
196
|
export type AddonsResponse200 = {
|
|
18
197
|
senders?: {
|
|
19
198
|
included_per_seat: number;
|
|
@@ -112,512 +291,293 @@ export type PricesResponse200 = {
|
|
|
112
291
|
year: number;
|
|
113
292
|
};
|
|
114
293
|
};
|
|
115
|
-
export type
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
294
|
+
export type OpenapiJsonResponse200 = unknown;
|
|
295
|
+
export type UsersGetCurrentOrganizationData = {
|
|
296
|
+
body?: never;
|
|
297
|
+
path: {
|
|
298
|
+
userId: string;
|
|
299
|
+
};
|
|
300
|
+
query?: never;
|
|
301
|
+
url: '/users/{userId}/current_organization';
|
|
120
302
|
};
|
|
121
|
-
export type
|
|
122
|
-
name: string;
|
|
123
|
-
owner: string;
|
|
303
|
+
export type UsersGetCurrentOrganizationErrors = {
|
|
124
304
|
/**
|
|
125
|
-
*
|
|
305
|
+
* Error response
|
|
126
306
|
*/
|
|
127
|
-
|
|
307
|
+
default: ErrorResponse;
|
|
308
|
+
};
|
|
309
|
+
export type UsersGetCurrentOrganizationError = UsersGetCurrentOrganizationErrors[keyof UsersGetCurrentOrganizationErrors];
|
|
310
|
+
export type UsersGetCurrentOrganizationResponses = {
|
|
128
311
|
/**
|
|
129
|
-
*
|
|
312
|
+
* Response
|
|
130
313
|
*/
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
}>;
|
|
135
|
-
export type OrganizationsBody = {
|
|
136
|
-
name: string;
|
|
314
|
+
200: {
|
|
315
|
+
current_organization_id: string | null;
|
|
316
|
+
};
|
|
137
317
|
};
|
|
138
|
-
export type
|
|
139
|
-
|
|
140
|
-
|
|
318
|
+
export type UsersGetCurrentOrganizationResponse = UsersGetCurrentOrganizationResponses[keyof UsersGetCurrentOrganizationResponses];
|
|
319
|
+
export type UsersSetCurrentOrganizationData = {
|
|
320
|
+
body?: {
|
|
321
|
+
organization_id?: string | null;
|
|
322
|
+
};
|
|
323
|
+
path: {
|
|
324
|
+
user_id: string;
|
|
325
|
+
};
|
|
326
|
+
query?: never;
|
|
327
|
+
url: '/users/{user_id}/current_organization';
|
|
328
|
+
};
|
|
329
|
+
export type UsersSetCurrentOrganizationErrors = {
|
|
141
330
|
/**
|
|
142
|
-
*
|
|
331
|
+
* Error response
|
|
143
332
|
*/
|
|
144
|
-
|
|
333
|
+
default: ErrorResponse;
|
|
334
|
+
};
|
|
335
|
+
export type UsersSetCurrentOrganizationError = UsersSetCurrentOrganizationErrors[keyof UsersSetCurrentOrganizationErrors];
|
|
336
|
+
export type UsersSetCurrentOrganizationResponses = {
|
|
145
337
|
/**
|
|
146
|
-
*
|
|
338
|
+
* Response
|
|
147
339
|
*/
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
340
|
+
200: {
|
|
341
|
+
current_organization_id: string | null;
|
|
342
|
+
};
|
|
151
343
|
};
|
|
152
|
-
export type
|
|
153
|
-
|
|
344
|
+
export type UsersSetCurrentOrganizationResponse = UsersSetCurrentOrganizationResponses[keyof UsersSetCurrentOrganizationResponses];
|
|
345
|
+
export type UsersWatchMailboxData = {
|
|
346
|
+
body?: {
|
|
347
|
+
provider?: 'gmail' | 'outlook';
|
|
348
|
+
force?: boolean;
|
|
349
|
+
};
|
|
350
|
+
path: {
|
|
351
|
+
user_id: string;
|
|
352
|
+
};
|
|
353
|
+
query?: never;
|
|
354
|
+
url: '/users/{user_id}/watch_mailbox';
|
|
154
355
|
};
|
|
155
|
-
export type
|
|
156
|
-
name: string;
|
|
157
|
-
owner: string;
|
|
356
|
+
export type UsersWatchMailboxErrors = {
|
|
158
357
|
/**
|
|
159
|
-
*
|
|
358
|
+
* Error response
|
|
160
359
|
*/
|
|
161
|
-
|
|
360
|
+
default: ErrorResponse;
|
|
361
|
+
};
|
|
362
|
+
export type UsersWatchMailboxError = UsersWatchMailboxErrors[keyof UsersWatchMailboxErrors];
|
|
363
|
+
export type UsersWatchMailboxResponses = {
|
|
162
364
|
/**
|
|
163
|
-
*
|
|
365
|
+
* Response
|
|
164
366
|
*/
|
|
165
|
-
|
|
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;
|
|
367
|
+
204: void;
|
|
175
368
|
};
|
|
176
|
-
export type
|
|
177
|
-
|
|
369
|
+
export type UsersWatchMailboxResponse = UsersWatchMailboxResponses[keyof UsersWatchMailboxResponses];
|
|
370
|
+
export type UsersDeleteActionData = {
|
|
371
|
+
body?: never;
|
|
372
|
+
path: {
|
|
373
|
+
user_id: string;
|
|
374
|
+
action_id: string;
|
|
375
|
+
};
|
|
376
|
+
query?: never;
|
|
377
|
+
url: '/users/{user_id}/actions/{action_id}';
|
|
178
378
|
};
|
|
179
|
-
export type
|
|
180
|
-
email: string;
|
|
181
|
-
name?: string;
|
|
182
|
-
profile_picture_url?: string;
|
|
183
|
-
role: 'admin' | 'member';
|
|
184
|
-
/**
|
|
185
|
-
* Creation date
|
|
186
|
-
*/
|
|
187
|
-
created_at: string;
|
|
379
|
+
export type UsersDeleteActionErrors = {
|
|
188
380
|
/**
|
|
189
|
-
*
|
|
381
|
+
* Error response
|
|
190
382
|
*/
|
|
191
|
-
|
|
192
|
-
id: string;
|
|
193
|
-
organization_id: string;
|
|
194
|
-
object: 'organization_member';
|
|
195
|
-
}>;
|
|
196
|
-
export type MembersBody = {
|
|
197
|
-
email: string;
|
|
198
|
-
role: 'admin' | 'member';
|
|
383
|
+
default: ErrorResponse;
|
|
199
384
|
};
|
|
200
|
-
export type
|
|
201
|
-
|
|
202
|
-
name?: string;
|
|
203
|
-
profile_picture_url?: string;
|
|
204
|
-
role: 'admin' | 'member';
|
|
385
|
+
export type UsersDeleteActionError = UsersDeleteActionErrors[keyof UsersDeleteActionErrors];
|
|
386
|
+
export type UsersDeleteActionResponses = {
|
|
205
387
|
/**
|
|
206
|
-
*
|
|
388
|
+
* Response
|
|
207
389
|
*/
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* Last Update date
|
|
211
|
-
*/
|
|
212
|
-
updated_at?: string;
|
|
213
|
-
id: string;
|
|
214
|
-
organization_id: string;
|
|
215
|
-
object: 'organization_member';
|
|
216
|
-
};
|
|
217
|
-
export type MemberIdBody = {
|
|
218
|
-
role: 'admin' | 'member';
|
|
219
|
-
};
|
|
220
|
-
export type MemberIdParams = {
|
|
221
|
-
organization_id: string;
|
|
222
|
-
member_id: string;
|
|
223
|
-
};
|
|
224
|
-
export type MemberIdResponse200 = {
|
|
225
|
-
email: string;
|
|
226
|
-
name?: string;
|
|
227
|
-
profile_picture_url?: string;
|
|
228
|
-
role: 'admin' | 'member';
|
|
229
|
-
/**
|
|
230
|
-
* Creation date
|
|
231
|
-
*/
|
|
232
|
-
created_at: string;
|
|
233
|
-
/**
|
|
234
|
-
* Last Update date
|
|
235
|
-
*/
|
|
236
|
-
updated_at?: string;
|
|
237
|
-
id: string;
|
|
238
|
-
organization_id: string;
|
|
239
|
-
object: 'organization_member';
|
|
390
|
+
204: void;
|
|
240
391
|
};
|
|
241
|
-
export type
|
|
242
|
-
export type
|
|
392
|
+
export type UsersDeleteActionResponse = UsersDeleteActionResponses[keyof UsersDeleteActionResponses];
|
|
393
|
+
export type OrganizationMemberListData = {
|
|
243
394
|
body?: never;
|
|
244
|
-
path
|
|
245
|
-
|
|
246
|
-
|
|
395
|
+
path: {
|
|
396
|
+
organization_id: string;
|
|
397
|
+
};
|
|
398
|
+
query?: {
|
|
399
|
+
limit?: number;
|
|
400
|
+
starting_after?: string;
|
|
401
|
+
};
|
|
402
|
+
url: '/organizations/{organization_id}/members';
|
|
247
403
|
};
|
|
248
|
-
export type
|
|
404
|
+
export type OrganizationMemberListErrors = {
|
|
249
405
|
/**
|
|
250
406
|
* Error response
|
|
251
407
|
*/
|
|
252
408
|
default: ErrorResponse;
|
|
253
409
|
};
|
|
254
|
-
export type
|
|
255
|
-
export type
|
|
410
|
+
export type OrganizationMemberListError = OrganizationMemberListErrors[keyof OrganizationMemberListErrors];
|
|
411
|
+
export type OrganizationMemberListResponses = {
|
|
256
412
|
/**
|
|
257
413
|
* Response
|
|
258
414
|
*/
|
|
259
|
-
200: {
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
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
|
-
};
|
|
415
|
+
200: Array<{
|
|
416
|
+
email: string;
|
|
417
|
+
name?: string;
|
|
418
|
+
profile_picture_url?: string;
|
|
419
|
+
role: 'admin' | 'member';
|
|
420
|
+
/**
|
|
421
|
+
* Creation date
|
|
422
|
+
*/
|
|
423
|
+
created_at: string;
|
|
424
|
+
/**
|
|
425
|
+
* Last Update date
|
|
426
|
+
*/
|
|
427
|
+
updated_at?: string;
|
|
428
|
+
id: string;
|
|
429
|
+
organization_id: string;
|
|
430
|
+
object: 'organization_member';
|
|
431
|
+
}>;
|
|
285
432
|
};
|
|
286
|
-
export type
|
|
287
|
-
export type
|
|
433
|
+
export type OrganizationMemberListResponse = OrganizationMemberListResponses[keyof OrganizationMemberListResponses];
|
|
434
|
+
export type OrganizationMemberCreateData = {
|
|
288
435
|
body?: {
|
|
289
|
-
|
|
436
|
+
email: string;
|
|
437
|
+
role: 'admin' | 'member';
|
|
290
438
|
};
|
|
291
439
|
path: {
|
|
292
|
-
|
|
440
|
+
organization_id: string;
|
|
293
441
|
};
|
|
294
442
|
query?: never;
|
|
295
|
-
url: '/
|
|
443
|
+
url: '/organizations/{organization_id}/members';
|
|
296
444
|
};
|
|
297
|
-
export type
|
|
445
|
+
export type OrganizationMemberCreateErrors = {
|
|
298
446
|
/**
|
|
299
447
|
* Error response
|
|
300
448
|
*/
|
|
301
449
|
default: ErrorResponse;
|
|
302
450
|
};
|
|
303
|
-
export type
|
|
304
|
-
export type
|
|
451
|
+
export type OrganizationMemberCreateError = OrganizationMemberCreateErrors[keyof OrganizationMemberCreateErrors];
|
|
452
|
+
export type OrganizationMemberCreateResponses = {
|
|
305
453
|
/**
|
|
306
454
|
* Response
|
|
307
455
|
*/
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
456
|
+
201: {
|
|
457
|
+
email: string;
|
|
458
|
+
name?: string;
|
|
459
|
+
profile_picture_url?: string;
|
|
460
|
+
role: 'admin' | 'member';
|
|
461
|
+
/**
|
|
462
|
+
* Creation date
|
|
463
|
+
*/
|
|
464
|
+
created_at: string;
|
|
465
|
+
/**
|
|
466
|
+
* Last Update date
|
|
467
|
+
*/
|
|
468
|
+
updated_at?: string;
|
|
469
|
+
id: string;
|
|
470
|
+
organization_id: string;
|
|
471
|
+
object: 'organization_member';
|
|
316
472
|
};
|
|
317
473
|
};
|
|
318
|
-
export type
|
|
319
|
-
export type
|
|
474
|
+
export type OrganizationMemberCreateResponse = OrganizationMemberCreateResponses[keyof OrganizationMemberCreateResponses];
|
|
475
|
+
export type OrganizationMemberDeleteData = {
|
|
320
476
|
body?: never;
|
|
321
477
|
path: {
|
|
322
|
-
|
|
478
|
+
organization_id: string;
|
|
479
|
+
member_id: string;
|
|
323
480
|
};
|
|
324
481
|
query?: never;
|
|
325
|
-
url: '/
|
|
482
|
+
url: '/organizations/{organization_id}/members/{member_id}';
|
|
326
483
|
};
|
|
327
|
-
export type
|
|
484
|
+
export type OrganizationMemberDeleteErrors = {
|
|
328
485
|
/**
|
|
329
486
|
* Error response
|
|
330
487
|
*/
|
|
331
488
|
default: ErrorResponse;
|
|
332
489
|
};
|
|
333
|
-
export type
|
|
334
|
-
export type
|
|
490
|
+
export type OrganizationMemberDeleteError = OrganizationMemberDeleteErrors[keyof OrganizationMemberDeleteErrors];
|
|
491
|
+
export type OrganizationMemberDeleteResponses = {
|
|
335
492
|
/**
|
|
336
493
|
* Response
|
|
337
494
|
*/
|
|
338
|
-
|
|
339
|
-
id: string;
|
|
340
|
-
email: string;
|
|
341
|
-
usage: number;
|
|
342
|
-
}>;
|
|
495
|
+
204: void;
|
|
343
496
|
};
|
|
344
|
-
export type
|
|
345
|
-
export type
|
|
497
|
+
export type OrganizationMemberDeleteResponse = OrganizationMemberDeleteResponses[keyof OrganizationMemberDeleteResponses];
|
|
498
|
+
export type OrganizationMemberUpdateData = {
|
|
346
499
|
body?: {
|
|
347
|
-
|
|
500
|
+
role: 'admin' | 'member';
|
|
348
501
|
};
|
|
349
502
|
path: {
|
|
350
|
-
|
|
503
|
+
organization_id: string;
|
|
504
|
+
member_id: string;
|
|
351
505
|
};
|
|
352
506
|
query?: never;
|
|
353
|
-
url: '/
|
|
507
|
+
url: '/organizations/{organization_id}/members/{member_id}';
|
|
354
508
|
};
|
|
355
|
-
export type
|
|
509
|
+
export type OrganizationMemberUpdateErrors = {
|
|
356
510
|
/**
|
|
357
511
|
* Error response
|
|
358
512
|
*/
|
|
359
513
|
default: ErrorResponse;
|
|
360
514
|
};
|
|
361
|
-
export type
|
|
362
|
-
export type
|
|
515
|
+
export type OrganizationMemberUpdateError = OrganizationMemberUpdateErrors[keyof OrganizationMemberUpdateErrors];
|
|
516
|
+
export type OrganizationMemberUpdateResponses = {
|
|
363
517
|
/**
|
|
364
518
|
* Response
|
|
365
519
|
*/
|
|
366
520
|
200: {
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
521
|
+
email: string;
|
|
522
|
+
name?: string;
|
|
523
|
+
profile_picture_url?: string;
|
|
524
|
+
role: 'admin' | 'member';
|
|
525
|
+
/**
|
|
526
|
+
* Creation date
|
|
527
|
+
*/
|
|
528
|
+
created_at: string;
|
|
529
|
+
/**
|
|
530
|
+
* Last Update date
|
|
531
|
+
*/
|
|
532
|
+
updated_at?: string;
|
|
533
|
+
id: string;
|
|
534
|
+
organization_id: string;
|
|
535
|
+
object: 'organization_member';
|
|
370
536
|
};
|
|
371
537
|
};
|
|
372
|
-
export type
|
|
373
|
-
export type
|
|
538
|
+
export type OrganizationMemberUpdateResponse = OrganizationMemberUpdateResponses[keyof OrganizationMemberUpdateResponses];
|
|
539
|
+
export type OrganizationListData = {
|
|
374
540
|
body?: never;
|
|
375
541
|
path?: never;
|
|
376
542
|
query?: never;
|
|
377
|
-
url: '/
|
|
543
|
+
url: '/organizations';
|
|
378
544
|
};
|
|
379
|
-
export type
|
|
545
|
+
export type OrganizationListErrors = {
|
|
380
546
|
/**
|
|
381
547
|
* Error response
|
|
382
548
|
*/
|
|
383
549
|
default: ErrorResponse;
|
|
384
550
|
};
|
|
385
|
-
export type
|
|
386
|
-
export type
|
|
551
|
+
export type OrganizationListError = OrganizationListErrors[keyof OrganizationListErrors];
|
|
552
|
+
export type OrganizationListResponses = {
|
|
387
553
|
/**
|
|
388
554
|
* Response
|
|
389
555
|
*/
|
|
390
|
-
200: {
|
|
556
|
+
200: Array<{
|
|
557
|
+
name: string;
|
|
558
|
+
owner: string;
|
|
559
|
+
/**
|
|
560
|
+
* Creation date
|
|
561
|
+
*/
|
|
562
|
+
created_at: string;
|
|
563
|
+
/**
|
|
564
|
+
* Last Update date
|
|
565
|
+
*/
|
|
566
|
+
updated_at?: string;
|
|
391
567
|
id: string;
|
|
392
|
-
|
|
393
|
-
|
|
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;
|
|
568
|
+
object: 'organization';
|
|
569
|
+
}>;
|
|
419
570
|
};
|
|
420
|
-
export type
|
|
421
|
-
export type
|
|
571
|
+
export type OrganizationListResponse = OrganizationListResponses[keyof OrganizationListResponses];
|
|
572
|
+
export type OrganizationCreateData = {
|
|
422
573
|
body?: {
|
|
423
|
-
|
|
424
|
-
billing_period: 'month' | 'year';
|
|
574
|
+
name: string;
|
|
425
575
|
};
|
|
426
576
|
path?: never;
|
|
427
577
|
query?: never;
|
|
428
|
-
url: '/
|
|
578
|
+
url: '/organizations';
|
|
429
579
|
};
|
|
430
|
-
export type
|
|
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 = {
|
|
580
|
-
body?: never;
|
|
581
|
-
path?: never;
|
|
582
|
-
query?: never;
|
|
583
|
-
url: '/organizations';
|
|
584
|
-
};
|
|
585
|
-
export type OrganizationListErrors = {
|
|
586
|
-
/**
|
|
587
|
-
* Error response
|
|
588
|
-
*/
|
|
589
|
-
default: ErrorResponse;
|
|
590
|
-
};
|
|
591
|
-
export type OrganizationListError = OrganizationListErrors[keyof OrganizationListErrors];
|
|
592
|
-
export type OrganizationListResponses = {
|
|
593
|
-
/**
|
|
594
|
-
* Response
|
|
595
|
-
*/
|
|
596
|
-
200: Array<{
|
|
597
|
-
name: string;
|
|
598
|
-
owner: string;
|
|
599
|
-
/**
|
|
600
|
-
* Creation date
|
|
601
|
-
*/
|
|
602
|
-
created_at: string;
|
|
603
|
-
/**
|
|
604
|
-
* Last Update date
|
|
605
|
-
*/
|
|
606
|
-
updated_at?: string;
|
|
607
|
-
id: string;
|
|
608
|
-
object: 'organization';
|
|
609
|
-
}>;
|
|
610
|
-
};
|
|
611
|
-
export type OrganizationListResponse = OrganizationListResponses[keyof OrganizationListResponses];
|
|
612
|
-
export type OrganizationCreateData = {
|
|
613
|
-
body?: {
|
|
614
|
-
name: string;
|
|
615
|
-
};
|
|
616
|
-
path?: never;
|
|
617
|
-
query?: never;
|
|
618
|
-
url: '/organizations';
|
|
619
|
-
};
|
|
620
|
-
export type OrganizationCreateErrors = {
|
|
580
|
+
export type OrganizationCreateErrors = {
|
|
621
581
|
/**
|
|
622
582
|
* Error response
|
|
623
583
|
*/
|
|
@@ -738,152 +698,444 @@ export type OrganizationUpdateResponses = {
|
|
|
738
698
|
};
|
|
739
699
|
};
|
|
740
700
|
export type OrganizationUpdateResponse = OrganizationUpdateResponses[keyof OrganizationUpdateResponses];
|
|
741
|
-
export type
|
|
742
|
-
body?:
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
starting_after?: string;
|
|
701
|
+
export type ContactListsCreateData = {
|
|
702
|
+
body?: {
|
|
703
|
+
owner: string;
|
|
704
|
+
name: string;
|
|
705
|
+
metadata?: {
|
|
706
|
+
[key: string]: string;
|
|
707
|
+
};
|
|
749
708
|
};
|
|
750
|
-
|
|
709
|
+
path?: never;
|
|
710
|
+
query?: never;
|
|
711
|
+
url: '/contact_lists';
|
|
751
712
|
};
|
|
752
|
-
export type
|
|
713
|
+
export type ContactListsCreateErrors = {
|
|
753
714
|
/**
|
|
754
715
|
* Error response
|
|
755
716
|
*/
|
|
756
717
|
default: ErrorResponse;
|
|
757
718
|
};
|
|
758
|
-
export type
|
|
759
|
-
export type
|
|
719
|
+
export type ContactListsCreateError = ContactListsCreateErrors[keyof ContactListsCreateErrors];
|
|
720
|
+
export type ContactListsCreateResponses = {
|
|
760
721
|
/**
|
|
761
722
|
* Response
|
|
762
723
|
*/
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
name
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
* Last Update date
|
|
774
|
-
*/
|
|
775
|
-
updated_at?: string;
|
|
724
|
+
201: {
|
|
725
|
+
owner: string;
|
|
726
|
+
name: string;
|
|
727
|
+
created_at: number;
|
|
728
|
+
updated_at?: number;
|
|
729
|
+
deleted?: boolean;
|
|
730
|
+
deleted_at?: number;
|
|
731
|
+
metadata?: {
|
|
732
|
+
[key: string]: string;
|
|
733
|
+
};
|
|
776
734
|
id: string;
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
}>;
|
|
735
|
+
object: 'contact_list';
|
|
736
|
+
};
|
|
780
737
|
};
|
|
781
|
-
export type
|
|
782
|
-
export type
|
|
738
|
+
export type ContactListsCreateResponse = ContactListsCreateResponses[keyof ContactListsCreateResponses];
|
|
739
|
+
export type ContactListsRemoveData = {
|
|
783
740
|
body?: {
|
|
784
|
-
|
|
785
|
-
role: 'admin' | 'member';
|
|
741
|
+
remove_contacts?: boolean;
|
|
786
742
|
};
|
|
787
743
|
path: {
|
|
788
|
-
|
|
744
|
+
contact_list_id: string;
|
|
789
745
|
};
|
|
790
746
|
query?: never;
|
|
791
|
-
url: '/
|
|
747
|
+
url: '/contact_lists/{contact_list_id}';
|
|
792
748
|
};
|
|
793
|
-
export type
|
|
749
|
+
export type ContactListsRemoveErrors = {
|
|
794
750
|
/**
|
|
795
751
|
* Error response
|
|
796
752
|
*/
|
|
797
753
|
default: ErrorResponse;
|
|
798
754
|
};
|
|
799
|
-
export type
|
|
800
|
-
export type
|
|
755
|
+
export type ContactListsRemoveError = ContactListsRemoveErrors[keyof ContactListsRemoveErrors];
|
|
756
|
+
export type ContactListsRemoveResponses = {
|
|
801
757
|
/**
|
|
802
758
|
* Response
|
|
803
759
|
*/
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
name
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
* Last Update date
|
|
815
|
-
*/
|
|
816
|
-
updated_at?: string;
|
|
760
|
+
200: {
|
|
761
|
+
owner: string;
|
|
762
|
+
name: string;
|
|
763
|
+
created_at: number;
|
|
764
|
+
updated_at?: number;
|
|
765
|
+
deleted?: boolean;
|
|
766
|
+
deleted_at?: number;
|
|
767
|
+
metadata?: {
|
|
768
|
+
[key: string]: string;
|
|
769
|
+
};
|
|
817
770
|
id: string;
|
|
818
|
-
|
|
819
|
-
object: 'organization_member';
|
|
771
|
+
object: 'contact_list';
|
|
820
772
|
};
|
|
821
773
|
};
|
|
822
|
-
export type
|
|
823
|
-
export type
|
|
774
|
+
export type ContactListsRemoveResponse = ContactListsRemoveResponses[keyof ContactListsRemoveResponses];
|
|
775
|
+
export type ContactListsRetrieveData = {
|
|
824
776
|
body?: never;
|
|
825
777
|
path: {
|
|
826
|
-
|
|
827
|
-
member_id: string;
|
|
778
|
+
contact_list_id: string;
|
|
828
779
|
};
|
|
829
780
|
query?: never;
|
|
830
|
-
url: '/
|
|
781
|
+
url: '/contact_lists/{contact_list_id}';
|
|
831
782
|
};
|
|
832
|
-
export type
|
|
783
|
+
export type ContactListsRetrieveErrors = {
|
|
833
784
|
/**
|
|
834
785
|
* Error response
|
|
835
786
|
*/
|
|
836
787
|
default: ErrorResponse;
|
|
837
788
|
};
|
|
838
|
-
export type
|
|
839
|
-
export type
|
|
789
|
+
export type ContactListsRetrieveError = ContactListsRetrieveErrors[keyof ContactListsRetrieveErrors];
|
|
790
|
+
export type ContactListsRetrieveResponses = {
|
|
840
791
|
/**
|
|
841
792
|
* Response
|
|
842
793
|
*/
|
|
843
|
-
|
|
794
|
+
200: {
|
|
795
|
+
owner: string;
|
|
796
|
+
name: string;
|
|
797
|
+
created_at: number;
|
|
798
|
+
updated_at?: number;
|
|
799
|
+
deleted?: boolean;
|
|
800
|
+
deleted_at?: number;
|
|
801
|
+
metadata?: {
|
|
802
|
+
[key: string]: string;
|
|
803
|
+
};
|
|
804
|
+
id: string;
|
|
805
|
+
object: 'contact_list';
|
|
806
|
+
};
|
|
844
807
|
};
|
|
845
|
-
export type
|
|
846
|
-
export type
|
|
808
|
+
export type ContactListsRetrieveResponse = ContactListsRetrieveResponses[keyof ContactListsRetrieveResponses];
|
|
809
|
+
export type ContactListsUpdateData = {
|
|
847
810
|
body?: {
|
|
848
|
-
|
|
811
|
+
name: string;
|
|
812
|
+
metadata?: {
|
|
813
|
+
[key: string]: string;
|
|
814
|
+
};
|
|
849
815
|
};
|
|
850
816
|
path: {
|
|
851
|
-
|
|
852
|
-
member_id: string;
|
|
817
|
+
contact_list_id: string;
|
|
853
818
|
};
|
|
854
819
|
query?: never;
|
|
855
|
-
url: '/
|
|
820
|
+
url: '/contact_lists/{contact_list_id}';
|
|
856
821
|
};
|
|
857
|
-
export type
|
|
822
|
+
export type ContactListsUpdateErrors = {
|
|
858
823
|
/**
|
|
859
824
|
* Error response
|
|
860
825
|
*/
|
|
861
826
|
default: ErrorResponse;
|
|
862
827
|
};
|
|
863
|
-
export type
|
|
864
|
-
export type
|
|
828
|
+
export type ContactListsUpdateError = ContactListsUpdateErrors[keyof ContactListsUpdateErrors];
|
|
829
|
+
export type ContactListsUpdateResponses = {
|
|
830
|
+
/**
|
|
831
|
+
* Response
|
|
832
|
+
*/
|
|
833
|
+
200: {
|
|
834
|
+
owner: string;
|
|
835
|
+
name: string;
|
|
836
|
+
created_at: number;
|
|
837
|
+
updated_at?: number;
|
|
838
|
+
deleted?: boolean;
|
|
839
|
+
deleted_at?: number;
|
|
840
|
+
metadata?: {
|
|
841
|
+
[key: string]: string;
|
|
842
|
+
};
|
|
843
|
+
id: string;
|
|
844
|
+
object: 'contact_list';
|
|
845
|
+
};
|
|
846
|
+
};
|
|
847
|
+
export type ContactListsUpdateResponse = ContactListsUpdateResponses[keyof ContactListsUpdateResponses];
|
|
848
|
+
export type BillingAddonsGetAddonsData = {
|
|
849
|
+
body?: never;
|
|
850
|
+
path?: never;
|
|
851
|
+
query?: never;
|
|
852
|
+
url: '/billing/addons';
|
|
853
|
+
};
|
|
854
|
+
export type BillingAddonsGetAddonsErrors = {
|
|
855
|
+
/**
|
|
856
|
+
* Error response
|
|
857
|
+
*/
|
|
858
|
+
default: ErrorResponse;
|
|
859
|
+
};
|
|
860
|
+
export type BillingAddonsGetAddonsError = BillingAddonsGetAddonsErrors[keyof BillingAddonsGetAddonsErrors];
|
|
861
|
+
export type BillingAddonsGetAddonsResponses = {
|
|
865
862
|
/**
|
|
866
863
|
* Response
|
|
867
864
|
*/
|
|
868
865
|
200: {
|
|
866
|
+
senders?: {
|
|
867
|
+
included_per_seat: number;
|
|
868
|
+
included_total: number;
|
|
869
|
+
used: number;
|
|
870
|
+
extra: {
|
|
871
|
+
price_amount: number;
|
|
872
|
+
currency: string;
|
|
873
|
+
quantity_per_addon: number;
|
|
874
|
+
interval: 'day' | 'week' | 'month' | 'year';
|
|
875
|
+
subscribed: number;
|
|
876
|
+
} | null;
|
|
877
|
+
};
|
|
878
|
+
email_warmups?: {
|
|
879
|
+
included_per_seat: number;
|
|
880
|
+
included_total: number;
|
|
881
|
+
used: number;
|
|
882
|
+
extra: {
|
|
883
|
+
price_amount: number;
|
|
884
|
+
currency: string;
|
|
885
|
+
quantity_per_addon: number;
|
|
886
|
+
interval: 'day' | 'week' | 'month' | 'year';
|
|
887
|
+
subscribed: number;
|
|
888
|
+
} | null;
|
|
889
|
+
};
|
|
890
|
+
};
|
|
891
|
+
};
|
|
892
|
+
export type BillingAddonsGetAddonsResponse = BillingAddonsGetAddonsResponses[keyof BillingAddonsGetAddonsResponses];
|
|
893
|
+
export type BillingAddonsPreviewUpdateData = {
|
|
894
|
+
body?: {
|
|
895
|
+
quantity: number;
|
|
896
|
+
};
|
|
897
|
+
path: {
|
|
898
|
+
addon: 'senders' | 'email_warmups';
|
|
899
|
+
};
|
|
900
|
+
query?: never;
|
|
901
|
+
url: '/billing/addons/{addon}/preview';
|
|
902
|
+
};
|
|
903
|
+
export type BillingAddonsPreviewUpdateErrors = {
|
|
904
|
+
/**
|
|
905
|
+
* Error response
|
|
906
|
+
*/
|
|
907
|
+
default: ErrorResponse;
|
|
908
|
+
};
|
|
909
|
+
export type BillingAddonsPreviewUpdateError = BillingAddonsPreviewUpdateErrors[keyof BillingAddonsPreviewUpdateErrors];
|
|
910
|
+
export type BillingAddonsPreviewUpdateResponses = {
|
|
911
|
+
/**
|
|
912
|
+
* Response
|
|
913
|
+
*/
|
|
914
|
+
200: {
|
|
915
|
+
discount_percents: Array<number>;
|
|
916
|
+
total_excluding_tax: number;
|
|
917
|
+
total: number;
|
|
918
|
+
amount_due: number;
|
|
919
|
+
added_from_balance: number;
|
|
920
|
+
consumed_balance: number;
|
|
921
|
+
credited_to_balance: number;
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
export type BillingAddonsPreviewUpdateResponse = BillingAddonsPreviewUpdateResponses[keyof BillingAddonsPreviewUpdateResponses];
|
|
925
|
+
export type BillingAddonsGetAddonUsagesData = {
|
|
926
|
+
body?: never;
|
|
927
|
+
path: {
|
|
928
|
+
addon: 'senders' | 'email_warmups';
|
|
929
|
+
};
|
|
930
|
+
query?: never;
|
|
931
|
+
url: '/billing/addons/{addon}';
|
|
932
|
+
};
|
|
933
|
+
export type BillingAddonsGetAddonUsagesErrors = {
|
|
934
|
+
/**
|
|
935
|
+
* Error response
|
|
936
|
+
*/
|
|
937
|
+
default: ErrorResponse;
|
|
938
|
+
};
|
|
939
|
+
export type BillingAddonsGetAddonUsagesError = BillingAddonsGetAddonUsagesErrors[keyof BillingAddonsGetAddonUsagesErrors];
|
|
940
|
+
export type BillingAddonsGetAddonUsagesResponses = {
|
|
941
|
+
/**
|
|
942
|
+
* Response
|
|
943
|
+
*/
|
|
944
|
+
200: Array<{
|
|
945
|
+
id: string;
|
|
869
946
|
email: string;
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
947
|
+
usage: number;
|
|
948
|
+
}>;
|
|
949
|
+
};
|
|
950
|
+
export type BillingAddonsGetAddonUsagesResponse = BillingAddonsGetAddonUsagesResponses[keyof BillingAddonsGetAddonUsagesResponses];
|
|
951
|
+
export type BillingAddonsUpdateData = {
|
|
952
|
+
body?: {
|
|
953
|
+
quantity: number;
|
|
954
|
+
};
|
|
955
|
+
path: {
|
|
956
|
+
addon: 'senders' | 'email_warmups';
|
|
957
|
+
};
|
|
958
|
+
query?: never;
|
|
959
|
+
url: '/billing/addons/{addon}';
|
|
960
|
+
};
|
|
961
|
+
export type BillingAddonsUpdateErrors = {
|
|
962
|
+
/**
|
|
963
|
+
* Error response
|
|
964
|
+
*/
|
|
965
|
+
default: ErrorResponse;
|
|
966
|
+
};
|
|
967
|
+
export type BillingAddonsUpdateError = BillingAddonsUpdateErrors[keyof BillingAddonsUpdateErrors];
|
|
968
|
+
export type BillingAddonsUpdateResponses = {
|
|
969
|
+
/**
|
|
970
|
+
* Response
|
|
971
|
+
*/
|
|
972
|
+
200: {
|
|
973
|
+
status: 'confirmation_required' | 'success' | 'payment_failed';
|
|
974
|
+
client_secret?: string;
|
|
975
|
+
failure_code?: string;
|
|
976
|
+
};
|
|
977
|
+
};
|
|
978
|
+
export type BillingAddonsUpdateResponse = BillingAddonsUpdateResponses[keyof BillingAddonsUpdateResponses];
|
|
979
|
+
export type BillingSubscriptionGetData = {
|
|
980
|
+
body?: never;
|
|
981
|
+
path?: never;
|
|
982
|
+
query?: never;
|
|
983
|
+
url: '/billing/subscription';
|
|
984
|
+
};
|
|
985
|
+
export type BillingSubscriptionGetErrors = {
|
|
986
|
+
/**
|
|
987
|
+
* Error response
|
|
988
|
+
*/
|
|
989
|
+
default: ErrorResponse;
|
|
990
|
+
};
|
|
991
|
+
export type BillingSubscriptionGetError = BillingSubscriptionGetErrors[keyof BillingSubscriptionGetErrors];
|
|
992
|
+
export type BillingSubscriptionGetResponses = {
|
|
993
|
+
/**
|
|
994
|
+
* Response
|
|
995
|
+
*/
|
|
996
|
+
200: {
|
|
881
997
|
id: string;
|
|
882
|
-
|
|
883
|
-
|
|
998
|
+
created_at: number;
|
|
999
|
+
current_period_start: number;
|
|
1000
|
+
current_period_end: number;
|
|
1001
|
+
quantity: number;
|
|
1002
|
+
currency: string;
|
|
1003
|
+
amount: number | null;
|
|
1004
|
+
discount_percentage?: number | null;
|
|
1005
|
+
name: string | null;
|
|
1006
|
+
billing_period: 'day' | 'week' | 'month' | 'year' | null;
|
|
1007
|
+
plan: 'free' | 'starter' | 'pro' | 'premium' | 'business' | null;
|
|
1008
|
+
default_payment_method: {
|
|
1009
|
+
type: string;
|
|
1010
|
+
brand?: string | null;
|
|
1011
|
+
last4: string | null;
|
|
1012
|
+
exp_month: number | null;
|
|
1013
|
+
exp_year: number | null;
|
|
1014
|
+
bank_name?: string | null;
|
|
1015
|
+
} | null;
|
|
1016
|
+
addons: {
|
|
1017
|
+
senders?: {
|
|
1018
|
+
quantity: number;
|
|
1019
|
+
};
|
|
1020
|
+
email_warmups?: {
|
|
1021
|
+
quantity: number;
|
|
1022
|
+
};
|
|
1023
|
+
};
|
|
1024
|
+
} | null;
|
|
1025
|
+
};
|
|
1026
|
+
export type BillingSubscriptionGetResponse = BillingSubscriptionGetResponses[keyof BillingSubscriptionGetResponses];
|
|
1027
|
+
export type BillingSubscriptionUpdateData = {
|
|
1028
|
+
body?: {
|
|
1029
|
+
plan: 'free' | 'starter' | 'pro' | 'premium' | 'business';
|
|
1030
|
+
billing_period: 'month' | 'year';
|
|
884
1031
|
};
|
|
1032
|
+
path?: never;
|
|
1033
|
+
query?: never;
|
|
1034
|
+
url: '/billing/subscription';
|
|
885
1035
|
};
|
|
886
|
-
export type
|
|
1036
|
+
export type BillingSubscriptionUpdateErrors = {
|
|
1037
|
+
/**
|
|
1038
|
+
* Error response
|
|
1039
|
+
*/
|
|
1040
|
+
default: ErrorResponse;
|
|
1041
|
+
};
|
|
1042
|
+
export type BillingSubscriptionUpdateError = BillingSubscriptionUpdateErrors[keyof BillingSubscriptionUpdateErrors];
|
|
1043
|
+
export type BillingSubscriptionUpdateResponses = {
|
|
1044
|
+
/**
|
|
1045
|
+
* Response
|
|
1046
|
+
*/
|
|
1047
|
+
200: {
|
|
1048
|
+
status: 'confirmation_required' | 'success' | 'payment_failed';
|
|
1049
|
+
client_secret?: string;
|
|
1050
|
+
failure_code?: string;
|
|
1051
|
+
};
|
|
1052
|
+
};
|
|
1053
|
+
export type BillingSubscriptionUpdateResponse = BillingSubscriptionUpdateResponses[keyof BillingSubscriptionUpdateResponses];
|
|
1054
|
+
export type BillingSubscriptionPreviewUpdateData = {
|
|
1055
|
+
body?: {
|
|
1056
|
+
plan: 'free' | 'starter' | 'pro' | 'premium' | 'business';
|
|
1057
|
+
billing_period: 'month' | 'year';
|
|
1058
|
+
};
|
|
1059
|
+
path?: never;
|
|
1060
|
+
query?: never;
|
|
1061
|
+
url: '/billing/subscription/preview';
|
|
1062
|
+
};
|
|
1063
|
+
export type BillingSubscriptionPreviewUpdateErrors = {
|
|
1064
|
+
/**
|
|
1065
|
+
* Error response
|
|
1066
|
+
*/
|
|
1067
|
+
default: ErrorResponse;
|
|
1068
|
+
};
|
|
1069
|
+
export type BillingSubscriptionPreviewUpdateError = BillingSubscriptionPreviewUpdateErrors[keyof BillingSubscriptionPreviewUpdateErrors];
|
|
1070
|
+
export type BillingSubscriptionPreviewUpdateResponses = {
|
|
1071
|
+
/**
|
|
1072
|
+
* Response
|
|
1073
|
+
*/
|
|
1074
|
+
200: {
|
|
1075
|
+
discount_percents: Array<number>;
|
|
1076
|
+
total_excluding_tax: number;
|
|
1077
|
+
total: number;
|
|
1078
|
+
amount_due: number;
|
|
1079
|
+
added_from_balance: number;
|
|
1080
|
+
consumed_balance: number;
|
|
1081
|
+
credited_to_balance: number;
|
|
1082
|
+
lines: Array<{
|
|
1083
|
+
amount: number;
|
|
1084
|
+
billing_period: 'day' | 'week' | 'month' | 'year';
|
|
1085
|
+
proration: boolean;
|
|
1086
|
+
plan?: 'free' | 'starter' | 'pro' | 'premium' | 'business';
|
|
1087
|
+
addon?: 'senders' | 'email_warmups';
|
|
1088
|
+
}>;
|
|
1089
|
+
next_renewal: number;
|
|
1090
|
+
total_tax_amounts: Array<{
|
|
1091
|
+
amount: number;
|
|
1092
|
+
}>;
|
|
1093
|
+
};
|
|
1094
|
+
};
|
|
1095
|
+
export type BillingSubscriptionPreviewUpdateResponse = BillingSubscriptionPreviewUpdateResponses[keyof BillingSubscriptionPreviewUpdateResponses];
|
|
1096
|
+
export type BillingGetPricesData = {
|
|
1097
|
+
body?: never;
|
|
1098
|
+
path?: never;
|
|
1099
|
+
query: {
|
|
1100
|
+
currency: string;
|
|
1101
|
+
};
|
|
1102
|
+
url: '/billing/prices';
|
|
1103
|
+
};
|
|
1104
|
+
export type BillingGetPricesErrors = {
|
|
1105
|
+
/**
|
|
1106
|
+
* Error response
|
|
1107
|
+
*/
|
|
1108
|
+
default: ErrorResponse;
|
|
1109
|
+
};
|
|
1110
|
+
export type BillingGetPricesError = BillingGetPricesErrors[keyof BillingGetPricesErrors];
|
|
1111
|
+
export type BillingGetPricesResponses = {
|
|
1112
|
+
/**
|
|
1113
|
+
* Response
|
|
1114
|
+
*/
|
|
1115
|
+
200: {
|
|
1116
|
+
free?: {
|
|
1117
|
+
month: number;
|
|
1118
|
+
year: number;
|
|
1119
|
+
};
|
|
1120
|
+
starter?: {
|
|
1121
|
+
month: number;
|
|
1122
|
+
year: number;
|
|
1123
|
+
};
|
|
1124
|
+
pro?: {
|
|
1125
|
+
month: number;
|
|
1126
|
+
year: number;
|
|
1127
|
+
};
|
|
1128
|
+
premium?: {
|
|
1129
|
+
month: number;
|
|
1130
|
+
year: number;
|
|
1131
|
+
};
|
|
1132
|
+
business?: {
|
|
1133
|
+
month: number;
|
|
1134
|
+
year: number;
|
|
1135
|
+
};
|
|
1136
|
+
};
|
|
1137
|
+
};
|
|
1138
|
+
export type BillingGetPricesResponse = BillingGetPricesResponses[keyof BillingGetPricesResponses];
|
|
887
1139
|
export type GetOpenapiJsonData = {
|
|
888
1140
|
body?: never;
|
|
889
1141
|
path?: never;
|