Skip to content

Commit

Permalink
update docs for client mod
Browse files Browse the repository at this point in the history
  • Loading branch information
nsantiago2719 committed Apr 5, 2023
1 parent 250e578 commit 6ffe458
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion client/src/lib.rs
Expand Up @@ -11,6 +11,7 @@ use base64::{
Engine as _,
};

/// Client for Maya SDK
#[derive(Debug)]
pub struct MayaClient {
pub client: Client,
Expand All @@ -24,7 +25,12 @@ const CUSTOM_ENGINE: engine::GeneralPurpose =
impl MayaClient {
/// Creates a client from reqwest client and returns client, auth_header and the url domain
/// for the client
/// ```
///
/// It takes a parameter username, password, and url_domain to generate and return a MayaClient
/// which can be used to send a request to the domain given in the parameter. The *url_domain*
/// is an Option<String> which the user can use to set the domain of the API endpoint.
///
/// ```rust,no_run
/// use maya_client_sdk::MayaClient;
///
/// let maya_client = MayaClient::new(
Expand Down

0 comments on commit 6ffe458

Please sign in to comment.