@tolt/api 0.2.0 → 0.3.0

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

@@ -16,6 +16,7 @@ export declare class LinksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -30,13 +31,14 @@ export declare class LinksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.links.createLink({
      *         value: "value",
-     *         partnerId: "partnerId"
+     *         partner_id: "partner_id"
      *     })
      */
     createLink(request: ToltApi.CreateLinkRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateLinkResponse>;
@@ -47,6 +49,7 @@ export declare class LinksClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -64,6 +67,7 @@ export declare class LinksClient {
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -80,6 +84,7 @@ export declare class LinksClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *

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

@@ -17,6 +17,7 @@ export class LinksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -27,11 +28,17 @@ export class LinksClient {
         return core.HttpResponsePromise.fromPromise(this.__listLinks(request, requestOptions));
     }
     async __listLinks(request = {}, requestOptions) {
-        const { limit, order, starting_after: startingAfter, program_id: programId, partner_id: partnerId, search, } = 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, 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,
             search,
@@ -64,6 +71,8 @@ export class LinksClient {
                     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,
@@ -80,13 +89,14 @@ export class LinksClient {
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
      * @example
      *     await client.links.createLink({
      *         value: "value",
-     *         partnerId: "partnerId"
+     *         partner_id: "partner_id"
      *     })
      */
     createLink(request, requestOptions) {
@@ -120,6 +130,8 @@ export class LinksClient {
                     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,
@@ -136,6 +148,7 @@ export class LinksClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -173,6 +186,8 @@ export class LinksClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new ToltApi.NotFoundError(_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,
@@ -190,6 +205,7 @@ export class LinksClient {
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -232,6 +248,8 @@ export class LinksClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new ToltApi.NotFoundError(_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,
@@ -248,6 +266,7 @@ export class LinksClient {
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -285,6 +304,8 @@ export class LinksClient {
                     throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
                 case 404:
                     throw new ToltApi.NotFoundError(_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,

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

@@ -2,11 +2,11 @@
  * @example
  *     {
  *         value: "value",
- *         partnerId: "partnerId"
+ *         partner_id: "partner_id"
  *     }
  */
 export interface CreateLinkRequest {
     value: string;
     param?: string;
-    partnerId: string;
+    partner_id: string;
 }

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

@@ -6,7 +6,20 @@ import type * as ToltApi from "../../../../index.js";
 export interface ListLinksRequest {
     limit?: number;
     order?: ToltApi.ListLinksRequestOrder;
+    /** Column the list is ordered and paged by. */
+    sort?: ToltApi.ListLinksRequestSort;
+    /** 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. */
+    created_after?: string;
+    /** Only items created before this ISO 8601 time. */
+    created_before?: string;
+    /** Only items updated at or after this ISO 8601 time. Combine with sort=updated_at to sync changes. */
+    updated_after?: string;
+    /** Only items updated before this ISO 8601 time. */
+    updated_before?: string;
     program_id?: string;
     partner_id?: string;
     search?: string;

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

@@ -0,0 +1,6 @@
+/** Column the list is ordered and paged by. */
+export declare const ListLinksRequestSort: {
+    readonly CreatedAt: "created_at";
+    readonly UpdatedAt: "updated_at";
+};
+export type ListLinksRequestSort = (typeof ListLinksRequestSort)[keyof typeof ListLinksRequestSort];

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

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Column the list is ordered and paged by. */
+export const ListLinksRequestSort = {
+    CreatedAt: "created_at",
+    UpdatedAt: "updated_at",
+};

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

@@ -4,4 +4,8 @@ export interface ListLinksResponse {
     message: string;
     data: ToltApi.Link[];
     has_more: boolean;
+    /** Opaque cursor marking the last item on this page. Pass it as starting_after to continue. Null when the page is empty. */
+    next_cursor: string | null;
+    /** Opaque cursor marking the first item on this page. Pass it as ending_before to page backward. Null when the page is empty. */
+    prev_cursor: string | null;
 }

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

@@ -2,5 +2,6 @@ export * from "./CreateLinkResponse.js";
 export * from "./DeleteLinkResponse.js";
 export * from "./GetLinkResponse.js";
 export * from "./ListLinksRequestOrder.js";
+export * from "./ListLinksRequestSort.js";
 export * from "./ListLinksResponse.js";
 export * from "./UpdateLinkResponse.js";

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

@@ -2,5 +2,6 @@ export * from "./CreateLinkResponse.js";
 export * from "./DeleteLinkResponse.js";
 export * from "./GetLinkResponse.js";
 export * from "./ListLinksRequestOrder.js";
+export * from "./ListLinksRequestSort.js";
 export * from "./ListLinksResponse.js";
 export * from "./UpdateLinkResponse.js";

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

@@ -10,12 +10,51 @@ export declare namespace PartnersClient {
 export declare class PartnersClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<PartnersClient.Options>;
     constructor(options: PartnersClient.Options);
+    /**
+     * Approves up to 100 partners. Each id is processed on its own and the response reports the outcome per id, so one refused partner does not fail the request.
+     *
+     * @param {ToltApi.BulkApprovePartnersRequest} request
+     * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
+     * @throws {@link errors.ToltApiError}
+     * @throws {@link errors.ToltApiTimeoutError}
+     *
+     * @example
+     *     await client.partners.bulkApprovePartners({
+     *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+     *     })
+     */
+    bulkApprovePartners(request: ToltApi.BulkApprovePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.BulkApprovePartnersResponse>;
+    private __bulkApprovePartners;
+    /**
+     * Rejects up to 100 partners with an optional shared rejection note. Each id is processed on its own and the response reports the outcome per id.
+     *
+     * @param {ToltApi.BulkRejectPartnersRequest} request
+     * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
+     * @throws {@link errors.ToltApiError}
+     * @throws {@link errors.ToltApiTimeoutError}
+     *
+     * @example
+     *     await client.partners.bulkRejectPartners({
+     *         ids: ["part_9fQ2xLL", "part_3RtV9k"]
+     *     })
+     */
+    bulkRejectPartners(request: ToltApi.BulkRejectPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.BulkRejectPartnersResponse>;
+    private __bulkRejectPartners;
     /**
      * @param {ToltApi.ListPartnersRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -24,12 +63,34 @@ export declare class PartnersClient {
      */
     listPartners(request?: ToltApi.ListPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListPartnersResponse>;
     private __listPartners;
+    /**
+     * 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.CreatePartnerRequest} request
+     * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ToltApi.BadRequestError}
+     * @throws {@link ToltApi.UnauthorizedError}
+     * @throws {@link ToltApi.ConflictError}
+     * @throws {@link ToltApi.TooManyRequestsError}
+     * @throws {@link errors.ToltApiError}
+     * @throws {@link errors.ToltApiTimeoutError}
+     *
+     * @example
+     *     await client.partners.createPartner({
+     *         email: "sam@acme.com",
+     *         program_id: "prg_YRsbPDAK"
+     *     })
+     */
+    createPartner(request: ToltApi.CreatePartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreatePartnerResponse>;
+    private __createPartner;
     /**
      * @param {ToltApi.GetPartnerRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -40,12 +101,34 @@ export declare class PartnersClient {
      */
     getPartner(request: ToltApi.GetPartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetPartnerResponse>;
     private __getPartner;
+    /**
+     * Edits profile fields and group membership. Status changes go through the approve, reject and suspend actions.
+     *
+     * @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.TooManyRequestsError}
+     * @throws {@link errors.ToltApiError}
+     * @throws {@link errors.ToltApiTimeoutError}
+     *
+     * @example
+     *     await client.partners.updatePartner({
+     *         id: "id"
+     *     })
+     */
+    updatePartner(request: ToltApi.UpdatePartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdatePartnerResponse>;
+    private __updatePartner;
     /**
      * @param {ToltApi.ApprovePartnerRequest} request
      * @param {PartnersClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -63,6 +146,7 @@ export declare class PartnersClient {
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *
@@ -80,6 +164,7 @@ export declare class PartnersClient {
      * @throws {@link ToltApi.BadRequestError}
      * @throws {@link ToltApi.UnauthorizedError}
      * @throws {@link ToltApi.NotFoundError}
+     * @throws {@link ToltApi.TooManyRequestsError}
      * @throws {@link errors.ToltApiError}
      * @throws {@link errors.ToltApiTimeoutError}
      *