File Coverage

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

Criterion	Covered	Total	%
statement	12	38	31.5
branch			n/a
condition			n/a
subroutine	4	12	33.3
pod	8	8	100.0
total	24	58	41.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::Milestones;

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_active_milestone

    Get active Milestone for specific Contract

B

$contract_id

    Contract ID

B

    JSON response as a string

=cut

sub get_active_milestone {
    my $self = shift;
    my $contract_id = shift;

    return $self->client()->get("/hr/v3/fp/milestones/statuses/active/contracts/" . $contract_id);
}

=item get_submissions

    Get active Milestone for specific Contract

B

$milestone_id

    Milestone ID

B

    JSON response as a string

=cut

sub get_submissions {
    my $self = shift;
    my $milestone_id = shift;

    return $self->client()->get("/hr/v3/fp/milestones/" . $milestone_id . "/submissions");
}

=item create

    Create a new Milestone

B

$params

    Hash of parameters

B

    JSON response as a string

=cut

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

    return $self->client()->post("/hr/v3/fp/milestones", %params);
}

=item edit

    Edit an existing Milestone

B

$milestone_id

    Milestone ID

$params

    Hash of parameters

B

    JSON response as a string

=cut

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

    return $self->client()->put("/hr/v3/fp/milestones/" . $milestone_id, %params);
}

=item activate

    Activate an existing Milestone

B

$milestone_id

    Milestone ID

$params

    Hash of parameters

B

    JSON response as a string

=cut

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

    return $self->client()->put("/hr/v3/fp/milestones/" . $milestone_id . "/activate", %params);
}

=item approve

    Approve an existing Milestone

B

$milestone_id

    Milestone ID

$params

    Hash of parameters

B

    JSON response as a string

=cut

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

    return $self->client()->put("/hr/v3/fp/milestones/" . $milestone_id . "/approve", %params);
}

=item delete

    Delete existent milestone

B

$milestone_id

    Milestone ID

B

    JSON response as a string

=cut

sub delete {
    my $self = shift;
    my $milestone_id = shift;

    return $self->client()->delete("/hr/v3/fp/milestones/" . $milestone_id);
}

=back

=head1 AUTHOR

Maksym Novozhylov C<<  >>

=head1 COPYRIGHT

Copyright E Upwork Global Corp., 2015

=cut

1;