mx-platform-ruby 0.9.0 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +13 -13
- data/README.md +7 -7
- data/docs/HoldingResponse.md +1 -1
- data/docs/MxPlatformApi.md +96 -90
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +159 -131
- data/lib/mx-platform-ruby/models/account_number_response.rb +4 -0
- data/lib/mx-platform-ruby/models/account_owner_response.rb +4 -0
- data/lib/mx-platform-ruby/models/account_response.rb +3 -0
- data/lib/mx-platform-ruby/models/category_response.rb +2 -0
- data/lib/mx-platform-ruby/models/challenge_response.rb +1 -0
- data/lib/mx-platform-ruby/models/connect_widget_response.rb +1 -0
- data/lib/mx-platform-ruby/models/credential_request.rb +0 -1
- data/lib/mx-platform-ruby/models/credential_response.rb +2 -0
- data/lib/mx-platform-ruby/models/enhance_transaction_response.rb +1 -0
- data/lib/mx-platform-ruby/models/holding_response.rb +4 -0
- data/lib/mx-platform-ruby/models/member_response.rb +2 -0
- data/lib/mx-platform-ruby/models/member_status_response.rb +1 -0
- data/lib/mx-platform-ruby/models/merchant_location_response.rb +2 -0
- data/lib/mx-platform-ruby/models/merchant_response.rb +1 -0
- data/lib/mx-platform-ruby/models/o_auth_window_response.rb +1 -0
- data/lib/mx-platform-ruby/models/statement_response.rb +4 -0
- data/lib/mx-platform-ruby/models/tag_response.rb +2 -0
- data/lib/mx-platform-ruby/models/tagging_response.rb +4 -0
- data/lib/mx-platform-ruby/models/transaction_response.rb +6 -0
- data/lib/mx-platform-ruby/models/transaction_rule_response.rb +3 -0
- data/lib/mx-platform-ruby/models/transaction_rule_update_request.rb +0 -2
- data/lib/mx-platform-ruby/models/user_response.rb +1 -0
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/openapi/config.yml +1 -1
- data/openapi/templates/README.mustache +7 -7
- data/spec/api/mx_platform_api_spec.rb +19 -15
- metadata +2 -2
@@ -67,10 +67,14 @@ module MxPlatformRuby
|
|
67
67
|
# List of attributes with nullable: true
|
68
68
|
def self.openapi_nullable
|
69
69
|
Set.new([
|
70
|
+
:'account_guid',
|
70
71
|
:'account_number',
|
72
|
+
:'guid',
|
71
73
|
:'institution_number',
|
74
|
+
:'member_guid',
|
72
75
|
:'routing_number',
|
73
76
|
:'transit_number',
|
77
|
+
:'user_guid'
|
74
78
|
])
|
75
79
|
end
|
76
80
|
|
@@ -83,14 +83,18 @@ module MxPlatformRuby
|
|
83
83
|
# List of attributes with nullable: true
|
84
84
|
def self.openapi_nullable
|
85
85
|
Set.new([
|
86
|
+
:'account_guid',
|
86
87
|
:'address',
|
87
88
|
:'city',
|
88
89
|
:'country',
|
89
90
|
:'email',
|
91
|
+
:'guid',
|
92
|
+
:'member_guid',
|
90
93
|
:'owner_name',
|
91
94
|
:'phone',
|
92
95
|
:'postal_code',
|
93
96
|
:'state',
|
97
|
+
:'user_guid'
|
94
98
|
])
|
95
99
|
end
|
96
100
|
|
@@ -236,6 +236,7 @@ module MxPlatformRuby
|
|
236
236
|
:'currency_code',
|
237
237
|
:'day_payment_is_due',
|
238
238
|
:'death_benefit',
|
239
|
+
:'guid',
|
239
240
|
:'holdings_value',
|
240
241
|
:'id',
|
241
242
|
:'imported_at',
|
@@ -248,6 +249,7 @@ module MxPlatformRuby
|
|
248
249
|
:'last_payment_at',
|
249
250
|
:'loan_amount',
|
250
251
|
:'matures_on',
|
252
|
+
:'member_guid',
|
251
253
|
:'member_id',
|
252
254
|
:'member_is_managed_by_user',
|
253
255
|
:'metadata',
|
@@ -266,6 +268,7 @@ module MxPlatformRuby
|
|
266
268
|
:'total_account_value',
|
267
269
|
:'type',
|
268
270
|
:'updated_at',
|
271
|
+
:'user_guid',
|
269
272
|
:'user_id'
|
270
273
|
])
|
271
274
|
end
|
@@ -107,20 +107,24 @@ module MxPlatformRuby
|
|
107
107
|
# List of attributes with nullable: true
|
108
108
|
def self.openapi_nullable
|
109
109
|
Set.new([
|
110
|
+
:'account_guid',
|
110
111
|
:'cost_basis',
|
111
112
|
:'created_at',
|
112
113
|
:'currency_code',
|
113
114
|
:'cusip',
|
114
115
|
:'daily_change',
|
115
116
|
:'description',
|
117
|
+
:'guid',
|
116
118
|
:'holding_type',
|
117
119
|
:'id',
|
118
120
|
:'market_value',
|
121
|
+
:'member_guid',
|
119
122
|
:'metadata',
|
120
123
|
:'purchase_price',
|
121
124
|
:'shares',
|
122
125
|
:'symbol',
|
123
126
|
:'updated_at',
|
127
|
+
:'user_guid'
|
124
128
|
])
|
125
129
|
end
|
126
130
|
|
@@ -93,6 +93,7 @@ module MxPlatformRuby
|
|
93
93
|
Set.new([
|
94
94
|
:'aggregated_at',
|
95
95
|
:'connection_status',
|
96
|
+
:'guid',
|
96
97
|
:'id',
|
97
98
|
:'institution_code',
|
98
99
|
:'is_being_aggregated',
|
@@ -102,6 +103,7 @@ module MxPlatformRuby
|
|
102
103
|
:'name',
|
103
104
|
:'oauth_window_uri',
|
104
105
|
:'successfully_aggregated_at',
|
106
|
+
:'user_guid',
|
105
107
|
:'user_id'
|
106
108
|
])
|
107
109
|
end
|
@@ -67,10 +67,14 @@ module MxPlatformRuby
|
|
67
67
|
# List of attributes with nullable: true
|
68
68
|
def self.openapi_nullable
|
69
69
|
Set.new([
|
70
|
+
:'account_guid',
|
70
71
|
:'content_hash',
|
71
72
|
:'created_at',
|
73
|
+
:'guid',
|
74
|
+
:'member_guid',
|
72
75
|
:'updated_at',
|
73
76
|
:'uri',
|
77
|
+
:'user_guid'
|
74
78
|
])
|
75
79
|
end
|
76
80
|
|
@@ -207,6 +207,7 @@ module MxPlatformRuby
|
|
207
207
|
# List of attributes with nullable: true
|
208
208
|
def self.openapi_nullable
|
209
209
|
Set.new([
|
210
|
+
:'account_guid',
|
210
211
|
:'account_id',
|
211
212
|
:'amount',
|
212
213
|
:'category',
|
@@ -217,6 +218,7 @@ module MxPlatformRuby
|
|
217
218
|
:'date',
|
218
219
|
:'description',
|
219
220
|
:'extended_transaction_type',
|
221
|
+
:'guid',
|
220
222
|
:'id',
|
221
223
|
:'is_bill_pay',
|
222
224
|
:'is_direct_deposit',
|
@@ -232,9 +234,12 @@ module MxPlatformRuby
|
|
232
234
|
:'localized_description',
|
233
235
|
:'localized_memo',
|
234
236
|
:'longitude',
|
237
|
+
:'member_guid',
|
235
238
|
:'member_is_managed_by_user',
|
236
239
|
:'memo',
|
237
240
|
:'merchant_category_code',
|
241
|
+
:'merchant_guid',
|
242
|
+
:'merchant_location_guid',
|
238
243
|
:'metadata',
|
239
244
|
:'original_description',
|
240
245
|
:'posted_at',
|
@@ -243,6 +248,7 @@ module MxPlatformRuby
|
|
243
248
|
:'transacted_at',
|
244
249
|
:'type',
|
245
250
|
:'updated_at',
|
251
|
+
:'user_guid',
|
246
252
|
:'user_id'
|
247
253
|
])
|
248
254
|
end
|
@@ -63,10 +63,13 @@ module MxPlatformRuby
|
|
63
63
|
# List of attributes with nullable: true
|
64
64
|
def self.openapi_nullable
|
65
65
|
Set.new([
|
66
|
+
:'category_guid',
|
66
67
|
:'created_at',
|
67
68
|
:'description',
|
69
|
+
:'guid',
|
68
70
|
:'match_description',
|
69
71
|
:'updated_at',
|
72
|
+
:'user_guid'
|
70
73
|
])
|
71
74
|
end
|
72
75
|
|
data/openapi/config.yml
CHANGED
@@ -38,7 +38,7 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
38
38
|
```ruby
|
39
39
|
require 'mx-platform-ruby'
|
40
40
|
|
41
|
-
MxPlatformRuby.configure do |config|
|
41
|
+
::MxPlatformRuby.configure do |config|
|
42
42
|
# Configure with your Client ID/API Key from https://dashboard.mx.com
|
43
43
|
config.username = 'Your Client ID'
|
44
44
|
config.password = 'Your API Key'
|
@@ -51,16 +51,16 @@ api_client = ::MxPlatformRuby::ApiClient.new
|
|
51
51
|
api_client.default_headers['Accept'] = 'application/vnd.mx.api.v1+json'
|
52
52
|
mx_platform_api = ::MxPlatformRuby::MxPlatformApi.new(api_client)
|
53
53
|
|
54
|
-
|
55
|
-
user: MxPlatformRuby::UserCreateRequest.new(
|
56
|
-
metadata:
|
54
|
+
request_body = ::MxPlatformRuby::UserCreateRequestBody.new(
|
55
|
+
user: ::MxPlatformRuby::UserCreateRequest.new(
|
56
|
+
metadata: 'Creating a user!'
|
57
57
|
)
|
58
58
|
)
|
59
59
|
|
60
60
|
begin
|
61
|
-
|
62
|
-
p
|
63
|
-
rescue MxPlatformRuby::ApiError => e
|
61
|
+
response = mx_platform_api.create_user(request_body)
|
62
|
+
p response
|
63
|
+
rescue ::MxPlatformRuby::ApiError => e
|
64
64
|
puts "Error when calling MxPlatformApi->create_user: #{e}"
|
65
65
|
end
|
66
66
|
```
|
@@ -74,8 +74,8 @@ describe 'MxPlatformApi' do
|
|
74
74
|
# unit tests for create_managed_account
|
75
75
|
# Create managed account
|
76
76
|
# Use this endpoint to create a partner-managed account.
|
77
|
-
# @param user_guid The unique id for a `user`.
|
78
77
|
# @param member_guid The unique id for a `member`.
|
78
|
+
# @param user_guid The unique id for a `user`.
|
79
79
|
# @param managed_account_create_request_body Managed account to be created.
|
80
80
|
# @param [Hash] opts the optional parameters
|
81
81
|
# @return [AccountResponseBody]
|
@@ -101,8 +101,9 @@ describe 'MxPlatformApi' do
|
|
101
101
|
# unit tests for create_managed_transaction
|
102
102
|
# Create managed transaction
|
103
103
|
# Use this endpoint to create a new partner-managed `transaction`.
|
104
|
-
# @param
|
104
|
+
# @param account_guid The unique id for an `account`.
|
105
105
|
# @param member_guid The unique id for a `member`.
|
106
|
+
# @param user_guid The unique id for a `user`.
|
106
107
|
# @param managed_transaction_create_request_body Managed transaction to be created.
|
107
108
|
# @param [Hash] opts the optional parameters
|
108
109
|
# @return [TransactionResponseBody]
|
@@ -192,9 +193,9 @@ describe 'MxPlatformApi' do
|
|
192
193
|
# unit tests for delete_managed_account
|
193
194
|
# Delete managed account
|
194
195
|
# Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`.
|
196
|
+
# @param account_guid The unique id for an `account`.
|
195
197
|
# @param member_guid The unique id for a `member`.
|
196
198
|
# @param user_guid The unique id for a `user`.
|
197
|
-
# @param account_guid The unique id for an `account`.
|
198
199
|
# @param [Hash] opts the optional parameters
|
199
200
|
# @return [nil]
|
200
201
|
describe 'delete_managed_account test' do
|
@@ -219,9 +220,10 @@ describe 'MxPlatformApi' do
|
|
219
220
|
# unit tests for delete_managed_transaction
|
220
221
|
# Delete managed transaction
|
221
222
|
# Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource.
|
223
|
+
# @param account_guid The unique id for an `account`.
|
222
224
|
# @param member_guid The unique id for a `member`.
|
223
|
-
# @param user_guid The unique id for a `user`.
|
224
225
|
# @param transaction_guid The unique id for a `transaction`.
|
226
|
+
# @param user_guid The unique id for a `user`.
|
225
227
|
# @param [Hash] opts the optional parameters
|
226
228
|
# @return [nil]
|
227
229
|
describe 'delete_managed_transaction test' do
|
@@ -543,8 +545,8 @@ describe 'MxPlatformApi' do
|
|
543
545
|
# unit tests for list_managed_accounts
|
544
546
|
# List managed accounts
|
545
547
|
# Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member.
|
546
|
-
# @param user_guid The unique id for a `user`.
|
547
548
|
# @param member_guid The unique id for a `member`.
|
549
|
+
# @param user_guid The unique id for a `user`.
|
548
550
|
# @param [Hash] opts the optional parameters
|
549
551
|
# @option opts [Integer] :page Specify current page.
|
550
552
|
# @option opts [Integer] :records_per_page Specify records per page.
|
@@ -585,8 +587,9 @@ describe 'MxPlatformApi' do
|
|
585
587
|
# unit tests for list_managed_transactions
|
586
588
|
# List managed transactions
|
587
589
|
# This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`.
|
588
|
-
# @param
|
590
|
+
# @param account_guid The unique id for an `account`.
|
589
591
|
# @param member_guid The unique id for a `member`.
|
592
|
+
# @param user_guid The unique id for a `user`.
|
590
593
|
# @param [Hash] opts the optional parameters
|
591
594
|
# @option opts [Integer] :page Specify current page.
|
592
595
|
# @option opts [Integer] :records_per_page Specify records per page.
|
@@ -835,7 +838,6 @@ describe 'MxPlatformApi' do
|
|
835
838
|
# Read a default category
|
836
839
|
# Use this endpoint to read the attributes of a default category.
|
837
840
|
# @param category_guid The unique id for a `category`.
|
838
|
-
# @param user_guid The unique id for a `user`.
|
839
841
|
# @param [Hash] opts the optional parameters
|
840
842
|
# @return [CategoryResponseBody]
|
841
843
|
describe 'read_default_category test' do
|
@@ -872,9 +874,9 @@ describe 'MxPlatformApi' do
|
|
872
874
|
# unit tests for read_managed_account
|
873
875
|
# Read managed account
|
874
876
|
# Use this endpoint to read the attributes of a partner-managed account according to its unique guid.
|
877
|
+
# @param account_guid The unique id for an `account`.
|
875
878
|
# @param member_guid The unique id for a `member`.
|
876
879
|
# @param user_guid The unique id for a `user`.
|
877
|
-
# @param account_guid The unique id for an `account`.
|
878
880
|
# @param [Hash] opts the optional parameters
|
879
881
|
# @return [AccountResponseBody]
|
880
882
|
describe 'read_managed_account test' do
|
@@ -899,9 +901,10 @@ describe 'MxPlatformApi' do
|
|
899
901
|
# unit tests for read_managed_transaction
|
900
902
|
# Read managed transaction
|
901
903
|
# Requests to this endpoint will return the attributes of the specified partner-managed `transaction`.
|
904
|
+
# @param account_guid The unique id for an `account`.
|
902
905
|
# @param member_guid The unique id for a `member`.
|
903
|
-
# @param user_guid The unique id for a `user`.
|
904
906
|
# @param transaction_guid The unique id for a `transaction`.
|
907
|
+
# @param user_guid The unique id for a `user`.
|
905
908
|
# @param [Hash] opts the optional parameters
|
906
909
|
# @return [TransactionResponseBody]
|
907
910
|
describe 'read_managed_transaction test' do
|
@@ -1042,8 +1045,8 @@ describe 'MxPlatformApi' do
|
|
1042
1045
|
# Request connect widget url
|
1043
1046
|
# This endpoint will return a URL for an embeddable version of MX Connect.
|
1044
1047
|
# @param user_guid The unique id for a `user`.
|
1048
|
+
# @param connect_widget_request_body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
|
1045
1049
|
# @param [Hash] opts the optional parameters
|
1046
|
-
# @option opts [ConnectWidgetRequestBody] :connect_widget_request_body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
|
1047
1050
|
# @return [ConnectWidgetResponseBody]
|
1048
1051
|
describe 'request_connect_widget_url test' do
|
1049
1052
|
it 'should work' do
|
@@ -1058,8 +1061,8 @@ describe 'MxPlatformApi' do
|
|
1058
1061
|
# @param user_guid The unique id for a `user`.
|
1059
1062
|
# @param [Hash] opts the optional parameters
|
1060
1063
|
# @option opts [String] :referral_source Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
|
1061
|
-
# @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in.
|
1062
1064
|
# @option opts [Boolean] :skip_aggregation Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
|
1065
|
+
# @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in.
|
1063
1066
|
# @return [OAuthWindowResponseBody]
|
1064
1067
|
describe 'request_o_auth_window_uri test' do
|
1065
1068
|
it 'should work' do
|
@@ -1098,9 +1101,9 @@ describe 'MxPlatformApi' do
|
|
1098
1101
|
# unit tests for update_account_by_member
|
1099
1102
|
# Update account by member
|
1100
1103
|
# This endpoint allows you to update certain attributes of an `account` resource.
|
1101
|
-
# @param user_guid The unique id for a `user`.
|
1102
|
-
# @param member_guid The unique id for a `member`.
|
1103
1104
|
# @param account_guid The unique id for an `account`.
|
1105
|
+
# @param member_guid The unique id for a `member`.
|
1106
|
+
# @param user_guid The unique id for a `user`.
|
1104
1107
|
# @param account_update_request_body Account object to be created with optional parameters (is_hidden)
|
1105
1108
|
# @param [Hash] opts the optional parameters
|
1106
1109
|
# @return [AccountResponseBody]
|
@@ -1127,9 +1130,9 @@ describe 'MxPlatformApi' do
|
|
1127
1130
|
# unit tests for update_managed_account
|
1128
1131
|
# Update managed account
|
1129
1132
|
# Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.
|
1133
|
+
# @param account_guid The unique id for an `account`.
|
1130
1134
|
# @param member_guid The unique id for a `member`.
|
1131
1135
|
# @param user_guid The unique id for a `user`.
|
1132
|
-
# @param account_guid The unique id for an `account`.
|
1133
1136
|
# @param managed_account_update_request_body Managed account object to be updated (While no single parameter is required, the request body can't be empty)
|
1134
1137
|
# @param [Hash] opts the optional parameters
|
1135
1138
|
# @return [AccountResponseBody]
|
@@ -1156,9 +1159,10 @@ describe 'MxPlatformApi' do
|
|
1156
1159
|
# unit tests for update_managed_transaction
|
1157
1160
|
# Update managed transaction
|
1158
1161
|
# Use this endpoint to update the attributes of the specified partner_managed `transaction`.
|
1162
|
+
# @param account_guid The unique id for an `account`.
|
1159
1163
|
# @param member_guid The unique id for a `member`.
|
1160
|
-
# @param user_guid The unique id for a `user`.
|
1161
1164
|
# @param transaction_guid The unique id for a `transaction`.
|
1165
|
+
# @param user_guid The unique id for a `user`.
|
1162
1166
|
# @param managed_transaction_update_request_body Managed transaction object to be updated (While no single parameter is required, the request body can't be empty)
|
1163
1167
|
# @param [Hash] opts the optional parameters
|
1164
1168
|
# @return [TransactionResponseBody]
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: mx-platform-ruby
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- MX
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-02-
|
11
|
+
date: 2022-02-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|