sib-api-v3-sdk 2.0.1 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/AttributesApi.md +2 -2
  4. data/docs/ContactsApi.md +32 -32
  5. data/docs/CreateEmailCampaign.md +1 -1
  6. data/docs/CreateSmsCampaign.md +1 -1
  7. data/docs/{CreaUpdateFolder.md → CreateUpdateFolder.md} +1 -1
  8. data/docs/EmailCampaignsApi.md +16 -16
  9. data/docs/FoldersApi.md +16 -16
  10. data/docs/GetAccountPlan.md +2 -0
  11. data/docs/GetCampaignOverview.md +1 -1
  12. data/docs/GetContactCampaignStatsOpened.md +1 -1
  13. data/docs/GetContactDetails.md +1 -1
  14. data/docs/GetEmailCampaign.md +3 -3
  15. data/docs/GetEmailEventReportEvents.md +4 -4
  16. data/docs/GetExtendedCampaignOverview.md +3 -3
  17. data/docs/GetExtendedContactDetails.md +1 -1
  18. data/docs/GetExtendedContactDetailsStatisticsLinks.md +1 -1
  19. data/docs/GetExtendedContactDetailsStatisticsMessagesSent.md +1 -1
  20. data/docs/GetExtendedContactDetailsStatisticsOpened.md +1 -1
  21. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md +1 -1
  22. data/docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md +1 -1
  23. data/docs/GetExtendedList.md +1 -1
  24. data/docs/GetSmsCampaign.md +3 -3
  25. data/docs/GetSmsCampaignOverview.md +3 -3
  26. data/docs/GetSmsEventReportEvents.md +2 -2
  27. data/docs/GetSmtpTemplateOverview.md +2 -2
  28. data/docs/GetWebhook.md +2 -2
  29. data/docs/ListsApi.md +16 -16
  30. data/docs/ProcessApi.md +2 -2
  31. data/docs/ResellerApi.md +7 -7
  32. data/docs/SMSCampaignsApi.md +16 -16
  33. data/docs/SMTPApi.md +10 -10
  34. data/docs/SendTransacSms.md +1 -0
  35. data/docs/SendersApi.md +6 -6
  36. data/docs/UpdateEmailCampaign.md +1 -1
  37. data/docs/UpdateSmsCampaign.md +1 -1
  38. data/docs/WebhooksApi.md +6 -6
  39. data/lib/sib-api-v3-sdk.rb +1 -1
  40. data/lib/sib-api-v3-sdk/api/contacts_api.rb +20 -24
  41. data/lib/sib-api-v3-sdk/api/folders_api.rb +18 -18
  42. data/lib/sib-api-v3-sdk/api/lists_api.rb +2 -6
  43. data/lib/sib-api-v3-sdk/api/smtp_api.rb +2 -2
  44. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +2 -18
  45. data/lib/sib-api-v3-sdk/models/create_sms_campaign.rb +2 -18
  46. data/lib/sib-api-v3-sdk/models/{crea_update_folder.rb → create_update_folder.rb} +1 -1
  47. data/lib/sib-api-v3-sdk/models/get_account_plan.rb +24 -4
  48. data/lib/sib-api-v3-sdk/models/get_campaign_overview.rb +2 -18
  49. data/lib/sib-api-v3-sdk/models/get_contact_campaign_stats_opened.rb +1 -20
  50. data/lib/sib-api-v3-sdk/models/get_contact_details.rb +2 -21
  51. data/lib/sib-api-v3-sdk/models/get_email_campaign.rb +6 -60
  52. data/lib/sib-api-v3-sdk/models/get_email_event_report_events.rb +4 -4
  53. data/lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb +6 -60
  54. data/lib/sib-api-v3-sdk/models/get_extended_contact_details.rb +2 -21
  55. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_links.rb +1 -20
  56. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_messages_sent.rb +1 -20
  57. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_opened.rb +1 -20
  58. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_admin_unsubscription.rb +1 -20
  59. data/lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics_unsubscriptions_user_unsubscription.rb +1 -20
  60. data/lib/sib-api-v3-sdk/models/get_extended_list.rb +2 -21
  61. data/lib/sib-api-v3-sdk/models/get_sms_campaign.rb +6 -63
  62. data/lib/sib-api-v3-sdk/models/get_sms_campaign_overview.rb +6 -63
  63. data/lib/sib-api-v3-sdk/models/get_sms_event_report_events.rb +2 -2
  64. data/lib/sib-api-v3-sdk/models/get_smtp_template_overview.rb +4 -42
  65. data/lib/sib-api-v3-sdk/models/get_webhook.rb +4 -42
  66. data/lib/sib-api-v3-sdk/models/send_transac_sms.rb +46 -1
  67. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +2 -18
  68. data/lib/sib-api-v3-sdk/models/update_sms_campaign.rb +2 -18
  69. data/lib/sib-api-v3-sdk/version.rb +1 -1
  70. data/spec/api/contacts_api_spec.rb +3 -3
  71. data/spec/api/folders_api_spec.rb +2 -2
  72. data/spec/api/lists_api_spec.rb +1 -1
  73. data/spec/api/smtp_api_spec.rb +1 -1
  74. data/spec/models/{crea_update_folder_spec.rb → create_update_folder_spec.rb} +6 -6
  75. data/spec/models/get_account_plan_spec.rb +12 -0
  76. data/spec/models/send_transac_sms_spec.rb +10 -0
  77. metadata +6 -6
