Procore.Api.CoreCompanyDirectoryCompanyVendorInsurances (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyDirectoryCompanyVendorInsurances.

Summary

Functions

rest_v10_companies_company_id_vendors_vendor_id_insurances_get(connection, procore_company_id, company_id, vendor_id, opts \\ [])

List company vendor insurances Return a list of Insurances from the specified Company Vendor.

rest_v10_companies_company_id_vendors_vendor_id_insurances_id_delete(connection, procore_company_id, company_id, vendor_id, id, opts \\ [])

Delete company vendor insurance Delete the specified Company Vendor Insurance.

rest_v10_companies_company_id_vendors_vendor_id_insurances_id_get(connection, procore_company_id, company_id, vendor_id, id, opts \\ [])

Show company vendor insurance Show detail on the specified Company Vendor Insurance.

rest_v10_companies_company_id_vendors_vendor_id_insurances_id_patch(connection, procore_company_id, company_id, vendor_id, id, body34, opts \\ [])

Update company vendor insurance Update the specified Company Vendor Insurance.

rest_v10_companies_company_id_vendors_vendor_id_insurances_post(connection, procore_company_id, company_id, vendor_id, body34, opts \\ [])

Create company vendor insurance Create a new Insurance associated with the specified Company Vendor.

rest_v10_companies_company_id_vendors_vendor_id_insurances_sync_patch(connection, procore_company_id, company_id, vendor_id, insurance_sync_body, opts \\ [])

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

Functions

Link to this function

rest_v10_companies_company_id_vendors_vendor_id_insurances_get(connection, procore_company_id, company_id, vendor_id, opts \\ [])

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

List company vendor insurances Return a list of Insurances from the specified Company Vendor.

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

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

Delete company vendor insurance Delete the specified Company Vendor 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.
  • vendor_id (integer()): Vendor ID
  • 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_vendors_vendor_id_insurances_id_get(connection, procore_company_id, company_id, vendor_id, id, opts \\ [])

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

Show company vendor insurance Show detail on the specified Company Vendor 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.
  • vendor_id (integer()): Vendor ID
  • 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_vendors_vendor_id_insurances_id_patch(connection, procore_company_id, company_id, vendor_id, id, body34, opts \\ [])

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

Update company vendor insurance Update the specified Company Vendor 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.
  • vendor_id (integer()): Vendor ID
  • id (integer()): ID
  • body34 (Body34):
  • 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_vendors_vendor_id_insurances_post(connection, procore_company_id, company_id, vendor_id, body34, opts \\ [])

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

Create company vendor insurance Create a new Insurance associated with the specified Company Vendor.

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.
  • vendor_id (integer()): Vendor ID
  • body34 (Body34):
  • 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_vendors_vendor_id_insurances_sync_patch(connection, procore_company_id, company_id, vendor_id, insurance_sync_body, opts \\ [])

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

Sync Company Vendor Insurances This endpoint creates or updates a batch of Company Vendor 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.
  • vendor_id (integer()): Vendor ID
  • insurance_sync_body (InsuranceSyncBody):
  • opts (keyword): Optional parameters

Returns

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