Skip to content

Latest commit

 

History

History
110 lines (78 loc) · 3.55 KB

OperationsApi.md

File metadata and controls

110 lines (78 loc) · 3.55 KB

YouSign\Client\OperationsApi

All URIs are relative to https://api.yousign.com

Method HTTP request Description
operationsIdGet GET /operations/{id} Find an Operation by ID
operationsPost POST /operations Create a new Operation

operationsIdGet

\YouSign\Client\Model\OperationOutput operationsIdGet($id, $authorization)

Find an Operation by ID

Example

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

$apiInstance = new YouSign\Client\Api\OperationsApi(
    // 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()
);
$id = "id_example"; // string | 
$authorization = "\"Bearer {{access_token}}\""; // string | Authentication credentials for HTTP authentication

try {
    $result = $apiInstance->operationsIdGet($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OperationsApi->operationsIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string
authorization string Authentication credentials for HTTP authentication

Return type

\YouSign\Client\Model\OperationOutput

Authorization

No authorization required

HTTP request headers

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

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

operationsPost

\YouSign\Client\Model\OperationOutput operationsPost($body, $content_type, $authorization)

Create a new Operation

Example

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

$apiInstance = new YouSign\Client\Api\OperationsApi(
    // 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()
);
$body = new \YouSign\Client\Model\Body(); // \YouSign\Client\Model\Body | 
$content_type = "\"application/json\""; // string | The MIME type of the body of the request
$authorization = "\"Bearer {{access_token}}\""; // string | Authentication credentials for HTTP authentication

try {
    $result = $apiInstance->operationsPost($body, $content_type, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OperationsApi->operationsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \YouSign\Client\Model\Body
content_type string The MIME type of the body of the request [optional]
authorization string Authentication credentials for HTTP authentication [optional]

Return type

\YouSign\Client\Model\OperationOutput

Authorization

No authorization required

HTTP request headers

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

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