Skip to content

Latest commit

 

History

History
196 lines (133 loc) · 6.71 KB

AuditTrailApi.md

File metadata and controls

196 lines (133 loc) · 6.71 KB

Yousign\Client\AuditTrailApi

All URIs are relative to https://api-sandbox.yousign.app/v3, except if the operation defines another base path.

Method HTTP request Description
getSignatureRequestsSignatureRequestIdAuditTrailsDownload() GET /signature_requests/{signatureRequestId}/audit_trails/download Download Signature Request Audit Trails
getSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails() GET /signature_requests/{signatureRequestId}/signers/{signerId}/audit_trails Get Signer Audit Trail
getSignersSignerIdAuditTrailsDownload() GET /signature_requests/{signatureRequestId}/signers/{signerId}/audit_trails/download Download Audit Trail PDF

getSignatureRequestsSignatureRequestIdAuditTrailsDownload()

getSignatureRequestsSignatureRequestIdAuditTrailsDownload($signature_request_id, $merge): \SplFileObject

Download Signature Request Audit Trails

Download the PDF version of all the Audit Trails attached to a given Signature Request. Each Audit Trail is bound to a different Signer. Only possible when the Signature Request status is done.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\AuditTrailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$merge = false; // bool | Download all Audit Trails merged as a single PDF file

try {
    $result = $apiInstance->getSignatureRequestsSignatureRequestIdAuditTrailsDownload($signature_request_id, $merge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditTrailApi->getSignatureRequestsSignatureRequestIdAuditTrailsDownload: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
merge bool Download all Audit Trails merged as a single PDF file [optional] [default to false]

Return type

\SplFileObject

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/zip, application/pdf, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails()

getSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails($signature_request_id, $signer_id): \Yousign\Client\Model\SignerAuditTrail

Get Signer Audit Trail

Retrieves the JSON version of the Audit Trail attached to a given Signer. Only possible when Signer status is signed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\AuditTrailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$signer_id = 'signer_id_example'; // string | Signer Id

try {
    $result = $apiInstance->getSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails($signature_request_id, $signer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditTrailApi->getSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
signer_id string Signer Id

Return type

\Yousign\Client\Model\SignerAuditTrail

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSignersSignerIdAuditTrailsDownload()

getSignersSignerIdAuditTrailsDownload($signature_request_id, $signer_id): \SplFileObject

Download Audit Trail PDF

Download the PDF version of the Audit Trail attached to a given Signer. Only possible when Signer status is signed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\AuditTrailApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$signer_id = 'signer_id_example'; // string | Signer Id

try {
    $result = $apiInstance->getSignersSignerIdAuditTrailsDownload($signature_request_id, $signer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditTrailApi->getSignersSignerIdAuditTrailsDownload: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
signer_id string Signer Id

Return type

\SplFileObject

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/pdf, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]