@tidal-music/api 0.39.0 → 0.40.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.
@@ -17,17 +17,17 @@ export interface paths {
17
17
  get: {
18
18
  parameters: {
19
19
  query: {
20
+ /** @description User id. Use `me` for the authenticated user */
21
+ "filter[owners.id]": string[];
22
+ /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE, MERCH_GUIDELINES (e.g. `DEVELOPER`) */
23
+ "filter[terms.termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES")[];
20
24
  /**
21
25
  * @description Allows the client to customize which related resources should be returned. Available options: owners, terms
22
26
  * @example owners
23
27
  */
24
28
  include?: string[];
25
- /** @description User id. Use `me` for the authenticated user */
26
- "filter[owners.id]": string[];
27
29
  /** @description Filter by terms.isLatestVersion */
28
30
  "filter[terms.isLatestVersion]"?: string[];
29
- /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE (e.g. `DEVELOPER`) */
30
- "filter[terms.termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
31
31
  };
32
32
  header?: never;
33
33
  path?: never;
@@ -81,7 +81,7 @@ export interface paths {
81
81
  [name: string]: unknown;
82
82
  };
83
83
  content: {
84
- "application/vnd.api+json": components["schemas"]["AcceptedTerms_Single_Resource_Data_Document"];
84
+ "application/vnd.api+json": components["schemas"]["AcceptedTerms_Create_Single_Resource_Data_Document"];
85
85
  };
86
86
  };
87
87
  400: components["responses"]["Default400Response"];
@@ -446,7 +446,7 @@ export interface paths {
446
446
  [name: string]: unknown;
447
447
  };
448
448
  content: {
449
- "application/vnd.api+json": components["schemas"]["Albums_Single_Resource_Data_Document"];
449
+ "application/vnd.api+json": components["schemas"]["Albums_Create_Single_Resource_Data_Document"];
450
450
  };
451
451
  };
452
452
  400: components["responses"]["Default400Response"];
@@ -1603,7 +1603,7 @@ export interface paths {
1603
1603
  [name: string]: unknown;
1604
1604
  };
1605
1605
  content: {
1606
- "application/vnd.api+json": components["schemas"]["Appreciations_Single_Resource_Data_Document"];
1606
+ "application/vnd.api+json": components["schemas"]["Appreciations_Create_Single_Resource_Data_Document"];
1607
1607
  };
1608
1608
  };
1609
1609
  400: components["responses"]["Default400Response"];
