vitable-connect 0.6.0 → 1.0.0

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/members.rbi

@@ -1,169 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    # Browse the members covered across your book and read a member's profile
-    class Members
-      # Retrieves a member's profile by ID — identity, demographics, address, contact
-      # details, tobacco status, and profile status. Access is scoped to the
-      # authenticated principal; a member not visible to the caller returns a 404.
-      sig do
-        params(
-          member_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::MemberRetrieveResponse)
-      end
-      def retrieve(member_id, request_options: {})
-      end
-
-      # Retrieves a paginated list of the members in the authenticated organization's
-      # book — identity, contact details, and address. The book covers members reached
-      # through an employer in the organization's book as well as members of a group it
-      # owns. Supports free-text search (name, email, or exact member id).
-      sig do
-        params(
-          limit: Integer,
-          page: Integer,
-          search: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(
-          VitableConnect::Internal::PageNumberPage[
-            VitableConnect::Models::MemberListResponse
-          ]
-        )
-      end
-      def list(
-        # Items per page (default: 20, max: 100)
-        limit: nil,
-        # Page number (default: 1)
-        page: nil,
-        # Case-insensitive search across member name and email; exact match on member id
-        search: nil,
-        request_options: {}
-      )
-      end
-
-      # Lists a member's active legal dependents — name, relationship, date of birth,
-      # age, and sex at birth. Access is scoped to the authenticated principal; a member
-      # not visible to the caller returns a 404.
-      sig do
-        params(
-          member_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::MemberListDependentsResponse)
-      end
-      def list_dependents(member_id, request_options: {})
-      end
-
-      # Lists a member's employment across every employer — the same employee record
-      # shape as the employer's employees list, plus the employer name. For an
-      # organization caller the rows are scoped to companies in that organization's
-      # book; a member (self/household) or Vitable Admin sees all employments. A member
-      # not visible to the caller returns a 404.
-      sig do
-        params(
-          member_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::MemberListEmploymentsResponse)
-      end
-      def list_employments(member_id, request_options: {})
-      end
-
-      # Lists a member's benefit enrollments across every employer — benefit type and
-      # product, employer, carrier, plan, tier, employee deduction, employer
-      # contribution and total premium, the individual enrollment coverage boundary
-      # (`coverage_end`), the distinct benefit plan-year boundary
-      # (`plan_year_coverage_end`) used to determine whether the plan year itself has
-      # ended, whether a qualifying life event would currently be required for reissue
-      # under the product/open-enrollment rule, enrollment/open-enrollment window, and
-      # two statuses: `election_status` (what the member answered) and `policy_status`
-      # (what became of their coverage, null unless they enrolled). Every row includes a
-      # stable enrollment ID that can be used to target enrollment actions. The full
-      # list is returned across all states so the client derives active plans (effective
-      # and upcoming) and the enrollment history from those per-row statuses. For an
-      # organization caller the rows are scoped to companies in that organization's
-      # book; a member (self/household) or Vitable Admin sees all enrollments. A member
-      # not visible to the caller returns a 404.
-      sig do
-        params(
-          member_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::MemberListEnrollmentsResponse)
-      end
-      def list_enrollments(member_id, request_options: {})
-      end
-
-      # Lists a member's benefit ID cards — card type (medical, dental, vision, or rx),
-      # employer, plan, provider network, claims payer, carrier contact details, and the
-      # disclaimers printed on the card. Medical, dental and vision cards come from the
-      # member's active digital benefit cards; the rx card from the member's Ventegra
-      # pharmacy benefit (omitted when the member has no free-medication coverage),
-      # which carries no plan, network, or carrier details. Access is scoped to the
-      # authenticated principal, and an organization caller sees only cards from
-      # employers in its book; a member not visible to the caller returns a 404.
-      sig do
-        params(
-          member_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::MemberListIDCardsResponse)
-      end
-      def list_id_cards(member_id, request_options: {})
-      end
-
-      # Lists a member's qualifying life events, including events already used for
-      # another enrollment. Returns all statuses by default; pass the status query param
-      # to filter to one (e.g. approved). Events are ordered newest submission first
-      # with stable paging. Custom text is present only when submitted and is otherwise
-      # null. A member not visible to the caller returns a 404. API keys and unbound
-      # access tokens have organization-wide access. Employer-bound tokens require
-      # employment at the bound employer, and employee-bound tokens require the exact
-      # employee-member relationship. Organization or scope mismatches return a 404
-      # before pagination is validated.
-      sig do
-        params(
-          member_id: String,
-          limit: Integer,
-          page: Integer,
-          status:
-            VitableConnect::MemberListQualifyingLifeEventsParams::Status::OrSymbol,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(
-          VitableConnect::Internal::PageNumberPage[
-            VitableConnect::Models::MemberListQualifyingLifeEventsResponse
-          ]
-        )
-      end
-      def list_qualifying_life_events(
-        # Unique member identifier (mbr\_\*)
-        member_id,
-        # Items per page (default: 20, max: 100)
-        limit: nil,
-        # Page number (default: 1)
-        page: nil,
-        # Optional. Filter to a single QLE status; omit to return all statuses.
-        status: nil,
-        request_options: {}
-      )
-      end
-
-      # Lists a member's household as a per-participant table — the account holder plus
-      # each active household member, with name, relationship, member type, date of
-      # birth, and household-admin flag. Access is scoped to the authenticated
-      # principal; a member not visible to the caller (or with no household) returns
-      # a 404.
-      sig do
-        params(
-          member_id: String,
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::MemberRetrieveHouseholdResponse)
-      end
-      def retrieve_household(member_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/organizations.rbi

@@ -1,48 +0,0 @@
-# typed: strong
-
-module VitableConnect
-  module Resources
-    class Organizations
-      # Onboards the authenticated user's partner Organization: creates the local
-      # Organization + the creator's admin membership atomically, then mirrors it to
-      # WorkOS (creates the WorkOS org and binds the creator as admin). 409
-      # `organization_already_exists` when the user already has an organization (v0: one
-      # organization per user).
-      sig do
-        params(
-          name: String,
-          type:
-            T.nilable(VitableConnect::OrganizationCreateParams::Type::OrSymbol),
-          request_options: VitableConnect::RequestOptions::OrHash
-        ).returns(VitableConnect::Models::OrganizationCreateResponse)
-      end
-      def create(
-        name:,
-        # - `BROKERAGE` - BROKERAGE
-        # - `TPA` - TPA
-        # - `GENERAL_AGENT` - GENERAL_AGENT
-        # - `CHANNEL_PARTNER` - CHANNEL_PARTNER
-        # - `CONSULTING_FIRM` - CONSULTING_FIRM
-        # - `API_PLATFORM` - API_PLATFORM
-        type: nil,
-        request_options: {}
-      )
-      end
-
-      # Lists the organizations the authenticated caller is an active member of
-      # (paginated). Returns an empty list when the caller belongs to no organizations.
-      sig do
-        params(request_options: VitableConnect::RequestOptions::OrHash).returns(
-          VitableConnect::Models::OrganizationListResponse
-        )
-      end
-      def list(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,84 +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.termination_rescheduled` - Enrollment Termination Rescheduled
-        # - `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,52 +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 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 members: VitableConnect::Resources::Members
-
-    attr_reader organizations: VitableConnect::Resources::Organizations
-
-    attr_reader plans: VitableConnect::Resources::Plans
-
-    private def auth_headers: (
-      security: { api_key_auth: bool }
-    ) -> ::Hash[String, String]
-
-    private def api_key_auth: -> ::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