vortex-ruby-sdk 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef46095579ff2ce432423b52947fe7b09bcbac70a9aeaaa72c28245f79aee801
-  data.tar.gz: b71a185023f2593be2fd5adfa28771eb281de595b8539b023a60448119b29a7b
+  metadata.gz: ac2c594fa0a88757da59e6df7f87e0d232b25e53035b560bce733c582d953320
+  data.tar.gz: 356960f55a08e9c475bf4be6b126510d36ad8251d2988d44c3ede9f3d00598e4
 SHA512:
-  metadata.gz: f9fee1a62aa03ee7184bf596b13644f48bb3df7a6164eec8bae3be10ebe9f66e21c848410831a09ff99136d01a023aa7bebdbbe9cdf95c7333d7a55a94bd58ed
-  data.tar.gz: 315cdc79b63d0f79563d25e9568df67043245cd8c3d230ef79e322b02c39c7559eb3f5613f0c575b946b01f651397052e1ca8aa76ec51683bec5988a7b2445d2
+  metadata.gz: f5b8fd2f00a23144c21d87a3cd127bef7dc25d935d78e9a0120048e075c756a5e5db1f3bf6b0a466e7788c626a75e1f91b019acadf2f334ddb9da811ee37fcd0
+  data.tar.gz: b4c4a42a681f9cd772cd2310b00692f149e48171ce5c0659f94dc3995a307a5d6c986aa96984aaf403a0ed610c0491718c8c0323771ba308c25a09f586724265

data/README.md

@@ -47,7 +47,9 @@ client = Vortex::Client.new(ENV['VORTEX_API_KEY'])
 user = {
   id: 'user-123',
   email: 'user@example.com',
-  admin_scopes: ['autojoin']  # Optional - included as adminScopes array in JWT
+  user_name: 'Jane Doe',                                    # Optional: user's display name
+  user_avatar_url: 'https://example.com/avatars/jane.jpg',  # Optional: user's avatar URL
+  admin_scopes: ['autojoin']                                # Optional: grants autojoin admin privileges
 }
 
 # Generate JWT
