Procore.Api.QualitySafetyPunchListPunchItems (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyPunchListPunchItems.

Summary

Functions

Add Attachments to Punch Item Add Attachments to Punch Item #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with attachments[] as files.

List Punch Items Return a list of all Punch Items for a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Show Punch Item Return detailed information about a specific Punch Item in a Project.

Update Punch Item Update a specific Punch Item in a Project. #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with punch_item[images][] as files.

Send Punch Item Email Send an email for a Punch Item in a Project.

Create Punch Item Create a new Punch Item in a Project. #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with punch_item[images][] as files.

List Deleted Punch Items Return an array of Deleted Punch objects for a specified Project

Send All Unsent Punch Item Emails Send all unsent Punch Item emails in a Project.

List Punch Item Default Distribution List Returns a collection of Default Distribution Members for a given Punch Item.

Add Attachments to Punch Item Add Attachments to Punch Item #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with attachments[] as files.

List Punch Items Return a list of all Punch Items for a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Show Punch Item Return detailed information about a specific Punch Item in a Project.

Update Punch Item Update a specific Punch Item in a Project. #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with punch_item[images][] as files.

Send Punch Item Email Send an email for a Punch Item in a Project.

Create Punch Item Create a new Punch Item in a Project. #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with punch_item[images][] as files.

List Deleted Punch Items Return an array of Deleted Punch objects for a specified Project

Send All Unsent Punch Item Emails Send all unsent Punch Item emails in a Project.

Functions

Link to this function

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

Add Attachments to Punch Item Add Attachments to Punch Item #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with attachments[] as files.

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 Punch Item
  • project_id (integer()): ID of the project
  • opts (keyword): Optional parameters
    • :attachments ([String.t]): Punch Item Assignment attachments. To upload attachments you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with attachments[] as files.

Returns

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

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

List Punch Items Return a list of all Punch Items for a specified 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
    • :"filters[status]" (String.t): Return item(s) with the specified Punch Item Status - 'open' or 'closed'.
    • :"filters[priority]" (String.t): Return item(s) with the specified Punch Item Priority - 'low', 'medium', 'high'
    • :"filters[punch_item_type_id]" (integer()): Return item(s) with the specified Punch Item Type ID.
    • :"filters[location_id]" ([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.
    • :"filters[include_sublocations]" (boolean()): Use together with filters[location_id]
    • :"filters[approver_login_information_id]" (integer()): User ID. Returns item(s) where the specified User ID is an approver.
    • :"filters[vendor_id]" (integer()): Return item(s) with the specified Vendor ID.
    • :"filters[assignee_response]" (boolean()): If true, returns item(s) with the specified assignee response approved status.
    • :"filters[trade_id]" (integer()): Trade ID
    • :"filters[id]" ([integer()]): Return item(s) with the specified Punch Item ID.
    • :"filters[query]" (String.t): Return item(s) containing search query
    • :"filters[updated_at]" (Date.t): Return item(s) last updated 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

Returns

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

rest_v10_punch_items_id_comments_post(connection, procore_company_id, id, project_id, punch_item_comment_body, opts \\ [])

Create Punch Item Comment Create a new Punch Item Comment in a 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 Punch Item
  • project_id (integer()): Unique identifier for the project.
  • punch_item_comment_body (PunchItemCommentBody):
  • opts (keyword): Optional parameters

Returns

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

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

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

Delete Punch Item Delete a specific Punch Item.

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 Punch Item
  • 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_punch_items_id_get(connection, procore_company_id, id, project_id, opts \\ [])

Show Punch Item Return detailed information about a specific Punch Item in a 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 Punch Item
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_punch_items_id_patch(connection, procore_company_id, id, punch_item_body6, opts \\ [])

Update Punch Item Update a specific Punch Item in a Project. #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with punch_item[images][] as files.

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 Punch Item
  • punch_item_body6 (PunchItemBody6):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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

rest_v10_punch_items_id_send_email_post(connection, procore_company_id, id, body30, opts \\ [])

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

Send Punch Item Email Send an email for a Punch Item in a 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 Punch Item
  • body30 (Body30):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_punch_items_post(connection, procore_company_id, punch_item_body4, opts \\ [])

Create Punch Item Create a new Punch Item in a Project. #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with punch_item[images][] as files.

Parameters

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

Returns

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

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

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

List Deleted Punch Items Return an array of Deleted Punch objects for 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

Returns

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

rest_v10_punch_items_send_all_unsent_post(connection, procore_company_id, project_id, body29, opts \\ [])

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

Send All Unsent Punch Item Emails Send all unsent Punch Item emails in 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.
  • body29 (Body29):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_punch_items_send_unsent_post(connection, procore_company_id, rest_v11_punch_items_send_unsent_post_request, opts \\ [])

Send unsent Punch Items Sends email notifications for unsent Punch Items.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • rest_v11_punch_items_send_unsent_post_request (RestV11PunchItemsSendUnsentPostRequest):
  • opts (keyword): Optional parameters

Returns

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

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

List Punch Item Default Distribution List Returns a collection of Default Distribution Members for a given Punch Item.

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, [%RestV10ProjectsProjectIdWorkLogsGet200ResponseInnerCreatedBy{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

Add Attachments to Punch Item Add Attachments to Punch Item #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with attachments[] as files.

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 Punch Item
  • project_id (integer()): ID of the project
  • opts (keyword): Optional parameters
    • :attachments ([String.t]): Punch Item Assignment attachments. To upload attachments you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with attachments[] as files.

Returns

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

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

List Punch Items Return a list of all Punch Items for a specified 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
    • :"filters[status]" (String.t): Return item(s) with the specified Punch Item Status - 'open' or 'closed'.
    • :"filters[priority]" (String.t): Return item(s) with the specified Punch Item Priority - 'low', 'medium', 'high'
    • :"filters[punch_item_type_id]" (integer()): Return item(s) with the specified Punch Item Type ID.
    • :"filters[location_id]" ([integer()]): Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.
    • :"filters[include_sublocations]" (boolean()): Use together with filters[location_id]
    • :"filters[approver_login_information_id]" (integer()): User ID. Returns item(s) where the specified User ID is an approver.
    • :"filters[vendor_id]" (integer()): Return item(s) with the specified Vendor ID.
    • :"filters[assignee_response]" (boolean()): If true, returns item(s) with the specified assignee response approved status.
    • :"filters[trade_id]" (integer()): Trade ID
    • :"filters[id]" ([integer()]): Return item(s) with the specified Punch Item ID.
    • :"filters[query]" (String.t): Return item(s) containing search query
    • :"filters[updated_at]" (Date.t): Return item(s) last updated 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

Returns

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

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

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

Delete Punch Item Delete a specific Punch Item.

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 Punch Item
  • 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_v11_punch_items_id_get(connection, procore_company_id, id, project_id, opts \\ [])

Show Punch Item Return detailed information about a specific Punch Item in a 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 Punch Item
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

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

rest_v11_punch_items_id_patch(connection, procore_company_id, id, punch_item_body2, opts \\ [])

Update Punch Item Update a specific Punch Item in a Project. #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with punch_item[images][] as files.

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 Punch Item
  • punch_item_body2 (PunchItemBody2):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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

rest_v11_punch_items_id_send_email_post(connection, procore_company_id, id, body30, opts \\ [])

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

Send Punch Item Email Send an email for a Punch Item in a 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 Punch Item
  • body30 (Body30):
  • opts (keyword): Optional parameters

Returns

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

rest_v11_punch_items_post(connection, procore_company_id, punch_item_body, opts \\ [])

Create Punch Item Create a new Punch Item in a Project. #### Uploading images To upload images you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with punch_item[images][] as files.

Parameters

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

Returns

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

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

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

List Deleted Punch Items Return an array of Deleted Punch objects for 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

Returns

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

rest_v11_punch_items_send_all_unsent_post(connection, procore_company_id, project_id, body29, opts \\ [])

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

Send All Unsent Punch Item Emails Send all unsent Punch Item emails in 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.
  • body29 (Body29):
  • opts (keyword): Optional parameters

Returns

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

rest_v11_punch_items_send_unsent_post(connection, procore_company_id, rest_v11_punch_items_send_unsent_post_request, opts \\ [])

Send unsent Punch Items Sends email notifications for unsent Punch Items.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • rest_v11_punch_items_send_unsent_post_request (RestV11PunchItemsSendUnsentPostRequest):
  • opts (keyword): Optional parameters

Returns

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