apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/pay.rb

@@ -0,0 +1,88 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing a monetary amount.
+  class Pay < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A numerical amount of a specific currency.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code, e.g. USD
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        amount
+        currency
+      ]
+    end
+
+    def initialize(amount: SKIP, currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : 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.
+      Pay.new(amount: amount,
+              currency: currency,
+              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} amount: #{@amount}, currency: #{@currency}, 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} amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/pay_frequency.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PayFrequency Model.
+  class PayFrequency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The frequency of the pay period.
+    # @return [Value]
+    attr_accessor :value
+
+    # The verification status. One of the following:
+    # `"VERIFIED"`: The information was successfully verified.
+    # `"UNVERIFIED"`: The verification has not yet been performed.
+    # `"NEEDS_INFO"`: The verification was attempted but could not be completed
+    # due to missing information.
+    # "`UNABLE_TO_VERIFY`": The verification was performed and the information
+    # could not be verified.
+    # `"UNKNOWN"`: The verification status is unknown.
+    # @return [VerificationStatus]
+    attr_accessor :verification_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash['verification_status'] = 'verification_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value:, verification_status:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @value = value
+      @verification_status = verification_status
+      @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.
+      value = hash.key?('value') ? hash['value'] : nil
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : 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.
+      PayFrequency.new(value: value,
+                       verification_status: verification_status,
+                       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} value: #{@value}, verification_status: #{@verification_status},"\
+      " 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} value: #{@value.inspect}, verification_status:"\
+      " #{@verification_status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/pay_frequency1.rb

@@ -0,0 +1,45 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The frequency at which the employee is paid. Possible values: `MONTHLY`,
+  # `BI-WEEKLY`, `WEEKLY`, `SEMI-MONTHLY`.
+  class PayFrequency1
+    PAY_FREQUENCY1 = [
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BI-WEEKLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMI-MONTHLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MONTHLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'monthly' then MONTHLY
+      when 'biweekly' then BIWEEKLY
+      when 'weekly' then WEEKLY
+      when 'semimonthly' then SEMIMONTHLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/pay_period_details.rb

@@ -0,0 +1,119 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Details about the pay period.
+  class PayPeriodDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pay period start date, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format: "yyyy-mm-dd".
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The pay period end date, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format: "yyyy-mm-dd".
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The date on which the paystub was issued, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").
+    # @return [Date]
+    attr_accessor :pay_day
+
+    # Total earnings before tax.
+    # @return [Float]
+    attr_accessor :gross_earnings
+
+    # The net amount of the paycheck.
+    # @return [Float]
+    attr_accessor :check_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['pay_day'] = 'pay_day'
+      @_hash['gross_earnings'] = 'gross_earnings'
+      @_hash['check_amount'] = 'check_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+        pay_day
+        gross_earnings
+        check_amount
+      ]
+    end
+
+    def initialize(start_date:, end_date:, pay_day:, gross_earnings:,
+                   check_amount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_date = start_date
+      @end_date = end_date
+      @pay_day = pay_day
+      @gross_earnings = gross_earnings
+      @check_amount = check_amount
+      @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.
+      start_date = hash.key?('start_date') ? hash['start_date'] : nil
+      end_date = hash.key?('end_date') ? hash['end_date'] : nil
+      pay_day = hash.key?('pay_day') ? hash['pay_day'] : nil
+      gross_earnings =
+        hash.key?('gross_earnings') ? hash['gross_earnings'] : nil
+      check_amount = hash.key?('check_amount') ? hash['check_amount'] : 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.
+      PayPeriodDetails.new(start_date: start_date,
+                           end_date: end_date,
+                           pay_day: pay_day,
+                           gross_earnings: gross_earnings,
+                           check_amount: check_amount,
+                           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} start_date: #{@start_date}, end_date: #{@end_date}, pay_day: #{@pay_day},"\
+      " gross_earnings: #{@gross_earnings}, check_amount: #{@check_amount}, 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} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " pay_day: #{@pay_day.inspect}, gross_earnings: #{@gross_earnings.inspect}, check_amount:"\
+      " #{@check_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_amount.rb

@@ -0,0 +1,84 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The amount and currency of a payment
+  class PaymentAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ISO-4217 currency code of the payment. For standing orders, `"GBP"`
+    # must be used.
+    # @return [Currency]
+    attr_accessor :currency
+
+    # The amount of the payment. Must contain at most two digits of precision
+    # e.g. `1.23`. Minimum accepted value is `1`.
+    # @return [Float]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency:, value:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency = currency
+      @value = value
+      @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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      value = hash.key?('value') ? hash['value'] : 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.
+      PaymentAmount.new(currency: currency,
+                        value: value,
+                        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} currency: #{@currency}, value: #{@value}, 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} currency: #{@currency.inspect}, value: #{@value.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_channel.rb

@@ -0,0 +1,43 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The channel used to make a payment. `online:` transactions that took place
+  # online. `in store:` transactions that were made at a physical location.
+  # `other:` transactions that relate to banks, e.g. fees or deposits. This
+  # field replaces the `transaction_type` field.
+  class PaymentChannel
+    PAYMENT_CHANNEL = [
+      # TODO: Write general description for ONLINE
+      ONLINE = 'online'.freeze,
+
+      # TODO: Write general description for ENUM_IN_STORE
+      ENUM_IN_STORE = 'in store'.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 = ONLINE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'online' then ONLINE
+      when 'enum_in_store' then ENUM_IN_STORE
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_address.rb

@@ -0,0 +1,103 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The optional address of the payment recipient. This object is not currently
+  # required to make payments from UK institutions and should not be populated,
+  # though may be necessary for future European expansion.
+  class PaymentInitiationAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of length 1-2 representing the street address where the recipient
+    # is located. Maximum of 70 characters.
+    # @return [Array[String]]
+    attr_accessor :street
+
+    # The city where the recipient is located. Maximum of 35 characters.
+    # @return [String]
+    attr_accessor :city
+
+    # The postal code where the recipient is located. Maximum of 16 characters.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The ISO 3166-1 alpha-2 country code where the recipient is located.
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['street'] = 'street'
+      @_hash['city'] = 'city'
+      @_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(street:, city:, postal_code:, country:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @street = street
+      @city = city
+      @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.
+      street = hash.key?('street') ? hash['street'] : nil
+      city = hash.key?('city') ? hash['city'] : 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.
+      PaymentInitiationAddress.new(street: street,
+                                   city: city,
+                                   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} street: #{@street}, city: #{@city}, 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} street: #{@street.inspect}, city: #{@city.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_metadata.rb

@@ -0,0 +1,117 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Metadata that captures what specific payment configurations an institution
+  # supports when making Payment Initiation requests.
+  class PaymentInitiationMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether the institution supports payments from a different
+    # country.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_international_payments
+
+    # A mapping of currency to maximum payment amount (denominated in the
+    # smallest unit of currency) supported by the insitution.
+    # Example: `{"GBP": "10000"}`
+    # @return [Hash[String, String]]
+    attr_accessor :maximum_payment_amount
+
+    # Indicates whether the institution supports returning refund details when
+    # initiating a payment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_refund_details
+
+    # Metadata specifically related to valid Payment Initiation standing order
+    # configurations for the institution.
+    # @return [PaymentInitiationStandingOrderMetadata]
+    attr_accessor :standing_order_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['supports_international_payments'] =
+        'supports_international_payments'
+      @_hash['maximum_payment_amount'] = 'maximum_payment_amount'
+      @_hash['supports_refund_details'] = 'supports_refund_details'
+      @_hash['standing_order_metadata'] = 'standing_order_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(supports_international_payments:, maximum_payment_amount:,
+                   supports_refund_details:, standing_order_metadata:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @supports_international_payments = supports_international_payments
+      @maximum_payment_amount = maximum_payment_amount
+      @supports_refund_details = supports_refund_details
+      @standing_order_metadata = standing_order_metadata
+      @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.
+      supports_international_payments =
+        hash.key?('supports_international_payments') ? hash['supports_international_payments'] : nil
+      maximum_payment_amount =
+        hash.key?('maximum_payment_amount') ? hash['maximum_payment_amount'] : nil
+      supports_refund_details =
+        hash.key?('supports_refund_details') ? hash['supports_refund_details'] : nil
+      if hash['standing_order_metadata']
+        standing_order_metadata = PaymentInitiationStandingOrderMetadata.from_hash(hash['standing_order_metadata'])
+      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.
+      PaymentInitiationMetadata.new(supports_international_payments: supports_international_payments,
+                                    maximum_payment_amount: maximum_payment_amount,
+                                    supports_refund_details: supports_refund_details,
+                                    standing_order_metadata: standing_order_metadata,
+                                    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} supports_international_payments: #{@supports_international_payments},"\
+      " maximum_payment_amount: #{@maximum_payment_amount}, supports_refund_details:"\
+      " #{@supports_refund_details}, standing_order_metadata: #{@standing_order_metadata},"\
+      " 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} supports_international_payments:"\
+      " #{@supports_international_payments.inspect}, maximum_payment_amount:"\
+      " #{@maximum_payment_amount.inspect}, supports_refund_details:"\
+      " #{@supports_refund_details.inspect}, standing_order_metadata:"\
+      " #{@standing_order_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end