Class ContactsResource

Hierarchy

AbstractResource
- ContactsResource

Index

Constructors

Properties

Methods

create delete get list update

Constructors

constructor

new ContactsResource(client: Client): ContactsResource
Parameters
- client: Client
Returns ContactsResource
Inherited from AbstractResource.constructor
- Defined in resources/AbstractResource.ts:4

Properties

`Protected` `Readonly`client

client: Client

Methods

create

create(__namedParameters: ContactsCreateParams): Promise<Contact>
Parameters
- __namedParameters: ContactsCreateParams
Returns Promise<Contact>
- Defined in resources/contacts/ContactsResource.ts:9

delete

delete(id: number): Promise<ContactsDeleteResponse>
Parameters
- id: number
Returns Promise<ContactsDeleteResponse>
- Defined in resources/contacts/ContactsResource.ts:32

get

get(id: number): Promise<Contact>
Parameters
- id: number
Returns Promise<Contact>
- Defined in resources/contacts/ContactsResource.ts:36

list

list(p?: ContactsListParams): Promise<ContactsListResponse>
Parameters
- p: ContactsListParams = {}
Returns Promise<ContactsListResponse>
- Defined in resources/contacts/ContactsResource.ts:40

update

update(p: Contact): Promise<Contact>
Parameters
- p: Contact
Returns Promise<Contact>
- Defined in resources/contacts/ContactsResource.ts:44