atrium-ruby 2.4.0 → 2.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 992d348d5ccb8a9a27f5d289e11cbdc0a99cb621
4
- data.tar.gz: 75d5eb9ca4e3b4f8b1077080530a2f24dd9660e8
3
+ metadata.gz: 18efce902d5a2379e7ad3891b4f154e4179c9523
4
+ data.tar.gz: 4c32ae6fbc45830ae49f62e3a7c4240d54fef9e6
5
5
  SHA512:
6
- metadata.gz: 4430540f0ca08ab95a85f93f1e58a8ec03150fd420e1d7f9dde0c26cd27c3c4e31ea5be0b58f14ae89fd0cc65c5e6643161b29d869a1764151a26ac0336d5e3e
7
- data.tar.gz: 6d4bf8a5a11e6dcb7ff618c59e1844da32f33f4c2a98c9404e35087e0c39204deb45e299e051f1b48ef14fafeb6b181fb14d4a62aa76bb017c71f9db963f6fff
6
+ metadata.gz: 2b783444cccada0dfc73dee846ced031930c34ef978818876b356f3c5eb5b71eed91dfe9b400e19fe8e60b0d5cffb076b37baeb5893c8499a5611fbe66dc2d2d
7
+ data.tar.gz: 14e0fbc11f2a3a76a05ec61c342da689761ebbe721026017de79fedda3caff12b295a4384ddbad1ce7de7fae644c5c740d22c2bb2cbb776dec6a0be515542f70
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.4.0.gem
20
+ gem install ./atrium-ruby-2.5.0.gem
21
21
  ```
22
22
 
23
23
  Finally add this to the Gemfile:
24
24
 
25
- gem 'atrium-ruby', '~> 2.4.0'
25
+ gem 'atrium-ruby', '~> 2.5.0'
26
26
 
27
27
  ### Install from Git
28
28
 
@@ -58,7 +58,7 @@ opts = {
58
58
 
59
59
  begin
60
60
  #List account transactions
61
- response = client.accounts.list_account_transactions(account_guid, user_guid, opts)
61
+ response = client.accounts.list_account_transactions(account_guid, user_guid, , opts)
62
62
  p response
63
63
  rescue Atrium::ApiError => e
64
64
  puts "Exception when calling AccountsApi->list_account_transactions: #{e}"
@@ -98,8 +98,10 @@ 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* | [**download_statement_pdf**](docs/StatementsApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement PDF
101
102
  *Atrium::StatementsApi* | [**fetch_statements**](docs/StatementsApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
102
103
  *Atrium::StatementsApi* | [**list_member_statements**](docs/StatementsApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
104
+ *Atrium::StatementsApi* | [**read_member_statement**](docs/StatementsApi.md#read_member_statement) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement JSON
103
105
  *Atrium::TransactionsApi* | [**cleanse_and_categorize_transactions**](docs/TransactionsApi.md#cleanse_and_categorize_transactions) | **POST** /cleanse_and_categorize | Categorize transactions
104
106
  *Atrium::TransactionsApi* | [**list_user_transactions**](docs/TransactionsApi.md#list_user_transactions) | **GET** /users/{user_guid}/transactions | List transactions for a user
105
107
  *Atrium::TransactionsApi* | [**read_transaction**](docs/TransactionsApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read a transaction
@@ -153,6 +155,7 @@ Class | Method | HTTP request | Description
153
155
  - [Atrium::MerchantResponseBody](docs/MerchantResponseBody.md)
154
156
  - [Atrium::Pagination](docs/Pagination.md)
155
157
  - [Atrium::Statement](docs/Statement.md)
158
+ - [Atrium::StatementResponseBody](docs/StatementResponseBody.md)
156
159
  - [Atrium::StatementsResponseBody](docs/StatementsResponseBody.md)
157
160
  - [Atrium::Transaction](docs/Transaction.md)
158
161
  - [Atrium::TransactionCleanseAndCategorizeRequest](docs/TransactionCleanseAndCategorizeRequest.md)
@@ -9,7 +9,7 @@ Method | HTTP request | Description
9
9
 
10
10
 
11
11
  # **list_account_transactions**
12
- > TransactionsResponseBody list_account_transactions(account_guid, user_guid, opts)
12
+ > TransactionsResponseBody list_account_transactions(account_guid, user_guid, , opts)
13
13
 
14
14
  List account transactions
15
15
 
@@ -33,7 +33,7 @@ opts = {
33
33
 
34
34
  begin
35
35
  #List account transactions
36
- response = client.accounts.list_account_transactions(account_guid, user_guid, opts)
36
+ response = client.accounts.list_account_transactions(account_guid, user_guid, , opts)
37
37
  p response
38
38
  rescue Atrium::ApiError => e
39
39
  puts "Exception when calling AccountsApi->list_account_transactions: #{e}"
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
56
56
  [**TransactionsResponseBody**](TransactionsResponseBody.md)
57
57
 
58
58
  # **list_user_accounts**
59
- > AccountsResponseBody list_user_accounts(user_guid, opts)
59
+ > AccountsResponseBody list_user_accounts(user_guid, , opts)
60
60
 
61
61
  List accounts for a user
62
62
 
@@ -77,7 +77,7 @@ opts = {
77
77
 
78
78
  begin
79
79
  #List accounts for a user
80
- response = client.accounts.list_user_accounts(user_guid, opts)
80
+ response = client.accounts.list_user_accounts(user_guid, , opts)
81
81
  p response
82
82
  rescue Atrium::ApiError => e
83
83
  puts "Exception when calling AccountsApi->list_user_accounts: #{e}"
@@ -97,7 +97,7 @@ Name | Type | Description | Notes
97
97
  [**AccountsResponseBody**](AccountsResponseBody.md)
98
98
 
99
99
  # **read_account**
100
- > AccountResponseBody read_account(account_guid, user_guid)
100
+ > AccountResponseBody read_account(account_guid, user_guid, )
101
101
 
102
102
  Read an account
103
103
 
@@ -115,7 +115,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
115
115
 
116
116
  begin
117
117
  #Read an account
118
- response = client.accounts.read_account(account_guid, user_guid)
118
+ response = client.accounts.read_account(account_guid, user_guid, )
119
119
  p response
120
120
  rescue Atrium::ApiError => e
121
121
  puts "Exception when calling AccountsApi->read_account: #{e}"
@@ -134,7 +134,7 @@ Name | Type | Description | Notes
134
134
  [**AccountResponseBody**](AccountResponseBody.md)
135
135
 
136
136
  # **read_account_by_member_guid**
137
- > AccountResponseBody read_account_by_member_guid(account_guid, member_guid, user_guid)
137
+ > AccountResponseBody read_account_by_member_guid(account_guid, member_guid, user_guid, )
138
138
 
139
139
  Read an account
140
140
 
@@ -153,7 +153,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
153
153
 
154
154
  begin
155
155
  #Read an account
156
- response = client.accounts.read_account_by_member_guid(account_guid, member_guid, user_guid)
156
+ response = client.accounts.read_account_by_member_guid(account_guid, member_guid, user_guid, )
157
157
  p response
158
158
  rescue Atrium::ApiError => e
159
159
  puts "Exception when calling AccountsApi->read_account_by_member_guid: #{e}"
@@ -6,7 +6,7 @@ Method | HTTP request | Description
6
6
 
7
7
 
8
8
  # **get_connect_widget**
9
- > ConnectWidgetResponseBody get_connect_widget(user_guidbody)
9
+ > ConnectWidgetResponseBody get_connect_widget(user_guid, body)
10
10
 
11
11
  Embedding in a website
12
12
 
@@ -24,7 +24,7 @@ body = Atrium::ConnectWidgetRequestBody.new # ConnectWidgetRequestBody | Optiona
24
24
 
25
25
  begin
26
26
  #Embedding in a website
27
- response = client.connectWidget.get_connect_widget(user_guidbody)
27
+ response = client.connectWidget.get_connect_widget(user_guid, body)
28
28
  p response
29
29
  rescue Atrium::ApiError => e
30
30
  puts "Exception when calling ConnectWidgetApi->get_connect_widget: #{e}"
@@ -9,7 +9,7 @@ Method | HTTP request | Description
9
9
 
10
10
 
11
11
  # **list_holdings**
12
- > HoldingsResponseBody list_holdings(user_guid)
12
+ > HoldingsResponseBody list_holdings(user_guid, )
13
13
 
14
14
  List holdings
15
15
 
@@ -26,7 +26,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
26
26
 
27
27
  begin
28
28
  #List holdings
29
- response = client.holdings.list_holdings(user_guid)
29
+ response = client.holdings.list_holdings(user_guid, )
30
30
  p response
31
31
  rescue Atrium::ApiError => e
32
32
  puts "Exception when calling HoldingsApi->list_holdings: #{e}"
@@ -44,7 +44,7 @@ Name | Type | Description | Notes
44
44
  [**HoldingsResponseBody**](HoldingsResponseBody.md)
45
45
 
46
46
  # **list_holdings_by_account**
47
- > HoldingsResponseBody list_holdings_by_account(account_guid, user_guid)
47
+ > HoldingsResponseBody list_holdings_by_account(account_guid, user_guid, )
48
48
 
49
49
  List holdings by account
50
50
 
@@ -62,7 +62,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
62
62
 
63
63
  begin
64
64
  #List holdings by account
65
- response = client.holdings.list_holdings_by_account(account_guid, user_guid)
65
+ response = client.holdings.list_holdings_by_account(account_guid, user_guid, )
66
66
  p response
67
67
  rescue Atrium::ApiError => e
68
68
  puts "Exception when calling HoldingsApi->list_holdings_by_account: #{e}"
@@ -81,7 +81,7 @@ Name | Type | Description | Notes
81
81
  [**HoldingsResponseBody**](HoldingsResponseBody.md)
82
82
 
83
83
  # **list_holdings_by_member**
84
- > HoldingsResponseBody list_holdings_by_member(member_guid, user_guid)
84
+ > HoldingsResponseBody list_holdings_by_member(member_guid, user_guid, )
85
85
 
86
86
  List holdings by member
87
87
 
@@ -99,7 +99,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
99
99
 
100
100
  begin
101
101
  #List holdings by member
102
- response = client.holdings.list_holdings_by_member(member_guid, user_guid)
102
+ response = client.holdings.list_holdings_by_member(member_guid, user_guid, )
103
103
  p response
104
104
  rescue Atrium::ApiError => e
105
105
  puts "Exception when calling HoldingsApi->list_holdings_by_member: #{e}"
@@ -118,7 +118,7 @@ Name | Type | Description | Notes
118
118
  [**HoldingsResponseBody**](HoldingsResponseBody.md)
119
119
 
120
120
  # **read_holding**
121
- > HoldingResponseBody read_holding(holding_guid, user_guid)
121
+ > HoldingResponseBody read_holding(holding_guid, user_guid, )
122
122
 
123
123
  Read holding
124
124
 
@@ -136,7 +136,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
136
136
 
137
137
  begin
138
138
  #Read holding
139
- response = client.holdings.read_holding(holding_guid, user_guid)
139
+ response = client.holdings.read_holding(holding_guid, user_guid, )
140
140
  p response
141
141
  rescue Atrium::ApiError => e
142
142
  puts "Exception when calling HoldingsApi->read_holding: #{e}"
@@ -7,7 +7,7 @@ Method | HTTP request | Description
7
7
 
8
8
 
9
9
  # **identify_member**
10
- > MemberResponseBody identify_member(member_guid, user_guid)
10
+ > MemberResponseBody identify_member(member_guid, user_guid, )
11
11
 
12
12
  Identify
13
13
 
@@ -25,7 +25,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
25
25
 
26
26
  begin
27
27
  #Identify
28
- response = client.identity.identify_member(member_guid, user_guid)
28
+ response = client.identity.identify_member(member_guid, user_guid, )
29
29
  p response
30
30
  rescue Atrium::ApiError => e
31
31
  puts "Exception when calling IdentityApi->identify_member: #{e}"
@@ -44,7 +44,7 @@ Name | Type | Description | Notes
44
44
  [**MemberResponseBody**](MemberResponseBody.md)
45
45
 
46
46
  # **list_account_owners**
47
- > AccountOwnersResponseBody list_account_owners(member_guid, user_guid)
47
+ > AccountOwnersResponseBody list_account_owners(member_guid, user_guid, )
48
48
 
49
49
  List member account owners
50
50
 
@@ -62,7 +62,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
62
62
 
63
63
  begin
64
64
  #List member account owners
65
- response = client.identity.list_account_owners(member_guid, user_guid)
65
+ response = client.identity.list_account_owners(member_guid, user_guid, )
66
66
  p response
67
67
  rescue Atrium::ApiError => e
68
68
  puts "Exception when calling IdentityApi->list_account_owners: #{e}"
@@ -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
 
@@ -36,7 +36,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
36
36
 
37
37
  begin
38
38
  #Aggregate member
39
- response = client.members.aggregate_member(member_guid, user_guid)
39
+ response = client.members.aggregate_member(member_guid, user_guid, )
40
40
  p response
41
41
  rescue Atrium::ApiError => e
42
42
  puts "Exception when calling MembersApi->aggregate_member: #{e}"
@@ -55,7 +55,7 @@ Name | Type | Description | Notes
55
55
  [**MemberResponseBody**](MemberResponseBody.md)
56
56
 
57
57
  # **create_member**
58
- > MemberResponseBody create_member(user_guidbody)
58
+ > MemberResponseBody create_member(user_guid, body)
59
59
 
60
60
  Create member
61
61
 
@@ -73,7 +73,7 @@ body = Atrium::MemberCreateRequestBody.new # MemberCreateRequestBody | Member ob
73
73
 
74
74
  begin
75
75
  #Create member
76
- response = client.members.create_member(user_guidbody)
76
+ response = client.members.create_member(user_guid, body)
77
77
  p response
78
78
  rescue Atrium::ApiError => e
79
79
  puts "Exception when calling MembersApi->create_member: #{e}"
@@ -92,7 +92,7 @@ Name | Type | Description | Notes
92
92
  [**MemberResponseBody**](MemberResponseBody.md)
93
93
 
94
94
  # **delete_member**
95
- > delete_member(member_guid, user_guid)
95
+ > delete_member(member_guid, user_guid, )
96
96
 
97
97
  Delete member
98
98
 
@@ -110,7 +110,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
110
110
 
111
111
  begin
112
112
  #Delete member
113
- client.members.delete_member(member_guid, user_guid)
113
+ client.members.delete_member(member_guid, user_guid, )
114
114
  rescue Atrium::ApiError => e
115
115
  puts "Exception when calling MembersApi->delete_member: #{e}"
116
116
  end
@@ -128,7 +128,7 @@ Name | Type | Description | Notes
128
128
  nil (empty response body)
129
129
 
130
130
  # **extend_history**
131
- > MemberResponseBody extend_history(member_guid, user_guid)
131
+ > MemberResponseBody extend_history(member_guid, user_guid, )
132
132
 
133
133
  Extend history
134
134
 
@@ -146,7 +146,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
146
146
 
147
147
  begin
148
148
  #Extend history
149
- response = client.members.extend_history(member_guid, user_guid)
149
+ response = client.members.extend_history(member_guid, user_guid, )
150
150
  p response
151
151
  rescue Atrium::ApiError => e
152
152
  puts "Exception when calling MembersApi->extend_history: #{e}"
@@ -165,7 +165,7 @@ Name | Type | Description | Notes
165
165
  [**MemberResponseBody**](MemberResponseBody.md)
166
166
 
167
167
  # **list_member_accounts**
168
- > AccountsResponseBody list_member_accounts(member_guid, user_guid, opts)
168
+ > AccountsResponseBody list_member_accounts(member_guid, user_guid, , opts)
169
169
 
170
170
  List member accounts
171
171
 
@@ -187,7 +187,7 @@ opts = {
187
187
 
188
188
  begin
189
189
  #List member accounts
190
- response = client.members.list_member_accounts(member_guid, user_guid, opts)
190
+ response = client.members.list_member_accounts(member_guid, user_guid, , opts)
191
191
  p response
192
192
  rescue Atrium::ApiError => e
193
193
  puts "Exception when calling MembersApi->list_member_accounts: #{e}"
@@ -208,7 +208,7 @@ Name | Type | Description | Notes
208
208
  [**AccountsResponseBody**](AccountsResponseBody.md)
209
209
 
210
210
  # **list_member_credentials**
211
- > CredentialsResponseBody list_member_credentials(member_guid, user_guid)
211
+ > CredentialsResponseBody list_member_credentials(member_guid, user_guid, )
212
212
 
213
213
  List member credentials
214
214
 
@@ -226,7 +226,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
226
226
 
227
227
  begin
228
228
  #List member credentials
229
- response = client.members.list_member_credentials(member_guid, user_guid)
229
+ response = client.members.list_member_credentials(member_guid, user_guid, )
230
230
  p response
231
231
  rescue Atrium::ApiError => e
232
232
  puts "Exception when calling MembersApi->list_member_credentials: #{e}"
@@ -245,7 +245,7 @@ Name | Type | Description | Notes
245
245
  [**CredentialsResponseBody**](CredentialsResponseBody.md)
246
246
 
247
247
  # **list_member_mfa_challenges**
248
- > ChallengesResponseBody list_member_mfa_challenges(member_guid, user_guid)
248
+ > ChallengesResponseBody list_member_mfa_challenges(member_guid, user_guid, )
249
249
 
250
250
  List member MFA challenges
251
251
 
@@ -263,7 +263,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
263
263
 
264
264
  begin
265
265
  #List member MFA challenges
266
- response = client.members.list_member_mfa_challenges(member_guid, user_guid)
266
+ response = client.members.list_member_mfa_challenges(member_guid, user_guid, )
267
267
  p response
268
268
  rescue Atrium::ApiError => e
269
269
  puts "Exception when calling MembersApi->list_member_mfa_challenges: #{e}"
@@ -282,7 +282,7 @@ Name | Type | Description | Notes
282
282
  [**ChallengesResponseBody**](ChallengesResponseBody.md)
283
283
 
284
284
  # **list_member_transactions**
285
- > TransactionsResponseBody list_member_transactions(member_guid, user_guid, opts)
285
+ > TransactionsResponseBody list_member_transactions(member_guid, user_guid, , opts)
286
286
 
287
287
  List member transactions
288
288
 
@@ -306,7 +306,7 @@ opts = {
306
306
 
307
307
  begin
308
308
  #List member transactions
309
- response = client.members.list_member_transactions(member_guid, user_guid, opts)
309
+ response = client.members.list_member_transactions(member_guid, user_guid, , opts)
310
310
  p response
311
311
  rescue Atrium::ApiError => e
312
312
  puts "Exception when calling MembersApi->list_member_transactions: #{e}"
@@ -329,7 +329,7 @@ Name | Type | Description | Notes
329
329
  [**TransactionsResponseBody**](TransactionsResponseBody.md)
330
330
 
331
331
  # **list_members**
332
- > MembersResponseBody list_members(user_guid, opts)
332
+ > MembersResponseBody list_members(user_guid, , opts)
333
333
 
334
334
  List members
335
335
 
@@ -350,7 +350,7 @@ opts = {
350
350
 
351
351
  begin
352
352
  #List members
353
- response = client.members.list_members(user_guid, opts)
353
+ response = client.members.list_members(user_guid, , opts)
354
354
  p response
355
355
  rescue Atrium::ApiError => e
356
356
  puts "Exception when calling MembersApi->list_members: #{e}"
@@ -370,7 +370,7 @@ Name | Type | Description | Notes
370
370
  [**MembersResponseBody**](MembersResponseBody.md)
371
371
 
372
372
  # **read_member**
373
- > MemberResponseBody read_member(member_guid, user_guid)
373
+ > MemberResponseBody read_member(member_guid, user_guid, )
374
374
 
375
375
  Read member
376
376
 
@@ -388,7 +388,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
388
388
 
389
389
  begin
390
390
  #Read member
391
- response = client.members.read_member(member_guid, user_guid)
391
+ response = client.members.read_member(member_guid, user_guid, )
392
392
  p response
393
393
  rescue Atrium::ApiError => e
394
394
  puts "Exception when calling MembersApi->read_member: #{e}"
@@ -407,7 +407,7 @@ Name | Type | Description | Notes
407
407
  [**MemberResponseBody**](MemberResponseBody.md)
408
408
 
409
409
  # **read_member_status**
410
- > MemberConnectionStatusResponseBody read_member_status(member_guid, user_guid)
410
+ > MemberConnectionStatusResponseBody read_member_status(member_guid, user_guid, )
411
411
 
412
412
  Read member connection status
413
413
 
@@ -425,7 +425,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
425
425
 
426
426
  begin
427
427
  #Read member connection status
428
- response = client.members.read_member_status(member_guid, user_guid)
428
+ response = client.members.read_member_status(member_guid, user_guid, )
429
429
  p response
430
430
  rescue Atrium::ApiError => e
431
431
  puts "Exception when calling MembersApi->read_member_status: #{e}"
@@ -444,7 +444,7 @@ Name | Type | Description | Notes
444
444
  [**MemberConnectionStatusResponseBody**](MemberConnectionStatusResponseBody.md)
445
445
 
446
446
  # **resume_member**
447
- > MemberResponseBody resume_member(member_guid, user_guidbody)
447
+ > MemberResponseBody resume_member(member_guid, user_guid, body)
448
448
 
449
449
  Resume aggregation from MFA
450
450
 
@@ -463,7 +463,7 @@ body = Atrium::MemberResumeRequestBody.new # MemberResumeRequestBody | Member ob
463
463
 
464
464
  begin
465
465
  #Resume aggregation from MFA
466
- response = client.members.resume_member(member_guid, user_guidbody)
466
+ response = client.members.resume_member(member_guid, user_guid, body)
467
467
  p response
468
468
  rescue Atrium::ApiError => e
469
469
  puts "Exception when calling MembersApi->resume_member: #{e}"
@@ -483,7 +483,7 @@ Name | Type | Description | Notes
483
483
  [**MemberResponseBody**](MemberResponseBody.md)
484
484
 
485
485
  # **update_member**
486
- > MemberResponseBody update_member(member_guid, user_guid, opts)
486
+ > MemberResponseBody update_member(member_guid, user_guid, , opts)
487
487
 
488
488
  Update member
489
489
 
@@ -504,7 +504,7 @@ opts = {
504
504
 
505
505
  begin
506
506
  #Update member
507
- response = client.members.update_member(member_guid, user_guid, opts)
507
+ response = client.members.update_member(member_guid, user_guid, , opts)
508
508
  p response
509
509
  rescue Atrium::ApiError => e
510
510
  puts "Exception when calling MembersApi->update_member: #{e}"
@@ -4,6 +4,7 @@
4
4
  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
+ **content_hash** | **String** | SHA256 digest of the pdf payload | [optional]
7
8
  **created_at** | **String** | The date and time the `statement` was created. | [optional]
8
9
  **guid** | **String** | The unique identifier for the `statement`. Defined by MX. | [optional]
9
10
  **member_guid** | **String** | The unique identifier for the `member` associated with the `statement`. Defined by MX. | [optional]
@@ -0,0 +1,8 @@
1
+ # Atrium::StatementResponseBody
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **user** | [**Statement**](Statement.md) | | [optional]
7
+
8
+
@@ -2,12 +2,53 @@
2
2
 
3
3
  Method | HTTP request | Description
4
4
  ------------- | ------------- | -------------
5
+ [**download_statement_pdf**](StatementsApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement PDF
5
6
  [**fetch_statements**](StatementsApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
6
7
  [**list_member_statements**](StatementsApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
8
+ [**read_member_statement**](StatementsApi.md#read_member_statement) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement JSON
7
9
 
8
10
 
11
+ # **download_statement_pdf**
12
+ > File download_statement_pdf(member_guid, user_guid, statement_guid)
13
+
14
+ Download statement PDF
15
+
16
+ Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each `statement` object.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'atrium-ruby'
22
+
23
+ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
24
+
25
+ member_guid = "MBR-123" # String | The unique identifier for a `member`.
26
+ user_guid = "USR-123" # String | The unique identifier for a `user`.
27
+ statement_guid = "STA-123" # String | The unique identifier for an `statement`.
28
+
29
+ begin
30
+ #Download statement PDF
31
+ response = client.statements.download_statement_pdf(member_guid, user_guid, statement_guid)
32
+ p response
33
+ rescue Atrium::ApiError => e
34
+ puts "Exception when calling StatementsApi->download_statement_pdf: #{e}"
35
+ end
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ Name | Type | Description | Notes
41
+ ------------- | ------------- | ------------- | -------------
42
+ **member_guid** | **String**| The unique identifier for a `member`. |
43
+ **user_guid** | **String**| The unique identifier for a `user`. |
44
+ **statement_guid** | **String**| The unique identifier for an `statement`. |
45
+
46
+ ### Return type
47
+
48
+ **File**
49
+
9
50
  # **fetch_statements**
10
- > MemberResponseBody fetch_statements(member_guid, user_guid)
51
+ > MemberResponseBody fetch_statements(member_guid, user_guid, )
11
52
 
12
53
  Fetch statements
13
54
 
@@ -25,7 +66,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
25
66
 
26
67
  begin
27
68
  #Fetch statements
28
- response = client.statements.fetch_statements(member_guid, user_guid)
69
+ response = client.statements.fetch_statements(member_guid, user_guid, )
29
70
  p response
30
71
  rescue Atrium::ApiError => e
31
72
  puts "Exception when calling StatementsApi->fetch_statements: #{e}"
@@ -44,7 +85,7 @@ Name | Type | Description | Notes
44
85
  [**MemberResponseBody**](MemberResponseBody.md)
45
86
 
46
87
  # **list_member_statements**
47
- > StatementsResponseBody list_member_statements(member_guid, user_guid, opts)
88
+ > StatementsResponseBody list_member_statements(member_guid, user_guid, , opts)
48
89
 
49
90
  List member statements
50
91
 
@@ -66,7 +107,7 @@ opts = {
66
107
 
67
108
  begin
68
109
  #List member statements
69
- response = client.statements.list_member_statements(member_guid, user_guid, opts)
110
+ response = client.statements.list_member_statements(member_guid, user_guid, , opts)
70
111
  p response
71
112
  rescue Atrium::ApiError => e
72
113
  puts "Exception when calling StatementsApi->list_member_statements: #{e}"
@@ -86,3 +127,42 @@ Name | Type | Description | Notes
86
127
 
87
128
  [**StatementsResponseBody**](StatementsResponseBody.md)
88
129
 
130
+ # **read_member_statement**
131
+ > StatementResponseBody read_member_statement(member_guid, user_guid, statement_guid)
132
+
133
+ Read statement JSON
134
+
135
+ Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each `statement` object.
136
+
137
+ ### Example
138
+ ```ruby
139
+ # load the gem
140
+ require 'atrium-ruby'
141
+
142
+ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
143
+
144
+ member_guid = "MBR-123" # String | The unique identifier for a `member`.
145
+ user_guid = "USR-123" # String | The unique identifier for a `user`.
146
+ statement_guid = "STA-123" # String | The unique identifier for an `statement`.
147
+
148
+ begin
149
+ #Read statement JSON
150
+ response = client.statements.read_member_statement(member_guid, user_guid, statement_guid)
151
+ p response
152
+ rescue Atrium::ApiError => e
153
+ puts "Exception when calling StatementsApi->read_member_statement: #{e}"
154
+ end
155
+ ```
156
+
157
+ ### Parameters
158
+
159
+ Name | Type | Description | Notes
160
+ ------------- | ------------- | ------------- | -------------
161
+ **member_guid** | **String**| The unique identifier for a `member`. |
162
+ **user_guid** | **String**| The unique identifier for a `user`. |
163
+ **statement_guid** | **String**| The unique identifier for an `statement`. |
164
+
165
+ ### Return type
166
+
167
+ [**StatementResponseBody**](StatementResponseBody.md)
168
+
@@ -43,7 +43,7 @@ Name | Type | Description | Notes
43
43
  [**TransactionsCleanseAndCategorizeResponseBody**](TransactionsCleanseAndCategorizeResponseBody.md)
44
44
 
45
45
  # **list_user_transactions**
46
- > TransactionsResponseBody list_user_transactions(user_guid, opts)
46
+ > TransactionsResponseBody list_user_transactions(user_guid, , opts)
47
47
 
48
48
  List transactions for a user
49
49
 
@@ -66,7 +66,7 @@ opts = {
66
66
 
67
67
  begin
68
68
  #List transactions for a user
69
- response = client.transactions.list_user_transactions(user_guid, opts)
69
+ response = client.transactions.list_user_transactions(user_guid, , opts)
70
70
  p response
71
71
  rescue Atrium::ApiError => e
72
72
  puts "Exception when calling TransactionsApi->list_user_transactions: #{e}"
@@ -88,7 +88,7 @@ Name | Type | Description | Notes
88
88
  [**TransactionsResponseBody**](TransactionsResponseBody.md)
89
89
 
90
90
  # **read_transaction**
91
- > TransactionResponseBody read_transaction(transaction_guid, user_guid)
91
+ > TransactionResponseBody read_transaction(transaction_guid, user_guid, )
92
92
 
93
93
  Read a transaction
94
94
 
@@ -106,7 +106,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
106
106
 
107
107
  begin
108
108
  #Read a transaction
109
- response = client.transactions.read_transaction(transaction_guid, user_guid)
109
+ response = client.transactions.read_transaction(transaction_guid, user_guid, )
110
110
  p response
111
111
  rescue Atrium::ApiError => e
112
112
  puts "Exception when calling TransactionsApi->read_transaction: #{e}"
@@ -45,7 +45,7 @@ Name | Type | Description | Notes
45
45
  [**UserResponseBody**](UserResponseBody.md)
46
46
 
47
47
  # **delete_user**
48
- > delete_user(user_guid)
48
+ > delete_user(user_guid, )
49
49
 
50
50
  Delete user
51
51
 
@@ -62,7 +62,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
62
62
 
63
63
  begin
64
64
  #Delete user
65
- client.users.delete_user(user_guid)
65
+ client.users.delete_user(user_guid, )
66
66
  rescue Atrium::ApiError => e
67
67
  puts "Exception when calling UsersApi->delete_user: #{e}"
68
68
  end
@@ -118,7 +118,7 @@ Name | Type | Description | Notes
118
118
  [**UsersResponseBody**](UsersResponseBody.md)
119
119
 
120
120
  # **read_user**
121
- > UserResponseBody read_user(user_guid)
121
+ > UserResponseBody read_user(user_guid, )
122
122
 
123
123
  Read user
124
124
 
@@ -135,7 +135,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
135
135
 
136
136
  begin
137
137
  #Read user
138
- response = client.users.read_user(user_guid)
138
+ response = client.users.read_user(user_guid, )
139
139
  p response
140
140
  rescue Atrium::ApiError => e
141
141
  puts "Exception when calling UsersApi->read_user: #{e}"
@@ -153,7 +153,7 @@ Name | Type | Description | Notes
153
153
  [**UserResponseBody**](UserResponseBody.md)
154
154
 
155
155
  # **update_user**
156
- > UserResponseBody update_user(user_guid, opts)
156
+ > UserResponseBody update_user(user_guid, , opts)
157
157
 
158
158
  Update user
159
159
 
@@ -173,7 +173,7 @@ opts = {
173
173
 
174
174
  begin
175
175
  #Update user
176
- response = client.users.update_user(user_guid, opts)
176
+ response = client.users.update_user(user_guid, , opts)
177
177
  p response
178
178
  rescue Atrium::ApiError => e
179
179
  puts "Exception when calling UsersApi->update_user: #{e}"
@@ -8,7 +8,7 @@ Method | HTTP request | Description
8
8
 
9
9
 
10
10
  # **list_account_numbers**
11
- > AccountNumbersResponseBody list_account_numbers(member_guid, user_guid)
11
+ > AccountNumbersResponseBody list_account_numbers(member_guid, user_guid, )
12
12
 
13
13
  Read account numbers
14
14
 
@@ -26,7 +26,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
26
26
 
27
27
  begin
28
28
  #Read account numbers
29
- response = client.verification.list_account_numbers(member_guid, user_guid)
29
+ response = client.verification.list_account_numbers(member_guid, user_guid, )
30
30
  p response
31
31
  rescue Atrium::ApiError => e
32
32
  puts "Exception when calling VerificationApi->list_account_numbers: #{e}"
@@ -45,7 +45,7 @@ Name | Type | Description | Notes
45
45
  [**AccountNumbersResponseBody**](AccountNumbersResponseBody.md)
46
46
 
47
47
  # **list_account_numbers_by_account**
48
- > AccountNumbersResponseBody list_account_numbers_by_account(account_guid, user_guid)
48
+ > AccountNumbersResponseBody list_account_numbers_by_account(account_guid, user_guid, )
49
49
 
50
50
  Read account numbers by account GUID
51
51
 
@@ -63,7 +63,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
63
63
 
64
64
  begin
65
65
  #Read account numbers by account GUID
66
- response = client.verification.list_account_numbers_by_account(account_guid, user_guid)
66
+ response = client.verification.list_account_numbers_by_account(account_guid, user_guid, )
67
67
  p response
68
68
  rescue Atrium::ApiError => e
69
69
  puts "Exception when calling VerificationApi->list_account_numbers_by_account: #{e}"
@@ -82,7 +82,7 @@ Name | Type | Description | Notes
82
82
  [**AccountNumbersResponseBody**](AccountNumbersResponseBody.md)
83
83
 
84
84
  # **verify_member**
85
- > MemberResponseBody verify_member(member_guid, user_guid)
85
+ > MemberResponseBody verify_member(member_guid, user_guid, )
86
86
 
87
87
  Verify
88
88
 
@@ -100,7 +100,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
100
100
 
101
101
  begin
102
102
  #Verify
103
- response = client.verification.verify_member(member_guid, user_guid)
103
+ response = client.verification.verify_member(member_guid, user_guid, )
104
104
  p response
105
105
  rescue Atrium::ApiError => e
106
106
  puts "Exception when calling VerificationApi->verify_member: #{e}"
@@ -51,6 +51,7 @@ require 'atrium-ruby/models/merchant'
51
51
  require 'atrium-ruby/models/merchant_response_body'
52
52
  require 'atrium-ruby/models/pagination'
53
53
  require 'atrium-ruby/models/statement'
54
+ require 'atrium-ruby/models/statement_response_body'
54
55
  require 'atrium-ruby/models/statements_response_body'
55
56
  require 'atrium-ruby/models/transaction'
56
57
  require 'atrium-ruby/models/transaction_cleanse_and_categorize_request'
@@ -15,6 +15,18 @@ module Atrium
15
15
  def initialize(api_client = ApiClient.default)
16
16
  @api_client = api_client
17
17
  end
18
+ # Download statement PDF
19
+ # Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each `statement` object.
20
+ # @param member_guid The unique identifier for a `member`.
21
+ # @param user_guid The unique identifier for a `user`.
22
+ # @param statement_guid The unique identifier for an `statement`.
23
+ # @param [Hash] opts the optional parameters
24
+ # @return [File]
25
+ def download_statement_pdf(member_guid, user_guid, statement_guid, opts = {})
26
+ data, _status_code, _headers = download_statement_pdf_with_http_info(member_guid, user_guid, statement_guid, opts)
27
+ data
28
+ end
29
+
18
30
  # Fetch statements
19
31
  # The fetch statements endpoint begins fetching statements for a member.
20
32
  # @param member_guid The unique identifier for a `member`.
@@ -39,9 +51,73 @@ module Atrium
39
51
  data
40
52
  end
41
53
 
54
+ # Read statement JSON
55
+ # Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each `statement` object.
56
+ # @param member_guid The unique identifier for a `member`.
57
+ # @param user_guid The unique identifier for a `user`.
58
+ # @param statement_guid The unique identifier for an `statement`.
59
+ # @param [Hash] opts the optional parameters
60
+ # @return [StatementResponseBody]
61
+ def read_member_statement(member_guid, user_guid, statement_guid, opts = {})
62
+ data, _status_code, _headers = read_member_statement_with_http_info(member_guid, user_guid, statement_guid, opts)
63
+ data
64
+ end
65
+
42
66
 
43
67
  private
44
68
 
69
+ # Download statement PDF
70
+ # Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each `statement` object.
71
+ # @param member_guid The unique identifier for a `member`.
72
+ # @param user_guid The unique identifier for a `user`.
73
+ # @param statement_guid The unique identifier for an `statement`.
74
+ # @param [Hash] opts the optional parameters
75
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
76
+ def download_statement_pdf_with_http_info(member_guid, user_guid, statement_guid, opts = {})
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug 'Calling API: StatementsApi.download_statement_pdf ...'
79
+ end
80
+ # verify the required parameter 'member_guid' is set
81
+ if @api_client.config.client_side_validation && member_guid.nil?
82
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling StatementsApi.download_statement_pdf"
83
+ end
84
+ # verify the required parameter 'user_guid' is set
85
+ if @api_client.config.client_side_validation && user_guid.nil?
86
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling StatementsApi.download_statement_pdf"
87
+ end
88
+ # verify the required parameter 'statement_guid' is set
89
+ if @api_client.config.client_side_validation && statement_guid.nil?
90
+ fail ArgumentError, "Missing the required parameter 'statement_guid' when calling StatementsApi.download_statement_pdf"
91
+ end
92
+ # resource path
93
+ local_var_path = '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf'.sub('{' + 'member_guid' + '}', member_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s).sub('{' + 'statement_guid' + '}', statement_guid.to_s)
94
+
95
+ # query parameters
96
+ query_params = {}
97
+
98
+ # header parameters
99
+ header_params = {}
100
+ # HTTP header 'Accept' (if needed)
101
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+pdf'])
102
+
103
+ # form parameters
104
+ form_params = {}
105
+
106
+ # http body (model)
107
+ post_body = nil
108
+ auth_names = ['apiKey', 'clientID']
109
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
110
+ :header_params => header_params,
111
+ :query_params => query_params,
112
+ :form_params => form_params,
113
+ :body => post_body,
114
+ :auth_names => auth_names,
115
+ :return_type => 'File')
116
+ if @api_client.config.debugging
117
+ @api_client.config.logger.debug "API called: StatementsApi#download_statement_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
118
+ end
119
+ return data, status_code, headers
120
+ end
45
121
  # Fetch statements
46
122
  # The fetch statements endpoint begins fetching statements for a member.
47
123
  # @param member_guid The unique identifier for a &#x60;member&#x60;.
@@ -142,5 +218,57 @@ module Atrium
142
218
  end
143
219
  return data, status_code, headers
144
220
  end
221
+ # Read statement JSON
222
+ # Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each &#x60;statement&#x60; object.
223
+ # @param member_guid The unique identifier for a &#x60;member&#x60;.
224
+ # @param user_guid The unique identifier for a &#x60;user&#x60;.
225
+ # @param statement_guid The unique identifier for an &#x60;statement&#x60;.
226
+ # @param [Hash] opts the optional parameters
227
+ # @return [Array<(StatementResponseBody, Fixnum, Hash)>] StatementResponseBody data, response status code and response headers
228
+ def read_member_statement_with_http_info(member_guid, user_guid, statement_guid, opts = {})
229
+ if @api_client.config.debugging
230
+ @api_client.config.logger.debug 'Calling API: StatementsApi.read_member_statement ...'
231
+ end
232
+ # verify the required parameter 'member_guid' is set
233
+ if @api_client.config.client_side_validation && member_guid.nil?
234
+ fail ArgumentError, "Missing the required parameter 'member_guid' when calling StatementsApi.read_member_statement"
235
+ end
236
+ # verify the required parameter 'user_guid' is set
237
+ if @api_client.config.client_side_validation && user_guid.nil?
238
+ fail ArgumentError, "Missing the required parameter 'user_guid' when calling StatementsApi.read_member_statement"
239
+ end
240
+ # verify the required parameter 'statement_guid' is set
241
+ if @api_client.config.client_side_validation && statement_guid.nil?
242
+ fail ArgumentError, "Missing the required parameter 'statement_guid' when calling StatementsApi.read_member_statement"
243
+ end
244
+ # resource path
245
+ local_var_path = '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}'.sub('{' + 'member_guid' + '}', member_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s).sub('{' + 'statement_guid' + '}', statement_guid.to_s)
246
+
247
+ # query parameters
248
+ query_params = {}
249
+
250
+ # header parameters
251
+ header_params = {}
252
+ # HTTP header 'Accept' (if needed)
253
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
254
+
255
+ # form parameters
256
+ form_params = {}
257
+
258
+ # http body (model)
259
+ post_body = nil
260
+ auth_names = ['apiKey', 'clientID']
261
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
262
+ :header_params => header_params,
263
+ :query_params => query_params,
264
+ :form_params => form_params,
265
+ :body => post_body,
266
+ :auth_names => auth_names,
267
+ :return_type => 'StatementResponseBody')
268
+ if @api_client.config.debugging
269
+ @api_client.config.logger.debug "API called: StatementsApi#read_member_statement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
270
+ end
271
+ return data, status_code, headers
272
+ end
145
273
  end
146
274
  end
@@ -13,6 +13,9 @@ module Atrium
13
13
  # The unique identifier for the `account` associated with the `statement`. Defined by MX.
14
14
  attr_accessor :account_guid
15
15
 
16
+ # SHA256 digest of the pdf payload
17
+ attr_accessor :content_hash
18
+
16
19
  # The date and time the `statement` was created.
17
20
  attr_accessor :created_at
18
21
 
@@ -35,6 +38,7 @@ module Atrium
35
38
  def self.attribute_map
36
39
  {
37
40
  :'account_guid' => :'account_guid',
41
+ :'content_hash' => :'content_hash',
38
42
  :'created_at' => :'created_at',
39
43
  :'guid' => :'guid',
40
44
  :'member_guid' => :'member_guid',
@@ -48,6 +52,7 @@ module Atrium
48
52
  def self.mx_types
49
53
  {
50
54
  :'account_guid' => :'String',
55
+ :'content_hash' => :'String',
51
56
  :'created_at' => :'String',
52
57
  :'guid' => :'String',
53
58
  :'member_guid' => :'String',
@@ -69,6 +74,10 @@ module Atrium
69
74
  self.account_guid = attributes[:'account_guid']
70
75
  end
71
76
 
77
+ if attributes.has_key?(:'content_hash')
78
+ self.content_hash = attributes[:'content_hash']
79
+ end
80
+
72
81
  if attributes.has_key?(:'created_at')
73
82
  self.created_at = attributes[:'created_at']
74
83
  end
@@ -113,6 +122,7 @@ module Atrium
113
122
  return true if self.equal?(o)
114
123
  self.class == o.class &&
115
124
  account_guid == o.account_guid &&
125
+ content_hash == o.content_hash &&
116
126
  created_at == o.created_at &&
117
127
  guid == o.guid &&
118
128
  member_guid == o.member_guid &&
@@ -130,7 +140,7 @@ module Atrium
130
140
  # Calculates hash code according to all attributes.
131
141
  # @return [Fixnum] Hash code
132
142
  def hash
133
- [account_guid, created_at, guid, member_guid, uri, user_guid, updated_at].hash
143
+ [account_guid, content_hash, created_at, guid, member_guid, uri, user_guid, updated_at].hash
134
144
  end
135
145
 
136
146
  # Builds the object from hash
@@ -0,0 +1,179 @@
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 'date'
10
+
11
+ module Atrium
12
+ class StatementResponseBody
13
+ attr_accessor :user
14
+
15
+ # Attribute mapping from ruby-style variable name to JSON key.
16
+ def self.attribute_map
17
+ {
18
+ :'user' => :'user'
19
+ }
20
+ end
21
+
22
+ # Attribute type mapping.
23
+ def self.mx_types
24
+ {
25
+ :'user' => :'Statement'
26
+ }
27
+ end
28
+
29
+ # Initializes the object
30
+ # @param [Hash] attributes Model attributes in the form of hash
31
+ def initialize(attributes = {})
32
+ return unless attributes.is_a?(Hash)
33
+
34
+ # convert string to symbol for hash key
35
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
36
+
37
+ if attributes.has_key?(:'user')
38
+ self.user = attributes[:'user']
39
+ end
40
+ end
41
+
42
+ # Show invalid properties with the reasons. Usually used together with valid?
43
+ # @return Array for valid properties with the reasons
44
+ def list_invalid_properties
45
+ invalid_properties = Array.new
46
+ invalid_properties
47
+ end
48
+
49
+ # Check to see if the all the properties in the model are valid
50
+ # @return true if the model is valid
51
+ def valid?
52
+ true
53
+ end
54
+
55
+ # Checks equality by comparing each attribute.
56
+ # @param [Object] Object to be compared
57
+ def ==(o)
58
+ return true if self.equal?(o)
59
+ self.class == o.class &&
60
+ user == o.user
61
+ end
62
+
63
+ # @see the `==` method
64
+ # @param [Object] Object to be compared
65
+ def eql?(o)
66
+ self == o
67
+ end
68
+
69
+ # Calculates hash code according to all attributes.
70
+ # @return [Fixnum] Hash code
71
+ def hash
72
+ [user].hash
73
+ end
74
+
75
+ # Builds the object from hash
76
+ # @param [Hash] attributes Model attributes in the form of hash
77
+ # @return [Object] Returns the model itself
78
+ def build_from_hash(attributes)
79
+ return nil unless attributes.is_a?(Hash)
80
+ self.class.mx_types.each_pair do |key, type|
81
+ if type =~ /\AArray<(.*)>/i
82
+ # check to ensure the input is an array given that the the attribute
83
+ # is documented as an array but the input is not
84
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
85
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
86
+ end
87
+ elsif !attributes[self.class.attribute_map[key]].nil?
88
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
89
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
90
+ end
91
+
92
+ self
93
+ end
94
+
95
+ # Deserializes the data based on type
96
+ # @param string type Data type
97
+ # @param string value Value to be deserialized
98
+ # @return [Object] Deserialized data
99
+ def _deserialize(type, value)
100
+ case type.to_sym
101
+ when :DateTime
102
+ DateTime.parse(value)
103
+ when :Date
104
+ Date.parse(value)
105
+ when :String
106
+ value.to_s
107
+ when :Integer
108
+ value.to_i
109
+ when :Float
110
+ value.to_f
111
+ when :BOOLEAN
112
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
113
+ true
114
+ else
115
+ false
116
+ end
117
+ when :Object
118
+ # generic object (usually a Hash), return directly
119
+ value
120
+ when /\AArray<(?<inner_type>.+)>\z/
121
+ inner_type = Regexp.last_match[:inner_type]
122
+ value.map { |v| _deserialize(inner_type, v) }
123
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
124
+ k_type = Regexp.last_match[:k_type]
125
+ v_type = Regexp.last_match[:v_type]
126
+ {}.tap do |hash|
127
+ value.each do |k, v|
128
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
129
+ end
130
+ end
131
+ else # model
132
+ temp_model = Atrium.const_get(type).new
133
+ temp_model.build_from_hash(value)
134
+ end
135
+ end
136
+
137
+ # Returns the string representation of the object
138
+ # @return [String] String presentation of the object
139
+ def to_s
140
+ to_hash.to_s
141
+ end
142
+
143
+ # to_body is an alias to to_hash (backward compatibility)
144
+ # @return [Hash] Returns the object in the form of hash
145
+ def to_body
146
+ to_hash
147
+ end
148
+
149
+ # Returns the object in the form of hash
150
+ # @return [Hash] Returns the object in the form of hash
151
+ def to_hash
152
+ hash = {}
153
+ self.class.attribute_map.each_pair do |attr, param|
154
+ value = self.send(attr)
155
+ next if value.nil?
156
+ hash[param] = _to_hash(value)
157
+ end
158
+ hash
159
+ end
160
+
161
+ # Outputs non-array value in the form of hash
162
+ # For object, use to_hash. Otherwise, just return the value
163
+ # @param [Object] value Any valid value
164
+ # @return [Hash] Returns the value in the form of hash
165
+ def _to_hash(value)
166
+ if value.is_a?(Array)
167
+ value.compact.map { |v| _to_hash(v) }
168
+ elsif value.is_a?(Hash)
169
+ {}.tap do |hash|
170
+ value.each { |k, v| hash[k] = _to_hash(v) }
171
+ end
172
+ elsif value.respond_to? :to_hash
173
+ value.to_hash
174
+ else
175
+ value
176
+ end
177
+ end
178
+ end
179
+ end
@@ -7,5 +7,5 @@
7
7
  =end
8
8
 
9
9
  module Atrium
10
- VERSION = '2.4.0'
10
+ VERSION = '2.5.0'
11
11
  end
@@ -27,6 +27,20 @@ describe 'StatementsApi' do
27
27
  end
28
28
  end
29
29
 
30
+ # unit tests for download_statement_pdf
31
+ # Download statement PDF
32
+ # Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each &#x60;statement&#x60; object.
33
+ # @param member_guid The unique identifier for a &#x60;member&#x60;.
34
+ # @param user_guid The unique identifier for a &#x60;user&#x60;.
35
+ # @param statement_guid The unique identifier for an &#x60;statement&#x60;.
36
+ # @param [Hash] opts the optional parameters
37
+ # @return [File]
38
+ describe 'download_statement_pdf test' do
39
+ it 'should work' do
40
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
41
+ end
42
+ end
43
+
30
44
  # unit tests for fetch_statements
31
45
  # Fetch statements
32
46
  # The fetch statements endpoint begins fetching statements for a member.
@@ -55,4 +69,18 @@ describe 'StatementsApi' do
55
69
  end
56
70
  end
57
71
 
72
+ # unit tests for read_member_statement
73
+ # Read statement JSON
74
+ # Use this endpoint to download a specified statement. The endpoint URL is the same as the URI given in each &#x60;statement&#x60; object.
75
+ # @param member_guid The unique identifier for a &#x60;member&#x60;.
76
+ # @param user_guid The unique identifier for a &#x60;user&#x60;.
77
+ # @param statement_guid The unique identifier for an &#x60;statement&#x60;.
78
+ # @param [Hash] opts the optional parameters
79
+ # @return [StatementResponseBody]
80
+ describe 'read_member_statement test' do
81
+ it 'should work' do
82
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
83
+ end
84
+ end
85
+
58
86
  end
@@ -0,0 +1,36 @@
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
+ require 'date'
12
+
13
+ # Unit tests for Atrium::StatementResponseBody
14
+ # Please update as you see appropriate
15
+ describe 'StatementResponseBody' do
16
+ before do
17
+ # run before each test
18
+ @instance = Atrium::StatementResponseBody.new
19
+ end
20
+
21
+ after do
22
+ # run after each test
23
+ end
24
+
25
+ describe 'test an instance of StatementResponseBody' do
26
+ it 'should create an instance of StatementResponseBody' do
27
+ expect(@instance).to be_instance_of(Atrium::StatementResponseBody)
28
+ end
29
+ end
30
+ describe 'test attribute "user"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
33
+ end
34
+ end
35
+
36
+ end
@@ -33,6 +33,12 @@ describe 'Statement' do
33
33
  end
34
34
  end
35
35
 
36
+ describe 'test attribute "content_hash"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
39
+ end
40
+ end
41
+
36
42
  describe 'test attribute "created_at"' do
37
43
  it 'should work' do
38
44
  # 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.0
4
+ version: 2.5.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-02-08 00:00:00.000000000 Z
11
+ date: 2019-02-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -246,6 +246,7 @@ files:
246
246
  - docs/MerchantsApi.md
247
247
  - docs/Pagination.md
248
248
  - docs/Statement.md
249
+ - docs/StatementResponseBody.md
249
250
  - docs/StatementsApi.md
250
251
  - docs/StatementsResponseBody.md
251
252
  - docs/Transaction.md
@@ -318,6 +319,7 @@ files:
318
319
  - lib/atrium-ruby/models/merchant_response_body.rb
319
320
  - lib/atrium-ruby/models/pagination.rb
320
321
  - lib/atrium-ruby/models/statement.rb
322
+ - lib/atrium-ruby/models/statement_response_body.rb
321
323
  - lib/atrium-ruby/models/statements_response_body.rb
322
324
  - lib/atrium-ruby/models/transaction.rb
323
325
  - lib/atrium-ruby/models/transaction_cleanse_and_categorize_request.rb
@@ -382,6 +384,7 @@ files:
382
384
  - spec/models/merchant_response_body_spec.rb
383
385
  - spec/models/merchant_spec.rb
384
386
  - spec/models/pagination_spec.rb
387
+ - spec/models/statement_response_body_spec.rb
385
388
  - spec/models/statement_spec.rb
386
389
  - spec/models/statements_response_body_spec.rb
387
390
  - spec/models/transaction_cleanse_and_categorize_request_spec.rb
@@ -471,6 +474,7 @@ test_files:
471
474
  - spec/models/member_create_request_spec.rb
472
475
  - spec/models/member_resume_request_body_spec.rb
473
476
  - spec/models/pagination_spec.rb
477
+ - spec/models/statement_response_body_spec.rb
474
478
  - spec/models/user_create_request_body_spec.rb
475
479
  - spec/models/user_update_request_body_spec.rb
476
480
  - spec/models/merchant_spec.rb