Procore.Api.QualitySafetyIncidentsEnvironmentals (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyIncidentsEnvironmentals.

Summary

Functions

rest_v10_projects_project_id_incidents_environmentals_get(connection, procore_company_id, project_id, opts \\ [])

List Environmentals Returns a list of Environmental records for a given project.

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

Destroy Environmental Sends the specified Environmental record to the Recycle Bin

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

Show Environmental Returns the specified Environmental record

rest_v10_projects_project_id_incidents_environmentals_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_environmentals_id_patch_request, opts \\ [])

Update Environmental Updates the Environmental record

rest_v10_projects_project_id_incidents_environmentals_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_environmentals_post_request, opts \\ [])

Create Environmental Creates an Environmental record.

rest_v10_projects_project_id_recycle_bin_incidents_environmentals_get(connection, procore_company_id, project_id, opts \\ [])

List Recycled Environmentals Returns a list of Recycled Environmentals for a given project (or Incident, if incident_id is present).

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

Show Recycled Environmental Returns specified Recycled Environmental record

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

Retrieve Environmental Retrieves specified Recycled Environmental from the recycle bin

Functions

Link to this function

rest_v10_projects_project_id_incidents_environmentals_get(connection, procore_company_id, project_id, opts \\ [])

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

List Environmentals Returns a list of Environmental records for 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.
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID. When provided, the list will be scoped to only the Environmentals for a given Incident.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[environmental_type_id]" ([integer()]): Return item(s) with the specified Environmental Type ID.
    • :"filters[query]" (String.t): Return item(s) containing search query
    • :sort (String.t):

Returns

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

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

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

Destroy Environmental Sends the specified Environmental record to the Recycle Bin

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()): Environmental ID
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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

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

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

Show Environmental Returns the specified Environmental record

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()): Environmental ID
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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

rest_v10_projects_project_id_incidents_environmentals_id_patch(connection, procore_company_id, project_id, id, rest_v10_projects_project_id_incidents_environmentals_id_patch_request, opts \\ [])

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

Update Environmental Updates the Environmental record

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()): Environmental ID
  • rest_v10_projects_project_id_incidents_environmentals_id_patch_request (RestV10ProjectsProjectIdIncidentsEnvironmentalsIdPatchRequest):
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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

rest_v10_projects_project_id_incidents_environmentals_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_incidents_environmentals_post_request, opts \\ [])

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

Create Environmental Creates an Environmental record.

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.
  • rest_v10_projects_project_id_incidents_environmentals_post_request (RestV10ProjectsProjectIdIncidentsEnvironmentalsPostRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_recycle_bin_incidents_environmentals_get(connection, procore_company_id, project_id, opts \\ [])

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

List Recycled Environmentals Returns a list of Recycled Environmentals for a given project (or Incident, if incident_id is present).

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.
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID. When provided, the list will be scoped to only the Environmentals for a given Incident.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[environmental_type_id]" ([integer()]): Return item(s) with the specified Environmental Type ID.
    • :"filters[query]" (String.t): Return item(s) containing search query
    • :sort (String.t):

Returns

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

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

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

Show Recycled Environmental Returns specified Recycled Environmental record

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()): Environmental ID
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

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

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

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

Retrieve Environmental Retrieves specified Recycled Environmental from the recycle bin

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()): Environmental ID
  • opts (keyword): Optional parameters
    • :incident_id (integer()): Incident ID

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure