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

data/lib/finch_api/models/request_forwarding_forward_params.rb

@@ -49,19 +49,14 @@ module FinchAPI
       #   {FinchAPI::Models::RequestForwardingForwardParams} for more details.
       #
       #   @param method_ [String] The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
-      #   ...
       #
       #   @param route [String] The URL route path for the forwarded request. This value must begin with a forwa
-      #   ...
       #
       #   @param data [String, nil] The body for the forwarded request. This value must be specified as either a str
-      #   ...
       #
       #   @param headers [Object, nil] The HTTP headers to include on the forwarded request. This value must be specifi
-      #   ...
       #
       #   @param params [Object, nil] The query parameters for the forwarded request. This value must be specified as
-      #   ...
       #
       #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/finch_api/models/request_forwarding_forward_response.rb

@@ -38,16 +38,12 @@ module FinchAPI
       #   {FinchAPI::Models::RequestForwardingForwardResponse} for more details.
       #
       #   @param data [String, nil] A string representation of the HTTP response body of the forwarded request’s res
-      #   ...
       #
       #   @param headers [Object, nil] The HTTP headers of the forwarded request’s response, exactly as received from t
-      #   ...
       #
       #   @param request [FinchAPI::Models::RequestForwardingForwardResponse::Request] An object containing details of your original forwarded request, for your ease o
-      #   ...
       #
       #   @param status_code [Integer] The HTTP status code of the forwarded request’s response, exactly received from
-      #   ...
 
       # @see FinchAPI::Models::RequestForwardingForwardResponse#request
       class Request < FinchAPI::Internal::Type::BaseModel
@@ -94,16 +90,12 @@ module FinchAPI
         #   of reference.
         #
         #   @param data [String, nil] The body that was specified for the forwarded request. If a value was not specif
-        #   ...
         #
         #   @param headers [Object, nil] The specified HTTP headers that were included in the forwarded request. If no he
-        #   ...
         #
         #   @param method_ [String] The HTTP method that was specified for the forwarded request. Valid values inclu
-        #   ...
         #
         #   @param params [Object, nil] The query parameters that were included in the forwarded request. If no query pa
-        #   ...
         #
         #   @param route [String] The URL route path that was specified for the forwarded request.
       end

data/lib/finch_api/models/sandbox/company_update_params.rb

@@ -11,17 +11,20 @@ module FinchAPI
         # @!attribute accounts
         #   An array of bank account objects associated with the payroll/HRIS system.
         #
-        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil]
+        #   @return [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil]
         required :accounts,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account] },
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Account] },
                  nil?: true
 
         # @!attribute departments
         #   The array of company departments.
         #
-        #   @return [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil]
+        #   @return [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil]
         required :departments,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil?: true] },
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::CompanyUpdateParams::Department,
+                                                     nil?: true]
+                 },
                  nil?: true
 
         # @!attribute ein
@@ -33,8 +36,8 @@ module FinchAPI
         # @!attribute entity
         #   The entity type object.
         #
-        #   @return [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil]
-        required :entity, -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity }, nil?: true
+        #   @return [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil]
+        required :entity, -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity }, nil?: true
 
         # @!attribute legal_name
         #   The legal name of the company.
@@ -44,9 +47,11 @@ module FinchAPI
 
         # @!attribute locations
         #
-        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
+        #   @return [Array<FinchAPI::Location, nil>, nil]
         required :locations,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true] },
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]
+                 },
                  nil?: true
 
         # @!attribute primary_email
@@ -66,22 +71,21 @@ module FinchAPI
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Sandbox::CompanyUpdateParams} for more details.
         #
-        #   @param accounts [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
+        #   @param accounts [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
         #
-        #   @param departments [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
+        #   @param departments [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
         #
         #   @param ein [String, nil] The employer identification number.
         #
-        #   @param entity [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
+        #   @param entity [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
         #
         #   @param legal_name [String, nil] The legal name of the company.
         #
-        #   @param locations [Array<FinchAPI::Models::Location, nil>, nil]
+        #   @param locations [Array<FinchAPI::Location, nil>, nil]
         #
         #   @param primary_email [String, nil] The email of the main administrator on the account.
         #
         #   @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e
-        #   ...
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -101,9 +105,9 @@ module FinchAPI
           # @!attribute account_type
           #   The type of bank account.
           #
-          #   @return [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
+          #   @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType, nil]
           optional :account_type,
-                   enum: -> { FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType },
+                   enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType },
                    nil?: true
 
           # @!attribute institution_name
@@ -121,22 +125,21 @@ module FinchAPI
 
           # @!method initialize(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil)
           #   Some parameter documentations has been truncated, see
-          #   {FinchAPI::Models::Sandbox::CompanyUpdateParams::Account} for more details.
+          #   {FinchAPI::Sandbox::CompanyUpdateParams::Account} for more details.
           #
           #   @param account_name [String, nil] The name of the bank associated in the payroll/HRIS system.
           #
           #   @param account_number [String, nil] 10-12 digit number to specify the bank account
           #
-          #   @param account_type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType, nil] The type of bank account.
+          #   @param account_type [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType, nil] The type of bank account.
           #
           #   @param institution_name [String, nil] Name of the banking institution.
           #
           #   @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was
-          #   ...
 
           # The type of bank account.
           #
-          # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Account#account_type
+          # @see FinchAPI::Sandbox::CompanyUpdateParams::Account#account_type
           module AccountType
             extend FinchAPI::Internal::Type::Enum
 
@@ -158,15 +161,15 @@ module FinchAPI
           # @!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
+          #   @return [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil]
+          optional :parent, -> { FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent }, nil?: true
 
           # @!method initialize(name: nil, parent: nil)
           #   @param name [String, nil] The department name.
           #
-          #   @param parent [FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, nil] The parent department, if present.
+          #   @param parent [FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent, nil] The parent department, if present.
 
-          # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Department#parent
+          # @see FinchAPI::Sandbox::CompanyUpdateParams::Department#parent
           class Parent < FinchAPI::Internal::Type::BaseModel
             # @!attribute name
             #   The parent department's name.
@@ -185,27 +188,25 @@ module FinchAPI
           # @!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
+          #   @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil]
+          optional :subtype, enum: -> { FinchAPI::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
+          #   @return [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type, nil]
+          optional :type, enum: -> { FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type }, nil?: true
 
           # @!method initialize(subtype: nil, type: nil)
           #   The entity type object.
           #
-          #   @param subtype [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] The tax payer subtype of the company.
+          #   @param subtype [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype, nil] The tax payer subtype of the company.
           #
-          #   @param type [Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type, nil] The tax payer type of the company.
+          #   @param type [Symbol, FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type, nil] The tax payer type of the company.
 
           # The tax payer subtype of the company.
           #
-          # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity#subtype
+          # @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#subtype
           module Subtype
             extend FinchAPI::Internal::Type::Enum
 
@@ -219,7 +220,7 @@ module FinchAPI
 
           # The tax payer type of the company.
           #
-          # @see FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity#type
+          # @see FinchAPI::Sandbox::CompanyUpdateParams::Entity#type
           module Type
             extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/sandbox/company_update_response.rb

@@ -41,9 +41,11 @@ module FinchAPI
 
         # @!attribute locations
         #
-        #   @return [Array<FinchAPI::Models::Location, nil>, nil]
+        #   @return [Array<FinchAPI::Location, nil>, nil]
         required :locations,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Location, nil?: true] },
+                 -> {
+                   FinchAPI::Internal::Type::ArrayOf[FinchAPI::Location, nil?: true]
+                 },
                  nil?: true
 
         # @!attribute primary_email
@@ -73,12 +75,11 @@ module FinchAPI
         #
         #   @param legal_name [String, nil] The legal name of the company.
         #
-        #   @param locations [Array<FinchAPI::Models::Location, nil>, nil]
+        #   @param locations [Array<FinchAPI::Location, nil>, nil]
         #
         #   @param primary_email [String, nil] The email of the main administrator on the account.
         #
         #   @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e
-        #   ...
 
         class Account < FinchAPI::Internal::Type::BaseModel
           # @!attribute account_name
@@ -127,7 +128,6 @@ module FinchAPI
           #   @param institution_name [String, nil] Name of the banking institution.
           #
           #   @param routing_number [String, nil] A nine-digit code that's based on the U.S. Bank location where your account was
-          #   ...
 
           # The type of bank account.
           #

data/lib/finch_api/models/sandbox/connection_create_params.rb

@@ -16,9 +16,11 @@ module FinchAPI
 
         # @!attribute authentication_type
         #
-        #   @return [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType, nil]
+        #   @return [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType, nil]
         optional :authentication_type,
-                 enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType }
+                 enum: -> {
+                   FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType
+                 }
 
         # @!attribute employee_size
         #   Optional: the size of the employer to be created with this connection. Defaults
@@ -39,10 +41,9 @@ module FinchAPI
         #
         #   @param provider_id [String] The provider associated with the connection
         #
-        #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType]
+        #   @param authentication_type [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType]
         #
         #   @param employee_size [Integer] Optional: the size of the employer to be created with this connection. Defaults
-        #   ...
         #
         #   @param products [Array<String>]
         #

data/lib/finch_api/models/sandbox/connections/account_create_params.rb

@@ -22,9 +22,9 @@ module FinchAPI
 
           # @!attribute authentication_type
           #
-          #   @return [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil]
+          #   @return [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType, nil]
           optional :authentication_type,
-                   enum: -> { FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType }
+                   enum: -> { FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType }
 
           # @!attribute products
           #   Optional, defaults to Organization products (`company`, `directory`,
@@ -41,10 +41,9 @@ module FinchAPI
           #
           #   @param provider_id [String] The provider associated with the `access_token`
           #
-          #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType]
+          #   @param authentication_type [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType]
           #
           #   @param products [Array<String>] Optional, defaults to Organization products (`company`, `directory`, `employment
-          #   ...
           #
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/finch_api/models/sandbox/connections/account_update_params.rb

@@ -11,11 +11,11 @@ module FinchAPI
 
           # @!attribute connection_status
           #
-          #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
-          optional :connection_status, enum: -> { FinchAPI::Models::ConnectionStatusType }
+          #   @return [Symbol, FinchAPI::ConnectionStatusType, nil]
+          optional :connection_status, enum: -> { FinchAPI::ConnectionStatusType }
 
           # @!method initialize(connection_status: nil, request_options: {})
-          #   @param connection_status [Symbol, FinchAPI::Models::ConnectionStatusType]
+          #   @param connection_status [Symbol, FinchAPI::ConnectionStatusType]
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
         end
       end