@stream-io/feeds-client 1.7.0 → 1.9.0

package/src/gen/models/index.ts

@@ -554,7 +554,7 @@ export interface ActivityRequest {
 
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -971,7 +971,7 @@ export interface AddActivityRequest {
 
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -1111,7 +1111,7 @@ export interface AddCommentReactionRequest {
 
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -1157,7 +1157,7 @@ export interface AddCommentRequest {
 
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -1261,7 +1261,7 @@ export interface AddReactionRequest {
 
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -3830,6 +3830,11 @@ export interface EnrichmentOptions {
    */
   enrich_own_followings?: boolean;
 
+  /**
+   * Default: false. When true, includes the top-level flat 'activities' array in responses for aggregated feeds. By default, aggregated feeds only return 'aggregated_activities'.
+   */
+  include_flat_activities?: boolean;
+
   /**
    * Default: false. When true, includes score_vars in activity responses containing variable values used at ranking time.
    */
@@ -5041,9 +5046,14 @@ export interface FollowRequest {
    */
   target: string;
 
+  /**
+   * Maximum number of historical activities to copy from the target feed when the follow is first materialized. Defaults to 100. Range: 0-1000. 0 means no historical activities are copied.
+   */
+  activity_copy_limit?: number;
+
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -6872,6 +6882,9 @@ export interface PushPreferencesResponse {
 export interface QueryActivitiesRequest {
   enrich_own_fields?: boolean;
 
+  /**
+   * When true, include soft-deleted activities in the result.
+   */
   include_soft_deleted_activities?: boolean;
 
   limit?: number;
@@ -7454,6 +7467,9 @@ export interface QueryReviewQueueResponse {
 }
 
 export interface QueryUsersPayload {
+  /**
+   * Filter conditions to apply to the query
+   */
   filter_conditions: Record<string, any>;
 
   include_deactivated_users?: boolean;
@@ -7464,6 +7480,9 @@ export interface QueryUsersPayload {
 
   presence?: boolean;
 
+  /**
+   * Array of sort parameters
+   */
   sort?: SortParamRequest[];
 }
 
@@ -8577,7 +8596,7 @@ export interface UnpinActivityResponse {
 export interface UpdateActivityPartialRequest {
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when handle_mention_notifications creates notifications) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -8616,7 +8635,7 @@ export interface UpdateActivityPartialResponse {
 export interface UpdateActivityRequest {
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when handle_mention_notifications creates notifications) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -8819,7 +8838,7 @@ export interface UpdateCollectionsResponse {
 export interface UpdateCommentPartialRequest {
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to notification activities Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -8863,7 +8882,7 @@ export interface UpdateCommentRequest {
 
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when handle_mention_notifications creates notifications) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;
 
@@ -8977,9 +8996,14 @@ export interface UpdateFollowRequest {
    */
   target: string;
 
+  /**
+   * Maximum number of historical activities to copy from the target feed when the follow is first materialized. Defaults to 100. Range: 0-1000. 0 means no historical activities are copied.
+   */
+  activity_copy_limit?: number;
+
   /**
    * @deprecated
-   * Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
+   * Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead
    */
   copy_custom_to_notification?: boolean;