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

Comparing version 1.6.2 to 1.7.0

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+# [1.7.0](https://github.com/OpenGov/pluggable-payments/compare/@opengov/ppf-backend-types@1.6.2...@opengov/ppf-backend-types@1.7.0) (2024-01-12)
+
+
+### Features
+
+* **orbipay:** API to update payment status [CIT 7992 + 8480] ([#164](https://github.com/OpenGov/pluggable-payments/issues/164)) ([6d62f17](https://github.com/OpenGov/pluggable-payments/commit/6d62f17aea8095001bc68f4e1531b396c92d1712))
+
+
+
+
+
 ## [1.6.2](https://github.com/OpenGov/pluggable-payments/compare/@opengov/ppf-backend-types@1.6.1...@opengov/ppf-backend-types@1.6.2) (2024-01-12)
@@ -8,0 +19,0 @@

dist/types/enums.d.ts

@@ -9,3 +9,4 @@ export declare enum PaymentProcessorFlow {
     ONE_TIME_PAYMENT = "ONE_TIME_PAYMENT",
-    OFFLINE_PAYMENT = "OFFLINE_PAYMENT"
+    OFFLINE_PAYMENT = "OFFLINE_PAYMENT",
+    UPDATE_PAYMENT = "UPDATE_PAYMENT"
 }
@@ -40,2 +41,12 @@ export declare enum ConfigScope {
 }
+export declare enum OpenGovTenant {
+    plc = "plc"
+}
+export declare enum TransactionStatus {
+    SUCCEDED = 1,
+    PENDING = 2,
+    FAILED = 3,
+    DISPUTED = 4,
+    LOST = 5
+}
 //# sourceMappingURL=enums.d.ts.map

dist/types/enums.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaymentProcessorId = exports.PaymentStatus = exports.ConfigAction = exports.ImplementationTeam = exports.PaymentMethod = exports.ConfigScope = exports.PaymentProcessorFlow = void 0;
+exports.TransactionStatus = exports.OpenGovTenant = exports.PaymentProcessorId = exports.PaymentStatus = exports.ConfigAction = exports.ImplementationTeam = exports.PaymentMethod = exports.ConfigScope = exports.PaymentProcessorFlow = void 0;
 var PaymentProcessorFlow;
@@ -14,2 +14,3 @@ (function (PaymentProcessorFlow) {
     PaymentProcessorFlow["OFFLINE_PAYMENT"] = "OFFLINE_PAYMENT";
+    PaymentProcessorFlow["UPDATE_PAYMENT"] = "UPDATE_PAYMENT";
 })(PaymentProcessorFlow || (exports.PaymentProcessorFlow = PaymentProcessorFlow = {}));
@@ -50,2 +51,14 @@ var ConfigScope;
 })(PaymentProcessorId || (exports.PaymentProcessorId = PaymentProcessorId = {}));
+var OpenGovTenant;
+(function (OpenGovTenant) {
+    OpenGovTenant["plc"] = "plc";
+})(OpenGovTenant || (exports.OpenGovTenant = OpenGovTenant = {}));
+var TransactionStatus;
+(function (TransactionStatus) {
+    TransactionStatus[TransactionStatus["SUCCEDED"] = 1] = "SUCCEDED";
+    TransactionStatus[TransactionStatus["PENDING"] = 2] = "PENDING";
+    TransactionStatus[TransactionStatus["FAILED"] = 3] = "FAILED";
+    TransactionStatus[TransactionStatus["DISPUTED"] = 4] = "DISPUTED";
+    TransactionStatus[TransactionStatus["LOST"] = 5] = "LOST";
+})(TransactionStatus || (exports.TransactionStatus = TransactionStatus = {}));
 //# sourceMappingURL=enums.js.map

dist/types/generated.d.ts

@@ -170,3 +170,3 @@ import type { PaymentProcessorFlow } from "./enums";
 };
