Class DepositsApi

Hierarchy

  • DepositsApi
    • DepositsApi

Constructors

constructor

Properties

basePath axios configuration

Methods

getDeposit getSignableDeposit listDeposits

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns x.DepositsApi

Properties

Protected basePath

basePath: string

Protected axios

axios: AxiosInstance

Protected configuration

configuration: undefined | Configuration

Methods

getDeposit

  • Get details of a deposit with the given ID

    Parameters

    • requestParameters: DepositsApiGetDepositRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Deposit, any>>

    Summary

    Get details of a deposit with the given ID

    Throws

    Memberof

    DepositsApi

getSignableDeposit

  • Gets details of a signable deposit

    Parameters

    • requestParameters: DepositsApiGetSignableDepositRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetSignableDepositResponse, any>>

    Summary

    Gets details of a signable deposit

    Throws

    Memberof

    DepositsApi

listDeposits

  • Get a list of deposits

    Parameters

    • Optional requestParameters: DepositsApiListDepositsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListDepositsResponse, any>>

    Summary

    Get a list of deposits

    Throws

    Memberof

    DepositsApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc