mx-platform-ruby 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +4 -4
  4. data/docs/Account.md +96 -0
  5. data/docs/AccountNumber.md +32 -0
  6. data/docs/AccountNumbersResponseBody.md +20 -0
  7. data/docs/AccountOwner.md +40 -0
  8. data/docs/AccountOwnersResponseBody.md +20 -0
  9. data/docs/AccountResponseBody.md +18 -0
  10. data/docs/AccountUpdateRequest.md +18 -0
  11. data/docs/AccountUpdateRequestBody.md +18 -0
  12. data/docs/AccountsResponseBody.md +20 -0
  13. data/docs/CategoriesResponseBody.md +20 -0
  14. data/docs/Category.md +32 -0
  15. data/docs/CategoryCreateRequest.md +22 -0
  16. data/docs/CategoryCreateRequestBody.md +18 -0
  17. data/docs/CategoryResponseBody.md +18 -0
  18. data/docs/CategoryUpdateRequest.md +20 -0
  19. data/docs/CategoryUpdateRequestBody.md +18 -0
  20. data/docs/Challenge.md +30 -0
  21. data/docs/ChallengeImageOptions.md +22 -0
  22. data/docs/ChallengeOptions.md +20 -0
  23. data/docs/ChallengesResponseBody.md +20 -0
  24. data/docs/ConnectWidget.md +20 -0
  25. data/docs/ConnectWidgetRequest.md +38 -0
  26. data/docs/ConnectWidgetRequestBody.md +18 -0
  27. data/docs/ConnectWidgetResponseBody.md +18 -0
  28. data/docs/Credential.md +26 -0
  29. data/docs/CredentialRequest.md +20 -0
  30. data/docs/CredentialsResponseBody.md +20 -0
  31. data/docs/EnhanceTransaction.md +48 -0
  32. data/docs/EnhanceTransactionsRequest.md +26 -0
  33. data/docs/EnhanceTransactionsRequestBody.md +18 -0
  34. data/docs/EnhanceTransactionsResponseBody.md +18 -0
  35. data/docs/Holding.md +52 -0
  36. data/docs/HoldingResponseBody.md +18 -0
  37. data/docs/HoldingsResponseBody.md +20 -0
  38. data/docs/InlineResponse200.md +18 -0
  39. data/docs/Institution.md +36 -0
  40. data/docs/InstitutionResponseBody.md +18 -0
  41. data/docs/InstitutionsResponseBody.md +20 -0
  42. data/docs/Member.md +40 -0
  43. data/docs/MemberCreateRequest.md +30 -0
  44. data/docs/MemberCreateRequestBody.md +22 -0
  45. data/docs/MemberResponseBody.md +18 -0
  46. data/docs/MemberResumeRequest.md +18 -0
  47. data/docs/MemberResumeRequestBody.md +18 -0
  48. data/docs/MemberStatus.md +34 -0
  49. data/docs/MemberStatusResponseBody.md +18 -0
  50. data/docs/MemberUpdateRequest.md +26 -0
  51. data/docs/MemberUpdateRequestBody.md +18 -0
  52. data/docs/MembersResponseBody.md +20 -0
  53. data/docs/Merchant.md +28 -0
  54. data/docs/MerchantResponseBody.md +18 -0
  55. data/docs/MerchantsResponseBody.md +20 -0
  56. data/docs/MxPlatformApi.md +5182 -0
  57. data/docs/OAuthWindow.md +20 -0
  58. data/docs/OAuthWindowResponseBody.md +18 -0
  59. data/docs/Pagination.md +24 -0
  60. data/docs/Statement.md +32 -0
  61. data/docs/StatementResponseBody.md +18 -0
  62. data/docs/StatementsResponseBody.md +20 -0
  63. data/docs/Tag.md +22 -0
  64. data/docs/TagCreateRequest.md +18 -0
  65. data/docs/TagCreateRequestBody.md +18 -0
  66. data/docs/TagResponseBody.md +18 -0
  67. data/docs/TagUpdateRequest.md +18 -0
  68. data/docs/TagUpdateRequestBody.md +18 -0
  69. data/docs/Tagging.md +26 -0
  70. data/docs/TaggingCreateRequest.md +20 -0
  71. data/docs/TaggingCreateRequestBody.md +18 -0
  72. data/docs/TaggingResponseBody.md +18 -0
  73. data/docs/TaggingUpdateRequest.md +18 -0
  74. data/docs/TaggingUpdateRequestBody.md +18 -0
  75. data/docs/TaggingsResponseBody.md +20 -0
  76. data/docs/TagsResponseBody.md +20 -0
  77. data/docs/Transaction.md +88 -0
  78. data/docs/TransactionResponseBody.md +18 -0
  79. data/docs/TransactionRule.md +30 -0
  80. data/docs/TransactionRuleCreateRequest.md +22 -0
  81. data/docs/TransactionRuleCreateRequestBody.md +18 -0
  82. data/docs/TransactionRuleResponseBody.md +18 -0
  83. data/docs/TransactionRuleUpdateRequest.md +22 -0
  84. data/docs/TransactionRuleUpdateRequestBody.md +18 -0
  85. data/docs/TransactionRulesResponseBody.md +20 -0
  86. data/docs/TransactionUpdateRequest.md +18 -0
  87. data/docs/TransactionUpdateRequestBody.md +18 -0
  88. data/docs/TransactionsResponseBody.md +20 -0
  89. data/docs/User.md +26 -0
  90. data/docs/UserCreateRequest.md +24 -0
  91. data/docs/UserCreateRequestBody.md +18 -0
  92. data/docs/UserResponseBody.md +18 -0
  93. data/docs/UserUpdateRequest.md +24 -0
  94. data/docs/UserUpdateRequestBody.md +18 -0
  95. data/docs/UsersResponseBody.md +20 -0
  96. data/docs/Widget.md +22 -0
  97. data/docs/WidgetRequest.md +42 -0
  98. data/docs/WidgetRequestBody.md +18 -0
  99. data/docs/WidgetResponseBody.md +18 -0
  100. data/lib/mx-platform-ruby/version.rb +1 -1
  101. data/openapi/mx_platform_ruby.yml +1 -1
  102. data/pkg/mx-platform-ruby-0.2.0.gem +0 -0
  103. metadata +98 -1
data/docs/Holding.md ADDED
@@ -0,0 +1,52 @@
1
+ # MxPlatformRuby::Holding
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_guid** | **String** | | [optional] |
8
+ | **cost_basis** | **Float** | | [optional] |
9
+ | **created_at** | **String** | | [optional] |
10
+ | **currency_code** | **String** | | [optional] |
11
+ | **cusip** | **String** | | [optional] |
12
+ | **daily_change** | **Float** | | [optional] |
13
+ | **description** | **String** | | [optional] |
14
+ | **guid** | **String** | | [optional] |
15
+ | **holding_type** | **String** | | [optional] |
16
+ | **id** | **String** | | [optional] |
17
+ | **market_value** | **Float** | | [optional] |
18
+ | **member_guid** | **String** | | [optional] |
19
+ | **metadata** | **String** | | [optional] |
20
+ | **purchase_price** | **Float** | | [optional] |
21
+ | **shares** | **Float** | | [optional] |
22
+ | **symbol** | **String** | | [optional] |
23
+ | **updated_at** | **String** | | [optional] |
24
+ | **user_guid** | **String** | | [optional] |
25
+
26
+ ## Example
27
+
28
+ ```ruby
29
+ require 'mx-platform-ruby'
30
+
31
+ instance = MxPlatformRuby::Holding.new(
32
+ account_guid: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2,
33
+ cost_basis: 827.0,
34
+ created_at: 2015-04-13T18:01:23.000Z,
35
+ currency_code: USD,
36
+ cusip: 18383M878,
37
+ daily_change: 2.5,
38
+ description: Guggenheim Defensive Equity ETF,
39
+ guid: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2,
40
+ holding_type: MONEY_MARKET,
41
+ id: ID-123,
42
+ market_value: 989.5,
43
+ member_guid: MBR-d65683e8-9eab-26bb-bcfd-ced159c9abe,
44
+ metadata: metadata,
45
+ purchase_price: 26.3,
46
+ shares: 6.0,
47
+ symbol: DEF,
48
+ updated_at: 2015-04-13T18:01:23.000Z,
49
+ user_guid: USR-743e5d7f-1116-28fa-5de1-d3ba02e41d8d
50
+ )
51
+ ```
52
+
data/docs/HoldingResponseBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::HoldingResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **holding** | [**Holding**](Holding.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::HoldingResponseBody.new(
15
+ holding: null
16
+ )
17
+ ```
18
+
data/docs/HoldingsResponseBody.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::HoldingsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **holdings** | [**Array<Holding>**](Holding.md) | | [optional] |
8
+ | **pagination** | [**Pagination**](Pagination.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::HoldingsResponseBody.new(
16
+ holdings: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
data/docs/InlineResponse200.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::InlineResponse200
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **tag** | [**Tag**](Tag.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::InlineResponse200.new(
15
+ tag: null
16
+ )
17
+ ```
18
+
data/docs/Institution.md ADDED
@@ -0,0 +1,36 @@
1
+ # MxPlatformRuby::Institution
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **String** | | [optional] |
8
+ | **medium_logo_url** | **String** | | [optional] |
9
+ | **name** | **String** | | [optional] |
10
+ | **small_logo_url** | **String** | | [optional] |
11
+ | **supports_account_identification** | **Boolean** | | [optional] |
12
+ | **supports_account_statement** | **Boolean** | | [optional] |
13
+ | **supports_account_verification** | **Boolean** | | [optional] |
14
+ | **supports_oauth** | **Boolean** | | [optional] |
15
+ | **supports_transaction_history** | **Boolean** | | [optional] |
16
+ | **url** | **String** | | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'mx-platform-ruby'
22
+
23
+ instance = MxPlatformRuby::Institution.new(
24
+ code: chase,
25
+ medium_logo_url: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png,
26
+ name: Chase Bank,
27
+ small_logo_url: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png,
28
+ supports_account_identification: true,
29
+ supports_account_statement: true,
30
+ supports_account_verification: true,
31
+ supports_oauth: true,
32
+ supports_transaction_history: true,
33
+ url: https://www.chase.com
34
+ )
35
+ ```
36
+
data/docs/InstitutionResponseBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::InstitutionResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **institution** | [**Institution**](Institution.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::InstitutionResponseBody.new(
15
+ institution: null
16
+ )
17
+ ```
18
+
data/docs/InstitutionsResponseBody.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::InstitutionsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **institutions** | [**Array<Institution>**](Institution.md) | | [optional] |
8
+ | **pagination** | [**Pagination**](Pagination.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::InstitutionsResponseBody.new(
16
+ institutions: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
data/docs/Member.md ADDED
@@ -0,0 +1,40 @@
1
+ # MxPlatformRuby::Member
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **aggregated_at** | **String** | | [optional] |
8
+ | **connection_status** | **String** | | [optional] |
9
+ | **guid** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **institution_code** | **String** | | [optional] |
12
+ | **is_being_aggregated** | **Boolean** | | [optional] |
13
+ | **is_oauth** | **Boolean** | | [optional] |
14
+ | **metadata** | **String** | | [optional] |
15
+ | **name** | **String** | | [optional] |
16
+ | **oauth_window_uri** | **String** | | [optional] |
17
+ | **successfully_aggregated_at** | **String** | | [optional] |
18
+ | **user_guid** | **String** | | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'mx-platform-ruby'
24
+
25
+ instance = MxPlatformRuby::Member.new(
26
+ aggregated_at: 2016-10-13T18:07:57.000Z,
27
+ connection_status: CONNECTED,
28
+ guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
29
+ id: unique_id,
30
+ institution_code: chase,
31
+ is_being_aggregated: false,
32
+ is_oauth: false,
33
+ metadata: \"credentials_last_refreshed_at\": \"2015-10-15\",
34
+ name: Chase Bank,
35
+ oauth_window_uri: int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/p8v7rxpxg3pdAsfgwxcrwxwhz3Zbygxfr6wAb931qv91hpb57k6bkr6t6m9djrfrfd467p8xkgqp6w7k1r9g8k8bfxqbfw2lq5tdwjq2sngAx76fm0jrw0dpmbtlkxchgjsw3r7r0hhq6A8sshqptfxql2rt123shfpkyhhpfvy67yvprbkb7lmlyrpwsd9yj0s22pmsyjhcw7d2q44d9fsxn5kfsmr2zqc79c2AxAx5gkjgbczf22A1sjx70t2pvnggzyh55s7bh62dd5wq7f1r4x90mcxn1tfhhrq5b09mjkt5hg66cjn700pcf6fgA42lbsp7v1pdch85mswycrp21c6j2sxffm14Asg3?skip_aggregation=false&referral_source=APP&ui_message_webview_url_scheme=myapp,
36
+ successfully_aggregated_at: 2016-10-13T17:57:38.000Z,
37
+ user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
38
+ )
39
+ ```
40
+
data/docs/MemberCreateRequest.md ADDED
@@ -0,0 +1,30 @@
1
+ # MxPlatformRuby::MemberCreateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **background_aggregation_is_disabled** | **Boolean** | | [optional] |
8
+ | **credentials** | [**Array<CredentialRequest>**](CredentialRequest.md) | | |
9
+ | **id** | **String** | | [optional] |
10
+ | **institution_code** | **String** | | |
11
+ | **is_oauth** | **Boolean** | | [optional] |
12
+ | **metadata** | **String** | | [optional] |
13
+ | **skip_aggregation** | **Boolean** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'mx-platform-ruby'
19
+
20
+ instance = MxPlatformRuby::MemberCreateRequest.new(
21
+ background_aggregation_is_disabled: false,
22
+ credentials: null,
23
+ id: unique_id,
24
+ institution_code: chase,
25
+ is_oauth: false,
26
+ metadata: \"credentials_last_refreshed_at\": \"2015-10-15\",
27
+ skip_aggregation: false
28
+ )
29
+ ```
30
+
data/docs/MemberCreateRequestBody.md ADDED
@@ -0,0 +1,22 @@
1
+ # MxPlatformRuby::MemberCreateRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **member** | [**MemberCreateRequest**](MemberCreateRequest.md) | | [optional] |
8
+ | **referral_source** | **String** | | [optional] |
9
+ | **ui_message_webview_url_scheme** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mx-platform-ruby'
15
+
16
+ instance = MxPlatformRuby::MemberCreateRequestBody.new(
17
+ member: null,
18
+ referral_source: APP,
19
+ ui_message_webview_url_scheme: mx
20
+ )
21
+ ```
22
+
data/docs/MemberResponseBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MemberResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **member** | [**Member**](Member.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MemberResponseBody.new(
15
+ member: null
16
+ )
17
+ ```
18
+
data/docs/MemberResumeRequest.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MemberResumeRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **challenges** | [**Array<CredentialRequest>**](CredentialRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MemberResumeRequest.new(
15
+ challenges: null
16
+ )
17
+ ```
18
+
data/docs/MemberResumeRequestBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MemberResumeRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **member** | [**MemberResumeRequest**](MemberResumeRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MemberResumeRequestBody.new(
15
+ member: null
16
+ )
17
+ ```
18
+
data/docs/MemberStatus.md ADDED
@@ -0,0 +1,34 @@
1
+ # MxPlatformRuby::MemberStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **aggregated_at** | **String** | | [optional] |
8
+ | **challenges** | [**Array<Challenge>**](Challenge.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::MemberStatus.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/MemberStatusResponseBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MemberStatusResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **member** | [**MemberStatus**](MemberStatus.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MemberStatusResponseBody.new(
15
+ member: null
16
+ )
17
+ ```
18
+
data/docs/MemberUpdateRequest.md ADDED
@@ -0,0 +1,26 @@
1
+ # MxPlatformRuby::MemberUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **background_aggregation_is_disabled** | **Boolean** | | [optional] |
8
+ | **credentials** | [**Array<CredentialRequest>**](CredentialRequest.md) | | [optional] |
9
+ | **id** | **String** | | [optional] |
10
+ | **metadata** | **String** | | [optional] |
11
+ | **skip_aggregation** | **Boolean** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mx-platform-ruby'
17
+
18
+ instance = MxPlatformRuby::MemberUpdateRequest.new(
19
+ background_aggregation_is_disabled: false,
20
+ credentials: null,
21
+ id: unique_id,
22
+ metadata: \"credentials_last_refreshed_at\": \"2015-10-15\",
23
+ skip_aggregation: false
24
+ )
25
+ ```
26
+
data/docs/MemberUpdateRequestBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MemberUpdateRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **member** | [**MemberUpdateRequest**](MemberUpdateRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MemberUpdateRequestBody.new(
15
+ member: null
16
+ )
17
+ ```
18
+