-export type FlowValidationResponse = OnlinePaymentFlowResponse | OnlineRefundFlowResponse | OfflineRefundFlowResponse | OfflinePaymentFlowResponse | TerminalPaymentFlowResponse | OneTimePaymentFlowResponse | FuturePaymentFlowResponse | ConfigPluginFlowResponse | InvalidSignature | InvalidFlowResult;
+export type FlowValidationResponse = OnlinePaymentFlowResponse | OnlineRefundFlowResponse | OfflineRefundFlowResponse | OfflinePaymentFlowResponse | TerminalPaymentFlowResponse | OneTimePaymentFlowResponse | FuturePaymentFlowResponse | ConfigPluginFlowResponse | UpdatePaymentFlowResponse | InvalidSignature | InvalidFlowResult;
 export type Mutation = {
@@ -190,2 +190,4 @@ __typename?: "Mutation";
     configPlugin: FlowGrantResponse;
+    /** Requests a grant to perform the update of a payment */
+    updatePayment: FlowGrantResponse;
     /** Requests validation of a signed JWT */
@@ -218,2 +220,5 @@ validateFlowResult: FlowValidationResponse;
 };
+export type MutationupdatePaymentArgs = {
+    request?: InputMaybe<UpdatePaymentFlowRequest>;
+};
 export type MutationvalidateFlowResultArgs = {
@@ -380,2 +385,26 @@ flowType?: InputMaybe<PaymentProcessorFlow>;
 };
+export type UpdatePaymentFlowRequest = {
+    processorID: PaymentProcessorId;
+    entityID: Scalars["String"];
+    status: TransactionStatus;
+    tenantID: OpenGovTenant;
+    paymentID: Scalars["ID"];
+    transactionID?: InputMaybe<Scalars["String"]>;
+    amount?: InputMaybe<Scalars["Float"]>;
+    processingFee?: InputMaybe<Scalars["Float"]>;
+    currency?: InputMaybe<Scalars["String"]>;
+};
+export type UpdatePaymentFlowResponse = FlowResponseType & {
+    __typename?: "UpdatePaymentFlowResponse";
+    flowType: PaymentProcessorFlow;
+    processorID: PaymentProcessorId;
+    entityID: Scalars["String"];
+    status: TransactionStatus;
+    tenantID: OpenGovTenant;
+    paymentID: Scalars["ID"];
+    transactionID?: Maybe<Scalars["String"]>;
+    amount?: Maybe<Scalars["Float"]>;
+    processingFee?: Maybe<Scalars["Float"]>;
+    currency?: Maybe<Scalars["String"]>;
+};
 export type Header = {
@@ -425,2 +454,12 @@ alg?: InputMaybe<Scalars["String"]>;
 export { PaymentProcessorId };
+export declare enum OpenGovTenant {
+    plc = "plc"
+}
+export declare enum TransactionStatus {
+    SUCCEDED = "SUCCEDED",
+    PENDING = "PENDING",
+    FAILED = "FAILED",
+    DISPUTED = "DISPUTED",
+    LOST = "LOST"
+}
 export type FlowGrantResponse = FlowGrant | FlowUnsupported | FlowRequestInvalid;
@@ -465,3 +504,3 @@ export type PaymentMethodDetails = Card | ECheck;
         paymentMethodDetails?: Maybe<ResolversTypes["PaymentMethodDetails"]>;
-    }) | ConfigPluginFlowResponse | InvalidSignature | InvalidFlowResult;
+    }) | ConfigPluginFlowResponse | UpdatePaymentFlowResponse | InvalidSignature | InvalidFlowResult;
     FlowGrantResponse: FlowGrant | FlowUnsupported | FlowRequestInvalid;
@@ -482,3 +521,3 @@ PaymentMethodDetails: Card | ECheck;
         paymentMethodDetails?: Maybe<ResolversParentTypes["PaymentMethodDetails"]>;
-    }) | ConfigPluginFlowResponse | InvalidSignature | InvalidFlowResult;
+    }) | ConfigPluginFlowResponse | UpdatePaymentFlowResponse | InvalidSignature | InvalidFlowResult;
     FlowGrantResponse: FlowGrant | FlowUnsupported | FlowRequestInvalid;
@@ -510,3 +549,3 @@ PaymentMethodDetails: Card | ECheck;
     Float: ResolverTypeWrapper<Scalars["Float"]>;
-    FlowResponseType: ResolversTypes["OnlinePaymentFlowResponse"] | ResolversTypes["OnlineRefundFlowResponse"] | ResolversTypes["OfflineRefundFlowResponse"] | ResolversTypes["OfflinePaymentFlowResponse"] | ResolversTypes["TerminalPaymentFlowResponse"] | ResolversTypes["OneTimePaymentFlowResponse"] | ResolversTypes["FuturePaymentFlowResponse"] | ResolversTypes["ConfigPluginFlowResponse"];
+    FlowResponseType: ResolversTypes["OnlinePaymentFlowResponse"] | ResolversTypes["OnlineRefundFlowResponse"] | ResolversTypes["OfflineRefundFlowResponse"] | ResolversTypes["OfflinePaymentFlowResponse"] | ResolversTypes["TerminalPaymentFlowResponse"] | ResolversTypes["OneTimePaymentFlowResponse"] | ResolversTypes["FuturePaymentFlowResponse"] | ResolversTypes["ConfigPluginFlowResponse"] | ResolversTypes["UpdatePaymentFlowResponse"];
     PaymentProcessorFlow: PaymentProcessorFlow;
@@ -542,2 +581,4 @@ OnlinePaymentFlowRequest: OnlinePaymentFlowRequest;
     ConfigPluginFlowResponse: ResolverTypeWrapper<ConfigPluginFlowResponse>;
+    UpdatePaymentFlowRequest: UpdatePaymentFlowRequest;
+    UpdatePaymentFlowResponse: ResolverTypeWrapper<UpdatePaymentFlowResponse>;
     Header: Header;
@@ -554,2 +595,4 @@ Signature: Signature;
     PaymentProcessorId: PaymentProcessorId;
+    OpenGovTenant: OpenGovTenant;
+    TransactionStatus: TransactionStatus;
     FlowGrantResponse: ResolverTypeWrapper<ResolversUnionTypes["FlowGrantResponse"]>;
@@ -581,3 +624,3 @@ PaymentMethodDetails: ResolverTypeWrapper<ResolversUnionTypes["PaymentMethodDetails"]>;
     Float: Scalars["Float"];
-    FlowResponseType: ResolversParentTypes["OnlinePaymentFlowResponse"] | ResolversParentTypes["OnlineRefundFlowResponse"] | ResolversParentTypes["OfflineRefundFlowResponse"] | ResolversParentTypes["OfflinePaymentFlowResponse"] | ResolversParentTypes["TerminalPaymentFlowResponse"] | ResolversParentTypes["OneTimePaymentFlowResponse"] | ResolversParentTypes["FuturePaymentFlowResponse"] | ResolversParentTypes["ConfigPluginFlowResponse"];
+    FlowResponseType: ResolversParentTypes["OnlinePaymentFlowResponse"] | ResolversParentTypes["OnlineRefundFlowResponse"] | ResolversParentTypes["OfflineRefundFlowResponse"] | ResolversParentTypes["OfflinePaymentFlowResponse"] | ResolversParentTypes["TerminalPaymentFlowResponse"] | ResolversParentTypes["OneTimePaymentFlowResponse"] | ResolversParentTypes["FuturePaymentFlowResponse"] | ResolversParentTypes["ConfigPluginFlowResponse"] | ResolversParentTypes["UpdatePaymentFlowResponse"];
     OnlinePaymentFlowRequest: OnlinePaymentFlowRequest;
@@ -612,2 +655,4 @@ OnlinePaymentFlowResponse: Omit<OnlinePaymentFlowResponse, "paymentMethodDetails"> & {
     ConfigPluginFlowResponse: ConfigPluginFlowResponse;
+    UpdatePaymentFlowRequest: UpdatePaymentFlowRequest;
+    UpdatePaymentFlowResponse: UpdatePaymentFlowResponse;
     Header: Header;
@@ -720,6 +765,7 @@ Signature: Signature;
 export type FlowResponseTypeResolvers<ContextType = MercuriusContext, ParentType extends ResolversParentTypes["FlowResponseType"] = ResolversParentTypes["FlowResponseType"]> = {
-    resolveType: TypeResolveFn<"OnlinePaymentFlowResponse" | "OnlineRefundFlowResponse" | "OfflineRefundFlowResponse" | "OfflinePaymentFlowResponse" | "TerminalPaymentFlowResponse" | "OneTimePaymentFlowResponse" | "FuturePaymentFlowResponse" | "ConfigPluginFlowResponse", ParentType, ContextType>;
+    resolveType: TypeResolveFn<"OnlinePaymentFlowResponse" | "OnlineRefundFlowResponse" | "OfflineRefundFlowResponse" | "OfflinePaymentFlowResponse" | "TerminalPaymentFlowResponse" | "OneTimePaymentFlowResponse" | "FuturePaymentFlowResponse" | "ConfigPluginFlowResponse" | "UpdatePaymentFlowResponse", ParentType, ContextType>;
     flowType?: Resolver<ResolversTypes["PaymentProcessorFlow"], ParentType, ContextType>;
 };
 export type PaymentProcessorFlowResolvers = EnumResolverSignature<{
+    UPDATE_PAYMENT?: any;
     CONFIG?: any;
@@ -748,3 +794,3 @@ FUTURE_PAYMENT?: any;
 export type FlowValidationResponseResolvers<ContextType = MercuriusContext, ParentType extends ResolversParentTypes["FlowValidationResponse"] = ResolversParentTypes["FlowValidationResponse"]> = {
-    resolveType: TypeResolveFn<"OnlinePaymentFlowResponse" | "OnlineRefundFlowResponse" | "OfflineRefundFlowResponse" | "OfflinePaymentFlowResponse" | "TerminalPaymentFlowResponse" | "OneTimePaymentFlowResponse" | "FuturePaymentFlowResponse" | "ConfigPluginFlowResponse" | "InvalidSignature" | "InvalidFlowResult", ParentType, ContextType>;
+    resolveType: TypeResolveFn<"OnlinePaymentFlowResponse" | "OnlineRefundFlowResponse" | "OfflineRefundFlowResponse" | "OfflinePaymentFlowResponse" | "TerminalPaymentFlowResponse" | "OneTimePaymentFlowResponse" | "FuturePaymentFlowResponse" | "ConfigPluginFlowResponse" | "UpdatePaymentFlowResponse" | "InvalidSignature" | "InvalidFlowResult", ParentType, ContextType>;
 };
@@ -760,2 +806,3 @@ export type MutationResolvers<ContextType = MercuriusContext, ParentType extends ResolversParentTypes["Mutation"] = ResolversParentTypes["Mutation"]> = {
     configPlugin?: Resolver<ResolversTypes["FlowGrantResponse"], ParentType, ContextType, Partial<MutationconfigPluginArgs>>;
+    updatePayment?: Resolver<ResolversTypes["FlowGrantResponse"], ParentType, ContextType, Partial<MutationupdatePaymentArgs>>;
     validateFlowResult?: Resolver<ResolversTypes["FlowValidationResponse"], ParentType, ContextType, RequireFields<MutationvalidateFlowResultArgs, "flowResult">>;
@@ -833,2 +880,15 @@ };
 };
+export type UpdatePaymentFlowResponseResolvers<ContextType = MercuriusContext, ParentType extends ResolversParentTypes["UpdatePaymentFlowResponse"] = ResolversParentTypes["UpdatePaymentFlowResponse"]> = {
+    flowType?: Resolver<ResolversTypes["PaymentProcessorFlow"], ParentType, ContextType>;
+    processorID?: Resolver<ResolversTypes["PaymentProcessorId"], ParentType, ContextType>;
+    entityID?: Resolver<ResolversTypes["String"], ParentType, ContextType>;
+    status?: Resolver<ResolversTypes["TransactionStatus"], ParentType, ContextType>;
+    tenantID?: Resolver<ResolversTypes["OpenGovTenant"], ParentType, ContextType>;
+    paymentID?: Resolver<ResolversTypes["ID"], ParentType, ContextType>;
+    transactionID?: Resolver<Maybe<ResolversTypes["String"]>, ParentType, ContextType>;
+    amount?: Resolver<Maybe<ResolversTypes["Float"]>, ParentType, ContextType>;
+    processingFee?: Resolver<Maybe<ResolversTypes["Float"]>, ParentType, ContextType>;
+    currency?: Resolver<Maybe<ResolversTypes["String"]>, ParentType, ContextType>;
+    isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+};
 export type InvalidSignatureResolvers<ContextType = MercuriusContext, ParentType extends ResolversParentTypes["InvalidSignature"] = ResolversParentTypes["InvalidSignature"]> = {
@@ -896,2 +956,3 @@ message?: Resolver<ResolversTypes["String"], ParentType, ContextType>;
     ConfigPluginFlowResponse?: ConfigPluginFlowResponseResolvers<ContextType>;
+    UpdatePaymentFlowResponse?: UpdatePaymentFlowResponseResolvers<ContextType>;
     InvalidSignature?: InvalidSignatureResolvers<ContextType>;
@@ -1051,2 +1112,14 @@ InvalidFlowResult?: InvalidFlowResultResolvers<ContextType>;
     };
+    UpdatePaymentFlowResponse?: {
+        flowType?: LoaderResolver<PaymentProcessorFlow, UpdatePaymentFlowResponse, {}, TContext>;
+        processorID?: LoaderResolver<PaymentProcessorId, UpdatePaymentFlowResponse, {}, TContext>;
+        entityID?: LoaderResolver<Scalars["String"], UpdatePaymentFlowResponse, {}, TContext>;
+        status?: LoaderResolver<TransactionStatus, UpdatePaymentFlowResponse, {}, TContext>;
+        tenantID?: LoaderResolver<OpenGovTenant, UpdatePaymentFlowResponse, {}, TContext>;
+        paymentID?: LoaderResolver<Scalars["ID"], UpdatePaymentFlowResponse, {}, TContext>;
+        transactionID?: LoaderResolver<Maybe<Scalars["String"]>, UpdatePaymentFlowResponse, {}, TContext>;
+        amount?: LoaderResolver<Maybe<Scalars["Float"]>, UpdatePaymentFlowResponse, {}, TContext>;
+        processingFee?: LoaderResolver<Maybe<Scalars["Float"]>, UpdatePaymentFlowResponse, {}, TContext>;
+        currency?: LoaderResolver<Maybe<Scalars["String"]>, UpdatePaymentFlowResponse, {}, TContext>;
+    };
     InvalidSignature?: {
@@ -1053,0 +1126,0 @@ message?: LoaderResolver<Scalars["String"], InvalidSignature, {}, TContext>;

dist/types/generated.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TerminalPaySessionResultStatus = exports.CardType = void 0;
+exports.TransactionStatus = exports.OpenGovTenant = exports.TerminalPaySessionResultStatus = exports.CardType = void 0;
 var CardType;
@@ -20,2 +20,14 @@ (function (CardType) {
 })(TerminalPaySessionResultStatus || (exports.TerminalPaySessionResultStatus = TerminalPaySessionResultStatus = {}));
+var OpenGovTenant;
+(function (OpenGovTenant) {
+    OpenGovTenant["plc"] = "plc";
+})(OpenGovTenant || (exports.OpenGovTenant = OpenGovTenant = {}));
+var TransactionStatus;
+(function (TransactionStatus) {
+    TransactionStatus["SUCCEDED"] = "SUCCEDED";
+    TransactionStatus["PENDING"] = "PENDING";
+    TransactionStatus["FAILED"] = "FAILED";
+    TransactionStatus["DISPUTED"] = "DISPUTED";
+    TransactionStatus["LOST"] = "LOST";
+})(TransactionStatus || (exports.TransactionStatus = TransactionStatus = {}));
 //# sourceMappingURL=generated.js.map

package.json

 {
   "name": "@opengov/ppf-backend-types",
-  "version": "1.6.2",
+  "version": "1.7.0",
   "description": "PPF Backend types",
@@ -26,3 +26,3 @@ "homepage": "https://github.com/OpenGov/pluggable-payments#readme",
   },
-  "gitHead": "f0230605e1d9c5ca26c4254bc9f30afe17d95850"
+  "gitHead": "85bbd6fdc3b4fe2036dffa3e670e361283048480"
 }

src/types/enums.ts

@@ -10,2 +10,3 @@ export enum PaymentProcessorFlow {
   OFFLINE_PAYMENT = "OFFLINE_PAYMENT",
+  UPDATE_PAYMENT = "UPDATE_PAYMENT",
 }
@@ -46,1 +47,13 @@
 }
+
+export enum OpenGovTenant {
+  plc = "plc",
+}
+
+export enum TransactionStatus {
+  SUCCEDED = 1,
+  PENDING = 2,
+  FAILED = 3,
+  DISPUTED = 4,
+  LOST = 5,
+}

No alert changes

Improved metrics

Total package byte prevSize

326732

increased by4.9%

Lines of code

3482

increased by8.68%

No dependency changes