Class: OpenapiClient::Customer
- Inherits:
-
Object
- Object
- OpenapiClient::Customer
- Defined in:
- lib/openapi_client/models/customer.rb
Overview
Customer model for customers registered at merchant’s website.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#address ⇒ Object
Returns the value of attribute address.
-
#date_of_birth ⇒ Object
The customer’s year of birth.
-
#email ⇒ Object
Customer’s email address.
-
#first_name ⇒ Object
Customer’s first name.
-
#gender ⇒ Object
The customers gender.
-
#id ⇒ Object
Unique ID for the customer, if registered.
-
#last_name ⇒ Object
Customer’s last name.
-
#middle_name ⇒ Object
Customer’s middle name.
-
#session_id ⇒ Object
The unique ID of the current login session.
-
#start_date ⇒ Object
The timestamp of the customers registration in the merchants platform.
-
#user_defined ⇒ Object
A JSON object that can carry any additional information about the customer that might be helpful for fraud detection.
-
#username ⇒ Object
The username of this customer in the merchants system.
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 = {}) ⇒ Customer
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 = {}) ⇒ Customer
Initializes the object
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 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/openapi_client/models/customer.rb', line 113 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Customer` 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::Customer`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] end if attributes.key?(:'first_name') self.first_name = attributes[:'first_name'] end if attributes.key?(:'last_name') self.last_name = attributes[:'last_name'] end if attributes.key?(:'middle_name') self.middle_name = attributes[:'middle_name'] end if attributes.key?(:'email') self.email = attributes[:'email'] end if attributes.key?(:'session_id') self.session_id = attributes[:'session_id'] end if attributes.key?(:'username') self.username = attributes[:'username'] end if attributes.key?(:'gender') self.gender = attributes[:'gender'] end if attributes.key?(:'date_of_birth') self.date_of_birth = attributes[:'date_of_birth'] end if attributes.key?(:'address') self.address = attributes[:'address'] end if attributes.key?(:'user_defined') self.user_defined = attributes[:'user_defined'] end end |
Instance Attribute Details
#address ⇒ Object
Returns the value of attribute address.
48 49 50 |
# File 'lib/openapi_client/models/customer.rb', line 48 def address @address end |
#date_of_birth ⇒ Object
The customer’s year of birth. Format is YYYY.
46 47 48 |
# File 'lib/openapi_client/models/customer.rb', line 46 def date_of_birth @date_of_birth end |
#email ⇒ Object
Customer’s email address.
34 35 36 |
# File 'lib/openapi_client/models/customer.rb', line 34 def email @email end |
#first_name ⇒ Object
Customer’s first name.
25 26 27 |
# File 'lib/openapi_client/models/customer.rb', line 25 def first_name @first_name end |
#gender ⇒ Object
The customers gender. Do not set this property if the customer does not specify a gender.
43 44 45 |
# File 'lib/openapi_client/models/customer.rb', line 43 def gender @gender end |
#id ⇒ Object
Unique ID for the customer, if registered. This field is required if the parent object is present.
19 20 21 |
# File 'lib/openapi_client/models/customer.rb', line 19 def id @id end |
#last_name ⇒ Object
Customer’s last name.
28 29 30 |
# File 'lib/openapi_client/models/customer.rb', line 28 def last_name @last_name end |
#middle_name ⇒ Object
Customer’s middle name.
31 32 33 |
# File 'lib/openapi_client/models/customer.rb', line 31 def middle_name @middle_name end |
#session_id ⇒ Object
The unique ID of the current login session. Must be unique for the customer.
37 38 39 |
# File 'lib/openapi_client/models/customer.rb', line 37 def session_id @session_id end |
#start_date ⇒ Object
The timestamp of the customers registration in the merchants platform. Format is YYYY-MM-DD.
22 23 24 |
# File 'lib/openapi_client/models/customer.rb', line 22 def start_date @start_date end |
#user_defined ⇒ Object
A JSON object that can carry any additional information about the customer that might be helpful for fraud detection.
51 52 53 |
# File 'lib/openapi_client/models/customer.rb', line 51 def user_defined @user_defined end |
#username ⇒ Object
The username of this customer in the merchants system. This field should contain customer-supplied data if available instead of a generated ID. This field can contain the clients email address if it is also used for authentication purposes.
40 41 42 |
# File 'lib/openapi_client/models/customer.rb', line 40 def username @username end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/openapi_client/models/customer.rb', line 76 def self.attribute_map { :'id' => :'id', :'start_date' => :'startDate', :'first_name' => :'firstName', :'last_name' => :'lastName', :'middle_name' => :'middleName', :'email' => :'email', :'session_id' => :'sessionId', :'username' => :'username', :'gender' => :'gender', :'date_of_birth' => :'dateOfBirth', :'address' => :'address', :'user_defined' => :'userDefined' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
260 261 262 |
# File 'lib/openapi_client/models/customer.rb', line 260 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/openapi_client/models/customer.rb', line 94 def self.openapi_types { :'id' => :'String', :'start_date' => :'String', :'first_name' => :'String', :'last_name' => :'String', :'middle_name' => :'String', :'email' => :'String', :'session_id' => :'String', :'username' => :'String', :'gender' => :'String', :'date_of_birth' => :'String', :'address' => :'CustomerAddress', :'user_defined' => :'Object' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/openapi_client/models/customer.rb', line 228 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && start_date == o.start_date && first_name == o.first_name && last_name == o.last_name && middle_name == o.middle_name && email == o.email && session_id == o.session_id && username == o.username && gender == o.gender && date_of_birth == o.date_of_birth && address == o.address && user_defined == o.user_defined end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/openapi_client/models/customer.rb', line 288 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
362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/openapi_client/models/customer.rb', line 362 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
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/openapi_client/models/customer.rb', line 267 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
247 248 249 |
# File 'lib/openapi_client/models/customer.rb', line 247 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
253 254 255 |
# File 'lib/openapi_client/models/customer.rb', line 253 def hash [id, start_date, first_name, last_name, middle_name, email, session_id, username, gender, date_of_birth, address, user_defined].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/openapi_client/models/customer.rb', line 177 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end pattern = Regexp.new(/^(?!\s*$).+/) if @id !~ pattern invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.") end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
338 339 340 |
# File 'lib/openapi_client/models/customer.rb', line 338 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
344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/openapi_client/models/customer.rb', line 344 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
332 333 334 |
# File 'lib/openapi_client/models/customer.rb', line 332 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
193 194 195 196 197 198 199 |
# File 'lib/openapi_client/models/customer.rb', line 193 def valid? return false if @id.nil? return false if @id !~ Regexp.new(/^(?!\s*$).+/) gender_validator = EnumAttributeValidator.new('String', ["male", "female", "other"]) return false unless gender_validator.valid?(@gender) true end |