@tolt/api 0.6.1 → 1.0.0

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

@@ -18,13 +18,14 @@ export declare 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: ToltApi.BulkApprovePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.BulkApprovePartnersResponse>;
@@ -37,23 +38,28 @@ export declare 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: 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.
+     *
      * @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}
@@ -61,118 +67,140 @@ 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}
      * @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: ToltApi.CreatePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreatePartnersResponse>;
+    create(request: ToltApi.CreatePartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreatePartnerResponse>;
     private __create;
     /**
-     * @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: 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}
      * @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: ToltApi.UpdatePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdatePartnersResponse>;
+    update(request: ToltApi.UpdatePartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdatePartnerResponse>;
     private __update;
     /**
-     * @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: ToltApi.ApprovePartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ApprovePartnersResponse>;
+    approve(request: ToltApi.ApprovePartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.ApprovePartnerResponse>;
     private __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: ToltApi.RejectPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.RejectPartnersResponse>;
+    reject(request: ToltApi.RejectPartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.RejectPartnerResponse>;
     private __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: ToltApi.SuspendPartnersRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.SuspendPartnersResponse>;
+    suspend(request: ToltApi.SuspendPartnerRequest, requestOptions?: PartnersClient.RequestOptions): core.HttpResponsePromise<ToltApi.SuspendPartnerResponse>;
     private __suspend;
 }