DeliveryApiKey
class DeliveryApiKey extends BaseProxy
DeliveryApiKey class.
This class is used as a proxy for doing operations related to delivery api keys.
Properties
| protected Client | $client | from BaseProxy | |
| protected string|null | $spaceId | from BaseProxy | |
| protected bool | $requiresSpaceId | Whether the current proxy requires a space ID for working properly. | from BaseProxy |
Methods
Returns the string to be used as baseUri option, or null otherwise.
No description
No description
Override this method in a proxy class if special headers are to be defined upon creation.
No description
No description
Returns the URI for the current proxy type.
An array of enabled methods for the current proxy.
Returns a DeliveryApiKey object which corresponds to the given resource ID in Contentful.
Details
in BaseProxy at line 76
ResourceInterface
__call(string $name, array $arguments)
Acts as a whitelister for protected methods.
in BaseProxy at line 91
protected string|null
getBaseUri()
Returns the string to be used as baseUri option, or null otherwise.
in BaseProxy at line 103
protected ResourceInterface|ResourceArray
getResource(array $values, Query $query = null, ResourceInterface $resource = null)
in BaseProxy at line 130
protected ResourceInterface
requestResource(string $method, string $uriSuffix, ResourceInterface|string $resource, int $version = null, mixed $body = null)
in BaseProxy at line 158
protected string
getResourceId(ResourceInterface|string $resource)
at line 25
ResourceInterface
create(DeliveryApiKey $resource, string $resourceId = null)
in BaseProxy at line 198
protected string[]
getCreateAdditionalHeaders(ResourceInterface $resource)
Override this method in a proxy class if special headers are to be defined upon creation.
at line 25
ResourceInterface
update(DeliveryApiKey $resource)
at line 25
ResourceInterface
delete(DeliveryApiKey|string $resource, int $version = null)
in BaseProxy at line 234
protected
archive(ResourceInterface|string $resource, int $version = null)
Archives a resource.
in BaseProxy at line 249
protected
unarchive(ResourceInterface|string $resource, int $version = null)
Unarchives a resource.
in BaseProxy at line 264
protected
publish(ResourceInterface|string $resource, int $version = null)
Publishes a resource.
in BaseProxy at line 279
protected
unpublish(ResourceInterface|string $resource, int $version = null)
Unpublishes a resource.
at line 30
protected string
getResourceUri(array $values)
Returns the URI for the current proxy type.
at line 38
string[]
getEnabledMethods()
An array of enabled methods for the current proxy.
at line 52
DeliveryApiKey
get(string $resourceId)
Returns a DeliveryApiKey object which corresponds to the given resource ID in Contentful.
at line 68
ResourceArray
getAll(Query $query = null)
Returns a ResourceArray object containing DeliveryApiKey objects.