@alogram/payrisk 0.1.6

package/dist/_generated/models/ChannelEnum.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChannelEnum = void 0;
+exports.instanceOfChannelEnum = instanceOfChannelEnum;
+exports.ChannelEnumFromJSON = ChannelEnumFromJSON;
+exports.ChannelEnumFromJSONTyped = ChannelEnumFromJSONTyped;
+exports.ChannelEnumToJSON = ChannelEnumToJSON;
+exports.ChannelEnumToJSONTyped = ChannelEnumToJSONTyped;
+/**
+ * pos: 'Point of Sale', ecom: 'E-commerce', in_app: 'In-App Purchase', ivr: 'Interactive Voice Response'.
+ *
+ * @export
+ * @enum {string}
+ */
+var ChannelEnum;
+(function (ChannelEnum) {
+    ChannelEnum["Pos"] = "pos";
+    ChannelEnum["Ecom"] = "ecom";
+    ChannelEnum["InApp"] = "in_app";
+    ChannelEnum["Ivr"] = "ivr";
+})(ChannelEnum || (exports.ChannelEnum = ChannelEnum = {}));
+function instanceOfChannelEnum(value) {
+    for (const key in ChannelEnum) {
+        if (Object.prototype.hasOwnProperty.call(ChannelEnum, key)) {
+            if (ChannelEnum[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function ChannelEnumFromJSON(json) {
+    return ChannelEnumFromJSONTyped(json, false);
+}
+function ChannelEnumFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function ChannelEnumToJSON(value) {
+    return value;
+}
+function ChannelEnumToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/_generated/models/CheckRequest.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Purchase } from './Purchase';
+import type { EntityIds } from './EntityIds';
+import type { Identity } from './Identity';
+/**
+ * Request for synchronous purchase risk check.
+ * @export
+ * @interface CheckRequest
+ */
+export interface CheckRequest {
+    /**
+     * (optional) event being checked, this may expand later beyond 'purchase'.
+     * @type {string}
+     * @memberof CheckRequest
+     */
+    eventType?: CheckRequestEventTypeEnum;
+    /**
+     * Server-minted unique payment identifier.
+     * @type {string}
+     * @memberof CheckRequest
+     */
+    paymentIntentId?: string;
+    /**
+     *
+     * @type {EntityIds}
+     * @memberof CheckRequest
+     */
+    entities: EntityIds;
+    /**
+     *
+     * @type {Purchase}
+     * @memberof CheckRequest
+     */
+    purchase: Purchase;
+    /**
+     *
+     * @type {Identity}
+     * @memberof CheckRequest
+     */
+    identity?: Identity;
+}
+/**
+* @export
+* @enum {string}
+*/
+export declare enum CheckRequestEventTypeEnum {
+    Purchase = "purchase"
+}
+/**
+ * Check if a given object implements the CheckRequest interface.
+ */
+export declare function instanceOfCheckRequest(value: object): value is CheckRequest;
+export declare function CheckRequestFromJSON(json: any): CheckRequest;
+export declare function CheckRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckRequest;
+export declare function CheckRequestToJSON(json: any): CheckRequest;
+export declare function CheckRequestToJSONTyped(value?: CheckRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/CheckRequest.js

@@ -0,0 +1,72 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckRequestEventTypeEnum = void 0;
+exports.instanceOfCheckRequest = instanceOfCheckRequest;
+exports.CheckRequestFromJSON = CheckRequestFromJSON;
+exports.CheckRequestFromJSONTyped = CheckRequestFromJSONTyped;
+exports.CheckRequestToJSON = CheckRequestToJSON;
+exports.CheckRequestToJSONTyped = CheckRequestToJSONTyped;
+const Purchase_1 = require("./Purchase");
+const EntityIds_1 = require("./EntityIds");
+const Identity_1 = require("./Identity");
+/**
+* @export
+* @enum {string}
+*/
+var CheckRequestEventTypeEnum;
+(function (CheckRequestEventTypeEnum) {
+    CheckRequestEventTypeEnum["Purchase"] = "purchase";
+})(CheckRequestEventTypeEnum || (exports.CheckRequestEventTypeEnum = CheckRequestEventTypeEnum = {}));
+/**
+ * Check if a given object implements the CheckRequest interface.
+ */
+function instanceOfCheckRequest(value) {
+    if (!('entities' in value) || value['entities'] === undefined)
+        return false;
+    if (!('purchase' in value) || value['purchase'] === undefined)
+        return false;
+    return true;
+}
+function CheckRequestFromJSON(json) {
+    return CheckRequestFromJSONTyped(json, false);
+}
+function CheckRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'eventType': json['eventType'] == null ? undefined : json['eventType'],
+        'paymentIntentId': json['paymentIntentId'] == null ? undefined : json['paymentIntentId'],
+        'entities': (0, EntityIds_1.EntityIdsFromJSON)(json['entities']),
+        'purchase': (0, Purchase_1.PurchaseFromJSON)(json['purchase']),
+        'identity': json['identity'] == null ? undefined : (0, Identity_1.IdentityFromJSON)(json['identity']),
+    };
+}
+function CheckRequestToJSON(json) {
+    return CheckRequestToJSONTyped(json, false);
+}
+function CheckRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'eventType': value['eventType'],
+        'paymentIntentId': value['paymentIntentId'],
+        'entities': (0, EntityIds_1.EntityIdsToJSON)(value['entities']),
+        'purchase': (0, Purchase_1.PurchaseToJSON)(value['purchase']),
+        'identity': (0, Identity_1.IdentityToJSON)(value['identity']),
+    };
+}

package/dist/_generated/models/ConfidenceEnum.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The confidence level of the risk assessment.
+ * @export
+ * @enum {string}
+ */
+export declare enum ConfidenceEnum {
+    Low = "low",
+    Medium = "medium",
+    High = "high"
+}
+export declare function instanceOfConfidenceEnum(value: any): boolean;
+export declare function ConfidenceEnumFromJSON(json: any): ConfidenceEnum;
+export declare function ConfidenceEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConfidenceEnum;
+export declare function ConfidenceEnumToJSON(value?: ConfidenceEnum | null): any;
+export declare function ConfidenceEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): ConfidenceEnum;

package/dist/_generated/models/ConfidenceEnum.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfidenceEnum = void 0;
+exports.instanceOfConfidenceEnum = instanceOfConfidenceEnum;
+exports.ConfidenceEnumFromJSON = ConfidenceEnumFromJSON;
+exports.ConfidenceEnumFromJSONTyped = ConfidenceEnumFromJSONTyped;
+exports.ConfidenceEnumToJSON = ConfidenceEnumToJSON;
+exports.ConfidenceEnumToJSONTyped = ConfidenceEnumToJSONTyped;
+/**
+ * The confidence level of the risk assessment.
+ * @export
+ * @enum {string}
+ */
+var ConfidenceEnum;
+(function (ConfidenceEnum) {
+    ConfidenceEnum["Low"] = "low";
+    ConfidenceEnum["Medium"] = "medium";
+    ConfidenceEnum["High"] = "high";
+})(ConfidenceEnum || (exports.ConfidenceEnum = ConfidenceEnum = {}));
+function instanceOfConfidenceEnum(value) {
+    for (const key in ConfidenceEnum) {
+        if (Object.prototype.hasOwnProperty.call(ConfidenceEnum, key)) {
+            if (ConfidenceEnum[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function ConfidenceEnumFromJSON(json) {
+    return ConfidenceEnumFromJSONTyped(json, false);
+}
+function ConfidenceEnumFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function ConfidenceEnumToJSON(value) {
+    return value;
+}
+function ConfidenceEnumToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/_generated/models/Crypto.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Crypto
+ */
+export interface Crypto {
+    /**
+     * Fixed to `crypto` for this schema.
+     * @type {string}
+     * @memberof Crypto
+     */
+    type: CryptoTypeEnum;
+}
+/**
+* @export
+* @enum {string}
+*/
+export declare enum CryptoTypeEnum {
+    Crypto = "crypto"
+}
+/**
+ * Check if a given object implements the Crypto interface.
+ */
+export declare function instanceOfCrypto(value: object): value is Crypto;
+export declare function CryptoFromJSON(json: any): Crypto;
+export declare function CryptoFromJSONTyped(json: any, ignoreDiscriminator: boolean): Crypto;
+export declare function CryptoToJSON(json: any): Crypto;
+export declare function CryptoToJSONTyped(value?: Crypto | null, ignoreDiscriminator?: boolean): any;

package/dist/_generated/models/Crypto.js

@@ -0,0 +1,59 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CryptoTypeEnum = void 0;
+exports.instanceOfCrypto = instanceOfCrypto;
+exports.CryptoFromJSON = CryptoFromJSON;
+exports.CryptoFromJSONTyped = CryptoFromJSONTyped;
+exports.CryptoToJSON = CryptoToJSON;
+exports.CryptoToJSONTyped = CryptoToJSONTyped;
+/**
+* @export
+* @enum {string}
+*/
+var CryptoTypeEnum;
+(function (CryptoTypeEnum) {
+    CryptoTypeEnum["Crypto"] = "crypto";
+})(CryptoTypeEnum || (exports.CryptoTypeEnum = CryptoTypeEnum = {}));
+/**
+ * Check if a given object implements the Crypto interface.
+ */
+function instanceOfCrypto(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    return true;
+}
+function CryptoFromJSON(json) {
+    return CryptoFromJSONTyped(json, false);
+}
+function CryptoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+    };
+}
+function CryptoToJSON(json) {
+    return CryptoToJSONTyped(json, false);
+}
+function CryptoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+    };
+}

package/dist/_generated/models/CvvResultEnum.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * M: CVV match
+ * N: CVV no match
+ * P: Not processed
+ * S: Should have been present
+ * U: Unavailable
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum CvvResultEnum {
+    M = "M",
+    N = "N",
+    P = "P",
+    S = "S",
+    U = "U"
+}
+export declare function instanceOfCvvResultEnum(value: any): boolean;
+export declare function CvvResultEnumFromJSON(json: any): CvvResultEnum;
+export declare function CvvResultEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): CvvResultEnum;
+export declare function CvvResultEnumToJSON(value?: CvvResultEnum | null): any;
+export declare function CvvResultEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): CvvResultEnum;

