Class InsuranceAPI

Insurance API module - /v1/insurance

Hierarchy

InsuranceAPI

Index

Constructors

Properties

Methods

Constructors

constructor

new InsuranceAPI(client: AxiosInstance): InsuranceAPI
Parameters
- client: AxiosInstance
Returns InsuranceAPI
- Defined in javascript/src/insurance/api.ts:9

Properties

`Private` client

client: AxiosInstance

Methods

addFunds

addFunds(insuranceProvider: "shipsurance", params: SE.InsuranceAccount): Promise<AxiosResponse<SE.InsuranceAccount, any>>
The addFunds method add funds to the account balance of the given insuranceProvider.
Parameters
- insuranceProvider: "shipsurance"
- params: SE.InsuranceAccount
Returns Promise<AxiosResponse<SE.InsuranceAccount, any>>
- Defined in javascript/src/insurance/api.ts:24

get

get(insuranceProvider: "shipsurance"): Promise<AxiosResponse<SE.InsuranceAccount, any>>
The get method retrieves the insurance balance for a given insuranceProvider by ID.
Parameters
- insuranceProvider: "shipsurance"
Returns Promise<AxiosResponse<SE.InsuranceAccount, any>>
- Defined in javascript/src/insurance/api.ts:17

Generated using TypeDoc