Class Companies

Hierarchy

UrlSection
- Companies

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

get

get(): Promise<GlipCompany>

- Defined in paths/Companies.ts:13
Since 1.0.28 (Release 8.4)
Returns a company by ID.
Required Permissions
Permission Description
Glip Availability of Glip
API Group
Light

Returns Promise<GlipCompany>

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

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