apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/institutions_search_request_options.rb

@@ -0,0 +1,136 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to filter `/institutions/search` results.
+  class InstitutionsSearchRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Limit results to institutions with or without OAuth login flows. This is
+    # primarily relevant to institutions with European country codes
+    # @return [TrueClass | FalseClass]
+    attr_accessor :oauth
+
+    # When true, return the institution's homepage URL, logo and primary brand
+    # color.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_optional_metadata
+
+    # When `true`, returns metadata related to the Auth product indicating which
+    # auth methods are supported.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_auth_metadata
+
+    # When `true`, returns metadata related to the Payment Initiation product
+    # indicating which payment configurations are supported.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_payment_initiation_metadata
+
+    # Additional options that will be used to filter institutions by various
+    # Payment Initiation configurations.
+    # @return [InstitutionsSearchPaymentInitiationOptions]
+    attr_accessor :payment_initiation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['oauth'] = 'oauth'
+      @_hash['include_optional_metadata'] = 'include_optional_metadata'
+      @_hash['include_auth_metadata'] = 'include_auth_metadata'
+      @_hash['include_payment_initiation_metadata'] =
+        'include_payment_initiation_metadata'
+      @_hash['payment_initiation'] = 'payment_initiation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        oauth
+        include_optional_metadata
+        include_auth_metadata
+        include_payment_initiation_metadata
+        payment_initiation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(oauth: SKIP, include_optional_metadata: SKIP,
+                   include_auth_metadata: false,
+                   include_payment_initiation_metadata: false,
+                   payment_initiation: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @oauth = oauth unless oauth == SKIP
+      unless include_optional_metadata == SKIP
+        @include_optional_metadata =
+          include_optional_metadata
+      end
+      @include_auth_metadata = include_auth_metadata unless include_auth_metadata == SKIP
+      unless include_payment_initiation_metadata == SKIP
+        @include_payment_initiation_metadata =
+          include_payment_initiation_metadata
+      end
+      @payment_initiation = payment_initiation unless payment_initiation == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      oauth = hash.key?('oauth') ? hash['oauth'] : SKIP
+      include_optional_metadata =
+        hash.key?('include_optional_metadata') ? hash['include_optional_metadata'] : SKIP
+      include_auth_metadata = hash['include_auth_metadata'] ||= false
+      include_payment_initiation_metadata =
+        hash['include_payment_initiation_metadata'] ||= false
+      if hash['payment_initiation']
+        payment_initiation = InstitutionsSearchPaymentInitiationOptions.from_hash(hash['payment_initiation'])
+      end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      InstitutionsSearchRequestOptions.new(oauth: oauth,
+                                           include_optional_metadata: include_optional_metadata,
+                                           include_auth_metadata: include_auth_metadata,
+                                           include_payment_initiation_metadata: include_payment_initiation_metadata,
+                                           payment_initiation: payment_initiation,
+                                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} oauth: #{@oauth}, include_optional_metadata: #{@include_optional_metadata},"\
+      " include_auth_metadata: #{@include_auth_metadata}, include_payment_initiation_metadata:"\
+      " #{@include_payment_initiation_metadata}, payment_initiation: #{@payment_initiation},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} oauth: #{@oauth.inspect}, include_optional_metadata:"\
+      " #{@include_optional_metadata.inspect}, include_auth_metadata:"\
+      " #{@include_auth_metadata.inspect}, include_payment_initiation_metadata:"\
+      " #{@include_payment_initiation_metadata.inspect}, payment_initiation:"\
+      " #{@payment_initiation.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/institutions_search_response.rb

@@ -0,0 +1,94 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # InstitutionsSearchResponse defines the response schema for
+  # `/institutions/search`
+  class InstitutionsSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of institutions matching the search criteria
+    # @return [Array[Institution]]
+    attr_accessor :institutions
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['institutions'] = 'institutions'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(institutions:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @institutions = institutions
+      @request_id = request_id
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      institutions = nil
+      unless hash['institutions'].nil?
+        institutions = []
+        hash['institutions'].each do |structure|
+          institutions << (Institution.from_hash(structure) if structure)
+        end
+      end
+
+      institutions = nil unless hash.key?('institutions')
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      InstitutionsSearchResponse.new(institutions: institutions,
+                                     request_id: request_id,
+                                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} institutions: #{@institutions}, request_id: #{@request_id},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} institutions: #{@institutions.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/investment.rb

@@ -0,0 +1,80 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A filter to apply to `investment`-type accounts
+  class Investment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of account subtypes to display in Link. If not specified, all
+    # account subtypes will be shown. For a full list of valid types and
+    # subtypes, see the [Account
+    # schema](https://plaid.com/docs/api/accounts#accounts-schema).
+    # @return [Array[AccountSubtype]]
+    attr_accessor :account_subtypes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_subtypes'] = 'account_subtypes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_subtypes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_subtypes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_subtypes = account_subtypes unless account_subtypes == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_subtypes =
+        hash.key?('account_subtypes') ? hash['account_subtypes'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Investment.new(account_subtypes: account_subtypes,
+                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_subtypes: #{@account_subtypes}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_subtypes: #{@account_subtypes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end