\TxTextControl\ReportingCloudDeleteTrait

Trait DeleteTrait

Summary

Methods

Properties

Constants

deleteApiKey()
deleteTemplate()

No public properties found

No constants found

uri()
request()

No protected properties found

N/A

delete()

No private properties found

N/A

File: DeleteTrait.php
Package: TxTextControl\ReportingCloud
Class hierarchy: \TxTextControl\ReportingCloud\DeleteTrait

Methods

deleteApiKey()

deleteApiKey(string  $key) : bool

Delete an API key

Parameters

string

$key

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

bool —

deleteTemplate()

deleteTemplate(string  $templateName) : bool

Delete a template in template storage

Parameters

string

$templateName

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

bool —

uri()

uri(string  $uri) : string

Construct URI with version number

Parameters

string

$uri

URI

Returns

string —

request()

request(string  $method, string  $uri, array  $options) : \Psr\Http\Message\ResponseInterface

Request the URI with options

Parameters

string	$method	HTTP method
string	$uri	URI
array	$options	Options

Throws

\TxTextControl\ReportingCloud\Exception\RuntimeException

Returns

\Psr\Http\Message\ResponseInterface —

delete()

delete(string  $uri, array<string,string>  $query = [], mixed  $json = '', int  $statusCode) : bool

Execute a DELETE request via REST client

Parameters

string	$uri	URI
array	$query	Query
mixed	$json	JSON
int	$statusCode	Required HTTP status code for response

Returns

bool —