Class: UltracartClient::OrderChannelPartner

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderChannelPartner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



86
87
88
89
90
91
92
93
94
95
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
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 86

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

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

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

Instance Attribute Details

#auto_approve_purchase_order ⇒ Object

If true, any purchase order submitted is automatically approved



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

def auto_approve_purchase_order
  @auto_approve_purchase_order
end

#channel_partner_code ⇒ Object

The code of the channel partner



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

def channel_partner_code
  @channel_partner_code
end

#channel_partner_data ⇒ Object

Additional data provided by the channel partner, read-only



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

def channel_partner_data
  @channel_partner_data
end

#channel_partner_oid ⇒ Object

Channel partner object identifier, read-only and available on existing channel orders only.



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

def channel_partner_oid
  @channel_partner_oid
end

#channel_partner_order_id ⇒ Object

The order ID assigned by the channel partner for this order.



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

def channel_partner_order_id
  @channel_partner_order_id
end

#ignore_invalid_shipping_method ⇒ Object

Set to true to ignore invalid shipping method being specified. Only applicable on inserting orders.



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

def ignore_invalid_shipping_method
  @ignore_invalid_shipping_method
end

#no_realtime_payment_processing ⇒ Object

Indicates this order should be placed in Account Receivable for later payment processing



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

def no_realtime_payment_processing
  @no_realtime_payment_processing
end

#skip_payment_processing ⇒ Object

Indicates this order was already paid for via a channel purchase and no payment collection should be attempted



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

def skip_payment_processing
  @skip_payment_processing
end

#store_completed ⇒ Object

Instructs UltraCart to skip shipping department and mark this order as fully complete. This flag defaults to true. Set this flag to false to shipped product for this order.



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

def store_completed
  @store_completed
end

#store_if_payment_declines ⇒ Object

If true, any failed payment will place the order in Accounts Receivable rather than rejecting it.



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

def store_if_payment_declines
  @store_if_payment_declines
end

#treat_warnings_as_errors ⇒ Object

Any warnings are raised as errors and halt the import of the order



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

def treat_warnings_as_errors
  @treat_warnings_as_errors
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 51

def self.attribute_map
  {
    :'auto_approve_purchase_order' => :'auto_approve_purchase_order',
    :'channel_partner_code' => :'channel_partner_code',
    :'channel_partner_data' => :'channel_partner_data',
    :'channel_partner_oid' => :'channel_partner_oid',
    :'channel_partner_order_id' => :'channel_partner_order_id',
    :'ignore_invalid_shipping_method' => :'ignore_invalid_shipping_method',
    :'no_realtime_payment_processing' => :'no_realtime_payment_processing',
    :'skip_payment_processing' => :'skip_payment_processing',
    :'store_completed' => :'store_completed',
    :'store_if_payment_declines' => :'store_if_payment_declines',
    :'treat_warnings_as_errors' => :'treat_warnings_as_errors'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 68

def self.swagger_types
  {
    :'auto_approve_purchase_order' => :'BOOLEAN',
    :'channel_partner_code' => :'String',
    :'channel_partner_data' => :'String',
    :'channel_partner_oid' => :'Integer',
    :'channel_partner_order_id' => :'String',
    :'ignore_invalid_shipping_method' => :'BOOLEAN',
    :'no_realtime_payment_processing' => :'BOOLEAN',
    :'skip_payment_processing' => :'BOOLEAN',
    :'store_completed' => :'BOOLEAN',
    :'store_if_payment_declines' => :'BOOLEAN',
    :'treat_warnings_as_errors' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 167

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_data == o.channel_partner_data &&
      channel_partner_oid == o.channel_partner_oid &&
      channel_partner_order_id == o.channel_partner_order_id &&
      ignore_invalid_shipping_method == o.ignore_invalid_shipping_method &&
      no_realtime_payment_processing == o.no_realtime_payment_processing &&
      skip_payment_processing == o.skip_payment_processing &&
      store_completed == o.store_completed &&
      store_if_payment_declines == o.store_if_payment_declines &&
      treat_warnings_as_errors == o.treat_warnings_as_errors
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 219

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 285

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 198

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


185
186
187
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 191

def hash
  [auto_approve_purchase_order, channel_partner_code, channel_partner_data, channel_partner_oid, channel_partner_order_id, ignore_invalid_shipping_method, no_realtime_payment_processing, skip_payment_processing, store_completed, store_if_payment_declines, treat_warnings_as_errors].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



139
140
141
142
143
144
145
146
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 139

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



265
266
267
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 265

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



271
272
273
274
275
276
277
278
279
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 271

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



259
260
261
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 259

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



150
151
152
153
 
# File 'lib/ultracart_api/models/order_channel_partner.rb', line 150

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