@tolt/api 0.4.0 → 0.6.0

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

@@ -12,7 +12,7 @@ export class CommissionsClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * Approves up to 100 commissions. Each id is processed on its own and the response reports the outcome per id, with the error code for any that were refused.
+     * Approves up to 100 commissions and reports the outcome per id. Successful changes and affected draft invoice totals commit together.
      *
      * @param {ToltApi.BulkApproveCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -24,14 +24,14 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.bulkApproveCommissions({
+     *     await client.commissions.bulkApprove({
      *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
      *     })
      */
-    bulkApproveCommissions(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__bulkApproveCommissions(request, requestOptions));
+    bulkApprove(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__bulkApprove(request, requestOptions));
     }
-    async __bulkApproveCommissions(request, requestOptions) {
+    async __bulkApprove(request, requestOptions) {
         const _authRequest = await this._options.authProvider.getAuthRequest();
         const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
         const _response = await core.fetcher({
@@ -75,7 +75,7 @@ export class CommissionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/commissions/bulk/approve");
     }
     /**
-     * Declines up to 100 commissions. Each id is processed on its own and the response reports the outcome per id, with the error code for any that were refused.
+     * Declines up to 100 commissions and reports the outcome per id. Successful changes and affected draft invoice totals commit together.
      *
      * @param {ToltApi.BulkDeclineCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -87,14 +87,14 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.bulkDeclineCommissions({
+     *     await client.commissions.bulkDecline({
      *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
      *     })
      */
-    bulkDeclineCommissions(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__bulkDeclineCommissions(request, requestOptions));
+    bulkDecline(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__bulkDecline(request, requestOptions));
     }
-    async __bulkDeclineCommissions(request, requestOptions) {
+    async __bulkDecline(request, requestOptions) {
         const _authRequest = await this._options.authProvider.getAuthRequest();
         const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
         const _response = await core.fetcher({
@@ -148,12 +148,12 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.listCommissions()
+     *     await client.commissions.list()
      */
-    listCommissions(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__listCommissions(request, requestOptions));
+    list(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
     }
-    async __listCommissions(request = {}, requestOptions) {
+    async __list(request = {}, requestOptions) {
         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, transaction_id: transactionId, status, type: type_, search, } = request;
         const _queryParams = {
             limit,
@@ -214,7 +214,9 @@ export class CommissionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/commissions");
     }
     /**
-     * @param {ToltApi.CreateCommissionRequest} request
+     * Supports historical created_at values. Status defaults to approved when omitted.
+     *
+     * @param {ToltApi.CreateCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -225,14 +227,14 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.createCommission({
+     *     await client.commissions.create({
      *         "key": "value"
      *     })
      */
-    createCommission(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__createCommission(request, requestOptions));
+    create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
     }
-    async __createCommission(request, requestOptions) {
+    async __create(request, requestOptions) {
         const _authRequest = await this._options.authProvider.getAuthRequest();
         const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
         const _response = await core.fetcher({
@@ -275,7 +277,7 @@ export class CommissionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/commissions");
     }
     /**
-     * @param {ToltApi.GetCommissionRequest} request
+     * @param {ToltApi.GetCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
@@ -285,14 +287,14 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.getCommission({
+     *     await client.commissions.get({
      *         id: "id"
      *     })
      */
-    getCommission(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getCommission(request, requestOptions));
+    get(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
     }
-    async __getCommission(request, requestOptions) {
+    async __get(request, requestOptions) {
         const { id } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
         const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
@@ -331,7 +333,9 @@ export class CommissionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/commissions/{id}");
     }
     /**
-     * @param {ToltApi.UpdateCommissionRequest} request
+     * Unpaid commissions can be changed unless linked to a confirmed invoice or legacy autopayout invoice. Affected draft invoice totals are recalculated.
+     *
+     * @param {ToltApi.UpdateCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -343,14 +347,14 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.updateCommission({
+     *     await client.commissions.update({
      *         id: "id"
      *     })
      */
-    updateCommission(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__updateCommission(request, requestOptions));
+    update(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
     }
-    async __updateCommission(request, requestOptions) {
+    async __update(request, requestOptions) {
         const { id, ..._body } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
         const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
@@ -396,7 +400,7 @@ export class CommissionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v2/commissions/{id}");
     }
     /**
-     * @param {ToltApi.DeleteCommissionRequest} request
+     * @param {ToltApi.DeleteCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -408,14 +412,14 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.deleteCommission({
+     *     await client.commissions.delete({
      *         id: "id"
      *     })
      */
-    deleteCommission(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__deleteCommission(request, requestOptions));
+    delete(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__delete(request, requestOptions));
     }
-    async __deleteCommission(request, requestOptions) {
+    async __delete(request, requestOptions) {
         const { id } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
         const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
@@ -458,7 +462,7 @@ export class CommissionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v2/commissions/{id}");
     }
     /**
-     * @param {ToltApi.ApproveCommissionRequest} request
+     * @param {ToltApi.ApproveCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -470,14 +474,14 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.approveCommission({
+     *     await client.commissions.approve({
      *         id: "id"
      *     })
      */
-    approveCommission(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__approveCommission(request, requestOptions));
+    approve(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__approve(request, requestOptions));
     }
-    async __approveCommission(request, requestOptions) {
+    async __approve(request, requestOptions) {
         const { id } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
         const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
@@ -520,7 +524,7 @@ export class CommissionsClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/commissions/{id}/approve");
     }
     /**
-     * @param {ToltApi.DeclineCommissionRequest} request
+     * @param {ToltApi.DeclineCommissionsRequest} request
      * @param {CommissionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -532,14 +536,14 @@ export class CommissionsClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.commissions.declineCommission({
+     *     await client.commissions.decline({
      *         id: "id"
      *     })
      */
-    declineCommission(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__declineCommission(request, requestOptions));
+    decline(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__decline(request, requestOptions));
     }
-    async __declineCommission(request, requestOptions) {
+    async __decline(request, requestOptions) {
         const { id } = request;
         const _authRequest = await this._options.authProvider.getAuthRequest();
         const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);

package/dist/api/resources/commissions/client/requests/{ApproveCommissionRequest.d.ts → ApproveCommissionsRequest.d.ts}

@@ -4,6 +4,6 @@
  *         id: "id"
  *     }
  */
-export interface ApproveCommissionRequest {
+export interface ApproveCommissionsRequest {
     id: string;
 }

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

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

package/dist/api/resources/commissions/client/requests/{DeclineCommissionRequest.d.ts → DeleteCommissionsRequest.d.ts}

@@ -4,6 +4,6 @@
  *         id: "id"
  *     }
  */
-export interface DeclineCommissionRequest {
+export interface DeleteCommissionsRequest {
     id: string;
 }

package/dist/api/resources/commissions/client/requests/{GetCommissionRequest.d.ts → GetCommissionsRequest.d.ts}

@@ -4,6 +4,6 @@
  *         id: "id"
  *     }
  */
-export interface GetCommissionRequest {
+export interface GetCommissionsRequest {
     id: string;
 }

package/dist/api/resources/commissions/client/requests/{UpdateCommissionRequest.d.ts → UpdateCommissionsRequest.d.ts}

@@ -4,7 +4,7 @@
  *         id: "id"
  *     }
  */
-export interface UpdateCommissionRequest {
+export interface UpdateCommissionsRequest {
     id: string;
     /** Monetary amount as an integer in the smallest currency unit (cents), e.g. 500 = 5.00 */
     amount?: number;

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

@@ -1,8 +1,8 @@
-export type { ApproveCommissionRequest } from "./ApproveCommissionRequest.js";
+export type { ApproveCommissionsRequest } from "./ApproveCommissionsRequest.js";
 export type { BulkApproveCommissionsRequest } from "./BulkApproveCommissionsRequest.js";
 export type { BulkDeclineCommissionsRequest } from "./BulkDeclineCommissionsRequest.js";
-export type { DeclineCommissionRequest } from "./DeclineCommissionRequest.js";
-export type { DeleteCommissionRequest } from "./DeleteCommissionRequest.js";
-export type { GetCommissionRequest } from "./GetCommissionRequest.js";
+export type { DeclineCommissionsRequest } from "./DeclineCommissionsRequest.js";
+export type { DeleteCommissionsRequest } from "./DeleteCommissionsRequest.js";
+export type { GetCommissionsRequest } from "./GetCommissionsRequest.js";
 export type { ListCommissionsRequest } from "./ListCommissionsRequest.js";
-export type { UpdateCommissionRequest } from "./UpdateCommissionRequest.js";
+export type { UpdateCommissionsRequest } from "./UpdateCommissionsRequest.js";

package/dist/api/resources/commissions/types/{CreateCommissionResponse.d.ts → ApproveCommissionsResponse.d.ts}

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

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

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

package/dist/api/resources/commissions/types/{ApproveCommissionResponse.d.ts → CreateCommissionsResponse.d.ts}

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

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

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

package/dist/api/resources/commissions/types/{DeclineCommissionResponse.d.ts → DeleteCommissionsResponse.d.ts}

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

package/dist/api/resources/commissions/types/{GetCommissionResponse.d.ts → GetCommissionsResponse.d.ts}

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

package/dist/api/resources/commissions/types/{DeleteCommissionResponse.d.ts → UpdateCommissionsResponse.d.ts}

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

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

@@ -1,12 +1,12 @@
-export * from "./ApproveCommissionResponse.js";
+export * from "./ApproveCommissionsResponse.js";
 export * from "./BulkApproveCommissionsResponse.js";
 export * from "./BulkDeclineCommissionsResponse.js";
-export * from "./CreateCommissionRequest.js";
-export * from "./CreateCommissionResponse.js";
-export * from "./DeclineCommissionResponse.js";
-export * from "./DeleteCommissionResponse.js";
-export * from "./GetCommissionResponse.js";
+export * from "./CreateCommissionsRequest.js";
+export * from "./CreateCommissionsResponse.js";
+export * from "./DeclineCommissionsResponse.js";
+export * from "./DeleteCommissionsResponse.js";
+export * from "./GetCommissionsResponse.js";
 export * from "./ListCommissionsRequestOrder.js";
 export * from "./ListCommissionsRequestSort.js";
 export * from "./ListCommissionsResponse.js";
-export * from "./UpdateCommissionResponse.js";
+export * from "./UpdateCommissionsResponse.js";

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

@@ -1,12 +1,12 @@
-export * from "./ApproveCommissionResponse.js";
+export * from "./ApproveCommissionsResponse.js";
 export * from "./BulkApproveCommissionsResponse.js";
 export * from "./BulkDeclineCommissionsResponse.js";
-export * from "./CreateCommissionRequest.js";
-export * from "./CreateCommissionResponse.js";
-export * from "./DeclineCommissionResponse.js";
-export * from "./DeleteCommissionResponse.js";
-export * from "./GetCommissionResponse.js";
+export * from "./CreateCommissionsRequest.js";
+export * from "./CreateCommissionsResponse.js";
+export * from "./DeclineCommissionsResponse.js";
+export * from "./DeleteCommissionsResponse.js";
+export * from "./GetCommissionsResponse.js";
 export * from "./ListCommissionsRequestOrder.js";
 export * from "./ListCommissionsRequestSort.js";
 export * from "./ListCommissionsResponse.js";
-export * from "./UpdateCommissionResponse.js";
+export * from "./UpdateCommissionsResponse.js";

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

@@ -21,27 +21,28 @@ export declare class CustomersClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.customers.listCustomers()
+     *     await client.customers.list()
      */
-    listCustomers(request?: ToltApi.ListCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListCustomersResponse>;
-    private __listCustomers;
+    list(request?: ToltApi.ListCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListCustomersResponse>;
+    private __list;
     /**
-     * @param {ToltApi.CreateCustomerRequest} request
+     * @param {ToltApi.CreateCustomersRequest} request
      * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ConflictError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.customers.createCustomer()
+     *     await client.customers.create()
      */
-    createCustomer(request?: ToltApi.CreateCustomerRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateCustomerResponse>;
-    private __createCustomer;
+    create(request?: ToltApi.CreateCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateCustomersResponse>;
+    private __create;
     /**
-     * @param {ToltApi.GetCustomerRequest} request
+     * @param {ToltApi.GetCustomersRequest} request
      * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
@@ -51,34 +52,36 @@ export declare class CustomersClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.customers.getCustomer({
+     *     await client.customers.get({
      *         id: "id"
      *     })
      */
-    getCustomer(request: ToltApi.GetCustomerRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetCustomerResponse>;
-    private __getCustomer;
+    get(request: ToltApi.GetCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetCustomersResponse>;
+    private __get;
     /**
-     * @param {ToltApi.UpdateCustomerRequest} request
+     * @param {ToltApi.UpdateCustomersRequest} request
      * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.ConflictError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.customers.updateCustomer({
+     *     await client.customers.update({
      *         id: "id"
      *     })
      */
-    updateCustomer(request: ToltApi.UpdateCustomerRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateCustomerResponse>;
-    private __updateCustomer;
+    update(request: ToltApi.UpdateCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateCustomersResponse>;
+    private __update;
     /**
-     * @param {ToltApi.DeleteCustomerRequest} request
+     * @param {ToltApi.DeleteCustomersRequest} request
      * @param {CustomersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
      * @throws {@link ToltApi.TooManyRequestsError}
@@ -86,10 +89,10 @@ export declare class CustomersClient {
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
-     *     await client.customers.deleteCustomer({
+     *     await client.customers.delete({
      *         id: "id"
      *     })
      */
-    deleteCustomer(request: ToltApi.DeleteCustomerRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteCustomerResponse>;
-    private __deleteCustomer;
+    delete(request: ToltApi.DeleteCustomersRequest, requestOptions?: CustomersClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteCustomersResponse>;
+    private __delete;
 }