finch-api 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/lib/finch_api/models/income.rb

@@ -18,19 +18,19 @@ module FinchAPI
       # @!attribute effective_date
       #   The date the income amount went into effect.
       #
-      #   @return [String, nil]
-      required :effective_date, String, nil?: true
+      #   @return [Date, nil]
+      required :effective_date, Date, nil?: true
 
       # @!attribute unit
       #   The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
       #   `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
       #
-      #   @return [Symbol, FinchAPI::Income::Unit, nil]
+      #   @return [Symbol, FinchAPI::Models::Income::Unit, nil]
       required :unit, enum: -> { FinchAPI::Income::Unit }, nil?: true
 
       # @!method initialize(amount:, currency:, effective_date:, unit:)
-      #   Some parameter documentations has been truncated, see {FinchAPI::Income} for
-      #   more details.
+      #   Some parameter documentations has been truncated, see {FinchAPI::Models::Income}
+      #   for more details.
       #
       #   The employee's income as reported by the provider. This may not always be
       #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
@@ -40,14 +40,14 @@ module FinchAPI
       #
       #   @param currency [String, nil] The currency code.
       #
-      #   @param effective_date [String, nil] The date the income amount went into effect.
+      #   @param effective_date [Date, nil] The date the income amount went into effect.
       #
-      #   @param unit [Symbol, FinchAPI::Income::Unit, nil] The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_mon
+      #   @param unit [Symbol, FinchAPI::Models::Income::Unit, nil] The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_mon
 
       # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
       # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
       #
-      # @see FinchAPI::Income#unit
+      # @see FinchAPI::Models::Income#unit
       module Unit
         extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/individual_event.rb

@@ -5,17 +5,17 @@ module FinchAPI
     class IndividualEvent < FinchAPI::Models::BaseWebhookEvent
       # @!attribute data
       #
-      #   @return [FinchAPI::IndividualEvent::Data, nil]
+      #   @return [FinchAPI::Models::IndividualEvent::Data, nil]
       optional :data, -> { FinchAPI::IndividualEvent::Data }
 
       # @!attribute event_type
       #
-      #   @return [Symbol, FinchAPI::IndividualEvent::EventType, nil]
+      #   @return [Symbol, FinchAPI::Models::IndividualEvent::EventType, nil]
       optional :event_type, enum: -> { FinchAPI::IndividualEvent::EventType }
 
       # @!method initialize(data: nil, event_type: nil)
-      #   @param data [FinchAPI::IndividualEvent::Data]
-      #   @param event_type [Symbol, FinchAPI::IndividualEvent::EventType]
+      #   @param data [FinchAPI::Models::IndividualEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::IndividualEvent::EventType]
 
       class Data < FinchAPI::Internal::Type::BaseModel
         # @!attribute individual_id

data/lib/finch_api/models/introspection.rb

@@ -21,7 +21,7 @@ module FinchAPI
 
       # @!attribute authentication_methods
       #
-      #   @return [Array<FinchAPI::Introspection::AuthenticationMethod>]
+      #   @return [Array<FinchAPI::Models::Introspection::AuthenticationMethod>]
       required :authentication_methods,
                -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Introspection::AuthenticationMethod] }
 
@@ -34,7 +34,7 @@ module FinchAPI
       # @!attribute client_type
       #   The type of application associated with a token.
       #
-      #   @return [Symbol, FinchAPI::Introspection::ClientType]
+      #   @return [Symbol, FinchAPI::Models::Introspection::ClientType]
       required :client_type, enum: -> { FinchAPI::Introspection::ClientType }
 
       # @!attribute company_id
@@ -54,7 +54,7 @@ module FinchAPI
 
       # @!attribute connection_status
       #
-      #   @return [FinchAPI::Introspection::ConnectionStatus]
+      #   @return [FinchAPI::Models::Introspection::ConnectionStatus]
       required :connection_status, -> { FinchAPI::Introspection::ConnectionStatus }
 
       # @!attribute connection_type
@@ -63,7 +63,7 @@ module FinchAPI
       #   - `provider` - connection to an external provider
       #   - `finch` - finch-generated data.
       #
-      #   @return [Symbol, FinchAPI::Introspection::ConnectionType]
+      #   @return [Symbol, FinchAPI::Models::Introspection::ConnectionType]
       required :connection_type, enum: -> { FinchAPI::Introspection::ConnectionType }
 
       # @!attribute customer_email
@@ -123,26 +123,26 @@ module FinchAPI
       required :username, String
 
       # @!method initialize(id:, account_id:, authentication_methods:, client_id:, client_type:, company_id:, connection_id:, connection_status:, connection_type:, customer_email:, customer_id:, customer_name:, manual:, payroll_provider_id:, products:, provider_id:, username:)
-      #   Some parameter documentations has been truncated, see {FinchAPI::Introspection}
-      #   for more details.
+      #   Some parameter documentations has been truncated, see
+      #   {FinchAPI::Models::Introspection} for more details.
       #
       #   @param id [String] The Finch UUID of the token being introspected.
       #
       #   @param account_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins
       #
-      #   @param authentication_methods [Array<FinchAPI::Introspection::AuthenticationMethod>]
+      #   @param authentication_methods [Array<FinchAPI::Models::Introspection::AuthenticationMethod>]
       #
       #   @param client_id [String] The client ID of the application associated with the `access_token`.
       #
-      #   @param client_type [Symbol, FinchAPI::Introspection::ClientType] The type of application associated with a token.
+      #   @param client_type [Symbol, FinchAPI::Models::Introspection::ClientType] The type of application associated with a token.
       #
       #   @param company_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins
       #
       #   @param connection_id [String] The Finch UUID of the connection associated with the `access_token`.
       #
-      #   @param connection_status [FinchAPI::Introspection::ConnectionStatus]
+      #   @param connection_status [FinchAPI::Models::Introspection::ConnectionStatus]
       #
-      #   @param connection_type [Symbol, FinchAPI::Introspection::ConnectionType] The type of the connection associated with the token.
+      #   @param connection_type [Symbol, FinchAPI::Models::Introspection::ConnectionType] The type of the connection associated with the token.
       #
       #   @param customer_email [String, nil] The email of your customer you provided to Finch when a connect session was crea
       #
@@ -163,7 +163,7 @@ module FinchAPI
       class AuthenticationMethod < FinchAPI::Internal::Type::BaseModel
         # @!attribute connection_status
         #
-        #   @return [FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus, nil]
+        #   @return [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, nil]
         optional :connection_status, -> { FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus }
 
         # @!attribute products
@@ -175,17 +175,17 @@ module FinchAPI
         # @!attribute type
         #   The type of authentication method.
         #
-        #   @return [Symbol, FinchAPI::Introspection::AuthenticationMethod::Type, nil]
+        #   @return [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type, nil]
         optional :type, enum: -> { FinchAPI::Introspection::AuthenticationMethod::Type }
 
         # @!method initialize(connection_status: nil, products: nil, type: nil)
-        #   @param connection_status [FinchAPI::Introspection::AuthenticationMethod::ConnectionStatus]
+        #   @param connection_status [FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus]
         #
         #   @param products [Array<String>] An array of the authorized products associated with the `access_token`.
         #
-        #   @param type [Symbol, FinchAPI::Introspection::AuthenticationMethod::Type] The type of authentication method.
+        #   @param type [Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type] The type of authentication method.
 
-        # @see FinchAPI::Introspection::AuthenticationMethod#connection_status
+        # @see FinchAPI::Models::Introspection::AuthenticationMethod#connection_status
         class ConnectionStatus < FinchAPI::Internal::Type::BaseModel
           # @!attribute message
           #
@@ -194,17 +194,17 @@ module FinchAPI
 
           # @!attribute status
           #
-          #   @return [Symbol, FinchAPI::ConnectionStatusType, nil]
+          #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
           optional :status, enum: -> { FinchAPI::ConnectionStatusType }
 
           # @!method initialize(message: nil, status: nil)
           #   @param message [String]
-          #   @param status [Symbol, FinchAPI::ConnectionStatusType]
+          #   @param status [Symbol, FinchAPI::Models::ConnectionStatusType]
         end
 
         # The type of authentication method.
         #
-        # @see FinchAPI::Introspection::AuthenticationMethod#type
+        # @see FinchAPI::Models::Introspection::AuthenticationMethod#type
         module Type
           extend FinchAPI::Internal::Type::Enum
 
@@ -221,7 +221,7 @@ module FinchAPI
 
       # The type of application associated with a token.
       #
-      # @see FinchAPI::Introspection#client_type
+      # @see FinchAPI::Models::Introspection#client_type
       module ClientType
         extend FinchAPI::Internal::Type::Enum
 
@@ -233,7 +233,7 @@ module FinchAPI
         #   @return [Array<Symbol>]
       end
 
-      # @see FinchAPI::Introspection#connection_status
+      # @see FinchAPI::Models::Introspection#connection_status
       class ConnectionStatus < FinchAPI::Internal::Type::BaseModel
         # @!attribute last_successful_sync
         #   The datetime when the connection was last successfully synced.
@@ -248,7 +248,7 @@ module FinchAPI
 
         # @!attribute status
         #
-        #   @return [Symbol, FinchAPI::ConnectionStatusType, nil]
+        #   @return [Symbol, FinchAPI::Models::ConnectionStatusType, nil]
         optional :status, enum: -> { FinchAPI::ConnectionStatusType }
 
         # @!method initialize(last_successful_sync: nil, message: nil, status: nil)
@@ -256,7 +256,7 @@ module FinchAPI
         #
         #   @param message [String]
         #
-        #   @param status [Symbol, FinchAPI::ConnectionStatusType]
+        #   @param status [Symbol, FinchAPI::Models::ConnectionStatusType]
       end
 
       # The type of the connection associated with the token.
@@ -264,7 +264,7 @@ module FinchAPI
       # - `provider` - connection to an external provider
       # - `finch` - finch-generated data.
       #
-      # @see FinchAPI::Introspection#connection_type
+      # @see FinchAPI::Models::Introspection#connection_type
       module ConnectionType
         extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/job_completion_event.rb

@@ -5,17 +5,17 @@ module FinchAPI
     class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent
       # @!attribute data
       #
-      #   @return [FinchAPI::JobCompletionEvent::Data, nil]
+      #   @return [FinchAPI::Models::JobCompletionEvent::Data, nil]
       optional :data, -> { FinchAPI::JobCompletionEvent::Data }
 
       # @!attribute event_type
       #
-      #   @return [Symbol, FinchAPI::JobCompletionEvent::EventType, nil]
+      #   @return [Symbol, FinchAPI::Models::JobCompletionEvent::EventType, nil]
       optional :event_type, enum: -> { FinchAPI::JobCompletionEvent::EventType }
 
       # @!method initialize(data: nil, event_type: nil)
-      #   @param data [FinchAPI::JobCompletionEvent::Data]
-      #   @param event_type [Symbol, FinchAPI::JobCompletionEvent::EventType]
+      #   @param data [FinchAPI::Models::JobCompletionEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::JobCompletionEvent::EventType]
 
       class Data < FinchAPI::Internal::Type::BaseModel
         # @!attribute job_id

data/lib/finch_api/models/jobs/automated_async_job.rb

@@ -34,7 +34,7 @@ module FinchAPI
         # @!attribute params
         #   The input parameters for the job.
         #
-        #   @return [FinchAPI::Jobs::AutomatedAsyncJob::Params, nil]
+        #   @return [FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, nil]
         required :params, -> { FinchAPI::Jobs::AutomatedAsyncJob::Params }, nil?: true
 
         # @!attribute scheduled_at
@@ -53,18 +53,18 @@ module FinchAPI
 
         # @!attribute status
         #
-        #   @return [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Status]
+        #   @return [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status]
         required :status, enum: -> { FinchAPI::Jobs::AutomatedAsyncJob::Status }
 
         # @!attribute type
         #   The type of automated job
         #
-        #   @return [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Type]
+        #   @return [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type]
         required :type, enum: -> { FinchAPI::Jobs::AutomatedAsyncJob::Type }
 
         # @!method initialize(completed_at:, created_at:, job_id:, job_url:, params:, scheduled_at:, started_at:, status:, type:)
         #   Some parameter documentations has been truncated, see
-        #   {FinchAPI::Jobs::AutomatedAsyncJob} for more details.
+        #   {FinchAPI::Models::Jobs::AutomatedAsyncJob} for more details.
         #
         #   @param completed_at [Time, nil] The datetime the job completed.
         #
@@ -74,17 +74,17 @@ module FinchAPI
         #
         #   @param job_url [String] The url that can be used to retrieve the job status
         #
-        #   @param params [FinchAPI::Jobs::AutomatedAsyncJob::Params, nil] The input parameters for the job.
+        #   @param params [FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, nil] The input parameters for the job.
         #
         #   @param scheduled_at [Time, nil] The datetime a job is scheduled to be run. For scheduled jobs, this datetime can
         #
         #   @param started_at [Time, nil] The datetime a job entered into the job queue.
         #
-        #   @param status [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Status]
+        #   @param status [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status]
         #
-        #   @param type [Symbol, FinchAPI::Jobs::AutomatedAsyncJob::Type] The type of automated job
+        #   @param type [Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type] The type of automated job
 
-        # @see FinchAPI::Jobs::AutomatedAsyncJob#params
+        # @see FinchAPI::Models::Jobs::AutomatedAsyncJob#params
         class Params < FinchAPI::Internal::Type::BaseModel
           # @!attribute individual_id
           #   The ID of the individual that the job was completed for.
@@ -98,7 +98,7 @@ module FinchAPI
           #   @param individual_id [String] The ID of the individual that the job was completed for.
         end
 
-        # @see FinchAPI::Jobs::AutomatedAsyncJob#status
+        # @see FinchAPI::Models::Jobs::AutomatedAsyncJob#status
         module Status
           extend FinchAPI::Internal::Type::Enum
 
@@ -115,7 +115,7 @@ module FinchAPI
 
         # The type of automated job
         #
-        # @see FinchAPI::Jobs::AutomatedAsyncJob#type
+        # @see FinchAPI::Models::Jobs::AutomatedAsyncJob#type
         module Type
           extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/jobs/automated_create_params.rb

@@ -11,18 +11,18 @@ module FinchAPI
         # @!attribute type
         #   The type of job to start.
         #
-        #   @return [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type]
+        #   @return [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type]
         required :type, enum: -> { FinchAPI::Jobs::AutomatedCreateParams::Type }
 
         # @!attribute params
         #
-        #   @return [FinchAPI::Jobs::AutomatedCreateParams::Params]
+        #   @return [FinchAPI::Models::Jobs::AutomatedCreateParams::Params]
         required :params, -> { FinchAPI::Jobs::AutomatedCreateParams::Params }
 
         # @!method initialize(type:, params:, request_options: {})
-        #   @param type [Symbol, FinchAPI::Jobs::AutomatedCreateParams::Type] The type of job to start.
+        #   @param type [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type] The type of job to start.
         #
-        #   @param params [FinchAPI::Jobs::AutomatedCreateParams::Params]
+        #   @param params [FinchAPI::Models::Jobs::AutomatedCreateParams::Params]
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/finch_api/models/jobs/automated_list_response.rb

@@ -7,7 +7,7 @@ module FinchAPI
       class AutomatedListResponse < FinchAPI::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Array<FinchAPI::Jobs::AutomatedAsyncJob>]
+        #   @return [Array<FinchAPI::Models::Jobs::AutomatedAsyncJob>]
         required :data, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Jobs::AutomatedAsyncJob] }
 
         # @!attribute meta
@@ -16,7 +16,7 @@ module FinchAPI
         required :meta, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta }
 
         # @!method initialize(data:, meta:)
-        #   @param data [Array<FinchAPI::Jobs::AutomatedAsyncJob>]
+        #   @param data [Array<FinchAPI::Models::Jobs::AutomatedAsyncJob>]
         #   @param meta [FinchAPI::Models::Jobs::AutomatedListResponse::Meta]
 
         # @see FinchAPI::Models::Jobs::AutomatedListResponse#meta

data/lib/finch_api/models/jobs/manual_async_job.rb

@@ -18,7 +18,7 @@ module FinchAPI
 
         # @!attribute status
         #
-        #   @return [Symbol, FinchAPI::Jobs::ManualAsyncJob::Status]
+        #   @return [Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status]
         required :status, enum: -> { FinchAPI::Jobs::ManualAsyncJob::Status }
 
         # @!method initialize(body:, job_id:, status:)
@@ -26,9 +26,9 @@ module FinchAPI
         #
         #   @param job_id [String]
         #
-        #   @param status [Symbol, FinchAPI::Jobs::ManualAsyncJob::Status]
+        #   @param status [Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status]
 
