Class: Tradenity::State

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ State

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/tradenity/resources/state.rb', line 72

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

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

Instance Attribute Details

#__metaObject

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#codeObject

Returns the value of attribute code.



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

def code
  @code
end

#countryObject

Returns the value of attribute country.



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

def country
  @country
end

#created_atObject

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#updated_atObject

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_clientObject



267
268
269
# File 'lib/tradenity/resources/state.rb', line 267

def self.api_client
  ApiClient.default
end

.attribute_mapObject

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



45
46
47
48
49
50
51
52
53
54
55
# File 'lib/tradenity/resources/state.rb', line 45

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'code' => :'code',
    :'country' => :'country'
  }
end

.create_state(state, opts = {}) ⇒ State

Create State Create a new State

Parameters:

  • state

    Attributes of state to create

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

    the optional parameters

Returns:



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

def create_state(state, opts = {})
  data, _status_code, _headers = create_state_with_http_info(state, opts)
  data
end

.create_state_with_http_info(state, opts = {}) ⇒ Array<(State, Fixnum, Hash)>

Create State Create a new State

Parameters:

  • state

    Attributes of state to create

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

    the optional parameters

Returns:

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

    State data, response status code and response headers



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
# File 'lib/tradenity/resources/state.rb', line 350

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

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

.delete_by_id(id) ⇒ nil

Delete State Delete an instance of State by its ID.

Parameters:

  • id

    ID of State to delete.

Returns:

  • (nil)


331
332
333
# File 'lib/tradenity/resources/state.rb', line 331

def delete_by_id(id)
  delete_state_by_id(id)
end

.delete_state_by_id(state_id, opts = {}) ⇒ nil

Delete State Delete an instance of State by its ID.

Parameters:

  • state_id

    ID of state to delete.

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

    the optional parameters

Returns:

  • (nil)


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

def delete_state_by_id(state_id, opts = {})
  delete_state_by_id_with_http_info(state_id, opts)
  nil
end

.delete_state_by_id_with_http_info(state_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete State Delete an instance of State by its ID.

Parameters:

  • state_id

    ID of state to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



404
405
406
407
408
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
# File 'lib/tradenity/resources/state.rb', line 404

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

.find_allPage<State>

List States Return a list of States

Parameters:

  • opts (Hash)

    the optional parameters

Returns:



299
300
301
# File 'lib/tradenity/resources/state.rb', line 299

def find_all
  list_all_states
end

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

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

Parameters:

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

    the search parameters

Returns:



307
308
309
# File 'lib/tradenity/resources/state.rb', line 307

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

.find_by_id(id) ⇒ State

Find State Return single instance of State by its ID.

Parameters:

  • id

    ID of State to return

Returns:



323
324
325
# File 'lib/tradenity/resources/state.rb', line 323

def find_by_id(id)
  get_state_by_id(id)
end

.find_one_by(opts = {}) ⇒ State

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

Parameters:

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

    search parameters

Returns:



315
316
317
# File 'lib/tradenity/resources/state.rb', line 315

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

.get_state_by_id(state_id, opts = {}) ⇒ State

Find State Return single instance of State by its ID.

Parameters:

  • state_id

    ID of state to return

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

    the optional parameters

Returns:



447
448
449
450
# File 'lib/tradenity/resources/state.rb', line 447

def get_state_by_id(state_id, opts = {})
  data, _status_code, _headers = get_state_by_id_with_http_info(state_id, opts)
  data
end

.get_state_by_id_with_http_info(state_id, opts = {}) ⇒ Array<(State, Fixnum, Hash)>

Find State Return single instance of State by its ID.

Parameters:

  • state_id

    ID of state to return

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

    the optional parameters

Returns:

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

    State data, response status code and response headers



457
458
459
460
461
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
# File 'lib/tradenity/resources/state.rb', line 457

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

.list_all_states(opts = {}) ⇒ Page<State>

List States Return a list of States

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)

    page number

  • :size (Integer)

    page size

  • :sort (String)

    page order

Returns:



503
504
505
506
# File 'lib/tradenity/resources/state.rb', line 503

def list_all_states(opts = {})
  data, _status_code, _headers = list_all_states_with_http_info(opts)
  data
