cybrid_api_bank_ruby 0.4.2 → 0.6.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +13 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/FeeBankModel.md +22 -0
  6. data/docs/PostFeeBankModel.md +22 -0
  7. data/docs/PostTradingConfigurationBankModel.md +20 -0
  8. data/docs/TradingConfigurationBankModel.md +26 -0
  9. data/docs/TradingConfigurationListBankModel.md +24 -0
  10. data/docs/TradingConfigurationsBankApi.md +230 -0
  11. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/identity_records_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb +228 -0
  21. data/lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/models/attestation_details_bank_model.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/exchange_account_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/exchange_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/fee_bank_model.rb +273 -0
  37. data/lib/cybrid_api_bank_ruby/models/identity_record_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +278 -0
  42. data/lib/cybrid_api_bank_ruby/models/post_identity_record_attestation_details_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/post_identity_record_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/post_trading_configuration_bank_model.rb +269 -0
  47. data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/system_account_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/trading_configuration_bank_model.rb +334 -0
  55. data/lib/cybrid_api_bank_ruby/models/trading_configuration_list_bank_model.rb +295 -0
  56. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  59. data/lib/cybrid_api_bank_ruby.rb +7 -1
  60. data/spec/api/accounts_bank_api_spec.rb +1 -1
  61. data/spec/api/assets_bank_api_spec.rb +1 -1
  62. data/spec/api/banks_bank_api_spec.rb +1 -1
  63. data/spec/api/customers_bank_api_spec.rb +1 -1
  64. data/spec/api/identity_records_bank_api_spec.rb +1 -1
  65. data/spec/api/prices_bank_api_spec.rb +1 -1
  66. data/spec/api/quotes_bank_api_spec.rb +1 -1
  67. data/spec/api/symbols_bank_api_spec.rb +1 -1
  68. data/spec/api/trades_bank_api_spec.rb +1 -1
  69. data/spec/api/trading_configurations_bank_api_spec.rb +72 -0
  70. data/spec/api/verification_keys_bank_api_spec.rb +1 -1
  71. data/spec/api_client_spec.rb +1 -1
  72. data/spec/configuration_spec.rb +1 -1
  73. data/spec/models/account_bank_model_spec.rb +1 -1
  74. data/spec/models/account_list_bank_model_spec.rb +1 -1
  75. data/spec/models/asset_bank_model_spec.rb +1 -1
  76. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  77. data/spec/models/attestation_details_bank_model_spec.rb +1 -1
  78. data/spec/models/bank_bank_model_spec.rb +1 -1
  79. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  80. data/spec/models/customer_bank_model_spec.rb +1 -1
  81. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  82. data/spec/models/exchange_account_bank_model_spec.rb +1 -1
  83. data/spec/models/exchange_bank_model_spec.rb +1 -1
  84. data/spec/models/fee_bank_model_spec.rb +50 -0
  85. data/spec/models/identity_record_bank_model_spec.rb +1 -1
  86. data/spec/models/post_account_bank_model_spec.rb +1 -1
  87. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  88. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  89. data/spec/models/post_fee_bank_model_spec.rb +50 -0
  90. data/spec/models/post_identity_record_attestation_details_bank_model_spec.rb +1 -1
  91. data/spec/models/post_identity_record_bank_model_spec.rb +1 -1
  92. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  93. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  94. data/spec/models/post_trading_configuration_bank_model_spec.rb +40 -0
  95. data/spec/models/post_verification_key_bank_model_spec.rb +1 -1
  96. data/spec/models/quote_bank_model_spec.rb +1 -1
  97. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  98. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  99. data/spec/models/system_account_bank_model_spec.rb +1 -1
  100. data/spec/models/trade_bank_model_spec.rb +1 -1
  101. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  102. data/spec/models/trading_configuration_bank_model_spec.rb +58 -0
  103. data/spec/models/trading_configuration_list_bank_model_spec.rb +52 -0
  104. data/spec/models/verification_key_bank_model_spec.rb +1 -1
  105. data/spec/models/verification_key_list_bank_model_spec.rb +1 -1
  106. data/spec/spec_helper.rb +1 -1
  107. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out +2 -2
  108. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out +2 -2
  109. 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
  110. data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  111. data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  112. data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  113. metadata +26 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 02f67692b817b3258a44bdb11b1bc7b8d8d9073d0a718851c7bb547b77345926
4
- data.tar.gz: 333ffa72ca6e5025c57c2c77c7791b1e1d2f78f2c5985ed8e1b8e3dfe7fb9cbe
3
+ metadata.gz: 839a877070995dd70a53cba23ca8c6ffba6cf75e9c8f7b750ae26a869c895b7a
4
+ data.tar.gz: 1eaa070a96033b97e5afa85ec5cb234ae1a04aff3535c6cab7a6392017191386
5
5
  SHA512:
6
- metadata.gz: f4409b70854848dcbacc8917a3002303cdb47c9d65b31c9e70c4744d6775cbd38aab13e9d8ea23a98ef4f300e997de03fd172724b03792c4a5a3958b95320a7f
7
- data.tar.gz: 7012f47522440a9222e7a8f99207b95cbefa691d864f5879fc1bc91301e7f1b253bda304164077a009692e52a1b8df1001829a578e0b433715294f8af48e1616
6
+ metadata.gz: 5042f39decb9e2ad39fb30fce4b6c2ad5be7ff13f500f757da7e6c88658c7e7b6a5aa81246f624eb8796a33c6c7c1a7b896a2eb2de396ccad1e70688b6ecfa70
7
+ data.tar.gz: '0465784989bf3d7223533fb8ae6f60660d4210289a3aa17ce8a28370f0c69049ba5b82a8e2500847b9b941ec8bb1554e3a1bcc6d6886d27094555acf69307d75'
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_bank_ruby (0.4.2)
4
+ cybrid_api_bank_ruby (0.6.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.4.2
86
- - Package version: 0.4.2
85
+ - API version: v0.6.1
86
+ - Package version: 0.6.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.4.2.gem
102
+ gem install ./cybrid_api_bank_ruby-0.6.1.gem
103
103
  ```
104
104
 
105
- (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.4.2.gem` to install the development dependencies)
105
+ (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.6.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.4.2'
111
+ gem 'cybrid_api_bank_ruby', '~> 0.6.1'
112
112
 
113
113
  ### Install from Git
114
114
 
@@ -180,6 +180,9 @@ Class | Method | HTTP request | Description
180
180
  *CybridApiBank::TradesBankApi* | [**create_trade**](docs/TradesBankApi.md#create_trade) | **POST** /api/trades | Create Trade
181
181
  *CybridApiBank::TradesBankApi* | [**get_trade**](docs/TradesBankApi.md#get_trade) | **GET** /api/trades/{trade_guid} | Get Trade
182
182
  *CybridApiBank::TradesBankApi* | [**list_trades**](docs/TradesBankApi.md#list_trades) | **GET** /api/trades | Get trades list
183
+ *CybridApiBank::TradingConfigurationsBankApi* | [**create_trading_configuration**](docs/TradingConfigurationsBankApi.md#create_trading_configuration) | **POST** /api/trading_configurations | Create TradingConfiguration
184
+ *CybridApiBank::TradingConfigurationsBankApi* | [**get_trading_configuration**](docs/TradingConfigurationsBankApi.md#get_trading_configuration) | **GET** /api/trading_configurations/{trading_configuration_guid} | Get TradingConfiguration
185
+ *CybridApiBank::TradingConfigurationsBankApi* | [**list_trading_configurations**](docs/TradingConfigurationsBankApi.md#list_trading_configurations) | **GET** /api/trading_configurations | List trading configurations
183
186
  *CybridApiBank::VerificationKeysBankApi* | [**create_verification_key**](docs/VerificationKeysBankApi.md#create_verification_key) | **POST** /api/banks/{bank_guid}/verification_keys | Create VerificationKey
184
187
  *CybridApiBank::VerificationKeysBankApi* | [**get_verification_key**](docs/VerificationKeysBankApi.md#get_verification_key) | **GET** /api/banks/{bank_guid}/verification_keys/{verification_key_guid} | Get VerificationKey
185
188
  *CybridApiBank::VerificationKeysBankApi* | [**list_verification_keys**](docs/VerificationKeysBankApi.md#list_verification_keys) | **GET** /api/banks/{bank_guid}/verification_keys | Get Verification Keys list
@@ -198,14 +201,17 @@ Class | Method | HTTP request | Description
198
201
  - [CybridApiBank::CustomerListBankModel](docs/CustomerListBankModel.md)
199
202
  - [CybridApiBank::ExchangeAccountBankModel](docs/ExchangeAccountBankModel.md)
200
203
  - [CybridApiBank::ExchangeBankModel](docs/ExchangeBankModel.md)
204
+ - [CybridApiBank::FeeBankModel](docs/FeeBankModel.md)
201
205
  - [CybridApiBank::IdentityRecordBankModel](docs/IdentityRecordBankModel.md)
202
206
  - [CybridApiBank::PostAccountBankModel](docs/PostAccountBankModel.md)
203
207
  - [CybridApiBank::PostBankBankModel](docs/PostBankBankModel.md)
204
208
  - [CybridApiBank::PostCustomerBankModel](docs/PostCustomerBankModel.md)
209
+ - [CybridApiBank::PostFeeBankModel](docs/PostFeeBankModel.md)
205
210
  - [CybridApiBank::PostIdentityRecordAttestationDetailsBankModel](docs/PostIdentityRecordAttestationDetailsBankModel.md)
206
211
  - [CybridApiBank::PostIdentityRecordBankModel](docs/PostIdentityRecordBankModel.md)
207
212
  - [CybridApiBank::PostQuoteBankModel](docs/PostQuoteBankModel.md)
208
213
  - [CybridApiBank::PostTradeBankModel](docs/PostTradeBankModel.md)
214
+ - [CybridApiBank::PostTradingConfigurationBankModel](docs/PostTradingConfigurationBankModel.md)
209
215
  - [CybridApiBank::PostVerificationKeyBankModel](docs/PostVerificationKeyBankModel.md)
210
216
  - [CybridApiBank::QuoteBankModel](docs/QuoteBankModel.md)
211
217
  - [CybridApiBank::QuoteListBankModel](docs/QuoteListBankModel.md)
@@ -213,6 +219,8 @@ Class | Method | HTTP request | Description
213
219
  - [CybridApiBank::SystemAccountBankModel](docs/SystemAccountBankModel.md)
214
220
  - [CybridApiBank::TradeBankModel](docs/TradeBankModel.md)
215
221
  - [CybridApiBank::TradeListBankModel](docs/TradeListBankModel.md)
222
+ - [CybridApiBank::TradingConfigurationBankModel](docs/TradingConfigurationBankModel.md)
223
+ - [CybridApiBank::TradingConfigurationListBankModel](docs/TradingConfigurationListBankModel.md)
216
224
  - [CybridApiBank::VerificationKeyBankModel](docs/VerificationKeyBankModel.md)
217
225
  - [CybridApiBank::VerificationKeyListBankModel](docs/VerificationKeyListBankModel.md)
218
226
 
@@ -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.4.2
8
+ The version of the OpenAPI document: v0.6.1
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 5.4.0
@@ -0,0 +1,22 @@
1
+ # CybridApiBank::FeeBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The fee&#39;s type | [optional] |
8
+ | **spread_fee** | **Integer** | The percentage amount, in basis points, to apply when charging a fee. | [optional] |
9
+ | **fixed_fee** | **Integer** | The fixed amount, in the currency of the parent trading configuration, to apply when charging a fee. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'cybrid_api_bank_ruby'
15
+
16
+ instance = CybridApiBank::FeeBankModel.new(
17
+ type: null,
18
+ spread_fee: null,
19
+ fixed_fee: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # CybridApiBank::PostFeeBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The fee&#39;s type | |
8
+ | **spread_fee** | **Integer** | The percentage amount, in basis points, to apply when charging a fee. | [optional] |
9
+ | **fixed_fee** | **Integer** | The fixed amount, in the currency of the parent trading configuration, to apply when charging a fee. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'cybrid_api_bank_ruby'
15
+
16
+ instance = CybridApiBank::PostFeeBankModel.new(
17
+ type: null,
18
+ spread_fee: null,
19
+ fixed_fee: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # CybridApiBank::PostTradingConfigurationBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **asset** | **String** | The asset code. | |
8
+ | **fees** | [**Array&lt;PostFeeBankModel&gt;**](PostFeeBankModel.md) | The fees associated with the configuration | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'cybrid_api_bank_ruby'
14
+
15
+ instance = CybridApiBank::PostTradingConfigurationBankModel.new(
16
+ asset: null,
17
+ fees: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # CybridApiBank::TradingConfigurationBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **guid** | **String** | Auto-generated unique identifier for the exchange. | [optional] |
8
+ | **bank_guid** | **String** | The bank identifier. | [optional] |
9
+ | **asset** | **String** | The asset code. | [optional] |
10
+ | **created_at** | **Time** | ISO8601 datetime the bank was created at. | [optional] |
11
+ | **fees** | [**Array&lt;FeeBankModel&gt;**](FeeBankModel.md) | The fees associated with the configuration | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'cybrid_api_bank_ruby'
17
+
18
+ instance = CybridApiBank::TradingConfigurationBankModel.new(
19
+ guid: null,
20
+ bank_guid: null,
21
+ asset: null,
22
+ created_at: null,
23
+ fees: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::TradingConfigurationListBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | The total number of records available. | [optional] |
8
+ | **page** | **Integer** | The page index to retrieve. | [optional] |
9
+ | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
10
+ | **objects** | [**Array&lt;TradingConfigurationBankModel&gt;**](TradingConfigurationBankModel.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::TradingConfigurationListBankModel.new(
18
+ total: null,
19
+ page: null,
20
+ per_page: null,
21
+ objects: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,230 @@
1
+ # CybridApiBank::TradingConfigurationsBankApi
2
+
3
+ All URIs are relative to *https://bank.demo.cybrid.app*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_trading_configuration**](TradingConfigurationsBankApi.md#create_trading_configuration) | **POST** /api/trading_configurations | Create TradingConfiguration |
8
+ | [**get_trading_configuration**](TradingConfigurationsBankApi.md#get_trading_configuration) | **GET** /api/trading_configurations/{trading_configuration_guid} | Get TradingConfiguration |
9
+ | [**list_trading_configurations**](TradingConfigurationsBankApi.md#list_trading_configurations) | **GET** /api/trading_configurations | List trading configurations |
10
+
11
+
12
+ ## create_trading_configuration
13
+
14
+ > <TradingConfigurationBankModel> create_trading_configuration(post_trading_configuration_bank_model)
15
+
16
+ Create TradingConfiguration
17
+
18
+ Creates a trading configuration. Required scope: **banks:write**
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'cybrid_api_bank_ruby'
25
+ # setup authorization
26
+ CybridApiBank.configure do |config|
27
+ # Configure Bearer authorization (JWT): BearerAuth
28
+ config.access_token = 'YOUR_BEARER_TOKEN'
29
+
30
+ # Configure OAuth2 access token for authorization: oauth2
31
+ config.access_token = 'YOUR ACCESS TOKEN'
32
+ end
33
+
34
+ api_instance = CybridApiBank::TradingConfigurationsBankApi.new
35
+ post_trading_configuration_bank_model = CybridApiBank::PostTradingConfigurationBankModel.new({asset: 'asset_example', fees: [CybridApiBank::PostFeeBankModel.new({type: 'spread'})]}) # PostTradingConfigurationBankModel |
36
+
37
+ begin
38
+ # Create TradingConfiguration
39
+ result = api_instance.create_trading_configuration(post_trading_configuration_bank_model)
40
+ p result
41
+ rescue CybridApiBank::ApiError => e
42
+ puts "Error when calling TradingConfigurationsBankApi->create_trading_configuration: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_trading_configuration_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<TradingConfigurationBankModel>, Integer, Hash)> create_trading_configuration_with_http_info(post_trading_configuration_bank_model)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create TradingConfiguration
55
+ data, status_code, headers = api_instance.create_trading_configuration_with_http_info(post_trading_configuration_bank_model)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <TradingConfigurationBankModel>
59
+ rescue CybridApiBank::ApiError => e
60
+ puts "Error when calling TradingConfigurationsBankApi->create_trading_configuration_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **post_trading_configuration_bank_model** | [**PostTradingConfigurationBankModel**](PostTradingConfigurationBankModel.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**TradingConfigurationBankModel**](TradingConfigurationBankModel.md)
73
+
74
+ ### Authorization
75
+
76
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## get_trading_configuration
85
+
86
+ > <TradingConfigurationBankModel> get_trading_configuration(trading_configuration_guid)
87
+
88
+ Get TradingConfiguration
89
+
90
+ Retrieves a trading configuration. Required scope: **banks:read**
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'cybrid_api_bank_ruby'
97
+ # setup authorization
98
+ CybridApiBank.configure do |config|
99
+ # Configure Bearer authorization (JWT): BearerAuth
100
+ config.access_token = 'YOUR_BEARER_TOKEN'
101
+
102
+ # Configure OAuth2 access token for authorization: oauth2
103
+ config.access_token = 'YOUR ACCESS TOKEN'
104
+ end
105
+
106
+ api_instance = CybridApiBank::TradingConfigurationsBankApi.new
107
+ trading_configuration_guid = 'trading_configuration_guid_example' # String | Identifier for the trading configuration.
108
+
109
+ begin
110
+ # Get TradingConfiguration
111
+ result = api_instance.get_trading_configuration(trading_configuration_guid)
112
+ p result
113
+ rescue CybridApiBank::ApiError => e
114
+ puts "Error when calling TradingConfigurationsBankApi->get_trading_configuration: #{e}"
115
+ end
116
+ ```
117
+
118
+ #### Using the get_trading_configuration_with_http_info variant
119
+
120
+ This returns an Array which contains the response data, status code and headers.
121
+
122
+ > <Array(<TradingConfigurationBankModel>, Integer, Hash)> get_trading_configuration_with_http_info(trading_configuration_guid)
123
+
124
+ ```ruby
125
+ begin
126
+ # Get TradingConfiguration
127
+ data, status_code, headers = api_instance.get_trading_configuration_with_http_info(trading_configuration_guid)
128
+ p status_code # => 2xx
129
+ p headers # => { ... }
130
+ p data # => <TradingConfigurationBankModel>
131
+ rescue CybridApiBank::ApiError => e
132
+ puts "Error when calling TradingConfigurationsBankApi->get_trading_configuration_with_http_info: #{e}"
133
+ end
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+ | Name | Type | Description | Notes |
139
+ | ---- | ---- | ----------- | ----- |
140
+ | **trading_configuration_guid** | **String** | Identifier for the trading configuration. | |
141
+
142
+ ### Return type
143
+
144
+ [**TradingConfigurationBankModel**](TradingConfigurationBankModel.md)
145
+
146
+ ### Authorization
147
+
148
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## list_trading_configurations
157
+
158
+ > <TradingConfigurationListBankModel> list_trading_configurations(opts)
159
+
160
+ List trading configurations
161
+
162
+ Retrieves a listing of trading configurations for a bank. Required scope: **banks:read**
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'cybrid_api_bank_ruby'
169
+ # setup authorization
170
+ CybridApiBank.configure do |config|
171
+ # Configure Bearer authorization (JWT): BearerAuth
172
+ config.access_token = 'YOUR_BEARER_TOKEN'
173
+
174
+ # Configure OAuth2 access token for authorization: oauth2
175
+ config.access_token = 'YOUR ACCESS TOKEN'
176
+ end
177
+
178
+ api_instance = CybridApiBank::TradingConfigurationsBankApi.new
179
+ opts = {
180
+ page: 56, # Integer |
181
+ per_page: 56 # Integer |
182
+ }
183
+
184
+ begin
185
+ # List trading configurations
186
+ result = api_instance.list_trading_configurations(opts)
187
+ p result
188
+ rescue CybridApiBank::ApiError => e
189
+ puts "Error when calling TradingConfigurationsBankApi->list_trading_configurations: #{e}"
190
+ end
191
+ ```
192
+
193
+ #### Using the list_trading_configurations_with_http_info variant
194
+
195
+ This returns an Array which contains the response data, status code and headers.
196
+
197
+ > <Array(<TradingConfigurationListBankModel>, Integer, Hash)> list_trading_configurations_with_http_info(opts)
198
+
199
+ ```ruby
200
+ begin
201
+ # List trading configurations
202
+ data, status_code, headers = api_instance.list_trading_configurations_with_http_info(opts)
203
+ p status_code # => 2xx
204
+ p headers # => { ... }
205
+ p data # => <TradingConfigurationListBankModel>
206
+ rescue CybridApiBank::ApiError => e
207
+ puts "Error when calling TradingConfigurationsBankApi->list_trading_configurations_with_http_info: #{e}"
208
+ end
209
+ ```
210
+
211
+ ### Parameters
212
+
213
+ | Name | Type | Description | Notes |
214
+ | ---- | ---- | ----------- | ----- |
215
+ | **page** | **Integer** | | [optional][default to 0] |
216
+ | **per_page** | **Integer** | | [optional][default to 10] |
217
+
218
+ ### Return type
219
+
220
+ [**TradingConfigurationListBankModel**](TradingConfigurationListBankModel.md)
221
+
222
+ ### Authorization
223
+
224
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: Not defined
229
+ - **Accept**: application/json
230
+
@@ -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.4.2
6
+ The version of the OpenAPI document: v0.6.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.4.2
6
+ The version of the OpenAPI document: v0.6.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.4.2
6
+ The version of the OpenAPI document: v0.6.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.4.2
6
+ The version of the OpenAPI document: v0.6.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.4.2
6
+ The version of the OpenAPI document: v0.6.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.4.2
6
+ The version of the OpenAPI document: v0.6.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.4.2
6
+ The version of the OpenAPI document: v0.6.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.4.2
6
+ The version of the OpenAPI document: v0.6.1
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0