@tidal-music/api 0.14.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 +211 -13
  2. package/package.json +4 -4
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
  /**
@@ -597,7 +593,7 @@ export declare interface components {
597
593
  */
598
594
  recommendation?: "CLAIM_PROFILE" | "CLAIM_CONTENT";
599
595
  /** @description List of UPCs retrieved from the DSP */
600
- retrievedUpcs?: components["schemas"]["BarcodeId"][];
596
+ retrievedUpcs?: components["schemas"]["LegacyBarcodeId"][];
601
597
  /**
602
598
  * @description Current status of this claim
603
599
  * @enum {string}
@@ -1007,13 +1003,6 @@ export declare interface components {
1007
1003
  /** Format: float */
1008
1004
  replayGain?: number;
1009
1005
  };
1010
- /**
1011
- * @description Barcode Id
1012
- * @example 196589525444
1013
- */
1014
- BarcodeId: {
1015
- value: string;
1016
- };
1017
1006
  ClientsCreateOperation_Payload: {
1018
1007
  data: components["schemas"]["ClientsCreateOperation_Payload_Data"];
1019
1008
  };
@@ -1777,7 +1766,7 @@ export declare interface components {
1777
1766
  status: string;
1778
1767
  }[];
1779
1768
  };
1780
- 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"]["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"])[];
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"])[];
1781
1770
  InstallationsCreateOperation_Payload: {
1782
1771
  data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
1783
1772
  };
@@ -1870,6 +1859,10 @@ export declare interface components {
1870
1859
  included?: components["schemas"]["Included"];
1871
1860
  links: components["schemas"]["Links"];
1872
1861
  };
