@doist/comms-sdk 3.9.0 → 3.9.1

package/dist/esm/clients/users-client.js

@@ -164,16 +164,16 @@ export class UsersClient extends BaseClient {
         return this.post(`${ENDPOINT_USERS}/update`, args, UserSchema);
     }
     /**
-     * Sets the shared status of the session user, replacing any current one.
+     * Creates or partially updates the session user's shared status.
      * The status belongs to the Todoist account, so it is shared with Todoist.
      * Requires the `user:write` scope.
      *
      * @param args - The status to set.
-     * @param args.message - 1 to 80 characters once trimmed.
-     * @param args.emoji - Optional emoji.
-     * @param args.activeUntil - Optional expiry in the future (`Date` or ISO 8601 string).
-     * @param args.effects - Optional effects, e.g. `{ pauseNotifications: {} }` to hold back
-     *   Comms notifications while the status is active.
+     * @param args.message - 1 to 80 characters once trimmed. Required when creating a status.
+     * @param args.emoji - Emoji to set; null removes it, omission preserves it.
+     * @param args.activeUntil - Future expiry (`Date` or ISO string); null removes it, omission preserves it.
+     * @param args.effects - Merge supplied effects. Omission or {} preserves effects; null clears all.
+     *   An individual effect set to null is removed; {} preserves its configuration or enables defaults.
      * @returns The updated user object.
      *
      * @example

package/dist/types/clients/users-client.d.ts

@@ -160,16 +160,16 @@ export declare class UsersClient extends BaseClient {
      */
     update(args: UpdateUserArgs): Promise<User>;
     /**
-     * Sets the shared status of the session user, replacing any current one.
+     * Creates or partially updates the session user's shared status.
      * The status belongs to the Todoist account, so it is shared with Todoist.
      * Requires the `user:write` scope.
      *
      * @param args - The status to set.
-     * @param args.message - 1 to 80 characters once trimmed.
-     * @param args.emoji - Optional emoji.
-     * @param args.activeUntil - Optional expiry in the future (`Date` or ISO 8601 string).
-     * @param args.effects - Optional effects, e.g. `{ pauseNotifications: {} }` to hold back
-     *   Comms notifications while the status is active.
+     * @param args.message - 1 to 80 characters once trimmed. Required when creating a status.
+     * @param args.emoji - Emoji to set; null removes it, omission preserves it.
+     * @param args.activeUntil - Future expiry (`Date` or ISO string); null removes it, omission preserves it.
+     * @param args.effects - Merge supplied effects. Omission or {} preserves effects; null clears all.
+     *   An individual effect set to null is removed; {} preserves its configuration or enables defaults.
      * @returns The updated user object.
      *
      * @example

package/dist/types/types/requests.d.ts

@@ -189,21 +189,23 @@ export type UpdateUserArgs = {
 };
 type StatusEffectArgs = {
     scope?: {
-        mode: 'all';
+        mode?: 'all';
     };
 };
+/** Only supplied fields change. Null removes optional fields and effects. */
 export type SetStatusArgs = {
-    /** 1 to 80 characters once trimmed. */
-    message: string;
+    /** 1 to 80 characters once trimmed. Required when creating a status; omission preserves it. */
+    message?: string;
     emoji?: string | null;
-    /** When the status ends. Must be in the future. A `Date` is sent as an ISO 8601 string. */
+    /** Must be in the future; null removes expiry, omission preserves it. Dates are sent as ISO strings. */
     activeUntil?: Date | string | null;
+    /** Supplied effects are merged; null clears all effects, omission or {} preserves them. */
     effects?: {
-        /** Holds back Comms notifications while the status is active. They are not sent later. */
-        pauseNotifications?: StatusEffectArgs;
-        /** Meant to pause Karma and streaks while the status is active. Comms drops it until Doist/comms-backend#1081 ships. */
-        pauseActivity?: StatusEffectArgs;
-    };
+        /** Holds back Comms notifications. Null removes it; {} preserves its configuration or enables it with defaults. */
+        pauseNotifications?: StatusEffectArgs | null;
+        /** Pauses Todoist Karma and streaks. Null removes it; {} preserves its configuration or enables it with defaults. */
+        pauseActivity?: StatusEffectArgs | null;
+    } | null;
 };
 type SearchArgsCommon = {
     workspaceId: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@doist/comms-sdk",
-    "version": "3.9.0",
+    "version": "3.9.1",
     "description": "A TypeScript wrapper for the Comms REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/comms-sdk-typescript/",