package/dist/_generated/models/CvvResultEnum.js

@@ -0,0 +1,61 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CvvResultEnum = void 0;
+exports.instanceOfCvvResultEnum = instanceOfCvvResultEnum;
+exports.CvvResultEnumFromJSON = CvvResultEnumFromJSON;
+exports.CvvResultEnumFromJSONTyped = CvvResultEnumFromJSONTyped;
+exports.CvvResultEnumToJSON = CvvResultEnumToJSON;
+exports.CvvResultEnumToJSONTyped = CvvResultEnumToJSONTyped;
+/**
+ * M: CVV match
+ * N: CVV no match
+ * P: Not processed
+ * S: Should have been present
+ * U: Unavailable
+ *
+ * @export
+ * @enum {string}
+ */
+var CvvResultEnum;
+(function (CvvResultEnum) {
+    CvvResultEnum["M"] = "M";
+    CvvResultEnum["N"] = "N";
+    CvvResultEnum["P"] = "P";
+    CvvResultEnum["S"] = "S";
+    CvvResultEnum["U"] = "U";
+})(CvvResultEnum || (exports.CvvResultEnum = CvvResultEnum = {}));
+function instanceOfCvvResultEnum(value) {
+    for (const key in CvvResultEnum) {
+        if (Object.prototype.hasOwnProperty.call(CvvResultEnum, key)) {
+            if (CvvResultEnum[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function CvvResultEnumFromJSON(json) {
+    return CvvResultEnumFromJSONTyped(json, false);
+}
+function CvvResultEnumFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function CvvResultEnumToJSON(value) {
+    return value;
+}
+function CvvResultEnumToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/_generated/models/DecisionResponse.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { FraudScore } from './FraudScore';
+import type { ReasonDetail } from './ReasonDetail';
+import type { RiskBreakdown } from './RiskBreakdown';
+/**
+ * The synchronous risk decision for a purchase.
+ * @export
+ * @interface DecisionResponse
+ */
+export interface DecisionResponse {
+    /**
+     * Universal decision identifier. For purchases, equals paymentIntentId.
+     * @type {string}
+     * @memberof DecisionResponse
+     */
+    assessmentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DecisionResponse
+     */
+    decision: DecisionResponseDecisionEnum;
+    /**
+     * RFC 3339 timestamp with timezone.
+     * @type {string}
+     * @memberof DecisionResponse
+     */
+    decisionAt: string;
+    /**
+     *
+     * @type {number}
+     * @memberof DecisionResponse
+     */
+    riskScore: number;
+    /**
+     *
+     * @type {FraudScore}
+     * @memberof DecisionResponse
+     */
+    fraudScore?: FraudScore;
+    /**
+     *
+     * @type {RiskBreakdown}
+     * @memberof DecisionResponse
+     */
+    breakdown?: RiskBreakdown;
+    /**
+     * Technical reason codes for the decision.
+     * @type {Array<string>}
+     * @memberof DecisionResponse
+     */
+    reasonCodes?: Array<string>;
+    /**
+     * Structured reason details for the decision.
+     * @type {Array<ReasonDetail>}
+     * @memberof DecisionResponse
+     */
+    reasons?: Array<ReasonDetail>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof DecisionResponse
+     */
+    actions?: Array<DecisionResponseActionsEnum>;
+    /**
+     * Server-minted unique payment identifier.
+     * @type {string}
+     * @memberof DecisionResponse
+     */
+    paymentIntentId?: string;
+    /**
+     * The version of the policy that generated the decision.
+     * @type {string}
+     * @memberof DecisionResponse
+     */
+    policyVersion?: string;
+    /**
+     * The version of the model that generated the decision.
+     * @type {string}
+     * @memberof DecisionResponse
+     */
+    modelVersion?: string;
+    /**
+     * Time to live for the decision in seconds.
+     * @type {number}
+     * @memberof DecisionResponse
+     */
+    ttlSeconds?: number;
+}
+/**
+* @export
+* @enum {string}
+*/
+export declare enum DecisionResponseDecisionEnum {
+    Approve = "approve",
+    Review = "review",
+    Decline = "decline",
+    StepUp = "step_up"
+}
+/**
+* @export
+* @enum {string}
+*/
+export declare enum DecisionResponseActionsEnum {
+    StepUp = "step_up",
+    Throttle = "throttle",
+    LockAccount = "lock_account",
+    Decline = "decline",
+    QueueReview = "queue_review"
+}
+/**
+ * Check if a given object implements the DecisionResponse interface.
+ */
+export declare function instanceOfDecisionResponse(value: object): value is DecisionResponse;
+export declare function DecisionResponseFromJSON(json: any): DecisionResponse;
+export declare function DecisionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DecisionResponse;
+export declare function DecisionResponseToJSON(json: any): DecisionResponse;
+export declare function DecisionResponseToJSONTyped(value?: DecisionResponse | null, ignoreDiscriminator?: boolean): any;