atrium-ruby 2.8.4 → 2.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfb0993147bf4c7081dcdafd342b21ee0d6899c0621a3481f3538927d874e394
-  data.tar.gz: 3ff88515ff6344a2ce4f6f9643bddc4e60c82f0c77cc1b80b482573c7e967f45
+  metadata.gz: 9758e41dc9d2bebcea6e6f993258f6a20e0801b4cde8bd5f7cc04f2c13b74f0e
+  data.tar.gz: a3a741ede145afe3c8182a8eeec8a0a526c5810d6079e4d2461984cd5377ded1
 SHA512:
-  metadata.gz: 8490bbcb3cd907cb6facfef8d3fcdfe514c1bcb4cf35da5cea1c2bce43531298217d789807b4a950d8e82c978472ee3d5fca9669461c0454abc35b2d0d357ce5
-  data.tar.gz: 8508d91958c58b477afa983615e11cace6835bd3ac2a4309f907cacb9604a9cd4a084e7bb26fb03bb6494b38aa1ff5b0f04fb1339ba8830813c389834e02e80c
+  metadata.gz: 51e1b0cafd8d8ed67be2a14c76d8bb5bcb1b82d6efebbca6cf22954b770a5e25c51560035fc58712f66181f1cbcc0caace930d3861b9cf583d6bf59285175887
+  data.tar.gz: 92207bfbc244974e935ba5be94197b2de43bc9cf5e43e36319aa9cadc47dc763e4c85dec66a2cbe9e3b2488dde64a908024d565f84faf831ed533c97097836d6

data/README.md

