-
Notifications
You must be signed in to change notification settings - Fork 10
/
transaction-report.ts
89 lines (83 loc) · 2.86 KB
/
transaction-report.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
import { isIP } from 'net';
import * as snakecaseKeys from 'snakecase-keys';
import { Tag } from '../constants';
import { ArgumentError } from '../errors';
interface TransactionReportProps {
/**
* A string which is provided by your payment processor indicating the
* reason for the chargeback.
*/
chargebackCode?: string;
/**
* The IP address of the customer placing the order.
*/
ipAddress: string;
/**
* A unique eight character string identifying a minFraud Standard or
* Premium request. These IDs are returned in the maxmindID field of a
* response for a successful minFraud request. This field is not required,
* but you are encouraged to provide it, if possible.
*/
maxmindId?: string;
/**
* A UUID that identifies a minFraud Score, minFraud Insights, or minFraud
* Factors request. This ID is returned at /id in the response. This field
* is not required, but you are encouraged to provide it if the request was
* made to one of these services.
*/
minfraudId?: string;
/**
* Your notes on the fraud tag associated with the transaction. We manually
* review many reported transactions to improve our scoring for you so any
* additional details to help us understand context are helpful.
*/
notes?: string;
/**
* A Tag enum indicating the likelihood that a transaction may be
* fraudulent.
*/
tag: Tag;
/**
* The transaction ID you originally passed to minFraud. This field is not
* required, but you are encouraged to provide it or the transaction’s
* maxmindId or minfraudId.
*/
transactionId?: string;
}
export default class TransactionReport {
/** @inheritDoc TransactionReportProps.chargebackCode */
public chargebackCode?: string;
/** @inheritDoc TransactionReportProps.ipAddress */
public ipAddress: string;
/** @inheritDoc TransactionReportProps.maxmindId */
public maxmindId?: string;
/** @inheritDoc TransactionReportProps.minfraudId */
public minfraudId?: string;
/** @inheritDoc TransactionReportProps.notes */
public notes?: string;
/** @inheritDoc TransactionReportProps.tag */
public tag: Tag;
/** @inheritDoc TransactionReportProps.transactionId */
public transactionId?: string;
public constructor(transactionReport: TransactionReportProps) {
if (isIP(transactionReport.ipAddress) === 0) {
throw new ArgumentError(
'`transactionReport.ipAddress` is an invalid IP address'
);
}
if (
!transactionReport.tag ||
!Object.values(Tag).includes(transactionReport.tag)
) {
throw new ArgumentError(
`"${transactionReport.tag}" is an invalid value for "transactionReport.tag"`
);
}
this.ipAddress = transactionReport.ipAddress;
this.tag = transactionReport.tag;
Object.assign(this, transactionReport);
}
public toString(): string {
return JSON.stringify(snakecaseKeys(this));
}
}