@trycourier/courier 5.7.0 → 6.0.0

package/lib/send/types.d.ts

@@ -1,389 +0,0 @@
-export interface IBrandSnippet {
-    format: "handlebars";
-    name: string;
-    value: string;
-}
-export interface IBrandSnippets {
-    items: IBrandSnippet[];
-}
-export interface IBrandColors {
-    primary?: string;
-    secondary?: string;
-    tertiary?: string;
-}
-interface IBrandTemplate {
-    backgroundColor?: string;
-    blocksBackgroundColor?: string;
-    enabled: boolean;
-    footer?: string;
-    head?: string;
-    header?: string;
-    width?: string;
-}
-export interface IBrandTemplateOverride extends IBrandTemplate {
-    mjml?: IBrandTemplate;
-    footerBackgroundColor?: string;
-    footerFullWidth?: boolean;
-}
-export interface IBrandSettingsSocialPresence {
-    inheritDefault?: boolean;
-    facebook?: {
-        url: string;
-    };
-    instagram?: {
-        url: string;
-    };
-    linkedin?: {
-        url: string;
-    };
-    medium?: {
-        url: string;
-    };
-    twitter?: {
-        url: string;
-    };
-}
-export interface IBrandSettingsEmail {
-    templateOverride?: IBrandTemplateOverride;
-    head?: {
-        inheritDefault: boolean;
-        content?: string;
-    };
-    footer?: {
-        content?: object;
-        inheritDefault?: boolean;
-        markdown?: string;
-        social?: IBrandSettingsSocialPresence;
-    };
-    header?: {
-        inheritDefault?: boolean;
-        barColor?: string;
-        logo?: {
-            href?: string;
-            image?: string;
-        };
-    };
-}
-export interface IBrandSettingsInApp {
-    borderRadius?: string;
-    disableMessageIcon?: boolean;
-    fontFamily?: string;
-    placement?: "top" | "bottom" | "left" | "right";
-    widgetBackground?: {
-        topColor?: string;
-        bottomColor?: string;
-    };
-    colors?: {
-        invertHeader?: boolean;
-        invertButtons?: boolean;
-    };
-    icons?: {
-        bell?: string;
-        message?: string;
-    };
-    preferences?: {
-        templateIds: string[];
-    };
-}
-export declare type IActionButtonStyle = "button" | "link";
-export declare type IAlignment = "center" | "left" | "right" | "full";
-export interface ElementalContent {
-    version: "2022-01-01";
-    brand?: any;
-    elements: ElementalNode[];
-}
-export declare type ElementalNode = ElementalTextNode | ElementalMetaNode | ElementalChannelNode | ElementalImageNode | ElementalActionNode | ElementalDividerNode | ElementalGroupNode | ElementalQuoteNode;
-export interface ElementalTextNode extends ElementalBaseNode {
-    type: "text";
-    content: string;
-    format?: "markdown";
-    locales?: {
-        [locale: string]: {
-            content: string;
-        };
-    };
-}
-export interface ElementalMetaNode extends ElementalBaseNode {
-    type: "meta";
-    title?: string;
-}
-export interface ElementalChannelNode extends ElementalBaseNode {
-    type: "channel";
-    channel: string;
-    elements?: ElementalNode[];
-    raw?: {
-        [templateName: string]: any;
-    };
-}
-export interface ElementalImageNode extends ElementalBaseNode {
-    type: "image";
-    src: string;
-    href?: string;
-    align?: IAlignment;
-    altText?: string;
-    width?: string;
-}
-export interface ElementalActionNode extends ElementalBaseNode {
-    type: "action";
-    content: string;
-    href: string;
-    actionId?: string;
-    style?: IActionButtonStyle;
-    align?: IAlignment;
-    backgroundColor?: string;
-    locales?: {
-        [locale: string]: {
-            content: string;
-        };
-    };
-}
-export interface ElementalDividerNode extends ElementalBaseNode {
-    type: "divider";
-    color?: string;
-}
-export interface ElementalGroupNode extends ElementalBaseNode {
-    type: "group";
-    elements: ElementalNode[];
-}
-export interface ElementalQuoteNode extends ElementalBaseNode {
-    type: "quote";
-    content: string;
-    align?: IAlignment;
-    borderColor?: string;
-    textStyle?: "text" | "h1" | "h2" | "subtext";
-    locales?: {
-        [locale: string]: {
-            content: string;
-        };
-    };
-}
-interface ElementalBaseNode {
-    type: string;
-    channels?: string[];
-    ref?: string;
-    if?: string;
-    loop?: string;
-}
-export interface MessageContext {
-    tenant_id?: string;
-}
-export interface MessageData extends Record<string, any> {
-}
-export interface MessageDelay {
-    duration?: number;
-}
-export declare type RuleType = "snooze" | "channel_preferences" | "status";
-export interface IRule<T extends RuleType> {
-    type: T;
-}
-export interface ISnoozeRule extends IRule<"snooze"> {
-    start?: string;
-    until: string;
-}
-export declare type Rule = ISnoozeRule;
-export declare type PreferenceStatus = "OPTED_IN" | "OPTED_OUT" | "REQUIRED";
-export declare type ChannelClassification = "direct_message" | "email" | "push";
-export interface IPreference {
-    status: PreferenceStatus;
-    rules?: Rule[];
-    channel_preferences?: Array<{
-        channel: ChannelClassification;
-    }>;
-    source?: "subscription" | "list" | "recipient";
-}
-export interface IPreferences {
-    [id: string]: IPreference;
-}
-export interface IProfilePreferences {
-    categories?: IPreferences;
-    notifications: IPreferences;
-    templateId?: string;
-}
-interface InvalidListRecipient {
-    user_id: string;
-    list_pattern: string;
-}
-declare type ListRecipientType = Record<string, unknown> & {
-    [key in keyof InvalidListRecipient]?: never;
-};
-export interface ListFilter {
-    operator: "MEMBER_OF";
-    path: "account_id";
-    value: string;
-}
-export interface ListRecipient extends ListRecipientType {
-    list_id?: string;
-    data?: MessageData;
-    filters?: ListFilter[];
-}
-interface InvalidListPatternRecipient {
-    user_id: string;
-    list_id: string;
-}
-declare type ListPatternRecipientType = Record<string, unknown> & {
-    [key in keyof InvalidListPatternRecipient]?: never;
-};
-export interface ListPatternRecipient extends ListPatternRecipientType {
-    list_pattern?: string;
-    data?: MessageData;
-}
-interface InvalidUserRecipient {
-    list_id: string;
-    list_pattern: string;
-}
-declare type UserRecipientType = Record<string, unknown> & {
-    [key in keyof InvalidUserRecipient]?: never;
-};
-export interface AudienceFilter {
-    operator: "MEMBER_OF";
-    path: "account_id";
-    value: string;
-}
-export interface AudienceRecipient {
-    audience_id: string;
-    data?: MessageData;
-    filters?: AudienceFilter[];
-}
-export interface UserRecipient extends UserRecipientType {
-    account_id?: string;
-    context?: MessageContext;
-    data?: MessageData;
-    email?: string;
-    locale?: string;
-    user_id?: string;
-    phone_number?: string;
-    preferences?: IProfilePreferences;
-    tenant_id?: string;
-}
-export declare type Recipient = AudienceRecipient | ListRecipient | ListPatternRecipient | UserRecipient;
-export declare type MessageRecipient = Recipient | Recipient[];
-export interface ElementalContentSugar {
-    body?: string;
-    title?: string;
-}
-export interface Timeout {
-    provider?: {
-        [provider: string]: number;
-    };
-    channel?: {
-        [channel: string]: number;
-    };
-    message?: number;
-    escalation?: number;
-    criteria?: "no-escalation" | "delivered" | "viewed" | "engaged";
-}
-export declare type Content = ElementalContentSugar | ElementalContent;
-export interface BaseMessage {
-    brand_id?: string;
-    channels?: MessageChannels;
-    context?: MessageContext;
-    data?: MessageData;
-    delay?: MessageDelay;
-    metadata?: MessageMetadata;
-    providers?: MessageProviders;
-    routing?: Routing;
-    timeout?: Timeout;
-    to: MessageRecipient;
-}
-interface TrackingOverride {
-    open: boolean;
-}
-export interface MessageProviders {
-    [key: string]: {
-        override?: Record<string, any>;
-        if?: string;
-        timeouts?: number;
-    };
-}
-export interface MessageChannelEmailOverride {
-    attachments?: Record<string, any>[];
-    bcc?: string;
-    brand?: {
-        snippets?: IBrandSnippets;
-        settings?: {
-            colors?: IBrandColors;
-            email?: IBrandSettingsEmail;
-        };
-    };
-    cc?: string;
-    from?: string;
-    html?: string;
-    reply_to?: string;
-    subject?: string;
-    text?: string;
-    tracking?: TrackingOverride;
-}
-export interface MessageChannelPushOverride {
-    body?: string;
-    brand?: {
-        snippets?: IBrandSnippets;
-        settings?: {
-            colors?: IBrandColors;
-            inapp?: IBrandSettingsInApp;
-        };
-    };
-    click_action?: string;
-    data?: Record<string, any>;
-    icon?: string;
-    title?: string;
-}
-export interface MessageChannels {
-    [key: string]: {
-        brand_id?: string;
-        providers?: string[];
-        routing_method?: "all" | "single";
-        if?: string;
-        timeouts?: {
-            provider?: number;
-            channel?: number;
-        };
-        override?: MessageChannelEmailOverride | MessageChannelPushOverride;
-        metadata?: {
-            utm?: UTM;
-        };
-    };
-}
-export interface Routing {
-    method: "all" | "single";
-    channels: RoutingChannel[];
-}
-export declare type RoutingChannel = RoutingStrategyChannel | RoutingStrategyProvider | string;
-export interface RoutingStrategyChannel<T = Record<string, any>> {
-    channel: string;
-    config?: T;
-    method?: "all" | "single";
-    providers?: (RoutingStrategyProvider | string)[];
-    if?: string;
-}
-export interface RoutingStrategyProvider<T = Record<string, any>> {
-    name: string;
-    config?: T;
-    if?: string;
-    metadata?: {
-        utm?: UTM;
-    };
-}
-export interface UTM {
-    source?: string;
-    medium?: string;
-    campaign?: string;
-    term?: string;
-    content?: string;
-}
-export interface MessageMetadata {
-    event?: string;
-    tags?: string[];
-    utm?: UTM;
-    trace_id?: string;
-}
-export interface ContentMessage extends BaseMessage {
-    content: Content;
-}
-export interface TemplateMessage extends BaseMessage {
-    template: string;
-}
-export declare type Message = ContentMessage | TemplateMessage;
-export interface RequestV2 {
-    message: Message;
-}
-export {};

package/lib/tenants/index.d.ts

@@ -1,8 +0,0 @@
-import { ICourierClientConfiguration } from "../types";
-import * as TenantTypes from "./types";
-export declare const tenants: (options: ICourierClientConfiguration) => {
-    delete: (tenantId: string) => Promise<void>;
-    get: (tenantId: string) => Promise<TenantTypes.ITenant>;
-    listTenants: (listOptions?: TenantTypes.ITenantListOptions | undefined) => Promise<TenantTypes.IPaginatedResult<TenantTypes.ITenant>>;
-    put: (tenant: Omit<TenantTypes.ITenant, "type">) => Promise<TenantTypes.ITenant>;
-};

package/lib/tenants/index.js

@@ -1,99 +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.tenants = void 0;
-var deleteTenant = function (options) { return function (tenantId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, options.httpClient.delete("/tenants/" + tenantId)];
-            case 1:
-                _a.sent();
-                return [2 /*return*/];
-        }
-    });
-}); }; };
-var getTenant = function (options) {
-    return function (tenantId) { return __awaiter(void 0, void 0, void 0, function () {
-        var response;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/tenants/" + tenantId)];
-                case 1:
-                    response = _a.sent();
-                    return [2 /*return*/, response.data];
-            }
-        });
-    }); };
-};
-var listTenants = function (options) {
-    return function (listOptions) { return __awaiter(void 0, void 0, void 0, function () {
-        var response;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.get("/tenants", undefined, {
-                        params: {
-                            cursor: (listOptions === null || listOptions === void 0 ? void 0 : listOptions.cursor) || "",
-                            limit: (listOptions === null || listOptions === void 0 ? void 0 : listOptions.limit) || "20"
-                        }
-                    })];
-                case 1:
-                    response = _a.sent();
-                    return [2 /*return*/, response.data];
-            }
-        });
-    }); };
-};
-var putTenant = function (options) {
-    return function (tenant) { return __awaiter(void 0, void 0, void 0, function () {
-        var response;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.put("/tenants/" + tenant.id, tenant)];
-                case 1:
-                    response = _a.sent();
-                    return [2 /*return*/, response.data];
-            }
-        });
-    }); };
-};
-exports.tenants = function (options) { return ({
-    delete: deleteTenant(options),
-    get: getTenant(options),
-    listTenants: listTenants(options),
-    put: putTenant(options)
-}); };

package/lib/tenants/types.d.ts

@@ -1,36 +0,0 @@
-export interface ITenant {
-    brand_id?: string;
-    id: string;
-    name: string;
-    parent_tenant_id?: string;
-    default_preferences?: {
-        items: Array<{
-            id: string;
-            status: "OPTED_IN" | "OPTED_OUT" | "REQUIRED";
-            type: "subscription_topic";
-        }>;
-    };
-    properties?: {
-        [key: string]: any;
-    };
-    user_profile?: Record<string, any>;
-    type: "tenant";
-}
-export interface IPaginatedResult<T> {
-    cursor?: string;
-    has_more: boolean;
-    items: T[];
-    next_url?: string;
-    type: "list";
-    url: string;
-}
-export interface ITenantListOptions {
-    cursor?: string;
-    limit?: string;
-}
-export interface ICourierClientTenants {
-    delete: (id: string) => Promise<void>;
-    get: (id: string) => Promise<ITenant>;
-    listTenants: (options?: ITenantListOptions) => Promise<IPaginatedResult<ITenant>>;
-    put: (tenant: Omit<ITenant, "type">) => Promise<ITenant>;
-}

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

@@ -1,12 +0,0 @@
-import { ICourierClientConfiguration } from "../types";
-import { IDeleteUserTokenOpts, IGetUserTokenOpts, IGetUserTokenResponse, IGetUserTokensOpts, IPatchUserTokenOpts, IPutUserTokenOpts, IPutUserTokensOpts } from "./types";
-export declare const tokenManagement: (options: ICourierClientConfiguration) => {
-    deleteUserToken: (opts: IDeleteUserTokenOpts) => Promise<void>;
-    getUserToken: (opts: IGetUserTokenOpts) => Promise<IGetUserTokenResponse>;
-    getUserTokens: (opts: IGetUserTokensOpts) => Promise<{
-        tokens: IGetUserTokenResponse[];
-    }>;
-    patchUserToken: (opts: IPatchUserTokenOpts) => Promise<void>;
-    putUserToken: (opts: IPutUserTokenOpts) => Promise<void>;
-    putUserTokens: (opts: IPutUserTokensOpts) => Promise<void>;
-};

