@tidal-music/api 0.39.1 → 0.41.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,7 +10354,7 @@ export interface paths {
10331
10354
  patch?: never;
10332
10355
  trace?: never;
10333
10356
  };
10334
- "/searchResults/{id}": {
10357
+ "/searchResults": {
10335
10358
  parameters: {
10336
10359
  query?: never;
10337
10360
  header?: never;
@@ -10339,12 +10362,14 @@ export interface paths {
10339
10362
  cookie?: never;
10340
10363
  };
10341
10364
  /**
10342
- * Get single searchResult.
10343
- * @description Retrieves single searchResult by id.
10365
+ * Get search results by query.
10366
+ * @description Searches for a query and returns a collection containing exactly one search results resource.
10344
10367
  */
10345
10368
  get: {
10346
10369
  parameters: {
10347
- query?: {
10370
+ query: {
10371
+ /** @description Search query (e.g. `hello`) */
10372
+ "filter[query]": string;
10348
10373
  /**
10349
10374
  * @description Explicit filter. Valid values: INCLUDE or EXCLUDE
10350
10375
  * @example INCLUDE
@@ -10382,13 +10407,7 @@ export interface paths {
10382
10407
  replaceMedia?: string;
10383
10408
  };
10384
10409
  header?: never;
10385
- path: {
10386
- /**
10387
- * @description Search query string used as the resource identifier
10388
- * @example hello
10389
- */
10390
- id: string;
10391
- };
10410
+ path?: never;
10392
10411
  cookie?: never;
10393
10412
  };
10394
10413
  requestBody?: never;
@@ -10399,7 +10418,7 @@ export interface paths {
10399
10418
  [name: string]: unknown;
10400
10419
  };
10401
10420
  content: {
10402
- "application/vnd.api+json": components["schemas"]["SearchResults_Single_Resource_Data_Document"];
10421
+ "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Resource_Data_Document"];
10403
10422
  };
10404
10423
  };
10405
10424
  400: components["responses"]["Default400Response"];
@@ -10474,10 +10493,7 @@ export interface paths {
10474
10493
  };
10475
10494
  header?: never;
10476
10495
  path: {
10477
- /**
10478
- * @description Search query string used as the resource identifier
10479
- * @example hello
10480
- */
10496
+ /** @description An opaque search results identifier */
10481
10497
  id: string;
10482
10498
  };
10483
10499
  cookie?: never;
@@ -10565,10 +10581,7 @@ export interface paths {
10565
10581
  };
10566
10582
  header?: never;
10567
10583
  path: {
10568
- /**
10569
- * @description Search query string used as the resource identifier
10570
- * @example hello
10571
- */
10584
+ /** @description An opaque search results identifier */
10572
10585
  id: string;
10573
10586
  };
10574
10587
  cookie?: never;
@@ -10656,10 +10669,7 @@ export interface paths {
10656
10669
  };
10657
10670
  header?: never;
10658
10671
  path: {
10659
- /**
10660
- * @description Search query string used as the resource identifier
10661
- * @example hello
10662
- */
10672
+ /** @description An opaque search results identifier */
10663
10673
  id: string;
10664
10674
  };
10665
10675
  cookie?: never;
@@ -10747,10 +10757,7 @@ export interface paths {
10747
10757
  };
10748
10758
  header?: never;
10749
10759
  path: {
10750
- /**
10751
- * @description Search query string used as the resource identifier
10752
- * @example hello
10753
- */
10760
+ /** @description An opaque search results identifier */
10754
10761
  id: string;
10755
10762
  };
10756
10763
  cookie?: never;
@@ -10838,10 +10845,7 @@ export interface paths {
10838
10845
  };
10839
10846
  header?: never;
10840
10847
  path: {
10841
- /**
10842
- * @description Search query string used as the resource identifier
10843
- * @example hello
10844
- */
10848
+ /** @description An opaque search results identifier */
10845
10849
  id: string;
10846
10850
  };
10847
10851
  cookie?: never;
@@ -10929,10 +10933,7 @@ export interface paths {
10929
10933
  };
10930
10934
  header?: never;
10931
10935
  path: {
10932
- /**
10933
- * @description Search query string used as the resource identifier
10934
- * @example hello
10935
- */
10936
+ /** @description An opaque search results identifier */
10936
10937
  id: string;
10937
10938
  };
10938
10939
  cookie?: never;
@@ -10966,7 +10967,7 @@ export interface paths {
10966
10967
  patch?: never;
10967
10968
  trace?: never;
10968
10969
  };
10969
- "/searchSuggestions/{id}": {
10970
+ "/searchSuggestions": {
10970
10971
  parameters: {
10971
10972
  query?: never;
10972
10973
  header?: never;
@@ -10974,12 +10975,14 @@ export interface paths {
10974
10975
  cookie?: never;
10975
10976
  };
10976
10977
  /**
10977
- * Get single searchSuggestion.
10978
- * @description Retrieves single searchSuggestion by id.
10978
+ * Get search suggestions by query.
10979
+ * @description Searches for a query and returns a collection containing exactly one search suggestions resource.
10979
10980
  */
10980
10981
  get: {
10981
10982
  parameters: {
10982
- query?: {
10983
+ query: {
10984
+ /** @description Search query (e.g. `hello`) */
10985
+ "filter[query]": string;
10983
10986
  /**
10984
10987
  * @description Explicit filter. Valid values: INCLUDE or EXCLUDE
10985
10988
  * @example INCLUDE
@@ -11002,13 +11005,7 @@ export interface paths {
11002
11005
  replaceMedia?: string;
11003
11006
  };
11004
11007
  header?: never;
11005
- path: {
11006
- /**
11007
- * @description Search query string used as the resource identifier
11008
- * @example hello
11009
- */
11010
- id: string;
11011
- };
11008
+ path?: never;
11012
11009
  cookie?: never;
11013
11010
  };
11014
11011
  requestBody?: never;
@@ -11019,7 +11016,7 @@ export interface paths {
11019
11016
  [name: string]: unknown;
11020
11017
  };
11021
11018
  content: {
11022
- "application/vnd.api+json": components["schemas"]["SearchSuggestions_Single_Resource_Data_Document"];
11019
+ "application/vnd.api+json": components["schemas"]["SearchSuggestions_Multi_Resource_Data_Document"];
11023
11020
  };
11024
11021
  };
11025
11022
  400: components["responses"]["Default400Response"];
@@ -11079,10 +11076,7 @@ export interface paths {
11079
11076
  };
11080
11077
  header?: never;
11081
11078
  path: {
11082
- /**
11083
- * @description Search query string used as the resource identifier
11084
- * @example hello
11085
- */
11079
+ /** @description An opaque search suggestions identifier */
11086
11080
  id: string;
11087
11081
  };
11088
11082
  cookie?: never;
@@ -11150,10 +11144,7 @@ export interface paths {
11150
11144
  };
11151
11145
  header?: never;
11152
11146
  path: {
11153
- /**
11154
- * @description Search query string used as the resource identifier
11155
- * @example hello
11156
- */
11147
+ /** @description An opaque search suggestions identifier */
11157
11148
  id: string;
11158
11149
  };
11159
11150
  cookie?: never;
@@ -11201,13 +11192,13 @@ export interface paths {
11201
11192
  get: {
11202
11193
  parameters: {
11203
11194
  query: {
11195
+ /** @description A share code (e.g. `xyz`) */
11196
+ "filter[code]": string[];
11204
11197
  /**
11205
11198
  * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources
11206
11199
  * @example sharedResources
11207
11200
  */
11208
11201
  include?: string[];
11209
- /** @description A share code (e.g. `xyz`) */
11210
- "filter[code]": string[];
11211
11202
  /**
11212
11203
  * @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
11204
  * @example sharedResources
@@ -11266,7 +11257,7 @@ export interface paths {
11266
11257
  [name: string]: unknown;
11267
11258
  };
11268
11259
  content: {
11269
- "application/vnd.api+json": components["schemas"]["Shares_Single_Resource_Data_Document"];
11260
+ "application/vnd.api+json": components["schemas"]["Shares_Create_Single_Resource_Data_Document"];
11270
11261
  };
11271
11262
  };
11272
11263
  400: components["responses"]["Default400Response"];
@@ -11520,7 +11511,7 @@ export interface paths {
11520
11511
  [name: string]: unknown;
11521
11512
  };
11522
11513
  content: {
11523
- "application/vnd.api+json": components["schemas"]["SquareConnections_Single_Resource_Data_Document"];
11514
+ "application/vnd.api+json": components["schemas"]["SquareConnections_Create_Single_Resource_Data_Document"];
11524
11515
  };
11525
11516
  };
11526
11517
  400: components["responses"]["Default400Response"];
@@ -11583,6 +11574,7 @@ export interface paths {
11583
11574
  };
11584
11575
  };
11585
11576
  400: components["responses"]["Default400Response"];
11577
+ 403: components["responses"]["SquareConnectionsReadById403Response"];
11586
11578
  404: components["responses"]["Default404Response"];
11587
11579
  405: components["responses"]["Default405Response"];
11588
11580
  406: components["responses"]["Default406Response"];
@@ -11642,6 +11634,7 @@ export interface paths {
11642
11634
  };
11643
11635
  };
11644
11636
  400: components["responses"]["Default400Response"];
11637
+ 403: components["responses"]["SquareConnectionsReadSingleDataRelationship403Response"];
11645
11638
  404: components["responses"]["Default404Response"];
11646
11639
  405: components["responses"]["Default405Response"];
11647
11640
  406: components["responses"]["Default406Response"];
@@ -11688,10 +11681,11 @@ export interface paths {
11688
11681
  [name: string]: unknown;
11689
11682
  };
11690
11683
  content: {
11691
- "application/vnd.api+json": components["schemas"]["SquareConnections_Single_Relationship_Data_Document"];
11684
+ "application/vnd.api+json": components["schemas"]["SquareConnections_SelectedSite_Update_Single_Relationship_Data_Document"];
11692
11685
  };
11693
11686
  };
11694
11687
  400: components["responses"]["Default400Response"];
11688
+ 403: components["responses"]["SquareConnectionsUpdateSingleDataRelationship403Response"];
11695
11689
  404: components["responses"]["Default404Response"];
11696
11690
  405: components["responses"]["Default405Response"];
11697
11691
  406: components["responses"]["Default406Response"];
@@ -11749,6 +11743,7 @@ export interface paths {
11749
11743
  };
11750
11744
  };
11751
11745
  400: components["responses"]["Default400Response"];
11746
+ 403: components["responses"]["SquareConnectionsReadMultiDataRelationship403Response"];
11752
11747
  404: components["responses"]["Default404Response"];
11753
11748
  405: components["responses"]["Default405Response"];
11754
11749
  406: components["responses"]["Default406Response"];
@@ -11780,13 +11775,13 @@ export interface paths {
11780
11775
  get: {
11781
11776
  parameters: {
11782
11777
  query: {
11778
+ /** @description User id. Use `me` for the authenticated user */
11779
+ "filter[owners.id]": string[];
11783
11780
  /**
11784
11781
  * @description Allows the client to customize which related resources should be returned. Available options: owners
11785
11782
  * @example owners
11786
11783
  */
11787
11784
  include?: string[];
11788
- /** @description User id. Use `me` for the authenticated user */
11789
- "filter[owners.id]": string[];
11790
11785
  };
11791
11786
  header?: never;
11792
11787
  path?: never;
@@ -11846,7 +11841,7 @@ export interface paths {
11846
11841
  [name: string]: unknown;
11847
11842
  };
11848
11843
  content: {
11849
- "application/vnd.api+json": components["schemas"]["StripeConnections_Single_Resource_Data_Document"];
11844
+ "application/vnd.api+json": components["schemas"]["StripeConnections_Create_Single_Resource_Data_Document"];
11850
11845
  };
11851
11846
  };
11852
11847
  400: components["responses"]["Default400Response"];
@@ -11942,13 +11937,13 @@ export interface paths {
11942
11937
  get: {
11943
11938
  parameters: {
11944
11939
  query: {
11940
+ /** @description User id. Use `me` for the authenticated user */
11941
+ "filter[owners.id]": string[];
11945
11942
  /**
11946
11943
  * @description Allows the client to customize which related resources should be returned. Available options: owners
11947
11944
  * @example owners
11948
11945
  */
11949
11946
  include?: string[];
11950
- /** @description User id. Use `me` for the authenticated user */
11951
- "filter[owners.id]": string[];
11952
11947
  };
11953
11948
  header?: never;
11954
11949
  path?: never;
@@ -12058,13 +12053,13 @@ export interface paths {
12058
12053
  get: {
12059
12054
  parameters: {
12060
12055
  query: {
12056
+ /** @description User id. Use `me` for the authenticated user */
12057
+ "filter[owners.id]": string[];
12061
12058
  /**
12062
12059
  * @description Allows the client to customize which related resources should be returned. Available options: priceChange
12063
12060
  * @example priceChange
12064
12061
  */
12065
12062
  include?: string[];
12066
- /** @description User id. Use `me` for the authenticated user */
12067
- "filter[owners.id]": string[];
12068
12063
  };
12069
12064
  header?: never;
12070
12065
  path?: never;
@@ -12118,7 +12113,7 @@ export interface paths {
12118
12113
  [name: string]: unknown;
12119
12114
  };
12120
12115
  content: {
12121
- "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Resource_Data_Document"];
12116
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Create_Single_Resource_Data_Document"];
12122
12117
  };
12123
12118
  };
12124
12119
  400: components["responses"]["Default400Response"];
@@ -12184,7 +12179,7 @@ export interface paths {
12184
12179
  [name: string]: unknown;
12185
12180
  };
12186
12181
  content: {
12187
- "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Resource_Data_Document"];
12182
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Update_Single_Resource_Data_Document"];
12188
12183
  };
12189
12184
  };
12190
12185
  400: components["responses"]["Default400Response"];
@@ -12295,7 +12290,7 @@ export interface paths {
12295
12290
  [name: string]: unknown;
12296
12291
  };
12297
12292
  content: {
12298
- "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Single_Resource_Data_Document"];
12293
+ "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Create_Single_Resource_Data_Document"];
12299
12294
  };
12300
12295
  };
12301
12296
  400: components["responses"]["Default400Response"];
@@ -12450,12 +12445,12 @@ export interface paths {
12450
12445
  get: {
12451
12446
  parameters: {
12452
12447
  query: {
12448
+ /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE, MERCH_GUIDELINES (e.g. `DEVELOPER`) */
12449
+ "filter[termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES")[];
12453
12450
  /** @description Filter by countryCode */
12454
12451
  "filter[countryCode]"?: string[];
12455
12452
  /** @description Filter by isLatestVersion */
12456
12453
  "filter[isLatestVersion]"?: string[];
12457
- /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE (e.g. `DEVELOPER`) */
12458
- "filter[termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
12459
12454
  };
12460
12455
  header?: never;
12461
12456
  path?: never;
@@ -12699,7 +12694,7 @@ export interface paths {
12699
12694
  [name: string]: unknown;
12700
12695
  };
12701
12696
  content: {
12702
- "application/vnd.api+json": components["schemas"]["TrackSourceFiles_Single_Resource_Data_Document"];
12697
+ "application/vnd.api+json": components["schemas"]["TrackSourceFiles_Create_Single_Resource_Data_Document"];
12703
12698
  };
12704
12699
  };
12705
12700
  400: components["responses"]["Default400Response"];
@@ -13064,7 +13059,7 @@ export interface paths {
13064
13059
  [name: string]: unknown;
13065
13060
  };
13066
13061
  content: {
13067
- "application/vnd.api+json": components["schemas"]["Tracks_Single_Resource_Data_Document"];
13062
+ "application/vnd.api+json": components["schemas"]["Tracks_Create_Single_Resource_Data_Document"];
13068
13063
  };
13069
13064
  };
13070
13065
  400: components["responses"]["Default400Response"];
@@ -14566,7 +14561,7 @@ export interface paths {
14566
14561
  [name: string]: unknown;
14567
14562
  };
14568
14563
  content: {
14569
- "application/vnd.api+json": components["schemas"]["UsageRules_Single_Resource_Data_Document"];
14564
+ "application/vnd.api+json": components["schemas"]["UsageRules_Create_Single_Resource_Data_Document"];
14570
14565
  };
14571
14566
  };
14572
14567
  400: components["responses"]["Default400Response"];
@@ -15226,13 +15221,13 @@ export interface paths {
15226
15221
  get: {
15227
15222
  parameters: {
15228
15223
  query: {
15224
+ /** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
15225
+ "filter[id]": string[];
15229
15226
  /**
15230
15227
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection
15231
15228
  * @example items.items
15232
15229
  */
15233
15230
  include?: string[];
15234
- /** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
15235
- "filter[id]": string[];
15236
15231
  /**
15237
15232
  * @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
15233
  * @example items.items
@@ -15291,7 +15286,7 @@ export interface paths {
15291
15286
  [name: string]: unknown;
15292
15287
  };
15293
15288
  content: {
15294
- "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Single_Resource_Data_Document"];
15289
+ "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Create_Single_Resource_Data_Document"];
15295
15290
  };
15296
15291
  };
15297
15292
  400: components["responses"]["Default400Response"];
@@ -15533,6 +15528,13 @@ export interface paths {
15533
15528
  };
15534
15529
  };
15535
15530
  responses: {
15531
+ /** @description Successful response */
15532
+ 201: {
15533
+ headers: {
15534
+ [name: string]: unknown;
15535
+ };
15536
+ content?: never;
15537
+ };
15536
15538
  400: components["responses"]["Default400Response"];
15537
15539
  404: components["responses"]["Default404Response"];
15538
15540
  405: components["responses"]["Default405Response"];
@@ -17005,6 +17007,13 @@ export interface paths {
17005
17007
  };
17006
17008
  };
17007
17009
  responses: {
17010
+ /** @description Successful response */
17011
+ 201: {
17012
+ headers: {
17013
+ [name: string]: unknown;
17014
+ };
17015
+ content?: never;
17016
+ };
17008
17017
  400: components["responses"]["Default400Response"];
17009
17018
  404: components["responses"]["Default404Response"];
17010
17019
  405: components["responses"]["Default405Response"];
@@ -17155,6 +17164,13 @@ export interface paths {
17155
17164
  };
17156
17165
  };
17157
17166
  responses: {
17167
+ /** @description Successful response */
17168
+ 201: {
17169
+ headers: {
17170
+ [name: string]: unknown;
17171
+ };
17172
+ content?: never;
17173
+ };
17158
17174
  400: components["responses"]["Default400Response"];
17159
17175
  404: components["responses"]["Default404Response"];
17160
17176
  405: components["responses"]["Default405Response"];
@@ -17220,7 +17236,8 @@ export interface paths {
17220
17236
  };
17221
17237
  /**
17222
17238
  * Get owners relationship ("to-many").
17223
- * @description Retrieves owners relationship.
17239
+ * @deprecated
17240
+ * @description Deprecated. Use the owners relationship on the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists.
17224
17241
  */
17225
17242
  get: {
17226
17243
  parameters: {
@@ -17362,6 +17379,13 @@ export interface paths {
17362
17379
  };
17363
17380
  };
17364
17381
  responses: {
17382
+ /** @description Successful response */
17383
+ 201: {
17384
+ headers: {
17385
+ [name: string]: unknown;
17386
+ };
17387
+ content?: never;
17388
+ };
17365
17389
  400: components["responses"]["Default400Response"];
17366
17390
  404: components["responses"]["Default404Response"];
17367
17391
  405: components["responses"]["Default405Response"];
@@ -17512,6 +17536,13 @@ export interface paths {
17512
17536
  };
17513
17537
  };
17514
17538
  responses: {
17539
+ /** @description Successful response */
17540
+ 201: {
17541
+ headers: {
17542
+ [name: string]: unknown;
17543
+ };
17544
+ content?: never;
17545
+ };
17515
17546
  400: components["responses"]["Default400Response"];
17516
17547
  404: components["responses"]["Default404Response"];
17517
17548
  405: components["responses"]["Default405Response"];
@@ -17662,6 +17693,13 @@ export interface paths {
17662
17693
  };
17663
17694
  };
17664
17695
  responses: {
17696
+ /** @description Successful response */
17697
+ 201: {
17698
+ headers: {
17699
+ [name: string]: unknown;
17700
+ };
17701
+ content?: never;
17702
+ };
17665
17703
  400: components["responses"]["Default400Response"];
17666
17704
  404: components["responses"]["Default404Response"];
17667
17705
  405: components["responses"]["Default405Response"];
@@ -17893,7 +17931,7 @@ export interface paths {
17893
17931
  [name: string]: unknown;
17894
17932
  };
17895
17933
  content: {
17896
- "application/vnd.api+json": components["schemas"]["UserDataExportRequests_Single_Resource_Data_Document"];
17934
+ "application/vnd.api+json": components["schemas"]["UserDataExportRequests_Create_Single_Resource_Data_Document"];
17897
17935
  };
17898
17936
  };
17899
17937
  400: components["responses"]["Default400Response"];
@@ -18494,7 +18532,7 @@ export interface paths {
18494
18532
  [name: string]: unknown;
18495
18533
  };
18496
18534
  content: {
18497
- "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document"];
18535
+ "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Artists_Add_Multi_Relationship_Data_Document"];
18498
18536
  };
18499
18537
  };
18500
18538
  400: components["responses"]["Default400Response"];
@@ -18704,7 +18742,7 @@ export interface paths {
18704
18742
  [name: string]: unknown;
18705
18743
  };
18706
18744
  content: {
18707
- "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document"];
18745
+ "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Tracks_Add_Multi_Relationship_Data_Document"];
18708
18746
  };
18709
18747
  };
18710
18748
  400: components["responses"]["Default400Response"];
@@ -18853,7 +18891,7 @@ export interface paths {
18853
18891
  [name: string]: unknown;
18854
18892
  };
18855
18893
  content: {
18856
- "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document"];
18894
+ "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Videos_Add_Multi_Relationship_Data_Document"];
18857
18895
  };
18858
18896
  };
18859
18897
  400: components["responses"]["Default400Response"];
@@ -19304,7 +19342,7 @@ export interface paths {
19304
19342
  [name: string]: unknown;
19305
19343
  };
19306
19344
  content: {
19307
- "application/vnd.api+json": components["schemas"]["UserReports_Single_Resource_Data_Document"];
19345
+ "application/vnd.api+json": components["schemas"]["UserReports_Create_Single_Resource_Data_Document"];
19308
19346
  };
19309
19347
  };
19310
19348
  400: components["responses"]["Default400Response"];
@@ -19339,13 +19377,13 @@ export interface paths {
19339
19377
  get: {
19340
19378
  parameters: {
19341
19379
  query: {
19380
+ /** @description User id. Use `me` for the authenticated user */
19381
+ "filter[owners.id]": string[];
19342
19382
  /**
19343
19383
  * @description Allows the client to customize which related resources should be returned. Available options: decision
19344
19384
  * @example decision
19345
19385
  */
19346
19386
  include?: string[];
19347
- /** @description User id. Use `me` for the authenticated user */
19348
- "filter[owners.id]": string[];
19349
19387
  };
19350
19388
  header?: never;
19351
19389
  path?: never;
@@ -20327,6 +20365,10 @@ export interface components {
20327
20365
  /** Format: date-time */
20328
20366
  createdAt: string;
20329
20367
  };
20368
+ AcceptedTerms_Create_Single_Resource_Data_Document: {
20369
+ data: components["schemas"]["AcceptedTerms_Resource_Object"];
20370
+ links: components["schemas"]["Links"];
20371
+ };
20330
20372
  AcceptedTerms_Multi_Relationship_Data_Document: {
20331
20373
  data?: components["schemas"]["Resource_Identifier"][];
20332
20374
  included?: components["schemas"]["Included"];
@@ -20360,11 +20402,6 @@ export interface components {
20360
20402
  included?: components["schemas"]["Included"];
20361
20403
  links: components["schemas"]["Links"];
20362
20404
  };
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
20405
  AlbumStatistics_Attributes: {
20369
20406
  /**
20370
20407
  * Format: int32
@@ -20387,11 +20424,6 @@ export interface components {
20387
20424
  included?: components["schemas"]["Included"];
20388
20425
  links: components["schemas"]["Links"];
20389
20426
  };
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
20427
  AlbumStatistics_Relationships: {
20396
20428
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
20397
20429
  };
@@ -20616,6 +20648,10 @@ export interface components {
20616
20648
  */
20617
20649
  version?: string;
20618
20650
  };
20651
+ Albums_Create_Single_Resource_Data_Document: {
20652
+ data: components["schemas"]["Albums_Resource_Object"];
20653
+ links: components["schemas"]["Links"];
20654
+ };
20619
20655
  Albums_Items_Multi_Relationship_Data_Document: {
20620
20656
  data?: components["schemas"]["Albums_Items_Resource_Identifier"][];
20621
20657
  included?: components["schemas"]["Included"];
@@ -20801,9 +20837,8 @@ export interface components {
20801
20837
  */
20802
20838
  createdAt: string;
20803
20839
  };
20804
- Appreciations_Multi_Resource_Data_Document: {
20805
- data: components["schemas"]["Appreciations_Resource_Object"][];
20806
- included?: components["schemas"]["Included"];
20840
+ Appreciations_Create_Single_Resource_Data_Document: {
20841
+ data: components["schemas"]["Appreciations_Resource_Object"];
20807
20842
  links: components["schemas"]["Links"];
20808
20843
  };
20809
20844
  Appreciations_Resource_Object: {
@@ -20819,11 +20854,6 @@ export interface components {
20819
20854
  */
20820
20855
  type: "appreciations";
20821
20856
  };
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
20857
  ArtistBiographiesUpdateOperation_Payload: {
20828
20858
  data: components["schemas"]["ArtistBiographiesUpdateOperation_Payload_Data"];
20829
20859
  };
@@ -20859,11 +20889,6 @@ export interface components {
20859
20889
  included?: components["schemas"]["Included"];
20860
20890
  links: components["schemas"]["Links"];
20861
20891
  };
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
20892
  ArtistBiographies_Relationships: {
20868
20893
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
20869
20894
  };
@@ -20913,11 +20938,6 @@ export interface components {
20913
20938
  */
20914
20939
  type: "artistClaimStatuses";
20915
20940
  };
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
20941
  ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload: {
20922
20942
  data: components["schemas"]["ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload_Data"][];
20923
20943
  };
@@ -20982,6 +21002,10 @@ export interface components {
20982
21002
  */
20983
21003
  status: "AWAITING_OAUTH" | "FETCHING_CONTENT" | "VERIFIED" | "NO_MATCHES" | "AUTHENTICATION_FAILED" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "NAME_MISMATCH" | "CLAIMED_ARTIST_MISMATCH";
20984
21004
  };
21005
+ ArtistClaims_Create_Single_Resource_Data_Document: {
21006
+ data: components["schemas"]["ArtistClaims_Resource_Object"];
21007
+ links: components["schemas"]["Links"];
21008
+ };
20985
21009
  ArtistClaims_Multi_Relationship_Data_Document: {
20986
21010
  data?: components["schemas"]["Resource_Identifier"][];
20987
21011
  included?: components["schemas"]["Included"];
@@ -21020,11 +21044,6 @@ export interface components {
21020
21044
  /** @description Name of the artist role */
21021
21045
  name: string;
21022
21046
  };
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
21047
  ArtistRoles_Resource_Object: {
21029
21048
  attributes?: components["schemas"]["ArtistRoles_Attributes"];
21030
21049
  /**
@@ -21164,6 +21183,10 @@ export interface components {
21164
21183
  */
21165
21184
  spotlighted?: boolean;
21166
21185
  };
21186
+ Artists_Create_Single_Resource_Data_Document: {
21187
+ data: components["schemas"]["Artists_Resource_Object"];
21188
+ links: components["schemas"]["Links"];
21189
+ };
21167
21190
  Artists_Followers_Multi_Relationship_Data_Document: {
21168
21191
  data?: components["schemas"]["Artists_Followers_Resource_Identifier"][];
21169
21192
  included?: components["schemas"]["Included"];
@@ -21410,6 +21433,10 @@ export interface components {
21410
21433
  sourceFile?: components["schemas"]["Artwork_SourceFile"];
21411
21434
  visualMetadata?: components["schemas"]["Artwork_VisualMetadata"];
21412
21435
  };
21436
+ Artworks_Create_Single_Resource_Data_Document: {
21437
+ data: components["schemas"]["Artworks_Resource_Object"];
21438
+ links: components["schemas"]["Links"];
21439
+ };
21413
21440
  Artworks_Multi_Relationship_Data_Document: {
21414
21441
  data?: components["schemas"]["Resource_Identifier"][];
21415
21442
  included?: components["schemas"]["Included"];
@@ -21487,6 +21514,10 @@ export interface components {
21487
21514
  redirectUris?: string[];
21488
21515
  scopes?: string[];
21489
21516
  };
21517
+ Clients_Create_Single_Resource_Data_Document: {
21518
+ data: components["schemas"]["Clients_Resource_Object"];
21519
+ links: components["schemas"]["Links"];
21520
+ };
21490
21521
  Clients_Multi_Relationship_Data_Document: {
21491
21522
  data?: components["schemas"]["Resource_Identifier"][];
21492
21523
  included?: components["schemas"]["Included"];
@@ -21519,6 +21550,10 @@ export interface components {
21519
21550
  included?: components["schemas"]["Included"];
21520
21551
  links: components["schemas"]["Links"];
21521
21552
  };
21553
+ Clients_Update_Single_Resource_Data_Document: {
21554
+ data: components["schemas"]["Clients_Resource_Object"];
21555
+ links: components["schemas"]["Links"];
21556
+ };
21522
21557
  CollaborationInviteRedemptionsCreateOperation_Payload: {
21523
21558
  data: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data"];
21524
21559
  };
@@ -21545,9 +21580,8 @@ export interface components {
21545
21580
  */
21546
21581
  redeemedAt: string;
21547
21582
  };
21548
- CollaborationInviteRedemptions_Multi_Resource_Data_Document: {
21549
- data: components["schemas"]["CollaborationInviteRedemptions_Resource_Object"][];
21550
- included?: components["schemas"]["Included"];
21583
+ CollaborationInviteRedemptions_Create_Single_Resource_Data_Document: {
21584
+ data: components["schemas"]["CollaborationInviteRedemptions_Resource_Object"];
21551
21585
  links: components["schemas"]["Links"];
21552
21586
  };
21553
21587
  CollaborationInviteRedemptions_Resource_Object: {
@@ -21563,11 +21597,6 @@ export interface components {
21563
21597
  */
21564
21598
  type: "collaborationInviteRedemptions";
21565
21599
  };
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
21600
  CollaborationInvitesCreateOperation_Payload: {
21572
21601
  data: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data"];
21573
21602
  };
@@ -21603,6 +21632,10 @@ export interface components {
21603
21632
  /** @description Whether the invite has been revoked by the subject's owner */
21604
21633
  revoked: boolean;
21605
21634
  };
21635
+ CollaborationInvites_Create_Single_Resource_Data_Document: {
21636
+ data: components["schemas"]["CollaborationInvites_Resource_Object"];
21637
+ links: components["schemas"]["Links"];
21638
+ };
21606
21639
  CollaborationInvites_Multi_Relationship_Data_Document: {
21607
21640
  data?: components["schemas"]["Resource_Identifier"][];
21608
21641
  included?: components["schemas"]["Included"];
@@ -21730,6 +21763,10 @@ export interface components {
21730
21763
  */
21731
21764
  startTime?: string;
21732
21765
  };
21766
+ Comments_Create_Single_Resource_Data_Document: {
21767
+ data: components["schemas"]["Comments_Resource_Object"];
21768
+ links: components["schemas"]["Links"];
21769
+ };
21733
21770
  Comments_Multi_Relationship_Data_Document: {
21734
21771
  data?: components["schemas"]["Resource_Identifier"][];
21735
21772
  included?: components["schemas"]["Included"];
@@ -21845,6 +21882,10 @@ export interface components {
21845
21882
  included?: components["schemas"]["Included"];
21846
21883
  links: components["schemas"]["Links"];
21847
21884
  };
21885
+ ContentClaims_Create_Single_Resource_Data_Document: {
21886
+ data: components["schemas"]["ContentClaims_Resource_Object"];
21887
+ links: components["schemas"]["Links"];
21888
+ };
21848
21889
  ContentClaims_Multi_Relationship_Data_Document: {
21849
21890
  data?: components["schemas"]["Resource_Identifier"][];
21850
21891
  included?: components["schemas"]["Included"];
@@ -21900,11 +21941,6 @@ export interface components {
21900
21941
  */
21901
21942
  role: string;
21902
21943
  };
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
21944
  Credits_Relationships: {
21909
21945
  artist?: components["schemas"]["Single_Relationship_Data_Document"];
21910
21946
  category?: components["schemas"]["Single_Relationship_Data_Document"];
@@ -22095,11 +22131,6 @@ export interface components {
22095
22131
  included?: components["schemas"]["Included"];
22096
22132
  links: components["schemas"]["Links"];
22097
22133
  };
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
22134
  DspSharingLinks_Subject_Resource_Identifier: {
22104
22135
  /**
22105
22136
  * @description Resource id
@@ -22285,11 +22316,6 @@ export interface components {
22285
22316
  included?: components["schemas"]["Included"];
22286
22317
  links: components["schemas"]["Links"];
22287
22318
  };
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
22319
  DynamicPages_Subject_Resource_Identifier: {
22294
22320
  /**
22295
22321
  * @description Resource id
@@ -22491,6 +22517,10 @@ export interface components {
22491
22517
  */
22492
22518
  name: string;
22493
22519
  };
22520
+ Installations_Create_Single_Resource_Data_Document: {
22521
+ data: components["schemas"]["Installations_Resource_Object"];
22522
+ links: components["schemas"]["Links"];
22523
+ };
22494
22524
  Installations_Multi_Relationship_Data_Document: {
22495
22525
  data?: components["schemas"]["Resource_Identifier"][];
22496
22526
  included?: components["schemas"]["Included"];
@@ -22641,13 +22671,12 @@ export interface components {
22641
22671
  technicalStatus: "PENDING" | "PROCESSING" | "ERROR" | "OK";
22642
22672
  text?: string;
22643
22673
  };
22644
- Lyrics_Multi_Relationship_Data_Document: {
22645
- data?: components["schemas"]["Resource_Identifier"][];
22646
- included?: components["schemas"]["Included"];
22674
+ Lyrics_Create_Single_Resource_Data_Document: {
22675
+ data: components["schemas"]["Lyrics_Resource_Object"];
22647
22676
  links: components["schemas"]["Links"];
22648
22677
  };
22649
- Lyrics_Multi_Resource_Data_Document: {
22650
- data: components["schemas"]["Lyrics_Resource_Object"][];
22678
+ Lyrics_Multi_Relationship_Data_Document: {
22679
+ data?: components["schemas"]["Resource_Identifier"][];
22651
22680
  included?: components["schemas"]["Included"];
22652
22681
  links: components["schemas"]["Links"];
22653
22682
  };
@@ -22778,9 +22807,8 @@ export interface components {
22778
22807
  upcs?: string[];
22779
22808
  websiteOrSocialLink: components["schemas"]["Link_Object"];
22780
22809
  };
22781
- ManualArtistClaims_Multi_Resource_Data_Document: {
22782
- data: components["schemas"]["ManualArtistClaims_Resource_Object"][];
22783
- included?: components["schemas"]["Included"];
22810
+ ManualArtistClaims_Create_Single_Resource_Data_Document: {
22811
+ data: components["schemas"]["ManualArtistClaims_Resource_Object"];
22784
22812
  links: components["schemas"]["Links"];
22785
22813
  };
22786
22814
  ManualArtistClaims_Resource_Object: {
@@ -22796,11 +22824,6 @@ export interface components {
22796
22824
  */
22797
22825
  type: "manualArtistClaims";
22798
22826
  };
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
22827
  Multi_Relationship_Data_Document: {
22805
22828
  data?: components["schemas"]["Resource_Identifier"][];
22806
22829
  links: components["schemas"]["Links"];
@@ -22819,7 +22842,7 @@ export interface components {
22819
22842
  * @description New state for the offline task
22820
22843
  * @enum {string}
22821
22844
  */
22822
- state: "IN_PROGRESS" | "FAILED" | "COMPLETED";
22845
+ state: "PENDING" | "IN_PROGRESS" | "FAILED" | "COMPLETED";
22823
22846
  };
22824
22847
  OfflineTasks_Attributes: {
22825
22848
  /**
@@ -23032,6 +23055,10 @@ export interface components {
23032
23055
  /** @description Queue is shuffled or not */
23033
23056
  shuffled: boolean;
23034
23057
  };
23058
+ PlayQueues_Create_Single_Resource_Data_Document: {
23059
+ data: components["schemas"]["PlayQueues_Resource_Object"];
23060
+ links: components["schemas"]["Links"];
23061
+ };
23035
23062
  PlayQueues_Current_Resource_Identifier: {
23036
23063
  /**
23037
23064
  * @description Resource id
@@ -23181,7 +23208,7 @@ export interface components {
23181
23208
  };
23182
23209
  PlaylistsCreateOperation_Payload_Data_Attributes: {
23183
23210
  /**
23184
- * @description Access type
23211
+ * @description User-selectable playlist visibility.
23185
23212
  * @example PUBLIC
23186
23213
  * @enum {string}
23187
23214
  */
@@ -23208,10 +23235,17 @@ export interface components {
23208
23235
  PlaylistsItemsRelationshipAddOperation_Payload_Meta: {
23209
23236
  positionBefore: string;
23210
23237
  };
23211
- PlaylistsItemsRelationshipRemoveOperation_Payload: {
23212
- data: components["schemas"]["PlaylistsItemsRelationshipRemoveOperation_Payload_Data"][];
23213
- };
23214
- PlaylistsItemsRelationshipRemoveOperation_Payload_Data: {
23238
+ PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
23239
+ id: string;
23240
+ /** @enum {string} */
23241
+ reason: "NOT_FOUND";
23242
+ /** @enum {string} */
23243
+ type: "tracks" | "videos";
23244
+ };
23245
+ PlaylistsItemsRelationshipRemoveOperation_Payload: {
23246
+ data: components["schemas"]["PlaylistsItemsRelationshipRemoveOperation_Payload_Data"][];
23247
+ };
23248
+ PlaylistsItemsRelationshipRemoveOperation_Payload_Data: {
23215
23249
  id: string;
23216
23250
  meta: components["schemas"]["PlaylistsItemsRelationshipRemoveOperation_Payload_Data_Meta"];
23217
23251
  /** @enum {string} */
@@ -23247,7 +23281,7 @@ export interface components {
23247
23281
  };
23248
23282
  PlaylistsUpdateOperation_Payload_Data_Attributes: {
23249
23283
  /**
23250
- * @description Access type
23284
+ * @description User-selectable playlist visibility.
23251
23285
  * @example PUBLIC
23252
23286
  * @enum {string}
23253
23287
  */
@@ -23258,10 +23292,10 @@ export interface components {
23258
23292
  Playlists_Attributes: {
23259
23293
  /**
23260
23294
  * @description Access type
23261
- * @example PUBLIC
23295
+ * @example PRIVATE
23262
23296
  * @enum {string}
23263
23297
  */
23264
- accessType: "PUBLIC" | "UNLISTED";
23298
+ accessType: "PUBLIC" | "UNLISTED" | "PRIVATE";
23265
23299
  /** @description Indicates if the playlist has a duration and set number of tracks */
23266
23300
  bounded: boolean;
23267
23301
  /**
@@ -23300,6 +23334,29 @@ export interface components {
23300
23334
  */
23301
23335
  playlistType: "EDITORIAL" | "USER" | "MIX" | "ARTIST";
23302
23336
  };
23337
+ Playlists_Create_Single_Resource_Data_Document: {
23338
+ data: components["schemas"]["Playlists_Resource_Object"];
23339
+ links: components["schemas"]["Links"];
23340
+ };
23341
+ Playlists_Items_Add_Multi_Relationship_Data_Document: {
23342
+ data: components["schemas"]["Playlists_Items_Add_Resource_Identifier"][];
23343
+ links: components["schemas"]["Links"];
23344
+ meta?: components["schemas"]["Playlists_Items_Add_Multi_Relationship_Data_Document_Meta"];
23345
+ };
23346
+ Playlists_Items_Add_Multi_Relationship_Data_Document_Meta: {
23347
+ skipped: components["schemas"]["PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
23348
+ };
23349
+ Playlists_Items_Add_Resource_Identifier: {
23350
+ id: string;
23351
+ meta?: components["schemas"]["Playlists_Items_Add_Resource_Identifier_Meta"];
23352
+ /** @enum {string} */
23353
+ type: "tracks" | "videos";
23354
+ };
23355
+ Playlists_Items_Add_Resource_Identifier_Meta: {
23356
+ /** Format: date-time */
23357
+ addedAt: string;
23358
+ itemId: string;
23359
+ };
23303
23360
  Playlists_Items_Multi_Relationship_Data_Document: {
23304
23361
  data?: components["schemas"]["Playlists_Items_Resource_Identifier"][];
23305
23362
  included?: components["schemas"]["Included"];
@@ -23387,6 +23444,10 @@ export interface components {
23387
23444
  /** @description Foreground color for the suggested artwork */
23388
23445
  foregroundColor: string;
23389
23446
  };
23447
+ Playlists_Update_Single_Resource_Data_Document: {
23448
+ data: components["schemas"]["Playlists_Resource_Object"];
23449
+ links: components["schemas"]["Links"];
23450
+ };
23390
23451
  PriceConfigurationsCreateOperation_Payload: {
23391
23452
  data: components["schemas"]["PriceConfigurationsCreateOperation_Payload_Data"];
23392
23453
  };
@@ -23431,6 +23492,10 @@ export interface components {
23431
23492
  */
23432
23493
  price: string;
23433
23494
  };
23495
+ PriceConfigurations_Create_Single_Resource_Data_Document: {
23496
+ data: components["schemas"]["PriceConfigurations_Resource_Object"];
23497
+ links: components["schemas"]["Links"];
23498
+ };
23434
23499
  PriceConfigurations_Multi_Resource_Data_Document: {
23435
23500
  data: components["schemas"]["PriceConfigurations_Resource_Object"][];
23436
23501
  included?: components["schemas"]["Included"];
@@ -23491,11 +23556,6 @@ export interface components {
23491
23556
  included?: components["schemas"]["Included"];
23492
23557
  links: components["schemas"]["Links"];
23493
23558
  };
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
23559
  ProviderProductInfos_Attributes: {
23500
23560
  barcodeId?: string;
23501
23561
  broken?: boolean;
@@ -23532,11 +23592,6 @@ export interface components {
23532
23592
  included?: components["schemas"]["Included"];
23533
23593
  links: components["schemas"]["Links"];
23534
23594
  };
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
23595
  ProviderProductInfos_Subject_Resource_Identifier: {
23541
23596
  /**
23542
23597
  * @description Resource id
@@ -23565,11 +23620,6 @@ export interface components {
23565
23620
  */
23566
23621
  name: string;
23567
23622
  };
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
23623
  Providers_Resource_Object: {
23574
23624
  attributes?: components["schemas"]["Providers_Attributes"];
23575
23625
  /**
@@ -23633,11 +23683,6 @@ export interface components {
23633
23683
  included?: components["schemas"]["Included"];
23634
23684
  links: components["schemas"]["Links"];
23635
23685
  };
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
23686
  Purchases_Subject_Resource_Identifier: {
23642
23687
  /**
23643
23688
  * @description Resource id
@@ -23704,6 +23749,10 @@ export interface components {
23704
23749
  /** @description The type of reaction representing an emoji */
23705
23750
  emoji: string;
23706
23751
  };
23752
+ Reactions_Create_Single_Resource_Data_Document: {
23753
+ data: components["schemas"]["Reactions_Resource_Object"];
23754
+ links: components["schemas"]["Links"];
23755
+ };
23707
23756
  Reactions_Multi_Relationship_Data_Document: {
23708
23757
  data?: components["schemas"]["Resource_Identifier"][];
23709
23758
  included?: components["schemas"]["Included"];
@@ -23738,11 +23787,6 @@ export interface components {
23738
23787
  */
23739
23788
  type: "reactions";
23740
23789
  };
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
23790
  /** @description Relationship identifier before contextual replacement projection. */
23747
23791
  Replacement_Original_Identifier: {
23748
23792
  /** @example 12345 */
@@ -23808,9 +23852,8 @@ export interface components {
23808
23852
  */
23809
23853
  createdAt: string;
23810
23854
  };
23811
- SavedShares_Multi_Resource_Data_Document: {
23812
- data: components["schemas"]["SavedShares_Resource_Object"][];
23813
- included?: components["schemas"]["Included"];
23855
+ SavedShares_Create_Single_Resource_Data_Document: {
23856
+ data: components["schemas"]["SavedShares_Resource_Object"];
23814
23857
  links: components["schemas"]["Links"];
23815
23858
  };
23816
23859
  SavedShares_Resource_Object: {
@@ -23826,11 +23869,6 @@ export interface components {
23826
23869
  */
23827
23870
  type: "savedShares";
23828
23871
  };
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
23872
  Scopes_Attributes: {
23835
23873
  /**
23836
23874
  * @description Text shown to the end user on the OAuth consent screen when this scope is requested.
@@ -23872,20 +23910,10 @@ export interface components {
23872
23910
  */
23873
23911
  type: "scopes";
23874
23912
  };
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
23913
  SearchHistoryEntries_Attributes: {
23881
23914
  highlights: components["schemas"]["Highlight"][];
23882
23915
  query: string;
23883
23916
  };
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
23917
  SearchHistoryEntries_Resource_Object: {
23890
23918
  attributes?: components["schemas"]["SearchHistoryEntries_Attributes"];
23891
23919
  /**
@@ -23899,11 +23927,6 @@ export interface components {
23899
23927
  */
23900
23928
  type: "searchHistoryEntries";
23901
23929
  };
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
23930
  SearchResults_Albums_Multi_Relationship_Data_Document: {
23908
23931
  data?: components["schemas"]["SearchResults_Albums_Resource_Identifier"][];
23909
23932
  included?: components["schemas"]["Included"];
@@ -23952,6 +23975,11 @@ export interface components {
23952
23975
  * @example beatles
23953
23976
  */
23954
23977
  didYouMean?: string;
23978
+ /**
23979
+ * @description The search query represented by this resource
23980
+ * @example hello
23981
+ */
23982
+ query: string;
23955
23983
  /**
23956
23984
  * @description search request unique tracking number
23957
23985
  * @example 5896e37d-e847-4ca6-9629-ef8001719f7f
@@ -24011,11 +24039,6 @@ export interface components {
24011
24039
  */
24012
24040
  type: "searchResults";
24013
24041
  };
24014
- SearchResults_Single_Resource_Data_Document: {
24015
- data: components["schemas"]["SearchResults_Resource_Object"];
24016
- included?: components["schemas"]["Included"];
24017
- links: components["schemas"]["Links"];
24018
- };
24019
24042
  SearchResults_TopHits_Multi_Relationship_Data_Document: {
24020
24043
  data?: components["schemas"]["SearchResults_TopHits_Resource_Identifier"][];
24021
24044
  included?: components["schemas"]["Included"];
@@ -24081,10 +24104,10 @@ export interface components {
24081
24104
  };
24082
24105
  SearchSuggestions_Attributes: {
24083
24106
  /**
24084
- * @deprecated
24085
- * @description Suggestions from search history. Deprecated — use the history relationship instead. Will be deleted shortly.
24107
+ * @description The search query represented by this resource
24108
+ * @example hello
24086
24109
  */
24087
- history?: components["schemas"]["SearchSuggestions_History"][];
24110
+ query: string;
24088
24111
  /** @description Suggested search queries */
24089
24112
  suggestions?: components["schemas"]["SearchSuggestions_Suggestions"][];
24090
24113
  /** @description Unique tracking id */
@@ -24117,11 +24140,6 @@ export interface components {
24117
24140
  /** Format: int32 */
24118
24141
  start: number;
24119
24142
  };
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
24143
  SearchSuggestions_Multi_Relationship_Data_Document: {
24126
24144
  data?: components["schemas"]["Resource_Identifier"][];
24127
24145
  included?: components["schemas"]["Included"];
@@ -24150,11 +24168,6 @@ export interface components {
24150
24168
  */
24151
24169
  type: "searchSuggestions";
24152
24170
  };
24153
- SearchSuggestions_Single_Resource_Data_Document: {
24154
- data: components["schemas"]["SearchSuggestions_Resource_Object"];
24155
- included?: components["schemas"]["Included"];
24156
- links: components["schemas"]["Links"];
24157
- };
24158
24171
  /** @description Suggested search queries */
24159
24172
  SearchSuggestions_Suggestions: {
24160
24173
  highlights?: components["schemas"]["SearchSuggestions_Highlights"][];
@@ -24190,6 +24203,10 @@ export interface components {
24190
24203
  /** @description Links external to TIDAL API */
24191
24204
  externalLinks?: components["schemas"]["External_Link"][];
24192
24205
  };
24206
+ Shares_Create_Single_Resource_Data_Document: {
24207
+ data: components["schemas"]["Shares_Resource_Object"];
24208
+ links: components["schemas"]["Links"];
24209
+ };
24193
24210
  Shares_Multi_Relationship_Data_Document: {
24194
24211
  data?: components["schemas"]["Resource_Identifier"][];
24195
24212
  included?: components["schemas"]["Included"];
@@ -24268,6 +24285,45 @@ export interface components {
24268
24285
  */
24269
24286
  redirectUrl?: string;
24270
24287
  };
24288
+ SquareConnectionsReadById403ResponseBody: {
24289
+ errors: {
24290
+ /**
24291
+ * @example REQUIRED_TERMS_NOT_ACCEPTED
24292
+ * @enum {string}
24293
+ */
24294
+ code: "REQUIRED_TERMS_NOT_ACCEPTED";
24295
+ /** @example Latest terms and conditions must be accepted */
24296
+ detail?: string;
24297
+ /** @example 403 */
24298
+ status: string;
24299
+ }[];
24300
+ };
24301
+ SquareConnectionsReadMultiDataRelationship403ResponseBody: {
24302
+ errors: {
24303
+ /**
24304
+ * @example REQUIRED_TERMS_NOT_ACCEPTED
24305
+ * @enum {string}
24306
+ */
24307
+ code: "REQUIRED_TERMS_NOT_ACCEPTED";
24308
+ /** @example Latest terms and conditions must be accepted */
24309
+ detail?: string;
24310
+ /** @example 403 */
24311
+ status: string;
24312
+ }[];
24313
+ };
24314
+ SquareConnectionsReadSingleDataRelationship403ResponseBody: {
24315
+ errors: {
24316
+ /**
24317
+ * @example REQUIRED_TERMS_NOT_ACCEPTED
24318
+ * @enum {string}
24319
+ */
24320
+ code: "REQUIRED_TERMS_NOT_ACCEPTED";
24321
+ /** @example Latest terms and conditions must be accepted */
24322
+ detail?: string;
24323
+ /** @example 403 */
24324
+ status: string;
24325
+ }[];
24326
+ };
24271
24327
  SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload: {
24272
24328
  data: components["schemas"]["SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload_Data"] | (never | null);
24273
24329
  };
@@ -24277,6 +24333,19 @@ export interface components {
24277
24333
  /** @enum {string} */
24278
24334
  type: "squareSites";
24279
24335
  };
24336
+ SquareConnectionsUpdateSingleDataRelationship403ResponseBody: {
24337
+ errors: {
24338
+ /**
24339
+ * @example REQUIRED_TERMS_NOT_ACCEPTED
24340
+ * @enum {string}
24341
+ */
24342
+ code: "REQUIRED_TERMS_NOT_ACCEPTED";
24343
+ /** @example Latest terms and conditions must be accepted */
24344
+ detail?: string;
24345
+ /** @example 403 */
24346
+ status: string;
24347
+ }[];
24348
+ };
24280
24349
  SquareConnectionsUpdateSingleDataRelationship409ResponseBody: {
24281
24350
  errors: {
24282
24351
  /**
@@ -24323,13 +24392,12 @@ export interface components {
24323
24392
  */
24324
24393
  status: "GRANTED" | "REQUIRES_REAUTH";
24325
24394
  };
24326
- SquareConnections_Multi_Relationship_Data_Document: {
24327
- data?: components["schemas"]["Resource_Identifier"][];
24328
- included?: components["schemas"]["Included"];
24395
+ SquareConnections_Create_Single_Resource_Data_Document: {
24396
+ data: components["schemas"]["SquareConnections_Resource_Object"];
24329
24397
  links: components["schemas"]["Links"];
24330
24398
  };
24331
- SquareConnections_Multi_Resource_Data_Document: {
24332
- data: components["schemas"]["SquareConnections_Resource_Object"][];
24399
+ SquareConnections_Multi_Relationship_Data_Document: {
24400
+ data?: components["schemas"]["Resource_Identifier"][];
24333
24401
  included?: components["schemas"]["Included"];
24334
24402
  links: components["schemas"]["Links"];
24335
24403
  };
@@ -24351,6 +24419,15 @@ export interface components {
24351
24419
  */
24352
24420
  type: "squareConnections";
24353
24421
  };
24422
+ SquareConnections_SelectedSite_Update_Resource_Identifier: {
24423
+ id: string;
24424
+ /** @enum {string} */
24425
+ type: "squareSites";
24426
+ };
24427
+ SquareConnections_SelectedSite_Update_Single_Relationship_Data_Document: {
24428
+ data: components["schemas"]["SquareConnections_SelectedSite_Update_Resource_Identifier"] | (never | null);
24429
+ links: components["schemas"]["Links"];
24430
+ };
24354
24431
  SquareConnections_Single_Relationship_Data_Document: {
24355
24432
  data?: components["schemas"]["Resource_Identifier"] | (never | null);
24356
24433
  included?: components["schemas"]["Included"];
@@ -24369,11 +24446,6 @@ export interface components {
24369
24446
  /** @description The site's title as set by the seller in Square */
24370
24447
  siteTitle?: string;
24371
24448
  };
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
24449
  SquareSites_Resource_Object: {
24378
24450
  attributes?: components["schemas"]["SquareSites_Attributes"];
24379
24451
  /**
@@ -24387,11 +24459,6 @@ export interface components {
24387
24459
  */
24388
24460
  type: "squareSites";
24389
24461
  };
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
24462
  StripeConnectionsCreateOperation_Payload: {
24396
24463
  data: components["schemas"]["StripeConnectionsCreateOperation_Payload_Data"];
24397
24464
  meta?: components["schemas"]["StripeConnectionsCreateOperation_Payload_Meta"];
@@ -24461,6 +24528,10 @@ export interface components {
24461
24528
  */
24462
24529
  status: "PENDING_REQUIREMENTS" | "UNDER_REVIEW" | "ACCEPTED" | "REJECTED" | "SUSPENDED";
24463
24530
  };
24531
+ StripeConnections_Create_Single_Resource_Data_Document: {
24532
+ data: components["schemas"]["StripeConnections_Resource_Object"];
24533
+ links: components["schemas"]["Links"];
24534
+ };
24464
24535
  StripeConnections_Multi_Relationship_Data_Document: {
24465
24536
  data?: components["schemas"]["Resource_Identifier"][];
24466
24537
  included?: components["schemas"]["Included"];
@@ -24488,11 +24559,6 @@ export interface components {
24488
24559
  */
24489
24560
  type: "stripeConnections";
24490
24561
  };
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
24562
  StripeDashboardLinks_Attributes: {
24497
24563
  dashboardLink?: components["schemas"]["Link_Object"];
24498
24564
  };
@@ -24523,11 +24589,6 @@ export interface components {
24523
24589
  */
24524
24590
  type: "stripeDashboardLinks";
24525
24591
  };
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
24592
  SubscriptionPriceChangeDecisionsCreateOperation_Payload: {
24532
24593
  data: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data"];
24533
24594
  };
@@ -24583,6 +24644,10 @@ export interface components {
24583
24644
  */
24584
24645
  status: "ACCEPTED" | "REJECTED";
24585
24646
  };
24647
+ SubscriptionPriceChangeDecisions_Create_Single_Resource_Data_Document: {
24648
+ data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"];
24649
+ links: components["schemas"]["Links"];
24650
+ };
24586
24651
  SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document: {
24587
24652
  data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"][];
24588
24653
  included?: components["schemas"]["Included"];
@@ -24610,9 +24675,8 @@ export interface components {
24610
24675
  included?: components["schemas"]["Included"];
24611
24676
  links: components["schemas"]["Links"];
24612
24677
  };
24613
- SubscriptionPriceChangeDecisions_Single_Resource_Data_Document: {
24678
+ SubscriptionPriceChangeDecisions_Update_Single_Resource_Data_Document: {
24614
24679
  data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"];
24615
- included?: components["schemas"]["Included"];
24616
24680
  links: components["schemas"]["Links"];
24617
24681
  };
24618
24682
  TemporaryUserTokensCreateOperation_Payload: {
@@ -24623,13 +24687,12 @@ export interface components {
24623
24687
  type: "temporaryUserTokens";
24624
24688
  };
24625
24689
  TemporaryUserTokens_Attributes: Record<string, never>;
24626
- TemporaryUserTokens_Multi_Relationship_Data_Document: {
24627
- data?: components["schemas"]["Resource_Identifier"][];
24628
- included?: components["schemas"]["Included"];
24690
+ TemporaryUserTokens_Create_Single_Resource_Data_Document: {
24691
+ data: components["schemas"]["TemporaryUserTokens_Resource_Object"];
24629
24692
  links: components["schemas"]["Links"];
24630
24693
  };
24631
- TemporaryUserTokens_Multi_Resource_Data_Document: {
24632
- data: components["schemas"]["TemporaryUserTokens_Resource_Object"][];
24694
+ TemporaryUserTokens_Multi_Relationship_Data_Document: {
24695
+ data?: components["schemas"]["Resource_Identifier"][];
24633
24696
  included?: components["schemas"]["Included"];
24634
24697
  links: components["schemas"]["Links"];
24635
24698
  };
@@ -24661,7 +24724,7 @@ export interface components {
24661
24724
  /** Format: date-time */
24662
24725
  effectiveAt: string;
24663
24726
  /** @enum {string} */
24664
- termsType: "DEVELOPER" | "UPLOAD_MARKETPLACE";
24727
+ termsType: "DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES";
24665
24728
  };
24666
24729
  Terms_Multi_Resource_Data_Document: {
24667
24730
  data: components["schemas"]["Terms_Resource_Object"][];
@@ -24749,11 +24812,6 @@ export interface components {
24749
24812
  /** @description File URL */
24750
24813
  url?: string;
24751
24814
  };
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
24815
  TrackFiles_Resource_Object: {
24758
24816
  attributes?: components["schemas"]["TrackFiles_Attributes"];
24759
24817
  /**
@@ -24825,11 +24883,6 @@ export interface components {
24825
24883
  /** @description Manifest URI */
24826
24884
  uri?: string;
24827
24885
  };
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
24886
  TrackManifests_Resource_Object: {
24834
24887
  attributes?: components["schemas"]["TrackManifests_Attributes"];
24835
24888
  /**
@@ -24891,13 +24944,12 @@ export interface components {
24891
24944
  status: components["schemas"]["File_Status"];
24892
24945
  uploadLink: components["schemas"]["File_Upload_Link"];
24893
24946
  };
24894
- TrackSourceFiles_Multi_Relationship_Data_Document: {
24895
- data?: components["schemas"]["Resource_Identifier"][];
24896
- included?: components["schemas"]["Included"];
24947
+ TrackSourceFiles_Create_Single_Resource_Data_Document: {
24948
+ data: components["schemas"]["TrackSourceFiles_Resource_Object"];
24897
24949
  links: components["schemas"]["Links"];
24898
24950
  };
24899
- TrackSourceFiles_Multi_Resource_Data_Document: {
24900
- data: components["schemas"]["TrackSourceFiles_Resource_Object"][];
24951
+ TrackSourceFiles_Multi_Relationship_Data_Document: {
24952
+ data?: components["schemas"]["Resource_Identifier"][];
24901
24953
  included?: components["schemas"]["Included"];
24902
24954
  links: components["schemas"]["Links"];
24903
24955
  };
@@ -24940,11 +24992,6 @@ export interface components {
24940
24992
  included?: components["schemas"]["Included"];
24941
24993
  links: components["schemas"]["Links"];
24942
24994
  };
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
24995
  TrackStatistics_Relationships: {
24949
24996
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
24950
24997
  };
@@ -25034,11 +25081,6 @@ export interface components {
25034
25081
  */
25035
25082
  status: "PENDING" | "PROCESSING" | "ERROR" | "OK";
25036
25083
  };
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
25084
  TracksMetadataStatus_Resource_Object: {
25043
25085
  attributes?: components["schemas"]["TracksMetadataStatus_Attributes"];
25044
25086
  /**
@@ -25200,6 +25242,10 @@ export interface components {
25200
25242
  */
25201
25243
  version?: string;
25202
25244
  };
25245
+ Tracks_Create_Single_Resource_Data_Document: {
25246
+ data: components["schemas"]["Tracks_Resource_Object"];
25247
+ links: components["schemas"]["Links"];
25248
+ };
25203
25249
  Tracks_Multi_Relationship_Data_Document: {
25204
25250
  data?: components["schemas"]["Resource_Identifier"][];
25205
25251
  included?: components["schemas"]["Included"];
@@ -25367,9 +25413,8 @@ export interface components {
25367
25413
  */
25368
25414
  validFrom?: string;
25369
25415
  };
25370
- UsageRules_Multi_Resource_Data_Document: {
25371
- data: components["schemas"]["UsageRules_Resource_Object"][];
25372
- included?: components["schemas"]["Included"];
25416
+ UsageRules_Create_Single_Resource_Data_Document: {
25417
+ data: components["schemas"]["UsageRules_Resource_Object"];
25373
25418
  links: components["schemas"]["Links"];
25374
25419
  };
25375
25420
  UsageRules_Resource_Object: {
@@ -25449,14 +25494,23 @@ export interface components {
25449
25494
  numberOfItems: number;
25450
25495
  };
25451
25496
  UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document: {
25452
- data?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier"][];
25453
- included?: components["schemas"]["Included"];
25497
+ data: components["schemas"]["UserCollectionAlbums_Items_Add_Resource_Identifier"][];
25454
25498
  links: components["schemas"]["Links"];
25455
25499
  meta?: components["schemas"]["UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta"];
25456
25500
  };
25457
25501
  UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta: {
25458
25502
  skipped: components["schemas"]["UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
25459
25503
  };
25504
+ UserCollectionAlbums_Items_Add_Resource_Identifier: {
25505
+ id: string;
25506
+ meta?: components["schemas"]["UserCollectionAlbums_Items_Add_Resource_Identifier_Meta"];
25507
+ /** @enum {string} */
25508
+ type: "albums";
25509
+ };
25510
+ UserCollectionAlbums_Items_Add_Resource_Identifier_Meta: {
25511
+ /** Format: date-time */
25512
+ addedAt: string;
25513
+ };
25460
25514
  UserCollectionAlbums_Items_Multi_Relationship_Data_Document: {
25461
25515
  data?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier"][];
25462
25516
  included?: components["schemas"]["Included"];
@@ -25485,11 +25539,6 @@ export interface components {
25485
25539
  included?: components["schemas"]["Included"];
25486
25540
  links: components["schemas"]["Links"];
25487
25541
  };
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
25542
  UserCollectionAlbums_Relationships: {
25494
25543
  items?: components["schemas"]["UserCollectionAlbums_Items_Multi_Relationship_Data_Document"];
25495
25544
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -25567,14 +25616,23 @@ export interface components {
25567
25616
  numberOfItems: number;
25568
25617
  };
25569
25618
  UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document: {
25570
- data?: components["schemas"]["UserCollectionArtists_Items_Resource_Identifier"][];
25571
- included?: components["schemas"]["Included"];
25619
+ data: components["schemas"]["UserCollectionArtists_Items_Add_Resource_Identifier"][];
25572
25620
  links: components["schemas"]["Links"];
25573
25621
  meta?: components["schemas"]["UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta"];
25574
25622
  };
25575
25623
  UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta: {
25576
25624
  skipped: components["schemas"]["UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
25577
25625
  };
25626
+ UserCollectionArtists_Items_Add_Resource_Identifier: {
25627
+ id: string;
25628
+ meta?: components["schemas"]["UserCollectionArtists_Items_Add_Resource_Identifier_Meta"];
25629
+ /** @enum {string} */
25630
+ type: "artists";
25631
+ };
25632
+ UserCollectionArtists_Items_Add_Resource_Identifier_Meta: {
25633
+ /** Format: date-time */
25634
+ addedAt: string;
25635
+ };
25578
25636
  UserCollectionArtists_Items_Multi_Relationship_Data_Document: {
25579
25637
  data?: components["schemas"]["UserCollectionArtists_Items_Resource_Identifier"][];
25580
25638
  included?: components["schemas"]["Included"];
@@ -25602,11 +25660,6 @@ export interface components {
25602
25660
  included?: components["schemas"]["Included"];
25603
25661
  links: components["schemas"]["Links"];
25604
25662
  };
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
25663
  UserCollectionArtists_Relationships: {
25611
25664
  items?: components["schemas"]["UserCollectionArtists_Items_Multi_Relationship_Data_Document"];
25612
25665
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -25698,6 +25751,10 @@ export interface components {
25698
25751
  /** Format: int32 */
25699
25752
  numberOfItems?: number;
25700
25753
  };
25754
+ UserCollectionFolders_Create_Single_Resource_Data_Document: {
25755
+ data: components["schemas"]["UserCollectionFolders_Resource_Object"];
25756
+ links: components["schemas"]["Links"];
25757
+ };
25701
25758
  UserCollectionFolders_Items_Multi_Relationship_Data_Document: {
25702
25759
  data?: components["schemas"]["UserCollectionFolders_Items_Resource_Identifier"][];
25703
25760
  included?: components["schemas"]["Included"];
@@ -25813,14 +25870,23 @@ export interface components {
25813
25870
  numberOfItems: number;
25814
25871
  };
25815
25872
  UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document: {
25816
- data?: components["schemas"]["UserCollectionPlaylists_Items_Resource_Identifier"][];
25817
- included?: components["schemas"]["Included"];
25873
+ data: components["schemas"]["UserCollectionPlaylists_Items_Add_Resource_Identifier"][];
25818
25874
  links: components["schemas"]["Links"];
25819
25875
  meta?: components["schemas"]["UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta"];
25820
25876
  };
25821
25877
  UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta: {
25822
25878
  skipped: components["schemas"]["UserCollectionPlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
25823
25879
  };
25880
+ UserCollectionPlaylists_Items_Add_Resource_Identifier: {
25881
+ id: string;
25882
+ meta?: components["schemas"]["UserCollectionPlaylists_Items_Add_Resource_Identifier_Meta"];
25883
+ /** @enum {string} */
25884
+ type: "playlists";
25885
+ };
25886
+ UserCollectionPlaylists_Items_Add_Resource_Identifier_Meta: {
25887
+ /** Format: date-time */
25888
+ addedAt: string;
25889
+ };
25824
25890
  UserCollectionPlaylists_Items_Multi_Relationship_Data_Document: {
25825
25891
  data?: components["schemas"]["UserCollectionPlaylists_Items_Resource_Identifier"][];
25826
25892
  included?: components["schemas"]["Included"];
@@ -25848,11 +25914,6 @@ export interface components {
25848
25914
  included?: components["schemas"]["Included"];
25849
25915
  links: components["schemas"]["Links"];
25850
25916
  };
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
25917
  UserCollectionPlaylists_Relationships: {
25857
25918
  items?: components["schemas"]["UserCollectionPlaylists_Items_Multi_Relationship_Data_Document"];
25858
25919
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -25925,14 +25986,23 @@ export interface components {
25925
25986
  numberOfItems: number;
25926
25987
  };
25927
25988
  UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document: {
25928
- data?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier"][];
25929
- included?: components["schemas"]["Included"];
25989
+ data: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Resource_Identifier"][];
25930
25990
  links: components["schemas"]["Links"];
25931
25991
  meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta"];
25932
25992
  };
25933
25993
  UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta: {
25934
25994
  skipped: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
25935
25995
  };
25996
+ UserCollectionSaveForLaters_Items_Add_Resource_Identifier: {
25997
+ id: string;
25998
+ meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Resource_Identifier_Meta"];
25999
+ /** @enum {string} */
26000
+ type: "tracks" | "albums" | "artists" | "playlists" | "videos";
26001
+ };
26002
+ UserCollectionSaveForLaters_Items_Add_Resource_Identifier_Meta: {
26003
+ /** Format: date-time */
26004
+ addedAt: string;
26005
+ };
25936
26006
  UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document: {
25937
26007
  data?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier"][];
25938
26008
  included?: components["schemas"]["Included"];
@@ -25961,11 +26031,6 @@ export interface components {
25961
26031
  included?: components["schemas"]["Included"];
25962
26032
  links: components["schemas"]["Links"];
25963
26033
  };
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
26034
  UserCollectionSaveForLaters_Relationships: {
25970
26035
  items?: components["schemas"]["UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"];
25971
26036
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26043,14 +26108,23 @@ export interface components {
26043
26108
  numberOfItems: number;
26044
26109
  };
26045
26110
  UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document: {
26046
- data?: components["schemas"]["UserCollectionTracks_Items_Resource_Identifier"][];
26047
- included?: components["schemas"]["Included"];
26111
+ data: components["schemas"]["UserCollectionTracks_Items_Add_Resource_Identifier"][];
26048
26112
  links: components["schemas"]["Links"];
26049
26113
  meta?: components["schemas"]["UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta"];
26050
26114
  };
26051
26115
  UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta: {
26052
26116
  skipped: components["schemas"]["UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
26053
26117
  };
26118
+ UserCollectionTracks_Items_Add_Resource_Identifier: {
26119
+ id: string;
26120
+ meta?: components["schemas"]["UserCollectionTracks_Items_Add_Resource_Identifier_Meta"];
26121
+ /** @enum {string} */
26122
+ type: "tracks";
26123
+ };
26124
+ UserCollectionTracks_Items_Add_Resource_Identifier_Meta: {
26125
+ /** Format: date-time */
26126
+ addedAt: string;
26127
+ };
26054
26128
  UserCollectionTracks_Items_Multi_Relationship_Data_Document: {
26055
26129
  data?: components["schemas"]["UserCollectionTracks_Items_Resource_Identifier"][];
26056
26130
  included?: components["schemas"]["Included"];
@@ -26079,11 +26153,6 @@ export interface components {
26079
26153
  included?: components["schemas"]["Included"];
26080
26154
  links: components["schemas"]["Links"];
26081
26155
  };
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
26156
  UserCollectionTracks_Relationships: {
26088
26157
  items?: components["schemas"]["UserCollectionTracks_Items_Multi_Relationship_Data_Document"];
26089
26158
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26161,14 +26230,23 @@ export interface components {
26161
26230
  numberOfItems: number;
26162
26231
  };
26163
26232
  UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document: {
26164
- data?: components["schemas"]["UserCollectionVideos_Items_Resource_Identifier"][];
26165
- included?: components["schemas"]["Included"];
26233
+ data: components["schemas"]["UserCollectionVideos_Items_Add_Resource_Identifier"][];
26166
26234
  links: components["schemas"]["Links"];
26167
26235
  meta?: components["schemas"]["UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta"];
26168
26236
  };
26169
26237
  UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta: {
26170
26238
  skipped: components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
26171
26239
  };
26240
+ UserCollectionVideos_Items_Add_Resource_Identifier: {
26241
+ id: string;
26242
+ meta?: components["schemas"]["UserCollectionVideos_Items_Add_Resource_Identifier_Meta"];
26243
+ /** @enum {string} */
26244
+ type: "videos";
26245
+ };
26246
+ UserCollectionVideos_Items_Add_Resource_Identifier_Meta: {
26247
+ /** Format: date-time */
26248
+ addedAt: string;
26249
+ };
26172
26250
  UserCollectionVideos_Items_Multi_Relationship_Data_Document: {
26173
26251
  data?: components["schemas"]["UserCollectionVideos_Items_Resource_Identifier"][];
26174
26252
  included?: components["schemas"]["Included"];
@@ -26197,11 +26275,6 @@ export interface components {
26197
26275
  included?: components["schemas"]["Included"];
26198
26276
  links: components["schemas"]["Links"];
26199
26277
  };
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
26278
  UserCollectionVideos_Relationships: {
26206
26279
  items?: components["schemas"]["UserCollectionVideos_Items_Multi_Relationship_Data_Document"];
26207
26280
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26384,11 +26457,6 @@ export interface components {
26384
26457
  included?: components["schemas"]["Included"];
26385
26458
  links: components["schemas"]["Links"];
26386
26459
  };
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
26460
  UserCollections_Playlists_Multi_Relationship_Data_Document: {
26393
26461
  data?: components["schemas"]["UserCollections_Playlists_Resource_Identifier"][];
26394
26462
  included?: components["schemas"]["Included"];
@@ -26490,11 +26558,6 @@ export interface components {
26490
26558
  included?: components["schemas"]["Included"];
26491
26559
  links: components["schemas"]["Links"];
26492
26560
  };
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
26561
  UserDailyMixes_Relationships: {
26499
26562
  items?: components["schemas"]["Multi_Relationship_Data_Document"];
26500
26563
  };
@@ -26536,9 +26599,8 @@ export interface components {
26536
26599
  */
26537
26600
  flowType: "GDPR" | "CCPA" | "COPPA" | "ANZ_PA" | "US_PRIVACY_REGULATION" | "APPI" | "RETENTION_POLICY";
26538
26601
  };
26539
- UserDataExportRequests_Multi_Resource_Data_Document: {
26540
- data: components["schemas"]["UserDataExportRequests_Resource_Object"][];
26541
- included?: components["schemas"]["Included"];
26602
+ UserDataExportRequests_Create_Single_Resource_Data_Document: {
26603
+ data: components["schemas"]["UserDataExportRequests_Resource_Object"];
26542
26604
  links: components["schemas"]["Links"];
26543
26605
  };
26544
26606
  UserDataExportRequests_Resource_Object: {
@@ -26554,22 +26616,12 @@ export interface components {
26554
26616
  */
26555
26617
  type: "userDataExportRequests";
26556
26618
  };
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
26619
  UserDiscoveryMixes_Attributes: Record<string, never>;
26563
26620
  UserDiscoveryMixes_Multi_Relationship_Data_Document: {
26564
26621
  data?: components["schemas"]["Resource_Identifier"][];
26565
26622
  included?: components["schemas"]["Included"];
26566
26623
  links: components["schemas"]["Links"];
26567
26624
  };
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
26625
  UserDiscoveryMixes_Relationships: {
26574
26626
  items?: components["schemas"]["Multi_Relationship_Data_Document"];
26575
26627
  };
@@ -26598,11 +26650,6 @@ export interface components {
26598
26650
  included?: components["schemas"]["Included"];
26599
26651
  links: components["schemas"]["Links"];
26600
26652
  };
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
26653
  UserNewReleaseMixes_Relationships: {
26607
26654
  items?: components["schemas"]["Multi_Relationship_Data_Document"];
26608
26655
  };
@@ -26631,11 +26678,6 @@ export interface components {
26631
26678
  included?: components["schemas"]["Included"];
26632
26679
  links: components["schemas"]["Links"];
26633
26680
  };
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
26681
  UserOfflineMixes_Relationships: {
26640
26682
  items?: components["schemas"]["Multi_Relationship_Data_Document"];
26641
26683
  };
@@ -26719,6 +26761,15 @@ export interface components {
26719
26761
  /** @enum {string} */
26720
26762
  type: "videos";
26721
26763
  };
26764
+ UserRecommendationBlocks_Artists_Add_Multi_Relationship_Data_Document: {
26765
+ data: components["schemas"]["UserRecommendationBlocks_Artists_Add_Resource_Identifier"][];
26766
+ links: components["schemas"]["Links"];
26767
+ };
26768
+ UserRecommendationBlocks_Artists_Add_Resource_Identifier: {
26769
+ id: string;
26770
+ /** @enum {string} */
26771
+ type: "artists";
26772
+ };
26722
26773
  UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document: {
26723
26774
  data?: components["schemas"]["UserRecommendationBlocks_Artists_Resource_Identifier"][];
26724
26775
  included?: components["schemas"]["Included"];
@@ -26750,11 +26801,6 @@ export interface components {
26750
26801
  included?: components["schemas"]["Included"];
26751
26802
  links: components["schemas"]["Links"];
26752
26803
  };
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
26804
  UserRecommendationBlocks_Relationships: {
26759
26805
  artists?: components["schemas"]["UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document"];
26760
26806
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26780,6 +26826,15 @@ export interface components {
26780
26826
  included?: components["schemas"]["Included"];
26781
26827
  links: components["schemas"]["Links"];
26782
26828
  };
26829
+ UserRecommendationBlocks_Tracks_Add_Multi_Relationship_Data_Document: {
26830
+ data: components["schemas"]["UserRecommendationBlocks_Tracks_Add_Resource_Identifier"][];
26831
+ links: components["schemas"]["Links"];
26832
+ };
26833
+ UserRecommendationBlocks_Tracks_Add_Resource_Identifier: {
26834
+ id: string;
26835
+ /** @enum {string} */
26836
+ type: "tracks";
26837
+ };
26783
26838
  UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document: {
26784
26839
  data?: components["schemas"]["UserRecommendationBlocks_Tracks_Resource_Identifier"][];
26785
26840
  included?: components["schemas"]["Included"];
@@ -26806,6 +26861,15 @@ export interface components {
26806
26861
  createdAt: string;
26807
26862
  replacement?: components["schemas"]["Replacement_Provenance"];
26808
26863
  };
26864
+ UserRecommendationBlocks_Videos_Add_Multi_Relationship_Data_Document: {
26865
+ data: components["schemas"]["UserRecommendationBlocks_Videos_Add_Resource_Identifier"][];
26866
+ links: components["schemas"]["Links"];
26867
+ };
26868
+ UserRecommendationBlocks_Videos_Add_Resource_Identifier: {
26869
+ id: string;
26870
+ /** @enum {string} */
26871
+ type: "videos";
26872
+ };
26809
26873
  UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document: {
26810
26874
  data?: components["schemas"]["UserRecommendationBlocks_Videos_Resource_Identifier"][];
26811
26875
  included?: components["schemas"]["Included"];
@@ -26838,11 +26902,6 @@ export interface components {
26838
26902
  included?: components["schemas"]["Included"];
26839
26903
  links: components["schemas"]["Links"];
26840
26904
  };
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
26905
  UserRecommendations_Relationships: {
26847
26906
  discoveryMixes?: components["schemas"]["Multi_Relationship_Data_Document"];
26848
26907
  myMixes?: components["schemas"]["Multi_Relationship_Data_Document"];
@@ -26902,9 +26961,8 @@ export interface components {
26902
26961
  */
26903
26962
  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
26963
  };
26905
- UserReports_Multi_Resource_Data_Document: {
26906
- data: components["schemas"]["UserReports_Resource_Object"][];
26907
- included?: components["schemas"]["Included"];
26964
+ UserReports_Create_Single_Resource_Data_Document: {
26965
+ data: components["schemas"]["UserReports_Resource_Object"];
26908
26966
  links: components["schemas"]["Links"];
26909
26967
  };
26910
26968
  UserReports_Resource_Object: {
@@ -26920,11 +26978,6 @@ export interface components {
26920
26978
  */
26921
26979
  type: "userReports";
26922
26980
  };
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
26981
  UserSubscriptionPriceChanges_Attributes: {
26929
26982
  /**
26930
26983
  * @description ISO 4217 currency code
@@ -26974,11 +27027,6 @@ export interface components {
26974
27027
  included?: components["schemas"]["Included"];
26975
27028
  links: components["schemas"]["Links"];
26976
27029
  };
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
27030
  Users_Attributes: {
26983
27031
  /**
26984
27032
  * @description ISO 3166-1 alpha-2 country code
@@ -27022,11 +27070,6 @@ export interface components {
27022
27070
  */
27023
27071
  username: string;
27024
27072
  };
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
27073
  Users_Resource_Object: {
27031
27074
  attributes?: components["schemas"]["Users_Attributes"];
27032
27075
  /**
@@ -27085,11 +27128,6 @@ export interface components {
27085
27128
  */
27086
27129
  videoPresentation?: "FULL" | "PREVIEW";
27087
27130
  };
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
27131
  VideoManifests_Resource_Object: {
27094
27132
  attributes?: components["schemas"]["VideoManifests_Attributes"];
27095
27133
  /**
@@ -27376,6 +27414,42 @@ export interface components {
27376
27414
  "application/vnd.api+json": components["schemas"]["Idempotency422ResponseBody"];
27377
27415
  };
27378
27416
  };
27417
+ /** @description Latest terms and conditions must be accepted */
27418
+ SquareConnectionsReadById403Response: {
27419
+ headers: {
27420
+ [name: string]: unknown;
27421
+ };
27422
+ content: {
27423
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsReadById403ResponseBody"];
27424
+ };
27425
+ };
27426
+ /** @description Latest terms and conditions must be accepted */
27427
+ SquareConnectionsReadMultiDataRelationship403Response: {
27428
+ headers: {
27429
+ [name: string]: unknown;
27430
+ };
27431
+ content: {
27432
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsReadMultiDataRelationship403ResponseBody"];
27433
+ };
27434
+ };
27435
+ /** @description Latest terms and conditions must be accepted */
27436
+ SquareConnectionsReadSingleDataRelationship403Response: {
27437
+ headers: {
27438
+ [name: string]: unknown;
27439
+ };
27440
+ content: {
27441
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsReadSingleDataRelationship403ResponseBody"];
27442
+ };
27443
+ };
27444
+ /** @description Latest terms and conditions must be accepted */
27445
+ SquareConnectionsUpdateSingleDataRelationship403Response: {
27446
+ headers: {
27447
+ [name: string]: unknown;
27448
+ };
27449
+ content: {
27450
+ "application/vnd.api+json": components["schemas"]["SquareConnectionsUpdateSingleDataRelationship403ResponseBody"];
27451
+ };
27452
+ };
27379
27453
  /** @description Square credential lacks required site scopes; run Square onboarding again; Request already in progress for this idempotency key */
27380
27454
  SquareConnectionsUpdateSingleDataRelationship409Response: {
27381
27455
  headers: {