Class: Tradenity::TaxClass

Inherits:
Object
  • Object
show all
Defined in:
lib/tradenity/resources/tax_class.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaxClass

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
# File 'lib/tradenity/resources/tax_class.rb', line 98

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#__metaObject

Returns the value of attribute __meta.



32
33
34
# File 'lib/tradenity/resources/tax_class.rb', line 32

def __meta
  @__meta
end

#created_atObject

Returns the value of attribute created_at.



34
35
36
# File 'lib/tradenity/resources/tax_class.rb', line 34

def created_at
  @created_at
end

#descriptionObject

Returns the value of attribute description.



42
43
44
# File 'lib/tradenity/resources/tax_class.rb', line 42

def description
  @description
end

#nameObject

Returns the value of attribute name.



38
39
40
# File 'lib/tradenity/resources/tax_class.rb', line 38

def name
  @name
end

#slugObject

Returns the value of attribute slug.



40
41
42
# File 'lib/tradenity/resources/tax_class.rb', line 40

def slug
  @slug
end

#statusObject

Returns the value of attribute status.



44
45
46
# File 'lib/tradenity/resources/tax_class.rb', line 44

def status
  @status
end

#updated_atObject

Returns the value of attribute updated_at.



36
37
38
# File 'lib/tradenity/resources/tax_class.rb', line 36

def updated_at
  @updated_at
end

Class Method Details

.api_clientObject



315
316
317
# File 'lib/tradenity/resources/tax_class.rb', line 315

def self.api_client
  ApiClient.default
end

.attribute_mapObject

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



69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/tradenity/resources/tax_class.rb', line 69

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'slug' => :'slug',
    :'description' => :'description',
    :'status' => :'status'
  }
end

.create_tax_class(tax_class, opts = {}) ⇒ TaxClass

Create TaxClass Create a new TaxClass

Parameters:

  • tax_class

    Attributes of taxClass to create

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



388
389
390
391
# File 'lib/tradenity/resources/tax_class.rb', line 388

def create_tax_class(tax_class, opts = {})
  data, _status_code, _headers = create_tax_class_with_http_info(tax_class, opts)
  data
end

.create_tax_class_with_http_info(tax_class, opts = {}) ⇒ Array<(TaxClass, Fixnum, Hash)>

Create TaxClass Create a new TaxClass

Parameters:

  • tax_class

    Attributes of taxClass to create

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(TaxClass, Fixnum, Hash)>)

    TaxClass data, response status code and response headers



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'lib/tradenity/resources/tax_class.rb', line 398

