@wix/auth-management 1.0.12 → 1.0.14

package/build/cjs/src/headless-v1-o-auth-app.universal.d.ts

@@ -1,9 +1,4 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
+import { EventDefinition } from '@wix/sdk-types';
 /** An intermediary application that authorizes and authenticates an external client to access data on a Wix project or site. */
 export interface OAuthApp {
     /**
@@ -47,6 +42,8 @@ export interface OAuthApp {
      * Default: `true` until a secret has been generated for the OAuth App.
      */
     allowSecretGeneration?: boolean | null;
+    /** External logout URL to which we invoke when user logout at wix. If no logout URL is specified, the user is logged out only at Wix. */
+    logoutUrl?: string | null;
 }
 export interface CreateOAuthAppRequest {
     /** OAuth app to create. */
@@ -67,8 +64,6 @@ export interface GetOAuthAppResponse {
 export interface UpdateOAuthAppRequest {
     /** Updated OAuth app details. May include some or all fields. */
     oAuthApp: OAuthApp;
-    /** Explicit list of fields to update. Only fields listed are updated. */
-    mask: string[];
 }
 export interface UpdateOAuthAppResponse {
     /** Updated OAuth app info. */
@@ -128,13 +123,12 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Number of items to load. */
+    /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
-     * You can get the relevant cursor token
-     * from the `pagingMetadata` object in the previous call's response.
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
      */
     cursor?: string | null;
@@ -158,9 +152,9 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor pointing to next page in the list of results. */
+    /** Cursor string pointing to the next page in the list of results. */
     next?: string | null;
-    /** Cursor pointing to previous page in the list of results. */
+    /** Cursor pointing to the previous page in the list of results. */
     prev?: string | null;
 }
 export interface GenerateOAuthAppSecretRequest {
@@ -171,6 +165,352 @@ export interface GenerateOAuthAppSecretResponse {
     /** Secret generated. */
     oAuthAppSecret?: string;
 }
+export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+    /** A meta site id. */
+    metaSiteId?: string;
+    /** A meta site version. Monotonically increasing. */
+    version?: string;
+    /** A timestamp of the event. */
+    timestamp?: string;
+    /** A list of "assets" (applications). The same as MetaSiteContext. */
+    assets?: Asset[];
+}
+/** @oneof */
+export interface MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+}
+export interface Asset {
+    /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
+    appDefId?: string;
+    /** An instance id. For legacy reasons may be UUID or a string. */
+    instanceId?: string;
+    /** An application state. */
+    state?: State;
+}
+export declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+export interface SiteCreated {
+    /** A template identifier (empty if not created from a template). */
+    originTemplateId?: string;
+    /** An account id of the owner. */
+    ownerId?: string;
+    /** A context in which meta site was created. */
+    context?: SiteCreatedContext;
+    /**
+     * A meta site id from which this site was created.
+     *
+     * In case of a creation from a template it's a template id.
+     * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     */
+    originMetaSiteId?: string | null;
+    /** A meta site name (URL slug). */
+    siteName?: string;
+    /** A namespace. */
+    namespace?: Namespace;
+}
+export declare enum SiteCreatedContext {
+    /** A valid option, we don't expose all reasons why site might be created. */
+    OTHER = "OTHER",
+    /** A meta site was created from template. */
+    FROM_TEMPLATE = "FROM_TEMPLATE",
+    /** A meta site was created by copying of the transfferred meta site. */
+    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
+    /** A copy of existing meta site. */
+    DUPLICATE = "DUPLICATE",
+    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
+    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
+    /** deprecated A meta site was created for Flash editor. */
+    FLASH = "FLASH"
+}
+export declare enum Namespace {
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
+    WIX = "WIX",
+    /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    SHOUT_OUT = "SHOUT_OUT",
+    /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ALBUMS = "ALBUMS",
+    /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
+    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    HOTELS = "HOTELS",
+    /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    CLUBS = "CLUBS",
+    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
+    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_SITE = "DEV_SITE",
+    /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    LOGOS = "LOGOS",
+    /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    VIDEO_MAKER = "VIDEO_MAKER",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
+    /**
+     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
+     *
+     * Meta site with this namespace will *not* be shown in a user's site list by default.
+     */
+    HTML_DRAFT = "HTML_DRAFT",
+    /**
+     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
+     * Will be accessible from Site List and will not have a website app.
+     * Once the user attaches a site, the site will become a regular wixsite.
+     */
+    SITELESS_BUSINESS = "SITELESS_BUSINESS",
+    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
+    CREATOR_ECONOMY = "CREATOR_ECONOMY",
+    /** It is to be used in the Business First efforts. */
+    DASHBOARD_FIRST = "DASHBOARD_FIRST",
+    /** Bookings business flow with no site. */
+    ANYWHERE = "ANYWHERE",
+    /** Namespace for Headless Backoffice with no editor */
+    HEADLESS = "HEADLESS",
+    /**
+     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
+     * The site will be used for account level CSM feature for enterprise
+     */
+    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
+    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
+    RISE = "RISE",
+    /**
+     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
+     * There's a blank site behind the scene but it's blank).
+     * The Mobile company will be the owner of this namespace.
+     */
+    BRANDED_FIRST = "BRANDED_FIRST"
+}
+/** Site transferred to another user. */
+export interface SiteTransferred {
+    /** A previous owner id (user that transfers meta site). */
+    oldOwnerId?: string;
+    /** A new owner id (user that accepts meta site). */
+    newOwnerId?: string;
+}
+/** Soft deletion of the meta site. Could be restored. */
+export interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface DeleteContext {
+    /** When the meta site was deleted. */
+    dateDeleted?: Date;
+    /** A status. */
+    deleteStatus?: DeleteStatus;
+    /** A reason (flow). */
+    deleteOrigin?: string;
+    /** A service that deleted it. */
+    initiatorId?: string | null;
+}
+export declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE"
+}
+/** Restoration of the meta site. */
+export interface SiteUndeleted {
+}
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+export interface SitePublished {
+}
+export interface SiteUnpublished {
+    /** A list of URLs previously associated with the meta site. */
+    urls?: string[];
+}
+export interface SiteMarkedAsTemplate {
+}
+export interface SiteMarkedAsWixSite {
+}
+export interface ServiceProvisioned {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** An instance id from which this instance is originated. */
+    originInstanceId?: string;
+    /** A version. */
+    version?: string | null;
+}
+export interface ServiceRemoved {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** A version. */
+    version?: string | null;
+}
+/** Rename of the site. Meaning, free public url has been changed as well. */
+export interface SiteRenamed {
+    /** A new meta site name (URL slug). */
+    newSiteName?: string;
+    /** A previous meta site name (URL slug). */
+    oldSiteName?: string;
+}
+/**
+ * Hard deletion of the meta site.
+ *
+ * Could not be restored. Therefore it's desirable to cleanup data.
+ */
+export interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+export interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+export interface StudioUnassigned {
+}
+export interface Empty {
+}
+export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
+    createdEvent?: EntityCreatedEvent<T>;
+    updatedEvent?: EntityUpdatedEvent<T>;
+    deletedEvent?: EntityDeletedEvent<T>;
+    actionEvent?: ActionEvent<T>;
+    /**
+     * 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. */
+    eventTime?: Date;
+    /**
+     * 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;
+}
+export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
+}
+export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
+}
+export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
+}
+export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
+}
+/** @oneof */
+export interface DomainEventBodyOneOf<T> {
+    createdEvent?: EntityCreatedEvent<T>;
+    updatedEvent?: EntityUpdatedEvent<T>;
+    deletedEvent?: EntityDeletedEvent<T>;
+    actionEvent?: ActionEvent<T>;
+}
+export interface EntityCreatedEvent<T> {
+    entity?: T;
+}
+export interface EntityUpdatedEvent<T> {
+    /**
+     * 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.
+     */
+    currentEntity?: T;
+}
+export interface EntityDeletedEvent<T> {
+    /** Entity that was deleted */
+    deletedEntity?: T | null;
+}
+export interface ActionEvent<T> {
+    body?: T;
+}
 export interface CreateOAuthAppResponseNonNullableFields {
     oAuthApp?: {
         allowedRedirectUris: string[];
@@ -195,6 +535,9 @@ export interface QueryOAuthAppsResponseNonNullableFields {
         allowedRedirectDomains: string[];
     }[];
 }
+export declare const onOAuthAppCreated: EventDefinition<DomainCreatedEvent<OAuthApp>, "wix.headless.v1.o_auth_app_created">;
+export declare const onOAuthAppUpdated: EventDefinition<DomainUpdatedEvent<OAuthApp>, "wix.headless.v1.o_auth_app_updated">;
+export declare const onOAuthAppDeleted: EventDefinition<DomainDeletedEvent<OAuthApp>, "wix.headless.v1.o_auth_app_deleted">;
 /**
  * Creates a new OAuth app for a Wix Headless client.
  *
@@ -208,6 +551,7 @@ export interface QueryOAuthAppsResponseNonNullableFields {
  * @requiredField oAuthApp
  * @requiredField oAuthApp.name
  * @permissionScope Manage OAuth Apps
+ * @permissionScopeId SCOPE.OAUTH_APP.MANAGE
  * @applicableIdentity APP
  * @returns Created OAuth app info.
  */
@@ -219,7 +563,9 @@ export declare function createOAuthApp(oAuthApp: OAuthApp): Promise<OAuthApp & N
  * @documentationMaturity preview
  * @requiredField oAuthAppId
  * @permissionScope Manage OAuth Apps
+ * @permissionScopeId SCOPE.OAUTH_APP.MANAGE
  * @permissionScope Read OAuth Apps
+ * @permissionScopeId SCOPE.OAUTH_APP.READ
  * @applicableIdentity APP
  * @returns Retrieved OAuth app info.
  */
@@ -235,18 +581,18 @@ export declare function getOAuthApp(oAuthAppId: string): Promise<OAuthApp & NonN
  * + `description`
  * + `allowedDomain`
  * + `loginUrl`
+ * + `logoutUrl`
  * @param _id - ID of the OAuth app.
- * @param mask - Explicit list of fields to update. Only fields listed are updated.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
- * @requiredField mask
  * @requiredField oAuthApp
  * @permissionScope Manage OAuth Apps
+ * @permissionScopeId SCOPE.OAUTH_APP.MANAGE
  * @applicableIdentity APP
  * @returns Updated OAuth app info.
  */
-export declare function updateOAuthApp(_id: string | null, oAuthApp: UpdateOAuthApp, mask: string[]): Promise<OAuthApp & NonNullable<UpdateOAuthAppResponseNonNullableFields>['oAuthApp']>;
+export declare function updateOAuthApp(_id: string | null, oAuthApp: UpdateOAuthApp): Promise<OAuthApp & NonNullable<UpdateOAuthAppResponseNonNullableFields>['oAuthApp']>;
 export interface UpdateOAuthApp {
     /**
      * ID of the OAuth app.
@@ -289,6 +635,8 @@ export interface UpdateOAuthApp {
      * Default: `true` until a secret has been generated for the OAuth App.
      */
     allowSecretGeneration?: boolean | null;
+    /** External logout URL to which we invoke when user logout at wix. If no logout URL is specified, the user is logged out only at Wix. */
+    logoutUrl?: string | null;
 }
 /**
  * Retrieves a list of OAuth apps, given the provided paging, filtering, and sorting.
@@ -300,14 +648,16 @@ export interface UpdateOAuthApp {
  * @public
  * @documentationMaturity preview
  * @permissionScope Manage OAuth Apps
+ * @permissionScopeId SCOPE.OAUTH_APP.MANAGE
  * @permissionScope Read OAuth Apps
+ * @permissionScopeId SCOPE.OAUTH_APP.READ
  * @applicableIdentity APP
  */
 export declare function queryOAuthApps(): OAuthAppsQueryBuilder;
 interface QueryOffsetResult {
-    currentPage: number;
-    totalPages: number;
-    totalCount: number;
+    currentPage: number | undefined;
+    totalPages: number | undefined;
+    totalCount: number | undefined;
     hasNext: () => boolean;
     hasPrev: () => boolean;
     length: number;