cybrid_api_organization_ruby 0.125.250 → 0.125.251

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 (73) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +5 -5
  4. data/cybrid_api_organization_ruby.gemspec +1 -1
  5. data/lib/cybrid_api_organization_ruby/api/organizations_organization_api.rb +1 -1
  6. data/lib/cybrid_api_organization_ruby/api/subscription_deliveries_organization_api.rb +1 -1
  7. data/lib/cybrid_api_organization_ruby/api/subscription_events_organization_api.rb +1 -1
  8. data/lib/cybrid_api_organization_ruby/api/subscriptions_organization_api.rb +1 -1
  9. data/lib/cybrid_api_organization_ruby/api_client.rb +1 -1
  10. data/lib/cybrid_api_organization_ruby/api_error.rb +1 -1
  11. data/lib/cybrid_api_organization_ruby/configuration.rb +1 -1
  12. data/lib/cybrid_api_organization_ruby/models/error_response_organization_model.rb +1 -1
  13. data/lib/cybrid_api_organization_ruby/models/organization_organization_model.rb +1 -1
  14. data/lib/cybrid_api_organization_ruby/models/patch_organization_organization_model.rb +1 -1
  15. data/lib/cybrid_api_organization_ruby/models/post_subscription_delivery_organization_model.rb +1 -1
  16. data/lib/cybrid_api_organization_ruby/models/post_subscription_organization_model.rb +1 -1
  17. data/lib/cybrid_api_organization_ruby/models/subscription_delivery_list_organization_model.rb +1 -1
  18. data/lib/cybrid_api_organization_ruby/models/subscription_delivery_organization_model.rb +1 -1
  19. data/lib/cybrid_api_organization_ruby/models/subscription_environment_organization_model.rb +1 -1
  20. data/lib/cybrid_api_organization_ruby/models/subscription_event_list_organization_model.rb +1 -1
  21. data/lib/cybrid_api_organization_ruby/models/subscription_event_organization_model.rb +1 -1
  22. data/lib/cybrid_api_organization_ruby/models/subscription_list_organization_model.rb +1 -1
  23. data/lib/cybrid_api_organization_ruby/models/subscription_organization_model.rb +1 -1
  24. data/lib/cybrid_api_organization_ruby/models/subscription_state_organization_model.rb +1 -1
  25. data/lib/cybrid_api_organization_ruby/models/subscription_type_organization_model.rb +1 -1
  26. data/lib/cybrid_api_organization_ruby/version.rb +2 -2
  27. data/lib/cybrid_api_organization_ruby.rb +1 -1
  28. data/spec/api/organizations_organization_api_spec.rb +1 -1
  29. data/spec/api/subscription_deliveries_organization_api_spec.rb +1 -1
  30. data/spec/api/subscription_events_organization_api_spec.rb +1 -1
  31. data/spec/api/subscriptions_organization_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/error_response_organization_model_spec.rb +1 -1
  35. data/spec/models/organization_organization_model_spec.rb +1 -1
  36. data/spec/models/patch_organization_organization_model_spec.rb +1 -1
  37. data/spec/models/post_subscription_delivery_organization_model_spec.rb +1 -1
  38. data/spec/models/post_subscription_organization_model_spec.rb +1 -1
  39. data/spec/models/subscription_delivery_list_organization_model_spec.rb +1 -1
  40. data/spec/models/subscription_delivery_organization_model_spec.rb +1 -1
  41. data/spec/models/subscription_environment_organization_model_spec.rb +1 -1
  42. data/spec/models/subscription_event_list_organization_model_spec.rb +1 -1
  43. data/spec/models/subscription_event_organization_model_spec.rb +1 -1
  44. data/spec/models/subscription_list_organization_model_spec.rb +1 -1
  45. data/spec/models/subscription_organization_model_spec.rb +1 -1
  46. data/spec/models/subscription_state_organization_model_spec.rb +1 -1
  47. data/spec/models/subscription_type_organization_model_spec.rb +1 -1
  48. data/spec/spec_helper.rb +1 -1
  49. data/vendor/bundle/ruby/3.3.0/cache/stringio-3.1.9.gem +0 -0
  50. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-12.0.0/gem_make.out +5 -5
  51. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.5.0/gem_make.out +5 -5
  52. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  53. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +5 -5
  54. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  55. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/{stringio-3.1.8 → stringio-3.1.9}/gem_make.out +18 -18
  56. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/{stringio-3.1.8 → stringio-3.1.9}/stringio.so +0 -0
  57. data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/NEWS.md +33 -0
  58. data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/ext/stringio/stringio.c +7 -169
  59. data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/lib/stringio.so +0 -0
  60. data/vendor/bundle/ruby/3.3.0/specifications/{stringio-3.1.8.gemspec → stringio-3.1.9.gemspec} +4 -4
  61. metadata +19 -19
  62. data/vendor/bundle/ruby/3.3.0/cache/stringio-3.1.8.gem +0 -0
  63. /data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/{stringio-3.1.8 → stringio-3.1.9}/gem.build_complete +0 -0
  64. /data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/{stringio-3.1.8 → stringio-3.1.9}/mkmf.log +0 -0
  65. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/.document +0 -0
  66. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/.rdoc_options +0 -0
  67. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/COPYING +0 -0
  68. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/LICENSE.txt +0 -0
  69. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/README.md +0 -0
  70. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/docs/io.rb +0 -0
  71. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/ext/stringio/.document +0 -0
  72. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/ext/stringio/Makefile +0 -0
  73. /data/vendor/bundle/ruby/3.3.0/gems/{stringio-3.1.8 → stringio-3.1.9}/ext/stringio/extconf.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 Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-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://kb.cybrid.xyz/getting-ready-for-trading), 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:execute accounts:read 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 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:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read 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 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:execute banks:read banks:write banks:execute bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read 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 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.125.250
6
+ The version of the OpenAPI document: v0.125.251
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 Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-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://kb.cybrid.xyz/getting-ready-for-trading), 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:execute accounts:read 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 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:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read 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 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:execute banks:read banks:write banks:execute bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read 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 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.125.250
6
+ The version of the OpenAPI document: v0.125.251
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-platform-orga
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug
6
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-xkuvms sitelibdir\=./.gem.20251201-3343-xkuvms clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-rp5q9k sitelibdir\=./.gem.20251202-3365-rp5q9k clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug
11
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-xkuvms sitelibdir\=./.gem.20251201-3343-xkuvms
11
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-rp5q9k sitelibdir\=./.gem.20251202-3365-rp5q9k
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.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-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug'
40
40
 
41
41
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug
42
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-xkuvms sitelibdir\=./.gem.20251201-3343-xkuvms install
42
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-rp5q9k sitelibdir\=./.gem.20251202-3365-rp5q9k install
43
43
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug'
44
- /usr/bin/install -c -m 0755 byebug.so ./.gem.20251201-3343-xkuvms/byebug
44
+ /usr/bin/install -c -m 0755 byebug.so ./.gem.20251202-3365-rp5q9k/byebug
45
45
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug'
46
46
 
47
47
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug
48
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-xkuvms sitelibdir\=./.gem.20251201-3343-xkuvms clean
48
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-rp5q9k sitelibdir\=./.gem.20251202-3365-rp5q9k clean
49
49
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.0.0/ext/byebug'
50
50
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/byebug-12.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-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date
9
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-lt0f16 sitelibdir\=./.gem.20251201-3343-lt0f16 clean
9
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-geen8f sitelibdir\=./.gem.20251202-3365-geen8f clean
10
10
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date'
11
11
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date'
12
12
 
13
13
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date
14
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-lt0f16 sitelibdir\=./.gem.20251201-3343-lt0f16
14
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-geen8f sitelibdir\=./.gem.20251202-3365-geen8f
15
15
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/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-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date'
22
22
 
23
23
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date
24
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-lt0f16 sitelibdir\=./.gem.20251201-3343-lt0f16 install
24
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-geen8f sitelibdir\=./.gem.20251202-3365-geen8f install
25
25
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date'
26
- /usr/bin/install -c -m 0755 date_core.so ./.gem.20251201-3343-lt0f16
26
+ /usr/bin/install -c -m 0755 date_core.so ./.gem.20251202-3365-geen8f
27
27
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date'
28
28
 
29
29
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date
30
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-lt0f16 sitelibdir\=./.gem.20251201-3343-lt0f16 clean
30
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-geen8f sitelibdir\=./.gem.20251202-3365-geen8f clean
31
31
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date'
32
32
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/date-3.5.0/ext/date'
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/build/public-clients/api-platform-orga
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
6
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-tfhqm7 sitelibdir\=./.gem.20251201-3343-tfhqm7 clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-owtg5 sitelibdir\=./.gem.20251202-3365-owtg5 clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
11
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-tfhqm7 sitelibdir\=./.gem.20251201-3343-tfhqm7
11
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-owtg5 sitelibdir\=./.gem.20251202-3365-owtg5
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.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-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
27
27
 
28
28
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
29
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-tfhqm7 sitelibdir\=./.gem.20251201-3343-tfhqm7 install
29
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-owtg5 sitelibdir\=./.gem.20251202-3365-owtg5 install
30
30
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
31
- /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20251201-3343-tfhqm7/jaro_winkler
31
+ /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20251202-3365-owtg5/jaro_winkler
32
32
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
33
33
 
34
34
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
35
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-tfhqm7 sitelibdir\=./.gem.20251201-3343-tfhqm7 clean
35
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-owtg5 sitelibdir\=./.gem.20251202-3365-owtg5 clean
36
36
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
37
37
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
@@ -6,7 +6,7 @@ checking for yaml_get_version() in -lyaml... yes
6
6
  creating Makefile
7
7
 
8
8
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych
9
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-fvefmm sitelibdir\=./.gem.20251201-3343-fvefmm clean
9
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-6571vn sitelibdir\=./.gem.20251202-3365-6571vn clean
10
10
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych'
11
11
  cd libyaml && make clean
12
12
  /bin/sh: 1: cd: can't cd to libyaml
@@ -14,7 +14,7 @@ make[1]: [Makefile:283: clean-so] Error 2 (ignored)
14
14
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych'
15
15
 
16
16
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych
17
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-fvefmm sitelibdir\=./.gem.20251201-3343-fvefmm
17
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-6571vn sitelibdir\=./.gem.20251202-3365-6571vn
18
18
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych'
19
19
  compiling psych.c
20
20
  compiling psych_emitter.c
@@ -25,13 +25,13 @@ linking shared-object psych.so
25
25
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych'
26
26
 
27
27
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych
28
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-fvefmm sitelibdir\=./.gem.20251201-3343-fvefmm install
28
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-6571vn sitelibdir\=./.gem.20251202-3365-6571vn install
29
29
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych'
30
- /usr/bin/install -c -m 0755 psych.so ./.gem.20251201-3343-fvefmm
30
+ /usr/bin/install -c -m 0755 psych.so ./.gem.20251202-3365-6571vn
31
31
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych'
32
32
 
33
33
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych
34
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-fvefmm sitelibdir\=./.gem.20251201-3343-fvefmm clean
34
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-6571vn sitelibdir\=./.gem.20251202-3365-6571vn clean
35
35
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/psych-5.2.6/ext/psych'
36
36
  cd libyaml && make clean
37
37
  /bin/sh: 1: cd: can't cd to libyaml
@@ -3,24 +3,24 @@ current directory: /home/circleci/project/build/public-clients/api-platform-orga
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse
6
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-2c9wco sitelibdir\=./.gem.20251201-3343-2c9wco clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-emted1 sitelibdir\=./.gem.20251202-3365-emted1 clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse
11
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-2c9wco sitelibdir\=./.gem.20251201-3343-2c9wco
11
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-emted1 sitelibdir\=./.gem.20251202-3365-emted1
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.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-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse'
16
16
 
17
17
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse
18
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-2c9wco sitelibdir\=./.gem.20251201-3343-2c9wco install
18
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-emted1 sitelibdir\=./.gem.20251202-3365-emted1 install
19
19
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse'
20
- /usr/bin/install -c -m 0755 cparse.so ./.gem.20251201-3343-2c9wco/racc
20
+ /usr/bin/install -c -m 0755 cparse.so ./.gem.20251202-3365-emted1/racc
21
21
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse'
22
22
 
23
23
  current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse
24
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-2c9wco sitelibdir\=./.gem.20251201-3343-2c9wco clean
24
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-emted1 sitelibdir\=./.gem.20251202-3365-emted1 clean
25
25
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse'
26
26
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/racc-1.8.1/ext/racc/cparse'
@@ -1,27 +1,27 @@
1
- current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio
1
+ current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio
2
2
  /usr/local/bin/ruby extconf.rb
3
3
  checking for rb_io_mode_t in ruby/io.h... no
4
4
  creating Makefile
5
5
 
6
- current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio
7
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-otbn5c sitelibdir\=./.gem.20251201-3343-otbn5c clean
8
- make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio'
9
- make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio'
6
+ current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio
7
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-r4nyq3 sitelibdir\=./.gem.20251202-3365-r4nyq3 clean
8
+ make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio'
9
+ make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio'
10
10
 
11
- current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio
12
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-otbn5c sitelibdir\=./.gem.20251201-3343-otbn5c
13
- make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio'
11
+ current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio
12
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-r4nyq3 sitelibdir\=./.gem.20251202-3365-r4nyq3
13
+ make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio'
14
14
  compiling stringio.c
15
15
  linking shared-object stringio.so
16
- make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio'
16
+ make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio'
17
17
 
18
- current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio
19
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-otbn5c sitelibdir\=./.gem.20251201-3343-otbn5c install
20
- make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio'
21
- /usr/bin/install -c -m 0755 stringio.so ./.gem.20251201-3343-otbn5c
22
- make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio'
18
+ current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio
19
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-r4nyq3 sitelibdir\=./.gem.20251202-3365-r4nyq3 install
20
+ make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio'
21
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20251202-3365-r4nyq3
22
+ make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio'
23
23
 
24
- current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio
25
- make DESTDIR\= sitearchdir\=./.gem.20251201-3343-otbn5c sitelibdir\=./.gem.20251201-3343-otbn5c clean
26
- make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio'
27
- make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.8/ext/stringio'
24
+ current directory: /home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio
25
+ make DESTDIR\= sitearchdir\=./.gem.20251202-3365-r4nyq3 sitelibdir\=./.gem.20251202-3365-r4nyq3 clean
26
+ make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio'
27
+ make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.3.0/gems/stringio-3.1.9/ext/stringio'
@@ -1,5 +1,35 @@
1
1
  # News
2
2
 
3
+ ## 3.1.9 - 2025-12-01
4
+
5
+ ### Improvements
6
+
7
+ * [DOC] Tweaks for StringIO#each_line
8
+ * GH-165
9
+
10
+ * [DOC] Doc for StringIO.size
11
+ * GH-175
12
+
13
+ * [DOC] Tweaks for StringIO#fsync
14
+ * GH-173
15
+
16
+ * [DOC] Fix #seek link
17
+ * GH-174
18
+
19
+ * Add a note about chilled string support to 3.1.8 release note
20
+ * GH-180 fixes GH-179
21
+
22
+ ### Fixes
23
+
24
+ * JRuby: Removed use of RubyBasicObject.flags
25
+ * GH-182
26
+
27
+ ### Thanks
28
+
29
+ * Burdette Lamar
30
+
31
+ * Charles Oliver Nutter
32
+
3
33
  ## 3.1.8 - 2025-11-12
4
34
 
5
35
  ### Improvements
@@ -7,6 +37,9 @@
7
37
  * Improved documents
8
38
  * Patch by Burdette Lamar
9
39
 
40
+ * Improved chilled string support
41
+ * GH-128
42
+
10
43
  ### Fixes
11
44
 
12
45
  * Fixed SEGV in `StringIO#seek` with `SEEK_END` on `StringIO.new(nil)`
@@ -13,7 +13,7 @@
13
13
  **********************************************************************/
14
14
 
15
15
  static const char *const
16
- STRINGIO_VERSION = "3.1.8";
16
+ STRINGIO_VERSION = "3.1.9";
17
17
 
18
18
  #include <stdbool.h>
19
19
 
@@ -883,9 +883,9 @@ strio_rewind(VALUE self)
883
883
  * call-seq:
884
884
  * seek(offset, whence = SEEK_SET) -> 0
885
885
  *
886
- * Sets the current position to the given integer +offset+ (in bytes),
886
+ * Sets the position to the given integer +offset+ (in bytes),
887
887
  * with respect to a given constant +whence+;
888
- * see {Position}[rdoc-ref:IO@Position].
888
+ * see {IO#seek}[https://docs.ruby-lang.org/en/master/IO.html#method-i-seek].
889
889
  */
890
890
  static VALUE
891
891
  strio_seek(int argc, VALUE *argv, VALUE self)
@@ -1473,170 +1473,8 @@ strio_readline(int argc, VALUE *argv, VALUE self)
1473
1473
  * each_line(limit, chomp: false) {|line| ... } -> self
1474
1474
  * each_line(sep, limit, chomp: false) {|line| ... } -> self
1475
1475
  *
1476
- * With a block given calls the block with each remaining line (see "Position" below) in the stream;
1477
- * returns `self`.
1478
- *
1479
- * Leaves stream position as end-of-stream.
1480
- *
1481
- * **No Arguments**
1482
- *
1483
- * With no arguments given,
1484
- * reads lines using the default record separator global variable `$/`, whose initial value is `"\n"`.
1485
- *
1486
- * ```
1487
- * strio = StringIO.new(TEXT)
1488
- * strio.each_line {|line| p line }
1489
- * strio.eof? # => true
1490
- * ```
1491
- *
1492
- * Output:
1493
- *
1494
- * ```
1495
- * "First line\n"
1496
- * "Second line\n"
1497
- * "\n"
1498
- * "Fourth line\n"
1499
- * "Fifth line\n"
1500
- * ```
1501
- *
1502
- * **Argument `sep`**
1503
- *
1504
- * With only string argument `sep` given,
1505
- * reads lines using that string as the record separator:
1506
- *
1507
- * ```
1508
- * strio = StringIO.new(TEXT)
1509
- * strio.each_line(' ') {|line| p line }
1510
- * ```
1511
- *
1512
- * Output:
1513
- *
1514
- * ```
1515
- * "First "
1516
- * "line\nSecond "
1517
- * "line\n\nFourth "
1518
- * "line\nFifth "
1519
- * "line\n"
1520
- * ```
1521
- *
1522
- * **Argument `limit`**
1523
- *
1524
- * With only integer argument `limit` given,
1525
- * reads lines using the default record separator global variable `$/`, whose initial value is `"\n"`;
1526
- * also limits the size (in characters) of each line to the given limit:
1527
- *
1528
- * ```
1529
- * strio = StringIO.new(TEXT)
1530
- * strio.each_line(10) {|line| p line }
1531
- * ```
1532
- *
1533
- * Output:
1534
- *
1535
- * ```
1536
- * "First line"
1537
- * "\n"
1538
- * "Second lin"
1539
- * "e\n"
1540
- * "\n"
1541
- * "Fourth lin"
1542
- * "e\n"
1543
- * "Fifth line"
1544
- * "\n"
1545
- * ```
1546
- * **Arguments `sep` and `limit`**
1547
- *
1548
- * With arguments `sep` and `limit` both given,
1549
- * honors both:
1550
- *
1551
- * ```
1552
- * strio = StringIO.new(TEXT)
1553
- * strio.each_line(' ', 10) {|line| p line }
1554
- * ```
1555
- *
1556
- * Output:
1557
- *
1558
- * ```
1559
- * "First "
1560
- * "line\nSecon"
1561
- * "d "
1562
- * "line\n\nFour"
1563
- * "th "
1564
- * "line\nFifth"
1565
- * " "
1566
- * "line\n"
1567
- * ```
1568
- *
1569
- * **Position**
1476
+ * :include: stringio/each_line.md
1570
1477
  *
1571
- * As stated above, method `each` _remaining_ line in the stream.
1572
- *
1573
- * In the examples above each `strio` object starts with its position at beginning-of-stream;
1574
- * but in other cases the position may be anywhere (see StringIO#pos):
1575
- *
1576
- * ```
1577
- * strio = StringIO.new(TEXT)
1578
- * strio.pos = 30 # Set stream position to character 30.
1579
- * strio.each_line {|line| p line }
1580
- * ```
1581
- *
1582
- * Output:
1583
- *
1584
- * ```
1585
- * " line\n"
1586
- * "Fifth line\n"
1587
- * ```
1588
- *
1589
- * **Special Record Separators**
1590
- *
1591
- * Like some methds in class `IO`, StringIO.each honors two special record separators;
1592
- * see {Special Line Separators}[https://docs.ruby-lang.org/en/master/IO.html#class-IO-label-Special+Line+Separator+Values].
1593
- *
1594
- * ```
1595
- * strio = StringIO.new(TEXT)
1596
- * strio.each_line('') {|line| p line } # Read as paragraphs (separated by blank lines).
1597
- * ```
1598
- *
1599
- * Output:
1600
- *
1601
- * ```
1602
- * "First line\nSecond line\n\n"
1603
- * "Fourth line\nFifth line\n"
1604
- * ```
1605
- *
1606
- * ```
1607
- * strio = StringIO.new(TEXT)
1608
- * strio.each_line(nil) {|line| p line } # "Slurp"; read it all.
1609
- * ```
1610
- *
1611
- * Output:
1612
- *
1613
- * ```
1614
- * "First line\nSecond line\n\nFourth line\nFifth line\n"
1615
- * ```
1616
- *
1617
- * **Keyword Argument `chomp`**
1618
- *
1619
- * With keyword argument `chomp` given as `true` (the default is `false`),
1620
- * removes trailing newline (if any) from each line:
1621
- *
1622
- * ```
1623
- * strio = StringIO.new(TEXT)
1624
- * strio.each_line(chomp: true) {|line| p line }
1625
- * ```
1626
- *
1627
- * Output:
1628
- *
1629
- * ```
1630
- * "First line"
1631
- * "Second line"
1632
- * ""
1633
- * "Fourth line"
1634
- * "Fifth line"
1635
- * ```
1636
- *
1637
- * With no block given, returns a new {Enumerator}[https://docs.ruby-lang.org/en/master/Enumerator.html].
1638
- *
1639
- * Related: StringIO.each_byte, StringIO.each_char, StringIO.each_codepoint.
1640
1478
  */
1641
1479
  static VALUE
1642
1480
  strio_each(int argc, VALUE *argv, VALUE self)
@@ -2005,10 +1843,10 @@ strio_syswrite_nonblock(int argc, VALUE *argv, VALUE self)
2005
1843
 
2006
1844
  /*
2007
1845
  * call-seq:
2008
- * strio.length -> integer
2009
- * strio.size -> integer
1846
+ * size -> integer
1847
+ *
1848
+ * :include: stringio/size.rdoc
2010
1849
  *
2011
- * Returns the size of the buffer string.
2012
1850
  */
2013
1851
  static VALUE
2014
1852
  strio_size(VALUE self)
@@ -1,16 +1,16 @@
1
1
  # -*- encoding: utf-8 -*-
2
- # stub: stringio 3.1.8 ruby lib
2
+ # stub: stringio 3.1.9 ruby lib
3
3
  # stub: ext/stringio/extconf.rb
4
4
 
5
5
  Gem::Specification.new do |s|
6
6
  s.name = "stringio".freeze
7
- s.version = "3.1.8".freeze
7
+ s.version = "3.1.9".freeze
8
8
 
9
9
  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
10
- s.metadata = { "changelog_uri" => "https://github.com/ruby/stringio/releases/tag/v3.1.8" } if s.respond_to? :metadata=
10
+ s.metadata = { "changelog_uri" => "https://github.com/ruby/stringio/releases/tag/v3.1.9" } if s.respond_to? :metadata=
11
11
  s.require_paths = ["lib".freeze]
12
12
  s.authors = ["Nobu Nakada".freeze, "Charles Oliver Nutter".freeze]
13
- s.date = "2025-11-12"
13
+ s.date = "2025-12-02"
14
14
  s.description = "Pseudo `IO` class from/to `String`.".freeze
15
15
  s.email = ["nobu@ruby-lang.org".freeze, "headius@headius.com".freeze]
16
16
  s.extensions = ["ext/stringio/extconf.rb".freeze]