Procore.Api.ProjectManagementProjectScheduleCalendarItems (procore_sdk v0.3.0)

API calls for all endpoints tagged ProjectManagementProjectScheduleCalendarItems.

Summary

Functions

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

List Calendar Items Returns all Calendar Items for a given project.

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

Delete Calendar Item Delete a single Calendar Item

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

Show Calendar Item Get the details of a single Calendar Item

rest_v10_projects_project_id_schedule_calendar_items_id_patch(connection, procore_company_id, project_id, id, body116, opts \\ [])

Update Calendar Item Update attributes on a single Calendar Item

rest_v10_projects_project_id_schedule_calendar_items_post(connection, procore_company_id, project_id, body116, opts \\ [])

Create Calendar Item Create a new Calendar Item

rest_v10_projects_project_id_schedule_calendar_items_sync_patch(connection, procore_company_id, project_id, body117, opts \\ [])

Sync Calendar Items Create or update a batch of Calendar Items

Functions

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

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

List Calendar Items Returns all Calendar Items for a given 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
- :view (String.t): The view to use when serializing Calendar Item data. The ids_only view returns an array of Calendar Item IDs. The total_count_only view returns total count of Calendar Items.
- :start_date (Date.t): Calendar Items that occur after this date
- :finish_date (Date.t): Calendar Items that occur before this date
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"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
- :"filters[assigned_id]" ([integer()]): Returns task(s) with specified assignee(s)
- :"filters[date]" (String.t): Returns task(s) existing on the specified ISO 8601 datetime
- :sort (String.t): Return item(s) with the specified sort. Prepend "-" to specify descending order.

Returns

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

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

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

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

Returns

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

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

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

Show Calendar Item Get the details of a single Calendar 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.
id (integer()): Calendar Item ID
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_schedule_calendar_items_id_patch(connection, procore_company_id, project_id, id, body116, opts \\ [])

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

Update Calendar Item Update attributes on a single Calendar 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.
id (integer()): Calendar Item ID
body116 (Body116):
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_schedule_calendar_items_post(connection, procore_company_id, project_id, body116, opts \\ [])

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

Create Calendar Item Create a new Calendar 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.
body116 (Body116):
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_schedule_calendar_items_sync_patch(connection, procore_company_id, project_id, body117, opts \\ [])

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

Sync Calendar Items Create or update a batch of Calendar Items

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

Returns

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