vortex-ruby-sdk 1.5.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2c594fa0a88757da59e6df7f87e0d232b25e53035b560bce733c582d953320
-  data.tar.gz: 356960f55a08e9c475bf4be6b126510d36ad8251d2988d44c3ede9f3d00598e4
+  metadata.gz: d8b96f994327d61bfa1cb19ee512a9da227762c0212413cb3de3871e9bc26b56
+  data.tar.gz: f3750eb0f15fd83a76d5b15da5adf1b39f004b657abb3ac79b811ba56980dce3
 SHA512:
-  metadata.gz: f5b8fd2f00a23144c21d87a3cd127bef7dc25d935d78e9a0120048e075c756a5e5db1f3bf6b0a466e7788c626a75e1f91b019acadf2f334ddb9da811ee37fcd0
-  data.tar.gz: b4c4a42a681f9cd772cd2310b00692f149e48171ce5c0659f94dc3995a307a5d6c986aa96984aaf403a0ed610c0491718c8c0323771ba308c25a09f586724265
+  metadata.gz: 73d8968550bb227d4c49fa888e454e3307c8797a33b6812f6cff9b00e48ee144a0396c32492f858e5c8ae02e2a558ecdc56ca192a18dfc4f0d17d81cd57654ea
+  data.tar.gz: ab1f06dea51572aa0853ad271cdff44afdb2d502bddedaef32d4c9e3502c74810006af768fe670a8e1a7f8094c9516557e7f006fc0513e3c9764e6d57472c731

data/README.md

@@ -58,8 +58,8 @@ jwt = client.generate_jwt(user: user)
 # Get invitations by target
 invitations = client.get_invitations_by_target('email', 'user@example.com')
 
-# Accept invitations
-client.accept_invitations(['inv1', 'inv2'], { type: 'email', value: 'user@example.com' })
+# Accept an invitation
+client.accept_invitation('inv-123', { email: 'user@example.com' })
 
 # Get invitations by group
 group_invitations = client.get_invitations_by_group('team', 'team1')
@@ -170,7 +170,7 @@ All methods match the functionality of other Vortex SDKs:
 - `get_invitations_by_target(target_type, target_value)` - Get invitations by target
 - `get_invitation(invitation_id)` - Get specific invitation
 - `revoke_invitation(invitation_id)` - Revoke invitation
-- `accept_invitations(invitation_ids, target)` - Accept invitations
+- `accept_invitation(invitation_id, user)` - Accept an invitation
 - `get_invitations_by_group(group_type, group_id)` - Get group invitations
 - `delete_invitations_by_group(group_type, group_id)` - Delete group invitations
 - `reinvite(invitation_id)` - Reinvite user

data/lib/vortex/client.rb

@@ -95,6 +95,11 @@ module Vortex
         payload[:adminScopes] = user[:admin_scopes]
       end
 
+      # Add allowedEmailDomains if present (for domain-restricted invitations)
+      if user[:allowed_email_domains] && !user[:allowed_email_domains].empty?
+        payload[:allowedEmailDomains] = user[:allowed_email_domains]
+      end
+
       # Add any additional properties from attributes
       if attributes && !attributes.empty?
         payload.merge!(attributes)
@@ -248,6 +253,22 @@ module Vortex
       raise VortexError, "Failed to accept invitations: #{e.message}"
     end
 
+    # Accept a single invitation (recommended method)
+    #
+    # This is the recommended method for accepting invitations.
+    #
+    # @param invitation_id [String] Single invitation ID to accept
+    # @param user [Hash] User hash with :email and/or :phone
+    # @return [Hash] The accepted invitation result
+    # @raise [VortexError] If the request fails
+    #
+    # @example
+    #   user = { email: 'user@example.com', name: 'John Doe' }
+    #   result = client.accept_invitation('inv-123', user)
+    def accept_invitation(invitation_id, user)
+      accept_invitations([invitation_id], user)
+    end
+
     # Get invitations by group
     #
     # @param group_type [String] The group type
@@ -383,6 +404,81 @@ module Vortex
       raise VortexError, "Failed to create invitation: #{e.message}"
     end
 
+    # Get autojoin domains configured for a specific scope
+    #
+    # @param scope_type [String] The type of scope (e.g., "organization", "team", "project")
+    # @param scope [String] The scope identifier (customer's group ID)
+    # @return [Hash] Response with :autojoin_domains array and :invitation
+    # @raise [VortexError] If the request fails
+    #
+    # @example
+    #   result = client.get_autojoin_domains('organization', 'acme-org')
+    #   result['autojoinDomains'].each do |domain|
+    #     puts "Domain: #{domain['domain']}"
+    #   end
+    def get_autojoin_domains(scope_type, scope)
+      encoded_scope_type = URI.encode_www_form_component(scope_type)
+      encoded_scope = URI.encode_www_form_component(scope)
+
+      response = @connection.get("/api/v1/invitations/by-scope/#{encoded_scope_type}/#{encoded_scope}/autojoin")
+      handle_response(response)
+    rescue VortexError
+      raise
+    rescue => e
+      raise VortexError, "Failed to get autojoin domains: #{e.message}"
+    end
+
+    # Configure autojoin domains for a specific scope
+    #
+    # This endpoint syncs autojoin domains - it will add new domains, remove domains
+    # not in the provided list, and deactivate the autojoin invitation if all domains
+    # are removed (empty array).
+    #
+    # @param scope [String] The scope identifier (customer's group ID)
+    # @param scope_type [String] The type of scope (e.g., "organization", "team")
+    # @param domains [Array<String>] Array of domains to configure for autojoin
+    # @param widget_id [String] The widget configuration ID
+    # @param scope_name [String, nil] Optional display name for the scope
+    # @param metadata [Hash, nil] Optional metadata to attach to the invitation
+    # @return [Hash] Response with :autojoin_domains array and :invitation
+    # @raise [VortexError] If the request fails
+    #
+    # @example
+    #   result = client.configure_autojoin(
+    #     'acme-org',
+    #     'organization',
+    #     ['acme.com', 'acme.org'],
+    #     'widget-123',
+    #     'Acme Corporation'
+    #   )
+    def configure_autojoin(scope, scope_type, domains, widget_id, scope_name = nil, metadata = nil)
+      raise VortexError, 'scope is required' if scope.nil? || scope.empty?
+      raise VortexError, 'scope_type is required' if scope_type.nil? || scope_type.empty?
+      raise VortexError, 'widget_id is required' if widget_id.nil? || widget_id.empty?
+      raise VortexError, 'domains must be an array' unless domains.is_a?(Array)
+
+      body = {
+        scope: scope,
+        scopeType: scope_type,
+        domains: domains,
+        widgetId: widget_id
+      }
+
+      body[:scopeName] = scope_name if scope_name
+      body[:metadata] = metadata if metadata
+
+      response = @connection.post('/api/v1/invitations/autojoin') do |req|
+        req.headers['Content-Type'] = 'application/json'
+        req.body = JSON.generate(body)
+      end
+
+      handle_response(response)
+    rescue VortexError
+      raise
+    rescue => e
+      raise VortexError, "Failed to configure autojoin: #{e.message}"
+    end
+
     private
 
     def build_connection

data/lib/vortex/types.rb

@@ -113,5 +113,46 @@ module Vortex
       name: String,       # Optional: Display name of the person being invited
       avatarUrl: String   # Optional: Avatar URL for the person being invited
     }.freeze
+
+    # AutojoinDomain structure for autojoin domain configuration
+    # @example
+    #   {
+    #     id: '550e8400-e29b-41d4-a716-446655440000',
+    #     domain: 'acme.com'
+    #   }
+    AUTOJOIN_DOMAIN = {
+      id: String,     # Vortex internal UUID
+      domain: String  # The domain configured for autojoin
+    }.freeze
+
+    # AutojoinDomainsResponse from autojoin API endpoints
+    # @example
+    #   {
+    #     autojoinDomains: [AUTOJOIN_DOMAIN, ...],
+    #     invitation: INVITATION  # or nil
+    #   }
+    AUTOJOIN_DOMAINS_RESPONSE = {
+      autojoinDomains: Array,  # Array of AUTOJOIN_DOMAIN structures
+      invitation: Hash         # INVITATION structure or nil
+    }.freeze
+
+    # ConfigureAutojoinRequest for configuring autojoin domains
+    # @example
+    #   {
+    #     scope: 'acme-org',
+    #     scopeType: 'organization',
+    #     scopeName: 'Acme Corporation',  # Optional
+    #     domains: ['acme.com', 'acme.org'],
+    #     widgetId: 'widget-123',
+    #     metadata: { ... }  # Optional
+    #   }
+    CONFIGURE_AUTOJOIN_REQUEST = {
+      scope: String,       # Required: Customer's group ID
+      scopeType: String,   # Required: Type of scope (e.g., "organization", "team")
+      scopeName: String,   # Optional: Display name for the scope
+      domains: Array,      # Required: Array of domain strings
+      widgetId: String,    # Required: Widget configuration ID
+      metadata: Hash       # Optional: Metadata to attach to the invitation
+    }.freeze
   end
 end

data/lib/vortex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vortex
-  VERSION = '1.5.0'
+  VERSION = '1.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vortex-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Vortex Software
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-04 00:00:00.000000000 Z
+date: 2026-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday