vitable-connect 0.4.0 → 0.6.0

data/rbi/vitable_connect/models/employer_list_hris_providers_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class EmployerListHRISProvidersParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::EmployerListHRISProvidersParams,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: VitableConnect::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: VitableConnect::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/employer_list_hris_providers_response.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class EmployerListHRISProvidersResponse < VitableConnect::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::Models::EmployerListHRISProvidersResponse,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T::Array[
+            VitableConnect::Models::EmployerListHRISProvidersResponse::Data
+          ]
+        )
+      end
+      attr_accessor :data
+
+      # Unpaginated `{"data": [...]}` list of organization hris providers.
+      sig do
+        params(
+          data:
+            T::Array[
+              VitableConnect::Models::EmployerListHRISProvidersResponse::Data::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T::Array[
+                VitableConnect::Models::EmployerListHRISProvidersResponse::Data
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < VitableConnect::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              VitableConnect::Models::EmployerListHRISProvidersResponse::Data,
+              VitableConnect::Internal::AnyHash
+            )
+          end
+
+        # HRIS/payroll provider name, as stored on the connection (e.g. `ADP RUN`).
+        sig { returns(String) }
+        attr_accessor :provider
+
+        sig { params(provider: String).returns(T.attached_class) }
+        def self.new(
+          # HRIS/payroll provider name, as stored on the connection (e.g. `ADP RUN`).
+          provider:
+        )
+        end
+
+        sig { override.returns({ provider: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/employer_list_invoices_params.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class EmployerListInvoicesParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::EmployerListInvoicesParams,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      # Unique employer identifier (empr\_\*)
+      sig { returns(String) }
+      attr_accessor :employer_id
+
+      # Maximum number of invoices per page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Opaque cursor from a previous page's next_offset
+      sig { returns(T.nilable(String)) }
+      attr_accessor :offset
+
+      sig do
+        params(
+          employer_id: String,
+          limit: Integer,
+          offset: T.nilable(String),
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique employer identifier (empr\_\*)
+        employer_id:,
+        # Maximum number of invoices per page
+        limit: nil,
+        # Opaque cursor from a previous page's next_offset
+        offset: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            employer_id: String,
+            limit: Integer,
+            offset: T.nilable(String),
+            request_options: VitableConnect::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/employer_list_invoices_response.rbi

@@ -0,0 +1,151 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class EmployerListInvoicesResponse < VitableConnect::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::Models::EmployerListInvoicesResponse,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T::Array[VitableConnect::Models::EmployerListInvoicesResponse::Data]
+        )
+      end
+      attr_accessor :data
+
+      sig do
+        returns(
+          VitableConnect::Models::EmployerListInvoicesResponse::Pagination
+        )
+      end
+      attr_reader :pagination
+
+      sig do
+        params(
+          pagination:
+            VitableConnect::Models::EmployerListInvoicesResponse::Pagination::OrHash
+        ).void
+      end
+      attr_writer :pagination
+
+      # Cursor-paginated invoices envelope:
+      # `{ "data": [...], "pagination": { "next_offset": ... } }`.
+      sig do
+        params(
+          data:
+            T::Array[
+              VitableConnect::Models::EmployerListInvoicesResponse::Data::OrHash
+            ],
+          pagination:
+            VitableConnect::Models::EmployerListInvoicesResponse::Pagination::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, pagination:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data:
+              T::Array[
+                VitableConnect::Models::EmployerListInvoicesResponse::Data
+              ],
+            pagination:
+              VitableConnect::Models::EmployerListInvoicesResponse::Pagination
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < VitableConnect::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              VitableConnect::Models::EmployerListInvoicesResponse::Data,
+              VitableConnect::Internal::AnyHash
+            )
+          end
+
+        # Chargebee invoice id (external id, not a prefixed UUID).
+        sig { returns(String) }
+        attr_accessor :invoice_id
+
+        # Invoice date as an ISO string, or null.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :period
+
+        # Chargebee invoice status (e.g. `paid`), or null.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :status
+
+        # Invoice total in dollars, or null.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :total
+
+        sig do
+          params(
+            invoice_id: String,
+            period: T.nilable(String),
+            status: T.nilable(String),
+            total: T.nilable(Float)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Chargebee invoice id (external id, not a prefixed UUID).
+          invoice_id:,
+          # Invoice date as an ISO string, or null.
+          period:,
+          # Chargebee invoice status (e.g. `paid`), or null.
+          status:,
+          # Invoice total in dollars, or null.
+          total:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              invoice_id: String,
+              period: T.nilable(String),
+              status: T.nilable(String),
+              total: T.nilable(Float)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Pagination < VitableConnect::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              VitableConnect::Models::EmployerListInvoicesResponse::Pagination,
+              VitableConnect::Internal::AnyHash
+            )
+          end
+
+        # Opaque JSON-encoded cursor for the next page; null when there are no more pages.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_offset
+
+        sig { params(next_offset: T.nilable(String)).returns(T.attached_class) }
+        def self.new(
+          # Opaque JSON-encoded cursor for the next page; null when there are no more pages.
+          next_offset:
+        )
+        end
+
+        sig { override.returns({ next_offset: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/employer_list_params.rbi

@@ -14,32 +14,143 @@ module VitableConnect
           )
         end
 
-      # Items per page (default: 20, max: 100)
+      # Filter to employers with at least one active benefit in these families.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              VitableConnect::EmployerListParams::BenefitFamily::OrSymbol
+            ]
+          )
+        )
+      end
+      attr_reader :benefit_family
+
+      sig do
+        params(
+          benefit_family:
+            T::Array[
+              VitableConnect::EmployerListParams::BenefitFamily::OrSymbol
+            ]
+        ).void
+      end
+      attr_writer :benefit_family
+
+      # Filter to employers in one of these computed benefit-lifecycle stages.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              VitableConnect::EmployerListParams::BenefitLifecycleStage::OrSymbol
+            ]
+          )
+        )
+      end
+      attr_reader :benefit_lifecycle_stage
+
+      sig do
+        params(
+          benefit_lifecycle_stage:
+            T::Array[
+              VitableConnect::EmployerListParams::BenefitLifecycleStage::OrSymbol
+            ]
+        ).void
+      end
+      attr_writer :benefit_lifecycle_stage
+
+      # Filter to employers whose HRIS connection is with one of these payroll providers
+      # (e.g. `ADP RUN`). Matched case-insensitively; free text, so read the available
+      # values from the HRIS-providers endpoint rather than assuming a fixed set.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :hris_provider
+
+      sig { params(hris_provider: T::Array[String]).void }
+      attr_writer :hris_provider
+
+      # Filter to employers whose HRIS connection is in one of these statuses.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[VitableConnect::EmployerListParams::HRISStatus::OrSymbol]
+          )
+        )
+      end
+      attr_reader :hris_status
+
+      sig do
+        params(
+          hris_status:
+            T::Array[VitableConnect::EmployerListParams::HRISStatus::OrSymbol]
+        ).void
+      end
+      attr_writer :hris_status
+
+      # Include cancelled employers (hidden by default unless their stage is explicitly
+      # requested).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_cancelled
+
+      sig { params(include_cancelled: T::Boolean).void }
+      attr_writer :include_cancelled
+
+      # Items per page.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
       sig { params(limit: Integer).void }
       attr_writer :limit
 
