Procore.Api.QualitySafetyInspectionsChecklistSignatureRequests (procore_sdk v0.3.0)

API calls for all endpoints tagged QualitySafetyInspectionsChecklistSignatureRequests.

Summary

Functions

rest_v10_checklist_lists_list_id_signature_requests_get(connection, procore_company_id, list_id, project_id, opts \\ [])

List Checklist Signature Requests Lists Signature Requests for a specified Checklist

rest_v10_checklist_lists_list_id_signature_requests_id_delete(connection, procore_company_id, project_id, list_id, id, opts \\ [])

Delete Checklist Signature Request Deletes a Signature Request for a specified Checklist.

rest_v10_checklist_lists_list_id_signature_requests_id_get(connection, procore_company_id, project_id, list_id, id, opts \\ [])

Show Checklist Signature Request Retrieves Signature Request for a specified Checklist.

rest_v10_checklist_lists_list_id_signature_requests_post(connection, procore_company_id, list_id, project_id, checklist_signature_request_create_body, opts \\ [])

Create Checklist Signature Request Creates a Signature Request for a specified Checklist.

rest_v10_checklist_lists_list_id_signature_requests_signature_request_id_signature_delete(connection, procore_company_id, list_id, signature_request_id, project_id, opts \\ [])

Delete Checklist Signature Deletes a Signature for a specified Checklist Signature Request.

rest_v10_checklist_lists_list_id_signature_requests_signature_request_id_signature_post(connection, procore_company_id, list_id, signature_request_id, project_id, attachment, opts \\ [])

Create Checklist Signature Creates a Signature for a specified Checklist Signature Request.

Functions

rest_v10_checklist_lists_list_id_signature_requests_get(connection, procore_company_id, list_id, project_id, opts \\ [])

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

List Checklist Signature Requests Lists Signature Requests for a specified Checklist

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
list_id (integer()): Checklist ID
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_signature_requests_id_delete(connection, procore_company_id, project_id, list_id, id, opts \\ [])

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

Delete Checklist Signature Request Deletes a Signature Request for a specified Checklist.

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.
list_id (integer()): Checklist ID
id (integer()): Signature Request ID
opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_signature_requests_id_get(connection, procore_company_id, project_id, list_id, id, opts \\ [])

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

Show Checklist Signature Request Retrieves Signature Request for a specified Checklist.

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.
list_id (integer()): Checklist ID
id (integer()): Signature Request ID
opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_signature_requests_post(connection, procore_company_id, list_id, project_id, checklist_signature_request_create_body, opts \\ [])

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

Create Checklist Signature Request Creates a Signature Request for a specified Checklist.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
list_id (integer()): Checklist ID
project_id (integer()): Unique identifier for the project.
checklist_signature_request_create_body (ChecklistSignatureRequestCreateBody):
opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_signature_requests_signature_request_id_signature_delete(connection, procore_company_id, list_id, signature_request_id, project_id, opts \\ [])

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

Delete Checklist Signature Deletes a Signature for a specified Checklist Signature Request.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
list_id (integer()): Checklist ID
signature_request_id (integer()): Checklist Signature Request ID
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters

Returns

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

rest_v10_checklist_lists_list_id_signature_requests_signature_request_id_signature_post(connection, procore_company_id, list_id, signature_request_id, project_id, attachment, opts \\ [])

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

Create Checklist Signature Creates a Signature for a specified Checklist Signature Request.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
list_id (integer()): Checklist ID
signature_request_id (integer()): Checklist Signature Request ID
project_id (integer()): Unique identifier for the project.
attachment (String.t): Attachment representing the Signature. To upload an attachment you must upload the entire payload as multipart/form-data content-type and specify each parameter as form-data together with the signature file.
opts (keyword): Optional parameters
- :attachment_string (String.t): Base64 encoded string representing PNG image of signature

Returns

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