Struct Client 

pub struct Client { /* private fields */ }

Client for Compose x402

Canonical contract for Compose x402 settlement, reusable Compose Keys, session state, payments, and facilitator operations.

Version: 0.8.6

Implementations

impl Client

pub fn new(baseurl: &str) -> Self

Create a new client.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

pub fn new_with_client(baseurl: &str, client: Client) -> Self

Construct a new client with an existing reqwest::Client, allowing more control over its configuration.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

impl Client

pub fn list(&self) -> List<'_>

Sends a GET request to /api/keys

let response = client.list()
    .x_chain_id(x_chain_id)
    .x_session_user_address(x_session_user_address)
    .send()
    .await;

pub fn create(&self) -> Create<'_>

Sends a POST request to /api/keys

let response = client.create()
    .x_chain_id(x_chain_id)
    .x_session_user_address(x_session_user_address)
    .body(body)
    .send()
    .await;

pub fn get(&self) -> Get<'_>

Sends a GET request to /api/keys/{keyId}

let response = client.get()
    .key_id(key_id)
    .send()
    .await;

pub fn revoke(&self) -> Revoke<'_>

Sends a DELETE request to /api/keys/{keyId}

let response = client.revoke()
    .key_id(key_id)
    .send()
    .await;

pub fn abort(&self) -> Abort<'_>

Sends a POST request to /api/payments/abort

let response = client.abort()
    .body(body)
    .send()
    .await;

pub fn model_meter(&self) -> ModelMeter<'_>

Sends a POST request to /api/payments/meter/model

let response = client.model_meter()
    .body(body)
    .send()
    .await;

pub fn prepare(&self) -> Prepare<'_>

Sends a POST request to /api/payments/prepare

let response = client.prepare()
    .x_chain_id(x_chain_id)
    .x_session_user_address(x_session_user_address)
    .x_x402_max_amount_wei(x_x402_max_amount_wei)
    .body(body)
    .send()
    .await;

pub fn settle(&self) -> Settle<'_>

Sends a POST request to /api/payments/settle

let response = client.settle()
    .body(body)
    .send()
    .await;

pub fn session_get_active(&self) -> SessionGetActive<'_>

Sends a GET request to /api/session

let response = client.session_get_active()
    .x_chain_id(x_chain_id)
    .x_session_user_address(x_session_user_address)
    .send()
    .await;

pub fn session_events_subscribe(&self) -> SessionEventsSubscribe<'_>

Sends a GET request to /api/session/events

let response = client.session_events_subscribe()
    .chain_id(chain_id)
    .user_address(user_address)
    .send()
    .await;

pub fn chains_list(&self) -> ChainsList<'_>

Sends a GET request to /api/x402/facilitator/chains

let response = client.chains_list()
    .send()
    .await;

pub fn payment_settle(&self) -> PaymentSettle<'_>

Sends a POST request to /api/x402/facilitator/settle

let response = client.payment_settle()
    .body(body)
    .send()
    .await;

pub fn supported(&self) -> Supported<'_>

Sends a GET request to /api/x402/facilitator/supported

let response = client.supported()
    .send()
    .await;

pub fn payment_verify(&self) -> PaymentVerify<'_>

Sends a POST request to /api/x402/facilitator/verify

let response = client.payment_verify()
    .body(body)
    .send()
    .await;

pub fn check(&self) -> Check<'_>

Sends a GET request to /health

let response = client.check()
    .send()
    .await;

pub fn feedback_list(&self) -> FeedbackList<'_>

Sends a GET request to /v1/feedback

let response = client.feedback_list()
    .limit(limit)
    .target_id(target_id)
    .target_type(target_type)
    .send()
    .await;

pub fn submit(&self) -> Submit<'_>

Sends a POST request to /v1/feedback

let response = client.submit()
    .x_chain_id(x_chain_id)
    .x_session_user_address(x_session_user_address)
    .body(body)
    .send()
    .await;

pub fn summary_get(&self) -> SummaryGet<'_>

Sends a GET request to /v1/feedback/summary

let response = client.summary_get()
    .recent_limit(recent_limit)
    .target_id(target_id)
    .target_type(target_type)
    .send()
    .await;

Trait Implementations

impl ClientHooks for &Client

async fn pre<E>( &self, request: &mut Request, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs prior to the execution of the request. This may be used to modify the request before it is transmitted.

async fn post<E>( &self, result: &Result<Response, Error>, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs after completion of the request.

async fn exec( &self, request: Request, info: &OperationInfo, ) -> Result<Response, Error>

Execute the request. Note that for almost any reasonable implementation this will include code equivalent to this:

impl ClientInfo<()> for Client

fn api_version() -> &'static str

Get the version of this API.

fn baseurl(&self) -> &str

Get the base URL to which requests are made.

fn client(&self) -> &Client

Get the internal reqwest::Client used to make requests.

fn inner(&self) -> &()

Get the inner value of type T if one is specified.

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.