@apostra/sdk 0.0.0-stage → 0.38.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/LICENSE +201 -0
- package/README.md +117 -2
- package/SKILL.md +29 -0
- package/dist/generated/client.d.ts +1092 -0
- package/dist/generated/client.js +606 -0
- package/dist/generated/metadata.d.ts +989 -0
- package/dist/generated/metadata.js +1339 -0
- package/dist/generated/types.gen.d.ts +35171 -0
- package/dist/generated/types.gen.js +2 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +3 -0
- package/dist/transport.d.ts +142 -0
- package/dist/transport.js +600 -0
- package/dist/webhooks.d.ts +24 -0
- package/dist/webhooks.js +49 -0
- package/examples/first-value.ts +58 -0
- package/llms.txt +11 -0
- package/package.json +60 -4
|
@@ -0,0 +1,606 @@
|
|
|
1
|
+
import { Transport } from '../transport.js';
|
|
2
|
+
export class Apostra extends Transport {
|
|
3
|
+
/**
|
|
4
|
+
* Download a public immutable document revision
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* await client.downloadV3PublicDocumentRevision(input)
|
|
8
|
+
*/
|
|
9
|
+
downloadV3PublicDocumentRevision(input, options) { return this.request("downloadV3PublicDocumentRevision", input, options); }
|
|
10
|
+
/** Download a public immutable document revision Returns the data together with response headers and request ID. */
|
|
11
|
+
downloadV3PublicDocumentRevisionWithResponse(input, options) { return this.requestDetailed("downloadV3PublicDocumentRevision", input, options); }
|
|
12
|
+
/**
|
|
13
|
+
* Generate variants from a saved brief; use Creative Sessions for voice/audio, radio spots, and voiceovers. Send kind, scope, and variantAction; reuse actionKey only on retries.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* await client.generateVariants(input, { idempotencyKey: 'stable-key' })
|
|
17
|
+
*/
|
|
18
|
+
generateVariants(input, options) { return this.request("generate_variants", input, options); }
|
|
19
|
+
/** Generate variants from a saved brief; use Creative Sessions for voice/audio, radio spots, and voiceovers. Send kind, scope, and variantAction; reuse actionKey only on retries. Returns the data together with response headers and request ID. */
|
|
20
|
+
generateVariantsWithResponse(input, options) { return this.requestDetailed("generate_variants", input, options); }
|
|
21
|
+
/**
|
|
22
|
+
* Read one object by kind and id, or an account singleton without id. Never guess ids. Campaign reads return targetingOverlay to verify before proposals. include adds detail only for kinds that serve it.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* await client.get(input)
|
|
26
|
+
*/
|
|
27
|
+
get(input, options) { return this.request("get", input, options); }
|
|
28
|
+
/** Read one object by kind and id, or an account singleton without id. Never guess ids. Campaign reads return targetingOverlay to verify before proposals. include adds detail only for kinds that serve it. Returns the data together with response headers and request ID. */
|
|
29
|
+
getWithResponse(input, options) { return this.requestDetailed("get", input, options); }
|
|
30
|
+
/**
|
|
31
|
+
* Read a bounded public immutable document revision
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* await client.getV3PublicDocumentRevisionSections(input)
|
|
35
|
+
*/
|
|
36
|
+
getV3PublicDocumentRevisionSections(input, options) { return this.request("getV3PublicDocumentRevisionSections", input, options); }
|
|
37
|
+
/** Read a bounded public immutable document revision Returns the data together with response headers and request ID. */
|
|
38
|
+
getV3PublicDocumentRevisionSectionsWithResponse(input, options) { return this.requestDetailed("getV3PublicDocumentRevisionSections", input, options); }
|
|
39
|
+
/**
|
|
40
|
+
* Read the state of a V3 HTTP write receipt
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* await client.getV3PublicMutationReceipt(input)
|
|
44
|
+
*/
|
|
45
|
+
getV3PublicMutationReceipt(input, options) { return this.request("getV3PublicMutationReceipt", input, options); }
|
|
46
|
+
/** Read the state of a V3 HTTP write receipt Returns the data together with response headers and request ID. */
|
|
47
|
+
getV3PublicMutationReceiptWithResponse(input, options) { return this.requestDetailed("getV3PublicMutationReceipt", input, options); }
|
|
48
|
+
/**
|
|
49
|
+
* 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.
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* await client.getDelivery(input)
|
|
53
|
+
*/
|
|
54
|
+
getDelivery(input, options) { return this.request("get_delivery", input, options); }
|
|
55
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
56
|
+
getDeliveryWithResponse(input, options) { return this.requestDetailed("get_delivery", input, options); }
|
|
57
|
+
/**
|
|
58
|
+
* 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.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* await client.getRfpPerformance(input)
|
|
62
|
+
*/
|
|
63
|
+
getRfpPerformance(input, options) { return this.request("get_rfp_performance", input, options); }
|
|
64
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
65
|
+
getRfpPerformanceWithResponse(input, options) { return this.requestDetailed("get_rfp_performance", input, options); }
|
|
66
|
+
/**
|
|
67
|
+
* 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.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* await client.getSellerReportingReceipts(input)
|
|
71
|
+
*/
|
|
72
|
+
getSellerReportingReceipts(input, options) { return this.request("get_seller_reporting_receipts", input, options); }
|
|
73
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
74
|
+
getSellerReportingReceiptsWithResponse(input, options) { return this.requestDetailed("get_seller_reporting_receipts", input, options); }
|
|
75
|
+
/**
|
|
76
|
+
* 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.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* await client.getStatus(input)
|
|
80
|
+
*/
|
|
81
|
+
getStatus(input = {}, options) { return this.request("get_status", input, options); }
|
|
82
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
83
|
+
getStatusWithResponse(input = {}, options) { return this.requestDetailed("get_status", input, options); }
|
|
84
|
+
/**
|
|
85
|
+
* 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").
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* await client.openAdvertisersPage(input)
|
|
89
|
+
*/
|
|
90
|
+
openAdvertisersPage(input, options) { return this.request("open_advertisers_page", input, options); }
|
|
91
|
+
/** 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"). Returns the data together with response headers and request ID. */
|
|
92
|
+
openAdvertisersPageWithResponse(input, options) { return this.requestDetailed("open_advertisers_page", input, options); }
|
|
93
|
+
/**
|
|
94
|
+
* Open one agent owned by this Developer account.
|
|
95
|
+
*
|
|
96
|
+
* @example
|
|
97
|
+
* await client.openAgentPage(input)
|
|
98
|
+
*/
|
|
99
|
+
openAgentPage(input, options) { return this.request("open_agent_page", input, options); }
|
|
100
|
+
/** Open one agent owned by this Developer account. Returns the data together with response headers and request ID. */
|
|
101
|
+
openAgentPageWithResponse(input, options) { return this.requestDetailed("open_agent_page", input, options); }
|
|
102
|
+
/**
|
|
103
|
+
* Open Build an agent for this Developer account.
|
|
104
|
+
*
|
|
105
|
+
* @example
|
|
106
|
+
* await client.openAgentsPage(input)
|
|
107
|
+
*/
|
|
108
|
+
openAgentsPage(input, options) { return this.request("open_agents_page", input, options); }
|
|
109
|
+
/** Open Build an agent for this Developer account. Returns the data together with response headers and request ID. */
|
|
110
|
+
openAgentsPageWithResponse(input, options) { return this.requestDetailed("open_agents_page", input, options); }
|
|
111
|
+
/**
|
|
112
|
+
* 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.
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* await client.openApprovals(input)
|
|
116
|
+
*/
|
|
117
|
+
openApprovals(input, options) { return this.request("open_approvals", input, options); }
|
|
118
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
119
|
+
openApprovalsWithResponse(input, options) { return this.requestDetailed("open_approvals", input, options); }
|
|
120
|
+
/**
|
|
121
|
+
* 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.
|
|
122
|
+
*
|
|
123
|
+
* @example
|
|
124
|
+
* await client.openCampaignReceipt(input)
|
|
125
|
+
*/
|
|
126
|
+
openCampaignReceipt(input, options) { return this.request("open_campaign_receipt", input, options); }
|
|
127
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
128
|
+
openCampaignReceiptWithResponse(input, options) { return this.requestDetailed("open_campaign_receipt", input, options); }
|
|
129
|
+
/**
|
|
130
|
+
* 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.
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* await client.openCampaignsPage(input)
|
|
134
|
+
*/
|
|
135
|
+
openCampaignsPage(input, options) { return this.request("open_campaigns_page", input, options); }
|
|
136
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
137
|
+
openCampaignsPageWithResponse(input, options) { return this.requestDetailed("open_campaigns_page", input, options); }
|
|
138
|
+
/**
|
|
139
|
+
* 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.
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* await client.openConnectionsPage(input)
|
|
143
|
+
*/
|
|
144
|
+
openConnectionsPage(input, options) { return this.request("open_connections_page", input, options); }
|
|
145
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
146
|
+
openConnectionsPageWithResponse(input, options) { return this.requestDetailed("open_connections_page", input, options); }
|
|
147
|
+
/**
|
|
148
|
+
* 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.
|
|
149
|
+
*
|
|
150
|
+
* @example
|
|
151
|
+
* await client.openCreativeEnginesPage(input)
|
|
152
|
+
*/
|
|
153
|
+
openCreativeEnginesPage(input, options) { return this.request("open_creative_engines_page", input, options); }
|
|
154
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
155
|
+
openCreativeEnginesPageWithResponse(input, options) { return this.requestDetailed("open_creative_engines_page", input, options); }
|
|
156
|
+
/**
|
|
157
|
+
* 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.
|
|
158
|
+
*
|
|
159
|
+
* @example
|
|
160
|
+
* await client.openCreativeLibrary(input, { idempotencyKey: 'stable-key' })
|
|
161
|
+
*/
|
|
162
|
+
openCreativeLibrary(input, options) { return this.request("open_creative_library", input, options); }
|
|
163
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
164
|
+
openCreativeLibraryWithResponse(input, options) { return this.requestDetailed("open_creative_library", input, options); }
|
|
165
|
+
/**
|
|
166
|
+
* Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches.
|
|
167
|
+
*
|
|
168
|
+
* @example
|
|
169
|
+
* await client.openMediaBuysPage(input)
|
|
170
|
+
*/
|
|
171
|
+
openMediaBuysPage(input, options) { return this.request("open_media_buys_page", input, options); }
|
|
172
|
+
/** Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches. Returns the data together with response headers and request ID. */
|
|
173
|
+
openMediaBuysPageWithResponse(input, options) { return this.requestDetailed("open_media_buys_page", input, options); }
|
|
174
|
+
/**
|
|
175
|
+
* Open a compatibility Page. source_diagnostics can create or attach the Agent. External hosts may return text. Credentials and authority changes remain human ceremonies.
|
|
176
|
+
*
|
|
177
|
+
* @example
|
|
178
|
+
* await client.openPage(input)
|
|
179
|
+
*/
|
|
180
|
+
openPage(input, options) { return this.request("open_page", input, options); }
|
|
181
|
+
/** Open a compatibility Page. source_diagnostics can create or attach the Agent. External hosts may return text. Credentials and authority changes remain human ceremonies. Returns the data together with response headers and request ID. */
|
|
182
|
+
openPageWithResponse(input, options) { return this.requestDetailed("open_page", input, options); }
|
|
183
|
+
/**
|
|
184
|
+
* 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.
|
|
185
|
+
*
|
|
186
|
+
* @example
|
|
187
|
+
* await client.openProposalPass(input)
|
|
188
|
+
*/
|
|
189
|
+
openProposalPass(input, options) { return this.request("open_proposal_pass", input, options); }
|
|
190
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
191
|
+
openProposalPassWithResponse(input, options) { return this.requestDetailed("open_proposal_pass", input, options); }
|
|
192
|
+
/**
|
|
193
|
+
* 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.
|
|
194
|
+
*
|
|
195
|
+
* @example
|
|
196
|
+
* await client.openSellerDashboard(input)
|
|
197
|
+
*/
|
|
198
|
+
openSellerDashboard(input, options) { return this.request("open_seller_dashboard", input, options); }
|
|
199
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
200
|
+
openSellerDashboardWithResponse(input, options) { return this.requestDetailed("open_seller_dashboard", input, options); }
|
|
201
|
+
/**
|
|
202
|
+
* Show a saved Creative Session’s variants (find via search/get kind creative_session). Not for generating new variants.
|
|
203
|
+
*
|
|
204
|
+
* @example
|
|
205
|
+
* await client.openVariantGallery(input)
|
|
206
|
+
*/
|
|
207
|
+
openVariantGallery(input, options) { return this.request("open_variant_gallery", input, options); }
|
|
208
|
+
/** Show a saved Creative Session’s variants (find via search/get kind creative_session). Not for generating new variants. Returns the data together with response headers and request ID. */
|
|
209
|
+
openVariantGalleryWithResponse(input, options) { return this.requestDetailed("open_variant_gallery", input, options); }
|
|
210
|
+
/**
|
|
211
|
+
* Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy.
|
|
212
|
+
*
|
|
213
|
+
* @example
|
|
214
|
+
* await client.refreshInventorySourceHealth(input, { idempotencyKey: 'stable-key' })
|
|
215
|
+
*/
|
|
216
|
+
refreshInventorySourceHealth(input, options) { return this.request("refresh_inventory_source_health", input, options); }
|
|
217
|
+
/** Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy. Returns the data together with response headers and request ID. */
|
|
218
|
+
refreshInventorySourceHealthWithResponse(input, options) { return this.requestDetailed("refresh_inventory_source_health", input, options); }
|
|
219
|
+
/**
|
|
220
|
+
* 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.
|
|
221
|
+
*
|
|
222
|
+
* @example
|
|
223
|
+
* await client.requestBuyerChildAccount(input, { idempotencyKey: 'stable-key' })
|
|
224
|
+
*/
|
|
225
|
+
requestBuyerChildAccount(input, options) { return this.request("request_buyer_child_account", input, options); }
|
|
226
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
227
|
+
requestBuyerChildAccountWithResponse(input, options) { return this.requestDetailed("request_buyer_child_account", input, options); }
|
|
228
|
+
/**
|
|
229
|
+
* 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.
|
|
230
|
+
*
|
|
231
|
+
* @example
|
|
232
|
+
* await client.requestProposals(input, { idempotencyKey: 'stable-key' })
|
|
233
|
+
*/
|
|
234
|
+
requestProposals(input, options) { return this.request("request_proposals", input, options); }
|
|
235
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
236
|
+
requestProposalsWithResponse(input, options) { return this.requestDetailed("request_proposals", input, options); }
|
|
237
|
+
/**
|
|
238
|
+
* Requests a scheduler-run reporting refresh or a bounded replay for one seller media buy. It never polls a provider directly.
|
|
239
|
+
*
|
|
240
|
+
* @example
|
|
241
|
+
* await client.requestSellerReportingUpdate(input, { idempotencyKey: 'stable-key' })
|
|
242
|
+
*/
|
|
243
|
+
requestSellerReportingUpdate(input, options) { return this.request("request_seller_reporting_update", input, options); }
|
|
244
|
+
/** Requests a scheduler-run reporting refresh or a bounded replay for one seller media buy. It never polls a provider directly. Returns the data together with response headers and request ID. */
|
|
245
|
+
requestSellerReportingUpdateWithResponse(input, options) { return this.requestDetailed("request_seller_reporting_update", input, options); }
|
|
246
|
+
/**
|
|
247
|
+
* 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.
|
|
248
|
+
*
|
|
249
|
+
* @example
|
|
250
|
+
* await client.reviewBuyerChildAccount(input)
|
|
251
|
+
*/
|
|
252
|
+
reviewBuyerChildAccount(input, options) { return this.request("review_buyer_child_account", input, options); }
|
|
253
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
254
|
+
reviewBuyerChildAccountWithResponse(input, options) { return this.requestDetailed("review_buyer_child_account", input, options); }
|
|
255
|
+
/**
|
|
256
|
+
* Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes.
|
|
257
|
+
*
|
|
258
|
+
* @example
|
|
259
|
+
* await client.saveAccount(input, { idempotencyKey: 'stable-key' })
|
|
260
|
+
*/
|
|
261
|
+
saveAccount(input, options) { return this.request("save_account", input, options); }
|
|
262
|
+
/** Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes. Returns the data together with response headers and request ID. */
|
|
263
|
+
saveAccountWithResponse(input, options) { return this.requestDetailed("save_account", input, options); }
|
|
264
|
+
/**
|
|
265
|
+
* Save an advertiser or mappings. Buyer privateNotes: owning Buyer Account only; /v3/manage-ads#private-advertiser-notes. Confirm markets/channels (footprintProposal); needs_input=ask; never recreate for currency. Brand: identityContract:confirmed-v1; preview: resolveBrand; read advertiser.brandRef.
|
|
266
|
+
*
|
|
267
|
+
* @example
|
|
268
|
+
* await client.saveAdvertiser(input, { idempotencyKey: 'stable-key' })
|
|
269
|
+
*/
|
|
270
|
+
saveAdvertiser(input, options) { return this.request("save_advertiser", input, options); }
|
|
271
|
+
/** Save an advertiser or mappings. Buyer privateNotes: owning Buyer Account only; /v3/manage-ads#private-advertiser-notes. Confirm markets/channels (footprintProposal); needs_input=ask; never recreate for currency. Brand: identityContract:confirmed-v1; preview: resolveBrand; read advertiser.brandRef. Returns the data together with response headers and request ID. */
|
|
272
|
+
saveAdvertiserWithResponse(input, options) { return this.requestDetailed("save_advertiser", input, options); }
|
|
273
|
+
/**
|
|
274
|
+
* Invite a client to one of your advertisers, approve, suspend, reactivate, or revoke a client, or change a client's role. Read get kind advertiser_access first and use only what it offers. Needs an organization administrator signed in directly.
|
|
275
|
+
*
|
|
276
|
+
* @example
|
|
277
|
+
* await client.saveAdvertiserAccess(input, { idempotencyKey: 'stable-key' })
|
|
278
|
+
*/
|
|
279
|
+
saveAdvertiserAccess(input, options) { return this.request("save_advertiser_access", input, options); }
|
|
280
|
+
/** Invite a client to one of your advertisers, approve, suspend, reactivate, or revoke a client, or change a client's role. Read get kind advertiser_access first and use only what it offers. Needs an organization administrator signed in directly. Returns the data together with response headers and request ID. */
|
|
281
|
+
saveAdvertiserAccessWithResponse(input, options) { return this.requestDetailed("save_advertiser_access", input, options); }
|
|
282
|
+
/**
|
|
283
|
+
* 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.
|
|
284
|
+
*
|
|
285
|
+
* @example
|
|
286
|
+
* await client.saveAdvertiserGrant(input, { idempotencyKey: 'stable-key' })
|
|
287
|
+
*/
|
|
288
|
+
saveAdvertiserGrant(input, options) { return this.request("save_advertiser_grant", input, options); }
|
|
289
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
290
|
+
saveAdvertiserGrantWithResponse(input, options) { return this.requestDetailed("save_advertiser_grant", input, options); }
|
|
291
|
+
/**
|
|
292
|
+
* Seller-only CRM notes for an exact brand × operator pair. Buyers use save_advertiser.privateNotes; see /v3/manage-ads#private-advertiser-notes. Effective discounts, routing, access and trust are read-only.
|
|
293
|
+
*
|
|
294
|
+
* @example
|
|
295
|
+
* await client.saveAdvertiserInstructions(input, { idempotencyKey: 'stable-key' })
|
|
296
|
+
*/
|
|
297
|
+
saveAdvertiserInstructions(input, options) { return this.request("save_advertiser_instructions", input, options); }
|
|
298
|
+
/** Seller-only CRM notes for an exact brand × operator pair. Buyers use save_advertiser.privateNotes; see /v3/manage-ads#private-advertiser-notes. Effective discounts, routing, access and trust are read-only. Returns the data together with response headers and request ID. */
|
|
299
|
+
saveAdvertiserInstructionsWithResponse(input, options) { return this.requestDetailed("save_advertiser_instructions", input, options); }
|
|
300
|
+
/**
|
|
301
|
+
* Save a Sales Agent mode, register an Agent, or update an owned Agent: rename it or say it is ready for certification. Select seller_save, developer_create, or developer_update.
|
|
302
|
+
*
|
|
303
|
+
* @example
|
|
304
|
+
* await client.saveAgent(input, { idempotencyKey: 'stable-key' })
|
|
305
|
+
*/
|
|
306
|
+
saveAgent(input, options) { return this.request("save_agent", input, options); }
|
|
307
|
+
/** Save a Sales Agent mode, register an Agent, or update an owned Agent: rename it or say it is ready for certification. Select seller_save, developer_create, or developer_update. Returns the data together with response headers and request ID. */
|
|
308
|
+
saveAgentWithResponse(input, options) { return this.requestDetailed("save_agent", input, options); }
|
|
309
|
+
/**
|
|
310
|
+
* 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.
|
|
311
|
+
*
|
|
312
|
+
* @example
|
|
313
|
+
* await client.saveAsk(input, { idempotencyKey: 'stable-key' })
|
|
314
|
+
*/
|
|
315
|
+
saveAsk(input, options) { return this.request("save_ask", input, options); }
|
|
316
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
317
|
+
saveAskWithResponse(input, options) { return this.requestDetailed("save_ask", input, options); }
|
|
318
|
+
/**
|
|
319
|
+
* 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.
|
|
320
|
+
*
|
|
321
|
+
* @example
|
|
322
|
+
* await client.saveAudience(input, { idempotencyKey: 'stable-key' })
|
|
323
|
+
*/
|
|
324
|
+
saveAudience(input, options) { return this.request("save_audience", input, options); }
|
|
325
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
326
|
+
saveAudienceWithResponse(input, options) { return this.requestDetailed("save_audience", input, options); }
|
|
327
|
+
/**
|
|
328
|
+
* Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP.
|
|
329
|
+
*
|
|
330
|
+
* @example
|
|
331
|
+
* await client.saveBilling(input, { idempotencyKey: 'stable-key' })
|
|
332
|
+
*/
|
|
333
|
+
saveBilling(input, options) { return this.request("save_billing", input, options); }
|
|
334
|
+
/** Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP. Returns the data together with response headers and request ID. */
|
|
335
|
+
saveBillingWithResponse(input, options) { return this.requestDetailed("save_billing", input, options); }
|
|
336
|
+
/**
|
|
337
|
+
* Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview.
|
|
338
|
+
*
|
|
339
|
+
* @example
|
|
340
|
+
* await client.saveBusinessRules(input, { idempotencyKey: 'stable-key' })
|
|
341
|
+
*/
|
|
342
|
+
saveBusinessRules(input, options) { return this.request("save_business_rules", input, options); }
|
|
343
|
+
/** Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview. Returns the data together with response headers and request ID. */
|
|
344
|
+
saveBusinessRulesWithResponse(input, options) { return this.requestDetailed("save_business_rules", input, options); }
|
|
345
|
+
/**
|
|
346
|
+
* Create or manage one buyer agent.
|
|
347
|
+
*
|
|
348
|
+
* @example
|
|
349
|
+
* await client.saveBuyerAgent(input, { idempotencyKey: 'stable-key' })
|
|
350
|
+
*/
|
|
351
|
+
saveBuyerAgent(input, options) { return this.request("save_buyer_agent", input, options); }
|
|
352
|
+
/** Create or manage one buyer agent. Returns the data together with response headers and request ID. */
|
|
353
|
+
saveBuyerAgentWithResponse(input, options) { return this.requestDetailed("save_buyer_agent", input, options); }
|
|
354
|
+
/**
|
|
355
|
+
* Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup.
|
|
356
|
+
*
|
|
357
|
+
* @example
|
|
358
|
+
* await client.saveBuyerOperator(input, { idempotencyKey: 'stable-key' })
|
|
359
|
+
*/
|
|
360
|
+
saveBuyerOperator(input, options) { return this.request("save_buyer_operator", input, options); }
|
|
361
|
+
/** Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup. Returns the data together with response headers and request ID. */
|
|
362
|
+
saveBuyerOperatorWithResponse(input, options) { return this.requestDetailed("save_buyer_operator", input, options); }
|
|
363
|
+
/**
|
|
364
|
+
* Save a campaign. To create, send advertiserId and name; flight and budget are optional. Split inventory into media buys. Set desiredPhase: active to launch; omit confirmLaunch to preview. Cancellation is irreversible: desiredPhase: canceled cancels the campaign and every live media buy.
|
|
365
|
+
*
|
|
366
|
+
* @example
|
|
367
|
+
* await client.saveCampaign(input, { idempotencyKey: 'stable-key' })
|
|
368
|
+
*/
|
|
369
|
+
saveCampaign(input, options) { return this.request("save_campaign", input, options); }
|
|
370
|
+
/** Save a campaign. To create, send advertiserId and name; flight and budget are optional. Split inventory into media buys. Set desiredPhase: active to launch; omit confirmLaunch to preview. Cancellation is irreversible: desiredPhase: canceled cancels the campaign and every live media buy. Returns the data together with response headers and request ID. */
|
|
371
|
+
saveCampaignWithResponse(input, options) { return this.requestDetailed("save_campaign", input, options); }
|
|
372
|
+
/**
|
|
373
|
+
* Create or replace a catalog: type and exactly one of url (feed URL) or non-empty items are required. If missing, ask the buyer for the feed URL or items before calling. URL saves refetch the feed. To archive, set isArchived: true with identity only; type, url and items are not needed.
|
|
374
|
+
*
|
|
375
|
+
* @example
|
|
376
|
+
* await client.saveCatalog(input, { idempotencyKey: 'stable-key' })
|
|
377
|
+
*/
|
|
378
|
+
saveCatalog(input, options) { return this.request("save_catalog", input, options); }
|
|
379
|
+
/** Create or replace a catalog: type and exactly one of url (feed URL) or non-empty items are required. If missing, ask the buyer for the feed URL or items before calling. URL saves refetch the feed. To archive, set isArchived: true with identity only; type, url and items are not needed. Returns the data together with response headers and request ID. */
|
|
380
|
+
saveCatalogWithResponse(input, options) { return this.requestDetailed("save_catalog", input, options); }
|
|
381
|
+
/**
|
|
382
|
+
* Manage seller or creative-engine authorization, accounts and advertiser mappings. Seller-only: reporting, selection, billing, policy, activation.
|
|
383
|
+
*
|
|
384
|
+
* @example
|
|
385
|
+
* await client.saveConnection(input, { idempotencyKey: 'stable-key' })
|
|
386
|
+
*/
|
|
387
|
+
saveConnection(input, options) { return this.request("save_connection", input, options); }
|
|
388
|
+
/** Manage seller or creative-engine authorization, accounts and advertiser mappings. Seller-only: reporting, selection, billing, policy, activation. Returns the data together with response headers and request ID. */
|
|
389
|
+
saveConnectionWithResponse(input, options) { return this.requestDetailed("save_connection", input, options); }
|
|
390
|
+
/**
|
|
391
|
+
* 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.
|
|
392
|
+
*
|
|
393
|
+
* @example
|
|
394
|
+
* await client.saveCoverage(input, { idempotencyKey: 'stable-key' })
|
|
395
|
+
*/
|
|
396
|
+
saveCoverage(input, options) { return this.request("save_coverage", input, options); }
|
|
397
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
398
|
+
saveCoverageWithResponse(input, options) { return this.requestDetailed("save_coverage", input, options); }
|
|
399
|
+
/**
|
|
400
|
+
* 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.
|
|
401
|
+
*
|
|
402
|
+
* @example
|
|
403
|
+
* await client.saveCreative(input, { idempotencyKey: 'stable-key' })
|
|
404
|
+
*/
|
|
405
|
+
saveCreative(input, options) { return this.request("save_creative", input, options); }
|
|
406
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
407
|
+
saveCreativeWithResponse(input, options) { return this.requestDetailed("save_creative", input, options); }
|
|
408
|
+
/**
|
|
409
|
+
* 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.
|
|
410
|
+
*
|
|
411
|
+
* @example
|
|
412
|
+
* await client.saveCreativeCollection(input, { idempotencyKey: 'stable-key' })
|
|
413
|
+
*/
|
|
414
|
+
saveCreativeCollection(input, options) { return this.request("save_creative_collection", input, options); }
|
|
415
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
416
|
+
saveCreativeCollectionWithResponse(input, options) { return this.requestDetailed("save_creative_collection", input, options); }
|
|
417
|
+
/**
|
|
418
|
+
* Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId.
|
|
419
|
+
*
|
|
420
|
+
* @example
|
|
421
|
+
* await client.saveCreativeSession(input, { idempotencyKey: 'stable-key' })
|
|
422
|
+
*/
|
|
423
|
+
saveCreativeSession(input, options) { return this.request("save_creative_session", input, options); }
|
|
424
|
+
/** Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId. Returns the data together with response headers and request ID. */
|
|
425
|
+
saveCreativeSessionWithResponse(input, options) { return this.requestDetailed("save_creative_session", input, options); }
|
|
426
|
+
/**
|
|
427
|
+
* Create a dimension, or update an existing dimension by its id. Tags is built in and open. Labels belong only to objects in appliesTo.
|
|
428
|
+
*
|
|
429
|
+
* @example
|
|
430
|
+
* await client.saveDimension(input, { idempotencyKey: 'stable-key' })
|
|
431
|
+
*/
|
|
432
|
+
saveDimension(input, options) { return this.request("save_dimension", input, options); }
|
|
433
|
+
/** Create a dimension, or update an existing dimension by its id. Tags is built in and open. Labels belong only to objects in appliesTo. Returns the data together with response headers and request ID. */
|
|
434
|
+
saveDimensionWithResponse(input, options) { return this.requestDetailed("save_dimension", input, options); }
|
|
435
|
+
/**
|
|
436
|
+
* Import native campaigns from Spotify Ads Manager or other platforms, including future-start campaigns, as read-only mirrors. Confirm ongoing sync first. No provider changes. /v3/import-existing-campaigns.
|
|
437
|
+
*
|
|
438
|
+
* @example
|
|
439
|
+
* await client.saveDirectedCampaignSubscription(input, { idempotencyKey: 'stable-key' })
|
|
440
|
+
*/
|
|
441
|
+
saveDirectedCampaignSubscription(input, options) { return this.request("save_directed_campaign_subscription", input, options); }
|
|
442
|
+
/** Import native campaigns from Spotify Ads Manager or other platforms, including future-start campaigns, as read-only mirrors. Confirm ongoing sync first. No provider changes. /v3/import-existing-campaigns. Returns the data together with response headers and request ID. */
|
|
443
|
+
saveDirectedCampaignSubscriptionWithResponse(input, options) { return this.requestDetailed("save_directed_campaign_subscription", input, options); }
|
|
444
|
+
/**
|
|
445
|
+
* 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.
|
|
446
|
+
*
|
|
447
|
+
* @example
|
|
448
|
+
* await client.saveEventSource(input, { idempotencyKey: 'stable-key' })
|
|
449
|
+
*/
|
|
450
|
+
saveEventSource(input, options) { return this.request("save_event_source", input, options); }
|
|
451
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
452
|
+
saveEventSourceWithResponse(input, options) { return this.requestDetailed("save_event_source", input, options); }
|
|
453
|
+
/**
|
|
454
|
+
* 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.
|
|
455
|
+
*
|
|
456
|
+
* @example
|
|
457
|
+
* await client.saveInventorySource(input, { idempotencyKey: 'stable-key' })
|
|
458
|
+
*/
|
|
459
|
+
saveInventorySource(input, options) { return this.request("save_inventory_source", input, options); }
|
|
460
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
461
|
+
saveInventorySourceWithResponse(input, options) { return this.requestDetailed("save_inventory_source", input, options); }
|
|
462
|
+
/**
|
|
463
|
+
* Manage seller lessons. propose requires lesson; approve and retire require lessonId; preview requires lessonId and brief. Preserve seller words from a private Session note and ask if kind or scope is unclear.
|
|
464
|
+
*
|
|
465
|
+
* @example
|
|
466
|
+
* await client.saveLesson(input, { idempotencyKey: 'stable-key' })
|
|
467
|
+
*/
|
|
468
|
+
saveLesson(input, options) { return this.request("save_lesson", input, options); }
|
|
469
|
+
/** Manage seller lessons. propose requires lesson; approve and retire require lessonId; preview requires lessonId and brief. Preserve seller words from a private Session note and ask if kind or scope is unclear. Returns the data together with response headers and request ID. */
|
|
470
|
+
saveLessonWithResponse(input, options) { return this.requestDetailed("save_lesson", input, options); }
|
|
471
|
+
/**
|
|
472
|
+
* Open a seller library request or close it with seller Material.
|
|
473
|
+
*
|
|
474
|
+
* @example
|
|
475
|
+
* await client.saveLibraryRequest(input, { idempotencyKey: 'stable-key' })
|
|
476
|
+
*/
|
|
477
|
+
saveLibraryRequest(input, options) { return this.request("save_library_request", input, options); }
|
|
478
|
+
/** Open a seller library request or close it with seller Material. Returns the data together with response headers and request ID. */
|
|
479
|
+
saveLibraryRequestWithResponse(input, options) { return this.requestDetailed("save_library_request", input, options); }
|
|
480
|
+
/**
|
|
481
|
+
* 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).
|
|
482
|
+
*
|
|
483
|
+
* @example
|
|
484
|
+
* await client.saveMaterial(input, { idempotencyKey: 'stable-key' })
|
|
485
|
+
*/
|
|
486
|
+
saveMaterial(input, options) { return this.request("save_material", input, options); }
|
|
487
|
+
/** 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). Returns the data together with response headers and request ID. */
|
|
488
|
+
saveMaterialWithResponse(input, options) { return this.requestDetailed("save_material", input, options); }
|
|
489
|
+
/**
|
|
490
|
+
* 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.
|
|
491
|
+
*
|
|
492
|
+
* @example
|
|
493
|
+
* await client.saveMediaBuy(input, { idempotencyKey: 'stable-key' })
|
|
494
|
+
*/
|
|
495
|
+
saveMediaBuy(input, options) { return this.request("save_media_buy", input, options); }
|
|
496
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
497
|
+
saveMediaBuyWithResponse(input, options) { return this.requestDetailed("save_media_buy", input, options); }
|
|
498
|
+
/**
|
|
499
|
+
* 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`.
|
|
500
|
+
*
|
|
501
|
+
* @example
|
|
502
|
+
* await client.saveMediaKit(input, { idempotencyKey: 'stable-key' })
|
|
503
|
+
*/
|
|
504
|
+
saveMediaKit(input, options) { return this.request("save_media_kit", input, options); }
|
|
505
|
+
/** 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`. Returns the data together with response headers and request ID. */
|
|
506
|
+
saveMediaKitWithResponse(input, options) { return this.requestDetailed("save_media_kit", input, options); }
|
|
507
|
+
/**
|
|
508
|
+
* Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed.
|
|
509
|
+
*
|
|
510
|
+
* @example
|
|
511
|
+
* await client.saveNotificationConfig(input, { idempotencyKey: 'stable-key' })
|
|
512
|
+
*/
|
|
513
|
+
saveNotificationConfig(input, options) { return this.request("save_notification_config", input, options); }
|
|
514
|
+
/** Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed. Returns the data together with response headers and request ID. */
|
|
515
|
+
saveNotificationConfigWithResponse(input, options) { return this.requestDetailed("save_notification_config", input, options); }
|
|
516
|
+
/**
|
|
517
|
+
* 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.
|
|
518
|
+
*
|
|
519
|
+
* @example
|
|
520
|
+
* await client.savePlaybook(input, { idempotencyKey: 'stable-key' })
|
|
521
|
+
*/
|
|
522
|
+
savePlaybook(input, options) { return this.request("save_playbook", input, options); }
|
|
523
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
524
|
+
savePlaybookWithResponse(input, options) { return this.requestDetailed("save_playbook", input, options); }
|
|
525
|
+
/**
|
|
526
|
+
* Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
|
|
527
|
+
*
|
|
528
|
+
* @example
|
|
529
|
+
* await client.savePropertyList(input, { idempotencyKey: 'stable-key' })
|
|
530
|
+
*/
|
|
531
|
+
savePropertyList(input, options) { return this.request("save_property_list", input, options); }
|
|
532
|
+
/** Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists. Returns the data together with response headers and request ID. */
|
|
533
|
+
savePropertyListWithResponse(input, options) { return this.requestDetailed("save_property_list", input, options); }
|
|
534
|
+
/**
|
|
535
|
+
* Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests.
|
|
536
|
+
*
|
|
537
|
+
* @example
|
|
538
|
+
* await client.saveRfp(input, { idempotencyKey: 'stable-key' })
|
|
539
|
+
*/
|
|
540
|
+
saveRfp(input, options) { return this.request("save_rfp", input, options); }
|
|
541
|
+
/** Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests. Returns the data together with response headers and request ID. */
|
|
542
|
+
saveRfpWithResponse(input, options) { return this.requestDetailed("save_rfp", input, options); }
|
|
543
|
+
/**
|
|
544
|
+
* 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").
|
|
545
|
+
*
|
|
546
|
+
* @example
|
|
547
|
+
* await client.saveSeller(input, { idempotencyKey: 'stable-key' })
|
|
548
|
+
*/
|
|
549
|
+
saveSeller(input, options) { return this.request("save_seller", input, options); }
|
|
550
|
+
/** 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"). Returns the data together with response headers and request ID. */
|
|
551
|
+
saveSellerWithResponse(input, options) { return this.requestDetailed("save_seller", input, options); }
|
|
552
|
+
/**
|
|
553
|
+
* Create, replace, or archive a signal. Managed writes need a complete draft; read before updates. Without sourceId, writes the seller catalog.
|
|
554
|
+
*
|
|
555
|
+
* @example
|
|
556
|
+
* await client.saveSignal(input, { idempotencyKey: 'stable-key' })
|
|
557
|
+
*/
|
|
558
|
+
saveSignal(input, options) { return this.request("save_signal", input, options); }
|
|
559
|
+
/** Create, replace, or archive a signal. Managed writes need a complete draft; read before updates. Without sourceId, writes the seller catalog. Returns the data together with response headers and request ID. */
|
|
560
|
+
saveSignalWithResponse(input, options) { return this.requestDetailed("save_signal", input, options); }
|
|
561
|
+
/**
|
|
562
|
+
* 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.
|
|
563
|
+
*
|
|
564
|
+
* @example
|
|
565
|
+
* await client.saveWholesaleProduct(input, { idempotencyKey: 'stable-key' })
|
|
566
|
+
*/
|
|
567
|
+
saveWholesaleProduct(input, options) { return this.request("save_wholesale_product", input, options); }
|
|
568
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
569
|
+
saveWholesaleProductWithResponse(input, options) { return this.requestDetailed("save_wholesale_product", input, options); }
|
|
570
|
+
/**
|
|
571
|
+
* 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.
|
|
572
|
+
*
|
|
573
|
+
* @example
|
|
574
|
+
* await client.saveWorkItem(input, { idempotencyKey: 'stable-key' })
|
|
575
|
+
*/
|
|
576
|
+
saveWorkItem(input, options) { return this.request("save_work_item", input, options); }
|
|
577
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
578
|
+
saveWorkItemWithResponse(input, options) { return this.requestDetailed("save_work_item", input, options); }
|
|
579
|
+
/**
|
|
580
|
+
* 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.
|
|
581
|
+
*
|
|
582
|
+
* @example
|
|
583
|
+
* await client.search(input)
|
|
584
|
+
*/
|
|
585
|
+
search(input, options) { return this.request("search", input, options); }
|
|
586
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
587
|
+
searchWithResponse(input, options) { return this.requestDetailed("search", input, options); }
|
|
588
|
+
/**
|
|
589
|
+
* 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.
|
|
590
|
+
*
|
|
591
|
+
* @example
|
|
592
|
+
* await client.testCreativeMacros(input)
|
|
593
|
+
*/
|
|
594
|
+
testCreativeMacros(input, options) { return this.request("test_creative_macros", input, options); }
|
|
595
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
596
|
+
testCreativeMacrosWithResponse(input, options) { return this.requestDetailed("test_creative_macros", input, options); }
|
|
597
|
+
/**
|
|
598
|
+
* 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.
|
|
599
|
+
*
|
|
600
|
+
* @example
|
|
601
|
+
* await client.uploadCreativeAsset(input, { idempotencyKey: 'stable-key' })
|
|
602
|
+
*/
|
|
603
|
+
uploadCreativeAsset(input, options) { return this.request("upload_creative_asset", input, options); }
|
|
604
|
+
/** 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. Returns the data together with response headers and request ID. */
|
|
605
|
+
uploadCreativeAssetWithResponse(input, options) { return this.requestDetailed("upload_creative_asset", input, options); }
|
|
606
|
+
}
|