@opengov/ppf-backend-types - npm Package Compare versions

Comparing version 1.8.4 to 1.8.5-beta.122.1.0

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+## [1.8.5-beta.122.1.0](https://github.com/OpenGov/pluggable-payments/compare/@opengov/ppf-backend-types@1.8.4...@opengov/ppf-backend-types@1.8.5-beta.122.1.0) (2024-02-09)
+
+**Note:** Version bump only for package @opengov/ppf-backend-types
+
+
+
+
+
 ## [1.8.4](https://github.com/OpenGov/pluggable-payments/compare/@opengov/ppf-backend-types@1.8.3...@opengov/ppf-backend-types@1.8.4) (2024-01-29)
@@ -8,0 +16,0 @@

dist/types/generated.d.ts

@@ -42,2 +42,14 @@ import { PaymentProcessorFlow } from "./enums";
 };
+export type ApplicationMetadataResponse = {
+    __typename?: "ApplicationMetadataResponse";
+    community?: Maybe<Scalars["String"]>;
+    departmentID?: Maybe<Scalars["ID"]>;
+    departmentName?: Maybe<Scalars["String"]>;
+    paymentID?: Maybe<Scalars["String"]>;
+    paymentMethod?: Maybe<Scalars["String"]>;
+    recordNo?: Maybe<Scalars["String"]>;
+    recordStepID?: Maybe<Scalars["String"]>;
+    recordType?: Maybe<Scalars["String"]>;
+    recordTypeID?: Maybe<Scalars["String"]>;
+};
 export type Card = {
@@ -89,2 +101,8 @@ __typename?: "Card";
 };
+export type FeeItemResponse = {
+    __typename?: "FeeItemResponse";
+    feeAccountNumber?: Maybe<Scalars["String"]>;
+    feeAmount?: Maybe<Scalars["Float"]>;
+    feeTitle?: Maybe<Scalars["String"]>;
+};
 /** Represents a successful grant with a token */
@@ -159,2 +177,4 @@ export type FlowGrant = {
     futurePayment: FlowGrantResponse;
+    /** Requests a grant based on an idempotecy key. */
+    getMetadata?: Maybe<PaymentMetadataResponse>;
     /** Requests a grant to perform the OFFLINE_PAYMENT flow. */
@@ -183,2 +203,5 @@ offlinePayment: FlowGrantResponse;
 };
+export type MutationgetMetadataArgs = {
+    idempotencyKey?: InputMaybe<Scalars["String"]>;
+};
 export type MutationofflinePaymentArgs = {
@@ -306,2 +329,3 @@ request?: InputMaybe<OfflinePaymentFlowRequest>;
     flowType: PaymentProcessorFlow;
+    idempotencyKey?: Maybe<Scalars["String"]>;
     paymentID: Scalars["ID"];
@@ -327,2 +351,19 @@ paymentMethodDetails: PaymentMethodDetails;
 export { OpenGovTenant };
+export type PaymentMetadataResponse = {
+    __typename?: "PaymentMetadataResponse";
+    amount: Scalars["Float"];
+    applicationMetadata?: Maybe<ApplicationMetadataResponse>;
+    currency: Scalars["String"];
+    description: Scalars["String"];
+    entityID: Scalars["String"];
+    idempotencyKey?: Maybe<Scalars["String"]>;
+    items?: Maybe<Array<Maybe<FeeItemResponse>>>;
+    paymentID: Scalars["String"];
+    paymentMethod: PaymentMethod;
+    processingFee: Scalars["Float"];
+    processorID: PaymentProcessorId;
+    sourceApp: Scalars["String"];
+    tenantID?: Maybe<Scalars["String"]>;
+    userID: Scalars["ID"];
+};
 export { PaymentMethod };
@@ -396,3 +437,3 @@ export type PaymentMethodDetails = Card | ECheck;
 export type TerminalPaymentFlowRequest = {
-    /**  Amount to be paid  */
+    /** Amount to be paid */
     amount: Scalars["Float"];
@@ -402,20 +443,20 @@ applicationMetadata?: InputMaybe<ApplicationMetadata>;
     description?: InputMaybe<Scalars["String"]>;
-    /**  Integrator system or client system or tenant  */
+    /** Integrator system or client system or tenant */
     entityID: Scalars["String"];
-    /**  Unique payent transaction reference in integrator system  */
+    /** Unique payent transaction reference in integrator system */
     paymentID: Scalars["String"];
-    /**  Type of payment channel for transaction  */
+    /** Type of payment channel for transaction */
     paymentMethod: PaymentMethod;
-    /**  Processing fee to be paid  */
+    /** Processing fee to be paid */
     processingFee?: InputMaybe<Scalars["Float"]>;
-    /**  Payment plug processor  */
+    /** Payment plug processor */
     processorId: PaymentProcessorId;
     sourceApp?: InputMaybe<Scalars["String"]>;
-    /**  Identifier for terminal device  */
+    /** Identifier for terminal device */
     terminalID: Scalars["String"];
-    /**  Options if need to mention for terminal device  */
+    /** Options if need to mention for terminal device */
     terminalOptions?: InputMaybe<Scalars["String"]>;
-    /**  Type of terminal device  */
+    /** Type of terminal device */
     terminalType: Scalars["String"];
-    /**  User initiating or on behalf of whom the payment is being made  */
+    /** User initiating or on behalf of whom the payment is being made */
     userId: Scalars["ID"];
@@ -422,0 +463,0 @@ };

package.json

 {
   "name": "@opengov/ppf-backend-types",
-  "version": "1.8.4",
+  "version": "1.8.5-beta.122.1.0",
   "description": "PPF Backend types",
@@ -20,3 +20,3 @@ "homepage": "https://github.com/OpenGov/pluggable-payments#readme",
     "@opengov/plc-fastify-auth-plugin": "0.0.9",
-    "@opengov/ppf-backend-graphql-schema": "^0.6.4"
+    "@opengov/ppf-backend-graphql-schema": "^0.6.5-beta.122.1.0"
   },
@@ -38,3 +38,3 @@ "repository": {
   },
-  "gitHead": "cc25e4b2a37c21746f842177ee236825866145bc"
+  "gitHead": "07f1cbc85f7f65a754cf161dd1ac8115bee0e8e3"
 }

