Documentation

VersionsApi
in package

VersionsApi Class Doc Comment

Tags
author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  : array<string, array<string|int, string>> = ['version' => ['application/json']]

Properties

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int

Methods

__construct()  : mixed
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
setHostIndex()  : void
Set the host index
version()  : ModelVersion|ErrorResponse
Operation version
versionAsync()  : PromiseInterface
Operation versionAsync
versionAsyncWithHttpInfo()  : PromiseInterface
Operation versionAsyncWithHttpInfo
versionRequest()  : Request
Create request for operation 'version'
versionWithHttpInfo()  : ErrorResponse, 1: int, 2: array}
Operation versionWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getExceptionResponse()  : ResponseInterface|null
Returns the response attached to a Guzzle exception, if there is one.
handleResponseWithDataType()  : array<string|int, mixed>
responseWithinRangeCode()  : bool

Constants

contentTypes

public array<string, array<string|int, string>> contentTypes = ['version' => ['application/json']]

Properties

Methods

__construct()

public __construct([ClientInterface|null $client = null ][, Configuration|null $config = null ][, HeaderSelector|null $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
$client : ClientInterface|null = null
$config : Configuration|null = null
$selector : HeaderSelector|null = null
$hostIndex : int = 0

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

version()

Operation version

public version(string $uuid[, string $contentType = self::contentTypes['version'][0] ]) : ModelVersion|ErrorResponse

The metadata of a Version by its UUID (deprecated, use GetVersion, or Download for the file)

Parameters
$uuid : string

The UUID of the Version (required)

$contentType : string = self::contentTypes['version'][0]

The value for the Content-Type header. Check self::contentTypes['version'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
ModelVersion|ErrorResponse

versionAsync()

Operation versionAsync

public versionAsync(string $uuid[, string $contentType = self::contentTypes['version'][0] ]) : PromiseInterface

The metadata of a Version by its UUID (deprecated, use GetVersion, or Download for the file)

Parameters
$uuid : string

The UUID of the Version (required)

$contentType : string = self::contentTypes['version'][0]

The value for the Content-Type header. Check self::contentTypes['version'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

versionAsyncWithHttpInfo()

Operation versionAsyncWithHttpInfo

public versionAsyncWithHttpInfo(string $uuid[, string $contentType = self::contentTypes['version'][0] ]) : PromiseInterface

The metadata of a Version by its UUID (deprecated, use GetVersion, or Download for the file)

Parameters
$uuid : string

The UUID of the Version (required)

$contentType : string = self::contentTypes['version'][0]

The value for the Content-Type header. Check self::contentTypes['version'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

versionRequest()

Create request for operation 'version'

public versionRequest(string $uuid[, string $contentType = self::contentTypes['version'][0] ]) : Request
Parameters
$uuid : string

The UUID of the Version (required)

$contentType : string = self::contentTypes['version'][0]

The value for the Content-Type header. Check self::contentTypes['version'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

versionWithHttpInfo()

Operation versionWithHttpInfo

public versionWithHttpInfo(string $uuid[, string $contentType = self::contentTypes['version'][0] ]) : ErrorResponse, 1: int, 2: array}

The metadata of a Version by its UUID (deprecated, use GetVersion, or Download for the file)

Parameters
$uuid : string

The UUID of the Version (required)

$contentType : string = self::contentTypes['version'][0]

The value for the Content-Type header. Check self::contentTypes['version'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response or if the response body is not in the expected format

InvalidArgumentException
Return values
ErrorResponse, 1: int, 2: array} —

[response data, HTTP status code, HTTP response headers]

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

getExceptionResponse()

Returns the response attached to a Guzzle exception, if there is one.

private getExceptionResponse(Throwable $exception) : ResponseInterface|null

Guzzle 7 exposes getResponse() on RequestException, while Guzzle 8 only exposes it on ResponseException and its subclasses.

Parameters
$exception : Throwable
Return values
ResponseInterface|null

handleResponseWithDataType()

private handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>
Parameters
$dataType : string
$request : RequestInterface
$response : ResponseInterface
Return values
array<string|int, mixed>

responseWithinRangeCode()

private responseWithinRangeCode(string $rangeCode, int $statusCode) : bool
Parameters
$rangeCode : string
$statusCode : int
Return values
bool
On this page

Search results