Skip to content

Commit f74b3d6

Browse files
Merge pull request sendinblue#30 from sendinblue/feature_updated_swagger_sync
Updated swagger for reseller child domains CRUD operations
2 parents 75e958d + 6f57dc1 commit f74b3d6

21 files changed

+1896
-1
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,11 @@ SibApiV3Sdk.configure do |config|
5959
config.api_key['api-key'] = 'YOUR API KEY'
6060
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
6161
#config.api_key_prefix['api-key'] = 'Bearer'
62+
63+
# Configure API key authorization: partner-key
64+
config.api_key['partner-key'] = 'YOUR API KEY'
65+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
66+
#config.api_key_prefix['partner-key'] = 'Bearer'
6267
end
6368

6469
api_instance = SibApiV3Sdk::AccountApi.new
@@ -139,12 +144,17 @@ Class | Method | HTTP request | Description
139144
*SibApiV3Sdk::ProcessApi* | [**get_processes**](docs/ProcessApi.md#get_processes) | **GET** /processes | Return all the processes for your account
140145
*SibApiV3Sdk::ResellerApi* | [**add_credits**](docs/ResellerApi.md#add_credits) | **POST** /reseller/children/{childAuthKey}/credits/add | Add Email and/or SMS credits to a specific child account
141146
*SibApiV3Sdk::ResellerApi* | [**associate_ip_to_child**](docs/ResellerApi.md#associate_ip_to_child) | **POST** /reseller/children/{childAuthKey}/ips/associate | Associate a dedicated IP to the child
147+
*SibApiV3Sdk::ResellerApi* | [**create_child_domain**](docs/ResellerApi.md#create_child_domain) | **POST** /reseller/children/{childAuthKey}/domains | Creates a domain for a child account
142148
*SibApiV3Sdk::ResellerApi* | [**create_reseller_child**](docs/ResellerApi.md#create_reseller_child) | **POST** /reseller/children | Creates a reseller child
149+
*SibApiV3Sdk::ResellerApi* | [**delete_child_domain**](docs/ResellerApi.md#delete_child_domain) | **DELETE** /reseller/children/{childAuthKey}/domains/{domainName} | Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
143150
*SibApiV3Sdk::ResellerApi* | [**delete_reseller_child**](docs/ResellerApi.md#delete_reseller_child) | **DELETE** /reseller/children/{childAuthKey} | Deletes a single reseller child based on the childAuthKey supplied
144151
*SibApiV3Sdk::ResellerApi* | [**dissociate_ip_from_child**](docs/ResellerApi.md#dissociate_ip_from_child) | **POST** /reseller/children/{childAuthKey}/ips/dissociate | Dissociate a dedicated IP to the child
152+
*SibApiV3Sdk::ResellerApi* | [**get_child_domains**](docs/ResellerApi.md#get_child_domains) | **GET** /reseller/children/{childAuthKey}/domains | Gets all the sender domains of a specific child account
145153
*SibApiV3Sdk::ResellerApi* | [**get_child_info**](docs/ResellerApi.md#get_child_info) | **GET** /reseller/children/{childAuthKey} | Gets the info about a specific child account
146154
*SibApiV3Sdk::ResellerApi* | [**get_reseller_childs**](docs/ResellerApi.md#get_reseller_childs) | **GET** /reseller/children | Gets the list of all reseller's children accounts
155+
*SibApiV3Sdk::ResellerApi* | [**get_sso_token**](docs/ResellerApi.md#get_sso_token) | **GET** /reseller/children/{childAuthKey}/auth | Generates a session token which will remain valid for a short period of time only.
147156
*SibApiV3Sdk::ResellerApi* | [**remove_credits**](docs/ResellerApi.md#remove_credits) | **POST** /reseller/children/{childAuthKey}/credits/remove | Remove Email and/or SMS credits from a specific child account
157+
*SibApiV3Sdk::ResellerApi* | [**update_child_domain**](docs/ResellerApi.md#update_child_domain) | **PUT** /reseller/children/{childAuthKey}/domains/{domainName} | Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
148158
*SibApiV3Sdk::ResellerApi* | [**update_reseller_child**](docs/ResellerApi.md#update_reseller_child) | **PUT** /reseller/children/{childAuthKey} | Updates infos of reseller's child based on the childAuthKey supplied
149159
*SibApiV3Sdk::SMSCampaignsApi* | [**create_sms_campaign**](docs/SMSCampaignsApi.md#create_sms_campaign) | **POST** /smsCampaigns | Creates an SMS campaign
150160
*SibApiV3Sdk::SMSCampaignsApi* | [**delete_sms_campaign**](docs/SMSCampaignsApi.md#delete_sms_campaign) | **DELETE** /smsCampaigns/{campaignId} | Delete the SMS campaign
@@ -187,6 +197,7 @@ Class | Method | HTTP request | Description
187197

188198
## Documentation for Models
189199

200+
- [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
190201
- [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
191202
- [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
192203
- [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
@@ -225,6 +236,8 @@ Class | Method | HTTP request | Description
225236
- [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
226237
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
227238
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
239+
- [SibApiV3Sdk::GetChildDomain](docs/GetChildDomain.md)
240+
- [SibApiV3Sdk::GetChildDomains](docs/GetChildDomains.md)
228241
- [SibApiV3Sdk::GetChildInfoApiKeys](docs/GetChildInfoApiKeys.md)
229242
- [SibApiV3Sdk::GetChildInfoApiKeysV2](docs/GetChildInfoApiKeysV2.md)
230243
- [SibApiV3Sdk::GetChildInfoApiKeysV3](docs/GetChildInfoApiKeysV3.md)
@@ -278,6 +291,7 @@ Class | Method | HTTP request | Description
278291
- [SibApiV3Sdk::GetSmtpTemplateOverview](docs/GetSmtpTemplateOverview.md)
279292
- [SibApiV3Sdk::GetSmtpTemplateOverviewSender](docs/GetSmtpTemplateOverviewSender.md)
280293
- [SibApiV3Sdk::GetSmtpTemplates](docs/GetSmtpTemplates.md)
294+
- [SibApiV3Sdk::GetSsoToken](docs/GetSsoToken.md)
281295
- [SibApiV3Sdk::GetStatsByDomain](docs/GetStatsByDomain.md)
282296
- [SibApiV3Sdk::GetTransacAggregatedSmsReport](docs/GetTransacAggregatedSmsReport.md)
283297
- [SibApiV3Sdk::GetTransacSmsReport](docs/GetTransacSmsReport.md)
@@ -318,6 +332,7 @@ Class | Method | HTTP request | Description
318332
- [SibApiV3Sdk::UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
319333
- [SibApiV3Sdk::UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
320334
- [SibApiV3Sdk::UpdateChild](docs/UpdateChild.md)
335+
- [SibApiV3Sdk::UpdateChildDomain](docs/UpdateChildDomain.md)
321336
- [SibApiV3Sdk::UpdateContact](docs/UpdateContact.md)
322337
- [SibApiV3Sdk::UpdateEmailCampaign](docs/UpdateEmailCampaign.md)
323338
- [SibApiV3Sdk::UpdateEmailCampaignRecipients](docs/UpdateEmailCampaignRecipients.md)
@@ -347,6 +362,12 @@ Class | Method | HTTP request | Description
347362
- **API key parameter name**: api-key
348363
- **Location**: HTTP header
349364

365+
### partner-key
366+
367+
- **Type**: API key
368+
- **API key parameter name**: partner-key
369+
- **Location**: HTTP header
370+
350371

351372
## Support and Feedback
352373

docs/AddChildDomain.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk::AddChildDomain
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**domain** | **String** | Sender domain to add for a specific child account | [optional]
7+
8+

docs/GetChildDomain.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk::GetChildDomain
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**domain** | **String** | Sender domain |
7+
**active** | **BOOLEAN** | indicates whether a domain is verified or not |
8+
9+

docs/GetChildDomains.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# SibApiV3Sdk::GetChildDomains
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+

docs/GetSsoToken.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk::GetSsoToken
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**token** | **String** | Session token. It will remain valid for a short period of time only. |
7+
8+

0 commit comments

Comments
 (0)