apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/institutions_get_request_options.rb

@@ -0,0 +1,154 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to filter `/institutions/get` results.
+  class InstitutionsGetRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Filter the Institutions based on which products they support.
+    # @return [Array[Products]]
+    attr_accessor :products
+
+    # Specify an array of routing numbers to filter institutions. The response
+    # will only return institutions that match all of the routing numbers in the
+    # array.
+    # @return [Array[String]]
+    attr_accessor :routing_numbers
+
+    # 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.
+    # Note that Plaid does not own any of the logos shared by the API, and that
+    # by accessing or using these logos, you agree that you are doing so at your
+    # own risk and will, if necessary, obtain all required permissions from the
+    # appropriate rights holders and adhere to any applicable usage guidelines.
+    # Plaid disclaims all express or implied warranties with respect to the
+    # logos.
+    # @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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['products'] = 'products'
+      @_hash['routing_numbers'] = 'routing_numbers'
+      @_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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        products
+        routing_numbers
+        oauth
+        include_optional_metadata
+        include_auth_metadata
+        include_payment_initiation_metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(products: SKIP, routing_numbers: SKIP, oauth: SKIP,
+                   include_optional_metadata: SKIP,
+                   include_auth_metadata: false,
+                   include_payment_initiation_metadata: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @products = products unless products == SKIP
+      @routing_numbers = routing_numbers unless routing_numbers == SKIP
+      @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
+      @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.
+      products = hash.key?('products') ? hash['products'] : SKIP
+      routing_numbers =
+        hash.key?('routing_numbers') ? hash['routing_numbers'] : SKIP
+      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
+
+      # 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.
+      InstitutionsGetRequestOptions.new(products: products,
+                                        routing_numbers: routing_numbers,
+                                        oauth: oauth,
+                                        include_optional_metadata: include_optional_metadata,
+                                        include_auth_metadata: include_auth_metadata,
+                                        include_payment_initiation_metadata: include_payment_initiation_metadata,
+                                        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} products: #{@products}, routing_numbers: #{@routing_numbers}, oauth:"\
+      " #{@oauth}, include_optional_metadata: #{@include_optional_metadata},"\
+      " include_auth_metadata: #{@include_auth_metadata}, include_payment_initiation_metadata:"\
+      " #{@include_payment_initiation_metadata}, 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} products: #{@products.inspect}, routing_numbers:"\
+      " #{@routing_numbers.inspect}, 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}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/institutions_get_response.rb

@@ -0,0 +1,102 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # InstitutionsGetResponse defines the response schema for `/institutions/get`
+  class InstitutionsGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of Plaid Institution
+    # @return [Array[Institution]]
+    attr_accessor :institutions
+
+    # The total number of institutions available via this endpoint
+    # @return [Integer]
+    attr_accessor :total
+
+    # 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['total'] = 'total'
+      @_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:, total:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @institutions = institutions
+      @total = total
+      @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')
+      total = hash.key?('total') ? hash['total'] : nil
+      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.
+      InstitutionsGetResponse.new(institutions: institutions,
+                                  total: total,
+                                  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}, total: #{@total}, 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}, total: #{@total.inspect},"\
+      " request_id: #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/institutions_search_account_filter.rb

@@ -0,0 +1,105 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # InstitutionsSearchAccountFilter Model.
+  class InstitutionsSearchAccountFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AccountSubtype]]
+    attr_accessor :loan
+
+    # TODO: Write general description for this method
+    # @return [Array[AccountSubtype]]
+    attr_accessor :depository
+
+    # TODO: Write general description for this method
+    # @return [Array[AccountSubtype]]
+    attr_accessor :credit
+
+    # TODO: Write general description for this method
+    # @return [Array[AccountSubtype]]
+    attr_accessor :investment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['loan'] = 'loan'
+      @_hash['depository'] = 'depository'
+      @_hash['credit'] = 'credit'
+      @_hash['investment'] = 'investment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        loan
+        depository
+        credit
+        investment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(loan: SKIP, depository: SKIP, credit: SKIP, investment: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @loan = loan unless loan == SKIP
+      @depository = depository unless depository == SKIP
+      @credit = credit unless credit == SKIP
+      @investment = investment unless investment == 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.
+      loan = hash.key?('loan') ? hash['loan'] : SKIP
+      depository = hash.key?('depository') ? hash['depository'] : SKIP
+      credit = hash.key?('credit') ? hash['credit'] : SKIP
+      investment = hash.key?('investment') ? hash['investment'] : 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.
+      InstitutionsSearchAccountFilter.new(loan: loan,
+                                          depository: depository,
+                                          credit: credit,
+                                          investment: investment,
+                                          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} loan: #{@loan}, depository: #{@depository}, credit: #{@credit}, investment:"\
+      " #{@investment}, 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} loan: #{@loan.inspect}, depository: #{@depository.inspect}, credit:"\
+      " #{@credit.inspect}, investment: #{@investment.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/institutions_search_payment_initiation_options.rb

@@ -0,0 +1,77 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Additional options that will be used to filter institutions by various
+  # Payment Initiation configurations.
+  class InstitutionsSearchPaymentInitiationOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique ID identifying the payment
+    # @return [String]
+    attr_accessor :payment_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_id'] = 'payment_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_id = payment_id unless payment_id == 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.
+      payment_id = hash.key?('payment_id') ? hash['payment_id'] : 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.
+      InstitutionsSearchPaymentInitiationOptions.new(payment_id: payment_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} payment_id: #{@payment_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} payment_id: #{@payment_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/institutions_search_request.rb

@@ -0,0 +1,132 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # InstitutionsSearchRequest defines the request schema for
+  # `/institutions/search`
+  class InstitutionsSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your Plaid API `client_id`. The `client_id` is required and may be
+    # provided either in the `PLAID-CLIENT-ID` header or as part of a request
+    # body.
+    # @return [String]
+    attr_accessor :client_id
+
+    # Your Plaid API `secret`. The `secret` is required and may be provided
+    # either in the `PLAID-SECRET` header or as part of a request body.
+    # @return [String]
+    attr_accessor :secret
+
+    # The search query. Institutions with names matching the query are returned
+    # @return [String]
+    attr_accessor :query
+
+    # Filter the Institutions based on whether they support all products listed
+    # in `products`. Provide `null` to get institutions regardless of supported
+    # products. Note that when `auth` is specified as a product, if you are
+    # enabled for Instant Match or Automated Micro-deposits, institutions that
+    # support those products will be returned even if `auth` is not present in
+    # their product array.
+    # @return [Array[Products]]
+    attr_accessor :products
+
+    # Specify an array of Plaid-supported country codes this institution
+    # supports, using the ISO-3166-1 alpha-2 country code standard.
+    # @return [Array[CountryCode]]
+    attr_accessor :country_codes
+
+    # An optional object to filter `/institutions/search` results.
+    # @return [InstitutionsSearchRequestOptions]
+    attr_accessor :options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'client_id'
+      @_hash['secret'] = 'secret'
+      @_hash['query'] = 'query'
+      @_hash['products'] = 'products'
+      @_hash['country_codes'] = 'country_codes'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(query:, products:, country_codes:, client_id: SKIP,
+                   secret: SKIP, options: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_id = client_id unless client_id == SKIP
+      @secret = secret unless secret == SKIP
+      @query = query
+      @products = products
+      @country_codes = country_codes
+      @options = options unless options == 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.
+      query = hash.key?('query') ? hash['query'] : nil
+      products = hash.key?('products') ? hash['products'] : nil
+      country_codes = hash.key?('country_codes') ? hash['country_codes'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      options = InstitutionsSearchRequestOptions.from_hash(hash['options']) if hash['options']
+
+      # 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.
+      InstitutionsSearchRequest.new(query: query,
+                                    products: products,
+                                    country_codes: country_codes,
+                                    client_id: client_id,
+                                    secret: secret,
+                                    options: options,
+                                    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} client_id: #{@client_id}, secret: #{@secret}, query: #{@query}, products:"\
+      " #{@products}, country_codes: #{@country_codes}, options: #{@options},"\
+      " 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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, query:"\
+      " #{@query.inspect}, products: #{@products.inspect}, country_codes:"\
+      " #{@country_codes.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end