vitable-connect 0.4.0 → 0.6.0

data/lib/vitable_connect/models/employer_update_settings_response.rb

@@ -18,8 +18,8 @@ module VitableConnect
       class Data < VitableConnect::Internal::Type::BaseModel
         # @!attribute pay_frequency
         #   - `weekly` - Weekly
-        #   - `bi_weekly` - Bi-Weekly
-        #   - `semi_monthly` - Semi-Monthly
+        #   - `bi_weekly` - Bi Weekly
+        #   - `semi_monthly` - Semi Monthly
         #   - `monthly` - Monthly
         #
         #   @return [Symbol, VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency, nil]
@@ -34,8 +34,8 @@ module VitableConnect
         #   @param pay_frequency [Symbol, VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency, nil] - `weekly` - Weekly
 
         # - `weekly` - Weekly
-        # - `bi_weekly` - Bi-Weekly
-        # - `semi_monthly` - Semi-Monthly
+        # - `bi_weekly` - Bi Weekly
+        # - `semi_monthly` - Semi Monthly
         # - `monthly` - Monthly
         #
         # @see VitableConnect::Models::EmployerUpdateSettingsResponse::Data#pay_frequency

data/lib/vitable_connect/models/enrollment_reissue_params.rb

@@ -0,0 +1,50 @@
+# 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

@@ -0,0 +1,30 @@
+# 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_terminate_params.rb

@@ -0,0 +1,50 @@
+# 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

@@ -5,42 +5,53 @@ module VitableConnect
     # @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]
-      #   @param created_at [Time, nil]
-      #   @param external_reference_id [String]
-      #   @param name [String]
-      #   @param organization_id [String]
-      #   @param updated_at [Time, nil]
+      #   @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/groups/members/sync_retrieve_response.rb

@@ -40,15 +40,86 @@ module VitableConnect
 
             # @!attribute results
             #
-            #   @return [Object]
-            required :results, VitableConnect::Internal::Type::Unknown
+            #   @return [VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results, nil]
+            required :results,
+                     -> { VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results },
+                     nil?: true
 
             # @!method initialize(accepted_at:, completed_at:, group_id:, request_id:, results:)
             #   @param accepted_at [Time]
             #   @param completed_at [Time, nil]
             #   @param group_id [String]
             #   @param request_id [String]
-            #   @param results [Object]
+            #   @param results [VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results, nil]
+
+            # @see VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data#results
+            class Results < VitableConnect::Internal::Type::BaseModel
+              # @!attribute added_group_member_ids
+              #
+              #   @return [Array<String>]
+              required :added_group_member_ids, VitableConnect::Internal::Type::ArrayOf[String]
+
+              # @!attribute failures
+              #
+              #   @return [Array<VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results::Failure>]
+              required :failures,
+                       -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results::Failure] }
+
+              # @!attribute removed_group_member_ids
+              #
+              #   @return [Array<String>]
+              required :removed_group_member_ids, VitableConnect::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(added_group_member_ids:, failures:, removed_group_member_ids:)
+              #   @param added_group_member_ids [Array<String>]
+              #   @param failures [Array<VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results::Failure>]
+              #   @param removed_group_member_ids [Array<String>]
+
+              class Failure < VitableConnect::Internal::Type::BaseModel
+                # @!attribute operation
+                #   - `add` - add
+                #   - `remove` - remove
+                #
+                #   @return [Symbol, VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results::Failure::Operation]
+                required :operation,
+                         enum: -> { VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results::Failure::Operation }
+
+                # @!attribute reason
+                #
+                #   @return [String]
+                required :reason, String
+
+                # @!attribute reference_id
+                #
+                #   @return [String]
+                required :reference_id, String
+
+                # @!method initialize(operation:, reason:, reference_id:)
+                #   Some parameter documentations has been truncated, see
+                #   {VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results::Failure}
+                #   for more details.
+                #
+                #   @param operation [Symbol, VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results::Failure::Operation] - `add` - add
+                #
+                #   @param reason [String]
+                #
+                #   @param reference_id [String]
+
+                # - `add` - add
+                # - `remove` - remove
+                #
+                # @see VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::Results::Failure#operation
+                module Operation
+                  extend VitableConnect::Internal::Type::Enum
+
+                  ADD = :add
+                  REMOVE = :remove
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+            end
           end
         end
       end

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

@@ -49,11 +49,6 @@ module VitableConnect
             #   @return [String]
             required :last_name, String
 
-            # @!attribute phone
-            #
-            #   @return [String]
-            required :phone, String
-
             # @!attribute plan_id
             #
             #   @return [String]
@@ -69,15 +64,20 @@ module VitableConnect
             #   @return [String, nil]
             optional :email, String, nil?: true
 
-            # @!method initialize(address:, date_of_birth:, first_name:, last_name:, phone:, plan_id:, reference_id:, email: nil)
+            # @!attribute phone
+            #
+            #   @return [String, nil]
+            optional :phone, String, nil?: true
+
+            # @!method initialize(address:, date_of_birth:, first_name:, last_name:, plan_id:, reference_id:, email: nil, phone: nil)
             #   @param address [VitableConnect::Models::Groups::Members::SyncSubmitParams::Member::Address]
             #   @param date_of_birth [Date]
             #   @param first_name [String]
             #   @param last_name [String]
-            #   @param phone [String]
             #   @param plan_id [String]
             #   @param reference_id [String]
             #   @param email [String, nil]
+            #   @param phone [String, nil]
 
             # @see VitableConnect::Models::Groups::Members::SyncSubmitParams::Member#address
             class Address < VitableConnect::Internal::Type::BaseModel

data/lib/vitable_connect/models/member_list_dependents_params.rb

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

data/lib/vitable_connect/models/member_list_dependents_response.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Members#list_dependents
+    class MemberListDependentsResponse < VitableConnect::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<VitableConnect::Models::MemberListDependentsResponse::Data>]
+      required :data,
+               -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Models::MemberListDependentsResponse::Data] }
+
+      # @!method initialize(data:)
+      #   Unpaginated `{"data": [...]}` list of member dependents.
+      #
+      #   @param data [Array<VitableConnect::Models::MemberListDependentsResponse::Data>]
+
+      class Data < VitableConnect::Internal::Type::BaseModel
+        # @!attribute age
+        #   Dependent's age in years, derived from date of birth
+        #
+        #   @return [Integer]
+        required :age, Integer
+
+        # @!attribute date_of_birth
+        #   Date of birth (YYYY-MM-DD)
+        #
+        #   @return [Date]
+        required :date_of_birth, Date
+
+        # @!attribute first_name
+        #   Dependent's first name
+        #
+        #   @return [String]
+        required :first_name, String
+
+        # @!attribute last_name
+        #   Dependent's last name
+        #
+        #   @return [String]
+        required :last_name, String
+
+        # @!attribute relationship
+        #   - `Spouse` - Spouse
+        #   - `Child` - Child
+        #
+        #   @return [Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::Relationship]
+        required :relationship,
+                 enum: -> { VitableConnect::Models::MemberListDependentsResponse::Data::Relationship }
+
+        # @!attribute sex_at_birth
+        #   - `Male` - Male
+        #   - `Female` - Female
+        #   - `Other` - Other
+        #   - `Unknown` - Unknown
+        #
+        #   @return [Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::SexAtBirth, nil]
+        optional :sex_at_birth,
+                 enum: -> { VitableConnect::Models::MemberListDependentsResponse::Data::SexAtBirth },
+                 nil?: true
+
+        response_only do
+          # @!attribute member_id
+          #   The dependent's own member identifier with 'mbr\_' prefix
+          #
+          #   @return [String]
+          required :member_id, String
+
+          # @!attribute primary_member_id
+          #   The primary member's identifier with 'mbr\_' prefix
+          #
+          #   @return [String]
+          required :primary_member_id, String
+        end
+
+        # @!method initialize(age:, date_of_birth:, first_name:, last_name:, member_id:, primary_member_id:, relationship:, sex_at_birth: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {VitableConnect::Models::MemberListDependentsResponse::Data} for more details.
+        #
+        #   Wire serializer for :class:`MemberLegalDependentDTO` (one legal-dependent row).
+        #
+        #   @param age [Integer] Dependent's age in years, derived from date of birth
+        #
+        #   @param date_of_birth [Date] Date of birth (YYYY-MM-DD)
+        #
+        #   @param first_name [String] Dependent's first name
+        #
+        #   @param last_name [String] Dependent's last name
+        #
+        #   @param member_id [String] The dependent's own member identifier with 'mbr\_' prefix
+        #
+        #   @param primary_member_id [String] The primary member's identifier with 'mbr\_' prefix
+        #
+        #   @param relationship [Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::Relationship] - `Spouse` - Spouse
+        #
+        #   @param sex_at_birth [Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::SexAtBirth, nil] - `Male` - Male
+
+        # - `Spouse` - Spouse
+        # - `Child` - Child
+        #
+        # @see VitableConnect::Models::MemberListDependentsResponse::Data#relationship
+        module Relationship
+          extend VitableConnect::Internal::Type::Enum
+
+          SPOUSE = :Spouse
+          CHILD = :Child
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # - `Male` - Male
+        # - `Female` - Female
+        # - `Other` - Other
+        # - `Unknown` - Unknown
+        #
+        # @see VitableConnect::Models::MemberListDependentsResponse::Data#sex_at_birth
+        module SexAtBirth
+          extend VitableConnect::Internal::Type::Enum
+
+          MALE = :Male
+          FEMALE = :Female
+          OTHER = :Other
+          UNKNOWN = :Unknown
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/member_list_employments_params.rb

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

data/lib/vitable_connect/models/member_list_employments_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Members#list_employments
+    class MemberListEmploymentsResponse < VitableConnect::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<VitableConnect::Models::Employee>]
+      required :data, -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Employee] }
+
+      # @!method initialize(data:)
+      #   Unpaginated `{"data": [...]}` list of member employments.
+      #
+      #   @param data [Array<VitableConnect::Models::Employee>]
+    end
+  end
+end

data/lib/vitable_connect/models/member_list_enrollments_params.rb

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