@ibm-cloud/secrets-manager 0.0.4 → 0.1.1

package/ibm-cloud-secrets-manager-api/v1.d.ts

@@ -1,842 +0,0 @@
-/**
- * (C) Copyright IBM Corp. 2020.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/// <reference types="node" />
-import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
-import { BaseService, UserOptions } from 'ibm-cloud-sdk-core';
-/**
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- */
-declare class IbmCloudSecretsManagerApiV1 extends BaseService {
-    static DEFAULT_SERVICE_URL: string;
-    static DEFAULT_SERVICE_NAME: string;
-    /*************************
-     * Factory method
-     ************************/
-    /**
-     * Constructs an instance of IbmCloudSecretsManagerApiV1 with passed in options and external configuration.
-     *
-     * @param {UserOptions} [options] - The parameters to send to the service.
-     * @param {string} [options.serviceName] - The name of the service to configure
-     * @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service
-     * @param {string} [options.serviceUrl] - The URL for the service
-     * @returns {IbmCloudSecretsManagerApiV1}
-     */
-    static newInstance(options: UserOptions): IbmCloudSecretsManagerApiV1;
-    /**
-     * Construct a IbmCloudSecretsManagerApiV1 object.
-     *
-     * @param {Object} options - Options for the service.
-     * @param {string} [options.serviceUrl] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net'). The base url may differ between IBM Cloud regions.
-     * @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
-     * @param {Authenticator} options.authenticator - The Authenticator object used to authenticate requests to the service
-     * @constructor
-     * @returns {IbmCloudSecretsManagerApiV1}
-     */
-    constructor(options: UserOptions);
-    /*************************
-     * config
-     ************************/
-    /**
-     * Configure secrets of a given type.
-     *
-     * Updates the configuration for the given secret type.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {SetEngineConfigOneOf} params.setEngineConfigOneOf - The base request for config update.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.Empty>>}
-     */
-    putConfig(params: IbmCloudSecretsManagerApiV1.PutConfigParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.Empty>>;
-    /**
-     * Get the configuration for a secret type.
-     *
-     * Retrieves a list of policies that are associated with a specified secret.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SetIAMSecretEngineRootConfig>>}
-     */
-    getConfig(params: IbmCloudSecretsManagerApiV1.GetConfigParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SetIAMSecretEngineRootConfig>>;
-    /*************************
-     * policies
-     ************************/
-    /**
-     * Set secret policies.
-     *
-     * Creates or updates one or more policies for the specified secret.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret.
-     * @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
-     * @param {SecretPolicyRotation[]} params.resources - A collection of resources.
-     * @param {string} [params.policy] - The type of policy that is associated with the specified secret.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.GetSecretPoliciesOneOf>>}
-     */
-    putPolicy(params: IbmCloudSecretsManagerApiV1.PutPolicyParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.GetSecretPoliciesOneOf>>;
-    /**
-     * List secret policies.
-     *
-     * Retrieves a list of policies that are associated with a specified secret.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret.
-     * @param {string} [params.policy] - The type of policy that is associated with the specified secret.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.GetSecretPoliciesOneOf>>}
-     */
-    getPolicy(params: IbmCloudSecretsManagerApiV1.GetPolicyParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.GetSecretPoliciesOneOf>>;
-    /*************************
-     * secretGroups
-     ************************/
-    /**
-     * Create secret group.
-     *
-     * Creates a new secret group.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
-     * @param {SecretGroupResource[]} params.resources - A collection of resources.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>}
-     */
-    createSecretGroup(params: IbmCloudSecretsManagerApiV1.CreateSecretGroupParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>;
-    /**
-     * List secret groups.
-     *
-     * Retrieves the list of secret groups.
-     *
-     * @param {Object} [params] - The parameters to send to the service.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>}
-     */
-    listSecretGroups(params?: IbmCloudSecretsManagerApiV1.ListSecretGroupsParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>;
-    /**
-     * Retrieve a secret group.
-     *
-     * Retrieves a secret group and its details by specifying the ID of the secret group.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret group.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>}
-     */
-    getSecretGroup(params: IbmCloudSecretsManagerApiV1.GetSecretGroupParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>;
-    /**
-     * Update secret group metadata.
-     *
-     * Updates the metadata of a secret group.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret group.
-     * @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
-     * @param {SecretGroupMetadataUpdatable[]} params.resources - A collection of resources.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>}
-     */
-    updateSecretGroupMetadata(params: IbmCloudSecretsManagerApiV1.UpdateSecretGroupMetadataParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>;
-    /**
-     * Delete a secret group.
-     *
-     * Deletes a secret group by specifying the ID of the secret group.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret group.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>}
-     */
-    deleteSecretGroup(params: IbmCloudSecretsManagerApiV1.DeleteSecretGroupParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretGroupDef>>;
-    /*************************
-     * secrets
-     ************************/
-    /**
-     * Create secret.
-     *
-     * Creates a new secret.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
-     * @param {SecretResource[]} params.resources - A collection of resources.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.CreateSecret>>}
-     */
-    createSecret(params: IbmCloudSecretsManagerApiV1.CreateSecretParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.CreateSecret>>;
-    /**
-     * List secrets for type.
-     *
-     * Retrieves a list of secrets for a specific type.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {number} [params.limit] - The number of secrets to retrieve. By default, `GET /secrets/{secret-type}`
-     * returns the first 200 secrets. To retrieve a different set of secrets, use `limit` with `offset` to page through
-     * your available resources. The maximum value for `limit` is 5000.
-     * **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5 secrets, use
-     * `../secrets/{secret-type}?limit=5`.
-     * @param {number} [params.offset] - The number of secrets to skip. By specifying `offset`, you retrieve a subset of
-     * secrets that starts with the `offset` value. Use `offset` with `limit` to page through your available resources.
-     * **Usage:** If you have 100 keys in your instance, and you want to retrieve secrets 26 through 50, use
-     * `../secrets/{secret-type}?offset=25&limit=25`.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.ListSecrets>>}
-     */
-    listSecrets(params: IbmCloudSecretsManagerApiV1.ListSecretsParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.ListSecrets>>;
-    /**
-     * List secrets of all types.
-     *
-     * Retrieves a list of secrets of all types.
-     *
-     * @param {Object} [params] - The parameters to send to the service.
-     * @param {number} [params.limit] - The number of secrets to retrieve. By default, `GET /secrets/{secret-type}`
-     * returns the first 200 secrets. To retrieve a different set of secrets, use `limit` with `offset` to page through
-     * your available resources. The maximum value for `limit` is 5000.
-     * **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5 secrets, use
-     * `../secrets/{secret-type}?limit=5`.
-     * @param {number} [params.offset] - The number of secrets to skip. By specifying `offset`, you retrieve a subset of
-     * secrets that starts with the `offset` value. Use `offset` with `limit` to page through your available resources.
-     * **Usage:** If you have 100 keys in your instance, and you want to retrieve secrets 26 through 50, use
-     * `../secrets/{secret-type}?offset=25&limit=25`.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.ListSecrets>>}
-     */
-    listAllSecrets(params?: IbmCloudSecretsManagerApiV1.ListAllSecretsParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.ListSecrets>>;
-    /**
-     * Retrieve a secret.
-     *
-     * Retrieves a secret and its details by specifying the ID of the secret.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.GetSecret>>}
-     */
-    getSecret(params: IbmCloudSecretsManagerApiV1.GetSecretParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.GetSecret>>;
-    /**
-     * Invoke an action on a secret.
-     *
-     * Invokes an action on a specified secret. Currently the supported actions are `rotate` for arbitrary and
-     * usernname-password secrets, and `delete_credentials` for IAM credentials secrets.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret.
-     * @param {string} params.action - The action to perform on the specified secret.
-     * @param {SecretActionOneOf} params.secretActionOneOf - The base request for invoking an action on a secret.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.GetSecret>>}
-     */
-    updateSecret(params: IbmCloudSecretsManagerApiV1.UpdateSecretParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.GetSecret>>;
-    /**
-     * Delete a secret.
-     *
-     * Deletes a secret by specifying the ID of the secret.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.Empty>>}
-     */
-    deleteSecret(params: IbmCloudSecretsManagerApiV1.DeleteSecretParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.Empty>>;
-    /**
-     * Retrieve secret metadata.
-     *
-     * Retrieves the details of a secret by specifying the ID. The actual content of the secret is not returned.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretMetadataRequest>>}
-     */
-    getSecretMetadata(params: IbmCloudSecretsManagerApiV1.GetSecretMetadataParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretMetadataRequest>>;
-    /**
-     * Update secret metadata.
-     *
-     * Updates the metadata of a secret. The actual content of the secret is not updated.
-     *
-     * @param {Object} params - The parameters to send to the service.
-     * @param {string} params.secretType - The secret type.
-     * @param {string} params.id - The v4 UUID that uniquely identifies the secret.
-     * @param {CollectionMetadata} params.metadata - The metadata that describes the resource array.
-     * @param {SecretMetadata[]} params.resources - A collection of resources.
-     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
-     * @returns {Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretMetadataRequest>>}
-     */
-    updateSecretMetadata(params: IbmCloudSecretsManagerApiV1.UpdateSecretMetadataParams): Promise<IbmCloudSecretsManagerApiV1.Response<IbmCloudSecretsManagerApiV1.SecretMetadataRequest>>;
-}
-/*************************
- * interfaces
- ************************/
-declare namespace IbmCloudSecretsManagerApiV1 {
-    /** An operation response. */
-    interface Response<T = any> {
-        result: T;
-        status: number;
-        statusText: string;
-        headers: IncomingHttpHeaders;
-    }
-    /** The callback for a service request. */
-    type Callback<T> = (error: any, response?: Response<T>) => void;
-    /** The body of a service request that returns no response data. */
-    interface Empty {
-    }
-    /** A standard JS object, defined to avoid the limitations of `Object` and `object` */
-    interface JsonObject {
-        [key: string]: any;
-    }
-    /*************************
-     * request interfaces
-     ************************/
-    /** Parameters for the `putConfig` operation. */
-    interface PutConfigParams {
-        /** The secret type. */
-        secretType: PutConfigConstants.SecretType | string;
-        /** The base request for config update. */
-        setEngineConfigOneOf: SetEngineConfigOneOf;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `putConfig` operation. */
-    namespace PutConfigConstants {
-        /** The secret type. */
-        enum SecretType {
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-    }
-    /** Parameters for the `getConfig` operation. */
-    interface GetConfigParams {
-        /** The secret type. */
-        secretType: GetConfigConstants.SecretType | string;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `getConfig` operation. */
-    namespace GetConfigConstants {
-        /** The secret type. */
-        enum SecretType {
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-    }
-    /** Parameters for the `putPolicy` operation. */
-    interface PutPolicyParams {
-        /** The secret type. */
-        secretType: PutPolicyConstants.SecretType | string;
-        /** The v4 UUID that uniquely identifies the secret. */
-        id: string;
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretPolicyRotation[];
-        /** The type of policy that is associated with the specified secret. */
-        policy?: PutPolicyConstants.Policy | string;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `putPolicy` operation. */
-    namespace PutPolicyConstants {
-        /** The secret type. */
-        enum SecretType {
-            USERNAME_PASSWORD = "username_password"
-        }
-        /** The type of policy that is associated with the specified secret. */
-        enum Policy {
-            ROTATION = "rotation"
-        }
-    }
-    /** Parameters for the `getPolicy` operation. */
-    interface GetPolicyParams {
-        /** The secret type. */
-        secretType: GetPolicyConstants.SecretType | string;
-        /** The v4 UUID that uniquely identifies the secret. */
-        id: string;
-        /** The type of policy that is associated with the specified secret. */
-        policy?: GetPolicyConstants.Policy | string;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `getPolicy` operation. */
-    namespace GetPolicyConstants {
-        /** The secret type. */
-        enum SecretType {
-            USERNAME_PASSWORD = "username_password"
-        }
-        /** The type of policy that is associated with the specified secret. */
-        enum Policy {
-            ROTATION = "rotation"
-        }
-    }
-    /** Parameters for the `createSecretGroup` operation. */
-    interface CreateSecretGroupParams {
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretGroupResource[];
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Parameters for the `listSecretGroups` operation. */
-    interface ListSecretGroupsParams {
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Parameters for the `getSecretGroup` operation. */
-    interface GetSecretGroupParams {
-        /** The v4 UUID that uniquely identifies the secret group. */
-        id: string;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Parameters for the `updateSecretGroupMetadata` operation. */
-    interface UpdateSecretGroupMetadataParams {
-        /** The v4 UUID that uniquely identifies the secret group. */
-        id: string;
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretGroupMetadataUpdatable[];
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Parameters for the `deleteSecretGroup` operation. */
-    interface DeleteSecretGroupParams {
-        /** The v4 UUID that uniquely identifies the secret group. */
-        id: string;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Parameters for the `createSecret` operation. */
-    interface CreateSecretParams {
-        /** The secret type. */
-        secretType: CreateSecretConstants.SecretType | string;
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretResource[];
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `createSecret` operation. */
-    namespace CreateSecretConstants {
-        /** The secret type. */
-        enum SecretType {
-            ARBITRARY = "arbitrary",
-            USERNAME_PASSWORD = "username_password",
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-    }
-    /** Parameters for the `listSecrets` operation. */
-    interface ListSecretsParams {
-        /** The secret type. */
-        secretType: ListSecretsConstants.SecretType | string;
-        /** The number of secrets to retrieve. By default, `GET /secrets/{secret-type}` returns the first 200 secrets.
-         *  To retrieve a different set of secrets, use `limit` with `offset` to page through your available resources. The
-         *  maximum value for `limit` is 5000.
-         *  **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5 secrets, use
-         *  `../secrets/{secret-type}?limit=5`.
-         */
-        limit?: number;
-        /** The number of secrets to skip. By specifying `offset`, you retrieve a subset of secrets that starts with the
-         *  `offset` value. Use `offset` with `limit` to page through your available resources.
-         *  **Usage:** If you have 100 keys in your instance, and you want to retrieve secrets 26 through 50, use
-         *  `../secrets/{secret-type}?offset=25&limit=25`.
-         */
-        offset?: number;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `listSecrets` operation. */
-    namespace ListSecretsConstants {
-        /** The secret type. */
-        enum SecretType {
-            ARBITRARY = "arbitrary",
-            USERNAME_PASSWORD = "username_password",
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-    }
-    /** Parameters for the `listAllSecrets` operation. */
-    interface ListAllSecretsParams {
-        /** The number of secrets to retrieve. By default, `GET /secrets/{secret-type}` returns the first 200 secrets.
-         *  To retrieve a different set of secrets, use `limit` with `offset` to page through your available resources. The
-         *  maximum value for `limit` is 5000.
-         *  **Usage:** If you have 20 secrets in your instance, and you want to retrieve only the first 5 secrets, use
-         *  `../secrets/{secret-type}?limit=5`.
-         */
-        limit?: number;
-        /** The number of secrets to skip. By specifying `offset`, you retrieve a subset of secrets that starts with the
-         *  `offset` value. Use `offset` with `limit` to page through your available resources.
-         *  **Usage:** If you have 100 keys in your instance, and you want to retrieve secrets 26 through 50, use
-         *  `../secrets/{secret-type}?offset=25&limit=25`.
-         */
-        offset?: number;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Parameters for the `getSecret` operation. */
-    interface GetSecretParams {
-        /** The secret type. */
-        secretType: GetSecretConstants.SecretType | string;
-        /** The v4 UUID that uniquely identifies the secret. */
-        id: string;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `getSecret` operation. */
-    namespace GetSecretConstants {
-        /** The secret type. */
-        enum SecretType {
-            ARBITRARY = "arbitrary",
-            USERNAME_PASSWORD = "username_password",
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-    }
-    /** Parameters for the `updateSecret` operation. */
-    interface UpdateSecretParams {
-        /** The secret type. */
-        secretType: UpdateSecretConstants.SecretType | string;
-        /** The v4 UUID that uniquely identifies the secret. */
-        id: string;
-        /** The action to perform on the specified secret. */
-        action: UpdateSecretConstants.Action | string;
-        /** The base request for invoking an action on a secret. */
-        secretActionOneOf: SecretActionOneOf;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `updateSecret` operation. */
-    namespace UpdateSecretConstants {
-        /** The secret type. */
-        enum SecretType {
-            ARBITRARY = "arbitrary",
-            USERNAME_PASSWORD = "username_password",
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-        /** The action to perform on the specified secret. */
-        enum Action {
-            ROTATE = "rotate",
-            DELETE_CREDENTIALS = "delete_credentials"
-        }
-    }
-    /** Parameters for the `deleteSecret` operation. */
-    interface DeleteSecretParams {
-        /** The secret type. */
-        secretType: DeleteSecretConstants.SecretType | string;
-        /** The v4 UUID that uniquely identifies the secret. */
-        id: string;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `deleteSecret` operation. */
-    namespace DeleteSecretConstants {
-        /** The secret type. */
-        enum SecretType {
-            ARBITRARY = "arbitrary",
-            USERNAME_PASSWORD = "username_password",
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-    }
-    /** Parameters for the `getSecretMetadata` operation. */
-    interface GetSecretMetadataParams {
-        /** The secret type. */
-        secretType: GetSecretMetadataConstants.SecretType | string;
-        /** The v4 UUID that uniquely identifies the secret. */
-        id: string;
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `getSecretMetadata` operation. */
-    namespace GetSecretMetadataConstants {
-        /** The secret type. */
-        enum SecretType {
-            ARBITRARY = "arbitrary",
-            USERNAME_PASSWORD = "username_password",
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-    }
-    /** Parameters for the `updateSecretMetadata` operation. */
-    interface UpdateSecretMetadataParams {
-        /** The secret type. */
-        secretType: UpdateSecretMetadataConstants.SecretType | string;
-        /** The v4 UUID that uniquely identifies the secret. */
-        id: string;
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretMetadata[];
-        headers?: OutgoingHttpHeaders;
-    }
-    /** Constants for the `updateSecretMetadata` operation. */
-    namespace UpdateSecretMetadataConstants {
-        /** The secret type. */
-        enum SecretType {
-            ARBITRARY = "arbitrary",
-            USERNAME_PASSWORD = "username_password",
-            IAM_CREDENTIALS = "iam_credentials"
-        }
-    }
-    /*************************
-     * model interfaces
-     ************************/
-    /** The metadata that describes the resource array. */
-    interface CollectionMetadata {
-        /** The type of resources in the resource array. */
-        collection_type: string;
-        /** The number of elements in the resource array. */
-        collection_total: number;
-    }
-    /** The base schema for creating secrets. */
-    interface CreateSecret {
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretResource[];
-    }
-    /** The base schema for secret. */
-    interface GetSecret {
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretResource[];
-    }
-    /** GetSecretPoliciesOneOf. */
-    interface GetSecretPoliciesOneOf {
-    }
-    /** Policy of type rotation. */
-    interface GetSecretPoliciesOneOfGetSecretPolicyRotationResourcesItem {
-        /** The v4 UUID used to uniquely identify the policy resource, as specified by RFC 4122. */
-        id: string;
-        /** The Cloud Resource Name (CRN) that uniquely identifies your cloud resources. */
-        crn?: string;
-        /** The date the policy was created. The date format follows RFC 3339. */
-        creation_date?: string;
-        /** The unique identifier for the resource that created the policy. */
-        created_by?: string;
-        /** Updates when the policy is replaced or modified. The date format follows RFC 3339. */
-        last_update_date?: string;
-        /** The unique identifier for the resource that updated the policy. */
-        updated_by?: string;
-        /** Specifies the MIME type that represents the policy resource. Currently, only the default is supported. */
-        type: string;
-        /** Specifies the secret rotation time interval. "unit" specifies the unit of the interval, and "interval"
-         *  specifies the amount of the units.
-         */
-        rotation: SecretPolicyRotationRotation;
-    }
-    /** The base schema for listing keys. */
-    interface ListSecrets {
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources?: SecretResource[];
-    }
-    /** SecretActionOneOf. */
-    interface SecretActionOneOf {
-    }
-    /** The base schema definition for a secret group. */
-    interface SecretGroupDef {
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretGroupResource[];
-    }
-    /** Updatable metadata properties that describe a secret group. */
-    interface SecretGroupMetadataUpdatable {
-        /** A human-readable name to assign to your secret group. To protect your privacy, do not use personal data,
-         *  such as your name or location, as an name for your secret group.
-         */
-        name?: string;
-        /** A text field used to provide a more detailed description of the secret group. The maximum length is 1024
-         *  characters. To protect your privacy, do not use personal data, such as your name or location, as a description
-         *  for your secret group.
-         */
-        description?: string;
-    }
-    /** Properties that describe a secret group. */
-    interface SecretGroupResource {
-        /** The v4 UUID used to uniquely identify the resource, as specified by RFC 4122. */
-        id?: string;
-        /** A human-readable name to assign to your secret group. To protect your privacy, do not use personal data,
-         *  such as your name or location, as an name for your secret group.
-         */
-        name?: string;
-        /** A text field used to provide a more detailed description of the secret group. The maximum length is 1024
-         *  characters. To protect your privacy, do not use personal data, such as your name or location, as a description
-         *  for your secret group.
-         */
-        description?: string;
-        /** SecretGroupResource accepts additional properties. */
-        [propName: string]: any;
-    }
-    /** Metadata properties that describe a secret. */
-    interface SecretMetadata {
-        /** The unique ID of the secret. */
-        id?: string;
-        /** The labels of the secret. */
-        labels?: string[];
-        /** The name of the secret. */
-        name: string;
-        /** A string describing the secret. */
-        description?: string;
-        /** The v4 UUID that uniquely identifies the secret group to assign to this secret. Optional, the secret is
-         *  assigned to the "default" secret group when the param is not included.
-         */
-        secret_group_id?: string;
-        /** The key state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active
-         *  = 1,  Suspended = 2, Deactivated = 3, and Destroyed = 5 values.
-         */
-        state?: number;
-        /** A text representation of the secret state. */
-        state_description?: string;
-        /** The secret type. */
-        secret_type?: string;
-        /** The date the secret material expires. The date format follows RFC 3339. You can set an expiration date on
-         *  any secret on its creation. If you create a secret without specifying an expiration date, the secret does not
-         *  expire. This property is only relevant for Arbitrary and Username-Password secrets.
-         */
-        expiration_date?: string;
-        /** TTL defines the time-to-live for generated credentials. For IAM-credentials secrets, the TTL defines for how
-         *  long each generated API key will live. The value can be either an integer specifying the number of seconds, or
-         *  the string representation of a duration (eg. “120m”, “24h”). This parameter is only relevant for IAM-credentials
-         *  secrets.
-         */
-        ttl?: any;
-        /** The Cloud Resource Name (CRN) that uniquely identifies your cloud resources. */
-        crn?: string;
-        /** The date the secret was created. The date format follows RFC 3339. */
-        creation_date?: string;
-        /** The unique identifier for the entity that created the secret. */
-        created_by?: string;
-        /** Updates when any part of the secret metadata is modified. The date format follows RFC 3339. */
-        last_update_date?: string;
-    }
-    /** The metadata for a secret. */
-    interface SecretMetadataRequest {
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: SecretMetadata[];
-    }
-    /** Policy of type rotation. */
-    interface SecretPolicyRotation {
-        /** Specifies the MIME type that represents the policy resource. Currently, only the default is supported. */
-        type: string;
-        /** Specifies the secret rotation time interval. "unit" specifies the unit of the interval, and "interval"
-         *  specifies the amount of the units.
-         */
-        rotation: SecretPolicyRotationRotation;
-    }
-    /** Specifies the secret rotation time interval. "unit" specifies the unit of the interval, and "interval" specifies the amount of the units. */
-    interface SecretPolicyRotationRotation {
-        /** Specifies the length of the secret rotation time interval. */
-        interval: number;
-        /** Specifies the units for the secret rotation time interval. */
-        unit: string;
-    }
-    /** Properties that describe a secret. */
-    interface SecretResource {
-        /** Specifies the MIME type that represents the secret resource. */
-        type?: string;
-        /** The v4 UUID used to uniquely identify the resource, as specified by RFC 4122. */
-        id?: string;
-        /** A human-readable alias to assign to your secret. To protect your privacy, do not use personal data, such as
-         *  your name or location, as an alias for your secret.
-         */
-        name: string;
-        /** A text field used to provide a more detailed description of the secret. The maximum length is 240
-         *  characters. To protect your privacy, do not use personal data, such as your name or location, as a description
-         *  for your secret.
-         */
-        description?: string;
-        /** The v4 UUID that uniquely identifies the secret group to assign to this secret. Optional, the secret is
-         *  assigned to the "default" secret group when the param is not included.
-         */
-        secret_group_id?: string;
-        /** Up to 30 labels can be created. Labels can be between 2-30 characters, including spaces. Special characters
-         *  not permitted include the angled bracket, comma, colon, ampersand, and vertical pipe character (|). To protect
-         *  your privacy, do not use personal data, such as your name or location, as a label for your secret.
-         */
-        labels?: string[];
-        /** The key state based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active
-         *  = 1,  Suspended = 2, Deactivated = 3, and Destroyed = 5 values.
-         */
-        state?: number;
-        /** The date the secret material expires. The date format follows RFC 3339. You can set an expiration date on
-         *  any secret on its creation. If you create a secret without specifying an expiration date, the secret does not
-         *  expire. This parameter is only relevant for Arbitrary and Username-Password secrets.
-         */
-        expiration_date?: string;
-        /** TTL defines the time-to-live for generated credentials. For IAM-credentials secrets, the TTL defines for how
-         *  long each generated API key will live. The value can be either an integer specifying the number of seconds, or
-         *  the string representation of a duration (eg. "120m", “12h”).
-         */
-        ttl?: any;
-        /** The IAM access groups that define the capabilities of the IAM credentials generated for an IAM secret. This
-         *  field is relevant only for IAM secrets.
-         */
-        access_groups?: string[];
-        /** The Cloud Resource Name (CRN) that uniquely identifies your cloud resources. */
-        crn?: string;
-        /** The date the secret was created. The date format follows RFC 3339. */
-        creation_date?: string;
-        /** The unique identifier for the entity that created the secret. */
-        created_by?: string;
-        /** Updates when any part of the secret metadata is modified. The date format follows RFC 3339. */
-        last_update_date?: string;
-        /** An array containing metadata for each secret version. */
-        versions?: SecretVersion[];
-        /** SecretResource accepts additional properties. */
-        [propName: string]: any;
-    }
-    /** Properties associated with a specific secret version. */
-    interface SecretVersion {
-        /** The ID of the secret version. */
-        id?: string;
-        /** The date that the version of the secret was created. */
-        creation_date?: string;
-        /** The unique identifier for the resource that created the secret. */
-        created_by?: string;
-    }
-    /** SetEngineConfigOneOf. */
-    interface SetEngineConfigOneOf {
-    }
-    /** Configuration used for IAM credentials generation. */
-    interface SetIAMSecretEngineRootConfig {
-        /** An API key that has the capability to create IAM serviceIDs. Specifically, it should be assigned an IAM
-         *  Editor role on both the IAM Identity Service and the IAM Access Groups Service.
-         */
-        api_key: string;
-    }
-    /** The base schema for retrieving a dual authorization secret policy. */
-    interface GetSecretPoliciesOneOfGetSecretPolicyRotation extends GetSecretPoliciesOneOf {
-        /** The metadata that describes the resource array. */
-        metadata: CollectionMetadata;
-        /** A collection of resources. */
-        resources: GetSecretPoliciesOneOfGetSecretPolicyRotationResourcesItem[];
-    }
-    /** Delete credentials generated for an IAM secret. */
-    interface SecretActionOneOfDeleteCredentialsForIAMSecret extends SecretActionOneOf {
-        /** The IAM serviceId that you want to delete. It will be deleted together with its API key. */
-        service_id: string;
-    }
-    /** Base schema for the request body of a rotate action. */
-    interface SecretActionOneOfRotateArbitrarySecretBody extends SecretActionOneOf {
-        /** The new secret data. */
-        payload: string;
-    }
-    /** Base schema for the request body of a rotate action. */
-    interface SecretActionOneOfRotateUsernamePasswordSecretBody extends SecretActionOneOf {
-        /** The new secret password. */
-        password: string;
-    }
-    /** Configuration used for IAM credentials generation. */
-    interface SetEngineConfigOneOfSetIAMSecretEngineRootConfig extends SetEngineConfigOneOf {
-        /** An API key that has the capability to create IAM serviceIDs. Specifically, it should be assigned an IAM
-         *  Editor role on both the IAM Identity Service and the IAM Access Groups Service.
-         */
-        api_key: string;
-    }
-}
-export = IbmCloudSecretsManagerApiV1;