From 14732d3936de790253e09daea8c65e8cc083df62 Mon Sep 17 00:00:00 2001 From: ekta-slt Date: Thu, 18 Jan 2018 15:10:29 +0530 Subject: [PATCH] Mixed spec updates --- README.md | 22 +- docs/Api/ContactsApi.md | 8 +- docs/Api/EmailCampaignsApi.md | 20 +- docs/Api/ListsApi.md | 4 +- docs/Api/SMSCampaignsApi.md | 138 ++++----- docs/Model/CreateContact.md | 1 + docs/Model/CreateEmailCampaign.md | 4 +- docs/Model/CreateSmsCampaign.md | 2 +- docs/Model/CreateSmtpTemplate.md | 2 +- docs/Model/GetCampaignRecipients.md | 4 +- .../GetCampaignRecipientsExclusionLists.md | 11 - docs/Model/GetCampaignRecipientsLists.md | 11 - docs/Model/GetReportsReports.md | 1 - docs/Model/GetSmsEventReportEvents.md | 4 +- docs/Model/GetTransacSmsReportReports.md | 1 - docs/Model/RequestSMSRecipientExport.md | 2 +- docs/Model/SendEmail.md | 4 +- docs/Model/SendSmtpEmail.md | 2 +- docs/Model/UpdateContact.md | 1 + docs/Model/UpdateEmailCampaign.md | 4 +- docs/Model/UpdateSmsCampaign.md | 2 +- docs/Model/UpdateSmtpTemplate.md | 2 +- lib/Api/ContactsApi.php | 8 +- lib/Api/EmailCampaignsApi.php | 26 +- lib/Api/ListsApi.php | 4 +- lib/Api/SMSCampaignsApi.php | 288 +++++++++--------- lib/Model/CreateContact.php | 37 ++- lib/Model/CreateEmailCampaign.php | 4 +- lib/Model/CreateSmsCampaign.php | 2 +- lib/Model/CreateSmtpTemplate.php | 2 +- lib/Model/GetCampaignRecipients.php | 16 +- .../GetCampaignRecipientsExclusionLists.php | 281 ----------------- lib/Model/GetCampaignRecipientsLists.php | 281 ----------------- lib/Model/GetReportsReports.php | 33 -- lib/Model/GetSmsEventReportEvents.php | 12 - lib/Model/GetTransacSmsReportReports.php | 33 -- lib/Model/RequestSMSRecipientExport.php | 8 +- lib/Model/SendEmail.php | 4 +- lib/Model/SendSmtpEmail.php | 2 +- lib/Model/UpdateContact.php | 37 ++- lib/Model/UpdateEmailCampaign.php | 4 +- lib/Model/UpdateSmsCampaign.php | 2 +- lib/Model/UpdateSmtpTemplate.php | 2 +- test/Api/EmailCampaignsApiTest.php | 8 +- test/Api/SMSCampaignsApiTest.php | 44 +-- test/Model/CreateContactTest.php | 7 + ...etCampaignRecipientsExclusionListsTest.php | 93 ------ test/Model/GetCampaignRecipientsListsTest.php | 93 ------ test/Model/GetReportsReportsTest.php | 7 - test/Model/GetTransacSmsReportReportsTest.php | 7 - test/Model/RequestSMSRecipientExportTest.php | 12 +- test/Model/UpdateContactTest.php | 7 + 52 files changed, 409 insertions(+), 1205 deletions(-) delete mode 100644 docs/Model/GetCampaignRecipientsExclusionLists.md delete mode 100644 docs/Model/GetCampaignRecipientsLists.md delete mode 100644 lib/Model/GetCampaignRecipientsExclusionLists.php delete mode 100644 lib/Model/GetCampaignRecipientsLists.php delete mode 100644 test/Model/GetCampaignRecipientsExclusionListsTest.php delete mode 100644 test/Model/GetCampaignRecipientsListsTest.php diff --git a/README.md b/README.md index 06aaae2a..b6e4417d 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Class | Method | HTTP request | Description *ContactsApi* | [**updateFolder**](docs/Api/ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a contact folder *ContactsApi* | [**updateList**](docs/Api/ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list *EmailCampaignsApi* | [**createEmailCampaign**](docs/Api/EmailCampaignsApi.md#createemailcampaign) | **POST** /emailCampaigns | Create an email campaign -*EmailCampaignsApi* | [**deleteEmailCampaigns**](docs/Api/EmailCampaignsApi.md#deleteemailcampaigns) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign +*EmailCampaignsApi* | [**deleteEmailCampaign**](docs/Api/EmailCampaignsApi.md#deleteemailcampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign *EmailCampaignsApi* | [**emailExportRecipients**](docs/Api/EmailCampaignsApi.md#emailexportrecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign *EmailCampaignsApi* | [**getEmailCampaign**](docs/Api/EmailCampaignsApi.md#getemailcampaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations *EmailCampaignsApi* | [**getEmailCampaigns**](docs/Api/EmailCampaignsApi.md#getemailcampaigns) | **GET** /emailCampaigns | Return all your created campaigns @@ -124,7 +124,7 @@ Class | Method | HTTP request | Description *EmailCampaignsApi* | [**sendReport**](docs/Api/EmailCampaignsApi.md#sendreport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns *EmailCampaignsApi* | [**sendTestEmail**](docs/Api/EmailCampaignsApi.md#sendtestemail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list *EmailCampaignsApi* | [**updateCampaignStatus**](docs/Api/EmailCampaignsApi.md#updatecampaignstatus) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status -*EmailCampaignsApi* | [**updateEmailCampaigns**](docs/Api/EmailCampaignsApi.md#updateemailcampaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign +*EmailCampaignsApi* | [**updateEmailCampaign**](docs/Api/EmailCampaignsApi.md#updateemailcampaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign *FoldersApi* | [**createFolder**](docs/Api/FoldersApi.md#createfolder) | **POST** /contacts/folders | Create a folder *FoldersApi* | [**deleteFolder**](docs/Api/FoldersApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists) *FoldersApi* | [**getFolder**](docs/Api/FoldersApi.md#getfolder) | **GET** /contacts/folders/{folderId} | Returns folder details @@ -151,16 +151,16 @@ Class | Method | HTTP request | Description *ResellerApi* | [**getResellerChilds**](docs/Api/ResellerApi.md#getresellerchilds) | **GET** /reseller/children | Gets the list of all reseller's children accounts *ResellerApi* | [**removeCredits**](docs/Api/ResellerApi.md#removecredits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account *ResellerApi* | [**updateResellerChild**](docs/Api/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied -*SMSCampaignsApi* | [**createSMSCampaign**](docs/Api/SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an SMS campaign -*SMSCampaignsApi* | [**deleteSMSCampaigns**](docs/Api/SMSCampaignsApi.md#deletesmscampaigns) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign -*SMSCampaignsApi* | [**getSMSCampaigns**](docs/Api/SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns +*SMSCampaignsApi* | [**createSmsCampaign**](docs/Api/SMSCampaignsApi.md#createsmscampaign) | **POST** /smsCampaigns | Creates an SMS campaign +*SMSCampaignsApi* | [**deleteSmsCampaign**](docs/Api/SMSCampaignsApi.md#deletesmscampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign *SMSCampaignsApi* | [**getSmsCampaign**](docs/Api/SMSCampaignsApi.md#getsmscampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign -*SMSCampaignsApi* | [**requestSMSRecipientExport**](docs/Api/SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign. -*SMSCampaignsApi* | [**sendSMSCampaignNow**](docs/Api/SMSCampaignsApi.md#sendsmscampaignnow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately -*SMSCampaignsApi* | [**sendSMSReport**](docs/Api/SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns +*SMSCampaignsApi* | [**getSmsCampaigns**](docs/Api/SMSCampaignsApi.md#getsmscampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns +*SMSCampaignsApi* | [**requestSmsRecipientExport**](docs/Api/SMSCampaignsApi.md#requestsmsrecipientexport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign. +*SMSCampaignsApi* | [**sendSmsCampaignNow**](docs/Api/SMSCampaignsApi.md#sendsmscampaignnow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately +*SMSCampaignsApi* | [**sendSmsReport**](docs/Api/SMSCampaignsApi.md#sendsmsreport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns *SMSCampaignsApi* | [**sendTestSms**](docs/Api/SMSCampaignsApi.md#sendtestsms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS -*SMSCampaignsApi* | [**updateSMSCampaignStatus**](docs/Api/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status *SMSCampaignsApi* | [**updateSmsCampaign**](docs/Api/SMSCampaignsApi.md#updatesmscampaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign +*SMSCampaignsApi* | [**updateSmsCampaignStatus**](docs/Api/SMSCampaignsApi.md#updatesmscampaignstatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status *SMTPApi* | [**createSmtpTemplate**](docs/Api/SMTPApi.md#createsmtptemplate) | **POST** /smtp/templates | Create an smtp template *SMTPApi* | [**deleteHardbounces**](docs/Api/SMTPApi.md#deletehardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces *SMTPApi* | [**deleteSmtpTemplate**](docs/Api/SMTPApi.md#deletesmtptemplate) | **DELETE** /smtp/templates/{templateId} | Delete an inactive smtp template @@ -227,8 +227,6 @@ Class | Method | HTTP request | Description - [GetAttributesEnumeration](docs/Model/GetAttributesEnumeration.md) - [GetCampaignOverview](docs/Model/GetCampaignOverview.md) - [GetCampaignRecipients](docs/Model/GetCampaignRecipients.md) - - [GetCampaignRecipientsExclusionLists](docs/Model/GetCampaignRecipientsExclusionLists.md) - - [GetCampaignRecipientsLists](docs/Model/GetCampaignRecipientsLists.md) - [GetCampaignStats](docs/Model/GetCampaignStats.md) - [GetChildInfoApiKeys](docs/Model/GetChildInfoApiKeys.md) - [GetChildInfoCredits](docs/Model/GetChildInfoCredits.md) @@ -301,7 +299,7 @@ Class | Method | HTTP request | Description - [RequestContactExport](docs/Model/RequestContactExport.md) - [RequestContactImport](docs/Model/RequestContactImport.md) - [RequestContactImportNewList](docs/Model/RequestContactImportNewList.md) - - [RequestSMSRecipientExport](docs/Model/RequestSMSRecipientExport.md) + - [RequestSmsRecipientExport](docs/Model/RequestSmsRecipientExport.md) - [SendEmail](docs/Model/SendEmail.md) - [SendEmailAttachment](docs/Model/SendEmailAttachment.md) - [SendReport](docs/Model/SendReport.md) diff --git a/docs/Api/ContactsApi.md b/docs/Api/ContactsApi.md index db364e87..e17e1b13 100644 --- a/docs/Api/ContactsApi.md +++ b/docs/Api/ContactsApi.md @@ -577,7 +577,7 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', $api_instance = new SendinBlue\Client\Api\ContactsApi(); $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page -$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) +$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. try { $result = $api_instance->getContacts($limit, $offset, $modifiedSince); @@ -594,7 +594,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] - **modifiedSince** | **\DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] + **modifiedSince** | **\DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] ### Return type @@ -628,7 +628,7 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', $api_instance = new SendinBlue\Client\Api\ContactsApi(); $listId = 789; // int | Id of the list -$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) +$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page @@ -646,7 +646,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | - **modifiedSince** | **\DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] + **modifiedSince** | **\DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] diff --git a/docs/Api/EmailCampaignsApi.md b/docs/Api/EmailCampaignsApi.md index 9e8746ff..05d10645 100644 --- a/docs/Api/EmailCampaignsApi.md +++ b/docs/Api/EmailCampaignsApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**createEmailCampaign**](EmailCampaignsApi.md#createEmailCampaign) | **POST** /emailCampaigns | Create an email campaign -[**deleteEmailCampaigns**](EmailCampaignsApi.md#deleteEmailCampaigns) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign +[**deleteEmailCampaign**](EmailCampaignsApi.md#deleteEmailCampaign) | **DELETE** /emailCampaigns/{campaignId} | Delete an email campaign [**emailExportRecipients**](EmailCampaignsApi.md#emailExportRecipients) | **POST** /emailCampaigns/{campaignId}/exportRecipients | Export the recipients of a campaign [**getEmailCampaign**](EmailCampaignsApi.md#getEmailCampaign) | **GET** /emailCampaigns/{campaignId} | Get campaign informations [**getEmailCampaigns**](EmailCampaignsApi.md#getEmailCampaigns) | **GET** /emailCampaigns | Return all your created campaigns @@ -13,7 +13,7 @@ Method | HTTP request | Description [**sendReport**](EmailCampaignsApi.md#sendReport) | **POST** /emailCampaigns/{campaignId}/sendReport | Send the report of a campaigns [**sendTestEmail**](EmailCampaignsApi.md#sendTestEmail) | **POST** /emailCampaigns/{campaignId}/sendTest | Send an email campaign to your test list [**updateCampaignStatus**](EmailCampaignsApi.md#updateCampaignStatus) | **PUT** /emailCampaigns/{campaignId}/status | Update a campaign status -[**updateEmailCampaigns**](EmailCampaignsApi.md#updateEmailCampaigns) | **PUT** /emailCampaigns/{campaignId} | Update a campaign +[**updateEmailCampaign**](EmailCampaignsApi.md#updateEmailCampaign) | **PUT** /emailCampaigns/{campaignId} | Update a campaign # **createEmailCampaign** @@ -64,8 +64,8 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **deleteEmailCampaigns** -> deleteEmailCampaigns($campaignId) +# **deleteEmailCampaign** +> deleteEmailCampaign($campaignId) Delete an email campaign @@ -83,9 +83,9 @@ $api_instance = new SendinBlue\Client\Api\EmailCampaignsApi(); $campaignId = 789; // int | id of the campaign try { - $api_instance->deleteEmailCampaigns($campaignId); + $api_instance->deleteEmailCampaign($campaignId); } catch (Exception $e) { - echo 'Exception when calling EmailCampaignsApi->deleteEmailCampaigns: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling EmailCampaignsApi->deleteEmailCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -459,8 +459,8 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **updateEmailCampaigns** -> updateEmailCampaigns($campaignId, $emailCampaign) +# **updateEmailCampaign** +> updateEmailCampaign($campaignId, $emailCampaign) Update a campaign @@ -479,9 +479,9 @@ $campaignId = 789; // int | Id of the campaign $emailCampaign = new \SendinBlue\Client\Model\UpdateEmailCampaign(); // \SendinBlue\Client\Model\UpdateEmailCampaign | Values to update a campaign try { - $api_instance->updateEmailCampaigns($campaignId, $emailCampaign); + $api_instance->updateEmailCampaign($campaignId, $emailCampaign); } catch (Exception $e) { - echo 'Exception when calling EmailCampaignsApi->updateEmailCampaigns: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling EmailCampaignsApi->updateEmailCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` diff --git a/docs/Api/ListsApi.md b/docs/Api/ListsApi.md index 4c4d7120..6ce5fcb9 100644 --- a/docs/Api/ListsApi.md +++ b/docs/Api/ListsApi.md @@ -177,7 +177,7 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', $api_instance = new SendinBlue\Client\Api\ListsApi(); $listId = 789; // int | Id of the list -$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) +$modifiedSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. $limit = 50; // int | Number of documents per page $offset = 0; // int | Index of the first document of the page @@ -195,7 +195,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **listId** | **int**| Id of the list | - **modifiedSince** | **\DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] + **modifiedSince** | **\DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **limit** | **int**| Number of documents per page | [optional] [default to 50] **offset** | **int**| Index of the first document of the page | [optional] [default to 0] diff --git a/docs/Api/SMSCampaignsApi.md b/docs/Api/SMSCampaignsApi.md index 36c1ef7f..585aa9b0 100644 --- a/docs/Api/SMSCampaignsApi.md +++ b/docs/Api/SMSCampaignsApi.md @@ -4,20 +4,20 @@ All URIs are relative to *https://api.sendinblue.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**createSMSCampaign**](SMSCampaignsApi.md#createSMSCampaign) | **POST** /smsCampaigns | Creates an SMS campaign -[**deleteSMSCampaigns**](SMSCampaignsApi.md#deleteSMSCampaigns) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign -[**getSMSCampaigns**](SMSCampaignsApi.md#getSMSCampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns +[**createSmsCampaign**](SMSCampaignsApi.md#createSmsCampaign) | **POST** /smsCampaigns | Creates an SMS campaign +[**deleteSmsCampaign**](SMSCampaignsApi.md#deleteSmsCampaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign [**getSmsCampaign**](SMSCampaignsApi.md#getSmsCampaign) | **GET** /smsCampaigns/{campaignId} | Get an SMS campaign -[**requestSMSRecipientExport**](SMSCampaignsApi.md#requestSMSRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign. -[**sendSMSCampaignNow**](SMSCampaignsApi.md#sendSMSCampaignNow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately -[**sendSMSReport**](SMSCampaignsApi.md#sendSMSReport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns +[**getSmsCampaigns**](SMSCampaignsApi.md#getSmsCampaigns) | **GET** /smsCampaigns | Returns the informations for all your created SMS campaigns +[**requestSmsRecipientExport**](SMSCampaignsApi.md#requestSmsRecipientExport) | **POST** /smsCampaigns/{campaignId}/exportRecipients | Exports the recipients of the specified campaign. +[**sendSmsCampaignNow**](SMSCampaignsApi.md#sendSmsCampaignNow) | **POST** /smsCampaigns/{campaignId}/sendNow | Send your SMS campaign immediately +[**sendSmsReport**](SMSCampaignsApi.md#sendSmsReport) | **POST** /smsCampaigns/{campaignId}/sendReport | Send report of SMS campaigns [**sendTestSms**](SMSCampaignsApi.md#sendTestSms) | **POST** /smsCampaigns/{campaignId}/sendTest | Send an SMS -[**updateSMSCampaignStatus**](SMSCampaignsApi.md#updateSMSCampaignStatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status [**updateSmsCampaign**](SMSCampaignsApi.md#updateSmsCampaign) | **PUT** /smsCampaigns/{campaignId} | Updates an SMS campaign +[**updateSmsCampaignStatus**](SMSCampaignsApi.md#updateSmsCampaignStatus) | **PUT** /smsCampaigns/{campaignId}/status | Update the campaign status -# **createSMSCampaign** -> \SendinBlue\Client\Model\CreateModel createSMSCampaign($createSmsCampaign) +# **createSmsCampaign** +> \SendinBlue\Client\Model\CreateModel createSmsCampaign($createSmsCampaign) Creates an SMS campaign @@ -35,10 +35,10 @@ $api_instance = new SendinBlue\Client\Api\SMSCampaignsApi(); $createSmsCampaign = new \SendinBlue\Client\Model\CreateSmsCampaign(); // \SendinBlue\Client\Model\CreateSmsCampaign | Values to create an SMS Campaign try { - $result = $api_instance->createSMSCampaign($createSmsCampaign); + $result = $api_instance->createSmsCampaign($createSmsCampaign); print_r($result); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->createSMSCampaign: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->createSmsCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -64,8 +64,8 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **deleteSMSCampaigns** -> deleteSMSCampaigns($campaignId) +# **deleteSmsCampaign** +> deleteSmsCampaign($campaignId) Delete the SMS campaign @@ -83,9 +83,9 @@ $api_instance = new SendinBlue\Client\Api\SMSCampaignsApi(); $campaignId = 789; // int | id of the SMS campaign try { - $api_instance->deleteSMSCampaigns($campaignId); + $api_instance->deleteSmsCampaign($campaignId); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->deleteSMSCampaigns: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->deleteSmsCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -111,10 +111,10 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **getSMSCampaigns** -> \SendinBlue\Client\Model\GetSmsCampaigns getSMSCampaigns($status, $limit, $offset) +# **getSmsCampaign** +> \SendinBlue\Client\Model\GetSmsCampaign getSmsCampaign($campaignId, $getSmsCampaign) -Returns the informations for all your created SMS campaigns +Get an SMS campaign ### Example ```php @@ -127,15 +127,14 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', // SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); $api_instance = new SendinBlue\Client\Api\SMSCampaignsApi(); -$status = "status_example"; // string | Status of campaign. -$limit = 500; // int | Number limitation for the result returned -$offset = 0; // int | Beginning point in the list to retrieve from. +$campaignId = 789; // int | id of the SMS campaign +$getSmsCampaign = new \SendinBlue\Client\Model\GetSmsCampaign(); // \SendinBlue\Client\Model\GetSmsCampaign | Values to update an SMS Campaign try { - $result = $api_instance->getSMSCampaigns($status, $limit, $offset); + $result = $api_instance->getSmsCampaign($campaignId, $getSmsCampaign); print_r($result); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->getSMSCampaigns: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->getSmsCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -144,13 +143,12 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **string**| Status of campaign. | [optional] - **limit** | **int**| Number limitation for the result returned | [optional] [default to 500] - **offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0] + **campaignId** | **int**| id of the SMS campaign | + **getSmsCampaign** | [**\SendinBlue\Client\Model\GetSmsCampaign**](../Model/GetSmsCampaign.md)| Values to update an SMS Campaign | ### Return type -[**\SendinBlue\Client\Model\GetSmsCampaigns**](../Model/GetSmsCampaigns.md) +[**\SendinBlue\Client\Model\GetSmsCampaign**](../Model/GetSmsCampaign.md) ### Authorization @@ -163,10 +161,10 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **getSmsCampaign** -> \SendinBlue\Client\Model\GetSmsCampaign getSmsCampaign($campaignId, $getSmsCampaign) +# **getSmsCampaigns** +> \SendinBlue\Client\Model\GetSmsCampaigns getSmsCampaigns($status, $limit, $offset) -Get an SMS campaign +Returns the informations for all your created SMS campaigns ### Example ```php @@ -179,14 +177,15 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', // SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); $api_instance = new SendinBlue\Client\Api\SMSCampaignsApi(); -$campaignId = 789; // int | id of the SMS campaign -$getSmsCampaign = new \SendinBlue\Client\Model\GetSmsCampaign(); // \SendinBlue\Client\Model\GetSmsCampaign | Values to update an SMS Campaign +$status = "status_example"; // string | Status of campaign. +$limit = 500; // int | Number limitation for the result returned +$offset = 0; // int | Beginning point in the list to retrieve from. try { - $result = $api_instance->getSmsCampaign($campaignId, $getSmsCampaign); + $result = $api_instance->getSmsCampaigns($status, $limit, $offset); print_r($result); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->getSmsCampaign: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->getSmsCampaigns: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -195,12 +194,13 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **campaignId** | **int**| id of the SMS campaign | - **getSmsCampaign** | [**\SendinBlue\Client\Model\GetSmsCampaign**](../Model/GetSmsCampaign.md)| Values to update an SMS Campaign | + **status** | **string**| Status of campaign. | [optional] + **limit** | **int**| Number limitation for the result returned | [optional] [default to 500] + **offset** | **int**| Beginning point in the list to retrieve from. | [optional] [default to 0] ### Return type -[**\SendinBlue\Client\Model\GetSmsCampaign**](../Model/GetSmsCampaign.md) +[**\SendinBlue\Client\Model\GetSmsCampaigns**](../Model/GetSmsCampaigns.md) ### Authorization @@ -213,8 +213,8 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **requestSMSRecipientExport** -> \SendinBlue\Client\Model\CreatedProcessId requestSMSRecipientExport($campaignId, $recipientExport) +# **requestSmsRecipientExport** +> \SendinBlue\Client\Model\CreatedProcessId requestSmsRecipientExport($campaignId, $recipientExport) Exports the recipients of the specified campaign. @@ -232,13 +232,13 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', $api_instance = new SendinBlue\Client\Api\SMSCampaignsApi(); $campaignId = 789; // int | id of the campaign -$recipientExport = new \SendinBlue\Client\Model\RequestSMSRecipientExport(); // \SendinBlue\Client\Model\RequestSMSRecipientExport | Values to send for a recipient export request +$recipientExport = new \SendinBlue\Client\Model\RequestSmsRecipientExport(); // \SendinBlue\Client\Model\RequestSmsRecipientExport | Values to send for a recipient export request try { - $result = $api_instance->requestSMSRecipientExport($campaignId, $recipientExport); + $result = $api_instance->requestSmsRecipientExport($campaignId, $recipientExport); print_r($result); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->requestSMSRecipientExport: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->requestSmsRecipientExport: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -248,7 +248,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **int**| id of the campaign | - **recipientExport** | [**\SendinBlue\Client\Model\RequestSMSRecipientExport**](../Model/RequestSMSRecipientExport.md)| Values to send for a recipient export request | [optional] + **recipientExport** | [**\SendinBlue\Client\Model\RequestSmsRecipientExport**](../Model/RequestSmsRecipientExport.md)| Values to send for a recipient export request | [optional] ### Return type @@ -265,8 +265,8 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **sendSMSCampaignNow** -> sendSMSCampaignNow($campaignId) +# **sendSmsCampaignNow** +> sendSmsCampaignNow($campaignId) Send your SMS campaign immediately @@ -284,9 +284,9 @@ $api_instance = new SendinBlue\Client\Api\SMSCampaignsApi(); $campaignId = 789; // int | id of the campaign try { - $api_instance->sendSMSCampaignNow($campaignId); + $api_instance->sendSmsCampaignNow($campaignId); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->sendSMSCampaignNow: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->sendSmsCampaignNow: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -312,8 +312,8 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **sendSMSReport** -> sendSMSReport($campaignId, $sendReport) +# **sendSmsReport** +> sendSmsReport($campaignId, $sendReport) Send report of SMS campaigns @@ -334,9 +334,9 @@ $campaignId = 789; // int | id of the campaign $sendReport = new \SendinBlue\Client\Model\SendReport(); // \SendinBlue\Client\Model\SendReport | Values for send a report try { - $api_instance->sendSMSReport($campaignId, $sendReport); + $api_instance->sendSmsReport($campaignId, $sendReport); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->sendSMSReport: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->sendSmsReport: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -412,10 +412,10 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **updateSMSCampaignStatus** -> updateSMSCampaignStatus($campaignId, $status) +# **updateSmsCampaign** +> updateSmsCampaign($campaignId, $updateSmsCampaign) -Update the campaign status +Updates an SMS campaign ### Example ```php @@ -428,13 +428,13 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', // SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); $api_instance = new SendinBlue\Client\Api\SMSCampaignsApi(); -$campaignId = 789; // int | id of the campaign -$status = new \SendinBlue\Client\Model\UpdateCampaignStatus(); // \SendinBlue\Client\Model\UpdateCampaignStatus | Status of the campaign. +$campaignId = 789; // int | id of the SMS campaign +$updateSmsCampaign = new \SendinBlue\Client\Model\UpdateSmsCampaign(); // \SendinBlue\Client\Model\UpdateSmsCampaign | Values to update an SMS Campaign try { - $api_instance->updateSMSCampaignStatus($campaignId, $status); + $api_instance->updateSmsCampaign($campaignId, $updateSmsCampaign); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->updateSMSCampaignStatus: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->updateSmsCampaign: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -443,8 +443,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **campaignId** | **int**| id of the campaign | - **status** | [**\SendinBlue\Client\Model\UpdateCampaignStatus**](../Model/UpdateCampaignStatus.md)| Status of the campaign. | + **campaignId** | **int**| id of the SMS campaign | + **updateSmsCampaign** | [**\SendinBlue\Client\Model\UpdateSmsCampaign**](../Model/UpdateSmsCampaign.md)| Values to update an SMS Campaign | ### Return type @@ -461,10 +461,10 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) -# **updateSmsCampaign** -> updateSmsCampaign($campaignId, $updateSmsCampaign) +# **updateSmsCampaignStatus** +> updateSmsCampaignStatus($campaignId, $status) -Updates an SMS campaign +Update the campaign status ### Example ```php @@ -477,13 +477,13 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', // SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); $api_instance = new SendinBlue\Client\Api\SMSCampaignsApi(); -$campaignId = 789; // int | id of the SMS campaign -$updateSmsCampaign = new \SendinBlue\Client\Model\UpdateSmsCampaign(); // \SendinBlue\Client\Model\UpdateSmsCampaign | Values to update an SMS Campaign +$campaignId = 789; // int | id of the campaign +$status = new \SendinBlue\Client\Model\UpdateCampaignStatus(); // \SendinBlue\Client\Model\UpdateCampaignStatus | Status of the campaign. try { - $api_instance->updateSmsCampaign($campaignId, $updateSmsCampaign); + $api_instance->updateSmsCampaignStatus($campaignId, $status); } catch (Exception $e) { - echo 'Exception when calling SMSCampaignsApi->updateSmsCampaign: ', $e->getMessage(), PHP_EOL; + echo 'Exception when calling SMSCampaignsApi->updateSmsCampaignStatus: ', $e->getMessage(), PHP_EOL; } ?> ``` @@ -492,8 +492,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **campaignId** | **int**| id of the SMS campaign | - **updateSmsCampaign** | [**\SendinBlue\Client\Model\UpdateSmsCampaign**](../Model/UpdateSmsCampaign.md)| Values to update an SMS Campaign | + **campaignId** | **int**| id of the campaign | + **status** | [**\SendinBlue\Client\Model\UpdateCampaignStatus**](../Model/UpdateCampaignStatus.md)| Status of the campaign. | ### Return type diff --git a/docs/Model/CreateContact.md b/docs/Model/CreateContact.md index 9ed35ad9..645e6029 100644 --- a/docs/Model/CreateContact.md +++ b/docs/Model/CreateContact.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **smsBlacklisted** | **bool** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional] **listIds** | **int[]** | Ids of the lists to add the contact to | [optional] **updateEnabled** | **bool** | Facilitate to update existing contact in same request (updateEnabled = true) | [optional] [default to false] +**smtpBlacklistSender** | **string[]** | SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/CreateEmailCampaign.md b/docs/Model/CreateEmailCampaign.md index 669262ba..6df5ef14 100644 --- a/docs/Model/CreateEmailCampaign.md +++ b/docs/Model/CreateEmailCampaign.md @@ -8,12 +8,12 @@ Name | Type | Description | Notes **name** | **string** | Name of the campaign | **htmlContent** | **string** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional] **htmlUrl** | **string** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional] -**scheduledAt** | **\DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] +**scheduledAt** | **\DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **subject** | **string** | Subject of the campaign | **replyTo** | **string** | Email on which the campaign recipients will be able to reply to | [optional] **toField** | **string** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use [FNAME] [LNAME]. These attributes must already exist in your contact database | [optional] **recipients** | [**\SendinBlue\Client\Model\CreateEmailCampaignRecipients**](CreateEmailCampaignRecipients.md) | | [optional] -**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] +**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **inlineImageActivation** | **bool** | Use true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can not be sent to more than 5000 contacts | [optional] [default to false] **mirrorActive** | **bool** | Use true to enable the mirror link | [optional] **recurring** | **bool** | For trigger campagins use false to make sure a contact receives the same campaign only once | [optional] [default to false] diff --git a/docs/Model/CreateSmsCampaign.md b/docs/Model/CreateSmsCampaign.md index 3b745684..31f74188 100644 --- a/docs/Model/CreateSmsCampaign.md +++ b/docs/Model/CreateSmsCampaign.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **sender** | **string** | Name of the sender. The number of characters is limited to 11 | **content** | **string** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] **recipients** | [**\SendinBlue\Client\Model\CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] -**scheduledAt** | **\DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] +**scheduledAt** | **\DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/CreateSmtpTemplate.md b/docs/Model/CreateSmtpTemplate.md index ac2b8c88..c36504c6 100644 --- a/docs/Model/CreateSmtpTemplate.md +++ b/docs/Model/CreateSmtpTemplate.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **subject** | **string** | Subject of the template | **replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional] **toField** | **string** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. To use the contact attributes here, these must already exist in SendinBlue account | [optional] -**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] +**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **isActive** | **bool** | Status of template. isActive = true means template is active and isActive = false means template is inactive | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/GetCampaignRecipients.md b/docs/Model/GetCampaignRecipients.md index c9950e49..4dc68b4f 100644 --- a/docs/Model/GetCampaignRecipients.md +++ b/docs/Model/GetCampaignRecipients.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**lists** | [**\SendinBlue\Client\Model\GetCampaignRecipientsLists[]**](GetCampaignRecipientsLists.md) | Lists included in the campaign | -**exclusionLists** | [**\SendinBlue\Client\Model\GetCampaignRecipientsExclusionLists[]**](GetCampaignRecipientsExclusionLists.md) | Lists excluded of the campaign | +**lists** | **int[]** | | +**exclusionLists** | **int[]** | | [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/GetCampaignRecipientsExclusionLists.md b/docs/Model/GetCampaignRecipientsExclusionLists.md deleted file mode 100644 index 9b802cbb..00000000 --- a/docs/Model/GetCampaignRecipientsExclusionLists.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetCampaignRecipientsExclusionLists - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **int** | ID of the list excluded of the campaign | -**name** | **string** | Name of the list excluded of the campaign | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - diff --git a/docs/Model/GetCampaignRecipientsLists.md b/docs/Model/GetCampaignRecipientsLists.md deleted file mode 100644 index d40c08d7..00000000 --- a/docs/Model/GetCampaignRecipientsLists.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetCampaignRecipientsLists - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **int** | ID of the list included in the campaign | -**name** | **string** | Name of the list included in the campaign | - -[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) - - diff --git a/docs/Model/GetReportsReports.md b/docs/Model/GetReportsReports.md index 771af712..1f7d19b4 100644 --- a/docs/Model/GetReportsReports.md +++ b/docs/Model/GetReportsReports.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **date** | **\DateTime** | Date of the statistics | -**tag** | **string** | Reminder of the specified tag (only available if a specific tag has been specified in the request) | **requests** | **int** | Number of requests for the date | **delivered** | **int** | Number of delivered emails for the date | **hardBounces** | **int** | Number of hardbounces for the date | diff --git a/docs/Model/GetSmsEventReportEvents.md b/docs/Model/GetSmsEventReportEvents.md index 702d32cb..293b5f91 100644 --- a/docs/Model/GetSmsEventReportEvents.md +++ b/docs/Model/GetSmsEventReportEvents.md @@ -7,9 +7,9 @@ Name | Type | Description | Notes **date** | **\DateTime** | Date on which the event has been generated | **messageId** | **string** | Message ID which generated the event | **event** | **string** | Event which occurred | -**reason** | **string** | Reason of bounce (only available if the event is hardbounce or softbounce) | +**reason** | **string** | Reason of bounce (only available if the event is hardbounce or softbounce) | [optional] **reply** | **string** | | [optional] -**tag** | **string** | Tag of the SMS which generated the event | +**tag** | **string** | Tag of the SMS which generated the event | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/GetTransacSmsReportReports.md b/docs/Model/GetTransacSmsReportReports.md index f8d069df..a240fd54 100644 --- a/docs/Model/GetTransacSmsReportReports.md +++ b/docs/Model/GetTransacSmsReportReports.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **date** | **\DateTime** | Date for which statistics are retrieved | -**tag** | **string** | Tag specified in request | **requests** | **int** | Number of requests for the date | **delivered** | **int** | Number of delivered SMS for the date | **hardBounces** | **int** | Number of hardbounces for the date | diff --git a/docs/Model/RequestSMSRecipientExport.md b/docs/Model/RequestSMSRecipientExport.md index 29976a64..129167c5 100644 --- a/docs/Model/RequestSMSRecipientExport.md +++ b/docs/Model/RequestSMSRecipientExport.md @@ -1,4 +1,4 @@ -# RequestSMSRecipientExport +# RequestSmsRecipientExport ## Properties Name | Type | Description | Notes diff --git a/docs/Model/SendEmail.md b/docs/Model/SendEmail.md index 18393c3a..d2861036 100644 --- a/docs/Model/SendEmail.md +++ b/docs/Model/SendEmail.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **emailBcc** | **string[]** | Email addresses of the recipients in bcc | [optional] **emailCc** | **string[]** | Email addresses of the recipients in cc | [optional] **replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional] -**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] -**attachment** | [**\SendinBlue\Client\Model\SendEmailAttachment[]**](SendEmailAttachment.md) | Pass the base64 content of the attachment. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] +**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] +**attachment** | [**\SendinBlue\Client\Model\SendEmailAttachment[]**](SendEmailAttachment.md) | Pass the base64 content of the attachment. Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **headers** | **map[string,string]** | | [optional] **attributes** | **map[string,string]** | | [optional] diff --git a/docs/Model/SendSmtpEmail.md b/docs/Model/SendSmtpEmail.md index 1b708574..7aa8cc4e 100644 --- a/docs/Model/SendSmtpEmail.md +++ b/docs/Model/SendSmtpEmail.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **textContent** | **string** | Plain Text body of the message | [optional] **subject** | **string** | Subject of the message | **replyTo** | [**\SendinBlue\Client\Model\SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) | | [optional] -**attachment** | [**\SendinBlue\Client\Model\SendSmtpEmailAttachment[]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: gif, png, bmp, cgm, jpg, jpeg, tif, tiff, rtf, txt, css, shtml, html, htm, csv, zip, pdf, xml, ods, doc, docx, docm, ics, xls, xlsx, ppt, tar, and ez | [optional] +**attachment** | [**\SendinBlue\Client\Model\SendSmtpEmailAttachment[]**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment. Name can be used in both cases to define the attachment name. It is mandatory in case of content. Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **headers** | **map[string,string]** | | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/UpdateContact.md b/docs/Model/UpdateContact.md index 43e53a88..7b691259 100644 --- a/docs/Model/UpdateContact.md +++ b/docs/Model/UpdateContact.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **smsBlacklisted** | **bool** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional] **listIds** | **int[]** | Ids of the lists to add the contact to | [optional] **unlinkListIds** | **int[]** | Ids of the lists to remove the contact from | [optional] +**smtpBlacklistSender** | **string[]** | SMTP forbidden sender for contact. Use only for email Contact | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/UpdateEmailCampaign.md b/docs/Model/UpdateEmailCampaign.md index 2ce213ea..f0631970 100644 --- a/docs/Model/UpdateEmailCampaign.md +++ b/docs/Model/UpdateEmailCampaign.md @@ -8,12 +8,12 @@ Name | Type | Description | Notes **name** | **string** | Name of the campaign | [optional] **htmlContent** | **string** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional] **htmlUrl** | **string** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] -**scheduledAt** | **\DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] +**scheduledAt** | **\DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] **subject** | **string** | Subject of the campaign | [optional] **replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional] **toField** | **string** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. To use the contact attributes here, these must already exist in SendinBlue account | [optional] **recipients** | [**\SendinBlue\Client\Model\UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) | | [optional] -**attachmentUrl** | **string** | Absolute url of the attachment. Url not allowed from local machine. File must be hosted somewhere.Possilbe extension values are xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] +**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **inlineImageActivation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false] **mirrorActive** | **bool** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] **recurring** | **bool** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] [default to false] diff --git a/docs/Model/UpdateSmsCampaign.md b/docs/Model/UpdateSmsCampaign.md index de06b9be..685f2a8f 100644 --- a/docs/Model/UpdateSmsCampaign.md +++ b/docs/Model/UpdateSmsCampaign.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **sender** | **string** | Name of the sender. The number of characters is limited to 11 | [optional] **content** | **string** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] **recipients** | [**\SendinBlue\Client\Model\CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional] -**scheduledAt** | **\DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] +**scheduledAt** | **\DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/UpdateSmtpTemplate.md b/docs/Model/UpdateSmtpTemplate.md index eebed094..c130ede1 100644 --- a/docs/Model/UpdateSmtpTemplate.md +++ b/docs/Model/UpdateSmtpTemplate.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **subject** | **string** | Subject of the email | [optional] **replyTo** | **string** | Email on which campaign recipients will be able to reply to | [optional] **toField** | **string** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. These attributes must already exist in contacts database | [optional] -**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] +**attachmentUrl** | **string** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps | [optional] **isActive** | **bool** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) diff --git a/lib/Api/ContactsApi.php b/lib/Api/ContactsApi.php index d1f7f0c0..85f22e95 100644 --- a/lib/Api/ContactsApi.php +++ b/lib/Api/ContactsApi.php @@ -1126,7 +1126,7 @@ public function getContactStatsWithHttpInfo($email) * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) - * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional) + * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return \SendinBlue\Client\Model\GetContacts */ @@ -1143,7 +1143,7 @@ public function getContacts($limit = '50', $offset = '0', $modifiedSince = null) * * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) - * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional) + * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of \SendinBlue\Client\Model\GetContacts, HTTP status code, HTTP response headers (array of strings) */ @@ -1224,7 +1224,7 @@ public function getContactsWithHttpInfo($limit = '50', $offset = '0', $modifiedS * Get the contacts in a list * * @param int $listId Id of the list (required) - * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional) + * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @throws \SendinBlue\Client\ApiException on non-2xx response @@ -1242,7 +1242,7 @@ public function getContactsFromList($listId, $modifiedSince = null, $limit = '50 * Get the contacts in a list * * @param int $listId Id of the list (required) - * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional) + * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @throws \SendinBlue\Client\ApiException on non-2xx response diff --git a/lib/Api/EmailCampaignsApi.php b/lib/Api/EmailCampaignsApi.php index 922bd898..be50d316 100644 --- a/lib/Api/EmailCampaignsApi.php +++ b/lib/Api/EmailCampaignsApi.php @@ -176,7 +176,7 @@ public function createEmailCampaignWithHttpInfo($emailCampaigns) } /** - * Operation deleteEmailCampaigns + * Operation deleteEmailCampaign * * Delete an email campaign * @@ -184,14 +184,14 @@ public function createEmailCampaignWithHttpInfo($emailCampaigns) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return void */ - public function deleteEmailCampaigns($campaignId) + public function deleteEmailCampaign($campaignId) { - list($response) = $this->deleteEmailCampaignsWithHttpInfo($campaignId); + list($response) = $this->deleteEmailCampaignWithHttpInfo($campaignId); return $response; } /** - * Operation deleteEmailCampaignsWithHttpInfo + * Operation deleteEmailCampaignWithHttpInfo * * Delete an email campaign * @@ -199,11 +199,11 @@ public function deleteEmailCampaigns($campaignId) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function deleteEmailCampaignsWithHttpInfo($campaignId) + public function deleteEmailCampaignWithHttpInfo($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling deleteEmailCampaigns'); + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling deleteEmailCampaign'); } // parse inputs $resourcePath = "/emailCampaigns/{campaignId}"; @@ -970,7 +970,7 @@ public function updateCampaignStatusWithHttpInfo($campaignId, $status) } /** - * Operation updateEmailCampaigns + * Operation updateEmailCampaign * * Update a campaign * @@ -979,14 +979,14 @@ public function updateCampaignStatusWithHttpInfo($campaignId, $status) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return void */ - public function updateEmailCampaigns($campaignId, $emailCampaign) + public function updateEmailCampaign($campaignId, $emailCampaign) { - list($response) = $this->updateEmailCampaignsWithHttpInfo($campaignId, $emailCampaign); + list($response) = $this->updateEmailCampaignWithHttpInfo($campaignId, $emailCampaign); return $response; } /** - * Operation updateEmailCampaignsWithHttpInfo + * Operation updateEmailCampaignWithHttpInfo * * Update a campaign * @@ -995,15 +995,15 @@ public function updateEmailCampaigns($campaignId, $emailCampaign) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function updateEmailCampaignsWithHttpInfo($campaignId, $emailCampaign) + public function updateEmailCampaignWithHttpInfo($campaignId, $emailCampaign) { // verify the required parameter 'campaignId' is set if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling updateEmailCampaigns'); + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling updateEmailCampaign'); } // verify the required parameter 'emailCampaign' is set if ($emailCampaign === null) { - throw new \InvalidArgumentException('Missing the required parameter $emailCampaign when calling updateEmailCampaigns'); + throw new \InvalidArgumentException('Missing the required parameter $emailCampaign when calling updateEmailCampaign'); } // parse inputs $resourcePath = "/emailCampaigns/{campaignId}"; diff --git a/lib/Api/ListsApi.php b/lib/Api/ListsApi.php index 5f8debd5..dc4b2f96 100644 --- a/lib/Api/ListsApi.php +++ b/lib/Api/ListsApi.php @@ -378,7 +378,7 @@ public function deleteListWithHttpInfo($listId) * Get the contacts in a list * * @param int $listId Id of the list (required) - * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional) + * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @throws \SendinBlue\Client\ApiException on non-2xx response @@ -396,7 +396,7 @@ public function getContactsFromList($listId, $modifiedSince = null, $limit = '50 * Get the contacts in a list * * @param int $listId Id of the list (required) - * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional) + * @param \DateTime $modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. (optional) * @param int $limit Number of documents per page (optional, default to 50) * @param int $offset Index of the first document of the page (optional, default to 0) * @throws \SendinBlue\Client\ApiException on non-2xx response diff --git a/lib/Api/SMSCampaignsApi.php b/lib/Api/SMSCampaignsApi.php index e4fca6a5..5ce59140 100644 --- a/lib/Api/SMSCampaignsApi.php +++ b/lib/Api/SMSCampaignsApi.php @@ -88,7 +88,7 @@ public function setApiClient(\SendinBlue\Client\ApiClient $apiClient) } /** - * Operation createSMSCampaign + * Operation createSmsCampaign * * Creates an SMS campaign * @@ -96,14 +96,14 @@ public function setApiClient(\SendinBlue\Client\ApiClient $apiClient) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return \SendinBlue\Client\Model\CreateModel */ - public function createSMSCampaign($createSmsCampaign) + public function createSmsCampaign($createSmsCampaign) { - list($response) = $this->createSMSCampaignWithHttpInfo($createSmsCampaign); + list($response) = $this->createSmsCampaignWithHttpInfo($createSmsCampaign); return $response; } /** - * Operation createSMSCampaignWithHttpInfo + * Operation createSmsCampaignWithHttpInfo * * Creates an SMS campaign * @@ -111,11 +111,11 @@ public function createSMSCampaign($createSmsCampaign) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of \SendinBlue\Client\Model\CreateModel, HTTP status code, HTTP response headers (array of strings) */ - public function createSMSCampaignWithHttpInfo($createSmsCampaign) + public function createSmsCampaignWithHttpInfo($createSmsCampaign) { // verify the required parameter 'createSmsCampaign' is set if ($createSmsCampaign === null) { - throw new \InvalidArgumentException('Missing the required parameter $createSmsCampaign when calling createSMSCampaign'); + throw new \InvalidArgumentException('Missing the required parameter $createSmsCampaign when calling createSmsCampaign'); } // parse inputs $resourcePath = "/smsCampaigns"; @@ -176,7 +176,7 @@ public function createSMSCampaignWithHttpInfo($createSmsCampaign) } /** - * Operation deleteSMSCampaigns + * Operation deleteSmsCampaign * * Delete the SMS campaign * @@ -184,14 +184,14 @@ public function createSMSCampaignWithHttpInfo($createSmsCampaign) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return void */ - public function deleteSMSCampaigns($campaignId) + public function deleteSmsCampaign($campaignId) { - list($response) = $this->deleteSMSCampaignsWithHttpInfo($campaignId); + list($response) = $this->deleteSmsCampaignWithHttpInfo($campaignId); return $response; } /** - * Operation deleteSMSCampaignsWithHttpInfo + * Operation deleteSmsCampaignWithHttpInfo * * Delete the SMS campaign * @@ -199,11 +199,11 @@ public function deleteSMSCampaigns($campaignId) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function deleteSMSCampaignsWithHttpInfo($campaignId) + public function deleteSmsCampaignWithHttpInfo($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling deleteSMSCampaigns'); + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling deleteSmsCampaign'); } // parse inputs $resourcePath = "/smsCampaigns/{campaignId}"; @@ -267,41 +267,43 @@ public function deleteSMSCampaignsWithHttpInfo($campaignId) } /** - * Operation getSMSCampaigns + * Operation getSmsCampaign * - * Returns the informations for all your created SMS campaigns + * Get an SMS campaign * - * @param string $status Status of campaign. (optional) - * @param int $limit Number limitation for the result returned (optional, default to 500) - * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) + * @param int $campaignId id of the SMS campaign (required) + * @param \SendinBlue\Client\Model\GetSmsCampaign $getSmsCampaign Values to update an SMS Campaign (required) * @throws \SendinBlue\Client\ApiException on non-2xx response - * @return \SendinBlue\Client\Model\GetSmsCampaigns + * @return \SendinBlue\Client\Model\GetSmsCampaign */ - public function getSMSCampaigns($status = null, $limit = '500', $offset = '0') + public function getSmsCampaign($campaignId, $getSmsCampaign) { - list($response) = $this->getSMSCampaignsWithHttpInfo($status, $limit, $offset); + list($response) = $this->getSmsCampaignWithHttpInfo($campaignId, $getSmsCampaign); return $response; } /** - * Operation getSMSCampaignsWithHttpInfo + * Operation getSmsCampaignWithHttpInfo * - * Returns the informations for all your created SMS campaigns + * Get an SMS campaign * - * @param string $status Status of campaign. (optional) - * @param int $limit Number limitation for the result returned (optional, default to 500) - * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) + * @param int $campaignId id of the SMS campaign (required) + * @param \SendinBlue\Client\Model\GetSmsCampaign $getSmsCampaign Values to update an SMS Campaign (required) * @throws \SendinBlue\Client\ApiException on non-2xx response - * @return array of \SendinBlue\Client\Model\GetSmsCampaigns, HTTP status code, HTTP response headers (array of strings) + * @return array of \SendinBlue\Client\Model\GetSmsCampaign, HTTP status code, HTTP response headers (array of strings) */ - public function getSMSCampaignsWithHttpInfo($status = null, $limit = '500', $offset = '0') + public function getSmsCampaignWithHttpInfo($campaignId, $getSmsCampaign) { - if (!is_null($limit) && ($limit > 1000)) { - throw new \InvalidArgumentException('invalid value for "$limit" when calling SMSCampaignsApi.getSMSCampaigns, must be smaller than or equal to 1000.'); + // verify the required parameter 'campaignId' is set + if ($campaignId === null) { + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling getSmsCampaign'); + } + // verify the required parameter 'getSmsCampaign' is set + if ($getSmsCampaign === null) { + throw new \InvalidArgumentException('Missing the required parameter $getSmsCampaign when calling getSmsCampaign'); } - // parse inputs - $resourcePath = "/smsCampaigns"; + $resourcePath = "/smsCampaigns/{campaignId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -312,17 +314,18 @@ public function getSMSCampaignsWithHttpInfo($status = null, $limit = '500', $off } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json']); - // query params - if ($status !== null) { - $queryParams['status'] = $this->apiClient->getSerializer()->toQueryValue($status); - } - // query params - if ($limit !== null) { - $queryParams['limit'] = $this->apiClient->getSerializer()->toQueryValue($limit); + // path params + if ($campaignId !== null) { + $resourcePath = str_replace( + "{" . "campaignId" . "}", + $this->apiClient->getSerializer()->toPathValue($campaignId), + $resourcePath + ); } - // query params - if ($offset !== null) { - $queryParams['offset'] = $this->apiClient->getSerializer()->toQueryValue($offset); + // body params + $_tempBody = null; + if (isset($getSmsCampaign)) { + $_tempBody = $getSmsCampaign; } // for model (json/xml) @@ -344,21 +347,25 @@ public function getSMSCampaignsWithHttpInfo($status = null, $limit = '500', $off $queryParams, $httpBody, $headerParams, - '\SendinBlue\Client\Model\GetSmsCampaigns', - '/smsCampaigns' + '\SendinBlue\Client\Model\GetSmsCampaign', + '/smsCampaigns/{campaignId}' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\SendinBlue\Client\Model\GetSmsCampaigns', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\SendinBlue\Client\Model\GetSmsCampaign', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SendinBlue\Client\Model\GetSmsCampaigns', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SendinBlue\Client\Model\GetSmsCampaign', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SendinBlue\Client\Model\ErrorModel', $e->getResponseHeaders()); $e->setResponseObject($data); break; + case 404: + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SendinBlue\Client\Model\ErrorModel', $e->getResponseHeaders()); + $e->setResponseObject($data); + break; } throw $e; @@ -366,43 +373,41 @@ public function getSMSCampaignsWithHttpInfo($status = null, $limit = '500', $off } /** - * Operation getSmsCampaign + * Operation getSmsCampaigns * - * Get an SMS campaign + * Returns the informations for all your created SMS campaigns * - * @param int $campaignId id of the SMS campaign (required) - * @param \SendinBlue\Client\Model\GetSmsCampaign $getSmsCampaign Values to update an SMS Campaign (required) + * @param string $status Status of campaign. (optional) + * @param int $limit Number limitation for the result returned (optional, default to 500) + * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @throws \SendinBlue\Client\ApiException on non-2xx response - * @return \SendinBlue\Client\Model\GetSmsCampaign + * @return \SendinBlue\Client\Model\GetSmsCampaigns */ - public function getSmsCampaign($campaignId, $getSmsCampaign) + public function getSmsCampaigns($status = null, $limit = '500', $offset = '0') { - list($response) = $this->getSmsCampaignWithHttpInfo($campaignId, $getSmsCampaign); + list($response) = $this->getSmsCampaignsWithHttpInfo($status, $limit, $offset); return $response; } /** - * Operation getSmsCampaignWithHttpInfo + * Operation getSmsCampaignsWithHttpInfo * - * Get an SMS campaign + * Returns the informations for all your created SMS campaigns * - * @param int $campaignId id of the SMS campaign (required) - * @param \SendinBlue\Client\Model\GetSmsCampaign $getSmsCampaign Values to update an SMS Campaign (required) + * @param string $status Status of campaign. (optional) + * @param int $limit Number limitation for the result returned (optional, default to 500) + * @param int $offset Beginning point in the list to retrieve from. (optional, default to 0) * @throws \SendinBlue\Client\ApiException on non-2xx response - * @return array of \SendinBlue\Client\Model\GetSmsCampaign, HTTP status code, HTTP response headers (array of strings) + * @return array of \SendinBlue\Client\Model\GetSmsCampaigns, HTTP status code, HTTP response headers (array of strings) */ - public function getSmsCampaignWithHttpInfo($campaignId, $getSmsCampaign) + public function getSmsCampaignsWithHttpInfo($status = null, $limit = '500', $offset = '0') { - // verify the required parameter 'campaignId' is set - if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling getSmsCampaign'); - } - // verify the required parameter 'getSmsCampaign' is set - if ($getSmsCampaign === null) { - throw new \InvalidArgumentException('Missing the required parameter $getSmsCampaign when calling getSmsCampaign'); + if (!is_null($limit) && ($limit > 1000)) { + throw new \InvalidArgumentException('invalid value for "$limit" when calling SMSCampaignsApi.getSmsCampaigns, must be smaller than or equal to 1000.'); } + // parse inputs - $resourcePath = "/smsCampaigns/{campaignId}"; + $resourcePath = "/smsCampaigns"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -413,18 +418,17 @@ public function getSmsCampaignWithHttpInfo($campaignId, $getSmsCampaign) } $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json']); - // path params - if ($campaignId !== null) { - $resourcePath = str_replace( - "{" . "campaignId" . "}", - $this->apiClient->getSerializer()->toPathValue($campaignId), - $resourcePath - ); + // query params + if ($status !== null) { + $queryParams['status'] = $this->apiClient->getSerializer()->toQueryValue($status); } - // body params - $_tempBody = null; - if (isset($getSmsCampaign)) { - $_tempBody = $getSmsCampaign; + // query params + if ($limit !== null) { + $queryParams['limit'] = $this->apiClient->getSerializer()->toQueryValue($limit); + } + // query params + if ($offset !== null) { + $queryParams['offset'] = $this->apiClient->getSerializer()->toQueryValue($offset); } // for model (json/xml) @@ -446,25 +450,21 @@ public function getSmsCampaignWithHttpInfo($campaignId, $getSmsCampaign) $queryParams, $httpBody, $headerParams, - '\SendinBlue\Client\Model\GetSmsCampaign', - '/smsCampaigns/{campaignId}' + '\SendinBlue\Client\Model\GetSmsCampaigns', + '/smsCampaigns' ); - return [$this->apiClient->getSerializer()->deserialize($response, '\SendinBlue\Client\Model\GetSmsCampaign', $httpHeader), $statusCode, $httpHeader]; + return [$this->apiClient->getSerializer()->deserialize($response, '\SendinBlue\Client\Model\GetSmsCampaigns', $httpHeader), $statusCode, $httpHeader]; } catch (ApiException $e) { switch ($e->getCode()) { case 200: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SendinBlue\Client\Model\GetSmsCampaign', $e->getResponseHeaders()); + $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SendinBlue\Client\Model\GetSmsCampaigns', $e->getResponseHeaders()); $e->setResponseObject($data); break; case 400: $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SendinBlue\Client\Model\ErrorModel', $e->getResponseHeaders()); $e->setResponseObject($data); break; - case 404: - $data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\SendinBlue\Client\Model\ErrorModel', $e->getResponseHeaders()); - $e->setResponseObject($data); - break; } throw $e; @@ -472,36 +472,36 @@ public function getSmsCampaignWithHttpInfo($campaignId, $getSmsCampaign) } /** - * Operation requestSMSRecipientExport + * Operation requestSmsRecipientExport * * Exports the recipients of the specified campaign. * * @param int $campaignId id of the campaign (required) - * @param \SendinBlue\Client\Model\RequestSMSRecipientExport $recipientExport Values to send for a recipient export request (optional) + * @param \SendinBlue\Client\Model\RequestSmsRecipientExport $recipientExport Values to send for a recipient export request (optional) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return \SendinBlue\Client\Model\CreatedProcessId */ - public function requestSMSRecipientExport($campaignId, $recipientExport = null) + public function requestSmsRecipientExport($campaignId, $recipientExport = null) { - list($response) = $this->requestSMSRecipientExportWithHttpInfo($campaignId, $recipientExport); + list($response) = $this->requestSmsRecipientExportWithHttpInfo($campaignId, $recipientExport); return $response; } /** - * Operation requestSMSRecipientExportWithHttpInfo + * Operation requestSmsRecipientExportWithHttpInfo * * Exports the recipients of the specified campaign. * * @param int $campaignId id of the campaign (required) - * @param \SendinBlue\Client\Model\RequestSMSRecipientExport $recipientExport Values to send for a recipient export request (optional) + * @param \SendinBlue\Client\Model\RequestSmsRecipientExport $recipientExport Values to send for a recipient export request (optional) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of \SendinBlue\Client\Model\CreatedProcessId, HTTP status code, HTTP response headers (array of strings) */ - public function requestSMSRecipientExportWithHttpInfo($campaignId, $recipientExport = null) + public function requestSmsRecipientExportWithHttpInfo($campaignId, $recipientExport = null) { // verify the required parameter 'campaignId' is set if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling requestSMSRecipientExport'); + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling requestSmsRecipientExport'); } // parse inputs $resourcePath = "/smsCampaigns/{campaignId}/exportRecipients"; @@ -574,7 +574,7 @@ public function requestSMSRecipientExportWithHttpInfo($campaignId, $recipientExp } /** - * Operation sendSMSCampaignNow + * Operation sendSmsCampaignNow * * Send your SMS campaign immediately * @@ -582,14 +582,14 @@ public function requestSMSRecipientExportWithHttpInfo($campaignId, $recipientExp * @throws \SendinBlue\Client\ApiException on non-2xx response * @return void */ - public function sendSMSCampaignNow($campaignId) + public function sendSmsCampaignNow($campaignId) { - list($response) = $this->sendSMSCampaignNowWithHttpInfo($campaignId); + list($response) = $this->sendSmsCampaignNowWithHttpInfo($campaignId); return $response; } /** - * Operation sendSMSCampaignNowWithHttpInfo + * Operation sendSmsCampaignNowWithHttpInfo * * Send your SMS campaign immediately * @@ -597,11 +597,11 @@ public function sendSMSCampaignNow($campaignId) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function sendSMSCampaignNowWithHttpInfo($campaignId) + public function sendSmsCampaignNowWithHttpInfo($campaignId) { // verify the required parameter 'campaignId' is set if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling sendSMSCampaignNow'); + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling sendSmsCampaignNow'); } // parse inputs $resourcePath = "/smsCampaigns/{campaignId}/sendNow"; @@ -669,7 +669,7 @@ public function sendSMSCampaignNowWithHttpInfo($campaignId) } /** - * Operation sendSMSReport + * Operation sendSmsReport * * Send report of SMS campaigns * @@ -678,14 +678,14 @@ public function sendSMSCampaignNowWithHttpInfo($campaignId) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return void */ - public function sendSMSReport($campaignId, $sendReport) + public function sendSmsReport($campaignId, $sendReport) { - list($response) = $this->sendSMSReportWithHttpInfo($campaignId, $sendReport); + list($response) = $this->sendSmsReportWithHttpInfo($campaignId, $sendReport); return $response; } /** - * Operation sendSMSReportWithHttpInfo + * Operation sendSmsReportWithHttpInfo * * Send report of SMS campaigns * @@ -694,15 +694,15 @@ public function sendSMSReport($campaignId, $sendReport) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function sendSMSReportWithHttpInfo($campaignId, $sendReport) + public function sendSmsReportWithHttpInfo($campaignId, $sendReport) { // verify the required parameter 'campaignId' is set if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling sendSMSReport'); + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling sendSmsReport'); } // verify the required parameter 'sendReport' is set if ($sendReport === null) { - throw new \InvalidArgumentException('Missing the required parameter $sendReport when calling sendSMSReport'); + throw new \InvalidArgumentException('Missing the required parameter $sendReport when calling sendSmsReport'); } // parse inputs $resourcePath = "/smsCampaigns/{campaignId}/sendReport"; @@ -873,43 +873,43 @@ public function sendTestSmsWithHttpInfo($campaignId, $sendTestSms) } /** - * Operation updateSMSCampaignStatus + * Operation updateSmsCampaign * - * Update the campaign status + * Updates an SMS campaign * - * @param int $campaignId id of the campaign (required) - * @param \SendinBlue\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) + * @param int $campaignId id of the SMS campaign (required) + * @param \SendinBlue\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return void */ - public function updateSMSCampaignStatus($campaignId, $status) + public function updateSmsCampaign($campaignId, $updateSmsCampaign) { - list($response) = $this->updateSMSCampaignStatusWithHttpInfo($campaignId, $status); + list($response) = $this->updateSmsCampaignWithHttpInfo($campaignId, $updateSmsCampaign); return $response; } /** - * Operation updateSMSCampaignStatusWithHttpInfo + * Operation updateSmsCampaignWithHttpInfo * - * Update the campaign status + * Updates an SMS campaign * - * @param int $campaignId id of the campaign (required) - * @param \SendinBlue\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) + * @param int $campaignId id of the SMS campaign (required) + * @param \SendinBlue\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function updateSMSCampaignStatusWithHttpInfo($campaignId, $status) + public function updateSmsCampaignWithHttpInfo($campaignId, $updateSmsCampaign) { // verify the required parameter 'campaignId' is set if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling updateSMSCampaignStatus'); + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling updateSmsCampaign'); } - // verify the required parameter 'status' is set - if ($status === null) { - throw new \InvalidArgumentException('Missing the required parameter $status when calling updateSMSCampaignStatus'); + // verify the required parameter 'updateSmsCampaign' is set + if ($updateSmsCampaign === null) { + throw new \InvalidArgumentException('Missing the required parameter $updateSmsCampaign when calling updateSmsCampaign'); } // parse inputs - $resourcePath = "/smsCampaigns/{campaignId}/status"; + $resourcePath = "/smsCampaigns/{campaignId}"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -930,8 +930,8 @@ public function updateSMSCampaignStatusWithHttpInfo($campaignId, $status) } // body params $_tempBody = null; - if (isset($status)) { - $_tempBody = $status; + if (isset($updateSmsCampaign)) { + $_tempBody = $updateSmsCampaign; } // for model (json/xml) @@ -954,7 +954,7 @@ public function updateSMSCampaignStatusWithHttpInfo($campaignId, $status) $httpBody, $headerParams, null, - '/smsCampaigns/{campaignId}/status' + '/smsCampaigns/{campaignId}' ); return [null, $statusCode, $httpHeader]; @@ -975,43 +975,43 @@ public function updateSMSCampaignStatusWithHttpInfo($campaignId, $status) } /** - * Operation updateSmsCampaign + * Operation updateSmsCampaignStatus * - * Updates an SMS campaign + * Update the campaign status * - * @param int $campaignId id of the SMS campaign (required) - * @param \SendinBlue\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) + * @param int $campaignId id of the campaign (required) + * @param \SendinBlue\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return void */ - public function updateSmsCampaign($campaignId, $updateSmsCampaign) + public function updateSmsCampaignStatus($campaignId, $status) { - list($response) = $this->updateSmsCampaignWithHttpInfo($campaignId, $updateSmsCampaign); + list($response) = $this->updateSmsCampaignStatusWithHttpInfo($campaignId, $status); return $response; } /** - * Operation updateSmsCampaignWithHttpInfo + * Operation updateSmsCampaignStatusWithHttpInfo * - * Updates an SMS campaign + * Update the campaign status * - * @param int $campaignId id of the SMS campaign (required) - * @param \SendinBlue\Client\Model\UpdateSmsCampaign $updateSmsCampaign Values to update an SMS Campaign (required) + * @param int $campaignId id of the campaign (required) + * @param \SendinBlue\Client\Model\UpdateCampaignStatus $status Status of the campaign. (required) * @throws \SendinBlue\Client\ApiException on non-2xx response * @return array of null, HTTP status code, HTTP response headers (array of strings) */ - public function updateSmsCampaignWithHttpInfo($campaignId, $updateSmsCampaign) + public function updateSmsCampaignStatusWithHttpInfo($campaignId, $status) { // verify the required parameter 'campaignId' is set if ($campaignId === null) { - throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling updateSmsCampaign'); + throw new \InvalidArgumentException('Missing the required parameter $campaignId when calling updateSmsCampaignStatus'); } - // verify the required parameter 'updateSmsCampaign' is set - if ($updateSmsCampaign === null) { - throw new \InvalidArgumentException('Missing the required parameter $updateSmsCampaign when calling updateSmsCampaign'); + // verify the required parameter 'status' is set + if ($status === null) { + throw new \InvalidArgumentException('Missing the required parameter $status when calling updateSmsCampaignStatus'); } // parse inputs - $resourcePath = "/smsCampaigns/{campaignId}"; + $resourcePath = "/smsCampaigns/{campaignId}/status"; $httpBody = ''; $queryParams = []; $headerParams = []; @@ -1032,8 +1032,8 @@ public function updateSmsCampaignWithHttpInfo($campaignId, $updateSmsCampaign) } // body params $_tempBody = null; - if (isset($updateSmsCampaign)) { - $_tempBody = $updateSmsCampaign; + if (isset($status)) { + $_tempBody = $status; } // for model (json/xml) @@ -1056,7 +1056,7 @@ public function updateSmsCampaignWithHttpInfo($campaignId, $updateSmsCampaign) $httpBody, $headerParams, null, - '/smsCampaigns/{campaignId}' + '/smsCampaigns/{campaignId}/status' ); return [null, $statusCode, $httpHeader]; diff --git a/lib/Model/CreateContact.php b/lib/Model/CreateContact.php index c8bd29d9..fda96d76 100644 --- a/lib/Model/CreateContact.php +++ b/lib/Model/CreateContact.php @@ -59,7 +59,8 @@ class CreateContact implements ArrayAccess 'emailBlacklisted' => 'bool', 'smsBlacklisted' => 'bool', 'listIds' => 'int[]', - 'updateEnabled' => 'bool' + 'updateEnabled' => 'bool', + 'smtpBlacklistSender' => 'string[]' ]; /** @@ -72,7 +73,8 @@ class CreateContact implements ArrayAccess 'emailBlacklisted' => null, 'smsBlacklisted' => null, 'listIds' => 'int64', - 'updateEnabled' => null + 'updateEnabled' => null, + 'smtpBlacklistSender' => 'email' ]; public static function swaggerTypes() @@ -95,7 +97,8 @@ public static function swaggerFormats() 'emailBlacklisted' => 'emailBlacklisted', 'smsBlacklisted' => 'smsBlacklisted', 'listIds' => 'listIds', - 'updateEnabled' => 'updateEnabled' + 'updateEnabled' => 'updateEnabled', + 'smtpBlacklistSender' => 'smtpBlacklistSender' ]; @@ -109,7 +112,8 @@ public static function swaggerFormats() 'emailBlacklisted' => 'setEmailBlacklisted', 'smsBlacklisted' => 'setSmsBlacklisted', 'listIds' => 'setListIds', - 'updateEnabled' => 'setUpdateEnabled' + 'updateEnabled' => 'setUpdateEnabled', + 'smtpBlacklistSender' => 'setSmtpBlacklistSender' ]; @@ -123,7 +127,8 @@ public static function swaggerFormats() 'emailBlacklisted' => 'getEmailBlacklisted', 'smsBlacklisted' => 'getSmsBlacklisted', 'listIds' => 'getListIds', - 'updateEnabled' => 'getUpdateEnabled' + 'updateEnabled' => 'getUpdateEnabled', + 'smtpBlacklistSender' => 'getSmtpBlacklistSender' ]; public static function attributeMap() @@ -163,6 +168,7 @@ public function __construct(array $data = null) $this->container['smsBlacklisted'] = isset($data['smsBlacklisted']) ? $data['smsBlacklisted'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['updateEnabled'] = isset($data['updateEnabled']) ? $data['updateEnabled'] : false; + $this->container['smtpBlacklistSender'] = isset($data['smtpBlacklistSender']) ? $data['smtpBlacklistSender'] : null; } /** @@ -315,6 +321,27 @@ public function setUpdateEnabled($updateEnabled) return $this; } + + /** + * Gets smtpBlacklistSender + * @return string[] + */ + public function getSmtpBlacklistSender() + { + return $this->container['smtpBlacklistSender']; + } + + /** + * Sets smtpBlacklistSender + * @param string[] $smtpBlacklistSender SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) + * @return $this + */ + public function setSmtpBlacklistSender($smtpBlacklistSender) + { + $this->container['smtpBlacklistSender'] = $smtpBlacklistSender; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/CreateEmailCampaign.php b/lib/Model/CreateEmailCampaign.php index 380c98f7..36b912db 100644 --- a/lib/Model/CreateEmailCampaign.php +++ b/lib/Model/CreateEmailCampaign.php @@ -422,7 +422,7 @@ public function getScheduledAt() /** * Sets scheduledAt - * @param \DateTime $scheduledAt Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) + * @param \DateTime $scheduledAt Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. * @return $this */ public function setScheduledAt($scheduledAt) @@ -527,7 +527,7 @@ public function getAttachmentUrl() /** * Sets attachmentUrl - * @param string $attachmentUrl Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf + * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps * @return $this */ public function setAttachmentUrl($attachmentUrl) diff --git a/lib/Model/CreateSmsCampaign.php b/lib/Model/CreateSmsCampaign.php index 39490e21..1b06d187 100644 --- a/lib/Model/CreateSmsCampaign.php +++ b/lib/Model/CreateSmsCampaign.php @@ -302,7 +302,7 @@ public function getScheduledAt() /** * Sets scheduledAt - * @param \DateTime $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) + * @param \DateTime $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. * @return $this */ public function setScheduledAt($scheduledAt) diff --git a/lib/Model/CreateSmtpTemplate.php b/lib/Model/CreateSmtpTemplate.php index 432b2214..f158eb9f 100644 --- a/lib/Model/CreateSmtpTemplate.php +++ b/lib/Model/CreateSmtpTemplate.php @@ -405,7 +405,7 @@ public function getAttachmentUrl() /** * Sets attachmentUrl - * @param string $attachmentUrl Absolute url of the attachment (no local file). Extensions allowed xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf + * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps * @return $this */ public function setAttachmentUrl($attachmentUrl) diff --git a/lib/Model/GetCampaignRecipients.php b/lib/Model/GetCampaignRecipients.php index 4e7071d4..11ae229a 100644 --- a/lib/Model/GetCampaignRecipients.php +++ b/lib/Model/GetCampaignRecipients.php @@ -54,8 +54,8 @@ class GetCampaignRecipients implements ArrayAccess * @var string[] */ protected static $swaggerTypes = [ - 'lists' => '\SendinBlue\Client\Model\GetCampaignRecipientsLists[]', - 'exclusionLists' => '\SendinBlue\Client\Model\GetCampaignRecipientsExclusionLists[]' + 'lists' => 'int[]', + 'exclusionLists' => 'int[]' ]; /** @@ -63,8 +63,8 @@ class GetCampaignRecipients implements ArrayAccess * @var string[] */ protected static $swaggerFormats = [ - 'lists' => null, - 'exclusionLists' => null + 'lists' => 'int64', + 'exclusionLists' => 'int64' ]; public static function swaggerTypes() @@ -180,7 +180,7 @@ public function valid() /** * Gets lists - * @return \SendinBlue\Client\Model\GetCampaignRecipientsLists[] + * @return int[] */ public function getLists() { @@ -189,7 +189,7 @@ public function getLists() /** * Sets lists - * @param \SendinBlue\Client\Model\GetCampaignRecipientsLists[] $lists Lists included in the campaign + * @param int[] $lists * @return $this */ public function setLists($lists) @@ -201,7 +201,7 @@ public function setLists($lists) /** * Gets exclusionLists - * @return \SendinBlue\Client\Model\GetCampaignRecipientsExclusionLists[] + * @return int[] */ public function getExclusionLists() { @@ -210,7 +210,7 @@ public function getExclusionLists() /** * Sets exclusionLists - * @param \SendinBlue\Client\Model\GetCampaignRecipientsExclusionLists[] $exclusionLists Lists excluded of the campaign + * @param int[] $exclusionLists * @return $this */ public function setExclusionLists($exclusionLists) diff --git a/lib/Model/GetCampaignRecipientsExclusionLists.php b/lib/Model/GetCampaignRecipientsExclusionLists.php deleted file mode 100644 index 87728b2a..00000000 --- a/lib/Model/GetCampaignRecipientsExclusionLists.php +++ /dev/null @@ -1,281 +0,0 @@ - 'int', - 'name' => 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'id' => 'int64', - 'name' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'id' => 'id', - 'name' => 'name' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'id' => 'setId', - 'name' => 'setName' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'id' => 'getId', - 'name' => 'getName' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['id'] = isset($data['id']) ? $data['id'] : null; - $this->container['name'] = isset($data['name']) ? $data['name'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - if ($this->container['id'] === null) { - $invalid_properties[] = "'id' can't be null"; - } - if ($this->container['name'] === null) { - $invalid_properties[] = "'name' can't be null"; - } - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - if ($this->container['id'] === null) { - return false; - } - if ($this->container['name'] === null) { - return false; - } - return true; - } - - - /** - * Gets id - * @return int - */ - public function getId() - { - return $this->container['id']; - } - - /** - * Sets id - * @param int $id ID of the list excluded of the campaign - * @return $this - */ - public function setId($id) - { - $this->container['id'] = $id; - - return $this; - } - - /** - * Gets name - * @return string - */ - public function getName() - { - return $this->container['name']; - } - - /** - * Sets name - * @param string $name Name of the list excluded of the campaign - * @return $this - */ - public function setName($name) - { - $this->container['name'] = $name; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\SendinBlue\Client\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\SendinBlue\Client\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/GetCampaignRecipientsLists.php b/lib/Model/GetCampaignRecipientsLists.php deleted file mode 100644 index 74a5895a..00000000 --- a/lib/Model/GetCampaignRecipientsLists.php +++ /dev/null @@ -1,281 +0,0 @@ - 'int', - 'name' => 'string' - ]; - - /** - * Array of property to format mappings. Used for (de)serialization - * @var string[] - */ - protected static $swaggerFormats = [ - 'id' => 'int64', - 'name' => null - ]; - - public static function swaggerTypes() - { - return self::$swaggerTypes; - } - - public static function swaggerFormats() - { - return self::$swaggerFormats; - } - - /** - * Array of attributes where the key is the local name, and the value is the original name - * @var string[] - */ - protected static $attributeMap = [ - 'id' => 'id', - 'name' => 'name' - ]; - - - /** - * Array of attributes to setter functions (for deserialization of responses) - * @var string[] - */ - protected static $setters = [ - 'id' => 'setId', - 'name' => 'setName' - ]; - - - /** - * Array of attributes to getter functions (for serialization of requests) - * @var string[] - */ - protected static $getters = [ - 'id' => 'getId', - 'name' => 'getName' - ]; - - public static function attributeMap() - { - return self::$attributeMap; - } - - public static function setters() - { - return self::$setters; - } - - public static function getters() - { - return self::$getters; - } - - - - - - /** - * Associative array for storing property values - * @var mixed[] - */ - protected $container = []; - - /** - * Constructor - * @param mixed[] $data Associated array of property values initializing the model - */ - public function __construct(array $data = null) - { - $this->container['id'] = isset($data['id']) ? $data['id'] : null; - $this->container['name'] = isset($data['name']) ? $data['name'] : null; - } - - /** - * show all the invalid properties with reasons. - * - * @return array invalid properties with reasons - */ - public function listInvalidProperties() - { - $invalid_properties = []; - - if ($this->container['id'] === null) { - $invalid_properties[] = "'id' can't be null"; - } - if ($this->container['name'] === null) { - $invalid_properties[] = "'name' can't be null"; - } - return $invalid_properties; - } - - /** - * validate all the properties in the model - * return true if all passed - * - * @return bool True if all properties are valid - */ - public function valid() - { - - if ($this->container['id'] === null) { - return false; - } - if ($this->container['name'] === null) { - return false; - } - return true; - } - - - /** - * Gets id - * @return int - */ - public function getId() - { - return $this->container['id']; - } - - /** - * Sets id - * @param int $id ID of the list included in the campaign - * @return $this - */ - public function setId($id) - { - $this->container['id'] = $id; - - return $this; - } - - /** - * Gets name - * @return string - */ - public function getName() - { - return $this->container['name']; - } - - /** - * Sets name - * @param string $name Name of the list included in the campaign - * @return $this - */ - public function setName($name) - { - $this->container['name'] = $name; - - return $this; - } - /** - * Returns true if offset exists. False otherwise. - * @param integer $offset Offset - * @return boolean - */ - public function offsetExists($offset) - { - return isset($this->container[$offset]); - } - - /** - * Gets offset. - * @param integer $offset Offset - * @return mixed - */ - public function offsetGet($offset) - { - return isset($this->container[$offset]) ? $this->container[$offset] : null; - } - - /** - * Sets value based on offset. - * @param integer $offset Offset - * @param mixed $value Value to be set - * @return void - */ - public function offsetSet($offset, $value) - { - if (is_null($offset)) { - $this->container[] = $value; - } else { - $this->container[$offset] = $value; - } - } - - /** - * Unsets offset. - * @param integer $offset Offset - * @return void - */ - public function offsetUnset($offset) - { - unset($this->container[$offset]); - } - - /** - * Gets the string presentation of the object - * @return string - */ - public function __toString() - { - if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print - return json_encode(\SendinBlue\Client\ObjectSerializer::sanitizeForSerialization($this), JSON_PRETTY_PRINT); - } - - return json_encode(\SendinBlue\Client\ObjectSerializer::sanitizeForSerialization($this)); - } -} - - diff --git a/lib/Model/GetReportsReports.php b/lib/Model/GetReportsReports.php index b9a74ce2..69ee6fb4 100644 --- a/lib/Model/GetReportsReports.php +++ b/lib/Model/GetReportsReports.php @@ -55,7 +55,6 @@ class GetReportsReports implements ArrayAccess */ protected static $swaggerTypes = [ 'date' => '\DateTime', - 'tag' => 'string', 'requests' => 'int', 'delivered' => 'int', 'hardBounces' => 'int', @@ -75,7 +74,6 @@ class GetReportsReports implements ArrayAccess */ protected static $swaggerFormats = [ 'date' => 'date', - 'tag' => null, 'requests' => 'int64', 'delivered' => 'int64', 'hardBounces' => 'int64', @@ -105,7 +103,6 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'date' => 'date', - 'tag' => 'tag', 'requests' => 'requests', 'delivered' => 'delivered', 'hardBounces' => 'hardBounces', @@ -126,7 +123,6 @@ public static function swaggerFormats() */ protected static $setters = [ 'date' => 'setDate', - 'tag' => 'setTag', 'requests' => 'setRequests', 'delivered' => 'setDelivered', 'hardBounces' => 'setHardBounces', @@ -147,7 +143,6 @@ public static function swaggerFormats() */ protected static $getters = [ 'date' => 'getDate', - 'tag' => 'getTag', 'requests' => 'getRequests', 'delivered' => 'getDelivered', 'hardBounces' => 'getHardBounces', @@ -193,7 +188,6 @@ public static function getters() public function __construct(array $data = null) { $this->container['date'] = isset($data['date']) ? $data['date'] : null; - $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['requests'] = isset($data['requests']) ? $data['requests'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; @@ -219,9 +213,6 @@ public function listInvalidProperties() if ($this->container['date'] === null) { $invalid_properties[] = "'date' can't be null"; } - if ($this->container['tag'] === null) { - $invalid_properties[] = "'tag' can't be null"; - } if ($this->container['requests'] === null) { $invalid_properties[] = "'requests' can't be null"; } @@ -270,9 +261,6 @@ public function valid() if ($this->container['date'] === null) { return false; } - if ($this->container['tag'] === null) { - return false; - } if ($this->container['requests'] === null) { return false; } @@ -331,27 +319,6 @@ public function setDate($date) return $this; } - /** - * Gets tag - * @return string - */ - public function getTag() - { - return $this->container['tag']; - } - - /** - * Sets tag - * @param string $tag Reminder of the specified tag (only available if a specific tag has been specified in the request) - * @return $this - */ - public function setTag($tag) - { - $this->container['tag'] = $tag; - - return $this; - } - /** * Gets requests * @return int diff --git a/lib/Model/GetSmsEventReportEvents.php b/lib/Model/GetSmsEventReportEvents.php index ffdc8c37..7548a53f 100644 --- a/lib/Model/GetSmsEventReportEvents.php +++ b/lib/Model/GetSmsEventReportEvents.php @@ -228,12 +228,6 @@ public function listInvalidProperties() ); } - if ($this->container['reason'] === null) { - $invalid_properties[] = "'reason' can't be null"; - } - if ($this->container['tag'] === null) { - $invalid_properties[] = "'tag' can't be null"; - } return $invalid_properties; } @@ -262,12 +256,6 @@ public function valid() if (!in_array($this->container['event'], $allowed_values)) { return false; } - if ($this->container['reason'] === null) { - return false; - } - if ($this->container['tag'] === null) { - return false; - } return true; } diff --git a/lib/Model/GetTransacSmsReportReports.php b/lib/Model/GetTransacSmsReportReports.php index e9d62351..dcb90c82 100644 --- a/lib/Model/GetTransacSmsReportReports.php +++ b/lib/Model/GetTransacSmsReportReports.php @@ -55,7 +55,6 @@ class GetTransacSmsReportReports implements ArrayAccess */ protected static $swaggerTypes = [ 'date' => '\DateTime', - 'tag' => 'string', 'requests' => 'int', 'delivered' => 'int', 'hardBounces' => 'int', @@ -73,7 +72,6 @@ class GetTransacSmsReportReports implements ArrayAccess */ protected static $swaggerFormats = [ 'date' => 'date', - 'tag' => null, 'requests' => 'int64', 'delivered' => 'int64', 'hardBounces' => 'int64', @@ -101,7 +99,6 @@ public static function swaggerFormats() */ protected static $attributeMap = [ 'date' => 'date', - 'tag' => 'tag', 'requests' => 'requests', 'delivered' => 'delivered', 'hardBounces' => 'hardBounces', @@ -120,7 +117,6 @@ public static function swaggerFormats() */ protected static $setters = [ 'date' => 'setDate', - 'tag' => 'setTag', 'requests' => 'setRequests', 'delivered' => 'setDelivered', 'hardBounces' => 'setHardBounces', @@ -139,7 +135,6 @@ public static function swaggerFormats() */ protected static $getters = [ 'date' => 'getDate', - 'tag' => 'getTag', 'requests' => 'getRequests', 'delivered' => 'getDelivered', 'hardBounces' => 'getHardBounces', @@ -183,7 +178,6 @@ public static function getters() public function __construct(array $data = null) { $this->container['date'] = isset($data['date']) ? $data['date'] : null; - $this->container['tag'] = isset($data['tag']) ? $data['tag'] : null; $this->container['requests'] = isset($data['requests']) ? $data['requests'] : null; $this->container['delivered'] = isset($data['delivered']) ? $data['delivered'] : null; $this->container['hardBounces'] = isset($data['hardBounces']) ? $data['hardBounces'] : null; @@ -207,9 +201,6 @@ public function listInvalidProperties() if ($this->container['date'] === null) { $invalid_properties[] = "'date' can't be null"; } - if ($this->container['tag'] === null) { - $invalid_properties[] = "'tag' can't be null"; - } if ($this->container['requests'] === null) { $invalid_properties[] = "'requests' can't be null"; } @@ -252,9 +243,6 @@ public function valid() if ($this->container['date'] === null) { return false; } - if ($this->container['tag'] === null) { - return false; - } if ($this->container['requests'] === null) { return false; } @@ -307,27 +295,6 @@ public function setDate($date) return $this; } - /** - * Gets tag - * @return string - */ - public function getTag() - { - return $this->container['tag']; - } - - /** - * Sets tag - * @param string $tag Tag specified in request - * @return $this - */ - public function setTag($tag) - { - $this->container['tag'] = $tag; - - return $this; - } - /** * Gets requests * @return int diff --git a/lib/Model/RequestSMSRecipientExport.php b/lib/Model/RequestSMSRecipientExport.php index 28b47930..1399f5c1 100644 --- a/lib/Model/RequestSMSRecipientExport.php +++ b/lib/Model/RequestSMSRecipientExport.php @@ -1,6 +1,6 @@ 'bool', 'smsBlacklisted' => 'bool', 'listIds' => 'int[]', - 'unlinkListIds' => 'int[]' + 'unlinkListIds' => 'int[]', + 'smtpBlacklistSender' => 'string[]' ]; /** @@ -70,7 +71,8 @@ class UpdateContact implements ArrayAccess 'emailBlacklisted' => null, 'smsBlacklisted' => null, 'listIds' => 'int64', - 'unlinkListIds' => 'int64' + 'unlinkListIds' => 'int64', + 'smtpBlacklistSender' => 'email' ]; public static function swaggerTypes() @@ -92,7 +94,8 @@ public static function swaggerFormats() 'emailBlacklisted' => 'emailBlacklisted', 'smsBlacklisted' => 'smsBlacklisted', 'listIds' => 'listIds', - 'unlinkListIds' => 'unlinkListIds' + 'unlinkListIds' => 'unlinkListIds', + 'smtpBlacklistSender' => 'smtpBlacklistSender' ]; @@ -105,7 +108,8 @@ public static function swaggerFormats() 'emailBlacklisted' => 'setEmailBlacklisted', 'smsBlacklisted' => 'setSmsBlacklisted', 'listIds' => 'setListIds', - 'unlinkListIds' => 'setUnlinkListIds' + 'unlinkListIds' => 'setUnlinkListIds', + 'smtpBlacklistSender' => 'setSmtpBlacklistSender' ]; @@ -118,7 +122,8 @@ public static function swaggerFormats() 'emailBlacklisted' => 'getEmailBlacklisted', 'smsBlacklisted' => 'getSmsBlacklisted', 'listIds' => 'getListIds', - 'unlinkListIds' => 'getUnlinkListIds' + 'unlinkListIds' => 'getUnlinkListIds', + 'smtpBlacklistSender' => 'getSmtpBlacklistSender' ]; public static function attributeMap() @@ -157,6 +162,7 @@ public function __construct(array $data = null) $this->container['smsBlacklisted'] = isset($data['smsBlacklisted']) ? $data['smsBlacklisted'] : null; $this->container['listIds'] = isset($data['listIds']) ? $data['listIds'] : null; $this->container['unlinkListIds'] = isset($data['unlinkListIds']) ? $data['unlinkListIds'] : null; + $this->container['smtpBlacklistSender'] = isset($data['smtpBlacklistSender']) ? $data['smtpBlacklistSender'] : null; } /** @@ -288,6 +294,27 @@ public function setUnlinkListIds($unlinkListIds) return $this; } + + /** + * Gets smtpBlacklistSender + * @return string[] + */ + public function getSmtpBlacklistSender() + { + return $this->container['smtpBlacklistSender']; + } + + /** + * Sets smtpBlacklistSender + * @param string[] $smtpBlacklistSender SMTP forbidden sender for contact. Use only for email Contact + * @return $this + */ + public function setSmtpBlacklistSender($smtpBlacklistSender) + { + $this->container['smtpBlacklistSender'] = $smtpBlacklistSender; + + return $this; + } /** * Returns true if offset exists. False otherwise. * @param integer $offset Offset diff --git a/lib/Model/UpdateEmailCampaign.php b/lib/Model/UpdateEmailCampaign.php index 47dbafcb..d3d8db60 100644 --- a/lib/Model/UpdateEmailCampaign.php +++ b/lib/Model/UpdateEmailCampaign.php @@ -372,7 +372,7 @@ public function getScheduledAt() /** * Sets scheduledAt - * @param \DateTime $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) + * @param \DateTime $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. * @return $this */ public function setScheduledAt($scheduledAt) @@ -477,7 +477,7 @@ public function getAttachmentUrl() /** * Sets attachmentUrl - * @param string $attachmentUrl Absolute url of the attachment. Url not allowed from local machine. File must be hosted somewhere.Possilbe extension values are xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf + * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps * @return $this */ public function setAttachmentUrl($attachmentUrl) diff --git a/lib/Model/UpdateSmsCampaign.php b/lib/Model/UpdateSmsCampaign.php index 371fcb5e..dc479fdc 100644 --- a/lib/Model/UpdateSmsCampaign.php +++ b/lib/Model/UpdateSmsCampaign.php @@ -290,7 +290,7 @@ public function getScheduledAt() /** * Sets scheduledAt - * @param \DateTime $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) + * @param \DateTime $scheduledAt UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. * @return $this */ public function setScheduledAt($scheduledAt) diff --git a/lib/Model/UpdateSmtpTemplate.php b/lib/Model/UpdateSmtpTemplate.php index daeb54b7..a7202d17 100644 --- a/lib/Model/UpdateSmtpTemplate.php +++ b/lib/Model/UpdateSmtpTemplate.php @@ -393,7 +393,7 @@ public function getAttachmentUrl() /** * Sets attachmentUrl - * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf + * @param string $attachmentUrl Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps * @return $this */ public function setAttachmentUrl($attachmentUrl) diff --git a/test/Api/EmailCampaignsApiTest.php b/test/Api/EmailCampaignsApiTest.php index 7ec056b9..d742a6ab 100644 --- a/test/Api/EmailCampaignsApiTest.php +++ b/test/Api/EmailCampaignsApiTest.php @@ -83,12 +83,12 @@ public function testCreateEmailCampaign() } /** - * Test case for deleteEmailCampaigns + * Test case for deleteEmailCampaign * * Delete an email campaign. * */ - public function testDeleteEmailCampaigns() + public function testDeleteEmailCampaign() { } @@ -163,12 +163,12 @@ public function testUpdateCampaignStatus() } /** - * Test case for updateEmailCampaigns + * Test case for updateEmailCampaign * * Update a campaign. * */ - public function testUpdateEmailCampaigns() + public function testUpdateEmailCampaign() { } } diff --git a/test/Api/SMSCampaignsApiTest.php b/test/Api/SMSCampaignsApiTest.php index fd4fe446..e473a685 100644 --- a/test/Api/SMSCampaignsApiTest.php +++ b/test/Api/SMSCampaignsApiTest.php @@ -73,72 +73,72 @@ public static function tearDownAfterClass() } /** - * Test case for createSMSCampaign + * Test case for createSmsCampaign * * Creates an SMS campaign. * */ - public function testCreateSMSCampaign() + public function testCreateSmsCampaign() { } /** - * Test case for deleteSMSCampaigns + * Test case for deleteSmsCampaign * * Delete the SMS campaign. * */ - public function testDeleteSMSCampaigns() + public function testDeleteSmsCampaign() { } /** - * Test case for getSMSCampaigns + * Test case for getSmsCampaign * - * Returns the informations for all your created SMS campaigns. + * Get an SMS campaign. * */ - public function testGetSMSCampaigns() + public function testGetSmsCampaign() { } /** - * Test case for getSmsCampaign + * Test case for getSmsCampaigns * - * Get an SMS campaign. + * Returns the informations for all your created SMS campaigns. * */ - public function testGetSmsCampaign() + public function testGetSmsCampaigns() { } /** - * Test case for requestSMSRecipientExport + * Test case for requestSmsRecipientExport * * Exports the recipients of the specified campaign.. * */ - public function testRequestSMSRecipientExport() + public function testRequestSmsRecipientExport() { } /** - * Test case for sendSMSCampaignNow + * Test case for sendSmsCampaignNow * * Send your SMS campaign immediately. * */ - public function testSendSMSCampaignNow() + public function testSendSmsCampaignNow() { } /** - * Test case for sendSMSReport + * Test case for sendSmsReport * * Send report of SMS campaigns. * */ - public function testSendSMSReport() + public function testSendSmsReport() { } @@ -153,22 +153,22 @@ public function testSendTestSms() } /** - * Test case for updateSMSCampaignStatus + * Test case for updateSmsCampaign * - * Update the campaign status. + * Updates an SMS campaign. * */ - public function testUpdateSMSCampaignStatus() + public function testUpdateSmsCampaign() { } /** - * Test case for updateSmsCampaign + * Test case for updateSmsCampaignStatus * - * Updates an SMS campaign. + * Update the campaign status. * */ - public function testUpdateSmsCampaign() + public function testUpdateSmsCampaignStatus() { } } diff --git a/test/Model/CreateContactTest.php b/test/Model/CreateContactTest.php index 933a0413..bdbd7a6a 100644 --- a/test/Model/CreateContactTest.php +++ b/test/Model/CreateContactTest.php @@ -118,4 +118,11 @@ public function testPropertyListIds() public function testPropertyUpdateEnabled() { } + + /** + * Test attribute "smtpBlacklistSender" + */ + public function testPropertySmtpBlacklistSender() + { + } } diff --git a/test/Model/GetCampaignRecipientsExclusionListsTest.php b/test/Model/GetCampaignRecipientsExclusionListsTest.php deleted file mode 100644 index cec9b2fb..00000000 --- a/test/Model/GetCampaignRecipientsExclusionListsTest.php +++ /dev/null @@ -1,93 +0,0 @@ -