cybrid_api_bank_ruby 0.92.5 → 0.93.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (164) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -12
  4. data/cybrid_api_bank_ruby.gemspec +2 -2
  5. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +2 -2
  6. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
  7. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
  8. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
  9. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +2 -2
  10. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
  11. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +2 -2
  12. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
  13. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
  14. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
  15. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
  16. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
  17. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +2 -2
  18. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +2 -2
  19. data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
  20. data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
  21. data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
  22. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
  23. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
  24. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
  25. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
  26. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
  27. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
  28. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +2 -2
  29. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
  30. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
  31. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +2 -2
  32. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +2 -2
  33. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +2 -2
  34. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
  35. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
  36. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
  37. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +2 -2
  38. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +2 -2
  39. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +2 -2
  40. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
  41. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_all_of_bank_model.rb +2 -2
  42. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +2 -2
  43. data/lib/cybrid_api_bank_ruby/models/list_request_owner_bank_model.rb +2 -2
  44. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
  45. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -2
  46. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +2 -2
  47. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
  48. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +2 -2
  49. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +2 -2
  50. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +2 -2
  51. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +2 -2
  52. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +2 -2
  53. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +2 -2
  54. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +2 -2
  56. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +2 -2
  57. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +2 -2
  58. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +2 -2
  59. data/lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb +2 -2
  60. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
  61. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +2 -2
  62. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +2 -2
  63. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
  64. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
  65. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
  66. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  67. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
  68. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +2 -2
  69. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +2 -2
  70. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +2 -2
  71. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +2 -2
  72. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +2 -2
  73. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +2 -2
  74. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +2 -2
  75. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +2 -2
  76. data/lib/cybrid_api_bank_ruby/version.rb +3 -3
  77. data/lib/cybrid_api_bank_ruby.rb +2 -5
  78. data/spec/api/accounts_bank_api_spec.rb +2 -2
  79. data/spec/api/assets_bank_api_spec.rb +2 -2
  80. data/spec/api/banks_bank_api_spec.rb +2 -2
  81. data/spec/api/customers_bank_api_spec.rb +2 -2
  82. data/spec/api/deposit_addresses_bank_api_spec.rb +2 -2
  83. data/spec/api/external_bank_accounts_bank_api_spec.rb +2 -2
  84. data/spec/api/external_wallets_bank_api_spec.rb +2 -2
  85. data/spec/api/identity_verifications_bank_api_spec.rb +2 -2
  86. data/spec/api/prices_bank_api_spec.rb +2 -2
  87. data/spec/api/quotes_bank_api_spec.rb +2 -2
  88. data/spec/api/symbols_bank_api_spec.rb +2 -2
  89. data/spec/api/trades_bank_api_spec.rb +2 -2
  90. data/spec/api/transfers_bank_api_spec.rb +2 -2
  91. data/spec/api/workflows_bank_api_spec.rb +2 -2
  92. data/spec/api_client_spec.rb +2 -2
  93. data/spec/configuration_spec.rb +2 -2
  94. data/spec/models/account_bank_model_spec.rb +2 -2
  95. data/spec/models/account_list_bank_model_spec.rb +2 -2
  96. data/spec/models/asset_bank_model_spec.rb +2 -2
  97. data/spec/models/asset_list_bank_model_spec.rb +2 -2
  98. data/spec/models/bank_bank_model_spec.rb +2 -2
  99. data/spec/models/bank_list_bank_model_spec.rb +2 -2
  100. data/spec/models/customer_address_bank_model_spec.rb +2 -2
  101. data/spec/models/customer_bank_model_spec.rb +2 -2
  102. data/spec/models/customer_list_bank_model_spec.rb +2 -2
  103. data/spec/models/customer_name_bank_model_spec.rb +2 -2
  104. data/spec/models/deposit_address_bank_model_spec.rb +2 -2
  105. data/spec/models/deposit_address_list_bank_model_spec.rb +2 -2
  106. data/spec/models/error_response_bank_model_spec.rb +2 -2
  107. data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
  108. data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
  109. data/spec/models/external_wallet_bank_model_spec.rb +2 -2
  110. data/spec/models/external_wallet_list_bank_model_spec.rb +2 -2
  111. data/spec/models/identity_verification_bank_model_spec.rb +2 -2
  112. data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
  113. data/spec/models/identity_verification_with_details_all_of_bank_model_spec.rb +2 -2
  114. data/spec/models/identity_verification_with_details_bank_model_spec.rb +2 -2
  115. data/spec/models/list_request_owner_bank_model_spec.rb +2 -2
  116. data/spec/models/patch_bank_bank_model_spec.rb +2 -2
  117. data/spec/models/patch_external_bank_account_bank_model_spec.rb +2 -2
  118. data/spec/models/post_account_bank_model_spec.rb +2 -2
  119. data/spec/models/post_bank_bank_model_spec.rb +2 -2
  120. data/spec/models/post_customer_address_bank_model_spec.rb +2 -2
  121. data/spec/models/post_customer_bank_model_spec.rb +2 -2
  122. data/spec/models/post_customer_name_bank_model_spec.rb +2 -2
  123. data/spec/models/post_deposit_address_bank_model_spec.rb +2 -2
  124. data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
  125. data/spec/models/post_external_wallet_bank_model_spec.rb +2 -2
  126. data/spec/models/post_identification_number_bank_model_spec.rb +2 -2
  127. data/spec/models/post_identity_verification_address_bank_model_spec.rb +2 -2
  128. data/spec/models/post_identity_verification_bank_model_spec.rb +2 -2
  129. data/spec/models/post_identity_verification_name_bank_model_spec.rb +2 -2
  130. data/spec/models/post_quote_bank_model_spec.rb +2 -2
  131. data/spec/models/post_reward_bank_model_spec.rb +2 -2
  132. data/spec/models/post_trade_bank_model_spec.rb +2 -2
  133. data/spec/models/post_transfer_bank_model_spec.rb +2 -2
  134. data/spec/models/post_workflow_bank_model_spec.rb +2 -2
  135. data/spec/models/quote_bank_model_spec.rb +2 -2
  136. data/spec/models/quote_list_bank_model_spec.rb +2 -2
  137. data/spec/models/symbol_price_bank_model_spec.rb +2 -2
  138. data/spec/models/trade_bank_model_spec.rb +2 -2
  139. data/spec/models/trade_list_bank_model_spec.rb +2 -2
  140. data/spec/models/transfer_bank_model_spec.rb +2 -2
  141. data/spec/models/transfer_destination_account_bank_model_spec.rb +2 -2
  142. data/spec/models/transfer_list_bank_model_spec.rb +2 -2
  143. data/spec/models/transfer_source_account_bank_model_spec.rb +2 -2
  144. data/spec/models/workflow_bank_model_spec.rb +2 -2
  145. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +2 -2
  146. data/spec/models/workflow_with_details_bank_model_spec.rb +2 -2
  147. data/spec/models/workflows_list_bank_model_spec.rb +2 -2
  148. data/spec/spec_helper.rb +2 -2
  149. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  150. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +5 -5
  151. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  152. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.0/gem_make.out +5 -5
  153. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.1/gem_make.out +5 -5
  154. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.8/gem_make.out +5 -5
  155. metadata +1 -13
  156. data/docs/RewardBankModel.md +0 -36
  157. data/docs/RewardListBankModel.md +0 -24
  158. data/docs/RewardsBankApi.md +0 -236
  159. data/lib/cybrid_api_bank_ruby/api/rewards_bank_api.rb +0 -237
  160. data/lib/cybrid_api_bank_ruby/models/reward_bank_model.rb +0 -440
  161. data/lib/cybrid_api_bank_ruby/models/reward_list_bank_model.rb +0 -329
  162. data/spec/api/rewards_bank_api_spec.rb +0 -75
  163. data/spec/models/reward_bank_model_spec.rb +0 -92
  164. data/spec/models/reward_list_bank_model_spec.rb +0 -52