end

.list_all_states_with_http_info(opts = {}) ⇒ Array<(Page<State>, Fixnum, Hash)>

List States Return a list of States

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

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



515
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
# File 'lib/tradenity/resources/state.rb', line 515

def list_all_states_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: State.list_all_states ...'
  end
  # resource path
  local_var_path = '/states'

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

.replace_state_by_id(state_id, state, opts = {}) ⇒ State

Replace State Replace all attributes of State

Parameters:

  • state_id

    ID of state to replace

  • state

    Attributes of state to replace

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

    the optional parameters

Returns:



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

def replace_state_by_id(state_id, state, opts = {})
  data, _status_code, _headers = replace_state_by_id_with_http_info(state_id, state, opts)
  data
end

.replace_state_by_id_with_http_info(state_id, state, opts = {}) ⇒ Array<(State, Fixnum, Hash)>

Replace State Replace all attributes of State

Parameters:

  • state_id

    ID of state to replace

  • state

    Attributes of state to replace

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

    the optional parameters

Returns:

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

    State data, response status code and response headers



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

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

.swagger_typesObject

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
# File 'lib/tradenity/resources/state.rb', line 58

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'code' => :'String',
    :'country' => :'Country'
  }
end

.update_state_by_id(state_id, state, opts = {}) ⇒ State

Update State Update attributes of State

Parameters:

  • state_id

    ID of state to update.

  • state

    Attributes of state to update.

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

    the optional parameters

Returns:



619
620
621
622
# File 'lib/tradenity/resources/state.rb', line 619

def update_state_by_id(state_id, state, opts = {})
  data, _status_code, _headers = update_state_by_id_with_http_info(state_id, state, opts)
  data
end

.update_state_by_id_with_http_info(state_id, state, opts = {}) ⇒ Array<(State, Fixnum, Hash)>

Update State Update attributes of State

Parameters:

  • state_id

    ID of state to update.

  • state

    Attributes of state to update.

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

    the optional parameters

Returns:

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

    State data, response status code and response headers



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
672
# File 'lib/tradenity/resources/state.rb', line 630

def update_state_by_id_with_http_info(state_id, state, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: State.update_state_by_id ...'
  end
  # verify the required parameter 'state_id' is set
  if api_client.config.client_side_validation && state_id.nil?
    fail ArgumentError, "Missing the required parameter 'state_id' when calling State.update_state_by_id"
  end
  # verify the required parameter 'state' is set
  if api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling State.update_state_by_id"
  end
  # resource path
  local_var_path = '/states/{stateId}'.sub('{' + 'stateId' + '}', state_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(state)
  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 => 'State')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: State#update_state_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



139
140
141
142
143
144
145
146
147
148
# File 'lib/tradenity/resources/state.rb', line 139

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 &&
      code == o.code &&
      country == o.country
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



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
# File 'lib/tradenity/resources/state.rb', line 186

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



252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/tradenity/resources/state.rb', line 252

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/tradenity/resources/state.rb', line 165

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



273
274
275
276
277
# File 'lib/tradenity/resources/state.rb', line 273

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

#deletenil

Delete State Delete this instance of State.

Returns:

  • (nil)


289
290
291
# File 'lib/tradenity/resources/state.rb', line 289

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


152
153
154
# File 'lib/tradenity/resources/state.rb', line 152

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



158
159
160
# File 'lib/tradenity/resources/state.rb', line 158

def hash
  [__meta, created_at, updated_at, name, code, country].hash
end

#idObject



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



116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/tradenity/resources/state.rb', line 116

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

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



232
233
234
# File 'lib/tradenity/resources/state.rb', line 232

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



238
239
240
241
242
243
244
245
246
# File 'lib/tradenity/resources/state.rb', line 238

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



226
227
228
# File 'lib/tradenity/resources/state.rb', line 226

def to_s
  to_hash.to_s
end

#updateState

Update State Update attributes of State

Returns:



282
283
284
# File 'lib/tradenity/resources/state.rb', line 282

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



131
132
133
134
135
# File 'lib/tradenity/resources/state.rb', line 131

def valid?
  return false if @name.nil?
  return false if @country.nil?
  true
end