cybrid_api_organization_ruby 0.56.10 → 0.56.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (117) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  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-5.0.1.gem +0 -0
  22. data/vendor/bundle/ruby/3.1.0/cache/stringio-3.0.3.gem +0 -0
  23. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/byebug-11.1.3/gem_make.out +4 -4
  24. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/ffi-1.15.5/gem_make.out +4 -4
  25. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/jaro_winkler-1.5.4/gem_make.out +4 -4
  26. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/{psych-5.0.0 → psych-5.0.1}/gem.build_complete +0 -0
  27. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/{psych-5.0.0 → psych-5.0.1}/gem_make.out +14 -14
  28. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/{psych-5.0.0 → psych-5.0.1}/mkmf.log +0 -0
  29. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/{psych-5.0.0 → psych-5.0.1}/psych.so +0 -0
  30. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/{stringio-3.0.2 → stringio-3.0.3}/gem.build_complete +0 -0
  31. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/{stringio-3.0.2 → stringio-3.0.3}/gem_make.out +14 -14
  32. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/{stringio-3.0.2 → stringio-3.0.3}/mkmf.log +0 -0
  33. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/stringio-3.0.3/stringio.so +0 -0
  34. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/.gitignore +0 -0
  35. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/Gemfile +0 -0
  36. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/LICENSE +0 -0
  37. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/Mavenfile +0 -0
  38. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/README.md +6 -5
  39. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/Rakefile +0 -0
  40. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/bin/console +0 -0
  41. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/bin/setup +0 -0
  42. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/.sitearchdir.time +0 -0
  43. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/Makefile +0 -0
  44. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/depend +0 -0
  45. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/extconf.rb +0 -0
  46. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych.c +0 -0
  47. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych.h +0 -0
  48. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych.o +0 -0
  49. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych.so +0 -0
  50. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_emitter.c +0 -0
  51. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_emitter.h +0 -0
  52. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_emitter.o +0 -0
  53. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_parser.c +0 -0
  54. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_parser.h +0 -0
  55. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_parser.o +0 -0
  56. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_to_ruby.c +0 -0
  57. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_to_ruby.h +0 -0
  58. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_to_ruby.o +0 -0
  59. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_yaml_tree.c +0 -0
  60. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_yaml_tree.h +0 -0
  61. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/ext/psych/psych_yaml_tree.o +0 -0
  62. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/class_loader.rb +0 -0
  63. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/coder.rb +0 -0
  64. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/core_ext.rb +0 -0
  65. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/exception.rb +0 -0
  66. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/handler.rb +0 -0
  67. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/handlers/document_stream.rb +0 -0
  68. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/handlers/recorder.rb +0 -0
  69. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/json/ruby_events.rb +0 -0
  70. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/json/stream.rb +0 -0
  71. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/json/tree_builder.rb +0 -0
  72. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/json/yaml_events.rb +0 -0
  73. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/nodes/alias.rb +0 -0
  74. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/nodes/document.rb +0 -0
  75. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/nodes/mapping.rb +0 -0
  76. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/nodes/node.rb +0 -0
  77. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/nodes/scalar.rb +0 -0
  78. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/nodes/sequence.rb +0 -0
  79. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/nodes/stream.rb +0 -0
  80. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/nodes.rb +0 -0
  81. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/omap.rb +0 -0
  82. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/parser.rb +0 -0
  83. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/scalar_scanner.rb +0 -0
  84. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/set.rb +0 -0
  85. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/stream.rb +0 -0
  86. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/streaming.rb +0 -0
  87. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/syntax_error.rb +0 -0
  88. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/tree_builder.rb +0 -0
  89. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/versions.rb +1 -1
  90. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/visitors/depth_first.rb +0 -0
  91. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/visitors/emitter.rb +0 -0
  92. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/visitors/json_tree.rb +0 -0
  93. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/visitors/to_ruby.rb +0 -0
  94. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/visitors/visitor.rb +0 -0
  95. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/visitors/yaml_tree.rb +0 -0
  96. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/visitors.rb +0 -0
  97. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych/y.rb +0 -0
  98. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych.rb +0 -0
  99. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/lib/psych.so +0 -0
  100. data/vendor/bundle/ruby/3.1.0/gems/{psych-5.0.0 → psych-5.0.1}/psych.gemspec +0 -0
  101. data/vendor/bundle/ruby/3.1.0/gems/{stringio-3.0.2 → stringio-3.0.3}/README.md +0 -0
  102. data/vendor/bundle/ruby/3.1.0/gems/{stringio-3.0.2 → stringio-3.0.3}/ext/stringio/.sitearchdir.time +0 -0
  103. data/vendor/bundle/ruby/3.1.0/gems/{stringio-3.0.2 → stringio-3.0.3}/ext/stringio/Makefile +0 -0
  104. data/vendor/bundle/ruby/3.1.0/gems/{stringio-3.0.2 → stringio-3.0.3}/ext/stringio/extconf.rb +0 -0
  105. data/vendor/bundle/ruby/3.1.0/gems/{stringio-3.0.2 → stringio-3.0.3}/ext/stringio/stringio.c +241 -132
  106. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio/stringio.o +0 -0
  107. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio/stringio.so +0 -0
  108. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/lib/stringio.so +0 -0
  109. data/vendor/bundle/ruby/3.1.0/specifications/{psych-5.0.0.gemspec → psych-5.0.1.gemspec} +3 -3
  110. data/vendor/bundle/ruby/3.1.0/specifications/{stringio-3.0.2.gemspec → stringio-3.0.3.gemspec} +3 -3
  111. metadata +89 -89
  112. data/vendor/bundle/ruby/3.1.0/cache/psych-5.0.0.gem +0 -0
  113. data/vendor/bundle/ruby/3.1.0/cache/stringio-3.0.2.gem +0 -0
  114. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/stringio-3.0.2/stringio.so +0 -0
  115. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/stringio.o +0 -0
  116. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/stringio.so +0 -0
  117. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/lib/stringio.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-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 using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` 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, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | 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, Customer) | | 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 (e.g., funding, book) | ## 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 moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and 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.56.10
6
+ The version of the OpenAPI document: v0.56.12
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-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 using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` 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, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | 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, Customer) | | 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 (e.g., funding, book) | ## 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 moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and 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.56.10
6
+ The version of the OpenAPI document: v0.56.12
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-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 using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` 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, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | 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, Customer) | | 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 (e.g., funding, book) | ## 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 moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and 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.56.10
6
+ The version of the OpenAPI document: v0.56.12
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-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 using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` 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, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | 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, Customer) | | 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 (e.g., funding, book) | ## 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 moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and 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.56.10
6
+ The version of the OpenAPI document: v0.56.12
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-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 using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` 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, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | 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, Customer) | | 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 (e.g., funding, book) | ## 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 moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and 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.56.10
6
+ The version of the OpenAPI document: v0.56.12
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 using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` 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, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | 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, Customer) | | 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 (e.g., funding, book) | ## 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 moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and 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.56.10
6
+ The version of the OpenAPI document: v0.56.12
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/api-service-clients/api-platform-organ
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
6
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-hhyrw7 sitelibdir\=./.gem.20221207-3916-hhyrw7 clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-ruthwd sitelibdir\=./.gem.20221208-3901-ruthwd clean
7
7
  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'
