Skip to content

Commit

Permalink
Merge pull request #37 from sendinblue/feature_fix-stats-emailCamps
Browse files Browse the repository at this point in the history 
Type object fix in GET call
  • Loading branch information
@ekta-slit
ekta-slit committed Mar 21, 2018
2 parents 95d935c + 5b11f72 commit 4886771
Show file tree
Hide file tree
Showing 34 changed files with 1,277 additions and 398 deletions.
18 changes: 10 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,15 +142,15 @@ Class | Method | HTTP request | Description
*ListsApi* | [**updateList**](docs/Api/ListsApi.md#updatelist) | **PUT** /contacts/lists/{listId} | Update a list
*ProcessApi* | [**getProcess**](docs/Api/ProcessApi.md#getprocess) | **GET** /processes/{processId} | Return the informations for a process
*ProcessApi* | [**getProcesses**](docs/Api/ProcessApi.md#getprocesses) | **GET** /processes | Return all the processes for your account
*ResellerApi* | [**addCredits**](docs/Api/ResellerApi.md#addcredits) | **POST** /reseller/children/{childId}/credits/add | Add Email and/or SMS credits to a specific child account
*ResellerApi* | [**associateIpToChild**](docs/Api/ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childId}/ips/associate | Associate a dedicated IP to the child
*ResellerApi* | [**addCredits**](docs/Api/ResellerApi.md#addcredits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
*ResellerApi* | [**associateIpToChild**](docs/Api/ResellerApi.md#associateiptochild) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
*ResellerApi* | [**createResellerChild**](docs/Api/ResellerApi.md#createresellerchild) | **POST** /reseller/children | Creates a reseller child
*ResellerApi* | [**deleteResellerChild**](docs/Api/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childId} | Deletes a single reseller child based on the childId supplied
*ResellerApi* | [**dissociateIpFromChild**](docs/Api/ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childId}/ips/dissociate | Dissociate a dedicated IP to the child
*ResellerApi* | [**getChildInfo**](docs/Api/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childId} | Gets the info about a specific child account
*ResellerApi* | [**deleteResellerChild**](docs/Api/ResellerApi.md#deleteresellerchild) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
*ResellerApi* | [**dissociateIpFromChild**](docs/Api/ResellerApi.md#dissociateipfromchild) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
*ResellerApi* | [**getChildInfo**](docs/Api/ResellerApi.md#getchildinfo) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
*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
*ResellerApi* | [**removeCredits**](docs/Api/ResellerApi.md#removecredits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
*ResellerApi* | [**updateResellerChild**](docs/Api/ResellerApi.md#updateresellerchild) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
*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
Expand Down Expand Up @@ -203,6 +203,7 @@ Class | Method | HTTP request | Description
- [CreateEmailCampaignSender](docs/Model/CreateEmailCampaignSender.md)
- [CreateList](docs/Model/CreateList.md)
- [CreateModel](docs/Model/CreateModel.md)
- [CreateReseller](docs/Model/CreateReseller.md)
- [CreateSender](docs/Model/CreateSender.md)
- [CreateSenderIps](docs/Model/CreateSenderIps.md)
- [CreateSenderModel](docs/Model/CreateSenderModel.md)
Expand All @@ -229,8 +230,9 @@ Class | Method | HTTP request | Description
- [GetCampaignRecipients](docs/Model/GetCampaignRecipients.md)
- [GetCampaignStats](docs/Model/GetCampaignStats.md)
- [GetChildInfoApiKeys](docs/Model/GetChildInfoApiKeys.md)
- [GetChildInfoApiKeysV2](docs/Model/GetChildInfoApiKeysV2.md)
- [GetChildInfoApiKeysV3](docs/Model/GetChildInfoApiKeysV3.md)
- [GetChildInfoCredits](docs/Model/GetChildInfoCredits.md)
- [GetChildInfoIps](docs/Model/GetChildInfoIps.md)
- [GetChildInfoStatistics](docs/Model/GetChildInfoStatistics.md)
- [GetChildrenList](docs/Model/GetChildrenList.md)
- [GetClient](docs/Model/GetClient.md)
Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
},
"extra": {
"branch-alias": {
"dev-master": "4.0.x-dev"
"dev-master": "5.0.x-dev"
}
}
}
86 changes: 43 additions & 43 deletions docs/Api/ResellerApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ All URIs are relative to *https://api.sendinblue.com/v3*

Method | HTTP request | Description
------------- | ------------- | -------------
[**addCredits**](ResellerApi.md#addCredits) | **POST** /reseller/children/{childId}/credits/add | Add Email and/or SMS credits to a specific child account
[**associateIpToChild**](ResellerApi.md#associateIpToChild) | **POST** /reseller/children/{childId}/ips/associate | Associate a dedicated IP to the child
[**addCredits**](ResellerApi.md#addCredits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
[**associateIpToChild**](ResellerApi.md#associateIpToChild) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
[**createResellerChild**](ResellerApi.md#createResellerChild) | **POST** /reseller/children | Creates a reseller child
[**deleteResellerChild**](ResellerApi.md#deleteResellerChild) | **DELETE** /reseller/children/{childId} | Deletes a single reseller child based on the childId supplied
[**dissociateIpFromChild**](ResellerApi.md#dissociateIpFromChild) | **POST** /reseller/children/{childId}/ips/dissociate | Dissociate a dedicated IP to the child
[**getChildInfo**](ResellerApi.md#getChildInfo) | **GET** /reseller/children/{childId} | Gets the info about a specific child account
[**deleteResellerChild**](ResellerApi.md#deleteResellerChild) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
[**dissociateIpFromChild**](ResellerApi.md#dissociateIpFromChild) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
[**getChildInfo**](ResellerApi.md#getChildInfo) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
[**getResellerChilds**](ResellerApi.md#getResellerChilds) | **GET** /reseller/children | Gets the list of all reseller's children accounts
[**removeCredits**](ResellerApi.md#removeCredits) | **POST** /reseller/children/{childId}/credits/remove | Remove Email and/or SMS credits from a specific child account
[**updateResellerChild**](ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childId} | Updates infos of reseller's child based on the childId supplied
[**removeCredits**](ResellerApi.md#removeCredits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
[**updateResellerChild**](ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied


# **addCredits**
> \SendinBlue\Client\Model\RemainingCreditModel addCredits($childId, $addCredits)
> \SendinBlue\Client\Model\RemainingCreditModel addCredits($childAuthKey, $addCredits)
Add Email and/or SMS credits to a specific child account

Expand All @@ -31,11 +31,11 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new SendinBlue\Client\Api\ResellerApi();
$childId = 789; // int | id of reseller's child
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child
$addCredits = new \SendinBlue\Client\Model\AddCredits(); // \SendinBlue\Client\Model\AddCredits | Values to post to add credit to a specific child account

try {
$result = $api_instance->addCredits($childId, $addCredits);
$result = $api_instance->addCredits($childAuthKey, $addCredits);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ResellerApi->addCredits: ', $e->getMessage(), PHP_EOL;
Expand All @@ -47,7 +47,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**childId** | **int**| id of reseller's child |
**childAuthKey** | **string**| auth key of reseller's child |
**addCredits** | [**\SendinBlue\Client\Model\AddCredits**](../Model/AddCredits.md)| Values to post to add credit to a specific child account |

### Return type
Expand All @@ -66,7 +66,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)

# **associateIpToChild**
> associateIpToChild($childId, $ipId)
> associateIpToChild($childAuthKey, $ip)
Associate a dedicated IP to the child

Expand All @@ -81,11 +81,11 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new SendinBlue\Client\Api\ResellerApi();
$childId = 789; // int | id of reseller's child
$ipId = new \SendinBlue\Client\Model\ManageIp(); // \SendinBlue\Client\Model\ManageIp | IP's id
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child
$ip = new \SendinBlue\Client\Model\ManageIp(); // \SendinBlue\Client\Model\ManageIp | IP to associate

try {
$api_instance->associateIpToChild($childId, $ipId);
$api_instance->associateIpToChild($childAuthKey, $ip);
} catch (Exception $e) {
echo 'Exception when calling ResellerApi->associateIpToChild: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -96,8 +96,8 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**childId** | **int**| id of reseller's child |
**ipId** | [**\SendinBlue\Client\Model\ManageIp**](../Model/ManageIp.md)| IP's id |
**childAuthKey** | **string**| auth key of reseller's child |
**ip** | [**\SendinBlue\Client\Model\ManageIp**](../Model/ManageIp.md)| IP to associate |

### Return type

Expand All @@ -115,7 +115,7 @@ 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)

# **createResellerChild**
> \SendinBlue\Client\Model\CreateModel createResellerChild($resellerChild)
> \SendinBlue\Client\Model\CreateReseller createResellerChild($resellerChild)
Creates a reseller child

Expand Down Expand Up @@ -149,7 +149,7 @@ Name | Type | Description | Notes

### Return type

[**\SendinBlue\Client\Model\CreateModel**](../Model/CreateModel.md)
[**\SendinBlue\Client\Model\CreateReseller**](../Model/CreateReseller.md)

### Authorization

Expand All @@ -163,9 +163,9 @@ 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)

# **deleteResellerChild**
> deleteResellerChild($childId)
> deleteResellerChild($childAuthKey)
Deletes a single reseller child based on the childId supplied
Deletes a single reseller child based on the childAuthKey supplied

### Example
```php
Expand All @@ -178,10 +178,10 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new SendinBlue\Client\Api\ResellerApi();
$childId = 789; // int | id of reseller's child
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child

try {
$api_instance->deleteResellerChild($childId);
$api_instance->deleteResellerChild($childAuthKey);
} catch (Exception $e) {
echo 'Exception when calling ResellerApi->deleteResellerChild: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -192,7 +192,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**childId** | **int**| id of reseller's child |
**childAuthKey** | **string**| auth key of reseller's child |

### Return type

Expand All @@ -210,7 +210,7 @@ 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)

# **dissociateIpFromChild**
> dissociateIpFromChild($childId, $ipId)
> dissociateIpFromChild($childAuthKey, $ip)
Dissociate a dedicated IP to the child

Expand All @@ -225,11 +225,11 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new SendinBlue\Client\Api\ResellerApi();
$childId = 789; // int | id of reseller's child
$ipId = new \SendinBlue\Client\Model\ManageIp(); // \SendinBlue\Client\Model\ManageIp | IP's id
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child
$ip = new \SendinBlue\Client\Model\ManageIp(); // \SendinBlue\Client\Model\ManageIp | IP to dissociate

try {
$api_instance->dissociateIpFromChild($childId, $ipId);
$api_instance->dissociateIpFromChild($childAuthKey, $ip);
} catch (Exception $e) {
echo 'Exception when calling ResellerApi->dissociateIpFromChild: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -240,8 +240,8 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**childId** | **int**| id of reseller's child |
**ipId** | [**\SendinBlue\Client\Model\ManageIp**](../Model/ManageIp.md)| IP's id |
**childAuthKey** | **string**| auth key of reseller's child |
**ip** | [**\SendinBlue\Client\Model\ManageIp**](../Model/ManageIp.md)| IP to dissociate |

### Return type

Expand All @@ -259,7 +259,7 @@ 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)

# **getChildInfo**
> \SendinBlue\Client\Model\GetChildInfo getChildInfo($childId)
> \SendinBlue\Client\Model\GetChildInfo getChildInfo($childAuthKey)
Gets the info about a specific child account

Expand All @@ -274,10 +274,10 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new SendinBlue\Client\Api\ResellerApi();
$childId = 789; // int | id of reseller's child
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child

try {
$result = $api_instance->getChildInfo($childId);
$result = $api_instance->getChildInfo($childAuthKey);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ResellerApi->getChildInfo: ', $e->getMessage(), PHP_EOL;
Expand All @@ -289,7 +289,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**childId** | **int**| id of reseller's child |
**childAuthKey** | **string**| auth key of reseller's child |

### Return type

Expand Down Expand Up @@ -351,7 +351,7 @@ This endpoint does not need any parameter.
[[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)

# **removeCredits**
> \SendinBlue\Client\Model\RemainingCreditModel removeCredits($childId, $removeCredits)
> \SendinBlue\Client\Model\RemainingCreditModel removeCredits($childAuthKey, $removeCredits)
Remove Email and/or SMS credits from a specific child account

Expand All @@ -366,11 +366,11 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new SendinBlue\Client\Api\ResellerApi();
$childId = 789; // int | id of reseller's child
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child
$removeCredits = new \SendinBlue\Client\Model\RemoveCredits(); // \SendinBlue\Client\Model\RemoveCredits | Values to post to remove email or SMS credits from a specific child account

try {
$result = $api_instance->removeCredits($childId, $removeCredits);
$result = $api_instance->removeCredits($childAuthKey, $removeCredits);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ResellerApi->removeCredits: ', $e->getMessage(), PHP_EOL;
Expand All @@ -382,7 +382,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**childId** | **int**| id of reseller's child |
**childAuthKey** | **string**| auth key of reseller's child |
**removeCredits** | [**\SendinBlue\Client\Model\RemoveCredits**](../Model/RemoveCredits.md)| Values to post to remove email or SMS credits from a specific child account |

### Return type
Expand All @@ -401,9 +401,9 @@ 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)

# **updateResellerChild**
> updateResellerChild($childId, $resellerChild)
> updateResellerChild($childAuthKey, $resellerChild)
Updates infos of reseller's child based on the childId supplied
Updates infos of reseller's child based on the childAuthKey supplied

### Example
```php
Expand All @@ -416,11 +416,11 @@ SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key',
// SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

$api_instance = new SendinBlue\Client\Api\ResellerApi();
$childId = 789; // int | id of reseller's child
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child
$resellerChild = new \SendinBlue\Client\Model\UpdateChild(); // \SendinBlue\Client\Model\UpdateChild | values to update in child profile

try {
$api_instance->updateResellerChild($childId, $resellerChild);
$api_instance->updateResellerChild($childAuthKey, $resellerChild);
} catch (Exception $e) {
echo 'Exception when calling ResellerApi->updateResellerChild: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -431,7 +431,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**childId** | **int**| id of reseller's child |
**childAuthKey** | **string**| auth key of reseller's child |
**resellerChild** | [**\SendinBlue\Client\Model\UpdateChild**](../Model/UpdateChild.md)| values to update in child profile |

### Return type
Expand Down
5 changes: 2 additions & 3 deletions docs/Model/GetChildInfoIps.md → docs/Model/CreateReseller.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# GetChildInfoIps
# CreateReseller

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | ID of the IP |
**ip** | **string** | IP associated to the child account user |
**authKey** | **string** | AuthKey of Reseller child created |

[[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

0 comments on commit 4886771

Please sign in to comment.