Skip to content

Commit 303a1c1

Browse files
authored
Merge pull request #59 from sendinblue/feature_params-update
Mixed spec updates
2 parents dc38570 + bc16120 commit 303a1c1

10 files changed

+179
-77
lines changed

composer.lock

Lines changed: 62 additions & 59 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Api/EmailCampaignsApi.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ Name | Type | Description | Notes
230230
[[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)
231231

232232
# **getEmailCampaigns**
233-
> \SendinBlue\Client\Model\GetEmailCampaigns getEmailCampaigns($type, $status, $limit, $offset)
233+
> \SendinBlue\Client\Model\GetEmailCampaigns getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset)
234234
235235
Return all your created campaigns
236236

@@ -252,11 +252,13 @@ $apiInstance = new SendinBlue\Client\Api\EmailCampaignsApi(
252252
);
253253
$type = "type_example"; // string | Filter on the type of the campaigns
254254
$status = "status_example"; // string | Filter on the status of the campaign
255+
$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 email 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' )
256+
$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 email 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' )
255257
$limit = 500; // int | Number of documents per page
256258
$offset = 0; // int | Index of the first document in the page
257259

258260
try {
259-
$result = $apiInstance->getEmailCampaigns($type, $status, $limit, $offset);
261+
$result = $apiInstance->getEmailCampaigns($type, $status, $startDate, $endDate, $limit, $offset);
260262
print_r($result);
261263
} catch (Exception $e) {
262264
echo 'Exception when calling EmailCampaignsApi->getEmailCampaigns: ', $e->getMessage(), PHP_EOL;
@@ -270,6 +272,8 @@ Name | Type | Description | Notes
270272
------------- | ------------- | ------------- | -------------
271273
**type** | **string**| Filter on the type of the campaigns | [optional]
272274
**status** | **string**| Filter on the status of the campaign | [optional]
275+
**startDate** | **\DateTime**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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]
276+
**endDate** | **\DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email 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]
273277
**limit** | **int**| Number of documents per page | [optional] [default to 500]
274278
**offset** | **int**| Index of the first document in the page | [optional] [default to 0]
275279

docs/Model/CreateAttribute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**value** | **string** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional]
77
**enumeration** | [**\SendinBlue\Client\Model\CreateAttributeEnumeration[]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional]
8-
**type** | **string** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
8+
**type** | **string** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional]
99

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

docs/Model/GetEmailCampaign.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Name | Type | Description | Notes
2323
**inlineImageActivation** | **bool** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
2424
**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]
2525
**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]
26+
**sentDate** | [**\DateTime**] | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional]
2627
**recipients** | **object** | |
2728
**statistics** | **object** | |
2829

0 commit comments

Comments
 (0)