Skip to content

Commit

Permalink
Update DOCUMENTATION
Browse files Browse the repository at this point in the history
  • Loading branch information
@webeweb
webeweb committed May 17, 2019
1 parent 1240bfd commit cb8b210
Showing 1 changed file with 43 additions and 43 deletions.
86 changes: 43 additions & 43 deletions DOCUMENTATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ DOCUMENTATION
---

```php
// Creates an authentication model.
// Create an authentication model.
$authentication = new Authentication();

// Set a couple login/password.
Expand All @@ -19,7 +19,7 @@ $authentication->setAccessToken("accessToken");
Creating an API key :

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -29,7 +29,7 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->creatingAPIKey(new CreatingAPIKeyRequest());

// Handle the response.
Expand All @@ -49,7 +49,7 @@ $response->getState();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -59,14 +59,14 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Sending SMS message model.
// Create a Sending SMS message model.
$model = new SendingSMSMessageRequest();
$model->setMessage("message")
$model->addNumero("33600000001")
$model->addNumero("33600000002")
// ...

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->sendingSMSMessage($model);

// Handle the response.
Expand All @@ -80,7 +80,7 @@ $response->getSmsID();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -90,11 +90,11 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Delivery report model.
// Create a Delivery report model.
$model = new DeliveryReportRequest();
$model->setSmsID("smsID")

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->deliveryReport($model);

// Handle the response.
Expand All @@ -111,7 +111,7 @@ foreach($response->getDeliveryReports() as $current) {
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -121,7 +121,7 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->accountBalance(new AccountBalanceRequest());

// Handle response.
Expand All @@ -135,7 +135,7 @@ $response->getAccountBalance();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -145,12 +145,12 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Creating sub-account model.
// Create a Creating sub-account model.
$model = new CreatingSubAccountRequest();
$model->setNewPseudo("pseudo");
$model->setNewPass("pass")

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->creatingSubAccount($model);

// Handle the response.
Expand All @@ -161,7 +161,7 @@ $response->getDescription();
Deleting sub-account :

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -171,11 +171,11 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Deleting sub-account model.
// Create a Deleting sub-account model.
$model = new DeletingSubAccountRequest();
$model->setPseudoToDelete("pseudoToDelete")

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->deletingSubAccount($model);

// Handle the response.
Expand All @@ -187,7 +187,7 @@ $response->getDescription();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -197,12 +197,12 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Transferring credits model.
// Create a Transferring credits model.
$model = new TransferringCreditsRequest();
$model->setCreditAmount(212);
$model->setTargetPseudo("targetPseudo");

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->transferringCredits($model);

// Handle the response.
Expand All @@ -214,7 +214,7 @@ $response->getDescription();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -224,12 +224,12 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates an Adding contact model.
// Create an Adding contact model.
$model = new AddingContactRequest();
$model->setNom("lastname");
$model->setMobile("33600000000")

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->addingContact($model);

// Handle the response.
Expand All @@ -241,7 +241,7 @@ $response->getDescription();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -251,11 +251,11 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Deleting SMS model.
// Create a Deleting SMS model.
$model = new DeletingSMSRequest();
$model->setSmsID("smsID")

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->deletingSMS($model);

// Handle the response.
Expand All @@ -267,7 +267,7 @@ $response->getDescription();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -277,7 +277,7 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->sentSMSMessageList(new SentSMSMessageListRequest());

// Handle response.
Expand All @@ -298,7 +298,7 @@ foreach($response->getSentSMSMessages() as $current) {
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -308,11 +308,11 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Checking SMS message status model.
// Create a Checking SMS message status model.
$model = new CheckingSMSMessageStatusRequest();
$model->setSmsID("smsID")

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->checkingSMSMessageStatus($model);

// Handle the response.
Expand All @@ -324,7 +324,7 @@ $response->getDescription();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -334,7 +334,7 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Retrieving SMS reply model.
// Create a Retrieving SMS reply model.
$model = new RetrievingSMSReplyRequest();
$model->setStart(0);
$model->setOffset(10);
Expand All @@ -343,7 +343,7 @@ $model->setOffset(10);
// $model->setStartDate(new DateTime("2017-09-14 00:00:00"));
// $model->setEndDate(new DateTime("2017-09-15 00:00:00"));

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->retrievingSMSReply($model);

// Handle the response.
Expand All @@ -364,7 +364,7 @@ foreach($response->getSMSReplies() as $current) {
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -374,14 +374,14 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Sending text-to-speech SMS model.
// Create a Sending text-to-speech SMS model.
$model = new SendingTextToSpeechSMSRequest();
$model->setMessage("message")
$model->addNumero("33600000001")
$model->addNumero("33600000002")
// ...

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->sendingTextToSpeechSMS($model);

// Handle the response.
Expand All @@ -395,7 +395,7 @@ $response->getSmsID();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -405,14 +405,14 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Sending unicode SMS model.
// Create a Sending unicode SMS model.
$model = new SendingUnicodeSMSRequest();
$model->setMessage("message")
$model->addNumero("33600000001")
$model->addNumero("33600000002")
// ...

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->sendingUnicodeSMS($model);

// Handle the response.
Expand All @@ -426,7 +426,7 @@ $response->getSmsID();
---

```php
// Creates the API provider.
// Create the API provider.
$provider = new APIProvider(new Authentication());

// Set a couple login/password.
Expand All @@ -436,11 +436,11 @@ $provider->getAuthentication()->setPass("pass");
// or use an access token.
// $provider->getAuthentication()->setAccessToken("accessToken");

// Creates a Sending SMS batch model.
// Create a Sending SMS batch model.
$model = new SendingSMSBatchRequest();
$model->setFichier("fichier.csv")

// Calls the API and get the response.
// Call the API and get the response.
$response = $provider->sendingSMSBatch($model);

// Handle the response.
Expand Down

0 comments on commit cb8b210

Please sign in to comment.