Procore.Api.CoreCompanyDirectoryCompanyPeople (procore_sdk v0.1.3)

API calls for all endpoints tagged CoreCompanyDirectoryCompanyPeople.

Summary

Functions

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

List Company People Return a list of People associated with a Company. Includes users in the directory and reference users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

rest_v10_companies_company_id_people_id_patch(connection, procore_company_id, company_id, id, company_person_body, opts \\ [])

Update company person Update the specified Company Person.

rest_v10_companies_company_id_people_post(connection, procore_company_id, company_id, company_person_body, opts \\ [])

Create Company Person Create a new Company Person.

Functions

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

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

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): ID of the company
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[is_employee]" (boolean()): If true, returns item(s) where is_employee value is true.
- :"filters[reference_users_only]" (boolean()): If true, returns only people who are reference users.
- :"filters[include_company_people]" (boolean()): If true, returns people in the Company not just the Project. This option only works if the user has permission to create people in the project directory or permission to read from the company directory.
- :"filters[search]" (String.t): Returns item(s) matching the specified search query string.

Returns

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

rest_v10_companies_company_id_people_id_patch(connection, procore_company_id, company_id, id, company_person_body, opts \\ [])

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

Update company person Update the specified Company Person.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): ID of the company
id (integer()): ID of the person
company_person_body (CompanyPersonBody):
opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_people_post(connection, procore_company_id, company_id, company_person_body, opts \\ [])

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

Create Company Person Create a new Company Person.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): ID of the company
company_person_body (CompanyPersonBody):
opts (keyword): Optional parameters

Returns

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