README

API pour envoyer et suivre des Lettres Recommandées En Ligne distribuées par le facteur

Elle comprend les fonctions clés pour :

créer un envoi,
ajouter des documents et des destinataires,
choisir ses options,
suivre la production.

Pour connaître les notifications (webhooks) concernées par cette API, consultez la documentation de l'API notification_center.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, run the following:

composer require jp10/maileva-registered-sdk

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure OAuth2 access token for authorization: oAuth2PasswordProduction
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oAuth2PasswordSandbox
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

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


$apiInstance = new OpenAPI\Client\Api\DestinatairesApi(
    // 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
);
$sending_id = 'sending_id_example'; // string | Identifiant d'un envoi
$recipient_creation = new \OpenAPI\Client\Model\RecipientCreation(); // \OpenAPI\Client\Model\RecipientCreation

try {
    $result = $apiInstance->createRecipientOfSending($sending_id, $recipient_creation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DestinatairesApi->createRecipientOfSending: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.sandbox.maileva.net/registered_mail/v4

Class	Method	HTTP request	Description
DestinatairesApi	createRecipientOfSending	POST /sendings/{sending_id}/recipients	Ajout d'un destinataire à l'envoi
DestinatairesApi	deleteAllRecipientsOfSending	DELETE /sendings/{sending_id}/recipients	Suppression de tous les destinataires
DestinatairesApi	deleteRecipientOfSending	DELETE /sendings/{sending_id}/recipients/{recipient_id}	Suppression d'un destinataire
DestinatairesApi	downloadAcknowledgementOfReceiptOfRecipientOfSending	GET /sendings/{sending_id}/recipients/{recipient_id}/download_acknowledgement_of_receipt	Télécharger l'avis de réception archivé du destinataire
DestinatairesApi	downloadArchivedUndeliveredMailOfRecipientOfSending	GET /sendings/{sending_id}/recipients/{recipient_id}/download_undelivered_mail	Téléchargement de l'image du pli retourné
DestinatairesApi	downloadContentProofOfRecipientOfSending	GET /sendings/{sending_id}/recipients/{recipient_id}/download_content_proof	Télécharger la preuve de contenu du destinataire
DestinatairesApi	downloadDepositProofOfRecipientOfSending	GET /sendings/{sending_id}/recipients/{recipient_id}/download_deposit_proof	Télécharger la preuve de dépôt du destinataire
DestinatairesApi	downloadEmbeddedDocumentOfRecipientOfSending	GET /sendings/{sending_id}/recipients/{recipient_id}/content_proof/download_embedded_document	Télécharger le document contenu dans la preuve de contenu
DestinatairesApi	getAllRecipientsOfSending	GET /sendings/{sending_id}/recipients	Liste des destinataires d'un envoi
DestinatairesApi	getRecipientOfSending	GET /sendings/{sending_id}/recipients/{recipient_id}	Détail d'un destinataire
DestinatairesApi	patchRecipientOfSending	PATCH /sendings/{sending_id}/recipients/{recipient_id}	Modification partielle d'un destinataire
DocumentsApi	deleteDocumentOfSending	DELETE /sendings/{sending_id}/documents/{document_id}	Suppression d'un document
DocumentsApi	getAllDocumentsOfSending	GET /sendings/{sending_id}/documents	Liste des documents d'un envoi
DocumentsApi	getDocumentOfSending	GET /sendings/{sending_id}/documents/{document_id}	Détail d'un document
DocumentsApi	postDocumentOfSending	POST /sendings/{sending_id}/documents	Ajout d'un document à l'envoi.
DocumentsApi	setDocumentPriorityOfSending	POST /sendings/{sending_id}/documents/{document_id}/set_priority	Classement des documents
EnvoiApi	deleteSending	DELETE /sendings/{sending_id}	Suppression d'un envoi
EnvoiApi	getAllSendings	GET /sendings	Liste des envois
EnvoiApi	getSending	GET /sendings/{sending_id}	Détail d'un envoi
EnvoiApi	postSending	POST /sendings	Création d'un envoi
EnvoiApi	submitSending	POST /sendings/{sending_id}/submit	Finalisation d'un envoi
EnvoiApi	updateSending	PATCH /sendings/{sending_id}	Modification partielle d'un envoi
PreuveDeDptGlobaleApi	downloadGlobalDepositProof	GET /global_deposit_proofs/{global_deposit_proof_id}/download	Télécharger une preuve de dépôt globale
PreuveDeDptGlobaleApi	getAllGlobalDepositProofs	GET /global_deposit_proofs	Liste des preuves de dépôt globales
PreuveDeDptGlobaleApi	getGlobalDepositProof	GET /global_deposit_proofs/{global_deposit_proof_id}	Détail d'une preuve de dépôt globale

Models

Authorization

Authentication schemes defined for the API:

bearerAuth

Type: Bearer authentication (JWT)

oAuth2PasswordProduction

Type: OAuth
Flow: password
Authorization URL: ``
Scopes:
- all: CRUD on resources

oAuth2PasswordSandbox

Type: OAuth
Flow: password
Authorization URL: ``
Scopes:
- all: CRUD on resources

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 4.4
Build package: org.openapitools.codegen.languages.PhpClientCodegen

jp10 / maileva-registered-sdk

Maintainers

Details