mx-platform-ruby 0.5.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 523780181f868c8c9ff0ac8fb2bff613f2cea7d66698884915564f0d5df1ec5e
-  data.tar.gz: b8eeb78719c9f1ede5f426ff550d5354080c961b4fba94e9ac8bb0bc6a56e1b5
+  metadata.gz: 262c6362945060899351feb3aa49356bbfa5a234f917b2efa099f39188f4cc55
+  data.tar.gz: 3dfa97a2aa14f65c8f048f8c9e6a5bbc199bc3fef5c0ccbe58e7f11e38737aad
 SHA512:
-  metadata.gz: 15c7498cbd50b0a6bb24dd12160af3e24f7e60efd85d8277dddaa730ca1ff0d2cc9a01905104127dff5ad7809c89bbc5ed596e76697ab96682fcdb22cf6581a2
-  data.tar.gz: 7fb874e999254793c2a1cb92799ccdf55c022e143d1b5df5ce0e8937fe9468492df0a5c31fd6ba707c352874631fb295e6f16e81cd5c1bcd21b226b00e2cd6a6
+  metadata.gz: 986214ba1b32b491894c84294f03c7413a62b8fe145c485ac9965bd90285981fac989e1e8607ba48f32ecfc08e54ea8d01fe34d62be775143f43eeaa10036627
+  data.tar.gz: a0e99f8388aea551610df4241e34c57a0c4c035d6b3fd3a8da6edb5c37c1422a379846ef6ec411cb8e9ba67d3e9ca22cd74c6c99125dc5f9569a2af3fec3e2ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.5.0)
+    mx-platform-ruby (0.6.3)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -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.0.3.1)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -57,7 +57,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)
@@ -81,4 +81,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.2.29
+   2.2.32

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.5.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-java/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-java/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,
+  is_subscription: false,
+  memo: Additional-information*on_transaction,
   merchant_category_code: 5411,
-  merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b,
-  original_description: IN-N-OUT BURGER,
+  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,8 +19,10 @@ 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,
+  memo: Additional-information*on_transaction,
   merchant_category_code: 123,
   type: DEBIT
 )

data/docs/MxPlatformApi.md

@@ -2199,7 +2199,7 @@ end
 
 ## list_default_categories
 
-> <CategoriesResponseBody> list_default_categories(user_guid)
+> <CategoriesResponseBody> list_default_categories(user_guid, opts)
 
 List default categories
 
@@ -2219,10 +2219,14 @@ 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
-  result = api_instance.list_default_categories(user_guid)
+  result = api_instance.list_default_categories(user_guid, opts)
   p result
 rescue MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->list_default_categories: #{e}"
@@ -2233,12 +2237,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)
+> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid, opts)
 
 ```ruby
 begin
   # List default categories
-  data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid)
+  data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CategoriesResponseBody>
@@ -2252,6 +2256,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+| **page** | **Integer** | Specify current page. | [optional] |
+| **records_per_page** | **Integer** | Specify records per page. | [optional] |
 
 ### Return type
 
@@ -2602,6 +2608,8 @@ end
 api_instance = MxPlatformRuby::MxPlatformApi.new
 opts = {
   name: 'chase', # String | This will list only institutions in which the appended string appears.
+  page: 1, # Integer | Specify current page.
+  records_per_page: 10, # Integer | Specify records per page.
   supports_account_identification: true, # Boolean | Filter only institutions which support account identification.
   supports_account_statement: true, # Boolean | Filter only institutions which support account statements.
   supports_account_verification: true, # Boolean | Filter only institutions which support account verification.
@@ -2640,6 +2648,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | This will list only institutions in which the appended string appears. | [optional] |
+| **page** | **Integer** | Specify current page. | [optional] |
+| **records_per_page** | **Integer** | Specify records per page. | [optional] |
 | **supports_account_identification** | **Boolean** | Filter only institutions which support account identification. | [optional] |
 | **supports_account_statement** | **Boolean** | Filter only institutions which support account statements. | [optional] |
 | **supports_account_verification** | **Boolean** | Filter only institutions which support account verification. | [optional] |
@@ -3823,7 +3833,7 @@ end
 
 ## list_transactions_by_tag
 
-> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid)
+> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid, opts)
 
 List transactions by tag
 
@@ -3844,10 +3854,16 @@ end
 api_instance = MxPlatformRuby::MxPlatformApi.new
 tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
 user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+opts = {
+  from_date: '2015-09-20', # String | Filter transactions from this date.
+  page: 1, # Integer | Specify current page.
+  records_per_page: 10, # Integer | Specify records per page.
+  to_date: '2019-10-20' # String | Filter transactions to this date.
+}
 
 begin
   # List transactions by tag
-  result = api_instance.list_transactions_by_tag(tag_guid, user_guid)
+  result = api_instance.list_transactions_by_tag(tag_guid, user_guid, opts)
   p result
 rescue MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}"
@@ -3858,12 +3874,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid)
+> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
 
 ```ruby
 begin
   # List transactions by tag
-  data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid)
+  data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TransactionsResponseBody>
@@ -3878,6 +3894,10 @@ end
 | ---- | ---- | ----------- | ----- |
 | **tag_guid** | **String** | The unique id for a &#x60;tag&#x60;. |  |
 | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+| **from_date** | **String** | Filter transactions from this date. | [optional] |
+| **page** | **Integer** | Specify current page. | [optional] |
+| **records_per_page** | **Integer** | Specify records per page. | [optional] |
+| **to_date** | **String** | Filter transactions to this date. | [optional] |
 
 ### Return type
 

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,