Struct ConnectorClient

pub struct ConnectorClient<'a> { /* private fields */ }

The connector client implements all relevant functions to communicate with an enmeshed connector.

Implementations

impl<'a> ConnectorClient<'a>

pub fn new(base_url: &'a str, api_key: &str) -> Self

To construct a connector client a base url the connector is listening to and the configured api key is needed.

impl<'a> ConnectorClient<'a>

All endpoints related to the enmeshed account.

pub async fn get_identity_info(&self) -> Result<IdentityInfo, Error>

Retrieves the IdentityInfo of the connector the client is connected to.

pub async fn get_sync_info(&self) -> Result<SyncInfo, Error>

Retrieves the date of the last sync ran if there has been one.

pub async fn sync(&self) -> Result<ConnectorSyncResult, Error>

Syncs the connector with the backbone retrieving all messages and relationships that have been received since the last sync.

impl<'a> ConnectorClient<'a>

All endpoints to manage the attributes of the connector.

pub async fn create_attribute( &self, attribute: &CreateAttributeRequest, ) -> Result<ConnectorAttribute, Error>

pub async fn get_attributes( &self, query: &GetAttributesRequest<'a>, ) -> Result<Vec<ConnectorAttribute>, Error>

pub async fn get_attribute_by_id( &self, id: &str, ) -> Result<ConnectorAttribute, Error>

pub async fn get_valid_attributes( &self, query: &GetValidAttributesRequest<'a>, ) -> Result<Vec<ConnectorAttribute>, Error>

pub async fn execute_identity_query( &self, body: &ExecuteIdentityAttributeQueryRequest<'a>, ) -> Result<Vec<ConnectorAttribute>, Error>

impl<'a> ConnectorClient<'a>

All endpoints related to creating and verifying challenges.

pub async fn create_device_challenge(&self) -> Result<ConnectorChallenge, Error>

pub async fn create_identity_challenge( &self, ) -> Result<ConnectorChallenge, Error>

pub async fn create_relationship_challenge( &self, rel: &str, ) -> Result<ConnectorChallenge, Error>

pub async fn validate_challenge( &self, req: &ValidateChallengeRequest<'_>, ) -> Result<ConnectorChallengeValidationResult<Value, Value>, Error>

impl<'a> ConnectorClient<'a>

All endpoints related to file management, like upload or download of files.

pub async fn get_files( &self, files_query: &GetAllFilesRequest<'_>, ) -> Result<Vec<ConnectorFile>, Error>

pub async fn upload_file( &self, upload_body: &UploadFileRequest<'_>, ) -> Result<ConnectorFile, Error>

pub async fn get_own_files( &self, files_query: &GetOwnFilesRequest<'_>, ) -> Result<Vec<ConnectorFile>, Error>

pub async fn load_peer_file( &self, file_reference: &LoadPeerFileRequest, ) -> Result<Vec<ConnectorFile>, Error>

pub async fn get_peer_files( &self, peer_req: &GetPeerFilesRequest<'_>, ) -> Result<Vec<ConnectorFile>, Error>

pub async fn get_file(&self, file_id: &str) -> Result<Vec<ConnectorFile>, Error>

pub async fn get_file_data(&self, file_id: &str) -> Result<Vec<u8>, Error>

pub async fn get_file_qr_code(&self, file_id: &str) -> Result<Vec<u8>, Error>

pub async fn get_file_token( &self, file_id: &str, req: Option<CreateTokenForFileRequest<'_>>, ) -> Result<ConnectorToken<FileToken>, Error>

pub async fn get_file_token_qr_code( &self, file_id: &str, req: Option<CreateTokenQrCodeForFileRequest<'_>>, ) -> Result<Vec<u8>, Error>

impl<'a> ConnectorClient<'a>

All endpoints related to managing incomming requests.

pub async fn get_incomming_request( &self, id: &str, ) -> Result<Vec<ConnectorRequest>, Error>

pub async fn get_incomming_requests( &self, req: &GetRequestsRequest<'_>, ) -> Result<Vec<ConnectorRequest>, Error>

pub async fn can_accept( &self, request_id: &str, req: &DecideRequest, ) -> Result<ConnectorRequestValidationResult, Error>

pub async fn can_reject( &self, request_id: &str, req: &DecideRequest, ) -> Result<ConnectorRequestValidationResult, Error>

pub async fn accept( &self, request_id: &str, req: &DecideRequest, ) -> Result<ConnectorRequest, Error>

pub async fn reject( &self, request_id: &str, req: &DecideRequest, ) -> Result<ConnectorRequest, Error>

impl<'a> ConnectorClient<'a>

All endpoints related to managing messages.

pub async fn get_messages( &self, attribute_query: &GetMessagesRequest, ) -> Result<Vec<ConnectorMessage<Value>>, Error>

pub async fn send_message<'i, T: Serialize + DeserializeOwned>( &self, send_message: &SendMessageRequest<'i, T>, ) -> Result<ConnectorMessage<T>, Error>

pub async fn get_message<T: DeserializeOwned>( &self, id: &str, ) -> Result<ConnectorMessageWithAttachments<T>, Error>

pub async fn get_attachment( &self, message_id: &str, attachment_id: &str, ) -> Result<ConnectorFile, Error>

pub async fn get_attachment_data( &self, message_id: &str, attachment_id: &str, ) -> Result<Vec<u8>, Error>

impl ConnectorClient<'_>

All endpoints related to monotoring the connector status.

pub async fn check_health(&self) -> Result<ConnectorHealth, Error>

pub async fn check_version(&self) -> Result<ConnectorVersionInfo, Error>

pub async fn check_request_stats(&self) -> Result<ConnectorRequestCount, Error>

pub async fn get_support(&self) -> Result<ConnectorSupport, Error>

impl<'a> ConnectorClient<'a>

All endpoints related to creating and managing outgoing requests.

pub async fn can_create_request( &self, req: &CanCreateOutgoingRequestRequest, ) -> Result<ConnectorRequestValidationResult, Error>

pub async fn create_request( &self, req: &CreateOutgoingRequestRequest, ) -> Result<ConnectorRequest, Error>

pub async fn get_request(&self, req_id: &str) -> Result<ConnectorRequest, Error>

pub async fn get_requests( &self, req: &GetRequestsRequest<'_>, ) -> Result<ConnectorRequest, Error>

impl<'a> ConnectorClient<'a>

pub async fn get_relationship_templates( &self, request_params: Option<GetRelationshipTemplatesRequest<'_>>, ) -> Result<Vec<ConnectorRelationshipTemplate<Value>>, Error>

pub async fn get_own_relationship_templates( &self, request_params: Option<GetTemplatesRequest<'_>>, ) -> Result<Vec<ConnectorRelationshipTemplate<Value>>, Error>

pub async fn get_peer_relationship_templates( &self, request_params: Option<GetTemplatesRequest<'_>>, ) -> Result<Vec<ConnectorRelationshipTemplate<Value>>, Error>

pub async fn get_relationship_template_by_id<T: DeserializeOwned>( &self, id: &str, ) -> Result<ConnectorRelationshipTemplate<T>, Error>

pub async fn create_own_relationship_template<T: Serialize + DeserializeOwned>( &self, template: &CreateOwnRelationshipTemplateRequest<'_, T>, ) -> Result<ConnectorRelationshipTemplate<T>, Error>

pub async fn get_qr_code_for_relationship_template( &self, id: &str, ) -> Result<Vec<u8>, Error>

pub async fn create_token_for_own_relationship_template( &self, id: &str, req: Option<CreateTokenForOwnRelationshipTemplateRequest>, ) -> Result<ConnectorToken<FileToken>, Error>

impl<'a> ConnectorClient<'a>

pub async fn create_relationship<T: Serialize + DeserializeOwned>( &self, req: CreateRelationshipRequest<'_, T>, ) -> Result<ConnectorRelationship<T, Value>, Error>

pub async fn get_relationship<T: DeserializeOwned>( &self, id: &str, ) -> Result<ConnectorRelationship<T, Value>, Error>

pub async fn get_relationships( &self, req: GetRelationshipsRequest<'_>, ) -> Result<Vec<ConnectorRelationship<Value, Value>>, Error>

pub async fn accept_relationship_change<C: Serialize>( &self, rel_id: &str, change_id: &str, req: &DecideRelationshipChangeRequest<C>, ) -> Result<Vec<ConnectorRelationship<Value, Value>>, Error>

pub async fn reject_relationship_change<C: Serialize>( &self, rel_id: &str, change_id: &str, req: &DecideRelationshipChangeRequest<C>, ) -> Result<Vec<ConnectorRelationship<Value, Value>>, Error>