vitable-connect 0.3.0 → 0.4.0

data/rbi/vitable_connect/models/groups/members/sync_retrieve_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        class SyncRetrieveParams < VitableConnect::Internal::Type::BaseModel
+          extend VitableConnect::Internal::Type::RequestParameters::Converter
+          include VitableConnect::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                VitableConnect::Groups::Members::SyncRetrieveParams,
+                VitableConnect::Internal::AnyHash
+              )
+            end
+
+          # Unique group identifier (grp\_\*)
+          sig { returns(String) }
+          attr_accessor :group_id
+
+          sig { returns(String) }
+          attr_accessor :request_id
+
+          sig do
+            params(
+              group_id: String,
+              request_id: String,
+              request_options: VitableConnect::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique group identifier (grp\_\*)
+            group_id:,
+            request_id:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                group_id: String,
+                request_id: String,
+                request_options: VitableConnect::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/groups/members/sync_retrieve_response.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        class SyncRetrieveResponse < VitableConnect::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                VitableConnect::Models::Groups::Members::SyncRetrieveResponse,
+                VitableConnect::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          # Response containing a single group member sync request detail resource.
+          sig do
+            params(
+              data:
+                VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data:)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < VitableConnect::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  VitableConnect::Models::Groups::Members::SyncRetrieveResponse::Data,
+                  VitableConnect::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Time) }
+            attr_accessor :accepted_at
+
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :completed_at
+
+            sig { returns(String) }
+            attr_accessor :group_id
+
+            sig { returns(String) }
+            attr_accessor :request_id
+
+            sig { returns(T.anything) }
+            attr_accessor :results
+
+            sig do
+              params(
+                accepted_at: Time,
+                completed_at: T.nilable(Time),
+                group_id: String,
+                request_id: String,
+                results: T.anything
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              accepted_at:,
+              completed_at:,
+              group_id:,
+              request_id:,
+              results:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  accepted_at: Time,
+                  completed_at: T.nilable(Time),
+                  group_id: String,
+                  request_id: String,
+                  results: T.anything
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/groups/members/sync_submit_params.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        class SyncSubmitParams < VitableConnect::Internal::Type::BaseModel
+          extend VitableConnect::Internal::Type::RequestParameters::Converter
+          include VitableConnect::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                VitableConnect::Groups::Members::SyncSubmitParams,
+                VitableConnect::Internal::AnyHash
+              )
+            end
+
+          # Unique group identifier (grp\_\*)
+          sig { returns(String) }
+          attr_accessor :group_id
+
+          sig do
+            returns(
+              T::Array[
+                VitableConnect::Groups::Members::SyncSubmitParams::Member
+              ]
+            )
+          end
+          attr_accessor :members
+
+          sig do
+            params(
+              group_id: String,
+              members:
+                T::Array[
+                  VitableConnect::Groups::Members::SyncSubmitParams::Member::OrHash
+                ],
+              request_options: VitableConnect::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique group identifier (grp\_\*)
+            group_id:,
+            members:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                group_id: String,
+                members:
+                  T::Array[
+                    VitableConnect::Groups::Members::SyncSubmitParams::Member
+                  ],
+                request_options: VitableConnect::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Member < VitableConnect::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  VitableConnect::Groups::Members::SyncSubmitParams::Member,
+                  VitableConnect::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                VitableConnect::Groups::Members::SyncSubmitParams::Member::Address
+              )
+            end
+            attr_reader :address
+
+            sig do
+              params(
+                address:
+                  VitableConnect::Groups::Members::SyncSubmitParams::Member::Address::OrHash
+              ).void
+            end
+            attr_writer :address
+
+            sig { returns(Date) }
+            attr_accessor :date_of_birth
+
+            sig { returns(String) }
+            attr_accessor :first_name
+
+            sig { returns(String) }
+            attr_accessor :last_name
+
+            sig { returns(String) }
+            attr_accessor :phone
+
+            sig { returns(String) }
+            attr_accessor :plan_id
+
+            sig { returns(String) }
+            attr_accessor :reference_id
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :email
+
+            sig do
+              params(
+                address:
+                  VitableConnect::Groups::Members::SyncSubmitParams::Member::Address::OrHash,
+                date_of_birth: Date,
+                first_name: String,
+                last_name: String,
+                phone: String,
+                plan_id: String,
+                reference_id: String,
+                email: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              address:,
+              date_of_birth:,
+              first_name:,
+              last_name:,
+              phone:,
+              plan_id:,
+              reference_id:,
+              email: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  address:
+                    VitableConnect::Groups::Members::SyncSubmitParams::Member::Address,
+                  date_of_birth: Date,
+                  first_name: String,
+                  last_name: String,
+                  phone: String,
+                  plan_id: String,
+                  reference_id: String,
+                  email: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Address < VitableConnect::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    VitableConnect::Groups::Members::SyncSubmitParams::Member::Address,
+                    VitableConnect::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :address_line_1
+
+              sig { returns(String) }
+              attr_accessor :city
+
+              sig { returns(String) }
+              attr_accessor :state
+
+              sig { returns(String) }
+              attr_accessor :zipcode
+
+              sig { returns(T.nilable(String)) }
+              attr_accessor :address_line_2
+
+              sig do
+                params(
+                  address_line_1: String,
+                  city: String,
+                  state: String,
+                  zipcode: String,
+                  address_line_2: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                address_line_1:,
+                city:,
+                state:,
+                zipcode:,
+                address_line_2: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    address_line_1: String,
+                    city: String,
+                    state: String,
+                    zipcode: String,
+                    address_line_2: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/groups/members/sync_submit_response.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        class SyncSubmitResponse < VitableConnect::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                VitableConnect::Models::Groups::Members::SyncSubmitResponse,
+                VitableConnect::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              VitableConnect::Models::Groups::Members::SyncSubmitResponse::Data
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                VitableConnect::Models::Groups::Members::SyncSubmitResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          # Response containing a single group member sync detail resource.
+          sig do
+            params(
+              data:
+                VitableConnect::Models::Groups::Members::SyncSubmitResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data:)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  VitableConnect::Models::Groups::Members::SyncSubmitResponse::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < VitableConnect::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  VitableConnect::Models::Groups::Members::SyncSubmitResponse::Data,
+                  VitableConnect::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Time) }
+            attr_accessor :accepted_at
+
+            sig { returns(String) }
+            attr_accessor :group_id
+
+            sig { returns(String) }
+            attr_accessor :request_id
+
+            sig do
+              params(
+                accepted_at: Time,
+                group_id: String,
+                request_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(accepted_at:, group_id:, request_id:)
+            end
+
+            sig do
+              override.returns(
+                { accepted_at: Time, group_id: String, request_id: String }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/plan_list_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class PlanListParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::PlanListParams,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      # Items per page (default: 20, max: 100)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Page number (default: 1)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      sig do
+        params(
+          limit: Integer,
+          page: Integer,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Items per page (default: 20, max: 100)
+        limit: nil,
+        # Page number (default: 1)
+        page: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            limit: Integer,
+            page: Integer,
+            request_options: VitableConnect::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models/plan_list_response.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module VitableConnect
+  module Models
+    class PlanListResponse < VitableConnect::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            VitableConnect::Models::PlanListResponse,
+            VitableConnect::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { params(id: String, name: String).returns(T.attached_class) }
+      def self.new(id:, name:)
+      end
+
+      sig { override.returns({ id: String, name: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/vitable_connect/models.rbi

@@ -40,14 +40,33 @@ 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/rbi/vitable_connect/resources/employers.rbi

@@ -140,6 +140,28 @@ module VitableConnect
       )
       end
 
+      # Updates configuration settings for a specific employer. The employer must belong
+      # to the authenticated organization.
+      sig do
+        params(
+          employer_id: String,
+          pay_frequency:
+            VitableConnect::EmployerUpdateSettingsParams::PayFrequency::OrSymbol,
+          request_options: VitableConnect::RequestOptions::OrHash
+        ).returns(VitableConnect::Models::EmployerUpdateSettingsResponse)
+      end
+      def update_settings(
+        # Unique employer identifier (empr\_\*)
+        employer_id,
+        # - `weekly` - weekly
+        # - `bi_weekly` - bi_weekly
+        # - `semi_monthly` - semi_monthly
+        # - `monthly` - monthly
+        pay_frequency:,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: VitableConnect::Client).returns(T.attached_class) }
       def self.new(client:)

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