Docspring.Model.SignatureRequest (docspring v4.4.0)

A request for someone to fill in their fields of a submission and sign it. Someone who only fills in fields for the people who sign later (such as an employer's section) has a signature request too. The submission's PDF is generated once every signature request is completed.

Summary

Types

t()

Functions

decode(value)

Types

t()

@type t() :: %Docspring.Model.SignatureRequest{
  auth_phone_number_hash: String.t() | nil,
  auth_provider: String.t() | nil,
  auth_second_factor_type:
    Docspring.Model.SignatureRequestAuthSecondFactorType.t(),
  auth_session_id_hash: String.t() | nil,
  auth_session_started_at: DateTime.t() | nil,
  auth_type: Docspring.Model.SignatureRequestAuthType.t(),
  auth_user_id_hash: String.t() | nil,
  auth_username_hash: String.t() | nil,
  completed_at: DateTime.t() | nil,
  created_at: DateTime.t(),
  data: %{optional(String.t()) => any()} | nil,
  declined_at: DateTime.t() | nil,
  email: String.t() | nil,
  email_status: Docspring.Model.SignatureRequestEmailStatus.t() | nil,
  fields: [String.t()] | nil,
  id: String.t(),
  ip_address: String.t() | nil,
  metadata: %{optional(String.t()) => any()},
  name: String.t() | nil,
  role: String.t(),
  send_email: boolean(),
  sent_at: DateTime.t() | nil,
  signing_step: integer() | nil,
  sort_order: integer(),
  state: Docspring.Model.SignatureRequestState.t(),
  submission_id: String.t(),
  updated_at: DateTime.t(),
  user_agent: String.t() | nil,
  viewed_at: DateTime.t() | nil
}

Functions

decode(value)