vortex-ruby-sdk 1.0.0 → 1.1.3

data/lib/vortex/types.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Vortex
+  # Type documentation for Vortex SDK responses
+  # Ruby uses dynamic typing with Hashes, but this documents the expected structure
+  module Types
+    # Group structure for JWT generation (input)
+    # @example
+    #   {
+    #     type: 'workspace',
+    #     id: 'workspace-123',       # Legacy field (deprecated, use groupId)
+    #     groupId: 'workspace-123',  # Preferred field
+    #     name: 'My Workspace'
+    #   }
+    GROUP_INPUT = {
+      type: String,      # Required: Group type (e.g., "workspace", "team")
+      id: String,        # Optional: Legacy field (deprecated, use groupId)
+      groupId: String,   # Optional: Preferred - Customer's group ID
+      name: String       # Required: Group name
+    }.freeze
+
+    # InvitationGroup structure from API responses
+    # This matches the MemberGroups table structure from the API
+    # @example
+    #   {
+    #     id: '550e8400-e29b-41d4-a716-446655440000',
+    #     accountId: '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+    #     groupId: 'workspace-123',
+    #     type: 'workspace',
+    #     name: 'My Workspace',
+    #     createdAt: '2025-01-27T12:00:00.000Z'
+    #   }
+    INVITATION_GROUP = {
+      id: String,          # Vortex internal UUID
+      accountId: String,   # Vortex account ID
+      groupId: String,     # Customer's group ID (the ID they provided to Vortex)
+      type: String,        # Group type (e.g., "workspace", "team")
+      name: String,        # Group name
+      createdAt: String    # ISO 8601 timestamp when the group was created
+    }.freeze
+
+    # AcceptUser structure for accepting invitations (new format - preferred)
+    # @example
+    #   {
+    #     email: 'user@example.com',
+    #     phone: '+1234567890',      # Optional
+    #     name: 'John Doe'           # Optional
+    #   }
+    ACCEPT_USER = {
+      email: String,  # Optional but either email or phone must be provided
+      phone: String,  # Optional but either email or phone must be provided
+      name: String    # Optional
+    }.freeze
+
+    # Invitation structure from API responses
+    # @example
+    #   {
+    #     id: '550e8400-e29b-41d4-a716-446655440000',
+    #     accountId: '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+    #     groups: [INVITATION_GROUP, ...],
+    #     # ... other fields
+    #   }
+    INVITATION = {
+      id: String,
+      accountId: String,
+      clickThroughs: Integer,
+      configurationAttributes: Hash,
+      attributes: Hash,
+      createdAt: String,
+      deactivated: :boolean,
+      deliveryCount: Integer,
+      deliveryTypes: Array, # of String
+      foreignCreatorId: String,
+      invitationType: String,
+      modifiedAt: String,
+      status: String,
+      target: Array, # of { type: String, value: String }
+      views: Integer,
+      widgetConfigurationId: String,
+      projectId: String,
+      groups: Array, # of INVITATION_GROUP structures
+      accepts: Array, # of acceptance structures
+      expired: :boolean,
+      expires: String # ISO 8601 timestamp (optional)
+    }.freeze
+  end
+end

data/lib/vortex/version.rb

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

data/lib/vortex.rb

@@ -2,6 +2,7 @@
 
 require 'vortex/version'
 require 'vortex/error'
+require 'vortex/types'
 require 'vortex/client'
 
 # Vortex Ruby SDK

data/vortex-ruby-sdk.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name = 'vortex-ruby-sdk'
   spec.version = Vortex::VERSION
   spec.authors = ['Vortex Software']
-  spec.email = ['support@vortexsoftware.io']
+  spec.email = ['support@vortexsoftware.com']
 
   spec.summary = 'Ruby SDK for Vortex invitation system'
   spec.description = 'A Ruby SDK that provides seamless integration with the Vortex invitation system, including JWT generation and invitation management.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vortex-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.3
 platform: ruby
 authors:
 - Vortex Software
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-17 00:00:00.000000000 Z
+date: 2026-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,11 +139,13 @@ dependencies:
 description: A Ruby SDK that provides seamless integration with the Vortex invitation
   system, including JWT generation and invitation management.
 email:
-- support@vortexsoftware.io
+- support@vortexsoftware.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/implementation-guide.md"
+- CHANGELOG.md
 - LICENSE
 - PUBLISHING.md
 - README.md
@@ -156,6 +158,7 @@ files:
 - lib/vortex/error.rb
 - lib/vortex/rails.rb
 - lib/vortex/sinatra.rb
+- lib/vortex/types.rb
 - lib/vortex/version.rb
 - vortex-ruby-sdk.gemspec
 homepage: https://github.com/vortexsoftware/vortex-ruby-sdk
@@ -166,7 +169,7 @@ metadata:
   homepage_uri: https://github.com/vortexsoftware/vortex-ruby-sdk
   source_code_uri: https://github.com/vortexsoftware/vortex-ruby-sdk
   changelog_uri: https://github.com/vortexsoftware/vortex-ruby-sdk/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,8 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Ruby SDK for Vortex invitation system
 test_files: []