Class: Tradenity::TableRateRule

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TableRateRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
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
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 80

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

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

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#cost ⇒ Object

Returns the value of attribute cost.



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

def cost
  @cost
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#maximum ⇒ Object

Returns the value of attribute maximum.



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

def maximum
  @maximum
end

#minimum ⇒ Object

Returns the value of attribute minimum.



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

def minimum
  @minimum
end

#table_rate_shipping ⇒ Object

Returns the value of attribute table_rate_shipping.



46
47
48
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 46

def table_rate_shipping
  @table_rate_shipping
end

#unit ⇒ Object

Returns the value of attribute unit.



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

def unit
  @unit
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



304
305
306
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 304

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 49

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'minimum' => :'minimum',
    :'maximum' => :'maximum',
    :'cost' => :'cost',
    :'unit' => :'unit',
    :'table_rate_shipping' => :'tableRateShipping'
  }
end

.create_table_rate_rule(table_rate_rule, opts = {}) ⇒ TableRateRule

Create TableRateRule Create a new TableRateRule

Parameters:

  • table_rate_rule —

    Attributes of tableRateRule to create

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

    the optional parameters

Returns:



377
378
379
380
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 377

def create_table_rate_rule(table_rate_rule, opts = {})
  data, _status_code, _headers = create_table_rate_rule_with_http_info(table_rate_rule, opts)
  data
end

.create_table_rate_rule_with_http_info(table_rate_rule, opts = {}) ⇒ Array<(TableRateRule, Fixnum, Hash)>

Create TableRateRule Create a new TableRateRule

Parameters:

  • table_rate_rule —

    Attributes of tableRateRule to create

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

    the optional parameters

Returns:

  • (Array<(TableRateRule, Fixnum, Hash)>) —

    TableRateRule data, response status code and response headers



387
388
389
390
391
392
393
394
395
396
397
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
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 387

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

  # 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(table_rate_rule)
  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 => 'TableRateRule')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TableRateRule#create_table_rate_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.delete_by_id(id) ⇒ nil

Delete TableRateRule Delete an instance of TableRateRule by its ID.

Parameters:

  • id —

    ID of TableRateRule to delete.

Returns:

  • (nil) 


368
369
370
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 368

def delete_by_id(id)
  delete_table_rate_rule_by_id(id)
end

.delete_table_rate_rule_by_id(table_rate_rule_id, opts = {}) ⇒ nil

Delete TableRateRule Delete an instance of TableRateRule by its ID.

Parameters:

  • table_rate_rule_id —

    ID of tableRateRule to delete.

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

    the optional parameters

Returns:

  • (nil) 


431
432
433
434
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 431

def delete_table_rate_rule_by_id(table_rate_rule_id, opts = {})
  delete_table_rate_rule_by_id_with_http_info(table_rate_rule_id, opts)
  nil
end

.delete_table_rate_rule_by_id_with_http_info(table_rate_rule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete TableRateRule Delete an instance of TableRateRule by its ID.

Parameters:

  • table_rate_rule_id —

    ID of tableRateRule to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



441
442
443
444
445
446
447
448
449
450
451
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
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 441

def delete_table_rate_rule_by_id_with_http_info(table_rate_rule_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TableRateRule.delete_table_rate_rule_by_id ...'
  end
  # verify the required parameter 'table_rate_rule_id' is set
  if api_client.config.client_side_validation && table_rate_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'table_rate_rule_id' when calling TableRateRule.delete_table_rate_rule_by_id"
  end
  # resource path
  local_var_path = '/tableRateRules/{tableRateRuleId}'.sub('{' + 'tableRateRuleId' + '}', table_rate_rule_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: TableRateRule#delete_table_rate_rule_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.find_all ⇒ Page<TableRateRule>

List TableRateRules Return a list of TableRateRules

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



336
337
338
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 336

def find_all
  list_all_table_rate_rules
end

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

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

Parameters:

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

    the search parameters

Returns:



344
345
346
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 344

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

.find_by_id(id) ⇒ TableRateRule

Find TableRateRule Return single instance of TableRateRule by its ID.

Parameters:

  • id —

    ID of TableRateRule to return

Returns:



360
361
362
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 360

def find_by_id(id)
  get_table_rate_rule_by_id(id)
end

.find_one_by(opts = {}) ⇒ TableRateRule

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

Parameters:

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

    search parameters

Returns:



352
353
354
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 352

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

.get_table_rate_rule_by_id(table_rate_rule_id, opts = {}) ⇒ TableRateRule

Find TableRateRule Return single instance of TableRateRule by its ID.

Parameters:

  • table_rate_rule_id —

    ID of tableRateRule to return

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

    the optional parameters

Returns:



484
485
486
487
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 484

def get_table_rate_rule_by_id(table_rate_rule_id, opts = {})
  data, _status_code, _headers = get_table_rate_rule_by_id_with_http_info(table_rate_rule_id, opts)
  data
end

.get_table_rate_rule_by_id_with_http_info(table_rate_rule_id, opts = {}) ⇒ Array<(TableRateRule, Fixnum, Hash)>

Find TableRateRule Return single instance of TableRateRule by its ID.

Parameters:

  • table_rate_rule_id —

    ID of tableRateRule to return

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

    the optional parameters

Returns:

  • (Array<(TableRateRule, Fixnum, Hash)>) —

    TableRateRule data, response status code and response headers



494
495
496
497
498
499
500
501
502
503
504
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
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 494

def get_table_rate_rule_by_id_with_http_info(table_rate_rule_id, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TableRateRule.get_table_rate_rule_by_id ...'
  end
  # verify the required parameter 'table_rate_rule_id' is set
  if api_client.config.client_side_validation && table_rate_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'table_rate_rule_id' when calling TableRateRule.get_table_rate_rule_by_id"
  end
  # resource path
  local_var_path = '/tableRateRules/{tableRateRuleId}'.sub('{' + 'tableRateRuleId' + '}', table_rate_rule_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 => 'TableRateRule')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TableRateRule#get_table_rate_rule_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.list_all_table_rate_rules(opts = {}) ⇒ Page<TableRateRule>

List TableRateRules Return a list of TableRateRules

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



540
541
542
543
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 540

def list_all_table_rate_rules(opts = {})
  data, _status_code, _headers = list_all_table_rate_rules_with_http_info(opts)
  data
end

.list_all_table_rate_rules_with_http_info(opts = {}) ⇒ Array<(Page<TableRateRule>, Fixnum, Hash)>

List TableRateRules Return a list of TableRateRules

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<TableRateRule>, Fixnum, Hash)>) —

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



552
553
554
555
556
557
558
559
560
561
562
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
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 552

def list_all_table_rate_rules_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TableRateRule.list_all_table_rate_rules ...'
  end
  # resource path
  local_var_path = '/tableRateRules'

  # 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<TableRateRule>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TableRateRule#list_all_table_rate_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.replace_table_rate_rule_by_id(table_rate_rule_id, table_rate_rule, opts = {}) ⇒ TableRateRule

Replace TableRateRule Replace all attributes of TableRateRule

Parameters:

  • table_rate_rule_id —

    ID of tableRateRule to replace

  • table_rate_rule —

    Attributes of tableRateRule to replace

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

    the optional parameters

Returns:



596
597
598
599
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 596

def replace_table_rate_rule_by_id(table_rate_rule_id, table_rate_rule, opts = {})
  data, _status_code, _headers = replace_table_rate_rule_by_id_with_http_info(table_rate_rule_id, table_rate_rule, opts)
  data
end

.replace_table_rate_rule_by_id_with_http_info(table_rate_rule_id, table_rate_rule, opts = {}) ⇒ Array<(TableRateRule, Fixnum, Hash)>

Replace TableRateRule Replace all attributes of TableRateRule

Parameters:

  • table_rate_rule_id —

    ID of tableRateRule to replace

  • table_rate_rule —

    Attributes of tableRateRule to replace

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

    the optional parameters

Returns:

  • (Array<(TableRateRule, Fixnum, Hash)>) —

    TableRateRule data, response status code and response headers



607
608
609
610
611
612
613
614
615
616
617
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
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 607

def replace_table_rate_rule_by_id_with_http_info(table_rate_rule_id, table_rate_rule, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TableRateRule.replace_table_rate_rule_by_id ...'
  end
  # verify the required parameter 'table_rate_rule_id' is set
  if api_client.config.client_side_validation && table_rate_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'table_rate_rule_id' when calling TableRateRule.replace_table_rate_rule_by_id"
  end
  # verify the required parameter 'table_rate_rule' is set
  if api_client.config.client_side_validation && table_rate_rule.nil?
    fail ArgumentError, "Missing the required parameter 'table_rate_rule' when calling TableRateRule.replace_table_rate_rule_by_id"
  end
  # resource path
  local_var_path = '/tableRateRules/{tableRateRuleId}'.sub('{' + 'tableRateRuleId' + '}', table_rate_rule_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(table_rate_rule)
  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 => 'TableRateRule')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TableRateRule#replace_table_rate_rule_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 64

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'minimum' => :'Integer',
    :'maximum' => :'Integer',
    :'cost' => :'Integer',
    :'unit' => :'String',
    :'table_rate_shipping' => :'TableRateShipping'
  }
end

.update_table_rate_rule_by_id(table_rate_rule_id, table_rate_rule, opts = {}) ⇒ TableRateRule

Update TableRateRule Update attributes of TableRateRule

Parameters:

  • table_rate_rule_id —

    ID of tableRateRule to update.

  • table_rate_rule —

    Attributes of tableRateRule to update.

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

    the optional parameters

Returns:



656
657
658
659
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 656

def update_table_rate_rule_by_id(table_rate_rule_id, table_rate_rule, opts = {})
  data, _status_code, _headers = update_table_rate_rule_by_id_with_http_info(table_rate_rule_id, table_rate_rule, opts)
  data
end

.update_table_rate_rule_by_id_with_http_info(table_rate_rule_id, table_rate_rule, opts = {}) ⇒ Array<(TableRateRule, Fixnum, Hash)>

Update TableRateRule Update attributes of TableRateRule

Parameters:

  • table_rate_rule_id —

    ID of tableRateRule to update.

  • table_rate_rule —

    Attributes of tableRateRule to update.

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

    the optional parameters

Returns:

  • (Array<(TableRateRule, Fixnum, Hash)>) —

    TableRateRule data, response status code and response headers



667
668
669
670
671
672
673
674
675
676
677
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
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 667

def update_table_rate_rule_by_id_with_http_info(table_rate_rule_id, table_rate_rule, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: TableRateRule.update_table_rate_rule_by_id ...'
  end
  # verify the required parameter 'table_rate_rule_id' is set
  if api_client.config.client_side_validation && table_rate_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'table_rate_rule_id' when calling TableRateRule.update_table_rate_rule_by_id"
  end
  # verify the required parameter 'table_rate_rule' is set
  if api_client.config.client_side_validation && table_rate_rule.nil?
    fail ArgumentError, "Missing the required parameter 'table_rate_rule' when calling TableRateRule.update_table_rate_rule_by_id"
  end
  # resource path
  local_var_path = '/tableRateRules/{tableRateRuleId}'.sub('{' + 'tableRateRuleId' + '}', table_rate_rule_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(table_rate_rule)
  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 => 'TableRateRule')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: TableRateRule#update_table_rate_rule_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



174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 174

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 &&
      minimum == o.minimum &&
      maximum == o.maximum &&
      cost == o.cost &&
      unit == o.unit &&
      table_rate_shipping == o.table_rate_shipping
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



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
256
257
258
259
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 223

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 289

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 202

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

#create ⇒ Object

Create TableRateRule Create a new TableRateRule



310
311
312
313
314
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 310

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

#delete ⇒ nil

Delete TableRateRule Delete this instance of TableRateRule.

Returns:

  • (nil) 


326
327
328
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 326

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


189
190
191
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 195

def hash
  [__meta, created_at, updated_at, minimum, maximum, cost, unit, table_rate_shipping].hash
end

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/table_rate_rule.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/table_rate_rule.rb', line 17

def id=(id)
  @id = id
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 136

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

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

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

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

  if @table_rate_shipping.nil?
    invalid_properties.push('invalid value for "table_rate_shipping", table_rate_shipping cannot be nil.')
  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



269
270
271
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 269

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



275
276
277
278
279
280
281
282
283
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 275

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



263
264
265
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 263

def to_s
  to_hash.to_s
end

#update ⇒ TableRateRule

Update TableRateRule Update attributes of TableRateRule

Returns:



319
320
321
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 319

def update
  self.class.update_table_rate_rule_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



163
164
165
166
167
168
169
170
 
# File 'lib/tradenity/resources/table_rate_rule.rb', line 163

def valid?
  return false if @minimum.nil?
  return false if @maximum.nil?
  return false if @cost.nil?
  return false if @unit.nil?
  return false if @table_rate_shipping.nil?
  true
end