vortex-ruby-sdk 1.1.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2f54f415260bef01b6106dc5d32cf274e4b9c45e00cdd89e18ad6dfbc1df177
-  data.tar.gz: 32e1ab2a8a7bc1ee1a3a683d82832a301f4e3403289a64ff8eea4c77410dc104
+  metadata.gz: ac2c594fa0a88757da59e6df7f87e0d232b25e53035b560bce733c582d953320
+  data.tar.gz: 356960f55a08e9c475bf4be6b126510d36ad8251d2988d44c3ede9f3d00598e4
 SHA512:
-  metadata.gz: 61262106b17af91ce480f7fac66a79a9d4bf2b7b77c264eba92ea07bf7a82967991e3629b59c84f0edbed77054a4f3f9ac661f9a101a4e28f8dd1efc16deafe9
-  data.tar.gz: efc03cda77c4d08a66ef056da5d6c72930ce0003bd6418e2cb145a6a95930e0895f7057d4e864c6c78ca7c5a69ac05dca35d0d6e17ea1aec01e480d795244a32
+  metadata.gz: f5b8fd2f00a23144c21d87a3cd127bef7dc25d935d78e9a0120048e075c756a5e5db1f3bf6b0a466e7788c626a75e1f91b019acadf2f334ddb9da811ee37fcd0
+  data.tar.gz: b4c4a42a681f9cd772cd2310b00692f149e48171ce5c0659f94dc3995a307a5d6c986aa96984aaf403a0ed610c0491718c8c0323771ba308c25a09f586724265

data/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to the Vortex Ruby SDK will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2026-01-23
+
+### Added
+- **Internal Invitations**: New `'internal'` delivery type for customer-managed invitations
+  - Support for `deliveryTypes: ['internal']`
+  - No email/SMS communication triggered by Vortex
+  - Target value can be any customer-defined identifier
+  - Useful for in-app invitation flows managed by customer's application
+
+### Changed
+- Updated `deliveryTypes` field documentation to include `'internal'` as a valid value
+
 ## [1.1.3] - 2025-01-29
 
 ### Added

data/README.md

@@ -12,6 +12,8 @@ A Ruby SDK for the Vortex invitation system, providing seamless integration with
 - **Same Route Structure**: Ensures React provider compatibility
 - **Comprehensive Testing**: Full test coverage with RSpec
 - **Type Safety**: Clear method signatures and documentation
+- **Multiple Delivery Types**: Support for `email`, `phone`, `share`, and `internal` invitation delivery
+  - `internal` invitations allow for customer-managed, in-app invitation flows with no external communication
 
 ## Installation
 
@@ -45,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
@@ -61,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

@@ -80,6 +80,16 @@ module Vortex
         expires: expires
       }
 
+      # Add name if present (convert snake_case to camelCase for JWT)
+      if user[:user_name]
+        payload[:userName] = user[:user_name]
+      end
+
+      # 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
       if user[:admin_scopes]
         payload[:adminScopes] = user[:admin_scopes]
@@ -204,7 +214,7 @@ module Vortex
         case target_type
         when 'email'
           user[:email] = target_value
-        when 'sms', 'phoneNumber'
+        when 'phone', 'phoneNumber'
           user[:phone] = target_value
         else
           # For other types, try to use as email
@@ -277,6 +287,102 @@ module Vortex
       raise VortexError, "Failed to reinvite: #{e.message}"
     end
 
+    # Create an invitation from your backend
+    #
+    # This method allows you to create invitations programmatically using your API key,
+    # without requiring a user JWT token. Useful for server-side invitation creation,
+    # such as "People You May Know" flows or admin-initiated invitations.
+    #
+    # Target types:
+    # - 'email': Send an email invitation
+    # - 'phone': Create a phone invitation (short link returned for you to send)
+    # - 'internal': Create an internal invitation for PYMK flows (no email sent)
+    #
+    # @param widget_configuration_id [String] The widget configuration ID to use
+    # @param target [Hash] The invitation target: { type: 'email|sms|internal', value: '...' }
+    # @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 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' }],
+    #     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)
+    #   result = client.create_invitation(
+    #     'widget-config-123',
+    #     { type: 'internal', value: 'internal-user-abc' },
+    #     { user_id: 'user-456' },
+    #     nil,
+    #     'pymk'
+    #   )
+    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?
+
+      # Build request body with camelCase keys for the API
+      body = {
+        widgetConfigurationId: widget_configuration_id,
+        target: target,
+        inviter: {
+          userId: inviter[:user_id],
+          userEmail: inviter[:user_email],
+          userName: inviter[:user_name],
+          userAvatarUrl: inviter[:user_avatar_url]
+        }.compact
+      }
+
+      if groups && !groups.empty?
+        body[:groups] = groups.map do |g|
+          {
+            type: g[:type],
+            groupId: g[:group_id],
+            name: g[:name]
+          }
+        end
+      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'
+        req.body = JSON.generate(body)
+      end
+
+      handle_response(response)
+    rescue VortexError
+      raise
+    rescue => e
+      raise VortexError, "Failed to create invitation: #{e.message}"
+    end
+
     private
 
     def build_connection

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,
@@ -69,12 +84,12 @@ module Vortex
       createdAt: String,
       deactivated: :boolean,
       deliveryCount: Integer,
-      deliveryTypes: Array, # of String
+      deliveryTypes: Array, # of String - valid values: "email", "phone", "share", "internal"
       foreignCreatorId: String,
       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.1.3'
+  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.1.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Vortex Software
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-05 00:00:00.000000000 Z
+date: 2026-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday