@apostra/sdk 0.0.0-stage → 0.37.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.
Files changed (18) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +117 -2
  3. package/SKILL.md +29 -0
  4. package/dist/generated/client.d.ts +1058 -0
  5. package/dist/generated/client.js +588 -0
  6. package/dist/generated/metadata.d.ts +960 -0
  7. package/dist/generated/metadata.js +1300 -0
  8. package/dist/generated/types.gen.d.ts +30093 -0
  9. package/dist/generated/types.gen.js +2 -0
  10. package/dist/index.d.ts +4 -0
  11. package/dist/index.js +3 -0
  12. package/dist/transport.d.ts +142 -0
  13. package/dist/transport.js +600 -0
  14. package/dist/webhooks.d.ts +24 -0
  15. package/dist/webhooks.js +49 -0
  16. package/examples/first-value.ts +58 -0
  17. package/llms.txt +11 -0
  18. package/package.json +60 -4
package/dist/generated/metadata.js ADDED
@@ -0,0 +1,1300 @@
1
+ // Generated. Do not edit.
2
+ export const version = '0.37.0';
3
+ export const baseUrl = "https://api.apostra.com/api/v3";
4
+ export const m2mTokenUrl = "https://identity.scope3.com/oauth2/token";
5
+ export const operations = {
6
+ "downloadV3PublicDocumentRevision": {
7
+ "path": "/documents/{documentId}/revisions/{revisionId}/download",
8
+ "method": "GET",
9
+ "body": false,
10
+ "binary": true,
11
+ "idempotencyKey": false,
12
+ "parameters": [
13
+ {
14
+ "name": "documentId",
15
+ "location": "path",
16
+ "required": true
17
+ },
18
+ {
19
+ "name": "revisionId",
20
+ "location": "path",
21
+ "required": true
22
+ }
23
+ ],
24
+ "security": [
25
+ {
26
+ "apiKeyAuth": []
27
+ },
28
+ {
29
+ "m2mOAuth": [
30
+ "interchange:read"
31
+ ]
32
+ }
33
+ ],
34
+ "summary": "Download a public immutable document revision"
35
+ },
36
+ "generate_variants": {
37
+ "path": "/tools/generate_variants",
38
+ "method": "POST",
39
+ "body": true,
40
+ "binary": false,
41
+ "idempotencyKey": true,
42
+ "parameters": [],
43
+ "security": [
44
+ {
45
+ "apiKeyAuth": []
46
+ },
47
+ {
48
+ "m2mOAuth": [
49
+ "interchange:write"
50
+ ]
51
+ }
52
+ ],
53
+ "summary": "Generate or refine new image, hosted video, or voice/audio (radio spots, voiceovers) from a saved Creative Engines brief. Reuse actionKey for an identical retry."
54
+ },
55
+ "get": {
56
+ "path": "/tools/get",
57
+ "method": "POST",
58
+ "body": true,
59
+ "binary": false,
60
+ "idempotencyKey": false,
61
+ "parameters": [],
62
+ "security": [
63
+ {
64
+ "apiKeyAuth": []
65
+ },
66
+ {
67
+ "m2mOAuth": [
68
+ "interchange:read"
69
+ ]
70
+ }
71
+ ],
72
+ "summary": "Read one object by kind plus the id that search returned, or an account singleton with no id. Never guess an id. include adds detail; each include value works only for the kinds that serve it."
73
+ },
74
+ "getV3PublicDocumentRevisionSections": {
75
+ "path": "/documents/{documentId}/revisions/{revisionId}/sections",
76
+ "method": "GET",
77
+ "body": false,
78
+ "binary": false,
79
+ "idempotencyKey": false,
80
+ "parameters": [
81
+ {
82
+ "name": "documentId",
83
+ "location": "path",
84
+ "required": true
85
+ },
86
+ {
87
+ "name": "revisionId",
88
+ "location": "path",
89
+ "required": true
90
+ },
91
+ {
92
+ "name": "section",
93
+ "location": "query",
94
+ "required": false
95
+ },
96
+ {
97
+ "name": "query",
98
+ "location": "query",
99
+ "required": false
100
+ },
101
+ {
102
+ "name": "cursor",
103
+ "location": "query",
104
+ "required": false
105
+ },
106
+ {
107
+ "name": "asOf",
108
+ "location": "query",
109
+ "required": false
110
+ }
111
+ ],
112
+ "security": [
113
+ {
114
+ "apiKeyAuth": []
115
+ },
116
+ {
117
+ "m2mOAuth": [
118
+ "interchange:read"
119
+ ]
120
+ }
121
+ ],
122
+ "summary": "Read a bounded public immutable document revision"
123
+ },
124
+ "getV3PublicMutationReceipt": {
125
+ "path": "/receipts/{receiptId}",
126
+ "method": "GET",
127
+ "body": false,
128
+ "binary": false,
129
+ "idempotencyKey": false,
130
+ "parameters": [
131
+ {
132
+ "name": "receiptId",
133
+ "location": "path",
134
+ "required": true
135
+ }
136
+ ],
137
+ "security": [
138
+ {
139
+ "apiKeyAuth": []
140
+ },
141
+ {
142
+ "m2mOAuth": [
143
+ "interchange:read"
144
+ ]
145
+ },
146
+ {
147
+ "m2mOAuth": [
148
+ "interchange:write"
149
+ ]
150
+ }
151
+ ],
152
+ "summary": "Read the state of a V3 HTTP write receipt"
153
+ },
154
+ "get_delivery": {
155
+ "path": "/tools/get_delivery",
156
+ "method": "POST",
157
+ "body": true,
158
+ "binary": false,
159
+ "idempotencyKey": false,
160
+ "parameters": [],
161
+ "security": [
162
+ {
163
+ "apiKeyAuth": []
164
+ },
165
+ {
166
+ "m2mOAuth": [
167
+ "interchange:read"
168
+ ]
169
+ }
170
+ ],
171
+ "summary": "Query seller delivery, stored or live buyer campaign delivery, or margin facts. Use live_campaign_delivery with one campaignId for the connected provider's current response. campaign_delivery preserves stored rows, totals, and paging. Buyer measurement is excluded."
172
+ },
173
+ "get_rfp_performance": {
174
+ "path": "/tools/get_rfp_performance",
175
+ "method": "POST",
176
+ "body": true,
177
+ "binary": false,
178
+ "idempotencyKey": false,
179
+ "parameters": [],
180
+ "security": [
181
+ {
182
+ "apiKeyAuth": []
183
+ },
184
+ {
185
+ "m2mOAuth": [
186
+ "interchange:read"
187
+ ]
188
+ }
189
+ ],
190
+ "summary": "Query grouped Seller RFP quality, efficiency, and commercial metrics with metric-specific availability and immutable pages. Defaults to live terminal turns; synthetic purposes are opt-in and excluded from commercial metrics. Use get for individual RFPs or turns."
191
+ },
192
+ "get_seller_reporting_receipts": {
193
+ "path": "/tools/get_seller_reporting_receipts",
194
+ "method": "POST",
195
+ "body": true,
196
+ "binary": false,
197
+ "idempotencyKey": false,
198
+ "parameters": [],
199
+ "security": [
200
+ {
201
+ "apiKeyAuth": []
202
+ },
203
+ {
204
+ "m2mOAuth": [
205
+ "interchange:read"
206
+ ]
207
+ }
208
+ ],
209
+ "summary": "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."
210
+ },
211
+ "get_status": {
212
+ "path": "/tools/get_status",
213
+ "method": "POST",
214
+ "body": true,
215
+ "binary": false,
216
+ "idempotencyKey": false,
217
+ "parameters": [],
218
+ "security": [
219
+ {
220
+ "apiKeyAuth": []
221
+ },
222
+ {
223
+ "m2mOAuth": [
224
+ "interchange:read"
225
+ ]
226
+ }
227
+ ],
228
+ "summary": "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."
229
+ },
230
+ "open_advertisers_page": {
231
+ "path": "/tools/open_advertisers_page",
232
+ "method": "POST",
233
+ "body": true,
234
+ "binary": false,
235
+ "idempotencyKey": false,
236
+ "parameters": [],
237
+ "security": [
238
+ {
239
+ "apiKeyAuth": []
240
+ },
241
+ {
242
+ "m2mOAuth": [
243
+ "interchange:read"
244
+ ]
245
+ }
246
+ ],
247
+ "summary": "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\")."
248
+ },
249
+ "open_agent_page": {
250
+ "path": "/tools/open_agent_page",
251
+ "method": "POST",
252
+ "body": true,
253
+ "binary": false,
254
+ "idempotencyKey": false,
255
+ "parameters": [],
256
+ "security": [
257
+ {
258
+ "apiKeyAuth": []
259
+ },
260
+ {
261
+ "m2mOAuth": [
262
+ "interchange:admin"
263
+ ]
264
+ }
265
+ ],
266
+ "summary": "Open one agent owned by this Developer account."
267
+ },
268
+ "open_agents_page": {
269
+ "path": "/tools/open_agents_page",
270
+ "method": "POST",
271
+ "body": true,
272
+ "binary": false,
273
+ "idempotencyKey": false,
274
+ "parameters": [],
275
+ "security": [
276
+ {
277
+ "apiKeyAuth": []
278
+ },
279
+ {
280
+ "m2mOAuth": [
281
+ "interchange:admin"
282
+ ]
283
+ }
284
+ ],
285
+ "summary": "Open Build an agent for this Developer account."
286
+ },
287
+ "open_approvals": {
288
+ "path": "/tools/open_approvals",
289
+ "method": "POST",
290
+ "body": true,
291
+ "binary": false,
292
+ "idempotencyKey": false,
293
+ "parameters": [],
294
+ "security": [
295
+ {
296
+ "apiKeyAuth": []
297
+ },
298
+ {
299
+ "m2mOAuth": [
300
+ "interchange:read"
301
+ ]
302
+ }
303
+ ],
304
+ "summary": "Open the Approvals Page for reviews, assignments, routing, evidence, decisions, and forward recovery. Focus by exact media-buy identity or reviewRef; creativeId works only for one loaded version."
305
+ },
306
+ "open_campaign_receipt": {
307
+ "path": "/tools/open_campaign_receipt",
308
+ "method": "POST",
309
+ "body": true,
310
+ "binary": false,
311
+ "idempotencyKey": false,
312
+ "parameters": [],
313
+ "security": [
314
+ {
315
+ "apiKeyAuth": []
316
+ },
317
+ {
318
+ "m2mOAuth": [
319
+ "interchange:read"
320
+ ]
321
+ }
322
+ ],
323
+ "summary": "Open Review & go live for one draft campaign: budget, flight, staged media buys and their budget split, why each buy is not live yet, and the readiness blockers. Use when a buyer asks if a draft is ready to launch. Refuses non-draft campaigns; launching stays a separate confirmed save_campaign."
324
+ },
325
+ "open_campaigns_page": {
326
+ "path": "/tools/open_campaigns_page",
327
+ "method": "POST",
328
+ "body": true,
329
+ "binary": false,
330
+ "idempotencyKey": false,
331
+ "parameters": [],
332
+ "security": [
333
+ {
334
+ "apiKeyAuth": []
335
+ },
336
+ {
337
+ "m2mOAuth": [
338
+ "interchange:read"
339
+ ]
340
+ }
341
+ ],
342
+ "summary": "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."
343
+ },
344
+ "open_connections_page": {
345
+ "path": "/tools/open_connections_page",
346
+ "method": "POST",
347
+ "body": true,
348
+ "binary": false,
349
+ "idempotencyKey": false,
350
+ "parameters": [],
351
+ "security": [
352
+ {
353
+ "apiKeyAuth": []
354
+ },
355
+ {
356
+ "m2mOAuth": [
357
+ "interchange:read"
358
+ ]
359
+ }
360
+ ],
361
+ "summary": "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."
362
+ },
363
+ "open_creative_engines_page": {
364
+ "path": "/tools/open_creative_engines_page",
365
+ "method": "POST",
366
+ "body": true,
367
+ "binary": false,
368
+ "idempotencyKey": false,
369
+ "parameters": [],
370
+ "security": [
371
+ {
372
+ "apiKeyAuth": []
373
+ },
374
+ {
375
+ "m2mOAuth": [
376
+ "interchange:read"
377
+ ]
378
+ }
379
+ ],
380
+ "summary": "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."
381
+ },
382
+ "open_creative_library": {
383
+ "path": "/tools/open_creative_library",
384
+ "method": "POST",
385
+ "body": true,
386
+ "binary": false,
387
+ "idempotencyKey": true,
388
+ "parameters": [],
389
+ "security": [
390
+ {
391
+ "apiKeyAuth": []
392
+ },
393
+ {
394
+ "m2mOAuth": [
395
+ "interchange:read"
396
+ ]
397
+ }
398
+ ],
399
+ "summary": "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."
400
+ },
401
+ "open_media_buys_page": {
402
+ "path": "/tools/open_media_buys_page",
403
+ "method": "POST",
404
+ "body": true,
405
+ "binary": false,
406
+ "idempotencyKey": false,
407
+ "parameters": [],
408
+ "security": [
409
+ {
410
+ "apiKeyAuth": []
411
+ },
412
+ {
413
+ "m2mOAuth": [
414
+ "interchange:read"
415
+ ]
416
+ }
417
+ ],
418
+ "summary": "Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches."
419
+ },
420
+ "open_page": {
421
+ "path": "/tools/open_page",
422
+ "method": "POST",
423
+ "body": true,
424
+ "binary": false,
425
+ "idempotencyKey": false,
426
+ "parameters": [],
427
+ "security": [
428
+ {
429
+ "apiKeyAuth": []
430
+ },
431
+ {
432
+ "m2mOAuth": [
433
+ "interchange:read"
434
+ ]
435
+ }
436
+ ],
437
+ "summary": "Open a compatibility Page. source_diagnostics can create or attach the Agent. External hosts may return text. Credentials and authority changes remain human ceremonies."
438
+ },
439
+ "open_proposal_pass": {
440
+ "path": "/tools/open_proposal_pass",
441
+ "method": "POST",
442
+ "body": true,
443
+ "binary": false,
444
+ "idempotencyKey": false,
445
+ "parameters": [],
446
+ "security": [
447
+ {
448
+ "apiKeyAuth": []
449
+ },
450
+ {
451
+ "m2mOAuth": [
452
+ "interchange:read"
453
+ ]
454
+ }
455
+ ],
456
+ "summary": "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."
457
+ },
458
+ "open_seller_dashboard": {
459
+ "path": "/tools/open_seller_dashboard",
460
+ "method": "POST",
461
+ "body": true,
462
+ "binary": false,
463
+ "idempotencyKey": false,
464
+ "parameters": [],
465
+ "security": [
466
+ {
467
+ "apiKeyAuth": []
468
+ },
469
+ {
470
+ "m2mOAuth": [
471
+ "interchange:read"
472
+ ]
473
+ }
474
+ ],
475
+ "summary": "Open the Seller Dashboard Page: seller analytics, or the synthetic evaluation view of practice runs while this is an active demo Seller Account. The Page self-fetches."
476
+ },
477
+ "open_variant_gallery": {
478
+ "path": "/tools/open_variant_gallery",
479
+ "method": "POST",
480
+ "body": true,
481
+ "binary": false,
482
+ "idempotencyKey": false,
483
+ "parameters": [],
484
+ "security": [
485
+ {
486
+ "apiKeyAuth": []
487
+ },
488
+ {
489
+ "m2mOAuth": [
490
+ "interchange:read"
491
+ ]
492
+ }
493
+ ],
494
+ "summary": "Show a saved Creative Session’s variants (find via search/get kind creative_session). Not for generating new variants."
495
+ },
496
+ "refresh_inventory_source_health": {
497
+ "path": "/tools/refresh_inventory_source_health",
498
+ "method": "POST",
499
+ "body": true,
500
+ "binary": false,
501
+ "idempotencyKey": true,
502
+ "parameters": [],
503
+ "security": [
504
+ {
505
+ "apiKeyAuth": []
506
+ },
507
+ {
508
+ "m2mOAuth": [
509
+ "interchange:write"
510
+ ]
511
+ }
512
+ ],
513
+ "summary": "Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy."
514
+ },
515
+ "request_buyer_child_account": {
516
+ "path": "/tools/request_buyer_child_account",
517
+ "method": "POST",
518
+ "body": true,
519
+ "binary": false,
520
+ "idempotencyKey": true,
521
+ "bodyKeyField": "idempotencyKey",
522
+ "parameters": [],
523
+ "security": [
524
+ {
525
+ "apiKeyAuth": []
526
+ },
527
+ {
528
+ "m2mOAuth": [
529
+ "interchange:admin"
530
+ ]
531
+ }
532
+ ],
533
+ "summary": "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."
534
+ },
535
+ "request_proposals": {
536
+ "path": "/tools/request_proposals",
537
+ "method": "POST",
538
+ "body": true,
539
+ "binary": false,
540
+ "idempotencyKey": true,
541
+ "bodyKeyField": "idempotencyKey",
542
+ "parameters": [],
543
+ "security": [
544
+ {
545
+ "apiKeyAuth": []
546
+ },
547
+ {
548
+ "m2mOAuth": [
549
+ "interchange:write"
550
+ ]
551
+ }
552
+ ],
553
+ "summary": "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."
554
+ },
555
+ "request_seller_reporting_update": {
556
+ "path": "/tools/request_seller_reporting_update",
557
+ "method": "POST",
558
+ "body": true,
559
+ "binary": false,
560
+ "idempotencyKey": true,
561
+ "parameters": [],
562
+ "security": [
563
+ {
564
+ "apiKeyAuth": []
565
+ },
566
+ {
567
+ "m2mOAuth": [
568
+ "interchange:write"
569
+ ]
570
+ }
571
+ ],
572
+ "summary": "Requests a scheduler-run reporting refresh or a bounded replay for one seller media buy. It never polls a provider directly."
573
+ },
574
+ "review_buyer_child_account": {
575
+ "path": "/tools/review_buyer_child_account",
576
+ "method": "POST",
577
+ "body": true,
578
+ "binary": false,
579
+ "idempotencyKey": false,
580
+ "parameters": [],
581
+ "security": [
582
+ {
583
+ "apiKeyAuth": []
584
+ },
585
+ {
586
+ "m2mOAuth": [
587
+ "interchange:admin"
588
+ ]
589
+ }
590
+ ],
591
+ "summary": "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."
592
+ },
593
+ "save_account": {
594
+ "path": "/tools/save_account",
595
+ "method": "POST",
596
+ "body": true,
597
+ "binary": false,
598
+ "idempotencyKey": true,
599
+ "parameters": [],
600
+ "security": [
601
+ {
602
+ "apiKeyAuth": []
603
+ },
604
+ {
605
+ "m2mOAuth": [
606
+ "interchange:admin"
607
+ ]
608
+ }
609
+ ],
610
+ "summary": "Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes."
611
+ },
612
+ "save_advertiser": {
613
+ "path": "/tools/save_advertiser",
614
+ "method": "POST",
615
+ "body": true,
616
+ "binary": false,
617
+ "idempotencyKey": true,
618
+ "parameters": [],
619
+ "security": [
620
+ {
621
+ "apiKeyAuth": []
622
+ },
623
+ {
624
+ "m2mOAuth": [
625
+ "interchange:write"
626
+ ]
627
+ }
628
+ ],
629
+ "summary": "Save an advertiser or its mappings. Confirm markets/channels with the buyer first (see footprintProposal). `needs_input` = ask the buyer; never recreate to change currency. Use identityContract:confirmed-v1 for brand fixes. resolveBrand looks up public branding. Guide: /v2/setup/v3/identity-setup."
630
+ },
631
+ "save_advertiser_grant": {
632
+ "path": "/tools/save_advertiser_grant",
633
+ "method": "POST",
634
+ "body": true,
635
+ "binary": false,
636
+ "idempotencyKey": true,
637
+ "parameters": [],
638
+ "security": [
639
+ {
640
+ "apiKeyAuth": []
641
+ },
642
+ {
643
+ "m2mOAuth": [
644
+ "interchange:admin"
645
+ ]
646
+ }
647
+ ],
648
+ "summary": "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."
649
+ },
650
+ "save_advertiser_instructions": {
651
+ "path": "/tools/save_advertiser_instructions",
652
+ "method": "POST",
653
+ "body": true,
654
+ "binary": false,
655
+ "idempotencyKey": true,
656
+ "parameters": [],
657
+ "security": [
658
+ {
659
+ "apiKeyAuth": []
660
+ },
661
+ {
662
+ "m2mOAuth": [
663
+ "interchange:write"
664
+ ]
665
+ }
666
+ ],
667
+ "summary": "Save seller notes and instructions for an exact brand-domain × operator-domain pair. Configuration does not verify the registry; discounts, source routing, sponsored access, and buyer-account trust are read-only."
668
+ },
669
+ "save_agent": {
670
+ "path": "/tools/save_agent",
671
+ "method": "POST",
672
+ "body": true,
673
+ "binary": false,
674
+ "idempotencyKey": true,
675
+ "parameters": [],
676
+ "security": [
677
+ {
678
+ "apiKeyAuth": []
679
+ },
680
+ {
681
+ "m2mOAuth": [
682
+ "interchange:write"
683
+ ]
684
+ }
685
+ ],
686
+ "summary": "In a Developer account, register a Sales or Creative Agent, or rename an owned Agent. A registration requires an account administrator and an idempotency key. In a Seller account, confirm or correct one Sales Agent product mode."
687
+ },
688
+ "save_ask": {
689
+ "path": "/tools/save_ask",
690
+ "method": "POST",
691
+ "body": true,
692
+ "binary": false,
693
+ "idempotencyKey": true,
694
+ "parameters": [],
695
+ "security": [
696
+ {
697
+ "apiKeyAuth": []
698
+ },
699
+ {
700
+ "m2mOAuth": [
701
+ "interchange:read"
702
+ ]
703
+ }
704
+ ],
705
+ "summary": "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."
706
+ },
707
+ "save_audience": {
708
+ "path": "/tools/save_audience",
709
+ "method": "POST",
710
+ "body": true,
711
+ "binary": false,
712
+ "idempotencyKey": true,
713
+ "parameters": [],
714
+ "security": [
715
+ {
716
+ "apiKeyAuth": []
717
+ },
718
+ {
719
+ "m2mOAuth": [
720
+ "interchange:write"
721
+ ]
722
+ }
723
+ ],
724
+ "summary": "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."
725
+ },
726
+ "save_billing": {
727
+ "path": "/tools/save_billing",
728
+ "method": "POST",
729
+ "body": true,
730
+ "binary": false,
731
+ "idempotencyKey": true,
732
+ "parameters": [],
733
+ "security": [
734
+ {
735
+ "apiKeyAuth": []
736
+ },
737
+ {
738
+ "m2mOAuth": [
739
+ "interchange:read"
740
+ ]
741
+ }
742
+ ],
743
+ "summary": "Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP."
744
+ },
745
+ "save_business_rules": {
746
+ "path": "/tools/save_business_rules",
747
+ "method": "POST",
748
+ "body": true,
749
+ "binary": false,
750
+ "idempotencyKey": true,
751
+ "parameters": [],
752
+ "security": [
753
+ {
754
+ "apiKeyAuth": []
755
+ },
756
+ {
757
+ "m2mOAuth": [
758
+ "interchange:write"
759
+ ]
760
+ }
761
+ ],
762
+ "summary": "Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview."
763
+ },
764
+ "save_buyer_agent": {
765
+ "path": "/tools/save_buyer_agent",
766
+ "method": "POST",
767
+ "body": true,
768
+ "binary": false,
769
+ "idempotencyKey": true,
770
+ "parameters": [],
771
+ "security": [
772
+ {
773
+ "apiKeyAuth": []
774
+ },
775
+ {
776
+ "m2mOAuth": [
777
+ "interchange:admin"
778
+ ]
779
+ }
780
+ ],
781
+ "summary": "Create, rename, reconcile access, change lifecycle, or prepare a human credential handoff for one buyer agent per call."
782
+ },
783
+ "save_buyer_operator": {
784
+ "path": "/tools/save_buyer_operator",
785
+ "method": "POST",
786
+ "body": true,
787
+ "binary": false,
788
+ "idempotencyKey": true,
789
+ "parameters": [],
790
+ "security": [
791
+ {
792
+ "apiKeyAuth": []
793
+ },
794
+ {
795
+ "m2mOAuth": [
796
+ "interchange:admin"
797
+ ]
798
+ }
799
+ ],
800
+ "summary": "Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup."
801
+ },
802
+ "save_campaign": {
803
+ "path": "/tools/save_campaign",
804
+ "method": "POST",
805
+ "body": true,
806
+ "binary": false,
807
+ "idempotencyKey": true,
808
+ "bodyKeyField": "idempotencyKey",
809
+ "parameters": [],
810
+ "security": [
811
+ {
812
+ "apiKeyAuth": []
813
+ },
814
+ {
815
+ "m2mOAuth": [
816
+ "interchange:write"
817
+ ]
818
+ }
819
+ ],
820
+ "summary": "Save a campaign. Create needs advertiserId and name; flight and budget are optional. Split inventory choices into separate media buys; presets expand dimensions. To launch, set desiredPhase: active with confirmLaunch: true; omit confirmation to preview. Cancellation never cancels media buys."
821
+ },
822
+ "save_catalog": {
823
+ "path": "/tools/save_catalog",
824
+ "method": "POST",
825
+ "body": true,
826
+ "binary": false,
827
+ "idempotencyKey": true,
828
+ "bodyKeyField": "idempotencyKey",
829
+ "parameters": [],
830
+ "security": [
831
+ {
832
+ "apiKeyAuth": []
833
+ },
834
+ {
835
+ "m2mOAuth": [
836
+ "interchange:write"
837
+ ]
838
+ }
839
+ ],
840
+ "summary": "Create or replace one flat catalog declaration by catalogId, or archive it with isArchived. URL saves refetch the feed."
841
+ },
842
+ "save_connection": {
843
+ "path": "/tools/save_connection",
844
+ "method": "POST",
845
+ "body": true,
846
+ "binary": false,
847
+ "idempotencyKey": true,
848
+ "parameters": [],
849
+ "security": [
850
+ {
851
+ "apiKeyAuth": []
852
+ },
853
+ {
854
+ "m2mOAuth": [
855
+ "interchange:write"
856
+ ]
857
+ }
858
+ ],
859
+ "summary": "Manage seller or creative-engine authorization, accounts and advertiser mappings. Seller-only: reporting, selection, billing, policy, activation."
860
+ },
861
+ "save_coverage": {
862
+ "path": "/tools/save_coverage",
863
+ "method": "POST",
864
+ "body": true,
865
+ "binary": false,
866
+ "idempotencyKey": true,
867
+ "parameters": [],
868
+ "security": [
869
+ {
870
+ "apiKeyAuth": []
871
+ },
872
+ {
873
+ "m2mOAuth": [
874
+ "interchange:write"
875
+ ]
876
+ }
877
+ ],
878
+ "summary": "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."
879
+ },
880
+ "save_creative": {
881
+ "path": "/tools/save_creative",
882
+ "method": "POST",
883
+ "body": true,
884
+ "binary": false,
885
+ "idempotencyKey": true,
886
+ "parameters": [],
887
+ "security": [
888
+ {
889
+ "apiKeyAuth": []
890
+ },
891
+ {
892
+ "m2mOAuth": [
893
+ "interchange:write"
894
+ ]
895
+ }
896
+ ],
897
+ "summary": "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."
898
+ },
899
+ "save_creative_collection": {
900
+ "path": "/tools/save_creative_collection",
901
+ "method": "POST",
902
+ "body": true,
903
+ "binary": false,
904
+ "idempotencyKey": true,
905
+ "parameters": [],
906
+ "security": [
907
+ {
908
+ "apiKeyAuth": []
909
+ },
910
+ {
911
+ "m2mOAuth": [
912
+ "interchange:write"
913
+ ]
914
+ }
915
+ ],
916
+ "summary": "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."
917
+ },
918
+ "save_creative_session": {
919
+ "path": "/tools/save_creative_session",
920
+ "method": "POST",
921
+ "body": true,
922
+ "binary": false,
923
+ "idempotencyKey": true,
924
+ "parameters": [],
925
+ "security": [
926
+ {
927
+ "apiKeyAuth": []
928
+ },
929
+ {
930
+ "m2mOAuth": [
931
+ "interchange:write"
932
+ ]
933
+ }
934
+ ],
935
+ "summary": "Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId."
936
+ },
937
+ "save_dimension": {
938
+ "path": "/tools/save_dimension",
939
+ "method": "POST",
940
+ "body": true,
941
+ "binary": false,
942
+ "idempotencyKey": true,
943
+ "parameters": [],
944
+ "security": [
945
+ {
946
+ "apiKeyAuth": []
947
+ },
948
+ {
949
+ "m2mOAuth": [
950
+ "interchange:write"
951
+ ]
952
+ }
953
+ ],
954
+ "summary": "Create a dimension, or update an existing dimension by its id. Tags is built in and open. Labels belong only to objects in appliesTo."
955
+ },
956
+ "save_directed_campaign_subscription": {
957
+ "path": "/tools/save_directed_campaign_subscription",
958
+ "method": "POST",
959
+ "body": true,
960
+ "binary": false,
961
+ "idempotencyKey": true,
962
+ "parameters": [],
963
+ "security": [
964
+ {
965
+ "apiKeyAuth": []
966
+ },
967
+ {
968
+ "m2mOAuth": [
969
+ "interchange:write"
970
+ ]
971
+ }
972
+ ],
973
+ "summary": "Subscribe to a connected seller's directed campaigns, mirroring its media buys into this buyer's view. Set `unsubscribe: true` to remove the subscription and retire mirrored campaigns. Requires a mapped seller account and reachable advertiser."
974
+ },
975
+ "save_event_source": {
976
+ "path": "/tools/save_event_source",
977
+ "method": "POST",
978
+ "body": true,
979
+ "binary": false,
980
+ "idempotencyKey": true,
981
+ "bodyKeyField": "idempotencyKey",
982
+ "parameters": [],
983
+ "security": [
984
+ {
985
+ "apiKeyAuth": []
986
+ },
987
+ {
988
+ "m2mOAuth": [
989
+ "interchange:write"
990
+ ]
991
+ }
992
+ ],
993
+ "summary": "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."
994
+ },
995
+ "save_inventory_source": {
996
+ "path": "/tools/save_inventory_source",
997
+ "method": "POST",
998
+ "body": true,
999
+ "binary": false,
1000
+ "idempotencyKey": true,
1001
+ "parameters": [],
1002
+ "security": [
1003
+ {
1004
+ "apiKeyAuth": []
1005
+ },
1006
+ {
1007
+ "m2mOAuth": [
1008
+ "interchange:write"
1009
+ ]
1010
+ }
1011
+ ],
1012
+ "summary": "Create or update where a seller's inventory comes from. Pass `id` to change an existing source, omit it to add one. Credentials are never passed here — a source that needs a secret comes back with the state and the page that collects it."
1013
+ },
1014
+ "save_library_request": {
1015
+ "path": "/tools/save_library_request",
1016
+ "method": "POST",
1017
+ "body": true,
1018
+ "binary": false,
1019
+ "idempotencyKey": true,
1020
+ "parameters": [],
1021
+ "security": [
1022
+ {
1023
+ "apiKeyAuth": []
1024
+ },
1025
+ {
1026
+ "m2mOAuth": [
1027
+ "interchange:write"
1028
+ ]
1029
+ }
1030
+ ],
1031
+ "summary": "Open a seller library request or close it with seller Material."
1032
+ },
1033
+ "save_material": {
1034
+ "path": "/tools/save_material",
1035
+ "method": "POST",
1036
+ "body": true,
1037
+ "binary": false,
1038
+ "idempotencyKey": true,
1039
+ "parameters": [],
1040
+ "security": [
1041
+ {
1042
+ "apiKeyAuth": []
1043
+ },
1044
+ {
1045
+ "m2mOAuth": [
1046
+ "interchange:write"
1047
+ ]
1048
+ }
1049
+ ],
1050
+ "summary": "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)."
1051
+ },
1052
+ "save_media_buy": {
1053
+ "path": "/tools/save_media_buy",
1054
+ "method": "POST",
1055
+ "body": true,
1056
+ "binary": false,
1057
+ "idempotencyKey": true,
1058
+ "bodyKeyField": "idempotencyKey",
1059
+ "parameters": [],
1060
+ "security": [
1061
+ {
1062
+ "apiKeyAuth": []
1063
+ },
1064
+ {
1065
+ "m2mOAuth": [
1066
+ "interchange:write"
1067
+ ]
1068
+ }
1069
+ ],
1070
+ "summary": "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."
1071
+ },
1072
+ "save_media_kit": {
1073
+ "path": "/tools/save_media_kit",
1074
+ "method": "POST",
1075
+ "body": true,
1076
+ "binary": false,
1077
+ "idempotencyKey": true,
1078
+ "parameters": [],
1079
+ "security": [
1080
+ {
1081
+ "apiKeyAuth": []
1082
+ },
1083
+ {
1084
+ "m2mOAuth": [
1085
+ "interchange:write"
1086
+ ]
1087
+ }
1088
+ ],
1089
+ "summary": "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`."
1090
+ },
1091
+ "save_notification_config": {
1092
+ "path": "/tools/save_notification_config",
1093
+ "method": "POST",
1094
+ "body": true,
1095
+ "binary": false,
1096
+ "idempotencyKey": true,
1097
+ "parameters": [],
1098
+ "security": [
1099
+ {
1100
+ "apiKeyAuth": []
1101
+ },
1102
+ {
1103
+ "m2mOAuth": [
1104
+ "interchange:write"
1105
+ ]
1106
+ }
1107
+ ],
1108
+ "summary": "Create or update a notification subscription: scope, content, routes; no trigger type is creatable yet, no delivery policy yet. Omit subscriptionId to create, supply it to patch. Managed subscriptions are editable only within their mutability. Credentials belong to save_integration."
1109
+ },
1110
+ "save_playbook": {
1111
+ "path": "/tools/save_playbook",
1112
+ "method": "POST",
1113
+ "body": true,
1114
+ "binary": false,
1115
+ "idempotencyKey": true,
1116
+ "parameters": [],
1117
+ "security": [
1118
+ {
1119
+ "apiKeyAuth": []
1120
+ },
1121
+ {
1122
+ "m2mOAuth": [
1123
+ "interchange:write"
1124
+ ]
1125
+ }
1126
+ ],
1127
+ "summary": "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."
1128
+ },
1129
+ "save_property_list": {
1130
+ "path": "/tools/save_property_list",
1131
+ "method": "POST",
1132
+ "body": true,
1133
+ "binary": false,
1134
+ "idempotencyKey": true,
1135
+ "parameters": [],
1136
+ "security": [
1137
+ {
1138
+ "apiKeyAuth": []
1139
+ },
1140
+ {
1141
+ "m2mOAuth": [
1142
+ "interchange:write"
1143
+ ]
1144
+ }
1145
+ ],
1146
+ "summary": "Create, update, archive, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists."
1147
+ },
1148
+ "save_rfp": {
1149
+ "path": "/tools/save_rfp",
1150
+ "method": "POST",
1151
+ "body": true,
1152
+ "binary": false,
1153
+ "idempotencyKey": true,
1154
+ "parameters": [],
1155
+ "security": [
1156
+ {
1157
+ "apiKeyAuth": []
1158
+ },
1159
+ {
1160
+ "m2mOAuth": [
1161
+ "interchange:write"
1162
+ ]
1163
+ }
1164
+ ],
1165
+ "summary": "Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests."
1166
+ },
1167
+ "save_seller": {
1168
+ "path": "/tools/save_seller",
1169
+ "method": "POST",
1170
+ "body": true,
1171
+ "binary": false,
1172
+ "idempotencyKey": true,
1173
+ "parameters": [],
1174
+ "security": [
1175
+ {
1176
+ "apiKeyAuth": []
1177
+ },
1178
+ {
1179
+ "m2mOAuth": [
1180
+ "interchange:write"
1181
+ ]
1182
+ }
1183
+ ],
1184
+ "summary": "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\")."
1185
+ },
1186
+ "save_signal": {
1187
+ "path": "/tools/save_signal",
1188
+ "method": "POST",
1189
+ "body": true,
1190
+ "binary": false,
1191
+ "idempotencyKey": true,
1192
+ "parameters": [],
1193
+ "security": [
1194
+ {
1195
+ "apiKeyAuth": []
1196
+ },
1197
+ {
1198
+ "m2mOAuth": [
1199
+ "interchange:write"
1200
+ ]
1201
+ }
1202
+ ],
1203
+ "summary": "Create, replace, or archive a signal. Managed writes need a complete draft; read before updates. Without sourceId, writes the seller catalog."
1204
+ },
1205
+ "save_wholesale_product": {
1206
+ "path": "/tools/save_wholesale_product",
1207
+ "method": "POST",
1208
+ "body": true,
1209
+ "binary": false,
1210
+ "idempotencyKey": true,
1211
+ "parameters": [],
1212
+ "security": [
1213
+ {
1214
+ "apiKeyAuth": []
1215
+ },
1216
+ {
1217
+ "m2mOAuth": [
1218
+ "interchange:write"
1219
+ ]
1220
+ }
1221
+ ],
1222
+ "summary": "Create, change, or delete one wholesale product on an ad-server source — what buyers discover and buy. Omit `id` to create: needs `name` and `inventory`, validated first. Pass `id` to change only the fields you name. `active` = buyable, `archived` = off the market and reversible, `delete` is not."
1223
+ },
1224
+ "save_work_item": {
1225
+ "path": "/tools/save_work_item",
1226
+ "method": "POST",
1227
+ "body": true,
1228
+ "binary": false,
1229
+ "idempotencyKey": true,
1230
+ "parameters": [],
1231
+ "security": [
1232
+ {
1233
+ "apiKeyAuth": []
1234
+ },
1235
+ {
1236
+ "m2mOAuth": [
1237
+ "interchange:write"
1238
+ ]
1239
+ }
1240
+ ],
1241
+ "summary": "Decide a creative or media-buy approval, or complete a modular-source follow-up. Repeats preserve evidence; retry, evaluation, and reassignment stay on the approvals Page."
1242
+ },
1243
+ "search": {
1244
+ "path": "/tools/search",
1245
+ "method": "POST",
1246
+ "body": true,
1247
+ "binary": false,
1248
+ "idempotencyKey": false,
1249
+ "parameters": [],
1250
+ "security": [
1251
+ {
1252
+ "apiKeyAuth": []
1253
+ },
1254
+ {
1255
+ "m2mOAuth": [
1256
+ "interchange:read"
1257
+ ]
1258
+ }
1259
+ ],
1260
+ "summary": "Find objects in this account, or answer questions from the docs. Pass kind to list one object type, query to match text, or both. Before a multi-step task, search kind skill for a workflow. Reread a docs hit with its document (and revision, for agreements) before you cite it."
1261
+ },
1262
+ "test_creative_macros": {
1263
+ "path": "/tools/test_creative_macros",
1264
+ "method": "POST",
1265
+ "body": true,
1266
+ "binary": false,
1267
+ "idempotencyKey": false,
1268
+ "parameters": [],
1269
+ "security": [
1270
+ {
1271
+ "apiKeyAuth": []
1272
+ },
1273
+ {
1274
+ "m2mOAuth": [
1275
+ "interchange:read"
1276
+ ]
1277
+ }
1278
+ ],
1279
+ "summary": "Dry-runs one tracker URL through exact raw input, canonical AdCP compilation, recipient translation, and deterministic synthetic substitution. Use it before preview or trafficking; unresolved required macros fail closed."
1280
+ },
1281
+ "upload_creative_asset": {
1282
+ "path": "/tools/upload_creative_asset",
1283
+ "method": "POST",
1284
+ "body": true,
1285
+ "binary": false,
1286
+ "idempotencyKey": true,
1287
+ "parameters": [],
1288
+ "security": [
1289
+ {
1290
+ "apiKeyAuth": []
1291
+ },
1292
+ {
1293
+ "m2mOAuth": [
1294
+ "interchange:read"
1295
+ ]
1296
+ }
1297
+ ],
1298
+ "summary": "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."
1299
+ }
1300
+ };