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

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

@@ -1,144 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class HRIS
-      class Company
-        class PayStatementItem
-          class Rules
-            # Some parameter documentations has been truncated, see
-            # {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams} for more
-            # details.
-            #
-            # 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.
-            #
-            # @overload create(entity_ids: nil, attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
-            #
-            # @param entity_ids [Array<String>] Query param: The entity IDs to create the rule for.
-            #
-            # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Body param: Specifies the fields to be applied when the condition is met.
-            #
-            # @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>] Body param
-            #
-            # @param effective_end_date [String, nil] Body param: Specifies when the rules should stop applying rules based on the dat
-            #
-            # @param effective_start_date [String, nil] Body param: Specifies when the rule should begin applying based on the date.
-            #
-            # @param entity_type [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType] Body param: The entity type to which the rule is applied.
-            #
-            # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
-            #
-            # @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse]
-            #
-            # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams
-            def create(params = {})
-              query_params = [:entity_ids]
-              parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams.dump_request(params)
-              query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
-              @client.request(
-                method: :post,
-                path: "employer/pay-statement-item/rule",
-                query: query,
-                body: parsed.except(*query_params),
-                model: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateResponse,
-                security: {bearer_auth: true},
-                options: options
-              )
-            end
-
-            # Update a rule for a pay statement item.
-            #
-            # @overload update(rule_id, entity_ids: nil, optional_property: nil, request_options: {})
-            #
-            # @param rule_id [String] Path param
-            #
-            # @param entity_ids [Array<String>] Query param: The entity IDs to update the rule for.
-            #
-            # @param optional_property [Object] Body param
-            #
-            # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
-            #
-            # @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse]
-            #
-            # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateParams
-            def update(rule_id, params = {})
-              query_params = [:entity_ids]
-              parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleUpdateParams.dump_request(params)
-              query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
-              @client.request(
-                method: :put,
-                path: ["employer/pay-statement-item/rule/%1$s", rule_id],
-                query: query,
-                body: parsed.except(*query_params),
-                model: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse,
-                security: {bearer_auth: true},
-                options: options
-              )
-            end
-
-            # List all rules of a connection account.
-            #
-            # @overload list(entity_ids: nil, request_options: {})
-            #
-            # @param entity_ids [Array<String>] The entity IDs to retrieve rules for.
-            #
-            # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
-            #
-            # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse>]
-            #
-            # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListParams
-            def list(params = {})
-              parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleListParams.dump_request(params)
-              query = FinchAPI::Internal::Util.encode_query_params(parsed)
-              @client.request(
-                method: :get,
-                path: "employer/pay-statement-item/rule",
-                query: query,
-                page: FinchAPI::Internal::ResponsesPage,
-                model: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse,
-                security: {bearer_auth: true},
-                options: options
-              )
-            end
-
-            # Delete a rule for a pay statement item.
-            #
-            # @overload delete(rule_id, entity_ids: nil, request_options: {})
-            #
-            # @param rule_id [String]
-            #
-            # @param entity_ids [Array<String>] The entity IDs to delete the rule for.
-            #
-            # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
-            #
-            # @return [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse]
-            #
-            # @see FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteParams
-            def delete(rule_id, params = {})
-              parsed, options = FinchAPI::HRIS::Company::PayStatementItem::RuleDeleteParams.dump_request(params)
-              query = FinchAPI::Internal::Util.encode_query_params(parsed)
-              @client.request(
-                method: :delete,
-                path: ["employer/pay-statement-item/rule/%1$s", rule_id],
-                query: query,
-                model: FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse,
-                security: {bearer_auth: true},
-                options: options
-              )
-            end
-
-            # @api private
-            #
-            # @param client [FinchAPI::Client]
-            def initialize(client:)
-              @client = client
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class HRIS
-      class Company
-        class PayStatementItem
-          # @return [FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules]
-          attr_reader :rules
-
-          # Some parameter documentations has been truncated, see
-          # {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details.
-          #
-          # Retrieve a list of detailed pay statement items for the access token's
-          # connection account.
-          #
-          # @overload list(categories: nil, end_date: nil, entity_ids: nil, name: nil, start_date: nil, type: nil, request_options: {})
-          #
-          # @param categories [Array<Symbol, FinchAPI::Models::HRIS::Company::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}, nil]
-          #
-          # @return [FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::Company::PayStatementItemListResponse>]
-          #
-          # @see FinchAPI::Models::HRIS::Company::PayStatementItemListParams
-          def list(params = {})
-            parsed, options = FinchAPI::HRIS::Company::PayStatementItemListParams.dump_request(params)
-            query = FinchAPI::Internal::Util.encode_query_params(parsed)
-            @client.request(
-              method: :get,
-              path: "employer/pay-statement-item",
-              query: query,
-              page: FinchAPI::Internal::ResponsesPage,
-              model: FinchAPI::Models::HRIS::Company::PayStatementItemListResponse,
-              security: {bearer_auth: true},
-              options: options
-            )
-          end
-
-          # @api private
-          #
-          # @param client [FinchAPI::Client]
-          def initialize(client:)
-            @client = client
-            @rules = FinchAPI::Resources::HRIS::Company::PayStatementItem::Rules.new(client: client)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,319 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module HRIS
-      module Company
-        module PayStatementItem
-          class RuleCreateParams < 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::PayStatementItem::RuleCreateParams,
-                  FinchAPI::Internal::AnyHash
-                )
-              end
-
-            # The entity IDs to create the rule for.
-            sig { returns(T.nilable(T::Array[String])) }
-            attr_reader :entity_ids
-
-            sig { params(entity_ids: T::Array[String]).void }
-            attr_writer :entity_ids
-
-            # Specifies the fields to be applied when the condition is met.
-            sig do
-              returns(
-                T.nilable(
-                  FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes
-                )
-              )
-            end
-            attr_reader :attributes
-
-            sig do
-              params(
-                attributes:
-                  FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes::OrHash
-              ).void
-            end
-            attr_writer :attributes
-
-            sig do
-              returns(
-                T.nilable(
-                  T::Array[
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition
-                  ]
-                )
-              )
-            end
-            attr_reader :conditions
-
-            sig do
-              params(
-                conditions:
-                  T::Array[
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::OrHash
-                  ]
-              ).void
-            end
-            attr_writer :conditions
-
-            # 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::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol
-                )
-              )
-            end
-            attr_reader :entity_type
-
-            sig do
-              params(
-                entity_type:
-                  FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol
-              ).void
-            end
-            attr_writer :entity_type
-
-            sig do
-              params(
-                entity_ids: T::Array[String],
-                attributes:
-                  FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes::OrHash,
-                conditions:
-                  T::Array[
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::OrHash
-                  ],
-                effective_end_date: T.nilable(String),
-                effective_start_date: T.nilable(String),
-                entity_type:
-                  FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol,
-                request_options: FinchAPI::RequestOptions::OrHash
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              # The entity IDs to create the rule for.
-              entity_ids: nil,
-              # Specifies the fields to be applied when the condition is met.
-              attributes: nil,
-              conditions: 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,
-              request_options: {}
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  entity_ids: T::Array[String],
-                  attributes:
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes,
-                  conditions:
-                    T::Array[
-                      FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition
-                    ],
-                  effective_end_date: T.nilable(String),
-                  effective_start_date: T.nilable(String),
-                  entity_type:
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::OrSymbol,
-                  request_options: FinchAPI::RequestOptions
-                }
-              )
-            end
-            def to_hash
-            end
-
-            class Attributes < FinchAPI::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::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::HRIS::Company::PayStatementItem::RuleCreateParams::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::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol
-                  )
-                )
-              end
-              attr_reader :operator
-
-              sig do
-                params(
-                  operator:
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::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::HRIS::Company::PayStatementItem::RuleCreateParams::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::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::OrSymbol,
-                    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::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator
-                    )
-                  end
-                OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-                EQUALS =
-                  T.let(
-                    :equals,
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Condition::Operator::TaggedSymbol
-                  )
-
-                sig do
-                  override.returns(
-                    T::Array[
-                      FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::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::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType
-                  )
-                end
-              OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-              PAY_STATEMENT_ITEM =
-                T.let(
-                  :pay_statement_item,
-                  FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::TaggedSymbol
-                )
-
-              sig do
-                override.returns(
-                  T::Array[
-                    FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::EntityType::TaggedSymbol
-                  ]
-                )
-              end
-              def self.values
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end