Class RateShoppersAPI

Rate Shoppers API module - /v1/rate_shoppers

Hierarchy

RateShoppersAPI

Index

Constructors

Properties

Methods

create delete edit get list

Constructors

constructor

new RateShoppersAPI(client: AxiosInstance): RateShoppersAPI
Parameters
- client: AxiosInstance
Returns RateShoppersAPI
- Defined in javascript/src/rate-shoppers/api.ts:11

Properties

`Private` client

client: AxiosInstance

Methods

create

create(request: SE.RateShopperUpsertRequest): Promise<AxiosResponse<SE.RateShopper, any>>
The create method allows to create a new Rate Shopper for a given user
Parameters
- request: SE.RateShopperUpsertRequest
Returns Promise<AxiosResponse<SE.RateShopper, any>>
- Defined in javascript/src/rate-shoppers/api.ts:34

delete

delete(rateShopperId: string): Promise<AxiosResponse<void, any>>
The delete method allows to delete a Rate Shopper for a given user by the Rate Shopper ID
Parameters
- rateShopperId: string
Returns Promise<AxiosResponse<void, any>>
- Defined in javascript/src/rate-shoppers/api.ts:48

edit

edit(rateShopperId: string, request: SE.RateShopperUpsertRequest): Promise<AxiosResponse<SE.RateShopper, any>>
The edit method allows to update a Rate Shopper for a given user by the Rate Shopper ID
Parameters
- rateShopperId: string
- request: SE.RateShopperUpsertRequest
Returns Promise<AxiosResponse<SE.RateShopper, any>>
- Defined in javascript/src/rate-shoppers/api.ts:41

get

get(rateShopperId: string): Promise<AxiosResponse<SE.RateShopper, any>>
The get method retrieves a Rate Shoppers for a given user by the Rate Shopper ID
Parameters
- rateShopperId: string
Returns Promise<AxiosResponse<SE.RateShopper, any>>
- Defined in javascript/src/rate-shoppers/api.ts:27

list

list(params?: SE.SortableQuery<"created_at" | "name">): Promise<AxiosResponse<SE.RateShopperListResponse, any>>
The list method retrieves a list of Rate Shoppers for a given user.
Parameters
- Optional params: SE.SortableQuery<"created_at" | "name">
Returns Promise<AxiosResponse<SE.RateShopperListResponse, any>>
- Defined in javascript/src/rate-shoppers/api.ts:18

Generated using TypeDoc