@wix/auto_sdk_app-management_app-permissions 1.0.0

package/build/cjs/src/devcenter-apps-v1-app-permission-app-permissions.types.d.ts

@@ -0,0 +1,306 @@
+/** AppPermission is the main entity of AppPermissionsService that define relation between app and permission */
+export interface AppPermission {
+    /**
+     * App ID
+     * @format GUID
+     */
+    appId?: string;
+    /** Permission object */
+    permission?: V1Permission;
+    /**
+     * Represents the time this AppPermission was created
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Represents the time this AppPermission was updated
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+export interface V1Permission {
+    /**
+     * Permission ID
+     * @minLength 1
+     * @maxLength 164
+     */
+    permissionId?: string;
+}
+export interface CreateAppPermissionRequest {
+    /** AppPermission to be created */
+    appPermission: AppPermission;
+}
+export interface CreateAppPermissionResponse {
+    /** The created AppPermission */
+    appPermission?: AppPermission;
+}
+export interface GetAppPermissionRequest {
+    /**
+     * App ID
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Permission ID
+     * @minLength 1
+     * @maxLength 164
+     */
+    permissionId?: string;
+}
+export interface GetAppPermissionResponse {
+    /** The retrieved AppPermission */
+    appPermission?: AppPermission;
+}
+export interface ListAppPermissionsRequest {
+    /**
+     * App ID
+     * @format GUID
+     */
+    appId: string;
+    /** Fetch consistent data */
+    consistent?: boolean;
+    /** Paging */
+    paging?: CursorPaging;
+}
+export interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+export interface ListAppPermissionsResponse {
+    /** AppPermissions list */
+    appPermissions?: AppPermission[];
+    /** Paging */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+export interface DeleteAppPermissionRequest {
+    /**
+     * App ID
+     * @format GUID
+     */
+    appId: string;
+    /**
+     * Permission ID
+     * @minLength 1
+     * @maxLength 164
+     */
+    permissionId: string;
+}
+export interface DeleteAppPermissionResponse {
+}
+export interface PermissionActionDomainEventEntity {
+    /** The permission that had an event */
+    appPermission?: AppPermission;
+    /** The action which happened */
+    actionType?: ActionType;
+}
+export declare enum ActionType {
+    APP_PERMISSION_DELETED = "APP_PERMISSION_DELETED"
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface Empty {
+}
+export interface OldPermissionChangedEvent {
+    /** @format GUID */
+    appId?: string;
+    permission?: Permission;
+    action?: Action;
+}
+export interface Permission {
+    permissionId?: string;
+}
+export declare enum Action {
+    CREATED = "CREATED",
+    UPDATED = "UPDATED",
+    DELETED = "DELETED"
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface V1PermissionNonNullableFields {
+    permissionId: string;
+}
+interface AppPermissionNonNullableFields {
+    appId: string;
+    permission?: V1PermissionNonNullableFields;
+}
+export interface CreateAppPermissionResponseNonNullableFields {
+    appPermission?: AppPermissionNonNullableFields;
+}
+export interface ListAppPermissionsResponseNonNullableFields {
+    appPermissions: AppPermissionNonNullableFields[];
+}
+export {};

package/build/cjs/src/devcenter-apps-v1-app-permission-app-permissions.types.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.Action = exports.ActionType = void 0;
+var ActionType;
+(function (ActionType) {
+    ActionType["APP_PERMISSION_DELETED"] = "APP_PERMISSION_DELETED";
+})(ActionType || (exports.ActionType = ActionType = {}));
+var Action;
+(function (Action) {
+    Action["CREATED"] = "CREATED";
+    Action["UPDATED"] = "UPDATED";
+    Action["DELETED"] = "DELETED";
+})(Action || (exports.Action = Action = {}));
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+//# sourceMappingURL=devcenter-apps-v1-app-permission-app-permissions.types.js.map

package/build/cjs/src/devcenter-apps-v1-app-permission-app-permissions.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devcenter-apps-v1-app-permission-app-permissions.types.js","sourceRoot":"","sources":["../../../src/devcenter-apps-v1-app-permission-app-permissions.types.ts"],"names":[],"mappings":";;;AAgJA,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,+DAAiD,CAAA;AACnD,CAAC,EAFW,UAAU,0BAAV,UAAU,QAErB;AA8FD,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;AACrB,CAAC,EAJW,MAAM,sBAAN,MAAM,QAIjB;AAoED,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}