Class: SignwellSDK::Models::V1::DocumentRemindParams::Recipient

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/signwell_sdk/models/v1/document_remind_params.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: nil, name: nil) ⇒ Object

Parameters:

  • email (String) (defaults to: nil) —

    Recipient’s email address.

  • name (String) (defaults to: nil) —

    Recipient’s name (required if multiple recipients share the same email).



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/signwell_sdk/models/v1/document_remind_params.rb', line 28

class Recipient < SignwellSDK::Internal::Type::BaseModel
  # @!attribute email
  #   Recipient's email address.
  #
  #   @return [String, nil]
  optional :email, String

  # @!attribute name
  #   Recipient's name (required if multiple recipients share the same email).
  #
  #   @return [String, nil]
  optional :name, String

  # @!method initialize(email: nil, name: nil)
  #   @param email [String] Recipient's email address.
  #
  #   @param name [String] Recipient's name (required if multiple recipients share the same email).
end

Instance Attribute Details

#email ⇒ String?

Recipient’s email address.

Returns:

  • (String, nil) 


33
 
# File 'lib/signwell_sdk/models/v1/document_remind_params.rb', line 33

optional :email, String

#name ⇒ String?

Recipient’s name (required if multiple recipients share the same email).

Returns:

  • (String, nil) 


39
 
# File 'lib/signwell_sdk/models/v1/document_remind_params.rb', line 39

optional :name, String