Class: Tradenity::DiscountCoupon

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DiscountCoupon

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/discount_coupon.rb', line 122

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#amount ⇒ Object

Returns the value of attribute amount.



56
57
58
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 56

def amount
  @amount
end

#begins_at ⇒ Object

Returns the value of attribute begins_at.



48
49
50
 
# File 'lib/tradenity/resources/discount_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/discount_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/discount_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/discount_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/discount_coupon.rb', line 50

def ends_at
  @ends_at
end

#include ⇒ Object

Returns the value of attribute include.



52
53
54
 
# File 'lib/tradenity/resources/discount_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/discount_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/discount_coupon.rb', line 38

def name
  @name
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



403
404
405
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 403

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 81

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',
    :'type' => :'type',
    :'amount' => :'amount'
  }
end

.create_discount_coupon(discount_coupon, opts = {}) ⇒ DiscountCoupon

Create DiscountCoupon Create a new DiscountCoupon

Parameters:

  • discount_coupon —

    Attributes of discountCoupon to create

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

    the optional parameters

Returns:



476
477
478
479
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 476

def create_discount_coupon(discount_coupon, opts = {})
  data, _status_code, _headers = create_discount_coupon_with_http_info(discount_coupon, opts)
  data
end

.create_discount_coupon_with_http_info(discount_coupon, opts = {}) ⇒ Array<(DiscountCoupon, Fixnum, Hash)>

Create DiscountCoupon Create a new DiscountCoupon

Parameters:

  • discount_coupon —

    Attributes of discountCoupon to create

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

    the optional parameters

Returns:

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

    DiscountCoupon data, response status code and response headers



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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 486

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

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

.delete_by_id(id) ⇒ nil

Delete DiscountCoupon Delete an instance of DiscountCoupon by its ID.

Parameters:

  • id —

    ID of DiscountCoupon to delete.

Returns:

  • (nil) 


467
468
469
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 467

def delete_by_id(id)
  delete_discount_coupon_by_id(id)
end

.delete_discount_coupon_by_id(discount_coupon_id, opts = {}) ⇒ nil

Delete DiscountCoupon Delete an instance of DiscountCoupon by its ID.

Parameters:

  • discount_coupon_id —

    ID of discountCoupon to delete.

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

    the optional parameters

Returns:

  • (nil) 


530
531
532
533
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 530

def delete_discount_coupon_by_id(discount_coupon_id, opts = {})
  delete_discount_coupon_by_id_with_http_info(discount_coupon_id, opts)
  nil
end

.delete_discount_coupon_by_id_with_http_info(discount_coupon_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete DiscountCoupon Delete an instance of DiscountCoupon by its ID.

Parameters:

  • discount_coupon_id —

    ID of discountCoupon to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 540

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

.find_all ⇒ Page<DiscountCoupon>

List DiscountCoupons Return a list of DiscountCoupons

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



435
436
437
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 435

def find_all
  list_all_discount_coupons
end

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

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

Parameters:

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

    the search parameters

Returns:



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

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

.find_by_id(id) ⇒ DiscountCoupon

Find DiscountCoupon Return single instance of DiscountCoupon by its ID.

Parameters:

  • id —

    ID of DiscountCoupon to return

Returns:



459
460
461
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 459

def find_by_id(id)
  get_discount_coupon_by_id(id)
end

.find_one_by(opts = {}) ⇒ DiscountCoupon

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

Parameters:

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

    search parameters

Returns:



451
452
453
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 451

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

.get_discount_coupon_by_id(discount_coupon_id, opts = {}) ⇒ DiscountCoupon

Find DiscountCoupon Return single instance of DiscountCoupon by its ID.

Parameters:

  • discount_coupon_id —

    ID of discountCoupon to return

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

    the optional parameters

Returns:



583
584
585
586
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 583

def get_discount_coupon_by_id(discount_coupon_id, opts = {})
  data, _status_code, _headers = get_discount_coupon_by_id_with_http_info(discount_coupon_id, opts)
  data
end

.get_discount_coupon_by_id_with_http_info(discount_coupon_id, opts = {}) ⇒ Array<(DiscountCoupon, Fixnum, Hash)>

Find DiscountCoupon Return single instance of DiscountCoupon by its ID.

Parameters:

  • discount_coupon_id —

    ID of discountCoupon to return

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

    the optional parameters

Returns:

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

    DiscountCoupon data, response status code and response headers



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
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 593

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

.list_all_discount_coupons(opts = {}) ⇒ Page<DiscountCoupon>

List DiscountCoupons Return a list of DiscountCoupons

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



639
640
641
642
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 639

def list_all_discount_coupons(opts = {})
  data, _status_code, _headers = list_all_discount_coupons_with_http_info(opts)
  data
end

.list_all_discount_coupons_with_http_info(opts = {}) ⇒ Array<(Page<DiscountCoupon>, Fixnum, Hash)>

List DiscountCoupons Return a list of DiscountCoupons

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

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



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
682
683
684
685
686
687
688
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 651

def list_all_discount_coupons_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: DiscountCoupon.list_all_discount_coupons ...'
  end
  # resource path
  local_var_path = '/discountCoupons'

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

.replace_discount_coupon_by_id(discount_coupon_id, discount_coupon, opts = {}) ⇒ DiscountCoupon

Replace DiscountCoupon Replace all attributes of DiscountCoupon

Parameters:

  • discount_coupon_id —

    ID of discountCoupon to replace

  • discount_coupon —

    Attributes of discountCoupon to replace

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

    the optional parameters

Returns:



695
696
697
698
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 695

def replace_discount_coupon_by_id(discount_coupon_id, discount_coupon, opts = {})
  data, _status_code, _headers = replace_discount_coupon_by_id_with_http_info(discount_coupon_id, discount_coupon, opts)
  data
end

.replace_discount_coupon_by_id_with_http_info(discount_coupon_id, discount_coupon, opts = {}) ⇒ Array<(DiscountCoupon, Fixnum, Hash)>

Replace DiscountCoupon Replace all attributes of DiscountCoupon

Parameters:

  • discount_coupon_id —

    ID of discountCoupon to replace

  • discount_coupon —

    Attributes of discountCoupon to replace

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

    the optional parameters

Returns:

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

    DiscountCoupon data, response status code and response headers



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
742
743
744
745
746
747
748
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 706

def replace_discount_coupon_by_id_with_http_info(discount_coupon_id, discount_coupon, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: DiscountCoupon.replace_discount_coupon_by_id ...'
  end
  # verify the required parameter 'discount_coupon_id' is set
  if api_client.config.client_side_validation && discount_coupon_id.nil?
    fail ArgumentError, "Missing the required parameter 'discount_coupon_id' when calling DiscountCoupon.replace_discount_coupon_by_id"
  end
  # verify the required parameter 'discount_coupon' is set
  if api_client.config.client_side_validation && discount_coupon.nil?
    fail ArgumentError, "Missing the required parameter 'discount_coupon' when calling DiscountCoupon.replace_discount_coupon_by_id"
  end
  # resource path
  local_var_path = '/discountCoupons/{discountCouponId}'.sub('{' + 'discountCouponId' + '}', discount_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(discount_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 => 'DiscountCoupon')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: DiscountCoupon#replace_discount_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.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 101

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',
    :'type' => :'String',
    :'amount' => :'Integer'
  }
end

.update_discount_coupon_by_id(discount_coupon_id, discount_coupon, opts = {}) ⇒ DiscountCoupon

Update DiscountCoupon Update attributes of DiscountCoupon

Parameters:

  • discount_coupon_id —

    ID of discountCoupon to update.

  • discount_coupon —

    Attributes of discountCoupon to update.

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

    the optional parameters

Returns:



755
756
757
758
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 755

def update_discount_coupon_by_id(discount_coupon_id, discount_coupon, opts = {})
  data, _status_code, _headers = update_discount_coupon_by_id_with_http_info(discount_coupon_id, discount_coupon, opts)
  data
end

.update_discount_coupon_by_id_with_http_info(discount_coupon_id, discount_coupon, opts = {}) ⇒ Array<(DiscountCoupon, Fixnum, Hash)>

Update DiscountCoupon Update attributes of DiscountCoupon

Parameters:

  • discount_coupon_id —

    ID of discountCoupon to update.

  • discount_coupon —

    Attributes of discountCoupon to update.

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

    the optional parameters

Returns:

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

    DiscountCoupon data, response status code and response headers



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 766

def update_discount_coupon_by_id_with_http_info(discount_coupon_id, discount_coupon, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: DiscountCoupon.update_discount_coupon_by_id ...'
  end
  # verify the required parameter 'discount_coupon_id' is set
  if api_client.config.client_side_validation && discount_coupon_id.nil?
    fail ArgumentError, "Missing the required parameter 'discount_coupon_id' when calling DiscountCoupon.update_discount_coupon_by_id"
  end
  # verify the required parameter 'discount_coupon' is set
  if api_client.config.client_side_validation && discount_coupon.nil?
    fail ArgumentError, "Missing the required parameter 'discount_coupon' when calling DiscountCoupon.update_discount_coupon_by_id"
  end
  # resource path
  local_var_path = '/discountCoupons/{discountCouponId}'.sub('{' + 'discountCouponId' + '}', discount_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(discount_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 => 'DiscountCoupon')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: DiscountCoupon#update_discount_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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 268

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 &&
      type == o.type &&
      amount == o.amount
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 322

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 388

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 301

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



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

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

#delete ⇒ nil

Delete DiscountCoupon Delete this instance of DiscountCoupon.

Returns:

  • (nil) 


425
426
427
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 425

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


288
289
290
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 288

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



294
295
296
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 294

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

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/discount_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/discount_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
222
223
224
225
226
227
228
229
 
# File 'lib/tradenity/resources/discount_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

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

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



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

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



374
375
376
377
378
379
380
381
382
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 374

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



362
363
364
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 362

def to_s
  to_hash.to_s
end

#update ⇒ DiscountCoupon

Update DiscountCoupon Update attributes of DiscountCoupon

Returns:



418
419
420
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 418

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



233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/tradenity/resources/discount_coupon.rb', line 233

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?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['percentage', 'fixedRate'])
  return false unless type_validator.valid?(@type)
  return false if @amount.nil?
  true
end