atrium-ruby 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '095fd068ed1950d40160c08e8570e3bdd2c4bdbde1451b8540929ec5ea370253'
-  data.tar.gz: c7b8533464cedeeccbade953720d887a507db2b4b80ea87c689ed7b1f93be420
+  metadata.gz: 4ed8d796ae961ae240fca5f1d773e57034cf946680d7d3227c047602b7e13288
+  data.tar.gz: 76a09150fe9ac9488d620156821f419e3192e8db745b3439f5320d1c7f04618e
 SHA512:
-  metadata.gz: 84bb52ee48db76f24772532910357717e3a9a3a87edb21d4327e7d2317dd2ed46cbf4b36deab1ff8eea40b3861f42305f17d3a84404bcc10a9547fdd717beec3
-  data.tar.gz: d13888ab77f5326f9f8597a2ce8cdc287c288564bfd0ce90bc98cc124dafc6aa1fe2d691bae1d8bfe71cf87ea10947ea64c6943d57c322b9ca61519d409c79ec
+  metadata.gz: a4abcff0afbd270498c095ca4ad4a334ab2d7cb949950684c773773297dff0fb3c4206ed816fef33bffd576b12ce7d991b2017ac6c56ecede181c060bc46a89f
+  data.tar.gz: fae17698fc63fa099d6235bfb0255b70b3d7f440b50426ca16a1eb55992861b7af7da066d3ecf3325b60b2e17952a753ecad2d3f84fc644acd491e8b99c775e1

data/README.md

