Class Client

Hierarchy

Client

Index

Constructors

constructor

Methods

Constructors

constructor

new Client(token: string, options?: ClientOptions): Client

- Defined in structures/Client.ts:13
Create a new API client

Parameters
- token: string
  
  Your API Token
- Optional options: ClientOptions
  
  Options for the client
Returns Client

Methods

getCutter

getCutter(search?: string | number): Promise<CutterResponse | CutterData | Error>

- Defined in structures/Client.ts:22
Get a cutter or all cutters

Parameters
- Optional search: string | number
Returns Promise<CutterResponse | CutterData | Error>

getFarm

getFarm(id: string): Promise<Error | FarmResponse | FarmData>

- Defined in structures/Client.ts:82
Get a user's farm

Parameters
- id: string
Returns Promise<Error | FarmResponse | FarmData>

getPlot

getPlot(search?: string | number): Promise<Error | PlotResponse | PlotData>

- Defined in structures/Client.ts:34
Get a plot or all plots

Parameters
- Optional search: string | number
Returns Promise<Error | PlotResponse | PlotData>

getStorage

getStorage(search?: string | number): Promise<Error | StorageResponse | FarmStorageData>

- Defined in structures/Client.ts:58
Get a storage or all storages

Parameters
- Optional search: string | number
Returns Promise<Error | StorageResponse | FarmStorageData>

getTree

getTree(search?: string | number): Promise<Error | TreeResponse | TreeData>

- Defined in structures/Client.ts:46
Get a tree or all trees

Parameters
- Optional search: string | number
Returns Promise<Error | TreeResponse | TreeData>

getUser

getUser(id: string): Promise<Error | UserResponse | UserData>

- Defined in structures/Client.ts:94
Get a user's data

Parameters
- id: string
Returns Promise<Error | UserResponse | UserData>

getVehicle

getVehicle(search?: string | number): Promise<Error | VehicleResponse | VehicleData>

- Defined in structures/Client.ts:70
Get a vehicle or all vehicles

Parameters
- Optional search: string | number
Returns Promise<Error | VehicleResponse | VehicleData>

Generated using TypeDoc