vitable-connect 0.5.0 → 1.0.0

data/lib/VitableConnect/plans/types/list_plans_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Plans
+    module Types
+      class ListPlansRequest < Internal::Types::Model
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/VitableConnect/types/access_method.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module AccessMethod
+      extend VitableConnect::Internal::Types::Enum
+
+      SELF_SETUP = "SELF_SETUP"
+      NEEDS_HELP = "NEEDS_HELP"
+    end
+  end
+end

data/lib/VitableConnect/types/access_token_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class AccessTokenResponse < Internal::Types::Model
+      field :access_token, -> { String }, optional: false, nullable: false
+
+      field :token_type, -> { String }, optional: false, nullable: false
+
+      field :expires_in, -> { Integer }, optional: false, nullable: false
+
+      field :bound_entity, -> { VitableConnect::Types::BoundEntityResponse }, optional: true, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/additional_access_method.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module AdditionalAccessMethod
+      extend VitableConnect::Internal::Types::Enum
+
+      SELF_SETUP = "SELF_SETUP"
+      NEEDS_HELP = "NEEDS_HELP"
+    end
+  end
+end

data/lib/VitableConnect/types/address.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Shared read serializer for a postal address on public API responses.
+    #
+    # One definition for the address block every public resource emits (employer, employee, …), so the
+    # 5-field shape isn't hand-rolled per endpoint. Read-only: it renders an already-built address
+    # value object (e.g. ``AddressDVO``) whose attributes map 1:1 to these fields.
+    class Address < Internal::Types::Model
+      field :address_line1, -> { String }, optional: false, nullable: false, api_name: "address_line_1"
+
+      field :address_line2, -> { String }, optional: false, nullable: true, api_name: "address_line_2"
+
+      field :city, -> { String }, optional: false, nullable: false
+
+      field :state, -> { String }, optional: false, nullable: false
+
+      field :zipcode, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/address_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class AddressRequest < Internal::Types::Model
+      field :address_line1, -> { String }, optional: false, nullable: false, api_name: "address_line_1"
+
+      field :address_line2, -> { String }, optional: true, nullable: false, api_name: "address_line_2"
+
+      field :city, -> { String }, optional: false, nullable: false
+
+      field :state, -> { String }, optional: false, nullable: false
+
+      field :zipcode, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_family.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module BenefitFamily
+      extend VitableConnect::Internal::Types::Enum
+
+      MEC = "mec"
+      MVP = "mvp"
+      ICHRA = "ichra"
+      VPC = "vpc"
+      DENTAL = "dental"
+      VISION = "vision"
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_family_param_item.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module BenefitFamilyParamItem
+      extend VitableConnect::Internal::Types::Enum
+
+      MEC = "mec"
+      MVP = "mvp"
+      ICHRA = "ichra"
+      VPC = "vpc"
+      DENTAL = "dental"
+      VISION = "vision"
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_lifecycle_stage_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module BenefitLifecycleStageItem
+      extend VitableConnect::Internal::Types::Enum
+
+      OPEN_ENROLLMENT = "open_enrollment"
+      RENEWAL = "renewal"
+      ACTIVE = "active"
+      ONBOARDING = "onboarding"
+      CANCELLED = "cancelled"
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_plan_network.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class BenefitPlanNetwork < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :logo, -> { String }, optional: false, nullable: true
+
+      field :address, -> { VitableConnect::Types::Address }, optional: false, nullable: false
+
+      field :edi, -> { String }, optional: true, nullable: false
+
+      field :website, -> { String }, optional: false, nullable: false
+
+      field :phone, -> { String }, optional: false, nullable: false
+
+      field :member_website, -> { String }, optional: true, nullable: false
+
+      field :member_phone, -> { String }, optional: false, nullable: true
+
+      field :provider_website, -> { String }, optional: true, nullable: false
+
+      field :provider_phone, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_plan_year_detail.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # One plan year, detail view.
+    #
+    # Standalone (no shared base) so the exact detail payload is readable in one place; the list
+    # serializer is a separate class even where fields overlap. Detail carries the SPD link and omits
+    # the list-only ``is_current`` flag.
+    class BenefitPlanYearDetail < Internal::Types::Model
+      field :benefit_plan_year_id, -> { String }, optional: false, nullable: false
+
+      field :benefit_id, -> { String }, optional: false, nullable: false
+
+      field :year, -> { Integer }, optional: false, nullable: false
+
+      field :family, -> { VitableConnect::Types::BenefitFamily }, optional: false, nullable: false
+
+      field :product_name, -> { String }, optional: false, nullable: false
+
+      field :carrier, -> { String }, optional: false, nullable: true
+
+      field :network_names, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :premium_in_cents, -> { Integer }, optional: false, nullable: true
+
+      field :employee_contribution, -> { VitableConnect::Types::ContributionRange }, optional: false, nullable: true
+
+      field :employer_contribution, -> { VitableConnect::Types::ContributionRange }, optional: false, nullable: true
+
+      field :status, -> { VitableConnect::Types::BenefitStatus }, optional: false, nullable: false
+
+      field :coverage_start, -> { String }, optional: false, nullable: false
+
+      field :coverage_end, -> { String }, optional: false, nullable: true
+
+      field :open_enrollment_start, -> { String }, optional: false, nullable: false
+
+      field :open_enrollment_end, -> { String }, optional: false, nullable: true
+
+      field :offered_states, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :enrollment_rate, -> { VitableConnect::Types::EnrollmentRate }, optional: false, nullable: false
+
+      field :spd_file_url, -> { String }, optional: false, nullable: true
+
+      field :contribution_strategy, -> { VitableConnect::Types::ContributionStrategy }, optional: false, nullable: false
+
+      field :eligibility_policy, -> { VitableConnect::Types::EligibilityPolicy }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_plan_year_id.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module BenefitPlanYearID
+      # BenefitPlanYearID is an alias for String
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_plan_year_list.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # One plan year, list view.
+    #
+    # Standalone (no shared base) so the exact list payload is readable in one place; the detail
+    # serializer is a separate class even where fields overlap.
+    class BenefitPlanYearList < Internal::Types::Model
+      field :benefit_plan_year_id, -> { String }, optional: false, nullable: false
+
+      field :benefit_id, -> { String }, optional: false, nullable: false
+
+      field :year, -> { Integer }, optional: false, nullable: false
+
+      field :family, -> { VitableConnect::Types::BenefitFamily }, optional: false, nullable: false
+
+      field :product_name, -> { String }, optional: false, nullable: false
+
+      field :carrier, -> { String }, optional: false, nullable: true
+
+      field :network_names, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :premium_in_cents, -> { Integer }, optional: false, nullable: true
+
+      field :employee_contribution, -> { VitableConnect::Types::ContributionRange }, optional: false, nullable: true
+
+      field :employer_contribution, -> { VitableConnect::Types::ContributionRange }, optional: false, nullable: true
+
+      field :status, -> { VitableConnect::Types::BenefitStatus }, optional: false, nullable: false
+
+      field :coverage_start, -> { String }, optional: false, nullable: false
+
+      field :coverage_end, -> { String }, optional: false, nullable: true
+
+      field :open_enrollment_start, -> { String }, optional: false, nullable: false
+
+      field :open_enrollment_end, -> { String }, optional: false, nullable: true
+
+      field :offered_states, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :is_current, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :enrollment_rate, -> { VitableConnect::Types::EnrollmentRate }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module BenefitStatus
+      extend VitableConnect::Internal::Types::Enum
+
+      ACTIVE = "active"
+      UPCOMING = "upcoming"
+      OPEN_ENROLLMENT = "open_enrollment"
+      INACTIVE = "inactive"
+    end
+  end
+end

