@adcp/sdk 17.0.0-beta.16 → 17.0.0-beta.17
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/dist/lib/schemas-data/3.0/compliance/comply-test-controller-request.json +647 -0
- package/dist/lib/schemas-data/3.0/compliance/comply-test-controller-response.json +486 -0
- package/dist/lib/schemas-data/3.1/compliance/comply-test-controller-request.json +1073 -0
- package/dist/lib/schemas-data/3.1/compliance/comply-test-controller-response.json +940 -0
- package/dist/lib/schemas-data/3.2/compliance/comply-test-controller-request.json +1778 -0
- package/dist/lib/schemas-data/3.2/compliance/comply-test-controller-response.json +1013 -0
- package/dist/lib/schemas-data/3.2/compliance/get-creative-features-completion.json +44 -0
- package/dist/lib/schemas-data/3.2/compliance/task-completion-data.json +24 -0
- package/dist/lib/schemas-data/3.3.0-beta.3/compliance/comply-test-controller-request.json +2150 -0
- package/dist/lib/schemas-data/3.3.0-beta.3/compliance/comply-test-controller-response.json +1064 -0
- package/dist/lib/schemas-data/3.3.0-beta.3/compliance/get-creative-features-completion.json +44 -0
- package/dist/lib/schemas-data/3.3.0-beta.3/compliance/task-completion-data.json +24 -0
- package/dist/lib/testing/storyboard/account-policy.d.mts +4 -1
- package/dist/lib/testing/storyboard/account-policy.d.ts +4 -1
- package/dist/lib/testing/storyboard/account-policy.js +16 -1
- package/dist/lib/testing/storyboard/account-policy.mjs +16 -1
- package/dist/lib/testing/storyboard/validations.d.mts +1 -1
- package/dist/lib/testing/storyboard/validations.d.ts +1 -1
- package/dist/lib/version.d.mts +3 -3
- package/dist/lib/version.d.ts +3 -3
- package/dist/lib/version.js +3 -3
- package/dist/lib/version.mjs +3 -3
- package/docs/TYPE-SUMMARY.md +2 -2
- package/docs/guides/VALIDATE-YOUR-AGENT.md +32 -2
- package/docs/llms.txt +2 -2
- package/docs/migration-14.x-rc-worksheet.md +4 -4
- package/package.json +1 -1
|
@@ -0,0 +1,486 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"$id": "/schemas/3.0.25/compliance/comply-test-controller-response.json",
|
|
4
|
+
"title": "Comply Test Controller Response",
|
|
5
|
+
"description": "Response from the comply_test_controller tool. Shape varies by scenario type: list_scenarios returns available scenarios, force_* returns state transition results, simulate_* returns simulation results.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"oneOf": [
|
|
8
|
+
{
|
|
9
|
+
"title": "ListScenariosSuccess",
|
|
10
|
+
"description": "Lists which scenarios this seller's test controller supports",
|
|
11
|
+
"type": "object",
|
|
12
|
+
"properties": {
|
|
13
|
+
"success": {
|
|
14
|
+
"type": "boolean",
|
|
15
|
+
"const": true
|
|
16
|
+
},
|
|
17
|
+
"scenarios": {
|
|
18
|
+
"type": "array",
|
|
19
|
+
"items": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"enum": [
|
|
22
|
+
"force_creative_status",
|
|
23
|
+
"force_account_status",
|
|
24
|
+
"force_media_buy_status",
|
|
25
|
+
"force_create_media_buy_arm",
|
|
26
|
+
"force_task_completion",
|
|
27
|
+
"force_session_status",
|
|
28
|
+
"simulate_delivery",
|
|
29
|
+
"simulate_budget_spend",
|
|
30
|
+
"seed_product",
|
|
31
|
+
"seed_pricing_option",
|
|
32
|
+
"seed_creative",
|
|
33
|
+
"seed_plan",
|
|
34
|
+
"seed_media_buy",
|
|
35
|
+
"seed_creative_format"
|
|
36
|
+
]
|
|
37
|
+
},
|
|
38
|
+
"description": "Scenarios this seller has implemented. Runners and sellers MUST accept unknown scenario strings (open-for-extension) — new scenarios may be added in additive minor bumps."
|
|
39
|
+
},
|
|
40
|
+
"context": {
|
|
41
|
+
"$ref": "/schemas/3.0.25/core/context.json"
|
|
42
|
+
},
|
|
43
|
+
"ext": {
|
|
44
|
+
"$ref": "/schemas/3.0.25/core/ext.json"
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
"required": [
|
|
48
|
+
"success",
|
|
49
|
+
"scenarios"
|
|
50
|
+
],
|
|
51
|
+
"additionalProperties": true,
|
|
52
|
+
"not": {
|
|
53
|
+
"anyOf": [
|
|
54
|
+
{
|
|
55
|
+
"required": [
|
|
56
|
+
"error"
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"required": [
|
|
61
|
+
"previous_state"
|
|
62
|
+
]
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"required": [
|
|
66
|
+
"simulated"
|
|
67
|
+
]
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"required": [
|
|
71
|
+
"forced"
|
|
72
|
+
]
|
|
73
|
+
}
|
|
74
|
+
]
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"title": "StateTransitionSuccess",
|
|
79
|
+
"description": "A force_* scenario successfully transitioned the entity to the target state",
|
|
80
|
+
"type": "object",
|
|
81
|
+
"properties": {
|
|
82
|
+
"success": {
|
|
83
|
+
"type": "boolean",
|
|
84
|
+
"const": true
|
|
85
|
+
},
|
|
86
|
+
"previous_state": {
|
|
87
|
+
"type": "string",
|
|
88
|
+
"description": "State before this transition"
|
|
89
|
+
},
|
|
90
|
+
"current_state": {
|
|
91
|
+
"type": "string",
|
|
92
|
+
"description": "State after this transition"
|
|
93
|
+
},
|
|
94
|
+
"message": {
|
|
95
|
+
"type": "string",
|
|
96
|
+
"description": "Human-readable description of the transition"
|
|
97
|
+
},
|
|
98
|
+
"context": {
|
|
99
|
+
"$ref": "/schemas/3.0.25/core/context.json"
|
|
100
|
+
},
|
|
101
|
+
"ext": {
|
|
102
|
+
"$ref": "/schemas/3.0.25/core/ext.json"
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"required": [
|
|
106
|
+
"success",
|
|
107
|
+
"previous_state",
|
|
108
|
+
"current_state"
|
|
109
|
+
],
|
|
110
|
+
"additionalProperties": true,
|
|
111
|
+
"not": {
|
|
112
|
+
"anyOf": [
|
|
113
|
+
{
|
|
114
|
+
"required": [
|
|
115
|
+
"error"
|
|
116
|
+
]
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"required": [
|
|
120
|
+
"scenarios"
|
|
121
|
+
]
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"required": [
|
|
125
|
+
"simulated"
|
|
126
|
+
]
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"required": [
|
|
130
|
+
"forced"
|
|
131
|
+
]
|
|
132
|
+
}
|
|
133
|
+
]
|
|
134
|
+
}
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"title": "SimulationSuccess",
|
|
138
|
+
"description": "A simulate_delivery or simulate_budget_spend scenario succeeded. For delivery: simulated contains impressions/clicks/reported_spend/conversions and cumulative contains running totals. For budget: simulated contains spend_percentage/computed_spend/budget.",
|
|
139
|
+
"type": "object",
|
|
140
|
+
"properties": {
|
|
141
|
+
"success": {
|
|
142
|
+
"type": "boolean",
|
|
143
|
+
"const": true
|
|
144
|
+
},
|
|
145
|
+
"simulated": {
|
|
146
|
+
"type": "object",
|
|
147
|
+
"description": "Values injected or applied by this call. Shape depends on scenario.",
|
|
148
|
+
"additionalProperties": true
|
|
149
|
+
},
|
|
150
|
+
"cumulative": {
|
|
151
|
+
"type": "object",
|
|
152
|
+
"description": "Running totals across all simulation calls (simulate_delivery only)",
|
|
153
|
+
"additionalProperties": true
|
|
154
|
+
},
|
|
155
|
+
"message": {
|
|
156
|
+
"type": "string"
|
|
157
|
+
},
|
|
158
|
+
"context": {
|
|
159
|
+
"$ref": "/schemas/3.0.25/core/context.json"
|
|
160
|
+
},
|
|
161
|
+
"ext": {
|
|
162
|
+
"$ref": "/schemas/3.0.25/core/ext.json"
|
|
163
|
+
}
|
|
164
|
+
},
|
|
165
|
+
"required": [
|
|
166
|
+
"success",
|
|
167
|
+
"simulated"
|
|
168
|
+
],
|
|
169
|
+
"additionalProperties": true,
|
|
170
|
+
"not": {
|
|
171
|
+
"anyOf": [
|
|
172
|
+
{
|
|
173
|
+
"required": [
|
|
174
|
+
"error"
|
|
175
|
+
]
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"required": [
|
|
179
|
+
"scenarios"
|
|
180
|
+
]
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"required": [
|
|
184
|
+
"previous_state"
|
|
185
|
+
]
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"required": [
|
|
189
|
+
"forced"
|
|
190
|
+
]
|
|
191
|
+
}
|
|
192
|
+
]
|
|
193
|
+
}
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"title": "ForcedDirectiveSuccess",
|
|
197
|
+
"description": "A force_create_media_buy_arm directive was registered. The directive shapes the next create_media_buy call from this caller's authenticated sandbox account into the requested arm, then is consumed. No entity transitioned — there is no media buy yet — so this branch carries 'forced' rather than previous_state/current_state.",
|
|
198
|
+
"type": "object",
|
|
199
|
+
"properties": {
|
|
200
|
+
"success": {
|
|
201
|
+
"type": "boolean",
|
|
202
|
+
"const": true
|
|
203
|
+
},
|
|
204
|
+
"forced": {
|
|
205
|
+
"type": "object",
|
|
206
|
+
"description": "Echo of the registered directive. The next create_media_buy call from this sandbox account will return the named arm.",
|
|
207
|
+
"properties": {
|
|
208
|
+
"arm": {
|
|
209
|
+
"type": "string",
|
|
210
|
+
"enum": [
|
|
211
|
+
"submitted",
|
|
212
|
+
"input-required"
|
|
213
|
+
],
|
|
214
|
+
"description": "Arm the seller will emit on the next create_media_buy response."
|
|
215
|
+
},
|
|
216
|
+
"task_id": {
|
|
217
|
+
"type": "string",
|
|
218
|
+
"maxLength": 128,
|
|
219
|
+
"description": "Echo of the registered task_id. Present only when arm is 'submitted' (the arm that emits a task envelope).",
|
|
220
|
+
"x-entity": "task"
|
|
221
|
+
}
|
|
222
|
+
},
|
|
223
|
+
"required": [
|
|
224
|
+
"arm"
|
|
225
|
+
],
|
|
226
|
+
"additionalProperties": false
|
|
227
|
+
},
|
|
228
|
+
"message": {
|
|
229
|
+
"type": "string",
|
|
230
|
+
"description": "Human-readable acknowledgement."
|
|
231
|
+
},
|
|
232
|
+
"context": {
|
|
233
|
+
"$ref": "/schemas/3.0.25/core/context.json"
|
|
234
|
+
},
|
|
235
|
+
"ext": {
|
|
236
|
+
"$ref": "/schemas/3.0.25/core/ext.json"
|
|
237
|
+
}
|
|
238
|
+
},
|
|
239
|
+
"required": [
|
|
240
|
+
"success",
|
|
241
|
+
"forced"
|
|
242
|
+
],
|
|
243
|
+
"additionalProperties": true,
|
|
244
|
+
"not": {
|
|
245
|
+
"anyOf": [
|
|
246
|
+
{
|
|
247
|
+
"required": [
|
|
248
|
+
"error"
|
|
249
|
+
]
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
"required": [
|
|
253
|
+
"scenarios"
|
|
254
|
+
]
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"required": [
|
|
258
|
+
"previous_state"
|
|
259
|
+
]
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
"required": [
|
|
263
|
+
"simulated"
|
|
264
|
+
]
|
|
265
|
+
}
|
|
266
|
+
]
|
|
267
|
+
}
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"title": "SeedSuccess",
|
|
271
|
+
"description": "A seed_* scenario successfully pre-populated a fixture in the seller's test state",
|
|
272
|
+
"type": "object",
|
|
273
|
+
"properties": {
|
|
274
|
+
"success": {
|
|
275
|
+
"type": "boolean",
|
|
276
|
+
"const": true
|
|
277
|
+
},
|
|
278
|
+
"message": {
|
|
279
|
+
"type": "string",
|
|
280
|
+
"description": "Human-readable acknowledgement."
|
|
281
|
+
},
|
|
282
|
+
"context": {
|
|
283
|
+
"$ref": "/schemas/3.0.25/core/context.json"
|
|
284
|
+
},
|
|
285
|
+
"ext": {
|
|
286
|
+
"$ref": "/schemas/3.0.25/core/ext.json"
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
"required": [
|
|
290
|
+
"success"
|
|
291
|
+
],
|
|
292
|
+
"additionalProperties": true,
|
|
293
|
+
"not": {
|
|
294
|
+
"anyOf": [
|
|
295
|
+
{
|
|
296
|
+
"required": [
|
|
297
|
+
"error"
|
|
298
|
+
]
|
|
299
|
+
},
|
|
300
|
+
{
|
|
301
|
+
"required": [
|
|
302
|
+
"scenarios"
|
|
303
|
+
]
|
|
304
|
+
},
|
|
305
|
+
{
|
|
306
|
+
"required": [
|
|
307
|
+
"previous_state"
|
|
308
|
+
]
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
"required": [
|
|
312
|
+
"simulated"
|
|
313
|
+
]
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"required": [
|
|
317
|
+
"forced"
|
|
318
|
+
]
|
|
319
|
+
}
|
|
320
|
+
]
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"title": "ControllerError",
|
|
325
|
+
"description": "The scenario failed — invalid transition, unknown entity, unsupported scenario, or invalid params",
|
|
326
|
+
"type": "object",
|
|
327
|
+
"properties": {
|
|
328
|
+
"success": {
|
|
329
|
+
"type": "boolean",
|
|
330
|
+
"const": false
|
|
331
|
+
},
|
|
332
|
+
"error": {
|
|
333
|
+
"type": "string",
|
|
334
|
+
"enum": [
|
|
335
|
+
"INVALID_TRANSITION",
|
|
336
|
+
"INVALID_STATE",
|
|
337
|
+
"NOT_FOUND",
|
|
338
|
+
"UNKNOWN_SCENARIO",
|
|
339
|
+
"INVALID_PARAMS",
|
|
340
|
+
"FORBIDDEN",
|
|
341
|
+
"INTERNAL_ERROR"
|
|
342
|
+
],
|
|
343
|
+
"description": "Structured error code"
|
|
344
|
+
},
|
|
345
|
+
"error_detail": {
|
|
346
|
+
"type": "string",
|
|
347
|
+
"description": "Human-readable explanation of the failure"
|
|
348
|
+
},
|
|
349
|
+
"current_state": {
|
|
350
|
+
"type": [
|
|
351
|
+
"string",
|
|
352
|
+
"null"
|
|
353
|
+
],
|
|
354
|
+
"description": "Current state of the entity, or null if not found"
|
|
355
|
+
},
|
|
356
|
+
"context": {
|
|
357
|
+
"$ref": "/schemas/3.0.25/core/context.json"
|
|
358
|
+
},
|
|
359
|
+
"ext": {
|
|
360
|
+
"$ref": "/schemas/3.0.25/core/ext.json"
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
"required": [
|
|
364
|
+
"success",
|
|
365
|
+
"error"
|
|
366
|
+
],
|
|
367
|
+
"additionalProperties": true,
|
|
368
|
+
"not": {
|
|
369
|
+
"anyOf": [
|
|
370
|
+
{
|
|
371
|
+
"required": [
|
|
372
|
+
"scenarios"
|
|
373
|
+
]
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"required": [
|
|
377
|
+
"simulated"
|
|
378
|
+
]
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"required": [
|
|
382
|
+
"previous_state"
|
|
383
|
+
]
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"required": [
|
|
387
|
+
"forced"
|
|
388
|
+
]
|
|
389
|
+
}
|
|
390
|
+
]
|
|
391
|
+
}
|
|
392
|
+
}
|
|
393
|
+
],
|
|
394
|
+
"examples": [
|
|
395
|
+
{
|
|
396
|
+
"description": "List scenarios response",
|
|
397
|
+
"data": {
|
|
398
|
+
"success": true,
|
|
399
|
+
"scenarios": [
|
|
400
|
+
"force_creative_status",
|
|
401
|
+
"force_account_status",
|
|
402
|
+
"force_media_buy_status"
|
|
403
|
+
]
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"description": "Successful state transition",
|
|
408
|
+
"data": {
|
|
409
|
+
"success": true,
|
|
410
|
+
"previous_state": "processing",
|
|
411
|
+
"current_state": "approved",
|
|
412
|
+
"message": "Creative cr-123 transitioned from processing to approved"
|
|
413
|
+
}
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"description": "Delivery simulation with cumulative totals",
|
|
417
|
+
"data": {
|
|
418
|
+
"success": true,
|
|
419
|
+
"simulated": {
|
|
420
|
+
"impressions": 10000,
|
|
421
|
+
"clicks": 150,
|
|
422
|
+
"reported_spend": {
|
|
423
|
+
"amount": 150,
|
|
424
|
+
"currency": "USD"
|
|
425
|
+
}
|
|
426
|
+
},
|
|
427
|
+
"cumulative": {
|
|
428
|
+
"impressions": 25000,
|
|
429
|
+
"clicks": 380,
|
|
430
|
+
"reported_spend": {
|
|
431
|
+
"amount": 375,
|
|
432
|
+
"currency": "USD"
|
|
433
|
+
}
|
|
434
|
+
},
|
|
435
|
+
"message": "Delivery simulated for mb-789: 10000 impressions, 150 clicks, $150.00 spend"
|
|
436
|
+
}
|
|
437
|
+
},
|
|
438
|
+
{
|
|
439
|
+
"description": "Budget spend simulation",
|
|
440
|
+
"data": {
|
|
441
|
+
"success": true,
|
|
442
|
+
"simulated": {
|
|
443
|
+
"spend_percentage": 95,
|
|
444
|
+
"computed_spend": {
|
|
445
|
+
"amount": 950,
|
|
446
|
+
"currency": "USD"
|
|
447
|
+
},
|
|
448
|
+
"budget": {
|
|
449
|
+
"amount": 1000,
|
|
450
|
+
"currency": "USD"
|
|
451
|
+
}
|
|
452
|
+
},
|
|
453
|
+
"message": "Budget for mb-789 set to 95% consumed ($950.00 of $1000.00)"
|
|
454
|
+
}
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
"description": "force_create_media_buy_arm directive registered",
|
|
458
|
+
"data": {
|
|
459
|
+
"success": true,
|
|
460
|
+
"forced": {
|
|
461
|
+
"arm": "submitted",
|
|
462
|
+
"task_id": "task_async_signed_io_q2"
|
|
463
|
+
},
|
|
464
|
+
"message": "Next create_media_buy call from this sandbox account will return the submitted arm with task_id task_async_signed_io_q2"
|
|
465
|
+
}
|
|
466
|
+
},
|
|
467
|
+
{
|
|
468
|
+
"description": "Invalid transition error",
|
|
469
|
+
"data": {
|
|
470
|
+
"success": false,
|
|
471
|
+
"error": "INVALID_TRANSITION",
|
|
472
|
+
"error_detail": "Cannot transition from archived to processing — archived is terminal",
|
|
473
|
+
"current_state": "archived"
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
{
|
|
477
|
+
"description": "Entity not found",
|
|
478
|
+
"data": {
|
|
479
|
+
"success": false,
|
|
480
|
+
"error": "NOT_FOUND",
|
|
481
|
+
"error_detail": "Creative cr-unknown not found",
|
|
482
|
+
"current_state": null
|
|
483
|
+
}
|
|
484
|
+
}
|
|
485
|
+
]
|
|
486
|
+
}
|