README

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

API version: 2.1
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$apiInstance = new YouSign\Client\Api\AuthenticationsApi(
    // 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->authenticationsEmailIdGet($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationsApi->authenticationsEmailIdGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AuthenticationsApi	authenticationsEmailIdGet	GET /authentications/email/{id}	Find an Authentication by ID
AuthenticationsApi	authenticationsEmailIdPut	PUT /authentications/email/{id}	Update an Email Authentication
AuthenticationsApi	authenticationsInweboIdGet	GET /authentications/inwebo/{id}	Get an Authentication
AuthenticationsApi	authenticationsInweboIdPut	PUT /authentications/inwebo/{id}	Update an inwebo Authentication
AuthenticationsApi	authenticationsSmsIdGet	GET /authentications/sms/{id}	Find an Authentication by ID
AuthenticationsApi	authenticationsSmsIdPut	PUT /authentications/sms/{id}	Update an SMS Authentication
CheckDocumentApi	checkDocumentBankAccountsIdGet	GET /check-document/bank_accounts/{id}	Get informations about a bank document (RIB)
CheckDocumentApi	checkDocumentBankAccountsPost	POST /check-document/bank_accounts	Verify a bank document (RIB)
CheckDocumentApi	checkDocumentIdentitiesIdGet	GET /check-document/identities/{id}	Get informations about an identity document (passport, id cards)
CheckDocumentApi	checkDocumentIdentitiesPost	POST /check-document/identities	Verify an identity document (passport, id cards)
FileApi	filesIdDownloadGet	GET /files/{id}/download	Download a File
FileApi	filesIdDuplicatePost	POST /files/{id}/duplicate	Duplicate a File
FileApi	filesIdGet	GET /files/{id}	Find a File by ID
FileApi	filesPost	POST /files	Create a new File
FileObjectApi	fileObjectsIdDelete	DELETE /file_objects/{id}	Delete a File Object
FileObjectApi	fileObjectsIdGet	GET /file_objects/{id}	Find a File Object by ID
FileObjectApi	fileObjectsIdPut	PUT /file_objects/{id}	Update a File Object
FileObjectApi	fileObjectsPost	POST /file_objects	Create a new File Object
MembersApi	membersGet	GET /members	Get all Members
MembersApi	membersIdDelete	DELETE /members/{id}	Delete a Member
MembersApi	membersIdProofGet	GET /members/{id}/proof	Get a proof file of a Member
MembersApi	membersIdPut	PUT /members/{id}	Edit a Member
MembersApi	membersPost	POST /members	Create a new Member
OperationsApi	operationsIdGet	GET /operations/{id}	Find an Operation by ID
OperationsApi	operationsPost	POST /operations	Create a new Operation
ProceduresApi	exportProceduresGet	GET /export/procedures	Export Procedure list
ProceduresApi	proceduresGet	GET /procedures	Get Procedure list
ProceduresApi	proceduresIdDelete	DELETE /procedures/{id}	Delete a Procedure
ProceduresApi	proceduresIdDuplicatePost	POST /procedures/{id}/duplicate	Duplicate a Procedure
ProceduresApi	proceduresIdGet	GET /procedures/{id}	Find a Procedure by ID
ProceduresApi	proceduresIdProofGet	GET /procedures/{id}/proof	Get a Procedure proof file
ProceduresApi	proceduresIdPut	PUT /procedures/{id}	Update a Procedure
ProceduresApi	proceduresIdRemindPost	POST /procedures/{id}/remind	Remind a Procedure
ProceduresApi	proceduresPost	POST /procedures	Create a new Procedure
ServerStampApi	serverStampsIdGet	GET /server_stamps/{id}
ServerStampApi	serverStampsPost	POST /server_stamps
SignatureUIApi	signatureUiLabelsGet	GET /signature_ui_labels	Get Signature UI Labels
SignatureUIApi	signatureUiLabelsIdDelete	DELETE /signature_ui_labels/{id}	Delete a Signature UI Label
SignatureUIApi	signatureUiLabelsIdGet	GET /signature_ui_labels/{id}	Find a Signature UI Label by ID
SignatureUIApi	signatureUiLabelsIdPut	PUT /signature_ui_labels/{id}	Update a Signature UI Label
SignatureUIApi	signatureUiLabelsPost	POST /signature_ui_labels	Create a new Signature UI Label
SignatureUIApi	signatureUisGet	GET /signature_uis	Get Signature UI list
SignatureUIApi	signatureUisIdDelete	DELETE /signature_uis/{id}	Delete a Signature UI
SignatureUIApi	signatureUisIdGet	GET /signature_uis/{id}	Find a Signature UI by ID
SignatureUIApi	signatureUisIdPut	PUT /signature_uis/{id}	Update a Signature UI
SignatureUIApi	signatureUisPost	POST /signature_uis	Create a new Signature UI
UserApi	usersGet	GET /users	List all Users
UserApi	usersIdDelete	DELETE /users/{id}	Delete a User
UserApi	usersIdGet	GET /users/{id}	Find a User by ID
UserApi	usersIdPut	PUT /users/{id}	Update a User
UserApi	usersPost	POST /users	Create a new User on Yousign application
UserGroupApi	userGroupsGet	GET /user_groups	Get User Group list
UserGroupApi	userGroupsIdGet	GET /user_groups/{id}	Find a User Group by ID

Documentation For Models

Documentation For Authorization

ApiKey

Type: API key
API key parameter name: Authorization
Location: HTTP header

Author

support@yousign.fr

vigicorp / yousign-api

Maintainers

Details