@tolt/api 0.6.1 → 1.0.0

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

@@ -19,13 +19,14 @@ export class PartnersClient {
      *
      * @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.partners.bulkApprove({
-     *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+     *         ids: ["part_NLYzgNKuSuASvrvoxNtau6SY", "part_9fQ2xLLmN3kP8dRvT1wYbHcS"]
      *     })
      */
     bulkApprove(request, requestOptions) {
@@ -37,7 +38,7 @@ export class PartnersClient {
         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.Production, "v2/partners/bulk/approve"),
+                environments.ToltApiEnvironment.Default, "v2/partners/bulk/approve"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -59,6 +60,8 @@ export class PartnersClient {
                     throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
                 case 401:
                     throw new ToltApi.UnauthorizedError(_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:
@@ -79,13 +82,15 @@ export class PartnersClient {
      *
      * @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.partners.bulkReject({
-     *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+     *         ids: ["part_NLYzgNKuSuASvrvoxNtau6SY", "part_9fQ2xLLmN3kP8dRvT1wYbHcS"],
+     *         rejection_note: "Site does not match our audience."
      *     })
      */
     bulkReject(request, requestOptions) {
@@ -97,7 +102,7 @@ export class PartnersClient {
         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.Production, "v2/partners/bulk/reject"),
+                environments.ToltApiEnvironment.Default, "v2/partners/bulk/reject"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -119,6 +124,8 @@ export class PartnersClient {
                     throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
                 case 401:
                     throw new ToltApi.UnauthorizedError(_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:
@@ -132,11 +139,14 @@ 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.
+     *
      * @param {ToltApi.ListPartnersRequest} request
      * @param {PartnersClient.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}
@@ -144,83 +154,103 @@ export class PartnersClient {
      * @example
      *     await client.partners.list()
      */
-    list(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__list(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, status, program_id: programId, group_id: groupId, search, } = request;
-        const _queryParams = {
-            limit,
-            order: order != null ? order : undefined,
-            sort: sort != null ? sort : undefined,
-            starting_after: startingAfter,
-            ending_before: endingBefore,
-            created_after: createdAfter != null ? createdAfter : undefined,
-            created_before: createdBefore != null ? createdBefore : undefined,
-            updated_after: updatedAfter != null ? updatedAfter : undefined,
-            updated_before: updatedBefore != null ? updatedBefore : undefined,
-            status: status != null ? status : undefined,
-            program_id: programId,
-            group_id: groupId,
-            search,
-        };
-        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.Production, "v2/partners"),
-            method: "GET",
-            headers: _headers,
-            queryString: core.url
-                .queryBuilder()
-                .addMany(_queryParams)
-                .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 400:
-                    throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
-                case 401:
-                    throw new ToltApi.UnauthorizedError(_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,
-                    });
+    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 _queryParams = {
+                limit,
+                order: order != null ? order : undefined,
+                sort: sort != null ? sort : undefined,
+                starting_after: startingAfter,
+                ending_before: endingBefore,
+                created_after: createdAfter != null ? createdAfter : undefined,
+                created_before: createdBefore != null ? createdBefore : undefined,
+                updated_after: updatedAfter != null ? updatedAfter : undefined,
+                updated_before: updatedBefore != null ? updatedBefore : undefined,
+                status: status != null ? status : undefined,
+                program_id: programId,
+                group_id: groupId,
+                search,
+            };
+            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"),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .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 };
             }
-        }
-        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/partners");
+            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 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, "GET", "/v2/partners");
+        });
+        const dataWithRawResponse = await list(request).withRawResponse();
+        return new core.Page({
+            response: dataWithRawResponse.data,
+            rawResponse: dataWithRawResponse.rawResponse,
+            hasNextPage: (response) => response?.next_cursor != null &&
+                !(typeof response?.next_cursor === "string" && response?.next_cursor === ""),
+            getItems: (response) => response?.data ?? [],
+            loadPage: (response) => {
+                return list(core.setObjectProperty(request, "starting_after", response?.next_cursor));
+            },
+        });
     }
     /**
      * Creates an onboarded partner together with their referral link. The link value defaults to a slug of the partner's name or email and the parameter to the program's first link parameter. Omit group_id to place the partner in the program's default group.
      *
-     * @param {ToltApi.CreatePartnersRequest} request
+     * @param {ToltApi.CreatePartnerRequest} request
      * @param {PartnersClient.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.partners.create({
-     *         email: "sam@acme.com",
-     *         program_id: "prg_YRsbPDAK"
+     *         email: "sam@example.com",
+     *         program_id: "prg_T6z8aRW3XCmvFWP972RKxpAd",
+     *         first_name: "Sam",
+     *         last_name: "Taylor",
+     *         group_id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a",
+     *         link: {
+     *             value: "sam",
+     *             param: "ref"
+     *         }
      *     })
      */
     create(request, requestOptions) {
@@ -232,7 +262,7 @@ export class PartnersClient {
         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.Production, "v2/partners"),
+                environments.ToltApiEnvironment.Default, "v2/partners"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -240,7 +270,7 @@ export class PartnersClient {
             requestType: "json",
             body: mergeAdditionalBodyParameters(request, requestOptions?.additionalBodyParameters),
             timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
-            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            maxRetries: 0,
             abortSignal: requestOptions?.abortSignal,
             fetchFn: this._options?.fetch,
             logging: this._options.logging,
@@ -256,6 +286,8 @@ export class PartnersClient {
                     throw new ToltApi.UnauthorizedError(_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:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -269,18 +301,21 @@ export class PartnersClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/partners");
     }
     /**
-     * @param {ToltApi.GetPartnersRequest} request
+     * Gets a partner by ID, with their profile, status, group and program.
+     *
+     * @param {ToltApi.GetPartnerRequest} 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.get({
-     *         id: "id"
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
     get(request, requestOptions) {
@@ -293,7 +328,7 @@ export class PartnersClient {
         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.Production, `v2/partners/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/partners/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -312,6 +347,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 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -327,20 +364,23 @@ export class PartnersClient {
     /**
      * Edits profile fields and group membership. Status changes go through the approve, reject and suspend actions.
      *
-     * @param {ToltApi.UpdatePartnersRequest} request
+     * @param {ToltApi.UpdatePartnerRequest} request
      * @param {PartnersClient.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.partners.update({
-     *         id: "id"
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY",
+     *         first_name: "Sam",
+     *         last_name: "Taylor",
+     *         group_id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a"
      *     })
      */
     update(request, requestOptions) {
@@ -353,7 +393,7 @@ export class PartnersClient {
         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.Production, `v2/partners/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/partners/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "PUT",
             headers: _headers,
             contentType: "application/json",
@@ -377,8 +417,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:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -392,18 +432,21 @@ export class PartnersClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/v2/partners/{id}");
     }
     /**
-     * @param {ToltApi.ApprovePartnersRequest} request
+     * Makes the partner active. A partner who was not already active is sent the program's approval email.
+     *
+     * @param {ToltApi.ApprovePartnerRequest} 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.approve({
-     *         id: "id"
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
     approve(request, requestOptions) {
@@ -416,7 +459,7 @@ export class PartnersClient {
         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.Production, `v2/partners/${core.url.encodePathParam(id)}/approve`),
+                environments.ToltApiEnvironment.Default, `v2/partners/${core.url.encodePathParam(id, errors.ToltApiError)}/approve`),
             method: "POST",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -435,6 +478,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 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -448,19 +493,22 @@ export class PartnersClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/partners/{id}/approve");
     }
     /**
-     * @param {ToltApi.RejectPartnersRequest} request
+     * Rejects the partner. A partner who was not already rejected is sent the program's rejection email with the note.
+     *
+     * @param {ToltApi.RejectPartnerRequest} 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.reject({
-     *         id: "id"
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
     reject(request, requestOptions) {
@@ -473,7 +521,7 @@ export class PartnersClient {
         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.Production, `v2/partners/${core.url.encodePathParam(id)}/reject`),
+                environments.ToltApiEnvironment.Default, `v2/partners/${core.url.encodePathParam(id, errors.ToltApiError)}/reject`),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -497,6 +545,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 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:
@@ -510,19 +560,22 @@ export class PartnersClient {
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/partners/{id}/reject");
     }
     /**
-     * @param {ToltApi.SuspendPartnersRequest} request
+     * Suspends the partner, with an optional suspension_reason. Use the approve action to make them active again.
+     *
+     * @param {ToltApi.SuspendPartnerRequest} 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.suspend({
-     *         id: "id"
+     *         id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
     suspend(request, requestOptions) {
@@ -535,7 +588,7 @@ export class PartnersClient {
         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.Production, `v2/partners/${core.url.encodePathParam(id)}/suspend`),
+                environments.ToltApiEnvironment.Default, `v2/partners/${core.url.encodePathParam(id, errors.ToltApiError)}/suspend`),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -559,6 +612,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 413:
+                    throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
                 case 429:
                     throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 default:

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

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

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

@@ -1,10 +1,10 @@
 /**
  * @example
  *     {
- *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+ *         ids: ["part_NLYzgNKuSuASvrvoxNtau6SY", "part_9fQ2xLLmN3kP8dRvT1wYbHcS"]
  *     }
  */
 export interface BulkApprovePartnersRequest {
-    /** Up to 100 ids. Duplicates are processed once. */
+    /** Ids of the partners to act on, as returned when listing partners. Each one succeeds or fails on its own and gets its own entry in results. */
     ids: string[];
 }

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

@@ -1,11 +1,13 @@
 /**
  * @example
  *     {
- *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+ *         ids: ["part_NLYzgNKuSuASvrvoxNtau6SY", "part_9fQ2xLLmN3kP8dRvT1wYbHcS"],
+ *         rejection_note: "Site does not match our audience."
  *     }
  */
 export interface BulkRejectPartnersRequest {
-    /** Up to 100 ids. Duplicates are processed once. */
+    /** Ids of the partners to act on, as returned when listing partners. Each one succeeds or fails on its own and gets its own entry in results. */
     ids: string[];
+    /** Reason for the rejection, shown to the partner in the partner portal. Null clears an earlier note. */
     rejection_note?: string | null;
 }

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

@@ -0,0 +1,59 @@
+/**
+ * @example
+ *     {
+ *         email: "sam@example.com",
+ *         program_id: "prg_T6z8aRW3XCmvFWP972RKxpAd",
+ *         first_name: "Sam",
+ *         last_name: "Taylor",
+ *         group_id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a",
+ *         link: {
+ *             value: "sam",
+ *             param: "ref"
+ *         }
+ *     }
+ */
+export interface CreatePartnerRequest {
+    /** Partner's email address, where program emails such as the welcome email go. It identifies the partner in the program, so it cannot match another partner's email there, ignoring case. */
+    email: string;
+    /** Id of the program to add the partner to (prg_...), as returned when listing programs. */
+    program_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. */
+    last_name?: string;
+    /** Overrides the name shown for the partner; defaults to the first and last name. */
+    display_name?: string;
+    /** Business the partner promotes through, if they are a company rather than a person. Leave it out for an individual. */
+    company_name?: string;
+    /** Two-letter ISO country code. */
+    country_code?: string;
+    /** URL of the partner's website, starting with http:// or https://. */
+    website_url?: string;
+    /** Backdate the partner's creation time. Defaults to now. */
+    created_at?: string;
+    /** Group in the program. Defaults to the program's default group. */
+    group_id?: string;
+    /** Use pending to add the partner as an application that still needs approval instead of an active partner. */
+    status?: CreatePartnerRequest.Status;
+    /** The referral link created with the partner. Leave it out to build the slug from the partner's name, or from the part of the email before the @ when there is no name. */
+    link?: CreatePartnerRequest.Link;
+    /** Send the partner the program's welcome email. Only goes out when the program's welcome email is enabled and the partner is active. */
+    notify_partner?: boolean;
+}
+export declare namespace CreatePartnerRequest {
+    /** Use pending to add the partner as an application that still needs approval instead of an active partner. */
+    const Status: {
+        readonly Active: "active";
+        readonly Pending: "pending";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /**
+     * The referral link created with the partner. Leave it out to build the slug from the partner's name, or from the part of the email before the @ when there is no name.
+     */
+    interface Link {
+        /** Slug that identifies the partner in referral URLs, such as `sam` in `?ref=sam`. Pick one that no other link uses with the same parameter. */
+        value: string;
+        /** Query parameter of the link, such as `ref` in `?ref=sam`. Leave it out to use the program's first link parameter. */
+        param?: string | undefined;
+    }
+}

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

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CreatePartnerRequest;
+(function (CreatePartnerRequest) {
+    /** Use pending to add the partner as an application that still needs approval instead of an active partner. */
+    CreatePartnerRequest.Status = {
+        Active: "active",
+        Pending: "pending",
+    };
+})(CreatePartnerRequest || (CreatePartnerRequest = {}));

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

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

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

@@ -4,24 +4,30 @@ import type * as ToltApi from "../../../../index.js";
  *     {}
  */
 export interface ListPartnersRequest {
+    /** How many rows to return in one page. */
     limit?: number;
+    /** Ranking direction: desc puts the most recently created or updated rows first. */
     order?: ToltApi.ListPartnersRequestOrder;
-    /** Column the list is ordered and paged by. */
+    /** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
     sort?: ToltApi.ListPartnersRequestSort;
     /** Continue after a position: the next_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with ending_before. */
     starting_after?: string;
     /** Page backward from a position: the prev_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with starting_after. */
     ending_before?: string;
-    /** Only items created at or after this ISO 8601 time. */
+    /** Start of a window on when items were created: items created at this time or later are included, for example 2026-01-01T00:00:00Z. Leave it out for no lower bound. */
     created_after?: string;
-    /** Only items created before this ISO 8601 time. */
+    /** End of a window on when items were created: only items created before this time are included. Leave it out for no upper bound. */
     created_before?: string;
-    /** Only items updated at or after this ISO 8601 time. Combine with sort=updated_at to sync changes. */
+    /** Only items last changed at or after this moment; with sort=updated_at, use it to fetch what changed since a previous sync. */
     updated_after?: string;
-    /** Only items updated before this ISO 8601 time. */
+    /** Only items last changed before this moment; pair it with updated_after to fetch what changed in a period. */
     updated_before?: string;
+    /** Keep only partners at this review stage; approved partners appear as active. */
     status?: ToltApi.ListPartnersRequestStatus;
+    /** Limit to one program, by its id (prg_...) as returned when listing programs. */
     program_id?: string;
+    /** Limit to partners in one group, by the group id (grp_...) as returned when listing groups. */
     group_id?: string;
+    /** Text matched anywhere in the partner's id, email, first name, last name or company name, ignoring case. */
     search?: string;
 }