mx-platform-ruby 0.2.0 → 0.2.1

data/docs/TransactionResponseBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::TransactionResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction** | [**Transaction**](Transaction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionResponseBody.new(
+  transaction: null
+)
+```
+

data/docs/TransactionRule.md

@@ -0,0 +1,30 @@
+# MxPlatformRuby::TransactionRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_guid** | **String** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **match_description** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionRule.new(
+  category_guid: CAT-b1de2a04-db08-b6ed-f6fe-ca2f5b11c2d0,
+  created_at: 2018-10-02T22:00:50+00:00,
+  description: Wal-mart food storage,
+  guid: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3,
+  match_description: Wal-mart,
+  updated_at: 2018-10-02T23:54:40+00:00,
+  user_guid: USR-22fc3203-b3e6-8340-43db-8e50b2f56995
+)
+```
+

data/docs/TransactionRuleCreateRequest.md

@@ -0,0 +1,22 @@
+# MxPlatformRuby::TransactionRuleCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_guid** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **match_description** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionRuleCreateRequest.new(
+  category_guid: CAT-b1de2a04-db08-b6ed-f6fe-ca2f5b11c2d0,
+  description: Wal-mart food storage,
+  match_description: Wal-mart
+)
+```
+

data/docs/TransactionRuleCreateRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::TransactionRuleCreateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_rule** | [**TransactionRuleCreateRequest**](TransactionRuleCreateRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionRuleCreateRequestBody.new(
+  transaction_rule: null
+)
+```
+

data/docs/TransactionRuleResponseBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::TransactionRuleResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_rule** | [**TransactionRule**](TransactionRule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionRuleResponseBody.new(
+  transaction_rule: null
+)
+```
+

data/docs/TransactionRuleUpdateRequest.md

@@ -0,0 +1,22 @@
+# MxPlatformRuby::TransactionRuleUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_guid** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **match_description** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionRuleUpdateRequest.new(
+  category_guid: CAT-b1de2a04-db08-b6ed-f6fe-ca2f5b11c2d0,
+  description: Wal-mart food storage,
+  match_description: Wal-mart
+)
+```
+

data/docs/TransactionRuleUpdateRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::TransactionRuleUpdateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_rule** | [**TransactionRuleUpdateRequest**](TransactionRuleUpdateRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionRuleUpdateRequestBody.new(
+  transaction_rule: null
+)
+```
+

data/docs/TransactionRulesResponseBody.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::TransactionRulesResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**Pagination**](Pagination.md) |  | [optional] |
+| **transaction_rules** | [**Array<TransactionRule>**](TransactionRule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionRulesResponseBody.new(
+  pagination: null,
+  transaction_rules: null
+)
+```
+

data/docs/TransactionUpdateRequest.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::TransactionUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionUpdateRequest.new(
+  description: new description
+)
+```
+

data/docs/TransactionUpdateRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::TransactionUpdateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction** | [**TransactionUpdateRequest**](TransactionUpdateRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionUpdateRequestBody.new(
+  transaction: null
+)
+```
+

data/docs/TransactionsResponseBody.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::TransactionsResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**Pagination**](Pagination.md) |  | [optional] |
+| **transactions** | [**Array<Transaction>**](Transaction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::TransactionsResponseBody.new(
+  pagination: null,
+  transactions: null
+)
+```
+

data/docs/User.md

@@ -0,0 +1,26 @@
+# MxPlatformRuby::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **is_disabled** | **Boolean** |  | [optional] |
+| **metadata** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::User.new(
+  email: email@provider.com,
+  guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6,
+  id: My-Unique-ID,
+  is_disabled: false,
+  metadata: {\"first_name\": \"Steven\", \"last_name\": \"Universe\"}
+)
+```
+

data/docs/UserCreateRequest.md

@@ -0,0 +1,24 @@
+# MxPlatformRuby::UserCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **is_disabled** | **Boolean** |  | [optional] |
+| **metadata** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::UserCreateRequest.new(
+  email: email@provider.com,
+  id: My-Unique-ID,
+  is_disabled: false,
+  metadata: {\"first_name\": \"Steven\", \"last_name\": \"Universe\"}
+)
+```
+

data/docs/UserCreateRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::UserCreateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**UserCreateRequest**](UserCreateRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::UserCreateRequestBody.new(
+  user: null
+)
+```
+

data/docs/UserResponseBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::UserResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**User**](User.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::UserResponseBody.new(
+  user: null
+)
+```
+

data/docs/UserUpdateRequest.md

@@ -0,0 +1,24 @@
+# MxPlatformRuby::UserUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **is_disabled** | **Boolean** |  | [optional] |
+| **metadata** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::UserUpdateRequest.new(
+  email: email@provider.com,
+  id: My-Unique-ID,
+  is_disabled: false,
+  metadata: {\"first_name\": \"Steven\", \"last_name\": \"Universe\"}
+)
+```
+

data/docs/UserUpdateRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::UserUpdateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**UserUpdateRequest**](UserUpdateRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::UserUpdateRequestBody.new(
+  user: null
+)
+```
+

data/docs/UsersResponseBody.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::UsersResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**Pagination**](Pagination.md) |  | [optional] |
+| **users** | [**Array<User>**](User.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::UsersResponseBody.new(
+  pagination: null,
+  users: null
+)
+```
+

data/docs/Widget.md

@@ -0,0 +1,22 @@
+# MxPlatformRuby::Widget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **user_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::Widget.new(
+  type: connect_widget,
+  url: https://int-widgets.moneydesktop.com/md/connect/yxcdk7f1nb99jwApp34lA24m0AZ8rzprgmw17gm8z8h2AzjyAnd1rj42qfv42r3xnn07Amfwlg3j09hwp8bkq8tc5z21j33xjggmp2qtlpkz2v4gywfhfn31l44tx2w91bfc2thc58j4syqp0hgxcyvA4g7754hk7gjc56kt7tc36s45mmkdz2jqqqydspytmtr3dAb9jh6fkb24f3zkfpdjj0v77f0vmrtzvzxkmxz7dklsq8gd0gstkbhlw5bgpgc3m9mAtpAcr2w15gwy5xc4blgxppl42Avnm63291z3cyp0wm3lqgmvgzdAddct423gAdqxdlfx5d4mvc0ck2gt7ktqgks4vxq1pAy5,
+  user_id: U-jeff-201709221210
+)
+```
+

data/docs/WidgetRequest.md

@@ -0,0 +1,42 @@
+# MxPlatformRuby::WidgetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **color_scheme** | **String** |  | [optional] |
+| **current_institution_code** | **String** |  | [optional] |
+| **current_institution_guid** | **String** |  | [optional] |
+| **current_member_guid** | **String** |  | [optional] |
+| **disable_institution_search** | **Boolean** |  | [optional] |
+| **include_transactions** | **Boolean** |  | [optional] |
+| **is_mobile_webview** | **Boolean** |  | [optional] |
+| **mode** | **String** |  | [optional] |
+| **ui_message_version** | **Integer** |  | [optional] |
+| **ui_message_webview_url_scheme** | **String** |  | [optional] |
+| **update_credentials** | **Boolean** |  | [optional] |
+| **wait_for_full_aggregation** | **Boolean** |  | [optional] |
+| **widget_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::WidgetRequest.new(
+  color_scheme: light,
+  current_institution_code: chase,
+  current_institution_guid: INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9,
+  current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
+  disable_institution_search: false,
+  include_transactions: true,
+  is_mobile_webview: true,
+  mode: aggregation,
+  ui_message_version: 4,
+  ui_message_webview_url_scheme: mx,
+  update_credentials: false,
+  wait_for_full_aggregation: false,
+  widget_type: connect_widget
+)
+```
+