vitable-connect 0.3.0 → 0.5.0

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        # @see VitableConnect::Resources::Groups::Members::Sync#retrieve
+        class SyncRetrieveResponse < VitableConnect::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data]
+          required :data, -> { VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data }
+
+          # @!method initialize(data:)
+          #   Response containing a single group member sync request detail resource.
+          #
+          #   @param data [VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data]
+
+          # @see VitableConnect::Models::Groups::Members::SyncRetrieveResponse#data
+          class Data < VitableConnect::Internal::Type::BaseModel
+            # @!attribute accepted_at
+            #
+            #   @return [Time]
+            required :accepted_at, Time
+
+            # @!attribute completed_at
+            #
+            #   @return [Time, nil]
+            required :completed_at, Time, nil?: true
+
+            # @!attribute group_id
+            #
+            #   @return [String]
+            required :group_id, String
+
+            # @!attribute request_id
+            #
+            #   @return [String]
+            required :request_id, String
+
+            # @!attribute results
+            #
+            #   @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 [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
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        # @see VitableConnect::Resources::Groups::Members::Sync#submit
+        class SyncSubmitParams < 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 members
+          #
+          #   @return [Array<VitableConnect::Models::Groups::Members::SyncSubmitParams::Member>]
+          required :members,
+                   -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Groups::Members::SyncSubmitParams::Member] }
+
+          # @!method initialize(group_id:, members:, request_options: {})
+          #   @param group_id [String] Unique group identifier (grp\_\*)
+          #
+          #   @param members [Array<VitableConnect::Models::Groups::Members::SyncSubmitParams::Member>]
+          #
+          #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
+
+          class Member < VitableConnect::Internal::Type::BaseModel
+            # @!attribute address
+            #
+            #   @return [VitableConnect::Models::Groups::Members::SyncSubmitParams::Member::Address]
+            required :address, -> { VitableConnect::Groups::Members::SyncSubmitParams::Member::Address }
+
+            # @!attribute date_of_birth
+            #
+            #   @return [Date]
+            required :date_of_birth, Date
+
+            # @!attribute first_name
+            #
+            #   @return [String]
+            required :first_name, String
+
+            # @!attribute last_name
+            #
+            #   @return [String]
+            required :last_name, String
+
+            # @!attribute phone
+            #
+            #   @return [String]
+            required :phone, String
+
+            # @!attribute plan_id
+            #
+            #   @return [String]
+            required :plan_id, String
+
+            # @!attribute reference_id
+            #
+            #   @return [String]
+            required :reference_id, String
+
+            # @!attribute email
+            #
+            #   @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)
+            #   @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]
+
+            # @see VitableConnect::Models::Groups::Members::SyncSubmitParams::Member#address
+            class Address < VitableConnect::Internal::Type::BaseModel
+              # @!attribute address_line_1
+              #
+              #   @return [String]
+              required :address_line_1, String
+
+              # @!attribute city
+              #
+              #   @return [String]
+              required :city, String
+
+              # @!attribute state
+              #
+              #   @return [String]
+              required :state, String
+
+              # @!attribute zipcode
+              #
+              #   @return [String]
+              required :zipcode, String
+
+              # @!attribute address_line_2
+              #
+              #   @return [String, nil]
+              optional :address_line_2, String, nil?: true
+
+              # @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
+              #   @param address_line_1 [String]
+              #   @param city [String]
+              #   @param state [String]
+              #   @param zipcode [String]
+              #   @param address_line_2 [String, nil]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        # @see VitableConnect::Resources::Groups::Members::Sync#submit
+        class SyncSubmitResponse < VitableConnect::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [VitableConnect::Models::Groups::Members::SyncSubmitResponse::Data]
+          required :data, -> { VitableConnect::Models::Groups::Members::SyncSubmitResponse::Data }
+
+          # @!method initialize(data:)
+          #   Response containing a single group member sync detail resource.
+          #
+          #   @param data [VitableConnect::Models::Groups::Members::SyncSubmitResponse::Data]
+
+          # @see VitableConnect::Models::Groups::Members::SyncSubmitResponse#data
+          class Data < VitableConnect::Internal::Type::BaseModel
+            # @!attribute accepted_at
+            #
+            #   @return [Time]
+            required :accepted_at, Time
+
+            # @!attribute group_id
+            #
+            #   @return [String]
+            required :group_id, String
+
+            # @!attribute request_id
+            #
+            #   @return [String]
+            required :request_id, String
+
+            # @!method initialize(accepted_at:, group_id:, request_id:)
+            #   @param accepted_at [Time]
+            #   @param group_id [String]
+            #   @param request_id [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/plan_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Plans#list
+    class PlanListParams < 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/plan_list_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Plans#list
+    class PlanListResponse < VitableConnect::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(id:, name:)
+      #   @param id [String]
+      #   @param name [String]
+    end
+  end
+end

data/lib/vitable_connect/models/webhook_event_list_params.rb

