@tolt/api 1.3.0 → 1.4.0

package/dist/BaseClient.js

@@ -5,7 +5,7 @@ import * as core from "./core/index.js";
 export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
-        "User-Agent": "tolt-typescript/1.3.0",
+        "User-Agent": "tolt-typescript/1.4.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options?.headers);

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

@@ -11,7 +11,7 @@ export declare class EmbedTokensClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<EmbedTokensClient.Options>;
     constructor(options: EmbedTokensClient.Options);
     /**
-     * Mint a short-lived, partner-scoped token for the embedded referral dashboard. Safe to send to the browser. With partner (email and program_id), the partner is created when the program has none with that email, so one call covers a user's first visit.
+     * Mint a short-lived, partner-scoped token for the embedded referral dashboard. Safe to send to the browser. With partner (email and program_id, plus your own external_id), the partner is found by external_id, then by email, and created when the program has neither, so one call covers a user's first visit.
      *
      * @param {ToltApi.CreateEmbedTokenRequest} request
      * @param {EmbedTokensClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -19,6 +19,7 @@ export declare class EmbedTokensClient {
      * @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}

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

@@ -12,7 +12,7 @@ export class EmbedTokensClient {
         this._options = normalizeClientOptionsWithAuth(options);
     }
     /**
-     * Mint a short-lived, partner-scoped token for the embedded referral dashboard. Safe to send to the browser. With partner (email and program_id), the partner is created when the program has none with that email, so one call covers a user's first visit.
+     * Mint a short-lived, partner-scoped token for the embedded referral dashboard. Safe to send to the browser. With partner (email and program_id, plus your own external_id), the partner is found by external_id, then by email, and created when the program has neither, so one call covers a user's first visit.
      *
      * @param {ToltApi.CreateEmbedTokenRequest} request
      * @param {EmbedTokensClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -20,6 +20,7 @@ export class EmbedTokensClient {
      * @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}
@@ -61,6 +62,8 @@ export class EmbedTokensClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 409:
+                    throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
                 case 413:
                     throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:

package/dist/api/resources/embedTokens/client/requests/CreateEmbedTokenRequest.d.ts

@@ -5,18 +5,20 @@
 export interface CreateEmbedTokenRequest {
     /** Id of an existing partner (part_...). Send this or partner, not both. */
     partner_id?: string;
