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

List Project Users Returns a list of active users associated with a project. 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.
• project_id (integer()): Unique identifier for the project.
• opts (keyword): Optional parameters
  • :page (integer()): Page
  • :per_page (integer()): Elements per page
  • :view (String.t): Specifies which view of the resource to return (which attributes should be present in the response). Users without read permissions to Directory are limited to the compact view. Otherwise, the default view is normal.
  • :"filters[created_at]" (Date.t): Return item(s) created 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[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[permission_template]"(integer()): Permission Template ID. Returns item(s) assiociated with the specified Permission Template ID. -:"filters[vendor_id]"([integer()]): Return item(s) with the specified Vendor IDs. -:"filters[origin_id]"(String.t): Origin ID. Returns item(s) with the specified Origin ID. -:"filters[trade_id][]"([integer()]): Returns users whose vendor record is associated with the specified trade id(s). -:"filters[search]"(String.t): Returns users where the search string matches the user's first name, last name, email address, keywords, job title, or company name -:"filters[employee]"(boolean()): Returns users whose is_employee attribute matches the parameter. -:"filters[id]"(integer()): Returns users whose id attribute matches the parameter. -:sort(String.t): Returns items with the specified sort. ### Returns -, ...]}on success -` on failure

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

Add company user to project Adds a user from the Company Directory to the Project Directory. #### Created Response For null values, the key won't be returned

Parameters

• connection (Procore.Connection): Connection to server
• procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
• project_id (integer()): Unique identifier for the project.
• id (integer()): ID of the user
• opts (keyword): Optional parameters
  • :body (RestV10ProjectsProjectIdUsersIdActionsAddPostRequest):

Returns

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

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

Remove a user from the project Removes a specified user from a project.

Parameters

• connection (Procore.Connection): Connection to server
• procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
• project_id (integer()): Unique identifier for the project.
• id (integer()): ID of the user
• opts (keyword): Optional parameters

Returns

• {:ok, nil} on success
• {:error, Tesla.Env.t} on failure

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

Show project user Show detail on a specified Project User. #### OK Response For null values, the key won't be returned

Parameters

• connection (Procore.Connection): Connection to server
• procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
• project_id (integer()): Unique identifier for the project.
• id (integer()): ID of the user
• opts (keyword): Optional parameters

Returns

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

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

Update project user Updates the specified project user. The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information. For OK responses with null values, the key will not be returned. Note: The is_active parameter value requires a boolean value to be passed in. Setting this parameter to false deactivates the user. If you have deactivated a user by setting is_active to false and then try to reactivate the user by setting is_active to true, you will receive an error message. To reactivate the user via API, you need to call the Sync Company Users method.

Parameters

• connection (Procore.Connection): Connection to server
• procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
• project_id (integer()): Unique identifier for the project.
• id (integer()): ID of the user
• project_user_body1 (ProjectUserBody1):
• opts (keyword): Optional parameters
  • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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

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

Generates PDF Document Generate PDF Document from a project. The endpoint returns url to PDF file. 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.
• project_id (integer()): Unique identifier for the project.
• opts (keyword): Optional parameters
  • :"filters[permission_template]" (integer()): Permission Template ID. Returns item(s) assiociated with the specified Permission Template ID.
  • :"filters[vendor_id]" ([integer()]): Return item(s) with the specified Vendor IDs.
  • :"filters[id]" (integer()): Returns users whose id attribute matches the parameter.
  • :"filters[trade_id][]" ([integer()]): Returns users whose vendor record is associated with the specified trade id(s).
  • :contact (boolean()): Indicates whether contacts should be included in PDF document.
  • :vendor (boolean()): Indicates whether vendor should be included in PDF document.
  • :user_role (boolean()): Indicates whether user_role should be included in PDF document.
  • :grouped_by_vendor (boolean()): Indicates whether users should be grouped by vendor.

Returns

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

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

Create project user Creates a new user in the specified project. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information. #### Created Response For null values, the key won't be returned

Parameters

• connection (Procore.Connection): Connection to server
• procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
• project_id (integer()): Unique identifier for the project.
• project_user_body (ProjectUserBody):
• opts (keyword): Optional parameters
  • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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