Procore.Api.ProjectManagementBiddingProjectBidPackages (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementBiddingProjectBidPackages.

Summary

Functions

rest_v10_projects_project_id_bid_packages_bid_package_id_correspondences_get(connection, procore_company_id, project_id, bid_package_id, opts \\ [])

List Correspondences Return a list of all Correspondences for a Bid Package.

rest_v10_projects_project_id_bid_packages_bid_package_id_correspondences_id_get(connection, procore_company_id, project_id, bid_package_id, id, opts \\ [])

Show Correspondence Return Correspondence detailed information.

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

Show Bid Package Return Bid Package detailed information.

rest_v10_projects_project_id_bid_packages_id_patch(connection, procore_company_id, project_id, id, body43, opts \\ [])

Update Bid Package Update a Bid Package.

rest_v10_projects_project_id_bid_packages_post(connection, procore_company_id, project_id, body43, opts \\ [])

Create Bid Package Create a Bid Package.

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

List Bid Packages Return a list of all Bid Packages for a Project.

Functions

rest_v10_projects_project_id_bid_packages_bid_package_id_correspondences_get(connection, procore_company_id, project_id, bid_package_id, opts \\ [])

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

List Correspondences Return a list of all Correspondences for a Bid Package.

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.
bid_package_id (integer()): Bid Package ID
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Elements per page

Returns

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

rest_v10_projects_project_id_bid_packages_bid_package_id_correspondences_id_get(connection, procore_company_id, project_id, bid_package_id, id, opts \\ [])

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

Show Correspondence Return Correspondence detailed information.

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.
bid_package_id (integer()): Bid Package ID
id (integer()): Correspondence ID
opts (keyword): Optional parameters

Returns

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

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

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

Show Bid Package Return Bid Package detailed information.

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

Returns

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

rest_v10_projects_project_id_bid_packages_id_patch(connection, procore_company_id, project_id, id, body43, opts \\ [])

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

Update Bid Package Update a Bid Package.

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
body43 (Body43):
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_bid_packages_post(connection, procore_company_id, project_id, body43, opts \\ [])

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

Create Bid Package Create a Bid Package.

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

Returns

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

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

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

List Bid Packages Return a list of all Bid Packages for a 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
- :view (String.t): When set to all, both open and closed bid packages will be returned. When set to internal, more keys will be made available for each bid package. When set to use_previous_bidders, a key will be made available that will provide information on whether the bid package has bid forms
- :filter (String.t): Filters down list of bid packages for a project.
- :with_flags ([String.t]): Filter bid packages by available features (e.g., flexible_response_types_enabled, bid_form_sections_enabled). For accurate results in the CPBP feature, both flags should be passed, not just one.
- :sort (String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter. Only applies when view=internal.

Returns

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