apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/sandbox_public_token_create_request.rb

@@ -0,0 +1,123 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SandboxPublicTokenCreateRequest defines the request schema for
+  # `/sandbox/public_token/create`
+  class SandboxPublicTokenCreateRequest < 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 institution the Item will be associated with
+    # @return [String]
+    attr_accessor :institution_id
+
+    # The products to initially pull for the Item. May be any products that the
+    # specified `institution_id`  supports. This array may not be empty.
+    # @return [Array[Products]]
+    attr_accessor :initial_products
+
+    # An optional set of options to be used when configuring the Item. If
+    # specified, must not be `null`.
+    # @return [SandboxPublicTokenCreateRequestOptions]
+    attr_accessor :options
+
+    # 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['institution_id'] = 'institution_id'
+      @_hash['initial_products'] = 'initial_products'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(institution_id:, initial_products:, client_id: SKIP,
+                   secret: SKIP, options: 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
+      @institution_id = institution_id
+      @initial_products = initial_products
+      @options = options unless options == 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.
+      institution_id =
+        hash.key?('institution_id') ? hash['institution_id'] : nil
+      initial_products =
+        hash.key?('initial_products') ? hash['initial_products'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      options = SandboxPublicTokenCreateRequestOptions.from_hash(hash['options']) if
+        hash['options']
+
+      # 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.
+      SandboxPublicTokenCreateRequest.new(institution_id: institution_id,
+                                          initial_products: initial_products,
+                                          client_id: client_id,
+                                          secret: secret,
+                                          options: options,
+                                          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}, institution_id:"\
+      " #{@institution_id}, initial_products: #{@initial_products}, options: #{@options},"\
+      " 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},"\
+      " institution_id: #{@institution_id.inspect}, initial_products:"\
+      " #{@initial_products.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_public_token_create_request_options.rb

@@ -0,0 +1,116 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional set of options to be used when configuring the Item. If
+  # specified, must not be `null`.
+  class SandboxPublicTokenCreateRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specify a webhook to associate with the new Item.
+    # @return [String]
+    attr_accessor :webhook
+
+    # Test username to use for the creation of the Sandbox Item. Default value
+    # is `user_good`.
+    # @return [String]
+    attr_accessor :override_username
+
+    # Test password to use for the creation of the Sandbox Item. Default value
+    # is `pass_good`.
+    # @return [String]
+    attr_accessor :override_password
+
+    # SandboxPublicTokenCreateRequestOptionsTransactions is an optional set of
+    # parameters corresponding to transactions options.
+    # @return [SandboxPublicTokenCreateRequestOptionsTransactions]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook'] = 'webhook'
+      @_hash['override_username'] = 'override_username'
+      @_hash['override_password'] = 'override_password'
+      @_hash['transactions'] = 'transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        webhook
+        override_username
+        override_password
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        override_username
+        override_password
+      ]
+    end
+
+    def initialize(webhook: SKIP, override_username: 'user_good',
+                   override_password: 'pass_good', transactions: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook = webhook unless webhook == SKIP
+      @override_username = override_username unless override_username == SKIP
+      @override_password = override_password unless override_password == SKIP
+      @transactions = transactions unless transactions == 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.
+      webhook = hash.key?('webhook') ? hash['webhook'] : SKIP
+      override_username = hash['override_username'] ||= 'user_good'
+      override_password = hash['override_password'] ||= 'pass_good'
+      if hash['transactions']
+        transactions = SandboxPublicTokenCreateRequestOptionsTransactions.from_hash(hash['transactions'])
+      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.
+      SandboxPublicTokenCreateRequestOptions.new(webhook: webhook,
+                                                 override_username: override_username,
+                                                 override_password: override_password,
+                                                 transactions: transactions,
+                                                 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: #{@webhook}, override_username: #{@override_username},"\
+      " override_password: #{@override_password}, transactions: #{@transactions},"\
+      " 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: #{@webhook.inspect}, override_username:"\
+      " #{@override_username.inspect}, override_password: #{@override_password.inspect},"\
+      " transactions: #{@transactions.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb

@@ -0,0 +1,88 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SandboxPublicTokenCreateRequestOptionsTransactions is an optional set of
+  # parameters corresponding to transactions options.
+  class SandboxPublicTokenCreateRequestOptionsTransactions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The earliest date for which to fetch transaction history. Dates should be
+    # formatted as YYYY-MM-DD.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The most recent date for which to fetch transaction history. Dates should
+    # be formatted as YYYY-MM-DD.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_date: SKIP, end_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == 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.
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : 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.
+      SandboxPublicTokenCreateRequestOptionsTransactions.new(start_date: start_date,
+                                                             end_date: end_date,
+                                                             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} start_date: #{@start_date}, end_date: #{@end_date}, 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} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_public_token_create_response.rb

@@ -0,0 +1,86 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # SandboxPublicTokenCreateResponse defines the response schema for
+  # `/sandbox/public_token/create`
+  class SandboxPublicTokenCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A public token that can be exchanged for an access token using
+    # `/item/public_token/exchange`
+    # @return [String]
+    attr_accessor :public_token
+
+    # 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['public_token'] = 'public_token'
+      @_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(public_token:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @public_token = public_token
+      @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.
+      public_token = hash.key?('public_token') ? hash['public_token'] : 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.
+      SandboxPublicTokenCreateResponse.new(public_token: public_token,
+                                           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} public_token: #{@public_token}, 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} public_token: #{@public_token.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_transfer_simulate_request.rb

@@ -0,0 +1,124 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/sandbox/transfer/simulate`
+  class SandboxTransferSimulateRequest < 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 transfer.
+    # @return [String]
+    attr_accessor :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 [TransferFailure]
+    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['transfer_id'] = '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(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
+      @transfer_id = 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.
+      transfer_id = hash.key?('transfer_id') ? hash['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 = TransferFailure.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.
+      SandboxTransferSimulateRequest.new(transfer_id: 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}, transfer_id: #{@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}, transfer_id:"\
+      " #{@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_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/transfer/simulate`
+  class SandboxTransferSimulateResponse < 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.
+      SandboxTransferSimulateResponse.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