Procore.Api.CoreAppInstallationsAppConfigurations (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreAppInstallationsAppConfigurations.

Summary

Functions

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

List app configurations Returns a list of app configurations on a given company or project

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

Delete app configuration Deletes an app configuration

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

Show app configuration Get the details of a single app configuration

rest_v10_companies_company_id_app_configurations_id_patch(connection, procore_company_id, id, company_id, rest_v10_companies_company_id_app_configurations_id_patch_request, opts \\ [])

Update app configuration Change the configuration of an existing app configuration

rest_v10_companies_company_id_app_configurations_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_app_configurations_post_request, opts \\ [])

Create app configuration Create new app configuration for a specified project

Functions

Link to this function

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

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

List app configurations Returns a list of app configurations on a given company or project

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
    • :sort (String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[app_installation_id]" (integer()): App installation ID
    • :"filters[project_id]" (integer()): Project ID

Returns

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

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

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

Delete app configuration Deletes an app configuration

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): App Configuration ID
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters

Returns

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

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

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

Show app configuration Get the details of a single app configuration

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): App Configuration ID
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_app_configurations_id_patch(connection, procore_company_id, id, company_id, rest_v10_companies_company_id_app_configurations_id_patch_request, opts \\ [])

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

Update app configuration Change the configuration of an existing app configuration

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): App Configuration ID
  • company_id (integer()): Unique identifier for the company.
  • rest_v10_companies_company_id_app_configurations_id_patch_request (RestV10CompaniesCompanyIdAppConfigurationsIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_app_configurations_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_app_configurations_post_request, opts \\ [])

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

Create app configuration Create new app configuration for a specified project

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_app_configurations_post_request (RestV10CompaniesCompanyIdAppConfigurationsPostRequest):
  • opts (keyword): Optional parameters
    • :sort (String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter.

Returns

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