VortexClient

Struct VortexClient 

Source
pub struct VortexClient { /* private fields */ }
Expand description

Vortex Rust SDK Client

Provides JWT generation and Vortex API integration for Rust applications. Compatible with React providers and follows the same paradigms as other Vortex SDKs.

Implementations§

Source§

impl VortexClient

Source

pub fn new(api_key: String) -> Self

Create a new Vortex client

§Arguments
  • api_key - Your Vortex API key
§Example
use vortex_sdk::VortexClient;

let api_key = "VRTX.your_encoded_id.your_key".to_string();
let client = VortexClient::new(api_key);
Source

pub fn with_base_url(api_key: String, base_url: String) -> Self

Create a new Vortex client with a custom base URL

§Arguments
  • api_key - Your Vortex API key
  • base_url - Custom base URL for the Vortex API
Source

pub fn generate_jwt( &self, user_id: &str, identifiers: Vec<Identifier>, groups: Vec<Group>, role: Option<&str>, ) -> Result<String, VortexError>

Generate a JWT token for the given user data

This uses the same algorithm as the Node.js SDK to ensure complete compatibility with React providers.

§Arguments
  • user_id - Unique identifier for the user
  • identifiers - List of identifiers (email, sms)
  • groups - List of groups the user belongs to
  • role - Optional user role
§Example
use vortex_sdk::{VortexClient, Identifier, Group};

// API key format: VRTX.base64_encoded_uuid.secret_key
let client = VortexClient::new("VRTX.AAAAAAAAAAAAAAAAAAAAAA.test_secret_key".to_string());
let jwt = client.generate_jwt(
    "user-123",
    vec![Identifier::new("email", "user@example.com")],
    vec![Group::new("team", "team-1", "Engineering")],
    Some("admin")
).unwrap();
Source

pub async fn get_invitations_by_target( &self, target_type: &str, target_value: &str, ) -> Result<Vec<Invitation>, VortexError>

Get invitations by target (email or sms)

Source

pub async fn get_invitation( &self, invitation_id: &str, ) -> Result<Invitation, VortexError>

Get a specific invitation by ID

Source

pub async fn revoke_invitation( &self, invitation_id: &str, ) -> Result<(), VortexError>

Revoke (delete) an invitation

Source

pub async fn accept_invitations( &self, invitation_ids: Vec<String>, target: InvitationTarget, ) -> Result<Invitation, VortexError>

Accept multiple invitations

Source

pub async fn delete_invitations_by_group( &self, group_type: &str, group_id: &str, ) -> Result<(), VortexError>

Delete all invitations for a specific group

Source

pub async fn get_invitations_by_group( &self, group_type: &str, group_id: &str, ) -> Result<Vec<Invitation>, VortexError>

Get all invitations for a specific group

Source

pub async fn reinvite( &self, invitation_id: &str, ) -> Result<Invitation, VortexError>

Reinvite a user (send invitation again)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,