data/lib/VitableConnect/types/benefit_summary.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class BenefitSummary < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :product_code, -> { VitableConnect::Types::ProductCode }, optional: false, nullable: false
+
+      field :category, -> { VitableConnect::Types::Category }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/bound_entity.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class BoundEntity < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :type, -> { VitableConnect::Types::BoundEntityType }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/bound_entity_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class BoundEntityResponse < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :type, -> { VitableConnect::Types::BoundEntityType }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/bound_entity_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module BoundEntityType
+      extend VitableConnect::Internal::Types::Enum
+
+      EMPLOYER = "employer"
+      EMPLOYEE = "employee"
+    end
+  end
+end

data/lib/VitableConnect/types/card_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module CardType
+      extend VitableConnect::Internal::Types::Enum
+
+      MEDICAL = "medical"
+      DENTAL = "dental"
+      VISION = "vision"
+      RX = "rx"
+    end
+  end
+end

data/lib/VitableConnect/types/category.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module Category
+      extend VitableConnect::Internal::Types::Enum
+
+      MEDICAL = "Medical"
+      DENTAL = "Dental"
+      VISION = "Vision"
+      HOSPITAL = "Hospital"
+    end
+  end
+end

data/lib/VitableConnect/types/census_sync_detail_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Response containing a single census sync detail resource.
+    class CensusSyncDetailResponse < Internal::Types::Model
+      field :data, -> { VitableConnect::Types::CensusSyncResponse }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/census_sync_employee_address_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class CensusSyncEmployeeAddressRequest < Internal::Types::Model
+      field :address_line1, -> { String }, optional: false, nullable: false, api_name: "address_line_1"
+
+      field :address_line2, -> { String }, optional: true, nullable: false, api_name: "address_line_2"
+
+      field :city, -> { String }, optional: false, nullable: false
+
+      field :state, -> { VitableConnect::Types::State }, optional: false, nullable: false
+
+      field :zipcode, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/census_sync_employee_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class CensusSyncEmployeeRequest < Internal::Types::Model
+      field :reference_id, -> { String }, optional: true, nullable: false
+
+      field :first_name, -> { String }, optional: false, nullable: false
+
+      field :last_name, -> { String }, optional: false, nullable: false
+
+      field :date_of_birth, -> { String }, optional: false, nullable: false
+
+      field :email, -> { String }, optional: false, nullable: false
+
+      field :phone, -> { String }, optional: true, nullable: false
+
+      field :address, -> { VitableConnect::Types::CensusSyncEmployeeAddressRequest }, optional: true, nullable: false
+
+      field :start_date, -> { String }, optional: true, nullable: false
+
+      field :employee_class, -> { VitableConnect::Types::EmployeeClass }, optional: true, nullable: false
+
+      field :compensation_type, -> { VitableConnect::Types::CompensationType }, optional: true, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/census_sync_response.rb

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

