@adcp/client 3.22.0 → 3.23.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/dist/lib/agents/index.generated.d.ts +9 -1
- package/dist/lib/agents/index.generated.d.ts.map +1 -1
- package/dist/lib/agents/index.generated.js +12 -0
- package/dist/lib/agents/index.generated.js.map +1 -1
- package/dist/lib/protocols/a2a.d.ts +1 -1
- package/dist/lib/protocols/a2a.d.ts.map +1 -1
- package/dist/lib/protocols/a2a.js +3 -2
- package/dist/lib/protocols/a2a.js.map +1 -1
- package/dist/lib/protocols/index.d.ts +2 -2
- package/dist/lib/protocols/index.d.ts.map +1 -1
- package/dist/lib/protocols/index.js +6 -6
- package/dist/lib/protocols/index.js.map +1 -1
- package/dist/lib/protocols/mcp.d.ts +4 -1
- package/dist/lib/protocols/mcp.d.ts.map +1 -1
- package/dist/lib/protocols/mcp.js +24 -25
- package/dist/lib/protocols/mcp.js.map +1 -1
- package/dist/lib/types/adcp.d.ts +14 -0
- package/dist/lib/types/adcp.d.ts.map +1 -1
- package/dist/lib/types/core.generated.d.ts +18 -1
- package/dist/lib/types/core.generated.d.ts.map +1 -1
- package/dist/lib/types/core.generated.js +1 -1
- package/dist/lib/types/schemas.generated.d.ts +294 -186
- package/dist/lib/types/schemas.generated.d.ts.map +1 -1
- package/dist/lib/types/schemas.generated.js +59 -25
- package/dist/lib/types/schemas.generated.js.map +1 -1
- package/dist/lib/types/tools.generated.d.ts +140 -28
- package/dist/lib/types/tools.generated.d.ts.map +1 -1
- package/dist/lib/types/tools.generated.js +3 -0
- package/dist/lib/types/tools.generated.js.map +1 -1
- package/package.json +1 -1
|
@@ -2381,6 +2381,7 @@ export interface CreateMediaBuyRequest {
|
|
|
2381
2381
|
* Campaign end date/time in ISO 8601 format
|
|
2382
2382
|
*/
|
|
2383
2383
|
end_time: string;
|
|
2384
|
+
push_notification_config?: PushNotificationConfig;
|
|
2384
2385
|
reporting_webhook?: ReportingWebhook;
|
|
2385
2386
|
/**
|
|
2386
2387
|
* Optional webhook configuration for content artifact delivery. Used by governance agents to validate content adjacency. Seller pushes artifacts to this endpoint; orchestrator forwards to governance agent for validation.
|
|
@@ -3026,6 +3027,34 @@ export interface URLAsset {
|
|
|
3026
3027
|
/**
|
|
3027
3028
|
* Brand reference for this media buy. Resolved to full brand identity at execution time from brand.json or the registry.
|
|
3028
3029
|
*/
|
|
3030
|
+
export interface PushNotificationConfig {
|
|
3031
|
+
/**
|
|
3032
|
+
* Webhook endpoint URL for task status notifications
|
|
3033
|
+
*/
|
|
3034
|
+
url: string;
|
|
3035
|
+
/**
|
|
3036
|
+
* Optional client-provided token for webhook validation. Echoed back in webhook payload to validate request authenticity.
|
|
3037
|
+
*/
|
|
3038
|
+
token?: string;
|
|
3039
|
+
/**
|
|
3040
|
+
* Authentication configuration for webhook delivery (A2A-compatible)
|
|
3041
|
+
*/
|
|
3042
|
+
authentication: {
|
|
3043
|
+
/**
|
|
3044
|
+
* Array of authentication schemes. Supported: ['Bearer'] for simple token auth, ['HMAC-SHA256'] for signature verification (recommended for production)
|
|
3045
|
+
*
|
|
3046
|
+
* @maxItems 1
|
|
3047
|
+
*/
|
|
3048
|
+
schemes: [] | [AuthenticationScheme];
|
|
3049
|
+
/**
|
|
3050
|
+
* Credentials for authentication. For Bearer: token sent in Authorization header. For HMAC-SHA256: shared secret used to generate signature. Minimum 32 characters. Exchanged out-of-band during onboarding.
|
|
3051
|
+
*/
|
|
3052
|
+
credentials: string;
|
|
3053
|
+
};
|
|
3054
|
+
}
|
|
3055
|
+
/**
|
|
3056
|
+
* Optional webhook configuration for automated reporting delivery
|
|
3057
|
+
*/
|
|
3029
3058
|
export interface ReportingWebhook {
|
|
3030
3059
|
/**
|
|
3031
3060
|
* Webhook endpoint URL for reporting notifications
|
|
@@ -3153,6 +3182,23 @@ export interface Account {
|
|
|
3153
3182
|
amount: number;
|
|
3154
3183
|
currency: string;
|
|
3155
3184
|
};
|
|
3185
|
+
/**
|
|
3186
|
+
* Present when status is 'pending_approval'. Contains next steps for completing account activation.
|
|
3187
|
+
*/
|
|
3188
|
+
setup?: {
|
|
3189
|
+
/**
|
|
3190
|
+
* URL where the human can complete the required action (credit application, legal agreement, add funds).
|
|
3191
|
+
*/
|
|
3192
|
+
url?: string;
|
|
3193
|
+
/**
|
|
3194
|
+
* Human-readable description of what's needed.
|
|
3195
|
+
*/
|
|
3196
|
+
message: string;
|
|
3197
|
+
/**
|
|
3198
|
+
* When this setup link expires.
|
|
3199
|
+
*/
|
|
3200
|
+
expires_at?: string;
|
|
3201
|
+
};
|
|
3156
3202
|
/**
|
|
3157
3203
|
* When true, this is a sandbox account. All requests using this account_id are treated as sandbox — no real platform calls, no real spend.
|
|
3158
3204
|
*/
|
|
@@ -3274,34 +3320,6 @@ export interface SyncCreativesRequest {
|
|
|
3274
3320
|
/**
|
|
3275
3321
|
* Creative asset for upload to library - supports static assets, generative formats, and third-party snippets
|
|
3276
3322
|
*/
|
|
3277
|
-
export interface PushNotificationConfig {
|
|
3278
|
-
/**
|
|
3279
|
-
* Webhook endpoint URL for task status notifications
|
|
3280
|
-
*/
|
|
3281
|
-
url: string;
|
|
3282
|
-
/**
|
|
3283
|
-
* Optional client-provided token for webhook validation. Echoed back in webhook payload to validate request authenticity.
|
|
3284
|
-
*/
|
|
3285
|
-
token?: string;
|
|
3286
|
-
/**
|
|
3287
|
-
* Authentication configuration for webhook delivery (A2A-compatible)
|
|
3288
|
-
*/
|
|
3289
|
-
authentication: {
|
|
3290
|
-
/**
|
|
3291
|
-
* Array of authentication schemes. Supported: ['Bearer'] for simple token auth, ['HMAC-SHA256'] for signature verification (recommended for production)
|
|
3292
|
-
*
|
|
3293
|
-
* @maxItems 1
|
|
3294
|
-
*/
|
|
3295
|
-
schemes: [] | [AuthenticationScheme];
|
|
3296
|
-
/**
|
|
3297
|
-
* Credentials for authentication. For Bearer: token sent in Authorization header. For HMAC-SHA256: shared secret used to generate signature. Minimum 32 characters. Exchanged out-of-band during onboarding.
|
|
3298
|
-
*/
|
|
3299
|
-
credentials: string;
|
|
3300
|
-
};
|
|
3301
|
-
}
|
|
3302
|
-
/**
|
|
3303
|
-
* Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
|
|
3304
|
-
*/
|
|
3305
3323
|
/**
|
|
3306
3324
|
* Response from creative sync operation. Returns either per-creative results (best-effort processing) OR operation-level errors (complete failure). This enforces atomic semantics at the operation level while allowing per-item failures within successful operations.
|
|
3307
3325
|
*/
|
|
@@ -8858,4 +8876,98 @@ export interface SyncAccountsError {
|
|
|
8858
8876
|
context?: ContextObject;
|
|
8859
8877
|
ext?: ExtensionObject;
|
|
8860
8878
|
}
|
|
8879
|
+
/**
|
|
8880
|
+
* Reports how a vendor's service was consumed after campaign delivery. Used by orchestrators (DSPs, storefronts) to inform vendor agents (signals, governance, creative) what was used so the vendor can track earned revenue and verify billing. Records can span multiple accounts, operators, and campaigns in a single request.
|
|
8881
|
+
*/
|
|
8882
|
+
export interface ReportUsageRequest {
|
|
8883
|
+
/**
|
|
8884
|
+
* The time range covered by this usage report. Applies to all records in the request.
|
|
8885
|
+
*/
|
|
8886
|
+
reporting_period: {
|
|
8887
|
+
/**
|
|
8888
|
+
* Start of the reporting period (inclusive), in UTC.
|
|
8889
|
+
*/
|
|
8890
|
+
start: string;
|
|
8891
|
+
/**
|
|
8892
|
+
* End of the reporting period (inclusive), in UTC.
|
|
8893
|
+
*/
|
|
8894
|
+
end: string;
|
|
8895
|
+
};
|
|
8896
|
+
/**
|
|
8897
|
+
* One or more usage records. Each record is self-contained: it carries its own account_id, operator_id, and buyer_campaign_ref, allowing a single request to span multiple accounts, operators, and campaigns.
|
|
8898
|
+
*/
|
|
8899
|
+
usage: {
|
|
8900
|
+
/**
|
|
8901
|
+
* The account with this vendor agent for this record, obtained from sync_accounts.
|
|
8902
|
+
*/
|
|
8903
|
+
account_id: string;
|
|
8904
|
+
/**
|
|
8905
|
+
* The operator on whose behalf this usage is reported. Identifies the billing party — the entity that owes the vendor for this consumption.
|
|
8906
|
+
*/
|
|
8907
|
+
operator_id: string;
|
|
8908
|
+
/**
|
|
8909
|
+
* The buyer's campaign reference (e.g., a media_buy_id). Used to group records by campaign.
|
|
8910
|
+
*/
|
|
8911
|
+
buyer_campaign_ref?: string;
|
|
8912
|
+
/**
|
|
8913
|
+
* The type of vendor service consumed.
|
|
8914
|
+
*/
|
|
8915
|
+
kind: 'signal' | 'content_standards' | 'creative';
|
|
8916
|
+
/**
|
|
8917
|
+
* Amount owed to the vendor for this record, denominated in currency.
|
|
8918
|
+
*/
|
|
8919
|
+
vendor_cost: number;
|
|
8920
|
+
/**
|
|
8921
|
+
* ISO 4217 currency code.
|
|
8922
|
+
*/
|
|
8923
|
+
currency: string;
|
|
8924
|
+
/**
|
|
8925
|
+
* Impressions delivered using this vendor service. Required when kind is 'signal'.
|
|
8926
|
+
*/
|
|
8927
|
+
impressions?: number;
|
|
8928
|
+
/**
|
|
8929
|
+
* Media spend in currency for the period. Required when a percent_of_media pricing model was used, so the vendor can verify the applied rate.
|
|
8930
|
+
*/
|
|
8931
|
+
media_spend?: number;
|
|
8932
|
+
/**
|
|
8933
|
+
* Signal identifier from get_signals. Required when kind is 'signal'.
|
|
8934
|
+
*/
|
|
8935
|
+
signal_agent_segment_id?: string;
|
|
8936
|
+
/**
|
|
8937
|
+
* Pricing option identifier from the original get_signals response. The vendor uses this to verify the correct rate was applied. Required when kind is 'signal'.
|
|
8938
|
+
*/
|
|
8939
|
+
pricing_option_id?: string;
|
|
8940
|
+
/**
|
|
8941
|
+
* Content standards configuration identifier. Required when kind is 'content_standards'.
|
|
8942
|
+
*/
|
|
8943
|
+
standards_id?: string;
|
|
8944
|
+
}[];
|
|
8945
|
+
context?: ContextObject;
|
|
8946
|
+
ext?: ExtensionObject;
|
|
8947
|
+
}
|
|
8948
|
+
/**
|
|
8949
|
+
* Opaque correlation data that is echoed unchanged in responses. Used for internal tracking, UI session IDs, trace IDs, and other caller-specific identifiers that don't affect protocol behavior. Context data is never parsed by AdCP agents - it's simply preserved and returned.
|
|
8950
|
+
*/
|
|
8951
|
+
/**
|
|
8952
|
+
* Response from report_usage. Partial acceptance is valid — records that pass validation are stored even when others fail.
|
|
8953
|
+
*/
|
|
8954
|
+
export interface ReportUsageResponse {
|
|
8955
|
+
/**
|
|
8956
|
+
* Number of usage records successfully stored.
|
|
8957
|
+
*/
|
|
8958
|
+
accepted: number;
|
|
8959
|
+
/**
|
|
8960
|
+
* Validation errors for individual records. The field property identifies which record failed (e.g., 'usage[1].pricing_option_id').
|
|
8961
|
+
*/
|
|
8962
|
+
errors?: Error[];
|
|
8963
|
+
/**
|
|
8964
|
+
* When true, the account is a sandbox account and no billing occurred.
|
|
8965
|
+
*/
|
|
8966
|
+
sandbox?: boolean;
|
|
8967
|
+
context?: ContextObject;
|
|
8968
|
+
ext?: ExtensionObject;
|
|
8969
|
+
}
|
|
8970
|
+
/**
|
|
8971
|
+
* Standard error structure for task-specific errors and warnings
|
|
8972
|
+
*/
|
|
8861
8973
|
//# sourceMappingURL=tools.generated.d.ts.map
|