Class: CyberSource::Riskv1decisionsOrderInformationShipTo
- Inherits:
-
Object
- Object
- CyberSource::Riskv1decisionsOrderInformationShipTo
- Defined in:
- lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb
Instance Attribute Summary collapse
-
#address1 ⇒ Object
First line of the shipping address.
-
#address2 ⇒ Object
Second line of the shipping address.
-
#address3 ⇒ Object
Third line of the shipping address.
-
#administrative_area ⇒ Object
State or province of the shipping address.
-
#country ⇒ Object
Country of the shipping address.
-
#destination_code ⇒ Object
Indicates destination chosen for the transaction.
-
#destination_types ⇒ Object
Shipping destination of item.
-
#first_name ⇒ Object
First name of the recipient.
-
#last_name ⇒ Object
Last name of the recipient.
-
#locality ⇒ Object
City of the shipping address.
-
#method ⇒ Object
Shipping method for the product.
-
#middle_name ⇒ Object
Middle name of the recipient.
-
#phone_number ⇒ Object
Phone number associated with the shipping address.
-
#postal_code ⇒ Object
Postal code for the shipping address.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.json_map ⇒ Object
Attribute mapping from JSON key to ruby-style variable name.
-
.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 = {}) ⇒ Riskv1decisionsOrderInformationShipTo
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 = {}) ⇒ Riskv1decisionsOrderInformationShipTo
Initializes the object
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 174 175 176 177 178 179 180 181 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 120 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?(:'address1') self.address1 = attributes[:'address1'] end if attributes.has_key?(:'address2') self.address2 = attributes[:'address2'] end if attributes.has_key?(:'address3') self.address3 = attributes[:'address3'] end if attributes.has_key?(:'administrativeArea') self.administrative_area = attributes[:'administrativeArea'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end if attributes.has_key?(:'destinationTypes') self.destination_types = attributes[:'destinationTypes'] end if attributes.has_key?(:'locality') self.locality = attributes[:'locality'] end if attributes.has_key?(:'firstName') self.first_name = attributes[:'firstName'] end if attributes.has_key?(:'lastName') self.last_name = attributes[:'lastName'] end if attributes.has_key?(:'middleName') self.middle_name = attributes[:'middleName'] end if attributes.has_key?(:'phoneNumber') self.phone_number = attributes[:'phoneNumber'] end if attributes.has_key?(:'postalCode') self.postal_code = attributes[:'postalCode'] end if attributes.has_key?(:'destinationCode') self.destination_code = attributes[:'destinationCode'] end if attributes.has_key?(:'method') self.method = attributes[:'method'] end end |
Instance Attribute Details
#address1 ⇒ Object
First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
17 18 19 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 17 def address1 @address1 end |
#address2 ⇒ Object
Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
20 21 22 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 20 def address2 @address2 end |
#address3 ⇒ Object
Third line of the shipping address. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
23 24 25 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 23 def address3 @address3 end |
#administrative_area ⇒ Object
State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
26 27 28 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 26 def administrative_area @administrative_area end |
#country ⇒ Object
Country of the shipping address. Use the two-character [ISO Standard Country Codes.](apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
29 30 31 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 29 def country @country end |
#destination_code ⇒ Object
Indicates destination chosen for the transaction. Possible values: - 01- Ship to cardholder billing address - 02- Ship to another verified address on file with merchant - 03- Ship to address that is different than billing address - 04- Ship to store (store address should be populated on request) - 05- Digital goods - 06- Travel and event tickets, not shipped - 07- Other
53 54 55 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 53 def destination_code @destination_code end |
#destination_types ⇒ Object
Shipping destination of item. Example: Commercial, Residential, Store
32 33 34 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 32 def destination_types @destination_types end |
#first_name ⇒ Object
First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.
38 39 40 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 38 def first_name @first_name end |
#last_name ⇒ Object
Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.
41 42 43 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 41 def last_name @last_name end |
#locality ⇒ Object
City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
35 36 37 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 35 def locality @locality end |
#method ⇒ Object
Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription Required for American Express SafeKey (U.S.).
56 57 58 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 56 def method @method end |
#middle_name ⇒ Object
Middle name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.
44 45 46 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 44 def middle_name @middle_name end |
#phone_number ⇒ Object
Phone number associated with the shipping address.
47 48 49 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 47 def phone_number @phone_number end |
#postal_code ⇒ Object
Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][alpha][numeric][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
50 51 52 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 50 def postal_code @postal_code end |
Class Method Details
.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 76 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 59 def self.attribute_map { :'address1' => :'address1', :'address2' => :'address2', :'address3' => :'address3', :'administrative_area' => :'administrativeArea', :'country' => :'country', :'destination_types' => :'destinationTypes', :'locality' => :'locality', :'first_name' => :'firstName', :'last_name' => :'lastName', :'middle_name' => :'middleName', :'phone_number' => :'phoneNumber', :'postal_code' => :'postalCode', :'destination_code' => :'destinationCode', :'method' => :'method' } end |
.json_map ⇒ Object
Attribute mapping from JSON key to ruby-style variable name.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 79 def self.json_map { :'address1' => :'address1', :'address2' => :'address2', :'address3' => :'address3', :'administrative_area' => :'administrative_area', :'country' => :'country', :'destination_types' => :'destination_types', :'locality' => :'locality', :'first_name' => :'first_name', :'last_name' => :'last_name', :'middle_name' => :'middle_name', :'phone_number' => :'phone_number', :'postal_code' => :'postal_code', :'destination_code' => :'destination_code', :'method' => :'method' } end |
.swagger_types ⇒ Object
Attribute type mapping.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 99 def self.swagger_types { :'address1' => :'String', :'address2' => :'String', :'address3' => :'String', :'administrative_area' => :'String', :'country' => :'String', :'destination_types' => :'String', :'locality' => :'String', :'first_name' => :'String', :'last_name' => :'String', :'middle_name' => :'String', :'phone_number' => :'String', :'postal_code' => :'String', :'destination_code' => :'Integer', :'method' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 276 def ==(o) return true if self.equal?(o) self.class == o.class && address1 == o.address1 && address2 == o.address2 && address3 == o.address3 && administrative_area == o.administrative_area && country == o.country && destination_types == o.destination_types && locality == o.locality && first_name == o.first_name && last_name == o.last_name && middle_name == o.middle_name && phone_number == o.phone_number && postal_code == o.postal_code && destination_code == o.destination_code && method == o.method end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 331 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 = CyberSource.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
397 398 399 400 401 402 403 404 405 406 407 408 409 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 397 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
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 310 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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{self.class.json_map[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
297 298 299 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 297 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
303 304 305 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 303 def hash [address1, address2, address3, administrative_area, country, destination_types, locality, first_name, last_name, middle_name, phone_number, postal_code, destination_code, method].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
185 186 187 188 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 185 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
377 378 379 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 377 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
383 384 385 386 387 388 389 390 391 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 383 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
371 372 373 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 371 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
192 193 194 |
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 192 def valid? true end |