DocuSign v0.2.4 DocuSign.Api.Contacts View Source
API calls for all endpoints tagged `Contacts`.
Link to this section Summary
Functions
Replaces a particular contact associated with an account for the DocuSign service.
Delete contacts associated with an account for the DocuSign service.
Gets a particular contact associated with the user's account.
Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
Replaces contacts associated with an account for the DocuSign service.
Link to this section Functions
contacts_delete_contact_with_id(connection, account_id, contact_id, opts \\ [])
View Sourcecontacts_delete_contact_with_id( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Tesla.Env.t()}
Replaces a particular contact associated with an account for the DocuSign service.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- contact_id (String.t): The unique identifier of a person in the contacts address book.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %DocuSign.Model.ContactUpdateResponse{}} on success {:error, info} on failure
contacts_delete_contacts(connection, account_id, opts \\ [])
View Sourcecontacts_delete_contacts(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Tesla.Env.t()}
Delete contacts associated with an account for the DocuSign service.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
opts (KeywordList): [optional] Optional parameters
- :contact_mod_request (ContactModRequest):
Returns
{:ok, %DocuSign.Model.ContactUpdateResponse{}} on success {:error, info} on failure
contacts_get_contact_by_id(connection, account_id, contact_id, opts \\ [])
View Sourcecontacts_get_contact_by_id( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ContactGetResponse.t()} | {:error, Tesla.Env.t()}
Gets a particular contact associated with the user's account.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- contact_id (String.t): The unique identifier of a person in the contacts address book.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %DocuSign.Model.ContactGetResponse{}} on success {:error, info} on failure
contacts_post_contacts(connection, account_id, opts \\ [])
View Sourcecontacts_post_contacts(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Tesla.Env.t()}
Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
opts (KeywordList): [optional] Optional parameters
- :contact_mod_request (ContactModRequest):
Returns
{:ok, %DocuSign.Model.ContactUpdateResponse{}} on success {:error, info} on failure
contacts_put_contacts(connection, account_id, opts \\ [])
View Sourcecontacts_put_contacts(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ContactUpdateResponse.t()} | {:error, Tesla.Env.t()}
Replaces contacts associated with an account for the DocuSign service.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
opts (KeywordList): [optional] Optional parameters
- :contact_mod_request (ContactModRequest):
Returns
{:ok, %DocuSign.Model.ContactUpdateResponse{}} on success {:error, info} on failure