cybrid_api_bank_ruby 0.6.17 → 0.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +8 -8
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/CustomersBankApi.md +13 -5
  6. data/docs/VerificationKeysBankApi.md +15 -21
  7. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  8. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  9. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  10. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +10 -1
  11. data/lib/cybrid_api_bank_ruby/api/identity_records_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb +13 -31
  18. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/models/attestation_details_bank_model.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/models/exchange_account_bank_model.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/models/exchange_bank_model.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/models/fee_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/identity_record_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/post_identity_record_attestation_details_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/post_identity_record_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/post_trading_configuration_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/system_account_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/trading_configuration_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/trading_configuration_list_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby.rb +1 -1
  56. data/spec/api/accounts_bank_api_spec.rb +1 -1
  57. data/spec/api/assets_bank_api_spec.rb +1 -1
  58. data/spec/api/banks_bank_api_spec.rb +1 -1
  59. data/spec/api/customers_bank_api_spec.rb +4 -1
  60. data/spec/api/identity_records_bank_api_spec.rb +1 -1
  61. data/spec/api/prices_bank_api_spec.rb +1 -1
  62. data/spec/api/quotes_bank_api_spec.rb +1 -1
  63. data/spec/api/symbols_bank_api_spec.rb +1 -1
  64. data/spec/api/trades_bank_api_spec.rb +1 -1
  65. data/spec/api/trading_configurations_bank_api_spec.rb +1 -1
  66. data/spec/api/verification_keys_bank_api_spec.rb +1 -4
  67. data/spec/api_client_spec.rb +1 -1
  68. data/spec/configuration_spec.rb +1 -1
  69. data/spec/models/account_bank_model_spec.rb +1 -1
  70. data/spec/models/account_list_bank_model_spec.rb +1 -1
  71. data/spec/models/asset_bank_model_spec.rb +1 -1
  72. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  73. data/spec/models/attestation_details_bank_model_spec.rb +1 -1
  74. data/spec/models/bank_bank_model_spec.rb +1 -1
  75. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  76. data/spec/models/customer_bank_model_spec.rb +1 -1
  77. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  78. data/spec/models/exchange_account_bank_model_spec.rb +1 -1
  79. data/spec/models/exchange_bank_model_spec.rb +1 -1
  80. data/spec/models/fee_bank_model_spec.rb +1 -1
  81. data/spec/models/identity_record_bank_model_spec.rb +1 -1
  82. data/spec/models/post_account_bank_model_spec.rb +1 -1
  83. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  84. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  85. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  86. data/spec/models/post_identity_record_attestation_details_bank_model_spec.rb +1 -1
  87. data/spec/models/post_identity_record_bank_model_spec.rb +1 -1
  88. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  89. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  90. data/spec/models/post_trading_configuration_bank_model_spec.rb +1 -1
  91. data/spec/models/post_verification_key_bank_model_spec.rb +1 -1
  92. data/spec/models/quote_bank_model_spec.rb +1 -1
  93. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  94. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  95. data/spec/models/system_account_bank_model_spec.rb +1 -1
  96. data/spec/models/trade_bank_model_spec.rb +1 -1
  97. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  98. data/spec/models/trading_configuration_bank_model_spec.rb +1 -1
  99. data/spec/models/trading_configuration_list_bank_model_spec.rb +1 -1
  100. data/spec/models/verification_key_bank_model_spec.rb +1 -1
  101. data/spec/models/verification_key_list_bank_model_spec.rb +1 -1
  102. data/spec/spec_helper.rb +1 -1
  103. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out +2 -2
  104. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out +2 -2
  105. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/jaro_winkler-1.5.4/gem_make.out +2 -2
  106. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out +2 -2
  107. data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  108. data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  109. data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  110. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  111. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: da6a209f9a41566e63aa55134e43fed52fc2da479ddfb8264567438e3f8ad7b3
