vitable-connect 0.6.0 → 1.0.0

data/rbi/vitable_connect/models/employer_list_payroll_deduction_statements_response.rbi

@@ -1,169 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Models
-    class EmployerListPayrollDeductionStatementsResponse < VitableConnect::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse,
-            VitableConnect::Internal::AnyHash
-          )
-        end
-
-      # Download link for the change CSV, or null.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :csv_file_url
-
-      # - `weekly` - Weekly
-      # - `bi_weekly` - Bi Weekly
-      # - `semi_monthly` - Semi Monthly
-      # - `monthly` - Monthly
-      sig do
-        returns(
-          VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency::TaggedSymbol
-        )
-      end
-      attr_accessor :deduction_frequency
-
-      # Human-readable deduction frequency (e.g. `Monthly`).
-      sig { returns(String) }
-      attr_accessor :deduction_frequency_label
-
-      # Distinct employees covered by the statement's entries.
-      sig { returns(Integer) }
-      attr_accessor :employee_count
-
-      # Deduction period end date.
-      sig { returns(Date) }
-      attr_accessor :period_end
-
-      # Deduction period start date.
-      sig { returns(Date) }
-      attr_accessor :period_start
-
-      # When the statement was generated.
-      sig { returns(Time) }
-      attr_accessor :run_date
-
-      # Prefixed payroll-deduction-statement identifier (`pstmt_<base64-encoded-uuid>`).
-      sig { returns(String) }
-      attr_accessor :statement_id
-
-      # Total payroll deduction for the period, in cents.
-      sig { returns(Integer) }
-      attr_accessor :total_deduction_cents
-
-      # One payroll-deduction statement row.
-      #
-      # Reads a :class:`PayrollDeductionStatementDTO` by attribute: the `statement_id`
-      # character field renders the prefixed id via `str()`, and the date/datetime
-      # fields emit ISO-8601 strings.
-      sig do
-        params(
-          csv_file_url: T.nilable(String),
-          deduction_frequency:
-            VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency::OrSymbol,
-          deduction_frequency_label: String,
-          employee_count: Integer,
-          period_end: Date,
-          period_start: Date,
-          run_date: Time,
-          statement_id: String,
-          total_deduction_cents: Integer
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Download link for the change CSV, or null.
-        csv_file_url:,
-        # - `weekly` - Weekly
-        # - `bi_weekly` - Bi Weekly
-        # - `semi_monthly` - Semi Monthly
-        # - `monthly` - Monthly
-        deduction_frequency:,
-        # Human-readable deduction frequency (e.g. `Monthly`).
-        deduction_frequency_label:,
-        # Distinct employees covered by the statement's entries.
-        employee_count:,
-        # Deduction period end date.
-        period_end:,
-        # Deduction period start date.
-        period_start:,
-        # When the statement was generated.
-        run_date:,
-        # Prefixed payroll-deduction-statement identifier (`pstmt_<base64-encoded-uuid>`).
-        statement_id:,
-        # Total payroll deduction for the period, in cents.
-        total_deduction_cents:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            csv_file_url: T.nilable(String),
-            deduction_frequency:
-              VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency::TaggedSymbol,
-            deduction_frequency_label: String,
-            employee_count: Integer,
-            period_end: Date,
-            period_start: Date,
-            run_date: Time,
-            statement_id: String,
-            total_deduction_cents: Integer
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # - `weekly` - Weekly
-      # - `bi_weekly` - Bi Weekly
-      # - `semi_monthly` - Semi Monthly
-      # - `monthly` - Monthly
-      module DeductionFrequency
-        extend VitableConnect::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        WEEKLY =
-          T.let(
-            :weekly,
-            VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency::TaggedSymbol
-          )
-        BI_WEEKLY =
-          T.let(
-            :bi_weekly,
-            VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency::TaggedSymbol
-          )
-        SEMI_MONTHLY =
-          T.let(
-            :semi_monthly,
-            VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency::TaggedSymbol
-          )
-        MONTHLY =
-          T.let(
-            :monthly,
-            VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/vitable_connect/models/employer_list_response.rbi

@@ -1,426 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Models
-    class EmployerListResponse < VitableConnect::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            VitableConnect::Models::EmployerListResponse,
-            VitableConnect::Internal::AnyHash
-          )
-        end
-
-      # Whether the employer is currently active in the system.
-      sig { returns(T::Boolean) }
-      attr_accessor :active
-
-      # Shared read serializer for a postal address on public API responses.
-      #
-      # One definition for the address block every public resource emits (employer,
-      # employee, …), so the 5-field shape isn't hand-rolled per endpoint. Read-only: it
-      # renders an already-built address value object (e.g. `AddressDVO`) whose
-      # attributes map 1:1 to these fields.
-      sig { returns(VitableConnect::Models::EmployerListResponse::Address) }
-      attr_reader :address
-
-      sig do
-        params(
-          address: VitableConnect::Models::EmployerListResponse::Address::OrHash
-        ).void
-      end
-      attr_writer :address
-
-      # Distinct benefit-family tags across the employer's active benefits (e.g. `MEC`,
-      # `ICHRA`, `VPC`).
-      sig { returns(T::Array[String]) }
-      attr_accessor :benefit_families
-
-      sig do
-        returns(
-          VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage
-        )
-      end
-      attr_reader :benefit_lifecycle_stage
-
-      sig do
-        params(
-          benefit_lifecycle_stage:
-            VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage::OrHash
-        ).void
-      end
-      attr_writer :benefit_lifecycle_stage
-
-      # Timestamp when the employer was created.
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      # Employer Identification Number (masked in responses).
-      sig { returns(T.nilable(String)) }
-      attr_accessor :ein
-
-      # Email address for billing and communications.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :email
-
-      # Prefixed employer identifier (`empr_<base64-encoded-uuid>`).
-      sig { returns(String) }
-      attr_accessor :employer_id
-
-      # Enrolled/eligible employees roll-up.
-      sig do
-        returns(
-          VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary
-        )
-      end
-      attr_reader :enrollment_rate_summary
-
-      sig do
-        params(
-          enrollment_rate_summary:
-            VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary::OrHash
-        ).void
-      end
-      attr_writer :enrollment_rate_summary
-
-      # HRIS connection, or null when the employer has none.
-      sig do
-        returns(
-          T.nilable(VitableConnect::Models::EmployerListResponse::HRISStatus)
-        )
-      end
-      attr_reader :hris_status
-
-      sig do
-        params(
-          hris_status:
-            T.nilable(
-              VitableConnect::Models::EmployerListResponse::HRISStatus::OrHash
-            )
-        ).void
-      end
-      attr_writer :hris_status
-
-      # Legal business name for compliance and tax purposes.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :legal_name
-
-      # Employer name.
-      sig { returns(String) }
-      attr_accessor :name
-
-      # ID of the parent organization (`org_*`), or null when unknown.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :organization_id
-
-      # Employer phone number.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :phone_number
-
-      # The organization's own reference id for this employer, or null when none was
-      # assigned.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :reference_id
-
-      # Timestamp when the employer was last updated.
-      sig { returns(Time) }
-      attr_accessor :updated_at
-
-      # One employer row of the organization's book (list projection).
-      #
-      # Carries the enriched/computed columns (enrollment roll-up, benefit-family tags,
-      # HRIS connection, benefit-lifecycle stage) alongside the flat CRM fields of the
-      # underlying employer (legal name, EIN, contact, address, timestamps) for parity
-      # with the legacy `Employer` contract.
-      sig do
-        params(
-          active: T::Boolean,
-          address:
-            VitableConnect::Models::EmployerListResponse::Address::OrHash,
-          benefit_families: T::Array[String],
-          benefit_lifecycle_stage:
-            VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage::OrHash,
-          created_at: Time,
-          ein: T.nilable(String),
-          email: T.nilable(String),
-          employer_id: String,
-          enrollment_rate_summary:
-            VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary::OrHash,
-          hris_status:
-            T.nilable(
-              VitableConnect::Models::EmployerListResponse::HRISStatus::OrHash
-            ),
-          legal_name: T.nilable(String),
-          name: String,
-          organization_id: T.nilable(String),
-          phone_number: T.nilable(String),
-          reference_id: T.nilable(String),
-          updated_at: Time
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Whether the employer is currently active in the system.
-        active:,
-        # Shared read serializer for a postal address on public API responses.
-        #
-        # One definition for the address block every public resource emits (employer,
-        # employee, …), so the 5-field shape isn't hand-rolled per endpoint. Read-only: it
-        # renders an already-built address value object (e.g. `AddressDVO`) whose
-        # attributes map 1:1 to these fields.
-        address:,
-        # Distinct benefit-family tags across the employer's active benefits (e.g. `MEC`,
-        # `ICHRA`, `VPC`).
-        benefit_families:,
-        benefit_lifecycle_stage:,
-        # Timestamp when the employer was created.
-        created_at:,
-        # Employer Identification Number (masked in responses).
-        ein:,
-        # Email address for billing and communications.
-        email:,
-        # Prefixed employer identifier (`empr_<base64-encoded-uuid>`).
-        employer_id:,
-        # Enrolled/eligible employees roll-up.
-        enrollment_rate_summary:,
-        # HRIS connection, or null when the employer has none.
-        hris_status:,
-        # Legal business name for compliance and tax purposes.
-        legal_name:,
-        # Employer name.
-        name:,
-        # ID of the parent organization (`org_*`), or null when unknown.
-        organization_id:,
-        # Employer phone number.
-        phone_number:,
-        # The organization's own reference id for this employer, or null when none was
-        # assigned.
-        reference_id:,
-        # Timestamp when the employer was last updated.
-        updated_at:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            active: T::Boolean,
-            address: VitableConnect::Models::EmployerListResponse::Address,
-            benefit_families: T::Array[String],
-            benefit_lifecycle_stage:
-              VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage,
-            created_at: Time,
-            ein: T.nilable(String),
-            email: T.nilable(String),
-            employer_id: String,
-            enrollment_rate_summary:
-              VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary,
-            hris_status:
-              T.nilable(
-                VitableConnect::Models::EmployerListResponse::HRISStatus
-              ),
-            legal_name: T.nilable(String),
-            name: String,
-            organization_id: T.nilable(String),
-            phone_number: T.nilable(String),
-            reference_id: T.nilable(String),
-            updated_at: Time
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Address < VitableConnect::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              VitableConnect::Models::EmployerListResponse::Address,
-              VitableConnect::Internal::AnyHash
-            )
-          end
-
-        # Primary street address.
-        sig { returns(String) }
-        attr_accessor :address_line_1
-
-        # Secondary street address (apt, suite, etc.).
-        sig { returns(T.nilable(String)) }
-        attr_accessor :address_line_2
-
-        # City name.
-        sig { returns(String) }
-        attr_accessor :city
-
-        # Two-letter state code (e.g. `CA`, `NY`).
-        sig { returns(String) }
-        attr_accessor :state
-
-        # ZIP code (5 or 9 digit).
-        sig { returns(String) }
-        attr_accessor :zipcode
-
-        # Shared read serializer for a postal address on public API responses.
-        #
-        # One definition for the address block every public resource emits (employer,
-        # employee, …), so the 5-field shape isn't hand-rolled per endpoint. Read-only: it
-        # renders an already-built address value object (e.g. `AddressDVO`) whose
-        # attributes map 1:1 to these fields.
-        sig do
-          params(
-            address_line_1: String,
-            address_line_2: T.nilable(String),
-            city: String,
-            state: String,
-            zipcode: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Primary street address.
-          address_line_1:,
-          # Secondary street address (apt, suite, etc.).
-          address_line_2:,
-          # City name.
-          city:,
-          # Two-letter state code (e.g. `CA`, `NY`).
-          state:,
-          # ZIP code (5 or 9 digit).
-          zipcode:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              address_line_1: String,
-              address_line_2: T.nilable(String),
-              city: String,
-              state: String,
-              zipcode: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      class BenefitLifecycleStage < VitableConnect::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage,
-              VitableConnect::Internal::AnyHash
-            )
-          end
-
-        # Anchor date for the stage (e.g. renewal date); null when not applicable.
-        sig { returns(T.nilable(Date)) }
-        attr_accessor :as_of_date
-
-        # Computed employer benefit-lifecycle stage: `open_enrollment`, `renewal`,
-        # `active`, `onboarding`, or `cancelled`.
-        sig { returns(String) }
-        attr_accessor :stage
-
-        sig do
-          params(as_of_date: T.nilable(Date), stage: String).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Anchor date for the stage (e.g. renewal date); null when not applicable.
-          as_of_date:,
-          # Computed employer benefit-lifecycle stage: `open_enrollment`, `renewal`,
-          # `active`, `onboarding`, or `cancelled`.
-          stage:
-        )
-        end
-
-        sig { override.returns({ as_of_date: T.nilable(Date), stage: String }) }
-        def to_hash
-        end
-      end
-
-      class EnrollmentRateSummary < VitableConnect::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary,
-              VitableConnect::Internal::AnyHash
-            )
-          end
-
-        # Employees eligible for at least one active benefit.
-        sig { returns(Integer) }
-        attr_accessor :eligible
-
-        # Employees enrolled in at least one active benefit.
-        sig { returns(Integer) }
-        attr_accessor :enrolled
-
-        # `enrolled / eligible` as a whole-number percent (0 when none eligible).
-        sig { returns(Integer) }
-        attr_accessor :percentage
-
-        # Enrolled/eligible employees roll-up.
-        sig do
-          params(
-            eligible: Integer,
-            enrolled: Integer,
-            percentage: Integer
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Employees eligible for at least one active benefit.
-          eligible:,
-          # Employees enrolled in at least one active benefit.
-          enrolled:,
-          # `enrolled / eligible` as a whole-number percent (0 when none eligible).
-          percentage:
-        )
-        end
-
-        sig do
-          override.returns(
-            { eligible: Integer, enrolled: Integer, percentage: Integer }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      class HRISStatus < VitableConnect::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              VitableConnect::Models::EmployerListResponse::HRISStatus,
-              VitableConnect::Internal::AnyHash
-            )
-          end
-
-        # HRIS/payroll provider the employer is connected to (e.g. `Paychex`).
-        sig { returns(String) }
-        attr_accessor :provider
-
-        # Connection status reported by the integration.
-        sig { returns(String) }
-        attr_accessor :status
-
-        # HRIS connection, or null when the employer has none.
-        sig do
-          params(provider: String, status: String).returns(T.attached_class)
-        end
-        def self.new(
-          # HRIS/payroll provider the employer is connected to (e.g. `Paychex`).
-          provider:,
-          # Connection status reported by the integration.
-          status:
-        )
-        end
-
-        sig { override.returns({ provider: String, status: String }) }
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/vitable_connect/models/employer_response.rbi

@@ -1,36 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Models
-    class EmployerResponse < VitableConnect::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(
-            VitableConnect::EmployerResponse,
-            VitableConnect::Internal::AnyHash
-          )
-        end
-
-      # Serializer for Employer entity in public API responses.
-      sig { returns(VitableConnect::Employer) }
-      attr_reader :data
-
-      sig { params(data: VitableConnect::Employer::OrHash).void }
-      attr_writer :data
-
-      # Response containing a single employer resource.
-      sig do
-        params(data: VitableConnect::Employer::OrHash).returns(T.attached_class)
-      end
-      def self.new(
-        # Serializer for Employer entity in public API responses.
-        data:
-      )
-      end
-
-      sig { override.returns({ data: VitableConnect::Employer }) }
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/vitable_connect/models/employer_retrieve_benefit_plan_year_params.rbi

@@ -1,54 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Models
-    class EmployerRetrieveBenefitPlanYearParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            VitableConnect::EmployerRetrieveBenefitPlanYearParams,
-            VitableConnect::Internal::AnyHash
-          )
-        end
-
-      # Unique employer identifier (empr\_\*)
-      sig { returns(String) }
-      attr_accessor :employer_id
-
-      # Unique benefit-plan-year identifier (plyr\_\*).
-      sig { returns(String) }
-      attr_accessor :benefit_plan_year_id
-
-      sig do
-        params(
-          employer_id: String,
-          benefit_plan_year_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Unique employer identifier (empr\_\*)
-        employer_id:,
-        # Unique benefit-plan-year identifier (plyr\_\*).
-        benefit_plan_year_id:,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            employer_id: String,
-            benefit_plan_year_id: String,
-            request_options: VitableConnect::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end