Class: SquareConnect::CreateCustomerRequest
- Inherits:
-
Object
- Object
- SquareConnect::CreateCustomerRequest
- Defined in:
- lib/square_connect/models/create_customer_request.rb
Overview
Defines the body parameters that can be provided in a request to the CreateCustomer endpoint.
Instance Attribute Summary collapse
-
#address ⇒ Object
The customer’s physical address.
-
#birthday ⇒ Object
The customer birthday in RFC-3339 format.
-
#company_name ⇒ Object
The name of the customer’s company.
-
#email_address ⇒ Object
The customer’s email address.
-
#family_name ⇒ Object
The customer’s family (i.e., last) name.
-
#given_name ⇒ Object
The customer’s given (i.e., first) name.
-
#idempotency_key ⇒ Object
The idempotency key for the request.
-
#nickname ⇒ Object
A nickname for the customer.
-
#note ⇒ Object
An optional note to associate with the customer.
-
#phone_number ⇒ Object
The customer’s phone number.
-
#reference_id ⇒ Object
An optional second ID you can set to associate the customer with an entity in another system.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_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) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateCustomerRequest
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 ⇒ 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 = {}) ⇒ CreateCustomerRequest
Initializes the object
85 86 87 88 89 90 91 92 93 94 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 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/square_connect/models/create_customer_request.rb', line 85 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'idempotency_key') self.idempotency_key = attributes[:'idempotency_key'] end if attributes.has_key?(:'given_name') self.given_name = attributes[:'given_name'] end if attributes.has_key?(:'family_name') self.family_name = attributes[:'family_name'] end if attributes.has_key?(:'company_name') self.company_name = attributes[:'company_name'] end if attributes.has_key?(:'nickname') self.nickname = attributes[:'nickname'] end if attributes.has_key?(:'email_address') self.email_address = attributes[:'email_address'] end if attributes.has_key?(:'address') self.address = attributes[:'address'] end if attributes.has_key?(:'phone_number') self.phone_number = attributes[:'phone_number'] end if attributes.has_key?(:'reference_id') self.reference_id = attributes[:'reference_id'] end if attributes.has_key?(:'note') self.note = attributes[:'note'] end if attributes.has_key?(:'birthday') self.birthday = attributes[:'birthday'] end end |
Instance Attribute Details
#address ⇒ Object
The customer’s physical address.
34 35 36 |
# File 'lib/square_connect/models/create_customer_request.rb', line 34 def address @address end |
#birthday ⇒ Object
The customer birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: ‘0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.
46 47 48 |
# File 'lib/square_connect/models/create_customer_request.rb', line 46 def birthday @birthday end |
#company_name ⇒ Object
The name of the customer’s company.
25 26 27 |
# File 'lib/square_connect/models/create_customer_request.rb', line 25 def company_name @company_name end |
#email_address ⇒ Object
The customer’s email address.
31 32 33 |
# File 'lib/square_connect/models/create_customer_request.rb', line 31 def email_address @email_address end |
#family_name ⇒ Object
The customer’s family (i.e., last) name.
22 23 24 |
# File 'lib/square_connect/models/create_customer_request.rb', line 22 def family_name @family_name end |
#given_name ⇒ Object
The customer’s given (i.e., first) name.
19 20 21 |
# File 'lib/square_connect/models/create_customer_request.rb', line 19 def given_name @given_name end |
#idempotency_key ⇒ Object
The idempotency key for the request. See the [Idempotency](/basics/api101/idempotency) guide for more information.
16 17 18 |
# File 'lib/square_connect/models/create_customer_request.rb', line 16 def idempotency_key @idempotency_key end |
#nickname ⇒ Object
A nickname for the customer.
28 29 30 |
# File 'lib/square_connect/models/create_customer_request.rb', line 28 def nickname @nickname end |
#note ⇒ Object
An optional note to associate with the customer.
43 44 45 |
# File 'lib/square_connect/models/create_customer_request.rb', line 43 def note @note end |
#phone_number ⇒ Object
The customer’s phone number.
37 38 39 |
# File 'lib/square_connect/models/create_customer_request.rb', line 37 def phone_number @phone_number end |
#reference_id ⇒ Object
An optional second ID you can set to associate the customer with an entity in another system.
40 41 42 |
# File 'lib/square_connect/models/create_customer_request.rb', line 40 def reference_id @reference_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/square_connect/models/create_customer_request.rb', line 50 def self.attribute_map { :'idempotency_key' => :'idempotency_key', :'given_name' => :'given_name', :'family_name' => :'family_name', :'company_name' => :'company_name', :'nickname' => :'nickname', :'email_address' => :'email_address', :'address' => :'address', :'phone_number' => :'phone_number', :'reference_id' => :'reference_id', :'note' => :'note', :'birthday' => :'birthday' } end |
.swagger_types ⇒ Object
Attribute type mapping.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/square_connect/models/create_customer_request.rb', line 67 def self.swagger_types { :'idempotency_key' => :'String', :'given_name' => :'String', :'family_name' => :'String', :'company_name' => :'String', :'nickname' => :'String', :'email_address' => :'String', :'address' => :'Address', :'phone_number' => :'String', :'reference_id' => :'String', :'note' => :'String', :'birthday' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/square_connect/models/create_customer_request.rb', line 152 def ==(o) return true if self.equal?(o) self.class == o.class && idempotency_key == o.idempotency_key && given_name == o.given_name && family_name == o.family_name && company_name == o.company_name && nickname == o.nickname && email_address == o.email_address && address == o.address && phone_number == o.phone_number && reference_id == o.reference_id && note == o.note && birthday == o.birthday end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/square_connect/models/create_customer_request.rb', line 204 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 temp_model = SquareConnect.const_get(type).new temp_model.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
270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/square_connect/models/create_customer_request.rb', line 270 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) ⇒ Object
Builds the object from hash
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/square_connect/models/create_customer_request.rb', line 183 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.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
170 171 172 |
# File 'lib/square_connect/models/create_customer_request.rb', line 170 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
176 177 178 |
# File 'lib/square_connect/models/create_customer_request.rb', line 176 def hash [idempotency_key, given_name, family_name, company_name, nickname, email_address, address, phone_number, reference_id, note, birthday].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
139 140 141 142 |
# File 'lib/square_connect/models/create_customer_request.rb', line 139 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
250 251 252 |
# File 'lib/square_connect/models/create_customer_request.rb', line 250 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
256 257 258 259 260 261 262 263 264 |
# File 'lib/square_connect/models/create_customer_request.rb', line 256 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
244 245 246 |
# File 'lib/square_connect/models/create_customer_request.rb', line 244 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
146 147 148 |
# File 'lib/square_connect/models/create_customer_request.rb', line 146 def valid? return true end |