@trycourier/courier 6.6.0 → 6.7.0-alpha2

package/api/resources/users/resources/tokens/types/PatchUserTokenOpts.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/users/resources/tokens/types/ProviderKey.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ProviderKey = "firebase-fcm" | "apn" | "expo" | "onesignal";
-export declare const ProviderKey: {
-    readonly FirebaseFcm: "firebase-fcm";
-    readonly Apn: "apn";
-    readonly Expo: "expo";
-    readonly Onesignal: "onesignal";
-};

package/api/resources/users/resources/tokens/types/ProviderKey.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProviderKey = void 0;
-exports.ProviderKey = {
-    FirebaseFcm: "firebase-fcm",
-    Apn: "apn",
-    Expo: "expo",
-    Onesignal: "onesignal",
-};

package/api/resources/users/resources/tokens/types/PutUserTokenOpts.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../../../index";
-export interface PutUserTokenOpts {
-    user_id: string;
-    token: Courier.users.UserToken;
-}

package/api/resources/users/resources/tokens/types/PutUserTokenOpts.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/users/resources/tokens/types/PutUserTokensOpts.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../../../index";
-export interface PutUserTokensOpts {
-    user_id: string;
-    tokens: Courier.users.UserToken[];
-}

package/api/resources/users/resources/tokens/types/PutUserTokensOpts.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/users/resources/tokens/types/TokenStatus.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type TokenStatus = "active" | "unknown" | "failed" | "revoked";
-export declare const TokenStatus: {
-    readonly Active: "active";
-    readonly Unknown: "unknown";
-    readonly Failed: "failed";
-    readonly Revoked: "revoked";
-};

package/api/resources/users/resources/tokens/types/TokenStatus.js

@@ -1,12 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenStatus = void 0;
-exports.TokenStatus = {
-    Active: "active",
-    Unknown: "unknown",
-    Failed: "failed",
-    Revoked: "revoked",
-};

package/api/resources/users/resources/tokens/types/Tracking.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface Tracking {
-    /** The operating system version */
-    os_version?: string;
-    /** The IP address of the device */
-    ip?: string;
-    /** The latitude of the device */
-    lat?: string;
-    /** The longitude of the device */
-    long?: string;
-}

package/api/resources/users/resources/tokens/types/Tracking.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/users/resources/tokens/types/UserToken.d.ts

@@ -1,17 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Courier from "../../../../../index";
-export interface UserToken {
-    /** Full body of the token. Must match token in URL. */
-    token?: string;
-    provider_key: Courier.users.ProviderKey;
-    /** ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to disable expiration. */
-    expiry_date?: Courier.users.ExpiryDate;
-    /** Properties sent to the provider along with the token */
-    properties?: any;
-    /** Information about the device the token is associated with. */
-    device?: Courier.users.Device;
-    /** Information about the device the token is associated with. */
-    tracking?: Courier.users.Tracking;
-}

package/api/resources/users/resources/tokens/types/UserToken.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/users/resources/tokens/types/index.d.ts

@@ -1,16 +0,0 @@
-export * from "./ProviderKey";
-export * from "./TokenStatus";
-export * from "./PatchOp";
-export * from "./Device";
-export * from "./Tracking";
-export * from "./UserToken";
-export * from "./GetUserTokenResponse";
-export * from "./PutUserTokensOpts";
-export * from "./PutUserTokenOpts";
-export * from "./PatchUserTokenOpts";
-export * from "./PatchOperation";
-export * from "./GetUserTokenOpts";
-export * from "./GetUserTokensOpts";
-export * from "./DeleteUserTokenOpts";
-export * from "./ExpiryDate";
-export * from "./GetAllTokensResponse";

package/api/resources/users/resources/tokens/types/index.js

@@ -1,32 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ProviderKey"), exports);
-__exportStar(require("./TokenStatus"), exports);
-__exportStar(require("./PatchOp"), exports);
-__exportStar(require("./Device"), exports);
-__exportStar(require("./Tracking"), exports);
-__exportStar(require("./UserToken"), exports);
-__exportStar(require("./GetUserTokenResponse"), exports);
-__exportStar(require("./PutUserTokensOpts"), exports);
-__exportStar(require("./PutUserTokenOpts"), exports);
-__exportStar(require("./PatchUserTokenOpts"), exports);
-__exportStar(require("./PatchOperation"), exports);
-__exportStar(require("./GetUserTokenOpts"), exports);
-__exportStar(require("./GetUserTokensOpts"), exports);
-__exportStar(require("./DeleteUserTokenOpts"), exports);
-__exportStar(require("./ExpiryDate"), exports);
-__exportStar(require("./GetAllTokensResponse"), exports);

