- COPYRIGHT AND LICENSE
WebService::ValidSign::API::DocumentPackage - A REST API client for ValidSign
You should not need to instantiate this object yourself. Use WebService::ValidSign for this.
use WebService::ValidSign; my $api = WebService::ValidSign->new( secret => 'foo', endpoint => 'https://some.url/api', ); my $pkg_api = $api->package;
Implement the endpoint as required by WebService::ValidSign::API.
Find a document package based on the ID. You get a WebService::ValidSign::Object::DocumentPackage object when we have found the document package.
The object is not full up to spec, as the documents are still an arrayref filled with hashrefs. Later implementations will try to fix this issue.
Create a document package on the ValidSign side. You need to pass a Webservice::ValidSign::Object::DocumentPackage to the call. It cannot have and ID as you would be able to create two packages with the same ID. You can call this function with, or without documents attached to the document package.
Similar to the create call, but this one can only be called when there are documents attached to the document package.
Download a document from package. When no document id is supplied we will only download the first document. If you supply one, we will use this document id. There is not check to see if the document actually exists in the document package. Callers should check these themselves (via the
Download all documents from the package. You will get a filehandle to a zip file. Use Archive::ZIP to extract the files.
Wesley Schwengle <firstname.lastname@example.org>
This software is Copyright (c) 2019 by Wesley Schwengle.
This is free software, licensed under:
The (three-clause) BSD License