Tectly PHP Client

AuthenticationApi
in package

AuthenticationApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  = ['issueAuthenticationToken' => ['application/json']]

Properties

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

Methods

__construct()  : mixed
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
issueAuthenticationToken()  : TokenInformation
Operation issueAuthenticationToken
issueAuthenticationTokenAsync()  : PromiseInterface
Operation issueAuthenticationTokenAsync
issueAuthenticationTokenAsyncWithHttpInfo()  : PromiseInterface
Operation issueAuthenticationTokenAsyncWithHttpInfo
issueAuthenticationTokenRequest()  : Request
Create request for operation 'issueAuthenticationToken'
issueAuthenticationTokenWithHttpInfo()  : array<string|int, mixed>
Operation issueAuthenticationTokenWithHttpInfo
setHostIndex()  : void
Set the host index
createHttpClientOption()  : array<string|int, mixed>
Create http client option
handleResponseWithDataType()  : array<string|int, mixed>
responseWithinRangeCode()  : bool

Constants

contentTypes

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

Properties

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = 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

issueAuthenticationToken()

Operation issueAuthenticationToken

public issueAuthenticationToken([string $contentType = self::contentTypes['issueAuthenticationToken'][0] ]) : TokenInformation

Get an authentication token.

Parameters
$contentType : string = self::contentTypes['issueAuthenticationToken'][0]

The value for the Content-Type header. Check self::contentTypes['issueAuthenticationToken'] 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

throws
InvalidArgumentException
Return values
TokenInformation

issueAuthenticationTokenAsync()

Operation issueAuthenticationTokenAsync

public issueAuthenticationTokenAsync([string $contentType = self::contentTypes['issueAuthenticationToken'][0] ]) : PromiseInterface

Get an authentication token.

Parameters
$contentType : string = self::contentTypes['issueAuthenticationToken'][0]

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

issueAuthenticationTokenAsyncWithHttpInfo()

Operation issueAuthenticationTokenAsyncWithHttpInfo

public issueAuthenticationTokenAsyncWithHttpInfo([string $contentType = self::contentTypes['issueAuthenticationToken'][0] ]) : PromiseInterface

Get an authentication token.

Parameters
$contentType : string = self::contentTypes['issueAuthenticationToken'][0]

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

issueAuthenticationTokenRequest()

Create request for operation 'issueAuthenticationToken'

public issueAuthenticationTokenRequest([string $contentType = self::contentTypes['issueAuthenticationToken'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['issueAuthenticationToken'][0]

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

Tags
throws
InvalidArgumentException
Return values
Request

issueAuthenticationTokenWithHttpInfo()

Operation issueAuthenticationTokenWithHttpInfo

public issueAuthenticationTokenWithHttpInfo([string $contentType = self::contentTypes['issueAuthenticationToken'][0] ]) : array<string|int, mixed>

Get an authentication token.

Parameters
$contentType : string = self::contentTypes['issueAuthenticationToken'][0]

The value for the Content-Type header. Check self::contentTypes['issueAuthenticationToken'] 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

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of \Tectly\OpenAPI\Model\TokenInformation, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index

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

Host index (required)

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

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