@wix/auto_sdk_app-management_apps 1.0.0 → 1.0.2

package/build/cjs/index.d.ts

@@ -11,10 +11,10 @@ interface CreateAppSignature {
      * Setting `companionApp` to `true` is restricted to authorized companion-app provisioning services.
      * A supplied `slug` is ignored except for authorized companion-app provisioning callers; use Generate Slug after creation.
      * A supplied `codeIdentifier` must not contain `wix` (case-insensitive).
-     * @param - App to be created
-     * @returns The created App
+     * @param - App to create.
+     * @returns Created app.
      */
-    (app: V1App): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
+    (app: V1App): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `appUrls.postInstallationUrls` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
 }
 declare function getApp$1(httpClient: HttpClient): GetAppSignature;
 interface GetAppSignature {
@@ -22,10 +22,10 @@ interface GetAppSignature {
      * Retrieves an app by ID. App secrets are omitted by default.
      * To include `appSecrets`, add `APP_SECRETS` to `additionalFields`.
      * Retrieving secrets requires authorization to access the app's secrets.
-     * @param - Id of the App to retrieve
-     * @returns The retrieved App
+     * @param - App ID.
+     * @returns Retrieved app.
      */
-    (appId: string, options?: GetAppOptions): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
+    (appId: string, options?: GetAppOptions): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `appUrls.postInstallationUrls` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
 }
 declare function updateApp$1(httpClient: HttpClient): UpdateAppSignature;
 interface UpdateAppSignature {
@@ -38,16 +38,16 @@ interface UpdateAppSignature {
      *
      * This method cannot update `appSecrets`, `accountId`, `namespace`, `slug`, `createdBy`,
      * `companionApp`, or `codeIdentifier`. Including any of these fields or their nested fields in the
-     * update mask causes the entire request to fail; they are not silently ignored.
+     * request causes the entire request to fail; they aren't silently ignored.
      * Use Set Namespace to assign a namespace and Generate Slug to generate a slug. To rotate app
      * secrets, use Create Secondary Secret and Revoke Secret. This method does not support changing
      * the owning account, creator, companion-app designation, or code identifier.
      *
      * Changing `status` requires additional status-change authorization beyond permission to update other fields.
      * @param - App ID.
-     * @returns The updated App
+     * @returns Updated app.
      */
-    (_id: string, app: NonNullablePaths<UpdateApp, `revision`, 0>): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
+    (_id: string, app: NonNullablePaths<UpdateApp, `revision`, 0>): Promise<NonNullablePaths<V1App, `name` | `appSecrets.appSecret` | `appSecrets.webhookPublicKey` | `appSecrets.secondarySecretActive` | `status` | `appUrls.redirectUris` | `appUrls.postInstallationUrls` | `createdBy._id` | `createdBy.type` | `installationPreferences.openComponentIdOptions.componentId` | `installationPreferences.overridePostInstallationRedirect` | `installationPreferences.openButtonAction` | `installationPreferences.uninstallAction` | `unreleasedChanges.componentsChanges` | `unreleasedChanges.appTranslationsChanges` | `unreleasedChanges.componentsTranslationChanges` | `unreleasedChanges.appPermissionsChanges` | `unreleasedChanges.appEntityChanges`, 2>>;
 }
 declare function generateSlug$1(httpClient: HttpClient): GenerateSlugSignature;
 interface GenerateSlugSignature {
@@ -56,9 +56,9 @@ interface GenerateSlugSignature {
      * Does not generate a slug for companion apps; a companion app without a slug is returned unchanged.
      * When generating a slug, the stored app name must not contain `wix` for non-Wix apps (case-insensitive).
      * The exact names `google`, `facebook`, and `amazon` require privileged authorization (case-insensitive).
-     * @param - Id of the App to update
+     * @param - App ID.
      */
-    (appId: string): Promise<NonNullablePaths<GenerateSlugResponse, `app.name` | `app.appSecrets.appSecret` | `app.appSecrets.webhookPublicKey` | `app.appSecrets.secondarySecretActive` | `app.status` | `app.appUrls.redirectUris` | `app.createdBy._id` | `app.createdBy.type` | `app.installationPreferences.openComponentIdOptions.componentId` | `app.installationPreferences.overridePostInstallationRedirect` | `app.installationPreferences.openButtonAction` | `app.installationPreferences.uninstallAction` | `app.unreleasedChanges.componentsChanges` | `app.unreleasedChanges.appTranslationsChanges` | `app.unreleasedChanges.componentsTranslationChanges` | `app.unreleasedChanges.appPermissionsChanges` | `app.unreleasedChanges.appEntityChanges`, 3>>;
+    (appId: string): Promise<NonNullablePaths<GenerateSlugResponse, `app.name` | `app.appSecrets.appSecret` | `app.appSecrets.webhookPublicKey` | `app.appSecrets.secondarySecretActive` | `app.status` | `app.appUrls.redirectUris` | `app.appUrls.postInstallationUrls` | `app.createdBy._id` | `app.createdBy.type` | `app.installationPreferences.openComponentIdOptions.componentId` | `app.installationPreferences.overridePostInstallationRedirect` | `app.installationPreferences.openButtonAction` | `app.installationPreferences.uninstallAction` | `app.unreleasedChanges.componentsChanges` | `app.unreleasedChanges.appTranslationsChanges` | `app.unreleasedChanges.componentsTranslationChanges` | `app.unreleasedChanges.appPermissionsChanges` | `app.unreleasedChanges.appEntityChanges`, 3>>;
 }
 declare function getNamespaceSuggestion$1(httpClient: HttpClient): GetNamespaceSuggestionSignature;
 interface GetNamespaceSuggestionSignature {
@@ -69,7 +69,7 @@ interface GetNamespaceSuggestionSignature {
      * The exact names `google`, `facebook`, and `amazon` require privileged authorization (case-insensitive).
      * If the base namespace is already used, suggests an alternative with a numeric suffix. Suggestions do not reserve a namespace.
      * Set Namespace derives its own namespace from `appName` without automatically adding a collision suffix. Choose a different `appName` and retry if it conflicts.
-     * @param - The id of the application
+     * @param - App ID.
      */
     (appId: string, options?: GetNamespaceSuggestionOptions): Promise<NonNullablePaths<GetNamespaceSuggestionResponse, `namespace`, 0>>;
 }
@@ -84,7 +84,7 @@ interface GetNamespaceSuggestionByNameSignature {
      * The exact names `google`, `facebook`, and `amazon` require privileged authorization (case-insensitive).
      * If the base namespace is already used, suggests an alternative with a numeric suffix. Suggestions do not reserve a namespace.
      * Set Namespace derives its own namespace from `appName` without automatically adding a collision suffix. Choose a different `appName` and retry if it conflicts.
-     * @param - The name of the application
+     * @param - App display name used to derive a namespace suggestion.
      */
     (name: string, options?: GetNamespaceSuggestionByNameOptions): Promise<NonNullablePaths<GetNamespaceSuggestionByNameResponse, `namespace`, 0>>;
 }
@@ -97,8 +97,8 @@ interface SetNamespaceSignature {
      * The exact names `google`, `facebook`, and `amazon` require privileged authorization (case-insensitive).
      * Unlike namespace suggestions, this method does not automatically add a suffix when the derived namespace is already used.
      * Suggestions are not reservations; on a collision, choose a different `appName` and retry.
-     * @param - Id of the App to update
-     * @param - Name used to derive the app's namespace component, at most 50 characters before normalization.
+     * @param - App ID.
+     * @param - Name used to derive the app's namespace component.
      * Lowercased; runs of non-alphanumeric characters (including spaces and underscores) become hyphens, with leading/trailing separators removed.
      * For example, `Bookings Helper` and `Bookings_Helper` become `bookings-helper`. If no letters or digits remain, uses `untitled`.
      * Subject to the reserved-name restrictions documented on Set Namespace. For permitted Wix-owned apps, `wix` is removed before normalization.
@@ -112,9 +112,9 @@ interface CreateSecondarySecretSignature {
      * (adding one here would break consistent-audience-for-shared-permission across all of them).
      * Renaming the permission would change who is actually authorized, so it stays as-is —
      * the real check is the MANUAL validateUpdateAppPermission(...) in code.
-     * @param - ID of the App to update
+     * @param - App ID.
      */
-    (appId: string, options?: CreateSecondarySecretOptions): Promise<NonNullablePaths<CreateSecondarySecretResponse, `app.name` | `app.appSecrets.appSecret` | `app.appSecrets.webhookPublicKey` | `app.appSecrets.secondarySecretActive` | `app.status` | `app.appUrls.redirectUris` | `app.createdBy._id` | `app.createdBy.type` | `app.installationPreferences.openComponentIdOptions.componentId` | `app.installationPreferences.overridePostInstallationRedirect` | `app.installationPreferences.openButtonAction` | `app.installationPreferences.uninstallAction` | `app.unreleasedChanges.componentsChanges` | `app.unreleasedChanges.appTranslationsChanges` | `app.unreleasedChanges.componentsTranslationChanges` | `app.unreleasedChanges.appPermissionsChanges` | `app.unreleasedChanges.appEntityChanges`, 3>>;
+    (appId: string, options?: CreateSecondarySecretOptions): Promise<NonNullablePaths<CreateSecondarySecretResponse, `app.name` | `app.appSecrets.appSecret` | `app.appSecrets.webhookPublicKey` | `app.appSecrets.secondarySecretActive` | `app.status` | `app.appUrls.redirectUris` | `app.appUrls.postInstallationUrls` | `app.createdBy._id` | `app.createdBy.type` | `app.installationPreferences.openComponentIdOptions.componentId` | `app.installationPreferences.overridePostInstallationRedirect` | `app.installationPreferences.openButtonAction` | `app.installationPreferences.uninstallAction` | `app.unreleasedChanges.componentsChanges` | `app.unreleasedChanges.appTranslationsChanges` | `app.unreleasedChanges.componentsTranslationChanges` | `app.unreleasedChanges.appPermissionsChanges` | `app.unreleasedChanges.appEntityChanges`, 3>>;
 }
 declare function revokeSecret$1(httpClient: HttpClient): RevokeSecretSignature;
 interface RevokeSecretSignature {
@@ -123,8 +123,8 @@ interface RevokeSecretSignature {
      * (adding one here would break consistent-audience-for-shared-permission across all of them).
      * Renaming the permission would change who is actually authorized, so it stays as-is —
      * the real check is the MANUAL validateUpdateAppPermission(...) in code.
-     * @param - ID of the App to update
-     * @param - Which of the two secrets to get rid of
+     * @param - App ID.
+     * @param - Credential to revoke. The app must have both a previous and a replacement secret.
      */
     (appId: string, secretToRevoke: SecretToRevokeWithLiterals): Promise<RevokeSecretResponse>;
 }