NAME

WebService::TypePad::Object::Endpoint - Perl representation of TypePad's Endpoint object type

SYNOPSIS

    use WebService::TypePad::Object::Endpoint;
    my $endpoint = WebService::TypePad::Object::Endpoint->new();

DESCRIPTION

This is a Perl representation of TypePad's Endpoint object type. For more information about this type and its parameters, see the documentation on TypePad's developer site.

PROPERTIES

Each of these properties has an accessor method which will retrieve the property's value when called with no arguments or set the property's value when called with one argument.

$endpoint->action_endpoints

For noun endpoints, an array of action endpoints that it supports.

Returns an array of Endpoint objects.

$endpoint->can_have_id

For noun endpoints, true if an id part is accepted, or false if the noun may only be used alone.

Returns a single boolean value.

$endpoint->can_omit_id

For noun endpoints, true if the id part can be ommitted, or false if it is always required.

Returns a single boolean value.

$endpoint->filter_endpoints

For endpoints that return lists, an array of filters that can be appended to the endpoint.

Returns an array of Endpoint objects.

$endpoint->format_sensitive

true if this requires expects a format suffix, or false otherwise.

Returns a single boolean value.

$endpoint->name

The name of the noun, as it appears in URLs.

Returns a single string value.

$endpoint->parameterized

For filter endpoints, true if a parameter is required on the filter, or false if it's a boolean filter.

Returns a single boolean value.

$endpoint->post_object_type

The type of object that this endpoint accepts for POST operations.

Returns a single ObjectType object.

$endpoint->property_endpoints

For noun endpoints, an array of property endpoints that it supports.

Returns an array of Endpoint objects.

$endpoint->resource_object_type

The type of object that this endpoint represents for GET, PUT and DELETE operations. This is not returned for action endpoints, since they do not represent resources.

Returns a single ObjectType object.

$endpoint->response_object_type

For action endpoints, the type of object that this endpoint returns on success. If the endpoint returns no payload on success, this property is null.

Returns a single ObjectType object.

$endpoint->supported_methods

A mapping whose keys are the HTTP method that this endpoint accepts and whose values are docstrings describing the result of each method.

Returns a map of string values.

$endpoint->supported_query_arguments

The names of the query string arguments that this endpoint accepts.

Returns a set of string values.

SEE ALSO

• WebService::TypePad::Noun::Nouns

• http://www.typepad.com/services/apidocs/objecttypes/Endpoint

cpanm WebService::TypePad

perl -MCPAN -e shell
install WebService::TypePad