Class: CyberSource::Ptsv2paymentsidcapturesOrderInformationShipTo

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsidcapturesOrderInformationShipTo

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 66

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?(:'administrativeArea')
    self.administrative_area = attributes[:'administrativeArea']
  end

  if attributes.has_key?(:'country')
    self.country = attributes[:'country']
  end

  if attributes.has_key?(:'postalCode')
    self.postal_code = attributes[:'postalCode']
  end

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'county')
    self.county = attributes[:'county']
  end
end

Instance Attribute Details

#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.



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 17

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.



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 20

def country
  @country
end

#county ⇒ Object

U.S. county if available.



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 29

def county
  @county
end

#email ⇒ Object

Email of the recipient.



26
27
28
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 26

def email
  @email
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.



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 23

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



32
33
34
35
36
37
38
39
40
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 32

def self.attribute_map
  {
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'postal_code' => :'postalCode',
    :'email' => :'email',
    :'county' => :'county'
  }
end

.json_map ⇒ Object

Attribute mapping from JSON key to ruby-style variable name.



43
44
45
46
47
48
49
50
51
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 43

def self.json_map
  {
    :'administrative_area' => :'administrative_area',
    :'country' => :'country',
    :'postal_code' => :'postal_code',
    :'email' => :'email',
    :'county' => :'county'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 54

def self.swagger_types
  {
    :'administrative_area' => :'String',
    :'country' => :'String',
    :'postal_code' => :'String',
    :'email' => :'String',
    :'county' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      administrative_area == o.administrative_area &&
      country == o.country &&
      postal_code == o.postal_code &&
      email == o.email &&
      county == o.county
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 184

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 250

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 163

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


150
151
152
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



156
157
158
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 156

def hash
  [administrative_area, country, postal_code, email, county].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



95
96
97
98
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 95

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



230
231
232
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 230

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 236

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

Returns:

  • (String) —

    String presentation of the object



224
225
226
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 224

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



102
103
104
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb', line 102

def valid?
  true
end