Class: CyberSource::Ptsv2paymentsOrderInformationShippingDetails

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

Overview

Contains shipping information not related to address.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsOrderInformationShippingDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 55

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

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

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

Instance Attribute Details

#gift_wrap ⇒ Object

Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping.



18
19
20
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 18

def gift_wrap
  @gift_wrap
end

#ship_from_postal_code ⇒ Object

Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is the postal code associated with your CyberSource account. The postal code must consist of 5 to 9 digits. 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 This field is frequently used for Level II and Level III transactions.



24
25
26
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 24

def ship_from_postal_code
  @ship_from_postal_code
end

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



21
22
23
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 21

def shipping_method
  @shipping_method
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 27

def self.attribute_map
  {
    :'gift_wrap' => :'giftWrap',
    :'shipping_method' => :'shippingMethod',
    :'ship_from_postal_code' => :'shipFromPostalCode'
  }
end

.json_map ⇒ Object

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



36
37
38
39
40
41
42
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 36

def self.json_map
  {
    :'gift_wrap' => :'gift_wrap',
    :'shipping_method' => :'shipping_method',
    :'ship_from_postal_code' => :'ship_from_postal_code'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'gift_wrap' => :'BOOLEAN',
    :'shipping_method' => :'String',
    :'ship_from_postal_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



101
102
103
104
105
106
107
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 101

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      gift_wrap == o.gift_wrap &&
      shipping_method == o.shipping_method &&
      ship_from_postal_code == o.ship_from_postal_code
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



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/ptsv2payments_order_information_shipping_details.rb', line 145

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



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 211

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 124

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


111
112
113
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 111

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 117

def hash
  [gift_wrap, shipping_method, ship_from_postal_code].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



76
77
78
79
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 76

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



191
192
193
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 191

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



197
198
199
200
201
202
203
204
205
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 197

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



185
186
187
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 185

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



83
84
85
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb', line 83

def valid?
  true
end