@@ -63,22 +65,6 @@ client.accept_invitations(['inv1', 'inv2'], { type: 'email', value: 'user@exampl
 group_invitations = client.get_invitations_by_group('team', 'team1')
 ```
 
-### Generate JWT with Additional Properties
-
-```ruby
-user = {
-  id: 'user-123',
-  email: 'user@example.com'
-}
-
-extra = {
-  role: 'admin',
-  department: 'Engineering'
-}
-
-jwt = client.generate_jwt(user: user, extra: extra)
-```
-
 ## Rails Integration
 
 Create a controller with Vortex routes:

data/lib/vortex/client.rb

@@ -81,13 +81,13 @@ module Vortex
       }
 
       # Add name if present (convert snake_case to camelCase for JWT)
-      if user[:name]
-        payload[:name] = user[:name]
+      if user[:user_name]
+        payload[:userName] = user[:user_name]
       end
 
-      # Add avatarUrl if present (convert snake_case to camelCase for JWT)
-      if user[:avatar_url]
-        payload[:avatarUrl] = user[:avatar_url]
+      # Add userAvatarUrl if present (convert snake_case to camelCase for JWT)
+      if user[:user_avatar_url]
+        payload[:userAvatarUrl] = user[:user_avatar_url]
       end
 
       # Add adminScopes if present
@@ -303,17 +303,23 @@ module Vortex
     # @param inviter [Hash] The inviter info: { user_id: '...', user_email: '...', name: '...' }
     # @param groups [Array<Hash>, nil] Optional groups: [{ type: '...', group_id: '...', name: '...' }]
     # @param source [String, nil] Optional source for analytics (defaults to 'api')
+    # @param subtype [String, nil] Optional subtype for analytics segmentation (e.g., 'pymk', 'find-friends')
     # @param template_variables [Hash, nil] Optional template variables for email customization
     # @param metadata [Hash, nil] Optional metadata passed through to webhooks
+    # @param unfurl_config [Hash, nil] Optional link unfurl (Open Graph) config: { title: '...', description: '...', image: '...', type: '...', site_name: '...' }
     # @return [Hash] Created invitation with :id, :short_link, :status, :created_at
     # @raise [VortexError] If the request fails
     #
-    # @example Create an email invitation
+    # @example Create an email invitation with custom link preview
     #   result = client.create_invitation(
     #     'widget-config-123',
     #     { type: 'email', value: 'invitee@example.com' },
     #     { user_id: 'user-456', user_email: 'inviter@example.com', name: 'John Doe' },
-    #     [{ type: 'team', group_id: 'team-789', name: 'Engineering' }]
+    #     [{ type: 'team', group_id: 'team-789', name: 'Engineering' }],
+    #     nil,
+    #     nil,
+    #     nil,
+    #     { title: 'Join the team!', description: 'You have been invited', image: 'https://example.com/og.png' }
     #   )
     #
     # @example Create an internal invitation (PYMK flow - no email sent)
@@ -324,7 +330,7 @@ module Vortex
     #     nil,
     #     'pymk'
     #   )
-    def create_invitation(widget_configuration_id, target, inviter, groups = nil, source = nil, template_variables = nil, metadata = nil)
+    def create_invitation(widget_configuration_id, target, inviter, groups = nil, source = nil, subtype = nil, template_variables = nil, metadata = nil, unfurl_config = nil)
       raise VortexError, 'widget_configuration_id is required' if widget_configuration_id.nil? || widget_configuration_id.empty?
       raise VortexError, 'target must have type and value' if target[:type].nil? || target[:value].nil?
       raise VortexError, 'inviter must have user_id' if inviter[:user_id].nil?
@@ -336,8 +342,8 @@ module Vortex
         inviter: {
           userId: inviter[:user_id],
           userEmail: inviter[:user_email],
-          name: inviter[:name],
-          avatarUrl: inviter[:avatar_url]
+          userName: inviter[:user_name],
+          userAvatarUrl: inviter[:user_avatar_url]
         }.compact
       }
 
@@ -352,8 +358,18 @@ module Vortex
       end
 
       body[:source] = source if source
+      body[:subtype] = subtype if subtype
       body[:templateVariables] = template_variables if template_variables
       body[:metadata] = metadata if metadata
+      if unfurl_config
+        body[:unfurlConfig] = {
+          title: unfurl_config[:title],
+          description: unfurl_config[:description],
+          image: unfurl_config[:image],
+          type: unfurl_config[:type],
+          siteName: unfurl_config[:site_name]
+        }.compact
+      end
 
       response = @connection.post('/api/v1/invitations') do |req|
         req.headers['Content-Type'] = 'application/json'

data/lib/vortex/types.rb

@@ -60,6 +60,21 @@ module Vortex
     #     groups: [INVITATION_GROUP, ...],
     #     # ... other fields
     #   }
+    # InvitationTarget represents the target of an invitation
+    # @example
+    #   {
+    #     type: 'email',         # 'email', 'phone', 'share', or 'internal'
+    #     value: 'user@example.com',
+    #     name: 'Jane Smith',    # Optional: Display name of the person being invited
+    #     avatarUrl: 'https://...' # Optional: Avatar URL for display in invitation lists
+    #   }
+    INVITATION_TARGET = {
+      type: String,       # Required: 'email', 'phone', 'share', or 'internal'
+      value: String,      # Required: Email, phone, or internal ID
+      name: String,       # Optional: Display name of the person being invited
+      avatarUrl: String   # Optional: Avatar URL for the person being invited
+    }.freeze
+
     INVITATION = {
       id: String,
       accountId: String,
@@ -74,7 +89,7 @@ module Vortex
       invitationType: String,
       modifiedAt: String,
       status: String,
-      target: Array, # of { type: String, value: String }
+      target: Array, # of INVITATION_TARGET structures
       views: Integer,
       widgetConfigurationId: String,
       projectId: String,
@@ -83,5 +98,20 @@ module Vortex
       expired: :boolean,
       expires: String # ISO 8601 timestamp (optional)
     }.freeze
+
+    # CreateInvitationTarget for creating invitations
+    # @example
+    #   {
+    #     type: 'email',
+    #     value: 'invitee@example.com',
+    #     name: 'Jane Smith',       # Optional
+    #     avatarUrl: 'https://...'  # Optional
+    #   }
+    CREATE_INVITATION_TARGET = {
+      type: String,       # Required: 'email', 'phone', or 'internal'
+      value: String,      # Required: Email, phone, or internal ID
+      name: String,       # Optional: Display name of the person being invited
+      avatarUrl: String   # Optional: Avatar URL for the person being invited
+    }.freeze
   end
 end

data/lib/vortex/version.rb

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

metadata

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