Procore.Api.ProjectManagementPhotosImageCategories (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementPhotosImageCategories.

Summary

Functions

rest_v10_image_categories_get(connection, procore_company_id, project_id, opts \\ [])

List image categories Return a list of all Photo Albums (Image Categories) in a specified project.

rest_v10_image_categories_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

Delete image category Delete a Photo Album (Image Category) from a specified Project.

rest_v10_image_categories_id_get(connection, procore_company_id, id, project_id, opts \\ [])

Show image category Return detail information about the specified Photo Album (Image Category).

rest_v10_image_categories_id_patch(connection, procore_company_id, id, project_id, body81, opts \\ [])

Update image category Update a Photo Album (Image Category) in a specified Project.

rest_v10_image_categories_ids_with_images_get(connection, procore_company_id, project_id, opts \\ [])

List Image Category IDs That Contain Images Return an array of Image Category IDs for a specified Project that contain Images See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

rest_v10_image_categories_post(connection, procore_company_id, project_id, body81, opts \\ [])

Create image category Create a new Photo Album (Category) for Images.

Functions

Link to this function

rest_v10_image_categories_get(connection, procore_company_id, project_id, opts \\ [])

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

List image categories Return a list of all Photo Albums (Image Categories) in a specified 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.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_image_categories_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

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

Delete image category Delete a Photo Album (Image Category) from a specified Project.

Parameters

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

Returns

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

rest_v10_image_categories_id_get(connection, procore_company_id, id, project_id, opts \\ [])

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

Show image category Return detail information about the specified Photo Album (Image Category).

Parameters

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

Returns

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

rest_v10_image_categories_id_patch(connection, procore_company_id, id, project_id, body81, opts \\ [])

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

Update image category Update a Photo Album (Image Category) in a specified Project.

Parameters

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

Returns

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

rest_v10_image_categories_ids_with_images_get(connection, procore_company_id, project_id, opts \\ [])

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

List Image Category IDs That Contain Images Return an array of Image Category IDs for a specified Project that contain Images 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[updated_at]" (String.t): Return Image Categories that contain Images that are within a specific updated_at date-time range.

Returns

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

rest_v10_image_categories_post(connection, procore_company_id, project_id, body81, opts \\ [])

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

Create image category Create a new Photo Album (Category) for Images.

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.
  • body81 (Body81):
  • opts (keyword): Optional parameters

Returns

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