vitable-connect 0.3.0 → 0.4.0

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.rb

@@ -75,14 +75,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/employers.rb

@@ -175,6 +175,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

data/lib/vitable_connect/resources/groups.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Resources
+    class Groups
+      # @return [VitableConnect::Resources::Groups::Members]
+      attr_reader :members
+
+      # Creates a new group scoped to the authenticated organization.
+      #
+      # @overload create(external_reference_id:, name:, request_options: {})
+      #
+      # @param external_reference_id [String]
+      # @param name [String]
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::GroupResponse]
+      #
+      # @see VitableConnect::Models::GroupCreateParams
+      def create(params)
+        parsed, options = VitableConnect::GroupCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/groups",
+          body: parsed,
+          model: VitableConnect::GroupResponse,
+          options: options
+        )
+      end
+
+      # Retrieves a single group by its prefixed ID. Returns 404 if the group does not
+      # belong to the authenticated organization.
+      #
+      # @overload retrieve(group_id, request_options: {})
+      #
+      # @param group_id [String] Unique group identifier (grp\_\*)
+      #
+      # @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [VitableConnect::Models::GroupResponse]
+      #
+      # @see VitableConnect::Models::GroupRetrieveParams
+      def retrieve(group_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/groups/%1$s", group_id],
+          model: VitableConnect::GroupResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Partially updates a group's name or external reference ID. Returns 404 if the
+      # group does not belong to the authenticated organization.
+      #
+      # @overload update(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}, nil]
+      #
+      # @return [VitableConnect::Models::GroupResponse]
+      #
+      # @see VitableConnect::Models::GroupUpdateParams
+      def update(group_id, params = {})
+        parsed, options = VitableConnect::GroupUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/groups/%1$s", group_id],
+          body: parsed,
+          model: VitableConnect::GroupResponse,
+          options: options
+        )
+      end
+
+      # Returns a paginated list of groups belonging to the authenticated organization.
+      #
+      # @overload list(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}, nil]
+      #
+      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::Group>]
+      #
+      # @see VitableConnect::Models::GroupListParams
+      def list(params = {})
+        parsed, options = VitableConnect::GroupListParams.dump_request(params)
+        query = VitableConnect::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/groups",
+          query: query,
+          page: VitableConnect::Internal::PageNumberPage,
+          model: VitableConnect::Group,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [VitableConnect::Client]
+      def initialize(client:)
+        @client = client
+        @members = VitableConnect::Resources::Groups::Members.new(client: client)
+      end
+    end
+  end
+end

data/lib/vitable_connect/resources/plans.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Resources
+    class Plans
+      # Returns a paginated list of benefit plans linked to the authenticated
+      # organization.
+      #
+      # @overload list(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}, nil]
+      #
+      # @return [VitableConnect::Internal::PageNumberPage<VitableConnect::Models::PlanListResponse>]
+      #
+      # @see VitableConnect::Models::PlanListParams
+      def list(params = {})
+        parsed, options = VitableConnect::PlanListParams.dump_request(params)
+        query = VitableConnect::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v1/plans",
+          query: query,
+          page: VitableConnect::Internal::PageNumberPage,
+          model: VitableConnect::Models::PlanListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [VitableConnect::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/vitable_connect/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VitableConnect
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/vitable_connect.rb

@@ -72,11 +72,25 @@ require_relative "vitable_connect/models/employer_response"
 require_relative "vitable_connect/models/employer_retrieve_params"
 require_relative "vitable_connect/models/employer_submit_census_sync_params"
 require_relative "vitable_connect/models/employer_submit_census_sync_response"
+require_relative "vitable_connect/models/employer_update_settings_params"
+require_relative "vitable_connect/models/employer_update_settings_response"
 require_relative "vitable_connect/models/enrollment"
 require_relative "vitable_connect/models/enrollment_retrieve_params"
 require_relative "vitable_connect/models/enrollment_retrieve_response"
 require_relative "vitable_connect/models/enrollment_status"
+require_relative "vitable_connect/models/group"
+require_relative "vitable_connect/models/group_create_params"
+require_relative "vitable_connect/models/group_list_params"
+require_relative "vitable_connect/models/group_response"
+require_relative "vitable_connect/models/group_retrieve_params"
+require_relative "vitable_connect/models/groups/members/sync_retrieve_params"
+require_relative "vitable_connect/models/groups/members/sync_retrieve_response"
+require_relative "vitable_connect/models/groups/members/sync_submit_params"
+require_relative "vitable_connect/models/groups/members/sync_submit_response"
+require_relative "vitable_connect/models/group_update_params"
 require_relative "vitable_connect/models/pagination"
+require_relative "vitable_connect/models/plan_list_params"
+require_relative "vitable_connect/models/plan_list_response"
 require_relative "vitable_connect/models/type"
 require_relative "vitable_connect/models/webhook_event"
 require_relative "vitable_connect/models/webhook_event_list_deliveries_params"
@@ -90,4 +104,8 @@ require_relative "vitable_connect/resources/benefit_eligibility_policies"
 require_relative "vitable_connect/resources/employees"
 require_relative "vitable_connect/resources/employers"
 require_relative "vitable_connect/resources/enrollments"
+require_relative "vitable_connect/resources/groups"
+require_relative "vitable_connect/resources/groups/members"
+require_relative "vitable_connect/resources/groups/members/sync"
+require_relative "vitable_connect/resources/plans"
 require_relative "vitable_connect/resources/webhook_events"

data/rbi/vitable_connect/client.rbi

@@ -45,6 +45,12 @@ module VitableConnect
     sig { returns(VitableConnect::Resources::WebhookEvents) }
     attr_reader :webhook_events
 
+    sig { returns(VitableConnect::Resources::Groups) }
+    attr_reader :groups
+
+    sig { returns(VitableConnect::Resources::Plans) }
+    attr_reader :plans
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers