Skip to main content

RainySessionClient

Struct RainySessionClient 

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

Client for Rainy API v3 JWT/session endpoints.

Use this client for authentication and dashboard/account operations such as /api/v1/auth/*, /api/v1/keys, /api/v1/usage/*, and /api/v1/orgs/me.

Implementations§

Source§

impl RainySessionClient

Source

pub fn new() -> Result<Self>

Creates a session client using default configuration.

Source

pub fn with_config(config: SessionConfig) -> Result<Self>

Creates a session client with custom configuration.

Source

pub fn with_base_url(base_url: impl Into<String>) -> Result<Self>

Creates a session client with only a custom base URL override.

Source

pub fn set_access_token(&mut self, access_token: impl Into<String>)

Sets the in-memory access token used for authenticated requests.

Source

pub fn clear_access_token(&mut self)

Clears the in-memory access token.

Source

pub fn access_token(&self) -> Option<&str>

Returns the current in-memory access token, if set.

Source

pub fn base_url(&self) -> &str

Returns the configured API base URL.

Source

pub async fn login( &mut self, email: &str, password: &str, ) -> Result<LoginResponse>

Authenticates a user and stores the returned access token in the client.

Source

pub async fn register( &mut self, email: &str, password: &str, region: &str, ) -> Result<LoginResponse>

Registers a user and stores the returned access token in the client.

Source

pub async fn refresh(&mut self, refresh_token: &str) -> Result<RefreshResponse>

Refreshes the session token pair and stores the new access token.

Source

pub async fn me(&self) -> Result<SessionUser>

Returns the current authenticated user profile from GET /api/v1/auth/me.

Source

pub async fn org_me(&self) -> Result<OrgProfile>

Returns the current organization profile from GET /api/v1/orgs/me.

Source

pub async fn list_api_keys(&self) -> Result<Vec<SessionApiKeyListItem>>

Lists API keys for the authenticated organization/user session.

Source

pub async fn create_api_key( &self, name: &str, key_type: Option<&str>, ) -> Result<CreatedApiKey>

Creates a new API key for the authenticated session.

key_type may be Some("standard"), Some("platform"), or None to let the server default apply.

Source

pub async fn delete_api_key(&self, id: &str) -> Result<Value>

Deletes an API key by ID.

Returns the server JSON response as-is to avoid over-expanding the SDK surface.

Source

pub async fn usage_credits(&self) -> Result<UsageCreditsResponse>

Returns current credit balance information from GET /api/v1/usage/credits.

Source

pub async fn usage_stats(&self, days: Option<u32>) -> Result<UsageStatsResponse>

Returns usage statistics from GET /api/v1/usage/stats.

When days is None, the server default period is used.

Trait Implementations§

Source§

impl Clone for RainySessionClient

Source§

fn clone(&self) -> RainySessionClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RainySessionClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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