Class: Tradenity::Collection

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Collection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/tradenity/resources/collection.rb', line 102

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#products ⇒ Object

Returns the value of attribute products.



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

def products
  @products
end

#slug ⇒ Object

Returns the value of attribute slug.



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

def slug
  @slug
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



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

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/tradenity/resources/collection.rb', line 71

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'slug' => :'slug',
    :'status' => :'status',
    :'description' => :'description',
    :'products' => :'products'
  }
end

.create_collection(collection, opts = {}) ⇒ Collection

Create Collection Create a new Collection

Parameters:

  • collection —

    Attributes of collection to create

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

    the optional parameters

Returns:



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

def create_collection(collection, opts = {})
  data, _status_code, _headers = create_collection_with_http_info(collection, opts)
  data
end

.create_collection_with_http_info(collection, opts = {}) ⇒ Array<(Collection, Fixnum, Hash)>

Create Collection Create a new Collection

Parameters:

  • collection —

    Attributes of collection to create

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

    the optional parameters

Returns:

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

    Collection data, response status code and response headers



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/tradenity/resources/collection.rb', line 409

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

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

.delete_by_id(id) ⇒ nil

Delete Collection Delete an instance of Collection by its ID.

Parameters:

  • id —

    ID of Collection to delete.

Returns:

  • (nil) 


390
391
392
 
# File 'lib/tradenity/resources/collection.rb', line 390

def delete_by_id(id)
  delete_collection_by_id(id)
end

.delete_collection_by_id(collection_id, opts = {}) ⇒ nil

Delete Collection Delete an instance of Collection by its ID.

Parameters:

  • collection_id —

    ID of collection to delete.

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_collection_by_id(collection_id, opts = {})
  delete_collection_by_id_with_http_info(collection_id, opts)
  nil
end

.delete_collection_by_id_with_http_info(collection_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Collection Delete an instance of Collection by its ID.

Parameters:

  • collection_id —

    ID of collection to delete.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/tradenity/resources/collection.rb', line 463

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

.find_all ⇒ Page<Collection>

List Collections Return a list of Collections

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



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

def find_all
  list_all_collections
end

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

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

Parameters:

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

    the search parameters

Returns:



366
367
368
 
# File 'lib/tradenity/resources/collection.rb', line 366

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

.find_by_id(id) ⇒ Collection

Find Collection Return single instance of Collection by its ID.

Parameters:

  • id —

    ID of Collection to return

Returns:



382
383
384
 
# File 'lib/tradenity/resources/collection.rb', line 382

def find_by_id(id)
  get_collection_by_id(id)
end

.find_one_by(opts = {}) ⇒ Collection

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

Parameters:

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

    search parameters

Returns:



374
375
376
 
# File 'lib/tradenity/resources/collection.rb', line 374

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

.get_collection_by_id(collection_id, opts = {}) ⇒ Collection

Find Collection Return single instance of Collection by its ID.

Parameters:

  • collection_id —

    ID of collection to return

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

    the optional parameters

Returns:



506
507
508
509
 
# File 'lib/tradenity/resources/collection.rb', line 506

def get_collection_by_id(collection_id, opts = {})
  data, _status_code, _headers = get_collection_by_id_with_http_info(collection_id, opts)
  data
end

.get_collection_by_id_with_http_info(collection_id, opts = {}) ⇒ Array<(Collection, Fixnum, Hash)>

Find Collection Return single instance of Collection by its ID.

Parameters:

  • collection_id —

    ID of collection to return

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

    the optional parameters

Returns:

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

    Collection data, response status code and response headers



516
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/collection.rb', line 516

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

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

List Collections Return a list of Collections

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



562
563
564
565
 
# File 'lib/tradenity/resources/collection.rb', line 562

def list_all_collections(opts = {})
  data, _status_code, _headers = list_all_collections_with_http_info(opts)
  data
end

.list_all_collections_with_http_info(opts = {}) ⇒ Array<(Page<Collection>, Fixnum, Hash)>

List Collections Return a list of Collections

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

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



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
609
610
611
 
# File 'lib/tradenity/resources/collection.rb', line 574

def list_all_collections_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Collection.list_all_collections ...'
  end
  # resource path
  local_var_path = '/collections'

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

.replace_collection_by_id(collection_id, collection, opts = {}) ⇒ Collection

Replace Collection Replace all attributes of Collection

Parameters:

  • collection_id —

    ID of collection to replace

  • collection —

    Attributes of collection to replace

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

    the optional parameters

Returns:



618
619
620
621
 
# File 'lib/tradenity/resources/collection.rb', line 618

def replace_collection_by_id(collection_id, collection, opts = {})
  data, _status_code, _headers = replace_collection_by_id_with_http_info(collection_id, collection, opts)
  data
end

.replace_collection_by_id_with_http_info(collection_id, collection, opts = {}) ⇒ Array<(Collection, Fixnum, Hash)>

Replace Collection Replace all attributes of Collection

Parameters:

  • collection_id —

    ID of collection to replace

  • collection —

    Attributes of collection to replace

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

    the optional parameters

Returns:

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

    Collection data, response status code and response headers



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
666
667
668
669
670
671
 
# File 'lib/tradenity/resources/collection.rb', line 629

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

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/tradenity/resources/collection.rb', line 86

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'slug' => :'String',
    :'status' => :'String',
    :'description' => :'String',
    :'products' => :'Array<Product>'
  }
end

.update_collection_by_id(collection_id, collection, opts = {}) ⇒ Collection

Update Collection Update attributes of Collection

Parameters:

  • collection_id —

    ID of collection to update.

  • collection —

    Attributes of collection to update.

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

    the optional parameters

Returns:



678
679
680
681
 
# File 'lib/tradenity/resources/collection.rb', line 678

def update_collection_by_id(collection_id, collection, opts = {})
  data, _status_code, _headers = update_collection_by_id_with_http_info(collection_id, collection, opts)
  data
end

.update_collection_by_id_with_http_info(collection_id, collection, opts = {}) ⇒ Array<(Collection, Fixnum, Hash)>

Update Collection Update attributes of Collection

Parameters:

  • collection_id —

    ID of collection to update.

  • collection —

    Attributes of collection to update.

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

    the optional parameters

Returns:

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

    Collection data, response status code and response headers



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
726
727
728
729
730
731
 
# File 'lib/tradenity/resources/collection.rb', line 689

def update_collection_by_id_with_http_info(collection_id, collection, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Collection.update_collection_by_id ...'
  end
  # verify the required parameter 'collection_id' is set
  if api_client.config.client_side_validation && collection_id.nil?
    fail ArgumentError, "Missing the required parameter 'collection_id' when calling Collection.update_collection_by_id"
  end
  # verify the required parameter 'collection' is set
  if api_client.config.client_side_validation && collection.nil?
    fail ArgumentError, "Missing the required parameter 'collection' when calling Collection.update_collection_by_id"
  end
  # resource path
  local_var_path = '/collections/{collectionId}'.sub('{' + 'collectionId' + '}', collection_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(collection)
  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 => 'Collection')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Collection#update_collection_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



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/tradenity/resources/collection.rb', line 196

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 &&
      status == o.status &&
      description == o.description &&
      products == o.products
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



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
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/tradenity/resources/collection.rb', line 245

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/tradenity/resources/collection.rb', line 311

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/tradenity/resources/collection.rb', line 224

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



332
333
334
335
336
 
# File 'lib/tradenity/resources/collection.rb', line 332

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

#delete ⇒ nil

Delete Collection Delete this instance of Collection.

Returns:

  • (nil) 


348
349
350
 
# File 'lib/tradenity/resources/collection.rb', line 348

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


211
212
213
 
# File 'lib/tradenity/resources/collection.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/tradenity/resources/collection.rb', line 217

def hash
  [__meta, created_at, updated_at, name, slug, status, description, products].hash
end

#id ⇒ Object 



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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/tradenity/resources/collection.rb', line 156

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
 
# File 'lib/tradenity/resources/collection.rb', line 291

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



297
298
299
300
301
302
303
304
305
 
# File 'lib/tradenity/resources/collection.rb', line 297

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



285
286
287
 
# File 'lib/tradenity/resources/collection.rb', line 285

def to_s
  to_hash.to_s
end

#update ⇒ Collection

Update Collection Update attributes of Collection

Returns:



341
342
343
 
# File 'lib/tradenity/resources/collection.rb', line 341

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



175
176
177
178
179
180
181
182
 
# File 'lib/tradenity/resources/collection.rb', line 175

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