mx-platform-ruby 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b936e81b35f1be7e58438403e10793c9288707645830a58687b31297198211f0
-  data.tar.gz: 4e6242f67b061afbb56ae5dd269f312cfda00ca00e4109abb3b2dfa7484a1b1d
+  metadata.gz: 3b6e332d0412f293d118fba4562f2bf1ecf50946e919302aff739e89f892a77b
+  data.tar.gz: c9f86aa585e0b4725c85c2b2612ca068b18d53fb32ae52df1f6a73269832d9fd
 SHA512:
-  metadata.gz: 387337d17b600182887959e099bb19a10412c5d5c26146fdb0367ba61ea8ffc2c53d45ae3e860f590310be7246323b8edda3c2cdd7f8fde462a21933dd52109e
-  data.tar.gz: 8e026569511052e4404604a3483aa7636991d642d23835db35ebb72abe08ded9db655f8c0a09e6c10e8d3cc20dfd4e5f4e17777c489dc9ab04cec41c12bcb16e
+  metadata.gz: 29a20826335615c90bf6e14d59dd64b301c064cd305dfe3e783a5e44ff6df5bbe4d7f094c4502da7722f9a05ff291ebc060c3abfdeb3684228c270012d5dc3b8
+  data.tar.gz: 60ef53441a91a70248d36677ee73839ecc22949b300186810da95b8d8d0a9b6ce59afd14038593b3bfc7e71d4d0143e3b03445abca3137d1583f6e6ba60a6294

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.17.0)
+    mx-platform-ruby (0.18.0)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -34,12 +34,13 @@ GEM
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
-    jaro_winkler (1.5.4)
+    jaro_winkler (1.5.6)
     method_source (1.0.0)
     multipart-post (2.3.0)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -48,6 +49,7 @@ GEM
       pry (~> 0.13.0)
     psych (5.1.0)
       stringio
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rspec (3.12.0)
@@ -59,10 +61,10 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -87,4 +89,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.4.12
+   2.4.16

data/docs/AccountCreateRequest.md

@@ -0,0 +1,78 @@
+# MxPlatformRuby::AccountCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_number** | **String** |  | [optional] |
+| **apr** | **Float** |  | [optional] |
+| **apy** | **Float** |  | [optional] |
+| **available_balance** | **Float** |  | [optional] |
+| **available_credit** | **Float** |  | [optional] |
+| **balance** | **Float** |  |  |
+| **cash_surrender_value** | **Float** |  | [optional] |
+| **credit_limit** | **Float** |  | [optional] |
+| **currency_code** | **String** |  | [optional] |
+| **day_payment_is_due** | **Integer** |  | [optional] |
+| **death_benefit** | **Integer** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **interest_rate** | **Float** |  | [optional] |
+| **is_closed** | **Boolean** |  | [optional] |
+| **is_hidden** | **Boolean** |  | [optional] |
+| **last_payment** | **Float** |  | [optional] |
+| **last_payment_at** | **String** |  | [optional] |
+| **loan_amount** | **Float** |  | [optional] |
+| **matures_on** | **String** |  | [optional] |
+| **metadata** | **String** |  | [optional] |
+| **minimum_balance** | **Float** |  | [optional] |
+| **minimum_payment** | **Float** |  | [optional] |
+| **name** | **String** |  |  |
+| **nickname** | **String** |  | [optional] |
+| **original_balance** | **Float** |  | [optional] |
+| **payment_due_at** | **String** |  | [optional] |
+| **payoff_balance** | **Float** |  | [optional] |
+| **routing_number** | **String** |  | [optional] |
+| **started_on** | **String** |  | [optional] |
+| **subtype** | **String** |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::AccountCreateRequest.new(
+  account_number: 5366,
+  apr: 1.0,
+  apy: 1.0,
+  available_balance: 1000.0,
+  available_credit: 1000.0,
+  balance: 1000.0,
+  cash_surrender_value: 1000.0,
+  credit_limit: 100.0,
+  currency_code: USD,
+  day_payment_is_due: 20,
+  death_benefit: 1000,
+  id: 1040434698,
+  interest_rate: 1.0,
+  is_closed: false,
+  is_hidden: false,
+  last_payment: 100.0,
+  last_payment_at: 2015-10-13T17:57:37.000Z,
+  loan_amount: 1000.0,
+  matures_on: 2015-10-13T17:57:37.000Z,
+  metadata: some metadata,
+  minimum_balance: 100.0,
+  minimum_payment: 10.0,
+  name: Test account 2,
+  nickname: Swiss Account,
+  original_balance: 10.0,
+  payment_due_at: 2015-10-13T17:57:37.000Z,
+  payoff_balance: 10.0,
+  routing_number: 68899990000000,
+  started_on: 2015-10-13T17:57:37.000Z,
+  subtype: NONE,
+  type: SAVINGS
+)
+```
+

data/docs/AccountCreateRequestBody.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::AccountCreateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **skip_webhook** | **Boolean** |  | [optional] |
+| **account** | [**AccountCreateRequest**](AccountCreateRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::AccountCreateRequestBody.new(
+  skip_webhook: true,
+  account: null
+)
+```
+

data/docs/AccountResponse.md

@@ -24,8 +24,10 @@
 | **institution_code** | **String** |  | [optional] |
 | **insured_name** | **String** |  | [optional] |
 | **interest_rate** | **Float** |  | [optional] |
+| **is_business** | **Boolean** |  | [optional] |
 | **is_closed** | **Boolean** |  | [optional] |
 | **is_hidden** | **Boolean** |  | [optional] |
+| **is_manual** | **Boolean** |  | [optional] |
 | **last_payment** | **Float** |  | [optional] |
 | **last_payment_at** | **String** |  | [optional] |
 | **loan_amount** | **Float** |  | [optional] |
@@ -43,6 +45,7 @@
 | **payment_due_at** | **String** |  | [optional] |
 | **payoff_balance** | **Float** |  | [optional] |
 | **premium_amount** | **Float** |  | [optional] |
+| **property_type** | **String** |  | [optional] |
 | **routing_number** | **String** |  | [optional] |
 | **started_on** | **String** |  | [optional] |
 | **subtype** | **String** |  | [optional] |
@@ -78,8 +81,10 @@ instance = MxPlatformRuby::AccountResponse.new(
   institution_code: chase,
   insured_name: Frodo Baggins,
   interest_rate: 1.0,
+  is_business: false,
   is_closed: false,
   is_hidden: false,
+  is_manual: false,
   last_payment: 100.0,
   last_payment_at: 2015-10-13T17:57:37.000Z,
   loan_amount: 1000.0,
@@ -97,6 +102,7 @@ instance = MxPlatformRuby::AccountResponse.new(
   payment_due_at: 2015-10-13T17:57:37.000Z,
   payoff_balance: 10.0,
   premium_amount: 1.0,
+  property_type: 1,
   routing_number: 68899990000000,
   started_on: 2015-10-13T17:57:37.000Z,
   subtype: NONE,

data/docs/MxPlatformApi.md

@@ -10,6 +10,7 @@ All URIs are relative to *https://api.mx.com*
 | [**create_managed_account**](MxPlatformApi.md#create_managed_account) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts | Create managed account |
 | [**create_managed_member**](MxPlatformApi.md#create_managed_member) | **POST** /users/{user_guid}/managed_members | Create managed member |
 | [**create_managed_transaction**](MxPlatformApi.md#create_managed_transaction) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | Create managed transaction |
+| [**create_manual_account**](MxPlatformApi.md#create_manual_account) | **POST** /users/{user_guid}/accounts | Create manual account |
 | [**create_member**](MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member |
 | [**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag |
 | [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging |
@@ -19,6 +20,7 @@ All URIs are relative to *https://api.mx.com*
 | [**delete_managed_account**](MxPlatformApi.md#delete_managed_account) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Delete managed account |
 | [**delete_managed_member**](MxPlatformApi.md#delete_managed_member) | **DELETE** /users/{user_guid}/managed_members/{member_guid} | Delete managed member |
 | [**delete_managed_transaction**](MxPlatformApi.md#delete_managed_transaction) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Delete managed transaction |
+| [**delete_manual_account**](MxPlatformApi.md#delete_manual_account) | **DELETE** /users/{user_guid}/accounts/{account_guid} | Delete manual account |
 | [**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member |
 | [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag |
 | [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
@@ -541,6 +543,78 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## create_manual_account
+
+> <AccountResponseBody> create_manual_account(user_guid, account_create_request_body)
+
+Create manual account
+
+This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed..
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+account_create_request_body = MxPlatformRuby::AccountCreateRequestBody.new # AccountCreateRequestBody | Manual account object to be created.
+
+begin
+  # Create manual account
+  result = api_instance.create_manual_account(user_guid, account_create_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->create_manual_account: #{e}"
+end
+```
+
+#### Using the create_manual_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountResponseBody>, Integer, Hash)> create_manual_account_with_http_info(user_guid, account_create_request_body)
+
+```ruby
+begin
+  # Create manual account
+  data, status_code, headers = api_instance.create_manual_account_with_http_info(user_guid, account_create_request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->create_manual_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+| **account_create_request_body** | [**AccountCreateRequestBody**](AccountCreateRequestBody.md) | Manual account object to be created. |  |
+
+### Return type
+
+[**AccountResponseBody**](AccountResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## create_member
 
 > <MemberResponseBody> create_member(user_guid, member_create_request_body)
@@ -1189,6 +1263,77 @@ nil (empty response body)
 - **Accept**: Not defined
 
 
+## delete_manual_account
+
+> delete_manual_account(account_guid, user_guid)
+
+Delete manual account
+
+This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+
+begin
+  # Delete manual account
+  api_instance.delete_manual_account(account_guid, user_guid)
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->delete_manual_account: #{e}"
+end
+```
+
+#### Using the delete_manual_account_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_manual_account_with_http_info(account_guid, user_guid)
+
+```ruby
+begin
+  # Delete manual account
+  data, status_code, headers = api_instance.delete_manual_account_with_http_info(account_guid, user_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->delete_manual_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** | The unique id for an &#x60;account&#x60;. |  |
+| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## delete_member
 
 > delete_member(member_guid, user_guid)

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

@@ -471,6 +471,80 @@ module MxPlatformRuby
       return data, status_code, headers
     end
 
+    # Create manual account
+    # This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed..
+    # @param user_guid [String] The unique id for a `user`.
+    # @param account_create_request_body [AccountCreateRequestBody] Manual account object to be created.
+    # @param [Hash] opts the optional parameters
+    # @return [AccountResponseBody]
+    def create_manual_account(user_guid, account_create_request_body, opts = {})
+      data, _status_code, _headers = create_manual_account_with_http_info(user_guid, account_create_request_body, opts)
+      data
+    end
+
+    # Create manual account
+    # This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed..
+    # @param user_guid [String] The unique id for a `user`.
+    # @param account_create_request_body [AccountCreateRequestBody] Manual account object to be created.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountResponseBody, Integer, Hash)>] AccountResponseBody data, response status code and response headers
+    def create_manual_account_with_http_info(user_guid, account_create_request_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_manual_account ...'
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_manual_account"
+      end
+      # verify the required parameter 'account_create_request_body' is set
+      if @api_client.config.client_side_validation && account_create_request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'account_create_request_body' when calling MxPlatformApi.create_manual_account"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/accounts'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(account_create_request_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AccountResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.create_manual_account",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#create_manual_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create member
     # This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.
     # @param user_guid [String] The unique id for a &#x60;user&#x60;.
@@ -1121,6 +1195,73 @@ module MxPlatformRuby
       return data, status_code, headers
     end
 
+    # Delete manual account
+    # This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`.
+    # @param account_guid [String] The unique id for an &#x60;account&#x60;.
+    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_manual_account(account_guid, user_guid, opts = {})
+      delete_manual_account_with_http_info(account_guid, user_guid, opts)
+      nil
+    end
+
+    # Delete manual account
+    # This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of &#x60;204 No Content&#x60;.
+    # @param account_guid [String] The unique id for an &#x60;account&#x60;.
+    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_manual_account_with_http_info(account_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_manual_account ...'
+      end
+      # verify the required parameter 'account_guid' is set
+      if @api_client.config.client_side_validation && account_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'account_guid' when calling MxPlatformApi.delete_manual_account"
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_manual_account"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/accounts/{account_guid}'.sub('{' + 'account_guid' + '}', CGI.escape(account_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.delete_manual_account",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#delete_manual_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete member
     # Accessing this endpoint will permanently delete a member.
     # @param member_guid [String] The unique id for a &#x60;member&#x60;.