apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/signal_return_report_response.rb

@@ -0,0 +1,77 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SignalReturnReportResponse defines the response schema for
+  # `/signal/return/report`
+  class SignalReturnReportResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['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(request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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.
+      SignalReturnReportResponse.new(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} 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} request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/signal_user.rb

@@ -0,0 +1,111 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Details about the end user initiating the transaction (i.e., the account
+  # holder).
+  class SignalUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The user's legal name
+    # @return [SignalPersonName]
+    attr_accessor :name
+
+    # The user's phone number, in E.164 format: +{countrycode}{number}. For
+    # example: "+14151234567"
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The user's email address.
+    # @return [String]
+    attr_accessor :email_address
+
+    # Data about the components comprising an address.
+    # @return [AddressData1]
+    attr_accessor :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['email_address'] = 'email_address'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        phone_number
+        email_address
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        phone_number
+        email_address
+      ]
+    end
+
+    def initialize(name: SKIP, phone_number: SKIP, email_address: SKIP,
+                   address: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @address = address unless address == 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.
+      name = SignalPersonName.from_hash(hash['name']) if hash['name']
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      address = AddressData1.from_hash(hash['address']) if hash['address']
+
+      # 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.
+      SignalUser.new(name: name,
+                     phone_number: phone_number,
+                     email_address: email_address,
+                     address: address,
+                     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} name: #{@name}, phone_number: #{@phone_number}, email_address:"\
+      " #{@email_address}, address: #{@address}, 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} name: #{@name.inspect}, phone_number: #{@phone_number.inspect},"\
+      " email_address: #{@email_address.inspect}, address: #{@address.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/standalone_account_type.rb

@@ -0,0 +1,115 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The schema below describes the various `types` and corresponding `subtypes`
+  # that Plaid recognizes and reports for financial institution accounts.
+  class StandaloneAccountType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An account type holding cash, in which funds are deposited. Supported
+    # products for `depository` accounts are: Auth, Balance, Transactions,
+    # Identity, Payment Initiation, and Assets.
+    # @return [DepositoryAccount]
+    attr_accessor :depository
+
+    # A credit card type account. Supported products for `credit` accounts are:
+    # Balance, Transactions, Identity, and Liabilities.
+    # @return [CreditAccount]
+    attr_accessor :credit
+
+    # A loan type account. Supported products for `loan` accounts are: Balance,
+    # Liabilities, and Transactions.
+    # @return [LoanAccount]
+    attr_accessor :loan
+
+    # An investment account. Supported products for `investment` accounts are:
+    # Balance and Investments.
+    # @return [InvestmentAccountSubtype]
+    attr_accessor :investment
+
+    # Other or unknown account type. Supported products for `other` accounts
+    # are: Balance, Transactions, Identity, and Assets.
+    # @return [String]
+    attr_accessor :other
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['depository'] = 'depository'
+      @_hash['credit'] = 'credit'
+      @_hash['loan'] = 'loan'
+      @_hash['investment'] = 'investment'
+      @_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(depository:, credit:, loan:, investment:, other:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @depository = depository
+      @credit = credit
+      @loan = loan
+      @investment = investment
+      @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.
+      depository = DepositoryAccount.from_hash(hash['depository']) if hash['depository']
+      credit = CreditAccount.from_hash(hash['credit']) if hash['credit']
+      loan = LoanAccount.from_hash(hash['loan']) if hash['loan']
+      investment = InvestmentAccountSubtype.from_hash(hash['investment']) if hash['investment']
+      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.
+      StandaloneAccountType.new(depository: depository,
+                                credit: credit,
+                                loan: loan,
+                                investment: investment,
+                                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} depository: #{@depository}, credit: #{@credit}, loan: #{@loan}, investment:"\
+      " #{@investment}, 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} depository: #{@depository.inspect}, credit: #{@credit.inspect}, loan:"\
+      " #{@loan.inspect}, investment: #{@investment.inspect}, other: #{@other.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/standalone_currency_code_list.rb

@@ -0,0 +1,86 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The following currency codes are supported by Plaid.
+  class StandaloneCurrencyCodeList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Plaid supports all ISO 4217 currency codes.
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # List of unofficial currency codes
+    # @return [UnofficialCurrencyCodeList]
+    attr_accessor :unofficial_currency_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['unofficial_currency_code'] = 'unofficial_currency_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(iso_currency_code:, unofficial_currency_code:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @iso_currency_code = iso_currency_code
+      @unofficial_currency_code = unofficial_currency_code
+      @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.
+      iso_currency_code =
+        hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
+      if hash['unofficial_currency_code']
+        unofficial_currency_code = UnofficialCurrencyCodeList.from_hash(hash['unofficial_currency_code'])
+      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.
+      StandaloneCurrencyCodeList.new(iso_currency_code: iso_currency_code,
+                                     unofficial_currency_code: unofficial_currency_code,
+                                     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} iso_currency_code: #{@iso_currency_code}, unofficial_currency_code:"\
+      " #{@unofficial_currency_code}, 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} iso_currency_code: #{@iso_currency_code.inspect}, unofficial_currency_code:"\
+      " #{@unofficial_currency_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/standalone_investment_transaction_type.rb

@@ -0,0 +1,119 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Valid values for investment transaction types and subtypes. Note that
+  # transactions representing inflow of cash will appear as negative amounts,
+  # outflow of cash will appear as positive amounts.
+  class StandaloneInvestmentTransactionType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Buying an investment
+    # @return [BuyType]
+    attr_accessor :buy
+
+    # Selling an investment
+    # @return [SellType]
+    attr_accessor :sell
+
+    # A cancellation of a pending transaction
+    # @return [String]
+    attr_accessor :cancel
+
+    # Activity that modifies a cash position
+    # @return [CashType]
+    attr_accessor :cash
+
+    # Fees on the account, e.g. commission, bookkeeping, options-related.
+    # @return [FeeType]
+    attr_accessor :fee
+
+    # Activity that modifies a position, but not through buy/sell activity e.g.
+    # options exercise, portfolio transfer
+    # @return [TransferType]
+    attr_accessor :transfer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['buy'] = 'buy'
+      @_hash['sell'] = 'sell'
+      @_hash['cancel'] = 'cancel'
+      @_hash['cash'] = 'cash'
+      @_hash['fee'] = 'fee'
+      @_hash['transfer'] = 'transfer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(buy:, sell:, cancel:, cash:, fee:, transfer:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @buy = buy
+      @sell = sell
+      @cancel = cancel
+      @cash = cash
+      @fee = fee
+      @transfer = transfer
+      @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.
+      buy = BuyType.from_hash(hash['buy']) if hash['buy']
+      sell = SellType.from_hash(hash['sell']) if hash['sell']
+      cancel = hash.key?('cancel') ? hash['cancel'] : nil
+      cash = CashType.from_hash(hash['cash']) if hash['cash']
+      fee = FeeType.from_hash(hash['fee']) if hash['fee']
+      transfer = TransferType.from_hash(hash['transfer']) if hash['transfer']
+
+      # 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.
+      StandaloneInvestmentTransactionType.new(buy: buy,
+                                              sell: sell,
+                                              cancel: cancel,
+                                              cash: cash,
+                                              fee: fee,
+                                              transfer: transfer,
+                                              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} buy: #{@buy}, sell: #{@sell}, cancel: #{@cancel}, cash: #{@cash}, fee:"\
+      " #{@fee}, transfer: #{@transfer}, 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} buy: #{@buy.inspect}, sell: #{@sell.inspect}, cancel: #{@cancel.inspect},"\
+      " cash: #{@cash.inspect}, fee: #{@fee.inspect}, transfer: #{@transfer.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/state.rb

@@ -0,0 +1,49 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The state, or status, of the deposit switch. - `initialized` – The deposit
+  # switch has been initialized with the user entering the information required
+  # to submit the deposit switch request. - `processing` – The deposit switch
+  # request has been submitted and is being processed. - `completed` – The
+  # user's employer has fulfilled the deposit switch request. - `error` – There
+  # was an error processing the deposit switch request.
+  class State
+    STATE = [
+      # TODO: Write general description for INITIALIZED
+      INITIALIZED = 'initialized'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'processing'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'error'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = INITIALIZED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'initialized' then INITIALIZED
+      when 'processing' then PROCESSING
+      when 'completed' then COMPLETED
+      when 'error' then ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/status.rb

@@ -0,0 +1,41 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # `HEALTHY`: the majority of requests are successful `DEGRADED`: only some
+  # requests are successful `DOWN`: all requests are failing
+  class Status
+    STATUS = [
+      # TODO: Write general description for HEALTHY
+      HEALTHY = 'HEALTHY'.freeze,
+
+      # TODO: Write general description for DEGRADED
+      DEGRADED = 'DEGRADED'.freeze,
+
+      # TODO: Write general description for DOWN
+      DOWN = 'DOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = HEALTHY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'healthy' then HEALTHY
+      when 'degraded' then DEGRADED
+      when 'down' then DOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/status1.rb

@@ -0,0 +1,48 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The status of the incident.
+  class Status1
+    STATUS1 = [
+      # TODO: Write general description for INVESTIGATING
+      INVESTIGATING = 'INVESTIGATING'.freeze,
+
+      # TODO: Write general description for IDENTIFIED
+      IDENTIFIED = 'IDENTIFIED'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'SCHEDULED'.freeze,
+
+      # TODO: Write general description for RESOLVED
+      RESOLVED = 'RESOLVED'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = INVESTIGATING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'investigating' then INVESTIGATING
+      when 'identified' then IDENTIFIED
+      when 'scheduled' then SCHEDULED
+      when 'resolved' then RESOLVED
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/status2.rb

@@ -0,0 +1,49 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The status of the refund. `PROCESSING`: The refund is currently being
+  # processed. The refund will automatically exit this state when processing is
+  # complete. `INITIATED`: The refund has been successfully initiated.
+  # `EXECUTED`: Indicates that the refund has been successfully executed.
+  # `FAILED`: The refund has failed to be executed. This error is retryable once
+  # the root cause is resolved.
+  class Status2
+    STATUS2 = [
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'PROCESSING'.freeze,
+
+      # TODO: Write general description for EXECUTED
+      EXECUTED = 'EXECUTED'.freeze,
+
+      # TODO: Write general description for INITIATED
+      INITIATED = 'INITIATED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PROCESSING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'processing' then PROCESSING
+      when 'executed' then EXECUTED
+      when 'initiated' then INITIATED
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
+  end
+end