resend 6.28.0 → 6.28.1
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 +2 -2
- package/dist/index.d.cts +362 -362
- package/dist/index.d.mts +362 -362
- package/dist/index.mjs +1 -1
- package/package.json +25 -23
package/dist/index.d.mts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import * as React$1 from "react";
|
|
2
|
-
|
|
3
2
|
//#region src/api-keys/interfaces/api-key.d.ts
|
|
4
|
-
interface ApiKey {
|
|
3
|
+
export interface ApiKey {
|
|
5
4
|
created_at: string;
|
|
6
5
|
id: string;
|
|
7
6
|
last_used_at: string | null;
|
|
@@ -19,7 +18,7 @@ interface ApiKey {
|
|
|
19
18
|
* Not to be confused with InboundAttachment, which is the raw metadata
|
|
20
19
|
* embedded inside GET /inbounds/{id} — no signed URL, nullable DB columns.
|
|
21
20
|
*/
|
|
22
|
-
interface AttachmentData {
|
|
21
|
+
export interface AttachmentData {
|
|
23
22
|
id: string;
|
|
24
23
|
filename?: string;
|
|
25
24
|
size: number;
|
|
@@ -31,22 +30,22 @@ interface AttachmentData {
|
|
|
31
30
|
}
|
|
32
31
|
//#endregion
|
|
33
32
|
//#region src/common/interfaces/delete-option.interface.d.ts
|
|
34
|
-
interface DeleteOptions {
|
|
33
|
+
export interface DeleteOptions {
|
|
35
34
|
headers?: HeadersInit;
|
|
36
35
|
}
|
|
37
36
|
//#endregion
|
|
38
37
|
//#region src/domains/interfaces/domain.d.ts
|
|
39
|
-
type DomainRegion = 'us-east-1' | 'eu-west-1' | 'sa-east-1' | 'ap-northeast-1';
|
|
40
|
-
type DomainCapabilityStatus = 'enabled' | 'disabled';
|
|
41
|
-
interface DomainCapabilities {
|
|
38
|
+
export type DomainRegion = 'us-east-1' | 'eu-west-1' | 'sa-east-1' | 'ap-northeast-1';
|
|
39
|
+
export type DomainCapabilityStatus = 'enabled' | 'disabled';
|
|
40
|
+
export interface DomainCapabilities {
|
|
42
41
|
sending: DomainCapabilityStatus;
|
|
43
42
|
receiving: DomainCapabilityStatus;
|
|
44
43
|
}
|
|
45
|
-
type DomainNameservers = 'Amazon Route 53' | 'Cloudflare' | 'Digital Ocean' | 'GoDaddy' | 'Google Domains' | 'Namecheap' | 'Unidentified' | 'Vercel';
|
|
46
|
-
type DomainRecordStatus = 'pending' | 'verified' | 'failed' | 'temporary_failure' | 'not_started';
|
|
47
|
-
type DomainStatus = 'pending' | 'verified' | 'failed' | 'not_started' | 'partially_verified' | 'partially_failed';
|
|
48
|
-
type DomainRecords = DomainSpfRecord | DomainDkimRecord | ReceivingRecord | TrackingRecord | TrackingCaaRecord;
|
|
49
|
-
interface DomainSpfRecord {
|
|
44
|
+
export type DomainNameservers = 'Amazon Route 53' | 'Cloudflare' | 'Digital Ocean' | 'GoDaddy' | 'Google Domains' | 'Namecheap' | 'Unidentified' | 'Vercel';
|
|
45
|
+
export type DomainRecordStatus = 'pending' | 'verified' | 'failed' | 'temporary_failure' | 'not_started';
|
|
46
|
+
export type DomainStatus = 'pending' | 'verified' | 'failed' | 'not_started' | 'partially_verified' | 'partially_failed';
|
|
47
|
+
export type DomainRecords = DomainSpfRecord | DomainDkimRecord | ReceivingRecord | TrackingRecord | TrackingCaaRecord;
|
|
48
|
+
export interface DomainSpfRecord {
|
|
50
49
|
record: 'SPF';
|
|
51
50
|
name: string;
|
|
52
51
|
value: string;
|
|
@@ -57,7 +56,7 @@ interface DomainSpfRecord {
|
|
|
57
56
|
priority?: number;
|
|
58
57
|
proxy_status?: 'enable' | 'disable';
|
|
59
58
|
}
|
|
60
|
-
interface DomainDkimRecord {
|
|
59
|
+
export interface DomainDkimRecord {
|
|
61
60
|
record: 'DKIM';
|
|
62
61
|
name: string;
|
|
63
62
|
value: string;
|
|
@@ -68,7 +67,7 @@ interface DomainDkimRecord {
|
|
|
68
67
|
priority?: number;
|
|
69
68
|
proxy_status?: 'enable' | 'disable';
|
|
70
69
|
}
|
|
71
|
-
interface ReceivingRecord {
|
|
70
|
+
export interface ReceivingRecord {
|
|
72
71
|
record: 'Receiving';
|
|
73
72
|
name: string;
|
|
74
73
|
value: string;
|
|
@@ -77,7 +76,7 @@ interface ReceivingRecord {
|
|
|
77
76
|
status: DomainRecordStatus;
|
|
78
77
|
priority: number;
|
|
79
78
|
}
|
|
80
|
-
interface TrackingRecord {
|
|
79
|
+
export interface TrackingRecord {
|
|
81
80
|
record: 'Tracking';
|
|
82
81
|
name: string;
|
|
83
82
|
value: string;
|
|
@@ -85,7 +84,7 @@ interface TrackingRecord {
|
|
|
85
84
|
ttl: string;
|
|
86
85
|
status: DomainRecordStatus;
|
|
87
86
|
}
|
|
88
|
-
interface TrackingCaaRecord {
|
|
87
|
+
export interface TrackingCaaRecord {
|
|
89
88
|
record: 'TrackingCAA';
|
|
90
89
|
name: string;
|
|
91
90
|
value: string;
|
|
@@ -93,7 +92,7 @@ interface TrackingCaaRecord {
|
|
|
93
92
|
ttl: string;
|
|
94
93
|
status: DomainRecordStatus;
|
|
95
94
|
}
|
|
96
|
-
interface Domain {
|
|
95
|
+
export interface Domain {
|
|
97
96
|
id: string;
|
|
98
97
|
name: string;
|
|
99
98
|
status: DomainStatus;
|
|
@@ -106,7 +105,7 @@ interface Domain {
|
|
|
106
105
|
}
|
|
107
106
|
//#endregion
|
|
108
107
|
//#region src/common/interfaces/domain-api-options.interface.d.ts
|
|
109
|
-
interface DomainApiOptions {
|
|
108
|
+
export interface DomainApiOptions {
|
|
110
109
|
name: string;
|
|
111
110
|
region?: string;
|
|
112
111
|
custom_return_path?: string;
|
|
@@ -139,14 +138,14 @@ type Tag$1 = {
|
|
|
139
138
|
};
|
|
140
139
|
//#endregion
|
|
141
140
|
//#region src/common/interfaces/email-api-options.interface.d.ts
|
|
142
|
-
interface EmailApiAttachment {
|
|
141
|
+
export interface EmailApiAttachment {
|
|
143
142
|
content?: string | Buffer;
|
|
144
143
|
filename?: string | false | undefined;
|
|
145
144
|
path?: string;
|
|
146
145
|
content_type?: string;
|
|
147
146
|
content_id?: string;
|
|
148
147
|
}
|
|
149
|
-
interface EmailApiOptions {
|
|
148
|
+
export interface EmailApiOptions {
|
|
150
149
|
from?: string;
|
|
151
150
|
to: string | string[];
|
|
152
151
|
subject?: string;
|
|
@@ -168,13 +167,13 @@ interface EmailApiOptions {
|
|
|
168
167
|
}
|
|
169
168
|
//#endregion
|
|
170
169
|
//#region src/common/interfaces/get-option.interface.d.ts
|
|
171
|
-
interface GetOptions {
|
|
170
|
+
export interface GetOptions {
|
|
172
171
|
query?: Record<string, unknown>;
|
|
173
172
|
headers?: HeadersInit;
|
|
174
173
|
}
|
|
175
174
|
//#endregion
|
|
176
175
|
//#region src/common/interfaces/idempotent-request.interface.d.ts
|
|
177
|
-
interface IdempotentRequest {
|
|
176
|
+
export interface IdempotentRequest {
|
|
178
177
|
/**
|
|
179
178
|
* Unique key that ensures the same operation is not processed multiple times.
|
|
180
179
|
* Allows for safe retries without duplicating operations.
|
|
@@ -184,7 +183,7 @@ interface IdempotentRequest {
|
|
|
184
183
|
}
|
|
185
184
|
//#endregion
|
|
186
185
|
//#region src/common/interfaces/pagination-options.interface.d.ts
|
|
187
|
-
type PaginationOptions = {
|
|
186
|
+
export type PaginationOptions = {
|
|
188
187
|
/**
|
|
189
188
|
* Maximum number of items to return (1-100, default: 20)
|
|
190
189
|
*/
|
|
@@ -202,14 +201,14 @@ type PaginationOptions = {
|
|
|
202
201
|
before?: string;
|
|
203
202
|
after?: never;
|
|
204
203
|
});
|
|
205
|
-
type PaginatedData<Data> = {
|
|
204
|
+
export type PaginatedData<Data> = {
|
|
206
205
|
object: 'list';
|
|
207
206
|
data: Data;
|
|
208
207
|
has_more: boolean;
|
|
209
208
|
};
|
|
210
209
|
//#endregion
|
|
211
210
|
//#region src/common/interfaces/patch-option.interface.d.ts
|
|
212
|
-
interface PatchOptions {
|
|
211
|
+
export interface PatchOptions {
|
|
213
212
|
query?: {
|
|
214
213
|
[key: string]: unknown;
|
|
215
214
|
};
|
|
@@ -217,7 +216,7 @@ interface PatchOptions {
|
|
|
217
216
|
}
|
|
218
217
|
//#endregion
|
|
219
218
|
//#region src/common/interfaces/post-option.interface.d.ts
|
|
220
|
-
interface PostOptions {
|
|
219
|
+
export interface PostOptions {
|
|
221
220
|
query?: {
|
|
222
221
|
[key: string]: unknown;
|
|
223
222
|
};
|
|
@@ -225,7 +224,7 @@ interface PostOptions {
|
|
|
225
224
|
}
|
|
226
225
|
//#endregion
|
|
227
226
|
//#region src/common/interfaces/put-option.interface.d.ts
|
|
228
|
-
interface PutOptions {
|
|
227
|
+
export interface PutOptions {
|
|
229
228
|
query?: {
|
|
230
229
|
[key: string]: unknown;
|
|
231
230
|
};
|
|
@@ -233,49 +232,49 @@ interface PutOptions {
|
|
|
233
232
|
}
|
|
234
233
|
//#endregion
|
|
235
234
|
//#region src/common/interfaces/require-at-least-one.d.ts
|
|
236
|
-
type RequireAtLeastOne<T> = { [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K
|
|
235
|
+
export type RequireAtLeastOne<T> = { [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>; }[keyof T];
|
|
237
236
|
//#endregion
|
|
238
237
|
//#region src/api-keys/interfaces/create-api-key-options.interface.d.ts
|
|
239
|
-
interface CreateApiKeyOptions {
|
|
238
|
+
export interface CreateApiKeyOptions {
|
|
240
239
|
name: string;
|
|
241
240
|
permission?: 'full_access' | 'sending_access';
|
|
242
241
|
domain_id?: string;
|
|
243
242
|
}
|
|
244
|
-
interface CreateApiKeyRequestOptions extends PostOptions {}
|
|
245
|
-
interface CreateApiKeyResponseSuccess {
|
|
243
|
+
export interface CreateApiKeyRequestOptions extends PostOptions {}
|
|
244
|
+
export interface CreateApiKeyResponseSuccess {
|
|
246
245
|
token: string;
|
|
247
246
|
id: string;
|
|
248
247
|
}
|
|
249
|
-
type CreateApiKeyResponse = Response<CreateApiKeyResponseSuccess>;
|
|
248
|
+
export type CreateApiKeyResponse = Response<CreateApiKeyResponseSuccess>;
|
|
250
249
|
//#endregion
|
|
251
250
|
//#region src/api-keys/interfaces/list-api-keys.interface.d.ts
|
|
252
|
-
type ListApiKeysOptions = PaginationOptions;
|
|
253
|
-
type ListApiKeysResponseSuccess = {
|
|
251
|
+
export type ListApiKeysOptions = PaginationOptions;
|
|
252
|
+
export type ListApiKeysResponseSuccess = {
|
|
254
253
|
object: 'list';
|
|
255
254
|
has_more: boolean;
|
|
256
255
|
data: Pick<ApiKey, 'name' | 'id' | 'created_at' | 'last_used_at'>[];
|
|
257
256
|
};
|
|
258
|
-
type ListApiKeysResponse = Response<ListApiKeysResponseSuccess>;
|
|
257
|
+
export type ListApiKeysResponse = Response<ListApiKeysResponseSuccess>;
|
|
259
258
|
//#endregion
|
|
260
259
|
//#region src/api-keys/interfaces/remove-api-keys.interface.d.ts
|
|
261
|
-
type RemoveApiKeyResponseSuccess = Pick<ApiKey, 'id'> & {
|
|
260
|
+
export type RemoveApiKeyResponseSuccess = Pick<ApiKey, 'id'> & {
|
|
262
261
|
object: 'api_key';
|
|
263
262
|
deleted: boolean;
|
|
264
263
|
};
|
|
265
|
-
type RemoveApiKeyResponse = Response<RemoveApiKeyResponseSuccess>;
|
|
264
|
+
export type RemoveApiKeyResponse = Response<RemoveApiKeyResponseSuccess>;
|
|
266
265
|
//#endregion
|
|
267
266
|
//#region src/api-keys/interfaces/update-api-key-options.interface.d.ts
|
|
268
|
-
interface UpdateApiKeyOptions {
|
|
267
|
+
export interface UpdateApiKeyOptions {
|
|
269
268
|
name: string;
|
|
270
269
|
}
|
|
271
|
-
interface UpdateApiKeyResponseSuccess {
|
|
270
|
+
export interface UpdateApiKeyResponseSuccess {
|
|
272
271
|
object: 'api_key';
|
|
273
272
|
id: string;
|
|
274
273
|
}
|
|
275
|
-
type UpdateApiKeyResponse = Response<UpdateApiKeyResponseSuccess>;
|
|
274
|
+
export type UpdateApiKeyResponse = Response<UpdateApiKeyResponseSuccess>;
|
|
276
275
|
//#endregion
|
|
277
276
|
//#region src/automations/interfaces/automation-step.interface.d.ts
|
|
278
|
-
type ConditionRule = {
|
|
277
|
+
export type ConditionRule = {
|
|
279
278
|
type: 'rule';
|
|
280
279
|
field: string;
|
|
281
280
|
operator: 'eq' | 'neq';
|
|
@@ -301,16 +300,16 @@ type ConditionRule = {
|
|
|
301
300
|
type: 'or';
|
|
302
301
|
rules: ConditionRule[];
|
|
303
302
|
};
|
|
304
|
-
type TemplateVariableValue = string | number | boolean | {
|
|
303
|
+
export type TemplateVariableValue = string | number | boolean | {
|
|
305
304
|
var: string;
|
|
306
305
|
} | Record<string, string | number | boolean> | Array<string | number | boolean | Record<string, string | number | boolean>>;
|
|
307
|
-
interface TriggerStepConfig {
|
|
306
|
+
export interface TriggerStepConfig {
|
|
308
307
|
eventName: string;
|
|
309
308
|
}
|
|
310
|
-
interface DelayStepConfig {
|
|
309
|
+
export interface DelayStepConfig {
|
|
311
310
|
duration: string;
|
|
312
311
|
}
|
|
313
|
-
interface SendEmailStepConfig {
|
|
312
|
+
export interface SendEmailStepConfig {
|
|
314
313
|
template: {
|
|
315
314
|
id: string;
|
|
316
315
|
variables?: Record<string, TemplateVariableValue>;
|
|
@@ -319,13 +318,13 @@ interface SendEmailStepConfig {
|
|
|
319
318
|
from?: string;
|
|
320
319
|
replyTo?: string;
|
|
321
320
|
}
|
|
322
|
-
interface WaitForEventStepConfig {
|
|
321
|
+
export interface WaitForEventStepConfig {
|
|
323
322
|
eventName: string;
|
|
324
323
|
timeout?: string;
|
|
325
324
|
filterRule?: ConditionRule;
|
|
326
325
|
}
|
|
327
|
-
type ConditionStepConfig = ConditionRule;
|
|
328
|
-
interface ContactUpdateStepConfig {
|
|
326
|
+
export type ConditionStepConfig = ConditionRule;
|
|
327
|
+
export interface ContactUpdateStepConfig {
|
|
329
328
|
firstName?: string | null | {
|
|
330
329
|
var: string;
|
|
331
330
|
};
|
|
@@ -339,11 +338,11 @@ interface ContactUpdateStepConfig {
|
|
|
339
338
|
var: string;
|
|
340
339
|
}>;
|
|
341
340
|
}
|
|
342
|
-
type ContactDeleteStepConfig = Record<string, never>;
|
|
343
|
-
interface AddToSegmentStepConfig {
|
|
341
|
+
export type ContactDeleteStepConfig = Record<string, never>;
|
|
342
|
+
export interface AddToSegmentStepConfig {
|
|
344
343
|
segmentId: string;
|
|
345
344
|
}
|
|
346
|
-
type AutomationStep = {
|
|
345
|
+
export type AutomationStep = {
|
|
347
346
|
key: string;
|
|
348
347
|
type: 'trigger';
|
|
349
348
|
config: TriggerStepConfig;
|
|
@@ -376,28 +375,28 @@ type AutomationStep = {
|
|
|
376
375
|
type: 'add_to_segment';
|
|
377
376
|
config: AddToSegmentStepConfig;
|
|
378
377
|
};
|
|
379
|
-
type AutomationConnectionType = 'default' | 'condition_met' | 'condition_not_met' | 'timeout' | 'event_received';
|
|
380
|
-
interface AutomationConnection {
|
|
378
|
+
export type AutomationConnectionType = 'default' | 'condition_met' | 'condition_not_met' | 'timeout' | 'event_received';
|
|
379
|
+
export interface AutomationConnection {
|
|
381
380
|
from: string;
|
|
382
381
|
to: string;
|
|
383
382
|
type?: AutomationConnectionType;
|
|
384
383
|
}
|
|
385
|
-
type AutomationStepType = AutomationStep['type'];
|
|
386
|
-
interface AutomationResponseStep {
|
|
384
|
+
export type AutomationStepType = AutomationStep['type'];
|
|
385
|
+
export interface AutomationResponseStep {
|
|
387
386
|
key: string;
|
|
388
387
|
type: AutomationStepType;
|
|
389
388
|
config: Record<string, unknown>;
|
|
390
389
|
}
|
|
391
|
-
interface AutomationResponseConnection {
|
|
390
|
+
export interface AutomationResponseConnection {
|
|
392
391
|
from: string;
|
|
393
392
|
to: string;
|
|
394
393
|
type: AutomationConnectionType;
|
|
395
394
|
}
|
|
396
395
|
//#endregion
|
|
397
396
|
//#region src/automation-runs/interfaces/automation-run.d.ts
|
|
398
|
-
type AutomationRunStatus = 'running' | 'completed' | 'failed' | 'cancelled';
|
|
399
|
-
type AutomationRunStepStatus = 'pending' | 'running' | 'completed' | 'failed' | 'skipped' | 'waiting';
|
|
400
|
-
interface AutomationRunStep {
|
|
397
|
+
export type AutomationRunStatus = 'running' | 'completed' | 'failed' | 'cancelled';
|
|
398
|
+
export type AutomationRunStepStatus = 'pending' | 'running' | 'completed' | 'failed' | 'skipped' | 'waiting';
|
|
399
|
+
export interface AutomationRunStep {
|
|
401
400
|
key: string;
|
|
402
401
|
type: AutomationStepType;
|
|
403
402
|
status: AutomationRunStepStatus;
|
|
@@ -407,7 +406,7 @@ interface AutomationRunStep {
|
|
|
407
406
|
completed_at: string | null;
|
|
408
407
|
created_at: string;
|
|
409
408
|
}
|
|
410
|
-
interface AutomationRun {
|
|
409
|
+
export interface AutomationRun {
|
|
411
410
|
object: 'automation_run';
|
|
412
411
|
id: string;
|
|
413
412
|
status: AutomationRunStatus;
|
|
@@ -416,94 +415,94 @@ interface AutomationRun {
|
|
|
416
415
|
created_at: string;
|
|
417
416
|
steps: AutomationRunStep[];
|
|
418
417
|
}
|
|
419
|
-
type AutomationRunItem = Pick<AutomationRun, 'id' | 'status' | 'started_at' | 'completed_at' | 'created_at'>;
|
|
418
|
+
export type AutomationRunItem = Pick<AutomationRun, 'id' | 'status' | 'started_at' | 'completed_at' | 'created_at'>;
|
|
420
419
|
//#endregion
|
|
421
420
|
//#region src/automation-runs/interfaces/get-automation-run.interface.d.ts
|
|
422
|
-
interface GetAutomationRunOptions {
|
|
421
|
+
export interface GetAutomationRunOptions {
|
|
423
422
|
automationId: string;
|
|
424
423
|
runId: string;
|
|
425
424
|
}
|
|
426
|
-
type GetAutomationRunResponseSuccess = AutomationRun;
|
|
427
|
-
type GetAutomationRunResponse = Response<GetAutomationRunResponseSuccess>;
|
|
425
|
+
export type GetAutomationRunResponseSuccess = AutomationRun;
|
|
426
|
+
export type GetAutomationRunResponse = Response<GetAutomationRunResponseSuccess>;
|
|
428
427
|
//#endregion
|
|
429
428
|
//#region src/automation-runs/interfaces/list-automation-runs.interface.d.ts
|
|
430
|
-
type ListAutomationRunsOptions = PaginationOptions & {
|
|
429
|
+
export type ListAutomationRunsOptions = PaginationOptions & {
|
|
431
430
|
automationId: string;
|
|
432
431
|
status?: AutomationRunStatus | AutomationRunStatus[];
|
|
433
432
|
};
|
|
434
|
-
type ListAutomationRunsResponseSuccess = PaginatedData<AutomationRunItem[]>;
|
|
435
|
-
type ListAutomationRunsResponse = Response<ListAutomationRunsResponseSuccess>;
|
|
433
|
+
export type ListAutomationRunsResponseSuccess = PaginatedData<AutomationRunItem[]>;
|
|
434
|
+
export type ListAutomationRunsResponse = Response<ListAutomationRunsResponseSuccess>;
|
|
436
435
|
//#endregion
|
|
437
436
|
//#region src/automations/interfaces/automation.d.ts
|
|
438
|
-
interface Automation {
|
|
437
|
+
export interface Automation {
|
|
439
438
|
id: string;
|
|
440
439
|
name: string;
|
|
441
440
|
status: 'enabled' | 'disabled';
|
|
442
441
|
created_at: string;
|
|
443
442
|
updated_at: string | null;
|
|
444
443
|
}
|
|
445
|
-
type AutomationStatus = Automation['status'];
|
|
444
|
+
export type AutomationStatus = Automation['status'];
|
|
446
445
|
//#endregion
|
|
447
446
|
//#region src/automations/interfaces/create-automation-options.interface.d.ts
|
|
448
|
-
interface CreateAutomationOptions {
|
|
447
|
+
export interface CreateAutomationOptions {
|
|
449
448
|
name: string;
|
|
450
449
|
status?: AutomationStatus;
|
|
451
450
|
steps: AutomationStep[];
|
|
452
451
|
connections: AutomationConnection[];
|
|
453
452
|
}
|
|
454
|
-
interface CreateAutomationResponseSuccess {
|
|
453
|
+
export interface CreateAutomationResponseSuccess {
|
|
455
454
|
object: 'automation';
|
|
456
455
|
id: string;
|
|
457
456
|
}
|
|
458
|
-
type CreateAutomationResponse = Response<CreateAutomationResponseSuccess>;
|
|
457
|
+
export type CreateAutomationResponse = Response<CreateAutomationResponseSuccess>;
|
|
459
458
|
//#endregion
|
|
460
459
|
//#region src/automations/interfaces/duplicate-automation.interface.d.ts
|
|
461
|
-
interface DuplicateAutomationResponseSuccess extends Pick<Automation, 'id'> {
|
|
460
|
+
export interface DuplicateAutomationResponseSuccess extends Pick<Automation, 'id'> {
|
|
462
461
|
object: 'automation';
|
|
463
462
|
}
|
|
464
|
-
type DuplicateAutomationResponse = Response<DuplicateAutomationResponseSuccess>;
|
|
463
|
+
export type DuplicateAutomationResponse = Response<DuplicateAutomationResponseSuccess>;
|
|
465
464
|
//#endregion
|
|
466
465
|
//#region src/automations/interfaces/get-automation.interface.d.ts
|
|
467
|
-
interface GetAutomationResponseSuccess extends Automation {
|
|
466
|
+
export interface GetAutomationResponseSuccess extends Automation {
|
|
468
467
|
object: 'automation';
|
|
469
468
|
steps: AutomationResponseStep[];
|
|
470
469
|
connections: AutomationResponseConnection[];
|
|
471
470
|
}
|
|
472
|
-
type GetAutomationResponse = Response<GetAutomationResponseSuccess>;
|
|
471
|
+
export type GetAutomationResponse = Response<GetAutomationResponseSuccess>;
|
|
473
472
|
//#endregion
|
|
474
473
|
//#region src/automations/interfaces/list-automation.interface.d.ts
|
|
475
|
-
type ListAutomationsOptions = PaginationOptions & {
|
|
474
|
+
export type ListAutomationsOptions = PaginationOptions & {
|
|
476
475
|
status?: AutomationStatus;
|
|
477
476
|
};
|
|
478
|
-
type ListAutomationsResponseSuccess = PaginatedData<Automation[]>;
|
|
479
|
-
type ListAutomationsResponse = Response<ListAutomationsResponseSuccess>;
|
|
477
|
+
export type ListAutomationsResponseSuccess = PaginatedData<Automation[]>;
|
|
478
|
+
export type ListAutomationsResponse = Response<ListAutomationsResponseSuccess>;
|
|
480
479
|
//#endregion
|
|
481
480
|
//#region src/automations/interfaces/remove-automation.interface.d.ts
|
|
482
|
-
interface RemoveAutomationResponseSuccess extends Pick<Automation, 'id'> {
|
|
481
|
+
export interface RemoveAutomationResponseSuccess extends Pick<Automation, 'id'> {
|
|
483
482
|
object: 'automation';
|
|
484
483
|
deleted: boolean;
|
|
485
484
|
}
|
|
486
|
-
type RemoveAutomationResponse = Response<RemoveAutomationResponseSuccess>;
|
|
485
|
+
export type RemoveAutomationResponse = Response<RemoveAutomationResponseSuccess>;
|
|
487
486
|
//#endregion
|
|
488
487
|
//#region src/automations/interfaces/stop-automation.interface.d.ts
|
|
489
|
-
interface StopAutomationResponseSuccess {
|
|
488
|
+
export interface StopAutomationResponseSuccess {
|
|
490
489
|
object: 'automation';
|
|
491
490
|
id: string;
|
|
492
491
|
status: 'disabled';
|
|
493
492
|
}
|
|
494
|
-
type StopAutomationResponse = Response<StopAutomationResponseSuccess>;
|
|
493
|
+
export type StopAutomationResponse = Response<StopAutomationResponseSuccess>;
|
|
495
494
|
//#endregion
|
|
496
495
|
//#region src/automations/interfaces/update-automation.interface.d.ts
|
|
497
|
-
interface UpdateAutomationOptions {
|
|
496
|
+
export interface UpdateAutomationOptions {
|
|
498
497
|
name?: string;
|
|
499
498
|
status?: AutomationStatus;
|
|
500
499
|
steps?: AutomationStep[];
|
|
501
500
|
connections?: AutomationConnection[];
|
|
502
501
|
}
|
|
503
|
-
interface UpdateAutomationResponseSuccess extends Pick<Automation, 'id'> {
|
|
502
|
+
export interface UpdateAutomationResponseSuccess extends Pick<Automation, 'id'> {
|
|
504
503
|
object: 'automation';
|
|
505
504
|
}
|
|
506
|
-
type UpdateAutomationResponse = Response<UpdateAutomationResponseSuccess>;
|
|
505
|
+
export type UpdateAutomationResponse = Response<UpdateAutomationResponseSuccess>;
|
|
507
506
|
//#endregion
|
|
508
507
|
//#region src/emails/interfaces/create-email-options.interface.d.ts
|
|
509
508
|
interface EmailRenderOptions$1 {
|
|
@@ -605,20 +604,20 @@ interface CreateEmailBaseOptions {
|
|
|
605
604
|
*/
|
|
606
605
|
scheduledAt?: string;
|
|
607
606
|
}
|
|
608
|
-
type CreateEmailOptions = ((RequireAtLeastOne<EmailRenderOptions$1> & CreateEmailBaseOptions) & {
|
|
607
|
+
export type CreateEmailOptions = ((RequireAtLeastOne<EmailRenderOptions$1> & CreateEmailBaseOptions) & {
|
|
609
608
|
template?: never;
|
|
610
609
|
}) | ((EmailTemplateOptions & CreateEmailBaseOptionsWithTemplate) & {
|
|
611
610
|
react?: never;
|
|
612
611
|
html?: never;
|
|
613
612
|
text?: never;
|
|
614
613
|
});
|
|
615
|
-
interface CreateEmailRequestOptions extends PostOptions, IdempotentRequest {}
|
|
616
|
-
interface CreateEmailResponseSuccess {
|
|
614
|
+
export interface CreateEmailRequestOptions extends PostOptions, IdempotentRequest {}
|
|
615
|
+
export interface CreateEmailResponseSuccess {
|
|
617
616
|
/** The ID of the newly created email. */
|
|
618
617
|
id: string;
|
|
619
618
|
}
|
|
620
|
-
type CreateEmailResponse = Response<CreateEmailResponseSuccess>;
|
|
621
|
-
interface Attachment {
|
|
619
|
+
export type CreateEmailResponse = Response<CreateEmailResponseSuccess>;
|
|
620
|
+
export interface Attachment {
|
|
622
621
|
/** Content of an attached file. */
|
|
623
622
|
content?: string | Buffer;
|
|
624
623
|
/** Name of attached file. */
|
|
@@ -633,7 +632,7 @@ interface Attachment {
|
|
|
633
632
|
*/
|
|
634
633
|
contentId?: string;
|
|
635
634
|
}
|
|
636
|
-
type Tag = {
|
|
635
|
+
export type Tag = {
|
|
637
636
|
/**
|
|
638
637
|
* The name of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
|
|
639
638
|
*/
|
|
@@ -657,17 +656,18 @@ type DistributiveOmit<T, K extends PropertyKey> = T extends unknown ? Omit<T, K>
|
|
|
657
656
|
*
|
|
658
657
|
* @link https://resend.com/docs/dashboard/emails/batch-sending#limitations
|
|
659
658
|
*/
|
|
660
|
-
type CreateBatchEmailOptions = DistributiveOmit<CreateEmailOptions, 'attachments'>;
|
|
661
|
-
type CreateBatchOptions = CreateBatchEmailOptions[];
|
|
662
|
-
interface CreateBatchRequestOptions extends PostOptions, IdempotentRequest {
|
|
659
|
+
export type CreateBatchEmailOptions = DistributiveOmit<CreateEmailOptions, 'attachments'>;
|
|
660
|
+
export type CreateBatchOptions = CreateBatchEmailOptions[];
|
|
661
|
+
export interface CreateBatchRequestOptions extends PostOptions, IdempotentRequest {
|
|
663
662
|
/**
|
|
664
663
|
* @default 'strict'
|
|
665
664
|
*/
|
|
666
665
|
batchValidation?: 'strict' | 'permissive';
|
|
667
666
|
}
|
|
668
|
-
type CreateBatchSuccessResponse<Options extends CreateBatchRequestOptions = CreateBatchRequestOptions> = {
|
|
667
|
+
export type CreateBatchSuccessResponse<Options extends CreateBatchRequestOptions = CreateBatchRequestOptions> = {
|
|
669
668
|
data: {
|
|
670
|
-
/** The ID of the newly created email. */
|
|
669
|
+
/** The ID of the newly created email. */
|
|
670
|
+
id: string;
|
|
671
671
|
}[];
|
|
672
672
|
} & (Options['batchValidation'] extends 'permissive' ? {
|
|
673
673
|
/**
|
|
@@ -684,10 +684,10 @@ type CreateBatchSuccessResponse<Options extends CreateBatchRequestOptions = Crea
|
|
|
684
684
|
message: string;
|
|
685
685
|
}[];
|
|
686
686
|
} : Record<string, never>);
|
|
687
|
-
type CreateBatchResponse<Options extends CreateBatchRequestOptions> = Response<CreateBatchSuccessResponse<Options>>;
|
|
687
|
+
export type CreateBatchResponse<Options extends CreateBatchRequestOptions> = Response<CreateBatchSuccessResponse<Options>>;
|
|
688
688
|
//#endregion
|
|
689
689
|
//#region src/broadcasts/interfaces/broadcast.d.ts
|
|
690
|
-
interface Broadcast {
|
|
690
|
+
export interface Broadcast {
|
|
691
691
|
id: string;
|
|
692
692
|
name: string;
|
|
693
693
|
segment_id: string | null;
|
|
@@ -706,10 +706,10 @@ interface Broadcast {
|
|
|
706
706
|
}
|
|
707
707
|
//#endregion
|
|
708
708
|
//#region src/broadcasts/interfaces/cancel-broadcast.interface.d.ts
|
|
709
|
-
interface CancelBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
|
|
709
|
+
export interface CancelBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
|
|
710
710
|
object: 'broadcast';
|
|
711
711
|
}
|
|
712
|
-
type CancelBroadcastResponse = Response<CancelBroadcastResponseSuccess>;
|
|
712
|
+
export type CancelBroadcastResponse = Response<CancelBroadcastResponseSuccess>;
|
|
713
713
|
//#endregion
|
|
714
714
|
//#region src/broadcasts/interfaces/create-broadcast-options.interface.d.ts
|
|
715
715
|
interface EmailRenderOptions {
|
|
@@ -815,29 +815,29 @@ interface CreateBroadcastBaseOptions {
|
|
|
815
815
|
*/
|
|
816
816
|
topicId?: string | null;
|
|
817
817
|
}
|
|
818
|
-
type CreateBroadcastOptions = RequireAtLeastOne<EmailRenderOptions> & RequireAtLeastOne<SegmentOptions> & CreateBroadcastBaseOptions & SendBroadcastOnCreationOptions;
|
|
819
|
-
interface CreateBroadcastRequestOptions extends PostOptions {}
|
|
820
|
-
interface CreateBroadcastResponseSuccess {
|
|
818
|
+
export type CreateBroadcastOptions = RequireAtLeastOne<EmailRenderOptions> & RequireAtLeastOne<SegmentOptions> & CreateBroadcastBaseOptions & SendBroadcastOnCreationOptions;
|
|
819
|
+
export interface CreateBroadcastRequestOptions extends PostOptions {}
|
|
820
|
+
export interface CreateBroadcastResponseSuccess {
|
|
821
821
|
/** The ID of the newly sent broadcasts. */
|
|
822
822
|
id: string;
|
|
823
823
|
}
|
|
824
|
-
type CreateBroadcastResponse = Response<CreateBroadcastResponseSuccess>;
|
|
824
|
+
export type CreateBroadcastResponse = Response<CreateBroadcastResponseSuccess>;
|
|
825
825
|
//#endregion
|
|
826
826
|
//#region src/broadcasts/interfaces/duplicate-broadcast.interface.d.ts
|
|
827
|
-
interface DuplicateBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
|
|
827
|
+
export interface DuplicateBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
|
|
828
828
|
object: 'broadcast';
|
|
829
829
|
}
|
|
830
|
-
type DuplicateBroadcastResponse = Response<DuplicateBroadcastResponseSuccess>;
|
|
830
|
+
export type DuplicateBroadcastResponse = Response<DuplicateBroadcastResponseSuccess>;
|
|
831
831
|
//#endregion
|
|
832
832
|
//#region src/broadcasts/interfaces/get-broadcast.interface.d.ts
|
|
833
|
-
interface GetBroadcastResponseSuccess extends Broadcast {
|
|
833
|
+
export interface GetBroadcastResponseSuccess extends Broadcast {
|
|
834
834
|
object: 'broadcast';
|
|
835
835
|
}
|
|
836
|
-
type GetBroadcastResponse = Response<GetBroadcastResponseSuccess>;
|
|
836
|
+
export type GetBroadcastResponse = Response<GetBroadcastResponseSuccess>;
|
|
837
837
|
//#endregion
|
|
838
838
|
//#region src/broadcasts/interfaces/list-broadcast-clicked-links.interface.d.ts
|
|
839
|
-
type ListBroadcastClickedLinksOptions = PaginationOptions;
|
|
840
|
-
type BroadcastClickedLink = {
|
|
839
|
+
export type ListBroadcastClickedLinksOptions = PaginationOptions;
|
|
840
|
+
export type BroadcastClickedLink = {
|
|
841
841
|
/**
|
|
842
842
|
* `id` is an opaque cursor for this row, used only for pagination.
|
|
843
843
|
* It does not identify any entity in Resend.
|
|
@@ -847,18 +847,18 @@ type BroadcastClickedLink = {
|
|
|
847
847
|
clicks: number;
|
|
848
848
|
unique_clicks: number;
|
|
849
849
|
};
|
|
850
|
-
type ListBroadcastClickedLinksResponseSuccess = PaginatedData<BroadcastClickedLink[]>;
|
|
851
|
-
type ListBroadcastClickedLinksResponse = Response<ListBroadcastClickedLinksResponseSuccess>;
|
|
850
|
+
export type ListBroadcastClickedLinksResponseSuccess = PaginatedData<BroadcastClickedLink[]>;
|
|
851
|
+
export type ListBroadcastClickedLinksResponse = Response<ListBroadcastClickedLinksResponseSuccess>;
|
|
852
852
|
//#endregion
|
|
853
853
|
//#region src/broadcasts/interfaces/list-broadcast-recipients.interface.d.ts
|
|
854
|
-
type BroadcastRecipientEventType = 'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'unsubscribed' | 'suppressed';
|
|
855
|
-
type BroadcastRecipientBounceType = 'permanent' | 'transient' | 'undetermined';
|
|
856
|
-
type ListBroadcastRecipientsOptions<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = PaginationOptions & {
|
|
854
|
+
export type BroadcastRecipientEventType = 'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'unsubscribed' | 'suppressed';
|
|
855
|
+
export type BroadcastRecipientBounceType = 'permanent' | 'transient' | 'undetermined';
|
|
856
|
+
export type ListBroadcastRecipientsOptions<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = PaginationOptions & {
|
|
857
857
|
type: T;
|
|
858
858
|
email?: string;
|
|
859
859
|
bounceType?: T extends 'bounced' ? BroadcastRecipientBounceType : never;
|
|
860
860
|
};
|
|
861
|
-
interface BroadcastRecipientClickedLink {
|
|
861
|
+
export interface BroadcastRecipientClickedLink {
|
|
862
862
|
url: string;
|
|
863
863
|
clicks: number;
|
|
864
864
|
}
|
|
@@ -890,25 +890,25 @@ type BroadcastRecipientFieldsByType = {
|
|
|
890
890
|
unsubscribed: unknown;
|
|
891
891
|
suppressed: unknown;
|
|
892
892
|
};
|
|
893
|
-
type BroadcastRecipient<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = IsUnion<T> extends true ? BroadcastRecipientLoose : BroadcastRecipientBase & BroadcastRecipientFieldsByType[T];
|
|
894
|
-
type ListBroadcastRecipientsResponseSuccess<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = PaginatedData<BroadcastRecipient<T>[]>;
|
|
895
|
-
type ListBroadcastRecipientsResponse<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = Response<ListBroadcastRecipientsResponseSuccess<T>>;
|
|
893
|
+
export type BroadcastRecipient<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = IsUnion<T> extends true ? BroadcastRecipientLoose : BroadcastRecipientBase & BroadcastRecipientFieldsByType[T];
|
|
894
|
+
export type ListBroadcastRecipientsResponseSuccess<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = PaginatedData<BroadcastRecipient<T>[]>;
|
|
895
|
+
export type ListBroadcastRecipientsResponse<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = Response<ListBroadcastRecipientsResponseSuccess<T>>;
|
|
896
896
|
//#endregion
|
|
897
897
|
//#region src/broadcasts/interfaces/list-broadcasts.interface.d.ts
|
|
898
|
-
type ListBroadcastsOptions = PaginationOptions;
|
|
899
|
-
type ListBroadcastsResponseSuccess = {
|
|
898
|
+
export type ListBroadcastsOptions = PaginationOptions;
|
|
899
|
+
export type ListBroadcastsResponseSuccess = {
|
|
900
900
|
object: 'list';
|
|
901
901
|
has_more: boolean;
|
|
902
902
|
data: Pick<Broadcast, 'id' | 'name' | 'audience_id' | 'segment_id' | 'status' | 'created_at' | 'scheduled_at' | 'sent_at'>[];
|
|
903
903
|
};
|
|
904
|
-
type ListBroadcastsResponse = Response<ListBroadcastsResponseSuccess>;
|
|
904
|
+
export type ListBroadcastsResponse = Response<ListBroadcastsResponseSuccess>;
|
|
905
905
|
//#endregion
|
|
906
906
|
//#region src/broadcasts/interfaces/remove-broadcast.interface.d.ts
|
|
907
|
-
interface RemoveBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
|
|
907
|
+
export interface RemoveBroadcastResponseSuccess extends Pick<Broadcast, 'id'> {
|
|
908
908
|
object: 'broadcast';
|
|
909
909
|
deleted: boolean;
|
|
910
910
|
}
|
|
911
|
-
type RemoveBroadcastResponse = Response<RemoveBroadcastResponseSuccess>;
|
|
911
|
+
export type RemoveBroadcastResponse = Response<RemoveBroadcastResponseSuccess>;
|
|
912
912
|
//#endregion
|
|
913
913
|
//#region src/broadcasts/interfaces/send-broadcast-options.interface.d.ts
|
|
914
914
|
interface SendBroadcastBaseOptions {
|
|
@@ -921,19 +921,19 @@ interface SendBroadcastBaseOptions {
|
|
|
921
921
|
*/
|
|
922
922
|
scheduledAt?: string;
|
|
923
923
|
}
|
|
924
|
-
type SendBroadcastOptions = SendBroadcastBaseOptions;
|
|
925
|
-
interface SendBroadcastRequestOptions extends PostOptions {}
|
|
926
|
-
interface SendBroadcastResponseSuccess {
|
|
924
|
+
export type SendBroadcastOptions = SendBroadcastBaseOptions;
|
|
925
|
+
export interface SendBroadcastRequestOptions extends PostOptions {}
|
|
926
|
+
export interface SendBroadcastResponseSuccess {
|
|
927
927
|
/** The ID of the sent broadcast. */
|
|
928
928
|
id: string;
|
|
929
929
|
}
|
|
930
|
-
type SendBroadcastResponse = Response<SendBroadcastResponseSuccess>;
|
|
930
|
+
export type SendBroadcastResponse = Response<SendBroadcastResponseSuccess>;
|
|
931
931
|
//#endregion
|
|
932
932
|
//#region src/broadcasts/interfaces/update-broadcast.interface.d.ts
|
|
933
|
-
interface UpdateBroadcastResponseSuccess {
|
|
933
|
+
export interface UpdateBroadcastResponseSuccess {
|
|
934
934
|
id: string;
|
|
935
935
|
}
|
|
936
|
-
type UpdateBroadcastOptions = {
|
|
936
|
+
export type UpdateBroadcastOptions = {
|
|
937
937
|
name?: string;
|
|
938
938
|
segmentId?: string;
|
|
939
939
|
/**
|
|
@@ -949,7 +949,7 @@ type UpdateBroadcastOptions = {
|
|
|
949
949
|
previewText?: string;
|
|
950
950
|
topicId?: string | null;
|
|
951
951
|
};
|
|
952
|
-
type UpdateBroadcastResponse = Response<UpdateBroadcastResponseSuccess>;
|
|
952
|
+
export type UpdateBroadcastResponse = Response<UpdateBroadcastResponseSuccess>;
|
|
953
953
|
//#endregion
|
|
954
954
|
//#region src/contact-properties/interfaces/contact-property.d.ts
|
|
955
955
|
type StringBaseApiContactProperty = {
|
|
@@ -960,7 +960,7 @@ type NumberBaseApiContactProperty = {
|
|
|
960
960
|
type: 'number';
|
|
961
961
|
fallback_value: number | null;
|
|
962
962
|
};
|
|
963
|
-
type ApiContactProperty = {
|
|
963
|
+
export type ApiContactProperty = {
|
|
964
964
|
id: string;
|
|
965
965
|
created_at: string;
|
|
966
966
|
key: string;
|
|
@@ -973,7 +973,7 @@ type NumberBaseContactProperty = {
|
|
|
973
973
|
type: 'number';
|
|
974
974
|
fallbackValue: number | null;
|
|
975
975
|
};
|
|
976
|
-
type ContactProperty = {
|
|
976
|
+
export type ContactProperty = {
|
|
977
977
|
id: string;
|
|
978
978
|
createdAt: string;
|
|
979
979
|
key: string;
|
|
@@ -988,70 +988,70 @@ type NumberBaseContactPropertyOptions = {
|
|
|
988
988
|
type: 'number';
|
|
989
989
|
fallbackValue?: number | null;
|
|
990
990
|
};
|
|
991
|
-
type CreateContactPropertyOptions = {
|
|
991
|
+
export type CreateContactPropertyOptions = {
|
|
992
992
|
key: string;
|
|
993
993
|
} & (StringBaseContactPropertyOptions | NumberBaseContactPropertyOptions);
|
|
994
|
-
interface CreateContactPropertyApiOptions {
|
|
994
|
+
export interface CreateContactPropertyApiOptions {
|
|
995
995
|
key: string;
|
|
996
996
|
type: 'string' | 'number';
|
|
997
997
|
fallback_value?: string | number | null;
|
|
998
998
|
}
|
|
999
|
-
type CreateContactPropertyResponseSuccess = Pick<ContactProperty, 'id'> & {
|
|
999
|
+
export type CreateContactPropertyResponseSuccess = Pick<ContactProperty, 'id'> & {
|
|
1000
1000
|
object: 'contact_property';
|
|
1001
1001
|
};
|
|
1002
|
-
type CreateContactPropertyResponse = Response<CreateContactPropertyResponseSuccess>;
|
|
1002
|
+
export type CreateContactPropertyResponse = Response<CreateContactPropertyResponseSuccess>;
|
|
1003
1003
|
//#endregion
|
|
1004
1004
|
//#region src/contact-properties/interfaces/delete-contact-property-options.interface.d.ts
|
|
1005
|
-
type RemoveContactPropertyResponseSuccess = Pick<ContactProperty, 'id'> & {
|
|
1005
|
+
export type RemoveContactPropertyResponseSuccess = Pick<ContactProperty, 'id'> & {
|
|
1006
1006
|
object: 'contact_property';
|
|
1007
1007
|
deleted: boolean;
|
|
1008
1008
|
};
|
|
1009
|
-
type RemoveContactPropertyResponse = Response<RemoveContactPropertyResponseSuccess>;
|
|
1009
|
+
export type RemoveContactPropertyResponse = Response<RemoveContactPropertyResponseSuccess>;
|
|
1010
1010
|
//#endregion
|
|
1011
1011
|
//#region src/contact-properties/interfaces/get-contact-property.interface.d.ts
|
|
1012
|
-
type GetContactPropertyResponseSuccess = ApiContactProperty & {
|
|
1012
|
+
export type GetContactPropertyResponseSuccess = ApiContactProperty & {
|
|
1013
1013
|
object: 'contact_property';
|
|
1014
1014
|
};
|
|
1015
|
-
type GetContactPropertyResponse = Response<ContactProperty & {
|
|
1015
|
+
export type GetContactPropertyResponse = Response<ContactProperty & {
|
|
1016
1016
|
object: 'contact_property';
|
|
1017
1017
|
}>;
|
|
1018
1018
|
//#endregion
|
|
1019
1019
|
//#region src/contact-properties/interfaces/list-contact-properties-options.interface.d.ts
|
|
1020
|
-
type ListContactPropertiesOptions = PaginationOptions;
|
|
1021
|
-
type ListContactPropertiesResponseSuccess = {
|
|
1020
|
+
export type ListContactPropertiesOptions = PaginationOptions;
|
|
1021
|
+
export type ListContactPropertiesResponseSuccess = {
|
|
1022
1022
|
object: 'list';
|
|
1023
1023
|
has_more: boolean;
|
|
1024
1024
|
data: ApiContactProperty[];
|
|
1025
1025
|
};
|
|
1026
|
-
type ListContactPropertiesResponse = Response<{
|
|
1026
|
+
export type ListContactPropertiesResponse = Response<{
|
|
1027
1027
|
object: 'list';
|
|
1028
1028
|
has_more: boolean;
|
|
1029
1029
|
data: ContactProperty[];
|
|
1030
1030
|
}>;
|
|
1031
1031
|
//#endregion
|
|
1032
1032
|
//#region src/contact-properties/interfaces/update-contact-property-options.interface.d.ts
|
|
1033
|
-
type UpdateContactPropertyOptions = {
|
|
1033
|
+
export type UpdateContactPropertyOptions = {
|
|
1034
1034
|
id: string;
|
|
1035
1035
|
fallbackValue?: string | number | null;
|
|
1036
1036
|
};
|
|
1037
|
-
interface UpdateContactPropertyApiOptions {
|
|
1037
|
+
export interface UpdateContactPropertyApiOptions {
|
|
1038
1038
|
fallback_value?: string | number | null;
|
|
1039
1039
|
}
|
|
1040
|
-
type UpdateContactPropertyResponseSuccess = Pick<ContactProperty, 'id'> & {
|
|
1040
|
+
export type UpdateContactPropertyResponseSuccess = Pick<ContactProperty, 'id'> & {
|
|
1041
1041
|
object: 'contact_property';
|
|
1042
1042
|
};
|
|
1043
|
-
type UpdateContactPropertyResponse = Response<UpdateContactPropertyResponseSuccess>;
|
|
1043
|
+
export type UpdateContactPropertyResponse = Response<UpdateContactPropertyResponseSuccess>;
|
|
1044
1044
|
//#endregion
|
|
1045
1045
|
//#region src/contacts/imports/interfaces/contact-import.interface.d.ts
|
|
1046
|
-
type ContactImportStatus = 'queued' | 'in_progress' | 'completed' | 'failed';
|
|
1047
|
-
interface ContactImportCounts {
|
|
1046
|
+
export type ContactImportStatus = 'queued' | 'in_progress' | 'completed' | 'failed';
|
|
1047
|
+
export interface ContactImportCounts {
|
|
1048
1048
|
total: number;
|
|
1049
1049
|
created: number;
|
|
1050
1050
|
updated: number;
|
|
1051
1051
|
skipped: number;
|
|
1052
1052
|
failed: number;
|
|
1053
1053
|
}
|
|
1054
|
-
interface ContactImport {
|
|
1054
|
+
export interface ContactImport {
|
|
1055
1055
|
object: 'contact_import';
|
|
1056
1056
|
id: string;
|
|
1057
1057
|
status: ContactImportStatus;
|
|
@@ -1061,53 +1061,53 @@ interface ContactImport {
|
|
|
1061
1061
|
}
|
|
1062
1062
|
//#endregion
|
|
1063
1063
|
//#region src/contacts/imports/interfaces/create-contact-import.interface.d.ts
|
|
1064
|
-
type ContactImportOnConflict = 'upsert' | 'skip';
|
|
1065
|
-
type ContactImportPropertyType = 'string' | 'number' | 'boolean';
|
|
1066
|
-
interface ContactImportPropertyMapping {
|
|
1064
|
+
export type ContactImportOnConflict = 'upsert' | 'skip';
|
|
1065
|
+
export type ContactImportPropertyType = 'string' | 'number' | 'boolean';
|
|
1066
|
+
export interface ContactImportPropertyMapping {
|
|
1067
1067
|
column: string;
|
|
1068
1068
|
type?: ContactImportPropertyType;
|
|
1069
1069
|
}
|
|
1070
|
-
interface ContactImportColumnMap {
|
|
1070
|
+
export interface ContactImportColumnMap {
|
|
1071
1071
|
email?: string;
|
|
1072
1072
|
firstName?: string;
|
|
1073
1073
|
lastName?: string;
|
|
1074
1074
|
unsubscribed?: string;
|
|
1075
1075
|
properties?: Record<string, ContactImportPropertyMapping>;
|
|
1076
1076
|
}
|
|
1077
|
-
interface ContactImportSegment {
|
|
1077
|
+
export interface ContactImportSegment {
|
|
1078
1078
|
id: string;
|
|
1079
1079
|
}
|
|
1080
|
-
interface ContactImportTopic {
|
|
1080
|
+
export interface ContactImportTopic {
|
|
1081
1081
|
id: string;
|
|
1082
1082
|
subscription: 'opt_in' | 'opt_out';
|
|
1083
1083
|
}
|
|
1084
|
-
interface CreateContactImportOptions {
|
|
1084
|
+
export interface CreateContactImportOptions {
|
|
1085
1085
|
file: Blob;
|
|
1086
1086
|
columnMap?: ContactImportColumnMap;
|
|
1087
1087
|
onConflict?: ContactImportOnConflict;
|
|
1088
1088
|
segments?: ContactImportSegment[];
|
|
1089
1089
|
topics?: ContactImportTopic[];
|
|
1090
1090
|
}
|
|
1091
|
-
interface CreateContactImportRequestOptions extends PostOptions {}
|
|
1092
|
-
interface CreateContactImportResponseSuccess {
|
|
1091
|
+
export interface CreateContactImportRequestOptions extends PostOptions {}
|
|
1092
|
+
export interface CreateContactImportResponseSuccess {
|
|
1093
1093
|
object: 'contact_import';
|
|
1094
1094
|
id: string;
|
|
1095
1095
|
}
|
|
1096
|
-
type CreateContactImportResponse = Response<CreateContactImportResponseSuccess>;
|
|
1096
|
+
export type CreateContactImportResponse = Response<CreateContactImportResponseSuccess>;
|
|
1097
1097
|
//#endregion
|
|
1098
1098
|
//#region src/contacts/imports/interfaces/get-contact-import.interface.d.ts
|
|
1099
|
-
type GetContactImportResponseSuccess = ContactImport;
|
|
1100
|
-
type GetContactImportResponse = Response<GetContactImportResponseSuccess>;
|
|
1099
|
+
export type GetContactImportResponseSuccess = ContactImport;
|
|
1100
|
+
export type GetContactImportResponse = Response<GetContactImportResponseSuccess>;
|
|
1101
1101
|
//#endregion
|
|
1102
1102
|
//#region src/contacts/imports/interfaces/list-contact-imports.interface.d.ts
|
|
1103
|
-
type ListContactImportsOptions = PaginationOptions & {
|
|
1103
|
+
export type ListContactImportsOptions = PaginationOptions & {
|
|
1104
1104
|
status?: ContactImportStatus;
|
|
1105
1105
|
};
|
|
1106
|
-
type ListContactImportsResponseSuccess = PaginatedData<ContactImport[]>;
|
|
1107
|
-
type ListContactImportsResponse = Response<ListContactImportsResponseSuccess>;
|
|
1106
|
+
export type ListContactImportsResponseSuccess = PaginatedData<ContactImport[]>;
|
|
1107
|
+
export type ListContactImportsResponse = Response<ListContactImportsResponseSuccess>;
|
|
1108
1108
|
//#endregion
|
|
1109
1109
|
//#region src/contacts/interfaces/contact.d.ts
|
|
1110
|
-
interface Contact {
|
|
1110
|
+
export interface Contact {
|
|
1111
1111
|
created_at: string;
|
|
1112
1112
|
id: string;
|
|
1113
1113
|
email: string;
|
|
@@ -1115,7 +1115,7 @@ interface Contact {
|
|
|
1115
1115
|
last_name: string | null;
|
|
1116
1116
|
unsubscribed: boolean;
|
|
1117
1117
|
}
|
|
1118
|
-
type SelectingField = {
|
|
1118
|
+
export type SelectingField = {
|
|
1119
1119
|
/**
|
|
1120
1120
|
* The contact id.
|
|
1121
1121
|
*
|
|
@@ -1147,7 +1147,7 @@ type SelectingField = {
|
|
|
1147
1147
|
interface CreateContactPropertiesOptions {
|
|
1148
1148
|
[key: string]: string | number | null;
|
|
1149
1149
|
}
|
|
1150
|
-
interface LegacyCreateContactOptions {
|
|
1150
|
+
export interface LegacyCreateContactOptions {
|
|
1151
1151
|
/**
|
|
1152
1152
|
* @deprecated Use `segments` instead to add one or more segments to the new contact
|
|
1153
1153
|
*
|
|
@@ -1160,7 +1160,7 @@ interface LegacyCreateContactOptions {
|
|
|
1160
1160
|
lastName?: string;
|
|
1161
1161
|
properties?: CreateContactPropertiesOptions;
|
|
1162
1162
|
}
|
|
1163
|
-
interface CreateContactOptions {
|
|
1163
|
+
export interface CreateContactOptions {
|
|
1164
1164
|
email: string;
|
|
1165
1165
|
unsubscribed?: boolean;
|
|
1166
1166
|
firstName?: string;
|
|
@@ -1174,14 +1174,14 @@ interface CreateContactOptions {
|
|
|
1174
1174
|
subscription: 'opt_in' | 'opt_out';
|
|
1175
1175
|
}[];
|
|
1176
1176
|
}
|
|
1177
|
-
interface CreateContactRequestOptions extends PostOptions {}
|
|
1178
|
-
interface CreateContactResponseSuccess extends Pick<Contact, 'id'> {
|
|
1177
|
+
export interface CreateContactRequestOptions extends PostOptions {}
|
|
1178
|
+
export interface CreateContactResponseSuccess extends Pick<Contact, 'id'> {
|
|
1179
1179
|
object: 'contact';
|
|
1180
1180
|
}
|
|
1181
|
-
type CreateContactResponse = Response<CreateContactResponseSuccess>;
|
|
1181
|
+
export type CreateContactResponse = Response<CreateContactResponseSuccess>;
|
|
1182
1182
|
//#endregion
|
|
1183
1183
|
//#region src/contacts/interfaces/get-contact.interface.d.ts
|
|
1184
|
-
type GetContactOptions = string | ({
|
|
1184
|
+
export type GetContactOptions = string | ({
|
|
1185
1185
|
audienceId?: string;
|
|
1186
1186
|
} & SelectingField);
|
|
1187
1187
|
type ContactPropertyValue = {
|
|
@@ -1194,43 +1194,43 @@ type ContactPropertyValue = {
|
|
|
1194
1194
|
interface ContactProperties$1 {
|
|
1195
1195
|
[key: string]: ContactPropertyValue;
|
|
1196
1196
|
}
|
|
1197
|
-
interface GetContactResponseSuccess extends Pick<Contact, 'id' | 'email' | 'created_at' | 'first_name' | 'last_name' | 'unsubscribed'> {
|
|
1197
|
+
export interface GetContactResponseSuccess extends Pick<Contact, 'id' | 'email' | 'created_at' | 'first_name' | 'last_name' | 'unsubscribed'> {
|
|
1198
1198
|
object: 'contact';
|
|
1199
1199
|
properties: ContactProperties$1;
|
|
1200
1200
|
}
|
|
1201
|
-
type GetContactResponse = Response<GetContactResponseSuccess>;
|
|
1201
|
+
export type GetContactResponse = Response<GetContactResponseSuccess>;
|
|
1202
1202
|
//#endregion
|
|
1203
1203
|
//#region src/contacts/interfaces/list-contacts.interface.d.ts
|
|
1204
|
-
type ListContactsOptions = PaginationOptions & {
|
|
1204
|
+
export type ListContactsOptions = PaginationOptions & {
|
|
1205
1205
|
segmentId?: string;
|
|
1206
1206
|
/**
|
|
1207
1207
|
* @deprecated Use segmentId instead to filter by segment
|
|
1208
1208
|
*/
|
|
1209
1209
|
audienceId?: string;
|
|
1210
1210
|
};
|
|
1211
|
-
interface ListContactsResponseSuccess {
|
|
1211
|
+
export interface ListContactsResponseSuccess {
|
|
1212
1212
|
object: 'list';
|
|
1213
1213
|
data: Contact[];
|
|
1214
1214
|
has_more: boolean;
|
|
1215
1215
|
}
|
|
1216
|
-
type ListContactsResponse = Response<ListContactsResponseSuccess>;
|
|
1216
|
+
export type ListContactsResponse = Response<ListContactsResponseSuccess>;
|
|
1217
1217
|
//#endregion
|
|
1218
1218
|
//#region src/contacts/interfaces/remove-contact.interface.d.ts
|
|
1219
|
-
type RemoveContactsResponseSuccess = {
|
|
1219
|
+
export type RemoveContactsResponseSuccess = {
|
|
1220
1220
|
object: 'contact';
|
|
1221
1221
|
deleted: boolean;
|
|
1222
1222
|
contact: string;
|
|
1223
1223
|
};
|
|
1224
|
-
type RemoveContactOptions = string | (SelectingField & {
|
|
1224
|
+
export type RemoveContactOptions = string | (SelectingField & {
|
|
1225
1225
|
audienceId?: string;
|
|
1226
1226
|
});
|
|
1227
|
-
type RemoveContactsResponse = Response<RemoveContactsResponseSuccess>;
|
|
1227
|
+
export type RemoveContactsResponse = Response<RemoveContactsResponseSuccess>;
|
|
1228
1228
|
//#endregion
|
|
1229
1229
|
//#region src/contacts/interfaces/update-contact.interface.d.ts
|
|
1230
1230
|
interface UpdateContactPropertiesOptions {
|
|
1231
1231
|
[key: string]: string | number | null;
|
|
1232
1232
|
}
|
|
1233
|
-
type UpdateContactOptions = {
|
|
1233
|
+
export type UpdateContactOptions = {
|
|
1234
1234
|
audienceId?: string;
|
|
1235
1235
|
unsubscribed?: boolean;
|
|
1236
1236
|
/**
|
|
@@ -1243,13 +1243,13 @@ type UpdateContactOptions = {
|
|
|
1243
1243
|
lastName?: string | null;
|
|
1244
1244
|
properties?: UpdateContactPropertiesOptions;
|
|
1245
1245
|
} & SelectingField;
|
|
1246
|
-
type UpdateContactResponseSuccess = Pick<Contact, 'id'> & {
|
|
1246
|
+
export type UpdateContactResponseSuccess = Pick<Contact, 'id'> & {
|
|
1247
1247
|
object: 'contact';
|
|
1248
1248
|
};
|
|
1249
|
-
type UpdateContactResponse = Response<UpdateContactResponseSuccess>;
|
|
1249
|
+
export type UpdateContactResponse = Response<UpdateContactResponseSuccess>;
|
|
1250
1250
|
//#endregion
|
|
1251
1251
|
//#region src/contacts/segments/interfaces/contact-segments.interface.d.ts
|
|
1252
|
-
type ContactSegmentsBaseOptions = {
|
|
1252
|
+
export type ContactSegmentsBaseOptions = {
|
|
1253
1253
|
contactId: string;
|
|
1254
1254
|
email?: never;
|
|
1255
1255
|
} | {
|
|
@@ -1258,80 +1258,80 @@ type ContactSegmentsBaseOptions = {
|
|
|
1258
1258
|
};
|
|
1259
1259
|
//#endregion
|
|
1260
1260
|
//#region src/contacts/segments/interfaces/add-contact-segment.interface.d.ts
|
|
1261
|
-
type AddContactSegmentOptions = ContactSegmentsBaseOptions & {
|
|
1261
|
+
export type AddContactSegmentOptions = ContactSegmentsBaseOptions & {
|
|
1262
1262
|
segmentId: string;
|
|
1263
1263
|
};
|
|
1264
|
-
interface AddContactSegmentResponseSuccess {
|
|
1264
|
+
export interface AddContactSegmentResponseSuccess {
|
|
1265
1265
|
id: string;
|
|
1266
1266
|
}
|
|
1267
|
-
type AddContactSegmentResponse = Response<AddContactSegmentResponseSuccess>;
|
|
1267
|
+
export type AddContactSegmentResponse = Response<AddContactSegmentResponseSuccess>;
|
|
1268
1268
|
//#endregion
|
|
1269
1269
|
//#region src/segments/interfaces/segment.d.ts
|
|
1270
|
-
interface Segment {
|
|
1270
|
+
export interface Segment {
|
|
1271
1271
|
created_at: string;
|
|
1272
1272
|
id: string;
|
|
1273
1273
|
name: string;
|
|
1274
1274
|
}
|
|
1275
1275
|
//#endregion
|
|
1276
1276
|
//#region src/contacts/segments/interfaces/list-contact-segments.interface.d.ts
|
|
1277
|
-
type ListContactSegmentsOptions = PaginationOptions & ContactSegmentsBaseOptions;
|
|
1278
|
-
type ListContactSegmentsResponseSuccess = PaginatedData<Segment[]>;
|
|
1279
|
-
type ListContactSegmentsResponse = Response<ListContactSegmentsResponseSuccess>;
|
|
1277
|
+
export type ListContactSegmentsOptions = PaginationOptions & ContactSegmentsBaseOptions;
|
|
1278
|
+
export type ListContactSegmentsResponseSuccess = PaginatedData<Segment[]>;
|
|
1279
|
+
export type ListContactSegmentsResponse = Response<ListContactSegmentsResponseSuccess>;
|
|
1280
1280
|
//#endregion
|
|
1281
1281
|
//#region src/contacts/segments/interfaces/remove-contact-segment.interface.d.ts
|
|
1282
|
-
type RemoveContactSegmentOptions = ContactSegmentsBaseOptions & {
|
|
1282
|
+
export type RemoveContactSegmentOptions = ContactSegmentsBaseOptions & {
|
|
1283
1283
|
segmentId: string;
|
|
1284
1284
|
};
|
|
1285
|
-
interface RemoveContactSegmentResponseSuccess {
|
|
1285
|
+
export interface RemoveContactSegmentResponseSuccess {
|
|
1286
1286
|
id: string;
|
|
1287
1287
|
audienceId: string;
|
|
1288
1288
|
deleted: boolean;
|
|
1289
1289
|
}
|
|
1290
|
-
type RemoveContactSegmentResponse = Response<RemoveContactSegmentResponseSuccess>;
|
|
1290
|
+
export type RemoveContactSegmentResponse = Response<RemoveContactSegmentResponseSuccess>;
|
|
1291
1291
|
//#endregion
|
|
1292
1292
|
//#region src/contacts/topics/interfaces/list-contact-topics.interface.d.ts
|
|
1293
1293
|
interface ListContactTopicsBaseOptions {
|
|
1294
1294
|
id?: string;
|
|
1295
1295
|
email?: string;
|
|
1296
1296
|
}
|
|
1297
|
-
type ListContactTopicsOptions = ListContactTopicsBaseOptions & PaginationOptions;
|
|
1298
|
-
interface ListContactTopicsRequestOptions extends GetOptions {}
|
|
1299
|
-
interface ContactTopic {
|
|
1297
|
+
export type ListContactTopicsOptions = ListContactTopicsBaseOptions & PaginationOptions;
|
|
1298
|
+
export interface ListContactTopicsRequestOptions extends GetOptions {}
|
|
1299
|
+
export interface ContactTopic {
|
|
1300
1300
|
id: string;
|
|
1301
1301
|
name: string;
|
|
1302
1302
|
description: string | null;
|
|
1303
1303
|
subscription: 'opt_in' | 'opt_out';
|
|
1304
1304
|
}
|
|
1305
|
-
type ListContactTopicsResponseSuccess = PaginatedData<ContactTopic[]>;
|
|
1306
|
-
type ListContactTopicsResponse = Response<ListContactTopicsResponseSuccess>;
|
|
1305
|
+
export type ListContactTopicsResponseSuccess = PaginatedData<ContactTopic[]>;
|
|
1306
|
+
export type ListContactTopicsResponse = Response<ListContactTopicsResponseSuccess>;
|
|
1307
1307
|
//#endregion
|
|
1308
1308
|
//#region src/contacts/topics/interfaces/update-contact-topics.interface.d.ts
|
|
1309
1309
|
interface UpdateContactTopicsBaseOptions {
|
|
1310
1310
|
id?: string;
|
|
1311
1311
|
email?: string;
|
|
1312
1312
|
}
|
|
1313
|
-
interface UpdateContactTopicsOptions extends UpdateContactTopicsBaseOptions {
|
|
1313
|
+
export interface UpdateContactTopicsOptions extends UpdateContactTopicsBaseOptions {
|
|
1314
1314
|
topics: {
|
|
1315
1315
|
id: string;
|
|
1316
1316
|
subscription: 'opt_in' | 'opt_out';
|
|
1317
1317
|
}[];
|
|
1318
1318
|
}
|
|
1319
|
-
interface UpdateContactTopicsRequestOptions extends PatchOptions {}
|
|
1320
|
-
interface UpdateContactTopicsResponseSuccess {
|
|
1319
|
+
export interface UpdateContactTopicsRequestOptions extends PatchOptions {}
|
|
1320
|
+
export interface UpdateContactTopicsResponseSuccess {
|
|
1321
1321
|
id: string;
|
|
1322
1322
|
}
|
|
1323
|
-
type UpdateContactTopicsResponse = Response<UpdateContactTopicsResponseSuccess>;
|
|
1323
|
+
export type UpdateContactTopicsResponse = Response<UpdateContactTopicsResponseSuccess>;
|
|
1324
1324
|
//#endregion
|
|
1325
1325
|
//#region src/domains/claims/interfaces/domain-claim.d.ts
|
|
1326
|
-
type DomainClaimStatus = 'pending' | 'verified' | 'completed' | 'blocked' | 'expired' | 'superseded' | 'canceled' | 'failed';
|
|
1327
|
-
type DomainClaimBlockedReason = 'grace_period' | 'recent_owner_activity' | 'pending_scheduled_emails';
|
|
1328
|
-
interface DomainClaimRecord {
|
|
1326
|
+
export type DomainClaimStatus = 'pending' | 'verified' | 'completed' | 'blocked' | 'expired' | 'superseded' | 'canceled' | 'failed';
|
|
1327
|
+
export type DomainClaimBlockedReason = 'grace_period' | 'recent_owner_activity' | 'pending_scheduled_emails';
|
|
1328
|
+
export interface DomainClaimRecord {
|
|
1329
1329
|
type: 'TXT';
|
|
1330
1330
|
name: string;
|
|
1331
1331
|
value: string;
|
|
1332
1332
|
ttl: 'Auto';
|
|
1333
1333
|
}
|
|
1334
|
-
interface DomainClaim {
|
|
1334
|
+
export interface DomainClaim {
|
|
1335
1335
|
id: string;
|
|
1336
1336
|
name: string;
|
|
1337
1337
|
status: DomainClaimStatus;
|
|
@@ -1345,7 +1345,7 @@ interface DomainClaim {
|
|
|
1345
1345
|
}
|
|
1346
1346
|
//#endregion
|
|
1347
1347
|
//#region src/domains/claims/interfaces/claim-domain-options.interface.d.ts
|
|
1348
|
-
interface ClaimDomainOptions {
|
|
1348
|
+
export interface ClaimDomainOptions {
|
|
1349
1349
|
name: string;
|
|
1350
1350
|
region?: DomainRegion;
|
|
1351
1351
|
customReturnPath?: string;
|
|
@@ -1353,26 +1353,26 @@ interface ClaimDomainOptions {
|
|
|
1353
1353
|
clickTracking?: boolean;
|
|
1354
1354
|
trackingSubdomain?: string;
|
|
1355
1355
|
}
|
|
1356
|
-
interface ClaimDomainRequestOptions extends PostOptions {}
|
|
1357
|
-
interface ClaimDomainResponseSuccess extends DomainClaim {
|
|
1356
|
+
export interface ClaimDomainRequestOptions extends PostOptions {}
|
|
1357
|
+
export interface ClaimDomainResponseSuccess extends DomainClaim {
|
|
1358
1358
|
object: 'domain_claim';
|
|
1359
1359
|
}
|
|
1360
|
-
type ClaimDomainResponse = Response<ClaimDomainResponseSuccess>;
|
|
1360
|
+
export type ClaimDomainResponse = Response<ClaimDomainResponseSuccess>;
|
|
1361
1361
|
//#endregion
|
|
1362
1362
|
//#region src/domains/claims/interfaces/get-domain-claim.interface.d.ts
|
|
1363
|
-
interface GetDomainClaimResponseSuccess extends DomainClaim {
|
|
1363
|
+
export interface GetDomainClaimResponseSuccess extends DomainClaim {
|
|
1364
1364
|
object: 'domain_claim';
|
|
1365
1365
|
}
|
|
1366
|
-
type GetDomainClaimResponse = Response<GetDomainClaimResponseSuccess>;
|
|
1366
|
+
export type GetDomainClaimResponse = Response<GetDomainClaimResponseSuccess>;
|
|
1367
1367
|
//#endregion
|
|
1368
1368
|
//#region src/domains/claims/interfaces/verify-domain-claim.interface.d.ts
|
|
1369
|
-
interface VerifyDomainClaimResponseSuccess extends DomainClaim {
|
|
1369
|
+
export interface VerifyDomainClaimResponseSuccess extends DomainClaim {
|
|
1370
1370
|
object: 'domain_claim';
|
|
1371
1371
|
}
|
|
1372
|
-
type VerifyDomainClaimResponse = Response<VerifyDomainClaimResponseSuccess>;
|
|
1372
|
+
export type VerifyDomainClaimResponse = Response<VerifyDomainClaimResponseSuccess>;
|
|
1373
1373
|
//#endregion
|
|
1374
1374
|
//#region src/domains/interfaces/create-domain-options.interface.d.ts
|
|
1375
|
-
interface CreateDomainOptions {
|
|
1375
|
+
export interface CreateDomainOptions {
|
|
1376
1376
|
name: string;
|
|
1377
1377
|
region?: DomainRegion;
|
|
1378
1378
|
customReturnPath?: string;
|
|
@@ -1382,38 +1382,38 @@ interface CreateDomainOptions {
|
|
|
1382
1382
|
tls?: 'enforced' | 'opportunistic';
|
|
1383
1383
|
trackingSubdomain?: string;
|
|
1384
1384
|
}
|
|
1385
|
-
interface CreateDomainRequestOptions extends PostOptions {}
|
|
1386
|
-
interface CreateDomainResponseSuccess extends Pick<Domain, 'name' | 'id' | 'status' | 'created_at' | 'region' | 'open_tracking' | 'click_tracking' | 'tracking_subdomain'> {
|
|
1385
|
+
export interface CreateDomainRequestOptions extends PostOptions {}
|
|
1386
|
+
export interface CreateDomainResponseSuccess extends Pick<Domain, 'name' | 'id' | 'status' | 'created_at' | 'region' | 'open_tracking' | 'click_tracking' | 'tracking_subdomain'> {
|
|
1387
1387
|
records: DomainRecords[];
|
|
1388
1388
|
capabilities: DomainCapabilities;
|
|
1389
1389
|
}
|
|
1390
|
-
type CreateDomainResponse = Response<CreateDomainResponseSuccess>;
|
|
1390
|
+
export type CreateDomainResponse = Response<CreateDomainResponseSuccess>;
|
|
1391
1391
|
//#endregion
|
|
1392
1392
|
//#region src/domains/interfaces/get-domain.interface.d.ts
|
|
1393
|
-
interface GetDomainResponseSuccess extends Pick<Domain, 'id' | 'name' | 'created_at' | 'region' | 'status' | 'capabilities' | 'open_tracking' | 'click_tracking' | 'tracking_subdomain'> {
|
|
1393
|
+
export interface GetDomainResponseSuccess extends Pick<Domain, 'id' | 'name' | 'created_at' | 'region' | 'status' | 'capabilities' | 'open_tracking' | 'click_tracking' | 'tracking_subdomain'> {
|
|
1394
1394
|
object: 'domain';
|
|
1395
1395
|
records: DomainRecords[];
|
|
1396
1396
|
}
|
|
1397
|
-
type GetDomainResponse = Response<GetDomainResponseSuccess>;
|
|
1397
|
+
export type GetDomainResponse = Response<GetDomainResponseSuccess>;
|
|
1398
1398
|
//#endregion
|
|
1399
1399
|
//#region src/domains/interfaces/list-domains.interface.d.ts
|
|
1400
|
-
type ListDomainsOptions = PaginationOptions;
|
|
1401
|
-
type ListDomainsResponseSuccess = {
|
|
1400
|
+
export type ListDomainsOptions = PaginationOptions;
|
|
1401
|
+
export type ListDomainsResponseSuccess = {
|
|
1402
1402
|
data: Domain[];
|
|
1403
1403
|
object: 'list';
|
|
1404
1404
|
has_more: boolean;
|
|
1405
1405
|
};
|
|
1406
|
-
type ListDomainsResponse = Response<ListDomainsResponseSuccess>;
|
|
1406
|
+
export type ListDomainsResponse = Response<ListDomainsResponseSuccess>;
|
|
1407
1407
|
//#endregion
|
|
1408
1408
|
//#region src/domains/interfaces/remove-domain.interface.d.ts
|
|
1409
|
-
type RemoveDomainsResponseSuccess = Pick<Domain, 'id'> & {
|
|
1409
|
+
export type RemoveDomainsResponseSuccess = Pick<Domain, 'id'> & {
|
|
1410
1410
|
object: 'domain';
|
|
1411
1411
|
deleted: boolean;
|
|
1412
1412
|
};
|
|
1413
|
-
type RemoveDomainsResponse = Response<RemoveDomainsResponseSuccess>;
|
|
1413
|
+
export type RemoveDomainsResponse = Response<RemoveDomainsResponseSuccess>;
|
|
1414
1414
|
//#endregion
|
|
1415
1415
|
//#region src/domains/interfaces/update-domain.interface.d.ts
|
|
1416
|
-
interface UpdateDomainsOptions {
|
|
1416
|
+
export interface UpdateDomainsOptions {
|
|
1417
1417
|
id: string;
|
|
1418
1418
|
clickTracking?: boolean;
|
|
1419
1419
|
openTracking?: boolean;
|
|
@@ -1421,16 +1421,16 @@ interface UpdateDomainsOptions {
|
|
|
1421
1421
|
capabilities?: Partial<DomainCapabilities>;
|
|
1422
1422
|
trackingSubdomain?: string;
|
|
1423
1423
|
}
|
|
1424
|
-
type UpdateDomainsResponseSuccess = Pick<Domain, 'id'> & {
|
|
1424
|
+
export type UpdateDomainsResponseSuccess = Pick<Domain, 'id'> & {
|
|
1425
1425
|
object: 'domain';
|
|
1426
1426
|
};
|
|
1427
|
-
type UpdateDomainsResponse = Response<UpdateDomainsResponseSuccess>;
|
|
1427
|
+
export type UpdateDomainsResponse = Response<UpdateDomainsResponseSuccess>;
|
|
1428
1428
|
//#endregion
|
|
1429
1429
|
//#region src/domains/interfaces/verify-domain.interface.d.ts
|
|
1430
|
-
type VerifyDomainsResponseSuccess = Pick<Domain, 'id'> & {
|
|
1430
|
+
export type VerifyDomainsResponseSuccess = Pick<Domain, 'id'> & {
|
|
1431
1431
|
object: 'domain';
|
|
1432
1432
|
};
|
|
1433
|
-
type VerifyDomainsResponse = Response<VerifyDomainsResponseSuccess>;
|
|
1433
|
+
export type VerifyDomainsResponse = Response<VerifyDomainsResponseSuccess>;
|
|
1434
1434
|
//#endregion
|
|
1435
1435
|
//#region src/emails/attachments/interfaces/get-attachment.interface.d.ts
|
|
1436
1436
|
interface GetAttachmentOptions {
|
|
@@ -1454,14 +1454,14 @@ interface ListAttachmentsResponseSuccess {
|
|
|
1454
1454
|
type ListAttachmentsResponse = Response<ListAttachmentsResponseSuccess>;
|
|
1455
1455
|
//#endregion
|
|
1456
1456
|
//#region src/emails/interfaces/cancel-email-options.interface.d.ts
|
|
1457
|
-
interface CancelEmailResponseSuccess {
|
|
1457
|
+
export interface CancelEmailResponseSuccess {
|
|
1458
1458
|
object: 'email';
|
|
1459
1459
|
id: string;
|
|
1460
1460
|
}
|
|
1461
|
-
type CancelEmailResponse = Response<CancelEmailResponseSuccess>;
|
|
1461
|
+
export type CancelEmailResponse = Response<CancelEmailResponseSuccess>;
|
|
1462
1462
|
//#endregion
|
|
1463
1463
|
//#region src/emails/interfaces/get-email-options.interface.d.ts
|
|
1464
|
-
interface GetEmailResponseSuccess {
|
|
1464
|
+
export interface GetEmailResponseSuccess {
|
|
1465
1465
|
bcc: string[] | null;
|
|
1466
1466
|
cc: string[] | null;
|
|
1467
1467
|
created_at: string;
|
|
@@ -1482,12 +1482,12 @@ interface GetEmailResponseSuccess {
|
|
|
1482
1482
|
scheduled_at: string | null;
|
|
1483
1483
|
object: 'email';
|
|
1484
1484
|
}
|
|
1485
|
-
type GetEmailResponse = Response<GetEmailResponseSuccess>;
|
|
1485
|
+
export type GetEmailResponse = Response<GetEmailResponseSuccess>;
|
|
1486
1486
|
//#endregion
|
|
1487
1487
|
//#region src/emails/interfaces/get-metrics.interface.d.ts
|
|
1488
|
-
type EmailMetric = 'received' | 'delivered' | 'complained' | 'suppressed' | 'bounced' | 'bounced_transient' | 'bounced_permanent' | 'bounced_undetermined' | 'opened' | 'clicked' | 'unsubscribed' | 'delivery_delayed' | 'failed' | 'sent' | 'unique_opened' | 'unique_clicked' | 'delivery_rate' | 'open_rate' | 'click_rate' | 'bounce_rate' | 'complaint_rate' | 'unsubscribe_rate';
|
|
1489
|
-
type EmailMetricsDimension = 'period' | 'domain' | 'email' | 'broadcast';
|
|
1490
|
-
type EmailMetricsGranularity = 'hourly' | 'daily' | 'weekly' | 'monthly';
|
|
1488
|
+
export type EmailMetric = 'received' | 'delivered' | 'complained' | 'suppressed' | 'bounced' | 'bounced_transient' | 'bounced_permanent' | 'bounced_undetermined' | 'opened' | 'clicked' | 'unsubscribed' | 'delivery_delayed' | 'failed' | 'sent' | 'unique_opened' | 'unique_clicked' | 'delivery_rate' | 'open_rate' | 'click_rate' | 'bounce_rate' | 'complaint_rate' | 'unsubscribe_rate';
|
|
1489
|
+
export type EmailMetricsDimension = 'period' | 'domain' | 'email' | 'broadcast';
|
|
1490
|
+
export type EmailMetricsGranularity = 'hourly' | 'daily' | 'weekly' | 'monthly';
|
|
1491
1491
|
type EmailMetricsCommonOptions = {
|
|
1492
1492
|
/**
|
|
1493
1493
|
* The start of the date range, as an ISO 8601 date or datetime.
|
|
@@ -1522,7 +1522,7 @@ type EmailMetricsCommonOptions = {
|
|
|
1522
1522
|
*/
|
|
1523
1523
|
domainId?: string[];
|
|
1524
1524
|
};
|
|
1525
|
-
type GetEmailsMetricsOptions = EmailMetricsCommonOptions & ({
|
|
1525
|
+
export type GetEmailsMetricsOptions = EmailMetricsCommonOptions & ({
|
|
1526
1526
|
/**
|
|
1527
1527
|
* The dimensions to break the response down by. Defaults to `[]`,
|
|
1528
1528
|
* which returns a single `totals` row for the whole range, with no
|
|
@@ -1549,8 +1549,8 @@ type GetEmailsMetricsOptions = EmailMetricsCommonOptions & ({
|
|
|
1549
1549
|
*/
|
|
1550
1550
|
broadcastId?: string[];
|
|
1551
1551
|
});
|
|
1552
|
-
type EmailMetricsTotals = Partial<Record<EmailMetric, number>>;
|
|
1553
|
-
type EmailMetricsDataRow = EmailMetricsTotals & {
|
|
1552
|
+
export type EmailMetricsTotals = Partial<Record<EmailMetric, number>>;
|
|
1553
|
+
export type EmailMetricsDataRow = EmailMetricsTotals & {
|
|
1554
1554
|
period?: string;
|
|
1555
1555
|
domain_id?: string;
|
|
1556
1556
|
domain_name?: string;
|
|
@@ -1558,7 +1558,7 @@ type EmailMetricsDataRow = EmailMetricsTotals & {
|
|
|
1558
1558
|
broadcast_id?: string;
|
|
1559
1559
|
broadcast_name?: string;
|
|
1560
1560
|
};
|
|
1561
|
-
interface GetEmailsMetricsResponseSuccess {
|
|
1561
|
+
export interface GetEmailsMetricsResponseSuccess {
|
|
1562
1562
|
object: 'metrics';
|
|
1563
1563
|
start_date: string;
|
|
1564
1564
|
end_date: string;
|
|
@@ -1568,39 +1568,39 @@ interface GetEmailsMetricsResponseSuccess {
|
|
|
1568
1568
|
totals: EmailMetricsTotals;
|
|
1569
1569
|
data?: EmailMetricsDataRow[];
|
|
1570
1570
|
}
|
|
1571
|
-
type GetEmailsMetricsResponse = Response<GetEmailsMetricsResponseSuccess>;
|
|
1571
|
+
export type GetEmailsMetricsResponse = Response<GetEmailsMetricsResponseSuccess>;
|
|
1572
1572
|
//#endregion
|
|
1573
1573
|
//#region src/emails/interfaces/list-emails-options.interface.d.ts
|
|
1574
|
-
type ListEmailsOptions = PaginationOptions;
|
|
1575
|
-
type ListEmail = Omit<GetEmailResponseSuccess, 'html' | 'text' | 'tags' | 'object'>;
|
|
1576
|
-
type ListEmailsResponseSuccess = {
|
|
1574
|
+
export type ListEmailsOptions = PaginationOptions;
|
|
1575
|
+
export type ListEmail = Omit<GetEmailResponseSuccess, 'html' | 'text' | 'tags' | 'object'>;
|
|
1576
|
+
export type ListEmailsResponseSuccess = {
|
|
1577
1577
|
object: 'list';
|
|
1578
1578
|
has_more: boolean;
|
|
1579
1579
|
data: ListEmail[];
|
|
1580
1580
|
};
|
|
1581
|
-
type ListEmailsResponse = Response<ListEmailsResponseSuccess>;
|
|
1581
|
+
export type ListEmailsResponse = Response<ListEmailsResponseSuccess>;
|
|
1582
1582
|
//#endregion
|
|
1583
1583
|
//#region src/emails/interfaces/share-email-options.interface.d.ts
|
|
1584
|
-
interface ShareEmailOptions {
|
|
1584
|
+
export interface ShareEmailOptions {
|
|
1585
1585
|
expiresIn?: string;
|
|
1586
1586
|
}
|
|
1587
|
-
interface ShareEmailResponseSuccess {
|
|
1587
|
+
export interface ShareEmailResponseSuccess {
|
|
1588
1588
|
object: 'email';
|
|
1589
1589
|
id: string;
|
|
1590
1590
|
url: string;
|
|
1591
1591
|
}
|
|
1592
|
-
type ShareEmailResponse = Response<ShareEmailResponseSuccess>;
|
|
1592
|
+
export type ShareEmailResponse = Response<ShareEmailResponseSuccess>;
|
|
1593
1593
|
//#endregion
|
|
1594
1594
|
//#region src/emails/interfaces/update-email-options.interface.d.ts
|
|
1595
|
-
interface UpdateEmailOptions {
|
|
1595
|
+
export interface UpdateEmailOptions {
|
|
1596
1596
|
id: string;
|
|
1597
1597
|
scheduledAt: string;
|
|
1598
1598
|
}
|
|
1599
|
-
interface UpdateEmailResponseSuccess {
|
|
1599
|
+
export interface UpdateEmailResponseSuccess {
|
|
1600
1600
|
id: string;
|
|
1601
1601
|
object: 'email';
|
|
1602
1602
|
}
|
|
1603
|
-
type UpdateEmailResponse = Response<UpdateEmailResponseSuccess>;
|
|
1603
|
+
export type UpdateEmailResponse = Response<UpdateEmailResponseSuccess>;
|
|
1604
1604
|
//#endregion
|
|
1605
1605
|
//#region src/emails/receiving/interfaces/forward-receiving-email.interface.d.ts
|
|
1606
1606
|
interface ForwardReceivingEmailBodyOptions {
|
|
@@ -1612,16 +1612,16 @@ interface ForwardReceivingEmailBaseOptions {
|
|
|
1612
1612
|
to: string | string[];
|
|
1613
1613
|
from: string;
|
|
1614
1614
|
}
|
|
1615
|
-
type ForwardReceivingEmailOptions = (ForwardReceivingEmailBaseOptions & {
|
|
1615
|
+
export type ForwardReceivingEmailOptions = (ForwardReceivingEmailBaseOptions & {
|
|
1616
1616
|
passthrough?: true;
|
|
1617
1617
|
}) | (ForwardReceivingEmailBaseOptions & {
|
|
1618
1618
|
passthrough: false;
|
|
1619
1619
|
} & RequireAtLeastOne<ForwardReceivingEmailBodyOptions>);
|
|
1620
|
-
interface ForwardReceivingEmailRequestOptions extends PostOptions, IdempotentRequest {}
|
|
1621
|
-
interface ForwardReceivingEmailResponseSuccess {
|
|
1620
|
+
export interface ForwardReceivingEmailRequestOptions extends PostOptions, IdempotentRequest {}
|
|
1621
|
+
export interface ForwardReceivingEmailResponseSuccess {
|
|
1622
1622
|
id: string;
|
|
1623
1623
|
}
|
|
1624
|
-
type ForwardReceivingEmailResponse = Response<ForwardReceivingEmailResponseSuccess>;
|
|
1624
|
+
export type ForwardReceivingEmailResponse = Response<ForwardReceivingEmailResponseSuccess>;
|
|
1625
1625
|
//#endregion
|
|
1626
1626
|
//#region src/emails/receiving/interfaces/get-receiving-email.interface.d.ts
|
|
1627
1627
|
/**
|
|
@@ -1632,7 +1632,7 @@ type ForwardReceivingEmailResponse = Response<ForwardReceivingEmailResponseSucce
|
|
|
1632
1632
|
* Not to be confused with AttachmentData, which is the shape returned by the
|
|
1633
1633
|
* dedicated attachment endpoints (includes download_url and expires_at).
|
|
1634
1634
|
*/
|
|
1635
|
-
interface InboundAttachment {
|
|
1635
|
+
export interface InboundAttachment {
|
|
1636
1636
|
id: string;
|
|
1637
1637
|
filename: string | null;
|
|
1638
1638
|
size: number;
|
|
@@ -1640,7 +1640,7 @@ interface InboundAttachment {
|
|
|
1640
1640
|
content_id: string | null;
|
|
1641
1641
|
content_disposition: string | null;
|
|
1642
1642
|
}
|
|
1643
|
-
interface GetReceivingEmailResponseSuccess {
|
|
1643
|
+
export interface GetReceivingEmailResponseSuccess {
|
|
1644
1644
|
object: 'email';
|
|
1645
1645
|
id: string;
|
|
1646
1646
|
to: string[];
|
|
@@ -1661,8 +1661,8 @@ interface GetReceivingEmailResponseSuccess {
|
|
|
1661
1661
|
} | null;
|
|
1662
1662
|
attachments: InboundAttachment[];
|
|
1663
1663
|
}
|
|
1664
|
-
type GetReceivingEmailResponse = Response<GetReceivingEmailResponseSuccess>;
|
|
1665
|
-
interface GetReceivingEmailOptions {
|
|
1664
|
+
export type GetReceivingEmailResponse = Response<GetReceivingEmailResponseSuccess>;
|
|
1665
|
+
export interface GetReceivingEmailOptions {
|
|
1666
1666
|
/**
|
|
1667
1667
|
* Controls how inline images are returned inside `html`. By default (or when
|
|
1668
1668
|
* set to `'data_uri'`), inline images appear in `html` as base64 `data:` URIs.
|
|
@@ -1673,14 +1673,14 @@ interface GetReceivingEmailOptions {
|
|
|
1673
1673
|
}
|
|
1674
1674
|
//#endregion
|
|
1675
1675
|
//#region src/emails/receiving/interfaces/list-receiving-emails.interface.d.ts
|
|
1676
|
-
type ListReceivingEmailsOptions = PaginationOptions;
|
|
1677
|
-
type ListReceivingEmail = Omit<GetReceivingEmailResponseSuccess, 'html' | 'text' | 'headers' | 'raw' | 'object'>;
|
|
1678
|
-
interface ListReceivingEmailsResponseSuccess {
|
|
1676
|
+
export type ListReceivingEmailsOptions = PaginationOptions;
|
|
1677
|
+
export type ListReceivingEmail = Omit<GetReceivingEmailResponseSuccess, 'html' | 'text' | 'headers' | 'raw' | 'object'>;
|
|
1678
|
+
export interface ListReceivingEmailsResponseSuccess {
|
|
1679
1679
|
object: 'list';
|
|
1680
1680
|
has_more: boolean;
|
|
1681
1681
|
data: ListReceivingEmail[];
|
|
1682
1682
|
}
|
|
1683
|
-
type ListReceivingEmailsResponse = {
|
|
1683
|
+
export type ListReceivingEmailsResponse = {
|
|
1684
1684
|
data: ListReceivingEmailsResponseSuccess;
|
|
1685
1685
|
error: null;
|
|
1686
1686
|
} | {
|
|
@@ -1689,9 +1689,9 @@ type ListReceivingEmailsResponse = {
|
|
|
1689
1689
|
};
|
|
1690
1690
|
//#endregion
|
|
1691
1691
|
//#region src/events/interfaces/event.d.ts
|
|
1692
|
-
type EventSchemaType = 'string' | 'number' | 'boolean' | 'date';
|
|
1693
|
-
type EventSchemaMap = Record<string, EventSchemaType>;
|
|
1694
|
-
interface Event {
|
|
1692
|
+
export type EventSchemaType = 'string' | 'number' | 'boolean' | 'date';
|
|
1693
|
+
export type EventSchemaMap = Record<string, EventSchemaType>;
|
|
1694
|
+
export interface Event {
|
|
1695
1695
|
id: string;
|
|
1696
1696
|
name: string;
|
|
1697
1697
|
schema: EventSchemaMap | null;
|
|
@@ -1700,40 +1700,40 @@ interface Event {
|
|
|
1700
1700
|
}
|
|
1701
1701
|
//#endregion
|
|
1702
1702
|
//#region src/events/interfaces/create-event.interface.d.ts
|
|
1703
|
-
interface CreateEventOptions {
|
|
1703
|
+
export interface CreateEventOptions {
|
|
1704
1704
|
name: string;
|
|
1705
1705
|
schema?: EventSchemaMap | null;
|
|
1706
1706
|
}
|
|
1707
|
-
interface CreateEventResponseSuccess {
|
|
1707
|
+
export interface CreateEventResponseSuccess {
|
|
1708
1708
|
object: 'event';
|
|
1709
1709
|
id: string;
|
|
1710
1710
|
}
|
|
1711
|
-
type CreateEventResponse = Response<CreateEventResponseSuccess>;
|
|
1711
|
+
export type CreateEventResponse = Response<CreateEventResponseSuccess>;
|
|
1712
1712
|
//#endregion
|
|
1713
1713
|
//#region src/events/interfaces/get-event.interface.d.ts
|
|
1714
|
-
interface GetEventResponseSuccess extends Event {
|
|
1714
|
+
export interface GetEventResponseSuccess extends Event {
|
|
1715
1715
|
object: 'event';
|
|
1716
1716
|
}
|
|
1717
|
-
type GetEventResponse = Response<GetEventResponseSuccess>;
|
|
1717
|
+
export type GetEventResponse = Response<GetEventResponseSuccess>;
|
|
1718
1718
|
//#endregion
|
|
1719
1719
|
//#region src/events/interfaces/list-events.interface.d.ts
|
|
1720
|
-
type ListEventsOptions = PaginationOptions;
|
|
1721
|
-
interface ListEventsResponseSuccess {
|
|
1720
|
+
export type ListEventsOptions = PaginationOptions;
|
|
1721
|
+
export interface ListEventsResponseSuccess {
|
|
1722
1722
|
object: 'list';
|
|
1723
1723
|
has_more: boolean;
|
|
1724
1724
|
data: Event[];
|
|
1725
1725
|
}
|
|
1726
|
-
type ListEventsResponse = Response<ListEventsResponseSuccess>;
|
|
1726
|
+
export type ListEventsResponse = Response<ListEventsResponseSuccess>;
|
|
1727
1727
|
//#endregion
|
|
1728
1728
|
//#region src/events/interfaces/remove-event.interface.d.ts
|
|
1729
|
-
interface RemoveEventResponseSuccess extends Pick<Event, 'id'> {
|
|
1729
|
+
export interface RemoveEventResponseSuccess extends Pick<Event, 'id'> {
|
|
1730
1730
|
object: 'event';
|
|
1731
1731
|
deleted: boolean;
|
|
1732
1732
|
}
|
|
1733
|
-
type RemoveEventResponse = Response<RemoveEventResponseSuccess>;
|
|
1733
|
+
export type RemoveEventResponse = Response<RemoveEventResponseSuccess>;
|
|
1734
1734
|
//#endregion
|
|
1735
1735
|
//#region src/events/interfaces/send-event.interface.d.ts
|
|
1736
|
-
type SendEventOptions = {
|
|
1736
|
+
export type SendEventOptions = {
|
|
1737
1737
|
event: string;
|
|
1738
1738
|
contactId: string;
|
|
1739
1739
|
email?: never;
|
|
@@ -1744,24 +1744,24 @@ type SendEventOptions = {
|
|
|
1744
1744
|
contactId?: never;
|
|
1745
1745
|
payload?: Record<string, unknown>;
|
|
1746
1746
|
};
|
|
1747
|
-
interface SendEventResponseSuccess {
|
|
1747
|
+
export interface SendEventResponseSuccess {
|
|
1748
1748
|
object: 'event';
|
|
1749
1749
|
event: string;
|
|
1750
1750
|
}
|
|
1751
|
-
type SendEventResponse = Response<SendEventResponseSuccess>;
|
|
1751
|
+
export type SendEventResponse = Response<SendEventResponseSuccess>;
|
|
1752
1752
|
//#endregion
|
|
1753
1753
|
//#region src/events/interfaces/update-event.interface.d.ts
|
|
1754
|
-
interface UpdateEventOptions {
|
|
1754
|
+
export interface UpdateEventOptions {
|
|
1755
1755
|
schema: EventSchemaMap | null;
|
|
1756
1756
|
}
|
|
1757
|
-
interface UpdateEventResponseSuccess {
|
|
1757
|
+
export interface UpdateEventResponseSuccess {
|
|
1758
1758
|
object: 'event';
|
|
1759
1759
|
id: string;
|
|
1760
1760
|
}
|
|
1761
|
-
type UpdateEventResponse = Response<UpdateEventResponseSuccess>;
|
|
1761
|
+
export type UpdateEventResponse = Response<UpdateEventResponseSuccess>;
|
|
1762
1762
|
//#endregion
|
|
1763
1763
|
//#region src/logs/interfaces/log.d.ts
|
|
1764
|
-
interface Log {
|
|
1764
|
+
export interface Log {
|
|
1765
1765
|
id: string;
|
|
1766
1766
|
created_at: string;
|
|
1767
1767
|
endpoint: string;
|
|
@@ -1773,19 +1773,19 @@ interface Log {
|
|
|
1773
1773
|
}
|
|
1774
1774
|
//#endregion
|
|
1775
1775
|
//#region src/logs/interfaces/get-log.interface.d.ts
|
|
1776
|
-
type GetLogResponseSuccess = {
|
|
1776
|
+
export type GetLogResponseSuccess = {
|
|
1777
1777
|
object: 'log';
|
|
1778
1778
|
} & Log;
|
|
1779
|
-
type GetLogResponse = Response<GetLogResponseSuccess>;
|
|
1779
|
+
export type GetLogResponse = Response<GetLogResponseSuccess>;
|
|
1780
1780
|
//#endregion
|
|
1781
1781
|
//#region src/logs/interfaces/list-logs.interface.d.ts
|
|
1782
|
-
type ListLogsOptions = PaginationOptions;
|
|
1783
|
-
type ListLogsResponseSuccess = {
|
|
1782
|
+
export type ListLogsOptions = PaginationOptions;
|
|
1783
|
+
export type ListLogsResponseSuccess = {
|
|
1784
1784
|
object: 'list';
|
|
1785
1785
|
has_more: boolean;
|
|
1786
1786
|
data: Pick<Log, 'id' | 'created_at' | 'endpoint' | 'method' | 'response_status' | 'user_agent'>[];
|
|
1787
1787
|
};
|
|
1788
|
-
type ListLogsResponse = Response<ListLogsResponseSuccess>;
|
|
1788
|
+
export type ListLogsResponse = Response<ListLogsResponseSuccess>;
|
|
1789
1789
|
//#endregion
|
|
1790
1790
|
//#region src/oauth-grants/interfaces/oauth-grant.d.ts
|
|
1791
1791
|
interface OAuthGrant {
|
|
@@ -2025,45 +2025,45 @@ declare class OAuthGrants {
|
|
|
2025
2025
|
}
|
|
2026
2026
|
//#endregion
|
|
2027
2027
|
//#region src/segments/interfaces/create-segment-options.interface.d.ts
|
|
2028
|
-
interface CreateSegmentOptions {
|
|
2028
|
+
export interface CreateSegmentOptions {
|
|
2029
2029
|
name: string;
|
|
2030
2030
|
}
|
|
2031
|
-
interface CreateSegmentRequestOptions extends PostOptions {}
|
|
2032
|
-
interface CreateSegmentResponseSuccess extends Pick<Segment, 'name' | 'id'> {
|
|
2031
|
+
export interface CreateSegmentRequestOptions extends PostOptions {}
|
|
2032
|
+
export interface CreateSegmentResponseSuccess extends Pick<Segment, 'name' | 'id'> {
|
|
2033
2033
|
object: 'segment';
|
|
2034
2034
|
}
|
|
2035
|
-
type CreateSegmentResponse = Response<CreateSegmentResponseSuccess>;
|
|
2035
|
+
export type CreateSegmentResponse = Response<CreateSegmentResponseSuccess>;
|
|
2036
2036
|
//#endregion
|
|
2037
2037
|
//#region src/segments/interfaces/get-segment.interface.d.ts
|
|
2038
|
-
interface GetSegmentResponseSuccess extends Pick<Segment, 'id' | 'name' | 'created_at'> {
|
|
2038
|
+
export interface GetSegmentResponseSuccess extends Pick<Segment, 'id' | 'name' | 'created_at'> {
|
|
2039
2039
|
object: 'segment';
|
|
2040
2040
|
}
|
|
2041
|
-
type GetSegmentResponse = Response<GetSegmentResponseSuccess>;
|
|
2041
|
+
export type GetSegmentResponse = Response<GetSegmentResponseSuccess>;
|
|
2042
2042
|
//#endregion
|
|
2043
2043
|
//#region src/segments/interfaces/list-segments.interface.d.ts
|
|
2044
|
-
type ListSegmentsOptions = PaginationOptions;
|
|
2045
|
-
type ListSegmentsResponseSuccess = {
|
|
2044
|
+
export type ListSegmentsOptions = PaginationOptions;
|
|
2045
|
+
export type ListSegmentsResponseSuccess = {
|
|
2046
2046
|
object: 'list';
|
|
2047
2047
|
data: Segment[];
|
|
2048
2048
|
has_more: boolean;
|
|
2049
2049
|
};
|
|
2050
|
-
type ListSegmentsResponse = Response<ListSegmentsResponseSuccess>;
|
|
2050
|
+
export type ListSegmentsResponse = Response<ListSegmentsResponseSuccess>;
|
|
2051
2051
|
//#endregion
|
|
2052
2052
|
//#region src/segments/interfaces/remove-segment.interface.d.ts
|
|
2053
|
-
interface RemoveSegmentResponseSuccess extends Pick<Segment, 'id'> {
|
|
2053
|
+
export interface RemoveSegmentResponseSuccess extends Pick<Segment, 'id'> {
|
|
2054
2054
|
object: 'segment';
|
|
2055
2055
|
deleted: boolean;
|
|
2056
2056
|
}
|
|
2057
|
-
type RemoveSegmentResponse = Response<RemoveSegmentResponseSuccess>;
|
|
2057
|
+
export type RemoveSegmentResponse = Response<RemoveSegmentResponseSuccess>;
|
|
2058
2058
|
//#endregion
|
|
2059
2059
|
//#region src/segments/interfaces/update-segment.interface.d.ts
|
|
2060
|
-
interface UpdateSegmentOptions {
|
|
2060
|
+
export interface UpdateSegmentOptions {
|
|
2061
2061
|
name: string;
|
|
2062
2062
|
}
|
|
2063
|
-
interface UpdateSegmentResponseSuccess extends Pick<Segment, 'id'> {
|
|
2063
|
+
export interface UpdateSegmentResponseSuccess extends Pick<Segment, 'id'> {
|
|
2064
2064
|
object: 'segment';
|
|
2065
2065
|
}
|
|
2066
|
-
type UpdateSegmentResponse = Response<UpdateSegmentResponseSuccess>;
|
|
2066
|
+
export type UpdateSegmentResponse = Response<UpdateSegmentResponseSuccess>;
|
|
2067
2067
|
//#endregion
|
|
2068
2068
|
//#region src/segments/segments.d.ts
|
|
2069
2069
|
declare class Segments {
|
|
@@ -2077,33 +2077,33 @@ declare class Segments {
|
|
|
2077
2077
|
}
|
|
2078
2078
|
//#endregion
|
|
2079
2079
|
//#region src/suppressions/batch/interfaces/batch-add-suppressions.interface.d.ts
|
|
2080
|
-
interface BatchAddSuppressionsOptions {
|
|
2080
|
+
export interface BatchAddSuppressionsOptions {
|
|
2081
2081
|
emails: string[];
|
|
2082
2082
|
}
|
|
2083
|
-
interface BatchAddSuppressionsResponseSuccess {
|
|
2083
|
+
export interface BatchAddSuppressionsResponseSuccess {
|
|
2084
2084
|
data: {
|
|
2085
2085
|
object: 'suppression';
|
|
2086
2086
|
id: string;
|
|
2087
2087
|
}[];
|
|
2088
2088
|
}
|
|
2089
|
-
type BatchAddSuppressionsResponse = Response<BatchAddSuppressionsResponseSuccess>;
|
|
2089
|
+
export type BatchAddSuppressionsResponse = Response<BatchAddSuppressionsResponseSuccess>;
|
|
2090
2090
|
//#endregion
|
|
2091
2091
|
//#region src/suppressions/batch/interfaces/batch-remove-suppressions.interface.d.ts
|
|
2092
|
-
type BatchRemoveSuppressionsOptions = {
|
|
2092
|
+
export type BatchRemoveSuppressionsOptions = {
|
|
2093
2093
|
emails: string[];
|
|
2094
2094
|
ids?: never;
|
|
2095
2095
|
} | {
|
|
2096
2096
|
ids: string[];
|
|
2097
2097
|
emails?: never;
|
|
2098
2098
|
};
|
|
2099
|
-
interface BatchRemoveSuppressionsResponseSuccess {
|
|
2099
|
+
export interface BatchRemoveSuppressionsResponseSuccess {
|
|
2100
2100
|
data: {
|
|
2101
2101
|
object: 'suppression';
|
|
2102
2102
|
id: string;
|
|
2103
2103
|
deleted: boolean;
|
|
2104
2104
|
}[];
|
|
2105
2105
|
}
|
|
2106
|
-
type BatchRemoveSuppressionsResponse = Response<BatchRemoveSuppressionsResponseSuccess>;
|
|
2106
|
+
export type BatchRemoveSuppressionsResponse = Response<BatchRemoveSuppressionsResponseSuccess>;
|
|
2107
2107
|
//#endregion
|
|
2108
2108
|
//#region src/suppressions/batch/batch.d.ts
|
|
2109
2109
|
declare class Batch {
|
|
@@ -2114,18 +2114,18 @@ declare class Batch {
|
|
|
2114
2114
|
}
|
|
2115
2115
|
//#endregion
|
|
2116
2116
|
//#region src/suppressions/interfaces/add-suppression.interface.d.ts
|
|
2117
|
-
interface AddSuppressionOptions {
|
|
2117
|
+
export interface AddSuppressionOptions {
|
|
2118
2118
|
email: string;
|
|
2119
2119
|
}
|
|
2120
|
-
interface AddSuppressionResponseSuccess {
|
|
2120
|
+
export interface AddSuppressionResponseSuccess {
|
|
2121
2121
|
object: 'suppression';
|
|
2122
2122
|
id: string;
|
|
2123
2123
|
}
|
|
2124
|
-
type AddSuppressionResponse = Response<AddSuppressionResponseSuccess>;
|
|
2124
|
+
export type AddSuppressionResponse = Response<AddSuppressionResponseSuccess>;
|
|
2125
2125
|
//#endregion
|
|
2126
2126
|
//#region src/suppressions/interfaces/suppression-list-entry.d.ts
|
|
2127
|
-
type SuppressionOrigin = 'bounce' | 'complaint' | 'manual';
|
|
2128
|
-
interface Suppression {
|
|
2127
|
+
export type SuppressionOrigin = 'bounce' | 'complaint' | 'manual';
|
|
2128
|
+
export interface Suppression {
|
|
2129
2129
|
object: 'suppression';
|
|
2130
2130
|
id: string;
|
|
2131
2131
|
email: string;
|
|
@@ -2133,26 +2133,26 @@ interface Suppression {
|
|
|
2133
2133
|
source_id: string | null;
|
|
2134
2134
|
created_at: string;
|
|
2135
2135
|
}
|
|
2136
|
-
type SuppressionListEntry = Omit<Suppression, 'object'>;
|
|
2136
|
+
export type SuppressionListEntry = Omit<Suppression, 'object'>;
|
|
2137
2137
|
//#endregion
|
|
2138
2138
|
//#region src/suppressions/interfaces/get-suppression.interface.d.ts
|
|
2139
|
-
type GetSuppressionResponseSuccess = Suppression;
|
|
2140
|
-
type GetSuppressionResponse = Response<GetSuppressionResponseSuccess>;
|
|
2139
|
+
export type GetSuppressionResponseSuccess = Suppression;
|
|
2140
|
+
export type GetSuppressionResponse = Response<GetSuppressionResponseSuccess>;
|
|
2141
2141
|
//#endregion
|
|
2142
2142
|
//#region src/suppressions/interfaces/list-suppressions.interface.d.ts
|
|
2143
|
-
type ListSuppressionsOptions = PaginationOptions & {
|
|
2143
|
+
export type ListSuppressionsOptions = PaginationOptions & {
|
|
2144
2144
|
origin?: SuppressionOrigin;
|
|
2145
2145
|
};
|
|
2146
|
-
type ListSuppressionsResponseSuccess = PaginatedData<SuppressionListEntry[]>;
|
|
2147
|
-
type ListSuppressionsResponse = Response<ListSuppressionsResponseSuccess>;
|
|
2146
|
+
export type ListSuppressionsResponseSuccess = PaginatedData<SuppressionListEntry[]>;
|
|
2147
|
+
export type ListSuppressionsResponse = Response<ListSuppressionsResponseSuccess>;
|
|
2148
2148
|
//#endregion
|
|
2149
2149
|
//#region src/suppressions/interfaces/remove-suppression.interface.d.ts
|
|
2150
|
-
interface RemoveSuppressionResponseSuccess {
|
|
2150
|
+
export interface RemoveSuppressionResponseSuccess {
|
|
2151
2151
|
object: 'suppression';
|
|
2152
2152
|
id: string;
|
|
2153
2153
|
deleted: boolean;
|
|
2154
2154
|
}
|
|
2155
|
-
type RemoveSuppressionResponse = Response<RemoveSuppressionResponseSuccess>;
|
|
2155
|
+
export type RemoveSuppressionResponse = Response<RemoveSuppressionResponseSuccess>;
|
|
2156
2156
|
//#endregion
|
|
2157
2157
|
//#region src/suppressions/suppressions.d.ts
|
|
2158
2158
|
declare class Suppressions {
|
|
@@ -2166,7 +2166,7 @@ declare class Suppressions {
|
|
|
2166
2166
|
}
|
|
2167
2167
|
//#endregion
|
|
2168
2168
|
//#region src/templates/interfaces/template.d.ts
|
|
2169
|
-
interface Template {
|
|
2169
|
+
export interface Template {
|
|
2170
2170
|
id: string;
|
|
2171
2171
|
name: string;
|
|
2172
2172
|
subject: string | null;
|
|
@@ -2183,7 +2183,7 @@ interface Template {
|
|
|
2183
2183
|
has_unpublished_versions: boolean;
|
|
2184
2184
|
current_version_id: string;
|
|
2185
2185
|
}
|
|
2186
|
-
interface TemplateVariable {
|
|
2186
|
+
export interface TemplateVariable {
|
|
2187
2187
|
key: string;
|
|
2188
2188
|
fallback_value: string | number | null;
|
|
2189
2189
|
type: 'string' | 'number';
|
|
@@ -2207,24 +2207,24 @@ type TemplateOptionalFieldsForCreation = Partial<Pick<Template, 'subject' | 'tex
|
|
|
2207
2207
|
replyTo?: string[] | string;
|
|
2208
2208
|
variables?: TemplateVariableCreationOptions[];
|
|
2209
2209
|
};
|
|
2210
|
-
type CreateTemplateOptions = Pick<Template, 'name'> & TemplateOptionalFieldsForCreation & TemplateContentCreationOptions;
|
|
2211
|
-
interface CreateTemplateRequestOptions extends PostOptions {}
|
|
2212
|
-
interface CreateTemplateResponseSuccess extends Pick<Template, 'id'> {
|
|
2210
|
+
export type CreateTemplateOptions = Pick<Template, 'name'> & TemplateOptionalFieldsForCreation & TemplateContentCreationOptions;
|
|
2211
|
+
export interface CreateTemplateRequestOptions extends PostOptions {}
|
|
2212
|
+
export interface CreateTemplateResponseSuccess extends Pick<Template, 'id'> {
|
|
2213
2213
|
object: 'template';
|
|
2214
2214
|
}
|
|
2215
|
-
type CreateTemplateResponse = Response<CreateTemplateResponseSuccess>;
|
|
2215
|
+
export type CreateTemplateResponse = Response<CreateTemplateResponseSuccess>;
|
|
2216
2216
|
//#endregion
|
|
2217
2217
|
//#region src/templates/interfaces/duplicate-template.interface.d.ts
|
|
2218
|
-
interface DuplicateTemplateResponseSuccess extends Pick<Template, 'id'> {
|
|
2218
|
+
export interface DuplicateTemplateResponseSuccess extends Pick<Template, 'id'> {
|
|
2219
2219
|
object: 'template';
|
|
2220
2220
|
}
|
|
2221
|
-
type DuplicateTemplateResponse = Response<DuplicateTemplateResponseSuccess>;
|
|
2221
|
+
export type DuplicateTemplateResponse = Response<DuplicateTemplateResponseSuccess>;
|
|
2222
2222
|
//#endregion
|
|
2223
2223
|
//#region src/templates/interfaces/publish-template.interface.d.ts
|
|
2224
|
-
interface PublishTemplateResponseSuccess extends Pick<Template, 'id'> {
|
|
2224
|
+
export interface PublishTemplateResponseSuccess extends Pick<Template, 'id'> {
|
|
2225
2225
|
object: 'template';
|
|
2226
2226
|
}
|
|
2227
|
-
type PublishTemplateResponse = Response<PublishTemplateResponseSuccess>;
|
|
2227
|
+
export type PublishTemplateResponse = Response<PublishTemplateResponseSuccess>;
|
|
2228
2228
|
//#endregion
|
|
2229
2229
|
//#region src/templates/chainable-template-result.d.ts
|
|
2230
2230
|
declare class ChainableTemplateResult<T extends CreateTemplateResponse | DuplicateTemplateResponse> implements PromiseLike<T> {
|
|
@@ -2236,28 +2236,28 @@ declare class ChainableTemplateResult<T extends CreateTemplateResponse | Duplica
|
|
|
2236
2236
|
}
|
|
2237
2237
|
//#endregion
|
|
2238
2238
|
//#region src/templates/interfaces/get-template.interface.d.ts
|
|
2239
|
-
interface GetTemplateResponseSuccess extends Template {
|
|
2239
|
+
export interface GetTemplateResponseSuccess extends Template {
|
|
2240
2240
|
object: 'template';
|
|
2241
2241
|
}
|
|
2242
|
-
type GetTemplateResponse = Response<GetTemplateResponseSuccess>;
|
|
2242
|
+
export type GetTemplateResponse = Response<GetTemplateResponseSuccess>;
|
|
2243
2243
|
//#endregion
|
|
2244
2244
|
//#region src/templates/interfaces/list-templates.interface.d.ts
|
|
2245
|
-
type ListTemplatesOptions = PaginationOptions;
|
|
2245
|
+
export type ListTemplatesOptions = PaginationOptions;
|
|
2246
2246
|
interface TemplateListItem extends Pick<Template, 'id' | 'name' | 'created_at' | 'updated_at' | 'status' | 'published_at' | 'alias'> {}
|
|
2247
|
-
interface ListTemplatesResponseSuccess {
|
|
2247
|
+
export interface ListTemplatesResponseSuccess {
|
|
2248
2248
|
object: 'list';
|
|
2249
2249
|
data: TemplateListItem[];
|
|
2250
2250
|
has_more: boolean;
|
|
2251
2251
|
}
|
|
2252
|
-
type ListTemplatesResponse = Response<ListTemplatesResponseSuccess>;
|
|
2252
|
+
export type ListTemplatesResponse = Response<ListTemplatesResponseSuccess>;
|
|
2253
2253
|
//#endregion
|
|
2254
2254
|
//#region src/templates/interfaces/remove-template.interface.d.ts
|
|
2255
|
-
interface RemoveTemplateResponseSuccess {
|
|
2255
|
+
export interface RemoveTemplateResponseSuccess {
|
|
2256
2256
|
object: 'template';
|
|
2257
2257
|
id: string;
|
|
2258
2258
|
deleted: boolean;
|
|
2259
2259
|
}
|
|
2260
|
-
type RemoveTemplateResponse = Response<RemoveTemplateResponseSuccess>;
|
|
2260
|
+
export type RemoveTemplateResponse = Response<RemoveTemplateResponseSuccess>;
|
|
2261
2261
|
//#endregion
|
|
2262
2262
|
//#region src/templates/interfaces/update-template.interface.d.ts
|
|
2263
2263
|
type TemplateVariableUpdateOptions = Pick<TemplateVariable, 'key' | 'type'> & ({
|
|
@@ -2267,14 +2267,14 @@ type TemplateVariableUpdateOptions = Pick<TemplateVariable, 'key' | 'type'> & ({
|
|
|
2267
2267
|
type: 'number';
|
|
2268
2268
|
fallbackValue?: number | null;
|
|
2269
2269
|
});
|
|
2270
|
-
interface UpdateTemplateOptions extends Partial<Pick<Template, 'name' | 'subject' | 'html' | 'text' | 'from' | 'alias'>> {
|
|
2270
|
+
export interface UpdateTemplateOptions extends Partial<Pick<Template, 'name' | 'subject' | 'html' | 'text' | 'from' | 'alias'>> {
|
|
2271
2271
|
variables?: TemplateVariableUpdateOptions[];
|
|
2272
2272
|
replyTo?: string[] | string;
|
|
2273
2273
|
}
|
|
2274
|
-
interface UpdateTemplateResponseSuccess extends Pick<Template, 'id'> {
|
|
2274
|
+
export interface UpdateTemplateResponseSuccess extends Pick<Template, 'id'> {
|
|
2275
2275
|
object: 'template';
|
|
2276
2276
|
}
|
|
2277
|
-
type UpdateTemplateResponse = Response<UpdateTemplateResponseSuccess>;
|
|
2277
|
+
export type UpdateTemplateResponse = Response<UpdateTemplateResponseSuccess>;
|
|
2278
2278
|
//#endregion
|
|
2279
2279
|
//#region src/templates/templates.d.ts
|
|
2280
2280
|
declare class Templates {
|
|
@@ -2291,7 +2291,7 @@ declare class Templates {
|
|
|
2291
2291
|
}
|
|
2292
2292
|
//#endregion
|
|
2293
2293
|
//#region src/topics/interfaces/topic.d.ts
|
|
2294
|
-
interface Topic {
|
|
2294
|
+
export interface Topic {
|
|
2295
2295
|
id: string;
|
|
2296
2296
|
name: string;
|
|
2297
2297
|
description?: string;
|
|
@@ -2300,42 +2300,42 @@ interface Topic {
|
|
|
2300
2300
|
}
|
|
2301
2301
|
//#endregion
|
|
2302
2302
|
//#region src/topics/interfaces/create-topic-options.interface.d.ts
|
|
2303
|
-
interface CreateTopicOptions {
|
|
2303
|
+
export interface CreateTopicOptions {
|
|
2304
2304
|
name: string;
|
|
2305
2305
|
description?: string;
|
|
2306
2306
|
defaultSubscription: 'opt_in' | 'opt_out';
|
|
2307
2307
|
}
|
|
2308
|
-
type CreateTopicResponseSuccess = Pick<Topic, 'id'>;
|
|
2309
|
-
type CreateTopicResponse = Response<CreateTopicResponseSuccess>;
|
|
2308
|
+
export type CreateTopicResponseSuccess = Pick<Topic, 'id'>;
|
|
2309
|
+
export type CreateTopicResponse = Response<CreateTopicResponseSuccess>;
|
|
2310
2310
|
//#endregion
|
|
2311
2311
|
//#region src/topics/interfaces/get-topic.interface.d.ts
|
|
2312
|
-
interface GetTopicOptions {
|
|
2312
|
+
export interface GetTopicOptions {
|
|
2313
2313
|
id: string;
|
|
2314
2314
|
}
|
|
2315
|
-
type GetTopicResponseSuccess = Topic;
|
|
2316
|
-
type GetTopicResponse = Response<GetTopicResponseSuccess>;
|
|
2315
|
+
export type GetTopicResponseSuccess = Topic;
|
|
2316
|
+
export type GetTopicResponse = Response<GetTopicResponseSuccess>;
|
|
2317
2317
|
//#endregion
|
|
2318
2318
|
//#region src/topics/interfaces/list-topics.interface.d.ts
|
|
2319
|
-
interface ListTopicsResponseSuccess {
|
|
2319
|
+
export interface ListTopicsResponseSuccess {
|
|
2320
2320
|
data: Topic[];
|
|
2321
2321
|
}
|
|
2322
|
-
type ListTopicsResponse = Response<ListTopicsResponseSuccess>;
|
|
2322
|
+
export type ListTopicsResponse = Response<ListTopicsResponseSuccess>;
|
|
2323
2323
|
//#endregion
|
|
2324
2324
|
//#region src/topics/interfaces/remove-topic.interface.d.ts
|
|
2325
|
-
type RemoveTopicResponseSuccess = Pick<Topic, 'id'> & {
|
|
2325
|
+
export type RemoveTopicResponseSuccess = Pick<Topic, 'id'> & {
|
|
2326
2326
|
object: 'topic';
|
|
2327
2327
|
deleted: boolean;
|
|
2328
2328
|
};
|
|
2329
|
-
type RemoveTopicResponse = Response<RemoveTopicResponseSuccess>;
|
|
2329
|
+
export type RemoveTopicResponse = Response<RemoveTopicResponseSuccess>;
|
|
2330
2330
|
//#endregion
|
|
2331
2331
|
//#region src/topics/interfaces/update-topic.interface.d.ts
|
|
2332
|
-
interface UpdateTopicOptions {
|
|
2332
|
+
export interface UpdateTopicOptions {
|
|
2333
2333
|
id: string;
|
|
2334
2334
|
name?: string;
|
|
2335
2335
|
description?: string;
|
|
2336
2336
|
}
|
|
2337
|
-
type UpdateTopicResponseSuccess = Pick<Topic, 'id'>;
|
|
2338
|
-
type UpdateTopicResponse = Response<UpdateTopicResponseSuccess>;
|
|
2337
|
+
export type UpdateTopicResponseSuccess = Pick<Topic, 'id'>;
|
|
2338
|
+
export type UpdateTopicResponse = Response<UpdateTopicResponseSuccess>;
|
|
2339
2339
|
//#endregion
|
|
2340
2340
|
//#region src/topics/topics.d.ts
|
|
2341
2341
|
declare class Topics {
|
|
@@ -2719,7 +2719,7 @@ interface ResendOptions {
|
|
|
2719
2719
|
baseUrl?: string;
|
|
2720
2720
|
userAgent?: string;
|
|
2721
2721
|
}
|
|
2722
|
-
declare class Resend {
|
|
2722
|
+
export declare class Resend {
|
|
2723
2723
|
readonly key?: string | undefined;
|
|
2724
2724
|
readonly baseUrl: string;
|
|
2725
2725
|
readonly userAgent: string;
|
|
@@ -2754,4 +2754,4 @@ declare class Resend {
|
|
|
2754
2754
|
delete<T>(path: string, query?: unknown, options?: DeleteOptions): Promise<Response<T>>;
|
|
2755
2755
|
}
|
|
2756
2756
|
//#endregion
|
|
2757
|
-
export { AddContactSegmentOptions, AddContactSegmentResponse, AddContactSegmentResponseSuccess, AddSuppressionOptions, AddSuppressionResponse, AddSuppressionResponseSuccess, AddToSegmentStepConfig, ApiContactProperty, ApiKey, Attachment, AttachmentData, Automation, AutomationConnection, AutomationConnectionType, AutomationResponseConnection, AutomationResponseStep, AutomationRun, AutomationRunItem, AutomationRunStatus, AutomationRunStep, AutomationRunStepStatus, AutomationStatus, AutomationStep, AutomationStepType, BatchAddSuppressionsOptions, BatchAddSuppressionsResponse, BatchAddSuppressionsResponseSuccess, BatchRemoveSuppressionsOptions, BatchRemoveSuppressionsResponse, BatchRemoveSuppressionsResponseSuccess, Broadcast, BroadcastClickedLink, BroadcastRecipient, BroadcastRecipientBounceType, BroadcastRecipientClickedLink, BroadcastRecipientEventType, CancelBroadcastResponse, CancelBroadcastResponseSuccess, CancelEmailResponse, CancelEmailResponseSuccess, ClaimDomainOptions, ClaimDomainRequestOptions, ClaimDomainResponse, ClaimDomainResponseSuccess, ConditionRule, ConditionStepConfig, Contact, ContactCreatedEvent, ContactDeleteStepConfig, ContactDeletedEvent, ContactImport, ContactImportColumnMap, ContactImportCounts, ContactImportOnConflict, ContactImportPropertyMapping, ContactImportPropertyType, ContactImportSegment, ContactImportStatus, ContactImportTopic, ContactProperty, ContactSegmentsBaseOptions, ContactTopic, ContactUpdateStepConfig, ContactUpdatedEvent, CreateApiKeyOptions, CreateApiKeyRequestOptions, CreateApiKeyResponse, CreateApiKeyResponseSuccess, CreateAutomationOptions, CreateAutomationResponse, CreateAutomationResponseSuccess, CreateBatchEmailOptions, CreateBatchOptions, CreateBatchRequestOptions, CreateBatchResponse, CreateBatchSuccessResponse, CreateBroadcastOptions, CreateBroadcastRequestOptions, CreateBroadcastResponse, CreateBroadcastResponseSuccess, CreateContactImportOptions, CreateContactImportRequestOptions, CreateContactImportResponse, CreateContactImportResponseSuccess, CreateContactOptions, CreateContactPropertyApiOptions, CreateContactPropertyOptions, CreateContactPropertyResponse, CreateContactPropertyResponseSuccess, CreateContactRequestOptions, CreateContactResponse, CreateContactResponseSuccess, CreateDomainOptions, CreateDomainRequestOptions, CreateDomainResponse, CreateDomainResponseSuccess, CreateEmailOptions, CreateEmailRequestOptions, CreateEmailResponse, CreateEmailResponseSuccess, CreateEventOptions, CreateEventResponse, CreateEventResponseSuccess, CreateSegmentOptions, CreateSegmentRequestOptions, CreateSegmentResponse, CreateSegmentResponseSuccess, CreateTemplateOptions, CreateTemplateRequestOptions, CreateTemplateResponse, CreateTemplateResponseSuccess, CreateTopicOptions, CreateTopicResponse, CreateTopicResponseSuccess, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DelayStepConfig, DeleteOptions, Domain, DomainApiOptions, DomainCapabilities, DomainCapabilityStatus, DomainClaim, DomainClaimBlockedReason, DomainClaimRecord, DomainClaimStatus, DomainCreatedEvent, DomainDeletedEvent, DomainDkimRecord, DomainNameservers, DomainRecordStatus, DomainRecords, DomainRegion, DomainSpfRecord, DomainStatus, DomainUpdatedEvent, DuplicateAutomationResponse, DuplicateAutomationResponseSuccess, DuplicateBroadcastResponse, DuplicateBroadcastResponseSuccess, DuplicateTemplateResponse, DuplicateTemplateResponseSuccess, EmailApiAttachment, EmailApiOptions, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailMetric, EmailMetricsDataRow, EmailMetricsDimension, EmailMetricsGranularity, EmailMetricsTotals, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, type ErrorResponse, Event, EventSchemaMap, EventSchemaType, ForwardReceivingEmailOptions, ForwardReceivingEmailRequestOptions, ForwardReceivingEmailResponse, ForwardReceivingEmailResponseSuccess, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetAutomationResponse, GetAutomationResponseSuccess, GetAutomationRunOptions, GetAutomationRunResponse, GetAutomationRunResponseSuccess, GetBroadcastResponse, GetBroadcastResponseSuccess, GetContactImportResponse, GetContactImportResponseSuccess, GetContactOptions, GetContactPropertyResponse, GetContactPropertyResponseSuccess, GetContactResponse, GetContactResponseSuccess, GetDomainClaimResponse, GetDomainClaimResponseSuccess, GetDomainResponse, GetDomainResponseSuccess, GetEmailResponse, GetEmailResponseSuccess, GetEmailsMetricsOptions, GetEmailsMetricsResponse, GetEmailsMetricsResponseSuccess, GetEventResponse, GetEventResponseSuccess, GetLogResponse, GetLogResponseSuccess, GetOptions, GetReceivingEmailOptions, GetReceivingEmailResponse, GetReceivingEmailResponseSuccess, GetSegmentResponse, GetSegmentResponseSuccess, GetSuppressionResponse, GetSuppressionResponseSuccess, GetTemplateResponse, GetTemplateResponseSuccess, GetTopicOptions, GetTopicResponse, GetTopicResponseSuccess, GetWebhookEventOptions, GetWebhookEventResponse, GetWebhookEventResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, IdempotentRequest, InboundAttachment, LegacyCreateContactOptions, ListApiKeysOptions, ListApiKeysResponse, ListApiKeysResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListAutomationRunsOptions, ListAutomationRunsResponse, ListAutomationRunsResponseSuccess, ListAutomationsOptions, ListAutomationsResponse, ListAutomationsResponseSuccess, ListBroadcastClickedLinksOptions, ListBroadcastClickedLinksResponse, ListBroadcastClickedLinksResponseSuccess, ListBroadcastRecipientsOptions, ListBroadcastRecipientsResponse, ListBroadcastRecipientsResponseSuccess, ListBroadcastsOptions, ListBroadcastsResponse, ListBroadcastsResponseSuccess, ListContactImportsOptions, ListContactImportsResponse, ListContactImportsResponseSuccess, ListContactPropertiesOptions, ListContactPropertiesResponse, ListContactPropertiesResponseSuccess, ListContactSegmentsOptions, ListContactSegmentsResponse, ListContactSegmentsResponseSuccess, ListContactTopicsOptions, ListContactTopicsRequestOptions, ListContactTopicsResponse, ListContactTopicsResponseSuccess, ListContactsOptions, ListContactsResponse, ListContactsResponseSuccess, ListDomainsOptions, ListDomainsResponse, ListDomainsResponseSuccess, ListEmail, ListEmailsOptions, ListEmailsResponse, ListEmailsResponseSuccess, ListEventsOptions, ListEventsResponse, ListEventsResponseSuccess, ListLogsOptions, ListLogsResponse, ListLogsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListReceivingEmail, ListReceivingEmailsOptions, ListReceivingEmailsResponse, ListReceivingEmailsResponseSuccess, ListSegmentsOptions, ListSegmentsResponse, ListSegmentsResponseSuccess, ListSuppressionsOptions, ListSuppressionsResponse, ListSuppressionsResponseSuccess, ListTemplatesOptions, ListTemplatesResponse, ListTemplatesResponseSuccess, ListTopicsResponse, ListTopicsResponseSuccess, ListWebhookEventAttemptsOptions, ListWebhookEventAttemptsResponse, ListWebhookEventAttemptsResponseSuccess, ListWebhookEventsOptions, ListWebhookEventsResponse, ListWebhookEventsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, Log, OAuthGrant, PaginatedData, PaginationOptions, PatchOptions, PostOptions, PublishTemplateResponse, PublishTemplateResponseSuccess, PutOptions, ReceivingRecord, RemoveApiKeyResponse, RemoveApiKeyResponseSuccess, RemoveAutomationResponse, RemoveAutomationResponseSuccess, RemoveBroadcastResponse, RemoveBroadcastResponseSuccess, RemoveContactOptions, RemoveContactPropertyResponse, RemoveContactPropertyResponseSuccess, RemoveContactSegmentOptions, RemoveContactSegmentResponse, RemoveContactSegmentResponseSuccess, RemoveContactsResponse, RemoveContactsResponseSuccess, RemoveDomainsResponse, RemoveDomainsResponseSuccess, RemoveEventResponse, RemoveEventResponseSuccess, RemoveSegmentResponse, RemoveSegmentResponseSuccess, RemoveSuppressionResponse, RemoveSuppressionResponseSuccess, RemoveTemplateResponse, RemoveTemplateResponseSuccess, RemoveTopicResponse, RemoveTopicResponseSuccess, RemoveWebhookResponse, RemoveWebhookResponseSuccess, ReplayWebhookEventOptions, ReplayWebhookEventResponse, ReplayWebhookEventResponseSuccess, RequireAtLeastOne, Resend, type ResendOptions, type Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, RotateWebhookSigningSecretResponse, RotateWebhookSigningSecretResponseSuccess, Segment, SelectingField, SendBroadcastOptions, SendBroadcastRequestOptions, SendBroadcastResponse, SendBroadcastResponseSuccess, SendEmailStepConfig, SendEventOptions, SendEventResponse, SendEventResponseSuccess, ShareEmailOptions, ShareEmailResponse, ShareEmailResponseSuccess, StopAutomationResponse, StopAutomationResponseSuccess, Suppression, SuppressionAddedEvent, SuppressionListEntry, SuppressionOrigin, SuppressionRemovedEvent, Tag, Template, TemplateVariable, TemplateVariableValue, Topic, TrackingCaaRecord, TrackingRecord, TriggerStepConfig, UpdateApiKeyOptions, UpdateApiKeyResponse, UpdateApiKeyResponseSuccess, UpdateAutomationOptions, UpdateAutomationResponse, UpdateAutomationResponseSuccess, UpdateBroadcastOptions, UpdateBroadcastResponse, UpdateBroadcastResponseSuccess, UpdateContactOptions, UpdateContactPropertyApiOptions, UpdateContactPropertyOptions, UpdateContactPropertyResponse, UpdateContactPropertyResponseSuccess, UpdateContactResponse, UpdateContactResponseSuccess, UpdateContactTopicsOptions, UpdateContactTopicsRequestOptions, UpdateContactTopicsResponse, UpdateContactTopicsResponseSuccess, UpdateDomainsOptions, UpdateDomainsResponse, UpdateDomainsResponseSuccess, UpdateEmailOptions, UpdateEmailResponse, UpdateEmailResponseSuccess, UpdateEventOptions, UpdateEventResponse, UpdateEventResponseSuccess, UpdateSegmentOptions, UpdateSegmentResponse, UpdateSegmentResponseSuccess, UpdateTemplateOptions, UpdateTemplateResponse, UpdateTemplateResponseSuccess, UpdateTopicOptions, UpdateTopicResponse, UpdateTopicResponseSuccess, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, VerifyDomainClaimResponse, VerifyDomainClaimResponseSuccess, VerifyDomainsResponse, VerifyDomainsResponseSuccess, WaitForEventStepConfig, Webhook, WebhookEvent, WebhookEventAttempt, WebhookEventLog, WebhookEventLogStatus, WebhookEventPayload };
|
|
2757
|
+
export type { ContactCreatedEvent, ContactDeletedEvent, ContactUpdatedEvent, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, ErrorResponse, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetWebhookEventOptions, GetWebhookEventResponse, GetWebhookEventResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListWebhookEventAttemptsOptions, ListWebhookEventAttemptsResponse, ListWebhookEventAttemptsResponseSuccess, ListWebhookEventsOptions, ListWebhookEventsResponse, ListWebhookEventsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, OAuthGrant, RemoveWebhookResponse, RemoveWebhookResponseSuccess, ReplayWebhookEventOptions, ReplayWebhookEventResponse, ReplayWebhookEventResponseSuccess, ResendOptions, Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, RotateWebhookSigningSecretResponse, RotateWebhookSigningSecretResponseSuccess, SuppressionAddedEvent, SuppressionRemovedEvent, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, Webhook, WebhookEvent, WebhookEventAttempt, WebhookEventLog, WebhookEventLogStatus, WebhookEventPayload };
|