atrium-ruby 2.8.5 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a610289014355dca342894a1e5ea60e9ff67ab778744c33fbe0511200e02a255
-  data.tar.gz: ea45acd5c98cbcd7c3d8fe9e684233c73a82af45e3284548c8a591debe290543
+  metadata.gz: 48c3fc574a543cce206566163be272ed59cfab1d05b121fb7eb8922cf33a92a5
+  data.tar.gz: 0370ce6f952bbff330fc3e4ea6970b88a377f5d350f84fe577af02d67ed6683e
 SHA512:
-  metadata.gz: 3c61a95bfd9372b8a7e5a78b27de9db845186cd9c6c76f4257c1f33ef888e1c77a74fc178c26a42e45e6602c887c0ba2cf0d1bce4413b52f5ef9e086ec337a8c
-  data.tar.gz: 51b0036bc1c27679532440e917b456c23d60b769aef2c84af47e78bc70277e56b5bfb9b86a7f80d56e16736a21585ec3fe060c6d281a57012539e04bcaf909e5
+  metadata.gz: 237f2ca0ce1da387f18e2bb770db636ba6b15c4a639ef5361efbab58e5f3fd6d60f0fc58c20af7ebb04b072fb115714d743bd6549896f16fdd1257be88087900
+  data.tar.gz: 61ea35786ba0ab7e502dedcf83968cc0e48874758219080e6efb00c4b20b1e08e0e54b70a7fc4de67a8e56bffd163b04b5cf43b05b84497bb26f3a2aebf7842f

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.5.gem
+gem install ./atrium-ruby-2.9.0.gem
 ```
 
 Finally add this to the Gemfile:
 
-    gem 'atrium-ruby', '~> 2.8.5'
+    gem 'atrium-ruby', '~> 2.9.0'
 
 ### Install from Git
 
@@ -98,7 +98,10 @@ Class | Method | HTTP request | Description
 *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* | [**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 +157,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/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
+------------ | ------------- | ------------- | -------------
+**merchant** | [**Array<Merchant>**](Merchant.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [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/merchants_api.rb

@@ -15,6 +15,25 @@ module Atrium
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # List merchant locations
+    # Returns a list of all the merchant locations associated with a merchant, including physical location, latitude, longitude, etc.
+    # @param merchant_guid The unique identifier for a `merchant`.
+    # @param [Hash] opts the optional parameters
+    # @return [MerchantLocationsResponseBody]
+    def list_merchant_locations(merchant_guid, opts = {})
+      data, _status_code, _headers = list_merchant_locations_with_http_info(merchant_guid, opts)
+      data
+    end
+
+    # List merchants
+    # Returns a list of merchnants.
+    # @param [Hash] opts the optional parameters
+    # @return [MerchantsResponseBody]
+    def list_merchants(opts = {})
+      data, _status_code, _headers = list_merchants_with_http_info(opts)
+      data
+    end
+
     # Read merchant
     # Returns information about a particular merchant, such as a logo, name, and website.
     # @param merchant_guid The unique identifier for a `merchant`.
@@ -25,9 +44,99 @@ module Atrium
       data
     end
 
+    # Read merchant location
+    # Retuns a specific location associated with a merchant, including physical location, latitude, longitude, etc.
+    # @param merchant_guid The unique identifier for a `merchant`.
+    # @param merchant_location_guid The unique identifier for a `merchant_location`.
+    # @param [Hash] opts the optional parameters
+    # @return [MerchantLocationResponseBody]
+    def read_merchant_location(merchant_guid, merchant_location_guid, opts = {})
+      data, _status_code, _headers = read_merchant_location_with_http_info(merchant_guid, merchant_location_guid, opts)
+      data
+    end
+
 
   private
 
+    # List merchant locations
+    # Returns a list of all the merchant locations associated with a merchant, including physical location, latitude, longitude, etc.
+    # @param merchant_guid The unique identifier for a `merchant`.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MerchantLocationsResponseBody, Fixnum, Hash)>] MerchantLocationsResponseBody data, response status code and response headers
+    def list_merchant_locations_with_http_info(merchant_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MerchantsApi.list_merchant_locations ...'
+      end
+      # verify the required parameter 'merchant_guid' is set
+      if @api_client.config.client_side_validation && merchant_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_guid' when calling MerchantsApi.list_merchant_locations"
+      end
+      # resource path
+      local_var_path = '/merchants/{merchant_guid}/merchant_locations'.sub('{' + 'merchant_guid' + '}', merchant_guid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 => 'MerchantLocationsResponseBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MerchantsApi#list_merchant_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # List merchants
+    # Returns a list of merchnants.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MerchantsResponseBody, Fixnum, Hash)>] MerchantsResponseBody data, response status code and response headers
+    def list_merchants_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MerchantsApi.list_merchants ...'
+      end
+      # resource path
+      local_var_path = '/merchants'
+
+      # query parameters
+      query_params = {}
+
+      # 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 => 'MerchantsResponseBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MerchantsApi#list_merchants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Read merchant
     # Returns information about a particular merchant, such as a logo, name, and website.
     # @param merchant_guid The unique identifier for a &#x60;merchant&#x60;.
@@ -70,5 +179,52 @@ module Atrium
       end
       return data, status_code, headers
     end
+    # Read merchant location
+    # Retuns a specific location associated with a merchant, including physical location, latitude, longitude, etc.
+    # @param merchant_guid The unique identifier for a &#x60;merchant&#x60;.
+    # @param merchant_location_guid The unique identifier for a &#x60;merchant_location&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MerchantLocationResponseBody, Fixnum, Hash)>] MerchantLocationResponseBody data, response status code and response headers
+    def read_merchant_location_with_http_info(merchant_guid, merchant_location_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MerchantsApi.read_merchant_location ...'
+      end
+      # verify the required parameter 'merchant_guid' is set
+      if @api_client.config.client_side_validation && merchant_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_guid' when calling MerchantsApi.read_merchant_location"
+      end
+      # verify the required parameter 'merchant_location_guid' is set
+      if @api_client.config.client_side_validation && merchant_location_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_location_guid' when calling MerchantsApi.read_merchant_location"
+      end
+      # resource path
+      local_var_path = '/merchants/{merchant_guid}/merchant_locations/{merchant_location_guid}'.sub('{' + 'merchant_guid' + '}', merchant_guid.to_s).sub('{' + 'merchant_location_guid' + '}', merchant_location_guid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 => 'MerchantLocationResponseBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MerchantsApi#read_merchant_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/atrium-ruby/models/account_number.rb

@@ -14,10 +14,14 @@ module Atrium
 
     attr_accessor :account_number
 
+    attr_accessor :institution_number
+
     attr_accessor :member_guid
 
     attr_accessor :routing_number
 
+    attr_accessor :transit_number
+
     attr_accessor :user_guid
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -25,8 +29,10 @@ module Atrium
       {
         :'account_guid' => :'account_guid',
         :'account_number' => :'account_number',
+        :'institution_number' => :'institution_number',
         :'member_guid' => :'member_guid',
         :'routing_number' => :'routing_number',
+        :'transit_number' => :'transit_number',
         :'user_guid' => :'user_guid'
       }
     end
@@ -36,8 +42,10 @@ module Atrium
       {
         :'account_guid' => :'String',
         :'account_number' => :'String',
+        :'institution_number' => :'String',
         :'member_guid' => :'String',
         :'routing_number' => :'String',
+        :'transit_number' => :'String',
         :'user_guid' => :'String'
       }
     end
@@ -58,6 +66,10 @@ module Atrium
         self.account_number = attributes[:'account_number']
       end
 
+      if attributes.has_key?(:'institution_number')
+        self.institution_number = attributes[:'institution_number']
+      end
+
       if attributes.has_key?(:'member_guid')
         self.member_guid = attributes[:'member_guid']
       end
@@ -66,6 +78,10 @@ module Atrium
         self.routing_number = attributes[:'routing_number']
       end
 
+      if attributes.has_key?(:'transit_number')
+        self.transit_number = attributes[:'transit_number']
+      end
+
       if attributes.has_key?(:'user_guid')
         self.user_guid = attributes[:'user_guid']
       end
@@ -91,8 +107,10 @@ module Atrium
       self.class == o.class &&
           account_guid == o.account_guid &&
           account_number == o.account_number &&
+          institution_number == o.institution_number &&
           member_guid == o.member_guid &&
           routing_number == o.routing_number &&
+          transit_number == o.transit_number &&
           user_guid == o.user_guid
     end
 
@@ -105,7 +123,7 @@ module Atrium
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_guid, account_number, member_guid, routing_number, user_guid].hash
+      [account_guid, account_number, institution_number, member_guid, routing_number, transit_number, user_guid].hash
     end
 
     # Builds the object from hash