Merge pull request #34 from mxenabled/bm/add_query_params

Add query params

Author: brettmortensen

.github/workflows/auto_tag.yml

@@ -0,0 +1,19 @@
+name: Automatic Tagging
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: butlerlogic/action-autotag@stable
+      with:
+        GITHUB_TOKEN: "${{ secrets.TAG_AND_RELEASE_TOKEN }}"
+        commit_message_template: "({{number}} {{message}})"
+        tag_prefix: "v"
+        strategy: regex
+        root: "/lib/mx-platform-ruby/version.rb"
+        regex_pattern: "[\d.]+"

.github/workflows/github_release.yml

@@ -0,0 +1,18 @@
+name: GitHub Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  tagged-release:
+    name: "Tagged Release"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Release"
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.TAG_AND_RELEASE_TOKEN }}"
+          prerelease: false

.github/workflows/release.yml .github/workflows/rubygems_release.yml.github/workflows/release.yml renamed to .github/workflows/rubygems_release.yml

@@ -1,4 +1,4 @@
-name: Release
+name: RubyGems Release
 
 on:
   push:

README.md

@@ -8,7 +8,7 @@ The MX Platform API is a powerful, fully-featured API designed to make aggregati
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- Package version: 0.5.0
+- Package version: 0.6.0
 
 ## Installation
 

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
 

lib/mx-platform-ruby/api/mx_platform_api.rb

@@ -2074,6 +2074,8 @@ def list_categories_with_http_info(user_guid, opts = {})
     # Use this endpoint to read the attributes of a specific user.
     # @param user_guid [String] The unique id for a `user`.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
     # @return [CategoriesResponseBody]
     def list_default_categories(user_guid, opts = {})
       data, _status_code, _headers = list_default_categories_with_http_info(user_guid, opts)
@@ -2084,6 +2086,8 @@ def list_default_categories(user_guid, opts = {})
     # Use this endpoint to read the attributes of a specific user.
     # @param user_guid [String] The unique id for a `user`.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
     # @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
     def list_default_categories_with_http_info(user_guid, opts = {})
       if @api_client.config.debugging
@@ -2098,6 +2102,8 @@ def list_default_categories_with_http_info(user_guid, opts = {})
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -2425,6 +2431,8 @@ def list_institution_credentials_with_http_info(institution_code, opts = {})
     # This endpoint returns a list of institutions based on the specified search term or parameter.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :name This will list only institutions in which the appended string appears.
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
     # @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
     # @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
     # @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
@@ -2439,6 +2447,8 @@ def list_institutions(opts = {})
     # This endpoint returns a list of institutions based on the specified search term or parameter.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :name This will list only institutions in which the appended string appears.
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
     # @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
     # @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
     # @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
@@ -2454,6 +2464,8 @@ def list_institutions_with_http_info(opts = {})
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
       query_params[:'supports_account_identification'] = opts[:'supports_account_identification'] if !opts[:'supports_account_identification'].nil?
       query_params[:'supports_account_statement'] = opts[:'supports_account_statement'] if !opts[:'supports_account_statement'].nil?
       query_params[:'supports_account_verification'] = opts[:'supports_account_verification'] if !opts[:'supports_account_verification'].nil?
@@ -3581,6 +3593,10 @@ def list_transactions_by_member_with_http_info(member_guid, user_guid, opts = {}
     # @param tag_guid [String] The unique id for a &#x60;tag&#x60;.
     # @param user_guid [String] The unique id for a &#x60;user&#x60;.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :from_date Filter transactions from this date.
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [String] :to_date Filter transactions to this date.
     # @return [TransactionsResponseBody]
     def list_transactions_by_tag(tag_guid, user_guid, opts = {})
       data, _status_code, _headers = list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts)
@@ -3592,6 +3608,10 @@ def list_transactions_by_tag(tag_guid, user_guid, opts = {})
     # @param tag_guid [String] The unique id for a &#x60;tag&#x60;.
     # @param user_guid [String] The unique id for a &#x60;user&#x60;.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :from_date Filter transactions from this date.
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [String] :to_date Filter transactions to this date.
     # @return [Array<(TransactionsResponseBody, Integer, Hash)>] TransactionsResponseBody data, response status code and response headers
     def list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts = {})
       if @api_client.config.debugging
@@ -3610,6 +3630,10 @@ def list_transactions_by_tag_with_http_info(tag_guid, user_guid, opts = {})
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
+      query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

lib/mx-platform-ruby/version.rb

@@ -11,5 +11,5 @@
 =end
 
 module MxPlatformRuby
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

openapi/config.yml

@@ -6,6 +6,6 @@ gemHomepage: "https://github.com/mxenabled/mx-platform-ruby"
 gemLicense: "MIT"
 gemName: "mx-platform-ruby"
 gemRequiredRubyVersion: ">= 2.6"
-gemVersion: "0.5.0"
+gemVersion: "0.6.0"
 library: "faraday"
 moduleName: "MxPlatformRuby"

spec/api/mx_platform_api_spec.rb

@@ -423,6 +423,8 @@
   # Use this endpoint to read the attributes of a specific user.
   # @param user_guid The unique id for a `user`.
   # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
   # @return [CategoriesResponseBody]
   describe 'list_default_categories test' do
     it 'should work' do
@@ -495,6 +497,8 @@
   # This endpoint returns a list of institutions based on the specified search term or parameter.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :name This will list only institutions in which the appended string appears.
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
   # @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
   # @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
   # @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
@@ -733,6 +737,10 @@
   # @param tag_guid The unique id for a `tag`.
   # @param user_guid The unique id for a `user`.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :from_date Filter transactions from this date.
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @option opts [String] :to_date Filter transactions to this date.
   # @return [TransactionsResponseBody]
   describe 'list_transactions_by_tag test' do
     it 'should work' do