cybrid_api_bank_ruby 0.47.7 → 0.48.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (131) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +48 -38
  4. data/cybrid_api_bank_ruby.gemspec +2 -2
  5. data/docs/ExternalBankAccountBankModel.md +34 -0
  6. data/docs/ExternalBankAccountListBankModel.md +24 -0
  7. data/docs/ExternalBankAccountsBankApi.md +236 -0
  8. data/docs/PostExternalBankAccountBankModel.md +28 -0
  9. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +2 -2
  10. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
  11. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
  12. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
  13. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +237 -0
  14. data/lib/cybrid_api_bank_ruby/api/fee_configurations_bank_api.rb +2 -2
  15. data/lib/cybrid_api_bank_ruby/api/identity_records_bank_api.rb +2 -2
  16. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
  17. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
  18. data/lib/cybrid_api_bank_ruby/api/rewards_bank_api.rb +2 -2
  19. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
  20. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
  21. data/lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb +2 -2
  22. data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
  23. data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
  24. data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
  25. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
  26. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
  27. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
  28. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
  29. data/lib/cybrid_api_bank_ruby/models/attestation_details_bank_model.rb +2 -2
  30. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
  31. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
  32. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
  33. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
  34. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
  35. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +493 -0
  36. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +329 -0
  37. data/lib/cybrid_api_bank_ruby/models/fee_bank_model.rb +2 -2
  38. data/lib/cybrid_api_bank_ruby/models/fee_configuration_bank_model.rb +2 -2
  39. data/lib/cybrid_api_bank_ruby/models/fee_configuration_list_bank_model.rb +2 -2
  40. data/lib/cybrid_api_bank_ruby/models/identity_record_bank_model.rb +2 -2
  41. data/lib/cybrid_api_bank_ruby/models/identity_record_list_bank_model.rb +2 -2
  42. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
  43. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +2 -2
  44. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
  45. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +2 -2
  46. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +450 -0
  47. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +2 -2
  48. data/lib/cybrid_api_bank_ruby/models/post_fee_configuration_bank_model.rb +2 -2
  49. data/lib/cybrid_api_bank_ruby/models/post_identity_record_attestation_details_bank_model.rb +2 -2
  50. data/lib/cybrid_api_bank_ruby/models/post_identity_record_bank_model.rb +2 -2
  51. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +2 -2
  52. data/lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb +2 -2
  53. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
  54. data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
  56. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
  57. data/lib/cybrid_api_bank_ruby/models/reward_bank_model.rb +2 -2
  58. data/lib/cybrid_api_bank_ruby/models/reward_list_bank_model.rb +2 -2
  59. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
  60. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  61. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
  62. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +2 -2
  63. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +2 -2
  64. data/lib/cybrid_api_bank_ruby/version.rb +3 -3
  65. data/lib/cybrid_api_bank_ruby.rb +6 -2
  66. data/spec/api/accounts_bank_api_spec.rb +2 -2
  67. data/spec/api/assets_bank_api_spec.rb +2 -2
  68. data/spec/api/banks_bank_api_spec.rb +2 -2
  69. data/spec/api/customers_bank_api_spec.rb +2 -2
  70. data/spec/api/external_bank_accounts_bank_api_spec.rb +75 -0
  71. data/spec/api/fee_configurations_bank_api_spec.rb +2 -2
  72. data/spec/api/identity_records_bank_api_spec.rb +2 -2
  73. data/spec/api/prices_bank_api_spec.rb +2 -2
  74. data/spec/api/quotes_bank_api_spec.rb +2 -2
  75. data/spec/api/rewards_bank_api_spec.rb +2 -2
  76. data/spec/api/symbols_bank_api_spec.rb +2 -2
  77. data/spec/api/trades_bank_api_spec.rb +2 -2
  78. data/spec/api/verification_keys_bank_api_spec.rb +2 -2
  79. data/spec/api_client_spec.rb +2 -2
  80. data/spec/configuration_spec.rb +2 -2
  81. data/spec/models/account_bank_model_spec.rb +2 -2
  82. data/spec/models/account_list_bank_model_spec.rb +2 -2
  83. data/spec/models/asset_bank_model_spec.rb +2 -2
  84. data/spec/models/asset_list_bank_model_spec.rb +2 -2
  85. data/spec/models/attestation_details_bank_model_spec.rb +2 -2
  86. data/spec/models/bank_bank_model_spec.rb +2 -2
  87. data/spec/models/bank_list_bank_model_spec.rb +2 -2
  88. data/spec/models/customer_bank_model_spec.rb +2 -2
  89. data/spec/models/customer_list_bank_model_spec.rb +2 -2
  90. data/spec/models/error_response_bank_model_spec.rb +2 -2
  91. data/spec/models/external_bank_account_bank_model_spec.rb +90 -0
  92. data/spec/models/external_bank_account_list_bank_model_spec.rb +52 -0
  93. data/spec/models/fee_bank_model_spec.rb +2 -2
  94. data/spec/models/fee_configuration_bank_model_spec.rb +2 -2
  95. data/spec/models/fee_configuration_list_bank_model_spec.rb +2 -2
  96. data/spec/models/identity_record_bank_model_spec.rb +2 -2
  97. data/spec/models/identity_record_list_bank_model_spec.rb +2 -2
  98. data/spec/models/patch_bank_bank_model_spec.rb +2 -2
  99. data/spec/models/post_account_bank_model_spec.rb +2 -2
  100. data/spec/models/post_bank_bank_model_spec.rb +2 -2
  101. data/spec/models/post_customer_bank_model_spec.rb +2 -2
  102. data/spec/models/post_external_bank_account_bank_model_spec.rb +68 -0
  103. data/spec/models/post_fee_bank_model_spec.rb +2 -2
  104. data/spec/models/post_fee_configuration_bank_model_spec.rb +2 -2
  105. data/spec/models/post_identity_record_attestation_details_bank_model_spec.rb +2 -2
  106. data/spec/models/post_identity_record_bank_model_spec.rb +2 -2
  107. data/spec/models/post_quote_bank_model_spec.rb +2 -2
  108. data/spec/models/post_reward_bank_model_spec.rb +2 -2
  109. data/spec/models/post_trade_bank_model_spec.rb +2 -2
  110. data/spec/models/post_verification_key_bank_model_spec.rb +2 -2
  111. data/spec/models/quote_bank_model_spec.rb +2 -2
  112. data/spec/models/quote_list_bank_model_spec.rb +2 -2
  113. data/spec/models/reward_bank_model_spec.rb +2 -2
  114. data/spec/models/reward_list_bank_model_spec.rb +2 -2
  115. data/spec/models/symbol_price_bank_model_spec.rb +2 -2
  116. data/spec/models/trade_bank_model_spec.rb +2 -2
  117. data/spec/models/trade_list_bank_model_spec.rb +2 -2
  118. data/spec/models/verification_key_bank_model_spec.rb +2 -2
  119. data/spec/models/verification_key_list_bank_model_spec.rb +2 -2
  120. data/spec/spec_helper.rb +2 -2
  121. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/byebug-11.1.3/gem_make.out +2 -2
  122. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/ffi-1.15.5/gem_make.out +2 -2
  123. 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
  124. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/psych-4.0.6/gem_make.out +2 -2
  125. data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0-static/stringio-3.0.2/gem_make.out +2 -2
  126. data/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  127. data/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  128. data/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  129. data/vendor/bundle/ruby/3.1.0/gems/psych-4.0.6/ext/psych/Makefile +2 -2
  130. data/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  131. metadata +18 -2
