cybrid_api_organization_ruby 0.54.6 → 0.54.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (125) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +5 -5
  4. data/cybrid_api_organization_ruby.gemspec +1 -1
  5. data/lib/cybrid_api_organization_ruby/api/organizations_organization_api.rb +1 -1
  6. data/lib/cybrid_api_organization_ruby/api_client.rb +1 -1
  7. data/lib/cybrid_api_organization_ruby/api_error.rb +1 -1
  8. data/lib/cybrid_api_organization_ruby/configuration.rb +1 -1
  9. data/lib/cybrid_api_organization_ruby/models/error_response_organization_model.rb +1 -1
  10. data/lib/cybrid_api_organization_ruby/models/organization_organization_model.rb +1 -1
  11. data/lib/cybrid_api_organization_ruby/models/patch_organization_organization_model.rb +1 -1
  12. data/lib/cybrid_api_organization_ruby/version.rb +2 -2
  13. data/lib/cybrid_api_organization_ruby.rb +1 -1
  14. data/spec/api/organizations_organization_api_spec.rb +1 -1
  15. data/spec/api_client_spec.rb +1 -1
  16. data/spec/configuration_spec.rb +1 -1
  17. data/spec/models/error_response_organization_model_spec.rb +1 -1
  18. data/spec/models/organization_organization_model_spec.rb +1 -1
  19. data/spec/models/patch_organization_organization_model_spec.rb +1 -1
  20. data/spec/spec_helper.rb +1 -1
  21. data/vendor/bundle/ruby/3.1.0/cache/parser-3.1.3.0.gem +0 -0
  22. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out +2 -2
  23. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out +2 -2
  24. 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
  25. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.6/gem_make.out +2 -2
  26. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out +2 -2
  27. data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  28. data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  29. data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  30. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/LICENSE.txt +0 -0
  31. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/bin/ruby-parse +0 -0
  32. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/bin/ruby-rewrite +0 -0
  33. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/gauntlet_parser.rb +0 -0
  34. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/all.rb +0 -0
  35. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/ast/node.rb +0 -0
  36. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/ast/processor.rb +3 -0
  37. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/base.rb +0 -0
  38. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/builders/default.rb +8 -0
  39. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/clobbering_error.rb +0 -0
  40. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/color.rb +0 -0
  41. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/context.rb +0 -0
  42. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/current.rb +3 -3
  43. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/current_arg_stack.rb +0 -0
  44. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/deprecation.rb +0 -0
  45. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/diagnostic/engine.rb +0 -0
  46. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/diagnostic.rb +0 -0
  47. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/lexer/dedenter.rb +0 -0
  48. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/lexer/explanation.rb +0 -0
  49. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/lexer/literal.rb +0 -0
  50. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/lexer/stack_state.rb +0 -0
  51. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/lexer.rb +867 -837
  52. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/macruby.rb +9632 -0
  53. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/max_numparam_stack.rb +0 -0
  54. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/messages.rb +2 -0
  55. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/meta.rb +1 -0
  56. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/rewriter.rb +0 -0
  57. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby18.rb +9270 -0
  58. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby19.rb +9556 -0
  59. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby20.rb +10227 -0
  60. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby21.rb +10201 -0
  61. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby22.rb +10300 -0
  62. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby23.rb +10320 -0
  63. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby24.rb +10452 -0
  64. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby25.rb +10372 -0
  65. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby26.rb +10350 -0
  66. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby27.rb +11945 -0
  67. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/ruby28.rb +0 -0
  68. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby30.rb +12241 -0
  69. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby31.rb +12714 -0
  70. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/ruby32.rb +12691 -0
  71. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.3.0/lib/parser/rubymotion.rb +9513 -0
  72. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/runner/ruby_parse.rb +0 -0
  73. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/runner/ruby_rewrite.rb +0 -0
  74. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/runner.rb +0 -0
  75. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/buffer.rb +0 -0
  76. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/comment/associator.rb +0 -0
  77. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/comment.rb +0 -0
  78. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/collection.rb +0 -0
  79. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/condition.rb +0 -0
  80. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/constant.rb +0 -0
  81. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/definition.rb +0 -0
  82. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/for.rb +0 -0
  83. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/heredoc.rb +0 -0
  84. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/index.rb +0 -0
  85. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/keyword.rb +0 -0
  86. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/method_definition.rb +0 -0
  87. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/objc_kwarg.rb +0 -0
  88. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/operator.rb +0 -0
  89. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/rescue_body.rb +0 -0
  90. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/send.rb +0 -0
  91. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/ternary.rb +0 -0
  92. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map/variable.rb +0 -0
  93. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/map.rb +0 -0
  94. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/range.rb +0 -0
  95. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/rewriter/action.rb +0 -0
  96. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/rewriter.rb +0 -0
  97. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/tree_rewriter/action.rb +0 -0
  98. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/source/tree_rewriter.rb +0 -0
  99. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/static_environment.rb +18 -0
  100. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/syntax_error.rb +0 -0
  101. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/tree_rewriter.rb +0 -0
  102. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/variables_stack.rb +0 -0
  103. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/version.rb +1 -1
  104. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser.rb +0 -0
  105. data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/parser.gemspec +1 -1
  106. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.6/ext/psych/Makefile +2 -2
  107. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  108. data/vendor/bundle/ruby/3.1.0/specifications/{parser-3.1.2.1.gemspec → parser-3.1.3.0.gemspec} +6 -6
  109. metadata +79 -79
  110. data/vendor/bundle/ruby/3.1.0/cache/parser-3.1.2.1.gem +0 -0
  111. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/macruby.rb +0 -6177
  112. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby18.rb +0 -5708
  113. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby19.rb +0 -6126
  114. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby20.rb +0 -6563
  115. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby21.rb +0 -6611
  116. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby22.rb +0 -6655
  117. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby23.rb +0 -6669
  118. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby24.rb +0 -6736
  119. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby25.rb +0 -6694
  120. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby26.rb +0 -6721
  121. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby27.rb +0 -7914
  122. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby30.rb +0 -8096
  123. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby31.rb +0 -8358
  124. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/ruby32.rb +0 -8338
  125. data/vendor/bundle/ruby/3.1.0/gems/parser-3.1.2.1/lib/parser/rubymotion.rb +0 -6125
