@tidal-music/api 0.15.0 → 0.19.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/dist/index.d.ts CHANGED
@@ -598,7 +598,7 @@ export declare interface components {
598
598
  * @description Current status of this claim
599
599
  * @enum {string}
600
600
  */
601
- status: "AWAITING_OAUTH" | "FETCHING_CONTENT" | "VERIFIED" | "NO_MATCHES" | "AUTHENTICATION_FAILED" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED";
601
+ status: "AWAITING_OAUTH" | "FETCHING_CONTENT" | "VERIFIED" | "NO_MATCHES" | "AUTHENTICATION_FAILED" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "NAME_MISMATCH" | "CLAIMED_ARTIST_MISMATCH";
602
602
  };
603
603
  ArtistClaims_Multi_Relationship_Data_Document: {
604
604
  data?: components["schemas"]["Resource_Identifier"][];
@@ -1766,7 +1766,7 @@ export declare interface components {
1766
1766
  status: string;
1767
1767
  }[];
1768
1768
  };
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"])[];
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"]["ProviderOwners_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"])[];
1770
1770
  InstallationsCreateOperation_Payload: {
1771
1771
  data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
1772
1772
  };
@@ -2662,6 +2662,48 @@ export declare interface components {
2662
2662
  included?: components["schemas"]["Included"];
2663
2663
  links: components["schemas"]["Links"];
2664
2664
  };
2665
+ ProviderOwners_Attributes: {
2666
+ /** Format: date-time */
2667
+ createdAt: string;
2668
+ };
2669
+ ProviderOwners_Multi_Relationship_Data_Document: {
2670
+ data?: components["schemas"]["Resource_Identifier"][];
2671
+ included?: components["schemas"]["Included"];
2672
+ links: components["schemas"]["Links"];
2673
+ };
2674
+ ProviderOwners_Multi_Resource_Data_Document: {
2675
+ data: components["schemas"]["ProviderOwners_Resource_Object"][];
2676
+ included?: components["schemas"]["Included"];
2677
+ links: components["schemas"]["Links"];
2678
+ };
2679
+ ProviderOwners_Relationships: {
2680
+ owners?: components["schemas"]["Multi_Relationship_Data_Document"];
2681
+ provider?: components["schemas"]["Single_Relationship_Data_Document"];
2682
+ };
2683
+ ProviderOwners_Resource_Object: {
2684
+ attributes?: components["schemas"]["ProviderOwners_Attributes"];
2685
+ /**
2686
+ * @description Resource id
2687
+ * @example 12345
2688
+ */
2689
+ id: string;
2690
+ relationships?: components["schemas"]["ProviderOwners_Relationships"];
2691
+ /**
2692
+ * @description Resource type (enum property replaced by openapi-typescript)
2693
+ * @enum {string}
2694
+ */
2695
+ type: "providerOwners";
2696
+ };
2697
+ ProviderOwners_Single_Relationship_Data_Document: {
2698
+ data?: components["schemas"]["Resource_Identifier"];
2699
+ included?: components["schemas"]["Included"];
2700
+ links: components["schemas"]["Links"];
2701
+ };
2702
+ ProviderOwners_Single_Resource_Data_Document: {
2703
+ data: components["schemas"]["ProviderOwners_Resource_Object"];
2704
+ included?: components["schemas"]["Included"];
2705
+ links: components["schemas"]["Links"];
2706
+ };
2665
2707
  ProviderProductInfos_Attributes: {
2666
2708
  barcodeId: string;
2667
2709
  };
@@ -3197,6 +3239,7 @@ export declare interface components {
3197
3239
  };
