Class RateCardsAPI

Rate Cards API module - /v1/rate_cards

Hierarchy

RateCardsAPI

Index

Constructors

Properties

Methods

create delete download get list publish update upload

Constructors

constructor

new RateCardsAPI(client: AxiosInstance): RateCardsAPI
Parameters
- client: AxiosInstance
Returns RateCardsAPI
- Defined in javascript/src/rate-cards/api.ts:9

Properties

`Private` client

client: AxiosInstance

Methods

create

create(rateCardInput: SE.RateCardInput): Promise<AxiosResponse<SE.RateCard, any>>
The create method creates a new rate card for a given user.
Parameters
- rateCardInput: SE.RateCardInput
Returns Promise<AxiosResponse<SE.RateCard, any>>
- Defined in javascript/src/rate-cards/api.ts:32

delete

delete(rateCardId: string): Promise<AxiosResponse<any, any>>
Description
https://auctane.atlassian.net/wiki/spaces/TE/pages/3837431603/Inc+1+3.+Rate+Card+Details#Delete-Rate-Card
Parameters
- rateCardId: string
Returns Promise<AxiosResponse<any, any>>
- Defined in javascript/src/rate-cards/api.ts:80

download

download(rateCardId: string): Promise<AxiosResponse<Blob, any>>
The download method allows for downloading a given rate card by rateCardId.
Parameters
- rateCardId: string
Returns Promise<AxiosResponse<Blob, any>>
- Defined in javascript/src/rate-cards/api.ts:47

get

get(rateCardId: string): Promise<AxiosResponse<SE.RateCard, any>>
The get method retrieves a specific rate card by rateCardId.
Parameters
- rateCardId: string
Returns Promise<AxiosResponse<SE.RateCard, any>>
- Defined in javascript/src/rate-cards/api.ts:25

list

list(carrierIds: string[]): Promise<AxiosResponse<{
rateCards: SE.RateCard[];
}, any>>
The list method retrieves a list of rate cards for a given list of carrier ID's.
Parameters
- carrierIds: string[]
Returns Promise<AxiosResponse<{
rateCards: SE.RateCard[];
}, any>>
- Defined in javascript/src/rate-cards/api.ts:16

publish

publish(rateCardId: string): Promise<AxiosResponse<any, any>>
The publish method allows for publishing a given rate card by rateCardId.
Parameters
- rateCardId: string
Returns Promise<AxiosResponse<any, any>>
- Defined in javascript/src/rate-cards/api.ts:73

update

update(rateCard: SE.RateCard): Promise<AxiosResponse<SE.RateCard, any>>
The update method updates a specific rate card by rateCardId with a new RateCard.
Parameters
- rateCard: SE.RateCard
Returns Promise<AxiosResponse<SE.RateCard, any>>
- Defined in javascript/src/rate-cards/api.ts:40

upload

upload(rateCardId: string, file: File): Promise<AxiosResponse<SE.RateCard, any>>
The upload method allows for uploading a given rate card as a spreadsheet file.
Parameters
- rateCardId: string
- file: File
Returns Promise<AxiosResponse<SE.RateCard, any>>
- Defined in javascript/src/rate-cards/api.ts:59

Generated using TypeDoc