Class: Tradenity::Option

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Option

Initializes the object

Parameters:

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

    Model attributes in the form of hash



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/tradenity/resources/option.rb', line 114

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

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

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

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

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

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

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

Instance Attribute Details

#__metaObject

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#created_atObject

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#data_typeObject

Returns the value of attribute data_type.



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

def data_type
  @data_type
end

#descriptionObject

Returns the value of attribute description.



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

def description
  @description
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#positionObject

Returns the value of attribute position.



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

def position
  @position
end

#requiredObject

Returns the value of attribute required.



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

def required
  @required
end

#slugObject

Returns the value of attribute slug.



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

def slug
  @slug
end

#statusObject

Returns the value of attribute status.



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

def status
  @status
end

#updated_atObject

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#valuesObject

Returns the value of attribute values.



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

def values
  @values
end

Class Method Details

.api_clientObject



379
380
381
# File 'lib/tradenity/resources/option.rb', line 379

def self.api_client
  ApiClient.default
end

.attribute_mapObject

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/tradenity/resources/option.rb', line 77

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'slug' => :'slug',
    :'description' => :'description',
    :'required' => :'required',
    :'data_type' => :'dataType',
    :'status' => :'status',
    :'position' => :'position',
    :'values' => :'values'
  }
end

.create_option(option, opts = {}) ⇒ Option

Create Option Create a new Option

Parameters:

  • option

    Attributes of option to create

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

    the optional parameters

Returns:



452
453
454
455
# File 'lib/tradenity/resources/option.rb', line 452

def create_option(option, opts = {})
  data, _status_code, _headers = create_option_with_http_info(option, opts)
  data
end

.create_option_with_http_info(option, opts = {}) ⇒ Array<(Option, Fixnum, Hash)>

Create Option Create a new Option

Parameters:

  • option

    Attributes of option to create

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

    the optional parameters

Returns:

  • (Array<(Option, Fixnum, Hash)>)

    Option data, response status code and response headers



462
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/option.rb', line 462

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

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

.delete_by_id(id) ⇒ nil

Delete Option Delete an instance of Option by its ID.

Parameters:

  • id

    ID of Option to delete.

Returns:

  • (nil)


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

def delete_by_id(id)
  delete_option_by_id(id)
end

.delete_option_by_id(option_id, opts = {}) ⇒ nil

Delete Option Delete an instance of Option by its ID.

Parameters:

  • option_id

    ID of option to delete.

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

    the optional parameters

Returns:

  • (nil)


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

def delete_option_by_id(option_id, opts = {})
  delete_option_by_id_with_http_info(option_id, opts)
  nil
end