package/api/types/SendMessageResponse.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface SendMessageResponse {
-    /**
-     * A successful call to `POST /send` returns a `202` status code along with a `requestId` in the response body.
-     *
-     * For send requests that have a single recipient, the `requestId` is assigned to the derived message as its message_id. Therefore the `requestId` can be supplied to the Message's API for single recipient messages.
-     *
-     * For send requests that have multiple recipients (accounts, audiences, lists, etc.), Courier assigns a unique id to each derived message as its `message_id`. Therefore the `requestId` cannot be supplied to the Message's API for single-recipient messages.
-     */
-    requestId: string;
-}

package/api/types/SendMessageResponse.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./SendMessageResponse";

package/api/types/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./SendMessageResponse"), exports);

package/core/auth/BasicAuth.d.ts

@@ -1,8 +0,0 @@
-export interface BasicAuth {
-    username: string;
-    password: string;
-}
-export declare const BasicAuth: {
-    toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;
-    fromAuthorizationHeader: (header: string) => BasicAuth;
-};

package/core/auth/BasicAuth.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BasicAuth = void 0;
-const js_base64_1 = require("js-base64");
-const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
-exports.BasicAuth = {
-    toAuthorizationHeader: (basicAuth) => {
-        if (basicAuth == null) {
-            return undefined;
-        }
-        const token = js_base64_1.Base64.encode(`${basicAuth.username}:${basicAuth.password}`);
-        return `Basic ${token}`;
-    },
-    fromAuthorizationHeader: (header) => {
-        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
-        const decoded = js_base64_1.Base64.decode(credentials);
-        const [username, password] = decoded.split(":", 2);
-        if (username == null || password == null) {
-            throw new Error("Invalid basic auth");
-        }
-        return {
-            username,
-            password,
-        };
-    },
-};

package/core/auth/BearerToken.d.ts

@@ -1,5 +0,0 @@
-export type BearerToken = string;
-export declare const BearerToken: {
-    toAuthorizationHeader: (token: BearerToken | undefined) => string | undefined;
-    fromAuthorizationHeader: (header: string) => BearerToken;
-};

package/core/auth/BearerToken.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BearerToken = void 0;
-const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
-exports.BearerToken = {
-    toAuthorizationHeader: (token) => {
-        if (token == null) {
-            return undefined;
-        }
-        return `Bearer ${token}`;
-    },
-    fromAuthorizationHeader: (header) => {
-        return header.replace(BEARER_AUTH_HEADER_PREFIX, "").trim();
-    },
-};

package/core/auth/index.d.ts

@@ -1,2 +0,0 @@
-export { BasicAuth } from "./BasicAuth";
-export { BearerToken } from "./BearerToken";

package/core/auth/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BearerToken = exports.BasicAuth = void 0;
-var BasicAuth_1 = require("./BasicAuth");
-Object.defineProperty(exports, "BasicAuth", { enumerable: true, get: function () { return BasicAuth_1.BasicAuth; } });
-var BearerToken_1 = require("./BearerToken");
-Object.defineProperty(exports, "BearerToken", { enumerable: true, get: function () { return BearerToken_1.BearerToken; } });

package/core/fetcher/APIResponse.d.ts

@@ -1,20 +0,0 @@
-import { RawResponse } from "./RawResponse";
-/**
- * The response of an API call.
- * It is a successful response or a failed response.
- */
-export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
-export interface SuccessfulResponse<T> {
-    ok: true;
-    body: T;
-    /**
-     * @deprecated Use `rawResponse` instead
-     */
-    headers?: Record<string, any>;
-    rawResponse: RawResponse;
-}
-export interface FailedResponse<T> {
-    ok: false;
-    error: T;
-    rawResponse: RawResponse;
-}

package/core/fetcher/APIResponse.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/core/fetcher/Fetcher.d.ts

@@ -1,39 +0,0 @@
-import { APIResponse } from "./APIResponse";
-export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
-export declare namespace Fetcher {
-    interface Args {
-        url: string;
-        method: string;
-        contentType?: string;
-        headers?: Record<string, string | undefined>;
-        queryParameters?: Record<string, string | string[] | object | object[] | null>;
-        body?: unknown;
-        timeoutMs?: number;
-        maxRetries?: number;
-        withCredentials?: boolean;
-        abortSignal?: AbortSignal;
-        requestType?: "json" | "file" | "bytes";
-        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer";
-        duplex?: "half";
-    }
-    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
-    interface FailedStatusCodeError {
-        reason: "status-code";
-        statusCode: number;
-        body: unknown;
-    }
-    interface NonJsonError {
-        reason: "non-json";
-        statusCode: number;
-        rawBody: string;
-    }
-    interface TimeoutError {
-        reason: "timeout";
-    }
-    interface UnknownError {
-        reason: "unknown";
-        errorMessage: string;
-    }
-}
-export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
-export declare const fetcher: FetchFunction;

package/core/fetcher/Fetcher.js

@@ -1,107 +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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetcher = void 0;
-exports.fetcherImpl = fetcherImpl;
-const json_1 = require("../json");
-const RawResponse_1 = require("./RawResponse");
-const createRequestUrl_1 = require("./createRequestUrl");
-const getFetchFn_1 = require("./getFetchFn");
-const getRequestBody_1 = require("./getRequestBody");
-const getResponseBody_1 = require("./getResponseBody");
-const makeRequest_1 = require("./makeRequest");
-const requestWithRetries_1 = require("./requestWithRetries");
-function fetcherImpl(args) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const headers = {};
-        if (args.body !== undefined && args.contentType != null) {
-            headers["Content-Type"] = args.contentType;
-        }
-        if (args.headers != null) {
-            for (const [key, value] of Object.entries(args.headers)) {
-                if (value != null) {
-                    headers[key] = value;
-                }
-            }
-        }
-        const url = (0, createRequestUrl_1.createRequestUrl)(args.url, args.queryParameters);
-        const requestBody = yield (0, getRequestBody_1.getRequestBody)({
-            body: args.body,
-            type: args.requestType === "json" ? "json" : "other",
-        });
-        const fetchFn = yield (0, getFetchFn_1.getFetchFn)();
-        try {
-            const response = yield (0, requestWithRetries_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
-                return (0, makeRequest_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
-            }), args.maxRetries);
-            const responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
-            if (response.status >= 200 && response.status < 400) {
-                return {
-                    ok: true,
-                    body: responseBody,
-                    headers: response.headers,
-                    rawResponse: (0, RawResponse_1.toRawResponse)(response),
-                };
-            }
-            else {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "status-code",
-                        statusCode: response.status,
-                        body: responseBody,
-                    },
-                    rawResponse: (0, RawResponse_1.toRawResponse)(response),
-                };
-            }
-        }
-        catch (error) {
-            if (args.abortSignal != null && args.abortSignal.aborted) {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "unknown",
-                        errorMessage: "The user aborted a request",
-                    },
-                    rawResponse: RawResponse_1.abortRawResponse,
-                };
-            }
-            else if (error instanceof Error && error.name === "AbortError") {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "timeout",
-                    },
-                    rawResponse: RawResponse_1.abortRawResponse,
-                };
-            }
-            else if (error instanceof Error) {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "unknown",
-                        errorMessage: error.message,
-                    },
-                    rawResponse: RawResponse_1.unknownRawResponse,
-                };
-            }
-            return {
-                ok: false,
-                error: {
-                    reason: "unknown",
-                    errorMessage: (0, json_1.toJson)(error),
-                },
-                rawResponse: RawResponse_1.unknownRawResponse,
-            };
-        }
-    });
-}
-exports.fetcher = fetcherImpl;

package/core/fetcher/Headers.d.ts

@@ -1,2 +0,0 @@
-declare let Headers: typeof globalThis.Headers;
-export { Headers };

