Procore.Api.ProjectManagementInstructionsInstructionTypes (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementInstructionsInstructionTypes.

Summary

Functions

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

List Instruction Types on a project Return a list of all Instruction Types from a specified Project.

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

Delete Instruction Type Delete the specified Instruction Type.

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

Show Instruction Type Return detailed information on the specified Instruction Type.

rest_v10_projects_project_id_instruction_types_id_patch(connection, procore_company_id, project_id, id, body77, opts \\ [])

Update Instruction Type Update the specified Instruction Type.

rest_v10_projects_project_id_instruction_types_post(connection, procore_company_id, project_id, body77, opts \\ [])

Create Instruction Types Create a new Instruction Type associated with the specified Project.

Functions

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

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

List Instruction Types on a project Return a list of all Instruction Types from a specified 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
- :page (integer()): Page
- :per_page (integer()): Elements per page

Returns

{:ok, [%RestV10ProjectsProjectIdInstructionsGet200ResponseInnerInstructionType{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

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

Delete Instruction Type Delete the specified Instruction Type.

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()): Instruction ID
opts (keyword): Optional parameters

Returns

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

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

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

Show Instruction Type Return detailed information on the specified Instruction Type.

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()): Instruction ID
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_instruction_types_id_patch(connection, procore_company_id, project_id, id, body77, opts \\ [])

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

Update Instruction Type Update the specified Instruction Type.

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()): Instruction ID
body77 (Body77):
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_instruction_types_post(connection, procore_company_id, project_id, body77, opts \\ [])

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

Create Instruction Types Create a new Instruction Type associated with the specified 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.
body77 (Body77):
opts (keyword): Optional parameters

Returns

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