@trycourier/courier 5.7.0 → 6.0.0

package/lib/token-management/types.d.ts

@@ -1,56 +0,0 @@
-export interface IUserToken {
-    token: string;
-    provider_key: "firebase-fcm" | "apn" | "expo" | "onesignal";
-    /** ISO 8601 Date. Set to false to disable expiration */
-    expiry_date?: string | false;
-    /** Additional properties to be passed to provider or to be generically associated with the token */
-    properties?: {
-        [key: string]: any;
-    };
-    device?: {
-        app_id?: string;
-        ad_id?: string;
-        device_id?: string;
-        platform?: string;
-        manufacturer?: string;
-        model?: string;
-    };
-    tracking?: {
-        os_version?: string;
-        ip?: string;
-        lat?: string;
-        long?: string;
-    };
-}
-export interface IGetUserTokenResponse extends IUserToken {
-    status: "active" | "unknown" | "failed" | "revoked";
-    status_reason?: string;
-}
-export interface IPutUserTokensOpts {
-    user_id: string;
-    tokens: IUserToken[];
-}
-export interface IPutUserTokenOpts {
-    user_id: string;
-    token: IUserToken;
-}
-export interface IPatchUserTokenOpts {
-    user_id: string;
-    token: string;
-    patch: Array<{
-        op: "replace" | "add" | "remove" | "copy" | "move" | "test";
-        path: string;
-        value?: string;
-    }>;
-}
-export interface IGetUserTokenOpts {
-    user_id: string;
-    token: string;
-}
-export interface IGetUserTokensOpts {
-    user_id: string;
-}
-export interface IDeleteUserTokenOpts {
-    user_id: string;
-    token: string;
-}

package/lib/types.d.ts

@@ -1,355 +0,0 @@
-import { ICourierClientAudiences } from "./audiences/types";
-import { auditEvents } from "./audit-events";
-import { ICourierClientAutomations } from "./automations/types";
-import { ICourierClientBulk } from "./bulk/types";
-import { ICourierAuthIssueTokenParameters, ICourierAuthIssueTokenResponse } from "./issue-token/types";
-import { ICourierClientLists, ICourierList, ICourierRecipientSubscriptionsResponse } from "./lists/types";
-import { ICourierClientNotifications } from "./notifications/types";
-import { ICourierClientPreferences, IRecipientPreferences } from "./preferences/types";
-import { Message } from "./send/types";
-import { ICourierClientTenants } from "./tenants/types";
-import { tokenManagement } from "./token-management";
-import { users } from "./users";
-export interface IInitHttpClientOptions {
-    baseUrl: string;
-    version: string;
-    authorizationToken: string;
-}
-export declare type HttpMethodClient = <T>(url: string, body?: object, config?: {
-    params?: Record<string, string>;
-    idempotencyKey?: string;
-    idempotencyExpiry?: number;
-}) => Promise<{
-    data: T;
-}>;
-export interface IHttpClient {
-    post: HttpMethodClient;
-    patch: HttpMethodClient;
-    put: HttpMethodClient;
-    get: HttpMethodClient;
-    delete: HttpMethodClient;
-}
-export interface ICourierClientOptions {
-    baseUrl?: string;
-    authorizationToken?: string;
-}
-export interface ICourierClientConfiguration {
-    httpClient: IHttpClient;
-}
-export interface ICourierSendParameters {
-    eventId: string;
-    recipientId: string;
-    data?: object;
-    brand?: string;
-    preferences?: IRecipientPreferences;
-    profile?: object;
-    override?: object;
-}
-export interface ICourierSendMessageParameters {
-    message: Message;
-}
-export interface ICourierSendConfig {
-    idempotencyKey?: string;
-    idempotencyExpiry?: number;
-}
-export interface ICourierSendResponse {
-    messageId: string;
-}
-export interface ICourierSendMessageResponse {
-    requestId: string;
-}
-export interface ICourierSendParams {
-    event: string;
-    data?: object;
-    brand?: string;
-    override?: object;
-}
-export interface ICourierSendListParams extends ICourierSendParams {
-    list: string;
-}
-export interface ICourierSendPatternParams extends ICourierSendParams {
-    pattern: string;
-}
-export declare type ICourierSendListOrPatternParams = ICourierSendListParams | ICourierSendPatternParams;
-export interface ICourierProfilePutParameters {
-    recipientId: string;
-    profile: object;
-}
-export interface ICourierProfilePutResponse {
-    status: "SUCCESS";
-}
-export interface ICourierProfilePostParameters {
-    recipientId: string;
-    profile: object;
-}
-export declare type List = Omit<ICourierList, "id"> & {
-    listId: string;
-    preferences?: IRecipientPreferences;
-};
-export interface ICourierProfileListsPostParameters {
-    recipientId: string;
-    lists: List[];
-}
-export interface ICourierProfilePostConfig {
-    idempotencyKey?: string;
-    idempotencyExpiry?: number;
-}
-export interface ICourierProfilePostResponse {
-    status: "SUCCESS";
-}
-export interface ICourierProfileGetParameters {
-    recipientId: string;
-}
-export interface ICourierProfileGetResponse {
-    profile: object;
-}
-export interface ICourierMessagesGetParameters {
-    cursor?: string;
-    eventId?: string;
-    listId?: string;
-    messageId?: string;
-    notificationId?: string;
-    recipientId?: string;
-    status?: string | string[];
-    tags?: string | string[];
-    traceId?: string;
-}
-export interface ICourierMessagesGetResponse {
-    paging: ICourierPaging;
-    results: Array<{
-        enqueued?: number;
-        event?: string;
-        id: string;
-        notification?: string;
-        recipient: string;
-        sent?: number;
-        status: string;
-        tags?: string[];
-    }>;
-}
-export interface ICourierMessageCancelResponse {
-    canceledAt: number;
-    event: string;
-    id: string;
-    recipient: string;
-    status: string;
-    clicked?: number;
-    delivered?: number;
-    enqueued?: number;
-    error?: string;
-    jobId?: string;
-    listId?: string;
-    listMessageId?: string;
-    notification?: string;
-    opened?: number;
-    runId?: string;
-    sent?: number;
-}
-export interface ICourierMessageGetResponse {
-    clicked?: number;
-    delivered?: number;
-    enqueued?: number;
-    error?: string;
-    event?: string;
-    id: string;
-    idempotencyKey?: string;
-    listId?: string;
-    listMessageId?: string;
-    notification?: string;
-    opened?: number;
-    providers?: Array<{
-        channel: {
-            key?: string;
-            name?: string;
-            template: string;
-        };
-        clicked?: number;
-        delivered?: number;
-        error?: string;
-        provider: string;
-        reference?: {
-            [key: string]: string | number;
-        };
-        sent: number;
-        status: MessageStatus;
-    }>;
-    reason?: MessageStatusReason;
-    reasonCode?: MessageStatusReasonCode;
-    reasonDetails?: string;
-    recipient: string;
-    runId?: string;
-    sent?: number;
-    status: MessageStatus;
-}
-export declare type MessageStatus = "CLICKED" | "DELIVERED" | "ENQUEUED" | "FILTERED" | "OPENED" | "SENT" | "SIMULATED" | "UNDELIVERABLE" | "UNMAPPED" | "UNROUTABLE";
-export declare type MessageHistoryType = MessageStatus | "DELIVERING" | "FILTERED" | "MAPPED" | "PROFILE_LOADED" | "RENDERED";
-export declare type MessageStatusReason = "BOUNCED" | "FAILED" | "FILTERED" | "NO_CHANNELS" | "NO_PROVIDERS" | "OPT_IN_REQUIRED" | "PROVIDER_ERROR" | "UNPUBLISHED" | "UNSUBSCRIBED";
-export declare type MessageStatusReasonCode = "HARD" | "SOFT";
-export interface IMessageHistory<T extends MessageHistoryType> {
-    ts: number;
-    type: T;
-}
-export interface IEnqueuedMessageHistory extends IMessageHistory<"ENQUEUED"> {
-    data?: string | {
-        [key: string]: string;
-    };
-    event: string;
-    profile?: {
-        [key: string]: any;
-    };
-    override?: {
-        [key: string]: any;
-    };
-    recipient: string;
-}
-export interface IMappedMessageHistory extends IMessageHistory<"MAPPED"> {
-    event_id: string;
-    notification_id: string;
-}
-export interface IProfileLoadedMessageHistory extends IMessageHistory<"PROFILE_LOADED"> {
-    merged_profile?: {
-        [key: string]: any;
-    };
-    received_profile?: {
-        [key: string]: any;
-    };
-    stored_profile?: {
-        [key: string]: any;
-    };
-}
-export interface IRenderedMessageHistory extends IRoutedMessageHistory<"RENDERED"> {
-    output: {
-        [key: string]: string;
-    };
-}
-export interface IUnroutableMessageHistory extends IMessageHistory<"UNROUTABLE"> {
-    reason: MessageStatusReason;
-}
-export interface IUndeliverableMessageHistory extends IMessageHistory<"UNDELIVERABLE">, Partial<Omit<IRoutedMessageHistory<"UNDELIVERABLE">, "ts" | "type">> {
-    reason: MessageStatusReason;
-    reasonCode?: MessageStatusReasonCode;
-}
-export declare type RoutedMessageHistoryTypes = Extract<MessageHistoryType, "CLICKED" | "DELIVERED" | "DELIVERING" | "OPENED" | "RENDERED" | "SENT" | "UNDELIVERABLE">;
-export interface IRoutedMessageHistory<T extends RoutedMessageHistoryTypes> extends IMessageHistory<T> {
-    channel: {
-        id: string;
-        label?: string;
-    };
-    integration: {
-        id: string;
-        provider: string;
-    };
-}
-export interface IDeliveredMessageHistory extends IRoutedMessageHistory<"DELIVERED"> {
-    reference: {
-        [key: string]: string;
-    };
-}
-export interface IProviderErrorMessageHistory extends IRoutedMessageHistory<"UNDELIVERABLE"> {
-    error_message: string;
-}
-export interface ICourierMessageGetHistoryResponse {
-    results: Array<IEnqueuedMessageHistory | IMappedMessageHistory | IProfileLoadedMessageHistory | IRenderedMessageHistory | IRoutedMessageHistory<RoutedMessageHistoryTypes> | IDeliveredMessageHistory | IProviderErrorMessageHistory | IUndeliverableMessageHistory | IUnroutableMessageHistory>;
-}
-export interface IApiMessageOutputItem {
-    channel: string;
-    channel_id: string;
-    content: {
-        html?: string;
-        title?: string;
-        blocks?: any[];
-        body?: string;
-        subject?: string;
-        text?: string;
-    };
-}
-export interface ICourierMessageGetOutputResponse {
-    results: IApiMessageOutputItem[];
-}
-export interface ICourierProfileDeleteParameters {
-    recipientId: string;
-}
-interface ICourierBrandSettings {
-    colors?: {
-        primary: string;
-        secondary: string;
-        tertiary: string;
-    };
-    email?: {
-        footer: object;
-        header: object;
-    };
-}
-interface ICourierBrandSnippets {
-    items: Array<{
-        format: string;
-        name: string;
-        value: string;
-    }>;
-}
-export interface ICourierBrand {
-    created: number;
-    id?: string;
-    name: string;
-    published: number;
-    settings: ICourierBrandSettings;
-    updated: number;
-    snippets?: ICourierBrandSnippets;
-    version: string;
-}
-export interface ICourierPaging {
-    cursor?: string;
-    more: boolean;
-}
-export interface ICourierBrandParameters {
-    id?: string;
-    name: string;
-    settings: ICourierBrandSettings;
-    snippets?: ICourierBrandSnippets;
-}
-export interface ICourierBrandPostConfig {
-    idempotencyKey?: string;
-    idempotencyExpiry?: number;
-}
-export interface ICourierBrandPutParameters extends ICourierBrandParameters {
-    id: string;
-}
-export interface ICourierBrandGetAllResponse {
-    paging: ICourierPaging;
-    results: ICourierBrand[];
-}
-export declare type SendResponse<T extends ICourierSendParameters | ICourierSendMessageParameters> = T extends ICourierSendParameters ? ICourierSendResponse : ICourierSendMessageResponse;
-export interface ICourierClient {
-    addRecipientToLists: (params: ICourierProfileListsPostParameters) => Promise<ICourierProfilePostResponse>;
-    tenants: ICourierClientTenants;
-    audiences: ICourierClientAudiences;
-    auditEvents: ReturnType<typeof auditEvents>;
-    automations: ICourierClientAutomations;
-    bulk: ICourierClientBulk;
-    cancelMessage: (messageId: string) => Promise<ICourierMessageCancelResponse>;
-    createBrand: (params: ICourierBrandParameters, config?: ICourierBrandPostConfig) => Promise<ICourierBrand>;
-    deleteBrand: (brandId: string) => Promise<void>;
-    getBrand: (brandId: string) => Promise<ICourierBrand>;
-    getBrands: (params?: {
-        cursor: string;
-    }) => Promise<ICourierBrandGetAllResponse>;
-    getMessage: (messageId: string) => Promise<ICourierMessageGetResponse>;
-    getMessageHistory: (messageId: string) => Promise<ICourierMessageGetHistoryResponse>;
-    getMessageOutput: (messageId: string) => Promise<ICourierMessageGetOutputResponse>;
-    getMessages: (params?: ICourierMessagesGetParameters) => Promise<ICourierMessagesGetResponse>;
-    getProfile: (params: ICourierProfileGetParameters) => Promise<ICourierProfileGetResponse>;
-    deleteProfile: (params: ICourierProfileDeleteParameters) => Promise<void>;
-    getRecipientSubscriptions: (params: ICourierProfileGetParameters) => Promise<ICourierRecipientSubscriptionsResponse>;
-    lists: ICourierClientLists;
-    mergeProfile: (params: ICourierProfilePostParameters, config?: ICourierProfilePostConfig) => Promise<ICourierProfilePostResponse>;
-    notifications: ICourierClientNotifications;
-    preferences: ICourierClientPreferences;
-    removeRecipientFromAllLists: (params: ICourierProfileGetParameters) => Promise<ICourierProfilePostResponse>;
-    replaceBrand: (params: ICourierBrandPutParameters) => Promise<ICourierBrand>;
-    replaceProfile: (params: ICourierProfilePutParameters) => Promise<ICourierProfilePutResponse>;
-    send: <T extends ICourierSendParameters | ICourierSendMessageParameters>(params: T, config?: ICourierSendConfig) => Promise<SendResponse<T>>;
-    tokenManagement: ReturnType<typeof tokenManagement>;
-    users: ReturnType<typeof users>;
-    issueToken: (params: ICourierAuthIssueTokenParameters) => Promise<ICourierAuthIssueTokenResponse>;
-}
-export {};

