@spritz-finance/service-client 0.19.0 → 0.21.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.
@@ -1,5 +1,5 @@
1
1
  export * as PlatformClient from "./platformServiceClient";
2
- import { CreateTokenizationData, CreateTokenizationRequest, IssueCardPayoutData, IssueCardPayoutRequest, IssuePayoutData, IssuePayoutRequest, MTBalancesData, PlaidTreasuryBalancesData, RelayCheckbookCardData, RelayCheckbookCardRequest, SendPaymentData, SendPaymentRequest, TabapayBalancesResponse, TabapayFundingRequirementResponse, ValidateBillData, ValidateBillRequest } from "./types";
2
+ import { CreateTokenizationData, CreateTokenizationRequest, IssueCardPayoutData, IssueCardPayoutRequest, IssuePayoutData, IssuePayoutRequest, IntegratorUsageKey, IntegratorUsageOperation, IntegratorUsageSummary, MTBalancesData, PlaidTreasuryBalancesData, RelayCheckbookCardData, RelayCheckbookCardRequest, ReleaseIntegratorUsageRequest, ReserveIntegratorUsageRequest, SendPaymentData, SendPaymentRequest, TabapayBalancesResponse, TabapayFundingRequirementResponse, ValidateBillData, ValidateBillRequest } from "./types";
3
3
  export declare function validateBill(request: ValidateBillRequest): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<ValidateBillData>>;
4
4
  export declare function tabapayBalances(): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<TabapayBalancesResponse>>;
5
5
  export declare function tabapayFundingRequirement(currency?: string): Promise<TabapayFundingRequirementResponse>;
@@ -33,3 +33,7 @@ export declare function relayCheckbookCard(request: RelayCheckbookCardRequest):
33
33
  * so no raw PAN reaches platform.
34
34
  */
35
35
  export declare function createTokenization(request: CreateTokenizationRequest): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<CreateTokenizationData>>;
36
+ export declare function reserveIntegratorUsage(request: ReserveIntegratorUsageRequest): Promise<IntegratorUsageOperation>;
37
+ export declare function commitIntegratorUsage(key: IntegratorUsageKey): Promise<IntegratorUsageOperation>;
38
+ export declare function releaseIntegratorUsage(request: ReleaseIntegratorUsageRequest): Promise<IntegratorUsageOperation>;
39
+ export declare function getIntegratorUsage(integratorId: string): Promise<IntegratorUsageSummary>;
@@ -47,6 +47,10 @@ exports.modernTreasuryBalances = modernTreasuryBalances;
47
47
  exports.plaidTreasuryBalances = plaidTreasuryBalances;
48
48
  exports.relayCheckbookCard = relayCheckbookCard;
49
49
  exports.createTokenization = createTokenization;
50
+ exports.reserveIntegratorUsage = reserveIntegratorUsage;
51
+ exports.commitIntegratorUsage = commitIntegratorUsage;
52
+ exports.releaseIntegratorUsage = releaseIntegratorUsage;
53
+ exports.getIntegratorUsage = getIntegratorUsage;
50
54
  exports.PlatformClient = __importStar(require("./platformServiceClient"));
51
55
  const axios_1 = __importDefault(require("axios"));
52
56
  // @ts-expect-error no type declarations for axios-token-interceptor
@@ -143,3 +147,28 @@ async function createTokenization(request) {
143
147
  .post(TOKENIZATIONS_ENDPOINT, request)
144
148
  .then((res) => res.data);
145
149
  }
150
+ const INTEGRATOR_USAGE_ENDPOINT = "/v1/integrator-usage";
151
+ async function reserveIntegratorUsage(request) {
152
+ return platformClient
153
+ .post(`${INTEGRATOR_USAGE_ENDPOINT}/reservations`, request)
154
+ .then((res) => res.data);
155
+ }
156
+ async function commitIntegratorUsage(key) {
157
+ const sourceSystem = encodeURIComponent(key.sourceSystem);
158
+ const operationId = encodeURIComponent(key.operationId);
159
+ return platformClient
160
+ .post(`${INTEGRATOR_USAGE_ENDPOINT}/reservations/${sourceSystem}/${operationId}/commit`, { integratorId: key.integratorId })
161
+ .then((res) => res.data);
162
+ }
163
+ async function releaseIntegratorUsage(request) {
164
+ const sourceSystem = encodeURIComponent(request.sourceSystem);
165
+ const operationId = encodeURIComponent(request.operationId);
166
+ return platformClient
167
+ .post(`${INTEGRATOR_USAGE_ENDPOINT}/reservations/${sourceSystem}/${operationId}/release`, { integratorId: request.integratorId, reason: request.reason })
168
+ .then((res) => res.data);
169
+ }
170
+ async function getIntegratorUsage(integratorId) {
171
+ return platformClient
172
+ .get(`${INTEGRATOR_USAGE_ENDPOINT}/integrators/${encodeURIComponent(integratorId)}`)
173
+ .then((res) => res.data);
174
+ }
@@ -208,3 +208,70 @@ export interface CreateTokenizationData {
208
208
  type: string;
209
209
  created_at: string;
210
210
  }
