Class: Tradenity::FreeShippingCoupon

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FreeShippingCoupon

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 118

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

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

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

  if attributes.has_key?(:'geoZones')
    if (value = attributes[:'geoZones']).is_a?(Array)
      self.geo_zones = value
    end
  end

  if attributes.has_key?(:'geo_zones')
    if (value = attributes[:'geo_zones']).is_a?(Array)
      self.geo_zones = value
    end
  end
end

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#begins_at ⇒ Object

Returns the value of attribute begins_at.



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

def begins_at
  @begins_at
end

#code ⇒ Object

Returns the value of attribute code.



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

def code
  @code
end

#created_at ⇒ Object

Returns the value of attribute created_at.



34
35
36
 
# File 'lib/tradenity/resources/free_shipping_coupon.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_coupon.rb', line 40

def description
  @description
end

#ends_at ⇒ Object

Returns the value of attribute ends_at.



50
51
52
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 50

def ends_at
  @ends_at
end

#geo_zones ⇒ Object

Returns the value of attribute geo_zones.



54
55
56
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 54

def geo_zones
  @geo_zones
end

#include ⇒ Object

Returns the value of attribute include.



52
53
54
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 52

def include
  @include
end

#minimum_order ⇒ Object

Returns the value of attribute minimum_order.



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

def minimum_order
  @minimum_order
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#status ⇒ Object

Returns the value of attribute status.



42
43
44
 
# File 'lib/tradenity/resources/free_shipping_coupon.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_coupon.rb', line 36

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



380
381
382
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 380

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 79

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

.create_free_shipping_coupon(free_shipping_coupon, opts = {}) ⇒ FreeShippingCoupon

Create FreeShippingCoupon Create a new FreeShippingCoupon

Parameters:

  • free_shipping_coupon —

    Attributes of freeShippingCoupon to create

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

    the optional parameters

Returns:



453
454
455
456
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 453

def create_free_shipping_coupon(free_shipping_coupon, opts = {})
  data, _status_code, _headers = create_free_shipping_coupon_with_http_info(free_shipping_coupon, opts)
  data
end

.create_free_shipping_coupon_with_http_info(free_shipping_coupon, opts = {}) ⇒ Array<(FreeShippingCoupon, Fixnum, Hash)>

Create FreeShippingCoupon Create a new FreeShippingCoupon

Parameters:

  • free_shipping_coupon —

    Attributes of freeShippingCoupon to create

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

    the optional parameters

Returns:

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

    FreeShippingCoupon data, response status code and response headers



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
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 463

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

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

.delete_by_id(id) ⇒ nil

Delete FreeShippingCoupon Delete an instance of FreeShippingCoupon by its ID.

Parameters:

  • id —

    ID of FreeShippingCoupon to delete.

Returns:

  • (nil) 


444
445
446
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 444

def delete_by_id(id)
  delete_free_shipping_coupon_by_id(id)
end

.delete_free_shipping_coupon_by_id(free_shipping_coupon_id, opts = {}) ⇒ nil

Delete FreeShippingCoupon Delete an instance of FreeShippingCoupon by its ID.

Parameters:

  • free_shipping_coupon_id —

    ID of freeShippingCoupon to delete.

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

    the optional parameters

Returns:

  • (nil) 


507
508
509
510
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 507

def delete_free_shipping_coupon_by_id(free_shipping_coupon_id, opts = {})
  delete_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, opts)
  nil
end

.delete_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete FreeShippingCoupon Delete an instance of FreeShippingCoupon by its ID.

Parameters:

  • free_shipping_coupon_id —

    ID of freeShippingCoupon to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 517

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

.find_all ⇒ Page<FreeShippingCoupon>

List FreeShippingCoupons Return a list of FreeShippingCoupons

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



412
413
414
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 412

def find_all
  list_all_free_shipping_coupons
end

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

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

Parameters:

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

    the search parameters

Returns:



420
421
422
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 420

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

.find_by_id(id) ⇒ FreeShippingCoupon

Find FreeShippingCoupon Return single instance of FreeShippingCoupon by its ID.

