apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb

@@ -0,0 +1,85 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PaymentInitiationOptionalRestrictionBacs Model.
+  class PaymentInitiationOptionalRestrictionBacs < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account number of the account. Maximum of 10 characters.
+    # @return [String]
+    attr_accessor :account
+
+    # The 6-character sort code of the account.
+    # @return [String]
+    attr_accessor :sort_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['sort_code'] = 'sort_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        sort_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account: SKIP, sort_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account = account unless account == SKIP
+      @sort_code = sort_code unless sort_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.
+      account = hash.key?('account') ? hash['account'] : SKIP
+      sort_code = hash.key?('sort_code') ? hash['sort_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.
+      PaymentInitiationOptionalRestrictionBacs.new(account: account,
+                                                   sort_code: sort_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} account: #{@account}, sort_code: #{@sort_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} account: #{@account.inspect}, sort_code: #{@sort_code.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_payment.rb

@@ -0,0 +1,242 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # PaymentInitiationPayment defines a payment initiation payment
+  class PaymentInitiationPayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the payment. Like all Plaid identifiers, the `payment_id` is
+    # case sensitive.
+    # @return [String]
+    attr_accessor :payment_id
+
+    # The amount and currency of a payment
+    # @return [PaymentAmount]
+    attr_accessor :amount
+
+    # The 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 [Status3]
+    attr_accessor :status
+
+    # The ID of the recipient
+    # @return [String]
+    attr_accessor :recipient_id
+
+    # A reference for the payment.
+    # @return [String]
+    attr_accessor :reference
+
+    # The value of the reference sent to the bank after adjustment to pass bank
+    # validation rules.
+    # @return [String]
+    attr_accessor :adjusted_reference
+
+    # The date and time of the last time the `status` was updated, in IS0 8601
+    # format
+    # @return [DateTime]
+    attr_accessor :last_status_update
+
+    # 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.
+    # @return [ExternalPaymentScheduleGet]
+    attr_accessor :schedule
+
+    # 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.
+    # @return [ExternalPaymentRefundDetails]
+    attr_accessor :refund_details
+
+    # 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.
+    # @return [SenderBacsNullable]
+    attr_accessor :bacs
+
+    # The International Bank Account Number (IBAN) for the sender, if specified
+    # in the `/payment_initiation/payment/create` call.
+    # @return [String]
+    attr_accessor :iban
+
+    # Initiated refunds associated with the payment.
+    # @return [Array[PaymentInitiationRefund]]
+    attr_accessor :initiated_refunds
+
+    # 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['payment_id'] = 'payment_id'
+      @_hash['amount'] = 'amount'
+      @_hash['status'] = 'status'
+      @_hash['recipient_id'] = 'recipient_id'
+      @_hash['reference'] = 'reference'
+      @_hash['adjusted_reference'] = 'adjusted_reference'
+      @_hash['last_status_update'] = 'last_status_update'
+      @_hash['schedule'] = 'schedule'
+      @_hash['refund_details'] = 'refund_details'
+      @_hash['bacs'] = 'bacs'
+      @_hash['iban'] = 'iban'
+      @_hash['initiated_refunds'] = 'initiated_refunds'
+      @_hash['emi_account_id'] = 'emi_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        adjusted_reference
+        schedule
+        refund_details
+        initiated_refunds
+        emi_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        adjusted_reference
+        iban
+        emi_account_id
+      ]
+    end
+
+    def initialize(payment_id:, amount:, status:, recipient_id:, reference:,
+                   last_status_update:, bacs:, iban:, adjusted_reference: SKIP,
+                   schedule: SKIP, refund_details: SKIP,
+                   initiated_refunds: SKIP, emi_account_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_id = payment_id
+      @amount = amount
+      @status = status
+      @recipient_id = recipient_id
+      @reference = reference
+      @adjusted_reference = adjusted_reference unless adjusted_reference == SKIP
+      @last_status_update = last_status_update
+      @schedule = schedule unless schedule == SKIP
+      @refund_details = refund_details unless refund_details == SKIP
+      @bacs = bacs
+      @iban = iban
+      @initiated_refunds = initiated_refunds unless initiated_refunds == 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.
+      payment_id = hash.key?('payment_id') ? hash['payment_id'] : nil
+      amount = PaymentAmount.from_hash(hash['amount']) if hash['amount']
+      status = hash.key?('status') ? hash['status'] : nil
+      recipient_id = hash.key?('recipient_id') ? hash['recipient_id'] : nil
+      reference = hash.key?('reference') ? hash['reference'] : nil
+      last_status_update = if hash.key?('last_status_update')
+                             (DateTimeHelper.from_rfc3339(hash['last_status_update']) if hash['last_status_update'])
+                           end
+      bacs = SenderBacsNullable.from_hash(hash['bacs']) if hash['bacs']
+      iban = hash.key?('iban') ? hash['iban'] : nil
+      adjusted_reference =
+        hash.key?('adjusted_reference') ? hash['adjusted_reference'] : SKIP
+      schedule = ExternalPaymentScheduleGet.from_hash(hash['schedule']) if hash['schedule']
+      refund_details = ExternalPaymentRefundDetails.from_hash(hash['refund_details']) if
+        hash['refund_details']
+      # Parameter is an array, so we need to iterate through it
+      initiated_refunds = nil
+      unless hash['initiated_refunds'].nil?
+        initiated_refunds = []
+        hash['initiated_refunds'].each do |structure|
+          initiated_refunds << (PaymentInitiationRefund.from_hash(structure) if structure)
+        end
+      end
+
+      initiated_refunds = SKIP unless hash.key?('initiated_refunds')
+      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.
+      PaymentInitiationPayment.new(payment_id: payment_id,
+                                   amount: amount,
+                                   status: status,
+                                   recipient_id: recipient_id,
+                                   reference: reference,
+                                   last_status_update: last_status_update,
+                                   bacs: bacs,
+                                   iban: iban,
+                                   adjusted_reference: adjusted_reference,
+                                   schedule: schedule,
+                                   refund_details: refund_details,
+                                   initiated_refunds: initiated_refunds,
+                                   emi_account_id: emi_account_id,
+                                   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} payment_id: #{@payment_id}, amount: #{@amount}, status: #{@status},"\
+      " recipient_id: #{@recipient_id}, reference: #{@reference}, adjusted_reference:"\
+      " #{@adjusted_reference}, last_status_update: #{@last_status_update}, schedule:"\
+      " #{@schedule}, refund_details: #{@refund_details}, bacs: #{@bacs}, iban: #{@iban},"\
+      " initiated_refunds: #{@initiated_refunds}, 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} payment_id: #{@payment_id.inspect}, amount: #{@amount.inspect}, status:"\
+      " #{@status.inspect}, recipient_id: #{@recipient_id.inspect}, reference:"\
+      " #{@reference.inspect}, adjusted_reference: #{@adjusted_reference.inspect},"\
+      " last_status_update: #{@last_status_update.inspect}, schedule: #{@schedule.inspect},"\
+      " refund_details: #{@refund_details.inspect}, bacs: #{@bacs.inspect}, iban:"\
+      " #{@iban.inspect}, initiated_refunds: #{@initiated_refunds.inspect}, emi_account_id:"\
+      " #{@emi_account_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_payment_create_request.rb

@@ -0,0 +1,140 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PaymentInitiationPaymentCreateRequest defines the request schema for
+  # `/payment_initiation/payment/create`
+  class PaymentInitiationPaymentCreateRequest < 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
+
+    # The ID of the recipient the payment is for.
+    # @return [String]
+    attr_accessor :recipient_id
+
+    # A reference for the payment. This must be an alphanumeric string with at
+    # most 18 characters and must not contain any special characters (since not
+    # all institutions support them).
+    # @return [String]
+    attr_accessor :reference
+
+    # The amount and currency of a payment
+    # @return [PaymentAmount]
+    attr_accessor :amount
+
+    # 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.
+    # @return [ExternalPaymentScheduleRequest]
+    attr_accessor :schedule
+
+    # Additional payment options
+    # @return [PaymentOptions]
+    attr_accessor :options
+
+    # 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['recipient_id'] = 'recipient_id'
+      @_hash['reference'] = 'reference'
+      @_hash['amount'] = 'amount'
+      @_hash['schedule'] = 'schedule'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        schedule
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(recipient_id:, reference:, amount:, client_id: SKIP,
+                   secret: SKIP, schedule: SKIP, options: 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
+      @recipient_id = recipient_id
+      @reference = reference
+      @amount = amount
+      @schedule = schedule unless schedule == SKIP
+      @options = options unless options == 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.
+      recipient_id = hash.key?('recipient_id') ? hash['recipient_id'] : nil
+      reference = hash.key?('reference') ? hash['reference'] : nil
+      amount = PaymentAmount.from_hash(hash['amount']) if hash['amount']
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      schedule = ExternalPaymentScheduleRequest.from_hash(hash['schedule']) if hash['schedule']
+      options = PaymentOptions.from_hash(hash['options']) if hash['options']
+
+      # 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.
+      PaymentInitiationPaymentCreateRequest.new(recipient_id: recipient_id,
+                                                reference: reference,
+                                                amount: amount,
+                                                client_id: client_id,
+                                                secret: secret,
+                                                schedule: schedule,
+                                                options: options,
+                                                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}, recipient_id:"\
+      " #{@recipient_id}, reference: #{@reference}, amount: #{@amount}, schedule: #{@schedule},"\
+      " options: #{@options}, 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}, recipient_id:"\
+      " #{@recipient_id.inspect}, reference: #{@reference.inspect}, amount: #{@amount.inspect},"\
+      " schedule: #{@schedule.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_payment_create_response.rb

@@ -0,0 +1,95 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PaymentInitiationPaymentCreateResponse defines the response schema for
+  # `/payment_initiation/payment/create`
+  class PaymentInitiationPaymentCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique ID identifying the payment
+    # @return [String]
+    attr_accessor :payment_id
+
+    # For a payment returned by this endpoint, there is only one possible value:
+    # `PAYMENT_STATUS_INPUT_NEEDED`: The initial phase of the payment
+    # @return [String]
+    attr_accessor :status
+
+    # 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['payment_id'] = 'payment_id'
+      @_hash['status'] = 'status'
+      @_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(payment_id:, status:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_id = payment_id
+      @status = status
+      @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.
+      payment_id = hash.key?('payment_id') ? hash['payment_id'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      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.
+      PaymentInitiationPaymentCreateResponse.new(payment_id: payment_id,
+                                                 status: status,
+                                                 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} payment_id: #{@payment_id}, status: #{@status}, 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} payment_id: #{@payment_id.inspect}, status: #{@status.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/payment_initiation_payment_get_request.rb

@@ -0,0 +1,98 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PaymentInitiationPaymentGetRequest defines the request schema for
+  # `/payment_initiation/payment/get`
+  class PaymentInitiationPaymentGetRequest < 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
+
+    # The `payment_id` returned from `/payment_initiation/payment/create`.
+    # @return [String]
+    attr_accessor :payment_id
+
+    # 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['payment_id'] = 'payment_id'
+      @_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(payment_id:, 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
+      @payment_id = payment_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.
+      payment_id = hash.key?('payment_id') ? hash['payment_id'] : nil
+      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.
+      PaymentInitiationPaymentGetRequest.new(payment_id: payment_id,
+                                             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}, payment_id: #{@payment_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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, payment_id:"\
+      " #{@payment_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end