apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/deposit_switch_alt_create_response.rb

@@ -0,0 +1,87 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchAltCreateResponse defines the response schema for
+  # `/deposit_switch/alt/create`
+  class DepositSwitchAltCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the deposit switch. This ID is persisted throughout the lifetime of
+    # the deposit switch.
+    # @return [String]
+    attr_accessor :deposit_switch_id
+
+    # 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['deposit_switch_id'] = 'deposit_switch_id'
+      @_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(deposit_switch_id:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deposit_switch_id = deposit_switch_id
+      @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.
+      deposit_switch_id =
+        hash.key?('deposit_switch_id') ? hash['deposit_switch_id'] : 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.
+      DepositSwitchAltCreateResponse.new(deposit_switch_id: deposit_switch_id,
+                                         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} deposit_switch_id: #{@deposit_switch_id}, 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} deposit_switch_id: #{@deposit_switch_id.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_create_request.rb

@@ -0,0 +1,133 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchCreateRequest defines the request schema for
+  # `/deposit_switch/create`
+  class DepositSwitchCreateRequest < 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
+
+    # Access token for the target Item, typically provided in the Import Item
+    # response.
+    # @return [String]
+    attr_accessor :target_access_token
+
+    # Plaid Account ID that specifies the target bank account. This account will
+    # become the recipient for a user's direct deposit.
+    # @return [String]
+    attr_accessor :target_account_id
+
+    # ISO-3166-1 alpha-2 country code standard.
+    # @return [CountryCode1]
+    attr_accessor :country_code
+
+    # Options to configure the `/deposit_switch/create` request. If provided,
+    # cannot be `null`.
+    # @return [DepositSwitchCreateRequestOptions]
+    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['target_access_token'] = 'target_access_token'
+      @_hash['target_account_id'] = 'target_account_id'
+      @_hash['country_code'] = 'country_code'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        country_code
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(target_access_token:, target_account_id:, client_id: SKIP,
+                   secret: SKIP, country_code: 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
+      @target_access_token = target_access_token
+      @target_account_id = target_account_id
+      @country_code = country_code unless country_code == SKIP
+      @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.
+      target_access_token =
+        hash.key?('target_access_token') ? hash['target_access_token'] : nil
+      target_account_id =
+        hash.key?('target_account_id') ? hash['target_account_id'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      options = DepositSwitchCreateRequestOptions.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.
+      DepositSwitchCreateRequest.new(target_access_token: target_access_token,
+                                     target_account_id: target_account_id,
+                                     client_id: client_id,
+                                     secret: secret,
+                                     country_code: country_code,
+                                     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}, target_access_token:"\
+      " #{@target_access_token}, target_account_id: #{@target_account_id}, country_code:"\
+      " #{@country_code}, 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},"\
+      " target_access_token: #{@target_access_token.inspect}, target_account_id:"\
+      " #{@target_account_id.inspect}, country_code: #{@country_code.inspect}, options:"\
+      " #{@options.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_create_request_options.rb

@@ -0,0 +1,99 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Options to configure the `/deposit_switch/create` request. If provided,
+  # cannot be `null`.
+  class DepositSwitchCreateRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The URL registered to receive webhooks when the status of a deposit switch
+    # request has changed.
+    # @return [String]
+    attr_accessor :webhook
+
+    # An array of access tokens corresponding to transaction items to use when
+    # attempting to match the user to their Payroll Provider. These tokens must
+    # be created by the same client id as the one creating the switch, and have
+    # access to the transactions product.
+    # @return [Array[String]]
+    attr_accessor :transaction_item_access_tokens
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook'] = 'webhook'
+      @_hash['transaction_item_access_tokens'] =
+        'transaction_item_access_tokens'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        webhook
+        transaction_item_access_tokens
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        webhook
+      ]
+    end
+
+    def initialize(webhook: SKIP, transaction_item_access_tokens: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook = webhook unless webhook == SKIP
+      unless transaction_item_access_tokens == SKIP
+        @transaction_item_access_tokens =
+          transaction_item_access_tokens
+      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.
+      webhook = hash.key?('webhook') ? hash['webhook'] : SKIP
+      transaction_item_access_tokens =
+        hash.key?('transaction_item_access_tokens') ? hash['transaction_item_access_tokens'] : 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.
+      DepositSwitchCreateRequestOptions.new(webhook: webhook,
+                                            transaction_item_access_tokens: transaction_item_access_tokens,
+                                            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}, transaction_item_access_tokens:"\
+      " #{@transaction_item_access_tokens}, 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}, transaction_item_access_tokens:"\
+      " #{@transaction_item_access_tokens.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_create_response.rb

@@ -0,0 +1,87 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchCreateResponse defines the response schema for
+  # `/deposit_switch/create`
+  class DepositSwitchCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the deposit switch. This ID is persisted throughout the lifetime of
+    # the deposit switch.
+    # @return [String]
+    attr_accessor :deposit_switch_id
+
+    # 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['deposit_switch_id'] = 'deposit_switch_id'
+      @_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(deposit_switch_id:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deposit_switch_id = deposit_switch_id
+      @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.
+      deposit_switch_id =
+        hash.key?('deposit_switch_id') ? hash['deposit_switch_id'] : 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.
+      DepositSwitchCreateResponse.new(deposit_switch_id: deposit_switch_id,
+                                      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} deposit_switch_id: #{@deposit_switch_id}, 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} deposit_switch_id: #{@deposit_switch_id.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_get_request.rb

@@ -0,0 +1,99 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchGetRequest defines the request schema for `/deposit_switch/get`
+  class DepositSwitchGetRequest < 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 deposit switch
+    # @return [String]
+    attr_accessor :deposit_switch_id
+
+    # 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['deposit_switch_id'] = 'deposit_switch_id'
+      @_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(deposit_switch_id:, 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
+      @deposit_switch_id = deposit_switch_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.
+      deposit_switch_id =
+        hash.key?('deposit_switch_id') ? hash['deposit_switch_id'] : 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.
+      DepositSwitchGetRequest.new(deposit_switch_id: deposit_switch_id,
+                                  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}, deposit_switch_id:"\
+      " #{@deposit_switch_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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect},"\
+      " deposit_switch_id: #{@deposit_switch_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end