Class Astroproxy

Hierarchy

Astroproxy

Index

Constructors

Properties

Methods

calculate checkResponseStatus createPort deletePort getBalance getCities getCountries getLists getOperators getPorts newipPort renewPort updatePort

Constructors

constructor

new Astroproxy(apiKey: string): Astroproxy
Parameters
- apiKey: string
Returns Astroproxy
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:12

Properties

`Readonly` apiKey

apiKey: string

`Private` got

got: Got

Methods

calculate

calculate(payload: create): Promise<Responses.Calculate.Data>
Parameters
- payload: create
Returns Promise<Responses.Calculate.Data>
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:158

`Private` checkResponseStatus

checkResponseStatus(json: {
    data?: any;
    message?: string;
    status: string;
}): void
Parameters
- json: {
      data?: any;
      message?: string;
      status: string;
  }
  - Optional data?: any
  - Optional message?: string
  - status: string
Returns void
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:27

createPort

createPort(payload: create): Promise<Responses.Ports.create.RootObject>
Parameters
- payload: create
Returns Promise<Responses.Ports.create.RootObject>
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:74

deletePort

deletePort(payload: remove): Promise<boolean>
Parameters
- payload: remove
Returns Promise<boolean>
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:84

getPorts

getPorts(payload?: {
    options?: get;
    raw?: false;
}): Promise<{
    data: Port[];
    page: pageInfo;
}>
Parameters
- Optional payload: {
  options?: get;
  raw?: false;
  }
  - Optional options?: get
  - Optional raw?: false
Returns Promise<{
data: Port[];
page: pageInfo;
}>
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:45
getPorts(payload?: {
    options?: get;
    raw?: true;
}): Promise<{
    data: Responses.Ports.get.Data;
    page: pageInfo;
}>
Parameters
- Optional payload: {
  options?: get;
  raw?: true;
  }
  - Optional options?: get
  - Optional raw?: true
Returns Promise<{
data: Responses.Ports.get.Data;
page: pageInfo;
}>
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:49

newipPort

newipPort(payload: newip): Promise<Responses.Ports.newip.ok.Data>
Parameters
- payload: newip
Returns Promise<Responses.Ports.newip.ok.Data>
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:110

renewPort

renewPort(payload: renew): Promise<Responses.Ports.renew.RootObject>
Parameters
- payload: renew
Returns Promise<Responses.Ports.renew.RootObject>
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:100

updatePort

updatePort(payload: update & {
id: number;
}): Promise<Responses.Ports.update.RootObject>
Parameters
- payload: update & {
  id: number;
  }
Returns Promise<Responses.Ports.update.RootObject>
- Defined in Development/astroproxy-api/src/components/astroproxy.ts:92

Class Astroproxy

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

apiKey: string

Returns Astroproxy

Properties

Readonly apiKey

Private got

Methods

calculate

Parameters

payload: create

Returns Promise<Responses.Calculate.Data>

Private checkResponseStatus

Parameters

json: { data?: any; message?: string; status: string; }

Optional data?: any

Optional message?: string

status: string

Returns void

createPort

Parameters

payload: create

Returns Promise<Responses.Ports.create.RootObject>

deletePort

Parameters

payload: remove

Returns Promise<boolean>

getBalance

Returns Promise<Responses.Balance.Data>

getCities

Parameters

payload: Cities

Returns Promise<Responses.Cities.Datum[]>

getCountries

Parameters

payload: Countries = {}

Returns Promise<Responses.Countries.Datum[]>

getLists

Returns Promise<Responses.Lists.Datum[]>

getOperators

Parameters

payload: Operators

Returns Promise<Responses.Operators.Datum[]>

getPorts

Parameters

Optional payload: { options?: get; raw?: false; }

Optional options?: get

Optional raw?: false

Returns Promise<{ data: Port[]; page: pageInfo; }>

Parameters

Optional payload: { options?: get; raw?: true; }

Optional options?: get

Optional raw?: true

Returns Promise<{ data: Responses.Ports.get.Data; page: pageInfo; }>

newipPort

Parameters

payload: newip

Returns Promise<Responses.Ports.newip.ok.Data>

renewPort

Parameters

payload: renew

Returns Promise<Responses.Ports.renew.RootObject>

updatePort

Parameters

payload: update & { id: number; }

Returns Promise<Responses.Ports.update.RootObject>

Settings

Member Visibility

Theme

`Readonly` apiKey

`Private` got

`Private` checkResponseStatus

json: {
data?: any;
message?: string;
status: string;
}

`Optional` data?: any

`Optional` message?: string

`Optional` payload: {
options?: get;
raw?: false;
}

`Optional` options?: get

`Optional` raw?: false

Returns Promise<{
data: Port[];
page: pageInfo;
}>

`Optional` payload: {
options?: get;
raw?: true;
}

`Optional` options?: get

`Optional` raw?: true

Returns Promise<{
data: Responses.Ports.get.Data;
page: pageInfo;
}>

payload: update & {
id: number;
}