@pacspace-io/sdk 0.9.0 → 0.15.2
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/README.md +53 -132
- package/dist/blinding-file.d.ts +13 -0
- package/dist/blinding-file.d.ts.map +1 -0
- package/dist/blinding-guard.d.ts +7 -0
- package/dist/blinding-guard.d.ts.map +1 -0
- package/dist/blinding.d.ts +32 -0
- package/dist/blinding.d.ts.map +1 -0
- package/dist/client.d.ts +28 -4
- package/dist/client.d.ts.map +1 -1
- package/dist/fingerprint.d.ts +26 -5
- package/dist/fingerprint.d.ts.map +1 -1
- package/dist/index.d.ts +35 -35
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7366 -186
- package/dist/index.js.map +7 -1
- package/dist/inputs.txt +132 -0
- package/dist/records-crypto-libraries.json +42 -0
- package/dist/records-crypto-types/proof/hiding-commitment-v1.d.ts +19 -0
- package/dist/records-crypto-types/proof/jcs.d.ts +4 -0
- package/dist/records-crypto-types/proof/layout-document-v1.d.ts +72 -0
- package/dist/records-crypto-types/proof/ledger-head-v1.d.ts +22 -0
- package/dist/records-crypto-types/proof/merkle-v2.d.ts +5 -0
- package/dist/records-crypto-types/proof/payload-ref-v1.d.ts +17 -0
- package/dist/records-crypto-types/proof/seal-input.d.ts +2 -0
- package/dist/records-crypto-types/proof/semantic-receipt-v2.d.ts +89 -0
- package/dist/records-crypto-types/proof/semantic-receipt-v3.d.ts +20 -0
- package/dist/records-crypto-types/proof/slot-encoding-v1.d.ts +169 -0
- package/dist/records-crypto-types/records/flag-threads-v1.d.ts +53 -0
- package/dist/records-crypto-types/records/labels.d.ts +37 -0
- package/dist/records-crypto-types/records/reader-crypto-v1.d.ts +198 -0
- package/dist/records-crypto-types/records/reader-link-v1.d.ts +164 -0
- package/dist/records-crypto-types/records/shared-record-ack-v2.d.ts +72 -0
- package/dist/records-crypto-types/records/signed-acknowledgment-v1.d.ts +38 -0
- package/dist/records-crypto-types/records/signed-acknowledgment-v2.d.ts +12 -0
- package/dist/records-crypto-types/records/trail-index-v1.d.ts +89 -0
- package/dist/records-crypto-types/records/trail-rule.d.ts +54 -0
- package/dist/records-crypto-types/records-crypto/asymmetric/ack-flag-notes-v1.d.ts +57 -0
- package/dist/records-crypto-types/records-crypto/asymmetric/flag-notes-v1.d.ts +55 -0
- package/dist/records-crypto-types/records-crypto/asymmetric/index.d.ts +4 -0
- package/dist/records-crypto-types/records-crypto/asymmetric/reader-wraps-v1.d.ts +83 -0
- package/dist/records-crypto-types/records-crypto/asymmetric/records-asymmetric-v1.d.ts +201 -0
- package/dist/records-crypto-types/records-crypto/base64url.d.ts +3 -0
- package/dist/records-crypto-types/records-crypto/blinding-file.d.ts +16 -0
- package/dist/records-crypto-types/records-crypto/blinding-value.d.ts +10 -0
- package/dist/records-crypto-types/records-crypto/bundle-entry.d.ts +2 -0
- package/dist/records-crypto-types/records-crypto/disclosure-envelope-v1.d.ts +42 -0
- package/dist/records-crypto-types/records-crypto/held-file.d.ts +17 -0
- package/dist/records-crypto-types/records-crypto/hmac-node.d.ts +8 -0
- package/dist/records-crypto-types/records-crypto/hmac-web.d.ts +8 -0
- package/dist/records-crypto-types/records-crypto/index.d.ts +13 -0
- package/dist/records-crypto-types/records-crypto/platform-crypto.d.ts +9 -0
- package/dist/records-crypto-types/records-crypto/record-disclosure-v1.d.ts +171 -0
- package/dist/records-crypto-types/records-crypto/record-hash-v2.d.ts +49 -0
- package/dist/records-crypto-types/records-crypto/record-hash-v3.d.ts +36 -0
- package/dist/records-crypto-types/records-crypto/records-encryption-v1.d.ts +185 -0
- package/dist/records-crypto-types/records-crypto/wrap-shapes-v1.d.ts +23 -0
- package/dist/records-crypto.d.ts +1 -0
- package/dist/records-crypto.js +16105 -0
- package/dist/records-crypto.js.map +7 -0
- package/dist/records-encryption/base64url.d.ts +5 -0
- package/dist/records-encryption/base64url.d.ts.map +1 -0
- package/dist/records-encryption/encrypted-records.d.ts +338 -0
- package/dist/records-encryption/encrypted-records.d.ts.map +1 -0
- package/dist/records-encryption/index.d.ts +14 -0
- package/dist/records-encryption/index.d.ts.map +1 -0
- package/dist/records-encryption/keys.d.ts +40 -0
- package/dist/records-encryption/keys.d.ts.map +1 -0
- package/dist/records-encryption/loader.d.ts +15 -0
- package/dist/records-encryption/loader.d.ts.map +1 -0
- package/dist/records-encryption/pin-store-file.d.ts +8 -0
- package/dist/records-encryption/pin-store-file.d.ts.map +1 -0
- package/dist/records-encryption/pin-store.d.ts +17 -0
- package/dist/records-encryption/pin-store.d.ts.map +1 -0
- package/dist/records-encryption/transport.d.ts +23 -0
- package/dist/records-encryption/transport.d.ts.map +1 -0
- package/dist/records-encryption/words.d.ts +40 -0
- package/dist/records-encryption/words.d.ts.map +1 -0
- package/dist/records-encryption/workspace-secret.d.ts +9 -0
- package/dist/records-encryption/workspace-secret.d.ts.map +1 -0
- package/dist/resources/records.d.ts +112 -2
- package/dist/resources/records.d.ts.map +1 -1
- package/dist/types/common.d.ts +0 -8
- package/dist/types/common.d.ts.map +1 -1
- package/dist/types/config.d.ts +7 -5
- package/dist/types/config.d.ts.map +1 -1
- package/dist/types/records-encryption.d.ts +136 -0
- package/dist/types/records-encryption.d.ts.map +1 -0
- package/dist/types/records.d.ts +171 -20
- package/dist/types/records.d.ts.map +1 -1
- package/dist/types/verify.d.ts +84 -0
- package/dist/types/verify.d.ts.map +1 -0
- package/dist/webhooks/index.d.ts +1 -1
- package/dist/webhooks/index.d.ts.map +1 -1
- package/dist/webhooks/index.js +229 -5
- package/dist/webhooks/index.js.map +7 -1
- package/dist/webhooks/types.d.ts +15 -7
- package/dist/webhooks/types.d.ts.map +1 -1
- package/dist/workspace-secret-file.d.ts +18 -0
- package/dist/workspace-secret-file.d.ts.map +1 -0
- package/package.json +16 -13
- package/dist/client.js +0 -553
- package/dist/client.js.map +0 -1
- package/dist/errors/index.js +0 -223
- package/dist/errors/index.js.map +0 -1
- package/dist/fingerprint.js +0 -132
- package/dist/fingerprint.js.map +0 -1
- package/dist/resources/balance.d.ts +0 -384
- package/dist/resources/balance.d.ts.map +0 -1
- package/dist/resources/balance.js +0 -1120
- package/dist/resources/balance.js.map +0 -1
- package/dist/resources/customers.d.ts +0 -33
- package/dist/resources/customers.d.ts.map +0 -1
- package/dist/resources/customers.js +0 -26
- package/dist/resources/customers.js.map +0 -1
- package/dist/resources/internal/batch-transport.d.ts +0 -65
- package/dist/resources/internal/batch-transport.d.ts.map +0 -1
- package/dist/resources/internal/batch-transport.js +0 -42
- package/dist/resources/internal/batch-transport.js.map +0 -1
- package/dist/resources/receipts.d.ts +0 -46
- package/dist/resources/receipts.d.ts.map +0 -1
- package/dist/resources/receipts.js +0 -133
- package/dist/resources/receipts.js.map +0 -1
- package/dist/resources/records.js +0 -232
- package/dist/resources/records.js.map +0 -1
- package/dist/resources/submission.d.ts +0 -79
- package/dist/resources/submission.d.ts.map +0 -1
- package/dist/resources/submission.js +0 -398
- package/dist/resources/submission.js.map +0 -1
- package/dist/types/balance.d.ts +0 -966
- package/dist/types/balance.d.ts.map +0 -1
- package/dist/types/balance.js +0 -3
- package/dist/types/balance.js.map +0 -1
- package/dist/types/common.js +0 -3
- package/dist/types/common.js.map +0 -1
- package/dist/types/config.js +0 -3
- package/dist/types/config.js.map +0 -1
- package/dist/types/records.js +0 -5
- package/dist/types/records.js.map +0 -1
- package/dist/types/submission.d.ts +0 -125
- package/dist/types/submission.d.ts.map +0 -1
- package/dist/types/submission.js +0 -3
- package/dist/types/submission.js.map +0 -1
- package/dist/utils/polling.d.ts +0 -32
- package/dist/utils/polling.d.ts.map +0 -1
- package/dist/utils/polling.js +0 -52
- package/dist/utils/polling.js.map +0 -1
- package/dist/utils/retry.js +0 -21
- package/dist/utils/retry.js.map +0 -1
- package/dist/webhooks/types.js +0 -3
- package/dist/webhooks/types.js.map +0 -1
- package/dist/webhooks/verify.js +0 -191
- package/dist/webhooks/verify.js.map +0 -1
|
@@ -1,384 +0,0 @@
|
|
|
1
|
-
import type { HttpClient } from '../client';
|
|
2
|
-
import type { EmitOptions, EmitAndWaitOptions, EmitResponse, DeriveOptions, DeriveResponse, CompareOptions, CompareBalances, CompareResponse, ReceiptResponse, CheckpointOptions, CheckpointResponse, ListCheckpointsOptions, ListCheckpointsResponse, DeltaStatusResponse, WaitForVerifiedOptions, UsageResponse, SequenceGapsOptions, SequenceGapsResponse, ListWebhookDeliveriesOptions, ListWebhookDeliveriesResponse, ListCustomersOptions, ListCustomersResponse, GetCustomerOptions, CustomerRecordDetail, InvoiceProofOptions, InvoiceProofResponse, CheckpointTimelineResponse, CheckpointDiffResponse, ListCheckpointTimelineOptions } from '../types/balance';
|
|
3
|
-
import type { RequestOptions } from '../types/config';
|
|
4
|
-
import type { CustomerUsageSummary, FlushSummariesOptions, QueuedUsageSummary, SubmissionAutomationOptions, SubmissionQueueState, SummaryFlushResult } from '../types/submission';
|
|
5
|
-
import { SubmissionCoordinator } from './submission';
|
|
6
|
-
import { ReceiptsResource } from './receipts';
|
|
7
|
-
type DeriveHelperOptions = RequestOptions & {
|
|
8
|
-
startingBalance?: number;
|
|
9
|
-
limit?: number;
|
|
10
|
-
offset?: number;
|
|
11
|
-
};
|
|
12
|
-
type ScopedReceiptOptions = InvoiceProofOptions & ({
|
|
13
|
-
period: string;
|
|
14
|
-
} | {
|
|
15
|
-
timePreset: NonNullable<InvoiceProofOptions['timePreset']>;
|
|
16
|
-
} | {
|
|
17
|
-
startDate: string;
|
|
18
|
-
} | {
|
|
19
|
-
endDate: string;
|
|
20
|
-
});
|
|
21
|
-
/**
|
|
22
|
-
* PacSpace Balance API resource.
|
|
23
|
-
*
|
|
24
|
-
* Provides methods for the five core Balance API operations:
|
|
25
|
-
* - `emit()` — Record a credit/debit delta
|
|
26
|
-
* - `emitAndWait()` — Record a delta and wait for verification
|
|
27
|
-
* - `derive()` — Derive balance from verified deltas
|
|
28
|
-
* - `compare()` — Compare balances against neutral truth
|
|
29
|
-
* - `receipt()` — Legacy receipt helper (customer-scoped proof generation)
|
|
30
|
-
* - `receipts.*` — Headless receipt document APIs by `receiptId`
|
|
31
|
-
* - `checkpoint()` — Commit a period-end checkpoint
|
|
32
|
-
*/
|
|
33
|
-
export declare class BalanceResource {
|
|
34
|
-
private readonly client;
|
|
35
|
-
/**
|
|
36
|
-
* Submission automation coordinator for tenant-produced summaries.
|
|
37
|
-
*/
|
|
38
|
-
readonly submission: SubmissionCoordinator;
|
|
39
|
-
/** Headless receipt helpers (get/list/preview/PDF/email). */
|
|
40
|
-
readonly receipts: ReceiptsResource;
|
|
41
|
-
/** @internal */
|
|
42
|
-
constructor(client: HttpClient, submissionOptions?: SubmissionAutomationOptions);
|
|
43
|
-
/**
|
|
44
|
-
* Record a credit or debit delta for a customer.
|
|
45
|
-
*
|
|
46
|
-
* The delta is queued, independently verified, and confirmed via webhook.
|
|
47
|
-
* Returns immediately with `status: 'QUEUED'`. Use `emitAndWait()` to
|
|
48
|
-
* block until verification completes.
|
|
49
|
-
*
|
|
50
|
-
* @param customerId - Unique identifier for the customer account.
|
|
51
|
-
* @param delta - Amount to adjust. Positive = credit, negative = debit.
|
|
52
|
-
* @param reason - Human-readable reason for the adjustment (audit trail).
|
|
53
|
-
* @param options - Optional reference ID, metadata, `adjusts` link, and request overrides.
|
|
54
|
-
* @returns The queued delta with its `receiptId`.
|
|
55
|
-
*
|
|
56
|
-
* @example
|
|
57
|
-
* ```typescript
|
|
58
|
-
* const delta = await pac.balance.emit('cust_123', -42.50, 'usage_charge');
|
|
59
|
-
* console.log(delta.receiptId); // Store this for verification
|
|
60
|
-
*
|
|
61
|
-
* const adjustment = await pac.balance.emit('cust_123', -10, 'adjustment', {
|
|
62
|
-
* adjusts: { referenceId: 'inv_001' },
|
|
63
|
-
* });
|
|
64
|
-
* ```
|
|
65
|
-
*/
|
|
66
|
-
emit(customerId: string, delta: number, reason: string, options?: EmitOptions): Promise<EmitResponse>;
|
|
67
|
-
/**
|
|
68
|
-
* Record a delta and wait for it to be verified.
|
|
69
|
-
*
|
|
70
|
-
* Combines `emit()` with status polling. Resolves when the delta reaches
|
|
71
|
-
* a terminal status (`VERIFIED` or `FAILED`), or throws `TimeoutError`
|
|
72
|
-
* if the timeout is exceeded.
|
|
73
|
-
*
|
|
74
|
-
* @param customerId - Unique identifier for the customer account.
|
|
75
|
-
* @param delta - Amount to adjust. Positive = credit, negative = debit.
|
|
76
|
-
* @param reason - Human-readable reason for the adjustment.
|
|
77
|
-
* @param options - Polling timeout, interval, and emit options.
|
|
78
|
-
* @returns The verified delta.
|
|
79
|
-
*
|
|
80
|
-
* @example
|
|
81
|
-
* ```typescript
|
|
82
|
-
* const verified = await pac.balance.emitAndWait('cust_123', -42.50, 'usage', {
|
|
83
|
-
* timeout: 30_000,
|
|
84
|
-
* pollInterval: 1000,
|
|
85
|
-
* });
|
|
86
|
-
* console.log(verified.status); // 'VERIFIED' or 'FAILED'
|
|
87
|
-
* ```
|
|
88
|
-
*/
|
|
89
|
-
emitAndWait(customerId: string, delta: number, reason: string, options?: EmitAndWaitOptions): Promise<EmitResponse>;
|
|
90
|
-
/**
|
|
91
|
-
* Check the status of a previously emitted delta.
|
|
92
|
-
*
|
|
93
|
-
* @param recordId - The record ID returned from emit.
|
|
94
|
-
* @param options - Request overrides.
|
|
95
|
-
* @returns Delta status with receipt and transaction details.
|
|
96
|
-
*
|
|
97
|
-
* @example
|
|
98
|
-
* ```typescript
|
|
99
|
-
* const status = await pac.balance.deltaStatus('rec_abc123');
|
|
100
|
-
* console.log(status.status); // 'QUEUED', 'PROCESSING', etc.
|
|
101
|
-
* ```
|
|
102
|
-
*/
|
|
103
|
-
deltaStatus(recordId: string, options?: RequestOptions): Promise<DeltaStatusResponse>;
|
|
104
|
-
/**
|
|
105
|
-
* Alias for `deltaStatus()` with lifecycle-oriented naming.
|
|
106
|
-
*/
|
|
107
|
-
getRecordStatus(recordId: string, options?: RequestOptions): Promise<DeltaStatusResponse>;
|
|
108
|
-
/**
|
|
109
|
-
* Poll record lifecycle until it reaches a terminal status.
|
|
110
|
-
*
|
|
111
|
-
* Terminal statuses are `VERIFIED` and `FAILED`.
|
|
112
|
-
*/
|
|
113
|
-
waitForVerified(recordId: string, options?: WaitForVerifiedOptions): Promise<DeltaStatusResponse>;
|
|
114
|
-
/**
|
|
115
|
-
* Retrieve tenant usage counters and remaining allotment.
|
|
116
|
-
*/
|
|
117
|
-
usage(options?: RequestOptions): Promise<UsageResponse>;
|
|
118
|
-
/**
|
|
119
|
-
* Detect missing per-customer sequence ranges.
|
|
120
|
-
*
|
|
121
|
-
* Use this to identify gaps and re-emit missing deltas safely.
|
|
122
|
-
*/
|
|
123
|
-
gaps(customerId: string, options?: SequenceGapsOptions): Promise<SequenceGapsResponse>;
|
|
124
|
-
/**
|
|
125
|
-
* Queue one tenant-produced summary for SDK-managed submission.
|
|
126
|
-
*/
|
|
127
|
-
queueSummary(summary: CustomerUsageSummary): QueuedUsageSummary;
|
|
128
|
-
/**
|
|
129
|
-
* Queue multiple tenant-produced summaries.
|
|
130
|
-
*/
|
|
131
|
-
queueSummaries(summaries: CustomerUsageSummary[]): QueuedUsageSummary[];
|
|
132
|
-
/**
|
|
133
|
-
* Flush queued summaries immediately.
|
|
134
|
-
*/
|
|
135
|
-
flushSummaries(options?: FlushSummariesOptions): Promise<SummaryFlushResult>;
|
|
136
|
-
/**
|
|
137
|
-
* Start periodic summary submission scheduling.
|
|
138
|
-
*/
|
|
139
|
-
startSummaryScheduler(): void;
|
|
140
|
-
/**
|
|
141
|
-
* Stop periodic summary submission scheduling.
|
|
142
|
-
*/
|
|
143
|
-
stopSummaryScheduler(): void;
|
|
144
|
-
/**
|
|
145
|
-
* Get queue/scheduler state for summary submission automation.
|
|
146
|
-
*/
|
|
147
|
-
getSummaryQueueState(): SubmissionQueueState;
|
|
148
|
-
/**
|
|
149
|
-
* Stop scheduler and flush queued summaries (best for graceful shutdown).
|
|
150
|
-
*/
|
|
151
|
-
shutdownSummaryScheduler(): Promise<void>;
|
|
152
|
-
/**
|
|
153
|
-
* Derive a customer's balance from all verified deltas.
|
|
154
|
-
*
|
|
155
|
-
* Any party can independently compute the same balance from the same deltas.
|
|
156
|
-
* Supports checkpointing to avoid replaying from genesis at scale.
|
|
157
|
-
*
|
|
158
|
-
* @param customerId - The customer account to derive balance for.
|
|
159
|
-
* @param options - Starting balance, checkpoint, and request overrides.
|
|
160
|
-
* @returns Derived balance with delta history and window summaries.
|
|
161
|
-
*
|
|
162
|
-
* @example
|
|
163
|
-
* ```typescript
|
|
164
|
-
* const { computedBalance, latestReceiptId } = await pac.balance.derive('cust_123');
|
|
165
|
-
*
|
|
166
|
-
* // Use checkpoint for efficient subsequent derivations:
|
|
167
|
-
* const next = await pac.balance.derive('cust_123', {
|
|
168
|
-
* startingBalance: computedBalance,
|
|
169
|
-
* startingCheckpoint: latestReceiptId,
|
|
170
|
-
* });
|
|
171
|
-
* ```
|
|
172
|
-
*/
|
|
173
|
-
derive(customerId: string, options?: DeriveOptions): Promise<DeriveResponse>;
|
|
174
|
-
/**
|
|
175
|
-
* Convenience helper for deriving the current UTC month.
|
|
176
|
-
*/
|
|
177
|
-
deriveCurrentMonth(customerId: string, options?: DeriveHelperOptions): Promise<DeriveResponse>;
|
|
178
|
-
/**
|
|
179
|
-
* Convenience helper for deriving a specific UTC month (`YYYY-MM`).
|
|
180
|
-
*/
|
|
181
|
-
deriveForPeriod(customerId: string, period: string, options?: DeriveHelperOptions): Promise<DeriveResponse>;
|
|
182
|
-
/**
|
|
183
|
-
* Convenience helper for deriving a rolling window of recent UTC months.
|
|
184
|
-
*
|
|
185
|
-
* For example, `months = 3` resolves from the start of month N-2 through the
|
|
186
|
-
* end of the current UTC month.
|
|
187
|
-
*/
|
|
188
|
-
deriveMonthsBack(customerId: string, months: number, options?: DeriveHelperOptions): Promise<DeriveResponse>;
|
|
189
|
-
/**
|
|
190
|
-
* Convenience helper for deriving the previous N UTC days.
|
|
191
|
-
*/
|
|
192
|
-
deriveDaysBack(customerId: string, days: number, options?: DeriveHelperOptions): Promise<DeriveResponse>;
|
|
193
|
-
/**
|
|
194
|
-
* Compare balances against neutral truth for dispute resolution.
|
|
195
|
-
*
|
|
196
|
-
* Submit your balance and your counterparty's balance. PacSpace derives
|
|
197
|
-
* the neutral truth from verified deltas and returns a discrepancy report
|
|
198
|
-
* showing which party matches and which window(s) diverged.
|
|
199
|
-
*
|
|
200
|
-
* @param customerId - The customer account to compare.
|
|
201
|
-
* @param balances - Your balance and their balance.
|
|
202
|
-
* @param options - Starting balance, checkpoint, and request overrides.
|
|
203
|
-
* @returns Comparison result with discrepancy report.
|
|
204
|
-
*
|
|
205
|
-
* @example
|
|
206
|
-
* ```typescript
|
|
207
|
-
* const report = await pac.balance.compare('cust_123', {
|
|
208
|
-
* yours: 95000,
|
|
209
|
-
* theirs: 98000,
|
|
210
|
-
* });
|
|
211
|
-
*
|
|
212
|
-
* if (report.matchesYours) {
|
|
213
|
-
* console.log('Your balance is correct');
|
|
214
|
-
* }
|
|
215
|
-
* ```
|
|
216
|
-
*/
|
|
217
|
-
compare(customerId: string, balances: CompareBalances, options?: CompareOptions): Promise<CompareResponse>;
|
|
218
|
-
/**
|
|
219
|
-
* Generate a verifiable receipt for a customer.
|
|
220
|
-
*
|
|
221
|
-
* When `options.period` is provided, returns a period-specific receipt (proof root,
|
|
222
|
-
* verifyUrl, verificationReference) suitable for sharing on invoices. When
|
|
223
|
-
* omitted, returns the full record receipt with all verified deltas.
|
|
224
|
-
*
|
|
225
|
-
* @param customerId - The customer account to generate a receipt for.
|
|
226
|
-
* @param options - Optional period (YYYY-MM) and request overrides.
|
|
227
|
-
* @returns Receipt with verification data; shape depends on whether period is set.
|
|
228
|
-
*
|
|
229
|
-
* @example
|
|
230
|
-
* ```typescript
|
|
231
|
-
* // Period-specific receipt (shareable proof for invoices)
|
|
232
|
-
* const receipt = await pac.balance.receipt('cust_123', { period: '2026-02' });
|
|
233
|
-
* console.log(receipt.proofRoot); // Include on invoice
|
|
234
|
-
* console.log(receipt.verifyUrl); // Share with counterparty
|
|
235
|
-
*
|
|
236
|
-
* // Full record receipt
|
|
237
|
-
* const full = await pac.balance.receipt('cust_123');
|
|
238
|
-
* console.log(full.finalBalance);
|
|
239
|
-
* ```
|
|
240
|
-
*/
|
|
241
|
-
receipt(customerId: string, options: ScopedReceiptOptions): Promise<InvoiceProofResponse>;
|
|
242
|
-
receipt(customerId: string, options?: RequestOptions): Promise<ReceiptResponse>;
|
|
243
|
-
/**
|
|
244
|
-
* @internal
|
|
245
|
-
* Generate a period-specific receipt (proof root, verifyUrl). Used by receipt().
|
|
246
|
-
*/
|
|
247
|
-
private receiptForPeriod;
|
|
248
|
-
/**
|
|
249
|
-
* Commit a period-end checkpoint.
|
|
250
|
-
*
|
|
251
|
-
* Computes a proof root over all verified deltas in the billing window
|
|
252
|
-
* and records it on the proof layer. The proof root can be
|
|
253
|
-
* included in invoices for instant counterparty verification.
|
|
254
|
-
*
|
|
255
|
-
* @param customerId - Customer to checkpoint (omit for all customers).
|
|
256
|
-
* @param options - Period (YYYY-MM) and request overrides.
|
|
257
|
-
* @returns Checkpoint details with proof root and status.
|
|
258
|
-
*
|
|
259
|
-
* @example
|
|
260
|
-
* ```typescript
|
|
261
|
-
* const checkpoint = await pac.balance.checkpoint('cust_123', {
|
|
262
|
-
* period: '2026-02',
|
|
263
|
-
* });
|
|
264
|
-
* console.log(checkpoint.proofRoot); // Include in your invoice
|
|
265
|
-
* ```
|
|
266
|
-
*/
|
|
267
|
-
checkpoint(customerId?: string, options?: CheckpointOptions): Promise<CheckpointResponse>;
|
|
268
|
-
/**
|
|
269
|
-
* List committed checkpoints for your tenant.
|
|
270
|
-
*
|
|
271
|
-
* Returns a paginated list of checkpoints, optionally filtered by
|
|
272
|
-
* customer ID and/or billing period.
|
|
273
|
-
*
|
|
274
|
-
* @param options - Filter and pagination options.
|
|
275
|
-
* @returns Paginated list of checkpoints.
|
|
276
|
-
*
|
|
277
|
-
* @example
|
|
278
|
-
* ```typescript
|
|
279
|
-
* const { checkpoints } = await pac.balance.listCheckpoints({
|
|
280
|
-
* period: '2026-02',
|
|
281
|
-
* limit: 10,
|
|
282
|
-
* });
|
|
283
|
-
* ```
|
|
284
|
-
*/
|
|
285
|
-
listCheckpoints(options?: ListCheckpointsOptions): Promise<ListCheckpointsResponse>;
|
|
286
|
-
/**
|
|
287
|
-
* List checkpoint timeline points and detected coverage gaps.
|
|
288
|
-
*/
|
|
289
|
-
listCheckpointTimeline(customerId: string, options?: ListCheckpointTimelineOptions): Promise<CheckpointTimelineResponse>;
|
|
290
|
-
/**
|
|
291
|
-
* Compare two checkpoints and return fingerprint and daily divergence deltas.
|
|
292
|
-
*/
|
|
293
|
-
diffCheckpoints(customerId: string, leftCheckpointId: string, rightCheckpointId: string, options?: RequestOptions): Promise<CheckpointDiffResponse>;
|
|
294
|
-
/**
|
|
295
|
-
* List webhook delivery history.
|
|
296
|
-
*
|
|
297
|
-
* @param options - Filter and pagination options.
|
|
298
|
-
* @returns Paginated list of webhook deliveries.
|
|
299
|
-
*
|
|
300
|
-
* @example
|
|
301
|
-
* ```typescript
|
|
302
|
-
* const { deliveries } = await pac.balance.listWebhookDeliveries({
|
|
303
|
-
* status: 'failed',
|
|
304
|
-
* limit: 10,
|
|
305
|
-
* });
|
|
306
|
-
* ```
|
|
307
|
-
*/
|
|
308
|
-
listWebhookDeliveries(options?: ListWebhookDeliveriesOptions): Promise<ListWebhookDeliveriesResponse>;
|
|
309
|
-
/**
|
|
310
|
-
* Retry a failed webhook delivery.
|
|
311
|
-
*
|
|
312
|
-
* @param eventId - The event ID of the failed delivery.
|
|
313
|
-
* @param options - Request overrides.
|
|
314
|
-
*
|
|
315
|
-
* @example
|
|
316
|
-
* ```typescript
|
|
317
|
-
* await pac.balance.retryWebhook('evt_abc123');
|
|
318
|
-
* ```
|
|
319
|
-
*/
|
|
320
|
-
retryWebhook(eventId: string, options?: RequestOptions): Promise<{
|
|
321
|
-
eventId: string;
|
|
322
|
-
status: string;
|
|
323
|
-
message: string;
|
|
324
|
-
}>;
|
|
325
|
-
/**
|
|
326
|
-
* List all customer balance records for your account.
|
|
327
|
-
*
|
|
328
|
-
* Each unique customerId passed to emit() automatically creates an
|
|
329
|
-
* isolated customer record. This method returns a paginated list.
|
|
330
|
-
*
|
|
331
|
-
* @param options - Search, pagination, and request overrides.
|
|
332
|
-
* @returns Paginated list of customer records.
|
|
333
|
-
*
|
|
334
|
-
* @example
|
|
335
|
-
* ```typescript
|
|
336
|
-
* const { customers } = await pac.balance.customers();
|
|
337
|
-
* for (const c of customers) {
|
|
338
|
-
* console.log(c.customerId, c.totalDeltas);
|
|
339
|
-
* }
|
|
340
|
-
* ```
|
|
341
|
-
*/
|
|
342
|
-
customers(options?: ListCustomersOptions): Promise<ListCustomersResponse>;
|
|
343
|
-
/**
|
|
344
|
-
* Get the full record detail for a specific customer.
|
|
345
|
-
*
|
|
346
|
-
* Returns the derived customer reference, computed balance, delta count,
|
|
347
|
-
* and latest checkpoint. The customer reference is deterministic.
|
|
348
|
-
*
|
|
349
|
-
* @param customerId - The customer to look up.
|
|
350
|
-
* @param options - Activity pagination and request overrides.
|
|
351
|
-
* @returns Customer detail including balance and references.
|
|
352
|
-
*
|
|
353
|
-
* @example
|
|
354
|
-
* ```typescript
|
|
355
|
-
* const customer = await pac.balance.customer('cust_001');
|
|
356
|
-
* console.log(customer.customerReference); // 0xA1b2...Ef34
|
|
357
|
-
* console.log(customer.computedBalance); // 4500.00
|
|
358
|
-
* ```
|
|
359
|
-
*/
|
|
360
|
-
customer(customerId: string, options?: GetCustomerOptions): Promise<CustomerRecordDetail>;
|
|
361
|
-
private normalizeEmitResponse;
|
|
362
|
-
private mergeEmitWithStatus;
|
|
363
|
-
private normalizeDeltaStatusResponse;
|
|
364
|
-
private normalizeDeriveResponse;
|
|
365
|
-
private normalizeCompareResponse;
|
|
366
|
-
private normalizeReceiptResponse;
|
|
367
|
-
private normalizeInvoiceProofResponse;
|
|
368
|
-
private normalizeCheckpointResponse;
|
|
369
|
-
private normalizeListCheckpointsResponse;
|
|
370
|
-
private normalizeSequenceGapsResponse;
|
|
371
|
-
private normalizeListCustomersResponse;
|
|
372
|
-
private normalizeCustomerDetailResponse;
|
|
373
|
-
/**
|
|
374
|
-
* Generate an invoice-ready receipt for a customer's billing period.
|
|
375
|
-
*
|
|
376
|
-
* @deprecated Use `receipt(customerId, { period })` instead.
|
|
377
|
-
* @param customerId - The customer to generate the receipt for.
|
|
378
|
-
* @param options - Period selection and request overrides.
|
|
379
|
-
* @returns Receipt with proof root, verifyUrl, and verification data.
|
|
380
|
-
*/
|
|
381
|
-
invoiceProof(customerId: string, options?: InvoiceProofOptions): Promise<InvoiceProofResponse>;
|
|
382
|
-
}
|
|
383
|
-
export {};
|
|
384
|
-
//# sourceMappingURL=balance.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"balance.d.ts","sourceRoot":"","sources":["../../src/resources/balance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,cAAc,EACd,eAAe,EACf,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,sBAAsB,EACtB,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,4BAA4B,EAC5B,6BAA6B,EAC7B,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,sBAAsB,EACtB,6BAA6B,EAC9B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,KAAK,EACV,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,2BAA2B,EAC3B,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAqB9C,KAAK,mBAAmB,GAAG,cAAc,GAAG;IAC1C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,oBAAoB,GAAG,mBAAmB,GAC7C,CACI;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAClB;IAAE,UAAU,EAAE,WAAW,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAA;CAAE,GAC9D;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GACrB;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CACtB,CAAC;AAEJ;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe;IAUxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IATzB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAC;IAC3C,6DAA6D;IAC7D,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IAEpC,gBAAgB;gBAEG,MAAM,EAAE,UAAU,EACnC,iBAAiB,CAAC,EAAE,2BAA2B;IAajD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,IAAI,CACR,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,YAAY,CAAC;IAqBxB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,WAAW,CACf,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,YAAY,CAAC;IA4BxB;;;;;;;;;;;;OAYG;IACG,WAAW,CACf,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAQ/B;;OAEG;IACG,eAAe,CACnB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAI/B;;;;OAIG;IACG,eAAe,CACnB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,mBAAmB,CAAC;IAkB/B;;OAEG;IACG,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAI7D;;;;OAIG;IACG,IAAI,CACR,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,oBAAoB,GAAG,kBAAkB;IAI/D;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,oBAAoB,EAAE,GAAG,kBAAkB,EAAE;IAIvE;;OAEG;IACG,cAAc,CAClB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAI9B;;OAEG;IACH,qBAAqB,IAAI,IAAI;IAI7B;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAI5B;;OAEG;IACH,oBAAoB,IAAI,oBAAoB;IAI5C;;OAEG;IACG,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ/C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,cAAc,CAAC;IAoD1B;;OAEG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,cAAc,CAAC;IAO1B;;OAEG;IACG,eAAe,CACnB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,cAAc,CAAC;IAO1B;;;;;OAKG;IACG,gBAAgB,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,cAAc,CAAC;IAqB1B;;OAEG;IACG,cAAc,CAClB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,cAAc,CAAC;IAgC1B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,OAAO,CACX,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,eAAe,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;IAmD3B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,OAAO,CACL,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,oBAAoB,CAAC;IAChC,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAuB/E;;;OAGG;YACW,gBAAgB;IAuB9B;;;;;;;;;;;;;;;;;;OAkBG;IACG,UAAU,CACd,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAgC9B;;;;;;;;;;;;;;;;OAgBG;IACG,eAAe,CACnB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,uBAAuB,CAAC;IAoBnC;;OAEG;IACG,sBAAsB,CAC1B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,6BAA6B,GACtC,OAAO,CAAC,0BAA0B,CAAC;IAatC;;OAEG;IACG,eAAe,CACnB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,iBAAiB,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAelC;;;;;;;;;;;;;OAaG;IACG,qBAAqB,CACzB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,6BAA6B,CAAC;IAczC;;;;;;;;;;OAUG;IACG,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAYhE;;;;;;;;;;;;;;;;OAgBG;IACG,SAAS,CACb,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,qBAAqB,CAAC;IAejC;;;;;;;;;;;;;;;;OAgBG;IACG,QAAQ,CACZ,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,oBAAoB,CAAC;IAehC,OAAO,CAAC,qBAAqB;IAsB7B,OAAO,CAAC,mBAAmB;IA8B3B,OAAO,CAAC,4BAA4B;IA+BpC,OAAO,CAAC,uBAAuB;IAgJ/B,OAAO,CAAC,wBAAwB;IAgFhC,OAAO,CAAC,wBAAwB;IAyBhC,OAAO,CAAC,6BAA6B;IA8CrC,OAAO,CAAC,2BAA2B;IA6BnC,OAAO,CAAC,gCAAgC;IA6CxC,OAAO,CAAC,6BAA6B;IA6BrC,OAAO,CAAC,8BAA8B;IA8BtC,OAAO,CAAC,+BAA+B;IA8CvC;;;;;;;OAOG;IACG,YAAY,CAChB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,oBAAoB,CAAC;CAGjC"}
|