@tolt/api 0.1.0

package/dist/api/resources/transactions/client/requests/RefundTransactionRequest.d.ts

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

package/dist/api/resources/transactions/client/requests/RefundTransactionRequest.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/transactions/client/requests/RerunTransactionFlowsRequest.d.ts

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

package/dist/api/resources/transactions/client/requests/RerunTransactionFlowsRequest.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/transactions/client/requests/UpdateTransactionRequest.d.ts

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

package/dist/api/resources/transactions/client/requests/UpdateTransactionRequest.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,7 @@
+export type { CreateTransactionRequest } from "./CreateTransactionRequest.js";
+export type { DeleteTransactionRequest } from "./DeleteTransactionRequest.js";
+export type { GetTransactionRequest } from "./GetTransactionRequest.js";
+export type { ListTransactionsRequest } from "./ListTransactionsRequest.js";
+export type { RefundTransactionRequest } from "./RefundTransactionRequest.js";
+export type { RerunTransactionFlowsRequest } from "./RerunTransactionFlowsRequest.js";
+export type { UpdateTransactionRequest } from "./UpdateTransactionRequest.js";

package/dist/api/resources/transactions/client/requests/index.js

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

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

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

package/dist/api/resources/transactions/exports.js

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { TransactionsClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/api/resources/transactions/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/api/resources/transactions/index.js

@@ -0,0 +1,2 @@
+export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/api/resources/transactions/types/CreateTransactionResponse.d.ts

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

package/dist/api/resources/transactions/types/CreateTransactionResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/transactions/types/DeleteTransactionResponse.d.ts

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

package/dist/api/resources/transactions/types/DeleteTransactionResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/transactions/types/GetTransactionResponse.d.ts

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

package/dist/api/resources/transactions/types/GetTransactionResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/transactions/types/ListTransactionsRequestOrder.d.ts

@@ -0,0 +1,5 @@
+export declare const ListTransactionsRequestOrder: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ListTransactionsRequestOrder = (typeof ListTransactionsRequestOrder)[keyof typeof ListTransactionsRequestOrder];

package/dist/api/resources/transactions/types/ListTransactionsRequestOrder.js

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const ListTransactionsRequestOrder = {
+    Asc: "asc",
+    Desc: "desc",
+};

package/dist/api/resources/transactions/types/ListTransactionsResponse.d.ts

@@ -0,0 +1,7 @@
+import type * as ToltApi from "../../../index.js";
+export interface ListTransactionsResponse {
+    success: boolean;
+    message: string;
+    data: ToltApi.Transaction[];
+    has_more: boolean;
+}

package/dist/api/resources/transactions/types/ListTransactionsResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/transactions/types/RefundTransactionResponse.d.ts

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

package/dist/api/resources/transactions/types/RefundTransactionResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/transactions/types/RerunTransactionFlowsResponse.d.ts

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

package/dist/api/resources/transactions/types/RerunTransactionFlowsResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/resources/transactions/types/UpdateTransactionResponse.d.ts

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

package/dist/api/resources/transactions/types/UpdateTransactionResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,8 @@
+export * from "./CreateTransactionResponse.js";
+export * from "./DeleteTransactionResponse.js";
+export * from "./GetTransactionResponse.js";
+export * from "./ListTransactionsRequestOrder.js";
+export * from "./ListTransactionsResponse.js";
+export * from "./RefundTransactionResponse.js";
+export * from "./RerunTransactionFlowsResponse.js";
+export * from "./UpdateTransactionResponse.js";

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

@@ -0,0 +1,8 @@
+export * from "./CreateTransactionResponse.js";
+export * from "./DeleteTransactionResponse.js";
+export * from "./GetTransactionResponse.js";
+export * from "./ListTransactionsRequestOrder.js";
+export * from "./ListTransactionsResponse.js";
+export * from "./RefundTransactionResponse.js";
+export * from "./RerunTransactionFlowsResponse.js";
+export * from "./UpdateTransactionResponse.js";

package/dist/api/types/Click.d.ts

@@ -0,0 +1,14 @@
+export interface Click {
+    id: string;
+    page: string | null;
+    referrer: string | null;
+    device: string | null;
+    browser: string | null;
+    country: string | null;
+    state: string | null;
+    linkId: string | null;
+    programId: string | null;
+    partnerId: string | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Click.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Commission.d.ts

@@ -0,0 +1,24 @@
+export interface Commission {
+    id: string;
+    /** Integer amount in the smallest currency unit (cents), serialized as a string. */
+    amount: string | null;
+    currency: string | null;
+    /** Integer amount in the smallest currency unit (cents), serialized as a string. */
+    revenue: string | null;
+    status: string | null;
+    type: string | null;
+    source: string | null;
+    partnerId: string | null;
+    customerId: string | null;
+    programId: string | null;
+    transactionId: string | null;
+    payoutId: string | null;
+    chargeId: string | null;
+    chargeStatus: string | null;
+    isAdClick: boolean | null;
+    isSelfReferral: boolean | null;
+    approvalType: string | null;
+    scheduledApprovalDate: string;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Commission.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Customer.d.ts

@@ -0,0 +1,19 @@
+export interface Customer {
+    id: string;
+    customerId: string | null;
+    identifier: string | null;
+    email: string | null;
+    name: string | null;
+    status: string | null;
+    plan: string | null;
+    subscriptionId: string | null;
+    partnerId: string | null;
+    programId: string | null;
+    linkId: string | null;
+    promotionCodeId: string | null;
+    clickId: string | null;
+    leadAt: string;
+    activeAt: string;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Customer.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Error_.d.ts

@@ -0,0 +1,4 @@
+export interface Error_ {
+    success: boolean;
+    message: string;
+}

package/dist/api/types/Error_.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Flow.d.ts

@@ -0,0 +1,18 @@
+export interface Flow {
+    id: string;
+    name: string | null;
+    description: string | null;
+    event: string | null;
+    actionType: string | null;
+    action?: unknown | undefined;
+    conditions?: unknown | undefined;
+    programId: string | null;
+    groupId: string | null;
+    campaignId: string | null;
+    active: boolean | null;
+    partnerOverrides?: unknown | undefined;
+    linkOverrides?: unknown | undefined;
+    options?: unknown | undefined;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Flow.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Group.d.ts

@@ -0,0 +1,14 @@
+export interface Group {
+    id: string;
+    name: string | null;
+    description: string | null;
+    programId: string | null;
+    isDefault: boolean | null;
+    publicKey: string | null;
+    websiteUrl: string | null;
+    isPrivate: boolean | null;
+    allowManualLeadSubmission: boolean | null;
+    minimumPayout: number | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Group.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Link.d.ts

@@ -0,0 +1,11 @@
+export interface Link {
+    id: string;
+    value: string | null;
+    param: string | null;
+    status: string | null;
+    partnerId: string | null;
+    programId: string | null;
+    campaignId: string | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Link.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Partner.d.ts

@@ -0,0 +1,13 @@
+export interface Partner {
+    id: string;
+    email: string;
+    firstName: string | null;
+    lastName: string | null;
+    companyName: string | null;
+    status: string;
+    groupId: string | null;
+    programId: string | null;
+    countryCode: string | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Partner.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Program.d.ts

@@ -0,0 +1,15 @@
+export interface Program {
+    id: string;
+    name: string | null;
+    productName: string | null;
+    type: string | null;
+    status: string | null;
+    currencyCode: string | null;
+    cookieDuration: number | null;
+    payoutTerm: string | null;
+    minimumPayout: number | null;
+    websiteUrl: string | null;
+    subdomain: string | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Program.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/PromotionCode.d.ts

@@ -0,0 +1,16 @@
+export interface PromotionCode {
+    id: string;
+    code: string | null;
+    type: string | null;
+    value: string | null;
+    duration: string;
+    durationInMonths: string | null;
+    active: boolean | null;
+    entityType: string | null;
+    externalId: string | null;
+    partnerId: string | null;
+    programId: string | null;
+    groupId: string | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/PromotionCode.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/ReportsOverview.d.ts

@@ -0,0 +1,30 @@
+export interface ReportsOverview {
+    /** Non-refunded transaction revenue, one entry per currency. */
+    revenue: ReportsOverview.Revenue.Item[];
+    /** Approved and paid commission totals, one entry per currency. */
+    commissions: ReportsOverview.Commissions.Item[];
+    /** Number of approved and paid commissions. */
+    commissionCount: number;
+    customerCount: number;
+    partnerCount: number;
+}
+export declare namespace ReportsOverview {
+    type Revenue = Revenue.Item[];
+    namespace Revenue {
+        interface Item {
+            /** ISO currency code for this bucket, or null when the source rows carry none. */
+            currency: string | null;
+            /** Integer amount in the smallest currency unit (cents), serialized as a string. */
+            amount: string;
+        }
+    }
+    type Commissions = Commissions.Item[];
+    namespace Commissions {
+        interface Item {
+            /** ISO currency code for this bucket, or null when the source rows carry none. */
+            currency: string | null;
+            /** Integer amount in the smallest currency unit (cents), serialized as a string. */
+            amount: string;
+        }
+    }
+}

package/dist/api/types/ReportsOverview.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/RerunFlowsResult.d.ts

@@ -0,0 +1,4 @@
+export interface RerunFlowsResult {
+    /** The transaction whose flows were queued for reprocessing. */
+    id: string;
+}

package/dist/api/types/RerunFlowsResult.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/api/types/Transaction.d.ts

@@ -0,0 +1,32 @@
+export interface Transaction {
+    id: string;
+    /** Integer amount in the smallest currency unit (cents), serialized as a string. */
+    amount: string | null;
+    /** Integer amount in the smallest currency unit (cents), serialized as a string. */
+    amountExcludingTax: string | null;
+    /** Integer amount in the smallest currency unit (cents), serialized as a string. */
+    amountIncludingTax: string | null;
+    currency: string | null;
+    tax: number | null;
+    /** Integer amount in the smallest currency unit (cents), serialized as a string. */
+    paymentAmount: string | null;
+    paymentCurrency: string | null;
+    status: string | null;
+    source: string | null;
+    billingType: string | null;
+    interval: string | null;
+    quantity: number | null;
+    partnerId: string | null;
+    customerId: string | null;
+    programId: string | null;
+    promotionCodeId: string | null;
+    promotionCodeName: string | null;
+    chargeId: string | null;
+    clickId: string | null;
+    productIds: string[] | null;
+    productNames: string[] | null;
+    conversionRate: string | null;
+    metadata?: unknown | undefined;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/api/types/Transaction.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

@@ -0,0 +1,13 @@
+export * from "./Click.js";
+export * from "./Commission.js";
+export * from "./Customer.js";
+export * from "./Error_.js";
+export * from "./Flow.js";
+export * from "./Group.js";
+export * from "./Link.js";
+export * from "./Partner.js";
+export * from "./Program.js";
+export * from "./PromotionCode.js";
+export * from "./ReportsOverview.js";
+export * from "./RerunFlowsResult.js";
+export * from "./Transaction.js";

package/dist/api/types/index.js

@@ -0,0 +1,13 @@
+export * from "./Click.js";
+export * from "./Commission.js";
+export * from "./Customer.js";
+export * from "./Error_.js";
+export * from "./Flow.js";
+export * from "./Group.js";
+export * from "./Link.js";
+export * from "./Partner.js";
+export * from "./Program.js";
+export * from "./PromotionCode.js";
+export * from "./ReportsOverview.js";
+export * from "./RerunFlowsResult.js";
+export * from "./Transaction.js";

package/dist/auth/BearerAuthProvider.d.ts

@@ -0,0 +1,20 @@
+import * as core from "../core/index.js";
+declare const TOKEN_PARAM: "token";
+export declare class BearerAuthProvider implements core.AuthProvider {
+    private readonly options;
+    constructor(options: BearerAuthProvider.Options);
+    static canCreate(options: Partial<BearerAuthProvider.Options>): boolean;
+    getAuthRequest({ endpointMetadata, }?: {
+        endpointMetadata?: core.EndpointMetadata;
+    }): Promise<core.AuthRequest>;
+}
+export declare namespace BearerAuthProvider {
+    const AUTH_SCHEME: "bearerAuth";
+    const AUTH_CONFIG_ERROR_MESSAGE: string;
+    type Options = AuthOptions;
+    type AuthOptions = {
+        [TOKEN_PARAM]: core.Supplier<core.BearerToken>;
+    };
+    function createInstance(options: Options): core.AuthProvider;
+}
+export {};

package/dist/auth/BearerAuthProvider.js

@@ -0,0 +1,31 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../core/index.js";
+import * as errors from "../errors/index.js";
+const TOKEN_PARAM = "token";
+export class BearerAuthProvider {
+    constructor(options) {
+        this.options = options;
+    }
+    static canCreate(options) {
+        return options?.[TOKEN_PARAM] != null;
+    }
+    async getAuthRequest({ endpointMetadata, } = {}) {
+        const token = await core.Supplier.get(this.options[TOKEN_PARAM]);
+        if (token == null) {
+            throw new errors.ToltApiError({
+                message: BearerAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
+            });
+        }
+        return {
+            headers: { Authorization: `Bearer ${token}` },
+        };
+    }
+}
+(function (BearerAuthProvider) {
+    BearerAuthProvider.AUTH_SCHEME = "bearerAuth";
+    BearerAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Please provide '${TOKEN_PARAM}' when initializing the client`;
+    function createInstance(options) {
+        return new BearerAuthProvider(options);
+    }
+    BearerAuthProvider.createInstance = createInstance;
+})(BearerAuthProvider || (BearerAuthProvider = {}));

package/dist/auth/index.d.ts

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

package/dist/auth/index.js

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

package/dist/core/auth/AuthProvider.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointMetadata } from "../fetcher/EndpointMetadata.js";
+import type { AuthRequest } from "./AuthRequest.js";
+export interface AuthProvider {
+    getAuthRequest(arg?: {
+        endpointMetadata?: EndpointMetadata;
+    }): Promise<AuthRequest>;
+}
+export declare function isAuthProvider(value: unknown): value is AuthProvider;

package/dist/core/auth/AuthProvider.js

@@ -0,0 +1,6 @@
+export function isAuthProvider(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "getAuthRequest" in value &&
+        typeof value.getAuthRequest === "function");
+}

package/dist/core/auth/AuthRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for authentication requests.
+ */
+export interface AuthRequest {
+    /**
+     * The headers to be included in the request.
+     */
+    headers: Record<string, string>;
+}

package/dist/core/auth/AuthRequest.js

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

package/dist/core/auth/BasicAuth.d.ts

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