cybrid_api_bank_ruby 0.92.4 → 0.93.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (164) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -12
  4. data/cybrid_api_bank_ruby.gemspec +2 -2
  5. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +2 -2
  6. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
  7. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
  8. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
  9. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +2 -2
  10. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
  11. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +2 -2
  12. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
  13. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
  14. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
  15. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
  16. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
  17. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +2 -2
  18. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +2 -2
  19. data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
  20. data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
  21. data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
  22. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
  23. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
  24. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
  25. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
  26. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
  27. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
  28. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +2 -2
  29. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
  30. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
  31. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +2 -2
  32. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +2 -2
  33. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +2 -2
  34. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
  35. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
  36. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
  37. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +2 -2
  38. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +2 -2
  39. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +2 -2
  40. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
  41. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_all_of_bank_model.rb +2 -2
  42. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +2 -2
  43. data/lib/cybrid_api_bank_ruby/models/list_request_owner_bank_model.rb +2 -2
  44. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
  45. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -2
  46. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +2 -2
  47. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
  48. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +2 -2
  49. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +2 -2
  50. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +2 -2
  51. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +2 -2
  52. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +2 -2
  53. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +2 -2
  54. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +2 -2
  56. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +2 -2
  57. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +2 -2
  58. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +2 -2
  59. data/lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb +2 -2
  60. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
  61. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +2 -2
  62. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +2 -2
  63. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
  64. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
  65. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
  66. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  67. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
  68. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +2 -2
  69. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +2 -2
  70. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +2 -2
  71. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +2 -2
  72. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +2 -2
  73. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +2 -2
  74. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +2 -2
  75. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +2 -2
  76. data/lib/cybrid_api_bank_ruby/version.rb +3 -3
  77. data/lib/cybrid_api_bank_ruby.rb +2 -5
  78. data/spec/api/accounts_bank_api_spec.rb +2 -2
  79. data/spec/api/assets_bank_api_spec.rb +2 -2
  80. data/spec/api/banks_bank_api_spec.rb +2 -2
  81. data/spec/api/customers_bank_api_spec.rb +2 -2
  82. data/spec/api/deposit_addresses_bank_api_spec.rb +2 -2
  83. data/spec/api/external_bank_accounts_bank_api_spec.rb +2 -2
  84. data/spec/api/external_wallets_bank_api_spec.rb +2 -2
  85. data/spec/api/identity_verifications_bank_api_spec.rb +2 -2
  86. data/spec/api/prices_bank_api_spec.rb +2 -2
  87. data/spec/api/quotes_bank_api_spec.rb +2 -2
  88. data/spec/api/symbols_bank_api_spec.rb +2 -2
  89. data/spec/api/trades_bank_api_spec.rb +2 -2
  90. data/spec/api/transfers_bank_api_spec.rb +2 -2
  91. data/spec/api/workflows_bank_api_spec.rb +2 -2
  92. data/spec/api_client_spec.rb +2 -2
  93. data/spec/configuration_spec.rb +2 -2
  94. data/spec/models/account_bank_model_spec.rb +2 -2
  95. data/spec/models/account_list_bank_model_spec.rb +2 -2
  96. data/spec/models/asset_bank_model_spec.rb +2 -2
  97. data/spec/models/asset_list_bank_model_spec.rb +2 -2
  98. data/spec/models/bank_bank_model_spec.rb +2 -2
  99. data/spec/models/bank_list_bank_model_spec.rb +2 -2
  100. data/spec/models/customer_address_bank_model_spec.rb +2 -2
  101. data/spec/models/customer_bank_model_spec.rb +2 -2
  102. data/spec/models/customer_list_bank_model_spec.rb +2 -2
  103. data/spec/models/customer_name_bank_model_spec.rb +2 -2
  104. data/spec/models/deposit_address_bank_model_spec.rb +2 -2
  105. data/spec/models/deposit_address_list_bank_model_spec.rb +2 -2
  106. data/spec/models/error_response_bank_model_spec.rb +2 -2
  107. data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
  108. data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
  109. data/spec/models/external_wallet_bank_model_spec.rb +2 -2
  110. data/spec/models/external_wallet_list_bank_model_spec.rb +2 -2
  111. data/spec/models/identity_verification_bank_model_spec.rb +2 -2
  112. data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
  113. data/spec/models/identity_verification_with_details_all_of_bank_model_spec.rb +2 -2
  114. data/spec/models/identity_verification_with_details_bank_model_spec.rb +2 -2
  115. data/spec/models/list_request_owner_bank_model_spec.rb +2 -2
  116. data/spec/models/patch_bank_bank_model_spec.rb +2 -2
  117. data/spec/models/patch_external_bank_account_bank_model_spec.rb +2 -2
  118. data/spec/models/post_account_bank_model_spec.rb +2 -2
  119. data/spec/models/post_bank_bank_model_spec.rb +2 -2
  120. data/spec/models/post_customer_address_bank_model_spec.rb +2 -2
  121. data/spec/models/post_customer_bank_model_spec.rb +2 -2
  122. data/spec/models/post_customer_name_bank_model_spec.rb +2 -2
  123. data/spec/models/post_deposit_address_bank_model_spec.rb +2 -2
  124. data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
  125. data/spec/models/post_external_wallet_bank_model_spec.rb +2 -2
  126. data/spec/models/post_identification_number_bank_model_spec.rb +2 -2
  127. data/spec/models/post_identity_verification_address_bank_model_spec.rb +2 -2
  128. data/spec/models/post_identity_verification_bank_model_spec.rb +2 -2
  129. data/spec/models/post_identity_verification_name_bank_model_spec.rb +2 -2
  130. data/spec/models/post_quote_bank_model_spec.rb +2 -2
  131. data/spec/models/post_reward_bank_model_spec.rb +2 -2
  132. data/spec/models/post_trade_bank_model_spec.rb +2 -2
  133. data/spec/models/post_transfer_bank_model_spec.rb +2 -2
  134. data/spec/models/post_workflow_bank_model_spec.rb +2 -2
  135. data/spec/models/quote_bank_model_spec.rb +2 -2
  136. data/spec/models/quote_list_bank_model_spec.rb +2 -2
  137. data/spec/models/symbol_price_bank_model_spec.rb +2 -2
  138. data/spec/models/trade_bank_model_spec.rb +2 -2
  139. data/spec/models/trade_list_bank_model_spec.rb +2 -2
  140. data/spec/models/transfer_bank_model_spec.rb +2 -2
  141. data/spec/models/transfer_destination_account_bank_model_spec.rb +2 -2
  142. data/spec/models/transfer_list_bank_model_spec.rb +2 -2
  143. data/spec/models/transfer_source_account_bank_model_spec.rb +2 -2
  144. data/spec/models/workflow_bank_model_spec.rb +2 -2
  145. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +2 -2
  146. data/spec/models/workflow_with_details_bank_model_spec.rb +2 -2
  147. data/spec/models/workflows_list_bank_model_spec.rb +2 -2
  148. data/spec/spec_helper.rb +2 -2
  149. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  150. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +5 -5
  151. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  152. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.0/gem_make.out +5 -5
  153. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.1/gem_make.out +5 -5
  154. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.8/gem_make.out +5 -5
  155. metadata +2 -14
  156. data/docs/RewardBankModel.md +0 -36
  157. data/docs/RewardListBankModel.md +0 -24
  158. data/docs/RewardsBankApi.md +0 -236
  159. data/lib/cybrid_api_bank_ruby/api/rewards_bank_api.rb +0 -237
  160. data/lib/cybrid_api_bank_ruby/models/reward_bank_model.rb +0 -440
  161. data/lib/cybrid_api_bank_ruby/models/reward_list_bank_model.rb +0 -329
  162. data/spec/api/rewards_bank_api_spec.rb +0 -75
  163. data/spec/models/reward_bank_model_spec.rb +0 -92
  164. data/spec/models/reward_list_bank_model_spec.rb +0 -52
