apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/transfer_cancel_request.rb

@@ -0,0 +1,97 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/transfer/cancel`
+  class TransferCancelRequest < 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 transfer.
+    # @return [String]
+    attr_accessor :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['transfer_id'] = '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(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
+      @transfer_id = 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.
+      transfer_id = hash.key?('transfer_id') ? hash['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.
+      TransferCancelRequest.new(transfer_id: 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}, transfer_id: #{@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}, transfer_id:"\
+      " #{@transfer_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_cancel_response.rb

@@ -0,0 +1,76 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/transfer/cancel`
+  class TransferCancelResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['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(request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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.
+      TransferCancelResponse.new(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} 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} request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_create_request.rb

@@ -0,0 +1,241 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/transfer/create`
+  class TransferCreateRequest < 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 random key provided by the client, per unique transfer. Maximum of 50
+    # characters.
+    # The API supports idempotency for safely retrying requests without
+    # accidentally performing the same operation twice. For example, if a
+    # request to create a transfer fails due to a network connection error, you
+    # can retry the request with the same idempotency key to guarantee that only
+    # a single transfer is created.
+    # @return [String]
+    attr_accessor :idempotency_key
+
+    # The Plaid `access_token` for the account that will be debited or credited.
+    # @return [String]
+    attr_accessor :access_token
+
+    # The Plaid `account_id` for the account that will be debited or credited.
+    # @return [String]
+    attr_accessor :account_id
+
+    # Plaid’s unique identifier for a transfer authorization.
+    # @return [String]
+    attr_accessor :authorization_id
+
+    # The type of transfer. This will be either `debit` or `credit`.  A `debit`
+    # indicates a transfer of money into the origination account; a `credit`
+    # indicates a transfer of money out of the origination account.
+    # @return [TransferType1]
+    attr_accessor :type
+
+    # The network or rails used for the transfer. Valid options are `ach` or
+    # `same-day-ach`.
+    # @return [TransferNetwork]
+    attr_accessor :network
+
+    # The amount of the transfer (decimal string with two digits of precision
+    # e.g. “10.00”).
+    # @return [String]
+    attr_accessor :amount
+
+    # The transfer description. Maximum of 10 characters.
+    # @return [String]
+    attr_accessor :description
+
+    # Specifies the use case of the transfer.  Required for transfers on an ACH
+    # network.
+    # `"arc"` - Accounts Receivable Entry
+    # `"cbr`" - Cross Border Entry
+    # `"ccd"` - Corporate Credit or Debit - fund transfer between two corporate
+    # bank accounts
+    # `"cie"` - Customer Initiated Entry
+    # `"cor"` - Automated Notification of Change
+    # `"ctx"` - Corporate Trade Exchange
+    # `"iat"` - International
+    # `"mte"` - Machine Transfer Entry
+    # `"pbr"` - Cross Border Entry
+    # `"pop"` - Point-of-Purchase Entry
+    # `"pos"` - Point-of-Sale Entry
+    # `"ppd"` - Prearranged Payment or Deposit - the transfer is part of a
+    # pre-existing relationship with a consumer, eg. bill payment
+    # `"rck"` - Re-presented Check Entry
+    # `"tel"` - Telephone-Initiated Entry
+    # `"web"` - Internet-Initiated Entry - debits from a consumer’s account
+    # where their authorization is obtained over the Internet
+    # @return [AchClass]
+    attr_accessor :ach_class
+
+    # The legal name and other information for the account holder.
+    # @return [TransferUserInRequest]
+    attr_accessor :user
+
+    # The Metadata object is a mapping of client-provided string fields to any
+    # string value. The following limitations apply:
+    # - The JSON values must be Strings (no nested JSON objects allowed)
+    # - Only ASCII characters may be used
+    # - Maximum of 50 key/value pairs
+    # - Maximum key length of 40 characters
+    # - Maximum value length of 500 characters
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # Plaid’s unique identifier for the origination account for this transfer.
+    # If you have more than one origination account, this value must be
+    # specified.
+    # @return [String]
+    attr_accessor :origination_account_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['idempotency_key'] = 'idempotency_key'
+      @_hash['access_token'] = 'access_token'
+      @_hash['account_id'] = 'account_id'
+      @_hash['authorization_id'] = 'authorization_id'
+      @_hash['type'] = 'type'
+      @_hash['network'] = 'network'
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['ach_class'] = 'ach_class'
+      @_hash['user'] = 'user'
+      @_hash['metadata'] = 'metadata'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        metadata
+        origination_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        origination_account_id
+      ]
+    end
+
+    def initialize(idempotency_key:, access_token:, account_id:,
+                   authorization_id:, type:, network:, amount:, description:,
+                   ach_class:, user:, client_id: SKIP, secret: SKIP,
+                   metadata: SKIP, origination_account_id: 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
+      @idempotency_key = idempotency_key
+      @access_token = access_token
+      @account_id = account_id
+      @authorization_id = authorization_id
+      @type = type
+      @network = network
+      @amount = amount
+      @description = description
+      @ach_class = ach_class
+      @user = user
+      @metadata = metadata unless metadata == SKIP
+      @origination_account_id = origination_account_id unless origination_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.
+      idempotency_key =
+        hash.key?('idempotency_key') ? hash['idempotency_key'] : nil
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      authorization_id =
+        hash.key?('authorization_id') ? hash['authorization_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      network = hash.key?('network') ? hash['network'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      ach_class = hash.key?('ach_class') ? hash['ach_class'] : nil
+      user = TransferUserInRequest.from_hash(hash['user']) if hash['user']
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      origination_account_id =
+        hash.key?('origination_account_id') ? hash['origination_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.
+      TransferCreateRequest.new(idempotency_key: idempotency_key,
+                                access_token: access_token,
+                                account_id: account_id,
+                                authorization_id: authorization_id,
+                                type: type,
+                                network: network,
+                                amount: amount,
+                                description: description,
+                                ach_class: ach_class,
+                                user: user,
+                                client_id: client_id,
+                                secret: secret,
+                                metadata: metadata,
+                                origination_account_id: origination_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} client_id: #{@client_id}, secret: #{@secret}, idempotency_key:"\
+      " #{@idempotency_key}, access_token: #{@access_token}, account_id: #{@account_id},"\
+      " authorization_id: #{@authorization_id}, type: #{@type}, network: #{@network}, amount:"\
+      " #{@amount}, description: #{@description}, ach_class: #{@ach_class}, user: #{@user},"\
+      " metadata: #{@metadata}, origination_account_id: #{@origination_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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect},"\
+      " idempotency_key: #{@idempotency_key.inspect}, access_token: #{@access_token.inspect},"\
+      " account_id: #{@account_id.inspect}, authorization_id: #{@authorization_id.inspect}, type:"\
+      " #{@type.inspect}, network: #{@network.inspect}, amount: #{@amount.inspect}, description:"\
+      " #{@description.inspect}, ach_class: #{@ach_class.inspect}, user: #{@user.inspect},"\
+      " metadata: #{@metadata.inspect}, origination_account_id:"\
+      " #{@origination_account_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_create_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 `/transfer/create`
+  class TransferCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Represents a transfer within the Transfers API.
+    # @return [Transfer]
+    attr_accessor :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['transfer'] = '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(transfer:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transfer = 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.
+      transfer = Transfer.from_hash(hash['transfer']) if hash['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.
+      TransferCreateResponse.new(transfer: 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} transfer: #{@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} transfer: #{@transfer.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_event.rb

@@ -0,0 +1,171 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # Represents an event in the Transfers API.
+  class TransferEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Plaid’s unique identifier for this event. IDs are sequential unsigned
+    # 64-bit integers.
+    # @return [Integer]
+    attr_accessor :event_id
+
+    # The datetime when this event occurred. This will be of the form
+    # `2006-01-02T15:04:05Z`.
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # The type of event that this 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.
+    # @return [TransferEventType]
+    attr_accessor :event_type
+
+    # The account ID associated with the transfer.
+    # @return [String]
+    attr_accessor :account_id
+
+    # Plaid’s unique identifier for a transfer.
+    # @return [String]
+    attr_accessor :transfer_id
+
+    # The ID of the origination account that this balance belongs to.
+    # @return [String]
+    attr_accessor :origination_account_id
+
+    # The type of transfer. This will be either `debit` or `credit`.  A `debit`
+    # indicates a transfer of money into the origination account; a `credit`
+    # indicates a transfer of money out of the origination account.
+    # @return [TransferType1]
+    attr_accessor :transfer_type
+
+    # The amount of the transfer (decimal string with two digits of precision
+    # e.g. “10.00”).
+    # @return [String]
+    attr_accessor :transfer_amount
+
+    # The failure reason if the type of this transfer is `"failed"` or
+    # `"reversed"`. Null value otherwise.
+    # @return [TransferFailure]
+    attr_accessor :failure_reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_id'] = 'event_id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['event_type'] = 'event_type'
+      @_hash['account_id'] = 'account_id'
+      @_hash['transfer_id'] = 'transfer_id'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash['transfer_type'] = 'transfer_type'
+      @_hash['transfer_amount'] = 'transfer_amount'
+      @_hash['failure_reason'] = 'failure_reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        origination_account_id
+      ]
+    end
+
+    def initialize(event_id:, timestamp:, event_type:, account_id:,
+                   transfer_id:, origination_account_id:, transfer_type:,
+                   transfer_amount:, failure_reason:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @event_id = event_id
+      @timestamp = timestamp
+      @event_type = event_type
+      @account_id = account_id
+      @transfer_id = transfer_id
+      @origination_account_id = origination_account_id
+      @transfer_type = transfer_type
+      @transfer_amount = transfer_amount
+      @failure_reason = failure_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.
+      event_id = hash.key?('event_id') ? hash['event_id'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      event_type = hash.key?('event_type') ? hash['event_type'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      transfer_id = hash.key?('transfer_id') ? hash['transfer_id'] : nil
+      origination_account_id =
+        hash.key?('origination_account_id') ? hash['origination_account_id'] : nil
+      transfer_type = hash.key?('transfer_type') ? hash['transfer_type'] : nil
+      transfer_amount =
+        hash.key?('transfer_amount') ? hash['transfer_amount'] : nil
+      failure_reason = TransferFailure.from_hash(hash['failure_reason']) if hash['failure_reason']
+
+      # 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.
+      TransferEvent.new(event_id: event_id,
+                        timestamp: timestamp,
+                        event_type: event_type,
+                        account_id: account_id,
+                        transfer_id: transfer_id,
+                        origination_account_id: origination_account_id,
+                        transfer_type: transfer_type,
+                        transfer_amount: transfer_amount,
+                        failure_reason: failure_reason,
+                        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} event_id: #{@event_id}, timestamp: #{@timestamp}, event_type:"\
+      " #{@event_type}, account_id: #{@account_id}, transfer_id: #{@transfer_id},"\
+      " origination_account_id: #{@origination_account_id}, transfer_type: #{@transfer_type},"\
+      " transfer_amount: #{@transfer_amount}, failure_reason: #{@failure_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} event_id: #{@event_id.inspect}, timestamp: #{@timestamp.inspect},"\
+      " event_type: #{@event_type.inspect}, account_id: #{@account_id.inspect}, transfer_id:"\
+      " #{@transfer_id.inspect}, origination_account_id: #{@origination_account_id.inspect},"\
+      " transfer_type: #{@transfer_type.inspect}, transfer_amount: #{@transfer_amount.inspect},"\
+      " failure_reason: #{@failure_reason.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end