@tolt/api 0.7.0 → 1.0.0

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

@@ -27,73 +27,83 @@ export class LinksClient {
      * @example
      *     await client.links.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, program_id: programId, partner_id: partnerId, param, value, 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,
-            program_id: programId,
-            partner_id: partnerId,
-            param,
-            value,
-            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/links"),
-            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 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,
-                    });
+    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, program_id: programId, partner_id: partnerId, param, value, 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,
+                program_id: programId,
+                partner_id: partnerId,
+                param,
+                value,
+                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/links"),
+                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/links");
+            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/links");
+        });
+        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 a referral link for a partner. The value must be unique for its parameter, and param defaults to the program's.
      *
-     * @param {ToltApi.CreateLinksRequest} request
+     * @param {ToltApi.CreateLinkRequest} request
      * @param {LinksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -128,7 +138,7 @@ export class LinksClient {
             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,
@@ -161,7 +171,7 @@ export class LinksClient {
     /**
      * Looks up a single link by its parameter and value (value matched case-insensitively). Returns 404 when none matches.
      *
-     * @param {ToltApi.GetByParamValueLinksRequest} request
+     * @param {ToltApi.GetLinkByParamValueRequest} request
      * @param {LinksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -234,7 +244,7 @@ export class LinksClient {
     /**
      * Gets an ordinary or campaign-managed link by ID.
      *
-     * @param {ToltApi.GetLinksRequest} request
+     * @param {ToltApi.GetLinkRequest} request
      * @param {LinksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
@@ -259,7 +269,7 @@ export class LinksClient {
         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/links/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/links/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "GET",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
@@ -295,7 +305,7 @@ export class LinksClient {
     /**
      * Updates an ordinary link. Campaign-managed links must be changed through campaigns.
      *
-     * @param {ToltApi.UpdateLinksRequest} request
+     * @param {ToltApi.UpdateLinkRequest} request
      * @param {LinksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -323,7 +333,7 @@ export class LinksClient {
         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/links/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/links/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "PUT",
             headers: _headers,
             contentType: "application/json",
@@ -364,7 +374,7 @@ export class LinksClient {
     /**
      * Deletes an ordinary link. Campaign-managed links must be changed through campaigns.
      *
-     * @param {ToltApi.DeleteLinksRequest} request
+     * @param {ToltApi.DeleteLinkRequest} request
      * @param {LinksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -390,7 +400,7 @@ export class LinksClient {
         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/links/${core.url.encodePathParam(id)}`),
+                environments.ToltApiEnvironment.Default, `v2/links/${core.url.encodePathParam(id, errors.ToltApiError)}`),
             method: "DELETE",
             headers: _headers,
             queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),

package/dist/api/resources/links/client/requests/{CreateLinksRequest.d.ts → CreateLinkRequest.d.ts}

@@ -6,7 +6,7 @@
  *         partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
  *     }
  */
-export interface CreateLinksRequest {
+export interface CreateLinkRequest {
     /** Slug that identifies the partner in referral URLs, such as `sam` in `?ref=sam`, saved in lowercase. Pick one that no other link uses with the same parameter; a taken slug returns an error. */
     value: string;
     /** Query parameter of the link, e.g. `ref` in `?ref=sam`. Leave it out or send an empty string to use the program's first link parameter, which is what gets stored. */

package/dist/api/resources/links/client/requests/{DeleteLinksRequest.d.ts → DeleteLinkRequest.d.ts}

@@ -4,6 +4,6 @@
  *         id: "lnk_mtTeeckFa1vMdvDFXretQNs6"
  *     }
  */
-export interface DeleteLinksRequest {
+export interface DeleteLinkRequest {
     id: string;
 }

package/dist/api/resources/links/client/requests/{GetByParamValueLinksRequest.d.ts → GetLinkByParamValueRequest.d.ts}

@@ -5,7 +5,7 @@
  *         value: "sam"
  *     }
  */
-export interface GetByParamValueLinksRequest {
+export interface GetLinkByParamValueRequest {
     param: string;
     /** Matched case-insensitively. */
     value: string;

package/dist/api/resources/links/client/requests/{GetLinksRequest.d.ts → GetLinkRequest.d.ts}

@@ -4,6 +4,6 @@
  *         id: "lnk_mtTeeckFa1vMdvDFXretQNs6"
  *     }
  */
-export interface GetLinksRequest {
+export interface GetLinkRequest {
     id: string;
 }

package/dist/api/resources/links/client/requests/{UpdateLinksRequest.d.ts → UpdateLinkRequest.d.ts}

@@ -6,7 +6,7 @@
  *         value: "sam"
  *     }
  */
-export interface UpdateLinksRequest {
+export interface UpdateLinkRequest {
     id: string;
     /** New query parameter of the link, e.g. `ref` in `?ref=sam`. URLs with the old parameter stop matching this link. */
     param?: string;

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

@@ -1,6 +1,6 @@
-export type { CreateLinksRequest } from "./CreateLinksRequest.js";
-export type { DeleteLinksRequest } from "./DeleteLinksRequest.js";
-export type { GetByParamValueLinksRequest } from "./GetByParamValueLinksRequest.js";
-export type { GetLinksRequest } from "./GetLinksRequest.js";
+export type { CreateLinkRequest } from "./CreateLinkRequest.js";
+export type { DeleteLinkRequest } from "./DeleteLinkRequest.js";
+export type { GetLinkByParamValueRequest } from "./GetLinkByParamValueRequest.js";
+export type { GetLinkRequest } from "./GetLinkRequest.js";
 export type { ListLinksRequest } from "./ListLinksRequest.js";
-export type { UpdateLinksRequest } from "./UpdateLinksRequest.js";
+export type { UpdateLinkRequest } from "./UpdateLinkRequest.js";

package/dist/api/resources/links/types/{DeleteLinksResponse.d.ts → CreateLinkResponse.d.ts}

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

package/dist/api/resources/links/types/{CreateLinksResponse.d.ts → DeleteLinkResponse.d.ts}

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

package/dist/api/resources/links/types/GetLinkByParamValueResponse.d.ts

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

package/dist/api/resources/links/types/{GetLinksResponse.d.ts → GetLinkResponse.d.ts}

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

package/dist/api/resources/links/types/{UpdateLinksResponse.d.ts → UpdateLinkResponse.d.ts}

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

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

@@ -1,8 +1,8 @@
-export * from "./CreateLinksResponse.js";
-export * from "./DeleteLinksResponse.js";
-export * from "./GetByParamValueLinksResponse.js";
-export * from "./GetLinksResponse.js";
+export * from "./CreateLinkResponse.js";
+export * from "./DeleteLinkResponse.js";
+export * from "./GetLinkByParamValueResponse.js";
+export * from "./GetLinkResponse.js";
 export * from "./ListLinksRequestOrder.js";
 export * from "./ListLinksRequestSort.js";
 export * from "./ListLinksResponse.js";
-export * from "./UpdateLinksResponse.js";
+export * from "./UpdateLinkResponse.js";

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

@@ -1,8 +1,8 @@
-export * from "./CreateLinksResponse.js";
-export * from "./DeleteLinksResponse.js";
-export * from "./GetByParamValueLinksResponse.js";
-export * from "./GetLinksResponse.js";
+export * from "./CreateLinkResponse.js";
+export * from "./DeleteLinkResponse.js";
+export * from "./GetLinkByParamValueResponse.js";
+export * from "./GetLinkResponse.js";
 export * from "./ListLinksRequestOrder.js";
 export * from "./ListLinksRequestSort.js";
 export * from "./ListLinksResponse.js";
-export * from "./UpdateLinksResponse.js";
+export * from "./UpdateLinkResponse.js";

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

@@ -67,12 +67,11 @@ export declare class PartnersClient {
      * @example
      *     await client.partners.list()
      */
-    list(request?: ToltApi.ListPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListPartnersResponse>;
-    private __list;
+    list(request?: ToltApi.ListPartnersRequest, requestOptions?: PartnersClient.RequestOptions): Promise<core.Page<ToltApi.PartnerDetails, ToltApi.ListPartnersResponse>>;
     /**
      * 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}
@@ -96,12 +95,12 @@ export declare class PartnersClient {
      *         }
      *     })
      */
-    create(request: ToltApi.CreatePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreatePartnersResponse>;
+    create(request: ToltApi.CreatePartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreatePartnerResponse>;
     private __create;
     /**
      * Gets a partner by ID, with their profile, status, group and program.
      *
-     * @param {ToltApi.GetPartnersRequest} request
+     * @param {ToltApi.GetPartnerRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
@@ -116,12 +115,12 @@ export declare class PartnersClient {
      *         id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
-    get(request: ToltApi.GetPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetPartnersResponse>;
+    get(request: ToltApi.GetPartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetPartnerResponse>;
     private __get;
     /**
      * 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}
@@ -140,12 +139,12 @@ export declare class PartnersClient {
      *         group_id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a"
      *     })
      */
-    update(request: ToltApi.UpdatePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdatePartnersResponse>;
+    update(request: ToltApi.UpdatePartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdatePartnerResponse>;
     private __update;
     /**
      * Makes the partner active. A partner who was not already active is sent the program's approval email.
      *
-     * @param {ToltApi.ApprovePartnersRequest} request
+     * @param {ToltApi.ApprovePartnerRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
@@ -160,12 +159,12 @@ export declare class PartnersClient {
      *         id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
-    approve(request: ToltApi.ApprovePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ApprovePartnersResponse>;
+    approve(request: ToltApi.ApprovePartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ApprovePartnerResponse>;
     private __approve;
     /**
      * Rejects the partner. A partner who was not already rejected is sent the program's rejection email with the note.
      *
-     * @param {ToltApi.RejectPartnersRequest} request
+     * @param {ToltApi.RejectPartnerRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -181,12 +180,12 @@ export declare class PartnersClient {
      *         id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
-    reject(request: ToltApi.RejectPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.RejectPartnersResponse>;
+    reject(request: ToltApi.RejectPartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.RejectPartnerResponse>;
     private __reject;
     /**
      * Suspends the partner, with an optional suspension_reason. Use the approve action to make them active again.
      *
-     * @param {ToltApi.SuspendPartnersRequest} request
+     * @param {ToltApi.SuspendPartnerRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
@@ -202,6 +201,6 @@ export declare class PartnersClient {
      *         id: "part_NLYzgNKuSuASvrvoxNtau6SY"
      *     })
      */
-    suspend(request: ToltApi.SuspendPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.SuspendPartnersResponse>;
+    suspend(request: ToltApi.SuspendPartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.SuspendPartnerResponse>;
     private __suspend;
 }