@apostra/sdk 0.38.0 → 0.40.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.
- package/README.md +5 -2
- package/SKILL.md +1 -1
- package/dist/cli-login.d.ts +76 -0
- package/dist/cli-login.js +557 -0
- package/dist/generated/client.d.ts +183 -55
- package/dist/generated/client.js +119 -47
- package/dist/generated/metadata.d.ts +151 -36
- package/dist/generated/metadata.js +196 -41
- package/dist/generated/types.gen.d.ts +6297 -4792
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/dist/transport.js +14 -0
- package/llms.txt +1 -1
- package/package.json +11 -4
|
@@ -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"];
|
|
@@ -40,12 +43,24 @@ export type GetSellerReportingReceiptsError = Wire.GetSellerReportingReceiptsErr
|
|
|
40
43
|
export type GetStatusInput = Wire.GetStatusData['body'];
|
|
41
44
|
export type GetStatusResult = Wire.GetStatusResponses[200]['data'];
|
|
42
45
|
export type GetStatusError = Wire.GetStatusErrors[keyof Wire.GetStatusErrors];
|
|
46
|
+
export type LogEventInput = OptionalWireField<Wire.LogEventData['body'], "idempotencyKey">;
|
|
47
|
+
export type LogEventResult = Wire.LogEventResponses[200]['data'];
|
|
48
|
+
export type LogEventError = Wire.LogEventErrors[keyof Wire.LogEventErrors];
|
|
43
49
|
export type OpenAdvertisersPageInput = Wire.OpenAdvertisersPageData['body'];
|
|
44
50
|
export type OpenAdvertisersPageResult = Wire.OpenAdvertisersPageResponses[200]['data'];
|
|
45
51
|
export type OpenAdvertisersPageError = Wire.OpenAdvertisersPageErrors[keyof Wire.OpenAdvertisersPageErrors];
|
|
52
|
+
export type OpenAgentCertificationPageInput = Wire.OpenAgentCertificationPageData['body'];
|
|
53
|
+
export type OpenAgentCertificationPageResult = Wire.OpenAgentCertificationPageResponses[200]['data'];
|
|
54
|
+
export type OpenAgentCertificationPageError = Wire.OpenAgentCertificationPageErrors[keyof Wire.OpenAgentCertificationPageErrors];
|
|
46
55
|
export type OpenAgentPageInput = Wire.OpenAgentPageData['body'];
|
|
47
56
|
export type OpenAgentPageResult = Wire.OpenAgentPageResponses[200]['data'];
|
|
48
57
|
export type OpenAgentPageError = Wire.OpenAgentPageErrors[keyof Wire.OpenAgentPageErrors];
|
|
58
|
+
export type OpenAgentSourcesPageInput = Wire.OpenAgentSourcesPageData['body'];
|
|
59
|
+
export type OpenAgentSourcesPageResult = Wire.OpenAgentSourcesPageResponses[200]['data'];
|
|
60
|
+
export type OpenAgentSourcesPageError = Wire.OpenAgentSourcesPageErrors[keyof Wire.OpenAgentSourcesPageErrors];
|
|
61
|
+
export type OpenAgentWebhooksPageInput = Wire.OpenAgentWebhooksPageData['body'];
|
|
62
|
+
export type OpenAgentWebhooksPageResult = Wire.OpenAgentWebhooksPageResponses[200]['data'];
|
|
63
|
+
export type OpenAgentWebhooksPageError = Wire.OpenAgentWebhooksPageErrors[keyof Wire.OpenAgentWebhooksPageErrors];
|
|
49
64
|
export type OpenAgentsPageInput = Wire.OpenAgentsPageData['body'];
|
|
50
65
|
export type OpenAgentsPageResult = Wire.OpenAgentsPageResponses[200]['data'];
|
|
51
66
|
export type OpenAgentsPageError = Wire.OpenAgentsPageErrors[keyof Wire.OpenAgentsPageErrors];
|
|
@@ -67,9 +82,15 @@ export type OpenCreativeEnginesPageError = Wire.OpenCreativeEnginesPageErrors[ke
|
|
|
67
82
|
export type OpenCreativeLibraryInput = Wire.OpenCreativeLibraryData['body'];
|
|
68
83
|
export type OpenCreativeLibraryResult = Wire.OpenCreativeLibraryResponses[200]['data'];
|
|
69
84
|
export type OpenCreativeLibraryError = Wire.OpenCreativeLibraryErrors[keyof Wire.OpenCreativeLibraryErrors];
|
|
85
|
+
export type OpenDeveloperHomeInput = Wire.OpenDeveloperHomeData['body'];
|
|
86
|
+
export type OpenDeveloperHomeResult = Wire.OpenDeveloperHomeResponses[200]['data'];
|
|
87
|
+
export type OpenDeveloperHomeError = Wire.OpenDeveloperHomeErrors[keyof Wire.OpenDeveloperHomeErrors];
|
|
70
88
|
export type OpenMediaBuysPageInput = Wire.OpenMediaBuysPageData['body'];
|
|
71
89
|
export type OpenMediaBuysPageResult = Wire.OpenMediaBuysPageResponses[200]['data'];
|
|
72
90
|
export type OpenMediaBuysPageError = Wire.OpenMediaBuysPageErrors[keyof Wire.OpenMediaBuysPageErrors];
|
|
91
|
+
export type OpenMediaPartnersPageInput = Wire.OpenMediaPartnersPageData['body'];
|
|
92
|
+
export type OpenMediaPartnersPageResult = Wire.OpenMediaPartnersPageResponses[200]['data'];
|
|
93
|
+
export type OpenMediaPartnersPageError = Wire.OpenMediaPartnersPageErrors[keyof Wire.OpenMediaPartnersPageErrors];
|
|
73
94
|
export type OpenPageInput = Wire.OpenPageData['body'];
|
|
74
95
|
export type OpenPageResult = Wire.OpenPageResponses[200]['data'];
|
|
75
96
|
export type OpenPageError = Wire.OpenPageErrors[keyof Wire.OpenPageErrors];
|
|
@@ -88,6 +109,9 @@ export type RefreshInventorySourceHealthError = Wire.RefreshInventorySourceHealt
|
|
|
88
109
|
export type RequestBuyerChildAccountInput = OptionalWireField<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey">;
|
|
89
110
|
export type RequestBuyerChildAccountResult = Wire.RequestBuyerChildAccountResponses[200]['data'];
|
|
90
111
|
export type RequestBuyerChildAccountError = Wire.RequestBuyerChildAccountErrors[keyof Wire.RequestBuyerChildAccountErrors];
|
|
112
|
+
export type RequestPaymentAuthorityInput = Wire.RequestPaymentAuthorityData['body'];
|
|
113
|
+
export type RequestPaymentAuthorityResult = Wire.RequestPaymentAuthorityResponses[200]['data'];
|
|
114
|
+
export type RequestPaymentAuthorityError = Wire.RequestPaymentAuthorityErrors[keyof Wire.RequestPaymentAuthorityErrors];
|
|
91
115
|
export type RequestProposalsInput = OptionalWireField<Wire.RequestProposalsData['body'], "idempotencyKey">;
|
|
92
116
|
export type RequestProposalsResult = Wire.RequestProposalsResponses[200]['data'];
|
|
93
117
|
export type RequestProposalsError = Wire.RequestProposalsErrors[keyof Wire.RequestProposalsErrors];
|
|
@@ -103,9 +127,6 @@ export type SaveAccountError = Wire.SaveAccountErrors[keyof Wire.SaveAccountErro
|
|
|
103
127
|
export type SaveAdvertiserInput = Wire.SaveAdvertiserData['body'];
|
|
104
128
|
export type SaveAdvertiserResult = Wire.SaveAdvertiserResponses[200]['data'];
|
|
105
129
|
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
130
|
export type SaveAdvertiserGrantInput = Wire.SaveAdvertiserGrantData['body'];
|
|
110
131
|
export type SaveAdvertiserGrantResult = Wire.SaveAdvertiserGrantResponses[200]['data'];
|
|
111
132
|
export type SaveAdvertiserGrantError = Wire.SaveAdvertiserGrantErrors[keyof Wire.SaveAdvertiserGrantErrors];
|
|
@@ -190,9 +211,12 @@ export type SavePlaybookError = Wire.SavePlaybookErrors[keyof Wire.SavePlaybookE
|
|
|
190
211
|
export type SavePropertyListInput = Wire.SavePropertyListData['body'];
|
|
191
212
|
export type SavePropertyListResult = Wire.SavePropertyListResponses[200]['data'];
|
|
192
213
|
export type SavePropertyListError = Wire.SavePropertyListErrors[keyof Wire.SavePropertyListErrors];
|
|
193
|
-
export type SaveRfpInput = Wire.SaveRfpData['body']
|
|
214
|
+
export type SaveRfpInput = OptionalWireField<Wire.SaveRfpData['body'], "clientRequestId">;
|
|
194
215
|
export type SaveRfpResult = Wire.SaveRfpResponses[200]['data'];
|
|
195
216
|
export type SaveRfpError = Wire.SaveRfpErrors[keyof Wire.SaveRfpErrors];
|
|
217
|
+
export type SaveRfpTurnInput = OptionalWireField<Wire.SaveRfpTurnData['body'], "clientRequestId">;
|
|
218
|
+
export type SaveRfpTurnResult = Wire.SaveRfpTurnResponses[200]['data'];
|
|
219
|
+
export type SaveRfpTurnError = Wire.SaveRfpTurnErrors[keyof Wire.SaveRfpTurnErrors];
|
|
196
220
|
export type SaveSellerInput = Wire.SaveSellerData['body'];
|
|
197
221
|
export type SaveSellerResult = Wire.SaveSellerResponses[200]['data'];
|
|
198
222
|
export type SaveSellerError = Wire.SaveSellerErrors[keyof Wire.SaveSellerErrors];
|
|
@@ -215,6 +239,10 @@ export type UploadCreativeAssetInput = Wire.UploadCreativeAssetData['body'];
|
|
|
215
239
|
export type UploadCreativeAssetResult = Wire.UploadCreativeAssetResponses[200]['data'];
|
|
216
240
|
export type UploadCreativeAssetError = Wire.UploadCreativeAssetErrors[keyof Wire.UploadCreativeAssetErrors];
|
|
217
241
|
export interface OperationTypes {
|
|
242
|
+
"confirm_payment_authority": {
|
|
243
|
+
input: ConfirmPaymentAuthorityInput;
|
|
244
|
+
result: ConfirmPaymentAuthorityResult;
|
|
245
|
+
};
|
|
218
246
|
"downloadV3PublicDocumentRevision": {
|
|
219
247
|
input: DownloadV3PublicDocumentRevisionInput;
|
|
220
248
|
result: DownloadV3PublicDocumentRevisionResult;
|
|
@@ -251,14 +279,30 @@ export interface OperationTypes {
|
|
|
251
279
|
input: GetStatusInput;
|
|
252
280
|
result: GetStatusResult;
|
|
253
281
|
};
|
|
282
|
+
"log_event": {
|
|
283
|
+
input: LogEventInput;
|
|
284
|
+
result: LogEventResult;
|
|
285
|
+
};
|
|
254
286
|
"open_advertisers_page": {
|
|
255
287
|
input: OpenAdvertisersPageInput;
|
|
256
288
|
result: OpenAdvertisersPageResult;
|
|
257
289
|
};
|
|
290
|
+
"open_agent_certification_page": {
|
|
291
|
+
input: OpenAgentCertificationPageInput;
|
|
292
|
+
result: OpenAgentCertificationPageResult;
|
|
293
|
+
};
|
|
258
294
|
"open_agent_page": {
|
|
259
295
|
input: OpenAgentPageInput;
|
|
260
296
|
result: OpenAgentPageResult;
|
|
261
297
|
};
|
|
298
|
+
"open_agent_sources_page": {
|
|
299
|
+
input: OpenAgentSourcesPageInput;
|
|
300
|
+
result: OpenAgentSourcesPageResult;
|
|
301
|
+
};
|
|
302
|
+
"open_agent_webhooks_page": {
|
|
303
|
+
input: OpenAgentWebhooksPageInput;
|
|
304
|
+
result: OpenAgentWebhooksPageResult;
|
|
305
|
+
};
|
|
262
306
|
"open_agents_page": {
|
|
263
307
|
input: OpenAgentsPageInput;
|
|
264
308
|
result: OpenAgentsPageResult;
|
|
@@ -287,10 +331,18 @@ export interface OperationTypes {
|
|
|
287
331
|
input: OpenCreativeLibraryInput;
|
|
288
332
|
result: OpenCreativeLibraryResult;
|
|
289
333
|
};
|
|
334
|
+
"open_developer_home": {
|
|
335
|
+
input: OpenDeveloperHomeInput;
|
|
336
|
+
result: OpenDeveloperHomeResult;
|
|
337
|
+
};
|
|
290
338
|
"open_media_buys_page": {
|
|
291
339
|
input: OpenMediaBuysPageInput;
|
|
292
340
|
result: OpenMediaBuysPageResult;
|
|
293
341
|
};
|
|
342
|
+
"open_media_partners_page": {
|
|
343
|
+
input: OpenMediaPartnersPageInput;
|
|
344
|
+
result: OpenMediaPartnersPageResult;
|
|
345
|
+
};
|
|
294
346
|
"open_page": {
|
|
295
347
|
input: OpenPageInput;
|
|
296
348
|
result: OpenPageResult;
|
|
@@ -315,6 +367,10 @@ export interface OperationTypes {
|
|
|
315
367
|
input: RequestBuyerChildAccountInput;
|
|
316
368
|
result: RequestBuyerChildAccountResult;
|
|
317
369
|
};
|
|
370
|
+
"request_payment_authority": {
|
|
371
|
+
input: RequestPaymentAuthorityInput;
|
|
372
|
+
result: RequestPaymentAuthorityResult;
|
|
373
|
+
};
|
|
318
374
|
"request_proposals": {
|
|
319
375
|
input: RequestProposalsInput;
|
|
320
376
|
result: RequestProposalsResult;
|
|
@@ -335,10 +391,6 @@ export interface OperationTypes {
|
|
|
335
391
|
input: SaveAdvertiserInput;
|
|
336
392
|
result: SaveAdvertiserResult;
|
|
337
393
|
};
|
|
338
|
-
"save_advertiser_access": {
|
|
339
|
-
input: SaveAdvertiserAccessInput;
|
|
340
|
-
result: SaveAdvertiserAccessResult;
|
|
341
|
-
};
|
|
342
394
|
"save_advertiser_grant": {
|
|
343
395
|
input: SaveAdvertiserGrantInput;
|
|
344
396
|
result: SaveAdvertiserGrantResult;
|
|
@@ -455,6 +507,10 @@ export interface OperationTypes {
|
|
|
455
507
|
input: SaveRfpInput;
|
|
456
508
|
result: SaveRfpResult;
|
|
457
509
|
};
|
|
510
|
+
"save_rfp_turn": {
|
|
511
|
+
input: SaveRfpTurnInput;
|
|
512
|
+
result: SaveRfpTurnResult;
|
|
513
|
+
};
|
|
458
514
|
"save_seller": {
|
|
459
515
|
input: SaveSellerInput;
|
|
460
516
|
result: SaveSellerResult;
|
|
@@ -485,6 +541,15 @@ export interface OperationTypes {
|
|
|
485
541
|
};
|
|
486
542
|
}
|
|
487
543
|
export declare class Apostra extends Transport {
|
|
544
|
+
/**
|
|
545
|
+
* Issue the hosted card-capture link for a token from request_payment_authority. Give the link to the cardholder; cards stay off MCP.
|
|
546
|
+
*
|
|
547
|
+
* @example
|
|
548
|
+
* await client.confirmPaymentAuthority(input, { idempotencyKey: 'stable-key' })
|
|
549
|
+
*/
|
|
550
|
+
confirmPaymentAuthority(input: ConfirmPaymentAuthorityInput, options: WriteRequestOptions): Promise<ConfirmPaymentAuthorityResult>;
|
|
551
|
+
/** 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. */
|
|
552
|
+
confirmPaymentAuthorityWithResponse(input: ConfirmPaymentAuthorityInput, options: WriteRequestOptions): Promise<ResponseDetails<ConfirmPaymentAuthorityResult>>;
|
|
488
553
|
/**
|
|
489
554
|
* Download a public immutable document revision
|
|
490
555
|
*
|
|
@@ -558,14 +623,23 @@ export declare class Apostra extends Transport {
|
|
|
558
623
|
/** 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
624
|
getSellerReportingReceiptsWithResponse(input: GetSellerReportingReceiptsInput, options?: RequestOptions): Promise<ResponseDetails<GetSellerReportingReceiptsResult>>;
|
|
560
625
|
/**
|
|
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.
|
|
626
|
+
* 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
627
|
*
|
|
563
628
|
* @example
|
|
564
629
|
* await client.getStatus(input)
|
|
565
630
|
*/
|
|
566
631
|
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. */
|
|
632
|
+
/** 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
633
|
getStatusWithResponse(input?: GetStatusInput, options?: RequestOptions): Promise<ResponseDetails<GetStatusResult>>;
|
|
634
|
+
/**
|
|
635
|
+
* Send up to 10,000 AdCP conversion events (log_event) to an event source the advertiser registered with save_event_source. Events must also pass the v2 rules: no raw email or phone in user_match, each event_type + event_id once per call. One invalid event refuses the whole call.
|
|
636
|
+
*
|
|
637
|
+
* @example
|
|
638
|
+
* await client.logEvent(input, { idempotencyKey: 'stable-key' })
|
|
639
|
+
*/
|
|
640
|
+
logEvent(input: LogEventInput, options: WriteRequestOptions): Promise<LogEventResult>;
|
|
641
|
+
/** Send up to 10,000 AdCP conversion events (log_event) to an event source the advertiser registered with save_event_source. Events must also pass the v2 rules: no raw email or phone in user_match, each event_type + event_id once per call. One invalid event refuses the whole call. Returns the data together with response headers and request ID. */
|
|
642
|
+
logEventWithResponse(input: LogEventInput, options: WriteRequestOptions): Promise<ResponseDetails<LogEventResult>>;
|
|
569
643
|
/**
|
|
570
644
|
* 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").
|
|
571
645
|
*
|
|
@@ -575,6 +649,15 @@ export declare class Apostra extends Transport {
|
|
|
575
649
|
openAdvertisersPage(input: OpenAdvertisersPageInput, options?: RequestOptions): Promise<OpenAdvertisersPageResult>;
|
|
576
650
|
/** 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
651
|
openAdvertisersPageWithResponse(input: OpenAdvertisersPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAdvertisersPageResult>>;
|
|
652
|
+
/**
|
|
653
|
+
* Open one agent’s Test & certify Page: live certification per use case, recent test runs, AdCP 4.0 readiness and capability declarations. Read-only.
|
|
654
|
+
*
|
|
655
|
+
* @example
|
|
656
|
+
* await client.openAgentCertificationPage(input)
|
|
657
|
+
*/
|
|
658
|
+
openAgentCertificationPage(input: OpenAgentCertificationPageInput, options?: RequestOptions): Promise<OpenAgentCertificationPageResult>;
|
|
659
|
+
/** 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. */
|
|
660
|
+
openAgentCertificationPageWithResponse(input: OpenAgentCertificationPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentCertificationPageResult>>;
|
|
578
661
|
/**
|
|
579
662
|
* Open one agent owned by this Developer account.
|
|
580
663
|
*
|
|
@@ -584,6 +667,24 @@ export declare class Apostra extends Transport {
|
|
|
584
667
|
openAgentPage(input: OpenAgentPageInput, options?: RequestOptions): Promise<OpenAgentPageResult>;
|
|
585
668
|
/** Open one agent owned by this Developer account. Returns the data together with response headers and request ID. */
|
|
586
669
|
openAgentPageWithResponse(input: OpenAgentPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentPageResult>>;
|
|
670
|
+
/**
|
|
671
|
+
* Open one agent’s Inventory sources Page: the inventory sources it powers and the health of each. Read-only.
|
|
672
|
+
*
|
|
673
|
+
* @example
|
|
674
|
+
* await client.openAgentSourcesPage(input)
|
|
675
|
+
*/
|
|
676
|
+
openAgentSourcesPage(input: OpenAgentSourcesPageInput, options?: RequestOptions): Promise<OpenAgentSourcesPageResult>;
|
|
677
|
+
/** 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. */
|
|
678
|
+
openAgentSourcesPageWithResponse(input: OpenAgentSourcesPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentSourcesPageResult>>;
|
|
679
|
+
/**
|
|
680
|
+
* Open one agent’s Webhooks Page: its recent inbound webhook outcomes, each refusal with its reason. Read-only.
|
|
681
|
+
*
|
|
682
|
+
* @example
|
|
683
|
+
* await client.openAgentWebhooksPage(input)
|
|
684
|
+
*/
|
|
685
|
+
openAgentWebhooksPage(input: OpenAgentWebhooksPageInput, options?: RequestOptions): Promise<OpenAgentWebhooksPageResult>;
|
|
686
|
+
/** 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. */
|
|
687
|
+
openAgentWebhooksPageWithResponse(input: OpenAgentWebhooksPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentWebhooksPageResult>>;
|
|
587
688
|
/**
|
|
588
689
|
* Open Build an agent for this Developer account.
|
|
589
690
|
*
|
|
@@ -621,13 +722,13 @@ export declare class Apostra extends Transport {
|
|
|
621
722
|
/** 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
723
|
openCampaignsPageWithResponse(input: OpenCampaignsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenCampaignsPageResult>>;
|
|
623
724
|
/**
|
|
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.
|
|
725
|
+
* 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
726
|
*
|
|
626
727
|
* @example
|
|
627
728
|
* await client.openConnectionsPage(input)
|
|
628
729
|
*/
|
|
629
730
|
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. */
|
|
731
|
+
/** 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
732
|
openConnectionsPageWithResponse(input: OpenConnectionsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenConnectionsPageResult>>;
|
|
632
733
|
/**
|
|
633
734
|
* 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 +749,40 @@ export declare class Apostra extends Transport {
|
|
|
648
749
|
/** 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
750
|
openCreativeLibraryWithResponse(input: OpenCreativeLibraryInput, options: WriteRequestOptions): Promise<ResponseDetails<OpenCreativeLibraryResult>>;
|
|
650
751
|
/**
|
|
651
|
-
* Open the
|
|
752
|
+
* Open the Developer home for this Developer account: its agents, their stages and what to do next.
|
|
753
|
+
*
|
|
754
|
+
* @example
|
|
755
|
+
* await client.openDeveloperHome(input)
|
|
756
|
+
*/
|
|
757
|
+
openDeveloperHome(input: OpenDeveloperHomeInput, options?: RequestOptions): Promise<OpenDeveloperHomeResult>;
|
|
758
|
+
/** 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. */
|
|
759
|
+
openDeveloperHomeWithResponse(input: OpenDeveloperHomeInput, options?: RequestOptions): Promise<ResponseDetails<OpenDeveloperHomeResult>>;
|
|
760
|
+
/**
|
|
761
|
+
* 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
762
|
*
|
|
653
763
|
* @example
|
|
654
764
|
* await client.openMediaBuysPage(input)
|
|
655
765
|
*/
|
|
656
766
|
openMediaBuysPage(input: OpenMediaBuysPageInput, options?: RequestOptions): Promise<OpenMediaBuysPageResult>;
|
|
657
|
-
/** Open the Seller Media Buys Page. Optionally focus one seller
|
|
767
|
+
/** 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
768
|
openMediaBuysPageWithResponse(input: OpenMediaBuysPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenMediaBuysPageResult>>;
|
|
659
769
|
/**
|
|
660
|
-
* Open
|
|
770
|
+
* 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.
|
|
771
|
+
*
|
|
772
|
+
* @example
|
|
773
|
+
* await client.openMediaPartnersPage(input)
|
|
774
|
+
*/
|
|
775
|
+
openMediaPartnersPage(input: OpenMediaPartnersPageInput, options?: RequestOptions): Promise<OpenMediaPartnersPageResult>;
|
|
776
|
+
/** 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. */
|
|
777
|
+
openMediaPartnersPageWithResponse(input: OpenMediaPartnersPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenMediaPartnersPageResult>>;
|
|
778
|
+
/**
|
|
779
|
+
* 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
780
|
*
|
|
662
781
|
* @example
|
|
663
782
|
* await client.openPage(input)
|
|
664
783
|
*/
|
|
665
784
|
openPage(input: OpenPageInput, options?: RequestOptions): Promise<OpenPageResult>;
|
|
666
|
-
/** Open a compatibility Page.
|
|
785
|
+
/** 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
786
|
openPageWithResponse(input: OpenPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenPageResult>>;
|
|
668
787
|
/**
|
|
669
788
|
* 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 +812,13 @@ export declare class Apostra extends Transport {
|
|
|
693
812
|
/** 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
813
|
openVariantGalleryWithResponse(input: OpenVariantGalleryInput, options?: RequestOptions): Promise<ResponseDetails<OpenVariantGalleryResult>>;
|
|
695
814
|
/**
|
|
696
|
-
* Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and
|
|
815
|
+
* 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
816
|
*
|
|
698
817
|
* @example
|
|
699
818
|
* await client.refreshInventorySourceHealth(input, { idempotencyKey: 'stable-key' })
|
|
700
819
|
*/
|
|
701
820
|
refreshInventorySourceHealth(input: RefreshInventorySourceHealthInput, options: WriteRequestOptions): Promise<RefreshInventorySourceHealthResult>;
|
|
702
|
-
/** Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and
|
|
821
|
+
/** 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
822
|
refreshInventorySourceHealthWithResponse(input: RefreshInventorySourceHealthInput, options: WriteRequestOptions): Promise<ResponseDetails<RefreshInventorySourceHealthResult>>;
|
|
704
823
|
/**
|
|
705
824
|
* 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 +830,22 @@ export declare class Apostra extends Transport {
|
|
|
711
830
|
/** 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
831
|
requestBuyerChildAccountWithResponse(input: RequestBuyerChildAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestBuyerChildAccountResult>>;
|
|
713
832
|
/**
|
|
714
|
-
*
|
|
833
|
+
* Stage a card handoff for the organization and return a confirmation token. No link is issued until confirm_payment_authority.
|
|
834
|
+
*
|
|
835
|
+
* @example
|
|
836
|
+
* await client.requestPaymentAuthority(input, { idempotencyKey: 'stable-key' })
|
|
837
|
+
*/
|
|
838
|
+
requestPaymentAuthority(input: RequestPaymentAuthorityInput, options: WriteRequestOptions): Promise<RequestPaymentAuthorityResult>;
|
|
839
|
+
/** 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. */
|
|
840
|
+
requestPaymentAuthorityWithResponse(input: RequestPaymentAuthorityInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestPaymentAuthorityResult>>;
|
|
841
|
+
/**
|
|
842
|
+
* 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
843
|
*
|
|
716
844
|
* @example
|
|
717
845
|
* await client.requestProposals(input, { idempotencyKey: 'stable-key' })
|
|
718
846
|
*/
|
|
719
847
|
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. */
|
|
848
|
+
/** 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
849
|
requestProposalsWithResponse(input: RequestProposalsInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestProposalsResult>>;
|
|
722
850
|
/**
|
|
723
851
|
* Requests a scheduler-run reporting refresh or a bounded replay for one seller media buy. It never polls a provider directly.
|
|
@@ -738,13 +866,13 @@ export declare class Apostra extends Transport {
|
|
|
738
866
|
/** 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
867
|
reviewBuyerChildAccountWithResponse(input: ReviewBuyerChildAccountInput, options?: RequestOptions): Promise<ResponseDetails<ReviewBuyerChildAccountResult>>;
|
|
740
868
|
/**
|
|
741
|
-
*
|
|
869
|
+
* 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
870
|
*
|
|
743
871
|
* @example
|
|
744
872
|
* await client.saveAccount(input, { idempotencyKey: 'stable-key' })
|
|
745
873
|
*/
|
|
746
874
|
saveAccount(input: SaveAccountInput, options: WriteRequestOptions): Promise<SaveAccountResult>;
|
|
747
|
-
/**
|
|
875
|
+
/** 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
876
|
saveAccountWithResponse(input: SaveAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAccountResult>>;
|
|
749
877
|
/**
|
|
750
878
|
* 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 +883,6 @@ export declare class Apostra extends Transport {
|
|
|
755
883
|
saveAdvertiser(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<SaveAdvertiserResult>;
|
|
756
884
|
/** 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
885
|
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
886
|
/**
|
|
768
887
|
* 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
888
|
*
|
|
@@ -783,13 +902,13 @@ export declare class Apostra extends Transport {
|
|
|
783
902
|
/** 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
903
|
saveAdvertiserInstructionsWithResponse(input: SaveAdvertiserInstructionsInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserInstructionsResult>>;
|
|
785
904
|
/**
|
|
786
|
-
*
|
|
905
|
+
* 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
906
|
*
|
|
788
907
|
* @example
|
|
789
908
|
* await client.saveAgent(input, { idempotencyKey: 'stable-key' })
|
|
790
909
|
*/
|
|
791
910
|
saveAgent(input: SaveAgentInput, options: WriteRequestOptions): Promise<SaveAgentResult>;
|
|
792
|
-
/**
|
|
911
|
+
/** 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
912
|
saveAgentWithResponse(input: SaveAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAgentResult>>;
|
|
794
913
|
/**
|
|
795
914
|
* 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 +929,13 @@ export declare class Apostra extends Transport {
|
|
|
810
929
|
/** 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
930
|
saveAudienceWithResponse(input: SaveAudienceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAudienceResult>>;
|
|
812
931
|
/**
|
|
813
|
-
* Accept Terms, set
|
|
932
|
+
* Accept Terms, set the payment terms sellers are asked for, or accept a plan, answer its offer and change its renewal. Accepting a plan needs an administrator to approve it on our site. Cards stay off MCP.
|
|
814
933
|
*
|
|
815
934
|
* @example
|
|
816
935
|
* await client.saveBilling(input, { idempotencyKey: 'stable-key' })
|
|
817
936
|
*/
|
|
818
937
|
saveBilling(input: SaveBillingInput, options: WriteRequestOptions): Promise<SaveBillingResult>;
|
|
819
|
-
/** Accept Terms, set
|
|
938
|
+
/** Accept Terms, set the payment terms sellers are asked for, or accept a plan, answer its offer and change its renewal. Accepting a plan needs an administrator to approve it on our site. Cards stay off MCP. Returns the data together with response headers and request ID. */
|
|
820
939
|
saveBillingWithResponse(input: SaveBillingInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBillingResult>>;
|
|
821
940
|
/**
|
|
822
941
|
* Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview.
|
|
@@ -828,13 +947,13 @@ export declare class Apostra extends Transport {
|
|
|
828
947
|
/** 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
948
|
saveBusinessRulesWithResponse(input: SaveBusinessRulesInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBusinessRulesResult>>;
|
|
830
949
|
/**
|
|
831
|
-
* Create or
|
|
950
|
+
* Create a buyer agent, or with id make one change: name, advertiser access, lifecycle state, or credential handoff.
|
|
832
951
|
*
|
|
833
952
|
* @example
|
|
834
953
|
* await client.saveBuyerAgent(input, { idempotencyKey: 'stable-key' })
|
|
835
954
|
*/
|
|
836
955
|
saveBuyerAgent(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<SaveBuyerAgentResult>;
|
|
837
|
-
/** Create or
|
|
956
|
+
/** 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
957
|
saveBuyerAgentWithResponse(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerAgentResult>>;
|
|
839
958
|
/**
|
|
840
959
|
* Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup.
|
|
@@ -846,13 +965,13 @@ export declare class Apostra extends Transport {
|
|
|
846
965
|
/** 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
966
|
saveBuyerOperatorWithResponse(input: SaveBuyerOperatorInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerOperatorResult>>;
|
|
848
967
|
/**
|
|
849
|
-
*
|
|
968
|
+
* 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
969
|
*
|
|
851
970
|
* @example
|
|
852
971
|
* await client.saveCampaign(input, { idempotencyKey: 'stable-key' })
|
|
853
972
|
*/
|
|
854
973
|
saveCampaign(input: SaveCampaignInput, options: WriteRequestOptions): Promise<SaveCampaignResult>;
|
|
855
|
-
/**
|
|
974
|
+
/** 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
975
|
saveCampaignWithResponse(input: SaveCampaignInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCampaignResult>>;
|
|
857
976
|
/**
|
|
858
977
|
* 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 +1001,13 @@ export declare class Apostra extends Transport {
|
|
|
882
1001
|
/** 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
1002
|
saveCoverageWithResponse(input: SaveCoverageInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCoverageResult>>;
|
|
884
1003
|
/**
|
|
885
|
-
*
|
|
1004
|
+
* 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
1005
|
*
|
|
887
1006
|
* @example
|
|
888
1007
|
* await client.saveCreative(input, { idempotencyKey: 'stable-key' })
|
|
889
1008
|
*/
|
|
890
1009
|
saveCreative(input: SaveCreativeInput, options: WriteRequestOptions): Promise<SaveCreativeResult>;
|
|
891
|
-
/**
|
|
1010
|
+
/** 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
1011
|
saveCreativeWithResponse(input: SaveCreativeInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeResult>>;
|
|
893
1012
|
/**
|
|
894
1013
|
* 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 +1019,13 @@ export declare class Apostra extends Transport {
|
|
|
900
1019
|
/** 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
1020
|
saveCreativeCollectionWithResponse(input: SaveCreativeCollectionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeCollectionResult>>;
|
|
902
1021
|
/**
|
|
903
|
-
*
|
|
1022
|
+
* 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
1023
|
*
|
|
905
1024
|
* @example
|
|
906
1025
|
* await client.saveCreativeSession(input, { idempotencyKey: 'stable-key' })
|
|
907
1026
|
*/
|
|
908
1027
|
saveCreativeSession(input: SaveCreativeSessionInput, options: WriteRequestOptions): Promise<SaveCreativeSessionResult>;
|
|
909
|
-
/**
|
|
1028
|
+
/** 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
1029
|
saveCreativeSessionWithResponse(input: SaveCreativeSessionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeSessionResult>>;
|
|
911
1030
|
/**
|
|
912
1031
|
* 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 +1055,22 @@ export declare class Apostra extends Transport {
|
|
|
936
1055
|
/** 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
1056
|
saveEventSourceWithResponse(input: SaveEventSourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveEventSourceResult>>;
|
|
938
1057
|
/**
|
|
939
|
-
* Create or update where a seller's inventory comes from. Pass `id` to change
|
|
1058
|
+
* 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
1059
|
*
|
|
941
1060
|
* @example
|
|
942
1061
|
* await client.saveInventorySource(input, { idempotencyKey: 'stable-key' })
|
|
943
1062
|
*/
|
|
944
1063
|
saveInventorySource(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<SaveInventorySourceResult>;
|
|
945
|
-
/** Create or update where a seller's inventory comes from. Pass `id` to change
|
|
1064
|
+
/** 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
1065
|
saveInventorySourceWithResponse(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveInventorySourceResult>>;
|
|
947
1066
|
/**
|
|
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.
|
|
1067
|
+
* Manage seller lessons in a seller account; send the accountId of that account. 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
1068
|
*
|
|
950
1069
|
* @example
|
|
951
1070
|
* await client.saveLesson(input, { idempotencyKey: 'stable-key' })
|
|
952
1071
|
*/
|
|
953
1072
|
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. */
|
|
1073
|
+
/** Manage seller lessons in a seller account; send the accountId of that account. 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
1074
|
saveLessonWithResponse(input: SaveLessonInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLessonResult>>;
|
|
956
1075
|
/**
|
|
957
1076
|
* Open a seller library request or close it with seller Material.
|
|
@@ -963,13 +1082,13 @@ export declare class Apostra extends Transport {
|
|
|
963
1082
|
/** Open a seller library request or close it with seller Material. Returns the data together with response headers and request ID. */
|
|
964
1083
|
saveLibraryRequestWithResponse(input: SaveLibraryRequestInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLibraryRequestResult>>;
|
|
965
1084
|
/**
|
|
966
|
-
*
|
|
1085
|
+
* 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
1086
|
*
|
|
968
1087
|
* @example
|
|
969
1088
|
* await client.saveMaterial(input, { idempotencyKey: 'stable-key' })
|
|
970
1089
|
*/
|
|
971
1090
|
saveMaterial(input: SaveMaterialInput, options: WriteRequestOptions): Promise<SaveMaterialResult>;
|
|
972
|
-
/**
|
|
1091
|
+
/** 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
1092
|
saveMaterialWithResponse(input: SaveMaterialInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveMaterialResult>>;
|
|
974
1093
|
/**
|
|
975
1094
|
* 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 +1118,13 @@ export declare class Apostra extends Transport {
|
|
|
999
1118
|
/** 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
1119
|
saveNotificationConfigWithResponse(input: SaveNotificationConfigInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveNotificationConfigResult>>;
|
|
1001
1120
|
/**
|
|
1002
|
-
* Write
|
|
1121
|
+
* 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
1122
|
*
|
|
1004
1123
|
* @example
|
|
1005
1124
|
* await client.savePlaybook(input, { idempotencyKey: 'stable-key' })
|
|
1006
1125
|
*/
|
|
1007
1126
|
savePlaybook(input: SavePlaybookInput, options: WriteRequestOptions): Promise<SavePlaybookResult>;
|
|
1008
|
-
/** Write
|
|
1127
|
+
/** 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
1128
|
savePlaybookWithResponse(input: SavePlaybookInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePlaybookResult>>;
|
|
1010
1129
|
/**
|
|
1011
1130
|
* Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
|
|
@@ -1017,22 +1136,31 @@ export declare class Apostra extends Transport {
|
|
|
1017
1136
|
/** 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
1137
|
savePropertyListWithResponse(input: SavePropertyListInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePropertyListResult>>;
|
|
1019
1138
|
/**
|
|
1020
|
-
* Save
|
|
1139
|
+
* 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
1140
|
*
|
|
1022
1141
|
* @example
|
|
1023
1142
|
* await client.saveRfp(input, { idempotencyKey: 'stable-key' })
|
|
1024
1143
|
*/
|
|
1025
1144
|
saveRfp(input: SaveRfpInput, options: WriteRequestOptions): Promise<SaveRfpResult>;
|
|
1026
|
-
/** Save
|
|
1145
|
+
/** 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
1146
|
saveRfpWithResponse(input: SaveRfpInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveRfpResult>>;
|
|
1028
1147
|
/**
|
|
1029
|
-
*
|
|
1148
|
+
* 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.
|
|
1149
|
+
*
|
|
1150
|
+
* @example
|
|
1151
|
+
* await client.saveRfpTurn(input, { idempotencyKey: 'stable-key' })
|
|
1152
|
+
*/
|
|
1153
|
+
saveRfpTurn(input: SaveRfpTurnInput, options: WriteRequestOptions): Promise<SaveRfpTurnResult>;
|
|
1154
|
+
/** 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. */
|
|
1155
|
+
saveRfpTurnWithResponse(input: SaveRfpTurnInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveRfpTurnResult>>;
|
|
1156
|
+
/**
|
|
1157
|
+
* 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
1158
|
*
|
|
1031
1159
|
* @example
|
|
1032
1160
|
* await client.saveSeller(input, { idempotencyKey: 'stable-key' })
|
|
1033
1161
|
*/
|
|
1034
1162
|
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
|
|
1163
|
+
/** 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
1164
|
saveSellerWithResponse(input: SaveSellerInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveSellerResult>>;
|
|
1037
1165
|
/**
|
|
1038
1166
|
* Create, replace, or archive a signal. Managed writes need a complete draft; read before updates. Without sourceId, writes the seller catalog.
|