Class: DocuSign_eSign::Reminders

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/reminders.rb

Overview

A complex element that specifies reminder settings for the envelope

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Reminders

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/docusign_esign/models/reminders.rb', line 47

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'reminderDelay')
    self.reminder_delay = attributes[:'reminderDelay']
  end

  if attributes.has_key?(:'reminderEnabled')
    self.reminder_enabled = attributes[:'reminderEnabled']
  end

  if attributes.has_key?(:'reminderFrequency')
    self.reminder_frequency = attributes[:'reminderFrequency']
  end
end

Instance Attribute Details

#reminder_delayObject

An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.


19
20
21
# File 'lib/docusign_esign/models/reminders.rb', line 19

def reminder_delay
  @reminder_delay
end

#reminder_enabledObject

When set to *true*, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.


22
23
24
# File 'lib/docusign_esign/models/reminders.rb', line 22

def reminder_enabled
  @reminder_enabled
end

#reminder_frequencyObject

An interger that sets the interval, in days, between reminder emails.


25
26
27
# File 'lib/docusign_esign/models/reminders.rb', line 25

def reminder_frequency
  @reminder_frequency
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


28
29
30
31
32
33
34
# File 'lib/docusign_esign/models/reminders.rb', line 28

def self.attribute_map
  {
    :'reminder_delay' => :'reminderDelay',
    :'reminder_enabled' => :'reminderEnabled',
    :'reminder_frequency' => :'reminderFrequency'
  }
end

.swagger_typesObject

Attribute type mapping.


37
38
39
40
41
42
43
# File 'lib/docusign_esign/models/reminders.rb', line 37

def self.swagger_types
  {
    :'reminder_delay' => :'String',
    :'reminder_enabled' => :'String',
    :'reminder_frequency' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


81
82
83
84
85
86
87
# File 'lib/docusign_esign/models/reminders.rb', line 81

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reminder_delay == o.reminder_delay &&
      reminder_enabled == o.reminder_enabled &&
      reminder_frequency == o.reminder_frequency
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/docusign_esign/models/reminders.rb', line 125

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/docusign_esign/models/reminders.rb', line 191

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/docusign_esign/models/reminders.rb', line 104

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

91
92
93
# File 'lib/docusign_esign/models/reminders.rb', line 91

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


97
98
99
# File 'lib/docusign_esign/models/reminders.rb', line 97

def hash
  [reminder_delay, reminder_enabled, reminder_frequency].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


68
69
70
71
# File 'lib/docusign_esign/models/reminders.rb', line 68

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


171
172
173
# File 'lib/docusign_esign/models/reminders.rb', line 171

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


177
178
179
180
181
182
183
184
185
# File 'lib/docusign_esign/models/reminders.rb', line 177

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


165
166
167
# File 'lib/docusign_esign/models/reminders.rb', line 165

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


75
76
77
# File 'lib/docusign_esign/models/reminders.rb', line 75

def valid?
  true
end