Skip to content

Latest commit

 

History

History
116 lines (66 loc) · 2.87 KB

definitions.Interfaces.IRoutesClient.md

File metadata and controls

116 lines (66 loc) · 2.87 KB

mailgun.js / Modules / definitions / Interfaces / IRoutesClient

Interface: IRoutesClient

definitions.Interfaces.IRoutesClient

Table of contents

Methods

Methods

create

create(data): Promise<Route>

Parameters

Name Type
data CreateUpdateRouteData

Returns

Promise<Route>

Defined in

Interfaces/Routes/IRoutesClient.ts:8


destroy

destroy(id): Promise<DestroyRouteResponse>

Parameters

Name Type
id string

Returns

Promise<DestroyRouteResponse>

Defined in

Interfaces/Routes/IRoutesClient.ts:10


get

get(id): Promise<Route>

Parameters

Name Type
id string

Returns

Promise<Route>

Defined in

Interfaces/Routes/IRoutesClient.ts:7


list

list(query): Promise<Route[]>

Parameters

Name Type
query RoutesListQuery

Returns

Promise<Route[]>

Defined in

Interfaces/Routes/IRoutesClient.ts:6


update

update(id, data): Promise<UpdateRouteResponse>

Parameters

Name Type
id string
data CreateUpdateRouteData

Returns

Promise<UpdateRouteResponse>

Defined in

Interfaces/Routes/IRoutesClient.ts:9