apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/payment_meta.rb

@@ -0,0 +1,156 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Transaction information specific to inter-bank transfers. If the transaction
+  # was not an inter-bank transfer, all fields will be `null`. If the
+  # `transactions` object was returned by a Transactions endpoint such as
+  # `/transactions/get`, the `payment_meta` key will always appear, but no data
+  # elements are guaranteed. If the `transactions` object was returned by an
+  # Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`,
+  # this field will only appear in an Asset Report with Insights.
+  class PaymentMeta < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transaction reference number supplied by the financial institution.
+    # @return [String]
+    attr_accessor :reference_number
+
+    # The ACH PPD ID for the payer.
+    # @return [String]
+    attr_accessor :ppd_id
+
+    # For transfers, the party that is receiving the transaction.
+    # @return [String]
+    attr_accessor :payee
+
+    # The party initiating a wire transfer. Will be `null` if the transaction is
+    # not a wire transfer.
+    # @return [String]
+    attr_accessor :by_order_of
+
+    # For transfers, the party that is paying the transaction.
+    # @return [String]
+    attr_accessor :payer
+
+    # The type of transfer, e.g. 'ACH'
+    # @return [String]
+    attr_accessor :payment_method
+
+    # The name of the payment processor
+    # @return [String]
+    attr_accessor :payment_processor
+
+    # The payer-supplied description of the transfer.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_number'] = 'reference_number'
+      @_hash['ppd_id'] = 'ppd_id'
+      @_hash['payee'] = 'payee'
+      @_hash['by_order_of'] = 'by_order_of'
+      @_hash['payer'] = 'payer'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['payment_processor'] = 'payment_processor'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reference_number
+        ppd_id
+        payee
+        by_order_of
+        payer
+        payment_method
+        payment_processor
+        reason
+      ]
+    end
+
+    def initialize(reference_number:, ppd_id:, payee:, by_order_of:, payer:,
+                   payment_method:, payment_processor:, reason:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reference_number = reference_number
+      @ppd_id = ppd_id
+      @payee = payee
+      @by_order_of = by_order_of
+      @payer = payer
+      @payment_method = payment_method
+      @payment_processor = payment_processor
+      @reason = reason
+      @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.
+      reference_number =
+        hash.key?('reference_number') ? hash['reference_number'] : nil
+      ppd_id = hash.key?('ppd_id') ? hash['ppd_id'] : nil
+      payee = hash.key?('payee') ? hash['payee'] : nil
+      by_order_of = hash.key?('by_order_of') ? hash['by_order_of'] : nil
+      payer = hash.key?('payer') ? hash['payer'] : nil
+      payment_method =
+        hash.key?('payment_method') ? hash['payment_method'] : nil
+      payment_processor =
+        hash.key?('payment_processor') ? hash['payment_processor'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : 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.
+      PaymentMeta.new(reference_number: reference_number,
+                      ppd_id: ppd_id,
+                      payee: payee,
+                      by_order_of: by_order_of,
+                      payer: payer,
+                      payment_method: payment_method,
+                      payment_processor: payment_processor,
+                      reason: reason,
+                      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} reference_number: #{@reference_number}, ppd_id: #{@ppd_id}, payee:"\
+      " #{@payee}, by_order_of: #{@by_order_of}, payer: #{@payer}, payment_method:"\
+      " #{@payment_method}, payment_processor: #{@payment_processor}, reason: #{@reason},"\
+      " 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} reference_number: #{@reference_number.inspect}, ppd_id: #{@ppd_id.inspect},"\
+      " payee: #{@payee.inspect}, by_order_of: #{@by_order_of.inspect}, payer: #{@payer.inspect},"\
+      " payment_method: #{@payment_method.inspect}, payment_processor:"\
+      " #{@payment_processor.inspect}, reason: #{@reason.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_options.rb

@@ -0,0 +1,122 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Additional payment options
+  class PaymentOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When `true`, Plaid will attempt to request refund details from the payee's
+    # financial institution.  Support varies between financial institutions and
+    # will not always be available.  If refund details could be retrieved, they
+    # will be available in the `/payment_initiation/payment/get` response.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :request_refund_details
+
+    # The International Bank Account Number (IBAN) for the payer's account. If
+    # provided, the end user will be able to send payments only from the
+    # specified bank account.
+    # @return [String]
+    attr_accessor :iban
+
+    # The International Bank Account Number (IBAN) for the payer's account. If
+    # provided, the end user will be able to send payments only from the
+    # specified bank account.
+    # @return [PaymentInitiationOptionalRestrictionBacs]
+    attr_accessor :bacs
+
+    # The EMI (E-Money Institution) account that this payment is associated
+    # with, if any. This EMI account is used as an intermediary account to
+    # enable Plaid to reconcile the settlement of funds for Payment Initiation
+    # requests.
+    # @return [String]
+    attr_accessor :emi_account_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_refund_details'] = 'request_refund_details'
+      @_hash['iban'] = 'iban'
+      @_hash['bacs'] = 'bacs'
+      @_hash['emi_account_id'] = 'emi_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_refund_details
+        iban
+        bacs
+        emi_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        request_refund_details
+        iban
+        emi_account_id
+      ]
+    end
+
+    def initialize(request_refund_details: SKIP, iban: SKIP, bacs: SKIP,
+                   emi_account_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @request_refund_details = request_refund_details unless request_refund_details == SKIP
+      @iban = iban unless iban == SKIP
+      @bacs = bacs unless bacs == SKIP
+      @emi_account_id = emi_account_id unless emi_account_id == 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.
+      request_refund_details =
+        hash.key?('request_refund_details') ? hash['request_refund_details'] : SKIP
+      iban = hash.key?('iban') ? hash['iban'] : SKIP
+      bacs = PaymentInitiationOptionalRestrictionBacs.from_hash(hash['bacs']) if hash['bacs']
+      emi_account_id =
+        hash.key?('emi_account_id') ? hash['emi_account_id'] : 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.
+      PaymentOptions.new(request_refund_details: request_refund_details,
+                         iban: iban,
+                         bacs: bacs,
+                         emi_account_id: emi_account_id,
+                         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} request_refund_details: #{@request_refund_details}, iban: #{@iban}, bacs:"\
+      " #{@bacs}, emi_account_id: #{@emi_account_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} request_refund_details: #{@request_refund_details.inspect}, iban:"\
+      " #{@iban.inspect}, bacs: #{@bacs.inspect}, emi_account_id: #{@emi_account_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_schedule_interval.rb

@@ -0,0 +1,36 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The frequency interval of the payment.
+  class PaymentScheduleInterval
+    PAYMENT_SCHEDULE_INTERVAL = [
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = WEEKLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'weekly' then WEEKLY
+      when 'monthly' then MONTHLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/payment_status_update_webhook.rb

@@ -0,0 +1,234 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # Fired when the status of a payment has changed.
+  class PaymentStatusUpdateWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `PAYMENT_INITIATION`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `PAYMENT_STATUS_UPDATE`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `payment_id` for the payment being updated
+    # @return [String]
+    attr_accessor :payment_id
+
+    # The new status of the payment.
+    # `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments.
+    # It indicates that the payment is waiting on user input to continue
+    # processing. A payment may re-enter this state later on if further input is
+    # needed.
+    # `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The
+    # payment will automatically exit this state when processing is complete.
+    # `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated
+    # and is considered complete.
+    # `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been
+    # successfully established. This state is only used for standing orders.
+    # `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to
+    # insufficient funds.
+    # `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This
+    # error is retryable once the root cause is resolved.
+    # `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a
+    # retryable error.
+    # `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
+    # @return [NewPaymentStatus]
+    attr_accessor :new_payment_status
+
+    # The previous status of the payment.
+    # `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments.
+    # It indicates that the payment is waiting on user input to continue
+    # processing. A payment may re-enter this state later on if further input is
+    # needed.
+    # `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The
+    # payment will automatically exit this state when processing is complete.
+    # `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated
+    # and is considered complete.
+    # `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been
+    # successfully established. This state is only used for standing orders.
+    # `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to
+    # insufficient funds.
+    # `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This
+    # error is retryable once the root cause is resolved.
+    # `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a
+    # retryable error.
+    # `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
+    # @return [OldPaymentStatus]
+    attr_accessor :old_payment_status
+
+    # The original value of the reference when creating the payment.
+    # @return [String]
+    attr_accessor :original_reference
+
+    # The value of the reference sent to the bank after adjustment to pass bank
+    # validation rules.
+    # @return [String]
+    attr_accessor :adjusted_reference
+
+    # The original value of the `start_date` provided during the creation of a
+    # standing order. If the payment is not a standing order, this field will be
+    # `null`.
+    # @return [Date]
+    attr_accessor :original_start_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, or if the
+    # payment is not a standing order, this field will be `null`.
+    # @return [Date]
+    attr_accessor :adjusted_start_date
+
+    # The timestamp of the update, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g.
+    # `"2017-09-14T14:42:19.350Z"`
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # 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
+
+    # 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['payment_id'] = 'payment_id'
+      @_hash['new_payment_status'] = 'new_payment_status'
+      @_hash['old_payment_status'] = 'old_payment_status'
+      @_hash['original_reference'] = 'original_reference'
+      @_hash['adjusted_reference'] = 'adjusted_reference'
+      @_hash['original_start_date'] = 'original_start_date'
+      @_hash['adjusted_start_date'] = 'adjusted_start_date'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        adjusted_reference
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        original_reference
+        adjusted_reference
+        original_start_date
+        adjusted_start_date
+      ]
+    end
+
+    def initialize(webhook_type:, webhook_code:, payment_id:,
+                   new_payment_status:, old_payment_status:,
+                   original_reference:, original_start_date:,
+                   adjusted_start_date:, timestamp:, adjusted_reference: SKIP,
+                   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
+      @payment_id = payment_id
+      @new_payment_status = new_payment_status
+      @old_payment_status = old_payment_status
+      @original_reference = original_reference
+      @adjusted_reference = adjusted_reference unless adjusted_reference == SKIP
+      @original_start_date = original_start_date
+      @adjusted_start_date = adjusted_start_date
+      @timestamp = timestamp
+      @error = error unless error == 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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      payment_id = hash.key?('payment_id') ? hash['payment_id'] : nil
+      new_payment_status =
+        hash.key?('new_payment_status') ? hash['new_payment_status'] : nil
+      old_payment_status =
+        hash.key?('old_payment_status') ? hash['old_payment_status'] : nil
+      original_reference =
+        hash.key?('original_reference') ? hash['original_reference'] : nil
+      original_start_date =
+        hash.key?('original_start_date') ? hash['original_start_date'] : nil
+      adjusted_start_date =
+        hash.key?('adjusted_start_date') ? hash['adjusted_start_date'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      adjusted_reference =
+        hash.key?('adjusted_reference') ? hash['adjusted_reference'] : SKIP
+      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.
+      PaymentStatusUpdateWebhook.new(webhook_type: webhook_type,
+                                     webhook_code: webhook_code,
+                                     payment_id: payment_id,
+                                     new_payment_status: new_payment_status,
+                                     old_payment_status: old_payment_status,
+                                     original_reference: original_reference,
+                                     original_start_date: original_start_date,
+                                     adjusted_start_date: adjusted_start_date,
+                                     timestamp: timestamp,
+                                     adjusted_reference: adjusted_reference,
+                                     error: error,
+                                     additional_properties: additional_properties)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    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}, payment_id:"\
+      " #{@payment_id}, new_payment_status: #{@new_payment_status}, old_payment_status:"\
+      " #{@old_payment_status}, original_reference: #{@original_reference}, adjusted_reference:"\
+      " #{@adjusted_reference}, original_start_date: #{@original_start_date}, adjusted_start_date:"\
+      " #{@adjusted_start_date}, timestamp: #{@timestamp}, error: #{@error},"\
+      " 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}, payment_id: #{@payment_id.inspect}, new_payment_status:"\
+      " #{@new_payment_status.inspect}, old_payment_status: #{@old_payment_status.inspect},"\
+      " original_reference: #{@original_reference.inspect}, adjusted_reference:"\
+      " #{@adjusted_reference.inspect}, original_start_date: #{@original_start_date.inspect},"\
+      " adjusted_start_date: #{@adjusted_start_date.inspect}, timestamp: #{@timestamp.inspect},"\
+      " error: #{@error.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end