Parameters:

  • id —

    ID of FreeShippingCoupon to return

Returns:



436
437
438
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 436

def find_by_id(id)
  get_free_shipping_coupon_by_id(id)
end

.find_one_by(opts = {}) ⇒ FreeShippingCoupon

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

Parameters:

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

    search parameters

Returns:



428
429
430
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 428

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

.get_free_shipping_coupon_by_id(free_shipping_coupon_id, opts = {}) ⇒ FreeShippingCoupon

Find FreeShippingCoupon Return single instance of FreeShippingCoupon by its ID.

Parameters:

  • free_shipping_coupon_id —

    ID of freeShippingCoupon to return

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

    the optional parameters

Returns:



560
561
562
563
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 560

def get_free_shipping_coupon_by_id(free_shipping_coupon_id, opts = {})
  data, _status_code, _headers = get_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, opts)
  data
end

.get_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, opts = {}) ⇒ Array<(FreeShippingCoupon, Fixnum, Hash)>

Find FreeShippingCoupon Return single instance of FreeShippingCoupon by its ID.

Parameters:

  • free_shipping_coupon_id —

    ID of freeShippingCoupon to return

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

    the optional parameters

Returns:

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

    FreeShippingCoupon data, response status code and response headers



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
601
602
603
604
605
606
607
608
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 570

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

.list_all_free_shipping_coupons(opts = {}) ⇒ Page<FreeShippingCoupon>

List FreeShippingCoupons Return a list of FreeShippingCoupons

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



616
617
618
619
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 616

def list_all_free_shipping_coupons(opts = {})
  data, _status_code, _headers = list_all_free_shipping_coupons_with_http_info(opts)
  data
end

.list_all_free_shipping_coupons_with_http_info(opts = {}) ⇒ Array<(Page<FreeShippingCoupon>, Fixnum, Hash)>

List FreeShippingCoupons Return a list of FreeShippingCoupons

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

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



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
661
662
663
664
665
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 628

def list_all_free_shipping_coupons_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: FreeShippingCoupon.list_all_free_shipping_coupons ...'
  end
  # resource path
  local_var_path = '/freeShippingCoupons'

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

.replace_free_shipping_coupon_by_id(free_shipping_coupon_id, free_shipping_coupon, opts = {}) ⇒ FreeShippingCoupon

Replace FreeShippingCoupon Replace all attributes of FreeShippingCoupon

Parameters:

  • free_shipping_coupon_id —

    ID of freeShippingCoupon to replace

  • free_shipping_coupon —

    Attributes of freeShippingCoupon to replace

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

    the optional parameters

Returns:



672
673
674
675
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 672

def replace_free_shipping_coupon_by_id(free_shipping_coupon_id, free_shipping_coupon, opts = {})
  data, _status_code, _headers = replace_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, free_shipping_coupon, opts)
  data
end

.replace_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, free_shipping_coupon, opts = {}) ⇒ Array<(FreeShippingCoupon, Fixnum, Hash)>

Replace FreeShippingCoupon Replace all attributes of FreeShippingCoupon

Parameters:

  • free_shipping_coupon_id —

    ID of freeShippingCoupon to replace

  • free_shipping_coupon —

    Attributes of freeShippingCoupon to replace

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

    the optional parameters

Returns:

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

    FreeShippingCoupon data, response status code and response headers



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
721
722
723
724
725
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 683

