From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

ALEXD / WWW-BigDoor-v0.1.1 / lib / WWW / BigDoor / NamedAward.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
—
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

              
package WWW::BigDoor::NamedAward;
use strict;
use warnings;
use Carp;
#use Smart::Comments -ENV;
use base qw(WWW::BigDoor::Resource Class::Accessor);
__PACKAGE__->follow_best_practice;
__PACKAGE__->mk_accessors(
    qw(parent_id named_award_collection_id relative_weight id read_only urls collection_uri) );
sub _parent_end_point { ## no critic (ProhibitUnusedPrivateSubroutines)
    return 'named_award_collection';
}
sub _parent_id_attr { ## no critic (ProhibitUnusedPrivateSubroutines)
    return 'named_award_collection_id';
}
1;
__END__
=head1 NAME
WWW::BigDoor::NamedAward - NamedAward Resource Object for BigDoor API
=head1 VERSION
This document describes BigDoor version 0.1.1
=head1 SYNOPSIS
    use WWW::BigDoor;
    use WWW::BigDoor::NamedAward;
    use WWW::BigDoor::NamedAwardCollection;
    my $client = new WWW::BigDoor( $APP_SECRET, $APP_KEY );
    my $named_award_collections = WWW::BigDoor::NamedAwardCollection->all( $client );
    my $named_award_collection =
      new WWW::BigDoor::NamedAwardCollection( {
                pub_title            => 'application achievements',
                pub_description      => 'a set of achievements that the user can earn',
                end_user_title       => 'achievements',
                end_user_description => 'things you can get',
            };
      );
     
    $named_award_collection->save( $client );
    my $named_award = new WWW::BigDoor::NamedAward({
        pub_title                 => 'obligatory early achievement ',
        pub_description           => 'the sort of achievement you get when you can turn on an xbox',
        end_user_title            => 'just breath',
        end_user_description      => 'congratulations you rock so hard; keep on breathing',
        relative_weight           => 1,
        named_award_collection_id => $named_award_collection->get_id,
    });
    $named_award->save( $client );
    $named_award->remove( $client );
    $named_award_collection->remove( $client );
   
=head1 DESCRIPTION
This module provides object corresponding to BigDoor API /named_award end point.
For description see online documentation L<http://publisher.bigdoor.com/docs/>
=head1 INTERFACE 
All methods except accessor/mutators are provided by base
WWW::BigDoor::Resource object
=head1 DIAGNOSTICS
No error messages produced by module itself.
=head1 CONFIGURATION AND ENVIRONMENT
WWW:BigDoor::NamedAward requires no configuration files or environment variables.
=head1 DEPENDENCIES
WWW::BigDoor::Resource, WWW::BigDoor
=head1 INCOMPATIBILITIES
None reported.
=head1 BUGS AND LIMITATIONS
No bugs have been reported.
Please report any bugs or feature requests to
C<bug-bigdoor@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.
=head1 SEE ALSO
WWW::BigDoor::Resource for base class description, WWW::BigDoor for procedural
interface for BigDoor REST API
=head1 AUTHOR
Alex L. Demidov  C<< <alexeydemidov@gmail.com> >>
=head1 LICENCE AND COPYRIGHT
BigDoor Open License
Copyright (c) 2010 BigDoor Media, Inc.
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:
- This copyright notice and all listed conditions and disclaimers shall
be included in all copies and portions of the Software including any
redistributions in binary form.
- The Software connects with the BigDoor API (api.bigdoor.com) and
all uses, copies, modifications, derivative works, mergers, publications,
distributions, sublicenses and sales shall also connect to the BigDoor API and
shall not be used to connect with any API, software or service that competes
with BigDoor's API, software and services.
- Except as contained in this notice, this license does not grant you rights to
use BigDoor Media, Inc. or any contributors' name, logo, or trademarks.
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.