Procore.Api.QualitySafetyActionPlansProjectActionPlanTemplateReceivers (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyActionPlansProjectActionPlanTemplateReceivers.

Summary

Functions

rest_v10_projects_project_id_action_plans_plan_template_receivers_bulk_create_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_template_receivers_bulk_create_post_request, opts \\ [])

Bulk Create Action Plan Template Receivers Bulk Create Action Plan Template Receivers for a given Project Action Plan Template.

rest_v10_projects_project_id_action_plans_plan_template_receivers_bulk_destroy_delete(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_template_receivers_bulk_destroy_delete_request, opts \\ [])

Bulk Destroy Action Plan Template Receivers Bulk Destroy Action Plan Template Receivers from a given Project Action Plan Template.

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

List Action Plan Template Receivers Returns all Action Plan Template Receivers for a given Project

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

Delete Action Plan Template Receiver Deletes an Action Plan Template Receiver

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

Show Action Plan Template Receiver Returns an Action Plan Template Receiver

rest_v10_projects_project_id_action_plans_plan_template_receivers_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_template_receivers_post_request, opts \\ [])

Create Action Plan Template Receiver Creates an Action Plan Template Receiver for a given Project Action Plan Template.

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

List Recycled Action Plan Template Receivers Returns all Recycled Action Plan Template Receivers for a given Project

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

Show Recycled Action Plan Template Receiver Returns a Recycled Action Plan Template Receiver

Functions

rest_v10_projects_project_id_action_plans_plan_template_receivers_bulk_create_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_template_receivers_bulk_create_post_request, opts \\ [])

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

Bulk Create Action Plan Template Receivers Bulk Create Action Plan Template Receivers for a given Project Action Plan Template.

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_action_plans_plan_template_receivers_bulk_create_post_request (RestV10ProjectsProjectIdActionPlansPlanTemplateReceiversBulkCreatePostRequest):
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_action_plans_plan_template_receivers_bulk_destroy_delete(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_template_receivers_bulk_destroy_delete_request, opts \\ [])

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

Bulk Destroy Action Plan Template Receivers Bulk Destroy Action Plan Template Receivers from a given Project Action Plan Template.

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_action_plans_plan_template_receivers_bulk_destroy_delete_request (RestV10ProjectsProjectIdActionPlansPlanTemplateReceiversBulkDestroyDeleteRequest):
opts (keyword): Optional parameters

Returns

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

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

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

List Action Plan Template Receivers Returns all Action Plan Template Receivers 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
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
- :"filters[plan_template_id]" ([integer()]): Return section(s) associated with the specified Action Plan Template ID(s).
- :"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, [%RestV10ProjectsProjectIdActionPlansPlanTemplateReceiversGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

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

Delete Action Plan Template Receiver Deletes an Action Plan Template Receiver

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()): Action Plan Template Receiver ID
opts (keyword): Optional parameters

Returns

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

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

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

Show Action Plan Template Receiver Returns an Action Plan Template Receiver

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()): Action Plan Template Receiver ID
opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_action_plans_plan_template_receivers_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_action_plans_plan_template_receivers_post_request, opts \\ [])

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

Create Action Plan Template Receiver Creates an Action Plan Template Receiver for a given Project Action Plan Template.

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_action_plans_plan_template_receivers_post_request (RestV10ProjectsProjectIdActionPlansPlanTemplateReceiversPostRequest):
opts (keyword): Optional parameters

Returns

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

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

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

List Recycled Action Plan Template Receivers Returns all Recycled Action Plan Template Receivers 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
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
- :"filters[plan_template_id]" ([integer()]): Return section(s) associated with the specified Action Plan Template ID(s).
- :"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, [%RestV10ProjectsProjectIdRecycleBinActionPlansPlanTemplateReceiversGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

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

Show Recycled Action Plan Template Receiver Returns a Recycled Action Plan Template Receiver

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()): Action Plan Template Receiver ID
opts (keyword): Optional parameters

Returns

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