apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/bank_transfer_event_sync_request.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/bank_transfer/event/sync`
+  class BankTransferEventSyncRequest < 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 latest (largest) `event_id` fetched via the sync endpoint, or 0
+    # initially.
+    # @return [Integer]
+    attr_accessor :after_id
+
+    # The maximum number of bank transfer events to return.
+    # @return [Integer]
+    attr_accessor :count
+
+    # 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['after_id'] = 'after_id'
+      @_hash['count'] = 'count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        count
+      ]
+    end
+
+    def initialize(after_id:, client_id: SKIP, secret: SKIP, count: 25,
+                   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
+      @after_id = after_id
+      @count = count unless count == 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.
+      after_id = hash.key?('after_id') ? hash['after_id'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      count = hash['count'] ||= 25
+
+      # 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.
+      BankTransferEventSyncRequest.new(after_id: after_id,
+                                       client_id: client_id,
+                                       secret: secret,
+                                       count: count,
+                                       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}, after_id: #{@after_id},"\
+      " count: #{@count}, 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}, after_id:"\
+      " #{@after_id.inspect}, count: #{@count.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_event_sync_response.rb

@@ -0,0 +1,94 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/bank_transfer/event/sync`
+  class BankTransferEventSyncResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[BankTransferEvent]]
+    attr_accessor :bank_transfer_events
+
+    # 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['bank_transfer_events'] = 'bank_transfer_events'
+      @_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(bank_transfer_events:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bank_transfer_events = bank_transfer_events
+      @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
+      bank_transfer_events = nil
+      unless hash['bank_transfer_events'].nil?
+        bank_transfer_events = []
+        hash['bank_transfer_events'].each do |structure|
+          bank_transfer_events << (BankTransferEvent.from_hash(structure) if structure)
+        end
+      end
+
+      bank_transfer_events = nil unless hash.key?('bank_transfer_events')
+      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.
+      BankTransferEventSyncResponse.new(bank_transfer_events: bank_transfer_events,
+                                        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} bank_transfer_events: #{@bank_transfer_events}, 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} bank_transfer_events: #{@bank_transfer_events.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_event_type.rb

@@ -0,0 +1,63 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The type of event that this bank transfer represents. `pending`: A new
+  # transfer was created; it is in the pending state. `cancelled`: The transfer
+  # was cancelled by the client. `failed`: The transfer failed, no funds were
+  # moved. `posted`: The transfer has been successfully submitted to the payment
+  # network. `reversed`: A posted transfer was reversed. `receiver_pending`: The
+  # matching transfer was found as a pending transaction in the receiver's
+  # account `receiver_posted`: The matching transfer was found as a posted
+  # transaction in the receiver's account
+  class BankTransferEventType
+    BANK_TRANSFER_EVENT_TYPE = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for POSTED
+      POSTED = 'posted'.freeze,
+
+      # TODO: Write general description for REVERSED
+      REVERSED = 'reversed'.freeze,
+
+      # TODO: Write general description for RECEIVER_PENDING
+      RECEIVER_PENDING = 'receiver_pending'.freeze,
+
+      # TODO: Write general description for RECEIVER_POSTED
+      RECEIVER_POSTED = 'receiver_posted'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'cancelled' then CANCELLED
+      when 'failed' then FAILED
+      when 'posted' then POSTED
+      when 'reversed' then REVERSED
+      when 'receiver_pending' then RECEIVER_PENDING
+      when 'receiver_posted' then RECEIVER_POSTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_failure.rb

@@ -0,0 +1,93 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The failure reason if the type of this transfer is `"failed"` or
+  # `"reversed"`. Null value otherwise.
+  class BankTransferFailure < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ACH return code, e.g. `R01`.  A return code will be provided if and
+    # only if the transfer status is `reversed`. For a full listing of ACH
+    # return codes, see [Bank Transfers
+    # errors](https://plaid.com/docs/errors/bank-transfers/#ach-return-codes).
+    # @return [String]
+    attr_accessor :ach_return_code
+
+    # A human-readable description of the reason for the failure or reversal.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ach_return_code'] = 'ach_return_code'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ach_return_code
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ach_return_code
+      ]
+    end
+
+    def initialize(ach_return_code: SKIP, description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ach_return_code = ach_return_code unless ach_return_code == SKIP
+      @description = description unless description == 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.
+      ach_return_code =
+        hash.key?('ach_return_code') ? hash['ach_return_code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : 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.
+      BankTransferFailure.new(ach_return_code: ach_return_code,
+                              description: description,
+                              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} ach_return_code: #{@ach_return_code}, description: #{@description},"\
+      " 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} ach_return_code: #{@ach_return_code.inspect}, description:"\
+      " #{@description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_get_request.rb

@@ -0,0 +1,99 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/bank_transfer/get`
+  class BankTransferGetRequest < 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
+
+    # Plaid’s unique identifier for a bank transfer.
+    # @return [String]
+    attr_accessor :bank_transfer_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['bank_transfer_id'] = 'bank_transfer_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(bank_transfer_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
+      @bank_transfer_id = bank_transfer_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.
+      bank_transfer_id =
+        hash.key?('bank_transfer_id') ? hash['bank_transfer_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.
+      BankTransferGetRequest.new(bank_transfer_id: bank_transfer_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}, bank_transfer_id:"\
+      " #{@bank_transfer_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},"\
+      " bank_transfer_id: #{@bank_transfer_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_get_response.rb

@@ -0,0 +1,84 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/bank_transfer/get`
+  class BankTransferGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents a bank transfer within the Bank Transfers API.
+    # @return [BankTransfer]
+    attr_accessor :bank_transfer
+
+    # 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['bank_transfer'] = 'bank_transfer'
+      @_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(bank_transfer:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bank_transfer = bank_transfer
+      @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.
+      bank_transfer = BankTransfer.from_hash(hash['bank_transfer']) if hash['bank_transfer']
+      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.
+      BankTransferGetResponse.new(bank_transfer: bank_transfer,
+                                  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} bank_transfer: #{@bank_transfer}, 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} bank_transfer: #{@bank_transfer.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end