Class: Dropbox::Sign::SubSignatureRequestGroupedSigners

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubSignatureRequestGroupedSigners

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 95

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubSignatureRequestGroupedSigners` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignatureRequestGroupedSigners`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'group')
    self.group = attributes[:'group']
  end

  if attributes.key?(:'signers')
    if (value = attributes[:'signers']).is_a?(Array)
      self.signers = value
    end
  end

  if attributes.key?(:'order')
    self.order = attributes[:'order']
  end
end

Instance Attribute Details

#group ⇒ String

The name of the group.

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 23

def group
  @group
end

#order ⇒ Integer?

The order the group is required to sign in. Use this instead of Signer-level ‘order`.

Returns:

  • (Integer, nil) 


31
32
33
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 31

def order
  @order
end

#signers ⇒ Array<SubSignatureRequestSigner>

Signers belonging to this Group. NOTE: Only ‘name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.

Returns:



27
28
29
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 27

def signers
  @signers
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



43
44
45
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 43

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



48
49
50
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 48

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 34

def self.attribute_map
  {
    :'group' => :'group',
    :'signers' => :'signers',
    :'order' => :'order'
  }
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



192
193
194
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 192

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.init(data) ⇒ SubSignatureRequestGroupedSigners

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



86
87
88
89
90
91
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 86

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "SubSignatureRequestGroupedSigners"
  ) || SubSignatureRequestGroupedSigners.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



69
70
71
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 69

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



79
80
81
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 79

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



74
75
76
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 74

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 62

def self.openapi_nullable
  Set.new([
    :'order'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 53

def self.openapi_types
  {
    :'group' => :'String',
    :'signers' => :'Array<SubSignatureRequestSigner>',
    :'order' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 169

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



222
223
224
225
226
227
228
229
230
231
232
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
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 222

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    klass = Dropbox::Sign.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value, include_nil = true) ⇒ 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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 293

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 199

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


179
180
181
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



185
186
187
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 185

def hash
  [group, signers, order].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



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 126

def list_invalid_properties
  invalid_properties = Array.new
  if @group.nil?
    invalid_properties.push('invalid value for "group", group cannot be nil.')
  end

  if @signers.nil?
    invalid_properties.push('invalid value for "signers", signers cannot be nil.')
  end

  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



268
269
270
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 268

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 274

def to_hash(include_nil = true)
  hash = {}
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



262
263
264
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 262

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



141
142
143
144
145
 
# File 'lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb', line 141

def valid?
  return false if @group.nil?
  return false if @signers.nil?
  true
end