@apostra/sdk 0.38.0 → 0.40.0

package/dist/generated/metadata.d.ts

@@ -1,7 +1,21 @@
-export declare const version = "0.38.0";
+export declare const version = "0.40.0";
 export declare const baseUrl = "https://api.apostra.com/api/v3";
 export declare const m2mTokenUrl = "https://identity.scope3.com/oauth2/token";
 export declare const operations: {
+    readonly confirm_payment_authority: {
+        readonly path: "/tools/confirm_payment_authority";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: true;
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:write"];
+        }];
+        readonly summary: "Issue the hosted card-capture link for a token from request_payment_authority. Give the link to the cardholder; cards stay off MCP.";
+    };
     readonly downloadV3PublicDocumentRevision: {
         readonly path: "/documents/{documentId}/revisions/{revisionId}/download";
         readonly method: "GET";
@@ -164,7 +178,22 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:read"];
         }];
-        readonly summary: "Current account, state, blockers, exact fixes, and reachable accounts. For seller demand, use it to tell whether readiness stops requests before source calls; read before diagnosing source health, empty responses, or demand.";
+        readonly summary: "Current account, state, blockers, exact fixes, and reachable accounts. For seller demand, use it to tell whether readiness stops requests before source calls; read before diagnosing source health, empty responses, or demand. A Developer account adds each agent's stage, blocker, and next call.";
+    };
+    readonly log_event: {
+        readonly path: "/tools/log_event";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: true;
+        readonly bodyKeyField: "idempotencyKey";
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:write"];
+        }];
+        readonly summary: "Send up to 10,000 AdCP conversion events (log_event) to an event source the advertiser registered with save_event_source. Events must also pass the v2 rules: no raw email or phone in user_match, each event_type + event_id once per call. One invalid event refuses the whole call.";
     };
     readonly open_advertisers_page: {
         readonly path: "/tools/open_advertisers_page";
@@ -180,6 +209,20 @@ export declare const operations: {
         }];
         readonly summary: "Open the Advertisers Page: every advertiser with its campaign and draft counts and one next action each. Use it for \"show my advertisers\" or \"where do I start\"; the Page self-fetches. To add or set up an advertiser, pass intent: \"add\". For a text answer use search(kind: \"advertiser\").";
     };
+    readonly open_agent_certification_page: {
+        readonly path: "/tools/open_agent_certification_page";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: false;
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:read"];
+        }];
+        readonly summary: "Open one agent’s Test & certify Page: live certification per use case, recent test runs, AdCP 4.0 readiness and capability declarations. Read-only.";
+    };
     readonly open_agent_page: {
         readonly path: "/tools/open_agent_page";
         readonly method: "POST";
@@ -190,10 +233,38 @@ export declare const operations: {
         readonly security: readonly [{
             readonly apiKeyAuth: readonly [];
         }, {
-            readonly m2mOAuth: readonly ["interchange:admin"];
+            readonly m2mOAuth: readonly ["interchange:read"];
         }];
         readonly summary: "Open one agent owned by this Developer account.";
     };
+    readonly open_agent_sources_page: {
+        readonly path: "/tools/open_agent_sources_page";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: false;
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:read"];
+        }];
+        readonly summary: "Open one agent’s Inventory sources Page: the inventory sources it powers and the health of each. Read-only.";
+    };
+    readonly open_agent_webhooks_page: {
+        readonly path: "/tools/open_agent_webhooks_page";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: false;
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:read"];
+        }];
+        readonly summary: "Open one agent’s Webhooks Page: its recent inbound webhook outcomes, each refusal with its reason. Read-only.";
+    };
     readonly open_agents_page: {
         readonly path: "/tools/open_agents_page";
         readonly method: "POST";
@@ -204,7 +275,7 @@ export declare const operations: {
         readonly security: readonly [{
             readonly apiKeyAuth: readonly [];
         }, {
-            readonly m2mOAuth: readonly ["interchange:admin"];
+            readonly m2mOAuth: readonly ["interchange:read"];
         }];
         readonly summary: "Open Build an agent for this Developer account.";
     };
@@ -262,7 +333,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:read"];
         }];