-      # Page number (default: 1)
+      # Page number.
       sig { returns(T.nilable(Integer)) }
       attr_reader :page
 
       sig { params(page: Integer).void }
       attr_writer :page
 
+      # Case-insensitive employer-name substring filter.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :search
+
       sig do
         params(
+          benefit_family:
+            T::Array[
+              VitableConnect::EmployerListParams::BenefitFamily::OrSymbol
+            ],
+          benefit_lifecycle_stage:
+            T::Array[
+              VitableConnect::EmployerListParams::BenefitLifecycleStage::OrSymbol
+            ],
+          hris_provider: T::Array[String],
+          hris_status:
+            T::Array[VitableConnect::EmployerListParams::HRISStatus::OrSymbol],
+          include_cancelled: T::Boolean,
           limit: Integer,
           page: Integer,
+          search: T.nilable(String),
           request_options: VitableConnect::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Items per page (default: 20, max: 100)
+        # Filter to employers with at least one active benefit in these families.
+        benefit_family: nil,
+        # Filter to employers in one of these computed benefit-lifecycle stages.
+        benefit_lifecycle_stage: nil,
+        # Filter to employers whose HRIS connection is with one of these payroll providers
+        # (e.g. `ADP RUN`). Matched case-insensitively; free text, so read the available
+        # values from the HRIS-providers endpoint rather than assuming a fixed set.
+        hris_provider: nil,
+        # Filter to employers whose HRIS connection is in one of these statuses.
+        hris_status: nil,
+        # Include cancelled employers (hidden by default unless their stage is explicitly
+        # requested).
+        include_cancelled: nil,
+        # Items per page.
         limit: nil,
-        # Page number (default: 1)
+        # Page number.
         page: nil,
+        # Case-insensitive employer-name substring filter.
+        search: nil,
         request_options: {}
       )
       end
