Class: Tradenity::Variant

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Variant

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/tradenity/resources/variant.rb', line 142

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#item_dimensions ⇒ Object

Returns the value of attribute item_dimensions.



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

def item_dimensions
  @item_dimensions
end

#maximum_sell_count ⇒ Object

Returns the value of attribute maximum_sell_count.



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

def maximum_sell_count
  @maximum_sell_count
end

#minimum_stock_level ⇒ Object

Returns the value of attribute minimum_stock_level.



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

def minimum_stock_level
  @minimum_stock_level
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#option_set ⇒ Object

Returns the value of attribute option_set.



64
65
66
 
# File 'lib/tradenity/resources/variant.rb', line 64

def option_set
  @option_set
end

#option_values ⇒ Object

Returns the value of attribute option_values.



66
67
68
 
# File 'lib/tradenity/resources/variant.rb', line 66

def option_values
  @option_values
end

#package_dimensions ⇒ Object

Returns the value of attribute package_dimensions.



58
59
60
 
# File 'lib/tradenity/resources/variant.rb', line 58

def package_dimensions
  @package_dimensions
end

#package_weight ⇒ Object

Returns the value of attribute package_weight.



60
61
62
 
# File 'lib/tradenity/resources/variant.rb', line 60

def package_weight
  @package_weight
end

#price_change ⇒ Object

Returns the value of attribute price_change.



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

def price_change
  @price_change
end

#product ⇒ Object

Returns the value of attribute product.



62
63
64
 
# File 'lib/tradenity/resources/variant.rb', line 62

def product
  @product
end

#sku ⇒ Object

Returns the value of attribute sku.



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

def sku
  @sku
end

#slug ⇒ Object

Returns the value of attribute slug.



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

def slug
  @slug
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#stock_level ⇒ Object

Returns the value of attribute stock_level.



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

def stock_level
  @stock_level
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



469
470
471
 
# File 'lib/tradenity/resources/variant.rb', line 469

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/tradenity/resources/variant.rb', line 91

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'slug' => :'slug',
    :'sku' => :'sku',
    :'description' => :'description',
    :'status' => :'status',
    :'price_change' => :'priceChange',
    :'stock_level' => :'stockLevel',
    :'minimum_stock_level' => :'minimumStockLevel',
    :'maximum_sell_count' => :'maximumSellCount',
    :'item_dimensions' => :'itemDimensions',
    :'package_dimensions' => :'packageDimensions',
    :'package_weight' => :'packageWeight',
    :'product' => :'product',
    :'option_set' => :'optionSet',
    :'option_values' => :'optionValues'
  }
end

.create_variant(variant, opts = {}) ⇒ Variant

Create Variant Create a new Variant

Parameters:

  • variant —

    Attributes of variant to create

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

    the optional parameters

Returns:



542
543
544
545
 
# File 'lib/tradenity/resources/variant.rb', line 542

def create_variant(variant, opts = {})
  data, _status_code, _headers = create_variant_with_http_info(variant, opts)
  data
end

.create_variant_with_http_info(variant, opts = {}) ⇒ Array<(Variant, Fixnum, Hash)>

Create Variant Create a new Variant

Parameters:

  • variant —

    Attributes of variant to create

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

    the optional parameters

Returns:

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

    Variant data, response status code and response headers



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/tradenity/resources/variant.rb', line 552

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

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

.delete_by_id(id) ⇒ nil

Delete Variant Delete an instance of Variant by its ID.

Parameters:

  • id —

    ID of Variant to delete.

Returns:

  • (nil) 


533
534
535
 
# File 'lib/tradenity/resources/variant.rb', line 533

def delete_by_id(id)
  delete_variant_by_id(id)
end

.delete_variant_by_id(variant_id, opts = {}) ⇒ nil

Delete Variant Delete an instance of Variant by its ID.

