Struct SdkApi

pub struct SdkApi<V> { /* private fields */ }

User facing structure to make calls to the Fundamentum API. This may be used within a user application to register a device, provision it, and other actions available via the Fundamentum API.

Implementations

impl<V: ApiVersion> SdkApi<V>

pub fn new(config: ClientConfig) -> Self

Create a new SDK API to access Fundamentum’s API.

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

Get the API’s status.

Errors

There may be errors if the API is not up and running.

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

Retrieve the Open API Json file.

Errors

There may be errors if the API is not up and running.

pub fn devices_api<'a>( &'a self, api_config: &'a DevicesApiConfig, ) -> DevicesApi<'a, V>

Get the Devices API.

pub fn provisioning_api<'a>( &'a self, api_config: &'a ProvisioningApiConfig, ) -> ProvisioningApi<'a, V>

Get the Provisioning API.

pub fn shelf_devices_api<'a>( &'a self, config: &'a ShelfDevicesApiConfig, ) -> ShelfDevicesApi<'a, V>

Get the Shelf Devices API.

pub const fn get_sdk_client(&self) -> &SdkClient

Return the real SdkClient used internally. This allows the flexibility to use the client to make other requests not supported by this SDK, however known to exist.