mailmeteor 0.0.3
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/README.md +49 -0
- package/dist/generated-sdk/client/client.gen.d.ts +3 -0
- package/dist/generated-sdk/client/client.gen.d.ts.map +1 -0
- package/dist/generated-sdk/client/index.d.ts +9 -0
- package/dist/generated-sdk/client/index.d.ts.map +1 -0
- package/dist/generated-sdk/client/types.gen.d.ts +118 -0
- package/dist/generated-sdk/client/types.gen.d.ts.map +1 -0
- package/dist/generated-sdk/client/utils.gen.d.ts +34 -0
- package/dist/generated-sdk/client/utils.gen.d.ts.map +1 -0
- package/dist/generated-sdk/client.gen.d.ts +13 -0
- package/dist/generated-sdk/client.gen.d.ts.map +1 -0
- package/dist/generated-sdk/core/auth.gen.d.ts +19 -0
- package/dist/generated-sdk/core/auth.gen.d.ts.map +1 -0
- package/dist/generated-sdk/core/bodySerializer.gen.d.ts +26 -0
- package/dist/generated-sdk/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated-sdk/core/params.gen.d.ts +44 -0
- package/dist/generated-sdk/core/params.gen.d.ts.map +1 -0
- package/dist/generated-sdk/core/pathSerializer.gen.d.ts +34 -0
- package/dist/generated-sdk/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated-sdk/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/generated-sdk/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/generated-sdk/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/generated-sdk/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated-sdk/core/types.gen.d.ts +79 -0
- package/dist/generated-sdk/core/types.gen.d.ts.map +1 -0
- package/dist/generated-sdk/core/utils.gen.d.ts +20 -0
- package/dist/generated-sdk/core/utils.gen.d.ts.map +1 -0
- package/dist/generated-sdk/index.d.ts +4 -0
- package/dist/generated-sdk/index.d.ts.map +1 -0
- package/dist/generated-sdk/sdk.gen.d.ts +112 -0
- package/dist/generated-sdk/sdk.gen.d.ts.map +1 -0
- package/dist/generated-sdk/types.gen.d.ts +426 -0
- package/dist/generated-sdk/types.gen.d.ts.map +1 -0
- package/dist/index.cjs +1323 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +1420 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.mjs +1320 -0
- package/dist/index.mjs.map +1 -0
- package/dist/types/generated-sdk/client/client.gen.d.ts +3 -0
- package/dist/types/generated-sdk/client/client.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/client/index.d.ts +9 -0
- package/dist/types/generated-sdk/client/index.d.ts.map +1 -0
- package/dist/types/generated-sdk/client/types.gen.d.ts +118 -0
- package/dist/types/generated-sdk/client/types.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/client/utils.gen.d.ts +34 -0
- package/dist/types/generated-sdk/client/utils.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/client.gen.d.ts +13 -0
- package/dist/types/generated-sdk/client.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/core/auth.gen.d.ts +19 -0
- package/dist/types/generated-sdk/core/auth.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/core/bodySerializer.gen.d.ts +26 -0
- package/dist/types/generated-sdk/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/core/params.gen.d.ts +44 -0
- package/dist/types/generated-sdk/core/params.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/core/pathSerializer.gen.d.ts +34 -0
- package/dist/types/generated-sdk/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/types/generated-sdk/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/types/generated-sdk/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/core/types.gen.d.ts +79 -0
- package/dist/types/generated-sdk/core/types.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/core/utils.gen.d.ts +20 -0
- package/dist/types/generated-sdk/core/utils.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/index.d.ts +4 -0
- package/dist/types/generated-sdk/index.d.ts.map +1 -0
- package/dist/types/generated-sdk/sdk.gen.d.ts +183 -0
- package/dist/types/generated-sdk/sdk.gen.d.ts.map +1 -0
- package/dist/types/generated-sdk/types.gen.d.ts +906 -0
- package/dist/types/generated-sdk/types.gen.d.ts.map +1 -0
- package/dist/types/index.d.ts +24 -0
- package/dist/types/index.d.ts.map +1 -0
- package/package.json +39 -0
|
@@ -0,0 +1,906 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: `${string}://${string}/v1` | (string & {});
|
|
3
|
+
};
|
|
4
|
+
export type ErrorResponse = {
|
|
5
|
+
error: {
|
|
6
|
+
status: number;
|
|
7
|
+
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';
|
|
8
|
+
message: string;
|
|
9
|
+
type?: string;
|
|
10
|
+
details?: {
|
|
11
|
+
[key: string]: unknown;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
message: string;
|
|
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
|
+
};
|
|
17
|
+
export type AddonsResponse200 = {
|
|
18
|
+
senders?: {
|
|
19
|
+
included_per_seat: number;
|
|
20
|
+
included_total: number;
|
|
21
|
+
used: number;
|
|
22
|
+
extra: {
|
|
23
|
+
price_amount: number;
|
|
24
|
+
currency: string;
|
|
25
|
+
quantity_per_addon: number;
|
|
26
|
+
interval: 'day' | 'week' | 'month' | 'year';
|
|
27
|
+
subscribed: number;
|
|
28
|
+
} | null;
|
|
29
|
+
};
|
|
30
|
+
email_warmups?: {
|
|
31
|
+
included_per_seat: number;
|
|
32
|
+
included_total: number;
|
|
33
|
+
used: number;
|
|
34
|
+
extra: {
|
|
35
|
+
price_amount: number;
|
|
36
|
+
currency: string;
|
|
37
|
+
quantity_per_addon: number;
|
|
38
|
+
interval: 'day' | 'week' | 'month' | 'year';
|
|
39
|
+
subscribed: number;
|
|
40
|
+
} | null;
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
export type PreviewBody = {
|
|
44
|
+
plan: 'free' | 'starter' | 'pro' | 'premium' | 'business';
|
|
45
|
+
billing_period: 'month' | 'year';
|
|
46
|
+
};
|
|
47
|
+
export type PreviewParams = {
|
|
48
|
+
addon: 'senders' | 'email_warmups';
|
|
49
|
+
};
|
|
50
|
+
export type PreviewResponse200 = {
|
|
51
|
+
discount_percents: Array<number>;
|
|
52
|
+
total_excluding_tax: number;
|
|
53
|
+
total: number;
|
|
54
|
+
amount_due: number;
|
|
55
|
+
added_from_balance: number;
|
|
56
|
+
consumed_balance: number;
|
|
57
|
+
credited_to_balance: number;
|
|
58
|
+
lines: Array<{
|
|
59
|
+
amount: number;
|
|
60
|
+
billing_period: 'day' | 'week' | 'month' | 'year';
|
|
61
|
+
proration: boolean;
|
|
62
|
+
plan?: 'free' | 'starter' | 'pro' | 'premium' | 'business';
|
|
63
|
+
addon?: 'senders' | 'email_warmups';
|
|
64
|
+
}>;
|
|
65
|
+
next_renewal: number;
|
|
66
|
+
total_tax_amounts: Array<{
|
|
67
|
+
amount: number;
|
|
68
|
+
}>;
|
|
69
|
+
};
|
|
70
|
+
export type AddonBody = {
|
|
71
|
+
quantity: number;
|
|
72
|
+
};
|
|
73
|
+
export type AddonParams = {
|
|
74
|
+
addon: 'senders' | 'email_warmups';
|
|
75
|
+
};
|
|
76
|
+
export type AddonResponse200 = Array<{
|
|
77
|
+
id: string;
|
|
78
|
+
email: string;
|
|
79
|
+
usage: number;
|
|
80
|
+
}>;
|
|
81
|
+
export type SubscriptionResponse200 = {
|
|
82
|
+
status: 'confirmation_required' | 'success' | 'payment_failed';
|
|
83
|
+
client_secret?: string;
|
|
84
|
+
failure_code?: string;
|
|
85
|
+
};
|
|
86
|
+
export type SubscriptionBody = {
|
|
87
|
+
plan: 'free' | 'starter' | 'pro' | 'premium' | 'business';
|
|
88
|
+
billing_period: 'month' | 'year';
|
|
89
|
+
};
|
|
90
|
+
export type PricesQuery = {
|
|
91
|
+
currency: string;
|
|
92
|
+
};
|
|
93
|
+
export type PricesResponse200 = {
|
|
94
|
+
free?: {
|
|
95
|
+
month: number;
|
|
96
|
+
year: number;
|
|
97
|
+
};
|
|
98
|
+
starter?: {
|
|
99
|
+
month: number;
|
|
100
|
+
year: number;
|
|
101
|
+
};
|
|
102
|
+
pro?: {
|
|
103
|
+
month: number;
|
|
104
|
+
year: number;
|
|
105
|
+
};
|
|
106
|
+
premium?: {
|
|
107
|
+
month: number;
|
|
108
|
+
year: number;
|
|
109
|
+
};
|
|
110
|
+
business?: {
|
|
111
|
+
month: number;
|
|
112
|
+
year: number;
|
|
113
|
+
};
|
|
114
|
+
};
|
|
115
|
+
export type CurrentResponse200 = {
|
|
116
|
+
current_organization_id: string | null;
|
|
117
|
+
};
|
|
118
|
+
export type CurrentBody = {
|
|
119
|
+
organization_id?: string | null;
|
|
120
|
+
};
|
|
121
|
+
export type OrganizationsResponse200 = Array<{
|
|
122
|
+
name: string;
|
|
123
|
+
owner: string;
|
|
124
|
+
/**
|
|
125
|
+
* Creation date
|
|
126
|
+
*/
|
|
127
|
+
created_at: string;
|
|
128
|
+
/**
|
|
129
|
+
* Last Update date
|
|
130
|
+
*/
|
|
131
|
+
updated_at?: string;
|
|
132
|
+
id: string;
|
|
133
|
+
object: 'organization';
|
|
134
|
+
}>;
|
|
135
|
+
export type OrganizationsBody = {
|
|
136
|
+
name: string;
|
|
137
|
+
};
|
|
138
|
+
export type OrganizationsResponse201 = {
|
|
139
|
+
name: string;
|
|
140
|
+
owner: string;
|
|
141
|
+
/**
|
|
142
|
+
* Creation date
|
|
143
|
+
*/
|
|
144
|
+
created_at: string;
|
|
145
|
+
/**
|
|
146
|
+
* Last Update date
|
|
147
|
+
*/
|
|
148
|
+
updated_at?: string;
|
|
149
|
+
id: string;
|
|
150
|
+
object: 'organization';
|
|
151
|
+
};
|
|
152
|
+
export type OrganizationIdParams = {
|
|
153
|
+
organization_id: string;
|
|
154
|
+
};
|
|
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;
|
|
178
|
+
};
|
|
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;
|
|
188
|
+
/**
|
|
189
|
+
* Last Update date
|
|
190
|
+
*/
|
|
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';
|
|
199
|
+
};
|
|
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;
|
|
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';
|
|
240
|
+
};
|
|
241
|
+
export type OpenapiJsonResponse200 = unknown;
|
|
242
|
+
export type BillingAddonsGetAddonsData = {
|
|
243
|
+
body?: never;
|
|
244
|
+
path?: never;
|
|
245
|
+
query?: never;
|
|
246
|
+
url: '/billing/addons';
|
|
247
|
+
};
|
|
248
|
+
export type BillingAddonsGetAddonsErrors = {
|
|
249
|
+
/**
|
|
250
|
+
* Error response
|
|
251
|
+
*/
|
|
252
|
+
default: ErrorResponse;
|
|
253
|
+
};
|
|
254
|
+
export type BillingAddonsGetAddonsError = BillingAddonsGetAddonsErrors[keyof BillingAddonsGetAddonsErrors];
|
|
255
|
+
export type BillingAddonsGetAddonsResponses = {
|
|
256
|
+
/**
|
|
257
|
+
* Response
|
|
258
|
+
*/
|
|
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
|
+
};
|
|
285
|
+
};
|
|
286
|
+
export type BillingAddonsGetAddonsResponse = BillingAddonsGetAddonsResponses[keyof BillingAddonsGetAddonsResponses];
|
|
287
|
+
export type BillingAddonsPreviewUpdateData = {
|
|
288
|
+
body?: {
|
|
289
|
+
quantity: number;
|
|
290
|
+
};
|
|
291
|
+
path: {
|
|
292
|
+
addon: 'senders' | 'email_warmups';
|
|
293
|
+
};
|
|
294
|
+
query?: never;
|
|
295
|
+
url: '/billing/addons/{addon}/preview';
|
|
296
|
+
};
|
|
297
|
+
export type BillingAddonsPreviewUpdateErrors = {
|
|
298
|
+
/**
|
|
299
|
+
* Error response
|
|
300
|
+
*/
|
|
301
|
+
default: ErrorResponse;
|
|
302
|
+
};
|
|
303
|
+
export type BillingAddonsPreviewUpdateError = BillingAddonsPreviewUpdateErrors[keyof BillingAddonsPreviewUpdateErrors];
|
|
304
|
+
export type BillingAddonsPreviewUpdateResponses = {
|
|
305
|
+
/**
|
|
306
|
+
* Response
|
|
307
|
+
*/
|
|
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;
|
|
316
|
+
};
|
|
317
|
+
};
|
|
318
|
+
export type BillingAddonsPreviewUpdateResponse = BillingAddonsPreviewUpdateResponses[keyof BillingAddonsPreviewUpdateResponses];
|
|
319
|
+
export type BillingAddonsGetAddonUsagesData = {
|
|
320
|
+
body?: never;
|
|
321
|
+
path: {
|
|
322
|
+
addon: 'senders' | 'email_warmups';
|
|
323
|
+
};
|
|
324
|
+
query?: never;
|
|
325
|
+
url: '/billing/addons/{addon}';
|
|
326
|
+
};
|
|
327
|
+
export type BillingAddonsGetAddonUsagesErrors = {
|
|
328
|
+
/**
|
|
329
|
+
* Error response
|
|
330
|
+
*/
|
|
331
|
+
default: ErrorResponse;
|
|
332
|
+
};
|
|
333
|
+
export type BillingAddonsGetAddonUsagesError = BillingAddonsGetAddonUsagesErrors[keyof BillingAddonsGetAddonUsagesErrors];
|
|
334
|
+
export type BillingAddonsGetAddonUsagesResponses = {
|
|
335
|
+
/**
|
|
336
|
+
* Response
|
|
337
|
+
*/
|
|
338
|
+
200: Array<{
|
|
339
|
+
id: string;
|
|
340
|
+
email: string;
|
|
341
|
+
usage: number;
|
|
342
|
+
}>;
|
|
343
|
+
};
|
|
344
|
+
export type BillingAddonsGetAddonUsagesResponse = BillingAddonsGetAddonUsagesResponses[keyof BillingAddonsGetAddonUsagesResponses];
|
|
345
|
+
export type BillingAddonsUpdateData = {
|
|
346
|
+
body?: {
|
|
347
|
+
quantity: number;
|
|
348
|
+
};
|
|
349
|
+
path: {
|
|
350
|
+
addon: 'senders' | 'email_warmups';
|
|
351
|
+
};
|
|
352
|
+
query?: never;
|
|
353
|
+
url: '/billing/addons/{addon}';
|
|
354
|
+
};
|
|
355
|
+
export type BillingAddonsUpdateErrors = {
|
|
356
|
+
/**
|
|
357
|
+
* Error response
|
|
358
|
+
*/
|
|
359
|
+
default: ErrorResponse;
|
|
360
|
+
};
|
|
361
|
+
export type BillingAddonsUpdateError = BillingAddonsUpdateErrors[keyof BillingAddonsUpdateErrors];
|
|
362
|
+
export type BillingAddonsUpdateResponses = {
|
|
363
|
+
/**
|
|
364
|
+
* Response
|
|
365
|
+
*/
|
|
366
|
+
200: {
|
|
367
|
+
status: 'confirmation_required' | 'success' | 'payment_failed';
|
|
368
|
+
client_secret?: string;
|
|
369
|
+
failure_code?: string;
|
|
370
|
+
};
|
|
371
|
+
};
|
|
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 = {
|
|
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 = {
|
|
621
|
+
/**
|
|
622
|
+
* Error response
|
|
623
|
+
*/
|
|
624
|
+
default: ErrorResponse;
|
|
625
|
+
};
|
|
626
|
+
export type OrganizationCreateError = OrganizationCreateErrors[keyof OrganizationCreateErrors];
|
|
627
|
+
export type OrganizationCreateResponses = {
|
|
628
|
+
/**
|
|
629
|
+
* Response
|
|
630
|
+
*/
|
|
631
|
+
201: {
|
|
632
|
+
name: string;
|
|
633
|
+
owner: string;
|
|
634
|
+
/**
|
|
635
|
+
* Creation date
|
|
636
|
+
*/
|
|
637
|
+
created_at: string;
|
|
638
|
+
/**
|
|
639
|
+
* Last Update date
|
|
640
|
+
*/
|
|
641
|
+
updated_at?: string;
|
|
642
|
+
id: string;
|
|
643
|
+
object: 'organization';
|
|
644
|
+
};
|
|
645
|
+
};
|
|
646
|
+
export type OrganizationCreateResponse = OrganizationCreateResponses[keyof OrganizationCreateResponses];
|
|
647
|
+
export type OrganizationDeleteData = {
|
|
648
|
+
body?: never;
|
|
649
|
+
path: {
|
|
650
|
+
organization_id: string;
|
|
651
|
+
};
|
|
652
|
+
query?: never;
|
|
653
|
+
url: '/organizations/{organization_id}';
|
|
654
|
+
};
|
|
655
|
+
export type OrganizationDeleteErrors = {
|
|
656
|
+
/**
|
|
657
|
+
* Error response
|
|
658
|
+
*/
|
|
659
|
+
default: ErrorResponse;
|
|
660
|
+
};
|
|
661
|
+
export type OrganizationDeleteError = OrganizationDeleteErrors[keyof OrganizationDeleteErrors];
|
|
662
|
+
export type OrganizationDeleteResponses = {
|
|
663
|
+
/**
|
|
664
|
+
* Response
|
|
665
|
+
*/
|
|
666
|
+
204: void;
|
|
667
|
+
};
|
|
668
|
+
export type OrganizationDeleteResponse = OrganizationDeleteResponses[keyof OrganizationDeleteResponses];
|
|
669
|
+
export type OrganizationRetrieveData = {
|
|
670
|
+
body?: never;
|
|
671
|
+
path: {
|
|
672
|
+
organization_id: string;
|
|
673
|
+
};
|
|
674
|
+
query?: never;
|
|
675
|
+
url: '/organizations/{organization_id}';
|
|
676
|
+
};
|
|
677
|
+
export type OrganizationRetrieveErrors = {
|
|
678
|
+
/**
|
|
679
|
+
* Error response
|
|
680
|
+
*/
|
|
681
|
+
default: ErrorResponse;
|
|
682
|
+
};
|
|
683
|
+
export type OrganizationRetrieveError = OrganizationRetrieveErrors[keyof OrganizationRetrieveErrors];
|
|
684
|
+
export type OrganizationRetrieveResponses = {
|
|
685
|
+
/**
|
|
686
|
+
* Response
|
|
687
|
+
*/
|
|
688
|
+
200: {
|
|
689
|
+
name: string;
|
|
690
|
+
owner: string;
|
|
691
|
+
/**
|
|
692
|
+
* Creation date
|
|
693
|
+
*/
|
|
694
|
+
created_at: string;
|
|
695
|
+
/**
|
|
696
|
+
* Last Update date
|
|
697
|
+
*/
|
|
698
|
+
updated_at?: string;
|
|
699
|
+
id: string;
|
|
700
|
+
object: 'organization';
|
|
701
|
+
};
|
|
702
|
+
};
|
|
703
|
+
export type OrganizationRetrieveResponse = OrganizationRetrieveResponses[keyof OrganizationRetrieveResponses];
|
|
704
|
+
export type OrganizationUpdateData = {
|
|
705
|
+
body?: {
|
|
706
|
+
name?: string;
|
|
707
|
+
};
|
|
708
|
+
path: {
|
|
709
|
+
organization_id: string;
|
|
710
|
+
};
|
|
711
|
+
query?: never;
|
|
712
|
+
url: '/organizations/{organization_id}';
|
|
713
|
+
};
|
|
714
|
+
export type OrganizationUpdateErrors = {
|
|
715
|
+
/**
|
|
716
|
+
* Error response
|
|
717
|
+
*/
|
|
718
|
+
default: ErrorResponse;
|
|
719
|
+
};
|
|
720
|
+
export type OrganizationUpdateError = OrganizationUpdateErrors[keyof OrganizationUpdateErrors];
|
|
721
|
+
export type OrganizationUpdateResponses = {
|
|
722
|
+
/**
|
|
723
|
+
* Response
|
|
724
|
+
*/
|
|
725
|
+
200: {
|
|
726
|
+
name: string;
|
|
727
|
+
owner: string;
|
|
728
|
+
/**
|
|
729
|
+
* Creation date
|
|
730
|
+
*/
|
|
731
|
+
created_at: string;
|
|
732
|
+
/**
|
|
733
|
+
* Last Update date
|
|
734
|
+
*/
|
|
735
|
+
updated_at?: string;
|
|
736
|
+
id: string;
|
|
737
|
+
object: 'organization';
|
|
738
|
+
};
|
|
739
|
+
};
|
|
740
|
+
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;
|
|
749
|
+
};
|
|
750
|
+
url: '/organizations/{organization_id}/members';
|
|
751
|
+
};
|
|
752
|
+
export type OrganizationMemberListErrors = {
|
|
753
|
+
/**
|
|
754
|
+
* Error response
|
|
755
|
+
*/
|
|
756
|
+
default: ErrorResponse;
|
|
757
|
+
};
|
|
758
|
+
export type OrganizationMemberListError = OrganizationMemberListErrors[keyof OrganizationMemberListErrors];
|
|
759
|
+
export type OrganizationMemberListResponses = {
|
|
760
|
+
/**
|
|
761
|
+
* Response
|
|
762
|
+
*/
|
|
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;
|
|
776
|
+
id: string;
|
|
777
|
+
organization_id: string;
|
|
778
|
+
object: 'organization_member';
|
|
779
|
+
}>;
|
|
780
|
+
};
|
|
781
|
+
export type OrganizationMemberListResponse = OrganizationMemberListResponses[keyof OrganizationMemberListResponses];
|
|
782
|
+
export type OrganizationMemberCreateData = {
|
|
783
|
+
body?: {
|
|
784
|
+
email: string;
|
|
785
|
+
role: 'admin' | 'member';
|
|
786
|
+
};
|
|
787
|
+
path: {
|
|
788
|
+
organization_id: string;
|
|
789
|
+
};
|
|
790
|
+
query?: never;
|
|
791
|
+
url: '/organizations/{organization_id}/members';
|
|
792
|
+
};
|
|
793
|
+
export type OrganizationMemberCreateErrors = {
|
|
794
|
+
/**
|
|
795
|
+
* Error response
|
|
796
|
+
*/
|
|
797
|
+
default: ErrorResponse;
|
|
798
|
+
};
|
|
799
|
+
export type OrganizationMemberCreateError = OrganizationMemberCreateErrors[keyof OrganizationMemberCreateErrors];
|
|
800
|
+
export type OrganizationMemberCreateResponses = {
|
|
801
|
+
/**
|
|
802
|
+
* Response
|
|
803
|
+
*/
|
|
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';
|
|
820
|
+
};
|
|
821
|
+
};
|
|
822
|
+
export type OrganizationMemberCreateResponse = OrganizationMemberCreateResponses[keyof OrganizationMemberCreateResponses];
|
|
823
|
+
export type OrganizationMemberDeleteData = {
|
|
824
|
+
body?: never;
|
|
825
|
+
path: {
|
|
826
|
+
organization_id: string;
|
|
827
|
+
member_id: string;
|
|
828
|
+
};
|
|
829
|
+
query?: never;
|
|
830
|
+
url: '/organizations/{organization_id}/members/{member_id}';
|
|
831
|
+
};
|
|
832
|
+
export type OrganizationMemberDeleteErrors = {
|
|
833
|
+
/**
|
|
834
|
+
* Error response
|
|
835
|
+
*/
|
|
836
|
+
default: ErrorResponse;
|
|
837
|
+
};
|
|
838
|
+
export type OrganizationMemberDeleteError = OrganizationMemberDeleteErrors[keyof OrganizationMemberDeleteErrors];
|
|
839
|
+
export type OrganizationMemberDeleteResponses = {
|
|
840
|
+
/**
|
|
841
|
+
* Response
|
|
842
|
+
*/
|
|
843
|
+
204: void;
|
|
844
|
+
};
|
|
845
|
+
export type OrganizationMemberDeleteResponse = OrganizationMemberDeleteResponses[keyof OrganizationMemberDeleteResponses];
|
|
846
|
+
export type OrganizationMemberUpdateData = {
|
|
847
|
+
body?: {
|
|
848
|
+
role: 'admin' | 'member';
|
|
849
|
+
};
|
|
850
|
+
path: {
|
|
851
|
+
organization_id: string;
|
|
852
|
+
member_id: string;
|
|
853
|
+
};
|
|
854
|
+
query?: never;
|
|
855
|
+
url: '/organizations/{organization_id}/members/{member_id}';
|
|
856
|
+
};
|
|
857
|
+
export type OrganizationMemberUpdateErrors = {
|
|
858
|
+
/**
|
|
859
|
+
* Error response
|
|
860
|
+
*/
|
|
861
|
+
default: ErrorResponse;
|
|
862
|
+
};
|
|
863
|
+
export type OrganizationMemberUpdateError = OrganizationMemberUpdateErrors[keyof OrganizationMemberUpdateErrors];
|
|
864
|
+
export type OrganizationMemberUpdateResponses = {
|
|
865
|
+
/**
|
|
866
|
+
* Response
|
|
867
|
+
*/
|
|
868
|
+
200: {
|
|
869
|
+
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;
|
|
881
|
+
id: string;
|
|
882
|
+
organization_id: string;
|
|
883
|
+
object: 'organization_member';
|
|
884
|
+
};
|
|
885
|
+
};
|
|
886
|
+
export type OrganizationMemberUpdateResponse = OrganizationMemberUpdateResponses[keyof OrganizationMemberUpdateResponses];
|
|
887
|
+
export type GetOpenapiJsonData = {
|
|
888
|
+
body?: never;
|
|
889
|
+
path?: never;
|
|
890
|
+
query?: never;
|
|
891
|
+
url: '/openapi.json';
|
|
892
|
+
};
|
|
893
|
+
export type GetOpenapiJsonErrors = {
|
|
894
|
+
/**
|
|
895
|
+
* Error response
|
|
896
|
+
*/
|
|
897
|
+
default: ErrorResponse;
|
|
898
|
+
};
|
|
899
|
+
export type GetOpenapiJsonError = GetOpenapiJsonErrors[keyof GetOpenapiJsonErrors];
|
|
900
|
+
export type GetOpenapiJsonResponses = {
|
|
901
|
+
/**
|
|
902
|
+
* Response
|
|
903
|
+
*/
|
|
904
|
+
200: unknown;
|
|
905
|
+
};
|
|
906
|
+
//# sourceMappingURL=types.gen.d.ts.map
|