cybrid_api_organization_ruby 0.37.32 → 0.37.35

Sign up to get free protection for your applications and to get access to all the features.
Files changed (121) 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/psych-4.0.5.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.4 → psych-4.0.5}/gem.build_complete +0 -0
  26. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/{psych-4.0.4 → psych-4.0.5}/gem_make.out +12 -12
  27. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/{psych-4.0.4 → psych-4.0.5}/mkmf.log +0 -0
  28. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.5/psych.so +0 -0
  29. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out +2 -2
  30. data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  31. data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  32. data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  33. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/.gitignore +0 -0
  34. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/Gemfile +0 -0
  35. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/LICENSE +0 -0
  36. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/Mavenfile +0 -0
  37. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/README.md +0 -0
  38. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/Rakefile +0 -0
  39. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/bin/console +0 -0
  40. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/bin/setup +0 -0
  41. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/.sitearchdir.time +0 -0
  42. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/Makefile +2 -2
  43. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/depend +0 -0
  44. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/extconf.rb +0 -0
  45. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych.c +0 -0
  46. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych.h +0 -0
  47. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych/psych.o +0 -0
  48. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych/psych.so +0 -0
  49. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_emitter.c +0 -0
  50. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_emitter.h +0 -0
  51. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_emitter.o +0 -0
  52. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_parser.c +0 -0
  53. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_parser.h +0 -0
  54. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_parser.o +0 -0
  55. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_to_ruby.c +0 -0
  56. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_to_ruby.h +0 -0
  57. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych/psych_to_ruby.o +0 -0
  58. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_yaml_tree.c +0 -0
  59. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/psych_yaml_tree.h +0 -0
  60. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych/psych_yaml_tree.o +0 -0
  61. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/LICENSE +0 -0
  62. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/api.c +0 -0
  63. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/config.h +0 -0
  64. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/dumper.c +0 -0
  65. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/emitter.c +0 -0
  66. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/loader.c +0 -0
  67. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/parser.c +0 -0
  68. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/reader.c +0 -0
  69. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/scanner.c +0 -0
  70. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/writer.c +0 -0
  71. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/yaml.h +0 -0
  72. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/ext/psych/yaml/yaml_private.h +0 -0
  73. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/class_loader.rb +0 -0
  74. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/coder.rb +0 -0
  75. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/core_ext.rb +0 -0
  76. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/exception.rb +0 -0
  77. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/handler.rb +0 -0
  78. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/handlers/document_stream.rb +0 -0
  79. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/handlers/recorder.rb +0 -0
  80. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/json/ruby_events.rb +0 -0
  81. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/json/stream.rb +0 -0
  82. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/json/tree_builder.rb +0 -0
  83. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/json/yaml_events.rb +0 -0
  84. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/nodes/alias.rb +0 -0
  85. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/nodes/document.rb +0 -0
  86. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/nodes/mapping.rb +0 -0
  87. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/nodes/node.rb +0 -0
  88. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/nodes/scalar.rb +0 -0
  89. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/nodes/sequence.rb +0 -0
  90. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/nodes/stream.rb +0 -0
  91. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/nodes.rb +0 -0
  92. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/omap.rb +0 -0
  93. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/parser.rb +0 -0
  94. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/scalar_scanner.rb +1 -1
  95. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/set.rb +0 -0
  96. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/stream.rb +0 -0
  97. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/streaming.rb +0 -0
  98. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/syntax_error.rb +0 -0
  99. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/tree_builder.rb +0 -0
  100. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/versions.rb +2 -2
  101. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/visitors/depth_first.rb +0 -0
  102. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/visitors/emitter.rb +0 -0
  103. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/visitors/json_tree.rb +0 -0
  104. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/visitors/to_ruby.rb +3 -1
  105. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/visitors/visitor.rb +0 -0
  106. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/visitors/yaml_tree.rb +8 -8
  107. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/visitors.rb +0 -0
  108. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych/y.rb +0 -0
  109. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/lib/psych.rb +0 -0
  110. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/lib/psych.so +0 -0
  111. data/vendor/bundle/ruby/3.1.0/gems/{psych-4.0.4 → psych-4.0.5}/psych.gemspec +0 -0
  112. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  113. data/vendor/bundle/ruby/3.1.0/specifications/{psych-4.0.4.gemspec → psych-4.0.5.gemspec} +3 -3
  114. metadata +87 -87
  115. data/vendor/bundle/ruby/3.1.0/cache/psych-4.0.4.gem +0 -0
  116. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.4/psych.so +0 -0
  117. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych/psych.o +0 -0
  118. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych/psych.so +0 -0
  119. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych/psych_to_ruby.o +0 -0
  120. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych/psych_yaml_tree.o +0 -0
  121. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/lib/psych.so +0 -0
