/** * 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 { ContactsPagedResponse } from '../models'; /** * ContactsApi - axios parameter creator * @export */ export declare const ContactsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns a paginated list of the workspace\'s address book contacts. Live contacts are returned by default; pass `archived=true` to return only the archived ones. Results are sorted by `name` ascending unless `sortBy`/`order` say otherwise. Because the sort column is the page cursor\'s leading key, a `pageCursor` must be replayed with the same sort it was minted under, or the request is rejected. Endpoint Permissions: any workspace role may read the address book. Writes are role-gated. * @summary List contacts * @param {string} [pageCursor] Cursor indicating the page position. Omit to fetch the first page. * @param {number} [pageSize] Number of results per page * @param {boolean} [includeTotal] Return the total count of matching contacts alongside the page. Counting is opt-in because it costs an extra pass over the filtered set; `total` is omitted from the response unless this is `true`. * @param {string} [name] Filter by a case-insensitive substring of the contact name * @param {Array} [types] Filter by one or more contact types * @param {string} [containerId] Filter by the container holding the contact * @param {boolean} [archived] Return only archived contacts instead of live ones * @param {GetContactsAccessControlEnum} [accessControl] Filter by the access control applied to the contact * @param {Array} [includeTagIds] List of tag IDs to include. Contacts with any of these tags will be included * @param {Array} [excludeTagIds] List of tag IDs to exclude. Contacts with any of these tags will be filtered out * @param {GetContactsSortByEnum} [sortBy] The field to sort by * @param {GetContactsOrderEnum} [order] The sort direction * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContacts: (pageCursor?: string, pageSize?: number, includeTotal?: boolean, name?: string, types?: Array, containerId?: string, archived?: boolean, accessControl?: GetContactsAccessControlEnum, includeTagIds?: Array, excludeTagIds?: Array, sortBy?: GetContactsSortByEnum, order?: GetContactsOrderEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * ContactsApi - functional programming interface * @export */ export declare const ContactsApiFp: (configuration?: Configuration) => { /** * Returns a paginated list of the workspace\'s address book contacts. Live contacts are returned by default; pass `archived=true` to return only the archived ones. Results are sorted by `name` ascending unless `sortBy`/`order` say otherwise. Because the sort column is the page cursor\'s leading key, a `pageCursor` must be replayed with the same sort it was minted under, or the request is rejected. Endpoint Permissions: any workspace role may read the address book. Writes are role-gated. * @summary List contacts * @param {string} [pageCursor] Cursor indicating the page position. Omit to fetch the first page. * @param {number} [pageSize] Number of results per page * @param {boolean} [includeTotal] Return the total count of matching contacts alongside the page. Counting is opt-in because it costs an extra pass over the filtered set; `total` is omitted from the response unless this is `true`. * @param {string} [name] Filter by a case-insensitive substring of the contact name * @param {Array} [types] Filter by one or more contact types * @param {string} [containerId] Filter by the container holding the contact * @param {boolean} [archived] Return only archived contacts instead of live ones * @param {GetContactsAccessControlEnum} [accessControl] Filter by the access control applied to the contact * @param {Array} [includeTagIds] List of tag IDs to include. Contacts with any of these tags will be included * @param {Array} [excludeTagIds] List of tag IDs to exclude. Contacts with any of these tags will be filtered out * @param {GetContactsSortByEnum} [sortBy] The field to sort by * @param {GetContactsOrderEnum} [order] The sort direction * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContacts(pageCursor?: string, pageSize?: number, includeTotal?: boolean, name?: string, types?: Array, containerId?: string, archived?: boolean, accessControl?: GetContactsAccessControlEnum, includeTagIds?: Array, excludeTagIds?: Array, sortBy?: GetContactsSortByEnum, order?: GetContactsOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContactsApi - factory interface * @export */ export declare const ContactsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns a paginated list of the workspace\'s address book contacts. Live contacts are returned by default; pass `archived=true` to return only the archived ones. Results are sorted by `name` ascending unless `sortBy`/`order` say otherwise. Because the sort column is the page cursor\'s leading key, a `pageCursor` must be replayed with the same sort it was minted under, or the request is rejected. Endpoint Permissions: any workspace role may read the address book. Writes are role-gated. * @summary List contacts * @param {ContactsApiGetContactsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getContacts(requestParameters?: ContactsApiGetContactsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getContacts operation in ContactsApi. * @export * @interface ContactsApiGetContactsRequest */ export interface ContactsApiGetContactsRequest { /** * Cursor indicating the page position. Omit to fetch the first page. * @type {string} * @memberof ContactsApiGetContacts */ readonly pageCursor?: string; /** * Number of results per page * @type {number} * @memberof ContactsApiGetContacts */ readonly pageSize?: number; /** * Return the total count of matching contacts alongside the page. Counting is opt-in because it costs an extra pass over the filtered set; `total` is omitted from the response unless this is `true`. * @type {boolean} * @memberof ContactsApiGetContacts */ readonly includeTotal?: boolean; /** * Filter by a case-insensitive substring of the contact name * @type {string} * @memberof ContactsApiGetContacts */ readonly name?: string; /** * Filter by one or more contact types * @type {Array<'COUNTERPARTY' | 'OWN_ACCOUNT'>} * @memberof ContactsApiGetContacts */ readonly types?: Array; /** * Filter by the container holding the contact * @type {string} * @memberof ContactsApiGetContacts */ readonly containerId?: string; /** * Return only archived contacts instead of live ones * @type {boolean} * @memberof ContactsApiGetContacts */ readonly archived?: boolean; /** * Filter by the access control applied to the contact * @type {'WHITELIST' | 'BLACKLIST'} * @memberof ContactsApiGetContacts */ readonly accessControl?: GetContactsAccessControlEnum; /** * List of tag IDs to include. Contacts with any of these tags will be included * @type {Array} * @memberof ContactsApiGetContacts */ readonly includeTagIds?: Array; /** * List of tag IDs to exclude. Contacts with any of these tags will be filtered out * @type {Array} * @memberof ContactsApiGetContacts */ readonly excludeTagIds?: Array; /** * The field to sort by * @type {'name' | 'updatedAt'} * @memberof ContactsApiGetContacts */ readonly sortBy?: GetContactsSortByEnum; /** * The sort direction * @type {'ASC' | 'DESC'} * @memberof ContactsApiGetContacts */ readonly order?: GetContactsOrderEnum; } /** * ContactsApi - object-oriented interface * @export * @class ContactsApi * @extends {BaseAPI} */ export declare class ContactsApi extends BaseAPI { /** * Returns a paginated list of the workspace\'s address book contacts. Live contacts are returned by default; pass `archived=true` to return only the archived ones. Results are sorted by `name` ascending unless `sortBy`/`order` say otherwise. Because the sort column is the page cursor\'s leading key, a `pageCursor` must be replayed with the same sort it was minted under, or the request is rejected. Endpoint Permissions: any workspace role may read the address book. Writes are role-gated. * @summary List contacts * @param {ContactsApiGetContactsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsApi */ getContacts(requestParameters?: ContactsApiGetContactsRequest): Promise>; } /** * @export */ export declare const GetContactsTypesEnum: { readonly Counterparty: "COUNTERPARTY"; readonly OwnAccount: "OWN_ACCOUNT"; }; export type GetContactsTypesEnum = typeof GetContactsTypesEnum[keyof typeof GetContactsTypesEnum]; /** * @export */ export declare const GetContactsAccessControlEnum: { readonly Whitelist: "WHITELIST"; readonly Blacklist: "BLACKLIST"; }; export type GetContactsAccessControlEnum = typeof GetContactsAccessControlEnum[keyof typeof GetContactsAccessControlEnum]; /** * @export */ export declare const GetContactsSortByEnum: { readonly Name: "name"; readonly UpdatedAt: "updatedAt"; }; export type GetContactsSortByEnum = typeof GetContactsSortByEnum[keyof typeof GetContactsSortByEnum]; /** * @export */ export declare const GetContactsOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetContactsOrderEnum = typeof GetContactsOrderEnum[keyof typeof GetContactsOrderEnum];