Class: CyberSource::TssV2TransactionsGet200ResponseOrderInformationShipTo
- Inherits:
-
Object
- Object
- CyberSource::TssV2TransactionsGet200ResponseOrderInformationShipTo
- Defined in:
- lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_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.
-
#administrative_area ⇒ Object
State or province of the billing address.
-
#company ⇒ Object
Name of the customer’s company.
-
#country ⇒ Object
Country of the shipping address.
-
#first_name ⇒ Object
First name of the recipient.
-
#last_name ⇒ Object
Last name of the recipient.
-
#locality ⇒ Object
City of the shipping address.
-
#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 = {}) ⇒ TssV2TransactionsGet200ResponseOrderInformationShipTo
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 = {}) ⇒ TssV2TransactionsGet200ResponseOrderInformationShipTo
Initializes the object
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 136 137 138 139 140 141 142 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 97 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?(:'firstName') self.first_name = attributes[:'firstName'] end if attributes.has_key?(:'lastName') self.last_name = attributes[:'lastName'] end if attributes.has_key?(:'address1') self.address1 = attributes[:'address1'] end if attributes.has_key?(:'address2') self.address2 = attributes[:'address2'] end if attributes.has_key?(:'locality') self.locality = attributes[:'locality'] end if attributes.has_key?(:'administrativeArea') self.administrative_area = attributes[:'administrativeArea'] end if attributes.has_key?(:'postalCode') self.postal_code = attributes[:'postalCode'] end if attributes.has_key?(:'company') self.company = attributes[:'company'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end if attributes.has_key?(:'phoneNumber') self.phone_number = attributes[:'phoneNumber'] 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.
24 25 26 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 24 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.
27 28 29 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 27 def address2 @address2 end |
#administrative_area ⇒ Object
State or province of the billing 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). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when ‘processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
33 34 35 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 33 def administrative_area @administrative_area end |
#company ⇒ Object
Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
39 40 41 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 39 def company @company 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.
42 43 44 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 42 def country @country end |
#first_name ⇒ Object
First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.
18 19 20 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 18 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.
21 22 23 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 21 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.
30 31 32 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 30 def locality @locality end |
#phone_number ⇒ Object
Phone number associated with the shipping address.
45 46 47 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 45 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.
36 37 38 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 36 def postal_code @postal_code end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 48 def self.attribute_map { :'first_name' => :'firstName', :'last_name' => :'lastName', :'address1' => :'address1', :'address2' => :'address2', :'locality' => :'locality', :'administrative_area' => :'administrativeArea', :'postal_code' => :'postalCode', :'company' => :'company', :'country' => :'country', :'phone_number' => :'phoneNumber' } end |
.json_map ⇒ Object
Attribute mapping from JSON key to ruby-style variable name.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 64 def self.json_map { :'first_name' => :'first_name', :'last_name' => :'last_name', :'address1' => :'address1', :'address2' => :'address2', :'locality' => :'locality', :'administrative_area' => :'administrative_area', :'postal_code' => :'postal_code', :'company' => :'company', :'country' => :'country', :'phone_number' => :'phone_number' } end |
.swagger_types ⇒ Object
Attribute type mapping.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 80 def self.swagger_types { :'first_name' => :'String', :'last_name' => :'String', :'address1' => :'String', :'address2' => :'String', :'locality' => :'String', :'administrative_area' => :'String', :'postal_code' => :'String', :'company' => :'String', :'country' => :'String', :'phone_number' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 219 def ==(o) return true if self.equal?(o) self.class == o.class && first_name == o.first_name && last_name == o.last_name && address1 == o.address1 && address2 == o.address2 && locality == o.locality && administrative_area == o.administrative_area && postal_code == o.postal_code && company == o.company && country == o.country && phone_number == o.phone_number end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 270 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
336 337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 336 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
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 249 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
236 237 238 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 236 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
242 243 244 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 242 def hash [first_name, last_name, address1, address2, locality, administrative_area, postal_code, company, country, phone_number].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
146 147 148 149 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 146 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
316 317 318 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 316 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
322 323 324 325 326 327 328 329 330 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 322 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
310 311 312 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 310 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
153 154 155 |
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb', line 153 def valid? true end |