Skip to content

Latest commit

 

History

History
151 lines (105 loc) · 7.71 KB

File metadata and controls

151 lines (105 loc) · 7.71 KB

@scope3/agentic-client

2.1.0

Minor Changes

  • #120 dcda3ca Thanks @bokelley! - Add scope3 login and scope3 logout commands for browser-based OAuth authentication via WorkOS. Credentials are saved to ~/.scope3/config.json and used automatically for subsequent API calls.

2.0.0

Major Changes

  • #114 7110b25 Thanks @EmmaLouise2018! - Persona-based API architecture for Agentic Platform v2

    Complete rebuild of the Scope3 SDK with persona-based design for the Agentic Platform v2 API.

    New Features:

    • Unified Scope3Client with persona parameter: buyer or partner
    • Full CLI with scope3 command for all API operations
    • REST and MCP adapter support
    • Buyer resources: advertisers, campaigns (discovery/performance/audience), bundles, signals, reporting, sales agents, conversion events, creative sets
    • Partner resources: partners, agents (with OAuth flows)

    CLI Highlights:

    • scope3 config set apiKey <key> - persistent configuration
    • scope3 commands - list all available commands by persona
    • Table, JSON, and YAML output formats
    • Environment support: production and staging

    Breaking Changes:

    • Removed Scope3AgenticClient - use Scope3Client with persona parameter
    • Removed brand persona - brands are now integrated into advertisers via brandDomain
    • Campaign type bundle renamed to discovery
    • Reporting moved from advertiser sub-resource to top-level client.reporting
    • Removed auto-generated types from OpenAPI (now manually maintained)
    • Auth uses Authorization: Bearer header (was x-scope3-api-key)
    • Response envelope: { data, pagination, error } (was flat)
    • MCP uses single api_call tool (was per-resource tools)

    Migration Guide:

    // Before (v1):
    import { Scope3AgenticClient } from 'scope3';
    const client = new Scope3AgenticClient({ apiKey: '...' });
    
    // After (v2):
    import { Scope3Client } from 'scope3';
    
    // For buyers (advertisers, campaigns, bundles):
    const buyerClient = new Scope3Client({ apiKey: '...', persona: 'buyer' });
    
    // For partners (agent registration, OAuth):
    const partnerClient = new Scope3Client({ apiKey: '...', persona: 'partner' });

1.1.0

Minor Changes

  • #18 c9e0c5b Thanks @nastassiafulconis! - Add dynamic CLI tool for Scope3 Agentic API with automatic command generation

    The CLI now dynamically discovers available API operations from the MCP server, ensuring commands are always up-to-date with the latest API capabilities:

    • Zero maintenance: Commands auto-generate from MCP server's tool list
    • Always in sync: CLI automatically reflects API changes without code updates
    • 80+ commands: Covers all resources (agents, campaigns, creatives, tactics, media buys, etc.)
    • Smart caching: 24-hour tool cache with fallback for offline use
    • Type-safe parameters: Automatic validation and parsing from server schemas
    • Multiple output formats: JSON and formatted table views
    • Persistent configuration: Save API keys and base URLs locally

    Usage:

    # Configure once
    scope3 config set apiKey YOUR_KEY
    
    # Commands are dynamically discovered
    scope3 list-tools  # See all available operations
    scope3 brand-agent list
    scope3 campaign create --prompt "..." --brandAgentId 123
    scope3 media-buy execute --mediaBuyId "buy_123"

    Benefits over static CLI:

    • API adds new endpoint → CLI instantly supports it (after cache refresh)
    • API changes parameter → CLI automatically updates validation
    • No manual maintenance of command definitions required

1.0.4

Patch Changes

1.0.3

Patch Changes

1.0.2

Patch Changes

1.0.1

Patch Changes

  • #8 1fe1262 Thanks @nastassiafulconis! - Update OpenAPI auto-update workflow to create PRs and fetch from agentic-api repo. Configure release workflow for npm Trusted Publishing with OIDC.

1.0.0

Major Changes

  • #6 186144c Thanks @nastassiafulconis! - Add unified agents API and remove salesAgents

    BREAKING CHANGE: Removed salesAgents resource. Use agents resource instead with type filtering.

    • Add unified agents resource supporting both SALES and OUTCOME agent types
    • Remove deprecated salesAgents resource
    • Add JWT authentication support
    • Update simple-media-agent to use new agents API
    • Update documentation to use 'Agent' instead of 'Sales Agent'
    • Add publishConfig for npm publishing
    • Update schemas from merged outcomes-agent-registration branch

    Migration guide:

    • Replace client.salesAgents.list() with client.agents.list({ type: 'SALES' })
    • Replace client.salesAgents.get() with client.agents.get()
    • Replace client.salesAgents.register() with client.agents.register({ type: 'SALES', ... })

0.2.0

Minor Changes

  • #1 5feeb69 Thanks @bokelley! - Initial release of Scope3 Agentic Client
    • Full TypeScript client for Scope3 Agentic API using MCP protocol
    • Complete API coverage for all 12 resource modules (Assets, Brand Agents, Campaigns, Creatives, etc.)
    • Official MCP SDK integration with HTTP streaming transport
    • Comprehensive type safety with auto-generated types from OpenAPI spec
    • Optional webhook server for AdCP events
    • Pre-commit hooks and CI validation
    • Automated versioning and NPM publishing with Changesets

Patch Changes

  • #5 afb58ee Thanks @nastassiafulconis! - Fix changeset check workflow to exempt release PRs

    Release PRs created by changesets/action are now properly exempted from the changeset requirement check, preventing false failures in CI.