-        # @see FinchAPI::Jobs::ManualAsyncJob#status
+        # @see FinchAPI::Models::Jobs::ManualAsyncJob#status
         module Status
           extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/money.rb

@@ -7,14 +7,14 @@ module FinchAPI
       #   Amount for money object (in cents)
       #
       #   @return [Integer, nil]
-      optional :amount, Integer, nil?: true
+      required :amount, Integer, nil?: true
 
       # @!attribute currency
       #
-      #   @return [String, nil]
-      optional :currency, String
+      #   @return [String]
+      required :currency, String
 
-      # @!method initialize(amount: nil, currency: nil)
+      # @!method initialize(amount:, currency:)
       #   @param amount [Integer, nil] Amount for money object (in cents)
       #
       #   @param currency [String]

data/lib/finch_api/models/operation_support_matrix.rb

@@ -12,7 +12,7 @@ module FinchAPI
       #   - `client_access_only`: This behavior is supported by the provider, but only
       #     available to the client and not to Finch
       #
-      #   @return [Symbol, FinchAPI::OperationSupport, nil]
+      #   @return [Symbol, FinchAPI::Models::OperationSupport, nil]
       optional :create, enum: -> { FinchAPI::OperationSupport }
 
       # @!attribute delete
@@ -24,7 +24,7 @@ module FinchAPI
       #   - `client_access_only`: This behavior is supported by the provider, but only
       #     available to the client and not to Finch
       #
-      #   @return [Symbol, FinchAPI::OperationSupport, nil]
+      #   @return [Symbol, FinchAPI::Models::OperationSupport, nil]
       optional :delete, enum: -> { FinchAPI::OperationSupport }
 
       # @!attribute read
@@ -36,7 +36,7 @@ module FinchAPI
       #   - `client_access_only`: This behavior is supported by the provider, but only
       #     available to the client and not to Finch
       #
-      #   @return [Symbol, FinchAPI::OperationSupport, nil]
+      #   @return [Symbol, FinchAPI::Models::OperationSupport, nil]
       optional :read, enum: -> { FinchAPI::OperationSupport }
 
       # @!attribute update
@@ -48,20 +48,20 @@ module FinchAPI
       #   - `client_access_only`: This behavior is supported by the provider, but only
       #     available to the client and not to Finch
       #
-      #   @return [Symbol, FinchAPI::OperationSupport, nil]
+      #   @return [Symbol, FinchAPI::Models::OperationSupport, nil]
       optional :update, enum: -> { FinchAPI::OperationSupport }
 
       # @!method initialize(create: nil, delete: nil, read: nil, update: nil)
       #   Some parameter documentations has been truncated, see
-      #   {FinchAPI::OperationSupportMatrix} for more details.
+      #   {FinchAPI::Models::OperationSupportMatrix} for more details.
       #
-      #   @param create [Symbol, FinchAPI::OperationSupport] - `supported`: This operation is supported by both the provider and Finch
+      #   @param create [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch
       #
-      #   @param delete [Symbol, FinchAPI::OperationSupport] - `supported`: This operation is supported by both the provider and Finch
+      #   @param delete [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch
       #
-      #   @param read [Symbol, FinchAPI::OperationSupport] - `supported`: This operation is supported by both the provider and Finch
+      #   @param read [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch
       #
-      #   @param update [Symbol, FinchAPI::OperationSupport] - `supported`: This operation is supported by both the provider and Finch
+      #   @param update [Symbol, FinchAPI::Models::OperationSupport] - `supported`: This operation is supported by both the provider and Finch
     end
   end
 end

data/lib/finch_api/models/pay_statement_event.rb

@@ -5,17 +5,17 @@ module FinchAPI
     class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent
       # @!attribute data
       #
-      #   @return [FinchAPI::PayStatementEvent::Data, nil]
+      #   @return [FinchAPI::Models::PayStatementEvent::Data, nil]
       optional :data, -> { FinchAPI::PayStatementEvent::Data }
 
       # @!attribute event_type
       #
-      #   @return [Symbol, FinchAPI::PayStatementEvent::EventType, nil]
+      #   @return [Symbol, FinchAPI::Models::PayStatementEvent::EventType, nil]
       optional :event_type, enum: -> { FinchAPI::PayStatementEvent::EventType }
 
       # @!method initialize(data: nil, event_type: nil)
-      #   @param data [FinchAPI::PayStatementEvent::Data]
-      #   @param event_type [Symbol, FinchAPI::PayStatementEvent::EventType]
+      #   @param data [FinchAPI::Models::PayStatementEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::PayStatementEvent::EventType]
 
       class Data < FinchAPI::Internal::Type::BaseModel
         # @!attribute individual_id

data/lib/finch_api/models/payment_event.rb

@@ -5,17 +5,17 @@ module FinchAPI
     class PaymentEvent < FinchAPI::Models::BaseWebhookEvent
       # @!attribute data
       #
-      #   @return [FinchAPI::PaymentEvent::Data, nil]
+      #   @return [FinchAPI::Models::PaymentEvent::Data, nil]
       optional :data, -> { FinchAPI::PaymentEvent::Data }
 
       # @!attribute event_type
       #
-      #   @return [Symbol, FinchAPI::PaymentEvent::EventType, nil]
+      #   @return [Symbol, FinchAPI::Models::PaymentEvent::EventType, nil]
       optional :event_type, enum: -> { FinchAPI::PaymentEvent::EventType }
 
       # @!method initialize(data: nil, event_type: nil)
-      #   @param data [FinchAPI::PaymentEvent::Data]
-      #   @param event_type [Symbol, FinchAPI::PaymentEvent::EventType]
+      #   @param data [FinchAPI::Models::PaymentEvent::Data]
+      #   @param event_type [Symbol, FinchAPI::Models::PaymentEvent::EventType]
 
       class Data < FinchAPI::Internal::Type::BaseModel
         # @!attribute pay_date

data/lib/finch_api/models/payroll/pay_group_list_response.rb

@@ -8,23 +8,23 @@ module FinchAPI
         # @!attribute id
         #   Finch id (uuidv4) for the pay group
         #
-        #   @return [String, nil]
-        optional :id, String
+        #   @return [String]
+        required :id, String
 
         # @!attribute name
         #   Name of the pay group
         #
-        #   @return [String, nil]
-        optional :name, String
+        #   @return [String]
+        required :name, String
 
         # @!attribute pay_frequencies
         #   List of pay frequencies associated with this pay group
         #
-        #   @return [Array<Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency>, nil]
-        optional :pay_frequencies,
+        #   @return [Array<Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency>]
+        required :pay_frequencies,
                  -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency] }
 
-        # @!method initialize(id: nil, name: nil, pay_frequencies: nil)
+        # @!method initialize(id:, name:, pay_frequencies:)
         #   @param id [String] Finch id (uuidv4) for the pay group
         #
         #   @param name [String] Name of the pay group
@@ -35,14 +35,14 @@ module FinchAPI
           extend FinchAPI::Internal::Type::Enum
 
           ANNUALLY = :annually
-          SEMI_ANNUALLY = :semi_annually
-          QUARTERLY = :quarterly
-          MONTHLY = :monthly
-          SEMI_MONTHLY = :semi_monthly
           BI_WEEKLY = :bi_weekly
-          WEEKLY = :weekly
           DAILY = :daily
+          MONTHLY = :monthly
           OTHER = :other
+          QUARTERLY = :quarterly
+          SEMI_ANNUALLY = :semi_annually
+          SEMI_MONTHLY = :semi_monthly
+          WEEKLY = :weekly
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/finch_api/models/payroll/pay_group_retrieve_response.rb

@@ -42,14 +42,14 @@ module FinchAPI
           extend FinchAPI::Internal::Type::Enum
 
           ANNUALLY = :annually
-          SEMI_ANNUALLY = :semi_annually
-          QUARTERLY = :quarterly
-          MONTHLY = :monthly
-          SEMI_MONTHLY = :semi_monthly
           BI_WEEKLY = :bi_weekly
-          WEEKLY = :weekly
           DAILY = :daily
+          MONTHLY = :monthly
           OTHER = :other
+          QUARTERLY = :quarterly
+          SEMI_ANNUALLY = :semi_annually
+          SEMI_MONTHLY = :semi_monthly
+          WEEKLY = :weekly
 
           # @!method self.values
           #   @return [Array<Symbol>]