cybrid_api_id_ruby 0.129.899 → 0.129.1022

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +4 -4
  3. data/README.md +5 -5
  4. data/cybrid_api_id_ruby.gemspec +1 -1
  5. data/lib/cybrid_api_id_ruby/api/bank_applications_idp_api.rb +1 -1
  6. data/lib/cybrid_api_id_ruby/api/customer_tokens_idp_api.rb +1 -1
  7. data/lib/cybrid_api_id_ruby/api/organization_applications_idp_api.rb +1 -1
  8. data/lib/cybrid_api_id_ruby/api/users_idp_api.rb +1 -1
  9. data/lib/cybrid_api_id_ruby/api_client.rb +1 -1
  10. data/lib/cybrid_api_id_ruby/api_error.rb +1 -1
  11. data/lib/cybrid_api_id_ruby/configuration.rb +1 -1
  12. data/lib/cybrid_api_id_ruby/models/application_idp_model.rb +1 -1
  13. data/lib/cybrid_api_id_ruby/models/application_list_idp_model.rb +1 -1
  14. data/lib/cybrid_api_id_ruby/models/application_with_secret_all_of_idp_model.rb +1 -1
  15. data/lib/cybrid_api_id_ruby/models/application_with_secret_idp_model.rb +1 -1
  16. data/lib/cybrid_api_id_ruby/models/customer_token_idp_model.rb +1 -1
  17. data/lib/cybrid_api_id_ruby/models/error_response_idp_model.rb +1 -1
  18. data/lib/cybrid_api_id_ruby/models/patch_application_idp_model.rb +1 -1
  19. data/lib/cybrid_api_id_ruby/models/patch_user_idp_model.rb +1 -1
  20. data/lib/cybrid_api_id_ruby/models/post_bank_application_idp_model.rb +1 -1
  21. data/lib/cybrid_api_id_ruby/models/post_customer_token_idp_model.rb +1 -1
  22. data/lib/cybrid_api_id_ruby/models/post_organization_application_idp_model.rb +1 -1
  23. data/lib/cybrid_api_id_ruby/models/post_user_idp_model.rb +1 -1
  24. data/lib/cybrid_api_id_ruby/models/user_idp_model.rb +1 -1
  25. data/lib/cybrid_api_id_ruby/models/user_list_idp_model.rb +1 -1
  26. data/lib/cybrid_api_id_ruby/version.rb +2 -2
  27. data/lib/cybrid_api_id_ruby.rb +1 -1
  28. data/spec/api/bank_applications_idp_api_spec.rb +1 -1
  29. data/spec/api/customer_tokens_idp_api_spec.rb +1 -1
  30. data/spec/api/organization_applications_idp_api_spec.rb +1 -1
  31. data/spec/api/users_idp_api_spec.rb +1 -1
  32. data/spec/api_client_spec.rb +1 -1
  33. data/spec/configuration_spec.rb +1 -1
  34. data/spec/models/application_idp_model_spec.rb +1 -1
  35. data/spec/models/application_list_idp_model_spec.rb +1 -1
  36. data/spec/models/application_with_secret_all_of_idp_model_spec.rb +1 -1
  37. data/spec/models/application_with_secret_idp_model_spec.rb +1 -1
  38. data/spec/models/customer_token_idp_model_spec.rb +1 -1
  39. data/spec/models/error_response_idp_model_spec.rb +1 -1
  40. data/spec/models/patch_application_idp_model_spec.rb +1 -1
  41. data/spec/models/patch_user_idp_model_spec.rb +1 -1
  42. data/spec/models/post_bank_application_idp_model_spec.rb +1 -1
  43. data/spec/models/post_customer_token_idp_model_spec.rb +1 -1
  44. data/spec/models/post_organization_application_idp_model_spec.rb +1 -1
  45. data/spec/models/post_user_idp_model_spec.rb +1 -1
  46. data/spec/models/user_idp_model_spec.rb +1 -1
  47. data/spec/models/user_list_idp_model_spec.rb +1 -1
  48. data/spec/spec_helper.rb +1 -1
  49. data/vendor/bundle/ruby/4.0.0/cache/psych-5.5.0.gem +0 -0
  50. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/byebug-13.0.0/gem_make.out +5 -5
  51. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/date-3.5.1/gem_make.out +5 -5
  52. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/io-console-0.9.2/gem_make.out +5 -5
  53. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  54. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/{psych-5.4.0 → psych-5.5.0}/gem_make.out +18 -18
  55. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/psych-5.5.0/psych.so +0 -0
  56. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/racc-1.8.1/gem_make.out +5 -5
  57. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/stringio-3.2.0/gem_make.out +5 -5
  58. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/README.md +53 -0
  59. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/extconf.rb +22 -0
  60. data/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych/psych.c +68 -0
  61. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych.h +4 -0
  62. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_emitter.c +4 -0
  63. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_parser.c +79 -18
  64. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/class_loader.rb +1 -0
  65. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/parser.rb +40 -1
  66. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/scalar_scanner.rb +15 -3
  67. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/versions.rb +1 -1
  68. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/to_ruby.rb +20 -9
  69. data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/yaml_tree.rb +0 -3
  70. data/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/lib/psych.so +0 -0
  71. data/vendor/bundle/ruby/4.0.0/specifications/{psych-5.4.0.gemspec → psych-5.5.0.gemspec} +2 -2
  72. metadata +61 -61
  73. data/vendor/bundle/ruby/4.0.0/cache/psych-5.4.0.gem +0 -0
  74. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/psych-5.4.0/psych.so +0 -0
  75. data/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych/psych.c +0 -36
  76. data/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/lib/psych.so +0 -0
  77. /data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/{psych-5.4.0 → psych-5.5.0}/gem.build_complete +0 -0
  78. /data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/{psych-5.4.0 → psych-5.5.0}/mkmf.log +0 -0
  79. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/CONTRIBUTING.md +0 -0
  80. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/LICENSE +0 -0
  81. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/Makefile +0 -0
  82. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/depend +0 -0
  83. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_emitter.h +0 -0
  84. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_parser.h +0 -0
  85. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_to_ruby.c +0 -0
  86. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_to_ruby.h +0 -0
  87. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_yaml_tree.c +0 -0
  88. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/ext/psych/psych_yaml_tree.h +0 -0
  89. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/coder.rb +0 -0
  90. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/core_ext.rb +0 -0
  91. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/exception.rb +0 -0
  92. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/handler.rb +0 -0
  93. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/handlers/document_stream.rb +0 -0
  94. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/handlers/recorder.rb +0 -0
  95. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/json/ruby_events.rb +0 -0
  96. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/json/stream.rb +0 -0
  97. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/json/tree_builder.rb +0 -0
  98. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/json/yaml_events.rb +0 -0
  99. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/alias.rb +0 -0
  100. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/document.rb +0 -0
  101. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/mapping.rb +0 -0
  102. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/node.rb +0 -0
  103. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/scalar.rb +0 -0
  104. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/sequence.rb +0 -0
  105. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes/stream.rb +0 -0
  106. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/nodes.rb +0 -0
  107. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/omap.rb +0 -0
  108. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/set.rb +0 -0
  109. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/stream.rb +0 -0
  110. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/streaming.rb +0 -0
  111. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/syntax_error.rb +0 -0
  112. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/tree_builder.rb +0 -0
  113. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/depth_first.rb +0 -0
  114. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/emitter.rb +0 -0
  115. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/json_tree.rb +0 -0
  116. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors/visitor.rb +0 -0
  117. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/visitors.rb +0 -0
  118. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych/y.rb +0 -0
  119. /data/vendor/bundle/ruby/4.0.0/gems/{psych-5.4.0 → psych-5.5.0}/lib/psych.rb +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.production.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.129.899