Parameters:

  • variant_id —

    ID of variant to delete.

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_variant_by_id(variant_id, opts = {})
  delete_variant_by_id_with_http_info(variant_id, opts)
  nil
end

.delete_variant_by_id_with_http_info(variant_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Variant Delete an instance of Variant by its ID.

Parameters:

  • variant_id —

    ID of variant to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/tradenity/resources/variant.rb', line 606

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

.find_all ⇒ Page<Variant>

List Variants Return a list of Variants

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



501
502
503
 
# File 'lib/tradenity/resources/variant.rb', line 501

def find_all
  list_all_variants
end

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

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

Parameters:

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

    the search parameters

Returns:



509
510
511
 
# File 'lib/tradenity/resources/variant.rb', line 509

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

.find_by_id(id) ⇒ Variant

Find Variant Return single instance of Variant by its ID.

Parameters:

  • id —

    ID of Variant to return

Returns:



525
526
527
 
# File 'lib/tradenity/resources/variant.rb', line 525

def find_by_id(id)
  get_variant_by_id(id)
end

.find_one_by(opts = {}) ⇒ Variant

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

Parameters:

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

    search parameters

Returns:



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

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

.get_variant_by_id(variant_id, opts = {}) ⇒ Variant

Find Variant Return single instance of Variant by its ID.

Parameters:

  • variant_id —

    ID of variant to return

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

    the optional parameters

Returns:



649
650
651
652
 
# File 'lib/tradenity/resources/variant.rb', line 649

def get_variant_by_id(variant_id, opts = {})
  data, _status_code, _headers = get_variant_by_id_with_http_info(variant_id, opts)
  data
end

.get_variant_by_id_with_http_info(variant_id, opts = {}) ⇒ Array<(Variant, Fixnum, Hash)>

Find Variant Return single instance of Variant by its ID.

Parameters:

  • variant_id —

    ID of variant to return

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

    the optional parameters

Returns:

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

    Variant data, response status code and response headers



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
689
690
691
692
693
694
695
696
697
 
# File 'lib/tradenity/resources/variant.rb', line 659

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

.list_all_variants(opts = {}) ⇒ Page<Variant>

List Variants Return a list of Variants

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



705
706
707
708
 
# File 'lib/tradenity/resources/variant.rb', line 705

def list_all_variants(opts = {})
  data, _status_code, _headers = list_all_variants_with_http_info(opts)
  data
end

.list_all_variants_with_http_info(opts = {}) ⇒ Array<(Page<Variant>, Fixnum, Hash)>

List Variants Return a list of Variants

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

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



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
749
750
751
752
753
754
 
# File 'lib/tradenity/resources/variant.rb', line 717

def list_all_variants_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Variant.list_all_variants ...'
  end
  # resource path
  local_var_path = '/variants'

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

.replace_variant_by_id(variant_id, variant, opts = {}) ⇒ Variant

Replace Variant Replace all attributes of Variant

Parameters:

  • variant_id —

    ID of variant to replace

  • variant —

    Attributes of variant to replace

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

    the optional parameters

Returns:



761
762
763
764
 
# File 'lib/tradenity/resources/variant.rb', line 761

def replace_variant_by_id(variant_id, variant, opts = {})
  data, _status_code, _headers = replace_variant_by_id_with_http_info(variant_id, variant, opts)
  data
end

.replace_variant_by_id_with_http_info(variant_id, variant, opts = {}) ⇒ Array<(Variant, Fixnum, Hash)>

Replace Variant Replace all attributes of Variant

Parameters:

  • variant_id —

    ID of variant to replace

  • variant —

    Attributes of variant to replace

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

    the optional parameters

Returns:

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

    Variant data, response status code and response headers



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
809
810
811
812
813
814
 
# File 'lib/tradenity/resources/variant.rb', line 772

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

.swagger_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/tradenity/resources/variant.rb', line 116

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'slug' => :'String',
    :'sku' => :'String',
    :'description' => :'String',
    :'status' => :'String',
    :'price_change' => :'Integer',
    :'stock_level' => :'Integer',
    :'minimum_stock_level' => :'Integer',
    :'maximum_sell_count' => :'Integer',
    :'item_dimensions' => :'Dimensions',
    :'package_dimensions' => :'Dimensions',
    :'package_weight' => :'Weight',
    :'product' => :'Product',
    :'option_set' => :'OptionSet',
    :'option_values' => :'Array<OptionValue>'
  }
