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

data/rbi/finch_api/models/hris/pay_statement_response.rbi

@@ -25,7 +25,7 @@ module FinchAPI
           params(
             body:
               T.any(
-                FinchAPI::HRIS::PayStatementResponseBody::OrHash,
+                FinchAPI::HRIS::PayStatementData::OrHash,
                 FinchAPI::HRIS::PayStatementResponse::Body::BatchError::OrHash,
                 FinchAPI::HRIS::PayStatementDataSyncInProgress::OrHash
               ),
@@ -54,7 +54,7 @@ module FinchAPI
           Variants =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::PayStatementResponseBody,
+                FinchAPI::HRIS::PayStatementData,
                 FinchAPI::HRIS::PayStatementResponse::Body::BatchError,
                 FinchAPI::HRIS::PayStatementDataSyncInProgress
               )

data/rbi/finch_api/resources/hris/company.rbi

@@ -4,9 +4,6 @@ module FinchAPI
   module Resources
     class HRIS
       class Company
-        sig { returns(FinchAPI::Resources::HRIS::Company::PayStatementItem) }
-        attr_reader :pay_statement_item
-
         # Read basic company data
         sig do
           params(

data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class HRIS
+      class PayStatementItem
+        class Rules
+          # Custom rules can be created to associate specific attributes to pay statement
+          # items depending on the use case. For example, pay statement items that meet
+          # certain conditions can be labeled as a pre-tax 401k. This metadata can be
+          # retrieved where pay statement item information is available.
+          sig do
+            params(
+              entity_ids: T::Array[String],
+              attributes:
+                FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Attributes::OrHash,
+              conditions:
+                T::Array[
+                  FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition::OrHash
+                ],
+              effective_end_date: T.nilable(String),
+              effective_start_date: T.nilable(String),
+              entity_type:
+                FinchAPI::HRIS::PayStatementItem::RuleCreateParams::EntityType::OrSymbol,
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(
+              FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse
+            )
+          end
+          def create(
+            # Query param: The entity IDs to create the rule for.
+            entity_ids: nil,
+            # Body param: Specifies the fields to be applied when the condition is met.
+            attributes: nil,
+            # Body param
+            conditions: nil,
+            # Body param: Specifies when the rules should stop applying rules based on the
+            # date.
+            effective_end_date: nil,
+            # Body param: Specifies when the rule should begin applying based on the date.
+            effective_start_date: nil,
+            # Body param: The entity type to which the rule is applied.
+            entity_type: nil,
+            request_options: {}
+          )
+          end
+
+          # Update a rule for a pay statement item.
+          sig do
+            params(
+              rule_id: String,
+              entity_ids: T::Array[String],
+              optional_property: T.anything,
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(
+              FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse
+            )
+          end
+          def update(
+            # Path param
+            rule_id,
+            # Query param: The entity IDs to update the rule for.
+            entity_ids: nil,
+            # Body param
+            optional_property: nil,
+            request_options: {}
+          )
+          end
+
+          # List all rules of a connection account.
+          sig do
+            params(
+              entity_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(
+              FinchAPI::Internal::ResponsesPage[
+                FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse
+              ]
+            )
+          end
+          def list(
+            # The entity IDs to retrieve rules for.
+            entity_ids: nil,
+            request_options: {}
+          )
+          end
+
+          # Delete a rule for a pay statement item.
+          sig do
+            params(
+              rule_id: String,
+              entity_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions::OrHash
+            ).returns(
+              FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse
+            )
+          end
+          def delete(
+            rule_id,
+            # The entity IDs to delete the rule for.
+            entity_ids: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/hris/pay_statement_item.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module FinchAPI
+  module Resources
+    class HRIS
+      class PayStatementItem
+        sig { returns(FinchAPI::Resources::HRIS::PayStatementItem::Rules) }
+        attr_reader :rules
+
+        # Retrieve a list of detailed pay statement items for the access token's
+        # connection account.
+        sig do
+          params(
+            categories:
+              T::Array[
+                FinchAPI::HRIS::PayStatementItemListParams::Category::OrSymbol
+              ],
+            end_date: Date,
+            entity_ids: T::Array[String],
+            name: String,
+            start_date: Date,
+            type: String,
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(
+            FinchAPI::Internal::ResponsesPage[
+              FinchAPI::Models::HRIS::PayStatementItemListResponse
+            ]
+          )
+        end
+        def list(
+          # 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
+
+        # @api private
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/resources/hris.rbi

@@ -6,6 +6,9 @@ module FinchAPI
       sig { returns(FinchAPI::Resources::HRIS::Company) }
       attr_reader :company
 
+      sig { returns(FinchAPI::Resources::HRIS::PayStatementItem) }
+      attr_reader :pay_statement_item
+
       sig { returns(FinchAPI::Resources::HRIS::Directory) }
       attr_reader :directory
 

data/sig/finch_api/models/hris/{pay_statement_response_body.rbs → pay_statement_data.rbs}

@@ -1,24 +1,24 @@
 module FinchAPI
   module Models
     module HRIS
-      type pay_statement_response_body =
+      type pay_statement_data =
         {
-          paging: FinchAPI::HRIS::PayStatementResponseBody::Paging,
+          paging: FinchAPI::HRIS::PayStatementData::Paging,
           pay_statements: ::Array[FinchAPI::HRIS::PayStatement]
         }
 
-      class PayStatementResponseBody < FinchAPI::Internal::Type::BaseModel
-        attr_accessor paging: FinchAPI::HRIS::PayStatementResponseBody::Paging
+      class PayStatementData < FinchAPI::Internal::Type::BaseModel
+        attr_accessor paging: FinchAPI::HRIS::PayStatementData::Paging
 
         attr_accessor pay_statements: ::Array[FinchAPI::HRIS::PayStatement]
 
         def initialize: (
-          paging: FinchAPI::HRIS::PayStatementResponseBody::Paging,
+          paging: FinchAPI::HRIS::PayStatementData::Paging,
           pay_statements: ::Array[FinchAPI::HRIS::PayStatement]
         ) -> void
 
         def to_hash: -> {
-          paging: FinchAPI::HRIS::PayStatementResponseBody::Paging,
+          paging: FinchAPI::HRIS::PayStatementData::Paging,
           pay_statements: ::Array[FinchAPI::HRIS::PayStatement]
         }
 

data/sig/finch_api/models/hris/pay_statement_item/rule_create_params.rbs

@@ -0,0 +1,136 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        type rule_create_params =
+          {
+            entity_ids: ::Array[String],
+            attributes: FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Attributes,
+            conditions: ::Array[FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition],
+            effective_end_date: String?,
+            effective_start_date: String?,
+            entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::entity_type
+          }
+          & FinchAPI::Internal::Type::request_parameters
+
+        class RuleCreateParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          attr_reader entity_ids: ::Array[String]?
+
+          def entity_ids=: (::Array[String]) -> ::Array[String]
+
+          attr_reader attributes: FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Attributes?
+
+          def attributes=: (
+            FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Attributes
+          ) -> FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Attributes
+
+          attr_reader conditions: ::Array[FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition]?
+
+          def conditions=: (
+            ::Array[FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition]
+          ) -> ::Array[FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition]
+
+          attr_accessor effective_end_date: String?
+
+          attr_accessor effective_start_date: String?
+
+          attr_reader entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::entity_type?
+
+          def entity_type=: (
+            FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::entity_type
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::entity_type
+
+          def initialize: (
+            ?entity_ids: ::Array[String],
+            ?attributes: FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Attributes,
+            ?conditions: ::Array[FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition],
+            ?effective_end_date: String?,
+            ?effective_start_date: String?,
+            ?entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::entity_type,
+            ?request_options: FinchAPI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            entity_ids: ::Array[String],
+            attributes: FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Attributes,
+            conditions: ::Array[FinchAPI::HRIS::PayStatementItem::RuleCreateParams::Condition],
+            effective_end_date: String?,
+            effective_start_date: String?,
+            entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::entity_type,
+            request_options: FinchAPI::RequestOptions
+          }
+
+          type attributes = { metadata: ::Hash[Symbol, top] }
+
+          class Attributes < FinchAPI::Internal::Type::BaseModel
+            attr_reader metadata: ::Hash[Symbol, top]?
+
+            def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+            def initialize: (?metadata: ::Hash[Symbol, top]) -> void
+
+            def to_hash: -> { metadata: ::Hash[Symbol, top] }
+          end
+
+          type condition =
+            {
+              field: String,
+              operator: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::operator,
+              value: String
+            }
+
+          class Condition < FinchAPI::Internal::Type::BaseModel
+            attr_reader field: String?
+
+            def field=: (String) -> String
+
+            attr_reader operator: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::operator?
+
+            def operator=: (
+              FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::operator
+            ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::operator
+
+            attr_reader value: String?
+
+            def value=: (String) -> String
+
+            def initialize: (
+              ?field: String,
+              ?operator: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::operator,
+              ?value: String
+            ) -> void
+
+            def to_hash: -> {
+              field: String,
+              operator: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::operator,
+              value: String
+            }
+
+            type operator = :equals
+
+            module Operator
+              extend FinchAPI::Internal::Type::Enum
+
+              EQUALS: :equals
+
+              def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Condition::operator]
+            end
+          end
+
+          type entity_type = :pay_statement_item
+
+          module EntityType
+            extend FinchAPI::Internal::Type::Enum
+
+            PAY_STATEMENT_ITEM: :pay_statement_item
+
+            def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::entity_type]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/pay_statement_item/rule_create_response.rbs

@@ -0,0 +1,151 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        type rule_create_response =
+          {
+            id: String,
+            attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes,
+            conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition],
+            created_at: Time,
+            effective_end_date: String?,
+            effective_start_date: String?,
+            entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::entity_type,
+            priority: Integer,
+            updated_at: Time
+          }
+
+        class RuleCreateResponse < FinchAPI::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          attr_reader attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes?
+
+          def attributes=: (
+            FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes
+
+          attr_reader conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition]?
+
+          def conditions=: (
+            ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition]
+          ) -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition]
+
+          attr_reader created_at: Time?
+
+          def created_at=: (Time) -> Time
+
+          attr_accessor effective_end_date: String?
+
+          attr_accessor effective_start_date: String?
+
+          attr_reader entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::entity_type?
+
+          def entity_type=: (
+            FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::entity_type
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::entity_type
+
+          attr_reader priority: Integer?
+
+          def priority=: (Integer) -> Integer
+
+          attr_reader updated_at: Time?
+
+          def updated_at=: (Time) -> Time
+
+          def initialize: (
+            ?id: String,
+            ?attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes,
+            ?conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition],
+            ?created_at: Time,
+            ?effective_end_date: String?,
+            ?effective_start_date: String?,
+            ?entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::entity_type,
+            ?priority: Integer,
+            ?updated_at: Time
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Attributes,
+            conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition],
+            created_at: Time,
+            effective_end_date: String?,
+            effective_start_date: String?,
+            entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::entity_type,
+            priority: Integer,
+            updated_at: Time
+          }
+
+          type attributes = { metadata: ::Hash[Symbol, top] }
+
+          class Attributes < FinchAPI::Internal::Type::BaseModel
+            attr_reader metadata: ::Hash[Symbol, top]?
+
+            def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+            def initialize: (?metadata: ::Hash[Symbol, top]) -> void
+
+            def to_hash: -> { metadata: ::Hash[Symbol, top] }
+          end
+
+          type condition =
+            {
+              field: String,
+              operator: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::operator,
+              value: String
+            }
+
+          class Condition < FinchAPI::Internal::Type::BaseModel
+            attr_reader field: String?
+
+            def field=: (String) -> String
+
+            attr_reader operator: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::operator?
+
+            def operator=: (
+              FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::operator
+            ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::operator
+
+            attr_reader value: String?
+
+            def value=: (String) -> String
+
+            def initialize: (
+              ?field: String,
+              ?operator: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::operator,
+              ?value: String
+            ) -> void
+
+            def to_hash: -> {
+              field: String,
+              operator: FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::operator,
+              value: String
+            }
+
+            type operator = :equals
+
+            module Operator
+              extend FinchAPI::Internal::Type::Enum
+
+              EQUALS: :equals
+
+              def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::Condition::operator]
+            end
+          end
+
+          type entity_type = :pay_statement_item
+
+          module EntityType
+            extend FinchAPI::Internal::Type::Enum
+
+            PAY_STATEMENT_ITEM: :pay_statement_item
+
+            def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse::entity_type]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/pay_statement_item/rule_delete_params.rbs

@@ -0,0 +1,34 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        type rule_delete_params =
+          { rule_id: String, entity_ids: ::Array[String] }
+          & FinchAPI::Internal::Type::request_parameters
+
+        class RuleDeleteParams < FinchAPI::Internal::Type::BaseModel
+          extend FinchAPI::Internal::Type::RequestParameters::Converter
+          include FinchAPI::Internal::Type::RequestParameters
+
+          attr_accessor rule_id: String
+
+          attr_reader entity_ids: ::Array[String]?
+
+          def entity_ids=: (::Array[String]) -> ::Array[String]
+
+          def initialize: (
+            rule_id: String,
+            ?entity_ids: ::Array[String],
+            ?request_options: FinchAPI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            rule_id: String,
+            entity_ids: ::Array[String],
+            request_options: FinchAPI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end