package/core/fetcher/Headers.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Headers = void 0;
-let Headers;
-if (typeof globalThis.Headers !== "undefined") {
-    exports.Headers = Headers = globalThis.Headers;
-}
-else {
-    exports.Headers = Headers = class Headers {
-        constructor(init) {
-            this.headers = new Map();
-            if (init) {
-                if (init instanceof Headers) {
-                    init.forEach((value, key) => this.append(key, value));
-                }
-                else if (Array.isArray(init)) {
-                    for (const [key, value] of init) {
-                        if (typeof key === "string" && typeof value === "string") {
-                            this.append(key, value);
-                        }
-                        else {
-                            throw new TypeError("Each header entry must be a [string, string] tuple");
-                        }
-                    }
-                }
-                else {
-                    for (const [key, value] of Object.entries(init)) {
-                        if (typeof value === "string") {
-                            this.append(key, value);
-                        }
-                        else {
-                            throw new TypeError("Header values must be strings");
-                        }
-                    }
-                }
-            }
-        }
-        append(name, value) {
-            const key = name.toLowerCase();
-            const existing = this.headers.get(key) || [];
-            this.headers.set(key, [...existing, value]);
-        }
-        delete(name) {
-            const key = name.toLowerCase();
-            this.headers.delete(key);
-        }
-        get(name) {
-            const key = name.toLowerCase();
-            const values = this.headers.get(key);
-            return values ? values.join(", ") : null;
-        }
-        has(name) {
-            const key = name.toLowerCase();
-            return this.headers.has(key);
-        }
-        set(name, value) {
-            const key = name.toLowerCase();
-            this.headers.set(key, [value]);
-        }
-        forEach(callbackfn, thisArg) {
-            const boundCallback = thisArg ? callbackfn.bind(thisArg) : callbackfn;
-            this.headers.forEach((values, key) => boundCallback(values.join(", "), key, this));
-        }
-        getSetCookie() {
-            return this.headers.get("set-cookie") || [];
-        }
-        *entries() {
-            for (const [key, values] of this.headers.entries()) {
-                yield [key, values.join(", ")];
-            }
-        }
-        *keys() {
-            yield* this.headers.keys();
-        }
-        *values() {
-            for (const values of this.headers.values()) {
-                yield values.join(", ");
-            }
-        }
-        [Symbol.iterator]() {
-            return this.entries();
-        }
-    };
-}

package/core/fetcher/HttpResponsePromise.d.ts

@@ -1,58 +0,0 @@
-import { WithRawResponse } from "./RawResponse";
-/**
- * A promise that returns the parsed response and lets you retrieve the raw response too.
- */
-export declare class HttpResponsePromise<T> extends Promise<T> {
-    private innerPromise;
-    private unwrappedPromise;
-    private constructor();
-    /**
-     * Creates an `HttpResponsePromise` from a function that returns a promise.
-     *
-     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
-     * @param args - Arguments to pass to the function.
-     * @returns An `HttpResponsePromise` instance.
-     */
-    static fromFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T>(fn: F, ...args: Parameters<F>): HttpResponsePromise<T>;
-    /**
-     * Creates a function that returns an `HttpResponsePromise` from a function that returns a promise.
-     *
-     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
-     * @returns A function that returns an `HttpResponsePromise` instance.
-     */
-    static interceptFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T = Awaited<ReturnType<F>>["data"]>(fn: F): (...args: Parameters<F>) => HttpResponsePromise<T>;
-    /**
-     * Creates an `HttpResponsePromise` from an existing promise.
-     *
-     * @param promise - A promise resolving to a `WithRawResponse` object.
-     * @returns An `HttpResponsePromise` instance.
-     */
-    static fromPromise<T>(promise: Promise<WithRawResponse<T>>): HttpResponsePromise<T>;
-    /**
-     * Creates an `HttpResponsePromise` from an executor function.
-     *
-     * @param executor - A function that takes resolve and reject callbacks to create a promise.
-     * @returns An `HttpResponsePromise` instance.
-     */
-    static fromExecutor<T>(executor: (resolve: (value: WithRawResponse<T>) => void, reject: (reason?: unknown) => void) => void): HttpResponsePromise<T>;
-    /**
-     * Creates an `HttpResponsePromise` from a resolved result.
-     *
-     * @param result - A `WithRawResponse` object to resolve immediately.
-     * @returns An `HttpResponsePromise` instance.
-     */
-    static fromResult<T>(result: WithRawResponse<T>): HttpResponsePromise<T>;
-    private unwrap;
-    /** @inheritdoc */
-    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
-    /** @inheritdoc */
-    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
-    /** @inheritdoc */
-    finally(onfinally?: (() => void) | null): Promise<T>;
-    /**
-     * Retrieves the data and raw response.
-     *
-     * @returns A promise resolving to a `WithRawResponse` object.
-     */
-    withRawResponse(): Promise<WithRawResponse<T>>;
-}