soundlink 1.1.1 → 2.0.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/CHANGELOG.md +13 -1
- package/README.md +105 -26
- package/dist/cjs/index.cjs +176 -31
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/index.d.ts +255 -42
- package/dist/esm/index.js +176 -31
- package/dist/esm/index.js.map +1 -1
- package/openapi/soundlink-public-api-v1.yaml +1355 -218
- package/package.json +1 -1
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,9 +1,22 @@
|
|
|
1
1
|
/** Stable snake_case error codes returned by the Soundlink Public API. */
|
|
2
|
-
type PublicApiErrorCode = 'invalid_api_key' | 'api_key_revoked' | 'api_key_expired' | 'mixed_credentials' | 'insufficient_scope' | 'not_found' | 'campaign_not_found' | 'invalid_query_parameter' | 'invalid_date_range' | 'page_size_exceeded' | 'rate_limit_exceeded' | 'internal_error';
|
|
3
|
-
/**
|
|
4
|
-
|
|
2
|
+
type PublicApiErrorCode = 'invalid_api_key' | 'api_key_revoked' | 'api_key_expired' | 'mixed_credentials' | 'insufficient_scope' | 'not_found' | 'campaign_not_found' | 'invalid_query_parameter' | 'invalid_date_range' | 'page_size_exceeded' | 'invalid_request' | 'invalid_genre' | 'invalid_duration_or_budget' | 'invalid_daily_budget' | 'invalid_duration_days' | 'invalid_spotify_url' | 'invalid_tier_budget_allocation' | 'invalid_tier_status' | 'tier_update_cooldown' | 'wallet_not_enabled' | 'insufficient_credit' | 'idempotency_key_conflict' | 'rate_limit_exceeded' | 'invalid_video_url' | 'video_import_limit_exceeded' | 'video_import_session_not_found' | 'internal_error';
|
|
3
|
+
/**
|
|
4
|
+
* Campaign lifecycle status.
|
|
5
|
+
*
|
|
6
|
+
* Includes OpenAPI values plus `inactive` (observed on wallet campaigns in
|
|
7
|
+
* production; may be aligned in a later OpenAPI revision).
|
|
8
|
+
*/
|
|
9
|
+
type CampaignStatus = 'creating' | 'active' | 'paused' | 'stopped' | 'completed' | 'failed' | 'ended' | 'inactive';
|
|
5
10
|
/** Ad platform used by the campaign. */
|
|
6
11
|
type SocialPlatform = 'meta';
|
|
12
|
+
/**
|
|
13
|
+
* Campaign resource generation.
|
|
14
|
+
*
|
|
15
|
+
* - `1` — Stripe / one-time / subscription / legacy
|
|
16
|
+
* - `2` — managed
|
|
17
|
+
* - `3` — wallet (writable via Public API)
|
|
18
|
+
*/
|
|
19
|
+
type CampaignGeneration = 1 | 2 | 3;
|
|
7
20
|
/**
|
|
8
21
|
* Engagement context for per-track metrics.
|
|
9
22
|
*
|
|
@@ -15,10 +28,23 @@ type EngagementContext = 'catalog' | 'playlist';
|
|
|
15
28
|
type CampaignSortBy = 'createdAt' | 'status';
|
|
16
29
|
/** Allowed `sortBy` values for breakdown list requests. */
|
|
17
30
|
type BreakdownSortBy = 'report_date' | 'spend_total';
|
|
18
|
-
/** Allowed `sortBy` values for engagement list requests. */
|
|
19
|
-
type EngagementSortBy = 'report_date' | 'streams' | 'listeners';
|
|
20
31
|
/** Sort direction for list endpoints. */
|
|
21
32
|
type SortOrder = 'asc' | 'desc';
|
|
33
|
+
/** Growth strategy for campaign create / catalog. */
|
|
34
|
+
type StrategyType = 'maximum_growth' | 'market_discovery' | 'revenue_maximization' | 'custom';
|
|
35
|
+
/** Non-custom strategies (platform default tiering; no `tierTargeting`). */
|
|
36
|
+
type BuiltInStrategyType = Exclude<StrategyType, 'custom'>;
|
|
37
|
+
/** Strictly validated genre list from the Public API. */
|
|
38
|
+
type Genre = 'Alternative/Indie' | 'Ambient/Sleep' | 'Chill/Background' | 'Classical' | 'Country' | 'Electronic/Dance' | 'Hip-Hop/R&B' | 'Latin/Reggaeton' | 'Pop' | 'Rock' | 'Christmas';
|
|
39
|
+
/** Budget increase mode for wallet campaigns. */
|
|
40
|
+
type BudgetIncreaseMode = 'current_cycle' | 'next_renewal' | 'current_and_renewals';
|
|
41
|
+
/** Budget decrease mode for wallet campaigns. */
|
|
42
|
+
type BudgetDecreaseMode = 'current_cycle' | 'current_and_renewals';
|
|
43
|
+
/** Options for write methods that require an `Idempotency-Key` header. */
|
|
44
|
+
interface IdempotencyOptions {
|
|
45
|
+
/** Client-generated key; reused retries must send the same body. */
|
|
46
|
+
idempotencyKey: string;
|
|
47
|
+
}
|
|
22
48
|
/** Server-generated request metadata. Include `requestId` when contacting Soundlink support. */
|
|
23
49
|
interface ApiMeta {
|
|
24
50
|
/** UUID for this API request. */
|
|
@@ -36,6 +62,11 @@ interface ApiError {
|
|
|
36
62
|
requestId?: string;
|
|
37
63
|
/** Seconds to wait before retrying, from the `Retry-After` header on `429`. */
|
|
38
64
|
retryAfter?: number;
|
|
65
|
+
/**
|
|
66
|
+
* Error-code-specific context from the API (e.g. `available` / `required` on
|
|
67
|
+
* `insufficient_credit`). Absent when the API sends no `details`.
|
|
68
|
+
*/
|
|
69
|
+
details?: Record<string, unknown> | null;
|
|
39
70
|
}
|
|
40
71
|
/**
|
|
41
72
|
* Standard SDK response shape for every Public API method.
|
|
@@ -73,6 +104,8 @@ interface CampaignSummary {
|
|
|
73
104
|
totalBudget: number;
|
|
74
105
|
/** Campaign duration in days. */
|
|
75
106
|
campaignDuration: number;
|
|
107
|
+
/** Resource generation — writable Public API methods require `3`. */
|
|
108
|
+
generation: CampaignGeneration;
|
|
76
109
|
/** ISO 8601 creation timestamp. */
|
|
77
110
|
createdAt: string;
|
|
78
111
|
/** ISO 8601 last update timestamp. */
|
|
@@ -80,8 +113,8 @@ interface CampaignSummary {
|
|
|
80
113
|
}
|
|
81
114
|
/** Full campaign detail from {@link CampaignsResource.get}. */
|
|
82
115
|
interface CampaignDetail extends CampaignSummary {
|
|
83
|
-
/** Growth strategy (e.g. `custom`, `maximum_growth`). */
|
|
84
|
-
strategyType?:
|
|
116
|
+
/** Growth strategy set at creation (e.g. `custom`, `maximum_growth`). */
|
|
117
|
+
strategyType?: StrategyType;
|
|
85
118
|
}
|
|
86
119
|
/** Paginated campaign list payload. */
|
|
87
120
|
interface CampaignListData {
|
|
@@ -92,6 +125,121 @@ interface CampaignListData {
|
|
|
92
125
|
interface PingData {
|
|
93
126
|
status: 'ok';
|
|
94
127
|
}
|
|
128
|
+
/** One entry from `GET /v1/strategies`. */
|
|
129
|
+
interface StrategyCatalogItem {
|
|
130
|
+
strategyType: StrategyType;
|
|
131
|
+
/** When `false`, omit `tierTargeting` on create. */
|
|
132
|
+
tierTargetingAllowed: boolean;
|
|
133
|
+
}
|
|
134
|
+
/** Payload from `GET /v1/strategies`. */
|
|
135
|
+
interface StrategiesCatalogData {
|
|
136
|
+
strategies: StrategyCatalogItem[];
|
|
137
|
+
}
|
|
138
|
+
/** Shared fields for wallet campaign create. */
|
|
139
|
+
interface CreateCampaignRequestBase {
|
|
140
|
+
/** Spotify track or playlist URL. */
|
|
141
|
+
spotifyUrl: string;
|
|
142
|
+
/** USD per day (minimum 10). */
|
|
143
|
+
dailyBudget: number;
|
|
144
|
+
/** Duration in days: 7–30, or 60, or 90. */
|
|
145
|
+
durationDays: number;
|
|
146
|
+
genre: Genre;
|
|
147
|
+
/** Optional; server generates a default when omitted. */
|
|
148
|
+
campaignName?: string;
|
|
149
|
+
creativeDirection?: CreativeDirection;
|
|
150
|
+
trackOptions?: {
|
|
151
|
+
artistIdFollow?: string;
|
|
152
|
+
};
|
|
153
|
+
/** Lineage only — does not copy settings from the source campaign. */
|
|
154
|
+
clonedFromCampaignId?: string;
|
|
155
|
+
}
|
|
156
|
+
interface DoItForMeCreativeDirection {
|
|
157
|
+
type: 'do_it_for_me';
|
|
158
|
+
}
|
|
159
|
+
interface FullControlCreativeDirection {
|
|
160
|
+
type: 'full_control';
|
|
161
|
+
selectedCreatives: Array<{
|
|
162
|
+
videoId: string;
|
|
163
|
+
}>;
|
|
164
|
+
}
|
|
165
|
+
type CreativeDirection = DoItForMeCreativeDirection | FullControlCreativeDirection;
|
|
166
|
+
interface CustomTier {
|
|
167
|
+
name: string;
|
|
168
|
+
percentBudget: number;
|
|
169
|
+
countries?: string[];
|
|
170
|
+
language?: string;
|
|
171
|
+
}
|
|
172
|
+
interface TierTargeting {
|
|
173
|
+
customTierIds?: number[];
|
|
174
|
+
customTiers?: CustomTier[];
|
|
175
|
+
}
|
|
176
|
+
/** Create with a built-in strategy (no `tierTargeting`). */
|
|
177
|
+
interface CreateCampaignRequestBuiltIn extends CreateCampaignRequestBase {
|
|
178
|
+
strategyType: BuiltInStrategyType;
|
|
179
|
+
tierTargeting?: never;
|
|
180
|
+
}
|
|
181
|
+
/** Create with `custom` strategy (requires `tierTargeting`). */
|
|
182
|
+
interface CreateCampaignRequestCustom extends CreateCampaignRequestBase {
|
|
183
|
+
strategyType: 'custom';
|
|
184
|
+
tierTargeting: TierTargeting;
|
|
185
|
+
}
|
|
186
|
+
/** Body for `POST /v1/campaigns`. */
|
|
187
|
+
type CreateCampaignRequest = CreateCampaignRequestBuiltIn | CreateCampaignRequestCustom;
|
|
188
|
+
/** Success payload from campaign create. */
|
|
189
|
+
interface CampaignCreateData {
|
|
190
|
+
campaignId: string;
|
|
191
|
+
status: CampaignStatus;
|
|
192
|
+
}
|
|
193
|
+
/** Success payload from campaign stop. */
|
|
194
|
+
interface CampaignStopData {
|
|
195
|
+
campaignId: string;
|
|
196
|
+
status: CampaignStatus;
|
|
197
|
+
}
|
|
198
|
+
interface IncreaseCampaignBudgetRequest {
|
|
199
|
+
amount: number;
|
|
200
|
+
mode?: BudgetIncreaseMode;
|
|
201
|
+
targetDailyBudget?: number;
|
|
202
|
+
}
|
|
203
|
+
interface IncreaseCampaignBudgetData {
|
|
204
|
+
campaignId: string;
|
|
205
|
+
mode: BudgetIncreaseMode;
|
|
206
|
+
amount: number;
|
|
207
|
+
walletBalance: number;
|
|
208
|
+
walletNextCycleDailyBudget?: number | null;
|
|
209
|
+
}
|
|
210
|
+
interface DecreaseCampaignBudgetRequest {
|
|
211
|
+
targetDailyBudget: number;
|
|
212
|
+
mode?: BudgetDecreaseMode;
|
|
213
|
+
}
|
|
214
|
+
interface DecreaseCampaignBudgetData {
|
|
215
|
+
campaignId: string;
|
|
216
|
+
mode: BudgetDecreaseMode;
|
|
217
|
+
targetDailyBudget: number;
|
|
218
|
+
accepted: true;
|
|
219
|
+
walletNextCycleDailyBudget?: number | null;
|
|
220
|
+
}
|
|
221
|
+
interface CampaignTier {
|
|
222
|
+
tierId: number;
|
|
223
|
+
tierName: string;
|
|
224
|
+
isEnabled: boolean;
|
|
225
|
+
allocationPercent: number;
|
|
226
|
+
}
|
|
227
|
+
interface CampaignTiersData {
|
|
228
|
+
lastUpdate: string | null;
|
|
229
|
+
tiers: CampaignTier[];
|
|
230
|
+
}
|
|
231
|
+
interface TierStatusUpdateItem {
|
|
232
|
+
/**
|
|
233
|
+
* Targeting tier id — same value as `tierId` returned by
|
|
234
|
+
* `campaigns.tiers.get` (`CampaignTier.tierId`).
|
|
235
|
+
*/
|
|
236
|
+
targetingTierId: number;
|
|
237
|
+
isEnabled: boolean;
|
|
238
|
+
newAllocationPercent: number;
|
|
239
|
+
}
|
|
240
|
+
interface UpdateCampaignTiersRequest {
|
|
241
|
+
items: TierStatusUpdateItem[];
|
|
242
|
+
}
|
|
95
243
|
/** Campaign-level metric totals from {@link MetricsResource.overview}. */
|
|
96
244
|
interface MetricsOverview {
|
|
97
245
|
listeners: number;
|
|
@@ -184,12 +332,6 @@ interface BreakdownListData {
|
|
|
184
332
|
items: BreakdownRow[];
|
|
185
333
|
pagination: Pagination;
|
|
186
334
|
}
|
|
187
|
-
/** Paginated engagement list payload. */
|
|
188
|
-
interface EngagementListData {
|
|
189
|
-
schemaVersion: string;
|
|
190
|
-
items: EngagementRow[];
|
|
191
|
-
pagination: Pagination;
|
|
192
|
-
}
|
|
193
335
|
/** In-memory result from {@link ExportResource.collect}. */
|
|
194
336
|
interface ExportCollection<T> {
|
|
195
337
|
rows: T[];
|
|
@@ -203,7 +345,7 @@ interface JsonlStream<T> extends AsyncIterable<T> {
|
|
|
203
345
|
}
|
|
204
346
|
/** Options for {@link Soundlink} and {@link HttpClient}. */
|
|
205
347
|
interface SoundlinkClientOptions {
|
|
206
|
-
/** Soundlink API key (`sk_<prefix>_<secret>`). Sent as
|
|
348
|
+
/** Soundlink API key (`sk_<prefix>_<secret>`). Sent as `Authorization: Bearer`. */
|
|
207
349
|
apiKey: string;
|
|
208
350
|
/** API base URL. Defaults to `https://api.getsoundlink.com`. */
|
|
209
351
|
baseUrl?: string;
|
|
@@ -244,17 +386,6 @@ interface BreakdownListParams extends DateRangeParams {
|
|
|
244
386
|
/** Default: `asc`. */
|
|
245
387
|
sortOrder?: SortOrder;
|
|
246
388
|
}
|
|
247
|
-
/** Query params for {@link EngagementMetricsResource.list}. */
|
|
248
|
-
interface EngagementListParams extends DateRangeParams {
|
|
249
|
-
page?: number;
|
|
250
|
-
/** Default: `50`. Max: **500**. */
|
|
251
|
-
pageSize?: number;
|
|
252
|
-
/** Default: `report_date`. */
|
|
253
|
-
sortBy?: EngagementSortBy;
|
|
254
|
-
sortOrder?: SortOrder;
|
|
255
|
-
/** Filter to `catalog` or `playlist`. Omit for both. */
|
|
256
|
-
engagementContext?: EngagementContext;
|
|
257
|
-
}
|
|
258
389
|
/** Query params for engagement JSONL export. */
|
|
259
390
|
interface EngagementExportParams extends DateRangeParams {
|
|
260
391
|
engagementContext?: EngagementContext;
|
|
@@ -269,6 +400,14 @@ interface HttpGetOptions {
|
|
|
269
400
|
interface HttpJsonlOptions extends HttpGetOptions {
|
|
270
401
|
accept?: string;
|
|
271
402
|
}
|
|
403
|
+
interface HttpMutationOptions {
|
|
404
|
+
path: string;
|
|
405
|
+
body?: unknown;
|
|
406
|
+
query?: Record<string, string | number | boolean | undefined | null>;
|
|
407
|
+
headers?: Record<string, string>;
|
|
408
|
+
/** Sent as the `Idempotency-Key` header when set. */
|
|
409
|
+
idempotencyKey?: string;
|
|
410
|
+
}
|
|
272
411
|
interface ResolvedSoundlinkClientOptions {
|
|
273
412
|
apiKey: string;
|
|
274
413
|
baseUrl: string;
|
|
@@ -287,7 +426,10 @@ declare class HttpClient {
|
|
|
287
426
|
constructor(options: SoundlinkOptions);
|
|
288
427
|
get resolvedOptions(): ResolvedSoundlinkClientOptions;
|
|
289
428
|
get<T>({ path, query }: HttpGetOptions): Promise<ApiResponse<T>>;
|
|
429
|
+
post<T>({ path, body, query, headers, idempotencyKey, }: HttpMutationOptions): Promise<ApiResponse<T>>;
|
|
430
|
+
patch<T>({ path, body, query, headers, idempotencyKey, }: HttpMutationOptions): Promise<ApiResponse<T>>;
|
|
290
431
|
getJsonl<T>({ path, query, accept, }: HttpJsonlOptions): Promise<ApiResponse<JsonlStream<T>>>;
|
|
432
|
+
private mutateJson;
|
|
291
433
|
private buildHeaders;
|
|
292
434
|
private requestJson;
|
|
293
435
|
private parseErrorEnvelope;
|
|
@@ -344,14 +486,52 @@ declare class PingResource {
|
|
|
344
486
|
*/
|
|
345
487
|
ping(): Promise<ApiResponse<PingData>>;
|
|
346
488
|
}
|
|
347
|
-
/**
|
|
489
|
+
/** Strategy catalog (`GET /v1/strategies`). Requires `campaigns:read`. */
|
|
490
|
+
declare class StrategiesResource {
|
|
491
|
+
private readonly http;
|
|
492
|
+
constructor(http: HttpClient);
|
|
493
|
+
/**
|
|
494
|
+
* List growth strategies available for wallet campaign create.
|
|
495
|
+
*
|
|
496
|
+
* Maps to `GET /v1/strategies`.
|
|
497
|
+
*
|
|
498
|
+
* @example
|
|
499
|
+
* ```ts
|
|
500
|
+
* const { data } = await soundlink.strategies.list();
|
|
501
|
+
* ```
|
|
502
|
+
*/
|
|
503
|
+
list(): Promise<ApiResponse<StrategiesCatalogData>>;
|
|
504
|
+
}
|
|
505
|
+
/** Campaign tiers (`/v1/campaigns/{id}/tiers`). Wallet only (`generation: 3`). */
|
|
506
|
+
declare class CampaignTiersResource {
|
|
507
|
+
private readonly http;
|
|
508
|
+
constructor(http: HttpClient);
|
|
509
|
+
/**
|
|
510
|
+
* Get current tier allocation for a wallet campaign.
|
|
511
|
+
*
|
|
512
|
+
* Maps to `GET /v1/campaigns/{campaignId}/tiers`. Wallet campaigns only (`generation: 3`).
|
|
513
|
+
*/
|
|
514
|
+
get(campaignId: string): Promise<ApiResponse<CampaignTiersData>>;
|
|
515
|
+
/**
|
|
516
|
+
* Update tier enablement and budget shares.
|
|
517
|
+
*
|
|
518
|
+
* Maps to `PATCH /v1/campaigns/{campaignId}/tiers`. Requires `campaigns:write`.
|
|
519
|
+
* Allocation percents across items must sum to 100.
|
|
520
|
+
* Use each tier's `tierId` from {@link CampaignTiersResource.get} as `targetingTierId`.
|
|
521
|
+
* Does not require an `Idempotency-Key` (unlike create / stop / budget).
|
|
522
|
+
*/
|
|
523
|
+
update(campaignId: string, body: UpdateCampaignTiersRequest): Promise<ApiResponse<CampaignTiersData>>;
|
|
524
|
+
}
|
|
525
|
+
/** Campaign listing, detail, and wallet write surface (`/v1/campaigns/*`). */
|
|
348
526
|
declare class CampaignsResource {
|
|
349
527
|
private readonly http;
|
|
528
|
+
/** Tier allocation for wallet campaigns (`generation: 3`). */
|
|
529
|
+
readonly tiers: CampaignTiersResource;
|
|
350
530
|
constructor(http: HttpClient);
|
|
351
531
|
/**
|
|
352
532
|
* List campaigns for the authenticated organization.
|
|
353
533
|
*
|
|
354
|
-
* Maps to `GET /v1/campaigns`. Max `pageSize` is **100**.
|
|
534
|
+
* Maps to `GET /v1/campaigns`. Max `pageSize` is **100**. Requires `campaigns:read`.
|
|
355
535
|
*
|
|
356
536
|
* @param params - Pagination and sort options.
|
|
357
537
|
*
|
|
@@ -364,11 +544,52 @@ declare class CampaignsResource {
|
|
|
364
544
|
/**
|
|
365
545
|
* Fetch full details for a single campaign.
|
|
366
546
|
*
|
|
367
|
-
* Maps to `GET /v1/campaigns/{campaignId}`.
|
|
547
|
+
* Maps to `GET /v1/campaigns/{campaignId}`. Requires `campaigns:read`.
|
|
368
548
|
*
|
|
369
549
|
* @param campaignId - Campaign identifier returned by {@link CampaignsResource.list}.
|
|
370
550
|
*/
|
|
371
551
|
get(campaignId: string): Promise<ApiResponse<CampaignDetail>>;
|
|
552
|
+
/**
|
|
553
|
+
* Create a wallet-funded campaign.
|
|
554
|
+
*
|
|
555
|
+
* Maps to `POST /v1/campaigns`. Requires `campaigns:write` and `Idempotency-Key`.
|
|
556
|
+
*
|
|
557
|
+
* @example
|
|
558
|
+
* ```ts
|
|
559
|
+
* const { data, error } = await soundlink.campaigns.create(
|
|
560
|
+
* {
|
|
561
|
+
* spotifyUrl: 'https://open.spotify.com/track/...',
|
|
562
|
+
* dailyBudget: 20,
|
|
563
|
+
* durationDays: 7,
|
|
564
|
+
* genre: 'Pop',
|
|
565
|
+
* strategyType: 'maximum_growth',
|
|
566
|
+
* },
|
|
567
|
+
* { idempotencyKey: 'create-mytrack-01' },
|
|
568
|
+
* );
|
|
569
|
+
* ```
|
|
570
|
+
*/
|
|
571
|
+
create(body: CreateCampaignRequest, options: IdempotencyOptions): Promise<ApiResponse<CampaignCreateData>>;
|
|
572
|
+
/**
|
|
573
|
+
* Stop a wallet campaign and refund unspent budget.
|
|
574
|
+
*
|
|
575
|
+
* Maps to `POST /v1/campaigns/{campaignId}/stop`. Requires `campaigns:write`
|
|
576
|
+
* and `Idempotency-Key`. Wallet campaigns only (`generation: 3`).
|
|
577
|
+
*/
|
|
578
|
+
stop(campaignId: string, options: IdempotencyOptions): Promise<ApiResponse<CampaignStopData>>;
|
|
579
|
+
/**
|
|
580
|
+
* Increase wallet campaign budget.
|
|
581
|
+
*
|
|
582
|
+
* Maps to `POST /v1/campaigns/{campaignId}/budget/increase`.
|
|
583
|
+
* Requires `campaigns:write` and `Idempotency-Key`. Wallet only (`generation: 3`).
|
|
584
|
+
*/
|
|
585
|
+
increaseBudget(campaignId: string, body: IncreaseCampaignBudgetRequest, options: IdempotencyOptions): Promise<ApiResponse<IncreaseCampaignBudgetData>>;
|
|
586
|
+
/**
|
|
587
|
+
* Decrease wallet campaign daily budget.
|
|
588
|
+
*
|
|
589
|
+
* Maps to `POST /v1/campaigns/{campaignId}/budget/decrease`.
|
|
590
|
+
* Requires `campaigns:write` and `Idempotency-Key`. Wallet only (`generation: 3`).
|
|
591
|
+
*/
|
|
592
|
+
decreaseBudget(campaignId: string, body: DecreaseCampaignBudgetRequest, options: IdempotencyOptions): Promise<ApiResponse<DecreaseCampaignBudgetData>>;
|
|
372
593
|
/**
|
|
373
594
|
* Async iterator over every campaign across all pages.
|
|
374
595
|
*
|
|
@@ -399,7 +620,7 @@ declare class MetricsResource {
|
|
|
399
620
|
private readonly http;
|
|
400
621
|
/** Per-day country breakdown and JSONL export. */
|
|
401
622
|
readonly breakdown: BreakdownMetricsResource;
|
|
402
|
-
/** Per-track engagement
|
|
623
|
+
/** Per-track engagement JSONL export. */
|
|
403
624
|
readonly engagement: EngagementMetricsResource;
|
|
404
625
|
constructor(http: HttpClient);
|
|
405
626
|
/**
|
|
@@ -449,7 +670,7 @@ declare class BreakdownMetricsResource {
|
|
|
449
670
|
/**
|
|
450
671
|
* Per-track engagement metrics (`campaign_engagement_daily` schema).
|
|
451
672
|
*
|
|
452
|
-
* Access via `soundlink.metrics.engagement`.
|
|
673
|
+
* Access via `soundlink.metrics.engagement`. Only JSONL export is shipped.
|
|
453
674
|
*/
|
|
454
675
|
declare class EngagementMetricsResource {
|
|
455
676
|
private readonly http;
|
|
@@ -460,16 +681,6 @@ declare class EngagementMetricsResource {
|
|
|
460
681
|
*/
|
|
461
682
|
readonly export: ExportResource<EngagementRow, EngagementExportParams>;
|
|
462
683
|
constructor(http: HttpClient);
|
|
463
|
-
/**
|
|
464
|
-
* Paginated per-day, per-track engagement rows.
|
|
465
|
-
*
|
|
466
|
-
* Maps to `GET /v1/campaigns/{campaignId}/metrics/engagement`.
|
|
467
|
-
* Max `pageSize` is **500** (default 50).
|
|
468
|
-
*
|
|
469
|
-
* @param campaignId - Campaign identifier.
|
|
470
|
-
* @param params - Date range, pagination, sort, and optional `engagementContext` filter.
|
|
471
|
-
*/
|
|
472
|
-
list(campaignId: string, params?: EngagementListParams): Promise<ApiResponse<EngagementListData>>;
|
|
473
684
|
}
|
|
474
685
|
|
|
475
686
|
/**
|
|
@@ -497,7 +708,9 @@ declare class EngagementMetricsResource {
|
|
|
497
708
|
declare class Soundlink {
|
|
498
709
|
/** Verify connectivity and authentication. Maps to `GET /v1/ping`. */
|
|
499
710
|
readonly ping: PingResource['ping'];
|
|
500
|
-
/**
|
|
711
|
+
/** Growth strategy catalog. Requires `campaigns:read` scope. */
|
|
712
|
+
readonly strategies: StrategiesResource;
|
|
713
|
+
/** List, fetch, and manage campaigns. Read needs `campaigns:read`; writes need `campaigns:write`. */
|
|
501
714
|
readonly campaigns: CampaignsResource;
|
|
502
715
|
/** Campaign metrics, breakdowns, and JSONL exports. Requires `metrics:read` scope. */
|
|
503
716
|
readonly metrics: MetricsResource;
|
|
@@ -533,4 +746,4 @@ declare const API_KEY_PREFIX = "sk_";
|
|
|
533
746
|
declare const CAMPAIGNS_MAX_PAGE_SIZE = 100;
|
|
534
747
|
declare const METRICS_MAX_PAGE_SIZE = 500;
|
|
535
748
|
|
|
536
|
-
export { API_KEY_PREFIX, type ApiError, type ApiMeta, type ApiResponse, type BreakdownExportParams, type BreakdownListData, type BreakdownListParams, type BreakdownRow, CAMPAIGNS_MAX_PAGE_SIZE, type CampaignDetail, type CampaignListData, type CampaignListParams, type CampaignSortBy, type CampaignStatus, type CampaignSummary, DEFAULT_BASE_URL, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT_MS, type DateRangeParams, type
|
|
749
|
+
export { API_KEY_PREFIX, type ApiError, type ApiMeta, type ApiResponse, type BreakdownExportParams, type BreakdownListData, type BreakdownListParams, type BreakdownRow, type BudgetDecreaseMode, type BudgetIncreaseMode, type BuiltInStrategyType, CAMPAIGNS_MAX_PAGE_SIZE, type CampaignCreateData, type CampaignDetail, type CampaignGeneration, type CampaignListData, type CampaignListParams, type CampaignSortBy, type CampaignStatus, type CampaignStopData, type CampaignSummary, type CampaignTier, type CampaignTiersData, type CreateCampaignRequest, type CreateCampaignRequestBase, type CreateCampaignRequestBuiltIn, type CreateCampaignRequestCustom, type CreativeDirection, type CustomTier, DEFAULT_BASE_URL, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT_MS, type DateRangeParams, type DecreaseCampaignBudgetData, type DecreaseCampaignBudgetRequest, type DoItForMeCreativeDirection, type EngagementContext, type EngagementExportParams, type EngagementRow, type ExportCollection, type ExportResource, type FullControlCreativeDirection, type Genre, HttpClient, type IdempotencyOptions, type IncreaseCampaignBudgetData, type IncreaseCampaignBudgetRequest, type JsonlStream, METRICS_MAX_PAGE_SIZE, type MetricsOverview, type Pagination, type PingData, type PublicApiErrorCode, type SocialPlatform, type SortOrder, Soundlink, type SoundlinkClientOptions, SoundlinkConfigError, type SoundlinkOptions, SoundlinkParseError, SoundlinkSdkError, type StrategiesCatalogData, type StrategyCatalogItem, type StrategyType, type TierStatusUpdateItem, type TierTargeting, type UpdateCampaignTiersRequest, getStreamRowCount, resolveClientOptions };
|