mx-platform-ruby 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0dfe5713f1eadf232d11dc0fb56b6a700681c3dd3662ee9d4a28c0ad73cfd0
-  data.tar.gz: 6c0a0d3eba0d715203029ad3785c2c2d49d3c365bad34182f2f2ac7bcbb57047
+  metadata.gz: 8e1b23a7826a1747fe4e70489563eccfb6ebf00fe33a1bb3fa196d848aad5319
+  data.tar.gz: 24b24c73997bd24c5e0d98996e62c01822fa3905d0a083780b31724c38e7b42c
 SHA512:
-  metadata.gz: caec6217ce34a5f03e4d52e670d18ae5df116ae3bba0c57cd13d8b9af5507d8660cceb8a6168fbe565e9303803ce5d3c98061a33f8f2f4f92b8e9756d455eb10
-  data.tar.gz: a4ba09563cc67f49cd50c41728dcc499d1a5e4c5a441190a4e9f1aaf637d7b5466a14274a647e56703ba6160a027bece08afcb374019c43f0b5d74769c7f0b1d
+  metadata.gz: 1929b26718b7e202f2d9cba036fcc2d7f1911de6eeeac9471653caecc2465b142a22761d2b0078126c41a51c47208b8a1c2da1fa4c944fbb51a97831c63a8727
+  data.tar.gz: 418722dca6d503d7fd646955f001fb1c7778921b85aa2ef050fa23142d4c5c6b2842e114917fc21cad7039609a9f0fc636735343aeb42309ecc6f2c1ff3b3f80

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.6.0)
+    mx-platform-ruby (0.7.0)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -34,7 +34,7 @@ GEM
     method_source (1.0.0)
     multipart-post (2.1.1)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -42,7 +42,8 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    psych (4.0.2)
+    psych (4.0.3)
+      stringio
     rainbow (3.0.0)
     rake (13.0.6)
     rspec (3.10.0)
@@ -57,7 +58,7 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -68,6 +69,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
+    stringio (3.0.1)
     unicode-display_width (1.5.0)
 
 PLATFORMS
@@ -81,4 +83,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.2.30
+   2.3.4

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 MX Technologies Inc.
+Copyright (c) 2022 MX Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,14 +1,16 @@
-*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform API Ruby Library.*
+*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform Ruby library.*
 
-# mx-platform-ruby
+# MX Platform Ruby
 