211
+ export type IntegratorUsageOperation = {
212
+ id: string;
213
+ integratorId: string;
214
+ sourceSystem: string;
215
+ operationId: string;
216
+ rail: string;
217
+ state: "reserved" | "committed" | "released";
218
+ sourceCurrency: string;
219
+ transactionPrincipalMinor: string;
220
+ lockedUsdPrincipal: string;
221
+ tier: string;
222
+ phase: string;
223
+ policyVersion: string;
224
+ reservationExpiresAt: string | null;
225
+ committedAt: string | null;
226
+ releasedAt: string | null;
227
+ releaseReason: string | null;
228
+ createdAt: string;
229
+ updatedAt: string;
230
+ };
231
+ export type ReserveIntegratorUsageRequest = {
232
+ integratorId: string;
233
+ sourceSystem: string;
234
+ operationId: string;
235
+ rail: string;
236
+ transactionPrincipalMinor: string;
237
+ sourceCurrency: string;
238
+ lockedUsdPrincipalCents: string;
239
+ reservationExpiresAt?: string;
240
+ };
241
+ export type IntegratorUsageKey = {
242
+ integratorId: string;
243
+ sourceSystem: string;
244
+ operationId: string;
245
+ };
246
+ export type ReleaseIntegratorUsageRequest = IntegratorUsageKey & {
247
+ reason: string;
248
+ };
249
+ export type IntegratorUsageSummary = {
250
+ integratorId: string;
251
+ policy: {
252
+ tier: string;
253
+ phase: string;
254
+ policyVersion: string;
255
+ liveMoneyAllowed: boolean;
256
+ liveMoneyBlockReason?: string;
257
+ planAdjustmentBps: number;
258
+ monthlyMinimumUsd: string;
259
+ developerLimits?: {
260
+ perTransactionUsd: string;
261
+ lifetimeTransactionCount: number;
262
+ lifetimeVolumeUsd: string;
263
+ };
264
+ launchStartedAt?: string;
265
+ launchEndsAt?: string;
266
+ decisionRequiredAt?: string;
267
+ };
268
+ committedTransactionCount: number;
269
+ committedVolumeUsd: string;
270
+ reservedTransactionCount: number;
271
+ reservedVolumeUsd: string;
272
+ currentMonthKey: string;
273
+ currentMonthCommittedCount: number;
274
+ currentMonthCommittedVolumeUsd: string;
275
+ remainingTransactionCount?: number;
276
+ remainingVolumeUsd?: string;
277
+ };
@@ -14,8 +14,15 @@ export declare function getSmartAccountAddress(input: {
14
14
  userId: string;
15
15
  usageType: SignerUsageType;
16
16
  }): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<`0x${string}`>>;
17
- export declare function createUserOpsSigner(input: {
17
+ /**
18
+ * Provisions the user's signer for `signerType` if they do not already have one
19
+ * and returns it. Turnkey bills per derived address, so signers are minted
20
+ * just-in-time by the first flow that needs one rather than at KYC — call this
21
+ * instead of `getUserOpsSigner` anywhere a missing signer should be created.
22
+ */
23
+ export declare function ensureUserOpsSigner(input: {
18
24
  userId: string;
19
- }): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<boolean>>;
25
+ signerType: OpsSignerType;
26
+ }): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<UserOpsSigner>>;
20
27
  export declare function buildSolanaPayment(input: SolanaPaymentBuildInput): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<SolanaPaymentBuildResult>>;
21
28
  export declare function listListedKaminoVaultIds(input?: ListListedKaminoVaultIdsInput): Promise<import("../types").ApiFailure | import("../types").ApiSuccess<ListListedKaminoVaultIdsResponse>>;
@@ -40,7 +40,7 @@ exports.getPortfolio = getPortfolio;
40
40
  exports.getUserOpsSigner = getUserOpsSigner;
41
41
  exports.getUserOpsSignerByAddress = getUserOpsSignerByAddress;
42
42
  exports.getSmartAccountAddress = getSmartAccountAddress;
43
- exports.createUserOpsSigner = createUserOpsSigner;
43
+ exports.ensureUserOpsSigner = ensureUserOpsSigner;
44
44
  exports.buildSolanaPayment = buildSolanaPayment;
45
45
  exports.listListedKaminoVaultIds = listListedKaminoVaultIds;
46
46
  exports.Web3Client = __importStar(require("./web3ServiceClient"));
@@ -77,9 +77,15 @@ async function getSmartAccountAddress(input) {
77
77
  .get(`${WEB3_ENDPOINT}/ops-signer/smart-account/${input.userId}?usageType=${input.usageType}`)
78
78
  .then((res) => res.data);
79
79
  }
80
- async function createUserOpsSigner(input) {
80
+ /**
81
+ * Provisions the user's signer for `signerType` if they do not already have one
82
+ * and returns it. Turnkey bills per derived address, so signers are minted
83
+ * just-in-time by the first flow that needs one rather than at KYC — call this
84
+ * instead of `getUserOpsSigner` anywhere a missing signer should be created.
85
+ */
86
+ async function ensureUserOpsSigner(input) {
81
87
  return serviceClient_1.baseClient
82
- .post(`${WEB3_ENDPOINT}/ops-signer/user/${input.userId}`)
88
+ .post(`${WEB3_ENDPOINT}/ops-signer/user/${input.userId}?signerType=${input.signerType}`)
83
89
  .then((res) => res.data);
84
90
  }
85
91
  async function buildSolanaPayment(input) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spritz-finance/service-client",
3
- "version": "0.19.0",
3
+ "version": "0.21.0",
4
4
  "gitHead": "06f8e96b7b38c34df26a38da329331940675e4f8",
5
5
  "description": "Service client",
6
6
  "license": "ISC",