ApiKey
class ApiKey extends BaseResource
ApiKey class.
Properties
| protected ApiKey | $sys | ||
| protected Client|null | $client | from BaseResource | |
| protected string | $name | ||
| protected string|null | $description | ||
| protected string|null | $accessToken | ||
| protected Link[] | $environments |
Methods
getSystemProperties()
{@inheritdoc}
getName()
No description
string|null
getDescription()
No description
setDescription(string $description)
No description
string|null
getAccessToken()
No description
jsonSerialize()
{@inheritdoc}
setEnvironments(array $environments)
No description
Link[]
getEnvironments()
No description
addEnvironment(Link $environment)
No description
Details
in BaseResource at line 37
getId()
{@inheritdoc}
in BaseResource at line 45
getType()
{@inheritdoc}
in BaseResource at line 53
asLink()
{@inheritdoc}
in BaseResource at line 61
mixed
asRequestBody()
Returns the resource in the form of request body.
This can differ from regular serialization, as some fields may not be present in the request payload.
in BaseResource at line 77
BaseResource
setClient(Client $client)
Sets the current Client object instance.
This is done automatically when performing API calls, so it shouldn't be used manually.
at line 50
getSystemProperties()
{@inheritdoc}
at line 55
getName()
at line 63
ApiKey
setName(string $name)
at line 73
string|null
getDescription()
at line 81
ApiKey
setDescription(string $description)
at line 91
string|null
getAccessToken()
at line 99
jsonSerialize()
{@inheritdoc}