Automatically update NodeJS SDK

github-actions[bot] · github-actions[bot] · commit 5fb04b18203e · 2026-06-07T09:37:01.000Z
diff --git a/api/errors/ForbiddenError.d.ts b/api/errors/ForbiddenError.d.ts
@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors";
+import * as TrophyApi from "..";
+export declare class ForbiddenError extends errors.TrophyApiError {
+    constructor(body: TrophyApi.ErrorBody);
+}
diff --git a/api/errors/ForbiddenError.js b/api/errors/ForbiddenError.js
@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForbiddenError = void 0;
+const errors = __importStar(require("../../errors"));
+class ForbiddenError extends errors.TrophyApiError {
+    constructor(body) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}
+exports.ForbiddenError = ForbiddenError;
diff --git a/api/errors/index.d.ts b/api/errors/index.d.ts
@@ -2,3 +2,4 @@ export * from "./UnauthorizedError";
 export * from "./UnprocessableEntityError";
 export * from "./NotFoundError";
 export * from "./BadRequestError";
+export * from "./ForbiddenError";
diff --git a/api/errors/index.js b/api/errors/index.js
@@ -18,3 +18,4 @@ __exportStar(require("./UnauthorizedError"), exports);
 __exportStar(require("./UnprocessableEntityError"), exports);
 __exportStar(require("./NotFoundError"), exports);
 __exportStar(require("./BadRequestError"), exports);
+__exportStar(require("./ForbiddenError"), exports);
diff --git a/api/resources/users/client/Client.d.ts b/api/resources/users/client/Client.d.ts
@@ -86,8 +86,9 @@ export declare class Users {
      */
     getPreferences(id: string, requestOptions?: Users.RequestOptions): Promise<TrophyApi.UserPreferencesResponse>;
     /**
-     * Update a user's notification preferences.
+     * Update a user's notification and streak preferences. Streak preferences require streak customization to be enabled in your Trophy dashboard settings.
      * @throws {@link TrophyApi.UnauthorizedError}
+     * @throws {@link TrophyApi.ForbiddenError}
      * @throws {@link TrophyApi.NotFoundError}
      * @throws {@link TrophyApi.UnprocessableEntityError}
      *
@@ -111,6 +112,17 @@ export declare class Users {
      *             achievementCompleted: [TrophyApi.NotificationChannel.Email, TrophyApi.NotificationChannel.Push]
      *         }
      *     })
+     *
+     * @example
+     *     await trophyApi.users.updatePreferences("user-123", {
+     *         streak: {
+     *             evaluationMode: TrophyApi.StreakEvaluationModePreference.Or,
+     *             metrics: [{
+     *                     key: "words-written",
+     *                     threshold: 500
+     *                 }]
+     *         }
+     *     })
      */
     updatePreferences(id: string, request?: TrophyApi.UpdateUserPreferencesRequest, requestOptions?: Users.RequestOptions): Promise<TrophyApi.UserPreferencesResponse>;
     /**
diff --git a/api/resources/users/client/Client.js b/api/resources/users/client/Client.js
@@ -477,8 +477,9 @@ class Users {
         });
     }
     /**
-     * Update a user's notification preferences.
+     * Update a user's notification and streak preferences. Streak preferences require streak customization to be enabled in your Trophy dashboard settings.
      * @throws {@link TrophyApi.UnauthorizedError}
+     * @throws {@link TrophyApi.ForbiddenError}
      * @throws {@link TrophyApi.NotFoundError}
      * @throws {@link TrophyApi.UnprocessableEntityError}
      *
@@ -502,6 +503,17 @@ class Users {
      *             achievementCompleted: [TrophyApi.NotificationChannel.Email, TrophyApi.NotificationChannel.Push]
      *         }
      *     })
+     *
+     * @example
+     *     await trophyApi.users.updatePreferences("user-123", {
+     *         streak: {
+     *             evaluationMode: TrophyApi.StreakEvaluationModePreference.Or,
+     *             metrics: [{
+     *                     key: "words-written",
+     *                     threshold: 500
+     *                 }]
+     *         }
+     *     })
      */
     updatePreferences(id, request = {}, requestOptions) {
         var _a;
@@ -541,6 +553,13 @@ class Users {
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
+                    case 403:
+                        throw new TrophyApi.ForbiddenError(yield serializers.ErrorBody.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
                     case 404:
                         throw new TrophyApi.NotFoundError(yield serializers.ErrorBody.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
diff --git a/api/resources/users/client/requests/UpdateUserPreferencesRequest.d.ts b/api/resources/users/client/requests/UpdateUserPreferencesRequest.d.ts
@@ -23,7 +23,19 @@ import * as TrophyApi from "../../../..";
  *             achievementCompleted: [TrophyApi.NotificationChannel.Email, TrophyApi.NotificationChannel.Push]
  *         }
  *     }
+ *
+ * @example
+ *     {
+ *         streak: {
+ *             evaluationMode: TrophyApi.StreakEvaluationModePreference.Or,
+ *             metrics: [{
+ *                     key: "words-written",
+ *                     threshold: 500
+ *                 }]
+ *         }
+ *     }
  */
 export interface UpdateUserPreferencesRequest {
     notifications?: TrophyApi.NotificationPreferences;
+    streak?: TrophyApi.StreakPreferences;
 }
diff --git a/api/types/StreakEvaluationModePreference.d.ts b/api/types/StreakEvaluationModePreference.d.ts
@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Whether meeting any single metric threshold (`OR`) or all configured metric thresholds (`AND`) extends the user's streak. Matches the evaluation mode configured in dashboard streak settings.
+ */
+export declare type StreakEvaluationModePreference = "OR" | "AND";
+export declare const StreakEvaluationModePreference: {
+    readonly Or: "OR";
+    readonly And: "AND";
+};
diff --git a/api/types/StreakEvaluationModePreference.js b/api/types/StreakEvaluationModePreference.js
@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreakEvaluationModePreference = void 0;
+exports.StreakEvaluationModePreference = {
+    Or: "OR",
+    And: "AND",
+};
diff --git a/api/types/StreakMetricPreference.d.ts b/api/types/StreakMetricPreference.d.ts
@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Per-metric streak threshold override for a user.
+ */
+export interface StreakMetricPreference {
+    /** The metric key. */
+    key: string;
+    /** Minimum metric change in a streak period to count toward the streak. */
+    threshold: number;
+}
diff --git a/api/types/StreakMetricPreference.js b/api/types/StreakMetricPreference.js
@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
diff --git a/api/types/StreakPreferences.d.ts b/api/types/StreakPreferences.d.ts
@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TrophyApi from "..";
+/**
+ * Per-user streak configuration. Requires streak customization to be enabled in dashboard settings.
+ */
+export interface StreakPreferences {
+    evaluationMode?: TrophyApi.StreakEvaluationModePreference;
+    /** Metrics and thresholds that count toward this user's streak. */
+    metrics?: TrophyApi.StreakMetricPreference[];
+}
diff --git a/api/types/StreakPreferences.js b/api/types/StreakPreferences.js
@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
diff --git a/api/types/UserPreferencesResponse.d.ts b/api/types/UserPreferencesResponse.d.ts
@@ -7,4 +7,5 @@ import * as TrophyApi from "..";
  */
 export interface UserPreferencesResponse {
     notifications: TrophyApi.NotificationPreferences;
+    streak?: TrophyApi.StreakPreferences;
 }
diff --git a/api/types/index.d.ts b/api/types/index.d.ts
@@ -61,6 +61,9 @@ export * from "./UpsertedUser";
 export * from "./User";
 export * from "./NotificationChannel";
 export * from "./NotificationPreferences";
+export * from "./StreakEvaluationModePreference";
+export * from "./StreakMetricPreference";
+export * from "./StreakPreferences";
 export * from "./UserPreferencesResponse";
 export * from "./ErrorBody";
 export * from "./AchievementCompletionResponse";
diff --git a/api/types/index.js b/api/types/index.js
@@ -77,6 +77,9 @@ __exportStar(require("./UpsertedUser"), exports);
 __exportStar(require("./User"), exports);
 __exportStar(require("./NotificationChannel"), exports);
 __exportStar(require("./NotificationPreferences"), exports);
+__exportStar(require("./StreakEvaluationModePreference"), exports);
+__exportStar(require("./StreakMetricPreference"), exports);
+__exportStar(require("./StreakPreferences"), exports);
 __exportStar(require("./UserPreferencesResponse"), exports);
 __exportStar(require("./ErrorBody"), exports);
 __exportStar(require("./AchievementCompletionResponse"), exports);
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@trophyso/node",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "NodeJS SDK for the Trophy API",
   "main": "index.js",
   "scripts": {
diff --git a/serialization/resources/users/client/requests/UpdateUserPreferencesRequest.d.ts b/serialization/resources/users/client/requests/UpdateUserPreferencesRequest.d.ts
@@ -8,5 +8,6 @@ export declare const UpdateUserPreferencesRequest: core.serialization.Schema<ser
 export declare namespace UpdateUserPreferencesRequest {
     interface Raw {
         notifications?: serializers.NotificationPreferences.Raw | null;
+        streak?: serializers.StreakPreferences.Raw | null;
     }
 }
diff --git a/serialization/resources/users/client/requests/UpdateUserPreferencesRequest.js b/serialization/resources/users/client/requests/UpdateUserPreferencesRequest.js
@@ -41,4 +41,5 @@ exports.UpdateUserPreferencesRequest = core.serialization.object({
     notifications: core.serialization
         .lazyObject(() => __awaiter(void 0, void 0, void 0, function* () { return (yield Promise.resolve().then(() => __importStar(require("../../../..")))).NotificationPreferences; }))
         .optional(),
+    streak: core.serialization.lazyObject(() => __awaiter(void 0, void 0, void 0, function* () { return (yield Promise.resolve().then(() => __importStar(require("../../../..")))).StreakPreferences; })).optional(),
 });
diff --git a/serialization/types/StreakEvaluationModePreference.d.ts b/serialization/types/StreakEvaluationModePreference.d.ts
@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "..";
+import * as TrophyApi from "../../api";
+import * as core from "../../core";
+export declare const StreakEvaluationModePreference: core.serialization.Schema<serializers.StreakEvaluationModePreference.Raw, TrophyApi.StreakEvaluationModePreference>;
+export declare namespace StreakEvaluationModePreference {
+    type Raw = "OR" | "AND";
+}
diff --git a/serialization/types/StreakEvaluationModePreference.js b/serialization/types/StreakEvaluationModePreference.js
@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreakEvaluationModePreference = void 0;
+const core = __importStar(require("../../core"));
+exports.StreakEvaluationModePreference = core.serialization.enum_(["OR", "AND"]);
diff --git a/serialization/types/StreakMetricPreference.d.ts b/serialization/types/StreakMetricPreference.d.ts
@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "..";
+import * as TrophyApi from "../../api";
+import * as core from "../../core";
+export declare const StreakMetricPreference: core.serialization.ObjectSchema<serializers.StreakMetricPreference.Raw, TrophyApi.StreakMetricPreference>;
+export declare namespace StreakMetricPreference {
+    interface Raw {
+        key: string;
+        threshold: number;
+    }
+}
diff --git a/serialization/types/StreakMetricPreference.js b/serialization/types/StreakMetricPreference.js
@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreakMetricPreference = void 0;
+const core = __importStar(require("../../core"));
+exports.StreakMetricPreference = core.serialization.object({
+    key: core.serialization.string(),
+    threshold: core.serialization.number(),
+});
diff --git a/serialization/types/StreakPreferences.d.ts b/serialization/types/StreakPreferences.d.ts
@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "..";
+import * as TrophyApi from "../../api";
+import * as core from "../../core";
+export declare const StreakPreferences: core.serialization.ObjectSchema<serializers.StreakPreferences.Raw, TrophyApi.StreakPreferences>;
+export declare namespace StreakPreferences {
+    interface Raw {
+        evaluationMode?: serializers.StreakEvaluationModePreference.Raw | null;
+        metrics?: serializers.StreakMetricPreference.Raw[] | null;
+    }
+}
diff --git a/serialization/types/StreakPreferences.js b/serialization/types/StreakPreferences.js
diff --git a/serialization/types/UserPreferencesResponse.d.ts b/serialization/types/UserPreferencesResponse.d.ts
diff --git a/serialization/types/UserPreferencesResponse.js b/serialization/types/UserPreferencesResponse.js
diff --git a/serialization/types/index.d.ts b/serialization/types/index.d.ts
diff --git a/serialization/types/index.js b/serialization/types/index.js
