Class: UltracartClient::OrderFormat

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderFormat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ultracart_api/models/order_format.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#context ⇒ Object

The context to generate the order view for.



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

def context
  @context
end

#dont_link_email_to_search ⇒ Object

True to not link the email address to the order search



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

def dont_link_email_to_search
  @dont_link_email_to_search
end

#email_as_link ⇒ Object

True to make the email address a clickable mailto link



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

def email_as_link
  @email_as_link
end

#filter_distribution_center_oid ⇒ Object

Specify a distribution center oid to filter the items displayed to that particular distribution center.



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

def filter_distribution_center_oid
  @filter_distribution_center_oid
end

#filter_to_items_in_container_oid ⇒ Object

The container oid to filter items to.



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

def filter_to_items_in_container_oid
  @filter_to_items_in_container_oid
end

#format ⇒ Object

The desired format.



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

def format
  @format
end

#hide_bill_to_address ⇒ Object

True to ide the bill to address



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

def hide_bill_to_address
  @hide_bill_to_address
end

#hide_price_information ⇒ Object

True to hide price information



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

def hide_price_information
  @hide_price_information
end

#link_file_attachments ⇒ Object

True to link file attachments for download



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

def link_file_attachments
  @link_file_attachments
end

#show_contact_info ⇒ Object

True to show contact information



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

def show_contact_info
  @show_contact_info
end

#show_in_merchant_currency ⇒ Object

True to show the order in the merchant currency



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

def show_in_merchant_currency
  @show_in_merchant_currency
end

#show_internal_information ⇒ Object

True to show internal information about the order



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

def show_internal_information
  @show_internal_information
end

#show_merchant_notes ⇒ Object

True to show merchant notes



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

def show_merchant_notes
  @show_merchant_notes
end

#show_non_sensitive_payment_info ⇒ Object

True to show non-sensitive payment information



57
58
59
 
# File 'lib/ultracart_api/models/order_format.rb', line 57

def show_non_sensitive_payment_info
  @show_non_sensitive_payment_info
end

#show_payment_info ⇒ Object

True to show payment information



60
61
62
 
# File 'lib/ultracart_api/models/order_format.rb', line 60

def show_payment_info
  @show_payment_info
end

#translate ⇒ Object

True to translate the order into the native language of the customer



63
64
65
 
# File 'lib/ultracart_api/models/order_format.rb', line 63

def translate
  @translate
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/ultracart_api/models/order_format.rb', line 88

def self.attribute_map
  {
    :'context' => :'context',
    :'dont_link_email_to_search' => :'dont_link_email_to_search',
    :'email_as_link' => :'email_as_link',
    :'filter_distribution_center_oid' => :'filter_distribution_center_oid',
    :'filter_to_items_in_container_oid' => :'filter_to_items_in_container_oid',
    :'format' => :'format',
    :'hide_bill_to_address' => :'hide_bill_to_address',
    :'hide_price_information' => :'hide_price_information',
    :'link_file_attachments' => :'link_file_attachments',
    :'show_contact_info' => :'show_contact_info',
    :'show_in_merchant_currency' => :'show_in_merchant_currency',
    :'show_internal_information' => :'show_internal_information',
    :'show_merchant_notes' => :'show_merchant_notes',
    :'show_non_sensitive_payment_info' => :'show_non_sensitive_payment_info',
    :'show_payment_info' => :'show_payment_info',
    :'translate' => :'translate'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/ultracart_api/models/order_format.rb', line 110

def self.swagger_types
  {
    :'context' => :'String',
    :'dont_link_email_to_search' => :'BOOLEAN',
    :'email_as_link' => :'BOOLEAN',
    :'filter_distribution_center_oid' => :'Integer',
    :'filter_to_items_in_container_oid' => :'Integer',
    :'format' => :'String',
    :'hide_bill_to_address' => :'BOOLEAN',
    :'hide_price_information' => :'BOOLEAN',
    :'link_file_attachments' => :'BOOLEAN',
    :'show_contact_info' => :'BOOLEAN',
    :'show_in_merchant_currency' => :'BOOLEAN',
    :'show_internal_information' => :'BOOLEAN',
    :'show_merchant_notes' => :'BOOLEAN',
    :'show_non_sensitive_payment_info' => :'BOOLEAN',
    :'show_payment_info' => :'BOOLEAN',
    :'translate' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/ultracart_api/models/order_format.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      context == o.context &&
      dont_link_email_to_search == o.dont_link_email_to_search &&
      email_as_link == o.email_as_link &&
      filter_distribution_center_oid == o.filter_distribution_center_oid &&
      filter_to_items_in_container_oid == o.filter_to_items_in_container_oid &&
      format == o.format &&
      hide_bill_to_address == o.hide_bill_to_address &&
      hide_price_information == o.hide_price_information &&
      link_file_attachments == o.link_file_attachments &&
      show_contact_info == o.show_contact_info &&
      show_in_merchant_currency == o.show_in_merchant_currency &&
      show_internal_information == o.show_internal_information &&
      show_merchant_notes == o.show_merchant_notes &&
      show_non_sensitive_payment_info == o.show_non_sensitive_payment_info &&
      show_payment_info == o.show_payment_info &&
      translate == o.translate
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ultracart_api/models/order_format.rb', line 288

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/ultracart_api/models/order_format.rb', line 354

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/ultracart_api/models/order_format.rb', line 267

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


254
255
256
 
# File 'lib/ultracart_api/models/order_format.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/ultracart_api/models/order_format.rb', line 260

def hash
  [context, dont_link_email_to_search, email_as_link, filter_distribution_center_oid, filter_to_items_in_container_oid, format, hide_bill_to_address, hide_price_information, link_file_attachments, show_contact_info, show_in_merchant_currency, show_internal_information, show_merchant_notes, show_non_sensitive_payment_info, show_payment_info, translate].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



206
207
208
209
 
# File 'lib/ultracart_api/models/order_format.rb', line 206

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



334
335
336
 
# File 'lib/ultracart_api/models/order_format.rb', line 334

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



340
341
342
343
344
345
346
347
348
 
# File 'lib/ultracart_api/models/order_format.rb', line 340

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



328
329
330
 
# File 'lib/ultracart_api/models/order_format.rb', line 328

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



213
214
215
216
217
 
# File 'lib/ultracart_api/models/order_format.rb', line 213

def valid?
  format_validator = EnumAttributeValidator.new('String', ['text', 'div', 'table', 'email'])
  return false unless format_validator.valid?(@format)
  true
end