webflow-api 3.3.0-beta → 3.3.1

package/api/resources/users/client/Client.d.ts

@@ -1,145 +0,0 @@
-import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
-import * as core from "../../../../core";
-import * as Webflow from "../../../index";
-export declare namespace Users {
-    interface Options extends BaseClientOptions {
-    }
-    interface RequestOptions extends BaseRequestOptions {
-    }
-}
-export declare class Users {
-    protected readonly _options: Users.Options;
-    constructor(_options?: Users.Options);
-    /**
-     * Get a list of users for a site
-     *
-     * Required scope | `users:read`
-     *
-     * @param {string} siteId - Unique identifier for a Site
-     * @param {Webflow.UsersListRequest} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Webflow.BadRequestError}
-     * @throws {@link Webflow.UnauthorizedError}
-     * @throws {@link Webflow.ForbiddenError}
-     * @throws {@link Webflow.NotFoundError}
-     * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
-     *
-     * @example
-     *     await client.users.list("580e63e98c9a982ac9b8b741", {
-     *         offset: 1.1,
-     *         limit: 1.1,
-     *         sort: "CreatedOn"
-     *     })
-     */
-    list(siteId: string, request?: Webflow.UsersListRequest, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Webflow.UserList>;
-    private __list;
-    /**
-     * Get a User by ID
-     *
-     * Required scope | `users:read`
-     *
-     * @param {string} siteId - Unique identifier for a Site
-     * @param {string} userId - Unique identifier for a User
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Webflow.BadRequestError}
-     * @throws {@link Webflow.UnauthorizedError}
-     * @throws {@link Webflow.ForbiddenError}
-     * @throws {@link Webflow.NotFoundError}
-     * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
-     *
-     * @example
-     *     await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741")
-     */
-    get(siteId: string, userId: string, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Webflow.User>;
-    private __get;
-    /**
-     * Delete a User by ID
-     *
-     * Required scope | `users:write`
-     *
-     * @param {string} siteId - Unique identifier for a Site
-     * @param {string} userId - Unique identifier for a User
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Webflow.BadRequestError}
-     * @throws {@link Webflow.UnauthorizedError}
-     * @throws {@link Webflow.ForbiddenError}
-     * @throws {@link Webflow.NotFoundError}
-     * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
-     *
-     * @example
-     *     await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741")
-     */
-    delete(siteId: string, userId: string, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<void>;
-    private __delete;
-    /**
-     * Update a User by ID
-     *
-     *   Required scope | `users:write`
-     *
-     * <Note class="notice">The <code>email</code> and <code>password</code>
-     * fields cannot be updated using this endpoint</Note>
-     *
-     * @param {string} siteId - Unique identifier for a Site
-     * @param {string} userId - Unique identifier for a User
-     * @param {Webflow.User} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Webflow.BadRequestError}
-     * @throws {@link Webflow.UnauthorizedError}
-     * @throws {@link Webflow.ForbiddenError}
-     * @throws {@link Webflow.NotFoundError}
-     * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
-     *
-     * @example
-     *     await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741", {
-     *         id: "6287ec36a841b25637c663df",
-     *         isEmailVerified: true,
-     *         lastUpdated: new Date("2022-05-20T13:46:12.000Z"),
-     *         invitedOn: new Date("2022-05-20T13:46:12.000Z"),
-     *         createdOn: new Date("2022-05-20T13:46:12.000Z"),
-     *         lastLogin: new Date("2022-05-20T13:46:12.000Z"),
-     *         status: "verified",
-     *         accessGroups: [{
-     *                 slug: "webflowers",
-     *                 type: "admin"
-     *             }]
-     *     })
-     */
-    update(siteId: string, userId: string, request: Webflow.User, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Webflow.User>;
-    private __update;
-    /**
-     * Create and invite a user with an email address.
-     *
-     * The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.
-     *
-     * Required scope | `users:write`
-     *
-     * @param {string} siteId - Unique identifier for a Site
-     * @param {Webflow.UsersInviteRequest} request
-     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Webflow.BadRequestError}
-     * @throws {@link Webflow.UnauthorizedError}
-     * @throws {@link Webflow.ForbiddenError}
-     * @throws {@link Webflow.NotFoundError}
-     * @throws {@link Webflow.ConflictError}
-     * @throws {@link Webflow.TooManyRequestsError}
-     * @throws {@link Webflow.InternalServerError}
-     *
-     * @example
-     *     await client.users.invite("580e63e98c9a982ac9b8b741", {
-     *         email: "some.one@home.com",
-     *         accessGroups: ["accessGroups"]
-     *     })
-     */
-    invite(siteId: string, request: Webflow.UsersInviteRequest, requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Webflow.User>;
-    private __invite;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}