6
+ The version of the OpenAPI document: v0.129.1022
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.production.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.129.899
6
+ The version of the OpenAPI document: v0.129.1022
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.production.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.129.899
6
+ The version of the OpenAPI document: v0.129.1022
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/build/public-clients/api-idp/ruby/vend
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug
6
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-iftep2 sitelibdir\=./.gem.20260818-3631-iftep2 clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-w0j50t sitelibdir\=./.gem.20260904-3650-w0j50t clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug
11
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-iftep2 sitelibdir\=./.gem.20260818-3631-iftep2
11
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-w0j50t sitelibdir\=./.gem.20260904-3650-w0j50t
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
13
13
  compiling breakpoint.c
14
14
  compiling byebug.c
@@ -39,12 +39,12 @@ linking shared-object byebug/byebug.so
39
39
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
40
40
 
41
41
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug
42
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-iftep2 sitelibdir\=./.gem.20260818-3631-iftep2 install
42
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-w0j50t sitelibdir\=./.gem.20260904-3650-w0j50t install
43
43
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
44
- /usr/bin/install -c -m 0755 byebug.so ./.gem.20260818-3631-iftep2/byebug
44
+ /usr/bin/install -c -m 0755 byebug.so ./.gem.20260904-3650-w0j50t/byebug
45
45
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
46
46
 
