finch-api 0.1.0.pre.alpha.44 → 0.1.0.pre.alpha.45

data/rbi/finch_api/models/hris/company/pay_statement_item/rule_update_response.rbi

@@ -1,346 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Company
-        module PayStatementItem
-          class RuleUpdateResponse < FinchAPI::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse,
-                  FinchAPI::Internal::AnyHash
-                )
-              end
-
-            # Finch id (uuidv4) for the rule.
-            sig { returns(T.nilable(String)) }
-            attr_reader :id
-
-            sig { params(id: String).void }
-            attr_writer :id
-
-            # Specifies the fields to be applied when the condition is met.
-            sig do
-              returns(
-                T.nilable(
-                  FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes
-                )
-              )
-            end
-            attr_reader :attributes
-
-            sig do
-              params(
-                attributes:
-                  FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes::OrHash
-              ).void
-            end
-            attr_writer :attributes
-
-            sig do
-              returns(
-                T.nilable(
-                  T::Array[
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition
-                  ]
-                )
-              )
-            end
-            attr_reader :conditions
-
-            sig do
-              params(
-                conditions:
-                  T::Array[
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::OrHash
-                  ]
-              ).void
-            end
-            attr_writer :conditions
-
-            # The datetime when the rule was created.
-            sig { returns(T.nilable(Time)) }
-            attr_reader :created_at
-
-            sig { params(created_at: Time).void }
-            attr_writer :created_at
-
-            # Specifies when the rules should stop applying rules based on the date.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :effective_end_date
-
-            # Specifies when the rule should begin applying based on the date.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :effective_start_date
-
-            # The entity type to which the rule is applied.
-            sig do
-              returns(
-                T.nilable(
-                  FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol
-                )
-              )
-            end
-            attr_reader :entity_type
-
-            sig do
-              params(
-                entity_type:
-                  FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::OrSymbol
-              ).void
-            end
-            attr_writer :entity_type
-
-            # The priority of the rule.
-            sig { returns(T.nilable(Integer)) }
-            attr_reader :priority
-
-            sig { params(priority: Integer).void }
-            attr_writer :priority
-
-            # The datetime when the rule was last updated.
-            sig { returns(T.nilable(Time)) }
-            attr_reader :updated_at
-
-            sig { params(updated_at: Time).void }
-            attr_writer :updated_at
-
-            sig do
-              params(
-                id: String,
-                attributes:
-                  FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes::OrHash,
-                conditions:
-                  T::Array[
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::OrHash
-                  ],
-                created_at: Time,
-                effective_end_date: T.nilable(String),
-                effective_start_date: T.nilable(String),
-                entity_type:
-                  FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::OrSymbol,
-                priority: Integer,
-                updated_at: Time
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              # Finch id (uuidv4) for the rule.
-              id: nil,
-              # Specifies the fields to be applied when the condition is met.
-              attributes: nil,
-              conditions: nil,
-              # The datetime when the rule was created.
-              created_at: nil,
-              # Specifies when the rules should stop applying rules based on the date.
-              effective_end_date: nil,
-              # Specifies when the rule should begin applying based on the date.
-              effective_start_date: nil,
-              # The entity type to which the rule is applied.
-              entity_type: nil,
-              # The priority of the rule.
-              priority: nil,
-              # The datetime when the rule was last updated.
-              updated_at: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  id: String,
-                  attributes:
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes,
-                  conditions:
-                    T::Array[
-                      FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition
-                    ],
-                  created_at: Time,
-                  effective_end_date: T.nilable(String),
-                  effective_start_date: T.nilable(String),
-                  entity_type:
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol,
-                  priority: Integer,
-                  updated_at: Time
-                }
-              )
-            end
-            def to_hash
-            end
-
-            class Attributes < FinchAPI::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Attributes,
-                    FinchAPI::Internal::AnyHash
-                  )
-                end
-
-              # The metadata to be attached in the entity. It is a key-value pairs where the
-              # values can be of any type (string, number, boolean, object, array, etc.).
-              sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-              attr_reader :metadata
-
-              sig { params(metadata: T::Hash[Symbol, T.anything]).void }
-              attr_writer :metadata
-
-              # Specifies the fields to be applied when the condition is met.
-              sig do
-                params(metadata: T::Hash[Symbol, T.anything]).returns(
-                  T.attached_class
-                )
-              end
-              def self.new(
-                # The metadata to be attached in the entity. It is a key-value pairs where the
-                # values can be of any type (string, number, boolean, object, array, etc.).
-                metadata: nil
-              )
-              end
-
-              sig do
-                override.returns({ metadata: T::Hash[Symbol, T.anything] })
-              end
-              def to_hash
-              end
-            end
-
-            class Condition < FinchAPI::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition,
-                    FinchAPI::Internal::AnyHash
-                  )
-                end
-
-              # The field to be checked in the rule.
-              sig { returns(T.nilable(String)) }
-              attr_reader :field
-
-              sig { params(field: String).void }
-              attr_writer :field
-
-              # The operator to be used in the rule.
-              sig do
-                returns(
-                  T.nilable(
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::TaggedSymbol
-                  )
-                )
-              end
-              attr_reader :operator
-
-              sig do
-                params(
-                  operator:
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::OrSymbol
-                ).void
-              end
-              attr_writer :operator
-
-              # The value of the field to be checked in the rule.
-              sig { returns(T.nilable(String)) }
-              attr_reader :value
-
-              sig { params(value: String).void }
-              attr_writer :value
-
-              sig do
-                params(
-                  field: String,
-                  operator:
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::OrSymbol,
-                  value: String
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                # The field to be checked in the rule.
-                field: nil,
-                # The operator to be used in the rule.
-                operator: nil,
-                # The value of the field to be checked in the rule.
-                value: nil
-              )
-              end
-
-              sig do
-                override.returns(
-                  {
-                    field: String,
-                    operator:
-                      FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::TaggedSymbol,
-                    value: String
-                  }
-                )
-              end
-              def to_hash
-              end
-
-              # The operator to be used in the rule.
-              module Operator
-                extend FinchAPI::Internal::Type::Enum
-
-                TaggedSymbol =
-                  T.type_alias do
-                    T.all(
-                      Symbol,
-                      FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator
-                    )
-                  end
-                OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-                EQUALS =
-                  T.let(
-                    :equals,
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::TaggedSymbol
-                  )
-
-                sig do
-                  override.returns(
-                    T::Array[
-                      FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::Condition::Operator::TaggedSymbol
-                    ]
-                  )
-                end
-                def self.values
-                end
-              end
-            end
-
-            # The entity type to which the rule is applied.
-            module EntityType
-              extend FinchAPI::Internal::Type::Enum
-
-              TaggedSymbol =
-                T.type_alias do
-                  T.all(
-                    Symbol,
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType
-                  )
-                end
-              OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-              PAY_STATEMENT_ITEM =
-                T.let(
-                  :pay_statement_item,
-                  FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol
-                )
-
-              sig do
-                override.returns(
-                  T::Array[
-                    FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse::EntityType::TaggedSymbol
-                  ]
-                )
-              end
-              def self.values
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/finch_api/models/hris/company/pay_statement_item_list_params.rbi

