@amityco/ts-sdk 7.29.1-0cb2e19.0 → 7.29.1-c2a29dc.0

package/dist/@types/core/errors.d.ts

@@ -28,7 +28,8 @@ declare global {
             VISITOR_USAGE_LIMIT_EXCEEDED = 400323,
             FEED_SNAPSHOT_EXPIRED = 400322,
             MAX_BLOCKED_USERS_REACHED = 400324,
-            MODULE_NOT_ENTITLED = 400325
+            MODULE_NOT_ENTITLED = 400325,
+            VISITOR_REPORT_DENIED = 488999
         }
         const enum ClientError {
             UNKNOWN_ERROR = 800000,

package/dist/@types/core/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/@types/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,UAAU;YACnB,KAAK,UAAU;YACf,KAAK,UAAU;SAChB;QAED,WAAW,WAAW;YACpB,WAAW,SAAS;YACpB,YAAY,SAAS;YACrB,iBAAiB,SAAS;YAC1B,cAAc,SAAS;YACvB,QAAQ,SAAS;YACjB,SAAS,SAAS;YAClB,aAAa,SAAS;YACtB,gBAAgB,SAAS;YACzB,WAAW,SAAS;YACpB,UAAU,SAAS;YACnB,WAAW,SAAS;YACpB,cAAc,SAAS;YACvB,0BAA0B,SAAS;YACnC,uBAAuB,SAAS;YAChC,cAAc,SAAS;YACvB,gBAAgB,SAAS;YACzB,cAAc,SAAS;YACvB,yBAAyB,SAAS;YAClC,qBAAqB,SAAS;YAC9B,4BAA4B,SAAS;YACrC,qBAAqB,SAAS;YAC9B,yBAAyB,SAAS;YAClC,mBAAmB,SAAS;SAC7B;QAED,WAAW,WAAW;YACpB,aAAa,SAAS;YACtB,kBAAkB,SAAS;YAC3B,iBAAiB,SAAS;YAC1B,gBAAgB,SAAS;YACzB,YAAY,SAAS;YACrB,aAAa,SAAS;YACtB,wBAAwB,SAAS;SAClC;QAED,KAAK,SAAS,GAAG,WAAW,GAAG,WAAW,CAAC;KAC5C;CACF"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/@types/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,UAAU;YACnB,KAAK,UAAU;YACf,KAAK,UAAU;SAChB;QAED,WAAW,WAAW;YACpB,WAAW,SAAS;YACpB,YAAY,SAAS;YACrB,iBAAiB,SAAS;YAC1B,cAAc,SAAS;YACvB,QAAQ,SAAS;YACjB,SAAS,SAAS;YAClB,aAAa,SAAS;YACtB,gBAAgB,SAAS;YACzB,WAAW,SAAS;YACpB,UAAU,SAAS;YACnB,WAAW,SAAS;YACpB,cAAc,SAAS;YACvB,0BAA0B,SAAS;YACnC,uBAAuB,SAAS;YAChC,cAAc,SAAS;YACvB,gBAAgB,SAAS;YACzB,cAAc,SAAS;YACvB,yBAAyB,SAAS;YAClC,qBAAqB,SAAS;YAC9B,4BAA4B,SAAS;YACrC,qBAAqB,SAAS;YAC9B,yBAAyB,SAAS;YAClC,mBAAmB,SAAS;YAE5B,qBAAqB,SAAS;SAC/B;QAED,WAAW,WAAW;YACpB,aAAa,SAAS;YACtB,kBAAkB,SAAS;YAC3B,iBAAiB,SAAS;YAC1B,gBAAgB,SAAS;YACzB,YAAY,SAAS;YACrB,aAAa,SAAS;YACtB,wBAAwB,SAAS;SAClC;QAED,KAAK,SAAS,GAAG,WAAW,GAAG,WAAW,CAAC;KAC5C;CACF"}

package/dist/@types/domains/user.d.ts

@@ -27,6 +27,20 @@ export declare enum UserProfileFieldEnum {
     DESCRIPTION = "description",
     AVATAR = "avatarFileId"
 }
