cybrid_api_bank_ruby 0.51.5 → 0.51.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (153) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +36 -24
  4. data/cybrid_api_bank_ruby.gemspec +2 -2
  5. data/docs/PostWorkflowBankModel.md +32 -0
  6. data/docs/WorkflowBankModel.md +24 -0
  7. data/docs/WorkflowWithDetailsAllOfBankModel.md +18 -0
  8. data/docs/WorkflowWithDetailsBankModel.md +26 -0
  9. data/docs/WorkflowsBankApi.md +236 -0
  10. data/docs/WorkflowsListBankModel.md +24 -0
  11. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +2 -2
  12. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
  13. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
  14. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
  15. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
  16. data/lib/cybrid_api_bank_ruby/api/fee_configurations_bank_api.rb +2 -2
  17. data/lib/cybrid_api_bank_ruby/api/identity_records_bank_api.rb +2 -2
  18. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
  19. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
  20. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
  21. data/lib/cybrid_api_bank_ruby/api/rewards_bank_api.rb +2 -2
  22. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
  23. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
  24. data/lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb +2 -2
  25. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +237 -0
  26. data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
  27. data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
  28. data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
  29. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
  30. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
  31. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
  32. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
  33. data/lib/cybrid_api_bank_ruby/models/attestation_details_bank_model.rb +2 -2
  34. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
  35. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
  36. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
  37. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
  38. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
  39. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
  40. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
  41. data/lib/cybrid_api_bank_ruby/models/fee_bank_model.rb +2 -2
  42. data/lib/cybrid_api_bank_ruby/models/fee_configuration_bank_model.rb +2 -2
  43. data/lib/cybrid_api_bank_ruby/models/fee_configuration_list_bank_model.rb +2 -2
  44. data/lib/cybrid_api_bank_ruby/models/identity_record_bank_model.rb +2 -2
  45. data/lib/cybrid_api_bank_ruby/models/identity_record_list_bank_model.rb +2 -2
  46. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +2 -2
  47. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
  48. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
  49. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +2 -2
  50. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
  51. data/lib/cybrid_api_bank_ruby/models/post_customer_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_fee_bank_model.rb +2 -2
  54. data/lib/cybrid_api_bank_ruby/models/post_fee_configuration_bank_model.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby/models/post_identity_record_attestation_details_bank_model.rb +2 -2
  56. data/lib/cybrid_api_bank_ruby/models/post_identity_record_bank_model.rb +2 -2
  57. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_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_verification_key_bank_model.rb +2 -2
  62. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +475 -0
  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/reward_bank_model.rb +2 -2
  66. data/lib/cybrid_api_bank_ruby/models/reward_list_bank_model.rb +2 -2
  67. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
  68. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  69. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
  70. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +2 -2
  71. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +2 -2
  72. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +332 -0
  73. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +221 -0
  74. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +351 -0
  75. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +329 -0
  76. data/lib/cybrid_api_bank_ruby/version.rb +3 -3
  77. data/lib/cybrid_api_bank_ruby.rb +8 -2
  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/external_bank_accounts_bank_api_spec.rb +2 -2
  83. data/spec/api/fee_configurations_bank_api_spec.rb +2 -2
  84. data/spec/api/identity_records_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/rewards_bank_api_spec.rb +2 -2
  89. data/spec/api/symbols_bank_api_spec.rb +2 -2
  90. data/spec/api/trades_bank_api_spec.rb +2 -2
  91. data/spec/api/verification_keys_bank_api_spec.rb +2 -2
  92. data/spec/api/workflows_bank_api_spec.rb +75 -0
  93. data/spec/api_client_spec.rb +2 -2
  94. data/spec/configuration_spec.rb +2 -2
  95. data/spec/models/account_bank_model_spec.rb +2 -2
  96. data/spec/models/account_list_bank_model_spec.rb +2 -2
  97. data/spec/models/asset_bank_model_spec.rb +2 -2
  98. data/spec/models/asset_list_bank_model_spec.rb +2 -2
  99. data/spec/models/attestation_details_bank_model_spec.rb +2 -2
  100. data/spec/models/bank_bank_model_spec.rb +2 -2
  101. data/spec/models/bank_list_bank_model_spec.rb +2 -2
  102. data/spec/models/customer_bank_model_spec.rb +2 -2
  103. data/spec/models/customer_list_bank_model_spec.rb +2 -2
  104. data/spec/models/error_response_bank_model_spec.rb +2 -2
  105. data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
  106. data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
  107. data/spec/models/fee_bank_model_spec.rb +2 -2
  108. data/spec/models/fee_configuration_bank_model_spec.rb +2 -2
  109. data/spec/models/fee_configuration_list_bank_model_spec.rb +2 -2
  110. data/spec/models/identity_record_bank_model_spec.rb +2 -2
  111. data/spec/models/identity_record_list_bank_model_spec.rb +2 -2
  112. data/spec/models/identity_verification_bank_model_spec.rb +2 -2
  113. data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
  114. data/spec/models/patch_bank_bank_model_spec.rb +2 -2
  115. data/spec/models/post_account_bank_model_spec.rb +2 -2
  116. data/spec/models/post_bank_bank_model_spec.rb +2 -2
  117. data/spec/models/post_customer_bank_model_spec.rb +2 -2
  118. data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
  119. data/spec/models/post_fee_bank_model_spec.rb +2 -2
  120. data/spec/models/post_fee_configuration_bank_model_spec.rb +2 -2
  121. data/spec/models/post_identity_record_attestation_details_bank_model_spec.rb +2 -2
  122. data/spec/models/post_identity_record_bank_model_spec.rb +2 -2
  123. data/spec/models/post_identity_verification_bank_model_spec.rb +2 -2
  124. data/spec/models/post_quote_bank_model_spec.rb +2 -2
  125. data/spec/models/post_reward_bank_model_spec.rb +2 -2
  126. data/spec/models/post_trade_bank_model_spec.rb +2 -2
  127. data/spec/models/post_verification_key_bank_model_spec.rb +2 -2
  128. data/spec/models/post_workflow_bank_model_spec.rb +88 -0
  129. data/spec/models/quote_bank_model_spec.rb +2 -2
  130. data/spec/models/quote_list_bank_model_spec.rb +2 -2
  131. data/spec/models/reward_bank_model_spec.rb +2 -2
  132. data/spec/models/reward_list_bank_model_spec.rb +2 -2
  133. data/spec/models/symbol_price_bank_model_spec.rb +2 -2
  134. data/spec/models/trade_bank_model_spec.rb +2 -2
  135. data/spec/models/trade_list_bank_model_spec.rb +2 -2
  136. data/spec/models/verification_key_bank_model_spec.rb +2 -2
  137. data/spec/models/verification_key_list_bank_model_spec.rb +2 -2
  138. data/spec/models/workflow_bank_model_spec.rb +56 -0
  139. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +34 -0
  140. data/spec/models/workflow_with_details_bank_model_spec.rb +62 -0
  141. data/spec/models/workflows_list_bank_model_spec.rb +52 -0
  142. data/spec/spec_helper.rb +2 -2
  143. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out +2 -2
  144. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out +2 -2
  145. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/jaro_winkler-1.5.4/gem_make.out +2 -2
  146. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.6/gem_make.out +2 -2
  147. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out +2 -2
  148. data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  149. data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  150. data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  151. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.6/ext/psych/Makefile +2 -2
  152. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  153. metadata +25 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1a93564456deb58c9e74aec7d406e24947169f4af1b5254da097285626f3011e