def create_tax_class_with_http_info(tax_class, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxClass.create_tax_class ...'
  end
  # verify the required parameter 'tax_class' is set
  if api_client.config.client_side_validation && tax_class.nil?
    fail ArgumentError, "Missing the required parameter 'tax_class' when calling TaxClass.create_tax_class"
  end
  # resource path
  local_var_path = '/taxClasses'

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(tax_class)
  auth_names = []
  data, status_code, headers = api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaxClass')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxClass#create_tax_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.delete_by_id(id) ⇒ nil

Delete TaxClass Delete an instance of TaxClass by its ID.

Parameters:

  • id

    ID of TaxClass to delete.

Returns:

  • (nil)


379
380
381
# File 'lib/tradenity/resources/tax_class.rb', line 379

def delete_by_id(id)
  delete_tax_class_by_id(id)
end

.delete_tax_class_by_id(tax_class_id, opts = {}) ⇒ nil

Delete TaxClass Delete an instance of TaxClass by its ID.

Parameters:

  • tax_class_id

    ID of taxClass to delete.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (nil)


442
443
444
445
# File 'lib/tradenity/resources/tax_class.rb', line 442

def delete_tax_class_by_id(tax_class_id, opts = {})
  delete_tax_class_by_id_with_http_info(tax_class_id, opts)
  nil
end

.delete_tax_class_by_id_with_http_info(tax_class_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete TaxClass Delete an instance of TaxClass by its ID.

Parameters:

  • tax_class_id

    ID of taxClass to delete.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>)

    nil, response status code and response headers



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# File 'lib/tradenity/resources/tax_class.rb', line 452

def delete_tax_class_by_id_with_http_info(tax_class_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxClass.delete_tax_class_by_id ...'
  end
  # verify the required parameter 'tax_class_id' is set
  if api_client.config.client_side_validation && tax_class_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_class_id' when calling TaxClass.delete_tax_class_by_id"
  end
  # resource path
  local_var_path = '/taxClasses/{taxClassId}'.sub('{' + 'taxClassId' + '}', tax_class_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxClass#delete_tax_class_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.find_allPage<TaxClass>

List TaxClasss Return a list of TaxClasss

Parameters:

  • opts (Hash)

    the optional parameters

Returns:



347
348
349
# File 'lib/tradenity/resources/tax_class.rb', line 347

def find_all
  list_all_tax_classes
end

.find_all_by(opts = {}) ⇒ Page<Collection>

Find List of TaxClass Return multiple instances of TaxClass by its attributes.

Parameters:

  • opts (Hash) (defaults to: {})

    the search parameters

Returns:



355
356
357
# File 'lib/tradenity/resources/tax_class.rb', line 355

def find_all_by(opts = {})
  list_all_tax_classes(opts)
end

.find_by_id(id) ⇒ TaxClass

Find TaxClass Return single instance of TaxClass by its ID.

Parameters:

  • id

    ID of TaxClass to return

Returns:



371
372
373
# File 'lib/tradenity/resources/tax_class.rb', line 371

def find_by_id(id)
  get_tax_class_by_id(id)
end

.find_one_by(opts = {}) ⇒ TaxClass

Find TaxClass by its parameters Return single instance of Collection by its attributes.

Parameters:

  • opts (Hash) (defaults to: {})

    search parameters

Returns:



363
364
365
# File 'lib/tradenity/resources/tax_class.rb', line 363

def find_one_by(opts = {})
  list_all_tax_classes(opts)[0]
end

.get_tax_class_by_id(tax_class_id, opts = {}) ⇒ TaxClass

Find TaxClass Return single instance of TaxClass by its ID.

Parameters:

  • tax_class_id

    ID of taxClass to return

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



495
496
497
498
# File 'lib/tradenity/resources/tax_class.rb', line 495

def get_tax_class_by_id(tax_class_id, opts = {})
  data, _status_code, _headers = get_tax_class_by_id_with_http_info(tax_class_id, opts)
  data
end

.get_tax_class_by_id_with_http_info(tax_class_id, opts = {}) ⇒ Array<(TaxClass, Fixnum, Hash)>

Find TaxClass Return single instance of TaxClass by its ID.

Parameters:

  • tax_class_id

    ID of taxClass to return

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(TaxClass, Fixnum, Hash)>)

    TaxClass data, response status code and response headers



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
# File 'lib/tradenity/resources/tax_class.rb', line 505

def get_tax_class_by_id_with_http_info(tax_class_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxClass.get_tax_class_by_id ...'
  end
  # verify the required parameter 'tax_class_id' is set
  if api_client.config.client_side_validation && tax_class_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_class_id' when calling TaxClass.get_tax_class_by_id"
  end
  # resource path
  local_var_path = '/taxClasses/{taxClassId}'.sub('{' + 'taxClassId' + '}', tax_class_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaxClass')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxClass#get_tax_class_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.list_all_tax_classes(opts = {}) ⇒ Page<TaxClass>

List TaxClasses Return a list of TaxClasses

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number

  • :size (Integer)

    page size

  • :sort (String)

    page order

Returns:



551
552
553
554
# File 'lib/tradenity/resources/tax_class.rb', line 551

def list_all_tax_classes(opts = {})
  data, _status_code, _headers = list_all_tax_classes_with_http_info(opts)
  data
end

.list_all_tax_classes_with_http_info(opts = {}) ⇒ Array<(Page<TaxClass>, Fixnum, Hash)>

List TaxClasses Return a list of TaxClasses

Parameters:

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number

  • :size (Integer)

    page size

  • :sort (String)

    page order

Returns:

  • (Array<(Page<TaxClass>, Fixnum, Hash)>)

    Page<TaxClass> data, response status code and response headers



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
# File 'lib/tradenity/resources/tax_class.rb', line 563

def list_all_tax_classes_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxClass.list_all_tax_classes ...'
  end
  # resource path
  local_var_path = '/taxClasses'

  # query parameters
  query_params = opts
  # query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  # query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  # query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Page<TaxClass>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxClass#list_all_tax_classes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.replace_tax_class_by_id(tax_class_id, tax_class, opts = {}) ⇒ TaxClass

Replace TaxClass Replace all attributes of TaxClass

Parameters:

  • tax_class_id

    ID of taxClass to replace

  • tax_class

    Attributes of taxClass to replace

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



607
608
609
610
# File 'lib/tradenity/resources/tax_class.rb', line 607

def replace_tax_class_by_id(tax_class_id, tax_class, opts = {})
  data, _status_code, _headers = replace_tax_class_by_id_with_http_info(tax_class_id, tax_class, opts)
  data
end

.replace_tax_class_by_id_with_http_info(tax_class_id, tax_class, opts = {}) ⇒ Array<(TaxClass, Fixnum, Hash)>

Replace TaxClass Replace all attributes of TaxClass

Parameters:

  • tax_class_id

    ID of taxClass to replace

  • tax_class

    Attributes of taxClass to replace

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(TaxClass, Fixnum, Hash)>)

    TaxClass data, response status code and response headers



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
# File 'lib/tradenity/resources/tax_class.rb', line 618

def replace_tax_class_by_id_with_http_info(tax_class_id, tax_class, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxClass.replace_tax_class_by_id ...'
  end
  # verify the required parameter 'tax_class_id' is set
  if api_client.config.client_side_validation && tax_class_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_class_id' when calling TaxClass.replace_tax_class_by_id"
  end
  # verify the required parameter 'tax_class' is set
  if api_client.config.client_side_validation && tax_class.nil?
    fail ArgumentError, "Missing the required parameter 'tax_class' when calling TaxClass.replace_tax_class_by_id"
  end
  # resource path
  local_var_path = '/taxClasses/{taxClassId}'.sub('{' + 'taxClassId' + '}', tax_class_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(tax_class)
  auth_names = []
  data, status_code, headers = api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaxClass')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxClass#replace_tax_class_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_typesObject

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/tradenity/resources/tax_class.rb', line 83

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'slug' => :'String',
    :'description' => :'String',
    :'status' => :'String'
  }
end

.update_tax_class_by_id(tax_class_id, tax_class, opts = {}) ⇒ TaxClass

Update TaxClass Update attributes of TaxClass

Parameters:

  • tax_class_id

    ID of taxClass to update.

  • tax_class

    Attributes of taxClass to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:



667
668
669
670
# File 'lib/tradenity/resources/tax_class.rb', line 667

def update_tax_class_by_id(tax_class_id, tax_class, opts = {})
  data, _status_code, _headers = update_tax_class_by_id_with_http_info(tax_class_id, tax_class, opts)
  data
end

.update_tax_class_by_id_with_http_info(tax_class_id, tax_class, opts = {}) ⇒ Array<(TaxClass, Fixnum, Hash)>

Update TaxClass Update attributes of TaxClass

Parameters:

  • tax_class_id

    ID of taxClass to update.

  • tax_class

    Attributes of taxClass to update.

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(TaxClass, Fixnum, Hash)>)

    TaxClass data, response status code and response headers



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
# File 'lib/tradenity/resources/tax_class.rb', line 678

def update_tax_class_by_id_with_http_info(tax_class_id, tax_class, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TaxClass.update_tax_class_by_id ...'
  end
  # verify the required parameter 'tax_class_id' is set
  if api_client.config.client_side_validation && tax_class_id.nil?
    fail ArgumentError, "Missing the required parameter 'tax_class_id' when calling TaxClass.update_tax_class_by_id"
  end
  # verify the required parameter 'tax_class' is set
  if api_client.config.client_side_validation && tax_class.nil?
    fail ArgumentError, "Missing the required parameter 'tax_class' when calling TaxClass.update_tax_class_by_id"
  end
  # resource path
  local_var_path = '/taxClasses/{taxClassId}'.sub('{' + 'taxClassId' + '}', tax_class_id.to_s)

  # query parameters
  query_params = opts

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(tax_class)
  auth_names = []
  data, status_code, headers = api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TaxClass')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TaxClass#update_tax_class_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



186
187
188
189
190
191
192
193
194
195
196
# File 'lib/tradenity/resources/tax_class.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      slug == o.slug &&
      description == o.description &&
      status == o.status
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



234
235
236
237
238
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
# File 'lib/tradenity/resources/tax_class.rb', line 234

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



300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/tradenity/resources/tax_class.rb', line 300

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/tradenity/resources/tax_class.rb', line 213

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("#{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

#createObject

Create TaxClass Create a new TaxClass



321
322
323
324
325
# File 'lib/tradenity/resources/tax_class.rb', line 321

def create
  data = self.class.create_tax_class(self)
  self.id = data.id
  data
end

#deletenil

Delete TaxClass Delete this instance of TaxClass.

Returns:

  • (nil)


337
338
339
# File 'lib/tradenity/resources/tax_class.rb', line 337

def delete
  self.class.delete_tax_class_by_id(self.id)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
# File 'lib/tradenity/resources/tax_class.rb', line 200

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



206
207
208
# File 'lib/tradenity/resources/tax_class.rb', line 206

def hash
  [__meta, created_at, updated_at, name, slug, description, status].hash
end

#idObject



21
22
23
24
25
26
27
28
29
30
# File 'lib/tradenity/resources/tax_class.rb', line 21

def id
  if instance_variable_defined?('@id') && @id != nil
    @id
  elsif __meta && __meta.href != nil
    @id = __meta.href.split('/')[-1]
    @id
  else
    nil
  end
end

#id=(id) ⇒ Object



17
18
19
# File 'lib/tradenity/resources/tax_class.rb', line 17

def id=(id)
  @id = id
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/tradenity/resources/tax_class.rb', line 146

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @slug.nil?
    invalid_properties.push('invalid value for "slug", slug cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



280
281
282
# File 'lib/tradenity/resources/tax_class.rb', line 280

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
# File 'lib/tradenity/resources/tax_class.rb', line 286

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



274
275
276
# File 'lib/tradenity/resources/tax_class.rb', line 274

def to_s
  to_hash.to_s
end

#updateTaxClass

Update TaxClass Update attributes of TaxClass

Returns:



330
331
332
# File 'lib/tradenity/resources/tax_class.rb', line 330

def update
  self.class.update_tax_class_by_id(self.id, self)
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



165
166
167
168
169
170
171
172
# File 'lib/tradenity/resources/tax_class.rb', line 165

def valid?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled'])
  return false unless status_validator.valid?(@status)
  true
end