47
47
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug
48
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-iftep2 sitelibdir\=./.gem.20260818-3631-iftep2 clean
48
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-w0j50t sitelibdir\=./.gem.20260904-3650-w0j50t clean
49
49
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
50
50
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
@@ -6,12 +6,12 @@ checking for altzone in time.h with -Werror... no
6
6
  creating Makefile
7
7
 
8
8
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date
9
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-k2bw7i sitelibdir\=./.gem.20260818-3631-k2bw7i clean
9
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-x2xq7n sitelibdir\=./.gem.20260904-3650-x2xq7n clean
10
10
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
11
11
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
12
12
 
13
13
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date
14
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-k2bw7i sitelibdir\=./.gem.20260818-3631-k2bw7i
14
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-x2xq7n sitelibdir\=./.gem.20260904-3650-x2xq7n
15
15
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
16
16
  compiling date_core.c
17
17
  compiling date_parse.c
@@ -21,12 +21,12 @@ linking shared-object date_core.so
21
21
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
22
22
 
23
23
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date
24
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-k2bw7i sitelibdir\=./.gem.20260818-3631-k2bw7i install
24
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-x2xq7n sitelibdir\=./.gem.20260904-3650-x2xq7n install
25
25
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
26
- /usr/bin/install -c -m 0755 date_core.so ./.gem.20260818-3631-k2bw7i
26
+ /usr/bin/install -c -m 0755 date_core.so ./.gem.20260904-3650-x2xq7n
27
27
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
28
28
 
29
29
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date
30
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-k2bw7i sitelibdir\=./.gem.20260818-3631-k2bw7i clean
30
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-x2xq7n sitelibdir\=./.gem.20260904-3650-x2xq7n clean
31
31
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
32
32
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
@@ -17,24 +17,24 @@ checking for rb_prepend_module()... yes
17
17
  creating Makefile
18
18
 
19
19
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console
20
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-ng5be sitelibdir\=./.gem.20260818-3631-ng5be clean
20
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-n1xgfj sitelibdir\=./.gem.20260904-3650-n1xgfj clean
21
21
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console'
22
22
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console'
23
23
 
24
24
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console
25
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-ng5be sitelibdir\=./.gem.20260818-3631-ng5be
25
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-n1xgfj sitelibdir\=./.gem.20260904-3650-n1xgfj
26
26
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console'
27
27
  compiling console.c
28
28
  linking shared-object io/console.so
29
29
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console'
30
30
 
31
31
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console
32
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-ng5be sitelibdir\=./.gem.20260818-3631-ng5be install
32
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-n1xgfj sitelibdir\=./.gem.20260904-3650-n1xgfj install
33
33
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console'
34
- /usr/bin/install -c -m 0755 console.so ./.gem.20260818-3631-ng5be/io
34
+ /usr/bin/install -c -m 0755 console.so ./.gem.20260904-3650-n1xgfj/io
35
35
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console'
36
36
 
37
37
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console
38
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-ng5be sitelibdir\=./.gem.20260818-3631-ng5be clean
38
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-n1xgfj sitelibdir\=./.gem.20260904-3650-n1xgfj clean
39
39
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console'
40
40
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.9.2/ext/io/console'
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vend
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
6
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-9mkhn3 sitelibdir\=./.gem.20260818-3631-9mkhn3 clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-hele33 sitelibdir\=./.gem.20260904-3650-hele33 clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
11
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-9mkhn3 sitelibdir\=./.gem.20260818-3631-9mkhn3
11
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-hele33 sitelibdir\=./.gem.20260904-3650-hele33
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
13
13
  compiling adj_matrix.c
14
14
  adj_matrix.c: In function ‘adj_matrix_default’:
@@ -26,12 +26,12 @@ linking shared-object jaro_winkler/jaro_winkler_ext.so
26
26
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
27
27
 
28
28
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
29
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-9mkhn3 sitelibdir\=./.gem.20260818-3631-9mkhn3 install
29
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-hele33 sitelibdir\=./.gem.20260904-3650-hele33 install
30
30
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
31
- /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20260818-3631-9mkhn3/jaro_winkler
31
+ /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20260904-3650-hele33/jaro_winkler
32
32
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
33
33
 
