@rockset/cli/lib/commands/api/apikeys/updateApiKey.js

Official Rockset CLI

"use strict";
/* eslint-disable unicorn/filename-case */
// Generated file, please do not edit directly
Object.defineProperty(exports, "__esModule", { value: true });
const core_1 = require("@oclif/core");
const core_2 = require("@rockset/core");
const util_1 = require("../../../helper/util");
const base_command_1 = require("../../../base-command");
const chalk = require("chalk");
const cli_ux_1 = require("cli-ux");
const bodySchema = `state: ACTIVE
`;
let UpdateApiKey = /** @class */ (() => {
    class UpdateApiKey extends base_command_1.RockCommand {
        async run() {
            const { args, flags } = await this.parse(UpdateApiKey);
            // Rockset client object
            const client = await core_2.main.createClient();
            const namedArgs = UpdateApiKey.args;
            // apicall
            const apicall = client.apikeys.updateApiKey.bind(client.apikeys);
            // endpoint
            const endpoint = '/v1/orgs/self/users/{user}/apikeys/{name}';
            const method = 'POST';
            await util_1.runApiCall.bind(this)({ args, flags, namedArgs, apicall, method, endpoint, bodySchema });
        }
    }
    UpdateApiKey.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), body: core_1.Flags.string({
            required: true,
            description: 'Path to a file whose contents will be passed as the POST body of this request. Format must be [json|yaml]. An example schema is shown below.',
        }), raw: core_1.Flags.boolean({
            description: 'Show the raw output from the server, instead of grabbing the results. Usually used in conjunction with --output=json',
        }) }, cli_ux_1.cli.table.flags({ only: ['columns', 'output'] }));
    UpdateApiKey.args = [
        {
            name: 'name',
            description: 'Name of the API key.',
            required: true,
            hidden: false,
        },
        {
            name: 'user',
            description: 'Email of the API key owner. Use `self` to specify the currently authenticated user.',
            required: true,
            hidden: false,
        },
    ];
    UpdateApiKey.description = `update the state of an api key for any user in your organization
Arguments to this command will be passed as URL parameters to ${chalk.bold(`POST: /v1/orgs/self/users/{user}/apikeys/{name}`)}
${chalk.bold(`This endpoint REQUIRES a POST body. To specify a POST body, please pass a JSON or YAML file to the --body flag.
       `)}
Example Body (YAML):
state: ACTIVE


Endpoint Reference
POST: /v1/orgs/self/users/{user}/apikeys/{name}
Update an API key's state
Update the state of an API key for any user in your organization.

More documentation at ${chalk.underline(`https://docs.rockset.com/rest-api#updateapikey`)}`;
    UpdateApiKey.examples = [
        '$ rockset api:apikeys:updateApiKey NAME USER --body body.yaml\n$ cat body.yaml\nstate: ACTIVE\n\n',
    ];
    return UpdateApiKey;
})();
exports.default = UpdateApiKey;