forge-dashboard-sdk-php

TokensApi
in package

ForgeDashboard

Generated

TokensApi Class Doc Comment

Constants

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

Properties

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

Methods

__construct() : mixed
createAPIToken() : APITokenCreateResponse|Error: Operation createAPIToken
createAPITokenAsync() : PromiseInterface: Operation createAPITokenAsync
createAPITokenAsyncWithHttpInfo() : PromiseInterface: Operation createAPITokenAsyncWithHttpInfo
createAPITokenRequest() : Request: Create request for operation 'createAPIToken'
createAPITokenWithHttpInfo() : array<string|int, mixed>: Operation createAPITokenWithHttpInfo
deleteAPIToken() : void: Operation deleteAPIToken
deleteAPITokenAsync() : PromiseInterface: Operation deleteAPITokenAsync
deleteAPITokenAsyncWithHttpInfo() : PromiseInterface: Operation deleteAPITokenAsyncWithHttpInfo
deleteAPITokenRequest() : Request: Create request for operation 'deleteAPIToken'
deleteAPITokenWithHttpInfo() : array<string|int, mixed>: Operation deleteAPITokenWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
listAPITokens() : array<string|int, APIToken>|Error: Operation listAPITokens
listAPITokensAsync() : PromiseInterface: Operation listAPITokensAsync
listAPITokensAsyncWithHttpInfo() : PromiseInterface: Operation listAPITokensAsyncWithHttpInfo
listAPITokensRequest() : Request: Create request for operation 'listAPITokens'
listAPITokensWithHttpInfo() : array<string|int, mixed>: Operation listAPITokensWithHttpInfo
setHostIndex() : void: Set the host index
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


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

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__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

createAPIToken()

Operation createAPIToken


    public
                    createAPIToken(APITokenCreateRequest $api_token_create_request[, string $contentType = self::contentTypes['createAPIToken'][0] ]) : APITokenCreateResponse|Error

Generate a new personal API token

Parameters

$api_token_create_request : APITokenCreateRequest: api_token_create_request (required)
$contentType : string = self::contentTypes['createAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAPIToken'] to see the possible values for this operation

Return values

APITokenCreateResponse|Error

createAPITokenAsync()

Operation createAPITokenAsync


    public
                    createAPITokenAsync(APITokenCreateRequest $api_token_create_request[, string $contentType = self::contentTypes['createAPIToken'][0] ]) : PromiseInterface

Generate a new personal API token

Parameters

$api_token_create_request : APITokenCreateRequest: (required)
$contentType : string = self::contentTypes['createAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAPIToken'] to see the possible values for this operation

Return values

PromiseInterface

createAPITokenAsyncWithHttpInfo()

Operation createAPITokenAsyncWithHttpInfo


    public
                    createAPITokenAsyncWithHttpInfo(APITokenCreateRequest $api_token_create_request[, string $contentType = self::contentTypes['createAPIToken'][0] ]) : PromiseInterface

Generate a new personal API token

Parameters

$api_token_create_request : APITokenCreateRequest: (required)
$contentType : string = self::contentTypes['createAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAPIToken'] to see the possible values for this operation

Return values

PromiseInterface

createAPITokenRequest()

Create request for operation 'createAPIToken'


    public
                    createAPITokenRequest(APITokenCreateRequest $api_token_create_request[, string $contentType = self::contentTypes['createAPIToken'][0] ]) : Request

Parameters

$api_token_create_request : APITokenCreateRequest: (required)
$contentType : string = self::contentTypes['createAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAPIToken'] to see the possible values for this operation

Return values

Request

createAPITokenWithHttpInfo()

Operation createAPITokenWithHttpInfo


    public
                    createAPITokenWithHttpInfo(APITokenCreateRequest $api_token_create_request[, string $contentType = self::contentTypes['createAPIToken'][0] ]) : array<string|int, mixed>

Generate a new personal API token

Parameters

$api_token_create_request : APITokenCreateRequest: (required)
$contentType : string = self::contentTypes['createAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['createAPIToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\APITokenCreateResponse|\ForgeDashboard\Generated\Model\Error|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

deleteAPIToken()

Operation deleteAPIToken


    public
                    deleteAPIToken(string $id[, string $contentType = self::contentTypes['deleteAPIToken'][0] ]) : void

Revoke a personal API token

Parameters

$id : string: id (required)
$contentType : string = self::contentTypes['deleteAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAPIToken'] to see the possible values for this operation

deleteAPITokenAsync()

Operation deleteAPITokenAsync


    public
                    deleteAPITokenAsync(string $id[, string $contentType = self::contentTypes['deleteAPIToken'][0] ]) : PromiseInterface

Revoke a personal API token

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['deleteAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAPIToken'] to see the possible values for this operation

Return values

PromiseInterface

deleteAPITokenAsyncWithHttpInfo()

Operation deleteAPITokenAsyncWithHttpInfo


    public
                    deleteAPITokenAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteAPIToken'][0] ]) : PromiseInterface

Revoke a personal API token

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['deleteAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAPIToken'] to see the possible values for this operation

Return values

PromiseInterface

deleteAPITokenRequest()

Create request for operation 'deleteAPIToken'


    public
                    deleteAPITokenRequest(string $id[, string $contentType = self::contentTypes['deleteAPIToken'][0] ]) : Request

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['deleteAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAPIToken'] to see the possible values for this operation

Return values

Request

deleteAPITokenWithHttpInfo()

Operation deleteAPITokenWithHttpInfo


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

Revoke a personal API token

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['deleteAPIToken'][0]: The value for the Content-Type header. Check self::contentTypes['deleteAPIToken'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

listAPITokens()

Operation listAPITokens


    public
                    listAPITokens([string $contentType = self::contentTypes['listAPITokens'][0] ]) : array<string|int, APIToken>|Error

List the signed-in user's own personal API tokens

Parameters

$contentType : string = self::contentTypes['listAPITokens'][0]: The value for the Content-Type header. Check self::contentTypes['listAPITokens'] to see the possible values for this operation

Return values

array<string|int, APIToken>|Error

listAPITokensAsync()

Operation listAPITokensAsync


    public
                    listAPITokensAsync([string $contentType = self::contentTypes['listAPITokens'][0] ]) : PromiseInterface

List the signed-in user's own personal API tokens

Parameters

$contentType : string = self::contentTypes['listAPITokens'][0]: The value for the Content-Type header. Check self::contentTypes['listAPITokens'] to see the possible values for this operation

Return values

PromiseInterface

listAPITokensAsyncWithHttpInfo()

Operation listAPITokensAsyncWithHttpInfo


    public
                    listAPITokensAsyncWithHttpInfo([string $contentType = self::contentTypes['listAPITokens'][0] ]) : PromiseInterface

List the signed-in user's own personal API tokens

Parameters

$contentType : string = self::contentTypes['listAPITokens'][0]: The value for the Content-Type header. Check self::contentTypes['listAPITokens'] to see the possible values for this operation

Return values

PromiseInterface

listAPITokensRequest()

Create request for operation 'listAPITokens'


    public
                    listAPITokensRequest([string $contentType = self::contentTypes['listAPITokens'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['listAPITokens'][0]: The value for the Content-Type header. Check self::contentTypes['listAPITokens'] to see the possible values for this operation

Return values

Request

listAPITokensWithHttpInfo()

Operation listAPITokensWithHttpInfo


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

List the signed-in user's own personal API tokens

Parameters

$contentType : string = self::contentTypes['listAPITokens'][0]: The value for the Content-Type header. Check self::contentTypes['listAPITokens'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\APIToken[]|\ForgeDashboard\Generated\Model\Error, 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>

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

TokensApi in package ForgeDashboard Generated

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

createAPIToken()

Parameters

Tags

Return values

createAPITokenAsync()

Parameters

Tags

Return values

createAPITokenAsyncWithHttpInfo()

Parameters

Tags

Return values

createAPITokenRequest()

Parameters

Tags

Return values

createAPITokenWithHttpInfo()

Parameters

Tags

Return values

deleteAPIToken()

Parameters

Tags

deleteAPITokenAsync()

Parameters

Tags

Return values

deleteAPITokenAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteAPITokenRequest()

Parameters

Tags

Return values

deleteAPITokenWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

listAPITokens()

Parameters

Tags

Return values

listAPITokensAsync()

Parameters

Tags

Return values

listAPITokensAsyncWithHttpInfo()

Parameters

Tags

Return values

listAPITokensRequest()

Parameters

Tags

Return values

listAPITokensWithHttpInfo()

Parameters

Tags

Return values

setHostIndex()

TokensApi
in package

ForgeDashboard

Generated