vitable-connect 0.5.0 → 1.0.0

data/rbi/vitable_connect/resources/employers.rbi

@@ -1,150 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    class Employers
-      # Creates a new employer for the authenticated organization. Requires employer
-      # name, legal name, EIN, email, and address information. Returns the created
-      # employer with its assigned ID.
-      sig do
-        params(
-          address: VitableConnect::EmployerCreateParams::Address::OrHash,
-          ein: String,
-          email: String,
-          legal_name: String,
-          name: String,
-          phone_number: T.nilable(String),
-          reference_id: T.nilable(String),
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::EmployerResponse)
-      end
-      def create(
-        # Employer address
-        address:,
-        # Employer Identification Number (format: XX-XXXXXXX)
-        ein:,
-        # Email address for billing and communications
-        email:,
-        # Legal business name
-        legal_name:,
-        # Employer display name
-        name:,
-        # Employer phone number (10-digit US format, e.g. 5551234567)
-        phone_number: nil,
-        # External reference ID for this employer
-        reference_id: nil,
-        request_options: {}
-      )
-      end
-
-      # Retrieves detailed information for a specific employer by ID. The employer must
-      # belong to the authenticated organization.
-      sig do
-        params(
-          employer_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::EmployerResponse)
-      end
-      def retrieve(
-        # Unique employer identifier (empr\_\*)
-        employer_id,
-        request_options: {}
-      )
-      end
-
-      # Retrieves a paginated list of all employers belonging to the authenticated
-      # organization. Results are sorted by creation date (newest first) and paginated
-      # using page and limit parameters.
-      sig do
-        params(
-          limit: Integer,
-          page: Integer,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(
-          VitableConnect::Internal::PageNumberPage[VitableConnect::Employer]
-        )
-      end
-      def list(
-        # Items per page (default: 20, max: 100)
-        limit: nil,
-        # Page number (default: 1)
-        page: nil,
-        request_options: {}
-      )
-      end
-
-      # Retrieves a paginated list of all employees for a specific employer. Results are
-      # paginated using page and limit parameters. Each employee includes payroll
-      # deductions from the most recent statement period. When a new deduction statement
-      # is generated, previous period deductions are replaced.
-      sig do
-        params(
-          employer_id: String,
-          limit: Integer,
-          page: Integer,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(
-          VitableConnect::Internal::PageNumberPage[VitableConnect::Employee]
-        )
-      end
-      def list_employees(
-        # Unique employer identifier (empr\_\*)
-        employer_id,
-        # Items per page (default: 20, max: 100)
-        limit: nil,
-        # Page number (default: 1)
-        page: nil,
-        request_options: {}
-      )
-      end
-
-      # Submits a census sync payload for the specified employer. The employees in the
-      # payload will be queued for processing. Returns an accepted response with the
-      # timestamp of acceptance.
-      sig do
-        params(
-          employer_id: String,
-          employees:
-            T::Array[
-              VitableConnect::EmployerSubmitCensusSyncParams::Employee::OrHash
-            ],
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::EmployerSubmitCensusSyncResponse)
-      end
-      def submit_census_sync(
-        # Unique employer identifier (empr\_\*)
-        employer_id,
-        employees:,
-        request_options: {}
-      )
-      end
-
-      # Updates configuration settings for a specific employer. The employer must belong
-      # to the authenticated organization.
-      sig do
-        params(
-          employer_id: String,
-          pay_frequency:
-            VitableConnect::EmployerUpdateSettingsParams::PayFrequency::OrSymbol,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::EmployerUpdateSettingsResponse)
-      end
-      def update_settings(
-        # Unique employer identifier (empr\_\*)
-        employer_id,
-        # - `weekly` - weekly
-        # - `bi_weekly` - bi_weekly
-        # - `semi_monthly` - semi_monthly
-        # - `monthly` - monthly
-        pay_frequency:,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/vitable_connect/resources/enrollments.rbi

@@ -1,27 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    # Manage benefit enrollments and elections for employees
-    class Enrollments
-      # Retrieves detailed information for a specific enrollment by ID.
-      sig do
-        params(
-          enrollment_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::EnrollmentRetrieveResponse)
-      end
-      def retrieve(
-        # Unique enrollment identifier (enrl\_\*)
-        enrollment_id,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/vitable_connect/resources/groups/members/sync.rbi

@@ -1,62 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    class Groups
-      class Members
-        class Sync
-          # Retrieves a previously-submitted group member sync request by its `grpmsr_` ID.
-          # Returns the acceptance timestamp, completion timestamp (if processing has
-          # finished), and the per-member `results` once available. While processing is in
-          # flight, `completed_at` and `results` are `null`.
-          sig do
-            params(
-              request_id: String,
-              group_id: String,
-              request_options: VitableConnect::RequestOptions::OrHash
-            ).returns(
-              VitableConnect::Models::Groups::Members::SyncRetrieveResponse
-            )
-          end
-          def retrieve(
-            request_id,
-            # Unique group identifier (grp\_\*)
-            group_id:,
-            request_options: {}
-          )
-          end
-
-          # Submits a member sync payload for the specified group. Members in the payload
-          # will be queued for processing asynchronously. Returns HTTP 202 with the batch ID
-          # and acceptance timestamp.
-          sig do
-            params(
-              group_id: String,
-              members:
-                T::Array[
-                  VitableConnect::Groups::Members::SyncSubmitParams::Member::OrHash
-                ],
-              request_options: VitableConnect::RequestOptions::OrHash
-            ).returns(
-              VitableConnect::Models::Groups::Members::SyncSubmitResponse
-            )
-          end
-          def submit(
-            # Unique group identifier (grp\_\*)
-            group_id,
-            members:,
-            request_options: {}
-          )
-          end
-
-          # @api private
-          sig do
-            params(client: VitableConnect::Client).returns(T.attached_class)
-          end
-          def self.new(client:)
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/vitable_connect/resources/groups/members.rbi

@@ -1,17 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    class Groups
-      class Members
-        sig { returns(VitableConnect::Resources::Groups::Members::Sync) }
-        attr_reader :sync
-
-        # @api private
-        sig { params(client: VitableConnect::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end

data/rbi/vitable_connect/resources/groups.rbi

@@ -1,79 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    class Groups
-      sig { returns(VitableConnect::Resources::Groups::Members) }
-      attr_reader :members
-
-      # Creates a new group scoped to the authenticated organization.
-      sig do
-        params(
-          external_reference_id: String,
-          name: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::GroupResponse)
-      end
-      def create(external_reference_id:, name:, request_options: {})
-      end
-
-      # Retrieves a single group by its prefixed ID. Returns 404 if the group does not
-      # belong to the authenticated organization.
-      sig do
-        params(
-          group_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::GroupResponse)
-      end
-      def retrieve(
-        # Unique group identifier (grp\_\*)
-        group_id,
-        request_options: {}
-      )
-      end
-
-      # Partially updates a group's name or external reference ID. Returns 404 if the
-      # group does not belong to the authenticated organization.
-      sig do
-        params(
-          group_id: String,
-          external_reference_id: T.nilable(String),
-          name: T.nilable(String),
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::GroupResponse)
-      end
-      def update(
-        # Unique group identifier (grp\_\*)
-        group_id,
-        external_reference_id: nil,
-        name: nil,
-        request_options: {}
-      )
-      end
-
-      # Returns a paginated list of groups belonging to the authenticated organization.
-      sig do
-        params(
-          limit: Integer,
-          page: Integer,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(
-          VitableConnect::Internal::PageNumberPage[VitableConnect::Group]
-        )
-      end
-      def list(
-        # Items per page (default: 20, max: 100)
-        limit: nil,
-        # Page number (default: 1)
-        page: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/vitable_connect/resources/plans.rbi

@@ -1,34 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    class Plans
-      # Returns a paginated list of benefit plans linked to the authenticated
-      # organization.
-      sig do
-        params(
-          limit: Integer,
-          page: Integer,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(
-          VitableConnect::Internal::PageNumberPage[
-            VitableConnect::Models::PlanListResponse
-          ]
-        )
-      end
-      def list(
-        # Items per page (default: 20, max: 100)
-        limit: nil,
-        # Page number (default: 1)
-        page: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/vitable_connect/resources/webhook_events.rbi

@@ -1,83 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    class WebhookEvents
-      # Retrieves a single webhook event by its prefixed ID. Returns 404 if the event
-      # does not exist or belongs to a different organization.
-      sig do
-        params(
-          event_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::WebhookEventRetrieveResponse)
-      end
-      def retrieve(event_id, request_options: {})
-      end
-
-      # Retrieves a paginated list of webhook events for the authenticated organization.
-      # Supports filtering by event name, resource type, resource ID, and date range.
-      sig do
-        params(
-          created_after: Time,
-          created_before: Time,
-          event_name:
-            VitableConnect::WebhookEventListParams::EventName::OrSymbol,
-          limit: Integer,
-          page: Integer,
-          resource_id: String,
-          resource_type:
-            VitableConnect::WebhookEventListParams::ResourceType::OrSymbol,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(
-          VitableConnect::Internal::PageNumberPage[VitableConnect::WebhookEvent]
-        )
-      end
-      def list(
-        created_after: nil,
-        created_before: nil,
-        # - `enrollment.accepted` - Enrollment Accepted
-        # - `enrollment.terminated` - Enrollment Terminated
-        # - `enrollment.elected` - Enrollment Elected
-        # - `enrollment.granted` - Enrollment Granted
-        # - `enrollment.waived` - Enrollment Waived
-        # - `enrollment.started` - Enrollment Started
-        # - `employee.eligibility_granted` - Employee Eligibility Granted
-        # - `employee.eligibility_terminated` - Employee Eligibility Terminated
-        # - `employee.deactivated` - Employee Deactivated
-        # - `employee.deduction_created` - Employee Deduction Created
-        event_name: nil,
-        # Items per page (default: 20, max: 100)
-        limit: nil,
-        # Page number (default: 1)
-        page: nil,
-        resource_id: nil,
-        # - `enrollment` - Enrollment
-        # - `employee` - Employee
-        # - `employer` - Employer
-        # - `dependent` - Dependent
-        # - `plan_year` - Plan Year
-        # - `payroll_deduction` - Payroll Deduction
-        resource_type: nil,
-        request_options: {}
-      )
-      end
-
-      # Retrieves all delivery attempts for a webhook event. Returns up to 100
-      # deliveries. Each delivery includes a computed status field (Pending, In
-      # Progress, Delivered, or Failed).
-      sig do
-        params(
-          event_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::WebhookEventListDeliveriesResponse)
-      end
-      def list_deliveries(event_id, request_options: {})
-      end
-
-      # @api private
-      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/vitable_connect/version.rbi

@@ -1,5 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  VERSION = T.let(T.unsafe(nil), String)
-end

data/sig/vitable_connect/client.rbs

@@ -1,46 +0,0 @@
-module VitableConnect
-  class Client < VitableConnect::Internal::Transport::BaseClient
-    DEFAULT_MAX_RETRIES: 2
-
-    DEFAULT_TIMEOUT_IN_SECONDS: Float
-
-    DEFAULT_INITIAL_RETRY_DELAY: Float
-
-    DEFAULT_MAX_RETRY_DELAY: Float
-
-    ENVIRONMENTS: {
-      production: "https://api.vitablehealth.com",
-      :environment_1 => "https://api.uat.vitablehealth.com"
-    }
-
-    attr_reader api_key: String
-
-    attr_reader auth: VitableConnect::Resources::Auth
-
-    attr_reader benefit_eligibility_policies: VitableConnect::Resources::BenefitEligibilityPolicies
-
-    attr_reader employees: VitableConnect::Resources::Employees
-
-    attr_reader employers: VitableConnect::Resources::Employers
-
-    attr_reader enrollments: VitableConnect::Resources::Enrollments
-
-    attr_reader webhook_events: VitableConnect::Resources::WebhookEvents
-
-    attr_reader groups: VitableConnect::Resources::Groups
-
-    attr_reader plans: VitableConnect::Resources::Plans
-
-    private def auth_headers: -> ::Hash[String, String]
-
-    def initialize: (
-      ?api_key: String?,
-      ?environment: :production | :environment_1 | nil,
-      ?base_url: String?,
-      ?max_retries: Integer,
-      ?timeout: Float,
-      ?initial_retry_delay: Float,
-      ?max_retry_delay: Float
-    ) -> void
-  end
-end

data/sig/vitable_connect/errors.rbs

@@ -1,117 +0,0 @@
-module VitableConnect
-  module Errors
-    class Error < StandardError
-      attr_accessor cause: StandardError?
-    end
-
-    class ConversionError < VitableConnect::Errors::Error
-      def cause: -> StandardError?
-
-      def initialize: (
-        on: Class,
-        method: Symbol,
-        target: top,
-        value: top,
-        ?cause: StandardError?
-      ) -> void
-    end
-
-    class APIError < VitableConnect::Errors::Error
-      attr_accessor url: URI::Generic
-
-      attr_accessor status: Integer?
-
-      attr_accessor headers: ::Hash[String, String]?
-
-      attr_accessor body: top?
-
-      def initialize: (
-        url: URI::Generic,
-        ?status: Integer?,
-        ?headers: ::Hash[String, String]?,
-        ?body: Object?,
-        ?request: nil,
-        ?response: nil,
-        ?message: String?
-      ) -> void
-    end
-
-    class APIConnectionError < VitableConnect::Errors::APIError
-      def initialize: (
-        url: URI::Generic,
-        ?status: nil,
-        ?headers: ::Hash[String, String]?,
-        ?body: nil,
-        ?request: nil,
-        ?response: nil,
-        ?message: String?
-      ) -> void
-    end
-
-    class APITimeoutError < VitableConnect::Errors::APIConnectionError
-      def initialize: (
-        url: URI::Generic,
-        ?status: nil,
-        ?headers: ::Hash[String, String]?,
-        ?body: nil,
-        ?request: nil,
-        ?response: nil,
-        ?message: String?
-      ) -> void
-    end
-
-    class APIStatusError < VitableConnect::Errors::APIError
-      def self.for: (
-        url: URI::Generic,
-        status: Integer,
-        headers: ::Hash[String, String]?,
-        body: Object?,
-        request: nil,
-        response: nil,
-        ?message: String?
-      ) -> instance
-
-      def initialize: (
-        url: URI::Generic,
-        status: Integer,
-        headers: ::Hash[String, String]?,
-        body: Object?,
-        request: nil,
-        response: nil,
-        ?message: String?
-      ) -> void
-    end
-
-    class BadRequestError < VitableConnect::Errors::APIStatusError
-      HTTP_STATUS: 400
-    end
-
-    class AuthenticationError < VitableConnect::Errors::APIStatusError
-      HTTP_STATUS: 401
-    end
-
-    class PermissionDeniedError < VitableConnect::Errors::APIStatusError
-      HTTP_STATUS: 403
-    end
-
-    class NotFoundError < VitableConnect::Errors::APIStatusError
-      HTTP_STATUS: 404
-    end
-
-    class ConflictError < VitableConnect::Errors::APIStatusError
-      HTTP_STATUS: 409
-    end
-
-    class UnprocessableEntityError < VitableConnect::Errors::APIStatusError
-      HTTP_STATUS: 422
-    end
-
-    class RateLimitError < VitableConnect::Errors::APIStatusError
-      HTTP_STATUS: 429
-    end
-
-    class InternalServerError < VitableConnect::Errors::APIStatusError
-      HTTP_STATUS: Range[Integer]
-    end
-  end
-end

data/sig/vitable_connect/file_part.rbs

@@ -1,21 +0,0 @@
-module VitableConnect
-  class FilePart
-    attr_reader content: Pathname | StringIO | IO | String
-
-    attr_reader content_type: String?
-
-    attr_reader filename: String?
-
-    private def read: -> String
-
-    def to_json: (*top a) -> String
-
-    def to_yaml: (*top a) -> String
-
-    def initialize: (
-      Pathname | StringIO | IO | String content,
-      ?filename: (Pathname | String)?,
-      ?content_type: String?
-    ) -> void
-  end
-end

data/sig/vitable_connect/internal/page_number_page.rbs

@@ -1,28 +0,0 @@
-module VitableConnect
-  module Internal
-    class PageNumberPage[Elem]
-      include VitableConnect::Internal::Type::BasePage[Elem]
-
-      attr_accessor data: ::Array[Elem]?
-
-      attr_accessor pagination: Pagination
-
-      def inspect: -> String
-
-      type pagination = { page: Integer, total_pages: Integer }
-      class Pagination < VitableConnect::Internal::Type::BaseModel
-        attr_reader page: Integer?
-
-        def page=: (Integer) -> Integer
-
-        attr_reader total_pages: Integer?
-
-        def total_pages=: (Integer) -> Integer
-
-        def initialize: (?page: Integer, ?total_pages: Integer) -> void
-
-        def to_hash: -> { page: Integer, total_pages: Integer }
-      end
-    end
-  end
-end