soundlink 2.4.0 → 2.6.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 +14 -0
- package/README.md +22 -0
- package/dist/cjs/index.cjs +93 -0
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/index.d.ts +179 -3
- package/dist/esm/index.js +93 -0
- package/dist/esm/index.js.map +1 -1
- package/openapi/soundlink-public-api-v1.yaml +1350 -81
- package/package.json +1 -1
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
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' | '
|
|
2
|
+
type PublicApiErrorCode = 'invalid_api_key' | 'invalid_token' | 'api_key_revoked' | 'api_key_expired' | 'access_denied' | 'insufficient_scope' | 'not_found' | 'not_in_listening_graph' | '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' | 'learning_edit_ack_required' | 'wallet_not_enabled' | 'premium_plan_required' | 'youtube_music_not_enabled' | 'attribution_not_enabled' | 'soundlink_plan_required' | 'custom_pixel_not_enabled' | 'meta_pixel_conflict' | 'insufficient_credit' | 'idempotency_key_conflict' | 'rate_limit_exceeded' | 'invalid_video_url' | 'video_import_limit_exceeded' | 'video_import_session_not_found' | 'internal_error';
|
|
3
3
|
/** Campaign lifecycle status returned by the Public API. */
|
|
4
4
|
type CampaignStatus = 'creating' | 'active' | 'inactive' | 'ended' | 'renewing' | 'restarting' | 'restart_failed' | 'renew_awaiting_charge' | 'renew_failed' | 'stopped';
|
|
5
5
|
/** Ad platform used by the campaign. */
|
|
@@ -128,6 +128,8 @@ interface CampaignSummary {
|
|
|
128
128
|
/** ISO 8601 last update timestamp. */
|
|
129
129
|
updatedAt: string;
|
|
130
130
|
}
|
|
131
|
+
/** Meta ad set learning status on a campaign tier. */
|
|
132
|
+
type TierLearningStatus = 'LEARNING' | 'FAIL' | 'SUCCESS';
|
|
131
133
|
/** Full campaign detail from {@link CampaignsResource.get}. */
|
|
132
134
|
interface CampaignDetail extends CampaignSummary {
|
|
133
135
|
/** Growth strategy set at creation (e.g. `custom`, `maximum_growth`). */
|
|
@@ -137,6 +139,12 @@ interface CampaignDetail extends CampaignSummary {
|
|
|
137
139
|
* `false` when auto-renew is off or the campaign has no stored value.
|
|
138
140
|
*/
|
|
139
141
|
autoRenew: boolean;
|
|
142
|
+
/**
|
|
143
|
+
* When the current wallet cycle ends and the campaign renews.
|
|
144
|
+
* `null` unless the campaign is wallet-funded, auto-renew is on,
|
|
145
|
+
* and a cycle end is stored.
|
|
146
|
+
*/
|
|
147
|
+
nextRenewalAt: string | null;
|
|
140
148
|
}
|
|
141
149
|
/** Paginated campaign list payload. */
|
|
142
150
|
interface CampaignListData {
|
|
@@ -235,11 +243,37 @@ interface WalletData {
|
|
|
235
243
|
/** ISO 8601. `null` when the organization has no credits row. */
|
|
236
244
|
updatedAt: string | null;
|
|
237
245
|
}
|
|
246
|
+
/** Ad platform for an organization pixel. Only `meta` is supported today. */
|
|
247
|
+
type PixelPlatform = 'meta';
|
|
248
|
+
/** One pixel from {@link PixelsResource.list} / {@link PixelsResource.update}. */
|
|
249
|
+
interface Pixel {
|
|
250
|
+
id: string;
|
|
251
|
+
platform: PixelPlatform;
|
|
252
|
+
}
|
|
253
|
+
/** Payload from `GET /v1/pixels`. */
|
|
254
|
+
interface PixelListData {
|
|
255
|
+
pixels: Pixel[];
|
|
256
|
+
}
|
|
257
|
+
/** Body for `PUT /v1/pixels/{pixelId}`. */
|
|
258
|
+
interface UpdatePixelRequest {
|
|
259
|
+
platform: PixelPlatform;
|
|
260
|
+
/** Conversions API access token. Stored and never returned. */
|
|
261
|
+
accessToken: string;
|
|
262
|
+
}
|
|
263
|
+
/** Payload from `POST /v1/pixels/{pixelId}/test-events`. */
|
|
264
|
+
interface PixelTestEventData {
|
|
265
|
+
status: 'sent';
|
|
266
|
+
pixelId: string;
|
|
267
|
+
}
|
|
238
268
|
/** One variant under a creative group (`GET .../metrics/creatives`). */
|
|
239
269
|
interface CreativeMetricsChild {
|
|
240
270
|
caption: string | null;
|
|
241
271
|
language: string | null;
|
|
242
272
|
spotify_track_id: string;
|
|
273
|
+
/** Audio cut start in ms. `null` when the cut is not a ready sound. */
|
|
274
|
+
timestamp_start_ms: number | null;
|
|
275
|
+
/** Audio cut end in ms. `null` when the cut is not a ready sound. */
|
|
276
|
+
timestamp_end_ms: number | null;
|
|
243
277
|
listeners: number | null;
|
|
244
278
|
followers: number | null;
|
|
245
279
|
link_clicks: number | null;
|
|
@@ -264,6 +298,54 @@ interface CreativeMetricsGroup {
|
|
|
264
298
|
interface CreativeMetrics {
|
|
265
299
|
creatives: CreativeMetricsGroup[];
|
|
266
300
|
}
|
|
301
|
+
/** One event from `GET /v1/campaigns/{campaignId}/activity`. */
|
|
302
|
+
interface CampaignActivityItem {
|
|
303
|
+
event_type: string;
|
|
304
|
+
/** ISO 8601 timestamp. */
|
|
305
|
+
timestamp: string;
|
|
306
|
+
summary: string;
|
|
307
|
+
}
|
|
308
|
+
/** Page from `campaigns.activity`. */
|
|
309
|
+
interface CampaignActivityData {
|
|
310
|
+
items: CampaignActivityItem[];
|
|
311
|
+
pagination: Pagination;
|
|
312
|
+
}
|
|
313
|
+
/** Query for {@link CampaignsResource.activity}. */
|
|
314
|
+
interface CampaignActivityParams {
|
|
315
|
+
/**
|
|
316
|
+
* Events at or after this moment. `YYYY-MM-DD` starts at 00:00:00Z.
|
|
317
|
+
* An ISO-8601 timestamp uses that instant. Omit for the full history.
|
|
318
|
+
*/
|
|
319
|
+
startDate?: string;
|
|
320
|
+
/** Page number (1-indexed). Default: `1`. */
|
|
321
|
+
page?: number;
|
|
322
|
+
/** Items per page. Default: `20`. Max: **100**. */
|
|
323
|
+
pageSize?: number;
|
|
324
|
+
}
|
|
325
|
+
/** One row from `GET .../metrics/creative-daily`. */
|
|
326
|
+
interface CreativeDailyRow {
|
|
327
|
+
/** UTC calendar date (`YYYY-MM-DD`). */
|
|
328
|
+
date: string;
|
|
329
|
+
meta_ad_creative_id: string;
|
|
330
|
+
/** Meta media spend. Fees are not included. */
|
|
331
|
+
spend_media: number;
|
|
332
|
+
impressions: number;
|
|
333
|
+
followers: number;
|
|
334
|
+
/** `spend_media / followers` for this row. `null` when followers is zero. */
|
|
335
|
+
cpf: number | null;
|
|
336
|
+
}
|
|
337
|
+
/** Page from `metrics.creativeDaily`. */
|
|
338
|
+
interface CreativeDailyData {
|
|
339
|
+
items: CreativeDailyRow[];
|
|
340
|
+
pagination: Pagination;
|
|
341
|
+
}
|
|
342
|
+
/** Query for {@link MetricsResource.creativeDaily}. */
|
|
343
|
+
interface CreativeDailyParams extends DateRangeParams {
|
|
344
|
+
/** Page number (1-indexed). Default: `1`. */
|
|
345
|
+
page?: number;
|
|
346
|
+
/** Rows per page. Default: `50`. Max: **500**. */
|
|
347
|
+
pageSize?: number;
|
|
348
|
+
}
|
|
267
349
|
/** Success payload from campaign stop. */
|
|
268
350
|
interface CampaignStopData {
|
|
269
351
|
campaignId: string;
|
|
@@ -297,6 +379,8 @@ interface CampaignTier {
|
|
|
297
379
|
tierName: string;
|
|
298
380
|
isEnabled: boolean;
|
|
299
381
|
allocationPercent: number;
|
|
382
|
+
/** Meta learning status for this tier. `null` when not yet reported. */
|
|
383
|
+
learningStatus: TierLearningStatus | null;
|
|
300
384
|
}
|
|
301
385
|
interface CampaignTiersData {
|
|
302
386
|
lastUpdate: string | null;
|
|
@@ -313,10 +397,21 @@ interface TierStatusUpdateItem {
|
|
|
313
397
|
}
|
|
314
398
|
interface UpdateCampaignTiersRequest {
|
|
315
399
|
items: TierStatusUpdateItem[];
|
|
400
|
+
/**
|
|
401
|
+
* Set to `true` to continue a tier edit while ad sets are still learning.
|
|
402
|
+
* Omit or `false` to leave the warning unacknowledged.
|
|
403
|
+
*/
|
|
404
|
+
acknowledgeLearningWarning?: boolean;
|
|
316
405
|
}
|
|
317
406
|
/** Campaign-level metric totals from {@link MetricsResource.overview}. */
|
|
318
407
|
interface MetricsOverview {
|
|
408
|
+
/** Attributed new listeners (CPL denominator). */
|
|
319
409
|
listeners: number;
|
|
410
|
+
/**
|
|
411
|
+
* Distinct new + returning listeners in the selected window.
|
|
412
|
+
* Denominator for {@link MetricsOverview.streams_per_listener}.
|
|
413
|
+
*/
|
|
414
|
+
total_listeners: number;
|
|
320
415
|
streams: number;
|
|
321
416
|
followers: number;
|
|
322
417
|
impressions: number | null;
|
|
@@ -333,9 +428,10 @@ interface MetricsOverview {
|
|
|
333
428
|
cpl: number;
|
|
334
429
|
/** Cost per follower. */
|
|
335
430
|
cpf: number;
|
|
431
|
+
/** Streams / `total_listeners`. Zero when `total_listeners` is 0. */
|
|
336
432
|
streams_per_listener: number;
|
|
337
433
|
}
|
|
338
|
-
/** One row of the `campaign_country_daily` v1.
|
|
434
|
+
/** One row of the `campaign_country_daily` v1.1 schema. */
|
|
339
435
|
interface BreakdownRow {
|
|
340
436
|
provider: 'soundlink';
|
|
341
437
|
account_id: string;
|
|
@@ -355,7 +451,13 @@ interface BreakdownRow {
|
|
|
355
451
|
ad_clicks: number | null;
|
|
356
452
|
link_clicks: number | null;
|
|
357
453
|
streams: number;
|
|
454
|
+
/** Attributed new listeners. */
|
|
358
455
|
listeners: number;
|
|
456
|
+
/** Alias of `listeners`. */
|
|
457
|
+
new_listeners: number;
|
|
458
|
+
returning_listeners: number;
|
|
459
|
+
/** `new_listeners` + `returning_listeners`. Do not sum across days. */
|
|
460
|
+
total_listeners: number;
|
|
359
461
|
followers: number;
|
|
360
462
|
streams_per_listener: number;
|
|
361
463
|
spend_media: number;
|
|
@@ -484,6 +586,11 @@ interface SoundlinkDetail extends SoundlinkSummary {
|
|
|
484
586
|
appleMusicUrl: string | null;
|
|
485
587
|
/** Stored YouTube Music URL, or `null` when unset. */
|
|
486
588
|
youtubeMusicUrl: string | null;
|
|
589
|
+
/**
|
|
590
|
+
* When `false`, the landing page skips Spotify login and only tracks the
|
|
591
|
+
* landing-page click.
|
|
592
|
+
*/
|
|
593
|
+
attributionEnabled: boolean;
|
|
487
594
|
}
|
|
488
595
|
/** Body for `POST /v1/soundlinks`. */
|
|
489
596
|
interface CreateSoundlinkRequest {
|
|
@@ -510,6 +617,11 @@ interface CreateSoundlinkRequest {
|
|
|
510
617
|
* playlist returns `400 invalid_request`.
|
|
511
618
|
*/
|
|
512
619
|
youtubeMusicUrl?: string;
|
|
620
|
+
/**
|
|
621
|
+
* When `false`, the landing page skips Spotify login and only tracks the
|
|
622
|
+
* landing-page click. Defaults to `true`. Cannot combine with `autoFollow: true`.
|
|
623
|
+
*/
|
|
624
|
+
attributionEnabled?: boolean;
|
|
513
625
|
}
|
|
514
626
|
/** Paginated soundlink list payload. */
|
|
515
627
|
interface SoundlinkListData {
|
|
@@ -768,6 +880,53 @@ declare class StrategiesResource {
|
|
|
768
880
|
*/
|
|
769
881
|
list(): Promise<ApiResponse<StrategiesCatalogData>>;
|
|
770
882
|
}
|
|
883
|
+
/**
|
|
884
|
+
* Organization Meta pixels (`/v1/pixels`).
|
|
885
|
+
* Read needs `pixels:read`; write and test-events need `pixels:write`.
|
|
886
|
+
*/
|
|
887
|
+
declare class PixelsResource {
|
|
888
|
+
private readonly http;
|
|
889
|
+
constructor(http: HttpClient);
|
|
890
|
+
/**
|
|
891
|
+
* List Meta pixels saved for the organization.
|
|
892
|
+
*
|
|
893
|
+
* Maps to `GET /v1/pixels`. Requires `pixels:read`.
|
|
894
|
+
* Returns `403 custom_pixel_not_enabled` when the feature is off.
|
|
895
|
+
*
|
|
896
|
+
* @example
|
|
897
|
+
* ```ts
|
|
898
|
+
* const { data } = await soundlink.pixels.list();
|
|
899
|
+
* ```
|
|
900
|
+
*/
|
|
901
|
+
list(): Promise<ApiResponse<PixelListData>>;
|
|
902
|
+
/**
|
|
903
|
+
* Save or rotate a Meta pixel access token.
|
|
904
|
+
*
|
|
905
|
+
* Maps to `PUT /v1/pixels/{pixelId}`. Requires `pixels:write`.
|
|
906
|
+
* Does not require an `Idempotency-Key`. The access token is never returned.
|
|
907
|
+
*
|
|
908
|
+
* @example
|
|
909
|
+
* ```ts
|
|
910
|
+
* const { data } = await soundlink.pixels.update('1234567890123456', {
|
|
911
|
+
* platform: 'meta',
|
|
912
|
+
* accessToken: process.env.META_CAPI_TOKEN!,
|
|
913
|
+
* });
|
|
914
|
+
* ```
|
|
915
|
+
*/
|
|
916
|
+
update(pixelId: string, body: UpdatePixelRequest): Promise<ApiResponse<Pixel>>;
|
|
917
|
+
/**
|
|
918
|
+
* Send a live Meta Conversions API test event to a saved pixel.
|
|
919
|
+
*
|
|
920
|
+
* Maps to `POST /v1/pixels/{pixelId}/test-events`. Requires `pixels:write`.
|
|
921
|
+
* This is not a sandbox event — it appears in Events Manager.
|
|
922
|
+
*
|
|
923
|
+
* @example
|
|
924
|
+
* ```ts
|
|
925
|
+
* const { data } = await soundlink.pixels.sendTestEvent('1234567890123456');
|
|
926
|
+
* ```
|
|
927
|
+
*/
|
|
928
|
+
sendTestEvent(pixelId: string): Promise<ApiResponse<PixelTestEventData>>;
|
|
929
|
+
}
|
|
771
930
|
/** Campaign tiers (`/v1/campaigns/{id}/tiers`). Wallet only (`generation: 3`). */
|
|
772
931
|
declare class CampaignTiersResource {
|
|
773
932
|
private readonly http;
|
|
@@ -815,6 +974,13 @@ declare class CampaignsResource {
|
|
|
815
974
|
* @param campaignId - Campaign identifier returned by {@link CampaignsResource.list}.
|
|
816
975
|
*/
|
|
817
976
|
get(campaignId: string): Promise<ApiResponse<CampaignDetail>>;
|
|
977
|
+
/**
|
|
978
|
+
* Page of creative adds, budget changes, and other campaign events.
|
|
979
|
+
*
|
|
980
|
+
* Maps to `GET /v1/campaigns/{campaignId}/activity`. Requires `campaigns:read`.
|
|
981
|
+
* Omit `startDate` for the full history. Max `pageSize` is **100**.
|
|
982
|
+
*/
|
|
983
|
+
activity(campaignId: string, params?: CampaignActivityParams): Promise<ApiResponse<CampaignActivityData>>;
|
|
818
984
|
/**
|
|
819
985
|
* Create a wallet-funded campaign.
|
|
820
986
|
*
|
|
@@ -1053,6 +1219,14 @@ declare class MetricsResource {
|
|
|
1053
1219
|
* Snapshot only — do not send a date range.
|
|
1054
1220
|
*/
|
|
1055
1221
|
creatives(campaignId: string): Promise<ApiResponse<CreativeMetrics>>;
|
|
1222
|
+
/**
|
|
1223
|
+
* One row per day and Meta ad creative.
|
|
1224
|
+
*
|
|
1225
|
+
* Maps to `GET /v1/campaigns/{campaignId}/metrics/creative-daily`.
|
|
1226
|
+
* Requires `metrics:read`. Omit both dates for every day that has rows.
|
|
1227
|
+
* Max `pageSize` is **500**.
|
|
1228
|
+
*/
|
|
1229
|
+
creativeDaily(campaignId: string, params?: CreativeDailyParams): Promise<ApiResponse<CreativeDailyData>>;
|
|
1056
1230
|
}
|
|
1057
1231
|
/**
|
|
1058
1232
|
* Country-level daily metrics (`campaign_country_daily` schema).
|
|
@@ -1124,6 +1298,8 @@ declare class Soundlink {
|
|
|
1124
1298
|
readonly wallet: WalletResource;
|
|
1125
1299
|
/** Growth strategy catalog. Requires `campaigns:read` scope. */
|
|
1126
1300
|
readonly strategies: StrategiesResource;
|
|
1301
|
+
/** Organization Meta pixels. Read needs `pixels:read`; write needs `pixels:write`. */
|
|
1302
|
+
readonly pixels: PixelsResource;
|
|
1127
1303
|
/** List, fetch, and manage campaigns. Read needs `campaigns:read`; writes need `campaigns:write`. */
|
|
1128
1304
|
readonly campaigns: CampaignsResource;
|
|
1129
1305
|
/** Self-serve soundlinks. Read needs `soundlinks:read`; create/delete need `soundlinks:write`. */
|
|
@@ -1163,4 +1339,4 @@ declare const CAMPAIGNS_MAX_PAGE_SIZE = 100;
|
|
|
1163
1339
|
declare const SOUNDLINKS_MAX_PAGE_SIZE = 100;
|
|
1164
1340
|
declare const METRICS_MAX_PAGE_SIZE = 500;
|
|
1165
1341
|
|
|
1166
|
-
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 CampaignAutoRenewData, 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 CreateSoundlinkRequest, type CreativeDirection, type CreativeMetrics, type CreativeMetricsChild, type CreativeMetricsGroup, 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, SOUNDLINKS_MAX_PAGE_SIZE, type SocialPlatform, type SortOrder, Soundlink, type SoundlinkBreakdownListData, type SoundlinkBreakdownListParams, type SoundlinkBreakdownRow, type SoundlinkBreakdownSortBy, type SoundlinkClientOptions, SoundlinkConfigError, type SoundlinkDetail, type SoundlinkEngagementListData, type SoundlinkEngagementListParams, type SoundlinkEngagementRow, type SoundlinkEngagementSortBy, type SoundlinkListData, type SoundlinkListParams, type SoundlinkMetricsOverview, type SoundlinkOptions, SoundlinkParseError, SoundlinkSdkError, type SoundlinkSortBy, type SoundlinkStatus, type SoundlinkSummary, type SoundlinkTargetType, type StrategiesCatalogData, type StrategyCatalogItem, type StrategyType, type TierStatusUpdateItem, type TierTargeting, type UpdateCampaignAutoRenewRequest, type UpdateCampaignTiersRequest, type WalletData, getStreamRowCount, resolveClientOptions };
|
|
1342
|
+
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 CampaignActivityData, type CampaignActivityItem, type CampaignActivityParams, type CampaignAutoRenewData, 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 CreateSoundlinkRequest, type CreativeDailyData, type CreativeDailyParams, type CreativeDailyRow, type CreativeDirection, type CreativeMetrics, type CreativeMetricsChild, type CreativeMetricsGroup, 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 Pixel, type PixelListData, type PixelPlatform, type PixelTestEventData, type PublicApiErrorCode, SOUNDLINKS_MAX_PAGE_SIZE, type SocialPlatform, type SortOrder, Soundlink, type SoundlinkBreakdownListData, type SoundlinkBreakdownListParams, type SoundlinkBreakdownRow, type SoundlinkBreakdownSortBy, type SoundlinkClientOptions, SoundlinkConfigError, type SoundlinkDetail, type SoundlinkEngagementListData, type SoundlinkEngagementListParams, type SoundlinkEngagementRow, type SoundlinkEngagementSortBy, type SoundlinkListData, type SoundlinkListParams, type SoundlinkMetricsOverview, type SoundlinkOptions, SoundlinkParseError, SoundlinkSdkError, type SoundlinkSortBy, type SoundlinkStatus, type SoundlinkSummary, type SoundlinkTargetType, type StrategiesCatalogData, type StrategyCatalogItem, type StrategyType, type TierLearningStatus, type TierStatusUpdateItem, type TierTargeting, type UpdateCampaignAutoRenewRequest, type UpdateCampaignTiersRequest, type UpdatePixelRequest, type WalletData, getStreamRowCount, resolveClientOptions };
|
package/dist/esm/index.js
CHANGED
|
@@ -509,6 +509,62 @@ var StrategiesResource = class {
|
|
|
509
509
|
return this.http.get({ path: "/strategies" });
|
|
510
510
|
}
|
|
511
511
|
};
|
|
512
|
+
var PixelsResource = class {
|
|
513
|
+
constructor(http) {
|
|
514
|
+
this.http = http;
|
|
515
|
+
}
|
|
516
|
+
http;
|
|
517
|
+
/**
|
|
518
|
+
* List Meta pixels saved for the organization.
|
|
519
|
+
*
|
|
520
|
+
* Maps to `GET /v1/pixels`. Requires `pixels:read`.
|
|
521
|
+
* Returns `403 custom_pixel_not_enabled` when the feature is off.
|
|
522
|
+
*
|
|
523
|
+
* @example
|
|
524
|
+
* ```ts
|
|
525
|
+
* const { data } = await soundlink.pixels.list();
|
|
526
|
+
* ```
|
|
527
|
+
*/
|
|
528
|
+
list() {
|
|
529
|
+
return this.http.get({ path: "/pixels" });
|
|
530
|
+
}
|
|
531
|
+
/**
|
|
532
|
+
* Save or rotate a Meta pixel access token.
|
|
533
|
+
*
|
|
534
|
+
* Maps to `PUT /v1/pixels/{pixelId}`. Requires `pixels:write`.
|
|
535
|
+
* Does not require an `Idempotency-Key`. The access token is never returned.
|
|
536
|
+
*
|
|
537
|
+
* @example
|
|
538
|
+
* ```ts
|
|
539
|
+
* const { data } = await soundlink.pixels.update('1234567890123456', {
|
|
540
|
+
* platform: 'meta',
|
|
541
|
+
* accessToken: process.env.META_CAPI_TOKEN!,
|
|
542
|
+
* });
|
|
543
|
+
* ```
|
|
544
|
+
*/
|
|
545
|
+
update(pixelId, body) {
|
|
546
|
+
return this.http.put({
|
|
547
|
+
path: `/pixels/${encodeURIComponent(pixelId)}`,
|
|
548
|
+
body
|
|
549
|
+
});
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* Send a live Meta Conversions API test event to a saved pixel.
|
|
553
|
+
*
|
|
554
|
+
* Maps to `POST /v1/pixels/{pixelId}/test-events`. Requires `pixels:write`.
|
|
555
|
+
* This is not a sandbox event — it appears in Events Manager.
|
|
556
|
+
*
|
|
557
|
+
* @example
|
|
558
|
+
* ```ts
|
|
559
|
+
* const { data } = await soundlink.pixels.sendTestEvent('1234567890123456');
|
|
560
|
+
* ```
|
|
561
|
+
*/
|
|
562
|
+
sendTestEvent(pixelId) {
|
|
563
|
+
return this.http.post({
|
|
564
|
+
path: `/pixels/${encodeURIComponent(pixelId)}/test-events`
|
|
565
|
+
});
|
|
566
|
+
}
|
|
567
|
+
};
|
|
512
568
|
var CampaignTiersResource = class {
|
|
513
569
|
constructor(http) {
|
|
514
570
|
this.http = http;
|
|
@@ -582,6 +638,22 @@ var CampaignsResource = class {
|
|
|
582
638
|
path: `/campaigns/${encodeURIComponent(campaignId)}`
|
|
583
639
|
});
|
|
584
640
|
}
|
|
641
|
+
/**
|
|
642
|
+
* Page of creative adds, budget changes, and other campaign events.
|
|
643
|
+
*
|
|
644
|
+
* Maps to `GET /v1/campaigns/{campaignId}/activity`. Requires `campaigns:read`.
|
|
645
|
+
* Omit `startDate` for the full history. Max `pageSize` is **100**.
|
|
646
|
+
*/
|
|
647
|
+
activity(campaignId, params = {}) {
|
|
648
|
+
return this.http.get({
|
|
649
|
+
path: `/campaigns/${encodeURIComponent(campaignId)}/activity`,
|
|
650
|
+
query: {
|
|
651
|
+
startDate: params.startDate,
|
|
652
|
+
page: params.page,
|
|
653
|
+
pageSize: params.pageSize
|
|
654
|
+
}
|
|
655
|
+
});
|
|
656
|
+
}
|
|
585
657
|
/**
|
|
586
658
|
* Create a wallet-funded campaign.
|
|
587
659
|
*
|
|
@@ -925,6 +997,24 @@ var MetricsResource = class {
|
|
|
925
997
|
path: `/campaigns/${encodeURIComponent(campaignId)}/metrics/creatives`
|
|
926
998
|
});
|
|
927
999
|
}
|
|
1000
|
+
/**
|
|
1001
|
+
* One row per day and Meta ad creative.
|
|
1002
|
+
*
|
|
1003
|
+
* Maps to `GET /v1/campaigns/{campaignId}/metrics/creative-daily`.
|
|
1004
|
+
* Requires `metrics:read`. Omit both dates for every day that has rows.
|
|
1005
|
+
* Max `pageSize` is **500**.
|
|
1006
|
+
*/
|
|
1007
|
+
creativeDaily(campaignId, params = {}) {
|
|
1008
|
+
return this.http.get({
|
|
1009
|
+
path: `/campaigns/${encodeURIComponent(campaignId)}/metrics/creative-daily`,
|
|
1010
|
+
query: {
|
|
1011
|
+
startDate: params.startDate,
|
|
1012
|
+
endDate: params.endDate,
|
|
1013
|
+
page: params.page,
|
|
1014
|
+
pageSize: params.pageSize
|
|
1015
|
+
}
|
|
1016
|
+
});
|
|
1017
|
+
}
|
|
928
1018
|
};
|
|
929
1019
|
var BreakdownMetricsResource = class {
|
|
930
1020
|
constructor(http) {
|
|
@@ -998,6 +1088,8 @@ var Soundlink = class {
|
|
|
998
1088
|
wallet;
|
|
999
1089
|
/** Growth strategy catalog. Requires `campaigns:read` scope. */
|
|
1000
1090
|
strategies;
|
|
1091
|
+
/** Organization Meta pixels. Read needs `pixels:read`; write needs `pixels:write`. */
|
|
1092
|
+
pixels;
|
|
1001
1093
|
/** List, fetch, and manage campaigns. Read needs `campaigns:read`; writes need `campaigns:write`. */
|
|
1002
1094
|
campaigns;
|
|
1003
1095
|
/** Self-serve soundlinks. Read needs `soundlinks:read`; create/delete need `soundlinks:write`. */
|
|
@@ -1015,6 +1107,7 @@ var Soundlink = class {
|
|
|
1015
1107
|
this.ping = pingResource.ping.bind(pingResource);
|
|
1016
1108
|
this.wallet = new WalletResource(http);
|
|
1017
1109
|
this.strategies = new StrategiesResource(http);
|
|
1110
|
+
this.pixels = new PixelsResource(http);
|
|
1018
1111
|
this.campaigns = new CampaignsResource(http);
|
|
1019
1112
|
this.soundlinks = new SoundlinksResource(http);
|
|
1020
1113
|
this.metrics = new MetricsResource(http);
|