3198
3240
  Terms_Attributes: {
3199
3241
  contentLink: components["schemas"]["Link_Object"];
3242
+ countryCode: string;
3200
3243
  /** Format: date-time */
3201
3244
  effectiveAt: string;
3202
3245
  /** @enum {string} */
@@ -4774,6 +4817,7 @@ export declare interface components {
4774
4817
  discoveryMixes?: components["schemas"]["Multi_Relationship_Data_Document"];
4775
4818
  myMixes?: components["schemas"]["Multi_Relationship_Data_Document"];
4776
4819
  newArrivalMixes?: components["schemas"]["Multi_Relationship_Data_Document"];
4820
+ offlineMixes?: components["schemas"]["Multi_Relationship_Data_Document"];
4777
4821
  };
4778
4822
  UserRecommendations_Resource_Object: {
4779
4823
  attributes?: components["schemas"]["UserRecommendations_Attributes"];
@@ -13844,6 +13888,175 @@ declare interface paths {
13844
13888
  patch?: never;
13845
13889
  trace?: never;
13846
13890
  };
13891
+ "/providerOwners": {
13892
+ parameters: {
13893
+ query?: never;
13894
+ header?: never;
13895
+ path?: never;
13896
+ cookie?: never;
13897
+ };
13898
+ /**
13899
+ * Get multiple providerOwners.
13900
+ * @description Retrieves multiple providerOwners by available filters, or without if applicable.
13901
+ */
13902
+ get: {
13903
+ parameters: {
13904
+ query?: {
13905
+ /**
13906
+ * @description Allows the client to customize which related resources should be returned. Available options: owners, provider
13907
+ * @example owners
13908
+ */
13909
+ include?: string[];
13910
+ /** @description User id. Use `me` for the authenticated user */
13911
+ "filter[owners.id]"?: string[];
13912
+ };
13913
+ header?: never;
13914
+ path?: never;
13915
+ cookie?: never;
13916
+ };
13917
+ requestBody?: never;
13918
+ responses: {
13919
+ /** @description Successful response */
13920
+ 200: {
13921
+ headers: {
13922
+ [name: string]: unknown;
13923
+ };
13924
+ content: {
13925
+ "application/vnd.api+json": components["schemas"]["ProviderOwners_Multi_Resource_Data_Document"];
13926
+ };
13927
+ };
13928
+ 400: components["responses"]["Default400Response"];
13929
+ 404: components["responses"]["Default404Response"];
13930
+ 405: components["responses"]["Default405Response"];
13931
+ 406: components["responses"]["Default406Response"];
13932
+ 415: components["responses"]["Default415Response"];
13933
+ 429: components["responses"]["Default429Response"];
13934
+ 500: components["responses"]["Default500Response"];
13935
+ 503: components["responses"]["Default503Response"];
13936
+ };
13937
+ };
13938
+ put?: never;
13939
+ post?: never;
13940
+ delete?: never;
13941
+ options?: never;
13942
+ head?: never;
13943
+ patch?: never;
13944
+ trace?: never;
13945
+ };
13946
+ "/providerOwners/{id}/relationships/owners": {
13947
+ parameters: {
13948
+ query?: never;
13949
+ header?: never;
13950
+ path?: never;
13951
+ cookie?: never;
13952
+ };
13953
+ /**
13954
+ * Get owners relationship ("to-many").
13955
+ * @description Retrieves owners relationship.
13956
+ */
13957
+ get: {
13958
+ parameters: {
13959
+ query?: {
13960
+ /**
13961
+ * @description Allows the client to customize which related resources should be returned. Available options: owners
13962
+ * @example owners
13963
+ */
13964
+ include?: string[];
13965
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
13966
+ "page[cursor]"?: string;
13967
+ };
13968
+ header?: never;
13969
+ path: {
13970
+ /** @description Provider owner id */
13971
+ id: string;
13972
+ };
13973
+ cookie?: never;
13974
+ };
13975
+ requestBody?: never;
13976
+ responses: {
13977
+ /** @description Successful response */
13978
+ 200: {
13979
+ headers: {
13980
+ [name: string]: unknown;
13981
+ };
13982
+ content: {
13983
+ "application/vnd.api+json": components["schemas"]["ProviderOwners_Multi_Relationship_Data_Document"];
13984
+ };
13985
+ };
13986
+ 400: components["responses"]["Default400Response"];
13987
+ 404: components["responses"]["Default404Response"];
13988
+ 405: components["responses"]["Default405Response"];
13989
+ 406: components["responses"]["Default406Response"];
13990
+ 415: components["responses"]["Default415Response"];
13991
+ 429: components["responses"]["Default429Response"];
13992
+ 500: components["responses"]["Default500Response"];
13993
+ 503: components["responses"]["Default503Response"];
13994
+ };
13995
+ };
13996
+ put?: never;
13997
+ post?: never;
13998
+ delete?: never;
13999
+ options?: never;
14000
+ head?: never;
14001
+ patch?: never;
14002
+ trace?: never;
14003
+ };
14004
+ "/providerOwners/{id}/relationships/provider": {
14005
+ parameters: {
14006
+ query?: never;
14007
+ header?: never;
14008
+ path?: never;
14009
+ cookie?: never;
14010
+ };
14011
+ /**
14012
+ * Get provider relationship ("to-one").
14013
+ * @description Retrieves provider relationship.
14014
+ */
14015
+ get: {
14016
+ parameters: {
14017
+ query?: {
14018
+ /**
14019
+ * @description Allows the client to customize which related resources should be returned. Available options: provider
14020
+ * @example provider
14021
+ */
14022
+ include?: string[];
14023
+ };
14024
+ header?: never;
14025
+ path: {
14026
+ /** @description Provider owner id */
14027
+ id: string;
14028
+ };
14029
+ cookie?: never;
14030
+ };
14031
+ requestBody?: never;
14032
+ responses: {
14033
+ /** @description Successful response */
14034
+ 200: {
14035
+ headers: {
14036
+ [name: string]: unknown;
14037
+ };
14038
+ content: {
14039
+ "application/vnd.api+json": components["schemas"]["ProviderOwners_Single_Relationship_Data_Document"];
14040
+ };
14041
+ };
14042
+ 400: components["responses"]["Default400Response"];
14043
+ 404: components["responses"]["Default404Response"];
14044
+ 405: components["responses"]["Default405Response"];
14045
+ 406: components["responses"]["Default406Response"];
14046
+ 415: components["responses"]["Default415Response"];
14047
+ 429: components["responses"]["Default429Response"];
14048
+ 500: components["responses"]["Default500Response"];
14049
+ 503: components["responses"]["Default503Response"];
14050
+ };
14051
+ };
14052
+ put?: never;
14053
+ post?: never;
14054
+ delete?: never;
14055
+ options?: never;
14056
+ head?: never;
14057
+ patch?: never;
14058
+ trace?: never;
14059
+ };
13847
14060
  "/providerProductInfos": {
13848
14061
  parameters: {
13849
14062
  query?: never;
@@ -15652,6 +15865,8 @@ declare interface paths {
15652
15865
  get: {
15653
15866
  parameters: {
15654
15867
  query?: {
15868
+ /** @description Filter by countryCode */
15869
+ "filter[countryCode]"?: string[];
15655
15870
  /** @description Terms id (e.g. `a468bee88def`) */
15656
15871
  "filter[id]"?: string[];
15657
15872
  /** @description Filter by isLatestVersion */
@@ -21059,7 +21274,7 @@ declare interface paths {
21059
21274
  */
21060
21275
  locale?: string;
21061
21276
  /**
21062
- * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes, myMixes, newArrivalMixes
21277
+ * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes, myMixes, newArrivalMixes, offlineMixes
21063
21278
  * @example discoveryMixes
21064
21279
  */
21065
21280
  include?: string[];
@@ -21316,6 +21531,72 @@ declare interface paths {
21316
21531
  patch?: never;
21317
21532
  trace?: never;
21318
21533
  };
21534
+ "/userRecommendations/{id}/relationships/offlineMixes": {
21535
+ parameters: {
21536
+ query?: never;
21537
+ header?: never;
21538
+ path?: never;
21539
+ cookie?: never;
21540
+ };
21541
+ /**
21542
+ * Get offlineMixes relationship ("to-many").
21543
+ * @description Retrieves offlineMixes relationship.
21544
+ */
21545
+ get: {
21546
+ parameters: {
21547
+ query?: {
21548
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
21549
+ "page[cursor]"?: string;
21550
+ /**
21551
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
21552
+ * @example en-US
21553
+ */
21554
+ locale?: string;
21555
+ /**
21556
+ * @description Allows the client to customize which related resources should be returned. Available options: offlineMixes
21557
+ * @example offlineMixes
21558
+ */
21559
+ include?: string[];
21560
+ };
21561
+ header?: never;
21562
+ path: {
21563
+ /**
21564
+ * @description User recommendations id. Use `me` for the authenticated user's resource
21565
+ * @example me
21566
+ */
21567
+ id: string;
21568
+ };
21569
+ cookie?: never;
21570
+ };
21571
+ requestBody?: never;
21572
+ responses: {
21573
+ /** @description Successful response */
21574
+ 200: {
21575
+ headers: {
21576
+ [name: string]: unknown;
21577
+ };
21578
+ content: {
21579
+ "application/vnd.api+json": components["schemas"]["UserRecommendations_Multi_Relationship_Data_Document"];
21580
+ };
21581
+ };
21582
+ 400: components["responses"]["Default400Response"];
21583
+ 404: components["responses"]["Default404Response"];
21584
+ 405: components["responses"]["Default405Response"];
21585
+ 406: components["responses"]["Default406Response"];
21586
+ 415: components["responses"]["Default415Response"];
21587
+ 429: components["responses"]["Default429Response"];
21588
+ 500: components["responses"]["Default500Response"];
21589
+ 503: components["responses"]["Default503Response"];
21590
+ };
21591
+ };
21592
+ put?: never;
21593
+ post?: never;
21594
+ delete?: never;
21595
+ options?: never;
21596
+ head?: never;
21597
+ patch?: never;
21598
+ trace?: never;
21599
+ };
21319
21600
  "/userReports": {
21320
21601
  parameters: {
21321
21602
  query?: never;
package/dist/index.js CHANGED
@@ -338,7 +338,10 @@ function p(e, t = "https://openapi.tidal.com/v2/") {
338
338
  let n = { async onRequest({ request: t }) {
339
339
  let n = await e.getCredentials();
340
340
  return t.headers.set("Authorization", `Bearer ${n.token}`), (t.method === "POST" || t.method === "PATCH" || t.method === "DELETE") && t.headers.set("Content-Type", "application/vnd.api+json"), t;
341
- } }, i = r({ baseUrl: t });
341
+ } }, i = r({
342
+ baseUrl: t,
343
+ querySerializer: { allowReserved: !0 }
344
+ });
342
345
  return i.use(n), i;
343
346
  }
344
347
  //#endregion
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tidal-music/api",
3
- "version": "0.15.0",
3
+ "version": "0.19.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.15.0"
21
+ "@tidal-music/api": "0.19.0"
22
22
  },
23
23
  "devDependencies": {
24
- "@vitest/coverage-v8": "4.1.0",
25
- "@vitest/ui": "4.1.0",
24
+ "@vitest/coverage-v8": "4.1.2",
25
+ "@vitest/ui": "4.1.2",
26
26
  "openapi-typescript": "7.13.0",
27
27
  "typescript": "5.9.3",
28
- "vite": "8.0.1",
28
+ "vite": "8.0.5",
29
29
  "vite-plugin-dts": "4.5.4",
30
- "vitest": "4.1.0",
31
- "@tidal-music/common": "^0.2.0",
32
- "@tidal-music/auth": "^1.5.0"
30
+ "vitest": "4.1.2",
31
+ "@tidal-music/auth": "^1.6.0",
32
+ "@tidal-music/common": "^0.2.0"
33
33
  },
34
34
  "scripts": {
35
35
  "build": "vite build",