sib-api-v3-sdk 1.0.0

data/docs/GetAttributesAttributes.md

@@ -0,0 +1,13 @@
+# SibApiV3Sdk::GetAttributesAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the attribute | 
+**name** | **String** | Name of the attribute | 
+**category** | **String** | Category of the attribute | 
+**type** | **String** | Type of the attribute | [optional] 
+**enumeration** | [**Array<GetAttributesEnumeration>**](GetAttributesEnumeration.md) | Parameter only available for \"category\" type attributes. | [optional] 
+**calculated_value** | **String** | Calculated value formula | [optional] 
+
+

data/docs/GetAttributesEnumeration.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetAttributesEnumeration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Integer** | ID of Value of the \"category\" type attribute | 
+**label** | **String** | Label of the \"category\" type attribute | 
+
+

data/docs/GetCampaignOverview.md

@@ -0,0 +1,13 @@
+# SibApiV3Sdk::GetCampaignOverview
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the campaign | 
+**name** | **String** | Name of the campaign | 
+**subject** | **String** | Subject of the campaign | 
+**type** | **String** | Type of campaign | 
+**status** | **String** | Status of the campaign | 
+**scheduled_at** | **String** | Date on which campaign is scheduled (YYYY-MM-DD HH:mm:ss) | [optional] 
+
+

data/docs/GetCampaignRecipients.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lists** | [**Array<GetCampaignRecipientsLists>**](GetCampaignRecipientsLists.md) | Lists included in the campaign | 
+**exclusion_lists** | [**Array<GetCampaignRecipientsExclusionLists>**](GetCampaignRecipientsExclusionLists.md) | Lists excluded of the campaign | 
+
+

data/docs/GetCampaignRecipientsExclusionLists.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetCampaignRecipientsExclusionLists
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the list excluded of the campaign | 
+**name** | **String** | Name of the list excluded of the campaign | 
+
+

data/docs/GetCampaignRecipientsLists.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetCampaignRecipientsLists
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the list included in the campaign | 
+**name** | **String** | Name of the list included in the campaign | 
+
+

data/docs/GetCampaignStats.md

@@ -0,0 +1,19 @@
+# SibApiV3Sdk::GetCampaignStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list_id** | **Integer** | List Id of email campaign (only in case of get email campaign(s)) | 
+**unique_clicks** | **Integer** | Number of unique clicks for the campaign | 
+**clickers** | **Integer** | Number of clicks for the campaign | 
+**complaints** | **Integer** | Number of complaints (Spam reports) for the campaign | 
+**delivered** | **Integer** | Number of delivered emails for the campaign | 
+**sent** | **Integer** | Number of sent emails for the campaign | 
+**soft_bounces** | **Integer** | Number of softbounce for the campaign | 
+**hard_bounces** | **Integer** | Number of harbounce for the campaign | 
+**unique_views** | **Integer** | Number of unique openings for the campaign | 
+**unsubscriptions** | **Integer** | Number of unsubscription for the campaign | 
+**viewed** | **Integer** | Number of openings for the campaign | 
+**deferred** | **Integer** | Number of deferred emails for the campaign | 
+
+

data/docs/GetChildInfo.md

@@ -0,0 +1,16 @@
+# SibApiV3Sdk::GetChildInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Login Email | 
+**first_name** | **String** | First Name | 
+**last_name** | **String** | Last Name | 
+**company_name** | **String** | Name of the company | 
+**credits** | [**GetChildInfoCredits**](GetChildInfoCredits.md) |  | [optional] 
+**statistics** | [**GetChildInfoStatistics**](GetChildInfoStatistics.md) |  | [optional] 
+**password** | **String** | The encrypted password of child account | 
+**ips** | [**Array<GetChildInfoIps>**](GetChildInfoIps.md) | IP(s) associated to a child account user | [optional] 
+**api_keys** | [**Array<GetChildInfoApiKeys>**](GetChildInfoApiKeys.md) | API Keys associated to child account | [optional] 
+
+

data/docs/GetChildInfoApiKeys.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetChildInfoApiKeys
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the key | 
+**key** | **String** | API Key | 
+**secret** | **String** | Secret Key associated to the API Key (in case v1 Key is used only) | [optional] 
+
+

data/docs/GetChildInfoCredits.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetChildInfoCredits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_credits** | **Integer** | Email credits available for your child | [optional] 
+**sms_credits** | **Integer** | SMS credits available for your child | [optional] 
+
+

data/docs/GetChildInfoIps.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetChildInfoIps
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the IP | 
+**ip** | **String** | IP associated to the child account user | 
+
+

data/docs/GetChildInfoStatistics.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetChildInfoStatistics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**previous_month_total_sent** | **Integer** | Overall emails sent for the previous month | [optional] 
+**current_month_total_sent** | **Integer** | Overall emails sent for current month | [optional] 
+**total_sent** | **Integer** | Overall emails sent for since the account exists | [optional] 
+
+

data/docs/GetChildrenList.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetChildrenList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**children** | **Array<Object>** | Your children's account information | [optional] 
+
+

data/docs/GetClient.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetClient
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Login Email | 
+**first_name** | **String** | First Name | 
+**last_name** | **String** | Last Name | 
+**company_name** | **String** | Name of the company | 
+
+

data/docs/GetContactCampaignStats.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::GetContactCampaignStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages_sent** | [**Array<GetContactCampaignStatsMessagesSent>**](GetContactCampaignStatsMessagesSent.md) |  | [optional] 
+**hard_bounces** | [**Array<GetContactCampaignStatsMessagesSent>**](GetContactCampaignStatsMessagesSent.md) |  | [optional] 
+**soft_bounces** | [**Array<GetContactCampaignStatsMessagesSent>**](GetContactCampaignStatsMessagesSent.md) |  | [optional] 
+**complaints** | [**Array<GetContactCampaignStatsMessagesSent>**](GetContactCampaignStatsMessagesSent.md) |  | [optional] 
+**unsubscriptions** | [**GetContactCampaignStatsUnsubscriptions**](GetContactCampaignStatsUnsubscriptions.md) |  | [optional] 
+**opened** | [**Array<GetContactCampaignStatsOpened>**](GetContactCampaignStatsOpened.md) |  | [optional] 
+**clicked** | [**Array<GetContactCampaignStatsClicked>**](GetContactCampaignStatsClicked.md) |  | [optional] 
+**transac_attributes** | [**Array<GetContactCampaignStatsTransacAttributes>**](GetContactCampaignStatsTransacAttributes.md) |  | [optional] 
+
+

data/docs/GetContactCampaignStatsClicked.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetContactCampaignStatsClicked
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign which generated the event | 
+**links** | [**Array<GetContactCampaignStatsLinks>**](GetContactCampaignStatsLinks.md) |  | 
+
+

data/docs/GetContactCampaignStatsLinks.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetContactCampaignStatsLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Number of clicks on this link for the campaign | 
+**event_time** | **DateTime** | Date of the event | 
+**ip** | **String** | IP from which the user has clicked on the link | 
+**url** | **String** | URL of the clicked link | 
+
+

data/docs/GetContactCampaignStatsMessagesSent.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetContactCampaignStatsMessagesSent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign which generated the event | 
+**event_time** | **DateTime** | Date of the event | 
+
+

data/docs/GetContactCampaignStatsOpened.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetContactCampaignStatsOpened
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign which generated the event | 
+**count** | **Integer** | Number of openings of the campaign | 
+**event_time** | **DateTime** | Date of the event | 
+**ip** | **String** | IP from which the user has opened the campaign | 
+
+

data/docs/GetContactCampaignStatsTransacAttributes.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetContactCampaignStatsTransacAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_date** | **Date** | Date of the order | 
+**order_price** | **Float** | Price of the order | 
+**order_id** | **Integer** | ID of the order | 
+
+

data/docs/GetContactCampaignStatsUnsubscriptions.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetContactCampaignStatsUnsubscriptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_unsubscription** | [**Array<GetContactCampaignStatsUnsubscriptionsUserUnsubscription>**](GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md) | Contact has unsubscribed via the unsubscription link in the email | 
+**admin_unsubscription** | [**Array<GetContactCampaignStatsUnsubscriptionsAdminUnsubscription>**](GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md) | Contact has been unsubscribed from the administrator | 
+
+

data/docs/GetContactCampaignStatsUnsubscriptionsAdminUnsubscription.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsAdminUnsubscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_time** | **DateTime** | Date of the event | 
+**ip** | **String** | IP from which the user has been unsubscribed | 
+
+

data/docs/GetContactCampaignStatsUnsubscriptionsUserUnsubscription.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetContactCampaignStatsUnsubscriptionsUserUnsubscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign which generated the event | 
+**event_time** | **DateTime** | Date of the event | 
+**ip** | **String** | IP from which the user has unsubscribed | 
+
+

data/docs/GetContactDetails.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::GetContactDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address of the contact for which you requested the details | 
+**id** | **Integer** | ID of the contact for which you requested the details | 
+**email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | 
+**sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | 
+**modified_at** | **String** | Last modification date of the contact (YYYY-MM-DD HH:mm:ss) | 
+**list_ids** | **Array<Integer>** |  | 
+**list_unsubscribed** | **Array<Integer>** |  | [optional] 
+**attributes** | **Hash<String, String>** |  | 
+
+

