/** * 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 { BulkSigningKeyJob } from '../models'; import { CreateBulkSigningKeys } from '../models'; import { CreateBulkSigningKeysResponse } from '../models'; import { CreateSigningKeyDto } from '../models'; import { CreateValidationKeyDto } from '../models'; import { CreateValidationKeyResponseDto } from '../models'; import { GetBulkSigningKeysJobsResponse } from '../models'; import { GetSigningKeyResponseDto } from '../models'; import { GetValidationKeyResponseDto } from '../models'; import { ModifySigningKeyAgentIdDto } from '../models'; import { ModifySigningKeyDto } from '../models'; import { ModifyValidationKeyDto } from '../models'; import { SigningKeyDto } from '../models'; import { ValidationKeyDto } from '../models'; /** * KeyLinkApi - axios parameter creator * @export */ export declare const KeyLinkApiAxiosParamCreator: (configuration?: Configuration) => { /** * Accepts a set of signing keys certified by a single validation key and queues them for registration in the background. Returns a job id to poll. A workspace can have one bulk registration at a time; submitting another while one is QUEUED or IN_PROGRESS is rejected with 409. Bulk registrations from different workspaces share a limited number of slots, so a job may wait QUEUED behind another workspace\'s before it starts. Keys already registered in the workspace are recognized and skipped, so resubmitting the same request after a failure is safe and only processes what is missing. Every key must carry its own proof of ownership; a bulk registration has no interactive step in which one can arrive later. * @summary Register signing keys in bulk * @param {CreateBulkSigningKeys} createBulkSigningKeys * @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} */ createBulkSigningKeys: (createBulkSigningKeys: CreateBulkSigningKeys, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. * @summary Add a new signing key * @param {CreateSigningKeyDto} createSigningKeyDto * @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} */ createSigningKey: (createSigningKeyDto: CreateSigningKeyDto, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. * @summary Add a new validation key * @param {CreateValidationKeyDto} createValidationKeyDto * @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} */ createValidationKey: (createValidationKeyDto: CreateValidationKeyDto, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. * @summary Disables a validation key * @param {ModifyValidationKeyDto} modifyValidationKeyDto * @param {string} keyId The unique identifier for the validation key provided by Fireblocks * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ disableValidationKey: (modifyValidationKeyDto: ModifyValidationKeyDto, keyId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the progress and outcome of a bulk registration job. `created + alreadyRegistered` reaching `total` means every submitted key is present. * @summary Get a bulk registration job * @param {string} jobId The id of the bulk registration job * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBulkSigningKeysJob: (jobId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the workspace\'s bulk registration jobs, newest first, a page at a time. * @summary Get bulk registration jobs * @param {string} [pageCursor] Cursor to the next page * @param {number} [pageSize] Amount of results to return in the next page * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBulkSigningKeysJobs: (pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns a signing key if it exists, identified by the specified `keyId`. * @summary Get a signing key by `keyId` * @param {string} keyId The unique identifier for the signing key provided by Fireblocks * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSigningKey: (keyId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the list of signing keys in the workspace * @summary Get list of signing keys * @param {string} [pageCursor] Cursor to the next page * @param {number} [pageSize] Amount of results to return in the next page * @param {GetSigningKeysListSortByEnum} [sortBy] Field(s) to use for sorting * @param {GetSigningKeysListOrderEnum} [order] Is the order ascending or descending * @param {number} [vaultAccountId] Return keys assigned to a specific vault * @param {string} [agentUserId] Return keys associated with a specific agent user * @param {GetSigningKeysListAlgorithmEnum} [algorithm] Return only keys with a specific algorithm * @param {boolean} [enabled] Return keys that have been proof of ownership * @param {boolean} [available] Return keys that are proof of ownership but not assigned. Available filter can be used only when vaultAccountId and enabled filters are not set * @param {boolean | null} [isAssigned] Return keys that are assigned to a vault account * @param {string} [keyPrefix] A case-insensitive prefix filter that matches records where either keyId or signingDeviceKeyID starts with the specified value. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSigningKeysList: (pageCursor?: string, pageSize?: number, sortBy?: GetSigningKeysListSortByEnum, order?: GetSigningKeysListOrderEnum, vaultAccountId?: number, agentUserId?: string, algorithm?: GetSigningKeysListAlgorithmEnum, enabled?: boolean, available?: boolean, isAssigned?: boolean | null, keyPrefix?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a validation key if it exists, identified by the specified `keyId`. * @summary Get a validation key by `keyId` * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getValidationKey: (keyId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. * @summary Get list of registered validation keys * @param {string} [pageCursor] Cursor to the next page * @param {number} [pageSize] Amount of results to return in the next page * @param {GetValidationKeysListSortByEnum} [sortBy] Field(s) to use for sorting * @param {GetValidationKeysListOrderEnum} [order] Is the order ascending or descending * @param {boolean} [includeRevoked] Include revoked validation keys in the response * @param {*} [options] Override http request option. * @throws {RequiredError} */ getValidationKeysList: (pageCursor?: string, pageSize?: number, sortBy?: GetValidationKeysListSortByEnum, order?: GetValidationKeysListOrderEnum, includeRevoked?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. * @summary Revokes a validation key * @param {string} keyId The unique identifier for the validation key provided by Fireblocks * @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} */ revokeValidationKey: (keyId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. * @summary Set agent user id * @param {ModifySigningKeyAgentIdDto} modifySigningKeyAgentIdDto * @param {string} keyId The unique identifier for the signing key provided by Fireblocks * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAgentId: (modifySigningKeyAgentIdDto: ModifySigningKeyAgentIdDto, keyId: string, options?: RawAxiosRequestConfig) => Promise; /** * Allows assigning the signing key to a vault account, if it hasn\'t been assigned to any other vault accounts yet. * @summary Modify the signing keyId * @param {ModifySigningKeyDto} modifySigningKeyDto * @param {string} keyId The unique identifier for the signing key provided by Fireblocks * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSigningKey: (modifySigningKeyDto: ModifySigningKeyDto, keyId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * KeyLinkApi - functional programming interface * @export */ export declare const KeyLinkApiFp: (configuration?: Configuration) => { /** * Accepts a set of signing keys certified by a single validation key and queues them for registration in the background. Returns a job id to poll. A workspace can have one bulk registration at a time; submitting another while one is QUEUED or IN_PROGRESS is rejected with 409. Bulk registrations from different workspaces share a limited number of slots, so a job may wait QUEUED behind another workspace\'s before it starts. Keys already registered in the workspace are recognized and skipped, so resubmitting the same request after a failure is safe and only processes what is missing. Every key must carry its own proof of ownership; a bulk registration has no interactive step in which one can arrive later. * @summary Register signing keys in bulk * @param {CreateBulkSigningKeys} createBulkSigningKeys * @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} */ createBulkSigningKeys(createBulkSigningKeys: CreateBulkSigningKeys, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. * @summary Add a new signing key * @param {CreateSigningKeyDto} createSigningKeyDto * @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} */ createSigningKey(createSigningKeyDto: CreateSigningKeyDto, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. * @summary Add a new validation key * @param {CreateValidationKeyDto} createValidationKeyDto * @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} */ createValidationKey(createValidationKeyDto: CreateValidationKeyDto, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. * @summary Disables a validation key * @param {ModifyValidationKeyDto} modifyValidationKeyDto * @param {string} keyId The unique identifier for the validation key provided by Fireblocks * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ disableValidationKey(modifyValidationKeyDto: ModifyValidationKeyDto, keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the progress and outcome of a bulk registration job. `created + alreadyRegistered` reaching `total` means every submitted key is present. * @summary Get a bulk registration job * @param {string} jobId The id of the bulk registration job * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBulkSigningKeysJob(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the workspace\'s bulk registration jobs, newest first, a page at a time. * @summary Get bulk registration jobs * @param {string} [pageCursor] Cursor to the next page * @param {number} [pageSize] Amount of results to return in the next page * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBulkSigningKeysJobs(pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a signing key if it exists, identified by the specified `keyId`. * @summary Get a signing key by `keyId` * @param {string} keyId The unique identifier for the signing key provided by Fireblocks * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSigningKey(keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the list of signing keys in the workspace * @summary Get list of signing keys * @param {string} [pageCursor] Cursor to the next page * @param {number} [pageSize] Amount of results to return in the next page * @param {GetSigningKeysListSortByEnum} [sortBy] Field(s) to use for sorting * @param {GetSigningKeysListOrderEnum} [order] Is the order ascending or descending * @param {number} [vaultAccountId] Return keys assigned to a specific vault * @param {string} [agentUserId] Return keys associated with a specific agent user * @param {GetSigningKeysListAlgorithmEnum} [algorithm] Return only keys with a specific algorithm * @param {boolean} [enabled] Return keys that have been proof of ownership * @param {boolean} [available] Return keys that are proof of ownership but not assigned. Available filter can be used only when vaultAccountId and enabled filters are not set * @param {boolean | null} [isAssigned] Return keys that are assigned to a vault account * @param {string} [keyPrefix] A case-insensitive prefix filter that matches records where either keyId or signingDeviceKeyID starts with the specified value. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSigningKeysList(pageCursor?: string, pageSize?: number, sortBy?: GetSigningKeysListSortByEnum, order?: GetSigningKeysListOrderEnum, vaultAccountId?: number, agentUserId?: string, algorithm?: GetSigningKeysListAlgorithmEnum, enabled?: boolean, available?: boolean, isAssigned?: boolean | null, keyPrefix?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a validation key if it exists, identified by the specified `keyId`. * @summary Get a validation key by `keyId` * @param {string} keyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getValidationKey(keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. * @summary Get list of registered validation keys * @param {string} [pageCursor] Cursor to the next page * @param {number} [pageSize] Amount of results to return in the next page * @param {GetValidationKeysListSortByEnum} [sortBy] Field(s) to use for sorting * @param {GetValidationKeysListOrderEnum} [order] Is the order ascending or descending * @param {boolean} [includeRevoked] Include revoked validation keys in the response * @param {*} [options] Override http request option. * @throws {RequiredError} */ getValidationKeysList(pageCursor?: string, pageSize?: number, sortBy?: GetValidationKeysListSortByEnum, order?: GetValidationKeysListOrderEnum, includeRevoked?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. * @summary Revokes a validation key * @param {string} keyId The unique identifier for the validation key provided by Fireblocks * @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} */ revokeValidationKey(keyId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. * @summary Set agent user id * @param {ModifySigningKeyAgentIdDto} modifySigningKeyAgentIdDto * @param {string} keyId The unique identifier for the signing key provided by Fireblocks * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAgentId(modifySigningKeyAgentIdDto: ModifySigningKeyAgentIdDto, keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Allows assigning the signing key to a vault account, if it hasn\'t been assigned to any other vault accounts yet. * @summary Modify the signing keyId * @param {ModifySigningKeyDto} modifySigningKeyDto * @param {string} keyId The unique identifier for the signing key provided by Fireblocks * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSigningKey(modifySigningKeyDto: ModifySigningKeyDto, keyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * KeyLinkApi - factory interface * @export */ export declare const KeyLinkApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Accepts a set of signing keys certified by a single validation key and queues them for registration in the background. Returns a job id to poll. A workspace can have one bulk registration at a time; submitting another while one is QUEUED or IN_PROGRESS is rejected with 409. Bulk registrations from different workspaces share a limited number of slots, so a job may wait QUEUED behind another workspace\'s before it starts. Keys already registered in the workspace are recognized and skipped, so resubmitting the same request after a failure is safe and only processes what is missing. Every key must carry its own proof of ownership; a bulk registration has no interactive step in which one can arrive later. * @summary Register signing keys in bulk * @param {KeyLinkApiCreateBulkSigningKeysRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBulkSigningKeys(requestParameters: KeyLinkApiCreateBulkSigningKeysRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. * @summary Add a new signing key * @param {KeyLinkApiCreateSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSigningKey(requestParameters: KeyLinkApiCreateSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. * @summary Add a new validation key * @param {KeyLinkApiCreateValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createValidationKey(requestParameters: KeyLinkApiCreateValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. * @summary Disables a validation key * @param {KeyLinkApiDisableValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ disableValidationKey(requestParameters: KeyLinkApiDisableValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the progress and outcome of a bulk registration job. `created + alreadyRegistered` reaching `total` means every submitted key is present. * @summary Get a bulk registration job * @param {KeyLinkApiGetBulkSigningKeysJobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBulkSigningKeysJob(requestParameters: KeyLinkApiGetBulkSigningKeysJobRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the workspace\'s bulk registration jobs, newest first, a page at a time. * @summary Get bulk registration jobs * @param {KeyLinkApiGetBulkSigningKeysJobsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBulkSigningKeysJobs(requestParameters?: KeyLinkApiGetBulkSigningKeysJobsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a signing key if it exists, identified by the specified `keyId`. * @summary Get a signing key by `keyId` * @param {KeyLinkApiGetSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSigningKey(requestParameters: KeyLinkApiGetSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the list of signing keys in the workspace * @summary Get list of signing keys * @param {KeyLinkApiGetSigningKeysListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSigningKeysList(requestParameters?: KeyLinkApiGetSigningKeysListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a validation key if it exists, identified by the specified `keyId`. * @summary Get a validation key by `keyId` * @param {KeyLinkApiGetValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getValidationKey(requestParameters: KeyLinkApiGetValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. * @summary Get list of registered validation keys * @param {KeyLinkApiGetValidationKeysListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getValidationKeysList(requestParameters?: KeyLinkApiGetValidationKeysListRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. * @summary Revokes a validation key * @param {KeyLinkApiRevokeValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeValidationKey(requestParameters: KeyLinkApiRevokeValidationKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. * @summary Set agent user id * @param {KeyLinkApiSetAgentIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAgentId(requestParameters: KeyLinkApiSetAgentIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Allows assigning the signing key to a vault account, if it hasn\'t been assigned to any other vault accounts yet. * @summary Modify the signing keyId * @param {KeyLinkApiUpdateSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSigningKey(requestParameters: KeyLinkApiUpdateSigningKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createBulkSigningKeys operation in KeyLinkApi. * @export * @interface KeyLinkApiCreateBulkSigningKeysRequest */ export interface KeyLinkApiCreateBulkSigningKeysRequest { /** * * @type {CreateBulkSigningKeys} * @memberof KeyLinkApiCreateBulkSigningKeys */ readonly createBulkSigningKeys: CreateBulkSigningKeys; /** * 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 KeyLinkApiCreateBulkSigningKeys */ readonly idempotencyKey?: string; } /** * Request parameters for createSigningKey operation in KeyLinkApi. * @export * @interface KeyLinkApiCreateSigningKeyRequest */ export interface KeyLinkApiCreateSigningKeyRequest { /** * * @type {CreateSigningKeyDto} * @memberof KeyLinkApiCreateSigningKey */ readonly createSigningKeyDto: CreateSigningKeyDto; /** * 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 KeyLinkApiCreateSigningKey */ readonly idempotencyKey?: string; } /** * Request parameters for createValidationKey operation in KeyLinkApi. * @export * @interface KeyLinkApiCreateValidationKeyRequest */ export interface KeyLinkApiCreateValidationKeyRequest { /** * * @type {CreateValidationKeyDto} * @memberof KeyLinkApiCreateValidationKey */ readonly createValidationKeyDto: CreateValidationKeyDto; /** * 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 KeyLinkApiCreateValidationKey */ readonly idempotencyKey?: string; } /** * Request parameters for disableValidationKey operation in KeyLinkApi. * @export * @interface KeyLinkApiDisableValidationKeyRequest */ export interface KeyLinkApiDisableValidationKeyRequest { /** * * @type {ModifyValidationKeyDto} * @memberof KeyLinkApiDisableValidationKey */ readonly modifyValidationKeyDto: ModifyValidationKeyDto; /** * The unique identifier for the validation key provided by Fireblocks * @type {string} * @memberof KeyLinkApiDisableValidationKey */ readonly keyId: string; } /** * Request parameters for getBulkSigningKeysJob operation in KeyLinkApi. * @export * @interface KeyLinkApiGetBulkSigningKeysJobRequest */ export interface KeyLinkApiGetBulkSigningKeysJobRequest { /** * The id of the bulk registration job * @type {string} * @memberof KeyLinkApiGetBulkSigningKeysJob */ readonly jobId: string; } /** * Request parameters for getBulkSigningKeysJobs operation in KeyLinkApi. * @export * @interface KeyLinkApiGetBulkSigningKeysJobsRequest */ export interface KeyLinkApiGetBulkSigningKeysJobsRequest { /** * Cursor to the next page * @type {string} * @memberof KeyLinkApiGetBulkSigningKeysJobs */ readonly pageCursor?: string; /** * Amount of results to return in the next page * @type {number} * @memberof KeyLinkApiGetBulkSigningKeysJobs */ readonly pageSize?: number; } /** * Request parameters for getSigningKey operation in KeyLinkApi. * @export * @interface KeyLinkApiGetSigningKeyRequest */ export interface KeyLinkApiGetSigningKeyRequest { /** * The unique identifier for the signing key provided by Fireblocks * @type {string} * @memberof KeyLinkApiGetSigningKey */ readonly keyId: string; } /** * Request parameters for getSigningKeysList operation in KeyLinkApi. * @export * @interface KeyLinkApiGetSigningKeysListRequest */ export interface KeyLinkApiGetSigningKeysListRequest { /** * Cursor to the next page * @type {string} * @memberof KeyLinkApiGetSigningKeysList */ readonly pageCursor?: string; /** * Amount of results to return in the next page * @type {number} * @memberof KeyLinkApiGetSigningKeysList */ readonly pageSize?: number; /** * Field(s) to use for sorting * @type {'createdAt'} * @memberof KeyLinkApiGetSigningKeysList */ readonly sortBy?: GetSigningKeysListSortByEnum; /** * Is the order ascending or descending * @type {'ASC' | 'DESC'} * @memberof KeyLinkApiGetSigningKeysList */ readonly order?: GetSigningKeysListOrderEnum; /** * Return keys assigned to a specific vault * @type {number} * @memberof KeyLinkApiGetSigningKeysList */ readonly vaultAccountId?: number; /** * Return keys associated with a specific agent user * @type {string} * @memberof KeyLinkApiGetSigningKeysList */ readonly agentUserId?: string; /** * Return only keys with a specific algorithm * @type {'ECDSA_SECP256K1' | 'EDDSA_ED25519'} * @memberof KeyLinkApiGetSigningKeysList */ readonly algorithm?: GetSigningKeysListAlgorithmEnum; /** * Return keys that have been proof of ownership * @type {boolean} * @memberof KeyLinkApiGetSigningKeysList */ readonly enabled?: boolean; /** * Return keys that are proof of ownership but not assigned. Available filter can be used only when vaultAccountId and enabled filters are not set * @type {boolean} * @memberof KeyLinkApiGetSigningKeysList */ readonly available?: boolean; /** * Return keys that are assigned to a vault account * @type {boolean} * @memberof KeyLinkApiGetSigningKeysList */ readonly isAssigned?: boolean | null; /** * A case-insensitive prefix filter that matches records where either keyId or signingDeviceKeyID starts with the specified value. * @type {string} * @memberof KeyLinkApiGetSigningKeysList */ readonly keyPrefix?: string; } /** * Request parameters for getValidationKey operation in KeyLinkApi. * @export * @interface KeyLinkApiGetValidationKeyRequest */ export interface KeyLinkApiGetValidationKeyRequest { /** * * @type {string} * @memberof KeyLinkApiGetValidationKey */ readonly keyId: string; } /** * Request parameters for getValidationKeysList operation in KeyLinkApi. * @export * @interface KeyLinkApiGetValidationKeysListRequest */ export interface KeyLinkApiGetValidationKeysListRequest { /** * Cursor to the next page * @type {string} * @memberof KeyLinkApiGetValidationKeysList */ readonly pageCursor?: string; /** * Amount of results to return in the next page * @type {number} * @memberof KeyLinkApiGetValidationKeysList */ readonly pageSize?: number; /** * Field(s) to use for sorting * @type {'createdAt'} * @memberof KeyLinkApiGetValidationKeysList */ readonly sortBy?: GetValidationKeysListSortByEnum; /** * Is the order ascending or descending * @type {'ASC' | 'DESC'} * @memberof KeyLinkApiGetValidationKeysList */ readonly order?: GetValidationKeysListOrderEnum; /** * Include revoked validation keys in the response * @type {boolean} * @memberof KeyLinkApiGetValidationKeysList */ readonly includeRevoked?: boolean; } /** * Request parameters for revokeValidationKey operation in KeyLinkApi. * @export * @interface KeyLinkApiRevokeValidationKeyRequest */ export interface KeyLinkApiRevokeValidationKeyRequest { /** * The unique identifier for the validation key provided by Fireblocks * @type {string} * @memberof KeyLinkApiRevokeValidationKey */ readonly keyId: 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 KeyLinkApiRevokeValidationKey */ readonly idempotencyKey?: string; } /** * Request parameters for setAgentId operation in KeyLinkApi. * @export * @interface KeyLinkApiSetAgentIdRequest */ export interface KeyLinkApiSetAgentIdRequest { /** * * @type {ModifySigningKeyAgentIdDto} * @memberof KeyLinkApiSetAgentId */ readonly modifySigningKeyAgentIdDto: ModifySigningKeyAgentIdDto; /** * The unique identifier for the signing key provided by Fireblocks * @type {string} * @memberof KeyLinkApiSetAgentId */ readonly keyId: string; } /** * Request parameters for updateSigningKey operation in KeyLinkApi. * @export * @interface KeyLinkApiUpdateSigningKeyRequest */ export interface KeyLinkApiUpdateSigningKeyRequest { /** * * @type {ModifySigningKeyDto} * @memberof KeyLinkApiUpdateSigningKey */ readonly modifySigningKeyDto: ModifySigningKeyDto; /** * The unique identifier for the signing key provided by Fireblocks * @type {string} * @memberof KeyLinkApiUpdateSigningKey */ readonly keyId: string; } /** * KeyLinkApi - object-oriented interface * @export * @class KeyLinkApi * @extends {BaseAPI} */ export declare class KeyLinkApi extends BaseAPI { /** * Accepts a set of signing keys certified by a single validation key and queues them for registration in the background. Returns a job id to poll. A workspace can have one bulk registration at a time; submitting another while one is QUEUED or IN_PROGRESS is rejected with 409. Bulk registrations from different workspaces share a limited number of slots, so a job may wait QUEUED behind another workspace\'s before it starts. Keys already registered in the workspace are recognized and skipped, so resubmitting the same request after a failure is safe and only processes what is missing. Every key must carry its own proof of ownership; a bulk registration has no interactive step in which one can arrive later. * @summary Register signing keys in bulk * @param {KeyLinkApiCreateBulkSigningKeysRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ createBulkSigningKeys(requestParameters: KeyLinkApiCreateBulkSigningKeysRequest): Promise>; /** * Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled. * @summary Add a new signing key * @param {KeyLinkApiCreateSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ createSigningKey(requestParameters: KeyLinkApiCreateSigningKeyRequest): Promise>; /** * Adds a new validation key used to validate signing keys. The new validation key will undergo an approval process by the workspace quorum. * @summary Add a new validation key * @param {KeyLinkApiCreateValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ createValidationKey(requestParameters: KeyLinkApiCreateValidationKeyRequest): Promise>; /** * DEPRECATED - Please use `POST /key_link/validation_keys/{keyId}/revoke` instead. Allows disabling validation key even if it has not expired yet. It is not allowed to enable the validation key back. Another key has to be used for future validations. * @summary Disables a validation key * @param {KeyLinkApiDisableValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof KeyLinkApi */ disableValidationKey(requestParameters: KeyLinkApiDisableValidationKeyRequest): Promise>; /** * Returns the progress and outcome of a bulk registration job. `created + alreadyRegistered` reaching `total` means every submitted key is present. * @summary Get a bulk registration job * @param {KeyLinkApiGetBulkSigningKeysJobRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ getBulkSigningKeysJob(requestParameters: KeyLinkApiGetBulkSigningKeysJobRequest): Promise>; /** * Returns the workspace\'s bulk registration jobs, newest first, a page at a time. * @summary Get bulk registration jobs * @param {KeyLinkApiGetBulkSigningKeysJobsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ getBulkSigningKeysJobs(requestParameters?: KeyLinkApiGetBulkSigningKeysJobsRequest): Promise>; /** * Returns a signing key if it exists, identified by the specified `keyId`. * @summary Get a signing key by `keyId` * @param {KeyLinkApiGetSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ getSigningKey(requestParameters: KeyLinkApiGetSigningKeyRequest): Promise>; /** * Returns the list of signing keys in the workspace * @summary Get list of signing keys * @param {KeyLinkApiGetSigningKeysListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ getSigningKeysList(requestParameters?: KeyLinkApiGetSigningKeysListRequest): Promise>; /** * Returns a validation key if it exists, identified by the specified `keyId`. * @summary Get a validation key by `keyId` * @param {KeyLinkApiGetValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ getValidationKey(requestParameters: KeyLinkApiGetValidationKeyRequest): Promise>; /** * Returns the list of validation keys in the workspace. By default, revoked keys are filtered out. Use `includeRevoked=true` to show all keys. * @summary Get list of registered validation keys * @param {KeyLinkApiGetValidationKeysListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ getValidationKeysList(requestParameters?: KeyLinkApiGetValidationKeysListRequest): Promise>; /** * Revokes a validation key, making it permanently unusable for validation. Once revoked, a key cannot be un-revoked. Another key has to be used for future validations. * @summary Revokes a validation key * @param {KeyLinkApiRevokeValidationKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ revokeValidationKey(requestParameters: KeyLinkApiRevokeValidationKeyRequest): Promise>; /** * Can modify existing signing key id if the key is not enabled. The change done in background and will be visible once applied. If key is already enabled (after proof of ownership) the user cannot be changed. * @summary Set agent user id * @param {KeyLinkApiSetAgentIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ setAgentId(requestParameters: KeyLinkApiSetAgentIdRequest): Promise>; /** * Allows assigning the signing key to a vault account, if it hasn\'t been assigned to any other vault accounts yet. * @summary Modify the signing keyId * @param {KeyLinkApiUpdateSigningKeyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KeyLinkApi */ updateSigningKey(requestParameters: KeyLinkApiUpdateSigningKeyRequest): Promise>; } /** * @export */ export declare const GetSigningKeysListSortByEnum: { readonly CreatedAt: "createdAt"; }; export type GetSigningKeysListSortByEnum = typeof GetSigningKeysListSortByEnum[keyof typeof GetSigningKeysListSortByEnum]; /** * @export */ export declare const GetSigningKeysListOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetSigningKeysListOrderEnum = typeof GetSigningKeysListOrderEnum[keyof typeof GetSigningKeysListOrderEnum]; /** * @export */ export declare const GetSigningKeysListAlgorithmEnum: { readonly EcdsaSecp256K1: "ECDSA_SECP256K1"; readonly EddsaEd25519: "EDDSA_ED25519"; }; export type GetSigningKeysListAlgorithmEnum = typeof GetSigningKeysListAlgorithmEnum[keyof typeof GetSigningKeysListAlgorithmEnum]; /** * @export */ export declare const GetValidationKeysListSortByEnum: { readonly CreatedAt: "createdAt"; }; export type GetValidationKeysListSortByEnum = typeof GetValidationKeysListSortByEnum[keyof typeof GetValidationKeysListSortByEnum]; /** * @export */ export declare const GetValidationKeysListOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetValidationKeysListOrderEnum = typeof GetValidationKeysListOrderEnum[keyof typeof GetValidationKeysListOrderEnum];