Merge pull request #1567 from Adyen/export-enums

Export EnvironmentEnum and RegionEnum

Author: gcatanese

README.md

@@ -254,12 +254,12 @@ Alternatively, you can use the `Types` included in this module for Typescript an
 #### Deserializing JSON Strings
 In some setups you might need to deserialize JSON strings to request objects. For example, when using the libraries in combination with [Dropin/Components](https://github.com/Adyen/adyen-web). Please use the built-in deserialization functions:
 ``` typescript
-// Import the required model class
-import { checkout } from "../typings";
+// Import the models
+import { Types } from "@adyen/api-library";
 
 // Deserialize using built-in ObjectSerializer class
 const requestJson: JSON = JSON.parse(`YOUR_JSON_STRING`);
-const paymentRequest: checkout.PaymentRequest = await checkout.ObjectSerializer.deserialize(requestJson,"PaymentRequest");
+const paymentRequest: Types.checkout.PaymentRequest = await Types.checkout.ObjectSerializer.deserialize(requestJson,"PaymentRequest");
 ```
 
 ### Custom HTTP client configuration
@@ -299,8 +299,11 @@ const client = new Client({
 ### Parsing and Authenticating Banking Webhooks
 Parse an AccountHolderNotificationRequest webhook;
 ``` typescript
+// import models
+import { Types, ConfigurationWebhooksHandler } from "@adyen/api-library";
+
 const configurationWebhooksHandler = new ConfigurationWebhooksHandler(YOUR_BANKING_WEBHOOK);
-const accountHolderNotificationRequest: AccountHolderNotificationRequest = configurationWebhooksHandler.getAccountHolderNotificationRequest();
+const accountHolderNotificationRequest: Types.configurationWebhooks.AccountHolderNotificationRequest = configurationWebhooksHandler.getAccountHolderNotificationRequest();
 ```
 You can also parse the webhook with a generic type, in case you do not know the webhook type in advance. In this case you can check the instance of the webhook in order to parse it to the respective type (or just use it dynamically);
 ``` typescript
@@ -331,7 +334,7 @@ To configure a proxy connection, set the `proxy` property of your `HttpURLConnec
 For example:
 
 ``` javascript
-const {HttpURLConnectionClient, Client, Config} = require('@adyen/api-library');
+const {HttpURLConnectionClient, Client, Config, EnvironmentEnum} = require('@adyen/api-library');
 // ... more code
 const client = new Client({apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST}); 
 const httpClient = new HttpURLConnectionClient();
@@ -494,7 +497,7 @@ const paymentRequest: SaleToPOIRequest = {
 }
 
 // Step 6: Make the request
-const terminalApiResponse: terminal.TerminalApiResponse = await terminalLocalAPI.request(paymentRequest, securityKey);
+const terminalApiResponse: Types.terminal.TerminalApiResponse = await terminalLocalAPI.request(paymentRequest, securityKey);
 ```
 ## Using the Local Terminal API Integration without Encryption (Only on TEST)
 If you wish to develop the Local Terminal API integration parallel to your encryption implementation, you can opt for the unencrypted version. Be sure to remove any encryption details from the CA terminal config page. 
@@ -517,15 +520,15 @@ const paymentRequest: SaleToPOIRequest = {
 }
 
 // Step 5: Make the request
-const terminalApiResponse: terminal.TerminalApiResponse = await terminalLocalAPI.request(paymentRequest);
+const terminalApiResponse: Types.terminal.TerminalApiResponse = await terminalLocalAPI.request(paymentRequest);
 ```
 ### Using the Cloud Terminal API Integration (async)
 If you choose to integrate [Terminal API over Cloud](https://docs.adyen.com/point-of-sale/design-your-integration/choose-your-architecture/cloud/) **asynchronously**, you need to follow similar steps to initialize the client and prepare the request object. However the response will be asynchronous:
 * a successful request will return `200` status code and `ok` as response body. Make sure to setup the [event notifications](https://docs.adyen.com/point-of-sale/design-your-integration/notifications/event-notifications/)
 * a request that fails will return `200` status code and the `TerminalApiResponse` as response body
 ``` typescript
 // Step 1: Require the parts of the module you want to use
-const {Client, TerminalCloudAPI} from "@adyen/api-library";
+const {Client, TerminalCloudAPI, EnvironmentEnum} from "@adyen/api-library";
 
 // Step 2: Initialize the client object
 const client = new Client({apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST}); 

src/__tests__/balanceControl.spec.ts

@@ -2,8 +2,7 @@ import nock from "nock";
 import  { createClient } from "../__mocks__/base";
 import { BalanceControlAPI } from "../services";
 import Client from "../client";
-import { BalanceTransferRequest } from "../typings/balanceControl/balanceTransferRequest";
-import { BalanceTransferResponse } from "../typings/balanceControl/balanceTransferResponse";
+import { Types } from "..";
 import HttpClientException from "../httpClient/httpClientException";
 
 let client: Client,
@@ -39,13 +38,13 @@ describe("Balance Control", (): void => {
             "pspReference": "8816080397613514",
             "status": "transferred"
         };
-        const request: BalanceTransferRequest = new BalanceTransferRequest;
+        const request = new Types.balanceControl.BalanceTransferRequest();
 
         scope.post("/balanceTransfer")
             .reply(200, expected);
 
-        const response: BalanceTransferResponse = await balanceService.BalanceControlApi.balanceTransfer(request);
-        expect(response.status).toEqual(BalanceTransferResponse.StatusEnum.Transferred);
+        const response: Types.balanceControl.BalanceTransferResponse = await balanceService.BalanceControlApi.balanceTransfer(request);
+        expect(response.status).toEqual(Types.balanceControl.BalanceTransferResponse.StatusEnum.Transferred);
     });
 
     test("Should return correct Validation error", async (): Promise<void> => {
@@ -55,7 +54,7 @@ describe("Balance Control", (): void => {
             "message": "Merchant account code is invalid or missing",
             "errorType": "validation"
         };
-        const request: BalanceTransferRequest = new BalanceTransferRequest;
+        const request = new Types.balanceControl.BalanceTransferRequest();
 
         try {
             scope.post("/balanceTransfer")