sib-api-v3-sdk 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff2b749eee2a0089ea9bece7a9bcea3c1d5dd739
-  data.tar.gz: fb9e32f8150278ed7424089b484988bb3c6ac118
+  metadata.gz: 24de2aa04d387c34ad71b9b3214e49c1d8cbbf77
+  data.tar.gz: 82c94392593df1f9c3810b1cf459f74e7e3ea2e3
 SHA512:
-  metadata.gz: 8956d3518d78072bb7a75f8c2840dc968bf8c9b8ce0d30eeb7a3d5b4f223d04a1e1f74e540570f4190bd7ee530be8a75c402ed3d698675df954b799422d2653b
-  data.tar.gz: d9a30322bab8063315119e3530b9bac38a31ec68f34181249eefe0087b7331d974c85f081112266193bdbd3a64a4c23388a3a9d407f805d4335c23ed9953243b
+  metadata.gz: 0721bbe1879af084ad02d088fc027d348915a277d4ba3ce684bbca214185a5925b2ff42feab4cc359e5d8337fe62e6a4ff92215b9f9c122e2d9bd5723464b408
+  data.tar.gz: 153185b069137d2bce64335e4216855d2ec0237634ebd09629baebfbe08e49f9f4bb0abe36b771bc11aca2dff5d97d2862afd183b1efdf8cb991b3e8e70d57ad

data/README.md

@@ -185,7 +185,6 @@ Class | Method | HTTP request | Description
 
  - [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
  - [SibApiV3Sdk::AddRemoveContactToList](docs/AddRemoveContactToList.md)
- - [SibApiV3Sdk::CreaUpdateFolder](docs/CreaUpdateFolder.md)
  - [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
  - [SibApiV3Sdk::CreateAttributeEnumemaration](docs/CreateAttributeEnumemaration.md)
  - [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
@@ -203,6 +202,7 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::CreateSmtpEmail](docs/CreateSmtpEmail.md)
  - [SibApiV3Sdk::CreateSmtpTemplate](docs/CreateSmtpTemplate.md)
  - [SibApiV3Sdk::CreateSmtpTemplateSender](docs/CreateSmtpTemplateSender.md)
+ - [SibApiV3Sdk::CreateUpdateFolder](docs/CreateUpdateFolder.md)
  - [SibApiV3Sdk::CreateWebhook](docs/CreateWebhook.md)
  - [SibApiV3Sdk::CreatedProcessId](docs/CreatedProcessId.md)
  - [SibApiV3Sdk::DeleteHardbounces](docs/DeleteHardbounces.md)

data/docs/AttributesApi.md

@@ -80,7 +80,7 @@ end
 
 api_instance = SibApiV3Sdk::AttributesApi.new
 
-attribute_id = "attribute_id_example" # String | id of the attribute
+attribute_id = 789 # Integer | id of the attribute
 
 
 begin
@@ -95,7 +95,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **attribute_id** | **String**| id of the attribute | 
+ **attribute_id** | **Integer**| id of the attribute | 
 
 ### Return type
 

data/docs/ContactsApi.md

@@ -49,7 +49,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-list_id = "list_id_example" # String | Id of the list
+list_id = 789 # Integer | Id of the list
 
 contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails addresses of the contacts
 
@@ -67,7 +67,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **String**| Id of the list | 
+ **list_id** | **Integer**| Id of the list | 
  **contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts | 
 
 ### Return type
@@ -190,7 +190,7 @@ Name | Type | Description  | Notes
 
 
 # **create_folder**
-> CreateModel create_folder(name)
+> CreateModel create_folder(create_folder)
 
 Create a folder
 
@@ -208,12 +208,12 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-name = SibApiV3Sdk::CreaUpdateFolder.new # CreaUpdateFolder | Name of the folder
+create_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
 
 
 begin
   #Create a folder
-  result = api_instance.create_folder(name)
+  result = api_instance.create_folder(create_folder)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->create_folder: #{e}"
@@ -224,7 +224,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder | 
+ **create_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder | 
 
 ### Return type
 
@@ -312,7 +312,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-attribute_id = "attribute_id_example" # String | id of the attribute
+attribute_id = 789 # Integer | id of the attribute
 
 
 begin
@@ -327,7 +327,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **attribute_id** | **String**| id of the attribute | 
+ **attribute_id** | **Integer**| id of the attribute | 
 
 ### Return type
 
@@ -363,7 +363,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-folder_id = "folder_id_example" # String | Id of the folder
+folder_id = 789 # Integer | Id of the folder
 
 
 begin
@@ -378,7 +378,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **folder_id** | **String**| Id of the folder | 
+ **folder_id** | **Integer**| Id of the folder | 
 
 ### Return type
 
@@ -414,7 +414,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-list_id = "list_id_example" # String | Id of the list
+list_id = 789 # Integer | Id of the list
 
 
 begin
@@ -429,7 +429,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **String**| Id of the list | 
+ **list_id** | **Integer**| Id of the list | 
 
 ### Return type
 
@@ -670,10 +670,10 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-list_id = "list_id_example" # String | Id of the list
+list_id = 789 # Integer | Id of the list
 
 opts = { 
-  modified_since: "modified_since_example", # String | Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss)
+  modified_since: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
   limit: 50, # Integer | Number of documents per page
   offset: 0 # Integer | Index of the first document of the page
 }
@@ -691,8 +691,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **String**| Id of the list | 
- **modified_since** | **String**| Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss) | [optional] 
+ **list_id** | **Integer**| Id of the list | 
+ **modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] 
  **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
 
@@ -730,7 +730,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-folder_id = "folder_id_example" # String | id of the folder
+folder_id = 789 # Integer | id of the folder
 
 
 begin
@@ -746,7 +746,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **folder_id** | **String**| id of the folder | 
+ **folder_id** | **Integer**| id of the folder | 
 
 ### Return type
 
@@ -782,7 +782,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-folder_id = "folder_id_example" # String | Id of the folder
+folder_id = 789 # Integer | Id of the folder
 
 opts = { 
   limit: 10, # Integer | Number of documents per page
@@ -802,7 +802,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **folder_id** | **String**| Id of the folder | 
+ **folder_id** | **Integer**| Id of the folder | 
  **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
 
@@ -895,7 +895,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-list_id = "list_id_example" # String | Id of the list
+list_id = 789 # Integer | Id of the list
 
 
 begin
@@ -911,7 +911,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **String**| Id of the list | 
+ **list_id** | **Integer**| Id of the list | 
 
 ### Return type
 
@@ -1056,7 +1056,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-list_id = "list_id_example" # String | Id of the list
+list_id = 789 # Integer | Id of the list
 
 contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails adresses of the contact
 
@@ -1074,7 +1074,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **String**| Id of the list | 
+ **list_id** | **Integer**| Id of the list | 
  **contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact | 
 
 ### Return type
@@ -1201,7 +1201,7 @@ nil (empty response body)
 
 
 # **update_folder**
-> update_folder(folder_id, name)
+> update_folder(folder_id, update_folder)
 
 Update a contact folder
 
@@ -1219,14 +1219,14 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-folder_id = "folder_id_example" # String | Id of the folder
+folder_id = 789 # Integer | Id of the folder
 
-name = SibApiV3Sdk::CreaUpdateFolder.new # CreaUpdateFolder | Name of the folder
+update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
 
 
 begin
   #Update a contact folder
-  api_instance.update_folder(folder_id, name)
+  api_instance.update_folder(folder_id, update_folder)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->update_folder: #{e}"
 end
@@ -1236,8 +1236,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **folder_id** | **String**| Id of the folder | 
- **name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder | 
+ **folder_id** | **Integer**| Id of the folder | 
+ **update_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder | 
 
 ### Return type
 
@@ -1273,7 +1273,7 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-list_id = "list_id_example" # String | Id of the list
+list_id = 789 # Integer | Id of the list
 
 update_list = SibApiV3Sdk::UpdateList.new # UpdateList | Values to update a list
 
@@ -1290,7 +1290,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **list_id** | **String**| Id of the list | 
+ **list_id** | **Integer**| Id of the list | 
  **update_list** | [**UpdateList**](UpdateList.md)| Values to update a list | 
 
 ### Return type

data/docs/CreateEmailCampaign.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **name** | **String** | Name of the campaign | 
 **html_content** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional] 
 **html_url** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional] 
-**scheduled_at** | **String** | Sending date and time (YYYY-MM-DD HH:mm:ss) | [optional] 
+**scheduled_at** | **DateTime** | Sending date and time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] 
 **subject** | **String** | Subject of the campaign | 
 **reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional] 
 **to_field** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, use [FNAME] [LNAME]. These attributes must already exist in your contact database | [optional] 

data/docs/CreateSmsCampaign.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **sender** | **String** | Name of the sender. The number of characters is limited to 11 | 
 **content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] 
 **recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) |  | [optional] 
