@tolt/api 0.6.1 → 1.0.0

package/dist/core/pagination/Page.js

@@ -0,0 +1,49 @@
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ * @template R The type of the API response.
+ */
+export class Page {
+    constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }) {
+        this.response = response;
+        this.rawResponse = rawResponse;
+        this.data = getItems(response);
+        this._hasNextPage = hasNextPage;
+        this.getItems = getItems;
+        this.loadNextPage = loadPage;
+    }
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    async getNextPage() {
+        const { data, rawResponse } = await this.loadNextPage(this.response).withRawResponse();
+        this.response = data;
+        this.rawResponse = rawResponse;
+        this.data = this.getItems(this.response);
+        return this;
+    }
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage() {
+        return this._hasNextPage(this.response);
+    }
+    async *iterMessages() {
+        for (const item of this.data) {
+            yield item;
+        }
+        while (this.hasNextPage()) {
+            await this.getNextPage();
+            for (const item of this.data) {
+                yield item;
+            }
+        }
+    }
+    async *[Symbol.asyncIterator]() {
+        for await (const message of this.iterMessages()) {
+            yield message;
+        }
+    }
+}

package/dist/core/pagination/exports.d.ts

@@ -0,0 +1 @@
+export type { Page } from "./Page.js";

package/dist/core/pagination/exports.js

@@ -0,0 +1 @@
+export {};

package/dist/core/pagination/index.d.ts

@@ -0,0 +1 @@
+export { Page } from "./Page.js";

package/dist/core/pagination/index.js

@@ -0,0 +1 @@
+export { Page } from "./Page.js";

package/dist/core/url/encodePathParam.d.ts

@@ -1 +1,3 @@
-export declare function encodePathParam(param: unknown): string;
+export declare function encodePathParam(param: unknown, InvalidPathParameterError?: new (args: {
+    message: string;
+}) => Error): string;

package/dist/core/url/encodePathParam.js

