Class: Dropbox::Sign::AccountResponseQuotas

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

Overview

Details concerning remaining monthly quotas.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountResponseQuotas

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 119

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::AccountResponseQuotas` 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::AccountResponseQuotas`. 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?(:'api_signature_requests_left')
    self.api_signature_requests_left = attributes[:'api_signature_requests_left']
  end

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

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

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

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

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

Instance Attribute Details

#api_signature_requests_left ⇒ Integer?

API signature requests remaining.

Returns:

  • (Integer, nil) 


24
25
26
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 24

def api_signature_requests_left
  @api_signature_requests_left
end

#documents_left ⇒ Integer?

Signature requests remaining.

Returns:

  • (Integer, nil) 


28
29
30
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 28

def documents_left
  @documents_left
end

#num_fax_pages_left ⇒ Integer?

Number of fax pages left

Returns:

  • (Integer, nil) 


44
45
46
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 44

def num_fax_pages_left
  @num_fax_pages_left
end

#sms_verifications_left ⇒ Integer?

SMS verifications remaining.

Returns:

  • (Integer, nil) 


40
41
42
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 40

def sms_verifications_left
  @sms_verifications_left
end

#templates_left ⇒ Integer?

API templates remaining.

Returns:

  • (Integer, nil) 


36
37
38
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 36

def templates_left
  @templates_left
end

#templates_total ⇒ Integer?

Total API templates allowed.

Returns:

  • (Integer, nil) 


32
33
34
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 32

def templates_total
  @templates_total
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



59
60
61
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 47

def self.attribute_map
  {
    :'api_signature_requests_left' => :'api_signature_requests_left',
    :'documents_left' => :'documents_left',
    :'templates_total' => :'templates_total',
    :'templates_left' => :'templates_left',
    :'sms_verifications_left' => :'sms_verifications_left',
    :'num_fax_pages_left' => :'num_fax_pages_left'
  }
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
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 199

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

.init(data) ⇒ AccountResponseQuotas

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



110
111
112
113
114
115
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 110

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



93
94
95
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 93

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



103
104
105
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 103

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



98
99
100
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 98

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 81

def self.openapi_nullable
  Set.new([
    :'api_signature_requests_left',
    :'documents_left',
    :'templates_total',
    :'templates_left',
    :'sms_verifications_left',
    :'num_fax_pages_left'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 69

def self.openapi_types
  {
    :'api_signature_requests_left' => :'Integer',
    :'documents_left' => :'Integer',
    :'templates_total' => :'Integer',
    :'templates_left' => :'Integer',
    :'sms_verifications_left' => :'Integer',
    :'num_fax_pages_left' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_signature_requests_left == o.api_signature_requests_left &&
      documents_left == o.documents_left &&
      templates_total == o.templates_total &&
      templates_left == o.templates_left &&
      sms_verifications_left == o.sms_verifications_left &&
      num_fax_pages_left == o.num_fax_pages_left
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



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
259
260
261
262
263
264
265
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 229

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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 300

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 206

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


186
187
188
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 186

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [api_signature_requests_left, documents_left, templates_total, templates_left, sms_verifications_left, num_fax_pages_left].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



160
161
162
163
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 160

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



275
276
277
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 275

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 281

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



269
270
271
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 269

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



167
168
169
 
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 167

def valid?
  true
end