-        readonly summary: "Open the buyer Media Partners Page. Optionally scope to an advertiser or seller; connectionAction \"connect\" opens that media partner at connection setup without mutating until the user confirms.";
+        readonly summary: "Open the buyer Media Partners Page. Optionally scope to an advertiser or seller; connectionAction \"connect\" opens that media partner at connection setup without mutating until the user confirms. Replaced by open_media_partners_page, which opens the same Page.";
     };
     readonly open_creative_engines_page: {
         readonly path: "/tools/open_creative_engines_page";
@@ -292,6 +363,20 @@ export declare const operations: {
         }];
         readonly summary: "Open Creative Library. Use search for a plain object answer. Composer needs campaignId; assembly needs no Creative Engine. To save a draft, use exactly one format: a canonical format such as image, hosted video, or hosted audio, or a seller format.";
     };
+    readonly open_developer_home: {
+        readonly path: "/tools/open_developer_home";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: false;
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:read"];
+        }];
+        readonly summary: "Open the Developer home for this Developer account: its agents, their stages and what to do next.";
+    };
     readonly open_media_buys_page: {
         readonly path: "/tools/open_media_buys_page";
         readonly method: "POST";
@@ -304,7 +389,21 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:read"];
         }];
-        readonly summary: "Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches.";
+        readonly summary: "Open the Seller Media Buys Page. Optionally focus one account relationship or seller account mapping (not both) and its buys or creatives; the Page self-fetches.";
+    };
+    readonly open_media_partners_page: {
+        readonly path: "/tools/open_media_partners_page";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: false;
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:read"];
+        }];
+        readonly summary: "Open the buyer Media Partners Page. Optionally scope to an advertiser or seller; connectionAction \"connect\" opens that media partner at connection setup without mutating until the user confirms.";
     };
     readonly open_page: {
         readonly path: "/tools/open_page";
@@ -318,7 +417,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:read"];
         }];
-        readonly summary: "Open a compatibility Page. source_diagnostics can create or attach the Agent. External hosts may return text. Credentials and authority changes remain human ceremonies.";
+        readonly summary: "Open a compatibility Page. Owners create or attach the Agent in source_diagnostics. External hosts may return text. Credentials and authority changes remain human ceremonies.";
     };
     readonly open_proposal_pass: {
         readonly path: "/tools/open_proposal_pass";
@@ -374,7 +473,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy.";
+        readonly summary: "Rechecks one external sales-agent source with no-spend get_products and, if it publishes one, a catalog refresh. Returns each check, findings still open, evidence IDs and readiness; no source configuration or media buy.";
     };
     readonly request_buyer_child_account: {
         readonly path: "/tools/request_buyer_child_account";
@@ -391,6 +490,20 @@ export declare const operations: {
         }];
         readonly summary: "Request a Buyer child under the selected Organization. Nothing is created until an Organization administrator approves it on our site; the result is approval_required with a link to show the person. Repeat with the same idempotencyKey and name for the outcome.";
     };
+    readonly request_payment_authority: {
+        readonly path: "/tools/request_payment_authority";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: true;
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:write"];
+        }];
+        readonly summary: "Stage a card handoff for the organization and return a confirmation token. No link is issued until confirm_payment_authority.";
+    };
     readonly request_proposals: {
         readonly path: "/tools/request_proposals";
         readonly method: "POST";
@@ -404,7 +517,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Request quotes/products. With a MediaBuy cap, only quotes confirming the exact cap are usable. sellerIds fail closed; campaign-only lists use eligible subset. Broadcast needs confirmBroadcast:true.";
+        readonly summary: "Request quotes/products. With a MediaBuy cap, only quotes confirming the exact cap are usable. sellerIds and sellerAccountIds fail closed; campaign-only lists use eligible subset. Broadcast needs confirmBroadcast:true.";
     };
     readonly request_seller_reporting_update: {
         readonly path: "/tools/request_seller_reporting_update";
@@ -446,7 +559,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:admin"];
         }];
-        readonly summary: "Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes.";
+        readonly summary: "Create a child Account (omit id), rename one, or archive or restore it (isArchived). Each is recorded for website approval by an Organization administrator; repeat with the same idempotencyKey for the outcome. dryRun previews. settings.company saves at once. Never changes owners or members.";
     };
     readonly save_advertiser: {
         readonly path: "/tools/save_advertiser";
@@ -462,20 +575,6 @@ export declare const operations: {
         }];
         readonly summary: "Save an advertiser or mappings. Buyer privateNotes: owning Buyer Account only; /v3/manage-ads#private-advertiser-notes. Confirm markets/channels (footprintProposal); needs_input=ask; never recreate for currency. Brand: identityContract:confirmed-v1; preview: resolveBrand; read advertiser.brandRef.";
     };
