@apostra/sdk 0.38.0 → 0.39.0

package/dist/generated/metadata.js

@@ -1,8 +1,27 @@
 // Generated. Do not edit.
-export const version = '0.38.0';
+export const version = '0.39.0';
 export const baseUrl = "https://api.apostra.com/api/v3";
 export const m2mTokenUrl = "https://identity.scope3.com/oauth2/token";
 export const operations = {
+    "confirm_payment_authority": {
+        "path": "/tools/confirm_payment_authority",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": true,
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:write"
+                ]
+            }
+        ],
+        "summary": "Issue the hosted card-capture link for a token from request_payment_authority. Give the link to the cardholder; cards stay off MCP."
+    },
     "downloadV3PublicDocumentRevision": {
         "path": "/documents/{documentId}/revisions/{revisionId}/download",
         "method": "GET",
@@ -225,7 +244,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "open_advertisers_page": {
         "path": "/tools/open_advertisers_page",
@@ -246,6 +265,25 @@ export const operations = {
         ],
         "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\")."
     },
+    "open_agent_certification_page": {
+        "path": "/tools/open_agent_certification_page",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": false,
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:read"
+                ]
+            }
+        ],
+        "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."
+    },
     "open_agent_page": {
         "path": "/tools/open_agent_page",
         "method": "POST",
@@ -259,12 +297,50 @@ export const operations = {
             },
             {
                 "m2mOAuth": [
-                    "interchange:admin"
+                    "interchange:read"
                 ]
             }
         ],
         "summary": "Open one agent owned by this Developer account."
     },
+    "open_agent_sources_page": {
+        "path": "/tools/open_agent_sources_page",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": false,
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:read"
+                ]
+            }
+        ],
+        "summary": "Open one agent’s Inventory sources Page: the inventory sources it powers and the health of each. Read-only."
+    },
+    "open_agent_webhooks_page": {
+        "path": "/tools/open_agent_webhooks_page",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": false,
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:read"
+                ]
+            }
+        ],
+        "summary": "Open one agent’s Webhooks Page: its recent inbound webhook outcomes, each refusal with its reason. Read-only."
+    },
     "open_agents_page": {
         "path": "/tools/open_agents_page",
         "method": "POST",
@@ -278,7 +354,7 @@ export const operations = {
             },
             {
                 "m2mOAuth": [
-                    "interchange:admin"
+                    "interchange:read"
                 ]
             }
         ],
@@ -358,7 +434,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "open_creative_engines_page": {
         "path": "/tools/open_creative_engines_page",
@@ -398,6 +474,25 @@ export const operations = {
         ],
         "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."
     },
+    "open_developer_home": {
+        "path": "/tools/open_developer_home",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": false,
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:read"
+                ]
+            }
+        ],
+        "summary": "Open the Developer home for this Developer account: its agents, their stages and what to do next."
+    },
     "open_media_buys_page": {
         "path": "/tools/open_media_buys_page",
         "method": "POST",
@@ -415,7 +510,26 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches."
+        "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."
+    },
+    "open_media_partners_page": {
+        "path": "/tools/open_media_partners_page",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": false,
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:read"
+                ]
+            }
+        ],
+        "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."
     },
     "open_page": {
         "path": "/tools/open_page",
@@ -434,7 +548,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "open_proposal_pass": {
         "path": "/tools/open_proposal_pass",
@@ -510,7 +624,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy."
+        "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."
     },
     "request_buyer_child_account": {
         "path": "/tools/request_buyer_child_account",
@@ -532,6 +646,25 @@ export const operations = {
         ],
         "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."
     },
+    "request_payment_authority": {
+        "path": "/tools/request_payment_authority",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": true,
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:write"
+                ]
+            }
+        ],
+        "summary": "Stage a card handoff for the organization and return a confirmation token. No link is issued until confirm_payment_authority."
+    },
     "request_proposals": {
         "path": "/tools/request_proposals",
         "method": "POST",
@@ -550,7 +683,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "request_seller_reporting_update": {
         "path": "/tools/request_seller_reporting_update",
@@ -607,7 +740,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "save_advertiser": {
         "path": "/tools/save_advertiser",
@@ -628,25 +761,6 @@ export const operations = {
         ],
         "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."
     },
-    "save_advertiser_access": {
-        "path": "/tools/save_advertiser_access",
-        "method": "POST",
-        "body": true,
-        "binary": false,
-        "idempotencyKey": true,
-        "parameters": [],
-        "security": [
-            {
-                "apiKeyAuth": []
-            },
-            {
-                "m2mOAuth": [
-                    "interchange:admin"
-                ]
-            }
-        ],
-        "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."
-    },
     "save_advertiser_grant": {
         "path": "/tools/save_advertiser_grant",
         "method": "POST",
@@ -702,7 +816,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "save_ask": {
         "path": "/tools/save_ask",
@@ -759,7 +873,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP."
+        "summary": "Accept Terms, set the payment terms sellers are asked for, or accept a plan, answer its offer and change its renewal. Cards stay off MCP."
     },
     "save_business_rules": {
         "path": "/tools/save_business_rules",
@@ -797,7 +911,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Create or manage one buyer agent."
+        "summary": "Create a buyer agent, or with id make one change: name, advertiser access, lifecycle state, or credential handoff."
     },
     "save_buyer_operator": {
         "path": "/tools/save_buyer_operator",
@@ -836,7 +950,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "save_catalog": {
         "path": "/tools/save_catalog",
@@ -913,7 +1027,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "save_creative_collection": {
         "path": "/tools/save_creative_collection",
@@ -951,7 +1065,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId."
+        "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."
     },
     "save_dimension": {
         "path": "/tools/save_dimension",
@@ -1029,7 +1143,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "save_lesson": {
         "path": "/tools/save_lesson",
@@ -1048,7 +1162,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "summary": "Manage seller lessons in a seller account context; use switch_account first. 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."
     },
     "save_library_request": {
         "path": "/tools/save_library_request",
@@ -1086,7 +1200,7 @@ export const operations = {
                 ]
             }
         ],
-        "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)."
+        "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"
     },
     "save_media_buy": {
         "path": "/tools/save_media_buy",
@@ -1163,7 +1277,7 @@ export const operations = {
                 ]
             }
         ],
-        "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."
+        "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."
     },
     "save_property_list": {
         "path": "/tools/save_property_list",
@@ -1190,6 +1304,27 @@ export const operations = {
         "body": true,
         "binary": false,
         "idempotencyKey": true,
+        "bodyKeyField": "clientRequestId",
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:write"
+                ]
+            }
+        ],
+        "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."
+    },
+    "save_rfp_turn": {
+        "path": "/tools/save_rfp_turn",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": true,
+        "bodyKeyField": "clientRequestId",
         "parameters": [],
         "security": [
             {
@@ -1201,7 +1336,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests."
+        "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."
     },
     "save_seller": {
         "path": "/tools/save_seller",
@@ -1220,7 +1355,7 @@ export const operations = {
                 ]
             }
         ],
-        "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\")."
+        "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\")."
     },
     "save_signal": {
         "path": "/tools/save_signal",