Class: Tradenity::StoreCredit

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StoreCredit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/tradenity/resources/store_credit.rb', line 76

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#amount ⇒ Object

Returns the value of attribute amount.



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

def amount
  @amount
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#customer ⇒ Object

Returns the value of attribute customer.



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

def customer
  @customer
end

#transactions ⇒ Object

Returns the value of attribute transactions.



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

def transactions
  @transactions
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



278
279
280
 
# File 'lib/tradenity/resources/store_credit.rb', line 278

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/tradenity/resources/store_credit.rb', line 47

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'amount' => :'amount',
    :'customer' => :'customer',
    :'currency' => :'currency',
    :'transactions' => :'transactions'
  }
end

.create_store_credit(store_credit, opts = {}) ⇒ StoreCredit

Create StoreCredit Create a new StoreCredit

Parameters:

  • store_credit —

    Attributes of storeCredit to create

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

    the optional parameters

Returns:



351
352
353
354
 
# File 'lib/tradenity/resources/store_credit.rb', line 351

def create_store_credit(store_credit, opts = {})
  data, _status_code, _headers = create_store_credit_with_http_info(store_credit, opts)
  data
end

.create_store_credit_with_http_info(store_credit, opts = {}) ⇒ Array<(StoreCredit, Fixnum, Hash)>

Create StoreCredit Create a new StoreCredit

Parameters:

  • store_credit —

    Attributes of storeCredit to create

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

    the optional parameters

Returns:

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

    StoreCredit data, response status code and response headers



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
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/tradenity/resources/store_credit.rb', line 361

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

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

.delete_by_id(id) ⇒ nil

Delete StoreCredit Delete an instance of StoreCredit by its ID.

Parameters:

  • id —

    ID of StoreCredit to delete.

Returns:

  • (nil) 


342
343
344
 
# File 'lib/tradenity/resources/store_credit.rb', line 342

def delete_by_id(id)
  delete_store_credit_by_id(id)
end

.delete_store_credit_by_id(store_credit_id, opts = {}) ⇒ nil

Delete StoreCredit Delete an instance of StoreCredit by its ID.

Parameters:

  • store_credit_id —

    ID of storeCredit to delete.

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

    the optional parameters

Returns:

  • (nil) 


405
406
407
408
 
# File 'lib/tradenity/resources/store_credit.rb', line 405

def delete_store_credit_by_id(store_credit_id, opts = {})
  delete_store_credit_by_id_with_http_info(store_credit_id, opts)
  nil
end

.delete_store_credit_by_id_with_http_info(store_credit_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete StoreCredit Delete an instance of StoreCredit by its ID.

Parameters:

  • store_credit_id —

    ID of storeCredit to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
448
449
450
451
452
 
# File 'lib/tradenity/resources/store_credit.rb', line 415

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

.find_all ⇒ Page<StoreCredit>

List StoreCredits Return a list of StoreCredits

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



310
311
312
 
# File 'lib/tradenity/resources/store_credit.rb', line 310

def find_all
  list_all_store_credits
end

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

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

Parameters:

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

    the search parameters

Returns:



318
319
320
 
# File 'lib/tradenity/resources/store_credit.rb', line 318

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

.find_by_id(id) ⇒ StoreCredit

Find StoreCredit Return single instance of StoreCredit by its ID.

Parameters:

  • id —

    ID of StoreCredit to return

Returns:



334
335
336
 
# File 'lib/tradenity/resources/store_credit.rb', line 334

def find_by_id(id)
  get_store_credit_by_id(id)
end

.find_one_by(opts = {}) ⇒ StoreCredit

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

Parameters:

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

    search parameters

Returns:



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

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

.get_store_credit_by_id(store_credit_id, opts = {}) ⇒ StoreCredit

Find StoreCredit Return single instance of StoreCredit by its ID.

Parameters:

  • store_credit_id —

    ID of storeCredit to return

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

    the optional parameters

Returns:



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

def get_store_credit_by_id(store_credit_id, opts = {})
  data, _status_code, _headers = get_store_credit_by_id_with_http_info(store_credit_id, opts)
  data
end

.get_store_credit_by_id_with_http_info(store_credit_id, opts = {}) ⇒ Array<(StoreCredit, Fixnum, Hash)>

Find StoreCredit Return single instance of StoreCredit by its ID.

Parameters:

  • store_credit_id —

    ID of storeCredit to return

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

    the optional parameters

Returns:

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

    StoreCredit data, response status code and response headers



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
501
502
503
504
505
506
 
# File 'lib/tradenity/resources/store_credit.rb', line 468

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

.list_all_store_credits(opts = {}) ⇒ Page<StoreCredit>

List StoreCredits Return a list of StoreCredits

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



514
515
516
517
 
# File 'lib/tradenity/resources/store_credit.rb', line 514

def list_all_store_credits(opts = {})
  data, _status_code, _headers = list_all_store_credits_with_http_info(opts)
  data
end

.list_all_store_credits_with_http_info(opts = {}) ⇒ Array<(Page<StoreCredit>, Fixnum, Hash)>

List StoreCredits Return a list of StoreCredits

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

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



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
555
556
557
558
559
560
561
562
563
 
# File 'lib/tradenity/resources/store_credit.rb', line 526

def list_all_store_credits_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreCredit.list_all_store_credits ...'
  end
  # resource path
  local_var_path = '/storeCredits'

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

.replace_store_credit_by_id(store_credit_id, store_credit, opts = {}) ⇒ StoreCredit

Replace StoreCredit Replace all attributes of StoreCredit

Parameters:

  • store_credit_id —

    ID of storeCredit to replace

  • store_credit —

    Attributes of storeCredit to replace

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

    the optional parameters

Returns:



570
571
572
573
 
# File 'lib/tradenity/resources/store_credit.rb', line 570

def replace_store_credit_by_id(store_credit_id, store_credit, opts = {})
  data, _status_code, _headers = replace_store_credit_by_id_with_http_info(store_credit_id, store_credit, opts)
  data
end

.replace_store_credit_by_id_with_http_info(store_credit_id, store_credit, opts = {}) ⇒ Array<(StoreCredit, Fixnum, Hash)>

Replace StoreCredit Replace all attributes of StoreCredit

Parameters:

  • store_credit_id —

    ID of storeCredit to replace

  • store_credit —

    Attributes of storeCredit to replace

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

    the optional parameters

Returns:

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

    StoreCredit data, response status code and response headers



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
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/tradenity/resources/store_credit.rb', line 581

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

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/tradenity/resources/store_credit.rb', line 61

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'amount' => :'Integer',
    :'customer' => :'Customer',
    :'currency' => :'Currency',
    :'transactions' => :'Array<Transaction>'
  }