4
- data.tar.gz: e349b06a43e657fb8ab35a5885d878bda2478640a26137babc6ad2ef721e8314
3
+ metadata.gz: 9925279bf3ca8b620c221441513f8659a0643dfa176f69daddcd4018ba766c94
4
+ data.tar.gz: 67ed7606b8668e1bd630c372132f275ec9526ad60926ed39d67e4c143a1790a2
5
5
  SHA512:
6
- metadata.gz: 87e8a3a6ccea34af965c448b404f0508933c43fc6b59366f8ca4a4394002841d739a6bdb72434cc8e9090511592db50c504b63629dae77f68cc3371e28f3fbb8
7
- data.tar.gz: b4cf3b47976d989709131288f5329c78396e100b7beadee10ee77d14deef2d72bc0b8b88db98718373b969ba7cc86be16c7c4bdf18fd7f912570b4fb9631deec
6
+ metadata.gz: 7b40272271057c092c8e8a562afec5cfd606d83c540dade0feb965837274f8b45b1a43f5c7808ad7582a004df3f8d0fa10cae8d22e70ccf000e2ba29910633c4
7
+ data.tar.gz: 8f2826f9fcaa4e01fa08c3b22e89ad1ed3b1994764cee6adfa8d4bd24d5998cc5542313bf4da30bc357f3c23b801e8f656acd93af0d667d2fcc8d0f1849011fb
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_bank_ruby (0.6.17)
4
+ cybrid_api_bank_ruby (0.8.1)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -82,8 +82,8 @@ Customers must also have an account to be able to transact. See the Accounts API
82
82
 
83
83
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
84
84
 
85
- - API version: v0.6.17
86
- - Package version: 0.6.17
85
+ - API version: v0.8.1
86
+ - Package version: 0.8.1
87
87
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
88
88
 
89
89
  ## Installation
@@ -99,16 +99,16 @@ gem build cybrid_api_bank_ruby.gemspec
99
99
  Then either install the gem locally:
100
100
 
101
101
  ```shell
102
- gem install ./cybrid_api_bank_ruby-0.6.17.gem
102
+ gem install ./cybrid_api_bank_ruby-0.8.1.gem
103
103
  ```
104
104
 
105
- (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.6.17.gem` to install the development dependencies)
105
+ (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.8.1.gem` to install the development dependencies)
106
106
 
107
107
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
108
108
 
109
109
  Finally add this to the Gemfile:
110
110
 
111
- gem 'cybrid_api_bank_ruby', '~> 0.6.17'
111
+ gem 'cybrid_api_bank_ruby', '~> 0.8.1'
112
112
 
113
113
  ### Install from Git
114
114
 
