@wix/auto_sdk_app-management_app-permissions 1.0.5 → 1.0.7

package/build/{internal/cjs/src/devcenter-apps-v1-app-permission-app-permissions.universal.d.ts → devcenter-apps-v1-app-permission-app-permissions.universal-ROYtr-wC.d.mts}

@@ -1,15 +1,13 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-/** AppPermission is the main entity of AppPermissionsService that define relation between app and permission */
-export interface AppPermission {
+interface AppPermission {
     /**
      * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
      *
-     * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
+     * You can find the app ID in the app's dashboard's [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home).
      * @format GUID
      */
     appId?: string;
     /**
-     * Permission details.
+     * Permission to configure.
      *
      * Learn more [about permissions for Wix apps](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
      */
@@ -20,30 +18,30 @@ export interface AppPermission {
      */
     _createdDate?: Date | null;
     /**
-     * When the permission was last updated
+     * When the permission was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
 }
-export interface V1Permission {
+interface V1Permission {
     /**
      * Permission ID.
      *
-     * To find the permission ID, visit the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app#step-1--identify-required-permissions).
+     * To find the permission ID, navigate to the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app#step-1--identify-required-permissions).
      * @minLength 1
      * @maxLength 164
      */
     permissionId?: string;
 }
-export interface CreateAppPermissionRequest {
-    /** App permission to create. */
+interface CreateAppPermissionRequest {
+    /** Permission to add to the specified app. */
     appPermission: AppPermission;
 }
-export interface CreateAppPermissionResponse {
-    /** Details of the created app permission. */
+interface CreateAppPermissionResponse {
+    /** Details of permission that was added to the app. */
     appPermission?: AppPermission;
 }
-export interface GetAppPermissionRequest {
+interface GetAppPermissionRequest {
     /**
      * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
      *
@@ -54,17 +52,17 @@ export interface GetAppPermissionRequest {
     /**
      * Permission ID.
      *
-     * To find the permission ID, visit the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app#step-1--identify-required-permissions).
+     * To find the permission ID, navigate to the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app#step-1--identify-required-permissions).
      * @minLength 1
      * @maxLength 164
      */
     permissionId?: string;
 }
-export interface GetAppPermissionResponse {
+interface GetAppPermissionResponse {
     /** Details of the retrieved app permission. */
     appPermission?: AppPermission;
 }
-export interface ListAppPermissionsRequest {
+interface ListAppPermissionsRequest {
     /**
      * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
      *
@@ -73,7 +71,7 @@ export interface ListAppPermissionsRequest {
      */
     appId: string;
     /**
-     * Whether to retrieve the most recent permissions information. This decreases performance but ensures the information retrieved is up-to-date even immediately after an update.
+     * Whether to retrieve the most recent permissions information. This decreases performance but ensures that the retrieved information is up-to-date, even immediately after an update.
      *
      * Default: `false`
      */
@@ -81,7 +79,7 @@ export interface ListAppPermissionsRequest {
     /** Paging configuration. */
     paging?: CursorPaging;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -96,13 +94,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface ListAppPermissionsResponse {
-    /** App permissions. */
+interface ListAppPermissionsResponse {
+    /** List of permissions for the specified app. */
     appPermissions?: AppPermission[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -115,7 +113,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -127,7 +125,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface DeleteAppPermissionRequest {
+interface DeleteAppPermissionRequest {
     /**
      * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
      *
@@ -138,24 +136,24 @@ export interface DeleteAppPermissionRequest {
     /**
      * Permission ID.
      *
-     * To find the permission ID, visit the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app#step-1--identify-required-permissions).
+     * To find the permission ID, navigate to the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app#step-1--identify-required-permissions).
      * @minLength 1
      * @maxLength 164
      */
     permissionId: string;
 }
-export interface DeleteAppPermissionResponse {
+interface DeleteAppPermissionResponse {
 }
-export interface PermissionActionDomainEventEntity {
+interface PermissionActionDomainEventEntity {
     /** The permission that had an event */
     appPermission?: AppPermission;
     /** The action which happened */
     actionType?: ActionType;
 }
-export declare enum ActionType {
+declare enum ActionType {
     APP_PERMISSION_DELETED = "APP_PERMISSION_DELETED"
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -198,19 +196,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -218,30 +216,30 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface OldPermissionChangedEvent {
+interface OldPermissionChangedEvent {
     /** @format GUID */
     appId?: string;
     permission?: Permission;
     action?: Action;
 }
-export interface Permission {
+interface Permission {
     permissionId?: string;
 }
-export declare enum Action {
+declare enum Action {
     CREATED = "CREATED",
     UPDATED = "UPDATED",
     DELETED = "DELETED"
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -257,7 +255,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -282,7 +280,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -304,14 +302,14 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface BaseEventMetadata {
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -325,7 +323,7 @@ export interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-export interface EventMetadata extends BaseEventMetadata {
+interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -363,52 +361,16 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface AppPermissionCreatedEnvelope {
+interface AppPermissionCreatedEnvelope {
     entity: AppPermission;
     metadata: EventMetadata;
 }
-/** @permissionId DEV_CENTER.READ_APP_PERMISSIONS
- * @webhook
- * @eventType wix.devcenter.apps.v1.app_permission_created
- * @slug created
- * @documentationMaturity preview
- */
-export declare function onAppPermissionCreated(handler: (event: AppPermissionCreatedEnvelope) => void | Promise<void>): void;
-type AppPermissionNonNullablePaths = `appId` | `permission.permissionId`;
-/**
- * Creates a new app permission.
- * @param appPermission - App permission to create.
- * @public
- * @documentationMaturity preview
- * @requiredField appPermission
- * @requiredField appPermission.appId
- * @requiredField appPermission.permission
- * @requiredField appPermission.permission.permissionId
- * @permissionId DEV_CENTER.CREATE_APP_PERMISSION
- * @permissionScope Write Dev Center App Permissions
- * @permissionScopeId SCOPE.DEV_CENTER.WRITE_PERMISSIONS
- * @applicableIdentity APP
- * @returns Details of the created app permission.
- * @fqn wix.devcenter.apps.permissions.v1.AppPermissionsService.CreateAppPermission
- */
-export declare function createAppPermission(appPermission: NonNullablePaths<AppPermission, `appId` | `permission` | `permission.permissionId`>): Promise<NonNullablePaths<AppPermission, AppPermissionNonNullablePaths>>;
-/**
- * Lists app permissions by app ID.
- * @param appId - [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
- *
- * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
- * @public
- * @documentationMaturity preview
- * @requiredField appId
- * @permissionId DEV_CENTER.READ_APP_PERMISSIONS
- * @fqn wix.devcenter.apps.permissions.v1.AppPermissionsService.ListAppPermissions
- */
-export declare function listAppPermissions(appId: string, options?: ListAppPermissionsOptions): Promise<NonNullablePaths<ListAppPermissionsResponse, {
-    [P in AppPermissionNonNullablePaths]: `appPermissions.${number}.${P}`;
-}[AppPermissionNonNullablePaths]>>;
-export interface ListAppPermissionsOptions {
-    /**
-     * Whether to retrieve the most recent permissions information. This decreases performance but ensures the information retrieved is up-to-date even immediately after an update.
+interface AppPermissionDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface ListAppPermissionsOptions {
+    /**
+     * Whether to retrieve the most recent permissions information. This decreases performance but ensures that the retrieved information is up-to-date, even immediately after an update.
      *
      * Default: `false`
      */
@@ -416,31 +378,5 @@ export interface ListAppPermissionsOptions {
     /** Paging configuration. */
     paging?: CursorPaging;
 }
-/**
- * Deletes the specified app permission.
- * @param appId - [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
- *
- * You can find the app ID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard.
- * @public
- * @documentationMaturity preview
- * @requiredField appId
- * @requiredField options
- * @requiredField options.permissionId
- * @permissionId DEV_CENTER.DELETE_APP_PERMISSION
- * @permissionScope Write Dev Center App Permissions
- * @permissionScopeId SCOPE.DEV_CENTER.WRITE_PERMISSIONS
- * @applicableIdentity APP
- * @fqn wix.devcenter.apps.permissions.v1.AppPermissionsService.DeleteAppPermission
- */
-export declare function deleteAppPermission(appId: string, options: NonNullablePaths<DeleteAppPermissionOptions, `permissionId`>): Promise<void>;
-export interface DeleteAppPermissionOptions {
-    /**
-     * Permission ID.
-     *
-     * To find the permission ID, visit the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app#step-1--identify-required-permissions).
-     * @minLength 1
-     * @maxLength 164
-     */
-    permissionId: string;
-}
-export {};
+
+export { type AppPermission as A, type BaseEventMetadata as B, type CreateAppPermissionRequest as C, type DeleteAppPermissionRequest as D, type EntityCreatedEvent as E, type GetAppPermissionRequest as G, type IdentificationData as I, type ListAppPermissionsOptions as L, type MessageEnvelope as M, type OldPermissionChangedEvent as O, type PermissionActionDomainEventEntity as P, type RestoreInfo as R, type V1Permission as V, WebhookIdentityType as W, type ListAppPermissionsResponse as a, ActionType as b, Action as c, type CreateAppPermissionResponse as d, type GetAppPermissionResponse as e, type ListAppPermissionsRequest as f, type CursorPaging as g, type CursorPagingMetadata as h, type Cursors as i, type DeleteAppPermissionResponse as j, type DomainEvent as k, type DomainEventBodyOneOf as l, type EntityUpdatedEvent as m, type EntityDeletedEvent as n, type ActionEvent as o, type Empty as p, type Permission as q, type IdentificationDataIdOneOf as r, type EventMetadata as s, type AppPermissionCreatedEnvelope as t, type AppPermissionDeletedEnvelope as u };