.delete_option_by_id_with_http_info(option_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Option Delete an instance of Option by its ID.

Parameters:

  • option_id

    ID of option to delete.

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

    the optional parameters

Returns:

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

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

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

.find_allPage<Option>

List Options Return a list of Options

Parameters:

  • opts (Hash)

    the optional parameters

Returns:



411
412
413
# File 'lib/tradenity/resources/option.rb', line 411

def find_all
  list_all_options
end

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

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

Parameters:

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

    the search parameters

Returns:



419
420
421
# File 'lib/tradenity/resources/option.rb', line 419

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

.find_by_id(id) ⇒ Option

Find Option Return single instance of Option by its ID.

Parameters:

  • id

    ID of Option to return

Returns:



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

def find_by_id(id)
  get_option_by_id(id)
end

.find_one_by(opts = {}) ⇒ Option

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

Parameters:

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

    search parameters

Returns:



427
428
429
# File 'lib/tradenity/resources/option.rb', line 427

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

.get_option_by_id(option_id, opts = {}) ⇒ Option

Find Option Return single instance of Option by its ID.

Parameters:

  • option_id

    ID of option to return

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

    the optional parameters

Returns:



559
560
561
562
# File 'lib/tradenity/resources/option.rb', line 559

def get_option_by_id(option_id, opts = {})
  data, _status_code, _headers = get_option_by_id_with_http_info(option_id, opts)
  data
end

.get_option_by_id_with_http_info(option_id, opts = {}) ⇒ Array<(Option, Fixnum, Hash)>

Find Option Return single instance of Option by its ID.

Parameters:

  • option_id

    ID of option to return

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

    the optional parameters

Returns:

  • (Array<(Option, Fixnum, Hash)>)

    Option data, response status code and response headers



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
# File 'lib/tradenity/resources/option.rb', line 569

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

.list_all_options(opts = {}) ⇒ Page<Option>

List Options Return a list of Options

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number

  • :size (Integer)

    page size

  • :sort (String)

    page order

Returns:



615
616
617
618
# File 'lib/tradenity/resources/option.rb', line 615

def list_all_options(opts = {})
  data, _status_code, _headers = list_all_options_with_http_info(opts)
  data
end

.list_all_options_with_http_info(opts = {}) ⇒ Array<(Page<Option>, Fixnum, Hash)>

List Options Return a list of Options

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

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



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
# File 'lib/tradenity/resources/option.rb', line 627

def list_all_options_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Option.list_all_options ...'
  end
  # resource path
  local_var_path = '/options'

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

.replace_option_by_id(option_id, option, opts = {}) ⇒ Option

Replace Option Replace all attributes of Option

Parameters:

  • option_id

    ID of option to replace

  • option

    Attributes of option to replace

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

    the optional parameters

Returns:



671
672
673
674
# File 'lib/tradenity/resources/option.rb', line 671

def replace_option_by_id(option_id, option, opts = {})
  data, _status_code, _headers = replace_option_by_id_with_http_info(option_id, option, opts)
  data
end

.replace_option_by_id_with_http_info(option_id, option, opts = {}) ⇒ Array<(Option, Fixnum, Hash)>

Replace Option Replace all attributes of Option

Parameters:

  • option_id

    ID of option to replace

  • option

    Attributes of option to replace

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

    the optional parameters

Returns:

  • (Array<(Option, Fixnum, Hash)>)

    Option data, response status code and response headers



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
# File 'lib/tradenity/resources/option.rb', line 682

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

.swagger_typesObject

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/tradenity/resources/option.rb', line 95

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'slug' => :'String',
    :'description' => :'String',
    :'required' => :'BOOLEAN',
    :'data_type' => :'String',
    :'status' => :'String',
    :'position' => :'Integer',
    :'values' => :'Array<OptionValue>'
  }
end

.update_option_by_id(option_id, option, opts = {}) ⇒ Option

Update Option Update attributes of Option

Parameters:

  • option_id

    ID of option to update.

  • option

    Attributes of option to update.

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

    the optional parameters

Returns:



731
732
733
734
# File 'lib/tradenity/resources/option.rb', line 731

def update_option_by_id(option_id, option, opts = {})
  data, _status_code, _headers = update_option_by_id_with_http_info(option_id, option, opts)
  data
end

.update_option_by_id_with_http_info(option_id, option, opts = {}) ⇒ Array<(Option, Fixnum, Hash)>

Update Option Update attributes of Option

Parameters:

  • option_id

    ID of option to update.

  • option

    Attributes of option to update.

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

    the optional parameters

Returns:

  • (Array<(Option, Fixnum, Hash)>)

    Option data, response status code and response headers



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      slug == o.slug &&
      description == o.description &&
      required == o.required &&
      data_type == o.data_type &&
      status == o.status &&
      position == o.position &&
      values == o.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



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

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



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

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



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

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

#createObject

Create Option Create a new Option



385
386
387
388
389
# File 'lib/tradenity/resources/option.rb', line 385

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

#deletenil

Delete Option Delete this instance of Option.

Returns:

  • (nil)


401
402
403
# File 'lib/tradenity/resources/option.rb', line 401

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
# File 'lib/tradenity/resources/option.rb', line 264

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



270
271
272
# File 'lib/tradenity/resources/option.rb', line 270

def hash
  [__meta, created_at, updated_at, name, slug, description, required, data_type, status, position, values].hash
end

#idObject



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

def id=(id)
  @id = id
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/tradenity/resources/option.rb', line 184

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



344
345
346
# File 'lib/tradenity/resources/option.rb', line 344

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



338
339
340
# File 'lib/tradenity/resources/option.rb', line 338

def to_s
  to_hash.to_s
end

#updateOption

Update Option Update attributes of Option

Returns:



394
395
396
# File 'lib/tradenity/resources/option.rb', line 394

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



211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/tradenity/resources/option.rb', line 211

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