Struct ShelfDevicesApi

pub struct ShelfDevicesApi<'a, V> { /* private fields */ }

“Shelf Devices” section of the devices API.

Implementations

impl<'a, V> ShelfDevicesApi<'a, V>

pub fn new(client: &'a SdkClient, config: &ShelfDevicesApiConfig) -> Self

Create a new interface for “Shelf Devices” API.

pub async fn get( &self, serial_number: impl Into<String> + Send + Clone, ) -> Result<GetShelfDeviceResponse, SdkClientError>

Get a Shelf Device’s information.

Errors

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

pub async fn get_registry_id( &self, serial_number: impl Into<String> + Send + Clone, ) -> Result<GetShelfDeviceResponse, SdkClientError>

Get a Shelf Device’s registry ID.

After a device has been registered as shelf, it must periodically poll this route to check if it has been provisioned to a registry.

This route requires a JWT generated from the private key.

Errors

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

pub async fn store( &self, serial_number: impl Into<String> + Send + Clone, secret: impl Into<String> + Send + Clone, ) -> Result<StoreShelfDeviceResponse, SdkClientError>

Store a new Shelf Device.

Errors

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

pub async fn provision( &self, serial_number: impl Into<String> + Send + Clone, registry_id: u32, ) -> Result<ProvisionShelfDeviceResponse, SdkClientError>

Provision an existing Shelf Device to a registry.

Errors

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

pub async fn deprovision( &self, serial_number: impl Into<String> + Send + Clone, ) -> Result<DeprovisionShelfDeviceResponse, SdkClientError>

Deprovision a provisioned Shelf Device.

Errors

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

pub async fn delete( &self, serial_number: impl Into<String> + Send + Clone, ) -> Result<DeleteShelfDeviceResponse, SdkClientError>

Delete a Shelf Device.

Errors

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