vitable-connect 0.5.0 → 1.0.0

data/lib/VitableConnect/types/employer_search.rb

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

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

data/lib/VitableConnect/types/employer_settings_response.rb

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

data/lib/VitableConnect/types/enrollment.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # One enrollment as it appears in a list row.
+    class Enrollment < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :employee_id, -> { String }, optional: false, nullable: false
+
+      field :employer_id, -> { String }, optional: false, nullable: false
+
+      field :benefit, -> { VitableConnect::Types::BenefitSummary }, optional: false, nullable: false
+
+      field :status, -> { VitableConnect::Types::EnrollmentStatus }, optional: false, nullable: false
+
+      field :coverage_start, -> { String }, optional: false, nullable: false
+
+      field :coverage_end, -> { String }, optional: false, nullable: true
+
+      field :employee_deduction_in_cents, -> { Integer }, optional: false, nullable: true
+
+      field :employer_contribution_in_cents, -> { Integer }, optional: false, nullable: true
+
+      field :answered_at, -> { String }, optional: false, nullable: true
+
+      field :terminated_at, -> { String }, optional: false, nullable: true
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/enrollment_detail.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # A single enrollment, including the enrolled plan's documents.
+    #
+    # The plan documents are resolved one enrollment at a time and are therefore not part of the
+    # list row.
+    class EnrollmentDetail < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :employee_id, -> { String }, optional: false, nullable: false
+
+      field :employer_id, -> { String }, optional: false, nullable: false
+
+      field :benefit, -> { VitableConnect::Types::BenefitSummary }, optional: false, nullable: false
+
+      field :status, -> { VitableConnect::Types::EnrollmentStatus }, optional: false, nullable: false
+
+      field :coverage_start, -> { String }, optional: false, nullable: false
+
+      field :coverage_end, -> { String }, optional: false, nullable: true
+
+      field :employee_deduction_in_cents, -> { Integer }, optional: false, nullable: true
+
+      field :employer_contribution_in_cents, -> { Integer }, optional: false, nullable: true
+
+      field :answered_at, -> { String }, optional: false, nullable: true
+
+      field :terminated_at, -> { String }, optional: false, nullable: true
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+
+      field :sbc_url, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/enrollment_id.rb

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

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

data/lib/VitableConnect/types/enrollment_rate.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EnrollmentRate < Internal::Types::Model
+      field :eligible, -> { Integer }, optional: false, nullable: false
+
+      field :enrolled, -> { Integer }, optional: false, nullable: false
+
+      field :percentage, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/enrollment_rate_summary.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class EnrollmentRateSummary < Internal::Types::Model
+      field :eligible, -> { Integer }, optional: false, nullable: false
+
+      field :enrolled, -> { Integer }, optional: false, nullable: false
+
+      field :percentage, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/enrollment_response.rb

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

data/lib/VitableConnect/types/enrollment_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EnrollmentStatus
+      extend VitableConnect::Internal::Types::Enum
+
+      PENDING = "pending"
+      ENROLLED = "enrolled"
+      WAIVED = "waived"
+      INACTIVE = "inactive"
+    end
+  end
+end

data/lib/VitableConnect/types/error_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class ErrorResponse < Internal::Types::Model
+      field :timestamp, -> { String }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+
+      field :error, -> { String }, optional: false, nullable: false
+
+      field :app_error_code, -> { String }, optional: true, nullable: false
+
+      field :trace_id, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/event_id.rb

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module EventName
+      extend VitableConnect::Internal::Types::Enum
+
+      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"
+    end
+  end
+end

data/lib/VitableConnect/types/gender.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module Gender
+      extend VitableConnect::Internal::Types::Enum
+
+      MALE = "Male"
+      FEMALE = "Female"
+      TRANSGENDER = "Transgender"
+      NON_BINARY = "Non-binary"
+      PREFER_NOT_TO_RESPOND = "Prefer not to respond"
+    end
+  end
+end

data/lib/VitableConnect/types/grant_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module GrantType
+      extend VitableConnect::Internal::Types::Enum
+
+      CLIENT_CREDENTIALS = "client_credentials"
+    end
+  end
+end

data/lib/VitableConnect/types/group.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class Group < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :organization_id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :external_reference_id, -> { String }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: true
+
+      field :updated_at, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/group_id.rb

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

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

data/lib/VitableConnect/types/group_member_sync_detail_response.rb

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

data/lib/VitableConnect/types/group_member_sync_failure.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class GroupMemberSyncFailure < Internal::Types::Model
+      field :reference_id, -> { String }, optional: false, nullable: false
+
+      field :operation, -> { VitableConnect::Types::Operation }, optional: false, nullable: false
+
+      field :reason, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/group_member_sync_member_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class GroupMemberSyncMemberRequest < Internal::Types::Model
+      field :reference_id, -> { String }, optional: false, 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 :phone, -> { String }, optional: true, nullable: false
+
+      field :plan_id, -> { String }, optional: false, nullable: false
+
+      field :address, -> { VitableConnect::Types::AddressRequest }, optional: false, nullable: false
+
+      field :email, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/group_member_sync_request_detail.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class GroupMemberSyncRequestDetail < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false
+
+      field :group_id, -> { String }, optional: false, nullable: false
+
+      field :accepted_at, -> { String }, optional: false, nullable: false
+
+      field :completed_at, -> { String }, optional: false, nullable: true
+
+      field :results, -> { VitableConnect::Types::GroupMemberSyncResults }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/group_member_sync_request_detail_response.rb

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

data/lib/VitableConnect/types/group_member_sync_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class GroupMemberSyncResponse < Internal::Types::Model
+      field :request_id, -> { String }, optional: false, nullable: false
+
+      field :group_id, -> { String }, optional: false, nullable: false
+
+      field :accepted_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/group_member_sync_results.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class GroupMemberSyncResults < Internal::Types::Model
+      field :added_group_member_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :removed_group_member_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :failures, -> { Internal::Types::Array[VitableConnect::Types::GroupMemberSyncFailure] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/group_response.rb

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

data/lib/VitableConnect/types/household_member.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Wire serializer for :class:`HouseholdMemberDTO` (one household participant).
+    class HouseholdMember < Internal::Types::Model
+      field :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::HouseholdMemberRelationship }, optional: true, nullable: false
+
+      field :member_type, -> { VitableConnect::Types::HouseholdMemberType }, optional: false, nullable: false
+
+      field :date_of_birth, -> { String }, optional: false, nullable: false
+
+      field :household_admin_in, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/household_member_relationship.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module HouseholdMemberRelationship
+      extend VitableConnect::Internal::Types::Enum
+
+      CHILD = "Child"
+      SPOUSE = "Spouse"
+      ROOMMATE = "Roommate"
+      OTHER = "Other"
+    end
+  end
+end

data/lib/VitableConnect/types/household_member_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module HouseholdMemberType
+      extend VitableConnect::Internal::Types::Enum
+
+      ACCOUNT_HOLDER = "Account Holder"
+      DEPENDENT = "Dependent"
+      INACTIVE = "Inactive"
+    end
+  end
+end

data/lib/VitableConnect/types/household_members_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # Unpaginated ``{"data": [...]}`` list of the members of a member's household.
+    class HouseholdMembersResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[VitableConnect::Types::HouseholdMember] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/hris_connection.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class HrisConnection < Internal::Types::Model
+      field :provider, -> { String }, optional: false, nullable: false
+
+      field :provider_label, -> { String }, optional: false, nullable: false
+
+      field :status, -> { String }, optional: false, nullable: false
+
+      field :last_sync_on, -> { String }, optional: false, nullable: true
+
+      field :synced_row_count, -> { Integer }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/hris_status_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module HrisStatusItem
+      extend VitableConnect::Internal::Types::Enum
+
+      PENDING = "Pending"
+      ACTIVE = "Active"
+      INACTIVE = "Inactive"
+      PAUSED = "Paused"
+      TERMINATED = "Terminated"
+    end
+  end
+end

data/lib/VitableConnect/types/ichra_contribution_class.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    # One ICHRA contribution class, mirroring the internal configuration endpoint's
+    # ``IchraContributionClassConfigurationEntitySerializer`` field-for-field. Two deliberate
+    # differences for the public surface: the identifier is the opaque prefixed ``iccl_*`` form rather
+    # than a raw UUID, and the matcher choices come from the domain enums rather than the model's.
+    class IchraContributionClass < Internal::Types::Model
+      field :contribution_class_id, -> { String }, optional: false, nullable: false
+
+      field :amount_in_cents, -> { Integer }, optional: false, nullable: false
+
+      field :employment, -> { VitableConnect::Types::ContributionClassEmployment }, optional: false, nullable: false
+
+      field :compensation, -> { VitableConnect::Types::ContributionClassCompensation }, optional: false, nullable: false
+
+      field :location, -> { VitableConnect::Types::ContributionClassLocation }, optional: false, nullable: false
+
+      field :location_value, -> { String }, optional: false, nullable: true
+
+      field :family_status, -> { VitableConnect::Types::CoverageTier }, optional: false, nullable: false
+
+      field :min_age, -> { Integer }, optional: false, nullable: true
+
+      field :max_age, -> { Integer }, optional: false, nullable: true
+    end
+  end
+end

data/lib/VitableConnect/types/idp_provider.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module IdpProvider
+      extend VitableConnect::Internal::Types::Enum
+
+      WORKOS = "workos"
+      VITABLE = "vitable"
+    end
+  end
+end

data/lib/VitableConnect/types/include_cancelled.rb

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