Struct AMPAPI

pub struct AMPAPI {
    pub base_uri: String,
    pub data_source: String,
    pub username: String,
    pub password: String,
    pub remember_me_token: String,
    pub session_id: String,
    /* private fields */
}

AMPAPI - Struct for interacting with the AMP API

Fields

base_uri: String

base_uri - The base URI of the AMP instance

data_source: String

data_source - The data source URI of the AMP instance

username: String

username - The username to use for authentication

password: String

password - The password to use for authentication

remember_me_token: String

remember_me_token - The remember me token to use for authentication

session_id: String

session_id - The session ID to use for authentication

Implementations

impl AMPAPI

AMPAPI methods

pub fn new( base_uri: String, username: String, password: String, remember_me_token: String, session_id: String, ) -> AMPAPI

AMPAPI.new - Create a new AMPAPI struct

• base_uri - The base URI of the AMP instance
• username - The username to use for authentication
• password - The password to use for authentication
  • Optional if using a remember me token
• remember_me_token - The remember me token to use for authentication
  • Optional
• session_id - The session ID to use for authentication
  • Optional, will be instantiated on login Returns AMPAPI

pub fn api_call<T: DeserializeOwned>( &mut self, endpoint: String, args: HashMap<String, Value>, ) -> Result<T, Error>

AMPAPI.api_call - This function takes an endpoint and a map of arguments and returns the response

• endpoint - The endpoint to call
• args - A map of arguments to pass to the endpoint Returns Result<T, reqwest::Error>

pub fn login(&mut self) -> Result<LoginResult, Error>

AMPAPI.login - Simplified login function Returns Result<LoginResult, reqwest::Error>

Trait Implementations

impl Clone for AMPAPI

fn clone(&self) -> AMPAPI

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AMPAPI

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

Formats the value using the given formatter.