cybrid_api_bank_ruby 0.30.3 → 0.30.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (132) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +9 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/CustomerBankModel.md +2 -2
  6. data/docs/ExchangeSettlementBankModel.md +30 -0
  7. data/docs/ExchangeSettlementExpectedPaymentBankModel.md +32 -0
  8. data/docs/ExchangeSettlementObligationBankModel.md +28 -0
  9. data/docs/ExchangeSettlementPaymentOrderBankModel.md +36 -0
  10. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  11. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/identity_records_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api/trading_configurations_bank_api.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/models/attestation_details_bank_model.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +15 -15
  32. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/cybrid_account_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/exchange_account_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/exchange_bank_model.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/models/exchange_list_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/exchange_settlement_bank_model.rb +392 -0
  39. data/lib/cybrid_api_bank_ruby/models/exchange_settlement_expected_payment_bank_model.rb +408 -0
  40. data/lib/cybrid_api_bank_ruby/models/exchange_settlement_obligation_bank_model.rb +376 -0
  41. data/lib/cybrid_api_bank_ruby/models/exchange_settlement_payment_order_bank_model.rb +464 -0
  42. data/lib/cybrid_api_bank_ruby/models/fee_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/identity_record_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/identity_record_list_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/post_identity_record_attestation_details_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/post_identity_record_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/post_trading_configuration_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/system_account_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/trading_configuration_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/trading_configuration_list_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  66. data/lib/cybrid_api_bank_ruby.rb +5 -1
  67. data/spec/api/accounts_bank_api_spec.rb +1 -1
  68. data/spec/api/assets_bank_api_spec.rb +1 -1
  69. data/spec/api/banks_bank_api_spec.rb +1 -1
  70. data/spec/api/customers_bank_api_spec.rb +1 -1
  71. data/spec/api/identity_records_bank_api_spec.rb +1 -1
  72. data/spec/api/prices_bank_api_spec.rb +1 -1
  73. data/spec/api/quotes_bank_api_spec.rb +1 -1
  74. data/spec/api/symbols_bank_api_spec.rb +1 -1
  75. data/spec/api/trades_bank_api_spec.rb +1 -1
  76. data/spec/api/trading_configurations_bank_api_spec.rb +1 -1
  77. data/spec/api/verification_keys_bank_api_spec.rb +1 -1
  78. data/spec/api_client_spec.rb +1 -1
  79. data/spec/configuration_spec.rb +1 -1
  80. data/spec/models/account_bank_model_spec.rb +1 -1
  81. data/spec/models/account_list_bank_model_spec.rb +1 -1
  82. data/spec/models/asset_bank_model_spec.rb +1 -1
  83. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  84. data/spec/models/attestation_details_bank_model_spec.rb +1 -1
  85. data/spec/models/bank_bank_model_spec.rb +1 -1
  86. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  87. data/spec/models/customer_bank_model_spec.rb +3 -3
  88. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  89. data/spec/models/cybrid_account_bank_model_spec.rb +1 -1
  90. data/spec/models/error_response_bank_model_spec.rb +1 -1
  91. data/spec/models/exchange_account_bank_model_spec.rb +1 -1
  92. data/spec/models/exchange_bank_model_spec.rb +1 -1
  93. data/spec/models/exchange_list_bank_model_spec.rb +1 -1
  94. data/spec/models/exchange_settlement_bank_model_spec.rb +74 -0
  95. data/spec/models/exchange_settlement_expected_payment_bank_model_spec.rb +84 -0
  96. data/spec/models/exchange_settlement_obligation_bank_model_spec.rb +68 -0
  97. data/spec/models/exchange_settlement_payment_order_bank_model_spec.rb +100 -0
  98. data/spec/models/fee_bank_model_spec.rb +1 -1
  99. data/spec/models/identity_record_bank_model_spec.rb +1 -1
  100. data/spec/models/identity_record_list_bank_model_spec.rb +1 -1
  101. data/spec/models/post_account_bank_model_spec.rb +1 -1
  102. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  103. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  104. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  105. data/spec/models/post_identity_record_attestation_details_bank_model_spec.rb +1 -1
  106. data/spec/models/post_identity_record_bank_model_spec.rb +1 -1
  107. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  108. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  109. data/spec/models/post_trading_configuration_bank_model_spec.rb +1 -1
  110. data/spec/models/post_verification_key_bank_model_spec.rb +1 -1
  111. data/spec/models/quote_bank_model_spec.rb +1 -1
  112. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  113. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  114. data/spec/models/system_account_bank_model_spec.rb +1 -1
  115. data/spec/models/trade_bank_model_spec.rb +1 -1
  116. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  117. data/spec/models/trading_configuration_bank_model_spec.rb +1 -1
  118. data/spec/models/trading_configuration_list_bank_model_spec.rb +1 -1
  119. data/spec/models/verification_key_bank_model_spec.rb +1 -1
  120. data/spec/models/verification_key_list_bank_model_spec.rb +1 -1
  121. data/spec/spec_helper.rb +1 -1
  122. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out +2 -2
  123. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out +2 -2
  124. 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
  125. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.4/gem_make.out +2 -2
  126. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out +2 -2
  127. data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  128. data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  129. data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  130. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.4/ext/psych/Makefile +2 -2
  131. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  132. metadata +18 -2
@@ -0,0 +1,464 @@
1
+ =begin
2
+ #Cybrid Bank API
3
+
4
+ ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
+
6
+ The version of the OpenAPI document: v0.30.6
7
+ Contact: support@cybrid.app
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module CybridApiBank
17
+ class ExchangeSettlementPaymentOrderBankModel
18
+ # Auto-generated unique identifier for the exchange settlement payment order.
19
+ attr_accessor :guid
20
+
21
+ # The identifier of the exchange settlement obligation that this payment is associated with.
22
+ attr_accessor :exchange_settlement_obligation_guid
23
+
24
+ # The sequence number of the payment order
25
+ attr_accessor :sequence_number
26
+
27
+ # The amount expected to be received as part of this payment.
28
+ attr_accessor :payment_amount
29
+
30
+ # The identifier of the internal account that is expected to originate the payment.
31
+ attr_accessor :internal_account_guid
32
+
33
+ # The type of the internal account that is expected to originate the payment.
34
+ attr_accessor :internal_account_type
35
+
36
+ # The identifier of the external account that is expected to receive the payment.
37
+ attr_accessor :external_account_guid
38
+
39
+ # The type of the external account that is expected to receive the payment.
40
+ attr_accessor :external_account_type
41
+
42
+ # The exchange settlement payment order's state
43
+ attr_accessor :state
44
+
45
+ # ISO8601 datetime the exchange settlement payment order was created at.
46
+ attr_accessor :created_at
47
+
48
+ class EnumAttributeValidator
49
+ attr_reader :datatype
50
+ attr_reader :allowable_values
51
+
52
+ def initialize(datatype, allowable_values)
53
+ @allowable_values = allowable_values.map do |value|
54
+ case datatype.to_s
55
+ when /Integer/i
56
+ value.to_i
57
+ when /Float/i
58
+ value.to_f
59
+ else
60
+ value
61
+ end
62
+ end
63
+ end
64
+
65
+ def valid?(value)
66
+ !value || allowable_values.include?(value)
67
+ end
68
+ end
69
+
70
+ # Attribute mapping from ruby-style variable name to JSON key.
71
+ def self.attribute_map
72
+ {
73
+ :'guid' => :'guid',
74
+ :'exchange_settlement_obligation_guid' => :'exchange_settlement_obligation_guid',
75
+ :'sequence_number' => :'sequence_number',
76
+ :'payment_amount' => :'payment_amount',
77
+ :'internal_account_guid' => :'internal_account_guid',
78
+ :'internal_account_type' => :'internal_account_type',
79
+ :'external_account_guid' => :'external_account_guid',
80
+ :'external_account_type' => :'external_account_type',
81
+ :'state' => :'state',
82
+ :'created_at' => :'created_at'
83
+ }
84
+ end
85
+
86
+ # Returns all the JSON keys this model knows about
87
+ def self.acceptable_attributes
88
+ attribute_map.values
89
+ end
90
+
91
+ # Attribute type mapping.
92
+ def self.openapi_types
93
+ {
94
+ :'guid' => :'String',
95
+ :'exchange_settlement_obligation_guid' => :'String',
96
+ :'sequence_number' => :'Integer',
97
+ :'payment_amount' => :'Integer',
98
+ :'internal_account_guid' => :'String',
99
+ :'internal_account_type' => :'String',
100
+ :'external_account_guid' => :'String',
101
+ :'external_account_type' => :'String',
102
+ :'state' => :'String',
103
+ :'created_at' => :'Time'
104
+ }
105
+ end
106
+
107
+ # List of attributes with nullable: true
108
+ def self.openapi_nullable
109
+ Set.new([
110
+ ])
111
+ end
112
+
113
+ # Initializes the object
114
+ # @param [Hash] attributes Model attributes in the form of hash
115
+ def initialize(attributes = {})
116
+ if (!attributes.is_a?(Hash))
117
+ fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::ExchangeSettlementPaymentOrderBankModel` initialize method"
118
+ end
119
+
120
+ # check to see if the attribute exists and convert string to symbol for hash key
121
+ attributes = attributes.each_with_object({}) { |(k, v), h|
122
+ if (!self.class.attribute_map.key?(k.to_sym))
123
+ fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::ExchangeSettlementPaymentOrderBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
124
+ end
125
+ h[k.to_sym] = v
126
+ }
127
+
128
+ if attributes.key?(:'guid')
129
+ self.guid = attributes[:'guid']
130
+ end
131
+
132
+ if attributes.key?(:'exchange_settlement_obligation_guid')
133
+ self.exchange_settlement_obligation_guid = attributes[:'exchange_settlement_obligation_guid']
134
+ end
135
+
136
+ if attributes.key?(:'sequence_number')
137
+ self.sequence_number = attributes[:'sequence_number']
138
+ end
139
+
140
+ if attributes.key?(:'payment_amount')
141
+ self.payment_amount = attributes[:'payment_amount']
142
+ end
143
+
144
+ if attributes.key?(:'internal_account_guid')
145
+ self.internal_account_guid = attributes[:'internal_account_guid']
146
+ end
147
+
148
+ if attributes.key?(:'internal_account_type')
149
+ self.internal_account_type = attributes[:'internal_account_type']
150
+ end
151
+
152
+ if attributes.key?(:'external_account_guid')
153
+ self.external_account_guid = attributes[:'external_account_guid']
154
+ end
155
+
156
+ if attributes.key?(:'external_account_type')
157
+ self.external_account_type = attributes[:'external_account_type']
158
+ end
159
+
160
+ if attributes.key?(:'state')
161
+ self.state = attributes[:'state']
162
+ end
163
+
164
+ if attributes.key?(:'created_at')
165
+ self.created_at = attributes[:'created_at']
166
+ end
167
+ end
168
+
169
+ # Show invalid properties with the reasons. Usually used together with valid?
170
+ # @return Array for valid properties with the reasons
171
+ def list_invalid_properties
172
+ invalid_properties = Array.new
173
+ if !@guid.nil? && @guid.to_s.length > 32
174
+ invalid_properties.push('invalid value for "guid", the character length must be smaller than or equal to 32.')
175
+ end
176
+
177
+ if !@guid.nil? && @guid.to_s.length < 32
178
+ invalid_properties.push('invalid value for "guid", the character length must be great than or equal to 32.')
179
+ end
180
+
181
+ if !@exchange_settlement_obligation_guid.nil? && @exchange_settlement_obligation_guid.to_s.length > 32
182
+ invalid_properties.push('invalid value for "exchange_settlement_obligation_guid", the character length must be smaller than or equal to 32.')
183
+ end
184
+
185
+ if !@exchange_settlement_obligation_guid.nil? && @exchange_settlement_obligation_guid.to_s.length < 32
186
+ invalid_properties.push('invalid value for "exchange_settlement_obligation_guid", the character length must be great than or equal to 32.')
187
+ end
188
+
189
+ if !@internal_account_guid.nil? && @internal_account_guid.to_s.length > 32
190
+ invalid_properties.push('invalid value for "internal_account_guid", the character length must be smaller than or equal to 32.')
191
+ end
192
+
193
+ if !@internal_account_guid.nil? && @internal_account_guid.to_s.length < 32
194
+ invalid_properties.push('invalid value for "internal_account_guid", the character length must be great than or equal to 32.')
195
+ end
196
+
197
+ if !@external_account_guid.nil? && @external_account_guid.to_s.length > 32
198
+ invalid_properties.push('invalid value for "external_account_guid", the character length must be smaller than or equal to 32.')
199
+ end
200
+
201
+ if !@external_account_guid.nil? && @external_account_guid.to_s.length < 32
202
+ invalid_properties.push('invalid value for "external_account_guid", the character length must be great than or equal to 32.')
203
+ end
204
+
205
+ invalid_properties
206
+ end
207
+
208
+ # Check to see if the all the properties in the model are valid
209
+ # @return true if the model is valid
210
+ def valid?
211
+ return false if !@guid.nil? && @guid.to_s.length > 32
212
+ return false if !@guid.nil? && @guid.to_s.length < 32
213
+ return false if !@exchange_settlement_obligation_guid.nil? && @exchange_settlement_obligation_guid.to_s.length > 32
214
+ return false if !@exchange_settlement_obligation_guid.nil? && @exchange_settlement_obligation_guid.to_s.length < 32
215
+ return false if !@internal_account_guid.nil? && @internal_account_guid.to_s.length > 32
216
+ return false if !@internal_account_guid.nil? && @internal_account_guid.to_s.length < 32
217
+ internal_account_type_validator = EnumAttributeValidator.new('String', ["internal_wallet", "internal_bank_account"])
218
+ return false unless internal_account_type_validator.valid?(@internal_account_type)
219
+ return false if !@external_account_guid.nil? && @external_account_guid.to_s.length > 32
220
+ return false if !@external_account_guid.nil? && @external_account_guid.to_s.length < 32
221
+ external_account_type_validator = EnumAttributeValidator.new('String', ["external_wallet", "external_bank_account"])
222
+ return false unless external_account_type_validator.valid?(@external_account_type)
223
+ state_validator = EnumAttributeValidator.new('String', ["storing", "pending__created", "pending__principal_reserved", "pending__transactions_claimed", "not_approved", "in_progress", "not_owing", "amount_incorrect", "invalid_principal", "nsf", "sent", "rejected"])
224
+ return false unless state_validator.valid?(@state)
225
+ true
226
+ end
227
+
228
+ # Custom attribute writer method with validation
229
+ # @param [Object] guid Value to be assigned
230
+ def guid=(guid)
231
+ if !guid.nil? && guid.to_s.length > 32
232
+ fail ArgumentError, 'invalid value for "guid", the character length must be smaller than or equal to 32.'
233
+ end
234
+
235
+ if !guid.nil? && guid.to_s.length < 32
236
+ fail ArgumentError, 'invalid value for "guid", the character length must be great than or equal to 32.'
237
+ end
238
+
239
+ @guid = guid
240
+ end
241
+
242
+ # Custom attribute writer method with validation
243
+ # @param [Object] exchange_settlement_obligation_guid Value to be assigned
244
+ def exchange_settlement_obligation_guid=(exchange_settlement_obligation_guid)
245
+ if !exchange_settlement_obligation_guid.nil? && exchange_settlement_obligation_guid.to_s.length > 32
246
+ fail ArgumentError, 'invalid value for "exchange_settlement_obligation_guid", the character length must be smaller than or equal to 32.'
247
+ end
248
+
249
+ if !exchange_settlement_obligation_guid.nil? && exchange_settlement_obligation_guid.to_s.length < 32
250
+ fail ArgumentError, 'invalid value for "exchange_settlement_obligation_guid", the character length must be great than or equal to 32.'
251
+ end
252
+
253
+ @exchange_settlement_obligation_guid = exchange_settlement_obligation_guid
254
+ end
255
+
256
+ # Custom attribute writer method with validation
257
+ # @param [Object] internal_account_guid Value to be assigned
258
+ def internal_account_guid=(internal_account_guid)
259
+ if !internal_account_guid.nil? && internal_account_guid.to_s.length > 32
260
+ fail ArgumentError, 'invalid value for "internal_account_guid", the character length must be smaller than or equal to 32.'
261
+ end
262
+
263
+ if !internal_account_guid.nil? && internal_account_guid.to_s.length < 32
264
+ fail ArgumentError, 'invalid value for "internal_account_guid", the character length must be great than or equal to 32.'
265
+ end
266
+
267
+ @internal_account_guid = internal_account_guid
268
+ end
269
+
270
+ # Custom attribute writer method checking allowed values (enum).
271
+ # @param [Object] internal_account_type Object to be assigned
272
+ def internal_account_type=(internal_account_type)
273
+ validator = EnumAttributeValidator.new('String', ["internal_wallet", "internal_bank_account"])
274
+ unless validator.valid?(internal_account_type)
275
+ fail ArgumentError, "invalid value for \"internal_account_type\", must be one of #{validator.allowable_values}."
276
+ end
277
+ @internal_account_type = internal_account_type
278
+ end
279
+
280
+ # Custom attribute writer method with validation
281
+ # @param [Object] external_account_guid Value to be assigned
282
+ def external_account_guid=(external_account_guid)
283
+ if !external_account_guid.nil? && external_account_guid.to_s.length > 32
284
+ fail ArgumentError, 'invalid value for "external_account_guid", the character length must be smaller than or equal to 32.'
285
+ end
286
+
287
+ if !external_account_guid.nil? && external_account_guid.to_s.length < 32
288
+ fail ArgumentError, 'invalid value for "external_account_guid", the character length must be great than or equal to 32.'
289
+ end
290
+
291
+ @external_account_guid = external_account_guid
292
+ end
293
+
294
+ # Custom attribute writer method checking allowed values (enum).
295
+ # @param [Object] external_account_type Object to be assigned
296
+ def external_account_type=(external_account_type)
297
+ validator = EnumAttributeValidator.new('String', ["external_wallet", "external_bank_account"])
298
+ unless validator.valid?(external_account_type)
299
+ fail ArgumentError, "invalid value for \"external_account_type\", must be one of #{validator.allowable_values}."
300
+ end
301
+ @external_account_type = external_account_type
302
+ end
303
+
304
+ # Custom attribute writer method checking allowed values (enum).
305
+ # @param [Object] state Object to be assigned
306
+ def state=(state)
307
+ validator = EnumAttributeValidator.new('String', ["storing", "pending__created", "pending__principal_reserved", "pending__transactions_claimed", "not_approved", "in_progress", "not_owing", "amount_incorrect", "invalid_principal", "nsf", "sent", "rejected"])
308
+ unless validator.valid?(state)
309
+ fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
310
+ end
311
+ @state = state
312
+ end
313
+
314
+ # Checks equality by comparing each attribute.
315
+ # @param [Object] Object to be compared
316
+ def ==(o)
317
+ return true if self.equal?(o)
318
+ self.class == o.class &&
319
+ guid == o.guid &&
320
+ exchange_settlement_obligation_guid == o.exchange_settlement_obligation_guid &&
321
+ sequence_number == o.sequence_number &&
322
+ payment_amount == o.payment_amount &&
323
+ internal_account_guid == o.internal_account_guid &&
324
+ internal_account_type == o.internal_account_type &&
325
+ external_account_guid == o.external_account_guid &&
326
+ external_account_type == o.external_account_type &&
327
+ state == o.state &&
328
+ created_at == o.created_at
329
+ end
330
+
331
+ # @see the `==` method
332
+ # @param [Object] Object to be compared
333
+ def eql?(o)
334
+ self == o
335
+ end
336
+
337
+ # Calculates hash code according to all attributes.
338
+ # @return [Integer] Hash code
339
+ def hash
340
+ [guid, exchange_settlement_obligation_guid, sequence_number, payment_amount, internal_account_guid, internal_account_type, external_account_guid, external_account_type, state, created_at].hash
341
+ end
342
+
343
+ # Builds the object from hash
344
+ # @param [Hash] attributes Model attributes in the form of hash
345
+ # @return [Object] Returns the model itself
346
+ def self.build_from_hash(attributes)
347
+ new.build_from_hash(attributes)
348
+ end
349
+
350
+ # Builds the object from hash
351
+ # @param [Hash] attributes Model attributes in the form of hash
352
+ # @return [Object] Returns the model itself
353
+ def build_from_hash(attributes)
354
+ return nil unless attributes.is_a?(Hash)
355
+ attributes = attributes.transform_keys(&:to_sym)
356
+ self.class.openapi_types.each_pair do |key, type|
357
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
358
+ self.send("#{key}=", nil)
359
+ elsif type =~ /\AArray<(.*)>/i
360
+ # check to ensure the input is an array given that the attribute
361
+ # is documented as an array but the input is not
362
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
363
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
364
+ end
365
+ elsif !attributes[self.class.attribute_map[key]].nil?
366
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
367
+ end
368
+ end
369
+
370
+ self
371
+ end
372
+
373
+ # Deserializes the data based on type
374
+ # @param string type Data type
375
+ # @param string value Value to be deserialized
376
+ # @return [Object] Deserialized data
377
+ def _deserialize(type, value)
378
+ case type.to_sym
379
+ when :Time
380
+ Time.parse(value)
381
+ when :Date
382
+ Date.parse(value)
383
+ when :String
384
+ value.to_s
385
+ when :Integer
386
+ value.to_i
387
+ when :Float
388
+ value.to_f
389
+ when :Boolean
390
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
391
+ true
392
+ else
393
+ false
394
+ end
395
+ when :Object
396
+ # generic object (usually a Hash), return directly
397
+ value
398
+ when /\AArray<(?<inner_type>.+)>\z/
399
+ inner_type = Regexp.last_match[:inner_type]
400
+ value.map { |v| _deserialize(inner_type, v) }
401
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
402
+ k_type = Regexp.last_match[:k_type]
403
+ v_type = Regexp.last_match[:v_type]
404
+ {}.tap do |hash|
405
+ value.each do |k, v|
406
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
407
+ end
408
+ end
409
+ else # model
410
+ # models (e.g. Pet) or oneOf
411
+ klass = CybridApiBank.const_get(type)
412
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
413
+ end
414
+ end
415
+
416
+ # Returns the string representation of the object
417
+ # @return [String] String presentation of the object
418
+ def to_s
419
+ to_hash.to_s
420
+ end
421
+
422
+ # to_body is an alias to to_hash (backward compatibility)
423
+ # @return [Hash] Returns the object in the form of hash
424
+ def to_body
425
+ to_hash
426
+ end
427
+
428
+ # Returns the object in the form of hash
429
+ # @return [Hash] Returns the object in the form of hash
430
+ def to_hash
431
+ hash = {}
432
+ self.class.attribute_map.each_pair do |attr, param|
433
+ value = self.send(attr)
434
+ if value.nil?
435
+ is_nullable = self.class.openapi_nullable.include?(attr)
436
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
437
+ end
438
+
439
+ hash[param] = _to_hash(value)
440
+ end
441
+ hash
442
+ end
443
+
444
+ # Outputs non-array value in the form of hash
445
+ # For object, use to_hash. Otherwise, just return the value
446
+ # @param [Object] value Any valid value
447
+ # @return [Hash] Returns the value in the form of hash
448
+ def _to_hash(value)
449
+ if value.is_a?(Array)
450
+ value.compact.map { |v| _to_hash(v) }
451
+ elsif value.is_a?(Hash)
452
+ {}.tap do |hash|
453
+ value.each { |k, v| hash[k] = _to_hash(v) }
454
+ end
455
+ elsif value.respond_to? :to_hash
456
+ value.to_hash
457
+ else
458
+ value
459
+ end
460
+ end
461
+
462
+ end
463
+
464
+ end
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.30.3
6
+ The version of the OpenAPI document: v0.30.6
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.30.3
6
+ The version of the OpenAPI document: v0.30.6
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.30.3
6
+ The version of the OpenAPI document: v0.30.6
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.30.3
6
+ The version of the OpenAPI document: v0.30.6
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.30.3
6
+ The version of the OpenAPI document: v0.30.6
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.30.3
6
+ The version of the OpenAPI document: v0.30.6
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.30.3
6
+ The version of the OpenAPI document: v0.30.6
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. 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 | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **Never share your Client ID or Secret publicly or in your source code repository** 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: ``` 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\": \"<Your requested scopes -- space separated>\" }' -H \"Content-Type: application/json\" ``` ## 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## 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. 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. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.30.3
6
+ The version of the OpenAPI document: v0.30.6
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0