apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/bank_transfer_type.rb

@@ -0,0 +1,38 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The type of bank transfer. This will be either `debit` or `credit`.  A
+  # `debit` indicates a transfer of money into the origination account; a
+  # `credit` indicates a transfer of money out of the origination account.
+  class BankTransferType
+    BANK_TRANSFER_TYPE = [
+      # TODO: Write general description for DEBIT
+      DEBIT = 'debit'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DEBIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'debit' then DEBIT
+      when 'credit' then CREDIT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_type1.rb

@@ -0,0 +1,38 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The type of bank transfer. This will be either `debit` or `credit`.  A
+  # `debit` indicates a transfer of money into your origination account; a
+  # `credit` indicates a transfer of money out of your origination account.
+  class BankTransferType1
+    BANK_TRANSFER_TYPE1 = [
+      # TODO: Write general description for DEBIT
+      DEBIT = 'debit'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DEBIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'debit' then DEBIT
+      when 'credit' then CREDIT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_user.rb

@@ -0,0 +1,100 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The legal name and other information for the account holder.
+  class BankTransferUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account holder’s full legal name. If the transfer description is
+    # `ccd`, this should be the business name of the account holder.
+    # @return [String]
+    attr_accessor :legal_name
+
+    # The account holder’s email.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The account holder's routing number. This field is only used in response
+    # data. Do not provide this field when making requests.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['legal_name'] = 'legal_name'
+      @_hash['email_address'] = 'email_address'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        routing_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        email_address
+      ]
+    end
+
+    def initialize(legal_name:, email_address: SKIP, routing_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @legal_name = legal_name
+      @email_address = email_address unless email_address == SKIP
+      @routing_number = routing_number unless routing_number == 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.
+      legal_name = hash.key?('legal_name') ? hash['legal_name'] : nil
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : 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.
+      BankTransferUser.new(legal_name: legal_name,
+                           email_address: email_address,
+                           routing_number: routing_number,
+                           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} legal_name: #{@legal_name}, email_address: #{@email_address},"\
+      " routing_number: #{@routing_number}, 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} legal_name: #{@legal_name.inspect}, email_address:"\
+      " #{@email_address.inspect}, routing_number: #{@routing_number.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfers_events_update_webhook.rb

@@ -0,0 +1,83 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when new bank transfer events are available. Receiving this webhook
+  # indicates you should fetch the new events from `/bank_transfer/event/sync`.
+  class BankTransfersEventsUpdateWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `BANK_TRANSFERS`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `BANK_TRANSFERS_EVENTS_UPDATE`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_type'] = 'webhook_type'
+      @_hash['webhook_code'] = 'webhook_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : 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.
+      BankTransfersEventsUpdateWebhook.new(webhook_type: webhook_type,
+                                           webhook_code: webhook_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} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/base_model.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/plaid/models/branch.rb

@@ -0,0 +1,49 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # If the user is currently serving in the US military, the branch of the
+  # military they are serving in
+  class Branch
+    BRANCH = [
+      # TODO: Write general description for ENUM_AIR_FORCE
+      ENUM_AIR_FORCE = 'AIR FORCE'.freeze,
+
+      # TODO: Write general description for ARMY
+      ARMY = 'ARMY'.freeze,
+
+      # TODO: Write general description for ENUM_COAST_GUARD
+      ENUM_COAST_GUARD = 'COAST GUARD'.freeze,
+
+      # TODO: Write general description for MARINES
+      MARINES = 'MARINES'.freeze,
+
+      # TODO: Write general description for NAVY
+      NAVY = 'NAVY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_AIR_FORCE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_air_force' then ENUM_AIR_FORCE
+      when 'army' then ARMY
+      when 'enum_coast_guard' then ENUM_COAST_GUARD
+      when 'marines' then MARINES
+      when 'navy' then NAVY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/buy_type.rb

@@ -0,0 +1,165 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Buying an investment
+  class BuyType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Assignment of short option holding
+    # @return [String]
+    attr_accessor :assignment
+
+    # Inflow of assets into a tax-advantaged account
+    # @return [String]
+    attr_accessor :contribution
+
+    # Purchase to open or increase a position
+    # @return [String]
+    attr_accessor :buy
+
+    # Purchase to close a short position
+    # @return [String]
+    attr_accessor :buy_to_cover
+
+    # Purchase using proceeds from a cash dividend
+    # @return [String]
+    attr_accessor :dividend_reinvestment
+
+    # Purchase using proceeds from a cash interest payment
+    # @return [String]
+    attr_accessor :interest_reinvestment
+
+    # Purchase using long-term capital gain cash proceeds
+    # @return [String]
+    attr_accessor :long_term_capital_gain_reinvestment
+
+    # Purchase using short-term capital gain cash proceeds
+    # @return [String]
+    attr_accessor :short_term_capital_gain_reinvestment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['assignment'] = 'assignment'
+      @_hash['contribution'] = 'contribution'
+      @_hash['buy'] = 'buy'
+      @_hash['buy_to_cover'] = 'buy to cover'
+      @_hash['dividend_reinvestment'] = 'dividend reinvestment'
+      @_hash['interest_reinvestment'] = 'interest reinvestment'
+      @_hash['long_term_capital_gain_reinvestment'] =
+        'long-term capital gain reinvestment'
+      @_hash['short_term_capital_gain_reinvestment'] =
+        'short-term capital gain reinvestment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assignment
+        contribution
+        buy
+        buy_to_cover
+        dividend_reinvestment
+        interest_reinvestment
+        long_term_capital_gain_reinvestment
+        short_term_capital_gain_reinvestment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(assignment: SKIP, contribution: SKIP, buy: SKIP,
+                   buy_to_cover: SKIP, dividend_reinvestment: SKIP,
+                   interest_reinvestment: SKIP,
+                   long_term_capital_gain_reinvestment: SKIP,
+                   short_term_capital_gain_reinvestment: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @assignment = assignment unless assignment == SKIP
+      @contribution = contribution unless contribution == SKIP
+      @buy = buy unless buy == SKIP
+      @buy_to_cover = buy_to_cover unless buy_to_cover == SKIP
+      @dividend_reinvestment = dividend_reinvestment unless dividend_reinvestment == SKIP
+      @interest_reinvestment = interest_reinvestment unless interest_reinvestment == SKIP
+      unless long_term_capital_gain_reinvestment == SKIP
+        @long_term_capital_gain_reinvestment =
+          long_term_capital_gain_reinvestment
+      end
+      unless short_term_capital_gain_reinvestment == SKIP
+        @short_term_capital_gain_reinvestment =
+          short_term_capital_gain_reinvestment
+      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.
+      assignment = hash.key?('assignment') ? hash['assignment'] : SKIP
+      contribution = hash.key?('contribution') ? hash['contribution'] : SKIP
+      buy = hash.key?('buy') ? hash['buy'] : SKIP
+      buy_to_cover = hash.key?('buy to cover') ? hash['buy to cover'] : SKIP
+      dividend_reinvestment =
+        hash.key?('dividend reinvestment') ? hash['dividend reinvestment'] : SKIP
+      interest_reinvestment =
+        hash.key?('interest reinvestment') ? hash['interest reinvestment'] : SKIP
+      long_term_capital_gain_reinvestment =
+        hash.key?('long-term capital gain reinvestment') ? hash['long-term capital gain reinvestment'] : SKIP
+      short_term_capital_gain_reinvestment =
+        hash.key?('short-term capital gain reinvestment') ? hash['short-term capital gain reinvestment'] : 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.
+      BuyType.new(assignment: assignment,
+                  contribution: contribution,
+                  buy: buy,
+                  buy_to_cover: buy_to_cover,
+                  dividend_reinvestment: dividend_reinvestment,
+                  interest_reinvestment: interest_reinvestment,
+                  long_term_capital_gain_reinvestment: long_term_capital_gain_reinvestment,
+                  short_term_capital_gain_reinvestment: short_term_capital_gain_reinvestment,
+                  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} assignment: #{@assignment}, contribution: #{@contribution}, buy: #{@buy},"\
+      " buy_to_cover: #{@buy_to_cover}, dividend_reinvestment: #{@dividend_reinvestment},"\
+      " interest_reinvestment: #{@interest_reinvestment}, long_term_capital_gain_reinvestment:"\
+      " #{@long_term_capital_gain_reinvestment}, short_term_capital_gain_reinvestment:"\
+      " #{@short_term_capital_gain_reinvestment}, 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} assignment: #{@assignment.inspect}, contribution: #{@contribution.inspect},"\
+      " buy: #{@buy.inspect}, buy_to_cover: #{@buy_to_cover.inspect}, dividend_reinvestment:"\
+      " #{@dividend_reinvestment.inspect}, interest_reinvestment:"\
+      " #{@interest_reinvestment.inspect}, long_term_capital_gain_reinvestment:"\
+      " #{@long_term_capital_gain_reinvestment.inspect}, short_term_capital_gain_reinvestment:"\
+      " #{@short_term_capital_gain_reinvestment.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/canonical_description.rb

@@ -0,0 +1,92 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Commonly used term to describe the line item.
+  class CanonicalDescription
+    CANONICAL_DESCRIPTION = [
+      # TODO: Write general description for BONUS
+      BONUS = 'BONUS'.freeze,
+
+      # TODO: Write general description for COMMISSION
+      COMMISSION = 'COMMISSION'.freeze,
+
+      # TODO: Write general description for OVERTIME
+      OVERTIME = 'OVERTIME'.freeze,
+
+      # TODO: Write general description for ENUM_PAID_TIME_OFF
+      ENUM_PAID_TIME_OFF = 'PAID TIME OFF'.freeze,
+
+      # TODO: Write general description for ENUM_REGULAR_PAY
+      ENUM_REGULAR_PAY = 'REGULAR PAY'.freeze,
+
+      # TODO: Write general description for VACATION
+      VACATION = 'VACATION'.freeze,
+
+      # TODO: Write general description for ENUM_EMPLOYEE_MEDICARE
+      ENUM_EMPLOYEE_MEDICARE = 'EMPLOYEE MEDICARE'.freeze,
+
+      # TODO: Write general description for FICA
+      FICA = 'FICA'.freeze,
+
+      # TODO: Write general description for ENUM_SOCIAL_SECURITY_EMPLOYEE_TAX
+      ENUM_SOCIAL_SECURITY_EMPLOYEE_TAX = 'SOCIAL SECURITY EMPLOYEE TAX'.freeze,
+
+      # TODO: Write general description for MEDICAL
+      MEDICAL = 'MEDICAL'.freeze,
+
+      # TODO: Write general description for VISION
+      VISION = 'VISION'.freeze,
+
+      # TODO: Write general description for DENTAL
+      DENTAL = 'DENTAL'.freeze,
+
+      # TODO: Write general description for ENUM_NET_PAY
+      ENUM_NET_PAY = 'NET PAY'.freeze,
+
+      # TODO: Write general description for TAXES
+      TAXES = 'TAXES'.freeze,
+
+      # TODO: Write general description for NOT_FOUND
+      NOT_FOUND = 'NOT_FOUND'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BONUS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bonus' then BONUS
+      when 'commission' then COMMISSION
+      when 'overtime' then OVERTIME
+      when 'enum_paid_time_off' then ENUM_PAID_TIME_OFF
+      when 'enum_regular_pay' then ENUM_REGULAR_PAY
+      when 'vacation' then VACATION
+      when 'enum_employee_medicare' then ENUM_EMPLOYEE_MEDICARE
+      when 'fica' then FICA
+      when 'enum_social_security_employee_tax' then ENUM_SOCIAL_SECURITY_EMPLOYEE_TAX
+      when 'medical' then MEDICAL
+      when 'vision' then VISION
+      when 'dental' then DENTAL
+      when 'enum_net_pay' then ENUM_NET_PAY
+      when 'taxes' then TAXES
+      when 'not_found' then NOT_FOUND
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end