vitable-connect 2.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67cc90860044f147b33727cb875908908dfdc1c55207374234a02aabf717b510
-  data.tar.gz: f3ce52bbf2f6e09b00fbe999425d96d628e9106f6e829b85cf83d1fba26701ff
+  metadata.gz: bd641f8cbcc651041563f6c1fecc4aab6a27ab3909b001fa3b3eaa00ccd9871a
+  data.tar.gz: aca5cbedb59b94753becde48a42260f1c4a3086a6adea5850ebd0432584ff48f
 SHA512:
-  metadata.gz: 6bd5c5f86c189338678c010c3d20f55ed29bea785822dbe26b3dd83be1e1ce0eb39a2c4e1cbeb07e95ca43709a5f5411e14ccca03a2e2160b25ad33d8802e714
-  data.tar.gz: 3a182911a77829803f417c845bbcc67c4c08dedf0cbbd21807f6fd25c4bb83f92604131532a6958d1d2b26e1a0d9ba74f47714e3463f02673b217da2e5323818
+  metadata.gz: 1cec2e039c69e02007532b5089cce1be6ce7652ad5577fa010e81a6cea407a57640e24e56d7e0b1a221e0ff947e02b1be3d5ef0fe3333ca2319d98da51b473de
+  data.tar.gz: 7d23eb05aab210dc106668373219d2a5fc6d7261a246a268c1332dc53a7d6f6a2cab839d1e29e1d9a908dddbd539b5ae71141a3d8a2fefe162593c8a84fadc69

data/.fern/metadata.json

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

data/changelog.md

@@ -1,3 +1,17 @@
+## 4.0.0 - 2026-09-16
+### Breaking Changes
+* **`VitableConnect::Organizations::Client#create`** has been removed. Any calls to `client.organizations.create(...)` will raise `NoMethodError`; remove or replace these call sites.
+* **`VitableConnect::Organizations::Types::CreateOrganizationRequest`** has been removed. Replace any direct references to this class with your own request construction or remove them entirely.
+* **`VitableConnect::Types::Organization`** has been removed. Any code that references this class (e.g. `is_a?` checks, constant lookups, or return-value handling) must be updated; use `VitableConnect::Types::OrganizationMembership` for organization data returned by the list endpoint.
+
+## 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/4.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]
@@ -45,50 +45,6 @@ module VitableConnect
           raise error_class.new(response.body, code: code)
         end
       end
-
-      # Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin
-      # membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin). A user
-      # may hold several organizations and selects which one a request acts as with the `X-Vitable-Organization` header.
-      # The founder's email domain is claimed only when no other organization holds it, so a taken domain is left with
-      # its owner rather than rejected.
-      #
-      # @param request_options [Hash]
-      # @param params [VitableConnect::Organizations::Types::CreateOrganizationRequest]
-      # @option request_options [String] :base_url
-      # @option request_options [Hash{String => Object}] :additional_headers
-      # @option request_options [Hash{String => Object}] :additional_query_parameters
-      # @option request_options [Hash{String => Object}] :additional_body_parameters
-      # @option request_options [Integer] :timeout_in_seconds
-      #
-      # @example
-      #   client.organizations.create(
-      #     name: "Acme Brokerage",
-      #     type: "BROKERAGE"
-      #   )
-      #
-      # @return [VitableConnect::Types::Organization]
-      def create(request_options: {}, **params)
-        params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
-        request = VitableConnect::Internal::JSON::Request.new(
-          base_url: request_options[:base_url],
-          method: "POST",
-          path: "v1/organizations",
-          body: VitableConnect::Organizations::Types::CreateOrganizationRequest.new(params).to_h,
-          request_options: request_options
-        )
-        begin
-          response = @client.send(request)
-        rescue Net::HTTPRequestTimeout
-          raise VitableConnect::Errors::TimeoutError
-        end
-        code = response.code.to_i
-        if code.between?(200, 299)
-          VitableConnect::Types::Organization.load(response.body)
-        else
-          error_class = VitableConnect::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(response.body, code: code)
-        end
-      end
     end
   end
 end