@@ -0,0 +1,493 @@
1
+ =begin
2
+ #Cybrid Bank API
3
+
4
+ ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.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) | 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) | | 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.
5
+
6
+ The version of the OpenAPI document: v0.48.0
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 ExternalBankAccountBankModel
18
+ # Auto-generated unique identifier for the account.
19
+ attr_accessor :guid
20
+
21
+ # The name of the account.
22
+ attr_accessor :name
23
+
24
+ # The asset code.
25
+ attr_accessor :asset_code
26
+
27
+ # The type of account.
28
+ attr_accessor :account_kind
29
+
30
+ # The environment that the external bank account is operating in.
31
+ attr_accessor :environment
32
+
33
+ # The bank identifier.
34
+ attr_accessor :bank_guid
35
+
36
+ # The customer identifier.
37
+ attr_accessor :customer_guid
38
+
39
+ # ISO8601 datetime the exchange was created at.
40
+ attr_accessor :created_at
41
+
42
+ # The Plaid access token for the account.
43
+ attr_accessor :plaid_access_token
44
+
45
+ class EnumAttributeValidator
46
+ attr_reader :datatype
47
+ attr_reader :allowable_values
48
+
49
+ def initialize(datatype, allowable_values)
50
+ @allowable_values = allowable_values.map do |value|
51
+ case datatype.to_s
52
+ when /Integer/i
53
+ value.to_i
54
+ when /Float/i
55
+ value.to_f
56
+ else
57
+ value
58
+ end
59
+ end
60
+ end
61
+
62
+ def valid?(value)
63
+ !value || allowable_values.include?(value)
64
+ end
65
+ end
66
+
67
+ # Attribute mapping from ruby-style variable name to JSON key.
68
+ def self.attribute_map
69
+ {
70
+ :'guid' => :'guid',
71
+ :'name' => :'name',
72
+ :'asset_code' => :'asset_code',
73
+ :'account_kind' => :'account_kind',
74
+ :'environment' => :'environment',
75
+ :'bank_guid' => :'bank_guid',
76
+ :'customer_guid' => :'customer_guid',
77
+ :'created_at' => :'created_at',
78
+ :'plaid_access_token' => :'plaid_access_token'
79
+ }
80
+ end
81
+
82
+ # Returns all the JSON keys this model knows about
83
+ def self.acceptable_attributes
84
+ attribute_map.values
85
+ end
86
+
87
+ # Attribute type mapping.
88
+ def self.openapi_types
89
+ {
90
+ :'guid' => :'String',
91
+ :'name' => :'String',
92
+ :'asset_code' => :'String',
93
+ :'account_kind' => :'String',
94
+ :'environment' => :'String',
95
+ :'bank_guid' => :'String',
96
+ :'customer_guid' => :'String',
97
+ :'created_at' => :'Time',
98
+ :'plaid_access_token' => :'String'
99
+ }
100
+ end
101
+
102
+ # List of attributes with nullable: true
103
+ def self.openapi_nullable
104
+ Set.new([
105
+ :'bank_guid',
106
+ :'customer_guid',
107
+ :'plaid_access_token'
108
+ ])
109
+ end
110
+
111
+ # Initializes the object
112
+ # @param [Hash] attributes Model attributes in the form of hash
113
+ def initialize(attributes = {})
114
+ if (!attributes.is_a?(Hash))
115
+ fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::ExternalBankAccountBankModel` initialize method"
116
+ end
117
+
118
+ # check to see if the attribute exists and convert string to symbol for hash key
119
+ attributes = attributes.each_with_object({}) { |(k, v), h|
120
+ if (!self.class.attribute_map.key?(k.to_sym))
121
+ fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::ExternalBankAccountBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
122
+ end
123
+ h[k.to_sym] = v
124
+ }
125
+
126
+ if attributes.key?(:'guid')
127
+ self.guid = attributes[:'guid']
128
+ end
129
+
130
+ if attributes.key?(:'name')
131
+ self.name = attributes[:'name']
132
+ end
133
+
134
+ if attributes.key?(:'asset_code')
135
+ self.asset_code = attributes[:'asset_code']
136
+ end
137
+
138
+ if attributes.key?(:'account_kind')
139
+ self.account_kind = attributes[:'account_kind']
140
+ end
141
+
142
+ if attributes.key?(:'environment')
143
+ self.environment = attributes[:'environment']
144
+ end
145
+
146
+ if attributes.key?(:'bank_guid')
147
+ self.bank_guid = attributes[:'bank_guid']
148
+ end
149
+
150
+ if attributes.key?(:'customer_guid')
151
+ self.customer_guid = attributes[:'customer_guid']
152
+ end
153
+
154
+ if attributes.key?(:'created_at')
155
+ self.created_at = attributes[:'created_at']
156
+ end
157
+
158
+ if attributes.key?(:'plaid_access_token')
159
+ self.plaid_access_token = attributes[:'plaid_access_token']
160
+ end
161
+ end
162
+
163
+ # Show invalid properties with the reasons. Usually used together with valid?
164
+ # @return Array for valid properties with the reasons
165
+ def list_invalid_properties
166
+ invalid_properties = Array.new
167
+ if !@guid.nil? && @guid.to_s.length > 32
168
+ invalid_properties.push('invalid value for "guid", the character length must be smaller than or equal to 32.')
169
+ end
170
+
171
+ if !@guid.nil? && @guid.to_s.length < 32
172
+ invalid_properties.push('invalid value for "guid", the character length must be great than or equal to 32.')
173
+ end
174
+
175
+ if !@name.nil? && @name.to_s.length > 128
176
+ invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
177
+ end
178
+
179
+ if !@name.nil? && @name.to_s.length < 1
180
+ invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
181
+ end
182
+
183
+ if !@asset_code.nil? && @asset_code.to_s.length > 8
184
+ invalid_properties.push('invalid value for "asset_code", the character length must be smaller than or equal to 8.')
185
+ end
186
+
187
+ if !@asset_code.nil? && @asset_code.to_s.length < 1
188
+ invalid_properties.push('invalid value for "asset_code", the character length must be great than or equal to 1.')
189
+ end
190
+
191
+ if !@bank_guid.nil? && @bank_guid.to_s.length > 32
192
+ invalid_properties.push('invalid value for "bank_guid", the character length must be smaller than or equal to 32.')
193
+ end
194
+
195
+ if !@bank_guid.nil? && @bank_guid.to_s.length < 32
196
+ invalid_properties.push('invalid value for "bank_guid", the character length must be great than or equal to 32.')
197
+ end
198
+
199
+ if !@customer_guid.nil? && @customer_guid.to_s.length > 32
200
+ invalid_properties.push('invalid value for "customer_guid", the character length must be smaller than or equal to 32.')
201
+ end
202
+
203
+ if !@customer_guid.nil? && @customer_guid.to_s.length < 32
204
+ invalid_properties.push('invalid value for "customer_guid", the character length must be great than or equal to 32.')
205
+ end
206
+
207
+ if !@plaid_access_token.nil? && @plaid_access_token.to_s.length > 128
208
+ invalid_properties.push('invalid value for "plaid_access_token", the character length must be smaller than or equal to 128.')
209
+ end
210
+
211
+ if !@plaid_access_token.nil? && @plaid_access_token.to_s.length < 1
212
+ invalid_properties.push('invalid value for "plaid_access_token", the character length must be great than or equal to 1.')
213
+ end
214
+
215
+ invalid_properties
216
+ end
217
+
218
+ # Check to see if the all the properties in the model are valid
219
+ # @return true if the model is valid
220
+ def valid?
221
+ return false if !@guid.nil? && @guid.to_s.length > 32
222
+ return false if !@guid.nil? && @guid.to_s.length < 32
223
+ return false if !@name.nil? && @name.to_s.length > 128
224
+ return false if !@name.nil? && @name.to_s.length < 1
225
+ return false if !@asset_code.nil? && @asset_code.to_s.length > 8
226
+ return false if !@asset_code.nil? && @asset_code.to_s.length < 1
227
+ account_kind_validator = EnumAttributeValidator.new('String', ["plaid"])
228
+ return false unless account_kind_validator.valid?(@account_kind)
229
+ environment_validator = EnumAttributeValidator.new('String', ["sandbox", "production"])
230
+ return false unless environment_validator.valid?(@environment)
231
+ return false if !@bank_guid.nil? && @bank_guid.to_s.length > 32
232
+ return false if !@bank_guid.nil? && @bank_guid.to_s.length < 32
233
+ return false if !@customer_guid.nil? && @customer_guid.to_s.length > 32
234
+ return false if !@customer_guid.nil? && @customer_guid.to_s.length < 32
235
+ return false if !@plaid_access_token.nil? && @plaid_access_token.to_s.length > 128
236
+ return false if !@plaid_access_token.nil? && @plaid_access_token.to_s.length < 1
237
+ true
238
+ end
239
+
240
+ # Custom attribute writer method with validation
241
+ # @param [Object] guid Value to be assigned
242
+ def guid=(guid)
243
+ if !guid.nil? && guid.to_s.length > 32
244
+ fail ArgumentError, 'invalid value for "guid", the character length must be smaller than or equal to 32.'
245
+ end
246
+
247
+ if !guid.nil? && guid.to_s.length < 32
248
+ fail ArgumentError, 'invalid value for "guid", the character length must be great than or equal to 32.'
249
+ end
250
+
251
+ @guid = guid
252
+ end
253
+
254
+ # Custom attribute writer method with validation
255
+ # @param [Object] name Value to be assigned
256
+ def name=(name)
257
+ if !name.nil? && name.to_s.length > 128
258
+ fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 128.'
259
+ end
260
+
261
+ if !name.nil? && name.to_s.length < 1
262
+ fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
263
+ end
264
+
265
+ @name = name
266
+ end
267
+
268
+ # Custom attribute writer method with validation
269
+ # @param [Object] asset_code Value to be assigned
270
+ def asset_code=(asset_code)
271
+ if !asset_code.nil? && asset_code.to_s.length > 8
272
+ fail ArgumentError, 'invalid value for "asset_code", the character length must be smaller than or equal to 8.'
273
+ end
274
+
275
+ if !asset_code.nil? && asset_code.to_s.length < 1
276
+ fail ArgumentError, 'invalid value for "asset_code", the character length must be great than or equal to 1.'
277
+ end
278
+
279
+ @asset_code = asset_code
280
+ end
281
+
282
+ # Custom attribute writer method checking allowed values (enum).
283
+ # @param [Object] account_kind Object to be assigned
284
+ def account_kind=(account_kind)
285
+ validator = EnumAttributeValidator.new('String', ["plaid"])
286
+ unless validator.valid?(account_kind)
287
+ fail ArgumentError, "invalid value for \"account_kind\", must be one of #{validator.allowable_values}."
288
+ end
289
+ @account_kind = account_kind
290
+ end
291
+
292
+ # Custom attribute writer method checking allowed values (enum).
293
+ # @param [Object] environment Object to be assigned
294
+ def environment=(environment)
295
+ validator = EnumAttributeValidator.new('String', ["sandbox", "production"])
296
+ unless validator.valid?(environment)
297
+ fail ArgumentError, "invalid value for \"environment\", must be one of #{validator.allowable_values}."
298
+ end
299
+ @environment = environment
300
+ end
301
+
302
+ # Custom attribute writer method with validation
303
+ # @param [Object] bank_guid Value to be assigned
304
+ def bank_guid=(bank_guid)
305
+ if !bank_guid.nil? && bank_guid.to_s.length > 32
306
+ fail ArgumentError, 'invalid value for "bank_guid", the character length must be smaller than or equal to 32.'
307
+ end
308
+
309
+ if !bank_guid.nil? && bank_guid.to_s.length < 32
310
+ fail ArgumentError, 'invalid value for "bank_guid", the character length must be great than or equal to 32.'
311
+ end
312
+
313
+ @bank_guid = bank_guid
314
+ end
315
+
316
+ # Custom attribute writer method with validation
317
+ # @param [Object] customer_guid Value to be assigned
318
+ def customer_guid=(customer_guid)
319
+ if !customer_guid.nil? && customer_guid.to_s.length > 32
320
+ fail ArgumentError, 'invalid value for "customer_guid", the character length must be smaller than or equal to 32.'
321
+ end
322
+
323
+ if !customer_guid.nil? && customer_guid.to_s.length < 32
324
+ fail ArgumentError, 'invalid value for "customer_guid", the character length must be great than or equal to 32.'
325
+ end
326
+
327
+ @customer_guid = customer_guid
328
+ end
329
+
330
+ # Custom attribute writer method with validation
331
+ # @param [Object] plaid_access_token Value to be assigned
332
+ def plaid_access_token=(plaid_access_token)
333
+ if !plaid_access_token.nil? && plaid_access_token.to_s.length > 128
334
+ fail ArgumentError, 'invalid value for "plaid_access_token", the character length must be smaller than or equal to 128.'
335
+ end
336
+
337
+ if !plaid_access_token.nil? && plaid_access_token.to_s.length < 1
338
+ fail ArgumentError, 'invalid value for "plaid_access_token", the character length must be great than or equal to 1.'
339
+ end
340
+
341
+ @plaid_access_token = plaid_access_token
342
+ end
343
+
344
+ # Checks equality by comparing each attribute.
345
+ # @param [Object] Object to be compared
346
+ def ==(o)
347
+ return true if self.equal?(o)
348
+ self.class == o.class &&
349
+ guid == o.guid &&
350
+ name == o.name &&
351
+ asset_code == o.asset_code &&
352
+ account_kind == o.account_kind &&
353
+ environment == o.environment &&
354
+ bank_guid == o.bank_guid &&
355
+ customer_guid == o.customer_guid &&
356
+ created_at == o.created_at &&
357
+ plaid_access_token == o.plaid_access_token
358
+ end
359
+
360
+ # @see the `==` method
361
+ # @param [Object] Object to be compared
362
+ def eql?(o)
363
+ self == o
364
+ end
365
+
366
+ # Calculates hash code according to all attributes.
367
+ # @return [Integer] Hash code
368
+ def hash
369
+ [guid, name, asset_code, account_kind, environment, bank_guid, customer_guid, created_at, plaid_access_token].hash
370
+ end
371
+
372
+ # Builds the object from hash
373
+ # @param [Hash] attributes Model attributes in the form of hash
374
+ # @return [Object] Returns the model itself
375
+ def self.build_from_hash(attributes)
376
+ new.build_from_hash(attributes)
377
+ end
378
+
379
+ # Builds the object from hash
380
+ # @param [Hash] attributes Model attributes in the form of hash
381
+ # @return [Object] Returns the model itself
382
+ def build_from_hash(attributes)
383
+ return nil unless attributes.is_a?(Hash)
384
+ attributes = attributes.transform_keys(&:to_sym)
385
+ self.class.openapi_types.each_pair do |key, type|
386
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
387
+ self.send("#{key}=", nil)
388
+ elsif type =~ /\AArray<(.*)>/i
389
+ # check to ensure the input is an array given that the attribute
390
+ # is documented as an array but the input is not
391
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
392
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
393
+ end
394
+ elsif !attributes[self.class.attribute_map[key]].nil?
395
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
396
+ end
397
+ end
398
+
399
+ self
400
+ end
401
+
402
+ # Deserializes the data based on type
403
+ # @param string type Data type
404
+ # @param string value Value to be deserialized
405
+ # @return [Object] Deserialized data
406
+ def _deserialize(type, value)
407
+ case type.to_sym
408
+ when :Time
409
+ Time.parse(value)
410
+ when :Date
411
+ Date.parse(value)
412
+ when :String
413
+ value.to_s
414
+ when :Integer
415
+ value.to_i
416
+ when :Float
417
+ value.to_f
418
+ when :Boolean
419
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
420
+ true
421
+ else
422
+ false
423
+ end
424
+ when :Object
425
+ # generic object (usually a Hash), return directly
426
+ value
427
+ when /\AArray<(?<inner_type>.+)>\z/
428
+ inner_type = Regexp.last_match[:inner_type]
429
+ value.map { |v| _deserialize(inner_type, v) }
430
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
431
+ k_type = Regexp.last_match[:k_type]
432
+ v_type = Regexp.last_match[:v_type]
433
+ {}.tap do |hash|
434
+ value.each do |k, v|
435
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
436
+ end
437
+ end
438
+ else # model
439
+ # models (e.g. Pet) or oneOf
440
+ klass = CybridApiBank.const_get(type)
441
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
442
+ end
443
+ end
444
+
445
+ # Returns the string representation of the object
446
+ # @return [String] String presentation of the object
447
+ def to_s
448
+ to_hash.to_s
449
+ end
450
+
451
+ # to_body is an alias to to_hash (backward compatibility)
452
+ # @return [Hash] Returns the object in the form of hash
453
+ def to_body
454
+ to_hash
455
+ end
456
+
457
+ # Returns the object in the form of hash
458
+ # @return [Hash] Returns the object in the form of hash
459
+ def to_hash
460
+ hash = {}
461
+ self.class.attribute_map.each_pair do |attr, param|
462
+ value = self.send(attr)
463
+ if value.nil?
464
+ is_nullable = self.class.openapi_nullable.include?(attr)
465
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
466
+ end
467
+
468
+ hash[param] = _to_hash(value)
469
+ end
470
+ hash
471
+ end
472
+
473
+ # Outputs non-array value in the form of hash
474
+ # For object, use to_hash. Otherwise, just return the value
475
+ # @param [Object] value Any valid value
476
+ # @return [Hash] Returns the value in the form of hash
477
+ def _to_hash(value)
478
+ if value.is_a?(Array)
479
+ value.compact.map { |v| _to_hash(v) }
480
+ elsif value.is_a?(Hash)
481
+ {}.tap do |hash|
482
+ value.each { |k, v| hash[k] = _to_hash(v) }
483
+ end
484
+ elsif value.respond_to? :to_hash
485
+ value.to_hash
486
+ else
487
+ value
488
+ end
489
+ end
490
+
491
+ end
492
+
493
+ end