+/**
+ * Selects which of the caller's reports `UserRepository.unflagUser` withdraws, sent as the
+ * `reportType` query parameter. The four typed members are the backend `reportType` wire
+ * values and match `UserReportTypeEnum`. `UNTYPED` selects the typeless (legacy) report,
+ * which `isUserFlaggedByMe` returns as `reportType: null`; it is a selector only, never
+ * stored, and the flag endpoint refuses it.
+ */
+export declare enum UserReportTypeFilterEnum {
+    DISPLAY_NAME = "displayName",
+    DESCRIPTION = "description",
+    AVATAR = "avatarFileId",
+    BEHAVIOR = "behavior",
+    UNTYPED = "untyped"
+}
 export {};
 declare global {
     namespace Amity {
@@ -70,6 +84,36 @@ declare global {
             reason: ContentFlagReasonEnum;
             comment?: string;
         };
+        type UserReportTypeFilter = `${UserReportTypeFilterEnum}`;
+        /**
+         * Options of `UserRepository.unflagUser`. Omit `reportType` to withdraw every report
+         * the caller filed on the user; pass one to withdraw only that report.
+         */
+        type UserReportTypeFilterOptions = {
+            reportType?: Amity.UserReportTypeFilter;
+        };
+        /**
+         * One of the caller's own reports on a user, as the backend returns it in
+         * `UserRepository.isUserFlaggedByMe`. Every field is always present; a field the
+         * report does not carry is `null`. `reportType: null` is the typeless report (withdrawn
+         * with `UserReportTypeFilterEnum.UNTYPED`) and `createdAt: null` marks a report filed
+         * before report types existed.
+         */
+        type UserFlag = {
+            reportType: `${UserReportTypeEnum}` | null;
+            reason: string | null;
+            comment: string | null;
+            createdAt: string | null;
+        };
+        /**
+         * Result of `UserRepository.isUserFlaggedByMe`: the `GET /api/v4/users/:userId/isFlagByMe`
+         * payload as is. `isFlagByMe` says whether the caller holds any report on the user;
+         * `flags` lists the caller's own reports. Other users' reports are never included.
+         */
+        type UserFlagByMe = {
+            isFlagByMe: boolean;
+            flags: Amity.UserFlag[];
+        };
         type RawUser = {
             _id: string;
             userId: string;

package/dist/@types/domains/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAElD,0BAAkB,YAAY;IAC5B,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,oBAAY,iBAAiB;IAC3B,YAAY,gBAAgB;IAC5B,cAAc,kBAAkB;IAChC,OAAO,WAAW;CACnB;AAED,oBAAY,kBAAkB;IAC5B,YAAY,gBAAgB;IAC5B,WAAW,gBAAgB;IAC3B,MAAM,iBAAiB;IACvB,QAAQ,aAAa;CACtB;AAED;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,YAAY,gBAAgB;IAC5B,WAAW,gBAAgB;IAC3B,MAAM,iBAAiB;CACxB;AAED,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,cAAc;YACvB,YAAY,iBAAiB;YAC7B,WAAW,gBAAgB;SAC5B;QAED,KAAK,mBAAmB,GAAG,wBAAwB,CAAC;QAEpD,KAAK,UAAU,GAAG,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;QAE5C,WAAW,oBAAoB;YAC7B,YAAY,iBAAiB;YAC7B,WAAW,gBAAgB;YAC3B,WAAW,gBAAgB;SAC5B;QAED,KAAK,gBAAgB,GAAG,GAAG,KAAK,CAAC,oBAAoB,EAAE,CAAC;QAExD,KAAK,aAAa,GAAG,iBAAiB,CAAC;QAEvC,KAAK,cAAc,GACf,SAAS,GACT,UAAU,GACV,UAAU,GACV,WAAW,GACX,aAAa,GACb,eAAe,CAAC;QAEpB,KAAK,QAAQ,GAAG,GAAG,YAAY,EAAE,CAAC;QAElC,KAAK,cAAc,GAAG,kBAAkB,CAAC;QAEzC,KAAK,iBAAiB,GAAG;YACvB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC;YAClC,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;YACjC,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF;;;;WAIG;QACH,KAAK,wBAAwB,GAAG;YAC9B,KAAK,EAAE,oBAAoB,CAAC;YAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF;;;;;WAKG;QACH,KAAK,yBAAyB,GAAG;YAC/B,MAAM,EAAE,qBAAqB,CAAC;YAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF,KAAK,OAAO,GAAG;YACb,GAAG,EAAE,MAAM,CAAC;YACZ,MAAM,EAAE,MAAM,CAAC;YACf,cAAc,EAAE,MAAM,CAAC;YACvB,YAAY,EAAE,MAAM,CAAC;YACrB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,eAAe,CAAC,EAAE,MAAM,CAAC;YACzB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,OAAO,EAAE,OAAO,CAAC;YACjB,WAAW,EAAE,OAAO,CAAC;SACtB,GAAG,KAAK,CAAC,QAAQ,GAChB,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,YAAY,CAAC;QAErB,KAAK,YAAY,GAAG,KAAK,CAAC,OAAO,GAAG;YAClC,cAAc,EAAE,OAAO,CAAC;SACzB,GAAG,KAAK,CAAC,QAAQ,GAChB,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,YAAY,CAAC;QAErB,KAAK,IAAI,GAAG,KAAK,CAAC,YAAY,GAAG;YAC/B,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;SACrC,CAAC;QAEF,KAAK,UAAU,GAAG;YAChB,MAAM,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;YAC3B,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,cAAc,CAAC;YACjD,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,SAAS,CAAC,EAAE,mBAAmB,CAAC;SACjC,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,WAAW,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;YAChD,MAAM,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;YAC3B,MAAM,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAAG,KAAK,CAAC,oBAAoB,CAAC;YAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,SAAS,CAAC,EAAE,mBAAmB,CAAC;YAChC,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,EAAE,CAAC;SAClC,CAAC;QAEF,KAAK,kBAAkB,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;QAErF,KAAK,wBAAwB,GAAG,KAAK,CAAC,oBAAoB,CACxD,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CACvC,CAAC;QAEF,KAAK,wBAAwB,GAAG,KAAK,CAAC,wBAAwB,CAAC;QAE/D,KAAK,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CACtD,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,EAC5B,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CACzB,CAAC;KACH;CACF"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/@types/domains/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAElD,0BAAkB,YAAY;IAC5B,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,oBAAY,iBAAiB;IAC3B,YAAY,gBAAgB;IAC5B,cAAc,kBAAkB;IAChC,OAAO,WAAW;CACnB;AAED,oBAAY,kBAAkB;IAC5B,YAAY,gBAAgB;IAC5B,WAAW,gBAAgB;IAC3B,MAAM,iBAAiB;IACvB,QAAQ,aAAa;CACtB;AAED;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,YAAY,gBAAgB;IAC5B,WAAW,gBAAgB;IAC3B,MAAM,iBAAiB;CACxB;AAED;;;;;;GAMG;AACH,oBAAY,wBAAwB;IAClC,YAAY,gBAAgB;IAC5B,WAAW,gBAAgB;IAC3B,MAAM,iBAAiB;IACvB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAED,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,WAAW,cAAc;YACvB,YAAY,iBAAiB;YAC7B,WAAW,gBAAgB;SAC5B;QAED,KAAK,mBAAmB,GAAG,wBAAwB,CAAC;QAEpD,KAAK,UAAU,GAAG,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;QAE5C,WAAW,oBAAoB;YAC7B,YAAY,iBAAiB;YAC7B,WAAW,gBAAgB;YAC3B,WAAW,gBAAgB;SAC5B;QAED,KAAK,gBAAgB,GAAG,GAAG,KAAK,CAAC,oBAAoB,EAAE,CAAC;QAExD,KAAK,aAAa,GAAG,iBAAiB,CAAC;QAEvC,KAAK,cAAc,GACf,SAAS,GACT,UAAU,GACV,UAAU,GACV,WAAW,GACX,aAAa,GACb,eAAe,CAAC;QAEpB,KAAK,QAAQ,GAAG,GAAG,YAAY,EAAE,CAAC;QAElC,KAAK,cAAc,GAAG,kBAAkB,CAAC;QAEzC,KAAK,iBAAiB,GAAG;YACvB,UAAU,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC;YAClC,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC;YACjC,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF;;;;WAIG;QACH,KAAK,wBAAwB,GAAG;YAC9B,KAAK,EAAE,oBAAoB,CAAC;YAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF;;;;;WAKG;QACH,KAAK,yBAAyB,GAAG;YAC/B,MAAM,EAAE,qBAAqB,CAAC;YAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QAEF,KAAK,oBAAoB,GAAG,GAAG,wBAAwB,EAAE,CAAC;QAE1D;;;WAGG;QACH,KAAK,2BAA2B,GAAG;YACjC,UAAU,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC;SACzC,CAAC;QAEF;;;;;;WAMG;QACH,KAAK,QAAQ,GAAG;YACd,UAAU,EAAE,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAC;YAC3C,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;YACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;YACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B,CAAC;QAEF;;;;WAIG;QACH,KAAK,YAAY,GAAG;YAClB,UAAU,EAAE,OAAO,CAAC;YACpB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;SACzB,CAAC;QAEF,KAAK,OAAO,GAAG;YACb,GAAG,EAAE,MAAM,CAAC;YACZ,MAAM,EAAE,MAAM,CAAC;YACf,cAAc,EAAE,MAAM,CAAC;YACvB,YAAY,EAAE,MAAM,CAAC;YACrB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,eAAe,CAAC,EAAE,MAAM,CAAC;YACzB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,OAAO,EAAE,OAAO,CAAC;YACjB,WAAW,EAAE,OAAO,CAAC;SACtB,GAAG,KAAK,CAAC,QAAQ,GAChB,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,YAAY,CAAC;QAErB,KAAK,YAAY,GAAG,KAAK,CAAC,OAAO,GAAG;YAClC,cAAc,EAAE,OAAO,CAAC;SACzB,GAAG,KAAK,CAAC,QAAQ,GAChB,KAAK,CAAC,QAAQ,GACd,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,UAAU,GAChB,KAAK,CAAC,YAAY,CAAC;QAErB,KAAK,IAAI,GAAG,KAAK,CAAC,YAAY,GAAG;YAC/B,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;SACrC,CAAC;QAEF,KAAK,UAAU,GAAG;YAChB,MAAM,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;YAC3B,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,cAAc,CAAC;YACjD,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,SAAS,CAAC,EAAE,mBAAmB,CAAC;SACjC,CAAC;QAEF,KAAK,gBAAgB,GAAG;YACtB,WAAW,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;YAChD,MAAM,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;YAC3B,MAAM,CAAC,EAAE,KAAK,CAAC,gBAAgB,GAAG,KAAK,CAAC,oBAAoB,CAAC;YAC7D,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,SAAS,CAAC,EAAE,mBAAmB,CAAC;YAChC,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,EAAE,CAAC;SAClC,CAAC;QAEF,KAAK,kBAAkB,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;QAErF,KAAK,wBAAwB,GAAG,KAAK,CAAC,oBAAoB,CACxD,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CACvC,CAAC;QAEF,KAAK,wBAAwB,GAAG,KAAK,CAAC,wBAAwB,CAAC;QAE/D,KAAK,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CACtD,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,EAC5B,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CACzB,CAAC;KACH;CACF"}

package/dist/index.cjs.js

@@ -70,6 +70,21 @@ exports.UserProfileFieldEnum = void 0;
     UserProfileFieldEnum["DESCRIPTION"] = "description";
     UserProfileFieldEnum["AVATAR"] = "avatarFileId";
 })(exports.UserProfileFieldEnum || (exports.UserProfileFieldEnum = {}));
+/**
+ * Selects which of the caller's reports `UserRepository.unflagUser` withdraws, sent as the
+ * `reportType` query parameter. The four typed members are the backend `reportType` wire
+ * values and match `UserReportTypeEnum`. `UNTYPED` selects the typeless (legacy) report,
+ * which `isUserFlaggedByMe` returns as `reportType: null`; it is a selector only, never
+ * stored, and the flag endpoint refuses it.
+ */
+exports.UserReportTypeFilterEnum = void 0;
+(function (UserReportTypeFilterEnum) {
+    UserReportTypeFilterEnum["DISPLAY_NAME"] = "displayName";
+    UserReportTypeFilterEnum["DESCRIPTION"] = "description";
+    UserReportTypeFilterEnum["AVATAR"] = "avatarFileId";
+    UserReportTypeFilterEnum["BEHAVIOR"] = "behavior";
+    UserReportTypeFilterEnum["UNTYPED"] = "untyped";
+})(exports.UserReportTypeFilterEnum || (exports.UserReportTypeFilterEnum = {}));
 
 const FileType = Object.freeze({
     FILE: 'file',
@@ -15487,6 +15502,7 @@ const submitUserReport = async (apiName, userId, body) => {
 const USER_REPORT_COMMENT_MAX_LENGTH = 300;
 const PROFILE_FIELDS = Object.values(exports.UserProfileFieldEnum);
 const BEHAVIOR_REASONS = Object.values(exports.ContentFlagReasonEnum);
+const REPORT_TYPE_FILTERS = Object.values(exports.UserReportTypeFilterEnum);
 const assertOptionsObject = (apiName, options, shape) => {
     if (typeof options !== 'object' || options === null || Array.isArray(options)) {
         throw new ASCInvalidParameterError(`${apiName}: expected an options object \`${shape}\``);
@@ -15546,6 +15562,28 @@ const toUserBehaviorReportBody = (options) => {
     }
     return withComment({ reportType: 'behavior', reason }, normalizeUserReportComment(apiName, comment));
 };
+/**
+ * Validates the optional `{ reportType? }` of `unflagUser` and builds its query parameters.
+ * Returns `undefined` when no `reportType` is given, so the request carries no query string
+ * and withdraws every report the caller filed on the user. The server validates the value
+ * too (422); this local check only saves the round-trip for the string alias, which admits
+ * raw strings. Untyped callers can pass anything at runtime, so nothing is trusted from the
+ * declared type.
+ *
+ * @throws {ASCInvalidParameterError} `INVALID_PARAMETERS` when the options are malformed or `reportType` is unknown
+ */
+const toUserReportTypeFilter = (options) => {
+    if (options === undefined)
+        return undefined;
+    const apiName = 'unflagUser';
+    const { reportType } = assertOptionsObject(apiName, options, '{ reportType? }');
+    if (reportType === undefined)
+        return undefined;
+    if (typeof reportType !== 'string' || !REPORT_TYPE_FILTERS.includes(reportType)) {
+        throw new ASCInvalidParameterError(`${apiName}: \`reportType\` must be a \`UserReportTypeFilterEnum\` value`);
+    }
+    return { reportType: reportType };
+};
 
 /* begin_public_function
   id: user.flag_profile
@@ -15618,20 +15656,46 @@ const flagUserBehavior = async (userId, options) => submitUserReport('flagUserBe
 */
 /**
  * ```js
- * import { UserRepository } from '@amityco/ts-sdk'
- * const unflagged = await UserRepository.unflagUser('post', postId)
+ * import { UserRepository, UserReportTypeFilterEnum } from '@amityco/ts-sdk'
+ *
+ * // Withdraw every report I filed on the user.
+ * const unflagged = await UserRepository.unflagUser('userId')
+ *
+ * // Withdraw only my behavior report; my other reports on the user stay.
+ * await UserRepository.unflagUser('userId', { reportType: UserReportTypeFilterEnum.BEHAVIOR })
+ *
+ * // Withdraw only my typeless (legacy) report.
+ * await UserRepository.unflagUser('userId', { reportType: UserReportTypeFilterEnum.UNTYPED })
  * ```
  *
+ * Withdraws the caller's reports on a user. Without `reportType` every report the caller
+ * filed on that user is withdrawn, as before. With `reportType` only the caller's report
+ * of that type is withdrawn; the caller's other reports and other users' reports are
+ * untouched. Withdrawing a report that does not exist succeeds and changes nothing.
+ *
+ * The returned user is persisted to the cache, so its `hashFlag` says whether the caller
+ * still holds any report on the user. Do not flip a local "flagged by me" flag to `false`
+ * after a per-type withdrawal; read the fresh user, or call `isUserFlaggedByMe` for the
+ * remaining per-type state (`flags`).
+ *
+ * Sends `DELETE /api/v4/me/flags/:userId`, with `?reportType=<type>` when one is given.
+ *
  * @param userId The ID of the user to unflag
- * @returns the deleted report result
+ * @param options Optional; `reportType` selects a single report to withdraw. For a report that `isUserFlaggedByMe` lists with `reportType: null`, pass `UserReportTypeFilterEnum.UNTYPED`
+ * @returns `true` once the server has processed the withdrawal
+ * @throws {ASCInvalidParameterError} `INVALID_PARAMETERS` when `reportType` is not a `UserReportTypeFilterEnum` value, before any request is made
  *
  * @category User API
  * @async
  * */
-const unflagUser = async (userId) => {
-    const client = getActiveClient();
-    client.log('user/unflag', userId);
-    const { data } = await client.http.delete(`/api/v4/me/flags/${encodeURIComponent(userId)}`);
+const unflagUser = async (userId, options) => {
+    const client = getActiveClient();
+    client.log('user/unflag', { userId, options });
+    const params = toUserReportTypeFilter(options);
+    const url = `/api/v4/me/flags/${encodeURIComponent(userId)}`;
+    const { data } = params
+        ? await client.http.delete(url, { params })
+        : await client.http.delete(url);
     const payload = prepareUserPayload(data);
     if (client.cache) {
         ingestInCache(payload);
@@ -15647,11 +15711,29 @@ const unflagUser = async (userId) => {
 /**
  * ```js
  * import { UserRepository } from '@amityco/ts-sdk'
- * const isFlagged = await UserRepository.isUserFlaggedByMe(postId)
+ *
+ * const { isFlagByMe, flags } = await UserRepository.isUserFlaggedByMe('userId')
+ *
+ * // Grey out the report options already used; null marks the typeless report.
+ * const used = new Set(flags.map(flag => flag.reportType))
  * ```
  *
- * @param userId The ID of the thing to check a report to.
- * @returns `true` if the report is created by me, `false` if doesn't.
+ * Returns whether the caller has reported a user, with each of the caller's own reports
+ * on that user, exactly as `GET /api/v4/users/:userId/isFlagByMe` answers. Each report
+ * carries `reportType`, `reason`, `comment` and `createdAt`; a field the report does not
+ * have is `null`. `reportType: null` is the typeless (legacy) report, which `unflagUser`
+ * withdraws with `UserReportTypeFilterEnum.UNTYPED`. Only the caller's reports come back.
+ *
+ * This is the only source of per-type state. Nothing is filtered, cached or persisted:
+ * the call reads the server every time and does not consult `hashFlag`, which is a
+ * type-blind bloom filter. Call it again after a flag or unflag when the UI needs the
+ * updated per-type state.
+ *
+ * Breaking change: earlier versions returned a boolean from the v3 endpoint, which the
+ * backend has deprecated. Read `isFlagByMe` on the result for the same answer.
+ *
+ * @param userId The ID of the user to check
+ * @returns the caller's {@link Amity.UserFlagByMe} on that user
  *
  * @category Report API
  * @async
@@ -15659,8 +15741,8 @@ const unflagUser = async (userId) => {
 const isUserFlaggedByMe = async (userId) => {
     const client = getActiveClient();
     client.log('user/isUserFlaggedByMe', userId);
-    const { data: { isFlagByMe }, } = await client.http.get(`/api/v3/users/${userId}/isFlagByMe`);
-    return isFlagByMe;
+    const { data } = await client.http.get(`/api/v4/users/${encodeURIComponent(userId)}/isFlagByMe`);
+    return data;
 };
 /* end_public_function */
 
@@ -19210,7 +19292,8 @@ const getPostReport = async ({ client, referenceId, }) => {
 };
 const getUserReport = async ({ client, referenceId, }) => {
     var _a;
-    const { data } = await client.http.get(`/api/v3/users/${referenceId}/isflagbyme`);
+    // v3 isFlagByMe is deprecated by the backend; v4 answers the same boolean plus the caller's flags.
+    const { data } = await client.http.get(`/api/v4/users/${encodeURIComponent(referenceId)}/isFlagByMe`);
     const { result, isFlagByMe } = data !== null && data !== void 0 ? data : {};
     return (_a = result !== null && result !== void 0 ? result : isFlagByMe) !== null && _a !== void 0 ? _a : false;
 };

package/dist/index.esm.js

@@ -54,6 +54,21 @@ var UserProfileFieldEnum;
     UserProfileFieldEnum["DESCRIPTION"] = "description";
     UserProfileFieldEnum["AVATAR"] = "avatarFileId";
 })(UserProfileFieldEnum || (UserProfileFieldEnum = {}));
+/**
+ * Selects which of the caller's reports `UserRepository.unflagUser` withdraws, sent as the
+ * `reportType` query parameter. The four typed members are the backend `reportType` wire
+ * values and match `UserReportTypeEnum`. `UNTYPED` selects the typeless (legacy) report,
+ * which `isUserFlaggedByMe` returns as `reportType: null`; it is a selector only, never
+ * stored, and the flag endpoint refuses it.
+ */
+var UserReportTypeFilterEnum;
+(function (UserReportTypeFilterEnum) {
+    UserReportTypeFilterEnum["DISPLAY_NAME"] = "displayName";
+    UserReportTypeFilterEnum["DESCRIPTION"] = "description";
+    UserReportTypeFilterEnum["AVATAR"] = "avatarFileId";
+    UserReportTypeFilterEnum["BEHAVIOR"] = "behavior";
+    UserReportTypeFilterEnum["UNTYPED"] = "untyped";
+})(UserReportTypeFilterEnum || (UserReportTypeFilterEnum = {}));
 
 const FileType = Object.freeze({
     FILE: 'file',
@@ -15487,6 +15502,7 @@ const submitUserReport = async (apiName, userId, body) => {
 const USER_REPORT_COMMENT_MAX_LENGTH = 300;
 const PROFILE_FIELDS = Object.values(UserProfileFieldEnum);
 const BEHAVIOR_REASONS = Object.values(ContentFlagReasonEnum);
+const REPORT_TYPE_FILTERS = Object.values(UserReportTypeFilterEnum);
 const assertOptionsObject = (apiName, options, shape) => {
     if (typeof options !== 'object' || options === null || Array.isArray(options)) {
         throw new ASCInvalidParameterError(`${apiName}: expected an options object \`${shape}\``);
@@ -15546,6 +15562,28 @@ const toUserBehaviorReportBody = (options) => {
     }
     return withComment({ reportType: 'behavior', reason }, normalizeUserReportComment(apiName, comment));
 };
+/**
+ * Validates the optional `{ reportType? }` of `unflagUser` and builds its query parameters.
+ * Returns `undefined` when no `reportType` is given, so the request carries no query string
+ * and withdraws every report the caller filed on the user. The server validates the value
+ * too (422); this local check only saves the round-trip for the string alias, which admits
+ * raw strings. Untyped callers can pass anything at runtime, so nothing is trusted from the
+ * declared type.
+ *
+ * @throws {ASCInvalidParameterError} `INVALID_PARAMETERS` when the options are malformed or `reportType` is unknown
+ */
+const toUserReportTypeFilter = (options) => {
+    if (options === undefined)
+        return undefined;
+    const apiName = 'unflagUser';
+    const { reportType } = assertOptionsObject(apiName, options, '{ reportType? }');
+    if (reportType === undefined)
+        return undefined;
+    if (typeof reportType !== 'string' || !REPORT_TYPE_FILTERS.includes(reportType)) {
+        throw new ASCInvalidParameterError(`${apiName}: \`reportType\` must be a \`UserReportTypeFilterEnum\` value`);
+    }
+    return { reportType: reportType };
+};
 
 /* begin_public_function
   id: user.flag_profile
@@ -15618,20 +15656,46 @@ const flagUserBehavior = async (userId, options) => submitUserReport('flagUserBe
 */
 /**
  * ```js
- * import { UserRepository } from '@amityco/ts-sdk'
- * const unflagged = await UserRepository.unflagUser('post', postId)
+ * import { UserRepository, UserReportTypeFilterEnum } from '@amityco/ts-sdk'
+ *
+ * // Withdraw every report I filed on the user.
+ * const unflagged = await UserRepository.unflagUser('userId')
+ *
+ * // Withdraw only my behavior report; my other reports on the user stay.
+ * await UserRepository.unflagUser('userId', { reportType: UserReportTypeFilterEnum.BEHAVIOR })
+ *
+ * // Withdraw only my typeless (legacy) report.
+ * await UserRepository.unflagUser('userId', { reportType: UserReportTypeFilterEnum.UNTYPED })
  * ```
  *
+ * Withdraws the caller's reports on a user. Without `reportType` every report the caller
+ * filed on that user is withdrawn, as before. With `reportType` only the caller's report
+ * of that type is withdrawn; the caller's other reports and other users' reports are
+ * untouched. Withdrawing a report that does not exist succeeds and changes nothing.
+ *
+ * The returned user is persisted to the cache, so its `hashFlag` says whether the caller
+ * still holds any report on the user. Do not flip a local "flagged by me" flag to `false`
+ * after a per-type withdrawal; read the fresh user, or call `isUserFlaggedByMe` for the
+ * remaining per-type state (`flags`).
+ *
+ * Sends `DELETE /api/v4/me/flags/:userId`, with `?reportType=<type>` when one is given.
+ *
  * @param userId The ID of the user to unflag
- * @returns the deleted report result
+ * @param options Optional; `reportType` selects a single report to withdraw. For a report that `isUserFlaggedByMe` lists with `reportType: null`, pass `UserReportTypeFilterEnum.UNTYPED`
+ * @returns `true` once the server has processed the withdrawal
+ * @throws {ASCInvalidParameterError} `INVALID_PARAMETERS` when `reportType` is not a `UserReportTypeFilterEnum` value, before any request is made
  *
  * @category User API
  * @async
  * */
-const unflagUser = async (userId) => {
-    const client = getActiveClient();
-    client.log('user/unflag', userId);
-    const { data } = await client.http.delete(`/api/v4/me/flags/${encodeURIComponent(userId)}`);
+const unflagUser = async (userId, options) => {
+    const client = getActiveClient();
+    client.log('user/unflag', { userId, options });
+    const params = toUserReportTypeFilter(options);
+    const url = `/api/v4/me/flags/${encodeURIComponent(userId)}`;
+    const { data } = params
+        ? await client.http.delete(url, { params })
+        : await client.http.delete(url);
     const payload = prepareUserPayload(data);
     if (client.cache) {
         ingestInCache(payload);
@@ -15647,11 +15711,29 @@ const unflagUser = async (userId) => {
 /**
  * ```js
  * import { UserRepository } from '@amityco/ts-sdk'
- * const isFlagged = await UserRepository.isUserFlaggedByMe(postId)
+ *
+ * const { isFlagByMe, flags } = await UserRepository.isUserFlaggedByMe('userId')
+ *
+ * // Grey out the report options already used; null marks the typeless report.
+ * const used = new Set(flags.map(flag => flag.reportType))
  * ```
  *
- * @param userId The ID of the thing to check a report to.
- * @returns `true` if the report is created by me, `false` if doesn't.
+ * Returns whether the caller has reported a user, with each of the caller's own reports
+ * on that user, exactly as `GET /api/v4/users/:userId/isFlagByMe` answers. Each report
+ * carries `reportType`, `reason`, `comment` and `createdAt`; a field the report does not
+ * have is `null`. `reportType: null` is the typeless (legacy) report, which `unflagUser`
+ * withdraws with `UserReportTypeFilterEnum.UNTYPED`. Only the caller's reports come back.
+ *
+ * This is the only source of per-type state. Nothing is filtered, cached or persisted:
+ * the call reads the server every time and does not consult `hashFlag`, which is a
+ * type-blind bloom filter. Call it again after a flag or unflag when the UI needs the
+ * updated per-type state.
+ *
+ * Breaking change: earlier versions returned a boolean from the v3 endpoint, which the
+ * backend has deprecated. Read `isFlagByMe` on the result for the same answer.
+ *
+ * @param userId The ID of the user to check
+ * @returns the caller's {@link Amity.UserFlagByMe} on that user
  *
  * @category Report API
  * @async
@@ -15659,8 +15741,8 @@ const unflagUser = async (userId) => {
 const isUserFlaggedByMe = async (userId) => {
     const client = getActiveClient();
     client.log('user/isUserFlaggedByMe', userId);
-    const { data: { isFlagByMe }, } = await client.http.get(`/api/v3/users/${userId}/isFlagByMe`);
-    return isFlagByMe;
+    const { data } = await client.http.get(`/api/v4/users/${encodeURIComponent(userId)}/isFlagByMe`);
+    return data;
 };
 /* end_public_function */
 
@@ -19210,7 +19292,8 @@ const getPostReport = async ({ client, referenceId, }) => {
 };
 const getUserReport = async ({ client, referenceId, }) => {
     var _a;
-    const { data } = await client.http.get(`/api/v3/users/${referenceId}/isflagbyme`);
+    // v3 isFlagByMe is deprecated by the backend; v4 answers the same boolean plus the caller's flags.
+    const { data } = await client.http.get(`/api/v4/users/${encodeURIComponent(referenceId)}/isFlagByMe`);
     const { result, isFlagByMe } = data !== null && data !== void 0 ? data : {};
     return (_a = result !== null && result !== void 0 ? result : isFlagByMe) !== null && _a !== void 0 ? _a : false;
 };
@@ -37696,4 +37779,4 @@ class AmityAttachmentProductTags {
     }
 }
 
-export { API_REGIONS, index$6 as AdRepository, AmityAttachmentProductTags, AmityAutoSubscription, AmityChannelNotificationModeEnum, AmityCommunityType, AmityEventOrderOption, AmityEventOriginType, AmityEventResponseStatus, AmityEventSortOption, AmityEventStatus, AmityEventType, AmityLiveViewerCountMode, AmityModuleNotEntitledError, AmitySharableContentType, AnalyticsSourceTypeEnum, index$g as CategoryRepository, index$k as ChannelRepository, index$t as Client, index$f as CommentRepository, CommunityNotificationEventNameEnum, CommunityPostSettingMaps, CommunityPostSettings, index$h as CommunityRepository, ContentFeedType, ContentFlagReasonEnum, index as CuratedContentRepository, DefaultCommunityPostSetting, index$2 as EventRepository, FeedDataTypeEnum, index$e as FeedRepository, FeedSortByEnum, FeedSourceEnum, FeedTypeEnum, FileAccessTypeEnum, index$q as FileRepository, FileType, GET_WATCHER_URLS, index$4 as InvitationRepository, InvitationSortByEnum, InvitationStatusEnum, InvitationTargetTypeEnum, InvitationTypeEnum, JoinRequestStatusEnum, JoinResultStatusEnum, index$3 as LiveReactionRepository, index$8 as LiveStreamPlayer, MembershipAcceptanceTypeEnum, MessageContentType, index$o as MessageRepository, NotificationRolesFilterTypeEnum, NotificationSettingsLevelEnum, index$9 as PollRepository, PostContentType, index$c as PostRepository, PostStructureType, index$1 as ProductRepository, index$p as ReactionRepository, index$a as RoomPresenceRepository, index$d as RoomRepository, SearchUsersByEnum, index$7 as StoryRepository, index$b as StreamRepository, index$n as SubChannelRepository, SubscriptionLevels, UserNotificationModuleNameEnum, UserProfileFieldEnum, UserReportTypeEnum, index$r as UserRepository, UserTypeEnum, VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, backupCache, createQuery, createReport, createUserToken, deleteReport, disableCache, dropFromCache, enableCache, exceedsUntilAtBoundary, filterByChannelMembership, filterByCommunityMembership, filterByFeedType, filterByPostDataTypes, filterByPropEquality, filterByPropInclusion, filterByPropIntersection, filterBySearchTerm, filterByStringComparePartially, filterByUntilAt, filterCommentsByBlockUsers, filterPostsByBlockUsers, getBlockUsersId, getChannelTopic, getCommentTopic, getCommunityStoriesTopic, getCommunityTopic, getLiveReactionTopic, getLiveStreamTopic, getMarkedMessageTopic, getMarkerUserFeedTopic, getMessageTopic, getMyFollowersTopic, getMyFollowingsTopic, getNetworkId, getNetworkTopic, getPostTopic, getRole, getRoomStreamerTopic, getRoomWatcherTopic, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStoryTopic, getSubChannelTopic, getUserTopic, isAfterBefore, isAfterBeforeRaw, isCachable, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkip, mergeInCache, index$5 as notificationTray, onChannelMarkerFetched, onFeedMarkerFetched, onFeedMarkerUpdated, onMessageMarked, onMessageMarkerFetched, onSubChannelMarkerFetched, onSubChannelMarkerUpdated, onUserMarkerFetched, onUserMarkerFetchedLegacy, pullFromCache, pushToCache, queryCache, queryOptions, queryRoles, resolveModuleAvailability, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByFirstUpdated, sortByLastActivity, sortByLastCreated, sortByLastMessage, sortByLastUpdated, sortByLocalSortingDate, sortByName, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, upsertInCache, validateUntilAt, wipeCache };
+export { API_REGIONS, index$6 as AdRepository, AmityAttachmentProductTags, AmityAutoSubscription, AmityChannelNotificationModeEnum, AmityCommunityType, AmityEventOrderOption, AmityEventOriginType, AmityEventResponseStatus, AmityEventSortOption, AmityEventStatus, AmityEventType, AmityLiveViewerCountMode, AmityModuleNotEntitledError, AmitySharableContentType, AnalyticsSourceTypeEnum, index$g as CategoryRepository, index$k as ChannelRepository, index$t as Client, index$f as CommentRepository, CommunityNotificationEventNameEnum, CommunityPostSettingMaps, CommunityPostSettings, index$h as CommunityRepository, ContentFeedType, ContentFlagReasonEnum, index as CuratedContentRepository, DefaultCommunityPostSetting, index$2 as EventRepository, FeedDataTypeEnum, index$e as FeedRepository, FeedSortByEnum, FeedSourceEnum, FeedTypeEnum, FileAccessTypeEnum, index$q as FileRepository, FileType, GET_WATCHER_URLS, index$4 as InvitationRepository, InvitationSortByEnum, InvitationStatusEnum, InvitationTargetTypeEnum, InvitationTypeEnum, JoinRequestStatusEnum, JoinResultStatusEnum, index$3 as LiveReactionRepository, index$8 as LiveStreamPlayer, MembershipAcceptanceTypeEnum, MessageContentType, index$o as MessageRepository, NotificationRolesFilterTypeEnum, NotificationSettingsLevelEnum, index$9 as PollRepository, PostContentType, index$c as PostRepository, PostStructureType, index$1 as ProductRepository, index$p as ReactionRepository, index$a as RoomPresenceRepository, index$d as RoomRepository, SearchUsersByEnum, index$7 as StoryRepository, index$b as StreamRepository, index$n as SubChannelRepository, SubscriptionLevels, UserNotificationModuleNameEnum, UserProfileFieldEnum, UserReportTypeEnum, UserReportTypeFilterEnum, index$r as UserRepository, UserTypeEnum, VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, backupCache, createQuery, createReport, createUserToken, deleteReport, disableCache, dropFromCache, enableCache, exceedsUntilAtBoundary, filterByChannelMembership, filterByCommunityMembership, filterByFeedType, filterByPostDataTypes, filterByPropEquality, filterByPropInclusion, filterByPropIntersection, filterBySearchTerm, filterByStringComparePartially, filterByUntilAt, filterCommentsByBlockUsers, filterPostsByBlockUsers, getBlockUsersId, getChannelTopic, getCommentTopic, getCommunityStoriesTopic, getCommunityTopic, getLiveReactionTopic, getLiveStreamTopic, getMarkedMessageTopic, getMarkerUserFeedTopic, getMessageTopic, getMyFollowersTopic, getMyFollowingsTopic, getNetworkId, getNetworkTopic, getPostTopic, getRole, getRoomStreamerTopic, getRoomWatcherTopic, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStoryTopic, getSubChannelTopic, getUserTopic, isAfterBefore, isAfterBeforeRaw, isCachable, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkip, mergeInCache, index$5 as notificationTray, onChannelMarkerFetched, onFeedMarkerFetched, onFeedMarkerUpdated, onMessageMarked, onMessageMarkerFetched, onSubChannelMarkerFetched, onSubChannelMarkerUpdated, onUserMarkerFetched, onUserMarkerFetchedLegacy, pullFromCache, pushToCache, queryCache, queryOptions, queryRoles, resolveModuleAvailability, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByFirstUpdated, sortByLastActivity, sortByLastCreated, sortByLastMessage, sortByLastUpdated, sortByLocalSortingDate, sortByName, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, upsertInCache, validateUntilAt, wipeCache };