NAME

package Ambassador::API::V2::Role::Response; Ambassador::API::V2:: # ABSTRACT: A response from the getambassador.com API v2

DESCRIPTION

Encapsulates the Ambassador Response Format.

See https://docs.getambassador.com/docs/response-codes.

ATTRIBUTES

http_response

The original HTTP::Tiny response.

response

The Ambassador "response" as a hash ref.

code

The Ambassador "code" field.

NOT the HTTP repsonse code.

message

The Ambassador "message" field.

CONSTRUCTORS

new_from_response($resp)

my $response = Ambassador::API::V2::Response->new_from_response(
    $http_tiny_response
);

Returns a new object from an HTTP::Tiny response hash ref.

METHODS

$bool = $resp->is_success

Returns whether the repsonse was successful or not.

SEE ALSO

Ambassador::API::V2::Result Ambassador::API::V2::Error

SOURCE

The source code repository for Ambassador-API-V2 can be found at https://github.com/dreamhost/Ambassador-API-V2.

COPYRIGHT

Copyright 2016 Dreamhost <dev-notify@hq.newdream.net>.

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

See http://dev.perl.org/licenses/