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/CategoryResponseBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::CategoryResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category** | [**Category**](Category.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::CategoryResponseBody.new(
15
+ category: null
16
+ )
17
+ ```
18
+
data/docs/CategoryUpdateRequest.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::CategoryUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **metadata** | **String** | | [optional] |
8
+ | **name** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::CategoryUpdateRequest.new(
16
+ metadata: some metadata,
17
+ name: Web shopping
18
+ )
19
+ ```
20
+
data/docs/CategoryUpdateRequestBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::CategoryUpdateRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category** | [**CategoryUpdateRequest**](CategoryUpdateRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::CategoryUpdateRequestBody.new(
15
+ category: null
16
+ )
17
+ ```
18
+
data/docs/Challenge.md ADDED
@@ -0,0 +1,30 @@
1
+ # MxPlatformRuby::Challenge
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **field_name** | **String** | | [optional] |
8
+ | **guid** | **String** | | [optional] |
9
+ | **image_data** | **String** | | [optional] |
10
+ | **image_options** | [**Array<ChallengeImageOptions>**](ChallengeImageOptions.md) | | [optional] |
11
+ | **label** | **String** | | [optional] |
12
+ | **options** | [**Array<ChallengeOptions>**](ChallengeOptions.md) | | [optional] |
13
+ | **type** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'mx-platform-ruby'
19
+
20
+ instance = MxPlatformRuby::Challenge.new(
21
+ field_name: Who is this guy?,
22
+ guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5,
23
+ image_data: Who is this guy?,
24
+ image_options: null,
25
+ label: Who is this guy?,
26
+ options: null,
27
+ type: IMAGE_DATA
28
+ )
29
+ ```
30
+
data/docs/ChallengeImageOptions.md ADDED
@@ -0,0 +1,22 @@
1
+ # MxPlatformRuby::ChallengeImageOptions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data_uri** | **String** | | [optional] |
8
+ | **label** | **String** | | [optional] |
9
+ | **value** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mx-platform-ruby'
15
+
16
+ instance = MxPlatformRuby::ChallengeImageOptions.new(
17
+ data_uri: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...,
18
+ label: IMAGE_1,
19
+ value: image_data
20
+ )
21
+ ```
22
+
data/docs/ChallengeOptions.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::ChallengeOptions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **label** | **String** | | [optional] |
8
+ | **value** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::ChallengeOptions.new(
16
+ label: IMAGE_1,
17
+ value: image_data
18
+ )
19
+ ```
20
+
data/docs/ChallengesResponseBody.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::ChallengesResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **challenges** | [**Array<Challenge>**](Challenge.md) | | [optional] |
8
+ | **pagination** | [**Pagination**](Pagination.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::ChallengesResponseBody.new(
16
+ challenges: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
data/docs/ConnectWidget.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::ConnectWidget
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **connect_widget_url** | **String** | | [optional] |
8
+ | **guid** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::ConnectWidget.new(
16
+ connect_widget_url: https://int-widgets.moneydesktop.com/md/connect/jb1rA14m85tw2lyvpgfx4gc6d3Z8z8Ayb8,
17
+ guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
18
+ )
19
+ ```
20
+
data/docs/ConnectWidgetRequest.md ADDED
@@ -0,0 +1,38 @@
1
+ # MxPlatformRuby::ConnectWidgetRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **color_scheme** | **String** | | [optional] |
8
+ | **current_institution_code** | **String** | | [optional] |
9
+ | **current_member_guid** | **String** | | [optional] |
10
+ | **disable_institution_search** | **Boolean** | | [optional] |
11
+ | **include_transactions** | **Boolean** | | [optional] |
12
+ | **is_mobile_webview** | **Boolean** | | [optional] |
13
+ | **mode** | **String** | | [optional] |
14
+ | **ui_message_version** | **Integer** | | [optional] |
15
+ | **ui_message_webview_url_scheme** | **String** | | [optional] |
16
+ | **update_credentials** | **Boolean** | | [optional] |
17
+ | **wait_for_full_aggregation** | **Boolean** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'mx-platform-ruby'
23
+
24
+ instance = MxPlatformRuby::ConnectWidgetRequest.new(
25
+ color_scheme: light,
26
+ current_institution_code: chase,
27
+ current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
28
+ disable_institution_search: false,
29
+ include_transactions: true,
30
+ is_mobile_webview: true,
31
+ mode: aggregation,
32
+ ui_message_version: 4,
33
+ ui_message_webview_url_scheme: mx,
34
+ update_credentials: false,
35
+ wait_for_full_aggregation: false
36
+ )
37
+ ```
38
+
data/docs/ConnectWidgetRequestBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::ConnectWidgetRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **config** | [**ConnectWidgetRequest**](ConnectWidgetRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::ConnectWidgetRequestBody.new(
15
+ config: null
16
+ )
17
+ ```
18
+
data/docs/ConnectWidgetResponseBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::ConnectWidgetResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **user** | [**ConnectWidget**](ConnectWidget.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::ConnectWidgetResponseBody.new(
15
+ user: null
16
+ )
17
+ ```
18
+
data/docs/Credential.md ADDED
@@ -0,0 +1,26 @@
1
+ # MxPlatformRuby::Credential
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **display_order** | **Integer** | | [optional] |
8
+ | **field_name** | **String** | | [optional] |
9
+ | **field_type** | **String** | | [optional] |
10
+ | **guid** | **String** | | [optional] |
11
+ | **label** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mx-platform-ruby'
17
+
18
+ instance = MxPlatformRuby::Credential.new(
19
+ display_order: 1,
20
+ field_name: LOGIN,
21
+ field_type: TEXT,
22
+ guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da,
23
+ label: Username
24
+ )
25
+ ```
26
+
data/docs/CredentialRequest.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::CredentialRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **guid** | **String** | | [optional] |
8
+ | **value** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::CredentialRequest.new(
16
+ guid: CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f,
17
+ value: password
18
+ )
19
+ ```
20
+
data/docs/CredentialsResponseBody.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::CredentialsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **credentials** | [**Array<Credential>**](Credential.md) | | [optional] |
8
+ | **pagination** | [**Pagination**](Pagination.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::CredentialsResponseBody.new(
16
+ credentials: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
data/docs/EnhanceTransaction.md ADDED
@@ -0,0 +1,48 @@
1
+ # MxPlatformRuby::EnhanceTransaction
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Float** | | [optional] |
8
+ | **category** | **String** | | [optional] |
9
+ | **description** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+ | **is_bill_pay** | **Boolean** | | [optional] |
12
+ | **is_direct_deposit** | **Boolean** | | [optional] |
13
+ | **is_expense** | **Boolean** | | [optional] |
14
+ | **is_fee** | **Boolean** | | [optional] |
15
+ | **is_income** | **Boolean** | | [optional] |
16
+ | **is_international** | **Boolean** | | [optional] |
17
+ | **is_overdraft_fee** | **Boolean** | | [optional] |
18
+ | **is_payroll_advance** | **Boolean** | | [optional] |
19
+ | **merchant_category_code** | **Integer** | | [optional] |
20
+ | **merchant_guid** | **String** | | [optional] |
21
+ | **original_description** | **String** | | [optional] |
22
+ | **type** | **String** | | [optional] |
23
+
24
+ ## Example
25
+
26
+ ```ruby
27
+ require 'mx-platform-ruby'
28
+
29
+ instance = MxPlatformRuby::EnhanceTransaction.new(
30
+ amount: 21.33,
31
+ category: Fast Food,
32
+ description: IN-N-OUT BURGER,
33
+ id: ID-123,
34
+ is_bill_pay: false,
35
+ is_direct_deposit: false,
36
+ is_expense: false,
37
+ is_fee: false,
38
+ is_income: false,
39
+ is_international: false,
40
+ is_overdraft_fee: false,
41
+ is_payroll_advance: false,
42
+ merchant_category_code: 5411,
43
+ merchant_guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b,
44
+ original_description: IN-N-OUT BURGER,
45
+ type: DEBIT
46
+ )
47
+ ```
48
+
data/docs/EnhanceTransactionsRequest.md ADDED
@@ -0,0 +1,26 @@
1
+ # MxPlatformRuby::EnhanceTransactionsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Float** | | [optional] |
8
+ | **description** | **String** | | |
9
+ | **id** | **String** | | |
10
+ | **merchant_category_code** | **Integer** | | [optional] |
11
+ | **type** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mx-platform-ruby'
17
+
18
+ instance = MxPlatformRuby::EnhanceTransactionsRequest.new(
19
+ amount: 21.33,
20
+ description: IN-N-OUT BURGER,
21
+ id: ID-123,
22
+ merchant_category_code: 123,
23
+ type: DEBIT
24
+ )
25
+ ```
26
+
data/docs/EnhanceTransactionsRequestBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::EnhanceTransactionsRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transactions** | [**Array<EnhanceTransactionsRequest>**](EnhanceTransactionsRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::EnhanceTransactionsRequestBody.new(
15
+ transactions: null
16
+ )
17
+ ```
18
+
data/docs/EnhanceTransactionsResponseBody.md ADDED
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::EnhanceTransactionsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transactions** | [**Array<EnhanceTransaction>**](EnhanceTransaction.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::EnhanceTransactionsResponseBody.new(
15
+ transactions: null
16
+ )
17
+ ```
18
+