apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/employment_details.rb

@@ -0,0 +1,88 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing employment details found on a paystub.
+  class EmploymentDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object representing a monetary amount.
+    # @return [Pay]
+    attr_accessor :annual_salary
+
+    # Date on which the employee was hired, in the YYYY-MM-DD format.
+    # @return [Date]
+    attr_accessor :hire_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['annual_salary'] = 'annual_salary'
+      @_hash['hire_date'] = 'hire_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        annual_salary
+        hire_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        hire_date
+      ]
+    end
+
+    def initialize(annual_salary: SKIP, hire_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @annual_salary = annual_salary unless annual_salary == SKIP
+      @hire_date = hire_date unless hire_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.
+      annual_salary = Pay.from_hash(hash['annual_salary']) if hash['annual_salary']
+      hire_date = hash.key?('hire_date') ? hash['hire_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.
+      EmploymentDetails.new(annual_salary: annual_salary,
+                            hire_date: hire_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} annual_salary: #{@annual_salary}, hire_date: #{@hire_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} annual_salary: #{@annual_salary.inspect}, hire_date: #{@hire_date.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/error.rb

@@ -0,0 +1,172 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # 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.
+  class Error < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A broad categorization of the error. Safe for programatic use.
+    # @return [ErrorType]
+    attr_accessor :error_type
+
+    # The particular error code. Safe for programmatic use.
+    # @return [String]
+    attr_accessor :error_code
+
+    # A developer-friendly representation of the error code. This may change
+    # over time and is not safe for programmatic use.
+    # @return [String]
+    attr_accessor :error_message
+
+    # A user-friendly representation of the error code. `null` if the error is
+    # not related to user action.
+    # This may change over time and is not safe for programmatic use.
+    # @return [String]
+    attr_accessor :display_message
+
+    # A unique ID identifying the request, to be used for troubleshooting
+    # purposes. This field will be omitted in errors provided by webhooks.
+    # @return [String]
+    attr_accessor :request_id
+
+    # In the Assets product, a request can pertain to more than one Item. If an
+    # error is returned for such a request, `causes` will return an array of
+    # errors containing a breakdown of these errors on the individual Item
+    # level, if any can be identified.
+    # `causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`.
+    # @return [Array[Object]]
+    attr_accessor :causes
+
+    # The HTTP status code associated with the error. This will only be returned
+    # in the response body when the error information is provided via a webhook.
+    # @return [Float]
+    attr_accessor :status
+
+    # The URL of a Plaid documentation page with more information about the
+    # error
+    # @return [String]
+    attr_accessor :documentation_url
+
+    # Suggested steps for resolving the error
+    # @return [String]
+    attr_accessor :suggested_action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_type'] = 'error_type'
+      @_hash['error_code'] = 'error_code'
+      @_hash['error_message'] = 'error_message'
+      @_hash['display_message'] = 'display_message'
+      @_hash['request_id'] = 'request_id'
+      @_hash['causes'] = 'causes'
+      @_hash['status'] = 'status'
+      @_hash['documentation_url'] = 'documentation_url'
+      @_hash['suggested_action'] = 'suggested_action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        causes
+        status
+        documentation_url
+        suggested_action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        display_message
+        status
+      ]
+    end
+
+    def initialize(error_type:, error_code:, error_message:, display_message:,
+                   request_id: SKIP, causes: SKIP, status: SKIP,
+                   documentation_url: SKIP, suggested_action: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_type = error_type
+      @error_code = error_code
+      @error_message = error_message
+      @display_message = display_message
+      @request_id = request_id unless request_id == SKIP
+      @causes = causes unless causes == SKIP
+      @status = status unless status == SKIP
+      @documentation_url = documentation_url unless documentation_url == SKIP
+      @suggested_action = suggested_action unless suggested_action == 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.
+      error_type = hash.key?('error_type') ? hash['error_type'] : nil
+      error_code = hash.key?('error_code') ? hash['error_code'] : nil
+      error_message = hash.key?('error_message') ? hash['error_message'] : nil
+      display_message =
+        hash.key?('display_message') ? hash['display_message'] : nil
+      request_id = hash.key?('request_id') ? hash['request_id'] : SKIP
+      causes = hash.key?('causes') ? hash['causes'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      documentation_url =
+        hash.key?('documentation_url') ? hash['documentation_url'] : SKIP
+      suggested_action =
+        hash.key?('suggested_action') ? hash['suggested_action'] : 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.
+      Error.new(error_type: error_type,
+                error_code: error_code,
+                error_message: error_message,
+                display_message: display_message,
+                request_id: request_id,
+                causes: causes,
+                status: status,
+                documentation_url: documentation_url,
+                suggested_action: suggested_action,
+                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} error_type: #{@error_type}, error_code: #{@error_code}, error_message:"\
+      " #{@error_message}, display_message: #{@display_message}, request_id: #{@request_id},"\
+      " causes: #{@causes}, status: #{@status}, documentation_url: #{@documentation_url},"\
+      " suggested_action: #{@suggested_action}, 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} error_type: #{@error_type.inspect}, error_code: #{@error_code.inspect},"\
+      " error_message: #{@error_message.inspect}, display_message: #{@display_message.inspect},"\
+      " request_id: #{@request_id.inspect}, causes: #{@causes.inspect}, status:"\
+      " #{@status.inspect}, documentation_url: #{@documentation_url.inspect}, suggested_action:"\
+      " #{@suggested_action.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/error_type.rb

@@ -0,0 +1,76 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A broad categorization of the error. Safe for programatic use.
+  class ErrorType
+    ERROR_TYPE = [
+      # TODO: Write general description for INVALID_REQUEST
+      INVALID_REQUEST = 'INVALID_REQUEST'.freeze,
+
+      # TODO: Write general description for INVALID_RESULT
+      INVALID_RESULT = 'INVALID_RESULT'.freeze,
+
+      # TODO: Write general description for INVALID_INPUT
+      INVALID_INPUT = 'INVALID_INPUT'.freeze,
+
+      # TODO: Write general description for INSTITUTION_ERROR
+      INSTITUTION_ERROR = 'INSTITUTION_ERROR'.freeze,
+
+      # TODO: Write general description for RATE_LIMIT_EXCEEDED
+      RATE_LIMIT_EXCEEDED = 'RATE_LIMIT_EXCEEDED'.freeze,
+
+      # TODO: Write general description for API_ERROR
+      API_ERROR = 'API_ERROR'.freeze,
+
+      # TODO: Write general description for ITEM_ERROR
+      ITEM_ERROR = 'ITEM_ERROR'.freeze,
+
+      # TODO: Write general description for ASSET_REPORT_ERROR
+      ASSET_REPORT_ERROR = 'ASSET_REPORT_ERROR'.freeze,
+
+      # TODO: Write general description for RECAPTCHA_ERROR
+      RECAPTCHA_ERROR = 'RECAPTCHA_ERROR'.freeze,
+
+      # TODO: Write general description for OAUTH_ERROR
+      OAUTH_ERROR = 'OAUTH_ERROR'.freeze,
+
+      # TODO: Write general description for PAYMENT_ERROR
+      PAYMENT_ERROR = 'PAYMENT_ERROR'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER_ERROR
+      BANK_TRANSFER_ERROR = 'BANK_TRANSFER_ERROR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = INVALID_REQUEST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invalid_request' then INVALID_REQUEST
+      when 'invalid_result' then INVALID_RESULT
+      when 'invalid_input' then INVALID_INPUT
+      when 'institution_error' then INSTITUTION_ERROR
+      when 'rate_limit_exceeded' then RATE_LIMIT_EXCEEDED
+      when 'api_error' then API_ERROR
+      when 'item_error' then ITEM_ERROR
+      when 'asset_report_error' then ASSET_REPORT_ERROR
+      when 'recaptcha_error' then RECAPTCHA_ERROR
+      when 'oauth_error' then OAUTH_ERROR
+      when 'payment_error' then PAYMENT_ERROR
+      when 'bank_transfer_error' then BANK_TRANSFER_ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/external_payment_refund_details.rb

@@ -0,0 +1,92 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ExternalPaymentRefundDetails Model.
+  class ExternalPaymentRefundDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the account holder.
+    # @return [String]
+    attr_accessor :name
+
+    # The International Bank Account Number (IBAN) for the account.
+    # @return [String]
+    attr_accessor :iban
+
+    # The International Bank Account Number (IBAN) for the account.
+    # @return [RecipientBacsNullable]
+    attr_accessor :bacs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['iban'] = 'iban'
+      @_hash['bacs'] = 'bacs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        iban
+      ]
+    end
+
+    def initialize(name:, iban:, bacs:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @iban = iban
+      @bacs = bacs
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      iban = hash.key?('iban') ? hash['iban'] : nil
+      bacs = RecipientBacsNullable.from_hash(hash['bacs']) if hash['bacs']
+
+      # 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.
+      ExternalPaymentRefundDetails.new(name: name,
+                                       iban: iban,
+                                       bacs: bacs,
+                                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, iban: #{@iban}, bacs: #{@bacs}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, iban: #{@iban.inspect}, bacs: #{@bacs.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/external_payment_schedule_base.rb

@@ -0,0 +1,147 @@
+# 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 ExternalPaymentScheduleBase < 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[
+        interval
+        interval_execution_day
+        start_date
+        end_date
+        adjusted_start_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+        adjusted_start_date
+      ]
+    end
+
+    def initialize(interval: SKIP, interval_execution_day: SKIP,
+                   start_date: SKIP, 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 unless interval == SKIP
+      @interval_execution_day = interval_execution_day unless interval_execution_day == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @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'] : SKIP
+      interval_execution_day =
+        hash.key?('interval_execution_day') ? hash['interval_execution_day'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      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.
+      ExternalPaymentScheduleBase.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