Class: UltracartClient::CartFinalizeOrderRequestOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/cart_finalize_order_request_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CartFinalizeOrderRequestOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
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
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 96

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_approve_purchase_order ⇒ Object

Automatically approve the purchase order



18
19
20
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 18

def auto_approve_purchase_order
  @auto_approve_purchase_order
end

#channel_partner_code ⇒ Object

Channel partner code to associate this order with



21
22
23
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 21

def channel_partner_code
  @channel_partner_code
end

#channel_partner_oid ⇒ Object

Channel partner oid to associate this order with



24
25
26
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 24

def channel_partner_oid
  @channel_partner_oid
end

#channel_partner_order_id ⇒ Object

Channel partner order id for reference



27
28
29
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 27

def channel_partner_order_id
  @channel_partner_order_id
end

#consider_recurring ⇒ Object

Consider this order a recurring order for the purposes of payment gateway recurring flag



30
31
32
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 30

def consider_recurring
  @consider_recurring
end

#credit_card_authorization_amount ⇒ Object

If the order was authorized outside of UltraCart, this is the amount of the authorization



33
34
35
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 33

def credit_card_authorization_amount
  @credit_card_authorization_amount
end

#credit_card_authorization_date ⇒ Object

If the order was authorized outside of UltraCart, this is the date/time of the authorization



36
37
38
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 36

def credit_card_authorization_date
  @credit_card_authorization_date
end

#credit_card_authorization_reference_number ⇒ Object

If the order was authorized outside of UltraCart, this is the authorization reference number



39
40
41
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 39

def credit_card_authorization_reference_number
  @credit_card_authorization_reference_number
end

#no_realtime_payment_processing ⇒ Object

Prevents normal real-time processing of the payment and sends the order to Accounts Receivable



42
43
44
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 42

def no_realtime_payment_processing
  @no_realtime_payment_processing
end

#setup_next_cart ⇒ Object

True if the system should create another cart automatically if the current cart was logged into a profile



45
46
47
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 45

def setup_next_cart
  @setup_next_cart
end

#skip_payment_processing ⇒ Object

Skip payment processing and move the order on to shipping (or completed if no shipping required)



48
49
50
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 48

def skip_payment_processing
  @skip_payment_processing
end

#store_completed ⇒ Object

True the order in the completed stage



51
52
53
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 51

def store_completed
  @store_completed
end

#store_if_payment_declines ⇒ Object

Store the order in accounts receivable if the payment declines



54
55
56
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 54

def store_if_payment_declines
  @store_if_payment_declines
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 57

def self.attribute_map
  {
    :'auto_approve_purchase_order' => :'auto_approve_purchase_order',
    :'channel_partner_code' => :'channel_partner_code',
    :'channel_partner_oid' => :'channel_partner_oid',
    :'channel_partner_order_id' => :'channel_partner_order_id',
    :'consider_recurring' => :'consider_recurring',
    :'credit_card_authorization_amount' => :'credit_card_authorization_amount',
    :'credit_card_authorization_date' => :'credit_card_authorization_date',
    :'credit_card_authorization_reference_number' => :'credit_card_authorization_reference_number',
    :'no_realtime_payment_processing' => :'no_realtime_payment_processing',
    :'setup_next_cart' => :'setup_next_cart',
    :'skip_payment_processing' => :'skip_payment_processing',
    :'store_completed' => :'store_completed',
    :'store_if_payment_declines' => :'store_if_payment_declines'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 76

def self.swagger_types
  {
    :'auto_approve_purchase_order' => :'BOOLEAN',
    :'channel_partner_code' => :'String',
    :'channel_partner_oid' => :'Integer',
    :'channel_partner_order_id' => :'String',
    :'consider_recurring' => :'BOOLEAN',
    :'credit_card_authorization_amount' => :'Float',
    :'credit_card_authorization_date' => :'String',
    :'credit_card_authorization_reference_number' => :'String',
    :'no_realtime_payment_processing' => :'BOOLEAN',
    :'setup_next_cart' => :'BOOLEAN',
    :'skip_payment_processing' => :'BOOLEAN',
    :'store_completed' => :'BOOLEAN',
    :'store_if_payment_declines' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_approve_purchase_order == o.auto_approve_purchase_order &&
      channel_partner_code == o.channel_partner_code &&
      channel_partner_oid == o.channel_partner_oid &&
      channel_partner_order_id == o.channel_partner_order_id &&
      consider_recurring == o.consider_recurring &&
      credit_card_authorization_amount == o.credit_card_authorization_amount &&
      credit_card_authorization_date == o.credit_card_authorization_date &&
      credit_card_authorization_reference_number == o.credit_card_authorization_reference_number &&
      no_realtime_payment_processing == o.no_realtime_payment_processing &&
      setup_next_cart == o.setup_next_cart &&
      skip_payment_processing == o.skip_payment_processing &&
      store_completed == o.store_completed &&
      store_if_payment_declines == o.store_if_payment_declines
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 239

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 = UltracartClient.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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 305

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 218

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


205
206
207
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 211

def hash
  [auto_approve_purchase_order, channel_partner_code, channel_partner_oid, channel_partner_order_id, consider_recurring, credit_card_authorization_amount, credit_card_authorization_date, credit_card_authorization_reference_number, no_realtime_payment_processing, setup_next_cart, skip_payment_processing, store_completed, store_if_payment_declines].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



157
158
159
160
161
162
163
164
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  if !@credit_card_authorization_reference_number.nil? && @credit_card_authorization_reference_number.to_s.length > 60
    invalid_properties.push('invalid value for "credit_card_authorization_reference_number", the character length must be smaller than or equal to 60.')
  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



285
286
287
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 291

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



279
280
281
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 279

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



168
169
170
171
 
# File 'lib/ultracart_api/models/cart_finalize_order_request_options.rb', line 168

def valid?
  return false if !@credit_card_authorization_reference_number.nil? && @credit_card_authorization_reference_number.to_s.length > 60
  true
end