Procore.Api.QualitySafetyInspectionsInspectionItemSignatureRequests (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyInspectionsInspectionItemSignatureRequests.

Summary

Functions

Finds or Creates a Inspection Item Signature Request Tries to find a Inspection Item Signature Request for a specified Inspection, creates one if it doesn't exist.

Get a list of Inspection Item Signature Requests Get a list of Inspection Item Signature Requests for a specified Inspection.

Creates a Inspection Item Signature Request Creates a Inspection Item Signature Request for a specified Inspection.

Functions

Link to this function

rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_find_or_create_post(connection, procore_company_id, company_id, project_id, item_id, opts \\ [])

@spec rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_find_or_create_post(
  Tesla.Env.client(),
  integer(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV20CompaniesCompanyIdProjectsProjectIdInspectionItemsItemIdSignatureRequestsPost201Response.t()}
  | {:error, Tesla.Env.t()}

Finds or Creates a Inspection Item Signature Request Tries to find a Inspection Item Signature Request for a specified Inspection, creates one if it doesn't exist.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • project_id (String.t): Unique identifier for the project.
  • item_id (String.t): Unique identifier for the inspection item.
  • opts (keyword): Optional parameters
    • :body (RestV20CompaniesCompanyIdProjectsProjectIdInspectionItemsItemIdSignatureRequestsPostRequest):

Returns

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

rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_get(connection, procore_company_id, company_id, project_id, item_id, opts \\ [])

@spec rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_get(
  Tesla.Env.client(),
  integer(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV20CompaniesCompanyIdProjectsProjectIdInspectionItemsItemIdSignatureRequestsGet200Response.t()}
  | {:error, Tesla.Env.t()}

Get a list of Inspection Item Signature Requests Get a list of Inspection Item Signature Requests for a specified Inspection.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • project_id (String.t): Unique identifier for the project.
  • item_id (String.t): Unique identifier for the inspection item.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[id]" ([String.t]): Return Signature Request(s) with the specified IDs

Returns

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

rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_id_delete(connection, procore_company_id, company_id, project_id, item_id, id, opts \\ [])

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

Deletes an Inspection Item Signature Request Deletes the specified Inspection Item Signature Request

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • project_id (String.t): Unique identifier for the project.
  • item_id (String.t): Unique identifier for the inspection item.
  • id (String.t): Unique identifier of the Inspection Item Signature
  • opts (keyword): Optional parameters

Returns

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

rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_id_get(connection, procore_company_id, company_id, project_id, item_id, id, opts \\ [])

@spec rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_id_get(
  Tesla.Env.client(),
  integer(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV20CompaniesCompanyIdProjectsProjectIdInspectionItemsItemIdSignatureRequestsPost201Response.t()}
  | {:error, Tesla.Env.t()}

Show a Inspection Item Signature Request Show the specified Inspection Item Signature Request.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • project_id (String.t): Unique identifier for the project.
  • item_id (String.t): Unique identifier for the inspection item.
  • id (String.t): Unique identifier of the Inspection Item Signature
  • opts (keyword): Optional parameters

Returns

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

rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_post(connection, procore_company_id, company_id, project_id, item_id, opts \\ [])

@spec rest_v20_companies_company_id_projects_project_id_inspection_items_item_id_signature_requests_post(
  Tesla.Env.client(),
  integer(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, Procore.Model.RestV20CompaniesCompanyIdWorkflowsToolsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV20CompaniesCompanyIdProjectsProjectIdInspectionItemsItemIdSignatureRequestsPost201Response.t()}
  | {:error, Tesla.Env.t()}

Creates a Inspection Item Signature Request Creates a Inspection Item Signature Request for a specified Inspection.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (String.t): Unique identifier for the company.
  • project_id (String.t): Unique identifier for the project.
  • item_id (String.t): Unique identifier for the inspection item.
  • opts (keyword): Optional parameters
    • :body (RestV20CompaniesCompanyIdProjectsProjectIdInspectionItemsItemIdSignatureRequestsPostRequest):

Returns

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