Class Greeting

Hierarchy

UrlSection
- Greeting

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

get

get(): Promise<DictionaryGreetingInfo>

- Defined in paths/Greeting.ts:29
Since 8.2 (Release 1.0.26)
Returns a standard greeting by ID
Required Permissions
Permission Description
ReadAccounts View Greetings
Usage Plan Group
Medium

Returns Promise<DictionaryGreetingInfo>

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<DictionaryGreetingList>

- Defined in paths/Greeting.ts:16
Since 8.2 (Release 1.0.26)
Returns a list of predefined standard greetings. Please note: Custom greetings recorded by user are not returned in response to this request. See Get Extension Custom Greetings.
Required Permissions
Permission Description
ReadAccounts View Greetings
Usage Plan Group
Light

Parameters
- Optional query: ListQuery
Returns Promise<DictionaryGreetingList>

post

post(body: CustomGreetingRequest): Promise<CustomCompanyGreetingInfo>

- Defined in paths/Greeting.ts:39
Parameters
- body: CustomGreetingRequest
Returns Promise<CustomCompanyGreetingInfo>

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