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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/signwell_sdk/models/v1/document.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(email:, name:, id: nil, attachment_requests: nil, body: nil, bounced: nil, bounced_details: nil, message: nil, passcode: nil, send_email: nil, send_email_delay: nil, signing_order: nil, signing_url: nil, status: nil, subject: nil) ⇒ Object

Parameters:

  • email (String)
  • name (String)
  • id (String) (defaults to: nil)
  • attachment_requests (Array<SignwellSDK::Models::AttachmentRequestInfo>) (defaults to: nil)
  • body (String) (defaults to: nil)
  • bounced (Boolean, nil) (defaults to: nil)
  • bounced_details (String, nil) (defaults to: nil)
  • message (String, nil) (defaults to: nil)
  • passcode (String, nil) (defaults to: nil)
  • send_email (Boolean, nil) (defaults to: nil)
  • send_email_delay (Integer, nil) (defaults to: nil)
  • signing_order (Integer) (defaults to: nil)
  • signing_url (String) (defaults to: nil)
  • status (String) (defaults to: nil)
  • subject (String, nil) (defaults to: nil) 



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

Instance Attribute Details

#attachment_requests ⇒ Array<SignwellSDK::Models::AttachmentRequestInfo>?

Returns:



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

optional :attachment_requests,
-> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::AttachmentRequestInfo] }

#body ⇒ String?

Returns:

  • (String, nil) 


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

optional :body, String

#bounced ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

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

#bounced_details ⇒ String?

Returns:

  • (String, nil) 


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

optional :bounced_details, String, nil?: true

#email ⇒ String

Returns:

  • (String) 


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

required :email, String

#id ⇒ String?

Returns:

  • (String, nil) 


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

optional :id, String

#message ⇒ String?

Returns:

  • (String, nil) 


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

optional :message, String, nil?: true

#name ⇒ String

Returns:

  • (String) 


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

required :name, String

#passcode ⇒ String?

Returns:

  • (String, nil) 


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

optional :passcode, String, nil?: true

#send_email ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

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

#send_email_delay ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :send_email_delay, Integer, nil?: true

#signing_order ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :signing_order, Integer

#signing_url ⇒ String?

Returns:

  • (String, nil) 


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

optional :signing_url, String

#status ⇒ String?

Returns:

  • (String, nil) 


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

optional :status, String

#subject ⇒ String?

Returns:

  • (String, nil) 


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

optional :subject, String, nil?: true