@openemail/sdk 0.0.4 → 0.0.5

package/index.cjs

@@ -2,6 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+const AUDIENCE_MEMBER_STATUSES = {
+    SUBSCRIBED: 'subscribed',
+    UNSUBSCRIBED: 'unsubscribed'
+};
+
 const BROADCAST_STATUSES = {
     SCHEDULED: 'scheduled',
     QUEUED: 'queued',
@@ -23,7 +28,7 @@ const BROADCAST_RECIPIENT_FILTERS = {
     UNSUBSCRIBED: 'unsubscribed'
 };
 
-var version = "0.0.4";
+var version = "0.0.5";
 
 const BUILD_BASE_URL = 'https://api.openemail.uk';
 
@@ -90,6 +95,18 @@ const CONTACT_PHOTO_TYPES = {
     GIF: 'image/gif'
 };
 
+const DOMAIN_RECORD_STATUSES = {
+    FOUND: 'found',
+    MISSING: 'missing'
+};
+const DOMAIN_DMARC_STAGES = {
+    MISSING: 'missing',
+    INVALID: 'invalid',
+    MONITOR: 'monitor',
+    QUARANTINE: 'quarantine',
+    REJECT: 'reject'
+};
+
 const MESSAGE_ENCRYPTION_FORMATS = {
     PGP_MIME: 'pgp-mime',
     PGP_SIGNED: 'pgp-signed',
@@ -155,6 +172,10 @@ const FILE_USAGES = {
     LINKED: 'linked',
     SCHEDULED: 'scheduled'
 };
+const FILE_VISIBILITIES = {
+    PUBLIC: 'public',
+    PRIVATE: 'private'
+};
 
 const HTTP_METHODS = {
     GET: 'GET',
@@ -593,6 +614,7 @@ const SEGMENTS = {
     TRASH: 'trash',
     UNSNOOZE: 'unsnooze',
     UPLOAD: 'upload',
+    VERIFY: 'verify',
     VERSIONS: 'versions'
 };
 
@@ -1342,6 +1364,9 @@ const BroadcastPath = (id) => `${PATHS.BROADCASTS}/${Segment(id)}`;
 const BroadcastChildPath = (id, segment) => `${BroadcastPath(id)}/${segment}`;
 const BroadcastRecipientPath = (id, emailId) => `${BroadcastChildPath(id, SEGMENTS.RECIPIENTS)}/${Segment(emailId)}`;
 const DomainPath = (id) => `${PATHS.DOMAINS}/${Segment(id)}`;
+const DomainChildPath = (id, segment) => `${DomainPath(id)}/${segment}`;
+const DomainAddressesPath = (id) => `${DomainPath(id)}/${SEGMENTS.ADDRESSES}`;
+const DomainAddressPath = (id, addressId) => `${DomainAddressesPath(id)}/${Segment(addressId)}`;
 const WebhookPath = (id) => `${PATHS.WEBHOOKS}/${Segment(id)}`;
 const WebhookChildPath = (id, segment) => `${WebhookPath(id)}/${segment}`;
 const WebhookDeliveryPath = (id, deliveryId) => `${WebhookChildPath(id, SEGMENTS.DELIVERIES)}/${Segment(deliveryId)}`;
@@ -1414,7 +1439,8 @@ const Addresses = (transport) => {
 const MemberQuery = (options) => ({
     [QUERY_KEYS.Q]: options.q,
     [QUERY_KEYS.SOURCE]: options.source,
-    [QUERY_KEYS.SORT]: options.sort
+    [QUERY_KEYS.SORT]: options.sort,
+    [QUERY_KEYS.STATUS]: options.statuses?.length ? options.statuses.join(LIST_SEPARATOR) : undefined
 });
 const GrowthQuery = (options) => ({
     [QUERY_KEYS.AUDIENCE_IDS]: options.audienceIds?.join(LIST_SEPARATOR),
@@ -1732,12 +1758,52 @@ const Domains = (transport) => ({
     listAll: (options = {}) => CollectAll(transport, PATHS.DOMAINS, CURSOR_STYLES.CURSOR, options),
     iterate: (options = {}) => IteratePages(transport, PATHS.DOMAINS, CURSOR_STYLES.CURSOR, options),
     get: (id, options = {}) => transport.request(DomainPath(id), { signal: options.signal, apiKey: options.apiKey }),
+    create: (body, options = {}) => transport.request(PATHS.DOMAINS, {
+        method: HTTP_METHODS.POST,
+        body,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    verify: (id, options = {}) => transport.request(DomainChildPath(id, SEGMENTS.VERIFY), {
+        method: HTTP_METHODS.POST,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     update: (id, patch, options = {}) => transport.request(DomainPath(id), {
         method: HTTP_METHODS.PATCH,
         body: patch,
         repeatable: true,
         signal: options.signal,
         apiKey: options.apiKey
+    }),
+    delete: (id, options = {}) => transport.request(DomainPath(id), {
+        method: HTTP_METHODS.DELETE,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    listAddresses: (id, options = {}) => FetchPage(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    listAllAddresses: (id, options = {}) => CollectAll(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    iterateAddresses: (id, options = {}) => IteratePages(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    createAddress: (id, body, options = {}) => transport.request(DomainAddressesPath(id), {
+        method: HTTP_METHODS.POST,
+        body,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    getAddress: (id, addressId, options = {}) => transport.request(DomainAddressPath(id, addressId), { signal: options.signal, apiKey: options.apiKey }),
+    updateAddress: (id, addressId, patch, options = {}) => transport.request(DomainAddressPath(id, addressId), {
+        method: HTTP_METHODS.PATCH,
+        body: patch,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    deleteAddress: (id, addressId, options = {}) => transport.request(DomainAddressPath(id, addressId), {
+        method: HTTP_METHODS.DELETE,
+        signal: options.signal,
+        apiKey: options.apiKey
     })
 });
 
@@ -2851,16 +2917,20 @@ const languageByCode = LanguageByCode;
 const isRtlLanguage = IsRtlLanguage;
 
 exports.API_SCOPES = API_SCOPES;
+exports.AUDIENCE_MEMBER_STATUSES = AUDIENCE_MEMBER_STATUSES;
 exports.BROADCAST_RECIPIENT_FILTERS = BROADCAST_RECIPIENT_FILTERS;
 exports.BROADCAST_STATUSES = BROADCAST_STATUSES;
 exports.CONTACT_BLOCK_LISTS = CONTACT_BLOCK_LISTS;
 exports.CONTACT_PHOTO_TYPES = CONTACT_PHOTO_TYPES;
 exports.CONTACT_THREAD_SORTS = CONTACT_THREAD_SORTS;
+exports.DOMAIN_DMARC_STAGES = DOMAIN_DMARC_STAGES;
+exports.DOMAIN_RECORD_STATUSES = DOMAIN_RECORD_STATUSES;
 exports.ERROR_TYPES = ERROR_TYPES;
 exports.FILE_DIRECTIONS = FILE_DIRECTIONS;
 exports.FILE_KINDS = FILE_KINDS;
 exports.FILE_SORTS = FILE_SORTS;
 exports.FILE_USAGES = FILE_USAGES;
+exports.FILE_VISIBILITIES = FILE_VISIBILITIES;
 exports.LANGUAGES = LANGUAGES;
 exports.MESSAGE_ENCRYPTION_FORMATS = MESSAGE_ENCRYPTION_FORMATS;
 exports.OpenEmail = OpenEmail;

package/index.d.cts

@@ -50,6 +50,11 @@ declare const AUDIENCE_MEMBER_SORTS: {
     readonly ADDED_OLDEST: "added-oldest";
     readonly NAME: "name";
 };
+interface AudienceMemberStatuses {
+    SUBSCRIBED: 'subscribed';
+    UNSUBSCRIBED: 'unsubscribed';
+}
+declare const AUDIENCE_MEMBER_STATUSES: AudienceMemberStatuses;
 
 type AudienceBuiltin = (typeof AUDIENCE_BUILTINS)[keyof typeof AUDIENCE_BUILTINS];
 
@@ -59,6 +64,8 @@ type AudienceContactAdd = {
 
 type AudienceMemberSort = (typeof AUDIENCE_MEMBER_SORTS)[keyof typeof AUDIENCE_MEMBER_SORTS];
 
+type AudienceMemberStatus = AudienceMemberStatuses[keyof AudienceMemberStatuses];
+
 declare const CONTACT_SOURCES: {
     readonly MANUAL: "manual";
     readonly AUTO: "auto";
@@ -101,6 +108,7 @@ type AudienceContactListOptions = ListOptions & {
     q?: string;
     source?: ContactSource;
     sort?: AudienceMemberSort;
+    statuses?: Array<AudienceMemberStatus>;
 };
 
 type ContactResource = {
@@ -995,7 +1003,17 @@ declare const Domains: (transport: Transport) => {
     listAll: (options?: ListOptions) => Promise<Array<DomainResource>>;
     iterate: (options?: ListOptions) => AsyncGenerator<DomainResource, void, undefined>;
     get: (id: string, options?: RequestScope) => Promise<DomainDetailResource>;
+    create: (body: DomainCreate, options?: RequestScope) => Promise<DomainDetailResource>;
+    verify: (id: string, options?: RequestScope) => Promise<DomainDetailResource>;
     update: (id: string, patch: DomainPatch, options?: RequestScope) => Promise<DomainDetailResource>;
+    delete: (id: string, options?: RequestScope) => Promise<DeletedDomainResource>;
+    listAddresses: (id: string, options?: ListOptions) => Promise<Page<DomainAddressResource>>;
+    listAllAddresses: (id: string, options?: ListOptions) => Promise<Array<DomainAddressResource>>;
+    iterateAddresses: (id: string, options?: ListOptions) => AsyncGenerator<DomainAddressResource, void, undefined>;
+    createAddress: (id: string, body: DomainAddressCreate, options?: RequestScope) => Promise<DomainAddressResource>;
+    getAddress: (id: string, addressId: string, options?: RequestScope) => Promise<DomainAddressResource>;
+    updateAddress: (id: string, addressId: string, patch: DomainAddressPatch, options?: RequestScope) => Promise<DomainAddressResource>;
+    deleteAddress: (id: string, addressId: string, options?: RequestScope) => Promise<DeletedDomainAddressResource>;
 };
 
 declare const Drafts: (transport: Transport) => {
@@ -1328,6 +1346,48 @@ type TempMailOptions = Omit<TransportOptions, 'apiKey'> & {
     inboxToken?: string;
 };
 
+type DeletedDomainAddressResource = {
+    object: 'address';
+    id: string;
+    address: string;
+    deleted: true;
+};
+
+type DeletedDomainResource = {
+    object: 'domain';
+    id: string;
+    domain: string;
+    deleted: true;
+    leftBehind: Array<string>;
+};
+
+type DomainAddressCreate = {
+    localPart: string;
+    label?: string | null;
+};
+
+type DomainAddressPatch = {
+    label?: string | null;
+    enabled?: boolean;
+};
+
+type DomainAddressResource = {
+    object: 'address';
+    id: string;
+    domainId: string;
+    address: string;
+    localPart: string;
+    label: string | null;
+    enabled: boolean;
+    lastReceivedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type DomainCreate = {
+    domain: string;
+};
+
 declare const DOMAIN_SENDING_STATES: {
     readonly VERIFIED: "verified";
     readonly PENDING: "pending";
@@ -1347,6 +1407,40 @@ declare const DOMAIN_STORAGE_STATES: {
     readonly ACTIVE: "active";
     readonly FAILED: "failed";
 };
+interface DomainRecordStatuses {
+    FOUND: 'found';
+    MISSING: 'missing';
+}
+declare const DOMAIN_RECORD_STATUSES: DomainRecordStatuses;
+interface DomainDmarcStages {
+    MISSING: 'missing';
+    INVALID: 'invalid';
+    MONITOR: 'monitor';
+    QUARANTINE: 'quarantine';
+    REJECT: 'reject';
+}
+declare const DOMAIN_DMARC_STAGES: DomainDmarcStages;
+
+type DomainDmarcStage = DomainDmarcStages[keyof DomainDmarcStages];
+
+type DomainDmarcResource = {
+    stage: DomainDmarcStage;
+    record: string | null;
+    issues: Array<string>;
+    alignmentPossible: boolean;
+    caveat: string;
+};
+
+type DomainRecordStatus = DomainRecordStatuses[keyof DomainRecordStatuses];
+
+type DomainRecordResource = {
+    type: string;
+    name: string;
+    value: string;
+    priority: number | null;
+    purpose: string | null;
+    status: DomainRecordStatus | null;
+};
 
 type DomainSendingState = (typeof DOMAIN_SENDING_STATES)[keyof typeof DOMAIN_SENDING_STATES];
 
@@ -1412,9 +1506,12 @@ type DomainDetailResource = DomainResource & {
         address: string;
         enabled: boolean;
     }>;
+    records: Array<DomainRecordResource>;
+    dmarc: DomainDmarcResource | null;
 };
 
 type DomainPatch = {
+    catchAll?: boolean;
     trackingHost?: string | null;
     storageHost?: string | null;
 };
@@ -1702,6 +1799,12 @@ interface FileUsages {
 }
 type FileUsage = FileUsages[keyof FileUsages];
 declare const FILE_USAGES: FileUsages;
+interface FileVisibilities {
+    PUBLIC: 'public';
+    PRIVATE: 'private';
+}
+type FileVisibility = FileVisibilities[keyof FileVisibilities];
+declare const FILE_VISIBILITIES: FileVisibilities;
 
 type FileKept = {
     id: string;
@@ -1782,6 +1885,8 @@ type FileResource = {
     deliveredTo: string | null;
     usage: FileUsage | null;
     deletable: boolean;
+    visibility: FileVisibility;
+    publicUrl: string | null;
     createdAt: string;
 };
 
@@ -3600,5 +3705,5 @@ declare const resolveLanguage: (input: string | null | undefined) => LanguageRes
 declare const languageByCode: (code: string | null | undefined) => LanguageResource | undefined;
 declare const isRtlLanguage: (code: string | null | undefined) => boolean;
 
-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 };
-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 };
+export { API_SCOPES, AUDIENCE_MEMBER_STATUSES, BROADCAST_RECIPIENT_FILTERS, BROADCAST_STATUSES, CONTACT_BLOCK_LISTS, CONTACT_PHOTO_TYPES, CONTACT_THREAD_SORTS, 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, 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 };
+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, 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, 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, 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 };

package/index.d.ts

@@ -50,6 +50,11 @@ declare const AUDIENCE_MEMBER_SORTS: {
     readonly ADDED_OLDEST: "added-oldest";
     readonly NAME: "name";
 };
+interface AudienceMemberStatuses {
+    SUBSCRIBED: 'subscribed';
+    UNSUBSCRIBED: 'unsubscribed';
+}
+declare const AUDIENCE_MEMBER_STATUSES: AudienceMemberStatuses;
 
 type AudienceBuiltin = (typeof AUDIENCE_BUILTINS)[keyof typeof AUDIENCE_BUILTINS];
 
@@ -59,6 +64,8 @@ type AudienceContactAdd = {
 
 type AudienceMemberSort = (typeof AUDIENCE_MEMBER_SORTS)[keyof typeof AUDIENCE_MEMBER_SORTS];
 
+type AudienceMemberStatus = AudienceMemberStatuses[keyof AudienceMemberStatuses];
+
 declare const CONTACT_SOURCES: {
     readonly MANUAL: "manual";
     readonly AUTO: "auto";
@@ -101,6 +108,7 @@ type AudienceContactListOptions = ListOptions & {
     q?: string;
     source?: ContactSource;
     sort?: AudienceMemberSort;
+    statuses?: Array<AudienceMemberStatus>;
 };
 
 type ContactResource = {
@@ -995,7 +1003,17 @@ declare const Domains: (transport: Transport) => {
     listAll: (options?: ListOptions) => Promise<Array<DomainResource>>;
     iterate: (options?: ListOptions) => AsyncGenerator<DomainResource, void, undefined>;
     get: (id: string, options?: RequestScope) => Promise<DomainDetailResource>;
+    create: (body: DomainCreate, options?: RequestScope) => Promise<DomainDetailResource>;
+    verify: (id: string, options?: RequestScope) => Promise<DomainDetailResource>;
     update: (id: string, patch: DomainPatch, options?: RequestScope) => Promise<DomainDetailResource>;
+    delete: (id: string, options?: RequestScope) => Promise<DeletedDomainResource>;
+    listAddresses: (id: string, options?: ListOptions) => Promise<Page<DomainAddressResource>>;
+    listAllAddresses: (id: string, options?: ListOptions) => Promise<Array<DomainAddressResource>>;
+    iterateAddresses: (id: string, options?: ListOptions) => AsyncGenerator<DomainAddressResource, void, undefined>;
+    createAddress: (id: string, body: DomainAddressCreate, options?: RequestScope) => Promise<DomainAddressResource>;
+    getAddress: (id: string, addressId: string, options?: RequestScope) => Promise<DomainAddressResource>;
+    updateAddress: (id: string, addressId: string, patch: DomainAddressPatch, options?: RequestScope) => Promise<DomainAddressResource>;
+    deleteAddress: (id: string, addressId: string, options?: RequestScope) => Promise<DeletedDomainAddressResource>;
 };
 
 declare const Drafts: (transport: Transport) => {
@@ -1328,6 +1346,48 @@ type TempMailOptions = Omit<TransportOptions, 'apiKey'> & {
     inboxToken?: string;
 };
 
+type DeletedDomainAddressResource = {
+    object: 'address';
+    id: string;
+    address: string;
+    deleted: true;
+};
+
+type DeletedDomainResource = {
+    object: 'domain';
+    id: string;
+    domain: string;
+    deleted: true;
+    leftBehind: Array<string>;
+};
+
+type DomainAddressCreate = {
+    localPart: string;
+    label?: string | null;
+};
+
+type DomainAddressPatch = {
+    label?: string | null;
+    enabled?: boolean;
+};
+
+type DomainAddressResource = {
+    object: 'address';
+    id: string;
+    domainId: string;
+    address: string;
+    localPart: string;
+    label: string | null;
+    enabled: boolean;
+    lastReceivedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type DomainCreate = {
+    domain: string;
+};
+
 declare const DOMAIN_SENDING_STATES: {
     readonly VERIFIED: "verified";
     readonly PENDING: "pending";
@@ -1347,6 +1407,40 @@ declare const DOMAIN_STORAGE_STATES: {
     readonly ACTIVE: "active";
     readonly FAILED: "failed";
 };
+interface DomainRecordStatuses {
+    FOUND: 'found';
+    MISSING: 'missing';
+}
+declare const DOMAIN_RECORD_STATUSES: DomainRecordStatuses;
+interface DomainDmarcStages {
+    MISSING: 'missing';
+    INVALID: 'invalid';
+    MONITOR: 'monitor';
+    QUARANTINE: 'quarantine';
+    REJECT: 'reject';
+}
+declare const DOMAIN_DMARC_STAGES: DomainDmarcStages;
+
+type DomainDmarcStage = DomainDmarcStages[keyof DomainDmarcStages];
+
+type DomainDmarcResource = {
+    stage: DomainDmarcStage;
+    record: string | null;
+    issues: Array<string>;
+    alignmentPossible: boolean;
+    caveat: string;
+};
+
+type DomainRecordStatus = DomainRecordStatuses[keyof DomainRecordStatuses];
+
+type DomainRecordResource = {
+    type: string;
+    name: string;
+    value: string;
+    priority: number | null;
+    purpose: string | null;
+    status: DomainRecordStatus | null;
+};
 
 type DomainSendingState = (typeof DOMAIN_SENDING_STATES)[keyof typeof DOMAIN_SENDING_STATES];
 
@@ -1412,9 +1506,12 @@ type DomainDetailResource = DomainResource & {
         address: string;
         enabled: boolean;
     }>;
+    records: Array<DomainRecordResource>;
+    dmarc: DomainDmarcResource | null;
 };
 
 type DomainPatch = {
+    catchAll?: boolean;
     trackingHost?: string | null;
     storageHost?: string | null;
 };
@@ -1702,6 +1799,12 @@ interface FileUsages {
 }
 type FileUsage = FileUsages[keyof FileUsages];
 declare const FILE_USAGES: FileUsages;
+interface FileVisibilities {
+    PUBLIC: 'public';
+    PRIVATE: 'private';
+}
+type FileVisibility = FileVisibilities[keyof FileVisibilities];
+declare const FILE_VISIBILITIES: FileVisibilities;
 
 type FileKept = {
     id: string;
@@ -1782,6 +1885,8 @@ type FileResource = {
     deliveredTo: string | null;
     usage: FileUsage | null;
     deletable: boolean;
+    visibility: FileVisibility;
+    publicUrl: string | null;
     createdAt: string;
 };
 
@@ -3600,5 +3705,5 @@ declare const resolveLanguage: (input: string | null | undefined) => LanguageRes
 declare const languageByCode: (code: string | null | undefined) => LanguageResource | undefined;
 declare const isRtlLanguage: (code: string | null | undefined) => boolean;
 
-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 };
-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 };
+export { API_SCOPES, AUDIENCE_MEMBER_STATUSES, BROADCAST_RECIPIENT_FILTERS, BROADCAST_STATUSES, CONTACT_BLOCK_LISTS, CONTACT_PHOTO_TYPES, CONTACT_THREAD_SORTS, 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, 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 };
+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, 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, 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, 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 };

package/index.js

@@ -1,3 +1,8 @@
+const AUDIENCE_MEMBER_STATUSES = {
+    SUBSCRIBED: 'subscribed',
+    UNSUBSCRIBED: 'unsubscribed'
+};
+
 const BROADCAST_STATUSES = {
     SCHEDULED: 'scheduled',
     QUEUED: 'queued',
@@ -19,7 +24,7 @@ const BROADCAST_RECIPIENT_FILTERS = {
     UNSUBSCRIBED: 'unsubscribed'
 };
 
-var version = "0.0.4";
+var version = "0.0.5";
 
 const BUILD_BASE_URL = 'https://api.openemail.uk';
 
@@ -86,6 +91,18 @@ const CONTACT_PHOTO_TYPES = {
     GIF: 'image/gif'
 };
 
+const DOMAIN_RECORD_STATUSES = {
+    FOUND: 'found',
+    MISSING: 'missing'
+};
+const DOMAIN_DMARC_STAGES = {
+    MISSING: 'missing',
+    INVALID: 'invalid',
+    MONITOR: 'monitor',
+    QUARANTINE: 'quarantine',
+    REJECT: 'reject'
+};
+
 const MESSAGE_ENCRYPTION_FORMATS = {
     PGP_MIME: 'pgp-mime',
     PGP_SIGNED: 'pgp-signed',
@@ -151,6 +168,10 @@ const FILE_USAGES = {
     LINKED: 'linked',
     SCHEDULED: 'scheduled'
 };
+const FILE_VISIBILITIES = {
+    PUBLIC: 'public',
+    PRIVATE: 'private'
+};
 
 const HTTP_METHODS = {
     GET: 'GET',
@@ -589,6 +610,7 @@ const SEGMENTS = {
     TRASH: 'trash',
     UNSNOOZE: 'unsnooze',
     UPLOAD: 'upload',
+    VERIFY: 'verify',
     VERSIONS: 'versions'
 };
 
@@ -1338,6 +1360,9 @@ const BroadcastPath = (id) => `${PATHS.BROADCASTS}/${Segment(id)}`;
 const BroadcastChildPath = (id, segment) => `${BroadcastPath(id)}/${segment}`;
 const BroadcastRecipientPath = (id, emailId) => `${BroadcastChildPath(id, SEGMENTS.RECIPIENTS)}/${Segment(emailId)}`;
 const DomainPath = (id) => `${PATHS.DOMAINS}/${Segment(id)}`;
+const DomainChildPath = (id, segment) => `${DomainPath(id)}/${segment}`;
+const DomainAddressesPath = (id) => `${DomainPath(id)}/${SEGMENTS.ADDRESSES}`;
+const DomainAddressPath = (id, addressId) => `${DomainAddressesPath(id)}/${Segment(addressId)}`;
 const WebhookPath = (id) => `${PATHS.WEBHOOKS}/${Segment(id)}`;
 const WebhookChildPath = (id, segment) => `${WebhookPath(id)}/${segment}`;
 const WebhookDeliveryPath = (id, deliveryId) => `${WebhookChildPath(id, SEGMENTS.DELIVERIES)}/${Segment(deliveryId)}`;
@@ -1410,7 +1435,8 @@ const Addresses = (transport) => {
 const MemberQuery = (options) => ({
     [QUERY_KEYS.Q]: options.q,
     [QUERY_KEYS.SOURCE]: options.source,
-    [QUERY_KEYS.SORT]: options.sort
+    [QUERY_KEYS.SORT]: options.sort,
+    [QUERY_KEYS.STATUS]: options.statuses?.length ? options.statuses.join(LIST_SEPARATOR) : undefined
 });
 const GrowthQuery = (options) => ({
     [QUERY_KEYS.AUDIENCE_IDS]: options.audienceIds?.join(LIST_SEPARATOR),
@@ -1728,12 +1754,52 @@ const Domains = (transport) => ({
     listAll: (options = {}) => CollectAll(transport, PATHS.DOMAINS, CURSOR_STYLES.CURSOR, options),
     iterate: (options = {}) => IteratePages(transport, PATHS.DOMAINS, CURSOR_STYLES.CURSOR, options),
     get: (id, options = {}) => transport.request(DomainPath(id), { signal: options.signal, apiKey: options.apiKey }),
+    create: (body, options = {}) => transport.request(PATHS.DOMAINS, {
+        method: HTTP_METHODS.POST,
+        body,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    verify: (id, options = {}) => transport.request(DomainChildPath(id, SEGMENTS.VERIFY), {
+        method: HTTP_METHODS.POST,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     update: (id, patch, options = {}) => transport.request(DomainPath(id), {
         method: HTTP_METHODS.PATCH,
         body: patch,
         repeatable: true,
         signal: options.signal,
         apiKey: options.apiKey
+    }),
+    delete: (id, options = {}) => transport.request(DomainPath(id), {
+        method: HTTP_METHODS.DELETE,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    listAddresses: (id, options = {}) => FetchPage(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    listAllAddresses: (id, options = {}) => CollectAll(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    iterateAddresses: (id, options = {}) => IteratePages(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    createAddress: (id, body, options = {}) => transport.request(DomainAddressesPath(id), {
+        method: HTTP_METHODS.POST,
+        body,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    getAddress: (id, addressId, options = {}) => transport.request(DomainAddressPath(id, addressId), { signal: options.signal, apiKey: options.apiKey }),
+    updateAddress: (id, addressId, patch, options = {}) => transport.request(DomainAddressPath(id, addressId), {
+        method: HTTP_METHODS.PATCH,
+        body: patch,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    deleteAddress: (id, addressId, options = {}) => transport.request(DomainAddressPath(id, addressId), {
+        method: HTTP_METHODS.DELETE,
+        signal: options.signal,
+        apiKey: options.apiKey
     })
 });
 
@@ -2846,4 +2912,4 @@ const resolveLanguage = ResolveLanguage;
 const languageByCode = LanguageByCode;
 const isRtlLanguage = IsRtlLanguage;
 
-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 };
+export { API_SCOPES, AUDIENCE_MEMBER_STATUSES, BROADCAST_RECIPIENT_FILTERS, BROADCAST_STATUSES, CONTACT_BLOCK_LISTS, CONTACT_PHOTO_TYPES, CONTACT_THREAD_SORTS, 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, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openemail/sdk",
-    "version": "0.0.4",
+    "version": "0.0.5",
     "author": "OpenEmail",
     "license": "UNLICENSED",
     "description": "The official TypeScript SDK for the OpenEmail API. Send email and broadcasts, work with threads, drafts, labels, templates, rules, webhooks, tracking, contacts, audiences, domains, suppressions, files, API keys, roles, members, mailbox imports and disposable inboxes from code.",