File Coverage

lib/Net/Upwork/API/Routers/Hr/Engagements.pm

Criterion	Covered	Total	%
statement	12	20	60.0
branch			n/a
condition			n/a
subroutine	4	7	57.1
pod	3	3	100.0
total	19	30	63.3

# Licensed under the Upwork's API Terms of Use;
# you may not use this file except in compliance with the Terms.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Author::    Maksym Novozhylov ([e-mail])
# Copyright:: Copyright 2015(c) Upwork.com
# License::   See LICENSE.txt and TOS - https://developers.upwork.com/api-tos.html

package Net::Upwork::API::Routers::Hr::Engagements;

use strict;
use warnings;
use parent "Net::Upwork::API";

use constant ENTRY_POINT => Net::Upwork::API::Client::ENTRY_POINT_API;

=pod

=head1 NAME

Auth

=head1 FUNCTIONS

=over 4

=item new($api)

Create a new object for accessing Auth API

B

$api

    API object

=cut

sub new {
    my ($class, $api) = @_;
    return Net::Upwork::API::init_router($class, $api, ENTRY_POINT);
}

=item get_list

    Get list of engagements

B

$params

    Hash of parameters

B

    JSON response as a string

=cut

sub get_list {
    my $self = shift;
    my %params = @_;

    return $self->client()->get("/hr/v2/engagements", %params);
}

=item get_specific

    Get specific engagement

B

$reference

    Engagement reference

B

    JSON response as a string

=cut

sub get_specific {
    my $self = shift;
    my $reference = shift;

    return $self->client()->get("/hr/v2/engagements/" . $reference);
}

=back

=head1 AUTHOR

Maksym Novozhylov C<<  >>

=head1 COPYRIGHT

Copyright E Upwork Global Corp., 2015

=cut

1;