Skip to content

New reseller route to update settings of reseller's child account #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 27, 2019
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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,9 @@ Class | Method | HTTP request | Description
*ResellerApi* | [**getChildDomains**](docs/Api/ResellerApi.md#getchilddomains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
*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* | [**getSsoToken**](docs/Api/ResellerApi.md#getssotoken) | **GET** /reseller/children/{childAuthKey}/auth | Generates a session token which will remain valid for a short period of time only.
*ResellerApi* | [**getSsoToken**](docs/Api/ResellerApi.md#getssotoken) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
*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* | [**updateChildAccountStatus**](docs/Api/ResellerApi.md#updatechildaccountstatus) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied
*ResellerApi* | [**updateChildDomain**](docs/Api/ResellerApi.md#updatechilddomain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
*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
Expand Down Expand Up @@ -327,6 +328,7 @@ Class | Method | HTTP request | Description
- [UpdateAttributeEnumeration](docs/Model/UpdateAttributeEnumeration.md)
- [UpdateCampaignStatus](docs/Model/UpdateCampaignStatus.md)
- [UpdateChild](docs/Model/UpdateChild.md)
- [UpdateChildAccountStatus](docs/Model/UpdateChildAccountStatus.md)
- [UpdateChildDomain](docs/Model/UpdateChildDomain.md)
- [UpdateContact](docs/Model/UpdateContact.md)
- [UpdateEmailCampaign](docs/Model/UpdateEmailCampaign.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/Api/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ $apiInstance = new SendinBlue\Client\Api\ContactsApi(
new GuzzleHttp\Client(),
$config
);
$email = "email_example"; // string | Email (urlencoded) of the contact
$email = "email_example"; // string | Email (urlencoded) of the contact OR its SMS attribute value

try {
$result = $apiInstance->getContactInfo($email);
Expand All @@ -641,7 +641,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**email** | **string**| Email (urlencoded) of the contact |
**email** | **string**| Email (urlencoded) of the contact OR its SMS attribute value |

### Return type

Expand Down
65 changes: 63 additions & 2 deletions docs/Api/ResellerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ Method | HTTP request | Description
[**getChildDomains**](ResellerApi.md#getChildDomains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
[**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
[**getSsoToken**](ResellerApi.md#getSsoToken) | **GET** /reseller/children/{childAuthKey}/auth | Generates a session token which will remain valid for a short period of time only.
[**getSsoToken**](ResellerApi.md#getSsoToken) | **GET** /reseller/children/{childAuthKey}/auth | Get session token to access Sendinblue (SSO)
[**removeCredits**](ResellerApi.md#removeCredits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
[**updateChildAccountStatus**](ResellerApi.md#updateChildAccountStatus) | **PUT** /reseller/children/{childAuthKey}/accountStatus | Updates infos of reseller's child account status based on the childAuthKey supplied
[**updateChildDomain**](ResellerApi.md#updateChildDomain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
[**updateResellerChild**](ResellerApi.md#updateResellerChild) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied

Expand Down Expand Up @@ -594,7 +595,9 @@ This endpoint does not need any parameter.
# **getSsoToken**
> \SendinBlue\Client\Model\GetSsoToken getSsoToken($childAuthKey)

Generates a session token which will remain valid for a short period of time only.
Get session token to access Sendinblue (SSO)

It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]

### Example
```php
Expand Down Expand Up @@ -707,6 +710,64 @@ 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)

# **updateChildAccountStatus**
> updateChildAccountStatus($childAuthKey, $updateChildAccountStatus)

Updates infos of reseller's child account status based on the childAuthKey supplied

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: partner-key
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer');

$apiInstance = new SendinBlue\Client\Api\ResellerApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$childAuthKey = "childAuthKey_example"; // string | auth key of reseller's child
$updateChildAccountStatus = new \SendinBlue\Client\Model\UpdateChildAccountStatus(); // \SendinBlue\Client\Model\UpdateChildAccountStatus | values to update in child account status

try {
$apiInstance->updateChildAccountStatus($childAuthKey, $updateChildAccountStatus);
} catch (Exception $e) {
echo 'Exception when calling ResellerApi->updateChildAccountStatus: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**childAuthKey** | **string**| auth key of reseller&#39;s child |
**updateChildAccountStatus** | [**\SendinBlue\Client\Model\UpdateChildAccountStatus**](../Model/UpdateChildAccountStatus.md)| values to update in child account status |

### Return type

void (empty response body)

### Authorization

[api-key](../../README.md#api-key), [partner-key](../../README.md#partner-key)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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

# **updateChildDomain**
> updateChildDomain($childAuthKey, $domainName, $updateChildDomain)

Expand Down
12 changes: 12 additions & 0 deletions docs/Model/UpdateChildAccountStatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# UpdateChildAccountStatus

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**transactionalEmail** | **bool** | Status of Transactional Email (SMTP) Platform activation for your account (true&#x3D;enabled, false&#x3D;disabled) | [optional]
**transactionalSms** | **bool** | Status of Transactional SMS Platform activation for your account (true&#x3D;enabled, false&#x3D;disabled) | [optional]
**marketingAutomation** | **bool** | Status of Marketing Automation Platform activation for your account (true&#x3D;enabled, false&#x3D;disabled) | [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)


10 changes: 5 additions & 5 deletions lib/Api/ContactsApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -2782,7 +2782,7 @@ protected function getAttributesRequest()
*
* Retrieves contact informations
*
* @param string $email Email (urlencoded) of the contact (required)
* @param string $email Email (urlencoded) of the contact OR its SMS attribute value (required)
*
* @throws \SendinBlue\Client\ApiException on non-2xx response
* @throws \InvalidArgumentException
Expand All @@ -2799,7 +2799,7 @@ public function getContactInfo($email)
*
* Retrieves contact informations
*
* @param string $email Email (urlencoded) of the contact (required)
* @param string $email Email (urlencoded) of the contact OR its SMS attribute value (required)
*
* @throws \SendinBlue\Client\ApiException on non-2xx response
* @throws \InvalidArgumentException
Expand Down Expand Up @@ -2890,7 +2890,7 @@ public function getContactInfoWithHttpInfo($email)
*
* Retrieves contact informations
*
* @param string $email Email (urlencoded) of the contact (required)
* @param string $email Email (urlencoded) of the contact OR its SMS attribute value (required)
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
Expand All @@ -2910,7 +2910,7 @@ function ($response) {
*
* Retrieves contact informations
*
* @param string $email Email (urlencoded) of the contact (required)
* @param string $email Email (urlencoded) of the contact OR its SMS attribute value (required)
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface
Expand Down Expand Up @@ -2960,7 +2960,7 @@ function ($exception) {
/**
* Create request for operation 'getContactInfo'
*
* @param string $email Email (urlencoded) of the contact (required)
* @param string $email Email (urlencoded) of the contact OR its SMS attribute value (required)
*
* @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request
Expand Down
Loading