@wix/secrets 1.0.1 → 1.0.2

package/build/cjs/src/velo-secrets-vault-v1-secret.http.d.ts

@@ -32,7 +32,7 @@ export declare function createSecret(payload: CreateSecretRequest): RequestOptio
 /**
  * Deletes an existing secret by ID.
  *
- * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo`](#listSecretInfo) function.
+ * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo()`](#listSecretInfo) function.
  *
  * >**Note:**
  * > Deleting a secret is irreversible and will break all code using the secret.

package/build/cjs/src/velo-secrets-vault-v1-secret.http.js

@@ -147,7 +147,7 @@ exports.createSecret = createSecret;
 /**
  * Deletes an existing secret by ID.
  *
- * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo`](#listSecretInfo) function.
+ * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo()`](#listSecretInfo) function.
  *
  * >**Note:**
  * > Deleting a secret is irreversible and will break all code using the secret.

package/build/cjs/src/velo-secrets-vault-v1-secret.types.d.ts

@@ -22,11 +22,11 @@ export interface Secret {
     updatedDate?: Date;
 }
 export interface GetSecretValueRequest {
-    /** The name of the secret to get the value for */
+    /** The name of the secret to get the value of. */
     name: string;
 }
 export interface GetSecretValueResponse {
-    /** The plaintext, unencrypted value of the secret */
+    /** The plaintext, unencrypted value of the secret. */
     value?: string;
 }
 export interface ListSecretInfoRequest {
@@ -36,23 +36,23 @@ export interface ListSecretInfoResponse {
     secrets?: Secret[];
 }
 export interface CreateSecretRequest {
-    /** A set of fields including info and the actual value to protect */
+    /** A set of fields including info and the actual value to protect. */
     secret: Secret;
 }
 export interface CreateSecretResponse {
-    /** The globally-unique id assigned to the secret by the service */
+    /** The globally-unique ID assigned to the secret by the service. */
     id?: string;
 }
 export interface DeleteSecretRequest {
-    /** The unique id of the secret to be deleted */
+    /** The unique ID of the secret to be deleted. */
     id: string;
 }
 export interface DeleteSecretResponse {
 }
 export interface UpdateSecretRequest {
-    /** The unique id of the secret to be updated */
+    /** The unique ID of the secret to be updated. */
     id: string;
-    /** The secret fields with the desired new values */
+    /** The secret fields to update. */
     secret: Secret;
 }
 export interface UpdateSecretResponse {

package/build/cjs/src/velo-secrets-vault-v1-secret.universal.d.ts

@@ -68,9 +68,9 @@ export interface DeleteSecretRequest {
 export interface DeleteSecretResponse {
 }
 export interface UpdateSecretRequest {
-    /** The unique id of the secret to be updated */
+    /** The unique ID of the secret to be updated. */
     _id: string;
-    /** The secret fields with the desired new values */
+    /** The secret fields to update. */
     secret: Secret;
 }
 export interface UpdateSecretResponse {
@@ -123,7 +123,7 @@ export declare function createSecret(secret: Secret): Promise<CreateSecretRespon
 /**
  * Deletes an existing secret by ID.
  *
- * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo`](#listSecretInfo) function.
+ * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo()`](#listSecretInfo) function.
  *
  * >**Note:**
  * > Deleting a secret is irreversible and will break all code using the secret.
@@ -137,8 +137,8 @@ export declare function createSecret(secret: Secret): Promise<CreateSecretRespon
 export declare function deleteSecret(_id: string): Promise<void>;
 /**
  * Updates all the fields of an existing secret at once
- * @param _id - The unique id of the secret to be updated
- * @param secret - The secret fields with the desired new values
+ * @param _id - The unique ID of the secret to be updated.
+ * @param secret - The secret fields to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
@@ -149,8 +149,8 @@ export declare function deleteSecret(_id: string): Promise<void>;
 export declare function updateSecret(_id: string, secret: Secret): Promise<void>;
 /**
  * Updates some or all of the fields of an existing secret
- * @param _id - The unique id of the secret to be updated
- * @param secret - The secret fields with the desired new values
+ * @param _id - The unique ID of the secret to be updated.
+ * @param secret - The secret fields to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id

package/build/cjs/src/velo-secrets-vault-v1-secret.universal.js

@@ -231,7 +231,7 @@ exports.createSecret = createSecret;
 /**
  * Deletes an existing secret by ID.
  *
- * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo`](#listSecretInfo) function.
+ * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo()`](#listSecretInfo) function.
  *
  * >**Note:**
  * > Deleting a secret is irreversible and will break all code using the secret.
@@ -288,8 +288,8 @@ function deleteSecret(_id) {
 exports.deleteSecret = deleteSecret;
 /**
  * Updates all the fields of an existing secret at once
- * @param _id - The unique id of the secret to be updated
- * @param secret - The secret fields with the desired new values
+ * @param _id - The unique ID of the secret to be updated.
+ * @param secret - The secret fields to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
@@ -344,8 +344,8 @@ function updateSecret(_id, secret) {
 exports.updateSecret = updateSecret;
 /**
  * Updates some or all of the fields of an existing secret
- * @param _id - The unique id of the secret to be updated
- * @param secret - The secret fields with the desired new values
+ * @param _id - The unique ID of the secret to be updated.
+ * @param secret - The secret fields to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id

package/build/es/src/velo-secrets-vault-v1-secret.http.d.ts

@@ -32,7 +32,7 @@ export declare function createSecret(payload: CreateSecretRequest): RequestOptio
 /**
  * Deletes an existing secret by ID.
  *
- * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo`](#listSecretInfo) function.
+ * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo()`](#listSecretInfo) function.
  *
  * >**Note:**
  * > Deleting a secret is irreversible and will break all code using the secret.

package/build/es/src/velo-secrets-vault-v1-secret.http.js

@@ -141,7 +141,7 @@ export function createSecret(payload) {
 /**
  * Deletes an existing secret by ID.
  *
- * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo`](#listSecretInfo) function.
+ * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo()`](#listSecretInfo) function.
  *
  * >**Note:**
  * > Deleting a secret is irreversible and will break all code using the secret.

package/build/es/src/velo-secrets-vault-v1-secret.types.d.ts

@@ -22,11 +22,11 @@ export interface Secret {
     updatedDate?: Date;
 }
 export interface GetSecretValueRequest {
-    /** The name of the secret to get the value for */
+    /** The name of the secret to get the value of. */
     name: string;
 }
 export interface GetSecretValueResponse {
-    /** The plaintext, unencrypted value of the secret */
+    /** The plaintext, unencrypted value of the secret. */
     value?: string;
 }
 export interface ListSecretInfoRequest {
@@ -36,23 +36,23 @@ export interface ListSecretInfoResponse {
     secrets?: Secret[];
 }
 export interface CreateSecretRequest {
-    /** A set of fields including info and the actual value to protect */
+    /** A set of fields including info and the actual value to protect. */
     secret: Secret;
 }
 export interface CreateSecretResponse {
-    /** The globally-unique id assigned to the secret by the service */
+    /** The globally-unique ID assigned to the secret by the service. */
     id?: string;
 }
 export interface DeleteSecretRequest {
-    /** The unique id of the secret to be deleted */
+    /** The unique ID of the secret to be deleted. */
     id: string;
 }
 export interface DeleteSecretResponse {
 }
 export interface UpdateSecretRequest {
-    /** The unique id of the secret to be updated */
+    /** The unique ID of the secret to be updated. */
     id: string;
-    /** The secret fields with the desired new values */
+    /** The secret fields to update. */
     secret: Secret;
 }
 export interface UpdateSecretResponse {

package/build/es/src/velo-secrets-vault-v1-secret.universal.d.ts

@@ -68,9 +68,9 @@ export interface DeleteSecretRequest {
 export interface DeleteSecretResponse {
 }
 export interface UpdateSecretRequest {
-    /** The unique id of the secret to be updated */
+    /** The unique ID of the secret to be updated. */
     _id: string;
-    /** The secret fields with the desired new values */
+    /** The secret fields to update. */
     secret: Secret;
 }
 export interface UpdateSecretResponse {
@@ -123,7 +123,7 @@ export declare function createSecret(secret: Secret): Promise<CreateSecretRespon
 /**
  * Deletes an existing secret by ID.
  *
- * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo`](#listSecretInfo) function.
+ * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo()`](#listSecretInfo) function.
  *
  * >**Note:**
  * > Deleting a secret is irreversible and will break all code using the secret.
@@ -137,8 +137,8 @@ export declare function createSecret(secret: Secret): Promise<CreateSecretRespon
 export declare function deleteSecret(_id: string): Promise<void>;
 /**
  * Updates all the fields of an existing secret at once
- * @param _id - The unique id of the secret to be updated
- * @param secret - The secret fields with the desired new values
+ * @param _id - The unique ID of the secret to be updated.
+ * @param secret - The secret fields to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
@@ -149,8 +149,8 @@ export declare function deleteSecret(_id: string): Promise<void>;
 export declare function updateSecret(_id: string, secret: Secret): Promise<void>;
 /**
  * Updates some or all of the fields of an existing secret
- * @param _id - The unique id of the secret to be updated
- * @param secret - The secret fields with the desired new values
+ * @param _id - The unique ID of the secret to be updated.
+ * @param secret - The secret fields to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id

package/build/es/src/velo-secrets-vault-v1-secret.universal.js

@@ -206,7 +206,7 @@ export function createSecret(secret) {
 /**
  * Deletes an existing secret by ID.
  *
- * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo`](#listSecretInfo) function.
+ * The `deleteSecret()` function returns a Promise that resolves when a secret from the [Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager) is deleted. You can retrieve the `_id` parameter using the [`listSecretInfo()`](#listSecretInfo) function.
  *
  * >**Note:**
  * > Deleting a secret is irreversible and will break all code using the secret.
@@ -262,8 +262,8 @@ export function deleteSecret(_id) {
 }
 /**
  * Updates all the fields of an existing secret at once
- * @param _id - The unique id of the secret to be updated
- * @param secret - The secret fields with the desired new values
+ * @param _id - The unique ID of the secret to be updated.
+ * @param secret - The secret fields to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
@@ -317,8 +317,8 @@ export function updateSecret(_id, secret) {
 }
 /**
  * Updates some or all of the fields of an existing secret
- * @param _id - The unique id of the secret to be updated
- * @param secret - The secret fields with the desired new values
+ * @param _id - The unique ID of the secret to be updated.
+ * @param secret - The secret fields to update.
  * @public
  * @documentationMaturity preview
  * @requiredField _id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/secrets",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -33,5 +33,5 @@
       "groupId": "com.wixpress.public-sdk-autogen"
     }
   },
-  "falconPackageHash": "d0ad85ec80b5d3124469ced81a77386308aee454671314d340e65804"
+  "falconPackageHash": "9445cd7ccd32bf280e54c4fcb592b47f99ad8d4b1234c0144905c51f"
 }