Procore.Api.CoreCompanyDirectoryCompanyInactiveUsers (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyDirectoryCompanyInactiveUsers.

Summary

Functions

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

List company inactive users Return a list of all Inactive Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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

Reactivate company user Reactivate the specified User.

Functions

Link to this function

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

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

List company inactive users Return a list of all Inactive Users associated with a Company. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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
    • :sort (String.t): Return items with the specified sort.

Returns

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

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

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

Reactivate company user Reactivate the specified User.

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 of the user
  • opts (keyword): Optional parameters

Returns

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