@apostra/sdk 0.40.0 → 0.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- export declare const version = "0.40.0";
1
+ export declare const version = "0.41.0";
2
2
  export declare const baseUrl = "https://api.apostra.com/api/v3";
3
3
  export declare const m2mTokenUrl = "https://identity.scope3.com/oauth2/token";
4
4
  export declare const operations: {
@@ -178,7 +178,7 @@ export declare const operations: {
178
178
  }, {
179
179
  readonly m2mOAuth: readonly ["interchange:read"];
180
180
  }];
181
- readonly 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. A Developer account adds each agent's stage, blocker, and next call.";
181
+ readonly summary: "Current account, state, blockers, exact fixes, accounts to pick from. For seller demand, tells if readiness stops requests before source calls; read before diagnosing source health, empty responses, or demand. A Developer account adds each agent's stage, blocker, next call.";
182
182
  };
183
183
  readonly log_event: {
184
184
  readonly path: "/tools/log_event";
@@ -209,20 +209,6 @@ export declare const operations: {
209
209
  }];
210
210
  readonly 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\").";
211
211
  };
212
- readonly open_agent_certification_page: {
213
- readonly path: "/tools/open_agent_certification_page";
214
- readonly method: "POST";
215
- readonly body: true;
216
- readonly binary: false;
217
- readonly idempotencyKey: false;
218
- readonly parameters: readonly [];
219
- readonly security: readonly [{
220
- readonly apiKeyAuth: readonly [];
221
- }, {
222
- readonly m2mOAuth: readonly ["interchange:read"];
223
- }];
224
- readonly summary: "Open one agent’s Test & certify Page: live certification per use case, recent test runs, AdCP 4.0 readiness and capability declarations. Read-only.";
225
- };
226
212
  readonly open_agent_page: {
227
213
  readonly path: "/tools/open_agent_page";
228
214
  readonly method: "POST";
@@ -361,7 +347,7 @@ export declare const operations: {
361
347
  }, {
362
348
  readonly m2mOAuth: readonly ["interchange:read"];
363
349
  }];
364
- readonly 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.";
350
+ readonly summary: "Open Creative Library. Use search for a plain object answer. The composer can start from an advertiser or a campaign and does not need a 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.";
365
351
  };
366
352
  readonly open_developer_home: {
367
353
  readonly path: "/tools/open_developer_home";
@@ -473,7 +459,7 @@ export declare const operations: {
473
459
  }, {
474
460
  readonly m2mOAuth: readonly ["interchange:write"];
475
461
  }];
476
- readonly summary: "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.";
462
+ readonly summary: "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. scope accounts re-lists the source's accounts instead.";
477
463
  };
478
464
  readonly request_buyer_child_account: {
479
465
  readonly path: "/tools/request_buyer_child_account";
@@ -629,7 +615,7 @@ export declare const operations: {
629
615
  }, {
630
616
  readonly m2mOAuth: readonly ["interchange:read"];
631
617
  }];
632
- readonly 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.";
618
+ readonly summary: "File or update a typed ask in the Apostra Support workflow; returns askId. kind create files a new ask; kind update sends only id and requester. Supply is buyer inventory. Call immediately with type support when a person explicitly asks for a human; do not diagnose first.";
633
619
  };
634
620
  readonly save_audience: {
635
621
  readonly path: "/tools/save_audience";
@@ -757,7 +743,7 @@ export declare const operations: {
757
743
  }, {
758
744
  readonly m2mOAuth: readonly ["interchange:write"];
759
745
  }];
760
- readonly 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.";
746
+ readonly summary: "Declare publisher domains this Seller sells and its claimed properties. `domains` replaces the complete set; `add`, `remove`, `declareProperties`, `removeProperties`, and `refresh` act on named items only. Read authorization; never assume it.";
761
747
  };
762
748
  readonly save_creative: {
763
749
  readonly path: "/tools/save_creative";
@@ -771,7 +757,7 @@ export declare const operations: {
771
757
  }, {
772
758
  readonly m2mOAuth: readonly ["interchange:write"];
773
759
  }];
774
- readonly summary: "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.";
760
+ readonly summary: "Save content you supply: advertiserId/campaignId, name, message, assets (landing_page_url, social, sourceAssetRef/sourceAssets). New media like radio spots: use save_creative_session. One format selector: formatKind+formatParams or creativeFormatId+formatOptionRef. libraryRole: Buyer Account only.";
775
761
  };
776
762
  readonly save_creative_collection: {
777
763
  readonly path: "/tools/save_creative_collection";
@@ -857,7 +843,7 @@ export declare const operations: {
857
843
  }, {
858
844
  readonly m2mOAuth: readonly ["interchange:write"];
859
845
  }];
860
- readonly summary: "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.";
846
+ readonly summary: "Create or update where a seller's inventory comes from. Pass `id` to change a source or omit it to add one. Add a sales agent with only `agentId`, never its address, or an ad server with only `adServer`; each opens a form. Credentials are never passed here; a source that needs one returns its form.";
861
847
  };
862
848
  readonly save_lesson: {
863
849
  readonly path: "/tools/save_lesson";
@@ -914,7 +900,7 @@ export declare const operations: {
914
900
  }, {
915
901
  readonly m2mOAuth: readonly ["interchange:write"];
916
902
  }];
917
- readonly 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.";
903
+ readonly summary: "Create DRAFT buy; no spend until confirmed. Meta: shared campaign=seller_optimized; ad sets=fixed; ask if unclear. Shared: omit product budgets. Pause/resume: mediaBuyId + isPaused. Proposal: flight + total budget; omit products. channelGroupId: required if grouped; invalid ungrouped/updates.";
918
904
  };
919
905
  readonly save_media_kit: {
920
906
  readonly path: "/tools/save_media_kit";
@@ -1014,7 +1000,7 @@ export declare const operations: {
1014
1000
  }, {
1015
1001
  readonly m2mOAuth: readonly ["interchange:write"];
1016
1002
  }];
1017
- readonly summary: "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\").";
1003
+ readonly summary: "Save Seller identity, capabilities, buyer-visible listing (mediaKit is a deprecated alias), Distribution's OpenAI challenge token, an admission, the intake hold, or the demo's expiry and sample sources. Scope3 eligibility and Market Maker entitlements are read-only here. Read Distribution with get.";
1018
1004
  };
1019
1005
  readonly save_signal: {
1020
1006
  readonly path: "/tools/save_signal";
@@ -1,5 +1,5 @@
1
1
  // Generated. Do not edit.
2
- export const version = '0.40.0';
2
+ export const version = '0.41.0';
3
3
  export const baseUrl = "https://api.apostra.com/api/v3";
4
4
  export const m2mTokenUrl = "https://identity.scope3.com/oauth2/token";
5
5
  export const operations = {
@@ -244,7 +244,7 @@ export const operations = {
244
244
  ]
245
245
  }
246
246
  ],
247
- "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. A Developer account adds each agent's stage, blocker, and next call."
247
+ "summary": "Current account, state, blockers, exact fixes, accounts to pick from. For seller demand, tells if readiness stops requests before source calls; read before diagnosing source health, empty responses, or demand. A Developer account adds each agent's stage, blocker, next call."
248
248
  },
249
249
  "log_event": {
250
250
  "path": "/tools/log_event",
@@ -285,25 +285,6 @@ export const operations = {
285
285
  ],
286
286
  "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\")."
287
287
  },
288
- "open_agent_certification_page": {
289
- "path": "/tools/open_agent_certification_page",
290
- "method": "POST",
291
- "body": true,
292
- "binary": false,
293
- "idempotencyKey": false,
294
- "parameters": [],
295
- "security": [
296
- {
297
- "apiKeyAuth": []
298
- },
299
- {
300
- "m2mOAuth": [
301
- "interchange:read"
302
- ]
303
- }
304
- ],
305
- "summary": "Open one agent’s Test & certify Page: live certification per use case, recent test runs, AdCP 4.0 readiness and capability declarations. Read-only."
306
- },
307
288
  "open_agent_page": {
308
289
  "path": "/tools/open_agent_page",
309
290
  "method": "POST",
@@ -492,7 +473,7 @@ export const operations = {
492
473
  ]
493
474
  }
494
475
  ],
495
- "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."
476
+ "summary": "Open Creative Library. Use search for a plain object answer. The composer can start from an advertiser or a campaign and does not need a 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."
496
477
  },
497
478
  "open_developer_home": {
498
479
  "path": "/tools/open_developer_home",
@@ -644,7 +625,7 @@ export const operations = {
644
625
  ]
645
626
  }
646
627
  ],
647
- "summary": "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."
628
+ "summary": "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. scope accounts re-lists the source's accounts instead."
648
629
  },
649
630
  "request_buyer_child_account": {
650
631
  "path": "/tools/request_buyer_child_account",
@@ -855,7 +836,7 @@ export const operations = {
855
836
  ]
856
837
  }
857
838
  ],
858
- "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."
839
+ "summary": "File or update a typed ask in the Apostra Support workflow; returns askId. kind create files a new ask; kind update sends only id and requester. Supply is buyer inventory. Call immediately with type support when a person explicitly asks for a human; do not diagnose first."
859
840
  },
860
841
  "save_audience": {
861
842
  "path": "/tools/save_audience",
@@ -1028,7 +1009,7 @@ export const operations = {
1028
1009
  ]
1029
1010
  }
1030
1011
  ],
1031
- "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."
1012
+ "summary": "Declare publisher domains this Seller sells and its claimed properties. `domains` replaces the complete set; `add`, `remove`, `declareProperties`, `removeProperties`, and `refresh` act on named items only. Read authorization; never assume it."
1032
1013
  },
1033
1014
  "save_creative": {
1034
1015
  "path": "/tools/save_creative",
@@ -1047,7 +1028,7 @@ export const operations = {
1047
1028
  ]
1048
1029
  }
1049
1030
  ],
1050
- "summary": "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."
1031
+ "summary": "Save content you supply: advertiserId/campaignId, name, message, assets (landing_page_url, social, sourceAssetRef/sourceAssets). New media like radio spots: use save_creative_session. One format selector: formatKind+formatParams or creativeFormatId+formatOptionRef. libraryRole: Buyer Account only."
1051
1032
  },
1052
1033
  "save_creative_collection": {
1053
1034
  "path": "/tools/save_creative_collection",
@@ -1163,7 +1144,7 @@ export const operations = {
1163
1144
  ]
1164
1145
  }
1165
1146
  ],
1166
- "summary": "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."
1147
+ "summary": "Create or update where a seller's inventory comes from. Pass `id` to change a source or omit it to add one. Add a sales agent with only `agentId`, never its address, or an ad server with only `adServer`; each opens a form. Credentials are never passed here; a source that needs one returns its form."
1167
1148
  },
1168
1149
  "save_lesson": {
1169
1150
  "path": "/tools/save_lesson",
@@ -1240,7 +1221,7 @@ export const operations = {
1240
1221
  ]
1241
1222
  }
1242
1223
  ],
1243
- "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."
1224
+ "summary": "Create DRAFT buy; no spend until confirmed. Meta: shared campaign=seller_optimized; ad sets=fixed; ask if unclear. Shared: omit product budgets. Pause/resume: mediaBuyId + isPaused. Proposal: flight + total budget; omit products. channelGroupId: required if grouped; invalid ungrouped/updates."
1244
1225
  },
1245
1226
  "save_media_kit": {
1246
1227
  "path": "/tools/save_media_kit",
@@ -1375,7 +1356,7 @@ export const operations = {
1375
1356
  ]
1376
1357
  }
1377
1358
  ],
1378
- "summary": "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\")."
1359
+ "summary": "Save Seller identity, capabilities, buyer-visible listing (mediaKit is a deprecated alias), Distribution's OpenAI challenge token, an admission, the intake hold, or the demo's expiry and sample sources. Scope3 eligibility and Market Maker entitlements are read-only here. Read Distribution with get."
1379
1360
  },
1380
1361
  "save_signal": {
1381
1362
  "path": "/tools/save_signal",