Class: OpenapiClient::Frequency
- Inherits:
-
Object
- Object
- OpenapiClient::Frequency
- Defined in:
- lib/openapi_client/models/frequency.rb
Overview
How often payments are sent.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#every ⇒ Object
Rate of frequency.
-
#unit ⇒ Object
Unit which defines the frequency.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Frequency
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(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ 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 = {}) ⇒ Frequency
Initializes the object
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/openapi_client/models/frequency.rb', line 64 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Frequency` 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.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Frequency`. 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?(:'every') self.every = attributes[:'every'] end if attributes.key?(:'unit') self.unit = attributes[:'unit'] end end |
Instance Attribute Details
#every ⇒ Object
Rate of frequency.
19 20 21 |
# File 'lib/openapi_client/models/frequency.rb', line 19 def every @every end |
#unit ⇒ Object
Unit which defines the frequency.
22 23 24 |
# File 'lib/openapi_client/models/frequency.rb', line 22 def unit @unit end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
47 48 49 50 51 52 |
# File 'lib/openapi_client/models/frequency.rb', line 47 def self.attribute_map { :'every' => :'every', :'unit' => :'unit' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
173 174 175 |
# File 'lib/openapi_client/models/frequency.rb', line 173 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
55 56 57 58 59 60 |
# File 'lib/openapi_client/models/frequency.rb', line 55 def self.openapi_types { :'every' => :'Integer', :'unit' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
151 152 153 154 155 156 |
# File 'lib/openapi_client/models/frequency.rb', line 151 def ==(o) return true if self.equal?(o) self.class == o.class && every == o.every && unit == o.unit end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
201 202 203 204 205 206 207 208 209 210 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 |
# File 'lib/openapi_client/models/frequency.rb', line 201 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 klass = OpenapiClient.const_get(type) if klass.respond_to?(:openapi_discriminator_name) klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]]) end klass.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
275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/openapi_client/models/frequency.rb', line 275 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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object
Builds the object from hash
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/openapi_client/models/frequency.rb', line 180 def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) return nil unless attributes.is_a?(Hash) openapi_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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
160 161 162 |
# File 'lib/openapi_client/models/frequency.rb', line 160 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
166 167 168 |
# File 'lib/openapi_client/models/frequency.rb', line 166 def hash [every, unit].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/openapi_client/models/frequency.rb', line 88 def list_invalid_properties invalid_properties = Array.new if @every.nil? invalid_properties.push('invalid value for "every", every cannot be nil.') end if @every > 1000 invalid_properties.push('invalid value for "every", must be smaller than or equal to 1000.') end if @every < 1 invalid_properties.push('invalid value for "every", must be greater than or equal to 1.') end if @unit.nil? invalid_properties.push('invalid value for "unit", unit cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
251 252 253 |
# File 'lib/openapi_client/models/frequency.rb', line 251 def to_body to_hash end |
#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash
Returns the object in the form of hash
257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/openapi_client/models/frequency.rb', line 257 def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) hash = {} attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
245 246 247 |
# File 'lib/openapi_client/models/frequency.rb', line 245 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
111 112 113 114 115 116 117 118 119 |
# File 'lib/openapi_client/models/frequency.rb', line 111 def valid? return false if @every.nil? return false if @every > 1000 return false if @every < 1 return false if @unit.nil? unit_validator = EnumAttributeValidator.new('String', ["DAY", "WEEK", "MONTH", "YEAR"]) return false unless unit_validator.valid?(@unit) true end |