atrium-ruby 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48c3fc574a543cce206566163be272ed59cfab1d05b121fb7eb8922cf33a92a5
-  data.tar.gz: 0370ce6f952bbff330fc3e4ea6970b88a377f5d350f84fe577af02d67ed6683e
+  metadata.gz: f08e2d96c61ae1138e229127724abbac929c570fa28ade6c5237cf8f68b14120
+  data.tar.gz: 61bdce1ea25e298bb8c27777443d577c206608c8cf0beb422aba6656bbe626e1
 SHA512:
-  metadata.gz: 237f2ca0ce1da387f18e2bb770db636ba6b15c4a639ef5361efbab58e5f3fd6d60f0fc58c20af7ebb04b072fb115714d743bd6549896f16fdd1257be88087900
-  data.tar.gz: 61ea35786ba0ab7e502dedcf83968cc0e48874758219080e6efb00c4b20b1e08e0e54b70a7fc4de67a8e56bffd163b04b5cf43b05b84497bb26f3a2aebf7842f
+  metadata.gz: 967452b0816d315fbe62e0a142e86b545c1d22fdf93ba286da38c6f2ebdd97bbe12cfb4ef1be498f042fa6d6e38ac09fe9948431edcfd2fe398324feb16b4056
+  data.tar.gz: 3de4cebc0d0320d76eb7ae08cf758859c7d78df31f125a5bce6be10630de50ce75d2fe5d74d9ea396f44330d1b77b1801f2595a1bc697049fe9f63918f9236b4

data/README.md

@@ -17,12 +17,12 @@ gem build atrium-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./atrium-ruby-2.9.0.gem
+gem install ./atrium-ruby-2.10.0.gem
 ```
 
 Finally add this to the Gemfile:
 
-    gem 'atrium-ruby', '~> 2.9.0'
+    gem 'atrium-ruby', '~> 2.10.0'
 
 ### Install from Git
 
@@ -96,6 +96,7 @@ 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

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/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;.

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

@@ -22,6 +22,8 @@ module Atrium
 
     attr_accessor :ui_message_version
 
+    attr_accessor :ui_message_webview_url_scheme
+
     attr_accessor :update_credentials
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -33,6 +35,7 @@ module Atrium
         :'disable_institution_search' => :'disable_institution_search',
         :'mode' => :'mode',
         :'ui_message_version' => :'ui_message_version',
+        :'ui_message_webview_url_scheme' => :'ui_message_webview_url_scheme',
         :'update_credentials' => :'update_credentials'
       }
     end
@@ -46,6 +49,7 @@ module Atrium
         :'disable_institution_search' => :'BOOLEAN',
         :'mode' => :'String',
         :'ui_message_version' => :'Float',
+        :'ui_message_webview_url_scheme' => :'String',
         :'update_credentials' => :'BOOLEAN'
       }
     end
@@ -82,6 +86,10 @@ module Atrium
         self.ui_message_version = attributes[:'ui_message_version']
       end
 
+      if attributes.has_key?(:'ui_message_webview_url_scheme')
+        self.ui_message_webview_url_scheme = attributes[:'ui_message_webview_url_scheme']
+      end
+
       if attributes.has_key?(:'update_credentials')
         self.update_credentials = attributes[:'update_credentials']
       end
@@ -111,6 +119,7 @@ module Atrium
           disable_institution_search == o.disable_institution_search &&
           mode == o.mode &&
           ui_message_version == o.ui_message_version &&
+          ui_message_webview_url_scheme == o.ui_message_webview_url_scheme &&
           update_credentials == o.update_credentials
     end
 
@@ -123,7 +132,7 @@ module Atrium
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [is_mobile_webview, current_institution_code, current_member_guid, disable_institution_search, mode, ui_message_version, update_credentials].hash
+      [is_mobile_webview, current_institution_code, current_member_guid, disable_institution_search, mode, ui_message_version, ui_message_webview_url_scheme, update_credentials].hash
     end
 
     # Builds the object from hash

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

@@ -26,6 +26,8 @@ module Atrium
 
     attr_accessor :name
 
+    attr_accessor :oauth_window_uri
+
     attr_accessor :status
 
     attr_accessor :successfully_aggregated_at
@@ -43,6 +45,7 @@ module Atrium
         :'is_being_aggregated' => :'is_being_aggregated',
         :'metadata' => :'metadata',
         :'name' => :'name',
+        :'oauth_window_uri' => :'oauth_window_uri',
         :'status' => :'status',
         :'successfully_aggregated_at' => :'successfully_aggregated_at',
         :'user_guid' => :'user_guid'
@@ -60,6 +63,7 @@ module Atrium
         :'is_being_aggregated' => :'BOOLEAN',
         :'metadata' => :'String',
         :'name' => :'String',
+        :'oauth_window_uri' => :'String',
         :'status' => :'String',
         :'successfully_aggregated_at' => :'String',
         :'user_guid' => :'String'
@@ -106,6 +110,10 @@ module Atrium
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'oauth_window_uri')
+        self.oauth_window_uri = attributes[:'oauth_window_uri']
+      end
+
       if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
@@ -145,6 +153,7 @@ module Atrium
           is_being_aggregated == o.is_being_aggregated &&
           metadata == o.metadata &&
           name == o.name &&
+          oauth_window_uri == o.oauth_window_uri &&
           status == o.status &&
           successfully_aggregated_at == o.successfully_aggregated_at &&
           user_guid == o.user_guid
@@ -159,7 +168,7 @@ module Atrium
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [aggregated_at, connection_status, guid, identifier, institution_code, is_being_aggregated, metadata, name, status, successfully_aggregated_at, user_guid].hash
+      [aggregated_at, connection_status, guid, identifier, institution_code, is_being_aggregated, metadata, name, oauth_window_uri, status, successfully_aggregated_at, user_guid].hash
     end
 
     # Builds the object from hash

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

@@ -14,20 +14,29 @@ module Atrium
 
     attr_accessor :identifier
 
+    attr_accessor :is_oauth
+
     attr_accessor :institution_code
 
     attr_accessor :metadata
 
+    attr_accessor :referral_source
+
     attr_accessor :skip_aggregation
 
+    attr_accessor :ui_message_webview_url_scheme
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'credentials' => :'credentials',
         :'identifier' => :'identifier',
+        :'is_oauth' => :'is_oauth',
         :'institution_code' => :'institution_code',
         :'metadata' => :'metadata',
-        :'skip_aggregation' => :'skip_aggregation'
+        :'referral_source' => :'referral_source',
+        :'skip_aggregation' => :'skip_aggregation',
+        :'ui_message_webview_url_scheme' => :'ui_message_webview_url_scheme'
       }
     end
 
@@ -36,9 +45,12 @@ module Atrium
       {
         :'credentials' => :'Array<CredentialRequest>',
         :'identifier' => :'String',
+        :'is_oauth' => :'BOOLEAN',
         :'institution_code' => :'String',
         :'metadata' => :'String',
-        :'skip_aggregation' => :'BOOLEAN'
+        :'referral_source' => :'String',
+        :'skip_aggregation' => :'BOOLEAN',
+        :'ui_message_webview_url_scheme' => :'String'
       }
     end
 
@@ -60,6 +72,10 @@ module Atrium
         self.identifier = attributes[:'identifier']
       end
 
+      if attributes.has_key?(:'is_oauth')
+        self.is_oauth = attributes[:'is_oauth']
+      end
+
       if attributes.has_key?(:'institution_code')
         self.institution_code = attributes[:'institution_code']
       end
@@ -68,19 +84,23 @@ module Atrium
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.has_key?(:'referral_source')
+        self.referral_source = attributes[:'referral_source']
+      end
+
       if attributes.has_key?(:'skip_aggregation')
         self.skip_aggregation = attributes[:'skip_aggregation']
       end
+
+      if attributes.has_key?(:'ui_message_webview_url_scheme')
+        self.ui_message_webview_url_scheme = attributes[:'ui_message_webview_url_scheme']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @credentials.nil?
-        invalid_properties.push('invalid value for "credentials", credentials cannot be nil.')
-      end
-
       if @institution_code.nil?
         invalid_properties.push('invalid value for "institution_code", institution_code cannot be nil.')
       end
@@ -91,7 +111,6 @@ module Atrium
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @credentials.nil?
       return false if @institution_code.nil?
       true
     end
@@ -103,9 +122,12 @@ module Atrium
       self.class == o.class &&
           credentials == o.credentials &&
           identifier == o.identifier &&
+          is_oauth == o.is_oauth &&
           institution_code == o.institution_code &&
           metadata == o.metadata &&
-          skip_aggregation == o.skip_aggregation
+          referral_source == o.referral_source &&
+          skip_aggregation == o.skip_aggregation &&
+          ui_message_webview_url_scheme == o.ui_message_webview_url_scheme
     end
 
     # @see the `==` method
@@ -117,7 +139,7 @@ module Atrium
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [credentials, identifier, institution_code, metadata, skip_aggregation].hash
+      [credentials, identifier, is_oauth, institution_code, metadata, referral_source, skip_aggregation, ui_message_webview_url_scheme].hash
     end
 
     # Builds the object from hash

data/lib/atrium-ruby/version.rb

@@ -7,5 +7,5 @@
 =end
 
 module Atrium
-  VERSION = '2.9.0'
+  VERSION = '2.10.0'
 end

data/spec/api/members_api_spec.rb

@@ -190,6 +190,21 @@ describe 'MembersApi' do
     end
   end
 
+  # unit tests for read_o_auth_window_uri
+  # 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]
+  describe 'read_o_auth_window_uri test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for resume_member
   # Resume aggregation from MFA
   # This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.

data/spec/models/connect_widget_request_body_spec.rb

@@ -63,6 +63,12 @@ describe 'ConnectWidgetRequestBody' do
     end
   end
 
+  describe 'test attribute "ui_message_webview_url_scheme"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "update_credentials"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/member_create_request_spec.rb

@@ -39,6 +39,12 @@ describe 'MemberCreateRequest' do
     end
   end
 
+  describe 'test attribute "is_oauth"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "institution_code"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -51,10 +57,22 @@ describe 'MemberCreateRequest' do
     end
   end
 
+  describe 'test attribute "referral_source"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "skip_aggregation"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  describe 'test attribute "ui_message_webview_url_scheme"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/member_spec.rb

@@ -75,6 +75,12 @@ describe 'Member' do
     end
   end
 
+  describe 'test attribute "oauth_window_uri"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "status"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atrium-ruby
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - MX
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus