Procore.Api.CoreCompanyDirectoryCompanyInsurances (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyDirectoryCompanyInsurances.

Summary

Functions

rest_v10_companies_company_id_insurances_get(connection, procore_company_id, company_id, opts \\ [])

List Company Insurances Return a list of all Insurances associated with the specified Company.

rest_v10_companies_company_id_insurances_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

Delete Company Insurance Delete the specified Insurance.

rest_v10_companies_company_id_insurances_id_get(connection, procore_company_id, company_id, id, opts \\ [])

Show Company Insurance Return detailed information on the specified Insurance.

rest_v10_companies_company_id_insurances_id_patch(connection, procore_company_id, company_id, id, body40, opts \\ [])

Update Company Insurance Update the specified Insurance.

rest_v10_companies_company_id_insurances_post(connection, procore_company_id, company_id, body40, opts \\ [])

Create Company Insurance Create a new Insurance associated with the specified Company.

rest_v10_companies_company_id_insurances_sync_patch(connection, procore_company_id, company_id, insurance_sync_body1, opts \\ [])

Sync Company Insurances This endpoint creates or updates a batch of Company Insurances.

rest_v10_insurances_sync_patch(connection, procore_company_id, insurance_sync_body2, opts \\ [])

Sync Company Insurances (Alternative) This endpoint creates or updates a batch of Company Insurances. Must provide Company ID in the request body.

Functions

Link to this function

rest_v10_companies_company_id_insurances_get(connection, procore_company_id, company_id, opts \\ [])

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

List Company Insurances Return a list of all Insurances associated with the specified Company.

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.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_companies_company_id_insurances_id_delete(connection, procore_company_id, company_id, id, opts \\ [])

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

Delete Company Insurance Delete the specified Insurance.

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.
  • id (integer()): 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_insurances_id_get(connection, procore_company_id, company_id, id, opts \\ [])

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

Show Company Insurance Return detailed information on the specified Insurance.

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.
  • id (integer()): ID
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_insurances_id_patch(connection, procore_company_id, company_id, id, body40, opts \\ [])

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

Update Company Insurance Update the specified Insurance.

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.
  • id (integer()): ID
  • body40 (Body40):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_insurances_post(connection, procore_company_id, company_id, body40, opts \\ [])

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

Create Company Insurance Create a new Insurance associated with the specified Company.

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

Returns

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

rest_v10_companies_company_id_insurances_sync_patch(connection, procore_company_id, company_id, insurance_sync_body1, opts \\ [])

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

Sync Company Insurances This endpoint creates or updates a batch of Company Insurances.

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

Returns

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

rest_v10_insurances_sync_patch(connection, procore_company_id, insurance_sync_body2, opts \\ [])

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

Sync Company Insurances (Alternative) This endpoint creates or updates a batch of Company Insurances. Must provide Company ID in the request body.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • insurance_sync_body2 (InsuranceSyncBody2):
  • opts (keyword): Optional parameters

Returns

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