Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 57 additions & 57 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions docs/Api/SMSCampaignsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ 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)

# **getSmsCampaigns**
> \SendinBlue\Client\Model\GetSmsCampaigns getSmsCampaigns($status, $limit, $offset)
> \SendinBlue\Client\Model\GetSmsCampaigns getSmsCampaigns($status, $startDate, $endDate, $limit, $offset)

Returns the informations for all your created SMS campaigns

Expand All @@ -198,11 +198,13 @@ $apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
$config
);
$status = "status_example"; // string | Status of campaign.
$startDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
$endDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
$limit = 500; // int | Number limitation for the result returned
$offset = 0; // int | Beginning point in the list to retrieve from.

try {
$result = $apiInstance->getSmsCampaigns($status, $limit, $offset);
$result = $apiInstance->getSmsCampaigns($status, $startDate, $endDate, $limit, $offset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling SMSCampaignsApi->getSmsCampaigns: ', $e->getMessage(), PHP_EOL;
Expand All @@ -215,6 +217,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | **string**| Status of campaign. | [optional]
**startDate** | **\DateTime**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
**endDate** | **\DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [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]

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/CreateEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Name | Type | Description | Notes
**footer** | **string** | Footer of the email campaign | [optional]
**header** | **string** | Header of the email campaign | [optional]
**utmCampaign** | **string** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional]
**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic' | [optional]
**params** | **object** | Pass the set of attributes to customize the type classic campaign. For example, {'FNAME':'Joe', 'LNAME':'Doe'}. Only available if 'type' is 'classic'. It's considered only if campaign is in New Template Language format. The New Template Language is dependent on the values of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField' | [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)

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/CreateSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Name of the campaign |
**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]
**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 |
**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). Prefer to pass your timezone in date-time format for accurate result. | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/CreateSmsCampaignRecipients.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**listIds** | **int[]** | Lists Ids to send the campaign to. REQUIRED if scheduledAt is not empty |
**exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign |
**exclusionListIds** | **int[]** | List ids which have to be excluded from a campaign | [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)

Expand Down
1 change: 1 addition & 0 deletions docs/Model/GetAggregatedReport.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes
**spamReports** | **int** | Number of complaint (spam report) for the timeframe |
**blocked** | **int** | Number of blocked contact emails for the timeframe |
**invalid** | **int** | Number of invalid emails for the timeframe |
**unsubscribed** | **int** | Number of unsubscribed emails for the timeframe |

[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/Model/GetReportsReports.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Notes
**spamReports** | **int** | Number of complaints (spam reports) for the date |
**blocked** | **int** | Number of blocked emails for the date |
**invalid** | **int** | Number of invalid emails for the date |
**unsubscribed** | **int** | Number of unsubscribed emails for the date |

[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

Expand Down
Loading