@apostra/sdk 0.37.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,5 +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
+ 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];
3
7
  export type DownloadV3PublicDocumentRevisionInput = {
4
8
  "documentId": NonNullable<Wire.DownloadV3PublicDocumentRevisionData['path']>["documentId"];
5
9
  "revisionId": NonNullable<Wire.DownloadV3PublicDocumentRevisionData['path']>["revisionId"];
@@ -42,9 +46,18 @@ export type GetStatusError = Wire.GetStatusErrors[keyof Wire.GetStatusErrors];
42
46
  export type OpenAdvertisersPageInput = Wire.OpenAdvertisersPageData['body'];
43
47
  export type OpenAdvertisersPageResult = Wire.OpenAdvertisersPageResponses[200]['data'];
44
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];
45
52
  export type OpenAgentPageInput = Wire.OpenAgentPageData['body'];
46
53
  export type OpenAgentPageResult = Wire.OpenAgentPageResponses[200]['data'];
47
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];
48
61
  export type OpenAgentsPageInput = Wire.OpenAgentsPageData['body'];
49
62
  export type OpenAgentsPageResult = Wire.OpenAgentsPageResponses[200]['data'];
50
63
  export type OpenAgentsPageError = Wire.OpenAgentsPageErrors[keyof Wire.OpenAgentsPageErrors];
@@ -66,9 +79,15 @@ export type OpenCreativeEnginesPageError = Wire.OpenCreativeEnginesPageErrors[ke
66
79
  export type OpenCreativeLibraryInput = Wire.OpenCreativeLibraryData['body'];
67
80
  export type OpenCreativeLibraryResult = Wire.OpenCreativeLibraryResponses[200]['data'];
68
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];
69
85
  export type OpenMediaBuysPageInput = Wire.OpenMediaBuysPageData['body'];
70
86
  export type OpenMediaBuysPageResult = Wire.OpenMediaBuysPageResponses[200]['data'];
71
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];
72
91
  export type OpenPageInput = Wire.OpenPageData['body'];
73
92
  export type OpenPageResult = Wire.OpenPageResponses[200]['data'];
74
93
  export type OpenPageError = Wire.OpenPageErrors[keyof Wire.OpenPageErrors];