data/spec/api_client_spec.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
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.demo.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. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/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://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-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.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 (and all downstream customer activity) | | [Identities API](https://id.demo.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.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.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. <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. ``` 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\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <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 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.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 | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent 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. Banks are created in either `Sandbox` or `Production` mode, where Sandbox is the environment that you would test, prototype and build in prior 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. 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, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.54.6
6
+ The version of the OpenAPI document: v0.54.7
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
data/spec/configuration_spec.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
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.demo.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. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/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://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-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.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 (and all downstream customer activity) | | [Identities API](https://id.demo.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.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.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. <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. ``` 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\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <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 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.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 | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent 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. Banks are created in either `Sandbox` or `Production` mode, where Sandbox is the environment that you would test, prototype and build in prior 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. 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, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.54.6
6
+ The version of the OpenAPI document: v0.54.7
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
data/spec/models/error_response_organization_model_spec.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
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.demo.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. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/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://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-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.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 (and all downstream customer activity) | | [Identities API](https://id.demo.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.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.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. <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. ``` 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\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <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 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.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 | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent 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. Banks are created in either `Sandbox` or `Production` mode, where Sandbox is the environment that you would test, prototype and build in prior 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. 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, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.54.6
6
+ The version of the OpenAPI document: v0.54.7
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
data/spec/models/organization_organization_model_spec.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
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.demo.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. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/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://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-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.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 (and all downstream customer activity) | | [Identities API](https://id.demo.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.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.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. <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. ``` 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\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <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 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.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 | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent 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. Banks are created in either `Sandbox` or `Production` mode, where Sandbox is the environment that you would test, prototype and build in prior 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. 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, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.54.6
6
+ The version of the OpenAPI document: v0.54.7
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
data/spec/models/patch_organization_organization_model_spec.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
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.demo.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. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/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://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-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.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 (and all downstream customer activity) | | [Identities API](https://id.demo.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.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.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. <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. ``` 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\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <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 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.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 | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent 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. Banks are created in either `Sandbox` or `Production` mode, where Sandbox is the environment that you would test, prototype and build in prior 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. 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, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.54.6
6
+ The version of the OpenAPI document: v0.54.7
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
data/spec/spec_helper.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
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.demo.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. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/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://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-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.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 (and all downstream customer activity) | | [Identities API](https://id.demo.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.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.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. <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. ``` 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\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <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 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 (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.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 | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent 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. Banks are created in either `Sandbox` or `Production` mode, where Sandbox is the environment that you would test, prototype and build in prior 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. 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, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.54.6
6
+ The version of the OpenAPI document: v0.54.7
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out CHANGED
@@ -1,5 +1,5 @@
1
1
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug
2
- /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3964-2mh3t9.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3957-mz89o1.rb extconf.rb
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug
@@ -21,5 +21,5 @@ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platf
21
21
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug
22
22
  make DESTDIR\= install