src/types/generated.ts

@@ -42,2 +42,15 @@ import { PaymentProcessorFlow } from "./enums";
 
+export type ApplicationMetadataResponse = {
+  __typename?: "ApplicationMetadataResponse";
+  community?: Maybe<Scalars["String"]>;
+  departmentID?: Maybe<Scalars["ID"]>;
+  departmentName?: Maybe<Scalars["String"]>;
+  paymentID?: Maybe<Scalars["String"]>;
+  paymentMethod?: Maybe<Scalars["String"]>;
+  recordNo?: Maybe<Scalars["String"]>;
+  recordStepID?: Maybe<Scalars["String"]>;
+  recordType?: Maybe<Scalars["String"]>;
+  recordTypeID?: Maybe<Scalars["String"]>;
+};
+
 export type Card = {
@@ -99,2 +112,9 @@ __typename?: "Card";
 
+export type FeeItemResponse = {
+  __typename?: "FeeItemResponse";
+  feeAccountNumber?: Maybe<Scalars["String"]>;
+  feeAmount?: Maybe<Scalars["Float"]>;
+  feeTitle?: Maybe<Scalars["String"]>;
+};
+
 /** Represents a successful grant with a token */
@@ -196,2 +216,4 @@ export type FlowGrant = {
   futurePayment: FlowGrantResponse;
+  /** Requests a grant based on an idempotecy key. */
+  getMetadata?: Maybe<PaymentMetadataResponse>;
   /** Requests a grant to perform the OFFLINE_PAYMENT flow. */
@@ -223,2 +245,6 @@ offlinePayment: FlowGrantResponse;
 
+export type MutationgetMetadataArgs = {
+  idempotencyKey?: InputMaybe<Scalars["String"]>;
+};
+
 export type MutationofflinePaymentArgs = {
@@ -361,2 +387,3 @@ request?: InputMaybe<OfflinePaymentFlowRequest>;
   flowType: PaymentProcessorFlow;
+  idempotencyKey?: Maybe<Scalars["String"]>;
   paymentID: Scalars["ID"];
@@ -386,2 +413,20 @@ paymentMethodDetails: PaymentMethodDetails;
 
+export type PaymentMetadataResponse = {
+  __typename?: "PaymentMetadataResponse";
+  amount: Scalars["Float"];
+  applicationMetadata?: Maybe<ApplicationMetadataResponse>;
+  currency: Scalars["String"];
+  description: Scalars["String"];
+  entityID: Scalars["String"];
+  idempotencyKey?: Maybe<Scalars["String"]>;
+  items?: Maybe<Array<Maybe<FeeItemResponse>>>;
+  paymentID: Scalars["String"];
+  paymentMethod: PaymentMethod;
+  processingFee: Scalars["Float"];
+  processorID: PaymentProcessorId;
+  sourceApp: Scalars["String"];
+  tenantID?: Maybe<Scalars["String"]>;
+  userID: Scalars["ID"];
+};
+
 export { PaymentMethod };
@@ -469,3 +514,3 @@
 export type TerminalPaymentFlowRequest = {
-  /**  Amount to be paid  */
+  /** Amount to be paid */
   amount: Scalars["Float"];
@@ -475,20 +520,20 @@ applicationMetadata?: InputMaybe<ApplicationMetadata>;
   description?: InputMaybe<Scalars["String"]>;
-  /**  Integrator system or client system or tenant  */
+  /** Integrator system or client system or tenant */
   entityID: Scalars["String"];
-  /**  Unique payent transaction reference in integrator system  */
+  /** Unique payent transaction reference in integrator system */
   paymentID: Scalars["String"];
-  /**  Type of payment channel for transaction  */
+  /** Type of payment channel for transaction */
   paymentMethod: PaymentMethod;
-  /**  Processing fee to be paid  */
+  /** Processing fee to be paid */
   processingFee?: InputMaybe<Scalars["Float"]>;
-  /**  Payment plug processor  */
+  /** Payment plug processor */
   processorId: PaymentProcessorId;
   sourceApp?: InputMaybe<Scalars["String"]>;
-  /**  Identifier for terminal device  */
+  /** Identifier for terminal device */
   terminalID: Scalars["String"];
-  /**  Options if need to mention for terminal device  */
+  /** Options if need to mention for terminal device */
   terminalOptions?: InputMaybe<Scalars["String"]>;
-  /**  Type of terminal device  */
+  /** Type of terminal device */
   terminalType: Scalars["String"];
-  /**  User initiating or on behalf of whom the payment is being made  */
+  /** User initiating or on behalf of whom the payment is being made */
   userId: Scalars["ID"];
@@ -495,0 +540,0 @@ };

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

149355

increased by3.53%

Lines of code

1293

increased by6.77%

Worsened metrics

Number of low quality alerts

2

increased by100%

Dependency changes

• Updated@opengov/ppf-backend-graphql-schema@^0.6.5-beta.122.1.0