4
- data.tar.gz: 5c4475a684eec47db86585ba12877b807ca07b005d82c53b8765cfb7ef251e10
3
+ metadata.gz: 9bb40c6977491e55056bddb31d6b806c896bfbeb5b0b23a556aa239e743da094
4
+ data.tar.gz: 4fce4a5218fbbb8e01d6371ecee170e106b1a7050cca03f1adee2d14968ffd7b
5
5
  SHA512:
6
- metadata.gz: bb060cb8d601ca801eb79acfd178593849ce7a740104bf958bb71ebf9d9ec3caad28a984675badf0d7148a72912537630e810bcdebe3aa26dd75bb67d7c32497
7
- data.tar.gz: 42f765f5b6f23c3ca7536a7d8ecfb42e38182938b92570063eab9834c24927f4b184e17731e9c8199bd5b3031d495b148e9858e2199ac548abdb9c2a8a2e9f92
6
+ metadata.gz: 5608bf604eaafeca969de0fa5e42728cd021d61f14e76e1bfbe2233b3936588dc16569ac90ef8625b9dde2fdccb0ad7a0556ec3d755417b5dc41c1c969bb1036
7
+ data.tar.gz: 1ce0b5e7cf40b1ebb7e3dafa3f9bdadedb8984e593cc7707f043288f5ce1e42bf47c5eb4fd84a644615ba4a594a49786fa8ba542f05334dd177179a87e735973
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_bank_ruby (0.51.5)
4
+ cybrid_api_bank_ruby (0.51.6)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -89,30 +89,32 @@ The following scopes are available on the platform and can be requested when gen
89
89
  | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) |