34
34
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
35
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-9mkhn3 sitelibdir\=./.gem.20260818-3631-9mkhn3 clean
35
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-hele33 sitelibdir\=./.gem.20260904-3650-hele33 clean
36
36
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
37
37
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
@@ -1,37 +1,37 @@
1
- current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
1
+ current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych
2
2
  /usr/local/bin/ruby extconf.rb
3
3
  checking for pkg-config for yaml-0.1... [" ", "", "-lyaml"]
4
4
  creating Makefile
5
5
 
6
- current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
7
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-z409dk sitelibdir\=./.gem.20260818-3631-z409dk clean
8
- make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
6
+ current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych
7
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-418ehv sitelibdir\=./.gem.20260904-3650-418ehv clean
8
+ make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych'
9
9
  cd libyaml && make clean
10
10
  /bin/sh: 1: cd: can't cd to libyaml
11
11
  make[1]: [Makefile:287: clean-so] Error 2 (ignored)
12
- make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
12
+ make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych'
13
13
 
14
- current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
15
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-z409dk sitelibdir\=./.gem.20260818-3631-z409dk
16
- make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
14
+ current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych
15
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-418ehv sitelibdir\=./.gem.20260904-3650-418ehv
16
+ make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych'
17
17
  compiling psych.c
18
18
  compiling psych_emitter.c
19
19
  compiling psych_parser.c
20
20
  compiling psych_to_ruby.c
21
21
  compiling psych_yaml_tree.c
22
22
  linking shared-object psych.so
23
- make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
23
+ make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych'
24
24
 
25
- current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
26
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-z409dk sitelibdir\=./.gem.20260818-3631-z409dk install
27
- make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
28
- /usr/bin/install -c -m 0755 psych.so ./.gem.20260818-3631-z409dk
29
- make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
25
+ current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych
26
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-418ehv sitelibdir\=./.gem.20260904-3650-418ehv install
27
+ make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych'
28
+ /usr/bin/install -c -m 0755 psych.so ./.gem.20260904-3650-418ehv
29
+ make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych'
30
30
 
31
- current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
32
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-z409dk sitelibdir\=./.gem.20260818-3631-z409dk clean
33
- make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
31
+ current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych
32
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-418ehv sitelibdir\=./.gem.20260904-3650-418ehv clean
33
+ make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych'
34
34
  cd libyaml && make clean
35
35
  /bin/sh: 1: cd: can't cd to libyaml
36
36
  make[1]: [Makefile:287: clean-so] Error 2 (ignored)
37
- make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
37
+ make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.5.0/ext/psych'
@@ -3,24 +3,24 @@ current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vend
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse
6
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-32ysot sitelibdir\=./.gem.20260818-3631-32ysot clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-8ck3op sitelibdir\=./.gem.20260904-3650-8ck3op clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse
11
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-32ysot sitelibdir\=./.gem.20260818-3631-32ysot
11
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-8ck3op sitelibdir\=./.gem.20260904-3650-8ck3op
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
13
13
  compiling cparse.c
14
14
  linking shared-object racc/cparse.so
15
15
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
16
16
 
17
17
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse
18
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-32ysot sitelibdir\=./.gem.20260818-3631-32ysot install
18
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-8ck3op sitelibdir\=./.gem.20260904-3650-8ck3op install
19
19
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
20
- /usr/bin/install -c -m 0755 cparse.so ./.gem.20260818-3631-32ysot/racc
20
+ /usr/bin/install -c -m 0755 cparse.so ./.gem.20260904-3650-8ck3op/racc
21
21
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
22
22
 
23
23
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse
24
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-32ysot sitelibdir\=./.gem.20260818-3631-32ysot clean
24
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-8ck3op sitelibdir\=./.gem.20260904-3650-8ck3op clean
25
25
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
26
26
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
@@ -4,24 +4,24 @@ checking for rb_io_mode_t in ruby/io.h... yes
4
4
  creating Makefile
5
5
 
6
6
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio
7
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-segne8 sitelibdir\=./.gem.20260818-3631-segne8 clean
7
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-ad134q sitelibdir\=./.gem.20260904-3650-ad134q clean
8
8
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
9
9
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
10
10
 
11
11
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio
12
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-segne8 sitelibdir\=./.gem.20260818-3631-segne8
12
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-ad134q sitelibdir\=./.gem.20260904-3650-ad134q
13
13
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
14
14
  compiling stringio.c
15
15
  linking shared-object stringio.so
16
16
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
17
17
 
18
18
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio
19
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-segne8 sitelibdir\=./.gem.20260818-3631-segne8 install
19
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-ad134q sitelibdir\=./.gem.20260904-3650-ad134q install
20
20
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
21
- /usr/bin/install -c -m 0755 stringio.so ./.gem.20260818-3631-segne8
21
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20260904-3650-ad134q
22
22
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
23
23
 
24
24
  current directory: /home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio
25
- make DESTDIR\= sitearchdir\=./.gem.20260818-3631-segne8 sitelibdir\=./.gem.20260818-3631-segne8 clean
25
+ make DESTDIR\= sitearchdir\=./.gem.20260904-3650-ad134q sitelibdir\=./.gem.20260904-3650-ad134q clean
26
26
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
27
27
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-idp/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
@@ -23,6 +23,7 @@ Psych.dump("foo") # => "--- foo\n...\n"
23
23
  ## Dependencies
24
24
 
25
25
  * libyaml
26
+ * libfyaml (optional, only for the experimental `--enable-libfyaml` backend)
26
27
 
27
28
  ## Installation
28
29
 
@@ -57,6 +58,58 @@ gem 'psych'
57
58
 
58
59
  JRuby ships with a pure Java implementation of Psych.
59
60
 
