Class: DocuSign_eSign::EnvelopeViewSettings

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeViewSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
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
160
161
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 100

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#back_button_action ⇒ Object

Returns the value of attribute back_button_action.



17
18
19
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 17

def back_button_action
  @back_button_action
end

#document_settings ⇒ Object

Returns the value of attribute document_settings.



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

def document_settings
  @document_settings
end

#envelope_custom_field_settings ⇒ Object

Returns the value of attribute envelope_custom_field_settings.



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

def envelope_custom_field_settings
  @envelope_custom_field_settings
end

#lock_token ⇒ Object

Returns the value of attribute lock_token.



26
27
28
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 26

def lock_token
  @lock_token
end

#recipient_settings ⇒ Object

Returns the value of attribute recipient_settings.



29
30
31
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 29

def recipient_settings
  @recipient_settings
end

#send_button_action ⇒ Object

Returns the value of attribute send_button_action.



32
33
34
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 32

def send_button_action
  @send_button_action
end

#show_advanced_options ⇒ Object

Returns the value of attribute show_advanced_options.



35
36
37
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 35

def show_advanced_options
  @show_advanced_options
end

#show_back_button ⇒ Object

Returns the value of attribute show_back_button.



38
39
40
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 38

def show_back_button
  @show_back_button
end

#show_discard_action ⇒ Object

Returns the value of attribute show_discard_action.



41
42
43
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 41

def show_discard_action
  @show_discard_action
end

#show_header_actions ⇒ Object

Returns the value of attribute show_header_actions.



44
45
46
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 44

def show_header_actions
  @show_header_actions
end

#show_sign_now ⇒ Object

Returns the value of attribute show_sign_now.



47
48
49
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 47

def show_sign_now
  @show_sign_now
end

#starting_screen ⇒ Object

Returns the value of attribute starting_screen.



50
51
52
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 50

def starting_screen
  @starting_screen
end

#tagger_settings ⇒ Object

Returns the value of attribute tagger_settings.



53
54
55
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 53

def tagger_settings
  @tagger_settings
end

#template_settings ⇒ Object

Returns the value of attribute template_settings.



56
57
58
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 56

def template_settings
  @template_settings
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 59

def self.attribute_map
  {
    :'back_button_action' => :'backButtonAction',
    :'document_settings' => :'documentSettings',
    :'envelope_custom_field_settings' => :'envelopeCustomFieldSettings',
    :'lock_token' => :'lockToken',
    :'recipient_settings' => :'recipientSettings',
    :'send_button_action' => :'sendButtonAction',
    :'show_advanced_options' => :'showAdvancedOptions',
    :'show_back_button' => :'showBackButton',
    :'show_discard_action' => :'showDiscardAction',
    :'show_header_actions' => :'showHeaderActions',
    :'show_sign_now' => :'showSignNow',
    :'starting_screen' => :'startingScreen',
    :'tagger_settings' => :'taggerSettings',
    :'template_settings' => :'templateSettings'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 79

def self.swagger_types
  {
    :'back_button_action' => :'String',
    :'document_settings' => :'EnvelopeViewDocumentSettings',
    :'envelope_custom_field_settings' => :'EnvelopeViewEnvelopeCustomFieldSettings',
    :'lock_token' => :'String',
    :'recipient_settings' => :'EnvelopeViewRecipientSettings',
    :'send_button_action' => :'String',
    :'show_advanced_options' => :'String',
    :'show_back_button' => :'String',
    :'show_discard_action' => :'String',
    :'show_header_actions' => :'String',
    :'show_sign_now' => :'String',
    :'starting_screen' => :'String',
    :'tagger_settings' => :'EnvelopeViewTaggerSettings',
    :'template_settings' => :'EnvelopeViewTemplateSettings'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      back_button_action == o.back_button_action &&
      document_settings == o.document_settings &&
      envelope_custom_field_settings == o.envelope_custom_field_settings &&
      lock_token == o.lock_token &&
      recipient_settings == o.recipient_settings &&
      send_button_action == o.send_button_action &&
      show_advanced_options == o.show_advanced_options &&
      show_back_button == o.show_back_button &&
      show_discard_action == o.show_discard_action &&
      show_header_actions == o.show_header_actions &&
      show_sign_now == o.show_sign_now &&
      starting_screen == o.starting_screen &&
      tagger_settings == o.tagger_settings &&
      template_settings == o.template_settings
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 233

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 299

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 212

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


199
200
201
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 205

def hash
  [back_button_action, document_settings, envelope_custom_field_settings, lock_token, recipient_settings, send_button_action, show_advanced_options, show_back_button, show_discard_action, show_header_actions, show_sign_now, starting_screen, tagger_settings, template_settings].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



279
280
281
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 279

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



285
286
287
288
289
290
291
292
293
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 285

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



273
274
275
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 273

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



172
173
174
 
# File 'lib/docusign_esign/models/envelope_view_settings.rb', line 172

def valid?
  true
end