Class: CyberSource::Ptsv2paymentsOrderInformationShipTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsOrderInformationShipTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 106

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

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

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

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

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

  if attributes.has_key?(:'destinationTypes')
    self.destination_types = attributes[:'destinationTypes']
  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.



24
25
26
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_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/ptsv2payments_order_information_ship_to.rb', line 27

def address2
  @address2
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) 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.



33
34
35
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 33

def administrative_area
  @administrative_area
end

#building_number ⇒ Object

Building number in the street address. For example, the building number is 187 in the following address: Rua da Quitanda 187



45
46
47
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 45

def building_number
  @building_number
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)



51
52
53
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 51

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.



39
40
41
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 39

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



57
58
59
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 57

def destination_code
  @destination_code
end

#destination_types ⇒ Object

Shipping destination of item. Example: Commercial, Residential, Store



54
55
56
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 54

def destination_types
  @destination_types
end

#district ⇒ Object

Neighborhood, community, or region within a city or municipality.



42
43
44
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 42

def district
  @district
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/ptsv2payments_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/ptsv2payments_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/ptsv2payments_order_information_ship_to.rb', line 30

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



60
61
62
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 60

def method
  @method
end

#phone_number ⇒ Object

Phone number associated with the shipping address.



48
49
50
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 48

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/ptsv2payments_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.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 63

def self.attribute_map
  {
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'postal_code' => :'postalCode',
    :'country' => :'country',
    :'district' => :'district',
    :'building_number' => :'buildingNumber',
    :'phone_number' => :'phoneNumber',
    :'company' => :'company',
    :'destination_types' => :'destinationTypes',
    :'destination_code' => :'destinationCode',
    :'method' => :'method'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 84

def self.swagger_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'address1' => :'String',
    :'address2' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String',
    :'district' => :'String',
    :'building_number' => :'String',
    :'phone_number' => :'String',
    :'company' => :'String',
    :'destination_types' => :'String',
    :'destination_code' => :'Integer',
    :'method' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 398

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 &&
      country == o.country &&
      district == o.district &&
      building_number == o.building_number &&
      phone_number == o.phone_number &&
      company == o.company &&
      destination_types == o.destination_types &&
      destination_code == o.destination_code &&
      method == o.method
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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 454

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



520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 520

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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 433

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


420
421
422
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 420

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



426
427
428
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 426

def hash
  [first_name, last_name, address1, address2, locality, administrative_area, postal_code, country, district, building_number, phone_number, company, destination_types, destination_code, method].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



175
176
177
178
179
180
181
182
183
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 175

def list_invalid_properties
  invalid_properties = Array.new
  if !@first_name.nil? && @first_name.to_s.length > 60
    invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 60.')
  end

  if !@last_name.nil? && @last_name.to_s.length > 60
    invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 60.')
  end

  if !@address1.nil? && @address1.to_s.length > 60
    invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 60.')
  end

  if !@address2.nil? && @address2.to_s.length > 60
    invalid_properties.push('invalid value for "address2", the character length must be smaller than or equal to 60.')
  end

  if !@locality.nil? && @locality.to_s.length > 50
    invalid_properties.push('invalid value for "locality", the character length must be smaller than or equal to 50.')
  end

  if !@administrative_area.nil? && @administrative_area.to_s.length > 2
    invalid_properties.push('invalid value for "administrative_area", the character length must be smaller than or equal to 2.')
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 10
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 10.')
  end

  if !@country.nil? && @country.to_s.length > 2
    invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
  end

  if !@district.nil? && @district.to_s.length > 50
    invalid_properties.push('invalid value for "district", the character length must be smaller than or equal to 50.')
  end

  if !@building_number.nil? && @building_number.to_s.length > 15
    invalid_properties.push('invalid value for "building_number", the character length must be smaller than or equal to 15.')
  end

  if !@phone_number.nil? && @phone_number.to_s.length > 15
    invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 15.')
  end

  if !@company.nil? && @company.to_s.length > 60
    invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 60.')
  end

  if !@destination_types.nil? && @destination_types.to_s.length > 25
    invalid_properties.push('invalid value for "destination_types", the character length must be smaller than or equal to 25.')
  end

  if !@method.nil? && @method.to_s.length > 10
    invalid_properties.push('invalid value for "method", the character length must be smaller than or equal to 10.')
  end

  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



500
501
502
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 500

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



506
507
508
509
510
511
512
513
514
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 506

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



494
495
496
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 494

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 238

def valid?
  return false if !@first_name.nil? && @first_name.to_s.length > 60
  return false if !@last_name.nil? && @last_name.to_s.length > 60
  return false if !@address1.nil? && @address1.to_s.length > 60
  return false if !@address2.nil? && @address2.to_s.length > 60
  return false if !@locality.nil? && @locality.to_s.length > 50
  return false if !@administrative_area.nil? && @administrative_area.to_s.length > 2
  return false if !@postal_code.nil? && @postal_code.to_s.length > 10
  return false if !@country.nil? && @country.to_s.length > 2
  return false if !@district.nil? && @district.to_s.length > 50
  return false if !@building_number.nil? && @building_number.to_s.length > 15
  return false if !@phone_number.nil? && @phone_number.to_s.length > 15
  return false if !@company.nil? && @company.to_s.length > 60
  return false if !@destination_types.nil? && @destination_types.to_s.length > 25
  return false if !@method.nil? && @method.to_s.length > 10
  true
end