@openemail/sdk 0.0.3 → 0.0.5

package/index.cjs

@@ -2,6 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+const AUDIENCE_MEMBER_STATUSES = {
+    SUBSCRIBED: 'subscribed',
+    UNSUBSCRIBED: 'unsubscribed'
+};
+
 const BROADCAST_STATUSES = {
     SCHEDULED: 'scheduled',
     QUEUED: 'queued',
@@ -10,8 +15,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.5";
 
 const BUILD_BASE_URL = 'https://api.openemail.uk';
 
@@ -78,6 +95,18 @@ const CONTACT_PHOTO_TYPES = {
     GIF: 'image/gif'
 };
 
+const DOMAIN_RECORD_STATUSES = {
+    FOUND: 'found',
+    MISSING: 'missing'
+};
+const DOMAIN_DMARC_STAGES = {
+    MISSING: 'missing',
+    INVALID: 'invalid',
+    MONITOR: 'monitor',
+    QUARANTINE: 'quarantine',
+    REJECT: 'reject'
+};
+
 const MESSAGE_ENCRYPTION_FORMATS = {
     PGP_MIME: 'pgp-mime',
     PGP_SIGNED: 'pgp-signed',
@@ -143,6 +172,10 @@ const FILE_USAGES = {
     LINKED: 'linked',
     SCHEDULED: 'scheduled'
 };
+const FILE_VISIBILITIES = {
+    PUBLIC: 'public',
+    PRIVATE: 'private'
+};
 
 const HTTP_METHODS = {
     GET: 'GET',
@@ -454,6 +487,8 @@ const QUERY_KEYS = {
     REASSIGN_TO: 'reassignTo',
     SOURCE: 'source',
     ADDRESS: 'address',
+    DIRECTION: 'direction',
+    FILTER: 'filter',
     SEARCH: 'search',
     SORT: 'sort',
     PAGE: 'page',
@@ -567,8 +602,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',
@@ -577,6 +614,7 @@ const SEGMENTS = {
     TRASH: 'trash',
     UNSNOOZE: 'unsnooze',
     UPLOAD: 'upload',
+    VERIFY: 'verify',
     VERSIONS: 'versions'
 };
 
@@ -643,6 +681,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 +744,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,7 +1362,11 @@ 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 DomainChildPath = (id, segment) => `${DomainPath(id)}/${segment}`;
+const DomainAddressesPath = (id) => `${DomainPath(id)}/${SEGMENTS.ADDRESSES}`;
+const DomainAddressPath = (id, addressId) => `${DomainAddressesPath(id)}/${Segment(addressId)}`;
 const WebhookPath = (id) => `${PATHS.WEBHOOKS}/${Segment(id)}`;
 const WebhookChildPath = (id, segment) => `${WebhookPath(id)}/${segment}`;
 const WebhookDeliveryPath = (id, deliveryId) => `${WebhookChildPath(id, SEGMENTS.DELIVERIES)}/${Segment(deliveryId)}`;
@@ -1352,6 +1398,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}`;
@@ -1392,7 +1439,8 @@ const Addresses = (transport) => {
 const MemberQuery = (options) => ({
     [QUERY_KEYS.Q]: options.q,
     [QUERY_KEYS.SOURCE]: options.source,
-    [QUERY_KEYS.SORT]: options.sort
+    [QUERY_KEYS.SORT]: options.sort,
+    [QUERY_KEYS.STATUS]: options.statuses?.length ? options.statuses.join(LIST_SEPARATOR) : undefined
 });
 const GrowthQuery = (options) => ({
     [QUERY_KEYS.AUDIENCE_IDS]: options.audienceIds?.join(LIST_SEPARATOR),
@@ -1514,6 +1562,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 +1588,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,
@@ -1690,12 +1758,52 @@ const Domains = (transport) => ({
     listAll: (options = {}) => CollectAll(transport, PATHS.DOMAINS, CURSOR_STYLES.CURSOR, options),
     iterate: (options = {}) => IteratePages(transport, PATHS.DOMAINS, CURSOR_STYLES.CURSOR, options),
     get: (id, options = {}) => transport.request(DomainPath(id), { signal: options.signal, apiKey: options.apiKey }),
+    create: (body, options = {}) => transport.request(PATHS.DOMAINS, {
+        method: HTTP_METHODS.POST,
+        body,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    verify: (id, options = {}) => transport.request(DomainChildPath(id, SEGMENTS.VERIFY), {
+        method: HTTP_METHODS.POST,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
     update: (id, patch, options = {}) => transport.request(DomainPath(id), {
         method: HTTP_METHODS.PATCH,
         body: patch,
         repeatable: true,
         signal: options.signal,
         apiKey: options.apiKey
+    }),
+    delete: (id, options = {}) => transport.request(DomainPath(id), {
+        method: HTTP_METHODS.DELETE,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    listAddresses: (id, options = {}) => FetchPage(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    listAllAddresses: (id, options = {}) => CollectAll(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    iterateAddresses: (id, options = {}) => IteratePages(transport, DomainAddressesPath(id), CURSOR_STYLES.CURSOR, options),
+    createAddress: (id, body, options = {}) => transport.request(DomainAddressesPath(id), {
+        method: HTTP_METHODS.POST,
+        body,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    getAddress: (id, addressId, options = {}) => transport.request(DomainAddressPath(id, addressId), { signal: options.signal, apiKey: options.apiKey }),
+    updateAddress: (id, addressId, patch, options = {}) => transport.request(DomainAddressPath(id, addressId), {
+        method: HTTP_METHODS.PATCH,
+        body: patch,
+        repeatable: true,
+        signal: options.signal,
+        apiKey: options.apiKey
+    }),
+    deleteAddress: (id, addressId, options = {}) => transport.request(DomainAddressPath(id, addressId), {
+        method: HTTP_METHODS.DELETE,
+        signal: options.signal,
+        apiKey: options.apiKey
     })
 });
 
@@ -1783,6 +1891,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 +1927,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,15 +2917,20 @@ const languageByCode = LanguageByCode;
 const isRtlLanguage = IsRtlLanguage;
 
 exports.API_SCOPES = API_SCOPES;
+exports.AUDIENCE_MEMBER_STATUSES = AUDIENCE_MEMBER_STATUSES;
+exports.BROADCAST_RECIPIENT_FILTERS = BROADCAST_RECIPIENT_FILTERS;
 exports.BROADCAST_STATUSES = BROADCAST_STATUSES;
 exports.CONTACT_BLOCK_LISTS = CONTACT_BLOCK_LISTS;
 exports.CONTACT_PHOTO_TYPES = CONTACT_PHOTO_TYPES;
 exports.CONTACT_THREAD_SORTS = CONTACT_THREAD_SORTS;
+exports.DOMAIN_DMARC_STAGES = DOMAIN_DMARC_STAGES;
+exports.DOMAIN_RECORD_STATUSES = DOMAIN_RECORD_STATUSES;
 exports.ERROR_TYPES = ERROR_TYPES;
 exports.FILE_DIRECTIONS = FILE_DIRECTIONS;
 exports.FILE_KINDS = FILE_KINDS;
 exports.FILE_SORTS = FILE_SORTS;
 exports.FILE_USAGES = FILE_USAGES;
+exports.FILE_VISIBILITIES = FILE_VISIBILITIES;
 exports.LANGUAGES = LANGUAGES;
 exports.MESSAGE_ENCRYPTION_FORMATS = MESSAGE_ENCRYPTION_FORMATS;
 exports.OpenEmail = OpenEmail;