Procore.Api.CoreCompanySupportPins (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanySupportPins.

Summary

Functions

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

Fetch active support pin Fetches active support pin for given company.

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

Create support pin Creates a support pin for the given company.

Functions

Link to this function

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

@spec rest_v20_companies_company_id_support_pins_get(
  Tesla.Env.client(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok, Procore.Model.RestV20CompaniesCompanyIdSupportPinsGet200Response.t()}
  | {:ok,
     Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Fetch active support pin Fetches active support pin for given company.

Parameters

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

Returns

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

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

@spec rest_v20_companies_company_id_support_pins_post(
  Tesla.Env.client(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok, Procore.Model.RestV20CompaniesCompanyIdSupportPinsPost201Response.t()}
  | {:ok,
     Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()}
  | {:error, Tesla.Env.t()}

Create support pin Creates a support pin for the given company.

Parameters

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

Returns

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