@alogram/payrisk 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/AI.md +37 -0
  2. package/LICENSE +201 -0
  3. package/README.md +129 -0
  4. package/dist/_generated/apis/PayriskApi.d.ts +108 -0
  5. package/dist/_generated/apis/PayriskApi.js +342 -0
  6. package/dist/_generated/apis/index.d.ts +1 -0
  7. package/dist/_generated/apis/index.js +19 -0
  8. package/dist/_generated/index.d.ts +3 -0
  9. package/dist/_generated/index.js +21 -0
  10. package/dist/_generated/models/Account.d.ts +59 -0
  11. package/dist/_generated/models/Account.js +57 -0
  12. package/dist/_generated/models/AccountCheckRequest.d.ts +64 -0
  13. package/dist/_generated/models/AccountCheckRequest.js +72 -0
  14. package/dist/_generated/models/AvsResultEnum.d.ts +54 -0
  15. package/dist/_generated/models/AvsResultEnum.js +82 -0
  16. package/dist/_generated/models/BankTransfer.d.ts +39 -0
  17. package/dist/_generated/models/BankTransfer.js +59 -0
  18. package/dist/_generated/models/Card.d.ts +93 -0
  19. package/dist/_generated/models/Card.js +81 -0
  20. package/dist/_generated/models/CardNetworkEnum.d.ts +30 -0
  21. package/dist/_generated/models/CardNetworkEnum.js +58 -0
  22. package/dist/_generated/models/CategorySignal.d.ts +45 -0
  23. package/dist/_generated/models/CategorySignal.js +55 -0
  24. package/dist/_generated/models/ChannelEnum.d.ts +28 -0
  25. package/dist/_generated/models/ChannelEnum.js +56 -0
  26. package/dist/_generated/models/CheckRequest.d.ts +66 -0
  27. package/dist/_generated/models/CheckRequest.js +72 -0
  28. package/dist/_generated/models/ConfidenceEnum.d.ts +26 -0
  29. package/dist/_generated/models/ConfidenceEnum.js +54 -0
  30. package/dist/_generated/models/Crypto.d.ts +39 -0
  31. package/dist/_generated/models/Crypto.js +59 -0
  32. package/dist/_generated/models/CvvResultEnum.d.ts +33 -0
  33. package/dist/_generated/models/CvvResultEnum.js +61 -0
  34. package/dist/_generated/models/DecisionResponse.d.ts +128 -0
  35. package/dist/_generated/models/DecisionResponse.js +107 -0
  36. package/dist/_generated/models/DeviceInfo.d.ts +54 -0
  37. package/dist/_generated/models/DeviceInfo.js +56 -0
  38. package/dist/_generated/models/EntityIds.d.ts +113 -0
  39. package/dist/_generated/models/EntityIds.js +70 -0
  40. package/dist/_generated/models/EntryMethodEnum.d.ts +30 -0
  41. package/dist/_generated/models/EntryMethodEnum.js +58 -0
  42. package/dist/_generated/models/FraudScore.d.ts +52 -0
  43. package/dist/_generated/models/FraudScore.js +58 -0
  44. package/dist/_generated/models/Identity.d.ts +71 -0
  45. package/dist/_generated/models/Identity.js +57 -0
  46. package/dist/_generated/models/Integrity.d.ts +68 -0
  47. package/dist/_generated/models/Integrity.js +58 -0
  48. package/dist/_generated/models/Interaction.d.ts +59 -0
  49. package/dist/_generated/models/Interaction.js +60 -0
  50. package/dist/_generated/models/InteractionTypeEnum.d.ts +29 -0
  51. package/dist/_generated/models/InteractionTypeEnum.js +57 -0
  52. package/dist/_generated/models/Invoice.d.ts +39 -0
  53. package/dist/_generated/models/Invoice.js +59 -0
  54. package/dist/_generated/models/IpInfo.d.ts +101 -0
  55. package/dist/_generated/models/IpInfo.js +78 -0
  56. package/dist/_generated/models/KycCheckRequest.d.ts +64 -0
  57. package/dist/_generated/models/KycCheckRequest.js +74 -0
  58. package/dist/_generated/models/KycPayload.d.ts +84 -0
  59. package/dist/_generated/models/KycPayload.js +82 -0
  60. package/dist/_generated/models/MerchantContext.d.ts +38 -0
  61. package/dist/_generated/models/MerchantContext.js +50 -0
  62. package/dist/_generated/models/OrderContext.d.ts +60 -0
  63. package/dist/_generated/models/OrderContext.js +65 -0
  64. package/dist/_generated/models/PayerTypeEnum.d.ts +25 -0
  65. package/dist/_generated/models/PayerTypeEnum.js +53 -0
  66. package/dist/_generated/models/PaymentAuthorizationOutcome.d.ts +38 -0
  67. package/dist/_generated/models/PaymentAuthorizationOutcome.js +50 -0
  68. package/dist/_generated/models/PaymentCaptureOutcome.d.ts +42 -0
  69. package/dist/_generated/models/PaymentCaptureOutcome.js +60 -0
  70. package/dist/_generated/models/PaymentCardTypeEnum.d.ts +26 -0
  71. package/dist/_generated/models/PaymentCardTypeEnum.js +54 -0
  72. package/dist/_generated/models/PaymentChargeback.d.ts +32 -0
  73. package/dist/_generated/models/PaymentChargeback.js +48 -0
  74. package/dist/_generated/models/PaymentChargebackOutcome.d.ts +42 -0
  75. package/dist/_generated/models/PaymentChargebackOutcome.js +60 -0
  76. package/dist/_generated/models/PaymentDisputeOutcome.d.ts +43 -0
  77. package/dist/_generated/models/PaymentDisputeOutcome.js +61 -0
  78. package/dist/_generated/models/PaymentEvent.d.ts +72 -0
  79. package/dist/_generated/models/PaymentEvent.js +68 -0
  80. package/dist/_generated/models/PaymentEventType.d.ts +30 -0
  81. package/dist/_generated/models/PaymentEventType.js +58 -0
  82. package/dist/_generated/models/PaymentMethod.d.ts +39 -0
  83. package/dist/_generated/models/PaymentMethod.js +73 -0
  84. package/dist/_generated/models/PaymentMethodBase.d.ts +44 -0
  85. package/dist/_generated/models/PaymentMethodBase.js +64 -0
  86. package/dist/_generated/models/PaymentOutcome.d.ts +69 -0
  87. package/dist/_generated/models/PaymentOutcome.js +64 -0
  88. package/dist/_generated/models/PaymentRealtimeTypeEnum.d.ts +28 -0
  89. package/dist/_generated/models/PaymentRealtimeTypeEnum.js +56 -0
  90. package/dist/_generated/models/PaymentRefundOutcome.d.ts +41 -0
  91. package/dist/_generated/models/PaymentRefundOutcome.js +59 -0
  92. package/dist/_generated/models/PaymentWalletTypeEnum.d.ts +28 -0
  93. package/dist/_generated/models/PaymentWalletTypeEnum.js +56 -0
  94. package/dist/_generated/models/PostalAddress.d.ts +65 -0
  95. package/dist/_generated/models/PostalAddress.js +58 -0
  96. package/dist/_generated/models/Problem.d.ts +62 -0
  97. package/dist/_generated/models/Problem.js +62 -0
  98. package/dist/_generated/models/Purchase.d.ts +122 -0
  99. package/dist/_generated/models/Purchase.js +88 -0
  100. package/dist/_generated/models/PurchaseInitiatorEnum.d.ts +25 -0
  101. package/dist/_generated/models/PurchaseInitiatorEnum.js +53 -0
  102. package/dist/_generated/models/PurchaseSequenceEnum.d.ts +25 -0
  103. package/dist/_generated/models/PurchaseSequenceEnum.js +53 -0
  104. package/dist/_generated/models/PurchaseUsageEnum.d.ts +27 -0
  105. package/dist/_generated/models/PurchaseUsageEnum.js +55 -0
  106. package/dist/_generated/models/Realtime.d.ts +46 -0
  107. package/dist/_generated/models/Realtime.js +62 -0
  108. package/dist/_generated/models/ReasonDetail.d.ts +57 -0
  109. package/dist/_generated/models/ReasonDetail.js +63 -0
  110. package/dist/_generated/models/RiskBreakdown.d.ts +51 -0
  111. package/dist/_generated/models/RiskBreakdown.js +55 -0
  112. package/dist/_generated/models/RiskCategoryEnum.d.ts +27 -0
  113. package/dist/_generated/models/RiskCategoryEnum.js +55 -0
  114. package/dist/_generated/models/RiskLevelEnum.d.ts +26 -0
  115. package/dist/_generated/models/RiskLevelEnum.js +54 -0
  116. package/dist/_generated/models/ScaMethodEnum.d.ts +30 -0
  117. package/dist/_generated/models/ScaMethodEnum.js +58 -0
  118. package/dist/_generated/models/ScoreRecord.d.ts +107 -0
  119. package/dist/_generated/models/ScoreRecord.js +92 -0
  120. package/dist/_generated/models/ScoresSuccessResponse.d.ts +39 -0
  121. package/dist/_generated/models/ScoresSuccessResponse.js +51 -0
  122. package/dist/_generated/models/SignalsAccountVariant.d.ts +53 -0
  123. package/dist/_generated/models/SignalsAccountVariant.js +69 -0
  124. package/dist/_generated/models/SignalsInteractionVariant.d.ts +53 -0
  125. package/dist/_generated/models/SignalsInteractionVariant.js +69 -0
  126. package/dist/_generated/models/SignalsRequest.d.ts +28 -0
  127. package/dist/_generated/models/SignalsRequest.js +53 -0
  128. package/dist/_generated/models/StoredCredentialContext.d.ts +47 -0
  129. package/dist/_generated/models/StoredCredentialContext.js +55 -0
  130. package/dist/_generated/models/ThreeDSData.d.ts +68 -0
  131. package/dist/_generated/models/ThreeDSData.js +66 -0
  132. package/dist/_generated/models/Wallet.d.ts +46 -0
  133. package/dist/_generated/models/Wallet.js +62 -0
  134. package/dist/_generated/models/index.d.ts +62 -0
  135. package/dist/_generated/models/index.js +80 -0
  136. package/dist/_generated/runtime.d.ts +184 -0
  137. package/dist/_generated/runtime.js +338 -0
  138. package/dist/client.d.ts +69 -0
  139. package/dist/client.js +281 -0
  140. package/dist/exceptions.d.ts +24 -0
  141. package/dist/exceptions.js +59 -0
  142. package/dist/index.d.ts +5 -0
  143. package/dist/index.js +23 -0
  144. package/dist/testing.d.ts +24 -0
  145. package/dist/testing.js +100 -0
  146. package/dist/webhooks.d.ts +10 -0
  147. package/dist/webhooks.js +32 -0
  148. package/examples/asyncSignalIngestion.ts +52 -0
  149. package/examples/checkRisk.ts +26 -0
  150. package/examples/productionErrorHandling.ts +52 -0
  151. package/examples/webhookVerification.ts +29 -0
  152. package/package.json +64 -0
@@ -0,0 +1,107 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Payments Risk API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 0.1.6-rc.3
9
+ * Contact: support@alogram.ai
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.DecisionResponseActionsEnum = exports.DecisionResponseDecisionEnum = void 0;
17
+ exports.instanceOfDecisionResponse = instanceOfDecisionResponse;
18
+ exports.DecisionResponseFromJSON = DecisionResponseFromJSON;
19
+ exports.DecisionResponseFromJSONTyped = DecisionResponseFromJSONTyped;
20
+ exports.DecisionResponseToJSON = DecisionResponseToJSON;
21
+ exports.DecisionResponseToJSONTyped = DecisionResponseToJSONTyped;
22
+ const FraudScore_1 = require("./FraudScore");
23
+ const ReasonDetail_1 = require("./ReasonDetail");
24
+ const RiskBreakdown_1 = require("./RiskBreakdown");
25
+ /**
26
+ * @export
27
+ * @enum {string}
28
+ */
29
+ var DecisionResponseDecisionEnum;
30
+ (function (DecisionResponseDecisionEnum) {
31
+ DecisionResponseDecisionEnum["Approve"] = "approve";
32
+ DecisionResponseDecisionEnum["Review"] = "review";
33
+ DecisionResponseDecisionEnum["Decline"] = "decline";
34
+ DecisionResponseDecisionEnum["StepUp"] = "step_up";
35
+ })(DecisionResponseDecisionEnum || (exports.DecisionResponseDecisionEnum = DecisionResponseDecisionEnum = {}));
36
+ /**
37
+ * @export
38
+ * @enum {string}
39
+ */
40
+ var DecisionResponseActionsEnum;
41
+ (function (DecisionResponseActionsEnum) {
42
+ DecisionResponseActionsEnum["StepUp"] = "step_up";
43
+ DecisionResponseActionsEnum["Throttle"] = "throttle";
44
+ DecisionResponseActionsEnum["LockAccount"] = "lock_account";
45
+ DecisionResponseActionsEnum["Decline"] = "decline";
46
+ DecisionResponseActionsEnum["QueueReview"] = "queue_review";
47
+ })(DecisionResponseActionsEnum || (exports.DecisionResponseActionsEnum = DecisionResponseActionsEnum = {}));
48
+ /**
49
+ * Check if a given object implements the DecisionResponse interface.
50
+ */
51
+ function instanceOfDecisionResponse(value) {
52
+ if (!('assessmentId' in value) || value['assessmentId'] === undefined)
53
+ return false;
54
+ if (!('decision' in value) || value['decision'] === undefined)
55
+ return false;
56
+ if (!('decisionAt' in value) || value['decisionAt'] === undefined)
57
+ return false;
58
+ if (!('riskScore' in value) || value['riskScore'] === undefined)
59
+ return false;
60
+ return true;
61
+ }
62
+ function DecisionResponseFromJSON(json) {
63
+ return DecisionResponseFromJSONTyped(json, false);
64
+ }
65
+ function DecisionResponseFromJSONTyped(json, ignoreDiscriminator) {
66
+ if (json == null) {
67
+ return json;
68
+ }
69
+ return {
70
+ 'assessmentId': json['assessmentId'],
71
+ 'decision': json['decision'],
72
+ 'decisionAt': json['decisionAt'],
73
+ 'riskScore': json['riskScore'],
74
+ 'fraudScore': json['fraudScore'] == null ? undefined : (0, FraudScore_1.FraudScoreFromJSON)(json['fraudScore']),
75
+ 'breakdown': json['breakdown'] == null ? undefined : (0, RiskBreakdown_1.RiskBreakdownFromJSON)(json['breakdown']),
76
+ 'reasonCodes': json['reasonCodes'] == null ? undefined : json['reasonCodes'],
77
+ 'reasons': json['reasons'] == null ? undefined : (json['reasons'].map(ReasonDetail_1.ReasonDetailFromJSON)),
78
+ 'actions': json['actions'] == null ? undefined : json['actions'],
79
+ 'paymentIntentId': json['paymentIntentId'] == null ? undefined : json['paymentIntentId'],
80
+ 'policyVersion': json['policyVersion'] == null ? undefined : json['policyVersion'],
81
+ 'modelVersion': json['modelVersion'] == null ? undefined : json['modelVersion'],
82
+ 'ttlSeconds': json['ttlSeconds'] == null ? undefined : json['ttlSeconds'],
83
+ };
84
+ }
85
+ function DecisionResponseToJSON(json) {
86
+ return DecisionResponseToJSONTyped(json, false);
87
+ }
88
+ function DecisionResponseToJSONTyped(value, ignoreDiscriminator = false) {
89
+ if (value == null) {
90
+ return value;
91
+ }
92
+ return {
93
+ 'assessmentId': value['assessmentId'],
94
+ 'decision': value['decision'],
95
+ 'decisionAt': value['decisionAt'],
96
+ 'riskScore': value['riskScore'],
97
+ 'fraudScore': (0, FraudScore_1.FraudScoreToJSON)(value['fraudScore']),
98
+ 'breakdown': (0, RiskBreakdown_1.RiskBreakdownToJSON)(value['breakdown']),
99
+ 'reasonCodes': value['reasonCodes'],
100
+ 'reasons': value['reasons'] == null ? undefined : (value['reasons'].map(ReasonDetail_1.ReasonDetailToJSON)),
101
+ 'actions': value['actions'],
102
+ 'paymentIntentId': value['paymentIntentId'],
103
+ 'policyVersion': value['policyVersion'],
104
+ 'modelVersion': value['modelVersion'],
105
+ 'ttlSeconds': value['ttlSeconds'],
106
+ };
107
+ }
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Payments Risk API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.6-rc.3
6
+ * Contact: support@alogram.ai
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { IpInfo } from './IpInfo';
13
+ import type { Integrity } from './Integrity';
14
+ /**
15
+ * Aggregated device fingerprinting and behavioral patterns used for fraud detection.
16
+ * @export
17
+ * @interface DeviceInfo
18
+ */
19
+ export interface DeviceInfo {
20
+ /**
21
+ * Unique hash representing the device's fingerprint. Lowercase hex. Prefix "fp_".
22
+ *
23
+ * @type {string}
24
+ * @memberof DeviceInfo
25
+ */
26
+ fingerprint?: string;
27
+ /**
28
+ * Browser's User-Agent string, useful for identifying OS and browser type. Must be between 10 and 512 printable ASCII characters.
29
+ *
30
+ * @type {string}
31
+ * @memberof DeviceInfo
32
+ */
33
+ userAgent?: string;
34
+ /**
35
+ *
36
+ * @type {IpInfo}
37
+ * @memberof DeviceInfo
38
+ */
39
+ ip?: IpInfo;
40
+ /**
41
+ *
42
+ * @type {Integrity}
43
+ * @memberof DeviceInfo
44
+ */
45
+ integrity?: Integrity;
46
+ }
47
+ /**
48
+ * Check if a given object implements the DeviceInfo interface.
49
+ */
50
+ export declare function instanceOfDeviceInfo(value: object): value is DeviceInfo;
51
+ export declare function DeviceInfoFromJSON(json: any): DeviceInfo;
52
+ export declare function DeviceInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeviceInfo;
53
+ export declare function DeviceInfoToJSON(json: any): DeviceInfo;
54
+ export declare function DeviceInfoToJSONTyped(value?: DeviceInfo | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Payments Risk API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 0.1.6-rc.3
9
+ * Contact: support@alogram.ai
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfDeviceInfo = instanceOfDeviceInfo;
17
+ exports.DeviceInfoFromJSON = DeviceInfoFromJSON;
18
+ exports.DeviceInfoFromJSONTyped = DeviceInfoFromJSONTyped;
19
+ exports.DeviceInfoToJSON = DeviceInfoToJSON;
20
+ exports.DeviceInfoToJSONTyped = DeviceInfoToJSONTyped;
21
+ const IpInfo_1 = require("./IpInfo");
22
+ const Integrity_1 = require("./Integrity");
23
+ /**
24
+ * Check if a given object implements the DeviceInfo interface.
25
+ */
26
+ function instanceOfDeviceInfo(value) {
27
+ return true;
28
+ }
29
+ function DeviceInfoFromJSON(json) {
30
+ return DeviceInfoFromJSONTyped(json, false);
31
+ }
32
+ function DeviceInfoFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'fingerprint': json['fingerprint'] == null ? undefined : json['fingerprint'],
38
+ 'userAgent': json['userAgent'] == null ? undefined : json['userAgent'],
39
+ 'ip': json['ip'] == null ? undefined : (0, IpInfo_1.IpInfoFromJSON)(json['ip']),
40
+ 'integrity': json['integrity'] == null ? undefined : (0, Integrity_1.IntegrityFromJSON)(json['integrity']),
41
+ };
42
+ }
43
+ function DeviceInfoToJSON(json) {
44
+ return DeviceInfoToJSONTyped(json, false);
45
+ }
46
+ function DeviceInfoToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'fingerprint': value['fingerprint'],
52
+ 'userAgent': value['userAgent'],
53
+ 'ip': (0, IpInfo_1.IpInfoToJSON)(value['ip']),
54
+ 'integrity': (0, Integrity_1.IntegrityToJSON)(value['integrity']),
55
+ };
56
+ }
@@ -0,0 +1,113 @@
1
+ /**
2
+ * Payments Risk API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.6-rc.3
6
+ * Contact: support@alogram.ai
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Canonical entity identifiers (tenant/client/user/device/session). Do not send raw PII. Hash emails/phones/addresses as sha256 and prefix with 'sha256_'.
14
+ * Tiered support:
15
+ * - tenantId is the top-level SaaS customer (required for all flows).
16
+ * - clientId is the tenant's downstream business customer (e.g. merchant/partner) and MAY be omitted for
17
+ * processor / bank / PSP-style integrations.
18
+ * - endCustomerId is the tenant/client's consumer or business account (cardholder, shopper, etc.) and
19
+ * MAY be omitted for purely device- or instrument-level checks.
20
+ *
21
+ * @export
22
+ * @interface EntityIds
23
+ */
24
+ export interface EntityIds {
25
+ /**
26
+ * Canonical ID for the paying organization (Tenant). Opaque, immutable, lowercase. Must start with "tid_". Do not use domains or emails here. For a tenant's domain, use a separate field (e.g., tenantDomain).
27
+ *
28
+ * @type {string}
29
+ * @memberof EntityIds
30
+ */
31
+ tenantId?: string;
32
+ /**
33
+ * Canonical ID for the Tenant’s business customer (e.g., merchant/partner). Opaque, immutable, lowercase. Must start with 'cid_'.
34
+ *
35
+ * @type {string}
36
+ * @memberof EntityIds
37
+ */
38
+ clientId?: string;
39
+ /**
40
+ * Canonical ID for the client’s end user / consumer (account holder). Opaque, immutable, lowercase. Must start with "ecid_". Do not put PII (like emails or phone numbers) in this field.
41
+ *
42
+ * @type {string}
43
+ * @memberof EntityIds
44
+ */
45
+ endCustomerId?: string;
46
+ /**
47
+ * Canonical ID for a Tenant member/operator (employee/contractor) using the platform. Opaque, immutable, lowercase. Must start with 'mid_'.
48
+ *
49
+ * @type {string}
50
+ * @memberof EntityIds
51
+ */
52
+ memberId?: string;
53
+ /**
54
+ * Tokenized instrument ID (non-PCI).
55
+ * @type {string}
56
+ * @memberof EntityIds
57
+ */
58
+ paymentInstrumentId?: string;
59
+ /**
60
+ * Server-issued stable device token (device-level identifier).
61
+ * Should persist across sessions and logins on the same browser/device.
62
+ *
63
+ * @type {string}
64
+ * @memberof EntityIds
65
+ */
66
+ deviceId?: string;
67
+ /**
68
+ * Application/user session identifier (login or checkout session).
69
+ * Typically rotates more frequently than deviceId and may be tied to authentication.
70
+ *
71
+ * @type {string}
72
+ * @memberof EntityIds
73
+ */
74
+ sessionId?: string;
75
+ /**
76
+ * Normalized+lowercased email hash (e.g., sha256).
77
+ * @type {string}
78
+ * @memberof EntityIds
79
+ */
80
+ emailHash?: string;
81
+ /**
82
+ * Normalized+lowercased email *domain* hash (e.g., sha256).
83
+ * @type {string}
84
+ * @memberof EntityIds
85
+ */
86
+ emailDomainHash?: string;
87
+ /**
88
+ * Normalized+lowercased phone hash (e.g., sha256).
89
+ * @type {string}
90
+ * @memberof EntityIds
91
+ */
92
+ phoneHash?: string;
93
+ /**
94
+ * Normalized+lowercased shipping address hash (e.g., sha256).
95
+ * @type {string}
96
+ * @memberof EntityIds
97
+ */
98
+ shippingAddressHash?: string;
99
+ /**
100
+ * Normalized+lowercased billing address hash (e.g., sha256).
101
+ * @type {string}
102
+ * @memberof EntityIds
103
+ */
104
+ billingAddressHash?: string;
105
+ }
106
+ /**
107
+ * Check if a given object implements the EntityIds interface.
108
+ */
109
+ export declare function instanceOfEntityIds(value: object): value is EntityIds;
110
+ export declare function EntityIdsFromJSON(json: any): EntityIds;
111
+ export declare function EntityIdsFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityIds;
112
+ export declare function EntityIdsToJSON(json: any): EntityIds;
113
+ export declare function EntityIdsToJSONTyped(value?: EntityIds | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Payments Risk API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 0.1.6-rc.3
9
+ * Contact: support@alogram.ai
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfEntityIds = instanceOfEntityIds;
17
+ exports.EntityIdsFromJSON = EntityIdsFromJSON;
18
+ exports.EntityIdsFromJSONTyped = EntityIdsFromJSONTyped;
19
+ exports.EntityIdsToJSON = EntityIdsToJSON;
20
+ exports.EntityIdsToJSONTyped = EntityIdsToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the EntityIds interface.
23
+ */
24
+ function instanceOfEntityIds(value) {
25
+ return true;
26
+ }
27
+ function EntityIdsFromJSON(json) {
28
+ return EntityIdsFromJSONTyped(json, false);
29
+ }
30
+ function EntityIdsFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'tenantId': json['tenantId'] == null ? undefined : json['tenantId'],
36
+ 'clientId': json['clientId'] == null ? undefined : json['clientId'],
37
+ 'endCustomerId': json['endCustomerId'] == null ? undefined : json['endCustomerId'],
38
+ 'memberId': json['memberId'] == null ? undefined : json['memberId'],
39
+ 'paymentInstrumentId': json['paymentInstrumentId'] == null ? undefined : json['paymentInstrumentId'],
40
+ 'deviceId': json['deviceId'] == null ? undefined : json['deviceId'],
41
+ 'sessionId': json['sessionId'] == null ? undefined : json['sessionId'],
42
+ 'emailHash': json['emailHash'] == null ? undefined : json['emailHash'],
43
+ 'emailDomainHash': json['emailDomainHash'] == null ? undefined : json['emailDomainHash'],
44
+ 'phoneHash': json['phoneHash'] == null ? undefined : json['phoneHash'],
45
+ 'shippingAddressHash': json['shippingAddressHash'] == null ? undefined : json['shippingAddressHash'],
46
+ 'billingAddressHash': json['billingAddressHash'] == null ? undefined : json['billingAddressHash'],
47
+ };
48
+ }
49
+ function EntityIdsToJSON(json) {
50
+ return EntityIdsToJSONTyped(json, false);
51
+ }
52
+ function EntityIdsToJSONTyped(value, ignoreDiscriminator = false) {
53
+ if (value == null) {
54
+ return value;
55
+ }
56
+ return {
57
+ 'tenantId': value['tenantId'],
58
+ 'clientId': value['clientId'],
59
+ 'endCustomerId': value['endCustomerId'],
60
+ 'memberId': value['memberId'],
61
+ 'paymentInstrumentId': value['paymentInstrumentId'],
62
+ 'deviceId': value['deviceId'],
63
+ 'sessionId': value['sessionId'],
64
+ 'emailHash': value['emailHash'],
65
+ 'emailDomainHash': value['emailDomainHash'],
66
+ 'phoneHash': value['phoneHash'],
67
+ 'shippingAddressHash': value['shippingAddressHash'],
68
+ 'billingAddressHash': value['billingAddressHash'],
69
+ };
70
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Payments Risk API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.6-rc.3
6
+ * Contact: support@alogram.ai
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * The method used to capture card data.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum EntryMethodEnum {
18
+ Chip = "chip",
19
+ Contactless = "contactless",
20
+ Magstripe = "magstripe",
21
+ ManualKeyed = "manual_keyed",
22
+ CardOnFile = "card_on_file",
23
+ WalletToken = "wallet_token",
24
+ NetworkToken = "network_token"
25
+ }
26
+ export declare function instanceOfEntryMethodEnum(value: any): boolean;
27
+ export declare function EntryMethodEnumFromJSON(json: any): EntryMethodEnum;
28
+ export declare function EntryMethodEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntryMethodEnum;
29
+ export declare function EntryMethodEnumToJSON(value?: EntryMethodEnum | null): any;
30
+ export declare function EntryMethodEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): EntryMethodEnum;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Payments Risk API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 0.1.6-rc.3
9
+ * Contact: support@alogram.ai
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.EntryMethodEnum = void 0;
17
+ exports.instanceOfEntryMethodEnum = instanceOfEntryMethodEnum;
18
+ exports.EntryMethodEnumFromJSON = EntryMethodEnumFromJSON;
19
+ exports.EntryMethodEnumFromJSONTyped = EntryMethodEnumFromJSONTyped;
20
+ exports.EntryMethodEnumToJSON = EntryMethodEnumToJSON;
21
+ exports.EntryMethodEnumToJSONTyped = EntryMethodEnumToJSONTyped;
22
+ /**
23
+ * The method used to capture card data.
24
+ * @export
25
+ * @enum {string}
26
+ */
27
+ var EntryMethodEnum;
28
+ (function (EntryMethodEnum) {
29
+ EntryMethodEnum["Chip"] = "chip";
30
+ EntryMethodEnum["Contactless"] = "contactless";
31
+ EntryMethodEnum["Magstripe"] = "magstripe";
32
+ EntryMethodEnum["ManualKeyed"] = "manual_keyed";
33
+ EntryMethodEnum["CardOnFile"] = "card_on_file";
34
+ EntryMethodEnum["WalletToken"] = "wallet_token";
35
+ EntryMethodEnum["NetworkToken"] = "network_token";
36
+ })(EntryMethodEnum || (exports.EntryMethodEnum = EntryMethodEnum = {}));
37
+ function instanceOfEntryMethodEnum(value) {
38
+ for (const key in EntryMethodEnum) {
39
+ if (Object.prototype.hasOwnProperty.call(EntryMethodEnum, key)) {
40
+ if (EntryMethodEnum[key] === value) {
41
+ return true;
42
+ }
43
+ }
44
+ }
45
+ return false;
46
+ }
47
+ function EntryMethodEnumFromJSON(json) {
48
+ return EntryMethodEnumFromJSONTyped(json, false);
49
+ }
50
+ function EntryMethodEnumFromJSONTyped(json, ignoreDiscriminator) {
51
+ return json;
52
+ }
53
+ function EntryMethodEnumToJSON(value) {
54
+ return value;
55
+ }
56
+ function EntryMethodEnumToJSONTyped(value, ignoreDiscriminator) {
57
+ return value;
58
+ }
@@ -0,0 +1,52 @@
1
+ /**
2
+ * Payments Risk API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.6-rc.3
6
+ * Contact: support@alogram.ai
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { RiskLevelEnum } from './RiskLevelEnum';
13
+ import type { ConfidenceEnum } from './ConfidenceEnum';
14
+ /**
15
+ * Fraud score for a specific transaction or entity.
16
+ * @export
17
+ * @interface FraudScore
18
+ */
19
+ export interface FraudScore {
20
+ /**
21
+ *
22
+ * @type {RiskLevelEnum}
23
+ * @memberof FraudScore
24
+ */
25
+ riskLevel: RiskLevelEnum;
26
+ /**
27
+ *
28
+ * @type {ConfidenceEnum}
29
+ * @memberof FraudScore
30
+ */
31
+ confidence?: ConfidenceEnum;
32
+ /**
33
+ * Fraud risk score (0.00 - 1.00).
34
+ * @type {number}
35
+ * @memberof FraudScore
36
+ */
37
+ score?: number;
38
+ /**
39
+ * A human-readable explanation of the fraud score, if available.
40
+ * @type {string}
41
+ * @memberof FraudScore
42
+ */
43
+ explanation?: string;
44
+ }
45
+ /**
46
+ * Check if a given object implements the FraudScore interface.
47
+ */
48
+ export declare function instanceOfFraudScore(value: object): value is FraudScore;
49
+ export declare function FraudScoreFromJSON(json: any): FraudScore;
50
+ export declare function FraudScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): FraudScore;
51
+ export declare function FraudScoreToJSON(json: any): FraudScore;
52
+ export declare function FraudScoreToJSONTyped(value?: FraudScore | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Payments Risk API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 0.1.6-rc.3
9
+ * Contact: support@alogram.ai
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfFraudScore = instanceOfFraudScore;
17
+ exports.FraudScoreFromJSON = FraudScoreFromJSON;
18
+ exports.FraudScoreFromJSONTyped = FraudScoreFromJSONTyped;
19
+ exports.FraudScoreToJSON = FraudScoreToJSON;
20
+ exports.FraudScoreToJSONTyped = FraudScoreToJSONTyped;
21
+ const RiskLevelEnum_1 = require("./RiskLevelEnum");
22
+ const ConfidenceEnum_1 = require("./ConfidenceEnum");
23
+ /**
24
+ * Check if a given object implements the FraudScore interface.
25
+ */
26
+ function instanceOfFraudScore(value) {
27
+ if (!('riskLevel' in value) || value['riskLevel'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function FraudScoreFromJSON(json) {
32
+ return FraudScoreFromJSONTyped(json, false);
33
+ }
34
+ function FraudScoreFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'riskLevel': (0, RiskLevelEnum_1.RiskLevelEnumFromJSON)(json['riskLevel']),
40
+ 'confidence': json['confidence'] == null ? undefined : (0, ConfidenceEnum_1.ConfidenceEnumFromJSON)(json['confidence']),
41
+ 'score': json['score'] == null ? undefined : json['score'],
42
+ 'explanation': json['explanation'] == null ? undefined : json['explanation'],
43
+ };
44
+ }
45
+ function FraudScoreToJSON(json) {
46
+ return FraudScoreToJSONTyped(json, false);
47
+ }
48
+ function FraudScoreToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'riskLevel': (0, RiskLevelEnum_1.RiskLevelEnumToJSON)(value['riskLevel']),
54
+ 'confidence': (0, ConfidenceEnum_1.ConfidenceEnumToJSON)(value['confidence']),
55
+ 'score': value['score'],
56
+ 'explanation': value['explanation'],
57
+ };
58
+ }
@@ -0,0 +1,71 @@
1
+ /**
2
+ * Payments Risk API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.6-rc.3
6
+ * Contact: support@alogram.ai
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { PostalAddress } from './PostalAddress';
13
+ /**
14
+ * Optional raw identity details for the account associated with the purchase.
15
+ * These fields (email, phone, addresses) are used for normalization, hashing,
16
+ * and risk feature extraction (e.g., email/phone/domain scoring, address risk),
17
+ * and are not stored in raw form by Alogram.
18
+ *
19
+ * When provided, Alogram will derive and/or cross-check:
20
+ * - emailHash / phoneHash / shippingAddressHash / billingAddressHash
21
+ * in the internal entity model
22
+ * - email/phone/domain risk signals
23
+ * - address consistency and geo-distance checks
24
+ *
25
+ * @export
26
+ * @interface Identity
27
+ */
28
+ export interface Identity {
29
+ /**
30
+ * Email address of the customer.
31
+ * @type {string}
32
+ * @memberof Identity
33
+ */
34
+ email?: string;
35
+ /**
36
+ * Email domain only (no local part). Useful for domain-level risk and
37
+ * allow/deny lists without sending full email PII.
38
+ * Example: "gmail.com", "merchant-example.co.uk"
39
+ *
40
+ * @type {string}
41
+ * @memberof Identity
42
+ */
43
+ emailDomain?: string;
44
+ /**
45
+ * Phone number that supports international E.164 format, as well as spaces, dashes, and parentheses. Examples: "+1 (415) 555-2671", "415-555-2671", "+14155552671"
46
+ *
47
+ * @type {string}
48
+ * @memberof Identity
49
+ */
50
+ phone?: string;
51
+ /**
52
+ *
53
+ * @type {PostalAddress}
54
+ * @memberof Identity
55
+ */
56
+ shippingAddress?: PostalAddress;
57
+ /**
58
+ *
59
+ * @type {PostalAddress}
60
+ * @memberof Identity
61
+ */
62
+ billingAddress?: PostalAddress;
63
+ }
64
+ /**
65
+ * Check if a given object implements the Identity interface.
66
+ */
67
+ export declare function instanceOfIdentity(value: object): value is Identity;
68
+ export declare function IdentityFromJSON(json: any): Identity;
69
+ export declare function IdentityFromJSONTyped(json: any, ignoreDiscriminator: boolean): Identity;
70
+ export declare function IdentityToJSON(json: any): Identity;
71
+ export declare function IdentityToJSONTyped(value?: Identity | null, ignoreDiscriminator?: boolean): any;