@@ -1850,13 +1850,13 @@ export interface paths {
1850
1850
  get: {
1851
1851
  parameters: {
1852
1852
  query: {
1853
+ /** @description User id. Use `me` for the authenticated user */
1854
+ "filter[owners.id]": string[];
1853
1855
  /**
1854
1856
  * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists
1855
1857
  * @example acceptedArtists.albums
1856
1858
  */
1857
1859
  include?: string[];
1858
- /** @description User id. Use `me` for the authenticated user */
1859
- "filter[owners.id]": string[];
1860
1860
  /**
1861
1861
  * @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: acceptedArtists.albums
1862
1862
  * @example acceptedArtists.albums
@@ -1921,7 +1921,7 @@ export interface paths {
1921
1921
  [name: string]: unknown;
1922
1922
  };
1923
1923
  content: {
1924
- "application/vnd.api+json": components["schemas"]["ArtistClaims_Single_Resource_Data_Document"];
1924
+ "application/vnd.api+json": components["schemas"]["ArtistClaims_Create_Single_Resource_Data_Document"];
1925
1925
  };
1926
1926
  };
1927
1927
  400: components["responses"]["Default400Response"];
@@ -2459,7 +2459,7 @@ export interface paths {
2459
2459
  [name: string]: unknown;
2460
2460
  };
2461
2461
  content: {
2462
- "application/vnd.api+json": components["schemas"]["Artists_Single_Resource_Data_Document"];
2462
+ "application/vnd.api+json": components["schemas"]["Artists_Create_Single_Resource_Data_Document"];
2463
2463
  };
2464
2464
  };
2465
2465
  400: components["responses"]["Default400Response"];
@@ -2939,6 +2939,13 @@ export interface paths {
2939
2939
  };
2940
2940
  };
2941
2941
  responses: {
2942
+ /** @description Successful response */
2943
+ 201: {
2944
+ headers: {
2945
+ [name: string]: unknown;
2946
+ };
2947
+ content?: never;
2948
+ };
2942
2949
  400: components["responses"]["Default400Response"];
2943
2950
  404: components["responses"]["Default404Response"];
2944
2951
  405: components["responses"]["Default405Response"];
@@ -3583,6 +3590,8 @@ export interface paths {
3583
3590
  get: {
3584
3591
  parameters: {
3585
3592
  query: {
3593
+ /** @description Artwork id (e.g. `a468bee88def`) */
3594
+ "filter[id]": string[];
3586
3595
  /**
3587
3596
  * @description ISO 3166-1 alpha-2 country code
3588
3597
  * @example US
@@ -3593,8 +3602,6 @@ export interface paths {
3593
3602
  * @example owners
3594
3603
  */
3595
3604
  include?: string[];
3596
- /** @description Artwork id (e.g. `a468bee88def`) */
3597
- "filter[id]": string[];
3598
3605
  };
3599
3606
  header?: never;
3600
3607
  path?: never;
@@ -3648,7 +3655,7 @@ export interface paths {
3648
3655
  [name: string]: unknown;
3649
3656
  };
3650
3657
  content: {
3651
- "application/vnd.api+json": components["schemas"]["Artworks_Single_Resource_Data_Document"];
3658
+ "application/vnd.api+json": components["schemas"]["Artworks_Create_Single_Resource_Data_Document"];
3652
3659
  };
3653
3660
  };
3654
3661
  400: components["responses"]["Default400Response"];
@@ -3808,13 +3815,13 @@ export interface paths {
3808
3815
  get: {
3809
3816
  parameters: {
3810
3817
  query: {
3818
+ /** @description User id. Use `me` for the authenticated user */
3819
+ "filter[owners.id]": string[];
3811
3820
  /**
3812
3821
  * @description Allows the client to customize which related resources should be returned. Available options: owners
3813
3822
  * @example owners
3814
3823
  */
3815
3824
  include?: string[];
3816
- /** @description User id. Use `me` for the authenticated user */
3817
- "filter[owners.id]": string[];
3818
3825
  };
3819
3826
  header?: never;
3820
3827
  path?: never;
@@ -3868,7 +3875,7 @@ export interface paths {
3868
3875
  [name: string]: unknown;
3869
3876
  };
3870
3877
  content: {
3871
- "application/vnd.api+json": components["schemas"]["Clients_Single_Resource_Data_Document"];
3878
+ "application/vnd.api+json": components["schemas"]["Clients_Create_Single_Resource_Data_Document"];
3872
3879
  };
3873
3880
  };
3874
3881
  400: components["responses"]["Default400Response"];
@@ -4010,7 +4017,7 @@ export interface paths {
4010
4017
  [name: string]: unknown;
4011
4018
  };
4012
4019
  content: {
4013
- "application/vnd.api+json": components["schemas"]["Clients_Single_Resource_Data_Document"];
4020
+ "application/vnd.api+json": components["schemas"]["Clients_Update_Single_Resource_Data_Document"];
4014
4021
  };
4015
4022
  };
4016
4023
  400: components["responses"]["Default400Response"];
@@ -4123,7 +4130,7 @@ export interface paths {
4123
4130
  [name: string]: unknown;
4124
4131
  };
4125
4132
  content: {
4126
- "application/vnd.api+json": components["schemas"]["CollaborationInviteRedemptions_Single_Resource_Data_Document"];
4133
+ "application/vnd.api+json": components["schemas"]["CollaborationInviteRedemptions_Create_Single_Resource_Data_Document"];
4127
4134
  };
4128
4135
  };
4129
4136
  400: components["responses"]["Default400Response"];
@@ -4158,13 +4165,13 @@ export interface paths {
4158
4165
  get: {
4159
4166
  parameters: {
4160
4167
  query: {
4168
+ /** @description Invite code */
4169
+ "filter[code]": string[];
4161
4170
  /**
4162
4171
  * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
4163
4172
  * @example subject.items
4164
4173
  */
4165
4174
  include?: string[];
4166
- /** @description Invite code */
4167
- "filter[code]": string[];
4168
4175
  /**
4169
4176
  * @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.items
4170
4177
  * @example subject.items
@@ -4223,7 +4230,7 @@ export interface paths {
4223
4230
  [name: string]: unknown;
4224
4231
  };
4225
4232
  content: {
4226
- "application/vnd.api+json": components["schemas"]["CollaborationInvites_Single_Resource_Data_Document"];
4233
+ "application/vnd.api+json": components["schemas"]["CollaborationInvites_Create_Single_Resource_Data_Document"];
4227
4234
  };
4228
4235
  };
4229
4236
  400: components["responses"]["Default400Response"];
@@ -4480,6 +4487,10 @@ export interface paths {
4480
4487
  get: {
4481
4488
  parameters: {
4482
4489
  query: {
4490
+ /** @description Filter by subject resource ID (e.g. `12345`) */
4491
+ "filter[subject.id]": string[];
4492
+ /** @description Filter by subject resource type (e.g. `albums`) */
4493
+ "filter[subject.type]": ("albums" | "tracks")[];
4483
4494
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
4484
4495
  "page[cursor]"?: string;
4485
4496
  /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
@@ -4491,10 +4502,6 @@ export interface paths {
4491
4502
  include?: string[];
4492
4503
  /** @description Filter by parent comment ID to get replies (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
4493
4504
  "filter[parentComment.id]"?: string[];
4494
- /** @description Filter by subject resource ID (e.g. `12345`) */
4495
- "filter[subject.id]": string[];
4496
- /** @description Filter by subject resource type (e.g. `albums`) */
4497
- "filter[subject.type]": ("albums" | "tracks")[];
4498
4505
  };
4499
4506
  header?: never;
4500
4507
  path?: never;
@@ -4548,7 +4555,7 @@ export interface paths {
4548
4555
  [name: string]: unknown;
4549
4556
  };
4550
4557
  content: {
4551
- "application/vnd.api+json": components["schemas"]["Comments_Single_Resource_Data_Document"];
4558
+ "application/vnd.api+json": components["schemas"]["Comments_Create_Single_Resource_Data_Document"];
4552
4559
  };
4553
4560
  };
4554
4561
  400: components["responses"]["Default400Response"];
@@ -4893,13 +4900,13 @@ export interface paths {
4893
4900
  get: {
4894
4901
  parameters: {
4895
4902
  query: {
4903
+ /** @description User id. Use `me` for the authenticated user */
4904
+ "filter[owners.id]": string[];
4896
4905
  /**
4897
4906
  * @description Allows the client to customize which related resources should be returned. Available options: claimedResource, claimingArtist, owners
4898
4907
  * @example claimedResource
4899
4908
  */
4900
4909
  include?: string[];
4901
- /** @description User id. Use `me` for the authenticated user */
4902
- "filter[owners.id]": string[];
4903
4910
  /**
4904
4911
  * @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: claimedResource
4905
4912
  * @example claimedResource
@@ -4958,7 +4965,7 @@ export interface paths {
4958
4965
  [name: string]: unknown;
4959
4966
  };
4960
4967
  content: {
4961
- "application/vnd.api+json": components["schemas"]["ContentClaims_Single_Resource_Data_Document"];
4968
+ "application/vnd.api+json": components["schemas"]["ContentClaims_Create_Single_Resource_Data_Document"];
4962
4969
  };
4963
4970
  };
4964
4971
  400: components["responses"]["Default400Response"];
@@ -5433,13 +5440,13 @@ export interface paths {
5433
5440
  get: {
5434
5441
  parameters: {
5435
5442
  query: {
5443
+ /** @description Download id (e.g. `VFJBQ0tTOjEyMzQ1`) */
5444
+ "filter[id]": string[];
5436
5445
  /**
5437
5446
  * @description Allows the client to customize which related resources should be returned. Available options: owners
5438
5447
  * @example owners
5439
5448
  */
5440
5449
  include?: string[];
5441
- /** @description Download id (e.g. `VFJBQ0tTOjEyMzQ1`) */
5442
- "filter[id]": string[];
5443
5450
  };
5444
5451
  header?: never;
5445
5452
  path?: never;
@@ -5608,15 +5615,15 @@ export interface paths {
5608
5615
  get: {
5609
5616
  parameters: {
5610
5617
  query: {
5618
+ /** @description The id of the subject resource */
5619
+ "filter[subject.id]": string[];
5620
+ /** @description The type of the subject resource (e.g., albums, tracks, artists) (e.g. `tracks`) */
5621
+ "filter[subject.type]": ("tracks" | "albums" | "artists")[];
5611
5622
  /**
5612
5623
  * @description Allows the client to customize which related resources should be returned. Available options: subject
5613
5624
  * @example subject
5614
5625
  */
5615
5626
  include?: string[];
5616
- /** @description The id of the subject resource */
5617
- "filter[subject.id]": string[];
5618
- /** @description The type of the subject resource (e.g., albums, tracks, artists) (e.g. `tracks`) */
5619
- "filter[subject.type]": ("tracks" | "albums" | "artists")[];
5620
5627
  /**
5621
5628
  * @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
5622
5629
  * @example subject
@@ -5734,18 +5741,6 @@ export interface paths {
5734
5741
  get: {
5735
5742
  parameters: {
5736
5743
  query: {
5737
- /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
5738
- refreshSeed?: string;
5739
- /**
5740
- * @description ISO 3166-1 alpha-2 country code
5741
- * @example US
5742
- */
5743
- countryCode?: string;
5744
- /**
5745
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
5746
- * @example en-US
5747
- */
5748
- locale?: string;
5749
5744
  /**
5750
5745
  * @description The type of device making the request
5751
5746
  * @example PHONE
@@ -5761,13 +5756,25 @@ export interface paths {
5761
5756
  * @example 2026.0.1
5762
5757
  */
5763
5758
  clientVersion: string;
5759
+ /** @description DynamicModules Id (e.g. `nejMcAhh5N8S3EQ4LaqysVdI0cZZ`) */
5760
+ "filter[id]": string[];
5761
+ /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
5762
+ refreshSeed?: string;
5763
+ /**
5764
+ * @description ISO 3166-1 alpha-2 country code
5765
+ * @example US
5766
+ */
5767
+ countryCode?: string;
5768
+ /**
5769
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
5770
+ * @example en-US
5771
+ */
5772
+ locale?: string;
5764
5773
  /**
5765
5774
  * @description Allows the client to customize which related resources should be returned. Available options: items, seedItem
5766
5775
  * @example items
5767
5776
  */
5768
5777
  include?: string[];
5769
- /** @description DynamicModules Id (e.g. `nejMcAhh5N8S3EQ4LaqysVdI0cZZ`) */
5770
- "filter[id]": string[];
5771
5778
  /**
5772
5779
  * @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: items
5773
5780
  * @example items
@@ -5821,18 +5828,6 @@ export interface paths {
5821
5828
  get: {
5822
5829
  parameters: {
5823
5830
  query: {
5824
- /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
5825
- refreshSeed?: string;
5826
- /**
5827
- * @description ISO 3166-1 alpha-2 country code
5828
- * @example US
5829
- */
5830
- countryCode?: string;
5831
- /**
5832
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
5833
- * @example en-US
5834
- */
5835
- locale?: string;
5836
5831
  /**
5837
5832
  * @description The type of device making the request
5838
5833
  * @example PHONE
@@ -5848,6 +5843,18 @@ export interface paths {
5848
5843
  * @example 2026.0.1
5849
5844
  */
5850
5845
  clientVersion: string;
5846
+ /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
5847
+ refreshSeed?: string;
5848
+ /**
5849
+ * @description ISO 3166-1 alpha-2 country code
5850
+ * @example US
5851
+ */
5852
+ countryCode?: string;
5853
+ /**
5854
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
5855
+ * @example en-US
5856
+ */
5857
+ locale?: string;
5851
5858
  /**
5852
5859
  * @description Allows the client to customize which related resources should be returned. Available options: items, seedItem
5853
5860
  * @example items
@@ -5912,20 +5919,6 @@ export interface paths {
5912
5919
  get: {
5913
5920
  parameters: {
5914
5921
  query: {
5915
- /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
5916
- refreshSeed?: string;
5917
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
5918
- "page[cursor]"?: string;
5919
- /**
5920
- * @description ISO 3166-1 alpha-2 country code
5921
- * @example US
5922
- */
5923
- countryCode?: string;
5924
- /**
5925
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
5926
- * @example en-US
5927
- */
5928
- locale?: string;
5929
5922
  /**
5930
5923
  * @description The type of device making the request
5931
5924
  * @example PHONE
@@ -5941,6 +5934,20 @@ export interface paths {
5941
5934
  * @example 2026.0.1
5942
5935
  */
5943
5936
  clientVersion: string;
5937
+ /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
5938
+ refreshSeed?: string;
5939
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
5940
+ "page[cursor]"?: string;
5941
+ /**
5942
+ * @description ISO 3166-1 alpha-2 country code
5943
+ * @example US
5944
+ */
5945
+ countryCode?: string;
5946
+ /**
5947
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
5948
+ * @example en-US
5949
+ */
5950
+ locale?: string;
5944
5951
  /**
5945
5952
  * @description Allows the client to customize which related resources should be returned. Available options: items
5946
5953
  * @example items
@@ -6005,18 +6012,6 @@ export interface paths {
6005
6012
  get: {
6006
6013
  parameters: {
6007
6014
  query: {
6008
- /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
6009
- refreshSeed?: string;
6010
- /**
6011
- * @description ISO 3166-1 alpha-2 country code
6012
- * @example US
6013
- */
6014
- countryCode?: string;
6015
- /**
6016
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6017
- * @example en-US
6018
- */
6019
- locale?: string;
6020
6015
  /**
6021
6016
  * @description The type of device making the request
6022
6017
  * @example PHONE
@@ -6032,6 +6027,18 @@ export interface paths {
6032
6027
  * @example 2026.0.1
6033
6028
  */
6034
6029
  clientVersion: string;
6030
+ /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
6031
+ refreshSeed?: string;
6032
+ /**
6033
+ * @description ISO 3166-1 alpha-2 country code
6034
+ * @example US
6035
+ */
6036
+ countryCode?: string;
6037
+ /**
6038
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6039
+ * @example en-US
6040
+ */
6041
+ locale?: string;
6035
6042
  /**
6036
6043
  * @description Allows the client to customize which related resources should be returned. Available options: seedItem
6037
6044
  * @example seedItem
@@ -6096,18 +6103,6 @@ export interface paths {
6096
6103
  get: {
6097
6104
  parameters: {
6098
6105
  query: {
6099
- /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
6100
- refreshSeed?: string;
6101
- /**
6102
- * @description ISO 3166-1 alpha-2 country code
6103
- * @example US
6104
- */
6105
- countryCode?: string;
6106
- /**
6107
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6108
- * @example en-US
6109
- */
6110
- locale?: string;
6111
6106
  /**
6112
6107
  * @description The type of device making the request
6113
6108
  * @example PHONE
@@ -6123,13 +6118,25 @@ export interface paths {
6123
6118
  * @example 2026.0.1
6124
6119
  */
6125
6120
  clientVersion: string;
6121
+ /** @description type of the page (e.g. `ARTIST`) */
6122
+ "filter[pageType]": string[];
6123
+ /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
6124
+ refreshSeed?: string;
6125
+ /**
6126
+ * @description ISO 3166-1 alpha-2 country code
6127
+ * @example US
6128
+ */
6129
+ countryCode?: string;
6130
+ /**
6131
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6132
+ * @example en-US
6133
+ */
6134
+ locale?: string;
6126
6135
  /**
6127
6136
  * @description Allows the client to customize which related resources should be returned. Available options: modules, subject
6128
6137
  * @example modules.items
6129
6138
  */
6130
6139
  include?: string[];
6131
- /** @description type of the page (e.g. `ARTIST`) */
6132
- "filter[pageType]": string[];
6133
6140
  /** @description The subject resource ID. Required except for HOME_FREE, where it must be omitted. (e.g. `67890`) */
6134
6141
  "filter[subject.id]"?: string[];
6135
6142
  /**
@@ -6185,20 +6192,6 @@ export interface paths {
6185
6192
  get: {
6186
6193
  parameters: {
6187
6194
  query: {
6188
- /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
6189
- refreshSeed?: string;
6190
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6191
- "page[cursor]"?: string;
6192
- /**
6193
- * @description ISO 3166-1 alpha-2 country code
6194
- * @example US
6195
- */
6196
- countryCode?: string;
6197
- /**
6198
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6199
- * @example en-US
6200
- */
6201
- locale?: string;
6202
6195
  /**
6203
6196
  * @description The type of device making the request
6204
6197
  * @example PHONE
@@ -6214,6 +6207,20 @@ export interface paths {
6214
6207
  * @example 2026.0.1
6215
6208
  */
6216
6209
  clientVersion: string;
6210
+ /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
6211
+ refreshSeed?: string;
6212
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6213
+ "page[cursor]"?: string;
6214
+ /**
6215
+ * @description ISO 3166-1 alpha-2 country code
6216
+ * @example US
6217
+ */
6218
+ countryCode?: string;
6219
+ /**
6220
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6221
+ * @example en-US
6222
+ */
6223
+ locale?: string;
6217
6224
  /**
6218
6225
  * @description Allows the client to customize which related resources should be returned. Available options: modules
6219
6226
  * @example modules.items
@@ -6342,6 +6349,8 @@ export interface paths {
6342
6349
  get: {
6343
6350
  parameters: {
6344
6351
  query: {
6352
+ /** @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'`) */
6353
+ "filter[id]": string[];
6345
6354
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6346
6355
  "page[cursor]"?: string;
6347
6356
  /**
@@ -6349,8 +6358,6 @@ export interface paths {
6349
6358
  * @example en-US
6350
6359
  */
6351
6360
  locale?: string;
6352
- /** @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'`) */
6353
- "filter[id]": string[];
6354
6361
  };
6355
6362
  header?: never;
6356
6363
  path?: never;
@@ -6527,7 +6534,7 @@ export interface paths {
6527
6534
  [name: string]: unknown;
6528
6535
  };
6529
6536
  content: {
6530
- "application/vnd.api+json": components["schemas"]["Installations_Single_Resource_Data_Document"];
6537
+ "application/vnd.api+json": components["schemas"]["Installations_Create_Single_Resource_Data_Document"];
6531
6538
  };
6532
6539
  };
6533
6540
  400: components["responses"]["Default400Response"];
@@ -6626,6 +6633,8 @@ export interface paths {
6626
6633
  get: {
6627
6634
  parameters: {
6628
6635
  query: {
6636
+ /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */
6637
+ "filter[type]": ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[];
6629
6638
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6630
6639
  "page[cursor]"?: string;
6631
6640
  /**
@@ -6637,8 +6646,6 @@ export interface paths {
6637
6646
  "filter[id]"?: string[];
6638
6647
  /** @description One of: PENDING, STORED (e.g. `PENDING`) */
6639
6648
  "filter[state]"?: ("PENDING" | "STORED")[];
6640
- /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */
6641
- "filter[type]": ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[];
6642
6649
  /**
6643
6650
  * @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
6644
6651
  * @example offlineInventory
@@ -6703,6 +6710,13 @@ export interface paths {
6703
6710
  };
6704
6711
  };
6705
6712
  responses: {
6713
+ /** @description Successful response */
6714
+ 201: {
6715
+ headers: {
6716
+ [name: string]: unknown;
6717
+ };
6718
+ content?: never;
6719
+ };
6706
6720
  400: components["responses"]["Default400Response"];
6707
6721
  404: components["responses"]["Default404Response"];
6708
6722
  405: components["responses"]["Default405Response"];
@@ -6854,7 +6868,7 @@ export interface paths {
6854
6868
  [name: string]: unknown;
6855
6869
  };
6856
6870
  content: {
6857
- "application/vnd.api+json": components["schemas"]["Lyrics_Single_Resource_Data_Document"];
6871
+ "application/vnd.api+json": components["schemas"]["Lyrics_Create_Single_Resource_Data_Document"];
6858
6872
  };
6859
6873
  };
6860
6874
  400: components["responses"]["Default400Response"];
@@ -7179,7 +7193,7 @@ export interface paths {
7179
7193
  [name: string]: unknown;
7180
7194
  };
7181
7195
  content: {
7182
- "application/vnd.api+json": components["schemas"]["ManualArtistClaims_Single_Resource_Data_Document"];
7196
+ "application/vnd.api+json": components["schemas"]["ManualArtistClaims_Create_Single_Resource_Data_Document"];
7183
7197
  };
7184
7198
  };
7185
7199
  400: components["responses"]["Default400Response"];
@@ -7214,6 +7228,8 @@ export interface paths {
7214
7228
  get: {
7215
7229
  parameters: {
7216
7230
  query: {
7231
+ /** @description List of offline task IDs (e.g. `a468bee88def`) */
7232
+ "filter[installation.id]": string[];
7217
7233
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
7218
7234
  "page[cursor]"?: string;
7219
7235
  /**
@@ -7221,8 +7237,6 @@ export interface paths {
7221
7237
  * @example collection
7222
7238
  */
7223
7239
  include?: string[];
7224
- /** @description List of offline task IDs (e.g. `a468bee88def`) */
7225
- "filter[installation.id]": string[];
7226
7240
  /**
7227
7241
  * @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: collection
7228
7242
  * @example collection
@@ -7566,6 +7580,8 @@ export interface paths {
7566
7580
  get: {
7567
7581
  parameters: {
7568
7582
  query: {
7583
+ /** @description User id. Use `me` for the authenticated user */
7584
+ "filter[owners.id]": string[];
7569
7585
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
7570
7586
  "page[cursor]"?: string;
7571
7587
  /**
@@ -7573,8 +7589,6 @@ export interface paths {
7573
7589
  * @example current
7574
7590
  */
7575
7591
  include?: string[];
7576
- /** @description User id. Use `me` for the authenticated user */
7577
- "filter[owners.id]": string[];
7578
7592
  /**
7579
7593
  * @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: current
7580
7594
  * @example current
@@ -7633,7 +7647,7 @@ export interface paths {
7633
7647
  [name: string]: unknown;
7634
7648
  };
7635
7649
  content: {
7636
- "application/vnd.api+json": components["schemas"]["PlayQueues_Single_Resource_Data_Document"];
7650
+ "application/vnd.api+json": components["schemas"]["PlayQueues_Create_Single_Resource_Data_Document"];
7637
7651
  };
7638
7652
  };
7639
7653
  400: components["responses"]["Default400Response"];
@@ -7974,6 +7988,13 @@ export interface paths {
7974
7988
  };
7975
7989
  };
7976
7990
  responses: {
7991
+ /** @description Successful response */
7992
+ 201: {
7993
+ headers: {
7994
+ [name: string]: unknown;
7995
+ };
7996
+ content?: never;
7997
+ };
7977
7998
  400: components["responses"]["Default400Response"];
7978
7999
  404: components["responses"]["Default404Response"];
7979
8000
  405: components["responses"]["Default405Response"];
@@ -8221,6 +8242,8 @@ export interface paths {
8221
8242
  * @example items
8222
8243
  */
8223
8244
  include?: string[];
8245
+ /** @description User id. Use `me` for the authenticated user */
8246
+ "filter[collaborators.id]"?: string[];
8224
8247
  /** @description List of playlist IDs (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
8225
8248
  "filter[id]"?: string[];
8226
8249
  /** @description User id. Use `me` for the authenticated user */
@@ -8263,13 +8286,7 @@ export interface paths {
8263
8286
  */
8264
8287
  post: {
8265
8288
  parameters: {
8266
- query?: {
8267
- /**
8268
- * @description ISO 3166-1 alpha-2 country code
8269
- * @example US
8270
- */
8271
- countryCode?: string;
8272
- };
8289
+ query?: never;
8273
8290
  header?: {
8274
8291
  /** @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. */
8275
8292
  "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
@@ -8289,7 +8306,7 @@ export interface paths {
8289
8306
  [name: string]: unknown;
8290
8307
  };
8291
8308
  content: {
8292
- "application/vnd.api+json": components["schemas"]["Playlists_Single_Resource_Data_Document"];
8309
+ "application/vnd.api+json": components["schemas"]["Playlists_Create_Single_Resource_Data_Document"];
8293
8310
  };
8294
8311
  };
8295
8312
  400: components["responses"]["Default400Response"];
@@ -8415,13 +8432,7 @@ export interface paths {
8415
8432
  */
8416
8433
  patch: {
8417
8434
  parameters: {
8418
- query?: {
8419
- /**
8420
- * @description ISO 3166-1 alpha-2 country code
8421
- * @example US
8422
- */
8423
- countryCode?: string;
8424
- };
8435
+ query?: never;
8425
8436
  header?: {
8426
8437
  /** @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. */
8427
8438
  "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
@@ -8441,6 +8452,15 @@ export interface paths {
8441
8452
  };
8442
8453
  };
8443
8454
  responses: {
8455
+ /** @description Successful response */
8456
+ 200: {
8457
+ headers: {
8458
+ [name: string]: unknown;
8459
+ };
8460
+ content: {
8461
+ "application/vnd.api+json": components["schemas"]["Playlists_Update_Single_Resource_Data_Document"];
8462
+ };
8463
+ };
8444
8464
  400: components["responses"]["Default400Response"];
8445
8465
  404: components["responses"]["Default404Response"];
8446
8466
  405: components["responses"]["Default405Response"];
@@ -8540,6 +8560,13 @@ export interface paths {
8540
8560
  };
8541
8561
  };
8542
8562
  responses: {
8563
+ /** @description Successful response */
8564
+ 201: {
8565
+ headers: {
8566
+ [name: string]: unknown;
8567
+ };
8568
+ content?: never;
8569
+ };
8543
8570
  400: components["responses"]["Default400Response"];
8544
8571
  404: components["responses"]["Default404Response"];
8545
8572
  405: components["responses"]["Default405Response"];
@@ -8792,6 +8819,8 @@ export interface paths {
8792
8819
  * @example items
8793
8820
  */
8794
8821
  include?: string[];
8822
+ /** @description Filter playlist items by a free-text query (e.g. `halo`) */
8823
+ "filter[query]"?: string;
8795
8824
  /**
8796
8825
  * @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: items
8797
8826
  * @example items
@@ -8836,13 +8865,7 @@ export interface paths {
8836
8865
  */
8837
8866
  post: {
8838
8867
  parameters: {
8839
- query?: {
8840
- /**
8841
- * @description ISO 3166-1 alpha-2 country code
8842
- * @example US
8843
- */
8844
- countryCode?: string;
8845
- };
8868
+ query?: never;
8846
8869
  header?: {
8847
8870
  /** @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. */
8848
8871
  "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
@@ -8868,7 +8891,7 @@ export interface paths {
8868
8891
  [name: string]: unknown;
8869
8892
  };
8870
8893
  content: {
8871
- "application/vnd.api+json": components["schemas"]["Playlists_Items_Multi_Relationship_Data_Document"];
8894
+ "application/vnd.api+json": components["schemas"]["Playlists_Items_Add_Multi_Relationship_Data_Document"];
8872
8895
  };
8873
8896
  };
8874
8897
  400: components["responses"]["Default400Response"];
@@ -9225,7 +9248,7 @@ export interface paths {
9225
9248
  [name: string]: unknown;
9226
9249
  };
9227
9250
  content: {
9228
- "application/vnd.api+json": components["schemas"]["PriceConfigurations_Single_Resource_Data_Document"];
9251
+ "application/vnd.api+json": components["schemas"]["PriceConfigurations_Create_Single_Resource_Data_Document"];
9229
9252
  };
9230
9253
  };
9231
9254
  400: components["responses"]["Default400Response"];
@@ -9313,13 +9336,13 @@ export interface paths {
9313
9336
  get: {
9314
9337
  parameters: {
9315
9338
  query: {
9339
+ /** @description User id. Use `me` for the authenticated user */
9340
+ "filter[owners.id]": string[];
9316
9341
  /**
9317
9342
  * @description Allows the client to customize which related resources should be returned. Available options: owners, provider
9318
9343
  * @example owners
9319
9344
  */
9320
9345
  include?: string[];
9321
- /** @description User id. Use `me` for the authenticated user */
9322
- "filter[owners.id]": string[];
9323
9346
  };
9324
9347
  header?: never;
9325
9348
  path?: never;
@@ -9482,6 +9505,8 @@ export interface paths {
9482
9505
  get: {
9483
9506
  parameters: {
9484
9507
  query: {
9508
+ /** @description Content provider ID (e.g. `50`) */
9509
+ "filter[provider.id]": string[];
9485
9510
  /**
9486
9511
  * @description ISO 3166-1 alpha-2 country code
9487
9512
  * @example US
@@ -9496,8 +9521,6 @@ export interface paths {
9496
9521
  "filter[barcodeId]"?: string[];
9497
9522
  /** @description List of GRIDs (Global Release Identifier, ISO 7064) (e.g. `A10302B0013941653J`) */
9498
9523
  "filter[grid]"?: string[];
9499
- /** @description Content provider ID (e.g. `50`) */
9500
- "filter[provider.id]": string[];
9501
9524
  /**
9502
9525
  * @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
9503
9526
  * @example subject
@@ -9726,6 +9749,10 @@ export interface paths {
9726
9749
  get: {
9727
9750
  parameters: {
9728
9751
  query: {
9752
+ /** @description User id. Use `me` for the authenticated user */
9753
+ "filter[owners.id]": string[];
9754
+ /** @description The type of purchased content (e.g. `albums`) */
9755
+ "filter[subject.type]": ("albums" | "tracks")[];
9729
9756
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
9730
9757
  "page[cursor]"?: string;
9731
9758
  /**
@@ -9733,10 +9760,6 @@ export interface paths {
9733
9760
  * @example subject
9734
9761
  */
9735
9762
  include?: string[];
9736
- /** @description User id. Use `me` for the authenticated user */
9737
- "filter[owners.id]": string[];
9738
- /** @description The type of purchased content (e.g. `albums`) */
9739
- "filter[subject.type]": ("albums" | "tracks")[];
9740
9763
  /**
9741
9764
  * @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
9742
9765
  * @example subject
@@ -9915,6 +9938,10 @@ export interface paths {
9915
9938
  get: {
9916
9939
  parameters: {
9917
9940
  query: {
9941
+ /** @description Filter by subject resource ID (e.g. `12345`) */
9942
+ "filter[subject.id]": string[];
9943
+ /** @description Filter by subject resource type (e.g. `albums`) */
9944
+ "filter[subject.type]": ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments")[];
9918
9945
  stats?: "ALL" | "COUNTS_BY_TYPE" | "TOTAL_COUNT";
9919
9946
  statsOnly?: boolean;
9920
9947
  viewerContext?: string;
@@ -9927,10 +9954,6 @@ export interface paths {
9927
9954
  include?: string[];
9928
9955
  /** @description Filter by emoji (e.g. `👍`) */
9929
9956
  "filter[emoji]"?: string[];
9930
- /** @description Filter by subject resource ID (e.g. `12345`) */
9931
- "filter[subject.id]": string[];
9932
- /** @description Filter by subject resource type (e.g. `albums`) */
9933
- "filter[subject.type]": ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments")[];
9934
9957
  };
9935
9958
  header?: never;
9936
9959
  path?: never;
@@ -9984,7 +10007,7 @@ export interface paths {
9984
10007
  [name: string]: unknown;
9985
10008
  };
9986
10009
  content: {
9987
- "application/vnd.api+json": components["schemas"]["Reactions_Single_Resource_Data_Document"];
10010
+ "application/vnd.api+json": components["schemas"]["Reactions_Create_Single_Resource_Data_Document"];
9988
10011
  };
9989
10012
  };
9990
10013
  400: components["responses"]["Default400Response"];
@@ -10211,7 +10234,7 @@ export interface paths {
10211
10234
  [name: string]: unknown;
10212
10235
  };
10213
10236
  content: {
10214
- "application/vnd.api+json": components["schemas"]["SavedShares_Single_Resource_Data_Document"];
10237
+ "application/vnd.api+json": components["schemas"]["SavedShares_Create_Single_Resource_Data_Document"];
10215
10238
  };
10216
10239
  };
10217
10240
  400: components["responses"]["Default400Response"];
@@ -10331,6 +10354,91 @@ export interface paths {
10331
10354
  patch?: never;
10332
10355
  trace?: never;
10333
10356
  };
10357
+ "/searchResults": {
10358
+ parameters: {
10359
+ query?: never;
10360
+ header?: never;
10361
+ path?: never;
10362
+ cookie?: never;
10363
+ };
10364
+ /**
10365
+ * Get search results by query.
10366
+ * @description Searches for a query and returns a collection containing exactly one search results resource.
10367
+ */
10368
+ get: {
10369
+ parameters: {
10370
+ query: {
10371
+ /** @description Search query (e.g. `hello`) */
10372
+ "filter[query]": string;
10373
+ /**
10374
+ * @description Explicit filter. Valid values: INCLUDE or EXCLUDE
10375
+ * @example INCLUDE
10376
+ */
10377
+ explicitFilter?: "INCLUDE" | "EXCLUDE";
10378
+ /**
10379
+ * @description ISO 3166-1 alpha-2 country code
10380
+ * @example US
10381
+ */
10382
+ countryCode?: string;
10383
+ /**
10384
+ * @description The type of device making the request
10385
+ * @example PHONE
10386
+ */
10387
+ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
10388
+ /**
10389
+ * @description The system type of the device making the request
10390
+ * @example IOS
10391
+ */
10392
+ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
10393
+ /**
10394
+ * @description Client version number
10395
+ * @example 2026.0.1
10396
+ */
10397
+ clientVersion?: string;
10398
+ /**
10399
+ * @description Allows the client to customize which related resources should be returned. Available options: albums, artists, playlists, topHits, tracks, videos
10400
+ * @example albums
10401
+ */
10402
+ include?: string[];
10403
+ /**
10404
+ * @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: albums
10405
+ * @example albums
10406
+ */
10407
+ replaceMedia?: string;
10408
+ };
10409
+ header?: never;
10410
+ path?: never;
10411
+ cookie?: never;
10412
+ };
10413
+ requestBody?: never;
10414
+ responses: {
10415
+ /** @description Successful response */
10416
+ 200: {
10417
+ headers: {
10418
+ [name: string]: unknown;
10419
+ };
10420
+ content: {
10421
+ "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Resource_Data_Document"];
10422
+ };
10423
+ };
10424
+ 400: components["responses"]["Default400Response"];
10425
+ 404: components["responses"]["Default404Response"];
10426
+ 405: components["responses"]["Default405Response"];
10427
+ 406: components["responses"]["Default406Response"];
10428
+ 415: components["responses"]["Default415Response"];
10429
+ 429: components["responses"]["Default429Response"];
10430
+ 500: components["responses"]["Default500Response"];
10431
+ 503: components["responses"]["Default503Response"];
10432
+ };
10433
+ };
10434
+ put?: never;
10435
+ post?: never;
10436
+ delete?: never;
10437
+ options?: never;
10438
+ head?: never;
10439
+ patch?: never;
10440
+ trace?: never;
10441
+ };
10334
10442
  "/searchResults/{id}": {
10335
10443
  parameters: {
10336
10444
  query?: never;
@@ -10340,7 +10448,8 @@ export interface paths {
10340
10448
  };
10341
10449
  /**
10342
10450
  * Get single searchResult.
10343
- * @description Retrieves single searchResult by id.
10451
+ * @deprecated
10452
+ * @description Deprecated. Use GET /searchResults?filter[query]=... to search instead. Opaque identifiers returned by that operation remain valid for searchResults relationship operations.
10344
10453
  */
10345
10454
  get: {
10346
10455
  parameters: {
@@ -10383,10 +10492,7 @@ export interface paths {
10383
10492
  };
10384
10493
  header?: never;
10385
10494
  path: {
10386
- /**
10387
- * @description Search query string used as the resource identifier
10388
- * @example hello
10389
- */
10495
+ /** @description An opaque search results identifier */
10390
10496
  id: string;
10391
10497
  };
10392
10498
  cookie?: never;
@@ -10474,10 +10580,7 @@ export interface paths {
10474
10580
  };
10475
10581
  header?: never;
10476
10582
  path: {
10477
- /**
10478
- * @description Search query string used as the resource identifier
10479
- * @example hello
10480
- */
10583
+ /** @description An opaque search results identifier */
10481
10584
  id: string;
10482
10585
  };
10483
10586
  cookie?: never;
@@ -10565,10 +10668,7 @@ export interface paths {
10565
10668
  };
10566
10669
  header?: never;
10567
10670
  path: {
10568
- /**
10569
- * @description Search query string used as the resource identifier
10570
- * @example hello
10571
- */
10671
+ /** @description An opaque search results identifier */
10572
10672
  id: string;
10573
10673
  };
10574
10674
  cookie?: never;
@@ -10656,10 +10756,7 @@ export interface paths {
10656
10756
  };
10657
10757
  header?: never;
10658
10758
  path: {
10659
- /**
10660
- * @description Search query string used as the resource identifier
10661
- * @example hello
10662
- */
10759
+ /** @description An opaque search results identifier */
10663
10760
  id: string;
10664
10761
  };
10665
10762
  cookie?: never;
@@ -10747,10 +10844,7 @@ export interface paths {
10747
10844
  };
10748
10845
  header?: never;
10749
10846
  path: {
10750
- /**
10751
- * @description Search query string used as the resource identifier
10752
- * @example hello
10753
- */
10847
+ /** @description An opaque search results identifier */
10754
10848
  id: string;
10755
10849
  };
10756
10850
  cookie?: never;
@@ -10838,10 +10932,7 @@ export interface paths {
10838
10932
  };
10839
10933
  header?: never;
10840
10934
  path: {
10841
- /**
10842
- * @description Search query string used as the resource identifier
10843
- * @example hello
10844
- */
10935
+ /** @description An opaque search results identifier */
10845
10936
  id: string;
10846
10937
  };
10847
10938
  cookie?: never;
@@ -10929,10 +11020,7 @@ export interface paths {
10929
11020
  };
10930
11021
  header?: never;
10931
11022
  path: {
10932
- /**
10933
- * @description Search query string used as the resource identifier
10934
- * @example hello
10935
- */
11023
+ /** @description An opaque search results identifier */
10936
11024
  id: string;
10937
11025
  };
10938
11026
  cookie?: never;
@@ -10966,6 +11054,76 @@ export interface paths {
10966
11054
  patch?: never;
10967
11055
  trace?: never;
10968
11056
  };
11057
+ "/searchSuggestions": {
11058
+ parameters: {
11059
+ query?: never;
11060
+ header?: never;
11061
+ path?: never;
11062
+ cookie?: never;
11063
+ };
11064
+ /**
11065
+ * Get search suggestions by query.
11066
+ * @description Searches for a query and returns a collection containing exactly one search suggestions resource.
11067
+ */
11068
+ get: {
11069
+ parameters: {
11070
+ query: {
11071
+ /** @description Search query (e.g. `hello`) */
11072
+ "filter[query]": string;
11073
+ /**
11074
+ * @description Explicit filter. Valid values: INCLUDE or EXCLUDE
11075
+ * @example INCLUDE
11076
+ */
11077
+ explicitFilter?: "INCLUDE" | "EXCLUDE";
11078
+ /**
11079
+ * @description ISO 3166-1 alpha-2 country code
11080
+ * @example US
11081
+ */
11082
+ countryCode?: string;
11083
+ /**
11084
+ * @description Allows the client to customize which related resources should be returned. Available options: directHits, history
11085
+ * @example directHits
11086
+ */
11087
+ include?: string[];
11088
+ /**
11089
+ * @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: directHits
11090
+ * @example directHits
11091
+ */
11092
+ replaceMedia?: string;
11093
+ };
11094
+ header?: never;
11095
+ path?: never;
11096
+ cookie?: never;
11097
+ };
11098
+ requestBody?: never;
11099
+ responses: {
11100
+ /** @description Successful response */
11101
+ 200: {
11102
+ headers: {
11103
+ [name: string]: unknown;
11104
+ };
11105
+ content: {
11106
+ "application/vnd.api+json": components["schemas"]["SearchSuggestions_Multi_Resource_Data_Document"];
11107
+ };
11108
+ };
11109
+ 400: components["responses"]["Default400Response"];
11110
+ 404: components["responses"]["Default404Response"];
11111
+ 405: components["responses"]["Default405Response"];
11112
+ 406: components["responses"]["Default406Response"];
11113
+ 415: components["responses"]["Default415Response"];
11114
+ 429: components["responses"]["Default429Response"];
11115
+ 500: components["responses"]["Default500Response"];
11116
+ 503: components["responses"]["Default503Response"];
11117
+ };
11118
+ };
11119
+ put?: never;
11120
+ post?: never;
11121
+ delete?: never;
11122
+ options?: never;
11123
+ head?: never;
11124
+ patch?: never;
11125
+ trace?: never;
11126
+ };
10969
11127
  "/searchSuggestions/{id}": {
10970
11128
  parameters: {
10971
11129
  query?: never;
@@ -10975,7 +11133,8 @@ export interface paths {
10975
11133
  };
10976
11134
  /**
10977
11135
  * Get single searchSuggestion.
10978
- * @description Retrieves single searchSuggestion by id.
11136
+ * @deprecated
11137
+ * @description Deprecated. Use GET /searchSuggestions?filter[query]=... to search instead. Opaque identifiers returned by that operation remain valid for searchSuggestions relationship operations.
10979
11138
  */
10980
11139
  get: {
10981
11140
  parameters: {
@@ -11003,10 +11162,7 @@ export interface paths {
11003
11162
  };
11004
11163
  header?: never;
11005
11164
  path: {
11006
- /**
11007
- * @description Search query string used as the resource identifier
11008
- * @example hello
11009
- */
11165
+ /** @description An opaque search suggestions identifier */
11010
11166
  id: string;
11011
11167
  };
11012
11168
  cookie?: never;
@@ -11079,10 +11235,7 @@ export interface paths {
11079
11235
  };
11080
11236
  header?: never;
11081
11237
  path: {
11082
- /**
11083
- * @description Search query string used as the resource identifier
11084
- * @example hello
11085
- */
11238
+ /** @description An opaque search suggestions identifier */
11086
11239
  id: string;
11087
11240
  };
11088
11241
  cookie?: never;
@@ -11150,10 +11303,7 @@ export interface paths {
11150
11303
  };
11151
11304
  header?: never;
11152
11305
  path: {
11153
- /**
11154
- * @description Search query string used as the resource identifier
11155
- * @example hello
11156
- */
11306
+ /** @description An opaque search suggestions identifier */
11157
11307
  id: string;
11158
11308
  };
11159
11309
  cookie?: never;
@@ -11201,13 +11351,13 @@ export interface paths {
11201
11351
  get: {
11202
11352
  parameters: {
11203
11353
  query: {
11354
+ /** @description A share code (e.g. `xyz`) */
11355
+ "filter[code]": string[];
11204
11356
  /**
11205
11357
  * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources
11206
11358
  * @example sharedResources
11207
11359
  */
11208
11360
  include?: string[];
11209
- /** @description A share code (e.g. `xyz`) */
11210
- "filter[code]": string[];
11211
11361
  /**
11212
11362
  * @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: sharedResources
11213
11363
  * @example sharedResources
@@ -11266,7 +11416,7 @@ export interface paths {
11266
11416
  [name: string]: unknown;
11267
11417
  };
11268
11418
  content: {
11269
- "application/vnd.api+json": components["schemas"]["Shares_Single_Resource_Data_Document"];
11419
+ "application/vnd.api+json": components["schemas"]["Shares_Create_Single_Resource_Data_Document"];
11270
11420
  };
11271
11421
  };
11272
11422
  400: components["responses"]["Default400Response"];
@@ -11520,7 +11670,7 @@ export interface paths {
11520
11670
  [name: string]: unknown;
11521
11671
  };
11522
11672
  content: {
11523
- "application/vnd.api+json": components["schemas"]["SquareConnections_Single_Resource_Data_Document"];
11673
+ "application/vnd.api+json": components["schemas"]["SquareConnections_Create_Single_Resource_Data_Document"];
11524
11674
  };
11525
11675
  };
11526
11676
  400: components["responses"]["Default400Response"];
@@ -11583,6 +11733,7 @@ export interface paths {
11583
11733
  };
11584
11734
  };
11585
11735
  400: components["responses"]["Default400Response"];
11736
+ 403: components["responses"]["SquareConnectionsReadById403Response"];
11586
11737
  404: components["responses"]["Default404Response"];
11587
11738
  405: components["responses"]["Default405Response"];
11588
11739
  406: components["responses"]["Default406Response"];
@@ -11642,6 +11793,7 @@ export interface paths {
11642
11793
  };
11643
11794
  };
11644
11795
  400: components["responses"]["Default400Response"];
11796
+ 403: components["responses"]["SquareConnectionsReadSingleDataRelationship403Response"];
11645
11797
  404: components["responses"]["Default404Response"];
11646
11798
  405: components["responses"]["Default405Response"];
11647
11799
  406: components["responses"]["Default406Response"];
@@ -11688,10 +11840,11 @@ export interface paths {
11688
11840
  [name: string]: unknown;
11689
11841
  };
11690
11842
  content: {
11691
- "application/vnd.api+json": components["schemas"]["SquareConnections_Single_Relationship_Data_Document"];
11843
+ "application/vnd.api+json": components["schemas"]["SquareConnections_SelectedSite_Update_Single_Relationship_Data_Document"];
11692
11844
  };
11693
11845
  };
11694
11846
  400: components["responses"]["Default400Response"];
11847
+ 403: components["responses"]["SquareConnectionsUpdateSingleDataRelationship403Response"];
11695
11848
  404: components["responses"]["Default404Response"];
11696
11849
  405: components["responses"]["Default405Response"];
11697
11850
  406: components["responses"]["Default406Response"];
@@ -11749,6 +11902,7 @@ export interface paths {
11749
11902
  };
11750
11903
  };
11751
11904
  400: components["responses"]["Default400Response"];
11905
+ 403: components["responses"]["SquareConnectionsReadMultiDataRelationship403Response"];
11752
11906
  404: components["responses"]["Default404Response"];
11753
11907
  405: components["responses"]["Default405Response"];
11754
11908
  406: components["responses"]["Default406Response"];
@@ -11780,13 +11934,13 @@ export interface paths {
11780
11934
  get: {
11781
11935
  parameters: {
11782
11936
  query: {
11937
+ /** @description User id. Use `me` for the authenticated user */
11938
+ "filter[owners.id]": string[];
11783
11939
  /**
11784
11940
  * @description Allows the client to customize which related resources should be returned. Available options: owners
11785
11941
  * @example owners
11786
11942
  */
11787
11943
  include?: string[];
11788
- /** @description User id. Use `me` for the authenticated user */
11789
- "filter[owners.id]": string[];
11790
11944
  };
11791
11945
  header?: never;
11792
11946
  path?: never;
@@ -11846,7 +12000,7 @@ export interface paths {
11846
12000
  [name: string]: unknown;
11847
12001
  };
11848
12002
  content: {
11849
- "application/vnd.api+json": components["schemas"]["StripeConnections_Single_Resource_Data_Document"];
12003
+ "application/vnd.api+json": components["schemas"]["StripeConnections_Create_Single_Resource_Data_Document"];
11850
12004
  };
11851
12005
  };
11852
12006
  400: components["responses"]["Default400Response"];
@@ -11942,13 +12096,13 @@ export interface paths {
11942
12096
  get: {
11943
12097
  parameters: {
11944
12098
  query: {
12099
+ /** @description User id. Use `me` for the authenticated user */
12100
+ "filter[owners.id]": string[];
11945
12101
  /**
11946
12102
  * @description Allows the client to customize which related resources should be returned. Available options: owners
11947
12103
  * @example owners
11948
12104
  */
11949
12105
  include?: string[];
11950
- /** @description User id. Use `me` for the authenticated user */
11951
- "filter[owners.id]": string[];
11952
12106
  };
11953
12107
  header?: never;
11954
12108
  path?: never;
@@ -12058,13 +12212,13 @@ export interface paths {
12058
12212
  get: {
12059
12213
  parameters: {
12060
12214
  query: {
12215
+ /** @description User id. Use `me` for the authenticated user */
12216
+ "filter[owners.id]": string[];
12061
12217
  /**
12062
12218
  * @description Allows the client to customize which related resources should be returned. Available options: priceChange
12063
12219
  * @example priceChange
12064
12220
  */
12065
12221
  include?: string[];
12066
- /** @description User id. Use `me` for the authenticated user */
12067
- "filter[owners.id]": string[];
12068
12222
  };
12069
12223
  header?: never;
12070
12224
  path?: never;
@@ -12118,7 +12272,7 @@ export interface paths {
12118
12272
  [name: string]: unknown;
12119
12273
  };
12120
12274
  content: {
12121
- "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Resource_Data_Document"];
12275
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Create_Single_Resource_Data_Document"];
12122
12276
  };
12123
12277
  };
12124
12278
  400: components["responses"]["Default400Response"];
@@ -12184,7 +12338,7 @@ export interface paths {
12184
12338
  [name: string]: unknown;
12185
12339
  };
12186
12340
  content: {
12187
- "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Resource_Data_Document"];
12341
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Update_Single_Resource_Data_Document"];
12188
12342
  };
12189
12343
  };
12190
12344
  400: components["responses"]["Default400Response"];
@@ -12295,7 +12449,7 @@ export interface paths {
12295
12449
  [name: string]: unknown;
12296
12450
  };
12297
12451
  content: {
12298
- "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Single_Resource_Data_Document"];
12452
+ "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Create_Single_Resource_Data_Document"];
12299
12453
  };
12300
12454
  };
12301
12455
  400: components["responses"]["Default400Response"];
@@ -12450,12 +12604,12 @@ export interface paths {
12450
12604
  get: {
12451
12605
  parameters: {
12452
12606
  query: {
12607
+ /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE, MERCH_GUIDELINES (e.g. `DEVELOPER`) */
12608
+ "filter[termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES")[];
12453
12609
  /** @description Filter by countryCode */
12454
12610
  "filter[countryCode]"?: string[];
12455
12611
  /** @description Filter by isLatestVersion */
12456
12612
  "filter[isLatestVersion]"?: string[];
12457
- /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE (e.g. `DEVELOPER`) */
12458
- "filter[termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
12459
12613
  };
12460
12614
  header?: never;
12461
12615
  path?: never;
@@ -12699,7 +12853,7 @@ export interface paths {
12699
12853
  [name: string]: unknown;
12700
12854
  };
12701
12855
  content: {
12702
- "application/vnd.api+json": components["schemas"]["TrackSourceFiles_Single_Resource_Data_Document"];
12856
+ "application/vnd.api+json": components["schemas"]["TrackSourceFiles_Create_Single_Resource_Data_Document"];
12703
12857
  };
12704
12858
  };
12705
12859
  400: components["responses"]["Default400Response"];
@@ -13064,7 +13218,7 @@ export interface paths {
13064
13218
  [name: string]: unknown;
13065
13219
  };
13066
13220
  content: {
13067
- "application/vnd.api+json": components["schemas"]["Tracks_Single_Resource_Data_Document"];
13221
+ "application/vnd.api+json": components["schemas"]["Tracks_Create_Single_Resource_Data_Document"];
13068
13222
  };
13069
13223
  };
13070
13224
  400: components["responses"]["Default400Response"];
@@ -14566,7 +14720,7 @@ export interface paths {
14566
14720
  [name: string]: unknown;
14567
14721
  };
14568
14722
  content: {
14569
- "application/vnd.api+json": components["schemas"]["UsageRules_Single_Resource_Data_Document"];
14723
+ "application/vnd.api+json": components["schemas"]["UsageRules_Create_Single_Resource_Data_Document"];
14570
14724
  };
14571
14725
  };
14572
14726
  400: components["responses"]["Default400Response"];
@@ -15226,13 +15380,13 @@ export interface paths {
15226
15380
  get: {
15227
15381
  parameters: {
15228
15382
  query: {
15383
+ /** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
15384
+ "filter[id]": string[];
15229
15385
  /**
15230
15386
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection
15231
15387
  * @example items.items
15232
15388
  */
15233
15389
  include?: string[];
15234
- /** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
15235
- "filter[id]": string[];
15236
15390
  /**
15237
15391
  * @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: items.items
15238
15392
  * @example items.items
@@ -15291,7 +15445,7 @@ export interface paths {
15291
15445
  [name: string]: unknown;
15292
15446
  };
15293
15447
  content: {
15294
- "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Single_Resource_Data_Document"];
15448
+ "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Create_Single_Resource_Data_Document"];
15295
15449
  };
15296
15450
  };
15297
15451
  400: components["responses"]["Default400Response"];
@@ -15533,9 +15687,16 @@ export interface paths {
15533
15687
  };
15534
15688
  };
15535
15689
  responses: {
15536
- 400: components["responses"]["Default400Response"];
15537
- 404: components["responses"]["Default404Response"];
15538
- 405: components["responses"]["Default405Response"];
15690
+ /** @description Successful response */
15691
+ 201: {
15692
+ headers: {
15693
+ [name: string]: unknown;
15694
+ };
15695
+ content?: never;
15696
+ };
15697
+ 400: components["responses"]["Default400Response"];
15698
+ 404: components["responses"]["Default404Response"];
15699
+ 405: components["responses"]["Default405Response"];
15539
15700
  406: components["responses"]["Default406Response"];
15540
15701
  409: components["responses"]["Idempotency409Response"];
15541
15702
  415: components["responses"]["Default415Response"];
@@ -17005,6 +17166,13 @@ export interface paths {
17005
17166
  };
17006
17167
  };
17007
17168
  responses: {
17169
+ /** @description Successful response */
17170
+ 201: {
17171
+ headers: {
17172
+ [name: string]: unknown;
17173
+ };
17174
+ content?: never;
17175
+ };
17008
17176
  400: components["responses"]["Default400Response"];
17009
17177
  404: components["responses"]["Default404Response"];
17010
17178
  405: components["responses"]["Default405Response"];
@@ -17155,6 +17323,13 @@ export interface paths {
17155
17323
  };
17156
17324
  };
17157
17325
  responses: {
17326
+ /** @description Successful response */
17327
+ 201: {
17328
+ headers: {
17329
+ [name: string]: unknown;
17330
+ };
17331
+ content?: never;
17332
+ };
17158
17333
  400: components["responses"]["Default400Response"];
17159
17334
  404: components["responses"]["Default404Response"];
17160
17335
  405: components["responses"]["Default405Response"];
@@ -17220,7 +17395,8 @@ export interface paths {
17220
17395
  };
17221
17396
  /**
17222
17397
  * Get owners relationship ("to-many").
17223
- * @description Retrieves owners relationship.
17398
+ * @deprecated
17399
+ * @description Deprecated. Use the owners relationship on the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists.
17224
17400
  */
17225
17401
  get: {
17226
17402
  parameters: {
@@ -17362,6 +17538,13 @@ export interface paths {
17362
17538
  };
17363
17539
  };
17364
17540
  responses: {
17541
+ /** @description Successful response */
17542
+ 201: {
17543
+ headers: {
17544
+ [name: string]: unknown;
17545
+ };
17546
+ content?: never;
17547
+ };
17365
17548
  400: components["responses"]["Default400Response"];
17366
17549
  404: components["responses"]["Default404Response"];
17367
17550
  405: components["responses"]["Default405Response"];
@@ -17512,6 +17695,13 @@ export interface paths {
17512
17695
  };
17513
17696
  };
17514
17697
  responses: {
17698
+ /** @description Successful response */
17699
+ 201: {
17700
+ headers: {
17701
+ [name: string]: unknown;
17702
+ };
17703
+ content?: never;
17704
+ };
17515
17705
  400: components["responses"]["Default400Response"];
17516
17706
  404: components["responses"]["Default404Response"];
17517
17707
  405: components["responses"]["Default405Response"];
@@ -17662,6 +17852,13 @@ export interface paths {
17662
17852
  };
17663
17853
  };
17664
17854
  responses: {
17855
+ /** @description Successful response */
17856
+ 201: {
17857
+ headers: {
17858
+ [name: string]: unknown;
17859
+ };
17860
+ content?: never;
17861
+ };
17665
17862
  400: components["responses"]["Default400Response"];
17666
17863
  404: components["responses"]["Default404Response"];
17667
17864
  405: components["responses"]["Default405Response"];
@@ -17893,7 +18090,7 @@ export interface paths {
17893
18090
  [name: string]: unknown;
17894
18091
  };
17895
18092
  content: {
17896
- "application/vnd.api+json": components["schemas"]["UserDataExportRequests_Single_Resource_Data_Document"];
18093
+ "application/vnd.api+json": components["schemas"]["UserDataExportRequests_Create_Single_Resource_Data_Document"];
17897
18094
  };
17898
18095
  };
17899
18096
  400: components["responses"]["Default400Response"];
@@ -18494,7 +18691,7 @@ export interface paths {
18494
18691
  [name: string]: unknown;
18495
18692
  };
18496
18693
  content: {
18497
- "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document"];
18694
+ "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Artists_Add_Multi_Relationship_Data_Document"];
18498
18695
  };
18499
18696
  };
18500
18697
  400: components["responses"]["Default400Response"];
@@ -18704,7 +18901,7 @@ export interface paths {
18704
18901
  [name: string]: unknown;
18705
18902
  };
18706
18903
  content: {
18707
- "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document"];
18904
+ "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Tracks_Add_Multi_Relationship_Data_Document"];
18708
18905
  };
18709
18906
  };
18710
18907
  400: components["responses"]["Default400Response"];
@@ -18853,7 +19050,7 @@ export interface paths {
18853
19050
  [name: string]: unknown;
18854
19051
  };
18855
19052
  content: {
18856
- "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document"];
19053
+ "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Videos_Add_Multi_Relationship_Data_Document"];
18857
19054
  };
18858
19055
  };
18859
19056
  400: components["responses"]["Default400Response"];
@@ -19304,7 +19501,7 @@ export interface paths {
19304
19501
  [name: string]: unknown;
19305
19502
  };
19306
19503
  content: {
19307
- "application/vnd.api+json": components["schemas"]["UserReports_Single_Resource_Data_Document"];
19504
+ "application/vnd.api+json": components["schemas"]["UserReports_Create_Single_Resource_Data_Document"];
19308
19505
  };
19309
19506
  };
19310
19507
  400: components["responses"]["Default400Response"];
@@ -19339,13 +19536,13 @@ export interface paths {
19339
19536
  get: {
19340
19537
  parameters: {
19341
19538
  query: {
19539
+ /** @description User id. Use `me` for the authenticated user */
19540
+ "filter[owners.id]": string[];
19342
19541
  /**
19343
19542
  * @description Allows the client to customize which related resources should be returned. Available options: decision
19344
19543
  * @example decision
19345
19544
  */
19346
19545
  include?: string[];
19347
- /** @description User id. Use `me` for the authenticated user */
19348
- "filter[owners.id]": string[];
19349
19546
  };
19350
19547
  header?: never;
19351
19548
  path?: never;
@@ -20327,6 +20524,10 @@ export interface components {
20327
20524
  /** Format: date-time */
20328
20525
  createdAt: string;
20329
20526
  };
20527
+ AcceptedTerms_Create_Single_Resource_Data_Document: {
20528
+ data: components["schemas"]["AcceptedTerms_Resource_Object"];
20529
+ links: components["schemas"]["Links"];
20530
+ };
20330
20531
  AcceptedTerms_Multi_Relationship_Data_Document: {
20331
20532
  data?: components["schemas"]["Resource_Identifier"][];
20332
20533
  included?: components["schemas"]["Included"];
@@ -20360,11 +20561,6 @@ export interface components {
20360
20561
  included?: components["schemas"]["Included"];
20361
20562
  links: components["schemas"]["Links"];
20362
20563
  };
20363
- AcceptedTerms_Single_Resource_Data_Document: {
20364
- data: components["schemas"]["AcceptedTerms_Resource_Object"];
20365
- included?: components["schemas"]["Included"];
20366
- links: components["schemas"]["Links"];
20367
- };
20368
20564
  AlbumStatistics_Attributes: {
20369
20565
  /**
20370
20566
  * Format: int32
@@ -20387,11 +20583,6 @@ export interface components {
20387
20583
  included?: components["schemas"]["Included"];
20388
20584
  links: components["schemas"]["Links"];
20389
20585
  };
20390
- AlbumStatistics_Multi_Resource_Data_Document: {
20391
- data: components["schemas"]["AlbumStatistics_Resource_Object"][];
20392
- included?: components["schemas"]["Included"];
20393
- links: components["schemas"]["Links"];
20394
- };
20395
20586
  AlbumStatistics_Relationships: {
20396
20587
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
20397
20588
  };
@@ -20616,6 +20807,10 @@ export interface components {
20616
20807
  */
20617
20808
  version?: string;
20618
20809
  };
20810
+ Albums_Create_Single_Resource_Data_Document: {
20811
+ data: components["schemas"]["Albums_Resource_Object"];
20812
+ links: components["schemas"]["Links"];
20813
+ };
20619
20814
  Albums_Items_Multi_Relationship_Data_Document: {
20620
20815
  data?: components["schemas"]["Albums_Items_Resource_Identifier"][];
20621
20816
  included?: components["schemas"]["Included"];
@@ -20801,9 +20996,8 @@ export interface components {
20801
20996
  */
20802
20997
  createdAt: string;
20803
20998
  };
20804
- Appreciations_Multi_Resource_Data_Document: {
20805
- data: components["schemas"]["Appreciations_Resource_Object"][];
20806
- included?: components["schemas"]["Included"];
20999
+ Appreciations_Create_Single_Resource_Data_Document: {
21000
+ data: components["schemas"]["Appreciations_Resource_Object"];
20807
21001
  links: components["schemas"]["Links"];
20808
21002
  };
20809
21003
  Appreciations_Resource_Object: {
@@ -20819,11 +21013,6 @@ export interface components {
20819
21013
  */
20820
21014
  type: "appreciations";
20821
21015
  };
20822
- Appreciations_Single_Resource_Data_Document: {
20823
- data: components["schemas"]["Appreciations_Resource_Object"];
20824
- included?: components["schemas"]["Included"];
20825
- links: components["schemas"]["Links"];
20826
- };
20827
21016
  ArtistBiographiesUpdateOperation_Payload: {
20828
21017
  data: components["schemas"]["ArtistBiographiesUpdateOperation_Payload_Data"];
20829
21018
  };
@@ -20859,11 +21048,6 @@ export interface components {
20859
21048
  included?: components["schemas"]["Included"];
20860
21049
  links: components["schemas"]["Links"];
20861
21050
  };
20862
- ArtistBiographies_Multi_Resource_Data_Document: {
20863
- data: components["schemas"]["ArtistBiographies_Resource_Object"][];
20864
- included?: components["schemas"]["Included"];
20865
- links: components["schemas"]["Links"];
20866
- };
20867
21051
  ArtistBiographies_Relationships: {
20868
21052
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
20869
21053
  };
@@ -20913,11 +21097,6 @@ export interface components {
20913
21097
  */
20914
21098
  type: "artistClaimStatuses";
20915
21099
  };
20916
- ArtistClaimStatuses_Single_Resource_Data_Document: {
20917
- data: components["schemas"]["ArtistClaimStatuses_Resource_Object"];
20918
- included?: components["schemas"]["Included"];
20919
- links: components["schemas"]["Links"];
20920
- };
20921
21100
  ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload: {
20922
21101
  data: components["schemas"]["ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload_Data"][];
20923
21102
  };
@@ -20982,6 +21161,10 @@ export interface components {
20982
21161
  */
20983
21162
  status: "AWAITING_OAUTH" | "FETCHING_CONTENT" | "VERIFIED" | "NO_MATCHES" | "AUTHENTICATION_FAILED" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "NAME_MISMATCH" | "CLAIMED_ARTIST_MISMATCH";
20984
21163
  };
21164
+ ArtistClaims_Create_Single_Resource_Data_Document: {
21165
+ data: components["schemas"]["ArtistClaims_Resource_Object"];
21166
+ links: components["schemas"]["Links"];
21167
+ };
20985
21168
  ArtistClaims_Multi_Relationship_Data_Document: {
20986
21169
  data?: components["schemas"]["Resource_Identifier"][];
20987
21170
  included?: components["schemas"]["Included"];
@@ -21020,11 +21203,6 @@ export interface components {
21020
21203
  /** @description Name of the artist role */
21021
21204
  name: string;
21022
21205
  };
21023
- ArtistRoles_Multi_Resource_Data_Document: {
21024
- data: components["schemas"]["ArtistRoles_Resource_Object"][];
21025
- included?: components["schemas"]["Included"];
21026
- links: components["schemas"]["Links"];
21027
- };
21028
21206
  ArtistRoles_Resource_Object: {
21029
21207
  attributes?: components["schemas"]["ArtistRoles_Attributes"];
21030
21208
  /**
@@ -21164,6 +21342,10 @@ export interface components {
21164
21342
  */
21165
21343
  spotlighted?: boolean;
21166
21344
  };
21345
+ Artists_Create_Single_Resource_Data_Document: {
21346
+ data: components["schemas"]["Artists_Resource_Object"];
21347
+ links: components["schemas"]["Links"];
21348
+ };
21167
21349
  Artists_Followers_Multi_Relationship_Data_Document: {
21168
21350
  data?: components["schemas"]["Artists_Followers_Resource_Identifier"][];
21169
21351
  included?: components["schemas"]["Included"];
@@ -21410,6 +21592,10 @@ export interface components {
21410
21592
  sourceFile?: components["schemas"]["Artwork_SourceFile"];
21411
21593
  visualMetadata?: components["schemas"]["Artwork_VisualMetadata"];
21412
21594
  };
21595
+ Artworks_Create_Single_Resource_Data_Document: {
21596
+ data: components["schemas"]["Artworks_Resource_Object"];
21597
+ links: components["schemas"]["Links"];
21598
+ };
21413
21599
  Artworks_Multi_Relationship_Data_Document: {
21414
21600
  data?: components["schemas"]["Resource_Identifier"][];
21415
21601
  included?: components["schemas"]["Included"];
@@ -21487,6 +21673,10 @@ export interface components {
21487
21673
  redirectUris?: string[];
21488
21674
  scopes?: string[];
21489
21675
  };
21676
+ Clients_Create_Single_Resource_Data_Document: {
21677
+ data: components["schemas"]["Clients_Resource_Object"];
21678
+ links: components["schemas"]["Links"];
21679
+ };
21490
21680
  Clients_Multi_Relationship_Data_Document: {
21491
21681
  data?: components["schemas"]["Resource_Identifier"][];
21492
21682
  included?: components["schemas"]["Included"];
@@ -21519,6 +21709,10 @@ export interface components {
21519
21709
  included?: components["schemas"]["Included"];
21520
21710
  links: components["schemas"]["Links"];
21521
21711
  };
21712
+ Clients_Update_Single_Resource_Data_Document: {
21713
+ data: components["schemas"]["Clients_Resource_Object"];
21714
+ links: components["schemas"]["Links"];
21715
+ };
21522
21716
  CollaborationInviteRedemptionsCreateOperation_Payload: {
21523
21717
  data: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data"];
21524
21718
  };
@@ -21545,9 +21739,8 @@ export interface components {
21545
21739
  */
21546
21740
  redeemedAt: string;
21547
21741
  };
21548
- CollaborationInviteRedemptions_Multi_Resource_Data_Document: {
21549
- data: components["schemas"]["CollaborationInviteRedemptions_Resource_Object"][];
21550
- included?: components["schemas"]["Included"];
21742
+ CollaborationInviteRedemptions_Create_Single_Resource_Data_Document: {
21743
+ data: components["schemas"]["CollaborationInviteRedemptions_Resource_Object"];
21551
21744
  links: components["schemas"]["Links"];
21552
21745
  };
21553
21746
  CollaborationInviteRedemptions_Resource_Object: {
@@ -21563,11 +21756,6 @@ export interface components {
21563
21756
  */
21564
21757
  type: "collaborationInviteRedemptions";
21565
21758
  };
21566
- CollaborationInviteRedemptions_Single_Resource_Data_Document: {
21567
- data: components["schemas"]["CollaborationInviteRedemptions_Resource_Object"];
21568
- included?: components["schemas"]["Included"];
21569
- links: components["schemas"]["Links"];
21570
- };
21571
21759
  CollaborationInvitesCreateOperation_Payload: {
21572
21760
  data: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data"];
21573
21761
  };
@@ -21603,6 +21791,10 @@ export interface components {
21603
21791
  /** @description Whether the invite has been revoked by the subject's owner */
21604
21792
  revoked: boolean;
21605
21793
  };
21794
+ CollaborationInvites_Create_Single_Resource_Data_Document: {
21795
+ data: components["schemas"]["CollaborationInvites_Resource_Object"];
21796
+ links: components["schemas"]["Links"];
21797
+ };
21606
21798
  CollaborationInvites_Multi_Relationship_Data_Document: {
21607
21799
  data?: components["schemas"]["Resource_Identifier"][];
21608
21800
  included?: components["schemas"]["Included"];
@@ -21730,6 +21922,10 @@ export interface components {
21730
21922
  */
21731
21923
  startTime?: string;
21732
21924
  };
21925
+ Comments_Create_Single_Resource_Data_Document: {
21926
+ data: components["schemas"]["Comments_Resource_Object"];
21927
+ links: components["schemas"]["Links"];
21928
+ };
21733
21929
  Comments_Multi_Relationship_Data_Document: {
21734
21930
  data?: components["schemas"]["Resource_Identifier"][];
21735
21931
  included?: components["schemas"]["Included"];
@@ -21845,6 +22041,10 @@ export interface components {
21845
22041
  included?: components["schemas"]["Included"];
21846
22042
  links: components["schemas"]["Links"];
21847
22043
  };
22044
+ ContentClaims_Create_Single_Resource_Data_Document: {
22045
+ data: components["schemas"]["ContentClaims_Resource_Object"];
22046
+ links: components["schemas"]["Links"];
22047
+ };
21848
22048
  ContentClaims_Multi_Relationship_Data_Document: {
21849
22049
  data?: components["schemas"]["Resource_Identifier"][];
21850
22050
  included?: components["schemas"]["Included"];
@@ -21900,11 +22100,6 @@ export interface components {
21900
22100
  */
21901
22101
  role: string;
21902
22102
  };
21903
- Credits_Multi_Resource_Data_Document: {
21904
- data: components["schemas"]["Credits_Resource_Object"][];
21905
- included?: components["schemas"]["Included"];
21906
- links: components["schemas"]["Links"];
21907
- };
21908
22103
  Credits_Relationships: {
21909
22104
  artist?: components["schemas"]["Single_Relationship_Data_Document"];
21910
22105
  category?: components["schemas"]["Single_Relationship_Data_Document"];
@@ -22095,11 +22290,6 @@ export interface components {
22095
22290
  included?: components["schemas"]["Included"];
22096
22291
  links: components["schemas"]["Links"];
22097
22292
  };
22098
- DspSharingLinks_Single_Resource_Data_Document: {
22099
- data: components["schemas"]["DspSharingLinks_Resource_Object"];
22100
- included?: components["schemas"]["Included"];
22101
- links: components["schemas"]["Links"];
22102
- };
22103
22293
  DspSharingLinks_Subject_Resource_Identifier: {
22104
22294
  /**
22105
22295
  * @description Resource id
@@ -22285,11 +22475,6 @@ export interface components {
22285
22475
  included?: components["schemas"]["Included"];
22286
22476
  links: components["schemas"]["Links"];
22287
22477
  };
22288
- DynamicPages_Single_Resource_Data_Document: {
22289
- data: components["schemas"]["DynamicPages_Resource_Object"];
22290
- included?: components["schemas"]["Included"];
22291
- links: components["schemas"]["Links"];
22292
- };
22293
22478
  DynamicPages_Subject_Resource_Identifier: {
22294
22479
  /**
22295
22480
  * @description Resource id
@@ -22491,6 +22676,10 @@ export interface components {
22491
22676
  */
22492
22677
  name: string;
22493
22678
  };
22679
+ Installations_Create_Single_Resource_Data_Document: {
22680
+ data: components["schemas"]["Installations_Resource_Object"];
22681
+ links: components["schemas"]["Links"];
22682
+ };
22494
22683
  Installations_Multi_Relationship_Data_Document: {
22495
22684
  data?: components["schemas"]["Resource_Identifier"][];
22496
22685
  included?: components["schemas"]["Included"];
@@ -22641,13 +22830,12 @@ export interface components {
22641
22830
  technicalStatus: "PENDING" | "PROCESSING" | "ERROR" | "OK";
22642
22831
  text?: string;
22643
22832
  };
22644
- Lyrics_Multi_Relationship_Data_Document: {
22645
- data?: components["schemas"]["Resource_Identifier"][];
22646
- included?: components["schemas"]["Included"];
22833
+ Lyrics_Create_Single_Resource_Data_Document: {
22834
+ data: components["schemas"]["Lyrics_Resource_Object"];
22647
22835
  links: components["schemas"]["Links"];
22648
22836
  };
22649
- Lyrics_Multi_Resource_Data_Document: {
22650
- data: components["schemas"]["Lyrics_Resource_Object"][];
22837
+ Lyrics_Multi_Relationship_Data_Document: {
22838
+ data?: components["schemas"]["Resource_Identifier"][];
22651
22839
  included?: components["schemas"]["Included"];
22652
22840
  links: components["schemas"]["Links"];
22653
22841
  };
@@ -22778,9 +22966,8 @@ export interface components {
22778
22966
  upcs?: string[];
22779
22967
  websiteOrSocialLink: components["schemas"]["Link_Object"];
22780
22968
  };
22781
- ManualArtistClaims_Multi_Resource_Data_Document: {
22782
- data: components["schemas"]["ManualArtistClaims_Resource_Object"][];
22783
- included?: components["schemas"]["Included"];
22969
+ ManualArtistClaims_Create_Single_Resource_Data_Document: {
22970
+ data: components["schemas"]["ManualArtistClaims_Resource_Object"];
22784
22971
  links: components["schemas"]["Links"];
22785
22972
  };
22786
22973
  ManualArtistClaims_Resource_Object: {
@@ -22796,11 +22983,6 @@ export interface components {
22796
22983
  */
22797
22984
  type: "manualArtistClaims";
22798
22985
  };
22799
- ManualArtistClaims_Single_Resource_Data_Document: {
22800
- data: components["schemas"]["ManualArtistClaims_Resource_Object"];
22801
- included?: components["schemas"]["Included"];
22802
- links: components["schemas"]["Links"];
22803
- };
22804
22986
  Multi_Relationship_Data_Document: {
22805
22987
  data?: components["schemas"]["Resource_Identifier"][];
22806
22988
  links: components["schemas"]["Links"];
@@ -22819,7 +23001,7 @@ export interface components {
22819
23001
  * @description New state for the offline task
22820
23002
  * @enum {string}
22821
23003
  */
22822
- state: "IN_PROGRESS" | "FAILED" | "COMPLETED";
23004
+ state: "PENDING" | "IN_PROGRESS" | "FAILED" | "COMPLETED";
22823
23005
  };
22824
23006
  OfflineTasks_Attributes: {
22825
23007
  /**
@@ -23032,6 +23214,10 @@ export interface components {
23032
23214
  /** @description Queue is shuffled or not */
23033
23215
  shuffled: boolean;
23034
23216
  };
23217
+ PlayQueues_Create_Single_Resource_Data_Document: {
23218
+ data: components["schemas"]["PlayQueues_Resource_Object"];
23219
+ links: components["schemas"]["Links"];
23220
+ };
23035
23221
  PlayQueues_Current_Resource_Identifier: {
23036
23222
  /**
23037
23223
  * @description Resource id
@@ -23181,7 +23367,7 @@ export interface components {
23181
23367
  };
23182
23368
  PlaylistsCreateOperation_Payload_Data_Attributes: {
23183
23369
  /**
23184
- * @description Access type
23370
+ * @description User-selectable playlist visibility.
23185
23371
  * @example PUBLIC
23186
23372
  * @enum {string}
23187
23373
  */
@@ -23208,6 +23394,13 @@ export interface components {
23208
23394
  PlaylistsItemsRelationshipAddOperation_Payload_Meta: {
23209
23395
  positionBefore: string;
23210
23396
  };
23397
+ PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
23398
+ id: string;
23399
+ /** @enum {string} */
23400
+ reason: "NOT_FOUND";
23401
+ /** @enum {string} */
23402
+ type: "tracks" | "videos";
23403
+ };
23211
23404
  PlaylistsItemsRelationshipRemoveOperation_Payload: {
23212
23405
  data: components["schemas"]["PlaylistsItemsRelationshipRemoveOperation_Payload_Data"][];
23213
23406
  };
@@ -23247,7 +23440,7 @@ export interface components {
23247
23440
  };
23248
23441
  PlaylistsUpdateOperation_Payload_Data_Attributes: {
23249
23442
  /**
23250
- * @description Access type
23443
+ * @description User-selectable playlist visibility.
23251
23444
  * @example PUBLIC
23252
23445
  * @enum {string}
23253
23446
  */
@@ -23258,10 +23451,10 @@ export interface components {
23258
23451
  Playlists_Attributes: {
23259
23452
  /**
23260
23453
  * @description Access type
23261
- * @example PUBLIC
23454
+ * @example PRIVATE
23262
23455
  * @enum {string}
23263
23456
  */
23264
- accessType: "PUBLIC" | "UNLISTED";
23457
+ accessType: "PUBLIC" | "UNLISTED" | "PRIVATE";
23265
23458
  /** @description Indicates if the playlist has a duration and set number of tracks */
23266
23459
  bounded: boolean;
23267
23460
  /**
@@ -23300,6 +23493,29 @@ export interface components {
23300
23493
  */
23301
23494
  playlistType: "EDITORIAL" | "USER" | "MIX" | "ARTIST";
23302
23495
  };
23496
+ Playlists_Create_Single_Resource_Data_Document: {
23497
+ data: components["schemas"]["Playlists_Resource_Object"];
23498
+ links: components["schemas"]["Links"];
23499
+ };
23500
+ Playlists_Items_Add_Multi_Relationship_Data_Document: {
23501
+ data: components["schemas"]["Playlists_Items_Add_Resource_Identifier"][];
23502
+ links: components["schemas"]["Links"];
23503
+ meta?: components["schemas"]["Playlists_Items_Add_Multi_Relationship_Data_Document_Meta"];
23504
+ };
23505
+ Playlists_Items_Add_Multi_Relationship_Data_Document_Meta: {
23506
+ skipped: components["schemas"]["PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
23507
+ };
23508
+ Playlists_Items_Add_Resource_Identifier: {
23509
+ id: string;
23510
+ meta?: components["schemas"]["Playlists_Items_Add_Resource_Identifier_Meta"];
23511
+ /** @enum {string} */
23512
+ type: "tracks" | "videos";
23513
+ };
23514
+ Playlists_Items_Add_Resource_Identifier_Meta: {
23515
+ /** Format: date-time */
23516
+ addedAt: string;
23517
+ itemId: string;
23518
+ };
23303
23519
  Playlists_Items_Multi_Relationship_Data_Document: {
23304
23520
  data?: components["schemas"]["Playlists_Items_Resource_Identifier"][];
23305
23521
  included?: components["schemas"]["Included"];
@@ -23387,6 +23603,10 @@ export interface components {
23387
23603
  /** @description Foreground color for the suggested artwork */
23388
23604
  foregroundColor: string;
23389
23605
  };
23606
+ Playlists_Update_Single_Resource_Data_Document: {
23607
+ data: components["schemas"]["Playlists_Resource_Object"];
23608
+ links: components["schemas"]["Links"];
23609
+ };
23390
23610
  PriceConfigurationsCreateOperation_Payload: {
23391
23611
  data: components["schemas"]["PriceConfigurationsCreateOperation_Payload_Data"];
23392
23612
  };
@@ -23431,6 +23651,10 @@ export interface components {
23431
23651
  */
23432
23652
  price: string;
23433
23653
  };
23654
+ PriceConfigurations_Create_Single_Resource_Data_Document: {
23655
+ data: components["schemas"]["PriceConfigurations_Resource_Object"];
23656
+ links: components["schemas"]["Links"];
23657
+ };
23434
23658
  PriceConfigurations_Multi_Resource_Data_Document: {
23435
23659
  data: components["schemas"]["PriceConfigurations_Resource_Object"][];
23436
23660
  included?: components["schemas"]["Included"];
@@ -23491,11 +23715,6 @@ export interface components {
23491
23715
  included?: components["schemas"]["Included"];
23492
23716
  links: components["schemas"]["Links"];
23493
23717
  };
23494
- ProviderOwners_Single_Resource_Data_Document: {
23495
- data: components["schemas"]["ProviderOwners_Resource_Object"];
23496
- included?: components["schemas"]["Included"];
23497
- links: components["schemas"]["Links"];
23498
- };
23499
23718
  ProviderProductInfos_Attributes: {
23500
23719
  barcodeId?: string;
23501
23720
  broken?: boolean;
@@ -23532,11 +23751,6 @@ export interface components {
23532
23751
  included?: components["schemas"]["Included"];
23533
23752
  links: components["schemas"]["Links"];
23534
23753
  };
23535
- ProviderProductInfos_Single_Resource_Data_Document: {
23536
- data: components["schemas"]["ProviderProductInfos_Resource_Object"];
23537
- included?: components["schemas"]["Included"];
23538
- links: components["schemas"]["Links"];
23539
- };
23540
23754
  ProviderProductInfos_Subject_Resource_Identifier: {
23541
23755
  /**
23542
23756
  * @description Resource id
@@ -23565,11 +23779,6 @@ export interface components {
23565
23779
  */
23566
23780
  name: string;
23567
23781
  };
23568
- Providers_Multi_Resource_Data_Document: {
23569
- data: components["schemas"]["Providers_Resource_Object"][];
23570
- included?: components["schemas"]["Included"];
23571
- links: components["schemas"]["Links"];
23572
- };
23573
23782
  Providers_Resource_Object: {
23574
23783
  attributes?: components["schemas"]["Providers_Attributes"];
23575
23784
  /**
@@ -23633,11 +23842,6 @@ export interface components {
23633
23842
  included?: components["schemas"]["Included"];
23634
23843
  links: components["schemas"]["Links"];
23635
23844
  };
23636
- Purchases_Single_Resource_Data_Document: {
23637
- data: components["schemas"]["Purchases_Resource_Object"];
23638
- included?: components["schemas"]["Included"];
23639
- links: components["schemas"]["Links"];
23640
- };
23641
23845
  Purchases_Subject_Resource_Identifier: {
23642
23846
  /**
23643
23847
  * @description Resource id
@@ -23704,6 +23908,10 @@ export interface components {
23704
23908
  /** @description The type of reaction representing an emoji */
23705
23909
  emoji: string;
23706
23910
  };
23911
+ Reactions_Create_Single_Resource_Data_Document: {
23912
+ data: components["schemas"]["Reactions_Resource_Object"];
23913
+ links: components["schemas"]["Links"];
23914
+ };
23707
23915
  Reactions_Multi_Relationship_Data_Document: {
23708
23916
  data?: components["schemas"]["Resource_Identifier"][];
23709
23917
  included?: components["schemas"]["Included"];
@@ -23738,11 +23946,6 @@ export interface components {
23738
23946
  */
23739
23947
  type: "reactions";
23740
23948
  };
23741
- Reactions_Single_Resource_Data_Document: {
23742
- data: components["schemas"]["Reactions_Resource_Object"];
23743
- included?: components["schemas"]["Included"];
23744
- links: components["schemas"]["Links"];
23745
- };
23746
23949
  /** @description Relationship identifier before contextual replacement projection. */
23747
23950
  Replacement_Original_Identifier: {
23748
23951
  /** @example 12345 */
@@ -23808,9 +24011,8 @@ export interface components {
23808
24011
  */
23809
24012
  createdAt: string;
23810
24013
  };
23811
- SavedShares_Multi_Resource_Data_Document: {
23812
- data: components["schemas"]["SavedShares_Resource_Object"][];
23813
- included?: components["schemas"]["Included"];
24014
+ SavedShares_Create_Single_Resource_Data_Document: {
24015
+ data: components["schemas"]["SavedShares_Resource_Object"];
23814
24016
  links: components["schemas"]["Links"];
23815
24017
  };
23816
24018
  SavedShares_Resource_Object: {
@@ -23826,11 +24028,6 @@ export interface components {
23826
24028
  */
23827
24029
  type: "savedShares";
23828
24030
  };
23829
- SavedShares_Single_Resource_Data_Document: {
23830
- data: components["schemas"]["SavedShares_Resource_Object"];
23831
- included?: components["schemas"]["Included"];
23832
- links: components["schemas"]["Links"];
23833
- };
23834
24031
  Scopes_Attributes: {
23835
24032
  /**
23836
24033
  * @description Text shown to the end user on the OAuth consent screen when this scope is requested.
@@ -23872,20 +24069,10 @@ export interface components {
23872
24069
  */
23873
24070
  type: "scopes";
23874
24071
  };
23875
- Scopes_Single_Resource_Data_Document: {
23876
- data: components["schemas"]["Scopes_Resource_Object"];
23877
- included?: components["schemas"]["Included"];
23878
- links: components["schemas"]["Links"];
23879
- };
23880
24072
  SearchHistoryEntries_Attributes: {
23881
24073
  highlights: components["schemas"]["Highlight"][];
23882
24074
  query: string;
23883
24075
  };
23884
- SearchHistoryEntries_Multi_Resource_Data_Document: {
23885
- data: components["schemas"]["SearchHistoryEntries_Resource_Object"][];
23886
- included?: components["schemas"]["Included"];
23887
- links: components["schemas"]["Links"];
23888
- };
23889
24076
  SearchHistoryEntries_Resource_Object: {
23890
24077
  attributes?: components["schemas"]["SearchHistoryEntries_Attributes"];
23891
24078
  /**
@@ -23899,11 +24086,6 @@ export interface components {
23899
24086
  */
23900
24087
  type: "searchHistoryEntries";
23901
24088
  };
23902
- SearchHistoryEntries_Single_Resource_Data_Document: {
23903
- data: components["schemas"]["SearchHistoryEntries_Resource_Object"];
23904
- included?: components["schemas"]["Included"];
23905
- links: components["schemas"]["Links"];
23906
- };
23907
24089
  SearchResults_Albums_Multi_Relationship_Data_Document: {
23908
24090
  data?: components["schemas"]["SearchResults_Albums_Resource_Identifier"][];
23909
24091
  included?: components["schemas"]["Included"];
@@ -23952,6 +24134,11 @@ export interface components {
23952
24134
  * @example beatles
23953
24135
  */
23954
24136
  didYouMean?: string;
24137
+ /**
24138
+ * @description The search query represented by this resource
24139
+ * @example hello
24140
+ */
24141
+ query: string;
23955
24142
  /**
23956
24143
  * @description search request unique tracking number
23957
24144
  * @example 5896e37d-e847-4ca6-9629-ef8001719f7f
@@ -24081,10 +24268,10 @@ export interface components {
24081
24268
  };
24082
24269
  SearchSuggestions_Attributes: {
24083
24270
  /**
24084
- * @deprecated
24085
- * @description Suggestions from search history. Deprecated — use the history relationship instead. Will be deleted shortly.
24271
+ * @description The search query represented by this resource
24272
+ * @example hello
24086
24273
  */
24087
- history?: components["schemas"]["SearchSuggestions_History"][];
24274
+ query: string;
24088
24275
  /** @description Suggested search queries */
24089
24276
  suggestions?: components["schemas"]["SearchSuggestions_Suggestions"][];
24090
24277
  /** @description Unique tracking id */
@@ -24117,11 +24304,6 @@ export interface components {
24117
24304
  /** Format: int32 */
24118
24305
  start: number;
24119
24306
  };
24120
- /** @description Suggestions from search history. Deprecated — use the history relationship instead. Will be deleted shortly. */
24121
- SearchSuggestions_History: {
24122
- highlights?: components["schemas"]["SearchSuggestions_Highlights"][];
24123
- query: string;
24124
- };
24125
24307
  SearchSuggestions_Multi_Relationship_Data_Document: {
24126
24308
  data?: components["schemas"]["Resource_Identifier"][];
24127
24309
  included?: components["schemas"]["Included"];
@@ -24190,6 +24372,10 @@ export interface components {
24190
24372
  /** @description Links external to TIDAL API */
24191
24373
  externalLinks?: components["schemas"]["External_Link"][];
24192
24374
  };
24375
+ Shares_Create_Single_Resource_Data_Document: {
24376
+ data: components["schemas"]["Shares_Resource_Object"];
24377
+ links: components["schemas"]["Links"];
24378
+ };
24193
24379
  Shares_Multi_Relationship_Data_Document: {
24194
24380
  data?: components["schemas"]["Resource_Identifier"][];
24195
24381
  included?: components["schemas"]["Included"];
@@ -24268,6 +24454,45 @@ export interface components {
24268
24454
  */
24269
24455
  redirectUrl?: string;
24270
24456
  };
24457
+ SquareConnectionsReadById403ResponseBody: {
24458
+ errors: {
24459
+ /**
24460
+ * @example REQUIRED_TERMS_NOT_ACCEPTED
24461
+ * @enum {string}
24462
+ */
24463
+ code: "REQUIRED_TERMS_NOT_ACCEPTED";
24464
+ /** @example Latest terms and conditions must be accepted */
24465
+ detail?: string;
24466
+ /** @example 403 */
24467
+ status: string;
24468
+ }[];
24469
+ };
24470
+ SquareConnectionsReadMultiDataRelationship403ResponseBody: {
24471
+ errors: {
24472
+ /**
24473
+ * @example REQUIRED_TERMS_NOT_ACCEPTED
24474
+ * @enum {string}
24475
+ */
24476
+ code: "REQUIRED_TERMS_NOT_ACCEPTED";
24477
+ /** @example Latest terms and conditions must be accepted */
24478
+ detail?: string;
24479
+ /** @example 403 */
24480
+ status: string;
24481
+ }[];
24482
+ };
24483
+ SquareConnectionsReadSingleDataRelationship403ResponseBody: {
24484
+ errors: {
24485
+ /**
24486
+ * @example REQUIRED_TERMS_NOT_ACCEPTED
24487
+ * @enum {string}
24488
+ */
24489
+ code: "REQUIRED_TERMS_NOT_ACCEPTED";
24490
+ /** @example Latest terms and conditions must be accepted */
24491
+ detail?: string;
24492
+ /** @example 403 */
24493
+ status: string;
24494
+ }[];
24495
+ };
24271
24496
  SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload: {
24272
24497
  data: components["schemas"]["SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload_Data"] | (never | null);
24273
24498
  };
@@ -24277,6 +24502,19 @@ export interface components {
24277
24502
  /** @enum {string} */
24278
24503
  type: "squareSites";
24279
24504
  };
24505
+ SquareConnectionsUpdateSingleDataRelationship403ResponseBody: {
24506
+ errors: {
24507
+ /**
24508
+ * @example REQUIRED_TERMS_NOT_ACCEPTED
24509
+ * @enum {string}
24510
+ */
24511
+ code: "REQUIRED_TERMS_NOT_ACCEPTED";
24512
+ /** @example Latest terms and conditions must be accepted */
24513
+ detail?: string;
24514
+ /** @example 403 */
24515
+ status: string;
24516
+ }[];
24517
+ };
24280
24518
  SquareConnectionsUpdateSingleDataRelationship409ResponseBody: {
24281
24519
  errors: {
24282
24520
  /**
@@ -24323,13 +24561,12 @@ export interface components {
24323
24561
  */
24324
24562
  status: "GRANTED" | "REQUIRES_REAUTH";
24325
24563
  };
24326
- SquareConnections_Multi_Relationship_Data_Document: {
24327
- data?: components["schemas"]["Resource_Identifier"][];
24328
- included?: components["schemas"]["Included"];
24564
+ SquareConnections_Create_Single_Resource_Data_Document: {
24565
+ data: components["schemas"]["SquareConnections_Resource_Object"];
24329
24566
  links: components["schemas"]["Links"];
24330
24567
  };
24331
- SquareConnections_Multi_Resource_Data_Document: {
24332
- data: components["schemas"]["SquareConnections_Resource_Object"][];
24568
+ SquareConnections_Multi_Relationship_Data_Document: {
24569
+ data?: components["schemas"]["Resource_Identifier"][];
24333
24570
  included?: components["schemas"]["Included"];
24334
24571
  links: components["schemas"]["Links"];
24335
24572
  };
@@ -24351,6 +24588,15 @@ export interface components {
24351
24588
  */
24352
24589
  type: "squareConnections";
24353
24590
  };
24591
+ SquareConnections_SelectedSite_Update_Resource_Identifier: {
24592
+ id: string;
24593
+ /** @enum {string} */
24594
+ type: "squareSites";
24595
+ };
24596
+ SquareConnections_SelectedSite_Update_Single_Relationship_Data_Document: {
24597
+ data: components["schemas"]["SquareConnections_SelectedSite_Update_Resource_Identifier"] | (never | null);
24598
+ links: components["schemas"]["Links"];
24599
+ };
24354
24600
  SquareConnections_Single_Relationship_Data_Document: {
24355
24601
  data?: components["schemas"]["Resource_Identifier"] | (never | null);
24356
24602
  included?: components["schemas"]["Included"];
@@ -24369,11 +24615,6 @@ export interface components {
24369
24615
  /** @description The site's title as set by the seller in Square */
24370
24616
  siteTitle?: string;
24371
24617
  };
24372
- SquareSites_Multi_Resource_Data_Document: {
24373
- data: components["schemas"]["SquareSites_Resource_Object"][];
24374
- included?: components["schemas"]["Included"];
24375
- links: components["schemas"]["Links"];
24376
- };
24377
24618
  SquareSites_Resource_Object: {
24378
24619
  attributes?: components["schemas"]["SquareSites_Attributes"];
24379
24620
  /**
@@ -24387,11 +24628,6 @@ export interface components {
24387
24628
  */
24388
24629
  type: "squareSites";
24389
24630
  };
24390
- SquareSites_Single_Resource_Data_Document: {
24391
- data: components["schemas"]["SquareSites_Resource_Object"];
24392
- included?: components["schemas"]["Included"];
24393
- links: components["schemas"]["Links"];
24394
- };
24395
24631
  StripeConnectionsCreateOperation_Payload: {
24396
24632
  data: components["schemas"]["StripeConnectionsCreateOperation_Payload_Data"];
24397
24633
  meta?: components["schemas"]["StripeConnectionsCreateOperation_Payload_Meta"];
@@ -24461,6 +24697,10 @@ export interface components {
24461
24697
  */
24462
24698
  status: "PENDING_REQUIREMENTS" | "UNDER_REVIEW" | "ACCEPTED" | "REJECTED" | "SUSPENDED";
24463
24699
  };
24700
+ StripeConnections_Create_Single_Resource_Data_Document: {
24701
+ data: components["schemas"]["StripeConnections_Resource_Object"];
24702
+ links: components["schemas"]["Links"];
24703
+ };
24464
24704
  StripeConnections_Multi_Relationship_Data_Document: {
24465
24705
  data?: components["schemas"]["Resource_Identifier"][];
24466
24706
  included?: components["schemas"]["Included"];
@@ -24488,11 +24728,6 @@ export interface components {
24488
24728
  */
24489
24729
  type: "stripeConnections";
24490
24730
  };
24491
- StripeConnections_Single_Resource_Data_Document: {
24492
- data: components["schemas"]["StripeConnections_Resource_Object"];
24493
- included?: components["schemas"]["Included"];
24494
- links: components["schemas"]["Links"];
24495
- };
24496
24731
  StripeDashboardLinks_Attributes: {
24497
24732
  dashboardLink?: components["schemas"]["Link_Object"];
24498
24733
  };
@@ -24523,11 +24758,6 @@ export interface components {
24523
24758
  */
24524
24759
  type: "stripeDashboardLinks";
24525
24760
  };
24526
- StripeDashboardLinks_Single_Resource_Data_Document: {
24527
- data: components["schemas"]["StripeDashboardLinks_Resource_Object"];
24528
- included?: components["schemas"]["Included"];
24529
- links: components["schemas"]["Links"];
24530
- };
24531
24761
  SubscriptionPriceChangeDecisionsCreateOperation_Payload: {
24532
24762
  data: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data"];
24533
24763
  };
@@ -24583,6 +24813,10 @@ export interface components {
24583
24813
  */
24584
24814
  status: "ACCEPTED" | "REJECTED";
24585
24815
  };
24816
+ SubscriptionPriceChangeDecisions_Create_Single_Resource_Data_Document: {
24817
+ data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"];
24818
+ links: components["schemas"]["Links"];
24819
+ };
24586
24820
  SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document: {
24587
24821
  data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"][];
24588
24822
  included?: components["schemas"]["Included"];
@@ -24610,9 +24844,8 @@ export interface components {
24610
24844
  included?: components["schemas"]["Included"];
24611
24845
  links: components["schemas"]["Links"];
24612
24846
  };
24613
- SubscriptionPriceChangeDecisions_Single_Resource_Data_Document: {
24847
+ SubscriptionPriceChangeDecisions_Update_Single_Resource_Data_Document: {
24614
24848
  data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"];
24615
- included?: components["schemas"]["Included"];
24616
24849
  links: components["schemas"]["Links"];
24617
24850
  };
24618
24851
  TemporaryUserTokensCreateOperation_Payload: {
@@ -24623,13 +24856,12 @@ export interface components {
24623
24856
  type: "temporaryUserTokens";
24624
24857
  };
24625
24858
  TemporaryUserTokens_Attributes: Record<string, never>;
24626
- TemporaryUserTokens_Multi_Relationship_Data_Document: {
24627
- data?: components["schemas"]["Resource_Identifier"][];
24628
- included?: components["schemas"]["Included"];
24859
+ TemporaryUserTokens_Create_Single_Resource_Data_Document: {
24860
+ data: components["schemas"]["TemporaryUserTokens_Resource_Object"];
24629
24861
  links: components["schemas"]["Links"];
24630
24862
  };
24631
- TemporaryUserTokens_Multi_Resource_Data_Document: {
24632
- data: components["schemas"]["TemporaryUserTokens_Resource_Object"][];
24863
+ TemporaryUserTokens_Multi_Relationship_Data_Document: {
24864
+ data?: components["schemas"]["Resource_Identifier"][];
24633
24865
  included?: components["schemas"]["Included"];
24634
24866
  links: components["schemas"]["Links"];
24635
24867
  };
@@ -24661,7 +24893,7 @@ export interface components {
24661
24893
  /** Format: date-time */
24662
24894
  effectiveAt: string;
24663
24895
  /** @enum {string} */
24664
- termsType: "DEVELOPER" | "UPLOAD_MARKETPLACE";
24896
+ termsType: "DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES";
24665
24897
  };
24666
24898
  Terms_Multi_Resource_Data_Document: {
24667
24899
  data: components["schemas"]["Terms_Resource_Object"][];
@@ -24749,11 +24981,6 @@ export interface components {
24749
24981
  /** @description File URL */
24750
24982
  url?: string;
24751
24983
  };
24752
- TrackFiles_Multi_Resource_Data_Document: {
24753
- data: components["schemas"]["TrackFiles_Resource_Object"][];
24754
- included?: components["schemas"]["Included"];
24755
- links: components["schemas"]["Links"];
24756
- };
24757
24984
  TrackFiles_Resource_Object: {
24758
24985
  attributes?: components["schemas"]["TrackFiles_Attributes"];
24759
24986
  /**
@@ -24825,11 +25052,6 @@ export interface components {
24825
25052
  /** @description Manifest URI */
24826
25053
  uri?: string;
24827
25054
  };
24828
- TrackManifests_Multi_Resource_Data_Document: {
24829
- data: components["schemas"]["TrackManifests_Resource_Object"][];
24830
- included?: components["schemas"]["Included"];
24831
- links: components["schemas"]["Links"];
24832
- };
24833
25055
  TrackManifests_Resource_Object: {
24834
25056
  attributes?: components["schemas"]["TrackManifests_Attributes"];
24835
25057
  /**
@@ -24891,13 +25113,12 @@ export interface components {
24891
25113
  status: components["schemas"]["File_Status"];
24892
25114
  uploadLink: components["schemas"]["File_Upload_Link"];
24893
25115
  };
24894
- TrackSourceFiles_Multi_Relationship_Data_Document: {
24895
- data?: components["schemas"]["Resource_Identifier"][];
24896
- included?: components["schemas"]["Included"];
25116
+ TrackSourceFiles_Create_Single_Resource_Data_Document: {
25117
+ data: components["schemas"]["TrackSourceFiles_Resource_Object"];
24897
25118
  links: components["schemas"]["Links"];
24898
25119
  };
24899
- TrackSourceFiles_Multi_Resource_Data_Document: {
24900
- data: components["schemas"]["TrackSourceFiles_Resource_Object"][];
25120
+ TrackSourceFiles_Multi_Relationship_Data_Document: {
25121
+ data?: components["schemas"]["Resource_Identifier"][];
24901
25122
  included?: components["schemas"]["Included"];
24902
25123
  links: components["schemas"]["Links"];
24903
25124
  };
@@ -24940,11 +25161,6 @@ export interface components {
24940
25161
  included?: components["schemas"]["Included"];
24941
25162
  links: components["schemas"]["Links"];
24942
25163
  };
24943
- TrackStatistics_Multi_Resource_Data_Document: {
24944
- data: components["schemas"]["TrackStatistics_Resource_Object"][];
24945
- included?: components["schemas"]["Included"];
24946
- links: components["schemas"]["Links"];
24947
- };
24948
25164
  TrackStatistics_Relationships: {
24949
25165
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
24950
25166
  };
@@ -25034,11 +25250,6 @@ export interface components {
25034
25250
  */
25035
25251
  status: "PENDING" | "PROCESSING" | "ERROR" | "OK";
25036
25252
  };
25037
- TracksMetadataStatus_Multi_Resource_Data_Document: {
25038
- data: components["schemas"]["TracksMetadataStatus_Resource_Object"][];
25039
- included?: components["schemas"]["Included"];
25040
- links: components["schemas"]["Links"];
25041
- };
25042
25253
  TracksMetadataStatus_Resource_Object: {
25043
25254
  attributes?: components["schemas"]["TracksMetadataStatus_Attributes"];
25044
25255
  /**
@@ -25200,6 +25411,10 @@ export interface components {
25200
25411
  */
25201
25412
  version?: string;
25202
25413
  };
25414
+ Tracks_Create_Single_Resource_Data_Document: {
25415
+ data: components["schemas"]["Tracks_Resource_Object"];
25416
+ links: components["schemas"]["Links"];
25417
+ };
25203
25418
  Tracks_Multi_Relationship_Data_Document: {
25204
25419
  data?: components["schemas"]["Resource_Identifier"][];
25205
25420
  included?: components["schemas"]["Included"];
@@ -25367,9 +25582,8 @@ export interface components {
25367
25582
  */
25368
25583
  validFrom?: string;
25369
25584
  };
25370
- UsageRules_Multi_Resource_Data_Document: {
25371
- data: components["schemas"]["UsageRules_Resource_Object"][];
25372
- included?: components["schemas"]["Included"];
25585
+ UsageRules_Create_Single_Resource_Data_Document: {
25586
+ data: components["schemas"]["UsageRules_Resource_Object"];
25373
25587
  links: components["schemas"]["Links"];
25374
25588
  };
25375
25589
  UsageRules_Resource_Object: {
@@ -25449,14 +25663,23 @@ export interface components {
25449
25663
  numberOfItems: number;
25450
25664
  };
25451
25665
  UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document: {
25452
- data?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier"][];
25453
- included?: components["schemas"]["Included"];
25666
+ data: components["schemas"]["UserCollectionAlbums_Items_Add_Resource_Identifier"][];
25454
25667
  links: components["schemas"]["Links"];
25455
25668
  meta?: components["schemas"]["UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta"];
25456
25669
  };
25457
25670
  UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta: {
25458
25671
  skipped: components["schemas"]["UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
25459
25672
  };
25673
+ UserCollectionAlbums_Items_Add_Resource_Identifier: {
25674
+ id: string;
25675
+ meta?: components["schemas"]["UserCollectionAlbums_Items_Add_Resource_Identifier_Meta"];
25676
+ /** @enum {string} */
25677
+ type: "albums";
25678
+ };
25679
+ UserCollectionAlbums_Items_Add_Resource_Identifier_Meta: {
25680
+ /** Format: date-time */
25681
+ addedAt: string;
25682
+ };
25460
25683
  UserCollectionAlbums_Items_Multi_Relationship_Data_Document: {
25461
25684
  data?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier"][];
25462
25685
  included?: components["schemas"]["Included"];
@@ -25485,11 +25708,6 @@ export interface components {
25485
25708
  included?: components["schemas"]["Included"];
25486
25709
  links: components["schemas"]["Links"];
25487
25710
  };
25488
- UserCollectionAlbums_Multi_Resource_Data_Document: {
25489
- data: components["schemas"]["UserCollectionAlbums_Resource_Object"][];
25490
- included?: components["schemas"]["Included"];
25491
- links: components["schemas"]["Links"];
25492
- };
25493
25711
  UserCollectionAlbums_Relationships: {
25494
25712
  items?: components["schemas"]["UserCollectionAlbums_Items_Multi_Relationship_Data_Document"];
25495
25713
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -25567,14 +25785,23 @@ export interface components {
25567
25785
  numberOfItems: number;
25568
25786
  };
25569
25787
  UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document: {
25570
- data?: components["schemas"]["UserCollectionArtists_Items_Resource_Identifier"][];
25571
- included?: components["schemas"]["Included"];
25788
+ data: components["schemas"]["UserCollectionArtists_Items_Add_Resource_Identifier"][];
25572
25789
  links: components["schemas"]["Links"];
25573
25790
  meta?: components["schemas"]["UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta"];
25574
25791
  };
25575
25792
  UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta: {
25576
25793
  skipped: components["schemas"]["UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
25577
25794
  };
25795
+ UserCollectionArtists_Items_Add_Resource_Identifier: {
25796
+ id: string;
25797
+ meta?: components["schemas"]["UserCollectionArtists_Items_Add_Resource_Identifier_Meta"];
25798
+ /** @enum {string} */
25799
+ type: "artists";
25800
+ };
25801
+ UserCollectionArtists_Items_Add_Resource_Identifier_Meta: {
25802
+ /** Format: date-time */
25803
+ addedAt: string;
25804
+ };
25578
25805
  UserCollectionArtists_Items_Multi_Relationship_Data_Document: {
25579
25806
  data?: components["schemas"]["UserCollectionArtists_Items_Resource_Identifier"][];
25580
25807
  included?: components["schemas"]["Included"];
@@ -25602,11 +25829,6 @@ export interface components {
25602
25829
  included?: components["schemas"]["Included"];
25603
25830
  links: components["schemas"]["Links"];
25604
25831
  };
25605
- UserCollectionArtists_Multi_Resource_Data_Document: {
25606
- data: components["schemas"]["UserCollectionArtists_Resource_Object"][];
25607
- included?: components["schemas"]["Included"];
25608
- links: components["schemas"]["Links"];
25609
- };
25610
25832
  UserCollectionArtists_Relationships: {
25611
25833
  items?: components["schemas"]["UserCollectionArtists_Items_Multi_Relationship_Data_Document"];
25612
25834
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -25698,6 +25920,10 @@ export interface components {
25698
25920
  /** Format: int32 */
25699
25921
  numberOfItems?: number;
25700
25922
  };
25923
+ UserCollectionFolders_Create_Single_Resource_Data_Document: {
25924
+ data: components["schemas"]["UserCollectionFolders_Resource_Object"];
25925
+ links: components["schemas"]["Links"];
25926
+ };
25701
25927
  UserCollectionFolders_Items_Multi_Relationship_Data_Document: {
25702
25928
  data?: components["schemas"]["UserCollectionFolders_Items_Resource_Identifier"][];
25703
25929
  included?: components["schemas"]["Included"];
@@ -25813,14 +26039,23 @@ export interface components {
25813
26039
  numberOfItems: number;
25814
26040
  };
25815
26041
  UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document: {
25816
- data?: components["schemas"]["UserCollectionPlaylists_Items_Resource_Identifier"][];
25817
- included?: components["schemas"]["Included"];
26042
+ data: components["schemas"]["UserCollectionPlaylists_Items_Add_Resource_Identifier"][];
25818
26043
  links: components["schemas"]["Links"];
25819
26044
  meta?: components["schemas"]["UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta"];
25820
26045
  };
25821
26046
  UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta: {
25822
26047
  skipped: components["schemas"]["UserCollectionPlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
25823
26048
  };
26049
+ UserCollectionPlaylists_Items_Add_Resource_Identifier: {
26050
+ id: string;
26051
+ meta?: components["schemas"]["UserCollectionPlaylists_Items_Add_Resource_Identifier_Meta"];
26052
+ /** @enum {string} */
26053
+ type: "playlists";
26054
+ };
26055
+ UserCollectionPlaylists_Items_Add_Resource_Identifier_Meta: {
26056
+ /** Format: date-time */
26057
+ addedAt: string;
26058
+ };
25824
26059
  UserCollectionPlaylists_Items_Multi_Relationship_Data_Document: {
25825
26060
  data?: components["schemas"]["UserCollectionPlaylists_Items_Resource_Identifier"][];
25826
26061
  included?: components["schemas"]["Included"];
@@ -25848,11 +26083,6 @@ export interface components {
25848
26083
  included?: components["schemas"]["Included"];
25849
26084
  links: components["schemas"]["Links"];
25850
26085
  };
25851
- UserCollectionPlaylists_Multi_Resource_Data_Document: {
25852
- data: components["schemas"]["UserCollectionPlaylists_Resource_Object"][];
25853
- included?: components["schemas"]["Included"];
25854
- links: components["schemas"]["Links"];
25855
- };
25856
26086
  UserCollectionPlaylists_Relationships: {
25857
26087
  items?: components["schemas"]["UserCollectionPlaylists_Items_Multi_Relationship_Data_Document"];
25858
26088
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -25925,14 +26155,23 @@ export interface components {
25925
26155
  numberOfItems: number;
25926
26156
  };
25927
26157
  UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document: {
25928
- data?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier"][];
25929
- included?: components["schemas"]["Included"];
26158
+ data: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Resource_Identifier"][];
25930
26159
  links: components["schemas"]["Links"];
25931
26160
  meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta"];
25932
26161
  };
25933
26162
  UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta: {
25934
26163
  skipped: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
25935
26164
  };
26165
+ UserCollectionSaveForLaters_Items_Add_Resource_Identifier: {
26166
+ id: string;
26167
+ meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Resource_Identifier_Meta"];
26168
+ /** @enum {string} */
26169
+ type: "tracks" | "albums" | "artists" | "playlists" | "videos";
26170
+ };
26171
+ UserCollectionSaveForLaters_Items_Add_Resource_Identifier_Meta: {
26172
+ /** Format: date-time */
26173
+ addedAt: string;
26174
+ };
25936
26175
  UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document: {
25937
26176
  data?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier"][];
25938
26177
  included?: components["schemas"]["Included"];
@@ -25961,11 +26200,6 @@ export interface components {
25961
26200
  included?: components["schemas"]["Included"];
25962
26201
  links: components["schemas"]["Links"];
25963
26202
  };
25964
- UserCollectionSaveForLaters_Multi_Resource_Data_Document: {
25965
- data: components["schemas"]["UserCollectionSaveForLaters_Resource_Object"][];
25966
- included?: components["schemas"]["Included"];
25967
- links: components["schemas"]["Links"];
25968
- };
25969
26203
  UserCollectionSaveForLaters_Relationships: {
25970
26204
  items?: components["schemas"]["UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"];
25971
26205
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26043,14 +26277,23 @@ export interface components {
26043
26277
  numberOfItems: number;
26044
26278
  };
26045
26279
  UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document: {
26046
- data?: components["schemas"]["UserCollectionTracks_Items_Resource_Identifier"][];
26047
- included?: components["schemas"]["Included"];
26280
+ data: components["schemas"]["UserCollectionTracks_Items_Add_Resource_Identifier"][];
26048
26281
  links: components["schemas"]["Links"];
26049
26282
  meta?: components["schemas"]["UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta"];
26050
26283
  };
26051
26284
  UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta: {
26052
26285
  skipped: components["schemas"]["UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
26053
26286
  };
26287
+ UserCollectionTracks_Items_Add_Resource_Identifier: {
26288
+ id: string;
26289
+ meta?: components["schemas"]["UserCollectionTracks_Items_Add_Resource_Identifier_Meta"];
26290
+ /** @enum {string} */
26291
+ type: "tracks";
26292
+ };
26293
+ UserCollectionTracks_Items_Add_Resource_Identifier_Meta: {
26294
+ /** Format: date-time */
26295
+ addedAt: string;
26296
+ };
26054
26297
  UserCollectionTracks_Items_Multi_Relationship_Data_Document: {
26055
26298
  data?: components["schemas"]["UserCollectionTracks_Items_Resource_Identifier"][];
26056
26299
  included?: components["schemas"]["Included"];
@@ -26079,11 +26322,6 @@ export interface components {
26079
26322
  included?: components["schemas"]["Included"];
26080
26323
  links: components["schemas"]["Links"];
26081
26324
  };
26082
- UserCollectionTracks_Multi_Resource_Data_Document: {
26083
- data: components["schemas"]["UserCollectionTracks_Resource_Object"][];
26084
- included?: components["schemas"]["Included"];
26085
- links: components["schemas"]["Links"];
26086
- };
26087
26325
  UserCollectionTracks_Relationships: {
26088
26326
  items?: components["schemas"]["UserCollectionTracks_Items_Multi_Relationship_Data_Document"];
26089
26327
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26161,14 +26399,23 @@ export interface components {
26161
26399
  numberOfItems: number;
26162
26400
  };
26163
26401
  UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document: {
26164
- data?: components["schemas"]["UserCollectionVideos_Items_Resource_Identifier"][];
26165
- included?: components["schemas"]["Included"];
26402
+ data: components["schemas"]["UserCollectionVideos_Items_Add_Resource_Identifier"][];
26166
26403
  links: components["schemas"]["Links"];
26167
26404
  meta?: components["schemas"]["UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta"];
26168
26405
  };
26169
26406
  UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta: {
26170
26407
  skipped: components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
26171
26408
  };
26409
+ UserCollectionVideos_Items_Add_Resource_Identifier: {
26410
+ id: string;
26411
+ meta?: components["schemas"]["UserCollectionVideos_Items_Add_Resource_Identifier_Meta"];
26412
+ /** @enum {string} */
26413
+ type: "videos";
26414
+ };
26415
+ UserCollectionVideos_Items_Add_Resource_Identifier_Meta: {
26416
+ /** Format: date-time */
26417
+ addedAt: string;
26418
+ };
26172
26419
  UserCollectionVideos_Items_Multi_Relationship_Data_Document: {
26173
26420
  data?: components["schemas"]["UserCollectionVideos_Items_Resource_Identifier"][];
26174
26421
  included?: components["schemas"]["Included"];
@@ -26197,11 +26444,6 @@ export interface components {
26197
26444
  included?: components["schemas"]["Included"];
26198
26445
  links: components["schemas"]["Links"];
26199
26446
  };
26200
- UserCollectionVideos_Multi_Resource_Data_Document: {
26201
- data: components["schemas"]["UserCollectionVideos_Resource_Object"][];
26202
- included?: components["schemas"]["Included"];
26203
- links: components["schemas"]["Links"];
26204
- };
26205
26447
  UserCollectionVideos_Relationships: {
26206
26448
  items?: components["schemas"]["UserCollectionVideos_Items_Multi_Relationship_Data_Document"];
26207
26449
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26384,11 +26626,6 @@ export interface components {
26384
26626
  included?: components["schemas"]["Included"];
26385
26627
  links: components["schemas"]["Links"];
26386
26628
  };
26387
- UserCollections_Multi_Resource_Data_Document: {
26388
- data: components["schemas"]["UserCollections_Resource_Object"][];
26389
- included?: components["schemas"]["Included"];
26390
- links: components["schemas"]["Links"];
26391
- };
26392
26629
  UserCollections_Playlists_Multi_Relationship_Data_Document: {
26393
26630
  data?: components["schemas"]["UserCollections_Playlists_Resource_Identifier"][];
26394
26631
  included?: components["schemas"]["Included"];
@@ -26490,11 +26727,6 @@ export interface components {
26490
26727
  included?: components["schemas"]["Included"];
26491
26728
  links: components["schemas"]["Links"];
26492
26729
  };
26493
- UserDailyMixes_Multi_Resource_Data_Document: {
26494
- data: components["schemas"]["UserDailyMixes_Resource_Object"][];
26495
- included?: components["schemas"]["Included"];
26496
- links: components["schemas"]["Links"];
26497
- };
26498
26730
  UserDailyMixes_Relationships: {
26499
26731
  items?: components["schemas"]["Multi_Relationship_Data_Document"];
26500
26732
  };
@@ -26536,9 +26768,8 @@ export interface components {
26536
26768
  */
26537
26769
  flowType: "GDPR" | "CCPA" | "COPPA" | "ANZ_PA" | "US_PRIVACY_REGULATION" | "APPI" | "RETENTION_POLICY";
26538
26770
  };
26539
- UserDataExportRequests_Multi_Resource_Data_Document: {
26540
- data: components["schemas"]["UserDataExportRequests_Resource_Object"][];
26541
- included?: components["schemas"]["Included"];
26771
+ UserDataExportRequests_Create_Single_Resource_Data_Document: {
26772
+ data: components["schemas"]["UserDataExportRequests_Resource_Object"];
26542
26773
  links: components["schemas"]["Links"];
26543
26774
  };
26544
26775
  UserDataExportRequests_Resource_Object: {
@@ -26554,22 +26785,12 @@ export interface components {
26554
26785
  */
26555
26786
  type: "userDataExportRequests";
26556
26787
  };
26557
- UserDataExportRequests_Single_Resource_Data_Document: {
26558
- data: components["schemas"]["UserDataExportRequests_Resource_Object"];
26559
- included?: components["schemas"]["Included"];
26560
- links: components["schemas"]["Links"];
26561
- };
26562
26788
  UserDiscoveryMixes_Attributes: Record<string, never>;
26563
26789
  UserDiscoveryMixes_Multi_Relationship_Data_Document: {
26564
26790
  data?: components["schemas"]["Resource_Identifier"][];
26565
26791
  included?: components["schemas"]["Included"];
26566
26792
  links: components["schemas"]["Links"];
26567
26793
  };
26568
- UserDiscoveryMixes_Multi_Resource_Data_Document: {
26569
- data: components["schemas"]["UserDiscoveryMixes_Resource_Object"][];
26570
- included?: components["schemas"]["Included"];
26571
- links: components["schemas"]["Links"];
26572
- };
26573
26794
  UserDiscoveryMixes_Relationships: {
26574
26795
  items?: components["schemas"]["Multi_Relationship_Data_Document"];
26575
26796
  };
@@ -26598,11 +26819,6 @@ export interface components {
26598
26819
  included?: components["schemas"]["Included"];
26599
26820
  links: components["schemas"]["Links"];
26600
26821
  };
26601
- UserNewReleaseMixes_Multi_Resource_Data_Document: {
26602
- data: components["schemas"]["UserNewReleaseMixes_Resource_Object"][];
26603
- included?: components["schemas"]["Included"];
26604
- links: components["schemas"]["Links"];
26605
- };
26606
26822
  UserNewReleaseMixes_Relationships: {
26607
26823
  items?: components["schemas"]["Multi_Relationship_Data_Document"];
26608
26824
  };
@@ -26631,11 +26847,6 @@ export interface components {
26631
26847
  included?: components["schemas"]["Included"];
26632
26848
  links: components["schemas"]["Links"];
26633
26849
  };
26634
- UserOfflineMixes_Multi_Resource_Data_Document: {
26635
- data: components["schemas"]["UserOfflineMixes_Resource_Object"][];
26636
- included?: components["schemas"]["Included"];
26637
- links: components["schemas"]["Links"];
26638
- };
26639
26850
  UserOfflineMixes_Relationships: {
26640
26851
  items?: components["schemas"]["Multi_Relationship_Data_Document"];
26641
26852
  };
@@ -26719,6 +26930,15 @@ export interface components {
26719
26930
  /** @enum {string} */
26720
26931
  type: "videos";
26721
26932
  };
26933
+ UserRecommendationBlocks_Artists_Add_Multi_Relationship_Data_Document: {
26934
+ data: components["schemas"]["UserRecommendationBlocks_Artists_Add_Resource_Identifier"][];
26935
+ links: components["schemas"]["Links"];
26936
+ };
26937
+ UserRecommendationBlocks_Artists_Add_Resource_Identifier: {
26938
+ id: string;
26939
+ /** @enum {string} */
26940
+ type: "artists";
26941
+ };
26722
26942
  UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document: {
26723
26943
  data?: components["schemas"]["UserRecommendationBlocks_Artists_Resource_Identifier"][];
26724
26944
  included?: components["schemas"]["Included"];
@@ -26750,11 +26970,6 @@ export interface components {
26750
26970
  included?: components["schemas"]["Included"];
26751
26971
  links: components["schemas"]["Links"];
26752
26972
  };
26753
- UserRecommendationBlocks_Multi_Resource_Data_Document: {
26754
- data: components["schemas"]["UserRecommendationBlocks_Resource_Object"][];
26755
- included?: components["schemas"]["Included"];
26756
- links: components["schemas"]["Links"];
26757
- };
26758
26973
  UserRecommendationBlocks_Relationships: {
26759
26974
  artists?: components["schemas"]["UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document"];
26760
26975
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26780,6 +26995,15 @@ export interface components {
26780
26995
  included?: components["schemas"]["Included"];
26781
26996
  links: components["schemas"]["Links"];
26782
26997
  };
26998
+ UserRecommendationBlocks_Tracks_Add_Multi_Relationship_Data_Document: {
26999
+ data: components["schemas"]["UserRecommendationBlocks_Tracks_Add_Resource_Identifier"][];
27000
+ links: components["schemas"]["Links"];
27001
+ };
27002
+ UserRecommendationBlocks_Tracks_Add_Resource_Identifier: {
27003
+ id: string;
27004
+ /** @enum {string} */
27005
+ type: "tracks";
27006
+ };
26783
27007
  UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document: {
26784
27008
  data?: components["schemas"]["UserRecommendationBlocks_Tracks_Resource_Identifier"][];
26785
27009
  included?: components["schemas"]["Included"];
@@ -26806,6 +27030,15 @@ export interface components {
26806
27030
  createdAt: string;
26807
27031
  replacement?: components["schemas"]["Replacement_Provenance"];
26808
27032
  };
27033
+ UserRecommendationBlocks_Videos_Add_Multi_Relationship_Data_Document: {
27034
+ data: components["schemas"]["UserRecommendationBlocks_Videos_Add_Resource_Identifier"][];
27035
+ links: components["schemas"]["Links"];
27036
+ };
27037
+ UserRecommendationBlocks_Videos_Add_Resource_Identifier: {
27038
+ id: string;
27039
+ /** @enum {string} */
27040
+ type: "videos";
27041
+ };
26809
27042
  UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document: {
26810
27043
  data?: components["schemas"]["UserRecommendationBlocks_Videos_Resource_Identifier"][];
26811
27044
  included?: components["schemas"]["Included"];
@@ -26838,11 +27071,6 @@ export interface components {
26838
27071
  included?: components["schemas"]["Included"];
26839
27072
  links: components["schemas"]["Links"];
26840
27073
  };
26841
- UserRecommendations_Multi_Resource_Data_Document: {
26842
- data: components["schemas"]["UserRecommendations_Resource_Object"][];
26843
- included?: components["schemas"]["Included"];
26844
- links: components["schemas"]["Links"];
26845
- };
26846
27074
  UserRecommendations_Relationships: {
26847
27075
  discoveryMixes?: components["schemas"]["Multi_Relationship_Data_Document"];
26848
27076
  myMixes?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26902,9 +27130,8 @@ export interface components {
26902
27130
  */
26903
27131
  reason: "SEXUAL_CONTENT_OR_NUDITY" | "VIOLENT_OR_DANGEROUS_CONTENT" | "HATEFUL_OR_ABUSIVE_CONTENT" | "HARASSMENT" | "PRIVACY_VIOLATION" | "SCAMS_OR_FRAUD" | "SPAM" | "COPYRIGHT_INFRINGEMENT" | "APPEAL" | "UNKNOWN";
26904
27132
  };
26905
- UserReports_Multi_Resource_Data_Document: {
26906
- data: components["schemas"]["UserReports_Resource_Object"][];
26907
- included?: components["schemas"]["Included"];
27133
+ UserReports_Create_Single_Resource_Data_Document: {
27134
+ data: components["schemas"]["UserReports_Resource_Object"];
26908
27135
  links: components["schemas"]["Links"];
26909
27136
  };
26910
27137
  UserReports_Resource_Object: {
@@ -26920,11 +27147,6 @@ export interface components {
26920
27147
  */
26921
27148
  type: "userReports";
26922
27149
  };
26923
- UserReports_Single_Resource_Data_Document: {
26924
- data: components["schemas"]["UserReports_Resource_Object"];
26925
- included?: components["schemas"]["Included"];
26926
- links: components["schemas"]["Links"];
26927
- };
26928
27150
  UserSubscriptionPriceChanges_Attributes: {
26929
27151
  /**
26930
27152
  * @description ISO 4217 currency code
@@ -26974,11 +27196,6 @@ export interface components {
26974
27196
  included?: components["schemas"]["Included"];
26975
27197
  links: components["schemas"]["Links"];
26976
27198
  };
26977
- UserSubscriptionPriceChanges_Single_Resource_Data_Document: {
26978
- data: components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"];
26979
- included?: components["schemas"]["Included"];
26980
- links: components["schemas"]["Links"];
26981
- };
26982
27199
  Users_Attributes: {
26983
27200
  /**
26984
27201
  * @description ISO 3166-1 alpha-2 country code
@@ -27022,11 +27239,6 @@ export interface components {
27022
27239
  */
27023
27240
  username: string;
27024
27241
  };
27025
- Users_Multi_Resource_Data_Document: {
27026
- data: components["schemas"]["Users_Resource_Object"][];
27027
- included?: components["schemas"]["Included"];
27028
- links: components["schemas"]["Links"];
27029
- };
27030
27242
  Users_Resource_Object: {
27031
27243
  attributes?: components["schemas"]["Users_Attributes"];
27032
27244
  /**
@@ -27085,11 +27297,6 @@ export interface components {
27085
27297
  */
27086
27298
  videoPresentation?: "FULL" | "PREVIEW";
27087
27299
  };
27088
- VideoManifests_Multi_Resource_Data_Document: {
27089
- data: components["schemas"]["VideoManifests_Resource_Object"][];
27090
- included?: components["schemas"]["Included"];
27091
- links: components["schemas"]["Links"];
27092
- };
27093
27300
  VideoManifests_Resource_Object: {
27094
27301
  attributes?: components["schemas"]["VideoManifests_Attributes"];
27095
27302
  /**
@@ -27376,6 +27583,42 @@ export interface components {
27376
27583
  "application/vnd.api+json": components["schemas"]["Idempotency422ResponseBody"];
27377
27584
  };
27378
27585
  };
27586
+ /** @description Latest terms and conditions must be accepted */
27587
+ SquareConnectionsReadById403Response: {
27588
+ headers: {
27589
+ [name: string]: unknown;
27590
+ };
27591
+ content: {
27592
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsReadById403ResponseBody"];
27593
+ };
27594
+ };
27595
+ /** @description Latest terms and conditions must be accepted */
27596
+ SquareConnectionsReadMultiDataRelationship403Response: {
27597
+ headers: {
27598
+ [name: string]: unknown;
27599
+ };
27600
+ content: {
27601
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsReadMultiDataRelationship403ResponseBody"];
27602
+ };
27603
+ };
27604
+ /** @description Latest terms and conditions must be accepted */
27605
+ SquareConnectionsReadSingleDataRelationship403Response: {
27606
+ headers: {
27607
+ [name: string]: unknown;
27608
+ };
27609
+ content: {
27610
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsReadSingleDataRelationship403ResponseBody"];
27611
+ };
27612
+ };
27613
+ /** @description Latest terms and conditions must be accepted */
27614
+ SquareConnectionsUpdateSingleDataRelationship403Response: {
27615
+ headers: {
27616
+ [name: string]: unknown;
27617
+ };
27618
+ content: {
27619
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsUpdateSingleDataRelationship403ResponseBody"];
27620
+ };
27621
+ };
27379
27622
  /** @description Square credential lacks required site scopes; run Square onboarding again; Request already in progress for this idempotency key */
27380
27623
  SquareConnectionsUpdateSingleDataRelationship409Response: {
27381
27624
  headers: {