File Coverage

lib/Net/Upwork/API/Routers/Reports/Finance/Earnings.pm

Criterion	Covered	Total	%
statement	12	34	35.2
branch			n/a
condition			n/a
subroutine	4	10	40.0
pod	6	6	100.0
total	22	50	44.0

# 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::Reports::Finance::Earnings;

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

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

=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_by_freelancer

    Generate Earning Reports for a Specific Freelancer

B

$freelancer_ref

    Freelancer reference

B

    JSON response as a string

=cut

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

    return $self->client()->get("/finreports/v2/providers/" . $freelancer_ref . "/earnings", %params);
}

=item get_by_freelancers_team

    Generate Earning Reports for a Specific Freelancer's Team

B

$freelancer_team_ref

    Freelancer's team reference

B

    JSON response as a string

=cut

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

    return $self->client()->get("/finreports/v2/provider_teams/" . $freelancer_team_ref . "/earnings", %params);
}

=item get_by_freelancers_company

    Generate Earning Reports for a Specific Freelancer's Company

B

$freelancer_company_ref

    Freelancer's company reference

B

    JSON response as a string

=cut

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

    return $self->client()->get("/finreports/v2/provider_companies/" . $freelancer_company_ref . "/earnings", %params);
}

=item get_by_buyers_team

    Generate Earning Reports for a Specific Buyer's Team

B

$buyer_team_ref

    Buyer's team reference

B

    JSON response as a string

=cut

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

    return $self->client()->get("/finreports/v2/buyer_teams/" . $buyer_team_ref . "/earnings", %params);
}

=item get_by_buyers_company

    Generate Earning Reports for a Specific Buyer's Company

B

$buyer_company_ref

    Buyer's company reference

B

    JSON response as a string

=cut

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

    return $self->client()->get("/finreports/v2/buyer_companies/" . $buyer_company_ref . "/earnings", %params);
}

=back

=head1 AUTHOR

Maksym Novozhylov C<<  >>

=head1 COPYRIGHT

Copyright E Upwork Global Corp., 2015

=cut

1;