data/docs/GetContacts.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetContacts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contacts** | **Array<Object>** |  | 
+**count** | **Integer** | Number of contacts | 
+
+

data/docs/GetEmailCampaign.md

@@ -0,0 +1,27 @@
+# SibApiV3Sdk::GetEmailCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the campaign | 
+**name** | **String** | Name of the campaign | 
+**subject** | **String** | Subject of the campaign | 
+**type** | **String** | Type of campaign | 
+**status** | **String** | Status of the campaign | 
+**scheduled_at** | **String** | Date on which campaign is scheduled (YYYY-MM-DD HH:mm:ss) | [optional] 
+**test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent  false=Test email has not been sent) | 
+**header** | **String** | Header of the campaign | 
+**footer** | **String** | Footer of the campaign | 
+**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) |  | [optional] 
+**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign | 
+**to_field** | **String** | Customisation of the \"to\" field of the campaign | 
+**html_content** | **String** | HTML content of the campaign | 
+**share_link** | **String** | Link to share the campaign on social medias | 
+**tag** | **String** | Tag of the campaign | 
+**created_at** | **String** | Creation date of the campaign (YYYY-MM-DD HH:mm:ss) | 
+**modified_at** | **String** | Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss) | 
+**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional] 
+**mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
+**recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] 
+
+

data/docs/GetEmailCampaigns.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetEmailCampaigns
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaigns** | **Array<Object>** |  | [optional] 
+**count** | **Integer** | Number of Email campaigns retrieved | 
+
+

data/docs/GetEmailEventReport.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetEmailEventReport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<GetEmailEventReportEvents>**](GetEmailEventReportEvents.md) |  | [optional] 
+
+

data/docs/GetEmailEventReportEvents.md

@@ -0,0 +1,14 @@
+# SibApiV3Sdk::GetEmailEventReportEvents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email address which generates the event | 
+**date** | **Date** | Date on which the event has been generated | 
+**message_id** | **String** | Message ID which generated the event | 
+**event** | **String** | Event which occured | 
+**reason** | **String** | Reason of bounce (only availble if the event is hardbounce or softbounce) | 
+**tag** | **String** | Tag of the email which generated the event | 
+**ip** | **String** | IP from which the user has opened the email or clicked on the link (only availble if the event is opened or clicks) | [optional] 
+
+

data/docs/GetExtendedCampaignOverview.md

@@ -0,0 +1,27 @@
+# SibApiV3Sdk::GetExtendedCampaignOverview
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the campaign | 
+**name** | **String** | Name of the campaign | 
+**subject** | **String** | Subject of the campaign | 
+**type** | **String** | Type of campaign | 
+**status** | **String** | Status of the campaign | 
+**scheduled_at** | **String** | Date on which campaign is scheduled (YYYY-MM-DD HH:mm:ss) | [optional] 
+**test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent  false=Test email has not been sent) | 
+**header** | **String** | Header of the campaign | 
+**footer** | **String** | Footer of the campaign | 
+**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) |  | [optional] 
+**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign | 
+**to_field** | **String** | Customisation of the \"to\" field of the campaign | 
+**html_content** | **String** | HTML content of the campaign | 
+**share_link** | **String** | Link to share the campaign on social medias | 
+**tag** | **String** | Tag of the campaign | 
+**created_at** | **String** | Creation date of the campaign (YYYY-MM-DD HH:mm:ss) | 
+**modified_at** | **String** | Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss) | 
+**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional] 
+**mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
+**recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] 
+
+

data/docs/GetExtendedCampaignOverviewSender.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetExtendedCampaignOverviewSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Sender name of the campaign | [optional] 
+**email** | **String** | Sender email of the campaign | [optional] 
+
+

data/docs/GetExtendedCampaignStats.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::GetExtendedCampaignStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_stats** | **Array<Object>** |  | 
+**mirror_click** | **Integer** | Number of clicks on mirror link | 
+**remaining** | **Integer** | Number of remaning emails to send | 
+**links_stats** | [**Hash<String, GetExtendedCampaignStatsLinksStats>**](GetExtendedCampaignStatsLinksStats.md) |  | 
+**stats_by_domain** | [**GetStatsByDomain**](GetStatsByDomain.md) |  | 
+
+

data/docs/GetExtendedCampaignStatsLinksStats.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetExtendedCampaignStatsLinksStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nb_click** | **Integer** | Number of clicks for the link | 
+
+

data/docs/GetExtendedClient.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::GetExtendedClient
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Login Email | 
+**first_name** | **String** | First Name | 
+**last_name** | **String** | Last Name | 
+**company_name** | **String** | Name of the company | 
+**address** | [**GetExtendedClientAddress**](GetExtendedClientAddress.md) |  | [optional] 
+
+