Skip to content

Commit 9ab466e

Browse files
committed
Swagger update: For minor changes in contact attributes api
1 parent 0512b09 commit 9ab466e

File tree

58 files changed

+868
-78
lines changed

Some content is hidden

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

58 files changed

+868
-78
lines changed

docs/ContactsApi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
627627
opts = {
628628
limit: 50, # Integer | Number of documents per page
629629
offset: 0, # Integer | Index of the first document of the page
630-
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)
630+
modified_since: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
631631
}
632632

633633
begin
@@ -645,7 +645,7 @@ Name | Type | Description | Notes
645645
------------- | ------------- | ------------- | -------------
646646
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
647647
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
648-
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
648+
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
649649

650650
### Return type
651651

@@ -684,7 +684,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
684684
list_id = 789 # Integer | Id of the list
685685

686686
opts = {
687-
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)
687+
modified_since: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
688688
limit: 50, # Integer | Number of documents per page
689689
offset: 0 # Integer | Index of the first document of the page
690690
}
@@ -703,7 +703,7 @@ end
703703
Name | Type | Description | Notes
704704
------------- | ------------- | ------------- | -------------
705705
**list_id** | **Integer**| Id of the list |
706-
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
706+
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
707707
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
708708
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
709709

docs/CreateAttributeEnumeration.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk::CreateAttributeEnumeration
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**value** | **Integer** | Id of the value |
7+
**label** | **String** | Label of the value |
8+
9+

docs/CreateEmailCampaign.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**name** | **String** | Name of the campaign |
99
**html_content** | **String** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
1010
**html_url** | **String** | Mandatory if htmlContent is empty. Url to the message (HTML) | [optional]
11-
**scheduled_at** | **DateTime** | Sending date and time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
11+
**scheduled_at** | **DateTime** | Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1212
**subject** | **String** | Subject of the campaign |
1313
**reply_to** | **String** | Email on which the campaign recipients will be able to reply to | [optional]
1414
**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]

docs/CreateSmsCampaign.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
77
**sender** | **String** | Name of the sender. The number of characters is limited to 11 |
88
**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]
99
**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) | | [optional]
10-
**scheduled_at** | **DateTime** | Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
10+
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1111

1212

docs/GetCampaignOverview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ Name | Type | Description | Notes
88
**subject** | **String** | Subject of the campaign |
99
**type** | **String** | Type of campaign |
1010
**status** | **String** | Status of the campaign |
11-
**scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
11+
**scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1212

1313

docs/GetContactCampaignStatsOpened.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **Integer** | ID of the campaign which generated the event |
77
**count** | **Integer** | Number of openings of the campaign |
8-
**event_time** | **DateTime** | Date of the event |
8+
**event_time** | **DateTime** | UTC date-time of the event |
99
**ip** | **String** | IP from which the user has opened the campaign |
1010

1111

docs/GetContactDetails.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**id** | **Integer** | ID of the contact for which you requested the details |
88
**email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
99
**sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
10-
**modified_at** | **DateTime** | Last modification date of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
10+
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1111
**list_ids** | **Array<Integer>** | |
1212
**list_unsubscribed** | **Array<Integer>** | | [optional]
1313
**attributes** | **Hash<String, String>** | |

docs/GetEmailCampaign.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**subject** | **String** | Subject of the campaign |
99
**type** | **String** | Type of campaign |
1010
**status** | **String** | Status of the campaign |
11-
**scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
11+
**scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1212
**test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
1313
**header** | **String** | Header of the campaign |
1414
**footer** | **String** | Footer of the campaign |
@@ -18,8 +18,8 @@ Name | Type | Description | Notes
1818
**html_content** | **String** | HTML content of the campaign |
1919
**share_link** | **String** | Link to share the campaign on social medias | [optional]
2020
**tag** | **String** | Tag of the campaign |
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) |
21+
**created_at** | **DateTime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
22+
**modified_at** | **DateTime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
2323
**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]
2424
**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]
2525
**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]

docs/GetEmailEventReportEvents.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**email** | **String** | Email address which generates the event |
7-
**date** | **DateTime** | Date on which the event has been generated |
7+
**date** | **DateTime** | UTC date-time on which the event has been generated |
88
**subject** | **String** | Subject of the event | [optional]
99
**message_id** | **String** | Message ID which generated the event |
1010
**event** | **String** | Event which occurred |

docs/GetExtendedCampaignOverview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**subject** | **String** | Subject of the campaign |
99
**type** | **String** | Type of campaign |
1010
**status** | **String** | Status of the campaign |
11-
**scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
11+
**scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
1212
**test_sent** | **BOOLEAN** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
1313
**header** | **String** | Header of the campaign |
1414
**footer** | **String** | Footer of the campaign |
@@ -18,8 +18,8 @@ Name | Type | Description | Notes
1818
**html_content** | **String** | HTML content of the campaign |
1919
**share_link** | **String** | Link to share the campaign on social medias | [optional]
2020
**tag** | **String** | Tag of the campaign |
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) |
21+
**created_at** | **DateTime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
22+
**modified_at** | **DateTime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
2323
**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]
2424
**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]
2525
**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]

docs/GetExtendedContactDetails.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**id** | **Integer** | ID of the contact for which you requested the details |
88
**email_blacklisted** | **BOOLEAN** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
99
**sms_blacklisted** | **BOOLEAN** | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
10-
**modified_at** | **DateTime** | Last modification date of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
10+
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1111
**list_ids** | **Array<Integer>** | |
1212
**list_unsubscribed** | **Array<Integer>** | | [optional]
1313
**attributes** | **Hash<String, String>** | |

docs/GetExtendedContactDetailsStatisticsLinks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**count** | **Integer** | Number of clicks on this link for the campaign |
7-
**event_time** | **DateTime** | Date of the event |
7+
**event_time** | **DateTime** | UTC date-time of the event |
88
**ip** | **String** | IP from which the user has clicked on the link |
99
**url** | **String** | URL of the clicked link |
1010

docs/GetExtendedContactDetailsStatisticsMessagesSent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **Integer** | ID of the campaign which generated the event |
7-
**event_time** | **DateTime** | Date of the event |
7+
**event_time** | **DateTime** | UTC date-time of the event |
88

99

docs/GetExtendedContactDetailsStatisticsOpened.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **Integer** | ID of the campaign which generated the event |
77
**count** | **Integer** | Number of openings for the campaign |
8-
**event_time** | **DateTime** | Date of the event |
8+
**event_time** | **DateTime** | UTC date-time of the event |
99
**ip** | **String** | IP from which the user has opened the email |
1010

1111

docs/GetExtendedContactDetailsStatisticsUnsubscriptionsAdminUnsubscription.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**event_time** | **DateTime** | Date of the event |
6+
**event_time** | **DateTime** | UTC date-time of the event |
77
**ip** | **String** | IP from which the user has been unsubscribed |
88

99

docs/GetExtendedContactDetailsStatisticsUnsubscriptionsUserUnsubscription.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **Integer** | ID of the campaign which generated the event |
7-
**event_time** | **DateTime** | Date of the event |
7+
**event_time** | **DateTime** | UTC date-time of the event |
88
**ip** | **String** | IP from which the user has unsubscribed |
99

1010

docs/GetExtendedList.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**total_blacklisted** | **Integer** | Number of blacklisted contacts in the list |
99
**total_subscribers** | **Integer** | Number of contacts in the list |
1010
**folder_id** | **Integer** | ID of the folder |
11-
**created_at** | **DateTime** | Creation Date of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
11+
**created_at** | **DateTime** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1212
**campaign_stats** | [**Array<GetExtendedListCampaignStats>**](GetExtendedListCampaignStats.md) | | [optional]
1313
**dynamic_list** | **BOOLEAN** | Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) | [optional]
1414

docs/GetSmsCampaign.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
77
**name** | **String** | Name of the SMS Campaign |
88
**status** | **String** | Status of the SMS Campaign |
99
**content** | **String** | Content of the SMS Campaign |
10-
**scheduled_at** | **DateTime** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
10+
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
1111
**test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
1212
**sender** | **String** | Sender of the SMS Campaign |
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) |
13+
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
14+
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1515

1616

docs/GetSmsCampaignOverview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
77
**name** | **String** | Name of the SMS Campaign |
88
**status** | **String** | Status of the SMS Campaign |
99
**content** | **String** | Content of the SMS Campaign |
10-
**scheduled_at** | **DateTime** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
10+
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
1111
**test_sent** | **BOOLEAN** | Retrieved the status of test SMS sending. (true=Test SMS has been sent false=Test SMS has not been sent) |
1212
**sender** | **String** | Sender of the SMS Campaign |
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) |
13+
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
14+
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1515

1616

docs/GetSmtpTemplateOverview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**to_field** | **String** | Customisation of the \"to\" field for the template |
1414
**tag** | **String** | Tag of the template |
1515
**html_content** | **String** | HTML content of the template |
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) |
16+
**created_at** | **DateTime** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
17+
**modified_at** | **DateTime** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1818

1919

docs/GetWebhook.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**description** | **String** | Description of the webhook |
99
**events** | **Array<String>** | |
1010
**type** | **String** | Type of webhook (marketing or transac) |
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) |
11+
**created_at** | **DateTime** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
12+
**modified_at** | **DateTime** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
1313

1414

docs/ListsApi.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
195195
list_id = 789 # Integer | Id of the list
196196

197197
opts = {
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)
198+
modified_since: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
199199
limit: 50, # Integer | Number of documents per page
200200
offset: 0 # Integer | Index of the first document of the page
201201
}
@@ -214,7 +214,7 @@ end
214214
Name | Type | Description | Notes
215215
------------- | ------------- | ------------- | -------------
216216
**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]
217+
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
218218
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
219219
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
220220

docs/UpdateAttribute.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk::UpdateAttribute
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional]
7+
**enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional]
8+
9+

docs/UpdateAttributeEnumeration.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SibApiV3Sdk::UpdateAttributeEnumeration
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**value** | **Integer** | Id of the value |
7+
**label** | **String** | Label of the value |
8+
9+

0 commit comments

Comments
 (0)