@tolt/api 1.1.0 → 1.3.0

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

@@ -203,4 +203,47 @@ export declare class PartnersClient {
      */
     suspend(request: ToltApi.SuspendPartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.SuspendPartnerResponse>;
     private __suspend;
+    /**
+     * Puts one or more tags on the partner. Each tag must belong to the partner's program; tags the partner already has stay as they are. Returns every tag the partner now has, and sends partner.updated if any tag was added.
+     *
+     * @param {ToltApi.AddPartnerTagsRequest} request
+     * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @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.partners.addPartnerTags({
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY",
+     *         tag_ids: ["ptag_zDEcdqNuNBPcokarWxBnk9gB"]
+     *     })
+     */
+    addPartnerTags(request: ToltApi.AddPartnerTagsRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.AddPartnerTagsResponse>;
+    private __addPartnerTags;
+    /**
+     * Takes the tag off the partner. Removing a tag the partner does not have succeeds and changes nothing. Returns every tag the partner still has, and sends partner.updated if the tag was removed.
+     *
+     * @param {ToltApi.RemovePartnerTagRequest} request
+     * @param {PartnersClient.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.partners.removePartnerTag({
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY",
+     *         tag_id: "ptag_zDEcdqNuNBPcokarWxBnk9gB"
+     *     })
+     */
+    removePartnerTag(request: ToltApi.RemovePartnerTagRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.RemovePartnerTagResponse>;
+    private __removePartnerTag;
 }

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

@@ -156,7 +156,7 @@ export class PartnersClient {
      */
     async list(request = {}, requestOptions) {
         const list = core.HttpResponsePromise.interceptFunction(async (request) => {
-            const { limit, order, sort, starting_after: startingAfter, ending_before: endingBefore, created_after: createdAfter, created_before: createdBefore, updated_after: updatedAfter, updated_before: updatedBefore, status, program_id: programId, group_id: groupId, search, } = request;
+            const { limit, order, sort, starting_after: startingAfter, ending_before: endingBefore, created_after: createdAfter, created_before: createdBefore, updated_after: updatedAfter, updated_before: updatedBefore, status, program_id: programId, group_id: groupId, tag_id: tagId, search, } = request;
             const _queryParams = {
                 limit,
                 order: order != null ? order : undefined,
@@ -170,6 +170,7 @@ export class PartnersClient {
                 status: status != null ? status : undefined,
                 program_id: programId,
                 group_id: groupId,
+                tag_id: tagId,
                 search,
             };
             const _authRequest = await this._options.authProvider.getAuthRequest();
@@ -626,4 +627,134 @@ export class PartnersClient {
         }
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/partners/{id}/suspend");
     }
+    /**
+     * Puts one or more tags on the partner. Each tag must belong to the partner's program; tags the partner already has stay as they are. Returns every tag the partner now has, and sends partner.updated if any tag was added.
+     *
+     * @param {ToltApi.AddPartnerTagsRequest} request
+     * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @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.partners.addPartnerTags({
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY",
+     *         tag_ids: ["ptag_zDEcdqNuNBPcokarWxBnk9gB"]
+     *     })
+     */
+    addPartnerTags(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__addPartnerTags(request, requestOptions));
+    }
+    async __addPartnerTags(request, requestOptions) {
+        const { id, ..._body } = request;
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.ToltApiEnvironment.Default, `v2/partners/${core.url.encodePathParam(id, errors.ToltApiError)}/tags`),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            requestType: "json",
+            body: mergeAdditionalBodyParameters(_body, requestOptions?.additionalBodyParameters),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new ToltApi.ContentTooLargeError(_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,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/partners/{id}/tags");
+    }
+    /**
+     * Takes the tag off the partner. Removing a tag the partner does not have succeeds and changes nothing. Returns every tag the partner still has, and sends partner.updated if the tag was removed.
+     *
+     * @param {ToltApi.RemovePartnerTagRequest} request
+     * @param {PartnersClient.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.partners.removePartnerTag({
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY",
+     *         tag_id: "ptag_zDEcdqNuNBPcokarWxBnk9gB"
+     *     })
+     */
+    removePartnerTag(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__removePartnerTag(request, requestOptions));
+    }
+    async __removePartnerTag(request, requestOptions) {
+        const { id, tag_id: tagId } = request;
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.ToltApiEnvironment.Default, `v2/partners/${core.url.encodePathParam(id, errors.ToltApiError)}/tags/${core.url.encodePathParam(tagId, errors.ToltApiError)}`),
+            method: "DELETE",
+            headers: _headers,
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 413:
+                    throw new ToltApi.ContentTooLargeError(_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,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v2/partners/{id}/tags/{tag_id}");
+    }
 }

package/dist/api/resources/partners/client/requests/AddPartnerTagsRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         id: "part_NLYzgNKuSuASvrvoxNtau6SY",
+ *         tag_ids: ["ptag_zDEcdqNuNBPcokarWxBnk9gB"]
+ *     }
+ */
+export interface AddPartnerTagsRequest {
+    id: string;
+    /** Ids of the tags to add (ptag_...), as returned when listing partner tags. Each must belong to the partner's program. Tags the partner already has stay as they are. */
+    tag_ids: string[];
+}

package/dist/api/resources/partners/client/requests/AddPartnerTagsRequest.js

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

package/dist/api/resources/partners/client/requests/ListPartnersRequest.d.ts

@@ -28,6 +28,8 @@ export interface ListPartnersRequest {
     program_id?: string;
     /** Limit to partners in one group, by the group id (grp_...) as returned when listing groups. */
     group_id?: string;
+    /** Limit to partners with this tag, by the tag id (ptag_...) as returned when listing partner tags. */
+    tag_id?: string;
     /** Text matched anywhere in the partner's id, email, first name, last name or company name, ignoring case. */
     search?: string;
 }

package/dist/api/resources/partners/client/requests/RemovePartnerTagRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @example
+ *     {
+ *         id: "part_NLYzgNKuSuASvrvoxNtau6SY",
+ *         tag_id: "ptag_zDEcdqNuNBPcokarWxBnk9gB"
+ *     }
+ */
+export interface RemovePartnerTagRequest {
+    id: string;
+    tag_id: string;
+}

package/dist/api/resources/partners/client/requests/RemovePartnerTagRequest.js

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

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

@@ -1,3 +1,4 @@
+export type { AddPartnerTagsRequest } from "./AddPartnerTagsRequest.js";
 export type { ApprovePartnerRequest } from "./ApprovePartnerRequest.js";
 export type { BulkApprovePartnersRequest } from "./BulkApprovePartnersRequest.js";
 export type { BulkRejectPartnersRequest } from "./BulkRejectPartnersRequest.js";
@@ -5,5 +6,6 @@ export { CreatePartnerRequest } from "./CreatePartnerRequest.js";
 export type { GetPartnerRequest } from "./GetPartnerRequest.js";
 export type { ListPartnersRequest } from "./ListPartnersRequest.js";
 export type { RejectPartnerRequest } from "./RejectPartnerRequest.js";
+export type { RemovePartnerTagRequest } from "./RemovePartnerTagRequest.js";
 export type { SuspendPartnerRequest } from "./SuspendPartnerRequest.js";
 export type { UpdatePartnerRequest } from "./UpdatePartnerRequest.js";

package/dist/api/resources/partners/types/AddPartnerTagsResponse.d.ts

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

package/dist/api/resources/partners/types/AddPartnerTagsResponse.js

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

package/dist/api/resources/partners/types/RemovePartnerTagResponse.d.ts

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

package/dist/api/resources/partners/types/RemovePartnerTagResponse.js

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

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

@@ -1,3 +1,4 @@
+export * from "./AddPartnerTagsResponse.js";
 export * from "./ApprovePartnerResponse.js";
 export * from "./BulkApprovePartnersResponse.js";
 export * from "./BulkRejectPartnersResponse.js";
@@ -8,5 +9,6 @@ export * from "./ListPartnersRequestSort.js";
 export * from "./ListPartnersRequestStatus.js";
 export * from "./ListPartnersResponse.js";
 export * from "./RejectPartnerResponse.js";
+export * from "./RemovePartnerTagResponse.js";
 export * from "./SuspendPartnerResponse.js";
 export * from "./UpdatePartnerResponse.js";

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

@@ -1,3 +1,4 @@
+export * from "./AddPartnerTagsResponse.js";
 export * from "./ApprovePartnerResponse.js";
 export * from "./BulkApprovePartnersResponse.js";
 export * from "./BulkRejectPartnersResponse.js";
@@ -8,5 +9,6 @@ export * from "./ListPartnersRequestSort.js";
 export * from "./ListPartnersRequestStatus.js";
 export * from "./ListPartnersResponse.js";
 export * from "./RejectPartnerResponse.js";
+export * from "./RemovePartnerTagResponse.js";
 export * from "./SuspendPartnerResponse.js";
 export * from "./UpdatePartnerResponse.js";

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

@@ -17,7 +17,7 @@ export interface CreateTransactionRequest {
     product_id?: string;
     /** Readable name of the purchased product, such as Pro plan. It is saved as the transaction's product name, which revenue_by_product groups revenue by; flows match on product_id, not on this name. */
     product_name?: string;
-    /** The payment amount in the smallest unit of the program currency (cents for USD); percentage commissions are calculated from it. */
+    /** The payment amount in the smallest unit of the program currency (cents for USD); percentage commissions are calculated from it. It must be 0 or more: to reverse a payment, refund its transaction instead of recording a negative amount. */
     amount: number;
     /** Id of the customer who paid (cus_...), as returned when listing customers. The transaction goes to that customer's partner and program, and the customer becomes active. */
     customer_id: string;

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

@@ -1,4 +1,6 @@
 export interface EmbedToken {
     token: string;
     expires_at: string;
+    /** The partner the token is for, including one this call just created. */
+    partner_id: string;
 }

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

@@ -2,6 +2,8 @@ import type * as ToltApi from "../index.js";
 export interface PartnerDetails extends ToltApi.Partner {
     /** Custom-field answers with their questions. Empty when no answers exist. */
     custom_fields: PartnerDetails.CustomFields.Item[];
+    /** Tags on the partner, sorted by name. Empty when the partner has none. */
+    tags: ToltApi.PartnerTagSummary[];
 }
 export declare namespace PartnerDetails {
     type CustomFields = CustomFields.Item[];

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

@@ -0,0 +1,11 @@
+export interface PartnerTag {
+    id: string;
+    name: string;
+    /** Hex color of the tag in the dashboard. */
+    color: string;
+    program_id: string;
+    /** How many partners have the tag. */
+    partners_count: number;
+    created_at: string;
+    updated_at: string;
+}

package/dist/api/types/PartnerTag.js

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

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

@@ -0,0 +1,5 @@
+export interface PartnerTagSummary {
+    id: string;
+    name: string;
+    color: string;
+}

package/dist/api/types/PartnerTagSummary.js

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

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

@@ -10,6 +10,8 @@ export * from "./Group.js";
 export * from "./Link.js";
 export * from "./Partner.js";
 export * from "./PartnerDetails.js";
+export * from "./PartnerTag.js";
+export * from "./PartnerTagSummary.js";
 export * from "./Program.js";
 export * from "./PromotionCode.js";
 export * from "./ReportsCustomerStats.js";

package/dist/api/types/index.js

@@ -10,6 +10,8 @@ export * from "./Group.js";
 export * from "./Link.js";
 export * from "./Partner.js";
 export * from "./PartnerDetails.js";
+export * from "./PartnerTag.js";
+export * from "./PartnerTagSummary.js";
 export * from "./Program.js";
 export * from "./PromotionCode.js";
 export * from "./ReportsCustomerStats.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolt/api",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "TypeScript SDK for the Tolt Public API",
   "license": "Apache-2.0",
   "repository": {