@augustusbank/typescript-sdk 0.32.0 → 0.34.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 +14 -0
- package/client.d.mts +7 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +7 -4
- 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/accounts.d.mts +36 -12
- package/resources/accounts.d.mts.map +1 -1
- package/resources/accounts.d.ts +36 -12
- package/resources/accounts.d.ts.map +1 -1
- package/resources/api-keys.d.mts +1 -1
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +1 -1
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/counterparties.d.mts +227 -12
- package/resources/counterparties.d.mts.map +1 -1
- package/resources/counterparties.d.ts +227 -12
- package/resources/counterparties.d.ts.map +1 -1
- package/resources/counterparties.js +16 -0
- package/resources/counterparties.js.map +1 -1
- package/resources/counterparties.mjs +16 -0
- package/resources/counterparties.mjs.map +1 -1
- package/resources/events.d.mts +3 -3
- package/resources/events.d.mts.map +1 -1
- package/resources/events.d.ts +3 -3
- package/resources/events.d.ts.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/payout-tracking-events.d.mts +454 -0
- package/resources/payout-tracking-events.d.mts.map +1 -0
- package/resources/payout-tracking-events.d.ts +454 -0
- package/resources/payout-tracking-events.d.ts.map +1 -0
- package/resources/payout-tracking-events.js +23 -0
- package/resources/payout-tracking-events.js.map +1 -0
- package/resources/payout-tracking-events.mjs +19 -0
- package/resources/payout-tracking-events.mjs.map +1 -0
- package/resources/payouts.d.mts +8 -16
- package/resources/payouts.d.mts.map +1 -1
- package/resources/payouts.d.ts +8 -16
- package/resources/payouts.d.ts.map +1 -1
- package/resources/scopes.d.mts +1 -1
- package/resources/scopes.d.mts.map +1 -1
- package/resources/scopes.d.ts +1 -1
- package/resources/scopes.d.ts.map +1 -1
- package/resources/transactions.d.mts +0 -10
- package/resources/transactions.d.mts.map +1 -1
- package/resources/transactions.d.ts +0 -10
- package/resources/transactions.d.ts.map +1 -1
- package/resources/webhook-subscriptions.d.mts +8 -8
- package/resources/webhook-subscriptions.d.mts.map +1 -1
- package/resources/webhook-subscriptions.d.ts +8 -8
- package/resources/webhook-subscriptions.d.ts.map +1 -1
- package/resources/webhooks.d.mts +254 -34
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +254 -34
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +21 -0
- package/src/resources/accounts.ts +36 -12
- package/src/resources/api-keys.ts +1 -0
- package/src/resources/counterparties.ts +536 -12
- package/src/resources/events.ts +3 -0
- package/src/resources/index.ts +9 -0
- package/src/resources/payout-tracking-events.ts +587 -0
- package/src/resources/payouts.ts +4 -36
- package/src/resources/scopes.ts +2 -1
- package/src/resources/transactions.ts +0 -12
- package/src/resources/webhook-subscriptions.ts +8 -0
- package/src/resources/webhooks.ts +300 -57
- 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
|
@@ -0,0 +1,454 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
export declare class PayoutTrackingEvents extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a payout tracking event by ID.
|
|
8
|
+
*/
|
|
9
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<PayoutTrackingEventRetrieveResponse>;
|
|
10
|
+
/**
|
|
11
|
+
* Returns a paginated list of payout tracking events, newest first.
|
|
12
|
+
*/
|
|
13
|
+
list(query?: PayoutTrackingEventListParams | null | undefined, options?: RequestOptions): PagePromise<PayoutTrackingEventListResponsesCursorPage, PayoutTrackingEventListResponse>;
|
|
14
|
+
}
|
|
15
|
+
export type PayoutTrackingEventListResponsesCursorPage = CursorPage<PayoutTrackingEventListResponse>;
|
|
16
|
+
export interface PayoutTrackingEventRetrieveResponse {
|
|
17
|
+
/**
|
|
18
|
+
* Unique identifier of the tracking event.
|
|
19
|
+
*/
|
|
20
|
+
id: string;
|
|
21
|
+
/**
|
|
22
|
+
* Amount credited to the beneficiary. Set only on a credited event, otherwise
|
|
23
|
+
* null.
|
|
24
|
+
*/
|
|
25
|
+
beneficiary_amount: PayoutTrackingEventRetrieveResponse.BeneficiaryAmount | null;
|
|
26
|
+
/**
|
|
27
|
+
* ISO 8601 UTC timestamp when Augustus recorded the event.
|
|
28
|
+
*/
|
|
29
|
+
created_at: string;
|
|
30
|
+
/**
|
|
31
|
+
* Fee deducted at this step. Null when none was reported.
|
|
32
|
+
*/
|
|
33
|
+
fee: PayoutTrackingEventRetrieveResponse.Fee | null;
|
|
34
|
+
/**
|
|
35
|
+
* Institution that sent the payout in this step. Null when unknown or not reported
|
|
36
|
+
* by the source.
|
|
37
|
+
*/
|
|
38
|
+
from_institution: PayoutTrackingEventRetrieveResponse.FromInstitution | null;
|
|
39
|
+
/**
|
|
40
|
+
* Institution holding the payout after this step: the bank that received it, or
|
|
41
|
+
* the bank that reported this status. Null when unknown.
|
|
42
|
+
*/
|
|
43
|
+
institution: PayoutTrackingEventRetrieveResponse.Institution | null;
|
|
44
|
+
/**
|
|
45
|
+
* Whether Augustus considers delivery finished. A credit reported by a bank that
|
|
46
|
+
* passes the payout on is a forwarded step and is not terminal. A later event,
|
|
47
|
+
* such as returned, can still follow.
|
|
48
|
+
*/
|
|
49
|
+
is_terminal: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Normalized point in the payout journey. New values may be added.
|
|
52
|
+
*/
|
|
53
|
+
milestone: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned' | 'accepted' | 'settled' | 'forwarded' | 'credited' | 'rejected' | 'returning' | 'visibility_lost' | 'other';
|
|
54
|
+
/**
|
|
55
|
+
* Raw network status. Null when the step has none.
|
|
56
|
+
*/
|
|
57
|
+
network_status: PayoutTrackingEventRetrieveResponse.NetworkStatus | null;
|
|
58
|
+
/**
|
|
59
|
+
* ISO 8601 UTC timestamp when the step happened. Null when the source has no
|
|
60
|
+
* timestamp. Can be out of order with sequence.
|
|
61
|
+
*/
|
|
62
|
+
occurred_at: string | null;
|
|
63
|
+
/**
|
|
64
|
+
* ID of the payout this event belongs to.
|
|
65
|
+
*/
|
|
66
|
+
payout_id: string;
|
|
67
|
+
/**
|
|
68
|
+
* How far Augustus can follow the payout: end_to_end when the rail confirms the
|
|
69
|
+
* beneficiary credit, network when it only confirms settlement. New values may be
|
|
70
|
+
* added.
|
|
71
|
+
*/
|
|
72
|
+
scope: 'network' | 'end_to_end';
|
|
73
|
+
/**
|
|
74
|
+
* Gap-free counter per payout, in the order Augustus recorded the events. A gap
|
|
75
|
+
* means you missed a recorded event, such as a dropped webhook. A sequence without
|
|
76
|
+
* gaps does not mean every network step was observed.
|
|
77
|
+
*/
|
|
78
|
+
sequence: number;
|
|
79
|
+
/**
|
|
80
|
+
* Where Augustus learned this step: augustus for steps Augustus records itself,
|
|
81
|
+
* swift_gpi for SWIFT gpi statuses, other for any other source. New values may be
|
|
82
|
+
* added.
|
|
83
|
+
*/
|
|
84
|
+
source: 'augustus' | 'swift_gpi' | 'other';
|
|
85
|
+
/**
|
|
86
|
+
* Reason for the current state. Null when none applies.
|
|
87
|
+
*/
|
|
88
|
+
status_reason: PayoutTrackingEventRetrieveResponse.StatusReason | null;
|
|
89
|
+
/**
|
|
90
|
+
* Resource type discriminator.
|
|
91
|
+
*/
|
|
92
|
+
type: 'payout_tracking_event';
|
|
93
|
+
}
|
|
94
|
+
export declare namespace PayoutTrackingEventRetrieveResponse {
|
|
95
|
+
/**
|
|
96
|
+
* Amount credited to the beneficiary. Set only on a credited event, otherwise
|
|
97
|
+
* null.
|
|
98
|
+
*/
|
|
99
|
+
interface BeneficiaryAmount {
|
|
100
|
+
/**
|
|
101
|
+
* Credited amount as a string decimal (e.g. "100.50").
|
|
102
|
+
*/
|
|
103
|
+
amount: string;
|
|
104
|
+
/**
|
|
105
|
+
* ISO 4217 currency code of the credited amount.
|
|
106
|
+
*/
|
|
107
|
+
currency: string;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Fee deducted at this step. Null when none was reported.
|
|
111
|
+
*/
|
|
112
|
+
interface Fee {
|
|
113
|
+
/**
|
|
114
|
+
* Fee amount as a string decimal (e.g. "10.00").
|
|
115
|
+
*/
|
|
116
|
+
amount: string;
|
|
117
|
+
/**
|
|
118
|
+
* Who bears the charges under the payment charge agreement: debtor (OUR), creditor
|
|
119
|
+
* (BEN), shared (SHA), or other for any other agreement. New values may be added.
|
|
120
|
+
*/
|
|
121
|
+
borne_by: 'debtor' | 'creditor' | 'shared' | 'other';
|
|
122
|
+
/**
|
|
123
|
+
* ISO 4217 currency code of the fee.
|
|
124
|
+
*/
|
|
125
|
+
currency: string;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Institution that sent the payout in this step. Null when unknown or not reported
|
|
129
|
+
* by the source.
|
|
130
|
+
*/
|
|
131
|
+
interface FromInstitution {
|
|
132
|
+
/**
|
|
133
|
+
* Identifier of the institution, typed by scheme. Null when only its name is
|
|
134
|
+
* known.
|
|
135
|
+
*/
|
|
136
|
+
identifier: FromInstitution.Identifier | null;
|
|
137
|
+
/**
|
|
138
|
+
* Name of the institution. Null when unknown.
|
|
139
|
+
*/
|
|
140
|
+
name: string | null;
|
|
141
|
+
}
|
|
142
|
+
namespace FromInstitution {
|
|
143
|
+
/**
|
|
144
|
+
* Identifier of the institution, typed by scheme. Null when only its name is
|
|
145
|
+
* known.
|
|
146
|
+
*/
|
|
147
|
+
interface Identifier {
|
|
148
|
+
/**
|
|
149
|
+
* Identifier scheme. Only bic today.
|
|
150
|
+
*/
|
|
151
|
+
type: 'bic';
|
|
152
|
+
/**
|
|
153
|
+
* ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
|
|
154
|
+
* padded with the XXX head office branch code.
|
|
155
|
+
*/
|
|
156
|
+
value: string;
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Institution holding the payout after this step: the bank that received it, or
|
|
161
|
+
* the bank that reported this status. Null when unknown.
|
|
162
|
+
*/
|
|
163
|
+
interface Institution {
|
|
164
|
+
/**
|
|
165
|
+
* Identifier of the institution, typed by scheme. Null when only its name is
|
|
166
|
+
* known.
|
|
167
|
+
*/
|
|
168
|
+
identifier: Institution.Identifier | null;
|
|
169
|
+
/**
|
|
170
|
+
* Name of the institution. Null when unknown.
|
|
171
|
+
*/
|
|
172
|
+
name: string | null;
|
|
173
|
+
}
|
|
174
|
+
namespace Institution {
|
|
175
|
+
/**
|
|
176
|
+
* Identifier of the institution, typed by scheme. Null when only its name is
|
|
177
|
+
* known.
|
|
178
|
+
*/
|
|
179
|
+
interface Identifier {
|
|
180
|
+
/**
|
|
181
|
+
* Identifier scheme. Only bic today.
|
|
182
|
+
*/
|
|
183
|
+
type: 'bic';
|
|
184
|
+
/**
|
|
185
|
+
* ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
|
|
186
|
+
* padded with the XXX head office branch code.
|
|
187
|
+
*/
|
|
188
|
+
value: string;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Raw network status. Null when the step has none.
|
|
193
|
+
*/
|
|
194
|
+
interface NetworkStatus {
|
|
195
|
+
/**
|
|
196
|
+
* Status code reported by the network, such as ACSP, ACSC, ACCC or RJCT.
|
|
197
|
+
*/
|
|
198
|
+
code: string;
|
|
199
|
+
/**
|
|
200
|
+
* Reason code for the status, such as G000. Null when the network reports none.
|
|
201
|
+
*/
|
|
202
|
+
reason_code: string | null;
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* Reason for the current state. Null when none applies.
|
|
206
|
+
*/
|
|
207
|
+
interface StatusReason {
|
|
208
|
+
/**
|
|
209
|
+
* Normalized reason code assigned by Augustus. Current codes: `CREDIT_PENDING`
|
|
210
|
+
* (the beneficiary bank reported the credit as pending). New codes may be added.
|
|
211
|
+
*/
|
|
212
|
+
code: string;
|
|
213
|
+
/**
|
|
214
|
+
* Explanation of the reason code, written by Augustus.
|
|
215
|
+
*/
|
|
216
|
+
description: string;
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
export interface PayoutTrackingEventListResponse {
|
|
220
|
+
/**
|
|
221
|
+
* Unique identifier of the tracking event.
|
|
222
|
+
*/
|
|
223
|
+
id: string;
|
|
224
|
+
/**
|
|
225
|
+
* Amount credited to the beneficiary. Set only on a credited event, otherwise
|
|
226
|
+
* null.
|
|
227
|
+
*/
|
|
228
|
+
beneficiary_amount: PayoutTrackingEventListResponse.BeneficiaryAmount | null;
|
|
229
|
+
/**
|
|
230
|
+
* ISO 8601 UTC timestamp when Augustus recorded the event.
|
|
231
|
+
*/
|
|
232
|
+
created_at: string;
|
|
233
|
+
/**
|
|
234
|
+
* Fee deducted at this step. Null when none was reported.
|
|
235
|
+
*/
|
|
236
|
+
fee: PayoutTrackingEventListResponse.Fee | null;
|
|
237
|
+
/**
|
|
238
|
+
* Institution that sent the payout in this step. Null when unknown or not reported
|
|
239
|
+
* by the source.
|
|
240
|
+
*/
|
|
241
|
+
from_institution: PayoutTrackingEventListResponse.FromInstitution | null;
|
|
242
|
+
/**
|
|
243
|
+
* Institution holding the payout after this step: the bank that received it, or
|
|
244
|
+
* the bank that reported this status. Null when unknown.
|
|
245
|
+
*/
|
|
246
|
+
institution: PayoutTrackingEventListResponse.Institution | null;
|
|
247
|
+
/**
|
|
248
|
+
* Whether Augustus considers delivery finished. A credit reported by a bank that
|
|
249
|
+
* passes the payout on is a forwarded step and is not terminal. A later event,
|
|
250
|
+
* such as returned, can still follow.
|
|
251
|
+
*/
|
|
252
|
+
is_terminal: boolean;
|
|
253
|
+
/**
|
|
254
|
+
* Normalized point in the payout journey. New values may be added.
|
|
255
|
+
*/
|
|
256
|
+
milestone: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned' | 'accepted' | 'settled' | 'forwarded' | 'credited' | 'rejected' | 'returning' | 'visibility_lost' | 'other';
|
|
257
|
+
/**
|
|
258
|
+
* Raw network status. Null when the step has none.
|
|
259
|
+
*/
|
|
260
|
+
network_status: PayoutTrackingEventListResponse.NetworkStatus | null;
|
|
261
|
+
/**
|
|
262
|
+
* ISO 8601 UTC timestamp when the step happened. Null when the source has no
|
|
263
|
+
* timestamp. Can be out of order with sequence.
|
|
264
|
+
*/
|
|
265
|
+
occurred_at: string | null;
|
|
266
|
+
/**
|
|
267
|
+
* ID of the payout this event belongs to.
|
|
268
|
+
*/
|
|
269
|
+
payout_id: string;
|
|
270
|
+
/**
|
|
271
|
+
* How far Augustus can follow the payout: end_to_end when the rail confirms the
|
|
272
|
+
* beneficiary credit, network when it only confirms settlement. New values may be
|
|
273
|
+
* added.
|
|
274
|
+
*/
|
|
275
|
+
scope: 'network' | 'end_to_end';
|
|
276
|
+
/**
|
|
277
|
+
* Gap-free counter per payout, in the order Augustus recorded the events. A gap
|
|
278
|
+
* means you missed a recorded event, such as a dropped webhook. A sequence without
|
|
279
|
+
* gaps does not mean every network step was observed.
|
|
280
|
+
*/
|
|
281
|
+
sequence: number;
|
|
282
|
+
/**
|
|
283
|
+
* Where Augustus learned this step: augustus for steps Augustus records itself,
|
|
284
|
+
* swift_gpi for SWIFT gpi statuses, other for any other source. New values may be
|
|
285
|
+
* added.
|
|
286
|
+
*/
|
|
287
|
+
source: 'augustus' | 'swift_gpi' | 'other';
|
|
288
|
+
/**
|
|
289
|
+
* Reason for the current state. Null when none applies.
|
|
290
|
+
*/
|
|
291
|
+
status_reason: PayoutTrackingEventListResponse.StatusReason | null;
|
|
292
|
+
/**
|
|
293
|
+
* Resource type discriminator.
|
|
294
|
+
*/
|
|
295
|
+
type: 'payout_tracking_event';
|
|
296
|
+
}
|
|
297
|
+
export declare namespace PayoutTrackingEventListResponse {
|
|
298
|
+
/**
|
|
299
|
+
* Amount credited to the beneficiary. Set only on a credited event, otherwise
|
|
300
|
+
* null.
|
|
301
|
+
*/
|
|
302
|
+
interface BeneficiaryAmount {
|
|
303
|
+
/**
|
|
304
|
+
* Credited amount as a string decimal (e.g. "100.50").
|
|
305
|
+
*/
|
|
306
|
+
amount: string;
|
|
307
|
+
/**
|
|
308
|
+
* ISO 4217 currency code of the credited amount.
|
|
309
|
+
*/
|
|
310
|
+
currency: string;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* Fee deducted at this step. Null when none was reported.
|
|
314
|
+
*/
|
|
315
|
+
interface Fee {
|
|
316
|
+
/**
|
|
317
|
+
* Fee amount as a string decimal (e.g. "10.00").
|
|
318
|
+
*/
|
|
319
|
+
amount: string;
|
|
320
|
+
/**
|
|
321
|
+
* Who bears the charges under the payment charge agreement: debtor (OUR), creditor
|
|
322
|
+
* (BEN), shared (SHA), or other for any other agreement. New values may be added.
|
|
323
|
+
*/
|
|
324
|
+
borne_by: 'debtor' | 'creditor' | 'shared' | 'other';
|
|
325
|
+
/**
|
|
326
|
+
* ISO 4217 currency code of the fee.
|
|
327
|
+
*/
|
|
328
|
+
currency: string;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* Institution that sent the payout in this step. Null when unknown or not reported
|
|
332
|
+
* by the source.
|
|
333
|
+
*/
|
|
334
|
+
interface FromInstitution {
|
|
335
|
+
/**
|
|
336
|
+
* Identifier of the institution, typed by scheme. Null when only its name is
|
|
337
|
+
* known.
|
|
338
|
+
*/
|
|
339
|
+
identifier: FromInstitution.Identifier | null;
|
|
340
|
+
/**
|
|
341
|
+
* Name of the institution. Null when unknown.
|
|
342
|
+
*/
|
|
343
|
+
name: string | null;
|
|
344
|
+
}
|
|
345
|
+
namespace FromInstitution {
|
|
346
|
+
/**
|
|
347
|
+
* Identifier of the institution, typed by scheme. Null when only its name is
|
|
348
|
+
* known.
|
|
349
|
+
*/
|
|
350
|
+
interface Identifier {
|
|
351
|
+
/**
|
|
352
|
+
* Identifier scheme. Only bic today.
|
|
353
|
+
*/
|
|
354
|
+
type: 'bic';
|
|
355
|
+
/**
|
|
356
|
+
* ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
|
|
357
|
+
* padded with the XXX head office branch code.
|
|
358
|
+
*/
|
|
359
|
+
value: string;
|
|
360
|
+
}
|
|
361
|
+
}
|
|
362
|
+
/**
|
|
363
|
+
* Institution holding the payout after this step: the bank that received it, or
|
|
364
|
+
* the bank that reported this status. Null when unknown.
|
|
365
|
+
*/
|
|
366
|
+
interface Institution {
|
|
367
|
+
/**
|
|
368
|
+
* Identifier of the institution, typed by scheme. Null when only its name is
|
|
369
|
+
* known.
|
|
370
|
+
*/
|
|
371
|
+
identifier: Institution.Identifier | null;
|
|
372
|
+
/**
|
|
373
|
+
* Name of the institution. Null when unknown.
|
|
374
|
+
*/
|
|
375
|
+
name: string | null;
|
|
376
|
+
}
|
|
377
|
+
namespace Institution {
|
|
378
|
+
/**
|
|
379
|
+
* Identifier of the institution, typed by scheme. Null when only its name is
|
|
380
|
+
* known.
|
|
381
|
+
*/
|
|
382
|
+
interface Identifier {
|
|
383
|
+
/**
|
|
384
|
+
* Identifier scheme. Only bic today.
|
|
385
|
+
*/
|
|
386
|
+
type: 'bic';
|
|
387
|
+
/**
|
|
388
|
+
* ISO 9362 Bank Identifier Code, always 11 characters. An 8-character BIC is
|
|
389
|
+
* padded with the XXX head office branch code.
|
|
390
|
+
*/
|
|
391
|
+
value: string;
|
|
392
|
+
}
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* Raw network status. Null when the step has none.
|
|
396
|
+
*/
|
|
397
|
+
interface NetworkStatus {
|
|
398
|
+
/**
|
|
399
|
+
* Status code reported by the network, such as ACSP, ACSC, ACCC or RJCT.
|
|
400
|
+
*/
|
|
401
|
+
code: string;
|
|
402
|
+
/**
|
|
403
|
+
* Reason code for the status, such as G000. Null when the network reports none.
|
|
404
|
+
*/
|
|
405
|
+
reason_code: string | null;
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* Reason for the current state. Null when none applies.
|
|
409
|
+
*/
|
|
410
|
+
interface StatusReason {
|
|
411
|
+
/**
|
|
412
|
+
* Normalized reason code assigned by Augustus. Current codes: `CREDIT_PENDING`
|
|
413
|
+
* (the beneficiary bank reported the credit as pending). New codes may be added.
|
|
414
|
+
*/
|
|
415
|
+
code: string;
|
|
416
|
+
/**
|
|
417
|
+
* Explanation of the reason code, written by Augustus.
|
|
418
|
+
*/
|
|
419
|
+
description: string;
|
|
420
|
+
}
|
|
421
|
+
}
|
|
422
|
+
export interface PayoutTrackingEventListParams extends CursorPageParams {
|
|
423
|
+
created_at?: PayoutTrackingEventListParams.CreatedAt;
|
|
424
|
+
/**
|
|
425
|
+
* Filter by whether Augustus considers delivery finished.
|
|
426
|
+
*/
|
|
427
|
+
is_terminal?: boolean;
|
|
428
|
+
/**
|
|
429
|
+
* Filter by milestone.
|
|
430
|
+
*/
|
|
431
|
+
milestone?: 'initiated' | 'submitted' | 'sent' | 'failed' | 'returned' | 'accepted' | 'settled' | 'forwarded' | 'credited' | 'rejected' | 'returning' | 'visibility_lost' | 'other';
|
|
432
|
+
/**
|
|
433
|
+
* Filter tracking events belonging to this payout.
|
|
434
|
+
*/
|
|
435
|
+
payout_id?: string;
|
|
436
|
+
}
|
|
437
|
+
export declare namespace PayoutTrackingEventListParams {
|
|
438
|
+
interface CreatedAt {
|
|
439
|
+
/**
|
|
440
|
+
* Include tracking events whose created_at is greater than or equal to this ISO
|
|
441
|
+
* 8601 timestamp.
|
|
442
|
+
*/
|
|
443
|
+
gte?: string;
|
|
444
|
+
/**
|
|
445
|
+
* Include tracking events whose created_at is less than or equal to this ISO 8601
|
|
446
|
+
* timestamp.
|
|
447
|
+
*/
|
|
448
|
+
lte?: string;
|
|
449
|
+
}
|
|
450
|
+
}
|
|
451
|
+
export declare namespace PayoutTrackingEvents {
|
|
452
|
+
export { type PayoutTrackingEventRetrieveResponse as PayoutTrackingEventRetrieveResponse, type PayoutTrackingEventListResponse as PayoutTrackingEventListResponse, type PayoutTrackingEventListResponsesCursorPage as PayoutTrackingEventListResponsesCursorPage, type PayoutTrackingEventListParams as PayoutTrackingEventListParams, };
|
|
453
|
+
}
|
|
454
|
+
//# sourceMappingURL=payout-tracking-events.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payout-tracking-events.d.ts","sourceRoot":"","sources":["../src/resources/payout-tracking-events.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,8BAA2B;AACpF,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;IAI/F;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,+BAA+B,CAAC;CAO5F;AAED,MAAM,MAAM,0CAA0C,GAAG,UAAU,CAAC,+BAA+B,CAAC,CAAC;AAErG,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,kBAAkB,EAAE,mCAAmC,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAEjF;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,mCAAmC,CAAC,GAAG,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,gBAAgB,EAAE,mCAAmC,CAAC,eAAe,GAAG,IAAI,CAAC;IAE7E;;;OAGG;IACH,WAAW,EAAE,mCAAmC,CAAC,WAAW,GAAG,IAAI,CAAC;IAEpE;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,SAAS,EACL,WAAW,GACX,WAAW,GACX,MAAM,GACN,QAAQ,GACR,UAAU,GACV,UAAU,GACV,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,OAAO,CAAC;IAEZ;;OAEG;IACH,cAAc,EAAE,mCAAmC,CAAC,aAAa,GAAG,IAAI,CAAC;IAEzE;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,KAAK,EAAE,SAAS,GAAG,YAAY,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,aAAa,EAAE,mCAAmC,CAAC,YAAY,GAAG,IAAI,CAAC;IAEvE;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,yBAAiB,mCAAmC,CAAC;IACnD;;;OAGG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,QAAQ,EAAE,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,CAAC;QAErD;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,UAAU,EAAE,eAAe,CAAC,UAAU,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;IAED,UAAiB,eAAe,CAAC;QAC/B;;;WAGG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC;YAEZ;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;;WAGG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC;QAE1C;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;IAED,UAAiB,WAAW,CAAC;QAC3B;;;WAGG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC;YAEZ;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,kBAAkB,EAAE,+BAA+B,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAE7E;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,+BAA+B,CAAC,GAAG,GAAG,IAAI,CAAC;IAEhD;;;OAGG;IACH,gBAAgB,EAAE,+BAA+B,CAAC,eAAe,GAAG,IAAI,CAAC;IAEzE;;;OAGG;IACH,WAAW,EAAE,+BAA+B,CAAC,WAAW,GAAG,IAAI,CAAC;IAEhE;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,SAAS,EACL,WAAW,GACX,WAAW,GACX,MAAM,GACN,QAAQ,GACR,UAAU,GACV,UAAU,GACV,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,OAAO,CAAC;IAEZ;;OAEG;IACH,cAAc,EAAE,+BAA+B,CAAC,aAAa,GAAG,IAAI,CAAC;IAErE;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,KAAK,EAAE,SAAS,GAAG,YAAY,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,aAAa,EAAE,+BAA+B,CAAC,YAAY,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;;OAGG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,QAAQ,EAAE,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,CAAC;QAErD;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,eAAe;QAC9B;;;WAGG;QACH,UAAU,EAAE,eAAe,CAAC,UAAU,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;IAED,UAAiB,eAAe,CAAC;QAC/B;;;WAGG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC;YAEZ;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;;WAGG;QACH,UAAU,EAAE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC;QAE1C;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;IAED,UAAiB,WAAW,CAAC;QAC3B;;;WAGG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,KAAK,CAAC;YAEZ;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACrE,UAAU,CAAC,EAAE,6BAA6B,CAAC,SAAS,CAAC;IAErD;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EACN,WAAW,GACX,WAAW,GACX,MAAM,GACN,QAAQ,GACR,UAAU,GACV,UAAU,GACV,SAAS,GACT,WAAW,GACX,UAAU,GACV,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,OAAO,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.PayoutTrackingEvents = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const pagination_1 = require("../core/pagination.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class PayoutTrackingEvents extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieves a payout tracking event by ID.
|
|
11
|
+
*/
|
|
12
|
+
retrieve(id, options) {
|
|
13
|
+
return this._client.get((0, path_1.path) `/v1/payout_tracking_events/${id}`, options);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Returns a paginated list of payout tracking events, newest first.
|
|
17
|
+
*/
|
|
18
|
+
list(query = {}, options) {
|
|
19
|
+
return this._client.getAPIList('/v1/payout_tracking_events', (pagination_1.CursorPage), { query, ...options });
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
exports.PayoutTrackingEvents = PayoutTrackingEvents;
|
|
23
|
+
//# sourceMappingURL=payout-tracking-events.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payout-tracking-events.js","sourceRoot":"","sources":["../src/resources/payout-tracking-events.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8BAA8B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,4BAA4B,EAC5B,CAAA,uBAA2C,CAAA,EAC3C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AArBD,oDAqBC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { CursorPage } from "../core/pagination.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
export class PayoutTrackingEvents extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a payout tracking event by ID.
|
|
8
|
+
*/
|
|
9
|
+
retrieve(id, options) {
|
|
10
|
+
return this._client.get(path `/v1/payout_tracking_events/${id}`, options);
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Returns a paginated list of payout tracking events, newest first.
|
|
14
|
+
*/
|
|
15
|
+
list(query = {}, options) {
|
|
16
|
+
return this._client.getAPIList('/v1/payout_tracking_events', (CursorPage), { query, ...options });
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=payout-tracking-events.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"payout-tracking-events.mjs","sourceRoot":"","sources":["../src/resources/payout-tracking-events.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,UAAU,EAAsC,+BAA2B;AAEpF,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8BAA8B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,4BAA4B,EAC5B,CAAA,UAA2C,CAAA,EAC3C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}
|