package/lib/users/index.d.ts

@@ -1,9 +0,0 @@
-import { ICourierClientConfiguration } from "../types";
-import { ITopicPreference, IUser, IUserAccount } from "./types";
-export declare const users: (options: ICourierClientConfiguration) => {
-    getUserPreferenceByTopic: (userId: string, topicId: string) => Promise<ITopicPreference>;
-    getUserPreferenceByTopics: (userId: string) => Promise<object>;
-    put: (id: string, user: IUser) => Promise<void>;
-    putAccounts: (id: string, accounts: IUserAccount[]) => Promise<void>;
-    putUserPreferenceByTopic: (userId: string, topicId: string, topic: Omit<ITopicPreference, "topic_id" | "topic_name">) => Promise<void>;
-};

package/lib/users/index.js

@@ -1,111 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.users = void 0;
-var put = function (options) {
-    return function (id, user) { return __awaiter(void 0, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.put("/users/" + id, user)];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-};
-var putAccounts = function (options) {
-    return function (id, accounts) { return __awaiter(void 0, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.put("/users/" + id + "/accounts", accounts)];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-};
-var putUserPreferenceByTopic = function (options) {
-    return function (userId, topicId, topic) { return __awaiter(void 0, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.put("/users/" + userId + "/preferences/" + topicId, {
-                        topic: topic,
-                    })];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-};
-var getUserPreferenceByTopic = function (options) {
-    return function (userId, topicId) { return __awaiter(void 0, void 0, void 0, function () {
-        var res;
-        var _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/users/" + userId + "/preferences/" + topicId)];
-                case 1:
-                    res = _b.sent();
-                    return [2 /*return*/, (_a = res.data) === null || _a === void 0 ? void 0 : _a.topic];
-            }
-        });
-    }); };
-};
-var getUserPreferenceByTopics = function (options) {
-    return function (userId) { return __awaiter(void 0, void 0, void 0, function () {
-        var res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/users/" + userId + "/preferences")];
-                case 1:
-                    res = _a.sent();
-                    return [2 /*return*/, res.data];
-            }
-        });
-    }); };
-};
-exports.users = function (options) { return ({
-    getUserPreferenceByTopic: getUserPreferenceByTopic(options),
-    getUserPreferenceByTopics: getUserPreferenceByTopics(options),
-    put: put(options),
-    putAccounts: putAccounts(options),
-    putUserPreferenceByTopic: putUserPreferenceByTopic(options),
-}); };

