MailSlurpAPI.Api.ContactController (mailslurp v11.7.8)
API calls for all endpoints tagged ContactController
.
Link to this section Summary
Link to this section Functions
Link to this function
create_contact(connection, create_contact_options, opts \\ [])
Specs
create_contact( Tesla.Env.client(), MailSlurpAPI.Model.CreateContactOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.ContactDto.t()} | {:error, Tesla.Env.t()}
Create a contact
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- create_contact_options (CreateContactOptions): createContactOptions
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
delete_contact(connection, contact_id, opts \\ [])
Specs
delete_contact(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete contact
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- contact_id (String.t): contactId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_all_contacts(connection, opts \\ [])
Specs
get_all_contacts(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageContactProjection.t()} | {:error, Tesla.Env.t()}
Get all contacts
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure
Link to this function
get_contact(connection, contact_id, opts \\ [])
Specs
get_contact(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.ContactDto.t()} | {:error, Tesla.Env.t()}
Get contact
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- contact_id (String.t): contactId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Link to this function
get_contacts(connection, opts \\ [])
Specs
get_contacts(Tesla.Env.client(), keyword()) :: {:ok, [MailSlurpAPI.Model.ContactProjection.t()]} | {:error, Tesla.Env.t()}
Get all contacts
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
, ...]} on success {:error, info} on failure