Class Contact

Hierarchy

UrlSection
- Contact

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

delete

delete(): Promise<void>

- Defined in paths/Contact.ts:66
Required Permissions
Permission Description
Contacts Creating, viewing, editing and deleting user personal contacts
ReadContacts Viewing user personal contacts
Usage Plan Group
Heavy

Returns Promise<void>

get

get(): Promise<PersonalContactResource>

- Defined in paths/Contact.ts:40
Required Permissions
Permission Description
ReadContacts Viewing user personal contacts
Usage Plan Group
Heavy

Returns Promise<PersonalContactResource>

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

- Defined in paths/Contact.ts:14
Required Permissions
Permission Description
ReadContacts Viewing user personal contacts
Usage Plan Group
Heavy

Parameters
- Optional query: ListQuery
Returns Promise<ContactList>

post

post(body: PersonalContactResource): Promise<PersonalContactResource>

- Defined in paths/Contact.ts:27
Required Permissions
Permission Description
Contacts Creating, viewing, editing and deleting user personal contacts
ReadContacts Viewing user personal contacts
Usage Plan Group
Heavy

Parameters
- body: PersonalContactResource
Returns Promise<PersonalContactResource>

put

put(body: PersonalContactResource): Promise<PersonalContactResource>

- Defined in paths/Contact.ts:53
Required Permissions
Permission Description
Contacts Creating, viewing, editing and deleting user personal contacts
ReadContacts Viewing user personal contacts
Usage Plan Group
Heavy

Parameters
- body: PersonalContactResource
Returns Promise<PersonalContactResource>

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