@openemail/sdk 0.0.3 → 0.0.4

package/index.cjs

@@ -10,8 +10,20 @@ const BROADCAST_STATUSES = {
     CANCELLED: 'cancelled',
     FAILED: 'failed'
 };
+const BROADCAST_RECIPIENT_FILTERS = {
+    PENDING: 'pending',
+    SENT: 'sent',
+    DELIVERED: 'delivered',
+    OPENED: 'opened',
+    NOT_OPENED: 'not_opened',
+    CLICKED: 'clicked',
+    BOUNCED: 'bounced',
+    COMPLAINED: 'complained',
+    FAILED: 'failed',
+    UNSUBSCRIBED: 'unsubscribed'
+};
 
-var version = "0.0.3";
+var version = "0.0.4";
 
 const BUILD_BASE_URL = 'https://api.openemail.uk';
 
@@ -454,6 +466,8 @@ const QUERY_KEYS = {
     REASSIGN_TO: 'reassignTo',
     SOURCE: 'source',
     ADDRESS: 'address',
+    DIRECTION: 'direction',
+    FILTER: 'filter',
     SEARCH: 'search',
     SORT: 'sort',
     PAGE: 'page',
@@ -567,8 +581,10 @@ const SEGMENTS = {
     REVOKE: 'revoke',
     ROTATE: 'rotate',
     ROTATE_SECRET: 'rotate-secret',
+    RECIPIENTS: 'recipients',
     SEND: 'send',
     SENDS: 'sends',
+    STATS: 'stats',
     SNOOZE: 'snooze',
     START: 'start',
     TEST: 'test',
@@ -643,6 +659,8 @@ const API_SCOPES = {
     DRAFTS_WRITE: 'drafts:write',
     THREADS_READ: 'threads:read',
     THREADS_WRITE: 'threads:write',
+    FILES_READ: 'files:read',
+    FILES_WRITE: 'files:write',
     LABELS_READ: 'labels:read',
     LABELS_WRITE: 'labels:write',
     CONTACTS_READ: 'contacts:read',
@@ -704,7 +722,9 @@ const WEBHOOK_EVENTS = {
     DOMAIN_SENDING_CHANGED: 'domain.sending_changed',
     DOMAIN_DELETED: 'domain.deleted',
     SUPPRESSION_ADDED: 'suppression.added',
-    SUPPRESSION_REMOVED: 'suppression.removed'
+    SUPPRESSION_REMOVED: 'suppression.removed',
+    FILE_UPLOADED: 'file.uploaded',
+    FILE_DELETED: 'file.deleted'
 };
 const WEBHOOK_REPLAY_ERROR_CODES = {
     RESOURCE_NOT_FOUND: 'resource_not_found',
@@ -1320,6 +1340,7 @@ const AudienceContactsChildPath = (id, segment) => `${AudienceContactsPath(id)}/
 const AudienceContactPath = (id, email) => `${AudienceContactsPath(id)}/${Segment(email)}`;
 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 WebhookPath = (id) => `${PATHS.WEBHOOKS}/${Segment(id)}`;
 const WebhookChildPath = (id, segment) => `${WebhookPath(id)}/${segment}`;
@@ -1352,6 +1373,7 @@ const MemberInvitationResendPath = (id) => `${MemberInvitationPath(id)}/${SEGMEN
 const SuppressionPath = (id) => `${PATHS.SUPPRESSIONS}/${Segment(id)}`;
 const FilePath = (id) => `${PATHS.FILES}/${Segment(id)}`;
 const FileChildPath = (id, segment) => `${FilePath(id)}/${segment}`;
+const FileLinkPath = (id, linkId) => `${FileChildPath(id, SEGMENTS.LINKS)}/${Segment(linkId)}`;
 const TempInboxPath = (id) => `${PATHS.TEMP_MAIL_INBOXES}/${Segment(id)}`;
 const TempInboxExtendPath = (id) => `${TempInboxPath(id)}/${SEGMENTS.EXTEND}`;
 const TempMessagesPath = (id) => `${TempInboxPath(id)}/${SEGMENTS.MESSAGES}`;
@@ -1514,6 +1536,11 @@ const ToInstant = Instant;
 const ListQuery$a = (options) => ({
     [QUERY_KEYS.AUDIENCE_ID]: options.audienceId
 });
+const RecipientQuery = (options) => ({
+    [QUERY_KEYS.FILTER]: options.filter,
+    [QUERY_KEYS.Q]: options.q
+});
+const RecipientsPath = (id) => BroadcastChildPath(id, SEGMENTS.RECIPIENTS);
 const Broadcasts = (transport) => ({
     preview: (body, options = {}) => transport.request(PATHS.BROADCASTS_PREVIEW, {
         method: HTTP_METHODS.POST,
@@ -1535,6 +1562,21 @@ const Broadcasts = (transport) => ({
     listAll: (options = {}) => CollectAll(transport, PATHS.BROADCASTS, CURSOR_STYLES.CURSOR, options, ListQuery$a(options)),
     iterate: (options = {}) => IteratePages(transport, PATHS.BROADCASTS, CURSOR_STYLES.CURSOR, options, ListQuery$a(options)),
     get: (id, options = {}) => transport.request(BroadcastPath(id), { signal: options.signal, apiKey: options.apiKey }),
+    listRecipients: (id, options = {}) => FetchPage(transport, RecipientsPath(id), CURSOR_STYLES.CURSOR, options, RecipientQuery(options)),
+    listAllRecipients: (id, options = {}) => CollectAll(transport, RecipientsPath(id), CURSOR_STYLES.CURSOR, options, RecipientQuery(options)),
+    iterateRecipients: (id, options = {}) => IteratePages(transport, RecipientsPath(id), CURSOR_STYLES.CURSOR, options, RecipientQuery(options)),
+    getRecipient: (id, emailId, options = {}) => transport.request(BroadcastRecipientPath(id, emailId), {
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    stats: (id, options = {}) => transport.request(BroadcastChildPath(id, SEGMENTS.STATS), {
+        query: {
+            [QUERY_KEYS.GRAIN]: options.grain,
+            [QUERY_KEYS.OFFSET_MINUTES]: options.offsetMinutes
+        },
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     cancel: (id, options = {}) => transport.request(BroadcastChildPath(id, SEGMENTS.CANCEL), {
         method: HTTP_METHODS.POST,
         repeatable: true,
@@ -1783,6 +1825,10 @@ const Emails = (transport) => ({
 const ListQuery$6 = (options) => ({
     [QUERY_KEYS.Q]: options.q,
     [QUERY_KEYS.KIND]: options.kind,
+    [QUERY_KEYS.DIRECTION]: options.direction,
+    [QUERY_KEYS.ADDRESS]: options.address,
+    [QUERY_KEYS.SINCE]: ToInstant(options.since),
+    [QUERY_KEYS.UNTIL]: ToInstant(options.until),
     [QUERY_KEYS.SORT]: options.sort
 });
 const UploadName = (options) => {
@@ -1815,6 +1861,18 @@ const Files = (transport) => ({
     listLinks: (id, options = {}) => FetchPage(transport, FileChildPath(id, SEGMENTS.LINKS), CURSOR_STYLES.CURSOR, options),
     listAllLinks: (id, options = {}) => CollectAll(transport, FileChildPath(id, SEGMENTS.LINKS), CURSOR_STYLES.CURSOR, options),
     iterateLinks: (id, options = {}) => IteratePages(transport, FileChildPath(id, SEGMENTS.LINKS), CURSOR_STYLES.CURSOR, options),
+    createLink: (id, options = {}) => transport.request(FileChildPath(id, SEGMENTS.LINKS), {
+        method: HTTP_METHODS.POST,
+        body: options.domain ? { domain: options.domain } : {},
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    revokeLink: (id, linkId, options = {}) => transport.request(FileLinkPath(id, linkId), {
+        method: HTTP_METHODS.DELETE,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     upload: (data, options) => transport.request(PATHS.FILES, {
         method: HTTP_METHODS.POST,
         query: { [QUERY_KEYS.FILENAME]: UploadName(options) },
@@ -2793,6 +2851,7 @@ const languageByCode = LanguageByCode;
 const isRtlLanguage = IsRtlLanguage;
 
 exports.API_SCOPES = API_SCOPES;
+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;

package/index.d.cts

@@ -305,12 +305,30 @@ type BroadcastPreviewResource = {
     suppressed: number;
 };
 
-declare const API_KEY_MODES: {
-    readonly LIVE: "live";
-    readonly TEST: "test";
+type BroadcastRecipientResource = {
+    object: 'broadcast_recipient';
+    emailId: string;
+    contactId: string | null;
+    email: string;
+    name: string | null;
+    status: string;
+    sentAt: string | null;
+    deliveredAt: string | null;
+    bouncedAt: string | null;
+    complainedAt: string | null;
+    failure: string | null;
+    opens: number;
+    firstOpenAt: string | null;
+    clicks: number;
+    firstClickAt: string | null;
+    unsubscribedAt: string | null;
 };
 
-type ApiKeyMode = (typeof API_KEY_MODES)[keyof typeof API_KEY_MODES];
+type BroadcastRecipientContentResource = BroadcastRecipientResource & {
+    subject: string;
+    html: string | null;
+    text: string | null;
+};
 
 declare const BROADCAST_STATUSES: {
     readonly SCHEDULED: "scheduled";
@@ -320,6 +338,33 @@ declare const BROADCAST_STATUSES: {
     readonly CANCELLED: "cancelled";
     readonly FAILED: "failed";
 };
+interface BroadcastRecipientFilters {
+    PENDING: 'pending';
+    SENT: 'sent';
+    DELIVERED: 'delivered';
+    OPENED: 'opened';
+    NOT_OPENED: 'not_opened';
+    CLICKED: 'clicked';
+    BOUNCED: 'bounced';
+    COMPLAINED: 'complained';
+    FAILED: 'failed';
+    UNSUBSCRIBED: 'unsubscribed';
+}
+declare const BROADCAST_RECIPIENT_FILTERS: BroadcastRecipientFilters;
+
+type BroadcastRecipientFilter = BroadcastRecipientFilters[keyof BroadcastRecipientFilters];
+
+type BroadcastRecipientListOptions = ListOptions & {
+    filter?: BroadcastRecipientFilter;
+    q?: string;
+};
+
+declare const API_KEY_MODES: {
+    readonly LIVE: "live";
+    readonly TEST: "test";
+};
+
+type ApiKeyMode = (typeof API_KEY_MODES)[keyof typeof API_KEY_MODES];
 
 type BroadcastStatus = (typeof BROADCAST_STATUSES)[keyof typeof BROADCAST_STATUSES];
 
@@ -385,6 +430,40 @@ type BroadcastResource = {
     updatedAt: string;
 };
 
+type BroadcastStatsOptions = RequestScope & {
+    grain?: TrackingGrain;
+    offsetMinutes?: number;
+};
+
+type BroadcastStatsTotals = {
+    recipients: number;
+    pending: number;
+    sent: number;
+    delivered: number;
+    bounced: number;
+    complained: number;
+    failed: number;
+    opened: number;
+    clicked: number;
+    unsubscribed: number;
+    opens: number;
+    clicks: number;
+};
+type BroadcastStatsBucket = {
+    bucket: string;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    unsubscribed: number;
+};
+type BroadcastStatsResource = {
+    object: 'broadcast_stats';
+    broadcastId: string;
+    grain: TrackingGrain;
+    totals: BroadcastStatsTotals;
+    series: Array<BroadcastStatsBucket>;
+};
+
 type SentBroadcastResource = BroadcastResource & {
     replayed: boolean;
 };
@@ -459,40 +538,43 @@ type CalendarRangeOptions = ListOptions & {
     timezone?: string;
 };
 
-declare const API_SCOPES: {
-    readonly EMAILS_SEND: "emails:send";
-    readonly EMAILS_READ: "emails:read";
-    readonly DRAFTS_READ: "drafts:read";
-    readonly DRAFTS_WRITE: "drafts:write";
-    readonly THREADS_READ: "threads:read";
-    readonly THREADS_WRITE: "threads:write";
-    readonly LABELS_READ: "labels:read";
-    readonly LABELS_WRITE: "labels:write";
-    readonly CONTACTS_READ: "contacts:read";
-    readonly CONTACTS_WRITE: "contacts:write";
-    readonly AUDIENCES_READ: "audiences:read";
-    readonly AUDIENCES_WRITE: "audiences:write";
-    readonly CALENDAR_READ: "calendar:read";
-    readonly CALENDAR_WRITE: "calendar:write";
-    readonly TEMPLATES_READ: "templates:read";
-    readonly TEMPLATES_WRITE: "templates:write";
-    readonly DOMAINS_READ: "domains:read";
-    readonly DOMAINS_WRITE: "domains:write";
-    readonly WEBHOOKS_READ: "webhooks:read";
-    readonly WEBHOOKS_WRITE: "webhooks:write";
-    readonly RULES_READ: "rules:read";
-    readonly RULES_WRITE: "rules:write";
-    readonly CONNECTIONS_READ: "connections:read";
-    readonly MEMBERS_READ: "members:read";
-    readonly MEMBERS_WRITE: "members:write";
-    readonly ROLES_READ: "roles:read";
-    readonly ROLES_WRITE: "roles:write";
-    readonly SETTINGS_READ: "settings:read";
-    readonly SETTINGS_WRITE: "settings:write";
-    readonly KEYS_WRITE: "keys:write";
-    readonly KEYS_READ: "keys:read";
-    readonly KEYS_MANAGE: "keys:manage";
-};
+interface ApiScopes {
+    EMAILS_SEND: 'emails:send';
+    EMAILS_READ: 'emails:read';
+    DRAFTS_READ: 'drafts:read';
+    DRAFTS_WRITE: 'drafts:write';
+    THREADS_READ: 'threads:read';
+    THREADS_WRITE: 'threads:write';
+    FILES_READ: 'files:read';
+    FILES_WRITE: 'files:write';
+    LABELS_READ: 'labels:read';
+    LABELS_WRITE: 'labels:write';
+    CONTACTS_READ: 'contacts:read';
+    CONTACTS_WRITE: 'contacts:write';
+    AUDIENCES_READ: 'audiences:read';
+    AUDIENCES_WRITE: 'audiences:write';
+    CALENDAR_READ: 'calendar:read';
+    CALENDAR_WRITE: 'calendar:write';
+    TEMPLATES_READ: 'templates:read';
+    TEMPLATES_WRITE: 'templates:write';
+    DOMAINS_READ: 'domains:read';
+    DOMAINS_WRITE: 'domains:write';
+    WEBHOOKS_READ: 'webhooks:read';
+    WEBHOOKS_WRITE: 'webhooks:write';
+    RULES_READ: 'rules:read';
+    RULES_WRITE: 'rules:write';
+    CONNECTIONS_READ: 'connections:read';
+    MEMBERS_READ: 'members:read';
+    MEMBERS_WRITE: 'members:write';
+    ROLES_READ: 'roles:read';
+    ROLES_WRITE: 'roles:write';
+    SETTINGS_READ: 'settings:read';
+    SETTINGS_WRITE: 'settings:write';
+    KEYS_WRITE: 'keys:write';
+    KEYS_READ: 'keys:read';
+    KEYS_MANAGE: 'keys:manage';
+}
+declare const API_SCOPES: ApiScopes;
 declare const CONSOLE_PERMISSIONS: {
     readonly API_KEYS_READ: "api-keys:read";
     readonly API_KEYS_WRITE: "api-keys:write";
@@ -501,7 +583,7 @@ declare const CONSOLE_PERMISSIONS: {
     readonly WORKSPACE_MANAGE: "workspace:manage";
 };
 
-type ApiScope = (typeof API_SCOPES)[keyof typeof API_SCOPES];
+type ApiScope = ApiScopes[keyof ApiScopes];
 
 type InlineAttachmentInput = {
     filename: string;
@@ -868,6 +950,11 @@ declare const Broadcasts: (transport: Transport) => {
     listAll: (options?: BroadcastListOptions) => Promise<Array<BroadcastResource>>;
     iterate: (options?: BroadcastListOptions) => AsyncGenerator<BroadcastResource, void, undefined>;
     get: (id: string, options?: RequestScope) => Promise<BroadcastResource>;
+    listRecipients: (id: string, options?: BroadcastRecipientListOptions) => Promise<Page<BroadcastRecipientResource>>;
+    listAllRecipients: (id: string, options?: BroadcastRecipientListOptions) => Promise<Array<BroadcastRecipientResource>>;
+    iterateRecipients: (id: string, options?: BroadcastRecipientListOptions) => AsyncGenerator<BroadcastRecipientResource, void, undefined>;
+    getRecipient: (id: string, emailId: string, options?: RequestScope) => Promise<BroadcastRecipientContentResource>;
+    stats: (id: string, options?: BroadcastStatsOptions) => Promise<BroadcastStatsResource>;
     cancel: (id: string, options?: RequestScope) => Promise<BroadcastResource>;
 };
 
@@ -947,6 +1034,8 @@ declare const Files: (transport: Transport) => {
     listLinks: (id: string, options?: ListOptions) => Promise<Page<FileLinkResource>>;
     listAllLinks: (id: string, options?: ListOptions) => Promise<Array<FileLinkResource>>;
     iterateLinks: (id: string, options?: ListOptions) => AsyncGenerator<FileLinkResource, void, undefined>;
+    createLink: (id: string, options?: FileLinkCreateOptions) => Promise<FileLinkResource>;
+    revokeLink: (id: string, linkId: string, options?: RequestScope) => Promise<FileLinkResource>;
     upload: (data: RawBody, options: FileUploadOptions) => Promise<FileResource>;
     delete: (id: string, options?: RequestScope) => Promise<DeletedFileResource>;
     deleteMany: (ids: Array<string>, options?: RequestScope) => Promise<FileBatchDeleteResource>;
@@ -1649,6 +1738,10 @@ type FileLinkCount = {
     lastDownloadAt: string | null;
 };
 
+type FileLinkCreateOptions = RequestScope & {
+    domain?: string;
+};
+
 type FileLinkResource = {
     object: 'file_link';
     id: string;
@@ -1658,6 +1751,7 @@ type FileLinkResource = {
     sizeBytes: number;
     host: string | null;
     url: string;
+    published: boolean;
     downloads: number;
     lastDownloadAt: string | null;
     revokedAt: string | null;
@@ -1669,6 +1763,10 @@ type FileSort = (typeof FILE_SORTS)[keyof typeof FILE_SORTS];
 type FileListOptions = ListOptions & {
     q?: string;
     kind?: FileKind;
+    direction?: FileDirection;
+    address?: string;
+    since?: Date | string;
+    until?: Date | string;
     sort?: FileSort;
 };
 
@@ -3153,28 +3251,31 @@ type TrackingStatsResource = {
     }>;
 };
 
-declare const WEBHOOK_EVENTS: {
-    readonly EMAIL_RECEIVED: "email.received";
-    readonly EMAIL_REPLIED: "email.replied";
-    readonly EMAIL_SENT: "email.sent";
-    readonly EMAIL_FAILED: "email.failed";
-    readonly EMAIL_CANCELLED: "email.cancelled";
-    readonly EMAIL_SCHEDULED: "email.scheduled";
-    readonly EMAIL_QUEUED: "email.queued";
-    readonly EMAIL_DELIVERED: "email.delivered";
-    readonly EMAIL_DELIVERY_DELAYED: "email.delivery_delayed";
-    readonly EMAIL_BOUNCED: "email.bounced";
-    readonly EMAIL_COMPLAINED: "email.complained";
-    readonly EMAIL_SUPPRESSED: "email.suppressed";
-    readonly EMAIL_OPENED: "email.opened";
-    readonly EMAIL_CLICKED: "email.clicked";
-    readonly EMAIL_DOWNLOADED: "email.downloaded";
-    readonly DOMAIN_VERIFIED: "domain.verified";
-    readonly DOMAIN_SENDING_CHANGED: "domain.sending_changed";
-    readonly DOMAIN_DELETED: "domain.deleted";
-    readonly SUPPRESSION_ADDED: "suppression.added";
-    readonly SUPPRESSION_REMOVED: "suppression.removed";
-};
+interface WebhookEvents {
+    EMAIL_RECEIVED: 'email.received';
+    EMAIL_REPLIED: 'email.replied';
+    EMAIL_SENT: 'email.sent';
+    EMAIL_FAILED: 'email.failed';
+    EMAIL_CANCELLED: 'email.cancelled';
+    EMAIL_SCHEDULED: 'email.scheduled';
+    EMAIL_QUEUED: 'email.queued';
+    EMAIL_DELIVERED: 'email.delivered';
+    EMAIL_DELIVERY_DELAYED: 'email.delivery_delayed';
+    EMAIL_BOUNCED: 'email.bounced';
+    EMAIL_COMPLAINED: 'email.complained';
+    EMAIL_SUPPRESSED: 'email.suppressed';
+    EMAIL_OPENED: 'email.opened';
+    EMAIL_CLICKED: 'email.clicked';
+    EMAIL_DOWNLOADED: 'email.downloaded';
+    DOMAIN_VERIFIED: 'domain.verified';
+    DOMAIN_SENDING_CHANGED: 'domain.sending_changed';
+    DOMAIN_DELETED: 'domain.deleted';
+    SUPPRESSION_ADDED: 'suppression.added';
+    SUPPRESSION_REMOVED: 'suppression.removed';
+    FILE_UPLOADED: 'file.uploaded';
+    FILE_DELETED: 'file.deleted';
+}
+declare const WEBHOOK_EVENTS: WebhookEvents;
 declare const WEBHOOK_DELIVERY_STATUSES: {
     readonly DELIVERED: "delivered";
     readonly FAILED: "failed";
@@ -3200,7 +3301,7 @@ declare const WEBHOOK_REPLAY_ERROR_CODES: {
     readonly REPLAY_IN_PROGRESS: "replay_in_progress";
 };
 
-type WebhookEvent = (typeof WEBHOOK_EVENTS)[keyof typeof WEBHOOK_EVENTS];
+type WebhookEvent = WebhookEvents[keyof WebhookEvents];
 
 type WebhookResource = {
     object: 'webhook';
@@ -3268,6 +3369,19 @@ type EmailDownloadedData = Omit<EmailOpenedData, 'recipient' | 'attributed' | 'o
     downloadedAt: string;
 };
 
+type FileEventData = {
+    fileId: string;
+    filename: string;
+    mimeType: string;
+    sizeBytes: number;
+    direction: FileDirection;
+    to: string | null;
+    threadId: string | null;
+    messageId: string | null;
+    uploadedAt?: string;
+    deletedAt?: string;
+};
+
 type WebhookSignatureHeaders = Record<string, string | Array<string> | undefined>;
 
 type VerifyWebhookProps = {
@@ -3486,5 +3600,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_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, BroadcastResource, 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, FileKept, FileKind, FileLinkCount, 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, 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 };

package/index.d.ts

@@ -305,12 +305,30 @@ type BroadcastPreviewResource = {
     suppressed: number;
 };
 
-declare const API_KEY_MODES: {
-    readonly LIVE: "live";
-    readonly TEST: "test";
+type BroadcastRecipientResource = {
+    object: 'broadcast_recipient';
+    emailId: string;
+    contactId: string | null;
+    email: string;
+    name: string | null;
+    status: string;
+    sentAt: string | null;
+    deliveredAt: string | null;
+    bouncedAt: string | null;
+    complainedAt: string | null;
+    failure: string | null;
+    opens: number;
+    firstOpenAt: string | null;
+    clicks: number;
+    firstClickAt: string | null;
+    unsubscribedAt: string | null;
 };
 
-type ApiKeyMode = (typeof API_KEY_MODES)[keyof typeof API_KEY_MODES];
+type BroadcastRecipientContentResource = BroadcastRecipientResource & {
+    subject: string;
+    html: string | null;
+    text: string | null;
+};
 
 declare const BROADCAST_STATUSES: {
     readonly SCHEDULED: "scheduled";
@@ -320,6 +338,33 @@ declare const BROADCAST_STATUSES: {
     readonly CANCELLED: "cancelled";
     readonly FAILED: "failed";
 };
+interface BroadcastRecipientFilters {
+    PENDING: 'pending';
+    SENT: 'sent';
+    DELIVERED: 'delivered';
+    OPENED: 'opened';
+    NOT_OPENED: 'not_opened';
+    CLICKED: 'clicked';
+    BOUNCED: 'bounced';
+    COMPLAINED: 'complained';
+    FAILED: 'failed';
+    UNSUBSCRIBED: 'unsubscribed';
+}
+declare const BROADCAST_RECIPIENT_FILTERS: BroadcastRecipientFilters;
+
+type BroadcastRecipientFilter = BroadcastRecipientFilters[keyof BroadcastRecipientFilters];
+
+type BroadcastRecipientListOptions = ListOptions & {
+    filter?: BroadcastRecipientFilter;
+    q?: string;
+};
+
+declare const API_KEY_MODES: {
+    readonly LIVE: "live";
+    readonly TEST: "test";
+};
+
+type ApiKeyMode = (typeof API_KEY_MODES)[keyof typeof API_KEY_MODES];
 
 type BroadcastStatus = (typeof BROADCAST_STATUSES)[keyof typeof BROADCAST_STATUSES];
 
@@ -385,6 +430,40 @@ type BroadcastResource = {
     updatedAt: string;
 };
 
+type BroadcastStatsOptions = RequestScope & {
+    grain?: TrackingGrain;
+    offsetMinutes?: number;
+};
+
+type BroadcastStatsTotals = {
+    recipients: number;
+    pending: number;
+    sent: number;
+    delivered: number;
+    bounced: number;
+    complained: number;
+    failed: number;
+    opened: number;
+    clicked: number;
+    unsubscribed: number;
+    opens: number;
+    clicks: number;
+};
+type BroadcastStatsBucket = {
+    bucket: string;
+    delivered: number;
+    opened: number;
+    clicked: number;
+    unsubscribed: number;
+};
+type BroadcastStatsResource = {
+    object: 'broadcast_stats';
+    broadcastId: string;
+    grain: TrackingGrain;
+    totals: BroadcastStatsTotals;
+    series: Array<BroadcastStatsBucket>;
+};
+
 type SentBroadcastResource = BroadcastResource & {
     replayed: boolean;
 };
@@ -459,40 +538,43 @@ type CalendarRangeOptions = ListOptions & {
     timezone?: string;
 };
 
-declare const API_SCOPES: {
-    readonly EMAILS_SEND: "emails:send";
-    readonly EMAILS_READ: "emails:read";
-    readonly DRAFTS_READ: "drafts:read";
-    readonly DRAFTS_WRITE: "drafts:write";
-    readonly THREADS_READ: "threads:read";
-    readonly THREADS_WRITE: "threads:write";
-    readonly LABELS_READ: "labels:read";
-    readonly LABELS_WRITE: "labels:write";
-    readonly CONTACTS_READ: "contacts:read";
-    readonly CONTACTS_WRITE: "contacts:write";
-    readonly AUDIENCES_READ: "audiences:read";
-    readonly AUDIENCES_WRITE: "audiences:write";
-    readonly CALENDAR_READ: "calendar:read";
-    readonly CALENDAR_WRITE: "calendar:write";
-    readonly TEMPLATES_READ: "templates:read";
-    readonly TEMPLATES_WRITE: "templates:write";
-    readonly DOMAINS_READ: "domains:read";
-    readonly DOMAINS_WRITE: "domains:write";
-    readonly WEBHOOKS_READ: "webhooks:read";
-    readonly WEBHOOKS_WRITE: "webhooks:write";
-    readonly RULES_READ: "rules:read";
-    readonly RULES_WRITE: "rules:write";
-    readonly CONNECTIONS_READ: "connections:read";
-    readonly MEMBERS_READ: "members:read";
-    readonly MEMBERS_WRITE: "members:write";
-    readonly ROLES_READ: "roles:read";
-    readonly ROLES_WRITE: "roles:write";
-    readonly SETTINGS_READ: "settings:read";
-    readonly SETTINGS_WRITE: "settings:write";
-    readonly KEYS_WRITE: "keys:write";
-    readonly KEYS_READ: "keys:read";
-    readonly KEYS_MANAGE: "keys:manage";
-};
+interface ApiScopes {
+    EMAILS_SEND: 'emails:send';
+    EMAILS_READ: 'emails:read';
+    DRAFTS_READ: 'drafts:read';
+    DRAFTS_WRITE: 'drafts:write';
+    THREADS_READ: 'threads:read';
+    THREADS_WRITE: 'threads:write';
+    FILES_READ: 'files:read';
+    FILES_WRITE: 'files:write';
+    LABELS_READ: 'labels:read';
+    LABELS_WRITE: 'labels:write';
+    CONTACTS_READ: 'contacts:read';
+    CONTACTS_WRITE: 'contacts:write';
+    AUDIENCES_READ: 'audiences:read';
+    AUDIENCES_WRITE: 'audiences:write';
+    CALENDAR_READ: 'calendar:read';
+    CALENDAR_WRITE: 'calendar:write';
+    TEMPLATES_READ: 'templates:read';
+    TEMPLATES_WRITE: 'templates:write';
+    DOMAINS_READ: 'domains:read';
+    DOMAINS_WRITE: 'domains:write';
+    WEBHOOKS_READ: 'webhooks:read';
+    WEBHOOKS_WRITE: 'webhooks:write';
+    RULES_READ: 'rules:read';
+    RULES_WRITE: 'rules:write';
+    CONNECTIONS_READ: 'connections:read';
+    MEMBERS_READ: 'members:read';
+    MEMBERS_WRITE: 'members:write';
+    ROLES_READ: 'roles:read';
+    ROLES_WRITE: 'roles:write';
+    SETTINGS_READ: 'settings:read';
+    SETTINGS_WRITE: 'settings:write';
+    KEYS_WRITE: 'keys:write';
+    KEYS_READ: 'keys:read';
+    KEYS_MANAGE: 'keys:manage';
+}
+declare const API_SCOPES: ApiScopes;
 declare const CONSOLE_PERMISSIONS: {
     readonly API_KEYS_READ: "api-keys:read";
     readonly API_KEYS_WRITE: "api-keys:write";
@@ -501,7 +583,7 @@ declare const CONSOLE_PERMISSIONS: {
     readonly WORKSPACE_MANAGE: "workspace:manage";
 };
 
-type ApiScope = (typeof API_SCOPES)[keyof typeof API_SCOPES];
+type ApiScope = ApiScopes[keyof ApiScopes];
 
 type InlineAttachmentInput = {
     filename: string;
@@ -868,6 +950,11 @@ declare const Broadcasts: (transport: Transport) => {
     listAll: (options?: BroadcastListOptions) => Promise<Array<BroadcastResource>>;
     iterate: (options?: BroadcastListOptions) => AsyncGenerator<BroadcastResource, void, undefined>;
     get: (id: string, options?: RequestScope) => Promise<BroadcastResource>;
+    listRecipients: (id: string, options?: BroadcastRecipientListOptions) => Promise<Page<BroadcastRecipientResource>>;
+    listAllRecipients: (id: string, options?: BroadcastRecipientListOptions) => Promise<Array<BroadcastRecipientResource>>;
+    iterateRecipients: (id: string, options?: BroadcastRecipientListOptions) => AsyncGenerator<BroadcastRecipientResource, void, undefined>;
+    getRecipient: (id: string, emailId: string, options?: RequestScope) => Promise<BroadcastRecipientContentResource>;
+    stats: (id: string, options?: BroadcastStatsOptions) => Promise<BroadcastStatsResource>;
     cancel: (id: string, options?: RequestScope) => Promise<BroadcastResource>;
 };
 
@@ -947,6 +1034,8 @@ declare const Files: (transport: Transport) => {
     listLinks: (id: string, options?: ListOptions) => Promise<Page<FileLinkResource>>;
     listAllLinks: (id: string, options?: ListOptions) => Promise<Array<FileLinkResource>>;
     iterateLinks: (id: string, options?: ListOptions) => AsyncGenerator<FileLinkResource, void, undefined>;
+    createLink: (id: string, options?: FileLinkCreateOptions) => Promise<FileLinkResource>;
+    revokeLink: (id: string, linkId: string, options?: RequestScope) => Promise<FileLinkResource>;
     upload: (data: RawBody, options: FileUploadOptions) => Promise<FileResource>;
     delete: (id: string, options?: RequestScope) => Promise<DeletedFileResource>;
     deleteMany: (ids: Array<string>, options?: RequestScope) => Promise<FileBatchDeleteResource>;
@@ -1649,6 +1738,10 @@ type FileLinkCount = {
     lastDownloadAt: string | null;
 };
 
+type FileLinkCreateOptions = RequestScope & {
+    domain?: string;
+};
+
 type FileLinkResource = {
     object: 'file_link';
     id: string;
@@ -1658,6 +1751,7 @@ type FileLinkResource = {
     sizeBytes: number;
     host: string | null;
     url: string;
+    published: boolean;
     downloads: number;
     lastDownloadAt: string | null;
     revokedAt: string | null;
@@ -1669,6 +1763,10 @@ type FileSort = (typeof FILE_SORTS)[keyof typeof FILE_SORTS];
 type FileListOptions = ListOptions & {
     q?: string;
     kind?: FileKind;
+    direction?: FileDirection;
+    address?: string;
+    since?: Date | string;
+    until?: Date | string;
     sort?: FileSort;
 };
 
@@ -3153,28 +3251,31 @@ type TrackingStatsResource = {
     }>;
 };
 
-declare const WEBHOOK_EVENTS: {
-    readonly EMAIL_RECEIVED: "email.received";
-    readonly EMAIL_REPLIED: "email.replied";
-    readonly EMAIL_SENT: "email.sent";
-    readonly EMAIL_FAILED: "email.failed";
-    readonly EMAIL_CANCELLED: "email.cancelled";
-    readonly EMAIL_SCHEDULED: "email.scheduled";
-    readonly EMAIL_QUEUED: "email.queued";
-    readonly EMAIL_DELIVERED: "email.delivered";
-    readonly EMAIL_DELIVERY_DELAYED: "email.delivery_delayed";
-    readonly EMAIL_BOUNCED: "email.bounced";
-    readonly EMAIL_COMPLAINED: "email.complained";
-    readonly EMAIL_SUPPRESSED: "email.suppressed";
-    readonly EMAIL_OPENED: "email.opened";
-    readonly EMAIL_CLICKED: "email.clicked";
-    readonly EMAIL_DOWNLOADED: "email.downloaded";
-    readonly DOMAIN_VERIFIED: "domain.verified";
-    readonly DOMAIN_SENDING_CHANGED: "domain.sending_changed";
-    readonly DOMAIN_DELETED: "domain.deleted";
-    readonly SUPPRESSION_ADDED: "suppression.added";
-    readonly SUPPRESSION_REMOVED: "suppression.removed";
-};
+interface WebhookEvents {
+    EMAIL_RECEIVED: 'email.received';
+    EMAIL_REPLIED: 'email.replied';
+    EMAIL_SENT: 'email.sent';
+    EMAIL_FAILED: 'email.failed';
+    EMAIL_CANCELLED: 'email.cancelled';
+    EMAIL_SCHEDULED: 'email.scheduled';
+    EMAIL_QUEUED: 'email.queued';
+    EMAIL_DELIVERED: 'email.delivered';
+    EMAIL_DELIVERY_DELAYED: 'email.delivery_delayed';
+    EMAIL_BOUNCED: 'email.bounced';
+    EMAIL_COMPLAINED: 'email.complained';
+    EMAIL_SUPPRESSED: 'email.suppressed';
+    EMAIL_OPENED: 'email.opened';
+    EMAIL_CLICKED: 'email.clicked';
+    EMAIL_DOWNLOADED: 'email.downloaded';
+    DOMAIN_VERIFIED: 'domain.verified';
+    DOMAIN_SENDING_CHANGED: 'domain.sending_changed';
+    DOMAIN_DELETED: 'domain.deleted';
+    SUPPRESSION_ADDED: 'suppression.added';
+    SUPPRESSION_REMOVED: 'suppression.removed';
+    FILE_UPLOADED: 'file.uploaded';
+    FILE_DELETED: 'file.deleted';
+}
+declare const WEBHOOK_EVENTS: WebhookEvents;
 declare const WEBHOOK_DELIVERY_STATUSES: {
     readonly DELIVERED: "delivered";
     readonly FAILED: "failed";
@@ -3200,7 +3301,7 @@ declare const WEBHOOK_REPLAY_ERROR_CODES: {
     readonly REPLAY_IN_PROGRESS: "replay_in_progress";
 };
 
-type WebhookEvent = (typeof WEBHOOK_EVENTS)[keyof typeof WEBHOOK_EVENTS];
+type WebhookEvent = WebhookEvents[keyof WebhookEvents];
 
 type WebhookResource = {
     object: 'webhook';
@@ -3268,6 +3369,19 @@ type EmailDownloadedData = Omit<EmailOpenedData, 'recipient' | 'attributed' | 'o
     downloadedAt: string;
 };
 
+type FileEventData = {
+    fileId: string;
+    filename: string;
+    mimeType: string;
+    sizeBytes: number;
+    direction: FileDirection;
+    to: string | null;
+    threadId: string | null;
+    messageId: string | null;
+    uploadedAt?: string;
+    deletedAt?: string;
+};
+
 type WebhookSignatureHeaders = Record<string, string | Array<string> | undefined>;
 
 type VerifyWebhookProps = {
@@ -3486,5 +3600,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_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, BroadcastResource, 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, FileKept, FileKind, FileLinkCount, 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, 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 };

package/index.js

@@ -6,8 +6,20 @@ const BROADCAST_STATUSES = {
     CANCELLED: 'cancelled',
     FAILED: 'failed'
 };
+const BROADCAST_RECIPIENT_FILTERS = {
+    PENDING: 'pending',
+    SENT: 'sent',
+    DELIVERED: 'delivered',
+    OPENED: 'opened',
+    NOT_OPENED: 'not_opened',
+    CLICKED: 'clicked',
+    BOUNCED: 'bounced',
+    COMPLAINED: 'complained',
+    FAILED: 'failed',
+    UNSUBSCRIBED: 'unsubscribed'
+};
 
-var version = "0.0.3";
+var version = "0.0.4";
 
 const BUILD_BASE_URL = 'https://api.openemail.uk';
 
@@ -450,6 +462,8 @@ const QUERY_KEYS = {
     REASSIGN_TO: 'reassignTo',
     SOURCE: 'source',
     ADDRESS: 'address',
+    DIRECTION: 'direction',
+    FILTER: 'filter',
     SEARCH: 'search',
     SORT: 'sort',
     PAGE: 'page',
@@ -563,8 +577,10 @@ const SEGMENTS = {
     REVOKE: 'revoke',
     ROTATE: 'rotate',
     ROTATE_SECRET: 'rotate-secret',
+    RECIPIENTS: 'recipients',
     SEND: 'send',
     SENDS: 'sends',
+    STATS: 'stats',
     SNOOZE: 'snooze',
     START: 'start',
     TEST: 'test',
@@ -639,6 +655,8 @@ const API_SCOPES = {
     DRAFTS_WRITE: 'drafts:write',
     THREADS_READ: 'threads:read',
     THREADS_WRITE: 'threads:write',
+    FILES_READ: 'files:read',
+    FILES_WRITE: 'files:write',
     LABELS_READ: 'labels:read',
     LABELS_WRITE: 'labels:write',
     CONTACTS_READ: 'contacts:read',
@@ -700,7 +718,9 @@ const WEBHOOK_EVENTS = {
     DOMAIN_SENDING_CHANGED: 'domain.sending_changed',
     DOMAIN_DELETED: 'domain.deleted',
     SUPPRESSION_ADDED: 'suppression.added',
-    SUPPRESSION_REMOVED: 'suppression.removed'
+    SUPPRESSION_REMOVED: 'suppression.removed',
+    FILE_UPLOADED: 'file.uploaded',
+    FILE_DELETED: 'file.deleted'
 };
 const WEBHOOK_REPLAY_ERROR_CODES = {
     RESOURCE_NOT_FOUND: 'resource_not_found',
@@ -1316,6 +1336,7 @@ const AudienceContactsChildPath = (id, segment) => `${AudienceContactsPath(id)}/
 const AudienceContactPath = (id, email) => `${AudienceContactsPath(id)}/${Segment(email)}`;
 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 WebhookPath = (id) => `${PATHS.WEBHOOKS}/${Segment(id)}`;
 const WebhookChildPath = (id, segment) => `${WebhookPath(id)}/${segment}`;
@@ -1348,6 +1369,7 @@ const MemberInvitationResendPath = (id) => `${MemberInvitationPath(id)}/${SEGMEN
 const SuppressionPath = (id) => `${PATHS.SUPPRESSIONS}/${Segment(id)}`;
 const FilePath = (id) => `${PATHS.FILES}/${Segment(id)}`;
 const FileChildPath = (id, segment) => `${FilePath(id)}/${segment}`;
+const FileLinkPath = (id, linkId) => `${FileChildPath(id, SEGMENTS.LINKS)}/${Segment(linkId)}`;
 const TempInboxPath = (id) => `${PATHS.TEMP_MAIL_INBOXES}/${Segment(id)}`;
 const TempInboxExtendPath = (id) => `${TempInboxPath(id)}/${SEGMENTS.EXTEND}`;
 const TempMessagesPath = (id) => `${TempInboxPath(id)}/${SEGMENTS.MESSAGES}`;
@@ -1510,6 +1532,11 @@ const ToInstant = Instant;
 const ListQuery$a = (options) => ({
     [QUERY_KEYS.AUDIENCE_ID]: options.audienceId
 });
+const RecipientQuery = (options) => ({
+    [QUERY_KEYS.FILTER]: options.filter,
+    [QUERY_KEYS.Q]: options.q
+});
+const RecipientsPath = (id) => BroadcastChildPath(id, SEGMENTS.RECIPIENTS);
 const Broadcasts = (transport) => ({
     preview: (body, options = {}) => transport.request(PATHS.BROADCASTS_PREVIEW, {
         method: HTTP_METHODS.POST,
@@ -1531,6 +1558,21 @@ const Broadcasts = (transport) => ({
     listAll: (options = {}) => CollectAll(transport, PATHS.BROADCASTS, CURSOR_STYLES.CURSOR, options, ListQuery$a(options)),
     iterate: (options = {}) => IteratePages(transport, PATHS.BROADCASTS, CURSOR_STYLES.CURSOR, options, ListQuery$a(options)),
     get: (id, options = {}) => transport.request(BroadcastPath(id), { signal: options.signal, apiKey: options.apiKey }),
+    listRecipients: (id, options = {}) => FetchPage(transport, RecipientsPath(id), CURSOR_STYLES.CURSOR, options, RecipientQuery(options)),
+    listAllRecipients: (id, options = {}) => CollectAll(transport, RecipientsPath(id), CURSOR_STYLES.CURSOR, options, RecipientQuery(options)),
+    iterateRecipients: (id, options = {}) => IteratePages(transport, RecipientsPath(id), CURSOR_STYLES.CURSOR, options, RecipientQuery(options)),
+    getRecipient: (id, emailId, options = {}) => transport.request(BroadcastRecipientPath(id, emailId), {
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    stats: (id, options = {}) => transport.request(BroadcastChildPath(id, SEGMENTS.STATS), {
+        query: {
+            [QUERY_KEYS.GRAIN]: options.grain,
+            [QUERY_KEYS.OFFSET_MINUTES]: options.offsetMinutes
+        },
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     cancel: (id, options = {}) => transport.request(BroadcastChildPath(id, SEGMENTS.CANCEL), {
         method: HTTP_METHODS.POST,
         repeatable: true,
@@ -1779,6 +1821,10 @@ const Emails = (transport) => ({
 const ListQuery$6 = (options) => ({
     [QUERY_KEYS.Q]: options.q,
     [QUERY_KEYS.KIND]: options.kind,
+    [QUERY_KEYS.DIRECTION]: options.direction,
+    [QUERY_KEYS.ADDRESS]: options.address,
+    [QUERY_KEYS.SINCE]: ToInstant(options.since),
+    [QUERY_KEYS.UNTIL]: ToInstant(options.until),
     [QUERY_KEYS.SORT]: options.sort
 });
 const UploadName = (options) => {
@@ -1811,6 +1857,18 @@ const Files = (transport) => ({
     listLinks: (id, options = {}) => FetchPage(transport, FileChildPath(id, SEGMENTS.LINKS), CURSOR_STYLES.CURSOR, options),
     listAllLinks: (id, options = {}) => CollectAll(transport, FileChildPath(id, SEGMENTS.LINKS), CURSOR_STYLES.CURSOR, options),
     iterateLinks: (id, options = {}) => IteratePages(transport, FileChildPath(id, SEGMENTS.LINKS), CURSOR_STYLES.CURSOR, options),
+    createLink: (id, options = {}) => transport.request(FileChildPath(id, SEGMENTS.LINKS), {
+        method: HTTP_METHODS.POST,
+        body: options.domain ? { domain: options.domain } : {},
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    revokeLink: (id, linkId, options = {}) => transport.request(FileLinkPath(id, linkId), {
+        method: HTTP_METHODS.DELETE,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     upload: (data, options) => transport.request(PATHS.FILES, {
         method: HTTP_METHODS.POST,
         query: { [QUERY_KEYS.FILENAME]: UploadName(options) },
@@ -2788,4 +2846,4 @@ const resolveLanguage = ResolveLanguage;
 const languageByCode = LanguageByCode;
 const isRtlLanguage = IsRtlLanguage;
 
-export { API_SCOPES, 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, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openemail/sdk",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "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.",