@interledger/open-payments - npm Package Compare versions

Comparing version 6.10.0 to 6.11.0

dist/openapi/generated/resource-server-types.d.ts

@@ -194,2 +194,51 @@ /**
         /**
+         * Outgoing Payment With Grant Spent Amounts
+         * @description An **outgoing payment** resource represents a payment that will be, is currently being, or has previously been, sent from the wallet address.
+         */
+        "outgoing-payment-with-spent-amounts": {
+            /**
+             * Format: uri
+             * @description The URL identifying the outgoing payment.
+             */
+            id: string;
+            /**
+             * Format: uri
+             * @description The URL of the wallet address from which this payment is sent.
+             */
+            walletAddress: string;
+            /**
+             * Format: uri
+             * @description The URL of the quote defining this payment's amounts.
+             */
+            quoteId?: string;
+            /** @description Describes whether the payment failed to send its full amount. */
+            failed?: boolean;
+            /** @description The URL of the incoming payment that is being paid. */
+            receiver: external["schemas.yaml"]["components"]["schemas"]["receiver"];
+            /** @description The total amount that should be received by the receiver when this outgoing payment has been paid. */
+            receiveAmount: external["schemas.yaml"]["components"]["schemas"]["amount"];
+            /** @description The total amount that should be deducted from the sender's account when this outgoing payment has been paid. */
+            debitAmount: external["schemas.yaml"]["components"]["schemas"]["amount"];
+            /** @description The total amount that has been sent under this outgoing payment. */
+            sentAmount: external["schemas.yaml"]["components"]["schemas"]["amount"];
+            /** @description The total amount successfully deducted from the sender's account using the current outgoing payment grant. */
+            grantSpentDebitAmount?: external["schemas.yaml"]["components"]["schemas"]["amount"];
+            /** @description The total amount successfully received (by all receivers) using the current outgoing payment grant. */
+            grantSpentReceiveAmount?: external["schemas.yaml"]["components"]["schemas"]["amount"];
+            /** @description Additional metadata associated with the outgoing payment. (Optional) */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Format: date-time
+             * @description The date and time when the outgoing payment was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description The date and time when the outgoing payment was updated.
+             */
+            updatedAt: string;
+        };
+        /**
          * Quote
@@ -413,3 +462,3 @@ * @description A **quote** resource represents the quoted amount details with which an Outgoing Payment may be created.
                 content: {
-                    "application/json": components["schemas"]["outgoing-payment"];
+                    "application/json": components["schemas"]["outgoing-payment-with-spent-amounts"];
                 };
@@ -416,0 +465,0 @@ };

dist/test/helpers.d.ts

 import { createHttpClient } from '../client/requests';
-import { IncomingPayment, GrantRequest, GrantContinuationRequest, OutgoingPayment, OutgoingPaymentPaginationResult, WalletAddress, JWK, AccessToken, Quote, IncomingPaymentPaginationResult, PendingGrant, Grant, IncomingPaymentWithPaymentMethods, IlpPaymentMethod, PublicIncomingPayment, DIDDocument } from '../types';
+import { IncomingPayment, GrantRequest, GrantContinuationRequest, OutgoingPayment, OutgoingPaymentPaginationResult, WalletAddress, JWK, AccessToken, Quote, IncomingPaymentPaginationResult, PendingGrant, Grant, IncomingPaymentWithPaymentMethods, IlpPaymentMethod, PublicIncomingPayment, DIDDocument, OutgoingPaymentWithSpentAmounts } from '../types';
 import { ResponseValidator } from '@interledger/openapi';
@@ -23,2 +23,3 @@ import { BaseDeps } from '../client';
 export declare const mockOutgoingPayment: (overrides?: Partial<OutgoingPayment>) => OutgoingPayment;
+export declare const mockOutgoingPaymentWithSpentAmounts: (overrides?: Partial<OutgoingPaymentWithSpentAmounts>) => OutgoingPaymentWithSpentAmounts;
 export declare const mockOutgoingPaymentPaginationResult: (overrides?: Partial<OutgoingPaymentPaginationResult>) => OutgoingPaymentPaginationResult;
@@ -25,0 +26,0 @@ export declare const mockPendingGrant: (overrides?: Partial<PendingGrant>) => PendingGrant;

dist/test/helpers.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTestDeps = exports.mockQuote = exports.mockAccessToken = exports.mockContinuationRequest = exports.mockGrantRequest = exports.mockGrant = exports.mockPendingGrant = exports.mockOutgoingPaymentPaginationResult = exports.mockOutgoingPayment = exports.mockIncomingPaymentPaginationResult = exports.mockIlpPaymentMethod = exports.mockPublicIncomingPayment = exports.mockIncomingPaymentWithPaymentMethods = exports.mockIncomingPayment = exports.mockWalletAddress = exports.mockDIDDocument = exports.mockJwk = exports.mockOpenApiResponseValidators = exports.getDefaultHttpClient = exports.keyId = exports.silentLogger = void 0;
+exports.createTestDeps = exports.mockQuote = exports.mockAccessToken = exports.mockContinuationRequest = exports.mockGrantRequest = exports.mockGrant = exports.mockPendingGrant = exports.mockOutgoingPaymentPaginationResult = exports.mockOutgoingPaymentWithSpentAmounts = exports.mockOutgoingPayment = exports.mockIncomingPaymentPaginationResult = exports.mockIlpPaymentMethod = exports.mockPublicIncomingPayment = exports.mockIncomingPaymentWithPaymentMethods = exports.mockIncomingPayment = exports.mockWalletAddress = exports.mockDIDDocument = exports.mockJwk = exports.mockOpenApiResponseValidators = exports.getDefaultHttpClient = exports.keyId = exports.silentLogger = void 0;
 const crypto_1 = require("crypto");
@@ -159,2 +159,17 @@ const pino_1 = __importDefault(require("pino"));
 exports.mockOutgoingPayment = mockOutgoingPayment;
+const mockOutgoingPaymentWithSpentAmounts = (overrides) => ({
+    ...(0, exports.mockOutgoingPayment)(),
+    grantSpentDebitAmount: {
+        assetCode: 'USD',
+        assetScale: 2,
+        value: '10'
+    },
+    grantSpentReceiveAmount: {
+        assetCode: 'USD',
+        assetScale: 2,
+        value: '10'
+    },
+    ...overrides
+});
+exports.mockOutgoingPaymentWithSpentAmounts = mockOutgoingPaymentWithSpentAmounts;
 const mockOutgoingPaymentPaginationResult = (overrides) => {
@@ -161,0 +176,0 @@ const result = overrides?.result || [

dist/types.d.ts

@@ -20,2 +20,3 @@ import { components as RSComponents, paths as RSPaths, operations as RSOperations } from './openapi/generated/resource-server-types';
 export type OutgoingPayment = RSComponents['schemas']['outgoing-payment'];
+export type OutgoingPaymentWithSpentAmounts = RSComponents['schemas']['outgoing-payment-with-spent-amounts'];
 export type CreateOutgoingPaymentArgs = RSOperations['create-outgoing-payment']['requestBody']['content']['application/json'];
@@ -22,0 +23,0 @@ type PaginationResult<T> = {

package.json

 {
   "name": "@interledger/open-payments",
-  "version": "6.10.0",
+  "version": "6.11.0",
   "description": "Tools for interacting with the Open Payments API",
@@ -5,0 +5,0 @@ "author": "Interledger Tech Team <[e-mail]>",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

257651

increased by3.38%

Lines of code

2998

increased by2.25%

No dependency changes