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



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

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

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

  if attributes.has_key?(:'middleName')
    self.middle_name = attributes[:'middleName']
  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?(:'county')
    self.county = attributes[:'county']
  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?(:'email')
    self.email = attributes[:'email']
  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.



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

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.



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

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



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

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



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

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)



62
63
64
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 62

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.



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

def country
  @country
end

#county ⇒ Object

U.S. county if available.



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

def county
  @county
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



68
69
70
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 68

def destination_code
  @destination_code
end

#destination_types ⇒ Object

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



65
66
67
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 65

def destination_types
  @destination_types
end

#district ⇒ Object

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



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

def district
  @district
end

#email ⇒ Object

Email of the recipient.



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

def email
  @email
end

#first_name ⇒ Object

First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.



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

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.



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

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



71
72
73
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 71

def method
  @method
end

#middle_name ⇒ Object

Middle name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field.



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

def middle_name
  @middle_name
end

#phone_number ⇒ Object

Phone number associated with the shipping address.



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

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.



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

def postal_code
  @postal_code
end

#title ⇒ Object

The title of the person receiving the product.



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

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 74

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

.json_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 99

def self.json_map
  {
    :'title' => :'title',
    :'first_name' => :'first_name',
    :'middle_name' => :'middle_name',
    :'last_name' => :'last_name',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'locality' => :'locality',
    :'administrative_area' => :'administrative_area',
    :'postal_code' => :'postal_code',
    :'county' => :'county',
    :'country' => :'country',
    :'district' => :'district',
    :'building_number' => :'building_number',
    :'phone_number' => :'phone_number',
    :'email' => :'email',
    :'company' => :'company',
    :'destination_types' => :'destination_types',
    :'destination_code' => :'destination_code',
    :'method' => :'method'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 124

def self.swagger_types
  {
    :'title' => :'String',
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'address1' => :'String',
    :'address2' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'postal_code' => :'String',
    :'county' => :'String',
    :'country' => :'String',
    :'district' => :'String',
    :'building_number' => :'String',
    :'phone_number' => :'String',
    :'email' => :'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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 356

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      first_name == o.first_name &&
      middle_name == o.middle_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 &&
      county == o.county &&
      country == o.country &&
      district == o.district &&
      building_number == o.building_number &&
      phone_number == o.phone_number &&
      email == o.email &&
      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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 416

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



482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 482

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



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 395

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


382
383
384
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 382

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



388
389
390
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 388

def hash
  [title, first_name, middle_name, last_name, address1, address2, locality, administrative_area, postal_code, county, country, district, building_number, phone_number, email, 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



235
236
237
238
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 235

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



462
463
464
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 462

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



468
469
470
471
472
473
474
475
476
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 468

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



456
457
458
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 456

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



242
243
244
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb', line 242

def valid?
  true
end