Class State

Hierarchy

UrlSection
- State

Index

Constructors

constructor

Methods

Constructors

constructor

new State(prv: PathSegment, id?: string, service?: any): State

Overrides UrlSection.constructor
- Defined in paths/State.ts:6
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns State

Methods

get

get(): Promise<GetStateInfoResponse>

- Defined in paths/State.ts:27
Since 1.0.10 (Release 6.2)
Returns the information on the required state.
Usage Plan Group
Light

Returns Promise<GetStateInfoResponse>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

list

list(query?: ListQuery): Promise<GetStateListResponse>

- Defined in paths/State.ts:14
Since 1.0.10 (Release 6.2)
Returns all the states for a certain country.
Usage Plan Group
Light

Parameters
- Optional query: ListQuery
Returns Promise<GetStateListResponse>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc