sib-api-v3-sdk 1.0.0

data/docs/GetExtendedClientAddress.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetExtendedClientAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**street** | **String** | Street information | 
+**city** | **String** | City information | 
+**zip_code** | **String** | Zip Code information | 
+**country** | **String** | Country information | 
+
+

data/docs/GetExtendedContactDetails.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::GetExtendedContactDetails
+
+## 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/GetExtendedList.md

@@ -0,0 +1,15 @@
+# SibApiV3Sdk::GetExtendedList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the list | 
+**name** | **String** | Name of the list | 
+**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list | 
+**total_subscribers** | **Integer** | Number of contacts in the list | 
+**folder_id** | **Integer** | ID of the folder | 
+**created_at** | **String** | Creation Date of the list (YYYY-MM-DD) | 
+**campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) |  | [optional] 
+**dynamic_list** | **BOOLEAN** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional] 
+
+

data/docs/GetExtendedListCampaignStats.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetExtendedListCampaignStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign | 
+**stats** | [**GetCampaignStats**](GetCampaignStats.md) |  | 
+
+

data/docs/GetFolder.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::GetFolder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the folder | 
+**name** | **String** | Name of the folder | 
+**total_blacklisted** | **Integer** | Number of blacklisted contacts in the folder | 
+**total_subscribers** | **Integer** | Number of contacts in the folder | 
+**unique_subscribers** | **Integer** | Number of unique contacts in the folder | 
+
+

data/docs/GetFolderLists.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetFolderLists
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lists** | **Array<Object>** |  | 
+**count** | **Integer** | Number of lists in the folder | 
+
+

data/docs/GetFolders.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetFolders
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folders** | **Array<Object>** |  | [optional] 
+**count** | **Integer** | Number of folders available in your account | [optional] 
+
+

data/docs/GetIp.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetIp
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the dedicated IP | 
+**ip** | **String** | Dedicated IP | 
+**active** | **BOOLEAN** | Status of the IP (true=active, false=inactive) | 
+**domain** | **String** | Domain associated to the IP | 
+
+

data/docs/GetIpFromSender.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetIpFromSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the dedicated IP | 
+**ip** | **String** | Dedicated IP | 
+**domain** | **String** | Domain associated to the IP | 
+**weight** | **Integer** | Weight of the IP | 
+
+

data/docs/GetIps.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetIps
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ips** | [**Array<GetIp>**](GetIp.md) | Dedicated IP(s) available on your account | 
+
+

data/docs/GetIpsFromSender.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetIpsFromSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ips** | [**Array<GetIpFromSender>**](GetIpFromSender.md) | Dedicated IP(s) linked to a sender | 
+
+

data/docs/GetList.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the list | 
+**name** | **String** | Name of the list | 
+**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list | 
+**total_subscribers** | **Integer** | Number of contacts in the list | 
+
+

data/docs/GetLists.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetLists
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Number of lists in your account | 
+**lists** | [**Array<GetListsLists>**](GetListsLists.md) | Listing of all the lists available in your account | 
+
+

data/docs/GetListsFolder.md

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

data/docs/GetListsLists.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetListsLists
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folder** | [**GetListsFolder**](GetListsFolder.md) |  | [optional] 
+
+

data/docs/GetProcess.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::GetProcess
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Id of the process | 
+**status** | **String** | Status of the process | 
+**name** | **String** | Process name | 
+**export_url** | **String** | URL on which send export the of contacts once the process is completed | [optional] 
+
+

data/docs/GetProcesses.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetProcesses
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**processes** | [**Array<GetProcess>**](GetProcess.md) | List of processes available on your account | [optional] 
+**count** | **Integer** | Number of processes available on your account | 
+
+

data/docs/GetReports.md

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

data/docs/GetReportsReports.md

@@ -0,0 +1,20 @@
+# SibApiV3Sdk::GetReportsReports
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **Date** | Date of the statistics | 
+**tag** | **String** | Reminder of the specified tag (only available if a specific tag has been specified in the request) | 
+**requests** | **Integer** | Number of requests for the date | 
+**delivered** | **Integer** | Number of delivered emails for the date | 
+**hard_bounces** | **Integer** | Number of hardbounces for the date | 
+**soft_bounces** | **Integer** | Number of softbounces for the date | 
+**clicks** | **Integer** | Number of clicks for the date | 
+**unique_clicks** | **Integer** | Number of unique clicks for the date | 
+**opens** | **Integer** | Number of openings for the date | 
+**unique_opens** | **Integer** | Number of unique openings for the date | 
+**spam_reports** | **Integer** | Number of complaints (spam reports) for the date | 
+**blocked** | **Integer** | Number of blocked emails for the date | 
+**invalid** | **Integer** | Number of invalid emails for the date | 
+
+

data/docs/GetSendersList.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::GetSendersList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**senders** | [**Array<GetSendersListSenders>**](GetSendersListSenders.md) | List of the senders available in your account | [optional] 
+
+

data/docs/GetSendersListIps.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::GetSendersListIps
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ip** | **String** | Dedicated IP available in your account | 
+**domain** | **String** | Domain of the IP | 
+**weight** | **Integer** | Weight of the IP for this sender | 
+
+

data/docs/GetSendersListSenders.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::GetSendersListSenders
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Id of the sender | 
+**name** | **String** | From Name associated to the sender | 
+**email** | **String** | From Email associated to the sender | 
+**active** | **BOOLEAN** | Status of sender (true=activated, false=deactivated) | 
+**ips** | [**Array<GetSendersListIps>**](GetSendersListIps.md) | List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs | [optional] 
+
+

data/docs/GetSmsCampaign.md

@@ -0,0 +1,16 @@
+# SibApiV3Sdk::GetSmsCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the SMS Campaign | 
+**name** | **String** | Name of the SMS Campaign | 
+**status** | **String** | Status of the SMS Campaign | 
+**content** | **String** | Content of the SMS Campaign | 
+**scheduled_at** | **String** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DD HH:mm:ss format | 
+**test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent  false=Test SMS has not been sent) | 
+**sender** | **String** | Sender of the SMS Campaign | 
+**created_at** | **String** | Creation date of the SMS campaign (YYYY-MM-DD HH:mm:ss) | 
+**modified_at** | **String** | Date of last modification of the SMS campaign (YYYY-MM-DD HH:mm:ss) | 
+
+

data/docs/GetSmsCampaignOverview.md

@@ -0,0 +1,16 @@
+# SibApiV3Sdk::GetSmsCampaignOverview
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the SMS Campaign | 
+**name** | **String** | Name of the SMS Campaign | 
+**status** | **String** | Status of the SMS Campaign | 
+**content** | **String** | Content of the SMS Campaign | 
+**scheduled_at** | **String** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DD HH:mm:ss format | 
+**test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent  false=Test SMS has not been sent) | 
+**sender** | **String** | Sender of the SMS Campaign | 
+**created_at** | **String** | Creation date of the SMS campaign (YYYY-MM-DD HH:mm:ss) | 
+**modified_at** | **String** | Date of last modification of the SMS campaign (YYYY-MM-DD HH:mm:ss) | 
+
+

data/docs/GetSmsCampaignStats.md

@@ -0,0 +1,14 @@
+# SibApiV3Sdk::GetSmsCampaignStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**delivered** | **Integer** | Number of delivered SMS | 
+**sent** | **Integer** | Number of sent SMS | 
+**processing** | **Integer** | Number of processing SMS | 
+**soft_bounces** | **Integer** | Number of softbounced SMS | 
+**hard_bounces** | **Integer** | Number of hardbounced SMS | 
+**unsubscriptions** | **Integer** | Number of unsubscription SMS | 
+**answered** | **Integer** | Number of replies to the SMS | 
+
+

data/docs/GetSmsCampaigns.md

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

data/docs/GetSmsEventReport.md

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

data/docs/GetSmsEventReportEvents.md

@@ -0,0 +1,14 @@
+# SibApiV3Sdk::GetSmsEventReportEvents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **String** | Phone number which has generated 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) | 
+**reply** | **String** |  | [optional] 
+**tag** | **String** | Tag of the SMS which generated the event | 
+
+

data/docs/GetSmtpTemplateOverview.md

@@ -0,0 +1,19 @@
+# SibApiV3Sdk::GetSmtpTemplateOverview
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the template | 
+**name** | **String** | Name of the template | 
+**subject** | **String** | Subject of the template | 
+**is_active** | **BOOLEAN** | Status of template (true=active, false=inactive) | 
+**test_sent** | **BOOLEAN** | Status of test sending for the template (true=test email has been sent, false=test email has not been sent) | 
+**sender** | [**GetSmtpTemplateOverviewSender**](GetSmtpTemplateOverviewSender.md) |  | [optional] 
+**reply_to** | **String** | Email defined as the \"Reply to\" for the template | 
+**to_field** | **String** | Customisation of the \"to\" field for the template | 
+**tag** | **String** | Tag of the template | 
+**html_content** | **String** | HTML content of the template | 
+**created_at** | **String** | Creation date of the template (YYYY-MM-DD HH:mm:ss) | 
+**modified_at** | **String** | Last modification date of the template (YYYY-MM-DD HH:mm:ss) | 
+
+

data/docs/GetSmtpTemplateOverviewSender.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetSmtpTemplateOverviewSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | From email for the template | [optional] 
+**email** | **String** | From email for the template | [optional] 
+
+

data/docs/GetSmtpTemplates.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::GetSmtpTemplates
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Count of smtp templates | [optional] 
+**templates** | [**Array<GetSmtpTemplateOverview>**](GetSmtpTemplateOverview.md) |  | [optional] 
+
+

data/docs/GetStatsByDomain.md

@@ -0,0 +1,7 @@
+# SibApiV3Sdk::GetStatsByDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/GetTransacAggregatedSmsReport.md

@@ -0,0 +1,17 @@
+# SibApiV3Sdk::GetTransacAggregatedSmsReport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**range** | **String** | Time frame of the report | 
+**requests** | **Integer** | Number of requests for the timeframe | 
+**delivered** | **Integer** | Number of delivered SMS for the timeframe | 
+**hard_bounces** | **Integer** | Number of hardbounces for the timeframe | 
+**soft_bounces** | **Integer** | Number of softbounces for the timeframe | 
+**blocked** | **Integer** | Number of blocked contact for the timeframe | 
+**unsubscribed** | **Integer** | Number of unsubscription for the timeframe | 
+**replied** | **Integer** | Number of answered SMS for the timeframe | 
+**accepted** | **Integer** | Number of accepted for the timeframe | 
+**rejected** | **Integer** | Number of rejected for the timeframe | 
+
+

data/docs/GetTransacSmsReport.md

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

data/docs/GetTransacSmsReportReports.md

@@ -0,0 +1,18 @@
+# SibApiV3Sdk::GetTransacSmsReportReports
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **Date** | Date for which statistics are retrieved | 
+**tag** | **String** | Tag specified in request | 
+**requests** | **Integer** | Number of requests for the date | 
+**delivered** | **Integer** | Number of delivered SMS for the date | 
+**hard_bounces** | **Integer** | Number of hardbounces for the date | 
+**soft_bounces** | **Integer** | Number of softbounces for the date | 
+**blocked** | **Integer** | Number of blocked contact for the date | 
+**unsubscribed** | **Integer** | Number of unsubscription for the date | 
+**replied** | **Integer** | Number of answered SMS for the date | 
+**accepted** | **Integer** | Number of accepted for the date | 
+**rejected** | **Integer** | Number of rejected for the date | 
+
+