Class: CybridApiBank::VerificationKeysBankApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VerificationKeysBankApi

Returns a new instance of VerificationKeysBankApi.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_verification_key(bank_guid, post_verification_key_bank_model, opts = {}) ⇒ VerificationKeyBankModel

Create VerificationKey Creates a verification key. Example code (python) for generating a Verification Key “‘python import base64 from cryptography.hazmat.primitives import hashes from cryptography.hazmat.primitives import serialization from cryptography.hazmat.primitives.asymmetric import padding from cryptography.hazmat.primitives.asymmetric import rsa nonce = "wen moon" private_key = rsa.generate_private_key(public_exponent=65537, key_size=2048) signature = base64.b64encode(private_key.sign( data=nonce.encode(’ascii’), padding=padding.PKCS1v15(), algorithm=hashes.SHA512())).decode(‘ascii’) public_key = base64.b64encode(private_key.public_key().public_bytes( encoding=serialization.Encoding.DER, format=serialization.PublicFormat.SubjectPublicKeyInfo)).decode(‘ascii’) ““ ## State | State | Description | |——-|————-| | storing | The Platform is storing the verification in our private key store | | pending | The Platform is verifying the verification key’s signature | | verified | The Platform has verified the verification key’s signature and the key can be used | | failed | The Platform was not able to verify the verification key’s signature and the key cannot be used | Required scope: banks:write

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb', line 28

def create_verification_key(bank_guid, post_verification_key_bank_model, opts = {})
  data, _status_code, _headers = create_verification_key_with_http_info(bank_guid, post_verification_key_bank_model, opts)
  data
end

#create_verification_key_with_http_info(bank_guid, post_verification_key_bank_model, opts = {}) ⇒ Array<(VerificationKeyBankModel, Integer, Hash)>

Create VerificationKey Creates a verification key. Example code (python) for generating a Verification Key &#x60;&#x60;&#x60;python import base64 from cryptography.hazmat.primitives import hashes from cryptography.hazmat.primitives import serialization from cryptography.hazmat.primitives.asymmetric import padding from cryptography.hazmat.primitives.asymmetric import rsa nonce &#x3D; &quot;wen moon&quot; private_key &#x3D; rsa.generate_private_key(public_exponent&#x3D;65537, key_size&#x3D;2048) signature &#x3D; base64.b64encode(private_key.sign( data&#x3D;nonce.encode(&#39;ascii&#39;), padding&#x3D;padding.PKCS1v15(), algorithm&#x3D;hashes.SHA512())).decode(&#39;ascii&#39;) public_key &#x3D; base64.b64encode(private_key.public_key().public_bytes( encoding&#x3D;serialization.Encoding.DER, format&#x3D;serialization.PublicFormat.SubjectPublicKeyInfo)).decode(&#39;ascii&#39;) &#x60;&#x60;&#x60;&#x60; ## State | State | Description | |——-|————-| | storing | The Platform is storing the verification in our private key store | | pending | The Platform is verifying the verification key&#39;s signature | | verified | The Platform has verified the verification key&#39;s signature and the key can be used | | failed | The Platform was not able to verify the verification key&#39;s signature and the key cannot be used | Required scope: banks:write

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

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

    the optional parameters

Returns:

  • (Array<(VerificationKeyBankModel, Integer, Hash)>) —

    VerificationKeyBankModel data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb', line 39