data/lib/VitableConnect/types/{organization.rb → organization_membership.rb}

@@ -2,7 +2,7 @@
 
 module VitableConnect
   module Types
-    class Organization < Internal::Types::Model
+    class OrganizationMembership < Internal::Types::Model
       field :id, -> { String }, optional: false, nullable: false
 
       field :name, -> { String }, optional: false, nullable: false
@@ -14,6 +14,8 @@ module VitableConnect
       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 = "4.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"
@@ -162,8 +161,6 @@ require_relative "VitableConnect/types/member_qualifying_life_event"
 require_relative "VitableConnect/types/member_qualifying_life_event_list_response"
 require_relative "VitableConnect/types/member_response"
 require_relative "VitableConnect/types/missing_employee_resolution"
-require_relative "VitableConnect/types/organization_type"
-require_relative "VitableConnect/types/organization"
 require_relative "VitableConnect/types/employer_benefit_lifecycle_stage"
 require_relative "VitableConnect/types/enrollment_rate_summary"
 require_relative "VitableConnect/types/employer_hris_status"
@@ -171,6 +168,9 @@ 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_type"
+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"
@@ -256,7 +256,6 @@ require_relative "VitableConnect/members/types/list_id_cards_members_request"
 require_relative "VitableConnect/members/types/list_qualifying_life_events_members_request"
 require_relative "VitableConnect/members/types/list_members_request"
 require_relative "VitableConnect/organizations/client"
-require_relative "VitableConnect/organizations/types/create_organization_request"
 require_relative "VitableConnect/plans/client"
 require_relative "VitableConnect/plans/types/list_plans_request"
 require_relative "VitableConnect/webhook_events/client"

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>
@@ -3374,79 +3374,6 @@ client.organizations.list
 </dl>
 
 
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.organizations.<a href="/lib/VitableConnect/organizations/client.rb">create</a>(request) -> VitableConnect::Types::Organization</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Onboards the authenticated user's partner Organization: creates the local Organization + the creator's admin membership atomically, then mirrors it to WorkOS (creates the WorkOS org and binds the creator as admin). A user may hold several organizations and selects which one a request acts as with the `X-Vitable-Organization` header. The founder's email domain is claimed only when no other organization holds it, so a taken domain is left with its owner rather than rejected.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.organizations.create(
-  name: "Acme Brokerage",
-  type: "BROKERAGE"
-)
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**name:** `String` — Legal or trading name of the organization.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**type:** `VitableConnect::Types::CreateOrganizationRequestType` — Category of organization being onboarded.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request_options:** `VitableConnect::Organizations::RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
 </dd>
 </dl>
 </details>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitable-connect
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - VitableConnect
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-08 00:00:00.000000000 Z
+date: 2026-09-16 00:00:00.000000000 Z
 dependencies: []
 description: The VitableConnect Ruby library provides convenient access to the VitableConnect
   API from Ruby.
@@ -109,7 +109,6 @@ files:
 - lib/VitableConnect/members/types/list_members_request.rb
 - lib/VitableConnect/members/types/list_qualifying_life_events_members_request.rb
 - lib/VitableConnect/organizations/client.rb
-- lib/VitableConnect/organizations/types/create_organization_request.rb
 - lib/VitableConnect/plans/client.rb
 - lib/VitableConnect/plans/types/list_plans_request.rb
 - lib/VitableConnect/types/access_method.rb
@@ -144,7 +143,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
@@ -244,12 +242,13 @@ files:
 - lib/VitableConnect/types/missing_employee_resolution.rb
 - lib/VitableConnect/types/name_suffix.rb
 - lib/VitableConnect/types/offset.rb
-- lib/VitableConnect/types/organization.rb
 - lib/VitableConnect/types/organization_employer.rb
 - 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/organizations/types/create_organization_request.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Organizations
-    module Types
-      class CreateOrganizationRequest < Internal::Types::Model
-        field :name, -> { String }, optional: false, nullable: false
-
-        field :type, -> { VitableConnect::Types::CreateOrganizationRequestType }, optional: true, nullable: false
-      end
-    end
-  end
-end

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