Procore.Api.CoreCompanyTrades (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyTrades.

Summary

Functions

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

List trades Return a list of all Trades associated with a Company.

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

Show Trade Returns the details for a specified Trade.

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

Create Trade Creates a Trade associated to a Company.

Functions

Link to this function

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

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

List trades Return a list of all Trades associated with a 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
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[updated_at]" (Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00 - Datetime with Custom Offset
    • :"filters[active]" (boolean()): Limit results to available trades
    • :"filters[query]" (String.t): Query trades by name

Returns

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

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

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

Show Trade Returns the details for a specified Trade.

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

Returns

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

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

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

Create Trade Creates a Trade associated to a 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
    • :body (Body9):

Returns

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