From ff46b878611c1a77fd56d2f918ad179867da0cfa Mon Sep 17 00:00:00 2001 From: Jonathan Wilsson Date: Mon, 31 Jul 2023 12:48:31 +0200 Subject: [PATCH] Regenerate method reference docs --- docs/method-reference/Request.md | 6 +++--- docs/method-reference/SpotifyWebAPI.md | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/method-reference/Request.md b/docs/method-reference/Request.md index 99ade3d..5c6ff9a 100644 --- a/docs/method-reference/Request.md +++ b/docs/method-reference/Request.md @@ -40,7 +40,7 @@ Make a request to the "account" endpoint. #### Arguments * `$method` **string** - The HTTP method to use. * `$uri` **string** - The URI to request. -* `$parameters` **array** - Optional. Query string parameters or HTTP body, depending on $method. +* `$parameters` **string\|array** - Optional. Query string parameters or HTTP body, depending on $method. * `$headers` **array** - Optional. HTTP headers. #### Return values @@ -63,7 +63,7 @@ Make a request to the "api" endpoint. #### Arguments * `$method` **string** - The HTTP method to use. * `$uri` **string** - The URI to request. -* `$parameters` **array** - Optional. Query string parameters or HTTP body, depending on $method. +* `$parameters` **string\|array** - Optional. Query string parameters or HTTP body, depending on $method. * `$headers` **array** - Optional. HTTP headers. #### Return values @@ -105,7 +105,7 @@ You'll probably want to use one of the convenience methods instead. #### Arguments * `$method` **string** - The HTTP method to use. * `$url` **string** - The URL to request. -* `$parameters` **array** - Optional. Query string parameters or HTTP body, depending on $method. +* `$parameters` **string\|array\|object** - Optional. Query string parameters or HTTP body, depending on $method. * `$headers` **array** - Optional. HTTP headers. #### Return values diff --git a/docs/method-reference/SpotifyWebAPI.md b/docs/method-reference/SpotifyWebAPI.md index fa50208..32f64c9 100644 --- a/docs/method-reference/SpotifyWebAPI.md +++ b/docs/method-reference/SpotifyWebAPI.md @@ -527,7 +527,7 @@ https://developer.spotify.com/documentation/web-api/reference/#/operations/get-a #### Arguments * `$artistId` **string** - ID or URI of the artist. * `$options` **array\|object** - Optional. Options for the albums. - * string country Optional. Limit the results to items that are playable in this country, for example SE. + * string market Optional. Limit the results to items that are playable in this country, for example SE. * string\|array include_groups Optional. Album types to return. If omitted, all album types will be returned. * int limit Optional. Limit the number of albums. * int offset Optional. Number of albums to skip. @@ -549,7 +549,7 @@ https://developer.spotify.com/documentation/web-api/reference/#/operations/get-a #### Arguments * `$artistId` **string** - ID or URI of the artist. * `$options` **array\|object** - Options for the tracks. - * string country Required. ISO 3166-1 alpha-2 country code specifying the country to get the top tracks for. + * string market Required. An ISO 3166-1 alpha-2 country code specifying the country to get the top tracks for. #### Return values * **array\|object** The artist's top tracks. Type is controlled by the `return_assoc` option. @@ -569,7 +569,7 @@ https://developer.spotify.com/documentation/web-api/reference/#/operations/get-a * `$trackId` **string** - ID or URI of the track. #### Return values -* **object** The track's audio analysis. Type is controlled by the `return_assoc` option. +* **array\|object** The track's audio analysis. Type is controlled by the `return_assoc` option. --- ### getAudiobook @@ -757,7 +757,7 @@ Get multiple episodes.
https://developer.spotify.com/documentation/web-api/reference/#/operations/get-multiple-episodes #### Arguments -* `$episodeIds` **array** - IDs or URIs of the episodes. +* `$episodeIds` **string\|array** - IDs or URIs of the episodes. * `$options` **array\|object** - Optional. Options for the episodes. * string market Optional. ISO 3166-1 alpha-2 country code, limit results to episodes available in that market. @@ -846,7 +846,7 @@ Get audio features of multiple tracks.
https://developer.spotify.com/documentation/web-api/reference/#/operations/get-several-audio-features #### Arguments -* `$trackIds` **array** - IDs or URIs of the tracks. +* `$trackIds` **string\|array** - IDs or URIs of the tracks. #### Return values * **array\|object** The tracks' audio features. Type is controlled by the `return_assoc` option. @@ -1230,7 +1230,7 @@ Get multiple shows.
https://developer.spotify.com/documentation/web-api/reference/#/operations/get-multiple-shows #### Arguments -* `$showIds` **array** - IDs or URIs of the shows. +* `$showIds` **string\|array** - IDs or URIs of the shows. * `$options` **array\|object** - Optional. Options for the shows. * string market Optional. ISO 3166-1 alpha-2 country code, limit results to shows available in that market.