Skip to content

storefront-guide.md

Latest commit

 

History

History
172 lines (117 loc) · 2.82 KB

storefront-guide.md

File metadata and controls

172 lines (117 loc) · 2.82 KB

Storefront Persona Guide

The storefront persona enables you to manage your storefront, inventory sources (agent registration), billing, readiness, and notifications on the Scope3 Agentic Platform.

Setup

import { Scope3Client } from 'scope3';

const client = new Scope3Client({
  apiKey: process.env.SCOPE3_API_KEY!,
  persona: 'storefront',
});

Storefront

Manage your storefront.

Get Storefront

const sf = await client.storefront.get();

Create Storefront

const sf = await client.storefront.create({
  platformId: 'my-platform',
  name: 'My Storefront',
});

Update Storefront

await client.storefront.update({
  name: 'Updated Name',
});

Delete Storefront

await client.storefront.delete();

Inventory Sources

Register and manage inventory sources (agents).

List Inventory Sources

const sources = await client.inventorySources.list();

Get an Inventory Source

const source = await client.inventorySources.get('source-123');

Create an Inventory Source

const source = await client.inventorySources.create({
  sourceId: 'my-sales-agent',
  name: 'My Sales Agent',
  executionType: 'agent',
  type: 'SALES',
  endpointUrl: 'https://my-agent.example.com/mcp',
  protocol: 'MCP',
  authenticationType: 'API_KEY',
  auth: { type: 'bearer', token: 'my-api-key' },
});

Update an Inventory Source

await client.inventorySources.update('source-123', {
  name: 'Updated Source Name',
});

Delete an Inventory Source

await client.inventorySources.delete('source-123');

Agents

List and manage agents (read-only discovery).

List Agents

const agents = await client.agents.list();

Get an Agent

const agent = await client.agents.get('agent-123');

Readiness

Check your storefront's readiness status.

const readiness = await client.readiness.check();

Billing

Manage Stripe Connect billing integration.

Get Billing Info

const billing = await client.billing.get();

Connect Stripe

const connect = await client.billing.connect();

Check Billing Status

const status = await client.billing.status();

Get Onboarding URL

const url = await client.billing.onboardingUrl();

Notifications

View and manage notifications.

List Notifications

const notifications = await client.notifications.list();

Mark as Read

await client.notifications.markAsRead('notification-123');

Acknowledge

await client.notifications.acknowledge('notification-123');

Mark All as Read

await client.notifications.markAllAsRead();