Skip to content

Commit

Permalink
Regenerate method reference
Browse files Browse the repository at this point in the history
  • Loading branch information
jwilsson committed Dec 7, 2020
1 parent 1166e86 commit 9063d2f
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 138 deletions.
15 changes: 7 additions & 8 deletions docs/method-reference/Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,13 @@ Get the latest full response from the Spotify API.
---
### getReturnType

_Deprecated_
_Deprecated. Use the `return_assoc` option instead._

```php
Request::getReturnType()
```

Use the `return_assoc` option instead.
Get a value indicating the response body type.


#### Return values
Expand Down Expand Up @@ -127,14 +127,13 @@ You'll probably want to use one of the convenience methods instead.
---
### setCurlOptions

_Deprecated_
_Deprecated. Use the `curl_options` option instead._

```php
Request::setCurlOptions($options)
```

Use the `curl_options` option instead.<br>
<br>
Set custom cURL options.<br>
Any options passed here will be merged with the defaults, overriding existing ones.

#### Arguments
Expand Down Expand Up @@ -162,16 +161,16 @@ Set options
---
### setReturnType

_Deprecated_
_Deprecated. Use the `return_assoc` option instead._

```php
Request::setReturnType($returnType)
```

Use the `return_assoc` option instead.
Set the return type for the response body.

#### Arguments
* `$returnType` **string** - One of the Request::RETURN_* constants.
* `$returnType` **string** - One of the `Request::RETURN_*` constants.

#### Return values
* **void**
Expand Down
13 changes: 6 additions & 7 deletions docs/method-reference/Session.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Generate a code challenge from a code verifier for use with the PKCE flow.

#### Arguments
* `$codeVerifier` **string** - The code verifier to create a challenge from.
* `$hashAlgo` **string** - Optional. The hash algorithm to use. Defaults to &quot;sha256&quot;.
* `$hashAlgo` **string** - Optional. The hash algorithm to use. Defaults to "sha256".

#### Return values
* **string** The code challenge.
Expand All @@ -48,7 +48,7 @@ Session::generateCodeVerifier($length)
Generate a code verifier for use with the PKCE flow.

#### Arguments
* `$length` **integer** - Optional. Code verifier length. Must be between 43 and 128 characters long, default is 128.
* `$length` **int** - Optional. Code verifier length. Must be between 43 and 128 characters long, default is 128.

#### Return values
* **string** A code verifier string.
Expand All @@ -70,7 +70,6 @@ Get the authorization URL.
* boolean show_dialog Optional. Whether or not to force the user to always approve the app. Default is false.
* string state Optional. A CSRF token.


#### Return values
* **string** The authorization URL.

Expand Down Expand Up @@ -128,7 +127,7 @@ Get the access token expiration time.


#### Return values
* **integer** A Unix timestamp indicating the token expiration time.
* **int** A Unix timestamp indicating the token expiration time.

---
### getRedirectUri
Expand Down Expand Up @@ -186,7 +185,7 @@ Refresh an access token.
* `$refreshToken` **string** - Optional. The refresh token to use.

#### Return values
* **boolean** Whether the access token was successfully refreshed.
* **bool** Whether the access token was successfully refreshed.

---
### requestAccessToken
Expand All @@ -203,7 +202,7 @@ Request an access token given an authorization code.
* `$codeVerifier` **string** - Optional. A previously generated code verifier. Will assume a PKCE flow if passed.

#### Return values
* **boolean** True when the access token was successfully granted, false otherwise.
* **bool** True when the access token was successfully granted, false otherwise.

---
### requestCredentialsToken
Expand All @@ -217,7 +216,7 @@ Request an access token using the Client Credentials Flow.


#### Return values
* **boolean** True when an access token was successfully granted, false otherwise.
* **bool** True when an access token was successfully granted, false otherwise.

---
### setAccessToken
Expand Down
Loading

0 comments on commit 9063d2f

Please sign in to comment.