NAME

WWW::GoDaddy::REST::Schema - schema specific resource class

SYNOPSIS

  $schema  = $client->schema('the_name');
  $scehama = $resource->schema(); 

DESCRIPTION

This is used to represent a 'schema' which is a very common resource in the Go Daddy(r) API specification.

It is a sub class of WWW::GoDaddy::REST::Resource.

METHODS

query

This is a helper method that, based on the parameters will choose to call query_by_id or query_complex.

You probably should not be calling this directly.

See the query method on WWW::GoDaddy::REST.

Example:

  $schema->query('1234'); # query_by_id('1234')
  $schema->query('1234', { opt => '1' } ); # query_by_id('1234', { opt => '1' } )

query_by_id

Returns a Resource given an id parameter and an optional hash reference with additional key value pairs.

You probably should not be calling this directly.

See the query method on the client instance.

Example:

  $resource = $schema->query_by_id('1234');
  $resource = $schema->query_by_id('1234', { opt => '1' } );

query_complex

Search against the collection defined by this resource.

Returns a Collection given a hash ref with key value pairs.

Example:

  $resource = $schema->query_complex( { opt => '1' } );

AUTHOR

David Bartle, <davidb@mediatemple.net>

COPYRIGHT & LICENSE

Copyright (c) 2014 Go Daddy Operating Company, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.