update makefile, readme and tests to upgrade Transfers and Management API #1235
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Aleffio
changed the title
michaelpaul
previously approved these changes
Aug 18, 2023
Aleffio
force-pushed
the
feature/management_transfers_upgrade
branch
from
9c54ecb
to
15c75eb
Compare
index b9b9453..5b74396 100644 --- a/Makefile +++ b/Makefile @@ -19,14 +19,13 @@ terminalManagement: spec=TfmAPIService-v1 payment: spec=PaymentService-v68 recurring: spec=RecurringService-v68 payout: spec=PayoutService-v68 -management: spec=ManagementService-v1 +management: spec=ManagementService-v3 legalEntityManagement: spec=LegalEntityService-v3 platformsAccount: spec=AccountService-v6 platformsFund: spec=FundService-v6 platformsNotificationConfiguration: spec=NotificationConfigurationService-v6 platformsHostedOnboardingPage: spec=HopService-v6 -transfers: spec=TransferService-v3 - +transfers: spec=TransferService-v4 # BalanceWebhooks acsWebhooks: spec=BalancePlatformAcsNotification-v1 configurationWebhooks: spec=BalancePlatformConfigurationNotification-v1 diff --git a/README.md b/README.md index 591e2bc..4529ace 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ This library supports the following: | [DataProtection API](https://docs.adyen.com/development-resources/data-protection-api) | v1 | Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email) | [DataProtection](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/dataProtectionApi.ts) | | [Legal Entity Management API](https://docs.adyen.com/api-explorer/legalentity/3/overview) | v3 | Manage legal entities that contain information required for verification. | [LegalEntityManagement](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/legalEntityManagement/index.ts) | | [Local/Cloud-based Terminal API](https://docs.adyen.com/point-of-sale/terminal-api-reference) | - | Our point-of-sale integration. | [TerminalLocalAPI](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/terminalLocalAPI.ts) or [TerminalCloudAPI](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/terminalCloudAPI.ts) | -| [Management API](https://docs.adyen.com/api-explorer/Management/1/overview) | v1 | Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. | [Management](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/management/index.ts) | +| [Management API](https://docs.adyen.com/api-explorer/Management/3/overview) | v3 | Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. | [Management](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/management/index.ts) | | [Payments API](https://docs.adyen.com/api-explorer/Payment/68/overview) | v68 | Our classic integration for online payments. | [ClassicIntegrationAPI](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/paymentApi.ts) | | [Payouts API](https://docs.adyen.com/api-explorer/Payout/68/overview) | v68 | Endpoints for sending funds to your customers. | [Payout](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/payout/index.ts) | | [Platforms APIs](https://docs.adyen.com/platforms/api) | - | Set of APIs when using Adyen for Platforms. This API is used for the classic integration. | [Platforms](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/platforms.ts) | @@ -34,7 +34,7 @@ This library supports the following: | [POS Terminal Management API](https://docs.adyen.com/api-explorer/postfmapi/1/overview) | v1 | Endpoints for managing your point-of-sale payment terminals. | [TerminalManagement](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/terminalManagementApi.ts) | | [Recurring API](https://docs.adyen.com/api-explorer/Recurring/68/overview) | v68 | Endpoints for managing saved payment details. | [Recurring](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/recurringApi.ts) | | [Stored Value API](https://docs.adyen.com/payment-methods/gift-cards/stored-value-api) | v46 | Manage both online and point-of-sale gift cards and other stored-value cards. | [StoredValue](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/storedValueApi.ts) | -| [Transfers API](https://docs.adyen.com/api-explorer/transfers/3/overview) | v3 | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | [Transfers](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/transfers/index.ts) | +| [Transfers API](https://docs.adyen.com/api-explorer/transfers/4/overview) | v4 | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | [Transfers](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/transfers/index.ts) | ## Supported Webhook versions The library supports all webhooks under the following model directories: @@ -43,7 +43,7 @@ The library supports all webhooks under the following model directories: |---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|-------------------| | [Authentication Webhooks](https://docs.adyen.com/api-explorer/acs-webhook/1/overview) | Adyen sends this webhook when the process of cardholder authentication is finalized, whether it is completed successfully, fails, or expires. | [AcsWebhooks](src/typings/acsWebhooks) | **v1** | | [Configuration Webhooks](https://docs.adyen.com/api-explorer/balanceplatform-webhooks/1/overview) | You can use these webhooks to build your implementation. For example, you can use this information to update internal statuses when the status of a capability is changed. | [ConfigurationNotification](src/typings/configurationWebhooks) | **v1** | -| [Transfer Webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/3/overview) | You can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds. | [TransferNotification](src/typings/transferWebhooks) | **v3** | +| [Transfer Webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/4/overview) | You can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds. | [TransferNotification](src/typings/transferWebhooks) | **v4** | | [Report Webhooks](https://docs.adyen.com/api-explorer/report-webhooks/1/overview) | You can download reports programmatically by making an HTTP GET request, or manually from your Balance Platform Customer Area | [ReportNotification](src/typings/reportWebhooks) | **v1** | | [Management Webhooks](https://docs.adyen.com/api-explorer/ManagementNotification/1/overview) | Adyen uses webhooks to inform your system about events that happen with your Adyen company and merchant accounts, stores, payment terminals, and payment methods when using Management API. | [ManagementWebhooks](src/typings/managementWebhooks) | **v1** | | [Notification Webhooks](https://docs.adyen.com/api-explorer/Webhooks/1/overview) | We use webhooks to send you updates about payment status updates, newly available reports, and other events that you can subscribe to. For more information, refer to our documentation | [Notification](src/typings/notification) | **v1** | diff --git a/src/__tests__/management.spec.ts b/src/__tests__/management.spec.ts index da3e502..b449614 100644 --- a/src/__tests__/management.spec.ts +++ b/src/__tests__/management.spec.ts @@ -28,7 +28,7 @@ beforeEach((): void => { nock.activate(); } client = createClient(); - scope = nock("https://management-test.adyen.com/v1"); + scope = nock("https://management-test.adyen.com/v3"); managementService = new ManagementAPI(client); }); @@ -678,7 +678,7 @@ describe("Management", (): void => { ...requests.createMerchantWebhookRequest, communicationFormat: management.CreateMerchantWebhookRequest.CommunicationFormatEnum.Json, networkType: management.CreateMerchantWebhookRequest.NetworkTypeEnum.Public, - sslVersion: management.CreateMerchantWebhookRequest.SslVersionEnum.Tlsv12 + encryptionProtocol: management.CreateMerchantWebhookRequest.EncryptionProtocolEnum.Tlsv12 }); expect(response).toBeTruthy(); @@ -708,7 +708,7 @@ describe("Management", (): void => { ...requests.updateMerchantWebhookRequest, communicationFormat: management.CreateMerchantWebhookRequest.CommunicationFormatEnum.Soap, networkType: management.CreateMerchantWebhookRequest.NetworkTypeEnum.Local, - sslVersion: management.CreateMerchantWebhookRequest.SslVersionEnum.Tlsv13 + encryptionProtocol: management.CreateMerchantWebhookRequest.EncryptionProtocolEnum.Tlsv13 }); expect(response).toBeTruthy(); diff --git a/src/__tests__/transfers.spec.ts b/src/__tests__/transfers.spec.ts index 4c26a42..0e79cef 100644 --- a/src/__tests__/transfers.spec.ts +++ b/src/__tests__/transfers.spec.ts @@ -15,7 +15,7 @@ beforeEach((): void => { } client = createClient(); transfersAPI = new TransfersAPI(client); - scope = nock("https://balanceplatform-api-test.adyen.com/btl/v3"); + scope = nock("https://balanceplatform-api-test.adyen.com/btl/v4"); }); afterEach(() => { diff --git a/Makefile b/Makefile index 220c76b..fbba481 100644 --- a/Makefile +++ b/Makefile @@ -20,14 +20,13 @@ terminalManagement: spec=TfmAPIService-v1 payment: spec=PaymentService-v68 recurring: spec=RecurringService-v68 payout: spec=PayoutService-v68 -management: spec=ManagementService-v1 +management: spec=ManagementService-v3 legalEntityManagement: spec=LegalEntityService-v3 platformsAccount: spec=AccountService-v6 platformsFund: spec=FundService-v6 platformsNotificationConfiguration: spec=NotificationConfigurationService-v6 platformsHostedOnboardingPage: spec=HopService-v6 -transfers: spec=TransferService-v3 - +transfers: spec=TransferService-v4 # BalanceWebhooks acsWebhooks: spec=BalancePlatformAcsNotification-v1 configurationWebhooks: spec=BalancePlatformConfigurationNotification-v1 diff --git a/README.md b/README.md index 7162e3e..58067e1 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ This library supports the following: | [DataProtection API](https://docs.adyen.com/development-resources/data-protection-api) | v1 | Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email) | [DataProtection](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/dataProtectionApi.ts) | | [Legal Entity Management API](https://docs.adyen.com/api-explorer/legalentity/3/overview) | v3 | Manage legal entities that contain information required for verification. | [LegalEntityManagement](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/legalEntityManagement/index.ts) | | [Local/Cloud-based Terminal API](https://docs.adyen.com/point-of-sale/terminal-api-reference) | - | Our point-of-sale integration. | [TerminalLocalAPI](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/terminalLocalAPI.ts) or [TerminalCloudAPI](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/terminalCloudAPI.ts) | -| [Management API](https://docs.adyen.com/api-explorer/Management/1/overview) | v1 | Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. | [Management](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/management/index.ts) | +| [Management API](https://docs.adyen.com/api-explorer/Management/3/overview) | v3 | Configure and manage your Adyen company and merchant accounts, stores, and payment terminals. | [Management](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/management/index.ts) | | [Payments API](https://docs.adyen.com/api-explorer/Payment/68/overview) | v68 | Our classic integration for online payments. | [ClassicIntegrationAPI](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/paymentApi.ts) | | [Payouts API](https://docs.adyen.com/api-explorer/Payout/68/overview) | v68 | Endpoints for sending funds to your customers. | [Payout](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/payout/index.ts) | | [Platforms APIs](https://docs.adyen.com/platforms/api) | - | Set of APIs when using Adyen for Platforms. This API is used for the classic integration. | [Platforms](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/platforms.ts) | @@ -34,7 +34,7 @@ This library supports the following: | [POS Terminal Management API](https://docs.adyen.com/api-explorer/postfmapi/1/overview) | v1 | Endpoints for managing your point-of-sale payment terminals. | [TerminalManagement](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/terminalManagementApi.ts) | | [Recurring API](https://docs.adyen.com/api-explorer/Recurring/68/overview) | v68 | Endpoints for managing saved payment details. | [Recurring](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/recurringApi.ts) | | [Stored Value API](https://docs.adyen.com/payment-methods/gift-cards/stored-value-api) | v46 | Manage both online and point-of-sale gift cards and other stored-value cards. | [StoredValue](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/storedValueApi.ts) | -| [Transfers API](https://docs.adyen.com/api-explorer/transfers/3/overview) | v3 | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | [Transfers](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/transfers/index.ts) | +| [Transfers API](https://docs.adyen.com/api-explorer/transfers/4/overview) | v4 | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | [Transfers](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/transfers/index.ts) | | [Disputes API](https://docs.adyen.com/api-explorer/Disputes/30/overview) | v30 | You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. | [Disputes](https://github.com/Adyen/adyen-node-api-library/blob/main/src/services/disputesApi.ts) | ## Supported Webhook versions @@ -44,9 +44,9 @@ The library supports all webhooks under the following model directories: |---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|-------------------| | [Authentication Webhooks](https://docs.adyen.com/api-explorer/acs-webhook/1/overview) | Adyen sends this webhook when the process of cardholder authentication is finalized, whether it is completed successfully, fails, or expires. | [AcsWebhooks](src/typings/acsWebhooks) | **v1** | | [Configuration Webhooks](https://docs.adyen.com/api-explorer/balanceplatform-webhooks/1/overview) | You can use these webhooks to build your implementation. For example, you can use this information to update internal statuses when the status of a capability is changed. | [ConfigurationNotification](src/typings/configurationWebhooks) | **v1** | -| [Transfer Webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/3/overview) | You can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds. | [TransferNotification](src/typings/transferWebhooks) | **v3** | +| [Transfer Webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/4/overview) | You can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds. | [TransferNotification](src/typings/transferWebhooks) | **v4** | | [Report Webhooks](https://docs.adyen.com/api-explorer/report-webhooks/1/overview) | You can download reports programmatically by making an HTTP GET request, or manually from your Balance Platform Customer Area | [ReportNotification](src/typings/reportWebhooks) | **v1** | -| [Management Webhooks](https://docs.adyen.com/api-explorer/ManagementNotification/1/overview) | Adyen uses webhooks to inform your system about events that happen with your Adyen company and merchant accounts, stores, payment terminals, and payment methods when using Management API. | [ManagementWebhooks](src/typings/managementWebhooks) | **v1** | +| [Management Webhooks](https://docs.adyen.com/api-explorer/ManagementNotification/3/overview) | Adyen uses webhooks to inform your system about events that happen with your Adyen company and merchant accounts, stores, payment terminals, and payment methods when using Management API. | [ManagementWebhooks](src/typings/managementWebhooks) | **v3** | | [Notification Webhooks](https://docs.adyen.com/api-explorer/Webhooks/1/overview) | We use webhooks to send you updates about payment status updates, newly available reports, and other events that you can subscribe to. For more information, refer to our documentation | [Notification](src/typings/notification) | **v1** | For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/). diff --git a/src/__tests__/management.spec.ts b/src/__tests__/management.spec.ts index da3e502..b449614 100644 --- a/src/__tests__/management.spec.ts +++ b/src/__tests__/management.spec.ts @@ -28,7 +28,7 @@ beforeEach((): void => { nock.activate(); } client = createClient(); - scope = nock("https://management-test.adyen.com/v1"); + scope = nock("https://management-test.adyen.com/v3"); managementService = new ManagementAPI(client); }); @@ -678,7 +678,7 @@ describe("Management", (): void => { ...requests.createMerchantWebhookRequest, communicationFormat: management.CreateMerchantWebhookRequest.CommunicationFormatEnum.Json, networkType: management.CreateMerchantWebhookRequest.NetworkTypeEnum.Public, - sslVersion: management.CreateMerchantWebhookRequest.SslVersionEnum.Tlsv12 + encryptionProtocol: management.CreateMerchantWebhookRequest.EncryptionProtocolEnum.Tlsv12 }); expect(response).toBeTruthy(); @@ -708,7 +708,7 @@ describe("Management", (): void => { ...requests.updateMerchantWebhookRequest, communicationFormat: management.CreateMerchantWebhookRequest.CommunicationFormatEnum.Soap, networkType: management.CreateMerchantWebhookRequest.NetworkTypeEnum.Local, - sslVersion: management.CreateMerchantWebhookRequest.SslVersionEnum.Tlsv13 + encryptionProtocol: management.CreateMerchantWebhookRequest.EncryptionProtocolEnum.Tlsv13 }); expect(response).toBeTruthy(); diff --git a/src/__tests__/transfers.spec.ts b/src/__tests__/transfers.spec.ts index 4c26a42..0e79cef 100644 --- a/src/__tests__/transfers.spec.ts +++ b/src/__tests__/transfers.spec.ts @@ -15,7 +15,7 @@ beforeEach((): void => { } client = createClient(); transfersAPI = new TransfersAPI(client); - scope = nock("https://balanceplatform-api-test.adyen.com/btl/v3"); + scope = nock("https://balanceplatform-api-test.adyen.com/btl/v4"); }); afterEach(() => {
diff --git a/Makefile b/Makefile index 5b74396..7d683f4 100644 --- a/Makefile +++ b/Makefile @@ -30,7 +30,7 @@ transfers: spec=TransferService-v4 acsWebhooks: spec=BalancePlatformAcsNotification-v1 configurationWebhooks: spec=BalancePlatformConfigurationNotification-v1 reportWebhooks: spec=BalancePlatformReportNotification-v1 -transferWebhooks: spec=BalancePlatformTransferNotification-v3 +transferWebhooks: spec=BalancePlatformTransferNotification-v4 # ManagementWebhooks managementWebhooks: spec=ManagementNotificationService-v1
Aleffio
force-pushed
the
feature/management_transfers_upgrade
branch
from
15c75eb
to
222ffd2
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
michaelpaul
approved these changes
Oct 23, 2023
jillingk
approved these changes
Oct 23, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR upgrades: