Skip to content

Latest commit

 

History

History
254 lines (171 loc) · 8.49 KB

MetadataApi.md

File metadata and controls

254 lines (171 loc) · 8.49 KB

Yousign\Client\MetadataApi

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

Method HTTP request Description
deleteSignatureRequestsSignatureRequestIdMetadata() DELETE /signature_requests/{signatureRequestId}/metadata Delete the Signature Request Metadata
getSignatureRequestsSignatureRequestIdMetadata() GET /signature_requests/{signatureRequestId}/metadata Get the Signature Request Metadata
postSignatureRequestsSignatureRequestIdMetadata() POST /signature_requests/{signatureRequestId}/metadata Attach Metadata to a Signature Request
putSignatureRequestsSignatureRequestIdMetadata() PUT /signature_requests/{signatureRequestId}/metadata Update Metadata of a Signature Request

deleteSignatureRequestsSignatureRequestIdMetadata()

deleteSignatureRequestsSignatureRequestIdMetadata($signature_request_id)

Delete the Signature Request Metadata

Deletes the Metadata of a given Signature Request.

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\MetadataApi(
    // 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

try {
    $apiInstance->deleteSignatureRequestsSignatureRequestIdMetadata($signature_request_id);
} catch (Exception $e) {
    echo 'Exception when calling MetadataApi->deleteSignatureRequestsSignatureRequestIdMetadata: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id

Return type

void (empty response body)

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]

getSignatureRequestsSignatureRequestIdMetadata()

getSignatureRequestsSignatureRequestIdMetadata($signature_request_id): \Yousign\Client\Model\Metadata

Get the Signature Request Metadata

Retrieves the Metadata of a given Signature Request.

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\MetadataApi(
    // 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

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

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id

Return type

\Yousign\Client\Model\Metadata

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]

postSignatureRequestsSignatureRequestIdMetadata()

postSignatureRequestsSignatureRequestIdMetadata($signature_request_id, $create_signature_request_metadata): \Yousign\Client\Model\Metadata

Attach Metadata to a Signature Request

Add Metadata to a given Signature Request.

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\MetadataApi(
    // 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
$create_signature_request_metadata = new \Yousign\Client\Model\CreateSignatureRequestMetadata(); // \Yousign\Client\Model\CreateSignatureRequestMetadata

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

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
create_signature_request_metadata \Yousign\Client\Model\CreateSignatureRequestMetadata [optional]

Return type

\Yousign\Client\Model\Metadata

Authorization

bearerAuth

HTTP request headers

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

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

putSignatureRequestsSignatureRequestIdMetadata()

putSignatureRequestsSignatureRequestIdMetadata($signature_request_id, $update_signature_request_metadata): \Yousign\Client\Model\Metadata

Update Metadata of a Signature Request

Updates the Metadata of a given Signature Request. Any parameters not provided are left unchanged.

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\MetadataApi(
    // 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
$update_signature_request_metadata = new \Yousign\Client\Model\UpdateSignatureRequestMetadata(); // \Yousign\Client\Model\UpdateSignatureRequestMetadata

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

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
update_signature_request_metadata \Yousign\Client\Model\UpdateSignatureRequestMetadata [optional]

Return type

\Yousign\Client\Model\Metadata

Authorization

bearerAuth

HTTP request headers

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

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