8
8
  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'
9
9
 
10
10
  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
11
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-hhyrw7 sitelibdir\=./.gem.20221207-3916-hhyrw7
11
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-ruthwd sitelibdir\=./.gem.20221208-3901-ruthwd
12
12
  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'
13
13
  compiling breakpoint.c
14
14
  compiling byebug.c
@@ -39,7 +39,7 @@ linking shared-object byebug/byebug.so
39
39
  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'
40
40
 
41
41
  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
42
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-hhyrw7 sitelibdir\=./.gem.20221207-3916-hhyrw7 install
42
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-ruthwd sitelibdir\=./.gem.20221208-3901-ruthwd install
43
43
  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'
44
- /usr/bin/install -c -m 0755 byebug.so ./.gem.20221207-3916-hhyrw7/byebug
44
+ /usr/bin/install -c -m 0755 byebug.so ./.gem.20221208-3901-ruthwd/byebug
45
45
  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'
@@ -9,12 +9,12 @@ creating extconf.h
9
9
  creating Makefile
10
10
 
11
11
  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
12
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-mfyel sitelibdir\=./.gem.20221207-3916-mfyel clean
12
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-90yv22 sitelibdir\=./.gem.20221208-3901-90yv22 clean
13
13
  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'
14
14
  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'
15
15
 
16
16
  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
17
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-mfyel sitelibdir\=./.gem.20221207-3916-mfyel
17
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-90yv22 sitelibdir\=./.gem.20221208-3901-90yv22
18
18
  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'
19
19
  compiling AbstractMemory.c
20
20
  compiling ArrayType.c
@@ -43,7 +43,7 @@ linking shared-object ffi_c.so
43
43
  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'
44
44
 
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
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-mfyel sitelibdir\=./.gem.20221207-3916-mfyel install
46
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-90yv22 sitelibdir\=./.gem.20221208-3901-90yv22 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.20221207-3916-mfyel
48
+ /usr/bin/install -c -m 0755 ffi_c.so ./.gem.20221208-3901-90yv22
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'
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/api-service-clients/api-platform-organ
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
6
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-p8b7q3 sitelibdir\=./.gem.20221207-3916-p8b7q3 clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-zu4ky4 sitelibdir\=./.gem.20221208-3901-zu4ky4 clean
7
7
  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'
8
8
  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'
9
9
 
10
10
  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
11
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-p8b7q3 sitelibdir\=./.gem.20221207-3916-p8b7q3
11
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-zu4ky4 sitelibdir\=./.gem.20221208-3901-zu4ky4
12
12
  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'
13
13
  compiling adj_matrix.c
14
14
  adj_matrix.c: In function ‘adj_matrix_default’:
@@ -63,7 +63,7 @@ linking shared-object jaro_winkler/jaro_winkler_ext.so
63
63
  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'
64
64
 
65
65
  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
66
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-p8b7q3 sitelibdir\=./.gem.20221207-3916-p8b7q3 install
66
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-zu4ky4 sitelibdir\=./.gem.20221208-3901-zu4ky4 install
67
67
  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'
68
- /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20221207-3916-p8b7q3/jaro_winkler
68
+ /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20221208-3901-zu4ky4/jaro_winkler
69
69
  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,30 +1,30 @@
1
- current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych
1
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych
2
2
  /usr/local/bin/ruby -I /usr/local/lib/ruby/3.1.0 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-5.0.0/ext/psych
8
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-hvv91g sitelibdir\=./.gem.20221207-3916-hvv91g clean
9
- make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych'
7
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych
8
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-de3h2v sitelibdir\=./.gem.20221208-3901-de3h2v clean
9
+ make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
10
10
  cd libyaml && make clean
11
11
  /bin/sh: 1: cd: can't cd to libyaml
12
12
  make[1]: [Makefile:282: clean-so] Error 2 (ignored)
13
- make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych'
13
+ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
14
14
 
15
- current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych
16
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-hvv91g sitelibdir\=./.gem.20221207-3916-hvv91g
17
- make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych'
15
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych
16
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-de3h2v sitelibdir\=./.gem.20221208-3901-de3h2v
17
+ make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
18
18
  compiling psych.c
19
19
  compiling psych_emitter.c
20
20
  compiling psych_parser.c
21
21
  compiling psych_to_ruby.c
22
22
  compiling psych_yaml_tree.c
23
23
  linking shared-object psych.so
24
- make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych'
24
+ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
25
25
 
26
- current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych
27
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-hvv91g sitelibdir\=./.gem.20221207-3916-hvv91g install
28
- make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych'
29
- /usr/bin/install -c -m 0755 psych.so ./.gem.20221207-3916-hvv91g
30
- make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.0/ext/psych'
26
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych
27
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-de3h2v sitelibdir\=./.gem.20221208-3901-de3h2v install
28
+ make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
29
+ /usr/bin/install -c -m 0755 psych.so ./.gem.20221208-3901-de3h2v
30
+ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
@@ -1,22 +1,22 @@
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
1
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio
2
2
  /usr/local/bin/ruby -I /usr/local/lib/ruby/3.1.0 extconf.rb
3
3
  checking for rb_io_extract_modeenc() in ruby/io.h... yes
4
4
  creating Makefile
5
5
 
6
- 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
7
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-cutogm sitelibdir\=./.gem.20221207-3916-cutogm clean
8
- 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'
9
- 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'
6
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio
7
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-tsk58u sitelibdir\=./.gem.20221208-3901-tsk58u clean
8
+ make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio'
9
+ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio'
10
10
 
11
- 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
12
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-cutogm sitelibdir\=./.gem.20221207-3916-cutogm
13
- 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'
11
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio
12
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-tsk58u sitelibdir\=./.gem.20221208-3901-tsk58u
13
+ make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio'
14
14
  compiling stringio.c
15
15
  linking shared-object stringio.so
16
- 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'
16
+ make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio'
17
17
 
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
- make DESTDIR\= sitearchdir\=./.gem.20221207-3916-cutogm sitelibdir\=./.gem.20221207-3916-cutogm install
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.20221207-3916-cutogm
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'
18
+ current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.3/ext/stringio
19
+ make DESTDIR\= sitearchdir\=./.gem.20221208-3901-tsk58u sitelibdir\=./.gem.20221208-3901-tsk58u install
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.3/ext/stringio'
21
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20221208-3901-tsk58u
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.3/ext/stringio'
@@ -1,6 +1,7 @@
1
1
  # Psych
2
2
 
3
3
  * https://github.com/ruby/psych
4
+ * https://docs.ruby-lang.org/en/master/Psych.html
4
5
 
5
6
  ## Description
6
7
 
@@ -32,6 +33,11 @@ If you want a newer gem release of Psych, you can use rubygems:
32
33
 
33
34
  gem install psych
34
35
 
36
+
37
+ Psych supported the static build with specific version of libyaml sources. You can build psych with libyaml-0.2.5 like this.
38
+
39
+ gem install psych -- --with-libyaml-source-dir=/path/to/libyaml-0.2.5
40
+
35
41
  In order to use the gem release in your app, and not the stdlib version,
36
42
  you'll need the following:
37
43
 
@@ -44,11 +50,6 @@ Or if you use Bundler add this to your `Gemfile`:
44
50
 
45
51
  JRuby ships with a pure Java implementation of Psych.
46
52
 
47
- If you're on Rubinius, Psych is available in 1.9 mode, please refer to the
48
- Language Modes section of the [Rubinius
49
- README](https://github.com/rubinius/rubinius#readme) for more information on
50
- building and 1.9 mode.
51
-
52
53
  ## License
53
54
 
54
55
  Copyright 2009 Aaron Patterson, et al.