Struct SdkClient

pub struct SdkClient { /* private fields */ }

Wrapper of a reqwest::Client to make API requests to Fundamentum. It contains the possible HTTP methods to be used with the client.

Implementations

impl SdkClient

pub fn new(config: ClientConfig, api_version: &str) -> Self

Create a new Client.

pub const fn config(&self) -> &ClientConfig

Get the current configuration of this client.

pub async fn status(&self) -> Result<Status, SdkClientError>

Retrieve the API’s status.

Errors

There may be an error to get the HTTP Response, to interpret its Json body into the Response.

pub async fn get_openapi_json(&self) -> Result<Value, SdkClientError>

Retrieve the Open API Json file.

Errors

There may be an error to get the HTTP Response, to interpret its Json body into the Response.

pub async fn get<T, S>(&self, path: S) -> Result<T, SdkClientError>

where T: DeserializeOwned, S: Into<String> + Send,

Method to perform a GET HTTP request.

Errors

The request may fail if the path is invalid or inexistant.

pub async fn delete<T, S>(&self, path: S) -> Result<T, SdkClientError>

where T: DeserializeOwned, S: Into<String> + Send,

Method to perform a DELETE HTTP request.

Errors

The request may fail if the path is invalid or inexistant.

pub async fn post_body<T, S, B>( &self, path: S, body: B, ) -> Result<T, SdkClientError>

where T: DeserializeOwned, S: Into<String> + Send, B: Serialize + Send + Sync,

Method to perform a POST HTTP request with a body.

Errors

The request may fail if the path is invalid or inexistant, or if the body is invalid.

pub async fn put_body<T, S, B>( &self, path: S, body: B, ) -> Result<T, SdkClientError>

where T: DeserializeOwned, S: Into<String> + Send, B: Serialize + Send + Sync,

Method to perform a PUT HTTP request with a body.

Errors

The request may fail if the path is invalid or inexistant, or if the body is invalid.

Trait Implementations

impl Clone for SdkClient

fn clone(&self) -> SdkClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.