finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.13

data/lib/finch-api/models/provider_list_params.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    class ProviderListParams < FinchAPI::BaseModel
-      # @!parse
-      #   extend FinchAPI::Type::RequestParameters::Converter
-      include FinchAPI::RequestParameters
-
-      # @!parse
-      #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | FinchAPI::BaseModel) -> void
-    end
-  end
-end

data/lib/finch-api/models/request_forwarding_forward_params.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    class RequestForwardingForwardParams < FinchAPI::BaseModel
-      # @!parse
-      #   extend FinchAPI::Type::RequestParameters::Converter
-      include FinchAPI::RequestParameters
-
-      # @!attribute method_
-      #   The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
-      #     , `PUT` , `DELETE` , and `PATCH`.
-      #
-      #   @return [String]
-      required :method_, String, api_name: :method
-
-      # @!attribute route
-      #   The URL route path for the forwarded request. This value must begin with a
-      #     forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and
-      #     underscores.
-      #
-      #   @return [String]
-      required :route, String
-
-      # @!attribute data
-      #   The body for the forwarded request. This value must be specified as either a
-      #     string or a valid JSON object.
-      #
-      #   @return [String, nil]
-      optional :data, String, nil?: true
-
-      # @!attribute headers
-      #   The HTTP headers to include on the forwarded request. This value must be
-      #     specified as an object of key-value pairs. Example:
-      #     `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
-      #
-      #   @return [Object, nil]
-      optional :headers, FinchAPI::Unknown, nil?: true
-
-      # @!attribute params
-      #   The query parameters for the forwarded request. This value must be specified as
-      #     a valid JSON object rather than a query string.
-      #
-      #   @return [Object, nil]
-      optional :params, FinchAPI::Unknown, nil?: true
-
-      # @!parse
-      #   # @param method_ [String]
-      #   # @param route [String]
-      #   # @param data [String, nil]
-      #   # @param headers [Object, nil]
-      #   # @param params [Object, nil]
-      #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(method_:, route:, data: nil, headers: nil, params: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | FinchAPI::BaseModel) -> void
-    end
-  end
-end

data/lib/finch-api/models/request_forwarding_forward_response.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    class RequestForwardingForwardResponse < FinchAPI::BaseModel
-      # @!attribute data
-      #   A string representation of the HTTP response body of the forwarded request’s
-      #     response received from the underlying integration’s API. This field may be null
-      #     in the case where the upstream system’s response is empty.
-      #
-      #   @return [String, nil]
-      required :data, String, nil?: true
-
-      # @!attribute headers
-      #   The HTTP headers of the forwarded request’s response, exactly as received from
-      #     the underlying integration’s API.
-      #
-      #   @return [Object, nil]
-      required :headers, FinchAPI::Unknown, nil?: true
-
-      # @!attribute request
-      #   An object containing details of your original forwarded request, for your ease
-      #     of reference.
-      #
-      #   @return [FinchAPI::Models::RequestForwardingForwardResponse::Request]
-      required :request, -> { FinchAPI::Models::RequestForwardingForwardResponse::Request }
-
-      # @!attribute status_code
-      #   The HTTP status code of the forwarded request’s response, exactly received from
-      #     the underlying integration’s API. This value will be returned as an integer.
-      #
-      #   @return [Integer]
-      required :status_code, Integer, api_name: :statusCode
-
-      # @!parse
-      #   # @param data [String, nil]
-      #   # @param headers [Object, nil]
-      #   # @param request [FinchAPI::Models::RequestForwardingForwardResponse::Request]
-      #   # @param status_code [Integer]
-      #   #
-      #   def initialize(data:, headers:, request:, status_code:, **) = super
-
-      # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-      class Request < FinchAPI::BaseModel
-        # @!attribute data
-        #   The body that was specified for the forwarded request. If a value was not
-        #     specified in the original request, this value will be returned as null ;
-        #     otherwise, this value will always be returned as a string.
-        #
-        #   @return [String, nil]
-        required :data, String, nil?: true
-
-        # @!attribute headers
-        #   The specified HTTP headers that were included in the forwarded request. If no
-        #     headers were specified, this will be returned as `null`.
-        #
-        #   @return [Object, nil]
-        required :headers, FinchAPI::Unknown, nil?: true
-
-        # @!attribute method_
-        #   The HTTP method that was specified for the forwarded request. Valid values
-        #     include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
-        #
-        #   @return [String]
-        required :method_, String, api_name: :method
-
-        # @!attribute params
-        #   The query parameters that were included in the forwarded request. If no query
-        #     parameters were specified, this will be returned as `null`.
-        #
-        #   @return [Object, nil]
-        required :params, FinchAPI::Unknown, nil?: true
-
-        # @!attribute route
-        #   The URL route path that was specified for the forwarded request.
-        #
-        #   @return [String]
-        required :route, String
-
-        # @!parse
-        #   # An object containing details of your original forwarded request, for your ease
-        #   #   of reference.
-        #   #
-        #   # @param data [String, nil]
-        #   # @param headers [Object, nil]
-        #   # @param method_ [String]
-        #   # @param params [Object, nil]
-        #   # @param route [String]
-        #   #
-        #   def initialize(data:, headers:, method_:, params:, route:, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-      end
-    end
-  end
-end

data/lib/finch-api/models/sandbox/company_update_params.rb

@@ -1,251 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module Sandbox
-      class CompanyUpdateParams < FinchAPI::BaseModel
-        # @!parse
-        #   extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # @!attribute accounts
-        #   An array of bank account objects associated with the payroll/HRIS system.
-        #
-        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil]
-        required :accounts,
-                 -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account] },
-                 nil?: true
-
-        # @!attribute departments
-        #   The array of company departments.
-        #
-        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil]
-        required :departments,
-                 -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil?: true] },
-                 nil?: true
-
-        # @!attribute ein
-        #   The employer identification number.
-        #
-        #   @return [String, nil]
-        required :ein, String, nil?: true
-
-        # @!attribute entity
-        #   The entity type object.
-        #
-        #   @return [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil]
-        required :entity, -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity }, nil?: true
-
-        # @!attribute legal_name
-        #   The legal name of the company.
-        #
-        #   @return [String, nil]
-        required :legal_name, String, nil?: true
-
-        # @!attribute locations
-        #
-        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
-        required :locations, -> { FinchAPI::ArrayOf[FinchAPI::Models::Location, nil?: true] }, nil?: true
-
-        # @!attribute primary_email
-        #   The email of the main administrator on the account.
-        #
-        #   @return [String, nil]
-        required :primary_email, String, nil?: true
-
-        # @!attribute primary_phone_number
-        #   The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
-        #
-        #   @return [String, nil]
-        required :primary_phone_number, String, nil?: true
-
-        # @!parse
-        #   # @param accounts [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil]
-        #   # @param departments [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil]
-        #   # @param ein [String, nil]
-        #   # @param entity [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil]
-        #   # @param legal_name [String, nil]
-        #   # @param locations [Array<FinchAPI::Models::Location, nil>, nil]
-        #   # @param primary_email [String, nil]
-        #   # @param primary_phone_number [String, nil]
-        #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(
-        #     accounts:,
-        #     departments:,
-        #     ein:,
-        #     entity:,
-        #     legal_name:,
-        #     locations:,
-        #     primary_email:,
-        #     primary_phone_number:,
-        #     request_options: {},
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        class Account < FinchAPI::BaseModel
-          # @!attribute account_name
-          #   The name of the bank associated in the payroll/HRIS system.
-          #
-          #   @return [String, nil]
-          optional :account_name, String, nil?: true
-
-          # @!attribute account_number
-          #   10-12 digit number to specify the bank account
-          #
-          #   @return [String, nil]
-          optional :account_number, String, nil?: true
-
-          # @!attribute account_type
-          #   The type of bank account.
-          #
-          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
-          optional :account_type,
-                   enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType },
-                   nil?: true
-
-          # @!attribute institution_name
-          #   Name of the banking institution.
-          #
-          #   @return [String, nil]
-          optional :institution_name, String, nil?: true
-
-          # @!attribute routing_number
-          #   A nine-digit code that's based on the U.S. Bank location where your account was
-          #     opened.
-          #
-          #   @return [String, nil]
-          optional :routing_number, String, nil?: true
-
-          # @!parse
-          #   # @param account_name [String, nil]
-          #   # @param account_number [String, nil]
-          #   # @param account_type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
-          #   # @param institution_name [String, nil]
-          #   # @param routing_number [String, nil]
-          #   #
-          #   def initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          # The type of bank account.
-          module AccountType
-            extend FinchAPI::Enum
-
-            CHECKING = :checking
-            SAVINGS = :savings
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-
-        class Department < FinchAPI::BaseModel
-          # @!attribute name
-          #   The department name.
-          #
-          #   @return [String, nil]
-          optional :name, String, nil?: true
-
-          # @!attribute parent
-          #   The parent department, if present.
-          #
-          #   @return [FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, nil]
-          optional :parent, -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent }, nil?: true
-
-          # @!parse
-          #   # @param name [String, nil]
-          #   # @param parent [FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, nil]
-          #   #
-          #   def initialize(name: nil, parent: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          class Parent < FinchAPI::BaseModel
-            # @!attribute name
-            #   The parent department's name.
-            #
-            #   @return [String, nil]
-            optional :name, String, nil?: true
-
-            # @!parse
-            #   # The parent department, if present.
-            #   #
-            #   # @param name [String, nil]
-            #   #
-            #   def initialize(name: nil, **) = super
-
-            # def initialize: (Hash | FinchAPI::BaseModel) -> void
-          end
-        end
-
-        class Entity < FinchAPI::BaseModel
-          # @!attribute subtype
-          #   The tax payer subtype of the company.
-          #
-          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype, nil]
-          optional :subtype,
-                   enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype },
-                   nil?: true
-
-          # @!attribute type
-          #   The tax payer type of the company.
-          #
-          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type, nil]
-          optional :type, enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type }, nil?: true
-
-          # @!parse
-          #   # The entity type object.
-          #   #
-          #   # @param subtype [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype, nil]
-          #   # @param type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type, nil]
-          #   #
-          #   def initialize(subtype: nil, type: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          # The tax payer subtype of the company.
-          module Subtype
-            extend FinchAPI::Enum
-
-            S_CORPORATION = :s_corporation
-            C_CORPORATION = :c_corporation
-            B_CORPORATION = :b_corporation
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-
-          # The tax payer type of the company.
-          module Type
-            extend FinchAPI::Enum
-
-            LLC = :llc
-            LP = :lp
-            CORPORATION = :corporation
-            SOLE_PROPRIETOR = :sole_proprietor
-            NON_PROFIT = :non_profit
-            PARTNERSHIP = :partnership
-            COOPERATIVE = :cooperative
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/models/sandbox/company_update_response.rb

@@ -1,233 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Models
-    module Sandbox
-      class CompanyUpdateResponse < FinchAPI::BaseModel
-        # @!attribute accounts
-        #   An array of bank account objects associated with the payroll/HRIS system.
-        #
-        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account>, nil]
-        required :accounts,
-                 -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account] },
-                 nil?: true
-
-        # @!attribute departments
-        #   The array of company departments.
-        #
-        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil>, nil]
-        required :departments,
-                 -> { FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil?: true] },
-                 nil?: true
-
-        # @!attribute ein
-        #   The employer identification number.
-        #
-        #   @return [String, nil]
-        required :ein, String, nil?: true
-
-        # @!attribute entity
-        #   The entity type object.
-        #
-        #   @return [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, nil]
-        required :entity, -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity }, nil?: true
-
-        # @!attribute legal_name
-        #   The legal name of the company.
-        #
-        #   @return [String, nil]
-        required :legal_name, String, nil?: true
-
-        # @!attribute locations
-        #
-        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
-        required :locations, -> { FinchAPI::ArrayOf[FinchAPI::Models::Location, nil?: true] }, nil?: true
-
-        # @!attribute primary_email
-        #   The email of the main administrator on the account.
-        #
-        #   @return [String, nil]
-        required :primary_email, String, nil?: true
-
-        # @!attribute primary_phone_number
-        #   The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
-        #
-        #   @return [String, nil]
-        required :primary_phone_number, String, nil?: true
-
-        # @!parse
-        #   # @param accounts [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account>, nil]
-        #   # @param departments [Array<FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, nil>, nil]
-        #   # @param ein [String, nil]
-        #   # @param entity [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, nil]
-        #   # @param legal_name [String, nil]
-        #   # @param locations [Array<FinchAPI::Models::Location, nil>, nil]
-        #   # @param primary_email [String, nil]
-        #   # @param primary_phone_number [String, nil]
-        #   #
-        #   def initialize(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:, **) = super
-
-        # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-        class Account < FinchAPI::BaseModel
-          # @!attribute account_name
-          #   The name of the bank associated in the payroll/HRIS system.
-          #
-          #   @return [String, nil]
-          optional :account_name, String, nil?: true
-
-          # @!attribute account_number
-          #   10-12 digit number to specify the bank account
-          #
-          #   @return [String, nil]
-          optional :account_number, String, nil?: true
-
-          # @!attribute account_type
-          #   The type of bank account.
-          #
-          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType, nil]
-          optional :account_type,
-                   enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType },
-                   nil?: true
-
-          # @!attribute institution_name
-          #   Name of the banking institution.
-          #
-          #   @return [String, nil]
-          optional :institution_name, String, nil?: true
-
-          # @!attribute routing_number
-          #   A nine-digit code that's based on the U.S. Bank location where your account was
-          #     opened.
-          #
-          #   @return [String, nil]
-          optional :routing_number, String, nil?: true
-
-          # @!parse
-          #   # @param account_name [String, nil]
-          #   # @param account_number [String, nil]
-          #   # @param account_type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType, nil]
-          #   # @param institution_name [String, nil]
-          #   # @param routing_number [String, nil]
-          #   #
-          #   def initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          # The type of bank account.
-          module AccountType
-            extend FinchAPI::Enum
-
-            CHECKING = :checking
-            SAVINGS = :savings
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-
-        class Department < FinchAPI::BaseModel
-          # @!attribute name
-          #   The department name.
-          #
-          #   @return [String, nil]
-          optional :name, String, nil?: true
-
-          # @!attribute parent
-          #   The parent department, if present.
-          #
-          #   @return [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, nil]
-          optional :parent, -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent }, nil?: true
-
-          # @!parse
-          #   # @param name [String, nil]
-          #   # @param parent [FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, nil]
-          #   #
-          #   def initialize(name: nil, parent: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          class Parent < FinchAPI::BaseModel
-            # @!attribute name
-            #   The parent department's name.
-            #
-            #   @return [String, nil]
-            optional :name, String, nil?: true
-
-            # @!parse
-            #   # The parent department, if present.
-            #   #
-            #   # @param name [String, nil]
-            #   #
-            #   def initialize(name: nil, **) = super
-
-            # def initialize: (Hash | FinchAPI::BaseModel) -> void
-          end
-        end
-
-        class Entity < FinchAPI::BaseModel
-          # @!attribute subtype
-          #   The tax payer subtype of the company.
-          #
-          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype, nil]
-          optional :subtype,
-                   enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype },
-                   nil?: true
-
-          # @!attribute type
-          #   The tax payer type of the company.
-          #
-          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type, nil]
-          optional :type, enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type }, nil?: true
-
-          # @!parse
-          #   # The entity type object.
-          #   #
-          #   # @param subtype [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype, nil]
-          #   # @param type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type, nil]
-          #   #
-          #   def initialize(subtype: nil, type: nil, **) = super
-
-          # def initialize: (Hash | FinchAPI::BaseModel) -> void
-
-          # The tax payer subtype of the company.
-          module Subtype
-            extend FinchAPI::Enum
-
-            S_CORPORATION = :s_corporation
-            C_CORPORATION = :c_corporation
-            B_CORPORATION = :b_corporation
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-
-          # The tax payer type of the company.
-          module Type
-            extend FinchAPI::Enum
-
-            LLC = :llc
-            LP = :lp
-            CORPORATION = :corporation
-            SOLE_PROPRIETOR = :sole_proprietor
-            NON_PROFIT = :non_profit
-            PARTNERSHIP = :partnership
-            COOPERATIVE = :cooperative
-
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
-          end
-        end
-      end
-    end
-  end
-end