AxUCPClient

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L36

Constructors

Constructor

TypeScript

new AxUCPClient(options: Readonly<AxUCPClientOptions>): AxUCPClient;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L46

Parameters

Parameter	Type
`options`	`Readonly`<`AxUCPClientOptions`>

Returns

AxUCPClient

Methods

call()

TypeScript

call(
   operation: string, 
   input: Readonly<AxUCPValue>, 
options: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L343

Parameters

Parameter	Type
`operation`	`string`
`input`	`Readonly`<`AxUCPValue`>
`options`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

cancelCart()

TypeScript

cancelCart(id: string, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L291

Parameters

Parameter	Type
`id`	`string`
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

cancelCheckout()

TypeScript

cancelCheckout(id: string, options: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L334

Parameters

Parameter	Type
`id`	`string`
`options`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

close()

TypeScript

close(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L247

Returns

Promise<void>

completeCheckout()

Call Signature

TypeScript

completeCheckout(id: string, options: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L314

Parameters

Parameter	Type
`id`	`string`
`options`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

Call Signature

TypeScript

completeCheckout(
   id: string, 
   completion: Readonly<AxUCPCheckoutCompletion>, 
options: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L318

Parameters

Parameter	Type
`id`	`string`
`completion`	`Readonly`<`AxUCPCheckoutCompletion`>
`options`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

createCart()

TypeScript

createCart(cart: Readonly<AxUCPCartInput>, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L272

Parameters

Parameter	Type
`cart`	`Readonly`<`AxUCPCartInput`>
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

createCheckout()

TypeScript

createCheckout(checkout: Readonly<AxUCPCheckoutInput>, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L295

Parameters

Parameter	Type
`checkout`	`Readonly`<`AxUCPCheckoutInput`>
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

getCart()

TypeScript

getCart(id: string, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L279

Parameters

Parameter	Type
`id`	`string`
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

getCheckout()

TypeScript

getCheckout(id: string, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L302

Parameters

Parameter	Type
`id`	`string`
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

getEvaluationMode()

TypeScript

getEvaluationMode(): "live" | "replay" | "sandbox";

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L128

Returns

"live" | "replay" | "sandbox"

getIdentityLinkingConfig()

TypeScript

getIdentityLinkingConfig(): 
  | undefined
  | AxUCPIdentityLinkingConfig;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L170

Returns

| undefined | AxUCPIdentityLinkingConfig

getIdentityLinkingScopes()

TypeScript

getIdentityLinkingScopes(): readonly string[];

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L179

Returns

readonly string[]

getMCPClient()

TypeScript

getMCPClient(): undefined | AxMCPClient;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L243

Returns the live MCP client used by AxGen/AxAgent native integration.

Returns

undefined | AxMCPClient

getNamespace()

TypeScript

getNamespace(): string;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L118

Returns

string

getOperationBindings()

TypeScript

getOperationBindings(): AxFunction[];

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L145

Returns

AxFunction[]

getOperationNames()

TypeScript

getOperationNames(): readonly string[];

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L132

Returns

readonly string[]

getOrder()

TypeScript

getOrder(id: string, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L339

Parameters

Parameter	Type
`id`	`string`
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

getPaymentHandlers()

TypeScript

getPaymentHandlers(): Record<string, readonly AxUCPPaymentHandler[]>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L166

Returns

Record<string, readonly AxUCPPaymentHandler[]>

getProduct()

TypeScript

getProduct(catalog: Readonly<AxUCPProductRequest>, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L265

Parameters

Parameter	Type
`catalog`	`Readonly`<`AxUCPProductRequest`>
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

getProfile()

TypeScript

getProfile(): AxUCPNegotiatedProfile;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L113

Returns

AxUCPNegotiatedProfile

init()

TypeScript

init(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L68

Returns

Promise<void>

lookupCatalog()

TypeScript

lookupCatalog(catalog: Readonly<AxUCPCatalogLookupRequest>, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L258

Parameters

Parameter	Type
`catalog`	`Readonly`<`AxUCPCatalogLookupRequest`>
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

searchCatalog()

TypeScript

searchCatalog(catalog: Readonly<AxUCPCatalogSearchRequest>, options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L251

Parameters

Parameter	Type
`catalog`	`Readonly`<`AxUCPCatalogSearchRequest`>
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

updateCart()

TypeScript

updateCart(
   id: string, 
   cart: Readonly<AxUCPCartInput>, 
options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L283

Parameters

Parameter	Type
`id`	`string`
`cart`	`Readonly`<`AxUCPCartInput`>
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

updateCheckout()

TypeScript

updateCheckout(
   id: string, 
   checkout: Readonly<AxUCPCheckoutInput>, 
options?: Readonly<AxUCPCallOptions>): Promise<AxUCPOutcome>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L306

Parameters

Parameter	Type
`id`	`string`
`checkout`	`Readonly`<`AxUCPCheckoutInput`>
`options?`	`Readonly`<`AxUCPCallOptions`>

Returns

Promise<AxUCPOutcome>

validateAgainstSchema()

TypeScript

validateAgainstSchema(value: unknown, schemaUrl: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L700

Parameters

Parameter	Type
`value`	`unknown`
`schemaUrl`	`string`

Returns

Promise<void>

verifyOrderEvent()

TypeScript

verifyOrderEvent(request: Request): Promise<AxUCPOrderEvent>;

Defined in: https://github.com/ax-llm/ax/blob/7965c876f6a5b641e0cf166e8942e540cfde65e1/src/ax/ucp/client.ts#L183

Parameters

Parameter	Type
`request`	`Request`

Returns

Promise<AxUCPOrderEvent>