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 @@ All URIs are relative to *https://api.segmentapis.com*
 
 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
 
@@ -101,7 +101,7 @@ public class Example {
 
 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
 

src/main/java/com/segment/publicapi/api/ActivationsApi.java

@@ -205,11 +205,13 @@ private okhttp3.Call addActivationToAudienceValidateBeforeCall(
     }
 
     /**
-     * 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
+     * Add Activation to Audience 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
@@ -244,11 +246,13 @@ public AddActivationToAudience200Response addActivationToAudience(
     }
 
     /**
-     * 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
+     * Add Activation to Audience 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
@@ -284,15 +288,18 @@ public ApiResponse<AddActivationToAudience200Response> addActivationToAudienceWi
     }
 
     /**
-     * Add Activation to Audience (asynchronously) 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 &#x60;Activation Created&#x60;
-     * 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.
+     * Add Activation to Audience (asynchronously) 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 &#x60;Activation
+     * Created&#x60; 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.
      *
      * @param spaceId (required)
      * @param audienceId (required)
@@ -449,16 +456,18 @@ private okhttp3.Call addDestinationToAudienceValidateBeforeCall(
     }
 
     /**
-     * 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 &#x60;Destination Added into
-     * Audience&#x60; 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.
+     * Add Destination to Audience 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 &#x60;Destination Added into Audience&#x60; 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.
      *
      * @param spaceId (required)
      * @param audienceId (required)
@@ -487,16 +496,18 @@ public AddDestinationToAudience200Response addDestinationToAudience(
     }
 
     /**
-     * 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 &#x60;Destination Added into
-     * Audience&#x60; 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.
+     * Add Destination to Audience 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 &#x60;Destination Added into Audience&#x60; 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.
      *
      * @param spaceId (required)
      * @param audienceId (required)
@@ -526,13 +537,16 @@ public ApiResponse<AddDestinationToAudience200Response> addDestinationToAudience
     }
 
     /**
-     * Add Destination to Audience (asynchronously) 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 &#x60;Destination Added
-     * into Audience&#x60; 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
+     * Add Destination to Audience (asynchronously) 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 &#x60;Destination Added into
+     * Audience&#x60; 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.

src/main/java/com/segment/publicapi/models/ActivationOutput.java

@@ -213,7 +213,12 @@ public ActivationOutput activationType(String activationType) {
     }
 
     /**
-     * Type of activation trigger.
+     * 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.
      *
      * @return activationType
      */
@@ -294,7 +299,7 @@ public ActivationOutput performResync(Boolean performResync) {
     }
 
     /**
-     * Whether to perform a resync after creation of the activation.
+     * Indicates if a full resync is currently pending or in progress.
      *
      * @return performResync
      */

src/main/java/com/segment/publicapi/models/AddActivationToAudienceAlphaInput.java

@@ -68,8 +68,7 @@ public AddActivationToAudienceAlphaInput enabled(Boolean enabled) {
     }
 
     /**
-     * Whether the event emitter should be created in an enabled state. Will trigger an audience run
-     * if enabled.
+     * Determines whether an activation is enabled.
      *
      * @return enabled
      */
@@ -89,7 +88,8 @@ public AddActivationToAudienceAlphaInput performResync(Boolean performResync) {
     }
 
     /**
-     * Whether to perform a resync after creation of the activation.
+     * 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.
      *
      * @return performResync
      */
@@ -109,7 +109,12 @@ public AddActivationToAudienceAlphaInput activationType(String activationType) {
     }
 
     /**
-     * Type of activation trigger.
+     * 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.
      *
      * @return activationType
      */

src/main/java/com/segment/publicapi/models/AddDestinationToAudienceAlphaInput.java

@@ -88,8 +88,9 @@ public AddDestinationToAudienceAlphaInput addIdSyncConfigurationItem(
     }
 
     /**
-     * Identifier sync configuration - array of external IDs to sync with their strategies. Maximum
-     * 5 items allowed.
+     * 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.
      *
      * @return idSyncConfiguration
      */
@@ -110,7 +111,8 @@ public AddDestinationToAudienceAlphaInput connectionSettings(Object connectionSe
 
     /**
      * 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.
+     * settings are Destination-specific. Use the List Supported Destinations from Audience endpoint
+     * to find the required connection settings.
      *
      * @return connectionSettings
      */

src/main/java/com/segment/publicapi/models/AddDestinationToAudienceAlphaOutput.java

@@ -88,7 +88,9 @@ public AddDestinationToAudienceAlphaOutput addIdSyncConfigurationItem(
     }
 
     /**
-     * The id sync configuration for the Destination - array of external ids with their strategies.
+     * 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.
      *
      * @return idSyncConfiguration
      */
@@ -109,7 +111,8 @@ public AddDestinationToAudienceAlphaOutput connectionSettings(Object connectionS
 
     /**
      * 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.
+     * settings are Destination-specific. Use the List Supported Destinations from Audience endpoint
+     * to find the required connection settings.
      *
      * @return connectionSettings
      */