File Coverage

blib/lib/WWW/TypePad/Applications.pm

Criterion	Covered	Total	%
statement	15	66	22.7
branch			n/a
condition			n/a
subroutine	5	18	27.7
pod	7	13	53.8
total	27	97	27.8

package WWW::TypePad::Applications;

use strict;
use warnings;

# Install an accessor into WWW::TypePad to access an instance of this class
# bound to the WWW::TypePad instance.
sub WWW::TypePad::applications { __PACKAGE__->new( base => $_[0] ) }

### BEGIN auto-generated
### This is an automatically generated code, do not edit!
### Scroll down to look for END to add additional methods

=pod

=head1 NAME

WWW::TypePad::Applications - Applications API methods

=head1 METHODS

=cut

use strict;
use Any::Moose;
extends 'WWW::TypePad::Noun';

use Carp ();


=pod

=over 4


=item get

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

Get basic information about the selected application.

Returns Application which contains following properties.

=over 8

=item name

(string) The name of the application as provided by its developer.

=item id

(string) A string containing the canonical identifier that can be used to identify this application in URLs.

=item objectTypes

(setEstringE) BEDeprecatedE The object types for this object. This set will contain the string CEtag:api.typepad.com,2009:ApplicationE for an Application object.

=item objectType

(string) The keyword identifying the type of object this is. For an Application object, MEobjectTypeE will be CEApplicationE.

=item oauthRequestTokenUrl

(string) The URL of the OAuth request token endpoint for this application.

=item oauthAuthorizationUrl

(string) The URL to send the user's browser to for the user authorization step.

=item oauthAccessTokenUrl

(string) The URL of the OAuth access token endpoint for this application.

=item oauthIdentificationUrl

(string) The URL to send the user's browser to in order to identify who is logged in (that is, the "sign in" link).

=item sessionSyncScriptUrl

(string) The URL of the session sync script.

=item signoutUrl

(string) The URL to send the user's browser to in order to sign them out of TypePad.

=item userFlyoutsScriptUrl

(string) The URL of a script to embed to enable the user flyouts functionality.

=item id

(string) A URI that serves as a globally unique identifier for the object.

=item urlId

(string) A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.


=back

=cut

sub get {
    my $api = shift;
    my @args;
    push @args, shift; # id
    my $uri = sprintf '/applications/%s.json', @args;
    $api->base->call("GET", $uri, @_);
}


=pod



=item get_badges

  my $res = $tp->applications->get_badges($id);

Get a list of badges defined by this application.

Returns ListEBadgeE which contains following properties.

=over 8

=item totalResults

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

=item entries

(arrayEBadgeE) The items within the selected slice of the list.


=back

=cut

sub get_badges {
    my $api = shift;
    my @args;
    push @args, shift; # id
    my $uri = sprintf '/applications/%s/badges.json', @args;
    $api->base->call("GET", $uri, @_);
}


sub badges {
    my $self = shift;
    Carp::carp("'badges' is deprecated. Use 'get_badges' instead.");
    $self->get_badges(@_);
}

=pod



=item get_learning_badges

  my $res = $tp->applications->get_learning_badges($id);

Get a list of all learning badges defined by this application.

Returns ListEBadgeE which contains following properties.

=over 8

=item totalResults

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

=item entries

(arrayEBadgeE) The items within the selected slice of the list.


=back

=cut

sub get_learning_badges {
    my $api = shift;
    my @args;
    push @args, shift; # id
    my $uri = sprintf '/applications/%s/badges/@learning.json', @args;
    $api->base->call("GET", $uri, @_);
}


sub learning_badges {
    my $self = shift;
    Carp::carp("'learning_badges' is deprecated. Use 'get_learning_badges' instead.");
    $self->get_learning_badges(@_);
}

=pod



=item get_public_badges

  my $res = $tp->applications->get_public_badges($id);

Get a list of all public badges defined by this application.

Returns ListEBadgeE which contains following properties.

=over 8

=item totalResults

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

=item entries

(arrayEBadgeE) The items within the selected slice of the list.


=back

=cut

sub get_public_badges {
    my $api = shift;
    my @args;
    push @args, shift; # id
    my $uri = sprintf '/applications/%s/badges/@public.json', @args;
    $api->base->call("GET", $uri, @_);
}


sub public_badges {
    my $self = shift;
    Carp::carp("'public_badges' is deprecated. Use 'get_public_badges' instead.");
    $self->get_public_badges(@_);
}

=pod



=item create_external_feed_subscription

  my $res = $tp->applications->create_external_feed_subscription($id);

Subscribe the application to one or more external feeds.

Returns hash reference which contains following properties.

=over 8

=item subscription

(ExternalFeedSubscription) The subscription object that was created.


=back

=cut

sub create_external_feed_subscription {
    my $api = shift;
    my @args;
    push @args, shift; # id
    my $uri = sprintf '/applications/%s/create-external-feed-subscription.json', @args;
    $api->base->call("POST", $uri, @_);
}


=pod



=item get_external_feed_subscriptions

  my $res = $tp->applications->get_external_feed_subscriptions($id);

Get a list of the application's active external feed subscriptions.

Returns ListEExternalFeedSubscriptionE which contains following properties.

=over 8

=item totalResults

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

=item entries

(arrayEExternalFeedSubscriptionE) The items within the selected slice of the list.


=back

=cut

sub get_external_feed_subscriptions {
    my $api = shift;
    my @args;
    push @args, shift; # id
    my $uri = sprintf '/applications/%s/external-feed-subscriptions.json', @args;
    $api->base->call("GET", $uri, @_);
}


sub external_feed_subscriptions {
    my $self = shift;
    Carp::carp("'external_feed_subscriptions' is deprecated. Use 'get_external_feed_subscriptions' instead.");
    $self->get_external_feed_subscriptions(@_);
}

=pod



=item get_groups

  my $res = $tp->applications->get_groups($id);

Get a list of groups in which a client using a CEapp_fullE access auth token from this application can act.

Returns ListEGroupE which contains following properties.

=over 8

=item totalResults

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

=item entries

(arrayEGroupE) The items within the selected slice of the list.


=back

=cut

sub get_groups {
    my $api = shift;
    my @args;
    push @args, shift; # id
    my $uri = sprintf '/applications/%s/groups.json', @args;
    $api->base->call("GET", $uri, @_);
}


sub groups {
    my $self = shift;
    Carp::carp("'groups' is deprecated. Use 'get_groups' instead.");
    $self->get_groups(@_);
}

=pod

=back

=cut

### END auto-generated

1;