apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/signal_evaluate_device.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Details about the end user's device
+  class SignalEvaluateDevice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The IP address of the device that initiated the transaction
+    # @return [String]
+    attr_accessor :ip_address
+
+    # The user agent of the device that initiated the transaction (e.g.
+    # "Mozilla/5.0")
+    # @return [String]
+    attr_accessor :user_agent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['user_agent'] = 'user_agent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ip_address
+        user_agent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ip_address
+        user_agent
+      ]
+    end
+
+    def initialize(ip_address: SKIP, user_agent: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ip_address = ip_address unless ip_address == SKIP
+      @user_agent = user_agent unless user_agent == 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.
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      user_agent = hash.key?('user_agent') ? hash['user_agent'] : 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.
+      SignalEvaluateDevice.new(ip_address: ip_address,
+                               user_agent: user_agent,
+                               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} ip_address: #{@ip_address}, user_agent: #{@user_agent},"\
+      " 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} ip_address: #{@ip_address.inspect}, user_agent: #{@user_agent.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/signal_evaluate_request.rb

@@ -0,0 +1,163 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SignalEvaluateRequest defines the request schema for `/signal/evaluate`
+  class SignalEvaluateRequest < 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` of the account whose verification status is to be
+    # modified
+    # @return [String]
+    attr_accessor :account_id
+
+    # The unique ID that you would like to use to refer to this transaction. For
+    # your convenience mapping your internal data, you could use your internal
+    # ID/identifier for this transaction. The max length for this field is 36
+    # characters.
+    # @return [String]
+    attr_accessor :client_transaction_id
+
+    # The transaction amount, in USD (e.g. `102.05`)
+    # @return [Float]
+    attr_accessor :amount
+
+    # A unique ID that identifies the end user in your system. This ID is used
+    # to correlate requests by a user with multiple Items. The max length for
+    # this field is 36 characters.
+    # @return [String]
+    attr_accessor :client_user_id
+
+    # Details about the end user initiating the transaction (i.e., the account
+    # holder).
+    # @return [SignalUser]
+    attr_accessor :user
+
+    # Details about the end user's device
+    # @return [SignalEvaluateDevice]
+    attr_accessor :device
+
+    # 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['client_transaction_id'] = 'client_transaction_id'
+      @_hash['amount'] = 'amount'
+      @_hash['client_user_id'] = 'client_user_id'
+      @_hash['user'] = 'user'
+      @_hash['device'] = 'device'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        client_user_id
+        user
+        device
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, account_id:, client_transaction_id:, amount:,
+                   client_id: SKIP, secret: SKIP, client_user_id: SKIP,
+                   user: SKIP, device: 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
+      @client_transaction_id = client_transaction_id
+      @amount = amount
+      @client_user_id = client_user_id unless client_user_id == SKIP
+      @user = user unless user == SKIP
+      @device = device unless device == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      client_transaction_id =
+        hash.key?('client_transaction_id') ? hash['client_transaction_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      client_user_id =
+        hash.key?('client_user_id') ? hash['client_user_id'] : SKIP
+      user = SignalUser.from_hash(hash['user']) if hash['user']
+      device = SignalEvaluateDevice.from_hash(hash['device']) if hash['device']
+
+      # 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.
+      SignalEvaluateRequest.new(access_token: access_token,
+                                account_id: account_id,
+                                client_transaction_id: client_transaction_id,
+                                amount: amount,
+                                client_id: client_id,
+                                secret: secret,
+                                client_user_id: client_user_id,
+                                user: user,
+                                device: device,
+                                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}, client_transaction_id:"\
+      " #{@client_transaction_id}, amount: #{@amount}, client_user_id: #{@client_user_id}, user:"\
+      " #{@user}, device: #{@device}, 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}, client_transaction_id:"\
+      " #{@client_transaction_id.inspect}, amount: #{@amount.inspect}, client_user_id:"\
+      " #{@client_user_id.inspect}, user: #{@user.inspect}, device: #{@device.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/signal_evaluate_response.rb

@@ -0,0 +1,99 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SignalEvaluateResponse defines the response schema for
+  # `/signal/income/evaluate`
+  class SignalEvaluateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Risk scoring details broken down by risk category.
+    # @return [SignalEvaluateScores]
+    attr_accessor :scores
+
+    # The core attributes object contains additional data that can be used to
+    # assess the ACH return risk, such as past ACH return events,
+    # balance/transaction history, the Item’s connection history in the Plaid
+    # network, and identity change history.
+    # @return [SignalEvaluateCoreAttributes]
+    attr_accessor :core_attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'request_id'
+      @_hash['scores'] = 'scores'
+      @_hash['core_attributes'] = 'core_attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id:, scores:, core_attributes:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @request_id = request_id
+      @scores = scores
+      @core_attributes = core_attributes
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+      scores = SignalEvaluateScores.from_hash(hash['scores']) if hash['scores']
+      core_attributes = SignalEvaluateCoreAttributes.from_hash(hash['core_attributes']) if
+        hash['core_attributes']
+
+      # 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.
+      SignalEvaluateResponse.new(request_id: request_id,
+                                 scores: scores,
+                                 core_attributes: core_attributes,
+                                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id}, scores: #{@scores}, core_attributes:"\
+      " #{@core_attributes}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} request_id: #{@request_id.inspect}, scores: #{@scores.inspect},"\
+      " core_attributes: #{@core_attributes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/signal_evaluate_scores.rb

@@ -0,0 +1,108 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Risk scoring details broken down by risk category.
+  class SignalEvaluateScores < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The object contains a risk score and a risk tier that evaluate the
+    # transaction return risk of an unauthorized debit. Common return codes in
+    # this category include: “R05”, "R07", "R10", "R11", "R29". These returns
+    # typically have a return time frame of up to 60 calendar days. During this
+    # period, the customer of financial institutions can dispute a transaction
+    # as unauthorized.
+    # @return [CustomerInitiatedReturnRisk]
+    attr_accessor :customer_initiated_return_risk
+
+    # The object contains a risk score and a risk tier that evaluate the
+    # transaction return risk because an account is overdrawn or because an
+    # ineligible account is used. Common return codes in this category include:
+    # "R01", "R02", "R03", "R04", "R06", “R08”,  "R09", "R13", "R16", "R17",
+    # "R20", "R23". These returns have a turnaround time of 2 banking days.
+    # @return [BankInitiatedReturnRisk]
+    attr_accessor :bank_initiated_return_risk
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_initiated_return_risk'] =
+        'customer_initiated_return_risk'
+      @_hash['bank_initiated_return_risk'] = 'bank_initiated_return_risk'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_initiated_return_risk
+        bank_initiated_return_risk
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_initiated_return_risk: SKIP,
+                   bank_initiated_return_risk: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless customer_initiated_return_risk == SKIP
+        @customer_initiated_return_risk =
+          customer_initiated_return_risk
+      end
+      unless bank_initiated_return_risk == SKIP
+        @bank_initiated_return_risk =
+          bank_initiated_return_risk
+      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.
+      if hash['customer_initiated_return_risk']
+        customer_initiated_return_risk = CustomerInitiatedReturnRisk.from_hash(hash['customer_initiated_return_risk'])
+      end
+      if hash['bank_initiated_return_risk']
+        bank_initiated_return_risk = BankInitiatedReturnRisk.from_hash(hash['bank_initiated_return_risk'])
+      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.
+      SignalEvaluateScores.new(customer_initiated_return_risk: customer_initiated_return_risk,
+                               bank_initiated_return_risk: bank_initiated_return_risk,
+                               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} customer_initiated_return_risk: #{@customer_initiated_return_risk},"\
+      " bank_initiated_return_risk: #{@bank_initiated_return_risk}, 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} customer_initiated_return_risk: #{@customer_initiated_return_risk.inspect},"\
+      " bank_initiated_return_risk: #{@bank_initiated_return_risk.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/signal_person_name.rb

@@ -0,0 +1,122 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The user's legal name
+  class SignalPersonName < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The user's name prefix (e.g. "Mr.")
+    # @return [String]
+    attr_accessor :prefix
+
+    # The user's given name. If the user has a one-word name, it should be
+    # provided in this field.
+    # @return [String]
+    attr_accessor :given_name
+
+    # The user's middle name
+    # @return [String]
+    attr_accessor :middle_name
+
+    # The user's family name / surname
+    # @return [String]
+    attr_accessor :family_name
+
+    # The user's name suffix (e.g. "II")
+    # @return [String]
+    attr_accessor :suffix
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prefix'] = 'prefix'
+      @_hash['given_name'] = 'given_name'
+      @_hash['middle_name'] = 'middle_name'
+      @_hash['family_name'] = 'family_name'
+      @_hash['suffix'] = 'suffix'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prefix
+        given_name
+        middle_name
+        family_name
+        suffix
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        prefix
+        given_name
+        middle_name
+        family_name
+        suffix
+      ]
+    end
+
+    def initialize(prefix: SKIP, given_name: SKIP, middle_name: SKIP,
+                   family_name: SKIP, suffix: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @prefix = prefix unless prefix == SKIP
+      @given_name = given_name unless given_name == SKIP
+      @middle_name = middle_name unless middle_name == SKIP
+      @family_name = family_name unless family_name == SKIP
+      @suffix = suffix unless suffix == 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.
+      prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      middle_name = hash.key?('middle_name') ? hash['middle_name'] : SKIP
+      family_name = hash.key?('family_name') ? hash['family_name'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : 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.
+      SignalPersonName.new(prefix: prefix,
+                           given_name: given_name,
+                           middle_name: middle_name,
+                           family_name: family_name,
+                           suffix: suffix,
+                           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} prefix: #{@prefix}, given_name: #{@given_name}, middle_name:"\
+      " #{@middle_name}, family_name: #{@family_name}, suffix: #{@suffix}, 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} prefix: #{@prefix.inspect}, given_name: #{@given_name.inspect},"\
+      " middle_name: #{@middle_name.inspect}, family_name: #{@family_name.inspect}, suffix:"\
+      " #{@suffix.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/signal_return_report_request.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SignalReturnReportRequest defines the request schema for
+  # `/signal/return/report`
+  class SignalReturnReportRequest < 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
+
+    # Must be the same as the `client_transaction_id` supplied when calling
+    # `/signal/evaluate`
+    # @return [String]
+    attr_accessor :client_transaction_id
+
+    # Must be a valid ACH return code (e.g. "R01")
+    # @return [String]
+    attr_accessor :return_code
+
+    # 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['client_transaction_id'] = 'client_transaction_id'
+      @_hash['return_code'] = 'return_code'
+      @_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(client_transaction_id:, return_code:, 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
+      @client_transaction_id = client_transaction_id
+      @return_code = return_code
+      @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_transaction_id =
+        hash.key?('client_transaction_id') ? hash['client_transaction_id'] : nil
+      return_code = hash.key?('return_code') ? hash['return_code'] : 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.
+      SignalReturnReportRequest.new(client_transaction_id: client_transaction_id,
+                                    return_code: return_code,
+                                    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}, client_transaction_id:"\
+      " #{@client_transaction_id}, return_code: #{@return_code}, 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},"\
+      " client_transaction_id: #{@client_transaction_id.inspect}, return_code:"\
+      " #{@return_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end