@wix/auto_sdk_app-management_apps 0.0.0-stage → 1.0.1

package/build/cjs/index.d.ts

@@ -0,0 +1,142 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { V1App, GetAppOptions, UpdateApp, GenerateSlugResponse, GetNamespaceSuggestionOptions, GetNamespaceSuggestionResponse, GetNamespaceSuggestionByNameOptions, GetNamespaceSuggestionByNameResponse, SetNamespaceOptions, SetNamespaceResponse, CreateSecondarySecretOptions, CreateSecondarySecretResponse, SecretToRevokeWithLiterals, RevokeSecretResponse } from './index.typings.js';
+export { AccountInfo, Action, ActionEvent, ActionWithLiterals, ActivateSecondarySecretRequest, ActivateSecondarySecretResponse, AddressLocation, App, AppChangedEvent, AppComponentMetadata, AppOwnerChangedEvent, AppSecrets, AppSlugChanged, AppType, AppTypeWithLiterals, AppUriMessage, AppUrls, AppUrlsChangedInOldServiceEvent, AppUrlsChangedInOldServiceEventChangedUrlOneOf, AppVersionApproved, AppVersionArchived, AppVersionCreated, AppVersionDeclined, AppVersionDraftChanged, AppVersionPublished, AppVersionReleased, AppVersionStateChanged, AppVersionStateChangedStateOneOf, AppVersionSubmitted, AssociateServiceAppRequest, AssociateServiceAppResponse, ConsentOptions, ContactEmails, CreateAppRequest, CreateAppResponse, CreateSecondarySecretRequest, CreateServiceAppRequest, CreateServiceAppResponse, CreatedBy, CreatedByType, CreatedByTypeWithLiterals, CursorPaging, Cursors, DeleteAppRequest, DeleteAppResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ForceCascadeDeleteAppDecision, ForceCascadeDeleteAppDecisionWithLiterals, ForceCascadeDeleteAppRequest, ForceCascadeDeleteAppResponse, GenerateSlugRequest, GetAppRequest, GetAppResponse, GetNamespaceSuggestionByNameRequest, GetNamespaceSuggestionRequest, HostAppConfig, IdentificationData, IdentificationDataIdOneOf, InstallationPreferences, InstallationPreferencesOpenButtonOptionsOneOf, LoginPolicy, LoginPolicyWithLiterals, MessageEnvelope, NamespaceType, NamespaceTypeWithLiterals, OpenButtonAction, OpenButtonActionWithLiterals, OpenComponentId, Paging, PagingMetadataV2, PartialVersionOptions, PermissionLevel, PermissionLevelWithLiterals, QueryAppRequest, QueryAppResponse, QueryV2, QueryV2PagingMethodOneOf, RedirectTarget, RedirectTargetWithLiterals, RedirectUrlMessage, RenameCodeIdentifierRequest, RenameCodeIdentifierResponse, RenameSlugRequest, RenameSlugResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, RevokeSecretRequest, RollbackSecretRequest, RollbackSecretResponse, RotateSecretRequest, RotateSecretResponse, SecretToRevoke, SetAppOwnerRequest, SetAppOwnerResponse, SetCacheableAppRequest, SetCacheableAppResponse, SetCodeIdentifierRequest, SetCodeIdentifierResponse, SetComponentsMetadataRequest, SetComponentsMetadataResponse, SetExceededSizeRequest, SetExceededSizeResponse, SetHipaaCompliantRequest, SetHipaaCompliantResponse, SetNamespaceRequest, SetOwnershipTagRequest, SetOwnershipTagResponse, SetPrivateAppRequest, SetPrivateAppResponse, ShowConsentBehaviour, ShowConsentBehaviourWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, Status, StatusWithLiterals, SuggestCodeIdentifierRequest, SuggestCodeIdentifierResponse, UninstallActions, UninstallActionsWithLiterals, UnreleasedChanges, UpdateAppRequest, UpdateAppResponse, UpdateHostAppConfigRequest, UpdateHostAppConfigResponse, VersionStatus, VersionStatusWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+declare function createApp$1(httpClient: HttpClient): CreateAppSignature;
+interface CreateAppSignature {
+    /**
+     * Creates an app.
+     *
+     * Don't include `namespace` in the request; use Set Namespace after creating the app.
+     * 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 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>>;
+}
+declare function getApp$1(httpClient: HttpClient): GetAppSignature;
+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 - 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>>;
+}
+declare function updateApp$1(httpClient: HttpClient): UpdateAppSignature;
+interface UpdateAppSignature {
+    /**
+     * Updates an app.
+     *
+     * Each time the app is updated, `revision` increments by 1. The current `revision` must be passed
+     * when updating the app. This ensures you're working with the latest app and prevents unintended overwrites.
+     * Supports partial updates; specify the app's ID and the fields to change.
+     *
+     * This method cannot update `appSecrets`, `accountId`, `namespace`, `slug`, `createdBy`,
+     * `companionApp`, or `codeIdentifier`. Including any of these fields or their nested fields in the
+     * 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 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>>;
+}
+declare function generateSlug$1(httpClient: HttpClient): GenerateSlugSignature;
+interface GenerateSlugSignature {
+    /**
+     * Generates a slug for the app. If a slug already exists, returns the app with its existing slug.
+     * 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 - 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>>;
+}
+declare function getNamespaceSuggestion$1(httpClient: HttpClient): GetNamespaceSuggestionSignature;
+interface GetNamespaceSuggestionSignature {
+    /**
+     * Suggests a namespace using the app's stored name and its owning account's slug or company name.
+     * Falls back to the account slug when no company name is available.
+     * Non-Wix app names must not contain `wix` (case-insensitive).
+     * 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 - App ID.
+     */
+    (appId: string, options?: GetNamespaceSuggestionOptions): Promise<NonNullablePaths<GetNamespaceSuggestionResponse, `namespace`, 0>>;
+}
+declare function getNamespaceSuggestionByName$1(httpClient: HttpClient): GetNamespaceSuggestionByNameSignature;
+interface GetNamespaceSuggestionByNameSignature {
+    /**
+     * Suggests a namespace from the supplied app name and the caller's account or company context.
+     * No app ID is required, so this method can be used before creating an app.
+     * With `type` set to `COMPANY`, falls back to the account slug if no company name is available.
+     * To suggest a namespace for an existing app using its stored name and ownership context, use Get Namespace Suggestion.
+     * The supplied name must not contain `wix` (case-insensitive).
+     * 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 - App display name used to derive a namespace suggestion.
+     */
+    (name: string, options?: GetNamespaceSuggestionByNameOptions): Promise<NonNullablePaths<GetNamespaceSuggestionByNameResponse, `namespace`, 0>>;
+}
+declare function setNamespace$1(httpClient: HttpClient): SetNamespaceSignature;
+interface SetNamespaceSignature {
+    /**
+     * Sets the app namespace using the owning account's slug or company name and the supplied `appName`.
+     * Falls back to the account slug when no company name is available. A namespace can be set only once.
+     * For non-Wix apps, `appName` must not contain `wix` (case-insensitive).
+     * 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 - 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.
+     */
+    (appId: string, appName: string, options?: SetNamespaceOptions): Promise<NonNullablePaths<SetNamespaceResponse, `namespace`, 0>>;
+}
+declare function createSecondarySecret$1(httpClient: HttpClient): CreateSecondarySecretSignature;
+interface CreateSecondarySecretSignature {
+    /**
+     * Shares WIX_DEVELOPERS.MODIFY_APP with the sibling app-write RPCs, which declare no audience
+     * (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 - 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>>;
+}
+declare function revokeSecret$1(httpClient: HttpClient): RevokeSecretSignature;
+interface RevokeSecretSignature {
+    /**
+     * Shares WIX_DEVELOPERS.MODIFY_APP with the sibling app-write RPCs, which declare no audience
+     * (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 - App ID.
+     * @param - Credential to revoke. The app must have both a previous and a replacement secret.
+     */
+    (appId: string, secretToRevoke: SecretToRevokeWithLiterals): Promise<RevokeSecretResponse>;
+}
+
+declare const createApp: MaybeContext<BuildRESTFunction<typeof createApp$1> & typeof createApp$1>;
+declare const getApp: MaybeContext<BuildRESTFunction<typeof getApp$1> & typeof getApp$1>;
+declare const updateApp: MaybeContext<BuildRESTFunction<typeof updateApp$1> & typeof updateApp$1>;
+declare const generateSlug: MaybeContext<BuildRESTFunction<typeof generateSlug$1> & typeof generateSlug$1>;
+declare const getNamespaceSuggestion: MaybeContext<BuildRESTFunction<typeof getNamespaceSuggestion$1> & typeof getNamespaceSuggestion$1>;
+declare const getNamespaceSuggestionByName: MaybeContext<BuildRESTFunction<typeof getNamespaceSuggestionByName$1> & typeof getNamespaceSuggestionByName$1>;
+declare const setNamespace: MaybeContext<BuildRESTFunction<typeof setNamespace$1> & typeof setNamespace$1>;
+declare const createSecondarySecret: MaybeContext<BuildRESTFunction<typeof createSecondarySecret$1> & typeof createSecondarySecret$1>;
+declare const revokeSecret: MaybeContext<BuildRESTFunction<typeof revokeSecret$1> & typeof revokeSecret$1>;
+
+export { CreateSecondarySecretOptions, CreateSecondarySecretResponse, GenerateSlugResponse, GetAppOptions, GetNamespaceSuggestionByNameOptions, GetNamespaceSuggestionByNameResponse, GetNamespaceSuggestionOptions, GetNamespaceSuggestionResponse, RevokeSecretResponse, SecretToRevokeWithLiterals, SetNamespaceOptions, SetNamespaceResponse, UpdateApp, V1App, createApp, createSecondarySecret, generateSlug, getApp, getNamespaceSuggestion, getNamespaceSuggestionByName, revokeSecret, setNamespace, updateApp };