Class: Groups

Defined in: groups.ts:17

Contact group management operations.

Constructors

Constructor

new Groups(client): Groups;

Defined in: groups.ts:18

Parameters

Parameter	Type
client	HttpClient

Returns

Groups

Methods

addContact()

addContact(groupId, input): Promise<Result<Contact, MNotifyError>>;

Defined in: groups.ts:61

Adds an existing contact to a group.

Parameters

Parameter	Type
groupId	string
input	CreateContactInput

Returns

Promise<Result<Contact, MNotifyError>>

---

create()

create(input): Promise<Result<Group, MNotifyError>>;

Defined in: groups.ts:21

Creates a new contact group.

Parameters

Parameter	Type
input	CreateGroupInput

Returns

Promise<Result<Group, MNotifyError>>

---

delete()

delete(id): Promise<Result<{
  message: string;
  status: string;
}, MNotifyError>>;

Defined in: groups.ts:77

Deletes a group by its ID.

Parameters

Parameter	Type
id	string

Returns

Promise<Result<{ message: string; status: string; }, MNotifyError>>

---

get()

get(id): Promise<Result<Group, MNotifyError>>;

Defined in: groups.ts:56

Fetches a single group by its ID.

Parameters

Parameter	Type
id	string

Returns

Promise<Result<Group, MNotifyError>>

---

list()

list(): Promise<Result<Group[], MNotifyError>>;

Defined in: groups.ts:51

Lists all contact groups.

Returns

Promise<Result<Group[], MNotifyError>>

---

removeContact()

removeContact(contactId): Promise<Result<{
  message: string;
  status: string;
}, MNotifyError>>;

Defined in: groups.ts:66

Deletes a contact by its ID.

Parameters

Parameter	Type
contactId	string

Returns

Promise<Result<{ message: string; status: string; }, MNotifyError>>