Procore.Api.CoreCompanyProjectStages (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyProjectStages.

Summary

Functions

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

List Project Stages Return a list of Project Stages.

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

Delete project stage Delete the specified Project Stage.

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

Show project stage Show detail on a specified Project Stage.

rest_v10_companies_company_id_project_stages_id_patch(connection, procore_company_id, company_id, id, body36, opts \\ [])

Update project stage Update the specified Project Stage.

rest_v10_companies_company_id_project_stages_post(connection, procore_company_id, company_id, body36, opts \\ [])

Create project stage Create a new Project Stage in the specified Company.

Functions

Link to this function

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

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

List Project Stages Return a list of Project Stages.

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
    • :project_id (integer()): Project ID is required if retrieving a list of project stages for RFI users

Returns

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

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

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

Delete project stage Delete the specified Project Stage.

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 of the project stage
  • opts (keyword): Optional parameters

Returns

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

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

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

Show project stage Show detail on a specified Project Stage.

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 of the project stage
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_project_stages_id_patch(connection, procore_company_id, company_id, id, body36, opts \\ [])

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

Update project stage Update the specified Project Stage.

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 of the project stage
  • body36 (Body36):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_project_stages_post(connection, procore_company_id, company_id, body36, opts \\ [])

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

Create project stage Create a new Project Stage in 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.
  • body36 (Body36):
  • opts (keyword): Optional parameters

Returns

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