@tolt/api 0.2.0 → 0.3.0

package/dist/api/resources/transactions/client/Client.js

@@ -17,6 +17,7 @@ export class TransactionsClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -27,11 +28,17 @@ export class TransactionsClient {
         return core.HttpResponsePromise.fromPromise(this.__listTransactions(request, requestOptions));
     }
     async __listTransactions(request = {}, requestOptions) {
-        const { limit, order, starting_after: startingAfter, program_id: programId, partner_id: partnerId, customer_id: customerId, status, search, } = request;
+        const { limit, order, sort, starting_after: startingAfter, ending_before: endingBefore, created_after: createdAfter, created_before: createdBefore, updated_after: updatedAfter, updated_before: updatedBefore, program_id: programId, partner_id: partnerId, customer_id: customerId, status, search, } = request;
         const _queryParams = {
             limit,
             order: order != null ? order : undefined,
+            sort: sort != null ? sort : undefined,
             starting_after: startingAfter,
+            ending_before: endingBefore,
+            created_after: createdAfter != null ? createdAfter : undefined,
+            created_before: createdBefore != null ? createdBefore : undefined,
+            updated_after: updatedAfter != null ? updatedAfter : undefined,
+            updated_before: updatedBefore != null ? updatedBefore : undefined,
             program_id: programId,
             partner_id: partnerId,
             customer_id: customerId,
@@ -66,6 +73,8 @@ export class TransactionsClient {
                     throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
                 case 401:
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -82,13 +91,14 @@ export class TransactionsClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.createTransaction({
      *         amount: 1,
-     *         customerId: "customerId"
+     *         customer_id: "customer_id"
      *     })
      */
     createTransaction(request, requestOptions) {
@@ -122,6 +132,8 @@ export class TransactionsClient {
                     throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
                 case 401:
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -138,6 +150,7 @@ export class TransactionsClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -175,6 +188,8 @@ export class TransactionsClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -193,6 +208,7 @@ export class TransactionsClient {
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -237,6 +253,8 @@ export class TransactionsClient {
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
                 case 409:
                     throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -254,6 +272,7 @@ export class TransactionsClient {
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -293,6 +312,8 @@ export class TransactionsClient {
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
                 case 409:
                     throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -310,6 +331,7 @@ export class TransactionsClient {
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -349,6 +371,8 @@ export class TransactionsClient {
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
                 case 409:
                     throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,
@@ -368,6 +392,7 @@ export class TransactionsClient {
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -410,6 +435,8 @@ export class TransactionsClient {
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
                 case 409:
                     throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.ToltApiError({
                         statusCode: _response.error.statusCode,

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

@@ -2,16 +2,16 @@
  * @example
  *     {
  *         amount: 1,
- *         customerId: "customerId"
+ *         customer_id: "customer_id"
  *     }
  */
 export interface CreateTransactionRequest {
     /** Monetary amount as an integer in the smallest currency unit (cents), e.g. 500 = 5.00 */
     amount: number;
-    customerId: string;
-    billingType?: string;
-    chargeId?: string;
-    clickId?: string;
+    customer_id: string;
+    billing_type?: string;
+    charge_id?: string;
+    click_id?: string;
     interval?: string;
     source?: string;
 }

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

@@ -6,7 +6,20 @@ import type * as ToltApi from "../../../../index.js";
 export interface ListTransactionsRequest {
     limit?: number;
     order?: ToltApi.ListTransactionsRequestOrder;
+    /** Column the list is ordered and paged by. */
+    sort?: ToltApi.ListTransactionsRequestSort;
+    /** Continue after a position: the next_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with ending_before. */
     starting_after?: string;
+    /** Page backward from a position: the prev_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with starting_after. */
+    ending_before?: string;
+    /** Only items created at or after this ISO 8601 time. */
+    created_after?: string;
+    /** Only items created before this ISO 8601 time. */
+    created_before?: string;
+    /** Only items updated at or after this ISO 8601 time. Combine with sort=updated_at to sync changes. */
+    updated_after?: string;
+    /** Only items updated before this ISO 8601 time. */
+    updated_before?: string;
     program_id?: string;
     partner_id?: string;
     customer_id?: string;

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

@@ -10,9 +10,9 @@ export interface UpdateTransactionRequest {
     amount?: number;
     status?: string | null;
     source?: string | null;
-    billingType?: string | null;
-    chargeId?: string | null;
-    clickId?: string | null;
+    billing_type?: string | null;
+    charge_id?: string | null;
+    click_id?: string | null;
     interval?: string | null;
-    createdAt?: string;
+    created_at?: string;
 }

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

@@ -0,0 +1,6 @@
+/** Column the list is ordered and paged by. */
+export declare const ListTransactionsRequestSort: {
+    readonly CreatedAt: "created_at";
+    readonly UpdatedAt: "updated_at";
+};
+export type ListTransactionsRequestSort = (typeof ListTransactionsRequestSort)[keyof typeof ListTransactionsRequestSort];

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

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Column the list is ordered and paged by. */
+export const ListTransactionsRequestSort = {
+    CreatedAt: "created_at",
+    UpdatedAt: "updated_at",
+};

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

@@ -4,4 +4,8 @@ export interface ListTransactionsResponse {
     message: string;
     data: ToltApi.Transaction[];
     has_more: boolean;
+    /** Opaque cursor marking the last item on this page. Pass it as starting_after to continue. Null when the page is empty. */
+    next_cursor: string | null;
+    /** Opaque cursor marking the first item on this page. Pass it as ending_before to page backward. Null when the page is empty. */
+    prev_cursor: string | null;
 }

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

@@ -2,6 +2,7 @@ export * from "./CreateTransactionResponse.js";
 export * from "./DeleteTransactionResponse.js";
 export * from "./GetTransactionResponse.js";
 export * from "./ListTransactionsRequestOrder.js";
+export * from "./ListTransactionsRequestSort.js";
 export * from "./ListTransactionsResponse.js";
 export * from "./RefundTransactionResponse.js";
 export * from "./RerunTransactionFlowsResponse.js";

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

@@ -2,6 +2,7 @@ export * from "./CreateTransactionResponse.js";
 export * from "./DeleteTransactionResponse.js";
 export * from "./GetTransactionResponse.js";
 export * from "./ListTransactionsRequestOrder.js";
+export * from "./ListTransactionsRequestSort.js";
 export * from "./ListTransactionsResponse.js";
 export * from "./RefundTransactionResponse.js";
 export * from "./RerunTransactionFlowsResponse.js";

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

@@ -0,0 +1,24 @@
+export interface BulkResult {
+    succeeded: number;
+    failed: number;
+    results: BulkResult.Results.Item[];
+}
+export declare namespace BulkResult {
+    type Results = Results.Item[];
+    namespace Results {
+        interface Item {
+            id: string;
+            status: Item.Status;
+            /** Error code when status is error. */
+            code?: string | undefined;
+            message?: string | undefined;
+        }
+        namespace Item {
+            const Status: {
+                readonly Ok: "ok";
+                readonly Error: "error";
+            };
+            type Status = (typeof Status)[keyof typeof Status];
+        }
+    }
+}

package/dist/api/types/BulkResult.js

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+export var BulkResult;
+(function (BulkResult) {
+    let Results;
+    (function (Results) {
+        let Item;
+        (function (Item) {
+            Item.Status = {
+                Ok: "ok",
+                Error: "error",
+            };
+        })(Item = Results.Item || (Results.Item = {}));
+    })(Results = BulkResult.Results || (BulkResult.Results = {}));
+})(BulkResult || (BulkResult = {}));

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

@@ -6,9 +6,9 @@ export interface Click {
     browser: string | null;
     country: string | null;
     state: string | null;
-    linkId: string | null;
-    programId: string | null;
-    partnerId: string | null;
-    createdAt: string;
-    updatedAt: string;
+    link_id: string | null;
+    program_id: string | null;
+    partner_id: string | null;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -8,17 +8,17 @@ export interface Commission {
     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;
+    partner_id: string | null;
+    customer_id: string | null;
+    program_id: string | null;
+    transaction_id: string | null;
+    payout_id: string | null;
+    charge_id: string | null;
+    charge_status: string | null;
+    is_ad_click: boolean | null;
+    is_self_referral: boolean | null;
+    approval_type: string | null;
+    scheduled_approval_date: string;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -0,0 +1,19 @@
+import type * as ToltApi from "../index.js";
+export interface CreatedPartner {
+    id: string;
+    email: string;
+    first_name: string | null;
+    last_name: string | null;
+    company_name: string | null;
+    status: string;
+    group_id: string | null;
+    program_id: string | null;
+    country_code: string | null;
+    website_url: string | null;
+    /** Name shown for the partner in the dashboard. */
+    display_name: string | null;
+    completed_onboarding: boolean | null;
+    created_at: string;
+    updated_at: string;
+    link: ToltApi.Link;
+}

package/dist/api/types/CreatedPartner.js

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

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

@@ -1,19 +1,19 @@
 export interface Customer {
     id: string;
-    customerId: string | null;
+    customer_id: 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;
+    subscription_id: string | null;
+    partner_id: string | null;
+    program_id: string | null;
+    link_id: string | null;
+    promotion_code_id: string | null;
+    click_id: string | null;
+    lead_at: string;
+    active_at: string;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -1,4 +1,4 @@
 export interface EmbedToken {
     token: string;
-    expiresAt: string;
+    expires_at: string;
 }

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

@@ -1,4 +1,38 @@
 export interface Error_ {
     success: boolean;
+    /** Human-readable explanation. May change; branch on code instead. */
     message: string;
+    /** Stable machine-readable error code. */
+    code: Error_.Code;
+    doc_url: string;
+    /** One entry per offending field. Present on validation_error and invalid_reference. */
+    errors?: Error_.Errors.Item[] | undefined;
+}
+export declare namespace Error_ {
+    /** Stable machine-readable error code. */
+    const Code: {
+        readonly BadRequest: "bad_request";
+        readonly ValidationError: "validation_error";
+        readonly InvalidReference: "invalid_reference";
+        readonly InvalidCursor: "invalid_cursor";
+        readonly Unauthorized: "unauthorized";
+        readonly Forbidden: "forbidden";
+        readonly NotFound: "not_found";
+        readonly Conflict: "conflict";
+        readonly AlreadyExists: "already_exists";
+        readonly CommissionPaid: "commission_paid";
+        readonly CommissionFrozen: "commission_frozen";
+        readonly TransactionRefunded: "transaction_refunded";
+        readonly CommissionExists: "commission_exists";
+        readonly RateLimited: "rate_limited";
+        readonly InternalError: "internal_error";
+    };
+    type Code = (typeof Code)[keyof typeof Code];
+    type Errors = Errors.Item[];
+    namespace Errors {
+        interface Item {
+            field: string;
+            message: string;
+        }
+    }
 }

package/dist/api/types/Error_.js

@@ -1,2 +1,22 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var Error_;
+(function (Error_) {
+    /** Stable machine-readable error code. */
+    Error_.Code = {
+        BadRequest: "bad_request",
+        ValidationError: "validation_error",
+        InvalidReference: "invalid_reference",
+        InvalidCursor: "invalid_cursor",
+        Unauthorized: "unauthorized",
+        Forbidden: "forbidden",
+        NotFound: "not_found",
+        Conflict: "conflict",
+        AlreadyExists: "already_exists",
+        CommissionPaid: "commission_paid",
+        CommissionFrozen: "commission_frozen",
+        TransactionRefunded: "transaction_refunded",
+        CommissionExists: "commission_exists",
+        RateLimited: "rate_limited",
+        InternalError: "internal_error",
+    };
+})(Error_ || (Error_ = {}));

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

@@ -3,16 +3,16 @@ export interface Flow {
     name: string | null;
     description: string | null;
     event: string | null;
-    actionType: string | null;
+    action_type: string | null;
     action?: unknown | undefined;
     conditions?: unknown | undefined;
-    programId: string | null;
-    groupId: string | null;
-    campaignId: string | null;
+    program_id: string | null;
+    group_id: string | null;
+    campaign_id: string | null;
     active: boolean | null;
-    partnerOverrides?: unknown | undefined;
-    linkOverrides?: unknown | undefined;
+    partner_overrides?: unknown | undefined;
+    link_overrides?: unknown | undefined;
     options?: unknown | undefined;
-    createdAt: string;
-    updatedAt: string;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -2,13 +2,13 @@ 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;
+    program_id: string | null;
+    is_default: boolean | null;
+    public_key: string | null;
+    website_url: string | null;
+    is_private: boolean | null;
+    allow_manual_lead_submission: boolean | null;
+    minimum_payout: number | null;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -3,9 +3,9 @@ export interface Link {
     value: string | null;
     param: string | null;
     status: string | null;
-    partnerId: string | null;
-    programId: string | null;
-    campaignId: string | null;
-    createdAt: string;
-    updatedAt: string;
+    partner_id: string | null;
+    program_id: string | null;
+    campaign_id: string | null;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -1,13 +1,17 @@
 export interface Partner {
     id: string;
     email: string;
-    firstName: string | null;
-    lastName: string | null;
-    companyName: string | null;
+    first_name: string | null;
+    last_name: string | null;
+    company_name: string | null;
     status: string;
-    groupId: string | null;
-    programId: string | null;
-    countryCode: string | null;
-    createdAt: string;
-    updatedAt: string;
+    group_id: string | null;
+    program_id: string | null;
+    country_code: string | null;
+    website_url: string | null;
+    /** Name shown for the partner in the dashboard. */
+    display_name: string | null;
+    completed_onboarding: boolean | null;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -1,15 +1,15 @@
 export interface Program {
     id: string;
     name: string | null;
-    productName: string | null;
+    product_name: string | null;
     type: string | null;
     status: string | null;
-    currencyCode: string | null;
-    cookieDuration: number | null;
-    payoutTerm: string | null;
-    minimumPayout: number | null;
-    websiteUrl: string | null;
+    currency_code: string | null;
+    cookie_duration: number | null;
+    payout_term: string | null;
+    minimum_payout: number | null;
+    website_url: string | null;
     subdomain: string | null;
-    createdAt: string;
-    updatedAt: string;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -4,13 +4,13 @@ export interface PromotionCode {
     type: string | null;
     value: string | null;
     duration: string;
-    durationInMonths: string | null;
+    duration_in_months: string | null;
     active: boolean | null;
-    entityType: string | null;
-    externalId: string | null;
-    partnerId: string | null;
-    programId: string | null;
-    groupId: string | null;
-    createdAt: string;
-    updatedAt: string;
+    entity_type: string | null;
+    external_id: string | null;
+    partner_id: string | null;
+    program_id: string | null;
+    group_id: string | null;
+    created_at: string;
+    updated_at: string;
 }

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

@@ -1,5 +1,5 @@
 export interface ReportsLinkRow {
-    linkId: string;
+    link_id: string;
     param: string | null;
     value: string | null;
     clicks: number;
@@ -8,5 +8,5 @@ export interface ReportsLinkRow {
     revenue: string;
     /** Integer amount in the smallest currency unit (cents), serialized as a string. Summed across the row's currencies; scope to a single-currency program with program_id, or use /reports/overview for the per-currency split. */
     commissions: string;
-    conversionRate: number;
+    conversion_rate: number;
 }

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

@@ -4,9 +4,9 @@ export interface ReportsOverview {
     /** 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;
+    commission_count: number;
+    customer_count: number;
+    partner_count: number;
 }
 export declare namespace ReportsOverview {
     type Revenue = Revenue.Item[];

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

@@ -1,7 +1,7 @@
 export interface ReportsPartnerRow {
-    partnerId: string;
-    firstName: string | null;
-    lastName: string | null;
+    partner_id: string;
+    first_name: string | null;
+    last_name: string | null;
     email: string | null;
     clicks: number;
     /** Converted (non-lead) customers. */
@@ -11,5 +11,5 @@ export interface ReportsPartnerRow {
     /** Integer amount in the smallest currency unit (cents), serialized as a string. Summed across the row's currencies; scope to a single-currency program with program_id, or use /reports/overview for the per-currency split. */
     commissions: string;
     /** Customers / clicks as a percentage. */
-    conversionRate: number;
+    conversion_rate: number;
 }