vortex-python-sdk 0.9.2__tar.gz → 0.9.4__tar.gz

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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: vortex-python-sdk
3
- Version: 0.9.2
3
+ Version: 0.9.4
4
4
  Summary: Vortex Python SDK for invitation management and JWT generation
5
5
  Author-email: TeamVortexSoftware <support@vortexsoftware.com>
6
6
  License-Expression: MIT
@@ -203,6 +203,46 @@ async def reinvite_user():
203
203
  invitation = vortex.reinvite_sync("invitation-id")
204
204
  ```
205
205
 
206
+ #### Sync Internal Invitation
207
+
208
+ 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.
209
+
210
+ ```python
211
+ async def sync_internal_invitation_action():
212
+ # Async version
213
+ result = await vortex.sync_internal_invitation(
214
+ creator_id="user-123", # The inviter's user ID in your system
215
+ target_value="user-456", # The invitee's user ID in your system
216
+ action="accepted", # "accepted" or "declined"
217
+ component_id="component-uuid" # The widget component UUID
218
+ )
219
+ print(f"Processed: {result['processed']}")
220
+ print(f"Invitation IDs: {result['invitationIds']}")
221
+
222
+ # Sync version
223
+ result = vortex.sync_internal_invitation_sync(
224
+ creator_id="user-123",
225
+ target_value="user-456",
226
+ action="accepted",
227
+ component_id="component-uuid"
228
+ )
229
+ ```
230
+
231
+ **Parameters:**
232
+ - `creator_id` (str) — The inviter's user ID in your system
233
+ - `target_value` (str) — The invitee's user ID in your system
234
+ - `action` ("accepted" | "declined") — The invitation decision
235
+ - `component_id` (str) — The widget component UUID
236
+
237
+ **Response:**
238
+ - `processed` (int) — Count of invitations processed
239
+ - `invitationIds` (list[str]) — IDs of processed invitations
240
+
241
+ **Use cases:**
242
+ - You handle invitation delivery through your own in-app notifications or UI
243
+ - Users accept/decline invitations within your application
244
+ - You need to keep Vortex updated with the invitation status
245
+
206
246
  ### Context Manager Usage
207
247
 
208
248
  ```python
@@ -165,6 +165,46 @@ async def reinvite_user():
165
165
  invitation = vortex.reinvite_sync("invitation-id")
166
166
  ```
167
167
 
168
+ #### Sync Internal Invitation
169
+
170
+ 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.
171
+
172
+ ```python
173
+ async def sync_internal_invitation_action():
174
+ # Async version
175
+ result = await vortex.sync_internal_invitation(
176
+ creator_id="user-123", # The inviter's user ID in your system
177
+ target_value="user-456", # The invitee's user ID in your system
178
+ action="accepted", # "accepted" or "declined"
179
+ component_id="component-uuid" # The widget component UUID
180
+ )
181
+ print(f"Processed: {result['processed']}")
182
+ print(f"Invitation IDs: {result['invitationIds']}")
183
+
184
+ # Sync version
185
+ result = vortex.sync_internal_invitation_sync(
186
+ creator_id="user-123",
187
+ target_value="user-456",
188
+ action="accepted",
189
+ component_id="component-uuid"
190
+ )
191
+ ```
192
+
193
+ **Parameters:**
194
+ - `creator_id` (str) — The inviter's user ID in your system
195
+ - `target_value` (str) — The invitee's user ID in your system
196
+ - `action` ("accepted" | "declined") — The invitation decision
197
+ - `component_id` (str) — The widget component UUID
198
+
199
+ **Response:**
200
+ - `processed` (int) — Count of invitations processed
201
+ - `invitationIds` (list[str]) — IDs of processed invitations
202
+
203
+ **Use cases:**
204
+ - You handle invitation delivery through your own in-app notifications or UI
205
+ - Users accept/decline invitations within your application
206
+ - You need to keep Vortex updated with the invitation status
207
+
168
208
  ### Context Manager Usage
169
209
 
170
210
  ```python
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "vortex-python-sdk"
7
- version = "0.9.2"
7
+ version = "0.9.4"
8
8
  description = "Vortex Python SDK for invitation management and JWT generation"
9
9
  authors = [{name = "TeamVortexSoftware", email = "support@vortexsoftware.com"}]
10
10
  readme = "README.md"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: vortex-python-sdk
3
- Version: 0.9.2
3
+ Version: 0.9.4
4
4
  Summary: Vortex Python SDK for invitation management and JWT generation
5
5
  Author-email: TeamVortexSoftware <support@vortexsoftware.com>
6
6
  License-Expression: MIT
@@ -203,6 +203,46 @@ async def reinvite_user():
203
203
  invitation = vortex.reinvite_sync("invitation-id")
204
204
  ```
205
205
 
206
+ #### Sync Internal Invitation
207
+
208
+ 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.
209
+
210
+ ```python
211
+ async def sync_internal_invitation_action():
212
+ # Async version
213
+ result = await vortex.sync_internal_invitation(
214
+ creator_id="user-123", # The inviter's user ID in your system
215
+ target_value="user-456", # The invitee's user ID in your system
216
+ action="accepted", # "accepted" or "declined"
217
+ component_id="component-uuid" # The widget component UUID
218
+ )
219
+ print(f"Processed: {result['processed']}")
220
+ print(f"Invitation IDs: {result['invitationIds']}")
221
+
222
+ # Sync version
223
+ result = vortex.sync_internal_invitation_sync(
224
+ creator_id="user-123",
225
+ target_value="user-456",
226
+ action="accepted",
227
+ component_id="component-uuid"
228
+ )
229
+ ```
230
+
231
+ **Parameters:**
232
+ - `creator_id` (str) — The inviter's user ID in your system
233
+ - `target_value` (str) — The invitee's user ID in your system
234
+ - `action` ("accepted" | "declined") — The invitation decision
235
+ - `component_id` (str) — The widget component UUID
236
+
237
+ **Response:**
238
+ - `processed` (int) — Count of invitations processed
239
+ - `invitationIds` (list[str]) — IDs of processed invitations
240
+
241
+ **Use cases:**
242
+ - You handle invitation delivery through your own in-app notifications or UI
243
+ - Users accept/decline invitations within your application
244
+ - You need to keep Vortex updated with the invitation status
245
+
206
246
  ### Context Manager Usage
207
247
 
208
248
  ```python
@@ -1039,7 +1039,7 @@ class Vortex:
1039
1039
 
1040
1040
  response = await self._vortex_api_request(
1041
1041
  "POST",
1042
- "/invitation-actions/sync-internal-invitation",
1042
+ "/invitations/sync-internal-invitation",
1043
1043
  data=request.model_dump(by_alias=True),
1044
1044
  )
1045
1045
  return SyncInternalInvitationResponse(**response)
@@ -1073,7 +1073,7 @@ class Vortex:
1073
1073
 
1074
1074
  response = self._vortex_api_request_sync(
1075
1075
  "POST",
1076
- "/invitation-actions/sync-internal-invitation",
1076
+ "/invitations/sync-internal-invitation",
1077
1077
  data=request.model_dump(by_alias=True),
1078
1078
  )
1079
1079
  return SyncInternalInvitationResponse(**response)