Class: Tradenity::FreeShippingPromotion

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FreeShippingPromotion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 106

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

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

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

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#begins_at ⇒ Object

Returns the value of attribute begins_at.



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

def begins_at
  @begins_at
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#ends_at ⇒ Object

Returns the value of attribute ends_at.



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

def ends_at
  @ends_at
end

#include ⇒ Object

Returns the value of attribute include.



48
49
50
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 48

def include
  @include
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



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

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 73

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'description' => :'description',
    :'status' => :'status',
    :'begins_at' => :'beginsAt',
    :'ends_at' => :'endsAt',
    :'include' => :'include'
  }
end

.create_free_shipping_promotion(free_shipping_promotion, opts = {}) ⇒ FreeShippingPromotion

Create FreeShippingPromotion Create a new FreeShippingPromotion

Parameters:

  • free_shipping_promotion —

    Attributes of freeShippingPromotion to create

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

    the optional parameters

Returns:



409
410
411
412
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 409

def create_free_shipping_promotion(free_shipping_promotion, opts = {})
  data, _status_code, _headers = create_free_shipping_promotion_with_http_info(free_shipping_promotion, opts)
  data
end

.create_free_shipping_promotion_with_http_info(free_shipping_promotion, opts = {}) ⇒ Array<(FreeShippingPromotion, Fixnum, Hash)>

Create FreeShippingPromotion Create a new FreeShippingPromotion

Parameters:

  • free_shipping_promotion —

    Attributes of freeShippingPromotion to create

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

    the optional parameters

Returns:

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

    FreeShippingPromotion data, response status code and response headers



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 419

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

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

.delete_by_id(id) ⇒ nil

Delete FreeShippingPromotion Delete an instance of FreeShippingPromotion by its ID.

Parameters:

  • id —

    ID of FreeShippingPromotion to delete.

Returns:

  • (nil) 


400
401
402
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 400

def delete_by_id(id)
  delete_free_shipping_promotion_by_id(id)
end

.delete_free_shipping_promotion_by_id(free_shipping_promotion_id, opts = {}) ⇒ nil

Delete FreeShippingPromotion Delete an instance of FreeShippingPromotion by its ID.

Parameters:

  • free_shipping_promotion_id —

    ID of freeShippingPromotion to delete.

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

    the optional parameters

Returns:

  • (nil) 


463
464
465
466
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 463

def delete_free_shipping_promotion_by_id(free_shipping_promotion_id, opts = {})
  delete_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, opts)
  nil
end

.delete_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete FreeShippingPromotion Delete an instance of FreeShippingPromotion by its ID.

Parameters:

  • free_shipping_promotion_id —

    ID of freeShippingPromotion to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 473

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

.find_all ⇒ Page<FreeShippingPromotion>

List FreeShippingPromotions Return a list of FreeShippingPromotions

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



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

def find_all
  list_all_free_shipping_promotions
end

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

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

Parameters:

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

    the search parameters

Returns:



376
377
378
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 376

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

.find_by_id(id) ⇒ FreeShippingPromotion

Find FreeShippingPromotion Return single instance of FreeShippingPromotion by its ID.

Parameters:

  • id —

    ID of FreeShippingPromotion to return

Returns:



392
393
394
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 392

def find_by_id(id)
  get_free_shipping_promotion_by_id(id)
end

.find_one_by(opts = {}) ⇒ FreeShippingPromotion

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

Parameters:

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

    search parameters

Returns:



384
385
386
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 384

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

.get_free_shipping_promotion_by_id(free_shipping_promotion_id, opts = {}) ⇒ FreeShippingPromotion

Find FreeShippingPromotion Return single instance of FreeShippingPromotion by its ID.

Parameters:

  • free_shipping_promotion_id —

    ID of freeShippingPromotion to return

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

    the optional parameters

Returns:



516
517
518
519
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 516

def get_free_shipping_promotion_by_id(free_shipping_promotion_id, opts = {})
  data, _status_code, _headers = get_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, opts)
  data
end

.get_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, opts = {}) ⇒ Array<(FreeShippingPromotion, Fixnum, Hash)>

Find FreeShippingPromotion Return single instance of FreeShippingPromotion by its ID.

Parameters:

  • free_shipping_promotion_id —

    ID of freeShippingPromotion to return

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

    the optional parameters

Returns:

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

    FreeShippingPromotion data, response status code and response headers



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 526

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

.list_all_free_shipping_promotions(opts = {}) ⇒ Page<FreeShippingPromotion>

List FreeShippingPromotions Return a list of FreeShippingPromotions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



572
573
574
575
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 572

def list_all_free_shipping_promotions(opts = {})
  data, _status_code, _headers = list_all_free_shipping_promotions_with_http_info(opts)
  data
end

.list_all_free_shipping_promotions_with_http_info(opts = {}) ⇒ Array<(Page<FreeShippingPromotion>, Fixnum, Hash)>

List FreeShippingPromotions Return a list of FreeShippingPromotions

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

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



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 584

def list_all_free_shipping_promotions_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: FreeShippingPromotion.list_all_free_shipping_promotions ...'
  end
  # resource path
  local_var_path = '/freeShippingPromotions'

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

.replace_free_shipping_promotion_by_id(free_shipping_promotion_id, free_shipping_promotion, opts = {}) ⇒ FreeShippingPromotion

Replace FreeShippingPromotion Replace all attributes of FreeShippingPromotion

Parameters:

  • free_shipping_promotion_id —

    ID of freeShippingPromotion to replace

  • free_shipping_promotion —

    Attributes of freeShippingPromotion to replace

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

    the optional parameters

Returns:



628
629
630
631
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 628

def replace_free_shipping_promotion_by_id(free_shipping_promotion_id, free_shipping_promotion, opts = {})
  data, _status_code, _headers = replace_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, free_shipping_promotion, opts)
  data
end

.replace_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, free_shipping_promotion, opts = {}) ⇒ Array<(FreeShippingPromotion, Fixnum, Hash)>

Replace FreeShippingPromotion Replace all attributes of FreeShippingPromotion

Parameters:

  • free_shipping_promotion_id —

    ID of freeShippingPromotion to replace

  • free_shipping_promotion —

    Attributes of freeShippingPromotion to replace

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

    the optional parameters

Returns:

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

    FreeShippingPromotion data, response status code and response headers



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 639

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

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 89

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

.update_free_shipping_promotion_by_id(free_shipping_promotion_id, free_shipping_promotion, opts = {}) ⇒ FreeShippingPromotion

Update FreeShippingPromotion Update attributes of FreeShippingPromotion

Parameters:

  • free_shipping_promotion_id —

    ID of freeShippingPromotion to update.

  • free_shipping_promotion —

    Attributes of freeShippingPromotion to update.

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

    the optional parameters

Returns:



688
689
690
691
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 688

def update_free_shipping_promotion_by_id(free_shipping_promotion_id, free_shipping_promotion, opts = {})
  data, _status_code, _headers = update_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, free_shipping_promotion, opts)
  data
end

.update_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, free_shipping_promotion, opts = {}) ⇒ Array<(FreeShippingPromotion, Fixnum, Hash)>

Update FreeShippingPromotion Update attributes of FreeShippingPromotion

Parameters:

  • free_shipping_promotion_id —

    ID of freeShippingPromotion to update.

  • free_shipping_promotion —

    Attributes of freeShippingPromotion to update.

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

    the optional parameters

Returns:

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

    FreeShippingPromotion data, response status code and response headers



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 699

def update_free_shipping_promotion_by_id_with_http_info(free_shipping_promotion_id, free_shipping_promotion, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: FreeShippingPromotion.update_free_shipping_promotion_by_id ...'
  end
  # verify the required parameter 'free_shipping_promotion_id' is set
  if api_client.config.client_side_validation && free_shipping_promotion_id.nil?
    fail ArgumentError, "Missing the required parameter 'free_shipping_promotion_id' when calling FreeShippingPromotion.update_free_shipping_promotion_by_id"
  end
  # verify the required parameter 'free_shipping_promotion' is set
  if api_client.config.client_side_validation && free_shipping_promotion.nil?
    fail ArgumentError, "Missing the required parameter 'free_shipping_promotion' when calling FreeShippingPromotion.update_free_shipping_promotion_by_id"
  end
  # resource path
  local_var_path = '/freeShippingPromotions/{freeShippingPromotionId}'.sub('{' + 'freeShippingPromotionId' + '}', free_shipping_promotion_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(free_shipping_promotion)
  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 => 'FreeShippingPromotion')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: FreeShippingPromotion#update_free_shipping_promotion_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



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

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 &&
      description == o.description &&
      status == o.status &&
      begins_at == o.begins_at &&
      ends_at == o.ends_at &&
      include == o.include
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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 255

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 321

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 234

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 FreeShippingPromotion Create a new FreeShippingPromotion



342
343
344
345
346
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 342

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

#delete ⇒ nil

Delete FreeShippingPromotion Delete this instance of FreeShippingPromotion.

Returns:

  • (nil) 


358
359
360
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 358

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


221
222
223
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



227
228
229
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 227

def hash
  [__meta, created_at, updated_at, name, description, status, begins_at, ends_at, include].hash
end

#id ⇒ Object 



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



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 170

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

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



301
302
303
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 301

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



307
308
309
310
311
312
313
314
315
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 307

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



295
296
297
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 295

def to_s
  to_hash.to_s
end

#update ⇒ FreeShippingPromotion

Update FreeShippingPromotion Update attributes of FreeShippingPromotion

Returns:



351
352
353
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 351

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



185
186
187
188
189
190
191
 
# File 'lib/tradenity/resources/free_shipping_promotion.rb', line 185

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