Interface: IRoutesClient
September 4, 2026 · View on GitHub
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
matchAddress
▸ matchAddress(address): Promise<Route>
Parameters
| Name | Type |
|---|---|
address | string |
Returns
Promise<Route>
Defined in
Interfaces/Routes/IRoutesClient.ts:11
update
▸ update(id, data): Promise<UpdateRouteResponse>
Parameters
| Name | Type |
|---|---|
id | string |
data | CreateUpdateRouteData |
Returns
Promise<UpdateRouteResponse>