@govuk-pay/cli 0.0.120 → 0.0.122

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-pay/cli",
-  "version": "0.0.120",
+  "version": "0.0.122",
   "description": "GOV.UK Pay Command Line Interface",
   "bin": {
     "pay": "bin/cli.js",

package/src/commands/local/app_client/app_client.js

@@ -39,10 +39,12 @@ const appClient = {
         const typedBody = body;
         return typedBody._links;
     },
-    async createService() {
+    async createService(serviceName = 'My service') {
         const createServiceData = {
-            en: 'My service',
-            cy: 'Welsh name for My service'
+            service_name: {
+                en: serviceName,
+                cy: `Welsh name for ${serviceName}`
+            }
         };
         const url = urlFor('adminusers', '/v1/api/services');
         const result = await (0, fetch_wrapper_1.postRequest)(url, createServiceData);
@@ -78,11 +80,11 @@ const appClient = {
         }
         return account;
     },
-    async createAccount(serviceID) {
+    async createAccount(serviceID, paymentProvider = 'sandbox', type = 'test') {
         const createAccountData = {
-            payment_provider: 'sandbox',
-            service_name: 'My service',
-            type: 'test',
+            payment_provider: paymentProvider,
+            service_name: `My ${type} ${paymentProvider} service`,
+            type,
             service_id: serviceID
         };
         const url = urlFor('connector', '/v1/api/accounts');
@@ -99,6 +101,97 @@ const appClient = {
         const typedBody = body;
         return typedBody;
     },
+    async completeStripeOnboarding(serviceID) {
+        const patchStripeAccountSetupData = [{
+                op: 'replace',
+                path: 'bank_account',
+                value: true
+            }, {
+                op: 'replace',
+                path: 'responsible_person',
+                value: true
+            }, {
+                op: 'replace',
+                path: 'vat_number',
+                value: true
+            }, {
+                op: 'replace',
+                path: 'company_number',
+                value: true
+            }, {
+                op: 'replace',
+                path: 'director',
+                value: true
+            }, {
+                op: 'replace',
+                path: 'government_entity_document',
+                value: true
+            }, {
+                op: 'replace',
+                path: 'organisation_details',
+                value: true
+            }];
+        const url = urlFor('connector', `/v1/api/service/${serviceID}/account/live/stripe-setup`);
+        const result = await (0, fetch_wrapper_1.patchRequest)(url, patchStripeAccountSetupData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        return true;
+    },
+    async enableProviderSwitching(serviceID) {
+        const patchProviderSwitchingEnabledData = {
+            op: 'replace',
+            path: 'provider_switch_enabled',
+            value: true
+        };
+        const url = urlFor('connector', `/v1/api/service/${serviceID}/account/live`);
+        const result = await (0, fetch_wrapper_1.patchRequest)(url, patchProviderSwitchingEnabledData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        return true;
+    },
+    async createAccountCredentials(serviceID, paymentProvider) {
+        const url = urlFor('connector', `/v1/api/service/${serviceID}/account/live/credentials`);
+        const credentialsData = {
+            credentials: {},
+            payment_provider: paymentProvider
+        };
+        const result = await (0, fetch_wrapper_1.postRequest)(url, credentialsData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        if (body === undefined || typeof body === 'string') {
+            console.error('The response to a create an account did not have a body, or the body was not JSON!');
+            return;
+        }
+        const typedBody = body;
+        return typedBody;
+    },
+    async updateStripeAccountCredentials(serviceID, credentialID) {
+        const url = urlFor('connector', `/v1/api/service/${serviceID}/account/live/credentials/${credentialID}`);
+        const patchAccountCredentialsData = [{
+                op: 'replace',
+                path: 'credentials',
+                value: { stripe_account_id: 'stripe-account-123' }
+            }];
+        const result = await (0, fetch_wrapper_1.patchRequest)(url, patchAccountCredentialsData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        if (body === undefined || typeof body === 'string') {
+            console.error('The response to a update a credential did not have a body, or the body was not JSON!');
+            return;
+        }
+        const typedBody = body;
+        return typedBody;
+    },
     async getAccount(gatewayAccountId) {
         const url = urlFor('connector', `/v1/api/accounts/${gatewayAccountId}`);
         const result = await (0, fetch_wrapper_1.getRequest)(url);
@@ -137,6 +230,20 @@ const appClient = {
         }
         return true;
     },
+    async setGoLiveStatusToLive(serviceID) {
+        const patchGoLiveStatusData = {
+            op: 'replace',
+            path: 'current_go_live_stage',
+            value: 'LIVE'
+        };
+        const url = urlFor('adminusers', `/v1/api/services/${serviceID}`);
+        const result = await (0, fetch_wrapper_1.patchRequest)(url, patchGoLiveStatusData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        return true;
+    },
     async createToken(gatewayAccountID, serviceExternalId, serviceMode) {
         const createTokenData = {
             account_id: gatewayAccountID,
@@ -205,6 +312,32 @@ const appClient = {
         };
         return typedAugmentedBody;
     },
+    async getUser(userEmailAddress) {
+        const url = urlFor('adminusers', '/v1/api/users/find');
+        const emailData = {
+            email: userEmailAddress
+        };
+        const result = await (0, fetch_wrapper_1.postRequest)(url, emailData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        return body;
+    },
+    async assignUserAsAdminToService(userExternalID, serviceExternalID) {
+        const url = urlFor('adminusers', `/v1/api/users/${userExternalID}/services`);
+        const serviceRoleData = {
+            service_external_id: serviceExternalID,
+            role_name: 'admin'
+        };
+        const result = await (0, fetch_wrapper_1.postRequest)(url, serviceRoleData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        return true;
+    },
     async isHealthy(serviceName) {
         const url = urlFor(serviceName, '/healthcheck');
         const response = await (0, fetch_wrapper_1.getRequest)(url);

package/src/commands/local/subcommands/service.js

@@ -0,0 +1,109 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.builder = exports.handler = exports.desc = exports.command = void 0;
+const standardContent_1 = require("../../../core/standardContent");
+const app_client_1 = __importDefault(require("../app_client/app_client"));
+exports.command = 'service <email>';
+exports.desc = 'Create an Adyen migration service';
+exports.handler = serviceHandler;
+const builder = (yargs) => {
+    return yargs
+        .usage(`$0 local service <email> \n\n${exports.desc}`)
+        .positional('email', {
+        type: 'string',
+        description: 'Email address of an existing user to assign as admin for the service'
+    });
+};
+exports.builder = builder;
+async function serviceHandler(argv) {
+    await (0, standardContent_1.showHeader)();
+    if (await app_client_1.default.isUnhealthy('adminusers')) {
+        console.error('Adminusers is unhealthy');
+        return;
+    }
+    if (await app_client_1.default.isUnhealthy('connector')) {
+        console.error('Connector is unhealthy');
+        return;
+    }
+    const serviceExternalID = await app_client_1.default.createService('Adyen migration service');
+    if (serviceExternalID === undefined) {
+        console.error('Unable to create a service');
+        return;
+    }
+    console.log(`💁  Service ID: ${serviceExternalID}`);
+    const userEmailAddress = argv.email;
+    const user = await app_client_1.default.getUser(userEmailAddress);
+    if (user === undefined) {
+        console.error('Failed to retrieve user');
+        return;
+    }
+    const userAssignedToService = await app_client_1.default.assignUserAsAdminToService(user.external_id, serviceExternalID);
+    if (userAssignedToService === undefined) {
+        console.error('Failed to add user');
+        return;
+    }
+    console.log(`🤓  Assigned user [${user.external_id}] as admin to service [${serviceExternalID}]`);
+    const testAccount = await app_client_1.default.createAccount(serviceExternalID);
+    if (testAccount === undefined) {
+        console.error('Failed to create a fully set up test account');
+        return;
+    }
+    console.log(`🆔  Test gateway account ID: ${testAccount.gateway_account_id}`);
+    const liveStripeAccount = await app_client_1.default.createAccount(serviceExternalID, 'stripe', 'live');
+    if (liveStripeAccount === undefined) {
+        console.error('Failed to create a live Stripe account');
+        return;
+    }
+    const testAccountID = testAccount.gateway_account_id;
+    const liveStripeAccountId = liveStripeAccount.gateway_account_id;
+    const gatewayAccountsIDs = [testAccountID, liveStripeAccountId];
+    console.log(`🆔  Live Stripe gateway account ID: ${liveStripeAccountId}`);
+    for (const accountId of gatewayAccountsIDs) {
+        const success = await app_client_1.default.addGatewayAccountToService(accountId, serviceExternalID);
+        if (!success) {
+            console.error('Failed to add the gateway account to the service');
+        }
+        else {
+            console.warn(`➕ Added gateway account ID [${accountId}] to Service ID [${serviceExternalID}]`);
+        }
+    }
+    const stripeAccountSetupTasksCompleted = await app_client_1.default.completeStripeOnboarding(serviceExternalID);
+    if (stripeAccountSetupTasksCompleted === undefined) {
+        console.error('Failed to complete Stripe onboarding tasks');
+        return;
+    }
+    console.log(`✅  Stripe onboarding tasks completed for gateway account [${liveStripeAccountId}]`);
+    const hasLiveStatus = await app_client_1.default.setGoLiveStatusToLive(serviceExternalID);
+    if (hasLiveStatus === undefined) {
+        console.error('Failed to update go live status for service');
+        return;
+    }
+    console.log(`▶️  Go live status set to live for Service ID [${serviceExternalID}]`);
+    const liveStripeAccountResponse = await app_client_1.default.getAccount(liveStripeAccountId);
+    if (liveStripeAccountResponse === undefined) {
+        console.error(`No gateway account exists with ID: ${liveStripeAccount.gateway_account_id}`);
+        return;
+    }
+    const stripeCredentialID = liveStripeAccountResponse.gateway_account_credentials[0].external_id;
+    const stripeGatewayAccountCredential = await app_client_1.default.updateStripeAccountCredentials(serviceExternalID, stripeCredentialID);
+    if (stripeGatewayAccountCredential === undefined) {
+        console.error('Failed to create a Stripe account credential');
+        return;
+    }
+    console.log(`⬆️   Live Stripe gateway account credential [${stripeGatewayAccountCredential.external_id}] set to active`);
+    const adyenGatewayAccountCredential = await app_client_1.default.createAccountCredentials(serviceExternalID, 'adyen');
+    if (adyenGatewayAccountCredential === undefined) {
+        console.error('Failed to create an Adyen account credential');
+        return;
+    }
+    console.log(`📑  Live Adyen gateway account credential ID: ${adyenGatewayAccountCredential.external_id}`);
+    const liveStripeAccountSwitchingFlagEnabled = await app_client_1.default.enableProviderSwitching(serviceExternalID);
+    if (liveStripeAccountSwitchingFlagEnabled === undefined) {
+        console.error('Failed to enable provider switching');
+        return;
+    }
+    console.log(`🔁  Provider switching enabled for account [${liveStripeAccountId}]`);
+}

package/src/commands/secrets/config/secrets/pay_low_pass/production-2.js

@@ -17,6 +17,8 @@ exports.PRODUCTION_2_CONFIG = {
         DB_SUPPORT_PASSWORD_READONLY: 'aws/rds/support_readonly_users/production/connector_support_readonly', // pragma: allowlist secret
         DB_SUPPORT_PASSWORD_READWRITE: 'aws/rds/support_readwrite_users/production/connector_support_readwrite', // pragma: allowlist secret
         NOTIFY_API_KEY: 'notify/api_key/deploy/production.connector.notify_api_key', // pragma: allowlist secret
+        GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_TEST: 'adyen/production/test/company-account-api-key', // pragma: allowlist secret
+        GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_LIVE: '', // pragma: allowlist secret
         GDS_CONNECTOR_STRIPE_AUTH_TOKEN: 'stripe/production/test/account-api-key',
         GDS_CONNECTOR_STRIPE_AUTH_LIVE_TOKEN: 'stripe/production/live/account-api-key',
         GDS_CONNECTOR_STRIPE_WEBHOOK_SIGN_SECRET: 'stripe/production/test/webhook-secret', // pragma: allowlist secret

package/src/commands/secrets/config/secrets/pay_low_pass/staging-2.js

@@ -17,6 +17,8 @@ exports.STAGING_2_CONFIG = {
         DB_SUPPORT_PASSWORD_READONLY: 'aws/rds/support_readonly_users/staging/connector_support_readonly', // pragma: allowlist secret
         DB_SUPPORT_PASSWORD_READWRITE: 'aws/rds/support_readwrite_users/staging/connector_support_readwrite', // pragma: allowlist secret
         NOTIFY_API_KEY: 'notify/api_key/deploy/staging.connector.notify_api_key', // pragma: allowlist secret
+        GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_TEST: 'adyen/staging/test/company-account-api-key', // pragma: allowlist secret
+        GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_LIVE: 'adyen/staging/test/company-account-api-key', // pragma: allowlist secret
         GDS_CONNECTOR_STRIPE_AUTH_TOKEN: 'stripe/staging/test/account-api-key',
         GDS_CONNECTOR_STRIPE_AUTH_LIVE_TOKEN: 'stripe/staging/test/account-api-key',
         GDS_CONNECTOR_STRIPE_WEBHOOK_SIGN_SECRET: 'stripe/staging/test/webhook-secret', // pragma: allowlist secret

package/src/commands/secrets/config/secrets/pay_low_pass/test-12.js

@@ -17,6 +17,8 @@ exports.TEST_12_CONFIG = {
         DB_SUPPORT_PASSWORD_READONLY: 'aws/rds/support_readonly_users/test/connector_support_readonly', // pragma: allowlist secret
         DB_SUPPORT_PASSWORD_READWRITE: 'aws/rds/support_readwrite_users/test/connector_support_readwrite', // pragma: allowlist secret
         NOTIFY_API_KEY: 'notify/api_key/ci/test.connector.notify_api_key', // pragma: allowlist secret
+        GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_TEST: 'adyen/test/test/company-account-api-key', // pragma: allowlist secret
+        GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_LIVE: 'adyen/test/test/company-account-api-key', // pragma: allowlist secret
         GDS_CONNECTOR_STRIPE_AUTH_TOKEN: 'stripe/test/test/account-api-key',
         GDS_CONNECTOR_STRIPE_AUTH_LIVE_TOKEN: 'stripe/test/test/account-api-key',
         GDS_CONNECTOR_STRIPE_WEBHOOK_SIGN_SECRET: 'stripe/test/test/webhook-secret', // pragma: allowlist secret

package/src/commands/secrets/config/secrets/pay_low_pass/test-perf-1.js

@@ -17,6 +17,8 @@ exports.TEST_PERF_1_CONFIG = {
         DB_SUPPORT_PASSWORD_READONLY: 'aws/rds/support_readonly_users/test-perf/connector_support_readonly', // pragma: allowlist secret
         DB_SUPPORT_PASSWORD_READWRITE: 'aws/rds/support_readwrite_users/test-perf/connector_support_readwrite', // pragma: allowlist secret
         NOTIFY_API_KEY: 'notify/api_key/ci/test_perf.connector.notify_api_key', // pragma: allowlist secret
+        GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_TEST: 'adyen/test/test/company-account-api-key', // pragma: allowlist secret
+        GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_LIVE: 'adyen/test/test/company-account-api-key', // pragma: allowlist secret
         GDS_CONNECTOR_STRIPE_AUTH_TOKEN: 'stripe/test/test/account-api-key',
         GDS_CONNECTOR_STRIPE_AUTH_LIVE_TOKEN: 'stripe/test/test/account-api-key',
         GDS_CONNECTOR_STRIPE_WEBHOOK_SIGN_SECRET: 'stripe/test/test/webhook-secret', // pragma: allowlist secret

package/src/commands/secrets/config/service_secrets.js

@@ -99,6 +99,8 @@ exports.SERVICE_SECRETS = {
         'DB_SUPPORT_USER_READONLY',
         'DB_SUPPORT_USER_READWRITE',
         'DB_USER',
+        'GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_TEST',
+        'GDS_CONNECTOR_ADYEN_COMPANY_ACCOUNT_API_KEY_LIVE',
         'GDS_CONNECTOR_STRIPE_AUTH_LIVE_TOKEN',
         'GDS_CONNECTOR_STRIPE_AUTH_TOKEN',
         'GDS_CONNECTOR_STRIPE_CONNECT_APPLICATION_WEBHOOK_LIVE_SIGN_SECRET',