DeleteTrait
Trait DeleteTrait
Table of Contents
Methods
- deleteApiKey() : bool
- Delete an API key
- deleteTemplate() : bool
- Delete a template in template storage
- request() : ResponseInterface
- Request the URI with options
- uri() : string
- Construct URI with version number
- delete() : bool
- Execute a DELETE request via REST client
Methods
deleteApiKey()
Delete an API key
public
deleteApiKey(string $key) : bool
Parameters
- $key : string
Return values
booldeleteTemplate()
Delete a template in template storage
public
deleteTemplate(string $templateName) : bool
Parameters
- $templateName : string
Return values
boolrequest()
Request the URI with options
protected
abstract request(string $method, string $uri, array<string|int, mixed> $options) : ResponseInterface
Parameters
- $method : string
-
HTTP method
- $uri : string
-
URI
- $options : array<string|int, mixed>
-
Options
Return values
ResponseInterfaceuri()
Construct URI with version number
protected
abstract uri(string $uri) : string
Parameters
- $uri : string
-
URI
Return values
stringdelete()
Execute a DELETE request via REST client
private
delete(string $uri[, array<string|int, mixed> $query = [] ][, mixed $json = '' ][, int $statusCode = 0 ]) : bool
Parameters
- $uri : string
-
URI
- $query : array<string|int, mixed> = []
-
Query
- $json : mixed = ''
-
JSON
- $statusCode : int = 0
-
Required HTTP status code for response