@@ -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-lable 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 API's. If you'd like to use a different tool to exercise our API's, 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 API's 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), Apple-coming soon) 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 API's 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). An `Organization` Token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` Token is specific to an individual Bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. <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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | | Rewards | rewards:read | | rewards:execute | Bank | ## Available Endpoints The available API's 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 Sevice | Model | API Endpoint Path | Description | | ------------ | ---------------- | ------------------------------ | ------------------------------------------------------------------------- | | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Organization | Organization | /api/organizations | API's 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) | ## 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.37.32
6
+ The version of the OpenAPI document: v0.37.35
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-lable 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 API's. If you'd like to use a different tool to exercise our API's, 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 API's 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), Apple-coming soon) 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 API's 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). An `Organization` Token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` Token is specific to an individual Bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. <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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | | Rewards | rewards:read | | rewards:execute | Bank | ## Available Endpoints The available API's 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 Sevice | Model | API Endpoint Path | Description | | ------------ | ---------------- | ------------------------------ | ------------------------------------------------------------------------- | | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Organization | Organization | /api/organizations | API's 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) | ## 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.37.32
6
+ The version of the OpenAPI document: v0.37.35
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-lable 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 API's. If you'd like to use a different tool to exercise our API's, 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 API's 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), Apple-coming soon) 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 API's 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). An `Organization` Token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` Token is specific to an individual Bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. <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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | | Rewards | rewards:read | | rewards:execute | Bank | ## Available Endpoints The available API's 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 Sevice | Model | API Endpoint Path | Description | | ------------ | ---------------- | ------------------------------ | ------------------------------------------------------------------------- | | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Organization | Organization | /api/organizations | API's 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) | ## 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.37.32
6
+ The version of the OpenAPI document: v0.37.35
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-lable 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 API's. If you'd like to use a different tool to exercise our API's, 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 API's 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), Apple-coming soon) 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 API's 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). An `Organization` Token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` Token is specific to an individual Bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. <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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | | Rewards | rewards:read | | rewards:execute | Bank | ## Available Endpoints The available API's 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 Sevice | Model | API Endpoint Path | Description | | ------------ | ---------------- | ------------------------------ | ------------------------------------------------------------------------- | | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Organization | Organization | /api/organizations | API's 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) | ## 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.37.32
6
+ The version of the OpenAPI document: v0.37.35
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -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 ./siteconf20220906-3430-kl9qrk.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20220907-3427-r5tqlf.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.20220906-3430-74j9ax/byebug
24
+ /usr/bin/install -c -m 0755 byebug.so ./.gem.20220907-3427-e82ud/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'
@@ -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 ./siteconf20220906-3430-kzehin.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20220907-3427-3lzo5c.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.20220906-3430-s724qr
48
+ /usr/bin/install -c -m 0755 ffi_c.so ./.gem.20220907-3427-p6pmgn
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'
@@ -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 ./siteconf20220906-3430-2id5gu.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20220907-3427-8bi7jc.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.20220906-3430-c1tk77/jaro_winkler
60
+ /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20220907-3427-ufliqd/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'
@@ -1,27 +1,27 @@
1
- current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych
2
- /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20220906-3430-cnokcg.rb extconf.rb
1
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20220907-3427-sln3di.rb extconf.rb
3
3
  checking for yaml.h... yes
4
4
  checking for yaml_get_version() in -lyaml... yes
5
5
  creating Makefile
6
6
 
7
- current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych
7
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych
8
8
  make DESTDIR\= clean
9
- make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych'
10
- make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych'
9
+ make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych'
10
+ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych'
11
11
 
12
- current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych
12
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych
13
13
  make DESTDIR\=
14
- make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych'
14
+ make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych'
15
15
  compiling psych.c
16
16
  compiling psych_emitter.c
17
17
  compiling psych_parser.c
18
18
  compiling psych_to_ruby.c
19
19
  compiling psych_yaml_tree.c
20
20
  linking shared-object psych.so
21
- make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych'
21
+ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych'
22
22
 
23
- current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych
23
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-4.0.5/ext/psych
24
24
  make DESTDIR\= install
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.4/ext/psych'
26
- /usr/bin/install -c -m 0755 psych.so ./.gem.20220906-3430-3mawop
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.4/ext/psych'
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.5/ext/psych'
26
+ /usr/bin/install -c -m 0755 psych.so ./.gem.20220907-3427-rha8on
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.5/ext/psych'
@@ -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 ./siteconf20220906-3430-aexmr3.rb extconf.rb
2
+ /usr/local/bin/ruby -I /usr/local/lib/ruby/site_ruby/3.1.0 -r ./siteconf20220907-3427-cy3alf.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.20220906-3430-5o0jmy
21
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20220907-3427-xk3c5p
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'
@@ -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.20220906-3430-74j9ax
36
- sitelibdir = $(DESTDIR)./.gem.20220906-3430-74j9ax
35
+ sitearchdir = $(DESTDIR)./.gem.20220907-3427-e82ud
36
+ sitelibdir = $(DESTDIR)./.gem.20220907-3427-e82ud
37
37
  sitedir = $(rubylibprefix)/site_ruby
38
38
  rubyarchdir = $(rubylibdir)/$(arch)
39
39
  rubylibdir = $(rubylibprefix)/$(ruby_version)
@@ -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.20220906-3430-s724qr
36
- sitelibdir = $(DESTDIR)./.gem.20220906-3430-s724qr
35
+ sitearchdir = $(DESTDIR)./.gem.20220907-3427-p6pmgn
36
+ sitelibdir = $(DESTDIR)./.gem.20220907-3427-p6pmgn
37
37
  sitedir = $(rubylibprefix)/site_ruby
38
38
  rubyarchdir = $(rubylibdir)/$(arch)
39
39
  rubylibdir = $(rubylibprefix)/$(ruby_version)
@@ -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.20220906-3430-c1tk77
36
- sitelibdir = $(DESTDIR)./.gem.20220906-3430-c1tk77
35
+ sitearchdir = $(DESTDIR)./.gem.20220907-3427-ufliqd
36
+ sitelibdir = $(DESTDIR)./.gem.20220907-3427-ufliqd
37
37
  sitedir = $(rubylibprefix)/site_ruby
38
38
  rubyarchdir = $(rubylibdir)/$(arch)
39
39
  rubylibdir = $(rubylibprefix)/$(ruby_version)
@@ -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.20220906-3430-3mawop
36
- sitelibdir = $(DESTDIR)./.gem.20220906-3430-3mawop
35
+ sitearchdir = $(DESTDIR)./.gem.20220907-3427-rha8on
36
+ sitelibdir = $(DESTDIR)./.gem.20220907-3427-rha8on
37
37
  sitedir = $(rubylibprefix)/site_ruby
38
38
  rubyarchdir = $(rubylibdir)/$(arch)
39
39
  rubylibdir = $(rubylibprefix)/$(ruby_version)
@@ -63,7 +63,7 @@ module Psych
63
63
  elsif string.match?(/^\d{4}-(?:1[012]|0\d|\d)-(?:[12]\d|3[01]|0\d|\d)$/)
64
64
  require 'date'
65
65
  begin
66
- class_loader.date.strptime(string, '%Y-%m-%d')
66
+ class_loader.date.strptime(string, '%F', Date::GREGORIAN)
67
67
  rescue ArgumentError
68
68
  string
69
69
  end
@@ -2,9 +2,9 @@
2
2
 
3
3
  module Psych
4
4
  # The version of Psych you are using
5
- VERSION = '4.0.4'
5
+ VERSION = '4.0.5'
6
6
 
7
7
  if RUBY_ENGINE == 'jruby'
8
- DEFAULT_SNAKEYAML_VERSION = '1.28'.freeze
8
+ DEFAULT_SNAKEYAML_VERSION = '1.31'.freeze
9
9
  end
10
10
  end
@@ -80,7 +80,9 @@ module Psych
80
80
  when "!ruby/object:DateTime"
81
81
  class_loader.date_time
82
82
  require 'date' unless defined? DateTime
83
- @ss.parse_time(o.value).to_datetime
83
+ t = @ss.parse_time(o.value)
84
+ DateTime.civil(*t.to_a[0, 6].reverse, Rational(t.utc_offset, 86400)) +
85
+ (t.subsec/86400)
84
86
  when '!ruby/encoding'
85
87
  ::Encoding.find o.value
86
88
  when "!ruby/object:Complex"
@@ -192,12 +192,13 @@ module Psych
192
192
  register o, @emitter.scalar(o.inspect, nil, '!ruby/regexp', false, false, Nodes::Scalar::ANY)
193
193
  end
194
194
 
195
+ def visit_Date o
196
+ register o, visit_Integer(o.gregorian)
197
+ end
198
+
195
199
  def visit_DateTime o
196
- formatted = if o.offset.zero?
197
- o.strftime("%Y-%m-%d %H:%M:%S.%9N Z".freeze)
198
- else
199
- o.strftime("%Y-%m-%d %H:%M:%S.%9N %:z".freeze)
200
- end
200
+ t = o.italy
201
+ formatted = format_time t, t.offset.zero?
201
202
  tag = '!ruby/object:DateTime'
202
203
  register o, @emitter.scalar(formatted, nil, tag, false, false, Nodes::Scalar::ANY)
203
204
  end
@@ -235,7 +236,6 @@ module Psych
235
236
  end
236
237
  alias :visit_TrueClass :visit_Integer
237
238
  alias :visit_FalseClass :visit_Integer
238
- alias :visit_Date :visit_Integer
239
239
 
240
240
  def visit_Float o
241
241
  if o.nan?
@@ -482,8 +482,8 @@ module Psych
482
482
  @emitter.end_mapping
483
483
  end
484
484
 
485
- def format_time time
486
- if time.utc?
485
+ def format_time time, utc = time.utc?
486
+ if utc
487
487
  time.strftime("%Y-%m-%d %H:%M:%S.%9N Z")
488
488
  else
489
489
  time.strftime("%Y-%m-%d %H:%M:%S.%9N %:z")