/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.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 type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { CreateAPIUser } from '../models'; import { GetAPIUsersResponse } from '../models'; import { IssueApiUserPairingTokenResponse } from '../models'; /** * ApiUserApi - axios parameter creator * @export */ export declare const ApiUserApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). Endpoint Permission: Admin, Non-Signing Admin. * @summary Create API Key * @param {CreateAPIUser} [createAPIUser] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApiUser: (createAPIUser?: CreateAPIUser, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get API Keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApiUsers: (options?: RawAxiosRequestConfig) => Promise; /** * Issues a device pairing token for the given user and returns the user\'s info along with the token. - The API user must be in PENDING_ACTIVATION status. If the user is already set up (enabled), the request is rejected with a 409 Conflict. - Please note that this endpoint is available only for API keys with Owner/Admin/Non Signing Admin permissions. - This is the same pairing token that the API Co-signer requests during installation and when you pair an additional API user with an existing Co-signer. You can use this endpoint instead of copying the token from Pair API user in the Console. The token is valid for one hour. * @summary Issue API user pairing token * @param {string} userId The ID of the api user * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ issueApiUserPairingToken: (userId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ApiUserApi - functional programming interface * @export */ export declare const ApiUserApiFp: (configuration?: Configuration) => { /** * Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). Endpoint Permission: Admin, Non-Signing Admin. * @summary Create API Key * @param {CreateAPIUser} [createAPIUser] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApiUser(createAPIUser?: CreateAPIUser, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get API Keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApiUsers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Issues a device pairing token for the given user and returns the user\'s info along with the token. - The API user must be in PENDING_ACTIVATION status. If the user is already set up (enabled), the request is rejected with a 409 Conflict. - Please note that this endpoint is available only for API keys with Owner/Admin/Non Signing Admin permissions. - This is the same pairing token that the API Co-signer requests during installation and when you pair an additional API user with an existing Co-signer. You can use this endpoint instead of copying the token from Pair API user in the Console. The token is valid for one hour. * @summary Issue API user pairing token * @param {string} userId The ID of the api user * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ issueApiUserPairingToken(userId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ApiUserApi - factory interface * @export */ export declare const ApiUserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). Endpoint Permission: Admin, Non-Signing Admin. * @summary Create API Key * @param {ApiUserApiCreateApiUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApiUser(requestParameters?: ApiUserApiCreateApiUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get API Keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApiUsers(options?: RawAxiosRequestConfig): AxiosPromise; /** * Issues a device pairing token for the given user and returns the user\'s info along with the token. - The API user must be in PENDING_ACTIVATION status. If the user is already set up (enabled), the request is rejected with a 409 Conflict. - Please note that this endpoint is available only for API keys with Owner/Admin/Non Signing Admin permissions. - This is the same pairing token that the API Co-signer requests during installation and when you pair an additional API user with an existing Co-signer. You can use this endpoint instead of copying the token from Pair API user in the Console. The token is valid for one hour. * @summary Issue API user pairing token * @param {ApiUserApiIssueApiUserPairingTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ issueApiUserPairingToken(requestParameters: ApiUserApiIssueApiUserPairingTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createApiUser operation in ApiUserApi. * @export * @interface ApiUserApiCreateApiUserRequest */ export interface ApiUserApiCreateApiUserRequest { /** * * @type {CreateAPIUser} * @memberof ApiUserApiCreateApiUser */ readonly createAPIUser?: CreateAPIUser; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ApiUserApiCreateApiUser */ readonly idempotencyKey?: string; } /** * Request parameters for issueApiUserPairingToken operation in ApiUserApi. * @export * @interface ApiUserApiIssueApiUserPairingTokenRequest */ export interface ApiUserApiIssueApiUserPairingTokenRequest { /** * The ID of the api user * @type {string} * @memberof ApiUserApiIssueApiUserPairingToken */ readonly userId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ApiUserApiIssueApiUserPairingToken */ readonly idempotencyKey?: string; } /** * ApiUserApi - object-oriented interface * @export * @class ApiUserApi * @extends {BaseAPI} */ export declare class ApiUserApi extends BaseAPI { /** * Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following [guide](https://developers.fireblocks.com/docs/manage-api-keys). Endpoint Permission: Admin, Non-Signing Admin. * @summary Create API Key * @param {ApiUserApiCreateApiUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApiUserApi */ createApiUser(requestParameters?: ApiUserApiCreateApiUserRequest): Promise>; /** * List all API keys in your workspace. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. * @summary Get API Keys * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApiUserApi */ getApiUsers(): Promise>; /** * Issues a device pairing token for the given user and returns the user\'s info along with the token. - The API user must be in PENDING_ACTIVATION status. If the user is already set up (enabled), the request is rejected with a 409 Conflict. - Please note that this endpoint is available only for API keys with Owner/Admin/Non Signing Admin permissions. - This is the same pairing token that the API Co-signer requests during installation and when you pair an additional API user with an existing Co-signer. You can use this endpoint instead of copying the token from Pair API user in the Console. The token is valid for one hour. * @summary Issue API user pairing token * @param {ApiUserApiIssueApiUserPairingTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApiUserApi */ issueApiUserPairingToken(requestParameters: ApiUserApiIssueApiUserPairingTokenRequest): Promise>; }