@@ -17,12 +17,12 @@ gem build atrium-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./atrium-ruby-2.8.4.gem
+gem install ./atrium-ruby-2.10.2.gem
 ```
 
 Finally add this to the Gemfile:
 
-    gem 'atrium-ruby', '~> 2.8.4'
+    gem 'atrium-ruby', '~> 2.10.2'
 
 ### Install from Git
 
@@ -96,9 +96,13 @@ Class | Method | HTTP request | Description
 *Atrium::MembersApi* | [**list_members**](docs/MembersApi.md#list_members) | **GET** /users/{user_guid}/members | List members
 *Atrium::MembersApi* | [**read_member**](docs/MembersApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member
 *Atrium::MembersApi* | [**read_member_status**](docs/MembersApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member connection status
+*Atrium::MembersApi* | [**read_o_auth_window_uri**](docs/MembersApi.md#read_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Read OAuth Window URI
 *Atrium::MembersApi* | [**resume_member**](docs/MembersApi.md#resume_member) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation from MFA
 *Atrium::MembersApi* | [**update_member**](docs/MembersApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member
+*Atrium::MerchantsApi* | [**list_merchant_locations**](docs/MerchantsApi.md#list_merchant_locations) | **GET** /merchants/{merchant_guid}/merchant_locations | List merchant locations
+*Atrium::MerchantsApi* | [**list_merchants**](docs/MerchantsApi.md#list_merchants) | **GET** /merchants | List merchants
 *Atrium::MerchantsApi* | [**read_merchant**](docs/MerchantsApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant
+*Atrium::MerchantsApi* | [**read_merchant_location**](docs/MerchantsApi.md#read_merchant_location) | **GET** /merchants/{merchant_guid}/merchant_locations/{merchant_location_guid} | Read merchant location
 *Atrium::StatementsApi* | [**download_statement_pdf**](docs/StatementsApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement PDF
 *Atrium::StatementsApi* | [**fetch_statements**](docs/StatementsApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
 *Atrium::StatementsApi* | [**list_member_statements**](docs/StatementsApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
@@ -154,7 +158,11 @@ Class | Method | HTTP request | Description
  - [Atrium::MemberUpdateRequestBody](docs/MemberUpdateRequestBody.md)
  - [Atrium::MembersResponseBody](docs/MembersResponseBody.md)
  - [Atrium::Merchant](docs/Merchant.md)
+ - [Atrium::MerchantLocation](docs/MerchantLocation.md)
+ - [Atrium::MerchantLocationResponseBody](docs/MerchantLocationResponseBody.md)
+ - [Atrium::MerchantLocationsResponseBody](docs/MerchantLocationsResponseBody.md)
  - [Atrium::MerchantResponseBody](docs/MerchantResponseBody.md)
+ - [Atrium::MerchantsResponseBody](docs/MerchantsResponseBody.md)
  - [Atrium::Pagination](docs/Pagination.md)
  - [Atrium::Statement](docs/Statement.md)
  - [Atrium::StatementResponseBody](docs/StatementResponseBody.md)

data/docs/AccountNumber.md

@@ -5,8 +5,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **account_guid** | **String** |  | [optional] 
 **account_number** | **String** |  | [optional] 
+**institution_number** | **String** |  | [optional] 
 **member_guid** | **String** |  | [optional] 
 **routing_number** | **String** |  | [optional] 
+**transit_number** | **String** |  | [optional] 
 **user_guid** | **String** |  | [optional] 
 
 

data/docs/ConnectWidgetRequestBody.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **disable_institution_search** | **BOOLEAN** |  | [optional] 
 **mode** | **String** |  | [optional] 
 **ui_message_version** | **Float** |  | [optional] 
+**ui_message_webview_url_scheme** | **String** |  | [optional] 
 **update_credentials** | **BOOLEAN** |  | [optional] 
 
 

data/docs/Member.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **is_being_aggregated** | **BOOLEAN** |  | [optional] 
 **metadata** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
+**oauth_window_uri** | **String** |  | [optional] 
 **status** | **String** |  | [optional] 
 **successfully_aggregated_at** | **String** |  | [optional] 
 **user_guid** | **String** |  | [optional] 

data/docs/MemberCreateRequest.md

@@ -3,10 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**credentials** | [**Array<CredentialRequest>**](CredentialRequest.md) |  | 
+**credentials** | [**Array<CredentialRequest>**](CredentialRequest.md) |  | [optional] 
 **identifier** | **String** |  | [optional] 
+**is_oauth** | **BOOLEAN** |  | [optional] 
 **institution_code** | **String** |  | 
 **metadata** | **String** |  | [optional] 
+**referral_source** | **String** |  | [optional] 
 **skip_aggregation** | **BOOLEAN** |  | [optional] 
+**ui_message_webview_url_scheme** | **String** |  | [optional] 
 
 

data/docs/MembersApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**list_members**](MembersApi.md#list_members) | **GET** /users/{user_guid}/members | List members
 [**read_member**](MembersApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member
 [**read_member_status**](MembersApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member connection status
+[**read_o_auth_window_uri**](MembersApi.md#read_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Read OAuth Window URI
 [**resume_member**](MembersApi.md#resume_member) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation from MFA
 [**update_member**](MembersApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member
 
@@ -481,6 +482,49 @@ Name | Type | Description  | Notes
 
 [**MemberConnectionStatusResponseBody**](MemberConnectionStatusResponseBody.md)
 
+# **read_o_auth_window_uri**
+> MemberResponseBody read_o_auth_window_uri(member_guid, user_guid, , opts)
+
+Read OAuth Window URI
+
+This endpoint will generate an `oauth_window_uri` for the specified `member`.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+member_guid = "MBR-123" # String | The unique identifier for a `member`.
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+opts = { 
+  referral_source: "BROWSER", # String | Should be either BROWSER or APP depending on the implementation.
+  ui_message_webview_url_scheme: "ui_message_webview_url_scheme_example" # String | A scheme for routing the user back to the application state they were previously in.
+}
+
+begin
+  #Read OAuth Window URI
+  response = client.members.read_o_auth_window_uri(member_guid, user_guid, , opts)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling MembersApi->read_o_auth_window_uri: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_guid** | **String**| The unique identifier for a `member`. | 
+ **user_guid** | **String**| The unique identifier for a `user`. | 
+ **referral_source** | **String**| Should be either BROWSER or APP depending on the implementation. | [optional] 
+ **ui_message_webview_url_scheme** | **String**| A scheme for routing the user back to the application state they were previously in. | [optional] 
+
+### Return type
+
+[**MemberResponseBody**](MemberResponseBody.md)
+
 # **resume_member**
 > MemberResponseBody resume_member(member_guid, user_guid, body)
 

data/docs/MerchantLocation.md

@@ -0,0 +1,17 @@
+# Atrium::MerchantLocation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**city** | **String** |  | [optional] 
+**guid** | **String** |  | [optional] 
+**latitude** | **Float** |  | [optional] 
+**longitude** | **Float** |  | [optional] 
+**merchant_guid** | **String** |  | [optional] 
+**phone_number** | **String** |  | [optional] 
+**postal_code** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**store_number** | **String** |  | [optional] 
+**street_address** | **String** |  | [optional] 
+
+

data/docs/MerchantLocationResponseBody.md

@@ -0,0 +1,8 @@
+# Atrium::MerchantLocationResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchant_location** | [**MerchantLocation**](MerchantLocation.md) |  | [optional] 
+
+

data/docs/MerchantLocationsResponseBody.md

@@ -0,0 +1,9 @@
+# Atrium::MerchantLocationsResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchant_locations** | [**Array<MerchantLocation>**](MerchantLocation.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

data/docs/MerchantsApi.md

@@ -2,11 +2,79 @@
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**list_merchant_locations**](MerchantsApi.md#list_merchant_locations) | **GET** /merchants/{merchant_guid}/merchant_locations | List merchant locations
+[**list_merchants**](MerchantsApi.md#list_merchants) | **GET** /merchants | List merchants
 [**read_merchant**](MerchantsApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant
+[**read_merchant_location**](MerchantsApi.md#read_merchant_location) | **GET** /merchants/{merchant_guid}/merchant_locations/{merchant_location_guid} | Read merchant location
 
 
+# **list_merchant_locations**
+> MerchantLocationsResponseBody list_merchant_locations(merchant_guid, )
+
+List merchant locations
+
+Returns a list of all the merchant locations associated with a merchant, including physical location, latitude, longitude, etc.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+merchant_guid = "MCH-123" # String | The unique identifier for a `merchant`.
+
+begin
+  #List merchant locations
+  response = client.merchants.list_merchant_locations(merchant_guid, )
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling MerchantsApi->list_merchant_locations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **merchant_guid** | **String**| The unique identifier for a `merchant`. | 
+
+### Return type
+
+[**MerchantLocationsResponseBody**](MerchantLocationsResponseBody.md)
+
+# **list_merchants**
+> MerchantsResponseBody list_merchants
+
+List merchants
+
+Returns a list of merchnants.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+begin
+  #List merchants
+  response = client.merchants.list_merchants
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling MerchantsApi->list_merchants: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**MerchantsResponseBody**](MerchantsResponseBody.md)
+
 # **read_merchant**
-> MerchantResponseBody read_merchant(merchant_guid)
+> MerchantResponseBody read_merchant(merchant_guid, )
 
 Read merchant
 
@@ -23,7 +91,7 @@ merchant_guid = "MCH-123" # String | The unique identifier for a `merchant`.
 
 begin
   #Read merchant
-  response = client.merchants.read_merchant(merchant_guid)
+  response = client.merchants.read_merchant(merchant_guid, )
   p response
 rescue Atrium::ApiError => e
   puts "Exception when calling MerchantsApi->read_merchant: #{e}"
@@ -40,3 +108,40 @@ Name | Type | Description  | Notes
 
 [**MerchantResponseBody**](MerchantResponseBody.md)
 
+# **read_merchant_location**
+> MerchantLocationResponseBody read_merchant_location(merchant_guid, merchant_location_guid)
+
+Read merchant location
+
+Retuns a specific location associated with a merchant, including physical location, latitude, longitude, etc.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+merchant_guid = "MCH-123" # String | The unique identifier for a `merchant`.
+merchant_location_guid = "MCL-123" # String | The unique identifier for a `merchant_location`.
+
+begin
+  #Read merchant location
+  response = client.merchants.read_merchant_location(merchant_guid, merchant_location_guid)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling MerchantsApi->read_merchant_location: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **merchant_guid** | **String**| The unique identifier for a `merchant`. | 
+ **merchant_location_guid** | **String**| The unique identifier for a `merchant_location`. | 
+
+### Return type
+
+[**MerchantLocationResponseBody**](MerchantLocationResponseBody.md)
+

data/docs/MerchantsResponseBody.md

@@ -0,0 +1,9 @@
+# Atrium::MerchantsResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchants** | [**Array<Merchant>**](Merchant.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

data/docs/Transaction.md

@@ -21,6 +21,7 @@ Name | Type | Description | Notes
 **is_international** | **BOOLEAN** |  | [optional] 
 **is_overdraft_fee** | **BOOLEAN** |  | [optional] 
 **is_payroll_advance** | **BOOLEAN** |  | [optional] 
+**is_subscription** | **BOOLEAN** |  | [optional] 
 **latitude** | **Float** |  | [optional] 
 **longitude** | **Float** |  | [optional] 
 **member_guid** | **String** |  | [optional] 

data/docs/TransactionCleanseAndCategorizeRequest.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **amount** | **Float** |  | [optional] 
 **description** | **String** |  | [optional] 
 **identifier** | **String** |  | [optional] 
+**merchant_category_code** | **Float** |  | [optional] 
 **type** | **String** |  | [optional] 
 
 

data/docs/TransactionCleanseAndCategorizeResponse.md

@@ -16,5 +16,8 @@ Name | Type | Description | Notes
 **is_international** | **BOOLEAN** |  | [optional] 
 **is_overdraft_fee** | **BOOLEAN** |  | [optional] 
 **is_payroll_advance** | **BOOLEAN** |  | [optional] 
+**merchant_category_code** | **Float** |  | [optional] 
+**merchant_guid** | **String** |  | [optional] 
+**original_description** | **String** |  | [optional] 
 
 

data/lib/atrium-ruby.rb

@@ -49,7 +49,11 @@ require 'atrium-ruby/models/member_update_request'
 require 'atrium-ruby/models/member_update_request_body'
 require 'atrium-ruby/models/members_response_body'
 require 'atrium-ruby/models/merchant'
+require 'atrium-ruby/models/merchant_location'
+require 'atrium-ruby/models/merchant_location_response_body'
+require 'atrium-ruby/models/merchant_locations_response_body'
 require 'atrium-ruby/models/merchant_response_body'
+require 'atrium-ruby/models/merchants_response_body'
 require 'atrium-ruby/models/pagination'
 require 'atrium-ruby/models/statement'
 require 'atrium-ruby/models/statement_response_body'

data/lib/atrium-ruby/api/members_api.rb

@@ -154,6 +154,19 @@ module Atrium
       data
     end
 
+    # Read OAuth Window URI
+    # This endpoint will generate an `oauth_window_uri` for the specified `member`.
+    # @param member_guid The unique identifier for a `member`.
+    # @param user_guid The unique identifier for a `user`.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :referral_source Should be either BROWSER or APP depending on the implementation.
+    # @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in.
+    # @return [MemberResponseBody]
+    def read_o_auth_window_uri(member_guid, user_guid, opts = {})
+      data, _status_code, _headers = read_o_auth_window_uri_with_http_info(member_guid, user_guid, opts)
+      data
+    end
+
     # Resume aggregation from MFA
     # This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
     # @param member_guid The unique identifier for a `member`.
@@ -761,6 +774,57 @@ module Atrium
       end
       return data, status_code, headers
     end
+    # Read OAuth Window URI
+    # This endpoint will generate an `oauth_window_uri` for the specified `member`.
+    # @param member_guid The unique identifier for a `member`.
+    # @param user_guid The unique identifier for a `user`.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :referral_source Should be either BROWSER or APP depending on the implementation.
+    # @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in.
+    # @return [Array<(MemberResponseBody, Fixnum, Hash)>] MemberResponseBody data, response status code and response headers
+    def read_o_auth_window_uri_with_http_info(member_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MembersApi.read_o_auth_window_uri ...'
+      end
+      # verify the required parameter 'member_guid' is set
+      if @api_client.config.client_side_validation && member_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.read_o_auth_window_uri"
+      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 MembersApi.read_o_auth_window_uri"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/members/{member_guid}/oauth_window_uri'.sub('{' + 'member_guid' + '}', member_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'referral_source'] = opts[:'referral_source'] if !opts[:'referral_source'].nil?
+      query_params[:'ui_message_webview_url_scheme'] = opts[:'ui_message_webview_url_scheme'] if !opts[:'ui_message_webview_url_scheme'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apiKey', 'clientID']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'MemberResponseBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MembersApi#read_o_auth_window_uri\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Resume aggregation from MFA
     # This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
     # @param member_guid The unique identifier for a &#x60;member&#x60;.