@wix/auto_sdk_app-management_apps 1.0.1 → 1.0.3

package/build/cjs/index.typings.d.ts

@@ -150,6 +150,13 @@ interface AppUrls {
      * @maxSize 100
      */
     redirectUris?: string[];
+    /**
+     * Allowed post-installation URLs, where Wix redirects the user after installing the app from an external install link.
+     * A `postInstallationUrl` matches an entry when they are equal, ignoring the query string.
+     * @format WEB_URL
+     * @maxSize 100
+     */
+    postInstallationUrls?: string[];
 }
 interface CreatedBy {
     /**
@@ -323,6 +330,21 @@ declare enum LoginPolicy {
 }
 /** @enumType */
 type LoginPolicyWithLiterals = LoginPolicy | 'LOGIN_POLICY_UNKNOWN' | 'LOGIN_POLICY_REQUIRED' | 'LOGIN_POLICY_OPTIONAL';
+interface CompanionAppOptions {
+    /**
+     * ID of the site or account that owns the companion app.
+     * @format GUID
+     */
+    tenantId?: string;
+    /** Type of tenant that owns the companion app. */
+    tenantType?: TenantTypeWithLiterals;
+}
+declare enum TenantType {
+    SITE = "SITE",
+    ACCOUNT = "ACCOUNT"
+}
+/** @enumType */
+type TenantTypeWithLiterals = TenantType | 'SITE' | 'ACCOUNT';
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -1166,6 +1188,19 @@ interface SetCacheableAppResponse {
     /** The updated app */
     app?: V1App;
 }
+interface SetCompanionAppOptionsRequest {
+    /**
+     * ID of the companion app to update.
+     * @format GUID
+     */
+    appId?: string;
+    /** Owning site or account of the companion app. */
+    companionAppOptions?: CompanionAppOptions;
+}
+interface SetCompanionAppOptionsResponse {
+    /** Updated app. */
+    app?: V1App;
+}
 interface SetComponentsMetadataRequest {
     /**
      * App id of the app to update
@@ -1251,7 +1286,7 @@ interface AssociateServiceAppResponse {
  * @returns Created app.
  * @fqn wix.devcenter.apps.v1.AppsService.CreateApp
  */
-declare function createApp(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 createApp(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>>;
 /**
  * Retrieves an app by ID. App secrets are omitted by default.
  * To include `appSecrets`, add `APP_SECRETS` to `additionalFields`.
@@ -1265,7 +1300,7 @@ declare function createApp(app: V1App): Promise<NonNullablePaths<V1App, `name` |
  * @returns Retrieved app.
  * @fqn wix.devcenter.apps.v1.AppsService.GetApp
  */
-declare function getApp(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 getApp(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>>;
 interface GetAppOptions {
     /** Whether to use a consistent read to retrieve the latest stored app data. Default: `false`. */
     consistent?: boolean;
@@ -1303,7 +1338,7 @@ interface GetAppOptions {
  * @returns Updated app.
  * @fqn wix.devcenter.apps.v1.AppsService.UpdateApp
  */
-declare function updateApp(_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 updateApp(_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>>;
 interface UpdateApp {
     /**
      * App ID.
@@ -1403,7 +1438,7 @@ interface UpdateApp {
  * @permissionId DEV_CENTER.WRITE_APP
  * @fqn wix.devcenter.apps.v1.AppsService.GenerateSlug
  */
-declare function generateSlug(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 generateSlug(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>>;
 /**
  * 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.
@@ -1482,7 +1517,7 @@ interface SetNamespaceOptions {
  * @permissionId WIX_DEVELOPERS.MODIFY_APP
  * @fqn wix.devcenter.apps.v1.AppsService.CreateSecondarySecret
  */
-declare function createSecondarySecret(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 createSecondarySecret(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>>;
 interface CreateSecondarySecretOptions {
     /** Latest app revision, available from Get App. An outdated revision is rejected. */
     revision?: string;
@@ -1503,4 +1538,4 @@ interface CreateSecondarySecretOptions {
  */
 declare function revokeSecret(appId: string, secretToRevoke: SecretToRevokeWithLiterals): Promise<RevokeSecretResponse>;
 
-export { type AccountInfo, Action, type ActionEvent, type ActionWithLiterals, type ActivateSecondarySecretRequest, type ActivateSecondarySecretResponse, type AddressLocation, type App, type AppChangedEvent, type AppComponentMetadata, type AppOwnerChangedEvent, type AppSecrets, type AppSlugChanged, AppType, type AppTypeWithLiterals, type AppUriMessage, type AppUrls, type AppUrlsChangedInOldServiceEvent, type AppUrlsChangedInOldServiceEventChangedUrlOneOf, type AppVersionApproved, type AppVersionArchived, type AppVersionCreated, type AppVersionDeclined, type AppVersionDraftChanged, type AppVersionPublished, type AppVersionReleased, type AppVersionStateChanged, type AppVersionStateChangedStateOneOf, type AppVersionSubmitted, type AssociateServiceAppRequest, type AssociateServiceAppResponse, type ConsentOptions, type ContactEmails, type CreateAppRequest, type CreateAppResponse, type CreateSecondarySecretOptions, type CreateSecondarySecretRequest, type CreateSecondarySecretResponse, type CreateServiceAppRequest, type CreateServiceAppResponse, type CreatedBy, CreatedByType, type CreatedByTypeWithLiterals, type CursorPaging, type Cursors, type DeleteAppRequest, type DeleteAppResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ForceCascadeDeleteAppDecision, type ForceCascadeDeleteAppDecisionWithLiterals, type ForceCascadeDeleteAppRequest, type ForceCascadeDeleteAppResponse, type GenerateSlugRequest, type GenerateSlugResponse, type GetAppOptions, type GetAppRequest, type GetAppResponse, type GetNamespaceSuggestionByNameOptions, type GetNamespaceSuggestionByNameRequest, type GetNamespaceSuggestionByNameResponse, type GetNamespaceSuggestionOptions, type GetNamespaceSuggestionRequest, type GetNamespaceSuggestionResponse, type HostAppConfig, type IdentificationData, type IdentificationDataIdOneOf, type InstallationPreferences, type InstallationPreferencesOpenButtonOptionsOneOf, LoginPolicy, type LoginPolicyWithLiterals, type MessageEnvelope, NamespaceType, type NamespaceTypeWithLiterals, OpenButtonAction, type OpenButtonActionWithLiterals, type OpenComponentId, type Paging, type PagingMetadataV2, type PartialVersionOptions, PermissionLevel, type PermissionLevelWithLiterals, type QueryAppRequest, type QueryAppResponse, type QueryV2, type QueryV2PagingMethodOneOf, RedirectTarget, type RedirectTargetWithLiterals, type RedirectUrlMessage, type RenameCodeIdentifierRequest, type RenameCodeIdentifierResponse, type RenameSlugRequest, type RenameSlugResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RevokeSecretRequest, type RevokeSecretResponse, type RollbackSecretRequest, type RollbackSecretResponse, type RotateSecretRequest, type RotateSecretResponse, SecretToRevoke, type SecretToRevokeWithLiterals, type SetAppOwnerRequest, type SetAppOwnerResponse, type SetCacheableAppRequest, type SetCacheableAppResponse, type SetCodeIdentifierRequest, type SetCodeIdentifierResponse, type SetComponentsMetadataRequest, type SetComponentsMetadataResponse, type SetExceededSizeRequest, type SetExceededSizeResponse, type SetHipaaCompliantRequest, type SetHipaaCompliantResponse, type SetNamespaceOptions, type SetNamespaceRequest, type SetNamespaceResponse, type SetOwnershipTagRequest, type SetOwnershipTagResponse, type SetPrivateAppRequest, type SetPrivateAppResponse, ShowConsentBehaviour, type ShowConsentBehaviourWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type SuggestCodeIdentifierRequest, type SuggestCodeIdentifierResponse, UninstallActions, type UninstallActionsWithLiterals, type UnreleasedChanges, type UpdateApp, type UpdateAppRequest, type UpdateAppResponse, type UpdateHostAppConfigRequest, type UpdateHostAppConfigResponse, type V1App, VersionStatus, type VersionStatusWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createApp, createSecondarySecret, generateSlug, getApp, getNamespaceSuggestion, getNamespaceSuggestionByName, revokeSecret, setNamespace, updateApp };
+export { type AccountInfo, Action, type ActionEvent, type ActionWithLiterals, type ActivateSecondarySecretRequest, type ActivateSecondarySecretResponse, type AddressLocation, type App, type AppChangedEvent, type AppComponentMetadata, type AppOwnerChangedEvent, type AppSecrets, type AppSlugChanged, AppType, type AppTypeWithLiterals, type AppUriMessage, type AppUrls, type AppUrlsChangedInOldServiceEvent, type AppUrlsChangedInOldServiceEventChangedUrlOneOf, type AppVersionApproved, type AppVersionArchived, type AppVersionCreated, type AppVersionDeclined, type AppVersionDraftChanged, type AppVersionPublished, type AppVersionReleased, type AppVersionStateChanged, type AppVersionStateChangedStateOneOf, type AppVersionSubmitted, type AssociateServiceAppRequest, type AssociateServiceAppResponse, type CompanionAppOptions, type ConsentOptions, type ContactEmails, type CreateAppRequest, type CreateAppResponse, type CreateSecondarySecretOptions, type CreateSecondarySecretRequest, type CreateSecondarySecretResponse, type CreateServiceAppRequest, type CreateServiceAppResponse, type CreatedBy, CreatedByType, type CreatedByTypeWithLiterals, type CursorPaging, type Cursors, type DeleteAppRequest, type DeleteAppResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ForceCascadeDeleteAppDecision, type ForceCascadeDeleteAppDecisionWithLiterals, type ForceCascadeDeleteAppRequest, type ForceCascadeDeleteAppResponse, type GenerateSlugRequest, type GenerateSlugResponse, type GetAppOptions, type GetAppRequest, type GetAppResponse, type GetNamespaceSuggestionByNameOptions, type GetNamespaceSuggestionByNameRequest, type GetNamespaceSuggestionByNameResponse, type GetNamespaceSuggestionOptions, type GetNamespaceSuggestionRequest, type GetNamespaceSuggestionResponse, type HostAppConfig, type IdentificationData, type IdentificationDataIdOneOf, type InstallationPreferences, type InstallationPreferencesOpenButtonOptionsOneOf, LoginPolicy, type LoginPolicyWithLiterals, type MessageEnvelope, NamespaceType, type NamespaceTypeWithLiterals, OpenButtonAction, type OpenButtonActionWithLiterals, type OpenComponentId, type Paging, type PagingMetadataV2, type PartialVersionOptions, PermissionLevel, type PermissionLevelWithLiterals, type QueryAppRequest, type QueryAppResponse, type QueryV2, type QueryV2PagingMethodOneOf, RedirectTarget, type RedirectTargetWithLiterals, type RedirectUrlMessage, type RenameCodeIdentifierRequest, type RenameCodeIdentifierResponse, type RenameSlugRequest, type RenameSlugResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type RevokeSecretRequest, type RevokeSecretResponse, type RollbackSecretRequest, type RollbackSecretResponse, type RotateSecretRequest, type RotateSecretResponse, SecretToRevoke, type SecretToRevokeWithLiterals, type SetAppOwnerRequest, type SetAppOwnerResponse, type SetCacheableAppRequest, type SetCacheableAppResponse, type SetCodeIdentifierRequest, type SetCodeIdentifierResponse, type SetCompanionAppOptionsRequest, type SetCompanionAppOptionsResponse, type SetComponentsMetadataRequest, type SetComponentsMetadataResponse, type SetExceededSizeRequest, type SetExceededSizeResponse, type SetHipaaCompliantRequest, type SetHipaaCompliantResponse, type SetNamespaceOptions, type SetNamespaceRequest, type SetNamespaceResponse, type SetOwnershipTagRequest, type SetOwnershipTagResponse, type SetPrivateAppRequest, type SetPrivateAppResponse, ShowConsentBehaviour, type ShowConsentBehaviourWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type SuggestCodeIdentifierRequest, type SuggestCodeIdentifierResponse, TenantType, type TenantTypeWithLiterals, UninstallActions, type UninstallActionsWithLiterals, type UnreleasedChanges, type UpdateApp, type UpdateAppRequest, type UpdateAppResponse, type UpdateHostAppConfigRequest, type UpdateHostAppConfigResponse, type V1App, VersionStatus, type VersionStatusWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createApp, createSecondarySecret, generateSlug, getApp, getNamespaceSuggestion, getNamespaceSuggestionByName, revokeSecret, setNamespace, updateApp };

package/build/cjs/index.typings.js

@@ -34,6 +34,7 @@ __export(index_typings_exports, {
   ShowConsentBehaviour: () => ShowConsentBehaviour,
   SortOrder: () => SortOrder,
   Status: () => Status,
+  TenantType: () => TenantType,
   UninstallActions: () => UninstallActions,
   VersionStatus: () => VersionStatus,
   WebhookIdentityType: () => WebhookIdentityType,
@@ -465,6 +466,11 @@ var LoginPolicy = /* @__PURE__ */ ((LoginPolicy2) => {
   LoginPolicy2["LOGIN_POLICY_OPTIONAL"] = "LOGIN_POLICY_OPTIONAL";
   return LoginPolicy2;
 })(LoginPolicy || {});
+var TenantType = /* @__PURE__ */ ((TenantType2) => {
+  TenantType2["SITE"] = "SITE";
+  TenantType2["ACCOUNT"] = "ACCOUNT";
+  return TenantType2;
+})(TenantType || {});
 var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
   WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
   WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
@@ -771,6 +777,7 @@ async function revokeSecret2(appId, secretToRevoke) {
   ShowConsentBehaviour,
   SortOrder,
   Status,
+  TenantType,
   UninstallActions,
   VersionStatus,
   WebhookIdentityType,