mx-platform-ruby 0.2.1 → 0.3.0

data/lib/mx-platform-ruby/models/user_response_body.rb

@@ -32,7 +32,7 @@ module MxPlatformRuby
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'user' => :'User'
+        :'user' => :'UserResponse'
       }
     end
 

data/lib/mx-platform-ruby/models/users_response_body.rb

@@ -35,8 +35,8 @@ module MxPlatformRuby
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'pagination' => :'Pagination',
-        :'users' => :'Array<User>'
+        :'pagination' => :'PaginationResponse',
+        :'users' => :'Array<UserResponse>'
       }
     end
 

data/lib/mx-platform-ruby/models/widget_response.rb

@@ -0,0 +1,236 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MxPlatformRuby
+  class WidgetResponse
+    attr_accessor :type
+
+    attr_accessor :url
+
+    attr_accessor :user_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'url' => :'url',
+        :'user_id' => :'user_id'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'url' => :'String',
+        :'user_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::WidgetResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MxPlatformRuby::WidgetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      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
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          url == o.url &&
+          user_id == o.user_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [type, url, user_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = MxPlatformRuby.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/mx-platform-ruby/models/widget_response_body.rb

@@ -32,7 +32,7 @@ module MxPlatformRuby
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'widget_url' => :'Widget'
+        :'widget_url' => :'WidgetResponse'
       }
     end
 

data/lib/mx-platform-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.2.0
 =end
 
 module MxPlatformRuby
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/openapi/config.yml

@@ -0,0 +1,11 @@
+---
+gemAuthor: "MX"
+gemAuthorEmail: "devexperience@mx.com"
+gemDescription: "A Ruby library for the MX Platform API."
+gemHomepage: "https://github.com/mxenabled/mx-platform-ruby"
+gemLicense: "MIT"
+gemName: "mx-platform-ruby"
+gemRequiredRubyVersion: ">= 2.6"
+gemVersion: "0.3.0"
+library: "faraday"
+moduleName: "MxPlatformRuby"

data/spec/api/mx_platform_api_spec.rb

@@ -90,7 +90,7 @@ describe 'MxPlatformApi' do
   # @param user_guid The unique id for a `user`.
   # @param tag_create_request_body Tag object to be created with required parameters (tag_guid)
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse200]
+  # @return [TagResponseBody]
   describe 'create_tag test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -213,7 +213,7 @@ describe 'MxPlatformApi' do
   end
 
   # unit tests for download_statement_pdf
-  # Download statement PDF
+  # Download statement pdf
   # Use this endpoint to download a specified statement PDF.
   # @param member_guid The unique id for a `member`.
   # @param statement_guid The unique id for a `statement`.
@@ -251,14 +251,14 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for fetch_statements_by_member
-  # Fetch statements by member
+  # unit tests for fetch_statements
+  # Fetch statements
   # Use this endpoint to fetch the statements associated with a particular member.
   # @param member_guid The unique id for a `member`.
   # @param user_guid The unique id for a `user`.
   # @param [Hash] opts the optional parameters
   # @return [MemberResponseBody]
-  describe 'fetch_statements_by_member test' do
+  describe 'fetch_statements test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -307,8 +307,8 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for list_account_owners
-  # List account owners
+  # unit tests for list_account_owners_by_member
+  # List account owners by member
   # This endpoint returns an array with information about every account associated with a particular member.
   # @param member_guid The unique id for a `member`.
   # @param user_guid The unique id for a `user`.
@@ -316,7 +316,7 @@ describe 'MxPlatformApi' do
   # @option opts [Integer] :page Specify current page.
   # @option opts [Integer] :records_per_page Specify records per page.
   # @return [AccountOwnersResponseBody]
-  describe 'list_account_owners test' do
+  describe 'list_account_owners_by_member test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -348,23 +348,22 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for list_favorites
-  # List favorites
+  # unit tests for list_favorite_institutions
+  # List favorite institutions
   # This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :page Specify current page.
   # @option opts [Integer] :records_per_page Specify records per page.
   # @return [InstitutionsResponseBody]
-  describe 'list_favorites test' do
+  describe 'list_favorite_institutions 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 list_holdings_by_member
-  # List holdings by member
-  # This endpoint returns all holdings associated with the specified `member` across all accounts.
-  # @param member_guid The unique id for a `member`.
+  # unit tests for list_holdings
+  # List holdings
+  # This endpoint returns all holdings associated with the specified `user` across all accounts and members.
   # @param user_guid The unique id for a `user`.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :from_date Filter holdings from this date.
@@ -372,15 +371,16 @@ describe 'MxPlatformApi' do
   # @option opts [Integer] :records_per_page Specify records per page.
   # @option opts [String] :to_date Filter holdings to this date.
   # @return [HoldingsResponseBody]
-  describe 'list_holdings_by_member test' do
+  describe 'list_holdings 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 list_holdings_by_user
-  # List holdings by user
-  # This endpoint returns all holdings associated with the specified `user` across all accounts and members.
+  # unit tests for list_holdings_by_member
+  # List holdings by member
+  # This endpoint returns all holdings associated with the specified `member` across all accounts.
+  # @param member_guid The unique id for a `member`.
   # @param user_guid The unique id for a `user`.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :from_date Filter holdings from this date.
@@ -388,21 +388,21 @@ describe 'MxPlatformApi' do
   # @option opts [Integer] :records_per_page Specify records per page.
   # @option opts [String] :to_date Filter holdings to this date.
   # @return [HoldingsResponseBody]
-  describe 'list_holdings_by_user test' do
+  describe 'list_holdings_by_member 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 list_institution_required_credentials
-  # List institution-required credentials
+  # unit tests for list_institution_credentials
+  # List institution credentials
   # Use this endpoint to see which credentials will be needed to create a member for a specific institution.
   # @param institution_code The institution_code of the institution.
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :page Specify current page.
   # @option opts [Integer] :records_per_page Specify records per page.
   # @return [CredentialsResponseBody]
-  describe 'list_institution_required_credentials test' do
+  describe 'list_institution_credentials test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -524,15 +524,31 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for list_transaction_rules_by_user
-  # List transaction rules by user
+  # unit tests for list_transaction_rules
+  # List transaction rules
   # Use this endpoint to read the attributes of all existing transaction rules belonging to the user.
   # @param user_guid The unique id for a `user`.
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :page Specify current page.
   # @option opts [Integer] :records_per_page Specify records per page.
   # @return [TransactionRulesResponseBody]
-  describe 'list_transaction_rules_by_user test' do
+  describe 'list_transaction_rules 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 list_transactions
+  # List transactions
+  # Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`.
+  # @param user_guid The unique id for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from_date Filter transactions from this date.
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @option opts [String] :to_date Filter transactions to this date.
+  # @return [TransactionsResponseBody]
+  describe 'list_transactions test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -585,22 +601,6 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for list_transactions_by_user
-  # List transactions by user
-  # Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`.
-  # @param user_guid The unique id for a `user`.
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :from_date Filter transactions from this date.
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @option opts [String] :to_date Filter transactions to this date.
-  # @return [TransactionsResponseBody]
-  describe 'list_transactions_by_user 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 list_user_accounts
   # List accounts
   # This endpoint returns a list of all the accounts associated with the specified `user`.
@@ -796,7 +796,7 @@ describe 'MxPlatformApi' do
   end
 
   # unit tests for request_connect_widget_url
-  # Request connect widget URL
+  # Request connect widget url
   # This endpoint will return a URL for an embeddable version of MX Connect.
   # @param user_guid The unique id for a `user`.
   # @param [Hash] opts the optional parameters
@@ -808,8 +808,8 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for request_o_auth_window
-  # Read member
+  # unit tests for request_o_auth_window_uri
+  # Request oauth window uri
   # This endpoint will generate an `oauth_window_uri` for the specified `member`.
   # @param member_guid The unique id for a `member`.
   # @param user_guid The unique id for a `user`.
@@ -817,14 +817,14 @@ describe 'MxPlatformApi' do
   # @option opts [String] :referral_source Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
   # @option opts [String] :ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in.
   # @return [OAuthWindowResponseBody]
-  describe 'request_o_auth_window test' do
+  describe 'request_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 request_widget_url
-  # Request a widget URL
+  # Request widget url
   # This endpoint allows partners to get a URL by passing the `widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request.
   # @param user_guid The unique id for a `user`.
   # @param widget_request_body The widget url configuration options.
@@ -851,8 +851,8 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for update_account
-  # Update account
+  # unit tests for update_account_by_member
+  # Update account by member
   # This endpoint allows you to update certain attributes of an `account` resource.
   # @param user_guid The unique id for a `user`.
   # @param member_guid The unique id for a `member`.
@@ -860,7 +860,7 @@ describe 'MxPlatformApi' do
   # @param account_update_request_body Account object to be created with optional parameters (is_hidden)
   # @param [Hash] opts the optional parameters
   # @return [AccountResponseBody]
-  describe 'update_account test' do
+  describe 'update_account_by_member test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -901,7 +901,7 @@ describe 'MxPlatformApi' do
   # @param user_guid The unique id for a `user`.
   # @param tag_update_request_body Tag object to be updated with required parameter (tag_guid)
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse200]
+  # @return [TagResponseBody]
   describe 'update_tag test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers