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

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

@@ -0,0 +1,151 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        type rule_list_response =
+          {
+            id: String,
+            attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes,
+            conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition],
+            created_at: Time,
+            effective_end_date: String?,
+            effective_start_date: String?,
+            entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::entity_type,
+            priority: Integer,
+            updated_at: Time
+          }
+
+        class RuleListResponse < FinchAPI::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          attr_reader attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes?
+
+          def attributes=: (
+            FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes
+
+          attr_reader conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition]?
+
+          def conditions=: (
+            ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition]
+          ) -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::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::RuleListResponse::entity_type?
+
+          def entity_type=: (
+            FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::entity_type
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::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::RuleListResponse::Attributes,
+            ?conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition],
+            ?created_at: Time,
+            ?effective_end_date: String?,
+            ?effective_start_date: String?,
+            ?entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::entity_type,
+            ?priority: Integer,
+            ?updated_at: Time
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Attributes,
+            conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition],
+            created_at: Time,
+            effective_end_date: String?,
+            effective_start_date: String?,
+            entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::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::RuleListResponse::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::RuleListResponse::Condition::operator?
+
+            def operator=: (
+              FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition::operator
+            ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition::operator
+
+            attr_reader value: String?
+
+            def value=: (String) -> String
+
+            def initialize: (
+              ?field: String,
+              ?operator: FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition::operator,
+              ?value: String
+            ) -> void
+
+            def to_hash: -> {
+              field: String,
+              operator: FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::Condition::operator,
+              value: String
+            }
+
+            type operator = :equals
+
+            module Operator
+              extend FinchAPI::Internal::Type::Enum
+
+              EQUALS: :equals
+
+              def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse::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::RuleListResponse::entity_type]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        type rule_update_params =
+          {
+            rule_id: String,
+            entity_ids: ::Array[String],
+            optional_property: top
+          }
+          & FinchAPI::Internal::Type::request_parameters
+
+        class RuleUpdateParams < 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]
+
+          attr_reader optional_property: top?
+
+          def optional_property=: (top) -> top
+
+          def initialize: (
+            rule_id: String,
+            ?entity_ids: ::Array[String],
+            ?optional_property: top,
+            ?request_options: FinchAPI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            rule_id: String,
+            entity_ids: ::Array[String],
+            optional_property: top,
+            request_options: FinchAPI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+module FinchAPI
+  module Models
+    module HRIS
+      module PayStatementItem
+        type rule_update_response =
+          {
+            id: String,
+            attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes,
+            conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition],
+            created_at: Time,
+            effective_end_date: String?,
+            effective_start_date: String?,
+            entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::entity_type,
+            priority: Integer,
+            updated_at: Time
+          }
+
+        class RuleUpdateResponse < FinchAPI::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          attr_reader attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes?
+
+          def attributes=: (
+            FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes
+
+          attr_reader conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition]?
+
+          def conditions=: (
+            ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition]
+          ) -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::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::RuleUpdateResponse::entity_type?
+
+          def entity_type=: (
+            FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::entity_type
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::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::RuleUpdateResponse::Attributes,
+            ?conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition],
+            ?created_at: Time,
+            ?effective_end_date: String?,
+            ?effective_start_date: String?,
+            ?entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::entity_type,
+            ?priority: Integer,
+            ?updated_at: Time
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            attributes: FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Attributes,
+            conditions: ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition],
+            created_at: Time,
+            effective_end_date: String?,
+            effective_start_date: String?,
+            entity_type: FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::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::RuleUpdateResponse::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::RuleUpdateResponse::Condition::operator?
+
+            def operator=: (
+              FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition::operator
+            ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition::operator
+
+            attr_reader value: String?
+
+            def value=: (String) -> String
+
+            def initialize: (
+              ?field: String,
+              ?operator: FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition::operator,
+              ?value: String
+            ) -> void
+
+            def to_hash: -> {
+              field: String,
+              operator: FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::Condition::operator,
+              value: String
+            }
+
+            type operator = :equals
+
+            module Operator
+              extend FinchAPI::Internal::Type::Enum
+
+              EQUALS: :equals
+
+              def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse::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::RuleUpdateResponse::entity_type]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/pay_statement_item_list_params.rbs

@@ -0,0 +1,81 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type pay_statement_item_list_params =
+        {
+          categories: ::Array[FinchAPI::Models::HRIS::PayStatementItemListParams::category],
+          end_date: Date,
+          entity_ids: ::Array[String],
+          name: String,
+          start_date: Date,
+          type: String
+        }
+        & FinchAPI::Internal::Type::request_parameters
+
+      class PayStatementItemListParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        attr_reader categories: ::Array[FinchAPI::Models::HRIS::PayStatementItemListParams::category]?
+
+        def categories=: (
+          ::Array[FinchAPI::Models::HRIS::PayStatementItemListParams::category]
+        ) -> ::Array[FinchAPI::Models::HRIS::PayStatementItemListParams::category]
+
+        attr_reader end_date: Date?
+
+        def end_date=: (Date) -> Date
+
+        attr_reader entity_ids: ::Array[String]?
+
+        def entity_ids=: (::Array[String]) -> ::Array[String]
+
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_reader start_date: Date?
+
+        def start_date=: (Date) -> Date
+
+        attr_reader type: String?
+
+        def type=: (String) -> String
+
+        def initialize: (
+          ?categories: ::Array[FinchAPI::Models::HRIS::PayStatementItemListParams::category],
+          ?end_date: Date,
+          ?entity_ids: ::Array[String],
+          ?name: String,
+          ?start_date: Date,
+          ?type: String,
+          ?request_options: FinchAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          categories: ::Array[FinchAPI::Models::HRIS::PayStatementItemListParams::category],
+          end_date: Date,
+          entity_ids: ::Array[String],
+          name: String,
+          start_date: Date,
+          type: String,
+          request_options: FinchAPI::RequestOptions
+        }
+
+        type category =
+          :earnings | :taxes | :employee_deductions | :employer_contributions
+
+        module Category
+          extend FinchAPI::Internal::Type::Enum
+
+          EARNINGS: :earnings
+          TAXES: :taxes
+          EMPLOYEE_DEDUCTIONS: :employee_deductions
+          EMPLOYER_CONTRIBUTIONS: :employer_contributions
+
+          def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatementItemListParams::category]
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/models/hris/pay_statement_item_list_response.rbs

@@ -0,0 +1,78 @@
+module FinchAPI
+  module Models
+    module HRIS
+      type pay_statement_item_list_response =
+        {
+          attributes: FinchAPI::Models::HRIS::PayStatementItemListResponse::Attributes,
+          category: FinchAPI::Models::HRIS::PayStatementItemListResponse::category,
+          name: String
+        }
+
+      class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
+        attr_accessor attributes: FinchAPI::Models::HRIS::PayStatementItemListResponse::Attributes
+
+        attr_accessor category: FinchAPI::Models::HRIS::PayStatementItemListResponse::category
+
+        attr_accessor name: String
+
+        def initialize: (
+          attributes: FinchAPI::Models::HRIS::PayStatementItemListResponse::Attributes,
+          category: FinchAPI::Models::HRIS::PayStatementItemListResponse::category,
+          name: String
+        ) -> void
+
+        def to_hash: -> {
+          attributes: FinchAPI::Models::HRIS::PayStatementItemListResponse::Attributes,
+          category: FinchAPI::Models::HRIS::PayStatementItemListResponse::category,
+          name: String
+        }
+
+        type attributes =
+          {
+            metadata: ::Hash[Symbol, top?]?,
+            employer: bool?,
+            pre_tax: bool?,
+            type: String?
+          }
+
+        class Attributes < FinchAPI::Internal::Type::BaseModel
+          attr_accessor metadata: ::Hash[Symbol, top?]?
+
+          attr_accessor employer: bool?
+
+          attr_accessor pre_tax: bool?
+
+          attr_accessor type: String?
+
+          def initialize: (
+            metadata: ::Hash[Symbol, top?]?,
+            ?employer: bool?,
+            ?pre_tax: bool?,
+            ?type: String?
+          ) -> void
+
+          def to_hash: -> {
+            metadata: ::Hash[Symbol, top?]?,
+            employer: bool?,
+            pre_tax: bool?,
+            type: String?
+          }
+        end
+
+        type category =
+          :earnings | :taxes | :employee_deductions | :employer_contributions
+
+        module Category
+          extend FinchAPI::Internal::Type::Enum
+
+          EARNINGS: :earnings
+          TAXES: :taxes
+          EMPLOYEE_DEDUCTIONS: :employee_deductions
+          EMPLOYER_CONTRIBUTIONS: :employer_contributions
+
+          def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatementItemListResponse::category]
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/resources/hris/company.rbs

@@ -2,8 +2,6 @@ module FinchAPI
   module Resources
     class HRIS
       class Company
-        attr_reader pay_statement_item: FinchAPI::Resources::HRIS::Company::PayStatementItem
-
         def retrieve: (
           ?entity_ids: ::Array[String],
           ?request_options: FinchAPI::request_opts

data/sig/finch_api/resources/hris/pay_statement_item/rules.rbs

@@ -0,0 +1,39 @@
+module FinchAPI
+  module Resources
+    class HRIS
+      class PayStatementItem
+        class Rules
+          def create: (
+            ?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
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleCreateResponse
+
+          def update: (
+            String rule_id,
+            ?entity_ids: ::Array[String],
+            ?optional_property: top,
+            ?request_options: FinchAPI::request_opts
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateResponse
+
+          def list: (
+            ?entity_ids: ::Array[String],
+            ?request_options: FinchAPI::request_opts
+          ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::PayStatementItem::RuleListResponse]
+
+          def delete: (
+            String rule_id,
+            ?entity_ids: ::Array[String],
+            ?request_options: FinchAPI::request_opts
+          ) -> FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteResponse
+
+          def initialize: (client: FinchAPI::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/finch_api/resources/hris/pay_statement_item.rbs

@@ -0,0 +1,21 @@
+module FinchAPI
+  module Resources
+    class HRIS
+      class PayStatementItem
+        attr_reader rules: FinchAPI::Resources::HRIS::PayStatementItem::Rules
+
+        def list: (
+          ?categories: ::Array[FinchAPI::Models::HRIS::PayStatementItemListParams::category],
+          ?end_date: Date,
+          ?entity_ids: ::Array[String],
+          ?name: String,
+          ?start_date: Date,
+          ?type: String,
+          ?request_options: FinchAPI::request_opts
+        ) -> FinchAPI::Internal::ResponsesPage[FinchAPI::Models::HRIS::PayStatementItemListResponse]
+
+        def initialize: (client: FinchAPI::Client) -> void
+      end
+    end
+  end
+end

data/sig/finch_api/resources/hris.rbs

@@ -3,6 +3,8 @@ module FinchAPI
     class HRIS
       attr_reader company: FinchAPI::Resources::HRIS::Company
 
+      attr_reader pay_statement_item: FinchAPI::Resources::HRIS::PayStatementItem
+
       attr_reader directory: FinchAPI::Resources::HRIS::Directory
 
       attr_reader individuals: FinchAPI::Resources::HRIS::Individuals