mx-platform-ruby 0.1.0 → 0.3.0

data/docs/InstitutionResponseBody.md

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

data/docs/InstitutionsResponseBody.md

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

data/docs/Member.md

@@ -0,0 +1,40 @@
+# MxPlatformRuby::Member
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aggregated_at** | **String** |  | [optional] |
+| **connection_status** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **institution_code** | **String** |  | [optional] |
+| **is_being_aggregated** | **Boolean** |  | [optional] |
+| **is_oauth** | **Boolean** |  | [optional] |
+| **metadata** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **oauth_window_uri** | **String** |  | [optional] |
+| **successfully_aggregated_at** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::Member.new(
+  aggregated_at: 2016-10-13T18:07:57.000Z,
+  connection_status: CONNECTED,
+  guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
+  id: unique_id,
+  institution_code: chase,
+  is_being_aggregated: false,
+  is_oauth: false,
+  metadata: \"credentials_last_refreshed_at\": \"2015-10-15\",
+  name: Chase Bank,
+  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,
+  successfully_aggregated_at: 2016-10-13T17:57:38.000Z,
+  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
+)
+```
+

data/docs/MemberCreateRequest.md

@@ -0,0 +1,30 @@
+# MxPlatformRuby::MemberCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **background_aggregation_is_disabled** | **Boolean** |  | [optional] |
+| **credentials** | [**Array<CredentialRequest>**](CredentialRequest.md) |  |  |
+| **id** | **String** |  | [optional] |
+| **institution_code** | **String** |  |  |
+| **is_oauth** | **Boolean** |  | [optional] |
+| **metadata** | **String** |  | [optional] |
+| **skip_aggregation** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MemberCreateRequest.new(
+  background_aggregation_is_disabled: false,
+  credentials: null,
+  id: unique_id,
+  institution_code: chase,
+  is_oauth: false,
+  metadata: \"credentials_last_refreshed_at\": \"2015-10-15\",
+  skip_aggregation: false
+)
+```
+

data/docs/MemberCreateRequestBody.md

@@ -0,0 +1,22 @@
+# MxPlatformRuby::MemberCreateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member** | [**MemberCreateRequest**](MemberCreateRequest.md) |  | [optional] |
+| **referral_source** | **String** |  | [optional] |
+| **ui_message_webview_url_scheme** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MemberCreateRequestBody.new(
+  member: null,
+  referral_source: APP,
+  ui_message_webview_url_scheme: mx
+)
+```
+

data/docs/MemberResponse.md

@@ -0,0 +1,40 @@
+# MxPlatformRuby::MemberResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aggregated_at** | **String** |  | [optional] |
+| **connection_status** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **institution_code** | **String** |  | [optional] |
+| **is_being_aggregated** | **Boolean** |  | [optional] |
+| **is_oauth** | **Boolean** |  | [optional] |
+| **metadata** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **oauth_window_uri** | **String** |  | [optional] |
+| **successfully_aggregated_at** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MemberResponse.new(
+  aggregated_at: 2016-10-13T18:07:57.000Z,
+  connection_status: CONNECTED,
+  guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
+  id: unique_id,
+  institution_code: chase,
+  is_being_aggregated: false,
+  is_oauth: false,
+  metadata: \"credentials_last_refreshed_at\": \"2015-10-15\",
+  name: Chase Bank,
+  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,
+  successfully_aggregated_at: 2016-10-13T17:57:38.000Z,
+  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
+)
+```
+

data/docs/MemberResponseBody.md

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

data/docs/MemberResumeRequest.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::MemberResumeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **challenges** | [**Array<CredentialRequest>**](CredentialRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MemberResumeRequest.new(
+  challenges: null
+)
+```
+

data/docs/MemberResumeRequestBody.md

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

data/docs/MemberStatus.md

@@ -0,0 +1,34 @@
+# MxPlatformRuby::MemberStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aggregated_at** | **String** |  | [optional] |
+| **challenges** | [**Array<Challenge>**](Challenge.md) |  | [optional] |
+| **connection_status** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **has_processed_accounts** | **Boolean** |  | [optional] |
+| **has_processed_transactions** | **Boolean** |  | [optional] |
+| **is_authenticated** | **Boolean** |  | [optional] |
+| **is_being_aggregated** | **Boolean** |  | [optional] |
+| **successfully_aggregated_at** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MemberStatus.new(
+  aggregated_at: 2016-10-13T18:07:57.000Z,
+  challenges: null,
+  connection_status: CONNECTED,
+  guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
+  has_processed_accounts: true,
+  has_processed_transactions: false,
+  is_authenticated: false,
+  is_being_aggregated: false,
+  successfully_aggregated_at: 2016-10-13T17:57:38.000Z
+)
+```
+

data/docs/MemberStatusResponse.md

@@ -0,0 +1,34 @@
+# MxPlatformRuby::MemberStatusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aggregated_at** | **String** |  | [optional] |
+| **challenges** | [**Array<ChallengeResponse>**](ChallengeResponse.md) |  | [optional] |
+| **connection_status** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **has_processed_accounts** | **Boolean** |  | [optional] |
+| **has_processed_transactions** | **Boolean** |  | [optional] |
+| **is_authenticated** | **Boolean** |  | [optional] |
+| **is_being_aggregated** | **Boolean** |  | [optional] |
+| **successfully_aggregated_at** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MemberStatusResponse.new(
+  aggregated_at: 2016-10-13T18:07:57.000Z,
+  challenges: null,
+  connection_status: CONNECTED,
+  guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
+  has_processed_accounts: true,
+  has_processed_transactions: false,
+  is_authenticated: false,
+  is_being_aggregated: false,
+  successfully_aggregated_at: 2016-10-13T17:57:38.000Z
+)
+```
+

data/docs/MemberStatusResponseBody.md

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

data/docs/MemberUpdateRequest.md

@@ -0,0 +1,26 @@
+# MxPlatformRuby::MemberUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **background_aggregation_is_disabled** | **Boolean** |  | [optional] |
+| **credentials** | [**Array<CredentialRequest>**](CredentialRequest.md) |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **metadata** | **String** |  | [optional] |
+| **skip_aggregation** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MemberUpdateRequest.new(
+  background_aggregation_is_disabled: false,
+  credentials: null,
+  id: unique_id,
+  metadata: \"credentials_last_refreshed_at\": \"2015-10-15\",
+  skip_aggregation: false
+)
+```
+

data/docs/MemberUpdateRequestBody.md

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

data/docs/MembersResponseBody.md

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

data/docs/Merchant.md

@@ -0,0 +1,28 @@
+# MxPlatformRuby::Merchant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **logo_url** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **website_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::Merchant.new(
+  created_at: 2017-04-20T19:30:12.000Z,
+  guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b,
+  logo_url: https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png,
+  name: Comcast,
+  updated_at: 2018-09-28T21:13:53.000Z,
+  website_url: https://www.xfinity.com
+)
+```
+

data/docs/MerchantResponse.md

@@ -0,0 +1,28 @@
+# MxPlatformRuby::MerchantResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **logo_url** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **website_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MerchantResponse.new(
+  created_at: 2017-04-20T19:30:12.000Z,
+  guid: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b,
+  logo_url: https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png,
+  name: Comcast,
+  updated_at: 2018-09-28T21:13:53.000Z,
+  website_url: https://www.xfinity.com
+)
+```
+