23
23
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug'
24
- /usr/bin/install -c -m 0755 byebug.so ./.gem.20221125-3964-237lff/byebug
24
+ /usr/bin/install -c -m 0755 byebug.so ./.gem.20221125-3957-vh85l0/byebug
25
25
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug'
data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out CHANGED
@@ -1,5 +1,5 @@
1
1
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c
2
- /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3964-z5cr7k.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3957-a3wc6g.rb extconf.rb
3
3
  checking for ffi_prep_closure_loc() in -lffi... yes
4
4
  checking for ffi_prep_cif_var()... yes
5
5
  checking for ffi_raw_call()... yes
@@ -45,5 +45,5 @@ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platf
45
45
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c
46
46
  make DESTDIR\= install
47
47
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c'
48
- /usr/bin/install -c -m 0755 ffi_c.so ./.gem.20221125-3964-wfkwpx
48
+ /usr/bin/install -c -m 0755 ffi_c.so ./.gem.20221125-3957-y4bvyt
49
49
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c'
data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/jaro_winkler-1.5.4/gem_make.out CHANGED
@@ -1,5 +1,5 @@
1
1
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler
2
- /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3964-uiqt64.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3957-vrzc2b.rb extconf.rb
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler
@@ -57,5 +57,5 @@ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platf
57
57
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler
58
58
  make DESTDIR\= install
59
59
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler'
60
- /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20221125-3964-rod4qe/jaro_winkler
60
+ /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20221125-3957-uj2woh/jaro_winkler
61
61
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler'
data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.6/gem_make.out CHANGED
@@ -1,5 +1,5 @@
1
1
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.6/ext/psych
2
- /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3964-wwwh2r.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3957-z03gue.rb extconf.rb
3
3
  checking for yaml.h... yes
4
4
  checking for yaml_get_version() in -lyaml... yes
5
5
  creating Makefile
@@ -23,5 +23,5 @@ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platf
23
23
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.6/ext/psych
24
24
  make DESTDIR\= install
25
25
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.6/ext/psych'
26
- /usr/bin/install -c -m 0755 psych.so ./.gem.20221125-3964-h92zqc
26
+ /usr/bin/install -c -m 0755 psych.so ./.gem.20221125-3957-2l5qcy
27
27
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.6/ext/psych'
data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out CHANGED
@@ -1,5 +1,5 @@
1
1
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio
2
- /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3964-sgyksy.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20221125-3957-zposlm.rb extconf.rb
3
3
  checking for rb_io_extract_modeenc() in ruby/io.h... yes
4
4
  creating Makefile
5
5
 
@@ -18,5 +18,5 @@ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platf
18
18
  current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio
19
19
  make DESTDIR\= install
20
20
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio'
21
- /usr/bin/install -c -m 0755 stringio.so ./.gem.20221125-3964-kn9tif
21
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20221125-3957-8ifwwj
22
22
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio'
data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile CHANGED
@@ -32,8 +32,8 @@ rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
32
32
  vendorarchdir = $(vendorlibdir)/$(sitearch)
33
33
  vendorlibdir = $(vendordir)/$(ruby_version)
34
34
  vendordir = $(rubylibprefix)/vendor_ruby
35
- sitearchdir = $(DESTDIR)./.gem.20221125-3964-237lff
36
- sitelibdir = $(DESTDIR)./.gem.20221125-3964-237lff
35
+ sitearchdir = $(DESTDIR)./.gem.20221125-3957-vh85l0
36
+ sitelibdir = $(DESTDIR)./.gem.20221125-3957-vh85l0
37
37
  sitedir = $(rubylibprefix)/site_ruby
38
38
  rubyarchdir = $(rubylibdir)/$(arch)
39
39
  rubylibdir = $(rubylibprefix)/$(ruby_version)
