apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/currency.rb

@@ -0,0 +1,37 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The ISO-4217 currency code of the payment. For standing orders, `"GBP"` must
+  # be used.
+  class Currency
+    CURRENCY = [
+      # TODO: Write general description for GBP
+      GBP = 'GBP'.freeze,
+
+      # TODO: Write general description for EUR
+      EUR = 'EUR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = GBP)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'gbp' then GBP
+      when 'eur' then EUR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/customer_initiated_return_risk.rb

@@ -0,0 +1,100 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The object contains a risk score and a risk tier that evaluate the
+  # transaction return risk of an unauthorized debit. Common return codes in
+  # this category include: “R05”, "R07", "R10", "R11", "R29". These returns
+  # typically have a return time frame of up to 60 calendar days. During this
+  # period, the customer of financial institutions can dispute a transaction as
+  # unauthorized.
+  class CustomerInitiatedReturnRisk < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A score from 0-99 that indicates the transaction return risk: a higher
+    # risk score suggests a higher return likelihood.
+    # @return [Integer]
+    attr_accessor :score
+
+    # A tier corresponding to the projected likelihood that the transaction, if
+    # initiated, will be subject to a return.
+    # In the `customer_initiated_return_risk` object, there are five risk tiers
+    # corresponding to the scores:
+    #   1: Predicted customer-initiated return incidence rate between 0.00% -
+    # 0.02%
+    #   2: Predicted customer-initiated return incidence rate between 0.02% -
+    # 0.05%
+    #   3: Predicted customer-initiated return incidence rate between 0.05% -
+    # 0.1%
+    #   4: Predicted customer-initiated return incidence rate between 0.1% -
+    # 0.5%
+    #   5: Predicted customer-initiated return incidence rate greater than 0.5%
+    # @return [Integer]
+    attr_accessor :risk_tier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['score'] = 'score'
+      @_hash['risk_tier'] = 'risk_tier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(score:, risk_tier:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @score = score
+      @risk_tier = risk_tier
+      @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.
+      score = hash.key?('score') ? hash['score'] : nil
+      risk_tier = hash.key?('risk_tier') ? hash['risk_tier'] : 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.
+      CustomerInitiatedReturnRisk.new(score: score,
+                                      risk_tier: risk_tier,
+                                      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} score: #{@score}, risk_tier: #{@risk_tier}, 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} score: #{@score.inspect}, risk_tier: #{@risk_tier.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/decision.rb

@@ -0,0 +1,48 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A decision regarding the proposed transfer. `approved` – The proposed
+  # transfer has received the end user's consent and has been approved for
+  # processing. Plaid has also reviewed the proposed transfer and has approved
+  # it for processing.  `permitted` – Plaid was unable to fetch the information
+  # required to approve or decline the proposed transfer. You may proceed with
+  # the transfer, but further review is recommended. Plaid is awaiting further
+  # instructions from the client. `declined` – Plaid reviewed the proposed
+  # transfer and declined processing. Refer to the `code` field in the
+  # `decision_rationale` object for details.
+  class Decision
+    DECISION = [
+      # TODO: Write general description for APPROVED
+      APPROVED = 'approved'.freeze,
+
+      # TODO: Write general description for PERMITTED
+      PERMITTED = 'permitted'.freeze,
+
+      # TODO: Write general description for DECLINED
+      DECLINED = 'declined'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = APPROVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'approved' then APPROVED
+      when 'permitted' then PERMITTED
+      when 'declined' then DECLINED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/deductions.rb

@@ -0,0 +1,103 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object with the deduction information found on a paystub.
+  class Deductions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Total]]
+    attr_accessor :subtotals
+
+    # TODO: Write general description for this method
+    # @return [Array[Total]]
+    attr_accessor :totals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subtotals'] = 'subtotals'
+      @_hash['totals'] = 'totals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subtotals
+        totals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subtotals: SKIP, totals: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @subtotals = subtotals unless subtotals == SKIP
+      @totals = totals unless totals == 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.
+      # Parameter is an array, so we need to iterate through it
+      subtotals = nil
+      unless hash['subtotals'].nil?
+        subtotals = []
+        hash['subtotals'].each do |structure|
+          subtotals << (Total.from_hash(structure) if structure)
+        end
+      end
+
+      subtotals = SKIP unless hash.key?('subtotals')
+      # Parameter is an array, so we need to iterate through it
+      totals = nil
+      unless hash['totals'].nil?
+        totals = []
+        hash['totals'].each do |structure|
+          totals << (Total.from_hash(structure) if structure)
+        end
+      end
+
+      totals = SKIP unless hash.key?('totals')
+
+      # 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.
+      Deductions.new(subtotals: subtotals,
+                     totals: totals,
+                     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} subtotals: #{@subtotals}, totals: #{@totals}, 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} subtotals: #{@subtotals.inspect}, totals: #{@totals.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/default_update_webhook.rb

@@ -0,0 +1,119 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when new transaction data is available for an Item. Plaid will
+  # typically check for new transaction data several times a day.
+  class DefaultUpdateWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `TRANSACTIONS`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `DEFAULT_UPDATE`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # We use standard HTTP response codes for success and failure notifications,
+    # and our errors are further classified by `error_type`. In general, 200
+    # HTTP codes correspond to success, 40X codes are for developer- or
+    # user-related failures, and 50X codes are for Plaid-related issues.  Error
+    # fields will be `null` if no error has occurred.
+    # @return [Error]
+    attr_accessor :error
+
+    # The number of new transactions detected since the last time this webhook
+    # was fired.
+    # @return [Float]
+    attr_accessor :new_transactions
+
+    # The `item_id` of the Item the webhook relates to.
+    # @return [String]
+    attr_accessor :item_id
+
+    # 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['error'] = 'error'
+      @_hash['new_transactions'] = 'new_transactions'
+      @_hash['item_id'] = 'item_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, new_transactions:, item_id:,
+                   error: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @error = error unless error == SKIP
+      @new_transactions = new_transactions
+      @item_id = item_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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      new_transactions =
+        hash.key?('new_transactions') ? hash['new_transactions'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      error = Error.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      DefaultUpdateWebhook.new(webhook_type: webhook_type,
+                               webhook_code: webhook_code,
+                               new_transactions: new_transactions,
+                               item_id: item_id,
+                               error: error,
+                               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}, error:"\
+      " #{@error}, new_transactions: #{@new_transactions}, item_id: #{@item_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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, error: #{@error.inspect}, new_transactions:"\
+      " #{@new_transactions.inspect}, item_id: #{@item_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_address_data.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The user's address.
+  class DepositSwitchAddressData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full city name
+    # @return [String]
+    attr_accessor :city
+
+    # The region or state
+    # Example: `"NC"`
+    # @return [String]
+    attr_accessor :region
+
+    # The full street address
+    # Example: `"564 Main Street, APT 15"`
+    # @return [String]
+    attr_accessor :street
+
+    # The postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The ISO 3166-1 alpha-2 country code
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['region'] = 'region'
+      @_hash['street'] = 'street'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city:, region:, street:, postal_code:, country:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @city = city
+      @region = region
+      @street = street
+      @postal_code = postal_code
+      @country = country
+      @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.
+      city = hash.key?('city') ? hash['city'] : nil
+      region = hash.key?('region') ? hash['region'] : nil
+      street = hash.key?('street') ? hash['street'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      country = hash.key?('country') ? hash['country'] : 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.
+      DepositSwitchAddressData.new(city: city,
+                                   region: region,
+                                   street: street,
+                                   postal_code: postal_code,
+                                   country: country,
+                                   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} city: #{@city}, region: #{@region}, street: #{@street}, postal_code:"\
+      " #{@postal_code}, country: #{@country}, 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} city: #{@city.inspect}, region: #{@region.inspect}, street:"\
+      " #{@street.inspect}, postal_code: #{@postal_code.inspect}, country: #{@country.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_alt_create_request.rb

@@ -0,0 +1,132 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchAltCreateRequest defines the request schema for
+  # `/deposit_switch/alt/create`
+  class DepositSwitchAltCreateRequest < 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
+
+    # 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 [DepositSwitchTargetAccount]
+    attr_accessor :target_account
+
+    # 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 [DepositSwitchTargetUser]
+    attr_accessor :target_user
+
+    # Options to configure the `/deposit_switch/create` request. If provided,
+    # cannot be `null`.
+    # @return [DepositSwitchCreateRequestOptions]
+    attr_accessor :options
+
+    # ISO-3166-1 alpha-2 country code standard.
+    # @return [CountryCode1]
+    attr_accessor :country_code
+
+    # 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['target_account'] = 'target_account'
+      @_hash['target_user'] = 'target_user'
+      @_hash['options'] = 'options'
+      @_hash['country_code'] = 'country_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        options
+        country_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(target_account:, target_user:, client_id: SKIP, secret: SKIP,
+                   options: SKIP, country_code: 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
+      @target_account = target_account
+      @target_user = target_user
+      @options = options unless options == SKIP
+      @country_code = country_code unless country_code == 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.
+      target_account = DepositSwitchTargetAccount.from_hash(hash['target_account']) if
+        hash['target_account']
+      target_user = DepositSwitchTargetUser.from_hash(hash['target_user']) if hash['target_user']
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      options = DepositSwitchCreateRequestOptions.from_hash(hash['options']) if hash['options']
+      country_code = hash.key?('country_code') ? hash['country_code'] : 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.
+      DepositSwitchAltCreateRequest.new(target_account: target_account,
+                                        target_user: target_user,
+                                        client_id: client_id,
+                                        secret: secret,
+                                        options: options,
+                                        country_code: country_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} client_id: #{@client_id}, secret: #{@secret}, target_account:"\
+      " #{@target_account}, target_user: #{@target_user}, options: #{@options}, country_code:"\
+      " #{@country_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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect},"\
+      " target_account: #{@target_account.inspect}, target_user: #{@target_user.inspect}, options:"\
+      " #{@options.inspect}, country_code: #{@country_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end