@wix/secrets 1.0.35 → 1.0.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/secrets",
-  "version": "1.0.35",
+  "version": "1.0.36",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/secrets_secrets": "1.0.24"
+    "@wix/secrets_secrets": "1.0.25"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -43,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "9db7fb0ee6c40c414d1572c02de64acf9dfa604354f02c2389e3d6b5"
+  "falconPackageHash": "893a772393937d105c609519d705521e13bbaf9537b7f543c0009965"
 }

package/type-bundles/context.bundle.d.ts

@@ -106,9 +106,9 @@ interface DeleteSecretRequest {
 interface DeleteSecretResponse {
 }
 interface UpdateSecretRequest {
-    /** The unique ID of the secret to be updated. */
+    /** ID of the secret to update. */
     _id: string;
-    /** The secret fields to update. */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface UpdateSecretResponse {
@@ -359,8 +359,8 @@ interface UpdateSecretSignature {
      * > - Changing a secret's name or value will break all code using the secret.
      * > - You can't rename the secret with a name of an existing secret.
      * > - Don't leave private keys in your code! Leaving them in is a security risk. Make sure to delete the keys from the code after running `updateSecret()`.
-     * @param - The unique ID of the secret to be updated.
-     * @param - The secret fields to update.
+     * @param - ID of the secret to update.
+     * @param - Details of a secret.
      * @returns Fulfilled - When the secret is updated.
      * Rejected - Error message.
      */
@@ -379,11 +379,15 @@ declare const deleteSecret: BuildRESTFunction<typeof deleteSecret$1> & typeof de
 declare const updateSecret: BuildRESTFunction<typeof updateSecret$1> & typeof updateSecret$1;
 
 type _publicOnSecretCreatedType = typeof onSecretCreated$1;
-/** */
+/**
+ * Triggered when a secret is created.
+ */
 declare const onSecretCreated: ReturnType<typeof createEventModule<_publicOnSecretCreatedType>>;
 
 type _publicOnSecretDeletedType = typeof onSecretDeleted$1;
-/** */
+/**
+ * Triggered when a secret is deleted.
+ */
 declare const onSecretDeleted: ReturnType<typeof createEventModule<_publicOnSecretDeletedType>>;
 
 type _publicOnSecretUpdatedType = typeof onSecretUpdated$1;

package/type-bundles/index.bundle.d.ts

@@ -106,9 +106,9 @@ interface DeleteSecretRequest {
 interface DeleteSecretResponse {
 }
 interface UpdateSecretRequest {
-    /** The unique ID of the secret to be updated. */
+    /** ID of the secret to update. */
     _id: string;
-    /** The secret fields to update. */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface UpdateSecretResponse {
@@ -359,8 +359,8 @@ interface UpdateSecretSignature {
      * > - Changing a secret's name or value will break all code using the secret.
      * > - You can't rename the secret with a name of an existing secret.
      * > - Don't leave private keys in your code! Leaving them in is a security risk. Make sure to delete the keys from the code after running `updateSecret()`.
-     * @param - The unique ID of the secret to be updated.
-     * @param - The secret fields to update.
+     * @param - ID of the secret to update.
+     * @param - Details of a secret.
      * @returns Fulfilled - When the secret is updated.
      * Rejected - Error message.
      */
@@ -379,11 +379,15 @@ declare const deleteSecret: BuildRESTFunction<typeof deleteSecret$1> & typeof de
 declare const updateSecret: BuildRESTFunction<typeof updateSecret$1> & typeof updateSecret$1;
 
 type _publicOnSecretCreatedType = typeof onSecretCreated$1;
-/** */
+/**
+ * Triggered when a secret is created.
+ */
 declare const onSecretCreated: ReturnType<typeof createEventModule<_publicOnSecretCreatedType>>;
 
 type _publicOnSecretDeletedType = typeof onSecretDeleted$1;
-/** */
+/**
+ * Triggered when a secret is deleted.
+ */
 declare const onSecretDeleted: ReturnType<typeof createEventModule<_publicOnSecretDeletedType>>;
 
 type _publicOnSecretUpdatedType = typeof onSecretUpdated$1;

package/type-bundles/meta.bundle.d.ts

@@ -1,28 +1,32 @@
 interface Secret$1 {
     /**
-     * A globally-unique, immutable identifier assigned to the secret upon creation.
+     * Secret ID.
      * @readonly
      */
     id?: string | null;
-    /** A unique, human-friendly name for the secret. Used for retrieving the secret easily at runtime. */
+    /**
+     * A unique, human-friendly name for the secret. Use it to retrieve the secret value easily with the [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value) endpoint.
+     *
+     * **Note:** You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.
+     */
     name?: string | null;
     /** An optional text describing the secret's purpose or any other notes about it. */
     description?: string | null;
-    /** The confidential value that is intended to be stored encrypted. */
+    /** The encrypted confidential value. */
     value?: string | null;
     /**
-     * The creation timestamp of the secret.
+     * Date and time when the secret was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * The last-update timestamp of the secret.
+     * Date and time when the secret was updated.
      * @readonly
      */
     updatedDate?: Date;
 }
 interface GetSecretValueRequest$1 {
-    /** The name of the secret to get the value of. */
+    /** Secret name. */
     name: string;
 }
 interface GetSecretValueResponse$1 {
@@ -32,27 +36,27 @@ interface GetSecretValueResponse$1 {
 interface ListSecretInfoRequest$1 {
 }
 interface ListSecretInfoResponse$1 {
-    /** A list of info object for each secret, without the secret value itself */
+    /** A list of secrets with encrypted values. */
     secrets?: Secret$1[];
 }
 interface CreateSecretRequest$1 {
-    /** A set of fields including info and the actual value to protect. */
+    /** Details of a secret. */
     secret: Secret$1;
 }
 interface CreateSecretResponse$1 {
-    /** The globally-unique ID assigned to the secret by the service. */
+    /** Secret ID. */
     id?: string;
 }
 interface DeleteSecretRequest$1 {
-    /** The unique ID of the secret to be deleted. */
+    /** ID of the secret to delete. */
     id: string;
 }
 interface DeleteSecretResponse$1 {
 }
 interface UpdateSecretRequest$1 {
-    /** The unique ID of the secret to be updated. */
+    /** ID of the secret to update. */
     id: string;
-    /** The secret fields to update. */
+    /** Details of a secret. */
     secret: Secret$1;
 }
 interface UpdateSecretResponse$1 {
@@ -128,9 +132,9 @@ interface DeleteSecretRequest {
 interface DeleteSecretResponse {
 }
 interface UpdateSecretRequest {
-    /** The unique ID of the secret to be updated. */
+    /** ID of the secret to update. */
     _id: string;
-    /** The secret fields to update. */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface UpdateSecretResponse {