Procore.Api.QualitySafetyInspectionsChecklistSchedules (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyInspectionsChecklistSchedules.

Summary

Functions

rest_v10_projects_project_id_checklist_schedules_calculate_first_inspection_created_at_get(connection, procore_company_id, project_id, rest_v10_projects_project_id_checklist_schedules_calculate_first_inspection_created_at_get_request, opts \\ [])

Calculate when the first Inspection of an Inspection Schedule will be created Calculates the creation date for the first Inspection to be created based on an Inspection Schedule's temporal attributes.

rest_v10_projects_project_id_checklist_schedules_calculate_total_inspections_count_get(connection, procore_company_id, project_id, rest_v10_projects_project_id_checklist_schedules_calculate_total_inspections_count_get_request, opts \\ [])

Calculate number of Inspections to create based on Schedule Calculates the total number of Inspections to create based on Schedule parameters.

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

List Checklist (Inspection) Schedules Returns the Checklist Schedules from Checklists (Inspections) on the Project

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

Delete Checklist Schedule Delete a Checklist Schedule in a specified Project.

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

Show Checklist Schedule Retrieves Checklist Schedule in a specified Project.

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

Update a Checklist (Inspection) Schedule Updates a Checklist (Inspection) Schedule in a specified Project

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

Create a Checklist (Inspection) Schedule Creates a Checklist Schedule from a Checklist (Inspection) Template on the Project

Functions

rest_v10_projects_project_id_checklist_schedules_calculate_first_inspection_created_at_get(connection, procore_company_id, project_id, rest_v10_projects_project_id_checklist_schedules_calculate_first_inspection_created_at_get_request, opts \\ [])

@spec rest_v10_projects_project_id_checklist_schedules_calculate_first_inspection_created_at_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10ProjectsProjectIdChecklistSchedulesCalculateFirstInspectionCreatedAtGetRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdChecklistSchedulesCalculateFirstInspectionCreatedAtGet200Response.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.
project_id (integer()): Unique identifier for the project.
rest_v10_projects_project_id_checklist_schedules_calculate_first_inspection_created_at_get_request (RestV10ProjectsProjectIdChecklistSchedulesCalculateFirstInspectionCreatedAtGetRequest):
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_checklist_schedules_calculate_total_inspections_count_get(connection, procore_company_id, project_id, rest_v10_projects_project_id_checklist_schedules_calculate_total_inspections_count_get_request, opts \\ [])

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

Calculate number of Inspections to create based on Schedule Calculates the total number of Inspections to create based on Schedule parameters.

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.
rest_v10_projects_project_id_checklist_schedules_calculate_total_inspections_count_get_request (RestV10ProjectsProjectIdChecklistSchedulesCalculateTotalInspectionsCountGetRequest):
opts (keyword): Optional parameters

Returns

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

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

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

List Checklist (Inspection) Schedules Returns the Checklist Schedules from Checklists (Inspections) on the 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
- :"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
- :"filters[inspection_type_id]" ([integer()]): Return schedule(s) with the specified Checklist Type IDs
- :"filters[frequency]" ([String.t]): Return schedule(s) with the specified Frequency Types
- :"filters[location_id]" ([integer()]): Return schedule(s) with the specified Location IDs
- :"filters[list_template_id]" ([integer()]): Return schedule(s) with the specified Inspection Template IDs
- :"filters[assignee_id]" ([integer()]): Return schedule(s) with the specified Assignee IDs
- :"filters[first_inspection_due_at]" ([Date.t]): Return schedule(s) with the specified First Inspection Due Date
- :"filters[ends_at]" ([Date.t]): Return schedule(s) with the specified Last Inspection Due Date.
- :"filters[ended]" (boolean()): Return schedule(s) that are finished when true, returns unfinished schedule(s) otherwise
- :"filters[equipment_id]" ([String.t]): Return schedule(s) with the specified Equipment IDs
- :sort (String.t): Sort schedule(s) by the chosen param; check below for a list of options. The direction of sorting is ascending by default; for descending sort, insert the - symbol before the param.
- :page (integer()): Page
- :per_page (integer()): Elements per page

Returns

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

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

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

Delete Checklist Schedule Delete a Checklist Schedule 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.
id (integer()): Checklist Schedule ID
opts (keyword): Optional parameters

Returns

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

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

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

Show Checklist Schedule Retrieves Checklist Schedule 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.
id (integer()): Checklist Schedule ID
opts (keyword): Optional parameters

Returns

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

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

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

Update a Checklist (Inspection) Schedule Updates a Checklist (Inspection) Schedule 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.
id (integer()): Checklist Schedule ID
opts (keyword): Optional parameters
- :body (ChecklistScheduleBody1):

Returns

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

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

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

Create a Checklist (Inspection) Schedule Creates a Checklist Schedule from a Checklist (Inspection) Template on the 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
- :body (ChecklistScheduleBody):

Returns

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