view release on metacpan or  search on metacpan

lib/WebService/ValidSign.pm  view on Meta::CPAN

                search_path => $search_path,
                require     => 1,
            );
            @API_PLUGINS = $finder->plugins;
        }

        if (my $plugin = first { $pkg eq $_ } @API_PLUGINS) {
            return $pkg->new(
                $self->args_builder,
                $pkg eq 'WebService::ValidSign::API::Auth' ? () : (
                    auth => $self->auth,
                )
            );
        }
        die sprintf("Unable to load '%s', not found in search path: '%s'!\n",
            $pkg, $search_path);
    }
}

sub _build_auth {
    my $self = shift;
    return $self->__build_api_package('WebService::ValidSign::API::Auth');
}

sub _build_package {
    my $self = shift;
    return $self->__build_api_package('WebService::ValidSign::API::DocumentPackage');
}

sub _build_account {
    my $self = shift;
    return $self->__build_api_package('WebService::ValidSign::API::Account');
}

with "WebService::ValidSign::API::Constructor";

__PACKAGE__->meta->make_immutable;

__END__

=pod

=encoding UTF-8

=head1 NAME

WebService::ValidSign - A REST API client for ValidSign

=head1 VERSION

version 0.004

=head1 SYNOPSIS

    use WebService::ValidSign;
    use WebService::ValidSign::Object::DocumentPackage;
    use WebService::ValidSign::Object::Document;

    my $client = WebService::ValidSign->new(
        secret   => 'my very secret API key',
        endpoint => 'https://my.validsign.nl/api'
        lwp      => LWP::UserAgent->new(), # optional
    );

    my $documentpackage = WebService::ValidSign::Object::DocumentPackage->new(
        name => "Document package name"
    );

    my $senders = $client->account->senders(search => $sender);
    if (!@$senders) {
        die "Unable to find sender $opts{senders}\n";
    }
    elsif (@$senders > 1) {
        die "Multiple senders found for $opts{senders}\n";
    }
    $documentpackage->sender($senders->[0]);

    my $signers = $client->account->senders(search => $signer);
    if (!@$signers) {
        die "Unable to find sender $signer\n";
    }
    # at this moment only one signer is supported
    elsif (@$signers > 1) {
        die "Multiple senders found for $signer}\n";
    }
    $documentpackage->add_signer('rolename' => signers->[0]);

    my @documents = qw(
        /path/to/documents/foo.bar
        /path/to/documents/foo.txt
    );
    foreach (@documents) {
        my $document = WebService::ValidSign::Object::Document->new(
            name => "$_",
            path => $_,
        );
        $documentpackage->add_document($document);
    }

    my $id = $client->package->create($documentpackage);
    print "Created package with ID $id", $/;
    my $details = $client->package->details($documentpackage);

=head1 DESCRIPTION

A module that uses the ValidSign API to create/upload and sign documents.

=head1 ATTRIBUTES

This module extends L<WebService::ValidSign::API::Constructor> and all of its
attributes.

=over

=item secret

Your API key

=item endpoint

The API URI endpoint as described in the Application Integrator's Guide