View Source Yousign.SignatureRequest (yousign_ex v0.2.3)

Models a Yousign request signature. See: https://developers.yousign.com/reference/get-signature_requests-signaturerequestid

Link to this section Summary

Link to this section Types

@type approver_status() :: :initiated | :notified | :approved | :rejected
@type delivery_mode() :: :email | :none
@type reminder_settings() :: %{
  interval_in_days: non_neg_integer(),
  max_occurrences: non_neg_integer()
}
Link to this type

signature_request_status()

View Source
@type signature_request_status() ::
  :draft
  | :ongoing
  | :done
  | :deleted
  | :expired
  | :canceled
  | :approval
  | :rejected
@type signer_status() ::
  :initiated
  | :notified
  | :identified
  | :verifying
  | :consent_given
  | :verified
  | :verification_failed
  | :processing
  | :signed
@type source() ::
  :public_api
  | :connector_hubspot_api
  | :connector_salesforce_api
  | :connector_google_api
  | :connector_zapier_api
@type t() :: %Yousign.SignatureRequest{
  approvers: [%{id: String.t(), status: approver_status()}],
  branding_id: String.t(),
  created_at: DateTime.t(),
  delivery_mode: delivery_mode(),
  documents: [%{id: String.t(), nature: Yousign.Document.document_nature()}],
  email_custom_note: String.t() | nil,
  expiration_date: DateTime.t() | nil,
  external_id: String.t(),
  id: String.t(),
  name: String.t(),
  ordered_signers: boolean() | nil,
  reminder_settings: reminder_settings(),
  sender: %{id: String.t(), email: String.t()},
  signers: [%{id: String.t(), status: signer_status()}],
  source: source(),
  status: signature_request_status(),
  timezone: String.t() | nil
}