Procore.Api.CoreCompanyDirectoryCompanyPermissionTemplates (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCompanyDirectoryCompanyPermissionTemplates.

Summary

Functions

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

List permission templates Returns the Permission Template names and IDs for the specified Company.

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

Returns specific template Returns the Permission Template along with its permitted actions.

rest_v10_companies_company_id_permission_templates_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_permission_templates_post_request, opts \\ [])

Create Permission Template Returns the created Permission Template along with its permitted actions.

Functions

Link to this function

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

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

List permission templates Returns the Permission Template names and IDs for the specified Company.

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
    • :"filters[type]" (String.t): Allows filtering by template type. If none is provided, default is "project_tools". Allowed types = company_tools, project_tools, global. Example - ?filters[type]=company_tools
    • :view (String.t): Returns detailed permission templates if view=with_permissions is specified.

Returns

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

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

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

Returns specific template Returns the Permission Template along with its permitted actions.

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()): The ID of the permission template to be retrieved
  • opts (keyword): Optional parameters

Returns

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

rest_v10_companies_company_id_permission_templates_post(connection, procore_company_id, company_id, rest_v10_companies_company_id_permission_templates_post_request, opts \\ [])

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

Create Permission Template Returns the created Permission Template along with its permitted actions.

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_permission_templates_post_request (RestV10CompaniesCompanyIdPermissionTemplatesPostRequest):
  • opts (keyword): Optional parameters

Returns

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