@openemail/sdk 0.0.4 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +54 -3
- package/index.cjs +262 -26
- package/index.d.cts +217 -9
- package/index.d.ts +217 -9
- package/index.js +255 -27
- package/package.json +2 -2
package/index.d.cts
CHANGED
|
@@ -50,6 +50,11 @@ declare const AUDIENCE_MEMBER_SORTS: {
|
|
|
50
50
|
readonly ADDED_OLDEST: "added-oldest";
|
|
51
51
|
readonly NAME: "name";
|
|
52
52
|
};
|
|
53
|
+
interface AudienceMemberStatuses {
|
|
54
|
+
SUBSCRIBED: 'subscribed';
|
|
55
|
+
UNSUBSCRIBED: 'unsubscribed';
|
|
56
|
+
}
|
|
57
|
+
declare const AUDIENCE_MEMBER_STATUSES: AudienceMemberStatuses;
|
|
53
58
|
|
|
54
59
|
type AudienceBuiltin = (typeof AUDIENCE_BUILTINS)[keyof typeof AUDIENCE_BUILTINS];
|
|
55
60
|
|
|
@@ -59,6 +64,8 @@ type AudienceContactAdd = {
|
|
|
59
64
|
|
|
60
65
|
type AudienceMemberSort = (typeof AUDIENCE_MEMBER_SORTS)[keyof typeof AUDIENCE_MEMBER_SORTS];
|
|
61
66
|
|
|
67
|
+
type AudienceMemberStatus = AudienceMemberStatuses[keyof AudienceMemberStatuses];
|
|
68
|
+
|
|
62
69
|
declare const CONTACT_SOURCES: {
|
|
63
70
|
readonly MANUAL: "manual";
|
|
64
71
|
readonly AUTO: "auto";
|
|
@@ -101,6 +108,7 @@ type AudienceContactListOptions = ListOptions & {
|
|
|
101
108
|
q?: string;
|
|
102
109
|
source?: ContactSource;
|
|
103
110
|
sort?: AudienceMemberSort;
|
|
111
|
+
statuses?: Array<AudienceMemberStatus>;
|
|
104
112
|
};
|
|
105
113
|
|
|
106
114
|
type ContactResource = {
|
|
@@ -363,6 +371,11 @@ declare const API_KEY_MODES: {
|
|
|
363
371
|
readonly LIVE: "live";
|
|
364
372
|
readonly TEST: "test";
|
|
365
373
|
};
|
|
374
|
+
interface CredentialKinds {
|
|
375
|
+
API_KEY: 'apiKey';
|
|
376
|
+
OAUTH: 'oauth';
|
|
377
|
+
}
|
|
378
|
+
declare const CREDENTIAL_KINDS: CredentialKinds;
|
|
366
379
|
|
|
367
380
|
type ApiKeyMode = (typeof API_KEY_MODES)[keyof typeof API_KEY_MODES];
|
|
368
381
|
|
|
@@ -648,6 +661,8 @@ type BuiltinRole = (typeof BUILTIN_ROLES)[keyof typeof BUILTIN_ROLES];
|
|
|
648
661
|
|
|
649
662
|
type ConsolePermission = (typeof CONSOLE_PERMISSIONS)[keyof typeof CONSOLE_PERMISSIONS];
|
|
650
663
|
|
|
664
|
+
type CredentialKind = CredentialKinds[keyof CredentialKinds];
|
|
665
|
+
|
|
651
666
|
type HitKind = (typeof HIT_KINDS)[keyof typeof HIT_KINDS];
|
|
652
667
|
|
|
653
668
|
type LogWindow = {
|
|
@@ -867,6 +882,8 @@ type PersonListOptions = ListOptions & {
|
|
|
867
882
|
blocked?: boolean;
|
|
868
883
|
};
|
|
869
884
|
|
|
885
|
+
type AccessTokenProvider = () => string | Promise<string>;
|
|
886
|
+
|
|
870
887
|
type ApiErrorPayload = {
|
|
871
888
|
type?: string;
|
|
872
889
|
code?: string;
|
|
@@ -904,6 +921,7 @@ type FetchLike = (input: string | URL | Request, init?: RequestInit) => Promise<
|
|
|
904
921
|
|
|
905
922
|
type TransportOptions = {
|
|
906
923
|
apiKey?: string;
|
|
924
|
+
accessToken?: string | AccessTokenProvider;
|
|
907
925
|
baseUrl?: string;
|
|
908
926
|
fetch?: FetchLike;
|
|
909
927
|
maxRetries?: number;
|
|
@@ -995,7 +1013,17 @@ declare const Domains: (transport: Transport) => {
|
|
|
995
1013
|
listAll: (options?: ListOptions) => Promise<Array<DomainResource>>;
|
|
996
1014
|
iterate: (options?: ListOptions) => AsyncGenerator<DomainResource, void, undefined>;
|
|
997
1015
|
get: (id: string, options?: RequestScope) => Promise<DomainDetailResource>;
|
|
1016
|
+
create: (body: DomainCreate, options?: RequestScope) => Promise<DomainDetailResource>;
|
|
1017
|
+
verify: (id: string, options?: RequestScope) => Promise<DomainDetailResource>;
|
|
998
1018
|
update: (id: string, patch: DomainPatch, options?: RequestScope) => Promise<DomainDetailResource>;
|
|
1019
|
+
delete: (id: string, options?: RequestScope) => Promise<DeletedDomainResource>;
|
|
1020
|
+
listAddresses: (id: string, options?: ListOptions) => Promise<Page<DomainAddressResource>>;
|
|
1021
|
+
listAllAddresses: (id: string, options?: ListOptions) => Promise<Array<DomainAddressResource>>;
|
|
1022
|
+
iterateAddresses: (id: string, options?: ListOptions) => AsyncGenerator<DomainAddressResource, void, undefined>;
|
|
1023
|
+
createAddress: (id: string, body: DomainAddressCreate, options?: RequestScope) => Promise<DomainAddressResource>;
|
|
1024
|
+
getAddress: (id: string, addressId: string, options?: RequestScope) => Promise<DomainAddressResource>;
|
|
1025
|
+
updateAddress: (id: string, addressId: string, patch: DomainAddressPatch, options?: RequestScope) => Promise<DomainAddressResource>;
|
|
1026
|
+
deleteAddress: (id: string, addressId: string, options?: RequestScope) => Promise<DeletedDomainAddressResource>;
|
|
999
1027
|
};
|
|
1000
1028
|
|
|
1001
1029
|
declare const Drafts: (transport: Transport) => {
|
|
@@ -1154,6 +1182,12 @@ declare const Rules: (transport: Transport) => {
|
|
|
1154
1182
|
iterateRuns: (options?: RuleRunListOptions) => AsyncGenerator<RuleRunResource, void, undefined>;
|
|
1155
1183
|
};
|
|
1156
1184
|
|
|
1185
|
+
declare const Security: (transport: Transport) => {
|
|
1186
|
+
stepUpStatus: (options?: RequestScope) => Promise<StepUpStatusResource>;
|
|
1187
|
+
beginStepUp: (body?: StepUpBegin, options?: RequestScope) => Promise<StepUpChallengeResource>;
|
|
1188
|
+
verifyStepUp: (body: StepUpVerify, options?: RequestScope) => Promise<StepUpVerifiedResource>;
|
|
1189
|
+
};
|
|
1190
|
+
|
|
1157
1191
|
declare const Settings: (transport: Transport) => {
|
|
1158
1192
|
get: (options?: SettingsOptions) => Promise<SettingsResource>;
|
|
1159
1193
|
update: (patch: SettingsPatch, options?: SettingsOptions) => Promise<SettingsResource>;
|
|
@@ -1265,6 +1299,7 @@ declare class OpenEmail {
|
|
|
1265
1299
|
private readonly transport;
|
|
1266
1300
|
readonly mode: ApiKeyMode;
|
|
1267
1301
|
readonly me: ReturnType<typeof Me>;
|
|
1302
|
+
readonly security: ReturnType<typeof Security>;
|
|
1268
1303
|
readonly keys: ReturnType<typeof Keys>;
|
|
1269
1304
|
readonly addresses: ReturnType<typeof Addresses>;
|
|
1270
1305
|
readonly languages: ReturnType<typeof Languages>;
|
|
@@ -1324,10 +1359,52 @@ type SendScope = RequestScope & {
|
|
|
1324
1359
|
idempotencyKey?: string;
|
|
1325
1360
|
};
|
|
1326
1361
|
|
|
1327
|
-
type TempMailOptions = Omit<TransportOptions, 'apiKey'> & {
|
|
1362
|
+
type TempMailOptions = Omit<TransportOptions, 'apiKey' | 'accessToken'> & {
|
|
1328
1363
|
inboxToken?: string;
|
|
1329
1364
|
};
|
|
1330
1365
|
|
|
1366
|
+
type DeletedDomainAddressResource = {
|
|
1367
|
+
object: 'address';
|
|
1368
|
+
id: string;
|
|
1369
|
+
address: string;
|
|
1370
|
+
deleted: true;
|
|
1371
|
+
};
|
|
1372
|
+
|
|
1373
|
+
type DeletedDomainResource = {
|
|
1374
|
+
object: 'domain';
|
|
1375
|
+
id: string;
|
|
1376
|
+
domain: string;
|
|
1377
|
+
deleted: true;
|
|
1378
|
+
leftBehind: Array<string>;
|
|
1379
|
+
};
|
|
1380
|
+
|
|
1381
|
+
type DomainAddressCreate = {
|
|
1382
|
+
localPart: string;
|
|
1383
|
+
label?: string | null;
|
|
1384
|
+
};
|
|
1385
|
+
|
|
1386
|
+
type DomainAddressPatch = {
|
|
1387
|
+
label?: string | null;
|
|
1388
|
+
enabled?: boolean;
|
|
1389
|
+
};
|
|
1390
|
+
|
|
1391
|
+
type DomainAddressResource = {
|
|
1392
|
+
object: 'address';
|
|
1393
|
+
id: string;
|
|
1394
|
+
domainId: string;
|
|
1395
|
+
address: string;
|
|
1396
|
+
localPart: string;
|
|
1397
|
+
label: string | null;
|
|
1398
|
+
enabled: boolean;
|
|
1399
|
+
lastReceivedAt: string | null;
|
|
1400
|
+
createdAt: string;
|
|
1401
|
+
updatedAt: string;
|
|
1402
|
+
};
|
|
1403
|
+
|
|
1404
|
+
type DomainCreate = {
|
|
1405
|
+
domain: string;
|
|
1406
|
+
};
|
|
1407
|
+
|
|
1331
1408
|
declare const DOMAIN_SENDING_STATES: {
|
|
1332
1409
|
readonly VERIFIED: "verified";
|
|
1333
1410
|
readonly PENDING: "pending";
|
|
@@ -1347,6 +1424,40 @@ declare const DOMAIN_STORAGE_STATES: {
|
|
|
1347
1424
|
readonly ACTIVE: "active";
|
|
1348
1425
|
readonly FAILED: "failed";
|
|
1349
1426
|
};
|
|
1427
|
+
interface DomainRecordStatuses {
|
|
1428
|
+
FOUND: 'found';
|
|
1429
|
+
MISSING: 'missing';
|
|
1430
|
+
}
|
|
1431
|
+
declare const DOMAIN_RECORD_STATUSES: DomainRecordStatuses;
|
|
1432
|
+
interface DomainDmarcStages {
|
|
1433
|
+
MISSING: 'missing';
|
|
1434
|
+
INVALID: 'invalid';
|
|
1435
|
+
MONITOR: 'monitor';
|
|
1436
|
+
QUARANTINE: 'quarantine';
|
|
1437
|
+
REJECT: 'reject';
|
|
1438
|
+
}
|
|
1439
|
+
declare const DOMAIN_DMARC_STAGES: DomainDmarcStages;
|
|
1440
|
+
|
|
1441
|
+
type DomainDmarcStage = DomainDmarcStages[keyof DomainDmarcStages];
|
|
1442
|
+
|
|
1443
|
+
type DomainDmarcResource = {
|
|
1444
|
+
stage: DomainDmarcStage;
|
|
1445
|
+
record: string | null;
|
|
1446
|
+
issues: Array<string>;
|
|
1447
|
+
alignmentPossible: boolean;
|
|
1448
|
+
caveat: string;
|
|
1449
|
+
};
|
|
1450
|
+
|
|
1451
|
+
type DomainRecordStatus = DomainRecordStatuses[keyof DomainRecordStatuses];
|
|
1452
|
+
|
|
1453
|
+
type DomainRecordResource = {
|
|
1454
|
+
type: string;
|
|
1455
|
+
name: string;
|
|
1456
|
+
value: string;
|
|
1457
|
+
priority: number | null;
|
|
1458
|
+
purpose: string | null;
|
|
1459
|
+
status: DomainRecordStatus | null;
|
|
1460
|
+
};
|
|
1350
1461
|
|
|
1351
1462
|
type DomainSendingState = (typeof DOMAIN_SENDING_STATES)[keyof typeof DOMAIN_SENDING_STATES];
|
|
1352
1463
|
|
|
@@ -1412,9 +1523,12 @@ type DomainDetailResource = DomainResource & {
|
|
|
1412
1523
|
address: string;
|
|
1413
1524
|
enabled: boolean;
|
|
1414
1525
|
}>;
|
|
1526
|
+
records: Array<DomainRecordResource>;
|
|
1527
|
+
dmarc: DomainDmarcResource | null;
|
|
1415
1528
|
};
|
|
1416
1529
|
|
|
1417
1530
|
type DomainPatch = {
|
|
1531
|
+
catchAll?: boolean;
|
|
1418
1532
|
trackingHost?: string | null;
|
|
1419
1533
|
storageHost?: string | null;
|
|
1420
1534
|
};
|
|
@@ -1702,6 +1816,12 @@ interface FileUsages {
|
|
|
1702
1816
|
}
|
|
1703
1817
|
type FileUsage = FileUsages[keyof FileUsages];
|
|
1704
1818
|
declare const FILE_USAGES: FileUsages;
|
|
1819
|
+
interface FileVisibilities {
|
|
1820
|
+
PUBLIC: 'public';
|
|
1821
|
+
PRIVATE: 'private';
|
|
1822
|
+
}
|
|
1823
|
+
type FileVisibility = FileVisibilities[keyof FileVisibilities];
|
|
1824
|
+
declare const FILE_VISIBILITIES: FileVisibilities;
|
|
1705
1825
|
|
|
1706
1826
|
type FileKept = {
|
|
1707
1827
|
id: string;
|
|
@@ -1782,6 +1902,8 @@ type FileResource = {
|
|
|
1782
1902
|
deliveredTo: string | null;
|
|
1783
1903
|
usage: FileUsage | null;
|
|
1784
1904
|
deletable: boolean;
|
|
1905
|
+
visibility: FileVisibility;
|
|
1906
|
+
publicUrl: string | null;
|
|
1785
1907
|
createdAt: string;
|
|
1786
1908
|
};
|
|
1787
1909
|
|
|
@@ -2222,8 +2344,20 @@ type LabelResource = {
|
|
|
2222
2344
|
updatedAt: string | null;
|
|
2223
2345
|
};
|
|
2224
2346
|
|
|
2225
|
-
type
|
|
2347
|
+
type ApiKeyPingResource = {
|
|
2348
|
+
ok: true;
|
|
2349
|
+
kind: CredentialKinds['API_KEY'];
|
|
2350
|
+
keyId: string;
|
|
2351
|
+
mode: ApiKeyMode;
|
|
2352
|
+
scopes: Array<ApiScope>;
|
|
2353
|
+
roleId: string | null;
|
|
2354
|
+
grantedScopes: Array<ApiScope>;
|
|
2355
|
+
workspaceId: string;
|
|
2356
|
+
};
|
|
2357
|
+
|
|
2358
|
+
type ApiKeySelfResource = {
|
|
2226
2359
|
object: 'api_key';
|
|
2360
|
+
kind: CredentialKinds['API_KEY'];
|
|
2227
2361
|
id: string;
|
|
2228
2362
|
mode: ApiKeyMode;
|
|
2229
2363
|
scopes: Array<ApiScope>;
|
|
@@ -2234,17 +2368,38 @@ type KeyResource = {
|
|
|
2234
2368
|
domainAllowlist: Array<string> | null;
|
|
2235
2369
|
};
|
|
2236
2370
|
|
|
2237
|
-
type
|
|
2371
|
+
type OauthTokenSelfResource = {
|
|
2372
|
+
object: 'oauth_token';
|
|
2373
|
+
kind: CredentialKinds['OAUTH'];
|
|
2374
|
+
id: null;
|
|
2375
|
+
clientId: string;
|
|
2376
|
+
mode: (typeof API_KEY_MODES)['LIVE'];
|
|
2377
|
+
scopes: Array<ApiScope>;
|
|
2378
|
+
roleId: null;
|
|
2379
|
+
grantedScopes: Array<ApiScope>;
|
|
2380
|
+
workspaceId: string;
|
|
2381
|
+
addressAllowlist: Array<string> | null;
|
|
2382
|
+
domainAllowlist: Array<string> | null;
|
|
2383
|
+
expiresAt: string | null;
|
|
2384
|
+
};
|
|
2385
|
+
|
|
2386
|
+
type KeyResource = ApiKeySelfResource | OauthTokenSelfResource;
|
|
2387
|
+
|
|
2388
|
+
type OauthTokenPingResource = {
|
|
2238
2389
|
ok: true;
|
|
2239
|
-
|
|
2240
|
-
|
|
2390
|
+
kind: CredentialKinds['OAUTH'];
|
|
2391
|
+
keyId: null;
|
|
2392
|
+
clientId: string;
|
|
2393
|
+
mode: (typeof API_KEY_MODES)['LIVE'];
|
|
2241
2394
|
scopes: Array<ApiScope>;
|
|
2242
|
-
roleId:
|
|
2395
|
+
roleId: null;
|
|
2243
2396
|
grantedScopes: Array<ApiScope>;
|
|
2244
2397
|
workspaceId: string;
|
|
2245
2398
|
};
|
|
2246
2399
|
|
|
2247
|
-
type
|
|
2400
|
+
type PingResource = ApiKeyPingResource | OauthTokenPingResource;
|
|
2401
|
+
|
|
2402
|
+
type RotatedKeyResource = Omit<ApiKeySelfResource, 'kind'> & {
|
|
2248
2403
|
token: string;
|
|
2249
2404
|
rotationCount: number;
|
|
2250
2405
|
rotatedAt: string;
|
|
@@ -2562,6 +2717,55 @@ type RuleTestResource = {
|
|
|
2562
2717
|
}>;
|
|
2563
2718
|
};
|
|
2564
2719
|
|
|
2720
|
+
type StepUpBegin = {
|
|
2721
|
+
resend?: boolean;
|
|
2722
|
+
};
|
|
2723
|
+
|
|
2724
|
+
interface StepUpMethods {
|
|
2725
|
+
EMAIL: 'email';
|
|
2726
|
+
TOTP: 'totp';
|
|
2727
|
+
}
|
|
2728
|
+
declare const STEP_UP_METHODS: StepUpMethods;
|
|
2729
|
+
interface StepUpErrorCodes {
|
|
2730
|
+
STEP_UP_REQUIRED: 'step_up_required';
|
|
2731
|
+
STEP_UP_NOT_APPLICABLE: 'step_up_not_applicable';
|
|
2732
|
+
STEP_UP_THROTTLED: 'step_up_throttled';
|
|
2733
|
+
STEP_UP_UNDELIVERABLE: 'step_up_undeliverable';
|
|
2734
|
+
STEP_UP_CODE_INVALID: 'step_up_code_invalid';
|
|
2735
|
+
STEP_UP_CODE_EXPIRED: 'step_up_code_expired';
|
|
2736
|
+
STEP_UP_LOCKED: 'step_up_locked';
|
|
2737
|
+
}
|
|
2738
|
+
declare const STEP_UP_ERROR_CODES: StepUpErrorCodes;
|
|
2739
|
+
|
|
2740
|
+
type StepUpMethod = StepUpMethods[keyof StepUpMethods];
|
|
2741
|
+
|
|
2742
|
+
type StepUpChallengeResource = {
|
|
2743
|
+
object: 'step_up_challenge';
|
|
2744
|
+
method: StepUpMethod;
|
|
2745
|
+
sentTo?: string;
|
|
2746
|
+
reused: boolean;
|
|
2747
|
+
};
|
|
2748
|
+
|
|
2749
|
+
type StepUpErrorCode = StepUpErrorCodes[keyof StepUpErrorCodes];
|
|
2750
|
+
|
|
2751
|
+
type StepUpStatusResource = {
|
|
2752
|
+
object: 'step_up';
|
|
2753
|
+
elevated: boolean;
|
|
2754
|
+
elevatedUntil: string | null;
|
|
2755
|
+
method: StepUpMethod;
|
|
2756
|
+
minutes: number;
|
|
2757
|
+
};
|
|
2758
|
+
|
|
2759
|
+
type StepUpVerifiedResource = {
|
|
2760
|
+
object: 'step_up';
|
|
2761
|
+
elevated: true;
|
|
2762
|
+
elevatedUntil: string;
|
|
2763
|
+
};
|
|
2764
|
+
|
|
2765
|
+
type StepUpVerify = {
|
|
2766
|
+
code: string;
|
|
2767
|
+
};
|
|
2768
|
+
|
|
2565
2769
|
type SettingsOptions = RequestScope & {
|
|
2566
2770
|
address?: string;
|
|
2567
2771
|
};
|
|
@@ -3151,6 +3355,7 @@ type ThreadResource = {
|
|
|
3151
3355
|
messageCount: number;
|
|
3152
3356
|
hasUnread: boolean;
|
|
3153
3357
|
totalReplies: number;
|
|
3358
|
+
deliveredTo: string | null;
|
|
3154
3359
|
};
|
|
3155
3360
|
|
|
3156
3361
|
type ThreadSummaryResource = {
|
|
@@ -3528,6 +3733,7 @@ declare class Transport {
|
|
|
3528
3733
|
inboxToken?: string;
|
|
3529
3734
|
});
|
|
3530
3735
|
request<T>(path: string, options?: RequestOptions): Promise<T>;
|
|
3736
|
+
private resolveAccessToken;
|
|
3531
3737
|
private headersFor;
|
|
3532
3738
|
private attempt;
|
|
3533
3739
|
private parse;
|
|
@@ -3545,6 +3751,7 @@ declare class OpenEmailApiError extends Error {
|
|
|
3545
3751
|
get isAuth(): boolean;
|
|
3546
3752
|
get isPermission(): boolean;
|
|
3547
3753
|
get isScopeMissing(): boolean;
|
|
3754
|
+
get isStepUpRequired(): boolean;
|
|
3548
3755
|
get isInvalidRequest(): boolean;
|
|
3549
3756
|
get isValidation(): boolean;
|
|
3550
3757
|
get isNotFound(): boolean;
|
|
@@ -3595,10 +3802,11 @@ declare const createTempMail: (options?: TempMailOptions) => ReturnType<(transpo
|
|
|
3595
3802
|
declare const verifyWebhookSignature: <T = Record<string, unknown>>(props: VerifyWebhookProps) => Promise<WebhookPayload<T>>;
|
|
3596
3803
|
declare const toBase64: (bytes: Uint8Array | ArrayBuffer) => string;
|
|
3597
3804
|
declare const isApiKey: (value: unknown) => value is string;
|
|
3805
|
+
declare const isAccessToken: (value: unknown) => value is string;
|
|
3598
3806
|
declare const isSealed: (message: Pick<MessageResource, "encryption">) => boolean;
|
|
3599
3807
|
declare const resolveLanguage: (input: string | null | undefined) => LanguageResource | undefined;
|
|
3600
3808
|
declare const languageByCode: (code: string | null | undefined) => LanguageResource | undefined;
|
|
3601
3809
|
declare const isRtlLanguage: (code: string | null | undefined) => boolean;
|
|
3602
3810
|
|
|
3603
|
-
export { API_SCOPES, BROADCAST_RECIPIENT_FILTERS, BROADCAST_STATUSES, CONTACT_BLOCK_LISTS, CONTACT_PHOTO_TYPES, CONTACT_THREAD_SORTS, ERROR_TYPES, FILE_DIRECTIONS, FILE_KINDS, FILE_SORTS, FILE_USAGES, LANGUAGES, MESSAGE_ENCRYPTION_FORMATS, OpenEmail, OpenEmailApiError, OpenEmailNetworkError, PAGE_LIMITS, PEOPLE_SORTS, PROVIDER_IMPORT_DOMAIN_STATES, PROVIDER_IMPORT_RESOURCES, PROVIDER_IMPORT_STATUSES, RULE_ACTIONS, RULE_FIELDS, RULE_OPERATORS, SUPPRESSION_REASONS, THREAD_SORTS, VERSION, WEBHOOK_EVENTS, WEBHOOK_REPLAY_ERROR_CODES, WEBHOOK_SIGNATURE_HEADERS, createClient, createOpenEmail, createTempMail, OpenEmail as default, getClient, init, isApiKey, isRtlLanguage, isSealed, languageByCode, openemail, resetClient, resolveLanguage, toBase64, verifyWebhookSignature };
|
|
3604
|
-
export type { AddressBookPage, AddressBookResource, AddressResource, ApiErrorPayload, ApiErrorProps, ApiKeyActivityListOptions, ApiKeyActivityResource, ApiKeyCreate, ApiKeyEventType, ApiKeyMode, ApiKeyPatch, ApiKeyRequestListOptions, ApiKeyRequestResource, ApiKeyResource, ApiKeyRevoke, ApiKeyStatus, ApiKeyWorkspaceActivityListOptions, ApiKeyWorkspaceRequestListOptions, ApiScope, AttachmentDeliveryMode, AttachmentInput, AttachmentResource, AudienceBatchAddResource, AudienceBatchRemoveResource, AudienceBuiltin, AudienceContactAdd, AudienceContactListOptions, AudienceContactResource, AudienceContactsBatch, AudienceCreate, AudienceGrowthBucket, AudienceGrowthOptions, AudienceGrowthResource, AudienceGrowthSeries, AudienceGrowthTotals, AudienceImport, AudienceImportResource, AudienceImportRow, AudienceListOptions, AudienceMemberResource, AudienceMemberSort, AudiencePatch, AudienceResource, AuditActorKind, AuditActorResource, BatchItemResource, BatchResultResource, BroadcastCounts, BroadcastCreate, BroadcastListOptions, BroadcastPreviewInput, BroadcastPreviewResource, BroadcastRecipientContentResource, BroadcastRecipientFilter, BroadcastRecipientListOptions, BroadcastRecipientResource, BroadcastResource, BroadcastStatsBucket, BroadcastStatsOptions, BroadcastStatsResource, BroadcastStatsTotals, BroadcastStatus, BuiltinRole, CalendarAttendeeResource, CalendarEventResource, CalendarOccurrenceResource, CalendarRangeOptions, ClientOptions, ConsolePermission, ContactActivityBucket, ContactActivityOptions, ContactActivityResource, ContactActivityTotals, ContactAudienceResource, ContactAudiencesSet, ContactBatchDeleteResource, ContactBlockList, ContactBlockResource, ContactBlockRule, ContactCreate, ContactDetailResource, ContactListOptions, ContactPatch, ContactPhotoOptions, ContactPhotoType, ContactReplyTime, ContactResource, ContactSave, ContactSource, ContactThreadListOptions, ContactThreadResource, ContactThreadSort, CreatedApiKeyResource, CreatedTempInboxResource, CreatedWebhookResource, DeletedApiKeyResource, DeletedAudienceResource, DeletedContactResource, DeletedDraftResource, DeletedFileResource, DeletedLabelResource, DeletedRoleResource, DeletedRuleResource, DeletedTempInboxResource, DeletedTempMessageResource, DeletedTemplateResource, DeletedTemplateVersionResource, DeletedWebhookResource, DomainDetailResource, DomainPatch, DomainResource, DomainSendingState, DomainStorage, DomainStorageState, DomainTracking, DomainTrackingState, DraftInput, DraftListOptions, DraftResource, DraftSummaryResource, EmailClickedData, EmailDownloadedData, EmailEventResource, EmailListOptions, EmailOpenedData, EmailRecipientResource, EmailResource, EmailSend, EmailSource, EmailStatus, EmailTrackingSummary, EmailTranslate, EmailTranslationResource, EmailTransport, EmptiedAudienceResource, ErrorType, FetchLike, FileAddressCount, FileBatchDeleteResource, FileCount, FileDayCount, FileDirection, FileEventData, FileKept, FileKind, FileLinkCount, FileLinkCreateOptions, FileLinkResource, FileListOptions, FileResource, FileSort, FileStatsResource, FileTypeCount, FileUploadOptions, FileUsage, HitKind, ImportChunkResource, ImportCounts, ImportCreate, ImportFailurePage, ImportFailureReason, ImportFailureResource, ImportFailuresOptions, ImportFileDescriptor, ImportFileInfo, ImportFilesInput, ImportFormat, ImportListOptions, ImportOptions, ImportProgress, ImportResource, ImportSource, ImportStatus, ImportUploadResource, InboxScope, InlineAttachmentInput, InvitationResource, KeyResource, LabelColor, LabelColorInput, LabelColorKind, LabelColorResource, LabelInput, LabelPatch, LabelResource, LanguageResource, ListOptions, LogWindow, MemberAccess, MemberAdd, MemberAddressGrant, MemberAddressResource, MemberDomainResource, MemberPatch, MemberResource, MessageEncryption, MessageEncryptionFormat, MessageEncryptionPartRole, MessageResource, Page, PeoplePage, PeopleSort, Permission, PermissionResource, PersonListOptions, PersonResource, PingResource, ProviderImportCount, ProviderImportCreate, ProviderImportDomainState, ProviderImportListOptions, ProviderImportReport, ProviderImportResource, ProviderImportResourceKind, ProviderImportStatus, ProviderInventoryResource, RawBody, RecipientInput, RecipientKind, RecipientStatus, RemovedAudienceContactResource, RemovedMemberResource, RemovedSuppressionResource, RequestOptions, RequestScope, RevokedInvitationResource, RoleCreate, RoleDeleteOptions, RolePatch, RoleResource, RotatedApiKeyResource, RotatedKeyResource, RuleAction, RuleActionType, RuleCondition, RuleConditionInput, RuleCreate, RuleField, RuleListOptions, RuleMatchMode, RuleOperator, RulePatch, RuleResource, RuleRunListOptions, RuleRunResource, RuleTestInput, RuleTestResource, RuleTestWarningCode, SavedDraftResource, SendScope, SendTranslateOptions, SendableDomainResource, SentBroadcastResource, SentEmailResource, SentTemplateEmailResource, SettingsOptions, SettingsPatch, SettingsResource, SnoozedThreadResource, StoredAttachmentInput, SuppressionAdd, SuppressionListOptions, SuppressionReason, SuppressionResource, TempDomainResource, TempInboxCreate, TempInboxResource, TempMailOptions, TempMessageDetailResource, TempMessageListOptions, TempMessageResource, TempMessagesResource, TemplateAnalyticsOptions, TemplateAnalyticsResource, TemplateBlock, TemplateBlockKind, TemplateCategory, TemplateContent, TemplateContentSource, TemplateCreate, TemplateDetailResource, TemplateDocument, TemplateDuplicate, TemplateEngine, TemplateFont, TemplateFontFormat, TemplateFontResource, TemplateFontStyle, TemplateListOptions, TemplatePatch, TemplatePreviewInput, TemplatePreviewResource, TemplatePreviewWarningCode, TemplateProp, TemplateRenderInput, TemplateRenderResource, TemplateResource, TemplateRestoreInput, TemplateRestoredResource, TemplateSend, TemplateSendListOptions, TemplateSendResource, TemplateSendsResource, TemplateSlot, TemplateSort, TemplateStarterDetailResource, TemplateStarterResource, TemplateStatus, TemplateValueKind, TemplateVersionResource, TemplateVersionState, ThreadListOptions, ThreadPatch, ThreadResource, ThreadSort, ThreadSummaryResource, TrackingClickResource, TrackingGrain, TrackingHitOptions, TrackingLinkResource, TrackingListOptions, TrackingOpenResource, TrackingRecipientResource, TrackingRequest, TrackingResource, TrackingStatsOptions, TrackingStatsResource, TrackingSummary, TranslateOptions, TranslationResource, TransportOptions, TrashedThreadResource, UpdatedThreadResource, VerifyWebhookProps, WebhookActivityListOptions, WebhookActivityResource, WebhookChangeType, WebhookCreate, WebhookDeliveryAttempt, WebhookDeliveryDetailResource, WebhookDeliveryListOptions, WebhookDeliveryResource, WebhookDeliveryStatus, WebhookEvent, WebhookPatch, WebhookPayload, WebhookReplayErrorCode, WebhookReplayRefusal, WebhookReplayResource, WebhookResource, WebhookSignatureHeaders, WebhookTestResource, WebhookWorkspaceActivityListOptions, WebhookWorkspaceDeliveryListOptions };
|
|
3811
|
+
export { API_SCOPES, AUDIENCE_MEMBER_STATUSES, BROADCAST_RECIPIENT_FILTERS, BROADCAST_STATUSES, CONTACT_BLOCK_LISTS, CONTACT_PHOTO_TYPES, CONTACT_THREAD_SORTS, CREDENTIAL_KINDS, DOMAIN_DMARC_STAGES, DOMAIN_RECORD_STATUSES, ERROR_TYPES, FILE_DIRECTIONS, FILE_KINDS, FILE_SORTS, FILE_USAGES, FILE_VISIBILITIES, LANGUAGES, MESSAGE_ENCRYPTION_FORMATS, OpenEmail, OpenEmailApiError, OpenEmailNetworkError, PAGE_LIMITS, PEOPLE_SORTS, PROVIDER_IMPORT_DOMAIN_STATES, PROVIDER_IMPORT_RESOURCES, PROVIDER_IMPORT_STATUSES, RULE_ACTIONS, RULE_FIELDS, RULE_OPERATORS, STEP_UP_ERROR_CODES, STEP_UP_METHODS, SUPPRESSION_REASONS, THREAD_SORTS, VERSION, WEBHOOK_EVENTS, WEBHOOK_REPLAY_ERROR_CODES, WEBHOOK_SIGNATURE_HEADERS, createClient, createOpenEmail, createTempMail, OpenEmail as default, getClient, init, isAccessToken, isApiKey, isRtlLanguage, isSealed, languageByCode, openemail, resetClient, resolveLanguage, toBase64, verifyWebhookSignature };
|
|
3812
|
+
export type { AccessTokenProvider, AddressBookPage, AddressBookResource, AddressResource, ApiErrorPayload, ApiErrorProps, ApiKeyActivityListOptions, ApiKeyActivityResource, ApiKeyCreate, ApiKeyEventType, ApiKeyMode, ApiKeyPatch, ApiKeyPingResource, ApiKeyRequestListOptions, ApiKeyRequestResource, ApiKeyResource, ApiKeyRevoke, ApiKeySelfResource, ApiKeyStatus, ApiKeyWorkspaceActivityListOptions, ApiKeyWorkspaceRequestListOptions, ApiScope, AttachmentDeliveryMode, AttachmentInput, AttachmentResource, AudienceBatchAddResource, AudienceBatchRemoveResource, AudienceBuiltin, AudienceContactAdd, AudienceContactListOptions, AudienceContactResource, AudienceContactsBatch, AudienceCreate, AudienceGrowthBucket, AudienceGrowthOptions, AudienceGrowthResource, AudienceGrowthSeries, AudienceGrowthTotals, AudienceImport, AudienceImportResource, AudienceImportRow, AudienceListOptions, AudienceMemberResource, AudienceMemberSort, AudienceMemberStatus, AudiencePatch, AudienceResource, AuditActorKind, AuditActorResource, BatchItemResource, BatchResultResource, BroadcastCounts, BroadcastCreate, BroadcastListOptions, BroadcastPreviewInput, BroadcastPreviewResource, BroadcastRecipientContentResource, BroadcastRecipientFilter, BroadcastRecipientListOptions, BroadcastRecipientResource, BroadcastResource, BroadcastStatsBucket, BroadcastStatsOptions, BroadcastStatsResource, BroadcastStatsTotals, BroadcastStatus, BuiltinRole, CalendarAttendeeResource, CalendarEventResource, CalendarOccurrenceResource, CalendarRangeOptions, ClientOptions, ConsolePermission, ContactActivityBucket, ContactActivityOptions, ContactActivityResource, ContactActivityTotals, ContactAudienceResource, ContactAudiencesSet, ContactBatchDeleteResource, ContactBlockList, ContactBlockResource, ContactBlockRule, ContactCreate, ContactDetailResource, ContactListOptions, ContactPatch, ContactPhotoOptions, ContactPhotoType, ContactReplyTime, ContactResource, ContactSave, ContactSource, ContactThreadListOptions, ContactThreadResource, ContactThreadSort, CreatedApiKeyResource, CreatedTempInboxResource, CreatedWebhookResource, CredentialKind, DeletedApiKeyResource, DeletedAudienceResource, DeletedContactResource, DeletedDomainAddressResource, DeletedDomainResource, DeletedDraftResource, DeletedFileResource, DeletedLabelResource, DeletedRoleResource, DeletedRuleResource, DeletedTempInboxResource, DeletedTempMessageResource, DeletedTemplateResource, DeletedTemplateVersionResource, DeletedWebhookResource, DomainAddressCreate, DomainAddressPatch, DomainAddressResource, DomainCreate, DomainDetailResource, DomainDmarcResource, DomainDmarcStage, DomainPatch, DomainRecordResource, DomainRecordStatus, DomainResource, DomainSendingState, DomainStorage, DomainStorageState, DomainTracking, DomainTrackingState, DraftInput, DraftListOptions, DraftResource, DraftSummaryResource, EmailClickedData, EmailDownloadedData, EmailEventResource, EmailListOptions, EmailOpenedData, EmailRecipientResource, EmailResource, EmailSend, EmailSource, EmailStatus, EmailTrackingSummary, EmailTranslate, EmailTranslationResource, EmailTransport, EmptiedAudienceResource, ErrorType, FetchLike, FileAddressCount, FileBatchDeleteResource, FileCount, FileDayCount, FileDirection, FileEventData, FileKept, FileKind, FileLinkCount, FileLinkCreateOptions, FileLinkResource, FileListOptions, FileResource, FileSort, FileStatsResource, FileTypeCount, FileUploadOptions, FileUsage, FileVisibility, HitKind, ImportChunkResource, ImportCounts, ImportCreate, ImportFailurePage, ImportFailureReason, ImportFailureResource, ImportFailuresOptions, ImportFileDescriptor, ImportFileInfo, ImportFilesInput, ImportFormat, ImportListOptions, ImportOptions, ImportProgress, ImportResource, ImportSource, ImportStatus, ImportUploadResource, InboxScope, InlineAttachmentInput, InvitationResource, KeyResource, LabelColor, LabelColorInput, LabelColorKind, LabelColorResource, LabelInput, LabelPatch, LabelResource, LanguageResource, ListOptions, LogWindow, MemberAccess, MemberAdd, MemberAddressGrant, MemberAddressResource, MemberDomainResource, MemberPatch, MemberResource, MessageEncryption, MessageEncryptionFormat, MessageEncryptionPartRole, MessageResource, OauthTokenPingResource, OauthTokenSelfResource, Page, PeoplePage, PeopleSort, Permission, PermissionResource, PersonListOptions, PersonResource, PingResource, ProviderImportCount, ProviderImportCreate, ProviderImportDomainState, ProviderImportListOptions, ProviderImportReport, ProviderImportResource, ProviderImportResourceKind, ProviderImportStatus, ProviderInventoryResource, RawBody, RecipientInput, RecipientKind, RecipientStatus, RemovedAudienceContactResource, RemovedMemberResource, RemovedSuppressionResource, RequestOptions, RequestScope, RevokedInvitationResource, RoleCreate, RoleDeleteOptions, RolePatch, RoleResource, RotatedApiKeyResource, RotatedKeyResource, RuleAction, RuleActionType, RuleCondition, RuleConditionInput, RuleCreate, RuleField, RuleListOptions, RuleMatchMode, RuleOperator, RulePatch, RuleResource, RuleRunListOptions, RuleRunResource, RuleTestInput, RuleTestResource, RuleTestWarningCode, SavedDraftResource, SendScope, SendTranslateOptions, SendableDomainResource, SentBroadcastResource, SentEmailResource, SentTemplateEmailResource, SettingsOptions, SettingsPatch, SettingsResource, SnoozedThreadResource, StepUpBegin, StepUpChallengeResource, StepUpErrorCode, StepUpMethod, StepUpStatusResource, StepUpVerifiedResource, StepUpVerify, StoredAttachmentInput, SuppressionAdd, SuppressionListOptions, SuppressionReason, SuppressionResource, TempDomainResource, TempInboxCreate, TempInboxResource, TempMailOptions, TempMessageDetailResource, TempMessageListOptions, TempMessageResource, TempMessagesResource, TemplateAnalyticsOptions, TemplateAnalyticsResource, TemplateBlock, TemplateBlockKind, TemplateCategory, TemplateContent, TemplateContentSource, TemplateCreate, TemplateDetailResource, TemplateDocument, TemplateDuplicate, TemplateEngine, TemplateFont, TemplateFontFormat, TemplateFontResource, TemplateFontStyle, TemplateListOptions, TemplatePatch, TemplatePreviewInput, TemplatePreviewResource, TemplatePreviewWarningCode, TemplateProp, TemplateRenderInput, TemplateRenderResource, TemplateResource, TemplateRestoreInput, TemplateRestoredResource, TemplateSend, TemplateSendListOptions, TemplateSendResource, TemplateSendsResource, TemplateSlot, TemplateSort, TemplateStarterDetailResource, TemplateStarterResource, TemplateStatus, TemplateValueKind, TemplateVersionResource, TemplateVersionState, ThreadListOptions, ThreadPatch, ThreadResource, ThreadSort, ThreadSummaryResource, TrackingClickResource, TrackingGrain, TrackingHitOptions, TrackingLinkResource, TrackingListOptions, TrackingOpenResource, TrackingRecipientResource, TrackingRequest, TrackingResource, TrackingStatsOptions, TrackingStatsResource, TrackingSummary, TranslateOptions, TranslationResource, TransportOptions, TrashedThreadResource, UpdatedThreadResource, VerifyWebhookProps, WebhookActivityListOptions, WebhookActivityResource, WebhookChangeType, WebhookCreate, WebhookDeliveryAttempt, WebhookDeliveryDetailResource, WebhookDeliveryListOptions, WebhookDeliveryResource, WebhookDeliveryStatus, WebhookEvent, WebhookPatch, WebhookPayload, WebhookReplayErrorCode, WebhookReplayRefusal, WebhookReplayResource, WebhookResource, WebhookSignatureHeaders, WebhookTestResource, WebhookWorkspaceActivityListOptions, WebhookWorkspaceDeliveryListOptions };
|