apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/pending_expiration_webhook.rb

@@ -0,0 +1,112 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # Fired when an Item’s access consent is expiring in 7 days. Some Items have
+  # explicit expiration times and we try to relay this when possible to reduce
+  # service disruption. This can be resolved by having the user go through
+  # Link’s update mode.
+  class PendingExpirationWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `ITEM`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `PENDING_EXPIRATION`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # The date and time at which the Item's access consent will expire, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # @return [DateTime]
+    attr_accessor :consent_expiration_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_type'] = 'webhook_type'
+      @_hash['webhook_code'] = 'webhook_code'
+      @_hash['item_id'] = 'item_id'
+      @_hash['consent_expiration_time'] = 'consent_expiration_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, item_id:,
+                   consent_expiration_time:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @item_id = item_id
+      @consent_expiration_time = consent_expiration_time
+      @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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      consent_expiration_time = if hash.key?('consent_expiration_time')
+                                  (DateTimeHelper.from_rfc3339(hash['consent_expiration_time']) if hash['consent_expiration_time'])
+                                end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PendingExpirationWebhook.new(webhook_type: webhook_type,
+                                   webhook_code: webhook_code,
+                                   item_id: item_id,
+                                   consent_expiration_time: consent_expiration_time,
+                                   additional_properties: additional_properties)
+    end
+
+    def to_custom_consent_expiration_time
+      DateTimeHelper.to_rfc3339(consent_expiration_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, item_id:"\
+      " #{@item_id}, consent_expiration_time: #{@consent_expiration_time}, 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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, item_id: #{@item_id.inspect}, consent_expiration_time:"\
+      " #{@consent_expiration_time.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/personal_finance_category.rb

@@ -0,0 +1,87 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Information describing the intent of the transaction. Most relevant for
+  # personal finance use cases, but not limited to such use cases. The field is
+  # currently in beta. The complete category can be generated by concatenating
+  # primary and detailed categories. This feature is currently in beta – to
+  # request access, contact transactions-feedback@plaid.com.
+  class PersonalFinanceCategory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A high level category that communicates the broad category of the
+    # transaction.
+    # @return [String]
+    attr_accessor :primary
+
+    # Provides additional granularity to the primary categorization.
+    # @return [String]
+    attr_accessor :detailed
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['primary'] = 'primary'
+      @_hash['detailed'] = 'detailed'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(primary:, detailed:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @primary = primary
+      @detailed = detailed
+      @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.
+      primary = hash.key?('primary') ? hash['primary'] : nil
+      detailed = hash.key?('detailed') ? hash['detailed'] : 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.
+      PersonalFinanceCategory.new(primary: primary,
+                                  detailed: detailed,
+                                  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} primary: #{@primary}, detailed: #{@detailed}, 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} primary: #{@primary.inspect}, detailed: #{@detailed.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/personal_finance_category2.rb

@@ -0,0 +1,83 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # PersonalFinanceCategory2 Model.
+  class PersonalFinanceCategory2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A high level category that communicates the broad category of the
+    # transaction.
+    # @return [String]
+    attr_accessor :primary
+
+    # Provides additional granularity to the primary categorization.
+    # @return [String]
+    attr_accessor :detailed
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['primary'] = 'primary'
+      @_hash['detailed'] = 'detailed'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(primary:, detailed:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @primary = primary
+      @detailed = detailed
+      @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.
+      primary = hash.key?('primary') ? hash['primary'] : nil
+      detailed = hash.key?('detailed') ? hash['detailed'] : 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.
+      PersonalFinanceCategory2.new(primary: primary,
+                                   detailed: detailed,
+                                   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} primary: #{@primary}, detailed: #{@detailed}, 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} primary: #{@primary.inspect}, detailed: #{@detailed.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/phone_number.rb

@@ -0,0 +1,91 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A phone number
+  class PhoneNumber < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The phone number.
+    # @return [String]
+    attr_accessor :data
+
+    # When `true`, identifies the phone number as the primary number on an
+    # account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # The type of phone number.
+    # @return [Type]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['primary'] = 'primary'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, primary:, type:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @primary = primary
+      @type = type
+      @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.
+      data = hash.key?('data') ? hash['data'] : nil
+      primary = hash.key?('primary') ? hash['primary'] : nil
+      type = hash.key?('type') ? hash['type'] : 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.
+      PhoneNumber.new(data: data,
+                      primary: primary,
+                      type: type,
+                      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} data: #{@data}, primary: #{@primary}, type: #{@type},"\
+      " 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} data: #{@data.inspect}, primary: #{@primary.inspect}, type:"\
+      " #{@type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/processor.rb

@@ -0,0 +1,116 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The processor you are integrating with.
+  class Processor
+    PROCESSOR = [
+      # TODO: Write general description for ACHQ
+      ACHQ = 'achq'.freeze,
+
+      # TODO: Write general description for ALPACA
+      ALPACA = 'alpaca'.freeze,
+
+      # TODO: Write general description for ASTRA
+      ASTRA = 'astra'.freeze,
+
+      # TODO: Write general description for CHECK
+      CHECK = 'check'.freeze,
+
+      # TODO: Write general description for CHECKBOOK
+      CHECKBOOK = 'checkbook'.freeze,
+
+      # TODO: Write general description for CIRCLE
+      CIRCLE = 'circle'.freeze,
+
+      # TODO: Write general description for DRIVEWEALTH
+      DRIVEWEALTH = 'drivewealth'.freeze,
+
+      # TODO: Write general description for DWOLLA
+      DWOLLA = 'dwolla'.freeze,
+
+      # TODO: Write general description for GALILEO
+      GALILEO = 'galileo'.freeze,
+
+      # TODO: Write general description for LITHIC
+      LITHIC = 'lithic'.freeze,
+
+      # TODO: Write general description for MODERN_TREASURY
+      MODERN_TREASURY = 'modern_treasury'.freeze,
+
+      # TODO: Write general description for MOOV
+      MOOV = 'moov'.freeze,
+
+      # TODO: Write general description for OCROLUS
+      OCROLUS = 'ocrolus'.freeze,
+
+      # TODO: Write general description for PRIME_TRUST
+      PRIME_TRUST = 'prime_trust'.freeze,
+
+      # TODO: Write general description for RIZE
+      RIZE = 'rize'.freeze,
+
+      # TODO: Write general description for SILA_MONEY
+      SILA_MONEY = 'sila_money'.freeze,
+
+      # TODO: Write general description for SVB_API
+      SVB_API = 'svb_api'.freeze,
+
+      # TODO: Write general description for TREASURY_PRIME
+      TREASURY_PRIME = 'treasury_prime'.freeze,
+
+      # TODO: Write general description for UNIT
+      UNIT = 'unit'.freeze,
+
+      # TODO: Write general description for VESTA
+      VESTA = 'vesta'.freeze,
+
+      # TODO: Write general description for VOPAY
+      VOPAY = 'vopay'.freeze,
+
+      # TODO: Write general description for WYRE
+      WYRE = 'wyre'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACHQ)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'achq' then ACHQ
+      when 'alpaca' then ALPACA
+      when 'astra' then ASTRA
+      when 'check' then CHECK
+      when 'checkbook' then CHECKBOOK
+      when 'circle' then CIRCLE
+      when 'drivewealth' then DRIVEWEALTH
+      when 'dwolla' then DWOLLA
+      when 'galileo' then GALILEO
+      when 'lithic' then LITHIC
+      when 'modern_treasury' then MODERN_TREASURY
+      when 'moov' then MOOV
+      when 'ocrolus' then OCROLUS
+      when 'prime_trust' then PRIME_TRUST
+      when 'rize' then RIZE
+      when 'sila_money' then SILA_MONEY
+      when 'svb_api' then SVB_API
+      when 'treasury_prime' then TREASURY_PRIME
+      when 'unit' then UNIT
+      when 'vesta' then VESTA
+      when 'vopay' then VOPAY
+      when 'wyre' then WYRE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/processor_apex_processor_token_create_request.rb

@@ -0,0 +1,108 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ProcessorApexProcessorTokenCreateRequest defines the request schema for
+  # `/processor/apex/processor_token/create`
+  class ProcessorApexProcessorTokenCreateRequest < 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 access token associated with the Item data is being requested for.
+    # @return [String]
+    attr_accessor :access_token
+
+    # The `account_id` value obtained from the `onSuccess` callback in Link
+    # @return [String]
+    attr_accessor :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['access_token'] = 'access_token'
+      @_hash['account_id'] = 'account_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(access_token:, account_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
+      @access_token = access_token
+      @account_id = account_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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      account_id = hash.key?('account_id') ? hash['account_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.
+      ProcessorApexProcessorTokenCreateRequest.new(access_token: access_token,
+                                                   account_id: account_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}, access_token:"\
+      " #{@access_token}, account_id: #{@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}, access_token:"\
+      " #{@access_token.inspect}, account_id: #{@account_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/processor_auth_get_request.rb

@@ -0,0 +1,100 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ProcessorAuthGetRequest defines the request schema for `/processor/auth/get`
+  class ProcessorAuthGetRequest < 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 processor token obtained from the Plaid integration partner. Processor
+    # tokens are in the format: `processor-<environment>-<identifier>`
+    # @return [String]
+    attr_accessor :processor_token
+
+    # 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['processor_token'] = 'processor_token'
+      @_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(processor_token:, 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
+      @processor_token = processor_token
+      @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.
+      processor_token =
+        hash.key?('processor_token') ? hash['processor_token'] : 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.
+      ProcessorAuthGetRequest.new(processor_token: processor_token,
+                                  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}, processor_token:"\
+      " #{@processor_token}, 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},"\
+      " processor_token: #{@processor_token.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end