/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

export interface paths {
  "/parameter": {
    parameters: {
      query?: never;
      header?: never;
      path?: never;
      cookie?: never;
    };
    /**
     * List parameters
     * @description List parameters by NRN
     */
    get: operations["parameter:list"];
    put?: never;
    /**
     * Create a parameter
     * @description Creates an application parameter.
     */
    post: operations["parameter:create"];
    delete?: never;
    options?: never;
    head?: never;
    patch?: never;
    trace?: never;
  };
  "/parameter/{id}": {
    parameters: {
      query?: never;
      header?: never;
      path?: never;
      cookie?: never;
    };
    /**
     * Read a parameter
     * @description Retrieve a parameter by ID
     */
    get: operations["parameter:read"];
    /**
     * Update a parameter
     * @description Create or replace parameter's field (this doesn't affect the underlying parameter values)
     */
    put: operations["parameter:write"];
    post?: never;
    /**
     * Delete a parameter
     * @description Permanently removes a parameter and all it's values and versions. Note that this action cannot be rolled back.
     */
    delete: operations["parameter:delete"];
    options?: never;
    head?: never;
    patch?: never;
    trace?: never;
  };
  "/parameter/{id}/version": {
    parameters: {
      query?: never;
      header?: never;
      path?: never;
      cookie?: never;
    };
    /**
     * List parameter versions
     * @description Lists the versions available for a parameter
     */
    get: operations["parameter_version:read"];
    put?: never;
    post?: never;
    delete?: never;
    options?: never;
    head?: never;
    patch?: never;
    trace?: never;
  };
  "/parameter/{id}/value": {
    parameters: {
      query?: never;
      header?: never;
      path?: never;
      cookie?: never;
    };
    get?: never;
    put?: never;
    /**
     * Create a single parameter value
     * @description Creates an application or scope parameter value.
     */
    post: operations["parameter_value:create"];
    delete?: never;
    options?: never;
    head?: never;
    patch?: never;
    trace?: never;
  };
  "/parameter/{id}/values": {
    parameters: {
      query?: never;
      header?: never;
      path?: never;
      cookie?: never;
    };
    get?: never;
    put?: never;
    /**
     * Create multiple parameter values
     * @description Creates an application or scope parameter value.
     */
    post: operations["parameter_values:create"];
    delete?: never;
    options?: never;
    head?: never;
    patch?: never;
    trace?: never;
  };
  "/parameter/{parameterId}/value/{id}": {
    parameters: {
      query?: never;
      header?: never;
      path?: never;
      cookie?: never;
    };
    get?: never;
    put?: never;
    post?: never;
    /**
     * Delete a parameter value
     * @description Creates a new version of the parameter without this value.
     */
    delete: operations["parameter_value:delete"];
    options?: never;
    head?: never;
    patch?: never;
    trace?: never;
  };
  "/parameter/{parameterId}/values": {
    parameters: {
      query?: never;
      header?: never;
      path?: never;
      cookie?: never;
    };
    get?: never;
    put?: never;
    post?: never;
    /**
     * Delete multiple parameter values
     * @description Creates a new version of the remaining parameters without the provided values.
     */
    delete: operations["parameter_values:delete"];
    options?: never;
    head?: never;
    patch?: never;
    trace?: never;
  };
}
export type webhooks = Record<string, never>;
export interface components {
  schemas: {
    /**
     * @example {
     *       "name": "Pool Size",
     *       "nrn": "organization=1:account=2:namespace=3:application=4",
     *       "type": "environment",
     *       "encoding": "plaintext",
     *       "variable": "POOL_SIZE",
     *       "secret": false,
     *       "read_only": false,
     *       "values": [
     *         {
     *           "id": 6,
     *           "nrn": "organization=1:account=2:namespace=3:application=4",
     *           "value": "100",
     *           "created_at": "2023-09-14T21:01:18.515Z"
     *         },
     *         {
     *           "id": 7,
     *           "nrn": "organization=1:account=2:namespace=3:application=4:scope=5",
     *           "value": "200",
     *           "created_at": "2023-09-14T21:01:18.515Z"
     *         }
     *       ],
     *       "version_id": 5
     *     }
     */
    parameter: {
      /**
       * @description A system-wide unique ID representing the resource
       * @example 1234
       */
      id: number;
      /**
       * @description The NRN of the application to which the parameter belongs to
       * @example organization=1:account=2:namespace=3:application=4
       */
      nrn: string;
      type: components["schemas"]["parameter_type"];
      encoding: components["schemas"]["parameter_encoding"];
      /** @description The name of the environment variable. Required when type = environment. */
      variable?: string;
      /** @description The full path for file. Required when type = file */
      destination_path?: string;
      /**
       * @description 'true' if the value is a secret, 'false' otherwise
       * @enum {boolean}
       */
      secret: "true" | "false";
      /**
       * @description 'true' if the value is read only, 'false' otherwise
       * @enum {boolean}
       */
      read_only: "true" | "false";
      /**
       * @description A system-wide unique ID representing the version of the parameter
       * @example 12341234
       */
      version_id: number;
      values: components["schemas"]["parameter_value"][];
    };
    /**
     * @description An application parameter
     * @example {
     *       "name": "Pool Size",
     *       "nrn": "organization=1:account=2:namespace=3:application=4",
     *       "type": "environment",
     *       "encoding": "plaintext",
     *       "variable": "POOL_SIZE",
     *       "secret": false,
     *       "read_only": false
     *     }
     */
    "parameter:create": {
      /**
       * @description The NRN of the application to which the parameter belongs to
       * @example organization=1:account=2:namespace=3:application=4
       */
      nrn: string;
      type: components["schemas"]["parameter_type"];
      encoding: components["schemas"]["parameter_encoding"];
      /** @description The name of the environment variable. Required when type = environment. */
      variable?: string;
      /** @description The full path for file. Required when type = file */
      destination_path?: string;
      /**
       * @description 'true' if the value is a secret, 'false' otherwise
       * @enum {boolean}
       */
      secret: "true" | "false";
      /**
       * @description 'true' if the value is read only, 'false' otherwise. By default 'false'.
       * @enum {boolean}
       */
      read_only: "true" | "false";
    };
    /**
     * @description An application parameter
     * @example {
     *       "variable": "POOL_SIZE"
     *     }
     */
    "parameter:write": Record<string, never>;
    /**
     * @example environment
     * @enum {string}
     */
    parameter_encoding: "plaintext" | " base64";
    /**
     * @example environment
     * @enum {string}
     */
    parameter_type: "environment" | " file";
    /**
     * @example {
     *       "id": 9,
     *       "nrn": "organization=1:account=2:namespace=3:application=4:scope=5",
     *       "value": "Hi! I'm a value",
     *       "location": null,
     *       "created_at": "2023-09-14T23:23:40.806Z"
     *     }
     */
    parameter_value: {
      /**
       * @description A system-wide unique ID representing the value
       * @example 1234
       */
      id: number;
      /**
       * @description The NRN of the application to which the parameter belongs to
       * @example organization=1:account=2:namespace=3:application=4
       */
      nrn: string;
      /** @description The ISO 8859 UTC date for this version creation */
      created_at: string;
      /** @description The content of the environment variable (only for environment variables, otherwise null). Also null for secrets. */
      value?: string;
      /** @description The location of the file (only for files, otherwise null). Also null for secrets. */
      location?: string;
    };
    /** @description A parameter value */
    "parameter_value:create": {
      /** @description Use when you want to create a new value copying the other values from a specific-version (roll back) */
      origin_version?: number;
      /**
       * @description The NRN of the application or scope to which the value will apply to (when setting dimensions, the NRN must be at app-level)
       * @example organization=1:account=2:namespace=3:application=4:scope=5
       */
      nrn: string;
      /** @description The content of the value. Can't exceed 2KB for environment variables and 2MB for files. */
      value: string;
      /**
       * @description The dimensions of the value
       * @example {
       *       "environment": "development",
       *       "country": "US"
       *     }
       */
      dimensions?: Record<string, never>;
    };
    /**
     * @description Multiple parameter values
     * @example {
     *       "id": 4,
     *       "name": "Pool Size",
     *       "nrn": "organization=1:account=2:namespace=3:application=4",
     *       "type": "environment",
     *       "encoding": "plaintext",
     *       "variable": "POOL_SIZE",
     *       "secret": false,
     *       "read_only": false,
     *       "dimensions": {
     *         "environment": "development",
     *         "country": "US"
     *       }
     *     }
     */
    "parameter_value:create:multi": {
      /** @description Use when you want to create a new value copying the other values from a specific-version (roll back) */
      origin_version?: number;
      values: components["schemas"]["parameter_value:create"][];
    };
    parameter_version: {
      /** @description A system-wide unique ID representing the version */
      id?: number;
      /** @description The ISO 8859 UTC date for this version creation */
      created_at?: string;
      /** @description The ID of the user who created the version */
      user_id?: number;
    };
    parameter_versions: {
      results?: components["schemas"]["parameter_version"][];
    };
    ParameterList: {
      paging?: {
        /** @description The start of the paging window. Minimum is 0. */
        offset?: number;
        /** @description Maximum number of elements to retrieve per call. Maximum is 200. */
        limit?: number;
        /** @description Total number of elements that can be retrieved */
        total?: number;
      };
      results?: components["schemas"]["parameter"][];
    };
  };
  responses: never;
  parameters: never;
  requestBodies: never;
  headers: never;
  pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
  "parameter:list": {
    parameters: {
      query?: {
        /** @description The start of the paging window. Minimum is 0. */
        offset?: number;
        /** @description Maximum number of elements to retrieve per call. Maximum is 200. */
        limit?: number;
      };
      header?: never;
      path: {
        /** @description The NRN to which the parameter belongs. Format: organization=1:account=2:namespace=3:application=4:scope=5 (trailing levels optional). Read one from an entity's nrn field, e.g. 'np application read --id <id> --query .nrn'. */
        nrn: string;
        /** @description If true, the secret values will be shown */
        show_secret_values: string;
        /** @description If true, interpolation will be applied to existing parameters */
        interpolate: string;
      };
      cookie?: never;
    };
    requestBody?: never;
    responses: {
      /** @description Parameters */
      200: {
        headers: {
          [name: string]: unknown;
        };
        content: {
          "application/json": components["schemas"]["ParameterList"];
        };
      };
    };
  };
  "parameter:create": {
    parameters: {
      query?: never;
      header?: never;
      path?: never;
      cookie?: never;
    };
    requestBody?: {
      content: {
        "application/json": components["schemas"]["parameter:create"];
      };
    };
    responses: {
      /** @description The operation was successful */
      200: {
        headers: {
          [name: string]: unknown;
        };
        content: {
          "application/json": components["schemas"]["parameter"];
        };
      };
    };
  };
  "parameter:read": {
    parameters: {
      query?: {
        /** @description If true, the secret values will be shown */
        show_secret_values?: string;
      };
      header?: never;
      path: {
        /** @description The ID of the parameter */
        id: string;
      };
      cookie?: never;
    };
    requestBody?: never;
    responses: {
      /** @description Parameters */
      200: {
        headers: {
          [name: string]: unknown;
        };
        content: {
          "application/json": components["schemas"]["parameter"];
        };
      };
    };
  };
  "parameter:write": {
    parameters: {
      query?: never;
      header?: never;
      path: {
        /** @description The ID of the parameter */
        id: string;
      };
      cookie?: never;
    };
    requestBody?: {
      content: {
        "application/json": components["schemas"]["parameter:create"];
      };
    };
    responses: {
      /** @description The operation was successful */
      200: {
        headers: {
          [name: string]: unknown;
        };
        content: {
          "application/json": components["schemas"]["parameter"];
        };
      };
    };
  };
  "parameter:delete": {
    parameters: {
      query?: never;
      header?: never;
      path: {
        /** @description The ID of the parameter */
        id: string;
      };
      cookie?: never;
    };
    requestBody?: never;
    responses: {
      /** @description The operation was successful */
      204: {
        headers: {
          [name: string]: unknown;
        };
        content?: never;
      };
    };
  };
  "parameter_version:read": {
    parameters: {
      query?: never;
      header?: never;
      path: {
        /** @description The ID of the parameter */
        id: string;
      };
      cookie?: never;
    };
    requestBody?: never;
    responses: {
      /** @description List of versions */
      200: {
        headers: {
          [name: string]: unknown;
        };
        content: {
          "application/json": components["schemas"]["parameter_versions"];
        };
      };
    };
  };
  "parameter_value:create": {
    parameters: {
      query?: never;
      header?: never;
      path: {
        /** @description The ID of the parameter */
        id: string;
      };
      cookie?: never;
    };
    requestBody?: {
      content: {
        "application/json": components["schemas"]["parameter_value:create"];
      };
    };
    responses: {
      /** @description The operation was successful */
      200: {
        headers: {
          [name: string]: unknown;
        };
        content: {
          "application/json": components["schemas"]["parameter_value"];
        };
      };
    };
  };
  "parameter_values:create": {
    parameters: {
      query?: never;
      header?: never;
      path: {
        /** @description The ID of the parameter */
        id: string;
      };
      cookie?: never;
    };
    requestBody?: {
      content: {
        "application/json": components["schemas"]["parameter_value:create:multi"];
      };
    };
    responses: {
      /** @description The operation was successful */
      200: {
        headers: {
          [name: string]: unknown;
        };
        content: {
          "application/json": components["schemas"]["parameter_value"];
        };
      };
    };
  };
  "parameter_value:delete": {
    parameters: {
      query?: never;
      header?: never;
      path: {
        /** @description The ID of the parameter */
        parameterId: string;
        /** @description The ID of the parameter value to delete */
        id: string;
      };
      cookie?: never;
    };
    requestBody?: never;
    responses: {
      /** @description The operation was successful */
      204: {
        headers: {
          [name: string]: unknown;
        };
        content?: never;
      };
    };
  };
  "parameter_values:delete": {
    parameters: {
      query: {
        /** @description The IDs of the parameter values to delete */
        ids: string[];
      };
      header?: never;
      path: {
        /** @description The ID of the parameter */
        parameterId: string;
      };
      cookie?: never;
    };
    requestBody?: never;
    responses: {
      /** @description The operation was successful */
      204: {
        headers: {
          [name: string]: unknown;
        };
        content?: never;
      };
    };
  };
}