vitable-connect 0.6.0 → 1.0.0

data/lib/VitableConnect/types/invoice.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class Invoice < Internal::Types::Model
+      field :invoice_id, -> { String }, optional: false, nullable: false
+
+      field :period, -> { String }, optional: false, nullable: true
+
+      field :total, -> { Integer }, optional: false, nullable: true
+
+      field :status, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/invoice_id.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module InvoiceID
+      # InvoiceID 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/invoices_cursor_pagination.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class InvoicesCursorPagination < Internal::Types::Model
+      field :next_offset, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/limit.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module Limit
+      # Limit is an alias for Integer
+
+      # @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/list_webhook_event_deliveries_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class ListWebhookEventDeliveriesResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::WebhookDelivery] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/marital_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module MaritalStatus
+      extend VitableConnect::Internal::Types::Enum
+
+      SINGLE = "Single"
+      MARRIED = "Married"
+    end
+  end
+end

data/lib/VitableConnect/types/member.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # A member's profile: identity, contact details, address, demographics, and onboarding status.
+    class Member < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :first_name, -> { String }, optional: false, nullable: false
+
+      field :last_name, -> { String }, optional: false, nullable: false
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :phone, -> { String }, optional: true, nullable: false
+
+      field :address, -> { VitableConnect::Types::MemberAddress }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :middle_name, -> { String }, optional: true, nullable: false
+
+      field :suffix, -> { VitableConnect::Types::NameSuffix }, optional: true, nullable: false
+
+      field :date_of_birth, -> { String }, optional: false, nullable: false
+
+      field :age, -> { Integer }, optional: false, nullable: false
+
+      field :sex_at_birth, -> { VitableConnect::Types::SexAtBirth }, optional: true, nullable: false
+
+      field :gender, -> { VitableConnect::Types::Gender }, optional: true, nullable: false
+
+      field :preferred_language, -> { VitableConnect::Types::PreferredLanguage }, optional: true, nullable: false
+
+      field :tobacco_status, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :marital_status, -> { VitableConnect::Types::MaritalStatus }, optional: true, nullable: false
+
+      field :status, -> { VitableConnect::Types::MemberStatus }, optional: true, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_address.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class MemberAddress < 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/member_dependents_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Unpaginated ``{"data": [...]}`` list of member dependents.
+    class MemberDependentsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::MemberLegalDependent] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_digital_benefit_cards_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Unpaginated ``{"data": [...]}`` list of member digital benefit cards.
+    class MemberDigitalBenefitCardsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::DigitalBenefitCard] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_employments_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Unpaginated ``{"data": [...]}`` list of member employments.
+    class MemberEmploymentsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::Employee] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_enrollment.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Wire serializer for :class:`MemberEnrollmentDTO` (one benefit enrollment row).
+    class MemberEnrollment < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :employer_id, -> { String }, optional: false, nullable: false
+
+      field :benefit_plan_year_id, -> { String }, optional: false, nullable: false
+
+      field :benefit_type, -> { VitableConnect::Types::Category }, optional: false, nullable: false
+
+      field :product_code, -> { VitableConnect::Types::ProductCode }, optional: false, nullable: false
+
+      field :requires_qle_for_reissue, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :product_name, -> { String }, optional: false, nullable: false
+
+      field :employer_name, -> { String }, optional: false, nullable: false
+
+      field :carrier_name, -> { String }, optional: true, nullable: false
+
+      field :plan_name, -> { String }, optional: true, nullable: false
+
+      field :tier_name, -> { String }, optional: true, nullable: false
+
+      field :employee_deduction_in_cents, -> { Integer }, optional: true, nullable: false
+
+      field :employer_contribution_in_cents, -> { Integer }, optional: true, nullable: false
+
+      field :premium_in_cents, -> { Integer }, optional: true, nullable: false
+
+      field :coverage_start, -> { String }, optional: true, nullable: false
+
+      field :coverage_end, -> { String }, optional: true, nullable: false
+
+      field :cancelled_date, -> { String }, optional: false, nullable: true
+
+      field :plan_year_coverage_end, -> { String }, optional: false, nullable: true
+
+      field :issued_date, -> { String }, optional: false, nullable: false
+
+      field :enrollment_window_start, -> { String }, optional: false, nullable: false
+
+      field :enrollment_window_end, -> { String }, optional: true, nullable: false
+
+      field :election_status, -> { VitableConnect::Types::PlanYearEnrollmentElectionStatus }, optional: false, nullable: false
+
+      field :policy_status, -> { VitableConnect::Types::PlanYearEnrollmentPolicyStatus }, optional: false, nullable: true
+
+      field :in_last_month_of_coverage, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :is_within_enrollment_window, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_enrollments_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Unpaginated ``{"data": [...]}`` list of member enrollments.
+    class MemberEnrollmentsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::MemberEnrollment] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_id.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module MemberID
+      # MemberID 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/member_legal_dependent.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Wire serializer for :class:`MemberLegalDependentDTO` (one legal-dependent row).
+    class MemberLegalDependent < Internal::Types::Model
+      field :member_id, -> { String }, optional: true, nullable: false
+
+      field :primary_member_id, -> { String }, optional: true, nullable: false
+
+      field :first_name, -> { String }, optional: false, nullable: false
+
+      field :last_name, -> { String }, optional: false, nullable: false
+
+      field :relationship, -> { VitableConnect::Types::Relationship }, optional: false, nullable: false
+
+      field :date_of_birth, -> { String }, optional: false, nullable: false
+
+      field :age, -> { Integer }, optional: false, nullable: false
+
+      field :sex_at_birth, -> { VitableConnect::Types::SexAtBirth }, optional: true, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_list_item.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # A member in the organization's directory: identity, contact details, address, and join date.
+    class MemberListItem < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :first_name, -> { String }, optional: false, nullable: false
+
+      field :last_name, -> { String }, optional: false, nullable: false
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :phone, -> { String }, optional: true, nullable: false
+
+      field :address, -> { VitableConnect::Types::MemberAddress }, optional: true, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Paginated list response containing member resources.
+    class MemberListResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::MemberListItem] }, optional: false, nullable: false
+
+      field :pagination, -> { VitableConnect::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_qualifying_life_event.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class MemberQualifyingLifeEvent < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :event_type, -> { VitableConnect::Types::QualifyingLifeEventType }, optional: false, nullable: false
+
+      field :event_type_label, -> { String }, optional: false, nullable: false
+
+      field :other_event, -> { String }, optional: false, nullable: true
+
+      field :status, -> { VitableConnect::Types::QualifyingLifeEventStatus }, optional: false, nullable: false
+
+      field :submitted_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_qualifying_life_event_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Paginated list response containing member qualifying life event resources.
+    class MemberQualifyingLifeEventListResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::MemberQualifyingLifeEvent] }, optional: false, nullable: false
+
+      field :pagination, -> { VitableConnect::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/member_response.rb

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

data/lib/VitableConnect/types/member_search.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module MemberSearch
+      # MemberSearch 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/member_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module MemberStatus
+      extend VitableConnect::Internal::Types::Enum
+
+      ONBOARDED = "onboarded"
+      PENDING_ONBOARDING = "pending_onboarding"
+    end
+  end
+end

data/lib/VitableConnect/types/missing_employee_resolution.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module MissingEmployeeResolution
+      extend VitableConnect::Internal::Types::Enum
+
+      EMAIL_CENSUS = "EMAIL_CENSUS"
+      SECOND_SYSTEM_ACCESS = "SECOND_SYSTEM_ACCESS"
+    end
+  end
+end

data/lib/VitableConnect/types/name_suffix.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module NameSuffix
+      extend VitableConnect::Internal::Types::Enum
+
+      SR = "Sr"
+      JR = "Jr"
+      I = "I"
+      II = "II"
+      III = "III"
+      IV = "IV"
+      V = "V"
+    end
+  end
+end

data/lib/VitableConnect/types/offset.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module Offset
+      # Offset is an alias for Object
+
+      # @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/operation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module Operation
+      extend VitableConnect::Internal::Types::Enum
+
+      ADD = "add"
+      REMOVE = "remove"
+    end
+  end
+end

data/lib/VitableConnect/types/organization.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class Organization < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :type, -> { VitableConnect::Types::OrganizationType }, optional: false, nullable: true
+
+      field :idp_org_id, -> { String }, optional: false, nullable: true
+
+      field :idp_provider, -> { VitableConnect::Types::IdpProvider }, optional: false, nullable: true
+
+      field :super_in, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/organization_employer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # One employer row of the organization's book (list projection).
+    #
+    # Carries the enriched/computed columns (enrollment roll-up, benefit-family tags, HRIS connection,
+    # benefit-lifecycle stage) alongside the flat CRM fields of the underlying employer (legal name,
+    # EIN, contact, address, timestamps) for parity with the legacy ``Employer`` contract.
+    class OrganizationEmployer < Internal::Types::Model
+      field :employer_id, -> { String }, optional: false, nullable: false
+
+      field :organization_id, -> { String }, optional: false, nullable: true
+
+      field :reference_id, -> { String }, optional: false, nullable: true
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :legal_name, -> { String }, optional: false, nullable: true
+
+      field :ein, -> { String }, optional: false, nullable: true
+
+      field :email, -> { String }, optional: false, nullable: true
+
+      field :phone_number, -> { String }, optional: false, nullable: true
+
+      field :active, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :address, -> { VitableConnect::Types::Address }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+
+      field :enrollment_rate_summary, -> { VitableConnect::Types::EnrollmentRateSummary }, optional: false, nullable: false
+
+      field :benefit_families, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :hris_status, -> { VitableConnect::Types::EmployerHrisStatus }, optional: false, nullable: true
+
+      field :benefit_lifecycle_stage, -> { VitableConnect::Types::EmployerBenefitLifecycleStage }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/organization_employer_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Paginated list response containing organization employer resources.
+    class OrganizationEmployerListResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::OrganizationEmployer] }, optional: false, nullable: false
+
+      field :pagination, -> { VitableConnect::Types::Pagination }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/organization_hris_provider.rb

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

data/lib/VitableConnect/types/organization_hris_providers_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Unpaginated ``{"data": [...]}`` list of organization hris providers.
+    class OrganizationHrisProvidersResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::OrganizationHrisProvider] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/organization_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module OrganizationType
+      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/organizations_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Envelope for the caller's organization memberships (paginated).
+    class OrganizationsListResponse < Internal::Types::Model
+      field :organizations, -> { Internal::Types::Array[VitableConnect::Types::Organization] }, optional: false, nullable: false
+
+      field :total, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/page.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module Page
+      # Page is an alias for Integer
+
+      # @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