cybrid_api_bank_ruby 0.35.4 → 0.35.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (123) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +11 -11
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/{TradingConfigurationBankModel.md → FeeConfigurationBankModel.md} +6 -2
  6. data/docs/{TradingConfigurationListBankModel.md → FeeConfigurationListBankModel.md} +3 -3
  7. data/docs/FeeConfigurationsBankApi.md +230 -0
  8. data/docs/PostFeeConfigurationBankModel.md +24 -0
  9. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  10. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  11. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/{trading_configurations_bank_api.rb → fee_configurations_bank_api.rb} +58 -58
  14. data/lib/cybrid_api_bank_ruby/api/identity_records_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/rewards_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/verification_keys_bank_api.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/models/attestation_details_bank_model.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/fee_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/{trading_configuration_bank_model.rb → fee_configuration_bank_model.rb} +72 -5
  36. data/lib/cybrid_api_bank_ruby/models/{trading_configuration_list_bank_model.rb → fee_configuration_list_bank_model.rb} +5 -5
  37. data/lib/cybrid_api_bank_ruby/models/identity_record_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/identity_record_list_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/{post_trading_configuration_bank_model.rb → post_fee_configuration_bank_model.rb} +80 -8
  45. data/lib/cybrid_api_bank_ruby/models/post_identity_record_attestation_details_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/post_identity_record_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/reward_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  60. data/lib/cybrid_api_bank_ruby.rb +5 -5
  61. data/spec/api/accounts_bank_api_spec.rb +1 -1
  62. data/spec/api/assets_bank_api_spec.rb +1 -1
  63. data/spec/api/banks_bank_api_spec.rb +1 -1
  64. data/spec/api/customers_bank_api_spec.rb +1 -1
  65. data/spec/api/{trading_configurations_bank_api_spec.rb → fee_configurations_bank_api_spec.rb} +24 -24
  66. data/spec/api/identity_records_bank_api_spec.rb +1 -1
  67. data/spec/api/prices_bank_api_spec.rb +1 -1
  68. data/spec/api/quotes_bank_api_spec.rb +1 -1
  69. data/spec/api/rewards_bank_api_spec.rb +1 -1
  70. data/spec/api/symbols_bank_api_spec.rb +1 -1
  71. data/spec/api/trades_bank_api_spec.rb +1 -1
  72. data/spec/api/verification_keys_bank_api_spec.rb +1 -1
  73. data/spec/api_client_spec.rb +1 -1
  74. data/spec/configuration_spec.rb +1 -1
  75. data/spec/models/account_bank_model_spec.rb +1 -1
  76. data/spec/models/account_list_bank_model_spec.rb +1 -1
  77. data/spec/models/asset_bank_model_spec.rb +1 -1
  78. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  79. data/spec/models/attestation_details_bank_model_spec.rb +1 -1
  80. data/spec/models/bank_bank_model_spec.rb +1 -1
  81. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  82. data/spec/models/customer_bank_model_spec.rb +1 -1
  83. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  84. data/spec/models/error_response_bank_model_spec.rb +1 -1
  85. data/spec/models/fee_bank_model_spec.rb +1 -1
  86. data/spec/models/{post_trading_configuration_bank_model_spec.rb → fee_configuration_bank_model_spec.rb} +45 -7
  87. data/spec/models/{trading_configuration_list_bank_model_spec.rb → fee_configuration_list_bank_model_spec.rb} +7 -7
  88. data/spec/models/identity_record_bank_model_spec.rb +1 -1
  89. data/spec/models/identity_record_list_bank_model_spec.rb +1 -1
  90. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  91. data/spec/models/post_account_bank_model_spec.rb +1 -1
  92. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  93. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  94. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  95. data/spec/models/{trading_configuration_bank_model_spec.rb → post_fee_configuration_bank_model_spec.rb} +18 -16
  96. data/spec/models/post_identity_record_attestation_details_bank_model_spec.rb +1 -1
  97. data/spec/models/post_identity_record_bank_model_spec.rb +1 -1
  98. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  99. data/spec/models/post_reward_bank_model_spec.rb +1 -1
  100. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  101. data/spec/models/post_verification_key_bank_model_spec.rb +1 -1
  102. data/spec/models/quote_bank_model_spec.rb +1 -1
  103. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  104. data/spec/models/reward_bank_model_spec.rb +1 -1
  105. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  106. data/spec/models/trade_bank_model_spec.rb +1 -1
  107. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  108. data/spec/models/verification_key_bank_model_spec.rb +1 -1
  109. data/spec/models/verification_key_list_bank_model_spec.rb +1 -1
  110. data/spec/spec_helper.rb +1 -1
  111. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out +2 -2
  112. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out +2 -2
  113. 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
  114. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.4/gem_make.out +2 -2
  115. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out +2 -2
  116. data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  117. data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  118. data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  119. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych/Makefile +2 -2
  120. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  121. metadata +17 -17
  122. data/docs/PostTradingConfigurationBankModel.md +0 -20
  123. data/docs/TradingConfigurationsBankApi.md +0 -230
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 470ddfd8e82b9d6667eabfa58414e4c0156b58d90397e5933c5f82d814aa4cbb
4
- data.tar.gz: f454d6cd778c17eff1d6718d486ba3e32f7ea8824fc53a026f9b2447f602be46
3
+ metadata.gz: 443cbdd65af1b70891371c35c477bdf2e9655239e8f6f18ded149206212bc348
4
+ data.tar.gz: b1d8acec94c674aad9818c6af07c48a1ec358aabb644427d52ddae03982330d2
5
5
  SHA512:
6
- metadata.gz: 414f060821fad8486b3224760da0f7575638168ba39218c43415be15d6a6173c020981e2430515f3074614c8b130b67c5db0dc656b6254c725d5754276f5daa8
7
- data.tar.gz: 62d94a6221d1422cd3f5c014e42da00ebf571c584e0b240a0acdab901cc9c2d4398db4d60a82861e9d88697d6bd287546a151ec9f3c892ccebc1c6d4ff15fd91
6
+ metadata.gz: 51b792e2c5a28d23a6c27d68fc4e4f883ef0d352ced536f9ac55e1ddd96a1c4fed7b206b832f959487bd49f5ad38313c74c6e59c3118d663f4b125f55c0227fc
7
+ data.tar.gz: d7c7f794928682f0d93422516fe9ed3b4c4b4c729f5a3b604b323f64a1b6731795deb18be1e2ebad2ea7e125a73a7faf600061723188e737186aac7d9d665209
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_bank_ruby (0.35.4)
4
+ cybrid_api_bank_ruby (0.35.5)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -83,8 +83,8 @@ Customers must also have an account to be able to transact. See the Accounts API
83
83
 
84
84
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
85
85
 
86
- - API version: v0.35.4
87
- - Package version: 0.35.4
86
+ - API version: v0.35.5
87
+ - Package version: 0.35.5
88
88
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
89
89
 
90
90
  ## Installation
@@ -100,16 +100,16 @@ gem build cybrid_api_bank_ruby.gemspec
100
100
  Then either install the gem locally:
101
101
 
102
102
  ```shell
103
- gem install ./cybrid_api_bank_ruby-0.35.4.gem
103
+ gem install ./cybrid_api_bank_ruby-0.35.5.gem
104
104
  ```
105
105
 
106
- (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.35.4.gem` to install the development dependencies)
106
+ (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.35.5.gem` to install the development dependencies)
107
107
 
108
108
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
109
109
 
110
110
  Finally add this to the Gemfile:
111
111
 
112
- gem 'cybrid_api_bank_ruby', '~> 0.35.4'
112
+ gem 'cybrid_api_bank_ruby', '~> 0.35.5'
113
113
 
114
114
  ### Install from Git
115
115
 
@@ -172,6 +172,9 @@ Class | Method | HTTP request | Description
172
172
  *CybridApiBank::CustomersBankApi* | [**create_customer**](docs/CustomersBankApi.md#create_customer) | **POST** /api/customers | Create Customer
173
173
  *CybridApiBank::CustomersBankApi* | [**get_customer**](docs/CustomersBankApi.md#get_customer) | **GET** /api/customers/{customer_guid} | Get Customer
174
174
  *CybridApiBank::CustomersBankApi* | [**list_customers**](docs/CustomersBankApi.md#list_customers) | **GET** /api/customers | Get customers list
175
+ *CybridApiBank::FeeConfigurationsBankApi* | [**create_fee_configuration**](docs/FeeConfigurationsBankApi.md#create_fee_configuration) | **POST** /api/fee_configurations | Create FeeConfiguration
176
+ *CybridApiBank::FeeConfigurationsBankApi* | [**get_fee_configuration**](docs/FeeConfigurationsBankApi.md#get_fee_configuration) | **GET** /api/fee_configurations/{fee_configuration_guid} | Get FeeConfiguration
177
+ *CybridApiBank::FeeConfigurationsBankApi* | [**list_fee_configurations**](docs/FeeConfigurationsBankApi.md#list_fee_configurations) | **GET** /api/fee_configurations | List fee configurations
175
178
  *CybridApiBank::IdentityRecordsBankApi* | [**create_identity_record**](docs/IdentityRecordsBankApi.md#create_identity_record) | **POST** /api/identity_records | Create Identity Record
176
179
  *CybridApiBank::IdentityRecordsBankApi* | [**get_identity_record**](docs/IdentityRecordsBankApi.md#get_identity_record) | **GET** /api/identity_records/{identity_record_guid} | Get Identity Record
177
180
  *CybridApiBank::IdentityRecordsBankApi* | [**list_identity_records**](docs/IdentityRecordsBankApi.md#list_identity_records) | **GET** /api/identity_records | List Identity Records
@@ -184,9 +187,6 @@ Class | Method | HTTP request | Description
184
187
  *CybridApiBank::TradesBankApi* | [**create_trade**](docs/TradesBankApi.md#create_trade) | **POST** /api/trades | Create Trade
185
188
  *CybridApiBank::TradesBankApi* | [**get_trade**](docs/TradesBankApi.md#get_trade) | **GET** /api/trades/{trade_guid} | Get Trade
186
189
  *CybridApiBank::TradesBankApi* | [**list_trades**](docs/TradesBankApi.md#list_trades) | **GET** /api/trades | Get trades list
187
- *CybridApiBank::TradingConfigurationsBankApi* | [**create_trading_configuration**](docs/TradingConfigurationsBankApi.md#create_trading_configuration) | **POST** /api/trading_configurations | Create TradingConfiguration
188
- *CybridApiBank::TradingConfigurationsBankApi* | [**get_trading_configuration**](docs/TradingConfigurationsBankApi.md#get_trading_configuration) | **GET** /api/trading_configurations/{trading_configuration_guid} | Get TradingConfiguration
189
- *CybridApiBank::TradingConfigurationsBankApi* | [**list_trading_configurations**](docs/TradingConfigurationsBankApi.md#list_trading_configurations) | **GET** /api/trading_configurations | List trading configurations
190
190
  *CybridApiBank::VerificationKeysBankApi* | [**create_verification_key**](docs/VerificationKeysBankApi.md#create_verification_key) | **POST** /api/bank_verification_keys | Create VerificationKey
191
191
  *CybridApiBank::VerificationKeysBankApi* | [**get_verification_key**](docs/VerificationKeysBankApi.md#get_verification_key) | **GET** /api/bank_verification_keys/{verification_key_guid} | Get VerificationKey
192
192
  *CybridApiBank::VerificationKeysBankApi* | [**list_verification_keys**](docs/VerificationKeysBankApi.md#list_verification_keys) | **GET** /api/bank_verification_keys | Get Verification Keys list
@@ -205,6 +205,8 @@ Class | Method | HTTP request | Description
205
205
  - [CybridApiBank::CustomerListBankModel](docs/CustomerListBankModel.md)
206
206
  - [CybridApiBank::ErrorResponseBankModel](docs/ErrorResponseBankModel.md)
207
207
  - [CybridApiBank::FeeBankModel](docs/FeeBankModel.md)
208
+ - [CybridApiBank::FeeConfigurationBankModel](docs/FeeConfigurationBankModel.md)
209
+ - [CybridApiBank::FeeConfigurationListBankModel](docs/FeeConfigurationListBankModel.md)
208
210
  - [CybridApiBank::IdentityRecordBankModel](docs/IdentityRecordBankModel.md)
209
211
  - [CybridApiBank::IdentityRecordListBankModel](docs/IdentityRecordListBankModel.md)
210
212
  - [CybridApiBank::PatchBankBankModel](docs/PatchBankBankModel.md)
@@ -212,12 +214,12 @@ Class | Method | HTTP request | Description
212
214
  - [CybridApiBank::PostBankBankModel](docs/PostBankBankModel.md)
213
215
  - [CybridApiBank::PostCustomerBankModel](docs/PostCustomerBankModel.md)
214
216
  - [CybridApiBank::PostFeeBankModel](docs/PostFeeBankModel.md)
217
+ - [CybridApiBank::PostFeeConfigurationBankModel](docs/PostFeeConfigurationBankModel.md)
215
218
  - [CybridApiBank::PostIdentityRecordAttestationDetailsBankModel](docs/PostIdentityRecordAttestationDetailsBankModel.md)
216
219
  - [CybridApiBank::PostIdentityRecordBankModel](docs/PostIdentityRecordBankModel.md)
217
220
  - [CybridApiBank::PostQuoteBankModel](docs/PostQuoteBankModel.md)
218
221
  - [CybridApiBank::PostRewardBankModel](docs/PostRewardBankModel.md)
219
222
  - [CybridApiBank::PostTradeBankModel](docs/PostTradeBankModel.md)
220
- - [CybridApiBank::PostTradingConfigurationBankModel](docs/PostTradingConfigurationBankModel.md)
221
223
  - [CybridApiBank::PostVerificationKeyBankModel](docs/PostVerificationKeyBankModel.md)
222
224
  - [CybridApiBank::QuoteBankModel](docs/QuoteBankModel.md)
223
225
  - [CybridApiBank::QuoteListBankModel](docs/QuoteListBankModel.md)
@@ -225,8 +227,6 @@ Class | Method | HTTP request | Description
225
227
  - [CybridApiBank::SymbolPriceBankModel](docs/SymbolPriceBankModel.md)
226
228
  - [CybridApiBank::TradeBankModel](docs/TradeBankModel.md)
227
229
  - [CybridApiBank::TradeListBankModel](docs/TradeListBankModel.md)
228
- - [CybridApiBank::TradingConfigurationBankModel](docs/TradingConfigurationBankModel.md)
229
- - [CybridApiBank::TradingConfigurationListBankModel](docs/TradingConfigurationListBankModel.md)
230
230
  - [CybridApiBank::VerificationKeyBankModel](docs/VerificationKeyBankModel.md)
231
231
  - [CybridApiBank::VerificationKeyListBankModel](docs/VerificationKeyListBankModel.md)
232
232
 
@@ -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 | | Rewards | rewards:read | | rewards: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.35.4
8
+ The version of the OpenAPI document: v0.35.5
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.0.0
@@ -1,4 +1,4 @@
1
- # CybridApiBank::TradingConfigurationBankModel
1
+ # CybridApiBank::FeeConfigurationBankModel
2
2
 
3
3
  ## Properties
4
4
 
@@ -6,8 +6,10 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **guid** | **String** | Auto-generated unique identifier for the exchange. | [optional] |
8
8
  | **bank_guid** | **String** | The bank identifier. | [optional] |
9
+ | **product_type** | **String** | The type of product being configured. | [optional] |
9
10
  | **asset** | **String** | The asset code. | [optional] |
10
11
  | **created_at** | **Time** | ISO8601 datetime the bank was created at. | [optional] |
12
+ | **product_provider** | **String** | The provider for the product being configured. | [optional] |
11
13
  | **fees** | [**Array&lt;FeeBankModel&gt;**](FeeBankModel.md) | The fees associated with the configuration | [optional] |
12
14
 
13
15
  ## Example
@@ -15,11 +17,13 @@
15
17
  ```ruby
16
18
  require 'cybrid_api_bank_ruby'
17
19
 
18
- instance = CybridApiBank::TradingConfigurationBankModel.new(
20
+ instance = CybridApiBank::FeeConfigurationBankModel.new(
19
21
  guid: null,
20
22
  bank_guid: null,
23
+ product_type: null,
21
24
  asset: null,
22
25
  created_at: null,
26
+ product_provider: null,
23
27
  fees: null
24
28
  )
25
29
  ```
@@ -1,4 +1,4 @@
1
- # CybridApiBank::TradingConfigurationListBankModel
1
+ # CybridApiBank::FeeConfigurationListBankModel
2
2
 
3
3
  ## Properties
4
4
 
@@ -7,14 +7,14 @@
7
7
  | **total** | **Integer** | The total number of records available. | [optional] |
8
8
  | **page** | **Integer** | The page index to retrieve. | [optional] |
9
9
  | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
10
- | **objects** | [**Array&lt;TradingConfigurationBankModel&gt;**](TradingConfigurationBankModel.md) | | [optional] |
10
+ | **objects** | [**Array&lt;FeeConfigurationBankModel&gt;**](FeeConfigurationBankModel.md) | | [optional] |
11
11
 
12
12
  ## Example
13
13
 
14
14
  ```ruby
15
15
  require 'cybrid_api_bank_ruby'
16
16
 
17
- instance = CybridApiBank::TradingConfigurationListBankModel.new(
17
+ instance = CybridApiBank::FeeConfigurationListBankModel.new(
18
18
  total: null,
19
19
  page: null,
20
20
  per_page: null,
@@ -0,0 +1,230 @@
1
+ # CybridApiBank::FeeConfigurationsBankApi
2
+
3
+ All URIs are relative to *https://bank.demo.cybrid.app*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_fee_configuration**](FeeConfigurationsBankApi.md#create_fee_configuration) | **POST** /api/fee_configurations | Create FeeConfiguration |
8
+ | [**get_fee_configuration**](FeeConfigurationsBankApi.md#get_fee_configuration) | **GET** /api/fee_configurations/{fee_configuration_guid} | Get FeeConfiguration |
9
+ | [**list_fee_configurations**](FeeConfigurationsBankApi.md#list_fee_configurations) | **GET** /api/fee_configurations | List fee configurations |
10
+
11
+
12
+ ## create_fee_configuration
13
+
14
+ > <FeeConfigurationBankModel> create_fee_configuration(post_fee_configuration_bank_model)
15
+
16
+ Create FeeConfiguration
17
+
18
+ Creates a fee 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::FeeConfigurationsBankApi.new
35
+ post_fee_configuration_bank_model = CybridApiBank::PostFeeConfigurationBankModel.new({product_type: 'trading', asset: 'asset_example', fees: [CybridApiBank::PostFeeBankModel.new({type: 'spread'})]}) # PostFeeConfigurationBankModel |
36
+
37
+ begin
38
+ # Create FeeConfiguration
39
+ result = api_instance.create_fee_configuration(post_fee_configuration_bank_model)
40
+ p result
41
+ rescue CybridApiBank::ApiError => e
42
+ puts "Error when calling FeeConfigurationsBankApi->create_fee_configuration: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_fee_configuration_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<FeeConfigurationBankModel>, Integer, Hash)> create_fee_configuration_with_http_info(post_fee_configuration_bank_model)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create FeeConfiguration
55
+ data, status_code, headers = api_instance.create_fee_configuration_with_http_info(post_fee_configuration_bank_model)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <FeeConfigurationBankModel>
59
+ rescue CybridApiBank::ApiError => e
60
+ puts "Error when calling FeeConfigurationsBankApi->create_fee_configuration_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **post_fee_configuration_bank_model** | [**PostFeeConfigurationBankModel**](PostFeeConfigurationBankModel.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**FeeConfigurationBankModel**](FeeConfigurationBankModel.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_fee_configuration
85
+
86
+ > <FeeConfigurationBankModel> get_fee_configuration(fee_configuration_guid)
87
+
88
+ Get FeeConfiguration
89
+
90
+ Retrieves a fee 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::FeeConfigurationsBankApi.new
107
+ fee_configuration_guid = 'fee_configuration_guid_example' # String | Identifier for the fee configuration.
108
+
109
+ begin
110
+ # Get FeeConfiguration
111
+ result = api_instance.get_fee_configuration(fee_configuration_guid)
112
+ p result
113
+ rescue CybridApiBank::ApiError => e
114
+ puts "Error when calling FeeConfigurationsBankApi->get_fee_configuration: #{e}"
115
+ end
116
+ ```
117
+
118
+ #### Using the get_fee_configuration_with_http_info variant
119
+
120
+ This returns an Array which contains the response data, status code and headers.
121
+
122
+ > <Array(<FeeConfigurationBankModel>, Integer, Hash)> get_fee_configuration_with_http_info(fee_configuration_guid)
123
+
124
+ ```ruby
125
+ begin
126
+ # Get FeeConfiguration
127
+ data, status_code, headers = api_instance.get_fee_configuration_with_http_info(fee_configuration_guid)
128
+ p status_code # => 2xx
129
+ p headers # => { ... }
130
+ p data # => <FeeConfigurationBankModel>
131
+ rescue CybridApiBank::ApiError => e
132
+ puts "Error when calling FeeConfigurationsBankApi->get_fee_configuration_with_http_info: #{e}"
133
+ end
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+ | Name | Type | Description | Notes |
139
+ | ---- | ---- | ----------- | ----- |
140
+ | **fee_configuration_guid** | **String** | Identifier for the fee configuration. | |
141
+
142
+ ### Return type
143
+
144
+ [**FeeConfigurationBankModel**](FeeConfigurationBankModel.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_fee_configurations
157
+
158
+ > <FeeConfigurationListBankModel> list_fee_configurations(opts)
159
+
160
+ List fee configurations
161
+
162
+ Retrieves a listing of fee 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::FeeConfigurationsBankApi.new
179
+ opts = {
180
+ page: 56, # Integer |
181
+ per_page: 56 # Integer |
182
+ }
183
+
184
+ begin
185
+ # List fee configurations
186
+ result = api_instance.list_fee_configurations(opts)
187
+ p result
188
+ rescue CybridApiBank::ApiError => e
189
+ puts "Error when calling FeeConfigurationsBankApi->list_fee_configurations: #{e}"
190
+ end
191
+ ```
192
+
193
+ #### Using the list_fee_configurations_with_http_info variant
194
+
195
+ This returns an Array which contains the response data, status code and headers.
196
+
197
+ > <Array(<FeeConfigurationListBankModel>, Integer, Hash)> list_fee_configurations_with_http_info(opts)
198
+
199
+ ```ruby
200
+ begin
201
+ # List fee configurations
202
+ data, status_code, headers = api_instance.list_fee_configurations_with_http_info(opts)
203
+ p status_code # => 2xx
204
+ p headers # => { ... }
205
+ p data # => <FeeConfigurationListBankModel>
206
+ rescue CybridApiBank::ApiError => e
207
+ puts "Error when calling FeeConfigurationsBankApi->list_fee_configurations_with_http_info: #{e}"
208
+ end
209
+ ```
210
+
211
+ ### Parameters
212
+
213
+ | Name | Type | Description | Notes |
214
+ | ---- | ---- | ----------- | ----- |
215
+ | **page** | **Integer** | | [optional] |
216
+ | **per_page** | **Integer** | | [optional] |
217
+
218
+ ### Return type
219
+
220
+ [**FeeConfigurationListBankModel**](FeeConfigurationListBankModel.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
+
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::PostFeeConfigurationBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **product_type** | **String** | The type of product being configured. | |
8
+ | **asset** | **String** | The asset code. | |
9
+ | **fees** | [**Array&lt;PostFeeBankModel&gt;**](PostFeeBankModel.md) | The fees associated with the configuration | |
10
+ | **product_provider** | **String** | The provider for the product being configured. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::PostFeeConfigurationBankModel.new(
18
+ product_type: null,
19
+ asset: null,
20
+ fees: null,
21
+ product_provider: null
22
+ )
23
+ ```
24
+
@@ -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 | | Rewards | rewards:read | | rewards: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.35.4
6
+ The version of the OpenAPI document: v0.35.5
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.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 | | Rewards | rewards:read | | rewards: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.35.4
6
+ The version of the OpenAPI document: v0.35.5
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.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 | | Rewards | rewards:read | | rewards: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.35.4
6
+ The version of the OpenAPI document: v0.35.5
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.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 | | Rewards | rewards:read | | rewards: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.35.4
6
+ The version of the OpenAPI document: v0.35.5
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0