@ibm-cloud/secrets-manager 0.0.4 → 0.1.1

package/secrets-manager/v1.d.ts

@@ -0,0 +1,1138 @@
+/**
+ * (C) Copyright IBM Corp. 2021.
+ *
+ * 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';
+/**
+ * With IBM Cloud® Secrets Manager, you can create, lease, and centrally manage secrets that are used in IBM Cloud
+ * services or your custom-built applications. Secrets are stored in a dedicated instance of Secrets Manager, built on
+ * open source HashiCorp Vault.
+ */
+declare class SecretsManagerV1 extends BaseService {
+    static DEFAULT_SERVICE_URL: string;
+    static DEFAULT_SERVICE_NAME: string;
+    /*************************
+     * Factory method
+     ************************/
+    /**
+     * Constructs an instance of SecretsManagerV1 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 {SecretsManagerV1}
+     */
+    static newInstance(options: UserOptions): SecretsManagerV1;
+    /**
+     * Construct a SecretsManagerV1 object.
+     *
+     * @param {Object} options - Options for the service.
+     * @param {string} [options.serviceUrl] - The base url to use when contacting the service. 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 {SecretsManagerV1}
+     */
+    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 {EngineConfigOneOf} params.engineConfigOneOf - The base request for setting secret engine configuration.
+     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
+     * @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.Empty>>}
+     */
+    putConfig(params: SecretsManagerV1.PutConfigParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.Empty>>;
+    /**
+     * Get the configuration for a secret type.
+     *
+     * Retrieves the configuration that is associated with the given secret type.
+     *
+     * @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<SecretsManagerV1.Response<SecretsManagerV1.GetConfig>>}
+     */
+    getConfig(params: SecretsManagerV1.GetConfigParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.GetConfig>>;
+    /*************************
+     * policies
+     ************************/
+    /**
+     * Set secret policies.
+     *
+     * Creates or updates one or more policies, such as an [automatic rotation
+     * policy](http://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-rotate-secrets#auto-rotate-secret), 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<SecretsManagerV1.Response<SecretsManagerV1.GetSecretPoliciesOneOf>>}
+     */
+    putPolicy(params: SecretsManagerV1.PutPolicyParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.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<SecretsManagerV1.Response<SecretsManagerV1.GetSecretPoliciesOneOf>>}
+     */
+    getPolicy(params: SecretsManagerV1.GetPolicyParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.GetSecretPoliciesOneOf>>;
+    /*************************
+     * secretGroups
+     ************************/
+    /**
+     * Create a secret group.
+     *
+     * Creates a secret group that you can use to organize secrets and control who on your team has access to them.
+     *
+     * A successful request returns the ID value of the secret group, along with other metadata. To learn more about
+     * secret groups, check out the
+     * [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-groups).
+     *
+     * @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<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>}
+     */
+    createSecretGroup(params: SecretsManagerV1.CreateSecretGroupParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>;
+    /**
+     * List secret groups.
+     *
+     * Retrieves the list of secret groups that are available in your Secrets Manager instance.
+     *
+     * @param {Object} [params] - The parameters to send to the service.
+     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
+     * @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>}
+     */
+    listSecretGroups(params?: SecretsManagerV1.ListSecretGroupsParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>;
+    /**
+     * Get a secret group.
+     *
+     * Retrieves the metadata of an existing secret group by specifying the ID of the 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<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>}
+     */
+    getSecretGroup(params: SecretsManagerV1.GetSecretGroupParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>;
+    /**
+     * Update a secret group.
+     *
+     * Updates the metadata of an existing secret group, such as its name or description.
+     *
+     * @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<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>}
+     */
+    updateSecretGroupMetadata(params: SecretsManagerV1.UpdateSecretGroupMetadataParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretGroupDef>>;
+    /**
+     * Delete a secret group.
+     *
+     * Deletes a secret group by specifying the ID of the secret group.
+     *
+     * **Note:** To delete a secret group, it must be empty. If you need to remove a secret group that contains secrets,
+     * you must first [delete the secrets](#delete-secret) that are associated with the 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<SecretsManagerV1.Response<SecretsManagerV1.Empty>>}
+     */
+    deleteSecretGroup(params: SecretsManagerV1.DeleteSecretGroupParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.Empty>>;
+    /*************************
+     * secrets
+     ************************/
+    /**
+     * Create a secret.
+     *
+     * Creates a secret that you can use to access or authenticate to a protected resource.
+     *
+     * A successful request stores the secret in your dedicated instance based on the secret type and data that you
+     * specify. The response returns the ID value of the secret, along with other metadata.
+     *
+     * To learn more about the types of secrets that you can create with Secrets Manager, check out the
+     * [docs](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-basics).
+     *
+     * @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<SecretsManagerV1.Response<SecretsManagerV1.CreateSecret>>}
+     */
+    createSecret(params: SecretsManagerV1.CreateSecretParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.CreateSecret>>;
+    /**
+     * List secrets by type.
+     *
+     * Retrieves a list of secrets based on the type that you specify.
+     *
+     * @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, list operations return the first
+     * 200 items. To retrieve a different set of items, use `limit` with `offset` to page through your available
+     * resources.
+     *
+     * **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
+     * items that starts with the `offset` value. Use `offset` with `limit` to page through your available resources.
+     *
+     * **Usage:** If you have 100 secrets 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<SecretsManagerV1.Response<SecretsManagerV1.ListSecrets>>}
+     */
+    listSecrets(params: SecretsManagerV1.ListSecretsParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.ListSecrets>>;
+    /**
+     * List all secrets.
+     *
+     * Retrieves a list of all secrets in your Secrets Manager instance.
+     *
+     * @param {Object} [params] - The parameters to send to the service.
+     * @param {number} [params.limit] - The number of secrets to retrieve. By default, list operations return the first
+     * 200 items. To retrieve a different set of items, use `limit` with `offset` to page through your available
+     * resources.
+     *
+     * **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
+     * items that starts with the `offset` value. Use `offset` with `limit` to page through your available resources.
+     *
+     * **Usage:** If you have 100 secrets in your instance, and you want to retrieve secrets 26 through 50, use
+     * `../secrets/{secret-type}?offset=25&limit=25`.
+     * @param {string} [params.search] - Filter secrets that contain the specified string. The fields that are searched
+     * include: id, name, description, labels, secret_type.
+     *
+     * **Usage:** If you want to list only the secrets that contain the string "text", use
+     * `../secrets/{secret-type}?search=text`.
+     * @param {string} [params.sortBy] - Sort a list of secrets by the specified field.
+     *
+     * **Usage:** To sort a list of secrets by their creation date, use
+     * `../secrets/{secret-type}?sort_by=creation_date`.
+     * @param {string[]} [params.groups] - Filter secrets by groups.
+     *
+     * You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets
+     * that are in the default secret group, use the `default` keyword.
+     *
+     * **Usage:** To retrieve a list of secrets that are associated with an existing secret group or the default group,
+     * use `../secrets?groups={secret_group_ID},default`.
+     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
+     * @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.ListSecrets>>}
+     */
+    listAllSecrets(params?: SecretsManagerV1.ListAllSecretsParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.ListSecrets>>;
+    /**
+     * Get a secret.
+     *
+     * Retrieves a secret and its details by specifying the ID of the secret.
+     *
+     * A successful request returns the secret data that is associated with your secret, along with other metadata. To
+     * view only the details of a specified secret without retrieving its value, use the [Get secret
+     * metadata](#get-secret-metadata) method.
+     *
+     * @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<SecretsManagerV1.Response<SecretsManagerV1.GetSecret>>}
+     */
+    getSecret(params: SecretsManagerV1.GetSecretParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.GetSecret>>;
+    /**
+     * Invoke an action on a secret.
+     *
+     * Invokes an action on a specified secret. This method supports the following actions:
+     *
+     * - `rotate`: Replace the value of an `arbitrary` or `username_password` secret.
+     * - `delete_credentials`: Delete the API key that is associated with an `iam_credentials` 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.action - The action to perform on the specified secret.
+     * @param {SecretActionOneOf} params.secretActionOneOf - The base request body for invoking an action on a secret.
+     * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
+     * @returns {Promise<SecretsManagerV1.Response<SecretsManagerV1.GetSecret>>}
+     */
+    updateSecret(params: SecretsManagerV1.UpdateSecretParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.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<SecretsManagerV1.Response<SecretsManagerV1.Empty>>}
+     */
+    deleteSecret(params: SecretsManagerV1.DeleteSecretParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.Empty>>;
+    /**
+     * Get secret metadata.
+     *
+     * Retrieves the details of a secret by specifying the ID.
+     *
+     * A successful request returns only metadata about the secret, such as its name and creation date. To retrieve the
+     * value of a secret, use the [Get a secret](#get-secret) method.
+     *
+     * @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<SecretsManagerV1.Response<SecretsManagerV1.SecretMetadataRequest>>}
+     */
+    getSecretMetadata(params: SecretsManagerV1.GetSecretMetadataParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretMetadataRequest>>;
+    /**
+     * Update secret metadata.
+     *
+     * Updates the metadata of a secret, such as its name or description.
+     *
+     * To update the actual contents of a secret, rotate the secret by using the [Invoke an action on a
+     * secret](#update-secret) method.
+     *
+     * @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<SecretsManagerV1.Response<SecretsManagerV1.SecretMetadataRequest>>}
+     */
+    updateSecretMetadata(params: SecretsManagerV1.UpdateSecretMetadataParams): Promise<SecretsManagerV1.Response<SecretsManagerV1.SecretMetadataRequest>>;
+}
+/*************************
+ * interfaces
+ ************************/
+declare namespace SecretsManagerV1 {
+    /** 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 setting secret engine configuration. */
+        engineConfigOneOf: EngineConfigOneOf;
+        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, list operations return the first 200 items. To retrieve a
+         *  different set of items, use `limit` with `offset` to page through your available resources.
+         *
+         *  **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 items that starts with the
+         *  `offset` value. Use `offset` with `limit` to page through your available resources.
+         *
+         *  **Usage:** If you have 100 secrets 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, list operations return the first 200 items. To retrieve a
+         *  different set of items, use `limit` with `offset` to page through your available resources.
+         *
+         *  **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 items that starts with the
+         *  `offset` value. Use `offset` with `limit` to page through your available resources.
+         *
+         *  **Usage:** If you have 100 secrets in your instance, and you want to retrieve secrets 26 through 50, use
+         *  `../secrets/{secret-type}?offset=25&limit=25`.
+         */
+        offset?: number;
+        /** Filter secrets that contain the specified string. The fields that are searched include: id, name,
+         *  description, labels, secret_type.
+         *
+         *  **Usage:** If you want to list only the secrets that contain the string "text", use
+         *  `../secrets/{secret-type}?search=text`.
+         */
+        search?: string;
+        /** Sort a list of secrets by the specified field.
+         *
+         *  **Usage:** To sort a list of secrets by their creation date, use
+         *  `../secrets/{secret-type}?sort_by=creation_date`.
+         */
+        sortBy?: ListAllSecretsConstants.SortBy | string;
+        /** Filter secrets by groups.
+         *
+         *  You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter
+         *  secrets that are in the default secret group, use the `default` keyword.
+         *
+         *  **Usage:** To retrieve a list of secrets that are associated with an existing secret group or the default group,
+         *  use `../secrets?groups={secret_group_ID},default`.
+         */
+        groups?: string[];
+        headers?: OutgoingHttpHeaders;
+    }
+    /** Constants for the `listAllSecrets` operation. */
+    namespace ListAllSecretsConstants {
+        /** Sort a list of secrets by the specified field. **Usage:** To sort a list of secrets by their creation date, use `../secrets/{secret-type}?sort_by=creation_date`. */
+        enum SortBy {
+            ID = "id",
+            CREATION_DATE = "creation_date",
+            EXPIRATION_DATE = "expiration_date",
+            SECRET_TYPE = "secret_type",
+            NAME = "name"
+        }
+    }
+    /** 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 body 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[];
+    }
+    /** EngineConfigOneOf. */
+    interface EngineConfigOneOf {
+    }
+    /** Configuration that is used to generate IAM credentials. */
+    interface GetConfig {
+        /** The metadata that describes the resource array. */
+        metadata: CollectionMetadata;
+        /** A collection of resources. */
+        resources: IAMSecretEngineRootConfig[];
+    }
+    /** The base schema for retrieving a secret. */
+    interface GetSecret {
+        /** The metadata that describes the resource array. */
+        metadata: CollectionMetadata;
+        /** A collection of resources. */
+        resources: SecretResource[];
+    }
+    /** GetSecretPoliciesOneOf. */
+    interface GetSecretPoliciesOneOf {
+    }
+    /** Properties that are associated with a rotation policy. */
+    interface GetSecretPoliciesOneOfGetSecretPolicyRotationResourcesItem {
+        /** The v4 UUID that uniquely identifies the policy. */
+        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 entity 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 entity that updated the policy. */
+        updated_by?: string;
+        /** The MIME type that represents the policy. Currently, only the default is supported. */
+        type: string;
+        /** The secret rotation time interval. */
+        rotation: SecretPolicyRotationRotation;
+    }
+    /** Configuration that is used to generate IAM credentials. */
+    interface IAMSecretEngineRootConfig {
+        /** An IBM Cloud API key that has the capability to create and manage service IDs.
+         *
+         *  The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform
+         *  role on the IAM Identity Service. For more information, see [Enabling the IAM secrets
+         *  engine](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-engines#configure-iam-engine).
+         */
+        api_key: string;
+        /** The hash value of the IBM Cloud API key that is used to create and manage service IDs. */
+        api_key_hash?: string;
+    }
+    /** The base schema for listing secrets. */
+    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[];
+    }
+    /** 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 a name for your secret
+         *  group.
+         */
+        name?: string;
+        /** An extended description of your secret group.
+         *
+         *  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 that uniquely identifies the secret group. */
+        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 a name for your secret
+         *  group.
+         */
+        name?: string;
+        /** An extended description of your secret group.
+         *
+         *  To protect your privacy, do not use personal data, such as your name or location, as a description for your
+         *  secret group.
+         */
+        description?: string;
+        /** The date the secret group was created. The date format follows RFC 3339. */
+        creation_date?: string;
+        /** Updates when the metadata of the secret group is modified. The date format follows RFC 3339. */
+        last_update_date?: string;
+        /** The MIME type that represents the secret group. */
+        type?: string;
+        /** SecretGroupResource accepts additional properties. */
+        [propName: string]: any;
+    }
+    /** Metadata properties that describe a secret. */
+    interface SecretMetadata {
+        /** The unique ID of the secret. */
+        id?: string;
+        /** Labels that you can use to filter for secrets in your instance.
+         *
+         *  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[];
+        /** 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;
+        /** An extended description of your secret.
+         *
+         *  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.
+         *
+         *  If you omit this parameter, your secret is assigned to the `default` secret group.
+         */
+        secret_group_id?: string;
+        /** The secret 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 supported secret types at their creation. If you create a secret without
+         *  specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
+         *  following secret types:
+         *
+         *  - `arbitrary`
+         *  - `username_password`.
+         */
+        expiration_date?: string;
+        /** The time-to-live (TTL) or lease duration to assign to generated credentials.
+         *
+         *  For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can
+         *  be either an integer that specifies the number of seconds, or the string representation of a duration, such as
+         *  `120m` or `24h`.
+         */
+        ttl?: any;
+        /** For `iam_credentials` secrets, this field controls whether to use the same service ID and API key for future
+         *  read operations on this secret. If set to `true`, the service reuses the current credentials. If set to `false`,
+         *  a new service ID and API key is generated each time that the secret is read or accessed.
+         */
+        reuse_api_key?: boolean;
+        /** The Cloud Resource Name (CRN) that uniquely identifies the resource. */
+        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 of a secret. */
+    interface SecretMetadataRequest {
+        /** The metadata that describes the resource array. */
+        metadata: CollectionMetadata;
+        /** A collection of resources. */
+        resources: SecretMetadata[];
+    }
+    /** Properties that are associated with a rotation policy. */
+    interface SecretPolicyRotation {
+        /** The MIME type that represents the policy. Currently, only the default is supported. */
+        type: string;
+        /** The secret rotation time interval. */
+        rotation: SecretPolicyRotationRotation;
+    }
+    /** The secret rotation time interval. */
+    interface SecretPolicyRotationRotation {
+        /** Specifies the length of the secret rotation time interval. */
+        interval: number;
+        /** Specifies the units for the secret rotation time interval. */
+        unit: string;
+    }
+    /** SecretResource. */
+    interface SecretResource {
+    }
+    /** Properties that are 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 entity that created the secret. */
+        created_by?: string;
+        /** Indicates whether the version of the secret was created by automatic rotation. */
+        auto_rotated?: boolean;
+    }
+    /** Configuration that is used to generate IAM credentials. */
+    interface EngineConfigOneOfIAMSecretEngineRootConfig extends EngineConfigOneOf {
+        /** An IBM Cloud API key that has the capability to create and manage service IDs.
+         *
+         *  The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform
+         *  role on the IAM Identity Service. For more information, see [Enabling the IAM secrets
+         *  engine](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-secret-engines#configure-iam-engine).
+         */
+        api_key: string;
+        /** The hash value of the IBM Cloud API key that is used to create and manage service IDs. */
+        api_key_hash?: string;
+    }
+    /** The base schema for retrieving a policy that is associated with a secret. */
+    interface GetSecretPoliciesOneOfGetSecretPolicyRotation extends GetSecretPoliciesOneOf {
+        /** The metadata that describes the resource array. */
+        metadata: CollectionMetadata;
+        /** A collection of resources. */
+        resources: GetSecretPoliciesOneOfGetSecretPolicyRotationResourcesItem[];
+    }
+    /** Delete the credentials that are associated with an `iam_credentials` secret. */
+    interface SecretActionOneOfDeleteCredentialsForIAMSecret extends SecretActionOneOf {
+        /** The service ID that you want to delete. It is deleted together with its API key. */
+        service_id: string;
+    }
+    /** The request body of a `rotate` action. */
+    interface SecretActionOneOfRotateArbitrarySecretBody extends SecretActionOneOf {
+        /** The new secret data to assign to an `arbitrary` secret. */
+        payload: string;
+    }
+    /** The request body of a `rotate` action. */
+    interface SecretActionOneOfRotateUsernamePasswordSecretBody extends SecretActionOneOf {
+        /** The new password to assign to a `username_password` secret. */
+        password: string;
+    }
+    /** The base schema for secrets. */
+    interface SecretResourceArbitrarySecretResource extends SecretResource {
+        /** The MIME type that represents the secret. */
+        type?: string;
+        /** The v4 UUID that uniquely identifies the secret. */
+        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;
+        /** An extended description of your secret.
+         *
+         *  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.
+         *
+         *  If you omit this parameter, your secret is assigned to the `default` secret group.
+         */
+        secret_group_id?: string;
+        /** Labels that you can use to filter for secrets in your instance.
+         *
+         *  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 secret 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 Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource. */
+        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 the actual secret is modified. The date format follows RFC 3339. */
+        last_update_date?: string;
+        /** An array that contains metadata for each secret version. */
+        versions?: SecretVersion[];
+        /** The date the secret material expires. The date format follows RFC 3339.
+         *
+         *  You can set an expiration date on supported secret types at their creation. If you create a secret without
+         *  specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
+         *  following secret types:
+         *
+         *  - `arbitrary`
+         *  - `username_password`.
+         */
+        expiration_date?: string;
+        /** The new secret data to assign to an `arbitrary` secret. */
+        payload?: string;
+        secret_data?: JsonObject;
+    }
+    /** The base schema for secrets. */
+    interface SecretResourceIAMSecretResource extends SecretResource {
+        /** The MIME type that represents the secret. */
+        type?: string;
+        /** The v4 UUID that uniquely identifies the secret. */
+        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;
+        /** An extended description of your secret.
+         *
+         *  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.
+         *
+         *  If you omit this parameter, your secret is assigned to the `default` secret group.
+         */
+        secret_group_id?: string;
+        /** Labels that you can use to filter for secrets in your instance.
+         *
+         *  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 secret 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 Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource. */
+        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 the actual secret is modified. The date format follows RFC 3339. */
+        last_update_date?: string;
+        /** An array that contains metadata for each secret version. */
+        versions?: SecretVersion[];
+        /** The time-to-live (TTL) or lease duration to assign to generated credentials.
+         *
+         *  For `iam_credentials` secrets, the TTL defines for how long each generated API key remains valid. The value can
+         *  be either an integer that specifies the number of seconds, or the string representation of a duration, such as
+         *  `120m` or `24h`.
+         */
+        ttl?: any;
+        /** The access groups that define the capabilities of the service ID and API key that are generated for an
+         *  `iam_credentials` secret.
+         *
+         *  **Tip:** To find the ID of an access group, go to **Manage > Access (IAM) > Access groups** in the IBM Cloud
+         *  console. Select the access group to inspect, and click **Details** to view its ID.
+         */
+        access_groups?: string[];
+        /** The API key that is generated for this secret.
+         *
+         *  After the secret reaches the end of its lease (see the `ttl` field), the API key is deleted automatically. If
+         *  you want to continue to use the same API key for future read operations, see the `reuse_api_key` field.
+         */
+        api_key?: string;
+        /** The service ID under which the API key (see the `api_key` field) is created. This service ID is added to the
+         *  access groups that you assign for this secret.
+         */
+        service_id?: string;
+        /** Set to `true` to reuse the service ID and API key for this secret.
+         *
+         *  Use this field to control whether to use the same service ID and API key for future read operations on this
+         *  secret. If set to `true`, the service reuses the current credentials. If set to `false`, a new service ID and
+         *  API key is generated each time that the secret is read or accessed.
+         */
+        reuse_api_key?: boolean;
+    }
+    /** The base schema for secrets. */
+    interface SecretResourceUsernamePasswordSecretResource extends SecretResource {
+        /** The MIME type that represents the secret. */
+        type?: string;
+        /** The v4 UUID that uniquely identifies the secret. */
+        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;
+        /** An extended description of your secret.
+         *
+         *  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.
+         *
+         *  If you omit this parameter, your secret is assigned to the `default` secret group.
+         */
+        secret_group_id?: string;
+        /** Labels that you can use to filter for secrets in your instance.
+         *
+         *  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 secret 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 Cloud Resource Name (CRN) that uniquely identifies your Secrets Manager resource. */
+        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 the actual secret is modified. The date format follows RFC 3339. */
+        last_update_date?: string;
+        /** An array that contains metadata for each secret version. */
+        versions?: SecretVersion[];
+        /** The username to assign to this secret. */
+        username?: string;
+        /** The password to assign to this secret. */
+        password?: string;
+        secret_data?: JsonObject;
+        /** The date the secret material expires. The date format follows RFC 3339.
+         *
+         *  You can set an expiration date on supported secret types at their creation. If you create a secret without
+         *  specifying an expiration date, the secret does not expire. The `expiration_date` field is supported for the
+         *  following secret types:
+         *
+         *  - `arbitrary`
+         *  - `username_password`.
+         */
+        expiration_date?: string;
+        /** The date that the secret is scheduled for automatic rotation.
+         *
+         *  The service automatically creates a new version of the secret on its next rotation date. This field exists only
+         *  for secrets that can be auto-rotated and have an existing rotation policy.
+         */
+        next_rotation_date?: string;
+    }
+}
+export = SecretsManagerV1;