vitable-connect 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67cc90860044f147b33727cb875908908dfdc1c55207374234a02aabf717b510
-  data.tar.gz: f3ce52bbf2f6e09b00fbe999425d96d628e9106f6e829b85cf83d1fba26701ff
+  metadata.gz: 9424774b8a5dae75ebd018790ab3545f7625c5e163b204fa2a208121e1a6ba81
+  data.tar.gz: 24e5c4381df0df6ecaf9e4b7285efd3056ae8454b09bfcc130ce2f8ac07be976
 SHA512:
-  metadata.gz: 6bd5c5f86c189338678c010c3d20f55ed29bea785822dbe26b3dd83be1e1ce0eb39a2c4e1cbeb07e95ca43709a5f5411e14ccca03a2e2160b25ad33d8802e714
-  data.tar.gz: 3a182911a77829803f417c845bbcc67c4c08dedf0cbbd21807f6fd25c4bb83f92604131532a6958d1d2b26e1a0d9ba74f47714e3463f02673b217da2e5323818
+  metadata.gz: d892ffcac685b36a833ee80bf6473b36ca5912e5f75cfdfbc1bc321ea5d26136d30f11d4ea37f12fb68a0ecd4cde574a77a211f07320a43a633fd185960a9780
+  data.tar.gz: dd4f896514948f8c779cf29e0a7296275021a1084350da98ee5c9d4c72aa047b323187aea9e690ba7f620f758f64ed0353a02e75fe52cf30d7a9c9aef2c3412e

data/.fern/metadata.json

@@ -7,10 +7,10 @@
     "offsetSemantics": "page-index",
     "respectAuthSchemeNames": true
   },
-  "originGitCommit": "bef03772691d90ef2bd02e356723d4d40733ec35",
+  "originGitCommit": "65d5d5d76dfc8bd4aa3f7f57e427d33465e889db",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
   "requestedVersion": "AUTO",
-  "ciProvider": "github",
-  "sdkVersion": "2.1.0"
+  "ciProvider": "gitlab",
+  "sdkVersion": "3.0.0"
 }

data/changelog.md

@@ -1,3 +1,11 @@
+## 3.0.0 - 2026-09-11
+### Breaking Changes
+* **`VitableConnect::Types::CreateOrganizationRequestType`** has been removed. Replace any references with `VitableConnect::Types::OrganizationType`, which carries the same enum values.
+* **`VitableConnect::Types::OrganizationsListResponse#organizations`** now returns an array of `OrganizationMembership` instead of `Organization`. Update any code that accesses fields on these objects to use the new `OrganizationMembership` shape.
+### Added
+* **`VitableConnect::Types::OrganizationMembership`** — new model returned in the organizations list, containing `id`, `name`, `type`, `idp_org_id`, `idp_provider`, `super_in`, and `role` fields so callers can see the authenticated user's role within each organization.
+* **`VitableConnect::Types::OrganizationUserRole`** — new enum with values `ADMIN`, `OPERATIONS`, `SALES`, and `ENROLLMENT_AGENT`, used by `OrganizationMembership#role`.
+
 ## 2.1.0 - 2026-09-08
 ### Added
 * **`vitable_organization`** — optional parameter added to all employer, enrollment, and members client methods, sending the `X-Vitable-Organization` HTTP header to scope requests to a specific organization.

data/lib/VitableConnect/client.rb

@@ -11,7 +11,7 @@ module VitableConnect
       @raw_client = VitableConnect::Internal::Http::RawClient.new(
         base_url: base_url || VitableConnect::Environment::PRODUCTION,
         headers: {
-          "User-Agent" => "vitable-connect/2.1.0",
+          "User-Agent" => "vitable-connect/3.0.0",
           "X-Fern-Language" => "Ruby",
           Authorization: "Bearer #{api_key}"
         },

data/lib/VitableConnect/organizations/client.rb

@@ -10,8 +10,8 @@ module VitableConnect
         @client = client
       end
 
-      # Lists the organizations the authenticated caller is an active member of (paginated). Returns an empty list when
-      # the caller belongs to no organizations.
+      # Lists the organizations the authenticated caller is an active member of (paginated), each with the role the
+      # caller holds in it. Returns an empty list when the caller belongs to no organizations.
       #
       # @param request_options [Hash]
       # @param _params [Hash]

data/lib/VitableConnect/organizations/types/create_organization_request.rb

@@ -6,7 +6,7 @@ module VitableConnect
       class CreateOrganizationRequest < Internal::Types::Model
         field :name, -> { String }, optional: false, nullable: false
 
-        field :type, -> { VitableConnect::Types::CreateOrganizationRequestType }, optional: true, nullable: false
+        field :type, -> { VitableConnect::Types::OrganizationType }, optional: true, nullable: false
       end
     end
   end

data/lib/VitableConnect/types/organization_membership.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    class OrganizationMembership < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :type, -> { VitableConnect::Types::OrganizationType }, optional: false, nullable: true
+
+      field :idp_org_id, -> { String }, optional: false, nullable: true
+
+      field :idp_provider, -> { VitableConnect::Types::IdpProvider }, optional: false, nullable: true
+
+      field :super_in, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :role, -> { VitableConnect::Types::OrganizationUserRole }, optional: false, nullable: false
+    end
+  end
+end

data/lib/VitableConnect/types/organization_user_role.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module OrganizationUserRole
+      extend VitableConnect::Internal::Types::Enum
+
+      ADMIN = "ADMIN"
+      OPERATIONS = "OPERATIONS"
+      SALES = "SALES"
+      ENROLLMENT_AGENT = "ENROLLMENT_AGENT"
+    end
+  end
+end

data/lib/VitableConnect/types/organizations_list_response.rb

@@ -4,7 +4,7 @@ module VitableConnect
   module Types
     # Envelope for the caller's organization memberships (paginated).
     class OrganizationsListResponse < Internal::Types::Model
-      field :organizations, -> { Internal::Types::Array[VitableConnect::Types::Organization] }, optional: false, nullable: false
+      field :organizations, -> { Internal::Types::Array[VitableConnect::Types::OrganizationMembership] }, optional: false, nullable: false
 
       field :total, -> { Integer }, optional: false, nullable: false
     end

data/lib/VitableConnect/version.rb

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

data/lib/VitableConnect.rb

@@ -81,7 +81,6 @@ require_relative "VitableConnect/types/compensation_type"
 require_relative "VitableConnect/types/employee_class"
 require_relative "VitableConnect/types/census_sync_employee_request"
 require_relative "VitableConnect/types/classification_correction_source"
-require_relative "VitableConnect/types/create_organization_request_type"
 require_relative "VitableConnect/types/deduction_frequency"
 require_relative "VitableConnect/types/tax_classification"
 require_relative "VitableConnect/types/deduction_detail"
@@ -171,6 +170,8 @@ require_relative "VitableConnect/types/organization_employer"
 require_relative "VitableConnect/types/organization_employer_list_response"
 require_relative "VitableConnect/types/organization_hris_provider"
 require_relative "VitableConnect/types/organization_hris_providers_response"
+require_relative "VitableConnect/types/organization_user_role"
+require_relative "VitableConnect/types/organization_membership"
 require_relative "VitableConnect/types/organizations_list_response"
 require_relative "VitableConnect/types/payroll_access_setup_status"
 require_relative "VitableConnect/types/payroll_access_setup_status_response"

data/reference.md

@@ -3336,7 +3336,7 @@ client.members.list(
 <dl>
 <dd>
 
-Lists the organizations the authenticated caller is an active member of (paginated). Returns an empty list when the caller belongs to no organizations.
+Lists the organizations the authenticated caller is an active member of (paginated), each with the role the caller holds in it. Returns an empty list when the caller belongs to no organizations.
 </dd>
 </dl>
 </dd>
@@ -3431,7 +3431,7 @@ client.organizations.create(
 <dl>
 <dd>
 
-**type:** `VitableConnect::Types::CreateOrganizationRequestType` — Category of organization being onboarded.
+**type:** `VitableConnect::Types::OrganizationType` — Category of organization being onboarded.
     
 </dd>
 </dl>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitable-connect
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - VitableConnect
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-08 00:00:00.000000000 Z
+date: 2026-09-11 00:00:00.000000000 Z
 dependencies: []
 description: The VitableConnect Ruby library provides convenient access to the VitableConnect
   API from Ruby.
@@ -144,7 +144,6 @@ files:
 - lib/VitableConnect/types/contribution_strategy.rb
 - lib/VitableConnect/types/contribution_tier.rb
 - lib/VitableConnect/types/coverage_tier.rb
-- lib/VitableConnect/types/create_organization_request_type.rb
 - lib/VitableConnect/types/created_after.rb
 - lib/VitableConnect/types/created_before.rb
 - lib/VitableConnect/types/deduction_detail.rb
@@ -249,7 +248,9 @@ files:
 - lib/VitableConnect/types/organization_employer_list_response.rb
 - lib/VitableConnect/types/organization_hris_provider.rb
 - lib/VitableConnect/types/organization_hris_providers_response.rb
+- lib/VitableConnect/types/organization_membership.rb
 - lib/VitableConnect/types/organization_type.rb
+- lib/VitableConnect/types/organization_user_role.rb
 - lib/VitableConnect/types/organizations_list_response.rb
 - lib/VitableConnect/types/page.rb
 - lib/VitableConnect/types/pagination.rb

data/lib/VitableConnect/types/create_organization_request_type.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Types
-    module CreateOrganizationRequestType
-      extend VitableConnect::Internal::Types::Enum
-
-      BROKERAGE = "BROKERAGE"
-      TPA = "TPA"
-      GENERAL_AGENT = "GENERAL_AGENT"
-      CHANNEL_PARTNER = "CHANNEL_PARTNER"
-      CONSULTING_FIRM = "CONSULTING_FIRM"
-      API_PLATFORM = "API_PLATFORM"
-    end
-  end
-end