end

.update_store_credit_by_id(store_credit_id, store_credit, opts = {}) ⇒ StoreCredit

Update StoreCredit Update attributes of StoreCredit

Parameters:

  • store_credit_id —

    ID of storeCredit to update.

  • store_credit —

    Attributes of storeCredit to update.

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

    the optional parameters

Returns:



630
631
632
633
 
# File 'lib/tradenity/resources/store_credit.rb', line 630

def update_store_credit_by_id(store_credit_id, store_credit, opts = {})
  data, _status_code, _headers = update_store_credit_by_id_with_http_info(store_credit_id, store_credit, opts)
  data
end

.update_store_credit_by_id_with_http_info(store_credit_id, store_credit, opts = {}) ⇒ Array<(StoreCredit, Fixnum, Hash)>

Update StoreCredit Update attributes of StoreCredit

Parameters:

  • store_credit_id —

    ID of storeCredit to update.

  • store_credit —

    Attributes of storeCredit to update.

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

    the optional parameters

Returns:

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

    StoreCredit data, response status code and response headers



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
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/tradenity/resources/store_credit.rb', line 641

def update_store_credit_by_id_with_http_info(store_credit_id, store_credit, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StoreCredit.update_store_credit_by_id ...'
  end
  # verify the required parameter 'store_credit_id' is set
  if api_client.config.client_side_validation && store_credit_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit_id' when calling StoreCredit.update_store_credit_by_id"
  end
  # verify the required parameter 'store_credit' is set
  if api_client.config.client_side_validation && store_credit.nil?
    fail ArgumentError, "Missing the required parameter 'store_credit' when calling StoreCredit.update_store_credit_by_id"
  end
  # resource path
  local_var_path = '/storeCredits/{storeCreditId}'.sub('{' + 'storeCreditId' + '}', store_credit_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(store_credit)
  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 => 'StoreCredit')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StoreCredit#update_store_credit_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



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/tradenity/resources/store_credit.rb', line 149

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 &&
      amount == o.amount &&
      customer == o.customer &&
      currency == o.currency &&
      transactions == o.transactions
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



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

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/tradenity/resources/store_credit.rb', line 263

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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/tradenity/resources/store_credit.rb', line 176

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



284
285
286
287
288
 
# File 'lib/tradenity/resources/store_credit.rb', line 284

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

#delete ⇒ nil

Delete StoreCredit Delete this instance of StoreCredit.

Returns:

  • (nil) 


300
301
302
 
# File 'lib/tradenity/resources/store_credit.rb', line 300

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


163
164
165
 
# File 'lib/tradenity/resources/store_credit.rb', line 163

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



169
170
171
 
# File 'lib/tradenity/resources/store_credit.rb', line 169

def hash
  [__meta, created_at, updated_at, amount, customer, currency, transactions].hash
end

#id ⇒ Object 



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



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/tradenity/resources/store_credit.rb', line 126

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

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



243
244
245
 
# File 'lib/tradenity/resources/store_credit.rb', line 243

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



249
250
251
252
253
254
255
256
257
 
# File 'lib/tradenity/resources/store_credit.rb', line 249

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



237
238
239
 
# File 'lib/tradenity/resources/store_credit.rb', line 237

def to_s
  to_hash.to_s
end

#update ⇒ StoreCredit

Update StoreCredit Update attributes of StoreCredit

Returns:



293
294
295
 
# File 'lib/tradenity/resources/store_credit.rb', line 293

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



141
142
143
144
145
 
# File 'lib/tradenity/resources/store_credit.rb', line 141

def valid?
  return false if @customer.nil?
  return false if @currency.nil?
  true
end