mx-platform-ruby 0.8.0 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f9a2465e0151aecb5fadd0743958c0f3ed32e12f1a0a3979315244c0055f66b
-  data.tar.gz: aea5d289f5d404e66f0bbc3823e3a4ec1d2ce7f8928dfd1f0b065fdd6902809f
+  metadata.gz: 0c505ce4ad9f2566ba4eb080ca46e2ed184c534549e0981617d3081d1bcdc949
+  data.tar.gz: 4aceaede0825d62348c9d84afcc60e3e4cfe45b89744d7be832c93c53a4f7f82
 SHA512:
-  metadata.gz: bbd8f3753a4dcddc9e983b77a3a18ff5f2f8173484fb132271cc8d9e16ba5bd568f34688c9c157479f14d8efd10df7e98d0dc3794149515657974198f8fcacec
-  data.tar.gz: 474373c6558a70eb41e0bbb1e3df4ea84722f24900cc1b0d2d76d4bf1e15ac9415e16b993c3be317e03230fd116ddd0ea401c76500001ecd23dacbaa5528f194
+  metadata.gz: b8c35e2f284e592031edc4bc5b47f9164db82fc1ebd844ce05d5ef2768aa71f6e5a372c345f9fa48f1210705638f76a82ce641d546ad0ef5b6642901877cbea0
+  data.tar.gz: 2e052901922e556d32422ae3334d4913f4970fc8028e900b5ba20304eb319b6a01932f491289bb6688dba25f78e77aaecbcdb350957663f0e7620993b5b7a8a3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.8.0)
+    mx-platform-ruby (0.8.4)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -54,7 +54,7 @@ GEM
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
+    rspec-core (3.10.2)
       rspec-support (~> 3.10.0)
     rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -87,4 +87,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.3.5
+   2.3.6

data/docs/MxPlatformApi.md

@@ -37,6 +37,7 @@ All URIs are relative to *https://api.mx.com*
 | [**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_account**](MxPlatformApi.md#list_holdings_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/holdings | List holdings by account |
 | [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member |
 | [**list_institution_credentials**](MxPlatformApi.md#list_institution_credentials) | **GET** /institutions/{institution_code}/credentials | List institution credentials |
 | [**list_institutions**](MxPlatformApi.md#list_institutions) | **GET** /institutions | List institutions |
@@ -2503,6 +2504,88 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## list_holdings_by_account
+
+> <HoldingsResponseBody> list_holdings_by_account(account_guid, user_guid, opts)
+
+List holdings by account
+
+This endpoint returns all holdings associated with the specified `account`.
+
+### 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
+account_guid = 'ACT-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for the `account`.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for the `user`.
+opts = {
+  from_date: '2015-09-20', # String | Filter holdings 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 holdings to this date.
+}
+
+begin
+  # List holdings by account
+  result = api_instance.list_holdings_by_account(account_guid, user_guid, opts)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->list_holdings_by_account: #{e}"
+end
+```
+
+#### Using the list_holdings_by_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_by_account_with_http_info(account_guid, user_guid, opts)
+
+```ruby
+begin
+  # List holdings by account
+  data, status_code, headers = api_instance.list_holdings_by_account_with_http_info(account_guid, user_guid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HoldingsResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->list_holdings_by_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** | The unique id for the &#x60;account&#x60;. |  |
+| **user_guid** | **String** | The unique id for the &#x60;user&#x60;. |  |
+| **from_date** | **String** | Filter holdings from this date. | [optional] |
+| **page** | **Integer** | Specify current page. | [optional] |
+| **records_per_page** | **Integer** | Specify records per page. | [optional] |
+| **to_date** | **String** | Filter holdings to this date. | [optional] |
+
+### Return type
+
+[**HoldingsResponseBody**](HoldingsResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## list_holdings_by_member
 
 > <HoldingsResponseBody> list_holdings_by_member(member_guid, user_guid, opts)

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

@@ -2352,6 +2352,87 @@ module MxPlatformRuby
       return data, status_code, headers
     end
 
+    # List holdings by account
+    # This endpoint returns all holdings associated with the specified `account`.
+    # @param account_guid [String] The unique id for the `account`.
+    # @param user_guid [String] The unique id for the `user`.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :from_date Filter holdings 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 holdings to this date.
+    # @return [HoldingsResponseBody]
+    def list_holdings_by_account(account_guid, user_guid, opts = {})
+      data, _status_code, _headers = list_holdings_by_account_with_http_info(account_guid, user_guid, opts)
+      data
+    end
+
+    # List holdings by account
+    # This endpoint returns all holdings associated with the specified `account`.
+    # @param account_guid [String] The unique id for the `account`.
+    # @param user_guid [String] The unique id for the `user`.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :from_date Filter holdings 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 holdings to this date.
+    # @return [Array<(HoldingsResponseBody, Integer, Hash)>] HoldingsResponseBody data, response status code and response headers
+    def list_holdings_by_account_with_http_info(account_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_holdings_by_account ...'
+      end
+      # verify the required parameter 'account_guid' is set
+      if @api_client.config.client_side_validation && account_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.list_holdings_by_account"
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_holdings_by_account"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/accounts/{account_guid}/holdings'.sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # 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] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'HoldingsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.list_holdings_by_account",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#list_holdings_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List holdings by member
     # This endpoint returns all holdings associated with the specified `member` across all accounts.
     # @param member_guid [String] The unique id for a &#x60;member&#x60;.

data/lib/mx-platform-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.1
 =end
 
 module MxPlatformRuby
-  VERSION = '0.8.0'
+  VERSION = '0.8.4'
 end

data/openapi/config.yml

@@ -1,11 +1,11 @@
 ---
-gemAuthor: "MX"
-gemAuthorEmail: "devexperience@mx.com"
-gemDescription: "A Ruby library for the MX Platform API."
-gemHomepage: "https://github.com/mxenabled/mx-platform-ruby"
-gemLicense: "MIT"
-gemName: "mx-platform-ruby"
+gemAuthor: MX
+gemAuthorEmail: devexperience@mx.com
+gemDescription: A Ruby library for the MX Platform API.
+gemHomepage: https://github.com/mxenabled/mx-platform-ruby
+gemLicense: MIT
+gemName: mx-platform-ruby
 gemRequiredRubyVersion: ">= 2.6"
-gemVersion: "0.8.0"
-library: "faraday"
-moduleName: "MxPlatformRuby"
+gemVersion: 0.8.4
+library: faraday
+moduleName: MxPlatformRuby

data/openapitools.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "5.3.1"
+  }
+}

data/spec/api/mx_platform_api_spec.rb

@@ -474,6 +474,23 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for list_holdings_by_account
+  # List holdings by account
+  # This endpoint returns all holdings associated with the specified `account`.
+  # @param account_guid The unique id for the `account`.
+  # @param user_guid The unique id for the `user`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from_date Filter holdings 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 holdings to this date.
+  # @return [HoldingsResponseBody]
+  describe 'list_holdings_by_account test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for list_holdings_by_member
   # List holdings by member
   # This endpoint returns all holdings associated with the specified `member` across all accounts.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mx-platform-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.4
 platform: ruby
 authors:
 - MX
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -288,6 +288,7 @@ files:
 - mx-platform-ruby.gemspec
 - openapi/config.yml
 - openapi/templates/README.mustache
+- openapitools.json
 - spec/api/mx_platform_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
@@ -427,112 +428,112 @@ test_files:
 - spec/api/mx_platform_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/tagging_response_spec.rb
-- spec/models/member_status_response_spec.rb
-- spec/models/transaction_update_request_body_spec.rb
-- spec/models/managed_transaction_update_request_spec.rb
-- spec/models/enhance_transaction_response_spec.rb
-- spec/models/institution_response_body_spec.rb
-- spec/models/enhance_transactions_request_spec.rb
-- spec/models/widget_request_spec.rb
-- spec/models/account_response_body_spec.rb
-- spec/models/merchant_response_body_spec.rb
-- spec/models/merchant_location_response_spec.rb
-- spec/models/holding_response_spec.rb
-- spec/models/managed_transaction_update_request_body_spec.rb
-- spec/models/user_response_body_spec.rb
 - spec/models/managed_member_create_request_spec.rb
-- spec/models/merchant_location_response_body_spec.rb
-- spec/models/widget_response_spec.rb
-- spec/models/transaction_update_request_spec.rb
-- spec/models/transaction_rule_update_request_body_spec.rb
-- spec/models/tag_response_spec.rb
-- spec/models/connect_widget_response_body_spec.rb
-- spec/models/challenge_response_spec.rb
-- spec/models/managed_account_create_request_body_spec.rb
-- spec/models/user_update_request_body_spec.rb
-- spec/models/transaction_rules_response_body_spec.rb
-- spec/models/user_create_request_body_spec.rb
-- spec/models/credential_request_spec.rb
-- spec/models/category_response_spec.rb
-- spec/models/managed_transaction_create_request_body_spec.rb
+- spec/models/pagination_response_spec.rb
+- spec/models/user_response_body_spec.rb
+- spec/models/managed_member_update_request_body_spec.rb
 - spec/models/account_number_response_spec.rb
-- spec/models/account_owners_response_body_spec.rb
-- spec/models/transactions_response_body_spec.rb
-- spec/models/tag_create_request_spec.rb
-- spec/models/account_owner_response_spec.rb
-- spec/models/category_create_request_spec.rb
-- spec/models/statements_response_body_spec.rb
-- spec/models/transaction_rule_response_body_spec.rb
-- spec/models/account_update_request_spec.rb
-- spec/models/connect_widget_request_spec.rb
-- spec/models/category_response_body_spec.rb
-- spec/models/members_response_body_spec.rb
-- spec/models/managed_account_create_request_spec.rb
-- spec/models/user_update_request_spec.rb
-- spec/models/tagging_update_request_body_spec.rb
-- spec/models/member_response_spec.rb
-- spec/models/managed_member_create_request_body_spec.rb
+- spec/models/tags_response_body_spec.rb
 - spec/models/enhance_transactions_request_body_spec.rb
-- spec/models/connect_widget_response_spec.rb
-- spec/models/statement_response_body_spec.rb
-- spec/models/transaction_response_body_spec.rb
+- spec/models/widget_request_spec.rb
+- spec/models/member_status_response_spec.rb
+- spec/models/o_auth_window_response_body_spec.rb
+- spec/models/connect_widget_request_spec.rb
+- spec/models/widget_response_spec.rb
+- spec/models/transaction_rule_update_request_spec.rb
 - spec/models/enhance_transactions_response_body_spec.rb
-- spec/models/users_response_body_spec.rb
-- spec/models/tagging_create_request_body_spec.rb
-- spec/models/option_response_spec.rb
-- spec/models/o_auth_window_response_spec.rb
+- spec/models/transaction_response_spec.rb
+- spec/models/statement_response_body_spec.rb
+- spec/models/managed_member_create_request_body_spec.rb
+- spec/models/member_create_request_spec.rb
+- spec/models/category_update_request_spec.rb
+- spec/models/institution_response_body_spec.rb
 - spec/models/account_update_request_body_spec.rb
+- spec/models/tagging_create_request_spec.rb
+- spec/models/accounts_response_body_spec.rb
+- spec/models/holdings_response_body_spec.rb
+- spec/models/account_owners_response_body_spec.rb
+- spec/models/tag_update_request_body_spec.rb
+- spec/models/tagging_update_request_body_spec.rb
+- spec/models/members_response_body_spec.rb
+- spec/models/statement_response_spec.rb
 - spec/models/member_resume_request_body_spec.rb
-- spec/models/transaction_rule_create_request_body_spec.rb
-- spec/models/transaction_response_spec.rb
-- spec/models/merchants_response_body_spec.rb
-- spec/models/o_auth_window_response_body_spec.rb
-- spec/models/transaction_rule_create_request_spec.rb
-- spec/models/pagination_response_spec.rb
-- spec/models/member_resume_request_spec.rb
-- spec/models/tagging_response_body_spec.rb
-- spec/models/member_status_response_body_spec.rb
-- spec/models/widget_request_body_spec.rb
-- spec/models/member_update_request_body_spec.rb
 - spec/models/tag_update_request_spec.rb
-- spec/models/tags_response_body_spec.rb
-- spec/models/managed_account_update_request_spec.rb
-- spec/models/tagging_create_request_spec.rb
+- spec/models/tagging_response_body_spec.rb
+- spec/models/member_resume_request_spec.rb
+- spec/models/transaction_rule_response_body_spec.rb
 - spec/models/account_numbers_response_body_spec.rb
+- spec/models/challenge_response_spec.rb
+- spec/models/user_update_request_spec.rb
+- spec/models/category_response_body_spec.rb
+- spec/models/merchant_response_body_spec.rb
+- spec/models/managed_account_create_request_body_spec.rb
 - spec/models/connect_widget_request_body_spec.rb
-- spec/models/member_response_body_spec.rb
-- spec/models/merchant_response_spec.rb
+- spec/models/transaction_update_request_body_spec.rb
+- spec/models/taggings_response_body_spec.rb
+- spec/models/o_auth_window_response_spec.rb
+- spec/models/institutions_response_body_spec.rb
+- spec/models/tagging_update_request_spec.rb
+- spec/models/statements_response_body_spec.rb
+- spec/models/connect_widget_response_spec.rb
+- spec/models/account_owner_response_spec.rb
+- spec/models/account_response_body_spec.rb
+- spec/models/merchants_response_body_spec.rb
+- spec/models/category_create_request_body_spec.rb
+- spec/models/transaction_update_request_spec.rb
+- spec/models/category_update_request_body_spec.rb
+- spec/models/category_response_spec.rb
+- spec/models/user_create_request_body_spec.rb
+- spec/models/managed_transaction_create_request_spec.rb
+- spec/models/member_update_request_spec.rb
+- spec/models/widget_response_body_spec.rb
+- spec/models/merchant_location_response_body_spec.rb
+- spec/models/member_create_request_body_spec.rb
+- spec/models/managed_account_update_request_body_spec.rb
+- spec/models/transaction_response_body_spec.rb
+- spec/models/connect_widget_response_body_spec.rb
+- spec/models/account_update_request_spec.rb
+- spec/models/tag_create_request_spec.rb
+- spec/models/transaction_rule_create_request_body_spec.rb
+- spec/models/managed_transaction_update_request_body_spec.rb
 - spec/models/challenges_response_body_spec.rb
-- spec/models/tag_response_body_spec.rb
-- spec/models/credential_response_spec.rb
-- spec/models/account_response_spec.rb
-- spec/models/transaction_rule_response_spec.rb
+- spec/models/enhance_transactions_request_spec.rb
+- spec/models/credential_request_spec.rb
 - spec/models/credentials_response_body_spec.rb
-- spec/models/categories_response_body_spec.rb
-- spec/models/managed_member_update_request_spec.rb
+- spec/models/transaction_rule_update_request_body_spec.rb
+- spec/models/credential_response_spec.rb
+- spec/models/managed_transaction_update_request_spec.rb
+- spec/models/tagging_response_spec.rb
+- spec/models/managed_account_update_request_spec.rb
+- spec/models/merchant_location_response_spec.rb
+- spec/models/member_response_spec.rb
+- spec/models/managed_account_create_request_spec.rb
+- spec/models/users_response_body_spec.rb
 - spec/models/user_response_spec.rb
-- spec/models/holdings_response_body_spec.rb
-- spec/models/transaction_rule_update_request_spec.rb
+- spec/models/category_create_request_spec.rb
+- spec/models/tag_response_body_spec.rb
+- spec/models/transaction_rule_response_spec.rb
+- spec/models/member_update_request_body_spec.rb
 - spec/models/holding_response_body_spec.rb
-- spec/models/member_create_request_spec.rb
-- spec/models/category_update_request_spec.rb
-- spec/models/member_create_request_body_spec.rb
-- spec/models/tagging_update_request_spec.rb
+- spec/models/managed_member_update_request_spec.rb
+- spec/models/widget_request_body_spec.rb
+- spec/models/transaction_rules_response_body_spec.rb
+- spec/models/user_create_request_spec.rb
+- spec/models/categories_response_body_spec.rb
+- spec/models/enhance_transaction_response_spec.rb
 - spec/models/institution_response_spec.rb
-- spec/models/managed_member_update_request_body_spec.rb
-- spec/models/tag_create_request_body_spec.rb
-- spec/models/institutions_response_body_spec.rb
 - spec/models/image_option_response_spec.rb
-- spec/models/taggings_response_body_spec.rb
-- spec/models/category_update_request_body_spec.rb
-- spec/models/widget_response_body_spec.rb
-- spec/models/category_create_request_body_spec.rb
-- spec/models/member_update_request_spec.rb
-- spec/models/managed_account_update_request_body_spec.rb
-- spec/models/tag_update_request_body_spec.rb
-- spec/models/statement_response_spec.rb
-- spec/models/user_create_request_spec.rb
-- spec/models/managed_transaction_create_request_spec.rb
-- spec/models/accounts_response_body_spec.rb
+- spec/models/member_status_response_body_spec.rb
+- spec/models/merchant_response_spec.rb
+- spec/models/tag_create_request_body_spec.rb
+- spec/models/member_response_body_spec.rb
+- spec/models/tagging_create_request_body_spec.rb
+- spec/models/option_response_spec.rb
+- spec/models/transactions_response_body_spec.rb
+- spec/models/transaction_rule_create_request_spec.rb
+- spec/models/user_update_request_body_spec.rb
+- spec/models/holding_response_spec.rb
+- spec/models/tag_response_spec.rb
+- spec/models/managed_transaction_create_request_body_spec.rb
+- spec/models/account_response_spec.rb
 - spec/spec_helper.rb