@adcp/client 3.17.0 → 3.18.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/types/core.generated.d.ts +24 -0
- 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 +80 -0
- package/dist/lib/types/schemas.generated.d.ts.map +1 -1
- package/dist/lib/types/schemas.generated.js +27 -4
- package/dist/lib/types/schemas.generated.js.map +1 -1
- package/dist/lib/types/tools.generated.d.ts +89 -1
- package/dist/lib/types/tools.generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -385,6 +385,10 @@ export interface MediaBuyFeatures {
|
|
|
385
385
|
* Supports sync_audiences task and audience_include/audience_exclude in targeting overlays for first-party CRM audience management
|
|
386
386
|
*/
|
|
387
387
|
audience_targeting?: boolean;
|
|
388
|
+
/**
|
|
389
|
+
* Supports sandbox mode for operations without real platform calls or spend
|
|
390
|
+
*/
|
|
391
|
+
sandbox?: boolean;
|
|
388
392
|
[k: string]: boolean | undefined;
|
|
389
393
|
}
|
|
390
394
|
/**
|
|
@@ -606,6 +610,10 @@ export interface GetProductsResponse {
|
|
|
606
610
|
*/
|
|
607
611
|
product_selectors_applied?: boolean;
|
|
608
612
|
pagination?: PaginationResponse;
|
|
613
|
+
/**
|
|
614
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
615
|
+
*/
|
|
616
|
+
sandbox?: boolean;
|
|
609
617
|
context?: ContextObject;
|
|
610
618
|
ext?: ExtensionObject;
|
|
611
619
|
}
|
|
@@ -1800,6 +1808,14 @@ export interface ListCreativeFormatsRequest {
|
|
|
1800
1808
|
*/
|
|
1801
1809
|
name_search?: string;
|
|
1802
1810
|
wcag_level?: WCAGLevel;
|
|
1811
|
+
/**
|
|
1812
|
+
* Filter to formats whose output_format_ids includes any of these format IDs. Returns formats that can produce these outputs — inspect each result's input_format_ids to see what inputs they accept.
|
|
1813
|
+
*/
|
|
1814
|
+
output_format_ids?: FormatID[];
|
|
1815
|
+
/**
|
|
1816
|
+
* Filter to formats whose input_format_ids includes any of these format IDs. Returns formats that accept these creatives as input — inspect each result's output_format_ids to see what they can produce.
|
|
1817
|
+
*/
|
|
1818
|
+
input_format_ids?: FormatID[];
|
|
1803
1819
|
pagination?: PaginationRequest;
|
|
1804
1820
|
context?: ContextObject;
|
|
1805
1821
|
ext?: ExtensionObject;
|
|
@@ -1849,6 +1865,10 @@ export interface ListCreativeFormatsResponse {
|
|
|
1849
1865
|
*/
|
|
1850
1866
|
errors?: Error[];
|
|
1851
1867
|
pagination?: PaginationResponse;
|
|
1868
|
+
/**
|
|
1869
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
1870
|
+
*/
|
|
1871
|
+
sandbox?: boolean;
|
|
1852
1872
|
context?: ContextObject;
|
|
1853
1873
|
ext?: ExtensionObject;
|
|
1854
1874
|
}
|
|
@@ -1935,7 +1955,11 @@ export interface Format {
|
|
|
1935
1955
|
*/
|
|
1936
1956
|
supported_macros?: (UniversalMacro | string)[];
|
|
1937
1957
|
/**
|
|
1938
|
-
*
|
|
1958
|
+
* Array of format IDs this format accepts as input creative manifests. When present, indicates this format can take existing creatives in these formats as input. Omit for formats that work from raw assets (images, text, etc.) rather than existing creatives.
|
|
1959
|
+
*/
|
|
1960
|
+
input_format_ids?: FormatID1[];
|
|
1961
|
+
/**
|
|
1962
|
+
* Array of format IDs that this format can produce as output. When present, indicates this format can build creatives in these output formats (e.g., a multi-publisher template format might produce standard display formats across many publishers). Omit for formats that produce a single fixed output (the format itself).
|
|
1939
1963
|
*/
|
|
1940
1964
|
output_format_ids?: FormatID1[];
|
|
1941
1965
|
/**
|
|
@@ -3169,6 +3193,10 @@ export interface CreateMediaBuySuccess {
|
|
|
3169
3193
|
* Array of created packages with complete state information
|
|
3170
3194
|
*/
|
|
3171
3195
|
packages: Package[];
|
|
3196
|
+
/**
|
|
3197
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
3198
|
+
*/
|
|
3199
|
+
sandbox?: boolean;
|
|
3172
3200
|
context?: ContextObject;
|
|
3173
3201
|
ext?: ExtensionObject;
|
|
3174
3202
|
}
|
|
@@ -3227,6 +3255,10 @@ export interface Account {
|
|
|
3227
3255
|
amount: number;
|
|
3228
3256
|
currency: string;
|
|
3229
3257
|
};
|
|
3258
|
+
/**
|
|
3259
|
+
* When true, this is a sandbox account. All requests using this account_id are treated as sandbox — no real platform calls, no real spend.
|
|
3260
|
+
*/
|
|
3261
|
+
sandbox?: boolean;
|
|
3230
3262
|
ext?: ExtensionObject;
|
|
3231
3263
|
[k: string]: unknown | undefined;
|
|
3232
3264
|
}
|
|
@@ -3442,6 +3474,10 @@ export interface SyncCreativesSuccess {
|
|
|
3442
3474
|
[k: string]: string;
|
|
3443
3475
|
};
|
|
3444
3476
|
}[];
|
|
3477
|
+
/**
|
|
3478
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
3479
|
+
*/
|
|
3480
|
+
sandbox?: boolean;
|
|
3445
3481
|
context?: ContextObject;
|
|
3446
3482
|
ext?: ExtensionObject;
|
|
3447
3483
|
}
|
|
@@ -3794,6 +3830,10 @@ export interface ListCreativesResponse {
|
|
|
3794
3830
|
*/
|
|
3795
3831
|
archived?: number;
|
|
3796
3832
|
};
|
|
3833
|
+
/**
|
|
3834
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
3835
|
+
*/
|
|
3836
|
+
sandbox?: boolean;
|
|
3797
3837
|
context?: ContextObject;
|
|
3798
3838
|
ext?: ExtensionObject;
|
|
3799
3839
|
}
|
|
@@ -3906,6 +3946,10 @@ export interface UpdateMediaBuySuccess {
|
|
|
3906
3946
|
* Array of packages that were modified with complete state information
|
|
3907
3947
|
*/
|
|
3908
3948
|
affected_packages?: Package[];
|
|
3949
|
+
/**
|
|
3950
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
3951
|
+
*/
|
|
3952
|
+
sandbox?: boolean;
|
|
3909
3953
|
context?: ContextObject;
|
|
3910
3954
|
ext?: ExtensionObject;
|
|
3911
3955
|
}
|
|
@@ -4176,6 +4220,10 @@ export interface GetMediaBuyDeliveryResponse {
|
|
|
4176
4220
|
* Task-specific errors and warnings (e.g., missing delivery data, reporting platform issues)
|
|
4177
4221
|
*/
|
|
4178
4222
|
errors?: Error[];
|
|
4223
|
+
/**
|
|
4224
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
4225
|
+
*/
|
|
4226
|
+
sandbox?: boolean;
|
|
4179
4227
|
context?: ContextObject;
|
|
4180
4228
|
ext?: ExtensionObject;
|
|
4181
4229
|
}
|
|
@@ -4479,6 +4527,10 @@ export interface ProvidePerformanceFeedbackSuccess {
|
|
|
4479
4527
|
* Whether the performance feedback was successfully received
|
|
4480
4528
|
*/
|
|
4481
4529
|
success: true;
|
|
4530
|
+
/**
|
|
4531
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
4532
|
+
*/
|
|
4533
|
+
sandbox?: boolean;
|
|
4482
4534
|
context?: ContextObject;
|
|
4483
4535
|
ext?: ExtensionObject;
|
|
4484
4536
|
}
|
|
@@ -4594,6 +4646,10 @@ export interface SyncEventSourcesSuccess {
|
|
|
4594
4646
|
*/
|
|
4595
4647
|
errors?: string[];
|
|
4596
4648
|
}[];
|
|
4649
|
+
/**
|
|
4650
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
4651
|
+
*/
|
|
4652
|
+
sandbox?: boolean;
|
|
4597
4653
|
context?: ContextObject;
|
|
4598
4654
|
ext?: ExtensionObject;
|
|
4599
4655
|
}
|
|
@@ -4828,6 +4884,10 @@ export interface LogEventSuccess {
|
|
|
4828
4884
|
* Overall match quality score for the batch (0.0 = no matches, 1.0 = all matched)
|
|
4829
4885
|
*/
|
|
4830
4886
|
match_quality?: number;
|
|
4887
|
+
/**
|
|
4888
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
4889
|
+
*/
|
|
4890
|
+
sandbox?: boolean;
|
|
4831
4891
|
context?: ContextObject;
|
|
4832
4892
|
ext?: ExtensionObject;
|
|
4833
4893
|
}
|
|
@@ -4985,6 +5045,10 @@ export interface SyncAudiencesSuccess {
|
|
|
4985
5045
|
*/
|
|
4986
5046
|
errors?: Error[];
|
|
4987
5047
|
}[];
|
|
5048
|
+
/**
|
|
5049
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
5050
|
+
*/
|
|
5051
|
+
sandbox?: boolean;
|
|
4988
5052
|
context?: ContextObject;
|
|
4989
5053
|
ext?: ExtensionObject;
|
|
4990
5054
|
}
|
|
@@ -5170,6 +5234,10 @@ export type BuildCreativeResponse = BuildCreativeSuccess | BuildCreativeError;
|
|
|
5170
5234
|
*/
|
|
5171
5235
|
export interface BuildCreativeSuccess {
|
|
5172
5236
|
creative_manifest: CreativeManifest;
|
|
5237
|
+
/**
|
|
5238
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
5239
|
+
*/
|
|
5240
|
+
sandbox?: boolean;
|
|
5173
5241
|
context?: ContextObject;
|
|
5174
5242
|
ext?: ExtensionObject;
|
|
5175
5243
|
}
|
|
@@ -6256,6 +6324,10 @@ export interface GetSignalsResponse {
|
|
|
6256
6324
|
*/
|
|
6257
6325
|
errors?: Error[];
|
|
6258
6326
|
pagination?: PaginationResponse;
|
|
6327
|
+
/**
|
|
6328
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
6329
|
+
*/
|
|
6330
|
+
sandbox?: boolean;
|
|
6259
6331
|
context?: ContextObject;
|
|
6260
6332
|
ext?: ExtensionObject;
|
|
6261
6333
|
}
|
|
@@ -6292,6 +6364,10 @@ export interface ActivateSignalSuccess {
|
|
|
6292
6364
|
* Array of deployment results for each deployment target
|
|
6293
6365
|
*/
|
|
6294
6366
|
deployments: Deployment[];
|
|
6367
|
+
/**
|
|
6368
|
+
* When true, this response contains simulated data from sandbox mode.
|
|
6369
|
+
*/
|
|
6370
|
+
sandbox?: boolean;
|
|
6295
6371
|
context?: ContextObject;
|
|
6296
6372
|
ext?: ExtensionObject;
|
|
6297
6373
|
}
|
|
@@ -8838,6 +8914,10 @@ export interface ListAccountsRequest {
|
|
|
8838
8914
|
*/
|
|
8839
8915
|
status?: 'active' | 'pending_approval' | 'payment_required' | 'suspended' | 'closed';
|
|
8840
8916
|
pagination?: PaginationRequest;
|
|
8917
|
+
/**
|
|
8918
|
+
* Filter by sandbox status. true returns only sandbox accounts, false returns only production accounts. Omit to return all accounts.
|
|
8919
|
+
*/
|
|
8920
|
+
sandbox?: boolean;
|
|
8841
8921
|
context?: ContextObject;
|
|
8842
8922
|
ext?: ExtensionObject;
|
|
8843
8923
|
}
|
|
@@ -8889,6 +8969,10 @@ export interface SyncAccountsRequest {
|
|
|
8889
8969
|
* Who should be invoiced. brand: seller invoices the brand directly. operator: seller invoices the operator (agency). agent: agent consolidates billing across brands. Omit to accept the seller's default.
|
|
8890
8970
|
*/
|
|
8891
8971
|
billing?: 'brand' | 'operator' | 'agent';
|
|
8972
|
+
/**
|
|
8973
|
+
* When true, provision this as a sandbox account. No real platform calls or billing. Sandbox accounts are identified by account_id in subsequent requests.
|
|
8974
|
+
*/
|
|
8975
|
+
sandbox?: boolean;
|
|
8892
8976
|
}[];
|
|
8893
8977
|
/**
|
|
8894
8978
|
* When true, accounts previously synced by this agent but not included in this request will be deactivated. Scoped to the authenticated agent — does not affect accounts managed by other agents. Use with caution.
|
|
@@ -8994,6 +9078,10 @@ export interface SyncAccountsSuccess {
|
|
|
8994
9078
|
* Non-fatal warnings about this account
|
|
8995
9079
|
*/
|
|
8996
9080
|
warnings?: string[];
|
|
9081
|
+
/**
|
|
9082
|
+
* Whether this is a sandbox account, echoed from the request.
|
|
9083
|
+
*/
|
|
9084
|
+
sandbox?: boolean;
|
|
8997
9085
|
}[];
|
|
8998
9086
|
context?: ContextObject;
|
|
8999
9087
|
ext?: ExtensionObject;
|