apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/external_payment_schedule_get.rb

@@ -0,0 +1,140 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The schedule that the payment will be executed on. If a schedule is
+  # provided, the payment is automatically set up as a standing order. If no
+  # schedule is specified, the payment will be executed only once.
+  class ExternalPaymentScheduleGet < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The frequency interval of the payment.
+    # @return [PaymentScheduleInterval]
+    attr_accessor :interval
+
+    # The day of the interval on which to schedule the payment.
+    # If the payment interval is weekly, `interval_execution_day` should be an
+    # integer from 1 (Monday) to 7 (Sunday).
+    # If the payment interval is monthly, `interval_execution_day` should be an
+    # integer indicating which day of the month to make the payment on. Integers
+    # from 1 to 28 can be used to make a payment on that day of the month.
+    # Negative integers from -1 to -5 can be used to make a payment relative to
+    # the end of the month. To make a payment on the last day of the month, use
+    # -1; to make the payment on the second-to-last day, use -2, and so on.
+    # @return [Integer]
+    attr_accessor :interval_execution_day
+
+    # A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (YYYY-MM-DD). Standing order payments will begin on the first
+    # `interval_execution_day` on or after the `start_date`.
+    # If the first `interval_execution_day` on or after the start date is also
+    # the same day that `/payment_initiation/payment/create` was called, the
+    # bank *may* make the first payment on that day, but it is not guaranteed to
+    # do so.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (YYYY-MM-DD). Standing order payments will end on the last
+    # `interval_execution_day` on or before the `end_date`.
+    # If the only `interval_execution_day` between the start date and the end
+    # date (inclusive) is also the same day that
+    # `/payment_initiation/payment/create` was called, the bank *may* make a
+    # payment on that day, but it is not guaranteed to do so.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The start date sent to the bank after adjusting for holidays or weekends.
+    # Will be provided in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (YYYY-MM-DD). If the start date did not require adjustment, this field
+    # will be `null`.
+    # @return [Date]
+    attr_accessor :adjusted_start_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['interval'] = 'interval'
+      @_hash['interval_execution_day'] = 'interval_execution_day'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['adjusted_start_date'] = 'adjusted_start_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+        adjusted_start_date
+      ]
+    end
+
+    def initialize(interval:, interval_execution_day:, start_date:, end_date:,
+                   adjusted_start_date:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @interval = interval
+      @interval_execution_day = interval_execution_day
+      @start_date = start_date
+      @end_date = end_date
+      @adjusted_start_date = adjusted_start_date
+      @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.
+      interval = hash.key?('interval') ? hash['interval'] : nil
+      interval_execution_day =
+        hash.key?('interval_execution_day') ? hash['interval_execution_day'] : nil
+      start_date = hash.key?('start_date') ? hash['start_date'] : nil
+      end_date = hash.key?('end_date') ? hash['end_date'] : nil
+      adjusted_start_date =
+        hash.key?('adjusted_start_date') ? hash['adjusted_start_date'] : 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.
+      ExternalPaymentScheduleGet.new(interval: interval,
+                                     interval_execution_day: interval_execution_day,
+                                     start_date: start_date,
+                                     end_date: end_date,
+                                     adjusted_start_date: adjusted_start_date,
+                                     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} interval: #{@interval}, interval_execution_day: #{@interval_execution_day},"\
+      " start_date: #{@start_date}, end_date: #{@end_date}, adjusted_start_date:"\
+      " #{@adjusted_start_date}, 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} interval: #{@interval.inspect}, interval_execution_day:"\
+      " #{@interval_execution_day.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, adjusted_start_date: #{@adjusted_start_date.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/external_payment_schedule_request.rb

@@ -0,0 +1,144 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The schedule that the payment will be executed on. If a schedule is
+  # provided, the payment is automatically set up as a standing order. If no
+  # schedule is specified, the payment will be executed only once.
+  class ExternalPaymentScheduleRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The frequency interval of the payment.
+    # @return [PaymentScheduleInterval]
+    attr_accessor :interval
+
+    # The day of the interval on which to schedule the payment.
+    # If the payment interval is weekly, `interval_execution_day` should be an
+    # integer from 1 (Monday) to 7 (Sunday).
+    # If the payment interval is monthly, `interval_execution_day` should be an
+    # integer indicating which day of the month to make the payment on. Integers
+    # from 1 to 28 can be used to make a payment on that day of the month.
+    # Negative integers from -1 to -5 can be used to make a payment relative to
+    # the end of the month. To make a payment on the last day of the month, use
+    # -1; to make the payment on the second-to-last day, use -2, and so on.
+    # @return [Integer]
+    attr_accessor :interval_execution_day
+
+    # A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (YYYY-MM-DD). Standing order payments will begin on the first
+    # `interval_execution_day` on or after the `start_date`.
+    # If the first `interval_execution_day` on or after the start date is also
+    # the same day that `/payment_initiation/payment/create` was called, the
+    # bank *may* make the first payment on that day, but it is not guaranteed to
+    # do so.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (YYYY-MM-DD). Standing order payments will end on the last
+    # `interval_execution_day` on or before the `end_date`.
+    # If the only `interval_execution_day` between the start date and the end
+    # date (inclusive) is also the same day that
+    # `/payment_initiation/payment/create` was called, the bank *may* make a
+    # payment on that day, but it is not guaranteed to do so.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The start date sent to the bank after adjusting for holidays or weekends.
+    # Will be provided in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (YYYY-MM-DD). If the start date did not require adjustment, this field
+    # will be `null`.
+    # @return [Date]
+    attr_accessor :adjusted_start_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['interval'] = 'interval'
+      @_hash['interval_execution_day'] = 'interval_execution_day'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['adjusted_start_date'] = 'adjusted_start_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        end_date
+        adjusted_start_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+        adjusted_start_date
+      ]
+    end
+
+    def initialize(interval:, interval_execution_day:, start_date:,
+                   end_date: SKIP, adjusted_start_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @interval = interval
+      @interval_execution_day = interval_execution_day
+      @start_date = start_date
+      @end_date = end_date unless end_date == SKIP
+      @adjusted_start_date = adjusted_start_date unless adjusted_start_date == 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.
+      interval = hash.key?('interval') ? hash['interval'] : nil
+      interval_execution_day =
+        hash.key?('interval_execution_day') ? hash['interval_execution_day'] : nil
+      start_date = hash.key?('start_date') ? hash['start_date'] : nil
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      adjusted_start_date =
+        hash.key?('adjusted_start_date') ? hash['adjusted_start_date'] : 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.
+      ExternalPaymentScheduleRequest.new(interval: interval,
+                                         interval_execution_day: interval_execution_day,
+                                         start_date: start_date,
+                                         end_date: end_date,
+                                         adjusted_start_date: adjusted_start_date,
+                                         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} interval: #{@interval}, interval_execution_day: #{@interval_execution_day},"\
+      " start_date: #{@start_date}, end_date: #{@end_date}, adjusted_start_date:"\
+      " #{@adjusted_start_date}, 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} interval: #{@interval.inspect}, interval_execution_day:"\
+      " #{@interval_execution_day.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, adjusted_start_date: #{@adjusted_start_date.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/fee_type.rb

@@ -0,0 +1,287 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fees on the account, e.g. commission, bookkeeping, options-related.
+  class FeeType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fees paid for account maintenance
+    # @return [String]
+    attr_accessor :account_fee
+
+    # Increase or decrease in quantity of item
+    # @return [String]
+    attr_accessor :adjustment
+
+    # Inflow of cash from a dividend
+    # @return [String]
+    attr_accessor :dividend
+
+    # Inflow of cash from interest
+    # @return [String]
+    attr_accessor :interest
+
+    # Inflow of cash from interest receivable
+    # @return [String]
+    attr_accessor :interest_receivable
+
+    # Long-term capital gain received as cash
+    # @return [String]
+    attr_accessor :long_term_capital_gain
+
+    # Fees paid for legal charges or services
+    # @return [String]
+    attr_accessor :legal_fee
+
+    # Fees paid for investment management of a mutual fund or other pooled
+    # investment vehicle
+    # @return [String]
+    attr_accessor :management_fee
+
+    # Fees paid for maintaining margin debt
+    # @return [String]
+    attr_accessor :margin_expense
+
+    # Inflow of cash from a non-qualified dividend
+    # @return [String]
+    attr_accessor :non_qualified_dividend
+
+    # Taxes paid on behalf of the investor for non-residency in investment
+    # jurisdiction
+    # @return [String]
+    attr_accessor :non_resident_tax
+
+    # Inflow of cash from a qualified dividend
+    # @return [String]
+    attr_accessor :qualified_dividend
+
+    # Repayment of loan principal
+    # @return [String]
+    attr_accessor :return_of_principal
+
+    # Short-term capital gain received as cash
+    # @return [String]
+    attr_accessor :short_term_capital_gain
+
+    # Inflow of stock from a distribution
+    # @return [String]
+    attr_accessor :stock_distribution
+
+    # Taxes paid on behalf of the investor
+    # @return [String]
+    attr_accessor :tax
+
+    # Taxes withheld on behalf of the customer
+    # @return [String]
+    attr_accessor :tax_withheld
+
+    # Fees incurred for transfer of a holding or account
+    # @return [String]
+    attr_accessor :transfer_fee
+
+    # Fees related to adminstration of a trust account
+    # @return [String]
+    attr_accessor :trust_fee
+
+    # Unqualified capital gain received as cash
+    # @return [String]
+    attr_accessor :unqualified_gain
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_fee'] = 'account fee'
+      @_hash['adjustment'] = 'adjustment'
+      @_hash['dividend'] = 'dividend'
+      @_hash['interest'] = 'interest'
+      @_hash['interest_receivable'] = 'interest receivable'
+      @_hash['long_term_capital_gain'] = 'long-term capital gain'
+      @_hash['legal_fee'] = 'legal fee'
+      @_hash['management_fee'] = 'management fee'
+      @_hash['margin_expense'] = 'margin expense'
+      @_hash['non_qualified_dividend'] = 'non-qualified dividend'
+      @_hash['non_resident_tax'] = 'non-resident tax'
+      @_hash['qualified_dividend'] = 'qualified dividend'
+      @_hash['return_of_principal'] = 'return of principal'
+      @_hash['short_term_capital_gain'] = 'short-term capital gain'
+      @_hash['stock_distribution'] = 'stock distribution'
+      @_hash['tax'] = 'tax'
+      @_hash['tax_withheld'] = 'tax withheld'
+      @_hash['transfer_fee'] = 'transfer fee'
+      @_hash['trust_fee'] = 'trust fee'
+      @_hash['unqualified_gain'] = 'unqualified gain'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_fee
+        adjustment
+        dividend
+        interest
+        interest_receivable
+        long_term_capital_gain
+        legal_fee
+        management_fee
+        margin_expense
+        non_qualified_dividend
+        non_resident_tax
+        qualified_dividend
+        return_of_principal
+        short_term_capital_gain
+        stock_distribution
+        tax
+        tax_withheld
+        transfer_fee
+        trust_fee
+        unqualified_gain
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_fee: SKIP, adjustment: SKIP, dividend: SKIP,
+                   interest: SKIP, interest_receivable: SKIP,
+                   long_term_capital_gain: SKIP, legal_fee: SKIP,
+                   management_fee: SKIP, margin_expense: SKIP,
+                   non_qualified_dividend: SKIP, non_resident_tax: SKIP,
+                   qualified_dividend: SKIP, return_of_principal: SKIP,
+                   short_term_capital_gain: SKIP, stock_distribution: SKIP,
+                   tax: SKIP, tax_withheld: SKIP, transfer_fee: SKIP,
+                   trust_fee: SKIP, unqualified_gain: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_fee = account_fee unless account_fee == SKIP
+      @adjustment = adjustment unless adjustment == SKIP
+      @dividend = dividend unless dividend == SKIP
+      @interest = interest unless interest == SKIP
+      @interest_receivable = interest_receivable unless interest_receivable == SKIP
+      @long_term_capital_gain = long_term_capital_gain unless long_term_capital_gain == SKIP
+      @legal_fee = legal_fee unless legal_fee == SKIP
+      @management_fee = management_fee unless management_fee == SKIP
+      @margin_expense = margin_expense unless margin_expense == SKIP
+      @non_qualified_dividend = non_qualified_dividend unless non_qualified_dividend == SKIP
+      @non_resident_tax = non_resident_tax unless non_resident_tax == SKIP
+      @qualified_dividend = qualified_dividend unless qualified_dividend == SKIP
+      @return_of_principal = return_of_principal unless return_of_principal == SKIP
+      @short_term_capital_gain = short_term_capital_gain unless short_term_capital_gain == SKIP
+      @stock_distribution = stock_distribution unless stock_distribution == SKIP
+      @tax = tax unless tax == SKIP
+      @tax_withheld = tax_withheld unless tax_withheld == SKIP
+      @transfer_fee = transfer_fee unless transfer_fee == SKIP
+      @trust_fee = trust_fee unless trust_fee == SKIP
+      @unqualified_gain = unqualified_gain unless unqualified_gain == 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_fee = hash.key?('account fee') ? hash['account fee'] : SKIP
+      adjustment = hash.key?('adjustment') ? hash['adjustment'] : SKIP
+      dividend = hash.key?('dividend') ? hash['dividend'] : SKIP
+      interest = hash.key?('interest') ? hash['interest'] : SKIP
+      interest_receivable =
+        hash.key?('interest receivable') ? hash['interest receivable'] : SKIP
+      long_term_capital_gain =
+        hash.key?('long-term capital gain') ? hash['long-term capital gain'] : SKIP
+      legal_fee = hash.key?('legal fee') ? hash['legal fee'] : SKIP
+      management_fee =
+        hash.key?('management fee') ? hash['management fee'] : SKIP
+      margin_expense =
+        hash.key?('margin expense') ? hash['margin expense'] : SKIP
+      non_qualified_dividend =
+        hash.key?('non-qualified dividend') ? hash['non-qualified dividend'] : SKIP
+      non_resident_tax =
+        hash.key?('non-resident tax') ? hash['non-resident tax'] : SKIP
+      qualified_dividend =
+        hash.key?('qualified dividend') ? hash['qualified dividend'] : SKIP
+      return_of_principal =
+        hash.key?('return of principal') ? hash['return of principal'] : SKIP
+      short_term_capital_gain =
+        hash.key?('short-term capital gain') ? hash['short-term capital gain'] : SKIP
+      stock_distribution =
+        hash.key?('stock distribution') ? hash['stock distribution'] : SKIP
+      tax = hash.key?('tax') ? hash['tax'] : SKIP
+      tax_withheld = hash.key?('tax withheld') ? hash['tax withheld'] : SKIP
+      transfer_fee = hash.key?('transfer fee') ? hash['transfer fee'] : SKIP
+      trust_fee = hash.key?('trust fee') ? hash['trust fee'] : SKIP
+      unqualified_gain =
+        hash.key?('unqualified gain') ? hash['unqualified gain'] : 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.
+      FeeType.new(account_fee: account_fee,
+                  adjustment: adjustment,
+                  dividend: dividend,
+                  interest: interest,
+                  interest_receivable: interest_receivable,
+                  long_term_capital_gain: long_term_capital_gain,
+                  legal_fee: legal_fee,
+                  management_fee: management_fee,
+                  margin_expense: margin_expense,
+                  non_qualified_dividend: non_qualified_dividend,
+                  non_resident_tax: non_resident_tax,
+                  qualified_dividend: qualified_dividend,
+                  return_of_principal: return_of_principal,
+                  short_term_capital_gain: short_term_capital_gain,
+                  stock_distribution: stock_distribution,
+                  tax: tax,
+                  tax_withheld: tax_withheld,
+                  transfer_fee: transfer_fee,
+                  trust_fee: trust_fee,
+                  unqualified_gain: unqualified_gain,
+                  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_fee: #{@account_fee}, adjustment: #{@adjustment}, dividend:"\
+      " #{@dividend}, interest: #{@interest}, interest_receivable: #{@interest_receivable},"\
+      " long_term_capital_gain: #{@long_term_capital_gain}, legal_fee: #{@legal_fee},"\
+      " management_fee: #{@management_fee}, margin_expense: #{@margin_expense},"\
+      " non_qualified_dividend: #{@non_qualified_dividend}, non_resident_tax:"\
+      " #{@non_resident_tax}, qualified_dividend: #{@qualified_dividend}, return_of_principal:"\
+      " #{@return_of_principal}, short_term_capital_gain: #{@short_term_capital_gain},"\
+      " stock_distribution: #{@stock_distribution}, tax: #{@tax}, tax_withheld: #{@tax_withheld},"\
+      " transfer_fee: #{@transfer_fee}, trust_fee: #{@trust_fee}, unqualified_gain:"\
+      " #{@unqualified_gain}, 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_fee: #{@account_fee.inspect}, adjustment: #{@adjustment.inspect},"\
+      " dividend: #{@dividend.inspect}, interest: #{@interest.inspect}, interest_receivable:"\
+      " #{@interest_receivable.inspect}, long_term_capital_gain:"\
+      " #{@long_term_capital_gain.inspect}, legal_fee: #{@legal_fee.inspect}, management_fee:"\
+      " #{@management_fee.inspect}, margin_expense: #{@margin_expense.inspect},"\
+      " non_qualified_dividend: #{@non_qualified_dividend.inspect}, non_resident_tax:"\
+      " #{@non_resident_tax.inspect}, qualified_dividend: #{@qualified_dividend.inspect},"\
+      " return_of_principal: #{@return_of_principal.inspect}, short_term_capital_gain:"\
+      " #{@short_term_capital_gain.inspect}, stock_distribution: #{@stock_distribution.inspect},"\
+      " tax: #{@tax.inspect}, tax_withheld: #{@tax_withheld.inspect}, transfer_fee:"\
+      " #{@transfer_fee.inspect}, trust_fee: #{@trust_fee.inspect}, unqualified_gain:"\
+      " #{@unqualified_gain.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end