Class: Printful::Address
- Inherits:
-
Object
- Object
- Printful::Address
- Defined in:
- lib/printful_client/models/address.rb
Overview
Information about the address
Instance Attribute Summary collapse
-
#address1 ⇒ Object
Address line 1.
-
#address2 ⇒ Object
Address line 2.
-
#city ⇒ Object
City.
-
#company ⇒ Object
Company name.
-
#country_code ⇒ Object
Country code.
-
#country_name ⇒ Object
Country name.
-
#email ⇒ Object
Email address.
-
#name ⇒ Object
Full name.
-
#phone ⇒ Object
Phone number.
-
#state_code ⇒ Object
State code.
-
#state_name ⇒ Object
State name.
-
#tax_number ⇒ Object
TAX number (‘optional`, but in case of Brazil country this field becomes `required` and will be used as CPF/CNPJ number)
CPF format is 000.000.000-00 (14 characters);
CNPJ format is 00.000.000/0000-00 (18 characters). -
#zip ⇒ Object
ZIP/Postal code.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.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.
-
.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.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Address
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 = {}) ⇒ Address
Initializes the object
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 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/printful_client/models/address.rb', line 109 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Printful::Address` 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 `Printful::Address`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'company') self.company = attributes[:'company'] end if attributes.key?(:'address1') self.address1 = attributes[:'address1'] end if attributes.key?(:'address2') self.address2 = attributes[:'address2'] end if attributes.key?(:'city') self.city = attributes[:'city'] end if attributes.key?(:'state_code') self.state_code = attributes[:'state_code'] end if attributes.key?(:'state_name') self.state_name = attributes[:'state_name'] end if attributes.key?(:'country_code') self.country_code = attributes[:'country_code'] end if attributes.key?(:'country_name') self.country_name = attributes[:'country_name'] end if attributes.key?(:'zip') self.zip = attributes[:'zip'] end if attributes.key?(:'phone') self.phone = attributes[:'phone'] end if attributes.key?(:'email') self.email = attributes[:'email'] end if attributes.key?(:'tax_number') self.tax_number = attributes[:'tax_number'] end end |
Instance Attribute Details
#address1 ⇒ Object
Address line 1
26 27 28 |
# File 'lib/printful_client/models/address.rb', line 26 def address1 @address1 end |
#address2 ⇒ Object
Address line 2
29 30 31 |
# File 'lib/printful_client/models/address.rb', line 29 def address2 @address2 end |
#city ⇒ Object
City
32 33 34 |
# File 'lib/printful_client/models/address.rb', line 32 def city @city end |
#company ⇒ Object
Company name
23 24 25 |
# File 'lib/printful_client/models/address.rb', line 23 def company @company end |
#country_code ⇒ Object
Country code
41 42 43 |
# File 'lib/printful_client/models/address.rb', line 41 def country_code @country_code end |
#country_name ⇒ Object
Country name
44 45 46 |
# File 'lib/printful_client/models/address.rb', line 44 def country_name @country_name end |
#email ⇒ Object
Email address
53 54 55 |
# File 'lib/printful_client/models/address.rb', line 53 def email @email end |
#name ⇒ Object
Full name
20 21 22 |
# File 'lib/printful_client/models/address.rb', line 20 def name @name end |
#phone ⇒ Object
Phone number
50 51 52 |
# File 'lib/printful_client/models/address.rb', line 50 def phone @phone end |
#state_code ⇒ Object
State code
35 36 37 |
# File 'lib/printful_client/models/address.rb', line 35 def state_code @state_code end |
#state_name ⇒ Object
State name
38 39 40 |
# File 'lib/printful_client/models/address.rb', line 38 def state_name @state_name end |
#tax_number ⇒ Object
TAX number (‘optional`, but in case of Brazil country this field becomes `required` and will be used as CPF/CNPJ number)
CPF format is 000.000.000-00 (14 characters);
CNPJ format is 00.000.000/0000-00 (18 characters).
56 57 58 |
# File 'lib/printful_client/models/address.rb', line 56 def tax_number @tax_number end |
#zip ⇒ Object
ZIP/Postal code
47 48 49 |
# File 'lib/printful_client/models/address.rb', line 47 def zip @zip end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/printful_client/models/address.rb', line 249 def self._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 # models (e.g. Pet) or oneOf klass = Printful.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
78 79 80 |
# File 'lib/printful_client/models/address.rb', line 78 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/printful_client/models/address.rb', line 59 def self.attribute_map { :'name' => :'name', :'company' => :'company', :'address1' => :'address1', :'address2' => :'address2', :'city' => :'city', :'state_code' => :'state_code', :'state_name' => :'state_name', :'country_code' => :'country_code', :'country_name' => :'country_name', :'zip' => :'zip', :'phone' => :'phone', :'email' => :'email', :'tax_number' => :'tax_number' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/printful_client/models/address.rb', line 225 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif 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) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
102 103 104 105 |
# File 'lib/printful_client/models/address.rb', line 102 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/printful_client/models/address.rb', line 83 def self.openapi_types { :'name' => :'String', :'company' => :'String', :'address1' => :'String', :'address2' => :'String', :'city' => :'String', :'state_code' => :'String', :'state_name' => :'String', :'country_code' => :'String', :'country_name' => :'String', :'zip' => :'String', :'phone' => :'String', :'email' => :'String', :'tax_number' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/printful_client/models/address.rb', line 192 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && company == o.company && address1 == o.address1 && address2 == o.address2 && city == o.city && state_code == o.state_code && state_name == o.state_name && country_code == o.country_code && country_name == o.country_name && zip == o.zip && phone == o.phone && email == o.email && tax_number == o.tax_number end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/printful_client/models/address.rb', line 320 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 |
#eql?(o) ⇒ Boolean
212 213 214 |
# File 'lib/printful_client/models/address.rb', line 212 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
218 219 220 |
# File 'lib/printful_client/models/address.rb', line 218 def hash [name, company, address1, address2, city, state_code, state_name, country_code, country_name, zip, phone, email, tax_number].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
177 178 179 180 181 |
# File 'lib/printful_client/models/address.rb', line 177 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
296 297 298 |
# File 'lib/printful_client/models/address.rb', line 296 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/printful_client/models/address.rb', line 302 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.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
290 291 292 |
# File 'lib/printful_client/models/address.rb', line 290 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
185 186 187 188 |
# File 'lib/printful_client/models/address.rb', line 185 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end |