@tidal-music/api 0.23.0 → 0.24.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.
@@ -5983,6 +5983,10 @@ export interface paths {
5983
5983
  * @example offlineInventory
5984
5984
  */
5985
5985
  include?: string[];
5986
+ /** @description Offline item id (e.g. `1234`) */
5987
+ "filter[id]"?: string[];
5988
+ /** @description One of: PENDING, STORED (e.g. `PENDING`) */
5989
+ "filter[state]"?: ("PENDING" | "STORED")[];
5986
5990
  /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */
5987
5991
  "filter[type]"?: ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[];
5988
5992
  };
@@ -10597,6 +10601,121 @@ export interface paths {
10597
10601
  patch?: never;
10598
10602
  trace?: never;
10599
10603
  };
10604
+ "/squareConnections": {
10605
+ parameters: {
10606
+ query?: never;
10607
+ header?: never;
10608
+ path?: never;
10609
+ cookie?: never;
10610
+ };
10611
+ get?: never;
10612
+ put?: never;
10613
+ /**
10614
+ * Create single squareConnection.
10615
+ * @description Creates a new squareConnection.
10616
+ */
10617
+ post: {
10618
+ parameters: {
10619
+ query?: {
10620
+ /**
10621
+ * @description ISO 3166-1 alpha-2 country code
10622
+ * @example US
10623
+ */
10624
+ countryCode?: string;
10625
+ };
10626
+ header?: {
10627
+ /** @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. */
10628
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
10629
+ };
10630
+ path?: never;
10631
+ cookie?: never;
10632
+ };
10633
+ requestBody?: {
10634
+ content: {
10635
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsCreateOperation_Payload"];
10636
+ };
10637
+ };
10638
+ responses: {
10639
+ /** @description Successful response */
10640
+ 201: {
10641
+ headers: {
10642
+ [name: string]: unknown;
10643
+ };
10644
+ content: {
10645
+ "application/vnd.api+json": components["schemas"]["SquareConnections_Single_Resource_Data_Document"];
10646
+ };
10647
+ };
10648
+ 400: components["responses"]["Default400Response"];
10649
+ 404: components["responses"]["Default404Response"];
10650
+ 405: components["responses"]["Default405Response"];
10651
+ 406: components["responses"]["Default406Response"];
10652
+ 409: components["responses"]["Idempotency409Response"];
10653
+ 415: components["responses"]["Default415Response"];
10654
+ 422: components["responses"]["Idempotency422Response"];
10655
+ 429: components["responses"]["Default429Response"];
10656
+ 500: components["responses"]["Default500Response"];
10657
+ 503: components["responses"]["Default503Response"];
10658
+ };
10659
+ };
10660
+ delete?: never;
10661
+ options?: never;
10662
+ head?: never;
10663
+ patch?: never;
10664
+ trace?: never;
10665
+ };
10666
+ "/squareConnections/{id}": {
10667
+ parameters: {
10668
+ query?: never;
10669
+ header?: never;
10670
+ path?: never;
10671
+ cookie?: never;
10672
+ };
10673
+ /**
10674
+ * Get single squareConnection.
10675
+ * @description Retrieves single squareConnection by id.
10676
+ */
10677
+ get: {
10678
+ parameters: {
10679
+ query?: never;
10680
+ header?: never;
10681
+ path: {
10682
+ /**
10683
+ * @description Square connection id. Use `me` for the authenticated user's resource
10684
+ * @example me
10685
+ */
10686
+ id: string;
10687
+ };
10688
+ cookie?: never;
10689
+ };
10690
+ requestBody?: never;
10691
+ responses: {
10692
+ /** @description Successful response */
10693
+ 200: {
10694
+ headers: {
10695
+ [name: string]: unknown;
10696
+ };
10697
+ content: {
10698
+ "application/vnd.api+json": components["schemas"]["SquareConnections_Single_Resource_Data_Document"];
10699
+ };
10700
+ };
10701
+ 400: components["responses"]["Default400Response"];
10702
+ 404: components["responses"]["Default404Response"];
10703
+ 405: components["responses"]["Default405Response"];
10704
+ 406: components["responses"]["Default406Response"];
10705
+ 415: components["responses"]["Default415Response"];
10706
+ 429: components["responses"]["Default429Response"];
10707
+ 500: components["responses"]["Default500Response"];
10708
+ 503: components["responses"]["Default503Response"];
10709
+ };
10710
+ };
10711
+ put?: never;
10712
+ post?: never;
10713
+ delete?: never;
10714
+ options?: never;
10715
+ head?: never;
10716
+ patch?: never;
10717
+ trace?: never;
10718
+ };
10600
10719
  "/stripeConnections": {
10601
10720
  parameters: {
10602
10721
  query?: never;
@@ -13532,11 +13651,20 @@ export interface paths {
13532
13651
  };
13533
13652
  };
13534
13653
  responses: {
13654
+ /** @description Successful response */
13655
+ 200: {
13656
+ headers: {
13657
+ [name: string]: unknown;
13658
+ };
13659
+ content: {
13660
+ "application/vnd.api+json": components["schemas"]["UserCollectionAlbums_Items_Multi_Relationship_Data_Document"];
13661
+ };
13662
+ };
13535
13663
  400: components["responses"]["Default400Response"];
13536
13664
  404: components["responses"]["Default404Response"];
13537
13665
  405: components["responses"]["Default405Response"];
13538
13666
  406: components["responses"]["Default406Response"];
13539
- 409: components["responses"]["UserCollectionAlbumsAddMultiDataRelationship409Response"];
13667
+ 409: components["responses"]["UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response"];
13540
13668
  415: components["responses"]["Default415Response"];
13541
13669
  422: components["responses"]["Idempotency422Response"];
13542
13670
  429: components["responses"]["Default429Response"];
@@ -13815,11 +13943,20 @@ export interface paths {
13815
13943
  };
13816
13944
  };
13817
13945
  responses: {
13946
+ /** @description Successful response */
13947
+ 200: {
13948
+ headers: {
13949
+ [name: string]: unknown;
13950
+ };
13951
+ content: {
13952
+ "application/vnd.api+json": components["schemas"]["UserCollectionArtists_Items_Multi_Relationship_Data_Document"];
13953
+ };
13954
+ };
13818
13955
  400: components["responses"]["Default400Response"];
13819
13956
  404: components["responses"]["Default404Response"];
13820
13957
  405: components["responses"]["Default405Response"];
13821
13958
  406: components["responses"]["Default406Response"];
13822
- 409: components["responses"]["UserCollectionArtistsAddMultiDataRelationship409Response"];
13959
+ 409: components["responses"]["UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response"];
13823
13960
  415: components["responses"]["Default415Response"];
13824
13961
  422: components["responses"]["Idempotency422Response"];
13825
13962
  429: components["responses"]["Default429Response"];
@@ -14505,11 +14642,20 @@ export interface paths {
14505
14642
  };
14506
14643
  };
14507
14644
  responses: {
14645
+ /** @description Successful response */
14646
+ 200: {
14647
+ headers: {
14648
+ [name: string]: unknown;
14649
+ };
14650
+ content: {
14651
+ "application/vnd.api+json": components["schemas"]["UserCollectionPlaylists_Items_Multi_Relationship_Data_Document"];
14652
+ };
14653
+ };
14508
14654
  400: components["responses"]["Default400Response"];
14509
14655
  404: components["responses"]["Default404Response"];
14510
14656
  405: components["responses"]["Default405Response"];
14511
14657
  406: components["responses"]["Default406Response"];
14512
- 409: components["responses"]["UserCollectionPlaylistsAddMultiDataRelationship409Response"];
14658
+ 409: components["responses"]["UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response"];
14513
14659
  415: components["responses"]["Default415Response"];
14514
14660
  422: components["responses"]["Idempotency422Response"];
14515
14661
  429: components["responses"]["Default429Response"];
@@ -14760,11 +14906,20 @@ export interface paths {
14760
14906
  };
14761
14907
  };
14762
14908
  responses: {
14909
+ /** @description Successful response */
14910
+ 200: {
14911
+ headers: {
14912
+ [name: string]: unknown;
14913
+ };
14914
+ content: {
14915
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"];
14916
+ };
14917
+ };
14763
14918
  400: components["responses"]["Default400Response"];
14764
14919
  404: components["responses"]["Default404Response"];
14765
14920
  405: components["responses"]["Default405Response"];
14766
14921
  406: components["responses"]["Default406Response"];
14767
- 409: components["responses"]["UserCollectionSaveForLatersAddMultiDataRelationship409Response"];
14922
+ 409: components["responses"]["UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response"];
14768
14923
  415: components["responses"]["Default415Response"];
14769
14924
  422: components["responses"]["Idempotency422Response"];
14770
14925
  429: components["responses"]["Default429Response"];
@@ -15390,11 +15545,20 @@ export interface paths {
15390
15545
  };
15391
15546
  };
15392
15547
  responses: {
15548
+ /** @description Successful response */
15549
+ 200: {
15550
+ headers: {
15551
+ [name: string]: unknown;
15552
+ };
15553
+ content: {
15554
+ "application/vnd.api+json": components["schemas"]["UserCollectionVideos_Items_Multi_Relationship_Data_Document"];
15555
+ };
15556
+ };
15393
15557
  400: components["responses"]["Default400Response"];
15394
15558
  404: components["responses"]["Default404Response"];
15395
15559
  405: components["responses"]["Default405Response"];
15396
15560
  406: components["responses"]["Default406Response"];
15397
- 409: components["responses"]["UserCollectionVideosAddMultiDataRelationship409Response"];
15561
+ 409: components["responses"]["UserCollectionVideosAddMultiDataRelationshipWithResponse409Response"];
15398
15562
  415: components["responses"]["Default415Response"];
15399
15563
  422: components["responses"]["Idempotency422Response"];
15400
15564
  429: components["responses"]["Default429Response"];
@@ -19265,7 +19429,6 @@ export interface components {
19265
19429
  };
19266
19430
  ClientsUpdateOperation_Payload_Data_Attributes: {
19267
19431
  description?: string;
19268
- enabled?: boolean;
19269
19432
  name?: string;
19270
19433
  /** @enum {string} */
19271
19434
  platformPreset?: "NONE" | "WEB" | "ANDROID" | "IOS";
@@ -19279,7 +19442,6 @@ export interface components {
19279
19442
  /** Format: date-time */
19280
19443
  createdAt?: string;
19281
19444
  description?: string;
19282
- enabled?: boolean;
19283
19445
  name: string;
19284
19446
  /** @enum {string} */
19285
19447
  platformPreset?: "NONE" | "WEB" | "ANDROID" | "IOS";
@@ -19915,7 +20077,7 @@ export interface components {
19915
20077
  /** @description metadata about an external link */
19916
20078
  External_Link_Meta: {
19917
20079
  /** @enum {string} */
19918
- type: "TIDAL_SHARING" | "TIDAL_USER_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "OFFICIAL_HOMEPAGE" | "CASHAPP_CONTRIBUTIONS" | "ARTIST_CLAIM_PROVIDER_REDIRECT" | "STRIPE_AUTHORIZATION_REDIRECT";
20080
+ type: "TIDAL_SHARING" | "TIDAL_USER_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "OFFICIAL_HOMEPAGE" | "CASHAPP_CONTRIBUTIONS" | "ARTIST_CLAIM_PROVIDER_REDIRECT" | "STRIPE_AUTHORIZATION_REDIRECT" | "SQUARE_AUTHORIZATION_REDIRECT";
19919
20081
  };
19920
20082
  External_Link_Payload: {
19921
20083
  href?: string;
@@ -20011,7 +20173,7 @@ export interface components {
20011
20173
  status: string;
20012
20174
  }[];
20013
20175
  };
20014
- 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"]["Purchases_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["SearchHistoryEntries_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"]["TemporaryUserTokens_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"]["UserDailyMixes_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserDiscoveryMixes_Resource_Object"] | components["schemas"]["UserNewReleaseMixes_Resource_Object"] | components["schemas"]["UserOfflineMixes_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"])[];
20176
+ 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"]["Purchases_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["SearchHistoryEntries_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["SquareConnections_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["TemporaryUserTokens_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"]["UserDailyMixes_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserDiscoveryMixes_Resource_Object"] | components["schemas"]["UserNewReleaseMixes_Resource_Object"] | components["schemas"]["UserOfflineMixes_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"])[];
20015
20177
  InstallationsCreateOperation_Payload: {
20016
20178
  data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
20017
20179
  };
@@ -20079,8 +20241,8 @@ export interface components {
20079
20241
  type: string;
20080
20242
  };
20081
20243
  Installations_OfflineInventory_Resource_Identifier_Meta: {
20082
- /** @enum {string} */
20083
- clientStorageState: "PENDING" | "STORED";
20244
+ /** Format: date-time */
20245
+ addedAt: string;
20084
20246
  };
20085
20247
  Installations_Relationships: {
20086
20248
  offlineInventory?: components["schemas"]["Installations_OfflineInventory_Multi_Relationship_Data_Document"];
@@ -21432,6 +21594,63 @@ export interface components {
21432
21594
  data?: components["schemas"]["Resource_Identifier"];
21433
21595
  links: components["schemas"]["Links"];
21434
21596
  };
21597
+ SquareConnectionsCreateOperation_Payload: {
21598
+ data: components["schemas"]["SquareConnectionsCreateOperation_Payload_Data"];
21599
+ meta: components["schemas"]["SquareConnectionsCreateOperation_Payload_Meta"];
21600
+ };
21601
+ SquareConnectionsCreateOperation_Payload_Data: {
21602
+ /** @enum {string} */
21603
+ type: "squareConnections";
21604
+ };
21605
+ SquareConnectionsCreateOperation_Payload_Meta: {
21606
+ /**
21607
+ * @description Client platform initiating Square onboarding.
21608
+ * @enum {string}
21609
+ */
21610
+ platform: "WEB" | "ANDROID" | "IOS";
21611
+ };
21612
+ SquareConnections_Attributes: {
21613
+ /**
21614
+ * Format: date-time
21615
+ * @description Timestamp when the connection was created
21616
+ */
21617
+ createdAt?: string;
21618
+ /** @description External links for Square connection */
21619
+ externalLinks?: components["schemas"]["External_Link"][];
21620
+ /**
21621
+ * Format: date-time
21622
+ * @description Timestamp when the connection was last modified
21623
+ */
21624
+ lastModifiedAt?: string;
21625
+ /**
21626
+ * @description Current status of this Square connection
21627
+ * @enum {string}
21628
+ */
21629
+ status: "PENDING_REQUIREMENTS" | "ACCEPTED" | "REJECTED";
21630
+ };
21631
+ SquareConnections_Multi_Resource_Data_Document: {
21632
+ data: components["schemas"]["SquareConnections_Resource_Object"][];
21633
+ included?: components["schemas"]["Included"];
21634
+ links: components["schemas"]["Links"];
21635
+ };
21636
+ SquareConnections_Resource_Object: {
21637
+ attributes?: components["schemas"]["SquareConnections_Attributes"];
21638
+ /**
21639
+ * @description Resource id
21640
+ * @example 12345
21641
+ */
21642
+ id: string;
21643
+ /**
21644
+ * @description Resource type (enum property replaced by openapi-typescript)
21645
+ * @enum {string}
21646
+ */
21647
+ type: "squareConnections";
21648
+ };
21649
+ SquareConnections_Single_Resource_Data_Document: {
21650
+ data: components["schemas"]["SquareConnections_Resource_Object"];
21651
+ included?: components["schemas"]["Included"];
21652
+ links: components["schemas"]["Links"];
21653
+ };
21435
21654
  StripeConnectionsCreateOperation_Payload: {
21436
21655
  data: components["schemas"]["StripeConnectionsCreateOperation_Payload_Data"];
21437
21656
  meta?: components["schemas"]["StripeConnectionsCreateOperation_Payload_Meta"];
@@ -22055,6 +22274,11 @@ export interface components {
22055
22274
  * @enum {string}
22056
22275
  */
22057
22276
  accessType?: "PUBLIC" | "UNLISTED" | "PRIVATE";
22277
+ /**
22278
+ * @description Whether the track is AI-generated
22279
+ * @example false
22280
+ */
22281
+ ai?: boolean;
22058
22282
  /**
22059
22283
  * @deprecated
22060
22284
  * @description Available usage for this track. Deprecated: use 'usageRules' instead. This field will be removed in a future version.
@@ -22189,6 +22413,8 @@ export interface components {
22189
22413
  UsageRulesCreateOperation_Payload_Data_Attributes: {
22190
22414
  countryCode?: string;
22191
22415
  free?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22416
+ /** @description Tracks only. Set to true (with empty paid/subscription/free) to clear an explicit track-level override and inherit usage rules from the album. Must be omitted or false when providing explicit usage values. */
22417
+ inherited?: boolean;
22192
22418
  paid?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22193
22419
  subscription?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22194
22420
  };
@@ -22208,6 +22434,8 @@ export interface components {
22208
22434
  countryCode: string;
22209
22435
  /** @description Usage types allowed for free/ad-supported model */
22210
22436
  free?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22437
+ /** @description Whether these usage rules are inherited from a parent (e.g. a track inheriting from its album). Tri-state: true means the rules are inherited, false means an explicit per-track override, null means the value is unknown or not applicable (albums, videos, and legacy data). */
22438
+ inherited?: boolean;
22211
22439
  /** @description Usage types allowed for paid/purchase model */
22212
22440
  paid?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22213
22441
  /** @description Usage types allowed for subscription model */
@@ -22236,7 +22464,7 @@ export interface components {
22236
22464
  included?: components["schemas"]["Included"];
22237
22465
  links: components["schemas"]["Links"];
22238
22466
  };
22239
- UserCollectionAlbumsAddMultiDataRelationship409ResponseBody: {
22467
+ UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody: {
22240
22468
  errors: {
22241
22469
  /**
22242
22470
  * @example DUPLICATE_ITEMS_IN_COLLECTION
@@ -22270,7 +22498,13 @@ export interface components {
22270
22498
  /** @enum {string} */
22271
22499
  type: "albums";
22272
22500
  };
22273
- UserCollectionAlbums_Attributes: Record<string, never>;
22501
+ UserCollectionAlbums_Attributes: {
22502
+ /**
22503
+ * Format: int32
22504
+ * @description Number of items in the collection
22505
+ */
22506
+ numberOfItems: number;
22507
+ };
22274
22508
  UserCollectionAlbums_Items_Multi_Relationship_Data_Document: {
22275
22509
  data?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier"][];
22276
22510
  included?: components["schemas"]["Included"];
@@ -22326,7 +22560,7 @@ export interface components {
22326
22560
  included?: components["schemas"]["Included"];
22327
22561
  links: components["schemas"]["Links"];
22328
22562
  };
22329
- UserCollectionArtistsAddMultiDataRelationship409ResponseBody: {
22563
+ UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody: {
22330
22564
  errors: {
22331
22565
  /**
22332
22566
  * @example DUPLICATE_ITEMS_IN_COLLECTION
@@ -22534,7 +22768,7 @@ export interface components {
22534
22768
  included?: components["schemas"]["Included"];
22535
22769
  links: components["schemas"]["Links"];
22536
22770
  };
22537
- UserCollectionPlaylistsAddMultiDataRelationship409ResponseBody: {
22771
+ UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody: {
22538
22772
  errors: {
22539
22773
  /**
22540
22774
  * @example DUPLICATE_ITEMS_IN_COLLECTION
@@ -22619,7 +22853,7 @@ export interface components {
22619
22853
  included?: components["schemas"]["Included"];
22620
22854
  links: components["schemas"]["Links"];
22621
22855
  };
22622
- UserCollectionSaveForLatersAddMultiDataRelationship409ResponseBody: {
22856
+ UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409ResponseBody: {
22623
22857
  errors: {
22624
22858
  /**
22625
22859
  * @example DUPLICATE_ITEMS_IN_COLLECTION
@@ -22794,7 +23028,7 @@ export interface components {
22794
23028
  included?: components["schemas"]["Included"];
22795
23029
  links: components["schemas"]["Links"];
22796
23030
  };
22797
- UserCollectionVideosAddMultiDataRelationship409ResponseBody: {
23031
+ UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody: {
22798
23032
  errors: {
22799
23033
  /**
22800
23034
  * @example DUPLICATE_ITEMS_IN_COLLECTION
@@ -23746,21 +23980,21 @@ export interface components {
23746
23980
  };
23747
23981
  };
23748
23982
  /** @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 */
23749
- UserCollectionAlbumsAddMultiDataRelationship409Response: {
23983
+ UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response: {
23750
23984
  headers: {
23751
23985
  [name: string]: unknown;
23752
23986
  };
23753
23987
  content: {
23754
- "application/vnd.api+json": components["schemas"]["UserCollectionAlbumsAddMultiDataRelationship409ResponseBody"];
23988
+ "application/vnd.api+json": components["schemas"]["UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody"];
23755
23989
  };
23756
23990
  };
23757
23991
  /** @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 */
23758
- UserCollectionArtistsAddMultiDataRelationship409Response: {
23992
+ UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response: {
23759
23993
  headers: {
23760
23994
  [name: string]: unknown;
23761
23995
  };
23762
23996
  content: {
23763
- "application/vnd.api+json": components["schemas"]["UserCollectionArtistsAddMultiDataRelationship409ResponseBody"];
23997
+ "application/vnd.api+json": components["schemas"]["UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody"];
23764
23998
  };
23765
23999
  };
23766
24000
  /** @description Cannot delete folder: only empty folders owned by you can be deleted. */
@@ -23773,21 +24007,21 @@ export interface components {
23773
24007
  };
23774
24008
  };
23775
24009
  /** @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 */
23776
- UserCollectionPlaylistsAddMultiDataRelationship409Response: {
24010
+ UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response: {
23777
24011
  headers: {
23778
24012
  [name: string]: unknown;
23779
24013
  };
23780
24014
  content: {
23781
- "application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsAddMultiDataRelationship409ResponseBody"];
24015
+ "application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody"];
23782
24016
  };
23783
24017
  };
23784
24018
  /** @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 */
23785
- UserCollectionSaveForLatersAddMultiDataRelationship409Response: {
24019
+ UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response: {
23786
24020
  headers: {
23787
24021
  [name: string]: unknown;
23788
24022
  };
23789
24023
  content: {
23790
- "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersAddMultiDataRelationship409ResponseBody"];
24024
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409ResponseBody"];
23791
24025
  };
23792
24026
  };
23793
24027
  /** @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 */
@@ -23800,12 +24034,12 @@ export interface components {
23800
24034
  };
23801
24035
  };
23802
24036
  /** @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 */
23803
- UserCollectionVideosAddMultiDataRelationship409Response: {
24037
+ UserCollectionVideosAddMultiDataRelationshipWithResponse409Response: {
23804
24038
  headers: {
23805
24039
  [name: string]: unknown;
23806
24040
  };
23807
24041
  content: {
23808
- "application/vnd.api+json": components["schemas"]["UserCollectionVideosAddMultiDataRelationship409ResponseBody"];
24042
+ "application/vnd.api+json": components["schemas"]["UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody"];
23809
24043
  };
23810
24044
  };
23811
24045
  /** @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 */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tidal-music/api",
3
- "version": "0.23.0",
3
+ "version": "0.24.0",
4
4
  "type": "module",
5
5
  "files": [
6
6
  "dist"
@@ -19,15 +19,15 @@
19
19
  },
20
20
  "dependencies": {
21
21
  "openapi-fetch": "0.17.0",
22
- "@tidal-music/api": "0.23.0"
22
+ "@tidal-music/api": "0.24.0"
23
23
  },
24
24
  "devDependencies": {
25
25
  "@vitest/coverage-v8": "4.1.5",
26
26
  "@vitest/ui": "4.1.5",
27
27
  "openapi-typescript": "7.13.0",
28
28
  "typescript": "6.0.3",
29
- "vite": "8.0.10",
30
- "vite-plugin-dts": "4.5.4",
29
+ "vite": "8.0.12",
30
+ "vite-plugin-dts": "5.0.0",
31
31
  "vitest": "4.1.5",
32
32
  "@tidal-music/auth": "^1.6.0",
33
33
  "@tidal-music/common": "^0.2.0"