Struct UserApi 

pub struct UserApi<'a> { /* private fields */ }

Main interface for TorBox User operations

Provides methods for all general API calls including:

• Retrieving user data
• Adding referal links
• Refreshing APIs

Implementations

impl<'a> UserApi<'a>

pub fn new(client: &'a TorboxClient) -> UserApi<'a>

pub async fn refresh_api_token( &self, token: String, expires_at: u64, ) -> Result<ApiResponse<String>, ApiError>

Not done

pub async fn get_data( &self, enable_settings: bool, ) -> Result<ApiResponse<UserProfile>, ApiError>

Overview

Gets a users account data and information.

pub async fn add_referral_code( &self, referral: String, ) -> Result<ApiResponse<()>, ApiError>

pub async fn get_confirmation_code(&self) -> Result<ApiResponse<()>, ApiError>

pub async fn start_device_code_auth( &self, app_name: String, ) -> Result<ApiResponse<DeviceCodeAuth>, ApiError>

pub async fn get_referral_data( &self, ) -> Result<ApiResponse<ReferralData>, ApiError>

pub async fn get_subscription( &self, ) -> Result<ApiResponse<SubscriptionData>, ApiError>

pub async fn get_transactions( &self, ) -> Result<ApiResponse<Vec<TransactionData>>, ApiError>

pub async fn get_search_engines( &self, id: u32, ) -> Result<ApiResponse<Vec<SearchEngineData>>, ApiError>

pub async fn control_search_engines( &self, body: SearchEngineControlBody, ) -> Result<ApiResponse<()>, ApiError>

pub async fn edit_search_engines( &self, body: SearchEngineEditBody, ) -> Result<ApiResponse<SearchEngineData>, ApiError>

Trait Implementations

impl<'a> NamedType for UserApi<'a>

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to Type::inline but returns a NamedDataType instead.

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a NamedDataType instead.

impl<'a> Type for UserApi<'a>

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics.

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl<'a> Flatten for UserApi<'a>