Procore.Api.ProjectManagementEmailEmailCommunications (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementEmailEmailCommunications.

Summary

Functions

rest_v10_project_project_id_email_communications_communication_id_emails_email_id_download_attachments_get(connection, procore_company_id, project_id, communication_id, email_id, opts \\ [])

Download all email attachments Return URL to download all email attachments in .zip format

rest_v10_project_project_id_email_communications_communication_id_emails_post(connection, procore_company_id, project_id, communication_id, topic_type, topic_id, rest_v10_project_project_id_email_communications_communication_id_emails_post_request, opts \\ [])

Create Email Creates a email on a given communication

rest_v10_project_project_id_email_communications_communication_id_export_get(connection, procore_company_id, project_id, communication_id, topic_type, opts \\ [])

Export Email Communication to PDF Creates a email communication on a given project

rest_v10_project_project_id_email_communications_emails_get(connection, procore_company_id, project_id, topic_type, topic_id, opts \\ [])

List of Emails Return a list of emails.

rest_v10_project_project_id_email_communications_id_get(connection, procore_company_id, project_id, id, opts \\ [])

Show Email Communication Shows detailed information around a single email communication

rest_v10_project_project_id_email_communications_id_patch(connection, procore_company_id, project_id, id, rest_v10_project_project_id_email_communications_id_patch_request, opts \\ [])

Update a private field in Email Communication Update a private field in email communication on the specified project.

rest_v10_project_project_id_email_communications_post(connection, procore_company_id, project_id, topic_type, topic_id, rest_v10_project_project_id_email_communications_post_request, opts \\ [])

Create Email Communication Creates a email communication on a given project

Functions

Link to this function

rest_v10_project_project_id_email_communications_communication_id_emails_email_id_download_attachments_get(connection, procore_company_id, project_id, communication_id, email_id, opts \\ [])

@spec rest_v10_project_project_id_email_communications_communication_id_emails_email_id_download_attachments_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectProjectIdEmailCommunicationsCommunicationIdEmailsEmailIdDownloadAttachmentsGet200Response.t()}
  | {:error, Tesla.Env.t()}

Download all email attachments Return URL to download all email attachments in .zip format

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • communication_id (integer()): Communication ID
  • email_id (integer()): Email ID
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectProjectIdEmailCommunicationsCommunicationIdEmailsEmailIdDownloadAttachmentsGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_project_project_id_email_communications_communication_id_emails_post(connection, procore_company_id, project_id, communication_id, topic_type, topic_id, rest_v10_project_project_id_email_communications_communication_id_emails_post_request, opts \\ [])

@spec rest_v10_project_project_id_email_communications_communication_id_emails_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  String.t(),
  integer(),
  Procore.Model.RestV10ProjectProjectIdEmailCommunicationsCommunicationIdEmailsPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdGet200Response.t()}
  | {:error, Tesla.Env.t()}

Create Email Creates a email on a given communication

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • communication_id (integer()): Communication ID
  • topic_type (String.t): The type of the topic to be associated with the communication
  • topic_id (integer()): Topic ID
  • rest_v10_project_project_id_email_communications_communication_id_emails_post_request (RestV10ProjectProjectIdEmailCommunicationsCommunicationIdEmailsPostRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_project_project_id_email_communications_communication_id_export_get(connection, procore_company_id, project_id, communication_id, topic_type, opts \\ [])

@spec rest_v10_project_project_id_email_communications_communication_id_export_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectProjectIdEmailCommunicationsCommunicationIdExportGet200Response.t()}
  | {:error, Tesla.Env.t()}

Export Email Communication to PDF Creates a email communication on a given project

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • communication_id (integer()): Communication ID
  • topic_type (String.t): The type of the topic to be associated with the communication
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectProjectIdEmailCommunicationsCommunicationIdExportGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_project_project_id_email_communications_emails_get(connection, procore_company_id, project_id, topic_type, topic_id, opts \\ [])

@spec rest_v10_project_project_id_email_communications_emails_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  String.t(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectProjectIdEmailCommunicationsEmailsGet200Response.t()}
  | {:error, Tesla.Env.t()}

List of Emails Return a list of emails.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • topic_type (String.t): The type of the topic to be associated with the communication
  • topic_id (integer()): Topic ID
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

  • {:ok, Procore.Model.RestV10ProjectProjectIdEmailCommunicationsEmailsGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_project_project_id_email_communications_id_get(connection, procore_company_id, project_id, id, opts \\ [])

@spec rest_v10_project_project_id_email_communications_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdGet200Response.t()}
  | {:error, Tesla.Env.t()}

Show Email Communication Shows detailed information around a single email communication

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • id (integer()): Communication ID
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_project_project_id_email_communications_id_patch(connection, procore_company_id, project_id, id, rest_v10_project_project_id_email_communications_id_patch_request, opts \\ [])

@spec rest_v10_project_project_id_email_communications_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdPatchRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdGet200Response.t()}
  | {:error, Tesla.Env.t()}

Update a private field in Email Communication Update a private field in email communication on the specified project.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • id (integer()): Communication ID
  • rest_v10_project_project_id_email_communications_id_patch_request (RestV10ProjectProjectIdEmailCommunicationsIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_project_project_id_email_communications_post(connection, procore_company_id, project_id, topic_type, topic_id, rest_v10_project_project_id_email_communications_post_request, opts \\ [])

@spec rest_v10_project_project_id_email_communications_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  String.t(),
  integer(),
  Procore.Model.RestV10ProjectProjectIdEmailCommunicationsPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdGet200Response.t()}
  | {:error, Tesla.Env.t()}

Create Email Communication Creates a email communication on a given project

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • topic_type (String.t): The type of the topic to be associated with the communication
  • topic_id (integer()): Topic ID
  • rest_v10_project_project_id_email_communications_post_request (RestV10ProjectProjectIdEmailCommunicationsPostRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectProjectIdEmailCommunicationsIdGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure