apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/payment_initiation_recipient_get_response.rb

@@ -0,0 +1,144 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PaymentInitiationRecipientGetResponse defines the response schema for
+  # `/payment_initiation/recipient/get`
+  class PaymentInitiationRecipientGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the recipient.
+    # @return [String]
+    attr_accessor :recipient_id
+
+    # The name of the recipient.
+    # @return [String]
+    attr_accessor :name
+
+    # 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.
+    # @return [PaymentInitiationAddress]
+    attr_accessor :address
+
+    # The International Bank Account Number (IBAN) for the recipient.
+    # @return [String]
+    attr_accessor :iban
+
+    # The International Bank Account Number (IBAN) for the recipient.
+    # @return [RecipientBacsNullable]
+    attr_accessor :bacs
+
+    # The EMI (E-Money Institution) recipient that this recipient is associated
+    # with, if any. This EMI recipient is used as an intermediary account to
+    # enable Plaid to reconcile the settlement of funds for Payment Initiation
+    # requests.
+    # @return [String]
+    attr_accessor :emi_recipient_id
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['recipient_id'] = 'recipient_id'
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['iban'] = 'iban'
+      @_hash['bacs'] = 'bacs'
+      @_hash['emi_recipient_id'] = 'emi_recipient_id'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        iban
+        bacs
+        emi_recipient_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        iban
+        emi_recipient_id
+      ]
+    end
+
+    def initialize(recipient_id:, name:, request_id:, address: SKIP, iban: SKIP,
+                   bacs: SKIP, emi_recipient_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @recipient_id = recipient_id
+      @name = name
+      @address = address unless address == SKIP
+      @iban = iban unless iban == SKIP
+      @bacs = bacs unless bacs == SKIP
+      @emi_recipient_id = emi_recipient_id unless emi_recipient_id == SKIP
+      @request_id = request_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.
+      recipient_id = hash.key?('recipient_id') ? hash['recipient_id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+      address = PaymentInitiationAddress.from_hash(hash['address']) if hash['address']
+      iban = hash.key?('iban') ? hash['iban'] : SKIP
+      bacs = RecipientBacsNullable.from_hash(hash['bacs']) if hash['bacs']
+      emi_recipient_id =
+        hash.key?('emi_recipient_id') ? hash['emi_recipient_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.
+      PaymentInitiationRecipientGetResponse.new(recipient_id: recipient_id,
+                                                name: name,
+                                                request_id: request_id,
+                                                address: address,
+                                                iban: iban,
+                                                bacs: bacs,
+                                                emi_recipient_id: emi_recipient_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} recipient_id: #{@recipient_id}, name: #{@name}, address: #{@address}, iban:"\
+      " #{@iban}, bacs: #{@bacs}, emi_recipient_id: #{@emi_recipient_id}, request_id:"\
+      " #{@request_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} recipient_id: #{@recipient_id.inspect}, name: #{@name.inspect}, address:"\
+      " #{@address.inspect}, iban: #{@iban.inspect}, bacs: #{@bacs.inspect}, emi_recipient_id:"\
+      " #{@emi_recipient_id.inspect}, request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_recipient_list_request.rb

@@ -0,0 +1,89 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PaymentInitiationRecipientListRequest defines the request schema for
+  # `/payment_initiation/recipient/list`
+  class PaymentInitiationRecipientListRequest < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id: SKIP, secret: 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
+      @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.
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : 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.
+      PaymentInitiationRecipientListRequest.new(client_id: client_id,
+                                                secret: secret,
+                                                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}, 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_recipient_list_response.rb

@@ -0,0 +1,94 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PaymentInitiationRecipientListResponse defines the response schema for
+  # `/payment_initiation/recipient/list`
+  class PaymentInitiationRecipientListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of payment recipients created for Payment Initiation
+    # @return [Array[PaymentInitiationRecipient]]
+    attr_accessor :recipients
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['recipients'] = 'recipients'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(recipients:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @recipients = recipients
+      @request_id = request_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.
+      # Parameter is an array, so we need to iterate through it
+      recipients = nil
+      unless hash['recipients'].nil?
+        recipients = []
+        hash['recipients'].each do |structure|
+          recipients << (PaymentInitiationRecipient.from_hash(structure) if structure)
+        end
+      end
+
+      recipients = nil unless hash.key?('recipients')
+      request_id = hash.key?('request_id') ? hash['request_id'] : 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.
+      PaymentInitiationRecipientListResponse.new(recipients: recipients,
+                                                 request_id: request_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} recipients: #{@recipients}, request_id: #{@request_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} recipients: #{@recipients.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_refund.rb

@@ -0,0 +1,116 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # PaymentInitiationRefund defines a payment initiation refund
+  class PaymentInitiationRefund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the refund. Like all Plaid identifiers, the `refund_id` is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :refund_id
+
+    # The amount and currency of a payment
+    # @return [PaymentAmount]
+    attr_accessor :amount
+
+    # The status of the refund.
+    # `PROCESSING`: The refund is currently being processed. The refund will
+    # automatically exit this state when processing is complete.
+    # `INITIATED`: The refund has been successfully initiated.
+    # `EXECUTED`: Indicates that the refund has been successfully executed.
+    # `FAILED`: The refund has failed to be executed. This error is retryable
+    # once the root cause is resolved.
+    # @return [Status2]
+    attr_accessor :status
+
+    # The date and time of the last time the `status` was updated, in IS0 8601
+    # format
+    # @return [DateTime]
+    attr_accessor :last_status_update
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['refund_id'] = 'refund_id'
+      @_hash['amount'] = 'amount'
+      @_hash['status'] = 'status'
+      @_hash['last_status_update'] = 'last_status_update'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(refund_id:, amount:, status:, last_status_update:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @refund_id = refund_id
+      @amount = amount
+      @status = status
+      @last_status_update = last_status_update
+      @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.
+      refund_id = hash.key?('refund_id') ? hash['refund_id'] : nil
+      amount = PaymentAmount.from_hash(hash['amount']) if hash['amount']
+      status = hash.key?('status') ? hash['status'] : nil
+      last_status_update = if hash.key?('last_status_update')
+                             (DateTimeHelper.from_rfc3339(hash['last_status_update']) if hash['last_status_update'])
+                           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.
+      PaymentInitiationRefund.new(refund_id: refund_id,
+                                  amount: amount,
+                                  status: status,
+                                  last_status_update: last_status_update,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_last_status_update
+      DateTimeHelper.to_rfc3339(last_status_update)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} refund_id: #{@refund_id}, amount: #{@amount}, status: #{@status},"\
+      " last_status_update: #{@last_status_update}, 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} refund_id: #{@refund_id.inspect}, amount: #{@amount.inspect}, status:"\
+      " #{@status.inspect}, last_status_update: #{@last_status_update.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_standing_order_metadata.rb

@@ -0,0 +1,108 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Metadata specifically related to valid Payment Initiation standing order
+  # configurations for the institution.
+  class PaymentInitiationStandingOrderMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether the institution supports closed-ended standing orders by
+    # providing an end date.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_standing_order_end_date
+
+    # This is only applicable to `MONTHLY` standing orders. Indicates whether
+    # the institution supports negative integers (-1 to -5) for setting up a
+    # `MONTHLY` standing order relative to the end of the month.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_standing_order_negative_execution_days
+
+    # A list of the valid standing order intervals supported by the institution.
+    # @return [Array[PaymentScheduleInterval]]
+    attr_accessor :valid_standing_order_intervals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['supports_standing_order_end_date'] =
+        'supports_standing_order_end_date'
+      @_hash['supports_standing_order_negative_execution_days'] =
+        'supports_standing_order_negative_execution_days'
+      @_hash['valid_standing_order_intervals'] =
+        'valid_standing_order_intervals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(supports_standing_order_end_date:,
+                   supports_standing_order_negative_execution_days:,
+                   valid_standing_order_intervals:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @supports_standing_order_end_date = supports_standing_order_end_date
+      @supports_standing_order_negative_execution_days = supports_standing_order_negative_execution_days
+      @valid_standing_order_intervals = valid_standing_order_intervals
+      @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_standing_order_end_date =
+        hash.key?('supports_standing_order_end_date') ? hash['supports_standing_order_end_date'] : nil
+      supports_standing_order_negative_execution_days =
+        hash.key?('supports_standing_order_negative_execution_days') ? hash['supports_standing_order_negative_execution_days'] : nil
+      valid_standing_order_intervals =
+        hash.key?('valid_standing_order_intervals') ? hash['valid_standing_order_intervals'] : 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.
+      PaymentInitiationStandingOrderMetadata.new(supports_standing_order_end_date: supports_standing_order_end_date,
+                                                 supports_standing_order_negative_execution_days: supports_standing_order_negative_execution_days,
+                                                 valid_standing_order_intervals: valid_standing_order_intervals,
+                                                 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_standing_order_end_date: #{@supports_standing_order_end_date},"\
+      ' supports_standing_order_negative_execution_days:'\
+      " #{@supports_standing_order_negative_execution_days}, valid_standing_order_intervals:"\
+      " #{@valid_standing_order_intervals}, 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_standing_order_end_date:"\
+      " #{@supports_standing_order_end_date.inspect},"\
+      ' supports_standing_order_negative_execution_days:'\
+      " #{@supports_standing_order_negative_execution_days.inspect},"\
+      " valid_standing_order_intervals: #{@valid_standing_order_intervals.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end