data/docs/FoldersApi.md CHANGED
@@ -13,7 +13,7 @@ Method | HTTP request | Description
13
13
 
14
14
 
15
15
  # **create_folder**
16
- > CreateModel create_folder(name)
16
+ > CreateModel create_folder(create_folder)
17
17
 
18
18
  Create a folder
19
19
 
@@ -31,12 +31,12 @@ end
31
31
 
32
32
  api_instance = SibApiV3Sdk::FoldersApi.new
33
33
 
34
- name = SibApiV3Sdk::CreaUpdateFolder.new # CreaUpdateFolder | Name of the folder
34
+ create_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
35
35
 
36
36
 
37
37
  begin
38
38
  #Create a folder
39
- result = api_instance.create_folder(name)
39
+ result = api_instance.create_folder(create_folder)
40
40
  p result
41
41
  rescue SibApiV3Sdk::ApiError => e
42
42
  puts "Exception when calling FoldersApi->create_folder: #{e}"
@@ -47,7 +47,7 @@ end
47
47
 
48
48
  Name | Type | Description | Notes
49
49
  ------------- | ------------- | ------------- | -------------
50
- **name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder |
50
+ **create_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
51
51
 
52
52
  ### Return type
53
53
 
@@ -83,7 +83,7 @@ end
83
83
 
84
84
  api_instance = SibApiV3Sdk::FoldersApi.new
85
85
 
86
- folder_id = "folder_id_example" # String | Id of the folder
86
+ folder_id = 789 # Integer | Id of the folder
87
87
 
88
88
 
89
89
  begin
@@ -98,7 +98,7 @@ end
98
98
 
99
99
  Name | Type | Description | Notes
100
100
  ------------- | ------------- | ------------- | -------------
101
- **folder_id** | **String**| Id of the folder |
101
+ **folder_id** | **Integer**| Id of the folder |
102
102
 
103
103
  ### Return type
104
104
 
@@ -134,7 +134,7 @@ end
134
134
 
135
135
  api_instance = SibApiV3Sdk::FoldersApi.new
136
136
 
137
- folder_id = "folder_id_example" # String | id of the folder
137
+ folder_id = 789 # Integer | id of the folder
138
138
 
139
139
 
140
140
  begin
@@ -150,7 +150,7 @@ end
150
150
 
151
151
  Name | Type | Description | Notes
152
152
  ------------- | ------------- | ------------- | -------------
153
- **folder_id** | **String**| id of the folder |
153
+ **folder_id** | **Integer**| id of the folder |
154
154
 
155
155
  ### Return type
156
156
 
@@ -186,7 +186,7 @@ end
186
186
 
187
187
  api_instance = SibApiV3Sdk::FoldersApi.new
188
188
 
189
- folder_id = "folder_id_example" # String | Id of the folder
189
+ folder_id = 789 # Integer | Id of the folder
190
190
 
191
191
  opts = {
192
192
  limit: 10, # Integer | Number of documents per page
@@ -206,7 +206,7 @@ end
206
206
 
207
207
  Name | Type | Description | Notes
208
208
  ------------- | ------------- | ------------- | -------------
209
- **folder_id** | **String**| Id of the folder |
209
+ **folder_id** | **Integer**| Id of the folder |
210
210
  **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
211
211
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
212
212
 
@@ -281,7 +281,7 @@ Name | Type | Description | Notes
281
281
 
282
282
 
283
283
  # **update_folder**
284
- > update_folder(folder_id, name)
284
+ > update_folder(folder_id, update_folder)
285
285
 
286
286
  Update a contact folder
287
287
 
@@ -299,14 +299,14 @@ end
299
299
 
300
300
  api_instance = SibApiV3Sdk::FoldersApi.new
301
301
 
302
- folder_id = "folder_id_example" # String | Id of the folder
302
+ folder_id = 789 # Integer | Id of the folder
303
303
 
304
- name = SibApiV3Sdk::CreaUpdateFolder.new # CreaUpdateFolder | Name of the folder
304
+ update_folder = SibApiV3Sdk::CreateUpdateFolder.new # CreateUpdateFolder | Name of the folder
305
305
 
306
306
 
307
307
  begin
308
308
  #Update a contact folder
309
- api_instance.update_folder(folder_id, name)
309
+ api_instance.update_folder(folder_id, update_folder)
310
310
  rescue SibApiV3Sdk::ApiError => e
311
311
  puts "Exception when calling FoldersApi->update_folder: #{e}"
312
312
  end
@@ -316,8 +316,8 @@ end
316
316
 
317
317
  Name | Type | Description | Notes
318
318
  ------------- | ------------- | ------------- | -------------
319
- **folder_id** | **String**| Id of the folder |
320
- **name** | [**CreaUpdateFolder**](CreaUpdateFolder.md)| Name of the folder |
319
+ **folder_id** | **Integer**| Id of the folder |
320
+ **update_folder** | [**CreateUpdateFolder**](CreateUpdateFolder.md)| Name of the folder |
321
321
 
322
322
  ### Return type
323
323
 
@@ -6,5 +6,7 @@ Name | Type | Description | Notes
6
6
  **type** | **String** | Displays the plan type of the user |
7
7
  **credits_type** | **String** | This is the type of the credit, \"User Limit\" or \"Send Limit\" are two possible types of credit of a user. \"User Limit\" implies the total number of subscribers you can add to your account, and \"Send Limit\" implies the total number of emails you can send to the subscribers in your account. |
8
8
  **credits** | **Float** | Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan. |
9
+ **start_date** | **Date** | Date of the period from which the plan will start (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type) | [optional]
10
+ **end_date** | **Date** | Date of the period from which the plan will end (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type) | [optional]
9
11
 
10
12
 
@@ -8,6 +8,6 @@ Name | Type | Description | Notes
8
8
  **subject** | **String** | Subject of the campaign |
9
9
  **type** | **String** | Type of campaign |
10
10
  **status** | **String** | Status of the campaign |
11
- **scheduled_at** | **String** | Date on which campaign is scheduled (YYYY-MM-DD HH:mm:ss) | [optional]
11
+ **scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
12
12
 
13
13
 
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **campaign_id** | **Integer** | ID of the campaign which generated the event |
7
7
  **count** | **Integer** | Number of openings of the campaign |
8
- **event_time** | **String** | Date of the event |
8
+ **event_time** | **DateTime** | Date of the event |
9
9
  **ip** | **String** | IP from which the user has opened the campaign |
10
10
 
11
11
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **id** | **Integer** | ID of the contact for which you requested the details |
8
8
  **email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
9
9
  **sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
10
- **modified_at** | **String** | Last modification date of the contact (YYYY-MM-DD HH:mm:ss) |
10
+ **modified_at** | **DateTime** | Last modification date of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
11
11
  **list_ids** | **Array<Integer>** | |
12
12
  **list_unsubscribed** | **Array<Integer>** | | [optional]
13
13
  **attributes** | **Hash<String, String>** | |
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **subject** | **String** | Subject of the campaign |
9
9
  **type** | **String** | Type of campaign |
10
10
  **status** | **String** | Status of the campaign |
11
- **scheduled_at** | **String** | Date on which campaign is scheduled (YYYY-MM-DD HH:mm:ss) | [optional]
11
+ **scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
12
12
  **test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
13
13
  **header** | **String** | Header of the campaign |
14
14
  **footer** | **String** | Footer of the campaign |
@@ -18,8 +18,8 @@ Name | Type | Description | Notes
18
18
  **html_content** | **String** | HTML content of the campaign |
19
19
  **share_link** | **String** | Link to share the campaign on social medias | [optional]
20
20
  **tag** | **String** | Tag of the campaign |
21
- **created_at** | **String** | Creation date of the campaign (YYYY-MM-DD HH:mm:ss) |
22
- **modified_at** | **String** | Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss) |
21
+ **created_at** | **DateTime** | Creation date of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
22
+ **modified_at** | **DateTime** | Date of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
23
23
  **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]