@@ -47,14 +158,191 @@ module VitableConnect
       sig do
         override.returns(
           {
+            benefit_family:
+              T::Array[
+                VitableConnect::EmployerListParams::BenefitFamily::OrSymbol
+              ],
+            benefit_lifecycle_stage:
+              T::Array[
+                VitableConnect::EmployerListParams::BenefitLifecycleStage::OrSymbol
+              ],
+            hris_provider: T::Array[String],
+            hris_status:
+              T::Array[
+                VitableConnect::EmployerListParams::HRISStatus::OrSymbol
+              ],
+            include_cancelled: T::Boolean,
             limit: Integer,
             page: Integer,
+            search: T.nilable(String),
             request_options: VitableConnect::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # - `mec` - mec
+      # - `mvp` - mvp
+      # - `ichra` - ichra
+      # - `vpc` - vpc
+      # - `dental` - dental
+      # - `vision` - vision
+      module BenefitFamily
+        extend VitableConnect::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, VitableConnect::EmployerListParams::BenefitFamily)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MEC =
+          T.let(
+            :mec,
+            VitableConnect::EmployerListParams::BenefitFamily::TaggedSymbol
+          )
+        MVP =
+          T.let(
+            :mvp,
+            VitableConnect::EmployerListParams::BenefitFamily::TaggedSymbol
+          )
+        ICHRA =
+          T.let(
+            :ichra,
+            VitableConnect::EmployerListParams::BenefitFamily::TaggedSymbol
+          )
+        VPC =
+          T.let(
+            :vpc,
+            VitableConnect::EmployerListParams::BenefitFamily::TaggedSymbol
+          )
+        DENTAL =
+          T.let(
+            :dental,
+            VitableConnect::EmployerListParams::BenefitFamily::TaggedSymbol
+          )
+        VISION =
+          T.let(
+            :vision,
+            VitableConnect::EmployerListParams::BenefitFamily::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              VitableConnect::EmployerListParams::BenefitFamily::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # - `open_enrollment` - open_enrollment
+      # - `renewal` - renewal
+      # - `active` - active
+      # - `onboarding` - onboarding
+      # - `cancelled` - cancelled
+      module BenefitLifecycleStage
+        extend VitableConnect::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              VitableConnect::EmployerListParams::BenefitLifecycleStage
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OPEN_ENROLLMENT =
+          T.let(
+            :open_enrollment,
+            VitableConnect::EmployerListParams::BenefitLifecycleStage::TaggedSymbol
+          )
+        RENEWAL =
+          T.let(
+            :renewal,
+            VitableConnect::EmployerListParams::BenefitLifecycleStage::TaggedSymbol
+          )
+        ACTIVE =
+          T.let(
+            :active,
+            VitableConnect::EmployerListParams::BenefitLifecycleStage::TaggedSymbol
+          )
+        ONBOARDING =
+          T.let(
+            :onboarding,
+            VitableConnect::EmployerListParams::BenefitLifecycleStage::TaggedSymbol
+          )
+        CANCELLED =
+          T.let(
+            :cancelled,
+            VitableConnect::EmployerListParams::BenefitLifecycleStage::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              VitableConnect::EmployerListParams::BenefitLifecycleStage::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # - `Pending` - Pending
+      # - `Active` - Active
+      # - `Inactive` - Inactive
+      # - `Paused` - Paused
+      # - `Terminated` - Terminated
+      module HRISStatus
+        extend VitableConnect::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, VitableConnect::EmployerListParams::HRISStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :Pending,
+            VitableConnect::EmployerListParams::HRISStatus::TaggedSymbol
+          )
+        ACTIVE =
+          T.let(
+            :Active,
+            VitableConnect::EmployerListParams::HRISStatus::TaggedSymbol
+          )
+        INACTIVE =
+          T.let(
+            :Inactive,
+            VitableConnect::EmployerListParams::HRISStatus::TaggedSymbol
+          )
+        PAUSED =
+          T.let(
+            :Paused,
+            VitableConnect::EmployerListParams::HRISStatus::TaggedSymbol
+          )
+        TERMINATED =
+          T.let(
+            :Terminated,
+            VitableConnect::EmployerListParams::HRISStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              VitableConnect::EmployerListParams::HRISStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end