Procore.Api.CoreAppInstallationsAppInstallations (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreAppInstallationsAppInstallations.

Summary

Functions

rest_v10_app_installations_get(connection, procore_company_id, company_id, project_id, opts \\ [])

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

rest_v10_app_installations_id_get(connection, procore_company_id, id, company_id, project_id, opts \\ [])

Show app installation Get the details of a single app installation

rest_v10_app_installations_id_patch(connection, procore_company_id, id, rest_v10_app_installations_id_patch_request, opts \\ [])

Update app installation Update the status of an application between installed or uninstalled

rest_v10_app_installations_post(connection, procore_company_id, body150, opts \\ [])

Create app installation Install a new application

Functions

Link to this function

rest_v10_app_installations_get(connection, procore_company_id, company_id, project_id, opts \\ [])

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

List app installations Returns a list of app installations 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. You must supply either a company_id or project_id.
  • project_id (integer()): Unique identifier for the project. You must supply either a company_id or project_id.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_app_installations_id_get(connection, procore_company_id, id, company_id, project_id, opts \\ [])

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

Show app installation Get the details of a single app installation

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): App installation ID
  • company_id (integer()): Unique identifier for the company. You must supply either a company_id or project_id.
  • project_id (integer()): Unique identifier for the project. You must supply either a company_id or project_id.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_app_installations_id_patch(connection, procore_company_id, id, rest_v10_app_installations_id_patch_request, opts \\ [])

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

Update app installation Update the status of an application between installed or uninstalled

Parameters

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

Returns

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

rest_v10_app_installations_post(connection, procore_company_id, body150, opts \\ [])

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

Create app installation Install a new application

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • body150 (Body150):
  • opts (keyword): Optional parameters

Returns

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