vitable-connect 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d19150b41214f8f64eead96cac977500a2fec2b2af851569bae8878b6e313a57
-  data.tar.gz: bdccce83b4bb326a6c362e8640b70465c2cd5e28185757a47d200c6cefe943b1
+  metadata.gz: 5b7bde326a118d6bf7e828b5656d7a171347a8f56cd6462ebd9039513c111deb
+  data.tar.gz: 81933369ea36e6cc106bfcf36f89a4730675a5fb213ae1ffb77dcb68b0f8c5cc
 SHA512:
-  metadata.gz: b546096529e4786fa985f0ce9843b8f7379f0d18968eb27b1f7b456719e216dff854037ae204f267515b305ebd89528f356f2cb2664377ea8140512cc3357d0a
-  data.tar.gz: b9fb5cabe64d38d8dc5fa19a93d3c5f2079b9dcbceff8aac61c0699ef6fce529cd1fcf373ce3bb58dc39bc1b724a8f1e31a4ab58bb42ec680d7b11847ff80275
+  metadata.gz: d738d00b68acbf4f3d801da254c7aec0e490c36d36ffa3ca48ea52f9a69320e8ec7887c3365ac9706170a901642042dfd290d50c01206bf50c51e326fa033356
+  data.tar.gz: 1d1f53004097675d631528b82e275558fa3f01bdb51bb65b2ef4d906a41a885dc3dff8e810acc8a28bffdf32faef58b19bc9b702d35fe337ae03314bf7571179

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.4.0 (2026-05-15)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/Vitable-Inc/vitable-connect-ruby/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([5891ffa](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/5891ffad3ab9bd4ece9a1e2c17e66a07ff30a228))
+* **api:** api update ([62eabe5](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/62eabe5767331aa848e6abaf1a229ee068fc299b))
+* **api:** manual updates ([ca33b4f](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/ca33b4fd801e497a4237e7d69bf557857be075d3))
+* support setting headers via env ([707a5d3](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/707a5d38e79b1e64ed132653910fec8a5a5bf125))
+
+
+### Bug Fixes
+
+* **client:** elide content type header on requests without body ([8427bb0](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/8427bb0aefea63b6d8b594cfcb400f8cff2c2b86))
+
+
+### Chores
+
+* **internal:** more robust bootstrap script ([921ddac](https://github.com/Vitable-Inc/vitable-connect-ruby/commit/921ddac9d3073aeb1fdb7292d413eedfdaf5aa4c))
+
 ## 0.3.0 (2026-04-17)
 
 Full Changelog: [v0.2.2...v0.3.0](https://github.com/Vitable-Inc/vitable-connect-ruby/compare/v0.2.2...v0.3.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "vitable-connect", "~> 0.3.0"
+gem "vitable-connect", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->
@@ -229,25 +229,25 @@ vitable_connect.auth.issue_access_token(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :"enrollment.accepted"
-puts(VitableConnect::WebhookEventListParams::EventName::ENROLLMENT_ACCEPTED)
+# :weekly
+puts(VitableConnect::EmployerUpdateSettingsParams::PayFrequency::WEEKLY)
 
-# Revealed type: `T.all(VitableConnect::WebhookEventListParams::EventName, Symbol)`
-T.reveal_type(VitableConnect::WebhookEventListParams::EventName::ENROLLMENT_ACCEPTED)
+# Revealed type: `T.all(VitableConnect::EmployerUpdateSettingsParams::PayFrequency, Symbol)`
+T.reveal_type(VitableConnect::EmployerUpdateSettingsParams::PayFrequency::WEEKLY)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-vitable_connect.webhook_events.list(
-  event_name: VitableConnect::WebhookEventListParams::EventName::ENROLLMENT_ACCEPTED,
+vitable_connect.employers.update_settings(
+  pay_frequency: VitableConnect::EmployerUpdateSettingsParams::PayFrequency::WEEKLY,
   # …
 )
 
 # Literal values are also permissible:
-vitable_connect.webhook_events.list(
-  event_name: :"enrollment.accepted",
+vitable_connect.employers.update_settings(
+  pay_frequency: :weekly,
   # …
 )
 ```

data/lib/vitable_connect/client.rb

@@ -47,6 +47,12 @@ module VitableConnect
     # @return [VitableConnect::Resources::WebhookEvents]
     attr_reader :webhook_events
 
+    # @return [VitableConnect::Resources::Groups]
+    attr_reader :groups
+
+    # @return [VitableConnect::Resources::Plans]
+    attr_reader :plans
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -97,6 +103,19 @@ module VitableConnect
         raise ArgumentError.new("api_key is required, and can be set via environ: \"VITABLE_CONNECT_API_KEY\"")
       end
 
+      headers = {}
+      custom_headers_env = ENV["VITABLE_CONNECT_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_key = api_key.to_s
 
       super(
@@ -104,7 +123,8 @@ module VitableConnect
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @auth = VitableConnect::Resources::Auth.new(client: self)
@@ -113,6 +133,8 @@ module VitableConnect
       @employers = VitableConnect::Resources::Employers.new(client: self)
       @enrollments = VitableConnect::Resources::Enrollments.new(client: self)
       @webhook_events = VitableConnect::Resources::WebhookEvents.new(client: self)
+      @groups = VitableConnect::Resources::Groups.new(client: self)
+      @plans = VitableConnect::Resources::Plans.new(client: self)
     end
   end
 end

data/lib/vitable_connect/internal/transport/base_client.rb

@@ -306,6 +306,8 @@ module VitableConnect
               VitableConnect::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          headers.delete("content-type") if body.nil?
+
           url = VitableConnect::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

data/lib/vitable_connect/models/employee.rb

@@ -28,13 +28,6 @@ module VitableConnect
       #   @return [String]
       required :email, String
 
-      # @!attribute enrollments
-      #   Benefit enrollments for this employee
-      #
-      #   @return [Array<VitableConnect::Models::Employee::Enrollment>]
-      required :enrollments,
-               -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Employee::Enrollment] }
-
       # @!attribute first_name
       #   Employee's legal first name
       #
@@ -126,7 +119,7 @@ module VitableConnect
         required :status, String
       end
 
-      # @!method initialize(id:, created_at:, date_of_birth:, deductions:, email:, enrollments:, first_name:, last_name:, member_id:, status:, updated_at:, address: nil, employee_class: nil, gender: nil, hire_date: nil, phone: nil, reference_id: nil, suffix: nil, termination_date: nil)
+      # @!method initialize(id:, created_at:, date_of_birth:, deductions:, email:, first_name:, last_name:, member_id:, status:, updated_at:, address: nil, employee_class: nil, gender: nil, hire_date: nil, phone: nil, reference_id: nil, suffix: nil, termination_date: nil)
       #   Some parameter documentations has been truncated, see
       #   {VitableConnect::Models::Employee} for more details.
       #
@@ -140,8 +133,6 @@ module VitableConnect
       #
       #   @param email [String] Email address
       #
-      #   @param enrollments [Array<VitableConnect::Models::Employee::Enrollment>] Benefit enrollments for this employee
-      #
       #   @param first_name [String] Employee's legal first name
       #
       #   @param last_name [String] Employee's legal last name
@@ -269,41 +260,6 @@ module VitableConnect
         end
       end
 
-      class Enrollment < VitableConnect::Internal::Type::BaseModel
-        # @!attribute status
-        #   - `pending` - Pending
-        #   - `enrolled` - Enrolled
-        #   - `waived` - Waived
-        #   - `inactive` - Inactive
-        #
-        #   @return [Symbol, VitableConnect::Models::EnrollmentStatus]
-        required :status, enum: -> { VitableConnect::EnrollmentStatus }
-
-        # @!attribute answered_at
-        #   Timestamp when the enrollment decision was made
-        #
-        #   @return [Time, nil]
-        optional :answered_at, Time, nil?: true
-
-        response_only do
-          # @!attribute id
-          #   Unique enrollment identifier with 'enrl\_' prefix
-          #
-          #   @return [String]
-          required :id, String
-        end
-
-        # @!method initialize(id:, status:, answered_at: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {VitableConnect::Models::Employee::Enrollment} for more details.
-        #
-        #   @param id [String] Unique enrollment identifier with 'enrl\_' prefix
-        #
-        #   @param status [Symbol, VitableConnect::Models::EnrollmentStatus] - `pending` - Pending
-        #
-        #   @param answered_at [Time, nil] Timestamp when the enrollment decision was made
-      end
-
       # @see VitableConnect::Models::Employee#address
       class Address < VitableConnect::Internal::Type::BaseModel
         # @!attribute address_line_1

data/lib/vitable_connect/models/employer_update_settings_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employers#update_settings
+    class EmployerUpdateSettingsParams < VitableConnect::Internal::Type::BaseModel
+      extend VitableConnect::Internal::Type::RequestParameters::Converter
+      include VitableConnect::Internal::Type::RequestParameters
+
+      # @!attribute employer_id
+      #   Unique employer identifier (empr\_\*)
+      #
+      #   @return [String]
+      required :employer_id, String
+
+      # @!attribute pay_frequency
+      #   - `weekly` - weekly
+      #   - `bi_weekly` - bi_weekly
+      #   - `semi_monthly` - semi_monthly
+      #   - `monthly` - monthly
+      #
+      #   @return [Symbol, VitableConnect::Models::EmployerUpdateSettingsParams::PayFrequency]
+      required :pay_frequency, enum: -> { VitableConnect::EmployerUpdateSettingsParams::PayFrequency }
+
+      # @!method initialize(employer_id:, pay_frequency:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {VitableConnect::Models::EmployerUpdateSettingsParams} for more details.
+      #
+      #   @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}]
+
+      # - `weekly` - weekly
+      # - `bi_weekly` - bi_weekly
+      # - `semi_monthly` - semi_monthly
+      # - `monthly` - monthly
+      module PayFrequency
+        extend VitableConnect::Internal::Type::Enum
+
+        WEEKLY = :weekly
+        BI_WEEKLY = :bi_weekly
+        SEMI_MONTHLY = :semi_monthly
+        MONTHLY = :monthly
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/employer_update_settings_response.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Employers#update_settings
+    class EmployerUpdateSettingsResponse < VitableConnect::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [VitableConnect::Models::EmployerUpdateSettingsResponse::Data]
+      required :data, -> { VitableConnect::Models::EmployerUpdateSettingsResponse::Data }
+
+      # @!method initialize(data:)
+      #   Response containing a single employer settings resource.
+      #
+      #   @param data [VitableConnect::Models::EmployerUpdateSettingsResponse::Data]
+
+      # @see VitableConnect::Models::EmployerUpdateSettingsResponse#data
+      class Data < VitableConnect::Internal::Type::BaseModel
+        # @!attribute pay_frequency
+        #   - `weekly` - Weekly
+        #   - `bi_weekly` - Bi-Weekly
+        #   - `semi_monthly` - Semi-Monthly
+        #   - `monthly` - Monthly
+        #
+        #   @return [Symbol, VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency, nil]
+        required :pay_frequency,
+                 enum: -> { VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency },
+                 nil?: true
+
+        # @!method initialize(pay_frequency:)
+        #   Some parameter documentations has been truncated, see
+        #   {VitableConnect::Models::EmployerUpdateSettingsResponse::Data} for more details.
+        #
+        #   @param pay_frequency [Symbol, VitableConnect::Models::EmployerUpdateSettingsResponse::Data::PayFrequency, nil] - `weekly` - Weekly
+
+        # - `weekly` - Weekly
+        # - `bi_weekly` - Bi-Weekly
+        # - `semi_monthly` - Semi-Monthly
+        # - `monthly` - Monthly
+        #
+        # @see VitableConnect::Models::EmployerUpdateSettingsResponse::Data#pay_frequency
+        module PayFrequency
+          extend VitableConnect::Internal::Type::Enum
+
+          WEEKLY = :weekly
+          BI_WEEKLY = :bi_weekly
+          SEMI_MONTHLY = :semi_monthly
+          MONTHLY = :monthly
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/vitable_connect/models/group.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Groups#list
+    class Group < VitableConnect::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time, nil]
+      required :created_at, Time, nil?: true
+
+      # @!attribute external_reference_id
+      #
+      #   @return [String]
+      required :external_reference_id, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute organization_id
+      #
+      #   @return [String]
+      required :organization_id, String
+
+      # @!attribute updated_at
+      #
+      #   @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]
+    end
+  end
+end

data/lib/vitable_connect/models/group_create_params.rb

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

data/lib/vitable_connect/models/group_list_params.rb

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Groups#create
+    class GroupResponse < VitableConnect::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [VitableConnect::Models::Group]
+      required :data, -> { VitableConnect::Group }
+
+      # @!method initialize(data:)
+      #   Response containing a single group resource.
+      #
+      #   @param data [VitableConnect::Models::Group]
+    end
+  end
+end

data/lib/vitable_connect/models/group_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Groups#retrieve
+    class GroupRetrieveParams < 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
+
+      # @!method initialize(group_id:, request_options: {})
+      #   @param group_id [String] Unique group identifier (grp\_\*)
+      #
+      #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/vitable_connect/models/group_update_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    # @see VitableConnect::Resources::Groups#update
+    class GroupUpdateParams < 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 external_reference_id
+      #
+      #   @return [String, nil]
+      optional :external_reference_id, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(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}]
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Models
+    module Groups
+      module Members
+        # @see VitableConnect::Resources::Groups::Members::Sync#retrieve
+        class SyncRetrieveParams < 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 request_id
+          #
+          #   @return [String]
+          required :request_id, String
+
+          # @!method initialize(group_id:, request_id:, request_options: {})
+          #   @param group_id [String] Unique group identifier (grp\_\*)
+          #
+          #   @param request_id [String]
+          #
+          #   @param request_options [VitableConnect::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 [Object]
+            required :results, VitableConnect::Internal::Type::Unknown
+
+            # @!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]
+          end
+        end
+      end
+    end
+  end
+end