Automated SDK update

This updates the SDK from internal repo commit segmentio/public-api@81c918c7.

Author: APIs and Common Services team

docs/ActivationsApi.md

@@ -22,7 +22,7 @@ Method | HTTP request | Description
 
 Add Activation to Audience
 
-Creates Activation.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Activation Created` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
+Defines how audience data is sent to a Destination. This step enables the data sync. You must establish a connection (Add Destination to Audience) for this audience before an Activation can be created.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Activation Created` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
 
 ### Example
 
@@ -102,7 +102,7 @@ Name | Type | Description  | Notes
 
 Add Destination to Audience
 
-Adds a Destination to an Audience.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Destination Added into Audience` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
+Establishes a connection between an audience and a Destination. To start syncing data, you must create an Activation for the connection created here.  Note that the Destination must be added to Engage through the Engage Settings page within the App before creating the connection through the API.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Destination Added into Audience` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.
 
 ### Example
 

segment_public_api/api/activations_api.py

@@ -62,7 +62,7 @@ def __init__(self, api_client=None) -> None:
     def add_activation_to_audience(self, space_id : constr(strict=True), audience_id : constr(strict=True), connection_id : constr(strict=True), add_activation_to_audience_alpha_input : AddActivationToAudienceAlphaInput, **kwargs) -> AddActivationToAudience200Response:  # noqa: E501
         """Add Activation to Audience  # noqa: E501
 
-        Creates Activation.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Activation Created` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.  # noqa: E501
+        Defines how audience data is sent to a Destination. This step enables the data sync. You must establish a connection (Add Destination to Audience) for this audience before an Activation can be created.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Activation Created` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -98,7 +98,7 @@ def add_activation_to_audience(self, space_id : constr(strict=True), audience_id
     def add_activation_to_audience_with_http_info(self, space_id : constr(strict=True), audience_id : constr(strict=True), connection_id : constr(strict=True), add_activation_to_audience_alpha_input : AddActivationToAudienceAlphaInput, **kwargs) -> ApiResponse:  # noqa: E501
         """Add Activation to Audience  # noqa: E501
 
