NAME

WebService::POEditor::Response

VERSION

version v1.1.0

res

Instance of Role::REST::Client::Response.

method

Original request method.

response

POEditor API response hash.

status

POEditor API response status.

code

POEditor API response code.

message

POEditor API response message.

list

Returns array of items for responses that return "list" (e.g. List Projects).

  my @list = $res->list;

count_list

Returns number of items in the list.

has_list

Returns true if list has items, false otherwise.

get_list_item($index)

Get list item by array index.

item

Returns item HashRef for responses that provide "item" (e.g. View Project Details).

NOTE: For "Export" method call, even though it provides item, the response will be stored in "export_url".

get_item($item_key)

  my $id = $res->get_item('id');

Returns item by key.

has_item

Returns true if response has item, false otherwise.

details

Returns details HashRef for responses that provide "details" (e.g. Add Terms).

get_detail($key)

Get detail by key.

  my $parsed = $self->get_detail('parsed');

has_details

Return true if response has details, false otherwise.

export_url

For "Export" method call returns an URL string.

AUTHOR

Roman F. <romanf@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Roman F..

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm WebService::POEditor

perl -MCPAN -e shell
install WebService::POEditor