@opengov/ppf-backend-types 1.155.0-beta.2313.1.0 → 1.155.0

package/src/types/generated.ts

@@ -237,11 +237,14 @@ export type FuturePaymentFlowRequest = {
 export type FuturePaymentFlowResponse = FlowResponseType & {
   __typename?: "FuturePaymentFlowResponse";
   applicationMetadata?: Maybe<ApplicationMetadataResponse>;
+  eventStatus?: Maybe<PaymentEventStatus>;
+  failure?: Maybe<PaymentEventFailure>;
   flowType: PaymentProcessorFlow;
   idempotencyKey?: Maybe<Scalars["String"]>;
   paymentAccountToken?: Maybe<Scalars["PaymentAccountToken"]>;
   paymentMethodDetails?: Maybe<PaymentMethodDetails>;
   status: Scalars["String"];
+  transactionType?: Maybe<PaymentEventTransactionType>;
 };
 
 export type Header = {
@@ -278,8 +281,7 @@ export type InvalidSignature = ResponseErrorMessage & {
 
 /**
  * Omit `suite` (or pass null/blank) for every product on the entity plus
- * blankets. Set `suite` for that product plus blankets. Ordered by `priority`
- * ASC, compared as text (LexoRank).
+ * blankets. Set `suite` for that product plus blankets. Ordered by priority ASC.
  * Use the omit-suite list as `orderedIds` for `reorderRoutingRules`.
  */
 export type ListPublishedRoutingRulesInput = {
@@ -308,7 +310,6 @@ export type Mutation = {
   onlineRefund: FlowGrantResponse;
   /** Requests a grant to perform the ONLINE_VOID flow. */
   onlineVoid: FlowGrantResponse;
-  reorderRoutingRules: ReorderRoutingRulesResult;
   saveRoutingRule: SaveRoutingRuleResult;
   /** Requests a grant to perform the TERMINAL_PAYMENT flow. */
   terminalPayment: FlowGrantResponse;
@@ -358,10 +359,6 @@ export type MutationonlineVoidArgs = {
   request: OnlineVoidFlowRequest;
 };
 
-export type MutationreorderRoutingRulesArgs = {
-  input: ReorderRoutingRulesInput;
-};
-
 export type MutationsaveRoutingRuleArgs = {
   input: SaveRoutingRuleInput;
 };
@@ -405,6 +402,8 @@ export type OfflinePaymentFlowResponse = FlowResponseType & {
   currency?: Maybe<Scalars["String"]>;
   description?: Maybe<Scalars["String"]>;
   entityID: Scalars["String"];
+  eventStatus?: Maybe<PaymentEventStatus>;
+  failure?: Maybe<PaymentEventFailure>;
   flowType: PaymentProcessorFlow;
   idempotencyKey?: Maybe<Scalars["String"]>;
   items?: Maybe<Array<Maybe<FeeItemResponse>>>;
@@ -419,6 +418,7 @@ export type OfflinePaymentFlowResponse = FlowResponseType & {
   sourceApp: Scalars["String"];
   status: Scalars["String"];
   transactionID?: Maybe<Scalars["String"]>;
+  transactionType?: Maybe<PaymentEventTransactionType>;
   userID: Scalars["ID"];
 };
 
@@ -506,6 +506,8 @@ export type OnlinePaymentFlowResponse = FlowResponseType & {
   currency?: Maybe<Scalars["String"]>;
   description?: Maybe<Scalars["String"]>;
   destinationPaymentID?: Maybe<Scalars["String"]>;
+  eventStatus?: Maybe<PaymentEventStatus>;
+  failure?: Maybe<PaymentEventFailure>;
   flowType: PaymentProcessorFlow;
   idempotencyKey?: Maybe<Scalars["String"]>;
   payer?: Maybe<Payer>;
@@ -518,6 +520,7 @@ export type OnlinePaymentFlowResponse = FlowResponseType & {
   processingFee?: Maybe<Scalars["Float"]>;
   status: Scalars["String"];
   transactionID?: Maybe<Scalars["String"]>;
+  transactionType?: Maybe<PaymentEventTransactionType>;
 };
 
 export type OnlineRefundFlowRequest = {
@@ -540,11 +543,15 @@ export type OnlineRefundFlowRequest = {
 export type OnlineRefundFlowResponse = FlowResponseType & {
   __typename?: "OnlineRefundFlowResponse";
   amount: Scalars["Float"];
+  eventStatus?: Maybe<PaymentEventStatus>;
+  failure?: Maybe<PaymentEventFailure>;
   flowType: PaymentProcessorFlow;
   idempotencyKey?: Maybe<Scalars["String"]>;
+  originalPaymentID?: Maybe<Scalars["ID"]>;
   paymentID: Scalars["ID"];
   status: Scalars["String"];
   transactionID?: Maybe<Scalars["String"]>;
+  transactionType?: Maybe<PaymentEventTransactionType>;
 };
 
 export type OnlineVoidFlowRequest = {
@@ -559,9 +566,13 @@ export type OnlineVoidFlowRequest = {
 
 export type OnlineVoidFlowResponse = FlowResponseType & {
   __typename?: "OnlineVoidFlowResponse";
+  eventStatus?: Maybe<PaymentEventStatus>;
+  failure?: Maybe<PaymentEventFailure>;
   flowType: PaymentProcessorFlow;
+  originalPaymentID?: Maybe<Scalars["ID"]>;
   status: Scalars["String"];
   transactionID?: Maybe<Scalars["String"]>;
+  transactionType?: Maybe<PaymentEventTransactionType>;
 };
 
 export { OpenGovTenant };
@@ -578,6 +589,52 @@ export enum PaymentChannel {
   WEB = "WEB",
 }
 
+export type PaymentEventFailure = {
+  __typename?: "PaymentEventFailure";
+  achReturnCode?: Maybe<Scalars["String"]>;
+  category: PaymentFailureCategory;
+  code?: Maybe<Scalars["String"]>;
+  message: Scalars["String"];
+  payerActionRequired: Scalars["Boolean"];
+  processorCode?: Maybe<Scalars["String"]>;
+  retryable: Scalars["Boolean"];
+};
+
+export enum PaymentEventStatus {
+  AUTHORIZED = "AUTHORIZED",
+  AWAITING_ACTION = "AWAITING_ACTION",
+  AWAITING_EXTERNAL_ACTION = "AWAITING_EXTERNAL_ACTION",
+  CANCELLED = "CANCELLED",
+  CAPTURED = "CAPTURED",
+  CREATED = "CREATED",
+  DECLINED = "DECLINED",
+  FAILED = "FAILED",
+  FUNDED = "FUNDED",
+  SETTLED = "SETTLED",
+  VOIDED = "VOIDED",
+}
+
+export enum PaymentEventTransactionType {
+  AUTHORIZATION = "AUTHORIZATION",
+  CAPTURE = "CAPTURE",
+  CHARGEBACK = "CHARGEBACK",
+  REFUND = "REFUND",
+  VOID = "VOID",
+}
+
+export enum PaymentFailureCategory {
+  ACH_RETURN = "ACH_RETURN",
+  AUTHENTICATION_REQUIRED = "AUTHENTICATION_REQUIRED",
+  CARD_DECLINED = "CARD_DECLINED",
+  CHARGEBACK_LOST = "CHARGEBACK_LOST",
+  DUPLICATE = "DUPLICATE",
+  EXPIRED_CARD = "EXPIRED_CARD",
+  INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
+  INVALID_ACCOUNT = "INVALID_ACCOUNT",
+  PPF_ERROR = "PPF_ERROR",
+  PROCESSOR_ERROR = "PROCESSOR_ERROR",
+}
+
 export type PaymentMetadataResponse = {
   __typename?: "PaymentMetadataResponse";
   amount?: Maybe<Scalars["Float"]>;
@@ -695,26 +752,6 @@ export type RefundMethodDetails = {
   userID?: Maybe<Scalars["String"]>;
 };
 
-/**
- * `orderedIds` must be every published route on the entity, across all products,
- * in the new order. Priority is one order per entity, so partial reorders are
- * rejected. The server restamps `priority` as ascending LexoRank strings.
- */
-export type ReorderRoutingRulesInput = {
-  entity: Scalars["String"];
-  orderedIds: Array<Scalars["ID"]>;
-};
-
-export type ReorderRoutingRulesResult =
-  | InternalError
-  | InvalidCommunity
-  | ReorderRoutingRulesSuccess;
-
-export type ReorderRoutingRulesSuccess = {
-  __typename?: "ReorderRoutingRulesSuccess";
-  rules: Array<RoutingRule>;
-};
-
 /** Common interface for mutation responses that fail for predictable reasons. */
 export type ResponseErrorMessage = {
   message: Scalars["String"];
@@ -729,11 +766,7 @@ export type RoutingRule = {
   entity: Scalars["String"];
   id: Scalars["ID"];
   notes?: Maybe<Scalars["String"]>;
-  /**
-   * LexoRank string. Route order is the lexicographic order of this field, so
-   * sort on it as text — never parse it as a number.
-   */
-  priority: Scalars["String"];
+  priority: Scalars["Int"];
   publishedAt?: Maybe<Scalars["DateTime"]>;
   ruleGroupId: Scalars["String"];
   state: Scalars["String"];
@@ -754,11 +787,7 @@ export type SaveRoutingRuleInput = {
   entity: Scalars["String"];
   id?: InputMaybe<Scalars["ID"]>;
   notes?: InputMaybe<Scalars["String"]>;
-  /**
-   * LexoRank string (e.g. `0|i00007:`). Omit to let the server pick; use
-   * `reorderRoutingRules` to change the order of an existing list.
-   */
-  priority?: InputMaybe<Scalars["String"]>;
+  priority?: InputMaybe<Scalars["Int"]>;
   state?: InputMaybe<Scalars["String"]>;
   suite?: InputMaybe<Scalars["String"]>;
 };
@@ -844,6 +873,8 @@ export type UpdatePaymentFlowResponse = FlowResponseType & {
   currency?: Maybe<Scalars["String"]>;
   destinationPaymentID?: Maybe<Scalars["String"]>;
   entityID: Scalars["String"];
+  eventStatus?: Maybe<PaymentEventStatus>;
+  failure?: Maybe<PaymentEventFailure>;
   flowType: PaymentProcessorFlow;
   last4?: Maybe<Scalars["String"]>;
   paymentReference: Scalars["String"];
@@ -853,4 +884,5 @@ export type UpdatePaymentFlowResponse = FlowResponseType & {
   status?: Maybe<PaymentStatus>;
   tenantID: OpenGovTenant;
   transactionID?: Maybe<Scalars["String"]>;
+  transactionType?: Maybe<PaymentEventTransactionType>;
 };