vitable-connect 2.0.0 → 2.1.0

data/lib/VitableConnect/enrollments/client.rb

@@ -23,6 +23,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::EnrollmentID] :enrollment_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.enrollments.get(enrollment_id: "enrl_AAAAAAAAAAAAAAAAAAAAAQ")
@@ -30,10 +31,14 @@ module VitableConnect
       # @return [VitableConnect::Types::EnrollmentResponse]
       def get(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "v1/enrollments/#{URI.encode_uri_component(params[:enrollment_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -63,6 +68,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::EnrollmentID] :enrollment_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.enrollments.reissue(
@@ -76,13 +82,17 @@ module VitableConnect
       def reissue(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
         request_data = VitableConnect::Enrollments::Types::ReissueEnrollmentRequest.new(params).to_h
-        non_body_param_names = %w[enrollment_id]
+        non_body_param_names = %w[enrollment_id X-Vitable-Organization]
         body = request_data.except(*non_body_param_names)
 
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "v1/enrollments/#{URI.encode_uri_component(params[:enrollment_id].to_s)}/reissue",
+          headers: headers,
           body: body,
           request_options: request_options
         )
@@ -113,6 +123,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::EnrollmentID] :enrollment_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.enrollments.terminate(
@@ -126,13 +137,17 @@ module VitableConnect
       def terminate(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
         request_data = VitableConnect::Enrollments::Types::TerminateEnrollmentRequest.new(params).to_h
-        non_body_param_names = %w[enrollment_id]
+        non_body_param_names = %w[enrollment_id X-Vitable-Organization]
         body = request_data.except(*non_body_param_names)
 
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "v1/enrollments/#{URI.encode_uri_component(params[:enrollment_id].to_s)}/terminate",
+          headers: headers,
           body: body,
           request_options: request_options
         )

data/lib/VitableConnect/enrollments/types/get_enrollments_request.rb

@@ -5,6 +5,8 @@ module VitableConnect
     module Types
       class GetEnrollmentsRequest < Internal::Types::Model
         field :enrollment_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/enrollments/types/reissue_enrollment_request.rb

@@ -6,6 +6,8 @@ module VitableConnect
       class ReissueEnrollmentRequest < Internal::Types::Model
         field :enrollment_id, -> { String }, optional: false, nullable: false
 
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
+
         field :reason, -> { String }, optional: true, nullable: false
 
         field :ticket_number, -> { String }, optional: true, nullable: false

data/lib/VitableConnect/enrollments/types/terminate_enrollment_request.rb

@@ -6,6 +6,8 @@ module VitableConnect
       class TerminateEnrollmentRequest < Internal::Types::Model
         field :enrollment_id, -> { String }, optional: false, nullable: false
 
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
+
         field :reason, -> { String }, optional: true, nullable: false
 
         field :ticket_number, -> { String }, optional: true, nullable: false

data/lib/VitableConnect/members/client.rb

@@ -22,6 +22,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::MemberID] :member_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.members.get(member_id: "mbr_abc123def456")
@@ -29,10 +30,14 @@ module VitableConnect
       # @return [VitableConnect::Types::MemberResponse]
       def get(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "v1/members/#{URI.encode_uri_component(params[:member_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -60,6 +65,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::MemberID] :member_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.members.list_dependents(member_id: "mbr_abc123def456")
@@ -67,10 +73,14 @@ module VitableConnect
       # @return [VitableConnect::Types::MemberDependentsResponse]
       def list_dependents(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "v1/members/#{URI.encode_uri_component(params[:member_id].to_s)}/dependents",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -100,6 +110,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::MemberID] :member_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.members.list_employments(member_id: "mbr_abc123def456")
@@ -107,10 +118,14 @@ module VitableConnect
       # @return [VitableConnect::Types::MemberEmploymentsResponse]
       def list_employments(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "v1/members/#{URI.encode_uri_component(params[:member_id].to_s)}/employments",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -150,6 +165,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::MemberID] :member_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.members.list_enrollments(member_id: "mbr_abc123def456")
@@ -157,10 +173,14 @@ module VitableConnect
       # @return [VitableConnect::Types::MemberEnrollmentsResponse]
       def list_enrollments(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "v1/members/#{URI.encode_uri_component(params[:member_id].to_s)}/enrollments",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -189,6 +209,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::MemberID] :member_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.members.get_household(member_id: "mbr_abc123def456")
@@ -196,10 +217,14 @@ module VitableConnect
       # @return [VitableConnect::Types::HouseholdMembersResponse]
       def get_household(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "v1/members/#{URI.encode_uri_component(params[:member_id].to_s)}/household",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -231,6 +256,7 @@ module VitableConnect
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [VitableConnect::Types::MemberID] :member_id
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.members.list_id_cards(member_id: "mbr_abc123def456")
@@ -238,10 +264,14 @@ module VitableConnect
       # @return [VitableConnect::Types::MemberDigitalBenefitCardsResponse]
       def list_id_cards(request_options: {}, **params)
         params = VitableConnect::Internal::Types::Utils.normalize_keys(params)
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         request = VitableConnect::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "v1/members/#{URI.encode_uri_component(params[:member_id].to_s)}/id-cards",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -276,6 +306,7 @@ module VitableConnect
       # @option params [Integer, nil] :limit
       # @option params [Integer, nil] :page
       # @option params [VitableConnect::Types::Status, nil] :status
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.members.list_qualifying_life_events(
@@ -292,6 +323,9 @@ module VitableConnect
         query_params["page"] = params[:page] if params.key?(:page)
         query_params["status"] = params[:status] if params.key?(:status)
 
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         VitableConnect::Internal::OffsetItemIterator.new(
           initial_page: query_params["page"],
           item_field: :data,
@@ -303,6 +337,7 @@ module VitableConnect
             base_url: request_options[:base_url],
             method: "GET",
             path: "v1/members/#{URI.encode_uri_component(params[:member_id].to_s)}/qualifying-life-events",
+            headers: headers,
             query: query_params,
             request_options: request_options
           )
@@ -336,6 +371,7 @@ module VitableConnect
       # @option params [Integer, nil] :limit
       # @option params [Integer, nil] :page
       # @option params [String, nil] :search
+      # @option params [String, nil] :vitable_organization
       #
       # @example
       #   client.members.list(
@@ -351,6 +387,9 @@ module VitableConnect
         query_params["page"] = params[:page] if params.key?(:page)
         query_params["search"] = params[:search] if params.key?(:search)
 
+        headers = {}
+        headers["X-Vitable-Organization"] = params[:vitable_organization] if params[:vitable_organization]
+
         VitableConnect::Internal::OffsetItemIterator.new(
           initial_page: query_params["page"],
           item_field: :data,
@@ -362,6 +401,7 @@ module VitableConnect
             base_url: request_options[:base_url],
             method: "GET",
             path: "v2/members",
+            headers: headers,
             query: query_params,
             request_options: request_options
           )

data/lib/VitableConnect/members/types/get_household_members_request.rb

@@ -5,6 +5,8 @@ module VitableConnect
     module Types
       class GetHouseholdMembersRequest < Internal::Types::Model
         field :member_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/members/types/get_members_request.rb

@@ -5,6 +5,8 @@ module VitableConnect
     module Types
       class GetMembersRequest < Internal::Types::Model
         field :member_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/members/types/list_dependents_members_request.rb

@@ -5,6 +5,8 @@ module VitableConnect
     module Types
       class ListDependentsMembersRequest < Internal::Types::Model
         field :member_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/members/types/list_employments_members_request.rb

@@ -5,6 +5,8 @@ module VitableConnect
     module Types
       class ListEmploymentsMembersRequest < Internal::Types::Model
         field :member_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/members/types/list_enrollments_members_request.rb

@@ -5,6 +5,8 @@ module VitableConnect
     module Types
       class ListEnrollmentsMembersRequest < Internal::Types::Model
         field :member_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/members/types/list_id_cards_members_request.rb

@@ -5,6 +5,8 @@ module VitableConnect
     module Types
       class ListIDCardsMembersRequest < Internal::Types::Model
         field :member_id, -> { String }, optional: false, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/members/types/list_members_request.rb

@@ -9,6 +9,8 @@ module VitableConnect
         field :page, -> { Integer }, optional: true, nullable: false
 
         field :search, -> { String }, optional: true, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/members/types/list_qualifying_life_events_members_request.rb

@@ -11,6 +11,8 @@ module VitableConnect
         field :page, -> { Integer }, optional: true, nullable: false
 
         field :status, -> { VitableConnect::Types::Status }, optional: true, nullable: false
+
+        field :vitable_organization, -> { String }, optional: true, nullable: false, api_name: "X-Vitable-Organization"
       end
     end
   end

data/lib/VitableConnect/organizations/client.rb

@@ -47,8 +47,10 @@ module VitableConnect
       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). 409
-      # `organization_already_exists` when the user already has an organization (v0: one organization per user).
+      # 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]

data/lib/VitableConnect/types/x_vitable_organization.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitableConnect
+  module Types
+    module XVitableOrganization
+      # XVitableOrganization is an alias for String
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/VitableConnect/version.rb

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

data/lib/VitableConnect.rb

@@ -190,6 +190,7 @@ require_relative "VitableConnect/types/webhook_event_response"
 require_relative "VitableConnect/types/employee_id"
 require_relative "VitableConnect/types/limit"
 require_relative "VitableConnect/types/page"
+require_relative "VitableConnect/types/x_vitable_organization"
 require_relative "VitableConnect/types/include_cancelled"
 require_relative "VitableConnect/types/search"
 require_relative "VitableConnect/types/employer_id"
@@ -235,6 +236,7 @@ require_relative "VitableConnect/employers/types/submit_payroll_access_setup_req
 require_relative "VitableConnect/employers/types/list_payroll_deduction_statements_employers_request"
 require_relative "VitableConnect/employers/types/ensure_payroll_integration_email_employers_request"
 require_relative "VitableConnect/employers/types/update_employer_settings_request"
+require_relative "VitableConnect/employers/types/list_hris_providers_employers_request"
 require_relative "VitableConnect/enrollments/client"
 require_relative "VitableConnect/enrollments/types/get_enrollments_request"
 require_relative "VitableConnect/enrollments/types/reissue_enrollment_request"