atrium-ruby 2.7.0 → 2.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -2
- data/docs/ConnectWidgetRequestBody.md +1 -0
- data/docs/MembersApi.md +38 -0
- data/lib/atrium-ruby/api/members_api.rb +58 -0
- data/lib/atrium-ruby/models/connect_widget_request_body.rb +10 -1
- data/lib/atrium-ruby/version.rb +1 -1
- data/spec/api/members_api_spec.rb +13 -0
- data/spec/models/connect_widget_request_body_spec.rb +6 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4ed8d796ae961ae240fca5f1d773e57034cf946680d7d3227c047602b7e13288
|
4
|
+
data.tar.gz: 76a09150fe9ac9488d620156821f419e3192e8db745b3439f5320d1c7f04618e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a4abcff0afbd270498c095ca4ad4a334ab2d7cb949950684c773773297dff0fb3c4206ed816fef33bffd576b12ce7d991b2017ac6c56ecede181c060bc46a89f
|
7
|
+
data.tar.gz: fae17698fc63fa099d6235bfb0255b70b3d7f440b50426ca16a1eb55992861b7af7da066d3ecf3325b60b2e17952a753ecad2d3f84fc644acd491e8b99c775e1
|
data/README.md
CHANGED
@@ -17,12 +17,12 @@ gem build atrium-ruby.gemspec
|
|
17
17
|
Then either install the gem locally:
|
18
18
|
|
19
19
|
```shell
|
20
|
-
gem install ./atrium-ruby-2.
|
20
|
+
gem install ./atrium-ruby-2.8.0.gem
|
21
21
|
```
|
22
22
|
|
23
23
|
Finally add this to the Gemfile:
|
24
24
|
|
25
|
-
gem 'atrium-ruby', '~> 2.
|
25
|
+
gem 'atrium-ruby', '~> 2.8.0'
|
26
26
|
|
27
27
|
### Install from Git
|
28
28
|
|
@@ -85,6 +85,7 @@ Class | Method | HTTP request | Description
|
|
85
85
|
*Atrium::InstitutionsApi* | [**read_institution**](docs/InstitutionsApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution
|
86
86
|
*Atrium::InstitutionsApi* | [**read_institution_credentials**](docs/InstitutionsApi.md#read_institution_credentials) | **GET** /institutions/{institution_code}/credentials | Read institution credentials
|
87
87
|
*Atrium::MembersApi* | [**aggregate_member**](docs/MembersApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
|
88
|
+
*Atrium::MembersApi* | [**aggregate_member_balances**](docs/MembersApi.md#aggregate_member_balances) | **POST** /users/{user_guid}/members/{member_guid}/balance | Aggregate member account balances
|
88
89
|
*Atrium::MembersApi* | [**create_member**](docs/MembersApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
|
89
90
|
*Atrium::MembersApi* | [**delete_member**](docs/MembersApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
|
90
91
|
*Atrium::MembersApi* | [**extend_history**](docs/MembersApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**is_mobile_webview** | **BOOLEAN** | | [optional]
|
7
7
|
**current_institution_code** | **String** | | [optional]
|
8
8
|
**current_member_guid** | **String** | | [optional]
|
9
|
+
**ui_message_version** | **Float** | | [optional]
|
9
10
|
**update_credentials** | **BOOLEAN** | | [optional]
|
10
11
|
|
11
12
|
|
data/docs/MembersApi.md
CHANGED
@@ -3,6 +3,7 @@
|
|
3
3
|
Method | HTTP request | Description
|
4
4
|
------------- | ------------- | -------------
|
5
5
|
[**aggregate_member**](MembersApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
|
6
|
+
[**aggregate_member_balances**](MembersApi.md#aggregate_member_balances) | **POST** /users/{user_guid}/members/{member_guid}/balance | Aggregate member account balances
|
6
7
|
[**create_member**](MembersApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
|
7
8
|
[**delete_member**](MembersApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
|
8
9
|
[**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
|
|
54
55
|
|
55
56
|
[**MemberResponseBody**](MemberResponseBody.md)
|
56
57
|
|
58
|
+
# **aggregate_member_balances**
|
59
|
+
> MemberResponseBody aggregate_member_balances(member_guid, user_guid, )
|
60
|
+
|
61
|
+
Aggregate member account balances
|
62
|
+
|
63
|
+
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.
|
64
|
+
|
65
|
+
### Example
|
66
|
+
```ruby
|
67
|
+
# load the gem
|
68
|
+
require 'atrium-ruby'
|
69
|
+
|
70
|
+
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
71
|
+
|
72
|
+
member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
73
|
+
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
74
|
+
|
75
|
+
begin
|
76
|
+
#Aggregate member account balances
|
77
|
+
response = client.members.aggregate_member_balances(member_guid, user_guid, )
|
78
|
+
p response
|
79
|
+
rescue Atrium::ApiError => e
|
80
|
+
puts "Exception when calling MembersApi->aggregate_member_balances: #{e}"
|
81
|
+
end
|
82
|
+
```
|
83
|
+
|
84
|
+
### Parameters
|
85
|
+
|
86
|
+
Name | Type | Description | Notes
|
87
|
+
------------- | ------------- | ------------- | -------------
|
88
|
+
**member_guid** | **String**| The unique identifier for a `member`. |
|
89
|
+
**user_guid** | **String**| The unique identifier for a `user`. |
|
90
|
+
|
91
|
+
### Return type
|
92
|
+
|
93
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
94
|
+
|
57
95
|
# **create_member**
|
58
96
|
> MemberResponseBody create_member(user_guid, body)
|
59
97
|
|
@@ -26,6 +26,17 @@ module Atrium
|
|
26
26
|
data
|
27
27
|
end
|
28
28
|
|
29
|
+
# Aggregate member account balances
|
30
|
+
# 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.
|
31
|
+
# @param member_guid The unique identifier for a `member`.
|
32
|
+
# @param user_guid The unique identifier for a `user`.
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [MemberResponseBody]
|
35
|
+
def aggregate_member_balances(member_guid, user_guid, opts = {})
|
36
|
+
data, _status_code, _headers = aggregate_member_balances_with_http_info(member_guid, user_guid, opts)
|
37
|
+
data
|
38
|
+
end
|
39
|
+
|
29
40
|
# Create member
|
30
41
|
# 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.
|
31
42
|
# @param user_guid The unique identifier for a `user`.
|
@@ -219,6 +230,53 @@ module Atrium
|
|
219
230
|
end
|
220
231
|
return data, status_code, headers
|
221
232
|
end
|
233
|
+
# Aggregate member account balances
|
234
|
+
# 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.
|
235
|
+
# @param member_guid The unique identifier for a `member`.
|
236
|
+
# @param user_guid The unique identifier for a `user`.
|
237
|
+
# @param [Hash] opts the optional parameters
|
238
|
+
# @return [Array<(MemberResponseBody, Fixnum, Hash)>] MemberResponseBody data, response status code and response headers
|
239
|
+
def aggregate_member_balances_with_http_info(member_guid, user_guid, opts = {})
|
240
|
+
if @api_client.config.debugging
|
241
|
+
@api_client.config.logger.debug 'Calling API: MembersApi.aggregate_member_balances ...'
|
242
|
+
end
|
243
|
+
# verify the required parameter 'member_guid' is set
|
244
|
+
if @api_client.config.client_side_validation && member_guid.nil?
|
245
|
+
fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.aggregate_member_balances"
|
246
|
+
end
|
247
|
+
# verify the required parameter 'user_guid' is set
|
248
|
+
if @api_client.config.client_side_validation && user_guid.nil?
|
249
|
+
fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.aggregate_member_balances"
|
250
|
+
end
|
251
|
+
# resource path
|
252
|
+
local_var_path = '/users/{user_guid}/members/{member_guid}/balance'.sub('{' + 'member_guid' + '}', member_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s)
|
253
|
+
|
254
|
+
# query parameters
|
255
|
+
query_params = {}
|
256
|
+
|
257
|
+
# header parameters
|
258
|
+
header_params = {}
|
259
|
+
# HTTP header 'Accept' (if needed)
|
260
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
|
261
|
+
|
262
|
+
# form parameters
|
263
|
+
form_params = {}
|
264
|
+
|
265
|
+
# http body (model)
|
266
|
+
post_body = nil
|
267
|
+
auth_names = ['apiKey', 'clientID']
|
268
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
269
|
+
:header_params => header_params,
|
270
|
+
:query_params => query_params,
|
271
|
+
:form_params => form_params,
|
272
|
+
:body => post_body,
|
273
|
+
:auth_names => auth_names,
|
274
|
+
:return_type => 'MemberResponseBody')
|
275
|
+
if @api_client.config.debugging
|
276
|
+
@api_client.config.logger.debug "API called: MembersApi#aggregate_member_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
277
|
+
end
|
278
|
+
return data, status_code, headers
|
279
|
+
end
|
222
280
|
# Create member
|
223
281
|
# 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.
|
224
282
|
# @param user_guid The unique identifier for a `user`.
|
@@ -16,6 +16,8 @@ module Atrium
|
|
16
16
|
|
17
17
|
attr_accessor :current_member_guid
|
18
18
|
|
19
|
+
attr_accessor :ui_message_version
|
20
|
+
|
19
21
|
attr_accessor :update_credentials
|
20
22
|
|
21
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -24,6 +26,7 @@ module Atrium
|
|
24
26
|
:'is_mobile_webview' => :'is_mobile_webview',
|
25
27
|
:'current_institution_code' => :'current_institution_code',
|
26
28
|
:'current_member_guid' => :'current_member_guid',
|
29
|
+
:'ui_message_version' => :'ui_message_version',
|
27
30
|
:'update_credentials' => :'update_credentials'
|
28
31
|
}
|
29
32
|
end
|
@@ -34,6 +37,7 @@ module Atrium
|
|
34
37
|
:'is_mobile_webview' => :'BOOLEAN',
|
35
38
|
:'current_institution_code' => :'String',
|
36
39
|
:'current_member_guid' => :'String',
|
40
|
+
:'ui_message_version' => :'Float',
|
37
41
|
:'update_credentials' => :'BOOLEAN'
|
38
42
|
}
|
39
43
|
end
|
@@ -58,6 +62,10 @@ module Atrium
|
|
58
62
|
self.current_member_guid = attributes[:'current_member_guid']
|
59
63
|
end
|
60
64
|
|
65
|
+
if attributes.has_key?(:'ui_message_version')
|
66
|
+
self.ui_message_version = attributes[:'ui_message_version']
|
67
|
+
end
|
68
|
+
|
61
69
|
if attributes.has_key?(:'update_credentials')
|
62
70
|
self.update_credentials = attributes[:'update_credentials']
|
63
71
|
end
|
@@ -84,6 +92,7 @@ module Atrium
|
|
84
92
|
is_mobile_webview == o.is_mobile_webview &&
|
85
93
|
current_institution_code == o.current_institution_code &&
|
86
94
|
current_member_guid == o.current_member_guid &&
|
95
|
+
ui_message_version == o.ui_message_version &&
|
87
96
|
update_credentials == o.update_credentials
|
88
97
|
end
|
89
98
|
|
@@ -96,7 +105,7 @@ module Atrium
|
|
96
105
|
# Calculates hash code according to all attributes.
|
97
106
|
# @return [Fixnum] Hash code
|
98
107
|
def hash
|
99
|
-
[is_mobile_webview, current_institution_code, current_member_guid, update_credentials].hash
|
108
|
+
[is_mobile_webview, current_institution_code, current_member_guid, ui_message_version, update_credentials].hash
|
100
109
|
end
|
101
110
|
|
102
111
|
# Builds the object from hash
|
data/lib/atrium-ruby/version.rb
CHANGED
@@ -40,6 +40,19 @@ describe 'MembersApi' do
|
|
40
40
|
end
|
41
41
|
end
|
42
42
|
|
43
|
+
# unit tests for aggregate_member_balances
|
44
|
+
# Aggregate member account balances
|
45
|
+
# 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.
|
46
|
+
# @param member_guid The unique identifier for a `member`.
|
47
|
+
# @param user_guid The unique identifier for a `user`.
|
48
|
+
# @param [Hash] opts the optional parameters
|
49
|
+
# @return [MemberResponseBody]
|
50
|
+
describe 'aggregate_member_balances test' do
|
51
|
+
it 'should work' do
|
52
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
43
56
|
# unit tests for create_member
|
44
57
|
# Create member
|
45
58
|
# 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.
|
@@ -45,6 +45,12 @@ describe 'ConnectWidgetRequestBody' do
|
|
45
45
|
end
|
46
46
|
end
|
47
47
|
|
48
|
+
describe 'test attribute "ui_message_version"' do
|
49
|
+
it 'should work' do
|
50
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
48
54
|
describe 'test attribute "update_credentials"' do
|
49
55
|
it 'should work' do
|
50
56
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: atrium-ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.
|
4
|
+
version: 2.8.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- MX
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-10-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|