@tolt/api 0.6.1 → 1.0.0

package/dist/api/resources/reports/client/requests/ReportsOverviewRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {}
+ */
+export interface ReportsOverviewRequest {
+    /** Limit to one program, by its id (prg_...) as returned when listing programs. */
+    program_id?: string;
+    /** Earliest day to include, by creation date. Leave it out for no lower bound. */
+    start_date?: string;
+    /** Latest day to include, by creation date; the whole day counts. Leave it out for no upper bound. */
+    end_date?: string;
+}

package/dist/api/resources/reports/client/requests/ReportsPartnersRequest.d.ts

@@ -0,0 +1,23 @@
+import type * as ToltApi from "../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface ReportsPartnersRequest {
+    /** Limit to one program, by its id (prg_...) as returned when listing programs. */
+    program_id?: string;
+    /** Earliest day to include, by creation date (customers by the day they became active). Leave it out for no lower bound. */
+    start_date?: string;
+    /** Latest day to include, by creation date (customers by the day they became active); the whole day counts. Leave it out for no upper bound. */
+    end_date?: string;
+    /** Only include transactions and commissions in this currency, such as USD; matching ignores case. Rows without their own currency use their program's. */
+    currency?: string;
+    /** How many rows to return in one page. */
+    limit?: number;
+    /** How many rows to skip before this page begins. */
+    offset?: number | null;
+    /** Metric to rank by, computed over the date window. */
+    sort?: ToltApi.PartnersReportsRequestSort;
+    /** Ranking direction: desc puts the highest values first. */
+    order?: ToltApi.PartnersReportsRequestOrder;
+}

package/dist/api/resources/reports/client/requests/ReportsTimeseriesRequest.d.ts

@@ -0,0 +1,17 @@
+import type * as ToltApi from "../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface ReportsTimeseriesRequest {
+    /** Limit to one program, by its id (prg_...) as returned when listing programs. */
+    program_id?: string;
+    /** Earliest day to include, by creation date (customers by the day they became active). Leave it out for no lower bound. */
+    start_date?: string;
+    /** Latest day to include, by creation date (customers by the day they became active); the whole day counts. Leave it out for no upper bound. */
+    end_date?: string;
+    /** Bucket size of the series; weeks start on Monday, months on the 1st, and each bucket is labeled with its first day. */
+    granularity?: ToltApi.TimeseriesReportsRequestGranularity;
+    /** Only include transactions and commissions in this currency, such as USD; matching ignores case. Rows without their own currency use their program's. */
+    currency?: string;
+}

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

@@ -1,5 +1,5 @@
-export type { CustomerStatsReportsRequest } from "./CustomerStatsReportsRequest.js";
-export type { LinksReportsRequest } from "./LinksReportsRequest.js";
-export type { OverviewReportsRequest } from "./OverviewReportsRequest.js";
-export type { PartnersReportsRequest } from "./PartnersReportsRequest.js";
-export type { TimeseriesReportsRequest } from "./TimeseriesReportsRequest.js";
+export type { ReportsCustomersRequest } from "./ReportsCustomersRequest.js";
+export type { ReportsLinksRequest } from "./ReportsLinksRequest.js";
+export type { ReportsOverviewRequest } from "./ReportsOverviewRequest.js";
+export type { ReportsPartnersRequest } from "./ReportsPartnersRequest.js";
+export type { ReportsTimeseriesRequest } from "./ReportsTimeseriesRequest.js";

package/dist/api/resources/reports/types/LinksReportsRequestOrder.d.ts

