apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb

@@ -0,0 +1,128 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/sandbox/bank_transfer/simulate`
+  class SandboxBankTransferSimulateRequest < 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
+
+    # Plaid’s unique identifier for a bank transfer.
+    # @return [String]
+    attr_accessor :bank_transfer_id
+
+    # The asynchronous event to be simulated. May be: `posted`, `failed`, or
+    # `reversed`.
+    # An error will be returned if the event type is incompatible with the
+    # current transfer status. Compatible status --> event type transitions
+    # include:
+    # `pending` --> `failed`
+    # `pending` --> `posted`
+    # `posted` --> `reversed`
+    # @return [String]
+    attr_accessor :event_type
+
+    # The failure reason if the type of this transfer is `"failed"` or
+    # `"reversed"`. Null value otherwise.
+    # @return [BankTransferFailure]
+    attr_accessor :failure_reason
+
+    # 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['bank_transfer_id'] = 'bank_transfer_id'
+      @_hash['event_type'] = 'event_type'
+      @_hash['failure_reason'] = 'failure_reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        failure_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bank_transfer_id:, event_type:, client_id: SKIP,
+                   secret: SKIP, failure_reason: 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
+      @bank_transfer_id = bank_transfer_id
+      @event_type = event_type
+      @failure_reason = failure_reason unless failure_reason == 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.
+      bank_transfer_id =
+        hash.key?('bank_transfer_id') ? hash['bank_transfer_id'] : nil
+      event_type = hash.key?('event_type') ? hash['event_type'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      failure_reason = BankTransferFailure.from_hash(hash['failure_reason']) if
+        hash['failure_reason']
+
+      # 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.
+      SandboxBankTransferSimulateRequest.new(bank_transfer_id: bank_transfer_id,
+                                             event_type: event_type,
+                                             client_id: client_id,
+                                             secret: secret,
+                                             failure_reason: failure_reason,
+                                             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}, bank_transfer_id:"\
+      " #{@bank_transfer_id}, event_type: #{@event_type}, failure_reason: #{@failure_reason},"\
+      " 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},"\
+      " bank_transfer_id: #{@bank_transfer_id.inspect}, event_type: #{@event_type.inspect},"\
+      " failure_reason: #{@failure_reason.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb

@@ -0,0 +1,76 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/sandbox/bank_transfer/simulate`
+  class SandboxBankTransferSimulateResponse < 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.
+      SandboxBankTransferSimulateResponse.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

data/lib/plaid/models/sandbox_income_fire_webhook_request.rb

@@ -0,0 +1,125 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SandboxIncomeFireWebhookRequest defines the request schema for
+  # `/sandbox/income/fire_webhook`
+  class SandboxIncomeFireWebhookRequest < 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 ID of the verification.
+    # @return [String]
+    attr_accessor :income_verification_id
+
+    # The URL to which the webhook should be sent.
+    # @return [String]
+    attr_accessor :webhook
+
+    # `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status
+    # processing has completed.
+    # `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The documentation uploaded by the
+    # end user was recognized as a supported file format, but not recognized as
+    # a valid paystub.
+    # `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when
+    # attempting to process the verification documentation.
+    # @return [VerificationStatus3]
+    attr_accessor :verification_status
+
+    # 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['income_verification_id'] = 'income_verification_id'
+      @_hash['webhook'] = 'webhook'
+      @_hash['verification_status'] = 'verification_status'
+      @_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(income_verification_id:, webhook:, verification_status:,
+                   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
+      @income_verification_id = income_verification_id
+      @webhook = webhook
+      @verification_status = verification_status
+      @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
+      webhook = hash.key?('webhook') ? hash['webhook'] : nil
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : 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.
+      SandboxIncomeFireWebhookRequest.new(income_verification_id: income_verification_id,
+                                          webhook: webhook,
+                                          verification_status: verification_status,
+                                          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}, income_verification_id:"\
+      " #{@income_verification_id}, webhook: #{@webhook}, verification_status:"\
+      " #{@verification_status}, 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},"\
+      " income_verification_id: #{@income_verification_id.inspect}, webhook: #{@webhook.inspect},"\
+      " verification_status: #{@verification_status.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_income_fire_webhook_response.rb

@@ -0,0 +1,77 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SandboxIncomeFireWebhookResponse defines the response schema for
+  # `/sandbox/income/fire_webhook`
+  class SandboxIncomeFireWebhookResponse < 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.
+      SandboxIncomeFireWebhookResponse.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

data/lib/plaid/models/sandbox_item_fire_webhook_request.rb

@@ -0,0 +1,109 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SandboxItemFireWebhookRequest defines the request schema for
+  # `/sandbox/item/fire_webhook`
+  class SandboxItemFireWebhookRequest < 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 following values for `webhook_code` are supported:
+    # * `DEFAULT_UPDATE`
+    # @return [String]
+    attr_accessor :webhook_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['access_token'] = 'access_token'
+      @_hash['webhook_code'] = 'webhook_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(access_token:, webhook_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
+      @access_token = access_token
+      @webhook_code = webhook_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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_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.
+      SandboxItemFireWebhookRequest.new(access_token: access_token,
+                                        webhook_code: webhook_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}, access_token:"\
+      " #{@access_token}, webhook_code: #{@webhook_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}, access_token:"\
+      " #{@access_token.inspect}, webhook_code: #{@webhook_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_item_fire_webhook_response.rb

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

data/lib/plaid/models/sandbox_item_reset_login_request.rb

@@ -0,0 +1,98 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SandboxItemResetLoginRequest defines the request schema for
+  # `/sandbox/item/reset_login`
+  class SandboxItemResetLoginRequest < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, client_id: SKIP, secret: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_id = client_id unless client_id == SKIP
+      @secret = secret unless secret == SKIP
+      @access_token = access_token
+      @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
+      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.
+      SandboxItemResetLoginRequest.new(access_token: access_token,
+                                       client_id: client_id,
+                                       secret: secret,
+                                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id}, secret: #{@secret}, access_token:"\
+      " #{@access_token}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, access_token:"\
+      " #{@access_token.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end