Release 4.15.0.

IngenicoEPayments · IngenicoEPayments · commit f0fbe03d357b · 2023-10-16T13:33:43.000+02:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "connect-sdk-nodejs",
-  "version": "4.14.0",
+  "version": "4.15.0",
   "description": "SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API",
   "homepage": "https://github.com/Ingenico-ePayments/connect-sdk-nodejs#readme",
   "bugs": {
diff --git a/schemas/hostedcheckout/CreateHostedCheckoutRequest.json b/schemas/hostedcheckout/CreateHostedCheckoutRequest.json
@@ -802,6 +802,19 @@
       },
       "additionalProperties" : false
     },
+    "Frequency" : {
+      "type" : "object",
+      "properties" : {
+        "interval" : {
+          "type" : "string"
+        },
+        "intervalFrequency" : {
+          "type" : "integer",
+          "maximum" : 2147483647
+        }
+      },
+      "additionalProperties" : false
+    },
     "GPayThreeDSecure" : {
       "type" : "object",
       "properties" : {
@@ -848,6 +861,9 @@
         "paymentProductFilters" : {
           "$ref" : "#/definitions/PaymentProductFiltersHostedCheckout"
         },
+        "recurringPaymentsData" : {
+          "$ref" : "#/definitions/RecurringPaymentsData"
+        },
         "returnCancelState" : {
           "type" : "boolean"
         },
@@ -875,6 +891,9 @@
         "amountOfMoneyPerInstallment" : {
           "$ref" : "#/definitions/AmountOfMoney"
         },
+        "amountOfMoneyTotal" : {
+          "$ref" : "#/definitions/AmountOfMoney"
+        },
         "frequencyOfInstallments" : {
           "type" : "string"
         },
@@ -1498,6 +1517,18 @@
       },
       "additionalProperties" : false
     },
+    "RecurringPaymentsData" : {
+      "type" : "object",
+      "properties" : {
+        "recurringInterval" : {
+          "$ref" : "#/definitions/Frequency"
+        },
+        "trialInformation" : {
+          "$ref" : "#/definitions/TrialInformation"
+        }
+      },
+      "additionalProperties" : false
+    },
     "RedirectPaymentMethodSpecificInputBase" : {
       "type" : "object",
       "properties" : {
@@ -1771,6 +1802,40 @@
         }
       },
       "additionalProperties" : false
+    },
+    "TrialInformation" : {
+      "type" : "object",
+      "properties" : {
+        "amountOfMoneyAfterTrial" : {
+          "$ref" : "#/definitions/AmountOfMoney"
+        },
+        "endDate" : {
+          "type" : "string"
+        },
+        "isRecurring" : {
+          "type" : "boolean"
+        },
+        "trialPeriod" : {
+          "$ref" : "#/definitions/TrialPeriod"
+        },
+        "trialPeriodRecurring" : {
+          "$ref" : "#/definitions/Frequency"
+        }
+      },
+      "additionalProperties" : false
+    },
+    "TrialPeriod" : {
+      "type" : "object",
+      "properties" : {
+        "duration" : {
+          "type" : "integer",
+          "maximum" : 2147483647
+        },
+        "interval" : {
+          "type" : "string"
+        }
+      },
+      "additionalProperties" : false
     }
   }
 }
diff --git a/schemas/installments/GetInstallmentRequest.json b/schemas/installments/GetInstallmentRequest.json
@@ -0,0 +1,35 @@
+{
+  "$schema" : "http://json-schema.org/draft-04/schema#",
+  "type" : "object",
+  "properties" : {
+    "amountOfMoney" : {
+      "$ref" : "#/definitions/AmountOfMoney"
+    },
+    "bin" : {
+      "type" : "string"
+    },
+    "countryCode" : {
+      "type" : "string"
+    },
+    "paymentProductId" : {
+      "type" : "integer",
+      "maximum" : 2147483647
+    }
+  },
+  "additionalProperties" : false,
+  "definitions" : {
+    "AmountOfMoney" : {
+      "type" : "object",
+      "properties" : {
+        "amount" : {
+          "type" : "integer",
+          "maximum" : 9223372036854775807
+        },
+        "currencyCode" : {
+          "type" : "string"
+        }
+      },
+      "additionalProperties" : false
+    }
+  }
+}
diff --git a/schemas/payment/CompletePaymentRequest.json b/schemas/payment/CompletePaymentRequest.json
@@ -576,6 +576,9 @@
         "amountOfMoneyPerInstallment" : {
           "$ref" : "#/definitions/AmountOfMoney"
         },
+        "amountOfMoneyTotal" : {
+          "$ref" : "#/definitions/AmountOfMoney"
+        },
         "frequencyOfInstallments" : {
           "type" : "string"
         },
