@apostra/sdk 0.37.0 → 0.38.0

package/dist/generated/metadata.d.ts

@@ -1,4 +1,4 @@
-export declare const version = "0.37.0";
+export declare const version = "0.38.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: {
@@ -36,7 +36,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Generate or refine new image, hosted video, or voice/audio (radio spots, voiceovers) from a saved Creative Engines brief. Reuse actionKey for an identical retry.";
+        readonly summary: "Generate variants from a saved brief; use Creative Sessions for voice/audio, radio spots, and voiceovers. Send kind, scope, and variantAction; reuse actionKey only on retries.";
     };
     readonly get: {
         readonly path: "/tools/get";
@@ -50,7 +50,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:read"];
         }];
-        readonly summary: "Read one object by kind plus the id that search returned, or an account singleton with no id. Never guess an id. include adds detail; each include value works only for the kinds that serve it.";
+        readonly summary: "Read one object by kind and id, or an account singleton without id. Never guess ids. Campaign reads return targetingOverlay to verify before proposals. include adds detail only for kinds that serve it.";
     };
     readonly getV3PublicDocumentRevisionSections: {
         readonly path: "/documents/{documentId}/revisions/{revisionId}/sections";
@@ -460,7 +460,21 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Save an advertiser or its mappings. Confirm markets/channels with the buyer first (see footprintProposal). `needs_input` = ask the buyer; never recreate to change currency. Use identityContract:confirmed-v1 for brand fixes. resolveBrand looks up public branding. Guide: /v2/setup/v3/identity-setup.";
+        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";
@@ -488,7 +502,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Save seller notes and instructions for an exact brand-domain × operator-domain pair. Configuration does not verify the registry; discounts, source routing, sponsored access, and buyer-account trust are read-only.";
+        readonly summary: "Seller-only CRM notes for an exact brand × operator pair. Buyers use save_advertiser.privateNotes; see /v3/manage-ads#private-advertiser-notes. Effective discounts, routing, access and trust are read-only.";
     };
     readonly save_agent: {
         readonly path: "/tools/save_agent";
@@ -502,7 +516,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "In a Developer account, register a Sales or Creative Agent, or rename an owned Agent. A registration requires an account administrator and an idempotency key. In a Seller account, confirm or correct one Sales Agent product mode.";
+        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 save_ask: {
         readonly path: "/tools/save_ask";
@@ -572,7 +586,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:admin"];
         }];
-        readonly summary: "Create, rename, reconcile access, change lifecycle, or prepare a human credential handoff for one buyer agent per call.";
+        readonly summary: "Create or manage one buyer agent.";
     };
     readonly save_buyer_operator: {
         readonly path: "/tools/save_buyer_operator";
@@ -601,7 +615,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Save a campaign. Create needs advertiserId and name; flight and budget are optional. Split inventory choices into separate media buys; presets expand dimensions. To launch, set desiredPhase: active with confirmLaunch: true; omit confirmation to preview. Cancellation never cancels media buys.";
+        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 save_catalog: {
         readonly path: "/tools/save_catalog";
@@ -616,7 +630,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Create or replace one flat catalog declaration by catalogId, or archive it with isArchived. URL saves refetch the feed.";
+        readonly summary: "Create or replace a catalog: type and exactly one of url (feed URL) or non-empty items are required. If missing, ask the buyer for the feed URL or items before calling. URL saves refetch the feed. To archive, set isArchived: true with identity only; type, url and items are not needed.";
     };
     readonly save_connection: {
         readonly path: "/tools/save_connection";
@@ -694,6 +708,7 @@ export declare const operations: {
         readonly body: true;
         readonly binary: false;
         readonly idempotencyKey: true;
+        readonly bodyKeyField: "idempotencyKey";
         readonly parameters: readonly [];
         readonly security: readonly [{
             readonly apiKeyAuth: readonly [];
@@ -714,7 +729,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Subscribe to a connected seller's directed campaigns, mirroring its media buys into this buyer's view. Set `unsubscribe: true` to remove the subscription and retire mirrored campaigns. Requires a mapped seller account and reachable advertiser.";
+        readonly summary: "Import native campaigns from Spotify Ads Manager or other platforms, including future-start campaigns, as read-only mirrors. Confirm ongoing sync first. No provider changes. /v3/import-existing-campaigns.";
     };
     readonly save_event_source: {
         readonly path: "/tools/save_event_source";
@@ -745,6 +760,20 @@ export declare const operations: {
         }];
         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 save_lesson: {
+        readonly path: "/tools/save_lesson";
+        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: "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 save_library_request: {
         readonly path: "/tools/save_library_request";
         readonly method: "POST";
@@ -814,7 +843,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Create or update a notification subscription: scope, content, routes; no trigger type is creatable yet, no delivery policy yet. Omit subscriptionId to create, supply it to patch. Managed subscriptions are editable only within their mutability. Credentials belong to save_integration.";
+        readonly summary: "Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed.";
     };
     readonly save_playbook: {
         readonly path: "/tools/save_playbook";
@@ -842,7 +871,7 @@ export declare const operations: {
         }, {
             readonly m2mOAuth: readonly ["interchange:write"];
         }];
-        readonly summary: "Create, update, archive, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.";
+        readonly summary: "Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.";
     };
     readonly save_rfp: {
         readonly path: "/tools/save_rfp";

package/dist/generated/metadata.js

@@ -1,5 +1,5 @@
 // Generated. Do not edit.
-export const version = '0.37.0';
+export const version = '0.38.0';
 export const baseUrl = "https://api.apostra.com/api/v3";
 export const m2mTokenUrl = "https://identity.scope3.com/oauth2/token";
 export const operations = {
@@ -50,7 +50,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Generate or refine new image, hosted video, or voice/audio (radio spots, voiceovers) from a saved Creative Engines brief. Reuse actionKey for an identical retry."
+        "summary": "Generate variants from a saved brief; use Creative Sessions for voice/audio, radio spots, and voiceovers. Send kind, scope, and variantAction; reuse actionKey only on retries."
     },
     "get": {
         "path": "/tools/get",
@@ -69,7 +69,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Read one object by kind plus the id that search returned, or an account singleton with no id. Never guess an id. include adds detail; each include value works only for the kinds that serve it."
+        "summary": "Read one object by kind and id, or an account singleton without id. Never guess ids. Campaign reads return targetingOverlay to verify before proposals. include adds detail only for kinds that serve it."
     },
     "getV3PublicDocumentRevisionSections": {
         "path": "/documents/{documentId}/revisions/{revisionId}/sections",
@@ -626,7 +626,26 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Save an advertiser or its mappings. Confirm markets/channels with the buyer first (see footprintProposal). `needs_input` = ask the buyer; never recreate to change currency. Use identityContract:confirmed-v1 for brand fixes. resolveBrand looks up public branding. Guide: /v2/setup/v3/identity-setup."
+        "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",
@@ -664,7 +683,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Save seller notes and instructions for an exact brand-domain × operator-domain pair. Configuration does not verify the registry; discounts, source routing, sponsored access, and buyer-account trust are read-only."
+        "summary": "Seller-only CRM notes for an exact brand × operator pair. Buyers use save_advertiser.privateNotes; see /v3/manage-ads#private-advertiser-notes. Effective discounts, routing, access and trust are read-only."
     },
     "save_agent": {
         "path": "/tools/save_agent",
@@ -683,7 +702,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "In a Developer account, register a Sales or Creative Agent, or rename an owned Agent. A registration requires an account administrator and an idempotency key. In a Seller account, confirm or correct one Sales Agent product mode."
+        "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."
     },
     "save_ask": {
         "path": "/tools/save_ask",
@@ -778,7 +797,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Create, rename, reconcile access, change lifecycle, or prepare a human credential handoff for one buyer agent per call."
+        "summary": "Create or manage one buyer agent."
     },
     "save_buyer_operator": {
         "path": "/tools/save_buyer_operator",
@@ -817,7 +836,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Save a campaign. Create needs advertiserId and name; flight and budget are optional. Split inventory choices into separate media buys; presets expand dimensions. To launch, set desiredPhase: active with confirmLaunch: true; omit confirmation to preview. Cancellation never cancels media buys."
+        "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."
     },
     "save_catalog": {
         "path": "/tools/save_catalog",
@@ -837,7 +856,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Create or replace one flat catalog declaration by catalogId, or archive it with isArchived. URL saves refetch the feed."
+        "summary": "Create or replace a catalog: type and exactly one of url (feed URL) or non-empty items are required. If missing, ask the buyer for the feed URL or items before calling. URL saves refetch the feed. To archive, set isArchived: true with identity only; type, url and items are not needed."
     },
     "save_connection": {
         "path": "/tools/save_connection",
@@ -940,6 +959,7 @@ export const operations = {
         "body": true,
         "binary": false,
         "idempotencyKey": true,
+        "bodyKeyField": "idempotencyKey",
         "parameters": [],
         "security": [
             {
@@ -970,7 +990,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Subscribe to a connected seller's directed campaigns, mirroring its media buys into this buyer's view. Set `unsubscribe: true` to remove the subscription and retire mirrored campaigns. Requires a mapped seller account and reachable advertiser."
+        "summary": "Import native campaigns from Spotify Ads Manager or other platforms, including future-start campaigns, as read-only mirrors. Confirm ongoing sync first. No provider changes. /v3/import-existing-campaigns."
     },
     "save_event_source": {
         "path": "/tools/save_event_source",
@@ -1011,6 +1031,25 @@ 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."
     },
+    "save_lesson": {
+        "path": "/tools/save_lesson",
+        "method": "POST",
+        "body": true,
+        "binary": false,
+        "idempotencyKey": true,
+        "parameters": [],
+        "security": [
+            {
+                "apiKeyAuth": []
+            },
+            {
+                "m2mOAuth": [
+                    "interchange:write"
+                ]
+            }
+        ],
+        "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."
+    },
     "save_library_request": {
         "path": "/tools/save_library_request",
         "method": "POST",
@@ -1105,7 +1144,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Create or update a notification subscription: scope, content, routes; no trigger type is creatable yet, no delivery policy yet. Omit subscriptionId to create, supply it to patch. Managed subscriptions are editable only within their mutability. Credentials belong to save_integration."
+        "summary": "Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed."
     },
     "save_playbook": {
         "path": "/tools/save_playbook",
@@ -1143,7 +1182,7 @@ export const operations = {
                 ]
             }
         ],
-        "summary": "Create, update, archive, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists."
+        "summary": "Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists."
     },
     "save_rfp": {
         "path": "/tools/save_rfp",