data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile CHANGED
@@ -32,8 +32,8 @@ rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
32
32
  vendorarchdir = $(vendorlibdir)/$(sitearch)
33
33
  vendorlibdir = $(vendordir)/$(ruby_version)
34
34
  vendordir = $(rubylibprefix)/vendor_ruby
35
- sitearchdir = $(DESTDIR)./.gem.20221125-3964-wfkwpx
36
- sitelibdir = $(DESTDIR)./.gem.20221125-3964-wfkwpx
35
+ sitearchdir = $(DESTDIR)./.gem.20221125-3957-y4bvyt
36
+ sitelibdir = $(DESTDIR)./.gem.20221125-3957-y4bvyt
37
37
  sitedir = $(rubylibprefix)/site_ruby
38
38
  rubyarchdir = $(rubylibdir)/$(arch)
39
39
  rubylibdir = $(rubylibprefix)/$(ruby_version)
data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile CHANGED
@@ -32,8 +32,8 @@ rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
32
32
  vendorarchdir = $(vendorlibdir)/$(sitearch)
33
33
  vendorlibdir = $(vendordir)/$(ruby_version)
34
34
  vendordir = $(rubylibprefix)/vendor_ruby
35
- sitearchdir = $(DESTDIR)./.gem.20221125-3964-rod4qe
36
- sitelibdir = $(DESTDIR)./.gem.20221125-3964-rod4qe
35
+ sitearchdir = $(DESTDIR)./.gem.20221125-3957-uj2woh
36
+ sitelibdir = $(DESTDIR)./.gem.20221125-3957-uj2woh
37
37
  sitedir = $(rubylibprefix)/site_ruby
38
38
  rubyarchdir = $(rubylibdir)/$(arch)
39
39
  rubylibdir = $(rubylibprefix)/$(ruby_version)
data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/ast/processor.rb RENAMED
@@ -148,6 +148,9 @@ module Parser
148
148
  alias on_blockarg_expr process_regular_node
149
149
  alias on_block_pass process_regular_node
150
150
 
151
+ alias on_forwarded_restarg process_regular_node
152
+ alias on_forwarded_kwrestarg process_regular_node
153
+
151
154
  alias on_module process_regular_node
152
155
  alias on_class process_regular_node
153
156
  alias on_sclass process_regular_node
data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/builders/default.rb RENAMED
@@ -1078,6 +1078,14 @@ module Parser
1078
1078
  n(:forwarded_args, [], token_map(dots_t))
1079
1079
  end
1080
1080
 
1081
+ def forwarded_restarg(star_t)
1082
+ n(:forwarded_restarg, [], token_map(star_t))
1083
+ end
1084
+
1085
+ def forwarded_kwrestarg(dstar_t)
1086
+ n(:forwarded_kwrestarg, [], token_map(dstar_t))
1087
+ end
1088
+
1081
1089
  def call_method(receiver, dot_t, selector_t,
1082
1090
  lparen_t=nil, args=[], rparen_t=nil)
1083
1091
  type = call_type_for_dot(dot_t)
data/vendor/bundle/ruby/3.1.0/gems/{parser-3.1.2.1 → parser-3.1.3.0}/lib/parser/current.rb RENAMED
@@ -75,7 +75,7 @@ module Parser
75
75
  CurrentRuby = Ruby26
76
76
 
77
77
  when /^2\.7\./
78
- current_version = '2.7.6'
78
+ current_version = '2.7.7'
79
79
  if RUBY_VERSION != current_version
80
80
  warn_syntax_deviation 'parser/ruby27', current_version
81
81
  end
@@ -84,7 +84,7 @@ module Parser
84
84
  CurrentRuby = Ruby27
85
85
 
86
86
  when /^3\.0\./
87
- current_version = '3.0.4'
87
+ current_version = '3.0.5'
88
88
  if RUBY_VERSION != current_version
89
89
  warn_syntax_deviation 'parser/ruby30', current_version
90
90
  end
@@ -93,7 +93,7 @@ module Parser
93
93
  CurrentRuby = Ruby30
94
94
 
95
95
  when /^3\.1\./
96
- current_version = '3.1.2'
96
+ current_version = '3.1.3'
97
97
  if RUBY_VERSION != current_version
98
98
  warn_syntax_deviation 'parser/ruby31', current_version
99
99
  end