mx-platform-ruby 0.13.1 → 0.14.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
  SHA256:
3
- metadata.gz: 0f4cb1fbbb31e28057c45e490bbf68e7fc0766edd67c020cc091c947a6429456
4
- data.tar.gz: 221346e032385e534779514a0a47abb55a96824595f97612007d378b1ae0261c
3
+ metadata.gz: 704300e7f4ab00b263d90b0534176702c0174116a0b16d1380f311b0f233b1d6
4
+ data.tar.gz: 8c385328b97c554b1e939d414f980c97c809ff9d535b08fe9decf178123ccef1
5
5
  SHA512:
6
- metadata.gz: 67e1a34a73cee9c23883134d234178ff9055176f1ccfb6b3471f44b4ba1f2d9ac3634458a10b6781e8b37277bc598930582a352902a4e447056774216c91f36f
7
- data.tar.gz: 7a17ee9af7712631a18de30b1c14282922d2f0296e4f35ec866ea8a0e7bac64be2802779ea33c7e33bcf933b84be22a1bb337f1ca24e2ed358547c321101c831
6
+ metadata.gz: aa2c6669e3889a5cc23fca0aab572ce5fa5ef76455cfc2a0a079230584e5ec4e51a434908b707269c1db67391e1e46a4e5d56c79dba7ef6c53a2016230f1331e
7
+ data.tar.gz: edcb7eae3c1e3bf4ba1309006b4ccbf525a36f7d0d6eb08faefb0efce7a3086256a1264d2def41c0b0dc793e8465ca44c4ede980b5e076a067892a4eb55d0de8
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mx-platform-ruby (0.13.1)
4
+ mx-platform-ruby (0.14.0)
5
5
  faraday (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -11,7 +11,7 @@ GEM
11
11
  byebug (11.1.3)
12
12
  coderay (1.1.3)
13
13
  diff-lcs (1.5.0)
14
- faraday (1.10.0)
14
+ faraday (1.10.3)
15
15
  faraday-em_http (~> 1.0)
16
16
  faraday-em_synchrony (~> 1.0)
17
17
  faraday-excon (~> 1.1)
@@ -27,8 +27,8 @@ GEM
27
27
  faraday-em_synchrony (1.0.0)
28
28
  faraday-excon (1.1.0)
29
29
  faraday-httpclient (1.0.1)
30
- faraday-multipart (1.0.3)
31
- multipart-post (>= 1.2, < 3)
30
+ faraday-multipart (1.0.4)
31
+ multipart-post (~> 2)
32
32
  faraday-net_http (1.0.1)
33
33
  faraday-net_http_persistent (1.2.0)
34
34
  faraday-patron (1.0.0)
@@ -36,9 +36,9 @@ GEM
36
36
  faraday-retry (1.0.3)
37
37
  jaro_winkler (1.5.4)
38
38
  method_source (1.0.0)
39
- multipart-post (2.1.1)
39
+ multipart-post (2.3.0)
40
40
  parallel (1.22.1)
41
- parser (3.1.2.0)
41
+ parser (3.2.1.1)
42
42
  ast (~> 2.4.1)
43
43
  pry (0.13.1)
44
44
  coderay (~> 1.1)
@@ -46,23 +46,23 @@ GEM
46
46
  pry-byebug (3.9.0)
47
47
  byebug (~> 11.0)
48
48
  pry (~> 0.13.0)
49
- psych (4.0.3)
49
+ psych (5.1.0)
50
50
  stringio
51
51
  rainbow (3.1.1)
52
52
  rake (13.0.6)
53
- rspec (3.11.0)
54
- rspec-core (~> 3.11.0)
55
- rspec-expectations (~> 3.11.0)
56
- rspec-mocks (~> 3.11.0)
57
- rspec-core (3.11.0)
58
- rspec-support (~> 3.11.0)
59
- rspec-expectations (3.11.0)
53
+ rspec (3.12.0)
54
+ rspec-core (~> 3.12.0)
55
+ rspec-expectations (~> 3.12.0)
56
+ rspec-mocks (~> 3.12.0)
57
+ rspec-core (3.12.1)
58
+ rspec-support (~> 3.12.0)
59
+ rspec-expectations (3.12.2)
60
60
  diff-lcs (>= 1.2.0, < 2.0)
61
- rspec-support (~> 3.11.0)
62
- rspec-mocks (3.11.1)
61
+ rspec-support (~> 3.12.0)
62
+ rspec-mocks (3.12.4)
63
63
  diff-lcs (>= 1.2.0, < 2.0)
64
- rspec-support (~> 3.11.0)
65
- rspec-support (3.11.0)
64
+ rspec-support (~> 3.12.0)
65
+ rspec-support (3.12.0)
66
66
  rubocop (0.66.0)
67
67
  jaro_winkler (~> 1.5.1)
68
68
  parallel (~> 1.10)
@@ -71,9 +71,9 @@ GEM
71
71
  rainbow (>= 2.2.2, < 4.0)
72
72
  ruby-progressbar (~> 1.7)
73
73
  unicode-display_width (>= 1.4.0, < 1.6)
74
- ruby-progressbar (1.11.0)
74
+ ruby-progressbar (1.13.0)
75
75
  ruby2_keywords (0.0.5)
76
- stringio (3.0.1)
76
+ stringio (3.0.5)
77
77
  unicode-display_width (1.5.0)
78
78
 
79
79
  PLATFORMS
@@ -87,4 +87,4 @@ DEPENDENCIES
87
87
  rubocop (~> 0.66.0)
88
88
 
89
89
  BUNDLED WITH
90
- 2.3.12
90
+ 2.4.8
@@ -9,6 +9,7 @@
9
9
  | **guid** | **String** | | [optional] |
10
10
  | **institution_number** | **String** | | [optional] |
11
11
  | **member_guid** | **String** | | [optional] |
12
+ | **passed_validation** | **Boolean** | | [optional] |
12
13
  | **routing_number** | **String** | | [optional] |
13
14
  | **transit_number** | **String** | | [optional] |
14
15
  | **user_guid** | **String** | | [optional] |
@@ -24,6 +25,7 @@ instance = MxPlatformRuby::AccountNumberResponse.new(
24
25
  guid: ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f,
25
26
  institution_number: 123,
26
27
  member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
28
+ passed_validation: true,
27
29
  routing_number: 68899990000000,
28
30
  transit_number: 12345,
29
31
  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
@@ -9,7 +9,9 @@
9
9
  | **city** | **String** | | [optional] |
10
10
  | **country** | **String** | | [optional] |
11
11
  | **email** | **String** | | [optional] |
12
+ | **first_name** | **String** | | [optional] |
12
13
  | **guid** | **String** | | [optional] |
14
+ | **last_name** | **String** | | [optional] |
13
15
  | **member_guid** | **String** | | [optional] |
14
16
  | **owner_name** | **String** | | [optional] |
15
17
  | **phone** | **String** | | [optional] |
@@ -28,7 +30,9 @@ instance = MxPlatformRuby::AccountOwnerResponse.new(
28
30
  city: Middlesex,
29
31
  country: US,
30
32
  email: donnie@darko.co,
33
+ first_name: Donnie,
31
34
  guid: ACO-63dc7714-6fc0-4aa2-a069-c06cdccd1af9,
35
+ last_name: Darko,
32
36
  member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
33
37
  owner_name: Donnie Darko,
34
38
  phone: 555-555-5555,
@@ -4,17 +4,20 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **client_redirect_url** | **String** | | [optional] |
7
8
  | **color_scheme** | **String** | | [optional] |
8
9
  | **current_institution_code** | **String** | | [optional] |
9
10
  | **current_member_guid** | **String** | | [optional] |
11
+ | **disable_background_agg** | **Boolean** | | [optional] |
10
12
  | **disable_institution_search** | **Boolean** | | [optional] |
13
+ | **include_identity** | **Boolean** | | [optional] |
11
14
  | **include_transactions** | **Boolean** | | [optional] |
12
15
  | **is_mobile_webview** | **Boolean** | | [optional] |
13
16
  | **mode** | **String** | | [optional] |
17
+ | **oauth_referral_source** | **String** | | [optional] |
14
18
  | **ui_message_version** | **Integer** | | [optional] |
15
19
  | **ui_message_webview_url_scheme** | **String** | | [optional] |
16
20
  | **update_credentials** | **Boolean** | | [optional] |
17
- | **wait_for_full_aggregation** | **Boolean** | | [optional] |
18
21
 
19
22
  ## Example
20
23
 
@@ -22,17 +25,20 @@
22
25
  require 'mx-platform-ruby'
23
26
 
24
27
  instance = MxPlatformRuby::ConnectWidgetRequest.new(
28
+ client_redirect_url: https://mx.com,
25
29
  color_scheme: light,
26
30
  current_institution_code: chase,
27
31
  current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
32
+ disable_background_agg: false,
28
33
  disable_institution_search: false,
34
+ include_identity: false,
29
35
  include_transactions: true,
30
- is_mobile_webview: true,
36
+ is_mobile_webview: false,
31
37
  mode: aggregation,
38
+ oauth_referral_source: BROWSER,
32
39
  ui_message_version: 4,
33
40
  ui_message_webview_url_scheme: mx,
34
- update_credentials: false,
35
- wait_for_full_aggregation: false
41
+ update_credentials: false
36
42
  )
37
43
  ```
38
44
 
@@ -13,6 +13,7 @@
13
13
  | **description** | **String** | | [optional] |
14
14
  | **guid** | **String** | | [optional] |
15
15
  | **holding_type** | **String** | | [optional] |
16
+ | **holding_type_id** | **Integer** | | [optional] |
16
17
  | **id** | **String** | | [optional] |
17
18
  | **market_value** | **Float** | | [optional] |
18
19
  | **member_guid** | **String** | | [optional] |
@@ -38,6 +39,7 @@ instance = MxPlatformRuby::HoldingResponse.new(
38
39
  description: Guggenheim Defensive Equity ETF,
39
40
  guid: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2,
40
41
  holding_type: MONEY_MARKET,
42
+ holding_type_id: 1,
41
43
  id: ID-123,
42
44
  market_value: 989.5,
43
45
  member_guid: MBR-d65683e8-9eab-26bb-bcfd-ced159c9abe,
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **client_redirect_url** | **String** | | [optional] |
7
8
  | **member** | [**MemberCreateRequest**](MemberCreateRequest.md) | | [optional] |
8
9
  | **referral_source** | **String** | | [optional] |
9
10
  | **ui_message_webview_url_scheme** | **String** | | [optional] |
@@ -14,6 +15,7 @@
14
15
  require 'mx-platform-ruby'
15
16
 
16
17
  instance = MxPlatformRuby::MemberCreateRequestBody.new(
18
+ client_redirect_url: https://mx.com,
17
19
  member: null,
18
20
  referral_source: APP,
19
21
  ui_message_webview_url_scheme: mx
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **aggregated_at** | **String** | | [optional] |
8
+ | **background_aggregation_is_disabled** | **Boolean** | | [optional] |
8
9
  | **connection_status** | **String** | | [optional] |
9
10
  | **guid** | **String** | | [optional] |
10
11
  | **id** | **String** | | [optional] |
@@ -26,6 +27,7 @@ require 'mx-platform-ruby'
26
27
 
27
28
  instance = MxPlatformRuby::MemberResponse.new(
28
29
  aggregated_at: 2016-10-13T18:07:57.000Z,
30
+ background_aggregation_is_disabled: false,
29
31
  connection_status: CONNECTED,
30
32
  guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
31
33
  id: unique_id,
@@ -35,7 +37,7 @@ instance = MxPlatformRuby::MemberResponse.new(
35
37
  is_oauth: false,
36
38
  metadata: \&quot;credentials_last_refreshed_at\&quot;: \&quot;2015-10-15\&quot;,
37
39
  name: Chase Bank,
38
- oauth_window_uri: int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/p8v7rxpxg3pdAsfgwxcrwxwhz3Zbygxfr6wAb931qv91hpb57k6bkr6t6m9djrfrfd467p8xkgqp6w7k1r9g8k8bfxqbfw2lq5tdwjq2sngAx76fm0jrw0dpmbtlkxchgjsw3r7r0hhq6A8sshqptfxql2rt123shfpkyhhpfvy67yvprbkb7lmlyrpwsd9yj0s22pmsyjhcw7d2q44d9fsxn5kfsmr2zqc79c2AxAx5gkjgbczf22A1sjx70t2pvnggzyh55s7bh62dd5wq7f1r4x90mcxn1tfhhrq5b09mjkt5hg66cjn700pcf6fgA42lbsp7v1pdch85mswycrp21c6j2sxffm14Asg3?skip_aggregation&#x3D;false&amp;referral_source&#x3D;APP&amp;ui_message_webview_url_scheme&#x3D;myapp,
40
+ oauth_window_uri: https://mxbank.mx.com/oauth/authorize?client_id&#x3D;b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&amp;redirect_uri&#x3D;https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&amp;response_type&#x3D;code&amp;scope&#x3D;openid&amp;state&#x3D;d745bd4ee6f0f9c184757f574bcc2df2,
39
41
  successfully_aggregated_at: 2016-10-13T17:57:38.000Z,
40
42
  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54,
41
43
  user_id: user123
@@ -45,6 +45,7 @@ All URIs are relative to *https://api.mx.com*
45
45
  | [**list_managed_institutions**](MxPlatformApi.md#list_managed_institutions) | **GET** /managed_institutions | List managed institutions |
46
46
  | [**list_managed_members**](MxPlatformApi.md#list_managed_members) | **GET** /users/{user_guid}/managed_members | List managed members |
47
47
  | [**list_managed_transactions**](MxPlatformApi.md#list_managed_transactions) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | List managed transactions |
48
+ | [**list_member_accounts**](MxPlatformApi.md#list_member_accounts) | **GET** /users/{user_guid}/members/{member_guid}/accounts | List accounts by member |
48
49
  | [**list_member_challenges**](MxPlatformApi.md#list_member_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member challenges |
49
50
  | [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
50
51
  | [**list_members**](MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members |
@@ -60,6 +61,7 @@ All URIs are relative to *https://api.mx.com*
60
61
  | [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts |
61
62
  | [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users |
62
63
  | [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account |
64
+ | [**read_account_by_member**](MxPlatformApi.md#read_account_by_member) | **GET** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Read account by member |
63
65
  | [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read a custom category |
64
66
  | [**read_default_category**](MxPlatformApi.md#read_default_category) | **GET** /categories/{category_guid} | Read a default category |
65
67
  | [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding |
@@ -3140,6 +3142,86 @@ end
3140
3142
  - **Accept**: application/vnd.mx.api.v1+json
3141
3143
 
3142
3144
 
3145
+ ## list_member_accounts
3146
+
3147
+ > <AccountsResponseBody> list_member_accounts(user_guid, member_guid, opts)
3148
+
3149
+ List accounts by member
3150
+
3151
+ This endpoint returns a list of all the accounts associated with the specified `member`.
3152
+
3153
+ ### Examples
3154
+
3155
+ ```ruby
3156
+ require 'time'
3157
+ require 'mx-platform-ruby'
3158
+ # setup authorization
3159
+ MxPlatformRuby.configure do |config|
3160
+ # Configure HTTP basic authorization: basicAuth
3161
+ config.username = 'YOUR USERNAME'
3162
+ config.password = 'YOUR PASSWORD'
3163
+ end
3164
+
3165
+ api_instance = MxPlatformRuby::MxPlatformApi.new
3166
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
3167
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
3168
+ opts = {
3169
+ member_is_managed_by_user: true, # Boolean | List only accounts whose member is managed by the user.
3170
+ page: 1, # Integer | Specify current page.
3171
+ records_per_page: 10 # Integer | Specify records per page.
3172
+ }
3173
+
3174
+ begin
3175
+ # List accounts by member
3176
+ result = api_instance.list_member_accounts(user_guid, member_guid, opts)
3177
+ p result
3178
+ rescue MxPlatformRuby::ApiError => e
3179
+ puts "Error when calling MxPlatformApi->list_member_accounts: #{e}"
3180
+ end
3181
+ ```
3182
+
3183
+ #### Using the list_member_accounts_with_http_info variant
3184
+
3185
+ This returns an Array which contains the response data, status code and headers.
3186
+
3187
+ > <Array(<AccountsResponseBody>, Integer, Hash)> list_member_accounts_with_http_info(user_guid, member_guid, opts)
3188
+
3189
+ ```ruby
3190
+ begin
3191
+ # List accounts by member
3192
+ data, status_code, headers = api_instance.list_member_accounts_with_http_info(user_guid, member_guid, opts)
3193
+ p status_code # => 2xx
3194
+ p headers # => { ... }
3195
+ p data # => <AccountsResponseBody>
3196
+ rescue MxPlatformRuby::ApiError => e
3197
+ puts "Error when calling MxPlatformApi->list_member_accounts_with_http_info: #{e}"
3198
+ end
3199
+ ```
3200
+
3201
+ ### Parameters
3202
+
3203
+ | Name | Type | Description | Notes |
3204
+ | ---- | ---- | ----------- | ----- |
3205
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
3206
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
3207
+ | **member_is_managed_by_user** | **Boolean** | List only accounts whose member is managed by the user. | [optional] |
3208
+ | **page** | **Integer** | Specify current page. | [optional] |
3209
+ | **records_per_page** | **Integer** | Specify records per page. | [optional] |
3210
+
3211
+ ### Return type
3212
+
3213
+ [**AccountsResponseBody**](AccountsResponseBody.md)
3214
+
3215
+ ### Authorization
3216
+
3217
+ [basicAuth](../README.md#basicAuth)
3218
+
3219
+ ### HTTP request headers
3220
+
3221
+ - **Content-Type**: Not defined
3222
+ - **Accept**: application/vnd.mx.api.v1+json
3223
+
3224
+
3143
3225
  ## list_member_challenges
3144
3226
 
3145
3227
  > <ChallengesResponseBody> list_member_challenges(member_guid, user_guid, opts)
@@ -4101,6 +4183,7 @@ end
4101
4183
  api_instance = MxPlatformRuby::MxPlatformApi.new
4102
4184
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4103
4185
  opts = {
4186
+ member_is_managed_by_user: true, # Boolean | List only accounts whose member is managed by the user.
4104
4187
  page: 1, # Integer | Specify current page.
4105
4188
  records_per_page: 10 # Integer | Specify records per page.
4106
4189
  }
@@ -4137,6 +4220,7 @@ end
4137
4220
  | Name | Type | Description | Notes |
4138
4221
  | ---- | ---- | ----------- | ----- |
4139
4222
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4223
+ | **member_is_managed_by_user** | **Boolean** | List only accounts whose member is managed by the user. | [optional] |
4140
4224
  | **page** | **Integer** | Specify current page. | [optional] |
4141
4225
  | **records_per_page** | **Integer** | Specify records per page. | [optional] |
4142
4226
 
@@ -4177,7 +4261,10 @@ end
4177
4261
  api_instance = MxPlatformRuby::MxPlatformApi.new
4178
4262
  opts = {
4179
4263
  page: 1, # Integer | Specify current page.
4180
- records_per_page: 10 # Integer | Specify records per page.
4264
+ records_per_page: 10, # Integer | Specify records per page.
4265
+ id: 'u-12324-abdc', # String | The user `id` to search for.
4266
+ email: 'example@example.com', # String | The user `email` to search for.
4267
+ is_disabled: true # Boolean | Search for users that are diabled.
4181
4268
  }
4182
4269
 
4183
4270
  begin
@@ -4213,6 +4300,9 @@ end
4213
4300
  | ---- | ---- | ----------- | ----- |
4214
4301
  | **page** | **Integer** | Specify current page. | [optional] |
4215
4302
  | **records_per_page** | **Integer** | Specify records per page. | [optional] |
4303
+ | **id** | **String** | The user &#x60;id&#x60; to search for. | [optional] |
4304
+ | **email** | **String** | The user &#x60;email&#x60; to search for. | [optional] |
4305
+ | **is_disabled** | **Boolean** | Search for users that are diabled. | [optional] |
4216
4306
 
4217
4307
  ### Return type
4218
4308
 
@@ -4300,6 +4390,80 @@ end
4300
4390
  - **Accept**: application/vnd.mx.api.v1+json
4301
4391
 
4302
4392
 
4393
+ ## read_account_by_member
4394
+
4395
+ > <AccountResponseBody> read_account_by_member(account_guid, member_guid, user_guid)
4396
+
4397
+ Read account by member
4398
+
4399
+ This endpoint allows you to read the attributes of an `account` resource.
4400
+
4401
+ ### Examples
4402
+
4403
+ ```ruby
4404
+ require 'time'
4405
+ require 'mx-platform-ruby'
4406
+ # setup authorization
4407
+ MxPlatformRuby.configure do |config|
4408
+ # Configure HTTP basic authorization: basicAuth
4409
+ config.username = 'YOUR USERNAME'
4410
+ config.password = 'YOUR PASSWORD'
4411
+ end
4412
+
4413
+ api_instance = MxPlatformRuby::MxPlatformApi.new
4414
+ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
4415
+ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
4416
+ user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4417
+
4418
+ begin
4419
+ # Read account by member
4420
+ result = api_instance.read_account_by_member(account_guid, member_guid, user_guid)
4421
+ p result
4422
+ rescue MxPlatformRuby::ApiError => e
4423
+ puts "Error when calling MxPlatformApi->read_account_by_member: #{e}"
4424
+ end
4425
+ ```
4426
+
4427
+ #### Using the read_account_by_member_with_http_info variant
4428
+
4429
+ This returns an Array which contains the response data, status code and headers.
4430
+
4431
+ > <Array(<AccountResponseBody>, Integer, Hash)> read_account_by_member_with_http_info(account_guid, member_guid, user_guid)
4432
+
4433
+ ```ruby
4434
+ begin
4435
+ # Read account by member
4436
+ data, status_code, headers = api_instance.read_account_by_member_with_http_info(account_guid, member_guid, user_guid)
4437
+ p status_code # => 2xx
4438
+ p headers # => { ... }
4439
+ p data # => <AccountResponseBody>
4440
+ rescue MxPlatformRuby::ApiError => e
4441
+ puts "Error when calling MxPlatformApi->read_account_by_member_with_http_info: #{e}"
4442
+ end
4443
+ ```
4444
+
4445
+ ### Parameters
4446
+
4447
+ | Name | Type | Description | Notes |
4448
+ | ---- | ---- | ----------- | ----- |
4449
+ | **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
4450
+ | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
4451
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4452
+
4453
+ ### Return type
4454
+
4455
+ [**AccountResponseBody**](AccountResponseBody.md)
4456
+
4457
+ ### Authorization
4458
+
4459
+ [basicAuth](../README.md#basicAuth)
4460
+
4461
+ ### HTTP request headers
4462
+
4463
+ - **Content-Type**: Not defined
4464
+ - **Accept**: application/vnd.mx.api.v1+json
4465
+
4466
+
4303
4467
  ## read_category
4304
4468
 
4305
4469
  > <CategoryResponseBody> read_category(category_guid, user_guid)
@@ -5618,9 +5782,10 @@ api_instance = MxPlatformRuby::MxPlatformApi.new
5618
5782
  member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
5619
5783
  user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
5620
5784
  opts = {
5785
+ client_redirect_url: 'https://mx.com', # String | A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`.
5621
5786
  referral_source: 'APP', # String | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
5622
5787
  skip_aggregation: false, # Boolean | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
5623
- ui_message_webview_url_scheme: 'mx' # String | A scheme for routing the user back to the application state they were previously in.
5788
+ ui_message_webview_url_scheme: 'mx' # String | A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`.
5624
5789
  }
5625
5790
 
5626
5791
  begin
@@ -5656,9 +5821,10 @@ end
5656
5821
  | ---- | ---- | ----------- | ----- |
5657
5822
  | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. | |
5658
5823
  | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
5824
+ | **client_redirect_url** | **String** | A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with &#x60;referral_source&#x3D;APP&#x60;. | [optional] |
5659
5825
  | **referral_source** | **String** | Must be either &#x60;BROWSER&#x60; or &#x60;APP&#x60; depending on the implementation. Defaults to &#x60;BROWSER&#x60;. | [optional] |
5660
5826
  | **skip_aggregation** | **Boolean** | Setting this parameter to &#x60;true&#x60; will prevent the member from automatically aggregating after being redirected from the authorization page. | [optional] |
5661
- | **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. | [optional] |
5827
+ | **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. Only available with &#x60;referral_source&#x3D;APP&#x60;. | [optional] |
5662
5828
 
5663
5829
  ### Return type
5664
5830
 
@@ -14,7 +14,7 @@ require 'mx-platform-ruby'
14
14
 
15
15
  instance = MxPlatformRuby::OAuthWindowResponse.new(
16
16
  guid: MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f,
17
- oauth_window_uri: int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/zgknnw5k7dmztn2njmwlgz574mZlnft6vdrv7kzn9ptj325th6c5p0w6c7j83Ap1bqg01mhsr1bqjgf2fry3ly9wff497c6fcczbyrfgj7s39cygw95Akl7vlpmcAy2kmvh1mlkytg7jA1z3vnw1w3zx2r1wt65s6f6r3ryqqrysl9qA1kr6cAj6vhr1zl325Azz6hx52j1ll3vwbvvbv5xzy7d6csplyw25brA7147vAfq29ArjjAj4qmc6r6h457hkcj2946m0kjp2xzpkz6hz55lsp3Avmdb8dsq4xzqmzzqk68s6bp5tj9jsskw4wvcb95vm4fwh9w8phgp67hfj2flrtwcy5bxbtk74?skip_aggregation&#x3D;false
17
+ oauth_window_uri: https://mxbank.mx.com/oauth/authorize?client_id&#x3D;b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&amp;redirect_uri&#x3D;https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&amp;response_type&#x3D;code&amp;scope&#x3D;openid&amp;state&#x3D;d745bd4ee6f0f9c184757f574bcc2df2
18
18
  )
19
19
  ```
20
20
 
@@ -18,7 +18,7 @@ instance = MxPlatformRuby::UserCreateRequest.new(
18
18
  email: email@provider.com,
19
19
  id: My-Unique-ID,
20
20
  is_disabled: false,
21
- metadata: {\&quot;first_name\&quot;: \&quot;Steven\&quot;, \&quot;last_name\&quot;: \&quot;Universe\&quot;}
21
+ metadata: {\&quot;type\&quot;: \&quot;individual\&quot;, \&quot;status\&quot;: \&quot;preferred\&quot;}
22
22
  )
23
23
  ```
24
24
 
@@ -4,18 +4,20 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **client_redirect_url** | **String** | | [optional] |
7
8
  | **color_scheme** | **String** | | [optional] |
8
9
  | **current_institution_code** | **String** | | [optional] |
9
10
  | **current_institution_guid** | **String** | | [optional] |
10
11
  | **current_member_guid** | **String** | | [optional] |
11
12
  | **disable_institution_search** | **Boolean** | | [optional] |
13
+ | **include_identity** | **Boolean** | | [optional] |
12
14
  | **include_transactions** | **Boolean** | | [optional] |
13
15
  | **is_mobile_webview** | **Boolean** | | [optional] |
14
16
  | **mode** | **String** | | [optional] |
17
+ | **oauth_referral_source** | **String** | | [optional] |
15
18
  | **ui_message_version** | **Integer** | | [optional] |
16
19
  | **ui_message_webview_url_scheme** | **String** | | [optional] |
17
20
  | **update_credentials** | **Boolean** | | [optional] |
18
- | **wait_for_full_aggregation** | **Boolean** | | [optional] |
19
21
  | **widget_type** | **String** | | |
20
22
 
21
23
  ## Example
@@ -24,18 +26,20 @@
24
26
  require 'mx-platform-ruby'
25
27
 
26
28
  instance = MxPlatformRuby::WidgetRequest.new(
29
+ client_redirect_url: https://mx.com,
27
30
  color_scheme: light,
28
31
  current_institution_code: chase,
29
32
  current_institution_guid: INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9,
30
33
  current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
31
34
  disable_institution_search: false,
35
+ include_identity: false,
32
36
  include_transactions: true,
33
- is_mobile_webview: true,
37
+ is_mobile_webview: false,
34
38
  mode: aggregation,
39
+ oauth_referral_source: BROWSER,
35
40
  ui_message_version: 4,
36
41
  ui_message_webview_url_scheme: mx,
37
42
  update_credentials: false,
38
- wait_for_full_aggregation: false,
39
43
  widget_type: connect_widget
40
44
  )
41
45
  ```