@hubspot/cli 8.3.0-beta.1 → 8.4.0-beta.0

package/bin/cli.js

@@ -31,6 +31,7 @@ import testAccountCommands from '../commands/testAccount.js';
 import getStartedCommand from '../commands/getStarted.js';
 import mcpCommand from '../commands/mcp.js';
 import upgradeCommand from '../commands/upgrade.js';
+import apiCommand from '../commands/api.js';
 import { uiLogger } from '../lib/ui/logger.js';
 import { initializeSpinniesManager } from '../lib/middleware/spinniesMiddleware.js';
 import { addCommandSuggestions } from '../lib/commandSuggestion.js';
@@ -111,6 +112,7 @@ const argv = yargs(process.argv.slice(2))
     .command(hubdbCommand)
     .command(filemanagerCommand)
     // Misc commands
+    .command(apiCommand)
     .command(customObjectCommand)
     .command(completionCommand)
     .command(doctorCommand)

package/commands/account/auth.js

@@ -2,15 +2,15 @@ import { ENVIRONMENTS } from '@hubspot/local-dev-lib/constants/environments';
 import { PERSONAL_ACCESS_KEY_AUTH_METHOD } from '@hubspot/local-dev-lib/constants/auth';
 import { deleteConfigFileIfEmpty } from '@hubspot/local-dev-lib/config';
 import { handleExit } from '../../lib/process.js';
-import { trackCommandUsage, trackAuthAction } from '../../lib/usageTracking.js';
+import { trackAuthAction } from '../../lib/usageTracking.js';
 import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
 import { uiFeatureHighlight } from '../../lib/ui/index.js';
 import { parseStringToNumber } from '../../lib/parsing.js';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
 import { commands } from '../../lang/en.js';
 import { uiLogger } from '../../lib/ui/logger.js';
 import { authenticateNewAccount } from '../../lib/accountAuth.js';
