/ 
WWW-TypePad-0.2000
River stage one • 1 direct dependent • 1 total dependent
/ WWW::TypePad::Nouns

NAME

WWW::TypePad::Nouns - Nouns API methods

METHODS

get_all
my $res = $tp->nouns->get_all();

Get information about all of the nouns in the API, along with their sub-resources and filters.

Returns List<Endpoint> which contains following properties.

totalResults

(integer) The total number of items in the whole list of which this list object is a paginated view.

entries

(array<Endpoint>) The items within the selected slice of the list.

get
my $res = $tp->nouns->get($id);

Get information about the selected noun, its sub-resources and their filters.

Returns Endpoint which contains following properties.

name

(string) The name of the endpoint, as it appears in URLs.

supportedMethods

(map<string>) A mapping of the HTTP methods that this endpoint accepts to the docstrings describing the result of each method.

supportedQueryArguments

(set<string>) The names of the query string arguments that this endpoint accepts.

formatSensitive

(boolean) C<true> if this endpoint requires a format suffix, or C<false> otherwise.

propertyEndpoints

(array<Endpoint>) For noun endpoints, an array of property endpoints that it supports.

actionEndpoints

(array<Endpoint>) For noun endpoints, an array of action endpoints that it supports.

canHaveId

(boolean) For noun endpoints, C<true> if an id part is accepted, or C<false> if the noun may only be used alone.

canOmitId

(boolean) For noun endpoints, C<true> if the id part can be ommitted, or C<false> if it is always required.

parameterized

(boolean) For filter endpoints, C<true> if a parameter is required on the filter, or C<false> if it's a boolean filter.

filterEndpoints

(array<Endpoint>) For endpoints that return lists, an array of filters that can be appended to the endpoint.

resourceObjectType

(ObjectType) The type of object that this endpoint represents for C<GET>, C<PUT> and C<DELETE> operations. This property is omitted for action endpoints, as they do not represent resources.

postObjectType

(ObjectType) The type of object that this endpoint accepts for C<POST> operations. This property is omitted if this endpoint does not accept C<POST> requests.

responseObjectType

(ObjectType) For action endpoints, the type of object that this endpoint returns on success. If the endpoint returns no payload on success, or if this is not an action endpoint, this property is omitted.