coriolis/sell-and-sign

A component to query the sell and sign API

1.1.2 2021-05-12 15:38 UTC

Requires

• jms/serializer: ^3.12
• phpunit/phpunit: ^8.5
• symfony/http-client: ^4.1
• symfony/var-dumper: ^4.1

MIT

• Hayat Qamar

README

This package offers you some features in order to interact with the REST API of the SellAndSign group https://www.sellandsign.com

Installation with composer

composer require coriolis/sell-and-sign

The features

ContractLoader

• getContracts > Allows you to retrieve all the available contracts
• getContract > Allows you to retrieve a contract from its ID
• getContractorsAbout > Allows you to retrieve all the signatories of a contract
• closeTransaction > Used to close the transaction of a contract

FileLoader

• getFilesForContract
• loadFile
• getEvidences
• getContractFileSigned
• getCurrentDocumentForContract

MemberLoader

• getMembers

ContractLoader

use QH\Sellandsign\{
    Configuration,
    ContractLoader,
    DTO\Request
};
use Symfony\Component\HttpClient\HttpClient;

//init the configuration
$configuration = (new Configuration)
    ->setApiUrl("THE_API_URL")
    ->setHttpclient(HttpClient::create())
    ->setToken("THE_TOEKN")
    ->setLicenseId("THE_LICENSE_ID");
    
$contractLoader = new ContractLoader($configuration);

/**
* Retrive all contract
 */
 
//You must provide an instance of Request
$request = new Request; //this class offers you certain method to specify filters
$contracts = $contractLoader->getContracts($request); //return an instance of ContractCollection


/**
* Retrieve a contract
 */
 $contract = $contractLoader->getContract(1234); // return an instance of Contract or null

FileLoader

use QH\Sellandsign\{
    Configuration,
    FileLoader
};
use Symfony\Component\HttpClient\HttpClient;

//init the configuration
$configuration = (new Configuration)
    ->setApiUrl("THE_API_URL")
    ->setHttpclient(HttpClient::create())
    ->setToken("THE_TOEKN")
    ->setLicenseId("THE_LICENSE_ID");
    
$fileLoader = new FileLoader($configuration);

$fileContent = $this->fileLoader->getCurrentDocumentForContract(1234); //return the content of the file in string

//You can write a file with the content
$filename = "someName.pdf";
$pathOfDirectory = "/path/of/directory/";
$file = fopen($pathOfDirectory . $filename , 'w');
fwrite($file, $fileContent);
fclose($fileHandler);

MemberLoader

use QH\Sellandsign\{
    Configuration,
    MemberLoader,
    DTO\MemberRequest
};
use Symfony\Component\HttpClient\HttpClient;

//init the configuration
$configuration = (new Configuration)
    ->setApiUrl("THE_API_URL")
    ->setHttpclient(HttpClient::create())
    ->setToken("THE_TOEKN")
    ->setLicenseId("THE_LICENSE_ID");
    
$memberLoader = new MemberLoader($configuration);

$request = new MemberRequest();
$members = $memberLoader->getMembers($request); //return an instance of MemberCollection

//You can do a search, for example a search on an email 
//it will be necessary to modify the request 
$request = new MemberRequest();
$request->setSearchString("[e-mail]");
$members = $memberLoader->getMembers($request); //return an instance of MemberCollection