mx-platform-ruby 0.12.0 → 0.13.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +7 -7
- data/docs/ConnectWidgetRequest.md +3 -3
- data/docs/HoldingResponse.md +2 -0
- data/docs/InstitutionResponse.md +2 -0
- data/docs/MemberCreateRequest.md +2 -0
- data/docs/MxPlatformApi.md +4 -215
- data/docs/WidgetRequest.md +2 -2
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +5 -190
- data/lib/mx-platform-ruby/configuration.rb +0 -7
- data/lib/mx-platform-ruby/models/connect_widget_request.rb +13 -13
- data/lib/mx-platform-ruby/models/holding_response.rb +11 -1
- data/lib/mx-platform-ruby/models/institution_response.rb +11 -1
- data/lib/mx-platform-ruby/models/member_create_request.rb +10 -1
- data/lib/mx-platform-ruby/models/widget_request.rb +10 -10
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/lib/mx-platform-ruby.rb +0 -7
- data/openapi/config.yml +1 -1
- data/spec/api/mx_platform_api_spec.rb +2 -37
- data/spec/models/connect_widget_request_spec.rb +6 -6
- data/spec/models/holding_response_spec.rb +6 -0
- data/spec/models/institution_response_spec.rb +6 -0
- data/spec/models/member_create_request_spec.rb +6 -0
- data/spec/models/widget_request_spec.rb +6 -6
- metadata +92 -120
- data/docs/PartnerAccountResponse.md +0 -30
- data/docs/PartnerAccountResponseBody.md +0 -18
- data/docs/PartnerAuthorizationCodeRequest.md +0 -22
- data/docs/PartnerAuthorizationCodeRequestBody.md +0 -18
- data/docs/PartnerAuthorizationCodeResponse.md +0 -18
- data/docs/PartnerAuthorizationCodeResponseBody.md +0 -18
- data/docs/PartnerTokenResponseBody.md +0 -22
- data/lib/mx-platform-ruby/models/partner_account_response.rb +0 -279
- data/lib/mx-platform-ruby/models/partner_account_response_body.rb +0 -218
- data/lib/mx-platform-ruby/models/partner_authorization_code_request.rb +0 -236
- data/lib/mx-platform-ruby/models/partner_authorization_code_request_body.rb +0 -218
- data/lib/mx-platform-ruby/models/partner_authorization_code_response.rb +0 -219
- data/lib/mx-platform-ruby/models/partner_authorization_code_response_body.rb +0 -218
- data/lib/mx-platform-ruby/models/partner_token_response_body.rb +0 -239
- data/spec/models/partner_account_response_body_spec.rb +0 -34
- data/spec/models/partner_account_response_spec.rb +0 -70
- data/spec/models/partner_authorization_code_request_body_spec.rb +0 -34
- data/spec/models/partner_authorization_code_request_spec.rb +0 -46
- data/spec/models/partner_authorization_code_response_body_spec.rb +0 -34
- data/spec/models/partner_authorization_code_response_spec.rb +0 -34
- data/spec/models/partner_token_response_body_spec.rb +0 -46
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fcea25ea3b882a6dcfb42235580778fa60c461ffea20ecf19eb97d1908d419df
|
4
|
+
data.tar.gz: 52e4464a0d35a6b2b581bef7fb366d498fed17563733667e801c716960ee8e52
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 80c36a073d4226c2fb892a64d2c47bce10621b641b80d1ccc0ce9ce7fb0c8e89bdae585dcd2b2382671a1b88c89a667b48c68bee0b2a21010c6314c90700fb5f
|
7
|
+
data.tar.gz: 725446f13c05df26770c88ca4230bd2779d0bf39fa00e920b036ec3f593022cbb7e03e2c4d4b45de8f752dd649f42919c7d6e88a5486494beaa8cf54bf2ed81e
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
mx-platform-ruby (0.
|
4
|
+
mx-platform-ruby (0.13.2)
|
5
5
|
faraday (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -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.
|
31
|
-
multipart-post (
|
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,7 +36,7 @@ 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.
|
39
|
+
multipart-post (2.2.3)
|
40
40
|
parallel (1.22.1)
|
41
41
|
parser (3.1.2.0)
|
42
42
|
ast (~> 2.4.1)
|
@@ -46,7 +46,7 @@ GEM
|
|
46
46
|
pry-byebug (3.9.0)
|
47
47
|
byebug (~> 11.0)
|
48
48
|
pry (~> 0.13.0)
|
49
|
-
psych (4.0.
|
49
|
+
psych (4.0.4)
|
50
50
|
stringio
|
51
51
|
rainbow (3.1.1)
|
52
52
|
rake (13.0.6)
|
@@ -73,7 +73,7 @@ GEM
|
|
73
73
|
unicode-display_width (>= 1.4.0, < 1.6)
|
74
74
|
ruby-progressbar (1.11.0)
|
75
75
|
ruby2_keywords (0.0.5)
|
76
|
-
stringio (3.0.
|
76
|
+
stringio (3.0.2)
|
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.
|
90
|
+
2.3.16
|
@@ -4,6 +4,7 @@
|
|
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] |
|
@@ -14,7 +15,6 @@
|
|
14
15
|
| **ui_message_version** | **Integer** | | [optional] |
|
15
16
|
| **ui_message_webview_url_scheme** | **String** | | [optional] |
|
16
17
|
| **update_credentials** | **Boolean** | | [optional] |
|
17
|
-
| **wait_for_full_aggregation** | **Boolean** | | [optional] |
|
18
18
|
|
19
19
|
## Example
|
20
20
|
|
@@ -22,6 +22,7 @@
|
|
22
22
|
require 'mx-platform-ruby'
|
23
23
|
|
24
24
|
instance = MxPlatformRuby::ConnectWidgetRequest.new(
|
25
|
+
client_redirect_url: https://mx.com,
|
25
26
|
color_scheme: light,
|
26
27
|
current_institution_code: chase,
|
27
28
|
current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
|
@@ -31,8 +32,7 @@ instance = MxPlatformRuby::ConnectWidgetRequest.new(
|
|
31
32
|
mode: aggregation,
|
32
33
|
ui_message_version: 4,
|
33
34
|
ui_message_webview_url_scheme: mx,
|
34
|
-
update_credentials: false
|
35
|
-
wait_for_full_aggregation: false
|
35
|
+
update_credentials: false
|
36
36
|
)
|
37
37
|
```
|
38
38
|
|
data/docs/HoldingResponse.md
CHANGED
@@ -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,
|
data/docs/InstitutionResponse.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **code** | **String** | | [optional] |
|
8
|
+
| **instructional_text** | **String** | | [optional] |
|
8
9
|
| **medium_logo_url** | **String** | | [optional] |
|
9
10
|
| **name** | **String** | | [optional] |
|
10
11
|
| **small_logo_url** | **String** | | [optional] |
|
@@ -22,6 +23,7 @@ require 'mx-platform-ruby'
|
|
22
23
|
|
23
24
|
instance = MxPlatformRuby::InstitutionResponse.new(
|
24
25
|
code: chase,
|
26
|
+
instructional_text: Some instructional text <a href="https://example.url.chase.com/instructions" id="instructional_text">for end users</a>.,
|
25
27
|
medium_logo_url: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png,
|
26
28
|
name: Chase Bank,
|
27
29
|
small_logo_url: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png,
|
data/docs/MemberCreateRequest.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **background_aggregation_is_disabled** | **Boolean** | | [optional] |
|
8
|
+
| **client_redirect_url** | **String** | | [optional] |
|
8
9
|
| **credentials** | [**Array<CredentialRequest>**](CredentialRequest.md) | | |
|
9
10
|
| **id** | **String** | | [optional] |
|
10
11
|
| **institution_code** | **String** | | |
|
@@ -19,6 +20,7 @@ require 'mx-platform-ruby'
|
|
19
20
|
|
20
21
|
instance = MxPlatformRuby::MemberCreateRequest.new(
|
21
22
|
background_aggregation_is_disabled: false,
|
23
|
+
client_redirect_url: https://mx.com,
|
22
24
|
credentials: null,
|
23
25
|
id: unique_id,
|
24
26
|
institution_code: chase,
|
data/docs/MxPlatformApi.md
CHANGED
@@ -79,9 +79,6 @@ All URIs are relative to *https://api.mx.com*
|
|
79
79
|
| [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
|
80
80
|
| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url |
|
81
81
|
| [**request_o_auth_window_uri**](MxPlatformApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri |
|
82
|
-
| [**request_partner_account**](MxPlatformApi.md#request_partner_account) | **GET** /partner_account | Request partner account |
|
83
|
-
| [**request_partner_authorization_code**](MxPlatformApi.md#request_partner_authorization_code) | **POST** /partner_authorization_code | Request partner authorization code |
|
84
|
-
| [**request_partner_token**](MxPlatformApi.md#request_partner_token) | **POST** /partner_token | Request partner token |
|
85
82
|
| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url |
|
86
83
|
| [**resume_aggregation**](MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation |
|
87
84
|
| [**update_account_by_member**](MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member |
|
@@ -5621,9 +5618,10 @@ api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
5621
5618
|
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
5622
5619
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
5623
5620
|
opts = {
|
5621
|
+
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`.
|
5624
5622
|
referral_source: 'APP', # String | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
|
5625
5623
|
skip_aggregation: false, # Boolean | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
|
5626
|
-
ui_message_webview_url_scheme: 'mx' # String | A scheme for routing the user back to the application state they were previously in.
|
5624
|
+
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`.
|
5627
5625
|
}
|
5628
5626
|
|
5629
5627
|
begin
|
@@ -5659,9 +5657,10 @@ end
|
|
5659
5657
|
| ---- | ---- | ----------- | ----- |
|
5660
5658
|
| **member_guid** | **String** | The unique id for a `member`. | |
|
5661
5659
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
5660
|
+
| **client_redirect_url** | **String** | A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`. | [optional] |
|
5662
5661
|
| **referral_source** | **String** | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`. | [optional] |
|
5663
5662
|
| **skip_aggregation** | **Boolean** | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page. | [optional] |
|
5664
|
-
| **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. | [optional] |
|
5663
|
+
| **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`. | [optional] |
|
5665
5664
|
|
5666
5665
|
### Return type
|
5667
5666
|
|
@@ -5677,216 +5676,6 @@ end
|
|
5677
5676
|
- **Accept**: application/vnd.mx.api.v1+json
|
5678
5677
|
|
5679
5678
|
|
5680
|
-
## request_partner_account
|
5681
|
-
|
5682
|
-
> <PartnerAccountResponseBody> request_partner_account
|
5683
|
-
|
5684
|
-
Request partner account
|
5685
|
-
|
5686
|
-
Use this endpoint to request a partner account.
|
5687
|
-
|
5688
|
-
### Examples
|
5689
|
-
|
5690
|
-
```ruby
|
5691
|
-
require 'time'
|
5692
|
-
require 'mx-platform-ruby'
|
5693
|
-
# setup authorization
|
5694
|
-
MxPlatformRuby.configure do |config|
|
5695
|
-
# Configure Bearer authorization: bearerAuth
|
5696
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
5697
|
-
end
|
5698
|
-
|
5699
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5700
|
-
|
5701
|
-
begin
|
5702
|
-
# Request partner account
|
5703
|
-
result = api_instance.request_partner_account
|
5704
|
-
p result
|
5705
|
-
rescue MxPlatformRuby::ApiError => e
|
5706
|
-
puts "Error when calling MxPlatformApi->request_partner_account: #{e}"
|
5707
|
-
end
|
5708
|
-
```
|
5709
|
-
|
5710
|
-
#### Using the request_partner_account_with_http_info variant
|
5711
|
-
|
5712
|
-
This returns an Array which contains the response data, status code and headers.
|
5713
|
-
|
5714
|
-
> <Array(<PartnerAccountResponseBody>, Integer, Hash)> request_partner_account_with_http_info
|
5715
|
-
|
5716
|
-
```ruby
|
5717
|
-
begin
|
5718
|
-
# Request partner account
|
5719
|
-
data, status_code, headers = api_instance.request_partner_account_with_http_info
|
5720
|
-
p status_code # => 2xx
|
5721
|
-
p headers # => { ... }
|
5722
|
-
p data # => <PartnerAccountResponseBody>
|
5723
|
-
rescue MxPlatformRuby::ApiError => e
|
5724
|
-
puts "Error when calling MxPlatformApi->request_partner_account_with_http_info: #{e}"
|
5725
|
-
end
|
5726
|
-
```
|
5727
|
-
|
5728
|
-
### Parameters
|
5729
|
-
|
5730
|
-
This endpoint does not need any parameter.
|
5731
|
-
|
5732
|
-
### Return type
|
5733
|
-
|
5734
|
-
[**PartnerAccountResponseBody**](PartnerAccountResponseBody.md)
|
5735
|
-
|
5736
|
-
### Authorization
|
5737
|
-
|
5738
|
-
[bearerAuth](../README.md#bearerAuth)
|
5739
|
-
|
5740
|
-
### HTTP request headers
|
5741
|
-
|
5742
|
-
- **Content-Type**: Not defined
|
5743
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5744
|
-
|
5745
|
-
|
5746
|
-
## request_partner_authorization_code
|
5747
|
-
|
5748
|
-
> <PartnerAuthorizationCodeResponseBody> request_partner_authorization_code(partner_authorization_code_request_body)
|
5749
|
-
|
5750
|
-
Request partner authorization code
|
5751
|
-
|
5752
|
-
Use this endpoint to request a partner authorization code.
|
5753
|
-
|
5754
|
-
### Examples
|
5755
|
-
|
5756
|
-
```ruby
|
5757
|
-
require 'time'
|
5758
|
-
require 'mx-platform-ruby'
|
5759
|
-
# setup authorization
|
5760
|
-
MxPlatformRuby.configure do |config|
|
5761
|
-
# Configure HTTP basic authorization: basicAuth
|
5762
|
-
config.username = 'YOUR USERNAME'
|
5763
|
-
config.password = 'YOUR PASSWORD'
|
5764
|
-
end
|
5765
|
-
|
5766
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5767
|
-
partner_authorization_code_request_body = MxPlatformRuby::PartnerAuthorizationCodeRequestBody.new # PartnerAuthorizationCodeRequestBody | Partner authorization code object containing account_guid, member_guid, and user_guid.
|
5768
|
-
|
5769
|
-
begin
|
5770
|
-
# Request partner authorization code
|
5771
|
-
result = api_instance.request_partner_authorization_code(partner_authorization_code_request_body)
|
5772
|
-
p result
|
5773
|
-
rescue MxPlatformRuby::ApiError => e
|
5774
|
-
puts "Error when calling MxPlatformApi->request_partner_authorization_code: #{e}"
|
5775
|
-
end
|
5776
|
-
```
|
5777
|
-
|
5778
|
-
#### Using the request_partner_authorization_code_with_http_info variant
|
5779
|
-
|
5780
|
-
This returns an Array which contains the response data, status code and headers.
|
5781
|
-
|
5782
|
-
> <Array(<PartnerAuthorizationCodeResponseBody>, Integer, Hash)> request_partner_authorization_code_with_http_info(partner_authorization_code_request_body)
|
5783
|
-
|
5784
|
-
```ruby
|
5785
|
-
begin
|
5786
|
-
# Request partner authorization code
|
5787
|
-
data, status_code, headers = api_instance.request_partner_authorization_code_with_http_info(partner_authorization_code_request_body)
|
5788
|
-
p status_code # => 2xx
|
5789
|
-
p headers # => { ... }
|
5790
|
-
p data # => <PartnerAuthorizationCodeResponseBody>
|
5791
|
-
rescue MxPlatformRuby::ApiError => e
|
5792
|
-
puts "Error when calling MxPlatformApi->request_partner_authorization_code_with_http_info: #{e}"
|
5793
|
-
end
|
5794
|
-
```
|
5795
|
-
|
5796
|
-
### Parameters
|
5797
|
-
|
5798
|
-
| Name | Type | Description | Notes |
|
5799
|
-
| ---- | ---- | ----------- | ----- |
|
5800
|
-
| **partner_authorization_code_request_body** | [**PartnerAuthorizationCodeRequestBody**](PartnerAuthorizationCodeRequestBody.md) | Partner authorization code object containing account_guid, member_guid, and user_guid. | |
|
5801
|
-
|
5802
|
-
### Return type
|
5803
|
-
|
5804
|
-
[**PartnerAuthorizationCodeResponseBody**](PartnerAuthorizationCodeResponseBody.md)
|
5805
|
-
|
5806
|
-
### Authorization
|
5807
|
-
|
5808
|
-
[basicAuth](../README.md#basicAuth)
|
5809
|
-
|
5810
|
-
### HTTP request headers
|
5811
|
-
|
5812
|
-
- **Content-Type**: application/json
|
5813
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5814
|
-
|
5815
|
-
|
5816
|
-
## request_partner_token
|
5817
|
-
|
5818
|
-
> <PartnerTokenResponseBody> request_partner_token(opts)
|
5819
|
-
|
5820
|
-
Request partner token
|
5821
|
-
|
5822
|
-
Use this endpoint to request a partner token.
|
5823
|
-
|
5824
|
-
### Examples
|
5825
|
-
|
5826
|
-
```ruby
|
5827
|
-
require 'time'
|
5828
|
-
require 'mx-platform-ruby'
|
5829
|
-
# setup authorization
|
5830
|
-
MxPlatformRuby.configure do |config|
|
5831
|
-
# Configure HTTP basic authorization: basicAuth
|
5832
|
-
config.username = 'YOUR USERNAME'
|
5833
|
-
config.password = 'YOUR PASSWORD'
|
5834
|
-
end
|
5835
|
-
|
5836
|
-
api_instance = MxPlatformRuby::MxPlatformApi.new
|
5837
|
-
opts = {
|
5838
|
-
code: 'sN3Ffd1nJg_iwEMuxcEo2Z5taC0RvMilfvYKsnM2XGM', # String | Code to request partner token.
|
5839
|
-
grant_type: 'authorization_code' # String | Specify grant type.
|
5840
|
-
}
|
5841
|
-
|
5842
|
-
begin
|
5843
|
-
# Request partner token
|
5844
|
-
result = api_instance.request_partner_token(opts)
|
5845
|
-
p result
|
5846
|
-
rescue MxPlatformRuby::ApiError => e
|
5847
|
-
puts "Error when calling MxPlatformApi->request_partner_token: #{e}"
|
5848
|
-
end
|
5849
|
-
```
|
5850
|
-
|
5851
|
-
#### Using the request_partner_token_with_http_info variant
|
5852
|
-
|
5853
|
-
This returns an Array which contains the response data, status code and headers.
|
5854
|
-
|
5855
|
-
> <Array(<PartnerTokenResponseBody>, Integer, Hash)> request_partner_token_with_http_info(opts)
|
5856
|
-
|
5857
|
-
```ruby
|
5858
|
-
begin
|
5859
|
-
# Request partner token
|
5860
|
-
data, status_code, headers = api_instance.request_partner_token_with_http_info(opts)
|
5861
|
-
p status_code # => 2xx
|
5862
|
-
p headers # => { ... }
|
5863
|
-
p data # => <PartnerTokenResponseBody>
|
5864
|
-
rescue MxPlatformRuby::ApiError => e
|
5865
|
-
puts "Error when calling MxPlatformApi->request_partner_token_with_http_info: #{e}"
|
5866
|
-
end
|
5867
|
-
```
|
5868
|
-
|
5869
|
-
### Parameters
|
5870
|
-
|
5871
|
-
| Name | Type | Description | Notes |
|
5872
|
-
| ---- | ---- | ----------- | ----- |
|
5873
|
-
| **code** | **String** | Code to request partner token. | [optional] |
|
5874
|
-
| **grant_type** | **String** | Specify grant type. | [optional] |
|
5875
|
-
|
5876
|
-
### Return type
|
5877
|
-
|
5878
|
-
[**PartnerTokenResponseBody**](PartnerTokenResponseBody.md)
|
5879
|
-
|
5880
|
-
### Authorization
|
5881
|
-
|
5882
|
-
[basicAuth](../README.md#basicAuth)
|
5883
|
-
|
5884
|
-
### HTTP request headers
|
5885
|
-
|
5886
|
-
- **Content-Type**: Not defined
|
5887
|
-
- **Accept**: application/vnd.mx.api.v1+json
|
5888
|
-
|
5889
|
-
|
5890
5679
|
## request_widget_url
|
5891
5680
|
|
5892
5681
|
> <WidgetResponseBody> request_widget_url(user_guid, widget_request_body, opts)
|
data/docs/WidgetRequest.md
CHANGED
@@ -4,6 +4,7 @@
|
|
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] |
|
@@ -15,7 +16,6 @@
|
|
15
16
|
| **ui_message_version** | **Integer** | | [optional] |
|
16
17
|
| **ui_message_webview_url_scheme** | **String** | | [optional] |
|
17
18
|
| **update_credentials** | **Boolean** | | [optional] |
|
18
|
-
| **wait_for_full_aggregation** | **Boolean** | | [optional] |
|
19
19
|
| **widget_type** | **String** | | |
|
20
20
|
|
21
21
|
## Example
|
@@ -24,6 +24,7 @@
|
|
24
24
|
require 'mx-platform-ruby'
|
25
25
|
|
26
26
|
instance = MxPlatformRuby::WidgetRequest.new(
|
27
|
+
client_redirect_url: https://mx.com,
|
27
28
|
color_scheme: light,
|
28
29
|
current_institution_code: chase,
|
29
30
|
current_institution_guid: INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9,
|
@@ -35,7 +36,6 @@ instance = MxPlatformRuby::WidgetRequest.new(
|
|
35
36
|
ui_message_version: 4,
|
36
37
|
ui_message_webview_url_scheme: mx,
|
37
38
|
update_credentials: false,
|
38
|
-
wait_for_full_aggregation: false,
|
39
39
|
widget_type: connect_widget
|
40
40
|
)
|
41
41
|
```
|
@@ -5290,9 +5290,10 @@ module MxPlatformRuby
|
|
5290
5290
|
# @param member_guid [String] The unique id for a `member`.
|
5291
5291
|
# @param user_guid [String] The unique id for a `user`.
|
5292
5292
|
# @param [Hash] opts the optional parameters
|
5293
|
+
# @option opts [String] :client_redirect_url A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`.
|
5293
5294
|
# @option opts [String] :referral_source Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
|
5294
5295
|
# @option opts [Boolean] :skip_aggregation Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
|
5295
|
-
# @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in.
|
5296
|
+
# @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`.
|
5296
5297
|
# @return [OAuthWindowResponseBody]
|
5297
5298
|
def request_o_auth_window_uri(member_guid, user_guid, opts = {})
|
5298
5299
|
data, _status_code, _headers = request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts)
|
@@ -5304,9 +5305,10 @@ module MxPlatformRuby
|
|
5304
5305
|
# @param member_guid [String] The unique id for a `member`.
|
5305
5306
|
# @param user_guid [String] The unique id for a `user`.
|
5306
5307
|
# @param [Hash] opts the optional parameters
|
5308
|
+
# @option opts [String] :client_redirect_url A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`.
|
5307
5309
|
# @option opts [String] :referral_source Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
|
5308
5310
|
# @option opts [Boolean] :skip_aggregation Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
|
5309
|
-
# @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in.
|
5311
|
+
# @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`.
|
5310
5312
|
# @return [Array<(OAuthWindowResponseBody, Integer, Hash)>] OAuthWindowResponseBody data, response status code and response headers
|
5311
5313
|
def request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts = {})
|
5312
5314
|
if @api_client.config.debugging
|
@@ -5325,6 +5327,7 @@ module MxPlatformRuby
|
|
5325
5327
|
|
5326
5328
|
# query parameters
|
5327
5329
|
query_params = opts[:query_params] || {}
|
5330
|
+
query_params[:'client_redirect_url'] = opts[:'client_redirect_url'] if !opts[:'client_redirect_url'].nil?
|
5328
5331
|
query_params[:'referral_source'] = opts[:'referral_source'] if !opts[:'referral_source'].nil?
|
5329
5332
|
query_params[:'skip_aggregation'] = opts[:'skip_aggregation'] if !opts[:'skip_aggregation'].nil?
|
5330
5333
|
query_params[:'ui_message_webview_url_scheme'] = opts[:'ui_message_webview_url_scheme'] if !opts[:'ui_message_webview_url_scheme'].nil?
|
@@ -5363,194 +5366,6 @@ module MxPlatformRuby
|
|
5363
5366
|
return data, status_code, headers
|
5364
5367
|
end
|
5365
5368
|
|
5366
|
-
# Request partner account
|
5367
|
-
# Use this endpoint to request a partner account.
|
5368
|
-
# @param [Hash] opts the optional parameters
|
5369
|
-
# @return [PartnerAccountResponseBody]
|
5370
|
-
def request_partner_account(opts = {})
|
5371
|
-
data, _status_code, _headers = request_partner_account_with_http_info(opts)
|
5372
|
-
data
|
5373
|
-
end
|
5374
|
-
|
5375
|
-
# Request partner account
|
5376
|
-
# Use this endpoint to request a partner account.
|
5377
|
-
# @param [Hash] opts the optional parameters
|
5378
|
-
# @return [Array<(PartnerAccountResponseBody, Integer, Hash)>] PartnerAccountResponseBody data, response status code and response headers
|
5379
|
-
def request_partner_account_with_http_info(opts = {})
|
5380
|
-
if @api_client.config.debugging
|
5381
|
-
@api_client.config.logger.debug 'Calling API: MxPlatformApi.request_partner_account ...'
|
5382
|
-
end
|
5383
|
-
# resource path
|
5384
|
-
local_var_path = '/partner_account'
|
5385
|
-
|
5386
|
-
# query parameters
|
5387
|
-
query_params = opts[:query_params] || {}
|
5388
|
-
|
5389
|
-
# header parameters
|
5390
|
-
header_params = opts[:header_params] || {}
|
5391
|
-
# HTTP header 'Accept' (if needed)
|
5392
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
5393
|
-
|
5394
|
-
# form parameters
|
5395
|
-
form_params = opts[:form_params] || {}
|
5396
|
-
|
5397
|
-
# http body (model)
|
5398
|
-
post_body = opts[:debug_body]
|
5399
|
-
|
5400
|
-
# return_type
|
5401
|
-
return_type = opts[:debug_return_type] || 'PartnerAccountResponseBody'
|
5402
|
-
|
5403
|
-
# auth_names
|
5404
|
-
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
5405
|
-
|
5406
|
-
new_options = opts.merge(
|
5407
|
-
:operation => :"MxPlatformApi.request_partner_account",
|
5408
|
-
:header_params => header_params,
|
5409
|
-
:query_params => query_params,
|
5410
|
-
:form_params => form_params,
|
5411
|
-
:body => post_body,
|
5412
|
-
:auth_names => auth_names,
|
5413
|
-
:return_type => return_type
|
5414
|
-
)
|
5415
|
-
|
5416
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
5417
|
-
if @api_client.config.debugging
|
5418
|
-
@api_client.config.logger.debug "API called: MxPlatformApi#request_partner_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5419
|
-
end
|
5420
|
-
return data, status_code, headers
|
5421
|
-
end
|
5422
|
-
|
5423
|
-
# Request partner authorization code
|
5424
|
-
# Use this endpoint to request a partner authorization code.
|
5425
|
-
# @param partner_authorization_code_request_body [PartnerAuthorizationCodeRequestBody] Partner authorization code object containing account_guid, member_guid, and user_guid.
|
5426
|
-
# @param [Hash] opts the optional parameters
|
5427
|
-
# @return [PartnerAuthorizationCodeResponseBody]
|
5428
|
-
def request_partner_authorization_code(partner_authorization_code_request_body, opts = {})
|
5429
|
-
data, _status_code, _headers = request_partner_authorization_code_with_http_info(partner_authorization_code_request_body, opts)
|
5430
|
-
data
|
5431
|
-
end
|
5432
|
-
|
5433
|
-
# Request partner authorization code
|
5434
|
-
# Use this endpoint to request a partner authorization code.
|
5435
|
-
# @param partner_authorization_code_request_body [PartnerAuthorizationCodeRequestBody] Partner authorization code object containing account_guid, member_guid, and user_guid.
|
5436
|
-
# @param [Hash] opts the optional parameters
|
5437
|
-
# @return [Array<(PartnerAuthorizationCodeResponseBody, Integer, Hash)>] PartnerAuthorizationCodeResponseBody data, response status code and response headers
|
5438
|
-
def request_partner_authorization_code_with_http_info(partner_authorization_code_request_body, opts = {})
|
5439
|
-
if @api_client.config.debugging
|
5440
|
-
@api_client.config.logger.debug 'Calling API: MxPlatformApi.request_partner_authorization_code ...'
|
5441
|
-
end
|
5442
|
-
# verify the required parameter 'partner_authorization_code_request_body' is set
|
5443
|
-
if @api_client.config.client_side_validation && partner_authorization_code_request_body.nil?
|
5444
|
-
fail ArgumentError, "Missing the required parameter 'partner_authorization_code_request_body' when calling MxPlatformApi.request_partner_authorization_code"
|
5445
|
-
end
|
5446
|
-
# resource path
|
5447
|
-
local_var_path = '/partner_authorization_code'
|
5448
|
-
|
5449
|
-
# query parameters
|
5450
|
-
query_params = opts[:query_params] || {}
|
5451
|
-
|
5452
|
-
# header parameters
|
5453
|
-
header_params = opts[:header_params] || {}
|
5454
|
-
# HTTP header 'Accept' (if needed)
|
5455
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
5456
|
-
# HTTP header 'Content-Type'
|
5457
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
5458
|
-
if !content_type.nil?
|
5459
|
-
header_params['Content-Type'] = content_type
|
5460
|
-
end
|
5461
|
-
|
5462
|
-
# form parameters
|
5463
|
-
form_params = opts[:form_params] || {}
|
5464
|
-
|
5465
|
-
# http body (model)
|
5466
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_authorization_code_request_body)
|
5467
|
-
|
5468
|
-
# return_type
|
5469
|
-
return_type = opts[:debug_return_type] || 'PartnerAuthorizationCodeResponseBody'
|
5470
|
-
|
5471
|
-
# auth_names
|
5472
|
-
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
5473
|
-
|
5474
|
-
new_options = opts.merge(
|
5475
|
-
:operation => :"MxPlatformApi.request_partner_authorization_code",
|
5476
|
-
:header_params => header_params,
|
5477
|
-
:query_params => query_params,
|
5478
|
-
:form_params => form_params,
|
5479
|
-
:body => post_body,
|
5480
|
-
:auth_names => auth_names,
|
5481
|
-
:return_type => return_type
|
5482
|
-
)
|
5483
|
-
|
5484
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5485
|
-
if @api_client.config.debugging
|
5486
|
-
@api_client.config.logger.debug "API called: MxPlatformApi#request_partner_authorization_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5487
|
-
end
|
5488
|
-
return data, status_code, headers
|
5489
|
-
end
|
5490
|
-
|
5491
|
-
# Request partner token
|
5492
|
-
# Use this endpoint to request a partner token.
|
5493
|
-
# @param [Hash] opts the optional parameters
|
5494
|
-
# @option opts [String] :code Code to request partner token.
|
5495
|
-
# @option opts [String] :grant_type Specify grant type.
|
5496
|
-
# @return [PartnerTokenResponseBody]
|
5497
|
-
def request_partner_token(opts = {})
|
5498
|
-
data, _status_code, _headers = request_partner_token_with_http_info(opts)
|
5499
|
-
data
|
5500
|
-
end
|
5501
|
-
|
5502
|
-
# Request partner token
|
5503
|
-
# Use this endpoint to request a partner token.
|
5504
|
-
# @param [Hash] opts the optional parameters
|
5505
|
-
# @option opts [String] :code Code to request partner token.
|
5506
|
-
# @option opts [String] :grant_type Specify grant type.
|
5507
|
-
# @return [Array<(PartnerTokenResponseBody, Integer, Hash)>] PartnerTokenResponseBody data, response status code and response headers
|
5508
|
-
def request_partner_token_with_http_info(opts = {})
|
5509
|
-
if @api_client.config.debugging
|
5510
|
-
@api_client.config.logger.debug 'Calling API: MxPlatformApi.request_partner_token ...'
|
5511
|
-
end
|
5512
|
-
# resource path
|
5513
|
-
local_var_path = '/partner_token'
|
5514
|
-
|
5515
|
-
# query parameters
|
5516
|
-
query_params = opts[:query_params] || {}
|
5517
|
-
query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
|
5518
|
-
query_params[:'grant_type'] = opts[:'grant_type'] if !opts[:'grant_type'].nil?
|
5519
|
-
|
5520
|
-
# header parameters
|
5521
|
-
header_params = opts[:header_params] || {}
|
5522
|
-
# HTTP header 'Accept' (if needed)
|
5523
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
|
5524
|
-
|
5525
|
-
# form parameters
|
5526
|
-
form_params = opts[:form_params] || {}
|
5527
|
-
|
5528
|
-
# http body (model)
|
5529
|
-
post_body = opts[:debug_body]
|
5530
|
-
|
5531
|
-
# return_type
|
5532
|
-
return_type = opts[:debug_return_type] || 'PartnerTokenResponseBody'
|
5533
|
-
|
5534
|
-
# auth_names
|
5535
|
-
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
5536
|
-
|
5537
|
-
new_options = opts.merge(
|
5538
|
-
:operation => :"MxPlatformApi.request_partner_token",
|
5539
|
-
:header_params => header_params,
|
5540
|
-
:query_params => query_params,
|
5541
|
-
:form_params => form_params,
|
5542
|
-
:body => post_body,
|
5543
|
-
:auth_names => auth_names,
|
5544
|
-
:return_type => return_type
|
5545
|
-
)
|
5546
|
-
|
5547
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5548
|
-
if @api_client.config.debugging
|
5549
|
-
@api_client.config.logger.debug "API called: MxPlatformApi#request_partner_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5550
|
-
end
|
5551
|
-
return data, status_code, headers
|
5552
|
-
end
|
5553
|
-
|
5554
5369
|
# Request widget url
|
5555
5370
|
# This endpoint allows partners to get a URL by passing the `widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request.
|
5556
5371
|
# @param user_guid [String] The unique id for a `user`.
|