mx-platform-ruby 0.2.1 → 0.3.0
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 +1 -1
- data/README.md +40 -41
- data/docs/AccountNumberResponse.md +32 -0
- data/docs/AccountNumbersResponseBody.md +2 -2
- data/docs/AccountOwnerResponse.md +40 -0
- data/docs/AccountOwnersResponseBody.md +2 -2
- data/docs/AccountResponse.md +96 -0
- data/docs/AccountResponseBody.md +1 -1
- data/docs/AccountsResponseBody.md +2 -2
- data/docs/CategoriesResponseBody.md +2 -2
- data/docs/CategoryResponse.md +32 -0
- data/docs/CategoryResponseBody.md +1 -1
- data/docs/ChallengeResponse.md +30 -0
- data/docs/ChallengeResponseImageOptions.md +22 -0
- data/docs/ChallengeResponseOptions.md +20 -0
- data/docs/ChallengesResponseBody.md +2 -2
- data/docs/ConnectWidgetResponse.md +20 -0
- data/docs/ConnectWidgetResponseBody.md +1 -1
- data/docs/CredentialResponse.md +26 -0
- data/docs/CredentialsResponseBody.md +2 -2
- data/docs/EnhanceTransactionResponse.md +48 -0
- data/docs/EnhanceTransactionsResponseBody.md +1 -1
- data/docs/HoldingResponse.md +52 -0
- data/docs/HoldingResponseBody.md +1 -1
- data/docs/HoldingsResponseBody.md +2 -2
- data/docs/InstitutionResponse.md +36 -0
- data/docs/InstitutionResponseBody.md +1 -1
- data/docs/InstitutionsResponseBody.md +2 -2
- data/docs/MemberResponse.md +40 -0
- data/docs/MemberResponseBody.md +1 -1
- data/docs/MemberStatusResponse.md +34 -0
- data/docs/MemberStatusResponseBody.md +1 -1
- data/docs/MembersResponseBody.md +2 -2
- data/docs/MerchantResponse.md +28 -0
- data/docs/MerchantResponseBody.md +1 -1
- data/docs/MerchantsResponseBody.md +2 -2
- data/docs/MxPlatformApi.md +196 -196
- data/docs/OAuthWindowResponse.md +20 -0
- data/docs/OAuthWindowResponseBody.md +1 -1
- data/docs/PaginationResponse.md +24 -0
- data/docs/StatementResponse.md +32 -0
- data/docs/StatementResponseBody.md +1 -1
- data/docs/StatementsResponseBody.md +2 -2
- data/docs/TagResponse.md +22 -0
- data/docs/TagResponseBody.md +1 -1
- data/docs/TaggingResponse.md +26 -0
- data/docs/TaggingResponseBody.md +1 -1
- data/docs/TaggingsResponseBody.md +2 -2
- data/docs/TagsResponseBody.md +2 -2
- data/docs/TransactionResponse.md +88 -0
- data/docs/TransactionResponseBody.md +1 -1
- data/docs/TransactionRuleResponse.md +30 -0
- data/docs/TransactionRuleResponseBody.md +1 -1
- data/docs/TransactionRulesResponseBody.md +2 -2
- data/docs/TransactionsResponseBody.md +2 -2
- data/docs/UserResponse.md +26 -0
- data/docs/UserResponseBody.md +1 -1
- data/docs/UsersResponseBody.md +2 -2
- data/docs/WidgetResponse.md +22 -0
- data/docs/WidgetResponseBody.md +1 -1
- data/lib/mx-platform-ruby.rb +24 -25
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +185 -185
- data/lib/mx-platform-ruby/models/account_number_response.rb +281 -0
- data/lib/mx-platform-ruby/models/account_numbers_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_owner_response.rb +317 -0
- data/lib/mx-platform-ruby/models/account_owners_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/account_response.rb +569 -0
- data/lib/mx-platform-ruby/models/account_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/accounts_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/categories_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/category_response.rb +281 -0
- data/lib/mx-platform-ruby/models/category_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/challenge_response.rb +276 -0
- data/lib/mx-platform-ruby/models/challenge_response_image_options.rb +236 -0
- data/lib/mx-platform-ruby/models/challenge_response_options.rb +227 -0
- data/lib/mx-platform-ruby/models/challenges_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/connect_widget_response.rb +227 -0
- data/lib/mx-platform-ruby/models/connect_widget_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/credential_response.rb +254 -0
- data/lib/mx-platform-ruby/models/credentials_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/enhance_transaction_response.rb +353 -0
- data/lib/mx-platform-ruby/models/enhance_transactions_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/holding_response.rb +371 -0
- data/lib/mx-platform-ruby/models/holding_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/holdings_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/institution_response.rb +299 -0
- data/lib/mx-platform-ruby/models/institution_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/institutions_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/member_response.rb +317 -0
- data/lib/mx-platform-ruby/models/member_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/member_status_response.rb +292 -0
- data/lib/mx-platform-ruby/models/member_status_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/members_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/merchant_response.rb +263 -0
- data/lib/mx-platform-ruby/models/merchant_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/merchants_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/o_auth_window_response.rb +227 -0
- data/lib/mx-platform-ruby/models/o_auth_window_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/pagination_response.rb +245 -0
- data/lib/mx-platform-ruby/models/statement_response.rb +281 -0
- data/lib/mx-platform-ruby/models/statement_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/statements_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tag_response.rb +236 -0
- data/lib/mx-platform-ruby/models/tag_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/tagging_response.rb +254 -0
- data/lib/mx-platform-ruby/models/tagging_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/taggings_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/tags_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transaction_response.rb +533 -0
- data/lib/mx-platform-ruby/models/transaction_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rule_response.rb +272 -0
- data/lib/mx-platform-ruby/models/transaction_rule_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/transaction_rules_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/transactions_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/user_response.rb +254 -0
- data/lib/mx-platform-ruby/models/user_response_body.rb +1 -1
- data/lib/mx-platform-ruby/models/users_response_body.rb +2 -2
- data/lib/mx-platform-ruby/models/widget_response.rb +236 -0
- data/lib/mx-platform-ruby/models/widget_response_body.rb +1 -1
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/openapi/config.yml +11 -0
- data/pkg/mx-platform-ruby-0.2.1.gem +0 -0
- data/spec/api/mx_platform_api_spec.rb +51 -51
- data/spec/models/account_number_response_spec.rb +76 -0
- data/spec/models/account_owner_response_spec.rb +100 -0
- data/spec/models/account_response_spec.rb +268 -0
- data/spec/models/category_response_spec.rb +76 -0
- data/spec/models/challenge_response_image_options_spec.rb +46 -0
- data/spec/models/challenge_response_options_spec.rb +40 -0
- data/spec/models/challenge_response_spec.rb +70 -0
- data/spec/models/connect_widget_response_spec.rb +40 -0
- data/spec/models/credential_response_spec.rb +58 -0
- data/spec/models/enhance_transaction_response_spec.rb +124 -0
- data/spec/models/holding_response_spec.rb +136 -0
- data/spec/models/institution_response_spec.rb +88 -0
- data/spec/models/member_response_spec.rb +100 -0
- data/spec/models/member_status_response_spec.rb +82 -0
- data/spec/models/merchant_response_spec.rb +64 -0
- data/spec/models/o_auth_window_response_spec.rb +40 -0
- data/spec/models/pagination_response_spec.rb +52 -0
- data/spec/models/statement_response_spec.rb +76 -0
- data/spec/models/tag_response_spec.rb +46 -0
- data/spec/models/tagging_response_spec.rb +58 -0
- data/spec/models/transaction_response_spec.rb +244 -0
- data/spec/models/transaction_rule_response_spec.rb +70 -0
- data/spec/models/user_response_spec.rb +58 -0
- data/spec/models/widget_response_spec.rb +46 -0
- metadata +100 -2
data/docs/MemberResponseBody.md
CHANGED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# MxPlatformRuby::MemberStatusResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **aggregated_at** | **String** | | [optional] |
|
|
8
|
+
| **challenges** | [**Array<ChallengeResponse>**](ChallengeResponse.md) | | [optional] |
|
|
9
|
+
| **connection_status** | **String** | | [optional] |
|
|
10
|
+
| **guid** | **String** | | [optional] |
|
|
11
|
+
| **has_processed_accounts** | **Boolean** | | [optional] |
|
|
12
|
+
| **has_processed_transactions** | **Boolean** | | [optional] |
|
|
13
|
+
| **is_authenticated** | **Boolean** | | [optional] |
|
|
14
|
+
| **is_being_aggregated** | **Boolean** | | [optional] |
|
|
15
|
+
| **successfully_aggregated_at** | **String** | | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'mx-platform-ruby'
|
|
21
|
+
|
|
22
|
+
instance = MxPlatformRuby::MemberStatusResponse.new(
|
|
23
|
+
aggregated_at: 2016-10-13T18:07:57.000Z,
|
|
24
|
+
challenges: null,
|
|
25
|
+
connection_status: CONNECTED,
|
|
26
|
+
guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
|
|
27
|
+
has_processed_accounts: true,
|
|
28
|
+
has_processed_transactions: false,
|
|
29
|
+
is_authenticated: false,
|
|
30
|
+
is_being_aggregated: false,
|
|
31
|
+
successfully_aggregated_at: 2016-10-13T17:57:38.000Z
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
data/docs/MembersResponseBody.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **members** | [**Array<
|
|
8
|
-
| **pagination** | [**
|
|
7
|
+
| **members** | [**Array<MemberResponse>**](MemberResponse.md) | | [optional] |
|
|
8
|
+
| **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MxPlatformRuby::MerchantResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **created_at** | **String** | | [optional] |
|
|
8
|
+
| **guid** | **String** | | [optional] |
|
|
9
|
+
| **logo_url** | **String** | | [optional] |
|
|
10
|
+
| **name** | **String** | | [optional] |
|
|
11
|
+
| **updated_at** | **String** | | [optional] |
|
|
12
|
+
| **website_url** | **String** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'mx-platform-ruby'
|
|
18
|
+
|
|
19
|
+
instance = MxPlatformRuby::MerchantResponse.new(
|
|
20
|
+
created_at: 2017-04-20T19:30:12.000Z,
|
|
21
|
+
guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b,
|
|
22
|
+
logo_url: https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png,
|
|
23
|
+
name: Comcast,
|
|
24
|
+
updated_at: 2018-09-28T21:13:53.000Z,
|
|
25
|
+
website_url: https://www.xfinity.com
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **merchants** | [**Array<
|
|
8
|
-
| **pagination** | [**
|
|
7
|
+
| **merchants** | [**Array<MerchantResponse>**](MerchantResponse.md) | | [optional] |
|
|
8
|
+
| **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
data/docs/MxPlatformApi.md
CHANGED
|
@@ -18,20 +18,20 @@ All URIs are relative to *https://api.mx.com*
|
|
|
18
18
|
| [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
|
|
19
19
|
| [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule |
|
|
20
20
|
| [**delete_user**](MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user |
|
|
21
|
-
| [**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement
|
|
21
|
+
| [**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf |
|
|
22
22
|
| [**enhance_transactions**](MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions |
|
|
23
23
|
| [**extend_history**](MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history |
|
|
24
|
-
| [**
|
|
24
|
+
| [**fetch_statements**](MxPlatformApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements |
|
|
25
25
|
| [**identify_member**](MxPlatformApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify member |
|
|
26
26
|
| [**list_account_numbers_by_account**](MxPlatformApi.md#list_account_numbers_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/account_numbers | List account numbers by account |
|
|
27
27
|
| [**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member |
|
|
28
|
-
| [**
|
|
28
|
+
| [**list_account_owners_by_member**](MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member |
|
|
29
29
|
| [**list_categories**](MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories |
|
|
30
30
|
| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories |
|
|
31
|
-
| [**
|
|
31
|
+
| [**list_favorite_institutions**](MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions |
|
|
32
|
+
| [**list_holdings**](MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings |
|
|
32
33
|
| [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member |
|
|
33
|
-
| [**
|
|
34
|
-
| [**list_institution_required_credentials**](MxPlatformApi.md#list_institution_required_credentials) | **GET** /institutions/{institution_code}/credentials | List institution-required credentials |
|
|
34
|
+
| [**list_institution_credentials**](MxPlatformApi.md#list_institution_credentials) | **GET** /institutions/{institution_code}/credentials | List institution credentials |
|
|
35
35
|
| [**list_institutions**](MxPlatformApi.md#list_institutions) | **GET** /institutions | List institutions |
|
|
36
36
|
| [**list_member_challenges**](MxPlatformApi.md#list_member_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member challenges |
|
|
37
37
|
| [**list_member_credentials**](MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials |
|
|
@@ -40,11 +40,11 @@ All URIs are relative to *https://api.mx.com*
|
|
|
40
40
|
| [**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member |
|
|
41
41
|
| [**list_taggings**](MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings |
|
|
42
42
|
| [**list_tags**](MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags |
|
|
43
|
-
| [**
|
|
43
|
+
| [**list_transaction_rules**](MxPlatformApi.md#list_transaction_rules) | **GET** /users/{user_guid}/transaction_rules | List transaction rules |
|
|
44
|
+
| [**list_transactions**](MxPlatformApi.md#list_transactions) | **GET** /users/{user_guid}/transactions | List transactions |
|
|
44
45
|
| [**list_transactions_by_account**](MxPlatformApi.md#list_transactions_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account |
|
|
45
46
|
| [**list_transactions_by_member**](MxPlatformApi.md#list_transactions_by_member) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List transactions by member |
|
|
46
47
|
| [**list_transactions_by_tag**](MxPlatformApi.md#list_transactions_by_tag) | **GET** /users/{user_guid}/tags/{tag_guid}/transactions | List transactions by tag |
|
|
47
|
-
| [**list_transactions_by_user**](MxPlatformApi.md#list_transactions_by_user) | **GET** /users/{user_guid}/transactions | List transactions by user |
|
|
48
48
|
| [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts |
|
|
49
49
|
| [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users |
|
|
50
50
|
| [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account |
|
|
@@ -60,11 +60,11 @@ All URIs are relative to *https://api.mx.com*
|
|
|
60
60
|
| [**read_transaction**](MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction |
|
|
61
61
|
| [**read_transaction_rule**](MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule |
|
|
62
62
|
| [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
|
|
63
|
-
| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget
|
|
64
|
-
| [**
|
|
65
|
-
| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request
|
|
63
|
+
| [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url |
|
|
64
|
+
| [**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 |
|
|
65
|
+
| [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url |
|
|
66
66
|
| [**resume_aggregation**](MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation |
|
|
67
|
-
| [**
|
|
67
|
+
| [**update_account_by_member**](MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member |
|
|
68
68
|
| [**update_category**](MxPlatformApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category |
|
|
69
69
|
| [**update_member**](MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member |
|
|
70
70
|
| [**update_tag**](MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag |
|
|
@@ -365,7 +365,7 @@ end
|
|
|
365
365
|
|
|
366
366
|
## create_tag
|
|
367
367
|
|
|
368
|
-
> <
|
|
368
|
+
> <TagResponseBody> create_tag(user_guid, tag_create_request_body)
|
|
369
369
|
|
|
370
370
|
Create tag
|
|
371
371
|
|
|
@@ -400,7 +400,7 @@ end
|
|
|
400
400
|
|
|
401
401
|
This returns an Array which contains the response data, status code and headers.
|
|
402
402
|
|
|
403
|
-
> <Array(<
|
|
403
|
+
> <Array(<TagResponseBody>, Integer, Hash)> create_tag_with_http_info(user_guid, tag_create_request_body)
|
|
404
404
|
|
|
405
405
|
```ruby
|
|
406
406
|
begin
|
|
@@ -408,7 +408,7 @@ begin
|
|
|
408
408
|
data, status_code, headers = api_instance.create_tag_with_http_info(user_guid, tag_create_request_body)
|
|
409
409
|
p status_code # => 2xx
|
|
410
410
|
p headers # => { ... }
|
|
411
|
-
p data # => <
|
|
411
|
+
p data # => <TagResponseBody>
|
|
412
412
|
rescue MxPlatformRuby::ApiError => e
|
|
413
413
|
puts "Error when calling MxPlatformApi->create_tag_with_http_info: #{e}"
|
|
414
414
|
end
|
|
@@ -423,7 +423,7 @@ end
|
|
|
423
423
|
|
|
424
424
|
### Return type
|
|
425
425
|
|
|
426
|
-
[**
|
|
426
|
+
[**TagResponseBody**](TagResponseBody.md)
|
|
427
427
|
|
|
428
428
|
### Authorization
|
|
429
429
|
|
|
@@ -1077,7 +1077,7 @@ nil (empty response body)
|
|
|
1077
1077
|
|
|
1078
1078
|
> File download_statement_pdf(member_guid, statement_guid, user_guid)
|
|
1079
1079
|
|
|
1080
|
-
Download statement
|
|
1080
|
+
Download statement pdf
|
|
1081
1081
|
|
|
1082
1082
|
Use this endpoint to download a specified statement PDF.
|
|
1083
1083
|
|
|
@@ -1099,7 +1099,7 @@ statement_guid = 'STA-737a344b-caae-0f6e-1384-01f52e75dcb1' # String | The uniqu
|
|
|
1099
1099
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
|
1100
1100
|
|
|
1101
1101
|
begin
|
|
1102
|
-
# Download statement
|
|
1102
|
+
# Download statement pdf
|
|
1103
1103
|
result = api_instance.download_statement_pdf(member_guid, statement_guid, user_guid)
|
|
1104
1104
|
p result
|
|
1105
1105
|
rescue MxPlatformRuby::ApiError => e
|
|
@@ -1115,7 +1115,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1115
1115
|
|
|
1116
1116
|
```ruby
|
|
1117
1117
|
begin
|
|
1118
|
-
# Download statement
|
|
1118
|
+
# Download statement pdf
|
|
1119
1119
|
data, status_code, headers = api_instance.download_statement_pdf_with_http_info(member_guid, statement_guid, user_guid)
|
|
1120
1120
|
p status_code # => 2xx
|
|
1121
1121
|
p headers # => { ... }
|
|
@@ -1289,11 +1289,11 @@ end
|
|
|
1289
1289
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
1290
1290
|
|
|
1291
1291
|
|
|
1292
|
-
##
|
|
1292
|
+
## fetch_statements
|
|
1293
1293
|
|
|
1294
|
-
> <MemberResponseBody>
|
|
1294
|
+
> <MemberResponseBody> fetch_statements(member_guid, user_guid)
|
|
1295
1295
|
|
|
1296
|
-
Fetch statements
|
|
1296
|
+
Fetch statements
|
|
1297
1297
|
|
|
1298
1298
|
Use this endpoint to fetch the statements associated with a particular member.
|
|
1299
1299
|
|
|
@@ -1314,29 +1314,29 @@ member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique i
|
|
|
1314
1314
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
|
1315
1315
|
|
|
1316
1316
|
begin
|
|
1317
|
-
# Fetch statements
|
|
1318
|
-
result = api_instance.
|
|
1317
|
+
# Fetch statements
|
|
1318
|
+
result = api_instance.fetch_statements(member_guid, user_guid)
|
|
1319
1319
|
p result
|
|
1320
1320
|
rescue MxPlatformRuby::ApiError => e
|
|
1321
|
-
puts "Error when calling MxPlatformApi->
|
|
1321
|
+
puts "Error when calling MxPlatformApi->fetch_statements: #{e}"
|
|
1322
1322
|
end
|
|
1323
1323
|
```
|
|
1324
1324
|
|
|
1325
|
-
#### Using the
|
|
1325
|
+
#### Using the fetch_statements_with_http_info variant
|
|
1326
1326
|
|
|
1327
1327
|
This returns an Array which contains the response data, status code and headers.
|
|
1328
1328
|
|
|
1329
|
-
> <Array(<MemberResponseBody>, Integer, Hash)>
|
|
1329
|
+
> <Array(<MemberResponseBody>, Integer, Hash)> fetch_statements_with_http_info(member_guid, user_guid)
|
|
1330
1330
|
|
|
1331
1331
|
```ruby
|
|
1332
1332
|
begin
|
|
1333
|
-
# Fetch statements
|
|
1334
|
-
data, status_code, headers = api_instance.
|
|
1333
|
+
# Fetch statements
|
|
1334
|
+
data, status_code, headers = api_instance.fetch_statements_with_http_info(member_guid, user_guid)
|
|
1335
1335
|
p status_code # => 2xx
|
|
1336
1336
|
p headers # => { ... }
|
|
1337
1337
|
p data # => <MemberResponseBody>
|
|
1338
1338
|
rescue MxPlatformRuby::ApiError => e
|
|
1339
|
-
puts "Error when calling MxPlatformApi->
|
|
1339
|
+
puts "Error when calling MxPlatformApi->fetch_statements_with_http_info: #{e}"
|
|
1340
1340
|
end
|
|
1341
1341
|
```
|
|
1342
1342
|
|
|
@@ -1589,11 +1589,11 @@ end
|
|
|
1589
1589
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
1590
1590
|
|
|
1591
1591
|
|
|
1592
|
-
##
|
|
1592
|
+
## list_account_owners_by_member
|
|
1593
1593
|
|
|
1594
|
-
> <AccountOwnersResponseBody>
|
|
1594
|
+
> <AccountOwnersResponseBody> list_account_owners_by_member(member_guid, user_guid, opts)
|
|
1595
1595
|
|
|
1596
|
-
List account owners
|
|
1596
|
+
List account owners by member
|
|
1597
1597
|
|
|
1598
1598
|
This endpoint returns an array with information about every account associated with a particular member.
|
|
1599
1599
|
|
|
@@ -1618,29 +1618,29 @@ opts = {
|
|
|
1618
1618
|
}
|
|
1619
1619
|
|
|
1620
1620
|
begin
|
|
1621
|
-
# List account owners
|
|
1622
|
-
result = api_instance.
|
|
1621
|
+
# List account owners by member
|
|
1622
|
+
result = api_instance.list_account_owners_by_member(member_guid, user_guid, opts)
|
|
1623
1623
|
p result
|
|
1624
1624
|
rescue MxPlatformRuby::ApiError => e
|
|
1625
|
-
puts "Error when calling MxPlatformApi->
|
|
1625
|
+
puts "Error when calling MxPlatformApi->list_account_owners_by_member: #{e}"
|
|
1626
1626
|
end
|
|
1627
1627
|
```
|
|
1628
1628
|
|
|
1629
|
-
#### Using the
|
|
1629
|
+
#### Using the list_account_owners_by_member_with_http_info variant
|
|
1630
1630
|
|
|
1631
1631
|
This returns an Array which contains the response data, status code and headers.
|
|
1632
1632
|
|
|
1633
|
-
> <Array(<AccountOwnersResponseBody>, Integer, Hash)>
|
|
1633
|
+
> <Array(<AccountOwnersResponseBody>, Integer, Hash)> list_account_owners_by_member_with_http_info(member_guid, user_guid, opts)
|
|
1634
1634
|
|
|
1635
1635
|
```ruby
|
|
1636
1636
|
begin
|
|
1637
|
-
# List account owners
|
|
1638
|
-
data, status_code, headers = api_instance.
|
|
1637
|
+
# List account owners by member
|
|
1638
|
+
data, status_code, headers = api_instance.list_account_owners_by_member_with_http_info(member_guid, user_guid, opts)
|
|
1639
1639
|
p status_code # => 2xx
|
|
1640
1640
|
p headers # => { ... }
|
|
1641
1641
|
p data # => <AccountOwnersResponseBody>
|
|
1642
1642
|
rescue MxPlatformRuby::ApiError => e
|
|
1643
|
-
puts "Error when calling MxPlatformApi->
|
|
1643
|
+
puts "Error when calling MxPlatformApi->list_account_owners_by_member_with_http_info: #{e}"
|
|
1644
1644
|
end
|
|
1645
1645
|
```
|
|
1646
1646
|
|
|
@@ -1813,11 +1813,11 @@ end
|
|
|
1813
1813
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
1814
1814
|
|
|
1815
1815
|
|
|
1816
|
-
##
|
|
1816
|
+
## list_favorite_institutions
|
|
1817
1817
|
|
|
1818
|
-
> <InstitutionsResponseBody>
|
|
1818
|
+
> <InstitutionsResponseBody> list_favorite_institutions(opts)
|
|
1819
1819
|
|
|
1820
|
-
List
|
|
1820
|
+
List favorite institutions
|
|
1821
1821
|
|
|
1822
1822
|
This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
|
|
1823
1823
|
|
|
@@ -1840,29 +1840,29 @@ opts = {
|
|
|
1840
1840
|
}
|
|
1841
1841
|
|
|
1842
1842
|
begin
|
|
1843
|
-
# List
|
|
1844
|
-
result = api_instance.
|
|
1843
|
+
# List favorite institutions
|
|
1844
|
+
result = api_instance.list_favorite_institutions(opts)
|
|
1845
1845
|
p result
|
|
1846
1846
|
rescue MxPlatformRuby::ApiError => e
|
|
1847
|
-
puts "Error when calling MxPlatformApi->
|
|
1847
|
+
puts "Error when calling MxPlatformApi->list_favorite_institutions: #{e}"
|
|
1848
1848
|
end
|
|
1849
1849
|
```
|
|
1850
1850
|
|
|
1851
|
-
#### Using the
|
|
1851
|
+
#### Using the list_favorite_institutions_with_http_info variant
|
|
1852
1852
|
|
|
1853
1853
|
This returns an Array which contains the response data, status code and headers.
|
|
1854
1854
|
|
|
1855
|
-
> <Array(<InstitutionsResponseBody>, Integer, Hash)>
|
|
1855
|
+
> <Array(<InstitutionsResponseBody>, Integer, Hash)> list_favorite_institutions_with_http_info(opts)
|
|
1856
1856
|
|
|
1857
1857
|
```ruby
|
|
1858
1858
|
begin
|
|
1859
|
-
# List
|
|
1860
|
-
data, status_code, headers = api_instance.
|
|
1859
|
+
# List favorite institutions
|
|
1860
|
+
data, status_code, headers = api_instance.list_favorite_institutions_with_http_info(opts)
|
|
1861
1861
|
p status_code # => 2xx
|
|
1862
1862
|
p headers # => { ... }
|
|
1863
1863
|
p data # => <InstitutionsResponseBody>
|
|
1864
1864
|
rescue MxPlatformRuby::ApiError => e
|
|
1865
|
-
puts "Error when calling MxPlatformApi->
|
|
1865
|
+
puts "Error when calling MxPlatformApi->list_favorite_institutions_with_http_info: #{e}"
|
|
1866
1866
|
end
|
|
1867
1867
|
```
|
|
1868
1868
|
|
|
@@ -1887,13 +1887,13 @@ end
|
|
|
1887
1887
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
1888
1888
|
|
|
1889
1889
|
|
|
1890
|
-
##
|
|
1890
|
+
## list_holdings
|
|
1891
1891
|
|
|
1892
|
-
> <HoldingsResponseBody>
|
|
1892
|
+
> <HoldingsResponseBody> list_holdings(user_guid, opts)
|
|
1893
1893
|
|
|
1894
|
-
List holdings
|
|
1894
|
+
List holdings
|
|
1895
1895
|
|
|
1896
|
-
This endpoint returns all holdings associated with the specified `
|
|
1896
|
+
This endpoint returns all holdings associated with the specified `user` across all accounts and members.
|
|
1897
1897
|
|
|
1898
1898
|
### Examples
|
|
1899
1899
|
|
|
@@ -1908,7 +1908,6 @@ MxPlatformRuby.configure do |config|
|
|
|
1908
1908
|
end
|
|
1909
1909
|
|
|
1910
1910
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
1911
|
-
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
1912
1911
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
|
1913
1912
|
opts = {
|
|
1914
1913
|
from_date: '2015-09-20', # String | Filter holdings from this date.
|
|
@@ -1918,29 +1917,29 @@ opts = {
|
|
|
1918
1917
|
}
|
|
1919
1918
|
|
|
1920
1919
|
begin
|
|
1921
|
-
# List holdings
|
|
1922
|
-
result = api_instance.
|
|
1920
|
+
# List holdings
|
|
1921
|
+
result = api_instance.list_holdings(user_guid, opts)
|
|
1923
1922
|
p result
|
|
1924
1923
|
rescue MxPlatformRuby::ApiError => e
|
|
1925
|
-
puts "Error when calling MxPlatformApi->
|
|
1924
|
+
puts "Error when calling MxPlatformApi->list_holdings: #{e}"
|
|
1926
1925
|
end
|
|
1927
1926
|
```
|
|
1928
1927
|
|
|
1929
|
-
#### Using the
|
|
1928
|
+
#### Using the list_holdings_with_http_info variant
|
|
1930
1929
|
|
|
1931
1930
|
This returns an Array which contains the response data, status code and headers.
|
|
1932
1931
|
|
|
1933
|
-
> <Array(<HoldingsResponseBody>, Integer, Hash)>
|
|
1932
|
+
> <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_with_http_info(user_guid, opts)
|
|
1934
1933
|
|
|
1935
1934
|
```ruby
|
|
1936
1935
|
begin
|
|
1937
|
-
# List holdings
|
|
1938
|
-
data, status_code, headers = api_instance.
|
|
1936
|
+
# List holdings
|
|
1937
|
+
data, status_code, headers = api_instance.list_holdings_with_http_info(user_guid, opts)
|
|
1939
1938
|
p status_code # => 2xx
|
|
1940
1939
|
p headers # => { ... }
|
|
1941
1940
|
p data # => <HoldingsResponseBody>
|
|
1942
1941
|
rescue MxPlatformRuby::ApiError => e
|
|
1943
|
-
puts "Error when calling MxPlatformApi->
|
|
1942
|
+
puts "Error when calling MxPlatformApi->list_holdings_with_http_info: #{e}"
|
|
1944
1943
|
end
|
|
1945
1944
|
```
|
|
1946
1945
|
|
|
@@ -1948,7 +1947,6 @@ end
|
|
|
1948
1947
|
|
|
1949
1948
|
| Name | Type | Description | Notes |
|
|
1950
1949
|
| ---- | ---- | ----------- | ----- |
|
|
1951
|
-
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
1952
1950
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
|
1953
1951
|
| **from_date** | **String** | Filter holdings from this date. | [optional] |
|
|
1954
1952
|
| **page** | **Integer** | Specify current page. | [optional] |
|
|
@@ -1969,13 +1967,13 @@ end
|
|
|
1969
1967
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
1970
1968
|
|
|
1971
1969
|
|
|
1972
|
-
##
|
|
1970
|
+
## list_holdings_by_member
|
|
1973
1971
|
|
|
1974
|
-
> <HoldingsResponseBody>
|
|
1972
|
+
> <HoldingsResponseBody> list_holdings_by_member(member_guid, user_guid, opts)
|
|
1975
1973
|
|
|
1976
|
-
List holdings by
|
|
1974
|
+
List holdings by member
|
|
1977
1975
|
|
|
1978
|
-
This endpoint returns all holdings associated with the specified `
|
|
1976
|
+
This endpoint returns all holdings associated with the specified `member` across all accounts.
|
|
1979
1977
|
|
|
1980
1978
|
### Examples
|
|
1981
1979
|
|
|
@@ -1990,6 +1988,7 @@ MxPlatformRuby.configure do |config|
|
|
|
1990
1988
|
end
|
|
1991
1989
|
|
|
1992
1990
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
1991
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
1993
1992
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
|
1994
1993
|
opts = {
|
|
1995
1994
|
from_date: '2015-09-20', # String | Filter holdings from this date.
|
|
@@ -1999,29 +1998,29 @@ opts = {
|
|
|
1999
1998
|
}
|
|
2000
1999
|
|
|
2001
2000
|
begin
|
|
2002
|
-
# List holdings by
|
|
2003
|
-
result = api_instance.
|
|
2001
|
+
# List holdings by member
|
|
2002
|
+
result = api_instance.list_holdings_by_member(member_guid, user_guid, opts)
|
|
2004
2003
|
p result
|
|
2005
2004
|
rescue MxPlatformRuby::ApiError => e
|
|
2006
|
-
puts "Error when calling MxPlatformApi->
|
|
2005
|
+
puts "Error when calling MxPlatformApi->list_holdings_by_member: #{e}"
|
|
2007
2006
|
end
|
|
2008
2007
|
```
|
|
2009
2008
|
|
|
2010
|
-
#### Using the
|
|
2009
|
+
#### Using the list_holdings_by_member_with_http_info variant
|
|
2011
2010
|
|
|
2012
2011
|
This returns an Array which contains the response data, status code and headers.
|
|
2013
2012
|
|
|
2014
|
-
> <Array(<HoldingsResponseBody>, Integer, Hash)>
|
|
2013
|
+
> <Array(<HoldingsResponseBody>, Integer, Hash)> list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
|
|
2015
2014
|
|
|
2016
2015
|
```ruby
|
|
2017
2016
|
begin
|
|
2018
|
-
# List holdings by
|
|
2019
|
-
data, status_code, headers = api_instance.
|
|
2017
|
+
# List holdings by member
|
|
2018
|
+
data, status_code, headers = api_instance.list_holdings_by_member_with_http_info(member_guid, user_guid, opts)
|
|
2020
2019
|
p status_code # => 2xx
|
|
2021
2020
|
p headers # => { ... }
|
|
2022
2021
|
p data # => <HoldingsResponseBody>
|
|
2023
2022
|
rescue MxPlatformRuby::ApiError => e
|
|
2024
|
-
puts "Error when calling MxPlatformApi->
|
|
2023
|
+
puts "Error when calling MxPlatformApi->list_holdings_by_member_with_http_info: #{e}"
|
|
2025
2024
|
end
|
|
2026
2025
|
```
|
|
2027
2026
|
|
|
@@ -2029,6 +2028,7 @@ end
|
|
|
2029
2028
|
|
|
2030
2029
|
| Name | Type | Description | Notes |
|
|
2031
2030
|
| ---- | ---- | ----------- | ----- |
|
|
2031
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
2032
2032
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
|
2033
2033
|
| **from_date** | **String** | Filter holdings from this date. | [optional] |
|
|
2034
2034
|
| **page** | **Integer** | Specify current page. | [optional] |
|
|
@@ -2049,11 +2049,11 @@ end
|
|
|
2049
2049
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
2050
2050
|
|
|
2051
2051
|
|
|
2052
|
-
##
|
|
2052
|
+
## list_institution_credentials
|
|
2053
2053
|
|
|
2054
|
-
> <CredentialsResponseBody>
|
|
2054
|
+
> <CredentialsResponseBody> list_institution_credentials(institution_code, opts)
|
|
2055
2055
|
|
|
2056
|
-
List institution
|
|
2056
|
+
List institution credentials
|
|
2057
2057
|
|
|
2058
2058
|
Use this endpoint to see which credentials will be needed to create a member for a specific institution.
|
|
2059
2059
|
|
|
@@ -2077,29 +2077,29 @@ opts = {
|
|
|
2077
2077
|
}
|
|
2078
2078
|
|
|
2079
2079
|
begin
|
|
2080
|
-
# List institution
|
|
2081
|
-
result = api_instance.
|
|
2080
|
+
# List institution credentials
|
|
2081
|
+
result = api_instance.list_institution_credentials(institution_code, opts)
|
|
2082
2082
|
p result
|
|
2083
2083
|
rescue MxPlatformRuby::ApiError => e
|
|
2084
|
-
puts "Error when calling MxPlatformApi->
|
|
2084
|
+
puts "Error when calling MxPlatformApi->list_institution_credentials: #{e}"
|
|
2085
2085
|
end
|
|
2086
2086
|
```
|
|
2087
2087
|
|
|
2088
|
-
#### Using the
|
|
2088
|
+
#### Using the list_institution_credentials_with_http_info variant
|
|
2089
2089
|
|
|
2090
2090
|
This returns an Array which contains the response data, status code and headers.
|
|
2091
2091
|
|
|
2092
|
-
> <Array(<CredentialsResponseBody>, Integer, Hash)>
|
|
2092
|
+
> <Array(<CredentialsResponseBody>, Integer, Hash)> list_institution_credentials_with_http_info(institution_code, opts)
|
|
2093
2093
|
|
|
2094
2094
|
```ruby
|
|
2095
2095
|
begin
|
|
2096
|
-
# List institution
|
|
2097
|
-
data, status_code, headers = api_instance.
|
|
2096
|
+
# List institution credentials
|
|
2097
|
+
data, status_code, headers = api_instance.list_institution_credentials_with_http_info(institution_code, opts)
|
|
2098
2098
|
p status_code # => 2xx
|
|
2099
2099
|
p headers # => { ... }
|
|
2100
2100
|
p data # => <CredentialsResponseBody>
|
|
2101
2101
|
rescue MxPlatformRuby::ApiError => e
|
|
2102
|
-
puts "Error when calling MxPlatformApi->
|
|
2102
|
+
puts "Error when calling MxPlatformApi->list_institution_credentials_with_http_info: #{e}"
|
|
2103
2103
|
end
|
|
2104
2104
|
```
|
|
2105
2105
|
|
|
@@ -2741,11 +2741,11 @@ end
|
|
|
2741
2741
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
2742
2742
|
|
|
2743
2743
|
|
|
2744
|
-
##
|
|
2744
|
+
## list_transaction_rules
|
|
2745
2745
|
|
|
2746
|
-
> <TransactionRulesResponseBody>
|
|
2746
|
+
> <TransactionRulesResponseBody> list_transaction_rules(user_guid, opts)
|
|
2747
2747
|
|
|
2748
|
-
List transaction rules
|
|
2748
|
+
List transaction rules
|
|
2749
2749
|
|
|
2750
2750
|
Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
|
|
2751
2751
|
|
|
@@ -2769,29 +2769,29 @@ opts = {
|
|
|
2769
2769
|
}
|
|
2770
2770
|
|
|
2771
2771
|
begin
|
|
2772
|
-
# List transaction rules
|
|
2773
|
-
result = api_instance.
|
|
2772
|
+
# List transaction rules
|
|
2773
|
+
result = api_instance.list_transaction_rules(user_guid, opts)
|
|
2774
2774
|
p result
|
|
2775
2775
|
rescue MxPlatformRuby::ApiError => e
|
|
2776
|
-
puts "Error when calling MxPlatformApi->
|
|
2776
|
+
puts "Error when calling MxPlatformApi->list_transaction_rules: #{e}"
|
|
2777
2777
|
end
|
|
2778
2778
|
```
|
|
2779
2779
|
|
|
2780
|
-
#### Using the
|
|
2780
|
+
#### Using the list_transaction_rules_with_http_info variant
|
|
2781
2781
|
|
|
2782
2782
|
This returns an Array which contains the response data, status code and headers.
|
|
2783
2783
|
|
|
2784
|
-
> <Array(<TransactionRulesResponseBody>, Integer, Hash)>
|
|
2784
|
+
> <Array(<TransactionRulesResponseBody>, Integer, Hash)> list_transaction_rules_with_http_info(user_guid, opts)
|
|
2785
2785
|
|
|
2786
2786
|
```ruby
|
|
2787
2787
|
begin
|
|
2788
|
-
# List transaction rules
|
|
2789
|
-
data, status_code, headers = api_instance.
|
|
2788
|
+
# List transaction rules
|
|
2789
|
+
data, status_code, headers = api_instance.list_transaction_rules_with_http_info(user_guid, opts)
|
|
2790
2790
|
p status_code # => 2xx
|
|
2791
2791
|
p headers # => { ... }
|
|
2792
2792
|
p data # => <TransactionRulesResponseBody>
|
|
2793
2793
|
rescue MxPlatformRuby::ApiError => e
|
|
2794
|
-
puts "Error when calling MxPlatformApi->
|
|
2794
|
+
puts "Error when calling MxPlatformApi->list_transaction_rules_with_http_info: #{e}"
|
|
2795
2795
|
end
|
|
2796
2796
|
```
|
|
2797
2797
|
|
|
@@ -2817,13 +2817,13 @@ end
|
|
|
2817
2817
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
2818
2818
|
|
|
2819
2819
|
|
|
2820
|
-
##
|
|
2820
|
+
## list_transactions
|
|
2821
2821
|
|
|
2822
|
-
> <TransactionsResponseBody>
|
|
2822
|
+
> <TransactionsResponseBody> list_transactions(user_guid, opts)
|
|
2823
2823
|
|
|
2824
|
-
List transactions
|
|
2824
|
+
List transactions
|
|
2825
2825
|
|
|
2826
|
-
|
|
2826
|
+
Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`.
|
|
2827
2827
|
|
|
2828
2828
|
### Examples
|
|
2829
2829
|
|
|
@@ -2838,7 +2838,6 @@ MxPlatformRuby.configure do |config|
|
|
|
2838
2838
|
end
|
|
2839
2839
|
|
|
2840
2840
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
2841
|
-
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
2842
2841
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
|
2843
2842
|
opts = {
|
|
2844
2843
|
from_date: '2015-09-20', # String | Filter transactions from this date.
|
|
@@ -2848,29 +2847,29 @@ opts = {
|
|
|
2848
2847
|
}
|
|
2849
2848
|
|
|
2850
2849
|
begin
|
|
2851
|
-
# List transactions
|
|
2852
|
-
result = api_instance.
|
|
2850
|
+
# List transactions
|
|
2851
|
+
result = api_instance.list_transactions(user_guid, opts)
|
|
2853
2852
|
p result
|
|
2854
2853
|
rescue MxPlatformRuby::ApiError => e
|
|
2855
|
-
puts "Error when calling MxPlatformApi->
|
|
2854
|
+
puts "Error when calling MxPlatformApi->list_transactions: #{e}"
|
|
2856
2855
|
end
|
|
2857
2856
|
```
|
|
2858
2857
|
|
|
2859
|
-
#### Using the
|
|
2858
|
+
#### Using the list_transactions_with_http_info variant
|
|
2860
2859
|
|
|
2861
2860
|
This returns an Array which contains the response data, status code and headers.
|
|
2862
2861
|
|
|
2863
|
-
> <Array(<TransactionsResponseBody>, Integer, Hash)>
|
|
2862
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_with_http_info(user_guid, opts)
|
|
2864
2863
|
|
|
2865
2864
|
```ruby
|
|
2866
2865
|
begin
|
|
2867
|
-
# List transactions
|
|
2868
|
-
data, status_code, headers = api_instance.
|
|
2866
|
+
# List transactions
|
|
2867
|
+
data, status_code, headers = api_instance.list_transactions_with_http_info(user_guid, opts)
|
|
2869
2868
|
p status_code # => 2xx
|
|
2870
2869
|
p headers # => { ... }
|
|
2871
2870
|
p data # => <TransactionsResponseBody>
|
|
2872
2871
|
rescue MxPlatformRuby::ApiError => e
|
|
2873
|
-
puts "Error when calling MxPlatformApi->
|
|
2872
|
+
puts "Error when calling MxPlatformApi->list_transactions_with_http_info: #{e}"
|
|
2874
2873
|
end
|
|
2875
2874
|
```
|
|
2876
2875
|
|
|
@@ -2878,7 +2877,6 @@ end
|
|
|
2878
2877
|
|
|
2879
2878
|
| Name | Type | Description | Notes |
|
|
2880
2879
|
| ---- | ---- | ----------- | ----- |
|
|
2881
|
-
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
2882
2880
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
|
2883
2881
|
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
|
2884
2882
|
| **page** | **Integer** | Specify current page. | [optional] |
|
|
@@ -2899,13 +2897,13 @@ end
|
|
|
2899
2897
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
2900
2898
|
|
|
2901
2899
|
|
|
2902
|
-
##
|
|
2900
|
+
## list_transactions_by_account
|
|
2903
2901
|
|
|
2904
|
-
> <TransactionsResponseBody>
|
|
2902
|
+
> <TransactionsResponseBody> list_transactions_by_account(account_guid, user_guid, opts)
|
|
2905
2903
|
|
|
2906
|
-
List transactions by
|
|
2904
|
+
List transactions by account
|
|
2907
2905
|
|
|
2908
|
-
|
|
2906
|
+
This endpoint returns a list of the last 90 days of transactions associated with the specified account.
|
|
2909
2907
|
|
|
2910
2908
|
### Examples
|
|
2911
2909
|
|
|
@@ -2920,7 +2918,7 @@ MxPlatformRuby.configure do |config|
|
|
|
2920
2918
|
end
|
|
2921
2919
|
|
|
2922
2920
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
2923
|
-
|
|
2921
|
+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
|
|
2924
2922
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
|
2925
2923
|
opts = {
|
|
2926
2924
|
from_date: '2015-09-20', # String | Filter transactions from this date.
|
|
@@ -2930,29 +2928,29 @@ opts = {
|
|
|
2930
2928
|
}
|
|
2931
2929
|
|
|
2932
2930
|
begin
|
|
2933
|
-
# List transactions by
|
|
2934
|
-
result = api_instance.
|
|
2931
|
+
# List transactions by account
|
|
2932
|
+
result = api_instance.list_transactions_by_account(account_guid, user_guid, opts)
|
|
2935
2933
|
p result
|
|
2936
2934
|
rescue MxPlatformRuby::ApiError => e
|
|
2937
|
-
puts "Error when calling MxPlatformApi->
|
|
2935
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_account: #{e}"
|
|
2938
2936
|
end
|
|
2939
2937
|
```
|
|
2940
2938
|
|
|
2941
|
-
#### Using the
|
|
2939
|
+
#### Using the list_transactions_by_account_with_http_info variant
|
|
2942
2940
|
|
|
2943
2941
|
This returns an Array which contains the response data, status code and headers.
|
|
2944
2942
|
|
|
2945
|
-
> <Array(<TransactionsResponseBody>, Integer, Hash)>
|
|
2943
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
|
|
2946
2944
|
|
|
2947
2945
|
```ruby
|
|
2948
2946
|
begin
|
|
2949
|
-
# List transactions by
|
|
2950
|
-
data, status_code, headers = api_instance.
|
|
2947
|
+
# List transactions by account
|
|
2948
|
+
data, status_code, headers = api_instance.list_transactions_by_account_with_http_info(account_guid, user_guid, opts)
|
|
2951
2949
|
p status_code # => 2xx
|
|
2952
2950
|
p headers # => { ... }
|
|
2953
2951
|
p data # => <TransactionsResponseBody>
|
|
2954
2952
|
rescue MxPlatformRuby::ApiError => e
|
|
2955
|
-
puts "Error when calling MxPlatformApi->
|
|
2953
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_account_with_http_info: #{e}"
|
|
2956
2954
|
end
|
|
2957
2955
|
```
|
|
2958
2956
|
|
|
@@ -2960,7 +2958,7 @@ end
|
|
|
2960
2958
|
|
|
2961
2959
|
| Name | Type | Description | Notes |
|
|
2962
2960
|
| ---- | ---- | ----------- | ----- |
|
|
2963
|
-
| **
|
|
2961
|
+
| **account_guid** | **String** | The unique id for an `account`. | |
|
|
2964
2962
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
|
2965
2963
|
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
|
2966
2964
|
| **page** | **Integer** | Specify current page. | [optional] |
|
|
@@ -2981,13 +2979,13 @@ end
|
|
|
2981
2979
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
2982
2980
|
|
|
2983
2981
|
|
|
2984
|
-
##
|
|
2982
|
+
## list_transactions_by_member
|
|
2985
2983
|
|
|
2986
|
-
> <TransactionsResponseBody>
|
|
2984
|
+
> <TransactionsResponseBody> list_transactions_by_member(member_guid, user_guid, opts)
|
|
2987
2985
|
|
|
2988
|
-
List transactions by
|
|
2986
|
+
List transactions by member
|
|
2989
2987
|
|
|
2990
|
-
|
|
2988
|
+
Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`.
|
|
2991
2989
|
|
|
2992
2990
|
### Examples
|
|
2993
2991
|
|
|
@@ -3002,33 +3000,39 @@ MxPlatformRuby.configure do |config|
|
|
|
3002
3000
|
end
|
|
3003
3001
|
|
|
3004
3002
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
3005
|
-
|
|
3003
|
+
member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
|
|
3006
3004
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
|
3005
|
+
opts = {
|
|
3006
|
+
from_date: '2015-09-20', # String | Filter transactions from this date.
|
|
3007
|
+
page: 1, # Integer | Specify current page.
|
|
3008
|
+
records_per_page: 10, # Integer | Specify records per page.
|
|
3009
|
+
to_date: '2019-10-20' # String | Filter transactions to this date.
|
|
3010
|
+
}
|
|
3007
3011
|
|
|
3008
3012
|
begin
|
|
3009
|
-
# List transactions by
|
|
3010
|
-
result = api_instance.
|
|
3013
|
+
# List transactions by member
|
|
3014
|
+
result = api_instance.list_transactions_by_member(member_guid, user_guid, opts)
|
|
3011
3015
|
p result
|
|
3012
3016
|
rescue MxPlatformRuby::ApiError => e
|
|
3013
|
-
puts "Error when calling MxPlatformApi->
|
|
3017
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_member: #{e}"
|
|
3014
3018
|
end
|
|
3015
3019
|
```
|
|
3016
3020
|
|
|
3017
|
-
#### Using the
|
|
3021
|
+
#### Using the list_transactions_by_member_with_http_info variant
|
|
3018
3022
|
|
|
3019
3023
|
This returns an Array which contains the response data, status code and headers.
|
|
3020
3024
|
|
|
3021
|
-
> <Array(<TransactionsResponseBody>, Integer, Hash)>
|
|
3025
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
|
|
3022
3026
|
|
|
3023
3027
|
```ruby
|
|
3024
3028
|
begin
|
|
3025
|
-
# List transactions by
|
|
3026
|
-
data, status_code, headers = api_instance.
|
|
3029
|
+
# List transactions by member
|
|
3030
|
+
data, status_code, headers = api_instance.list_transactions_by_member_with_http_info(member_guid, user_guid, opts)
|
|
3027
3031
|
p status_code # => 2xx
|
|
3028
3032
|
p headers # => { ... }
|
|
3029
3033
|
p data # => <TransactionsResponseBody>
|
|
3030
3034
|
rescue MxPlatformRuby::ApiError => e
|
|
3031
|
-
puts "Error when calling MxPlatformApi->
|
|
3035
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_member_with_http_info: #{e}"
|
|
3032
3036
|
end
|
|
3033
3037
|
```
|
|
3034
3038
|
|
|
@@ -3036,8 +3040,12 @@ end
|
|
|
3036
3040
|
|
|
3037
3041
|
| Name | Type | Description | Notes |
|
|
3038
3042
|
| ---- | ---- | ----------- | ----- |
|
|
3039
|
-
| **
|
|
3043
|
+
| **member_guid** | **String** | The unique id for a `member`. | |
|
|
3040
3044
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
|
3045
|
+
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
|
3046
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
|
3047
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
|
3048
|
+
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
|
3041
3049
|
|
|
3042
3050
|
### Return type
|
|
3043
3051
|
|
|
@@ -3053,13 +3061,13 @@ end
|
|
|
3053
3061
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
3054
3062
|
|
|
3055
3063
|
|
|
3056
|
-
##
|
|
3064
|
+
## list_transactions_by_tag
|
|
3057
3065
|
|
|
3058
|
-
> <TransactionsResponseBody>
|
|
3066
|
+
> <TransactionsResponseBody> list_transactions_by_tag(tag_guid, user_guid)
|
|
3059
3067
|
|
|
3060
|
-
List transactions by
|
|
3068
|
+
List transactions by tag
|
|
3061
3069
|
|
|
3062
|
-
|
|
3070
|
+
Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint.
|
|
3063
3071
|
|
|
3064
3072
|
### Examples
|
|
3065
3073
|
|
|
@@ -3074,38 +3082,33 @@ MxPlatformRuby.configure do |config|
|
|
|
3074
3082
|
end
|
|
3075
3083
|
|
|
3076
3084
|
api_instance = MxPlatformRuby::MxPlatformApi.new
|
|
3085
|
+
tag_guid = 'TAG-aef36e72-6294-4c38-844d-e573e80aed52' # String | The unique id for a `tag`.
|
|
3077
3086
|
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
|
3078
|
-
opts = {
|
|
3079
|
-
from_date: '2015-09-20', # String | Filter transactions from this date.
|
|
3080
|
-
page: 1, # Integer | Specify current page.
|
|
3081
|
-
records_per_page: 10, # Integer | Specify records per page.
|
|
3082
|
-
to_date: '2019-10-20' # String | Filter transactions to this date.
|
|
3083
|
-
}
|
|
3084
3087
|
|
|
3085
3088
|
begin
|
|
3086
|
-
# List transactions by
|
|
3087
|
-
result = api_instance.
|
|
3089
|
+
# List transactions by tag
|
|
3090
|
+
result = api_instance.list_transactions_by_tag(tag_guid, user_guid)
|
|
3088
3091
|
p result
|
|
3089
3092
|
rescue MxPlatformRuby::ApiError => e
|
|
3090
|
-
puts "Error when calling MxPlatformApi->
|
|
3093
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_tag: #{e}"
|
|
3091
3094
|
end
|
|
3092
3095
|
```
|
|
3093
3096
|
|
|
3094
|
-
#### Using the
|
|
3097
|
+
#### Using the list_transactions_by_tag_with_http_info variant
|
|
3095
3098
|
|
|
3096
3099
|
This returns an Array which contains the response data, status code and headers.
|
|
3097
3100
|
|
|
3098
|
-
> <Array(<TransactionsResponseBody>, Integer, Hash)>
|
|
3101
|
+
> <Array(<TransactionsResponseBody>, Integer, Hash)> list_transactions_by_tag_with_http_info(tag_guid, user_guid)
|
|
3099
3102
|
|
|
3100
3103
|
```ruby
|
|
3101
3104
|
begin
|
|
3102
|
-
# List transactions by
|
|
3103
|
-
data, status_code, headers = api_instance.
|
|
3105
|
+
# List transactions by tag
|
|
3106
|
+
data, status_code, headers = api_instance.list_transactions_by_tag_with_http_info(tag_guid, user_guid)
|
|
3104
3107
|
p status_code # => 2xx
|
|
3105
3108
|
p headers # => { ... }
|
|
3106
3109
|
p data # => <TransactionsResponseBody>
|
|
3107
3110
|
rescue MxPlatformRuby::ApiError => e
|
|
3108
|
-
puts "Error when calling MxPlatformApi->
|
|
3111
|
+
puts "Error when calling MxPlatformApi->list_transactions_by_tag_with_http_info: #{e}"
|
|
3109
3112
|
end
|
|
3110
3113
|
```
|
|
3111
3114
|
|
|
@@ -3113,11 +3116,8 @@ end
|
|
|
3113
3116
|
|
|
3114
3117
|
| Name | Type | Description | Notes |
|
|
3115
3118
|
| ---- | ---- | ----------- | ----- |
|
|
3119
|
+
| **tag_guid** | **String** | The unique id for a `tag`. | |
|
|
3116
3120
|
| **user_guid** | **String** | The unique id for a `user`. | |
|
|
3117
|
-
| **from_date** | **String** | Filter transactions from this date. | [optional] |
|
|
3118
|
-
| **page** | **Integer** | Specify current page. | [optional] |
|
|
3119
|
-
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
|
3120
|
-
| **to_date** | **String** | Filter transactions to this date. | [optional] |
|
|
3121
3121
|
|
|
3122
3122
|
### Return type
|
|
3123
3123
|
|
|
@@ -4219,7 +4219,7 @@ end
|
|
|
4219
4219
|
|
|
4220
4220
|
> <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, opts)
|
|
4221
4221
|
|
|
4222
|
-
Request connect widget
|
|
4222
|
+
Request connect widget url
|
|
4223
4223
|
|
|
4224
4224
|
This endpoint will return a URL for an embeddable version of MX Connect.
|
|
4225
4225
|
|
|
@@ -4242,7 +4242,7 @@ opts = {
|
|
|
4242
4242
|
}
|
|
4243
4243
|
|
|
4244
4244
|
begin
|
|
4245
|
-
# Request connect widget
|
|
4245
|
+
# Request connect widget url
|
|
4246
4246
|
result = api_instance.request_connect_widget_url(user_guid, opts)
|
|
4247
4247
|
p result
|
|
4248
4248
|
rescue MxPlatformRuby::ApiError => e
|
|
@@ -4258,7 +4258,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
4258
4258
|
|
|
4259
4259
|
```ruby
|
|
4260
4260
|
begin
|
|
4261
|
-
# Request connect widget
|
|
4261
|
+
# Request connect widget url
|
|
4262
4262
|
data, status_code, headers = api_instance.request_connect_widget_url_with_http_info(user_guid, opts)
|
|
4263
4263
|
p status_code # => 2xx
|
|
4264
4264
|
p headers # => { ... }
|
|
@@ -4289,11 +4289,11 @@ end
|
|
|
4289
4289
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
4290
4290
|
|
|
4291
4291
|
|
|
4292
|
-
##
|
|
4292
|
+
## request_o_auth_window_uri
|
|
4293
4293
|
|
|
4294
|
-
> <OAuthWindowResponseBody>
|
|
4294
|
+
> <OAuthWindowResponseBody> request_o_auth_window_uri(member_guid, user_guid, opts)
|
|
4295
4295
|
|
|
4296
|
-
|
|
4296
|
+
Request oauth window uri
|
|
4297
4297
|
|
|
4298
4298
|
This endpoint will generate an `oauth_window_uri` for the specified `member`.
|
|
4299
4299
|
|
|
@@ -4318,29 +4318,29 @@ opts = {
|
|
|
4318
4318
|
}
|
|
4319
4319
|
|
|
4320
4320
|
begin
|
|
4321
|
-
#
|
|
4322
|
-
result = api_instance.
|
|
4321
|
+
# Request oauth window uri
|
|
4322
|
+
result = api_instance.request_o_auth_window_uri(member_guid, user_guid, opts)
|
|
4323
4323
|
p result
|
|
4324
4324
|
rescue MxPlatformRuby::ApiError => e
|
|
4325
|
-
puts "Error when calling MxPlatformApi->
|
|
4325
|
+
puts "Error when calling MxPlatformApi->request_o_auth_window_uri: #{e}"
|
|
4326
4326
|
end
|
|
4327
4327
|
```
|
|
4328
4328
|
|
|
4329
|
-
#### Using the
|
|
4329
|
+
#### Using the request_o_auth_window_uri_with_http_info variant
|
|
4330
4330
|
|
|
4331
4331
|
This returns an Array which contains the response data, status code and headers.
|
|
4332
4332
|
|
|
4333
|
-
> <Array(<OAuthWindowResponseBody>, Integer, Hash)>
|
|
4333
|
+
> <Array(<OAuthWindowResponseBody>, Integer, Hash)> request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts)
|
|
4334
4334
|
|
|
4335
4335
|
```ruby
|
|
4336
4336
|
begin
|
|
4337
|
-
#
|
|
4338
|
-
data, status_code, headers = api_instance.
|
|
4337
|
+
# Request oauth window uri
|
|
4338
|
+
data, status_code, headers = api_instance.request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts)
|
|
4339
4339
|
p status_code # => 2xx
|
|
4340
4340
|
p headers # => { ... }
|
|
4341
4341
|
p data # => <OAuthWindowResponseBody>
|
|
4342
4342
|
rescue MxPlatformRuby::ApiError => e
|
|
4343
|
-
puts "Error when calling MxPlatformApi->
|
|
4343
|
+
puts "Error when calling MxPlatformApi->request_o_auth_window_uri_with_http_info: #{e}"
|
|
4344
4344
|
end
|
|
4345
4345
|
```
|
|
4346
4346
|
|
|
@@ -4371,7 +4371,7 @@ end
|
|
|
4371
4371
|
|
|
4372
4372
|
> <WidgetResponseBody> request_widget_url(user_guid, widget_request_body, opts)
|
|
4373
4373
|
|
|
4374
|
-
Request
|
|
4374
|
+
Request widget url
|
|
4375
4375
|
|
|
4376
4376
|
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.
|
|
4377
4377
|
|
|
@@ -4395,7 +4395,7 @@ opts = {
|
|
|
4395
4395
|
}
|
|
4396
4396
|
|
|
4397
4397
|
begin
|
|
4398
|
-
# Request
|
|
4398
|
+
# Request widget url
|
|
4399
4399
|
result = api_instance.request_widget_url(user_guid, widget_request_body, opts)
|
|
4400
4400
|
p result
|
|
4401
4401
|
rescue MxPlatformRuby::ApiError => e
|
|
@@ -4411,7 +4411,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
4411
4411
|
|
|
4412
4412
|
```ruby
|
|
4413
4413
|
begin
|
|
4414
|
-
# Request
|
|
4414
|
+
# Request widget url
|
|
4415
4415
|
data, status_code, headers = api_instance.request_widget_url_with_http_info(user_guid, widget_request_body, opts)
|
|
4416
4416
|
p status_code # => 2xx
|
|
4417
4417
|
p headers # => { ... }
|
|
@@ -4517,11 +4517,11 @@ end
|
|
|
4517
4517
|
- **Accept**: application/vnd.mx.api.v1+json
|
|
4518
4518
|
|
|
4519
4519
|
|
|
4520
|
-
##
|
|
4520
|
+
## update_account_by_member
|
|
4521
4521
|
|
|
4522
|
-
> <AccountResponseBody>
|
|
4522
|
+
> <AccountResponseBody> update_account_by_member(user_guid, member_guid, account_guid, account_update_request_body)
|
|
4523
4523
|
|
|
4524
|
-
Update account
|
|
4524
|
+
Update account by member
|
|
4525
4525
|
|
|
4526
4526
|
This endpoint allows you to update certain attributes of an `account` resource.
|
|
4527
4527
|
|
|
@@ -4544,29 +4544,29 @@ account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique
|
|
|
4544
4544
|
account_update_request_body = MxPlatformRuby::AccountUpdateRequestBody.new # AccountUpdateRequestBody | Account object to be created with optional parameters (is_hidden)
|
|
4545
4545
|
|
|
4546
4546
|
begin
|
|
4547
|
-
# Update account
|
|
4548
|
-
result = api_instance.
|
|
4547
|
+
# Update account by member
|
|
4548
|
+
result = api_instance.update_account_by_member(user_guid, member_guid, account_guid, account_update_request_body)
|
|
4549
4549
|
p result
|
|
4550
4550
|
rescue MxPlatformRuby::ApiError => e
|
|
4551
|
-
puts "Error when calling MxPlatformApi->
|
|
4551
|
+
puts "Error when calling MxPlatformApi->update_account_by_member: #{e}"
|
|
4552
4552
|
end
|
|
4553
4553
|
```
|
|
4554
4554
|
|
|
4555
|
-
#### Using the
|
|
4555
|
+
#### Using the update_account_by_member_with_http_info variant
|
|
4556
4556
|
|
|
4557
4557
|
This returns an Array which contains the response data, status code and headers.
|
|
4558
4558
|
|
|
4559
|
-
> <Array(<AccountResponseBody>, Integer, Hash)>
|
|
4559
|
+
> <Array(<AccountResponseBody>, Integer, Hash)> update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body)
|
|
4560
4560
|
|
|
4561
4561
|
```ruby
|
|
4562
4562
|
begin
|
|
4563
|
-
# Update account
|
|
4564
|
-
data, status_code, headers = api_instance.
|
|
4563
|
+
# Update account by member
|
|
4564
|
+
data, status_code, headers = api_instance.update_account_by_member_with_http_info(user_guid, member_guid, account_guid, account_update_request_body)
|
|
4565
4565
|
p status_code # => 2xx
|
|
4566
4566
|
p headers # => { ... }
|
|
4567
4567
|
p data # => <AccountResponseBody>
|
|
4568
4568
|
rescue MxPlatformRuby::ApiError => e
|
|
4569
|
-
puts "Error when calling MxPlatformApi->
|
|
4569
|
+
puts "Error when calling MxPlatformApi->update_account_by_member_with_http_info: #{e}"
|
|
4570
4570
|
end
|
|
4571
4571
|
```
|
|
4572
4572
|
|
|
@@ -4743,7 +4743,7 @@ end
|
|
|
4743
4743
|
|
|
4744
4744
|
## update_tag
|
|
4745
4745
|
|
|
4746
|
-
> <
|
|
4746
|
+
> <TagResponseBody> update_tag(tag_guid, user_guid, tag_update_request_body)
|
|
4747
4747
|
|
|
4748
4748
|
Update tag
|
|
4749
4749
|
|
|
@@ -4779,7 +4779,7 @@ end
|
|
|
4779
4779
|
|
|
4780
4780
|
This returns an Array which contains the response data, status code and headers.
|
|
4781
4781
|
|
|
4782
|
-
> <Array(<
|
|
4782
|
+
> <Array(<TagResponseBody>, Integer, Hash)> update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body)
|
|
4783
4783
|
|
|
4784
4784
|
```ruby
|
|
4785
4785
|
begin
|
|
@@ -4787,7 +4787,7 @@ begin
|
|
|
4787
4787
|
data, status_code, headers = api_instance.update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body)
|
|
4788
4788
|
p status_code # => 2xx
|
|
4789
4789
|
p headers # => { ... }
|
|
4790
|
-
p data # => <
|
|
4790
|
+
p data # => <TagResponseBody>
|
|
4791
4791
|
rescue MxPlatformRuby::ApiError => e
|
|
4792
4792
|
puts "Error when calling MxPlatformApi->update_tag_with_http_info: #{e}"
|
|
4793
4793
|
end
|
|
@@ -4803,7 +4803,7 @@ end
|
|
|
4803
4803
|
|
|
4804
4804
|
### Return type
|
|
4805
4805
|
|
|
4806
|
-
[**
|
|
4806
|
+
[**TagResponseBody**](TagResponseBody.md)
|
|
4807
4807
|
|
|
4808
4808
|
### Authorization
|
|
4809
4809
|
|