apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/link_token_get_metadata_response.rb

@@ -0,0 +1,140 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object specifying the arguments originally provided to the
+  # `/link/token/create` call.
+  class LinkTokenGetMetadataResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The `products` specified in the `/link/token/create` call.
+    # @return [Array[Products]]
+    attr_accessor :initial_products
+
+    # The `webhook` specified in the `/link/token/create` call.
+    # @return [String]
+    attr_accessor :webhook
+
+    # The `country_codes` specified in the `/link/token/create` call.
+    # @return [Array[CountryCode]]
+    attr_accessor :country_codes
+
+    # The `language` specified in the `/link/token/create` call.
+    # @return [String]
+    attr_accessor :language
+
+    # The `account_filters` specified in the original call to
+    # `/link/token/create`.
+    # @return [AccountFiltersResponse]
+    attr_accessor :account_filters
+
+    # The `redirect_uri` specified in the `/link/token/create` call.
+    # @return [String]
+    attr_accessor :redirect_uri
+
+    # The `client_name` specified in the `/link/token/create` call.
+    # @return [String]
+    attr_accessor :client_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['initial_products'] = 'initial_products'
+      @_hash['webhook'] = 'webhook'
+      @_hash['country_codes'] = 'country_codes'
+      @_hash['language'] = 'language'
+      @_hash['account_filters'] = 'account_filters'
+      @_hash['redirect_uri'] = 'redirect_uri'
+      @_hash['client_name'] = 'client_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_filters
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        webhook
+        language
+        redirect_uri
+        client_name
+      ]
+    end
+
+    def initialize(initial_products:, webhook:, country_codes:, language:,
+                   redirect_uri:, client_name:, account_filters: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @initial_products = initial_products
+      @webhook = webhook
+      @country_codes = country_codes
+      @language = language
+      @account_filters = account_filters unless account_filters == SKIP
+      @redirect_uri = redirect_uri
+      @client_name = client_name
+      @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.
+      initial_products =
+        hash.key?('initial_products') ? hash['initial_products'] : nil
+      webhook = hash.key?('webhook') ? hash['webhook'] : nil
+      country_codes = hash.key?('country_codes') ? hash['country_codes'] : nil
+      language = hash.key?('language') ? hash['language'] : nil
+      redirect_uri = hash.key?('redirect_uri') ? hash['redirect_uri'] : nil
+      client_name = hash.key?('client_name') ? hash['client_name'] : nil
+      account_filters = AccountFiltersResponse.from_hash(hash['account_filters']) if
+        hash['account_filters']
+
+      # 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.
+      LinkTokenGetMetadataResponse.new(initial_products: initial_products,
+                                       webhook: webhook,
+                                       country_codes: country_codes,
+                                       language: language,
+                                       redirect_uri: redirect_uri,
+                                       client_name: client_name,
+                                       account_filters: account_filters,
+                                       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} initial_products: #{@initial_products}, webhook: #{@webhook},"\
+      " country_codes: #{@country_codes}, language: #{@language}, account_filters:"\
+      " #{@account_filters}, redirect_uri: #{@redirect_uri}, client_name: #{@client_name},"\
+      " 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} initial_products: #{@initial_products.inspect}, webhook:"\
+      " #{@webhook.inspect}, country_codes: #{@country_codes.inspect}, language:"\
+      " #{@language.inspect}, account_filters: #{@account_filters.inspect}, redirect_uri:"\
+      " #{@redirect_uri.inspect}, client_name: #{@client_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/link_token_get_request.rb

@@ -0,0 +1,97 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # LinkTokenGetRequest defines the request schema for `/link/token/get`
+  class LinkTokenGetRequest < 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
+
+    # A `link_token` from a previous invocation of `/link/token/create`
+    # @return [String]
+    attr_accessor :link_token
+
+    # 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['link_token'] = 'link_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(link_token:, client_id: SKIP, secret: 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
+      @link_token = link_token
+      @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.
+      link_token = hash.key?('link_token') ? hash['link_token'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : 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.
+      LinkTokenGetRequest.new(link_token: link_token,
+                              client_id: client_id,
+                              secret: secret,
+                              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}, link_token: #{@link_token},"\
+      " 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}, link_token:"\
+      " #{@link_token.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/link_token_get_response.rb

@@ -0,0 +1,132 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # LinkTokenGetResponse defines the response schema for `/link/token/get`
+  class LinkTokenGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A `link_token`, which can be supplied to Link in order to initialize it
+    # and receive a `public_token`, which can be exchanged for an
+    # `access_token`.
+    # @return [String]
+    attr_accessor :link_token
+
+    # The creation timestamp for the `link_token`, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The expiration timestamp for the `link_token`, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :expiration
+
+    # An object specifying the arguments originally provided to the
+    # `/link/token/create` call.
+    # @return [LinkTokenGetMetadataResponse]
+    attr_accessor :metadata
+
+    # 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['link_token'] = 'link_token'
+      @_hash['created_at'] = 'created_at'
+      @_hash['expiration'] = 'expiration'
+      @_hash['metadata'] = 'metadata'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        created_at
+        expiration
+      ]
+    end
+
+    def initialize(link_token:, created_at:, expiration:, metadata:,
+                   request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @link_token = link_token
+      @created_at = created_at
+      @expiration = expiration
+      @metadata = metadata
+      @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.
+      link_token = hash.key?('link_token') ? hash['link_token'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      expiration = if hash.key?('expiration')
+                     (DateTimeHelper.from_rfc3339(hash['expiration']) if hash['expiration'])
+                   end
+      metadata = LinkTokenGetMetadataResponse.from_hash(hash['metadata']) if hash['metadata']
+      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.
+      LinkTokenGetResponse.new(link_token: link_token,
+                               created_at: created_at,
+                               expiration: expiration,
+                               metadata: metadata,
+                               request_id: request_id,
+                               additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_expiration
+      DateTimeHelper.to_rfc3339(expiration)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} link_token: #{@link_token}, created_at: #{@created_at}, expiration:"\
+      " #{@expiration}, metadata: #{@metadata}, 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} link_token: #{@link_token.inspect}, created_at: #{@created_at.inspect},"\
+      " expiration: #{@expiration.inspect}, metadata: #{@metadata.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/loan.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 `loan`-type accounts
+  class Loan < 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.
+      Loan.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

data/lib/plaid/models/loan_account.rb

@@ -0,0 +1,173 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A loan type account. Supported products for `loan` accounts are: Balance,
+  # Liabilities, and Transactions.
+  class LoanAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Auto loan
+    # @return [String]
+    attr_accessor :auto
+
+    # Business loan
+    # @return [String]
+    attr_accessor :business
+
+    # Commercial loan
+    # @return [String]
+    attr_accessor :commercial
+
+    # Construction loan
+    # @return [String]
+    attr_accessor :construction
+
+    # Consumer loan
+    # @return [String]
+    attr_accessor :consumer
+
+    # Home Equity Line of Credit (HELOC)
+    # @return [String]
+    attr_accessor :home_equity
+
+    # General loan
+    # @return [String]
+    attr_accessor :loan
+
+    # Mortgage loan
+    # @return [String]
+    attr_accessor :mortgage
+
+    # Pre-approved overdraft account, usually tied to a checking account
+    # @return [String]
+    attr_accessor :overdraft
+
+    # Pre-approved line of credit
+    # @return [String]
+    attr_accessor :line_of_credit
+
+    # Student loan
+    # @return [String]
+    attr_accessor :student
+
+    # Other loan type or unknown loan type
+    # @return [String]
+    attr_accessor :other
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto'] = 'auto'
+      @_hash['business'] = 'business'
+      @_hash['commercial'] = 'commercial'
+      @_hash['construction'] = 'construction'
+      @_hash['consumer'] = 'consumer'
+      @_hash['home_equity'] = 'home equity'
+      @_hash['loan'] = 'loan'
+      @_hash['mortgage'] = 'mortgage'
+      @_hash['overdraft'] = 'overdraft'
+      @_hash['line_of_credit'] = 'line of credit'
+      @_hash['student'] = 'student'
+      @_hash['other'] = 'other'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auto:, business:, commercial:, construction:, consumer:,
+                   home_equity:, loan:, mortgage:, overdraft:, line_of_credit:,
+                   student:, other:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @auto = auto
+      @business = business
+      @commercial = commercial
+      @construction = construction
+      @consumer = consumer
+      @home_equity = home_equity
+      @loan = loan
+      @mortgage = mortgage
+      @overdraft = overdraft
+      @line_of_credit = line_of_credit
+      @student = student
+      @other = other
+      @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.
+      auto = hash.key?('auto') ? hash['auto'] : nil
+      business = hash.key?('business') ? hash['business'] : nil
+      commercial = hash.key?('commercial') ? hash['commercial'] : nil
+      construction = hash.key?('construction') ? hash['construction'] : nil
+      consumer = hash.key?('consumer') ? hash['consumer'] : nil
+      home_equity = hash.key?('home equity') ? hash['home equity'] : nil
+      loan = hash.key?('loan') ? hash['loan'] : nil
+      mortgage = hash.key?('mortgage') ? hash['mortgage'] : nil
+      overdraft = hash.key?('overdraft') ? hash['overdraft'] : nil
+      line_of_credit =
+        hash.key?('line of credit') ? hash['line of credit'] : nil
+      student = hash.key?('student') ? hash['student'] : nil
+      other = hash.key?('other') ? hash['other'] : 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.
+      LoanAccount.new(auto: auto,
+                      business: business,
+                      commercial: commercial,
+                      construction: construction,
+                      consumer: consumer,
+                      home_equity: home_equity,
+                      loan: loan,
+                      mortgage: mortgage,
+                      overdraft: overdraft,
+                      line_of_credit: line_of_credit,
+                      student: student,
+                      other: other,
+                      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} auto: #{@auto}, business: #{@business}, commercial: #{@commercial},"\
+      " construction: #{@construction}, consumer: #{@consumer}, home_equity: #{@home_equity},"\
+      " loan: #{@loan}, mortgage: #{@mortgage}, overdraft: #{@overdraft}, line_of_credit:"\
+      " #{@line_of_credit}, student: #{@student}, other: #{@other}, 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} auto: #{@auto.inspect}, business: #{@business.inspect}, commercial:"\
+      " #{@commercial.inspect}, construction: #{@construction.inspect}, consumer:"\
+      " #{@consumer.inspect}, home_equity: #{@home_equity.inspect}, loan: #{@loan.inspect},"\
+      " mortgage: #{@mortgage.inspect}, overdraft: #{@overdraft.inspect}, line_of_credit:"\
+      " #{@line_of_credit.inspect}, student: #{@student.inspect}, other: #{@other.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/loan_filter.rb

@@ -0,0 +1,78 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A filter to apply to `loan`-type accounts
+  class LoanFilter < 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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_subtypes:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_subtypes = account_subtypes
+      @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'] : 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.
+      LoanFilter.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