1862
+ /** @description List of UPCs retrieved from the DSP */
1863
+ LegacyBarcodeId: {
1864
+ value?: string;
1865
+ };
1873
1866
  LegacySource: {
1874
1867
  id: string;
1875
1868
  type: string;
@@ -2669,6 +2662,42 @@ export declare interface components {
2669
2662
  included?: components["schemas"]["Included"];
2670
2663
  links: components["schemas"]["Links"];
2671
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
+ };
2672
2701
  Providers_Attributes: {
2673
2702
  /**
2674
2703
  * @description Provider name
@@ -13815,6 +13844,175 @@ declare interface paths {
13815
13844
  patch?: never;
13816
13845
  trace?: never;
13817
13846
  };
13847
+ "/providerProductInfos": {
13848
+ parameters: {
13849
+ query?: never;
13850
+ header?: never;
13851
+ path?: never;
13852
+ cookie?: never;
13853
+ };
13854
+ /**
13855
+ * Get multiple providerProductInfos.
13856
+ * @description Retrieves multiple providerProductInfos by available filters, or without if applicable.
13857
+ */
13858
+ get: {
13859
+ parameters: {
13860
+ query?: {
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[];
13870
+ };
13871
+ header?: never;
13872
+ path?: never;
13873
+ cookie?: never;
13874
+ };
13875
+ requestBody?: never;
13876
+ responses: {
13877
+ /** @description Successful response */
13878
+ 200: {
13879
+ headers: {
13880
+ [name: string]: unknown;
13881
+ };
13882
+ content: {
13883
+ "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Multi_Resource_Data_Document"];
13884
+ };
13885
+ };
13886
+ 400: components["responses"]["Default400Response"];
13887
+ 404: components["responses"]["Default404Response"];
13888
+ 405: components["responses"]["Default405Response"];
13889
+ 406: components["responses"]["Default406Response"];
13890
+ 415: components["responses"]["Default415Response"];
13891
+ 429: components["responses"]["Default429Response"];
13892
+ 500: components["responses"]["Default500Response"];
13893
+ 503: components["responses"]["Default503Response"];
13894
+ };
13895
+ };
13896
+ put?: never;
13897
+ post?: never;
13898
+ delete?: never;
13899
+ options?: never;
13900
+ head?: never;
13901
+ patch?: never;
13902
+ trace?: never;
13903
+ };
13904
+ "/providerProductInfos/{id}/relationships/provider": {
13905
+ parameters: {
13906
+ query?: never;
13907
+ header?: never;
13908
+ path?: never;
13909
+ cookie?: never;
13910
+ };
13911
+ /**
13912
+ * Get provider relationship ("to-one").
13913
+ * @description Retrieves provider relationship.
13914
+ */
13915
+ get: {
13916
+ parameters: {
13917
+ query?: {
13918
+ /**
13919
+ * @description Allows the client to customize which related resources should be returned. Available options: provider
13920
+ * @example provider
13921
+ */
13922
+ include?: string[];
13923
+ };
13924
+ header?: never;
13925
+ path: {
13926
+ /** @description Provider product info id */
13927
+ id: string;
13928
+ };
13929
+ cookie?: never;
13930
+ };
13931
+ requestBody?: never;
13932
+ responses: {
13933
+ /** @description Successful response */
13934
+ 200: {
13935
+ headers: {
13936
+ [name: string]: unknown;
13937
+ };
13938
+ content: {
13939
+ "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Single_Relationship_Data_Document"];
13940
+ };
13941
+ };
13942
+ 400: components["responses"]["Default400Response"];
13943
+ 404: components["responses"]["Default404Response"];
13944
+ 405: components["responses"]["Default405Response"];
13945
+ 406: components["responses"]["Default406Response"];
13946
+ 415: components["responses"]["Default415Response"];
13947
+ 429: components["responses"]["Default429Response"];
13948
+ 500: components["responses"]["Default500Response"];
13949
+ 503: components["responses"]["Default503Response"];
13950
+ };
13951
+ };
13952
+ put?: never;
13953
+ post?: never;
13954
+ delete?: never;
13955
+ options?: never;
13956
+ head?: never;
13957
+ patch?: never;
13958
+ trace?: never;
13959
+ };
13960
+ "/providerProductInfos/{id}/relationships/subject": {
13961
+ parameters: {
13962
+ query?: never;
13963
+ header?: never;
13964
+ path?: never;
13965
+ cookie?: never;
13966
+ };
13967
+ /**
13968
+ * Get subject relationship ("to-one").
13969
+ * @description Retrieves subject relationship.
13970
+ */
13971
+ get: {
13972
+ parameters: {
13973
+ query?: {
13974
+ /**
13975
+ * @description Allows the client to customize which related resources should be returned. Available options: subject
13976
+ * @example subject
13977
+ */
13978
+ include?: string[];
13979
+ };
13980
+ header?: never;
13981
+ path: {
13982
+ /** @description Provider product info id */
13983
+ id: string;
13984
+ };
13985
+ cookie?: never;
13986
+ };
13987
+ requestBody?: never;
13988
+ responses: {
13989
+ /** @description Successful response */
13990
+ 200: {
13991
+ headers: {
13992
+ [name: string]: unknown;
13993
+ };
13994
+ content: {
13995
+ "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Single_Relationship_Data_Document"];
13996
+ };
13997
+ };
13998
+ 400: components["responses"]["Default400Response"];
13999
+ 404: components["responses"]["Default404Response"];
14000
+ 405: components["responses"]["Default405Response"];
14001
+ 406: components["responses"]["Default406Response"];
14002
+ 415: components["responses"]["Default415Response"];
14003
+ 429: components["responses"]["Default429Response"];
14004
+ 500: components["responses"]["Default500Response"];
14005
+ 503: components["responses"]["Default503Response"];
14006
+ };
14007
+ };
14008
+ put?: never;
14009
+ post?: never;
14010
+ delete?: never;
14011
+ options?: never;
14012
+ head?: never;
14013
+ patch?: never;
14014
+ trace?: never;
14015
+ };
13818
14016
  "/providers": {
13819
14017
  parameters: {
13820
14018
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tidal-music/api",
3
- "version": "0.14.0",
3
+ "version": "0.15.0",
4
4
  "type": "module",
5
5
  "files": [
6
6
  "dist"
@@ -18,7 +18,7 @@
18
18
  },
19
19
  "dependencies": {
20
20
  "openapi-fetch": "0.17.0",
21
- "@tidal-music/api": "0.14.0"
21
+ "@tidal-music/api": "0.15.0"
22
22
  },
23
23
  "devDependencies": {
24
24
  "@vitest/coverage-v8": "4.1.0",
@@ -28,8 +28,8 @@
28
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",