-MxPlatformRuby - the Ruby gem for the MX Platform API
+The [MX Platform API](https://www.mx.com/products/platform-api) is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
 
-The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
+## Documentation
+
+Examples for the API endpoints can be found [here.](https://docs.mx.com/api)
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+## Requirements
 
-- Package version: 0.6.0
+- Ruby >= 2.6
 
 ## Installation
 
@@ -20,31 +22,28 @@ gem 'mx-platform-ruby'
 
 And then execute:
 ```shell
-$ bundle
+bundle
 ```
 
 Or install it yourself with:
 ```shell
-$ gem install mx-platform-ruby
+gem install mx-platform-ruby
 ```
 
 ## Getting Started
 
 In order to make requests, you will need to [sign up](https://dashboard.mx.com/sign_up) for the MX Platform API and get a `Client ID` and `API Key`.
 
-Please follow the [installation](#installation) procedure and then run the following code:
-
+Please follow the [installation](#installation) procedure and then run the following code to create your first User:
 ```ruby
-# Load the gem
 require 'mx-platform-ruby'
 
-# setup authorization
 MxPlatformRuby.configure do |config|
-  # Configure HTTP basic authorization
-  config.username = 'Your Client ID from https://dashboard.mx.com'
-  config.password = 'Your API Key from https://dashboard.mx.com'
+  # Configure with your Client ID/API Key from https://dashboard.mx.com
+  config.username = 'Your Client ID'
+  config.password = 'Your API Key'
 
-  # Configure server. 0 for production, 1 for development
+  # Configure environment. 0 for production, 1 for development
   config.server_index = 1
 end
 
@@ -56,7 +55,6 @@ user_create_request_body = MxPlatformRuby::UserCreateRequestBody.new(
 )
 
 begin
-  # Create user
   result = api_instance.create_user(user_create_request_body)
   p result
 rescue MxPlatformRuby::ApiError => e
@@ -64,6 +62,19 @@ rescue MxPlatformRuby::ApiError => e
 end
 ```
 
-## Documentation
+## Development
+
+This project was generated by the [OpenAPI Generator](https://openapi-generator.tech). To generate this library, verify you have the latest version of the `openapi-generator-cli` found [here.](https://github.com/OpenAPITools/openapi-generator#17---npm)
+
+Running the following command in this repo's directory will generate this library using the [MX Platform API OpenAPI spec](https://github.com/mxenabled/openapi/blob/master/openapi/mx_platform_api_beta.yml) with our [configuration and templates.](https://github.com/mxenabled/mx-platform-ruby/tree/master/openapi)
+```shell
+openapi-generator-cli generate \
+-i https://raw.githubusercontent.com/mxenabled/openapi/master/openapi/mx_platform_api_beta.yml \
+-g ruby \
+-c ./openapi/config.yml \
+-t ./openapi/templates
+```
+
+## Contributing
 
-Additional examples for the API endpoints can be found [here](docs/MxPlatformApi.md).
+Please [open an issue](https://github.com/mxenabled/mx-platform-ruby/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-ruby/pulls)

data/docs/EnhanceTransactionResponse.md

@@ -5,8 +5,12 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **amount** | **Float** |  | [optional] |
+| **categorized_by** | **Integer** |  | [optional] |
 | **category** | **String** |  | [optional] |
+| **category_guid** | **String** |  | [optional] |
+| **described_by** | **Integer** |  | [optional] |
 | **description** | **String** |  | [optional] |
+| **extended_transaction_type** | **String** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **is_bill_pay** | **Boolean** |  | [optional] |
 | **is_direct_deposit** | **Boolean** |  | [optional] |
@@ -16,8 +20,11 @@
 | **is_international** | **Boolean** |  | [optional] |
 | **is_overdraft_fee** | **Boolean** |  | [optional] |
 | **is_payroll_advance** | **Boolean** |  | [optional] |
+| **is_subscription** | **Boolean** |  | [optional] |
+| **memo** | **String** |  | [optional] |
 | **merchant_category_code** | **Integer** |  | [optional] |
 | **merchant_guid** | **String** |  | [optional] |
+| **merchant_location_guid** | **String** |  | [optional] |
 | **original_description** | **String** |  | [optional] |
 | **type** | **String** |  | [optional] |
 
@@ -28,8 +35,12 @@ require 'mx-platform-ruby'
 
 instance = MxPlatformRuby::EnhanceTransactionResponse.new(
   amount: 21.33,
-  category: Fast Food,
-  description: IN-N-OUT BURGER,
+  categorized_by: 13,
+  category: Rental Car & Taxi,
+  category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8,
+  described_by: 6,
+  description: Uber,
+  extended_transaction_type: partner_transaction_type,
   id: ID-123,
   is_bill_pay: false,
   is_direct_deposit: false,
@@ -39,9 +50,12 @@ instance = MxPlatformRuby::EnhanceTransactionResponse.new(
   is_international: false,
   is_overdraft_fee: false,
   is_payroll_advance: false,
-  merchant_category_code: 5411,
-  merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b,
-  original_description: IN-N-OUT BURGER,
+  is_subscription: false,
+  memo: Additional-information*on_transaction,
+  merchant_category_code: 4121,
+  merchant_guid: MCH-14f25b63-ef47-a38e-b2b6-d02b280b6e4e,
+  merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea,
+  original_description: ubr* pending.uber.com,
   type: DEBIT
 )
 ```

data/docs/EnhanceTransactionsRequest.md

@@ -6,7 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **amount** | **Float** |  | [optional] |
 | **description** | **String** |  |  |
+| **extended_transaction_type** | **String** |  | [optional] |
 | **id** | **String** |  |  |
+| **memo** | **String** |  | [optional] |
 | **merchant_category_code** | **Integer** |  | [optional] |
 | **type** | **String** |  | [optional] |
 
@@ -17,9 +19,11 @@ require 'mx-platform-ruby'
 
 instance = MxPlatformRuby::EnhanceTransactionsRequest.new(
   amount: 21.33,
-  description: IN-N-OUT BURGER,
+  description: ubr* pending.uber.com,
+  extended_transaction_type: partner_transaction_type,
   id: ID-123,
-  merchant_category_code: 123,
+  memo: Additional-information*on_transaction,
+  merchant_category_code: 4121,
   type: DEBIT
 )
 ```

data/docs/MxPlatformApi.md

@@ -33,7 +33,8 @@ All URIs are relative to *https://api.mx.com*
 | [**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member |
 | [**list_account_owners_by_member**](MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member |
 | [**list_categories**](MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories |
-| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories |
+| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /categories/default | List default categories |
+| [**list_default_categories_by_user**](MxPlatformApi.md#list_default_categories_by_user) | **GET** /users/{user_guid}/categories/default | List default categories by user |
 | [**list_favorite_institutions**](MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions |
 | [**list_holdings**](MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings |
 | [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member |
@@ -58,7 +59,8 @@ All URIs are relative to *https://api.mx.com*
 | [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts |
 | [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users |
 | [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account |
-| [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category |
+| [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read a custom category |
+| [**read_default_category**](MxPlatformApi.md#read_default_category) | **GET** /categories/{category_guid} | Read a default category |
 | [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding |
 | [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution |
 | [**read_managed_account**](MxPlatformApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account |
@@ -2199,11 +2201,11 @@ end
 
 ## list_default_categories
 
-> <CategoriesResponseBody> list_default_categories(user_guid, opts)
+> <CategoriesResponseBody> list_default_categories(opts)
 
 List default categories
 
-Use this endpoint to read the attributes of a specific user.
+Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
 
 ### Examples
 
@@ -2218,7 +2220,6 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::MxPlatformApi.new
-user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
 opts = {
   page: 1, # Integer | Specify current page.
   records_per_page: 10 # Integer | Specify records per page.
@@ -2226,7 +2227,7 @@ opts = {
 
 begin
   # List default categories
-  result = api_instance.list_default_categories(user_guid, opts)
+  result = api_instance.list_default_categories(opts)
   p result
 rescue MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->list_default_categories: #{e}"
@@ -2237,12 +2238,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid, opts)
+> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(opts)
 
 ```ruby
 begin
   # List default categories
-  data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid, opts)
+  data, status_code, headers = api_instance.list_default_categories_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CategoriesResponseBody>
@@ -2253,6 +2254,81 @@ end
 
 ### Parameters
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Specify current page. | [optional] |
+| **records_per_page** | **Integer** | Specify records per page. | [optional] |
+
+### Return type
+
+[**CategoriesResponseBody**](CategoriesResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## list_default_categories_by_user
+
+> <CategoriesResponseBody> list_default_categories_by_user(user_guid, opts)
+
+List default categories by user
+
+Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+opts = {
+  page: 1, # Integer | Specify current page.
+  records_per_page: 10 # Integer | Specify records per page.
+}
+
+begin
+  # List default categories by user
+  result = api_instance.list_default_categories_by_user(user_guid, opts)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->list_default_categories_by_user: #{e}"
+end
+```
+
+#### Using the list_default_categories_by_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_by_user_with_http_info(user_guid, opts)
+
+```ruby
+begin
+  # List default categories by user
+  data, status_code, headers = api_instance.list_default_categories_by_user_with_http_info(user_guid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CategoriesResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->list_default_categories_by_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
@@ -4139,7 +4215,7 @@ end
 
 > <CategoryResponseBody> read_category(category_guid, user_guid)
 
-Read category
+Read a custom category
 
 Use this endpoint to read the attributes of either a default category or a custom category.
 
@@ -4160,7 +4236,7 @@ category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique
 user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
 
 begin
-  # Read category
+  # Read a custom category
   result = api_instance.read_category(category_guid, user_guid)
   p result
 rescue MxPlatformRuby::ApiError => e
@@ -4176,7 +4252,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Read category
+  # Read a custom category
   data, status_code, headers = api_instance.read_category_with_http_info(category_guid, user_guid)
   p status_code # => 2xx
   p headers # => { ... }
@@ -4207,6 +4283,78 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## read_default_category
+
+> <CategoryResponseBody> read_default_category(category_guid, user_guid)
+
+Read a default category
+
+Use this endpoint to read the attributes of a default category.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+
+begin
+  # Read a default category
+  result = api_instance.read_default_category(category_guid, user_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->read_default_category: #{e}"
+end
+```
+
+#### Using the read_default_category_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid, user_guid)
+
+```ruby
+begin
+  # Read a default category
+  data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid, user_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CategoryResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->read_default_category_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_guid** | **String** | The unique id for a &#x60;category&#x60;. |  |
+| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+
+### Return type
+
+[**CategoryResponseBody**](CategoryResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## read_holding
 
 > <HoldingResponseBody> read_holding(holding_guid, user_guid)

data/docs/TransactionResponse.md

@@ -8,11 +8,13 @@
 | **account_id** | **String** |  | [optional] |
 | **amount** | **Float** |  | [optional] |
 | **category** | **String** |  | [optional] |
+| **category_guid** | **String** |  | [optional] |
 | **check_number_string** | **String** |  | [optional] |
 | **created_at** | **String** |  | [optional] |
 | **currency_code** | **String** |  | [optional] |
 | **date** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |
+| **extended_transaction_type** | **String** |  | [optional] |
 | **guid** | **String** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **is_bill_pay** | **Boolean** |  | [optional] |
@@ -56,11 +58,13 @@ instance = MxPlatformRuby::TransactionResponse.new(
   account_id: account123,
   amount: 61.11,
   category: Groceries,
+  category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8,
   check_number_string: 6812,
   created_at: 2016-10-06T09:43:42.000Z,
   currency_code: USD,
   date: 2013-09-23T00:00:00.000Z,
   description: Whole foods,
+  extended_transaction_type: partner_transaction_type,
   guid: TRN-265abee9-889b-af6a-c69b-25157db2bdd9,
   id: transaction-265abee9-889b-af6a-c69b-25157db2bdd9,
   is_bill_pay: false,