90
90
  | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) |
91
91
  | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) |
92
+ | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) |
92
93
 
93
94
  ## Available Endpoints
94
95
 
95
96
  The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below:
96
97
 
97
- | API Service | Model | API Endpoint Path | Description |
98
- |--------------|---------------------|--------------------------------|---------------------------------------------------------------------------------------------------|
99
- | Identity | Bank | /api/bank_applications | Create and list banks |
100
- | Identity | Organization | /api/organization_applications | Create and list organizations |
101
- | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens |
102
- | Organization | Organization | /api/organizations | APIs to retrieve and update organization name |
103
- | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) |
104
- | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities |
105
- | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc |
106
- | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) |
107
- | Bank | Customers | /api/customers | Create and list customers |
108
- | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC |
109
- | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers |
110
- | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) |
111
- | Bank | Prices | /api/prices | Get the current prices for assets on the platform |
112
- | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades |
113
- | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency |
114
- | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) |
115
- | Bank | ExternalBankAccount | /api/external_bank_account | Create, get and list external bank accounts, which connect customer bank accounts to the platform |
98
+ | API Service | Model | API Endpoint Path | Description |
99
+ |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------|
100
+ | Identity | Bank | /api/bank_applications | Create and list banks |
101
+ | Identity | Organization | /api/organization_applications | Create and list organizations |
102
+ | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens |
103
+ | Organization | Organization | /api/organizations | APIs to retrieve and update organization name |
104
+ | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) |
105
+ | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities |
106
+ | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc |
107
+ | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) |
108
+ | Bank | Customers | /api/customers | Create and list customers |
109
+ | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC |
110
+ | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers |
111
+ | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) |
112
+ | Bank | Prices | /api/prices | Get the current prices for assets on the platform |
113
+ | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades |
114
+ | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency |
115
+ | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) |
116
+ | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform |
117
+ | Bank | Workflows | /api/workflows | Create, get and list workflows |
116
118
 
117
119
  ## Understanding Object Models & Endpoints
118
120
 
@@ -139,8 +141,8 @@ An `Organization` can have multiple `banks`, in either sandbox or production env
139
141
 
140
142
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
141
143
 
142
- - API version: v0.51.5
143
- - Package version: 0.51.5
144
+ - API version: v0.51.6
145
+ - Package version: 0.51.6
144
146
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
145
147
 
146
148
  ## Installation
@@ -156,16 +158,16 @@ gem build cybrid_api_bank_ruby.gemspec
156
158
  Then either install the gem locally:
157
159
 
158
160
  ```shell
159
- gem install ./cybrid_api_bank_ruby-0.51.5.gem
161
+ gem install ./cybrid_api_bank_ruby-0.51.6.gem
160
162
  ```
161
163
 
162
- (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.51.5.gem` to install the development dependencies)
164
+ (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.51.6.gem` to install the development dependencies)
163
165
 
164
166
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
165
167
 
166
168
  Finally add this to the Gemfile:
167
169
 
168
- gem 'cybrid_api_bank_ruby', '~> 0.51.5'
170
+ gem 'cybrid_api_bank_ruby', '~> 0.51.6'
169
171
 
170
172
  ### Install from Git
171
173
 
@@ -254,6 +256,9 @@ Class | Method | HTTP request | Description
254
256
  *CybridApiBank::VerificationKeysBankApi* | [**create_verification_key**](docs/VerificationKeysBankApi.md#create_verification_key) | **POST** /api/bank_verification_keys | Create VerificationKey
255
257
  *CybridApiBank::VerificationKeysBankApi* | [**get_verification_key**](docs/VerificationKeysBankApi.md#get_verification_key) | **GET** /api/bank_verification_keys/{verification_key_guid} | Get VerificationKey
256
258
  *CybridApiBank::VerificationKeysBankApi* | [**list_verification_keys**](docs/VerificationKeysBankApi.md#list_verification_keys) | **GET** /api/bank_verification_keys | Get Verification Keys list
259
+ *CybridApiBank::WorkflowsBankApi* | [**create_workflow**](docs/WorkflowsBankApi.md#create_workflow) | **POST** /api/workflows | Create Workflow
260
+ *CybridApiBank::WorkflowsBankApi* | [**get_workflow**](docs/WorkflowsBankApi.md#get_workflow) | **GET** /api/workflows/{workflow_guid} | Get Workflow
261
+ *CybridApiBank::WorkflowsBankApi* | [**list_workflows**](docs/WorkflowsBankApi.md#list_workflows) | **GET** /api/workflows | Get workflows list
257
262
 
258
263
 
259
264
  ## Documentation for Models
@@ -291,6 +296,7 @@ Class | Method | HTTP request | Description
291
296
  - [CybridApiBank::PostRewardBankModel](docs/PostRewardBankModel.md)
292
297
  - [CybridApiBank::PostTradeBankModel](docs/PostTradeBankModel.md)
293
298
  - [CybridApiBank::PostVerificationKeyBankModel](docs/PostVerificationKeyBankModel.md)
299
+ - [CybridApiBank::PostWorkflowBankModel](docs/PostWorkflowBankModel.md)
294
300
  - [CybridApiBank::QuoteBankModel](docs/QuoteBankModel.md)
295
301
  - [CybridApiBank::QuoteListBankModel](docs/QuoteListBankModel.md)
296
302
  - [CybridApiBank::RewardBankModel](docs/RewardBankModel.md)
@@ -300,6 +306,10 @@ Class | Method | HTTP request | Description
300
306
  - [CybridApiBank::TradeListBankModel](docs/TradeListBankModel.md)
301
307
  - [CybridApiBank::VerificationKeyBankModel](docs/VerificationKeyBankModel.md)
302
308
  - [CybridApiBank::VerificationKeyListBankModel](docs/VerificationKeyListBankModel.md)
309
+ - [CybridApiBank::WorkflowBankModel](docs/WorkflowBankModel.md)
310
+ - [CybridApiBank::WorkflowWithDetailsAllOfBankModel](docs/WorkflowWithDetailsAllOfBankModel.md)
311
+ - [CybridApiBank::WorkflowWithDetailsBankModel](docs/WorkflowWithDetailsBankModel.md)
312
+ - [CybridApiBank::WorkflowsListBankModel](docs/WorkflowsListBankModel.md)
303
313
 
304
314
 
305
315
  ## Documentation for Authorization
@@ -332,4 +342,6 @@ Class | Method | HTTP request | Description
332
342
  - rewards:read: rewards read
333
343
  - external_bank_accounts:read: external_bank_accounts read
334
344
  - external_bank_accounts:execute: external_bank_accounts execute
345
+ - workflows:read: workflows read
346
+ - workflows:execute: workflows execute
335
347
 
@@ -3,9 +3,9 @@
3
3
  =begin
4
4
  #Cybrid Bank 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.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), Apple-coming soon) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API. <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|---------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccount | /api/external_bank_account | Create, get and list external bank accounts, which connect customer bank accounts to the platform | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `Customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where Sandbox is the environment that you would test, prototype and build in prior to 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
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.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), Apple-coming soon) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API. <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization or a Bank token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `Customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where Sandbox is the environment that you would test, prototype and build in prior to 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 processes will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amout 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 in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
7
7
 
8
- The version of the OpenAPI document: v0.51.5
8
+ The version of the OpenAPI document: v0.51.6
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.0.0
@@ -0,0 +1,32 @@
1
+ # CybridApiBank::PostWorkflowBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The workflow type. | |
8
+ | **kind** | **String** | The Plaid workflow kind. | [optional] |
9
+ | **customer_guid** | **String** | The customer identifier associated with the workflow. | [optional] |
10
+ | **external_bank_account_guid** | **String** | The external bank account identifier associated with the workflow. | [optional] |
11
+ | **language** | **String** | The language to initialize Plaid link. | [optional] |
12
+ | **link_customization_name** | **String** | The customization name for Plaid link. | [optional] |
13
+ | **redirect_uri** | **String** | The redirect URI for Plaid link. | [optional] |
14
+ | **android_package_name** | **String** | The Android package name for Plaid link. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'cybrid_api_bank_ruby'
20
+
21
+ instance = CybridApiBank::PostWorkflowBankModel.new(
22
+ type: null,
23
+ kind: null,
24
+ customer_guid: null,
25
+ external_bank_account_guid: null,
26
+ language: null,
27
+ link_customization_name: null,
28
+ redirect_uri: null,
29
+ android_package_name: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::WorkflowBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **guid** | **String** | Auto-generated unique identifier for the workflow. | [optional] |
8
+ | **customer_guid** | **String** | The associated customer&#39;s identifier. | [optional] |
9
+ | **type** | **String** | The type of workflow. | [optional] |
10
+ | **created_at** | **Time** | ISO8601 datetime the bank was created at. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::WorkflowBankModel.new(
18
+ guid: null,
19
+ customer_guid: null,
20
+ type: null,
21
+ created_at: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # CybridApiBank::WorkflowWithDetailsAllOfBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **plaid_link_token** | **String** | The Plaid link token generated by the workflow. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'cybrid_api_bank_ruby'
13
+
14
+ instance = CybridApiBank::WorkflowWithDetailsAllOfBankModel.new(
15
+ plaid_link_token: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,26 @@
1
+ # CybridApiBank::WorkflowWithDetailsBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **guid** | **String** | Auto-generated unique identifier for the workflow. | [optional] |
8
+ | **customer_guid** | **String** | The associated customer&#39;s identifier. | [optional] |
9
+ | **type** | **String** | The type of workflow. | [optional] |
10
+ | **created_at** | **Time** | ISO8601 datetime the bank was created at. | [optional] |
11
+ | **plaid_link_token** | **String** | The Plaid link token generated by the workflow. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'cybrid_api_bank_ruby'
17
+
18
+ instance = CybridApiBank::WorkflowWithDetailsBankModel.new(
19
+ guid: null,
20
+ customer_guid: null,
21
+ type: null,
22
+ created_at: null,
23
+ plaid_link_token: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,236 @@
1
+ # CybridApiBank::WorkflowsBankApi
2
+
3
+ All URIs are relative to *https://bank.demo.cybrid.app*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_workflow**](WorkflowsBankApi.md#create_workflow) | **POST** /api/workflows | Create Workflow |
8
+ | [**get_workflow**](WorkflowsBankApi.md#get_workflow) | **GET** /api/workflows/{workflow_guid} | Get Workflow |
9
+ | [**list_workflows**](WorkflowsBankApi.md#list_workflows) | **GET** /api/workflows | Get workflows list |
10
+
11
+
12
+ ## create_workflow
13
+
14
+ > <WorkflowBankModel> create_workflow(post_workflow_bank_model)
15
+
16
+ Create Workflow
17
+
18
+ Creates a workflow. Required scope: **workflows:execute**
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'cybrid_api_bank_ruby'
25
+ # setup authorization
26
+ CybridApiBank.configure do |config|
27
+ # Configure Bearer authorization (JWT): BearerAuth
28
+ config.access_token = 'YOUR_BEARER_TOKEN'
29
+
30
+ # Configure OAuth2 access token for authorization: oauth2
31
+ config.access_token = 'YOUR ACCESS TOKEN'
32
+ end
33
+
34
+ api_instance = CybridApiBank::WorkflowsBankApi.new
35
+ post_workflow_bank_model = CybridApiBank::PostWorkflowBankModel.new({type: 'plaid'}) # PostWorkflowBankModel |
36
+
37
+ begin
38
+ # Create Workflow
39
+ result = api_instance.create_workflow(post_workflow_bank_model)
40
+ p result
41
+ rescue CybridApiBank::ApiError => e
42
+ puts "Error when calling WorkflowsBankApi->create_workflow: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_workflow_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<WorkflowBankModel>, Integer, Hash)> create_workflow_with_http_info(post_workflow_bank_model)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create Workflow
55
+ data, status_code, headers = api_instance.create_workflow_with_http_info(post_workflow_bank_model)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <WorkflowBankModel>
59
+ rescue CybridApiBank::ApiError => e
60
+ puts "Error when calling WorkflowsBankApi->create_workflow_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **post_workflow_bank_model** | [**PostWorkflowBankModel**](PostWorkflowBankModel.md) | | |
69
+
70
+ ### Return type
71
+
72
+ [**WorkflowBankModel**](WorkflowBankModel.md)
73
+
74
+ ### Authorization
75
+
76
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## get_workflow
85
+
86
+ > <WorkflowWithDetailsBankModel> get_workflow(workflow_guid)
87
+
88
+ Get Workflow
89
+
90
+ Retrieves a workflow. Required scope: **workflows:read**
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'cybrid_api_bank_ruby'
97
+ # setup authorization
98
+ CybridApiBank.configure do |config|
99
+ # Configure Bearer authorization (JWT): BearerAuth
100
+ config.access_token = 'YOUR_BEARER_TOKEN'
101
+
102
+ # Configure OAuth2 access token for authorization: oauth2
103
+ config.access_token = 'YOUR ACCESS TOKEN'
104
+ end
105
+
106
+ api_instance = CybridApiBank::WorkflowsBankApi.new
107
+ workflow_guid = 'workflow_guid_example' # String | Identifier for the workflow.
108
+
109
+ begin
110
+ # Get Workflow
111
+ result = api_instance.get_workflow(workflow_guid)
112
+ p result
113
+ rescue CybridApiBank::ApiError => e
114
+ puts "Error when calling WorkflowsBankApi->get_workflow: #{e}"
115
+ end
116
+ ```
117
+
118
+ #### Using the get_workflow_with_http_info variant
119
+
120
+ This returns an Array which contains the response data, status code and headers.
121
+
122
+ > <Array(<WorkflowWithDetailsBankModel>, Integer, Hash)> get_workflow_with_http_info(workflow_guid)
123
+
124
+ ```ruby
125
+ begin
126
+ # Get Workflow
127
+ data, status_code, headers = api_instance.get_workflow_with_http_info(workflow_guid)
128
+ p status_code # => 2xx
129
+ p headers # => { ... }
130
+ p data # => <WorkflowWithDetailsBankModel>
131
+ rescue CybridApiBank::ApiError => e
132
+ puts "Error when calling WorkflowsBankApi->get_workflow_with_http_info: #{e}"
133
+ end
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+ | Name | Type | Description | Notes |
139
+ | ---- | ---- | ----------- | ----- |
140
+ | **workflow_guid** | **String** | Identifier for the workflow. | |
141
+
142
+ ### Return type
143
+
144
+ [**WorkflowWithDetailsBankModel**](WorkflowWithDetailsBankModel.md)
145
+
146
+ ### Authorization
147
+
148
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## list_workflows
157
+
158
+ > <WorkflowsListBankModel> list_workflows(opts)
159
+
160
+ Get workflows list
161
+
162
+ Retrieves a listing of workflows. Required scope: **workflows:read**
163
+
164
+ ### Examples
165
+
166
+ ```ruby
167
+ require 'time'
168
+ require 'cybrid_api_bank_ruby'
169
+ # setup authorization
170
+ CybridApiBank.configure do |config|
171
+ # Configure Bearer authorization (JWT): BearerAuth
172
+ config.access_token = 'YOUR_BEARER_TOKEN'
173
+
174
+ # Configure OAuth2 access token for authorization: oauth2
175
+ config.access_token = 'YOUR ACCESS TOKEN'
176
+ end
177
+
178
+ api_instance = CybridApiBank::WorkflowsBankApi.new
179
+ opts = {
180
+ page: 56, # Integer | The page index to retrieve.
181
+ per_page: 56, # Integer | The number of entities per page to return.
182
+ guid: 'guid_example', # String | Comma separated workflow_guids to list workflows for.
183
+ bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list workflows for.
184
+ customer_guid: 'customer_guid_example' # String | Comma separated customer_guids to list workflows for.
185
+ }
186
+
187
+ begin
188
+ # Get workflows list
189
+ result = api_instance.list_workflows(opts)
190
+ p result
191
+ rescue CybridApiBank::ApiError => e
192
+ puts "Error when calling WorkflowsBankApi->list_workflows: #{e}"
193
+ end
194
+ ```
195
+
196
+ #### Using the list_workflows_with_http_info variant
197
+
198
+ This returns an Array which contains the response data, status code and headers.
199
+
200
+ > <Array(<WorkflowsListBankModel>, Integer, Hash)> list_workflows_with_http_info(opts)
201
+
202
+ ```ruby
203
+ begin
204
+ # Get workflows list
205
+ data, status_code, headers = api_instance.list_workflows_with_http_info(opts)
206
+ p status_code # => 2xx
207
+ p headers # => { ... }
208
+ p data # => <WorkflowsListBankModel>
209
+ rescue CybridApiBank::ApiError => e
210
+ puts "Error when calling WorkflowsBankApi->list_workflows_with_http_info: #{e}"
211
+ end
212
+ ```
213
+
214
+ ### Parameters
215
+
216
+ | Name | Type | Description | Notes |
217
+ | ---- | ---- | ----------- | ----- |
218
+ | **page** | **Integer** | The page index to retrieve. | [optional] |
219
+ | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
220
+ | **guid** | **String** | Comma separated workflow_guids to list workflows for. | [optional] |
221
+ | **bank_guid** | **String** | Comma separated bank_guids to list workflows for. | [optional] |
222
+ | **customer_guid** | **String** | Comma separated customer_guids to list workflows for. | [optional] |
223
+
224
+ ### Return type
225
+
226
+ [**WorkflowsListBankModel**](WorkflowsListBankModel.md)
227
+
228
+ ### Authorization
229
+
230
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
231
+
232
+ ### HTTP request headers
233
+
234
+ - **Content-Type**: Not defined
235
+ - **Accept**: application/json
236
+
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::WorkflowsListBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | The total number of records available. | |
8
+ | **page** | **Integer** | The page index to retrieve. | |
9
+ | **per_page** | **Integer** | The number of entities per page to return. | |
10
+ | **objects** | [**Array&lt;WorkflowBankModel&gt;**](WorkflowBankModel.md) | Array of workflow entities | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::WorkflowsListBankModel.new(
18
+ total: null,
19
+ page: null,
20
+ per_page: null,
21
+ objects: null
22
+ )
23
+ ```
24
+