def replace_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, free_shipping_coupon, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: FreeShippingCoupon.replace_free_shipping_coupon_by_id ...'
  end
  # verify the required parameter 'free_shipping_coupon_id' is set
  if api_client.config.client_side_validation && free_shipping_coupon_id.nil?
    fail ArgumentError, "Missing the required parameter 'free_shipping_coupon_id' when calling FreeShippingCoupon.replace_free_shipping_coupon_by_id"
  end
  # verify the required parameter 'free_shipping_coupon' is set
  if api_client.config.client_side_validation && free_shipping_coupon.nil?
    fail ArgumentError, "Missing the required parameter 'free_shipping_coupon' when calling FreeShippingCoupon.replace_free_shipping_coupon_by_id"
  end
  # resource path
  local_var_path = '/freeShippingCoupons/{freeShippingCouponId}'.sub('{' + 'freeShippingCouponId' + '}', free_shipping_coupon_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_coupon)
  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 => 'FreeShippingCoupon')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: FreeShippingCoupon#replace_free_shipping_coupon_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 98

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'description' => :'String',
    :'status' => :'String',
    :'minimum_order' => :'Integer',
    :'code' => :'String',
    :'begins_at' => :'DateTime',
    :'ends_at' => :'DateTime',
    :'include' => :'ItemsSelector',
    :'geo_zones' => :'Array<GeoZone>'
  }
end

.update_free_shipping_coupon_by_id(free_shipping_coupon_id, free_shipping_coupon, opts = {}) ⇒ FreeShippingCoupon

Update FreeShippingCoupon Update attributes of FreeShippingCoupon

Parameters:

  • free_shipping_coupon_id —

    ID of freeShippingCoupon to update.

  • free_shipping_coupon —

    Attributes of freeShippingCoupon to update.

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

    the optional parameters

Returns:



732
733
734
735
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 732

def update_free_shipping_coupon_by_id(free_shipping_coupon_id, free_shipping_coupon, opts = {})
  data, _status_code, _headers = update_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, free_shipping_coupon, opts)
  data
end

.update_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, free_shipping_coupon, opts = {}) ⇒ Array<(FreeShippingCoupon, Fixnum, Hash)>

Update FreeShippingCoupon Update attributes of FreeShippingCoupon

Parameters:

  • free_shipping_coupon_id —

    ID of freeShippingCoupon to update.

  • free_shipping_coupon —

    Attributes of freeShippingCoupon to update.

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

    the optional parameters

Returns:

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

    FreeShippingCoupon data, response status code and response headers



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 743

def update_free_shipping_coupon_by_id_with_http_info(free_shipping_coupon_id, free_shipping_coupon, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: FreeShippingCoupon.update_free_shipping_coupon_by_id ...'
  end
  # verify the required parameter 'free_shipping_coupon_id' is set
  if api_client.config.client_side_validation && free_shipping_coupon_id.nil?
    fail ArgumentError, "Missing the required parameter 'free_shipping_coupon_id' when calling FreeShippingCoupon.update_free_shipping_coupon_by_id"
  end
  # verify the required parameter 'free_shipping_coupon' is set
  if api_client.config.client_side_validation && free_shipping_coupon.nil?
    fail ArgumentError, "Missing the required parameter 'free_shipping_coupon' when calling FreeShippingCoupon.update_free_shipping_coupon_by_id"
  end
  # resource path
  local_var_path = '/freeShippingCoupons/{freeShippingCouponId}'.sub('{' + 'freeShippingCouponId' + '}', free_shipping_coupon_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_coupon)
  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 => 'FreeShippingCoupon')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: FreeShippingCoupon#update_free_shipping_coupon_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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 246

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 &&
      minimum_order == o.minimum_order &&
      code == o.code &&
      begins_at == o.begins_at &&
      ends_at == o.ends_at &&
      include == o.include &&
      geo_zones == o.geo_zones
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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 299

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 365

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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 278

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



386
387
388
389
390
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 386

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

#delete ⇒ nil

Delete FreeShippingCoupon Delete this instance of FreeShippingCoupon.

Returns:

  • (nil) 


402
403
404
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 402

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


265
266
267
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



271
272
273
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 271

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

#id ⇒ Object 



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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 206

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

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



345
346
347
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 345

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



351
352
353
354
355
356
357
358
359
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 351

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



339
340
341
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 339

def to_s
  to_hash.to_s
end

#update ⇒ FreeShippingCoupon

Update FreeShippingCoupon Update attributes of FreeShippingCoupon

Returns:



395
396
397
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 395

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



225
226
227
228
229
230
231
232
 
# File 'lib/tradenity/resources/free_shipping_coupon.rb', line 225

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)
  return false if @code.nil?
  true
end