@@ -183,9 +183,9 @@ Class | Method | HTTP request | Description
183
183
  *CybridApiBank::TradingConfigurationsBankApi* | [**create_trading_configuration**](docs/TradingConfigurationsBankApi.md#create_trading_configuration) | **POST** /api/trading_configurations | Create TradingConfiguration
184
184
  *CybridApiBank::TradingConfigurationsBankApi* | [**get_trading_configuration**](docs/TradingConfigurationsBankApi.md#get_trading_configuration) | **GET** /api/trading_configurations/{trading_configuration_guid} | Get TradingConfiguration
185
185
  *CybridApiBank::TradingConfigurationsBankApi* | [**list_trading_configurations**](docs/TradingConfigurationsBankApi.md#list_trading_configurations) | **GET** /api/trading_configurations | List trading configurations
186
- *CybridApiBank::VerificationKeysBankApi* | [**create_verification_key**](docs/VerificationKeysBankApi.md#create_verification_key) | **POST** /api/banks/{bank_guid}/verification_keys | Create VerificationKey
187
- *CybridApiBank::VerificationKeysBankApi* | [**get_verification_key**](docs/VerificationKeysBankApi.md#get_verification_key) | **GET** /api/banks/{bank_guid}/verification_keys/{verification_key_guid} | Get VerificationKey
188
- *CybridApiBank::VerificationKeysBankApi* | [**list_verification_keys**](docs/VerificationKeysBankApi.md#list_verification_keys) | **GET** /api/banks/{bank_guid}/verification_keys | Get Verification Keys list
186
+ *CybridApiBank::VerificationKeysBankApi* | [**create_verification_key**](docs/VerificationKeysBankApi.md#create_verification_key) | **POST** /api/bank_verification_keys | Create VerificationKey
187
+ *CybridApiBank::VerificationKeysBankApi* | [**get_verification_key**](docs/VerificationKeysBankApi.md#get_verification_key) | **GET** /api/bank_verification_keys/{verification_key_guid} | Get VerificationKey
188
+ *CybridApiBank::VerificationKeysBankApi* | [**list_verification_keys**](docs/VerificationKeysBankApi.md#list_verification_keys) | **GET** /api/bank_verification_keys | Get Verification Keys list
189
189
 
190
190
 
191
191
  ## Documentation for Models
@@ -5,7 +5,7 @@
5
5
 
6
6
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
7
7
 
8
- The version of the OpenAPI document: v0.6.17
8
+ The version of the OpenAPI document: v0.8.1
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 5.4.0
@@ -83,7 +83,7 @@ end
83
83
 
84
84
  ## get_customer
85
85
 
86
- > <CustomerBankModel> get_customer(customer_guid)
86
+ > <CustomerBankModel> get_customer(customer_guid, opts)
87
87
 
88
88
  Get Customer
89
89
 
@@ -105,10 +105,13 @@ end
105
105
 
106
106
  api_instance = CybridApiBank::CustomersBankApi.new
107
107
  customer_guid = 'customer_guid_example' # String | Identifier for the customer.
108
+ opts = {
109
+ bank_guid: 'bank_guid_example' # String | Identifier for the bank.
110
+ }
108
111
 
109
112
  begin
110
113
  # Get Customer
111
- result = api_instance.get_customer(customer_guid)
114
+ result = api_instance.get_customer(customer_guid, opts)
112
115
  p result
113
116
  rescue CybridApiBank::ApiError => e
114
117
  puts "Error when calling CustomersBankApi->get_customer: #{e}"
@@ -119,12 +122,12 @@ end
119
122
 
120
123
  This returns an Array which contains the response data, status code and headers.
121
124
 
122
- > <Array(<CustomerBankModel>, Integer, Hash)> get_customer_with_http_info(customer_guid)
125
+ > <Array(<CustomerBankModel>, Integer, Hash)> get_customer_with_http_info(customer_guid, opts)
123
126
 
124
127
  ```ruby
125
128
  begin
126
129
  # Get Customer
127
- data, status_code, headers = api_instance.get_customer_with_http_info(customer_guid)
130
+ data, status_code, headers = api_instance.get_customer_with_http_info(customer_guid, opts)
128
131
  p status_code # => 2xx
129
132
  p headers # => { ... }
130
133
  p data # => <CustomerBankModel>
@@ -138,6 +141,7 @@ end
138
141
  | Name | Type | Description | Notes |
139
142
  | ---- | ---- | ----------- | ----- |
140
143
  | **customer_guid** | **String** | Identifier for the customer. | |
144
+ | **bank_guid** | **String** | Identifier for the bank. | [optional] |
141
145
 
142
146
  ### Return type
143
147
 
@@ -178,7 +182,9 @@ end
178
182
  api_instance = CybridApiBank::CustomersBankApi.new
179
183
  opts = {
180
184
  page: 56, # Integer |
181
- per_page: 56 # Integer |
185
+ per_page: 56, # Integer |
186
+ bank_guid: 'bank_guid_example', # String | Identifier for the bank.
187
+ guid: 'guid_example' # String | Comma separated customer_guid to list customers for.
182
188
  }
183
189
 
184
190
  begin
@@ -214,6 +220,8 @@ end
214
220
  | ---- | ---- | ----------- | ----- |
215
221
  | **page** | **Integer** | | [optional][default to 0] |
216
222
  | **per_page** | **Integer** | | [optional][default to 10] |
223
+ | **bank_guid** | **String** | Identifier for the bank. | [optional] |
224
+ | **guid** | **String** | Comma separated customer_guid to list customers for. | [optional] |
217
225
 
218
226
  ### Return type
219
227
 
@@ -4,14 +4,14 @@ All URIs are relative to *https://bank.demo.cybrid.app*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**create_verification_key**](VerificationKeysBankApi.md#create_verification_key) | **POST** /api/banks/{bank_guid}/verification_keys | Create VerificationKey |
8
- | [**get_verification_key**](VerificationKeysBankApi.md#get_verification_key) | **GET** /api/banks/{bank_guid}/verification_keys/{verification_key_guid} | Get VerificationKey |
9
- | [**list_verification_keys**](VerificationKeysBankApi.md#list_verification_keys) | **GET** /api/banks/{bank_guid}/verification_keys | Get Verification Keys list |
7
+ | [**create_verification_key**](VerificationKeysBankApi.md#create_verification_key) | **POST** /api/bank_verification_keys | Create VerificationKey |
8
+ | [**get_verification_key**](VerificationKeysBankApi.md#get_verification_key) | **GET** /api/bank_verification_keys/{verification_key_guid} | Get VerificationKey |
9
+ | [**list_verification_keys**](VerificationKeysBankApi.md#list_verification_keys) | **GET** /api/bank_verification_keys | Get Verification Keys list |
10
10
 
11
11
 
12
12
  ## create_verification_key
13
13
 
14
- > <VerificationKeyBankModel> create_verification_key(bank_guid, post_verification_key_bank_model)
14
+ > <VerificationKeyBankModel> create_verification_key(post_verification_key_bank_model)
15
15
 
16
16
  Create VerificationKey
17
17
 
@@ -32,12 +32,11 @@ CybridApiBank.configure do |config|
32
32
  end
33
33
 
34
34
  api_instance = CybridApiBank::VerificationKeysBankApi.new
35
- bank_guid = 'bank_guid_example' # String | Identifier for the bank.
36
35
  post_verification_key_bank_model = CybridApiBank::PostVerificationKeyBankModel.new({type: 'attestation', algorithm: 'RS512', public_key: 'public_key_example', nonce: 'nonce_example', signature: 'signature_example'}) # PostVerificationKeyBankModel |
37
36
 
38
37
  begin
39
38
  # Create VerificationKey
40
- result = api_instance.create_verification_key(bank_guid, post_verification_key_bank_model)
39
+ result = api_instance.create_verification_key(post_verification_key_bank_model)
41
40
  p result
42
41
  rescue CybridApiBank::ApiError => e
43
42
  puts "Error when calling VerificationKeysBankApi->create_verification_key: #{e}"
@@ -48,12 +47,12 @@ end
48
47
 
49
48
  This returns an Array which contains the response data, status code and headers.
50
49
 
51
- > <Array(<VerificationKeyBankModel>, Integer, Hash)> create_verification_key_with_http_info(bank_guid, post_verification_key_bank_model)
50
+ > <Array(<VerificationKeyBankModel>, Integer, Hash)> create_verification_key_with_http_info(post_verification_key_bank_model)
52
51
 
53
52
  ```ruby
54
53
  begin
55
54
  # Create VerificationKey
56
- data, status_code, headers = api_instance.create_verification_key_with_http_info(bank_guid, post_verification_key_bank_model)
55
+ data, status_code, headers = api_instance.create_verification_key_with_http_info(post_verification_key_bank_model)
57
56
  p status_code # => 2xx
58
57
  p headers # => { ... }
59
58
  p data # => <VerificationKeyBankModel>
@@ -66,7 +65,6 @@ end
66
65
 
67
66
  | Name | Type | Description | Notes |
68
67
  | ---- | ---- | ----------- | ----- |
69
- | **bank_guid** | **String** | Identifier for the bank. | |
70
68
  | **post_verification_key_bank_model** | [**PostVerificationKeyBankModel**](PostVerificationKeyBankModel.md) | | |
71
69
 
72
70
  ### Return type
@@ -85,7 +83,7 @@ end
85
83
 
86
84
  ## get_verification_key
87
85
 
88
- > <VerificationKeyBankModel> get_verification_key(bank_guid, verification_key_guid)
86
+ > <VerificationKeyBankModel> get_verification_key(verification_key_guid)
89
87
 
90
88
  Get VerificationKey
91
89
 
@@ -106,12 +104,11 @@ CybridApiBank.configure do |config|
106
104
  end
107
105
 
108
106
  api_instance = CybridApiBank::VerificationKeysBankApi.new
109
- bank_guid = 'bank_guid_example' # String | Identifier for the bank.
110
107
  verification_key_guid = 'verification_key_guid_example' # String | Identifier for the verification key.
111
108
 
112
109
  begin
113
110
  # Get VerificationKey
114
- result = api_instance.get_verification_key(bank_guid, verification_key_guid)
111
+ result = api_instance.get_verification_key(verification_key_guid)
115
112
  p result
116
113
  rescue CybridApiBank::ApiError => e
117
114
  puts "Error when calling VerificationKeysBankApi->get_verification_key: #{e}"
@@ -122,12 +119,12 @@ end
122
119
 
123
120
  This returns an Array which contains the response data, status code and headers.
124
121
 
125
- > <Array(<VerificationKeyBankModel>, Integer, Hash)> get_verification_key_with_http_info(bank_guid, verification_key_guid)
122
+ > <Array(<VerificationKeyBankModel>, Integer, Hash)> get_verification_key_with_http_info(verification_key_guid)
126
123
 
127
124
  ```ruby
128
125
  begin
129
126
  # Get VerificationKey
130
- data, status_code, headers = api_instance.get_verification_key_with_http_info(bank_guid, verification_key_guid)
127
+ data, status_code, headers = api_instance.get_verification_key_with_http_info(verification_key_guid)
131
128
  p status_code # => 2xx
132
129
  p headers # => { ... }
133
130
  p data # => <VerificationKeyBankModel>
@@ -140,7 +137,6 @@ end
140
137
 
141
138
  | Name | Type | Description | Notes |
142
139
  | ---- | ---- | ----------- | ----- |
143
- | **bank_guid** | **String** | Identifier for the bank. | |
144
140
  | **verification_key_guid** | **String** | Identifier for the verification key. | |
145
141
 
146
142
  ### Return type
@@ -159,7 +155,7 @@ end
159
155
 
160
156
  ## list_verification_keys
161
157
 
162
- > <VerificationKeyListBankModel> list_verification_keys(bank_guid, opts)
158
+ > <VerificationKeyListBankModel> list_verification_keys(opts)
163
159
 
164
160
  Get Verification Keys list
165
161
 
@@ -180,7 +176,6 @@ CybridApiBank.configure do |config|
180
176
  end
181
177
 
182
178
  api_instance = CybridApiBank::VerificationKeysBankApi.new
183
- bank_guid = 'bank_guid_example' # String | Identifier for the bank.
184
179
  opts = {
185
180
  page: 56, # Integer |
186
181
  per_page: 56 # Integer |
@@ -188,7 +183,7 @@ opts = {
188
183
 
189
184
  begin
190
185
  # Get Verification Keys list
191
- result = api_instance.list_verification_keys(bank_guid, opts)
186
+ result = api_instance.list_verification_keys(opts)
192
187
  p result
193
188
  rescue CybridApiBank::ApiError => e
194
189
  puts "Error when calling VerificationKeysBankApi->list_verification_keys: #{e}"
@@ -199,12 +194,12 @@ end
199
194
 
200
195
  This returns an Array which contains the response data, status code and headers.
201
196
 
202
- > <Array(<VerificationKeyListBankModel>, Integer, Hash)> list_verification_keys_with_http_info(bank_guid, opts)
197
+ > <Array(<VerificationKeyListBankModel>, Integer, Hash)> list_verification_keys_with_http_info(opts)
203
198
 
204
199
  ```ruby
205
200
  begin
206
201
  # Get Verification Keys list
207
- data, status_code, headers = api_instance.list_verification_keys_with_http_info(bank_guid, opts)
202
+ data, status_code, headers = api_instance.list_verification_keys_with_http_info(opts)
208
203
  p status_code # => 2xx
209
204
  p headers # => { ... }
210
205
  p data # => <VerificationKeyListBankModel>
@@ -217,7 +212,6 @@ end
217
212
 
218
213
  | Name | Type | Description | Notes |
219
214
  | ---- | ---- | ----------- | ----- |
220
- | **bank_guid** | **String** | Identifier for the bank. | |
221
215
  | **page** | **Integer** | | [optional][default to 0] |
222
216
  | **per_page** | **Integer** | | [optional][default to 10] |
223
217
 
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -91,6 +91,7 @@ module CybridApiBank
91
91
  # Retrieves a customer. Required scope: **customers:read**
92
92
  # @param customer_guid [String] Identifier for the customer.
93
93
  # @param [Hash] opts the optional parameters
94
+ # @option opts [String] :bank_guid Identifier for the bank.
94
95
  # @return [CustomerBankModel]
95
96
  def get_customer(customer_guid, opts = {})
96
97
  data, _status_code, _headers = get_customer_with_http_info(customer_guid, opts)
@@ -101,6 +102,7 @@ module CybridApiBank
101
102
  # Retrieves a customer. Required scope: **customers:read**
102
103
  # @param customer_guid [String] Identifier for the customer.
103
104
  # @param [Hash] opts the optional parameters
105
+ # @option opts [String] :bank_guid Identifier for the bank.
104
106
  # @return [Array<(CustomerBankModel, Integer, Hash)>] CustomerBankModel data, response status code and response headers
105
107
  def get_customer_with_http_info(customer_guid, opts = {})
106
108
  if @api_client.config.debugging
@@ -115,6 +117,7 @@ module CybridApiBank
115
117
 
116
118
  # query parameters
117
119
  query_params = opts[:query_params] || {}
120
+ query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
118
121
 
119
122
  # header parameters
120
123
  header_params = opts[:header_params] || {}
@@ -155,6 +158,8 @@ module CybridApiBank
155
158
  # @param [Hash] opts the optional parameters
156
159
  # @option opts [Integer] :page (default to 0)
157
160
  # @option opts [Integer] :per_page (default to 10)
161
+ # @option opts [String] :bank_guid Identifier for the bank.
162
+ # @option opts [String] :guid Comma separated customer_guid to list customers for.
158
163
  # @return [CustomerListBankModel]
159
164
  def list_customers(opts = {})
160
165
  data, _status_code, _headers = list_customers_with_http_info(opts)
@@ -166,6 +171,8 @@ module CybridApiBank
166
171
  # @param [Hash] opts the optional parameters
167
172
  # @option opts [Integer] :page
168
173
  # @option opts [Integer] :per_page
174
+ # @option opts [String] :bank_guid Identifier for the bank.
175
+ # @option opts [String] :guid Comma separated customer_guid to list customers for.
169
176
  # @return [Array<(CustomerListBankModel, Integer, Hash)>] CustomerListBankModel data, response status code and response headers
170
177
  def list_customers_with_http_info(opts = {})
171
178
  if @api_client.config.debugging
@@ -190,6 +197,8 @@ module CybridApiBank
190
197
  query_params = opts[:query_params] || {}
191
198
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
192
199
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
200
+ query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
201
+ query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
193
202
 
194
203
  # header parameters
195
204
  header_params = opts[:header_params] || {}
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual Bank. Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication. **Never share your Client ID or Secret publicly or in your source code repository** Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model the organization partnering with Cybrid to use our platform. An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform. ## Banks A Bank is owned by an Organization and can be thought of as an environment or container for Customers and product offerings. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. See the Identity Records section for more details on how a customer can be verified. Customers must also have an account to be able to transact. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.6.17
6
+ The version of the OpenAPI document: v0.8.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0