vitable-connect 0.1.0

data/lib/vitable_connect/resources/employees.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Resources
+    class Employees
+      # Retrieves detailed information for a specific employee by ID. Returns employee
+      # details including personal information and employment status.
+      #
+      # @overload retrieve(employee_id, request_options: {})
+      #
+      # @param employee_id [String] Unique employee identifier (empl\_\*)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::EmployeeRetrieveResponse]
+      #
+      # @see VitableConnect::Models::EmployeeRetrieveParams
+      def retrieve(employee_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/employees/%1$s", employee_id],
+          model: VitableConnect::Models::EmployeeRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieves a paginated list of benefit enrollments for an employee.
+      #
+      # @overload list_enrollments(employee_id, limit: nil, page: nil, request_options: {})
+      #
+      # @param employee_id [String] Unique employee identifier (empl\_\*)
+      #
+      # @param limit [Integer] Items per page (default: 20, max: 100)
+      #
+      # @param page [Integer] Page number (default: 1)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::Enrollment>]
+      #
+      # @see VitableConnect::Models::EmployeeListEnrollmentsParams
+      def list_enrollments(employee_id, params = {})
+        parsed, options = VitableConnect::EmployeeListEnrollmentsParams.dump_request(params)
+        query = VitableConnect::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["v1/employees/%1$s/enrollments", employee_id],
+          query: query,
+          page: VitableConnect::Internal::PageNumberPage,
+          model: VitableConnect::Enrollment,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [VitableConnect::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/vitable_connect/resources/employers.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+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.
+      #
+      # @overload create(address:, ein:, email:, legal_name:, name:, phone_number: nil, reference_id: nil, request_options: {})
+      #
+      # @param address [VitableConnect::Models::EmployerCreateParams::Address] Employer address
+      #
+      # @param ein [String] Employer Identification Number (format: XX-XXXXXXX)
+      #
+      # @param email [String] Email address for billing and communications
+      #
+      # @param legal_name [String] Legal business name
+      #
+      # @param name [String] Employer display name
+      #
+      # @param phone_number [String, nil] Employer phone number (10-digit US format, e.g. 5551234567)
+      #
+      # @param reference_id [String, nil] External reference ID for this employer
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::EmployerResponse]
+      #
+      # @see VitableConnect::Models::EmployerCreateParams
+      def create(params)
+        parsed, options = VitableConnect::EmployerCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/employers",
+          body: parsed,
+          model: VitableConnect::EmployerResponse,
+          options: options
+        )
+      end
+
+      # Retrieves detailed information for a specific employer by ID. The employer must
+      # belong to the authenticated organization.
+      #
+      # @overload retrieve(employer_id, request_options: {})
+      #
+      # @param employer_id [String] Unique employer identifier (empr\_\*)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::EmployerResponse]
+      #
+      # @see VitableConnect::Models::EmployerRetrieveParams
+      def retrieve(employer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/employers/%1$s", employer_id],
+          model: VitableConnect::EmployerResponse,
+          options: params[: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.
+      #
+      # @overload list(limit: nil, page: nil, request_options: {})
+      #
+      # @param limit [Integer] Items per page (default: 20, max: 100)
+      #
+      # @param page [Integer] Page number (default: 1)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::Employer>]
+      #
+      # @see VitableConnect::Models::EmployerListParams
+      def list(params = {})
+        parsed, options = VitableConnect::EmployerListParams.dump_request(params)
+        query = VitableConnect::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/employers",
+          query: query,
+          page: VitableConnect::Internal::PageNumberPage,
+          model: VitableConnect::Employer,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {VitableConnect::Models::EmployerCreateBenefitEligibilityPolicyParams} for more
+      # details.
+      #
+      # Creates a benefit eligibility policy for the specified employer.
+      #
+      # @overload create_benefit_eligibility_policy(employer_id, classification:, waiting_period:, request_options: {})
+      #
+      # @param employer_id [String] Unique employer identifier (empr\_\*)
+      #
+      # @param classification [String] Which employee classifications are eligible. One of: full_time, part_time, all
+      #
+      # @param waiting_period [String] Waiting period before eligibility. One of: first_of_following_month, 30_days, 60
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::BenefitEligibilityPolicyResponse]
+      #
+      # @see VitableConnect::Models::EmployerCreateBenefitEligibilityPolicyParams
+      def create_benefit_eligibility_policy(employer_id, params)
+        parsed, options = VitableConnect::EmployerCreateBenefitEligibilityPolicyParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/employers/%1$s/benefit-eligibility-policies", employer_id],
+          body: parsed,
+          model: VitableConnect::BenefitEligibilityPolicyResponse,
+          options: options
+        )
+      end
+
+      # Retrieves a paginated list of all employees for a specific employer. Results are
+      # paginated using page and limit parameters.
+      #
+      # @overload list_employees(employer_id, limit: nil, page: nil, request_options: {})
+      #
+      # @param employer_id [String] Unique employer identifier (empr\_\*)
+      #
+      # @param limit [Integer] Items per page (default: 20, max: 100)
+      #
+      # @param page [Integer] Page number (default: 1)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::Employee>]
+      #
+      # @see VitableConnect::Models::EmployerListEmployeesParams
+      def list_employees(employer_id, params = {})
+        parsed, options = VitableConnect::EmployerListEmployeesParams.dump_request(params)
+        query = VitableConnect::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["v1/employers/%1$s/employees", employer_id],
+          query: query,
+          page: VitableConnect::Internal::PageNumberPage,
+          model: VitableConnect::Employee,
+          options: 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.
+      #
+      # @overload submit_census_sync(employer_id, employees:, request_options: {})
+      #
+      # @param employer_id [String] Unique employer identifier (empr\_\*)
+      #
+      # @param employees [Array<VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee>]
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::EmployerSubmitCensusSyncResponse]
+      #
+      # @see VitableConnect::Models::EmployerSubmitCensusSyncParams
+      def submit_census_sync(employer_id, params)
+        parsed, options = VitableConnect::EmployerSubmitCensusSyncParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/employers/%1$s/census-sync", employer_id],
+          body: parsed,
+          model: VitableConnect::Models::EmployerSubmitCensusSyncResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [VitableConnect::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/vitable_connect/resources/enrollments.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Resources
+    # Manage benefit enrollments and elections for employees
+    class Enrollments
+      # Retrieves detailed information for a specific enrollment by ID.
+      #
+      # @overload retrieve(enrollment_id, request_options: {})
+      #
+      # @param enrollment_id [String] Unique enrollment identifier (enrl\_\*)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::EnrollmentRetrieveResponse]
+      #
+      # @see VitableConnect::Models::EnrollmentRetrieveParams
+      def retrieve(enrollment_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/enrollments/%1$s", enrollment_id],
+          model: VitableConnect::Models::EnrollmentRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [VitableConnect::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/vitable_connect/resources/webhook_events.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+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.
+      #
+      # @overload retrieve(event_id, request_options: {})
+      #
+      # @param event_id [String]
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::WebhookEventRetrieveResponse]
+      #
+      # @see VitableConnect::Models::WebhookEventRetrieveParams
+      def retrieve(event_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/webhook-events/%1$s", event_id],
+          model: VitableConnect::Models::WebhookEventRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {VitableConnect::Models::WebhookEventListParams} for more details.
+      #
+      # Retrieves a paginated list of webhook events for the authenticated organization.
+      # Supports filtering by event name, resource type, resource ID, and date range.
+      #
+      # @overload list(created_after: nil, created_before: nil, event_name: nil, limit: nil, page: nil, resource_id: nil, resource_type: nil, request_options: {})
+      #
+      # @param created_after [Time]
+      #
+      # @param created_before [Time]
+      #
+      # @param event_name [Symbol, VitableConnect::Models::WebhookEventListParams::EventName] - `enrollment.accepted` - Enrollment Accepted
+      #
+      # @param limit [Integer] Items per page (default: 20, max: 100)
+      #
+      # @param page [Integer] Page number (default: 1)
+      #
+      # @param resource_id [String]
+      #
+      # @param resource_type [Symbol, VitableConnect::Models::WebhookEventListParams::ResourceType] - `enrollment` - Enrollment
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::WebhookEvent>]
+      #
+      # @see VitableConnect::Models::WebhookEventListParams
+      def list(params = {})
+        parsed, options = VitableConnect::WebhookEventListParams.dump_request(params)
+        query = VitableConnect::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/webhook-events",
+          query: query,
+          page: VitableConnect::Internal::PageNumberPage,
+          model: VitableConnect::WebhookEvent,
+          options: 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).
+      #
+      # @overload list_deliveries(event_id, request_options: {})
+      #
+      # @param event_id [String]
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::WebhookEventListDeliveriesResponse]
+      #
+      # @see VitableConnect::Models::WebhookEventListDeliveriesParams
+      def list_deliveries(event_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/webhook-events/%1$s/deliveries", event_id],
+          model: VitableConnect::Models::WebhookEventListDeliveriesResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [VitableConnect::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/vitable_connect/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  VERSION = "0.1.0"
+end

data/lib/vitable_connect.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "vitable_connect/version"
+require_relative "vitable_connect/internal/util"
+require_relative "vitable_connect/internal/type/converter"
+require_relative "vitable_connect/internal/type/unknown"
+require_relative "vitable_connect/internal/type/boolean"
+require_relative "vitable_connect/internal/type/file_input"
+require_relative "vitable_connect/internal/type/enum"
+require_relative "vitable_connect/internal/type/union"
+require_relative "vitable_connect/internal/type/array_of"
+require_relative "vitable_connect/internal/type/hash_of"
+require_relative "vitable_connect/internal/type/base_model"
+require_relative "vitable_connect/internal/type/base_page"
+require_relative "vitable_connect/internal/type/request_parameters"
+require_relative "vitable_connect/internal"
+require_relative "vitable_connect/request_options"
+require_relative "vitable_connect/file_part"
+require_relative "vitable_connect/errors"
+require_relative "vitable_connect/internal/transport/base_client"
+require_relative "vitable_connect/internal/transport/pooled_net_requester"
+require_relative "vitable_connect/client"
+require_relative "vitable_connect/internal/page_number_page"
+require_relative "vitable_connect/models/auth_issue_access_token_params"
+require_relative "vitable_connect/models/auth_issue_access_token_response"
+require_relative "vitable_connect/models/benefit_eligibility_policy"
+require_relative "vitable_connect/models/benefit_eligibility_policy_response"
+require_relative "vitable_connect/models/benefit_eligibility_policy_retrieve_params"
+require_relative "vitable_connect/models/employee"
+require_relative "vitable_connect/models/employee_class"
+require_relative "vitable_connect/models/employee_list_enrollments_params"
+require_relative "vitable_connect/models/employee_retrieve_params"
+require_relative "vitable_connect/models/employee_retrieve_response"
+require_relative "vitable_connect/models/employer"
+require_relative "vitable_connect/models/employer_create_benefit_eligibility_policy_params"
+require_relative "vitable_connect/models/employer_create_params"
+require_relative "vitable_connect/models/employer_list_employees_params"
+require_relative "vitable_connect/models/employer_list_params"
+require_relative "vitable_connect/models/employer_response"
+require_relative "vitable_connect/models/employer_retrieve_params"
+require_relative "vitable_connect/models/employer_submit_census_sync_params"
+require_relative "vitable_connect/models/employer_submit_census_sync_response"
+require_relative "vitable_connect/models/enrollment"
+require_relative "vitable_connect/models/enrollment_retrieve_params"
+require_relative "vitable_connect/models/enrollment_retrieve_response"
+require_relative "vitable_connect/models/enrollment_status"
+require_relative "vitable_connect/models/pagination"
+require_relative "vitable_connect/models/type"
+require_relative "vitable_connect/models/webhook_event"
+require_relative "vitable_connect/models/webhook_event_list_deliveries_params"
+require_relative "vitable_connect/models/webhook_event_list_deliveries_response"
+require_relative "vitable_connect/models/webhook_event_list_params"
+require_relative "vitable_connect/models/webhook_event_retrieve_params"
+require_relative "vitable_connect/models/webhook_event_retrieve_response"
+require_relative "vitable_connect/models"
+require_relative "vitable_connect/resources/auth"
+require_relative "vitable_connect/resources/benefit_eligibility_policies"
+require_relative "vitable_connect/resources/employees"
+require_relative "vitable_connect/resources/employers"
+require_relative "vitable_connect/resources/enrollments"
+require_relative "vitable_connect/resources/webhook_events"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/vitable_connect/client.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module VitableConnect
+  class Client < VitableConnect::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    ENVIRONMENTS =
+      T.let(
+        {
+          production: "https://api.vitablehealth.com",
+          environment_1: "https://api.uat.vitablehealth.com"
+        },
+        T::Hash[Symbol, String]
+      )
+
+    # API Key or Access Token authentication using Bearer token in Authorization
+    # header. API keys use the vit*apk* prefix, access tokens use the vit*at* prefix.
+    sig { returns(String) }
+    attr_reader :api_key
+
+    # Issue short-lived access tokens for scoped API access
+    sig { returns(VitableConnect::Resources::Auth) }
+    attr_reader :auth
+
+    # Define rules that determine which employees qualify for benefits
+    sig { returns(VitableConnect::Resources::BenefitEligibilityPolicies) }
+    attr_reader :benefit_eligibility_policies
+
+    sig { returns(VitableConnect::Resources::Employees) }
+    attr_reader :employees
+
+    sig { returns(VitableConnect::Resources::Employers) }
+    attr_reader :employers
+
+    # Manage benefit enrollments and elections for employees
+    sig { returns(VitableConnect::Resources::Enrollments) }
+    attr_reader :enrollments
+
+    sig { returns(VitableConnect::Resources::WebhookEvents) }
+    attr_reader :webhook_events
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        environment: T.nilable(T.any(Symbol, String)),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # API Key or Access Token authentication using Bearer token in Authorization
+      # header. API keys use the vit*apk* prefix, access tokens use the vit*at* prefix.
+      # Defaults to `ENV["VITABLE_CONNECT_API_KEY"]`
+      api_key: ENV["VITABLE_CONNECT_API_KEY"],
+      # Specifies the environment to use for the API.
+      #
+      # Each environment maps to a different base URL:
+      #
+      # - `production` corresponds to `https://api.vitablehealth.com`
+      # - `environment_1` corresponds to `https://api.uat.vitablehealth.com`
+      environment: nil,
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["VITABLE_CONNECT_BASE_URL"]`
+      base_url: ENV["VITABLE_CONNECT_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: VitableConnect::Client::DEFAULT_MAX_RETRIES,
+      timeout: VitableConnect::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: VitableConnect::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: VitableConnect::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end