data/lib/VitableConnect/types/classification_correction_source.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module ClassificationCorrectionSource
+      extend VitableConnect::Internal::Types::Enum
+
+      ENTER_NAMES = "ENTER_NAMES"
+      EMAIL_LIST = "EMAIL_LIST"
+    end
+  end
+end

data/lib/VitableConnect/types/compensation_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module CompensationType
+      extend VitableConnect::Internal::Types::Enum
+
+      SALARY = "Salary"
+      HOURLY = "Hourly"
+    end
+  end
+end

data/lib/VitableConnect/types/contribution_class_compensation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module ContributionClassCompensation
+      extend VitableConnect::Internal::Types::Enum
+
+      UNSPECIFIED = "Unspecified"
+      SALARY = "Salary"
+      HOURLY = "Hourly"
+    end
+  end
+end

data/lib/VitableConnect/types/contribution_class_employment.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module ContributionClassEmployment
+      extend VitableConnect::Internal::Types::Enum
+
+      UNSPECIFIED = "Unspecified"
+      FULL_TIME = "Full Time"
+      PART_TIME = "Part Time"
+      TEMPORARY = "Temporary"
+      SEASONAL = "Seasonal"
+    end
+  end
+end

data/lib/VitableConnect/types/contribution_class_location.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module ContributionClassLocation
+      extend VitableConnect::Internal::Types::Enum
+
+      UNSPECIFIED = "Unspecified"
+      STATE = "State"
+    end
+  end
+end

data/lib/VitableConnect/types/contribution_range.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class ContributionRange < Internal::Types::Model
+      field :min_cents, -> { Integer }, optional: false, nullable: false
+
+      field :max_cents, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/contribution_strategy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # How the plan year prices contributions: exactly one collection is populated, determined by the
+    # plan year's ``family`` (ICHRA vs tier-priced).
+    class ContributionStrategy < Internal::Types::Model
+      field :ichra_contribution_classes, -> { Internal::Types::Array[VitableConnect::Types::IchraContributionClass] }, optional: false, nullable: false
+
+      field :contribution_tiers, -> { Internal::Types::Array[VitableConnect::Types::ContributionTier] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/contribution_tier.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # One non-ICHRA coverage tier, mirroring the internal configuration ``CompanyBenefitPlanTierCostDTO``
+    # minus the tier-cost id, ``pepm`` and ``pepm_per_dependent``; ``benefit_plan_id`` is the prefixed
+    # ``bpln_*`` form rather than a raw UUID.
+    class ContributionTier < Internal::Types::Model
+      field :benefit_plan_id, -> { String }, optional: false, nullable: false
+
+      field :benefit_plan_name, -> { String }, optional: false, nullable: false
+
+      field :benefit_plan_tier_name, -> { String }, optional: false, nullable: false
+
+      field :coverage_tier, -> { VitableConnect::Types::CoverageTier }, optional: false, nullable: false
+
+      field :cost, -> { Integer }, optional: false, nullable: false
+
+      field :cost_per_dependent, -> { Integer }, optional: false, nullable: false
+
+      field :dependents_required_in, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :spouse_required_in, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/coverage_tier.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module CoverageTier
+      extend VitableConnect::Internal::Types::Enum
+
+      UNSPECIFIED = "Unspecified"
+      EE = "EE"
+      ES = "ES"
+      EC = "EC"
+      EF = "EF"
+    end
+  end
+end

data/lib/VitableConnect/types/create_organization_request_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module CreateOrganizationRequestType
+      extend VitableConnect::Internal::Types::Enum
+
+      BROKERAGE = "BROKERAGE"
+      TPA = "TPA"
+      GENERAL_AGENT = "GENERAL_AGENT"
+      CHANNEL_PARTNER = "CHANNEL_PARTNER"
+      CONSULTING_FIRM = "CONSULTING_FIRM"
+      API_PLATFORM = "API_PLATFORM"
+    end
+  end
+end

data/lib/VitableConnect/types/created_after.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module CreatedAfter
+      # CreatedAfter is an alias for String
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end