Class: Dropbox::Sign::AccountResponseQuotas
- Inherits:
-
Object
- Object
- Dropbox::Sign::AccountResponseQuotas
- Defined in:
- lib/dropbox-sign/models/account_response_quotas.rb
Overview
Details concerning remaining monthly quotas.
Instance Attribute Summary collapse
-
#api_signature_requests_left ⇒ Integer?
API signature requests remaining.
-
#documents_left ⇒ Integer?
Signature requests remaining.
-
#sms_verifications_left ⇒ Integer?
SMS verifications remaining.
-
#templates_left ⇒ Integer?
API templates remaining.
-
#templates_total ⇒ Integer?
Total API templates allowed.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.init(data) ⇒ AccountResponseQuotas
Attempt to instantiate and hydrate a new instance of this class.
-
.merged_attributes ⇒ Object
Returns attribute map of this model + parent.
-
.merged_nullable ⇒ Object
Returns list of attributes with nullable: true of this model + parent.
-
.merged_types ⇒ Object
Attribute type mapping of this model + parent.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value, include_nil = true) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ AccountResponseQuotas
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash(include_nil = true) ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ AccountResponseQuotas
Initializes the object
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 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 107 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 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: " + self.class.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 end |
Instance Attribute Details
#api_signature_requests_left ⇒ Integer?
API signature requests remaining.
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.
28 29 30 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 28 def documents_left @documents_left end |
#sms_verifications_left ⇒ Integer?
SMS verifications remaining.
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.
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.
32 33 34 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 32 def templates_total @templates_total end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
54 55 56 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 54 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
43 44 45 46 47 48 49 50 51 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 43 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' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
181 182 183 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 181 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
98 99 100 101 102 103 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 98 def self.init(data) return ApiClient.default.convert_to_type( data, "AccountResponseQuotas" ) || AccountResponseQuotas.new end |
.merged_attributes ⇒ Object
Returns attribute map of this model + parent
59 60 61 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 59 def self.merged_attributes self.attribute_map end |
.merged_nullable ⇒ Object
Returns list of attributes with nullable: true of this model + parent
91 92 93 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 91 def self.merged_nullable self.openapi_nullable end |
.merged_types ⇒ Object
Attribute type mapping of this model + parent
75 76 77 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 75 def self.merged_types self.openapi_types end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
80 81 82 83 84 85 86 87 88 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 80 def self.openapi_nullable Set.new([ :'api_signature_requests_left', :'documents_left', :'templates_total', :'templates_left', :'sms_verifications_left' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
64 65 66 67 68 69 70 71 72 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 64 def self.openapi_types { :'api_signature_requests_left' => :'Integer', :'documents_left' => :'Integer', :'templates_total' => :'Integer', :'templates_left' => :'Integer', :'sms_verifications_left' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
156 157 158 159 160 161 162 163 164 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 156 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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
211 212 213 214 215 216 217 218 219 220 221 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 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 211 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 :File value 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 # models (e.g. Pet) klass = Dropbox::Sign.const_get(type) 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
285 286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 285 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
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 188 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
168 169 170 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 168 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
174 175 176 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 174 def hash [api_signature_requests_left, documents_left, templates_total, templates_left, sms_verifications_left].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
143 144 145 146 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 143 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
260 261 262 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 260 def to_body to_hash end |
#to_hash(include_nil = true) ⇒ Hash
Returns the object in the form of hash
266 267 268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 266 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
254 255 256 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 254 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
150 151 152 |
# File 'lib/dropbox-sign/models/account_response_quotas.rb', line 150 def valid? true end |