apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/transfer_get_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/get`
+  class TransferGetRequest < 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.
+      TransferGetRequest.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_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 `/transfer/get`
+  class TransferGetResponse < 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.
+      TransferGetResponse.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_list_request.rb

@@ -0,0 +1,163 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # Defines the request schema for `/transfer/list`
+  class TransferListRequest < 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 start datetime of transfers to list. This should be in RFC 3339 format
+    # (i.e. `2019-12-06T22:35:49Z`)
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end datetime of transfers to list. This should be in RFC 3339 format
+    # (i.e. `2019-12-06T22:35:49Z`)
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The maximum number of transfers to return.
+    # @return [Integer]
+    attr_accessor :count
+
+    # The number of transfers to skip before returning results.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # Filter transfers to only those originated through the specified
+    # origination account.
+    # @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['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['count'] = 'count'
+      @_hash['offset'] = 'offset'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        start_date
+        end_date
+        count
+        offset
+        origination_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+        origination_account_id
+      ]
+    end
+
+    def initialize(client_id: SKIP, secret: SKIP, start_date: SKIP,
+                   end_date: SKIP, count: 25, offset: 0,
+                   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
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @count = count unless count == SKIP
+      @offset = offset unless offset == 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.
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   else
+                     SKIP
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 else
+                   SKIP
+                 end
+      count = hash['count'] ||= 25
+      offset = hash['offset'] ||= 0
+      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.
+      TransferListRequest.new(client_id: client_id,
+                              secret: secret,
+                              start_date: start_date,
+                              end_date: end_date,
+                              count: count,
+                              offset: offset,
+                              origination_account_id: origination_account_id,
+                              additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    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}, start_date: #{@start_date},"\
+      " end_date: #{@end_date}, count: #{@count}, offset: #{@offset}, 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}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, count: #{@count.inspect}, offset:"\
+      " #{@offset.inspect}, origination_account_id: #{@origination_account_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_list_response.rb

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

data/lib/plaid/models/transfer_network.rb

@@ -0,0 +1,37 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The network or rails used for the transfer. Valid options are `ach` or
+  # `same-day-ach`.
+  class TransferNetwork
+    TRANSFER_NETWORK = [
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for SAMEDAYACH
+      SAMEDAYACH = 'same-day-ach'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ach' then ACH
+      when 'samedayach' then SAMEDAYACH
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/transfer_status.rb

@@ -0,0 +1,48 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The status of the transfer.
+  class TransferStatus
+    TRANSFER_STATUS = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for POSTED
+      POSTED = 'posted'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for REVERSED
+      REVERSED = 'reversed'.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 'posted' then POSTED
+      when 'cancelled' then CANCELLED
+      when 'failed' then FAILED
+      when 'reversed' then REVERSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/transfer_type.rb

@@ -0,0 +1,146 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Activity that modifies a position, but not through buy/sell activity e.g.
+  # options exercise, portfolio transfer
+  class TransferType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Assignment of short option holding
+    # @return [String]
+    attr_accessor :assignment
+
+    # Increase or decrease in quantity of item
+    # @return [String]
+    attr_accessor :adjustment
+
+    # Exercise of an option or warrant contract
+    # @return [String]
+    attr_accessor :exercise
+
+    # Expiration of an option or warrant contract
+    # @return [String]
+    attr_accessor :expire
+
+    # Stock exchanged at a pre-defined ratio as part of a merger between
+    # companies
+    # @return [String]
+    attr_accessor :merger
+
+    # Inflow of stock from spin-off transaction of an existing holding
+    # @return [String]
+    attr_accessor :spin_off
+
+    # Inflow of stock from a forward split of an existing holding
+    # @return [String]
+    attr_accessor :split
+
+    # Movement of assets into or out of an account
+    # @return [String]
+    attr_accessor :transfer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['assignment'] = 'assignment'
+      @_hash['adjustment'] = 'adjustment'
+      @_hash['exercise'] = 'exercise'
+      @_hash['expire'] = 'expire'
+      @_hash['merger'] = 'merger'
+      @_hash['spin_off'] = 'spin off'
+      @_hash['split'] = 'split'
+      @_hash['transfer'] = 'transfer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assignment
+        adjustment
+        exercise
+        expire
+        merger
+        spin_off
+        split
+        transfer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(assignment: SKIP, adjustment: SKIP, exercise: SKIP,
+                   expire: SKIP, merger: SKIP, spin_off: SKIP, split: SKIP,
+                   transfer: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @assignment = assignment unless assignment == SKIP
+      @adjustment = adjustment unless adjustment == SKIP
+      @exercise = exercise unless exercise == SKIP
+      @expire = expire unless expire == SKIP
+      @merger = merger unless merger == SKIP
+      @spin_off = spin_off unless spin_off == SKIP
+      @split = split unless split == SKIP
+      @transfer = transfer unless transfer == 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.
+      assignment = hash.key?('assignment') ? hash['assignment'] : SKIP
+      adjustment = hash.key?('adjustment') ? hash['adjustment'] : SKIP
+      exercise = hash.key?('exercise') ? hash['exercise'] : SKIP
+      expire = hash.key?('expire') ? hash['expire'] : SKIP
+      merger = hash.key?('merger') ? hash['merger'] : SKIP
+      spin_off = hash.key?('spin off') ? hash['spin off'] : SKIP
+      split = hash.key?('split') ? hash['split'] : SKIP
+      transfer = hash.key?('transfer') ? hash['transfer'] : 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.
+      TransferType.new(assignment: assignment,
+                       adjustment: adjustment,
+                       exercise: exercise,
+                       expire: expire,
+                       merger: merger,
+                       spin_off: spin_off,
+                       split: split,
+                       transfer: transfer,
+                       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} assignment: #{@assignment}, adjustment: #{@adjustment}, exercise:"\
+      " #{@exercise}, expire: #{@expire}, merger: #{@merger}, spin_off: #{@spin_off}, split:"\
+      " #{@split}, transfer: #{@transfer}, 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} assignment: #{@assignment.inspect}, adjustment: #{@adjustment.inspect},"\
+      " exercise: #{@exercise.inspect}, expire: #{@expire.inspect}, merger: #{@merger.inspect},"\
+      " spin_off: #{@spin_off.inspect}, split: #{@split.inspect}, transfer: #{@transfer.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end