Procore.Api.QualitySafetyIncidentsAlertRecipients (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyIncidentsAlertRecipients.

Summary

Functions

rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_get(connection, procore_company_id, company_id, severity_level_id, opts \\ [])

List Incident Alert Recipients Return a list of all Incident Alert Recipients associated with the specified Company and Incident Severity Level.

rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_id_delete(connection, procore_company_id, company_id, severity_level_id, id, opts \\ [])

Delete Incident Alert Recipient Deletes an Incident Alert Recipient.

rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_id_get(connection, procore_company_id, company_id, severity_level_id, id, opts \\ [])

Show Incident Alert Recipient Returns the specified Incident Alert Recipient.

rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_id_patch(connection, procore_company_id, company_id, severity_level_id, id, opts \\ [])

Update existing or create a new Incident Alert Recipient. Finds an exisiting Incident Alert Recipient or creates one with the specified User.

Functions

Link to this function

rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_get(connection, procore_company_id, company_id, severity_level_id, opts \\ [])

@spec rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     [
       Procore.Model.RestV10ProjectsProjectIdWorkLogsGet200ResponseInnerCreatedBy.t()
     ]}
  | {:error, Tesla.Env.t()}

List Incident Alert Recipients Return a list of all Incident Alert Recipients associated with the specified Company and Incident Severity Level.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • severity_level_id (integer()): Incident Severity Level ID
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :sort (String.t):

Returns

  • {:ok, [%RestV10ProjectsProjectIdWorkLogsGet200ResponseInnerCreatedBy{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_id_delete(connection, procore_company_id, company_id, severity_level_id, id, opts \\ [])

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

Delete Incident Alert Recipient Deletes an Incident Alert Recipient.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • severity_level_id (integer()): Incident Severity Level ID
  • id (integer()): Incident Alert Recipient's User ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_id_get(connection, procore_company_id, company_id, severity_level_id, id, opts \\ [])

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

Show Incident Alert Recipient Returns the specified Incident Alert Recipient.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • severity_level_id (integer()): Incident Severity Level ID
  • id (integer()): Incident Alert Recipient's User ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_incidents_severity_levels_severity_level_id_alert_recipients_id_patch(connection, procore_company_id, company_id, severity_level_id, id, opts \\ [])

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

Update existing or create a new Incident Alert Recipient. Finds an exisiting Incident Alert Recipient or creates one with the specified User.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • severity_level_id (integer()): Incident Severity Level ID
  • id (integer()): Incident Alert Recipient's User ID
  • opts (keyword): Optional parameters

Returns

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