-        Creates Activation.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Activation Created` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.  # noqa: E501
+        Defines how audience data is sent to a Destination. This step enables the data sync. You must establish a connection (Add Destination to Audience) for this audience before an Activation can be created.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Activation Created` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -236,7 +236,7 @@ def add_activation_to_audience_with_http_info(self, space_id : constr(strict=Tru
     def add_destination_to_audience(self, space_id : constr(strict=True), audience_id : constr(strict=True), add_destination_to_audience_alpha_input : AddDestinationToAudienceAlphaInput, **kwargs) -> AddDestinationToAudience200Response:  # noqa: E501
         """Add Destination to Audience  # noqa: E501
 
-        Adds a Destination to an Audience.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Destination Added into Audience` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.  # noqa: E501
+        Establishes a connection between an audience and a Destination. To start syncing data, you must create an Activation for the connection created here.  Note that the Destination must be added to Engage through the Engage Settings page within the App before creating the connection through the API.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Destination Added into Audience` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -270,7 +270,7 @@ def add_destination_to_audience(self, space_id : constr(strict=True), audience_i
     def add_destination_to_audience_with_http_info(self, space_id : constr(strict=True), audience_id : constr(strict=True), add_destination_to_audience_alpha_input : AddDestinationToAudienceAlphaInput, **kwargs) -> ApiResponse:  # noqa: E501
         """Add Destination to Audience  # noqa: E501
 
-        Adds a Destination to an Audience.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Destination Added into Audience` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.  # noqa: E501
+        Establishes a connection between an audience and a Destination. To start syncing data, you must create an Activation for the connection created here.  Note that the Destination must be added to Engage through the Engage Settings page within the App before creating the connection through the API.  • This endpoint is in **Alpha** testing.  Please submit any feedback by sending an email to friends@segment.com.   • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.  • When called, this endpoint may generate the `Destination Added into Audience` event in the [audit trail](/tag/Audit-Trail).   The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

segment_public_api/models/activation_output.py

@@ -34,11 +34,11 @@ class ActivationOutput(BaseModel):
     space_id: StrictStr = Field(..., alias="spaceId", description="The space id.")
     audience_id: StrictStr = Field(..., alias="audienceId", description="The audience id.")
     connection_id: StrictStr = Field(..., alias="connectionId", description="The connection id.")
-    activation_type: StrictStr = Field(..., alias="activationType", description="Type of activation trigger.")
+    activation_type: StrictStr = Field(..., alias="activationType", description="Determines when an event is sent to the Destination.   Possible values: Audience Entered: Sends an event when a profile or entity enters the audience. Audience Exited: Sends an event when a profile or entity exits the audience. Audience Membership Changed: Sends an event for both entries and exits. This does not apply to entities.  Note that events are sent for the profile, unless the audience is a Linked Audience. In that case, events are sent for the target entity defined for that audience.")
     activation_name: StrictStr = Field(..., alias="activationName", description="Name of the activation.")
     personalization: PersonalizationInput = Field(...)
     destination_mapping: Optional[DestinationSubscriptionConfiguration] = Field(None, alias="destinationMapping")
-    perform_resync: Optional[StrictBool] = Field(None, alias="performResync", description="Whether to perform a resync after creation of the activation.")
+    perform_resync: Optional[StrictBool] = Field(None, alias="performResync", description="Indicates if a full resync is currently pending or in progress.")
     __properties = ["id", "enabled", "workspaceId", "spaceId", "audienceId", "connectionId", "activationType", "activationName", "personalization", "destinationMapping", "performResync"]
 
     class Config:

segment_public_api/models/add_activation_to_audience_alpha_input.py

@@ -28,9 +28,9 @@ class AddActivationToAudienceAlphaInput(BaseModel):
     """
     Input to create an activation.  # noqa: E501
     """
-    enabled: Optional[StrictBool] = Field(None, description="Whether the event emitter should be created in an enabled state. Will trigger an audience run if enabled.")
-    perform_resync: StrictBool = Field(..., alias="performResync", description="Whether to perform a resync after creation of the activation.")
-    activation_type: StrictStr = Field(..., alias="activationType", description="Type of activation trigger.")
+    enabled: Optional[StrictBool] = Field(None, description="Determines whether an activation is enabled.")
+    perform_resync: StrictBool = Field(..., alias="performResync", description="Determines whether to perform a full resync upon creation. If true, the entire audience is resent to the Destination from scratch. If false, only future changes will be synced.")
+    activation_type: StrictStr = Field(..., alias="activationType", description="Determines when an event is sent to the Destination.   Possible values: Audience Entered: Sends an event when a profile or entity enters the audience. Audience Exited: Sends an event when a profile or entity exits the audience. Audience Membership Changed: Sends an event for both entries and exits. This does not apply to entities.  Note that events are sent for the profile, unless the audience is a Linked Audience. In that case, events are sent for the target entity defined for that audience.")
     activation_name: StrictStr = Field(..., alias="activationName", description="Name of the activation.")
     personalization: PersonalizationInput = Field(...)
     destination_mapping: Optional[DestinationSubscriptionConfiguration] = Field(None, alias="destinationMapping")

segment_public_api/models/add_destination_to_audience_alpha_input.py

@@ -29,8 +29,8 @@ class AddDestinationToAudienceAlphaInput(BaseModel):
     Input to Add a Destination into an Audience.  # noqa: E501
     """
     destination: DestinationInput = Field(...)
-    id_sync_configuration: Optional[conlist(IDSyncConfigurationInput)] = Field(None, alias="idSyncConfiguration", description="Identifier sync configuration - array of external IDs to sync with their strategies. Maximum 5 items allowed.")
-    connection_settings: Optional[Any] = Field(None, alias="connectionSettings", description="The settings that a Destination requires to create audiences on a third-party platform. These settings are Destination-specific and thus are best defined as unknown.")
+    id_sync_configuration: Optional[conlist(IDSyncConfigurationInput)] = Field(None, alias="idSyncConfiguration", description="Identifier sync configuration. Defines which external ids to sync and their selection strategies. Maximum 5 items allowed. If omitted, the default will be last email and last user_id, or all email and all user_id depending on the Destination.")
+    connection_settings: Optional[Any] = Field(None, alias="connectionSettings", description="The settings that a Destination requires to create audiences on a third-party platform. These settings are Destination-specific. Use the List Supported Destinations from Audience endpoint to find the required connection settings.")
     __properties = ["destination", "idSyncConfiguration", "connectionSettings"]
 
     class Config:

segment_public_api/models/add_destination_to_audience_alpha_output.py

@@ -29,8 +29,8 @@ class AddDestinationToAudienceAlphaOutput(BaseModel):
     AddDestinationToAudienceAlphaOutput
     """
     connection: Connection = Field(...)
-    id_sync_configuration: conlist(IDSyncConfigurationInput) = Field(..., alias="idSyncConfiguration", description="The id sync configuration for the Destination - array of external ids with their strategies.")
-    connection_settings: Optional[Any] = Field(None, alias="connectionSettings", description="The settings that a Destination requires to create audiences on a third-party platform. These settings are Destination-specific and thus are best defined as unknown.")
+    id_sync_configuration: conlist(IDSyncConfigurationInput) = Field(..., alias="idSyncConfiguration", description="Identifier sync configuration. Defines which external ids to sync and their selection strategies. Maximum 5 items allowed. If omitted, the default will be last email and last user_id, or all email and all user_id depending on the Destination.")
+    connection_settings: Optional[Any] = Field(None, alias="connectionSettings", description="The settings that a Destination requires to create audiences on a third-party platform. These settings are Destination-specific. Use the List Supported Destinations from Audience endpoint to find the required connection settings.")
     __properties = ["connection", "idSyncConfiguration", "connectionSettings"]
 
     class Config:

segment_public_api/models/destination_input.py

@@ -26,8 +26,8 @@ class DestinationInput(BaseModel):
     """
     The Destination Input Object.  # noqa: E501
     """
-    id: StrictStr = Field(..., description="The Destination instance id.")
-    type: StrictStr = Field(..., description="Type of Destination to add to the audience.")
+    id: StrictStr = Field(..., description="The Destination id. Use the List Destinations endpoint to look up available ids.")
+    type: StrictStr = Field(..., description="The category of the Destination.  Possible values: destination, warehouse.")
     __properties = ["id", "type"]
 
     class Config: