vitable-connect 0.6.0 → 1.0.0

data/lib/vitable_connect/models/enrollment.rb

@@ -1,234 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    class Enrollment < VitableConnect::Internal::Type::BaseModel
-      # @!attribute id
-      #   Unique enrollment identifier (enrl\_\*)
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute answered_at
-      #   When the employee enrolled or waived
-      #
-      #   @return [Time, nil]
-      required :answered_at, Time, nil?: true
-
-      # @!attribute benefit
-      #   Nested benefit product summary
-      #
-      #   @return [VitableConnect::Models::Enrollment::Benefit]
-      required :benefit, -> { VitableConnect::Enrollment::Benefit }
-
-      # @!attribute coverage_end
-      #   Coverage period end date
-      #
-      #   @return [Date, nil]
-      required :coverage_end, Date, nil?: true
-
-      # @!attribute coverage_start
-      #   Coverage period start date
-      #
-      #   @return [Date]
-      required :coverage_start, Date
-
-      # @!attribute created_at
-      #   When the enrollment was created
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute employee_deduction_in_cents
-      #   Employee monthly payroll deduction in cents
-      #
-      #   @return [Integer, nil]
-      required :employee_deduction_in_cents, Integer, nil?: true
-
-      # @!attribute employee_id
-      #   Employee ID (empl\_\*)
-      #
-      #   @return [String]
-      required :employee_id, String
-
-      # @!attribute employer_contribution_in_cents
-      #   Employer monthly contribution in cents
-      #
-      #   @return [Integer, nil]
-      required :employer_contribution_in_cents, Integer, nil?: true
-
-      # @!attribute employer_id
-      #   Employer ID (empr\_\*)
-      #
-      #   @return [String]
-      required :employer_id, String
-
-      # @!attribute status
-      #   - `pending` - Pending
-      #   - `enrolled` - Enrolled
-      #   - `waived` - Waived
-      #   - `inactive` - Inactive
-      #
-      #   @return [Symbol, VitableConnect::Models::EnrollmentStatus]
-      required :status, enum: -> { VitableConnect::EnrollmentStatus }
-
-      # @!attribute terminated_at
-      #   When coverage was terminated
-      #
-      #   @return [Time, nil]
-      required :terminated_at, Time, nil?: true
-
-      # @!attribute updated_at
-      #   When the enrollment was last updated
-      #
-      #   @return [Time]
-      required :updated_at, Time
-
-      # @!method initialize(id:, answered_at:, benefit:, coverage_end:, coverage_start:, created_at:, employee_deduction_in_cents:, employee_id:, employer_contribution_in_cents:, employer_id:, status:, terminated_at:, updated_at:)
-      #   Some parameter documentations has been truncated, see
-      #   {VitableConnect::Models::Enrollment} for more details.
-      #
-      #   @param id [String] Unique enrollment identifier (enrl\_\*)
-      #
-      #   @param answered_at [Time, nil] When the employee enrolled or waived
-      #
-      #   @param benefit [VitableConnect::Models::Enrollment::Benefit] Nested benefit product summary
-      #
-      #   @param coverage_end [Date, nil] Coverage period end date
-      #
-      #   @param coverage_start [Date] Coverage period start date
-      #
-      #   @param created_at [Time] When the enrollment was created
-      #
-      #   @param employee_deduction_in_cents [Integer, nil] Employee monthly payroll deduction in cents
-      #
-      #   @param employee_id [String] Employee ID (empl\_\*)
-      #
-      #   @param employer_contribution_in_cents [Integer, nil] Employer monthly contribution in cents
-      #
-      #   @param employer_id [String] Employer ID (empr\_\*)
-      #
-      #   @param status [Symbol, VitableConnect::Models::EnrollmentStatus] - `pending` - Pending
-      #
-      #   @param terminated_at [Time, nil] When coverage was terminated
-      #
-      #   @param updated_at [Time] When the enrollment was last updated
-
-      # @see VitableConnect::Models::Enrollment#benefit
-      class Benefit < VitableConnect::Internal::Type::BaseModel
-        # @!attribute id
-        #   Benefit product ID (bprd\_\*)
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute category
-        #   - `Medical` - Medical
-        #   - `Dental` - Dental
-        #   - `Vision` - Vision
-        #   - `Hospital` - Hospital
-        #
-        #   @return [Symbol, VitableConnect::Models::Enrollment::Benefit::Category]
-        required :category, enum: -> { VitableConnect::Enrollment::Benefit::Category }
-
-        # @!attribute name
-        #   Display name of the benefit product
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute product_code
-        #   - `EBA` - Eba Mec
-        #   - `VPC` - Vpc Enhanced
-        #   - `VPC_CORE` - Vpc Core
-        #   - `MEC` - Vpc Mec
-        #   - `MEC2` - Mec2
-        #   - `MEC_PLUS` - Mec Plus
-        #   - `MVP` - Mvp
-        #   - `MVP2` - Mvp2
-        #   - `MVPSL` - Mvpsl
-        #   - `MVPSL2` - Mvpsl2
-        #   - `VD` - Dental
-        #   - `VV` - Vision
-        #   - `ICHRA` - Ichra
-        #   - `ICHRA_PREMIUM_PLUS` - Ichra Premium Plus
-        #   - `ICHRA_REIMBURSEMENT_ONLY` - Ichra Reimbursement Only
-        #
-        #   @return [Symbol, VitableConnect::Models::Enrollment::Benefit::ProductCode]
-        required :product_code, enum: -> { VitableConnect::Enrollment::Benefit::ProductCode }
-
-        # @!method initialize(id:, category:, name:, product_code:)
-        #   Some parameter documentations has been truncated, see
-        #   {VitableConnect::Models::Enrollment::Benefit} for more details.
-        #
-        #   Nested benefit product summary
-        #
-        #   @param id [String] Benefit product ID (bprd\_\*)
-        #
-        #   @param category [Symbol, VitableConnect::Models::Enrollment::Benefit::Category] - `Medical` - Medical
-        #
-        #   @param name [String] Display name of the benefit product
-        #
-        #   @param product_code [Symbol, VitableConnect::Models::Enrollment::Benefit::ProductCode] - `EBA` - Eba Mec
-
-        # - `Medical` - Medical
-        # - `Dental` - Dental
-        # - `Vision` - Vision
-        # - `Hospital` - Hospital
-        #
-        # @see VitableConnect::Models::Enrollment::Benefit#category
-        module Category
-          extend VitableConnect::Internal::Type::Enum
-
-          MEDICAL = :Medical
-          DENTAL = :Dental
-          VISION = :Vision
-          HOSPITAL = :Hospital
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # - `EBA` - Eba Mec
-        # - `VPC` - Vpc Enhanced
-        # - `VPC_CORE` - Vpc Core
-        # - `MEC` - Vpc Mec
-        # - `MEC2` - Mec2
-        # - `MEC_PLUS` - Mec Plus
-        # - `MVP` - Mvp
-        # - `MVP2` - Mvp2
-        # - `MVPSL` - Mvpsl
-        # - `MVPSL2` - Mvpsl2
-        # - `VD` - Dental
-        # - `VV` - Vision
-        # - `ICHRA` - Ichra
-        # - `ICHRA_PREMIUM_PLUS` - Ichra Premium Plus
-        # - `ICHRA_REIMBURSEMENT_ONLY` - Ichra Reimbursement Only
-        #
-        # @see VitableConnect::Models::Enrollment::Benefit#product_code
-        module ProductCode
-          extend VitableConnect::Internal::Type::Enum
-
-          EBA = :EBA
-          VPC = :VPC
-          VPC_CORE = :VPC_CORE
-          MEC = :MEC
-          MEC2 = :MEC2
-          MEC_PLUS = :MEC_PLUS
-          MVP = :MVP
-          MVP2 = :MVP2
-          MVPSL = :MVPSL
-          MVPSL2 = :MVPSL2
-          VD = :VD
-          VV = :VV
-          ICHRA = :ICHRA
-          ICHRA_PREMIUM_PLUS = :ICHRA_PREMIUM_PLUS
-          ICHRA_REIMBURSEMENT_ONLY = :ICHRA_REIMBURSEMENT_ONLY
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/enrollment_reissue_params.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Enrollments#reissue
-    class EnrollmentReissueParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute enrollment_id
-      #   Unique enrollment identifier (enrl\_\*)
-      #
-      #   @return [String]
-      required :enrollment_id, String
-
-      # @!attribute qualifying_life_event_id
-      #   Accepted member qualifying life event identifier (qle\_\*)
-      #
-      #   @return [String, nil]
-      optional :qualifying_life_event_id, String, nil?: true
-
-      # @!attribute reason
-      #   Audit reason for the reissue; required for user-backed callers and optional for
-      #   userless organization callers
-      #
-      #   @return [String, nil]
-      optional :reason, String, nil?: true
-
-      # @!attribute ticket_number
-      #   Optional support or operational ticket number
-      #
-      #   @return [String, nil]
-      optional :ticket_number, String, nil?: true
-
-      # @!method initialize(enrollment_id:, qualifying_life_event_id: nil, reason: nil, ticket_number: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {VitableConnect::Models::EnrollmentReissueParams} for more details.
-      #
-      #   @param enrollment_id [String] Unique enrollment identifier (enrl\_\*)
-      #
-      #   @param qualifying_life_event_id [String, nil] Accepted member qualifying life event identifier (qle\_\*)
-      #
-      #   @param reason [String, nil] Audit reason for the reissue; required for user-backed callers and optional for
-      #
-      #   @param ticket_number [String, nil] Optional support or operational ticket number
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/enrollment_reissue_response.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Enrollments#reissue
-    class EnrollmentReissueResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [VitableConnect::Models::EnrollmentReissueResponse::Data]
-      required :data, -> { VitableConnect::Models::EnrollmentReissueResponse::Data }
-
-      # @!method initialize(data:)
-      #   Response containing a single reissue enrollment resource.
-      #
-      #   @param data [VitableConnect::Models::EnrollmentReissueResponse::Data]
-
-      # @see VitableConnect::Models::EnrollmentReissueResponse#data
-      class Data < VitableConnect::Internal::Type::BaseModel
-        # @!attribute enrollment_id
-        #   Opaque identifier for the new unanswered enrollment
-        #
-        #   @return [String]
-        required :enrollment_id, String
-
-        # @!method initialize(enrollment_id:)
-        #   @param enrollment_id [String] Opaque identifier for the new unanswered enrollment
-      end
-    end
-  end
-end

data/lib/vitable_connect/models/enrollment_retrieve_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Enrollments#retrieve
-    class EnrollmentRetrieveParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute enrollment_id
-      #   Unique enrollment identifier (enrl\_\*)
-      #
-      #   @return [String]
-      required :enrollment_id, String
-
-      # @!method initialize(enrollment_id:, request_options: {})
-      #   @param enrollment_id [String] Unique enrollment identifier (enrl\_\*)
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/enrollment_retrieve_response.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Enrollments#retrieve
-    class EnrollmentRetrieveResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [VitableConnect::Models::Enrollment]
-      required :data, -> { VitableConnect::Enrollment }
-
-      # @!method initialize(data:)
-      #   Response containing a single enrollment resource.
-      #
-      #   @param data [VitableConnect::Models::Enrollment]
-    end
-  end
-end

data/lib/vitable_connect/models/enrollment_status.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # - `pending` - Pending
-    # - `enrolled` - Enrolled
-    # - `waived` - Waived
-    # - `inactive` - Inactive
-    module EnrollmentStatus
-      extend VitableConnect::Internal::Type::Enum
-
-      PENDING = :pending
-      ENROLLED = :enrolled
-      WAIVED = :waived
-      INACTIVE = :inactive
-
-      # @!method self.values
-      #   @return [Array<Symbol>]
-    end
-  end
-end

data/lib/vitable_connect/models/enrollment_terminate_params.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Enrollments#terminate
-    class EnrollmentTerminateParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute enrollment_id
-      #   Unique enrollment identifier (enrl\_\*)
-      #
-      #   @return [String]
-      required :enrollment_id, String
-
-      # @!attribute qualifying_life_event_id
-      #   Accepted member qualifying life event identifier (qle\_\*)
-      #
-      #   @return [String, nil]
-      optional :qualifying_life_event_id, String, nil?: true
-
-      # @!attribute reason
-      #   Audit reason for the termination; required for user-backed callers and optional
-      #   for userless organization callers
-      #
-      #   @return [String, nil]
-      optional :reason, String, nil?: true
-
-      # @!attribute ticket_number
-      #   Optional support or operational ticket number
-      #
-      #   @return [String, nil]
-      optional :ticket_number, String, nil?: true
-
-      # @!method initialize(enrollment_id:, qualifying_life_event_id: nil, reason: nil, ticket_number: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {VitableConnect::Models::EnrollmentTerminateParams} for more details.
-      #
-      #   @param enrollment_id [String] Unique enrollment identifier (enrl\_\*)
-      #
-      #   @param qualifying_life_event_id [String, nil] Accepted member qualifying life event identifier (qle\_\*)
-      #
-      #   @param reason [String, nil] Audit reason for the termination; required for user-backed callers and optional
-      #
-      #   @param ticket_number [String, nil] Optional support or operational ticket number
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/group.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Groups#list
-    class Group < VitableConnect::Internal::Type::BaseModel
-      # @!attribute id
-      #   Prefixed group identifier (`grp_<base64-encoded-uuid>`).
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute created_at
-      #   Group creation timestamp (ISO 8601, UTC).
-      #
-      #   @return [Time, nil]
-      required :created_at, Time, nil?: true
-
-      # @!attribute external_reference_id
-      #   Stable identifier for this group in the integrator's own system.
-      #
-      #   @return [String]
-      required :external_reference_id, String
-
-      # @!attribute name
-      #   Human-readable group name.
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute organization_id
-      #   Prefixed organization identifier (`org_<base64-encoded-uuid>`).
-      #
-      #   @return [String]
-      required :organization_id, String
-
-      # @!attribute updated_at
-      #   Last-update timestamp (ISO 8601, UTC).
-      #
-      #   @return [Time, nil]
-      required :updated_at, Time, nil?: true
-
-      # @!method initialize(id:, created_at:, external_reference_id:, name:, organization_id:, updated_at:)
-      #   @param id [String] Prefixed group identifier (`grp_<base64-encoded-uuid>`).
-      #
-      #   @param created_at [Time, nil] Group creation timestamp (ISO 8601, UTC).
-      #
-      #   @param external_reference_id [String] Stable identifier for this group in the integrator's own system.
-      #
-      #   @param name [String] Human-readable group name.
-      #
-      #   @param organization_id [String] Prefixed organization identifier (`org_<base64-encoded-uuid>`).
-      #
-      #   @param updated_at [Time, nil] Last-update timestamp (ISO 8601, UTC).
-    end
-  end
-end

data/lib/vitable_connect/models/group_create_params.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Groups#create
-    class GroupCreateParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute external_reference_id
-      #
-      #   @return [String]
-      required :external_reference_id, String
-
-      # @!attribute name
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!method initialize(external_reference_id:, name:, request_options: {})
-      #   @param external_reference_id [String]
-      #   @param name [String]
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/group_list_params.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Groups#list
-    class GroupListParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute limit
-      #   Items per page (default: 20, max: 100)
-      #
-      #   @return [Integer, nil]
-      optional :limit, Integer
-
-      # @!attribute page
-      #   Page number (default: 1)
-      #
-      #   @return [Integer, nil]
-      optional :page, Integer
-
-      # @!method initialize(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}]
-    end
-  end
-end

data/lib/vitable_connect/models/group_response.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Groups#create
-    class GroupResponse < VitableConnect::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [VitableConnect::Models::Group]
-      required :data, -> { VitableConnect::Group }
-
-      # @!method initialize(data:)
-      #   Response containing a single group resource.
-      #
-      #   @param data [VitableConnect::Models::Group]
-    end
-  end
-end

data/lib/vitable_connect/models/group_retrieve_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Groups#retrieve
-    class GroupRetrieveParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute group_id
-      #   Unique group identifier (grp\_\*)
-      #
-      #   @return [String]
-      required :group_id, String
-
-      # @!method initialize(group_id:, request_options: {})
-      #   @param group_id [String] Unique group identifier (grp\_\*)
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/group_update_params.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    # @see VitableConnect::Resources::Groups#update
-    class GroupUpdateParams < VitableConnect::Internal::Type::BaseModel
-      extend VitableConnect::Internal::Type::RequestParameters::Converter
-      include VitableConnect::Internal::Type::RequestParameters
-
-      # @!attribute group_id
-      #   Unique group identifier (grp\_\*)
-      #
-      #   @return [String]
-      required :group_id, String
-
-      # @!attribute external_reference_id
-      #
-      #   @return [String, nil]
-      optional :external_reference_id, String, nil?: true
-
-      # @!attribute name
-      #
-      #   @return [String, nil]
-      optional :name, String, nil?: true
-
-      # @!method initialize(group_id:, external_reference_id: nil, name: nil, request_options: {})
-      #   @param group_id [String] Unique group identifier (grp\_\*)
-      #
-      #   @param external_reference_id [String, nil]
-      #
-      #   @param name [String, nil]
-      #
-      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/vitable_connect/models/groups/members/sync_retrieve_params.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Models
-    module Groups
-      module Members
-        # @see VitableConnect::Resources::Groups::Members::Sync#retrieve
-        class SyncRetrieveParams < VitableConnect::Internal::Type::BaseModel
-          extend VitableConnect::Internal::Type::RequestParameters::Converter
-          include VitableConnect::Internal::Type::RequestParameters
-
-          # @!attribute group_id
-          #   Unique group identifier (grp\_\*)
-          #
-          #   @return [String]
-          required :group_id, String
-
-          # @!attribute request_id
-          #
-          #   @return [String]
-          required :request_id, String
-
-          # @!method initialize(group_id:, request_id:, request_options: {})
-          #   @param group_id [String] Unique group identifier (grp\_\*)
-          #
-          #   @param request_id [String]
-          #
-          #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
-        end
-      end
-    end
-  end
-end