MailSlurpAPI.Api.GroupController (mailslurp v12.1.29)
API calls for all endpoints tagged GroupController
.
Link to this section Summary
Functions
Add contacts to a group
Create a group
Delete group
Get all Contact Groups in paginated format
Get group and contacts belonging to it
Get group and paginated contacts belonging to it
Get all groups
Remove contacts from a group
Link to this section Functions
add_contacts_to_group(connection, group_id, update_group_contacts_option, opts \\ [])
Specs
add_contacts_to_group( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.UpdateGroupContacts.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.GroupContactsDto.t()} | {:error, Tesla.Env.t()}
Add contacts to a group
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- group_id (String.t): groupId
- update_group_contacts_option (UpdateGroupContacts): updateGroupContactsOption
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
create_group(connection, create_group_options, opts \\ [])
Specs
create_group( Tesla.Env.client(), MailSlurpAPI.Model.CreateGroupOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.GroupDto.t()} | {:error, Tesla.Env.t()}
Create a group
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- create_group_options (CreateGroupOptions): createGroupOptions
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
delete_group(connection, group_id, opts \\ [])
Specs
delete_group(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete group
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- group_id (String.t): groupId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_all_groups(connection, opts \\ [])
Specs
get_all_groups(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageGroupProjection.t()} | {:error, Tesla.Env.t()}
Get all Contact Groups in paginated format
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure
get_group(connection, group_id, opts \\ [])
Specs
get_group(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.GroupDto.t()} | {:error, Tesla.Env.t()}
Get group
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- group_id (String.t): groupId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_group_with_contacts(connection, group_id, opts \\ [])
Specs
get_group_with_contacts(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.GroupContactsDto.t()} | {:error, Tesla.Env.t()}
Get group and contacts belonging to it
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- group_id (String.t): groupId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_group_with_contacts_paginated(connection, group_id, opts \\ [])
Specs
get_group_with_contacts_paginated(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.PageContactProjection.t()} | {:error, Tesla.Env.t()}
Get group and paginated contacts belonging to it
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- group_id (String.t): groupId
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure
get_groups(connection, opts \\ [])
Specs
get_groups(Tesla.Env.client(), keyword()) :: {:ok, [MailSlurpAPI.Model.GroupProjection.t()]} | {:error, Tesla.Env.t()}
Get all groups
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
, ...]} on success {:error, info} on failure
remove_contacts_from_group(connection, group_id, update_group_contacts_option, opts \\ [])
Specs
remove_contacts_from_group( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.UpdateGroupContacts.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.GroupContactsDto.t()} | {:error, Tesla.Env.t()}
Remove contacts from a group
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- group_id (String.t): groupId
- update_group_contacts_option (UpdateGroupContacts): updateGroupContactsOption
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure