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

data/lib/finch_api/models/hris/pay_statement_item/rule_list_response.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        # @see FinchAPI::Resources::HRIS::PayStatementItem::Rules#list
+        class RuleListResponse < FinchAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Finch id (uuidv4) for the rule.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute attributes
+          #   Specifies the fields to be applied when the condition is met.
+          #
+          #   @return [FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes, nil]
+          optional :attributes, -> { FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes }
+
+          # @!attribute conditions
+          #
+          #   @return [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition>, nil]
+          optional :conditions,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition] }
+
+          # @!attribute created_at
+          #   The datetime when the rule was created.
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute effective_end_date
+          #   Specifies when the rules should stop applying rules based on the date.
+          #
+          #   @return [String, nil]
+          optional :effective_end_date, String, nil?: true
+
+          # @!attribute effective_start_date
+          #   Specifies when the rule should begin applying based on the date.
+          #
+          #   @return [String, nil]
+          optional :effective_start_date, String, nil?: true
+
+          # @!attribute entity_type
+          #   The entity type to which the rule is applied.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::EntityType, nil]
+          optional :entity_type, enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::EntityType }
+
+          # @!attribute priority
+          #   The priority of the rule.
+          #
+          #   @return [Integer, nil]
+          optional :priority, Integer
+
+          # @!attribute updated_at
+          #   The datetime when the rule was last updated.
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(id: nil, attributes: nil, conditions: nil, created_at: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, priority: nil, updated_at: nil)
+          #   @param id [String] Finch id (uuidv4) for the rule.
+          #
+          #   @param attributes [FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes] Specifies the fields to be applied when the condition is met.
+          #
+          #   @param conditions [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition>]
+          #
+          #   @param created_at [Time] The datetime when the rule was created.
+          #
+          #   @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
+          #
+          #   @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
+          #
+          #   @param entity_type [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::EntityType] The entity type to which the rule is applied.
+          #
+          #   @param priority [Integer] The priority of the rule.
+          #
+          #   @param updated_at [Time] The datetime when the rule was last updated.
+
+          # @see FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse#attributes
+          class Attributes < FinchAPI::Internal::Type::BaseModel
+            # @!attribute metadata
+            #   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.).
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+            # @!method initialize(metadata: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes} for
+            #   more details.
+            #
+            #   Specifies the fields to be applied when the condition is met.
+            #
+            #   @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
+          end
+
+          class Condition < FinchAPI::Internal::Type::BaseModel
+            # @!attribute field
+            #   The field to be checked in the rule.
+            #
+            #   @return [String, nil]
+            optional :field, String
+
+            # @!attribute operator
+            #   The operator to be used in the rule.
+            #
+            #   @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition::Operator, nil]
+            optional :operator,
+                     enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition::Operator }
+
+            # @!attribute value
+            #   The value of the field to be checked in the rule.
+            #
+            #   @return [String, nil]
+            optional :value, String
+
+            # @!method initialize(field: nil, operator: nil, value: nil)
+            #   @param field [String] The field to be checked in the rule.
+            #
+            #   @param operator [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition::Operator] The operator to be used in the rule.
+            #
+            #   @param value [String] The value of the field to be checked in the rule.
+
+            # The operator to be used in the rule.
+            #
+            # @see FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition#operator
+            module Operator
+              extend FinchAPI::Internal::Type::Enum
+
+              EQUALS = :equals
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # The entity type to which the rule is applied.
+          #
+          # @see FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse#entity_type
+          module EntityType
+            extend FinchAPI::Internal::Type::Enum
+
+            PAY_STATEMENT_ITEM = :pay_statement_item
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        # @see FinchAPI::Resources::HRIS::PayStatementItem::Rules#update
+        class RuleUpdateParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          # @!attribute rule_id
+          #
+          #   @return [String]
+          required :rule_id, String
+
+          # @!attribute entity_ids
+          #   The entity IDs to update the rule for.
+          #
+          #   @return [Array<String>, nil]
+          optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+          # @!attribute optional_property
+          #
+          #   @return [Object, nil]
+          optional :optional_property, FinchAPI::Internal::Type::Unknown, api_name: :optionalProperty
+
+          # @!method initialize(rule_id:, entity_ids: nil, optional_property: nil, request_options: {})
+          #   @param rule_id [String]
+          #
+          #   @param entity_ids [Array<String>] The entity IDs to update the rule for.
+          #
+          #   @param optional_property [Object]
+          #
+          #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/pay_statement_item/rule_update_response.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        # @see FinchAPI::Resources::HRIS::PayStatementItem::Rules#update
+        class RuleUpdateResponse < FinchAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Finch id (uuidv4) for the rule.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute attributes
+          #   Specifies the fields to be applied when the condition is met.
+          #
+          #   @return [FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes, nil]
+          optional :attributes, -> { FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes }
+
+          # @!attribute conditions
+          #
+          #   @return [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition>, nil]
+          optional :conditions,
+                   -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition] }
+
+          # @!attribute created_at
+          #   The datetime when the rule was created.
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute effective_end_date
+          #   Specifies when the rules should stop applying rules based on the date.
+          #
+          #   @return [String, nil]
+          optional :effective_end_date, String, nil?: true
+
+          # @!attribute effective_start_date
+          #   Specifies when the rule should begin applying based on the date.
+          #
+          #   @return [String, nil]
+          optional :effective_start_date, String, nil?: true
+
+          # @!attribute entity_type
+          #   The entity type to which the rule is applied.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::EntityType, nil]
+          optional :entity_type,
+                   enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::EntityType }
+
+          # @!attribute priority
+          #   The priority of the rule.
+          #
+          #   @return [Integer, nil]
+          optional :priority, Integer
+
+          # @!attribute updated_at
+          #   The datetime when the rule was last updated.
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(id: nil, attributes: nil, conditions: nil, created_at: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, priority: nil, updated_at: nil)
+          #   @param id [String] Finch id (uuidv4) for the rule.
+          #
+          #   @param attributes [FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes] Specifies the fields to be applied when the condition is met.
+          #
+          #   @param conditions [Array<FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition>]
+          #
+          #   @param created_at [Time] The datetime when the rule was created.
+          #
+          #   @param effective_end_date [String, nil] Specifies when the rules should stop applying rules based on the date.
+          #
+          #   @param effective_start_date [String, nil] Specifies when the rule should begin applying based on the date.
+          #
+          #   @param entity_type [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::EntityType] The entity type to which the rule is applied.
+          #
+          #   @param priority [Integer] The priority of the rule.
+          #
+          #   @param updated_at [Time] The datetime when the rule was last updated.
+
+          # @see FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse#attributes
+          class Attributes < FinchAPI::Internal::Type::BaseModel
+            # @!attribute metadata
+            #   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.).
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :metadata, FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown]
+
+            # @!method initialize(metadata: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes} for
+            #   more details.
+            #
+            #   Specifies the fields to be applied when the condition is met.
+            #
+            #   @param metadata [Hash{Symbol=>Object}] The metadata to be attached in the entity. It is a key-value pairs where the val
+          end
+
+          class Condition < FinchAPI::Internal::Type::BaseModel
+            # @!attribute field
+            #   The field to be checked in the rule.
+            #
+            #   @return [String, nil]
+            optional :field, String
+
+            # @!attribute operator
+            #   The operator to be used in the rule.
+            #
+            #   @return [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition::Operator, nil]
+            optional :operator,
+                     enum: -> { FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition::Operator }
+
+            # @!attribute value
+            #   The value of the field to be checked in the rule.
+            #
+            #   @return [String, nil]
+            optional :value, String
+
+            # @!method initialize(field: nil, operator: nil, value: nil)
+            #   @param field [String] The field to be checked in the rule.
+            #
+            #   @param operator [Symbol, FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition::Operator] The operator to be used in the rule.
+            #
+            #   @param value [String] The value of the field to be checked in the rule.
+
+            # The operator to be used in the rule.
+            #
+            # @see FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition#operator
+            module Operator
+              extend FinchAPI::Internal::Type::Enum
+
+              EQUALS = :equals
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # The entity type to which the rule is applied.
+          #
+          # @see FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse#entity_type
+          module EntityType
+            extend FinchAPI::Internal::Type::Enum
+
+            PAY_STATEMENT_ITEM = :pay_statement_item
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/pay_statement_item_list_params.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::PayStatementItem#list
+      class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        # @!attribute categories
+        #   Comma-delimited list of pay statement item categories to filter on. If empty,
+        #   defaults to all categories.
+        #
+        #   @return [Array<Symbol, FinchAPI::Models::HRIS::PayStatementItemListParams::Category>, nil]
+        optional :categories,
+                 -> { FinchAPI::Internal::Type::ArrayOf[enum: FinchAPI::HRIS::PayStatementItemListParams::Category] }
+
+        # @!attribute end_date
+        #   The end date to retrieve pay statement items by via their last seen pay date in
+        #   `YYYY-MM-DD` format.
+        #
+        #   @return [Date, nil]
+        optional :end_date, Date
+
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!attribute name
+        #   Case-insensitive partial match search by pay statement item name.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute start_date
+        #   The start date to retrieve pay statement items by via their last seen pay date
+        #   (inclusive) in `YYYY-MM-DD` format.
+        #
+        #   @return [Date, nil]
+        optional :start_date, Date
+
+        # @!attribute type
+        #   String search by pay statement item type.
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!method initialize(categories: nil, end_date: nil, entity_ids: nil, name: nil, start_date: nil, type: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::PayStatementItemListParams} for more details.
+        #
+        #   @param categories [Array<Symbol, FinchAPI::Models::HRIS::PayStatementItemListParams::Category>] Comma-delimited list of pay statement item categories to filter on. If empty, de
+        #
+        #   @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
+        #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
+        #   @param name [String] Case-insensitive partial match search by pay statement item name.
+        #
+        #   @param start_date [Date] The start date to retrieve pay statement items by via their last seen pay date (
+        #
+        #   @param type [String] String search by pay statement item type.
+        #
+        #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+
+        module Category
+          extend FinchAPI::Internal::Type::Enum
+
+          EARNINGS = :earnings
+          TAXES = :taxes
+          EMPLOYEE_DEDUCTIONS = :employee_deductions
+          EMPLOYER_CONTRIBUTIONS = :employer_contributions
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/models/hris/pay_statement_item_list_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    module HRIS
+      # @see FinchAPI::Resources::HRIS::PayStatementItem#list
+      class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
+        # @!attribute attributes
+        #   The attributes of the pay statement item.
+        #
+        #   @return [FinchAPI::Models::HRIS::PayStatementItemListResponse::Attributes]
+        required :attributes, -> { FinchAPI::Models::HRIS::PayStatementItemListResponse::Attributes }
+
+        # @!attribute category
+        #   The category of the pay statement item.
+        #
+        #   @return [Symbol, FinchAPI::Models::HRIS::PayStatementItemListResponse::Category]
+        required :category, enum: -> { FinchAPI::Models::HRIS::PayStatementItemListResponse::Category }
+
+        # @!attribute name
+        #   The name of the pay statement item.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(attributes:, category:, name:)
+        #   @param attributes [FinchAPI::Models::HRIS::PayStatementItemListResponse::Attributes] The attributes of the pay statement item.
+        #
+        #   @param category [Symbol, FinchAPI::Models::HRIS::PayStatementItemListResponse::Category] The category of the pay statement item.
+        #
+        #   @param name [String] The name of the pay statement item.
+
+        # @see FinchAPI::Models::HRIS::PayStatementItemListResponse#attributes
+        class Attributes < FinchAPI::Internal::Type::BaseModel
+          # @!attribute metadata
+          #   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.
+          #
+          #   @return [Hash{Symbol=>Object, nil}, nil]
+          required :metadata,
+                   FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
+                   nil?: true
+
+          # @!attribute employer
+          #   `true` if the amount is paid by the employers. This field is only available for
+          #   taxes.
+          #
+          #   @return [Boolean, nil]
+          optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true
+
+          # @!attribute pre_tax
+          #   `true` if the pay statement item is pre-tax. This field is only available for
+          #   employee deductions.
+          #
+          #   @return [Boolean, nil]
+          optional :pre_tax, FinchAPI::Internal::Type::Boolean, nil?: true
+
+          # @!attribute type
+          #   The type of the pay statement item.
+          #
+          #   @return [String, nil]
+          optional :type, String, nil?: true
+
+          # @!method initialize(metadata:, employer: nil, pre_tax: nil, type: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::PayStatementItemListResponse::Attributes} for more
+          #   details.
+          #
+          #   The attributes of the pay statement item.
+          #
+          #   @param metadata [Hash{Symbol=>Object, nil}, nil] The metadata of the pay statement item derived by the rules engine if available.
+          #
+          #   @param employer [Boolean, nil] `true` if the amount is paid by the employers. This field is only available for
+          #
+          #   @param pre_tax [Boolean, nil] `true` if the pay statement item is pre-tax. This field is only available for em
+          #
+          #   @param type [String, nil] The type of the pay statement item.
+        end
+
+        # The category of the pay statement item.
+        #
+        # @see FinchAPI::Models::HRIS::PayStatementItemListResponse#category
+        module Category
+          extend FinchAPI::Internal::Type::Enum
+
+          EARNINGS = :earnings
+          TAXES = :taxes
+          EMPLOYEE_DEDUCTIONS = :employee_deductions
+          EMPLOYER_CONTRIBUTIONS = :employer_contributions
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/resources/hris/company.rb

@@ -4,9 +4,6 @@ module FinchAPI
   module Resources
     class HRIS
       class Company
-        # @return [FinchAPI::Resources::HRIS::Company::PayStatementItem]
-        attr_reader :pay_statement_item
-
         # Read basic company data
         #
         # @overload retrieve(entity_ids: nil, request_options: {})
@@ -36,7 +33,6 @@ module FinchAPI
         # @param client [FinchAPI::Client]
         def initialize(client:)
           @client = client
-          @pay_statement_item = FinchAPI::Resources::HRIS::Company::PayStatementItem.new(client: client)
         end
       end
     end