-**scheduled_at** | **String** | Date and time on which the campaign has to run (YYYY-MM-DD HH:mm:ss) | [optional] 
+**scheduled_at** | **DateTime** | Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional] 
 
 

data/docs/{CreaUpdateFolder.md → CreateUpdateFolder.md}

@@ -1,4 +1,4 @@
-# SibApiV3Sdk::CreaUpdateFolder
+# SibApiV3Sdk::CreateUpdateFolder
 
 ## Properties
 Name | Type | Description | Notes

data/docs/EmailCampaignsApi.md

@@ -87,7 +87,7 @@ end
 
 api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 
-campaign_id = "campaign_id_example" # String | id of the campaign
+campaign_id = 789 # Integer | id of the campaign
 
 
 begin
@@ -102,7 +102,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| id of the campaign | 
+ **campaign_id** | **Integer**| id of the campaign | 
 
 ### Return type
 
@@ -138,7 +138,7 @@ end
 
 api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 
-campaign_id = "campaign_id_example" # String | Id of the campaign
+campaign_id = 789 # Integer | Id of the campaign
 
 opts = { 
   recipient_export: SibApiV3Sdk::EmailExportRecipients.new # EmailExportRecipients | Values to send for a recipient export request
@@ -157,7 +157,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| Id of the campaign | 
+ **campaign_id** | **Integer**| Id of the campaign | 
  **recipient_export** | [**EmailExportRecipients**](EmailExportRecipients.md)| Values to send for a recipient export request | [optional] 
 
 ### Return type
@@ -194,7 +194,7 @@ end
 
 api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 
-campaign_id = "campaign_id_example" # String | Id of the campaign
+campaign_id = 789 # Integer | Id of the campaign
 
 
 begin
@@ -210,7 +210,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| Id of the campaign | 
+ **campaign_id** | **Integer**| Id of the campaign | 
 
 ### Return type
 
@@ -305,7 +305,7 @@ end
 
 api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 
-campaign_id = "campaign_id_example" # String | Id of the campaign
+campaign_id = 789 # Integer | Id of the campaign
 
 
 begin
@@ -320,7 +320,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| Id of the campaign | 
+ **campaign_id** | **Integer**| Id of the campaign | 
 
 ### Return type
 
@@ -358,7 +358,7 @@ end
 
 api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 
-campaign_id = "campaign_id_example" # String | Id of the campaign
+campaign_id = 789 # Integer | Id of the campaign
 
 send_report = SibApiV3Sdk::SendReport.new # SendReport | Values for send a report
 
@@ -375,7 +375,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| Id of the campaign | 
+ **campaign_id** | **Integer**| Id of the campaign | 
  **send_report** | [**SendReport**](SendReport.md)| Values for send a report | 
 
 ### Return type
@@ -412,7 +412,7 @@ end
 
 api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 
-campaign_id = "campaign_id_example" # String | Id of the campaign
+campaign_id = 789 # Integer | Id of the campaign
 
 email_to = SibApiV3Sdk::SendTestEmail.new # SendTestEmail | 
 
@@ -429,7 +429,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| Id of the campaign | 
+ **campaign_id** | **Integer**| Id of the campaign | 
  **email_to** | [**SendTestEmail**](SendTestEmail.md)|  | 
 
 ### Return type
@@ -466,7 +466,7 @@ end
 
 api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 
-campaign_id = "campaign_id_example" # String | Id of the campaign
+campaign_id = 789 # Integer | Id of the campaign
 
 status = SibApiV3Sdk::UpdateCampaignStatus.new # UpdateCampaignStatus | Status of the campaign
 
@@ -483,7 +483,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| Id of the campaign | 
+ **campaign_id** | **Integer**| Id of the campaign | 
  **status** | [**UpdateCampaignStatus**](UpdateCampaignStatus.md)| Status of the campaign | 
 
 ### Return type
@@ -520,7 +520,7 @@ end
 
 api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 
-campaign_id = "campaign_id_example" # String | Id of the campaign
+campaign_id = 789 # Integer | Id of the campaign
 
 email_campaign = SibApiV3Sdk::UpdateEmailCampaign.new # UpdateEmailCampaign | Values to update a campaign
 
@@ -537,7 +537,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| Id of the campaign | 
+ **campaign_id** | **Integer**| Id of the campaign | 
  **email_campaign** | [**UpdateEmailCampaign**](UpdateEmailCampaign.md)| Values to update a campaign | 
 
 ### Return type