apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/recaptcha_required_error.rb

@@ -0,0 +1,143 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The request was flagged by Plaid's fraud system, and requires additional
+  # verification to ensure they are not a bot.
+  class RecaptchaRequiredError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # RECAPTCHA_ERROR
+    # @return [String]
+    attr_accessor :error_type
+
+    # RECAPTCHA_REQUIRED
+    # @return [String]
+    attr_accessor :error_code
+
+    # RECAPTCHA_REQUIRED
+    # @return [String]
+    attr_accessor :display_message
+
+    # 400
+    # @return [String]
+    attr_accessor :http_code
+
+    # Your user will be prompted to solve a Google reCAPTCHA challenge in the
+    # Link Recaptcha pane. If they solve the challenge successfully, the user's
+    # request is resubmitted and they are directed to the next Item creation
+    # step.
+    # @return [String]
+    attr_accessor :link_user_experience
+
+    # Plaid's fraud system detects abusive traffic and considers a variety of
+    # parameters throughout Item creation requests. When a request is considered
+    # risky or possibly fraudulent, Link presents a reCAPTCHA for the user to
+    # solve.
+    # @return [String]
+    attr_accessor :common_causes
+
+    # Link will automatically guide your user through reCAPTCHA verification. As
+    # a general rule, we recommend instrumenting basic fraud monitoring to
+    # detect and protect your website from spam and abuse.
+    # If your user cannot verify their session, please submit a Support ticket
+    # with the following identifiers: `link_session_id` or `request_id`
+    # @return [String]
+    attr_accessor :troubleshooting_steps
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_type'] = 'error_type'
+      @_hash['error_code'] = 'error_code'
+      @_hash['display_message'] = 'display_message'
+      @_hash['http_code'] = 'http_code'
+      @_hash['link_user_experience'] = 'link_user_experience'
+      @_hash['common_causes'] = 'common_causes'
+      @_hash['troubleshooting_steps'] = 'troubleshooting_steps'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_type:, error_code:, display_message:, http_code:,
+                   link_user_experience:, common_causes:,
+                   troubleshooting_steps:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @error_type = error_type
+      @error_code = error_code
+      @display_message = display_message
+      @http_code = http_code
+      @link_user_experience = link_user_experience
+      @common_causes = common_causes
+      @troubleshooting_steps = troubleshooting_steps
+      @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.
+      error_type = hash.key?('error_type') ? hash['error_type'] : nil
+      error_code = hash.key?('error_code') ? hash['error_code'] : nil
+      display_message =
+        hash.key?('display_message') ? hash['display_message'] : nil
+      http_code = hash.key?('http_code') ? hash['http_code'] : nil
+      link_user_experience =
+        hash.key?('link_user_experience') ? hash['link_user_experience'] : nil
+      common_causes = hash.key?('common_causes') ? hash['common_causes'] : nil
+      troubleshooting_steps =
+        hash.key?('troubleshooting_steps') ? hash['troubleshooting_steps'] : 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.
+      RecaptchaRequiredError.new(error_type: error_type,
+                                 error_code: error_code,
+                                 display_message: display_message,
+                                 http_code: http_code,
+                                 link_user_experience: link_user_experience,
+                                 common_causes: common_causes,
+                                 troubleshooting_steps: troubleshooting_steps,
+                                 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} error_type: #{@error_type}, error_code: #{@error_code}, display_message:"\
+      " #{@display_message}, http_code: #{@http_code}, link_user_experience:"\
+      " #{@link_user_experience}, common_causes: #{@common_causes}, troubleshooting_steps:"\
+      " #{@troubleshooting_steps}, 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} error_type: #{@error_type.inspect}, error_code: #{@error_code.inspect},"\
+      " display_message: #{@display_message.inspect}, http_code: #{@http_code.inspect},"\
+      " link_user_experience: #{@link_user_experience.inspect}, common_causes:"\
+      " #{@common_causes.inspect}, troubleshooting_steps: #{@troubleshooting_steps.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/recipient_bacs.rb

@@ -0,0 +1,87 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object containing a BACS account number and sort code. If an IBAN is not
+  # provided or if this recipient needs to accept domestic GBP-denominated
+  # payments, BACS data is required.
+  class RecipientBacs < 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.
+      RecipientBacs.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/recipient_bacs_nullable.rb

@@ -0,0 +1,85 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # RecipientBacsNullable Model.
+  class RecipientBacsNullable < 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.
+      RecipientBacsNullable.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/refresh_interval.rb

@@ -0,0 +1,42 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The `refresh_interval` may be `DELAYED` or `STOPPED` even when the success
+  # rate is high. This value is only returned for Transactions status
+  # breakdowns.
+  class RefreshInterval
+    REFRESH_INTERVAL = [
+      # TODO: Write general description for NORMAL
+      NORMAL = 'NORMAL'.freeze,
+
+      # TODO: Write general description for DELAYED
+      DELAYED = 'DELAYED'.freeze,
+
+      # TODO: Write general description for STOPPED
+      STOPPED = 'STOPPED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = NORMAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'normal' then NORMAL
+      when 'delayed' then DELAYED
+      when 'stopped' then STOPPED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/requested_scopes.rb

@@ -0,0 +1,124 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Scope of required and optional account features or content from a
+  # ConnectedApplication.
+  class RequestedScopes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The product access being requested. Used to or disallow product access
+    # across all accounts. If unset, defaults to all products allowed.
+    # @return [ProductAccess]
+    attr_accessor :required_product_access
+
+    # The product access being requested. Used to or disallow product access
+    # across all accounts. If unset, defaults to all products allowed.
+    # @return [ProductAccess]
+    attr_accessor :optional_product_access
+
+    # Enumerates the account subtypes that the application wishes for the user
+    # to be able to select from. For more details refer to Plaid documentation
+    # on account filters.
+    # @return [AccountFilter]
+    attr_accessor :account_filters
+
+    # The application requires that accounts be limited to a specific
+    # cardinality.
+    # `MULTI_SELECT`: indicates that the user should be allowed to pick multiple
+    # accounts.
+    # `SINGLE_SELECT`: indicates that the user should be allowed to pick only a
+    # single account.
+    # `ALL`: indicates that the user must share all of their accounts and should
+    # not be given the opportunity to de-select
+    # @return [AccountSelectionCardinality]
+    attr_accessor :account_selection_cardinality
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['required_product_access'] = 'required_product_access'
+      @_hash['optional_product_access'] = 'optional_product_access'
+      @_hash['account_filters'] = 'account_filters'
+      @_hash['account_selection_cardinality'] =
+        'account_selection_cardinality'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_filters
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(required_product_access:, optional_product_access:,
+                   account_selection_cardinality:, account_filters: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @required_product_access = required_product_access
+      @optional_product_access = optional_product_access
+      @account_filters = account_filters unless account_filters == SKIP
+      @account_selection_cardinality = account_selection_cardinality
+      @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.
+      required_product_access = ProductAccess.from_hash(hash['required_product_access']) if
+        hash['required_product_access']
+      optional_product_access = ProductAccess.from_hash(hash['optional_product_access']) if
+        hash['optional_product_access']
+      account_selection_cardinality =
+        hash.key?('account_selection_cardinality') ? hash['account_selection_cardinality'] : nil
+      account_filters = AccountFilter.from_hash(hash['account_filters']) if
+        hash['account_filters']
+
+      # 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.
+      RequestedScopes.new(required_product_access: required_product_access,
+                          optional_product_access: optional_product_access,
+                          account_selection_cardinality: account_selection_cardinality,
+                          account_filters: account_filters,
+                          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} required_product_access: #{@required_product_access},"\
+      " optional_product_access: #{@optional_product_access}, account_filters:"\
+      " #{@account_filters}, account_selection_cardinality: #{@account_selection_cardinality},"\
+      " 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} required_product_access: #{@required_product_access.inspect},"\
+      " optional_product_access: #{@optional_product_access.inspect}, account_filters:"\
+      " #{@account_filters.inspect}, account_selection_cardinality:"\
+      " #{@account_selection_cardinality.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb

@@ -0,0 +1,97 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/sandbox/bank_transfer/fire_webhook`
+  class SandboxBankTransferFireWebhookRequest < 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 URL to which the webhook should be sent.
+    # @return [String]
+    attr_accessor :webhook
+
+    # 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['webhook'] = 'webhook'
+      @_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(webhook:, 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
+      @webhook = webhook
+      @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'] : 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.
+      SandboxBankTransferFireWebhookRequest.new(webhook: webhook,
+                                                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}, webhook: #{@webhook},"\
+      " 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}, webhook:"\
+      " #{@webhook.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_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/fire_webhook`
+  class SandboxBankTransferFireWebhookResponse < 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.
+      SandboxBankTransferFireWebhookResponse.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