@apostra/sdk 0.37.0 → 0.38.0

package/dist/generated/client.d.ts

@@ -1,5 +1,6 @@
 import type * as Wire from './types.gen.js';
 import { Transport, type RequestOptions, type ResponseDetails, type WriteRequestOptions } from '../transport.js';
+type OptionalWireField<T, K extends PropertyKey> = T extends unknown ? Omit<T, K> & Partial<Pick<T, Extract<K, keyof T>>> : never;
 export type DownloadV3PublicDocumentRevisionInput = {
     "documentId": NonNullable<Wire.DownloadV3PublicDocumentRevisionData['path']>["documentId"];
     "revisionId": NonNullable<Wire.DownloadV3PublicDocumentRevisionData['path']>["revisionId"];
@@ -84,10 +85,10 @@ export type OpenVariantGalleryError = Wire.OpenVariantGalleryErrors[keyof Wire.O
 export type RefreshInventorySourceHealthInput = Wire.RefreshInventorySourceHealthData['body'];
 export type RefreshInventorySourceHealthResult = Wire.RefreshInventorySourceHealthResponses[200]['data'];
 export type RefreshInventorySourceHealthError = Wire.RefreshInventorySourceHealthErrors[keyof Wire.RefreshInventorySourceHealthErrors];
-export type RequestBuyerChildAccountInput = Omit<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey"> & Partial<Pick<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey">>;
+export type RequestBuyerChildAccountInput = OptionalWireField<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey">;
 export type RequestBuyerChildAccountResult = Wire.RequestBuyerChildAccountResponses[200]['data'];
 export type RequestBuyerChildAccountError = Wire.RequestBuyerChildAccountErrors[keyof Wire.RequestBuyerChildAccountErrors];
-export type RequestProposalsInput = Omit<Wire.RequestProposalsData['body'], "idempotencyKey"> & Partial<Pick<Wire.RequestProposalsData['body'], "idempotencyKey">>;
+export type RequestProposalsInput = OptionalWireField<Wire.RequestProposalsData['body'], "idempotencyKey">;
 export type RequestProposalsResult = Wire.RequestProposalsResponses[200]['data'];
 export type RequestProposalsError = Wire.RequestProposalsErrors[keyof Wire.RequestProposalsErrors];
 export type RequestSellerReportingUpdateInput = Wire.RequestSellerReportingUpdateData['body'];
@@ -102,6 +103,9 @@ export type SaveAccountError = Wire.SaveAccountErrors[keyof Wire.SaveAccountErro
 export type SaveAdvertiserInput = Wire.SaveAdvertiserData['body'];
 export type SaveAdvertiserResult = Wire.SaveAdvertiserResponses[200]['data'];
 export type SaveAdvertiserError = Wire.SaveAdvertiserErrors[keyof Wire.SaveAdvertiserErrors];
+export type SaveAdvertiserAccessInput = Wire.SaveAdvertiserAccessData['body'];
+export type SaveAdvertiserAccessResult = Wire.SaveAdvertiserAccessResponses[200]['data'];
+export type SaveAdvertiserAccessError = Wire.SaveAdvertiserAccessErrors[keyof Wire.SaveAdvertiserAccessErrors];
 export type SaveAdvertiserGrantInput = Wire.SaveAdvertiserGrantData['body'];
 export type SaveAdvertiserGrantResult = Wire.SaveAdvertiserGrantResponses[200]['data'];
 export type SaveAdvertiserGrantError = Wire.SaveAdvertiserGrantErrors[keyof Wire.SaveAdvertiserGrantErrors];
@@ -129,10 +133,10 @@ export type SaveBuyerAgentError = Wire.SaveBuyerAgentErrors[keyof Wire.SaveBuyer
 export type SaveBuyerOperatorInput = Wire.SaveBuyerOperatorData['body'];
 export type SaveBuyerOperatorResult = Wire.SaveBuyerOperatorResponses[200]['data'];
 export type SaveBuyerOperatorError = Wire.SaveBuyerOperatorErrors[keyof Wire.SaveBuyerOperatorErrors];
-export type SaveCampaignInput = Omit<Wire.SaveCampaignData['body'], "idempotencyKey"> & Partial<Pick<Wire.SaveCampaignData['body'], "idempotencyKey">>;
+export type SaveCampaignInput = OptionalWireField<Wire.SaveCampaignData['body'], "idempotencyKey">;
 export type SaveCampaignResult = Wire.SaveCampaignResponses[200]['data'];
 export type SaveCampaignError = Wire.SaveCampaignErrors[keyof Wire.SaveCampaignErrors];
-export type SaveCatalogInput = Omit<Wire.SaveCatalogData['body'], "idempotencyKey"> & Partial<Pick<Wire.SaveCatalogData['body'], "idempotencyKey">>;
+export type SaveCatalogInput = OptionalWireField<Wire.SaveCatalogData['body'], "idempotencyKey">;
 export type SaveCatalogResult = Wire.SaveCatalogResponses[200]['data'];
 export type SaveCatalogError = Wire.SaveCatalogErrors[keyof Wire.SaveCatalogErrors];
 export type SaveConnectionInput = Wire.SaveConnectionData['body'];
@@ -150,25 +154,28 @@ export type SaveCreativeCollectionError = Wire.SaveCreativeCollectionErrors[keyo
 export type SaveCreativeSessionInput = Wire.SaveCreativeSessionData['body'];
 export type SaveCreativeSessionResult = Wire.SaveCreativeSessionResponses[200]['data'];
 export type SaveCreativeSessionError = Wire.SaveCreativeSessionErrors[keyof Wire.SaveCreativeSessionErrors];
-export type SaveDimensionInput = Wire.SaveDimensionData['body'];
+export type SaveDimensionInput = OptionalWireField<Wire.SaveDimensionData['body'], "idempotencyKey">;
 export type SaveDimensionResult = Wire.SaveDimensionResponses[200]['data'];
 export type SaveDimensionError = Wire.SaveDimensionErrors[keyof Wire.SaveDimensionErrors];
 export type SaveDirectedCampaignSubscriptionInput = Wire.SaveDirectedCampaignSubscriptionData['body'];
 export type SaveDirectedCampaignSubscriptionResult = Wire.SaveDirectedCampaignSubscriptionResponses[200]['data'];
 export type SaveDirectedCampaignSubscriptionError = Wire.SaveDirectedCampaignSubscriptionErrors[keyof Wire.SaveDirectedCampaignSubscriptionErrors];
-export type SaveEventSourceInput = Omit<Wire.SaveEventSourceData['body'], "idempotencyKey"> & Partial<Pick<Wire.SaveEventSourceData['body'], "idempotencyKey">>;
+export type SaveEventSourceInput = OptionalWireField<Wire.SaveEventSourceData['body'], "idempotencyKey">;
 export type SaveEventSourceResult = Wire.SaveEventSourceResponses[200]['data'];
 export type SaveEventSourceError = Wire.SaveEventSourceErrors[keyof Wire.SaveEventSourceErrors];
 export type SaveInventorySourceInput = Wire.SaveInventorySourceData['body'];
 export type SaveInventorySourceResult = Wire.SaveInventorySourceResponses[200]['data'];
 export type SaveInventorySourceError = Wire.SaveInventorySourceErrors[keyof Wire.SaveInventorySourceErrors];
+export type SaveLessonInput = Wire.SaveLessonData['body'];
+export type SaveLessonResult = Wire.SaveLessonResponses[200]['data'];
+export type SaveLessonError = Wire.SaveLessonErrors[keyof Wire.SaveLessonErrors];
 export type SaveLibraryRequestInput = Wire.SaveLibraryRequestData['body'];
 export type SaveLibraryRequestResult = Wire.SaveLibraryRequestResponses[200]['data'];
 export type SaveLibraryRequestError = Wire.SaveLibraryRequestErrors[keyof Wire.SaveLibraryRequestErrors];
 export type SaveMaterialInput = Wire.SaveMaterialData['body'];
 export type SaveMaterialResult = Wire.SaveMaterialResponses[200]['data'];
 export type SaveMaterialError = Wire.SaveMaterialErrors[keyof Wire.SaveMaterialErrors];
-export type SaveMediaBuyInput = Omit<Wire.SaveMediaBuyData['body'], "idempotencyKey"> & Partial<Pick<Wire.SaveMediaBuyData['body'], "idempotencyKey">>;
+export type SaveMediaBuyInput = OptionalWireField<Wire.SaveMediaBuyData['body'], "idempotencyKey">;
 export type SaveMediaBuyResult = Wire.SaveMediaBuyResponses[200]['data'];
 export type SaveMediaBuyError = Wire.SaveMediaBuyErrors[keyof Wire.SaveMediaBuyErrors];
 export type SaveMediaKitInput = Wire.SaveMediaKitData['body'];
@@ -328,6 +335,10 @@ export interface OperationTypes {
         input: SaveAdvertiserInput;
         result: SaveAdvertiserResult;
     };
+    "save_advertiser_access": {
+        input: SaveAdvertiserAccessInput;
+        result: SaveAdvertiserAccessResult;
+    };
     "save_advertiser_grant": {
         input: SaveAdvertiserGrantInput;
         result: SaveAdvertiserGrantResult;
@@ -408,6 +419,10 @@ export interface OperationTypes {
         input: SaveInventorySourceInput;
         result: SaveInventorySourceResult;
     };
+    "save_lesson": {
+        input: SaveLessonInput;
+        result: SaveLessonResult;
+    };
     "save_library_request": {
         input: SaveLibraryRequestInput;
         result: SaveLibraryRequestResult;
@@ -480,22 +495,22 @@ export declare class Apostra extends Transport {
     /** Download a public immutable document revision Returns the data together with response headers and request ID. */
     downloadV3PublicDocumentRevisionWithResponse(input: DownloadV3PublicDocumentRevisionInput, options?: RequestOptions): Promise<ResponseDetails<DownloadV3PublicDocumentRevisionResult>>;
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.generateVariants(input, { idempotencyKey: 'stable-key' })
      */
     generateVariants(input: GenerateVariantsInput, options: WriteRequestOptions): Promise<GenerateVariantsResult>;
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     generateVariantsWithResponse(input: GenerateVariantsInput, options: WriteRequestOptions): Promise<ResponseDetails<GenerateVariantsResult>>;
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.get(input)
      */
     get(input: GetInput, options?: RequestOptions): Promise<GetResult>;
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     getWithResponse(input: GetInput, options?: RequestOptions): Promise<ResponseDetails<GetResult>>;
     /**
      * Read a bounded public immutable document revision
@@ -732,14 +747,23 @@ export declare class Apostra extends Transport {
     /** Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes. Returns the data together with response headers and request ID. */
     saveAccountWithResponse(input: SaveAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAccountResult>>;
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveAdvertiser(input, { idempotencyKey: 'stable-key' })
      */
     saveAdvertiser(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<SaveAdvertiserResult>;
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveAdvertiserWithResponse(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserResult>>;
+    /**
+     * 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.
+     *
+     * @example
+     * await client.saveAdvertiserAccess(input, { idempotencyKey: 'stable-key' })
+     */
+    saveAdvertiserAccess(input: SaveAdvertiserAccessInput, options: WriteRequestOptions): Promise<SaveAdvertiserAccessResult>;
+    /** 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. Returns the data together with response headers and request ID. */
+    saveAdvertiserAccessWithResponse(input: SaveAdvertiserAccessInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserAccessResult>>;
     /**
      * Invite another Organization to exact advertisers, accept/reject an invitation, or revoke a grant. Limited beta: eligible Organization, entitlement, server-side exposure, and direct human-admin authority are required.
      *
@@ -750,22 +774,22 @@ export declare class Apostra extends Transport {
     /** Invite another Organization to exact advertisers, accept/reject an invitation, or revoke a grant. Limited beta: eligible Organization, entitlement, server-side exposure, and direct human-admin authority are required. Returns the data together with response headers and request ID. */
     saveAdvertiserGrantWithResponse(input: SaveAdvertiserGrantInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserGrantResult>>;
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveAdvertiserInstructions(input, { idempotencyKey: 'stable-key' })
      */
     saveAdvertiserInstructions(input: SaveAdvertiserInstructionsInput, options: WriteRequestOptions): Promise<SaveAdvertiserInstructionsResult>;
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveAdvertiserInstructionsWithResponse(input: SaveAdvertiserInstructionsInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserInstructionsResult>>;
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveAgent(input, { idempotencyKey: 'stable-key' })
      */
     saveAgent(input: SaveAgentInput, options: WriteRequestOptions): Promise<SaveAgentResult>;
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveAgentWithResponse(input: SaveAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAgentResult>>;
     /**
      * File or update a typed ask in the Apostra Support workflow; returns askId. Supply is buyer inventory. Call immediately with type support when a person explicitly asks for a human; do not diagnose first.
@@ -804,13 +828,13 @@ export declare class Apostra extends Transport {
     /** Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview. Returns the data together with response headers and request ID. */
     saveBusinessRulesWithResponse(input: SaveBusinessRulesInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBusinessRulesResult>>;
     /**
-     * Create, rename, reconcile access, change lifecycle, or prepare a human credential handoff for one buyer agent per call.
+     * Create or manage one buyer agent.
      *
      * @example
      * await client.saveBuyerAgent(input, { idempotencyKey: 'stable-key' })
      */
     saveBuyerAgent(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<SaveBuyerAgentResult>;
-    /** Create, rename, reconcile access, change lifecycle, or prepare a human credential handoff for one buyer agent per call. Returns the data together with response headers and request ID. */
+    /** Create or manage one buyer agent. Returns the data together with response headers and request ID. */
     saveBuyerAgentWithResponse(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerAgentResult>>;
     /**
      * Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup.
@@ -822,22 +846,22 @@ export declare class Apostra extends Transport {
     /** Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup. Returns the data together with response headers and request ID. */
     saveBuyerOperatorWithResponse(input: SaveBuyerOperatorInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerOperatorResult>>;
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveCampaign(input, { idempotencyKey: 'stable-key' })
      */
     saveCampaign(input: SaveCampaignInput, options: WriteRequestOptions): Promise<SaveCampaignResult>;
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveCampaignWithResponse(input: SaveCampaignInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCampaignResult>>;
     /**
-     * Create or replace one flat catalog declaration by catalogId, or archive it with isArchived. URL saves refetch the feed.
+     * 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.
      *
      * @example
      * await client.saveCatalog(input, { idempotencyKey: 'stable-key' })
      */
     saveCatalog(input: SaveCatalogInput, options: WriteRequestOptions): Promise<SaveCatalogResult>;
-    /** Create or replace one flat catalog declaration by catalogId, or archive it with isArchived. URL saves refetch the feed. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveCatalogWithResponse(input: SaveCatalogInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCatalogResult>>;
     /**
      * Manage seller or creative-engine authorization, accounts and advertiser mappings. Seller-only: reporting, selection, billing, policy, activation.
@@ -894,13 +918,13 @@ export declare class Apostra extends Transport {
     /** Create a dimension, or update an existing dimension by its id. Tags is built in and open. Labels belong only to objects in appliesTo. Returns the data together with response headers and request ID. */
     saveDimensionWithResponse(input: SaveDimensionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveDimensionResult>>;
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveDirectedCampaignSubscription(input, { idempotencyKey: 'stable-key' })
      */
     saveDirectedCampaignSubscription(input: SaveDirectedCampaignSubscriptionInput, options: WriteRequestOptions): Promise<SaveDirectedCampaignSubscriptionResult>;
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveDirectedCampaignSubscriptionWithResponse(input: SaveDirectedCampaignSubscriptionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveDirectedCampaignSubscriptionResult>>;
     /**
      * Create, change, archive, or restore up to 50 advertiser conversion event sources (pixels, server feeds). Each entry is keyed by eventSourceId and succeeds or fails alone. Setup is not proof events flow: check health with get, then use eventSourceId in an optimization goal.
@@ -920,6 +944,15 @@ export declare class Apostra extends Transport {
     saveInventorySource(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<SaveInventorySourceResult>;
     /** 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. Returns the data together with response headers and request ID. */
     saveInventorySourceWithResponse(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveInventorySourceResult>>;
+    /**
+     * 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.
+     *
+     * @example
+     * await client.saveLesson(input, { idempotencyKey: 'stable-key' })
+     */
+    saveLesson(input: SaveLessonInput, options: WriteRequestOptions): Promise<SaveLessonResult>;
+    /** 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. Returns the data together with response headers and request ID. */
+    saveLessonWithResponse(input: SaveLessonInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLessonResult>>;
     /**
      * Open a seller library request or close it with seller Material.
      *
@@ -957,13 +990,13 @@ export declare class Apostra extends Transport {
     /** Deprecated compatibility tool ("listing" is the modern term). It writes only the legacy businessProfile and does not update the canonical buyer-visible listing. New clients must read with `get({ kind: "seller", include: ["listing"] })` and write with `save_seller`. Returns the data together with response headers and request ID. */
     saveMediaKitWithResponse(input: SaveMediaKitInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveMediaKitResult>>;
     /**
-     * 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.
+     * Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed.
      *
      * @example
      * await client.saveNotificationConfig(input, { idempotencyKey: 'stable-key' })
      */
     saveNotificationConfig(input: SaveNotificationConfigInput, options: WriteRequestOptions): Promise<SaveNotificationConfigResult>;
-    /** 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. Returns the data together with response headers and request ID. */
+    /** Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed. Returns the data together with response headers and request ID. */
     saveNotificationConfigWithResponse(input: SaveNotificationConfigInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveNotificationConfigResult>>;
     /**
      * 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.
@@ -975,13 +1008,13 @@ export declare class Apostra extends Transport {
     /** 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. Returns the data together with response headers and request ID. */
     savePlaybookWithResponse(input: SavePlaybookInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePlaybookResult>>;
     /**
-     * Create, update, archive, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
+     * Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
      *
      * @example
      * await client.savePropertyList(input, { idempotencyKey: 'stable-key' })
      */
     savePropertyList(input: SavePropertyListInput, options: WriteRequestOptions): Promise<SavePropertyListResult>;
-    /** Create, update, archive, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists. Returns the data together with response headers and request ID. */
+    /** Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists. Returns the data together with response headers and request ID. */
     savePropertyListWithResponse(input: SavePropertyListInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePropertyListResult>>;
     /**
      * Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests.
@@ -1056,3 +1089,4 @@ export declare class Apostra extends Transport {
     /** Open the embedded Task for an advertiser. Returns accepted MIME types and exact byte limits by type. max_size_bytes is only the largest. Use fallback_url if the Task does not render. Uploading never creates or delivers a Creative. Returns the data together with response headers and request ID. */
     uploadCreativeAssetWithResponse(input: UploadCreativeAssetInput, options: WriteRequestOptions): Promise<ResponseDetails<UploadCreativeAssetResult>>;
 }
+export {};

package/dist/generated/client.js

@@ -10,22 +10,22 @@ export class Apostra extends Transport {
     /** Download a public immutable document revision Returns the data together with response headers and request ID. */
     downloadV3PublicDocumentRevisionWithResponse(input, options) { return this.requestDetailed("downloadV3PublicDocumentRevision", input, options); }
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.generateVariants(input, { idempotencyKey: 'stable-key' })
      */
     generateVariants(input, options) { return this.request("generate_variants", input, options); }
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     generateVariantsWithResponse(input, options) { return this.requestDetailed("generate_variants", input, options); }
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.get(input)
      */
     get(input, options) { return this.request("get", input, options); }
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     getWithResponse(input, options) { return this.requestDetailed("get", input, options); }
     /**
      * Read a bounded public immutable document revision
@@ -262,14 +262,23 @@ export class Apostra extends Transport {
     /** Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes. Returns the data together with response headers and request ID. */
     saveAccountWithResponse(input, options) { return this.requestDetailed("save_account", input, options); }
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveAdvertiser(input, { idempotencyKey: 'stable-key' })
      */
     saveAdvertiser(input, options) { return this.request("save_advertiser", input, options); }
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveAdvertiserWithResponse(input, options) { return this.requestDetailed("save_advertiser", input, options); }
+    /**
+     * 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.
+     *
+     * @example
+     * await client.saveAdvertiserAccess(input, { idempotencyKey: 'stable-key' })
+     */
+    saveAdvertiserAccess(input, options) { return this.request("save_advertiser_access", input, options); }
+    /** 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. Returns the data together with response headers and request ID. */
+    saveAdvertiserAccessWithResponse(input, options) { return this.requestDetailed("save_advertiser_access", input, options); }
     /**
      * Invite another Organization to exact advertisers, accept/reject an invitation, or revoke a grant. Limited beta: eligible Organization, entitlement, server-side exposure, and direct human-admin authority are required.
      *
@@ -280,22 +289,22 @@ export class Apostra extends Transport {
     /** Invite another Organization to exact advertisers, accept/reject an invitation, or revoke a grant. Limited beta: eligible Organization, entitlement, server-side exposure, and direct human-admin authority are required. Returns the data together with response headers and request ID. */
     saveAdvertiserGrantWithResponse(input, options) { return this.requestDetailed("save_advertiser_grant", input, options); }
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveAdvertiserInstructions(input, { idempotencyKey: 'stable-key' })
      */
     saveAdvertiserInstructions(input, options) { return this.request("save_advertiser_instructions", input, options); }
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveAdvertiserInstructionsWithResponse(input, options) { return this.requestDetailed("save_advertiser_instructions", input, options); }
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveAgent(input, { idempotencyKey: 'stable-key' })
      */
     saveAgent(input, options) { return this.request("save_agent", input, options); }
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveAgentWithResponse(input, options) { return this.requestDetailed("save_agent", input, options); }
     /**
      * File or update a typed ask in the Apostra Support workflow; returns askId. Supply is buyer inventory. Call immediately with type support when a person explicitly asks for a human; do not diagnose first.
@@ -334,13 +343,13 @@ export class Apostra extends Transport {
     /** Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview. Returns the data together with response headers and request ID. */
     saveBusinessRulesWithResponse(input, options) { return this.requestDetailed("save_business_rules", input, options); }
     /**
-     * Create, rename, reconcile access, change lifecycle, or prepare a human credential handoff for one buyer agent per call.
+     * Create or manage one buyer agent.
      *
      * @example
      * await client.saveBuyerAgent(input, { idempotencyKey: 'stable-key' })
      */
     saveBuyerAgent(input, options) { return this.request("save_buyer_agent", input, options); }
-    /** Create, rename, reconcile access, change lifecycle, or prepare a human credential handoff for one buyer agent per call. Returns the data together with response headers and request ID. */
+    /** Create or manage one buyer agent. Returns the data together with response headers and request ID. */
     saveBuyerAgentWithResponse(input, options) { return this.requestDetailed("save_buyer_agent", input, options); }
     /**
      * Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup.
@@ -352,22 +361,22 @@ export class Apostra extends Transport {
     /** Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup. Returns the data together with response headers and request ID. */
     saveBuyerOperatorWithResponse(input, options) { return this.requestDetailed("save_buyer_operator", input, options); }
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveCampaign(input, { idempotencyKey: 'stable-key' })
      */
     saveCampaign(input, options) { return this.request("save_campaign", input, options); }
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveCampaignWithResponse(input, options) { return this.requestDetailed("save_campaign", input, options); }
     /**
-     * Create or replace one flat catalog declaration by catalogId, or archive it with isArchived. URL saves refetch the feed.
+     * 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.
      *
      * @example
      * await client.saveCatalog(input, { idempotencyKey: 'stable-key' })
      */
     saveCatalog(input, options) { return this.request("save_catalog", input, options); }
-    /** Create or replace one flat catalog declaration by catalogId, or archive it with isArchived. URL saves refetch the feed. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveCatalogWithResponse(input, options) { return this.requestDetailed("save_catalog", input, options); }
     /**
      * Manage seller or creative-engine authorization, accounts and advertiser mappings. Seller-only: reporting, selection, billing, policy, activation.
@@ -424,13 +433,13 @@ export class Apostra extends Transport {
     /** Create a dimension, or update an existing dimension by its id. Tags is built in and open. Labels belong only to objects in appliesTo. Returns the data together with response headers and request ID. */
     saveDimensionWithResponse(input, options) { return this.requestDetailed("save_dimension", input, options); }
     /**
-     * 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.
+     * 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.
      *
      * @example
      * await client.saveDirectedCampaignSubscription(input, { idempotencyKey: 'stable-key' })
      */
     saveDirectedCampaignSubscription(input, options) { return this.request("save_directed_campaign_subscription", input, options); }
-    /** 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. Returns the data together with response headers and request ID. */
+    /** 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. Returns the data together with response headers and request ID. */
     saveDirectedCampaignSubscriptionWithResponse(input, options) { return this.requestDetailed("save_directed_campaign_subscription", input, options); }
     /**
      * Create, change, archive, or restore up to 50 advertiser conversion event sources (pixels, server feeds). Each entry is keyed by eventSourceId and succeeds or fails alone. Setup is not proof events flow: check health with get, then use eventSourceId in an optimization goal.
@@ -450,6 +459,15 @@ export class Apostra extends Transport {
     saveInventorySource(input, options) { return this.request("save_inventory_source", input, options); }
     /** 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. Returns the data together with response headers and request ID. */
     saveInventorySourceWithResponse(input, options) { return this.requestDetailed("save_inventory_source", input, options); }
+    /**
+     * 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.
+     *
+     * @example
+     * await client.saveLesson(input, { idempotencyKey: 'stable-key' })
+     */
+    saveLesson(input, options) { return this.request("save_lesson", input, options); }
+    /** 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. Returns the data together with response headers and request ID. */
+    saveLessonWithResponse(input, options) { return this.requestDetailed("save_lesson", input, options); }
     /**
      * Open a seller library request or close it with seller Material.
      *
@@ -487,13 +505,13 @@ export class Apostra extends Transport {
     /** Deprecated compatibility tool ("listing" is the modern term). It writes only the legacy businessProfile and does not update the canonical buyer-visible listing. New clients must read with `get({ kind: "seller", include: ["listing"] })` and write with `save_seller`. Returns the data together with response headers and request ID. */
     saveMediaKitWithResponse(input, options) { return this.requestDetailed("save_media_kit", input, options); }
     /**
-     * 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.
+     * Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed.
      *
      * @example
      * await client.saveNotificationConfig(input, { idempotencyKey: 'stable-key' })
      */
     saveNotificationConfig(input, options) { return this.request("save_notification_config", input, options); }
-    /** 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. Returns the data together with response headers and request ID. */
+    /** Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed. Returns the data together with response headers and request ID. */
     saveNotificationConfigWithResponse(input, options) { return this.requestDetailed("save_notification_config", input, options); }
     /**
      * 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.
@@ -505,13 +523,13 @@ export class Apostra extends Transport {
     /** 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. Returns the data together with response headers and request ID. */
     savePlaybookWithResponse(input, options) { return this.requestDetailed("save_playbook", input, options); }
     /**
-     * Create, update, archive, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
+     * Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
      *
      * @example
      * await client.savePropertyList(input, { idempotencyKey: 'stable-key' })
      */
     savePropertyList(input, options) { return this.request("save_property_list", input, options); }
-    /** Create, update, archive, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists. Returns the data together with response headers and request ID. */
+    /** Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists. Returns the data together with response headers and request ID. */
     savePropertyListWithResponse(input, options) { return this.requestDetailed("save_property_list", input, options); }
     /**
      * Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests.