@whop/sdk 0.0.28 → 0.0.30
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.
- package/CHANGELOG.md +49 -0
- package/client.d.mts +7 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +7 -6
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/checkout-configurations.d.mts +0 -13
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +0 -13
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +6 -33
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +6 -33
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs.map +1 -1
- package/resources/dispute-alerts.d.mts +325 -0
- package/resources/dispute-alerts.d.mts.map +1 -0
- package/resources/dispute-alerts.d.ts +325 -0
- package/resources/dispute-alerts.d.ts.map +1 -0
- package/resources/dispute-alerts.js +42 -0
- package/resources/dispute-alerts.js.map +1 -0
- package/resources/dispute-alerts.mjs +38 -0
- package/resources/dispute-alerts.mjs.map +1 -0
- package/resources/experiences.d.mts +0 -4
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +0 -4
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +0 -4
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +0 -4
- package/resources/experiences.mjs.map +1 -1
- package/resources/index.d.mts +3 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/messages.d.mts +4 -0
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +4 -0
- package/resources/messages.d.ts.map +1 -1
- package/resources/payments.d.mts +1 -14
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +1 -14
- package/resources/payments.d.ts.map +1 -1
- package/resources/payments.js.map +1 -1
- package/resources/payments.mjs.map +1 -1
- package/resources/products.d.mts +1 -29
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +1 -29
- package/resources/products.d.ts.map +1 -1
- package/resources/refunds.d.mts +1 -1
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +1 -1
- package/resources/refunds.d.ts.map +1 -1
- package/resources/shared.d.mts +1 -33
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +1 -33
- package/resources/shared.d.ts.map +1 -1
- package/resources/support-channels.d.mts +4 -0
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +4 -0
- package/resources/support-channels.d.ts.map +1 -1
- package/resources/webhooks.d.mts +224 -3
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +224 -3
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +21 -4
- package/src/resources/checkout-configurations.ts +0 -16
- package/src/resources/companies.ts +6 -40
- package/src/resources/dispute-alerts.ts +404 -0
- package/src/resources/experiences.ts +0 -4
- package/src/resources/index.ts +9 -1
- package/src/resources/messages.ts +5 -0
- package/src/resources/payments.ts +1 -16
- package/src/resources/products.ts +0 -170
- package/src/resources/refunds.ts +2 -1
- package/src/resources/shared.ts +2 -1991
- package/src/resources/support-channels.ts +5 -0
- package/src/resources/webhooks.ts +268 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,
|
|
1
|
+
{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;CAGpE;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAE1C;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEtD;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companies.js","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;
|
|
1
|
+
{"version":3,"file":"companies.js","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,uBAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAxDD,8BAwDC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"companies.mjs","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;
|
|
1
|
+
{"version":3,"file":"companies.mjs","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,UAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}
|
|
@@ -0,0 +1,325 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as DisputesAPI from "./disputes.mjs";
|
|
3
|
+
import * as PaymentsAPI from "./payments.mjs";
|
|
4
|
+
import * as Shared from "./shared.mjs";
|
|
5
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
6
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
7
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
8
|
+
export declare class DisputeAlerts extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieves the details of an existing dispute alert.
|
|
11
|
+
*
|
|
12
|
+
* Required permissions:
|
|
13
|
+
*
|
|
14
|
+
* - `payment:dispute_alert:read`
|
|
15
|
+
* - `payment:basic:read`
|
|
16
|
+
* - `member:email:read`
|
|
17
|
+
* - `member:basic:read`
|
|
18
|
+
* - `member:phone:read`
|
|
19
|
+
* - `payment:dispute:read`
|
|
20
|
+
*/
|
|
21
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<DisputeAlertRetrieveResponse>;
|
|
22
|
+
/**
|
|
23
|
+
* Returns a paginated list of dispute alerts for a company, with optional
|
|
24
|
+
* filtering by creation date.
|
|
25
|
+
*
|
|
26
|
+
* Required permissions:
|
|
27
|
+
*
|
|
28
|
+
* - `payment:dispute_alert:read`
|
|
29
|
+
* - `payment:basic:read`
|
|
30
|
+
* - `payment:dispute:read`
|
|
31
|
+
*/
|
|
32
|
+
list(query: DisputeAlertListParams, options?: RequestOptions): PagePromise<DisputeAlertListResponsesCursorPage, DisputeAlertListResponse>;
|
|
33
|
+
}
|
|
34
|
+
export type DisputeAlertListResponsesCursorPage = CursorPage<DisputeAlertListResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* The type of dispute alert.
|
|
37
|
+
*/
|
|
38
|
+
export type DisputeAlertType = 'dispute' | 'dispute_rdr' | 'fraud';
|
|
39
|
+
/**
|
|
40
|
+
* A dispute alert represents an early warning notification from a payment
|
|
41
|
+
* processor about a potential dispute or chargeback.
|
|
42
|
+
*/
|
|
43
|
+
export interface DisputeAlertRetrieveResponse {
|
|
44
|
+
/**
|
|
45
|
+
* The unique identifier of the dispute alert.
|
|
46
|
+
*/
|
|
47
|
+
id: string;
|
|
48
|
+
/**
|
|
49
|
+
* The type of the dispute alert.
|
|
50
|
+
*/
|
|
51
|
+
alert_type: DisputeAlertType;
|
|
52
|
+
/**
|
|
53
|
+
* The alerted amount in the specified currency.
|
|
54
|
+
*/
|
|
55
|
+
amount: number;
|
|
56
|
+
/**
|
|
57
|
+
* Whether this alert incurs a charge.
|
|
58
|
+
*/
|
|
59
|
+
charge_for_alert: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* The time the dispute alert was created.
|
|
62
|
+
*/
|
|
63
|
+
created_at: string;
|
|
64
|
+
/**
|
|
65
|
+
* The three-letter ISO currency code for the alerted amount.
|
|
66
|
+
*/
|
|
67
|
+
currency: Shared.Currency;
|
|
68
|
+
/**
|
|
69
|
+
* The dispute associated with the dispute alert.
|
|
70
|
+
*/
|
|
71
|
+
dispute: DisputeAlertRetrieveResponse.Dispute | null;
|
|
72
|
+
/**
|
|
73
|
+
* The payment associated with the dispute alert.
|
|
74
|
+
*/
|
|
75
|
+
payment: DisputeAlertRetrieveResponse.Payment | null;
|
|
76
|
+
/**
|
|
77
|
+
* The date of the original transaction.
|
|
78
|
+
*/
|
|
79
|
+
transaction_date: string | null;
|
|
80
|
+
}
|
|
81
|
+
export declare namespace DisputeAlertRetrieveResponse {
|
|
82
|
+
/**
|
|
83
|
+
* The dispute associated with the dispute alert.
|
|
84
|
+
*/
|
|
85
|
+
interface Dispute {
|
|
86
|
+
/**
|
|
87
|
+
* The unique identifier for the dispute.
|
|
88
|
+
*/
|
|
89
|
+
id: string;
|
|
90
|
+
/**
|
|
91
|
+
* The disputed amount in the specified currency, formatted as a decimal.
|
|
92
|
+
*/
|
|
93
|
+
amount: number;
|
|
94
|
+
/**
|
|
95
|
+
* The datetime the dispute was created.
|
|
96
|
+
*/
|
|
97
|
+
created_at: string | null;
|
|
98
|
+
/**
|
|
99
|
+
* The three-letter ISO currency code for the disputed amount.
|
|
100
|
+
*/
|
|
101
|
+
currency: Shared.Currency;
|
|
102
|
+
/**
|
|
103
|
+
* A human-readable reason for the dispute.
|
|
104
|
+
*/
|
|
105
|
+
reason: string | null;
|
|
106
|
+
/**
|
|
107
|
+
* The current status of the dispute lifecycle, such as needs_response,
|
|
108
|
+
* under_review, won, or lost.
|
|
109
|
+
*/
|
|
110
|
+
status: DisputesAPI.DisputeStatuses;
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* The payment associated with the dispute alert.
|
|
114
|
+
*/
|
|
115
|
+
interface Payment {
|
|
116
|
+
/**
|
|
117
|
+
* The unique identifier for the payment.
|
|
118
|
+
*/
|
|
119
|
+
id: string;
|
|
120
|
+
/**
|
|
121
|
+
* The reason why a specific payment was billed
|
|
122
|
+
*/
|
|
123
|
+
billing_reason: PaymentsAPI.BillingReasons | null;
|
|
124
|
+
/**
|
|
125
|
+
* Possible card brands that a payment token can have
|
|
126
|
+
*/
|
|
127
|
+
card_brand: PaymentsAPI.CardBrands | null;
|
|
128
|
+
/**
|
|
129
|
+
* The last four digits of the card used to make this payment. Null if the payment
|
|
130
|
+
* was not made with a card.
|
|
131
|
+
*/
|
|
132
|
+
card_last4: string | null;
|
|
133
|
+
/**
|
|
134
|
+
* The datetime the payment was created.
|
|
135
|
+
*/
|
|
136
|
+
created_at: string;
|
|
137
|
+
/**
|
|
138
|
+
* The available currencies on the platform
|
|
139
|
+
*/
|
|
140
|
+
currency: Shared.Currency | null;
|
|
141
|
+
/**
|
|
142
|
+
* When an alert came in that this transaction will be disputed
|
|
143
|
+
*/
|
|
144
|
+
dispute_alerted_at: string | null;
|
|
145
|
+
/**
|
|
146
|
+
* The member attached to this payment.
|
|
147
|
+
*/
|
|
148
|
+
member: Payment.Member | null;
|
|
149
|
+
/**
|
|
150
|
+
* The membership attached to this payment.
|
|
151
|
+
*/
|
|
152
|
+
membership: Payment.Membership | null;
|
|
153
|
+
/**
|
|
154
|
+
* The time at which this payment was successfully collected. Null if the payment
|
|
155
|
+
* has not yet succeeded. As a Unix timestamp.
|
|
156
|
+
*/
|
|
157
|
+
paid_at: string | null;
|
|
158
|
+
/**
|
|
159
|
+
* The different types of payment methods that can be used.
|
|
160
|
+
*/
|
|
161
|
+
payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
|
|
162
|
+
/**
|
|
163
|
+
* The subtotal to show to the creator (excluding buyer fees).
|
|
164
|
+
*/
|
|
165
|
+
subtotal: number | null;
|
|
166
|
+
/**
|
|
167
|
+
* The total to show to the creator (excluding buyer fees).
|
|
168
|
+
*/
|
|
169
|
+
total: number | null;
|
|
170
|
+
/**
|
|
171
|
+
* The total in USD to show to the creator (excluding buyer fees).
|
|
172
|
+
*/
|
|
173
|
+
usd_total: number | null;
|
|
174
|
+
/**
|
|
175
|
+
* The user that made this payment.
|
|
176
|
+
*/
|
|
177
|
+
user: Payment.User | null;
|
|
178
|
+
}
|
|
179
|
+
namespace Payment {
|
|
180
|
+
/**
|
|
181
|
+
* The member attached to this payment.
|
|
182
|
+
*/
|
|
183
|
+
interface Member {
|
|
184
|
+
/**
|
|
185
|
+
* The unique identifier for the company member.
|
|
186
|
+
*/
|
|
187
|
+
id: string;
|
|
188
|
+
/**
|
|
189
|
+
* The phone number for the member, if available.
|
|
190
|
+
*/
|
|
191
|
+
phone: string | null;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* The membership attached to this payment.
|
|
195
|
+
*/
|
|
196
|
+
interface Membership {
|
|
197
|
+
/**
|
|
198
|
+
* The unique identifier for the membership.
|
|
199
|
+
*/
|
|
200
|
+
id: string;
|
|
201
|
+
/**
|
|
202
|
+
* The state of the membership.
|
|
203
|
+
*/
|
|
204
|
+
status: Shared.MembershipStatus;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* The user that made this payment.
|
|
208
|
+
*/
|
|
209
|
+
interface User {
|
|
210
|
+
/**
|
|
211
|
+
* The unique identifier for the user.
|
|
212
|
+
*/
|
|
213
|
+
id: string;
|
|
214
|
+
/**
|
|
215
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
216
|
+
* Null if not authorized.
|
|
217
|
+
*/
|
|
218
|
+
email: string | null;
|
|
219
|
+
/**
|
|
220
|
+
* The user's display name shown on their public profile.
|
|
221
|
+
*/
|
|
222
|
+
name: string | null;
|
|
223
|
+
/**
|
|
224
|
+
* The user's unique username shown on their public profile.
|
|
225
|
+
*/
|
|
226
|
+
username: string;
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* A dispute alert represents an early warning notification from a payment
|
|
232
|
+
* processor about a potential dispute or chargeback.
|
|
233
|
+
*/
|
|
234
|
+
export interface DisputeAlertListResponse {
|
|
235
|
+
/**
|
|
236
|
+
* The unique identifier of the dispute alert.
|
|
237
|
+
*/
|
|
238
|
+
id: string;
|
|
239
|
+
/**
|
|
240
|
+
* The type of the dispute alert.
|
|
241
|
+
*/
|
|
242
|
+
alert_type: DisputeAlertType;
|
|
243
|
+
/**
|
|
244
|
+
* The alerted amount in the specified currency.
|
|
245
|
+
*/
|
|
246
|
+
amount: number;
|
|
247
|
+
/**
|
|
248
|
+
* Whether this alert incurs a charge.
|
|
249
|
+
*/
|
|
250
|
+
charge_for_alert: boolean;
|
|
251
|
+
/**
|
|
252
|
+
* The time the dispute alert was created.
|
|
253
|
+
*/
|
|
254
|
+
created_at: string;
|
|
255
|
+
/**
|
|
256
|
+
* The three-letter ISO currency code for the alerted amount.
|
|
257
|
+
*/
|
|
258
|
+
currency: Shared.Currency;
|
|
259
|
+
/**
|
|
260
|
+
* The dispute associated with the dispute alert.
|
|
261
|
+
*/
|
|
262
|
+
dispute: DisputeAlertListResponse.Dispute | null;
|
|
263
|
+
/**
|
|
264
|
+
* The payment associated with the dispute alert.
|
|
265
|
+
*/
|
|
266
|
+
payment: DisputeAlertListResponse.Payment | null;
|
|
267
|
+
/**
|
|
268
|
+
* The date of the original transaction.
|
|
269
|
+
*/
|
|
270
|
+
transaction_date: string | null;
|
|
271
|
+
}
|
|
272
|
+
export declare namespace DisputeAlertListResponse {
|
|
273
|
+
/**
|
|
274
|
+
* The dispute associated with the dispute alert.
|
|
275
|
+
*/
|
|
276
|
+
interface Dispute {
|
|
277
|
+
/**
|
|
278
|
+
* The unique identifier for the dispute.
|
|
279
|
+
*/
|
|
280
|
+
id: string;
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* The payment associated with the dispute alert.
|
|
284
|
+
*/
|
|
285
|
+
interface Payment {
|
|
286
|
+
/**
|
|
287
|
+
* The unique identifier for the payment.
|
|
288
|
+
*/
|
|
289
|
+
id: string;
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
export interface DisputeAlertListParams extends CursorPageParams {
|
|
293
|
+
/**
|
|
294
|
+
* The unique identifier of the company to list dispute alerts for.
|
|
295
|
+
*/
|
|
296
|
+
company_id: string;
|
|
297
|
+
/**
|
|
298
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
299
|
+
*/
|
|
300
|
+
before?: string | null;
|
|
301
|
+
/**
|
|
302
|
+
* Only return dispute alerts created after this timestamp.
|
|
303
|
+
*/
|
|
304
|
+
created_after?: string | null;
|
|
305
|
+
/**
|
|
306
|
+
* Only return dispute alerts created before this timestamp.
|
|
307
|
+
*/
|
|
308
|
+
created_before?: string | null;
|
|
309
|
+
/**
|
|
310
|
+
* The direction of the sort.
|
|
311
|
+
*/
|
|
312
|
+
direction?: Shared.Direction | null;
|
|
313
|
+
/**
|
|
314
|
+
* Returns the first _n_ elements from the list.
|
|
315
|
+
*/
|
|
316
|
+
first?: number | null;
|
|
317
|
+
/**
|
|
318
|
+
* Returns the last _n_ elements from the list.
|
|
319
|
+
*/
|
|
320
|
+
last?: number | null;
|
|
321
|
+
}
|
|
322
|
+
export declare namespace DisputeAlerts {
|
|
323
|
+
export { type DisputeAlertType as DisputeAlertType, type DisputeAlertRetrieveResponse as DisputeAlertRetrieveResponse, type DisputeAlertListResponse as DisputeAlertListResponse, type DisputeAlertListResponsesCursorPage as DisputeAlertListResponsesCursorPage, type DisputeAlertListParams as DisputeAlertListParams, };
|
|
324
|
+
}
|
|
325
|
+
//# sourceMappingURL=dispute-alerts.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dispute-alerts.d.mts","sourceRoot":"","sources":["../src/resources/dispute-alerts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIxF;;;;;;;;;OASG;IACH,IAAI,CACF,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;CAM9E;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,aAAa,GAAG,OAAO,CAAC;AAEnE;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,MAAM,EAAE,WAAW,CAAC,eAAe,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,cAAc,EAAE,WAAW,CAAC,cAAc,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC;QAE1C;;;WAGG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,mBAAmB,EAAE,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAE3D;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,OAAO,CAAC;QACvB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC;SACjC;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;;eAGG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -0,0 +1,325 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as DisputesAPI from "./disputes.js";
|
|
3
|
+
import * as PaymentsAPI from "./payments.js";
|
|
4
|
+
import * as Shared from "./shared.js";
|
|
5
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
6
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
|
|
7
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
8
|
+
export declare class DisputeAlerts extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieves the details of an existing dispute alert.
|
|
11
|
+
*
|
|
12
|
+
* Required permissions:
|
|
13
|
+
*
|
|
14
|
+
* - `payment:dispute_alert:read`
|
|
15
|
+
* - `payment:basic:read`
|
|
16
|
+
* - `member:email:read`
|
|
17
|
+
* - `member:basic:read`
|
|
18
|
+
* - `member:phone:read`
|
|
19
|
+
* - `payment:dispute:read`
|
|
20
|
+
*/
|
|
21
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<DisputeAlertRetrieveResponse>;
|
|
22
|
+
/**
|
|
23
|
+
* Returns a paginated list of dispute alerts for a company, with optional
|
|
24
|
+
* filtering by creation date.
|
|
25
|
+
*
|
|
26
|
+
* Required permissions:
|
|
27
|
+
*
|
|
28
|
+
* - `payment:dispute_alert:read`
|
|
29
|
+
* - `payment:basic:read`
|
|
30
|
+
* - `payment:dispute:read`
|
|
31
|
+
*/
|
|
32
|
+
list(query: DisputeAlertListParams, options?: RequestOptions): PagePromise<DisputeAlertListResponsesCursorPage, DisputeAlertListResponse>;
|
|
33
|
+
}
|
|
34
|
+
export type DisputeAlertListResponsesCursorPage = CursorPage<DisputeAlertListResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* The type of dispute alert.
|
|
37
|
+
*/
|
|
38
|
+
export type DisputeAlertType = 'dispute' | 'dispute_rdr' | 'fraud';
|
|
39
|
+
/**
|
|
40
|
+
* A dispute alert represents an early warning notification from a payment
|
|
41
|
+
* processor about a potential dispute or chargeback.
|
|
42
|
+
*/
|
|
43
|
+
export interface DisputeAlertRetrieveResponse {
|
|
44
|
+
/**
|
|
45
|
+
* The unique identifier of the dispute alert.
|
|
46
|
+
*/
|
|
47
|
+
id: string;
|
|
48
|
+
/**
|
|
49
|
+
* The type of the dispute alert.
|
|
50
|
+
*/
|
|
51
|
+
alert_type: DisputeAlertType;
|
|
52
|
+
/**
|
|
53
|
+
* The alerted amount in the specified currency.
|
|
54
|
+
*/
|
|
55
|
+
amount: number;
|
|
56
|
+
/**
|
|
57
|
+
* Whether this alert incurs a charge.
|
|
58
|
+
*/
|
|
59
|
+
charge_for_alert: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* The time the dispute alert was created.
|
|
62
|
+
*/
|
|
63
|
+
created_at: string;
|
|
64
|
+
/**
|
|
65
|
+
* The three-letter ISO currency code for the alerted amount.
|
|
66
|
+
*/
|
|
67
|
+
currency: Shared.Currency;
|
|
68
|
+
/**
|
|
69
|
+
* The dispute associated with the dispute alert.
|
|
70
|
+
*/
|
|
71
|
+
dispute: DisputeAlertRetrieveResponse.Dispute | null;
|
|
72
|
+
/**
|
|
73
|
+
* The payment associated with the dispute alert.
|
|
74
|
+
*/
|
|
75
|
+
payment: DisputeAlertRetrieveResponse.Payment | null;
|
|
76
|
+
/**
|
|
77
|
+
* The date of the original transaction.
|
|
78
|
+
*/
|
|
79
|
+
transaction_date: string | null;
|
|
80
|
+
}
|
|
81
|
+
export declare namespace DisputeAlertRetrieveResponse {
|
|
82
|
+
/**
|
|
83
|
+
* The dispute associated with the dispute alert.
|
|
84
|
+
*/
|
|
85
|
+
interface Dispute {
|
|
86
|
+
/**
|
|
87
|
+
* The unique identifier for the dispute.
|
|
88
|
+
*/
|
|
89
|
+
id: string;
|
|
90
|
+
/**
|
|
91
|
+
* The disputed amount in the specified currency, formatted as a decimal.
|
|
92
|
+
*/
|
|
93
|
+
amount: number;
|
|
94
|
+
/**
|
|
95
|
+
* The datetime the dispute was created.
|
|
96
|
+
*/
|
|
97
|
+
created_at: string | null;
|
|
98
|
+
/**
|
|
99
|
+
* The three-letter ISO currency code for the disputed amount.
|
|
100
|
+
*/
|
|
101
|
+
currency: Shared.Currency;
|
|
102
|
+
/**
|
|
103
|
+
* A human-readable reason for the dispute.
|
|
104
|
+
*/
|
|
105
|
+
reason: string | null;
|
|
106
|
+
/**
|
|
107
|
+
* The current status of the dispute lifecycle, such as needs_response,
|
|
108
|
+
* under_review, won, or lost.
|
|
109
|
+
*/
|
|
110
|
+
status: DisputesAPI.DisputeStatuses;
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* The payment associated with the dispute alert.
|
|
114
|
+
*/
|
|
115
|
+
interface Payment {
|
|
116
|
+
/**
|
|
117
|
+
* The unique identifier for the payment.
|
|
118
|
+
*/
|
|
119
|
+
id: string;
|
|
120
|
+
/**
|
|
121
|
+
* The reason why a specific payment was billed
|
|
122
|
+
*/
|
|
123
|
+
billing_reason: PaymentsAPI.BillingReasons | null;
|
|
124
|
+
/**
|
|
125
|
+
* Possible card brands that a payment token can have
|
|
126
|
+
*/
|
|
127
|
+
card_brand: PaymentsAPI.CardBrands | null;
|
|
128
|
+
/**
|
|
129
|
+
* The last four digits of the card used to make this payment. Null if the payment
|
|
130
|
+
* was not made with a card.
|
|
131
|
+
*/
|
|
132
|
+
card_last4: string | null;
|
|
133
|
+
/**
|
|
134
|
+
* The datetime the payment was created.
|
|
135
|
+
*/
|
|
136
|
+
created_at: string;
|
|
137
|
+
/**
|
|
138
|
+
* The available currencies on the platform
|
|
139
|
+
*/
|
|
140
|
+
currency: Shared.Currency | null;
|
|
141
|
+
/**
|
|
142
|
+
* When an alert came in that this transaction will be disputed
|
|
143
|
+
*/
|
|
144
|
+
dispute_alerted_at: string | null;
|
|
145
|
+
/**
|
|
146
|
+
* The member attached to this payment.
|
|
147
|
+
*/
|
|
148
|
+
member: Payment.Member | null;
|
|
149
|
+
/**
|
|
150
|
+
* The membership attached to this payment.
|
|
151
|
+
*/
|
|
152
|
+
membership: Payment.Membership | null;
|
|
153
|
+
/**
|
|
154
|
+
* The time at which this payment was successfully collected. Null if the payment
|
|
155
|
+
* has not yet succeeded. As a Unix timestamp.
|
|
156
|
+
*/
|
|
157
|
+
paid_at: string | null;
|
|
158
|
+
/**
|
|
159
|
+
* The different types of payment methods that can be used.
|
|
160
|
+
*/
|
|
161
|
+
payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
|
|
162
|
+
/**
|
|
163
|
+
* The subtotal to show to the creator (excluding buyer fees).
|
|
164
|
+
*/
|
|
165
|
+
subtotal: number | null;
|
|
166
|
+
/**
|
|
167
|
+
* The total to show to the creator (excluding buyer fees).
|
|
168
|
+
*/
|
|
169
|
+
total: number | null;
|
|
170
|
+
/**
|
|
171
|
+
* The total in USD to show to the creator (excluding buyer fees).
|
|
172
|
+
*/
|
|
173
|
+
usd_total: number | null;
|
|
174
|
+
/**
|
|
175
|
+
* The user that made this payment.
|
|
176
|
+
*/
|
|
177
|
+
user: Payment.User | null;
|
|
178
|
+
}
|
|
179
|
+
namespace Payment {
|
|
180
|
+
/**
|
|
181
|
+
* The member attached to this payment.
|
|
182
|
+
*/
|
|
183
|
+
interface Member {
|
|
184
|
+
/**
|
|
185
|
+
* The unique identifier for the company member.
|
|
186
|
+
*/
|
|
187
|
+
id: string;
|
|
188
|
+
/**
|
|
189
|
+
* The phone number for the member, if available.
|
|
190
|
+
*/
|
|
191
|
+
phone: string | null;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* The membership attached to this payment.
|
|
195
|
+
*/
|
|
196
|
+
interface Membership {
|
|
197
|
+
/**
|
|
198
|
+
* The unique identifier for the membership.
|
|
199
|
+
*/
|
|
200
|
+
id: string;
|
|
201
|
+
/**
|
|
202
|
+
* The state of the membership.
|
|
203
|
+
*/
|
|
204
|
+
status: Shared.MembershipStatus;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* The user that made this payment.
|
|
208
|
+
*/
|
|
209
|
+
interface User {
|
|
210
|
+
/**
|
|
211
|
+
* The unique identifier for the user.
|
|
212
|
+
*/
|
|
213
|
+
id: string;
|
|
214
|
+
/**
|
|
215
|
+
* The user's email address. Requires the member:email:read permission to access.
|
|
216
|
+
* Null if not authorized.
|
|
217
|
+
*/
|
|
218
|
+
email: string | null;
|
|
219
|
+
/**
|
|
220
|
+
* The user's display name shown on their public profile.
|
|
221
|
+
*/
|
|
222
|
+
name: string | null;
|
|
223
|
+
/**
|
|
224
|
+
* The user's unique username shown on their public profile.
|
|
225
|
+
*/
|
|
226
|
+
username: string;
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* A dispute alert represents an early warning notification from a payment
|
|
232
|
+
* processor about a potential dispute or chargeback.
|
|
233
|
+
*/
|
|
234
|
+
export interface DisputeAlertListResponse {
|
|
235
|
+
/**
|
|
236
|
+
* The unique identifier of the dispute alert.
|
|
237
|
+
*/
|
|
238
|
+
id: string;
|
|
239
|
+
/**
|
|
240
|
+
* The type of the dispute alert.
|
|
241
|
+
*/
|
|
242
|
+
alert_type: DisputeAlertType;
|
|
243
|
+
/**
|
|
244
|
+
* The alerted amount in the specified currency.
|
|
245
|
+
*/
|
|
246
|
+
amount: number;
|
|
247
|
+
/**
|
|
248
|
+
* Whether this alert incurs a charge.
|
|
249
|
+
*/
|
|
250
|
+
charge_for_alert: boolean;
|
|
251
|
+
/**
|
|
252
|
+
* The time the dispute alert was created.
|
|
253
|
+
*/
|
|
254
|
+
created_at: string;
|
|
255
|
+
/**
|
|
256
|
+
* The three-letter ISO currency code for the alerted amount.
|
|
257
|
+
*/
|
|
258
|
+
currency: Shared.Currency;
|
|
259
|
+
/**
|
|
260
|
+
* The dispute associated with the dispute alert.
|
|
261
|
+
*/
|
|
262
|
+
dispute: DisputeAlertListResponse.Dispute | null;
|
|
263
|
+
/**
|
|
264
|
+
* The payment associated with the dispute alert.
|
|
265
|
+
*/
|
|
266
|
+
payment: DisputeAlertListResponse.Payment | null;
|
|
267
|
+
/**
|
|
268
|
+
* The date of the original transaction.
|
|
269
|
+
*/
|
|
270
|
+
transaction_date: string | null;
|
|
271
|
+
}
|
|
272
|
+
export declare namespace DisputeAlertListResponse {
|
|
273
|
+
/**
|
|
274
|
+
* The dispute associated with the dispute alert.
|
|
275
|
+
*/
|
|
276
|
+
interface Dispute {
|
|
277
|
+
/**
|
|
278
|
+
* The unique identifier for the dispute.
|
|
279
|
+
*/
|
|
280
|
+
id: string;
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* The payment associated with the dispute alert.
|
|
284
|
+
*/
|
|
285
|
+
interface Payment {
|
|
286
|
+
/**
|
|
287
|
+
* The unique identifier for the payment.
|
|
288
|
+
*/
|
|
289
|
+
id: string;
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
export interface DisputeAlertListParams extends CursorPageParams {
|
|
293
|
+
/**
|
|
294
|
+
* The unique identifier of the company to list dispute alerts for.
|
|
295
|
+
*/
|
|
296
|
+
company_id: string;
|
|
297
|
+
/**
|
|
298
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
299
|
+
*/
|
|
300
|
+
before?: string | null;
|
|
301
|
+
/**
|
|
302
|
+
* Only return dispute alerts created after this timestamp.
|
|
303
|
+
*/
|
|
304
|
+
created_after?: string | null;
|
|
305
|
+
/**
|
|
306
|
+
* Only return dispute alerts created before this timestamp.
|
|
307
|
+
*/
|
|
308
|
+
created_before?: string | null;
|
|
309
|
+
/**
|
|
310
|
+
* The direction of the sort.
|
|
311
|
+
*/
|
|
312
|
+
direction?: Shared.Direction | null;
|
|
313
|
+
/**
|
|
314
|
+
* Returns the first _n_ elements from the list.
|
|
315
|
+
*/
|
|
316
|
+
first?: number | null;
|
|
317
|
+
/**
|
|
318
|
+
* Returns the last _n_ elements from the list.
|
|
319
|
+
*/
|
|
320
|
+
last?: number | null;
|
|
321
|
+
}
|
|
322
|
+
export declare namespace DisputeAlerts {
|
|
323
|
+
export { type DisputeAlertType as DisputeAlertType, type DisputeAlertRetrieveResponse as DisputeAlertRetrieveResponse, type DisputeAlertListResponse as DisputeAlertListResponse, type DisputeAlertListResponsesCursorPage as DisputeAlertListResponsesCursorPage, type DisputeAlertListParams as DisputeAlertListParams, };
|
|
324
|
+
}
|
|
325
|
+
//# sourceMappingURL=dispute-alerts.d.ts.map
|