-import { PromptExitError } from '../../lib/errors/PromptExitError.js';
 const TRACKING_STATUS = {
     STARTED: 'started',
     ERROR: 'error',
@@ -20,7 +20,7 @@ const authType = PERSONAL_ACCESS_KEY_AUTH_METHOD.value;
 const describe = commands.account.subcommands.auth.describe;
 const command = 'auth';
 async function handler(args) {
-    const { disableTracking, personalAccessKey: providedPersonalAccessKey, userProvidedAccount, } = args;
+    const { disableTracking, personalAccessKey: providedPersonalAccessKey, userProvidedAccount, exit, } = args;
     let parsedUserProvidedAccountId;
     if (userProvidedAccount) {
         try {
@@ -28,33 +28,23 @@ async function handler(args) {
         }
         catch (err) {
             uiLogger.error(commands.account.subcommands.auth.errors.invalidAccountIdProvided);
-            process.exit(EXIT_CODES.ERROR);
+            return exit(EXIT_CODES.ERROR);
         }
     }
     if (!disableTracking) {
-        trackCommandUsage('account-auth', {}, parsedUserProvidedAccountId);
         await trackAuthAction('account-auth', authType, TRACKING_STATUS.STARTED);
     }
     handleExit(deleteConfigFileIfEmpty);
-    let updatedConfig;
-    try {
-        updatedConfig = await authenticateNewAccount({
-            env: args.qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD,
-            providedPersonalAccessKey,
-            accountId: parsedUserProvidedAccountId,
-        });
-    }
-    catch (e) {
-        if (e instanceof PromptExitError) {
-            process.exit(e.exitCode);
-        }
-        throw e;
-    }
+    const updatedConfig = await authenticateNewAccount({
+        env: args.qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD,
+        providedPersonalAccessKey,
+        accountId: parsedUserProvidedAccountId,
+    });
     if (!updatedConfig) {
         if (!disableTracking) {
             await trackAuthAction('account-auth', authType, TRACKING_STATUS.ERROR);
         }
-        return process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
     const { accountId } = updatedConfig;
     uiFeatureHighlight([
@@ -66,7 +56,7 @@ async function handler(args) {
     if (!disableTracking) {
         await trackAuthAction('account-auth', authType, TRACKING_STATUS.COMPLETE, accountId);
     }
-    process.exit(EXIT_CODES.SUCCESS);
+    return exit(EXIT_CODES.SUCCESS);
 }
 function accountAuthBuilder(yargs) {
     yargs.options({
@@ -96,7 +86,7 @@ const builder = makeYargsBuilder(accountAuthBuilder, command, commands.account.s
 const accountAuthCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('account-auth', handler),
     builder,
 };
 export default accountAuthCommand;

package/commands/account/clean.js

@@ -3,12 +3,12 @@ import { accessTokenForPersonalAccessKey } from '@hubspot/local-dev-lib/personal
 import { removeAccountFromConfig, getAllConfigAccounts, getConfigDefaultAccountIfExists, setConfigAccountAsDefault, } from '@hubspot/local-dev-lib/config';
 import { getDefaultAccountOverrideAccountId, getDefaultAccountOverrideFilePath, } from '@hubspot/local-dev-lib/config/defaultAccountOverride';
 import { isSpecifiedError } from '@hubspot/local-dev-lib/errors/index';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
 import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
 import { promptUser } from '../../lib/prompts/promptUtils.js';
 import { selectAccountFromConfig } from '../../lib/prompts/accountsPrompt.js';
 import SpinniesManager from '../../lib/ui/SpinniesManager.js';
 import { uiAccountDescription } from '../../lib/ui/index.js';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { logError } from '../../lib/errorHandlers/index.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
 import { commands } from '../../lang/en.js';
@@ -17,13 +17,12 @@ import { renderList } from '../../ui/render.js';
 const command = 'clean';
 const describe = commands.account.subcommands.clean.describe;
 async function handler(args) {
-    const { qa } = args;
-    trackCommandUsage('accounts-clean');
+    const { qa, exit } = args;
     const accountsList = getAllConfigAccounts();
     const filteredTestAccounts = accountsList.filter(p => qa ? p.env === 'qa' : p.env !== 'qa');
     if (filteredTestAccounts && filteredTestAccounts.length === 0) {
         uiLogger.log(commands.account.subcommands.clean.noResults);
-        process.exit(EXIT_CODES.SUCCESS);
+        return exit(EXIT_CODES.SUCCESS);
     }
     const accountsToRemove = [];
     SpinniesManager.init({
@@ -105,7 +104,7 @@ async function handler(args) {
         });
     }
     uiLogger.log('');
-    process.exit(EXIT_CODES.SUCCESS);
+    return exit(EXIT_CODES.SUCCESS);
 }
 function accountCleanBuilder(yargs) {
     yargs.example([['$0 accounts clean']]);
@@ -119,7 +118,7 @@ const builder = makeYargsBuilder(accountCleanBuilder, command, describe, {
 const accountCleanCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('accounts-clean', handler),
     builder,
 };
 export default accountCleanCommand;

package/commands/account/createOverride.js

@@ -6,20 +6,21 @@ import { getConfigFilePath, getConfigAccountIfExists, globalConfigFileExists, ge
 import { getDefaultAccountOverrideAccountId, getDefaultAccountOverrideFilePath, } from '@hubspot/local-dev-lib/config/defaultAccountOverride';
 import { promptUser } from '../../lib/prompts/promptUtils.js';
 import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
 import { selectAccountFromConfig } from '../../lib/prompts/accountsPrompt.js';
 import { logError } from '../../lib/errorHandlers/index.js';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
 import { commands } from '../../lang/en.js';
 import { uiLogger } from '../../lib/ui/logger.js';
 const command = 'create-override [account]';
 const describe = commands.account.subcommands.createOverride.describe(DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME);
 async function handler(args) {
+    const { exit } = args;
     let overrideDefaultAccount = args.account;
     const globalConfigExists = globalConfigFileExists();
     if (!globalConfigExists) {
         uiLogger.error(commands.account.subcommands.createOverride.errors.globalConfigNotFound);
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
     const accounts = getAllConfigAccounts();
     const accountOverrideId = getDefaultAccountOverrideAccountId(accounts);
@@ -33,7 +34,7 @@ async function handler(args) {
         });
         uiLogger.log('');
         if (!replaceOverrideFile) {
-            process.exit(EXIT_CODES.SUCCESS);
+            return exit(EXIT_CODES.SUCCESS);
         }
     }
     if (!overrideDefaultAccount) {
@@ -48,16 +49,15 @@ async function handler(args) {
     }
     const account = getConfigAccountIfExists(overrideDefaultAccount);
     const accountId = account?.accountId;
-    trackCommandUsage('account-createOverride', undefined, accountId);
     try {
         const overrideFilePath = path.join(getCwd(), DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME);
         await fs.writeFile(overrideFilePath, accountId.toString(), 'utf8');
         uiLogger.success(commands.account.subcommands.createOverride.success(overrideFilePath));
-        process.exit(EXIT_CODES.SUCCESS);
+        return exit(EXIT_CODES.SUCCESS);
     }
     catch (e) {
         logError(e);
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
 }
 function accountCreateOverrideBuilder(yargs) {
@@ -87,7 +87,7 @@ const builder = makeYargsBuilder(accountCreateOverrideBuilder, command, describe
 const accountCreateOverrideCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('account-createOverride', handler),
     builder,
 };
 export default accountCreateOverrideCommand;

package/commands/account/info.js

@@ -3,6 +3,7 @@ import { getDefaultAccountOverrideFilePath } from '@hubspot/local-dev-lib/config
 import { getAccessToken } from '@hubspot/local-dev-lib/personalAccessKey';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
 import { indent } from '../../lib/ui/index.js';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { commands } from '../../lang/en.js';
 import { uiLogger } from '../../lib/ui/logger.js';
 import { renderList } from '../../ui/render.js';
@@ -69,7 +70,7 @@ const builder = makeYargsBuilder(accountInfoBuilder, command, describe, {
 const accountInfoCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('account-info', handler),
     builder,
 };
 export default accountInfoCommand;

package/commands/account/list.js

@@ -1,9 +1,9 @@
 import { getConfigFilePath, getAllConfigAccounts, getConfigDefaultAccountIfExists, } from '@hubspot/local-dev-lib/config';
 import { getDefaultAccountOverrideFilePath } from '@hubspot/local-dev-lib/config/defaultAccountOverride';
 import { indent } from '../../lib/ui/index.js';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
 import { isSandbox, isDeveloperTestAccount } from '../../lib/accountTypes.js';
 import { HUBSPOT_ACCOUNT_TYPES, HUBSPOT_ACCOUNT_TYPE_STRINGS, } from '@hubspot/local-dev-lib/constants/config';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
 import { uiLogger } from '../../lib/ui/logger.js';
 import { commands } from '../../lang/en.js';
@@ -58,9 +58,7 @@ function getAccountData(mappedAccountData) {
     });
     return accountData;
 }
-async function handler(args) {
-    const { derivedAccountId } = args;
-    trackCommandUsage('accounts-list', undefined, derivedAccountId);
+async function handler() {
     const configPath = getConfigFilePath();
     const accountsList = getAllConfigAccounts();
     const mappedAccountData = sortAndMapAccounts(accountsList);
@@ -101,7 +99,7 @@ const builder = makeYargsBuilder(accountListBuilder, command, describe, {
 const accountListCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('accounts-list', handler),
     builder,
 };
 export default accountListCommand;

package/commands/account/remove.js

@@ -1,10 +1,10 @@
 import fs from 'fs';
 import { getConfigFilePath, removeAccountFromConfig, getConfigDefaultAccountIfExists, getConfigAccountIfExists, getConfigAccountById, setConfigAccountAsDefault, getAllConfigAccounts, } from '@hubspot/local-dev-lib/config';
 import { getDefaultAccountOverrideAccountId, getDefaultAccountOverrideFilePath, } from '@hubspot/local-dev-lib/config/defaultAccountOverride';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
 import { promptUser } from '../../lib/prompts/promptUtils.js';
 import { logError } from '../../lib/errorHandlers/index.js';
 import { selectAccountFromConfig } from '../../lib/prompts/accountsPrompt.js';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
 import { uiLogger } from '../../lib/ui/logger.js';
 import { commands } from '../../lang/en.js';
@@ -23,7 +23,6 @@ async function handler(args) {
         accountToRemoveId = await selectAccountFromConfig(commands.account.subcommands.remove.prompts.selectAccountToRemove);
     }
     accountToRemoveConfig = getConfigAccountById(accountToRemoveId);
-    trackCommandUsage('accounts-remove', undefined, accountToRemoveId);
     const currentDefaultAccount = getConfigDefaultAccountIfExists();
     const accounts = getAllConfigAccounts();
     const accountOverride = getDefaultAccountOverrideAccountId(accounts);
@@ -81,7 +80,7 @@ const builder = makeYargsBuilder(accountRemoveBuilder, command, describe, {
 const accountRemoveCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('accounts-remove', handler),
     builder,
 };
 export default accountRemoveCommand;

package/commands/account/removeOverride.js

@@ -3,27 +3,25 @@ import { globalConfigFileExists, getAllConfigAccounts, } from '@hubspot/local-de
 import { getDefaultAccountOverrideAccountId, getDefaultAccountOverrideFilePath, } from '@hubspot/local-dev-lib/config/defaultAccountOverride';
 import { DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME } from '@hubspot/local-dev-lib/constants/config';
 import { promptUser } from '../../lib/prompts/promptUtils.js';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
 import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
 import { logError } from '../../lib/errorHandlers/index.js';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
 import { uiLogger } from '../../lib/ui/logger.js';
 import { commands } from '../../lang/en.js';
 const command = 'remove-override';
 const describe = commands.account.subcommands.removeOverride.describe(DEFAULT_ACCOUNT_OVERRIDE_FILE_NAME);
 async function handler(args) {
-    const { force } = args;
+    const { force, exit } = args;
     const globalConfigExists = globalConfigFileExists();
     if (!globalConfigExists) {
         uiLogger.error(commands.account.subcommands.removeOverride.errors.globalConfigNotFound);
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
     const accounts = getAllConfigAccounts();
     const accountOverride = getDefaultAccountOverrideAccountId(accounts);
     const overrideFilePath = getDefaultAccountOverrideFilePath();
     if (accountOverride && overrideFilePath) {
-        const accountId = accountOverride;
-        trackCommandUsage('account-removeOverride', undefined, accountId);
         if (!force) {
             uiLogger.log(commands.account.subcommands.removeOverride.accountOverride(overrideFilePath, accountOverride.toString()));
             const { deleteOverrideFile } = await promptUser({
@@ -34,22 +32,22 @@ async function handler(args) {
             });
             uiLogger.log('');
             if (!deleteOverrideFile) {
-                process.exit(EXIT_CODES.SUCCESS);
+                return exit(EXIT_CODES.SUCCESS);
             }
         }
         try {
             fs.unlinkSync(overrideFilePath);
             uiLogger.success(commands.account.subcommands.removeOverride.success);
-            process.exit(EXIT_CODES.SUCCESS);
+            return exit(EXIT_CODES.SUCCESS);
         }
         catch (error) {
             logError(error);
-            process.exit(EXIT_CODES.ERROR);
+            return exit(EXIT_CODES.ERROR);
         }
     }
     else {
         uiLogger.log(commands.account.subcommands.removeOverride.noOverrideFile);
-        process.exit(EXIT_CODES.SUCCESS);
+        return exit(EXIT_CODES.SUCCESS);
     }
 }
 function accountRemoveOverrideBuilder(yargs) {
@@ -65,7 +63,7 @@ const builder = makeYargsBuilder(accountRemoveOverrideBuilder, command, describe
 const accountRemoveOverrideCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('account-removeOverride', handler),
     builder,
 };
 export default accountRemoveOverrideCommand;

package/commands/account/rename.js

@@ -1,7 +1,7 @@
 import { renameConfigAccount } from '@hubspot/local-dev-lib/config';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
 import { commands } from '../../lang/en.js';
 import { uiLogger } from '../../lib/ui/logger.js';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { logError } from '../../lib/errorHandlers/index.js';
 import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
@@ -9,8 +9,7 @@ import { toKebabCase } from '@hubspot/local-dev-lib/text';
 const command = 'rename <account-name> <new-name>';
 const describe = commands.account.subcommands.rename.describe;
 async function handler(args) {
-    const { accountName, newName, derivedAccountId } = args;
-    trackCommandUsage('accounts-rename', undefined, derivedAccountId);
+    const { accountName, newName, exit } = args;
     const newNameKebabCase = toKebabCase(newName);
     const nameWasSanitized = newNameKebabCase !== newName;
     try {
@@ -18,10 +17,10 @@ async function handler(args) {
     }
     catch (error) {
         logError(error);
-        process.exit(EXIT_CODES.ERROR);
+        return exit(EXIT_CODES.ERROR);
     }
     uiLogger.success(commands.account.subcommands.rename.success.renamed(accountName, newNameKebabCase, nameWasSanitized));
-    process.exit(EXIT_CODES.SUCCESS);
+    return exit(EXIT_CODES.SUCCESS);
 }
 function accountRenameBuilder(yargs) {
     yargs.positional('account-name', {
@@ -45,7 +44,7 @@ const builder = makeYargsBuilder(accountRenameBuilder, command, describe, {
 const accountRenameCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('accounts-rename', handler),
     builder,
 };
 export default accountRenameCommand;

package/commands/account/use.js

@@ -1,17 +1,17 @@
 import { getConfigFilePath, setConfigAccountAsDefault, getConfigAccountIfExists, getConfigAccountByName, getConfigAccountById, globalConfigFileExists, getAllConfigAccounts, } from '@hubspot/local-dev-lib/config';
 import { getDefaultAccountOverrideAccountId, getDefaultAccountOverrideFilePath, } from '@hubspot/local-dev-lib/config/defaultAccountOverride';
 import { ENVIRONMENTS } from '@hubspot/local-dev-lib/constants/environments';
-import { trackCommandUsage } from '../../lib/usageTracking.js';
 import { commands } from '../../lang/en.js';
 import { uiLogger } from '../../lib/ui/logger.js';
 import { selectAccountFromConfig, AUTHENTICATE_NEW_ACCOUNT_VALUE, } from '../../lib/prompts/accountsPrompt.js';
+import { makeYargsHandlerWithUsageTracking } from '../../lib/yargs/makeYargsHandlerWithUsageTracking.js';
 import { makeYargsBuilder } from '../../lib/yargsUtils.js';
 import { authenticateNewAccount } from '../../lib/accountAuth.js';
-import { PromptExitError } from '../../lib/errors/PromptExitError.js';
 import { EXIT_CODES } from '../../lib/enums/exitCodes.js';
 const command = 'use [account]';
 const describe = commands.account.subcommands.use.describe;
 async function handler(args) {
+    const { exit } = args;
     let newDefaultAccount = args.account;
     const usingGlobalConfig = globalConfigFileExists();
     if (!newDefaultAccount) {
@@ -25,23 +25,13 @@ async function handler(args) {
         }
     }
     if (newDefaultAccount === AUTHENTICATE_NEW_ACCOUNT_VALUE) {
-        let updatedConfig;
-        try {
-            updatedConfig = await authenticateNewAccount({
-                env: args.qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD,
-                setAsDefaultAccount: true,
-            });
-        }
-        catch (e) {
-            if (e instanceof PromptExitError) {
-                process.exit(e.exitCode);
-            }
-            throw e;
-        }
+        const updatedConfig = await authenticateNewAccount({
+            env: args.qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD,
+            setAsDefaultAccount: true,
+        });
         if (!updatedConfig) {
-            process.exit(EXIT_CODES.ERROR);
+            return exit(EXIT_CODES.ERROR);
         }
-        trackCommandUsage('accounts-use', undefined, updatedConfig.accountId);
         return;
     }
     let account;
@@ -51,7 +41,6 @@ async function handler(args) {
     else {
         account = getConfigAccountByName(String(newDefaultAccount));
     }
-    trackCommandUsage('accounts-use', undefined, account?.accountId);
     const accounts = getAllConfigAccounts();
     const accountOverride = getDefaultAccountOverrideAccountId(accounts);
     const overrideFilePath = getDefaultAccountOverrideFilePath();
@@ -87,7 +76,7 @@ const builder = makeYargsBuilder(accountUseBuilder, command, describe, {
 const accountUseCommand = {
     command,
     describe,
-    handler,
+    handler: makeYargsHandlerWithUsageTracking('accounts-use', handler),
     builder,
 };
 export default accountUseCommand;

package/commands/api.d.ts

@@ -0,0 +1,10 @@
+import { CommonArgs, ConfigArgs, EnvironmentArgs, AccountArgs, JSONOutputArgs, YargsCommandModule } from '../types/Yargs.js';
+declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "PATCH", "DELETE"];
+type HttpMethod = (typeof HTTP_METHODS)[number];
+export type ApiArgs = CommonArgs & ConfigArgs & EnvironmentArgs & AccountArgs & JSONOutputArgs & {
+    endpoint: string;
+    method?: HttpMethod;
+    data?: string;
+};
+declare const apiCommand: YargsCommandModule<unknown, ApiArgs>;
+export default apiCommand;

package/commands/api.js

@@ -0,0 +1,164 @@
+import { http } from '@hubspot/local-dev-lib/http';
+import { getHubSpotApiOrigin } from '@hubspot/local-dev-lib/urls';
+import { getConfigAccountEnvironment } from '@hubspot/local-dev-lib/config';
+import { logError, debugError, ApiErrorContext, } from '../lib/errorHandlers/index.js';
+import { isHubSpotHttpError } from '@hubspot/local-dev-lib/errors/index';
+import { commands } from '../lang/en.js';
+import { EXIT_CODES } from '../lib/enums/exitCodes.js';
+import { makeYargsHandlerWithUsageTracking } from '../lib/yargs/makeYargsHandlerWithUsageTracking.js';
+import { makeYargsBuilder } from '../lib/yargsUtils.js';
+import { uiLogger } from '../lib/ui/logger.js';
+const HTTP_METHODS = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'];
+const command = 'api <endpoint>';
+const describe = commands.api.describe;
+function parseRequestData(data) {
+    try {
+        return JSON.parse(data);
+    }
+    catch {
+        return undefined;
+    }
+}
+function resolveMethod(args) {
+    if (args.method) {
+        return args.method;
+    }
+    return args.data ? 'POST' : 'GET';
+}
+function normalizeEndpoint(endpoint) {
+    return endpoint.startsWith('/') ? endpoint.slice(1) : endpoint;
+}
+async function handler(args) {
+    const { endpoint, data, derivedAccountId, json: formatOutputAsJson, exit, addUsageMetadata, } = args;
+    const method = resolveMethod(args);
+    addUsageMetadata({ action: method });
+    let parsedData;
+    if (data) {
+        parsedData = parseRequestData(data);
+        if (parsedData === undefined) {
+            uiLogger.error(commands.api.errors.invalidJson);
+            return exit(EXIT_CODES.ERROR);
+        }
+    }
+    const normalizedEndpoint = normalizeEndpoint(endpoint);
+    const env = getConfigAccountEnvironment(derivedAccountId);
+    const baseUrl = getHubSpotApiOrigin(env);
+    const fullUrl = `${baseUrl}/${normalizedEndpoint}`;
+    if (!formatOutputAsJson) {
+        uiLogger.log(commands.api.requestLog(method, fullUrl));
+        if (parsedData) {
+            uiLogger.log(commands.api.requestBodyLog(JSON.stringify(parsedData)));
+        }
+        uiLogger.log('');
+    }
+    try {
+        const requestOptions = {
+            url: normalizedEndpoint,
+        };
+        if (parsedData) {
+            requestOptions.data = parsedData;
+            requestOptions.headers = { 'Content-Type': 'application/json' };
+        }
+        let response;
+        switch (method) {
+            case 'GET':
+                response = await http.get(derivedAccountId, requestOptions);
+                break;
+            case 'POST':
+                response = await http.post(derivedAccountId, requestOptions);
+                break;
+            case 'PUT':
+                response = await http.put(derivedAccountId, requestOptions);
+                break;
+            case 'PATCH':
+                response = await http.patch(derivedAccountId, requestOptions);
+                break;
+            case 'DELETE':
+                response = await http.delete(derivedAccountId, requestOptions);
+                break;
+        }
+        if (response !== undefined) {
+            const responseData = response.data;
+            if (formatOutputAsJson) {
+                uiLogger.json(responseData);
+            }
+            else {
+                uiLogger.log(commands.api.responseLog);
+                uiLogger.log(JSON.stringify(responseData, null, 2));
+            }
+        }
+    }
+    catch (error) {
+        const errorContext = new ApiErrorContext({
+            accountId: derivedAccountId,
+            request: `api ${method} ${endpoint}`,
+        });
+        if (!isHubSpotHttpError(error)) {
+            logError(error, errorContext);
+            return exit(EXIT_CODES.ERROR);
+        }
+        debugError(error, errorContext);
+        const errorData = error.data;
+        if (formatOutputAsJson && errorData) {
+            uiLogger.json(errorData);
+        }
+        else if (errorData) {
+            if (error.status && error.statusText) {
+                uiLogger.error(commands.api.errors.statusLine(error.status, error.statusText));
+            }
+            uiLogger.log(JSON.stringify(errorData, null, 2));
+        }
+        else {
+            if (error.status && error.statusText) {
+                uiLogger.error(commands.api.errors.statusLine(error.status, error.statusText));
+            }
+            uiLogger.error(error.message);
+        }
+        return exit(EXIT_CODES.ERROR);
+    }
+    return exit(EXIT_CODES.SUCCESS);
+}
+function apiBuilder(yargs) {
+    yargs.positional('endpoint', {
+        describe: commands.api.positionals.endpoint.describe,
+        type: 'string',
+    });
+    yargs.option('method', {
+        alias: 'X',
+        describe: commands.api.options.method.describe,
+        type: 'string',
+        choices: [...HTTP_METHODS, ...HTTP_METHODS.map(m => m.toLowerCase())],
+        coerce: (value) => value.toUpperCase(),
+    });
+    yargs.option('data', {
+        describe: commands.api.options.data.describe,
+        type: 'string',
+    });
+    yargs.example([
+        ['$0 api /crm/v3/objects/contacts', 'Fetch contacts using GET'],
+        [
+            '$0 api /crm/v3/objects/contacts -X POST --data \'{"properties":{"email":"test@example.com"}}\'',
+            'Create a contact',
+        ],
+        ['$0 api /crm/v3/objects/deals/123', 'Fetch a specific deal'],
+        [
+            '$0 api /crm/v3/objects/contacts -a my-sandbox',
+            'Fetch contacts from a specific account',
+        ],
+    ]);
+    return yargs;
+}
+const builder = makeYargsBuilder(apiBuilder, command, commands.api.verboseDescribe, {
+    useGlobalOptions: true,
+    useConfigOptions: true,
+    useAccountOptions: true,
+    useEnvironmentOptions: true,
+    useJSONOutputOptions: true,
+});
+const apiCommand = {
+    command,
+    describe,
+    builder,
+    handler: makeYargsHandlerWithUsageTracking('api', handler),
+};
+export default apiCommand;