24
24
  **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]
25
25
  **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]
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
7
7
  **date** | **Date** | Date on which the event has been generated |
8
8
  **subject** | **String** | Subject of the event | [optional]
9
9
  **message_id** | **String** | Message ID which generated the event |
10
- **event** | **String** | Event which occured |
11
- **reason** | **String** | Reason of bounce (only availble if the event is hardbounce or softbounce) |
10
+ **event** | **String** | Event which occurred |
11
+ **reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) |
12
12
  **tag** | **String** | Tag of the email which generated the event |
13
- **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]
14
- **link** | **String** | The link which is sent to the user (only availble if the event is requests or opened or clicks) | [optional]
13
+ **ip** | **String** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional]
14
+ **link** | **String** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional]
15
15
 
16
16
 
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **subject** | **String** | Subject of the campaign |
9
9
  **type** | **String** | Type of campaign |
10
10
  **status** | **String** | Status of the campaign |
11
- **scheduled_at** | **String** | Date on which campaign is scheduled (YYYY-MM-DD HH:mm:ss) | [optional]
11
+ **scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
12
12
  **test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
13
13
  **header** | **String** | Header of the campaign |
14
14
  **footer** | **String** | Footer of the campaign |
@@ -18,8 +18,8 @@ Name | Type | Description | Notes
18
18
  **html_content** | **String** | HTML content of the campaign |
19
19
  **share_link** | **String** | Link to share the campaign on social medias | [optional]
20
20
  **tag** | **String** | Tag of the campaign |
21
- **created_at** | **String** | Creation date of the campaign (YYYY-MM-DD HH:mm:ss) |
22
- **modified_at** | **String** | Date of last modification of the campaign (YYYY-MM-DD HH:mm:ss) |
21
+ **created_at** | **DateTime** | Creation date of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
22
+ **modified_at** | **DateTime** | Date of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
23
23
  **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]
24
24
  **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]
25
25
  **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]
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **id** | **Integer** | ID of the contact for which you requested the details |
8
8
  **email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
9
9
  **sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
10
- **modified_at** | **String** | Last modification date of the contact (YYYY-MM-DD HH:mm:ss) |
10
+ **modified_at** | **DateTime** | Last modification date of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
11
11
  **list_ids** | **Array<Integer>** | |
12
12
  **list_unsubscribed** | **Array<Integer>** | | [optional]
13
13
  **attributes** | **Hash<String, String>** | |
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **count** | **Integer** | Number of clicks on this link for the campaign |
7
- **event_time** | **String** | Date of the event |
7
+ **event_time** | **DateTime** | Date of the event |
8
8
  **ip** | **String** | IP from which the user has clicked on the link |
9
9
  **url** | **String** | URL of the clicked link |
10
10
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **campaign_id** | **Integer** | ID of the campaign which generated the event |
7
- **event_time** | **String** | Date of the event |
7
+ **event_time** | **DateTime** | Date of the event |
8
8
 
9
9
 
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **campaign_id** | **Integer** | ID of the campaign which generated the event |
7
7
  **count** | **Integer** | Number of openings for the campaign |
8
- **event_time** | **String** | Date of the event |
8
+ **event_time** | **DateTime** | Date of the event |
9
9
  **ip** | **String** | IP from which the user has opened the email |
10
10
 
11
11
 
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **event_time** | **String** | Date of the event |
6
+ **event_time** | **DateTime** | Date of the event |
7
7
  **ip** | **String** | IP from which the user has been unsubscribed |
8
8
 
9
9
 
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **campaign_id** | **Integer** | ID of the campaign which generated the event |
7
- **event_time** | **String** | Date of the event |
7
+ **event_time** | **DateTime** | Date of the event |
8
8
  **ip** | **String** | IP from which the user has unsubscribed |
9
9
 
10
10
 
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **total_blacklisted** | **Integer** | Number of blacklisted contacts in the list |
9
9
  **total_subscribers** | **Integer** | Number of contacts in the list |
10
10
  **folder_id** | **Integer** | ID of the folder |
11
- **created_at** | **String** | Creation Date of the list (YYYY-MM-DD HH:mm:ss) |
11
+ **created_at** | **DateTime** | Creation Date of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
12
12
  **campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional]
13
13
  **dynamic_list** | **BOOLEAN** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional]
14
14
 
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
7
7
  **name** | **String** | Name of the SMS Campaign |
8
8
  **status** | **String** | Status of the SMS Campaign |
9
9
  **content** | **String** | Content of the SMS Campaign |
10
- **scheduled_at** | **String** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DD HH:mm:ss format |
10
+ **scheduled_at** | **DateTime** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
11
11
  **test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
12
12
  **sender** | **String** | Sender of the SMS Campaign |
13
- **created_at** | **String** | Creation date of the SMS campaign (YYYY-MM-DD HH:mm:ss) |
14
- **modified_at** | **String** | Date of last modification of the SMS campaign (YYYY-MM-DD HH:mm:ss) |
13
+ **created_at** | **DateTime** | Creation date of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
14
+ **modified_at** | **DateTime** | Date of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
15
15
 
16
16
 
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
7
7
  **name** | **String** | Name of the SMS Campaign |
8
8
  **status** | **String** | Status of the SMS Campaign |
9
9
  **content** | **String** | Content of the SMS Campaign |
10
- **scheduled_at** | **String** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DD HH:mm:ss format |
10
+ **scheduled_at** | **DateTime** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
11
11
  **test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
12
12
  **sender** | **String** | Sender of the SMS Campaign |
13
- **created_at** | **String** | Creation date of the SMS campaign (YYYY-MM-DD HH:mm:ss) |
14
- **modified_at** | **String** | Date of last modification of the SMS campaign (YYYY-MM-DD HH:mm:ss) |
13
+ **created_at** | **DateTime** | Creation date of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
14
+ **modified_at** | **DateTime** | Date of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
15
15
 
16
16
 
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
6
6
  **phone_number** | **String** | Phone number which has generated the event |
7
7
  **date** | **Date** | Date on which the event has been generated |
8
8
  **message_id** | **String** | Message ID which generated the event |
9
- **event** | **String** | Event which occured |
10
- **reason** | **String** | Reason of bounce (only availble if the event is hardbounce or softbounce) |
9
+ **event** | **String** | Event which occurred |
10
+ **reason** | **String** | Reason of bounce (only available if the event is hardbounce or softbounce) |
11
11
  **reply** | **String** | | [optional]
12
12
  **tag** | **String** | Tag of the SMS which generated the event |
13
13
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
  **to_field** | **String** | Customisation of the \"to\" field for the template |
14
14
  **tag** | **String** | Tag of the template |
15
15
  **html_content** | **String** | HTML content of the template |
16
- **created_at** | **String** | Creation date of the template (YYYY-MM-DD HH:mm:ss) |
17
- **modified_at** | **String** | Last modification date of the template (YYYY-MM-DD HH:mm:ss) |
16
+ **created_at** | **DateTime** | Creation date of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
17
+ **modified_at** | **DateTime** | Last modification date of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
18
18
 
19
19
 
data/docs/GetWebhook.md CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **description** | **String** | Description of the webhook |
9
9
  **events** | **Array<String>** | |
10
10
  **type** | **String** | Type of webhook (marketing or transac) |
11
- **created_at** | **String** | Creation date of the webhook (YYYY-MM-DD HH:mm:ss) |
12
- **modified_at** | **String** | Last modification date of the webhook (YYYY-MM-DD HH:mm:ss) |
11
+ **created_at** | **DateTime** | Creation date of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
12
+ **modified_at** | **DateTime** | Last modification date of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
13
13
 
14
14
 
data/docs/ListsApi.md CHANGED
@@ -34,7 +34,7 @@ end
34
34
 
35
35
  api_instance = SibApiV3Sdk::ListsApi.new
36
36
 
37
- list_id = "list_id_example" # String | Id of the list
37
+ list_id = 789 # Integer | Id of the list
38
38
 
39
39
  contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails addresses of the contacts
40
40
 
@@ -52,7 +52,7 @@ end
52
52
 
53
53
  Name | Type | Description | Notes
54
54
  ------------- | ------------- | ------------- | -------------
55
- **list_id** | **String**| Id of the list |
55
+ **list_id** | **Integer**| Id of the list |
56
56
  **contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails addresses of the contacts |
57
57
 
58
58
  ### Return type
@@ -141,7 +141,7 @@ end
141
141
 
142
142
  api_instance = SibApiV3Sdk::ListsApi.new
143
143
 
144
- list_id = "list_id_example" # String | Id of the list
144
+ list_id = 789 # Integer | Id of the list
145
145
 
146
146
 
147
147
  begin
@@ -156,7 +156,7 @@ end
156
156
 
157
157
  Name | Type | Description | Notes
158
158
  ------------- | ------------- | ------------- | -------------
159
- **list_id** | **String**| Id of the list |
159
+ **list_id** | **Integer**| Id of the list |
160
160
 
161
161
  ### Return type
162
162
 
@@ -192,10 +192,10 @@ end
192
192
 
193
193
  api_instance = SibApiV3Sdk::ListsApi.new
194
194
 
195
- list_id = "list_id_example" # String | Id of the list
195
+ list_id = 789 # Integer | Id of the list
196
196
 
197
197
  opts = {
198
- modified_since: "modified_since_example", # String | Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss)
198
+ 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)
199
199
  limit: 50, # Integer | Number of documents per page
200
200
  offset: 0 # Integer | Index of the first document of the page
201
201
  }
@@ -213,8 +213,8 @@ end
213
213
 
214
214
  Name | Type | Description | Notes
215
215
  ------------- | ------------- | ------------- | -------------
216
- **list_id** | **String**| Id of the list |
217
- **modified_since** | **String**| Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss) | [optional]
216
+ **list_id** | **Integer**| Id of the list |
217
+ **modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
218
218
  **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
219
219
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
220
220
 
@@ -252,7 +252,7 @@ end
252
252
 
253
253
  api_instance = SibApiV3Sdk::ListsApi.new
254
254
 
255
- folder_id = "folder_id_example" # String | Id of the folder
255
+ folder_id = 789 # Integer | Id of the folder
256
256
 
257
257
  opts = {
258
258
  limit: 10, # Integer | Number of documents per page
@@ -272,7 +272,7 @@ end
272
272
 
273
273
  Name | Type | Description | Notes
274
274
  ------------- | ------------- | ------------- | -------------
275
- **folder_id** | **String**| Id of the folder |
275
+ **folder_id** | **Integer**| Id of the folder |
276
276
  **limit** | **Integer**| Number of documents per page | [optional] [default to 10]
277
277
  **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
278
278
 
@@ -310,7 +310,7 @@ end
310
310
 
311
311
  api_instance = SibApiV3Sdk::ListsApi.new
312
312
 
313
- list_id = "list_id_example" # String | Id of the list
313
+ list_id = 789 # Integer | Id of the list
314
314
 
315
315
 
316
316
  begin
@@ -326,7 +326,7 @@ end
326
326
 
327
327
  Name | Type | Description | Notes
328
328
  ------------- | ------------- | ------------- | -------------
329
- **list_id** | **String**| Id of the list |
329
+ **list_id** | **Integer**| Id of the list |
330
330
 
331
331
  ### Return type
332
332
 
@@ -417,7 +417,7 @@ end
417
417
 
418
418
  api_instance = SibApiV3Sdk::ListsApi.new
419
419
 
420
- list_id = "list_id_example" # String | Id of the list
420
+ list_id = 789 # Integer | Id of the list
421
421
 
422
422
  contact_emails = SibApiV3Sdk::AddRemoveContactToList.new # AddRemoveContactToList | Emails adresses of the contact
423
423
 
@@ -435,7 +435,7 @@ end
435
435
 
436
436
  Name | Type | Description | Notes
437
437
  ------------- | ------------- | ------------- | -------------
438
- **list_id** | **String**| Id of the list |
438
+ **list_id** | **Integer**| Id of the list |
439
439
  **contact_emails** | [**AddRemoveContactToList**](AddRemoveContactToList.md)| Emails adresses of the contact |
440
440
 
441
441
  ### Return type
@@ -472,7 +472,7 @@ end
472
472
 
473
473
  api_instance = SibApiV3Sdk::ListsApi.new
474
474
 
475
- list_id = "list_id_example" # String | Id of the list
475
+ list_id = 789 # Integer | Id of the list
476
476
 
477
477
  update_list = SibApiV3Sdk::UpdateList.new # UpdateList | Values to update a list
478
478
 
@@ -489,7 +489,7 @@ end
489
489
 
490
490
  Name | Type | Description | Notes
491
491
  ------------- | ------------- | ------------- | -------------
492
- **list_id** | **String**| Id of the list |
492
+ **list_id** | **Integer**| Id of the list |
493
493
  **update_list** | [**UpdateList**](UpdateList.md)| Values to update a list |
494
494
 
495
495
  ### Return type