@wix/secrets 1.0.42 → 1.0.43

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/secrets",
-  "version": "1.0.42",
+  "version": "1.0.43",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,7 +21,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/secrets_secrets": "1.0.30"
+    "@wix/secrets_secrets": "1.0.31"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -46,5 +46,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "b0ac06e139ec5d38b420ab8eb0ccb6cad138b8efcd47957ececf99f0"
+  "falconPackageHash": "bf2d19c272a275b1f50acdac9db19522b5c2761b8a820f30ae969993"
 }

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

@@ -478,63 +478,55 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
 
 interface Secret {
     /**
-     * The secret's unique ID.
+     * Secret ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * A unique, meaningful name used for retrieving the secret at runtime with the `getSecretValue()` function. You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.
+     * 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 to protect, such as an API key.  */
+    /** The encrypted confidential value. */
     value?: string | null;
     /**
-     * The date and time the secreted was created.
+     * Date and time when the secret was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * The date and time the secret was last updated.
+     * Date and time when the secret was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
 }
 interface GetSecretValueRequest {
-    /** The name of the secret to get the value of. */
+    /** Secret name. */
     name: string;
 }
 interface GetSecretValueResponse {
-    /**
-     * The plaintext, unencrypted value of the secret.
-     *
-     */
+    /** The plaintext, unencrypted value of the secret. */
     value?: string;
 }
 interface ListSecretInfoRequest {
 }
 interface ListSecretInfoResponse {
-    /** Object containing information for each secret.  */
+    /** A list of secrets with encrypted values. */
     secrets?: Secret[];
 }
 interface CreateSecretRequest {
-    /** The object including the fields of a new secret.  */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface CreateSecretResponse {
-    /**
-     * The globally-unique ID assigned to the secret.
-     *
-     */
+    /** Secret ID. */
     _id?: string;
 }
 interface DeleteSecretRequest {
-    /**
-     * The unique ID of the secret to be deleted.
-     *
-     */
+    /** ID of the secret to delete. */
     _id: string;
 }
 interface DeleteSecretResponse {
@@ -724,79 +716,45 @@ interface SecretUpdatedEnvelope {
 declare function getSecretValue$1(httpClient: HttpClient): GetSecretValueSignature;
 interface GetSecretValueSignature {
     /**
-     * Retrieves the secret value specified by the secret name.
-     *
-     * The `getSecretValue()` function returns a Promise that resolves to the value of the secret with the specified given name.
-     *
-     * >**Note:**
-     * > Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.
+     * Retrieves a secret value by name.
      * @param - The name of the secret to get the value of.
-     * @returns Fulfilled - The value of the secret. Rejected - Error message.
      */
     (name: string): Promise<GetSecretValueResponse & GetSecretValueResponseNonNullableFields>;
 }
 declare function listSecretInfo$1(httpClient: HttpClient): ListSecretInfoSignature;
 interface ListSecretInfoSignature {
     /**
-     * Retrieves a list of objects containing information about all secrets.
-     *
-     * The `listSecretInfo()` function returns a Promise that resolves to a list containing information about all secrets stored on your site.
+     * Retrieves a list of secrets.
      *
-     * > **Note:**
-     * > - The secret's value does not get returned for security reasons. To retrieve a secret's value, use the [`getSecretValue()`](#getSecretValue) function.
-     * @returns Fulfilled - A list of objects containing information about your site's secrets. Rejected - Error message.
+     * >**Note:** This endpoint doesn't return the secret's value for security reasons. To retrieve the value, call [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value).
      */
     (): Promise<ListSecretInfoResponse>;
 }
 declare function createSecret$1(httpClient: HttpClient): CreateSecretSignature;
 interface CreateSecretSignature {
     /**
-     * Creates a new secret.
-     *
-     * The `createSecret()` function returns a Promise that resolves secret ID when the secret is created.
-     *
-     * >**Notes:**
-     * > - The secret's name cannot start with `'wix'` or be identical to an existing secret's name.
-     * > - Don't leave private keys in your code. Leaving them in your code is a security risk. Make sure to delete the keys from the code after running `createSecret()`.
+     * Creates a secret.
      * @param - Fields of a new secret.
-     * @returns Fulfilled - The ID of the created secret.
-     * Rejected - Error message.
+     * @returns Secret ID.
      */
     (secret: Secret): Promise<string>;
 }
 declare function deleteSecret$1(httpClient: HttpClient): DeleteSecretSignature;
 interface DeleteSecretSignature {
     /**
-     * Deletes an existing secret by ID.
-     *
-     * The `deleteSecret()` function returns a Promise that resolves when the secret is deleted. You can retrieve the secret `_id` using the [`listSecretInfo()`](#listsecretinfo) function.
-     *
-     * >**Note:**
-     * > Deleting a secret is irreversible and will break all code using the secret.
-     *
+     * Deletes a secret.
      * @param - The unique ID of the secret to be deleted.
-     * @returns Fulfilled - When the secret is successfully deleted. Rejected - Error message.
      */
     (_id: string): Promise<void>;
 }
 declare function updateSecret$1(httpClient: HttpClient): UpdateSecretSignature;
 interface UpdateSecretSignature {
     /**
-     * Updates the specified fields of an existing secret by ID.
-     *
-     *
-     * The `updateSecret()` function returns a Promise that resolves when the secret is successfully updated. You can update one or more fields. Only fields passed in the `secret` object will be updated. All other properties will remain unchanged.
-     *
-     * You can retrieve the `_id` parameter from the [`listSecretInfo()`](#listsecretinfo) function. The secret `_id` is different from the secret `name` used by the [`getSecretValue()`](#getsecretvalue) function.
+     * Updates 1 or all fields of a secret.
      *
-     * > **Notes:**
-     * > - 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()`.
+     * To get the secret ID, call [List Secret Info](https://dev.wix.com/docs/rest/business-management/secrets/list-secret-info).
      * @param - ID of the secret to update.
      * @param - Details of a secret.
-     * @returns Fulfilled - When the secret is updated.
-     * Rejected - Error message.
      */
     (_id: string, secret: Secret): Promise<void>;
 }

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

@@ -478,63 +478,55 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
 
 interface Secret {
     /**
-     * The secret's unique ID.
+     * Secret ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * A unique, meaningful name used for retrieving the secret at runtime with the `getSecretValue()` function. You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.
+     * 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 to protect, such as an API key.  */
+    /** The encrypted confidential value. */
     value?: string | null;
     /**
-     * The date and time the secreted was created.
+     * Date and time when the secret was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * The date and time the secret was last updated.
+     * Date and time when the secret was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
 }
 interface GetSecretValueRequest {
-    /** The name of the secret to get the value of. */
+    /** Secret name. */
     name: string;
 }
 interface GetSecretValueResponse {
-    /**
-     * The plaintext, unencrypted value of the secret.
-     *
-     */
+    /** The plaintext, unencrypted value of the secret. */
     value?: string;
 }
 interface ListSecretInfoRequest {
 }
 interface ListSecretInfoResponse {
-    /** Object containing information for each secret.  */
+    /** A list of secrets with encrypted values. */
     secrets?: Secret[];
 }
 interface CreateSecretRequest {
-    /** The object including the fields of a new secret.  */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface CreateSecretResponse {
-    /**
-     * The globally-unique ID assigned to the secret.
-     *
-     */
+    /** Secret ID. */
     _id?: string;
 }
 interface DeleteSecretRequest {
-    /**
-     * The unique ID of the secret to be deleted.
-     *
-     */
+    /** ID of the secret to delete. */
     _id: string;
 }
 interface DeleteSecretResponse {
@@ -724,79 +716,45 @@ interface SecretUpdatedEnvelope {
 declare function getSecretValue$1(httpClient: HttpClient): GetSecretValueSignature;
 interface GetSecretValueSignature {
     /**
-     * Retrieves the secret value specified by the secret name.
-     *
-     * The `getSecretValue()` function returns a Promise that resolves to the value of the secret with the specified given name.
-     *
-     * >**Note:**
-     * > Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.
+     * Retrieves a secret value by name.
      * @param - The name of the secret to get the value of.
-     * @returns Fulfilled - The value of the secret. Rejected - Error message.
      */
     (name: string): Promise<GetSecretValueResponse & GetSecretValueResponseNonNullableFields>;
 }
 declare function listSecretInfo$1(httpClient: HttpClient): ListSecretInfoSignature;
 interface ListSecretInfoSignature {
     /**
-     * Retrieves a list of objects containing information about all secrets.
-     *
-     * The `listSecretInfo()` function returns a Promise that resolves to a list containing information about all secrets stored on your site.
+     * Retrieves a list of secrets.
      *
-     * > **Note:**
-     * > - The secret's value does not get returned for security reasons. To retrieve a secret's value, use the [`getSecretValue()`](#getSecretValue) function.
-     * @returns Fulfilled - A list of objects containing information about your site's secrets. Rejected - Error message.
+     * >**Note:** This endpoint doesn't return the secret's value for security reasons. To retrieve the value, call [Get Secret Value](https://dev.wix.com/docs/rest/business-management/secrets/get-secret-value).
      */
     (): Promise<ListSecretInfoResponse>;
 }
 declare function createSecret$1(httpClient: HttpClient): CreateSecretSignature;
 interface CreateSecretSignature {
     /**
-     * Creates a new secret.
-     *
-     * The `createSecret()` function returns a Promise that resolves secret ID when the secret is created.
-     *
-     * >**Notes:**
-     * > - The secret's name cannot start with `'wix'` or be identical to an existing secret's name.
-     * > - Don't leave private keys in your code. Leaving them in your code is a security risk. Make sure to delete the keys from the code after running `createSecret()`.
+     * Creates a secret.
      * @param - Fields of a new secret.
-     * @returns Fulfilled - The ID of the created secret.
-     * Rejected - Error message.
+     * @returns Secret ID.
      */
     (secret: Secret): Promise<string>;
 }
 declare function deleteSecret$1(httpClient: HttpClient): DeleteSecretSignature;
 interface DeleteSecretSignature {
     /**
-     * Deletes an existing secret by ID.
-     *
-     * The `deleteSecret()` function returns a Promise that resolves when the secret is deleted. You can retrieve the secret `_id` using the [`listSecretInfo()`](#listsecretinfo) function.
-     *
-     * >**Note:**
-     * > Deleting a secret is irreversible and will break all code using the secret.
-     *
+     * Deletes a secret.
      * @param - The unique ID of the secret to be deleted.
-     * @returns Fulfilled - When the secret is successfully deleted. Rejected - Error message.
      */
     (_id: string): Promise<void>;
 }
 declare function updateSecret$1(httpClient: HttpClient): UpdateSecretSignature;
 interface UpdateSecretSignature {
     /**
-     * Updates the specified fields of an existing secret by ID.
-     *
-     *
-     * The `updateSecret()` function returns a Promise that resolves when the secret is successfully updated. You can update one or more fields. Only fields passed in the `secret` object will be updated. All other properties will remain unchanged.
-     *
-     * You can retrieve the `_id` parameter from the [`listSecretInfo()`](#listsecretinfo) function. The secret `_id` is different from the secret `name` used by the [`getSecretValue()`](#getsecretvalue) function.
+     * Updates 1 or all fields of a secret.
      *
-     * > **Notes:**
-     * > - 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()`.
+     * To get the secret ID, call [List Secret Info](https://dev.wix.com/docs/rest/business-management/secrets/list-secret-info).
      * @param - ID of the secret to update.
      * @param - Details of a secret.
-     * @returns Fulfilled - When the secret is updated.
-     * Rejected - Error message.
      */
     (_id: string, secret: Secret): Promise<void>;
 }

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

@@ -70,63 +70,55 @@ interface CreateSecretResponseNonNullableFields$1 {
 
 interface Secret {
     /**
-     * The secret's unique ID.
+     * Secret ID.
      * @readonly
      */
     _id?: string | null;
     /**
-     * A unique, meaningful name used for retrieving the secret at runtime with the `getSecretValue()` function. You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported.
+     * 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 to protect, such as an API key.  */
+    /** The encrypted confidential value. */
     value?: string | null;
     /**
-     * The date and time the secreted was created.
+     * Date and time when the secret was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * The date and time the secret was last updated.
+     * Date and time when the secret was updated.
      * @readonly
      */
     _updatedDate?: Date | null;
 }
 interface GetSecretValueRequest {
-    /** The name of the secret to get the value of. */
+    /** Secret name. */
     name: string;
 }
 interface GetSecretValueResponse {
-    /**
-     * The plaintext, unencrypted value of the secret.
-     *
-     */
+    /** The plaintext, unencrypted value of the secret. */
     value?: string;
 }
 interface ListSecretInfoRequest {
 }
 interface ListSecretInfoResponse {
-    /** Object containing information for each secret.  */
+    /** A list of secrets with encrypted values. */
     secrets?: Secret[];
 }
 interface CreateSecretRequest {
-    /** The object including the fields of a new secret.  */
+    /** Details of a secret. */
     secret: Secret;
 }
 interface CreateSecretResponse {
-    /**
-     * The globally-unique ID assigned to the secret.
-     *
-     */
+    /** Secret ID. */
     _id?: string;
 }
 interface DeleteSecretRequest {
-    /**
-     * The unique ID of the secret to be deleted.
-     *
-     */
+    /** ID of the secret to delete. */
     _id: string;
 }
 interface DeleteSecretResponse {