@@ -27,7 +27,6 @@ module VitableConnect
       #   - `employee.eligibility_granted` - Employee Eligibility Granted
       #   - `employee.eligibility_terminated` - Employee Eligibility Terminated
       #   - `employee.deactivated` - Employee Deactivated
-      #   - `employer.eligibility_policy_created` - Employer Eligibility Policy Created
       #   - `employee.deduction_created` - Employee Deduction Created
       #
       #   @return [Symbol, VitableConnect::Models::WebhookEventListParams::EventName, nil]
@@ -90,7 +89,6 @@ module VitableConnect
       # - `employee.eligibility_granted` - Employee Eligibility Granted
       # - `employee.eligibility_terminated` - Employee Eligibility Terminated
       # - `employee.deactivated` - Employee Deactivated
-      # - `employer.eligibility_policy_created` - Employer Eligibility Policy Created
       # - `employee.deduction_created` - Employee Deduction Created
       module EventName
         extend VitableConnect::Internal::Type::Enum
@@ -104,7 +102,6 @@ module VitableConnect
         EMPLOYEE_ELIGIBILITY_GRANTED = :"employee.eligibility_granted"
         EMPLOYEE_ELIGIBILITY_TERMINATED = :"employee.eligibility_terminated"
         EMPLOYEE_DEACTIVATED = :"employee.deactivated"
-        EMPLOYER_ELIGIBILITY_POLICY_CREATED = :"employer.eligibility_policy_created"
         EMPLOYEE_DEDUCTION_CREATED = :"employee.deduction_created"
 
         # @!method self.values

data/lib/vitable_connect/models.rb

@@ -44,12 +44,6 @@ module VitableConnect
 
   AuthIssueAccessTokenParams = VitableConnect::Models::AuthIssueAccessTokenParams
 
-  BenefitEligibilityPolicy = VitableConnect::Models::BenefitEligibilityPolicy
-
-  BenefitEligibilityPolicyResponse = VitableConnect::Models::BenefitEligibilityPolicyResponse
-
-  BenefitEligibilityPolicyRetrieveParams = VitableConnect::Models::BenefitEligibilityPolicyRetrieveParams
-
   Employee = VitableConnect::Models::Employee
 
   EmployeeClass = VitableConnect::Models::EmployeeClass
@@ -60,9 +54,6 @@ module VitableConnect
 
   Employer = VitableConnect::Models::Employer
 
-  EmployerCreateBenefitEligibilityPolicyParams =
-    VitableConnect::Models::EmployerCreateBenefitEligibilityPolicyParams
-
   EmployerCreateParams = VitableConnect::Models::EmployerCreateParams
 
   EmployerListEmployeesParams = VitableConnect::Models::EmployerListEmployeesParams
@@ -75,14 +66,32 @@ module VitableConnect
 
   EmployerSubmitCensusSyncParams = VitableConnect::Models::EmployerSubmitCensusSyncParams
 
+  EmployerUpdateSettingsParams = VitableConnect::Models::EmployerUpdateSettingsParams
+
   Enrollment = VitableConnect::Models::Enrollment
 
   EnrollmentRetrieveParams = VitableConnect::Models::EnrollmentRetrieveParams
 
   EnrollmentStatus = VitableConnect::Models::EnrollmentStatus
 
+  Group = VitableConnect::Models::Group
+
+  GroupCreateParams = VitableConnect::Models::GroupCreateParams
+
+  GroupListParams = VitableConnect::Models::GroupListParams
+
+  GroupResponse = VitableConnect::Models::GroupResponse
+
+  GroupRetrieveParams = VitableConnect::Models::GroupRetrieveParams
+
+  Groups = VitableConnect::Models::Groups
+
+  GroupUpdateParams = VitableConnect::Models::GroupUpdateParams
+
   Pagination = VitableConnect::Models::Pagination
 
+  PlanListParams = VitableConnect::Models::PlanListParams
+
   Type = VitableConnect::Models::Type
 
   WebhookEvent = VitableConnect::Models::WebhookEvent

data/lib/vitable_connect/resources/benefit_eligibility_policies.rb

@@ -2,28 +2,7 @@
 
 module VitableConnect
   module Resources
-    # Define rules that determine which employees qualify for benefits
     class BenefitEligibilityPolicies
-      # Retrieves a benefit eligibility policy by ID.
-      #
-      # @overload retrieve(policy_id, request_options: {})
-      #
-      # @param policy_id [String] Unique benefit eligibility policy identifier (epol\_\*)
-      #
-      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [VitableConnect::Models::BenefitEligibilityPolicyResponse]
-      #
-      # @see VitableConnect::Models::BenefitEligibilityPolicyRetrieveParams
-      def retrieve(policy_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["v1/benefit-eligibility-policies/%1$s", policy_id],
-          model: VitableConnect::BenefitEligibilityPolicyResponse,
-          options: params[:request_options]
-        )
-      end
-
       # @api private
       #
       # @param client [VitableConnect::Client]

data/lib/vitable_connect/resources/employers.rb

@@ -88,36 +88,6 @@ module VitableConnect
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {VitableConnect::Models::EmployerCreateBenefitEligibilityPolicyParams} for more
-      # details.
-      #
-      # Creates a benefit eligibility policy for the specified employer.
-      #
-      # @overload create_benefit_eligibility_policy(employer_id, classification:, waiting_period:, request_options: {})
-      #
-      # @param employer_id [String] Unique employer identifier (empr\_\*)
-      #
-      # @param classification [String] Which employee classifications are eligible. One of: full_time, part_time, all
-      #
-      # @param waiting_period [String] Waiting period before eligibility. One of: first_of_following_month, 30_days, 60
-      #
-      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [VitableConnect::Models::BenefitEligibilityPolicyResponse]
-      #
-      # @see VitableConnect::Models::EmployerCreateBenefitEligibilityPolicyParams
-      def create_benefit_eligibility_policy(employer_id, params)
-        parsed, options = VitableConnect::EmployerCreateBenefitEligibilityPolicyParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: ["v1/employers/%1$s/benefit-eligibility-policies", employer_id],
-          body: parsed,
-          model: VitableConnect::BenefitEligibilityPolicyResponse,
-          options: options
-        )
-      end
-
       # Retrieves a paginated list of all employees for a specific employer. Results are
       # paginated using page and limit parameters. Each employee includes payroll
       # deductions from the most recent statement period. When a new deduction statement
@@ -175,6 +145,34 @@ module VitableConnect
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {VitableConnect::Models::EmployerUpdateSettingsParams} for more details.
+      #
+      # Updates configuration settings for a specific employer. The employer must belong
+      # to the authenticated organization.
+      #
+      # @overload update_settings(employer_id, pay_frequency:, request_options: {})
+      #
+      # @param employer_id [String] Unique employer identifier (empr\_\*)
+      #
+      # @param pay_frequency [Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency] - `weekly` - weekly
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::EmployerUpdateSettingsResponse]
+      #
+      # @see VitableConnect::Models::EmployerUpdateSettingsParams
+      def update_settings(employer_id, params)
+        parsed, options = VitableConnect::EmployerUpdateSettingsParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["v1/employers/%1$s/settings", employer_id],
+          body: parsed,
+          model: VitableConnect::Models::EmployerUpdateSettingsResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [VitableConnect::Client]

data/lib/vitable_connect/resources/groups/members/sync.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Resources
+    class Groups
+      class Members
+        class Sync
+          # Retrieves a previously-submitted group member sync request by its `grpmsr_` ID.
+          # Returns the acceptance timestamp, completion timestamp (if processing has
+          # finished), and the per-member `results` once available. While processing is in
+          # flight, `completed_at` and `results` are `null`.
+          #
+          # @overload retrieve(request_id, group_id:, request_options: {})
+          #
+          # @param request_id [String]
+          #
+          # @param group_id [String] Unique group identifier (grp\_\*)
+          #
+          # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [VitableConnect::Models::Groups::Members::SyncRetrieveResponse]
+          #
+          # @see VitableConnect::Models::Groups::Members::SyncRetrieveParams
+          def retrieve(request_id, params)
+            parsed, options = VitableConnect::Groups::Members::SyncRetrieveParams.dump_request(params)
+            group_id =
+              parsed.delete(:group_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["v1/groups/%1$s/members/sync/%2$s", group_id, request_id],
+              model: VitableConnect::Models::Groups::Members::SyncRetrieveResponse,
+              options: options
+            )
+          end
+
+          # Submits a member sync payload for the specified group. Members in the payload
+          # will be queued for processing asynchronously. Returns HTTP 202 with the batch ID
+          # and acceptance timestamp.
+          #
+          # @overload submit(group_id, members:, request_options: {})
+          #
+          # @param group_id [String] Unique group identifier (grp\_\*)
+          #
+          # @param members [Array<VitableConnect::Models::Groups::Members::SyncSubmitParams::Member>]
+          #
+          # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [VitableConnect::Models::Groups::Members::SyncSubmitResponse]
+          #
+          # @see VitableConnect::Models::Groups::Members::SyncSubmitParams
+          def submit(group_id, params)
+            parsed, options = VitableConnect::Groups::Members::SyncSubmitParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["v1/groups/%1$s/members/sync", group_id],
+              body: parsed,
+              model: VitableConnect::Models::Groups::Members::SyncSubmitResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [VitableConnect::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vitable_connect/resources/groups/members.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Resources
+    class Groups
+      class Members
+        # @return [VitableConnect::Resources::Groups::Members::Sync]
+        attr_reader :sync
+
+        # @api private
+        #
+        # @param client [VitableConnect::Client]
+        def initialize(client:)
+          @client = client
+          @sync = VitableConnect::Resources::Groups::Members::Sync.new(client: client)
+        end
+      end
+    end
+  end
+end