def create_verification_key_with_http_info(bank_guid, post_verification_key_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationKeysBankApi.create_verification_key ...'
  end
  # verify the required parameter 'bank_guid' is set
  if @api_client.config.client_side_validation && bank_guid.nil?
    fail ArgumentError, "Missing the required parameter 'bank_guid' when calling VerificationKeysBankApi.create_verification_key"
  end
  # verify the required parameter 'post_verification_key_bank_model' is set
  if @api_client.config.client_side_validation && post_verification_key_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_verification_key_bank_model' when calling VerificationKeysBankApi.create_verification_key"
  end
  # resource path
  local_var_path = '/api/banks/{bank_guid}/verification_keys'.sub('{' + 'bank_guid' + '}', CGI.escape(bank_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_verification_key_bank_model)

  # return_type
  return_type = opts[:debug_return_type] || 'VerificationKeyBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"VerificationKeysBankApi.create_verification_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VerificationKeysBankApi#create_verification_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_verification_key(bank_guid, verification_key_guid, opts = {}) ⇒ VerificationKeyBankModel

Get VerificationKey Retrieves a verification key. Required scope: banks:read

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

  • verification_key_guid (String) —

    Identifier for the verification key.

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb', line 102

def get_verification_key(bank_guid, verification_key_guid, opts = {})
  data, _status_code, _headers = get_verification_key_with_http_info(bank_guid, verification_key_guid, opts)
  data
end

#get_verification_key_with_http_info(bank_guid, verification_key_guid, opts = {}) ⇒ Array<(VerificationKeyBankModel, Integer, Hash)>

Get VerificationKey Retrieves a verification key. Required scope: banks:read

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

  • verification_key_guid (String) —

    Identifier for the verification key.

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

    the optional parameters

Returns:

  • (Array<(VerificationKeyBankModel, Integer, Hash)>) —

    VerificationKeyBankModel data, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb', line 113

def get_verification_key_with_http_info(bank_guid, verification_key_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationKeysBankApi.get_verification_key ...'
  end
  # verify the required parameter 'bank_guid' is set
  if @api_client.config.client_side_validation && bank_guid.nil?
    fail ArgumentError, "Missing the required parameter 'bank_guid' when calling VerificationKeysBankApi.get_verification_key"
  end
  # verify the required parameter 'verification_key_guid' is set
  if @api_client.config.client_side_validation && verification_key_guid.nil?
    fail ArgumentError, "Missing the required parameter 'verification_key_guid' when calling VerificationKeysBankApi.get_verification_key"
  end
  # resource path
  local_var_path = '/api/banks/{bank_guid}/verification_keys/{verification_key_guid}'.sub('{' + 'bank_guid' + '}', CGI.escape(bank_guid.to_s)).sub('{' + 'verification_key_guid' + '}', CGI.escape(verification_key_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'VerificationKeyBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"VerificationKeysBankApi.get_verification_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VerificationKeysBankApi#get_verification_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_verification_keys(bank_guid, opts = {}) ⇒ VerificationKeyListBankModel

Get Verification Keys list Retrieves a listing of verification keys of a bank. Required scope: banks:read

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 0
  • :per_page (Integer) — default: default to 10

Returns:



172
173
174
175
 
# File 'lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb', line 172

def list_verification_keys(bank_guid, opts = {})
  data, _status_code, _headers = list_verification_keys_with_http_info(bank_guid, opts)
  data
end

#list_verification_keys_with_http_info(bank_guid, opts = {}) ⇒ Array<(VerificationKeyListBankModel, Integer, Hash)>

Get Verification Keys list Retrieves a listing of verification keys of a bank. Required scope: banks:read

Parameters:

  • bank_guid (String) —

    Identifier for the bank.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



184
185
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb', line 184

def list_verification_keys_with_http_info(bank_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerificationKeysBankApi.list_verification_keys ...'
  end
  # verify the required parameter 'bank_guid' is set
  if @api_client.config.client_side_validation && bank_guid.nil?
    fail ArgumentError, "Missing the required parameter 'bank_guid' when calling VerificationKeysBankApi.list_verification_keys"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VerificationKeysBankApi.list_verification_keys, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling VerificationKeysBankApi.list_verification_keys, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling VerificationKeysBankApi.list_verification_keys, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/banks/{bank_guid}/verification_keys'.sub('{' + 'bank_guid' + '}', CGI.escape(bank_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'VerificationKeyListBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"VerificationKeysBankApi.list_verification_keys",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VerificationKeysBankApi#list_verification_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end