package/lib/token-management/index.js

@@ -1,127 +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.tokenManagement = void 0;
-/** Associate a group of tokens with the supplied :user_id. Will overwrite any existing tokens associated with that user. */
-var putUserTokens = function (options) {
-    return function (opts) { 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/" + opts.user_id + "/tokens", {
-                        tokens: opts.tokens
-                    })];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-};
-/** Associate a token with the supplied :user_id. If token exists it's value will be replaced with the passed body, otherwise the token will be created. */
-var putUserToken = function (options) {
-    return function (opts) { 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/" + opts.user_id + "/tokens/" + opts.token.token, opts.token)];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-};
-var patchUserToken = function (options) {
-    return function (opts) { return __awaiter(void 0, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.patch("/users/" + opts.user_id + "/tokens/" + opts.token, { patch: opts.patch })];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-};
-var getUserToken = function (options) {
-    return function (opts) { 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/" + opts.user_id + "/tokens/" + opts.token)];
-                case 1:
-                    res = _a.sent();
-                    return [2 /*return*/, res.data];
-            }
-        });
-    }); };
-};
-var getUserTokens = function (options) {
-    return function (opts) { 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/" + opts.user_id + "/tokens")];
-                case 1:
-                    res = _a.sent();
-                    return [2 /*return*/, res.data];
-            }
-        });
-    }); };
-};
-var deleteUserToken = function (options) {
-    return function (opts) { return __awaiter(void 0, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, options.httpClient.delete("/users/" + opts.user_id + "/tokens/" + opts.token)];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-};
-exports.tokenManagement = function (options) {
-    return {
-        deleteUserToken: deleteUserToken(options),
-        getUserToken: getUserToken(options),
-        getUserTokens: getUserTokens(options),
-        patchUserToken: patchUserToken(options),
-        putUserToken: putUserToken(options),
-        putUserTokens: putUserTokens(options)
-    };
-};