@@ -1,4 +1,4 @@
-export function encodePathParam(param) {
+export function encodePathParam(param, InvalidPathParameterError) {
     if (param === null) {
         return "null";
     }
@@ -14,5 +14,11 @@ export function encodePathParam(param) {
             param = String(param);
             break;
     }
-    return encodeURIComponent(param);
+    const encoded = encodeURIComponent(param);
+    // "." and ".." are dot segments: URL resolution would remove them and send the request to a different path.
+    if (encoded === "." || encoded === "..") {
+        const message = `Invalid path parameter "${encoded}": "." and ".." are not allowed because they change the request path.`;
+        throw InvalidPathParameterError != null ? new InvalidPathParameterError({ message }) : new Error(message);
+    }
+    return encoded;
 }

package/dist/core/utils/index.d.ts

@@ -0,0 +1 @@
+export { setObjectProperty } from "./setObjectProperty.js";

package/dist/core/utils/index.js

@@ -0,0 +1 @@
+export { setObjectProperty } from "./setObjectProperty.js";

package/dist/core/utils/setObjectProperty.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Returns a copy of object with the value at path set. If a portion of path doesn’t exist it’s created.
+ * Each object along path is shallow-copied, so the original object (and any nested objects it
+ * shares with the copy) is never modified. This is inspired by Lodash's set function, but is
+ * simplified to accommodate our use case. For more details, see https://lodash.com/docs/4.17.15#set.
+ *
+ * @param object The object to copy.
+ * @param path The path of the property to set.
+ * @param value The value to set.
+ * @return Returns the updated copy of object.
+ */
+export declare function setObjectProperty<T extends object>(object: T, path: string, value: any): T;

package/dist/core/utils/setObjectProperty.js

@@ -0,0 +1,45 @@
+/**
+ * Returns a copy of object with the value at path set. If a portion of path doesn’t exist it’s created.
+ * Each object along path is shallow-copied, so the original object (and any nested objects it
+ * shares with the copy) is never modified. This is inspired by Lodash's set function, but is
+ * simplified to accommodate our use case. For more details, see https://lodash.com/docs/4.17.15#set.
+ *
+ * @param object The object to copy.
+ * @param path The path of the property to set.
+ * @param value The value to set.
+ * @return Returns the updated copy of object.
+ */
+export function setObjectProperty(object, path, value) {
+    if (object == null) {
+        return object;
+    }
+    const keys = path.split(".");
+    if (keys.length === 0) {
+        // Invalid path; do nothing.
+        return object;
+    }
+    const result = { ...object };
+    let current = result;
+    for (let i = 0; i < keys.length - 1; i++) {
+        const key = keys[i];
+        if (key == null) {
+            // Unreachable.
+            continue;
+        }
+        const next = current[key];
+        if (Array.isArray(next)) {
+            current[key] = [...next];
+        }
+        else {
+            current[key] = next != null && typeof next === "object" ? { ...next } : {};
+        }
+        current = current[key];
+    }
+    const lastKey = keys[keys.length - 1];
+    if (lastKey == null) {
+        // Unreachable.
+        return result;
+    }
+    current[lastKey] = value;
+    return result;
+}

package/dist/environments.d.ts

@@ -1,4 +1,4 @@
 export declare const ToltApiEnvironment: {
-    readonly Production: "https://platform.tolt.dev";
+    readonly Default: "https://platform.tolt.dev";
 };
-export type ToltApiEnvironment = typeof ToltApiEnvironment.Production;
+export type ToltApiEnvironment = typeof ToltApiEnvironment.Default;

package/dist/environments.js

@@ -1,4 +1,4 @@
 // This file was auto-generated by Fern from our API Definition.
 export const ToltApiEnvironment = {
-    Production: "https://platform.tolt.dev",
+    Default: "https://platform.tolt.dev",
 };

package/dist/errors/ToltApiError.js

@@ -16,7 +16,21 @@ export class ToltApiError extends Error {
         }
     }
     get requestId() {
-        return this.rawResponse?.headers?.get("x-request-id") ?? undefined;
+        const headers = this.rawResponse?.headers;
+        if (headers == null) {
+            return undefined;
+        }
+        const requestId = headers.get("X-Request-Id");
+        if (requestId != null) {
+            return requestId;
+        }
+        let fallback;
+        headers.forEach((value, name) => {
+            if (fallback === undefined && /request[-_]?id$/i.test(name)) {
+                fallback = value;
+            }
+        });
+        return fallback;
     }
 }
 function buildMessage({ message, statusCode, body, }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolt/api",
-  "version": "0.6.1",
+  "version": "1.0.0",
   "description": "TypeScript SDK for the Tolt Public API",
   "license": "Apache-2.0",
   "repository": {
@@ -13,6 +13,9 @@
   },
   "type": "module",
   "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -31,11 +34,13 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "test": "node --test test/client.test.mjs"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^7.0.0",
     "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/exec": "^7.1.0",
     "@semantic-release/git": "^11.0.1",
     "@semantic-release/github": "^12.0.9",
     "@semantic-release/npm": "^13.1.5",

package/dist/api/resources/clicks/client/requests/GetClicksRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface GetClicksRequest {
-    id: string;
-}

package/dist/api/resources/clicks/types/CreateClicksRequest.d.ts

@@ -1 +0,0 @@
-export type CreateClicksRequest = unknown;

package/dist/api/resources/commissions/client/requests/ApproveCommissionsRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface ApproveCommissionsRequest {
-    id: string;
-}

package/dist/api/resources/commissions/client/requests/DeclineCommissionsRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface DeclineCommissionsRequest {
-    id: string;
-}

package/dist/api/resources/commissions/client/requests/DeleteCommissionsRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface DeleteCommissionsRequest {
-    id: string;
-}

package/dist/api/resources/commissions/client/requests/GetCommissionsRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface GetCommissionsRequest {
-    id: string;
-}

package/dist/api/resources/commissions/client/requests/UpdateCommissionsRequest.d.ts

@@ -1,18 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface UpdateCommissionsRequest {
-    id: string;
-    /** Monetary amount as an integer in the smallest currency unit (cents), e.g. 500 = 5.00 */
-    amount?: number;
-    /** Monetary amount as an integer in the smallest currency unit (cents), e.g. 500 = 5.00 */
-    revenue?: number;
-    status?: string | null;
-    source?: string | null;
-    charge_id?: string | null;
-    transaction_id?: string | null;
-    created_at?: string;
-}

package/dist/api/resources/commissions/types/ApproveCommissionsResponse.d.ts

@@ -1,6 +0,0 @@
-import type * as ToltApi from "../../../index.js";
-export interface ApproveCommissionsResponse {
-    success: boolean;
-    message: string;
-    data: ToltApi.Commission;
-}

package/dist/api/resources/commissions/types/CreateCommissionsRequest.d.ts

@@ -1 +0,0 @@
-export type CreateCommissionsRequest = unknown;

package/dist/api/resources/commissions/types/DeclineCommissionsResponse.d.ts

@@ -1,6 +0,0 @@
-import type * as ToltApi from "../../../index.js";
-export interface DeclineCommissionsResponse {
-    success: boolean;
-    message: string;
-    data: ToltApi.Commission;
-}

package/dist/api/resources/customers/client/requests/CreateCustomersRequest.d.ts

@@ -1,29 +0,0 @@
-/**
- * @example
- *     {}
- */
-export interface CreateCustomersRequest {
-    email?: string;
-    /** Resolve a code in the partner’s program, preferring partner, group, then program scope. An unmatched code leaves attribution unchanged. */
-    promotion_code?: string;
-    created_at?: string;
-    name?: string;
-    customer_id?: string;
-    status?: CreateCustomersRequest.Status;
-    subscription_id?: string;
-    click_id?: string;
-    link_id?: string;
-    partner_id?: string;
-    lead_at?: string | null;
-    active_at?: string | null;
-}
-export declare namespace CreateCustomersRequest {
-    const Status: {
-        readonly Lead: "lead";
-        readonly Active: "active";
-        readonly Canceled: "canceled";
-        readonly Suspended: "suspended";
-        readonly Trialing: "trialing";
-    };
-    type Status = (typeof Status)[keyof typeof Status];
-}

package/dist/api/resources/customers/client/requests/CreateCustomersRequest.js

@@ -1,11 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-export var CreateCustomersRequest;
-(function (CreateCustomersRequest) {
-    CreateCustomersRequest.Status = {
-        Lead: "lead",
-        Active: "active",
-        Canceled: "canceled",
-        Suspended: "suspended",
-        Trialing: "trialing",
-    };
-})(CreateCustomersRequest || (CreateCustomersRequest = {}));

package/dist/api/resources/customers/client/requests/DeleteCustomersRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface DeleteCustomersRequest {
-    id: string;
-}

package/dist/api/resources/customers/client/requests/GetCustomersRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface GetCustomersRequest {
-    id: string;
-}

package/dist/api/resources/customers/client/requests/UpdateCustomersRequest.d.ts

@@ -1,31 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface UpdateCustomersRequest {
-    id: string;
-    email?: string;
-    /** Resolve a code in the partner’s program, preferring partner, group, then program scope. An unmatched code leaves attribution unchanged. Null clears the promotion code and its derived attribution. */
-    promotion_code?: string | null;
-    created_at?: string;
-    name?: string | null;
-    status?: UpdateCustomersRequest.Status | null;
-    customer_id?: string;
-    subscription_id?: string | null;
-    click_id?: string | null;
-    link_id?: string | null;
-    lead_at?: string | null;
-    active_at?: string | null;
-}
-export declare namespace UpdateCustomersRequest {
-    const Status: {
-        readonly Lead: "lead";
-        readonly Active: "active";
-        readonly Canceled: "canceled";
-        readonly Suspended: "suspended";
-        readonly Trialing: "trialing";
-    };
-    type Status = (typeof Status)[keyof typeof Status];
-}

package/dist/api/resources/customers/client/requests/UpdateCustomersRequest.js

@@ -1,11 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-export var UpdateCustomersRequest;
-(function (UpdateCustomersRequest) {
-    UpdateCustomersRequest.Status = {
-        Lead: "lead",
-        Active: "active",
-        Canceled: "canceled",
-        Suspended: "suspended",
-        Trialing: "trialing",
-    };
-})(UpdateCustomersRequest || (UpdateCustomersRequest = {}));

package/dist/api/resources/embed/client/requests/CreateTokenEmbedRequest.d.ts

@@ -1,14 +0,0 @@
-/**
- * @example
- *     {}
- */
-export interface CreateTokenEmbedRequest {
-    partner_id?: string;
-    partner?: CreateTokenEmbedRequest.Partner;
-}
-export declare namespace CreateTokenEmbedRequest {
-    interface Partner {
-        email: string;
-        program_id: string;
-    }
-}

package/dist/api/resources/embed/client/requests/index.d.ts

@@ -1 +0,0 @@
-export type { CreateTokenEmbedRequest } from "./CreateTokenEmbedRequest.js";

package/dist/api/resources/embed/exports.d.ts

@@ -1,2 +0,0 @@
-export { EmbedClient } from "./client/Client.js";
-export * from "./client/index.js";

package/dist/api/resources/embed/types/index.d.ts

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

package/dist/api/resources/embed/types/index.js

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

package/dist/api/resources/flows/client/requests/GetFlowsRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface GetFlowsRequest {
-    id: string;
-}

package/dist/api/resources/flows/types/ListFlowsRequestActive.d.ts

@@ -1,5 +0,0 @@
-export declare const ListFlowsRequestActive: {
-    readonly True: "true";
-    readonly False: "false";
-};
-export type ListFlowsRequestActive = (typeof ListFlowsRequestActive)[keyof typeof ListFlowsRequestActive];

package/dist/api/resources/flows/types/ListFlowsRequestActive.js

@@ -1,5 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-export const ListFlowsRequestActive = {
-    True: "true",
-    False: "false",
-};

package/dist/api/resources/groups/client/requests/GetGroupsRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface GetGroupsRequest {
-    id: string;
-}

package/dist/api/resources/groups/types/ListGroupsRequestDefault.d.ts

@@ -1,5 +0,0 @@
-export declare const ListGroupsRequestDefault: {
-    readonly True: "true";
-    readonly False: "false";
-};
-export type ListGroupsRequestDefault = (typeof ListGroupsRequestDefault)[keyof typeof ListGroupsRequestDefault];

package/dist/api/resources/groups/types/ListGroupsRequestDefault.js

@@ -1,5 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-export const ListGroupsRequestDefault = {
-    True: "true",
-    False: "false",
-};

package/dist/api/resources/links/client/requests/CreateLinksRequest.d.ts

@@ -1,12 +0,0 @@
-/**
- * @example
- *     {
- *         value: "value",
- *         partner_id: "partner_id"
- *     }
- */
-export interface CreateLinksRequest {
-    value: string;
-    param?: string;
-    partner_id: string;
-}

package/dist/api/resources/links/client/requests/DeleteLinksRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface DeleteLinksRequest {
-    id: string;
-}

package/dist/api/resources/links/client/requests/GetLinksRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface GetLinksRequest {
-    id: string;
-}

package/dist/api/resources/links/client/requests/UpdateLinksRequest.d.ts

@@ -1,11 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface UpdateLinksRequest {
-    id: string;
-    param?: string | null;
-    value?: string;
-}

package/dist/api/resources/links/types/GetByParamValueLinksResponse.d.ts

@@ -1,6 +0,0 @@
-import type * as ToltApi from "../../../index.js";
-export interface GetByParamValueLinksResponse {
-    success: boolean;
-    message: string;
-    data: ToltApi.Link;
-}

package/dist/api/resources/partners/client/requests/ApprovePartnersRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface ApprovePartnersRequest {
-    id: string;
-}

package/dist/api/resources/partners/client/requests/CreatePartnersRequest.d.ts

@@ -1,45 +0,0 @@
-/**
- * @example
- *     {
- *         email: "sam@acme.com",
- *         program_id: "prg_YRsbPDAK"
- *     }
- */
-export interface CreatePartnersRequest {
-    /** Unique within the program, compared case-insensitively. */
-    email: string;
-    program_id: string;
-    first_name?: string;
-    last_name?: string;
-    /** Overrides the name shown for the partner; defaults to the first and last name. */
-    display_name?: string;
-    company_name?: string;
-    /** Two-letter ISO country code. */
-    country_code?: string;
-    website_url?: string;
-    /** Backdate the partner's creation time. Defaults to now. */
-    created_at?: string;
-    /** Group in the program. Defaults to the program's default group. */
-    group_id?: string;
-    status?: CreatePartnersRequest.Status;
-    /** The referral link created with the partner. Defaults to a slug of the name or email. */
-    link?: CreatePartnersRequest.Link;
-    /** Send the partner the program's welcome email. Only goes out when the program's welcome email is enabled and the partner is active. */
-    notify_partner?: boolean;
-}
-export declare namespace CreatePartnersRequest {
-    const Status: {
-        readonly Active: "active";
-        readonly Pending: "pending";
-    };
-    type Status = (typeof Status)[keyof typeof Status];
-    /**
-     * The referral link created with the partner. Defaults to a slug of the name or email.
-     */
-    interface Link {
-        /** The slug after the parameter, e.g. `sam` in `?ref=sam`. */
-        value: string;
-        /** Defaults to the program's first link parameter. */
-        param?: string | undefined;
-    }
-}

package/dist/api/resources/partners/client/requests/CreatePartnersRequest.js

@@ -1,8 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-export var CreatePartnersRequest;
-(function (CreatePartnersRequest) {
-    CreatePartnersRequest.Status = {
-        Active: "active",
-        Pending: "pending",
-    };
-})(CreatePartnersRequest || (CreatePartnersRequest = {}));

package/dist/api/resources/partners/client/requests/GetPartnersRequest.d.ts

@@ -1,9 +0,0 @@
-/**
- * @example
- *     {
- *         id: "id"
- *     }
- */
-export interface GetPartnersRequest {
-    id: string;
-}