apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/link_token_create_request_income_verification.rb

@@ -0,0 +1,94 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specifies options for initializing Link for use with the Income (beta)
+  # product. This field is required if `income_verification` is included in the
+  # `products` array.
+  class LinkTokenCreateRequestIncomeVerification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The `income_verification_id` of the verification instance, as provided by
+    # `/income/verification/create`.
+    # @return [String]
+    attr_accessor :income_verification_id
+
+    # The `asset_report_id` of an asset report associated with the user, as
+    # provided by `/asset_report/create`. Providing an `asset_report_id` is
+    # optional and can be used to verify the user through a streamlined flow. If
+    # provided, the bank linking flow will be skipped.
+    # @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['income_verification_id'] = 'income_verification_id'
+      @_hash['asset_report_id'] = 'asset_report_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_report_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(income_verification_id:, asset_report_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @income_verification_id = income_verification_id
+      @asset_report_id = asset_report_id unless asset_report_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.
+      income_verification_id =
+        hash.key?('income_verification_id') ? hash['income_verification_id'] : nil
+      asset_report_id =
+        hash.key?('asset_report_id') ? hash['asset_report_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.
+      LinkTokenCreateRequestIncomeVerification.new(income_verification_id: income_verification_id,
+                                                   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} income_verification_id: #{@income_verification_id}, 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} income_verification_id: #{@income_verification_id.inspect},"\
+      " asset_report_id: #{@asset_report_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/link_token_create_request_payment_initiation.rb

@@ -0,0 +1,77 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specifies options for initializing Link for use with the Payment Initiation
+  # (Europe) product. This field is required if `payment_initiation` is included
+  # in the `products` array.
+  class LinkTokenCreateRequestPaymentInitiation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The `payment_id` provided by the `/payment_initiation/payment/create`
+    # endpoint.
+    # @return [String]
+    attr_accessor :payment_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_id'] = 'payment_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_id = payment_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.
+      payment_id = hash.key?('payment_id') ? hash['payment_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.
+      LinkTokenCreateRequestPaymentInitiation.new(payment_id: payment_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} payment_id: #{@payment_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} payment_id: #{@payment_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/link_token_create_request_update.rb

@@ -0,0 +1,82 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specifies options for initializing Link for [update
+  # mode](https://plaid.com/docs/link/update-mode).
+  class LinkTokenCreateRequestUpdate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If `true`, enables [update mode with Account
+    # Select](https://plaid.com/docs/link/update-mode/#using-update-mode-to-requ
+    # est-new-accounts).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :account_selection_enabled
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_selection_enabled'] = 'account_selection_enabled'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_selection_enabled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_selection_enabled: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless account_selection_enabled == SKIP
+        @account_selection_enabled =
+          account_selection_enabled
+      end
+      @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.
+      account_selection_enabled = hash['account_selection_enabled'] ||= false
+
+      # 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.
+      LinkTokenCreateRequestUpdate.new(account_selection_enabled: account_selection_enabled,
+                                       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} account_selection_enabled: #{@account_selection_enabled},"\
+      " 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} account_selection_enabled: #{@account_selection_enabled.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/link_token_create_request_user.rb

@@ -0,0 +1,201 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # An object specifying information about the end user who will be linking
+  # their account.
+  class LinkTokenCreateRequestUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique ID representing the end user. Typically this will be a user ID
+    # number from your application. Personally identifiable information, such as
+    # an email address or phone number, should not be used in the
+    # `client_user_id`. It is currently used as a means of searching logs for
+    # the given user in the Plaid Dashboard.
+    # @return [String]
+    attr_accessor :client_user_id
+
+    # The user's full legal name. This is an optional field used in the
+    # [returning user experience](https://plaid.com/docs/link/returning-user) to
+    # associate Items to the user.
+    # @return [String]
+    attr_accessor :legal_name
+
+    # The user's phone number in [E.164](https://en.wikipedia.org/wiki/E.164)
+    # format. This field is optional, but required to enable the [returning user
+    # experience](https://plaid.com/docs/link/returning-user).
+    # @return [String]
+    attr_accessor :phone_number
+
+    # The date and time the phone number was verified in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (`YYYY-MM-DDThh:mm:ssZ`). This field is optional, but required to enable
+    # any [returning user
+    # experience](https://plaid.com/docs/link/returning-user).
+    #  Only pass a verification time for a phone number that you have verified.
+    # If you have performed verification but don’t have the time, you may supply
+    # a signal value of the start of the UNIX epoch.
+    #  Example: `2020-01-01T00:00:00Z`
+    # @return [DateTime]
+    attr_accessor :phone_number_verified_time
+
+    # The user's email address. This field is optional, but required to enable
+    # the [pre-authenticated returning user
+    # flow](https://plaid.com/docs/link/returning-user/#enabling-the-returning-u
+    # ser-experience).
+    # @return [String]
+    attr_accessor :email_address
+
+    # The date and time the email address was verified in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (`YYYY-MM-DDThh:mm:ssZ`). This is an optional field used in the [returning
+    # user experience](https://plaid.com/docs/link/returning-user).
+    #  Only pass a verification time for an email address that you have
+    # verified. If you have performed verification but don’t have the time, you
+    # may supply a signal value of the start of the UNIX epoch.
+    #  Example: `2020-01-01T00:00:00Z`
+    # @return [DateTime]
+    attr_accessor :email_address_verified_time
+
+    # To be provided in the format "ddd-dd-dddd". This field is optional and
+    # will support not-yet-implemented functionality for new products.
+    # @return [String]
+    attr_accessor :ssn
+
+    # To be provided in the format "yyyy-mm-dd". This field is optional and will
+    # support not-yet-implemented functionality for new products.
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # 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['legal_name'] = 'legal_name'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['phone_number_verified_time'] = 'phone_number_verified_time'
+      @_hash['email_address'] = 'email_address'
+      @_hash['email_address_verified_time'] = 'email_address_verified_time'
+      @_hash['ssn'] = 'ssn'
+      @_hash['date_of_birth'] = 'date_of_birth'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        legal_name
+        phone_number
+        phone_number_verified_time
+        email_address
+        email_address_verified_time
+        ssn
+        date_of_birth
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_user_id:, legal_name: SKIP, phone_number: SKIP,
+                   phone_number_verified_time: SKIP, email_address: SKIP,
+                   email_address_verified_time: SKIP, ssn: SKIP,
+                   date_of_birth: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_user_id = client_user_id
+      @legal_name = legal_name unless legal_name == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      unless phone_number_verified_time == SKIP
+        @phone_number_verified_time =
+          phone_number_verified_time
+      end
+      @email_address = email_address unless email_address == SKIP
+      unless email_address_verified_time == SKIP
+        @email_address_verified_time =
+          email_address_verified_time
+      end
+      @ssn = ssn unless ssn == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == 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'] : nil
+      legal_name = hash.key?('legal_name') ? hash['legal_name'] : SKIP
+      phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
+      phone_number_verified_time = if hash.key?('phone_number_verified_time')
+                                     (DateTimeHelper.from_rfc3339(hash['phone_number_verified_time']) if hash['phone_number_verified_time'])
+                                   else
+                                     SKIP
+                                   end
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      email_address_verified_time = if hash.key?('email_address_verified_time')
+                                      (DateTimeHelper.from_rfc3339(hash['email_address_verified_time']) if hash['email_address_verified_time'])
+                                    else
+                                      SKIP
+                                    end
+      ssn = hash.key?('ssn') ? hash['ssn'] : SKIP
+      date_of_birth = hash.key?('date_of_birth') ? hash['date_of_birth'] : 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.
+      LinkTokenCreateRequestUser.new(client_user_id: client_user_id,
+                                     legal_name: legal_name,
+                                     phone_number: phone_number,
+                                     phone_number_verified_time: phone_number_verified_time,
+                                     email_address: email_address,
+                                     email_address_verified_time: email_address_verified_time,
+                                     ssn: ssn,
+                                     date_of_birth: date_of_birth,
+                                     additional_properties: additional_properties)
+    end
+
+    def to_custom_phone_number_verified_time
+      DateTimeHelper.to_rfc3339(phone_number_verified_time)
+    end
+
+    def to_custom_email_address_verified_time
+      DateTimeHelper.to_rfc3339(email_address_verified_time)
+    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}, legal_name: #{@legal_name},"\
+      " phone_number: #{@phone_number}, phone_number_verified_time:"\
+      " #{@phone_number_verified_time}, email_address: #{@email_address},"\
+      " email_address_verified_time: #{@email_address_verified_time}, ssn: #{@ssn}, date_of_birth:"\
+      " #{@date_of_birth}, 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}, legal_name:"\
+      " #{@legal_name.inspect}, phone_number: #{@phone_number.inspect},"\
+      " phone_number_verified_time: #{@phone_number_verified_time.inspect}, email_address:"\
+      " #{@email_address.inspect}, email_address_verified_time:"\
+      " #{@email_address_verified_time.inspect}, ssn: #{@ssn.inspect}, date_of_birth:"\
+      " #{@date_of_birth.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/link_token_create_response.rb

@@ -0,0 +1,107 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # LinkTokenCreateResponse defines the response schema for `/link/token/create`
+  class LinkTokenCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A `link_token`, which can be supplied to Link in order to initialize it
+    # and receive a `public_token`, which can be exchanged for an
+    # `access_token`.
+    # @return [String]
+    attr_accessor :link_token
+
+    # The expiration date for the `link_token`, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format. A `link_token` created
+    # to generate a `public_token` that will be exchanged for a new
+    # `access_token` expires after 4 hours. A `link_token` created for an
+    # existing Item (such as when updating an existing `access_token` by
+    # launching Link in update mode) expires after 30 minutes.
+    # @return [DateTime]
+    attr_accessor :expiration
+
+    # 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['link_token'] = 'link_token'
+      @_hash['expiration'] = 'expiration'
+      @_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(link_token:, expiration:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @link_token = link_token
+      @expiration = expiration
+      @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.
+      link_token = hash.key?('link_token') ? hash['link_token'] : nil
+      expiration = if hash.key?('expiration')
+                     (DateTimeHelper.from_rfc3339(hash['expiration']) if hash['expiration'])
+                   end
+      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.
+      LinkTokenCreateResponse.new(link_token: link_token,
+                                  expiration: expiration,
+                                  request_id: request_id,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_expiration
+      DateTimeHelper.to_rfc3339(expiration)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} link_token: #{@link_token}, expiration: #{@expiration}, 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} link_token: #{@link_token.inspect}, expiration: #{@expiration.inspect},"\
+      " request_id: #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/link_token_eu_config.rb

@@ -0,0 +1,75 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Configuration parameters for EU flows
+  class LinkTokenEuConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If `true`, open Link without an initial UI. Defaults to `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :headless
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['headless'] = 'headless'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        headless
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(headless: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @headless = headless unless headless == 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.
+      headless = hash.key?('headless') ? hash['headless'] : 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.
+      LinkTokenEuConfig.new(headless: headless,
+                            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} headless: #{@headless}, 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} headless: #{@headless.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end