mx-platform-ruby 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1d1c0ba96315b71568adedc3e2c8792cd14e6708c39b79702eb8e3ff356ab2c
-  data.tar.gz: cd1fc779370770e9203b7ae962fcb171ef06ad11fcbbd133613cba6f4a6a88c3
+  metadata.gz: 85664400840d2c897fb49f8b81aeb986c85b29fc15607de4694c42754247189f
+  data.tar.gz: b415ccc5a8049f379db22a7a7c82a95ca84216a597fd3bc559a7b25c411784a5
 SHA512:
-  metadata.gz: 022ea04e46532897902abda4e827ebebc7ee5748251a8865cf84f14101e07691e1e7d2b7d535a1fbbe3192b2d2dda4af87931c1b76d0f0a9d9d74771cfd16fcb
-  data.tar.gz: 78fb046f6eb457abedba54dae28b81e0b9eaa51319bfd5b8bd2e24afa148f8c3a0ff6e7a18a531345970815d1b17135cb988b0211ce23f8db7e187d7bf7c89ba
+  metadata.gz: f20ad72b1c7a576f199356f6d8033df00bb31af9c9b9b7f094a5df2905a04ad8a77a688774a8e2d84de01848f8491d9412a1e54fa2e210b8af20a751896128e8
+  data.tar.gz: c7bf65d460c4c1ade893eeb053b187ee159fb1f4e888d3932f79d2d6ed1d354ae5b87a466961f853c358ab5b4b411a2a98b120afd3fc80698a7f199dbbfcdd15

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (1.4.0)
+    mx-platform-ruby (1.6.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
       marcel
@@ -19,7 +19,7 @@ GEM
       base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-multipart (1.1.0)
+    faraday-multipart (1.1.1)
       multipart-post (~> 2.0)
     faraday-net_http (3.0.2)
     jaro_winkler (1.5.6)
@@ -46,7 +46,7 @@ GEM
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.4)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)

data/docs/AccountResponse.md

@@ -5,61 +5,125 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **account_number** | **String** |  | [optional] |
+| **account_number_set_by** | **Integer** |  | [optional] |
 | **account_ownership** | **String** |  | [optional] |
 | **annuity_policy_to_date** | **String** |  | [optional] |
 | **annuity_provider** | **String** |  | [optional] |
-| **annuity_term_year** | **Float** |  | [optional] |
+| **annuity_term_year** | **Integer** |  | [optional] |
 | **apr** | **Float** |  | [optional] |
+| **apr_set_by** | **Integer** |  | [optional] |
 | **apy** | **Float** |  | [optional] |
+| **apy_set_by** | **Integer** |  | [optional] |
 | **available_balance** | **Float** |  | [optional] |
+| **available_balance_set_by** | **Integer** |  | [optional] |
 | **available_credit** | **Float** |  | [optional] |
+| **available_credit_set_by** | **Integer** |  | [optional] |
 | **balance** | **Float** |  | [optional] |
+| **balance_set_by** | **Integer** |  | [optional] |
+| **calculated_apr** | **Float** |  | [optional] |
 | **cash_balance** | **Float** |  | [optional] |
+| **cash_balance_set_by** | **Integer** |  | [optional] |
 | **cash_surrender_value** | **Float** |  | [optional] |
+| **cash_surrender_value_set_by** | **Integer** |  | [optional] |
 | **created_at** | **String** |  | [optional] |
 | **credit_limit** | **Float** |  | [optional] |
+| **credit_limit_set_by** | **Integer** |  | [optional] |
 | **currency_code** | **String** |  | [optional] |
+| **currency_code_set_by** | **Integer** |  | [optional] |
 | **day_payment_is_due** | **Integer** |  | [optional] |
+| **day_payment_is_due_set_by** | **Integer** |  | [optional] |
 | **death_benefit** | **Integer** |  | [optional] |
+| **death_benefit_set_by** | **Integer** |  | [optional] |
 | **federal_insurance_status** | **String** |  | [optional] |
+| **feed_account_number** | **String** |  | [optional] |
+| **feed_account_subtype** | **Integer** |  | [optional] |
+| **feed_account_type** | **Integer** |  | [optional] |
+| **feed_apr** | **Float** |  | [optional] |
+| **feed_apy** | **Float** |  | [optional] |
+| **feed_available_balance** | **Float** |  | [optional] |
+| **feed_balance** | **Float** |  | [optional] |
+| **feed_cash_balance** | **Float** |  | [optional] |
+| **feed_cash_surrender_value** | **Float** |  | [optional] |
+| **feed_credit_limit** | **Float** |  | [optional] |
+| **feed_currency_code** | **String** |  | [optional] |
+| **feed_day_payment_is_due** | **Integer** |  | [optional] |
+| **feed_death_benefit** | **Integer** |  | [optional] |
+| **feed_holdings_value** | **Float** |  | [optional] |
+| **feed_interest_rate** | **Float** |  | [optional] |
+| **feed_is_closed** | **Boolean** |  | [optional] |
+| **feed_last_payment** | **Float** |  | [optional] |
+| **feed_last_payment_at** | **String** |  | [optional] |
+| **feed_loan_amount** | **Float** |  | [optional] |
+| **feed_matures_on** | **String** |  | [optional] |
+| **feed_minimum_balance** | **Float** |  | [optional] |
+| **feed_minimum_payment** | **Float** |  | [optional] |
+| **feed_name** | **String** |  | [optional] |
+| **feed_nickname** | **String** |  | [optional] |
+| **feed_original_balance** | **Float** |  | [optional] |
+| **feed_payment_due_at** | **String** |  | [optional] |
+| **feed_payoff_balance** | **Float** |  | [optional] |
+| **feed_routing_number** | **String** |  | [optional] |
+| **feed_started_on** | **String** |  | [optional] |
+| **feed_statement_balance** | **Float** |  | [optional] |
+| **feed_total_account_value** | **Float** |  | [optional] |
 | **guid** | **String** |  | [optional] |
 | **holdings_value** | **Float** |  | [optional] |
+| **holdings_value_set_by** | **Integer** |  | [optional] |
 | **id** | **String** |  | [optional] |
 | **imported_at** | **String** |  | [optional] |
 | **institution_code** | **String** |  | [optional] |
+| **institution_guid** | **String** |  | [optional] |
 | **insured_name** | **String** |  | [optional] |
 | **interest_rate** | **Float** |  | [optional] |
+| **interest_rate_set_by** | **Integer** |  | [optional] |
 | **is_closed** | **Boolean** |  | [optional] |
+| **is_closed_set_by** | **Integer** |  | [optional] |
 | **is_hidden** | **Boolean** |  | [optional] |
 | **is_manual** | **Boolean** |  | [optional] |
 | **last_payment** | **Float** |  | [optional] |
+| **last_payment_set_by** | **Integer** |  | [optional] |
 | **last_payment_at** | **String** |  | [optional] |
+| **last_payment_at_set_by** | **Integer** |  | [optional] |
 | **loan_amount** | **Float** |  | [optional] |
+| **loan_amount_set_by** | **Integer** |  | [optional] |
 | **margin_balance** | **Float** |  | [optional] |
 | **matures_on** | **String** |  | [optional] |
+| **matures_on_set_by** | **Integer** |  | [optional] |
 | **member_guid** | **String** |  | [optional] |
 | **member_id** | **String** |  | [optional] |
 | **member_is_managed_by_user** | **Boolean** |  | [optional] |
 | **metadata** | **String** |  | [optional] |
 | **minimum_balance** | **Float** |  | [optional] |
+| **minimum_balance_set_by** | **Integer** |  | [optional] |
 | **minimum_payment** | **Float** |  | [optional] |
+| **minimum_payment_set_by** | **Integer** |  | [optional] |
 | **name** | **String** |  | [optional] |
+| **name_set_by** | **Integer** |  | [optional] |
 | **nickname** | **String** |  | [optional] |
+| **nickname_set_by** | **Integer** |  | [optional] |
 | **original_balance** | **Float** |  | [optional] |
+| **original_balance_set_by** | **Integer** |  | [optional] |
 | **pay_out_amount** | **Float** |  | [optional] |
 | **payment_due_at** | **String** |  | [optional] |
+| **payment_due_at_set_by** | **Integer** |  | [optional] |
 | **payoff_balance** | **Float** |  | [optional] |
+| **payoff_balance_set_by** | **Integer** |  | [optional] |
 | **premium_amount** | **Float** |  | [optional] |
 | **property_type** | **String** |  | [optional] |
 | **routing_number** | **String** |  | [optional] |
 | **started_on** | **String** |  | [optional] |
+| **started_on_set_by** | **Integer** |  | [optional] |
 | **statement_balance** | **Float** |  | [optional] |
+| **statement_balance_set_by** | **Integer** |  | [optional] |
 | **subtype** | **String** |  | [optional] |
+| **subtype_set_by** | **Integer** |  | [optional] |
 | **today_ugl_amount** | **Float** |  | [optional] |
 | **today_ugl_percentage** | **Float** |  | [optional] |
 | **total_account_value** | **Float** |  | [optional] |
+| **total_account_value_set_by** | **Integer** |  | [optional] |
 | **total_account_value_ugl** | **Float** |  | [optional] |
 | **type** | **String** |  | [optional] |
+| **type_set_by** | **Integer** |  | [optional] |
 | **updated_at** | **String** |  | [optional] |
 | **user_guid** | **String** |  | [optional] |
 | **user_id** | **String** |  | [optional] |
@@ -71,61 +135,125 @@ require 'mx-platform-ruby'
 
 instance = MxPlatformRuby::AccountResponse.new(
   account_number: 5366,
+  account_number_set_by: 1,
   account_ownership: INDIVIDUAL,
   annuity_policy_to_date: 2016-10-13T17:57:37.000Z,
   annuity_provider: Metlife,
   annuity_term_year: 2048,
   apr: 1.0,
+  apr_set_by: 1,
   apy: 1.0,
+  apy_set_by: 1,
   available_balance: 1000.0,
+  available_balance_set_by: 1,
   available_credit: 1000.0,
+  available_credit_set_by: 1,
   balance: 10000.0,
+  balance_set_by: 1,
+  calculated_apr: 21.66409,
   cash_balance: 1000.0,
+  cash_balance_set_by: 1,
   cash_surrender_value: 1000.0,
+  cash_surrender_value_set_by: 1,
   created_at: 2023-07-25T17:14:46Z,
   credit_limit: 100.0,
+  credit_limit_set_by: 1,
   currency_code: USD,
+  currency_code_set_by: 1,
   day_payment_is_due: 20,
+  day_payment_is_due_set_by: 1,
   death_benefit: 1000,
+  death_benefit_set_by: 1,
   federal_insurance_status: INSURED,
+  feed_account_number: 5366,
+  feed_account_subtype: 1,
+  feed_account_type: 1,
+  feed_apr: 1.0,
+  feed_apy: 1.0,
+  feed_available_balance: 1000.0,
+  feed_balance: 1000.0,
+  feed_cash_balance: 1000.0,
+  feed_cash_surrender_value: 1000.0,
+  feed_credit_limit: 100.0,
+  feed_currency_code: USD,
+  feed_day_payment_is_due: 20,
+  feed_death_benefit: 1000,
+  feed_holdings_value: 1000.0,
+  feed_interest_rate: 1.0,
+  feed_is_closed: false,
+  feed_last_payment: 100.0,
+  feed_last_payment_at: 2023-07-25T17:14:46Z,
+  feed_loan_amount: 1000.0,
+  feed_matures_on: 2015-10-13T17:57:37.000Z,
+  feed_minimum_balance: 100.0,
+  feed_minimum_payment: 10.0,
+  feed_name: Test account 2,
+  feed_nickname: My Checking,
+  feed_original_balance: 10.0,
+  feed_payment_due_at: 2025-02-13T17:57:37.000Z,
+  feed_payoff_balance: 10.0,
+  feed_routing_number: 68899990000000,
+  feed_started_on: 2020-10-13T17:57:37.000Z,
+  feed_statement_balance: 100.0,
+  feed_total_account_value: 100.0,
   guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
   holdings_value: 1000.0,
+  holdings_value_set_by: 1,
   id: 1040434698,
   imported_at: 2015-10-13T17:57:37.000Z,
   institution_code: 3af3685e-05d9-7060-359f-008d0755e993,
+  institution_guid: INS-12a3b-4c5dd6-1349-008d0755e993,
   insured_name: Tommy Shelby,
   interest_rate: 1.0,
+  interest_rate_set_by: 1,
   is_closed: false,
+  is_closed_set_by: 1,
   is_hidden: false,
   is_manual: false,
   last_payment: 100.0,
+  last_payment_set_by: 1,
   last_payment_at: 2023-07-25T17:14:46Z,
+  last_payment_at_set_by: 1,
   loan_amount: 1000.0,
+  loan_amount_set_by: 1,
   margin_balance: 1000.0,
   matures_on: 2015-10-13T17:57:37.000Z,
+  matures_on_set_by: 1,
   member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
   member_id: member123,
   member_is_managed_by_user: false,
   metadata: some metadata,
   minimum_balance: 100.0,
+  minimum_balance_set_by: 1,
   minimum_payment: 10.0,
+  minimum_payment_set_by: 1,
   name: Test account 2,
+  name_set_by: 1,
   nickname: My Checking,
+  nickname_set_by: 1,
   original_balance: 10.0,
+  original_balance_set_by: 1,
   pay_out_amount: 10.0,
   payment_due_at: 2015-10-13T17:57:37.000Z,
+  payment_due_at_set_by: 1,
   payoff_balance: 10.0,
-  premium_amount: 1.0,
+  payoff_balance_set_by: 1,
+  premium_amount: 3900,
   property_type: VEHICLE,
   routing_number: 68899990000000,
   started_on: 2015-10-13T17:57:37.000Z,
-  statement_balance: 100.1,
+  started_on_set_by: 1,
+  statement_balance: 1000.5,
+  statement_balance_set_by: 1,
   subtype: NONE,
+  subtype_set_by: 1,
   today_ugl_amount: 1000.5,
   today_ugl_percentage: 6.9,
   total_account_value: 1.0,
-  total_account_value_ugl: 1.1,
+  total_account_value_set_by: 1,
+  total_account_value_ugl: 1.0,
   type: SAVINGS,
+  type_set_by: 1,
   updated_at: 2016-10-13T18:08:00.000Z,
   user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54,
   user_id: user123

data/docs/MxPlatformApi.md

@@ -115,7 +115,7 @@ All URIs are relative to *https://api.mx.com*
 
 ## aggregate_member
 
-> <MemberResponseBody> aggregate_member(member_guid, user_guid)
+> <MemberResponseBody> aggregate_member(member_guid, user_guid, opts)
 
 Aggregate member
 
@@ -136,10 +136,14 @@ end
 api_instance = MxPlatformRuby::MxPlatformApi.new
 member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
 user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+opts = {
+  include_holdings: false, # Boolean | When set to `false`, the aggregation will not gather holdings data. Defaults to `true`.
+  include_transactions: false # Boolean | When set to `false`, the aggregation will not gather transactions data. Defaults to `true`.
+}
 
 begin
   # Aggregate member
-  result = api_instance.aggregate_member(member_guid, user_guid)
+  result = api_instance.aggregate_member(member_guid, user_guid, opts)
   p result
 rescue MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->aggregate_member: #{e}"
@@ -150,12 +154,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<MemberResponseBody>, Integer, Hash)> aggregate_member_with_http_info(member_guid, user_guid)
+> <Array(<MemberResponseBody>, Integer, Hash)> aggregate_member_with_http_info(member_guid, user_guid, opts)
 
 ```ruby
 begin
   # Aggregate member
-  data, status_code, headers = api_instance.aggregate_member_with_http_info(member_guid, user_guid)
+  data, status_code, headers = api_instance.aggregate_member_with_http_info(member_guid, user_guid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <MemberResponseBody>
@@ -170,6 +174,8 @@ end
 | ---- | ---- | ----------- | ----- |
 | **member_guid** | **String** | The unique id for a &#x60;member&#x60;. |  |
 | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+| **include_holdings** | **Boolean** | When set to &#x60;false&#x60;, the aggregation will not gather holdings data. Defaults to &#x60;true&#x60;. | [optional] |
+| **include_transactions** | **Boolean** | When set to &#x60;false&#x60;, the aggregation will not gather transactions data. Defaults to &#x60;true&#x60;. | [optional] |
 
 ### Return type
 

data/lib/mx-platform-ruby/api/mx_platform_api.rb

@@ -24,6 +24,8 @@ module MxPlatformRuby
     # @param member_guid [String] The unique id for a `member`.
     # @param user_guid [String] The unique id for a `user`.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_holdings When set to `false`, the aggregation will not gather holdings data. Defaults to `true`.
+    # @option opts [Boolean] :include_transactions When set to `false`, the aggregation will not gather transactions data. Defaults to `true`.
     # @return [MemberResponseBody]
     def aggregate_member(member_guid, user_guid, opts = {})
       data, _status_code, _headers = aggregate_member_with_http_info(member_guid, user_guid, opts)
@@ -35,6 +37,8 @@ module MxPlatformRuby
     # @param member_guid [String] The unique id for a `member`.
     # @param user_guid [String] The unique id for a `user`.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_holdings When set to `false`, the aggregation will not gather holdings data. Defaults to `true`.
+    # @option opts [Boolean] :include_transactions When set to `false`, the aggregation will not gather transactions data. Defaults to `true`.
     # @return [Array<(MemberResponseBody, Integer, Hash)>] MemberResponseBody data, response status code and response headers
     def aggregate_member_with_http_info(member_guid, user_guid, opts = {})
       if @api_client.config.debugging
@@ -53,6 +57,8 @@ module MxPlatformRuby
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'include_holdings'] = opts[:'include_holdings'] if !opts[:'include_holdings'].nil?
+      query_params[:'include_transactions'] = opts[:'include_transactions'] if !opts[:'include_transactions'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}