@tidal-music/api 0.13.0 → 0.15.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +682 -69
  2. package/package.json +5 -5
package/dist/index.d.ts CHANGED
@@ -249,10 +249,6 @@ export declare interface components {
249
249
  * @description Available usage for this album. Deprecated: use 'usageRules' instead. This field will be removed in a future version.
250
250
  */
251
251
  availability?: ("STREAM" | "DJ" | "STEM")[];
252
- /**
253
- * @description Barcode id (EAN-13 or UPC-A)
254
- * @example 00854242007552
255
- */
256
252
  barcodeId: string;
257
253
  copyright?: components["schemas"]["Copyright"];
258
254
  /**
@@ -366,6 +362,7 @@ export declare interface components {
366
362
  priceConfig?: components["schemas"]["Single_Relationship_Data_Document"];
367
363
  providers?: components["schemas"]["Multi_Relationship_Data_Document"];
368
364
  replacement?: components["schemas"]["Single_Relationship_Data_Document"];
365
+ shares?: components["schemas"]["Multi_Relationship_Data_Document"];
369
366
  similarAlbums?: components["schemas"]["Multi_Relationship_Data_Document"];
370
367
  suggestedCoverArts?: components["schemas"]["Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"];
371
368
  usageRules?: components["schemas"]["Single_Relationship_Data_Document"];
@@ -596,7 +593,7 @@ export declare interface components {
596
593
  */
597
594
  recommendation?: "CLAIM_PROFILE" | "CLAIM_CONTENT";
598
595
  /** @description List of UPCs retrieved from the DSP */
599
- retrievedUpcs?: components["schemas"]["BarcodeId"][];
596
+ retrievedUpcs?: components["schemas"]["LegacyBarcodeId"][];
600
597
  /**
601
598
  * @description Current status of this claim
602
599
  * @enum {string}
@@ -1006,13 +1003,6 @@ export declare interface components {
1006
1003
  /** Format: float */
1007
1004
  replayGain?: number;
1008
1005
  };
1009
- /**
1010
- * @description Barcode Id
1011
- * @example 196589525444
1012
- */
1013
- BarcodeId: {
1014
- value: string;
1015
- };
1016
1006
  ClientsCreateOperation_Payload: {
1017
1007
  data: components["schemas"]["ClientsCreateOperation_Payload_Data"];
1018
1008
  };
@@ -1776,7 +1766,7 @@ export declare interface components {
1776
1766
  status: string;
1777
1767
  }[];
1778
1768
  };
1779
- Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
1769
+ Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["ProviderProductInfos_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionSaveForLaters_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
1780
1770
  InstallationsCreateOperation_Payload: {
1781
1771
  data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
1782
1772
  };
@@ -1869,6 +1859,10 @@ export declare interface components {
1869
1859
  included?: components["schemas"]["Included"];
1870
1860
  links: components["schemas"]["Links"];
1871
1861
  };
1862
+ /** @description List of UPCs retrieved from the DSP */
1863
+ LegacyBarcodeId: {
1864
+ value?: string;
1865
+ };
1872
1866
  LegacySource: {
1873
1867
  id: string;
1874
1868
  type: string;
@@ -2668,6 +2662,42 @@ export declare interface components {
2668
2662
  included?: components["schemas"]["Included"];
2669
2663
  links: components["schemas"]["Links"];
2670
2664
  };
2665
+ ProviderProductInfos_Attributes: {
2666
+ barcodeId: string;
2667
+ };
2668
+ ProviderProductInfos_Multi_Resource_Data_Document: {
2669
+ data: components["schemas"]["ProviderProductInfos_Resource_Object"][];
2670
+ included?: components["schemas"]["Included"];
2671
+ links: components["schemas"]["Links"];
2672
+ };
2673
+ ProviderProductInfos_Relationships: {
2674
+ provider?: components["schemas"]["Single_Relationship_Data_Document"];
2675
+ subject?: components["schemas"]["Single_Relationship_Data_Document"];
2676
+ };
2677
+ ProviderProductInfos_Resource_Object: {
2678
+ attributes?: components["schemas"]["ProviderProductInfos_Attributes"];
2679
+ /**
2680
+ * @description Resource id
2681
+ * @example 12345
2682
+ */
2683
+ id: string;
2684
+ relationships?: components["schemas"]["ProviderProductInfos_Relationships"];
2685
+ /**
2686
+ * @description Resource type (enum property replaced by openapi-typescript)
2687
+ * @enum {string}
2688
+ */
2689
+ type: "providerProductInfos";
2690
+ };
2691
+ ProviderProductInfos_Single_Relationship_Data_Document: {
2692
+ data?: components["schemas"]["Resource_Identifier"];
2693
+ included?: components["schemas"]["Included"];
2694
+ links: components["schemas"]["Links"];
2695
+ };
2696
+ ProviderProductInfos_Single_Resource_Data_Document: {
2697
+ data: components["schemas"]["ProviderProductInfos_Resource_Object"];
2698
+ included?: components["schemas"]["Included"];
2699
+ links: components["schemas"]["Links"];
2700
+ };
2671
2701
  Providers_Attributes: {
2672
2702
  /**
2673
2703
  * @description Provider name
@@ -4171,6 +4201,91 @@ export declare interface components {
4171
4201
  included?: components["schemas"]["Included"];
4172
4202
  links: components["schemas"]["Links"];
4173
4203
  };
4204
+ UserCollectionSaveForLatersAddMultiDataRelationship409ResponseBody: {
4205
+ errors: {
4206
+ /**
4207
+ * @example DUPLICATE_ITEMS_IN_COLLECTION
4208
+ * @enum {string}
4209
+ */
4210
+ code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
4211
+ /** @example You have reached the maximum number of items allowed for this collection. Please remove some items before adding more. */
4212
+ detail?: string;
4213
+ /** @example 409 */
4214
+ status: string;
4215
+ }[];
4216
+ };
4217
+ UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload: {
4218
+ data: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload_Data"][];
4219
+ };
4220
+ UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload_Data: {
4221
+ id: string;
4222
+ /** @enum {string} */
4223
+ type: "tracks" | "albums" | "artists" | "playlists" | "videos";
4224
+ };
4225
+ UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload: {
4226
+ data: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data"][];
4227
+ };
4228
+ UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data: {
4229
+ id: string;
4230
+ /** @enum {string} */
4231
+ type: "tracks" | "albums" | "artists" | "playlists" | "videos";
4232
+ };
4233
+ UserCollectionSaveForLaters_Attributes: Record<string, never>;
4234
+ UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document: {
4235
+ data?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier"][];
4236
+ included?: components["schemas"]["Included"];
4237
+ links: components["schemas"]["Links"];
4238
+ };
4239
+ UserCollectionSaveForLaters_Items_Resource_Identifier: {
4240
+ /**
4241
+ * @description Resource id
4242
+ * @example 12345
4243
+ */
4244
+ id: string;
4245
+ meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier_Meta"];
4246
+ /**
4247
+ * @description Resource type
4248
+ * @example tracks
4249
+ */
4250
+ type: string;
4251
+ };
4252
+ UserCollectionSaveForLaters_Items_Resource_Identifier_Meta: {
4253
+ /** Format: date-time */
4254
+ addedAt: string;
4255
+ };
4256
+ UserCollectionSaveForLaters_Multi_Relationship_Data_Document: {
4257
+ data?: components["schemas"]["Resource_Identifier"][];
4258
+ included?: components["schemas"]["Included"];
4259
+ links: components["schemas"]["Links"];
4260
+ };
4261
+ UserCollectionSaveForLaters_Multi_Resource_Data_Document: {
4262
+ data: components["schemas"]["UserCollectionSaveForLaters_Resource_Object"][];
4263
+ included?: components["schemas"]["Included"];
4264
+ links: components["schemas"]["Links"];
4265
+ };
4266
+ UserCollectionSaveForLaters_Relationships: {
4267
+ items?: components["schemas"]["UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"];
4268
+ owners?: components["schemas"]["Multi_Relationship_Data_Document"];
4269
+ };
4270
+ UserCollectionSaveForLaters_Resource_Object: {
4271
+ attributes?: components["schemas"]["UserCollectionSaveForLaters_Attributes"];
4272
+ /**
4273
+ * @description Resource id
4274
+ * @example 12345
4275
+ */
4276
+ id: string;
4277
+ relationships?: components["schemas"]["UserCollectionSaveForLaters_Relationships"];
4278
+ /**
4279
+ * @description Resource type (enum property replaced by openapi-typescript)
4280
+ * @enum {string}
4281
+ */
4282
+ type: "userCollectionSaveForLaters";
4283
+ };
4284
+ UserCollectionSaveForLaters_Single_Resource_Data_Document: {
4285
+ data: components["schemas"]["UserCollectionSaveForLaters_Resource_Object"];
4286
+ included?: components["schemas"]["Included"];
4287
+ links: components["schemas"]["Links"];
4288
+ };
4174
4289
  UserCollectionTracksAddMultiDataRelationship409ResponseBody: {
4175
4290
  errors: {
4176
4291
  /**
@@ -5116,6 +5231,15 @@ export declare interface components {
5116
5231
  };
5117
5232
  };
5118
5233
  /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
5234
+ UserCollectionSaveForLatersAddMultiDataRelationship409Response: {
5235
+ headers: {
5236
+ [name: string]: unknown;
5237
+ };
5238
+ content: {
5239
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersAddMultiDataRelationship409ResponseBody"];
5240
+ };
5241
+ };
5242
+ /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
5119
5243
  UserCollectionTracksAddMultiDataRelationship409Response: {
5120
5244
  headers: {
5121
5245
  [name: string]: unknown;
@@ -5602,7 +5726,7 @@ declare interface paths {
5602
5726
  */
5603
5727
  countryCode?: string;
5604
5728
  /**
5605
- * @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, similarAlbums, suggestedCoverArts, usageRules
5729
+ * @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules
5606
5730
  * @example albumStatistics
5607
5731
  */
5608
5732
  include?: string[];
@@ -5708,7 +5832,7 @@ declare interface paths {
5708
5832
  */
5709
5833
  countryCode?: string;
5710
5834
  /**
5711
- * @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, similarAlbums, suggestedCoverArts, usageRules
5835
+ * @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules
5712
5836
  * @example albumStatistics
5713
5837
  */
5714
5838
  include?: string[];
@@ -6494,6 +6618,69 @@ declare interface paths {
6494
6618
  patch?: never;
6495
6619
  trace?: never;
6496
6620
  };
6621
+ "/albums/{id}/relationships/shares": {
6622
+ parameters: {
6623
+ query?: never;
6624
+ header?: never;
6625
+ path?: never;
6626
+ cookie?: never;
6627
+ };
6628
+ /**
6629
+ * Get shares relationship ("to-many").
6630
+ * @description Retrieves shares relationship.
6631
+ */
6632
+ get: {
6633
+ parameters: {
6634
+ query?: {
6635
+ /**
6636
+ * @description Allows the client to customize which related resources should be returned. Available options: shares
6637
+ * @example shares
6638
+ */
6639
+ include?: string[];
6640
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6641
+ "page[cursor]"?: string;
6642
+ /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
6643
+ shareCode?: string;
6644
+ };
6645
+ header?: never;
6646
+ path: {
6647
+ /**
6648
+ * @description Album id
6649
+ * @example 251380836
6650
+ */
6651
+ id: string;
6652
+ };
6653
+ cookie?: never;
6654
+ };
6655
+ requestBody?: never;
6656
+ responses: {
6657
+ /** @description Successful response */
6658
+ 200: {
6659
+ headers: {
6660
+ [name: string]: unknown;
6661
+ };
6662
+ content: {
6663
+ "application/vnd.api+json": components["schemas"]["Albums_Multi_Relationship_Data_Document"];
6664
+ };
6665
+ };
6666
+ 400: components["responses"]["Default400Response"];
6667
+ 404: components["responses"]["Default404Response"];
6668
+ 405: components["responses"]["Default405Response"];
6669
+ 406: components["responses"]["Default406Response"];
6670
+ 415: components["responses"]["Default415Response"];
6671
+ 429: components["responses"]["Default429Response"];
6672
+ 500: components["responses"]["Default500Response"];
6673
+ 503: components["responses"]["Default503Response"];
6674
+ };
6675
+ };
6676
+ put?: never;
6677
+ post?: never;
6678
+ delete?: never;
6679
+ options?: never;
6680
+ head?: never;
6681
+ patch?: never;
6682
+ trace?: never;
6683
+ };
6497
6684
  "/albums/{id}/relationships/similarAlbums": {
6498
6685
  parameters: {
6499
6686
  query?: never;
@@ -13657,7 +13844,7 @@ declare interface paths {
13657
13844
  patch?: never;
13658
13845
  trace?: never;
13659
13846
  };
13660
- "/providers": {
13847
+ "/providerProductInfos": {
13661
13848
  parameters: {
13662
13849
  query?: never;
13663
13850
  header?: never;
@@ -13665,14 +13852,21 @@ declare interface paths {
13665
13852
  cookie?: never;
13666
13853
  };
13667
13854
  /**
13668
- * Get multiple providers.
13669
- * @description Retrieves multiple providers by available filters, or without if applicable.
13855
+ * Get multiple providerProductInfos.
13856
+ * @description Retrieves multiple providerProductInfos by available filters, or without if applicable.
13670
13857
  */
13671
13858
  get: {
13672
13859
  parameters: {
13673
13860
  query?: {
13674
- /** @description List of provider IDs (e.g. `12345`) */
13675
- "filter[id]"?: string[];
13861
+ /**
13862
+ * @description Allows the client to customize which related resources should be returned. Available options: provider, subject
13863
+ * @example provider
13864
+ */
13865
+ include?: string[];
13866
+ /** @description List of barcode IDs (EAN-13 or UPC-A) (e.g. `00602527336510`) */
13867
+ "filter[barcodeId]"?: string[];
13868
+ /** @description Content provider ID (e.g. `50`) */
13869
+ "filter[provider.id]"?: string[];
13676
13870
  };
13677
13871
  header?: never;
13678
13872
  path?: never;
@@ -13686,7 +13880,7 @@ declare interface paths {
13686
13880
  [name: string]: unknown;
13687
13881
  };
13688
13882
  content: {
13689
- "application/vnd.api+json": components["schemas"]["Providers_Multi_Resource_Data_Document"];
13883
+ "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Multi_Resource_Data_Document"];
13690
13884
  };
13691
13885
  };
13692
13886
  400: components["responses"]["Default400Response"];
@@ -13707,7 +13901,7 @@ declare interface paths {
13707
13901
  patch?: never;
13708
13902
  trace?: never;
13709
13903
  };
13710
- "/providers/{id}": {
13904
+ "/providerProductInfos/{id}/relationships/provider": {
13711
13905
  parameters: {
13712
13906
  query?: never;
13713
13907
  header?: never;
@@ -13715,18 +13909,21 @@ declare interface paths {
13715
13909
  cookie?: never;
13716
13910
  };
13717
13911
  /**
13718
- * Get single provider.
13719
- * @description Retrieves single provider by id.
13912
+ * Get provider relationship ("to-one").
13913
+ * @description Retrieves provider relationship.
13720
13914
  */
13721
13915
  get: {
13722
13916
  parameters: {
13723
- query?: never;
13724
- header?: never;
13725
- path: {
13917
+ query?: {
13726
13918
  /**
13727
- * @description Provider ID
13728
- * @example 12345
13919
+ * @description Allows the client to customize which related resources should be returned. Available options: provider
13920
+ * @example provider
13729
13921
  */
13922
+ include?: string[];
13923
+ };
13924
+ header?: never;
13925
+ path: {
13926
+ /** @description Provider product info id */
13730
13927
  id: string;
13731
13928
  };
13732
13929
  cookie?: never;
@@ -13739,7 +13936,7 @@ declare interface paths {
13739
13936
  [name: string]: unknown;
13740
13937
  };
13741
13938
  content: {
13742
- "application/vnd.api+json": components["schemas"]["Providers_Single_Resource_Data_Document"];
13939
+ "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Single_Relationship_Data_Document"];
13743
13940
  };
13744
13941
  };
13745
13942
  400: components["responses"]["Default400Response"];
@@ -13760,7 +13957,7 @@ declare interface paths {
13760
13957
  patch?: never;
13761
13958
  trace?: never;
13762
13959
  };
13763
- "/reactions": {
13960
+ "/providerProductInfos/{id}/relationships/subject": {
13764
13961
  parameters: {
13765
13962
  query?: never;
13766
13963
  header?: never;
@@ -13768,31 +13965,23 @@ declare interface paths {
13768
13965
  cookie?: never;
13769
13966
  };
13770
13967
  /**
13771
- * Get multiple reactions.
13772
- * @description Retrieves multiple reactions by available filters, or without if applicable.
13968
+ * Get subject relationship ("to-one").
13969
+ * @description Retrieves subject relationship.
13773
13970
  */
13774
13971
  get: {
13775
13972
  parameters: {
13776
13973
  query?: {
13777
- stats?: "ALL" | "COUNTS_BY_TYPE" | "TOTAL_COUNT";
13778
- statsOnly?: boolean;
13779
- viewerContext?: string;
13780
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
13781
- "page[cursor]"?: string;
13782
13974
  /**
13783
- * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners
13784
- * @example ownerProfiles
13975
+ * @description Allows the client to customize which related resources should be returned. Available options: subject
13976
+ * @example subject
13785
13977
  */
13786
13978
  include?: string[];
13787
- /** @description Filter by emoji (e.g. `👍`) */
13788
- "filter[emoji]"?: string[];
13789
- /** @description Filter by subject resource ID (e.g. `12345`) */
13790
- "filter[subject.id]"?: string[];
13791
- /** @description Filter by subject resource type (e.g. `albums`) */
13792
- "filter[subject.type]"?: ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments")[];
13793
13979
  };
13794
13980
  header?: never;
13795
- path?: never;
13981
+ path: {
13982
+ /** @description Provider product info id */
13983
+ id: string;
13984
+ };
13796
13985
  cookie?: never;
13797
13986
  };
13798
13987
  requestBody?: never;
@@ -13803,7 +13992,7 @@ declare interface paths {
13803
13992
  [name: string]: unknown;
13804
13993
  };
13805
13994
  content: {
13806
- "application/vnd.api+json": components["schemas"]["Reactions_Multi_Resource_Data_Document"];
13995
+ "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Single_Relationship_Data_Document"];
13807
13996
  };
13808
13997
  };
13809
13998
  400: components["responses"]["Default400Response"];
@@ -13817,65 +14006,232 @@ declare interface paths {
13817
14006
  };
13818
14007
  };
13819
14008
  put?: never;
14009
+ post?: never;
14010
+ delete?: never;
14011
+ options?: never;
14012
+ head?: never;
14013
+ patch?: never;
14014
+ trace?: never;
14015
+ };
14016
+ "/providers": {
14017
+ parameters: {
14018
+ query?: never;
14019
+ header?: never;
14020
+ path?: never;
14021
+ cookie?: never;
14022
+ };
13820
14023
  /**
13821
- * Create single reaction.
13822
- * @description Creates a new reaction.
14024
+ * Get multiple providers.
14025
+ * @description Retrieves multiple providers by available filters, or without if applicable.
13823
14026
  */
13824
- post: {
14027
+ get: {
13825
14028
  parameters: {
13826
- query?: never;
13827
- header?: {
13828
- /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */
13829
- "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
14029
+ query?: {
14030
+ /** @description List of provider IDs (e.g. `12345`) */
14031
+ "filter[id]"?: string[];
13830
14032
  };
14033
+ header?: never;
13831
14034
  path?: never;
13832
14035
  cookie?: never;
13833
14036
  };
13834
- requestBody?: {
13835
- content: {
13836
- "application/vnd.api+json": components["schemas"]["ReactionsCreateOperation_Payload"];
13837
- };
13838
- };
14037
+ requestBody?: never;
13839
14038
  responses: {
13840
14039
  /** @description Successful response */
13841
- 201: {
14040
+ 200: {
13842
14041
  headers: {
13843
14042
  [name: string]: unknown;
13844
14043
  };
13845
14044
  content: {
13846
- "application/vnd.api+json": components["schemas"]["Reactions_Single_Resource_Data_Document"];
14045
+ "application/vnd.api+json": components["schemas"]["Providers_Multi_Resource_Data_Document"];
13847
14046
  };
13848
14047
  };
13849
14048
  400: components["responses"]["Default400Response"];
13850
14049
  404: components["responses"]["Default404Response"];
13851
14050
  405: components["responses"]["Default405Response"];
13852
14051
  406: components["responses"]["Default406Response"];
13853
- 409: components["responses"]["Idempotency409Response"];
13854
14052
  415: components["responses"]["Default415Response"];
13855
- 422: components["responses"]["Idempotency422Response"];
13856
14053
  429: components["responses"]["Default429Response"];
13857
14054
  500: components["responses"]["Default500Response"];
13858
14055
  503: components["responses"]["Default503Response"];
13859
14056
  };
13860
14057
  };
14058
+ put?: never;
14059
+ post?: never;
13861
14060
  delete?: never;
13862
14061
  options?: never;
13863
14062
  head?: never;
13864
14063
  patch?: never;
13865
14064
  trace?: never;
13866
14065
  };
13867
- "/reactions/{id}": {
14066
+ "/providers/{id}": {
13868
14067
  parameters: {
13869
14068
  query?: never;
13870
14069
  header?: never;
13871
14070
  path?: never;
13872
14071
  cookie?: never;
13873
14072
  };
13874
- get?: never;
13875
- put?: never;
13876
- post?: never;
13877
14073
  /**
13878
- * Delete single reaction.
14074
+ * Get single provider.
14075
+ * @description Retrieves single provider by id.
14076
+ */
14077
+ get: {
14078
+ parameters: {
14079
+ query?: never;
14080
+ header?: never;
14081
+ path: {
14082
+ /**
14083
+ * @description Provider ID
14084
+ * @example 12345
14085
+ */
14086
+ id: string;
14087
+ };
14088
+ cookie?: never;
14089
+ };
14090
+ requestBody?: never;
14091
+ responses: {
14092
+ /** @description Successful response */
14093
+ 200: {
14094
+ headers: {
14095
+ [name: string]: unknown;
14096
+ };
14097
+ content: {
14098
+ "application/vnd.api+json": components["schemas"]["Providers_Single_Resource_Data_Document"];
14099
+ };
14100
+ };
14101
+ 400: components["responses"]["Default400Response"];
14102
+ 404: components["responses"]["Default404Response"];
14103
+ 405: components["responses"]["Default405Response"];
14104
+ 406: components["responses"]["Default406Response"];
14105
+ 415: components["responses"]["Default415Response"];
14106
+ 429: components["responses"]["Default429Response"];
14107
+ 500: components["responses"]["Default500Response"];
14108
+ 503: components["responses"]["Default503Response"];
14109
+ };
14110
+ };
14111
+ put?: never;
14112
+ post?: never;
14113
+ delete?: never;
14114
+ options?: never;
14115
+ head?: never;
14116
+ patch?: never;
14117
+ trace?: never;
14118
+ };
14119
+ "/reactions": {
14120
+ parameters: {
14121
+ query?: never;
14122
+ header?: never;
14123
+ path?: never;
14124
+ cookie?: never;
14125
+ };
14126
+ /**
14127
+ * Get multiple reactions.
14128
+ * @description Retrieves multiple reactions by available filters, or without if applicable.
14129
+ */
14130
+ get: {
14131
+ parameters: {
14132
+ query?: {
14133
+ stats?: "ALL" | "COUNTS_BY_TYPE" | "TOTAL_COUNT";
14134
+ statsOnly?: boolean;
14135
+ viewerContext?: string;
14136
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
14137
+ "page[cursor]"?: string;
14138
+ /**
14139
+ * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners
14140
+ * @example ownerProfiles
14141
+ */
14142
+ include?: string[];
14143
+ /** @description Filter by emoji (e.g. `👍`) */
14144
+ "filter[emoji]"?: string[];
14145
+ /** @description Filter by subject resource ID (e.g. `12345`) */
14146
+ "filter[subject.id]"?: string[];
14147
+ /** @description Filter by subject resource type (e.g. `albums`) */
14148
+ "filter[subject.type]"?: ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments")[];
14149
+ };
14150
+ header?: never;
14151
+ path?: never;
14152
+ cookie?: never;
14153
+ };
14154
+ requestBody?: never;
14155
+ responses: {
14156
+ /** @description Successful response */
14157
+ 200: {
14158
+ headers: {
14159
+ [name: string]: unknown;
14160
+ };
14161
+ content: {
14162
+ "application/vnd.api+json": components["schemas"]["Reactions_Multi_Resource_Data_Document"];
14163
+ };
14164
+ };
14165
+ 400: components["responses"]["Default400Response"];
14166
+ 404: components["responses"]["Default404Response"];
14167
+ 405: components["responses"]["Default405Response"];
14168
+ 406: components["responses"]["Default406Response"];
14169
+ 415: components["responses"]["Default415Response"];
14170
+ 429: components["responses"]["Default429Response"];
14171
+ 500: components["responses"]["Default500Response"];
14172
+ 503: components["responses"]["Default503Response"];
14173
+ };
14174
+ };
14175
+ put?: never;
14176
+ /**
14177
+ * Create single reaction.
14178
+ * @description Creates a new reaction.
14179
+ */
14180
+ post: {
14181
+ parameters: {
14182
+ query?: never;
14183
+ header?: {
14184
+ /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */
14185
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
14186
+ };
14187
+ path?: never;
14188
+ cookie?: never;
14189
+ };
14190
+ requestBody?: {
14191
+ content: {
14192
+ "application/vnd.api+json": components["schemas"]["ReactionsCreateOperation_Payload"];
14193
+ };
14194
+ };
14195
+ responses: {
14196
+ /** @description Successful response */
14197
+ 201: {
14198
+ headers: {
14199
+ [name: string]: unknown;
14200
+ };
14201
+ content: {
14202
+ "application/vnd.api+json": components["schemas"]["Reactions_Single_Resource_Data_Document"];
14203
+ };
14204
+ };
14205
+ 400: components["responses"]["Default400Response"];
14206
+ 404: components["responses"]["Default404Response"];
14207
+ 405: components["responses"]["Default405Response"];
14208
+ 406: components["responses"]["Default406Response"];
14209
+ 409: components["responses"]["Idempotency409Response"];
14210
+ 415: components["responses"]["Default415Response"];
14211
+ 422: components["responses"]["Idempotency422Response"];
14212
+ 429: components["responses"]["Default429Response"];
14213
+ 500: components["responses"]["Default500Response"];
14214
+ 503: components["responses"]["Default503Response"];
14215
+ };
14216
+ };
14217
+ delete?: never;
14218
+ options?: never;
14219
+ head?: never;
14220
+ patch?: never;
14221
+ trace?: never;
14222
+ };
14223
+ "/reactions/{id}": {
14224
+ parameters: {
14225
+ query?: never;
14226
+ header?: never;
14227
+ path?: never;
14228
+ cookie?: never;
14229
+ };
14230
+ get?: never;
14231
+ put?: never;
14232
+ post?: never;
14233
+ /**
14234
+ * Delete single reaction.
13879
14235
  * @description Deletes existing reaction.
13880
14236
  */
13881
14237
  delete: {
@@ -15465,6 +15821,8 @@ declare interface paths {
15465
15821
  uriScheme: "HTTPS" | "DATA";
15466
15822
  usage: "PLAYBACK" | "DOWNLOAD";
15467
15823
  adaptive: boolean;
15824
+ /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
15825
+ shareCode?: string;
15468
15826
  };
15469
15827
  header?: never;
15470
15828
  path: {
@@ -18848,6 +19206,261 @@ declare interface paths {
18848
19206
  patch?: never;
18849
19207
  trace?: never;
18850
19208
  };
19209
+ "/userCollectionSaveForLaters/{id}": {
19210
+ parameters: {
19211
+ query?: never;
19212
+ header?: never;
19213
+ path?: never;
19214
+ cookie?: never;
19215
+ };
19216
+ /**
19217
+ * Get single userCollectionSaveForLater.
19218
+ * @description Retrieves single userCollectionSaveForLater by id.
19219
+ */
19220
+ get: {
19221
+ parameters: {
19222
+ query?: {
19223
+ /**
19224
+ * @description Allows the client to customize which related resources should be returned. Available options: items, owners
19225
+ * @example items
19226
+ */
19227
+ include?: string[];
19228
+ };
19229
+ header?: never;
19230
+ path: {
19231
+ /**
19232
+ * @description User collection save for later id. Use `me` for the authenticated user's resource
19233
+ * @example me
19234
+ */
19235
+ id: string;
19236
+ };
19237
+ cookie?: never;
19238
+ };
19239
+ requestBody?: never;
19240
+ responses: {
19241
+ /** @description Successful response */
19242
+ 200: {
19243
+ headers: {
19244
+ [name: string]: unknown;
19245
+ };
19246
+ content: {
19247
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Single_Resource_Data_Document"];
19248
+ };
19249
+ };
19250
+ 400: components["responses"]["Default400Response"];
19251
+ 404: components["responses"]["Default404Response"];
19252
+ 405: components["responses"]["Default405Response"];
19253
+ 406: components["responses"]["Default406Response"];
19254
+ 415: components["responses"]["Default415Response"];
19255
+ 429: components["responses"]["Default429Response"];
19256
+ 500: components["responses"]["Default500Response"];
19257
+ 503: components["responses"]["Default503Response"];
19258
+ };
19259
+ };
19260
+ put?: never;
19261
+ post?: never;
19262
+ delete?: never;
19263
+ options?: never;
19264
+ head?: never;
19265
+ patch?: never;
19266
+ trace?: never;
19267
+ };
19268
+ "/userCollectionSaveForLaters/{id}/relationships/items": {
19269
+ parameters: {
19270
+ query?: never;
19271
+ header?: never;
19272
+ path?: never;
19273
+ cookie?: never;
19274
+ };
19275
+ /**
19276
+ * Get items relationship ("to-many").
19277
+ * @description Retrieves items relationship.
19278
+ */
19279
+ get: {
19280
+ parameters: {
19281
+ query?: {
19282
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
19283
+ "page[cursor]"?: string;
19284
+ /**
19285
+ * @description Allows the client to customize which related resources should be returned. Available options: items
19286
+ * @example items
19287
+ */
19288
+ include?: string[];
19289
+ };
19290
+ header?: never;
19291
+ path: {
19292
+ /**
19293
+ * @description User collection save for later id. Use `me` for the authenticated user's resource
19294
+ * @example me
19295
+ */
19296
+ id: string;
19297
+ };
19298
+ cookie?: never;
19299
+ };
19300
+ requestBody?: never;
19301
+ responses: {
19302
+ /** @description Successful response */
19303
+ 200: {
19304
+ headers: {
19305
+ [name: string]: unknown;
19306
+ };
19307
+ content: {
19308
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"];
19309
+ };
19310
+ };
19311
+ 400: components["responses"]["Default400Response"];
19312
+ 404: components["responses"]["Default404Response"];
19313
+ 405: components["responses"]["Default405Response"];
19314
+ 406: components["responses"]["Default406Response"];
19315
+ 415: components["responses"]["Default415Response"];
19316
+ 429: components["responses"]["Default429Response"];
19317
+ 500: components["responses"]["Default500Response"];
19318
+ 503: components["responses"]["Default503Response"];
19319
+ };
19320
+ };
19321
+ put?: never;
19322
+ /**
19323
+ * Add to items relationship ("to-many").
19324
+ * @description Adds item(s) to items relationship.
19325
+ */
19326
+ post: {
19327
+ parameters: {
19328
+ query?: never;
19329
+ header?: {
19330
+ /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */
19331
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
19332
+ };
19333
+ path: {
19334
+ /**
19335
+ * @description User collection save for later id. Use `me` for the authenticated user's resource
19336
+ * @example me
19337
+ */
19338
+ id: string;
19339
+ };
19340
+ cookie?: never;
19341
+ };
19342
+ requestBody?: {
19343
+ content: {
19344
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload"];
19345
+ };
19346
+ };
19347
+ responses: {
19348
+ 400: components["responses"]["Default400Response"];
19349
+ 404: components["responses"]["Default404Response"];
19350
+ 405: components["responses"]["Default405Response"];
19351
+ 406: components["responses"]["Default406Response"];
19352
+ 409: components["responses"]["UserCollectionSaveForLatersAddMultiDataRelationship409Response"];
19353
+ 415: components["responses"]["Default415Response"];
19354
+ 422: components["responses"]["Idempotency422Response"];
19355
+ 429: components["responses"]["Default429Response"];
19356
+ 500: components["responses"]["Default500Response"];
19357
+ 503: components["responses"]["Default503Response"];
19358
+ };
19359
+ };
19360
+ /**
19361
+ * Delete from items relationship ("to-many").
19362
+ * @description Deletes item(s) from items relationship.
19363
+ */
19364
+ delete: {
19365
+ parameters: {
19366
+ query?: never;
19367
+ header?: {
19368
+ /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */
19369
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
19370
+ };
19371
+ path: {
19372
+ /**
19373
+ * @description User collection save for later id. Use `me` for the authenticated user's resource
19374
+ * @example me
19375
+ */
19376
+ id: string;
19377
+ };
19378
+ cookie?: never;
19379
+ };
19380
+ requestBody?: {
19381
+ content: {
19382
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload"];
19383
+ };
19384
+ };
19385
+ responses: {
19386
+ 400: components["responses"]["Default400Response"];
19387
+ 404: components["responses"]["Default404Response"];
19388
+ 405: components["responses"]["Default405Response"];
19389
+ 406: components["responses"]["Default406Response"];
19390
+ 409: components["responses"]["Idempotency409Response"];
19391
+ 415: components["responses"]["Default415Response"];
19392
+ 422: components["responses"]["Idempotency422Response"];
19393
+ 429: components["responses"]["Default429Response"];
19394
+ 500: components["responses"]["Default500Response"];
19395
+ 503: components["responses"]["Default503Response"];
19396
+ };
19397
+ };
19398
+ options?: never;
19399
+ head?: never;
19400
+ patch?: never;
19401
+ trace?: never;
19402
+ };
19403
+ "/userCollectionSaveForLaters/{id}/relationships/owners": {
19404
+ parameters: {
19405
+ query?: never;
19406
+ header?: never;
19407
+ path?: never;
19408
+ cookie?: never;
19409
+ };
19410
+ /**
19411
+ * Get owners relationship ("to-many").
19412
+ * @description Retrieves owners relationship.
19413
+ */
19414
+ get: {
19415
+ parameters: {
19416
+ query?: {
19417
+ /**
19418
+ * @description Allows the client to customize which related resources should be returned. Available options: owners
19419
+ * @example owners
19420
+ */
19421
+ include?: string[];
19422
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
19423
+ "page[cursor]"?: string;
19424
+ };
19425
+ header?: never;
19426
+ path: {
19427
+ /**
19428
+ * @description User collection save for later id. Use `me` for the authenticated user's resource
19429
+ * @example me
19430
+ */
19431
+ id: string;
19432
+ };
19433
+ cookie?: never;
19434
+ };
19435
+ requestBody?: never;
19436
+ responses: {
19437
+ /** @description Successful response */
19438
+ 200: {
19439
+ headers: {
19440
+ [name: string]: unknown;
19441
+ };
19442
+ content: {
19443
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Multi_Relationship_Data_Document"];
19444
+ };
19445
+ };
19446
+ 400: components["responses"]["Default400Response"];
19447
+ 404: components["responses"]["Default404Response"];
19448
+ 405: components["responses"]["Default405Response"];
19449
+ 406: components["responses"]["Default406Response"];
19450
+ 415: components["responses"]["Default415Response"];
19451
+ 429: components["responses"]["Default429Response"];
19452
+ 500: components["responses"]["Default500Response"];
19453
+ 503: components["responses"]["Default503Response"];
19454
+ };
19455
+ };
19456
+ put?: never;
19457
+ post?: never;
19458
+ delete?: never;
19459
+ options?: never;
19460
+ head?: never;
19461
+ patch?: never;
19462
+ trace?: never;
19463
+ };
18851
19464
  "/userCollectionTracks": {
18852
19465
  parameters: {
18853
19466
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tidal-music/api",
3
- "version": "0.13.0",
3
+ "version": "0.15.0",
4
4
  "type": "module",
5
5
  "files": [
6
6
  "dist"
@@ -18,18 +18,18 @@
18
18
  },
19
19
  "dependencies": {
20
20
  "openapi-fetch": "0.17.0",
21
- "@tidal-music/api": "0.13.0"
21
+ "@tidal-music/api": "0.15.0"
22
22
  },
23
23
  "devDependencies": {
24
24
  "@vitest/coverage-v8": "4.1.0",
25
25
  "@vitest/ui": "4.1.0",
26
26
  "openapi-typescript": "7.13.0",
27
27
  "typescript": "5.9.3",
28
- "vite": "8.0.0",
28
+ "vite": "8.0.1",
29
29
  "vite-plugin-dts": "4.5.4",
30
30
  "vitest": "4.1.0",
31
- "@tidal-music/auth": "^1.4.0",
32
- "@tidal-music/common": "^0.2.0"
31
+ "@tidal-music/common": "^0.2.0",
32
+ "@tidal-music/auth": "^1.5.0"
33
33
  },
34
34
  "scripts": {
35
35
  "build": "vite build",