atrium-ruby 2.3.0 → 2.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (19) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -4
  3. data/docs/AccountsApi.md +2 -2
  4. data/docs/InstitutionsApi.md +1 -1
  5. data/docs/MembersApi.md +43 -53
  6. data/docs/Statement.md +2 -4
  7. data/docs/StatementsApi.md +88 -0
  8. data/docs/TransactionsApi.md +1 -1
  9. data/docs/UsersApi.md +1 -1
  10. data/lib/atrium-ruby.rb +1 -0
  11. data/lib/atrium-ruby/api/atrium_client.rb +2 -0
  12. data/lib/atrium-ruby/api/members_api.rb +58 -65
  13. data/lib/atrium-ruby/api/statements_api.rb +146 -0
  14. data/lib/atrium-ruby/models/statement.rb +21 -41
  15. data/lib/atrium-ruby/version.rb +1 -1
  16. data/spec/api/members_api_spec.rb +13 -16
  17. data/spec/api/statements_api_spec.rb +58 -0
  18. data/spec/models/statement_spec.rb +4 -16
  19. metadata +29 -25
data/lib/atrium-ruby/version.rb CHANGED
@@ -7,5 +7,5 @@
7
7
  =end
8
8
 
9
9
  module Atrium
10
- VERSION = '2.3.0'
10
+ VERSION = '2.4.0'
11
11
  end
data/spec/api/members_api_spec.rb CHANGED
@@ -33,7 +33,6 @@ describe 'MembersApi' do
33
33
  # @param member_guid The unique identifier for a `member`.
34
34
  # @param user_guid The unique identifier for a `user`.
35
35
  # @param [Hash] opts the optional parameters
36
- # @option opts [String] :type An optional parameter which determines the type of aggregation to be peformed. Possible values are `statement` and `history`.
37
36
  # @return [MemberResponseBody]
38
37
  describe 'aggregate_member test' do
39
38
  it 'should work' do
@@ -67,6 +66,19 @@ describe 'MembersApi' do
67
66
  end
68
67
  end
69
68
 
69
+ # unit tests for extend_history
70
+ # Extend history
71
+ # The extend_history endpoint begins the process of fetching up to 24 months of data associated with a particular `member`.
72
+ # @param member_guid The unique identifier for a `member`.
73
+ # @param user_guid The unique identifier for a `user`.
74
+ # @param [Hash] opts the optional parameters
75
+ # @return [MemberResponseBody]
76
+ describe 'extend_history test' do
77
+ it 'should work' do
78
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
79
+ end
80
+ end
81
+
70
82
  # unit tests for list_member_accounts
71
83
  # List member accounts
72
84
  # This endpoint returns an array with information about every account associated with a particular member.
@@ -108,21 +120,6 @@ describe 'MembersApi' do
108
120
  end
109
121
  end
110
122
 
111
- # unit tests for list_member_statements
112
- # List member statements
113
- # Certain institutions in Atrium allow developers to access account statements associated with a particular `member`. Use this endpoint to get an array of available statements. Before this endpoint can be used, an aggregation of type `statement` should be performed on the relevant `member`.
114
- # @param member_guid The unique identifier for a `member`.
115
- # @param user_guid The unique identifier for a `user`.
116
- # @param [Hash] opts the optional parameters
117
- # @option opts [Integer] :page Specify current page.
118
- # @option opts [Integer] :records_per_page Specify records per page.
119
- # @return [StatementsResponseBody]
120
- describe 'list_member_statements test' do
121
- it 'should work' do
122
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
123
- end
124
- end
125
-
126
123
  # unit tests for list_member_transactions
127
124
  # List member transactions
128
125
  # Use this endpoint to get all transactions from all accounts associated with a specific member.<br> This endpoint accepts optional URL query parameters — from_date and to_date — which are used to filter transactions according to the date they were posted. If no values are given for the query parameters, from_date will default to 90 days prior to the request and to_date will default to 5 days from the time of the request.
