vortex-ruby-sdk 1.8.2 → 1.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +32 -0
  3. data/lib/vortex/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 68f5ea9102076ab25a0178aee43feb1a96f647709a634d0936b0d41da0b28a03
4
- data.tar.gz: 347073bb4b8b3bb518e75b750112bb1ebc7230a1ef5507d1a0a1b4b3101745fa
3
+ metadata.gz: f18c676fb034bb528e9d15103c72c781336265ea591c207c98c3b43011999e19
4
+ data.tar.gz: f93d826ce67bbaf30a0d2c40240f0070c492f277823b9c377d31d0557b989d9f
5
5
  SHA512:
6
- metadata.gz: 0ecc573608fc5df6bd8ad3dfac50f8b8bc91dd187a775558cd0837398620c85f3a14b3217e35da5845dabccc2ee2da0f71b8866726d963f221d7adde1ea61034
7
- data.tar.gz: 7c1fe944df47039af93e32413c32522d535642df75bc1fbe5a8fe9b29c89d292459a590f14efec3e7015b373f66ccd7cf85b15b795165a390459bd144df7b961
6
+ metadata.gz: 55f270dd410709b262dded8417c3a0f76362e8650b4611a719cf4061601b0e2c056438c5ebe33f1d6544a2f6b41c22a341fd587ca9f93e97023920404401aec7
7
+ data.tar.gz: aefed295464f5b39ae39bd7738287f8e097b8ad5a1d4da056028019705f1a136856e4d63405a087d93bc268ddf0f27215ba19db53cd165caf833fc09b212785e
data/README.md CHANGED
@@ -190,6 +190,38 @@ The SDK provides these routes (same as other SDKs for React provider compatibili
190
190
  - `POST /api/vortex/invitations/:id/reinvite`
191
191
  - `POST /api/vortex/invitation-actions/sync-internal-invitation`
192
192
 
193
+ ## Sync Internal Invitation
194
+
195
+ If you're using `internal` delivery type invitations and managing the invitation flow within your own application, you can sync invitation decisions back to Vortex when users accept or decline invitations in your system.
196
+
197
+ ```ruby
198
+ # Sync an internal invitation action
199
+ result = client.sync_internal_invitation(
200
+ 'user-123', # creator_id - The inviter's user ID in your system
201
+ 'user-456', # target_value - The invitee's user ID in your system
202
+ 'accepted', # action - "accepted" or "declined"
203
+ 'component-uuid' # component_id - The widget component UUID
204
+ )
205
+
206
+ puts "Processed: #{result['processed']}"
207
+ puts "Invitation IDs: #{result['invitationIds']}"
208
+ ```
209
+
210
+ **Parameters:**
211
+ - `creator_id` (String) — The inviter's user ID in your system
212
+ - `target_value` (String) — The invitee's user ID in your system
213
+ - `action` ("accepted" | "declined") — The invitation decision
214
+ - `component_id` (String) — The widget component UUID
215
+
216
+ **Response:**
217
+ - `processed` (Integer) — Count of invitations processed
218
+ - `invitationIds` (Array<String>) — IDs of processed invitations
219
+
220
+ **Use cases:**
221
+ - You handle invitation delivery through your own in-app notifications or UI
222
+ - Users accept/decline invitations within your application
223
+ - You need to keep Vortex updated with the invitation status
224
+
193
225
  ## JWT Payload Structure
194
226
 
195
227
  The SDK generates JWTs with the following payload structure:
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Vortex
4
- VERSION = '1.8.2'
4
+ VERSION = '1.8.3'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vortex-ruby-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.2
4
+ version: 1.8.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vortex Software