cybrid_api_id_ruby 0.128.104 → 0.129.153

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 (63) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +16 -7
  4. data/cybrid_api_id_ruby.gemspec +2 -2
  5. data/docs/ApplicationIdpModel.md +2 -0
  6. data/docs/ApplicationWithSecretIdpModel.md +2 -0
  7. data/docs/BankApplicationsIdpApi.md +148 -0
  8. data/docs/OrganizationApplicationsIdpApi.md +148 -0
  9. data/docs/PatchApplicationIdpModel.md +20 -0
  10. data/docs/PostBankApplicationIdpModel.md +3 -1
  11. data/docs/PostOrganizationApplicationIdpModel.md +3 -1
  12. data/lib/cybrid_api_id_ruby/api/bank_applications_idp_api.rb +139 -2
  13. data/lib/cybrid_api_id_ruby/api/customer_tokens_idp_api.rb +2 -2
  14. data/lib/cybrid_api_id_ruby/api/organization_applications_idp_api.rb +139 -2
  15. data/lib/cybrid_api_id_ruby/api/users_idp_api.rb +2 -2
  16. data/lib/cybrid_api_id_ruby/api_client.rb +2 -2
  17. data/lib/cybrid_api_id_ruby/api_error.rb +2 -2
  18. data/lib/cybrid_api_id_ruby/configuration.rb +2 -2
  19. data/lib/cybrid_api_id_ruby/models/application_idp_model.rb +20 -3
  20. data/lib/cybrid_api_id_ruby/models/application_list_idp_model.rb +2 -2
  21. data/lib/cybrid_api_id_ruby/models/application_with_secret_all_of_idp_model.rb +2 -2
  22. data/lib/cybrid_api_id_ruby/models/application_with_secret_idp_model.rb +20 -3
  23. data/lib/cybrid_api_id_ruby/models/customer_token_idp_model.rb +2 -2
  24. data/lib/cybrid_api_id_ruby/models/error_response_idp_model.rb +2 -2
  25. data/lib/cybrid_api_id_ruby/models/patch_application_idp_model.rb +257 -0
  26. data/lib/cybrid_api_id_ruby/models/patch_user_idp_model.rb +2 -2
  27. data/lib/cybrid_api_id_ruby/models/post_bank_application_idp_model.rb +18 -6
  28. data/lib/cybrid_api_id_ruby/models/post_customer_token_idp_model.rb +2 -2
  29. data/lib/cybrid_api_id_ruby/models/post_organization_application_idp_model.rb +18 -6
  30. data/lib/cybrid_api_id_ruby/models/post_user_idp_model.rb +2 -2
  31. data/lib/cybrid_api_id_ruby/models/user_idp_model.rb +2 -2
  32. data/lib/cybrid_api_id_ruby/models/user_list_idp_model.rb +2 -2
  33. data/lib/cybrid_api_id_ruby/version.rb +3 -3
  34. data/lib/cybrid_api_id_ruby.rb +3 -2
  35. data/spec/api/bank_applications_idp_api_spec.rb +27 -2
  36. data/spec/api/customer_tokens_idp_api_spec.rb +2 -2
  37. data/spec/api/organization_applications_idp_api_spec.rb +27 -2
  38. data/spec/api/users_idp_api_spec.rb +2 -2
  39. data/spec/api_client_spec.rb +2 -2
  40. data/spec/configuration_spec.rb +2 -2
  41. data/spec/models/application_idp_model_spec.rb +9 -3
  42. data/spec/models/application_list_idp_model_spec.rb +2 -2
  43. data/spec/models/application_with_secret_all_of_idp_model_spec.rb +2 -2
  44. data/spec/models/application_with_secret_idp_model_spec.rb +9 -3
  45. data/spec/models/customer_token_idp_model_spec.rb +2 -2
  46. data/spec/models/error_response_idp_model_spec.rb +2 -2
  47. data/spec/models/patch_application_idp_model_spec.rb +40 -0
  48. data/spec/models/patch_user_idp_model_spec.rb +3 -3
  49. data/spec/models/post_bank_application_idp_model_spec.rb +8 -2
  50. data/spec/models/post_customer_token_idp_model_spec.rb +3 -3
  51. data/spec/models/post_organization_application_idp_model_spec.rb +8 -2
  52. data/spec/models/post_user_idp_model_spec.rb +3 -3
  53. data/spec/models/user_idp_model_spec.rb +3 -3
  54. data/spec/models/user_list_idp_model_spec.rb +2 -2
  55. data/spec/spec_helper.rb +2 -2
  56. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-13.0.0/gem_make.out +5 -5
  57. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.5.1/gem_make.out +5 -5
  58. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.2/gem_make.out +5 -5
  59. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  60. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.3.1/gem_make.out +5 -5
  61. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  62. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.2.0/gem_make.out +5 -5
  63. metadata +5 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 25b6ca3ea26899265f28c674ce4eacbfc43dc396b4222e18c53379860f6d16c6
4
- data.tar.gz: ebd2870cb7c3a369173de4abae6a02c91dcbfe7d5b1447436be807ef8b0a1e82
3
+ metadata.gz: '0359e565dafe24777e107ecd4bd509e31e9152c3cd2013ed4299577db0445ede'
4
+ data.tar.gz: ff10c370274a83c2a3c0ccefdefa7f402f4e730c995d07167ebc8de68b6c7897
5
5
  SHA512:
6
- metadata.gz: a591461c5adc6ce1f9cfdc9d9cf4db6996408778bcc76137ee7ff4f79615261cb943e60649d3a3590e88af01f5a452b0cc058a007dd98c7b783df8603814f8e8
7
- data.tar.gz: b93d018cedbbecd034d7c6592f74fc599e22c932055c178f53a2bcaf9bd35d06fc866cb277a186daddaac75559860b045265a9eae293415843f76303493cb8f1
6
+ metadata.gz: 621726a52f2587d8bb5c53e8a2a398f7f468d0711a54cf47626354b31529bd8847bf5003c69325496ddbcb1ce3b5b097c0b066694312628a5b283ada649453ba
7
+ data.tar.gz: 9ce39d46386a2f7d45442d019af592c32f5d5ed731e021ecdc833db6d289afc1367f6df8befc68e6ff76f96241f5dfd2500acaac3415af76ca025d7aa8e040a1
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_id_ruby (0.128.104)
4
+ cybrid_api_id_ruby (0.129.153)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -101,7 +101,7 @@ CHECKSUMS
101
101
  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
102
102
  byebug (13.0.0) sha256=d2263efe751941ca520fa29744b71972d39cbc41839496706f5d9b22e92ae05d
103
103
  coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
104
- cybrid_api_id_ruby (0.128.104)
104
+ cybrid_api_id_ruby (0.129.153)
105
105
  date (3.5.1) sha256=750d06384d7b9c15d562c76291407d89e368dda4d4fff957eb94962d325a0dc0
106
106
  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
107
107
  ethon (0.18.0) sha256=b598afc9f30448cb068b850714b7d6948e941476095d04f90a4ac65b8d6efcb2
data/README.md CHANGED
@@ -66,10 +66,10 @@ curl -X POST https://id.production.cybrid.app/oauth/token -d '{
66
66
  \"grant_type\": \"client_credentials\",
67
67
  \"client_id\": \"<Your Client ID>\",
68
68
  \"client_secret\": \"<Your Secret>\",
69
- \"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\"
69
+ \"scope\": \"banks:read banks:write bank_applications:read bank_applications: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 sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\"
70
70
  }' -H \"Content-Type: application/json\"
71
71
 
72
- # 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'
72
+ # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read 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 sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute'
73
73
  ```
74
74
  <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>
75
75
 
@@ -151,8 +151,8 @@ An `Organization` can have multiple `banks`, in either `Sandbox` or `Production`
151
151
 
152
152
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
153
153
 
154
- - API version: v0.128.104
155
- - Package version: 0.128.104
154
+ - API version: v0.129.153
155
+ - Package version: 0.129.153
156
156
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
157
157
 
158
158
  ## Installation
@@ -168,16 +168,16 @@ gem build cybrid_api_id_ruby.gemspec
168
168
  Then either install the gem locally:
169
169
 
170
170
  ```shell
171
- gem install ./cybrid_api_id_ruby-0.128.104.gem
171
+ gem install ./cybrid_api_id_ruby-0.129.153.gem
172
172
  ```
173
173
 
174
- (for development, run `gem install --dev ./cybrid_api_id_ruby-0.128.104.gem` to install the development dependencies)
174
+ (for development, run `gem install --dev ./cybrid_api_id_ruby-0.129.153.gem` to install the development dependencies)
175
175
 
176
176
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
177
177
 
178
178
  Finally add this to the Gemfile:
179
179
 
180
- gem 'cybrid_api_id_ruby', '~> 0.128.104'
180
+ gem 'cybrid_api_id_ruby', '~> 0.129.153'
181
181
 
182
182
  ### Install from Git
183
183
 
@@ -231,11 +231,15 @@ Class | Method | HTTP request | Description
231
231
  ------------ | ------------- | ------------- | -------------
232
232
  *CybridApiId::BankApplicationsIdpApi* | [**create_bank_application**](docs/BankApplicationsIdpApi.md#create_bank_application) | **POST** /api/bank_applications | Create bank application
233
233
  *CybridApiId::BankApplicationsIdpApi* | [**delete_bank_application**](docs/BankApplicationsIdpApi.md#delete_bank_application) | **DELETE** /api/bank_applications/{client_id} | Delete bank application
234
+ *CybridApiId::BankApplicationsIdpApi* | [**get_bank_application**](docs/BankApplicationsIdpApi.md#get_bank_application) | **GET** /api/bank_applications/{client_id} | Get bank application
234
235
  *CybridApiId::BankApplicationsIdpApi* | [**list_bank_applications**](docs/BankApplicationsIdpApi.md#list_bank_applications) | **GET** /api/bank_applications | List bank applications
236
+ *CybridApiId::BankApplicationsIdpApi* | [**update_bank_application**](docs/BankApplicationsIdpApi.md#update_bank_application) | **PATCH** /api/bank_applications/{client_id} | Update bank application
235
237
  *CybridApiId::CustomerTokensIdpApi* | [**create_customer_token**](docs/CustomerTokensIdpApi.md#create_customer_token) | **POST** /api/customer_tokens | Create customer access token
236
238
  *CybridApiId::OrganizationApplicationsIdpApi* | [**create_organization_application**](docs/OrganizationApplicationsIdpApi.md#create_organization_application) | **POST** /api/organization_applications | Create organization application
237
239
  *CybridApiId::OrganizationApplicationsIdpApi* | [**delete_organization_application**](docs/OrganizationApplicationsIdpApi.md#delete_organization_application) | **DELETE** /api/organization_applications/{client_id} | Delete organization application
240
+ *CybridApiId::OrganizationApplicationsIdpApi* | [**get_organization_application**](docs/OrganizationApplicationsIdpApi.md#get_organization_application) | **GET** /api/organization_applications/{client_id} | Get organization application
238
241
  *CybridApiId::OrganizationApplicationsIdpApi* | [**list_organization_applications**](docs/OrganizationApplicationsIdpApi.md#list_organization_applications) | **GET** /api/organization_applications | List organization applications
242
+ *CybridApiId::OrganizationApplicationsIdpApi* | [**update_organization_application**](docs/OrganizationApplicationsIdpApi.md#update_organization_application) | **PATCH** /api/organization_applications/{client_id} | Update organization application
239
243
  *CybridApiId::UsersIdpApi* | [**create_user**](docs/UsersIdpApi.md#create_user) | **POST** /api/users | Create user
240
244
  *CybridApiId::UsersIdpApi* | [**disable_user**](docs/UsersIdpApi.md#disable_user) | **DELETE** /api/users/{user_guid} | Disable User
241
245
  *CybridApiId::UsersIdpApi* | [**get_user**](docs/UsersIdpApi.md#get_user) | **GET** /api/users/{user_guid} | Get User
@@ -251,6 +255,7 @@ Class | Method | HTTP request | Description
251
255
  - [CybridApiId::ApplicationWithSecretIdpModel](docs/ApplicationWithSecretIdpModel.md)
252
256
  - [CybridApiId::CustomerTokenIdpModel](docs/CustomerTokenIdpModel.md)
253
257
  - [CybridApiId::ErrorResponseIdpModel](docs/ErrorResponseIdpModel.md)
258
+ - [CybridApiId::PatchApplicationIdpModel](docs/PatchApplicationIdpModel.md)
254
259
  - [CybridApiId::PatchUserIdpModel](docs/PatchUserIdpModel.md)
255
260
  - [CybridApiId::PostBankApplicationIdpModel](docs/PostBankApplicationIdpModel.md)
256
261
  - [CybridApiId::PostCustomerTokenIdpModel](docs/PostCustomerTokenIdpModel.md)
@@ -276,9 +281,13 @@ Class | Method | HTTP request | Description
276
281
  - **Scopes**:
277
282
  - organizations:write: organizations write
278
283
  - organizations:read: organizations read
284
+ - organization_applications:read: organization_applications read
285
+ - organization_applications:write: organization_applications write
279
286
  - organization_applications:execute: organization_applications execute
280
287
  - banks:write: banks write
281
288
  - banks:read: banks read
289
+ - bank_applications:read: bank_applications read
290
+ - bank_applications:write: bank_applications write
282
291
  - bank_applications:execute: bank_applications execute
283
292
  - users:read: users read
284
293
  - users:execute: users execute
@@ -3,9 +3,9 @@
3
3
  =begin
4
4
  #Cybrid Identity API
5
5
 
6
- ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications: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.
6
+ ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts: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 sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read 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 sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
7
7
 
8
- The version of the OpenAPI document: v0.128.104
8
+ The version of the OpenAPI document: v0.129.153
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.0.0
@@ -7,6 +7,7 @@
7
7
  | **name** | **String** | Name provided for the OAuth2 application. | |
8
8
  | **client_id** | **String** | The OAuth2 application&#39;s client ID. | |
9
9
  | **scopes** | **Array&lt;String&gt;** | List of the scopes granted to the OAuth2 application. | |
10
+ | **ip_allowlist** | **Array&lt;String&gt;** | List of IPv4 addresses or CIDR ranges that are allowlisted for API access. | |
10
11
  | **created_at** | **Time** | ISO8601 datetime the record was created at. | |
11
12
  | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
12
13
 
@@ -19,6 +20,7 @@ instance = CybridApiId::ApplicationIdpModel.new(
19
20
  name: null,
20
21
  client_id: null,
21
22
  scopes: null,
23
+ ip_allowlist: null,
22
24
  created_at: null,
23
25
  updated_at: null
24
26
  )
@@ -7,6 +7,7 @@
7
7
  | **name** | **String** | Name provided for the OAuth2 application. | |
8
8
  | **client_id** | **String** | The OAuth2 application&#39;s client ID. | |
9
9
  | **scopes** | **Array&lt;String&gt;** | List of the scopes granted to the OAuth2 application. | |
10
+ | **ip_allowlist** | **Array&lt;String&gt;** | List of IPv4 addresses or CIDR ranges that are allowlisted for API access. | |
10
11
  | **created_at** | **Time** | ISO8601 datetime the record was created at. | |
11
12
  | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
12
13
  | **secret** | **String** | The OAuth2 application&#39;s secret. | |
@@ -20,6 +21,7 @@ instance = CybridApiId::ApplicationWithSecretIdpModel.new(
20
21
  name: null,
21
22
  client_id: null,
22
23
  scopes: null,
24
+ ip_allowlist: null,
23
25
  created_at: null,
24
26
  updated_at: null,
25
27
  secret: null
@@ -6,7 +6,9 @@ All URIs are relative to *https://id.sandbox.cybrid.app*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_bank_application**](BankApplicationsIdpApi.md#create_bank_application) | **POST** /api/bank_applications | Create bank application |
8
8
  | [**delete_bank_application**](BankApplicationsIdpApi.md#delete_bank_application) | **DELETE** /api/bank_applications/{client_id} | Delete bank application |
9
+ | [**get_bank_application**](BankApplicationsIdpApi.md#get_bank_application) | **GET** /api/bank_applications/{client_id} | Get bank application |
9
10
  | [**list_bank_applications**](BankApplicationsIdpApi.md#list_bank_applications) | **GET** /api/bank_applications | List bank applications |
11
+ | [**update_bank_application**](BankApplicationsIdpApi.md#update_bank_application) | **PATCH** /api/bank_applications/{client_id} | Update bank application |
10
12
 
11
13
 
12
14
  ## create_bank_application
@@ -152,6 +154,78 @@ nil (empty response body)
152
154
  - **Accept**: application/json
153
155
 
154
156
 
157
+ ## get_bank_application
158
+
159
+ > <ApplicationIdpModel> get_bank_application(client_id)
160
+
161
+ Get bank application
162
+
163
+ Retrieves a bank application. Required scope: **bank_applications:read**
164
+
165
+ ### Examples
166
+
167
+ ```ruby
168
+ require 'time'
169
+ require 'cybrid_api_id_ruby'
170
+ # setup authorization
171
+ CybridApiId.configure do |config|
172
+ # Configure Bearer authorization (JWT): BearerAuth
173
+ config.access_token = 'YOUR_BEARER_TOKEN'
174
+
175
+ # Configure OAuth2 access token for authorization: oauth2
176
+ config.access_token = 'YOUR ACCESS TOKEN'
177
+ end
178
+
179
+ api_instance = CybridApiId::BankApplicationsIdpApi.new
180
+ client_id = 'client_id_example' # String | Identifier for the application.
181
+
182
+ begin
183
+ # Get bank application
184
+ result = api_instance.get_bank_application(client_id)
185
+ p result
186
+ rescue CybridApiId::ApiError => e
187
+ puts "Error when calling BankApplicationsIdpApi->get_bank_application: #{e}"
188
+ end
189
+ ```
190
+
191
+ #### Using the get_bank_application_with_http_info variant
192
+
193
+ This returns an Array which contains the response data, status code and headers.
194
+
195
+ > <Array(<ApplicationIdpModel>, Integer, Hash)> get_bank_application_with_http_info(client_id)
196
+
197
+ ```ruby
198
+ begin
199
+ # Get bank application
200
+ data, status_code, headers = api_instance.get_bank_application_with_http_info(client_id)
201
+ p status_code # => 2xx
202
+ p headers # => { ... }
203
+ p data # => <ApplicationIdpModel>
204
+ rescue CybridApiId::ApiError => e
205
+ puts "Error when calling BankApplicationsIdpApi->get_bank_application_with_http_info: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ | Name | Type | Description | Notes |
212
+ | ---- | ---- | ----------- | ----- |
213
+ | **client_id** | **String** | Identifier for the application. | |
214
+
215
+ ### Return type
216
+
217
+ [**ApplicationIdpModel**](ApplicationIdpModel.md)
218
+
219
+ ### Authorization
220
+
221
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: Not defined
226
+ - **Accept**: application/json
227
+
228
+
155
229
  ## list_bank_applications
156
230
 
157
231
  > <ApplicationListIdpModel> list_bank_applications(opts)
@@ -229,3 +303,77 @@ end
229
303
  - **Content-Type**: Not defined
230
304
  - **Accept**: application/json
231
305
 
306
+
307
+ ## update_bank_application
308
+
309
+ > <ApplicationIdpModel> update_bank_application(client_id, patch_application_idp_model)
310
+
311
+ Update bank application
312
+
313
+ Updates a bank application. Required scope: **bank_applications:write**
314
+
315
+ ### Examples
316
+
317
+ ```ruby
318
+ require 'time'
319
+ require 'cybrid_api_id_ruby'
320
+ # setup authorization
321
+ CybridApiId.configure do |config|
322
+ # Configure Bearer authorization (JWT): BearerAuth
323
+ config.access_token = 'YOUR_BEARER_TOKEN'
324
+
325
+ # Configure OAuth2 access token for authorization: oauth2
326
+ config.access_token = 'YOUR ACCESS TOKEN'
327
+ end
328
+
329
+ api_instance = CybridApiId::BankApplicationsIdpApi.new
330
+ client_id = 'client_id_example' # String | Identifier for the application.
331
+ patch_application_idp_model = CybridApiId::PatchApplicationIdpModel.new # PatchApplicationIdpModel |
332
+
333
+ begin
334
+ # Update bank application
335
+ result = api_instance.update_bank_application(client_id, patch_application_idp_model)
336
+ p result
337
+ rescue CybridApiId::ApiError => e
338
+ puts "Error when calling BankApplicationsIdpApi->update_bank_application: #{e}"
339
+ end
340
+ ```
341
+
342
+ #### Using the update_bank_application_with_http_info variant
343
+
344
+ This returns an Array which contains the response data, status code and headers.
345
+
346
+ > <Array(<ApplicationIdpModel>, Integer, Hash)> update_bank_application_with_http_info(client_id, patch_application_idp_model)
347
+
348
+ ```ruby
349
+ begin
350
+ # Update bank application
351
+ data, status_code, headers = api_instance.update_bank_application_with_http_info(client_id, patch_application_idp_model)
352
+ p status_code # => 2xx
353
+ p headers # => { ... }
354
+ p data # => <ApplicationIdpModel>
355
+ rescue CybridApiId::ApiError => e
356
+ puts "Error when calling BankApplicationsIdpApi->update_bank_application_with_http_info: #{e}"
357
+ end
358
+ ```
359
+
360
+ ### Parameters
361
+
362
+ | Name | Type | Description | Notes |
363
+ | ---- | ---- | ----------- | ----- |
364
+ | **client_id** | **String** | Identifier for the application. | |
365
+ | **patch_application_idp_model** | [**PatchApplicationIdpModel**](PatchApplicationIdpModel.md) | | |
366
+
367
+ ### Return type
368
+
369
+ [**ApplicationIdpModel**](ApplicationIdpModel.md)
370
+
371
+ ### Authorization
372
+
373
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
374
+
375
+ ### HTTP request headers
376
+
377
+ - **Content-Type**: application/json
378
+ - **Accept**: application/json
379
+
@@ -6,7 +6,9 @@ All URIs are relative to *https://id.sandbox.cybrid.app*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_organization_application**](OrganizationApplicationsIdpApi.md#create_organization_application) | **POST** /api/organization_applications | Create organization application |
8
8
  | [**delete_organization_application**](OrganizationApplicationsIdpApi.md#delete_organization_application) | **DELETE** /api/organization_applications/{client_id} | Delete organization application |
9
+ | [**get_organization_application**](OrganizationApplicationsIdpApi.md#get_organization_application) | **GET** /api/organization_applications/{client_id} | Get organization application |
9
10
  | [**list_organization_applications**](OrganizationApplicationsIdpApi.md#list_organization_applications) | **GET** /api/organization_applications | List organization applications |
11
+ | [**update_organization_application**](OrganizationApplicationsIdpApi.md#update_organization_application) | **PATCH** /api/organization_applications/{client_id} | Update organization application |
10
12
 
11
13
 
12
14
  ## create_organization_application
@@ -152,6 +154,78 @@ nil (empty response body)
152
154
  - **Accept**: application/json
153
155
 
154
156
 
157
+ ## get_organization_application
158
+
159
+ > <ApplicationIdpModel> get_organization_application(client_id)
160
+
161
+ Get organization application
162
+
163
+ Retrieves an organization application. Required scope: **organization_applications:read**
164
+
165
+ ### Examples
166
+
167
+ ```ruby
168
+ require 'time'
169
+ require 'cybrid_api_id_ruby'
170
+ # setup authorization
171
+ CybridApiId.configure do |config|
172
+ # Configure Bearer authorization (JWT): BearerAuth
173
+ config.access_token = 'YOUR_BEARER_TOKEN'
174
+
175
+ # Configure OAuth2 access token for authorization: oauth2
176
+ config.access_token = 'YOUR ACCESS TOKEN'
177
+ end
178
+
179
+ api_instance = CybridApiId::OrganizationApplicationsIdpApi.new
180
+ client_id = 'client_id_example' # String | Identifier for the application.
181
+
182
+ begin
183
+ # Get organization application
184
+ result = api_instance.get_organization_application(client_id)
185
+ p result
186
+ rescue CybridApiId::ApiError => e
187
+ puts "Error when calling OrganizationApplicationsIdpApi->get_organization_application: #{e}"
188
+ end
189
+ ```
190
+
191
+ #### Using the get_organization_application_with_http_info variant
192
+
193
+ This returns an Array which contains the response data, status code and headers.
194
+
195
+ > <Array(<ApplicationIdpModel>, Integer, Hash)> get_organization_application_with_http_info(client_id)
196
+
197
+ ```ruby
198
+ begin
199
+ # Get organization application
200
+ data, status_code, headers = api_instance.get_organization_application_with_http_info(client_id)
201
+ p status_code # => 2xx
202
+ p headers # => { ... }
203
+ p data # => <ApplicationIdpModel>
204
+ rescue CybridApiId::ApiError => e
205
+ puts "Error when calling OrganizationApplicationsIdpApi->get_organization_application_with_http_info: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ | Name | Type | Description | Notes |
212
+ | ---- | ---- | ----------- | ----- |
213
+ | **client_id** | **String** | Identifier for the application. | |
214
+
215
+ ### Return type
216
+
217
+ [**ApplicationIdpModel**](ApplicationIdpModel.md)
218
+
219
+ ### Authorization
220
+
221
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: Not defined
226
+ - **Accept**: application/json
227
+
228
+
155
229
  ## list_organization_applications
156
230
 
157
231
  > <ApplicationListIdpModel> list_organization_applications(opts)
@@ -227,3 +301,77 @@ end
227
301
  - **Content-Type**: Not defined
228
302
  - **Accept**: application/json
229
303
 
304
+
305
+ ## update_organization_application
306
+
307
+ > <ApplicationIdpModel> update_organization_application(client_id, patch_application_idp_model)
308
+
309
+ Update organization application
310
+
311
+ Updates an organization application. Required scope: **organization_applications:write**
312
+
313
+ ### Examples
314
+
315
+ ```ruby
316
+ require 'time'
317
+ require 'cybrid_api_id_ruby'
318
+ # setup authorization
319
+ CybridApiId.configure do |config|
320
+ # Configure Bearer authorization (JWT): BearerAuth
321
+ config.access_token = 'YOUR_BEARER_TOKEN'
322
+
323
+ # Configure OAuth2 access token for authorization: oauth2
324
+ config.access_token = 'YOUR ACCESS TOKEN'
325
+ end
326
+
327
+ api_instance = CybridApiId::OrganizationApplicationsIdpApi.new
328
+ client_id = 'client_id_example' # String | Identifier for the application.
329
+ patch_application_idp_model = CybridApiId::PatchApplicationIdpModel.new # PatchApplicationIdpModel |
330
+
331
+ begin
332
+ # Update organization application
333
+ result = api_instance.update_organization_application(client_id, patch_application_idp_model)
334
+ p result
335
+ rescue CybridApiId::ApiError => e
336
+ puts "Error when calling OrganizationApplicationsIdpApi->update_organization_application: #{e}"
337
+ end
338
+ ```
339
+
340
+ #### Using the update_organization_application_with_http_info variant
341
+
342
+ This returns an Array which contains the response data, status code and headers.
343
+
344
+ > <Array(<ApplicationIdpModel>, Integer, Hash)> update_organization_application_with_http_info(client_id, patch_application_idp_model)
345
+
346
+ ```ruby
347
+ begin
348
+ # Update organization application
349
+ data, status_code, headers = api_instance.update_organization_application_with_http_info(client_id, patch_application_idp_model)
350
+ p status_code # => 2xx
351
+ p headers # => { ... }
352
+ p data # => <ApplicationIdpModel>
353
+ rescue CybridApiId::ApiError => e
354
+ puts "Error when calling OrganizationApplicationsIdpApi->update_organization_application_with_http_info: #{e}"
355
+ end
356
+ ```
357
+
358
+ ### Parameters
359
+
360
+ | Name | Type | Description | Notes |
361
+ | ---- | ---- | ----------- | ----- |
362
+ | **client_id** | **String** | Identifier for the application. | |
363
+ | **patch_application_idp_model** | [**PatchApplicationIdpModel**](PatchApplicationIdpModel.md) | | |
364
+
365
+ ### Return type
366
+
367
+ [**ApplicationIdpModel**](ApplicationIdpModel.md)
368
+
369
+ ### Authorization
370
+
371
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
372
+
373
+ ### HTTP request headers
374
+
375
+ - **Content-Type**: application/json
376
+ - **Accept**: application/json
377
+
@@ -0,0 +1,20 @@
1
+ # CybridApiId::PatchApplicationIdpModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name for the application. | [optional] |
8
+ | **ip_allowlist** | **Array&lt;String&gt;** | List of public IPv4 addresses or CIDR ranges to allowlist for API access. Provide [] to clear the allowlist; omit to leave unchanged. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'cybrid_api_id_ruby'
14
+
15
+ instance = CybridApiId::PatchApplicationIdpModel.new(
16
+ name: null,
17
+ ip_allowlist: null
18
+ )
19
+ ```
20
+
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | Name for the bank application. | |
8
8
  | **bank_guid** | **String** | Bank guid the application is associated to. | [optional] |
9
+ | **ip_allowlist** | **Array&lt;String&gt;** | List of public IPv4 addresses or CIDR ranges to allowlist for API access. | [optional] |
9
10
 
10
11
  ## Example
11
12
 
@@ -14,7 +15,8 @@ require 'cybrid_api_id_ruby'
14
15
 
15
16
  instance = CybridApiId::PostBankApplicationIdpModel.new(
16
17
  name: null,
17
- bank_guid: null
18
+ bank_guid: null,
19
+ ip_allowlist: null
18
20
  )
19
21
  ```
20
22
 
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | Name for the organization application. | |
8
+ | **ip_allowlist** | **Array&lt;String&gt;** | List of public IPv4 addresses or CIDR ranges to allowlist for API access. | [optional] |
8
9
 
9
10
  ## Example
10
11
 
@@ -12,7 +13,8 @@
12
13
  require 'cybrid_api_id_ruby'
13
14
 
14
15
  instance = CybridApiId::PostOrganizationApplicationIdpModel.new(
15
- name: null
16
+ name: null,
17
+ ip_allowlist: null
16
18
  )
17
19
  ```
18
20