@tolt/api 0.6.1 → 1.0.0

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

@@ -18,13 +18,14 @@ export declare class CommissionsClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.commissions.bulkApprove({
-     *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+     *         ids: ["comm_X85RLnefjTCNrypH4MA1PdSp", "comm_3RtV9kQ2mW8nX5pL1sB7cD4f"]
      *     })
      */
     bulkApprove(request: ToltApi.BulkApproveCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.BulkApproveCommissionsResponse>;
@@ -37,23 +38,27 @@ export declare class CommissionsClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ContentTooLargeError}
      * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.commissions.bulkDecline({
-     *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+     *         ids: ["comm_X85RLnefjTCNrypH4MA1PdSp", "comm_3RtV9kQ2mW8nX5pL1sB7cD4f"]
      *     })
      */
     bulkDecline(request: ToltApi.BulkDeclineCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.BulkDeclineCommissionsResponse>;
     private __bulkDecline;
     /**
+     * Lists commissions. Filter by program, partner, customer, transaction, status or type, and page with cursors.
+     *
      * @param {ToltApi.ListCommissionsRequest} request
      * @param {CommissionsClient.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}
@@ -61,121 +66,142 @@ export declare class CommissionsClient {
      * @example
      *     await client.commissions.list()
      */
-    list(request?: ToltApi.ListCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListCommissionsResponse>;
-    private __list;
+    list(request?: ToltApi.ListCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): Promise<core.Page<ToltApi.Commission, ToltApi.ListCommissionsResponse>>;
     /**
      * Supports historical created_at values. Status defaults to approved when omitted.
      *
-     * @param {ToltApi.CreateCommissionsRequest} request
+     * @param {ToltApi.CreateCommissionRequest} request
      * @param {CommissionsClient.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.commissions.create({
-     *         "key": "value"
+     *         amount: 1000,
+     *         customer_id: "cus_LBfjvtfct9pVUeLojMHiGnXv",
+     *         revenue: 5000,
+     *         status: "approved",
+     *         source: "api",
+     *         transaction_id: "txn_fB3egT1sKNVNu3ZYuU1ypYDA"
      *     })
      */
-    create(request: ToltApi.CreateCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateCommissionsResponse>;
+    create(request: ToltApi.CreateCommissionRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateCommissionResponse>;
     private __create;
     /**
-     * @param {ToltApi.GetCommissionsRequest} request
+     * Gets a commission by ID, with its amount, status, type and partner, plus its customer and transaction when it has them.
+     *
+     * @param {ToltApi.GetCommissionRequest} request
      * @param {CommissionsClient.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.commissions.get({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp"
      *     })
      */
-    get(request: ToltApi.GetCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetCommissionsResponse>;
+    get(request: ToltApi.GetCommissionRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetCommissionResponse>;
     private __get;
     /**
      * 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 {ToltApi.UpdateCommissionRequest} request
      * @param {CommissionsClient.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.commissions.update({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp",
+     *         amount: 1000,
+     *         revenue: 5000,
+     *         status: "approved"
      *     })
      */
-    update(request: ToltApi.UpdateCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateCommissionsResponse>;
+    update(request: ToltApi.UpdateCommissionRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateCommissionResponse>;
     private __update;
     /**
-     * @param {ToltApi.DeleteCommissionsRequest} request
+     * Deletes a commission. Fails for paid commissions, refund commissions, commissions on a refunded transaction, and those on a confirmed or legacy autopayout invoice.
+     *
+     * @param {ToltApi.DeleteCommissionRequest} request
      * @param {CommissionsClient.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.commissions.delete({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp"
      *     })
      */
-    delete(request: ToltApi.DeleteCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteCommissionsResponse>;
+    delete(request: ToltApi.DeleteCommissionRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteCommissionResponse>;
     private __delete;
     /**
-     * @param {ToltApi.ApproveCommissionsRequest} request
+     * Marks a commission approved so it is included in the next payout. Fails for paid commissions, refund commissions, commissions on a refunded transaction, and those on a confirmed or legacy autopayout invoice.
+     *
+     * @param {ToltApi.ApproveCommissionRequest} request
      * @param {CommissionsClient.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.commissions.approve({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp"
      *     })
      */
-    approve(request: ToltApi.ApproveCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ApproveCommissionsResponse>;
+    approve(request: ToltApi.ApproveCommissionRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ApproveCommissionResponse>;
     private __approve;
     /**
-     * @param {ToltApi.DeclineCommissionsRequest} request
+     * Marks a commission declined so it is left out of payouts until it is approved again. Fails for paid commissions, refund commissions, commissions on a refunded transaction, and those on a confirmed or legacy autopayout invoice.
+     *
+     * @param {ToltApi.DeclineCommissionRequest} request
      * @param {CommissionsClient.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.commissions.decline({
-     *         id: "id"
+     *         id: "comm_X85RLnefjTCNrypH4MA1PdSp"
      *     })
      */
-    decline(request: ToltApi.DeclineCommissionsRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeclineCommissionsResponse>;
+    decline(request: ToltApi.DeclineCommissionRequest, requestOptions?: CommissionsClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeclineCommissionResponse>;
     private __decline;
 }