Skip to content

Latest commit

 

History

History
272 lines (189 loc) · 10.6 KB

FieldApi.md

File metadata and controls

272 lines (189 loc) · 10.6 KB

Yousign\Client\FieldApi

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

Method HTTP request Description
deleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId() DELETE /signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId} Delete a Field
getSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields() GET /signature_requests/{signatureRequestId}/documents/{documentId}/fields Lists the Fields of a Signature Request Document.
postSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields() POST /signature_requests/{signatureRequestId}/documents/{documentId}/fields Create a new Field on a Document
updateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId() PATCH /signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId} Update a Field

deleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId()

deleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId($signature_request_id, $document_id, $field_id)

Delete a Field

Deletes a given Field from a Document.

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\FieldApi(
    // 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
$document_id = 'document_id_example'; // string | Document Id
$field_id = 'field_id_example'; // string | Field Id

try {
    $apiInstance->deleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId($signature_request_id, $document_id, $field_id);
} catch (Exception $e) {
    echo 'Exception when calling FieldApi->deleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
document_id string Document Id
field_id string Field 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]

getSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields()

getSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields($signature_request_id, $document_id, $types, $after, $limit): \Yousign\Client\Model\GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200Response

Lists the Fields of a Signature Request Document.

Returns a list of Fields for a given Document. You can limit the number of items returned by using filters.

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\FieldApi(
    // 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
$document_id = 'document_id_example'; // string | Document ID
$types = array(new \Yousign\Client\Model\\Yousign\Client\Model\FieldType()); // FieldType[] | Filter by Field type.
$after = 'after_example'; // string | After cursor (pagination)
$limit = 100; // int | The limit of items count to retrieve.

try {
    $result = $apiInstance->getSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields($signature_request_id, $document_id, $types, $after, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldApi->getSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
document_id string Document ID
types FieldType[] Filter by Field type. [optional]
after string After cursor (pagination) [optional]
limit int The limit of items count to retrieve. [optional] [default to 100]

Return type

\Yousign\Client\Model\GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200Response

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]

postSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields()

postSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields($signature_request_id, $document_id, $create_field): \Yousign\Client\Model\GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200ResponseDataInner

Create a new Field on a Document

Adds a Field to a given Document.

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\FieldApi(
    // 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
$document_id = 'document_id_example'; // string | Document ID
$create_field = new \Yousign\Client\Model\CreateField(); // \Yousign\Client\Model\CreateField

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

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
document_id string Document ID
create_field \Yousign\Client\Model\CreateField [optional]

Return type

\Yousign\Client\Model\GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200ResponseDataInner

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]

updateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId()

updateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId($signature_request_id, $document_id, $field_id, $update_field): \Yousign\Client\Model\GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200ResponseDataInner

Update a Field

Updates a given Field. 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\FieldApi(
    // 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
$document_id = 'document_id_example'; // string | Document Id
$field_id = 'field_id_example'; // string | Field Id
$update_field = new \Yousign\Client\Model\UpdateField(); // \Yousign\Client\Model\UpdateField

try {
    $result = $apiInstance->updateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId($signature_request_id, $document_id, $field_id, $update_field);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldApi->updateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
signature_request_id string Signature Request Id
document_id string Document Id
field_id string Field Id
update_field \Yousign\Client\Model\UpdateField [optional]

Return type

\Yousign\Client\Model\GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200ResponseDataInner

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]