@circle-fin/circle-sdk/dist/generated/apis/encryption-api.d.ts

Node.js SDK for Circle API

/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
import { Configuration } from "../configuration";
import { RequestArgs, BaseAPI } from "../base";
import { GetPublicKeyResponse } from "../models";
/**
 * EncryptionApi - axios parameter creator
 * @export
 */
export declare const EncryptionApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more.
     * @summary Get public key
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPublicKey: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * EncryptionApi - functional programming interface
 * @export
 */
export declare const EncryptionApiFp: (configuration?: Configuration) => {
    /**
     * Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more.
     * @summary Get public key
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPublicKey(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicKeyResponse>>;
};
/**
 * EncryptionApi - factory interface
 * @export
 */
export declare const EncryptionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more.
     * @summary Get public key
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPublicKey(options?: any): AxiosPromise<GetPublicKeyResponse>;
};
/**
 * EncryptionApi - object-oriented interface
 * @export
 * @class EncryptionApi
 * @extends {BaseAPI}
 */
export declare class EncryptionApi extends BaseAPI {
    /**
     * Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more.
     * @summary Get public key
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EncryptionApi
     */
    getPublicKey(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPublicKeyResponse, any>>;
}