@tidal-music/api 0.45.1 → 0.47.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.
@@ -300,11 +300,6 @@ export interface paths {
300
300
  get: {
301
301
  parameters: {
302
302
  query?: {
303
- /**
304
- * @description ISO 3166-1 alpha-2 country code
305
- * @example US
306
- */
307
- countryCode?: string;
308
303
  /**
309
304
  * @description Allows the client to customize which related resources should be returned. Available options: owners
310
305
  * @example owners
@@ -1075,11 +1070,6 @@ export interface paths {
1075
1070
  get: {
1076
1071
  parameters: {
1077
1072
  query?: {
1078
- /**
1079
- * @description ISO 3166-1 alpha-2 country code
1080
- * @example US
1081
- */
1082
- countryCode?: string;
1083
1073
  /**
1084
1074
  * @description Allows the client to customize which related resources should be returned. Available options: owners
1085
1075
  * @example owners
@@ -6466,123 +6456,63 @@ export interface paths {
6466
6456
  patch?: never;
6467
6457
  trace?: never;
6468
6458
  };
6469
- "/genres": {
6459
+ "/folderItems": {
6470
6460
  parameters: {
6471
6461
  query?: never;
6472
6462
  header?: never;
6473
6463
  path?: never;
6474
6464
  cookie?: never;
6475
6465
  };
6466
+ get?: never;
6467
+ put?: never;
6476
6468
  /**
6477
- * Get multiple genres.
6478
- * @description Retrieves multiple genres by available filters, or without if applicable.
6469
+ * Create single folderItem.
6470
+ * @description Creates a new folderItem.
6479
6471
  */
6480
- get: {
6472
+ post: {
6481
6473
  parameters: {
6482
- query: {
6483
- /** @description Allows filtering by genre id(s). USER_SELECTABLE is special value used to return specific genres which users can select from (e.g. `'1,2,3' or 'USER_SELECTABLE'`) */
6484
- "filter[id]": string[];
6485
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6486
- "page[cursor]"?: string;
6487
- /**
6488
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6489
- * @example en-US
6490
- */
6491
- locale?: string;
6474
+ query?: never;
6475
+ header?: {
6476
+ /** @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. */
6477
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
6492
6478
  };
6493
- header?: never;
6494
6479
  path?: never;
6495
6480
  cookie?: never;
6496
6481
  };
6497
- requestBody?: never;
6498
- responses: {
6499
- /** @description Successful response */
6500
- 200: {
6501
- headers: {
6502
- [name: string]: unknown;
6503
- };
6504
- content: {
6505
- "application/vnd.api+json": components["schemas"]["Genres_Multi_Resource_Data_Document"];
6506
- };
6507
- };
6508
- 400: components["responses"]["Default400Response"];
6509
- 404: components["responses"]["Default404Response"];
6510
- 405: components["responses"]["Default405Response"];
6511
- 406: components["responses"]["Default406Response"];
6512
- 415: components["responses"]["Default415Response"];
6513
- 429: components["responses"]["Default429Response"];
6514
- 500: components["responses"]["Default500Response"];
6515
- 503: components["responses"]["Default503Response"];
6516
- };
6517
- };
6518
- put?: never;
6519
- post?: never;
6520
- delete?: never;
6521
- options?: never;
6522
- head?: never;
6523
- patch?: never;
6524
- trace?: never;
6525
- };
6526
- "/genres/{id}": {
6527
- parameters: {
6528
- query?: never;
6529
- header?: never;
6530
- path?: never;
6531
- cookie?: never;
6532
- };
6533
- /**
6534
- * Get single genre.
6535
- * @description Retrieves single genre by id.
6536
- */
6537
- get: {
6538
- parameters: {
6539
- query?: {
6540
- /**
6541
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6542
- * @example en-US
6543
- */
6544
- locale?: string;
6545
- };
6546
- header?: never;
6547
- path: {
6548
- /**
6549
- * @description Genre id
6550
- * @example 123
6551
- */
6552
- id: string;
6482
+ requestBody?: {
6483
+ content: {
6484
+ "application/vnd.api+json": components["schemas"]["FolderItemsCreateOperation_Payload"];
6553
6485
  };
6554
- cookie?: never;
6555
6486
  };
6556
- requestBody?: never;
6557
6487
  responses: {
6558
6488
  /** @description Successful response */
6559
- 200: {
6489
+ 201: {
6560
6490
  headers: {
6561
6491
  [name: string]: unknown;
6562
6492
  };
6563
6493
  content: {
6564
- "application/vnd.api+json": components["schemas"]["Genres_Single_Resource_Data_Document"];
6494
+ "application/vnd.api+json": components["schemas"]["FolderItems_Create_Single_Resource_Data_Document"];
6565
6495
  };
6566
6496
  };
6567
- 400: components["responses"]["Default400Response"];
6497
+ 400: components["responses"]["FolderItemsCreateResource400Response"];
6568
6498
  404: components["responses"]["Default404Response"];
6569
6499
  405: components["responses"]["Default405Response"];
6570
6500
  406: components["responses"]["Default406Response"];
6501
+ 409: components["responses"]["Idempotency409Response"];
6571
6502
  415: components["responses"]["Default415Response"];
6503
+ 422: components["responses"]["Idempotency422Response"];
6572
6504
  429: components["responses"]["Default429Response"];
6573
6505
  500: components["responses"]["Default500Response"];
6574
6506
  503: components["responses"]["Default503Response"];
6575
6507
  };
6576
6508
  };
6577
- put?: never;
6578
- post?: never;
6579
6509
  delete?: never;
6580
6510
  options?: never;
6581
6511
  head?: never;
6582
6512
  patch?: never;
6583
6513
  trace?: never;
6584
6514
  };
6585
- "/installations": {
6515
+ "/folderItems/{id}": {
6586
6516
  parameters: {
6587
6517
  query?: never;
6588
6518
  header?: never;
@@ -6590,31 +6520,31 @@ export interface paths {
6590
6520
  cookie?: never;
6591
6521
  };
6592
6522
  /**
6593
- * Get multiple installations.
6594
- * @description Retrieves multiple installations by available filters, or without if applicable.
6523
+ * Get single folderItem.
6524
+ * @description Retrieves single folderItem by id.
6595
6525
  */
6596
6526
  get: {
6597
6527
  parameters: {
6598
6528
  query?: {
6599
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6600
- "page[cursor]"?: string;
6601
6529
  /**
6602
- * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory, owners
6603
- * @example offlineInventory
6530
+ * @description Allows the client to customize which related resources should be returned. Available options: owners, parent, subject
6531
+ * @example parent.children.subject
6604
6532
  */
6605
6533
  include?: string[];
6606
- /** @description Client-provided installation identifier to filter by (e.g. `a468bee88def`) */
6607
- "filter[clientProvidedInstallationId]"?: string[];
6608
- /** @description User ID to filter by. Use `me` for the authenticated user */
6609
- "filter[owners.id]"?: string[];
6610
6534
  /**
6611
- * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory
6612
- * @example offlineInventory
6535
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: parent.children.subject
6536
+ * @example parent.children.subject
6613
6537
  */
6614
6538
  replaceMedia?: string;
6615
6539
  };
6616
6540
  header?: never;
6617
- path?: never;
6541
+ path: {
6542
+ /**
6543
+ * @description Folder item id
6544
+ * @example 2rXZ4nCfhMEyHXeuVHyGxLTkKDrxJZmDsPmSpYAvpBqNtLKe
6545
+ */
6546
+ id: string;
6547
+ };
6618
6548
  cookie?: never;
6619
6549
  };
6620
6550
  requestBody?: never;
@@ -6625,7 +6555,7 @@ export interface paths {
6625
6555
  [name: string]: unknown;
6626
6556
  };
6627
6557
  content: {
6628
- "application/vnd.api+json": components["schemas"]["Installations_Multi_Resource_Data_Document"];
6558
+ "application/vnd.api+json": components["schemas"]["FolderItems_Single_Resource_Data_Document"];
6629
6559
  };
6630
6560
  };
6631
6561
  400: components["responses"]["Default400Response"];
@@ -6639,33 +6569,36 @@ export interface paths {
6639
6569
  };
6640
6570
  };
6641
6571
  put?: never;
6572
+ post?: never;
6642
6573
  /**
6643
- * Create single installation.
6644
- * @description Creates a new installation.
6574
+ * Delete single folderItem.
6575
+ * @description Deletes existing folderItem.
6645
6576
  */
6646
- post: {
6577
+ delete: {
6647
6578
  parameters: {
6648
6579
  query?: never;
6649
6580
  header?: {
6650
6581
  /** @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. */
6651
6582
  "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
6652
6583
  };
6653
- path?: never;
6654
- cookie?: never;
6655
- };
6656
- requestBody?: {
6657
- content: {
6658
- "application/vnd.api+json": components["schemas"]["InstallationsCreateOperation_Payload"];
6584
+ path: {
6585
+ /**
6586
+ * @description Folder item id
6587
+ * @example 2rXZ4nCfhMEyHXeuVHyGxLTkKDrxJZmDsPmSpYAvpBqNtLKe
6588
+ */
6589
+ id: string;
6659
6590
  };
6591
+ cookie?: never;
6660
6592
  };
6593
+ requestBody?: never;
6661
6594
  responses: {
6662
6595
  /** @description Successful response */
6663
- 201: {
6596
+ 200: {
6664
6597
  headers: {
6665
6598
  [name: string]: unknown;
6666
6599
  };
6667
6600
  content: {
6668
- "application/vnd.api+json": components["schemas"]["Installations_Create_Single_Resource_Data_Document"];
6601
+ "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"];
6669
6602
  };
6670
6603
  };
6671
6604
  400: components["responses"]["Default400Response"];
@@ -6680,13 +6613,12 @@ export interface paths {
6680
6613
  503: components["responses"]["Default503Response"];
6681
6614
  };
6682
6615
  };
6683
- delete?: never;
6684
6616
  options?: never;
6685
6617
  head?: never;
6686
6618
  patch?: never;
6687
6619
  trace?: never;
6688
6620
  };
6689
- "/installations/{id}": {
6621
+ "/folderItems/{id}/relationships/owners": {
6690
6622
  parameters: {
6691
6623
  query?: never;
6692
6624
  header?: never;
@@ -6694,28 +6626,25 @@ export interface paths {
6694
6626
  cookie?: never;
6695
6627
  };
6696
6628
  /**
6697
- * Get single installation.
6698
- * @description Retrieves single installation by id.
6629
+ * Get owners relationship ("to-many").
6630
+ * @description Retrieves owners relationship.
6699
6631
  */
6700
6632
  get: {
6701
6633
  parameters: {
6702
6634
  query?: {
6703
6635
  /**
6704
- * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory, owners
6705
- * @example offlineInventory
6636
+ * @description Allows the client to customize which related resources should be returned. Available options: owners
6637
+ * @example owners
6706
6638
  */
6707
6639
  include?: string[];
6708
- /**
6709
- * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory
6710
- * @example offlineInventory
6711
- */
6712
- replaceMedia?: string;
6640
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6641
+ "page[cursor]"?: string;
6713
6642
  };
6714
6643
  header?: never;
6715
6644
  path: {
6716
6645
  /**
6717
- * @description Installation id
6718
- * @example a468bee88def
6646
+ * @description Folder item id
6647
+ * @example 2rXZ4nCfhMEyHXeuVHyGxLTkKDrxJZmDsPmSpYAvpBqNtLKe
6719
6648
  */
6720
6649
  id: string;
6721
6650
  };
@@ -6729,7 +6658,7 @@ export interface paths {
6729
6658
  [name: string]: unknown;
6730
6659
  };
6731
6660
  content: {
6732
- "application/vnd.api+json": components["schemas"]["Installations_Single_Resource_Data_Document"];
6661
+ "application/vnd.api+json": components["schemas"]["FolderItems_Owners_Multi_Relationship_Data_Document"];
6733
6662
  };
6734
6663
  };
6735
6664
  400: components["responses"]["Default400Response"];
@@ -6750,7 +6679,7 @@ export interface paths {
6750
6679
  patch?: never;
6751
6680
  trace?: never;
6752
6681
  };
6753
- "/installations/{id}/relationships/offlineInventory": {
6682
+ "/folderItems/{id}/relationships/parent": {
6754
6683
  parameters: {
6755
6684
  query?: never;
6756
6685
  header?: never;
@@ -6758,36 +6687,28 @@ export interface paths {
6758
6687
  cookie?: never;
6759
6688
  };
6760
6689
  /**
6761
- * Get offlineInventory relationship ("to-many").
6762
- * @description Retrieves offlineInventory relationship.
6690
+ * Get parent relationship ("to-one").
6691
+ * @description Retrieves parent relationship.
6763
6692
  */
6764
6693
  get: {
6765
6694
  parameters: {
6766
- query: {
6767
- /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */
6768
- "filter[type]": ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[];
6769
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6770
- "page[cursor]"?: string;
6695
+ query?: {
6771
6696
  /**
6772
- * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory
6773
- * @example offlineInventory
6697
+ * @description Allows the client to customize which related resources should be returned. Available options: parent
6698
+ * @example parent.children.subject
6774
6699
  */
6775
6700
  include?: string[];
6776
- /** @description Offline item id (e.g. `1234`) */
6777
- "filter[id]"?: string[];
6778
- /** @description One of: PENDING, STORED, FAILED (e.g. `PENDING`) */
6779
- "filter[state]"?: ("PENDING" | "STORED" | "FAILED")[];
6780
6701
  /**
6781
- * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory
6782
- * @example offlineInventory
6702
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: parent.children.subject
6703
+ * @example parent.children.subject
6783
6704
  */
6784
6705
  replaceMedia?: string;
6785
6706
  };
6786
6707
  header?: never;
6787
6708
  path: {
6788
6709
  /**
6789
- * @description Installation id
6790
- * @example a468bee88def
6710
+ * @description Folder item id
6711
+ * @example 2rXZ4nCfhMEyHXeuVHyGxLTkKDrxJZmDsPmSpYAvpBqNtLKe
6791
6712
  */
6792
6713
  id: string;
6793
6714
  };
@@ -6801,7 +6722,7 @@ export interface paths {
6801
6722
  [name: string]: unknown;
6802
6723
  };
6803
6724
  content: {
6804
- "application/vnd.api+json": components["schemas"]["Installations_OfflineInventory_Multi_Relationship_Data_Document"];
6725
+ "application/vnd.api+json": components["schemas"]["FolderItems_Parent_Single_Relationship_Data_Document"];
6805
6726
  };
6806
6727
  };
6807
6728
  400: components["responses"]["Default400Response"];
@@ -6815,11 +6736,15 @@ export interface paths {
6815
6736
  };
6816
6737
  };
6817
6738
  put?: never;
6739
+ post?: never;
6740
+ delete?: never;
6741
+ options?: never;
6742
+ head?: never;
6818
6743
  /**
6819
- * Add to offlineInventory relationship ("to-many").
6820
- * @description Adds item(s) to offlineInventory relationship.
6744
+ * Update parent relationship ("to-one").
6745
+ * @description Updates parent relationship.
6821
6746
  */
6822
- post: {
6747
+ patch: {
6823
6748
  parameters: {
6824
6749
  query?: never;
6825
6750
  header?: {
@@ -6828,8 +6753,8 @@ export interface paths {
6828
6753
  };
6829
6754
  path: {
6830
6755
  /**
6831
- * @description Installation id
6832
- * @example a468bee88def
6756
+ * @description Folder item id
6757
+ * @example 2rXZ4nCfhMEyHXeuVHyGxLTkKDrxJZmDsPmSpYAvpBqNtLKe
6833
6758
  */
6834
6759
  id: string;
6835
6760
  };
@@ -6837,7 +6762,7 @@ export interface paths {
6837
6762
  };
6838
6763
  requestBody?: {
6839
6764
  content: {
6840
- "application/vnd.api+json": components["schemas"]["InstallationsOfflineInventoryRelationshipAddOperation_Payload"];
6765
+ "application/vnd.api+json": components["schemas"]["FolderItemsParentRelationshipUpdateOperation_Payload"];
6841
6766
  };
6842
6767
  };
6843
6768
  responses: {
@@ -6847,10 +6772,10 @@ export interface paths {
6847
6772
  [name: string]: unknown;
6848
6773
  };
6849
6774
  content: {
6850
- "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"];
6775
+ "application/vnd.api+json": components["schemas"]["FolderItems_Parent_Update_Single_Relationship_Data_Document"];
6851
6776
  };
6852
6777
  };
6853
- 400: components["responses"]["Default400Response"];
6778
+ 400: components["responses"]["FolderItemsUpdateSingleDataRelationship400Response"];
6854
6779
  404: components["responses"]["Default404Response"];
6855
6780
  405: components["responses"]["Default405Response"];
6856
6781
  406: components["responses"]["Default406Response"];
@@ -6862,31 +6787,44 @@ export interface paths {
6862
6787
  503: components["responses"]["Default503Response"];
6863
6788
  };
6864
6789
  };
6790
+ trace?: never;
6791
+ };
6792
+ "/folderItems/{id}/relationships/subject": {
6793
+ parameters: {
6794
+ query?: never;
6795
+ header?: never;
6796
+ path?: never;
6797
+ cookie?: never;
6798
+ };
6865
6799
  /**
6866
- * Delete from offlineInventory relationship ("to-many").
6867
- * @description Deletes item(s) from offlineInventory relationship.
6800
+ * Get subject relationship ("to-one").
6801
+ * @description Retrieves subject relationship.
6868
6802
  */
6869
- delete: {
6803
+ get: {
6870
6804
  parameters: {
6871
- query?: never;
6872
- header?: {
6873
- /** @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. */
6874
- "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
6805
+ query?: {
6806
+ /**
6807
+ * @description Allows the client to customize which related resources should be returned. Available options: subject
6808
+ * @example subject
6809
+ */
6810
+ include?: string[];
6811
+ /**
6812
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject
6813
+ * @example subject
6814
+ */
6815
+ replaceMedia?: string;
6875
6816
  };
6817
+ header?: never;
6876
6818
  path: {
6877
6819
  /**
6878
- * @description Installation id
6879
- * @example a468bee88def
6820
+ * @description Folder item id
6821
+ * @example 2rXZ4nCfhMEyHXeuVHyGxLTkKDrxJZmDsPmSpYAvpBqNtLKe
6880
6822
  */
6881
6823
  id: string;
6882
6824
  };
6883
6825
  cookie?: never;
6884
6826
  };
6885
- requestBody?: {
6886
- content: {
6887
- "application/vnd.api+json": components["schemas"]["InstallationsOfflineInventoryRelationshipRemoveOperation_Payload"];
6888
- };
6889
- };
6827
+ requestBody?: never;
6890
6828
  responses: {
6891
6829
  /** @description Successful response */
6892
6830
  200: {
@@ -6894,50 +6832,834 @@ export interface paths {
6894
6832
  [name: string]: unknown;
6895
6833
  };
6896
6834
  content: {
6897
- "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"];
6835
+ "application/vnd.api+json": components["schemas"]["FolderItems_Subject_Single_Relationship_Data_Document"];
6898
6836
  };
6899
6837
  };
6900
6838
  400: components["responses"]["Default400Response"];
6901
6839
  404: components["responses"]["Default404Response"];
6902
6840
  405: components["responses"]["Default405Response"];
6903
6841
  406: components["responses"]["Default406Response"];
6904
- 409: components["responses"]["Idempotency409Response"];
6905
6842
  415: components["responses"]["Default415Response"];
6906
- 422: components["responses"]["Idempotency422Response"];
6907
6843
  429: components["responses"]["Default429Response"];
6908
6844
  500: components["responses"]["Default500Response"];
6909
6845
  503: components["responses"]["Default503Response"];
6910
6846
  };
6911
6847
  };
6848
+ put?: never;
6849
+ post?: never;
6850
+ delete?: never;
6912
6851
  options?: never;
6913
6852
  head?: never;
6914
6853
  patch?: never;
6915
6854
  trace?: never;
6916
6855
  };
6917
- "/installations/{id}/relationships/owners": {
6856
+ "/folders": {
6918
6857
  parameters: {
6919
6858
  query?: never;
6920
6859
  header?: never;
6921
6860
  path?: never;
6922
6861
  cookie?: never;
6923
6862
  };
6863
+ get?: never;
6864
+ put?: never;
6924
6865
  /**
6925
- * Get owners relationship ("to-many").
6926
- * @description Retrieves owners relationship.
6866
+ * Create single folder.
6867
+ * @description Creates a new folder.
6927
6868
  */
6928
- get: {
6869
+ post: {
6929
6870
  parameters: {
6930
- query?: {
6931
- /**
6932
- * @description Allows the client to customize which related resources should be returned. Available options: owners
6933
- * @example owners
6934
- */
6935
- include?: string[];
6936
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6937
- "page[cursor]"?: string;
6938
- };
6939
- header?: never;
6940
- path: {
6871
+ query?: never;
6872
+ header?: {
6873
+ /** @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. */
6874
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
6875
+ };
6876
+ path?: never;
6877
+ cookie?: never;
6878
+ };
6879
+ requestBody?: {
6880
+ content: {
6881
+ "application/vnd.api+json": components["schemas"]["FoldersCreateOperation_Payload"];
6882
+ };
6883
+ };
6884
+ responses: {
6885
+ /** @description Successful response */
6886
+ 201: {
6887
+ headers: {
6888
+ [name: string]: unknown;
6889
+ };
6890
+ content: {
6891
+ "application/vnd.api+json": components["schemas"]["Folders_Create_Single_Resource_Data_Document"];
6892
+ };
6893
+ };
6894
+ 400: components["responses"]["Default400Response"];
6895
+ 404: components["responses"]["Default404Response"];
6896
+ 405: components["responses"]["Default405Response"];
6897
+ 406: components["responses"]["Default406Response"];
6898
+ 409: components["responses"]["Idempotency409Response"];
6899
+ 415: components["responses"]["Default415Response"];
6900
+ 422: components["responses"]["Idempotency422Response"];
6901
+ 429: components["responses"]["Default429Response"];
6902
+ 500: components["responses"]["Default500Response"];
6903
+ 503: components["responses"]["Default503Response"];
6904
+ };
6905
+ };
6906
+ delete?: never;
6907
+ options?: never;
6908
+ head?: never;
6909
+ patch?: never;
6910
+ trace?: never;
6911
+ };
6912
+ "/folders/{id}": {
6913
+ parameters: {
6914
+ query?: never;
6915
+ header?: never;
6916
+ path?: never;
6917
+ cookie?: never;
6918
+ };
6919
+ /**
6920
+ * Get single folder.
6921
+ * @description Retrieves single folder by id.
6922
+ */
6923
+ get: {
6924
+ parameters: {
6925
+ query?: {
6926
+ /**
6927
+ * @description Allows the client to customize which related resources should be returned. Available options: children, owners
6928
+ * @example children.subject
6929
+ */
6930
+ include?: string[];
6931
+ /**
6932
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: children.subject
6933
+ * @example children.subject
6934
+ */
6935
+ replaceMedia?: string;
6936
+ };
6937
+ header?: never;
6938
+ path: {
6939
+ /**
6940
+ * @description Folder id. Use `me` for the authenticated user's resource
6941
+ * @example me
6942
+ */
6943
+ id: string;
6944
+ };
6945
+ cookie?: never;
6946
+ };
6947
+ requestBody?: never;
6948
+ responses: {
6949
+ /** @description Successful response */
6950
+ 200: {
6951
+ headers: {
6952
+ [name: string]: unknown;
6953
+ };
6954
+ content: {
6955
+ "application/vnd.api+json": components["schemas"]["Folders_Single_Resource_Data_Document"];
6956
+ };
6957
+ };
6958
+ 400: components["responses"]["Default400Response"];
6959
+ 404: components["responses"]["Default404Response"];
6960
+ 405: components["responses"]["Default405Response"];
6961
+ 406: components["responses"]["Default406Response"];
6962
+ 415: components["responses"]["Default415Response"];
6963
+ 429: components["responses"]["Default429Response"];
6964
+ 500: components["responses"]["Default500Response"];
6965
+ 503: components["responses"]["Default503Response"];
6966
+ };
6967
+ };
6968
+ put?: never;
6969
+ post?: never;
6970
+ /**
6971
+ * Delete single folder.
6972
+ * @description Deletes existing folder.
6973
+ */
6974
+ delete: {
6975
+ parameters: {
6976
+ query?: never;
6977
+ header?: {
6978
+ /** @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. */
6979
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
6980
+ };
6981
+ path: {
6982
+ /**
6983
+ * @description Folder id. Use `me` for the authenticated user's resource
6984
+ * @example me
6985
+ */
6986
+ id: string;
6987
+ };
6988
+ cookie?: never;
6989
+ };
6990
+ requestBody?: never;
6991
+ responses: {
6992
+ /** @description Successful response */
6993
+ 200: {
6994
+ headers: {
6995
+ [name: string]: unknown;
6996
+ };
6997
+ content: {
6998
+ "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"];
6999
+ };
7000
+ };
7001
+ 400: components["responses"]["FoldersDeleteResource400Response"];
7002
+ 404: components["responses"]["Default404Response"];
7003
+ 405: components["responses"]["Default405Response"];
7004
+ 406: components["responses"]["Default406Response"];
7005
+ 409: components["responses"]["Idempotency409Response"];
7006
+ 415: components["responses"]["Default415Response"];
7007
+ 422: components["responses"]["Idempotency422Response"];
7008
+ 429: components["responses"]["Default429Response"];
7009
+ 500: components["responses"]["Default500Response"];
7010
+ 503: components["responses"]["Default503Response"];
7011
+ };
7012
+ };
7013
+ options?: never;
7014
+ head?: never;
7015
+ /**
7016
+ * Update single folder.
7017
+ * @description Updates existing folder.
7018
+ */
7019
+ patch: {
7020
+ parameters: {
7021
+ query?: never;
7022
+ header?: {
7023
+ /** @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. */
7024
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
7025
+ };
7026
+ path: {
7027
+ /**
7028
+ * @description Folder id. Use `me` for the authenticated user's resource
7029
+ * @example me
7030
+ */
7031
+ id: string;
7032
+ };
7033
+ cookie?: never;
7034
+ };
7035
+ requestBody?: {
7036
+ content: {
7037
+ "application/vnd.api+json": components["schemas"]["FoldersUpdateOperation_Payload"];
7038
+ };
7039
+ };
7040
+ responses: {
7041
+ /** @description Successful response */
7042
+ 200: {
7043
+ headers: {
7044
+ [name: string]: unknown;
7045
+ };
7046
+ content: {
7047
+ "application/vnd.api+json": components["schemas"]["Folders_Update_Single_Resource_Data_Document"];
7048
+ };
7049
+ };
7050
+ 400: components["responses"]["FoldersUpdateResource400Response"];
7051
+ 404: components["responses"]["Default404Response"];
7052
+ 405: components["responses"]["Default405Response"];
7053
+ 406: components["responses"]["Default406Response"];
7054
+ 409: components["responses"]["Idempotency409Response"];
7055
+ 415: components["responses"]["Default415Response"];
7056
+ 422: components["responses"]["Idempotency422Response"];
7057
+ 429: components["responses"]["Default429Response"];
7058
+ 500: components["responses"]["Default500Response"];
7059
+ 503: components["responses"]["Default503Response"];
7060
+ };
7061
+ };
7062
+ trace?: never;
7063
+ };
7064
+ "/folders/{id}/relationships/children": {
7065
+ parameters: {
7066
+ query?: never;
7067
+ header?: never;
7068
+ path?: never;
7069
+ cookie?: never;
7070
+ };
7071
+ /**
7072
+ * Get children relationship ("to-many").
7073
+ * @description Retrieves children relationship.
7074
+ */
7075
+ get: {
7076
+ parameters: {
7077
+ query?: {
7078
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
7079
+ "page[cursor]"?: string;
7080
+ /**
7081
+ * @description Allows the client to customize which related resources should be returned. Available options: children
7082
+ * @example children.subject
7083
+ */
7084
+ include?: string[];
7085
+ /**
7086
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: children.subject
7087
+ * @example children.subject
7088
+ */
7089
+ replaceMedia?: string;
7090
+ };
7091
+ header?: never;
7092
+ path: {
7093
+ /**
7094
+ * @description Folder id. Use `me` for the authenticated user's resource
7095
+ * @example me
7096
+ */
7097
+ id: string;
7098
+ };
7099
+ cookie?: never;
7100
+ };
7101
+ requestBody?: never;
7102
+ responses: {
7103
+ /** @description Successful response */
7104
+ 200: {
7105
+ headers: {
7106
+ [name: string]: unknown;
7107
+ };
7108
+ content: {
7109
+ "application/vnd.api+json": components["schemas"]["Folders_Children_Multi_Relationship_Data_Document"];
7110
+ };
7111
+ };
7112
+ 400: components["responses"]["Default400Response"];
7113
+ 404: components["responses"]["Default404Response"];
7114
+ 405: components["responses"]["Default405Response"];
7115
+ 406: components["responses"]["Default406Response"];
7116
+ 415: components["responses"]["Default415Response"];
7117
+ 429: components["responses"]["Default429Response"];
7118
+ 500: components["responses"]["Default500Response"];
7119
+ 503: components["responses"]["Default503Response"];
7120
+ };
7121
+ };
7122
+ put?: never;
7123
+ post?: never;
7124
+ delete?: never;
7125
+ options?: never;
7126
+ head?: never;
7127
+ patch?: never;
7128
+ trace?: never;
7129
+ };
7130
+ "/folders/{id}/relationships/owners": {
7131
+ parameters: {
7132
+ query?: never;
7133
+ header?: never;
7134
+ path?: never;
7135
+ cookie?: never;
7136
+ };
7137
+ /**
7138
+ * Get owners relationship ("to-many").
7139
+ * @description Retrieves owners relationship.
7140
+ */
7141
+ get: {
7142
+ parameters: {
7143
+ query?: {
7144
+ /**
7145
+ * @description Allows the client to customize which related resources should be returned. Available options: owners
7146
+ * @example owners
7147
+ */
7148
+ include?: string[];
7149
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
7150
+ "page[cursor]"?: string;
7151
+ };
7152
+ header?: never;
7153
+ path: {
7154
+ /**
7155
+ * @description Folder id. Use `me` for the authenticated user's resource
7156
+ * @example me
7157
+ */
7158
+ id: string;
7159
+ };
7160
+ cookie?: never;
7161
+ };
7162
+ requestBody?: never;
7163
+ responses: {
7164
+ /** @description Successful response */
7165
+ 200: {
7166
+ headers: {
7167
+ [name: string]: unknown;
7168
+ };
7169
+ content: {
7170
+ "application/vnd.api+json": components["schemas"]["Folders_Owners_Multi_Relationship_Data_Document"];
7171
+ };
7172
+ };
7173
+ 400: components["responses"]["Default400Response"];
7174
+ 404: components["responses"]["Default404Response"];
7175
+ 405: components["responses"]["Default405Response"];
7176
+ 406: components["responses"]["Default406Response"];
7177
+ 415: components["responses"]["Default415Response"];
7178
+ 429: components["responses"]["Default429Response"];
7179
+ 500: components["responses"]["Default500Response"];
7180
+ 503: components["responses"]["Default503Response"];
7181
+ };
7182
+ };
7183
+ put?: never;
7184
+ post?: never;
7185
+ delete?: never;
7186
+ options?: never;
7187
+ head?: never;
7188
+ patch?: never;
7189
+ trace?: never;
7190
+ };
7191
+ "/genres": {
7192
+ parameters: {
7193
+ query?: never;
7194
+ header?: never;
7195
+ path?: never;
7196
+ cookie?: never;
7197
+ };
7198
+ /**
7199
+ * Get multiple genres.
7200
+ * @description Retrieves multiple genres by available filters, or without if applicable.
7201
+ */
7202
+ get: {
7203
+ parameters: {
7204
+ query: {
7205
+ /** @description Allows filtering by genre id(s). USER_SELECTABLE is special value used to return specific genres which users can select from (e.g. `'1,2,3' or 'USER_SELECTABLE'`) */
7206
+ "filter[id]": string[];
7207
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
7208
+ "page[cursor]"?: string;
7209
+ /**
7210
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
7211
+ * @example en-US
7212
+ */
7213
+ locale?: string;
7214
+ };
7215
+ header?: never;
7216
+ path?: never;
7217
+ cookie?: never;
7218
+ };
7219
+ requestBody?: never;
7220
+ responses: {
7221
+ /** @description Successful response */
7222
+ 200: {
7223
+ headers: {
7224
+ [name: string]: unknown;
7225
+ };
7226
+ content: {
7227
+ "application/vnd.api+json": components["schemas"]["Genres_Multi_Resource_Data_Document"];
7228
+ };
7229
+ };
7230
+ 400: components["responses"]["Default400Response"];
7231
+ 404: components["responses"]["Default404Response"];
7232
+ 405: components["responses"]["Default405Response"];
7233
+ 406: components["responses"]["Default406Response"];
7234
+ 415: components["responses"]["Default415Response"];
7235
+ 429: components["responses"]["Default429Response"];
7236
+ 500: components["responses"]["Default500Response"];
7237
+ 503: components["responses"]["Default503Response"];
7238
+ };
7239
+ };
7240
+ put?: never;
7241
+ post?: never;
7242
+ delete?: never;
7243
+ options?: never;
7244
+ head?: never;
7245
+ patch?: never;
7246
+ trace?: never;
7247
+ };
7248
+ "/genres/{id}": {
7249
+ parameters: {
7250
+ query?: never;
7251
+ header?: never;
7252
+ path?: never;
7253
+ cookie?: never;
7254
+ };
7255
+ /**
7256
+ * Get single genre.
7257
+ * @description Retrieves single genre by id.
7258
+ */
7259
+ get: {
7260
+ parameters: {
7261
+ query?: {
7262
+ /**
7263
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
7264
+ * @example en-US
7265
+ */
7266
+ locale?: string;
7267
+ };
7268
+ header?: never;
7269
+ path: {
7270
+ /**
7271
+ * @description Genre id
7272
+ * @example 123
7273
+ */
7274
+ id: string;
7275
+ };
7276
+ cookie?: never;
7277
+ };
7278
+ requestBody?: never;
7279
+ responses: {
7280
+ /** @description Successful response */
7281
+ 200: {
7282
+ headers: {
7283
+ [name: string]: unknown;
7284
+ };
7285
+ content: {
7286
+ "application/vnd.api+json": components["schemas"]["Genres_Single_Resource_Data_Document"];
7287
+ };
7288
+ };
7289
+ 400: components["responses"]["Default400Response"];
7290
+ 404: components["responses"]["Default404Response"];
7291
+ 405: components["responses"]["Default405Response"];
7292
+ 406: components["responses"]["Default406Response"];
7293
+ 415: components["responses"]["Default415Response"];
7294
+ 429: components["responses"]["Default429Response"];
7295
+ 500: components["responses"]["Default500Response"];
7296
+ 503: components["responses"]["Default503Response"];
7297
+ };
7298
+ };
7299
+ put?: never;
7300
+ post?: never;
7301
+ delete?: never;
7302
+ options?: never;
7303
+ head?: never;
7304
+ patch?: never;
7305
+ trace?: never;
7306
+ };
7307
+ "/installations": {
7308
+ parameters: {
7309
+ query?: never;
7310
+ header?: never;
7311
+ path?: never;
7312
+ cookie?: never;
7313
+ };
7314
+ /**
7315
+ * Get multiple installations.
7316
+ * @description Retrieves multiple installations by available filters, or without if applicable.
7317
+ */
7318
+ get: {
7319
+ parameters: {
7320
+ query?: {
7321
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
7322
+ "page[cursor]"?: string;
7323
+ /**
7324
+ * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory, owners
7325
+ * @example offlineInventory
7326
+ */
7327
+ include?: string[];
7328
+ /** @description Client-provided installation identifier to filter by (e.g. `a468bee88def`) */
7329
+ "filter[clientProvidedInstallationId]"?: string[];
7330
+ /** @description User ID to filter by. Use `me` for the authenticated user */
7331
+ "filter[owners.id]"?: string[];
7332
+ /**
7333
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory
7334
+ * @example offlineInventory
7335
+ */
7336
+ replaceMedia?: string;
7337
+ };
7338
+ header?: never;
7339
+ path?: never;
7340
+ cookie?: never;
7341
+ };
7342
+ requestBody?: never;
7343
+ responses: {
7344
+ /** @description Successful response */
7345
+ 200: {
7346
+ headers: {
7347
+ [name: string]: unknown;
7348
+ };
7349
+ content: {
7350
+ "application/vnd.api+json": components["schemas"]["Installations_Multi_Resource_Data_Document"];
7351
+ };
7352
+ };
7353
+ 400: components["responses"]["Default400Response"];
7354
+ 404: components["responses"]["Default404Response"];
7355
+ 405: components["responses"]["Default405Response"];
7356
+ 406: components["responses"]["Default406Response"];
7357
+ 415: components["responses"]["Default415Response"];
7358
+ 429: components["responses"]["Default429Response"];
7359
+ 500: components["responses"]["Default500Response"];
7360
+ 503: components["responses"]["Default503Response"];
7361
+ };
7362
+ };
7363
+ put?: never;
7364
+ /**
7365
+ * Create single installation.
7366
+ * @description Creates a new installation.
7367
+ */
7368
+ post: {
7369
+ parameters: {
7370
+ query?: never;
7371
+ header?: {
7372
+ /** @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. */
7373
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
7374
+ };
7375
+ path?: never;
7376
+ cookie?: never;
7377
+ };
7378
+ requestBody?: {
7379
+ content: {
7380
+ "application/vnd.api+json": components["schemas"]["InstallationsCreateOperation_Payload"];
7381
+ };
7382
+ };
7383
+ responses: {
7384
+ /** @description Successful response */
7385
+ 201: {
7386
+ headers: {
7387
+ [name: string]: unknown;
7388
+ };
7389
+ content: {
7390
+ "application/vnd.api+json": components["schemas"]["Installations_Create_Single_Resource_Data_Document"];
7391
+ };
7392
+ };
7393
+ 400: components["responses"]["Default400Response"];
7394
+ 404: components["responses"]["Default404Response"];
7395
+ 405: components["responses"]["Default405Response"];
7396
+ 406: components["responses"]["Default406Response"];
7397
+ 409: components["responses"]["Idempotency409Response"];
7398
+ 415: components["responses"]["Default415Response"];
7399
+ 422: components["responses"]["Idempotency422Response"];
7400
+ 429: components["responses"]["Default429Response"];
7401
+ 500: components["responses"]["Default500Response"];
7402
+ 503: components["responses"]["Default503Response"];
7403
+ };
7404
+ };
7405
+ delete?: never;
7406
+ options?: never;
7407
+ head?: never;
7408
+ patch?: never;
7409
+ trace?: never;
7410
+ };
7411
+ "/installations/{id}": {
7412
+ parameters: {
7413
+ query?: never;
7414
+ header?: never;
7415
+ path?: never;
7416
+ cookie?: never;
7417
+ };
7418
+ /**
7419
+ * Get single installation.
7420
+ * @description Retrieves single installation by id.
7421
+ */
7422
+ get: {
7423
+ parameters: {
7424
+ query?: {
7425
+ /**
7426
+ * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory, owners
7427
+ * @example offlineInventory
7428
+ */
7429
+ include?: string[];
7430
+ /**
7431
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory
7432
+ * @example offlineInventory
7433
+ */
7434
+ replaceMedia?: string;
7435
+ };
7436
+ header?: never;
7437
+ path: {
7438
+ /**
7439
+ * @description Installation id
7440
+ * @example a468bee88def
7441
+ */
7442
+ id: string;
7443
+ };
7444
+ cookie?: never;
7445
+ };
7446
+ requestBody?: never;
7447
+ responses: {
7448
+ /** @description Successful response */
7449
+ 200: {
7450
+ headers: {
7451
+ [name: string]: unknown;
7452
+ };
7453
+ content: {
7454
+ "application/vnd.api+json": components["schemas"]["Installations_Single_Resource_Data_Document"];
7455
+ };
7456
+ };
7457
+ 400: components["responses"]["Default400Response"];
7458
+ 404: components["responses"]["Default404Response"];
7459
+ 405: components["responses"]["Default405Response"];
7460
+ 406: components["responses"]["Default406Response"];
7461
+ 415: components["responses"]["Default415Response"];
7462
+ 429: components["responses"]["Default429Response"];
7463
+ 500: components["responses"]["Default500Response"];
7464
+ 503: components["responses"]["Default503Response"];
7465
+ };
7466
+ };
7467
+ put?: never;
7468
+ post?: never;
7469
+ delete?: never;
7470
+ options?: never;
7471
+ head?: never;
7472
+ patch?: never;
7473
+ trace?: never;
7474
+ };
7475
+ "/installations/{id}/relationships/offlineInventory": {
7476
+ parameters: {
7477
+ query?: never;
7478
+ header?: never;
7479
+ path?: never;
7480
+ cookie?: never;
7481
+ };
7482
+ /**
7483
+ * Get offlineInventory relationship ("to-many").
7484
+ * @description Retrieves offlineInventory relationship.
7485
+ */
7486
+ get: {
7487
+ parameters: {
7488
+ query: {
7489
+ /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */
7490
+ "filter[type]": ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[];
7491
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
7492
+ "page[cursor]"?: string;
7493
+ /**
7494
+ * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory
7495
+ * @example offlineInventory
7496
+ */
7497
+ include?: string[];
7498
+ /** @description Offline item id (e.g. `1234`) */
7499
+ "filter[id]"?: string[];
7500
+ /** @description One of: PENDING, STORED, FAILED (e.g. `PENDING`) */
7501
+ "filter[state]"?: ("PENDING" | "STORED" | "FAILED")[];
7502
+ /**
7503
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory
7504
+ * @example offlineInventory
7505
+ */
7506
+ replaceMedia?: string;
7507
+ };
7508
+ header?: never;
7509
+ path: {
7510
+ /**
7511
+ * @description Installation id
7512
+ * @example a468bee88def
7513
+ */
7514
+ id: string;
7515
+ };
7516
+ cookie?: never;
7517
+ };
7518
+ requestBody?: never;
7519
+ responses: {
7520
+ /** @description Successful response */
7521
+ 200: {
7522
+ headers: {
7523
+ [name: string]: unknown;
7524
+ };
7525
+ content: {
7526
+ "application/vnd.api+json": components["schemas"]["Installations_OfflineInventory_Multi_Relationship_Data_Document"];
7527
+ };
7528
+ };
7529
+ 400: components["responses"]["Default400Response"];
7530
+ 404: components["responses"]["Default404Response"];
7531
+ 405: components["responses"]["Default405Response"];
7532
+ 406: components["responses"]["Default406Response"];
7533
+ 415: components["responses"]["Default415Response"];
7534
+ 429: components["responses"]["Default429Response"];
7535
+ 500: components["responses"]["Default500Response"];
7536
+ 503: components["responses"]["Default503Response"];
7537
+ };
7538
+ };
7539
+ put?: never;
7540
+ /**
7541
+ * Add to offlineInventory relationship ("to-many").
7542
+ * @description Adds item(s) to offlineInventory relationship.
7543
+ */
7544
+ post: {
7545
+ parameters: {
7546
+ query?: never;
7547
+ header?: {
7548
+ /** @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. */
7549
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
7550
+ };
7551
+ path: {
7552
+ /**
7553
+ * @description Installation id
7554
+ * @example a468bee88def
7555
+ */
7556
+ id: string;
7557
+ };
7558
+ cookie?: never;
7559
+ };
7560
+ requestBody?: {
7561
+ content: {
7562
+ "application/vnd.api+json": components["schemas"]["InstallationsOfflineInventoryRelationshipAddOperation_Payload"];
7563
+ };
7564
+ };
7565
+ responses: {
7566
+ /** @description Successful response */
7567
+ 200: {
7568
+ headers: {
7569
+ [name: string]: unknown;
7570
+ };
7571
+ content: {
7572
+ "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"];
7573
+ };
7574
+ };
7575
+ 400: components["responses"]["Default400Response"];
7576
+ 404: components["responses"]["Default404Response"];
7577
+ 405: components["responses"]["Default405Response"];
7578
+ 406: components["responses"]["Default406Response"];
7579
+ 409: components["responses"]["Idempotency409Response"];
7580
+ 415: components["responses"]["Default415Response"];
7581
+ 422: components["responses"]["Idempotency422Response"];
7582
+ 429: components["responses"]["Default429Response"];
7583
+ 500: components["responses"]["Default500Response"];
7584
+ 503: components["responses"]["Default503Response"];
7585
+ };
7586
+ };
7587
+ /**
7588
+ * Delete from offlineInventory relationship ("to-many").
7589
+ * @description Deletes item(s) from offlineInventory relationship.
7590
+ */
7591
+ delete: {
7592
+ parameters: {
7593
+ query?: never;
7594
+ header?: {
7595
+ /** @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. */
7596
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
7597
+ };
7598
+ path: {
7599
+ /**
7600
+ * @description Installation id
7601
+ * @example a468bee88def
7602
+ */
7603
+ id: string;
7604
+ };
7605
+ cookie?: never;
7606
+ };
7607
+ requestBody?: {
7608
+ content: {
7609
+ "application/vnd.api+json": components["schemas"]["InstallationsOfflineInventoryRelationshipRemoveOperation_Payload"];
7610
+ };
7611
+ };
7612
+ responses: {
7613
+ /** @description Successful response */
7614
+ 200: {
7615
+ headers: {
7616
+ [name: string]: unknown;
7617
+ };
7618
+ content: {
7619
+ "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"];
7620
+ };
7621
+ };
7622
+ 400: components["responses"]["Default400Response"];
7623
+ 404: components["responses"]["Default404Response"];
7624
+ 405: components["responses"]["Default405Response"];
7625
+ 406: components["responses"]["Default406Response"];
7626
+ 409: components["responses"]["Idempotency409Response"];
7627
+ 415: components["responses"]["Default415Response"];
7628
+ 422: components["responses"]["Idempotency422Response"];
7629
+ 429: components["responses"]["Default429Response"];
7630
+ 500: components["responses"]["Default500Response"];
7631
+ 503: components["responses"]["Default503Response"];
7632
+ };
7633
+ };
7634
+ options?: never;
7635
+ head?: never;
7636
+ patch?: never;
7637
+ trace?: never;
7638
+ };
7639
+ "/installations/{id}/relationships/owners": {
7640
+ parameters: {
7641
+ query?: never;
7642
+ header?: never;
7643
+ path?: never;
7644
+ cookie?: never;
7645
+ };
7646
+ /**
7647
+ * Get owners relationship ("to-many").
7648
+ * @description Retrieves owners relationship.
7649
+ */
7650
+ get: {
7651
+ parameters: {
7652
+ query?: {
7653
+ /**
7654
+ * @description Allows the client to customize which related resources should be returned. Available options: owners
7655
+ * @example owners
7656
+ */
7657
+ include?: string[];
7658
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
7659
+ "page[cursor]"?: string;
7660
+ };
7661
+ header?: never;
7662
+ path: {
6941
7663
  /**
6942
7664
  * @description Installation id
6943
7665
  * @example a468bee88def
@@ -7197,11 +7919,6 @@ export interface paths {
7197
7919
  get: {
7198
7920
  parameters: {
7199
7921
  query?: {
7200
- /**
7201
- * @description ISO 3166-1 alpha-2 country code
7202
- * @example US
7203
- */
7204
- countryCode?: string;
7205
7922
  /**
7206
7923
  * @description Allows the client to customize which related resources should be returned. Available options: owners
7207
7924
  * @example owners
@@ -9276,84 +9993,37 @@ export interface paths {
9276
9993
  406: components["responses"]["Default406Response"];
9277
9994
  409: components["responses"]["Idempotency409Response"];
9278
9995
  415: components["responses"]["Default415Response"];
9279
- 422: components["responses"]["Idempotency422Response"];
9280
- 429: components["responses"]["Default429Response"];
9281
- 500: components["responses"]["Default500Response"];
9282
- 503: components["responses"]["Default503Response"];
9283
- };
9284
- };
9285
- trace?: never;
9286
- };
9287
- "/playlists/{id}/relationships/collaboratorProfiles": {
9288
- parameters: {
9289
- query?: never;
9290
- header?: never;
9291
- path?: never;
9292
- cookie?: never;
9293
- };
9294
- /**
9295
- * Get collaboratorProfiles relationship ("to-many").
9296
- * @description Retrieves collaboratorProfiles relationship.
9297
- */
9298
- get: {
9299
- parameters: {
9300
- query?: {
9301
- /**
9302
- * @description ISO 3166-1 alpha-2 country code
9303
- * @example US
9304
- */
9305
- countryCode?: string;
9306
- /**
9307
- * @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles
9308
- * @example collaboratorProfiles
9309
- */
9310
- include?: string[];
9311
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
9312
- "page[cursor]"?: string;
9313
- };
9314
- header?: never;
9315
- path: {
9316
- /**
9317
- * @description Playlist id
9318
- * @example 550e8400-e29b-41d4-a716-446655440000
9319
- */
9320
- id: string;
9321
- };
9322
- cookie?: never;
9323
- };
9324
- requestBody?: never;
9325
- responses: {
9326
- /** @description Successful response */
9327
- 200: {
9328
- headers: {
9329
- [name: string]: unknown;
9330
- };
9331
- content: {
9332
- "application/vnd.api+json": components["schemas"]["Playlists_CollaboratorProfiles_Multi_Relationship_Data_Document"];
9333
- };
9334
- };
9335
- 400: components["responses"]["Default400Response"];
9336
- 404: components["responses"]["Default404Response"];
9337
- 405: components["responses"]["Default405Response"];
9338
- 406: components["responses"]["Default406Response"];
9339
- 415: components["responses"]["Default415Response"];
9996
+ 422: components["responses"]["Idempotency422Response"];
9340
9997
  429: components["responses"]["Default429Response"];
9341
9998
  500: components["responses"]["Default500Response"];
9342
9999
  503: components["responses"]["Default503Response"];
9343
10000
  };
9344
10001
  };
9345
- put?: never;
10002
+ trace?: never;
10003
+ };
10004
+ "/playlists/{id}/relationships/collaboratorProfiles": {
10005
+ parameters: {
10006
+ query?: never;
10007
+ header?: never;
10008
+ path?: never;
10009
+ cookie?: never;
10010
+ };
9346
10011
  /**
9347
- * Add to collaboratorProfiles relationship ("to-many").
9348
- * @description Adds item(s) to collaboratorProfiles relationship.
10012
+ * Get collaboratorProfiles relationship ("to-many").
10013
+ * @description Retrieves collaboratorProfiles relationship.
9349
10014
  */
9350
- post: {
10015
+ get: {
9351
10016
  parameters: {
9352
- query?: never;
9353
- header?: {
9354
- /** @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. */
9355
- "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
10017
+ query?: {
10018
+ /**
10019
+ * @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles
10020
+ * @example collaboratorProfiles
10021
+ */
10022
+ include?: string[];
10023
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
10024
+ "page[cursor]"?: string;
9356
10025
  };
10026
+ header?: never;
9357
10027
  path: {
9358
10028
  /**
9359
10029
  * @description Playlist id
@@ -9363,11 +10033,7 @@ export interface paths {
9363
10033
  };
9364
10034
  cookie?: never;
9365
10035
  };
9366
- requestBody?: {
9367
- content: {
9368
- "application/vnd.api+json": components["schemas"]["PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload"];
9369
- };
9370
- };
10036
+ requestBody?: never;
9371
10037
  responses: {
9372
10038
  /** @description Successful response */
9373
10039
  200: {
@@ -9375,21 +10041,21 @@ export interface paths {
9375
10041
  [name: string]: unknown;
9376
10042
  };
9377
10043
  content: {
9378
- "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"];
10044
+ "application/vnd.api+json": components["schemas"]["Playlists_CollaboratorProfiles_Multi_Relationship_Data_Document"];
9379
10045
  };
9380
10046
  };
9381
10047
  400: components["responses"]["Default400Response"];
9382
10048
  404: components["responses"]["Default404Response"];
9383
10049
  405: components["responses"]["Default405Response"];
9384
10050
  406: components["responses"]["Default406Response"];
9385
- 409: components["responses"]["Idempotency409Response"];
9386
10051
  415: components["responses"]["Default415Response"];
9387
- 422: components["responses"]["Idempotency422Response"];
9388
10052
  429: components["responses"]["Default429Response"];
9389
10053
  500: components["responses"]["Default500Response"];
9390
10054
  503: components["responses"]["Default503Response"];
9391
10055
  };
9392
10056
  };
10057
+ put?: never;
10058
+ post?: never;
9393
10059
  /**
9394
10060
  * Delete from collaboratorProfiles relationship ("to-many").
9395
10061
  * @description Deletes item(s) from collaboratorProfiles relationship.
@@ -9456,11 +10122,6 @@ export interface paths {
9456
10122
  get: {
9457
10123
  parameters: {
9458
10124
  query?: {
9459
- /**
9460
- * @description ISO 3166-1 alpha-2 country code
9461
- * @example US
9462
- */
9463
- countryCode?: string;
9464
10125
  /**
9465
10126
  * @description Allows the client to customize which related resources should be returned. Available options: collaborators
9466
10127
  * @example collaborators
@@ -9727,7 +10388,7 @@ export interface paths {
9727
10388
  404: components["responses"]["Default404Response"];
9728
10389
  405: components["responses"]["Default405Response"];
9729
10390
  406: components["responses"]["Default406Response"];
9730
- 409: components["responses"]["Idempotency409Response"];
10391
+ 409: components["responses"]["PlaylistsAddMultiDataRelationshipWithResponse409Response"];
9731
10392
  415: components["responses"]["Default415Response"];
9732
10393
  422: components["responses"]["Idempotency422Response"];
9733
10394
  429: components["responses"]["Default429Response"];
@@ -9847,11 +10508,6 @@ export interface paths {
9847
10508
  get: {
9848
10509
  parameters: {
9849
10510
  query?: {
9850
- /**
9851
- * @description ISO 3166-1 alpha-2 country code
9852
- * @example US
9853
- */
9854
- countryCode?: string;
9855
10511
  /**
9856
10512
  * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles
9857
10513
  * @example ownerProfiles
@@ -9913,11 +10569,6 @@ export interface paths {
9913
10569
  get: {
9914
10570
  parameters: {
9915
10571
  query?: {
9916
- /**
9917
- * @description ISO 3166-1 alpha-2 country code
9918
- * @example US
9919
- */
9920
- countryCode?: string;
9921
10572
  /**
9922
10573
  * @description Allows the client to customize which related resources should be returned. Available options: owners
9923
10574
  * @example owners
@@ -13765,11 +14416,6 @@ export interface paths {
13765
14416
  get: {
13766
14417
  parameters: {
13767
14418
  query?: {
13768
- /**
13769
- * @description ISO 3166-1 alpha-2 country code
13770
- * @example US
13771
- */
13772
- countryCode?: string;
13773
14419
  /**
13774
14420
  * @description Allows the client to customize which related resources should be returned. Available options: owners
13775
14421
  * @example owners
@@ -14623,11 +15269,6 @@ export interface paths {
14623
15269
  get: {
14624
15270
  parameters: {
14625
15271
  query?: {
14626
- /**
14627
- * @description ISO 3166-1 alpha-2 country code
14628
- * @example US
14629
- */
14630
- countryCode?: string;
14631
15272
  /**
14632
15273
  * @description Allows the client to customize which related resources should be returned. Available options: owners
14633
15274
  * @example owners
@@ -21471,6 +22112,12 @@ export interface components {
21471
22112
  * @example JAY Z
21472
22113
  */
21473
22114
  name: string;
22115
+ /**
22116
+ * Format: int32
22117
+ * @description Number of users in the followers relationship
22118
+ * @example 1523
22119
+ */
22120
+ numberOfFollowers?: number;
21474
22121
  /**
21475
22122
  * @description Ownership type of the artist profile. LABEL: label-managed profile, USER: user-created profile, MIXED: claimed profile with both label and user content. May be null during rollout/backfill.
21476
22123
  * @enum {string}
@@ -22754,6 +23401,230 @@ export interface components {
22754
23401
  /** @description HTTP method */
22755
23402
  method: string;
22756
23403
  };
23404
+ FolderItemsCreateOperation_Payload: {
23405
+ data: components["schemas"]["FolderItemsCreateOperation_Payload_Data"];
23406
+ };
23407
+ FolderItemsCreateOperation_Payload_Data: {
23408
+ relationships: components["schemas"]["FolderItemsCreateOperation_Payload_Data_Relationships"];
23409
+ /** @enum {string} */
23410
+ type: "folderItems";
23411
+ };
23412
+ FolderItemsCreateOperation_Payload_Data_Relationships: {
23413
+ parent: components["schemas"]["FolderItemsCreateOperation_Payload_Data_Relationships_Parent"];
23414
+ subject: components["schemas"]["FolderItemsCreateOperation_Payload_Data_Relationships_Subject"];
23415
+ };
23416
+ FolderItemsCreateOperation_Payload_Data_Relationships_Parent: {
23417
+ data: components["schemas"]["FolderItemsCreateOperation_Payload_Data_Relationships_Parent_Data"];
23418
+ };
23419
+ FolderItemsCreateOperation_Payload_Data_Relationships_Parent_Data: {
23420
+ id: string;
23421
+ /** @enum {string} */
23422
+ type: "folders";
23423
+ };
23424
+ FolderItemsCreateOperation_Payload_Data_Relationships_Subject: {
23425
+ data: components["schemas"]["FolderItemsCreateOperation_Payload_Data_Relationships_Subject_Data"];
23426
+ };
23427
+ FolderItemsCreateOperation_Payload_Data_Relationships_Subject_Data: {
23428
+ id: string;
23429
+ /** @enum {string} */
23430
+ type: "folders" | "albums";
23431
+ };
23432
+ FolderItemsCreateResource400ResponseBody: {
23433
+ errors: {
23434
+ /**
23435
+ * @example FOLDER_CYCLE_NOT_ALLOWED
23436
+ * @enum {string}
23437
+ */
23438
+ code: "FOLDER_CYCLE_NOT_ALLOWED";
23439
+ /** @example A folder cannot be placed inside itself or one of its descendants */
23440
+ detail?: string;
23441
+ /** @example 400 */
23442
+ status: string;
23443
+ }[];
23444
+ };
23445
+ FolderItemsParentRelationshipUpdateOperation_Payload: {
23446
+ data: components["schemas"]["FolderItemsParentRelationshipUpdateOperation_Payload_Data"];
23447
+ };
23448
+ FolderItemsParentRelationshipUpdateOperation_Payload_Data: {
23449
+ id: string;
23450
+ /** @enum {string} */
23451
+ type: "folders";
23452
+ };
23453
+ FolderItemsUpdateSingleDataRelationship400ResponseBody: {
23454
+ errors: {
23455
+ /**
23456
+ * @example FOLDER_CYCLE_NOT_ALLOWED
23457
+ * @enum {string}
23458
+ */
23459
+ code: "FOLDER_CYCLE_NOT_ALLOWED";
23460
+ /** @example A folder cannot be placed inside itself or one of its descendants */
23461
+ detail?: string;
23462
+ /** @example 400 */
23463
+ status: string;
23464
+ }[];
23465
+ };
23466
+ FolderItems_Attributes: Record<string, never>;
23467
+ FolderItems_Create_Single_Resource_Data_Document: {
23468
+ data: components["schemas"]["FolderItems_Resource_Object"];
23469
+ links: components["schemas"]["Links"];
23470
+ };
23471
+ FolderItems_Owners_Multi_Relationship_Data_Document: {
23472
+ data?: components["schemas"]["Resource_Identifier"][];
23473
+ included?: components["schemas"]["Included"];
23474
+ links: components["schemas"]["Links"];
23475
+ };
23476
+ FolderItems_Parent_Single_Relationship_Data_Document: {
23477
+ data?: components["schemas"]["Resource_Identifier"] | (never | null);
23478
+ included?: components["schemas"]["Included"];
23479
+ links: components["schemas"]["Links"];
23480
+ };
23481
+ FolderItems_Parent_Update_Resource_Identifier: {
23482
+ id: string;
23483
+ /** @enum {string} */
23484
+ type: "folders";
23485
+ };
23486
+ FolderItems_Parent_Update_Single_Relationship_Data_Document: {
23487
+ data: components["schemas"]["FolderItems_Parent_Update_Resource_Identifier"] | (never | null);
23488
+ links: components["schemas"]["Links"];
23489
+ };
23490
+ FolderItems_Relationships: {
23491
+ owners?: components["schemas"]["FolderItems_Owners_Multi_Relationship_Data_Document"];
23492
+ parent?: components["schemas"]["FolderItems_Parent_Single_Relationship_Data_Document"];
23493
+ subject?: components["schemas"]["FolderItems_Subject_Single_Relationship_Data_Document"];
23494
+ };
23495
+ FolderItems_Resource_Object: {
23496
+ attributes?: components["schemas"]["FolderItems_Attributes"];
23497
+ /**
23498
+ * @description Resource id
23499
+ * @example 12345
23500
+ */
23501
+ id: string;
23502
+ relationships?: components["schemas"]["FolderItems_Relationships"];
23503
+ /**
23504
+ * @description Resource type (enum property replaced by openapi-typescript)
23505
+ * @enum {string}
23506
+ */
23507
+ type: "folderItems";
23508
+ };
23509
+ FolderItems_Single_Resource_Data_Document: {
23510
+ data: components["schemas"]["FolderItems_Resource_Object"];
23511
+ included?: components["schemas"]["Included"];
23512
+ links: components["schemas"]["Links"];
23513
+ };
23514
+ FolderItems_Subject_Resource_Identifier: {
23515
+ /**
23516
+ * @description Resource id
23517
+ * @example 12345
23518
+ */
23519
+ id: string;
23520
+ meta?: components["schemas"]["FolderItems_Subject_Resource_Identifier_Meta"];
23521
+ /**
23522
+ * @description Resource type
23523
+ * @example tracks
23524
+ */
23525
+ type: string;
23526
+ };
23527
+ FolderItems_Subject_Resource_Identifier_Meta: {
23528
+ replacement?: components["schemas"]["Replacement_Provenance"];
23529
+ };
23530
+ FolderItems_Subject_Single_Relationship_Data_Document: {
23531
+ data?: components["schemas"]["FolderItems_Subject_Resource_Identifier"] | (never | null);
23532
+ included?: components["schemas"]["Included"];
23533
+ links: components["schemas"]["Links"];
23534
+ };
23535
+ FoldersCreateOperation_Payload: {
23536
+ data: components["schemas"]["FoldersCreateOperation_Payload_Data"];
23537
+ };
23538
+ FoldersCreateOperation_Payload_Data: {
23539
+ attributes: components["schemas"]["FoldersCreateOperation_Payload_Data_Attributes"];
23540
+ /** @enum {string} */
23541
+ type: "folders";
23542
+ };
23543
+ FoldersCreateOperation_Payload_Data_Attributes: {
23544
+ name: string;
23545
+ };
23546
+ FoldersDeleteResource400ResponseBody: {
23547
+ errors: {
23548
+ /**
23549
+ * @example ROOT_FOLDER_NOT_MODIFIABLE
23550
+ * @enum {string}
23551
+ */
23552
+ code: "ROOT_FOLDER_NOT_MODIFIABLE";
23553
+ /** @example The root folder cannot be renamed or deleted */
23554
+ detail?: string;
23555
+ /** @example 400 */
23556
+ status: string;
23557
+ }[];
23558
+ };
23559
+ FoldersUpdateOperation_Payload: {
23560
+ data: components["schemas"]["FoldersUpdateOperation_Payload_Data"];
23561
+ };
23562
+ FoldersUpdateOperation_Payload_Data: {
23563
+ attributes: components["schemas"]["FoldersUpdateOperation_Payload_Data_Attributes"];
23564
+ id: string;
23565
+ /** @enum {string} */
23566
+ type: "folders";
23567
+ };
23568
+ FoldersUpdateOperation_Payload_Data_Attributes: {
23569
+ name: string;
23570
+ };
23571
+ FoldersUpdateResource400ResponseBody: {
23572
+ errors: {
23573
+ /**
23574
+ * @example ROOT_FOLDER_NOT_MODIFIABLE
23575
+ * @enum {string}
23576
+ */
23577
+ code: "ROOT_FOLDER_NOT_MODIFIABLE";
23578
+ /** @example The root folder cannot be renamed or deleted */
23579
+ detail?: string;
23580
+ /** @example 400 */
23581
+ status: string;
23582
+ }[];
23583
+ };
23584
+ Folders_Attributes: {
23585
+ name: string;
23586
+ };
23587
+ Folders_Children_Multi_Relationship_Data_Document: {
23588
+ data?: components["schemas"]["Resource_Identifier"][];
23589
+ included?: components["schemas"]["Included"];
23590
+ links: components["schemas"]["Links"];
23591
+ };
23592
+ Folders_Create_Single_Resource_Data_Document: {
23593
+ data: components["schemas"]["Folders_Resource_Object"];
23594
+ links: components["schemas"]["Links"];
23595
+ };
23596
+ Folders_Owners_Multi_Relationship_Data_Document: {
23597
+ data?: components["schemas"]["Resource_Identifier"][];
23598
+ included?: components["schemas"]["Included"];
23599
+ links: components["schemas"]["Links"];
23600
+ };
23601
+ Folders_Relationships: {
23602
+ children?: components["schemas"]["Folders_Children_Multi_Relationship_Data_Document"];
23603
+ owners?: components["schemas"]["Folders_Owners_Multi_Relationship_Data_Document"];
23604
+ };
23605
+ Folders_Resource_Object: {
23606
+ attributes?: components["schemas"]["Folders_Attributes"];
23607
+ /**
23608
+ * @description Resource id
23609
+ * @example 12345
23610
+ */
23611
+ id: string;
23612
+ relationships?: components["schemas"]["Folders_Relationships"];
23613
+ /**
23614
+ * @description Resource type (enum property replaced by openapi-typescript)
23615
+ * @enum {string}
23616
+ */
23617
+ type: "folders";
23618
+ };
23619
+ Folders_Single_Resource_Data_Document: {
23620
+ data: components["schemas"]["Folders_Resource_Object"];
23621
+ included?: components["schemas"]["Included"];
23622
+ links: components["schemas"]["Links"];
23623
+ };
23624
+ Folders_Update_Single_Resource_Data_Document: {
23625
+ data: components["schemas"]["Folders_Resource_Object"];
23626
+ links: components["schemas"]["Links"];
23627
+ };
22757
23628
  Genres_Attributes: {
22758
23629
  /**
22759
23630
  * @description Genre name
@@ -22810,7 +23681,7 @@ export interface components {
22810
23681
  status: string;
22811
23682
  }[];
22812
23683
  };
22813
- 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"]["ArtistClaimStatuses_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["ChangeEventStreams_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["CollaborationInviteRedemptions_Resource_Object"] | components["schemas"]["CollaborationInvites_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"]["PlaylistGenerationSchedules_Resource_Object"] | components["schemas"]["PlaylistGenerations_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"]["Scopes_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"]["SquareSites_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["SubscriptionPriceChangeDecisions_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"]["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"]["UserPlaybackStates_Resource_Object"] | components["schemas"]["UserRecommendationBlocks_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
23684
+ 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"]["ArtistClaimStatuses_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["ChangeEventStreams_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["CollaborationInviteRedemptions_Resource_Object"] | components["schemas"]["CollaborationInvites_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"]["FolderItems_Resource_Object"] | components["schemas"]["Folders_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"]["PlaylistGenerationSchedules_Resource_Object"] | components["schemas"]["PlaylistGenerations_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"]["Scopes_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"]["SquareSites_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["SubscriptionPriceChangeDecisions_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"]["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"]["UserPlaybackStates_Resource_Object"] | components["schemas"]["UserRecommendationBlocks_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
22814
23685
  InstallationsCreateOperation_Payload: {
22815
23686
  data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
22816
23687
  };
@@ -23721,13 +24592,18 @@ export interface components {
23721
24592
  included?: components["schemas"]["Included"];
23722
24593
  links: components["schemas"]["Links"];
23723
24594
  };
23724
- PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload: {
23725
- data: components["schemas"]["PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload_Data"][];
23726
- };
23727
- PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload_Data: {
23728
- id: string;
23729
- /** @enum {string} */
23730
- type: "artists";
24595
+ PlaylistsAddMultiDataRelationshipWithResponse409ResponseBody: {
24596
+ errors: {
24597
+ /**
24598
+ * @example DUPLICATE_ITEMS_IN_PLAYLIST
24599
+ * @enum {string}
24600
+ */
24601
+ code: "DUPLICATE_ITEMS_IN_PLAYLIST" | "IDEMPOTENT_REQUEST_IN_PROGRESS";
24602
+ /** @example Playlist already contains one or more requested items */
24603
+ detail?: string;
24604
+ /** @example 409 */
24605
+ status: string;
24606
+ }[];
23731
24607
  };
23732
24608
  PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload: {
23733
24609
  data: components["schemas"]["PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload_Data"][];
@@ -23780,12 +24656,21 @@ export interface components {
23780
24656
  addedAt?: string;
23781
24657
  };
23782
24658
  PlaylistsItemsRelationshipAddOperation_Payload_Meta: {
23783
- positionBefore: string;
24659
+ /**
24660
+ * @description How to handle available items already present in the playlist. Presence is evaluated against playlist state immediately before the operation; duplicate occurrences within this request do not make one another already present. ADD adds every requested occurrence. FAIL returns 409 and adds nothing when any requested resource type and id is already present. SKIP adds only absent resources and reports every omitted occurrence in response meta.skipped with reason ALREADY_PRESENT. Track and video identities with the same id are distinct. Defaults to ADD.
24661
+ * @default ADD
24662
+ * @enum {string}
24663
+ */
24664
+ onDuplicates: "ADD" | "FAIL" | "SKIP";
24665
+ positionBefore?: string;
23784
24666
  };
23785
24667
  PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
23786
24668
  id: string;
23787
- /** @enum {string} */
23788
- reason: "NOT_FOUND";
24669
+ /**
24670
+ * @description Why the requested occurrence was not added: NOT_FOUND means it was not available; ALREADY_PRESENT means SKIP omitted it because the playlist already contained that resource type and id.
24671
+ * @enum {string}
24672
+ */
24673
+ reason: "NOT_FOUND" | "ALREADY_PRESENT";
23789
24674
  /** @enum {string} */
23790
24675
  type: "tracks" | "videos";
23791
24676
  };
@@ -27903,6 +28788,42 @@ export interface components {
27903
28788
  "application/vnd.api+json": components["schemas"]["Default503ResponseBody"];
27904
28789
  };
27905
28790
  };
28791
+ /** @description A folder cannot be placed inside itself or one of its descendants */
28792
+ FolderItemsCreateResource400Response: {
28793
+ headers: {
28794
+ [name: string]: unknown;
28795
+ };
28796
+ content: {
28797
+ "application/vnd.api+json": components["schemas"]["FolderItemsCreateResource400ResponseBody"];
28798
+ };
28799
+ };
28800
+ /** @description A folder cannot be placed inside itself or one of its descendants */
28801
+ FolderItemsUpdateSingleDataRelationship400Response: {
28802
+ headers: {
28803
+ [name: string]: unknown;
28804
+ };
28805
+ content: {
28806
+ "application/vnd.api+json": components["schemas"]["FolderItemsUpdateSingleDataRelationship400ResponseBody"];
28807
+ };
28808
+ };
28809
+ /** @description The root folder cannot be renamed or deleted */
28810
+ FoldersDeleteResource400Response: {
28811
+ headers: {
28812
+ [name: string]: unknown;
28813
+ };
28814
+ content: {
28815
+ "application/vnd.api+json": components["schemas"]["FoldersDeleteResource400ResponseBody"];
28816
+ };
28817
+ };
28818
+ /** @description The root folder cannot be renamed or deleted */
28819
+ FoldersUpdateResource400Response: {
28820
+ headers: {
28821
+ [name: string]: unknown;
28822
+ };
28823
+ content: {
28824
+ "application/vnd.api+json": components["schemas"]["FoldersUpdateResource400ResponseBody"];
28825
+ };
28826
+ };
27906
28827
  /** @description Request already in progress for this idempotency key */
27907
28828
  Idempotency409Response: {
27908
28829
  headers: {
@@ -27930,6 +28851,15 @@ export interface components {
27930
28851
  "application/vnd.api+json": components["schemas"]["PlaylistGenerationSchedulesCreateResource403ResponseBody"];
27931
28852
  };
27932
28853
  };
28854
+ /** @description Playlist already contains one or more requested items; Request already in progress for this idempotency key */
28855
+ PlaylistsAddMultiDataRelationshipWithResponse409Response: {
28856
+ headers: {
28857
+ [name: string]: unknown;
28858
+ };
28859
+ content: {
28860
+ "application/vnd.api+json": components["schemas"]["PlaylistsAddMultiDataRelationshipWithResponse409ResponseBody"];
28861
+ };
28862
+ };
27933
28863
  /** @description Latest terms and conditions must be accepted */
27934
28864
  SquareConnectionsReadById403Response: {
27935
28865
  headers: {