Class GroupsResource

Hierarchy

AbstractResource
- GroupsResource

Index

Constructors

Properties

Methods

all create delete edit one

Constructors

constructor

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

Properties

`Protected` `Readonly`client

client: Client

Methods

all

all(): Promise<Group[]>
Returns Promise<Group[]>
- Defined in resources/groups/GroupsResource.ts:20

create

create(group: Pick<Group, "name">): Promise<Group>
Parameters
- group: Pick<Group, "name">
Returns Promise<Group>
- Defined in resources/groups/GroupsResource.ts:11

delete

delete(id: number, deleteContacts?: boolean): Promise<DeleteGroupResponse>
Parameters
- id: number
- deleteContacts: boolean = false
Returns Promise<DeleteGroupResponse>
- Defined in resources/groups/GroupsResource.ts:15

edit

edit(id: number, group: Pick<Group, "name">): Promise<Group>
Parameters
- id: number
- group: Pick<Group, "name">
Returns Promise<Group>
- Defined in resources/groups/GroupsResource.ts:6

one

one(id: number): Promise<Group>
Parameters
- id: number
Returns Promise<Group>
- Defined in resources/groups/GroupsResource.ts:24