@@ -1,179 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Company
-        class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel
-          extend FinchAPI::Internal::Type::RequestParameters::Converter
-          include FinchAPI::Internal::Type::RequestParameters
-
-          OrHash =
-            T.type_alias do
-              T.any(
-                FinchAPI::HRIS::Company::PayStatementItemListParams,
-                FinchAPI::Internal::AnyHash
-              )
-            end
-
-          # Comma-delimited list of pay statement item categories to filter on. If empty,
-          # defaults to all categories.
-          sig do
-            returns(
-              T.nilable(
-                T::Array[
-                  FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol
-                ]
-              )
-            )
-          end
-          attr_reader :categories
-
-          sig do
-            params(
-              categories:
-                T::Array[
-                  FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol
-                ]
-            ).void
-          end
-          attr_writer :categories
-
-          # The end date to retrieve pay statement items by via their last seen pay date in
-          # `YYYY-MM-DD` format.
-          sig { returns(T.nilable(Date)) }
-          attr_reader :end_date
-
-          sig { params(end_date: Date).void }
-          attr_writer :end_date
-
-          # The entity IDs to specify which entities' data to access.
-          sig { returns(T.nilable(T::Array[String])) }
-          attr_reader :entity_ids
-
-          sig { params(entity_ids: T::Array[String]).void }
-          attr_writer :entity_ids
-
-          # Case-insensitive partial match search by pay statement item name.
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
-
-          sig { params(name: String).void }
-          attr_writer :name
-
-          # The start date to retrieve pay statement items by via their last seen pay date
-          # (inclusive) in `YYYY-MM-DD` format.
-          sig { returns(T.nilable(Date)) }
-          attr_reader :start_date
-
-          sig { params(start_date: Date).void }
-          attr_writer :start_date
-
-          # String search by pay statement item type.
-          sig { returns(T.nilable(String)) }
-          attr_reader :type
-
-          sig { params(type: String).void }
-          attr_writer :type
-
-          sig do
-            params(
-              categories:
-                T::Array[
-                  FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol
-                ],
-              end_date: Date,
-              entity_ids: T::Array[String],
-              name: String,
-              start_date: Date,
-              type: String,
-              request_options: FinchAPI::RequestOptions::OrHash
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Comma-delimited list of pay statement item categories to filter on. If empty,
-            # defaults to all categories.
-            categories: nil,
-            # The end date to retrieve pay statement items by via their last seen pay date in
-            # `YYYY-MM-DD` format.
-            end_date: nil,
-            # The entity IDs to specify which entities' data to access.
-            entity_ids: nil,
-            # Case-insensitive partial match search by pay statement item name.
-            name: nil,
-            # The start date to retrieve pay statement items by via their last seen pay date
-            # (inclusive) in `YYYY-MM-DD` format.
-            start_date: nil,
-            # String search by pay statement item type.
-            type: nil,
-            request_options: {}
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                categories:
-                  T::Array[
-                    FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol
-                  ],
-                end_date: Date,
-                entity_ids: T::Array[String],
-                name: String,
-                start_date: Date,
-                type: String,
-                request_options: FinchAPI::RequestOptions
-              }
-            )
-          end
-          def to_hash
-          end
-
-          module Category
-            extend FinchAPI::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  FinchAPI::HRIS::Company::PayStatementItemListParams::Category
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            EARNINGS =
-              T.let(
-                :earnings,
-                FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol
-              )
-            TAXES =
-              T.let(
-                :taxes,
-                FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol
-              )
-            EMPLOYEE_DEDUCTIONS =
-              T.let(
-                :employee_deductions,
-                FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol
-              )
-            EMPLOYER_CONTRIBUTIONS =
-              T.let(
-                :employer_contributions,
-                FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  FinchAPI::HRIS::Company::PayStatementItemListParams::Category::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/finch_api/models/hris/company/pay_statement_item_list_response.rbi

@@ -1,191 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Company
-        class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse,
-                FinchAPI::Internal::AnyHash
-              )
-            end
-
-          # The attributes of the pay statement item.
-          sig do
-            returns(
-              FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes
-            )
-          end
-          attr_reader :attributes
-
-          sig do
-            params(
-              attributes:
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes::OrHash
-            ).void
-          end
-          attr_writer :attributes
-
-          # The category of the pay statement item.
-          sig do
-            returns(
-              FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
-            )
-          end
-          attr_accessor :category
-
-          # The name of the pay statement item.
-          sig { returns(String) }
-          attr_accessor :name
-
-          sig do
-            params(
-              attributes:
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes::OrHash,
-              category:
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::OrSymbol,
-              name: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The attributes of the pay statement item.
-            attributes:,
-            # The category of the pay statement item.
-            category:,
-            # The name of the pay statement item.
-            name:
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                attributes:
-                  FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes,
-                category:
-                  FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol,
-                name: String
-              }
-            )
-          end
-          def to_hash
-          end
-
-          class Attributes < FinchAPI::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes,
-                  FinchAPI::Internal::AnyHash
-                )
-              end
-
-            # The metadata of the pay statement item derived by the rules engine if available.
-            # Each attribute will be a key-value pair defined by a rule.
-            sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
-            attr_accessor :metadata
-
-            # `true` if the amount is paid by the employers. This field is only available for
-            # taxes.
-            sig { returns(T.nilable(T::Boolean)) }
-            attr_accessor :employer
-
-            # `true` if the pay statement item is pre-tax. This field is only available for
-            # employee deductions.
-            sig { returns(T.nilable(T::Boolean)) }
-            attr_accessor :pre_tax
-
-            # The type of the pay statement item.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :type
-
-            # The attributes of the pay statement item.
-            sig do
-              params(
-                metadata: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
-                employer: T.nilable(T::Boolean),
-                pre_tax: T.nilable(T::Boolean),
-                type: T.nilable(String)
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              # The metadata of the pay statement item derived by the rules engine if available.
-              # Each attribute will be a key-value pair defined by a rule.
-              metadata:,
-              # `true` if the amount is paid by the employers. This field is only available for
-              # taxes.
-              employer: nil,
-              # `true` if the pay statement item is pre-tax. This field is only available for
-              # employee deductions.
-              pre_tax: nil,
-              # The type of the pay statement item.
-              type: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  metadata: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
-                  employer: T.nilable(T::Boolean),
-                  pre_tax: T.nilable(T::Boolean),
-                  type: T.nilable(String)
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-
-          # The category of the pay statement item.
-          module Category
-            extend FinchAPI::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            EARNINGS =
-              T.let(
-                :earnings,
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
-              )
-            TAXES =
-              T.let(
-                :taxes,
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
-              )
-            EMPLOYEE_DEDUCTIONS =
-              T.let(
-                :employee_deductions,
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
-              )
-            EMPLOYER_CONTRIBUTIONS =
-              T.let(
-                :employer_contributions,
-                FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-      end
-    end
-  end
-end