-    readonly save_advertiser_access: {
-        readonly path: "/tools/save_advertiser_access";
-        readonly method: "POST";
-        readonly body: true;
-        readonly binary: false;
-        readonly idempotencyKey: true;
-        readonly parameters: readonly [];
-        readonly security: readonly [{
-            readonly apiKeyAuth: readonly [];
-        }, {
-            readonly m2mOAuth: readonly ["interchange:admin"];
-        }];
-        readonly summary: "Invite a client to one of your advertisers, approve, suspend, reactivate, or revoke a client, or change a client's role. Read get kind advertiser_access first and use only what it offers. Needs an organization administrator signed in directly.";
-    };
     readonly save_advertiser_grant: {
         readonly path: "/tools/save_advertiser_grant";
         readonly method: "POST";
@@ -516,7 +615,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Save a Sales Agent mode, register an Agent, or update an owned Agent: rename it or say it is ready for certification. Select seller_save, developer_create, or developer_update.";
+        readonly summary: "Confirm a Sales Agent product mode, register a Sales or Creative Agent, or update an owned Agent: rename it or allow certification buys. To connect from a URL, send agentUrl with dryRun: true, show what was read, then send it without dryRun. A connected agent is not yet verified as theirs.";
     };
     readonly save_ask: {
         readonly path: "/tools/save_ask";
@@ -558,7 +657,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:read"];
         }];
-        readonly summary: "Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP.";
+        readonly summary: "Accept Terms, set the payment terms sellers are asked for, or accept a plan, answer its offer and change its renewal. Accepting a plan needs an administrator to approve it on our site. Cards stay off MCP.";
     };
     readonly save_business_rules: {
         readonly path: "/tools/save_business_rules";
@@ -586,7 +685,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:admin"];
         }];
