Skip to content

Commit 29df675

Browse files
committed
Swagger updates: Minor updates for contact attributes api
1 parent 91a3a8a commit 29df675

File tree

49 files changed

+127
-125
lines changed

Some content is hidden

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

49 files changed

+127
-125
lines changed

docs/ContactsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'
614614
api_instance = sib_api_v3_sdk.ContactsApi()
615615
limit = 50 # int | Number of documents per page (optional) (default to 50)
616616
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
617-
modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional)
617+
modified_since = '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) (optional)
618618

619619
try:
620620
# Get all the contacts
@@ -630,7 +630,7 @@ Name | Type | Description | Notes
630630
------------- | ------------- | ------------- | -------------
631631
**limit** | **int**| Number of documents per page | [optional] [default to 50]
632632
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
633-
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
633+
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
634634

635635
### Return type
636636

@@ -668,7 +668,7 @@ sib_api_v3_sdk.configuration.api_key['api-key'] = 'YOUR_API_KEY'
668668
# create an instance of the API class
669669
api_instance = sib_api_v3_sdk.ContactsApi()
670670
list_id = 789 # int | Id of the list
671-
modified_since = '2013-10-20T19:20:30+01:00' # datetime | Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) (optional)
671+
modified_since = '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) (optional)
672672
limit = 50 # int | Number of documents per page (optional) (default to 50)
673673
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
674674

@@ -685,7 +685,7 @@ except ApiException as e:
685685
Name | Type | Description | Notes
686686
------------- | ------------- | ------------- | -------------
687687
**list_id** | **int**| Id of the list |
688-
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
688+
**modified_since** | **datetime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) | [optional]
689689
**limit** | **int**| Number of documents per page | [optional] [default to 50]
690690
**offset** | **int**| Index of the first document of the page | [optional] [default to 0]
691691

docs/CreateEmailCampaign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**name** | **str** | Name of the campaign |
99
**html_content** | **str** | Mandatory if htmlUrl is empty. Body of the message (HTML) | [optional]
1010
**html_url** | **str** | 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** | **str** | Subject of the campaign |
1313
**reply_to** | **str** | Email on which the campaign recipients will be able to reply to | [optional]
1414
**to_field** | **str** | 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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**sender** | **str** | Name of the sender. The number of characters is limited to 11 |
88
**content** | **str** | 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
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

docs/GetCampaignOverview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**subject** | **str** | Subject of the campaign |
99
**type** | **str** | Type of campaign |
1010
**status** | **str** | 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
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1414

docs/GetContactCampaignStatsOpened.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**campaign_id** | **int** | ID of the campaign which generated the event |
77
**count** | **int** | 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** | **str** | IP from which the user has opened the campaign |
1010

1111
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/GetContactDetails.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**id** | **int** | ID of the contact for which you requested the details |
88
**email_blacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
99
**sms_blacklisted** | **bool** | 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** | **list[int]** | |
1212
**list_unsubscribed** | **list[int]** | | [optional]
1313
**attributes** | **dict(str, str)** | |

docs/GetEmailCampaign.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**subject** | **str** | Subject of the campaign |
99
**type** | **str** | Type of campaign |
1010
**status** | **str** | 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** | **bool** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
1313
**header** | **str** | Header of the campaign |
1414
**footer** | **str** | Footer of the campaign |
@@ -18,8 +18,8 @@ Name | Type | Description | Notes
1818
**html_content** | **str** | HTML content of the campaign |
1919
**share_link** | **str** | Link to share the campaign on social medias | [optional]
2020
**tag** | **str** | 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** | **bool** | 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** | **bool** | 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** | **bool** | 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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**email** | **str** | 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** | **str** | Subject of the event | [optional]
99
**message_id** | **str** | Message ID which generated the event |
1010
**event** | **str** | Event which occurred |

docs/GetExtendedCampaignOverview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**subject** | **str** | Subject of the campaign |
99
**type** | **str** | Type of campaign |
1010
**status** | **str** | 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** | **bool** | Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) |
1313
**header** | **str** | Header of the campaign |
1414
**footer** | **str** | Footer of the campaign |
@@ -18,8 +18,8 @@ Name | Type | Description | Notes
1818
**html_content** | **str** | HTML content of the campaign |
1919
**share_link** | **str** | Link to share the campaign on social medias | [optional]
2020
**tag** | **str** | 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** | **bool** | 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** | **bool** | 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** | **bool** | 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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**id** | **int** | ID of the contact for which you requested the details |
88
**email_blacklisted** | **bool** | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
99
**sms_blacklisted** | **bool** | 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** | **list[int]** | |
1212
**list_unsubscribed** | **list[int]** | | [optional]
1313
**attributes** | **dict(str, str)** | |

0 commit comments

Comments
 (0)