@segment/public-api-sdk-typescript 72.0.0-b17382 → 72.0.0-b17400

package/api/activationsApi.ts

@@ -119,7 +119,7 @@ export class ActivationsApi {
     }
 
     /**
-     * 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.
      * @summary Add Activation to Audience
      * @param spaceId
      * @param audienceId
@@ -279,7 +279,7 @@ export class ActivationsApi {
         });
     }
     /**
-     * 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.
      * @summary Add Destination to Audience
      * @param spaceId
      * @param audienceId

package/model/activationOutput.ts

@@ -43,7 +43,7 @@ export class ActivationOutput {
      */
     'connectionId': string;
     /**
-     * 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.
      */
     'activationType': string;
     /**
@@ -53,7 +53,7 @@ export class ActivationOutput {
     'personalization': PersonalizationInput;
     'destinationMapping'?: DestinationSubscriptionConfiguration;
     /**
-     * Whether to perform a resync after creation of the activation.
+     * Indicates if a full resync is currently pending or in progress.
      */
     'performResync'?: boolean;
 

package/model/addActivationToAudienceAlphaInput.ts

@@ -19,15 +19,15 @@ import { PersonalizationInput } from './personalizationInput';
  */
 export class AddActivationToAudienceAlphaInput {
     /**
-     * Whether the event emitter should be created in an enabled state. Will trigger an audience run if enabled.
+     * Determines whether an activation is enabled.
      */
     'enabled'?: boolean;
     /**
-     * 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.
      */
     'performResync': boolean;
     /**
-     * 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.
      */
     'activationType': string;
     /**

package/model/addDestinationToAudienceAlphaInput.ts

@@ -20,11 +20,11 @@ import { IDSyncConfigurationInput } from './iDSyncConfigurationInput';
 export class AddDestinationToAudienceAlphaInput {
     'destination': DestinationInput;
     /**
-     * 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.
      */
     'idSyncConfiguration'?: Array<IDSyncConfigurationInput>;
     /**
-     * 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.
+     * 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.
      */
     'connectionSettings'?: any | null;
 

package/model/addDestinationToAudienceAlphaOutput.ts

@@ -17,11 +17,11 @@ import { IDSyncConfigurationInput } from './iDSyncConfigurationInput';
 export class AddDestinationToAudienceAlphaOutput {
     'connection': Connection;
     /**
-     * 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.
      */
     'idSyncConfiguration': Array<IDSyncConfigurationInput>;
     /**
-     * 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.
+     * 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.
      */
     'connectionSettings'?: any | null;
 

package/model/destinationInput.ts

@@ -17,11 +17,11 @@ import { RequestFile } from './models';
  */
 export class DestinationInput {
     /**
-     * The Destination instance id.
+     * The Destination id. Use the List Destinations endpoint to look up available ids.
      */
     'id': string;
     /**
-     * Type of Destination to add to the audience.
+     * The category of the Destination.  Possible values: destination, warehouse.
      */
     'type': string;
 

package/model/destinationSubscriptionConfiguration.ts

@@ -17,7 +17,7 @@ import { RequestFile } from './models';
  */
 export class DestinationSubscriptionConfiguration {
     /**
-     * The action id to instantiate.
+     * The id for the action that Segment should perform on the Destination.
      */
     'actionId': string;
     /**

package/model/iDSyncConfigurationInput.ts

@@ -17,11 +17,11 @@ import { RequestFile } from './models';
  */
 export class IDSyncConfigurationInput {
     /**
-     * The external id to sync, for example \"user_id\" or \"email\".
+     * The id type to sync. Examples: user_id, email, anonymous_id.
      */
     'externalId': string;
     /**
-     * The strategy for syncing this identifier. Valid values: \"first\", \"last\", \"all\".
+     * The rule for selecting which identifiers to sync from a profile.  Possible values: first: Syncs only the oldest recorded value. last: Syncs only the most recently updated value. all: Syncs every value found on the profile (sends multiple events).
      */
     'strategy': string;
 

package/model/personalizationInput.ts

@@ -24,7 +24,7 @@ export class PersonalizationInput {
      */
     'entities'?: Array<PersonalizationInputEntity>;
     /**
-     * Sync entity property changes back to Segment. Only applicable if activationType is \"Audience Membership Changed\".
+     * Sync entity property changes to the Destination. Only applicable if activationType is \"Audience Membership Changed\".
      */
     'syncEntityPropertyChanges'?: boolean;
 

package/model/simpleDestination.ts

@@ -49,11 +49,11 @@ export class SimpleDestination {
     'destinationId': string;
     'metadata'?: Metadata;
     /**
-     * ID Sync configuration - 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.
      */
     'idSyncConfiguration'?: Array<IDSyncConfigurationInput>;
     /**
-     * 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.
+     * 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.
      */
     'connectionSettings'?: any | null;
 

package/model/updateActivationForAudienceAlphaInput.ts

@@ -29,7 +29,7 @@ export class UpdateActivationForAudienceAlphaInput {
     'personalization'?: PersonalizationInput;
     'destinationMapping'?: DestinationSubscriptionConfiguration;
     /**
-     * Whether to perform a resync after creation of the activation.
+     * Determines whether to perform a full resync after the update. If true, the entire audience is resent to the Destination using the updated configuration. If false, the update applies only to future syncs.
      */
     'performResync'?: boolean;
 

package/package.json

@@ -18,7 +18,7 @@
         "uuid": "^8.3.2",
         "request": "^2.88.2"
     },
-    "version": "72.0.0-b17382",
+    "version": "72.0.0-b17400",
     "devDependencies": {
         "@types/bluebird": "^3.5.33",
         "@types/jest": "^29",