Procore.Api.ConstructionFinancialsWorkBreakdownStructureSegments (procore_sdk v0.3.0)

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

List Company WBS Segments All Segments for a given 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

Returns

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

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

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

Delete WBS Segment Delete WBS Segment

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
- :segment_item_list_id (integer()): Segment Item List ID

Returns

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

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

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

Show Company WBS Segment Show a company level segment

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
- :segment_item_list_id (integer()): Segment Item List ID

Returns

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

rest_v10_companies_company_id_work_breakdown_structure_segments_id_patch(connection, procore_company_id, company_id, id, rest_v10_companies_company_id_work_breakdown_structure_segments_id_patch_request, opts \\ [])

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

Update Company WBS Segment Update company level WBS Segment

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
rest_v10_companies_company_id_work_breakdown_structure_segments_id_patch_request (RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsIdPatchRequest):
opts (keyword): Optional parameters
- :segment_item_list_id (integer()): Segment Item List ID

Returns

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

rest_v10_companies_company_id_work_breakdown_structure_segments_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_work_breakdown_structure_segments_post_request, opts \\ [])

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

Create a Company WBS Segment Create a new company level WBS Segment

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.
rest_v10_companies_company_id_work_breakdown_structure_segments_post_request (RestV10CompaniesCompanyIdWorkBreakdownStructureSegmentsPostRequest):
opts (keyword): Optional parameters

Returns

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

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

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

List Project WBS Segments All Segments for a given 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

Returns

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

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

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

Show Project WBS Segment Show a project level segment

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()): ID
opts (keyword): Optional parameters
- :legacy_sub_job_id (integer()): Legacy Sub_Job ID

Returns

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