-    /** Find the partner by email within the program, or create them (active, with a referral link) when the program has no partner with that email. Send this or partner_id, not both. */
+    /** Find the partner by external_id or email within the program, or create them (active, with a referral link) when the program has no such partner. Send this or partner_id, not both. */
     partner?: CreateEmbedTokenRequest.Partner;
 }
 export declare namespace CreateEmbedTokenRequest {
     /**
-     * Find the partner by email within the program, or create them (active, with a referral link) when the program has no partner with that email. Send this or partner_id, not both.
+     * Find the partner by external_id or email within the program, or create them (active, with a referral link) when the program has no such partner. Send this or partner_id, not both.
      */
     interface Partner {
         /** Email of the partner, matched without regard to case. */
         email: string;
         /** Program the partner belongs to (prg_...). */
         program_id: string;
+        /** Your own id for the partner, such as the user id in your app. Matched before email, so the partner is still found after their email changes. Saved on a partner found by email who has none yet, and on a newly created partner. */
+        external_id?: string | undefined;
         /** First name, used only when the partner is created. */
         first_name?: string | undefined;
         /** Last name, used only when the partner is created. */

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

@@ -52,7 +52,7 @@ export declare class PartnersClient {
     bulkReject(request: ToltApi.BulkRejectPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.BulkRejectPartnersResponse>;
     private __bulkReject;
     /**
-     * Lists onboarded partners. Filter by status, program or group, search by name, email or company, and page with cursors.
+     * Lists onboarded partners. Filter by status, program, group or external_id, search by name, email or company, and page with cursors.
      *
      * @param {ToltApi.ListPartnersRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -86,6 +86,7 @@ export declare class PartnersClient {
      *     await client.partners.create({
      *         email: "sam@example.com",
      *         program_id: "prg_T6z8aRW3XCmvFWP972RKxpAd",
+     *         external_id: "user_123",
      *         first_name: "Sam",
      *         last_name: "Taylor",
      *         group_id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a",
@@ -126,6 +127,7 @@ export declare class PartnersClient {
      * @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}

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

@@ -139,7 +139,7 @@ export class PartnersClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/partners/bulk/reject");
     }
     /**
-     * Lists onboarded partners. Filter by status, program or group, search by name, email or company, and page with cursors.
+     * Lists onboarded partners. Filter by status, program, group or external_id, search by name, email or company, and page with cursors.
      *
      * @param {ToltApi.ListPartnersRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -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, tag_id: tagId, 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, external_id: externalId, search, } = request;
             const _queryParams = {
                 limit,
                 order: order != null ? order : undefined,
@@ -171,6 +171,7 @@ export class PartnersClient {
                 program_id: programId,
                 group_id: groupId,
                 tag_id: tagId,
+                external_id: externalId,
                 search,
             };
             const _authRequest = await this._options.authProvider.getAuthRequest();
@@ -245,6 +246,7 @@ export class PartnersClient {
      *     await client.partners.create({
      *         email: "sam@example.com",
      *         program_id: "prg_T6z8aRW3XCmvFWP972RKxpAd",
+     *         external_id: "user_123",
      *         first_name: "Sam",
      *         last_name: "Taylor",
      *         group_id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a",
@@ -371,6 +373,7 @@ export class PartnersClient {
      * @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}
@@ -418,6 +421,8 @@ export class PartnersClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
+                case 409:
+                    throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
                 case 413:
                     throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:

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

@@ -3,6 +3,7 @@
  *     {
  *         email: "sam@example.com",
  *         program_id: "prg_T6z8aRW3XCmvFWP972RKxpAd",
+ *         external_id: "user_123",
  *         first_name: "Sam",
  *         last_name: "Taylor",
  *         group_id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a",
@@ -17,6 +18,8 @@ export interface CreatePartnerRequest {
     email: string;
     /** Id of the program to add the partner to (prg_...), as returned when listing programs. */
     program_id: string;
+    /** Your own id for this partner, such as the user id in your app, so you can find them by it later. No other partner in the program can have it. */
+    external_id?: string;
     /** Partner's first name. With last_name it is used for the default link value when link is omitted. */
     first_name?: string;
     /** Partner's last name. With first_name it makes up the name shown for the partner unless display_name is set. */

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

@@ -30,6 +30,8 @@ export interface ListPartnersRequest {
     group_id?: string;
     /** Limit to partners with this tag, by the tag id (ptag_...) as returned when listing partner tags. */
     tag_id?: string;
+    /** Keep only partners with this external_id, matched exactly. Add program_id to get at most one partner. */
+    external_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/UpdatePartnerRequest.d.ts

@@ -19,6 +19,8 @@ export interface UpdatePartnerRequest {
     country_code?: string | null;
     /** URL of the partner's website, starting with http:// or https://; null clears it. */
     website_url?: string | null;
+    /** Your own id for this partner, such as the user id in your app. No other partner in the program can have it; null clears it. */
+    external_id?: string | null;
     /** Id of a group in the partner's program to move them to (grp_...), as returned when listing groups. Commission flows scoped to that group then apply to them; null removes them from their group. */
     group_id?: string | null;
 }

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

@@ -2,6 +2,8 @@ import type * as ToltApi from "../index.js";
 export interface CreatedPartner {
     id: string;
     email: string;
+    /** Your own id for the partner, such as the user id in your app, or null. */
+    external_id: string | null;
     first_name: string | null;
     last_name: string | null;
     company_name: string | null;

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

@@ -1,6 +1,8 @@
 export interface Partner {
     id: string;
     email: string;
+    /** Your own id for the partner, such as the user id in your app, or null. */
+    external_id: string | null;
     first_name: string | null;
     last_name: string | null;
     company_name: string | null;

package/package.json

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