@apostra/sdk 0.38.0 → 0.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,9 @@
1
1
  import type * as Wire from './types.gen.js';
2
2
  import { Transport, type RequestOptions, type ResponseDetails, type WriteRequestOptions } from '../transport.js';
3
3
  type OptionalWireField<T, K extends PropertyKey> = T extends unknown ? Omit<T, K> & Partial<Pick<T, Extract<K, keyof T>>> : never;
4
+ export type ConfirmPaymentAuthorityInput = Wire.ConfirmPaymentAuthorityData['body'];
5
+ export type ConfirmPaymentAuthorityResult = Wire.ConfirmPaymentAuthorityResponses[200]['data'];
6
+ export type ConfirmPaymentAuthorityError = Wire.ConfirmPaymentAuthorityErrors[keyof Wire.ConfirmPaymentAuthorityErrors];
4
7
  export type DownloadV3PublicDocumentRevisionInput = {
5
8
  "documentId": NonNullable<Wire.DownloadV3PublicDocumentRevisionData['path']>["documentId"];
6
9
  "revisionId": NonNullable<Wire.DownloadV3PublicDocumentRevisionData['path']>["revisionId"];
@@ -43,9 +46,18 @@ export type GetStatusError = Wire.GetStatusErrors[keyof Wire.GetStatusErrors];
43
46
  export type OpenAdvertisersPageInput = Wire.OpenAdvertisersPageData['body'];
44
47
  export type OpenAdvertisersPageResult = Wire.OpenAdvertisersPageResponses[200]['data'];
45
48
  export type OpenAdvertisersPageError = Wire.OpenAdvertisersPageErrors[keyof Wire.OpenAdvertisersPageErrors];
49
+ export type OpenAgentCertificationPageInput = Wire.OpenAgentCertificationPageData['body'];
50
+ export type OpenAgentCertificationPageResult = Wire.OpenAgentCertificationPageResponses[200]['data'];
51
+ export type OpenAgentCertificationPageError = Wire.OpenAgentCertificationPageErrors[keyof Wire.OpenAgentCertificationPageErrors];
46
52
  export type OpenAgentPageInput = Wire.OpenAgentPageData['body'];
47
53
  export type OpenAgentPageResult = Wire.OpenAgentPageResponses[200]['data'];
48
54
  export type OpenAgentPageError = Wire.OpenAgentPageErrors[keyof Wire.OpenAgentPageErrors];
55
+ export type OpenAgentSourcesPageInput = Wire.OpenAgentSourcesPageData['body'];
56
+ export type OpenAgentSourcesPageResult = Wire.OpenAgentSourcesPageResponses[200]['data'];
57
+ export type OpenAgentSourcesPageError = Wire.OpenAgentSourcesPageErrors[keyof Wire.OpenAgentSourcesPageErrors];
58
+ export type OpenAgentWebhooksPageInput = Wire.OpenAgentWebhooksPageData['body'];
59
+ export type OpenAgentWebhooksPageResult = Wire.OpenAgentWebhooksPageResponses[200]['data'];
60
+ export type OpenAgentWebhooksPageError = Wire.OpenAgentWebhooksPageErrors[keyof Wire.OpenAgentWebhooksPageErrors];
49
61
  export type OpenAgentsPageInput = Wire.OpenAgentsPageData['body'];
50
62
  export type OpenAgentsPageResult = Wire.OpenAgentsPageResponses[200]['data'];
51
63
  export type OpenAgentsPageError = Wire.OpenAgentsPageErrors[keyof Wire.OpenAgentsPageErrors];
@@ -67,9 +79,15 @@ export type OpenCreativeEnginesPageError = Wire.OpenCreativeEnginesPageErrors[ke
67
79
  export type OpenCreativeLibraryInput = Wire.OpenCreativeLibraryData['body'];
68
80
  export type OpenCreativeLibraryResult = Wire.OpenCreativeLibraryResponses[200]['data'];
69
81
  export type OpenCreativeLibraryError = Wire.OpenCreativeLibraryErrors[keyof Wire.OpenCreativeLibraryErrors];
82
+ export type OpenDeveloperHomeInput = Wire.OpenDeveloperHomeData['body'];
83
+ export type OpenDeveloperHomeResult = Wire.OpenDeveloperHomeResponses[200]['data'];
84
+ export type OpenDeveloperHomeError = Wire.OpenDeveloperHomeErrors[keyof Wire.OpenDeveloperHomeErrors];
70
85
  export type OpenMediaBuysPageInput = Wire.OpenMediaBuysPageData['body'];
71
86
  export type OpenMediaBuysPageResult = Wire.OpenMediaBuysPageResponses[200]['data'];
72
87
  export type OpenMediaBuysPageError = Wire.OpenMediaBuysPageErrors[keyof Wire.OpenMediaBuysPageErrors];
88
+ export type OpenMediaPartnersPageInput = Wire.OpenMediaPartnersPageData['body'];
89
+ export type OpenMediaPartnersPageResult = Wire.OpenMediaPartnersPageResponses[200]['data'];
90
+ export type OpenMediaPartnersPageError = Wire.OpenMediaPartnersPageErrors[keyof Wire.OpenMediaPartnersPageErrors];
73
91
  export type OpenPageInput = Wire.OpenPageData['body'];
74
92
  export type OpenPageResult = Wire.OpenPageResponses[200]['data'];
75
93
  export type OpenPageError = Wire.OpenPageErrors[keyof Wire.OpenPageErrors];
@@ -88,6 +106,9 @@ export type RefreshInventorySourceHealthError = Wire.RefreshInventorySourceHealt
88
106
  export type RequestBuyerChildAccountInput = OptionalWireField<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey">;
89
107
  export type RequestBuyerChildAccountResult = Wire.RequestBuyerChildAccountResponses[200]['data'];
90
108
  export type RequestBuyerChildAccountError = Wire.RequestBuyerChildAccountErrors[keyof Wire.RequestBuyerChildAccountErrors];
109
+ export type RequestPaymentAuthorityInput = Wire.RequestPaymentAuthorityData['body'];
110
+ export type RequestPaymentAuthorityResult = Wire.RequestPaymentAuthorityResponses[200]['data'];
111
+ export type RequestPaymentAuthorityError = Wire.RequestPaymentAuthorityErrors[keyof Wire.RequestPaymentAuthorityErrors];
91
112
  export type RequestProposalsInput = OptionalWireField<Wire.RequestProposalsData['body'], "idempotencyKey">;
92
113
  export type RequestProposalsResult = Wire.RequestProposalsResponses[200]['data'];
93
114
  export type RequestProposalsError = Wire.RequestProposalsErrors[keyof Wire.RequestProposalsErrors];
@@ -103,9 +124,6 @@ export type SaveAccountError = Wire.SaveAccountErrors[keyof Wire.SaveAccountErro
103
124
  export type SaveAdvertiserInput = Wire.SaveAdvertiserData['body'];
104
125
  export type SaveAdvertiserResult = Wire.SaveAdvertiserResponses[200]['data'];
105
126
  export type SaveAdvertiserError = Wire.SaveAdvertiserErrors[keyof Wire.SaveAdvertiserErrors];
106
- export type SaveAdvertiserAccessInput = Wire.SaveAdvertiserAccessData['body'];
107
- export type SaveAdvertiserAccessResult = Wire.SaveAdvertiserAccessResponses[200]['data'];
108
- export type SaveAdvertiserAccessError = Wire.SaveAdvertiserAccessErrors[keyof Wire.SaveAdvertiserAccessErrors];
109
127
  export type SaveAdvertiserGrantInput = Wire.SaveAdvertiserGrantData['body'];
110
128
  export type SaveAdvertiserGrantResult = Wire.SaveAdvertiserGrantResponses[200]['data'];
111
129
  export type SaveAdvertiserGrantError = Wire.SaveAdvertiserGrantErrors[keyof Wire.SaveAdvertiserGrantErrors];
@@ -190,9 +208,12 @@ export type SavePlaybookError = Wire.SavePlaybookErrors[keyof Wire.SavePlaybookE
190
208
  export type SavePropertyListInput = Wire.SavePropertyListData['body'];
191
209
  export type SavePropertyListResult = Wire.SavePropertyListResponses[200]['data'];
192
210
  export type SavePropertyListError = Wire.SavePropertyListErrors[keyof Wire.SavePropertyListErrors];
193
- export type SaveRfpInput = Wire.SaveRfpData['body'];
211
+ export type SaveRfpInput = OptionalWireField<Wire.SaveRfpData['body'], "clientRequestId">;
194
212
  export type SaveRfpResult = Wire.SaveRfpResponses[200]['data'];
195
213
  export type SaveRfpError = Wire.SaveRfpErrors[keyof Wire.SaveRfpErrors];
214
+ export type SaveRfpTurnInput = OptionalWireField<Wire.SaveRfpTurnData['body'], "clientRequestId">;
215
+ export type SaveRfpTurnResult = Wire.SaveRfpTurnResponses[200]['data'];
216
+ export type SaveRfpTurnError = Wire.SaveRfpTurnErrors[keyof Wire.SaveRfpTurnErrors];
196
217
  export type SaveSellerInput = Wire.SaveSellerData['body'];
197
218
  export type SaveSellerResult = Wire.SaveSellerResponses[200]['data'];
198
219
  export type SaveSellerError = Wire.SaveSellerErrors[keyof Wire.SaveSellerErrors];
@@ -215,6 +236,10 @@ export type UploadCreativeAssetInput = Wire.UploadCreativeAssetData['body'];
215
236
  export type UploadCreativeAssetResult = Wire.UploadCreativeAssetResponses[200]['data'];
216
237
  export type UploadCreativeAssetError = Wire.UploadCreativeAssetErrors[keyof Wire.UploadCreativeAssetErrors];
217
238
  export interface OperationTypes {
239
+ "confirm_payment_authority": {
240
+ input: ConfirmPaymentAuthorityInput;
241
+ result: ConfirmPaymentAuthorityResult;
242
+ };
218
243
  "downloadV3PublicDocumentRevision": {
219
244
  input: DownloadV3PublicDocumentRevisionInput;
220
245
  result: DownloadV3PublicDocumentRevisionResult;
@@ -255,10 +280,22 @@ export interface OperationTypes {
255
280
  input: OpenAdvertisersPageInput;
256
281
  result: OpenAdvertisersPageResult;
257
282
  };
283
+ "open_agent_certification_page": {
284
+ input: OpenAgentCertificationPageInput;
285
+ result: OpenAgentCertificationPageResult;
286
+ };
258
287
  "open_agent_page": {
259
288
  input: OpenAgentPageInput;
260
289
  result: OpenAgentPageResult;
261
290
  };
291
+ "open_agent_sources_page": {
292
+ input: OpenAgentSourcesPageInput;
293
+ result: OpenAgentSourcesPageResult;
294
+ };
295
+ "open_agent_webhooks_page": {
296
+ input: OpenAgentWebhooksPageInput;
297
+ result: OpenAgentWebhooksPageResult;
298
+ };
262
299
  "open_agents_page": {
263
300
  input: OpenAgentsPageInput;
264
301
  result: OpenAgentsPageResult;
@@ -287,10 +324,18 @@ export interface OperationTypes {
287
324
  input: OpenCreativeLibraryInput;
288
325
  result: OpenCreativeLibraryResult;
289
326
  };
327
+ "open_developer_home": {
328
+ input: OpenDeveloperHomeInput;
329
+ result: OpenDeveloperHomeResult;
330
+ };
290
331
  "open_media_buys_page": {
291
332
  input: OpenMediaBuysPageInput;
292
333
  result: OpenMediaBuysPageResult;
293
334
  };
335
+ "open_media_partners_page": {
336
+ input: OpenMediaPartnersPageInput;
337
+ result: OpenMediaPartnersPageResult;
338
+ };
294
339
  "open_page": {
295
340
  input: OpenPageInput;
296
341
  result: OpenPageResult;
@@ -315,6 +360,10 @@ export interface OperationTypes {
315
360
  input: RequestBuyerChildAccountInput;
316
361
  result: RequestBuyerChildAccountResult;
317
362
  };
363
+ "request_payment_authority": {
364
+ input: RequestPaymentAuthorityInput;
365
+ result: RequestPaymentAuthorityResult;
366
+ };
318
367
  "request_proposals": {
319
368
  input: RequestProposalsInput;
320
369
  result: RequestProposalsResult;
@@ -335,10 +384,6 @@ export interface OperationTypes {
335
384
  input: SaveAdvertiserInput;
336
385
  result: SaveAdvertiserResult;
337
386
  };
338
- "save_advertiser_access": {
339
- input: SaveAdvertiserAccessInput;
340
- result: SaveAdvertiserAccessResult;
341
- };
342
387
  "save_advertiser_grant": {
343
388
  input: SaveAdvertiserGrantInput;
344
389
  result: SaveAdvertiserGrantResult;
@@ -455,6 +500,10 @@ export interface OperationTypes {
455
500
  input: SaveRfpInput;
456
501
  result: SaveRfpResult;
457
502
  };
503
+ "save_rfp_turn": {
504
+ input: SaveRfpTurnInput;
505
+ result: SaveRfpTurnResult;
506
+ };
458
507
  "save_seller": {
459
508
  input: SaveSellerInput;
460
509
  result: SaveSellerResult;
@@ -485,6 +534,15 @@ export interface OperationTypes {
485
534
  };
486
535
  }
487
536
  export declare class Apostra extends Transport {
537
+ /**
538
+ * Issue the hosted card-capture link for a token from request_payment_authority. Give the link to the cardholder; cards stay off MCP.
539
+ *
540
+ * @example
541
+ * await client.confirmPaymentAuthority(input, { idempotencyKey: 'stable-key' })
542
+ */
543
+ confirmPaymentAuthority(input: ConfirmPaymentAuthorityInput, options: WriteRequestOptions): Promise<ConfirmPaymentAuthorityResult>;
544
+ /** Issue the hosted card-capture link for a token from request_payment_authority. Give the link to the cardholder; cards stay off MCP. Returns the data together with response headers and request ID. */
545
+ confirmPaymentAuthorityWithResponse(input: ConfirmPaymentAuthorityInput, options: WriteRequestOptions): Promise<ResponseDetails<ConfirmPaymentAuthorityResult>>;
488
546
  /**
489
547
  * Download a public immutable document revision
490
548
  *
@@ -558,13 +616,13 @@ export declare class Apostra extends Transport {
558
616
  /** Show a seller what reporting we received for one buyer media buy, whether each receipt was accepted, and the current computed daily totals. Opens the Media Buy Timeline Glance. Returns the data together with response headers and request ID. */
559
617
  getSellerReportingReceiptsWithResponse(input: GetSellerReportingReceiptsInput, options?: RequestOptions): Promise<ResponseDetails<GetSellerReportingReceiptsResult>>;
560
618
  /**
561
- * 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.
619
+ * 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.
562
620
  *
563
621
  * @example
564
622
  * await client.getStatus(input)
565
623
  */
566
624
  getStatus(input?: GetStatusInput, options?: RequestOptions): Promise<GetStatusResult>;
567
- /** 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. Returns the data together with response headers and request ID. */
625
+ /** 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. Returns the data together with response headers and request ID. */
568
626
  getStatusWithResponse(input?: GetStatusInput, options?: RequestOptions): Promise<ResponseDetails<GetStatusResult>>;
569
627
  /**
570
628
  * 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").
@@ -575,6 +633,15 @@ export declare class Apostra extends Transport {
575
633
  openAdvertisersPage(input: OpenAdvertisersPageInput, options?: RequestOptions): Promise<OpenAdvertisersPageResult>;
576
634
  /** 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"). Returns the data together with response headers and request ID. */
577
635
  openAdvertisersPageWithResponse(input: OpenAdvertisersPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAdvertisersPageResult>>;
636
+ /**
637
+ * Open one agent’s Test & certify Page: live certification per use case, recent test runs, AdCP 4.0 readiness and capability declarations. Read-only.
638
+ *
639
+ * @example
640
+ * await client.openAgentCertificationPage(input)
641
+ */
642
+ openAgentCertificationPage(input: OpenAgentCertificationPageInput, options?: RequestOptions): Promise<OpenAgentCertificationPageResult>;
643
+ /** Open one agent’s Test & certify Page: live certification per use case, recent test runs, AdCP 4.0 readiness and capability declarations. Read-only. Returns the data together with response headers and request ID. */
644
+ openAgentCertificationPageWithResponse(input: OpenAgentCertificationPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentCertificationPageResult>>;
578
645
  /**
579
646
  * Open one agent owned by this Developer account.
580
647
  *
@@ -584,6 +651,24 @@ export declare class Apostra extends Transport {
584
651
  openAgentPage(input: OpenAgentPageInput, options?: RequestOptions): Promise<OpenAgentPageResult>;
585
652
  /** Open one agent owned by this Developer account. Returns the data together with response headers and request ID. */
586
653
  openAgentPageWithResponse(input: OpenAgentPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentPageResult>>;
654
+ /**
655
+ * Open one agent’s Inventory sources Page: the inventory sources it powers and the health of each. Read-only.
656
+ *
657
+ * @example
658
+ * await client.openAgentSourcesPage(input)
659
+ */
660
+ openAgentSourcesPage(input: OpenAgentSourcesPageInput, options?: RequestOptions): Promise<OpenAgentSourcesPageResult>;
661
+ /** Open one agent’s Inventory sources Page: the inventory sources it powers and the health of each. Read-only. Returns the data together with response headers and request ID. */
662
+ openAgentSourcesPageWithResponse(input: OpenAgentSourcesPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentSourcesPageResult>>;
663
+ /**
664
+ * Open one agent’s Webhooks Page: its recent inbound webhook outcomes, each refusal with its reason. Read-only.
665
+ *
666
+ * @example
667
+ * await client.openAgentWebhooksPage(input)
668
+ */
669
+ openAgentWebhooksPage(input: OpenAgentWebhooksPageInput, options?: RequestOptions): Promise<OpenAgentWebhooksPageResult>;
670
+ /** Open one agent’s Webhooks Page: its recent inbound webhook outcomes, each refusal with its reason. Read-only. Returns the data together with response headers and request ID. */
671
+ openAgentWebhooksPageWithResponse(input: OpenAgentWebhooksPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentWebhooksPageResult>>;
587
672
  /**
588
673
  * Open Build an agent for this Developer account.
589
674
  *
@@ -621,13 +706,13 @@ export declare class Apostra extends Transport {
621
706
  /** Open the Campaigns Page: campaigns with status, flight, and budget; open one for its media buys and creatives. The Page self-fetches, so do not list campaigns in prose. advertiserId scopes to one advertiser; campaignId focuses one campaign. A draft's go-live review is open_campaign_receipt. Returns the data together with response headers and request ID. */
622
707
  openCampaignsPageWithResponse(input: OpenCampaignsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenCampaignsPageResult>>;
623
708
  /**
624
- * 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.
709
+ * 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.
625
710
  *
626
711
  * @example
627
712
  * await client.openConnectionsPage(input)
628
713
  */
629
714
  openConnectionsPage(input: OpenConnectionsPageInput, options?: RequestOptions): Promise<OpenConnectionsPageResult>;
630
- /** 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. Returns the data together with response headers and request ID. */
715
+ /** 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. Returns the data together with response headers and request ID. */
631
716
  openConnectionsPageWithResponse(input: OpenConnectionsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenConnectionsPageResult>>;
632
717
  /**
633
718
  * Open the buyer Creative Engines Page. Optionally focus an engine, connection, or its secure setup control; the buyer starts setup in the Page, and this does not authorize a provider or start generation.
@@ -648,22 +733,40 @@ export declare class Apostra extends Transport {
648
733
  /** 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. Returns the data together with response headers and request ID. */
649
734
  openCreativeLibraryWithResponse(input: OpenCreativeLibraryInput, options: WriteRequestOptions): Promise<ResponseDetails<OpenCreativeLibraryResult>>;
650
735
  /**
651
- * Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches.
736
+ * Open the Developer home for this Developer account: its agents, their stages and what to do next.
737
+ *
738
+ * @example
739
+ * await client.openDeveloperHome(input)
740
+ */
741
+ openDeveloperHome(input: OpenDeveloperHomeInput, options?: RequestOptions): Promise<OpenDeveloperHomeResult>;
742
+ /** Open the Developer home for this Developer account: its agents, their stages and what to do next. Returns the data together with response headers and request ID. */
743
+ openDeveloperHomeWithResponse(input: OpenDeveloperHomeInput, options?: RequestOptions): Promise<ResponseDetails<OpenDeveloperHomeResult>>;
744
+ /**
745
+ * 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.
652
746
  *
653
747
  * @example
654
748
  * await client.openMediaBuysPage(input)
655
749
  */
656
750
  openMediaBuysPage(input: OpenMediaBuysPageInput, options?: RequestOptions): Promise<OpenMediaBuysPageResult>;
657
- /** Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches. Returns the data together with response headers and request ID. */
751
+ /** 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. Returns the data together with response headers and request ID. */
658
752
  openMediaBuysPageWithResponse(input: OpenMediaBuysPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenMediaBuysPageResult>>;
659
753
  /**
660
- * Open a compatibility Page. source_diagnostics can create or attach the Agent. External hosts may return text. Credentials and authority changes remain human ceremonies.
754
+ * 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.
755
+ *
756
+ * @example
757
+ * await client.openMediaPartnersPage(input)
758
+ */
759
+ openMediaPartnersPage(input: OpenMediaPartnersPageInput, options?: RequestOptions): Promise<OpenMediaPartnersPageResult>;
760
+ /** 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. Returns the data together with response headers and request ID. */
761
+ openMediaPartnersPageWithResponse(input: OpenMediaPartnersPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenMediaPartnersPageResult>>;
762
+ /**
763
+ * 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.
661
764
  *
662
765
  * @example
663
766
  * await client.openPage(input)
664
767
  */
665
768
  openPage(input: OpenPageInput, options?: RequestOptions): Promise<OpenPageResult>;
666
- /** Open a compatibility Page. source_diagnostics can create or attach the Agent. External hosts may return text. Credentials and authority changes remain human ceremonies. Returns the data together with response headers and request ID. */
769
+ /** 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. Returns the data together with response headers and request ID. */
667
770
  openPageWithResponse(input: OpenPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenPageResult>>;
668
771
  /**
669
772
  * Open Proposal Pass on one exact immutable RFP turn. Supply the matching rfpId and turnId from save_rfp or get; the Page loads the private response itself.
@@ -693,13 +796,13 @@ export declare class Apostra extends Transport {
693
796
  /** Show a saved Creative Session’s variants (find via search/get kind creative_session). Not for generating new variants. Returns the data together with response headers and request ID. */
694
797
  openVariantGalleryWithResponse(input: OpenVariantGalleryInput, options?: RequestOptions): Promise<ResponseDetails<OpenVariantGalleryResult>>;
695
798
  /**
696
- * Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy.
799
+ * 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.
697
800
  *
698
801
  * @example
699
802
  * await client.refreshInventorySourceHealth(input, { idempotencyKey: 'stable-key' })
700
803
  */
701
804
  refreshInventorySourceHealth(input: RefreshInventorySourceHealthInput, options: WriteRequestOptions): Promise<RefreshInventorySourceHealthResult>;
702
- /** Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy. Returns the data together with response headers and request ID. */
805
+ /** 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. Returns the data together with response headers and request ID. */
703
806
  refreshInventorySourceHealthWithResponse(input: RefreshInventorySourceHealthInput, options: WriteRequestOptions): Promise<ResponseDetails<RefreshInventorySourceHealthResult>>;
704
807
  /**
705
808
  * 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.
@@ -711,13 +814,22 @@ export declare class Apostra extends Transport {
711
814
  /** 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. Returns the data together with response headers and request ID. */
712
815
  requestBuyerChildAccountWithResponse(input: RequestBuyerChildAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestBuyerChildAccountResult>>;
713
816
  /**
714
- * 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.
817
+ * Stage a card handoff for the organization and return a confirmation token. No link is issued until confirm_payment_authority.
818
+ *
819
+ * @example
820
+ * await client.requestPaymentAuthority(input, { idempotencyKey: 'stable-key' })
821
+ */
822
+ requestPaymentAuthority(input: RequestPaymentAuthorityInput, options: WriteRequestOptions): Promise<RequestPaymentAuthorityResult>;
823
+ /** Stage a card handoff for the organization and return a confirmation token. No link is issued until confirm_payment_authority. Returns the data together with response headers and request ID. */
824
+ requestPaymentAuthorityWithResponse(input: RequestPaymentAuthorityInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestPaymentAuthorityResult>>;
825
+ /**
826
+ * 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.
715
827
  *
716
828
  * @example
717
829
  * await client.requestProposals(input, { idempotencyKey: 'stable-key' })
718
830
  */
719
831
  requestProposals(input: RequestProposalsInput, options: WriteRequestOptions): Promise<RequestProposalsResult>;
720
- /** 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. Returns the data together with response headers and request ID. */
832
+ /** 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. Returns the data together with response headers and request ID. */
721
833
  requestProposalsWithResponse(input: RequestProposalsInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestProposalsResult>>;
722
834
  /**
723
835
  * Requests a scheduler-run reporting refresh or a bounded replay for one seller media buy. It never polls a provider directly.
@@ -738,13 +850,13 @@ export declare class Apostra extends Transport {
738
850
  /** Review a Buyer child under the selected Organization: name, role, capacity, plan coverage, operator, inherited access and other effects. Read-only; nothing is created. Show the review to the person, then call request_buyer_child_account. Returns the data together with response headers and request ID. */
739
851
  reviewBuyerChildAccountWithResponse(input: ReviewBuyerChildAccountInput, options?: RequestOptions): Promise<ResponseDetails<ReviewBuyerChildAccountResult>>;
740
852
  /**
741
- * Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes.
853
+ * 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.
742
854
  *
743
855
  * @example
744
856
  * await client.saveAccount(input, { idempotencyKey: 'stable-key' })
745
857
  */
746
858
  saveAccount(input: SaveAccountInput, options: WriteRequestOptions): Promise<SaveAccountResult>;
747
- /** 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. */
859
+ /** 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. Returns the data together with response headers and request ID. */
748
860
  saveAccountWithResponse(input: SaveAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAccountResult>>;
749
861
  /**
750
862
  * 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.
@@ -755,15 +867,6 @@ export declare class Apostra extends Transport {
755
867
  saveAdvertiser(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<SaveAdvertiserResult>;
756
868
  /** 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. */
757
869
  saveAdvertiserWithResponse(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserResult>>;
758
- /**
759
- * 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.
760
- *
761
- * @example
762
- * await client.saveAdvertiserAccess(input, { idempotencyKey: 'stable-key' })
763
- */
764
- saveAdvertiserAccess(input: SaveAdvertiserAccessInput, options: WriteRequestOptions): Promise<SaveAdvertiserAccessResult>;
765
- /** 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. */
766
- saveAdvertiserAccessWithResponse(input: SaveAdvertiserAccessInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserAccessResult>>;
767
870
  /**
768
871
  * 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.
769
872
  *
@@ -783,13 +886,13 @@ export declare class Apostra extends Transport {
783
886
  /** 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. */
784
887
  saveAdvertiserInstructionsWithResponse(input: SaveAdvertiserInstructionsInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserInstructionsResult>>;
785
888
  /**
786
- * 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.
889
+ * 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.
787
890
  *
788
891
  * @example
789
892
  * await client.saveAgent(input, { idempotencyKey: 'stable-key' })
790
893
  */
791
894
  saveAgent(input: SaveAgentInput, options: WriteRequestOptions): Promise<SaveAgentResult>;
792
- /** 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. */
895
+ /** 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. Returns the data together with response headers and request ID. */
793
896
  saveAgentWithResponse(input: SaveAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAgentResult>>;
794
897
  /**
795
898
  * 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.
@@ -810,13 +913,13 @@ export declare class Apostra extends Transport {
810
913
  /** Sync first-party CRM audiences for a buyer advertiser. Each audiences[] item may add, remove, or delete members. Returns an operationId; use get(kind: audience, advertiserId: "...") to read match status after it settles. Returns the data together with response headers and request ID. */
811
914
  saveAudienceWithResponse(input: SaveAudienceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAudienceResult>>;
812
915
  /**
813
- * Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP.
916
+ * 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.
814
917
  *
815
918
  * @example
816
919
  * await client.saveBilling(input, { idempotencyKey: 'stable-key' })
817
920
  */
818
921
  saveBilling(input: SaveBillingInput, options: WriteRequestOptions): Promise<SaveBillingResult>;
819
- /** Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP. Returns the data together with response headers and request ID. */
922
+ /** 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. Returns the data together with response headers and request ID. */
820
923
  saveBillingWithResponse(input: SaveBillingInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBillingResult>>;
821
924
  /**
822
925
  * Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview.
@@ -828,13 +931,13 @@ export declare class Apostra extends Transport {
828
931
  /** 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. */
829
932
  saveBusinessRulesWithResponse(input: SaveBusinessRulesInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBusinessRulesResult>>;
830
933
  /**
831
- * Create or manage one buyer agent.
934
+ * Create a buyer agent, or with id make one change: name, advertiser access, lifecycle state, or credential handoff.
832
935
  *
833
936
  * @example
834
937
  * await client.saveBuyerAgent(input, { idempotencyKey: 'stable-key' })
835
938
  */
836
939
  saveBuyerAgent(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<SaveBuyerAgentResult>;
837
- /** Create or manage one buyer agent. Returns the data together with response headers and request ID. */
940
+ /** Create a buyer agent, or with id make one change: name, advertiser access, lifecycle state, or credential handoff. Returns the data together with response headers and request ID. */
838
941
  saveBuyerAgentWithResponse(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerAgentResult>>;
839
942
  /**
840
943
  * Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup.
@@ -846,13 +949,13 @@ export declare class Apostra extends Transport {
846
949
  /** 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. */
847
950
  saveBuyerOperatorWithResponse(input: SaveBuyerOperatorInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerOperatorResult>>;
848
951
  /**
849
- * 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.
952
+ * 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.
850
953
  *
851
954
  * @example
852
955
  * await client.saveCampaign(input, { idempotencyKey: 'stable-key' })
853
956
  */
854
957
  saveCampaign(input: SaveCampaignInput, options: WriteRequestOptions): Promise<SaveCampaignResult>;
855
- /** 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. */
958
+ /** 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. Returns the data together with response headers and request ID. */
856
959
  saveCampaignWithResponse(input: SaveCampaignInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCampaignResult>>;
857
960
  /**
858
961
  * 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.
@@ -882,13 +985,13 @@ export declare class Apostra extends Transport {
882
985
  /** Declare publisher domains this Seller sells and its claimed properties. `domains` replaces the complete set; `add`, `remove`, `declareProperties`, and `removeProperties` change named items only. Read authorization; never assume it. Returns the data together with response headers and request ID. */
883
986
  saveCoverageWithResponse(input: SaveCoverageInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCoverageResult>>;
884
987
  /**
885
- * 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.
988
+ * 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.
886
989
  *
887
990
  * @example
888
991
  * await client.saveCreative(input, { idempotencyKey: 'stable-key' })
889
992
  */
890
993
  saveCreative(input: SaveCreativeInput, options: WriteRequestOptions): Promise<SaveCreativeResult>;
891
- /** 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. Returns the data together with response headers and request ID. */
994
+ /** 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. Returns the data together with response headers and request ID. */
892
995
  saveCreativeWithResponse(input: SaveCreativeInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeResult>>;
893
996
  /**
894
997
  * Manage collections. Create with one owner and name: campaignId or advertiserId. Only advertiser mutations of an existing collection need expectedUpdatedAt; campaign writes and creates do not. isArchived archives or restores advertiser collections.
@@ -900,13 +1003,13 @@ export declare class Apostra extends Transport {
900
1003
  /** Manage collections. Create with one owner and name: campaignId or advertiserId. Only advertiser mutations of an existing collection need expectedUpdatedAt; campaign writes and creates do not. isArchived archives or restores advertiser collections. Returns the data together with response headers and request ID. */
901
1004
  saveCreativeCollectionWithResponse(input: SaveCreativeCollectionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeCollectionResult>>;
902
1005
  /**
903
- * Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId.
1006
+ * 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.
904
1007
  *
905
1008
  * @example
906
1009
  * await client.saveCreativeSession(input, { idempotencyKey: 'stable-key' })
907
1010
  */
908
1011
  saveCreativeSession(input: SaveCreativeSessionInput, options: WriteRequestOptions): Promise<SaveCreativeSessionResult>;
909
- /** Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId. Returns the data together with response headers and request ID. */
1012
+ /** 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. Returns the data together with response headers and request ID. */
910
1013
  saveCreativeSessionWithResponse(input: SaveCreativeSessionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeSessionResult>>;
911
1014
  /**
912
1015
  * Create a dimension, or update an existing dimension by its id. Tags is built in and open. Labels belong only to objects in appliesTo.
@@ -936,22 +1039,22 @@ export declare class Apostra extends Transport {
936
1039
  /** 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. Returns the data together with response headers and request ID. */
937
1040
  saveEventSourceWithResponse(input: SaveEventSourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveEventSourceResult>>;
938
1041
  /**
939
- * 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.
1042
+ * 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.
940
1043
  *
941
1044
  * @example
942
1045
  * await client.saveInventorySource(input, { idempotencyKey: 'stable-key' })
943
1046
  */
944
1047
  saveInventorySource(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<SaveInventorySourceResult>;
945
- /** 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. */
1048
+ /** 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. Returns the data together with response headers and request ID. */
946
1049
  saveInventorySourceWithResponse(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveInventorySourceResult>>;
947
1050
  /**
948
- * 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.
1051
+ * 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.
949
1052
  *
950
1053
  * @example
951
1054
  * await client.saveLesson(input, { idempotencyKey: 'stable-key' })
952
1055
  */
953
1056
  saveLesson(input: SaveLessonInput, options: WriteRequestOptions): Promise<SaveLessonResult>;
954
- /** 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. */
1057
+ /** 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. Returns the data together with response headers and request ID. */
955
1058
  saveLessonWithResponse(input: SaveLessonInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLessonResult>>;
956
1059
  /**
957
1060
  * Open a seller library request or close it with seller Material.
@@ -963,13 +1066,13 @@ export declare class Apostra extends Transport {
963
1066
  /** Open a seller library request or close it with seller Material. Returns the data together with response headers and request ID. */
964
1067
  saveLibraryRequestWithResponse(input: SaveLibraryRequestInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLibraryRequestResult>>;
965
1068
  /**
966
- * 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).
1069
+ * 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
967
1070
  *
968
1071
  * @example
969
1072
  * await client.saveMaterial(input, { idempotencyKey: 'stable-key' })
970
1073
  */
971
1074
  saveMaterial(input: SaveMaterialInput, options: WriteRequestOptions): Promise<SaveMaterialResult>;
972
- /** 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). Returns the data together with response headers and request ID. */
1075
+ /** 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 Returns the data together with response headers and request ID. */
973
1076
  saveMaterialWithResponse(input: SaveMaterialInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveMaterialResult>>;
974
1077
  /**
975
1078
  * Create DRAFT buy; no spend until confirmed. Meta: shared campaign=seller_optimized; ad sets=fixed; ask if unclear. Shared: omit buy/product budgets. Pause/resume: mediaBuyId + isPaused. Proposal: flight + total budget; omit products. channelGroupId: required if grouped; invalid ungrouped/updates.
@@ -999,13 +1102,13 @@ export declare class Apostra extends Transport {
999
1102
  /** 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. */
1000
1103
  saveNotificationConfigWithResponse(input: SaveNotificationConfigInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveNotificationConfigResult>>;
1001
1104
  /**
1002
- * 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.
1105
+ * 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.
1003
1106
  *
1004
1107
  * @example
1005
1108
  * await client.savePlaybook(input, { idempotencyKey: 'stable-key' })
1006
1109
  */
1007
1110
  savePlaybook(input: SavePlaybookInput, options: WriteRequestOptions): Promise<SavePlaybookResult>;
1008
- /** 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. */
1111
+ /** 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. Returns the data together with response headers and request ID. */
1009
1112
  savePlaybookWithResponse(input: SavePlaybookInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePlaybookResult>>;
1010
1113
  /**
1011
1114
  * Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
@@ -1017,22 +1120,31 @@ export declare class Apostra extends Transport {
1017
1120
  /** 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. */
1018
1121
  savePropertyListWithResponse(input: SavePropertyListInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePropertyListResult>>;
1019
1122
  /**
1020
- * Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests.
1123
+ * 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.
1021
1124
  *
1022
1125
  * @example
1023
1126
  * await client.saveRfp(input, { idempotencyKey: 'stable-key' })
1024
1127
  */
1025
1128
  saveRfp(input: SaveRfpInput, options: WriteRequestOptions): Promise<SaveRfpResult>;
1026
- /** Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests. Returns the data together with response headers and request ID. */
1129
+ /** 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. Returns the data together with response headers and request ID. */
1027
1130
  saveRfpWithResponse(input: SaveRfpInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveRfpResult>>;
1028
1131
  /**
1029
- * 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").
1132
+ * 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.
1133
+ *
1134
+ * @example
1135
+ * await client.saveRfpTurn(input, { idempotencyKey: 'stable-key' })
1136
+ */
1137
+ saveRfpTurn(input: SaveRfpTurnInput, options: WriteRequestOptions): Promise<SaveRfpTurnResult>;
1138
+ /** 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. Returns the data together with response headers and request ID. */
1139
+ saveRfpTurnWithResponse(input: SaveRfpTurnInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveRfpTurnResult>>;
1140
+ /**
1141
+ * 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").
1030
1142
  *
1031
1143
  * @example
1032
1144
  * await client.saveSeller(input, { idempotencyKey: 'stable-key' })
1033
1145
  */
1034
1146
  saveSeller(input: SaveSellerInput, options: WriteRequestOptions): Promise<SaveSellerResult>;
1035
- /** 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"). Returns the data together with response headers and request ID. */
1147
+ /** 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"). Returns the data together with response headers and request ID. */
1036
1148
  saveSellerWithResponse(input: SaveSellerInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveSellerResult>>;
1037
1149
  /**
1038
1150
  * Create, replace, or archive a signal. Managed writes need a complete draft; read before updates. Without sourceId, writes the seller catalog.