Class: SignwellSDK::Models::V1::Document

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SignwellSDK::Models::V1::Document

Defined in:

lib/signwell_sdk/models/v1/document.rb

Overview

See Also:

• Resources::V1::Documents#create

Defined Under Namespace

Classes: AttachmentRequest, Field, Recipient

Instance Attribute Summary

• #allow_decline ⇒ Boolean^?
• #allow_reassign ⇒ Boolean^?
• #api_application_id ⇒ String^?
• #apply_signing_order ⇒ Boolean^?
• #archived ⇒ Boolean^?
• #attachment_requests ⇒ Array<SignwellSDK::Models::V1::Document::AttachmentRequest>^?
• #checkbox_groups ⇒ Array<SignwellSDK::Models::CheckboxGroupInfo>^?
• #copied_contacts ⇒ Array<SignwellSDK::Models::CopiedContactInfo>^?
• #created_at ⇒ Time^?
• #custom_requester_email ⇒ String^?
• #custom_requester_name ⇒ String^?
• #decline_redirect_url ⇒ String^?
• #embedded ⇒ Boolean^?
• #embedded_edit_url ⇒ String^?
• #embedded_preview_url ⇒ String^?
• #expires_in ⇒ Integer^?
• #fields ⇒ Array<Array<SignwellSDK::Models::V1::Document::Field>>^?
• #files ⇒ Array<SignwellSDK::Models::FileInfo>^?
• #id ⇒ String
• #labels ⇒ Array<SignwellSDK::Models::LabelInfo>^?
• #language ⇒ String^?
• #message ⇒ String^?
• #metadata ⇒ Hash{Symbol=>String}^?
• #name ⇒ String^?
• #recipients ⇒ Array<SignwellSDK::Models::V1::Document::Recipient>^?
• #redirect_url ⇒ String^?
• #reminders ⇒ Boolean^?
• #requester_email_address ⇒ String^?
• #status ⇒ String^?
• #subject ⇒ String^?
• #test_mode ⇒ Boolean
• #updated_at ⇒ Time^?

Class Method Summary

• .variants ⇒ Array(String, Boolean, Float)

Instance Method Summary

• #initialize(name:, recipient_id:, required: nil) ⇒ Object constructor

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(name:, recipient_id:, required: nil) ⇒ Object

Parameters:

• name (String)
• recipient_id (String)
• required (Boolean) (defaults to: nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 220

Instance Attribute Details

#allow_decline ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 21

optional :allow_decline, SignwellSDK::Internal::Type::Boolean, nil?: true

#allow_reassign ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 26

optional :allow_reassign, SignwellSDK::Internal::Type::Boolean, nil?: true

#api_application_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 31

optional :api_application_id, String, nil?: true

#apply_signing_order ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 36

optional :apply_signing_order, SignwellSDK::Internal::Type::Boolean

#archived ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 41

optional :archived, SignwellSDK::Internal::Type::Boolean

#attachment_requests ⇒ Array<SignwellSDK::Models::V1::Document::AttachmentRequest>^?

Returns:

• (Array<SignwellSDK::Models::V1::Document::AttachmentRequest>, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 46

optional :attachment_requests,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document::AttachmentRequest] }

#checkbox_groups ⇒ Array<SignwellSDK::Models::CheckboxGroupInfo>^?

Returns:

• (Array<SignwellSDK::Models::CheckboxGroupInfo>, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 52

optional :checkbox_groups, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::CheckboxGroupInfo] }

#copied_contacts ⇒ Array<SignwellSDK::Models::CopiedContactInfo>^?

Returns:

• (Array<SignwellSDK::Models::CopiedContactInfo>, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 57

optional :copied_contacts, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::CopiedContactInfo] }

#created_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 62

optional :created_at, Time

#custom_requester_email ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 67

optional :custom_requester_email, String, nil?: true

#custom_requester_name ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 72

optional :custom_requester_name, String, nil?: true

#decline_redirect_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 77

optional :decline_redirect_url, String, nil?: true

#embedded ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 82

optional :embedded, SignwellSDK::Internal::Type::Boolean

#embedded_edit_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 87

optional :embedded_edit_url, String

#embedded_preview_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 92

optional :embedded_preview_url, String, nil?: true

#expires_in ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 97

optional :expires_in, Integer

#fields ⇒ Array<Array<SignwellSDK::Models::V1::Document::Field>>^?

Returns:

• (Array<Array<SignwellSDK::Models::V1::Document::Field>>, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 102

optional :fields,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document::Field]] }

#files ⇒ Array<SignwellSDK::Models::FileInfo>^?

Returns:

• (Array<SignwellSDK::Models::FileInfo>, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 108

optional :files, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::FileInfo] }

#id ⇒ String

Returns:

• (String)

# File 'lib/signwell_sdk/models/v1/document.rb', line 11

required :id, String

#labels ⇒ Array<SignwellSDK::Models::LabelInfo>^?

Returns:

• (Array<SignwellSDK::Models::LabelInfo>, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 113

optional :labels, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::LabelInfo] }

#language ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 118

optional :language, String

#message ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 123

optional :message, String

#metadata ⇒ Hash{Symbol=>String}^?

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 128

optional :metadata, SignwellSDK::Internal::Type::HashOf[String], nil?: true

#name ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 133

optional :name, String

#recipients ⇒ Array<SignwellSDK::Models::V1::Document::Recipient>^?

Returns:

• (Array<SignwellSDK::Models::V1::Document::Recipient>, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 138

optional :recipients, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document::Recipient] }

#redirect_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 143

optional :redirect_url, String, nil?: true

#reminders ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 148

optional :reminders, SignwellSDK::Internal::Type::Boolean

#requester_email_address ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 153

optional :requester_email_address, String

#status ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 158

optional :status, String

#subject ⇒ String^?

Returns:

• (String, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 163

optional :subject, String

#test_mode ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/signwell_sdk/models/v1/document.rb', line 16

required :test_mode, SignwellSDK::Internal::Type::Boolean

#updated_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/signwell_sdk/models/v1/document.rb', line 168

optional :updated_at, Time

Class Method Details

.variants ⇒ Array(String, Boolean, Float)

Returns:

• (Array(String, Boolean, Float))

# File 'lib/signwell_sdk/models/v1/document.rb', line 441