apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/sell_type.rb

@@ -0,0 +1,105 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Selling an investment
+  class SellType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Outflow of assets from a tax-advantaged account
+    # @return [String]
+    attr_accessor :distribution
+
+    # Exercise of an option or warrant contract
+    # @return [String]
+    attr_accessor :exercise
+
+    # Sell to close or decrease an existing holding
+    # @return [String]
+    attr_accessor :sell
+
+    # Sell to open a short position
+    # @return [String]
+    attr_accessor :sell_short
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['distribution'] = 'distribution'
+      @_hash['exercise'] = 'exercise'
+      @_hash['sell'] = 'sell'
+      @_hash['sell_short'] = 'sell short'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        distribution
+        exercise
+        sell
+        sell_short
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(distribution: SKIP, exercise: SKIP, sell: SKIP,
+                   sell_short: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @distribution = distribution unless distribution == SKIP
+      @exercise = exercise unless exercise == SKIP
+      @sell = sell unless sell == SKIP
+      @sell_short = sell_short unless sell_short == 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.
+      distribution = hash.key?('distribution') ? hash['distribution'] : SKIP
+      exercise = hash.key?('exercise') ? hash['exercise'] : SKIP
+      sell = hash.key?('sell') ? hash['sell'] : SKIP
+      sell_short = hash.key?('sell short') ? hash['sell short'] : 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.
+      SellType.new(distribution: distribution,
+                   exercise: exercise,
+                   sell: sell,
+                   sell_short: sell_short,
+                   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} distribution: #{@distribution}, exercise: #{@exercise}, sell: #{@sell},"\
+      " sell_short: #{@sell_short}, 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} distribution: #{@distribution.inspect}, exercise: #{@exercise.inspect},"\
+      " sell: #{@sell.inspect}, sell_short: #{@sell_short.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sender_bacs_nullable.rb

@@ -0,0 +1,85 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SenderBacsNullable Model.
+  class SenderBacsNullable < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account number of the account. Maximum of 10 characters.
+    # @return [String]
+    attr_accessor :account
+
+    # The 6-character sort code of the account.
+    # @return [String]
+    attr_accessor :sort_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['sort_code'] = 'sort_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        sort_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account: SKIP, sort_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account = account unless account == SKIP
+      @sort_code = sort_code unless sort_code == 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.
+      account = hash.key?('account') ? hash['account'] : SKIP
+      sort_code = hash.key?('sort_code') ? hash['sort_code'] : 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.
+      SenderBacsNullable.new(account: account,
+                             sort_code: sort_code,
+                             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: #{@account}, sort_code: #{@sort_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} account: #{@account.inspect}, sort_code: #{@sort_code.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/servicer_address_data.rb

@@ -0,0 +1,117 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The address of the student loan servicer. This is generally the remittance
+  # address to which payments should be sent.
+  class ServicerAddressData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full city name
+    # @return [String]
+    attr_accessor :city
+
+    # The region or state
+    # Example: `"NC"`
+    # @return [String]
+    attr_accessor :region
+
+    # The full street address
+    # Example: `"564 Main Street, APT 15"`
+    # @return [String]
+    attr_accessor :street
+
+    # The postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The ISO 3166-1 alpha-2 country code
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['region'] = 'region'
+      @_hash['street'] = 'street'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        city
+        region
+        street
+        postal_code
+        country
+      ]
+    end
+
+    def initialize(city:, region:, street:, postal_code:, country:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @city = city
+      @region = region
+      @street = street
+      @postal_code = postal_code
+      @country = country
+      @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.
+      city = hash.key?('city') ? hash['city'] : nil
+      region = hash.key?('region') ? hash['region'] : nil
+      street = hash.key?('street') ? hash['street'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      country = hash.key?('country') ? hash['country'] : 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.
+      ServicerAddressData.new(city: city,
+                              region: region,
+                              street: street,
+                              postal_code: postal_code,
+                              country: country,
+                              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} city: #{@city}, region: #{@region}, street: #{@street}, postal_code:"\
+      " #{@postal_code}, country: #{@country}, 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} city: #{@city.inspect}, region: #{@region.inspect}, street:"\
+      " #{@street.inspect}, postal_code: #{@postal_code.inspect}, country: #{@country.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/signal_decision_report_request.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SignalDecisionReportRequest defines the request schema for
+  # `/signal/decision/report`
+  class SignalDecisionReportRequest < 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
+
+    # `true` if the ACH transaction was initiated, `false` otherwise.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :initiated
+
+    # 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['initiated'] = 'initiated'
+      @_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:, initiated:, 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
+      @initiated = initiated
+      @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
+      initiated = hash.key?('initiated') ? hash['initiated'] : 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.
+      SignalDecisionReportRequest.new(client_transaction_id: client_transaction_id,
+                                      initiated: initiated,
+                                      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}, initiated: #{@initiated}, 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}, initiated:"\
+      " #{@initiated.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/signal_decision_report_response.rb

@@ -0,0 +1,77 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SignalDecisionReportResponse defines the response schema for
+  # `/signal/decision/report`
+  class SignalDecisionReportResponse < 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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(request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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.
+      SignalDecisionReportResponse.new(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} 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} request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end