@wix/auto_sdk_app-management_app-permissions 1.0.17 → 1.0.19

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

@@ -1,5 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface AppPermission {
+interface AppPermission {
     /**
      * App ID.
      *
@@ -24,7 +23,7 @@ export interface AppPermission {
      */
     _updatedDate?: Date | null;
 }
-export interface V1Permission {
+interface V1Permission {
     /**
      * Permission ID.
      *
@@ -34,15 +33,15 @@ export interface V1Permission {
      */
     permissionId?: string;
 }
-export interface CreateAppPermissionRequest {
+interface CreateAppPermissionRequest {
     /** Permission to add to the specified app. */
     appPermission: AppPermission;
 }
-export interface CreateAppPermissionResponse {
+interface CreateAppPermissionResponse {
     /** Details of permission that was added to the app. */
     appPermission?: AppPermission;
 }
-export interface GetAppPermissionRequest {
+interface GetAppPermissionRequest {
     /**
      * App ID.
      *
@@ -59,11 +58,11 @@ export interface GetAppPermissionRequest {
      */
     permissionId?: string;
 }
-export interface GetAppPermissionResponse {
+interface GetAppPermissionResponse {
     /** Details of the retrieved app permission. */
     appPermission?: AppPermission;
 }
-export interface ListAppPermissionsRequest {
+interface ListAppPermissionsRequest {
     /**
      * App ID.
      *
@@ -80,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
@@ -95,13 +94,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface ListAppPermissionsResponse {
+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. */
@@ -114,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
@@ -126,7 +125,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface DeleteAppPermissionRequest {
+interface DeleteAppPermissionRequest {
     /**
      * App ID.
      *
@@ -143,20 +142,20 @@ export interface DeleteAppPermissionRequest {
      */
     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?: ActionTypeWithLiterals;
 }
-export declare enum ActionType {
+declare enum ActionType {
     APP_PERMISSION_DELETED = "APP_PERMISSION_DELETED"
 }
 /** @enumType */
-export type ActionTypeWithLiterals = ActionType | 'APP_PERMISSION_DELETED';
-export interface DomainEvent extends DomainEventBodyOneOf {
+type ActionTypeWithLiterals = ActionType | 'APP_PERMISSION_DELETED';
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -191,19 +190,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.
@@ -211,32 +210,32 @@ 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?: ActionWithLiterals;
 }
-export interface Permission {
+interface Permission {
     permissionId?: string;
 }
-export declare enum Action {
+declare enum Action {
     CREATED = "CREATED",
     UPDATED = "UPDATED",
     DELETED = "DELETED"
 }
 /** @enumType */
-export type ActionWithLiterals = Action | 'CREATED' | 'UPDATED' | 'DELETED';
-export interface MessageEnvelope {
+type ActionWithLiterals = Action | 'CREATED' | 'UPDATED' | 'DELETED';
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -252,7 +251,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
@@ -277,7 +276,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -299,7 +298,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -307,8 +306,8 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface BaseEventMetadata {
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -322,7 +321,7 @@ export interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-export interface EventMetadata extends BaseEventMetadata {
+interface EventMetadata extends BaseEventMetadata {
     /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
@@ -352,68 +351,14 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface AppPermissionCreatedEnvelope {
+interface AppPermissionCreatedEnvelope {
     entity: AppPermission;
     metadata: EventMetadata;
 }
-/**
- * Triggered when a permission is added to an app.
- * @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;
-export interface AppPermissionDeletedEnvelope {
+interface AppPermissionDeletedEnvelope {
     metadata: EventMetadata;
 }
-/**
- * Triggered when a permission is deleted from an app.
- * @permissionId DEV_CENTER.READ_APP_PERMISSIONS
- * @webhook
- * @eventType wix.devcenter.apps.v1.app_permission_deleted
- * @slug deleted
- * @documentationMaturity preview
- */
-export declare function onAppPermissionDeleted(handler: (event: AppPermissionDeletedEnvelope) => void | Promise<void>): void;
-type AppPermissionNonNullablePaths = `appId` | `permission.permissionId`;
-/**
- * Adds a permission to the specified app.
- *
- * When users install your app on a site, it requests this permission.
- * @param appPermission - Permission to add to the specified app.
- * @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 permission that was added to the app.
- * @fqn wix.devcenter.apps.permissions.v1.AppPermissionsService.CreateAppPermission
- */
-export declare function createAppPermission(appPermission: NonNullablePaths<AppPermission, `appId` | `permission` | `permission.permissionId`>): Promise<NonNullablePaths<AppPermission, AppPermissionNonNullablePaths>>;
-/**
- * Lists all permissions for the specified app.
- *
- * These are the permissions your app requests when users install it on a site.
- * @param appId - 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 {
+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.
      *
@@ -423,25 +368,5 @@ export interface ListAppPermissionsOptions {
     /** Paging configuration. */
     paging?: CursorPaging;
 }
-/**
- * Deletes a permission from the specified app.
- *
- * After deleting a permission, your app no longer requests it when users install it on a site. As a result, the app can no longer make calls to APIs that require this permission.
- * @param appId - 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.
- * @param permissionId - Permission ID.
- *
- * 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).
- * @public
- * @documentationMaturity preview
- * @requiredField appId
- * @requiredField 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, permissionId: string): Promise<void>;
-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, type AppPermissionCreatedEnvelope as b, type AppPermissionDeletedEnvelope as c, ActionType as d, Action as e, type CreateAppPermissionResponse as f, type GetAppPermissionResponse as g, type ListAppPermissionsRequest as h, type CursorPaging as i, type CursorPagingMetadata as j, type Cursors as k, type DeleteAppPermissionResponse as l, type DomainEvent as m, type DomainEventBodyOneOf as n, type EntityUpdatedEvent as o, type EntityDeletedEvent as p, type ActionEvent as q, type Empty as r, type Permission as s, type IdentificationDataIdOneOf as t, type EventMetadata as u };

package/build/cjs/index.d.ts

@@ -1 +1,58 @@
-export * from './src/devcenter-apps-v1-app-permission-app-permissions.context.js';
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { A as AppPermission, L as ListAppPermissionsOptions, a as ListAppPermissionsResponse, b as AppPermissionCreatedEnvelope, c as AppPermissionDeletedEnvelope } from './devcenter-apps-v1-app-permission-app-permissions.universal-BrjAb5-h.js';
+export { e as Action, q as ActionEvent, d as ActionType, B as BaseEventMetadata, C as CreateAppPermissionRequest, f as CreateAppPermissionResponse, i as CursorPaging, j as CursorPagingMetadata, k as Cursors, D as DeleteAppPermissionRequest, l as DeleteAppPermissionResponse, m as DomainEvent, n as DomainEventBodyOneOf, r as Empty, E as EntityCreatedEvent, p as EntityDeletedEvent, o as EntityUpdatedEvent, u as EventMetadata, G as GetAppPermissionRequest, g as GetAppPermissionResponse, I as IdentificationData, t as IdentificationDataIdOneOf, h as ListAppPermissionsRequest, M as MessageEnvelope, O as OldPermissionChangedEvent, s as Permission, P as PermissionActionDomainEventEntity, R as RestoreInfo, V as V1Permission, W as WebhookIdentityType } from './devcenter-apps-v1-app-permission-app-permissions.universal-BrjAb5-h.js';
+
+declare function createAppPermission$1(httpClient: HttpClient): CreateAppPermissionSignature;
+interface CreateAppPermissionSignature {
+    /**
+     * Adds a permission to the specified app.
+     *
+     * When users install your app on a site, it requests this permission.
+     * @param - Permission to add to the specified app.
+     * @returns Details of permission that was added to the app.
+     */
+    (appPermission: AppPermission): Promise<AppPermission>;
+}
+declare function listAppPermissions$1(httpClient: HttpClient): ListAppPermissionsSignature;
+interface ListAppPermissionsSignature {
+    /**
+     * Lists all permissions for the specified app.
+     *
+     * These are the permissions your app requests when users install it on a site.
+     * @param - 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.
+     */
+    (appId: string, options?: ListAppPermissionsOptions | undefined): Promise<ListAppPermissionsResponse>;
+}
+declare function deleteAppPermission$1(httpClient: HttpClient): DeleteAppPermissionSignature;
+interface DeleteAppPermissionSignature {
+    /**
+     * Deletes a permission from the specified app.
+     *
+     * After deleting a permission, your app no longer requests it when users install it on a site. As a result, the app can no longer make calls to APIs that require this permission.
+     * @param - 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.
+     * @param - Permission ID.
+     *
+     * 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).
+     */
+    (appId: string, permissionId: string): Promise<void>;
+}
+declare const onAppPermissionCreated$1: EventDefinition<AppPermissionCreatedEnvelope, "wix.devcenter.apps.v1.app_permission_created">;
+declare const onAppPermissionDeleted$1: EventDefinition<AppPermissionDeletedEnvelope, "wix.devcenter.apps.v1.app_permission_deleted">;
+
+declare const createAppPermission: MaybeContext<BuildRESTFunction<typeof createAppPermission$1> & typeof createAppPermission$1>;
+declare const listAppPermissions: MaybeContext<BuildRESTFunction<typeof listAppPermissions$1> & typeof listAppPermissions$1>;
+declare const deleteAppPermission: MaybeContext<BuildRESTFunction<typeof deleteAppPermission$1> & typeof deleteAppPermission$1>;
+/**
+ * Triggered when a permission is added to an app.
+ */
+declare const onAppPermissionCreated: BuildEventDefinition<typeof onAppPermissionCreated$1>;
+/**
+ * Triggered when a permission is deleted from an app.
+ */
+declare const onAppPermissionDeleted: BuildEventDefinition<typeof onAppPermissionDeleted$1>;
+
+export { AppPermission, AppPermissionCreatedEnvelope, AppPermissionDeletedEnvelope, ListAppPermissionsOptions, ListAppPermissionsResponse, createAppPermission, deleteAppPermission, listAppPermissions, onAppPermissionCreated, onAppPermissionDeleted };