data/spec/api/statements_api_spec.rb ADDED
@@ -0,0 +1,58 @@
1
+ =begin
2
+ #MX API
3
+
4
+ #The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification. Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes. Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access.
5
+
6
+
7
+ =end
8
+
9
+ require 'spec_helper'
10
+ require 'json'
11
+
12
+ # Unit tests for Atrium::StatementsApi
13
+ # Please update as you see appropriate
14
+ describe 'StatementsApi' do
15
+ before do
16
+ # run before each test
17
+ @instance = Atrium::StatementsApi.new
18
+ end
19
+
20
+ after do
21
+ # run after each test
22
+ end
23
+
24
+ describe 'test an instance of StatementsApi' do
25
+ it 'should create an instance of StatementsApi' do
26
+ expect(@instance).to be_instance_of(Atrium::StatementsApi)
27
+ end
28
+ end
29
+
30
+ # unit tests for fetch_statements
31
+ # Fetch statements
32
+ # The fetch statements endpoint begins fetching statements for a member.
33
+ # @param member_guid The unique identifier for a `member`.
34
+ # @param user_guid The unique identifier for a `user`.
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [MemberResponseBody]
37
+ describe 'fetch_statements test' do
38
+ it 'should work' do
39
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
40
+ end
41
+ end
42
+
43
+ # unit tests for list_member_statements
44
+ # List member statements
45
+ # Certain institutions in Atrium allow developers to access account statements associated with a particular `member`. Use this endpoint to get an array of available statements. Before this endpoint can be used, `fetch_statements` should be performed on the relevant `member`.
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
+ # @option opts [Integer] :page Specify current page.
50
+ # @option opts [Integer] :records_per_page Specify records per page.
51
+ # @return [StatementsResponseBody]
52
+ describe 'list_member_statements test' do
53
+ it 'should work' do
54
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
+ end
56
+ end
57
+
58
+ end
data/spec/models/statement_spec.rb CHANGED
@@ -39,43 +39,31 @@ describe 'Statement' do
39
39
  end
40
40
  end
41
41
 
42
- describe 'test attribute "content_hash"' do
43
- it 'should work' do
44
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
- end
46
- end
47
-
48
- describe 'test attribute "deleted_at"' 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
-
54
42
  describe 'test attribute "guid"' do
55
43
  it 'should work' do
56
44
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
57
45
  end
58
46
  end
59
47
 
60
- describe 'test attribute "is_deleted"' do
48
+ describe 'test attribute "member_guid"' do
61
49
  it 'should work' do
62
50
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
63
51
  end
64
52
  end
65
53
 
66
- describe 'test attribute "updated_at"' do
54
+ describe 'test attribute "uri"' do
67
55
  it 'should work' do
68
56
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
69
57
  end
70
58
  end
71
59
 
72
- describe 'test attribute "uri"' do
60
+ describe 'test attribute "user_guid"' do
73
61
  it 'should work' do
74
62
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
75
63
  end
76
64
  end
77
65
 
78
- describe 'test attribute "user_guid"' do
66
+ describe 'test attribute "updated_at"' do
79
67
  it 'should work' do
80
68
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
81
69
  end
metadata CHANGED
@@ -1,16 +1,17 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: atrium-ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.3.0
4
+ version: 2.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - MX
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-01-31 00:00:00.000000000 Z
11
+ date: 2019-02-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
+ name: typhoeus
14
15
  requirement: !ruby/object:Gem::Requirement
15
16
  requirements:
16
17
  - - "~>"
@@ -19,9 +20,8 @@ dependencies:
19
20
  - - ">="
20
21
  - !ruby/object:Gem::Version
21
22
  version: 1.0.1
22
- name: typhoeus
23
- prerelease: false
24
23
  type: :runtime
24
+ prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
26
26
  requirements:
27
27
  - - "~>"
@@ -31,6 +31,7 @@ dependencies:
31
31
  - !ruby/object:Gem::Version
32
32
  version: 1.0.1
33
33
  - !ruby/object:Gem::Dependency
34
+ name: json
34
35
  requirement: !ruby/object:Gem::Requirement
35
36
  requirements:
36
37
  - - "~>"
@@ -39,9 +40,8 @@ dependencies:
39
40
  - - ">="
40
41
  - !ruby/object:Gem::Version
41
42
  version: 2.1.0
42
- name: json
43
- prerelease: false
44
43
  type: :runtime
44
+ prerelease: false
45
45
  version_requirements: !ruby/object:Gem::Requirement
46
46
  requirements:
47
47
  - - "~>"
@@ -51,6 +51,7 @@ dependencies:
51
51
  - !ruby/object:Gem::Version
52
52
  version: 2.1.0
53
53
  - !ruby/object:Gem::Dependency
54
+ name: rspec
54
55
  requirement: !ruby/object:Gem::Requirement
55
56
  requirements:
56
57
  - - "~>"
@@ -59,9 +60,8 @@ dependencies:
59
60
  - - ">="
60
61
  - !ruby/object:Gem::Version
61
62
  version: 3.6.0
62
- name: rspec
63
- prerelease: false
64
63
  type: :development
64
+ prerelease: false
65
65
  version_requirements: !ruby/object:Gem::Requirement
66
66
  requirements:
67
67
  - - "~>"
@@ -71,6 +71,7 @@ dependencies:
71
71
  - !ruby/object:Gem::Version
72
72
  version: 3.6.0
73
73
  - !ruby/object:Gem::Dependency
74
+ name: vcr
74
75
  requirement: !ruby/object:Gem::Requirement
75
76
  requirements:
76
77
  - - "~>"
@@ -79,9 +80,8 @@ dependencies:
79
80
  - - ">="
80
81
  - !ruby/object:Gem::Version
81
82
  version: 3.0.1
82
- name: vcr
83
- prerelease: false
84
83
  type: :development
84
+ prerelease: false
85
85
  version_requirements: !ruby/object:Gem::Requirement
86
86
  requirements:
87
87
  - - "~>"
@@ -91,6 +91,7 @@ dependencies:
91
91
  - !ruby/object:Gem::Version
92
92
  version: 3.0.1
93
93
  - !ruby/object:Gem::Dependency
94
+ name: webmock
94
95
  requirement: !ruby/object:Gem::Requirement
95
96
  requirements:
96
97
  - - "~>"
@@ -99,9 +100,8 @@ dependencies:
99
100
  - - ">="
100
101
  - !ruby/object:Gem::Version
101
102
  version: 1.24.3
102
- name: webmock
103
- prerelease: false
104
103
  type: :development
104
+ prerelease: false
105
105
  version_requirements: !ruby/object:Gem::Requirement
106
106
  requirements:
107
107
  - - "~>"
@@ -111,6 +111,7 @@ dependencies:
111
111
  - !ruby/object:Gem::Version
112
112
  version: 1.24.3
113
113
  - !ruby/object:Gem::Dependency
114
+ name: autotest
114
115
  requirement: !ruby/object:Gem::Requirement
115
116
  requirements:
116
117
  - - "~>"
@@ -119,9 +120,8 @@ dependencies:
119
120
  - - ">="
120
121
  - !ruby/object:Gem::Version
121
122
  version: 4.4.6
122
- name: autotest
123
- prerelease: false
124
123
  type: :development
124
+ prerelease: false
125
125
  version_requirements: !ruby/object:Gem::Requirement
126
126
  requirements:
127
127
  - - "~>"
@@ -131,6 +131,7 @@ dependencies:
131
131
  - !ruby/object:Gem::Version
132
132
  version: 4.4.6
133
133
  - !ruby/object:Gem::Dependency
134
+ name: autotest-rails-pure
134
135
  requirement: !ruby/object:Gem::Requirement
135
136
  requirements:
136
137
  - - "~>"
@@ -139,9 +140,8 @@ dependencies:
139
140
  - - ">="
140
141
  - !ruby/object:Gem::Version
141
142
  version: 4.1.2
142
- name: autotest-rails-pure
143
- prerelease: false
144
143
  type: :development
144
+ prerelease: false
145
145
  version_requirements: !ruby/object:Gem::Requirement
146
146
  requirements:
147
147
  - - "~>"
@@ -151,6 +151,7 @@ dependencies:
151
151
  - !ruby/object:Gem::Version
152
152
  version: 4.1.2
153
153
  - !ruby/object:Gem::Dependency
154
+ name: autotest-growl
154
155
  requirement: !ruby/object:Gem::Requirement
155
156
  requirements:
156
157
  - - "~>"
@@ -159,9 +160,8 @@ dependencies:
159
160
  - - ">="
160
161
  - !ruby/object:Gem::Version
161
162
  version: 0.2.16
162
- name: autotest-growl
163
- prerelease: false
164
163
  type: :development
164
+ prerelease: false
165
165
  version_requirements: !ruby/object:Gem::Requirement
166
166
  requirements:
167
167
  - - "~>"
@@ -171,6 +171,7 @@ dependencies:
171
171
  - !ruby/object:Gem::Version
172
172
  version: 0.2.16
173
173
  - !ruby/object:Gem::Dependency
174
+ name: autotest-fsevent
174
175
  requirement: !ruby/object:Gem::Requirement
175
176
  requirements:
176
177
  - - "~>"
@@ -179,9 +180,8 @@ dependencies:
179
180
  - - ">="
180
181
  - !ruby/object:Gem::Version
181
182
  version: 0.2.12
182
- name: autotest-fsevent
183
- prerelease: false
184
183
  type: :development
184
+ prerelease: false
185
185
  version_requirements: !ruby/object:Gem::Requirement
186
186
  requirements:
187
187
  - - "~>"
@@ -246,6 +246,7 @@ files:
246
246
  - docs/MerchantsApi.md
247
247
  - docs/Pagination.md
248
248
  - docs/Statement.md
249
+ - docs/StatementsApi.md
249
250
  - docs/StatementsResponseBody.md
250
251
  - docs/Transaction.md
251
252
  - docs/TransactionCleanseAndCategorizeRequest.md
@@ -272,6 +273,7 @@ files:
272
273
  - lib/atrium-ruby/api/institutions_api.rb
273
274
  - lib/atrium-ruby/api/members_api.rb
274
275
  - lib/atrium-ruby/api/merchants_api.rb
276
+ - lib/atrium-ruby/api/statements_api.rb
275
277
  - lib/atrium-ruby/api/transactions_api.rb
276
278
  - lib/atrium-ruby/api/users_api.rb
277
279
  - lib/atrium-ruby/api/verification_api.rb
@@ -337,6 +339,7 @@ files:
337
339
  - spec/api/institutions_api_spec.rb
338
340
  - spec/api/members_api_spec.rb
339
341
  - spec/api/merchants_api_spec.rb
342
+ - spec/api/statements_api_spec.rb
340
343
  - spec/api/transactions_api_spec.rb
341
344
  - spec/api/users_api_spec.rb
342
345
  - spec/api/verification_api_spec.rb
@@ -398,7 +401,7 @@ homepage: https://atrium.mx.com
398
401
  licenses:
399
402
  - MIT
400
403
  metadata: {}
401
- post_install_message:
404
+ post_install_message:
402
405
  rdoc_options: []
403
406
  require_paths:
404
407
  - lib
@@ -413,9 +416,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
413
416
  - !ruby/object:Gem::Version
414
417
  version: '0'
415
418
  requirements: []
416
- rubyforge_project:
417
- rubygems_version: 2.6.14.1
418
- signing_key:
419
+ rubyforge_project:
420
+ rubygems_version: 2.6.14
421
+ signing_key:
419
422
  specification_version: 4
420
423
  summary: Ruby wrapper for the Atrium API by MX
421
424
  test_files:
@@ -426,6 +429,7 @@ test_files:
426
429
  - spec/api/connect_widget_api_spec.rb
427
430
  - spec/api/institutions_api_spec.rb
428
431
  - spec/api/accounts_api_spec.rb
432
+ - spec/api/statements_api_spec.rb
429
433
  - spec/api/users_api_spec.rb
430
434
  - spec/api/merchants_api_spec.rb
431
435
  - spec/api/holdings_api_spec.rb