vitable-connect 0.2.2 → 0.4.0

data/rbi/vitable_connect/resources/groups/members/sync.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+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`.
+          sig do
+            params(
+              request_id: String,
+              group_id: String,
+              request_options: VitableConnect::RequestOptions::OrHash
+            ).returns(
+              VitableConnect::Models::Groups::Members::SyncRetrieveResponse
+            )
+          end
+          def retrieve(
+            request_id,
+            # Unique group identifier (grp\_\*)
+            group_id:,
+            request_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.
+          sig do
+            params(
+              group_id: String,
+              members:
+                T::Array[
+                  VitableConnect::Groups::Members::SyncSubmitParams::Member::OrHash
+                ],
+              request_options: VitableConnect::RequestOptions::OrHash
+            ).returns(
+              VitableConnect::Models::Groups::Members::SyncSubmitResponse
+            )
+          end
+          def submit(
+            # Unique group identifier (grp\_\*)
+            group_id,
+            members:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig do
+            params(client: VitableConnect::Client).returns(T.attached_class)
+          end
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/resources/groups/members.rbi

@@ -0,0 +1,17 @@
+# typed: strong
+
+module VitableConnect
+  module Resources
+    class Groups
+      class Members
+        sig { returns(VitableConnect::Resources::Groups::Members::Sync) }
+        attr_reader :sync
+
+        # @api private
+        sig { params(client: VitableConnect::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/resources/groups.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module VitableConnect
+  module Resources
+    class Groups
+      sig { returns(VitableConnect::Resources::Groups::Members) }
+      attr_reader :members
+
+      # Creates a new group scoped to the authenticated organization.
+      sig do
+        params(
+          external_reference_id: String,
+          name: String,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(VitableConnect::GroupResponse)
+      end
+      def create(external_reference_id:, name:, request_options: {})
+      end
+
+      # Retrieves a single group by its prefixed ID. Returns 404 if the group does not
+      # belong to the authenticated organization.
+      sig do
+        params(
+          group_id: String,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(VitableConnect::GroupResponse)
+      end
+      def retrieve(
+        # Unique group identifier (grp\_\*)
+        group_id,
+        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.
+      sig do
+        params(
+          group_id: String,
+          external_reference_id: T.nilable(String),
+          name: T.nilable(String),
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(VitableConnect::GroupResponse)
+      end
+      def update(
+        # Unique group identifier (grp\_\*)
+        group_id,
+        external_reference_id: nil,
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of groups belonging to the authenticated organization.
+      sig do
+        params(
+          limit: Integer,
+          page: Integer,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(
+          VitableConnect::Internal::PageNumberPage[VitableConnect::Group]
+        )
+      end
+      def list(
+        # Items per page (default: 20, max: 100)
+        limit: nil,
+        # Page number (default: 1)
+        page: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/vitable_connect/resources/plans.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module VitableConnect
+  module Resources
+    class Plans
+      # Returns a paginated list of benefit plans linked to the authenticated
+      # organization.
+      sig do
+        params(
+          limit: Integer,
+          page: Integer,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(
+          VitableConnect::Internal::PageNumberPage[
+            VitableConnect::Models::PlanListResponse
+          ]
+        )
+      end
+      def list(
+        # Items per page (default: 20, max: 100)
+        limit: nil,
+        # Page number (default: 1)
+        page: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: VitableConnect::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/vitable_connect/client.rbs

@@ -27,6 +27,10 @@ module VitableConnect
 
     attr_reader webhook_events: VitableConnect::Resources::WebhookEvents
 
+    attr_reader groups: VitableConnect::Resources::Groups
+
+    attr_reader plans: VitableConnect::Resources::Plans
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/vitable_connect/models/employee.rbs

@@ -7,7 +7,6 @@ module VitableConnect
         date_of_birth: Date,
         deductions: ::Array[VitableConnect::Employee::Deduction],
         email: String,
-        enrollments: ::Array[VitableConnect::Employee::Enrollment],
         first_name: String,
         last_name: String,
         member_id: String,
@@ -32,8 +31,6 @@ module VitableConnect
 
       attr_accessor email: String
 
-      attr_accessor enrollments: ::Array[VitableConnect::Employee::Enrollment]
-
       attr_accessor first_name: String
 
       attr_accessor last_name: String
@@ -68,7 +65,6 @@ module VitableConnect
         date_of_birth: Date,
         deductions: ::Array[VitableConnect::Employee::Deduction],
         email: String,
-        enrollments: ::Array[VitableConnect::Employee::Enrollment],
         first_name: String,
         last_name: String,
         member_id: String,
@@ -90,7 +86,6 @@ module VitableConnect
         date_of_birth: Date,
         deductions: ::Array[VitableConnect::Employee::Deduction],
         email: String,
-        enrollments: ::Array[VitableConnect::Employee::Enrollment],
         first_name: String,
         last_name: String,
         member_id: String,
@@ -152,11 +147,14 @@ module VitableConnect
           tax_classification: VitableConnect::Models::Employee::Deduction::tax_classification
         }
 
-        type frequency = :monthly
+        type frequency = :weekly | :bi_weekly | :semi_monthly | :monthly
 
         module Frequency
           extend VitableConnect::Internal::Type::Enum
 
+          WEEKLY: :weekly
+          BI_WEEKLY: :bi_weekly
+          SEMI_MONTHLY: :semi_monthly
           MONTHLY: :monthly
 
           def self?.values: -> ::Array[VitableConnect::Models::Employee::Deduction::frequency]
@@ -175,33 +173,6 @@ module VitableConnect
         end
       end
 
-      type enrollment =
-        {
-          id: String,
-          status: VitableConnect::Models::enrollment_status,
-          answered_at: Time?
-        }
-
-      class Enrollment < VitableConnect::Internal::Type::BaseModel
-        attr_accessor status: VitableConnect::Models::enrollment_status
-
-        attr_accessor answered_at: Time?
-
-        attr_accessor id: String
-
-        def initialize: (
-          id: String,
-          status: VitableConnect::Models::enrollment_status,
-          ?answered_at: Time?
-        ) -> void
-
-        def to_hash: -> {
-          id: String,
-          status: VitableConnect::Models::enrollment_status,
-          answered_at: Time?
-        }
-      end
-
       type address =
         {
           :address_line_1 => String,

data/sig/vitable_connect/models/employer_update_settings_params.rbs

@@ -0,0 +1,44 @@
+module VitableConnect
+  module Models
+    type employer_update_settings_params =
+      {
+        employer_id: String,
+        pay_frequency: VitableConnect::Models::EmployerUpdateSettingsParams::pay_frequency
+      }
+      & VitableConnect::Internal::Type::request_parameters
+
+    class EmployerUpdateSettingsParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      attr_accessor employer_id: String
+
+      attr_accessor pay_frequency: VitableConnect::Models::EmployerUpdateSettingsParams::pay_frequency
+
+      def initialize: (
+        employer_id: String,
+        pay_frequency: VitableConnect::Models::EmployerUpdateSettingsParams::pay_frequency,
+        ?request_options: VitableConnect::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        employer_id: String,
+        pay_frequency: VitableConnect::Models::EmployerUpdateSettingsParams::pay_frequency,
+        request_options: VitableConnect::RequestOptions
+      }
+
+      type pay_frequency = :weekly | :bi_weekly | :semi_monthly | :monthly
+
+      module PayFrequency
+        extend VitableConnect::Internal::Type::Enum
+
+        WEEKLY: :weekly
+        BI_WEEKLY: :bi_weekly
+        SEMI_MONTHLY: :semi_monthly
+        MONTHLY: :monthly
+
+        def self?.values: -> ::Array[VitableConnect::Models::EmployerUpdateSettingsParams::pay_frequency]
+      end
+    end
+  end
+end

data/sig/vitable_connect/models/employer_update_settings_response.rbs

@@ -0,0 +1,48 @@
+module VitableConnect
+  module Models
+    type employer_update_settings_response =
+      { data: VitableConnect::Models::EmployerUpdateSettingsResponse::Data }
+
+    class EmployerUpdateSettingsResponse < VitableConnect::Internal::Type::BaseModel
+      attr_accessor data: VitableConnect::Models::EmployerUpdateSettingsResponse::Data
+
+      def initialize: (
+        data: VitableConnect::Models::EmployerUpdateSettingsResponse::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: VitableConnect::Models::EmployerUpdateSettingsResponse::Data
+      }
+
+      type data =
+        {
+          pay_frequency: VitableConnect::Models::EmployerUpdateSettingsResponse::Data::pay_frequency?
+        }
+
+      class Data < VitableConnect::Internal::Type::BaseModel
+        attr_accessor pay_frequency: VitableConnect::Models::EmployerUpdateSettingsResponse::Data::pay_frequency?
+
+        def initialize: (
+          pay_frequency: VitableConnect::Models::EmployerUpdateSettingsResponse::Data::pay_frequency?
+        ) -> void
+
+        def to_hash: -> {
+          pay_frequency: VitableConnect::Models::EmployerUpdateSettingsResponse::Data::pay_frequency?
+        }
+
+        type pay_frequency = :weekly | :bi_weekly | :semi_monthly | :monthly
+
+        module PayFrequency
+          extend VitableConnect::Internal::Type::Enum
+
+          WEEKLY: :weekly
+          BI_WEEKLY: :bi_weekly
+          SEMI_MONTHLY: :semi_monthly
+          MONTHLY: :monthly
+
+          def self?.values: -> ::Array[VitableConnect::Models::EmployerUpdateSettingsResponse::Data::pay_frequency]
+        end
+      end
+    end
+  end
+end

data/sig/vitable_connect/models/group.rbs

@@ -0,0 +1,45 @@
+module VitableConnect
+  module Models
+    type group =
+      {
+        id: String,
+        created_at: Time?,
+        external_reference_id: String,
+        name: String,
+        organization_id: String,
+        updated_at: Time?
+      }
+
+    class Group < VitableConnect::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time?
+
+      attr_accessor external_reference_id: String
+
+      attr_accessor name: String
+
+      attr_accessor organization_id: String
+
+      attr_accessor updated_at: Time?
+
+      def initialize: (
+        id: String,
+        created_at: Time?,
+        external_reference_id: String,
+        name: String,
+        organization_id: String,
+        updated_at: Time?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time?,
+        external_reference_id: String,
+        name: String,
+        organization_id: String,
+        updated_at: Time?
+      }
+    end
+  end
+end

data/sig/vitable_connect/models/group_create_params.rbs

@@ -0,0 +1,28 @@
+module VitableConnect
+  module Models
+    type group_create_params =
+      { external_reference_id: String, name: String }
+      & VitableConnect::Internal::Type::request_parameters
+
+    class GroupCreateParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      attr_accessor external_reference_id: String
+
+      attr_accessor name: String
+
+      def initialize: (
+        external_reference_id: String,
+        name: String,
+        ?request_options: VitableConnect::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        external_reference_id: String,
+        name: String,
+        request_options: VitableConnect::RequestOptions
+      }
+    end
+  end
+end

data/sig/vitable_connect/models/group_list_params.rbs

@@ -0,0 +1,32 @@
+module VitableConnect
+  module Models
+    type group_list_params =
+      { limit: Integer, page: Integer }
+      & VitableConnect::Internal::Type::request_parameters
+
+    class GroupListParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_reader page: Integer?
+
+      def page=: (Integer) -> Integer
+
+      def initialize: (
+        ?limit: Integer,
+        ?page: Integer,
+        ?request_options: VitableConnect::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        limit: Integer,
+        page: Integer,
+        request_options: VitableConnect::RequestOptions
+      }
+    end
+  end
+end

data/sig/vitable_connect/models/group_response.rbs

@@ -0,0 +1,13 @@
+module VitableConnect
+  module Models
+    type group_response = { data: VitableConnect::Group }
+
+    class GroupResponse < VitableConnect::Internal::Type::BaseModel
+      attr_accessor data: VitableConnect::Group
+
+      def initialize: (data: VitableConnect::Group) -> void
+
+      def to_hash: -> { data: VitableConnect::Group }
+    end
+  end
+end

data/sig/vitable_connect/models/group_retrieve_params.rbs

@@ -0,0 +1,23 @@
+module VitableConnect
+  module Models
+    type group_retrieve_params =
+      { group_id: String } & VitableConnect::Internal::Type::request_parameters
+
+    class GroupRetrieveParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      attr_accessor group_id: String
+
+      def initialize: (
+        group_id: String,
+        ?request_options: VitableConnect::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        group_id: String,
+        request_options: VitableConnect::RequestOptions
+      }
+    end
+  end
+end

data/sig/vitable_connect/models/group_update_params.rbs

@@ -0,0 +1,32 @@
+module VitableConnect
+  module Models
+    type group_update_params =
+      { group_id: String, external_reference_id: String?, name: String? }
+      & VitableConnect::Internal::Type::request_parameters
+
+    class GroupUpdateParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      attr_accessor group_id: String
+
+      attr_accessor external_reference_id: String?
+
+      attr_accessor name: String?
+
+      def initialize: (
+        group_id: String,
+        ?external_reference_id: String?,
+        ?name: String?,
+        ?request_options: VitableConnect::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        group_id: String,
+        external_reference_id: String?,
+        name: String?,
+        request_options: VitableConnect::RequestOptions
+      }
+    end
+  end
+end

data/sig/vitable_connect/models/groups/members/sync_retrieve_params.rbs

@@ -0,0 +1,32 @@
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        type sync_retrieve_params =
+          { group_id: String, request_id: String }
+          & VitableConnect::Internal::Type::request_parameters
+
+        class SyncRetrieveParams < VitableConnect::Internal::Type::BaseModel
+          extend VitableConnect::Internal::Type::RequestParameters::Converter
+          include VitableConnect::Internal::Type::RequestParameters
+
+          attr_accessor group_id: String
+
+          attr_accessor request_id: String
+
+          def initialize: (
+            group_id: String,
+            request_id: String,
+            ?request_options: VitableConnect::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            group_id: String,
+            request_id: String,
+            request_options: VitableConnect::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/vitable_connect/models/groups/members/sync_retrieve_response.rbs

@@ -0,0 +1,61 @@
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        type sync_retrieve_response =
+          {
+            data: VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data
+          }
+
+        class SyncRetrieveResponse < VitableConnect::Internal::Type::BaseModel
+          attr_accessor data: VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data
+
+          def initialize: (
+            data: VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data
+          ) -> void
+
+          def to_hash: -> {
+            data: VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data
+          }
+
+          type data =
+            {
+              accepted_at: Time,
+              completed_at: Time?,
+              group_id: String,
+              request_id: String,
+              results: top
+            }
+
+          class Data < VitableConnect::Internal::Type::BaseModel
+            attr_accessor accepted_at: Time
+
+            attr_accessor completed_at: Time?
+
+            attr_accessor group_id: String
+
+            attr_accessor request_id: String
+
+            attr_accessor results: top
+
+            def initialize: (
+              accepted_at: Time,
+              completed_at: Time?,
+              group_id: String,
+              request_id: String,
+              results: top
+            ) -> void
+
+            def to_hash: -> {
+              accepted_at: Time,
+              completed_at: Time?,
+              group_id: String,
+              request_id: String,
+              results: top
+            }
+          end
+        end
+      end
+    end
+  end
+end