Release 1.3.1

package.json

@@ -1,6 +1,6 @@
 {
     "name": "flagright",
-    "version": "1.3.0",
+    "version": "1.3.1",
     "private": false,
     "repository": "https://github.com/flagright/flagright-node",
     "main": "./index.js",

src/api/resources/businessUserEvents/client/Client.ts

@@ -68,7 +68,7 @@ export class BusinessUserEvents {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             queryParameters: _queryParams,

src/api/resources/businessUsers/client/Client.ts

@@ -56,7 +56,7 @@ export class BusinessUsers {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             body: await serializers.Business.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -126,7 +126,7 @@ export class BusinessUsers {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

src/api/resources/consumerUserEvents/client/Client.ts

@@ -68,7 +68,7 @@ export class ConsumerUserEvents {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             queryParameters: _queryParams,

src/api/resources/consumerUsers/client/Client.ts

@@ -55,7 +55,7 @@ export class ConsumerUsers {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             body: await serializers.User.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -122,7 +122,7 @@ export class ConsumerUsers {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

src/api/resources/transactionEvents/client/Client.ts

@@ -63,7 +63,7 @@ export class TransactionEvents {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             body: await serializers.TransactionEvent.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -133,7 +133,7 @@ export class TransactionEvents {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

src/api/resources/transactions/client/Client.ts

@@ -73,7 +73,7 @@ export class Transactions {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             queryParameters: _queryParams,
@@ -144,7 +144,7 @@ export class Transactions {
                 "x-api-key": await core.Supplier.get(this._options.apiKey),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "flagright",
-                "X-Fern-SDK-Version": "1.3.0",
+                "X-Fern-SDK-Version": "1.3.1",
             },
             contentType: "application/json",
             timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

src/api/types/BusinessResponse.ts

@@ -5,5 +5,5 @@
 import * as Flagright from "..";
 
 export interface BusinessResponse extends Flagright.BusinessWithRulesResult {
-    riskScoreDetails?: Flagright.RiskScoreDetails;
+    riskScoreDetails?: Flagright.UserRiskScoreDetails;
 }

src/api/types/BusinessUsersResponse.ts

@@ -10,7 +10,7 @@ import * as Flagright from "..";
 export interface BusinessUsersResponse {
     /** user ID the risk score pertains to */
     userId: string;
-    riskScoreDetails?: Flagright.RiskScoreDetails;
+    riskScoreDetails?: Flagright.UserRiskScoreDetails;
     hitRules?: Flagright.HitRulesDetails[];
     executedRules?: Flagright.ExecutedRulesResult[];
 }

src/api/types/ConsumerUsersResponse.ts

@@ -10,7 +10,7 @@ import * as Flagright from "..";
 export interface ConsumerUsersResponse {
     /** user ID the risk score pertains to */
     userId: string;
-    riskScoreDetails?: Flagright.RiskScoreDetails;
+    riskScoreDetails?: Flagright.UserRiskScoreDetails;
     hitRules?: Flagright.HitRulesDetails[];
     executedRules?: Flagright.ExecutedRulesResult[];
 }

src/api/types/ExecutedRulesResult.ts

@@ -9,7 +9,7 @@ import * as Flagright from "..";
  */
 export interface ExecutedRulesResult {
     /** Unique rule identifier */
-    ruleId: string;
+    ruleId?: string;
     ruleInstanceId: string;
     /** Name of the rule */
     ruleName: string;

src/api/types/HitRulesDetails.ts

@@ -9,7 +9,7 @@ import * as Flagright from "..";
  */
 export interface HitRulesDetails {
     /** Unique rule identifier */
-    ruleId: string;
+    ruleId?: string;
     ruleInstanceId: string;
     /** Name of the rule */
     ruleName: string;

src/api/types/TransactionMonitoringResult.ts

@@ -8,4 +8,5 @@ export interface TransactionMonitoringResult extends Flagright.RulesResults {
     /** Transaction ID that the results pertain to */
     transactionId: string;
     status: Flagright.RuleAction;
+    riskScoreDetails?: Flagright.TransactionRiskScoringResult;
 }

src/api/types/TransactionRiskScoringResult.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Flagright from "..";
+
+export interface TransactionRiskScoringResult {
+    /** Transaction risk scoring score */
+    trsScore: number;
+    trsRiskLevel: Flagright.RiskLevel;
+}

src/api/types/TransactionWithRulesResult.ts

@@ -11,4 +11,5 @@ export interface TransactionWithRulesResult extends Flagright.Transaction {
     executedRules: Flagright.ExecutedRulesResult[];
     hitRules: Flagright.HitRulesDetails[];
     status: Flagright.RuleAction;
+    riskScoreDetails?: Flagright.TransactionRiskScoringResult;
 }

src/api/types/UserResponse.ts

@@ -5,5 +5,5 @@
 import * as Flagright from "..";
 
 export interface UserResponse extends Flagright.UserWithRulesResult {
-    riskScoreDetails?: Flagright.RiskScoreDetails;
+    riskScoreDetails?: Flagright.UserRiskScoreDetails;
 }

src/api/types/RiskScoreDetails.ts → src/api/types/UserRiskScoreDetails.ts

@@ -4,7 +4,7 @@
 
 import * as Flagright from "..";
 
-export interface RiskScoreDetails {
+export interface UserRiskScoreDetails {
     kycRiskScore?: number;
     craRiskScore?: number;
     kycRiskLevel?: Flagright.RiskLevel;

src/api/types/index.ts

@@ -16,6 +16,7 @@ export * from "./DeviceData";
 export * from "./TransactionMonitoringResult";
 export * from "./TransactionEventMonitoringResult";
 export * from "./RulesResults";
+export * from "./TransactionRiskScoringResult";
 export * from "./ExecutedRulesResult";
 export * from "./HitRulesDetails";
 export * from "./FailedRulesResult";
@@ -113,7 +114,7 @@ export * from "./SanctionsDetails";
 export * from "./SanctionsDetailsEntityType";
 export * from "./BusinessEntityLink";
 export * from "./UserWithRulesResult";
-export * from "./RiskScoreDetails";
+export * from "./UserRiskScoreDetails";
 export * from "./UserResponse";
 export * from "./BusinessWithRulesResult";
 export * from "./BusinessResponse";

src/serialization/types/BusinessResponse.ts

@@ -11,12 +11,14 @@ export const BusinessResponse: core.serialization.ObjectSchema<
     Flagright.BusinessResponse
 > = core.serialization
     .object({
-        riskScoreDetails: core.serialization.lazyObject(async () => (await import("..")).RiskScoreDetails).optional(),
+        riskScoreDetails: core.serialization
+            .lazyObject(async () => (await import("..")).UserRiskScoreDetails)
+            .optional(),
     })
     .extend(core.serialization.lazyObject(async () => (await import("..")).BusinessWithRulesResult));
 
 export declare namespace BusinessResponse {
     interface Raw extends serializers.BusinessWithRulesResult.Raw {
-        riskScoreDetails?: serializers.RiskScoreDetails.Raw | null;
+        riskScoreDetails?: serializers.UserRiskScoreDetails.Raw | null;
     }
 }

src/serialization/types/BusinessUsersResponse.ts

@@ -11,7 +11,7 @@ export const BusinessUsersResponse: core.serialization.ObjectSchema<
     Flagright.BusinessUsersResponse
 > = core.serialization.object({
     userId: core.serialization.string(),
-    riskScoreDetails: core.serialization.lazyObject(async () => (await import("..")).RiskScoreDetails).optional(),
+    riskScoreDetails: core.serialization.lazyObject(async () => (await import("..")).UserRiskScoreDetails).optional(),
     hitRules: core.serialization
         .list(core.serialization.lazyObject(async () => (await import("..")).HitRulesDetails))
         .optional(),
@@ -23,7 +23,7 @@ export const BusinessUsersResponse: core.serialization.ObjectSchema<
 export declare namespace BusinessUsersResponse {
     interface Raw {
         userId: string;
-        riskScoreDetails?: serializers.RiskScoreDetails.Raw | null;
+        riskScoreDetails?: serializers.UserRiskScoreDetails.Raw | null;
         hitRules?: serializers.HitRulesDetails.Raw[] | null;
         executedRules?: serializers.ExecutedRulesResult.Raw[] | null;
     }

src/serialization/types/ConsumerUsersResponse.ts

@@ -11,7 +11,7 @@ export const ConsumerUsersResponse: core.serialization.ObjectSchema<
     Flagright.ConsumerUsersResponse
 > = core.serialization.object({
     userId: core.serialization.string(),
-    riskScoreDetails: core.serialization.lazyObject(async () => (await import("..")).RiskScoreDetails).optional(),
+    riskScoreDetails: core.serialization.lazyObject(async () => (await import("..")).UserRiskScoreDetails).optional(),
     hitRules: core.serialization
         .list(core.serialization.lazyObject(async () => (await import("..")).HitRulesDetails))
         .optional(),
@@ -23,7 +23,7 @@ export const ConsumerUsersResponse: core.serialization.ObjectSchema<
 export declare namespace ConsumerUsersResponse {
     interface Raw {
         userId: string;
-        riskScoreDetails?: serializers.RiskScoreDetails.Raw | null;
+        riskScoreDetails?: serializers.UserRiskScoreDetails.Raw | null;
         hitRules?: serializers.HitRulesDetails.Raw[] | null;
         executedRules?: serializers.ExecutedRulesResult.Raw[] | null;
     }

src/serialization/types/ExecutedRulesResult.ts

@@ -10,7 +10,7 @@ export const ExecutedRulesResult: core.serialization.ObjectSchema<
     serializers.ExecutedRulesResult.Raw,
     Flagright.ExecutedRulesResult
 > = core.serialization.object({
-    ruleId: core.serialization.string(),
+    ruleId: core.serialization.string().optional(),
     ruleInstanceId: core.serialization.string(),
     ruleName: core.serialization.string(),
     ruleDescription: core.serialization.string(),
@@ -23,7 +23,7 @@ export const ExecutedRulesResult: core.serialization.ObjectSchema<
 
 export declare namespace ExecutedRulesResult {
     interface Raw {
-        ruleId: string;
+        ruleId?: string | null;
         ruleInstanceId: string;
         ruleName: string;
         ruleDescription: string;

src/serialization/types/HitRulesDetails.ts

@@ -10,7 +10,7 @@ export const HitRulesDetails: core.serialization.ObjectSchema<
     serializers.HitRulesDetails.Raw,
     Flagright.HitRulesDetails
 > = core.serialization.object({
-    ruleId: core.serialization.string(),
+    ruleId: core.serialization.string().optional(),
     ruleInstanceId: core.serialization.string(),
     ruleName: core.serialization.string(),
     ruleDescription: core.serialization.string(),
@@ -22,7 +22,7 @@ export const HitRulesDetails: core.serialization.ObjectSchema<
 
 export declare namespace HitRulesDetails {
     interface Raw {
-        ruleId: string;
+        ruleId?: string | null;
         ruleInstanceId: string;
         ruleName: string;
         ruleDescription: string;

src/serialization/types/TransactionMonitoringResult.ts

@@ -13,12 +13,16 @@ export const TransactionMonitoringResult: core.serialization.ObjectSchema<
     .object({
         transactionId: core.serialization.string(),
         status: core.serialization.lazy(async () => (await import("..")).RuleAction),
+        riskScoreDetails: core.serialization
+            .lazyObject(async () => (await import("..")).TransactionRiskScoringResult)
+            .optional(),
     })
     .extend(core.serialization.lazyObject(async () => (await import("..")).RulesResults));
 
 export declare namespace TransactionMonitoringResult {
     interface Raw extends serializers.RulesResults.Raw {
         transactionId: string;
         status: serializers.RuleAction.Raw;
+        riskScoreDetails?: serializers.TransactionRiskScoringResult.Raw | null;
     }
 }

src/serialization/types/TransactionRiskScoringResult.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as serializers from "..";
+import * as Flagright from "../../api";
+import * as core from "../../core";
+
+export const TransactionRiskScoringResult: core.serialization.ObjectSchema<
+    serializers.TransactionRiskScoringResult.Raw,
+    Flagright.TransactionRiskScoringResult
+> = core.serialization.object({
+    trsScore: core.serialization.number(),
+    trsRiskLevel: core.serialization.lazy(async () => (await import("..")).RiskLevel),
+});
+
+export declare namespace TransactionRiskScoringResult {
+    interface Raw {
+        trsScore: number;
+        trsRiskLevel: serializers.RiskLevel.Raw;
+    }
+}

src/serialization/types/TransactionWithRulesResult.ts

@@ -18,6 +18,9 @@ export const TransactionWithRulesResult: core.serialization.ObjectSchema<
             core.serialization.lazyObject(async () => (await import("..")).HitRulesDetails)
         ),
         status: core.serialization.lazy(async () => (await import("..")).RuleAction),
+        riskScoreDetails: core.serialization
+            .lazyObject(async () => (await import("..")).TransactionRiskScoringResult)
+            .optional(),
     })
     .extend(core.serialization.lazyObject(async () => (await import("..")).Transaction));
 
@@ -26,5 +29,6 @@ export declare namespace TransactionWithRulesResult {
         executedRules: serializers.ExecutedRulesResult.Raw[];
         hitRules: serializers.HitRulesDetails.Raw[];
         status: serializers.RuleAction.Raw;
+        riskScoreDetails?: serializers.TransactionRiskScoringResult.Raw | null;
     }
 }

src/serialization/types/UserResponse.ts

@@ -10,13 +10,13 @@ export const UserResponse: core.serialization.ObjectSchema<serializers.UserRespo
     core.serialization
         .object({
             riskScoreDetails: core.serialization
-                .lazyObject(async () => (await import("..")).RiskScoreDetails)
+                .lazyObject(async () => (await import("..")).UserRiskScoreDetails)
                 .optional(),
         })
         .extend(core.serialization.lazyObject(async () => (await import("..")).UserWithRulesResult));
 
 export declare namespace UserResponse {
     interface Raw extends serializers.UserWithRulesResult.Raw {
-        riskScoreDetails?: serializers.RiskScoreDetails.Raw | null;
+        riskScoreDetails?: serializers.UserRiskScoreDetails.Raw | null;
     }
 }

src/serialization/types/RiskScoreDetails.ts → src/serialization/types/UserRiskScoreDetails.ts

@@ -6,17 +6,17 @@ import * as serializers from "..";
 import * as Flagright from "../../api";
 import * as core from "../../core";
 
-export const RiskScoreDetails: core.serialization.ObjectSchema<
-    serializers.RiskScoreDetails.Raw,
-    Flagright.RiskScoreDetails
+export const UserRiskScoreDetails: core.serialization.ObjectSchema<
+    serializers.UserRiskScoreDetails.Raw,
+    Flagright.UserRiskScoreDetails
 > = core.serialization.object({
     kycRiskScore: core.serialization.number().optional(),
     craRiskScore: core.serialization.number().optional(),
     kycRiskLevel: core.serialization.lazy(async () => (await import("..")).RiskLevel).optional(),
     craRiskLevel: core.serialization.lazy(async () => (await import("..")).RiskLevel).optional(),
 });
 
-export declare namespace RiskScoreDetails {
+export declare namespace UserRiskScoreDetails {
     interface Raw {
         kycRiskScore?: number | null;
         craRiskScore?: number | null;

src/serialization/types/index.ts

@@ -16,6 +16,7 @@ export * from "./DeviceData";
 export * from "./TransactionMonitoringResult";
 export * from "./TransactionEventMonitoringResult";
 export * from "./RulesResults";
+export * from "./TransactionRiskScoringResult";
 export * from "./ExecutedRulesResult";
 export * from "./HitRulesDetails";
 export * from "./FailedRulesResult";
@@ -113,7 +114,7 @@ export * from "./SanctionsDetails";
 export * from "./SanctionsDetailsEntityType";
 export * from "./BusinessEntityLink";
 export * from "./UserWithRulesResult";
-export * from "./RiskScoreDetails";
+export * from "./UserRiskScoreDetails";
 export * from "./UserResponse";
 export * from "./BusinessWithRulesResult";
 export * from "./BusinessResponse";