end

.update_variant_by_id(variant_id, variant, opts = {}) ⇒ Variant

Update Variant Update attributes of Variant

Parameters:

  • variant_id —

    ID of variant to update.

  • variant —

    Attributes of variant to update.

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

    the optional parameters

Returns:



821
822
823
824
 
# File 'lib/tradenity/resources/variant.rb', line 821

def update_variant_by_id(variant_id, variant, opts = {})
  data, _status_code, _headers = update_variant_by_id_with_http_info(variant_id, variant, opts)
  data
end

.update_variant_by_id_with_http_info(variant_id, variant, opts = {}) ⇒ Array<(Variant, Fixnum, Hash)>

Update Variant Update attributes of Variant

Parameters:

  • variant_id —

    ID of variant to update.

  • variant —

    Attributes of variant to update.

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

    the optional parameters

Returns:

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

    Variant data, response status code and response headers



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/tradenity/resources/variant.rb', line 832

def update_variant_by_id_with_http_info(variant_id, variant, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Variant.update_variant_by_id ...'
  end
  # verify the required parameter 'variant_id' is set
  if api_client.config.client_side_validation && variant_id.nil?
    fail ArgumentError, "Missing the required parameter 'variant_id' when calling Variant.update_variant_by_id"
  end
  # verify the required parameter 'variant' is set
  if api_client.config.client_side_validation && variant.nil?
    fail ArgumentError, "Missing the required parameter 'variant' when calling Variant.update_variant_by_id"
  end
  # resource path
  local_var_path = '/variants/{variantId}'.sub('{' + 'variantId' + '}', variant_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(variant)
  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 => 'Variant')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Variant#update_variant_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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/tradenity/resources/variant.rb', line 329

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      slug == o.slug &&
      sku == o.sku &&
      description == o.description &&
      status == o.status &&
      price_change == o.price_change &&
      stock_level == o.stock_level &&
      minimum_stock_level == o.minimum_stock_level &&
      maximum_sell_count == o.maximum_sell_count &&
      item_dimensions == o.item_dimensions &&
      package_dimensions == o.package_dimensions &&
      package_weight == o.package_weight &&
      product == o.product &&
      option_set == o.option_set &&
      option_values == o.option_values
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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/tradenity/resources/variant.rb', line 388

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



454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/tradenity/resources/variant.rb', line 454

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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/tradenity/resources/variant.rb', line 367

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



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

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

#delete ⇒ nil

Delete Variant Delete this instance of Variant.

Returns:

  • (nil) 


491
492
493
 
# File 'lib/tradenity/resources/variant.rb', line 491

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


354
355
356
 
# File 'lib/tradenity/resources/variant.rb', line 354

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [__meta, created_at, updated_at, name, slug, sku, description, status, price_change, stock_level, minimum_stock_level, maximum_sell_count, item_dimensions, package_dimensions, package_weight, product, option_set, option_values].hash
end

#id ⇒ Object 



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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/tradenity/resources/variant.rb', line 274

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

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

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

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

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

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



434
435
436
 
# File 'lib/tradenity/resources/variant.rb', line 434

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



440
441
442
443
444
445
446
447
448
 
# File 'lib/tradenity/resources/variant.rb', line 440

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



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

def to_s
  to_hash.to_s
end

#update ⇒ Variant

Update Variant Update attributes of Variant

Returns:



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

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



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

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