@@ -1,329 +0,0 @@
1
- =begin
2
- #Cybrid Bank API
3
-
4
- ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.sandbox.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API 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 the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a 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. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication 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, Bank or Customer 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Reward | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create an organization user | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Reward | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
-
6
- The version of the OpenAPI document: v0.92.5
7
- Contact: support@cybrid.app
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module CybridApiBank
17
- class RewardListBankModel
18
- # The total number of records available.
19
- attr_accessor :total
20
-
21
- # The page index to retrieve.
22
- attr_accessor :page
23
-
24
- # The number of entities per page to return.
25
- attr_accessor :per_page
26
-
27
- # Array of reward entities
28
- attr_accessor :objects
29
-
30
- # Attribute mapping from ruby-style variable name to JSON key.
31
- def self.attribute_map
32
- {
33
- :'total' => :'total',
34
- :'page' => :'page',
35
- :'per_page' => :'per_page',
36
- :'objects' => :'objects'
37
- }
38
- end
39
-
40
- # Returns all the JSON keys this model knows about
41
- def self.acceptable_attributes
42
- attribute_map.values
43
- end
44
-
45
- # Attribute type mapping.
46
- def self.openapi_types
47
- {
48
- :'total' => :'Integer',
49
- :'page' => :'Integer',
50
- :'per_page' => :'Integer',
51
- :'objects' => :'Array<RewardBankModel>'
52
- }
53
- end
54
-
55
- # List of attributes with nullable: true
56
- def self.openapi_nullable
57
- Set.new([
58
- ])
59
- end
60
-
61
- # Initializes the object
62
- # @param [Hash] attributes Model attributes in the form of hash
63
- def initialize(attributes = {})
64
- if (!attributes.is_a?(Hash))
65
- fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::RewardListBankModel` initialize method"
66
- end
67
-
68
- # check to see if the attribute exists and convert string to symbol for hash key
69
- attributes = attributes.each_with_object({}) { |(k, v), h|
70
- if (!self.class.attribute_map.key?(k.to_sym))
71
- fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::RewardListBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
72
- end
73
- h[k.to_sym] = v
74
- }
75
-
76
- if attributes.key?(:'total')
77
- self.total = attributes[:'total']
78
- end
79
-
80
- if attributes.key?(:'page')
81
- self.page = attributes[:'page']
82
- end
83
-
84
- if attributes.key?(:'per_page')
85
- self.per_page = attributes[:'per_page']
86
- end
87
-
88
- if attributes.key?(:'objects')
89
- if (value = attributes[:'objects']).is_a?(Array)
90
- self.objects = value
91
- end
92
- end
93
- end
94
-
95
- # Show invalid properties with the reasons. Usually used together with valid?
96
- # @return Array for valid properties with the reasons
97
- def list_invalid_properties
98
- invalid_properties = Array.new
99
- if @total.nil?
100
- invalid_properties.push('invalid value for "total", total cannot be nil.')
101
- end
102
-
103
- if @total < 0
104
- invalid_properties.push('invalid value for "total", must be greater than or equal to 0.')
105
- end
106
-
107
- if @page.nil?
108
- invalid_properties.push('invalid value for "page", page cannot be nil.')
109
- end
110
-
111
- if @page < 0
112
- invalid_properties.push('invalid value for "page", must be greater than or equal to 0.')
113
- end
114
-
115
- if @per_page.nil?
116
- invalid_properties.push('invalid value for "per_page", per_page cannot be nil.')
117
- end
118
-
119
- if @per_page < 0
120
- invalid_properties.push('invalid value for "per_page", must be greater than or equal to 0.')
121
- end
122
-
123
- if @objects.nil?
124
- invalid_properties.push('invalid value for "objects", objects cannot be nil.')
125
- end
126
-
127
- invalid_properties
128
- end
129
-
130
- # Check to see if the all the properties in the model are valid
131
- # @return true if the model is valid
132
- def valid?
133
- return false if @total.nil?
134
- return false if @total < 0
135
- return false if @page.nil?
136
- return false if @page < 0
137
- return false if @per_page.nil?
138
- return false if @per_page < 0
139
- return false if @objects.nil?
140
- true
141
- end
142
-
143
- # Custom attribute writer method with validation
144
- # @param [Object] total Value to be assigned
145
- def total=(total)
146
- if total.nil?
147
- fail ArgumentError, 'total cannot be nil'
148
- end
149
-
150
- if total < 0
151
- fail ArgumentError, 'invalid value for "total", must be greater than or equal to 0.'
152
- end
153
-
154
- @total = total
155
- end
156
-
157
- # Custom attribute writer method with validation
158
- # @param [Object] page Value to be assigned
159
- def page=(page)
160
- if page.nil?
161
- fail ArgumentError, 'page cannot be nil'
162
- end
163
-
164
- if page < 0
165
- fail ArgumentError, 'invalid value for "page", must be greater than or equal to 0.'
166
- end
167
-
168
- @page = page
169
- end
170
-
171
- # Custom attribute writer method with validation
172
- # @param [Object] per_page Value to be assigned
173
- def per_page=(per_page)
174
- if per_page.nil?
175
- fail ArgumentError, 'per_page cannot be nil'
176
- end
177
-
178
- if per_page < 0
179
- fail ArgumentError, 'invalid value for "per_page", must be greater than or equal to 0.'
180
- end
181
-
182
- @per_page = per_page
183
- end
184
-
185
- # Checks equality by comparing each attribute.
186
- # @param [Object] Object to be compared
187
- def ==(o)
188
- return true if self.equal?(o)
189
- self.class == o.class &&
190
- total == o.total &&
191
- page == o.page &&
192
- per_page == o.per_page &&
193
- objects == o.objects
194
- end
195
-
196
- # @see the `==` method
197
- # @param [Object] Object to be compared
198
- def eql?(o)
199
- self == o
200
- end
201
-
202
- # Calculates hash code according to all attributes.
203
- # @return [Integer] Hash code
204
- def hash
205
- [total, page, per_page, objects].hash
206
- end
207
-
208
- # Builds the object from hash
209
- # @param [Hash] attributes Model attributes in the form of hash
210
- # @return [Object] Returns the model itself
211
- def self.build_from_hash(attributes)
212
- new.build_from_hash(attributes)
213
- end
214
-
215
- # Builds the object from hash
216
- # @param [Hash] attributes Model attributes in the form of hash
217
- # @return [Object] Returns the model itself
218
- def build_from_hash(attributes)
219
- return nil unless attributes.is_a?(Hash)
220
- attributes = attributes.transform_keys(&:to_sym)
221
- self.class.openapi_types.each_pair do |key, type|
222
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
223
- self.send("#{key}=", nil)
224
- elsif type =~ /\AArray<(.*)>/i
225
- # check to ensure the input is an array given that the attribute
226
- # is documented as an array but the input is not
227
- if attributes[self.class.attribute_map[key]].is_a?(Array)
228
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
229
- end
230
- elsif !attributes[self.class.attribute_map[key]].nil?
231
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
232
- end
233
- end
234
-
235
- self
236
- end
237
-
238
- # Deserializes the data based on type
239
- # @param string type Data type
240
- # @param string value Value to be deserialized
241
- # @return [Object] Deserialized data
242
- def _deserialize(type, value)
243
- case type.to_sym
244
- when :Time
245
- Time.parse(value)
246
- when :Date
247
- Date.parse(value)
248
- when :String
249
- value.to_s
250
- when :Integer
251
- value.to_i
252
- when :Float
253
- value.to_f
254
- when :Boolean
255
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
256
- true
257
- else
258
- false
259
- end
260
- when :Object
261
- # generic object (usually a Hash), return directly
262
- value
263
- when /\AArray<(?<inner_type>.+)>\z/
264
- inner_type = Regexp.last_match[:inner_type]
265
- value.map { |v| _deserialize(inner_type, v) }
266
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
267
- k_type = Regexp.last_match[:k_type]
268
- v_type = Regexp.last_match[:v_type]
269
- {}.tap do |hash|
270
- value.each do |k, v|
271
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
272
- end
273
- end
274
- else # model
275
- # models (e.g. Pet) or oneOf
276
- klass = CybridApiBank.const_get(type)
277
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
278
- end
279
- end
280
-
281
- # Returns the string representation of the object
282
- # @return [String] String presentation of the object
283
- def to_s
284
- to_hash.to_s
285
- end
286
-
287
- # to_body is an alias to to_hash (backward compatibility)
288
- # @return [Hash] Returns the object in the form of hash
289
- def to_body
290
- to_hash
291
- end
292
-
293
- # Returns the object in the form of hash
294
- # @return [Hash] Returns the object in the form of hash
295
- def to_hash
296
- hash = {}
297
- self.class.attribute_map.each_pair do |attr, param|
298
- value = self.send(attr)
299
- if value.nil?
300
- is_nullable = self.class.openapi_nullable.include?(attr)
301
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
302
- end
303
-
304
- hash[param] = _to_hash(value)
305
- end
306
- hash
307
- end
308
-
309
- # Outputs non-array value in the form of hash
310
- # For object, use to_hash. Otherwise, just return the value
311
- # @param [Object] value Any valid value
312
- # @return [Hash] Returns the value in the form of hash
313
- def _to_hash(value)
314
- if value.is_a?(Array)
315
- value.compact.map { |v| _to_hash(v) }
316
- elsif value.is_a?(Hash)
317
- {}.tap do |hash|
318
- value.each { |k, v| hash[k] = _to_hash(v) }
319
- end
320
- elsif value.respond_to? :to_hash
321
- value.to_hash
322
- else
323
- value
324
- end
325
- end
326
-
327
- end
328
-
329
- end
@@ -1,75 +0,0 @@
1
- =begin
2
- #Cybrid Bank API
3
-
4
- ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.sandbox.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API 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 the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a 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. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication 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, Bank or Customer 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Reward | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create an organization user | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Reward | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
-
6
- The version of the OpenAPI document: v0.92.5
7
- Contact: support@cybrid.app
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
-
16
- # Unit tests for CybridApiBank::RewardsBankApi
17
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
- # Please update as you see appropriate
19
- describe 'RewardsBankApi' do
20
- before do
21
- # run before each test
22
- @api_instance = CybridApiBank::RewardsBankApi.new
23
- end
24
-
25
- after do
26
- # run after each test
27
- end
28
-
29
- describe 'test an instance of RewardsBankApi' do
30
- it 'should create an instance of RewardsBankApi' do
31
- expect(@api_instance).to be_instance_of(CybridApiBank::RewardsBankApi)
32
- end
33
- end
34
-
35
- # unit tests for create_rewards
36
- # Create Reward
37
- # Creates a reward. Required scope: **rewards:execute**
38
- # @param post_reward_bank_model
39
- # @param [Hash] opts the optional parameters
40
- # @return [RewardBankModel]
41
- describe 'create_rewards test' do
42
- it 'should work' do
43
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
- end
45
- end
46
-
47
- # unit tests for get_reward
48
- # Get Reward
49
- # Retrieves a reward. Required scope: **rewards:read**
50
- # @param reward_guid Identifier for the reward.
51
- # @param [Hash] opts the optional parameters
52
- # @return [RewardBankModel]
53
- describe 'get_reward test' do
54
- it 'should work' do
55
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
- end
57
- end
58
-
59
- # unit tests for list_rewards
60
- # Get rewards list
61
- # Retrieves a listing of rewards. Required scope: **rewards:read**
62
- # @param [Hash] opts the optional parameters
63
- # @option opts [Integer] :page The page index to retrieve.
64
- # @option opts [Integer] :per_page The number of entities per page to return.
65
- # @option opts [String] :guid Comma separated reward_guids to list rewards for.
66
- # @option opts [String] :bank_guid Comma separated bank_guids to list rewards for.
67
- # @option opts [String] :customer_guid Comma separated customer_guids to list rewards for.
68
- # @return [RewardListBankModel]
69
- describe 'list_rewards test' do
70
- it 'should work' do
71
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
72
- end
73
- end
74
-
75
- end
@@ -1,92 +0,0 @@
1
- =begin
2
- #Cybrid Bank API
3
-
4
- ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.sandbox.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API 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 the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a 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. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication 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, Bank or Customer 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Reward | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create an organization user | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Reward | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
-
6
- The version of the OpenAPI document: v0.92.5
7
- Contact: support@cybrid.app
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for CybridApiBank::RewardBankModel
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe CybridApiBank::RewardBankModel do
21
- let(:instance) { CybridApiBank::RewardBankModel.new }
22
-
23
- describe 'test an instance of RewardBankModel' do
24
- it 'should create an instance of RewardBankModel' do
25
- expect(instance).to be_instance_of(CybridApiBank::RewardBankModel)
26
- end
27
- end
28
- describe 'test attribute "guid"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- describe 'test attribute "customer_guid"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- describe 'test attribute "quote_guid"' do
41
- it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
- end
44
- end
45
-
46
- describe 'test attribute "trade_guid"' do
47
- it 'should work' do
48
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
- end
50
- end
51
-
52
- describe 'test attribute "symbol"' do
53
- it 'should work' do
54
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
- end
56
- end
57
-
58
- describe 'test attribute "state"' do
59
- it 'should work' do
60
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
61
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["storing", "pending", "cancelled", "completed", "settling", "failed"])
62
- # validator.allowable_values.each do |value|
63
- # expect { instance.state = value }.not_to raise_error
64
- # end
65
- end
66
- end
67
-
68
- describe 'test attribute "receive_amount"' do
69
- it 'should work' do
70
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
71
- end
72
- end
73
-
74
- describe 'test attribute "deliver_amount"' do
75
- it 'should work' do
76
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
77
- end
78
- end
79
-
80
- describe 'test attribute "fee"' do
81
- it 'should work' do
82
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
83
- end
84
- end
85
-
86
- describe 'test attribute "created_at"' do
87
- it 'should work' do
88
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
89
- end
90
- end
91
-
92
- end