Skip to content

Commit 6daf732

Browse files
skynetsibskynetsib
committed
added files
1 parent 83216e8 commit 6daf732

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+3088
-0
lines changed

‎docs/AbTestCampaignResult.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# SibApiV3Sdk.AbTestCampaignResult
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**winningVersion** | **String** | Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending. | [optional]
7+
**winningCriteria** | **String** | Criteria choosen for winning version (Open/Click) | [optional]
8+
**winningSubjectLine** | **String** | Subject Line of current winning version | [optional]
9+
**openRate** | **String** | Open rate for current winning version | [optional]
10+
**clickRate** | **String** | Click rate for current winning version | [optional]
11+
**winningVersionRate** | **String** | Open/Click rate for the winner version | [optional]
12+
13+
14+
<a name="WinningVersionEnum"></a>
15+
## Enum: WinningVersionEnum
16+
17+
18+
* `notAvailable` (value: `"notAvailable"`)
19+
20+
* `pending` (value: `"pending"`)
21+
22+
* `tie` (value: `"tie"`)
23+
24+
* `A` (value: `"A"`)
25+
26+
* `B` (value: `"B"`)
27+
28+
29+
30+
31+
<a name="WinningCriteriaEnum"></a>
32+
## Enum: WinningCriteriaEnum
33+
34+
35+
* `Open` (value: `"Open"`)
36+
37+
* `Click` (value: `"Click"`)
38+
39+
40+
41+

‎docs/GetChildAccountCreationStatus.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk.GetChildAccountCreationStatus
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**childAccountCreated** | **Boolean** | Status of child account creation whether it is successfully created (exists) or not. |
7+
8+

‎docs/GetDeviceBrowserStats.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SibApiV3Sdk.GetDeviceBrowserStats
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**clickers** | **Number** | Number of total clicks for the campaign using the particular browser |
7+
**uniqueClicks** | **Number** | Number of unique clicks for the campaign using the particular browser |
8+
**viewed** | **Number** | Number of openings for the campaign using the particular browser |
9+
**uniqueViews** | **Number** | Number of unique openings for the campaign using the particular browser |
10+
11+

‎docs/GetSharedTemplateUrl.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SibApiV3Sdk.GetSharedTemplateUrl
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**sharedUrl** | **String** | A unique URL for the email campaign or transactional template. This URL can be shared with other Sendinblue users. |
7+
8+

‎docs/GetStatsByBrowser.md

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

‎docs/GetStatsByDevice.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SibApiV3Sdk.GetStatsByDevice
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**desktop** | [**{String: GetDeviceBrowserStats}**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of desktop devices | [optional]
7+
**mobile** | [**{String: GetDeviceBrowserStats}**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of mobile devices | [optional]
8+
**tablet** | [**{String: GetDeviceBrowserStats}**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of tablet devices | [optional]
9+
**unknown** | [**{String: GetDeviceBrowserStats}**](GetDeviceBrowserStats.md) | Statistics of the campaign on the basis of unknown devices | [optional]
10+
11+

‎docs/GetTransacBlockedContacts.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk.GetTransacBlockedContacts
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**count** | **Number** | Count of blocked or unsubscribed contact | [optional]
7+
**contacts** | [**[GetTransacBlockedContactsContacts]**](GetTransacBlockedContactsContacts.md) | | [optional]
8+
9+

‎docs/GetTransacBlockedContactsContacts.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SibApiV3Sdk.GetTransacBlockedContactsContacts
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**email** | **String** | Email address of the blocked or unsubscribed contact |
7+
**senderEmail** | **String** | Sender email address of the blocked or unsubscribed contact |
8+
**reason** | [**GetTransacBlockedContactsReason**](GetTransacBlockedContactsReason.md) | |
9+
**blockedAt** | **Date** | Date when the contact was blocked or unsubscribed on |
10+
11+

‎docs/GetTransacBlockedContactsReason.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# SibApiV3Sdk.GetTransacBlockedContactsReason
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**code** | **String** | Reason code for blocking / unsubscribing (This code is safe for comparison) | [optional]
7+
**message** | **String** | Reason for blocking / unsubscribing (This string is not safe for comparison) | [optional]
8+
9+
10+
<a name="CodeEnum"></a>
11+
## Enum: CodeEnum
12+
13+
14+
* `unsubscribedViaMA` (value: `"unsubscribedViaMA"`)
15+
16+
* `unsubscribedViaEmail` (value: `"unsubscribedViaEmail"`)
17+
18+
* `adminBlocked` (value: `"adminBlocked"`)
19+
20+
* `unsubscribedViaApi` (value: `"unsubscribedViaApi"`)
21+
22+
* `hardBounce` (value: `"hardBounce"`)
23+
24+
* `contactFlaggedAsSpam` (value: `"contactFlaggedAsSpam"`)
25+
26+
27+
28+

‎docs/GetTransacEmailContent.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# SibApiV3Sdk.GetTransacEmailContent
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**email** | **String** | Email address to which transactional email has been sent |
7+
**subject** | **String** | Subject of the sent email |
8+
**templateId** | **Number** | Id of the template | [optional]
9+
**_date** | **Date** | Date on which transactional email was sent |
10+
**events** | [**[GetTransacEmailContentEvents]**](GetTransacEmailContentEvents.md) | Series of events which occurred on the transactional email |
11+
**body** | **String** | Actual content of the transactional email that has been sent |
12+
**attachmentCount** | **Number** | Count of the attachments that were sent in the email |
13+
14+

0 commit comments

Comments
 (0)