Class: Tradenity::StripeGateway

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StripeGateway

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#__meta ⇒ Object

Returns the value of attribute __meta.



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

def __meta
  @__meta
end

#account_id ⇒ Object

Returns the value of attribute account_id.



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

def 
  @account_id
end

#authorize_only ⇒ Object

Returns the value of attribute authorize_only.



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

def authorize_only
  @authorize_only
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#mode ⇒ Object

Returns the value of attribute mode.



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

def mode
  @mode
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#public_key ⇒ Object

Returns the value of attribute public_key.



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

def public_key
  @public_key
end

#secret_key ⇒ Object

Returns the value of attribute secret_key.



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

def secret_key
  @secret_key
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#test_public_key ⇒ Object

Returns the value of attribute test_public_key.



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

def test_public_key
  @test_public_key
end

#test_secret_key ⇒ Object

Returns the value of attribute test_secret_key.



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

def test_secret_key
  @test_secret_key
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



396
397
398
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 396

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 79

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'mode' => :'mode',
    :'authorize_only' => :'authorizeOnly',
    :'account_id' => :'accountId',
    :'status' => :'status',
    :'secret_key' => :'secretKey',
    :'public_key' => :'publicKey',
    :'test_secret_key' => :'testSecretKey',
    :'test_public_key' => :'testPublicKey'
  }
end

.create_stripe_gateway(stripe_gateway, opts = {}) ⇒ StripeGateway

Create StripeGateway Create a new StripeGateway

Parameters:

  • stripe_gateway —

    Attributes of stripeGateway to create

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

    the optional parameters

Returns:



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

def create_stripe_gateway(stripe_gateway, opts = {})
  data, _status_code, _headers = create_stripe_gateway_with_http_info(stripe_gateway, opts)
  data
end

.create_stripe_gateway_with_http_info(stripe_gateway, opts = {}) ⇒ Array<(StripeGateway, Fixnum, Hash)>

Create StripeGateway Create a new StripeGateway

Parameters:

  • stripe_gateway —

    Attributes of stripeGateway to create

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

    the optional parameters

Returns:

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

    StripeGateway data, response status code and response headers



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
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 479

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

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

.delete_by_id(id) ⇒ nil

Delete StripeGateway Delete an instance of StripeGateway by its ID.

Parameters:

  • id —

    ID of StripeGateway to delete.

Returns:

  • (nil) 


460
461
462
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 460

def delete_by_id(id)
  delete_stripe_gateway_by_id(id)
end

.delete_stripe_gateway_by_id(stripe_gateway_id, opts = {}) ⇒ nil

Delete StripeGateway Delete an instance of StripeGateway by its ID.

Parameters:

  • stripe_gateway_id —

    ID of stripeGateway to delete.

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

    the optional parameters

Returns:

  • (nil) 


523
524
525
526
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 523

def delete_stripe_gateway_by_id(stripe_gateway_id, opts = {})
  delete_stripe_gateway_by_id_with_http_info(stripe_gateway_id, opts)
  nil
end

.delete_stripe_gateway_by_id_with_http_info(stripe_gateway_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete StripeGateway Delete an instance of StripeGateway by its ID.

Parameters:

  • stripe_gateway_id —

    ID of stripeGateway to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
564
565
566
567
568
569
570
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 533

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

.find_all ⇒ Page<StripeGateway>

List StripeGateways Return a list of StripeGateways

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



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

def find_all
  list_all_stripe_gateways
end

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

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

Parameters:

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

    the search parameters

Returns:



436
437
438
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 436

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

.find_by_id(id) ⇒ StripeGateway

Find StripeGateway Return single instance of StripeGateway by its ID.

Parameters:

  • id —

    ID of StripeGateway to return

Returns:



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

def find_by_id(id)
  get_stripe_gateway_by_id(id)
end

.find_one_by(opts = {}) ⇒ StripeGateway

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

Parameters:

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

    search parameters

Returns:



444
445
446
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 444

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

.get_stripe_gateway_by_id(stripe_gateway_id, opts = {}) ⇒ StripeGateway

Find StripeGateway Return single instance of StripeGateway by its ID.

Parameters:

  • stripe_gateway_id —

    ID of stripeGateway to return

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

    the optional parameters

Returns:



576
577
578
579
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 576

def get_stripe_gateway_by_id(stripe_gateway_id, opts = {})
  data, _status_code, _headers = get_stripe_gateway_by_id_with_http_info(stripe_gateway_id, opts)
  data
end

.get_stripe_gateway_by_id_with_http_info(stripe_gateway_id, opts = {}) ⇒ Array<(StripeGateway, Fixnum, Hash)>

Find StripeGateway Return single instance of StripeGateway by its ID.

Parameters:

  • stripe_gateway_id —

    ID of stripeGateway to return

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

    the optional parameters

Returns:

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

    StripeGateway data, response status code and response headers



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
624
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 586

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

.list_all_stripe_gateways(opts = {}) ⇒ Page<StripeGateway>

List StripeGateways Return a list of StripeGateways

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



632
633
634
635
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 632

def list_all_stripe_gateways(opts = {})
  data, _status_code, _headers = list_all_stripe_gateways_with_http_info(opts)
  data
end

.list_all_stripe_gateways_with_http_info(opts = {}) ⇒ Array<(Page<StripeGateway>, Fixnum, Hash)>

List StripeGateways Return a list of StripeGateways

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

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



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

def list_all_stripe_gateways_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StripeGateway.list_all_stripe_gateways ...'
  end
  # resource path
  local_var_path = '/stripeGateways'

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

.replace_stripe_gateway_by_id(stripe_gateway_id, stripe_gateway, opts = {}) ⇒ StripeGateway

Replace StripeGateway Replace all attributes of StripeGateway

Parameters:

  • stripe_gateway_id —

    ID of stripeGateway to replace

  • stripe_gateway —

    Attributes of stripeGateway to replace

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

    the optional parameters

Returns:



688
689
690
691
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 688

def replace_stripe_gateway_by_id(stripe_gateway_id, stripe_gateway, opts = {})
  data, _status_code, _headers = replace_stripe_gateway_by_id_with_http_info(stripe_gateway_id, stripe_gateway, opts)
  data
end

.replace_stripe_gateway_by_id_with_http_info(stripe_gateway_id, stripe_gateway, opts = {}) ⇒ Array<(StripeGateway, Fixnum, Hash)>

Replace StripeGateway Replace all attributes of StripeGateway

Parameters:

  • stripe_gateway_id —

    ID of stripeGateway to replace

  • stripe_gateway —

    Attributes of stripeGateway to replace

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

    the optional parameters

Returns:

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

    StripeGateway data, response status code and response headers



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
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 699

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

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 98

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'mode' => :'String',
    :'authorize_only' => :'BOOLEAN',
    :'account_id' => :'String',
    :'status' => :'String',
    :'secret_key' => :'String',
    :'public_key' => :'String',
    :'test_secret_key' => :'String',
    :'test_public_key' => :'String'
  }