@@ -17,12 +17,12 @@ gem build atrium-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./atrium-ruby-2.7.0.gem
+gem install ./atrium-ruby-2.8.0.gem
 ```
 
 Finally add this to the Gemfile:
 
-    gem 'atrium-ruby', '~> 2.7.0'
+    gem 'atrium-ruby', '~> 2.8.0'
 
 ### Install from Git
 
@@ -85,6 +85,7 @@ Class | Method | HTTP request | Description
 *Atrium::InstitutionsApi* | [**read_institution**](docs/InstitutionsApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution
 *Atrium::InstitutionsApi* | [**read_institution_credentials**](docs/InstitutionsApi.md#read_institution_credentials) | **GET** /institutions/{institution_code}/credentials | Read institution credentials
 *Atrium::MembersApi* | [**aggregate_member**](docs/MembersApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
+*Atrium::MembersApi* | [**aggregate_member_balances**](docs/MembersApi.md#aggregate_member_balances) | **POST** /users/{user_guid}/members/{member_guid}/balance | Aggregate member account balances
 *Atrium::MembersApi* | [**create_member**](docs/MembersApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
 *Atrium::MembersApi* | [**delete_member**](docs/MembersApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
 *Atrium::MembersApi* | [**extend_history**](docs/MembersApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history

data/docs/ConnectWidgetRequestBody.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **is_mobile_webview** | **BOOLEAN** |  | [optional] 
 **current_institution_code** | **String** |  | [optional] 
 **current_member_guid** | **String** |  | [optional] 
+**ui_message_version** | **Float** |  | [optional] 
 **update_credentials** | **BOOLEAN** |  | [optional] 
 
 

data/docs/MembersApi.md

@@ -3,6 +3,7 @@
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**aggregate_member**](MembersApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
+[**aggregate_member_balances**](MembersApi.md#aggregate_member_balances) | **POST** /users/{user_guid}/members/{member_guid}/balance | Aggregate member account balances
 [**create_member**](MembersApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
 [**delete_member**](MembersApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
 [**extend_history**](MembersApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
@@ -54,6 +55,43 @@ Name | Type | Description  | Notes
 
 [**MemberResponseBody**](MemberResponseBody.md)
 
+# **aggregate_member_balances**
+> MemberResponseBody aggregate_member_balances(member_guid, user_guid, )
+
+Aggregate member account balances
+
+This endpoint operates much like the _aggregate member_ endpoint except that it gathers only account balance information; it does not gather any transaction data at all.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+member_guid = "MBR-123" # String | The unique identifier for a `member`.
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+
+begin
+  #Aggregate member account balances
+  response = client.members.aggregate_member_balances(member_guid, user_guid, )
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling MembersApi->aggregate_member_balances: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_guid** | **String**| The unique identifier for a `member`. | 
+ **user_guid** | **String**| The unique identifier for a `user`. | 
+
+### Return type
+
+[**MemberResponseBody**](MemberResponseBody.md)
+
 # **create_member**
 > MemberResponseBody create_member(user_guid, body)
 

data/lib/atrium-ruby/api/members_api.rb

@@ -26,6 +26,17 @@ module Atrium
       data
     end
 
+    # Aggregate member account balances
+    # This endpoint operates much like the _aggregate member_ endpoint except that it gathers only account balance information; it does not gather any transaction data at all.
+    # @param member_guid The unique identifier for a `member`.
+    # @param user_guid The unique identifier for a `user`.
+    # @param [Hash] opts the optional parameters
+    # @return [MemberResponseBody]
+    def aggregate_member_balances(member_guid, user_guid, opts = {})
+      data, _status_code, _headers = aggregate_member_balances_with_http_info(member_guid, user_guid, opts)
+      data
+    end
+
     # Create member
     # This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters identifier and metadata.<br> When creating a member, you'll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/{institution_code}/credentials endpoint.<br> If successful, Atrium will respond with the newly-created member object.<br> Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions. 
     # @param user_guid The unique identifier for a &#x60;user&#x60;.
@@ -219,6 +230,53 @@ module Atrium
       end
       return data, status_code, headers
     end
+    # Aggregate member account balances
+    # This endpoint operates much like the _aggregate member_ endpoint except that it gathers only account balance information; it does not gather any transaction data at all.
+    # @param member_guid The unique identifier for a &#x60;member&#x60;.
+    # @param user_guid The unique identifier for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MemberResponseBody, Fixnum, Hash)>] MemberResponseBody data, response status code and response headers
+    def aggregate_member_balances_with_http_info(member_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MembersApi.aggregate_member_balances ...'
+      end
+      # verify the required parameter 'member_guid' is set
+      if @api_client.config.client_side_validation && member_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.aggregate_member_balances"
+      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 MembersApi.aggregate_member_balances"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/members/{member_guid}/balance'.sub('{' + 'member_guid' + '}', member_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apiKey', 'clientID']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'MemberResponseBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MembersApi#aggregate_member_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Create member
     # This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters identifier and metadata.&lt;br&gt; When creating a member, you&#39;ll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/{institution_code}/credentials endpoint.&lt;br&gt; If successful, Atrium will respond with the newly-created member object.&lt;br&gt; Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions. 
     # @param user_guid The unique identifier for a &#x60;user&#x60;.

data/lib/atrium-ruby/models/connect_widget_request_body.rb

@@ -16,6 +16,8 @@ module Atrium
 
     attr_accessor :current_member_guid
 
+    attr_accessor :ui_message_version
+
     attr_accessor :update_credentials
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -24,6 +26,7 @@ module Atrium
         :'is_mobile_webview' => :'is_mobile_webview',
         :'current_institution_code' => :'current_institution_code',
         :'current_member_guid' => :'current_member_guid',
+        :'ui_message_version' => :'ui_message_version',
         :'update_credentials' => :'update_credentials'
       }
     end
@@ -34,6 +37,7 @@ module Atrium
         :'is_mobile_webview' => :'BOOLEAN',
         :'current_institution_code' => :'String',
         :'current_member_guid' => :'String',
+        :'ui_message_version' => :'Float',
         :'update_credentials' => :'BOOLEAN'
       }
     end
@@ -58,6 +62,10 @@ module Atrium
         self.current_member_guid = attributes[:'current_member_guid']
       end
 
+      if attributes.has_key?(:'ui_message_version')
+        self.ui_message_version = attributes[:'ui_message_version']
+      end
+
       if attributes.has_key?(:'update_credentials')
         self.update_credentials = attributes[:'update_credentials']
       end
@@ -84,6 +92,7 @@ module Atrium
           is_mobile_webview == o.is_mobile_webview &&
           current_institution_code == o.current_institution_code &&
           current_member_guid == o.current_member_guid &&
+          ui_message_version == o.ui_message_version &&
           update_credentials == o.update_credentials
     end
 
@@ -96,7 +105,7 @@ module Atrium
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [is_mobile_webview, current_institution_code, current_member_guid, update_credentials].hash
+      [is_mobile_webview, current_institution_code, current_member_guid, ui_message_version, update_credentials].hash
     end
 
     # Builds the object from hash

data/lib/atrium-ruby/version.rb

@@ -7,5 +7,5 @@
 =end
 
 module Atrium
-  VERSION = '2.7.0'
+  VERSION = '2.8.0'
 end

data/spec/api/members_api_spec.rb

@@ -40,6 +40,19 @@ describe 'MembersApi' do
     end
   end
 
+  # unit tests for aggregate_member_balances
+  # Aggregate member account balances
+  # This endpoint operates much like the _aggregate member_ endpoint except that it gathers only account balance information; it does not gather any transaction data at all.
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [MemberResponseBody]
+  describe 'aggregate_member_balances 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 create_member
   # Create member
   # This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters identifier and metadata.<br> When creating a member, you'll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/{institution_code}/credentials endpoint.<br> If successful, Atrium will respond with the newly-created member object.<br> Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions. 

data/spec/models/connect_widget_request_body_spec.rb

@@ -45,6 +45,12 @@ describe 'ConnectWidgetRequestBody' do
     end
   end
 
+  describe 'test attribute "ui_message_version"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "update_credentials"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atrium-ruby
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - MX
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus