Skip to content

Swagger update: For minor changes in contact attributes api #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 27, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ api_instance = SibApiV3Sdk::ContactsApi.new
opts = {
limit: 50, # Integer | Number of documents per page
offset: 0, # Integer | Index of the first document of the page
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)
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)
}

begin
Expand All @@ -645,7 +645,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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]
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]

### Return type

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

opts = {
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)
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)
limit: 50, # Integer | Number of documents per page
offset: 0 # Integer | Index of the first document of the page
}
Expand All @@ -703,7 +703,7 @@ end
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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]
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC 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]

Expand Down
9 changes: 9 additions & 0 deletions docs/CreateAttributeEnumeration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SibApiV3Sdk::CreateAttributeEnumeration

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **Integer** | Id of the value |
**label** | **String** | Label of the value |


2 changes: 1 addition & 1 deletion docs/CreateEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -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** | **DateTime** | Sending date and time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduled_at** | **DateTime** | Sending UTC date-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]
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -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** | **DateTime** | Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduled_at** | **DateTime** | UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]


2 changes: 1 addition & 1 deletion docs/GetCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Name | Type | Description | Notes
**subject** | **String** | Subject of the campaign |
**type** | **String** | Type of campaign |
**status** | **String** | Status of the campaign |
**scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]


2 changes: 1 addition & 1 deletion docs/GetContactCampaignStatsOpened.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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 |
**event_time** | **DateTime** | UTC date-time of the event |
**ip** | **String** | IP from which the user has opened the campaign |


2 changes: 1 addition & 1 deletion docs/GetContactDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**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** | **DateTime** | Last modification date of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**list_ids** | **Array<Integer>** | |
**list_unsubscribed** | **Array<Integer>** | | [optional]
**attributes** | **Hash<String, String>** | |
Expand Down
6 changes: 3 additions & 3 deletions docs/GetEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**subject** | **String** | Subject of the campaign |
**type** | **String** | Type of campaign |
**status** | **String** | Status of the campaign |
**scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [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 |
Expand All @@ -18,8 +18,8 @@ Name | Type | Description | Notes
**html_content** | **String** | HTML content of the campaign |
**share_link** | **String** | Link to share the campaign on social medias | [optional]
**tag** | **String** | Tag of the campaign |
**created_at** | **DateTime** | Creation date of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Date of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**created_at** | **DateTime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**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]
Expand Down
2 changes: 1 addition & 1 deletion docs/GetEmailEventReportEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **String** | Email address which generates the event |
**date** | **DateTime** | Date on which the event has been generated |
**date** | **DateTime** | UTC date-time on which the event has been generated |
**subject** | **String** | Subject of the event | [optional]
**message_id** | **String** | Message ID which generated the event |
**event** | **String** | Event which occurred |
Expand Down
6 changes: 3 additions & 3 deletions docs/GetExtendedCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**subject** | **String** | Subject of the campaign |
**type** | **String** | Type of campaign |
**status** | **String** | Status of the campaign |
**scheduled_at** | **DateTime** | Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
**scheduled_at** | **DateTime** | UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) | [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 |
Expand All @@ -18,8 +18,8 @@ Name | Type | Description | Notes
**html_content** | **String** | HTML content of the campaign |
**share_link** | **String** | Link to share the campaign on social medias | [optional]
**tag** | **String** | Tag of the campaign |
**created_at** | **DateTime** | Creation date of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Date of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**created_at** | **DateTime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**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]
Expand Down
2 changes: 1 addition & 1 deletion docs/GetExtendedContactDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**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** | **DateTime** | Last modification date of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**list_ids** | **Array<Integer>** | |
**list_unsubscribed** | **Array<Integer>** | | [optional]
**attributes** | **Hash<String, String>** | |
Expand Down
2 changes: 1 addition & 1 deletion docs/GetExtendedContactDetailsStatisticsLinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **Integer** | Number of clicks on this link for the campaign |
**event_time** | **DateTime** | Date of the event |
**event_time** | **DateTime** | UTC date-time of the event |
**ip** | **String** | IP from which the user has clicked on the link |
**url** | **String** | URL of the clicked link |

Expand Down
2 changes: 1 addition & 1 deletion docs/GetExtendedContactDetailsStatisticsMessagesSent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_id** | **Integer** | ID of the campaign which generated the event |
**event_time** | **DateTime** | Date of the event |
**event_time** | **DateTime** | UTC date-time of the event |


2 changes: 1 addition & 1 deletion docs/GetExtendedContactDetailsStatisticsOpened.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_id** | **Integer** | ID of the campaign which generated the event |
**count** | **Integer** | Number of openings for the campaign |
**event_time** | **DateTime** | Date of the event |
**event_time** | **DateTime** | UTC date-time of the event |
**ip** | **String** | IP from which the user has opened the email |


Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event_time** | **DateTime** | Date of the event |
**event_time** | **DateTime** | UTC date-time of the event |
**ip** | **String** | IP from which the user has been unsubscribed |


Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_id** | **Integer** | ID of the campaign which generated the event |
**event_time** | **DateTime** | Date of the event |
**event_time** | **DateTime** | UTC date-time of the event |
**ip** | **String** | IP from which the user has unsubscribed |


2 changes: 1 addition & 1 deletion docs/GetExtendedList.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**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** | **DateTime** | Creation Date of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**created_at** | **DateTime** | Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**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]

Expand Down
6 changes: 3 additions & 3 deletions docs/GetSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Name | Type | Description | Notes
**name** | **String** | Name of the SMS Campaign |
**status** | **String** | Status of the SMS Campaign |
**content** | **String** | Content of the SMS Campaign |
**scheduled_at** | **DateTime** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ 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** | **DateTime** | Creation date of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Date of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |


6 changes: 3 additions & 3 deletions docs/GetSmsCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Name | Type | Description | Notes
**name** | **String** | Name of the SMS Campaign |
**status** | **String** | Status of the SMS Campaign |
**content** | **String** | Content of the SMS Campaign |
**scheduled_at** | **DateTime** | Date on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ 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** | **DateTime** | Creation date of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Date of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |


4 changes: 2 additions & 2 deletions docs/GetSmtpTemplateOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**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** | **DateTime** | Creation date of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Last modification date of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**created_at** | **DateTime** | Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ) |


4 changes: 2 additions & 2 deletions docs/GetWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**description** | **String** | Description of the webhook |
**events** | **Array<String>** | |
**type** | **String** | Type of webhook (marketing or transac) |
**created_at** | **DateTime** | Creation date of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Last modification date of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**created_at** | **DateTime** | Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ) |


4 changes: 2 additions & 2 deletions docs/ListsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ api_instance = SibApiV3Sdk::ListsApi.new
list_id = 789 # Integer | Id of the list

opts = {
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)
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)
limit: 50, # Integer | Number of documents per page
offset: 0 # Integer | Index of the first document of the page
}
Expand All @@ -214,7 +214,7 @@ end
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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]
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC 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]

Expand Down
9 changes: 9 additions & 0 deletions docs/UpdateAttribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SibApiV3Sdk::UpdateAttribute

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional]
**enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional]


9 changes: 9 additions & 0 deletions docs/UpdateAttributeEnumeration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# SibApiV3Sdk::UpdateAttributeEnumeration

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **Integer** | Id of the value |
**label** | **String** | Label of the value |


Loading