@@ -84,10 +103,13 @@ export type OpenVariantGalleryError = Wire.OpenVariantGalleryErrors[keyof Wire.O
84
103
  export type RefreshInventorySourceHealthInput = Wire.RefreshInventorySourceHealthData['body'];
85
104
  export type RefreshInventorySourceHealthResult = Wire.RefreshInventorySourceHealthResponses[200]['data'];
86
105
  export type RefreshInventorySourceHealthError = Wire.RefreshInventorySourceHealthErrors[keyof Wire.RefreshInventorySourceHealthErrors];
87
- export type RequestBuyerChildAccountInput = Omit<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey"> & Partial<Pick<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey">>;
106
+ export type RequestBuyerChildAccountInput = OptionalWireField<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey">;
88
107
  export type RequestBuyerChildAccountResult = Wire.RequestBuyerChildAccountResponses[200]['data'];
89
108
  export type RequestBuyerChildAccountError = Wire.RequestBuyerChildAccountErrors[keyof Wire.RequestBuyerChildAccountErrors];
90
- export type RequestProposalsInput = Omit<Wire.RequestProposalsData['body'], "idempotencyKey"> & Partial<Pick<Wire.RequestProposalsData['body'], "idempotencyKey">>;
109
+ export type RequestPaymentAuthorityInput = Wire.RequestPaymentAuthorityData['body'];
110
+ export type RequestPaymentAuthorityResult = Wire.RequestPaymentAuthorityResponses[200]['data'];
111
+ export type RequestPaymentAuthorityError = Wire.RequestPaymentAuthorityErrors[keyof Wire.RequestPaymentAuthorityErrors];
112
+ export type RequestProposalsInput = OptionalWireField<Wire.RequestProposalsData['body'], "idempotencyKey">;
91
113
  export type RequestProposalsResult = Wire.RequestProposalsResponses[200]['data'];
92
114
  export type RequestProposalsError = Wire.RequestProposalsErrors[keyof Wire.RequestProposalsErrors];
93
115
  export type RequestSellerReportingUpdateInput = Wire.RequestSellerReportingUpdateData['body'];
@@ -129,10 +151,10 @@ export type SaveBuyerAgentError = Wire.SaveBuyerAgentErrors[keyof Wire.SaveBuyer
129
151
  export type SaveBuyerOperatorInput = Wire.SaveBuyerOperatorData['body'];
130
152
  export type SaveBuyerOperatorResult = Wire.SaveBuyerOperatorResponses[200]['data'];
131
153
  export type SaveBuyerOperatorError = Wire.SaveBuyerOperatorErrors[keyof Wire.SaveBuyerOperatorErrors];
132
- export type SaveCampaignInput = Omit<Wire.SaveCampaignData['body'], "idempotencyKey"> & Partial<Pick<Wire.SaveCampaignData['body'], "idempotencyKey">>;
154
+ export type SaveCampaignInput = OptionalWireField<Wire.SaveCampaignData['body'], "idempotencyKey">;
133
155
  export type SaveCampaignResult = Wire.SaveCampaignResponses[200]['data'];
134
156
  export type SaveCampaignError = Wire.SaveCampaignErrors[keyof Wire.SaveCampaignErrors];
135
- export type SaveCatalogInput = Omit<Wire.SaveCatalogData['body'], "idempotencyKey"> & Partial<Pick<Wire.SaveCatalogData['body'], "idempotencyKey">>;
157
+ export type SaveCatalogInput = OptionalWireField<Wire.SaveCatalogData['body'], "idempotencyKey">;
136
158
  export type SaveCatalogResult = Wire.SaveCatalogResponses[200]['data'];
137
159
  export type SaveCatalogError = Wire.SaveCatalogErrors[keyof Wire.SaveCatalogErrors];
138
160
  export type SaveConnectionInput = Wire.SaveConnectionData['body'];
@@ -150,25 +172,28 @@ export type SaveCreativeCollectionError = Wire.SaveCreativeCollectionErrors[keyo
150
172
  export type SaveCreativeSessionInput = Wire.SaveCreativeSessionData['body'];
151
173
  export type SaveCreativeSessionResult = Wire.SaveCreativeSessionResponses[200]['data'];
152
174
  export type SaveCreativeSessionError = Wire.SaveCreativeSessionErrors[keyof Wire.SaveCreativeSessionErrors];
153
- export type SaveDimensionInput = Wire.SaveDimensionData['body'];
175
+ export type SaveDimensionInput = OptionalWireField<Wire.SaveDimensionData['body'], "idempotencyKey">;
154
176
  export type SaveDimensionResult = Wire.SaveDimensionResponses[200]['data'];
155
177
  export type SaveDimensionError = Wire.SaveDimensionErrors[keyof Wire.SaveDimensionErrors];
156
178
  export type SaveDirectedCampaignSubscriptionInput = Wire.SaveDirectedCampaignSubscriptionData['body'];
157
179
  export type SaveDirectedCampaignSubscriptionResult = Wire.SaveDirectedCampaignSubscriptionResponses[200]['data'];
158
180
  export type SaveDirectedCampaignSubscriptionError = Wire.SaveDirectedCampaignSubscriptionErrors[keyof Wire.SaveDirectedCampaignSubscriptionErrors];
159
- export type SaveEventSourceInput = Omit<Wire.SaveEventSourceData['body'], "idempotencyKey"> & Partial<Pick<Wire.SaveEventSourceData['body'], "idempotencyKey">>;
181
+ export type SaveEventSourceInput = OptionalWireField<Wire.SaveEventSourceData['body'], "idempotencyKey">;
160
182
  export type SaveEventSourceResult = Wire.SaveEventSourceResponses[200]['data'];
161
183
  export type SaveEventSourceError = Wire.SaveEventSourceErrors[keyof Wire.SaveEventSourceErrors];
162
184
  export type SaveInventorySourceInput = Wire.SaveInventorySourceData['body'];
163
185
  export type SaveInventorySourceResult = Wire.SaveInventorySourceResponses[200]['data'];
164
186
  export type SaveInventorySourceError = Wire.SaveInventorySourceErrors[keyof Wire.SaveInventorySourceErrors];
187
+ export type SaveLessonInput = Wire.SaveLessonData['body'];
188
+ export type SaveLessonResult = Wire.SaveLessonResponses[200]['data'];
189
+ export type SaveLessonError = Wire.SaveLessonErrors[keyof Wire.SaveLessonErrors];
165
190
  export type SaveLibraryRequestInput = Wire.SaveLibraryRequestData['body'];
166
191
  export type SaveLibraryRequestResult = Wire.SaveLibraryRequestResponses[200]['data'];
167
192
  export type SaveLibraryRequestError = Wire.SaveLibraryRequestErrors[keyof Wire.SaveLibraryRequestErrors];
168
193
  export type SaveMaterialInput = Wire.SaveMaterialData['body'];
169
194
  export type SaveMaterialResult = Wire.SaveMaterialResponses[200]['data'];
170
195
  export type SaveMaterialError = Wire.SaveMaterialErrors[keyof Wire.SaveMaterialErrors];
171
- export type SaveMediaBuyInput = Omit<Wire.SaveMediaBuyData['body'], "idempotencyKey"> & Partial<Pick<Wire.SaveMediaBuyData['body'], "idempotencyKey">>;
196
+ export type SaveMediaBuyInput = OptionalWireField<Wire.SaveMediaBuyData['body'], "idempotencyKey">;
172
197
  export type SaveMediaBuyResult = Wire.SaveMediaBuyResponses[200]['data'];
173
198
  export type SaveMediaBuyError = Wire.SaveMediaBuyErrors[keyof Wire.SaveMediaBuyErrors];
174
199
  export type SaveMediaKitInput = Wire.SaveMediaKitData['body'];
@@ -183,9 +208,12 @@ export type SavePlaybookError = Wire.SavePlaybookErrors[keyof Wire.SavePlaybookE
183
208
  export type SavePropertyListInput = Wire.SavePropertyListData['body'];
184
209
  export type SavePropertyListResult = Wire.SavePropertyListResponses[200]['data'];
185
210
  export type SavePropertyListError = Wire.SavePropertyListErrors[keyof Wire.SavePropertyListErrors];
186
- export type SaveRfpInput = Wire.SaveRfpData['body'];
211
+ export type SaveRfpInput = OptionalWireField<Wire.SaveRfpData['body'], "clientRequestId">;
187
212
  export type SaveRfpResult = Wire.SaveRfpResponses[200]['data'];
188
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];
189
217
  export type SaveSellerInput = Wire.SaveSellerData['body'];
190
218
  export type SaveSellerResult = Wire.SaveSellerResponses[200]['data'];
191
219
  export type SaveSellerError = Wire.SaveSellerErrors[keyof Wire.SaveSellerErrors];
@@ -208,6 +236,10 @@ export type UploadCreativeAssetInput = Wire.UploadCreativeAssetData['body'];
208
236
  export type UploadCreativeAssetResult = Wire.UploadCreativeAssetResponses[200]['data'];
209
237
  export type UploadCreativeAssetError = Wire.UploadCreativeAssetErrors[keyof Wire.UploadCreativeAssetErrors];
210
238
  export interface OperationTypes {
239
+ "confirm_payment_authority": {
240
+ input: ConfirmPaymentAuthorityInput;
241
+ result: ConfirmPaymentAuthorityResult;
242
+ };
211
243
  "downloadV3PublicDocumentRevision": {
212
244
  input: DownloadV3PublicDocumentRevisionInput;
213
245
  result: DownloadV3PublicDocumentRevisionResult;
@@ -248,10 +280,22 @@ export interface OperationTypes {
248
280
  input: OpenAdvertisersPageInput;
249
281
  result: OpenAdvertisersPageResult;
250
282
  };
283
+ "open_agent_certification_page": {
284
+ input: OpenAgentCertificationPageInput;
285
+ result: OpenAgentCertificationPageResult;
286
+ };
251
287
  "open_agent_page": {
252
288
  input: OpenAgentPageInput;
253
289
  result: OpenAgentPageResult;
254
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
+ };
255
299
  "open_agents_page": {
256
300
  input: OpenAgentsPageInput;
257
301
  result: OpenAgentsPageResult;
@@ -280,10 +324,18 @@ export interface OperationTypes {
280
324
  input: OpenCreativeLibraryInput;
281
325
  result: OpenCreativeLibraryResult;
282
326
  };
327
+ "open_developer_home": {
328
+ input: OpenDeveloperHomeInput;
329
+ result: OpenDeveloperHomeResult;
330
+ };
283
331
  "open_media_buys_page": {
284
332
  input: OpenMediaBuysPageInput;
285
333
  result: OpenMediaBuysPageResult;
286
334
  };
335
+ "open_media_partners_page": {
336
+ input: OpenMediaPartnersPageInput;
337
+ result: OpenMediaPartnersPageResult;
338
+ };
287
339
  "open_page": {
288
340
  input: OpenPageInput;
289
341
  result: OpenPageResult;
@@ -308,6 +360,10 @@ export interface OperationTypes {
308
360
  input: RequestBuyerChildAccountInput;
309
361
  result: RequestBuyerChildAccountResult;
310
362
  };
363
+ "request_payment_authority": {
364
+ input: RequestPaymentAuthorityInput;
365
+ result: RequestPaymentAuthorityResult;
366
+ };
311
367
  "request_proposals": {
312
368
  input: RequestProposalsInput;
313
369
  result: RequestProposalsResult;
@@ -408,6 +464,10 @@ export interface OperationTypes {
408
464
  input: SaveInventorySourceInput;
409
465
  result: SaveInventorySourceResult;
410
466
  };
467
+ "save_lesson": {
468
+ input: SaveLessonInput;
469
+ result: SaveLessonResult;
470
+ };
411
471
  "save_library_request": {
412
472
  input: SaveLibraryRequestInput;
413
473
  result: SaveLibraryRequestResult;
@@ -440,6 +500,10 @@ export interface OperationTypes {
440
500
  input: SaveRfpInput;
441
501
  result: SaveRfpResult;
442
502
  };
503
+ "save_rfp_turn": {
504
+ input: SaveRfpTurnInput;
505
+ result: SaveRfpTurnResult;
506
+ };
443
507
  "save_seller": {
444
508
  input: SaveSellerInput;
445
509
  result: SaveSellerResult;
@@ -470,6 +534,15 @@ export interface OperationTypes {
470
534
  };
471
535
  }
472
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>>;
473
546
  /**
474
547
  * Download a public immutable document revision
475
548
  *
@@ -480,22 +553,22 @@ export declare class Apostra extends Transport {
480
553
  /** Download a public immutable document revision Returns the data together with response headers and request ID. */
481
554
  downloadV3PublicDocumentRevisionWithResponse(input: DownloadV3PublicDocumentRevisionInput, options?: RequestOptions): Promise<ResponseDetails<DownloadV3PublicDocumentRevisionResult>>;
482
555
  /**
483
- * 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.
556
+ * 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.
484
557
  *
485
558
  * @example
486
559
  * await client.generateVariants(input, { idempotencyKey: 'stable-key' })
487
560
  */
488
561
  generateVariants(input: GenerateVariantsInput, options: WriteRequestOptions): Promise<GenerateVariantsResult>;
489
- /** 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. */
562
+ /** 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. */
490
563
  generateVariantsWithResponse(input: GenerateVariantsInput, options: WriteRequestOptions): Promise<ResponseDetails<GenerateVariantsResult>>;
491
564
  /**
492
- * 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.
565
+ * 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.
493
566
  *
494
567
  * @example
495
568
  * await client.get(input)
496
569
  */
497
570
  get(input: GetInput, options?: RequestOptions): Promise<GetResult>;
498
- /** 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. */
571
+ /** 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. */
499
572
  getWithResponse(input: GetInput, options?: RequestOptions): Promise<ResponseDetails<GetResult>>;
500
573
  /**
501
574
  * Read a bounded public immutable document revision
@@ -543,13 +616,13 @@ export declare class Apostra extends Transport {
543
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. */
544
617
  getSellerReportingReceiptsWithResponse(input: GetSellerReportingReceiptsInput, options?: RequestOptions): Promise<ResponseDetails<GetSellerReportingReceiptsResult>>;
545
618
  /**
546
- * 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.
547
620
  *
548
621
  * @example
549
622
  * await client.getStatus(input)
550
623
  */
551
624
  getStatus(input?: GetStatusInput, options?: RequestOptions): Promise<GetStatusResult>;
552
- /** 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. */
553
626
  getStatusWithResponse(input?: GetStatusInput, options?: RequestOptions): Promise<ResponseDetails<GetStatusResult>>;
554
627
  /**
555
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").
@@ -560,6 +633,15 @@ export declare class Apostra extends Transport {
560
633
  openAdvertisersPage(input: OpenAdvertisersPageInput, options?: RequestOptions): Promise<OpenAdvertisersPageResult>;
561
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. */
562
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>>;
563
645
  /**
564
646
  * Open one agent owned by this Developer account.
565
647
  *
@@ -569,6 +651,24 @@ export declare class Apostra extends Transport {
569
651
  openAgentPage(input: OpenAgentPageInput, options?: RequestOptions): Promise<OpenAgentPageResult>;
570
652
  /** Open one agent owned by this Developer account. Returns the data together with response headers and request ID. */
571
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>>;
572
672
  /**
573
673
  * Open Build an agent for this Developer account.
574
674
  *
@@ -606,13 +706,13 @@ export declare class Apostra extends Transport {
606
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. */
607
707
  openCampaignsPageWithResponse(input: OpenCampaignsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenCampaignsPageResult>>;
608
708
  /**
609
- * 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.
610
710
  *
611
711
  * @example
612
712
  * await client.openConnectionsPage(input)
613
713
  */
614
714
  openConnectionsPage(input: OpenConnectionsPageInput, options?: RequestOptions): Promise<OpenConnectionsPageResult>;
615
- /** 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. */
616
716
  openConnectionsPageWithResponse(input: OpenConnectionsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenConnectionsPageResult>>;
617
717
  /**
618
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.
@@ -633,22 +733,40 @@ export declare class Apostra extends Transport {
633
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. */
634
734
  openCreativeLibraryWithResponse(input: OpenCreativeLibraryInput, options: WriteRequestOptions): Promise<ResponseDetails<OpenCreativeLibraryResult>>;
635
735
  /**
636
- * 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.
637
746
  *
638
747
  * @example
639
748
  * await client.openMediaBuysPage(input)
640
749
  */
641
750
  openMediaBuysPage(input: OpenMediaBuysPageInput, options?: RequestOptions): Promise<OpenMediaBuysPageResult>;
642
- /** 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. */
643
752
  openMediaBuysPageWithResponse(input: OpenMediaBuysPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenMediaBuysPageResult>>;
644
753
  /**
645
- * 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.
646
764
  *
647
765
  * @example
648
766
  * await client.openPage(input)
649
767
  */
650
768
  openPage(input: OpenPageInput, options?: RequestOptions): Promise<OpenPageResult>;
651
- /** 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. */
652
770
  openPageWithResponse(input: OpenPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenPageResult>>;
653
771
  /**
654
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.
@@ -678,13 +796,13 @@ export declare class Apostra extends Transport {
678
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. */
679
797
  openVariantGalleryWithResponse(input: OpenVariantGalleryInput, options?: RequestOptions): Promise<ResponseDetails<OpenVariantGalleryResult>>;
680
798
  /**
681
- * 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.
682
800
  *
683
801
  * @example
684
802
  * await client.refreshInventorySourceHealth(input, { idempotencyKey: 'stable-key' })
685
803
  */
686
804
  refreshInventorySourceHealth(input: RefreshInventorySourceHealthInput, options: WriteRequestOptions): Promise<RefreshInventorySourceHealthResult>;
687
- /** 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. */
688
806
  refreshInventorySourceHealthWithResponse(input: RefreshInventorySourceHealthInput, options: WriteRequestOptions): Promise<ResponseDetails<RefreshInventorySourceHealthResult>>;
689
807
  /**
690
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.
@@ -696,13 +814,22 @@ export declare class Apostra extends Transport {
696
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. */
697
815
  requestBuyerChildAccountWithResponse(input: RequestBuyerChildAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestBuyerChildAccountResult>>;
698
816
  /**
699
- * 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.
700
827
  *
701
828
  * @example
702
829
  * await client.requestProposals(input, { idempotencyKey: 'stable-key' })
703
830
  */
704
831
  requestProposals(input: RequestProposalsInput, options: WriteRequestOptions): Promise<RequestProposalsResult>;
705
- /** 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. */
706
833
  requestProposalsWithResponse(input: RequestProposalsInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestProposalsResult>>;
707
834
  /**
708
835
  * Requests a scheduler-run reporting refresh or a bounded replay for one seller media buy. It never polls a provider directly.
@@ -723,22 +850,22 @@ export declare class Apostra extends Transport {
723
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. */
724
851
  reviewBuyerChildAccountWithResponse(input: ReviewBuyerChildAccountInput, options?: RequestOptions): Promise<ResponseDetails<ReviewBuyerChildAccountResult>>;
725
852
  /**
726
- * 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.
727
854
  *
728
855
  * @example
729
856
  * await client.saveAccount(input, { idempotencyKey: 'stable-key' })
730
857
  */
731
858
  saveAccount(input: SaveAccountInput, options: WriteRequestOptions): Promise<SaveAccountResult>;
732
- /** 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. */
733
860
  saveAccountWithResponse(input: SaveAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAccountResult>>;
734
861
  /**
735
- * 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.
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.
736
863
  *
737
864
  * @example
738
865
  * await client.saveAdvertiser(input, { idempotencyKey: 'stable-key' })
739
866
  */
740
867
  saveAdvertiser(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<SaveAdvertiserResult>;
741
- /** 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. */
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. */
742
869
  saveAdvertiserWithResponse(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserResult>>;
743
870
  /**
744
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.
@@ -750,22 +877,22 @@ export declare class Apostra extends Transport {
750
877
  /** 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. */
751
878
  saveAdvertiserGrantWithResponse(input: SaveAdvertiserGrantInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserGrantResult>>;
752
879
  /**
753
- * 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.
880
+ * 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.
754
881
  *
755
882
  * @example
756
883
  * await client.saveAdvertiserInstructions(input, { idempotencyKey: 'stable-key' })
757
884
  */
758
885
  saveAdvertiserInstructions(input: SaveAdvertiserInstructionsInput, options: WriteRequestOptions): Promise<SaveAdvertiserInstructionsResult>;
759
- /** 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. */
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. */
760
887
  saveAdvertiserInstructionsWithResponse(input: SaveAdvertiserInstructionsInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserInstructionsResult>>;
761
888
  /**
762
- * 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.
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.
763
890
  *
764
891
  * @example
765
892
  * await client.saveAgent(input, { idempotencyKey: 'stable-key' })
766
893
  */
767
894
  saveAgent(input: SaveAgentInput, options: WriteRequestOptions): Promise<SaveAgentResult>;
768
- /** 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. */
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. */
769
896
  saveAgentWithResponse(input: SaveAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAgentResult>>;
770
897
  /**
771
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.
@@ -786,13 +913,13 @@ export declare class Apostra extends Transport {
786
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. */
787
914
  saveAudienceWithResponse(input: SaveAudienceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAudienceResult>>;
788
915
  /**
789
- * 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.
790
917
  *
791
918
  * @example
792
919
  * await client.saveBilling(input, { idempotencyKey: 'stable-key' })
793
920
  */
794
921
  saveBilling(input: SaveBillingInput, options: WriteRequestOptions): Promise<SaveBillingResult>;
795
- /** 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. */
796
923
  saveBillingWithResponse(input: SaveBillingInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBillingResult>>;
797
924
  /**
798
925
  * Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview.
@@ -804,13 +931,13 @@ export declare class Apostra extends Transport {
804
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. */
805
932
  saveBusinessRulesWithResponse(input: SaveBusinessRulesInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBusinessRulesResult>>;
806
933
  /**
807
- * Create, rename, reconcile access, change lifecycle, or prepare a human credential handoff for one buyer agent per call.
934
+ * Create a buyer agent, or with id make one change: name, advertiser access, lifecycle state, or credential handoff.
808
935
  *
809
936
  * @example
810
937
  * await client.saveBuyerAgent(input, { idempotencyKey: 'stable-key' })
811
938
  */
812
939
  saveBuyerAgent(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<SaveBuyerAgentResult>;
813
- /** 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. */
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. */
814
941
  saveBuyerAgentWithResponse(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerAgentResult>>;
815
942
  /**
816
943
  * Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup.
@@ -822,22 +949,22 @@ export declare class Apostra extends Transport {
822
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. */
823
950
  saveBuyerOperatorWithResponse(input: SaveBuyerOperatorInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerOperatorResult>>;
824
951
  /**
825
- * 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.
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.
826
953
  *
827
954
  * @example
828
955
  * await client.saveCampaign(input, { idempotencyKey: 'stable-key' })
829
956
  */
830
957
  saveCampaign(input: SaveCampaignInput, options: WriteRequestOptions): Promise<SaveCampaignResult>;
831
- /** 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. */
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. */
832
959
  saveCampaignWithResponse(input: SaveCampaignInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCampaignResult>>;
833
960
  /**
834
- * Create or replace one flat catalog declaration by catalogId, or archive it with isArchived. URL saves refetch the feed.
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.
835
962
  *
836
963
  * @example
837
964
  * await client.saveCatalog(input, { idempotencyKey: 'stable-key' })
838
965
  */
839
966
  saveCatalog(input: SaveCatalogInput, options: WriteRequestOptions): Promise<SaveCatalogResult>;
840
- /** 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. */
967
+ /** 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. */
841
968
  saveCatalogWithResponse(input: SaveCatalogInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCatalogResult>>;
842
969
  /**
843
970
  * Manage seller or creative-engine authorization, accounts and advertiser mappings. Seller-only: reporting, selection, billing, policy, activation.
@@ -858,13 +985,13 @@ export declare class Apostra extends Transport {
858
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. */
859
986
  saveCoverageWithResponse(input: SaveCoverageInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCoverageResult>>;
860
987
  /**
861
- * 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.
862
989
  *
863
990
  * @example
864
991
  * await client.saveCreative(input, { idempotencyKey: 'stable-key' })
865
992
  */
866
993
  saveCreative(input: SaveCreativeInput, options: WriteRequestOptions): Promise<SaveCreativeResult>;
867
- /** 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. */
868
995
  saveCreativeWithResponse(input: SaveCreativeInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeResult>>;
869
996
  /**
870
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.
@@ -876,13 +1003,13 @@ export declare class Apostra extends Transport {
876
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. */
877
1004
  saveCreativeCollectionWithResponse(input: SaveCreativeCollectionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeCollectionResult>>;
878
1005
  /**
879
- * 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.
880
1007
  *
881
1008
  * @example
882
1009
  * await client.saveCreativeSession(input, { idempotencyKey: 'stable-key' })
883
1010
  */
884
1011
  saveCreativeSession(input: SaveCreativeSessionInput, options: WriteRequestOptions): Promise<SaveCreativeSessionResult>;
885
- /** 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. */
886
1013
  saveCreativeSessionWithResponse(input: SaveCreativeSessionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeSessionResult>>;
887
1014
  /**
888
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.
@@ -894,13 +1021,13 @@ export declare class Apostra extends Transport {
894
1021
  /** 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. */
895
1022
  saveDimensionWithResponse(input: SaveDimensionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveDimensionResult>>;
896
1023
  /**
897
- * 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.
1024
+ * 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.
898
1025
  *
899
1026
  * @example
900
1027
  * await client.saveDirectedCampaignSubscription(input, { idempotencyKey: 'stable-key' })
901
1028
  */
902
1029
  saveDirectedCampaignSubscription(input: SaveDirectedCampaignSubscriptionInput, options: WriteRequestOptions): Promise<SaveDirectedCampaignSubscriptionResult>;
903
- /** 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. */
1030
+ /** 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. */
904
1031
  saveDirectedCampaignSubscriptionWithResponse(input: SaveDirectedCampaignSubscriptionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveDirectedCampaignSubscriptionResult>>;
905
1032
  /**
906
1033
  * 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.
@@ -912,14 +1039,23 @@ export declare class Apostra extends Transport {
912
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. */
913
1040
  saveEventSourceWithResponse(input: SaveEventSourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveEventSourceResult>>;
914
1041
  /**
915
- * 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.
916
1043
  *
917
1044
  * @example
918
1045
  * await client.saveInventorySource(input, { idempotencyKey: 'stable-key' })
919
1046
  */
920
1047
  saveInventorySource(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<SaveInventorySourceResult>;
921
- /** 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. */
922
1049
  saveInventorySourceWithResponse(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveInventorySourceResult>>;
1050
+ /**
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.
1052
+ *
1053
+ * @example
1054
+ * await client.saveLesson(input, { idempotencyKey: 'stable-key' })
1055
+ */
1056
+ saveLesson(input: SaveLessonInput, options: WriteRequestOptions): Promise<SaveLessonResult>;
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. */
1058
+ saveLessonWithResponse(input: SaveLessonInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLessonResult>>;
923
1059
  /**
924
1060
  * Open a seller library request or close it with seller Material.
925
1061
  *
@@ -930,13 +1066,13 @@ export declare class Apostra extends Transport {
930
1066
  /** Open a seller library request or close it with seller Material. Returns the data together with response headers and request ID. */
931
1067
  saveLibraryRequestWithResponse(input: SaveLibraryRequestInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLibraryRequestResult>>;
932
1068
  /**
933
- * 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
934
1070
  *
935
1071
  * @example
936
1072
  * await client.saveMaterial(input, { idempotencyKey: 'stable-key' })
937
1073
  */
938
1074
  saveMaterial(input: SaveMaterialInput, options: WriteRequestOptions): Promise<SaveMaterialResult>;
939
- /** 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. */
940
1076
  saveMaterialWithResponse(input: SaveMaterialInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveMaterialResult>>;
941
1077
  /**
942
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.
@@ -957,49 +1093,58 @@ export declare class Apostra extends Transport {
957
1093
  /** 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. */
958
1094
  saveMediaKitWithResponse(input: SaveMediaKitInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveMediaKitResult>>;
959
1095
  /**
960
- * 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.
1096
+ * Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed.
961
1097
  *
962
1098
  * @example
963
1099
  * await client.saveNotificationConfig(input, { idempotencyKey: 'stable-key' })
964
1100
  */
965
1101
  saveNotificationConfig(input: SaveNotificationConfigInput, options: WriteRequestOptions): Promise<SaveNotificationConfigResult>;
966
- /** 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. */
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. */
967
1103
  saveNotificationConfigWithResponse(input: SaveNotificationConfigInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveNotificationConfigResult>>;
968
1104
  /**
969
- * 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.
970
1106
  *
971
1107
  * @example
972
1108
  * await client.savePlaybook(input, { idempotencyKey: 'stable-key' })
973
1109
  */
974
1110
  savePlaybook(input: SavePlaybookInput, options: WriteRequestOptions): Promise<SavePlaybookResult>;
975
- /** 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. */
976
1112
  savePlaybookWithResponse(input: SavePlaybookInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePlaybookResult>>;
977
1113
  /**
978
- * Create, update, archive, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
1114
+ * Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
979
1115
  *
980
1116
  * @example
981
1117
  * await client.savePropertyList(input, { idempotencyKey: 'stable-key' })
982
1118
  */
983
1119
  savePropertyList(input: SavePropertyListInput, options: WriteRequestOptions): Promise<SavePropertyListResult>;
984
- /** 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. */
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. */
985
1121
  savePropertyListWithResponse(input: SavePropertyListInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePropertyListResult>>;
986
1122
  /**
987
- * 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.
988
1124
  *
989
1125
  * @example
990
1126
  * await client.saveRfp(input, { idempotencyKey: 'stable-key' })
991
1127
  */
992
1128
  saveRfp(input: SaveRfpInput, options: WriteRequestOptions): Promise<SaveRfpResult>;
993
- /** 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. */
994
1130
  saveRfpWithResponse(input: SaveRfpInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveRfpResult>>;
995
1131
  /**
996
- * 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").
997
1142
  *
998
1143
  * @example
999
1144
  * await client.saveSeller(input, { idempotencyKey: 'stable-key' })
1000
1145
  */
1001
1146
  saveSeller(input: SaveSellerInput, options: WriteRequestOptions): Promise<SaveSellerResult>;
1002
- /** 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. */
1003
1148
  saveSellerWithResponse(input: SaveSellerInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveSellerResult>>;
1004
1149
  /**
1005
1150
  * Create, replace, or archive a signal. Managed writes need a complete draft; read before updates. Without sourceId, writes the seller catalog.
@@ -1056,3 +1201,4 @@ export declare class Apostra extends Transport {
1056
1201
  /** 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. */
1057
1202
  uploadCreativeAssetWithResponse(input: UploadCreativeAssetInput, options: WriteRequestOptions): Promise<ResponseDetails<UploadCreativeAssetResult>>;
1058
1203
  }
1204
+ export {};