vitable-connect 0.6.0 → 1.0.0

data/lib/VitableConnect/employers/types/census_sync_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class CensusSyncRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :employees, -> { Internal::Types::Array[VitableConnect::Types::CensusSyncEmployeeRequest] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/create_employer_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class CreateEmployerRequest < Internal::Types::Model
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :legal_name, -> { String }, optional: false, nullable: false
+
+        field :ein, -> { String }, optional: false, nullable: false
+
+        field :email, -> { String }, optional: false, nullable: false
+
+        field :address, -> { VitableConnect::Types::EmployerAddressInput }, optional: false, nullable: false
+
+        field :phone_number, -> { String }, optional: true, nullable: false
+
+        field :reference_id, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/ensure_payroll_integration_email_employers_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class EnsurePayrollIntegrationEmailEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/get_benefit_plan_year_employers_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class GetBenefitPlanYearEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :benefit_plan_year_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/get_employers_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class GetEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/get_hris_employers_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class GetHrisEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/get_invoice_pdf_employers_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class GetInvoicePdfEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :invoice_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/get_payroll_access_setup_employers_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class GetPayrollAccessSetupEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/list_benefit_plan_year_enrollments_employers_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class ListBenefitPlanYearEnrollmentsEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :benefit_plan_year_id, -> { String }, optional: false, nullable: false
+
+        field :election_status, -> { VitableConnect::Types::ElectionStatusItem }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :search, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/list_benefit_plan_years_employers_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class ListBenefitPlanYearsEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/list_employees_employers_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class ListEmployeesEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :employment_status, -> { VitableConnect::Types::EmployeeStatus }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :search, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/list_employers_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class ListEmployersRequest < Internal::Types::Model
+        field :benefit_family, -> { VitableConnect::Types::BenefitFamilyParamItem }, optional: true, nullable: false
+
+        field :benefit_lifecycle_stage, -> { VitableConnect::Types::BenefitLifecycleStageItem }, optional: true, nullable: false
+
+        field :hris_provider, -> { String }, optional: true, nullable: false
+
+        field :hris_status, -> { VitableConnect::Types::HrisStatusItem }, optional: true, nullable: false
+
+        field :include_cancelled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :search, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/list_invoices_employers_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class ListInvoicesEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :offset, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/list_payroll_deduction_statements_employers_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class ListPayrollDeductionStatementsEmployersRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/submit_payroll_access_setup_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class SubmitPayrollAccessSetupRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :employees_in_payroll_acknowledged, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :payroll_data_impacts_eligibility_acknowledged, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :classifications_accurate, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :classification_correction_source, -> { VitableConnect::Types::ClassificationCorrectionSource }, optional: true, nullable: false
+
+        field :misclassified_employee_names, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :remaining_employee_action, -> { VitableConnect::Types::RemainingEmployeeAction }, optional: true, nullable: false
+
+        field :all_benefit_eligible_employees_present, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :missing_employee_resolution, -> { VitableConnect::Types::MissingEmployeeResolution }, optional: true, nullable: false
+
+        field :is_controlled_group, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :same_payroll_covers_other_eins, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :access_method, -> { VitableConnect::Types::AccessMethod }, optional: false, nullable: false
+
+        field :login_url, -> { String }, optional: true, nullable: false
+
+        field :username, -> { String }, optional: true, nullable: false
+
+        field :phone, -> { String }, optional: true, nullable: false
+
+        field :password, -> { String }, optional: true, nullable: false
+
+        field :integration_confirmed, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :has_additional_payroll_system, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :additional_access_method, -> { VitableConnect::Types::AdditionalAccessMethod }, optional: true, nullable: false
+
+        field :additional_login_url, -> { String }, optional: true, nullable: false
+
+        field :additional_username, -> { String }, optional: true, nullable: false
+
+        field :additional_phone, -> { String }, optional: true, nullable: false
+
+        field :additional_password, -> { String }, optional: true, nullable: false
+
+        field :additional_integration_confirmed, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/update_employer_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class UpdateEmployerRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :name, -> { String }, optional: true, nullable: false
+
+        field :legal_name, -> { String }, optional: true, nullable: false
+
+        field :address, -> { VitableConnect::Types::UpdateEmployerAddressInput }, optional: true, nullable: false
+
+        field :active, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/employers/types/update_employer_settings_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Employers
+    module Types
+      class UpdateEmployerSettingsRequest < Internal::Types::Model
+        field :employer_id, -> { String }, optional: false, nullable: false
+
+        field :pay_frequency, -> { VitableConnect::Types::DeductionFrequency }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/enrollments/client.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Enrollments
+    class Client
+      # @param client [VitableConnect::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieves a single enrollment: the employee and employer it belongs to, the benefit product, its status, the
+      # coverage period, the employee payroll deduction and employer contribution, and the enrolled plan's Summary of
+      # Benefits and Coverage document when one is on file. An enrollment the caller cannot reach is indistinguishable
+      # from one that does not exist.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [VitableConnect::Types::EnrollmentID] :enrollment_id
+      #
+      # @example
+      #   client.enrollments.get(enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ")
+      #
+      # @return [VitableConnect::Types::EnrollmentResponse]
+      def get(request_options: {}, **params)
+        params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        request = VitableConnect::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/enrollments/#{URI.encode_uri_component(params[:enrollment_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise VitableConnect::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          VitableConnect::Types::EnrollmentResponse.load(response.body)
+        else
+          error_class = VitableConnect::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Closes the targeted enrollment and creates a new unanswered enrollment for the same member and plan year. VPC
+      # never requires a qualifying life event; other products require an accepted, member-owned event outside open
+      # enrollment. User-backed callers must provide a reason; it is optional for organization API-key callers. Tenant
+      # mismatches return a non-disclosing 404 before the request body is validated.
+      #
+      # @param request_options [Hash]
+      # @param params [VitableConnect::Enrollments::Types::ReissueEnrollmentRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [VitableConnect::Types::EnrollmentID] :enrollment_id
+      #
+      # @example
+      #   client.enrollments.reissue(
+      #     enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
+      #     reason: "Member needs a new election after a qualifying event.",
+      #     ticket_number: "BPT-1234",
+      #     qualifying_life_event_id: "qle_AAAAAAAAAAAAAAAAAAAAAQ"
+      #   )
+      #
+      # @return [VitableConnect::Types::ReissueEnrollmentResponse]
+      def reissue(request_options: {}, **params)
+        params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        request_data = VitableConnect::Enrollments::Types::ReissueEnrollmentRequest.new(params).to_h
+        non_body_param_names = %w[enrollment_id]
+        body = request_data.except(*non_body_param_names)
+
+        request = VitableConnect::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/enrollments/#{URI.encode_uri_component(params[:enrollment_id].to_s)}/reissue",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise VitableConnect::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          VitableConnect::Types::ReissueEnrollmentResponse.load(response.body)
+        else
+          error_class = VitableConnect::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is
+      # required unless the plan is VPC or ICHRA. User-backed callers must provide a reason; it is optional for
+      # organization API-key callers. API keys may act across the caller organization's book. Tenant mismatches return
+      # the same non-disclosing 404 before the request body is validated.
+      #
+      # @param request_options [Hash]
+      # @param params [VitableConnect::Enrollments::Types::TerminateEnrollmentRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [VitableConnect::Types::EnrollmentID] :enrollment_id
+      #
+      # @example
+      #   client.enrollments.terminate(
+      #     enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ",
+      #     reason: "Member requested coverage termination after a qualifying event.",
+      #     ticket_number: "BPT-1234",
+      #     qualifying_life_event_id: "qle_AAAAAAAAAAAAAAAAAAAAAQ"
+      #   )
+      #
+      # @return [untyped]
+      def terminate(request_options: {}, **params)
+        params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        request_data = VitableConnect::Enrollments::Types::TerminateEnrollmentRequest.new(params).to_h
+        non_body_param_names = %w[enrollment_id]
+        body = request_data.except(*non_body_param_names)
+
+        request = VitableConnect::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/enrollments/#{URI.encode_uri_component(params[:enrollment_id].to_s)}/terminate",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise VitableConnect::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = VitableConnect::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+    end
+  end
+end

data/lib/VitableConnect/enrollments/types/get_enrollments_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Enrollments
+    module Types
+      class GetEnrollmentsRequest < Internal::Types::Model
+        field :enrollment_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/enrollments/types/reissue_enrollment_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Enrollments
+    module Types
+      class ReissueEnrollmentRequest < Internal::Types::Model
+        field :enrollment_id, -> { String }, optional: false, nullable: false
+
+        field :reason, -> { String }, optional: true, nullable: false
+
+        field :ticket_number, -> { String }, optional: true, nullable: false
+
+        field :qualifying_life_event_id, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/enrollments/types/terminate_enrollment_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Enrollments
+    module Types
+      class TerminateEnrollmentRequest < Internal::Types::Model
+        field :enrollment_id, -> { String }, optional: false, nullable: false
+
+        field :reason, -> { String }, optional: true, nullable: false
+
+        field :ticket_number, -> { String }, optional: true, nullable: false
+
+        field :qualifying_life_event_id, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/environment.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  class Environment
+    PRODUCTION = "https://api.vitablehealth.com"
+
+    UAT = "https://api.uat.vitablehealth.com"
+  end
+end

data/lib/VitableConnect/errors/api_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Errors
+    class ApiError < StandardError
+    end
+  end
+end

data/lib/VitableConnect/errors/client_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Errors
+    class ClientError < ResponseError
+    end
+
+    class UnauthorizedError < ClientError
+    end
+
+    class ForbiddenError < ClientError
+    end
+
+    class NotFoundError < ClientError
+    end
+  end
+end

data/lib/VitableConnect/errors/redirect_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Errors
+    class RedirectError < ResponseError
+    end
+  end
+end

data/lib/VitableConnect/errors/response_error.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Errors
+    class ResponseError < ApiError
+      attr_reader :code
+
+      def initialize(msg, code:)
+        @code = code
+        super(msg)
+      end
+
+      def inspect
+        "#<#{self.class.name} @code=#{code} @body=#{message}>"
+      end
+
+      # Returns the most appropriate error class for the given code.
+      #
+      # @return [Class]
+      def self.subclass_for_code(code)
+        case code
+        when 300..399
+          RedirectError
+        when 401
+          UnauthorizedError
+        when 403
+          ForbiddenError
+        when 404
+          NotFoundError
+        when 400..499
+          ClientError
+        when 503
+          ServiceUnavailableError
+        when 500..599
+          ServerError
+        else
+          ResponseError
+        end
+      end
+    end
+  end
+end

data/lib/VitableConnect/errors/server_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Errors
+    class ServerError < ResponseError
+    end
+
+    class ServiceUnavailableError < ApiError
+    end
+  end
+end

data/lib/VitableConnect/errors/timeout_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Errors
+    class TimeoutError < ApiError
+    end
+  end
+end