end

.update_stripe_gateway_by_id(stripe_gateway_id, stripe_gateway, opts = {}) ⇒ StripeGateway

Update StripeGateway Update attributes of StripeGateway

Parameters:

  • stripe_gateway_id —

    ID of stripeGateway to update.

  • stripe_gateway —

    Attributes of stripeGateway to update.

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

    the optional parameters

Returns:



748
749
750
751
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 748

def update_stripe_gateway_by_id(stripe_gateway_id, stripe_gateway, opts = {})
  data, _status_code, _headers = update_stripe_gateway_by_id_with_http_info(stripe_gateway_id, stripe_gateway, opts)
  data
end

.update_stripe_gateway_by_id_with_http_info(stripe_gateway_id, stripe_gateway, opts = {}) ⇒ Array<(StripeGateway, Fixnum, Hash)>

Update StripeGateway Update attributes of StripeGateway

Parameters:

  • stripe_gateway_id —

    ID of stripeGateway to update.

  • stripe_gateway —

    Attributes of stripeGateway to update.

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

    the optional parameters

Returns:

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

    StripeGateway data, response status code and response headers



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
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 759

def update_stripe_gateway_by_id_with_http_info(stripe_gateway_id, stripe_gateway, opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: StripeGateway.update_stripe_gateway_by_id ...'
  end
  # verify the required parameter 'stripe_gateway_id' is set
  if api_client.config.client_side_validation && stripe_gateway_id.nil?
    fail ArgumentError, "Missing the required parameter 'stripe_gateway_id' when calling StripeGateway.update_stripe_gateway_by_id"
  end
  # verify the required parameter 'stripe_gateway' is set
  if api_client.config.client_side_validation && stripe_gateway.nil?
    fail ArgumentError, "Missing the required parameter 'stripe_gateway' when calling StripeGateway.update_stripe_gateway_by_id"
  end
  # resource path
  local_var_path = '/stripeGateways/{stripeGatewayId}'.sub('{' + 'stripeGatewayId' + '}', stripe_gateway_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(stripe_gateway)
  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 => 'StripeGateway')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: StripeGateway#update_stripe_gateway_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



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

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 &&
      mode == o.mode &&
      authorize_only == o.authorize_only &&
       == o. &&
      status == o.status &&
      secret_key == o.secret_key &&
      public_key == o.public_key &&
      test_secret_key == o.test_secret_key &&
      test_public_key == o.test_public_key
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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 315

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 381

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 294

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



402
403
404
405
406
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 402

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

#delete ⇒ nil

Delete StripeGateway Delete this instance of StripeGateway.

Returns:

  • (nil) 


418
419
420
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 418

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


281
282
283
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



287
288
289
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 287

def hash
  [__meta, created_at, updated_at, name, mode, authorize_only, , status, secret_key, public_key, test_secret_key, test_public_key].hash
end

#id ⇒ Object 



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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 210

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

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



361
362
363
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 361

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



367
368
369
370
371
372
373
374
375
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 367

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



355
356
357
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 355

def to_s
  to_hash.to_s
end

#update ⇒ StripeGateway

Update StripeGateway Update attributes of StripeGateway

Returns:



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

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



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/tradenity/resources/stripe_gateway.rb', line 229

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