diff --git a/schemas/payment/CreatePaymentRequest.json b/schemas/payment/CreatePaymentRequest.json
@@ -1094,6 +1094,9 @@
         "amountOfMoneyPerInstallment" : {
           "$ref" : "#/definitions/AmountOfMoney"
         },
+        "amountOfMoneyTotal" : {
+          "$ref" : "#/definitions/AmountOfMoney"
+        },
         "frequencyOfInstallments" : {
           "type" : "string"
         },
diff --git a/src/index.ts b/src/index.ts
@@ -21,6 +21,7 @@ import services = require("./services");
 import tokens = require("./tokens");
 import mandates = require("./mandates");
 import sessions = require("./sessions");
+import installments = require("./installments");
 import files = require("./files");
 
 import webhooks = require("./webhooks");
@@ -87,6 +88,7 @@ const connectSdk: ConnectSdk = {
   tokens: tokens,
   mandates: mandates,
   sessions: sessions,
+  installments: installments,
   files: files,
   context: sdkcontext,
 
diff --git a/src/installments/getInstallmentsInfo.ts b/src/installments/getInstallmentsInfo.ts
@@ -0,0 +1,32 @@
+/*
+ * This file was auto-generated from the API references found at
+ * https://epayments-api.developer-ingenico.com/s2sapi/v1/
+ */
+import { validate } from "jsonschema";
+import communicator = require("../utils/communicator");
+import sdkcontext = require("../utils/context");
+import { PaymentContext, SdkCallback } from "../model";
+import { GetInstallmentRequest } from "../model/domain/installments";
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const requestSchema = require("../../schemas/installments/GetInstallmentRequest.json");
+
+const getInstallmentsInfo = function(merchantId: string, postData: GetInstallmentRequest, paymentContext: PaymentContext | null, cb: SdkCallback): void {
+  // validate postData
+  const isValidRequest = validate(postData, requestSchema);
+  if (!isValidRequest.valid) {
+    const logger = sdkcontext.getLogger();
+    if (sdkcontext.isLoggingEnabled()) {
+      logger("error", isValidRequest.errors);
+    }
+    throw new Error(isValidRequest.errors.toString());
+  }
+  communicator.json({
+    method: "POST",
+    modulePath: "/v1/" + merchantId + "/installments/getInstallmentsInfo",
+    body: postData,
+    paymentContext: paymentContext,
+    cb: cb
+  });
+};
+export = getInstallmentsInfo;
diff --git a/src/installments/index.ts b/src/installments/index.ts
@@ -0,0 +1,11 @@
+/*
+ * This file was auto-generated from the API references found at
+ * https://epayments-api.developer-ingenico.com/s2sapi/v1/
+ */
+import getInstallmentsInfo = require("./getInstallmentsInfo");
+import { InstallmentsClient } from "../model/installments";
+
+const installmentsClient: InstallmentsClient = {
+  getInstallmentsInfo: getInstallmentsInfo
+};
+export = installmentsClient;
diff --git a/src/model/domain/hostedcheckout/definitions/index.ts b/src/model/domain/hostedcheckout/definitions/index.ts
@@ -2,7 +2,7 @@
  * This file was auto-generated from the API references found at
  * https://epayments-api.developer-ingenico.com/s2sapi/v1/
  */
-import { AbstractPaymentMethodSpecificInput, KeyValuePair, PaymentProductFilter } from "../../definitions";
+import { AbstractPaymentMethodSpecificInput, AmountOfMoney, KeyValuePair, PaymentProductFilter } from "../../definitions";
 import { GPayThreeDSecure, Payment, PaymentCreationReferences } from "../../payment/definitions";
 
 export interface CreatedPaymentOutput {
@@ -24,10 +24,16 @@ export interface DisplayedData {
   showData?: KeyValuePair[] | null;
 }
 
+export interface Frequency {
+  interval?: string | null;
+  intervalFrequency?: number | null;
+}
+
 export interface HostedCheckoutSpecificInput {
   isRecurring?: boolean | null;
   locale?: string | null;
   paymentProductFilters?: PaymentProductFiltersHostedCheckout | null;
+  recurringPaymentsData?: RecurringPaymentsData | null;
   returnCancelState?: boolean | null;
   returnUrl?: string | null;
   showResultPage?: boolean | null;
@@ -60,3 +66,21 @@ export interface PaymentProductFiltersHostedCheckout {
   restrictTo?: PaymentProductFilter | null;
   tokensOnly?: boolean | null;
 }
+
+export interface RecurringPaymentsData {
+  recurringInterval?: Frequency | null;
+  trialInformation?: TrialInformation | null;
+}
+
+export interface TrialInformation {
+  amountOfMoneyAfterTrial?: AmountOfMoney | null;
+  endDate?: string | null;
+  isRecurring?: boolean | null;
+  trialPeriod?: TrialPeriod | null;
+  trialPeriodRecurring?: Frequency | null;
+}
+
+export interface TrialPeriod {
+  duration?: number | null;
+  interval?: string | null;
+}
diff --git a/src/model/domain/installments/definitions/index.ts b/src/model/domain/installments/definitions/index.ts
@@ -0,0 +1,17 @@
+/*
+ * This file was auto-generated from the API references found at
+ * https://epayments-api.developer-ingenico.com/s2sapi/v1/
+ */
+import { Installments } from "../../payment/definitions";
+
+export interface InstallmentDisplayHints {
+  displayOrder?: number | null;
+  label?: string | null;
+  logo?: string | null;
+}
+
+export interface InstallmentOptions {
+  displayHints?: InstallmentDisplayHints | null;
+  id?: string | null;
+  installmentPlans?: Installments[] | null;
+}
diff --git a/src/model/domain/installments/index.ts b/src/model/domain/installments/index.ts
@@ -0,0 +1,17 @@
+/*
+ * This file was auto-generated from the API references found at
+ * https://epayments-api.developer-ingenico.com/s2sapi/v1/
+ */
+import { AmountOfMoney } from "../definitions";
+import { InstallmentOptions } from "./definitions";
+
+export interface GetInstallmentRequest {
+  amountOfMoney?: AmountOfMoney | null;
+  bin?: string | null;
+  countryCode?: string | null;
+  paymentProductId?: number | null;
+}
+
+export interface InstallmentOptionsResponse {
+  installmentOptions?: InstallmentOptions[] | null;
+}
diff --git a/src/model/domain/payment/definitions/index.ts b/src/model/domain/payment/definitions/index.ts
@@ -431,6 +431,7 @@ export interface HostedCheckoutSpecificOutput {
 
 export interface Installments {
   amountOfMoneyPerInstallment?: AmountOfMoney | null;
+  amountOfMoneyTotal?: AmountOfMoney | null;
   frequencyOfInstallments?: string | null;
   installmentPlanCode?: number | null;
   interestRate?: string | null;
diff --git a/src/model/index.ts b/src/model/index.ts
@@ -17,6 +17,7 @@ import { ServicesClient } from "./services";
 import { TokensClient } from "./tokens";
 import { MandatesClient } from "./mandates";
 import { SessionsClient } from "./sessions";
+import { InstallmentsClient } from "./installments";
 import { FilesClient } from "./files";
 import { WebhooksHelper } from "./webhooks";
 
@@ -37,6 +38,7 @@ export interface ConnectSdk {
   readonly tokens: TokensClient;
   readonly mandates: MandatesClient;
   readonly sessions: SessionsClient;
+  readonly installments: InstallmentsClient;
   readonly files: FilesClient;
 
   readonly context: SdkContext;
diff --git a/src/model/installments/index.ts b/src/model/installments/index.ts
@@ -0,0 +1,16 @@
+/*
+ * This file was auto-generated from the API references found at
+ * https://epayments-api.developer-ingenico.com/s2sapi/v1/
+ */
+import { GetInstallmentRequest } from "../domain/installments";
+import { PaymentContext, SdkCallback } from "../types";
+
+export interface InstallmentsClient {
+  /**
+   * Resource /{merchantId}/installments/getInstallmentsInfo - <a href="https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/nodejs/installments/getInstallmentsInfo.html">Get Installment Info</a>
+   * @param cb The callback for the response.
+   *           If the call was successfull, the response body type will be {@link InstallmentOptionsResponse}.
+   *           If the call was not successful, the response body type will be {@link ErrorResponse}.
+   */
+  getInstallmentsInfo(merchantId: string, postData: GetInstallmentRequest, paymentContext: PaymentContext | null, cb: SdkCallback): void;
+}
diff --git a/src/utils/headers.ts b/src/utils/headers.ts
@@ -18,7 +18,7 @@ interface ServerMetaInfo {
 export function serverMetaInfo(sdkContext: SdkContext): Header {
   const info: ServerMetaInfo = {
     sdkCreator: "Ingenico",
-    sdkIdentifier: "NodejsServerSDK/v4.14.0",
+    sdkIdentifier: "NodejsServerSDK/v4.15.0",
     platformIdentifier: process.env["OS"] + " Node.js/" + process.versions.node
   };
   if (sdkContext.getIntegrator() !== null) {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "connect-sdk-nodejs",`
`3`		`- "version": "4.14.0",`
	`3`	`+ "version": "4.15.0",`
`4`	`4`	`"description": "SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API",`
`5`	`5`	`"homepage": "https://github.com/Ingenico-ePayments/connect-sdk-nodejs#readme",`
`6`	`6`	`"bugs": {`