@getivy/node-sdk 1.0.0 → 1.2.0
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 +21 -0
- package/index.d.mts +6 -6
- package/index.d.ts +6 -6
- package/index.d.ts.map +1 -1
- package/index.js +6 -6
- package/index.js.map +1 -1
- package/index.mjs +6 -6
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/data/accounts.d.ts +83 -0
- package/resources/data/accounts.d.ts.map +1 -0
- package/resources/data/accounts.js +15 -0
- package/resources/data/accounts.js.map +1 -0
- package/resources/data/accounts.mjs +11 -0
- package/resources/data/accounts.mjs.map +1 -0
- package/resources/data/balances.d.ts +48 -0
- package/resources/data/balances.d.ts.map +1 -0
- package/resources/data/balances.js +15 -0
- package/resources/data/balances.js.map +1 -0
- package/resources/data/balances.mjs +11 -0
- package/resources/data/balances.mjs.map +1 -0
- package/resources/data/consent.d.ts +80 -0
- package/resources/data/consent.d.ts.map +1 -0
- package/resources/data/consent.js +21 -0
- package/resources/data/consent.js.map +1 -0
- package/resources/data/consent.mjs +17 -0
- package/resources/data/consent.mjs.map +1 -0
- package/resources/data/data.d.ts +26 -0
- package/resources/data/data.d.ts.map +1 -0
- package/resources/data/data.js +55 -0
- package/resources/data/data.js.map +1 -0
- package/resources/data/data.mjs +28 -0
- package/resources/data/data.mjs.map +1 -0
- package/resources/data/index.d.ts +7 -0
- package/resources/data/index.d.ts.map +1 -0
- package/resources/data/index.js +17 -0
- package/resources/data/index.js.map +1 -0
- package/resources/data/index.mjs +8 -0
- package/resources/data/index.mjs.map +1 -0
- package/resources/data/session.d.ts +258 -0
- package/resources/data/session.d.ts.map +1 -0
- package/resources/data/session.js +21 -0
- package/resources/data/session.js.map +1 -0
- package/resources/data/session.mjs +17 -0
- package/resources/data/session.mjs.map +1 -0
- package/resources/data/transactions.d.ts +175 -0
- package/resources/data/transactions.d.ts.map +1 -0
- package/resources/data/transactions.js +16 -0
- package/resources/data/transactions.js.map +1 -0
- package/resources/data/transactions.mjs +12 -0
- package/resources/data/transactions.mjs.map +1 -0
- package/resources/data.d.ts +2 -0
- package/resources/data.d.ts.map +1 -0
- package/resources/data.js +19 -0
- package/resources/data.js.map +1 -0
- package/resources/data.mjs +3 -0
- package/resources/data.mjs.map +1 -0
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -5
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -2
- package/resources/index.mjs.map +1 -1
- package/resources/webhook/index.d.ts +3 -0
- package/resources/webhook/index.d.ts.map +1 -0
- package/resources/webhook/index.js +9 -0
- package/resources/webhook/index.js.map +1 -0
- package/resources/webhook/index.mjs +4 -0
- package/resources/webhook/index.mjs.map +1 -0
- package/resources/webhook/subscription.d.ts +152 -0
- package/resources/webhook/subscription.d.ts.map +1 -0
- package/resources/webhook/subscription.js +42 -0
- package/resources/webhook/subscription.js.map +1 -0
- package/resources/webhook/subscription.mjs +38 -0
- package/resources/webhook/subscription.mjs.map +1 -0
- package/resources/webhook/webhook.d.ts +28 -0
- package/resources/webhook/webhook.d.ts.map +1 -0
- package/resources/webhook/webhook.js +45 -0
- package/resources/webhook/webhook.js.map +1 -0
- package/resources/webhook/webhook.mjs +18 -0
- package/resources/webhook/webhook.mjs.map +1 -0
- package/resources/webhook.d.ts +2 -0
- package/resources/webhook.d.ts.map +1 -0
- package/resources/webhook.js +19 -0
- package/resources/webhook.js.map +1 -0
- package/resources/webhook.mjs +3 -0
- package/resources/webhook.mjs.map +1 -0
- package/src/index.ts +14 -26
- package/src/resources/data/accounts.ts +113 -0
- package/src/resources/data/balances.ts +60 -0
- package/src/resources/data/consent.ts +110 -0
- package/src/resources/data/data.ts +75 -0
- package/src/resources/data/index.ts +20 -0
- package/src/resources/data/session.ts +1317 -0
- package/src/resources/data/transactions.ts +235 -0
- package/src/resources/data.ts +3 -0
- package/src/resources/index.ts +2 -10
- package/src/resources/webhook/index.ts +16 -0
- package/src/resources/webhook/subscription.ts +405 -0
- package/src/resources/webhook/webhook.ts +69 -0
- package/src/resources/webhook.ts +3 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/charges.d.ts +0 -82
- package/resources/charges.d.ts.map +0 -1
- package/resources/charges.js +0 -15
- package/resources/charges.js.map +0 -1
- package/resources/charges.mjs +0 -11
- package/resources/charges.mjs.map +0 -1
- package/resources/mandates.d.ts +0 -129
- package/resources/mandates.d.ts.map +0 -1
- package/resources/mandates.js +0 -27
- package/resources/mandates.js.map +0 -1
- package/resources/mandates.mjs +0 -23
- package/resources/mandates.mjs.map +0 -1
- package/src/resources/charges.ts +0 -104
- package/src/resources/mandates.ts +0 -197
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../resource';
|
|
4
|
+
import * as Core from '../../core';
|
|
5
|
+
|
|
6
|
+
export class Transactions extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves the list of transactions for a given data session. Returns
|
|
9
|
+
* transactions from the last 3 months.
|
|
10
|
+
*/
|
|
11
|
+
list(body: TransactionListParams, options?: Core.RequestOptions): Core.APIPromise<TransactionListResponse> {
|
|
12
|
+
return this._client.post('/api/service/data/transactions/list', { body, ...options });
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export interface TransactionListResponse {
|
|
17
|
+
/**
|
|
18
|
+
* Array of transactions
|
|
19
|
+
*/
|
|
20
|
+
data: Array<TransactionListResponse.Data>;
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Pagination information
|
|
24
|
+
*/
|
|
25
|
+
paging: TransactionListResponse.Paging;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export namespace TransactionListResponse {
|
|
29
|
+
export interface Data {
|
|
30
|
+
/**
|
|
31
|
+
* Transaction identifier
|
|
32
|
+
*/
|
|
33
|
+
id: string;
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Amount of the transaction
|
|
37
|
+
*/
|
|
38
|
+
amount: string;
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Balance information
|
|
42
|
+
*/
|
|
43
|
+
balance: Data.Balance;
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Bank statement reference
|
|
47
|
+
*/
|
|
48
|
+
bankStatementReference: string;
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Creditor account details
|
|
52
|
+
*/
|
|
53
|
+
creditor: Data.Creditor;
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* ISO 4217 currency code
|
|
57
|
+
*/
|
|
58
|
+
currency: string;
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Debtor account details
|
|
62
|
+
*/
|
|
63
|
+
debtor: Data.Debtor;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Side of the transaction
|
|
67
|
+
*/
|
|
68
|
+
side: 'credit' | 'debit';
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Transaction date as unix timestamp
|
|
72
|
+
*/
|
|
73
|
+
transactionDate: number;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export namespace Data {
|
|
77
|
+
/**
|
|
78
|
+
* Balance information
|
|
79
|
+
*/
|
|
80
|
+
export interface Balance {
|
|
81
|
+
/**
|
|
82
|
+
* Balance after the transaction
|
|
83
|
+
*/
|
|
84
|
+
after: string;
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Balance before the transaction
|
|
88
|
+
*/
|
|
89
|
+
before: string;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Creditor account details
|
|
94
|
+
*/
|
|
95
|
+
export interface Creditor {
|
|
96
|
+
/**
|
|
97
|
+
* Type of financial address
|
|
98
|
+
*/
|
|
99
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
100
|
+
|
|
101
|
+
bankCode?: Creditor.BankCode;
|
|
102
|
+
|
|
103
|
+
bban?: Creditor.Bban;
|
|
104
|
+
|
|
105
|
+
iban?: Creditor.Iban;
|
|
106
|
+
|
|
107
|
+
sortCode?: Creditor.SortCode;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
export namespace Creditor {
|
|
111
|
+
export interface BankCode {
|
|
112
|
+
accountHolderName: string;
|
|
113
|
+
|
|
114
|
+
accountNumber: string;
|
|
115
|
+
|
|
116
|
+
code: string;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
export interface Bban {
|
|
120
|
+
accountHolderName: string;
|
|
121
|
+
|
|
122
|
+
bban: string;
|
|
123
|
+
|
|
124
|
+
bic?: string;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
export interface Iban {
|
|
128
|
+
accountHolderName: string;
|
|
129
|
+
|
|
130
|
+
iban: string;
|
|
131
|
+
|
|
132
|
+
bic?: string;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
export interface SortCode {
|
|
136
|
+
accountHolderName: string;
|
|
137
|
+
|
|
138
|
+
accountNumber: string;
|
|
139
|
+
|
|
140
|
+
sortCode: string;
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Debtor account details
|
|
146
|
+
*/
|
|
147
|
+
export interface Debtor {
|
|
148
|
+
/**
|
|
149
|
+
* Type of financial address
|
|
150
|
+
*/
|
|
151
|
+
type: 'iban' | 'sort_code' | 'bank_code' | 'bban';
|
|
152
|
+
|
|
153
|
+
bankCode?: Debtor.BankCode;
|
|
154
|
+
|
|
155
|
+
bban?: Debtor.Bban;
|
|
156
|
+
|
|
157
|
+
iban?: Debtor.Iban;
|
|
158
|
+
|
|
159
|
+
sortCode?: Debtor.SortCode;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
export namespace Debtor {
|
|
163
|
+
export interface BankCode {
|
|
164
|
+
accountHolderName: string;
|
|
165
|
+
|
|
166
|
+
accountNumber: string;
|
|
167
|
+
|
|
168
|
+
code: string;
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
export interface Bban {
|
|
172
|
+
accountHolderName: string;
|
|
173
|
+
|
|
174
|
+
bban: string;
|
|
175
|
+
|
|
176
|
+
bic?: string;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
export interface Iban {
|
|
180
|
+
accountHolderName: string;
|
|
181
|
+
|
|
182
|
+
iban: string;
|
|
183
|
+
|
|
184
|
+
bic?: string;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
export interface SortCode {
|
|
188
|
+
accountHolderName: string;
|
|
189
|
+
|
|
190
|
+
accountNumber: string;
|
|
191
|
+
|
|
192
|
+
sortCode: string;
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Pagination information
|
|
199
|
+
*/
|
|
200
|
+
export interface Paging {
|
|
201
|
+
/**
|
|
202
|
+
* Whether there are more transactions available
|
|
203
|
+
*/
|
|
204
|
+
hasNext: boolean;
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* Cursor for the next page of results
|
|
208
|
+
*/
|
|
209
|
+
nextCursor?: string;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
export interface TransactionListParams {
|
|
214
|
+
/**
|
|
215
|
+
* Start timestamp (inclusive) - unix timestamp
|
|
216
|
+
*/
|
|
217
|
+
from: number;
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* End timestamp (exclusive) - unix timestamp
|
|
221
|
+
*/
|
|
222
|
+
to: number;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Cursor for pagination
|
|
226
|
+
*/
|
|
227
|
+
afterCursor?: string;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
export declare namespace Transactions {
|
|
231
|
+
export {
|
|
232
|
+
type TransactionListResponse as TransactionListResponse,
|
|
233
|
+
type TransactionListParams as TransactionListParams,
|
|
234
|
+
};
|
|
235
|
+
}
|
package/src/resources/index.ts
CHANGED
|
@@ -12,7 +12,6 @@ export {
|
|
|
12
12
|
} from './banks';
|
|
13
13
|
export { BeneficiaryPayouts, type BeneficiaryPayoutCreateResponse } from './beneficiary-payouts';
|
|
14
14
|
export { Capabilities, type CapabilityRetrieveResponse, type CapabilityRetrieveParams } from './capabilities';
|
|
15
|
-
export { Charges, type Charge, type ChargeCreateParams } from './charges';
|
|
16
15
|
export {
|
|
17
16
|
Checkoutsession,
|
|
18
17
|
type CheckoutsessionCreateResponse,
|
|
@@ -31,6 +30,7 @@ export {
|
|
|
31
30
|
type CustomerRetrieveParams,
|
|
32
31
|
type CustomerSearchParams,
|
|
33
32
|
} from './customers';
|
|
33
|
+
export { Data } from './data/data';
|
|
34
34
|
export { Deposits, type DepositRetrieveResponse, type DepositRetrieveParams } from './deposits';
|
|
35
35
|
export {
|
|
36
36
|
Fx,
|
|
@@ -39,15 +39,6 @@ export {
|
|
|
39
39
|
type FxRetrieveParams,
|
|
40
40
|
type FxRetrieveRateParams,
|
|
41
41
|
} from './fx';
|
|
42
|
-
export {
|
|
43
|
-
Mandates,
|
|
44
|
-
type Mandate,
|
|
45
|
-
type MandateLookupResponse,
|
|
46
|
-
type MandateRevokeResponse,
|
|
47
|
-
type MandateRetrieveParams,
|
|
48
|
-
type MandateLookupParams,
|
|
49
|
-
type MandateRevokeParams,
|
|
50
|
-
} from './mandates';
|
|
51
42
|
export {
|
|
52
43
|
Orders,
|
|
53
44
|
type OrderCreateResponse,
|
|
@@ -89,3 +80,4 @@ export {
|
|
|
89
80
|
type SubaccountRetrieveParams,
|
|
90
81
|
} from './subaccounts';
|
|
91
82
|
export { Transactions, type TransactionListResponse, type TransactionListParams } from './transactions';
|
|
83
|
+
export { Webhook, type WebhookTriggerResponse, type WebhookTriggerParams } from './webhook/webhook';
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
export {
|
|
4
|
+
Subscription,
|
|
5
|
+
type SubscriptionCreateResponse,
|
|
6
|
+
type SubscriptionUpdateResponse,
|
|
7
|
+
type SubscriptionListResponse,
|
|
8
|
+
type SubscriptionDeleteResponse,
|
|
9
|
+
type SubscriptionPingResponse,
|
|
10
|
+
type SubscriptionCreateParams,
|
|
11
|
+
type SubscriptionUpdateParams,
|
|
12
|
+
type SubscriptionListParams,
|
|
13
|
+
type SubscriptionDeleteParams,
|
|
14
|
+
type SubscriptionPingParams,
|
|
15
|
+
} from './subscription';
|
|
16
|
+
export { Webhook, type WebhookTriggerResponse, type WebhookTriggerParams } from './webhook';
|
|
@@ -0,0 +1,405 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../resource';
|
|
4
|
+
import * as Core from '../../core';
|
|
5
|
+
|
|
6
|
+
export class Subscription extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Creates a webhook subscription that sends various events from Ivy to a specified
|
|
9
|
+
* url. There can be multiple subscriptions per app.
|
|
10
|
+
*/
|
|
11
|
+
create(
|
|
12
|
+
body: SubscriptionCreateParams,
|
|
13
|
+
options?: Core.RequestOptions,
|
|
14
|
+
): Core.APIPromise<SubscriptionCreateResponse> {
|
|
15
|
+
return this._client.post('/api/service/webhook-subscription/create', { body, ...options });
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Updates the url or subcribed to events for a webhook subscription. This can be
|
|
20
|
+
* used via the app or via the API by providing an API key.
|
|
21
|
+
*/
|
|
22
|
+
update(
|
|
23
|
+
body: SubscriptionUpdateParams,
|
|
24
|
+
options?: Core.RequestOptions,
|
|
25
|
+
): Core.APIPromise<SubscriptionUpdateResponse> {
|
|
26
|
+
return this._client.post('/api/service/webhook-subscription/update', { body, ...options });
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Lists all webhook subscriptions that are registered for the merchant. The
|
|
31
|
+
* results are paginated and provided in chronological order.
|
|
32
|
+
*/
|
|
33
|
+
list(
|
|
34
|
+
body: SubscriptionListParams,
|
|
35
|
+
options?: Core.RequestOptions,
|
|
36
|
+
): Core.APIPromise<SubscriptionListResponse> {
|
|
37
|
+
return this._client.post('/api/service/webhook-subscription/list', { body, ...options });
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Deletes a webhook subscription.
|
|
42
|
+
*/
|
|
43
|
+
delete(
|
|
44
|
+
body: SubscriptionDeleteParams,
|
|
45
|
+
options?: Core.RequestOptions,
|
|
46
|
+
): Core.APIPromise<SubscriptionDeleteResponse> {
|
|
47
|
+
return this._client.post('/api/service/webhook-subscription/delete', { body, ...options });
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Sends a test ping to verify webhook subscription endpoint connectivity.
|
|
52
|
+
*/
|
|
53
|
+
ping(
|
|
54
|
+
body: SubscriptionPingParams,
|
|
55
|
+
options?: Core.RequestOptions,
|
|
56
|
+
): Core.APIPromise<SubscriptionPingResponse> {
|
|
57
|
+
return this._client.post('/api/service/webhook-subscription/ping', { body, ...options });
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export interface SubscriptionCreateResponse {
|
|
62
|
+
id: unknown;
|
|
63
|
+
|
|
64
|
+
createdAt: unknown;
|
|
65
|
+
|
|
66
|
+
events: Array<
|
|
67
|
+
| 'test'
|
|
68
|
+
| 'merchant_updated'
|
|
69
|
+
| 'merchant_app_updated'
|
|
70
|
+
| 'order_created'
|
|
71
|
+
| 'order_updated'
|
|
72
|
+
| 'refund_succeeded'
|
|
73
|
+
| 'refund_failed'
|
|
74
|
+
| 'refund.initiated'
|
|
75
|
+
| 'refund.succeeded'
|
|
76
|
+
| 'refund.failed'
|
|
77
|
+
| 'payout_report_requested'
|
|
78
|
+
| 'data_session_completed'
|
|
79
|
+
| 'checkout_session_created'
|
|
80
|
+
| 'checkout_session_updated'
|
|
81
|
+
| 'checkout_session_expired'
|
|
82
|
+
| 'checkout_session_completed'
|
|
83
|
+
| 'payout_created'
|
|
84
|
+
| 'payout_updated'
|
|
85
|
+
| 'mandate_setup_started'
|
|
86
|
+
| 'mandate_setup_succeeded'
|
|
87
|
+
| 'mandate_setup_failed'
|
|
88
|
+
| 'mandate_revoked'
|
|
89
|
+
| 'user_payout.initiated'
|
|
90
|
+
| 'user_payout.failed'
|
|
91
|
+
| 'user_payout.paid'
|
|
92
|
+
| 'payout.initiated'
|
|
93
|
+
| 'payout.failed'
|
|
94
|
+
| 'payout.paid'
|
|
95
|
+
| 'deposit.received'
|
|
96
|
+
| 'return.initiated'
|
|
97
|
+
| 'return.succeeded'
|
|
98
|
+
| 'return.failed'
|
|
99
|
+
| 'return.returned'
|
|
100
|
+
>;
|
|
101
|
+
|
|
102
|
+
merchant: unknown;
|
|
103
|
+
|
|
104
|
+
merchantApp: unknown;
|
|
105
|
+
|
|
106
|
+
updatedAt: unknown;
|
|
107
|
+
|
|
108
|
+
url: string;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export interface SubscriptionUpdateResponse {
|
|
112
|
+
id: unknown;
|
|
113
|
+
|
|
114
|
+
createdAt: unknown;
|
|
115
|
+
|
|
116
|
+
events: Array<
|
|
117
|
+
| 'test'
|
|
118
|
+
| 'merchant_updated'
|
|
119
|
+
| 'merchant_app_updated'
|
|
120
|
+
| 'order_created'
|
|
121
|
+
| 'order_updated'
|
|
122
|
+
| 'refund_succeeded'
|
|
123
|
+
| 'refund_failed'
|
|
124
|
+
| 'refund.initiated'
|
|
125
|
+
| 'refund.succeeded'
|
|
126
|
+
| 'refund.failed'
|
|
127
|
+
| 'payout_report_requested'
|
|
128
|
+
| 'data_session_completed'
|
|
129
|
+
| 'checkout_session_created'
|
|
130
|
+
| 'checkout_session_updated'
|
|
131
|
+
| 'checkout_session_expired'
|
|
132
|
+
| 'checkout_session_completed'
|
|
133
|
+
| 'payout_created'
|
|
134
|
+
| 'payout_updated'
|
|
135
|
+
| 'mandate_setup_started'
|
|
136
|
+
| 'mandate_setup_succeeded'
|
|
137
|
+
| 'mandate_setup_failed'
|
|
138
|
+
| 'mandate_revoked'
|
|
139
|
+
| 'user_payout.initiated'
|
|
140
|
+
| 'user_payout.failed'
|
|
141
|
+
| 'user_payout.paid'
|
|
142
|
+
| 'payout.initiated'
|
|
143
|
+
| 'payout.failed'
|
|
144
|
+
| 'payout.paid'
|
|
145
|
+
| 'deposit.received'
|
|
146
|
+
| 'return.initiated'
|
|
147
|
+
| 'return.succeeded'
|
|
148
|
+
| 'return.failed'
|
|
149
|
+
| 'return.returned'
|
|
150
|
+
>;
|
|
151
|
+
|
|
152
|
+
merchant: unknown;
|
|
153
|
+
|
|
154
|
+
merchantApp: unknown;
|
|
155
|
+
|
|
156
|
+
updatedAt: unknown;
|
|
157
|
+
|
|
158
|
+
url: string;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
export interface SubscriptionListResponse {
|
|
162
|
+
/**
|
|
163
|
+
* The total number of webhook subscriptions
|
|
164
|
+
*/
|
|
165
|
+
count: number;
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* Whether there are more webhook subscriptions to retrieve
|
|
169
|
+
*/
|
|
170
|
+
hasNext: boolean;
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Array of webhook subscription objects
|
|
174
|
+
*/
|
|
175
|
+
items: Array<SubscriptionListResponse.Item>;
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* The number of webhook subscriptions skipped
|
|
179
|
+
*/
|
|
180
|
+
skip: number;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
export namespace SubscriptionListResponse {
|
|
184
|
+
export interface Item {
|
|
185
|
+
id: unknown;
|
|
186
|
+
|
|
187
|
+
createdAt: unknown;
|
|
188
|
+
|
|
189
|
+
events: Array<
|
|
190
|
+
| 'test'
|
|
191
|
+
| 'merchant_updated'
|
|
192
|
+
| 'merchant_app_updated'
|
|
193
|
+
| 'order_created'
|
|
194
|
+
| 'order_updated'
|
|
195
|
+
| 'refund_succeeded'
|
|
196
|
+
| 'refund_failed'
|
|
197
|
+
| 'refund.initiated'
|
|
198
|
+
| 'refund.succeeded'
|
|
199
|
+
| 'refund.failed'
|
|
200
|
+
| 'payout_report_requested'
|
|
201
|
+
| 'data_session_completed'
|
|
202
|
+
| 'checkout_session_created'
|
|
203
|
+
| 'checkout_session_updated'
|
|
204
|
+
| 'checkout_session_expired'
|
|
205
|
+
| 'checkout_session_completed'
|
|
206
|
+
| 'payout_created'
|
|
207
|
+
| 'payout_updated'
|
|
208
|
+
| 'mandate_setup_started'
|
|
209
|
+
| 'mandate_setup_succeeded'
|
|
210
|
+
| 'mandate_setup_failed'
|
|
211
|
+
| 'mandate_revoked'
|
|
212
|
+
| 'user_payout.initiated'
|
|
213
|
+
| 'user_payout.failed'
|
|
214
|
+
| 'user_payout.paid'
|
|
215
|
+
| 'payout.initiated'
|
|
216
|
+
| 'payout.failed'
|
|
217
|
+
| 'payout.paid'
|
|
218
|
+
| 'deposit.received'
|
|
219
|
+
| 'return.initiated'
|
|
220
|
+
| 'return.succeeded'
|
|
221
|
+
| 'return.failed'
|
|
222
|
+
| 'return.returned'
|
|
223
|
+
>;
|
|
224
|
+
|
|
225
|
+
merchant: unknown;
|
|
226
|
+
|
|
227
|
+
merchantApp: unknown;
|
|
228
|
+
|
|
229
|
+
updatedAt: unknown;
|
|
230
|
+
|
|
231
|
+
url: string;
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
export interface SubscriptionDeleteResponse {
|
|
236
|
+
/**
|
|
237
|
+
* Whether the webhook subscription was successfully deleted
|
|
238
|
+
*/
|
|
239
|
+
success: boolean;
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
export interface SubscriptionPingResponse {
|
|
243
|
+
/**
|
|
244
|
+
* The unique identifier of the webhook subscription
|
|
245
|
+
*/
|
|
246
|
+
id: unknown;
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* The timestamp when the ping was executed
|
|
250
|
+
*/
|
|
251
|
+
date: unknown;
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* The response from the webhook endpoint
|
|
255
|
+
*/
|
|
256
|
+
response: unknown;
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* The HTTP status code returned by the webhook endpoint
|
|
260
|
+
*/
|
|
261
|
+
statusCode: number;
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Whether the ping was successful
|
|
265
|
+
*/
|
|
266
|
+
success: boolean;
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
export interface SubscriptionCreateParams {
|
|
270
|
+
/**
|
|
271
|
+
* The endpoint where webhook events are sent.
|
|
272
|
+
*/
|
|
273
|
+
url: string;
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* The events to subscribe the url to.
|
|
277
|
+
*/
|
|
278
|
+
events?: Array<
|
|
279
|
+
| 'test'
|
|
280
|
+
| 'merchant_updated'
|
|
281
|
+
| 'merchant_app_updated'
|
|
282
|
+
| 'order_created'
|
|
283
|
+
| 'order_updated'
|
|
284
|
+
| 'refund_succeeded'
|
|
285
|
+
| 'refund_failed'
|
|
286
|
+
| 'refund.initiated'
|
|
287
|
+
| 'refund.succeeded'
|
|
288
|
+
| 'refund.failed'
|
|
289
|
+
| 'payout_report_requested'
|
|
290
|
+
| 'data_session_completed'
|
|
291
|
+
| 'checkout_session_created'
|
|
292
|
+
| 'checkout_session_updated'
|
|
293
|
+
| 'checkout_session_expired'
|
|
294
|
+
| 'checkout_session_completed'
|
|
295
|
+
| 'payout_created'
|
|
296
|
+
| 'payout_updated'
|
|
297
|
+
| 'mandate_setup_started'
|
|
298
|
+
| 'mandate_setup_succeeded'
|
|
299
|
+
| 'mandate_setup_failed'
|
|
300
|
+
| 'mandate_revoked'
|
|
301
|
+
| 'user_payout.initiated'
|
|
302
|
+
| 'user_payout.failed'
|
|
303
|
+
| 'user_payout.paid'
|
|
304
|
+
| 'payout.initiated'
|
|
305
|
+
| 'payout.failed'
|
|
306
|
+
| 'payout.paid'
|
|
307
|
+
| 'deposit.received'
|
|
308
|
+
| 'return.initiated'
|
|
309
|
+
| 'return.succeeded'
|
|
310
|
+
| 'return.failed'
|
|
311
|
+
| 'return.returned'
|
|
312
|
+
>;
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
export interface SubscriptionUpdateParams {
|
|
316
|
+
/**
|
|
317
|
+
* The unique identifier of the webhook subscription to update
|
|
318
|
+
*/
|
|
319
|
+
id: unknown;
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* The new events to subscribe the url to
|
|
323
|
+
*/
|
|
324
|
+
events?: Array<
|
|
325
|
+
| 'test'
|
|
326
|
+
| 'merchant_updated'
|
|
327
|
+
| 'merchant_app_updated'
|
|
328
|
+
| 'order_created'
|
|
329
|
+
| 'order_updated'
|
|
330
|
+
| 'refund_succeeded'
|
|
331
|
+
| 'refund_failed'
|
|
332
|
+
| 'refund.initiated'
|
|
333
|
+
| 'refund.succeeded'
|
|
334
|
+
| 'refund.failed'
|
|
335
|
+
| 'payout_report_requested'
|
|
336
|
+
| 'data_session_completed'
|
|
337
|
+
| 'checkout_session_created'
|
|
338
|
+
| 'checkout_session_updated'
|
|
339
|
+
| 'checkout_session_expired'
|
|
340
|
+
| 'checkout_session_completed'
|
|
341
|
+
| 'payout_created'
|
|
342
|
+
| 'payout_updated'
|
|
343
|
+
| 'mandate_setup_started'
|
|
344
|
+
| 'mandate_setup_succeeded'
|
|
345
|
+
| 'mandate_setup_failed'
|
|
346
|
+
| 'mandate_revoked'
|
|
347
|
+
| 'user_payout.initiated'
|
|
348
|
+
| 'user_payout.failed'
|
|
349
|
+
| 'user_payout.paid'
|
|
350
|
+
| 'payout.initiated'
|
|
351
|
+
| 'payout.failed'
|
|
352
|
+
| 'payout.paid'
|
|
353
|
+
| 'deposit.received'
|
|
354
|
+
| 'return.initiated'
|
|
355
|
+
| 'return.succeeded'
|
|
356
|
+
| 'return.failed'
|
|
357
|
+
| 'return.returned'
|
|
358
|
+
>;
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* The new endpoint where webhook events are sent
|
|
362
|
+
*/
|
|
363
|
+
url?: string;
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
export interface SubscriptionListParams {
|
|
367
|
+
/**
|
|
368
|
+
* The maximum number of webhook subscriptions to return
|
|
369
|
+
*/
|
|
370
|
+
limit?: number;
|
|
371
|
+
|
|
372
|
+
/**
|
|
373
|
+
* The number of webhook subscriptions to skip
|
|
374
|
+
*/
|
|
375
|
+
skip?: number;
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
export interface SubscriptionDeleteParams {
|
|
379
|
+
/**
|
|
380
|
+
* The unique identifier of the webhook subscription to delete
|
|
381
|
+
*/
|
|
382
|
+
id: unknown;
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
export interface SubscriptionPingParams {
|
|
386
|
+
/**
|
|
387
|
+
* The unique identifier of the webhook subscription to ping
|
|
388
|
+
*/
|
|
389
|
+
id: unknown;
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
export declare namespace Subscription {
|
|
393
|
+
export {
|
|
394
|
+
type SubscriptionCreateResponse as SubscriptionCreateResponse,
|
|
395
|
+
type SubscriptionUpdateResponse as SubscriptionUpdateResponse,
|
|
396
|
+
type SubscriptionListResponse as SubscriptionListResponse,
|
|
397
|
+
type SubscriptionDeleteResponse as SubscriptionDeleteResponse,
|
|
398
|
+
type SubscriptionPingResponse as SubscriptionPingResponse,
|
|
399
|
+
type SubscriptionCreateParams as SubscriptionCreateParams,
|
|
400
|
+
type SubscriptionUpdateParams as SubscriptionUpdateParams,
|
|
401
|
+
type SubscriptionListParams as SubscriptionListParams,
|
|
402
|
+
type SubscriptionDeleteParams as SubscriptionDeleteParams,
|
|
403
|
+
type SubscriptionPingParams as SubscriptionPingParams,
|
|
404
|
+
};
|
|
405
|
+
}
|