@spaciv/sdk 0.0.0 → 0.1.0

package/src/apis/UsersApi.ts

@@ -0,0 +1,672 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * spaciv API
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires.  ## Getting started  1. Exchange credentials for an access token using one of the operations under    **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one    before the old one expires.  ## Conventions  Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for.  Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for.  Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@spaciv.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ErrorModel,
+  ImportBody,
+  ListUserDetailsWithEmailRow,
+  UserV2GetResBody,
+  UserV2PatchReqBody,
+  UserV2PostReqBody,
+} from '../models/index';
+import {
+    ErrorModelFromJSON,
+    ErrorModelToJSON,
+    ImportBodyFromJSON,
+    ImportBodyToJSON,
+    ListUserDetailsWithEmailRowFromJSON,
+    ListUserDetailsWithEmailRowToJSON,
+    UserV2GetResBodyFromJSON,
+    UserV2GetResBodyToJSON,
+    UserV2PatchReqBodyFromJSON,
+    UserV2PatchReqBodyToJSON,
+    UserV2PostReqBodyFromJSON,
+    UserV2PostReqBodyToJSON,
+} from '../models/index';
+
+export interface UsersApiCreateRequest {
+    userV2PostReqBody: UserV2PostReqBody;
+}
+
+export interface UsersApiCreateImportRequest {
+    importBody: Array<ImportBody>;
+}
+
+export interface UsersApiGetImageRequest {
+    id?: number;
+}
+
+export interface UsersApiUpdateRequest {
+    userV2PatchReqBody: UserV2PatchReqBody;
+}
+
+export interface UsersApiUpdateImageRequest {
+    filename?: Blob;
+    name?: string;
+}
+
+/**
+ * UsersApi - interface
+ * 
+ * @export
+ * @interface UsersApiInterface
+ */
+export interface UsersApiInterface {
+    /**
+     * Creates a new spaciv user account for the given email address and sends a verification email with a magic link. The caller must pass `acceptTerms: true`.  Always returns `200` even if the address is already registered (an \"email in use\" notification is sent instead), to prevent account enumeration. Disposable email domains are rejected with `401`.
+     * @summary Register a new user
+     * @param {UserV2PostReqBody} userV2PostReqBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    createRaw(requestParameters: UsersApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Creates a new spaciv user account for the given email address and sends a verification email with a magic link. The caller must pass `acceptTerms: true`.  Always returns `200` even if the address is already registered (an \"email in use\" notification is sent instead), to prevent account enumeration. Disposable email domains are rejected with `401`.
+     * Register a new user
+     */
+    create(requestParameters: UsersApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates or updates a batch of users and assigns each one a role within the current account. If a user with a given email address does not yet exist they are created. Requires the *Manage users* permission.
+     * @summary Bulk import users
+     * @param {Array<ImportBody>} importBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    createImportRaw(requestParameters: UsersApiCreateImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Creates or updates a batch of users and assigns each one a role within the current account. If a user with a given email address does not yet exist they are created. Requires the *Manage users* permission.
+     * Bulk import users
+     */
+    createImport(requestParameters: UsersApiCreateImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * @summary Delete the current user\'s account
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    deleteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Delete the current user\'s account
+     */
+    delete(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Permanently removes the profile image for the authenticated user. Requires the *Edit my user profile* permission.
+     * @summary Delete the current user\'s profile image
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    deleteImageRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+
+    /**
+     * Permanently removes the profile image for the authenticated user. Requires the *Edit my user profile* permission.
+     * Delete the current user\'s profile image
+     */
+    deleteImage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+
+    /**
+     * Returns profile details for the authenticated user, including name, title, employee ID, locale, and a client-side key-value store. Requires the *View my user profile* permission.
+     * @summary Get the current user\'s profile
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    getRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserV2GetResBody>>;
+
+    /**
+     * Returns profile details for the authenticated user, including name, title, employee ID, locale, and a client-side key-value store. Requires the *View my user profile* permission.
+     * Get the current user\'s profile
+     */
+    get(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserV2GetResBody>;
+
+    /**
+     * Returns the raw image bytes for a user\'s profile photo, with the `Content-Type` header set to the image\'s MIME type. Omit `id` to retrieve the authenticated user\'s own image, or supply `id` to retrieve a colleague\'s image (the target must belong to the same account). Supplying `id` requires the *View my user profile* permission; retrieving your own image needs no particular permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * @summary Get a user\'s profile image
+     * @param {number} [id] ID of another user whose image to retrieve. When omitted, returns the authenticated user\&#39;s own image. The target user must belong to the same account.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    getImageRaw(requestParameters: UsersApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+
+    /**
+     * Returns the raw image bytes for a user\'s profile photo, with the `Content-Type` header set to the image\'s MIME type. Omit `id` to retrieve the authenticated user\'s own image, or supply `id` to retrieve a colleague\'s image (the target must belong to the same account). Supplying `id` requires the *View my user profile* permission; retrieving your own image needs no particular permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get a user\'s profile image
+     */
+    getImage(requestParameters: UsersApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+
+    /**
+     * Returns all users that belong to the authenticated user\'s account, including their profile details and primary email address. Requires the *View users* permission.
+     * @summary List users in the current account
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ListUserDetailsWithEmailRow>>>;
+
+    /**
+     * Returns all users that belong to the authenticated user\'s account, including their profile details and primary email address. Requires the *View users* permission.
+     * List users in the current account
+     */
+    list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListUserDetailsWithEmailRow>>;
+
+    /**
+     * Returns the role names that the authenticated user is permitted to assign to others. `System-Admin` users see all roles; `Account-Owner` users see all roles except `System-Admin`; all other roles receive an empty list.
+     * @summary List assignable roles
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    listUserRolesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+
+    /**
+     * Returns the role names that the authenticated user is permitted to assign to others. `System-Admin` users see all roles; `Account-Owner` users see all roles except `System-Admin`; all other roles receive an empty list.
+     * List assignable roles
+     */
+    listUserRoles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+
+    /**
+     * Applies a partial update to the authenticated user\'s own profile (name, title, employee ID, locale, client store, marketing preferences). To grant or revoke a role on another user, include `roleUser` (or `roleUserEmail`) and `role`; omitting `role` revokes the user\'s current role.  Updating profile fields requires the `Edit my user profile` permission. Updating another user\'s role requires `Manage users`. Role changes are written to the audit log. Inviting a new user by email sends them a verification email.
+     * @summary Update a user\'s profile or role
+     * @param {UserV2PatchReqBody} userV2PatchReqBody 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    updateRaw(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Applies a partial update to the authenticated user\'s own profile (name, title, employee ID, locale, client store, marketing preferences). To grant or revoke a role on another user, include `roleUser` (or `roleUserEmail`) and `role`; omitting `role` revokes the user\'s current role.  Updating profile fields requires the `Edit my user profile` permission. Updating another user\'s role requires `Manage users`. Role changes are written to the audit log. Inviting a new user by email sends them a verification email.
+     * Update a user\'s profile or role
+     */
+    update(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Uploads or replaces the authenticated user\'s profile photo. Send a `multipart/form-data` body with the image in the `img` field. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size: 4 MiB. Requires the *Edit my user profile* permission.
+     * @summary Upload a profile image
+     * @param {Blob} [filename] filename of the file being uploaded
+     * @param {string} [name] general purpose name for multipart form value
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    updateImageRaw(requestParameters: UsersApiUpdateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+
+    /**
+     * Uploads or replaces the authenticated user\'s profile photo. Send a `multipart/form-data` body with the image in the `img` field. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size: 4 MiB. Requires the *Edit my user profile* permission.
+     * Upload a profile image
+     */
+    updateImage(requestParameters: UsersApiUpdateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+
+}
+
+/**
+ * 
+ */
+export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
+
+    /**
+     * Creates a new spaciv user account for the given email address and sends a verification email with a magic link. The caller must pass `acceptTerms: true`.  Always returns `200` even if the address is already registered (an \"email in use\" notification is sent instead), to prevent account enumeration. Disposable email domains are rejected with `401`.
+     * Register a new user
+     */
+    async createRaw(requestParameters: UsersApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['userV2PostReqBody'] == null) {
+            throw new runtime.RequiredError(
+                'userV2PostReqBody',
+                'Required parameter "userV2PostReqBody" was null or undefined when calling create().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/users`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UserV2PostReqBodyToJSON(requestParameters['userV2PostReqBody']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Creates a new spaciv user account for the given email address and sends a verification email with a magic link. The caller must pass `acceptTerms: true`.  Always returns `200` even if the address is already registered (an \"email in use\" notification is sent instead), to prevent account enumeration. Disposable email domains are rejected with `401`.
+     * Register a new user
+     */
+    async create(requestParameters: UsersApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.createRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates or updates a batch of users and assigns each one a role within the current account. If a user with a given email address does not yet exist they are created. Requires the *Manage users* permission.
+     * Bulk import users
+     */
+    async createImportRaw(requestParameters: UsersApiCreateImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['importBody'] == null) {
+            throw new runtime.RequiredError(
+                'importBody',
+                'Required parameter "importBody" was null or undefined when calling createImport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/users/import`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['importBody']!.map(ImportBodyToJSON),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Creates or updates a batch of users and assigns each one a role within the current account. If a user with a given email address does not yet exist they are created. Requires the *Manage users* permission.
+     * Bulk import users
+     */
+    async createImport(requestParameters: UsersApiCreateImportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.createImportRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Delete the current user\'s account
+     */
+    async deleteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/user`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Permanently deletes the authenticated user\'s own account and all associated data. Requires the *Edit my user profile* permission. This action is irreversible.
+     * Delete the current user\'s account
+     */
+    async delete(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteRaw(initOverrides);
+    }
+
+    /**
+     * Permanently removes the profile image for the authenticated user. Requires the *Edit my user profile* permission.
+     * Delete the current user\'s profile image
+     */
+    async deleteImageRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/user/image`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse<any>(response);
+    }
+
+    /**
+     * Permanently removes the profile image for the authenticated user. Requires the *Edit my user profile* permission.
+     * Delete the current user\'s profile image
+     */
+    async deleteImage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
+        const response = await this.deleteImageRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns profile details for the authenticated user, including name, title, employee ID, locale, and a client-side key-value store. Requires the *View my user profile* permission.
+     * Get the current user\'s profile
+     */
+    async getRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserV2GetResBody>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/user`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserV2GetResBodyFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns profile details for the authenticated user, including name, title, employee ID, locale, and a client-side key-value store. Requires the *View my user profile* permission.
+     * Get the current user\'s profile
+     */
+    async get(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserV2GetResBody> {
+        const response = await this.getRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the raw image bytes for a user\'s profile photo, with the `Content-Type` header set to the image\'s MIME type. Omit `id` to retrieve the authenticated user\'s own image, or supply `id` to retrieve a colleague\'s image (the target must belong to the same account). Supplying `id` requires the *View my user profile* permission; retrieving your own image needs no particular permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get a user\'s profile image
+     */
+    async getImageRaw(requestParameters: UsersApiGetImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['id'] != null) {
+            queryParameters['id'] = requestParameters['id'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/user/image`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Returns the raw image bytes for a user\'s profile photo, with the `Content-Type` header set to the image\'s MIME type. Omit `id` to retrieve the authenticated user\'s own image, or supply `id` to retrieve a colleague\'s image (the target must belong to the same account). Supplying `id` requires the *View my user profile* permission; retrieving your own image needs no particular permission. Returns `403` (`file quarantined: it matched a virus signature`) when a rescan found the stored image matches a virus signature; the bytes are kept for investigation.
+     * Get a user\'s profile image
+     */
+    async getImage(requestParameters: UsersApiGetImageRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.getImageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns all users that belong to the authenticated user\'s account, including their profile details and primary email address. Requires the *View users* permission.
+     * List users in the current account
+     */
+    async listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ListUserDetailsWithEmailRow>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/users`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListUserDetailsWithEmailRowFromJSON));
+    }
+
+    /**
+     * Returns all users that belong to the authenticated user\'s account, including their profile details and primary email address. Requires the *View users* permission.
+     * List users in the current account
+     */
+    async list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListUserDetailsWithEmailRow>> {
+        const response = await this.listRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns the role names that the authenticated user is permitted to assign to others. `System-Admin` users see all roles; `Account-Owner` users see all roles except `System-Admin`; all other roles receive an empty list.
+     * List assignable roles
+     */
+    async listUserRolesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/user-roles`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse<any>(response);
+    }
+
+    /**
+     * Returns the role names that the authenticated user is permitted to assign to others. `System-Admin` users see all roles; `Account-Owner` users see all roles except `System-Admin`; all other roles receive an empty list.
+     * List assignable roles
+     */
+    async listUserRoles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>> {
+        const response = await this.listUserRolesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Applies a partial update to the authenticated user\'s own profile (name, title, employee ID, locale, client store, marketing preferences). To grant or revoke a role on another user, include `roleUser` (or `roleUserEmail`) and `role`; omitting `role` revokes the user\'s current role.  Updating profile fields requires the `Edit my user profile` permission. Updating another user\'s role requires `Manage users`. Role changes are written to the audit log. Inviting a new user by email sends them a verification email.
+     * Update a user\'s profile or role
+     */
+    async updateRaw(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['userV2PatchReqBody'] == null) {
+            throw new runtime.RequiredError(
+                'userV2PatchReqBody',
+                'Required parameter "userV2PatchReqBody" was null or undefined when calling update().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/user`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UserV2PatchReqBodyToJSON(requestParameters['userV2PatchReqBody']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Applies a partial update to the authenticated user\'s own profile (name, title, employee ID, locale, client store, marketing preferences). To grant or revoke a role on another user, include `roleUser` (or `roleUserEmail`) and `role`; omitting `role` revokes the user\'s current role.  Updating profile fields requires the `Edit my user profile` permission. Updating another user\'s role requires `Manage users`. Role changes are written to the audit log. Inviting a new user by email sends them a verification email.
+     * Update a user\'s profile or role
+     */
+    async update(requestParameters: UsersApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.updateRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Uploads or replaces the authenticated user\'s profile photo. Send a `multipart/form-data` body with the image in the `img` field. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size: 4 MiB. Requires the *Edit my user profile* permission.
+     * Upload a profile image
+     */
+    async updateImageRaw(requestParameters: UsersApiUpdateImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['filename'] != null) {
+            formParams.append('filename', requestParameters['filename'] as any);
+        }
+
+        if (requestParameters['name'] != null) {
+            formParams.append('name', requestParameters['name'] as any);
+        }
+
+
+        let urlPath = `/v1/user/image`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse<any>(response);
+    }
+
+    /**
+     * Uploads or replaces the authenticated user\'s profile photo. Send a `multipart/form-data` body with the image in the `img` field. Accepted MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml` (detected from file bytes). Maximum file size: 4 MiB. Requires the *Edit my user profile* permission.
+     * Upload a profile image
+     */
+    async updateImage(requestParameters: UsersApiUpdateImageRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
+        const response = await this.updateImageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}