@@ -1,3 +1,4 @@
+/** Ranking direction: desc puts the highest values first. */
 export declare const LinksReportsRequestOrder: {
     readonly Asc: "asc";
     readonly Desc: "desc";

package/dist/api/resources/reports/types/LinksReportsRequestOrder.js

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
+/** Ranking direction: desc puts the highest values first. */
 export const LinksReportsRequestOrder = {
     Asc: "asc",
     Desc: "desc",

package/dist/api/resources/reports/types/LinksReportsRequestSort.d.ts

@@ -1,3 +1,4 @@
+/** Metric to rank by, computed over the date window. */
 export declare const LinksReportsRequestSort: {
     readonly Revenue: "revenue";
     readonly Commissions: "commissions";

package/dist/api/resources/reports/types/LinksReportsRequestSort.js

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
+/** Metric to rank by, computed over the date window. */
 export const LinksReportsRequestSort = {
     Revenue: "revenue",
     Commissions: "commissions",

package/dist/api/resources/reports/types/PartnersReportsRequestOrder.d.ts

@@ -1,3 +1,4 @@
+/** Ranking direction: desc puts the highest values first. */
 export declare const PartnersReportsRequestOrder: {
     readonly Asc: "asc";
     readonly Desc: "desc";

package/dist/api/resources/reports/types/PartnersReportsRequestOrder.js

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
+/** Ranking direction: desc puts the highest values first. */
 export const PartnersReportsRequestOrder = {
     Asc: "asc",
     Desc: "desc",

package/dist/api/resources/reports/types/PartnersReportsRequestSort.d.ts

@@ -1,3 +1,4 @@
+/** Metric to rank by, computed over the date window. */
 export declare const PartnersReportsRequestSort: {
     readonly Revenue: "revenue";
     readonly Commissions: "commissions";

package/dist/api/resources/reports/types/PartnersReportsRequestSort.js

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
+/** Metric to rank by, computed over the date window. */
 export const PartnersReportsRequestSort = {
     Revenue: "revenue",
     Commissions: "commissions",

package/dist/api/resources/reports/types/{CustomerStatsReportsResponse.d.ts → ReportsCustomersResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface CustomerStatsReportsResponse {
+export interface ReportsCustomersResponse {
     success: boolean;
     message: string;
     data: ToltApi.ReportsCustomerStats;

package/dist/api/resources/reports/types/{LinksReportsResponse.d.ts → ReportsLinksResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface LinksReportsResponse {
+export interface ReportsLinksResponse {
     success: boolean;
     message: string;
     data: ToltApi.ReportsLinkRow[];

package/dist/api/resources/reports/types/{OverviewReportsResponse.d.ts → ReportsOverviewResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface OverviewReportsResponse {
+export interface ReportsOverviewResponse {
     success: boolean;
     message: string;
     data: ToltApi.ReportsOverview;

package/dist/api/resources/reports/types/{PartnersReportsResponse.d.ts → ReportsPartnersResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface PartnersReportsResponse {
+export interface ReportsPartnersResponse {
     success: boolean;
     message: string;
     data: ToltApi.ReportsPartnerRow[];

package/dist/api/resources/reports/types/{TimeseriesReportsResponse.d.ts → ReportsTimeseriesResponse.d.ts}

@@ -1,5 +1,5 @@
 import type * as ToltApi from "../../../index.js";
-export interface TimeseriesReportsResponse {
+export interface ReportsTimeseriesResponse {
     success: boolean;
     message: string;
     data: ToltApi.ReportsTimeseriesPoint[];

package/dist/api/resources/reports/types/TimeseriesReportsRequestGranularity.d.ts

@@ -1,3 +1,4 @@
+/** Bucket size of the series; weeks start on Monday, months on the 1st, and each bucket is labeled with its first day. */
 export declare const TimeseriesReportsRequestGranularity: {
     readonly Day: "day";
     readonly Week: "week";

package/dist/api/resources/reports/types/TimeseriesReportsRequestGranularity.js

@@ -1,4 +1,5 @@
 // This file was auto-generated by Fern from our API Definition.
+/** Bucket size of the series; weeks start on Monday, months on the 1st, and each bucket is labeled with its first day. */
 export const TimeseriesReportsRequestGranularity = {
     Day: "day",
     Week: "week",

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

@@ -1,10 +1,10 @@
-export * from "./CustomerStatsReportsResponse.js";
 export * from "./LinksReportsRequestOrder.js";
 export * from "./LinksReportsRequestSort.js";
-export * from "./LinksReportsResponse.js";
-export * from "./OverviewReportsResponse.js";
 export * from "./PartnersReportsRequestOrder.js";
 export * from "./PartnersReportsRequestSort.js";
-export * from "./PartnersReportsResponse.js";
+export * from "./ReportsCustomersResponse.js";
+export * from "./ReportsLinksResponse.js";
+export * from "./ReportsOverviewResponse.js";
+export * from "./ReportsPartnersResponse.js";
+export * from "./ReportsTimeseriesResponse.js";
 export * from "./TimeseriesReportsRequestGranularity.js";
-export * from "./TimeseriesReportsResponse.js";

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

@@ -1,10 +1,10 @@
-export * from "./CustomerStatsReportsResponse.js";
 export * from "./LinksReportsRequestOrder.js";
 export * from "./LinksReportsRequestSort.js";
-export * from "./LinksReportsResponse.js";
-export * from "./OverviewReportsResponse.js";
 export * from "./PartnersReportsRequestOrder.js";
 export * from "./PartnersReportsRequestSort.js";
-export * from "./PartnersReportsResponse.js";
+export * from "./ReportsCustomersResponse.js";
+export * from "./ReportsLinksResponse.js";
+export * from "./ReportsOverviewResponse.js";
+export * from "./ReportsPartnersResponse.js";
+export * from "./ReportsTimeseriesResponse.js";
 export * from "./TimeseriesReportsRequestGranularity.js";
-export * from "./TimeseriesReportsResponse.js";

package/dist/api/resources/transactions/client/Client.d.ts

@@ -11,11 +11,14 @@ export declare class TransactionsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<TransactionsClient.Options>;
     constructor(options: TransactionsClient.Options);
     /**
+     * Lists transactions. Filter by program, partner, customer or status, and page with cursors.
+     *
      * @param {ToltApi.ListTransactionsRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
@@ -23,120 +26,139 @@ export declare class TransactionsClient {
      * @example
      *     await client.transactions.list()
      */
-    list(request?: ToltApi.ListTransactionsRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListTransactionsResponse>;
-    private __list;
+    list(request?: ToltApi.ListTransactionsRequest, requestOptions?: TransactionsClient.RequestOptions): Promise<core.Page<ToltApi.Transaction, ToltApi.ListTransactionsResponse>>;
     /**
      * Supports historical created_at values. product_id and product_name are stored and returned in product_ids and product_names arrays.
      *
-     * @param {ToltApi.CreateTransactionsRequest} request
+     * @param {ToltApi.CreateTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.create({
-     *         amount: 1,
-     *         customer_id: "customer_id"
+     *         product_id: "prod_pro",
+     *         product_name: "Pro plan",
+     *         amount: 5000,
+     *         customer_id: "cus_LBfjvtfct9pVUeLojMHiGnXv",
+     *         billing_type: "subscription",
+     *         interval: "month",
+     *         source: "api"
      *     })
      */
-    create(request: ToltApi.CreateTransactionsRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateTransactionsResponse>;
+    create(request: ToltApi.CreateTransactionRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateTransactionResponse>;
     private __create;
     /**
-     * @param {ToltApi.GetTransactionsRequest} request
+     * Gets a transaction by ID, with its amount, status, billing details, products and the customer it belongs to.
+     *
+     * @param {ToltApi.GetTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.get({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
-    get(request: ToltApi.GetTransactionsRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetTransactionsResponse>;
+    get(request: ToltApi.GetTransactionRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetTransactionResponse>;
     private __get;
     /**
-     * @param {ToltApi.UpdateTransactionsRequest} request
+     * Updates a transaction's amount, status, billing or product details. Refunded transactions cannot be modified.
+     *
+     * @param {ToltApi.UpdateTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.update({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA",
+     *         amount: 5000,
+     *         product_name: "Pro plan"
      *     })
      */
-    update(request: ToltApi.UpdateTransactionsRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateTransactionsResponse>;
+    update(request: ToltApi.UpdateTransactionRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateTransactionResponse>;
     private __update;
     /**
-     * @param {ToltApi.DeleteTransactionsRequest} request
+     * Deletes a transaction. Refunded transactions and transactions that already have commissions cannot be deleted.
+     *
+     * @param {ToltApi.DeleteTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.delete({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
-    delete(request: ToltApi.DeleteTransactionsRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteTransactionsResponse>;
+    delete(request: ToltApi.DeleteTransactionRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteTransactionResponse>;
     private __delete;
     /**
      * Unpaid commissions are zeroed while preserving their original deducted commission amount, and affected draft invoices are recalculated. Paid commissions and commissions linked to legacy autopayout invoices receive a negative reversal.
      *
-     * @param {ToltApi.RefundTransactionsRequest} request
+     * @param {ToltApi.RefundTransactionRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.refund({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
-    refund(request: ToltApi.RefundTransactionsRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.RefundTransactionsResponse>;
+    refund(request: ToltApi.RefundTransactionRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.RefundTransactionResponse>;
     private __refund;
     /**
      * Re-queues the transaction for asynchronous flow processing. Only transactions without an existing commission are eligible, so a rerun cannot create a duplicate commission.
      *
-     * @param {ToltApi.RerunFlowsTransactionsRequest} request
+     * @param {ToltApi.RerunTransactionFlowsRequest} request
      * @param {TransactionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.transactions.rerunFlows({
-     *         id: "id"
+     *         id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
-    rerunFlows(request: ToltApi.RerunFlowsTransactionsRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.RerunFlowsTransactionsResponse>;
+    rerunFlows(request: ToltApi.RerunTransactionFlowsRequest, requestOptions?: TransactionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.RerunTransactionFlowsResponse>;
     private __rerunFlows;
 }