moneykit 0.0.5 → 0.1.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3869a58667e0ec2eba963138eb49878faa33e1bb61c3b933eea0aabcc75811a7
-  data.tar.gz: 39f7e63d8554775723fe1573b1e15dca5717ea6058f3d17c84dba0f7e135a66b
+  metadata.gz: c4ba29eb796ce98ed908df12ed88224a6b0bd8c744ed37bd5a523bc281a20880
+  data.tar.gz: c75fb4d3b6850aad0bb40392c7b0742d8f9529f31a8f67dec059b0509a0895e5
 SHA512:
-  metadata.gz: a079482190f946530983c63591752e9d9939e63deae9e8e26193922780584408ea3ab50d5c0048e53044641ac43cd06df3019886280b61ce76bb21a559af2480
-  data.tar.gz: fd15e518266ab34918a79c828ae3ac6d8ce9e24adc61094ccc611b7ca0e11f70614342a6588b68f0a491f92ccfbf6c28900da671edddfef688ae421e1fc29648
+  metadata.gz: 22fdf052dd374e5a7dc49c21f7be5e773a7f0a69b36bf0cb8d49ec5e905938a883259072f0289a0f85647f344f31b89e67e7a783c829ba4cc8bf652ae1c8d2dd
+  data.tar.gz: a512620c115713531282eecfb03975c5ee61b61d8a7d4e5b4431c4d6b6be7b57c5aae7b1401374d7a3983884b20bd6706e28b06db337fd8472c6f0242e928b01

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    moneykit (0.1.0.alpha.1)
+      faraday (>= 1.0.1, < 3.0)
+      faraday-multipart
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.2.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    faraday (2.7.12)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
+    jaro_winkler (1.5.6)
+    method_source (1.0.0)
+    multipart-post (2.3.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    stringio (3.1.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  moneykit!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -1,51 +1,22 @@
-# MoneyKit (ALPHA RELEASE)
+# MoneyKit
 
-MoneyKit - the Ruby gem for the MoneyKit API
+MoneyKit is the next generation connection for the world's money.
 
-No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 0.1.0
-- Package version: 0.0.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+This is an autogenerated python SDK for OpenFGA. It provides a wrapper around the [MoneyKit API definition](https://docs.moneykit.com).
 
 ## Installation
 
-### Build a gem
-
-To build the Ruby code into a gem:
+### Bundler
 
+Use `bundle add`
 ```shell
-gem build moneykit.gemspec
+bundle add moneykit.gemspec
 ```
 
-Then either install the gem locally:
+or add the following to your `Gemfile`
 
-```shell
-gem install ./moneykit-0.0.0.gem
 ```
-
-(for development, run `gem install --dev ./moneykit-0.0.0.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
-
-Finally add this to the Gemfile:
-
-    gem 'moneykit', '~> 0.0.0'
-
-### Install from Git
-
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
-
-    gem 'moneykit', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
-
-```shell
-ruby -Ilib script.rb
+gem 'moneykit', '~> 0.1.0.alpha.1'
 ```
 
 ## Getting Started
@@ -66,7 +37,7 @@ end
 
 api_instance = MoneyKit::AccessTokenApi.new
 opts = {
-  moneykit_version: 'moneykit_version_example', # String |
+  moneykit_version: 'moneykit_version_example', # String | 
   grant_type: 'grant_type_example', # String | Token grant type. Only `client_credentials` supported.
   scope: 'scope_example', # String | Actions to be allowed for this token, given as one or more strings separated by spaces.             If omitted, all actions allowed for your application will be granted to this token.
   client_id: 'client_id_example', # String | Your application's MoneyKit client ID.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/APIErrorAuthExpiredAccessTokenResponse.md

@@ -0,0 +1,22 @@
+# MoneyKit::APIErrorAuthExpiredAccessTokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** |  | [optional][default to 'api_error.auth.expired_access_token'] |
+| **error_message** | **String** | Error message | [optional][default to 'Access token expired'] |
+| **documentation_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'moneykit'
+
+instance = MoneyKit::APIErrorAuthExpiredAccessTokenResponse.new(
+  error_code: null,
+  error_message: null,
+  documentation_url: null
+)
+```
+

data/docs/APIErrorAuthUnauthorizedResponse.md

@@ -0,0 +1,22 @@
+# MoneyKit::APIErrorAuthUnauthorizedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** |  | [optional][default to 'api_error.auth.unauthorized'] |
+| **error_message** | **String** | Error message |  |
+| **documentation_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'moneykit'
+
+instance = MoneyKit::APIErrorAuthUnauthorizedResponse.new(
+  error_code: null,
+  error_message: Accounts access not permitted,
+  documentation_url: null
+)
+```
+

data/docs/APIErrorRateLimitExceededResponse.md

@@ -0,0 +1,22 @@
+# MoneyKit::APIErrorRateLimitExceededResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **String** |  | [optional][default to 'api_error.rate_limit_exceeded'] |
+| **error_message** | **String** | Error message | [optional][default to 'Rate limit exceeded'] |
+| **documentation_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'moneykit'
+
+instance = MoneyKit::APIErrorRateLimitExceededResponse.new(
+  error_code: null,
+  error_message: null,
+  documentation_url: null
+)
+```
+

data/docs/AccessTokenApi.md

@@ -0,0 +1,232 @@
+# MoneyKit::AccessTokenApi
+
+All URIs are relative to *https://api.moneykit.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_access_token**](AccessTokenApi.md#generate_access_token) | **POST** /auth/token | /auth/token |
+| [**get_well_known_jwks**](AccessTokenApi.md#get_well_known_jwks) | **GET** /.well-known/jwks.json | JSON Web Key Set |
+| [**instrospect_client**](AccessTokenApi.md#instrospect_client) | **GET** /auth/introspect | /auth/introspect |
+
+
+## generate_access_token
+
+> <GenerateAccessTokenResponse> generate_access_token(opts)
+
+/auth/token
+
+Create a new short-lived access token by validating your `client_id` and `client_secret`.  The `access_token` is to be forwarded with all subsequent requests as `Authorization: Bearer {access_token}` HTTP header.  When the token expires you must regenerate your `access_token`.  The `client_id` and `client_secret` can be supplied as POST body parameters, or as a HTTP basic auth header.
+
+### Examples
+
+```ruby
+require 'time'
+require 'moneykit'
+# setup authorization
+MoneyKit.configure do |config|
+  # Configure HTTP basic authorization: HTTPBasic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MoneyKit::AccessTokenApi.new
+opts = {
+  moneykit_version: 'moneykit_version_example', # String | 
+  grant_type: 'grant_type_example', # String | Token grant type. Only `client_credentials` supported.
+  scope: 'scope_example', # String | Actions to be allowed for this token, given as one or more strings separated by spaces.             If omitted, all actions allowed for your application will be granted to this token.
+  client_id: 'client_id_example', # String | Your application's MoneyKit client ID.
+  client_secret: 'client_secret_example' # String | Your application's MoneyKit client secret.
+}
+
+begin
+  # /auth/token
+  result = api_instance.generate_access_token(opts)
+  p result
+rescue MoneyKit::ApiError => e
+  puts "Error when calling AccessTokenApi->generate_access_token: #{e}"
+end
+```
+
+#### Using the generate_access_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateAccessTokenResponse>, Integer, Hash)> generate_access_token_with_http_info(opts)
+
+```ruby
+begin
+  # /auth/token
+  data, status_code, headers = api_instance.generate_access_token_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateAccessTokenResponse>
+rescue MoneyKit::ApiError => e
+  puts "Error when calling AccessTokenApi->generate_access_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **moneykit_version** | **String** |  | [optional][default to &#39;2023-02-18&#39;] |
+| **grant_type** | **String** | Token grant type. Only &#x60;client_credentials&#x60; supported. | [optional] |
+| **scope** | **String** | Actions to be allowed for this token, given as one or more strings separated by spaces.             If omitted, all actions allowed for your application will be granted to this token. | [optional][default to &#39;&#39;] |
+| **client_id** | **String** | Your application&#39;s MoneyKit client ID. | [optional] |
+| **client_secret** | **String** | Your application&#39;s MoneyKit client secret. | [optional] |
+
+### Return type
+
+[**GenerateAccessTokenResponse**](GenerateAccessTokenResponse.md)
+
+### Authorization
+
+[HTTPBasic](../README.md#HTTPBasic)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## get_well_known_jwks
+
+> <JWKSet> get_well_known_jwks(opts)
+
+JSON Web Key Set
+
+The JSON Web Key Set (JWKS) is a set of keys containing the public keys used to verify webhook JSON Web Tokens (JWT) issued by MoneyKit webhooks.
+
+### Examples
+
+```ruby
+require 'time'
+require 'moneykit'
+# setup authorization
+MoneyKit.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = MoneyKit::AccessTokenApi.new
+opts = {
+  moneykit_version: 'moneykit_version_example' # String | 
+}
+
+begin
+  # JSON Web Key Set
+  result = api_instance.get_well_known_jwks(opts)
+  p result
+rescue MoneyKit::ApiError => e
+  puts "Error when calling AccessTokenApi->get_well_known_jwks: #{e}"
+end
+```
+
+#### Using the get_well_known_jwks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JWKSet>, Integer, Hash)> get_well_known_jwks_with_http_info(opts)
+
+```ruby
+begin
+  # JSON Web Key Set
+  data, status_code, headers = api_instance.get_well_known_jwks_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JWKSet>
+rescue MoneyKit::ApiError => e
+  puts "Error when calling AccessTokenApi->get_well_known_jwks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **moneykit_version** | **String** |  | [optional][default to &#39;2023-02-18&#39;] |
+
+### Return type
+
+[**JWKSet**](JWKSet.md)
+
+### Authorization
+
+[OAuth2ClientCredentials](../README.md#OAuth2ClientCredentials)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## instrospect_client
+
+> <IntrospectClientResponse> instrospect_client(opts)
+
+/auth/introspect
+
+Get details about the client and application associated with your `access_token`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'moneykit'
+# setup authorization
+MoneyKit.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = MoneyKit::AccessTokenApi.new
+opts = {
+  moneykit_version: 'moneykit_version_example' # String | 
+}
+
+begin
+  # /auth/introspect
+  result = api_instance.instrospect_client(opts)
+  p result
+rescue MoneyKit::ApiError => e
+  puts "Error when calling AccessTokenApi->instrospect_client: #{e}"
+end
+```
+
+#### Using the instrospect_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntrospectClientResponse>, Integer, Hash)> instrospect_client_with_http_info(opts)
+
+```ruby
+begin
+  # /auth/introspect
+  data, status_code, headers = api_instance.instrospect_client_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntrospectClientResponse>
+rescue MoneyKit::ApiError => e
+  puts "Error when calling AccessTokenApi->instrospect_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **moneykit_version** | **String** |  | [optional][default to &#39;2023-02-18&#39;] |
+
+### Return type
+
+[**IntrospectClientResponse**](IntrospectClientResponse.md)
+
+### Authorization
+
+[OAuth2ClientCredentials](../README.md#OAuth2ClientCredentials)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Account.md

@@ -0,0 +1,26 @@
+# MoneyKit::Account
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | MoneyKit's unique ID for the account.         <p>The `account_id` is distinct from the institution's account number.  For accounts that may change account         numbers from time to time, such as credit cards, MoneyKit attempts to keep the `account_id` constant.         However, if MoneyKit can't reconcile the new account data with the old data, the `account_id` may change. |  |
+| **account_type** | **String** | See <a href=/pages/account_types>Account Types</a> for an explanation of account types.  Account types are         dot-prefixed with one of `depository`, `investment`, `liability`, or `other`; or the value is `unknown`.         <p>**Balances for `liability` accounts are reversed:**  negative balances (the amount owed) are reported as         positive values.  For all other types of accounts, a negative balance indicates the amount owed. |  |
+| **name** | **String** | The account name, according to the institution.  Note that some institutions allow         the end user to nickname the account; in such cases this field may be the name assigned by the user. |  |
+| **account_mask** | **String** | The last four characters (usually digits) of the account number.         Note that this mask may be non-unique between accounts. | [optional] |
+| **balances** | [**AccountBalances**](AccountBalances.md) |  |  |
+
+## Example
+
+```ruby
+require 'moneykit'
+
+instance = MoneyKit::Account.new(
+  account_id: acc_6Tef269B6ZArSVpYrxtjBV,
+  account_type: depository.checking,
+  name: Premier Checking,
+  account_mask: 3748,
+  balances: null
+)
+```
+

data/docs/AccountBalances.md

@@ -0,0 +1,24 @@
+# MoneyKit::AccountBalances
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | [**Currency**](Currency.md) |  |  |
+| **available** | **Float** | The amount of funds available for use.  Not all institutions report the available balance.             <p>Note that the available balance typically does not include overdraft limits. | [optional] |
+| **current** | **Float** | The total amount of funds in the account.             <p>For credit or loan accounts, a positive number indicates the amount owed by the account holder.             If the balance is negative (this is rare), this indicates an amount owed **to** the account holder.             <p>For depository or investment accounts, a positive number is the asset value of the account.             If the balance is negative (this is rare), this indicates an overdraft or margin condition. | [optional] |
+| **limit** | **Float** | The credit limit on the account.  Typically this exists only for credit-type accounts.             <p>In some cases, this may represent the overdraft limit for depository accounts. | [optional] |
+
+## Example
+
+```ruby
+require 'moneykit'
+
+instance = MoneyKit::AccountBalances.new(
+  currency: null,
+  available: 340.12,
+  current: 445.89,
+  limit: 500
+)
+```
+

data/docs/AccountGroup.md

@@ -0,0 +1,20 @@
+# MoneyKit::AccountGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accounts** | [**Array<Account>**](Account.md) |  |  |
+| **last_synced_at** | **Time** | An ISO-8601 timestamp indicating the last time that the account was updated. | [optional] |
+
+## Example
+
+```ruby
+require 'moneykit'
+
+instance = MoneyKit::AccountGroup.new(
+  accounts: null,
+  last_synced_at: 2023-02-16T09:14:11
+)
+```
+

data/docs/AccountIdentity.md

@@ -0,0 +1,28 @@
+# MoneyKit::AccountIdentity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | MoneyKit's unique ID for the account.         <p>The `account_id` is distinct from the institution's account number.  For accounts that may change account         numbers from time to time, such as credit cards, MoneyKit attempts to keep the `account_id` constant.         However, if MoneyKit can't reconcile the new account data with the old data, the `account_id` may change. |  |
+| **account_type** | **String** | See <a href=/pages/account_types>Account Types</a> for an explanation of account types.  Account types are         dot-prefixed with one of `depository`, `investment`, `liability`, or `other`; or the value is `unknown`.         <p>**Balances for `liability` accounts are reversed:**  negative balances (the amount owed) are reported as         positive values.  For all other types of accounts, a negative balance indicates the amount owed. |  |
+| **name** | **String** | The account name, according to the institution.  Note that some institutions allow         the end user to nickname the account; in such cases this field may be the name assigned by the user. |  |
+| **account_mask** | **String** | The last four characters (usually digits) of the account number.         Note that this mask may be non-unique between accounts. | [optional] |
+| **balances** | [**AccountBalances**](AccountBalances.md) |  |  |
+| **owners** | [**Array<Owner>**](Owner.md) |  |  |
+
+## Example
+
+```ruby
+require 'moneykit'
+
+instance = MoneyKit::AccountIdentity.new(
+  account_id: acc_6Tef269B6ZArSVpYrxtjBV,
+  account_type: depository.checking,
+  name: Premier Checking,
+  account_mask: 3748,
+  balances: null,
+  owners: null
+)
+```
+

data/docs/AccountNumbers.md

@@ -0,0 +1,24 @@
+# MoneyKit::AccountNumbers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ach** | [**Array<AchNumber>**](AchNumber.md) |  |  |
+| **bacs** | [**Array<BacsNumber>**](BacsNumber.md) |  |  |
+| **eft** | [**Array<EftNumber>**](EftNumber.md) |  |  |
+| **international** | [**Array<InternationalNumber>**](InternationalNumber.md) |  |  |
+
+## Example
+
+```ruby
+require 'moneykit'
+
+instance = MoneyKit::AccountNumbers.new(
+  ach: null,
+  bacs: null,
+  eft: null,
+  international: null
+)
+```
+