@@ -1,440 +0,0 @@
1
- =begin
2
- #Cybrid Bank API
3
-
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.sandbox.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. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), 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. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.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.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.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.sandbox.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.sandbox.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 customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards:read external_bank_accounts: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\" }' -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:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read' ``` <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) | | 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:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Reward | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | 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) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.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 an organization user | | 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 | 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 | 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 | Reward | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | 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
-
6
- The version of the OpenAPI document: v0.92.4
7
- Contact: support@cybrid.app
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module CybridApiBank
17
- class RewardBankModel
18
- # Auto-generated unique identifier for the reward.
19
- attr_accessor :guid
20
-
21
- # The associated customer's identifier.
22
- attr_accessor :customer_guid
23
-
24
- # The associated quote's identifier.
25
- attr_accessor :quote_guid
26
-
27
- # The associated trade's identifier.
28
- attr_accessor :trade_guid
29
-
30
- # The trade symbol the pricing is related to. Format is asset-counter_asset, e.g., BTC-USD.
31
- attr_accessor :symbol
32
-
33
- # The trade's state
34
- attr_accessor :state
35
-
36
- # The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell.
37
- attr_accessor :receive_amount
38
-
39
- # The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell.
40
- attr_accessor :deliver_amount
41
-
42
- # The fee associated with the trade. Denominated in \"counter_asset\" base units
43
- attr_accessor :fee
44
-
45
- # ISO8601 datetime the bank was created at.
46
- attr_accessor :created_at
47
-
48
- class EnumAttributeValidator
49
- attr_reader :datatype
50
- attr_reader :allowable_values
51
-
52
- def initialize(datatype, allowable_values)
53
- @allowable_values = allowable_values.map do |value|
54
- case datatype.to_s
55
- when /Integer/i
56
- value.to_i
57
- when /Float/i
58
- value.to_f
59
- else
60
- value
61
- end
62
- end
63
- end
64
-
65
- def valid?(value)
66
- !value || allowable_values.include?(value)
67
- end
68
- end
69
-
70
- # Attribute mapping from ruby-style variable name to JSON key.
71
- def self.attribute_map
72
- {
73
- :'guid' => :'guid',
74
- :'customer_guid' => :'customer_guid',
75
- :'quote_guid' => :'quote_guid',
76
- :'trade_guid' => :'trade_guid',
77
- :'symbol' => :'symbol',
78
- :'state' => :'state',
79
- :'receive_amount' => :'receive_amount',
80
- :'deliver_amount' => :'deliver_amount',
81
- :'fee' => :'fee',
82
- :'created_at' => :'created_at'
83
- }
84
- end
85
-
86
- # Returns all the JSON keys this model knows about
87
- def self.acceptable_attributes
88
- attribute_map.values
89
- end
90
-
91
- # Attribute type mapping.
92
- def self.openapi_types
93
- {
94
- :'guid' => :'String',
95
- :'customer_guid' => :'String',
96
- :'quote_guid' => :'String',
97
- :'trade_guid' => :'String',
98
- :'symbol' => :'String',
99
- :'state' => :'String',
100
- :'receive_amount' => :'Integer',
101
- :'deliver_amount' => :'Integer',
102
- :'fee' => :'Integer',
103
- :'created_at' => :'Time'
104
- }
105
- end
106
-
107
- # List of attributes with nullable: true
108
- def self.openapi_nullable
109
- Set.new([
110
- ])
111
- end
112
-
113
- # Initializes the object
114
- # @param [Hash] attributes Model attributes in the form of hash
115
- def initialize(attributes = {})
116
- if (!attributes.is_a?(Hash))
117
- fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::RewardBankModel` initialize method"
118
- end
119
-
120
- # check to see if the attribute exists and convert string to symbol for hash key
121
- attributes = attributes.each_with_object({}) { |(k, v), h|
122
- if (!self.class.attribute_map.key?(k.to_sym))
123
- fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::RewardBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
124
- end
125
- h[k.to_sym] = v
126
- }
127
-
128
- if attributes.key?(:'guid')
129
- self.guid = attributes[:'guid']
130
- end
131
-
132
- if attributes.key?(:'customer_guid')
133
- self.customer_guid = attributes[:'customer_guid']
134
- end
135
-
136
- if attributes.key?(:'quote_guid')
137
- self.quote_guid = attributes[:'quote_guid']
138
- end
139
-
140
- if attributes.key?(:'trade_guid')
141
- self.trade_guid = attributes[:'trade_guid']
142
- end
143
-
144
- if attributes.key?(:'symbol')
145
- self.symbol = attributes[:'symbol']
146
- end
147
-
148
- if attributes.key?(:'state')
149
- self.state = attributes[:'state']
150
- end
151
-
152
- if attributes.key?(:'receive_amount')
153
- self.receive_amount = attributes[:'receive_amount']
154
- end
155
-
156
- if attributes.key?(:'deliver_amount')
157
- self.deliver_amount = attributes[:'deliver_amount']
158
- end
159
-
160
- if attributes.key?(:'fee')
161
- self.fee = attributes[:'fee']
162
- end
163
-
164
- if attributes.key?(:'created_at')
165
- self.created_at = attributes[:'created_at']
166
- end
167
- end
168
-
169
- # Show invalid properties with the reasons. Usually used together with valid?
170
- # @return Array for valid properties with the reasons
171
- def list_invalid_properties
172
- invalid_properties = Array.new
173
- if !@guid.nil? && @guid.to_s.length > 32
174
- invalid_properties.push('invalid value for "guid", the character length must be smaller than or equal to 32.')
175
- end
176
-
177
- if !@guid.nil? && @guid.to_s.length < 32
178
- invalid_properties.push('invalid value for "guid", the character length must be great than or equal to 32.')
179
- end
180
-
181
- if !@customer_guid.nil? && @customer_guid.to_s.length > 32
182
- invalid_properties.push('invalid value for "customer_guid", the character length must be smaller than or equal to 32.')
183
- end
184
-
185
- if !@customer_guid.nil? && @customer_guid.to_s.length < 32
186
- invalid_properties.push('invalid value for "customer_guid", the character length must be great than or equal to 32.')
187
- end
188
-
189
- if !@quote_guid.nil? && @quote_guid.to_s.length > 32
190
- invalid_properties.push('invalid value for "quote_guid", the character length must be smaller than or equal to 32.')
191
- end
192
-
193
- if !@quote_guid.nil? && @quote_guid.to_s.length < 32
194
- invalid_properties.push('invalid value for "quote_guid", the character length must be great than or equal to 32.')
195
- end
196
-
197
- if !@trade_guid.nil? && @trade_guid.to_s.length > 32
198
- invalid_properties.push('invalid value for "trade_guid", the character length must be smaller than or equal to 32.')
199
- end
200
-
201
- if !@trade_guid.nil? && @trade_guid.to_s.length < 32
202
- invalid_properties.push('invalid value for "trade_guid", the character length must be great than or equal to 32.')
203
- end
204
-
205
- invalid_properties
206
- end
207
-
208
- # Check to see if the all the properties in the model are valid
209
- # @return true if the model is valid
210
- def valid?
211
- return false if !@guid.nil? && @guid.to_s.length > 32
212
- return false if !@guid.nil? && @guid.to_s.length < 32
213
- return false if !@customer_guid.nil? && @customer_guid.to_s.length > 32
214
- return false if !@customer_guid.nil? && @customer_guid.to_s.length < 32
215
- return false if !@quote_guid.nil? && @quote_guid.to_s.length > 32
216
- return false if !@quote_guid.nil? && @quote_guid.to_s.length < 32
217
- return false if !@trade_guid.nil? && @trade_guid.to_s.length > 32
218
- return false if !@trade_guid.nil? && @trade_guid.to_s.length < 32
219
- state_validator = EnumAttributeValidator.new('String', ["storing", "pending", "cancelled", "completed", "settling", "failed"])
220
- return false unless state_validator.valid?(@state)
221
- true
222
- end
223
-
224
- # Custom attribute writer method with validation
225
- # @param [Object] guid Value to be assigned
226
- def guid=(guid)
227
- if !guid.nil? && guid.to_s.length > 32
228
- fail ArgumentError, 'invalid value for "guid", the character length must be smaller than or equal to 32.'
229
- end
230
-
231
- if !guid.nil? && guid.to_s.length < 32
232
- fail ArgumentError, 'invalid value for "guid", the character length must be great than or equal to 32.'
233
- end
234
-
235
- @guid = guid
236
- end
237
-
238
- # Custom attribute writer method with validation
239
- # @param [Object] customer_guid Value to be assigned
240
- def customer_guid=(customer_guid)
241
- if !customer_guid.nil? && customer_guid.to_s.length > 32
242
- fail ArgumentError, 'invalid value for "customer_guid", the character length must be smaller than or equal to 32.'
243
- end
244
-
245
- if !customer_guid.nil? && customer_guid.to_s.length < 32
246
- fail ArgumentError, 'invalid value for "customer_guid", the character length must be great than or equal to 32.'
247
- end
248
-
249
- @customer_guid = customer_guid
250
- end
251
-
252
- # Custom attribute writer method with validation
253
- # @param [Object] quote_guid Value to be assigned
254
- def quote_guid=(quote_guid)
255
- if !quote_guid.nil? && quote_guid.to_s.length > 32
256
- fail ArgumentError, 'invalid value for "quote_guid", the character length must be smaller than or equal to 32.'
257
- end
258
-
259
- if !quote_guid.nil? && quote_guid.to_s.length < 32
260
- fail ArgumentError, 'invalid value for "quote_guid", the character length must be great than or equal to 32.'
261
- end
262
-
263
- @quote_guid = quote_guid
264
- end
265
-
266
- # Custom attribute writer method with validation
267
- # @param [Object] trade_guid Value to be assigned
268
- def trade_guid=(trade_guid)
269
- if !trade_guid.nil? && trade_guid.to_s.length > 32
270
- fail ArgumentError, 'invalid value for "trade_guid", the character length must be smaller than or equal to 32.'
271
- end
272
-
273
- if !trade_guid.nil? && trade_guid.to_s.length < 32
274
- fail ArgumentError, 'invalid value for "trade_guid", the character length must be great than or equal to 32.'
275
- end
276
-
277
- @trade_guid = trade_guid
278
- end
279
-
280
- # Custom attribute writer method checking allowed values (enum).
281
- # @param [Object] state Object to be assigned
282
- def state=(state)
283
- validator = EnumAttributeValidator.new('String', ["storing", "pending", "cancelled", "completed", "settling", "failed"])
284
- unless validator.valid?(state)
285
- fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
286
- end
287
- @state = state
288
- end
289
-
290
- # Checks equality by comparing each attribute.
291
- # @param [Object] Object to be compared
292
- def ==(o)
293
- return true if self.equal?(o)
294
- self.class == o.class &&
295
- guid == o.guid &&
296
- customer_guid == o.customer_guid &&
297
- quote_guid == o.quote_guid &&
298
- trade_guid == o.trade_guid &&
299
- symbol == o.symbol &&
300
- state == o.state &&
301
- receive_amount == o.receive_amount &&
302
- deliver_amount == o.deliver_amount &&
303
- fee == o.fee &&
304
- created_at == o.created_at
305
- end
306
-
307
- # @see the `==` method
308
- # @param [Object] Object to be compared
309
- def eql?(o)
310
- self == o
311
- end
312
-
313
- # Calculates hash code according to all attributes.
314
- # @return [Integer] Hash code
315
- def hash
316
- [guid, customer_guid, quote_guid, trade_guid, symbol, state, receive_amount, deliver_amount, fee, created_at].hash
317
- end
318
-
319
- # Builds the object from hash
320
- # @param [Hash] attributes Model attributes in the form of hash
321
- # @return [Object] Returns the model itself
322
- def self.build_from_hash(attributes)
323
- new.build_from_hash(attributes)
324
- end
325
-
326
- # Builds the object from hash
327
- # @param [Hash] attributes Model attributes in the form of hash
328
- # @return [Object] Returns the model itself
329
- def build_from_hash(attributes)
330
- return nil unless attributes.is_a?(Hash)
331
- attributes = attributes.transform_keys(&:to_sym)
332
- self.class.openapi_types.each_pair do |key, type|
333
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
334
- self.send("#{key}=", nil)
335
- elsif type =~ /\AArray<(.*)>/i
336
- # check to ensure the input is an array given that the attribute
337
- # is documented as an array but the input is not
338
- if attributes[self.class.attribute_map[key]].is_a?(Array)
339
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
340
- end
341
- elsif !attributes[self.class.attribute_map[key]].nil?
342
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
343
- end
344
- end
345
-
346
- self
347
- end
348
-
349
- # Deserializes the data based on type
350
- # @param string type Data type
351
- # @param string value Value to be deserialized
352
- # @return [Object] Deserialized data
353
- def _deserialize(type, value)
354
- case type.to_sym
355
- when :Time
356
- Time.parse(value)
357
- when :Date
358
- Date.parse(value)
359
- when :String
360
- value.to_s
361
- when :Integer
362
- value.to_i
363
- when :Float
364
- value.to_f
365
- when :Boolean
366
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
367
- true
368
- else
369
- false
370
- end
371
- when :Object
372
- # generic object (usually a Hash), return directly
373
- value
374
- when /\AArray<(?<inner_type>.+)>\z/
375
- inner_type = Regexp.last_match[:inner_type]
376
- value.map { |v| _deserialize(inner_type, v) }
377
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
378
- k_type = Regexp.last_match[:k_type]
379
- v_type = Regexp.last_match[:v_type]
380
- {}.tap do |hash|
381
- value.each do |k, v|
382
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
383
- end
384
- end
385
- else # model
386
- # models (e.g. Pet) or oneOf
387
- klass = CybridApiBank.const_get(type)
388
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
389
- end
390
- end
391
-
392
- # Returns the string representation of the object
393
- # @return [String] String presentation of the object
394
- def to_s
395
- to_hash.to_s
396
- end
397
-
398
- # to_body is an alias to to_hash (backward compatibility)
399
- # @return [Hash] Returns the object in the form of hash
400
- def to_body
401
- to_hash
402
- end
403
-
404
- # Returns the object in the form of hash
405
- # @return [Hash] Returns the object in the form of hash
406
- def to_hash
407
- hash = {}
408
- self.class.attribute_map.each_pair do |attr, param|
409
- value = self.send(attr)
410
- if value.nil?
411
- is_nullable = self.class.openapi_nullable.include?(attr)
412
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
413
- end
414
-
415
- hash[param] = _to_hash(value)
416
- end
417
- hash
418
- end
419
-
420
- # Outputs non-array value in the form of hash
421
- # For object, use to_hash. Otherwise, just return the value
422
- # @param [Object] value Any valid value
423
- # @return [Hash] Returns the value in the form of hash
424
- def _to_hash(value)
425
- if value.is_a?(Array)
426
- value.compact.map { |v| _to_hash(v) }
427
- elsif value.is_a?(Hash)
428
- {}.tap do |hash|
429
- value.each { |k, v| hash[k] = _to_hash(v) }
430
- end
431
- elsif value.respond_to? :to_hash
432
- value.to_hash
433
- else
434
- value
435
- end
436
- end
437
-
438
- end
439
-
440
- end