Struct CloudAgentPython

pub struct CloudAgentPython {
    pub endpoint: String,
    pub api_key: Option<String>,
    pub auth_token: Option<String>,
    pub version: CloudAgentPythonVersion,
}

Cloudagent Python Agent

Fields

endpoint: String

base url of the cloudagent

api_key: Option<String>

admin Api key for the cloudagent

auth_token: Option<String>

Authorization token for a multi tenancy agent

version: CloudAgentPythonVersion

Agent version

Implementations

impl CloudAgentPython

Call logic for http calls

pub async fn get<T: DeserializeOwned + Debug>( &self, url: Url, query: Option<Vec<(&str, String)>>, ) -> Result<T>

Builds a get request and calls the sender

Errors

When it could not fulfill a GET request

pub async fn patch<T: DeserializeOwned + Debug>( &self, url: Url, query: Option<Vec<(&str, String)>>, ) -> Result<T>

Builds a patch request and calls the sender

Errors

When it could not fulfill a PATCH request

pub async fn post<T: DeserializeOwned + Debug>( &self, url: Url, query: Option<Vec<(&str, String)>>, body: Option<Value>, ) -> Result<T>

Builds a post request and calls the sender

Errors

When it could not fulfill a POST request

pub async fn send<T: DeserializeOwned + Debug>( &self, client: RequestBuilder, ) -> Result<T>

Sends any request

Errors

When it could not fulfill the given request

impl CloudAgentPython

pub const fn new( endpoint: String, version: CloudAgentPythonVersion, api_key: Option<String>, auth_token: Option<String>, ) -> Self

Create a new instance of an aries cloudagent python

pub fn create_url(&self, paths: &[&str]) -> Result<Url>

Create a url based on the base url and a list of paths

Errors

When the url could not be constructed

Trait Implementations

impl BasicMessageModule for CloudAgentPython

fn send_message<'life0, 'async_trait>( &'life0 self, options: SendBasicMessageOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a basic message to another agent via the connection id

impl ConnectionModule for CloudAgentPython

fn get_all<'life0, 'async_trait>( &'life0 self, options: ConnectionGetAllOptions, ) -> Pin<Box<dyn Future<Output = Result<Vec<Connection>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets all the connections

fn get_by_id<'life0, 'async_trait>( &'life0 self, id: String, ) -> Pin<Box<dyn Future<Output = Result<Connection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a connection by id

fn create_invitation<'life0, 'async_trait>( &'life0 self, options: ConnectionCreateInvitationOptions, ) -> Pin<Box<dyn Future<Output = Result<Invitation>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create an invitation

fn receive_invitation<'life0, 'async_trait>( &'life0 self, invitation: ConnectionReceiveInvitationOptions, ) -> Pin<Box<dyn Future<Output = Result<Connection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Receive and accept a connection

impl CredentialDefinitionModule for CloudAgentPython

fn create<'life0, 'async_trait>( &'life0 self, options: CredentialDefinitionCreateOptions, ) -> Pin<Box<dyn Future<Output = Result<CredentialDefinitionCreateResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Register a credential definition on the ledger

fn get_by_id<'life0, 'async_trait>( &'life0 self, id: String, ) -> Pin<Box<dyn Future<Output = Result<CredentialDefinition>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the registered credential definition by id

fn get_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CredentialDefinitionGetAllResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get all the registered credential definitions

impl CredentialModule for CloudAgentPython

fn send_offer<'life0, 'async_trait>( &'life0 self, options: CredentialOfferOptions, ) -> Pin<Box<dyn Future<Output = Result<CredentialOfferResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a credential offer to the connection id supplied in the options

impl Debug for CloudAgentPython

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

Formats the value using the given formatter.

impl FeatureModule for CloudAgentPython

fn discover_features<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DiscoverFeaturesResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Requests all the features from the cloudagent

impl MultitenancyModule for CloudAgentPython

fn create<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<MultitenancyCreateResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

TODO: this only returns the wallet id for now

fn remove<'life0, 'async_trait>( &'life0 self, wallet_id: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove a subwallet

impl OobModule for CloudAgentPython

fn create_invitation<'life0, 'async_trait>( &'life0 self, options: OobConnectionCreateInvitationOptions, ) -> Pin<Box<dyn Future<Output = Result<OobConnectionCreateInvitationResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create an oob invitation

fn receive_invitation<'life0, 'async_trait>( &'life0 self, invitation: OobConnectionReceiveInvitationOptions, ) -> Pin<Box<dyn Future<Output = Result<OobConnection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Receive and accept an oob connection

impl ProofModule for CloudAgentPython

fn send_request<'life0, 'async_trait>( &'life0 self, options: ProofRequestOptions, ) -> Pin<Box<dyn Future<Output = Result<ProofRequestResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a proof request via the connection id to another agent

impl SchemaModule for CloudAgentPython

fn create<'life0, 'async_trait>( &'life0 self, options: SchemaCreateOptions, ) -> Pin<Box<dyn Future<Output = Result<Schema>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a schema on the ledger

fn get_by_id<'life0, 'async_trait>( &'life0 self, id: String, ) -> Pin<Box<dyn Future<Output = Result<Schema>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request the schema by the id

fn get_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SchemasGetAllResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get all the registerd schemas

impl WalletModule for CloudAgentPython

fn get_wallet_dids<'life0, 'async_trait>( &'life0 self, options: Did, ) -> Pin<Box<dyn Future<Output = Result<DidList>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Query a wallet for DIDs

fn create_local_did<'life0, 'async_trait>( &'life0 self, options: CreateLocalDidOptions, ) -> Pin<Box<dyn Future<Output = Result<Did>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a local DID

fn rotate_keypair<'life0, 'async_trait>( &'life0 self, did: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Rotate key pair

fn fetch_public_did<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Did>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch public did

fn assign_public_did<'life0, 'async_trait>( &'life0 self, did: String, ) -> Pin<Box<dyn Future<Output = Result<Did>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Assign the current public DID

fn fetch_did_endpoint<'life0, 'async_trait>( &'life0 self, did: String, ) -> Pin<Box<dyn Future<Output = Result<DidEndpoint>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Query DID endpoint of wallet

fn set_did_endpoint<'life0, 'async_trait>( &'life0 self, options: SetDidEndpointOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set DID endpoint of wallet

impl WebhookModule for CloudAgentPython

fn listen<'life0, 'async_trait>( &'life0 self, on_event: fn(Value), ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Listen to all incoming webhook