-        readonly summary: "Create or manage one buyer agent.";
+        readonly summary: "Create a buyer agent, or with id make one change: name, advertiser access, lifecycle state, or credential handoff.";
     };
     readonly save_buyer_operator: {
         readonly path: "/tools/save_buyer_operator";
@@ -615,7 +714,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Save a campaign. To create, send advertiserId and name; flight and budget are optional. Split inventory into media buys. Set desiredPhase: active to launch; omit confirmLaunch to preview. Cancellation is irreversible: desiredPhase: canceled cancels the campaign and every live media buy.";
+        readonly summary: "Create: advertiserId/name; flight/budget optional. Receipts and launch previews show local/UTC times in the applicable IANA timezone. desiredPhase: active previews; confirmLaunch: true launches. Cancellation is irreversible: desiredPhase: canceled cancels the campaign and every live media buy.";
     };
     readonly save_catalog: {
         readonly path: "/tools/save_catalog";
@@ -672,7 +771,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Save creative in advertiserId/campaignId with name, message, assets, clickUrl, social, sourceAssetRef/sourceAssets. Use exactly one format selector: formatKind/formatParams, creativeFormatId, formatOptionRef. Supplied content/assets only; generate new media (radio spots) via save_creative_session.";
+        readonly summary: "advertiserId/campaignId:name,message;assets/landing_page_url/social/sourceAssetRef/sourceAssets;Supplied content/assets only;generate new media (radio spots):save_creative_session;exactly one format selector:formatKind/formatParams,creativeFormatId/formatOptionRef;libraryRole:Buyer Account only.";
     };
     readonly save_creative_collection: {
         readonly path: "/tools/save_creative_collection";
@@ -700,7 +799,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId.";
+        readonly summary: "Save a Creative Session for image, video, or voice/audio (including radio spots) from a brief: its draft, selected output, approval, or finalisation. It never generates; generate_variants does. To save an approved output to the Library, use save_creative with fromCreativeSessionOutput.";
     };
     readonly save_dimension: {
         readonly path: "/tools/save_dimension";
@@ -758,7 +857,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Create or update where a seller's inventory comes from. Pass `id` to change an existing source, omit it to add one. Credentials are never passed here — a source that needs a secret comes back with the state and the page that collects it.";
+        readonly summary: "Create or update where a seller's inventory comes from. Pass `id` to change a source or omit it to add one. Pass only `agentId` or `adServer` to open the form that connects an agent or an ad server. Credentials are never passed here; a source that needs one returns the page that collects it.";
     };
     readonly save_lesson: {
         readonly path: "/tools/save_lesson";
@@ -772,7 +871,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Manage seller lessons. propose requires lesson; approve and retire require lessonId; preview requires lessonId and brief. Preserve seller words from a private Session note and ask if kind or scope is unclear.";
+        readonly summary: "Manage seller lessons in a seller account; send the accountId of that account. propose requires lesson; approve and retire require lessonId; preview requires lessonId and brief. Preserve seller words from a private Session note and ask if kind or scope is unclear.";
     };
     readonly save_library_request: {
         readonly path: "/tools/save_library_request";
@@ -800,7 +899,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Register, revise, archive, restore, or reprocess seller Materials; manage candidate decisions and receipts; mark a slide, page, or sheet reusable only when it has no commercial figures (UNIT_NOT_REUSABLE_KIND rejects document containers, UNIT_CONTAINS_PRICING rejects priced units).";
+        readonly summary: "Create or update seller Materials. Seller beta: preview, delete, Undo deletion, or Include again for one imported Library document. Delete archives it, excludes its source until Include again, and purges it after 30 days. https://docs.apostra.com/v3/delete-from-apostra";
     };
     readonly save_media_buy: {
         readonly path: "/tools/save_media_buy";
@@ -857,7 +956,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Write how the seller sells. `active` creates and activates a new version in one step — no separate activate; the response names the version created and replaced. `pricing` replaces the whole fact list. `discounts` sets or removes brand/operator rules one by one. Halves never roll back each other.";
+        readonly summary: "Write selling guidance. `active` turns Playbook prose and its optional seller note into proposed Lessons; the active Playbook is unchanged. `pricing` replaces facts. `discounts` sets or removes brand/operator rules. Halves never roll back each other.";
     };
     readonly save_property_list: {
         readonly path: "/tools/save_property_list";
@@ -879,13 +978,29 @@ export declare const operations: {
         readonly body: true;
         readonly binary: false;
         readonly idempotencyKey: true;
+        readonly bodyKeyField: "clientRequestId";
+        readonly parameters: readonly [];
+        readonly security: readonly [{
+            readonly apiKeyAuth: readonly [];
+        }, {
+            readonly m2mOAuth: readonly ["interchange:write"];
+        }];
+        readonly summary: "Save an RFP: create it from an origin, revise it with a new request, endorse or unendorse its response, or attach an imported response. A turn’s feedback, release, proposal files and outcome use save_rfp_turn.";
+    };
+    readonly save_rfp_turn: {
+        readonly path: "/tools/save_rfp_turn";
+        readonly method: "POST";
+        readonly body: true;
+        readonly binary: false;
+        readonly idempotencyKey: true;
+        readonly bodyKeyField: "clientRequestId";
         readonly parameters: readonly [];
         readonly security: readonly [{
             readonly apiKeyAuth: readonly [];
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests.";
+        readonly summary: "Change one RFP turn: release it, request or cancel a proposal file, append feedback, or record its outcome. One of these per call; revise, endorse and attach a response with save_rfp.";
     };
     readonly save_seller: {
         readonly path: "/tools/save_seller";
@@ -899,7 +1014,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Save Seller identity, capabilities, Apostra listing, buyer-visible listing (mediaKit is a deprecated alias), Distribution's OpenAI challenge token, or a seller-controlled admission. Scope3 eligibility and Market Maker entitlements are read-only here. Read Distribution with get(kind:\"distribution\").";
+        readonly summary: "Save Seller identity, capabilities, Apostra listing, buyer-visible listing (mediaKit is a deprecated alias), Distribution's OpenAI challenge token, an admission, or the intake hold. Scope3 eligibility and Market Maker entitlements are read-only here. Read Distribution with get(kind:\"distribution\").";
     };
     readonly save_signal: {
         readonly path: "/tools/save_signal";