Tectly PHP Client

DocumentPagesApi
in package

DocumentPagesApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Constants

contentTypes  = ['fetchDocumentPage' => ['application/json'], 'removeDocumentPage' => ['application/json']]

Properties

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

Methods

__construct()  : mixed
fetchDocumentPage()  : DocumentPage
Operation fetchDocumentPage
fetchDocumentPageAsync()  : PromiseInterface
Operation fetchDocumentPageAsync
fetchDocumentPageAsyncWithHttpInfo()  : PromiseInterface
Operation fetchDocumentPageAsyncWithHttpInfo
fetchDocumentPageRequest()  : Request
Create request for operation 'fetchDocumentPage'
fetchDocumentPageWithHttpInfo()  : array<string|int, mixed>
Operation fetchDocumentPageWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
removeDocumentPage()  : void
Operation removeDocumentPage
removeDocumentPageAsync()  : PromiseInterface
Operation removeDocumentPageAsync
removeDocumentPageAsyncWithHttpInfo()  : PromiseInterface
Operation removeDocumentPageAsyncWithHttpInfo
removeDocumentPageRequest()  : Request
Create request for operation 'removeDocumentPage'
removeDocumentPageWithHttpInfo()  : array<string|int, mixed>
Operation removeDocumentPageWithHttpInfo
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 = ['fetchDocumentPage' => ['application/json'], 'removeDocumentPage' => ['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

fetchDocumentPage()

Operation fetchDocumentPage

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

Get a document page by its id.

Parameters
$id : string

id (required)

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

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

fetchDocumentPageAsync()

Operation fetchDocumentPageAsync

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

Get a document page by its id.

Parameters
$id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

fetchDocumentPageAsyncWithHttpInfo()

Operation fetchDocumentPageAsyncWithHttpInfo

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

Get a document page by its id.

Parameters
$id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

fetchDocumentPageRequest()

Create request for operation 'fetchDocumentPage'

public fetchDocumentPageRequest(string $id[, string $contentType = self::contentTypes['fetchDocumentPage'][0] ]) : Request
Parameters
$id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

fetchDocumentPageWithHttpInfo()

Operation fetchDocumentPageWithHttpInfo

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

Get a document page by its id.

Parameters
$id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['fetchDocumentPage'] 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\DocumentPage, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int —

Host index

removeDocumentPage()

Operation removeDocumentPage

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

Delete a document page.

Parameters
$id : string

id (required)

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

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

removeDocumentPageAsync()

Operation removeDocumentPageAsync

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

Delete a document page.

Parameters
$id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

removeDocumentPageAsyncWithHttpInfo()

Operation removeDocumentPageAsyncWithHttpInfo

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

Delete a document page.

Parameters
$id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

removeDocumentPageRequest()

Create request for operation 'removeDocumentPage'

public removeDocumentPageRequest(string $id[, string $contentType = self::contentTypes['removeDocumentPage'][0] ]) : Request
Parameters
$id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

removeDocumentPageWithHttpInfo()

Operation removeDocumentPageWithHttpInfo

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

Delete a document page.

Parameters
$id : string

(required)

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

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