Class NetcupRestApi

Hierarchy

NetcupRestApi

Index

Constructors

Properties

Methods

infoDnsRecords infoDnsZone login postJson updateDnsRecords

Constructors

constructor

new NetcupRestApi(format?: JSON): NetcupRestApi
Parameters
- Optional format: JSON
Returns NetcupRestApi
- Defined in api.ts:34

Properties

axios

axios: AxiosInstance = ...

format

format: JSON = Formats.JSON

Methods

infoDnsRecords

infoDnsRecords(params: WithAuthentication<InfoDNSRecordsParam>): Promise<InfoDNSRecordsResponse>
Parameters
- params: WithAuthentication<InfoDNSRecordsParam>
Returns Promise<InfoDNSRecordsResponse>
- Defined in api.ts:78

infoDnsZone

infoDnsZone(params: WithAuthentication<InfoDNSZoneParam>): Promise<InfoDNSZoneResponse>
Parameters
- params: WithAuthentication<InfoDNSZoneParam>
Returns Promise<InfoDNSZoneResponse>
- Defined in api.ts:66

login

login(params: LoginParam): Promise<LoginResponse>
Parameters
- params: LoginParam
Returns Promise<LoginResponse>
- Defined in api.ts:54

`Protected` postJson

postJson<Req, Res>(url: string, data: Req, options?: AxiosRequestConfig<any>): Promise<Res>
Type Parameters
- Req
- Res
Parameters
- url: string
- data: Req
- Optional options: AxiosRequestConfig<any>
Returns Promise<Res>
- Defined in api.ts:42

updateDnsRecords

updateDnsRecords(params: WithAuthentication<UpdateDNSRecordsParam>): Promise<UpdateDNSRecordsResponse>
Parameters
- params: WithAuthentication<UpdateDNSRecordsParam>
Returns Promise<UpdateDNSRecordsResponse>
- Defined in api.ts:90

Generated using TypeDoc