Skip to content

Commit 189adc1

Browse files
ekta-slitekta-slit
committed
Contact attribute + SendSms + ErrorModel spec updates
1 parent 8c93479 commit 189adc1

27 files changed

+1372
-293
lines changed

‎README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,16 @@ All URIs are relative to *https://api.sendinblue.com/v3*
8686
Class | Method | HTTP request | Description
8787
------------ | ------------- | ------------- | -------------
8888
*AccountApi* | [**getAccount**](docs/Api/AccountApi.md#getaccount) | **GET** /account | Get your account informations, plans and credits details
89-
*AttributesApi* | [**createAttribute**](docs/Api/AttributesApi.md#createattribute) | **POST** /contacts/attributes | Creates contact attributes
90-
*AttributesApi* | [**deleteAttribute**](docs/Api/AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
89+
*AttributesApi* | [**createAttribute**](docs/Api/AttributesApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
90+
*AttributesApi* | [**deleteAttribute**](docs/Api/AttributesApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
9191
*AttributesApi* | [**getAttributes**](docs/Api/AttributesApi.md#getattributes) | **GET** /contacts/attributes | Lists all attributes
92+
*AttributesApi* | [**updateAttribute**](docs/Api/AttributesApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
9293
*ContactsApi* | [**addContactToList**](docs/Api/ContactsApi.md#addcontacttolist) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
93-
*ContactsApi* | [**createAttribute**](docs/Api/ContactsApi.md#createattribute) | **POST** /contacts/attributes | Creates contact attributes
94+
*ContactsApi* | [**createAttribute**](docs/Api/ContactsApi.md#createattribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
9495
*ContactsApi* | [**createContact**](docs/Api/ContactsApi.md#createcontact) | **POST** /contacts | Create a contact
9596
*ContactsApi* | [**createFolder**](docs/Api/ContactsApi.md#createfolder) | **POST** /contacts/folders | Create a folder
9697
*ContactsApi* | [**createList**](docs/Api/ContactsApi.md#createlist) | **POST** /contacts/lists | Create a list
97-
*ContactsApi* | [**deleteAttribute**](docs/Api/ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
98+
*ContactsApi* | [**deleteAttribute**](docs/Api/ContactsApi.md#deleteattribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
9899
*ContactsApi* | [**deleteFolder**](docs/Api/ContactsApi.md#deletefolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
99100
*ContactsApi* | [**deleteList**](docs/Api/ContactsApi.md#deletelist) | **DELETE** /contacts/lists/{listId} | Delete a list
100101
*ContactsApi* | [**getAttributes**](docs/Api/ContactsApi.md#getattributes) | **GET** /contacts/attributes | Lists all attributes
@@ -110,6 +111,7 @@ Class | Method | HTTP request | Description
110111
*ContactsApi* | [**importContacts**](docs/Api/ContactsApi.md#importcontacts) | **POST** /contacts/import | Import contacts
111112
*ContactsApi* | [**removeContactToList**](docs/Api/ContactsApi.md#removecontacttolist) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
112113
*ContactsApi* | [**requestContactExport**](docs/Api/ContactsApi.md#requestcontactexport) | **POST** /contacts/export | Export contacts
114+
*ContactsApi* | [**updateAttribute**](docs/Api/ContactsApi.md#updateattribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
113115
*ContactsApi* | [**updateContact**](docs/Api/ContactsApi.md#updatecontact) | **PUT** /contacts/{email} | Updates a contact
114116
*ContactsApi* | [**updateFolder**](docs/Api/ContactsApi.md#updatefolder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
115117
*ContactsApi* | [**updateList**](docs/Api/ContactsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list
@@ -193,7 +195,7 @@ Class | Method | HTTP request | Description
193195
- [AddCredits](docs/Model/AddCredits.md)
194196
- [AddRemoveContactToList](docs/Model/AddRemoveContactToList.md)
195197
- [CreateAttribute](docs/Model/CreateAttribute.md)
196-
- [CreateAttributeEnumemaration](docs/Model/CreateAttributeEnumemaration.md)
198+
- [CreateAttributeEnumeration](docs/Model/CreateAttributeEnumeration.md)
197199
- [CreateChild](docs/Model/CreateChild.md)
198200
- [CreateContact](docs/Model/CreateContact.md)
199201
- [CreateEmailCampaign](docs/Model/CreateEmailCampaign.md)
@@ -316,6 +318,8 @@ Class | Method | HTTP request | Description
316318
- [SendTestEmail](docs/Model/SendTestEmail.md)
317319
- [SendTestSms](docs/Model/SendTestSms.md)
318320
- [SendTransacSms](docs/Model/SendTransacSms.md)
321+
- [UpdateAttribute](docs/Model/UpdateAttribute.md)
322+
- [UpdateAttributeEnumeration](docs/Model/UpdateAttributeEnumeration.md)
319323
- [UpdateCampaignStatus](docs/Model/UpdateCampaignStatus.md)
320324
- [UpdateChild](docs/Model/UpdateChild.md)
321325
- [UpdateContact](docs/Model/UpdateContact.md)

‎composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
},
3838
"extra": {
3939
"branch-alias": {
40-
"dev-master": "2.0.x-dev"
40+
"dev-master": "2.1.x-dev"
4141
}
4242
}
4343
}

‎docs/Api/AttributesApi.md

Lines changed: 68 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ All URIs are relative to *https://api.sendinblue.com/v3*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**createAttribute**](AttributesApi.md#createAttribute) | **POST** /contacts/attributes | Creates contact attributes
8-
[**deleteAttribute**](AttributesApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
7+
[**createAttribute**](AttributesApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
8+
[**deleteAttribute**](AttributesApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
99
[**getAttributes**](AttributesApi.md#getAttributes) | **GET** /contacts/attributes | Lists all attributes
10+
[**updateAttribute**](AttributesApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
1011

1112

1213
# **createAttribute**
13-
> \SendinBlue\Client\Model\CreateModel createAttribute($createAttribute)
14+
> createAttribute($attributeCategory, $attributeName, $createAttribute)
1415
15-
Creates contact attributes
16+
Creates contact attribute
1617

1718
### Example
1819
```php
@@ -25,11 +26,12 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
2526
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
2627

2728
$api_instance = new SendinBlue\Client\Api\AttributesApi();
29+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
30+
$attributeName = "attributeName_example"; // string | Name of the attribute
2831
$createAttribute = new \SendinBlue\Client\Model\CreateAttribute(); // \SendinBlue\Client\Model\CreateAttribute | Values to create an attribute
2932

3033
try {
31-
$result = $api_instance->createAttribute($createAttribute);
32-
print_r($result);
34+
$api_instance->createAttribute($attributeCategory, $attributeName, $createAttribute);
3335
} catch (Exception $e) {
3436
echo 'Exception when calling AttributesApi->createAttribute: ', $e->getMessage(), PHP_EOL;
3537
}
@@ -40,11 +42,13 @@ try {
4042

4143
Name | Type | Description | Notes
4244
------------- | ------------- | ------------- | -------------
45+
**attributeCategory** | **string**| Category of the attribute |
46+
**attributeName** | **string**| Name of the attribute |
4347
**createAttribute** | [**\SendinBlue\Client\Model\CreateAttribute**](../Model/CreateAttribute.md)| Values to create an attribute |
4448

4549
### Return type
4650

47-
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
51+
void (empty response body)
4852

4953
### Authorization
5054

@@ -58,7 +62,7 @@ Name | Type | Description | Notes
5862
[[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)
5963

6064
# **deleteAttribute**
61-
> deleteAttribute($attributeId)
65+
> deleteAttribute($attributeCategory, $attributeName)
6266
6367
Deletes an attribute
6468

@@ -73,10 +77,11 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
7377
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
7478

7579
$api_instance = new SendinBlue\Client\Api\AttributesApi();
76-
$attributeId = 789; // int | id of the attribute
80+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
81+
$attributeName = "attributeName_example"; // string | Name of the existing attribute
7782

7883
try {
79-
$api_instance->deleteAttribute($attributeId);
84+
$api_instance->deleteAttribute($attributeCategory, $attributeName);
8085
} catch (Exception $e) {
8186
echo 'Exception when calling AttributesApi->deleteAttribute: ', $e->getMessage(), PHP_EOL;
8287
}
@@ -87,7 +92,8 @@ try {
8792

8893
Name | Type | Description | Notes
8994
------------- | ------------- | ------------- | -------------
90-
**attributeId** | **int**| id of the attribute |
95+
**attributeCategory** | **string**| Category of the attribute |
96+
**attributeName** | **string**| Name of the existing attribute |
9197

9298
### Return type
9399

@@ -148,3 +154,54 @@ This endpoint does not need any parameter.
148154

149155
[[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)
150156

157+
# **updateAttribute**
158+
> updateAttribute($attributeCategory, $attributeName, $updateAttribute)
159+
160+
Updates contact attribute
161+
162+
### Example
163+
```php
164+
<?php
165+
require_once(__DIR__ . '/vendor/autoload.php');
166+
167+
// Configure API key authorization: api-key
168+
SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
169+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
170+
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
171+
172+
$api_instance = new SendinBlue\Client\Api\AttributesApi();
173+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
174+
$attributeName = "attributeName_example"; // string | Name of the existing attribute
175+
$updateAttribute = new \SendinBlue\Client\Model\UpdateAttribute(); // \SendinBlue\Client\Model\UpdateAttribute | Values to update an attribute
176+
177+
try {
178+
$api_instance->updateAttribute($attributeCategory, $attributeName, $updateAttribute);
179+
} catch (Exception $e) {
180+
echo 'Exception when calling AttributesApi->updateAttribute: ', $e->getMessage(), PHP_EOL;
181+
}
182+
?>
183+
```
184+
185+
### Parameters
186+
187+
Name | Type | Description | Notes
188+
------------- | ------------- | ------------- | -------------
189+
**attributeCategory** | **string**| Category of the attribute |
190+
**attributeName** | **string**| Name of the existing attribute |
191+
**updateAttribute** | [**\SendinBlue\Client\Model\UpdateAttribute**](../Model/UpdateAttribute.md)| Values to update an attribute |
192+
193+
### Return type
194+
195+
void (empty response body)
196+
197+
### Authorization
198+
199+
[api-key](../../README.md#api-key)
200+
201+
### HTTP request headers
202+
203+
- **Content-Type**: application/json
204+
- **Accept**: application/json
205+
206+
[[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)
207+

‎docs/Api/ContactsApi.md

Lines changed: 68 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ All URIs are relative to *https://api.sendinblue.com/v3*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**addContactToList**](ContactsApi.md#addContactToList) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
8-
[**createAttribute**](ContactsApi.md#createAttribute) | **POST** /contacts/attributes | Creates contact attributes
8+
[**createAttribute**](ContactsApi.md#createAttribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
99
[**createContact**](ContactsApi.md#createContact) | **POST** /contacts | Create a contact
1010
[**createFolder**](ContactsApi.md#createFolder) | **POST** /contacts/folders | Create a folder
1111
[**createList**](ContactsApi.md#createList) | **POST** /contacts/lists | Create a list
12-
[**deleteAttribute**](ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
12+
[**deleteAttribute**](ContactsApi.md#deleteAttribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
1313
[**deleteFolder**](ContactsApi.md#deleteFolder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
1414
[**deleteList**](ContactsApi.md#deleteList) | **DELETE** /contacts/lists/{listId} | Delete a list
1515
[**getAttributes**](ContactsApi.md#getAttributes) | **GET** /contacts/attributes | Lists all attributes
@@ -25,6 +25,7 @@ Method | HTTP request | Description
2525
[**importContacts**](ContactsApi.md#importContacts) | **POST** /contacts/import | Import contacts
2626
[**removeContactToList**](ContactsApi.md#removeContactToList) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
2727
[**requestContactExport**](ContactsApi.md#requestContactExport) | **POST** /contacts/export | Export contacts
28+
[**updateAttribute**](ContactsApi.md#updateAttribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
2829
[**updateContact**](ContactsApi.md#updateContact) | **PUT** /contacts/{email} | Updates a contact
2930
[**updateFolder**](ContactsApi.md#updateFolder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
3031
[**updateList**](ContactsApi.md#updateList) | **PUT** /contacts/lists/{listId} | Update a list
@@ -81,9 +82,9 @@ Name | Type | Description | Notes
8182
[[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)
8283

8384
# **createAttribute**
84-
> \SendinBlue\Client\Model\CreateModel createAttribute($createAttribute)
85+
> createAttribute($attributeCategory, $attributeName, $createAttribute)
8586
86-
Creates contact attributes
87+
Creates contact attribute
8788

8889
### Example
8990
```php
@@ -96,11 +97,12 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
9697
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
9798

9899
$api_instance = new SendinBlue\Client\Api\ContactsApi();
100+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
101+
$attributeName = "attributeName_example"; // string | Name of the attribute
99102
$createAttribute = new \SendinBlue\Client\Model\CreateAttribute(); // \SendinBlue\Client\Model\CreateAttribute | Values to create an attribute
100103

101104
try {
102-
$result = $api_instance->createAttribute($createAttribute);
103-
print_r($result);
105+
$api_instance->createAttribute($attributeCategory, $attributeName, $createAttribute);
104106
} catch (Exception $e) {
105107
echo 'Exception when calling ContactsApi->createAttribute: ', $e->getMessage(), PHP_EOL;
106108
}
@@ -111,11 +113,13 @@ try {
111113

112114
Name | Type | Description | Notes
113115
------------- | ------------- | ------------- | -------------
116+
**attributeCategory** | **string**| Category of the attribute |
117+
**attributeName** | **string**| Name of the attribute |
114118
**createAttribute** | [**\SendinBlue\Client\Model\CreateAttribute**](../Model/CreateAttribute.md)| Values to create an attribute |
115119

116120
### Return type
117121

118-
[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
122+
void (empty response body)
119123

120124
### Authorization
121125

@@ -273,7 +277,7 @@ Name | Type | Description | Notes
273277
[[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)
274278

275279
# **deleteAttribute**
276-
> deleteAttribute($attributeId)
280+
> deleteAttribute($attributeCategory, $attributeName)
277281
278282
Deletes an attribute
279283

@@ -288,10 +292,11 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
288292
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
289293

290294
$api_instance = new SendinBlue\Client\Api\ContactsApi();
291-
$attributeId = 789; // int | id of the attribute
295+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
296+
$attributeName = "attributeName_example"; // string | Name of the existing attribute
292297

293298
try {
294-
$api_instance->deleteAttribute($attributeId);
299+
$api_instance->deleteAttribute($attributeCategory, $attributeName);
295300
} catch (Exception $e) {
296301
echo 'Exception when calling ContactsApi->deleteAttribute: ', $e->getMessage(), PHP_EOL;
297302
}
@@ -302,7 +307,8 @@ try {
302307

303308
Name | Type | Description | Notes
304309
------------- | ------------- | ------------- | -------------
305-
**attributeId** | **int**| id of the attribute |
310+
**attributeCategory** | **string**| Category of the attribute |
311+
**attributeName** | **string**| Name of the existing attribute |
306312

307313
### Return type
308314

@@ -1057,6 +1063,57 @@ Name | Type | Description | Notes
10571063

10581064
[[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)
10591065

1066+
# **updateAttribute**
1067+
> updateAttribute($attributeCategory, $attributeName, $updateAttribute)
1068+
1069+
Updates contact attribute
1070+
1071+
### Example
1072+
```php
1073+
<?php
1074+
require_once(__DIR__ . '/vendor/autoload.php');
1075+
1076+
// Configure API key authorization: api-key
1077+
SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
1078+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1079+
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
1080+
1081+
$api_instance = new SendinBlue\Client\Api\ContactsApi();
1082+
$attributeCategory = "attributeCategory_example"; // string | Category of the attribute
1083+
$attributeName = "attributeName_example"; // string | Name of the existing attribute
1084+
$updateAttribute = new \SendinBlue\Client\Model\UpdateAttribute(); // \SendinBlue\Client\Model\UpdateAttribute | Values to update an attribute
1085+
1086+
try {
1087+
$api_instance->updateAttribute($attributeCategory, $attributeName, $updateAttribute);
1088+
} catch (Exception $e) {
1089+
echo 'Exception when calling ContactsApi->updateAttribute: ', $e->getMessage(), PHP_EOL;
1090+
}
1091+
?>
1092+
```
1093+
1094+
### Parameters
1095+
1096+
Name | Type | Description | Notes
1097+
------------- | ------------- | ------------- | -------------
1098+
**attributeCategory** | **string**| Category of the attribute |
1099+
**attributeName** | **string**| Name of the existing attribute |
1100+
**updateAttribute** | [**\SendinBlue\Client\Model\UpdateAttribute**](../Model/UpdateAttribute.md)| Values to update an attribute |
1101+
1102+
### Return type
1103+
1104+
void (empty response body)
1105+
1106+
### Authorization
1107+
1108+
[api-key](../../README.md#api-key)
1109+
1110+
### HTTP request headers
1111+
1112+
- **Content-Type**: application/json
1113+
- **Accept**: application/json
1114+
1115+
[[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)
1116+
10601117
# **updateContact**
10611118
> updateContact($email, $updateContact)
10621119

0 commit comments

Comments
 (0)