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.
- checksums.yaml +4 -4
- data/README.md +6 -4
- data/docs/AccountsApi.md +2 -2
- data/docs/InstitutionsApi.md +1 -1
- data/docs/MembersApi.md +43 -53
- data/docs/Statement.md +2 -4
- data/docs/StatementsApi.md +88 -0
- data/docs/TransactionsApi.md +1 -1
- data/docs/UsersApi.md +1 -1
- data/lib/atrium-ruby.rb +1 -0
- data/lib/atrium-ruby/api/atrium_client.rb +2 -0
- data/lib/atrium-ruby/api/members_api.rb +58 -65
- data/lib/atrium-ruby/api/statements_api.rb +146 -0
- data/lib/atrium-ruby/models/statement.rb +21 -41
- data/lib/atrium-ruby/version.rb +1 -1
- data/spec/api/members_api_spec.rb +13 -16
- data/spec/api/statements_api_spec.rb +58 -0
- data/spec/models/statement_spec.rb +4 -16
- metadata +29 -25
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 992d348d5ccb8a9a27f5d289e11cbdc0a99cb621
|
4
|
+
data.tar.gz: 75d5eb9ca4e3b4f8b1077080530a2f24dd9660e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4430540f0ca08ab95a85f93f1e58a8ec03150fd420e1d7f9dde0c26cd27c3c4e31ea5be0b58f14ae89fd0cc65c5e6643161b29d869a1764151a26ac0336d5e3e
|
7
|
+
data.tar.gz: 6d4bf8a5a11e6dcb7ff618c59e1844da32f33f4c2a98c9404e35087e0c39204deb45e299e051f1b48ef14fafeb6b181fb14d4a62aa76bb017c71f9db963f6fff
|
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.4.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.4.0'
|
26
26
|
|
27
27
|
### Install from Git
|
28
28
|
|
@@ -53,7 +53,7 @@ opts = {
|
|
53
53
|
from_date: "2016-09-20", # String | Filter transactions from this date.
|
54
54
|
to_date: "2016-10-20" # String | Filter transactions to this date.
|
55
55
|
page: 1, # Integer | Specify current page.
|
56
|
-
records_per_page: 12
|
56
|
+
records_per_page: 12 # Integer | Specify records per page.
|
57
57
|
}
|
58
58
|
|
59
59
|
begin
|
@@ -87,10 +87,10 @@ Class | Method | HTTP request | Description
|
|
87
87
|
*Atrium::MembersApi* | [**aggregate_member**](docs/MembersApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
|
88
88
|
*Atrium::MembersApi* | [**create_member**](docs/MembersApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
|
89
89
|
*Atrium::MembersApi* | [**delete_member**](docs/MembersApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
|
90
|
+
*Atrium::MembersApi* | [**extend_history**](docs/MembersApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
|
90
91
|
*Atrium::MembersApi* | [**list_member_accounts**](docs/MembersApi.md#list_member_accounts) | **GET** /users/{user_guid}/members/{member_guid}/accounts | List member accounts
|
91
92
|
*Atrium::MembersApi* | [**list_member_credentials**](docs/MembersApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials
|
92
93
|
*Atrium::MembersApi* | [**list_member_mfa_challenges**](docs/MembersApi.md#list_member_mfa_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member MFA challenges
|
93
|
-
*Atrium::MembersApi* | [**list_member_statements**](docs/MembersApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
|
94
94
|
*Atrium::MembersApi* | [**list_member_transactions**](docs/MembersApi.md#list_member_transactions) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List member transactions
|
95
95
|
*Atrium::MembersApi* | [**list_members**](docs/MembersApi.md#list_members) | **GET** /users/{user_guid}/members | List members
|
96
96
|
*Atrium::MembersApi* | [**read_member**](docs/MembersApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member
|
@@ -98,6 +98,8 @@ Class | Method | HTTP request | Description
|
|
98
98
|
*Atrium::MembersApi* | [**resume_member**](docs/MembersApi.md#resume_member) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation from MFA
|
99
99
|
*Atrium::MembersApi* | [**update_member**](docs/MembersApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member
|
100
100
|
*Atrium::MerchantsApi* | [**read_merchant**](docs/MerchantsApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant
|
101
|
+
*Atrium::StatementsApi* | [**fetch_statements**](docs/StatementsApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
|
102
|
+
*Atrium::StatementsApi* | [**list_member_statements**](docs/StatementsApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
|
101
103
|
*Atrium::TransactionsApi* | [**cleanse_and_categorize_transactions**](docs/TransactionsApi.md#cleanse_and_categorize_transactions) | **POST** /cleanse_and_categorize | Categorize transactions
|
102
104
|
*Atrium::TransactionsApi* | [**list_user_transactions**](docs/TransactionsApi.md#list_user_transactions) | **GET** /users/{user_guid}/transactions | List transactions for a user
|
103
105
|
*Atrium::TransactionsApi* | [**read_transaction**](docs/TransactionsApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read a transaction
|
data/docs/AccountsApi.md
CHANGED
@@ -28,7 +28,7 @@ opts = {
|
|
28
28
|
from_date: "2016-09-20", # String | Filter transactions from this date.
|
29
29
|
to_date: "2016-10-20" # String | Filter transactions to this date.
|
30
30
|
page: 1, # Integer | Specify current page.
|
31
|
-
records_per_page: 12
|
31
|
+
records_per_page: 12 # Integer | Specify records per page.
|
32
32
|
}
|
33
33
|
|
34
34
|
begin
|
@@ -72,7 +72,7 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
|
72
72
|
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
73
73
|
opts = {
|
74
74
|
page: 1, # Integer | Specify current page.
|
75
|
-
records_per_page: 12
|
75
|
+
records_per_page: 12 # Integer | Specify records per page.
|
76
76
|
}
|
77
77
|
|
78
78
|
begin
|
data/docs/InstitutionsApi.md
CHANGED
@@ -24,7 +24,7 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
|
24
24
|
opts = {
|
25
25
|
name: name_example, # String | This will list only institutions in which the appended string appears.
|
26
26
|
page: 1, # Integer | Specify current page.
|
27
|
-
records_per_page: 12
|
27
|
+
records_per_page: 12 # Integer | Specify records per page.
|
28
28
|
supports_account_identification: true, # BOOLEAN | Filter only institutions which support account identification.
|
29
29
|
supports_account_statement: true, # BOOLEAN | Filter only institutions which support account statements.
|
30
30
|
supports_account_verification: true, # BOOLEAN | Filter only institutions which support account verification.
|
data/docs/MembersApi.md
CHANGED
@@ -5,10 +5,10 @@ Method | HTTP request | Description
|
|
5
5
|
[**aggregate_member**](MembersApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
|
6
6
|
[**create_member**](MembersApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
|
7
7
|
[**delete_member**](MembersApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
|
8
|
+
[**extend_history**](MembersApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
|
8
9
|
[**list_member_accounts**](MembersApi.md#list_member_accounts) | **GET** /users/{user_guid}/members/{member_guid}/accounts | List member accounts
|
9
10
|
[**list_member_credentials**](MembersApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials
|
10
11
|
[**list_member_mfa_challenges**](MembersApi.md#list_member_mfa_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member MFA challenges
|
11
|
-
[**list_member_statements**](MembersApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
|
12
12
|
[**list_member_transactions**](MembersApi.md#list_member_transactions) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List member transactions
|
13
13
|
[**list_members**](MembersApi.md#list_members) | **GET** /users/{user_guid}/members | List members
|
14
14
|
[**read_member**](MembersApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member
|
@@ -18,7 +18,7 @@ Method | HTTP request | Description
|
|
18
18
|
|
19
19
|
|
20
20
|
# **aggregate_member**
|
21
|
-
> MemberResponseBody aggregate_member(member_guid, user_guid
|
21
|
+
> MemberResponseBody aggregate_member(member_guid, user_guid)
|
22
22
|
|
23
23
|
Aggregate member
|
24
24
|
|
@@ -33,13 +33,10 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
|
33
33
|
|
34
34
|
member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
35
35
|
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
36
|
-
opts = {
|
37
|
-
type: "history" # String | An optional parameter which determines the type of aggregation to be peformed. Possible values are `statement` and `history`.
|
38
|
-
}
|
39
36
|
|
40
37
|
begin
|
41
38
|
#Aggregate member
|
42
|
-
response = client.members.aggregate_member(member_guid, user_guid
|
39
|
+
response = client.members.aggregate_member(member_guid, user_guid)
|
43
40
|
p response
|
44
41
|
rescue Atrium::ApiError => e
|
45
42
|
puts "Exception when calling MembersApi->aggregate_member: #{e}"
|
@@ -52,7 +49,6 @@ Name | Type | Description | Notes
|
|
52
49
|
------------- | ------------- | ------------- | -------------
|
53
50
|
**member_guid** | **String**| The unique identifier for a `member`. |
|
54
51
|
**user_guid** | **String**| The unique identifier for a `user`. |
|
55
|
-
**type** | **String**| An optional parameter which determines the type of aggregation to be peformed. Possible values are `statement` and `history`. | [optional]
|
56
52
|
|
57
53
|
### Return type
|
58
54
|
|
@@ -131,12 +127,12 @@ Name | Type | Description | Notes
|
|
131
127
|
|
132
128
|
nil (empty response body)
|
133
129
|
|
134
|
-
# **
|
135
|
-
>
|
130
|
+
# **extend_history**
|
131
|
+
> MemberResponseBody extend_history(member_guid, user_guid)
|
136
132
|
|
137
|
-
|
133
|
+
Extend history
|
138
134
|
|
139
|
-
|
135
|
+
The extend_history endpoint begins the process of fetching up to 24 months of data associated with a particular `member`.
|
140
136
|
|
141
137
|
### Example
|
142
138
|
```ruby
|
@@ -147,17 +143,13 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
|
147
143
|
|
148
144
|
member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
149
145
|
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
150
|
-
opts = {
|
151
|
-
page: 1, # Integer | Specify current page.
|
152
|
-
records_per_page: 12, # Integer | Specify records per page.
|
153
|
-
}
|
154
146
|
|
155
147
|
begin
|
156
|
-
#
|
157
|
-
response = client.members.
|
148
|
+
#Extend history
|
149
|
+
response = client.members.extend_history(member_guid, user_guid)
|
158
150
|
p response
|
159
151
|
rescue Atrium::ApiError => e
|
160
|
-
puts "Exception when calling MembersApi->
|
152
|
+
puts "Exception when calling MembersApi->extend_history: #{e}"
|
161
153
|
end
|
162
154
|
```
|
163
155
|
|
@@ -167,19 +159,17 @@ Name | Type | Description | Notes
|
|
167
159
|
------------- | ------------- | ------------- | -------------
|
168
160
|
**member_guid** | **String**| The unique identifier for a `member`. |
|
169
161
|
**user_guid** | **String**| The unique identifier for a `user`. |
|
170
|
-
**page** | **Integer**| Specify current page. | [optional]
|
171
|
-
**records_per_page** | **Integer**| Specify records per page. | [optional]
|
172
162
|
|
173
163
|
### Return type
|
174
164
|
|
175
|
-
[**
|
165
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
176
166
|
|
177
|
-
# **
|
178
|
-
>
|
167
|
+
# **list_member_accounts**
|
168
|
+
> AccountsResponseBody list_member_accounts(member_guid, user_guid, opts)
|
179
169
|
|
180
|
-
List member
|
170
|
+
List member accounts
|
181
171
|
|
182
|
-
This endpoint returns an array
|
172
|
+
This endpoint returns an array with information about every account associated with a particular member.
|
183
173
|
|
184
174
|
### Example
|
185
175
|
```ruby
|
@@ -190,13 +180,17 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
|
190
180
|
|
191
181
|
member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
192
182
|
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
183
|
+
opts = {
|
184
|
+
page: 1, # Integer | Specify current page.
|
185
|
+
records_per_page: 12 # Integer | Specify records per page.
|
186
|
+
}
|
193
187
|
|
194
188
|
begin
|
195
|
-
#List member
|
196
|
-
response = client.members.
|
189
|
+
#List member accounts
|
190
|
+
response = client.members.list_member_accounts(member_guid, user_guid, opts)
|
197
191
|
p response
|
198
192
|
rescue Atrium::ApiError => e
|
199
|
-
puts "Exception when calling MembersApi->
|
193
|
+
puts "Exception when calling MembersApi->list_member_accounts: #{e}"
|
200
194
|
end
|
201
195
|
```
|
202
196
|
|
@@ -206,17 +200,19 @@ Name | Type | Description | Notes
|
|
206
200
|
------------- | ------------- | ------------- | -------------
|
207
201
|
**member_guid** | **String**| The unique identifier for a `member`. |
|
208
202
|
**user_guid** | **String**| The unique identifier for a `user`. |
|
203
|
+
**page** | **Integer**| Specify current page. | [optional]
|
204
|
+
**records_per_page** | **Integer**| Specify records per page. | [optional]
|
209
205
|
|
210
206
|
### Return type
|
211
207
|
|
212
|
-
[**
|
208
|
+
[**AccountsResponseBody**](AccountsResponseBody.md)
|
213
209
|
|
214
|
-
# **
|
215
|
-
>
|
210
|
+
# **list_member_credentials**
|
211
|
+
> CredentialsResponseBody list_member_credentials(member_guid, user_guid)
|
216
212
|
|
217
|
-
List member
|
213
|
+
List member credentials
|
218
214
|
|
219
|
-
|
215
|
+
This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
|
220
216
|
|
221
217
|
### Example
|
222
218
|
```ruby
|
@@ -229,11 +225,11 @@ member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
|
229
225
|
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
230
226
|
|
231
227
|
begin
|
232
|
-
#List member
|
233
|
-
response = client.members.
|
228
|
+
#List member credentials
|
229
|
+
response = client.members.list_member_credentials(member_guid, user_guid)
|
234
230
|
p response
|
235
231
|
rescue Atrium::ApiError => e
|
236
|
-
puts "Exception when calling MembersApi->
|
232
|
+
puts "Exception when calling MembersApi->list_member_credentials: #{e}"
|
237
233
|
end
|
238
234
|
```
|
239
235
|
|
@@ -246,14 +242,14 @@ Name | Type | Description | Notes
|
|
246
242
|
|
247
243
|
### Return type
|
248
244
|
|
249
|
-
[**
|
245
|
+
[**CredentialsResponseBody**](CredentialsResponseBody.md)
|
250
246
|
|
251
|
-
# **
|
252
|
-
>
|
247
|
+
# **list_member_mfa_challenges**
|
248
|
+
> ChallengesResponseBody list_member_mfa_challenges(member_guid, user_guid)
|
253
249
|
|
254
|
-
List member
|
250
|
+
List member MFA challenges
|
255
251
|
|
256
|
-
|
252
|
+
Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.<br> If the aggregation is not challenged, i.e., the member does not have a connection status of CHALLENGED, then code 204 No Content will be returned.<br> If the aggregation has been challenged, i.e., the member does have a connection status of CHALLENGED, then code 200 OK will be returned — along with the corresponding credentials.
|
257
253
|
|
258
254
|
### Example
|
259
255
|
```ruby
|
@@ -264,17 +260,13 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
|
264
260
|
|
265
261
|
member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
266
262
|
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
267
|
-
opts = {
|
268
|
-
page: 1, # Integer | Specify current page.
|
269
|
-
records_per_page: 12, # Integer | Specify records per page.
|
270
|
-
}
|
271
263
|
|
272
264
|
begin
|
273
|
-
#List member
|
274
|
-
response = client.members.
|
265
|
+
#List member MFA challenges
|
266
|
+
response = client.members.list_member_mfa_challenges(member_guid, user_guid)
|
275
267
|
p response
|
276
268
|
rescue Atrium::ApiError => e
|
277
|
-
puts "Exception when calling MembersApi->
|
269
|
+
puts "Exception when calling MembersApi->list_member_mfa_challenges: #{e}"
|
278
270
|
end
|
279
271
|
```
|
280
272
|
|
@@ -284,12 +276,10 @@ Name | Type | Description | Notes
|
|
284
276
|
------------- | ------------- | ------------- | -------------
|
285
277
|
**member_guid** | **String**| The unique identifier for a `member`. |
|
286
278
|
**user_guid** | **String**| The unique identifier for a `user`. |
|
287
|
-
**page** | **Integer**| Specify current page. | [optional]
|
288
|
-
**records_per_page** | **Integer**| Specify records per page. | [optional]
|
289
279
|
|
290
280
|
### Return type
|
291
281
|
|
292
|
-
[**
|
282
|
+
[**ChallengesResponseBody**](ChallengesResponseBody.md)
|
293
283
|
|
294
284
|
# **list_member_transactions**
|
295
285
|
> TransactionsResponseBody list_member_transactions(member_guid, user_guid, opts)
|
@@ -311,7 +301,7 @@ opts = {
|
|
311
301
|
from_date: "2016-09-20", # String | Filter transactions from this date.
|
312
302
|
to_date: "2016-10-20" # String | Filter transactions to this date.
|
313
303
|
page: 1, # Integer | Specify current page.
|
314
|
-
records_per_page: 12
|
304
|
+
records_per_page: 12 # Integer | Specify records per page.
|
315
305
|
}
|
316
306
|
|
317
307
|
begin
|
@@ -355,7 +345,7 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
|
355
345
|
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
356
346
|
opts = {
|
357
347
|
page: 1, # Integer | Specify current page.
|
358
|
-
records_per_page: 12
|
348
|
+
records_per_page: 12 # Integer | Specify records per page.
|
359
349
|
}
|
360
350
|
|
361
351
|
begin
|
data/docs/Statement.md
CHANGED
@@ -5,12 +5,10 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**account_guid** | **String** | The unique identifier for the `account` associated with the `statement`. Defined by MX. | [optional]
|
7
7
|
**created_at** | **String** | The date and time the `statement` was created. | [optional]
|
8
|
-
**content_hash** | **String** | An SHA-256 hash value of the statement's byte payload, used as a unique identifier. | [optional]
|
9
|
-
**deleted_at** | **String** | The date and time the `statement` was deleted. Statements are automatically deleted when an `account` is deleted. | [optional]
|
10
8
|
**guid** | **String** | The unique identifier for the `statement`. Defined by MX. | [optional]
|
11
|
-
**
|
12
|
-
**updated_at** | **String** | The date and time at which the `statement` was last updated. | [optional]
|
9
|
+
**member_guid** | **String** | The unique identifier for the `member` associated with the `statement`. Defined by MX. | [optional]
|
13
10
|
**uri** | **String** | A URI for accessing the byte payload of the `statement`. | [optional]
|
14
11
|
**user_guid** | **String** | The unique identifier for the `user` associated with the `statement`. Defined by MX. | [optional]
|
12
|
+
**updated_at** | **String** | The date and time at which the `statement` was last updated. | [optional]
|
15
13
|
|
16
14
|
|
@@ -0,0 +1,88 @@
|
|
1
|
+
# Atrium::StatementsApi
|
2
|
+
|
3
|
+
Method | HTTP request | Description
|
4
|
+
------------- | ------------- | -------------
|
5
|
+
[**fetch_statements**](StatementsApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
|
6
|
+
[**list_member_statements**](StatementsApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
|
7
|
+
|
8
|
+
|
9
|
+
# **fetch_statements**
|
10
|
+
> MemberResponseBody fetch_statements(member_guid, user_guid)
|
11
|
+
|
12
|
+
Fetch statements
|
13
|
+
|
14
|
+
The fetch statements endpoint begins fetching statements for a member.
|
15
|
+
|
16
|
+
### Example
|
17
|
+
```ruby
|
18
|
+
# load the gem
|
19
|
+
require 'atrium-ruby'
|
20
|
+
|
21
|
+
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
22
|
+
|
23
|
+
member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
24
|
+
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
25
|
+
|
26
|
+
begin
|
27
|
+
#Fetch statements
|
28
|
+
response = client.statements.fetch_statements(member_guid, user_guid)
|
29
|
+
p response
|
30
|
+
rescue Atrium::ApiError => e
|
31
|
+
puts "Exception when calling StatementsApi->fetch_statements: #{e}"
|
32
|
+
end
|
33
|
+
```
|
34
|
+
|
35
|
+
### Parameters
|
36
|
+
|
37
|
+
Name | Type | Description | Notes
|
38
|
+
------------- | ------------- | ------------- | -------------
|
39
|
+
**member_guid** | **String**| The unique identifier for a `member`. |
|
40
|
+
**user_guid** | **String**| The unique identifier for a `user`. |
|
41
|
+
|
42
|
+
### Return type
|
43
|
+
|
44
|
+
[**MemberResponseBody**](MemberResponseBody.md)
|
45
|
+
|
46
|
+
# **list_member_statements**
|
47
|
+
> StatementsResponseBody list_member_statements(member_guid, user_guid, opts)
|
48
|
+
|
49
|
+
List member statements
|
50
|
+
|
51
|
+
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`.
|
52
|
+
|
53
|
+
### Example
|
54
|
+
```ruby
|
55
|
+
# load the gem
|
56
|
+
require 'atrium-ruby'
|
57
|
+
|
58
|
+
client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
59
|
+
|
60
|
+
member_guid = "MBR-123" # String | The unique identifier for a `member`.
|
61
|
+
user_guid = "USR-123" # String | The unique identifier for a `user`.
|
62
|
+
opts = {
|
63
|
+
page: 1, # Integer | Specify current page.
|
64
|
+
records_per_page: 12 # Integer | Specify records per page.
|
65
|
+
}
|
66
|
+
|
67
|
+
begin
|
68
|
+
#List member statements
|
69
|
+
response = client.statements.list_member_statements(member_guid, user_guid, opts)
|
70
|
+
p response
|
71
|
+
rescue Atrium::ApiError => e
|
72
|
+
puts "Exception when calling StatementsApi->list_member_statements: #{e}"
|
73
|
+
end
|
74
|
+
```
|
75
|
+
|
76
|
+
### Parameters
|
77
|
+
|
78
|
+
Name | Type | Description | Notes
|
79
|
+
------------- | ------------- | ------------- | -------------
|
80
|
+
**member_guid** | **String**| The unique identifier for a `member`. |
|
81
|
+
**user_guid** | **String**| The unique identifier for a `user`. |
|
82
|
+
**page** | **Integer**| Specify current page. | [optional]
|
83
|
+
**records_per_page** | **Integer**| Specify records per page. | [optional]
|
84
|
+
|
85
|
+
### Return type
|
86
|
+
|
87
|
+
[**StatementsResponseBody**](StatementsResponseBody.md)
|
88
|
+
|
data/docs/TransactionsApi.md
CHANGED
@@ -60,7 +60,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
|
|
60
60
|
opts = {
|
61
61
|
page: 1, # Integer | Specify current page.
|
62
62
|
from_date: "2016-09-20", # String | Filter transactions from this date.
|
63
|
-
records_per_page: 12
|
63
|
+
records_per_page: 12 # Integer | Specify records per page.
|
64
64
|
to_date: "2016-10-20" # String | Filter transactions to this date.
|
65
65
|
}
|
66
66
|
|
data/docs/UsersApi.md
CHANGED
@@ -94,7 +94,7 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
|
|
94
94
|
|
95
95
|
opts = {
|
96
96
|
page: 1, # Integer | Specify current page.
|
97
|
-
records_per_page: 12
|
97
|
+
records_per_page: 12 # Integer | Specify records per page.
|
98
98
|
}
|
99
99
|
|
100
100
|
begin
|
data/lib/atrium-ruby.rb
CHANGED
@@ -73,6 +73,7 @@ require 'atrium-ruby/api/identity_api'
|
|
73
73
|
require 'atrium-ruby/api/institutions_api'
|
74
74
|
require 'atrium-ruby/api/members_api'
|
75
75
|
require 'atrium-ruby/api/merchants_api'
|
76
|
+
require 'atrium-ruby/api/statements_api'
|
76
77
|
require 'atrium-ruby/api/transactions_api'
|
77
78
|
require 'atrium-ruby/api/users_api'
|
78
79
|
require 'atrium-ruby/api/verification_api'
|