61
+ ## Experimental libfyaml backend
62
+
63
+ Psych ships an experimental, opt-in backend built on
64
+ [libfyaml](https://github.com/pantoniou/libfyaml), a fully YAML 1.2 compliant
65
+ parser and emitter. It is compiled only when you explicitly pass
66
+ `--enable-libfyaml` at build time. Without the flag the default libyaml
67
+ backend is used and nothing changes.
68
+
69
+ ```bash
70
+ # libfyaml and pkg-config must be installed first, for example:
71
+ # apt-get install libfyaml-dev # Debian/Ubuntu
72
+ # brew install libfyaml # macOS
73
+ gem install psych -- --enable-libfyaml
74
+ ```
75
+
76
+ This backend is not supported on Windows.
77
+
78
+ Because libfyaml follows YAML 1.2, the YAML 1.1 booleans `yes`, `no`, `on`, and
79
+ `off` load as plain strings instead of `true`/`false` (only `true`/`false` are
80
+ booleans). This resolves the so-called "Norway problem", where the country
81
+ code `no` was parsed as `false`:
82
+
83
+ ```ruby
84
+ Psych.load("country: no") # => {"country" => "no"}
85
+ ```
86
+
87
+ You can check which backend is active:
88
+
89
+ ```ruby
90
+ Psych::BACKEND # => "libfyaml" (or "libyaml")
91
+ Psych.libfyaml_version # => "0.9.6"
92
+ ```
93
+
94
+ The backend is experimental. Its output is valid YAML but is formatted
95
+ differently from libyaml in places, and a few emitter edge cases are not yet
96
+ matched. The default libyaml backend remains the supported choice.
97
+
98
+ Two more differences are worth knowing. Scalars emitted with the default
99
+ (`ANY`) style may be quoted or laid out differently from libyaml, so
100
+ byte-for-byte output is not guaranteed to match. On a parse error,
101
+ `Psych::SyntaxError#problem` carries libfyaml's full diagnostic message and
102
+ `Psych::SyntaxError#context` is always `nil`, whereas libyaml splits the
103
+ description across `#problem` and `#context`.
104
+
105
+ This backend targets YAML 1.2 compliance, not speed. In a rough
106
+ single-machine benchmark that loads and dumps in-memory documents, parsing
107
+ was roughly on par with libyaml (sometimes faster on string-heavy input),
108
+ while emitting was about 1.7x to 1.9x slower. Your numbers will vary, but the
109
+ shape holds: libfyaml is competitive at parsing and slower at emitting. Use
110
+ this backend when you need YAML 1.2 semantics. If throughput is your priority,
111
+ keep using the default libyaml backend.
112
+
60
113
  ## Release
61
114
 
62
115
  We used the trusted publisher and [rubygems/release-gem](https://github.com/rubygems/release-gem) workflow.
@@ -2,6 +2,28 @@
2
2
  # frozen_string_literal: true
3
3
  require 'mkmf'
4
4
 
5
+ # Experimental, opt-in libfyaml backend. Only used when psych is built with
6
+ # --enable-libfyaml. Without the flag nothing below changes and the default
7
+ # libyaml backend is built exactly as before.
8
+ if enable_config("libfyaml", false)
9
+ if $mswin or $mingw or $cygwin
10
+ abort "The libfyaml backend (--enable-libfyaml) is not supported on Windows"
11
+ end
12
+ unless pkg_config('libfyaml')
13
+ abort "libfyaml was requested with --enable-libfyaml but was not found via pkg-config"
14
+ end
15
+ # libfyaml 0.8 and earlier crash psych's emitter, so require a known-good
16
+ # version rather than building something that segfaults at runtime.
17
+ pkgconfig = ENV["PKG_CONFIG"] || "pkg-config"
18
+ unless system(pkgconfig, "--atleast-version=0.9", "libfyaml")
19
+ abort "The libfyaml backend requires libfyaml 0.9 or newer"
20
+ end
21
+ $defs << "-DPSYCH_USE_LIBFYAML"
22
+
23
+ create_makefile 'psych'
24
+ return
25
+ end
26
+
5
27
  if $mswin or $mingw or $cygwin
6
28
  $CPPFLAGS << " -DYAML_DECLARE_STATIC"
7
29
  end
@@ -0,0 +1,68 @@
1
+ #include <psych.h>
2
+
3
+ /* call-seq: Psych.libyaml_version
4
+ *
5
+ * Returns the version of the underlying YAML library as a three-element
6
+ * array. This is libyaml by default. On the experimental libfyaml backend,
7
+ * where libyaml is not linked, it reports the libfyaml version instead.
8
+ */
9
+ static VALUE libyaml_version(VALUE module)
10
+ {
11
+ int major, minor, patch;
12
+ VALUE list[3];
13
+
14
+ #ifdef PSYCH_USE_LIBFYAML
15
+ /* Experimental libfyaml backend: there is no libyaml linked in. Report
16
+ * the libfyaml version so callers still receive a 3-element version. */
17
+ const struct fy_version *v = fy_version_default();
18
+ major = v ? v->major : 0;
19
+ minor = v ? v->minor : 0;
20
+ patch = 0;
21
+ #else
22
+ yaml_get_version(&major, &minor, &patch);
23
+ #endif
24
+
25
+ list[0] = INT2NUM(major);
26
+ list[1] = INT2NUM(minor);
27
+ list[2] = INT2NUM(patch);
28
+
29
+ return rb_ary_new4((long)3, list);
30
+ }
31
+
32
+ #ifdef PSYCH_USE_LIBFYAML
33
+ /* call-seq: Psych.libfyaml_version
34
+ *
35
+ * Returns the libfyaml version string. This method is only defined when
36
+ * psych was built with the experimental libfyaml backend
37
+ * (+--enable-libfyaml+).
38
+ */
39
+ static VALUE libfyaml_version(VALUE module)
40
+ {
41
+ const char *v = fy_library_version();
42
+ return v ? rb_usascii_str_new2(v) : Qnil;
43
+ }
44
+ #endif
45
+
46
+ VALUE mPsych;
47
+
48
+ void Init_psych(void)
49
+ {
50
+ #ifdef HAVE_RB_EXT_RACTOR_SAFE
51
+ RB_EXT_RACTOR_SAFE(true);
52
+ #endif
53
+ mPsych = rb_define_module("Psych");
54
+
55
+ rb_define_singleton_method(mPsych, "libyaml_version", libyaml_version, 0);
56
+
57
+ #ifdef PSYCH_USE_LIBFYAML
58
+ rb_define_singleton_method(mPsych, "libfyaml_version", libfyaml_version, 0);
59
+ rb_define_const(mPsych, "BACKEND", rb_usascii_str_new2("libfyaml"));
60
+ #else
61
+ rb_define_const(mPsych, "BACKEND", rb_usascii_str_new2("libyaml"));
62
+ #endif
63
+
64
+ Init_psych_parser();
65
+ Init_psych_emitter();
66
+ Init_psych_to_ruby();
67
+ Init_psych_yaml_tree();
68
+ }
@@ -4,7 +4,11 @@
4
4
  #include <ruby.h>
5
5
  #include <ruby/encoding.h>
6
6
 
7
+ #ifdef PSYCH_USE_LIBFYAML
8
+ #include <libfyaml.h>
9
+ #else
7
10
  #include <yaml.h>
11
+ #endif
8
12
 
9
13
  #include <psych_parser.h>
10
14
  #include <psych_emitter.h>