package/lib/users/types.d.ts

@@ -1,39 +0,0 @@
-export interface IUserAccount {
-    account_id: string;
-    profile: Record<string, any>;
-}
-export interface IUser {
-    accounts: IUserAccount[];
-    profile: Record<string, any>;
-}
-export declare type ChannelClassification = "direct_message" | "email" | "push" | "sms" | "webhook" | "inbox";
-export interface ITopicPreference {
-    /**
-     * Should contain unique items.
-     */
-    custom_routing?: ChannelClassification[];
-    default_status: "OPTED_IN" | "OPTED_OUT";
-    has_custom_routing?: boolean;
-    status: "OPTED_IN" | "OPTED_OUT";
-    topic_id: string;
-    topic_name: string;
-}
-interface IPagingInfo {
-    cursor: string;
-    more: boolean;
-}
-export interface IGetTopicPreferencesResponse {
-    topic: ITopicPreference;
-}
-export interface IGetTopicsResponse {
-    paging: IPagingInfo;
-    items: ITopicPreference[];
-}
-export interface ICourierClientUsers {
-    getUserPreferenceByTopic: (userId: string, topicId: string) => Promise<IGetTopicPreferencesResponse>;
-    getUserPreferenceByTopics: (userId: string) => Promise<IGetTopicsResponse>;
-    put: (id: string, user: IUser) => Promise<void>;
-    putAccounts: (id: string, accounts: IUserAccount[]) => Promise<void>;
-    putUserPreferenceByTopic: (userId: string, topicId: string, topic: Omit<ITopicPreference, "topic_id" | "topic_name">) => Promise<void>;
-}
-export {};