@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,1092 @@
|
|
|
1
|
+
import type * as Wire from './types.gen.js';
|
|
2
|
+
import { Transport, type RequestOptions, type ResponseDetails, type WriteRequestOptions } from '../transport.js';
|
|
3
|
+
type OptionalWireField<T, K extends PropertyKey> = T extends unknown ? Omit<T, K> & Partial<Pick<T, Extract<K, keyof T>>> : never;
|
|
4
|
+
export type DownloadV3PublicDocumentRevisionInput = {
|
|
5
|
+
"documentId": NonNullable<Wire.DownloadV3PublicDocumentRevisionData['path']>["documentId"];
|
|
6
|
+
"revisionId": NonNullable<Wire.DownloadV3PublicDocumentRevisionData['path']>["revisionId"];
|
|
7
|
+
};
|
|
8
|
+
export type DownloadV3PublicDocumentRevisionResult = Uint8Array;
|
|
9
|
+
export type DownloadV3PublicDocumentRevisionError = Wire.DownloadV3PublicDocumentRevisionErrors[keyof Wire.DownloadV3PublicDocumentRevisionErrors];
|
|
10
|
+
export type GenerateVariantsInput = Wire.GenerateVariantsData['body'];
|
|
11
|
+
export type GenerateVariantsResult = Wire.GenerateVariantsResponses[200]['data'];
|
|
12
|
+
export type GenerateVariantsError = Wire.GenerateVariantsErrors[keyof Wire.GenerateVariantsErrors];
|
|
13
|
+
export type GetInput = Wire.GetData['body'];
|
|
14
|
+
export type GetResult = Wire.GetResponses[200]['data'];
|
|
15
|
+
export type GetError = Wire.GetErrors[keyof Wire.GetErrors];
|
|
16
|
+
export type GetV3PublicDocumentRevisionSectionsInput = {
|
|
17
|
+
"documentId": NonNullable<Wire.GetV3PublicDocumentRevisionSectionsData['path']>["documentId"];
|
|
18
|
+
"revisionId": NonNullable<Wire.GetV3PublicDocumentRevisionSectionsData['path']>["revisionId"];
|
|
19
|
+
"section"?: NonNullable<Wire.GetV3PublicDocumentRevisionSectionsData['query']>["section"];
|
|
20
|
+
"query"?: NonNullable<Wire.GetV3PublicDocumentRevisionSectionsData['query']>["query"];
|
|
21
|
+
"cursor"?: NonNullable<Wire.GetV3PublicDocumentRevisionSectionsData['query']>["cursor"];
|
|
22
|
+
"asOf"?: NonNullable<Wire.GetV3PublicDocumentRevisionSectionsData['query']>["asOf"];
|
|
23
|
+
};
|
|
24
|
+
export type GetV3PublicDocumentRevisionSectionsResult = Wire.GetV3PublicDocumentRevisionSectionsResponses[200]['data'];
|
|
25
|
+
export type GetV3PublicDocumentRevisionSectionsError = Wire.GetV3PublicDocumentRevisionSectionsErrors[keyof Wire.GetV3PublicDocumentRevisionSectionsErrors];
|
|
26
|
+
export type GetV3PublicMutationReceiptInput = {
|
|
27
|
+
"receiptId": NonNullable<Wire.GetV3PublicMutationReceiptData['path']>["receiptId"];
|
|
28
|
+
};
|
|
29
|
+
export type GetV3PublicMutationReceiptResult = Wire.GetV3PublicMutationReceiptResponses[200]['data'];
|
|
30
|
+
export type GetV3PublicMutationReceiptError = Wire.GetV3PublicMutationReceiptErrors[keyof Wire.GetV3PublicMutationReceiptErrors];
|
|
31
|
+
export type GetDeliveryInput = Wire.GetDeliveryData['body'];
|
|
32
|
+
export type GetDeliveryResult = Wire.GetDeliveryResponses[200]['data'];
|
|
33
|
+
export type GetDeliveryError = Wire.GetDeliveryErrors[keyof Wire.GetDeliveryErrors];
|
|
34
|
+
export type GetRfpPerformanceInput = Wire.GetRfpPerformanceData['body'];
|
|
35
|
+
export type GetRfpPerformanceResult = Wire.GetRfpPerformanceResponses[200]['data'];
|
|
36
|
+
export type GetRfpPerformanceError = Wire.GetRfpPerformanceErrors[keyof Wire.GetRfpPerformanceErrors];
|
|
37
|
+
export type GetSellerReportingReceiptsInput = Wire.GetSellerReportingReceiptsData['body'];
|
|
38
|
+
export type GetSellerReportingReceiptsResult = Wire.GetSellerReportingReceiptsResponses[200]['data'];
|
|
39
|
+
export type GetSellerReportingReceiptsError = Wire.GetSellerReportingReceiptsErrors[keyof Wire.GetSellerReportingReceiptsErrors];
|
|
40
|
+
export type GetStatusInput = Wire.GetStatusData['body'];
|
|
41
|
+
export type GetStatusResult = Wire.GetStatusResponses[200]['data'];
|
|
42
|
+
export type GetStatusError = Wire.GetStatusErrors[keyof Wire.GetStatusErrors];
|
|
43
|
+
export type OpenAdvertisersPageInput = Wire.OpenAdvertisersPageData['body'];
|
|
44
|
+
export type OpenAdvertisersPageResult = Wire.OpenAdvertisersPageResponses[200]['data'];
|
|
45
|
+
export type OpenAdvertisersPageError = Wire.OpenAdvertisersPageErrors[keyof Wire.OpenAdvertisersPageErrors];
|
|
46
|
+
export type OpenAgentPageInput = Wire.OpenAgentPageData['body'];
|
|
47
|
+
export type OpenAgentPageResult = Wire.OpenAgentPageResponses[200]['data'];
|
|
48
|
+
export type OpenAgentPageError = Wire.OpenAgentPageErrors[keyof Wire.OpenAgentPageErrors];
|
|
49
|
+
export type OpenAgentsPageInput = Wire.OpenAgentsPageData['body'];
|
|
50
|
+
export type OpenAgentsPageResult = Wire.OpenAgentsPageResponses[200]['data'];
|
|
51
|
+
export type OpenAgentsPageError = Wire.OpenAgentsPageErrors[keyof Wire.OpenAgentsPageErrors];
|
|
52
|
+
export type OpenApprovalsInput = Wire.OpenApprovalsData['body'];
|
|
53
|
+
export type OpenApprovalsResult = Wire.OpenApprovalsResponses[200]['data'];
|
|
54
|
+
export type OpenApprovalsError = Wire.OpenApprovalsErrors[keyof Wire.OpenApprovalsErrors];
|
|
55
|
+
export type OpenCampaignReceiptInput = Wire.OpenCampaignReceiptData['body'];
|
|
56
|
+
export type OpenCampaignReceiptResult = Wire.OpenCampaignReceiptResponses[200]['data'];
|
|
57
|
+
export type OpenCampaignReceiptError = Wire.OpenCampaignReceiptErrors[keyof Wire.OpenCampaignReceiptErrors];
|
|
58
|
+
export type OpenCampaignsPageInput = Wire.OpenCampaignsPageData['body'];
|
|
59
|
+
export type OpenCampaignsPageResult = Wire.OpenCampaignsPageResponses[200]['data'];
|
|
60
|
+
export type OpenCampaignsPageError = Wire.OpenCampaignsPageErrors[keyof Wire.OpenCampaignsPageErrors];
|
|
61
|
+
export type OpenConnectionsPageInput = Wire.OpenConnectionsPageData['body'];
|
|
62
|
+
export type OpenConnectionsPageResult = Wire.OpenConnectionsPageResponses[200]['data'];
|
|
63
|
+
export type OpenConnectionsPageError = Wire.OpenConnectionsPageErrors[keyof Wire.OpenConnectionsPageErrors];
|
|
64
|
+
export type OpenCreativeEnginesPageInput = Wire.OpenCreativeEnginesPageData['body'];
|
|
65
|
+
export type OpenCreativeEnginesPageResult = Wire.OpenCreativeEnginesPageResponses[200]['data'];
|
|
66
|
+
export type OpenCreativeEnginesPageError = Wire.OpenCreativeEnginesPageErrors[keyof Wire.OpenCreativeEnginesPageErrors];
|
|
67
|
+
export type OpenCreativeLibraryInput = Wire.OpenCreativeLibraryData['body'];
|
|
68
|
+
export type OpenCreativeLibraryResult = Wire.OpenCreativeLibraryResponses[200]['data'];
|
|
69
|
+
export type OpenCreativeLibraryError = Wire.OpenCreativeLibraryErrors[keyof Wire.OpenCreativeLibraryErrors];
|
|
70
|
+
export type OpenMediaBuysPageInput = Wire.OpenMediaBuysPageData['body'];
|
|
71
|
+
export type OpenMediaBuysPageResult = Wire.OpenMediaBuysPageResponses[200]['data'];
|
|
72
|
+
export type OpenMediaBuysPageError = Wire.OpenMediaBuysPageErrors[keyof Wire.OpenMediaBuysPageErrors];
|
|
73
|
+
export type OpenPageInput = Wire.OpenPageData['body'];
|
|
74
|
+
export type OpenPageResult = Wire.OpenPageResponses[200]['data'];
|
|
75
|
+
export type OpenPageError = Wire.OpenPageErrors[keyof Wire.OpenPageErrors];
|
|
76
|
+
export type OpenProposalPassInput = Wire.OpenProposalPassData['body'];
|
|
77
|
+
export type OpenProposalPassResult = Wire.OpenProposalPassResponses[200]['data'];
|
|
78
|
+
export type OpenProposalPassError = Wire.OpenProposalPassErrors[keyof Wire.OpenProposalPassErrors];
|
|
79
|
+
export type OpenSellerDashboardInput = Wire.OpenSellerDashboardData['body'];
|
|
80
|
+
export type OpenSellerDashboardResult = Wire.OpenSellerDashboardResponses[200]['data'];
|
|
81
|
+
export type OpenSellerDashboardError = Wire.OpenSellerDashboardErrors[keyof Wire.OpenSellerDashboardErrors];
|
|
82
|
+
export type OpenVariantGalleryInput = Wire.OpenVariantGalleryData['body'];
|
|
83
|
+
export type OpenVariantGalleryResult = Wire.OpenVariantGalleryResponses[200]['data'];
|
|
84
|
+
export type OpenVariantGalleryError = Wire.OpenVariantGalleryErrors[keyof Wire.OpenVariantGalleryErrors];
|
|
85
|
+
export type RefreshInventorySourceHealthInput = Wire.RefreshInventorySourceHealthData['body'];
|
|
86
|
+
export type RefreshInventorySourceHealthResult = Wire.RefreshInventorySourceHealthResponses[200]['data'];
|
|
87
|
+
export type RefreshInventorySourceHealthError = Wire.RefreshInventorySourceHealthErrors[keyof Wire.RefreshInventorySourceHealthErrors];
|
|
88
|
+
export type RequestBuyerChildAccountInput = OptionalWireField<Wire.RequestBuyerChildAccountData['body'], "idempotencyKey">;
|
|
89
|
+
export type RequestBuyerChildAccountResult = Wire.RequestBuyerChildAccountResponses[200]['data'];
|
|
90
|
+
export type RequestBuyerChildAccountError = Wire.RequestBuyerChildAccountErrors[keyof Wire.RequestBuyerChildAccountErrors];
|
|
91
|
+
export type RequestProposalsInput = OptionalWireField<Wire.RequestProposalsData['body'], "idempotencyKey">;
|
|
92
|
+
export type RequestProposalsResult = Wire.RequestProposalsResponses[200]['data'];
|
|
93
|
+
export type RequestProposalsError = Wire.RequestProposalsErrors[keyof Wire.RequestProposalsErrors];
|
|
94
|
+
export type RequestSellerReportingUpdateInput = Wire.RequestSellerReportingUpdateData['body'];
|
|
95
|
+
export type RequestSellerReportingUpdateResult = Wire.RequestSellerReportingUpdateResponses[200]['data'];
|
|
96
|
+
export type RequestSellerReportingUpdateError = Wire.RequestSellerReportingUpdateErrors[keyof Wire.RequestSellerReportingUpdateErrors];
|
|
97
|
+
export type ReviewBuyerChildAccountInput = Wire.ReviewBuyerChildAccountData['body'];
|
|
98
|
+
export type ReviewBuyerChildAccountResult = Wire.ReviewBuyerChildAccountResponses[200]['data'];
|
|
99
|
+
export type ReviewBuyerChildAccountError = Wire.ReviewBuyerChildAccountErrors[keyof Wire.ReviewBuyerChildAccountErrors];
|
|
100
|
+
export type SaveAccountInput = Wire.SaveAccountData['body'];
|
|
101
|
+
export type SaveAccountResult = Wire.SaveAccountResponses[200]['data'];
|
|
102
|
+
export type SaveAccountError = Wire.SaveAccountErrors[keyof Wire.SaveAccountErrors];
|
|
103
|
+
export type SaveAdvertiserInput = Wire.SaveAdvertiserData['body'];
|
|
104
|
+
export type SaveAdvertiserResult = Wire.SaveAdvertiserResponses[200]['data'];
|
|
105
|
+
export type SaveAdvertiserError = Wire.SaveAdvertiserErrors[keyof Wire.SaveAdvertiserErrors];
|
|
106
|
+
export type SaveAdvertiserAccessInput = Wire.SaveAdvertiserAccessData['body'];
|
|
107
|
+
export type SaveAdvertiserAccessResult = Wire.SaveAdvertiserAccessResponses[200]['data'];
|
|
108
|
+
export type SaveAdvertiserAccessError = Wire.SaveAdvertiserAccessErrors[keyof Wire.SaveAdvertiserAccessErrors];
|
|
109
|
+
export type SaveAdvertiserGrantInput = Wire.SaveAdvertiserGrantData['body'];
|
|
110
|
+
export type SaveAdvertiserGrantResult = Wire.SaveAdvertiserGrantResponses[200]['data'];
|
|
111
|
+
export type SaveAdvertiserGrantError = Wire.SaveAdvertiserGrantErrors[keyof Wire.SaveAdvertiserGrantErrors];
|
|
112
|
+
export type SaveAdvertiserInstructionsInput = Wire.SaveAdvertiserInstructionsData['body'];
|
|
113
|
+
export type SaveAdvertiserInstructionsResult = Wire.SaveAdvertiserInstructionsResponses[200]['data'];
|
|
114
|
+
export type SaveAdvertiserInstructionsError = Wire.SaveAdvertiserInstructionsErrors[keyof Wire.SaveAdvertiserInstructionsErrors];
|
|
115
|
+
export type SaveAgentInput = Wire.SaveAgentData['body'];
|
|
116
|
+
export type SaveAgentResult = Wire.SaveAgentResponses[200]['data'];
|
|
117
|
+
export type SaveAgentError = Wire.SaveAgentErrors[keyof Wire.SaveAgentErrors];
|
|
118
|
+
export type SaveAskInput = Wire.SaveAskData['body'];
|
|
119
|
+
export type SaveAskResult = Wire.SaveAskResponses[200]['data'];
|
|
120
|
+
export type SaveAskError = Wire.SaveAskErrors[keyof Wire.SaveAskErrors];
|
|
121
|
+
export type SaveAudienceInput = Wire.SaveAudienceData['body'];
|
|
122
|
+
export type SaveAudienceResult = Wire.SaveAudienceResponses[200]['data'];
|
|
123
|
+
export type SaveAudienceError = Wire.SaveAudienceErrors[keyof Wire.SaveAudienceErrors];
|
|
124
|
+
export type SaveBillingInput = Wire.SaveBillingData['body'];
|
|
125
|
+
export type SaveBillingResult = Wire.SaveBillingResponses[200]['data'];
|
|
126
|
+
export type SaveBillingError = Wire.SaveBillingErrors[keyof Wire.SaveBillingErrors];
|
|
127
|
+
export type SaveBusinessRulesInput = Wire.SaveBusinessRulesData['body'];
|
|
128
|
+
export type SaveBusinessRulesResult = Wire.SaveBusinessRulesResponses[200]['data'];
|
|
129
|
+
export type SaveBusinessRulesError = Wire.SaveBusinessRulesErrors[keyof Wire.SaveBusinessRulesErrors];
|
|
130
|
+
export type SaveBuyerAgentInput = Wire.SaveBuyerAgentData['body'];
|
|
131
|
+
export type SaveBuyerAgentResult = Wire.SaveBuyerAgentResponses[200]['data'];
|
|
132
|
+
export type SaveBuyerAgentError = Wire.SaveBuyerAgentErrors[keyof Wire.SaveBuyerAgentErrors];
|
|
133
|
+
export type SaveBuyerOperatorInput = Wire.SaveBuyerOperatorData['body'];
|
|
134
|
+
export type SaveBuyerOperatorResult = Wire.SaveBuyerOperatorResponses[200]['data'];
|
|
135
|
+
export type SaveBuyerOperatorError = Wire.SaveBuyerOperatorErrors[keyof Wire.SaveBuyerOperatorErrors];
|
|
136
|
+
export type SaveCampaignInput = OptionalWireField<Wire.SaveCampaignData['body'], "idempotencyKey">;
|
|
137
|
+
export type SaveCampaignResult = Wire.SaveCampaignResponses[200]['data'];
|
|
138
|
+
export type SaveCampaignError = Wire.SaveCampaignErrors[keyof Wire.SaveCampaignErrors];
|
|
139
|
+
export type SaveCatalogInput = OptionalWireField<Wire.SaveCatalogData['body'], "idempotencyKey">;
|
|
140
|
+
export type SaveCatalogResult = Wire.SaveCatalogResponses[200]['data'];
|
|
141
|
+
export type SaveCatalogError = Wire.SaveCatalogErrors[keyof Wire.SaveCatalogErrors];
|
|
142
|
+
export type SaveConnectionInput = Wire.SaveConnectionData['body'];
|
|
143
|
+
export type SaveConnectionResult = Wire.SaveConnectionResponses[200]['data'];
|
|
144
|
+
export type SaveConnectionError = Wire.SaveConnectionErrors[keyof Wire.SaveConnectionErrors];
|
|
145
|
+
export type SaveCoverageInput = Wire.SaveCoverageData['body'];
|
|
146
|
+
export type SaveCoverageResult = Wire.SaveCoverageResponses[200]['data'];
|
|
147
|
+
export type SaveCoverageError = Wire.SaveCoverageErrors[keyof Wire.SaveCoverageErrors];
|
|
148
|
+
export type SaveCreativeInput = Wire.SaveCreativeData['body'];
|
|
149
|
+
export type SaveCreativeResult = Wire.SaveCreativeResponses[200]['data'];
|
|
150
|
+
export type SaveCreativeError = Wire.SaveCreativeErrors[keyof Wire.SaveCreativeErrors];
|
|
151
|
+
export type SaveCreativeCollectionInput = Wire.SaveCreativeCollectionData['body'];
|
|
152
|
+
export type SaveCreativeCollectionResult = Wire.SaveCreativeCollectionResponses[200]['data'];
|
|
153
|
+
export type SaveCreativeCollectionError = Wire.SaveCreativeCollectionErrors[keyof Wire.SaveCreativeCollectionErrors];
|
|
154
|
+
export type SaveCreativeSessionInput = Wire.SaveCreativeSessionData['body'];
|
|
155
|
+
export type SaveCreativeSessionResult = Wire.SaveCreativeSessionResponses[200]['data'];
|
|
156
|
+
export type SaveCreativeSessionError = Wire.SaveCreativeSessionErrors[keyof Wire.SaveCreativeSessionErrors];
|
|
157
|
+
export type SaveDimensionInput = OptionalWireField<Wire.SaveDimensionData['body'], "idempotencyKey">;
|
|
158
|
+
export type SaveDimensionResult = Wire.SaveDimensionResponses[200]['data'];
|
|
159
|
+
export type SaveDimensionError = Wire.SaveDimensionErrors[keyof Wire.SaveDimensionErrors];
|
|
160
|
+
export type SaveDirectedCampaignSubscriptionInput = Wire.SaveDirectedCampaignSubscriptionData['body'];
|
|
161
|
+
export type SaveDirectedCampaignSubscriptionResult = Wire.SaveDirectedCampaignSubscriptionResponses[200]['data'];
|
|
162
|
+
export type SaveDirectedCampaignSubscriptionError = Wire.SaveDirectedCampaignSubscriptionErrors[keyof Wire.SaveDirectedCampaignSubscriptionErrors];
|
|
163
|
+
export type SaveEventSourceInput = OptionalWireField<Wire.SaveEventSourceData['body'], "idempotencyKey">;
|
|
164
|
+
export type SaveEventSourceResult = Wire.SaveEventSourceResponses[200]['data'];
|
|
165
|
+
export type SaveEventSourceError = Wire.SaveEventSourceErrors[keyof Wire.SaveEventSourceErrors];
|
|
166
|
+
export type SaveInventorySourceInput = Wire.SaveInventorySourceData['body'];
|
|
167
|
+
export type SaveInventorySourceResult = Wire.SaveInventorySourceResponses[200]['data'];
|
|
168
|
+
export type SaveInventorySourceError = Wire.SaveInventorySourceErrors[keyof Wire.SaveInventorySourceErrors];
|
|
169
|
+
export type SaveLessonInput = Wire.SaveLessonData['body'];
|
|
170
|
+
export type SaveLessonResult = Wire.SaveLessonResponses[200]['data'];
|
|
171
|
+
export type SaveLessonError = Wire.SaveLessonErrors[keyof Wire.SaveLessonErrors];
|
|
172
|
+
export type SaveLibraryRequestInput = Wire.SaveLibraryRequestData['body'];
|
|
173
|
+
export type SaveLibraryRequestResult = Wire.SaveLibraryRequestResponses[200]['data'];
|
|
174
|
+
export type SaveLibraryRequestError = Wire.SaveLibraryRequestErrors[keyof Wire.SaveLibraryRequestErrors];
|
|
175
|
+
export type SaveMaterialInput = Wire.SaveMaterialData['body'];
|
|
176
|
+
export type SaveMaterialResult = Wire.SaveMaterialResponses[200]['data'];
|
|
177
|
+
export type SaveMaterialError = Wire.SaveMaterialErrors[keyof Wire.SaveMaterialErrors];
|
|
178
|
+
export type SaveMediaBuyInput = OptionalWireField<Wire.SaveMediaBuyData['body'], "idempotencyKey">;
|
|
179
|
+
export type SaveMediaBuyResult = Wire.SaveMediaBuyResponses[200]['data'];
|
|
180
|
+
export type SaveMediaBuyError = Wire.SaveMediaBuyErrors[keyof Wire.SaveMediaBuyErrors];
|
|
181
|
+
export type SaveMediaKitInput = Wire.SaveMediaKitData['body'];
|
|
182
|
+
export type SaveMediaKitResult = Wire.SaveMediaKitResponses[200]['data'];
|
|
183
|
+
export type SaveMediaKitError = Wire.SaveMediaKitErrors[keyof Wire.SaveMediaKitErrors];
|
|
184
|
+
export type SaveNotificationConfigInput = Wire.SaveNotificationConfigData['body'];
|
|
185
|
+
export type SaveNotificationConfigResult = Wire.SaveNotificationConfigResponses[200]['data'];
|
|
186
|
+
export type SaveNotificationConfigError = Wire.SaveNotificationConfigErrors[keyof Wire.SaveNotificationConfigErrors];
|
|
187
|
+
export type SavePlaybookInput = Wire.SavePlaybookData['body'];
|
|
188
|
+
export type SavePlaybookResult = Wire.SavePlaybookResponses[200]['data'];
|
|
189
|
+
export type SavePlaybookError = Wire.SavePlaybookErrors[keyof Wire.SavePlaybookErrors];
|
|
190
|
+
export type SavePropertyListInput = Wire.SavePropertyListData['body'];
|
|
191
|
+
export type SavePropertyListResult = Wire.SavePropertyListResponses[200]['data'];
|
|
192
|
+
export type SavePropertyListError = Wire.SavePropertyListErrors[keyof Wire.SavePropertyListErrors];
|
|
193
|
+
export type SaveRfpInput = Wire.SaveRfpData['body'];
|
|
194
|
+
export type SaveRfpResult = Wire.SaveRfpResponses[200]['data'];
|
|
195
|
+
export type SaveRfpError = Wire.SaveRfpErrors[keyof Wire.SaveRfpErrors];
|
|
196
|
+
export type SaveSellerInput = Wire.SaveSellerData['body'];
|
|
197
|
+
export type SaveSellerResult = Wire.SaveSellerResponses[200]['data'];
|
|
198
|
+
export type SaveSellerError = Wire.SaveSellerErrors[keyof Wire.SaveSellerErrors];
|
|
199
|
+
export type SaveSignalInput = Wire.SaveSignalData['body'];
|
|
200
|
+
export type SaveSignalResult = Wire.SaveSignalResponses[200]['data'];
|
|
201
|
+
export type SaveSignalError = Wire.SaveSignalErrors[keyof Wire.SaveSignalErrors];
|
|
202
|
+
export type SaveWholesaleProductInput = Wire.SaveWholesaleProductData['body'];
|
|
203
|
+
export type SaveWholesaleProductResult = Wire.SaveWholesaleProductResponses[200]['data'];
|
|
204
|
+
export type SaveWholesaleProductError = Wire.SaveWholesaleProductErrors[keyof Wire.SaveWholesaleProductErrors];
|
|
205
|
+
export type SaveWorkItemInput = Wire.SaveWorkItemData['body'];
|
|
206
|
+
export type SaveWorkItemResult = Wire.SaveWorkItemResponses[200]['data'];
|
|
207
|
+
export type SaveWorkItemError = Wire.SaveWorkItemErrors[keyof Wire.SaveWorkItemErrors];
|
|
208
|
+
export type SearchInput = Wire.SearchData['body'];
|
|
209
|
+
export type SearchResult = Wire.SearchResponses[200]['data'];
|
|
210
|
+
export type SearchError = Wire.SearchErrors[keyof Wire.SearchErrors];
|
|
211
|
+
export type TestCreativeMacrosInput = Wire.TestCreativeMacrosData['body'];
|
|
212
|
+
export type TestCreativeMacrosResult = Wire.TestCreativeMacrosResponses[200]['data'];
|
|
213
|
+
export type TestCreativeMacrosError = Wire.TestCreativeMacrosErrors[keyof Wire.TestCreativeMacrosErrors];
|
|
214
|
+
export type UploadCreativeAssetInput = Wire.UploadCreativeAssetData['body'];
|
|
215
|
+
export type UploadCreativeAssetResult = Wire.UploadCreativeAssetResponses[200]['data'];
|
|
216
|
+
export type UploadCreativeAssetError = Wire.UploadCreativeAssetErrors[keyof Wire.UploadCreativeAssetErrors];
|
|
217
|
+
export interface OperationTypes {
|
|
218
|
+
"downloadV3PublicDocumentRevision": {
|
|
219
|
+
input: DownloadV3PublicDocumentRevisionInput;
|
|
220
|
+
result: DownloadV3PublicDocumentRevisionResult;
|
|
221
|
+
};
|
|
222
|
+
"generate_variants": {
|
|
223
|
+
input: GenerateVariantsInput;
|
|
224
|
+
result: GenerateVariantsResult;
|
|
225
|
+
};
|
|
226
|
+
"get": {
|
|
227
|
+
input: GetInput;
|
|
228
|
+
result: GetResult;
|
|
229
|
+
};
|
|
230
|
+
"getV3PublicDocumentRevisionSections": {
|
|
231
|
+
input: GetV3PublicDocumentRevisionSectionsInput;
|
|
232
|
+
result: GetV3PublicDocumentRevisionSectionsResult;
|
|
233
|
+
};
|
|
234
|
+
"getV3PublicMutationReceipt": {
|
|
235
|
+
input: GetV3PublicMutationReceiptInput;
|
|
236
|
+
result: GetV3PublicMutationReceiptResult;
|
|
237
|
+
};
|
|
238
|
+
"get_delivery": {
|
|
239
|
+
input: GetDeliveryInput;
|
|
240
|
+
result: GetDeliveryResult;
|
|
241
|
+
};
|
|
242
|
+
"get_rfp_performance": {
|
|
243
|
+
input: GetRfpPerformanceInput;
|
|
244
|
+
result: GetRfpPerformanceResult;
|
|
245
|
+
};
|
|
246
|
+
"get_seller_reporting_receipts": {
|
|
247
|
+
input: GetSellerReportingReceiptsInput;
|
|
248
|
+
result: GetSellerReportingReceiptsResult;
|
|
249
|
+
};
|
|
250
|
+
"get_status": {
|
|
251
|
+
input: GetStatusInput;
|
|
252
|
+
result: GetStatusResult;
|
|
253
|
+
};
|
|
254
|
+
"open_advertisers_page": {
|
|
255
|
+
input: OpenAdvertisersPageInput;
|
|
256
|
+
result: OpenAdvertisersPageResult;
|
|
257
|
+
};
|
|
258
|
+
"open_agent_page": {
|
|
259
|
+
input: OpenAgentPageInput;
|
|
260
|
+
result: OpenAgentPageResult;
|
|
261
|
+
};
|
|
262
|
+
"open_agents_page": {
|
|
263
|
+
input: OpenAgentsPageInput;
|
|
264
|
+
result: OpenAgentsPageResult;
|
|
265
|
+
};
|
|
266
|
+
"open_approvals": {
|
|
267
|
+
input: OpenApprovalsInput;
|
|
268
|
+
result: OpenApprovalsResult;
|
|
269
|
+
};
|
|
270
|
+
"open_campaign_receipt": {
|
|
271
|
+
input: OpenCampaignReceiptInput;
|
|
272
|
+
result: OpenCampaignReceiptResult;
|
|
273
|
+
};
|
|
274
|
+
"open_campaigns_page": {
|
|
275
|
+
input: OpenCampaignsPageInput;
|
|
276
|
+
result: OpenCampaignsPageResult;
|
|
277
|
+
};
|
|
278
|
+
"open_connections_page": {
|
|
279
|
+
input: OpenConnectionsPageInput;
|
|
280
|
+
result: OpenConnectionsPageResult;
|
|
281
|
+
};
|
|
282
|
+
"open_creative_engines_page": {
|
|
283
|
+
input: OpenCreativeEnginesPageInput;
|
|
284
|
+
result: OpenCreativeEnginesPageResult;
|
|
285
|
+
};
|
|
286
|
+
"open_creative_library": {
|
|
287
|
+
input: OpenCreativeLibraryInput;
|
|
288
|
+
result: OpenCreativeLibraryResult;
|
|
289
|
+
};
|
|
290
|
+
"open_media_buys_page": {
|
|
291
|
+
input: OpenMediaBuysPageInput;
|
|
292
|
+
result: OpenMediaBuysPageResult;
|
|
293
|
+
};
|
|
294
|
+
"open_page": {
|
|
295
|
+
input: OpenPageInput;
|
|
296
|
+
result: OpenPageResult;
|
|
297
|
+
};
|
|
298
|
+
"open_proposal_pass": {
|
|
299
|
+
input: OpenProposalPassInput;
|
|
300
|
+
result: OpenProposalPassResult;
|
|
301
|
+
};
|
|
302
|
+
"open_seller_dashboard": {
|
|
303
|
+
input: OpenSellerDashboardInput;
|
|
304
|
+
result: OpenSellerDashboardResult;
|
|
305
|
+
};
|
|
306
|
+
"open_variant_gallery": {
|
|
307
|
+
input: OpenVariantGalleryInput;
|
|
308
|
+
result: OpenVariantGalleryResult;
|
|
309
|
+
};
|
|
310
|
+
"refresh_inventory_source_health": {
|
|
311
|
+
input: RefreshInventorySourceHealthInput;
|
|
312
|
+
result: RefreshInventorySourceHealthResult;
|
|
313
|
+
};
|
|
314
|
+
"request_buyer_child_account": {
|
|
315
|
+
input: RequestBuyerChildAccountInput;
|
|
316
|
+
result: RequestBuyerChildAccountResult;
|
|
317
|
+
};
|
|
318
|
+
"request_proposals": {
|
|
319
|
+
input: RequestProposalsInput;
|
|
320
|
+
result: RequestProposalsResult;
|
|
321
|
+
};
|
|
322
|
+
"request_seller_reporting_update": {
|
|
323
|
+
input: RequestSellerReportingUpdateInput;
|
|
324
|
+
result: RequestSellerReportingUpdateResult;
|
|
325
|
+
};
|
|
326
|
+
"review_buyer_child_account": {
|
|
327
|
+
input: ReviewBuyerChildAccountInput;
|
|
328
|
+
result: ReviewBuyerChildAccountResult;
|
|
329
|
+
};
|
|
330
|
+
"save_account": {
|
|
331
|
+
input: SaveAccountInput;
|
|
332
|
+
result: SaveAccountResult;
|
|
333
|
+
};
|
|
334
|
+
"save_advertiser": {
|
|
335
|
+
input: SaveAdvertiserInput;
|
|
336
|
+
result: SaveAdvertiserResult;
|
|
337
|
+
};
|
|
338
|
+
"save_advertiser_access": {
|
|
339
|
+
input: SaveAdvertiserAccessInput;
|
|
340
|
+
result: SaveAdvertiserAccessResult;
|
|
341
|
+
};
|
|
342
|
+
"save_advertiser_grant": {
|
|
343
|
+
input: SaveAdvertiserGrantInput;
|
|
344
|
+
result: SaveAdvertiserGrantResult;
|
|
345
|
+
};
|
|
346
|
+
"save_advertiser_instructions": {
|
|
347
|
+
input: SaveAdvertiserInstructionsInput;
|
|
348
|
+
result: SaveAdvertiserInstructionsResult;
|
|
349
|
+
};
|
|
350
|
+
"save_agent": {
|
|
351
|
+
input: SaveAgentInput;
|
|
352
|
+
result: SaveAgentResult;
|
|
353
|
+
};
|
|
354
|
+
"save_ask": {
|
|
355
|
+
input: SaveAskInput;
|
|
356
|
+
result: SaveAskResult;
|
|
357
|
+
};
|
|
358
|
+
"save_audience": {
|
|
359
|
+
input: SaveAudienceInput;
|
|
360
|
+
result: SaveAudienceResult;
|
|
361
|
+
};
|
|
362
|
+
"save_billing": {
|
|
363
|
+
input: SaveBillingInput;
|
|
364
|
+
result: SaveBillingResult;
|
|
365
|
+
};
|
|
366
|
+
"save_business_rules": {
|
|
367
|
+
input: SaveBusinessRulesInput;
|
|
368
|
+
result: SaveBusinessRulesResult;
|
|
369
|
+
};
|
|
370
|
+
"save_buyer_agent": {
|
|
371
|
+
input: SaveBuyerAgentInput;
|
|
372
|
+
result: SaveBuyerAgentResult;
|
|
373
|
+
};
|
|
374
|
+
"save_buyer_operator": {
|
|
375
|
+
input: SaveBuyerOperatorInput;
|
|
376
|
+
result: SaveBuyerOperatorResult;
|
|
377
|
+
};
|
|
378
|
+
"save_campaign": {
|
|
379
|
+
input: SaveCampaignInput;
|
|
380
|
+
result: SaveCampaignResult;
|
|
381
|
+
};
|
|
382
|
+
"save_catalog": {
|
|
383
|
+
input: SaveCatalogInput;
|
|
384
|
+
result: SaveCatalogResult;
|
|
385
|
+
};
|
|
386
|
+
"save_connection": {
|
|
387
|
+
input: SaveConnectionInput;
|
|
388
|
+
result: SaveConnectionResult;
|
|
389
|
+
};
|
|
390
|
+
"save_coverage": {
|
|
391
|
+
input: SaveCoverageInput;
|
|
392
|
+
result: SaveCoverageResult;
|
|
393
|
+
};
|
|
394
|
+
"save_creative": {
|
|
395
|
+
input: SaveCreativeInput;
|
|
396
|
+
result: SaveCreativeResult;
|
|
397
|
+
};
|
|
398
|
+
"save_creative_collection": {
|
|
399
|
+
input: SaveCreativeCollectionInput;
|
|
400
|
+
result: SaveCreativeCollectionResult;
|
|
401
|
+
};
|
|
402
|
+
"save_creative_session": {
|
|
403
|
+
input: SaveCreativeSessionInput;
|
|
404
|
+
result: SaveCreativeSessionResult;
|
|
405
|
+
};
|
|
406
|
+
"save_dimension": {
|
|
407
|
+
input: SaveDimensionInput;
|
|
408
|
+
result: SaveDimensionResult;
|
|
409
|
+
};
|
|
410
|
+
"save_directed_campaign_subscription": {
|
|
411
|
+
input: SaveDirectedCampaignSubscriptionInput;
|
|
412
|
+
result: SaveDirectedCampaignSubscriptionResult;
|
|
413
|
+
};
|
|
414
|
+
"save_event_source": {
|
|
415
|
+
input: SaveEventSourceInput;
|
|
416
|
+
result: SaveEventSourceResult;
|
|
417
|
+
};
|
|
418
|
+
"save_inventory_source": {
|
|
419
|
+
input: SaveInventorySourceInput;
|
|
420
|
+
result: SaveInventorySourceResult;
|
|
421
|
+
};
|
|
422
|
+
"save_lesson": {
|
|
423
|
+
input: SaveLessonInput;
|
|
424
|
+
result: SaveLessonResult;
|
|
425
|
+
};
|
|
426
|
+
"save_library_request": {
|
|
427
|
+
input: SaveLibraryRequestInput;
|
|
428
|
+
result: SaveLibraryRequestResult;
|
|
429
|
+
};
|
|
430
|
+
"save_material": {
|
|
431
|
+
input: SaveMaterialInput;
|
|
432
|
+
result: SaveMaterialResult;
|
|
433
|
+
};
|
|
434
|
+
"save_media_buy": {
|
|
435
|
+
input: SaveMediaBuyInput;
|
|
436
|
+
result: SaveMediaBuyResult;
|
|
437
|
+
};
|
|
438
|
+
"save_media_kit": {
|
|
439
|
+
input: SaveMediaKitInput;
|
|
440
|
+
result: SaveMediaKitResult;
|
|
441
|
+
};
|
|
442
|
+
"save_notification_config": {
|
|
443
|
+
input: SaveNotificationConfigInput;
|
|
444
|
+
result: SaveNotificationConfigResult;
|
|
445
|
+
};
|
|
446
|
+
"save_playbook": {
|
|
447
|
+
input: SavePlaybookInput;
|
|
448
|
+
result: SavePlaybookResult;
|
|
449
|
+
};
|
|
450
|
+
"save_property_list": {
|
|
451
|
+
input: SavePropertyListInput;
|
|
452
|
+
result: SavePropertyListResult;
|
|
453
|
+
};
|
|
454
|
+
"save_rfp": {
|
|
455
|
+
input: SaveRfpInput;
|
|
456
|
+
result: SaveRfpResult;
|
|
457
|
+
};
|
|
458
|
+
"save_seller": {
|
|
459
|
+
input: SaveSellerInput;
|
|
460
|
+
result: SaveSellerResult;
|
|
461
|
+
};
|
|
462
|
+
"save_signal": {
|
|
463
|
+
input: SaveSignalInput;
|
|
464
|
+
result: SaveSignalResult;
|
|
465
|
+
};
|
|
466
|
+
"save_wholesale_product": {
|
|
467
|
+
input: SaveWholesaleProductInput;
|
|
468
|
+
result: SaveWholesaleProductResult;
|
|
469
|
+
};
|
|
470
|
+
"save_work_item": {
|
|
471
|
+
input: SaveWorkItemInput;
|
|
472
|
+
result: SaveWorkItemResult;
|
|
473
|
+
};
|
|
474
|
+
"search": {
|
|
475
|
+
input: SearchInput;
|
|
476
|
+
result: SearchResult;
|
|
477
|
+
};
|
|
478
|
+
"test_creative_macros": {
|
|
479
|
+
input: TestCreativeMacrosInput;
|
|
480
|
+
result: TestCreativeMacrosResult;
|
|
481
|
+
};
|
|
482
|
+
"upload_creative_asset": {
|
|
483
|
+
input: UploadCreativeAssetInput;
|
|
484
|
+
result: UploadCreativeAssetResult;
|
|
485
|
+
};
|
|
486
|
+
}
|
|
487
|
+
export declare class Apostra extends Transport {
|
|
488
|
+
/**
|
|
489
|
+
* Download a public immutable document revision
|
|
490
|
+
*
|
|
491
|
+
* @example
|
|
492
|
+
* await client.downloadV3PublicDocumentRevision(input)
|
|
493
|
+
*/
|
|
494
|
+
downloadV3PublicDocumentRevision(input: DownloadV3PublicDocumentRevisionInput, options?: RequestOptions): Promise<DownloadV3PublicDocumentRevisionResult>;
|
|
495
|
+
/** Download a public immutable document revision Returns the data together with response headers and request ID. */
|
|
496
|
+
downloadV3PublicDocumentRevisionWithResponse(input: DownloadV3PublicDocumentRevisionInput, options?: RequestOptions): Promise<ResponseDetails<DownloadV3PublicDocumentRevisionResult>>;
|
|
497
|
+
/**
|
|
498
|
+
* 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.
|
|
499
|
+
*
|
|
500
|
+
* @example
|
|
501
|
+
* await client.generateVariants(input, { idempotencyKey: 'stable-key' })
|
|
502
|
+
*/
|
|
503
|
+
generateVariants(input: GenerateVariantsInput, options: WriteRequestOptions): Promise<GenerateVariantsResult>;
|
|
504
|
+
/** 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. */
|
|
505
|
+
generateVariantsWithResponse(input: GenerateVariantsInput, options: WriteRequestOptions): Promise<ResponseDetails<GenerateVariantsResult>>;
|
|
506
|
+
/**
|
|
507
|
+
* 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.
|
|
508
|
+
*
|
|
509
|
+
* @example
|
|
510
|
+
* await client.get(input)
|
|
511
|
+
*/
|
|
512
|
+
get(input: GetInput, options?: RequestOptions): Promise<GetResult>;
|
|
513
|
+
/** 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. */
|
|
514
|
+
getWithResponse(input: GetInput, options?: RequestOptions): Promise<ResponseDetails<GetResult>>;
|
|
515
|
+
/**
|
|
516
|
+
* Read a bounded public immutable document revision
|
|
517
|
+
*
|
|
518
|
+
* @example
|
|
519
|
+
* await client.getV3PublicDocumentRevisionSections(input)
|
|
520
|
+
*/
|
|
521
|
+
getV3PublicDocumentRevisionSections(input: GetV3PublicDocumentRevisionSectionsInput, options?: RequestOptions): Promise<GetV3PublicDocumentRevisionSectionsResult>;
|
|
522
|
+
/** Read a bounded public immutable document revision Returns the data together with response headers and request ID. */
|
|
523
|
+
getV3PublicDocumentRevisionSectionsWithResponse(input: GetV3PublicDocumentRevisionSectionsInput, options?: RequestOptions): Promise<ResponseDetails<GetV3PublicDocumentRevisionSectionsResult>>;
|
|
524
|
+
/**
|
|
525
|
+
* Read the state of a V3 HTTP write receipt
|
|
526
|
+
*
|
|
527
|
+
* @example
|
|
528
|
+
* await client.getV3PublicMutationReceipt(input)
|
|
529
|
+
*/
|
|
530
|
+
getV3PublicMutationReceipt(input: GetV3PublicMutationReceiptInput, options?: RequestOptions): Promise<GetV3PublicMutationReceiptResult>;
|
|
531
|
+
/** Read the state of a V3 HTTP write receipt Returns the data together with response headers and request ID. */
|
|
532
|
+
getV3PublicMutationReceiptWithResponse(input: GetV3PublicMutationReceiptInput, options?: RequestOptions): Promise<ResponseDetails<GetV3PublicMutationReceiptResult>>;
|
|
533
|
+
/**
|
|
534
|
+
* 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.
|
|
535
|
+
*
|
|
536
|
+
* @example
|
|
537
|
+
* await client.getDelivery(input)
|
|
538
|
+
*/
|
|
539
|
+
getDelivery(input: GetDeliveryInput, options?: RequestOptions): Promise<GetDeliveryResult>;
|
|
540
|
+
/** 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. */
|
|
541
|
+
getDeliveryWithResponse(input: GetDeliveryInput, options?: RequestOptions): Promise<ResponseDetails<GetDeliveryResult>>;
|
|
542
|
+
/**
|
|
543
|
+
* 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.
|
|
544
|
+
*
|
|
545
|
+
* @example
|
|
546
|
+
* await client.getRfpPerformance(input)
|
|
547
|
+
*/
|
|
548
|
+
getRfpPerformance(input: GetRfpPerformanceInput, options?: RequestOptions): Promise<GetRfpPerformanceResult>;
|
|
549
|
+
/** 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. */
|
|
550
|
+
getRfpPerformanceWithResponse(input: GetRfpPerformanceInput, options?: RequestOptions): Promise<ResponseDetails<GetRfpPerformanceResult>>;
|
|
551
|
+
/**
|
|
552
|
+
* 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.
|
|
553
|
+
*
|
|
554
|
+
* @example
|
|
555
|
+
* await client.getSellerReportingReceipts(input)
|
|
556
|
+
*/
|
|
557
|
+
getSellerReportingReceipts(input: GetSellerReportingReceiptsInput, options?: RequestOptions): Promise<GetSellerReportingReceiptsResult>;
|
|
558
|
+
/** 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. */
|
|
559
|
+
getSellerReportingReceiptsWithResponse(input: GetSellerReportingReceiptsInput, options?: RequestOptions): Promise<ResponseDetails<GetSellerReportingReceiptsResult>>;
|
|
560
|
+
/**
|
|
561
|
+
* 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.
|
|
562
|
+
*
|
|
563
|
+
* @example
|
|
564
|
+
* await client.getStatus(input)
|
|
565
|
+
*/
|
|
566
|
+
getStatus(input?: GetStatusInput, options?: RequestOptions): Promise<GetStatusResult>;
|
|
567
|
+
/** 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. */
|
|
568
|
+
getStatusWithResponse(input?: GetStatusInput, options?: RequestOptions): Promise<ResponseDetails<GetStatusResult>>;
|
|
569
|
+
/**
|
|
570
|
+
* 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").
|
|
571
|
+
*
|
|
572
|
+
* @example
|
|
573
|
+
* await client.openAdvertisersPage(input)
|
|
574
|
+
*/
|
|
575
|
+
openAdvertisersPage(input: OpenAdvertisersPageInput, options?: RequestOptions): Promise<OpenAdvertisersPageResult>;
|
|
576
|
+
/** 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. */
|
|
577
|
+
openAdvertisersPageWithResponse(input: OpenAdvertisersPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAdvertisersPageResult>>;
|
|
578
|
+
/**
|
|
579
|
+
* Open one agent owned by this Developer account.
|
|
580
|
+
*
|
|
581
|
+
* @example
|
|
582
|
+
* await client.openAgentPage(input)
|
|
583
|
+
*/
|
|
584
|
+
openAgentPage(input: OpenAgentPageInput, options?: RequestOptions): Promise<OpenAgentPageResult>;
|
|
585
|
+
/** Open one agent owned by this Developer account. Returns the data together with response headers and request ID. */
|
|
586
|
+
openAgentPageWithResponse(input: OpenAgentPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentPageResult>>;
|
|
587
|
+
/**
|
|
588
|
+
* Open Build an agent for this Developer account.
|
|
589
|
+
*
|
|
590
|
+
* @example
|
|
591
|
+
* await client.openAgentsPage(input)
|
|
592
|
+
*/
|
|
593
|
+
openAgentsPage(input: OpenAgentsPageInput, options?: RequestOptions): Promise<OpenAgentsPageResult>;
|
|
594
|
+
/** Open Build an agent for this Developer account. Returns the data together with response headers and request ID. */
|
|
595
|
+
openAgentsPageWithResponse(input: OpenAgentsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenAgentsPageResult>>;
|
|
596
|
+
/**
|
|
597
|
+
* 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.
|
|
598
|
+
*
|
|
599
|
+
* @example
|
|
600
|
+
* await client.openApprovals(input)
|
|
601
|
+
*/
|
|
602
|
+
openApprovals(input: OpenApprovalsInput, options?: RequestOptions): Promise<OpenApprovalsResult>;
|
|
603
|
+
/** 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. */
|
|
604
|
+
openApprovalsWithResponse(input: OpenApprovalsInput, options?: RequestOptions): Promise<ResponseDetails<OpenApprovalsResult>>;
|
|
605
|
+
/**
|
|
606
|
+
* 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.
|
|
607
|
+
*
|
|
608
|
+
* @example
|
|
609
|
+
* await client.openCampaignReceipt(input)
|
|
610
|
+
*/
|
|
611
|
+
openCampaignReceipt(input: OpenCampaignReceiptInput, options?: RequestOptions): Promise<OpenCampaignReceiptResult>;
|
|
612
|
+
/** 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. */
|
|
613
|
+
openCampaignReceiptWithResponse(input: OpenCampaignReceiptInput, options?: RequestOptions): Promise<ResponseDetails<OpenCampaignReceiptResult>>;
|
|
614
|
+
/**
|
|
615
|
+
* 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.
|
|
616
|
+
*
|
|
617
|
+
* @example
|
|
618
|
+
* await client.openCampaignsPage(input)
|
|
619
|
+
*/
|
|
620
|
+
openCampaignsPage(input: OpenCampaignsPageInput, options?: RequestOptions): Promise<OpenCampaignsPageResult>;
|
|
621
|
+
/** 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. */
|
|
622
|
+
openCampaignsPageWithResponse(input: OpenCampaignsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenCampaignsPageResult>>;
|
|
623
|
+
/**
|
|
624
|
+
* 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.
|
|
625
|
+
*
|
|
626
|
+
* @example
|
|
627
|
+
* await client.openConnectionsPage(input)
|
|
628
|
+
*/
|
|
629
|
+
openConnectionsPage(input: OpenConnectionsPageInput, options?: RequestOptions): Promise<OpenConnectionsPageResult>;
|
|
630
|
+
/** 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. */
|
|
631
|
+
openConnectionsPageWithResponse(input: OpenConnectionsPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenConnectionsPageResult>>;
|
|
632
|
+
/**
|
|
633
|
+
* 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.
|
|
634
|
+
*
|
|
635
|
+
* @example
|
|
636
|
+
* await client.openCreativeEnginesPage(input)
|
|
637
|
+
*/
|
|
638
|
+
openCreativeEnginesPage(input: OpenCreativeEnginesPageInput, options?: RequestOptions): Promise<OpenCreativeEnginesPageResult>;
|
|
639
|
+
/** 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. */
|
|
640
|
+
openCreativeEnginesPageWithResponse(input: OpenCreativeEnginesPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenCreativeEnginesPageResult>>;
|
|
641
|
+
/**
|
|
642
|
+
* 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.
|
|
643
|
+
*
|
|
644
|
+
* @example
|
|
645
|
+
* await client.openCreativeLibrary(input, { idempotencyKey: 'stable-key' })
|
|
646
|
+
*/
|
|
647
|
+
openCreativeLibrary(input: OpenCreativeLibraryInput, options: WriteRequestOptions): Promise<OpenCreativeLibraryResult>;
|
|
648
|
+
/** 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. */
|
|
649
|
+
openCreativeLibraryWithResponse(input: OpenCreativeLibraryInput, options: WriteRequestOptions): Promise<ResponseDetails<OpenCreativeLibraryResult>>;
|
|
650
|
+
/**
|
|
651
|
+
* Open the Seller Media Buys Page. Optionally focus one seller-owned account relationship and its buys or creatives; the Page self-fetches.
|
|
652
|
+
*
|
|
653
|
+
* @example
|
|
654
|
+
* await client.openMediaBuysPage(input)
|
|
655
|
+
*/
|
|
656
|
+
openMediaBuysPage(input: OpenMediaBuysPageInput, options?: RequestOptions): Promise<OpenMediaBuysPageResult>;
|
|
657
|
+
/** 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. */
|
|
658
|
+
openMediaBuysPageWithResponse(input: OpenMediaBuysPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenMediaBuysPageResult>>;
|
|
659
|
+
/**
|
|
660
|
+
* Open a compatibility Page. source_diagnostics can create or attach the Agent. External hosts may return text. Credentials and authority changes remain human ceremonies.
|
|
661
|
+
*
|
|
662
|
+
* @example
|
|
663
|
+
* await client.openPage(input)
|
|
664
|
+
*/
|
|
665
|
+
openPage(input: OpenPageInput, options?: RequestOptions): Promise<OpenPageResult>;
|
|
666
|
+
/** 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. */
|
|
667
|
+
openPageWithResponse(input: OpenPageInput, options?: RequestOptions): Promise<ResponseDetails<OpenPageResult>>;
|
|
668
|
+
/**
|
|
669
|
+
* 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.
|
|
670
|
+
*
|
|
671
|
+
* @example
|
|
672
|
+
* await client.openProposalPass(input)
|
|
673
|
+
*/
|
|
674
|
+
openProposalPass(input: OpenProposalPassInput, options?: RequestOptions): Promise<OpenProposalPassResult>;
|
|
675
|
+
/** 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. */
|
|
676
|
+
openProposalPassWithResponse(input: OpenProposalPassInput, options?: RequestOptions): Promise<ResponseDetails<OpenProposalPassResult>>;
|
|
677
|
+
/**
|
|
678
|
+
* 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.
|
|
679
|
+
*
|
|
680
|
+
* @example
|
|
681
|
+
* await client.openSellerDashboard(input)
|
|
682
|
+
*/
|
|
683
|
+
openSellerDashboard(input: OpenSellerDashboardInput, options?: RequestOptions): Promise<OpenSellerDashboardResult>;
|
|
684
|
+
/** 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. */
|
|
685
|
+
openSellerDashboardWithResponse(input: OpenSellerDashboardInput, options?: RequestOptions): Promise<ResponseDetails<OpenSellerDashboardResult>>;
|
|
686
|
+
/**
|
|
687
|
+
* Show a saved Creative Session’s variants (find via search/get kind creative_session). Not for generating new variants.
|
|
688
|
+
*
|
|
689
|
+
* @example
|
|
690
|
+
* await client.openVariantGallery(input)
|
|
691
|
+
*/
|
|
692
|
+
openVariantGallery(input: OpenVariantGalleryInput, options?: RequestOptions): Promise<OpenVariantGalleryResult>;
|
|
693
|
+
/** 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. */
|
|
694
|
+
openVariantGalleryWithResponse(input: OpenVariantGalleryInput, options?: RequestOptions): Promise<ResponseDetails<OpenVariantGalleryResult>>;
|
|
695
|
+
/**
|
|
696
|
+
* Rechecks one external sales-agent source with no-spend get_products. Returns evidence IDs and seller readiness; no source configuration or media buy.
|
|
697
|
+
*
|
|
698
|
+
* @example
|
|
699
|
+
* await client.refreshInventorySourceHealth(input, { idempotencyKey: 'stable-key' })
|
|
700
|
+
*/
|
|
701
|
+
refreshInventorySourceHealth(input: RefreshInventorySourceHealthInput, options: WriteRequestOptions): Promise<RefreshInventorySourceHealthResult>;
|
|
702
|
+
/** 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. */
|
|
703
|
+
refreshInventorySourceHealthWithResponse(input: RefreshInventorySourceHealthInput, options: WriteRequestOptions): Promise<ResponseDetails<RefreshInventorySourceHealthResult>>;
|
|
704
|
+
/**
|
|
705
|
+
* 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.
|
|
706
|
+
*
|
|
707
|
+
* @example
|
|
708
|
+
* await client.requestBuyerChildAccount(input, { idempotencyKey: 'stable-key' })
|
|
709
|
+
*/
|
|
710
|
+
requestBuyerChildAccount(input: RequestBuyerChildAccountInput, options: WriteRequestOptions): Promise<RequestBuyerChildAccountResult>;
|
|
711
|
+
/** 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. */
|
|
712
|
+
requestBuyerChildAccountWithResponse(input: RequestBuyerChildAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestBuyerChildAccountResult>>;
|
|
713
|
+
/**
|
|
714
|
+
* 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.
|
|
715
|
+
*
|
|
716
|
+
* @example
|
|
717
|
+
* await client.requestProposals(input, { idempotencyKey: 'stable-key' })
|
|
718
|
+
*/
|
|
719
|
+
requestProposals(input: RequestProposalsInput, options: WriteRequestOptions): Promise<RequestProposalsResult>;
|
|
720
|
+
/** 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. */
|
|
721
|
+
requestProposalsWithResponse(input: RequestProposalsInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestProposalsResult>>;
|
|
722
|
+
/**
|
|
723
|
+
* Requests a scheduler-run reporting refresh or a bounded replay for one seller media buy. It never polls a provider directly.
|
|
724
|
+
*
|
|
725
|
+
* @example
|
|
726
|
+
* await client.requestSellerReportingUpdate(input, { idempotencyKey: 'stable-key' })
|
|
727
|
+
*/
|
|
728
|
+
requestSellerReportingUpdate(input: RequestSellerReportingUpdateInput, options: WriteRequestOptions): Promise<RequestSellerReportingUpdateResult>;
|
|
729
|
+
/** 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. */
|
|
730
|
+
requestSellerReportingUpdateWithResponse(input: RequestSellerReportingUpdateInput, options: WriteRequestOptions): Promise<ResponseDetails<RequestSellerReportingUpdateResult>>;
|
|
731
|
+
/**
|
|
732
|
+
* 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.
|
|
733
|
+
*
|
|
734
|
+
* @example
|
|
735
|
+
* await client.reviewBuyerChildAccount(input)
|
|
736
|
+
*/
|
|
737
|
+
reviewBuyerChildAccount(input: ReviewBuyerChildAccountInput, options?: RequestOptions): Promise<ReviewBuyerChildAccountResult>;
|
|
738
|
+
/** 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. */
|
|
739
|
+
reviewBuyerChildAccountWithResponse(input: ReviewBuyerChildAccountInput, options?: RequestOptions): Promise<ResponseDetails<ReviewBuyerChildAccountResult>>;
|
|
740
|
+
/**
|
|
741
|
+
* Rename an existing direct child Account or update settings.company. Never provisions, archives, or changes owners or members; use Account settings for access changes.
|
|
742
|
+
*
|
|
743
|
+
* @example
|
|
744
|
+
* await client.saveAccount(input, { idempotencyKey: 'stable-key' })
|
|
745
|
+
*/
|
|
746
|
+
saveAccount(input: SaveAccountInput, options: WriteRequestOptions): Promise<SaveAccountResult>;
|
|
747
|
+
/** 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. */
|
|
748
|
+
saveAccountWithResponse(input: SaveAccountInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAccountResult>>;
|
|
749
|
+
/**
|
|
750
|
+
* 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.
|
|
751
|
+
*
|
|
752
|
+
* @example
|
|
753
|
+
* await client.saveAdvertiser(input, { idempotencyKey: 'stable-key' })
|
|
754
|
+
*/
|
|
755
|
+
saveAdvertiser(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<SaveAdvertiserResult>;
|
|
756
|
+
/** 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. */
|
|
757
|
+
saveAdvertiserWithResponse(input: SaveAdvertiserInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserResult>>;
|
|
758
|
+
/**
|
|
759
|
+
* 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.
|
|
760
|
+
*
|
|
761
|
+
* @example
|
|
762
|
+
* await client.saveAdvertiserAccess(input, { idempotencyKey: 'stable-key' })
|
|
763
|
+
*/
|
|
764
|
+
saveAdvertiserAccess(input: SaveAdvertiserAccessInput, options: WriteRequestOptions): Promise<SaveAdvertiserAccessResult>;
|
|
765
|
+
/** 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. */
|
|
766
|
+
saveAdvertiserAccessWithResponse(input: SaveAdvertiserAccessInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserAccessResult>>;
|
|
767
|
+
/**
|
|
768
|
+
* 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.
|
|
769
|
+
*
|
|
770
|
+
* @example
|
|
771
|
+
* await client.saveAdvertiserGrant(input, { idempotencyKey: 'stable-key' })
|
|
772
|
+
*/
|
|
773
|
+
saveAdvertiserGrant(input: SaveAdvertiserGrantInput, options: WriteRequestOptions): Promise<SaveAdvertiserGrantResult>;
|
|
774
|
+
/** 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. */
|
|
775
|
+
saveAdvertiserGrantWithResponse(input: SaveAdvertiserGrantInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserGrantResult>>;
|
|
776
|
+
/**
|
|
777
|
+
* 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.
|
|
778
|
+
*
|
|
779
|
+
* @example
|
|
780
|
+
* await client.saveAdvertiserInstructions(input, { idempotencyKey: 'stable-key' })
|
|
781
|
+
*/
|
|
782
|
+
saveAdvertiserInstructions(input: SaveAdvertiserInstructionsInput, options: WriteRequestOptions): Promise<SaveAdvertiserInstructionsResult>;
|
|
783
|
+
/** 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. */
|
|
784
|
+
saveAdvertiserInstructionsWithResponse(input: SaveAdvertiserInstructionsInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAdvertiserInstructionsResult>>;
|
|
785
|
+
/**
|
|
786
|
+
* 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.
|
|
787
|
+
*
|
|
788
|
+
* @example
|
|
789
|
+
* await client.saveAgent(input, { idempotencyKey: 'stable-key' })
|
|
790
|
+
*/
|
|
791
|
+
saveAgent(input: SaveAgentInput, options: WriteRequestOptions): Promise<SaveAgentResult>;
|
|
792
|
+
/** 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. */
|
|
793
|
+
saveAgentWithResponse(input: SaveAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAgentResult>>;
|
|
794
|
+
/**
|
|
795
|
+
* 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.
|
|
796
|
+
*
|
|
797
|
+
* @example
|
|
798
|
+
* await client.saveAsk(input, { idempotencyKey: 'stable-key' })
|
|
799
|
+
*/
|
|
800
|
+
saveAsk(input: SaveAskInput, options: WriteRequestOptions): Promise<SaveAskResult>;
|
|
801
|
+
/** 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. */
|
|
802
|
+
saveAskWithResponse(input: SaveAskInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAskResult>>;
|
|
803
|
+
/**
|
|
804
|
+
* 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.
|
|
805
|
+
*
|
|
806
|
+
* @example
|
|
807
|
+
* await client.saveAudience(input, { idempotencyKey: 'stable-key' })
|
|
808
|
+
*/
|
|
809
|
+
saveAudience(input: SaveAudienceInput, options: WriteRequestOptions): Promise<SaveAudienceResult>;
|
|
810
|
+
/** 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. */
|
|
811
|
+
saveAudienceWithResponse(input: SaveAudienceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveAudienceResult>>;
|
|
812
|
+
/**
|
|
813
|
+
* Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP.
|
|
814
|
+
*
|
|
815
|
+
* @example
|
|
816
|
+
* await client.saveBilling(input, { idempotencyKey: 'stable-key' })
|
|
817
|
+
*/
|
|
818
|
+
saveBilling(input: SaveBillingInput, options: WriteRequestOptions): Promise<SaveBillingResult>;
|
|
819
|
+
/** Accept Terms, set seller terms, or manage payment authority. Cards stay off MCP. Returns the data together with response headers and request ID. */
|
|
820
|
+
saveBillingWithResponse(input: SaveBillingInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBillingResult>>;
|
|
821
|
+
/**
|
|
822
|
+
* Write seller AI Business Rules. Policy content needs an account admin and both policy fields. Approval auto needs acknowledgeNoHumanReview.
|
|
823
|
+
*
|
|
824
|
+
* @example
|
|
825
|
+
* await client.saveBusinessRules(input, { idempotencyKey: 'stable-key' })
|
|
826
|
+
*/
|
|
827
|
+
saveBusinessRules(input: SaveBusinessRulesInput, options: WriteRequestOptions): Promise<SaveBusinessRulesResult>;
|
|
828
|
+
/** 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. */
|
|
829
|
+
saveBusinessRulesWithResponse(input: SaveBusinessRulesInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBusinessRulesResult>>;
|
|
830
|
+
/**
|
|
831
|
+
* Create or manage one buyer agent.
|
|
832
|
+
*
|
|
833
|
+
* @example
|
|
834
|
+
* await client.saveBuyerAgent(input, { idempotencyKey: 'stable-key' })
|
|
835
|
+
*/
|
|
836
|
+
saveBuyerAgent(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<SaveBuyerAgentResult>;
|
|
837
|
+
/** Create or manage one buyer agent. Returns the data together with response headers and request ID. */
|
|
838
|
+
saveBuyerAgentWithResponse(input: SaveBuyerAgentInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerAgentResult>>;
|
|
839
|
+
/**
|
|
840
|
+
* Save buyer commercial identity. Read get_status; use identityContract:confirmed-v1 for preview and confirmation. Guide: /v2/setup/v3/identity-setup.
|
|
841
|
+
*
|
|
842
|
+
* @example
|
|
843
|
+
* await client.saveBuyerOperator(input, { idempotencyKey: 'stable-key' })
|
|
844
|
+
*/
|
|
845
|
+
saveBuyerOperator(input: SaveBuyerOperatorInput, options: WriteRequestOptions): Promise<SaveBuyerOperatorResult>;
|
|
846
|
+
/** 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. */
|
|
847
|
+
saveBuyerOperatorWithResponse(input: SaveBuyerOperatorInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveBuyerOperatorResult>>;
|
|
848
|
+
/**
|
|
849
|
+
* 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.
|
|
850
|
+
*
|
|
851
|
+
* @example
|
|
852
|
+
* await client.saveCampaign(input, { idempotencyKey: 'stable-key' })
|
|
853
|
+
*/
|
|
854
|
+
saveCampaign(input: SaveCampaignInput, options: WriteRequestOptions): Promise<SaveCampaignResult>;
|
|
855
|
+
/** 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. */
|
|
856
|
+
saveCampaignWithResponse(input: SaveCampaignInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCampaignResult>>;
|
|
857
|
+
/**
|
|
858
|
+
* 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.
|
|
859
|
+
*
|
|
860
|
+
* @example
|
|
861
|
+
* await client.saveCatalog(input, { idempotencyKey: 'stable-key' })
|
|
862
|
+
*/
|
|
863
|
+
saveCatalog(input: SaveCatalogInput, options: WriteRequestOptions): Promise<SaveCatalogResult>;
|
|
864
|
+
/** 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. */
|
|
865
|
+
saveCatalogWithResponse(input: SaveCatalogInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCatalogResult>>;
|
|
866
|
+
/**
|
|
867
|
+
* Manage seller or creative-engine authorization, accounts and advertiser mappings. Seller-only: reporting, selection, billing, policy, activation.
|
|
868
|
+
*
|
|
869
|
+
* @example
|
|
870
|
+
* await client.saveConnection(input, { idempotencyKey: 'stable-key' })
|
|
871
|
+
*/
|
|
872
|
+
saveConnection(input: SaveConnectionInput, options: WriteRequestOptions): Promise<SaveConnectionResult>;
|
|
873
|
+
/** 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. */
|
|
874
|
+
saveConnectionWithResponse(input: SaveConnectionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveConnectionResult>>;
|
|
875
|
+
/**
|
|
876
|
+
* 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.
|
|
877
|
+
*
|
|
878
|
+
* @example
|
|
879
|
+
* await client.saveCoverage(input, { idempotencyKey: 'stable-key' })
|
|
880
|
+
*/
|
|
881
|
+
saveCoverage(input: SaveCoverageInput, options: WriteRequestOptions): Promise<SaveCoverageResult>;
|
|
882
|
+
/** 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. */
|
|
883
|
+
saveCoverageWithResponse(input: SaveCoverageInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCoverageResult>>;
|
|
884
|
+
/**
|
|
885
|
+
* 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.
|
|
886
|
+
*
|
|
887
|
+
* @example
|
|
888
|
+
* await client.saveCreative(input, { idempotencyKey: 'stable-key' })
|
|
889
|
+
*/
|
|
890
|
+
saveCreative(input: SaveCreativeInput, options: WriteRequestOptions): Promise<SaveCreativeResult>;
|
|
891
|
+
/** 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. */
|
|
892
|
+
saveCreativeWithResponse(input: SaveCreativeInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeResult>>;
|
|
893
|
+
/**
|
|
894
|
+
* 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.
|
|
895
|
+
*
|
|
896
|
+
* @example
|
|
897
|
+
* await client.saveCreativeCollection(input, { idempotencyKey: 'stable-key' })
|
|
898
|
+
*/
|
|
899
|
+
saveCreativeCollection(input: SaveCreativeCollectionInput, options: WriteRequestOptions): Promise<SaveCreativeCollectionResult>;
|
|
900
|
+
/** 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. */
|
|
901
|
+
saveCreativeCollectionWithResponse(input: SaveCreativeCollectionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeCollectionResult>>;
|
|
902
|
+
/**
|
|
903
|
+
* Create image, video, or voice/audio variants from a brief (including radio spots). Scope: campaign/campaignId or advertiser/advertiserId.
|
|
904
|
+
*
|
|
905
|
+
* @example
|
|
906
|
+
* await client.saveCreativeSession(input, { idempotencyKey: 'stable-key' })
|
|
907
|
+
*/
|
|
908
|
+
saveCreativeSession(input: SaveCreativeSessionInput, options: WriteRequestOptions): Promise<SaveCreativeSessionResult>;
|
|
909
|
+
/** 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. */
|
|
910
|
+
saveCreativeSessionWithResponse(input: SaveCreativeSessionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveCreativeSessionResult>>;
|
|
911
|
+
/**
|
|
912
|
+
* Create a dimension, or update an existing dimension by its id. Tags is built in and open. Labels belong only to objects in appliesTo.
|
|
913
|
+
*
|
|
914
|
+
* @example
|
|
915
|
+
* await client.saveDimension(input, { idempotencyKey: 'stable-key' })
|
|
916
|
+
*/
|
|
917
|
+
saveDimension(input: SaveDimensionInput, options: WriteRequestOptions): Promise<SaveDimensionResult>;
|
|
918
|
+
/** 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. */
|
|
919
|
+
saveDimensionWithResponse(input: SaveDimensionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveDimensionResult>>;
|
|
920
|
+
/**
|
|
921
|
+
* 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.
|
|
922
|
+
*
|
|
923
|
+
* @example
|
|
924
|
+
* await client.saveDirectedCampaignSubscription(input, { idempotencyKey: 'stable-key' })
|
|
925
|
+
*/
|
|
926
|
+
saveDirectedCampaignSubscription(input: SaveDirectedCampaignSubscriptionInput, options: WriteRequestOptions): Promise<SaveDirectedCampaignSubscriptionResult>;
|
|
927
|
+
/** 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. */
|
|
928
|
+
saveDirectedCampaignSubscriptionWithResponse(input: SaveDirectedCampaignSubscriptionInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveDirectedCampaignSubscriptionResult>>;
|
|
929
|
+
/**
|
|
930
|
+
* 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.
|
|
931
|
+
*
|
|
932
|
+
* @example
|
|
933
|
+
* await client.saveEventSource(input, { idempotencyKey: 'stable-key' })
|
|
934
|
+
*/
|
|
935
|
+
saveEventSource(input: SaveEventSourceInput, options: WriteRequestOptions): Promise<SaveEventSourceResult>;
|
|
936
|
+
/** 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. */
|
|
937
|
+
saveEventSourceWithResponse(input: SaveEventSourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveEventSourceResult>>;
|
|
938
|
+
/**
|
|
939
|
+
* 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.
|
|
940
|
+
*
|
|
941
|
+
* @example
|
|
942
|
+
* await client.saveInventorySource(input, { idempotencyKey: 'stable-key' })
|
|
943
|
+
*/
|
|
944
|
+
saveInventorySource(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<SaveInventorySourceResult>;
|
|
945
|
+
/** 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. */
|
|
946
|
+
saveInventorySourceWithResponse(input: SaveInventorySourceInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveInventorySourceResult>>;
|
|
947
|
+
/**
|
|
948
|
+
* 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.
|
|
949
|
+
*
|
|
950
|
+
* @example
|
|
951
|
+
* await client.saveLesson(input, { idempotencyKey: 'stable-key' })
|
|
952
|
+
*/
|
|
953
|
+
saveLesson(input: SaveLessonInput, options: WriteRequestOptions): Promise<SaveLessonResult>;
|
|
954
|
+
/** 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. */
|
|
955
|
+
saveLessonWithResponse(input: SaveLessonInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLessonResult>>;
|
|
956
|
+
/**
|
|
957
|
+
* Open a seller library request or close it with seller Material.
|
|
958
|
+
*
|
|
959
|
+
* @example
|
|
960
|
+
* await client.saveLibraryRequest(input, { idempotencyKey: 'stable-key' })
|
|
961
|
+
*/
|
|
962
|
+
saveLibraryRequest(input: SaveLibraryRequestInput, options: WriteRequestOptions): Promise<SaveLibraryRequestResult>;
|
|
963
|
+
/** Open a seller library request or close it with seller Material. Returns the data together with response headers and request ID. */
|
|
964
|
+
saveLibraryRequestWithResponse(input: SaveLibraryRequestInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveLibraryRequestResult>>;
|
|
965
|
+
/**
|
|
966
|
+
* 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).
|
|
967
|
+
*
|
|
968
|
+
* @example
|
|
969
|
+
* await client.saveMaterial(input, { idempotencyKey: 'stable-key' })
|
|
970
|
+
*/
|
|
971
|
+
saveMaterial(input: SaveMaterialInput, options: WriteRequestOptions): Promise<SaveMaterialResult>;
|
|
972
|
+
/** 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. */
|
|
973
|
+
saveMaterialWithResponse(input: SaveMaterialInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveMaterialResult>>;
|
|
974
|
+
/**
|
|
975
|
+
* 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.
|
|
976
|
+
*
|
|
977
|
+
* @example
|
|
978
|
+
* await client.saveMediaBuy(input, { idempotencyKey: 'stable-key' })
|
|
979
|
+
*/
|
|
980
|
+
saveMediaBuy(input: SaveMediaBuyInput, options: WriteRequestOptions): Promise<SaveMediaBuyResult>;
|
|
981
|
+
/** 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. */
|
|
982
|
+
saveMediaBuyWithResponse(input: SaveMediaBuyInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveMediaBuyResult>>;
|
|
983
|
+
/**
|
|
984
|
+
* 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`.
|
|
985
|
+
*
|
|
986
|
+
* @example
|
|
987
|
+
* await client.saveMediaKit(input, { idempotencyKey: 'stable-key' })
|
|
988
|
+
*/
|
|
989
|
+
saveMediaKit(input: SaveMediaKitInput, options: WriteRequestOptions): Promise<SaveMediaKitResult>;
|
|
990
|
+
/** 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. */
|
|
991
|
+
saveMediaKitWithResponse(input: SaveMediaKitInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveMediaKitResult>>;
|
|
992
|
+
/**
|
|
993
|
+
* Create or update a notification subscription. Omit subscriptionId to create; managed subscriptions permit only mutable fields. Use save_integration for credentials when needed.
|
|
994
|
+
*
|
|
995
|
+
* @example
|
|
996
|
+
* await client.saveNotificationConfig(input, { idempotencyKey: 'stable-key' })
|
|
997
|
+
*/
|
|
998
|
+
saveNotificationConfig(input: SaveNotificationConfigInput, options: WriteRequestOptions): Promise<SaveNotificationConfigResult>;
|
|
999
|
+
/** 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. */
|
|
1000
|
+
saveNotificationConfigWithResponse(input: SaveNotificationConfigInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveNotificationConfigResult>>;
|
|
1001
|
+
/**
|
|
1002
|
+
* 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.
|
|
1003
|
+
*
|
|
1004
|
+
* @example
|
|
1005
|
+
* await client.savePlaybook(input, { idempotencyKey: 'stable-key' })
|
|
1006
|
+
*/
|
|
1007
|
+
savePlaybook(input: SavePlaybookInput, options: WriteRequestOptions): Promise<SavePlaybookResult>;
|
|
1008
|
+
/** 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. */
|
|
1009
|
+
savePlaybookWithResponse(input: SavePlaybookInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePlaybookResult>>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Create, update, archive, restore, or AAO-check an advertiser property list. Check uses identifiers without saving. Search/get read saved lists.
|
|
1012
|
+
*
|
|
1013
|
+
* @example
|
|
1014
|
+
* await client.savePropertyList(input, { idempotencyKey: 'stable-key' })
|
|
1015
|
+
*/
|
|
1016
|
+
savePropertyList(input: SavePropertyListInput, options: WriteRequestOptions): Promise<SavePropertyListResult>;
|
|
1017
|
+
/** 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. */
|
|
1018
|
+
savePropertyListWithResponse(input: SavePropertyListInput, options: WriteRequestOptions): Promise<ResponseDetails<SavePropertyListResult>>;
|
|
1019
|
+
/**
|
|
1020
|
+
* Save RFPs and turns: imported origins, typed feedback, response pairs, endorsement, and proposal-file requests.
|
|
1021
|
+
*
|
|
1022
|
+
* @example
|
|
1023
|
+
* await client.saveRfp(input, { idempotencyKey: 'stable-key' })
|
|
1024
|
+
*/
|
|
1025
|
+
saveRfp(input: SaveRfpInput, options: WriteRequestOptions): Promise<SaveRfpResult>;
|
|
1026
|
+
/** 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. */
|
|
1027
|
+
saveRfpWithResponse(input: SaveRfpInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveRfpResult>>;
|
|
1028
|
+
/**
|
|
1029
|
+
* 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").
|
|
1030
|
+
*
|
|
1031
|
+
* @example
|
|
1032
|
+
* await client.saveSeller(input, { idempotencyKey: 'stable-key' })
|
|
1033
|
+
*/
|
|
1034
|
+
saveSeller(input: SaveSellerInput, options: WriteRequestOptions): Promise<SaveSellerResult>;
|
|
1035
|
+
/** 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. */
|
|
1036
|
+
saveSellerWithResponse(input: SaveSellerInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveSellerResult>>;
|
|
1037
|
+
/**
|
|
1038
|
+
* Create, replace, or archive a signal. Managed writes need a complete draft; read before updates. Without sourceId, writes the seller catalog.
|
|
1039
|
+
*
|
|
1040
|
+
* @example
|
|
1041
|
+
* await client.saveSignal(input, { idempotencyKey: 'stable-key' })
|
|
1042
|
+
*/
|
|
1043
|
+
saveSignal(input: SaveSignalInput, options: WriteRequestOptions): Promise<SaveSignalResult>;
|
|
1044
|
+
/** 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. */
|
|
1045
|
+
saveSignalWithResponse(input: SaveSignalInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveSignalResult>>;
|
|
1046
|
+
/**
|
|
1047
|
+
* 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.
|
|
1048
|
+
*
|
|
1049
|
+
* @example
|
|
1050
|
+
* await client.saveWholesaleProduct(input, { idempotencyKey: 'stable-key' })
|
|
1051
|
+
*/
|
|
1052
|
+
saveWholesaleProduct(input: SaveWholesaleProductInput, options: WriteRequestOptions): Promise<SaveWholesaleProductResult>;
|
|
1053
|
+
/** 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. */
|
|
1054
|
+
saveWholesaleProductWithResponse(input: SaveWholesaleProductInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveWholesaleProductResult>>;
|
|
1055
|
+
/**
|
|
1056
|
+
* 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.
|
|
1057
|
+
*
|
|
1058
|
+
* @example
|
|
1059
|
+
* await client.saveWorkItem(input, { idempotencyKey: 'stable-key' })
|
|
1060
|
+
*/
|
|
1061
|
+
saveWorkItem(input: SaveWorkItemInput, options: WriteRequestOptions): Promise<SaveWorkItemResult>;
|
|
1062
|
+
/** 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. */
|
|
1063
|
+
saveWorkItemWithResponse(input: SaveWorkItemInput, options: WriteRequestOptions): Promise<ResponseDetails<SaveWorkItemResult>>;
|
|
1064
|
+
/**
|
|
1065
|
+
* 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.
|
|
1066
|
+
*
|
|
1067
|
+
* @example
|
|
1068
|
+
* await client.search(input)
|
|
1069
|
+
*/
|
|
1070
|
+
search(input: SearchInput, options?: RequestOptions): Promise<SearchResult>;
|
|
1071
|
+
/** 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. */
|
|
1072
|
+
searchWithResponse(input: SearchInput, options?: RequestOptions): Promise<ResponseDetails<SearchResult>>;
|
|
1073
|
+
/**
|
|
1074
|
+
* 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.
|
|
1075
|
+
*
|
|
1076
|
+
* @example
|
|
1077
|
+
* await client.testCreativeMacros(input)
|
|
1078
|
+
*/
|
|
1079
|
+
testCreativeMacros(input: TestCreativeMacrosInput, options?: RequestOptions): Promise<TestCreativeMacrosResult>;
|
|
1080
|
+
/** 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. */
|
|
1081
|
+
testCreativeMacrosWithResponse(input: TestCreativeMacrosInput, options?: RequestOptions): Promise<ResponseDetails<TestCreativeMacrosResult>>;
|
|
1082
|
+
/**
|
|
1083
|
+
* 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.
|
|
1084
|
+
*
|
|
1085
|
+
* @example
|
|
1086
|
+
* await client.uploadCreativeAsset(input, { idempotencyKey: 'stable-key' })
|
|
1087
|
+
*/
|
|
1088
|
+
uploadCreativeAsset(input: UploadCreativeAssetInput, options: WriteRequestOptions): Promise<UploadCreativeAssetResult>;
|
|
1089
|
+
/** 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. */
|
|
1090
|
+
uploadCreativeAssetWithResponse(input: UploadCreativeAssetInput, options: WriteRequestOptions): Promise<ResponseDetails<UploadCreativeAssetResult>>;
|
|
1091
|
+
}
|
|
1092
|
+
export {};
|