Class: DocuSign_eSign::Notification

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

Overview

A complex element that specifies the notification options for the envelope. It consists of: * useAccountDefaults - When set to *true*, the account default notification settings are used for the envelope. * reminders - A complex element that specifies reminder settings for the envelope. It consists of: * reminderEnabled - When set to *true*, a reminder message is sent to the recipient. * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. * reminderFrequency - An interger that sets the interval, in days, between reminder emails. * expirations - A complex element that specifies the expiration settings for the envelope. It consists of: * expireEnabled - 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. * expireAfter - An integer that sets the number of days the envelope is active. * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Notification

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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?(:'expirations')
    self.expirations = attributes[:'expirations']
  end

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

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

Instance Attribute Details

#expirationsObject

Returns the value of attribute expirations


18
19
20
# File 'lib/docusign_esign/models/notification.rb', line 18

def expirations
  @expirations
end

#remindersObject

Returns the value of attribute reminders


20
21
22
# File 'lib/docusign_esign/models/notification.rb', line 20

def reminders
  @reminders
end

#use_account_defaultsObject

When set to *true*, the account default notification settings are used for the envelope.


23
24
25
# File 'lib/docusign_esign/models/notification.rb', line 23

def 
  @use_account_defaults
end

Class Method Details

.attribute_mapObject

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


26
27
28
29
30
31
32
# File 'lib/docusign_esign/models/notification.rb', line 26

def self.attribute_map
  {
    :'expirations' => :'expirations',
    :'reminders' => :'reminders',
    :'use_account_defaults' => :'useAccountDefaults'
  }
end

.swagger_typesObject

Attribute type mapping.


35
36
37
38
39
40
41
# File 'lib/docusign_esign/models/notification.rb', line 35

def self.swagger_types
  {
    :'expirations' => :'Expirations',
    :'reminders' => :'Reminders',
    :'use_account_defaults' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


79
80
81
82
83
84
85
# File 'lib/docusign_esign/models/notification.rb', line 79

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expirations == o.expirations &&
      reminders == o.reminders &&
       == o.
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


123
124
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
# File 'lib/docusign_esign/models/notification.rb', line 123

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


189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/docusign_esign/models/notification.rb', line 189

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


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

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

89
90
91
# File 'lib/docusign_esign/models/notification.rb', line 89

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


95
96
97
# File 'lib/docusign_esign/models/notification.rb', line 95

def hash
  [expirations, reminders, ].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


66
67
68
69
# File 'lib/docusign_esign/models/notification.rb', line 66

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


169
170
171
# File 'lib/docusign_esign/models/notification.rb', line 169

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


175
176
177
178
179
180
181
182
183
# File 'lib/docusign_esign/models/notification.rb', line 175

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


163
164
165
# File 'lib/docusign_esign/models/notification.rb', line 163

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


73
74
75
# File 'lib/docusign_esign/models/notification.rb', line 73

def valid?
  true
end