apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/asset_report_remove_response.rb

@@ -0,0 +1,85 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportRemoveResponse defines the response schema for
+  # `/asset_report/remove`
+  class AssetReportRemoveResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `true` if the Asset Report was successfully removed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :removed
+
+    # 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['removed'] = 'removed'
+      @_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(removed:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @removed = removed
+      @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.
+      removed = hash.key?('removed') ? hash['removed'] : 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.
+      AssetReportRemoveResponse.new(removed: removed,
+                                    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} removed: #{@removed}, 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} removed: #{@removed.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_transaction.rb

@@ -0,0 +1,296 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AssetReportTransaction Model.
+  class AssetReportTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Please use the `payment_channel` field, `transaction_type` will be
+    # deprecated in the future.
+    # `digital:` transactions that took place online.
+    # `place:` transactions that were made at a physical location.
+    # `special:` transactions that relate to banks, e.g. fees or deposits.
+    # `unresolved:` transactions that do not fit into the other three types.
+    # @return [TransactionType]
+    attr_accessor :transaction_type
+
+    # The ID of a posted transaction's associated pending transaction, where
+    # applicable.
+    # @return [String]
+    attr_accessor :pending_transaction_id
+
+    # The ID of the category to which this transaction belongs. See
+    # [Categories](https://plaid.com/docs/#category-overview).
+    # If the `transactions` object was returned by an Assets endpoint such as
+    # `/asset_report/get/` or `/asset_report/pdf/get`, this field will only
+    # appear in an Asset Report with Insights.
+    # @return [String]
+    attr_accessor :category_id
+
+    # A hierarchical array of the categories to which this transaction belongs.
+    # See [Categories](https://plaid.com/docs/#category-overview).
+    # If the `transactions` object was returned by an Assets endpoint such as
+    # `/asset_report/get/` or `/asset_report/pdf/get`, this field will only
+    # appear in an Asset Report with Insights.
+    # @return [Array[String]]
+    attr_accessor :category
+
+    # A representation of where a transaction took place
+    # @return [TransactionLocation]
+    attr_accessor :location
+
+    # Transaction information specific to inter-bank transfers. If the
+    # transaction was not an inter-bank transfer, all fields will be `null`.
+    # If the `transactions` object was returned by a Transactions endpoint such
+    # as `/transactions/get`, the `payment_meta` key will always appear, but no
+    # data elements are guaranteed. If the `transactions` object was returned by
+    # an Assets endpoint such as `/asset_report/get/` or
+    # `/asset_report/pdf/get`, this field will only appear in an Asset Report
+    # with Insights.
+    # @return [PaymentMeta]
+    attr_accessor :payment_meta
+
+    # The name of the account owner. This field is not typically populated and
+    # only relevant when dealing with sub-accounts.
+    # @return [String]
+    attr_accessor :account_owner
+
+    # The merchant name or transaction description.
+    # If the `transactions` object was returned by a Transactions endpoint such
+    # as `/transactions/get`, this field will always appear. If the
+    # `transactions` object was returned by an Assets endpoint such as
+    # `/asset_report/get/` or `/asset_report/pdf/get`, this field will only
+    # appear in an Asset Report with Insights.
+    # @return [String]
+    attr_accessor :name
+
+    # The string returned by the financial institution to describe the
+    # transaction. For transactions returned by `/transactions/get`, this field
+    # is in beta and will be omitted unless the client is both enrolled in the
+    # closed beta program and has set `options.include_original_description` to
+    # `true`.
+    # @return [String]
+    attr_accessor :original_description
+
+    # The ID of the account in which this transaction occurred.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The settled value of the transaction, denominated in the account's
+    # currency, as stated in `iso_currency_code` or `unofficial_currency_code`.
+    # Positive values when money moves out of the account; negative values when
+    # money moves in. For example, debit card purchases are positive; credit
+    # card payments, direct deposits, and refunds are negative.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The ISO-4217 currency code of the transaction. Always `null` if
+    # `unofficial_currency_code` is non-null.
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # The unofficial currency code associated with the transaction. Always
+    # `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are
+    # used for currencies that do not have official ISO currency codes, such as
+    # cryptocurrencies and the currencies of certain countries.
+    # See the [currency code
+    # schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a
+    # full listing of supported `iso_currency_code`s.
+    # @return [String]
+    attr_accessor :unofficial_currency_code
+
+    # For pending transactions, the date that the transaction occurred; for
+    # posted transactions, the date that the transaction posted. Both dates are
+    # returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (
+    # `YYYY-MM-DD` ).
+    # @return [Date]
+    attr_accessor :date
+
+    # When `true`, identifies the transaction as pending or unsettled. Pending
+    # transaction details (name, type, amount, category ID) may change before
+    # they are settled.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pending
+
+    # The unique ID of the transaction. Like all Plaid identifiers, the
+    # `transaction_id` is case sensitive.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # The date on which the transaction took place, in IS0 8601 format.
+    # @return [String]
+    attr_accessor :date_transacted
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['pending_transaction_id'] = 'pending_transaction_id'
+      @_hash['category_id'] = 'category_id'
+      @_hash['category'] = 'category'
+      @_hash['location'] = 'location'
+      @_hash['payment_meta'] = 'payment_meta'
+      @_hash['account_owner'] = 'account_owner'
+      @_hash['name'] = 'name'
+      @_hash['original_description'] = 'original_description'
+      @_hash['account_id'] = 'account_id'
+      @_hash['amount'] = 'amount'
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['unofficial_currency_code'] = 'unofficial_currency_code'
+      @_hash['date'] = 'date'
+      @_hash['pending'] = 'pending'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['date_transacted'] = 'date_transacted'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_type
+        pending_transaction_id
+        category_id
+        category
+        location
+        payment_meta
+        account_owner
+        name
+        date_transacted
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        pending_transaction_id
+        category_id
+        category
+        account_owner
+        original_description
+        iso_currency_code
+        unofficial_currency_code
+        date_transacted
+      ]
+    end
+
+    def initialize(original_description:, account_id:, amount:,
+                   iso_currency_code:, unofficial_currency_code:, date:,
+                   pending:, transaction_id:, transaction_type: SKIP,
+                   pending_transaction_id: SKIP, category_id: SKIP,
+                   category: SKIP, location: SKIP, payment_meta: SKIP,
+                   account_owner: SKIP, name: SKIP, date_transacted: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @pending_transaction_id = pending_transaction_id unless pending_transaction_id == SKIP
+      @category_id = category_id unless category_id == SKIP
+      @category = category unless category == SKIP
+      @location = location unless location == SKIP
+      @payment_meta = payment_meta unless payment_meta == SKIP
+      @account_owner = account_owner unless account_owner == SKIP
+      @name = name unless name == SKIP
+      @original_description = original_description
+      @account_id = account_id
+      @amount = amount
+      @iso_currency_code = iso_currency_code
+      @unofficial_currency_code = unofficial_currency_code
+      @date = date
+      @pending = pending
+      @transaction_id = transaction_id
+      @date_transacted = date_transacted unless date_transacted == 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.
+      original_description =
+        hash.key?('original_description') ? hash['original_description'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      iso_currency_code =
+        hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
+      unofficial_currency_code =
+        hash.key?('unofficial_currency_code') ? hash['unofficial_currency_code'] : nil
+      date = hash.key?('date') ? hash['date'] : nil
+      pending = hash.key?('pending') ? hash['pending'] : nil
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : nil
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      pending_transaction_id =
+        hash.key?('pending_transaction_id') ? hash['pending_transaction_id'] : SKIP
+      category_id = hash.key?('category_id') ? hash['category_id'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      location = TransactionLocation.from_hash(hash['location']) if hash['location']
+      payment_meta = PaymentMeta.from_hash(hash['payment_meta']) if hash['payment_meta']
+      account_owner = hash.key?('account_owner') ? hash['account_owner'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      date_transacted =
+        hash.key?('date_transacted') ? hash['date_transacted'] : 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.
+      AssetReportTransaction.new(original_description: original_description,
+                                 account_id: account_id,
+                                 amount: amount,
+                                 iso_currency_code: iso_currency_code,
+                                 unofficial_currency_code: unofficial_currency_code,
+                                 date: date,
+                                 pending: pending,
+                                 transaction_id: transaction_id,
+                                 transaction_type: transaction_type,
+                                 pending_transaction_id: pending_transaction_id,
+                                 category_id: category_id,
+                                 category: category,
+                                 location: location,
+                                 payment_meta: payment_meta,
+                                 account_owner: account_owner,
+                                 name: name,
+                                 date_transacted: date_transacted,
+                                 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} transaction_type: #{@transaction_type}, pending_transaction_id:"\
+      " #{@pending_transaction_id}, category_id: #{@category_id}, category: #{@category},"\
+      " location: #{@location}, payment_meta: #{@payment_meta}, account_owner: #{@account_owner},"\
+      " name: #{@name}, original_description: #{@original_description}, account_id:"\
+      " #{@account_id}, amount: #{@amount}, iso_currency_code: #{@iso_currency_code},"\
+      " unofficial_currency_code: #{@unofficial_currency_code}, date: #{@date}, pending:"\
+      " #{@pending}, transaction_id: #{@transaction_id}, date_transacted: #{@date_transacted},"\
+      " 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} transaction_type: #{@transaction_type.inspect}, pending_transaction_id:"\
+      " #{@pending_transaction_id.inspect}, category_id: #{@category_id.inspect}, category:"\
+      " #{@category.inspect}, location: #{@location.inspect}, payment_meta:"\
+      " #{@payment_meta.inspect}, account_owner: #{@account_owner.inspect}, name:"\
+      " #{@name.inspect}, original_description: #{@original_description.inspect}, account_id:"\
+      " #{@account_id.inspect}, amount: #{@amount.inspect}, iso_currency_code:"\
+      " #{@iso_currency_code.inspect}, unofficial_currency_code:"\
+      " #{@unofficial_currency_code.inspect}, date: #{@date.inspect}, pending:"\
+      " #{@pending.inspect}, transaction_id: #{@transaction_id.inspect}, date_transacted:"\
+      " #{@date_transacted.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/asset_report_user.rb

@@ -0,0 +1,153 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The user object allows you to provide additional information about the user
+  # to be appended to the Asset Report. All fields are optional. The
+  # `first_name`, `last_name`, and `ssn` fields are required if you would like
+  # the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
+  class AssetReportUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An identifier you determine and submit for the user.
+    # @return [String]
+    attr_accessor :client_user_id
+
+    # The user's first name. Required for the Fannie Mae Day 1 Certainty™
+    # program.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The user's middle name
+    # @return [String]
+    attr_accessor :middle_name
+
+    # The user's last name.  Required for the Fannie Mae Day 1 Certainty™
+    # program.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The user's Social Security Number. Required for the Fannie Mae Day 1
+    # Certainty™ program.
+    # Format: "ddd-dd-dddd"
+    # @return [String]
+    attr_accessor :ssn
+
+    # The user's phone number, in E.164 format: +{countrycode}{number}. For
+    # example: "+14151234567". Phone numbers provided in other formats will be
+    # parsed on a best-effort basis.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The user's email address.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_user_id'] = 'client_user_id'
+      @_hash['first_name'] = 'first_name'
+      @_hash['middle_name'] = 'middle_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['ssn'] = 'ssn'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_user_id
+        first_name
+        middle_name
+        last_name
+        ssn
+        phone_number
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        client_user_id
+        first_name
+        middle_name
+        last_name
+        ssn
+        phone_number
+        email
+      ]
+    end
+
+    def initialize(client_user_id: SKIP, first_name: SKIP, middle_name: SKIP,
+                   last_name: SKIP, ssn: SKIP, phone_number: SKIP, email: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_user_id = client_user_id unless client_user_id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @ssn = ssn unless ssn == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @email = email unless email == 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_user_id =
+        hash.key?('client_user_id') ? hash['client_user_id'] : SKIP
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      ssn = hash.key?('ssn') ? hash['ssn'] : SKIP
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+      email = hash.key?('email') ? hash['email'] : 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.
+      AssetReportUser.new(client_user_id: client_user_id,
+                          first_name: first_name,
+                          middle_name: middle_name,
+                          last_name: last_name,
+                          ssn: ssn,
+                          phone_number: phone_number,
+                          email: email,
+                          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_user_id: #{@client_user_id}, first_name: #{@first_name},"\
+      " middle_name: #{@middle_name}, last_name: #{@last_name}, ssn: #{@ssn}, phone_number:"\
+      " #{@phone_number}, email: #{@email}, 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_user_id: #{@client_user_id.inspect}, first_name:"\
+      " #{@first_name.inspect}, middle_name: #{@middle_name.inspect}, last_name:"\
+      " #{@last_name.inspect}, ssn: #{@ssn.inspect}, phone_number: #{@phone_number.inspect},"\
+      " email: #{@email.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/assets_error_webhook.rb

@@ -0,0 +1,107 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when Asset Report generation has failed. The resulting `error` will
+  # have an `error_type` of `ASSET_REPORT_ERROR`.
+  class AssetsErrorWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `ASSETS`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `ERROR`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # We use standard HTTP response codes for success and failure notifications,
+    # and our errors are further classified by `error_type`. In general, 200
+    # HTTP codes correspond to success, 40X codes are for developer- or
+    # user-related failures, and 50X codes are for Plaid-related issues.  Error
+    # fields will be `null` if no error has occurred.
+    # @return [Error]
+    attr_accessor :error
+
+    # The ID associated with the Asset Report.
+    # @return [String]
+    attr_accessor :asset_report_id
+
+    # 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['error'] = 'error'
+      @_hash['asset_report_id'] = 'asset_report_id'
+      @_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:, error:, asset_report_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @error = error
+      @asset_report_id = asset_report_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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      error = Error.from_hash(hash['error']) if hash['error']
+      asset_report_id =
+        hash.key?('asset_report_id') ? hash['asset_report_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.
+      AssetsErrorWebhook.new(webhook_type: webhook_type,
+                             webhook_code: webhook_code,
+                             error: error,
+                             asset_report_id: asset_report_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} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, error:"\
+      " #{@error}, asset_report_id: #{@asset_report_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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, error: #{@error.inspect}, asset_report_id:"\
+      " #{@asset_report_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end