@openemail/sdk 0.0.2 → 0.0.3

package/index.cjs

@@ -11,7 +11,7 @@ const BROADCAST_STATUSES = {
     FAILED: 'failed'
 };
 
-var version = "0.0.2";
+var version = "0.0.3";
 
 const BUILD_BASE_URL = 'https://api.openemail.uk';
 
@@ -19,6 +19,7 @@ const DEFAULTS = {
     BASE_URL: BUILD_BASE_URL,
     MAX_RETRIES: 2,
     TIMEOUT_MS: 30_000,
+    UPLOAD_TIMEOUT_MS: 600_000,
     USER_AGENT: `openemail-sdk/${version}`
 };
 const BROWSER_REFUSAL = [
@@ -51,6 +52,7 @@ const CLIENT_MESSAGES = {
     BASE_URL_SHAPE: 'is not a usable base URL. Pass an origin such as "https://api.openemail.uk", or the http origin of a server you run yourself.',
     NO_FETCH: 'No global fetch is available. Pass one as { fetch }, or run on Node 20+, Bun, Deno, Cloudflare Workers or a browser.',
     EMPTY_SEGMENT: 'An id must not be empty.',
+    FILENAME_REQUIRED: 'A file name is required. Pass it as { filename }, the name the file is stored and downloaded under.',
     DOT_SEGMENT: 'is not a usable id: a path segment made only of dots is removed by URL parsers, so the request would reach a different endpoint.'
 };
 
@@ -132,7 +134,14 @@ const FILE_KINDS = {
 };
 const FILE_DIRECTIONS = {
     INBOUND: 'inbound',
-    OUTBOUND: 'outbound'
+    OUTBOUND: 'outbound',
+    UPLOADED: 'uploaded'
+};
+const FILE_USAGES = {
+    RECEIVED: 'received',
+    SENT: 'sent',
+    LINKED: 'linked',
+    SCHEDULED: 'scheduled'
 };
 
 const HTTP_METHODS = {
@@ -466,7 +475,8 @@ const QUERY_KEYS = {
     KEY_IDS: 'keyIds',
     SINCE: 'since',
     UNTIL: 'until',
-    FAILED_ONLY: 'failedOnly'
+    FAILED_ONLY: 'failedOnly',
+    FILENAME: 'filename'
 };
 const LIST_SEPARATOR = ',';
 
@@ -517,6 +527,8 @@ const PATHS = {
     MEMBERS_INVITATIONS: '/members/invitations',
     SUPPRESSIONS: '/suppressions',
     FILES: '/files',
+    FILES_STATS: '/files/stats',
+    FILES_BATCH_DELETE: '/files/batch-delete',
     TEMP_MAIL_DOMAINS: '/temp-mail/domains',
     TEMP_MAIL_INBOXES: '/temp-mail/inboxes'
 };
@@ -1148,7 +1160,7 @@ class Transport {
         const repeatable = options.repeatable ?? RETRYABLE_METHODS.has(method);
         let attempt = 0;
         for (;;) {
-            const outcome = await this.attempt(url, method, headers, body, options.signal, options.binary === true);
+            const outcome = await this.attempt(url, method, headers, body, options.signal, options.binary === true, options.timeoutMs ?? this.timeoutMs);
             if (outcome instanceof OpenEmailNetworkError) {
                 if (options.signal?.aborted || !repeatable || attempt >= this.maxRetries)
                     throw outcome;
@@ -1195,13 +1207,13 @@ class Transport {
             headers[HEADER_KEYS.IDEMPOTENCY_KEY] = options.idempotencyKey ?? IdempotencyKey();
         return headers;
     }
-    async attempt(url, method, headers, body, signal, binary) {
-        const deadline = Deadline(this.timeoutMs, signal);
+    async attempt(url, method, headers, body, signal, binary, timeoutMs) {
+        const deadline = Deadline(timeoutMs, signal);
         const Failure = (error, fallback) => {
             if (signal?.aborted)
                 return new OpenEmailNetworkError('Request aborted by the caller.', error);
             if (deadline.timedOut())
-                return new OpenEmailNetworkError(`Request timed out after ${this.timeoutMs}ms.`, error, true);
+                return new OpenEmailNetworkError(`Request timed out after ${timeoutMs}ms.`, error, true);
             return new OpenEmailNetworkError(`${fallback}: ${Describe(error)}`, error);
         };
         try {
@@ -1773,11 +1785,28 @@ const ListQuery$6 = (options) => ({
     [QUERY_KEYS.KIND]: options.kind,
     [QUERY_KEYS.SORT]: options.sort
 });
+const UploadName = (options) => {
+    const filename = typeof options?.filename === 'string' ? options.filename.trim() : '';
+    if (!filename)
+        throw new Error(CLIENT_MESSAGES.FILENAME_REQUIRED);
+    return filename;
+};
+const UploadType = (data, options) => {
+    if (options.contentType)
+        return options.contentType;
+    return typeof Blob !== 'undefined' && data instanceof Blob && data.type ? data.type : undefined;
+};
+const UploadTimeout = (transport, options) => {
+    if (options.timeoutMs !== undefined)
+        return options.timeoutMs;
+    return transport.timeoutMs > 0 ? Math.max(transport.timeoutMs, DEFAULTS.UPLOAD_TIMEOUT_MS) : transport.timeoutMs;
+};
 const Files = (transport) => ({
     list: (options = {}) => FetchPage(transport, PATHS.FILES, CURSOR_STYLES.CURSOR, options, ListQuery$6(options)),
     listAll: (options = {}) => CollectAll(transport, PATHS.FILES, CURSOR_STYLES.CURSOR, options, ListQuery$6(options)),
     iterate: (options = {}) => IteratePages(transport, PATHS.FILES, CURSOR_STYLES.CURSOR, options, ListQuery$6(options)),
     get: (id, options = {}) => transport.request(FilePath(id), { signal: options.signal, apiKey: options.apiKey }),
+    stats: (options = {}) => transport.request(PATHS.FILES_STATS, { signal: options.signal, apiKey: options.apiKey }),
     download: (id, options = {}) => transport.request(FileChildPath(id, SEGMENTS.CONTENT), {
         binary: true,
         signal: options.signal,
@@ -1786,10 +1815,25 @@ 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),
+    upload: (data, options) => transport.request(PATHS.FILES, {
+        method: HTTP_METHODS.POST,
+        query: { [QUERY_KEYS.FILENAME]: UploadName(options) },
+        raw: data,
+        contentType: UploadType(data, options),
+        timeoutMs: UploadTimeout(transport, options),
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     delete: (id, options = {}) => transport.request(FilePath(id), {
         method: HTTP_METHODS.DELETE,
         signal: options.signal,
         apiKey: options.apiKey
+    }),
+    deleteMany: (ids, options = {}) => transport.request(PATHS.FILES_BATCH_DELETE, {
+        method: HTTP_METHODS.POST,
+        body: { ids },
+        signal: options.signal,
+        apiKey: options.apiKey
     })
 });
 
@@ -2757,6 +2801,7 @@ 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.LANGUAGES = LANGUAGES;
 exports.MESSAGE_ENCRYPTION_FORMATS = MESSAGE_ENCRYPTION_FORMATS;
 exports.OpenEmail = OpenEmail;

package/index.d.cts

@@ -132,6 +132,7 @@ type AudienceCreate = {
 type AudienceGrowthBucket = {
     bucket: string;
     added: number;
+    unsubscribed: number;
 };
 
 declare const HIT_KINDS: {
@@ -160,15 +161,19 @@ type AudienceGrowthSeries = {
     name: string;
     builtin: boolean;
     total: number;
+    subscribed: number;
     before: number;
     added: number;
+    unsubscribed: number;
     buckets: Array<AudienceGrowthBucket>;
 };
 
 type AudienceGrowthTotals = {
     contacts: number;
+    subscribed: number;
     memberships: number;
     added: number;
+    unsubscribed: number;
     lists: number;
     busiest: string | null;
 };
@@ -937,11 +942,14 @@ declare const Files: (transport: Transport) => {
     listAll: (options?: FileListOptions) => Promise<Array<FileResource>>;
     iterate: (options?: FileListOptions) => AsyncGenerator<FileResource, void, undefined>;
     get: (id: string, options?: RequestScope) => Promise<FileResource>;
+    stats: (options?: RequestScope) => Promise<FileStatsResource>;
     download: (id: string, options?: RequestScope) => Promise<Uint8Array>;
     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>;
+    upload: (data: RawBody, options: FileUploadOptions) => Promise<FileResource>;
     delete: (id: string, options?: RequestScope) => Promise<DeletedFileResource>;
+    deleteMany: (ids: Array<string>, options?: RequestScope) => Promise<FileBatchDeleteResource>;
 };
 
 declare const Imports: (transport: Transport) => {
@@ -1220,6 +1228,7 @@ type RequestOptions = {
     repeatable?: boolean;
     accept?: string;
     binary?: boolean;
+    timeoutMs?: number;
 };
 
 type SendScope = RequestScope & {
@@ -1572,6 +1581,12 @@ type DeletedFileResource = {
     deleted: true;
 };
 
+type FileAddressCount = {
+    address: string;
+    files: number;
+    bytes: number;
+};
+
 declare const FILE_SORTS: {
     readonly NEWEST: "newest";
     readonly OLDEST: "oldest";
@@ -1588,12 +1603,52 @@ declare const FILE_KINDS: {
 declare const FILE_DIRECTIONS: {
     readonly INBOUND: "inbound";
     readonly OUTBOUND: "outbound";
+    readonly UPLOADED: "uploaded";
+};
+interface FileUsages {
+    RECEIVED: 'received';
+    SENT: 'sent';
+    LINKED: 'linked';
+    SCHEDULED: 'scheduled';
+}
+type FileUsage = FileUsages[keyof FileUsages];
+declare const FILE_USAGES: FileUsages;
+
+type FileKept = {
+    id: string;
+    filename: string;
+    usage: FileUsage;
+    reason: string;
+};
+
+type FileBatchDeleteResource = {
+    object: 'file_batch_delete';
+    deleted: Array<string>;
+    kept: Array<FileKept>;
+    missing: Array<string>;
+};
+
+type FileCount = {
+    files: number;
+    bytes: number;
+};
+
+type FileDayCount = {
+    day: string;
+    files: number;
+    bytes: number;
 };
 
 type FileDirection = (typeof FILE_DIRECTIONS)[keyof typeof FILE_DIRECTIONS];
 
 type FileKind = (typeof FILE_KINDS)[keyof typeof FILE_KINDS];
 
+type FileLinkCount = {
+    shares: number;
+    downloads: number;
+    lastDownloadAt: string | null;
+};
+
 type FileLinkResource = {
     object: 'file_link';
     id: string;
@@ -1627,9 +1682,35 @@ type FileResource = {
     threadId: string | null;
     messageId: string | null;
     deliveredTo: string | null;
+    usage: FileUsage | null;
+    deletable: boolean;
     createdAt: string;
 };
 
+type FileTypeCount = {
+    mimeType: string;
+    files: number;
+    bytes: number;
+};
+
+type FileStatsResource = {
+    object: 'file_stats';
+    totals: FileCount;
+    received: FileCount;
+    sent: FileCount;
+    uploaded: FileCount;
+    types: Array<FileTypeCount>;
+    byDay: Array<FileDayCount>;
+    addresses: Array<FileAddressCount>;
+    links: FileLinkCount;
+};
+
+type FileUploadOptions = RequestScope & {
+    filename: string;
+    contentType?: string;
+    timeoutMs?: number;
+};
+
 type ImportChunkResource = {
     object: 'import_chunk';
     file: number;
@@ -3326,7 +3407,7 @@ declare class Transport {
     readonly baseUrl: string;
     private readonly fetchImpl;
     private readonly maxRetries;
-    private readonly timeoutMs;
+    readonly timeoutMs: number;
     private readonly userAgent;
     private readonly headers;
     constructor(options: TransportOptions & {
@@ -3405,5 +3486,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, 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, FileDirection, FileKind, FileLinkResource, FileListOptions, FileResource, FileSort, 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_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 };

package/index.d.ts

@@ -132,6 +132,7 @@ type AudienceCreate = {
 type AudienceGrowthBucket = {
     bucket: string;
     added: number;
+    unsubscribed: number;
 };
 
 declare const HIT_KINDS: {
@@ -160,15 +161,19 @@ type AudienceGrowthSeries = {
     name: string;
     builtin: boolean;
     total: number;
+    subscribed: number;
     before: number;
     added: number;
+    unsubscribed: number;
     buckets: Array<AudienceGrowthBucket>;
 };
 
 type AudienceGrowthTotals = {
     contacts: number;
+    subscribed: number;
     memberships: number;
     added: number;
+    unsubscribed: number;
     lists: number;
     busiest: string | null;
 };
@@ -937,11 +942,14 @@ declare const Files: (transport: Transport) => {
     listAll: (options?: FileListOptions) => Promise<Array<FileResource>>;
     iterate: (options?: FileListOptions) => AsyncGenerator<FileResource, void, undefined>;
     get: (id: string, options?: RequestScope) => Promise<FileResource>;
+    stats: (options?: RequestScope) => Promise<FileStatsResource>;
     download: (id: string, options?: RequestScope) => Promise<Uint8Array>;
     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>;
+    upload: (data: RawBody, options: FileUploadOptions) => Promise<FileResource>;
     delete: (id: string, options?: RequestScope) => Promise<DeletedFileResource>;
+    deleteMany: (ids: Array<string>, options?: RequestScope) => Promise<FileBatchDeleteResource>;
 };
 
 declare const Imports: (transport: Transport) => {
@@ -1220,6 +1228,7 @@ type RequestOptions = {
     repeatable?: boolean;
     accept?: string;
     binary?: boolean;
+    timeoutMs?: number;
 };
 
 type SendScope = RequestScope & {
@@ -1572,6 +1581,12 @@ type DeletedFileResource = {
     deleted: true;
 };
 
+type FileAddressCount = {
+    address: string;
+    files: number;
+    bytes: number;
+};
+
 declare const FILE_SORTS: {
     readonly NEWEST: "newest";
     readonly OLDEST: "oldest";
@@ -1588,12 +1603,52 @@ declare const FILE_KINDS: {
 declare const FILE_DIRECTIONS: {
     readonly INBOUND: "inbound";
     readonly OUTBOUND: "outbound";
+    readonly UPLOADED: "uploaded";
+};
+interface FileUsages {
+    RECEIVED: 'received';
+    SENT: 'sent';
+    LINKED: 'linked';
+    SCHEDULED: 'scheduled';
+}
+type FileUsage = FileUsages[keyof FileUsages];
+declare const FILE_USAGES: FileUsages;
+
+type FileKept = {
+    id: string;
+    filename: string;
+    usage: FileUsage;
+    reason: string;
+};
+
+type FileBatchDeleteResource = {
+    object: 'file_batch_delete';
+    deleted: Array<string>;
+    kept: Array<FileKept>;
+    missing: Array<string>;
+};
+
+type FileCount = {
+    files: number;
+    bytes: number;
+};
+
+type FileDayCount = {
+    day: string;
+    files: number;
+    bytes: number;
 };
 
 type FileDirection = (typeof FILE_DIRECTIONS)[keyof typeof FILE_DIRECTIONS];
 
 type FileKind = (typeof FILE_KINDS)[keyof typeof FILE_KINDS];
 
+type FileLinkCount = {
+    shares: number;
+    downloads: number;
+    lastDownloadAt: string | null;
+};
+
 type FileLinkResource = {
     object: 'file_link';
     id: string;
@@ -1627,9 +1682,35 @@ type FileResource = {
     threadId: string | null;
     messageId: string | null;
     deliveredTo: string | null;
+    usage: FileUsage | null;
+    deletable: boolean;
     createdAt: string;
 };
 
+type FileTypeCount = {
+    mimeType: string;
+    files: number;
+    bytes: number;
+};
+
+type FileStatsResource = {
+    object: 'file_stats';
+    totals: FileCount;
+    received: FileCount;
+    sent: FileCount;
+    uploaded: FileCount;
+    types: Array<FileTypeCount>;
+    byDay: Array<FileDayCount>;
+    addresses: Array<FileAddressCount>;
+    links: FileLinkCount;
+};
+
+type FileUploadOptions = RequestScope & {
+    filename: string;
+    contentType?: string;
+    timeoutMs?: number;
+};
+
 type ImportChunkResource = {
     object: 'import_chunk';
     file: number;
@@ -3326,7 +3407,7 @@ declare class Transport {
     readonly baseUrl: string;
     private readonly fetchImpl;
     private readonly maxRetries;
-    private readonly timeoutMs;
+    readonly timeoutMs: number;
     private readonly userAgent;
     private readonly headers;
     constructor(options: TransportOptions & {
@@ -3405,5 +3486,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, 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, FileDirection, FileKind, FileLinkResource, FileListOptions, FileResource, FileSort, 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_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 };

package/index.js

@@ -7,7 +7,7 @@ const BROADCAST_STATUSES = {
     FAILED: 'failed'
 };
 
-var version = "0.0.2";
+var version = "0.0.3";
 
 const BUILD_BASE_URL = 'https://api.openemail.uk';
 
@@ -15,6 +15,7 @@ const DEFAULTS = {
     BASE_URL: BUILD_BASE_URL,
     MAX_RETRIES: 2,
     TIMEOUT_MS: 30_000,
+    UPLOAD_TIMEOUT_MS: 600_000,
     USER_AGENT: `openemail-sdk/${version}`
 };
 const BROWSER_REFUSAL = [
@@ -47,6 +48,7 @@ const CLIENT_MESSAGES = {
     BASE_URL_SHAPE: 'is not a usable base URL. Pass an origin such as "https://api.openemail.uk", or the http origin of a server you run yourself.',
     NO_FETCH: 'No global fetch is available. Pass one as { fetch }, or run on Node 20+, Bun, Deno, Cloudflare Workers or a browser.',
     EMPTY_SEGMENT: 'An id must not be empty.',
+    FILENAME_REQUIRED: 'A file name is required. Pass it as { filename }, the name the file is stored and downloaded under.',
     DOT_SEGMENT: 'is not a usable id: a path segment made only of dots is removed by URL parsers, so the request would reach a different endpoint.'
 };
 
@@ -128,7 +130,14 @@ const FILE_KINDS = {
 };
 const FILE_DIRECTIONS = {
     INBOUND: 'inbound',
-    OUTBOUND: 'outbound'
+    OUTBOUND: 'outbound',
+    UPLOADED: 'uploaded'
+};
+const FILE_USAGES = {
+    RECEIVED: 'received',
+    SENT: 'sent',
+    LINKED: 'linked',
+    SCHEDULED: 'scheduled'
 };
 
 const HTTP_METHODS = {
@@ -462,7 +471,8 @@ const QUERY_KEYS = {
     KEY_IDS: 'keyIds',
     SINCE: 'since',
     UNTIL: 'until',
-    FAILED_ONLY: 'failedOnly'
+    FAILED_ONLY: 'failedOnly',
+    FILENAME: 'filename'
 };
 const LIST_SEPARATOR = ',';
 
@@ -513,6 +523,8 @@ const PATHS = {
     MEMBERS_INVITATIONS: '/members/invitations',
     SUPPRESSIONS: '/suppressions',
     FILES: '/files',
+    FILES_STATS: '/files/stats',
+    FILES_BATCH_DELETE: '/files/batch-delete',
     TEMP_MAIL_DOMAINS: '/temp-mail/domains',
     TEMP_MAIL_INBOXES: '/temp-mail/inboxes'
 };
@@ -1144,7 +1156,7 @@ class Transport {
         const repeatable = options.repeatable ?? RETRYABLE_METHODS.has(method);
         let attempt = 0;
         for (;;) {
-            const outcome = await this.attempt(url, method, headers, body, options.signal, options.binary === true);
+            const outcome = await this.attempt(url, method, headers, body, options.signal, options.binary === true, options.timeoutMs ?? this.timeoutMs);
             if (outcome instanceof OpenEmailNetworkError) {
                 if (options.signal?.aborted || !repeatable || attempt >= this.maxRetries)
                     throw outcome;
@@ -1191,13 +1203,13 @@ class Transport {
             headers[HEADER_KEYS.IDEMPOTENCY_KEY] = options.idempotencyKey ?? IdempotencyKey();
         return headers;
     }
-    async attempt(url, method, headers, body, signal, binary) {
-        const deadline = Deadline(this.timeoutMs, signal);
+    async attempt(url, method, headers, body, signal, binary, timeoutMs) {
+        const deadline = Deadline(timeoutMs, signal);
         const Failure = (error, fallback) => {
             if (signal?.aborted)
                 return new OpenEmailNetworkError('Request aborted by the caller.', error);
             if (deadline.timedOut())
-                return new OpenEmailNetworkError(`Request timed out after ${this.timeoutMs}ms.`, error, true);
+                return new OpenEmailNetworkError(`Request timed out after ${timeoutMs}ms.`, error, true);
             return new OpenEmailNetworkError(`${fallback}: ${Describe(error)}`, error);
         };
         try {
@@ -1769,11 +1781,28 @@ const ListQuery$6 = (options) => ({
     [QUERY_KEYS.KIND]: options.kind,
     [QUERY_KEYS.SORT]: options.sort
 });
+const UploadName = (options) => {
+    const filename = typeof options?.filename === 'string' ? options.filename.trim() : '';
+    if (!filename)
+        throw new Error(CLIENT_MESSAGES.FILENAME_REQUIRED);
+    return filename;
+};
+const UploadType = (data, options) => {
+    if (options.contentType)
+        return options.contentType;
+    return typeof Blob !== 'undefined' && data instanceof Blob && data.type ? data.type : undefined;
+};
+const UploadTimeout = (transport, options) => {
+    if (options.timeoutMs !== undefined)
+        return options.timeoutMs;
+    return transport.timeoutMs > 0 ? Math.max(transport.timeoutMs, DEFAULTS.UPLOAD_TIMEOUT_MS) : transport.timeoutMs;
+};
 const Files = (transport) => ({
     list: (options = {}) => FetchPage(transport, PATHS.FILES, CURSOR_STYLES.CURSOR, options, ListQuery$6(options)),
     listAll: (options = {}) => CollectAll(transport, PATHS.FILES, CURSOR_STYLES.CURSOR, options, ListQuery$6(options)),
     iterate: (options = {}) => IteratePages(transport, PATHS.FILES, CURSOR_STYLES.CURSOR, options, ListQuery$6(options)),
     get: (id, options = {}) => transport.request(FilePath(id), { signal: options.signal, apiKey: options.apiKey }),
+    stats: (options = {}) => transport.request(PATHS.FILES_STATS, { signal: options.signal, apiKey: options.apiKey }),
     download: (id, options = {}) => transport.request(FileChildPath(id, SEGMENTS.CONTENT), {
         binary: true,
         signal: options.signal,
@@ -1782,10 +1811,25 @@ 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),
+    upload: (data, options) => transport.request(PATHS.FILES, {
+        method: HTTP_METHODS.POST,
+        query: { [QUERY_KEYS.FILENAME]: UploadName(options) },
+        raw: data,
+        contentType: UploadType(data, options),
+        timeoutMs: UploadTimeout(transport, options),
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     delete: (id, options = {}) => transport.request(FilePath(id), {
         method: HTTP_METHODS.DELETE,
         signal: options.signal,
         apiKey: options.apiKey
+    }),
+    deleteMany: (ids, options = {}) => transport.request(PATHS.FILES_BATCH_DELETE, {
+        method: HTTP_METHODS.POST,
+        body: { ids },
+        signal: options.signal,
+        apiKey: options.apiKey
     })
 });
 
@@ -2744,4 +2788,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, 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_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.2",
+    "version": "0.0.3",
     "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.",