@wix/auto_sdk_multilingual_translation-schemas 1.0.28 → 1.0.29

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { S as Schema, G as GetSchemaByKeyIdentifiers, a as GetSchemaByKeyResponse, U as UpdateSchema, b as SchemasQueryBuilder, L as ListSiteSchemasOptions, c as ListSiteSchemasResponse, d as SchemaCreatedEnvelope, e as SchemaDeletedEnvelope, f as SchemaUpdatedEnvelope } from './multilingual-translation-v1-schema-translation-schemas.universal-9n5YslSa.js';
-export { ah as ActionEvent, H as Asset, al as BaseEventMetadata, C as CreateSchemaRequest, m as CreateSchemaResponse, x as CursorPaging, z as CursorPagingMetadata, u as CursorQuery, v as CursorQueryPagingMethodOneOf, A as Cursors, O as DeleteContext, s as DeleteSchemaRequest, t as DeleteSchemaResponse, D as DeleteStatus, ab as DomainEvent, ac as DomainEventBodyOneOf, aa as Empty, ad as EntityCreatedEvent, ag as EntityDeletedEvent, af as EntityUpdatedEvent, am as EventMetadata, F as FieldType, p as GetSchemaByKeyRequest, n as GetSchemaRequest, o as GetSchemaResponse, aj as IdentificationData, ak as IdentificationDataIdOneOf, B as ListSiteSchemasRequest, ai as MessageEnvelope, M as MetaSiteSpecialEvent, E as MetaSiteSpecialEventPayloadOneOf, N as Namespace, a1 as NamespaceChanged, a6 as OdeditorAssigned, a7 as OdeditorUnassigned, a8 as PicassoAssigned, a9 as PicassoUnassigned, P as PreviewFields, Q as QuerySchemasRequest, y as QuerySchemasResponse, ae as RestoreInfo, l as SchemaField, k as SchemaKey, g as SchemaScope, an as SchemasQueryResult, Z as ServiceProvisioned, _ as ServiceRemoved, I as SiteCreated, j as SiteCreatedContext, K as SiteDeleted, a0 as SiteHardDeleted, X as SiteMarkedAsTemplate, Y as SiteMarkedAsWixSite, T as SitePublished, a5 as SitePurgedExternally, $ as SiteRenamed, J as SiteTransferred, R as SiteUndeleted, V as SiteUnpublished, a4 as SiteUrlChanged, h as SortOrder, w as Sorting, i as State, a2 as StudioAssigned, a3 as StudioUnassigned, q as UpdateSchemaRequest, r as UpdateSchemaResponse, W as WebhookIdentityType } from './multilingual-translation-v1-schema-translation-schemas.universal-9n5YslSa.js';
+import { Schema, GetSchemaByKeyIdentifiers, GetSchemaByKeyResponse, UpdateSchema, SchemasQueryBuilder, ListSiteSchemasOptions, ListSiteSchemasResponse, SchemaCreatedEnvelope, SchemaDeletedEnvelope, SchemaUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, Asset, BaseEventMetadata, CreateSchemaRequest, CreateSchemaResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteContext, DeleteSchemaRequest, DeleteSchemaResponse, DeleteStatus, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, FieldType, GetSchemaByKeyRequest, GetSchemaRequest, GetSchemaResponse, IdentificationData, IdentificationDataIdOneOf, ListSiteSchemasRequest, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, OdeditorAssigned, OdeditorUnassigned, PicassoAssigned, PicassoUnassigned, PreviewFields, QuerySchemasRequest, QuerySchemasResponse, RestoreInfo, SchemaField, SchemaKey, SchemaScope, SchemasQueryResult, ServiceProvisioned, ServiceRemoved, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, Sorting, State, StudioAssigned, StudioUnassigned, UpdateSchemaRequest, UpdateSchemaResponse, WebhookIdentityType } from './index.typings.js';
 
 declare function createSchema$1(httpClient: HttpClient): CreateSchemaSignature;
 interface CreateSchemaSignature {

package/build/cjs/{multilingual-translation-v1-schema-translation-schemas.universal-9n5YslSa.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Schema {
     /**
      * Translation schema ID.
@@ -970,13 +972,84 @@ interface SchemaCreatedEnvelope {
     entity: Schema;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when translation schema is created.
+ * @permissionScope Wix Multilingual - Translation Schema Read
+ * @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION
+ * @webhook
+ * @eventType wix.multilingual.translation.v1.schema_created
+ * @slug created
+ */
+declare function onSchemaCreated(handler: (event: SchemaCreatedEnvelope) => void | Promise<void>): void;
 interface SchemaDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * Triggered when translation schema is deleted.
+ * @permissionScope Wix Multilingual - Translation Schema Read
+ * @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION
+ * @webhook
+ * @eventType wix.multilingual.translation.v1.schema_deleted
+ * @slug deleted
+ */
+declare function onSchemaDeleted(handler: (event: SchemaDeletedEnvelope) => void | Promise<void>): void;
 interface SchemaUpdatedEnvelope {
     entity: Schema;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when translation schema is updated.
+ * @permissionScope Wix Multilingual - Translation Schema Read
+ * @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_SCHEMA
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION
+ * @webhook
+ * @eventType wix.multilingual.translation.v1.schema_updated
+ * @slug updated
+ */
+declare function onSchemaUpdated(handler: (event: SchemaUpdatedEnvelope) => void | Promise<void>): void;
+type SchemaNonNullablePaths = `key.appId` | `key.entityType` | `key.scope`;
+/**
+ * Creates a translation schema.
+ * @param schema - Translation schema to create.
+ * @public
+ * @requiredField schema
+ * @requiredField schema.fields
+ * @requiredField schema.key
+ * @requiredField schema.key.entityType
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_CREATE_ORGANIZATION
+ * @applicableIdentity APP
+ * @returns Newly created translation schema.
+ * @fqn wix.multilingual.translation.schema.v1.TranslationSchema.CreateSchema
+ */
+declare function createSchema(schema: NonNullablePaths<Schema, `fields` | `key` | `key.entityType`>): Promise<NonNullablePaths<Schema, SchemaNonNullablePaths>>;
+/**
+ * Retrieves a translation schema by ID.
+ * @param schemaId - ID of the translation schema to retrieve.
+ * @public
+ * @requiredField schemaId
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION
+ * @applicableIdentity APP
+ * @returns The requested translation schema.
+ * @fqn wix.multilingual.translation.schema.v1.TranslationSchema.GetSchema
+ */
+declare function getSchema(schemaId: string): Promise<NonNullablePaths<Schema, SchemaNonNullablePaths>>;
+/**
+ * Retrieves a translation schema by key.
+ * @public
+ * @requiredField identifiers
+ * @requiredField identifiers.keyAppId
+ * @requiredField identifiers.keyEntityType
+ * @requiredField identifiers.keyScope
+ * @requiredField key
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION
+ * @applicableIdentity APP
+ * @fqn wix.multilingual.translation.schema.v1.TranslationSchema.GetSchemaByKey
+ */
+declare function getSchemaByKey(identifiers: NonNullablePaths<GetSchemaByKeyIdentifiers, `keyAppId` | `keyEntityType` | `keyScope`>): Promise<NonNullablePaths<GetSchemaByKeyResponse, {
+    [P in SchemaNonNullablePaths]: `schema.${P}`;
+}[SchemaNonNullablePaths]>>;
 interface GetSchemaByKeyIdentifiers {
     /**
      * ID of the app that created the schema.
@@ -1000,6 +1073,35 @@ interface GetSchemaByKeyIdentifiers {
      */
     keyScope?: SchemaScopeWithLiterals;
 }
+/**
+ * Updates a translation schema.
+ *
+ * To remove a field, pass the field key with an empty object as the value. For example:
+ *
+ * ```json
+ * {
+ * "fields": {
+ * "title": {}
+ * }
+ * }
+ * ```
+ *
+ * <blockquote class="caution">
+ * <strong>Caution:</strong>
+ *
+ * Removing a schema field makes the corresponding content field unavailable.
+ * </blockquote>
+ * @param _id - Translation schema ID.
+ * @public
+ * @requiredField _id
+ * @requiredField schema
+ * @requiredField schema.revision
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_UPDATE_ORGANIZATION
+ * @applicableIdentity APP
+ * @returns Updated Schema.
+ * @fqn wix.multilingual.translation.schema.v1.TranslationSchema.UpdateSchema
+ */
+declare function updateSchema(_id: string, schema: NonNullablePaths<UpdateSchema, `revision`>): Promise<NonNullablePaths<Schema, SchemaNonNullablePaths>>;
 interface UpdateSchema {
     /**
      * Translation schema ID.
@@ -1055,6 +1157,41 @@ interface UpdateSchema {
      */
     duplicateContent?: boolean | null;
 }
+/**
+ * Deletes a translation schema.
+ * @param schemaId - ID of the translation schema to delete.
+ * @public
+ * @requiredField schemaId
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_DELETE_ORGANIZATION
+ * @applicableIdentity APP
+ * @fqn wix.multilingual.translation.schema.v1.TranslationSchema.DeleteSchema
+ */
+declare function deleteSchema(schemaId: string): Promise<void>;
+/**
+ * Creates a query to retrieve a list of schemas.
+ *
+ * > **Note:**
+ * >
+ * > This method can retrieve all schemas with a `GLOBAL` scope and schemas with a `SITE` scope for the site the API request is authorized to access.
+ *
+ * The `querySchemas()` function builds a query to retrieve a list of translation schemas and returns a `SchemasQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/schemas-query-builder/find) function.
+ *
+ * You can refine the query by chaining `SchemasQueryBuilder` functions onto the query. `SchemasQueryBuilder` functions enable you to filter, sort, and control the results that `querySchemas()` returns.
+ *
+ * `querySchemas()` runs with the following `SchemasQueryBuilder` defaults which you can override:
+ *
+ * + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/schemas-query-builder/limit)
+ * + [`ascending('_id')`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/schemas-query-builder/ascending)
+ *
+ * The following `SchemasQueryBuilder` functions are supported for `querySchemas()`. For a full description of the operations object, see the object returned for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-schema/schemas-query-result/items) property in `SchemasQueryResult`.
+ * @public
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_READ_ORGANIZATION
+ * @applicableIdentity APP
+ * @fqn wix.multilingual.translation.schema.v1.TranslationSchema.QuerySchemas
+ */
+declare function querySchemas(): SchemasQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -1113,6 +1250,16 @@ interface SchemasQueryBuilder {
     skipTo: (cursor: string) => SchemasQueryBuilder;
     find: () => Promise<SchemasQueryResult>;
 }
+/**
+ * Retrieves a list of all translation schemas associated with a site, regardless of which app created them.
+ * @public
+ * @permissionId WIX_MULTILINGUAL.SCHEMA_READ
+ * @applicableIdentity APP
+ * @fqn wix.multilingual.translation.schema.v1.TranslationSchema.ListSiteSchemas
+ */
+declare function listSiteSchemas(options?: ListSiteSchemasOptions): Promise<NonNullablePaths<ListSiteSchemasResponse, {
+    [P in SchemaNonNullablePaths]: `schemas.${number}.${P}`;
+}[SchemaNonNullablePaths]>>;
 interface ListSiteSchemasOptions {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     paging?: CursorPaging;
@@ -1136,4 +1283,4 @@ interface ListSiteSchemasOptions {
     scope?: SchemaScopeWithLiterals;
 }
 
-export { type SiteRenamed as $, type Cursors as A, type ListSiteSchemasRequest as B, type CreateSchemaRequest as C, DeleteStatus as D, type MetaSiteSpecialEventPayloadOneOf as E, FieldType as F, type GetSchemaByKeyIdentifiers as G, type Asset as H, type SiteCreated as I, type SiteTransferred as J, type SiteDeleted as K, type ListSiteSchemasOptions as L, type MetaSiteSpecialEvent as M, Namespace as N, type DeleteContext as O, type PreviewFields as P, type QuerySchemasRequest as Q, type SiteUndeleted as R, type Schema as S, type SitePublished as T, type UpdateSchema as U, type SiteUnpublished as V, WebhookIdentityType as W, type SiteMarkedAsTemplate as X, type SiteMarkedAsWixSite as Y, type ServiceProvisioned as Z, type ServiceRemoved as _, type GetSchemaByKeyResponse as a, type SiteHardDeleted as a0, type NamespaceChanged as a1, type StudioAssigned as a2, type StudioUnassigned as a3, type SiteUrlChanged as a4, type SitePurgedExternally as a5, type OdeditorAssigned as a6, type OdeditorUnassigned as a7, type PicassoAssigned as a8, type PicassoUnassigned as a9, type Empty as aa, type DomainEvent as ab, type DomainEventBodyOneOf as ac, type EntityCreatedEvent as ad, type RestoreInfo as ae, type EntityUpdatedEvent as af, type EntityDeletedEvent as ag, type ActionEvent as ah, type MessageEnvelope as ai, type IdentificationData as aj, type IdentificationDataIdOneOf as ak, type BaseEventMetadata as al, type EventMetadata as am, type SchemasQueryResult as an, type SchemasQueryBuilder as b, type ListSiteSchemasResponse as c, type SchemaCreatedEnvelope as d, type SchemaDeletedEnvelope as e, type SchemaUpdatedEnvelope as f, SchemaScope as g, SortOrder as h, State as i, SiteCreatedContext as j, type SchemaKey as k, type SchemaField as l, type CreateSchemaResponse as m, type GetSchemaRequest as n, type GetSchemaResponse as o, type GetSchemaByKeyRequest as p, type UpdateSchemaRequest as q, type UpdateSchemaResponse as r, type DeleteSchemaRequest as s, type DeleteSchemaResponse as t, type CursorQuery as u, type CursorQueryPagingMethodOneOf as v, type Sorting as w, type CursorPaging as x, type QuerySchemasResponse as y, type CursorPagingMetadata as z };
+export { type ActionEvent, type Asset, type BaseEventMetadata, type CreateSchemaRequest, type CreateSchemaResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteContext, type DeleteSchemaRequest, type DeleteSchemaResponse, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, FieldType, type FieldTypeWithLiterals, type GetSchemaByKeyIdentifiers, type GetSchemaByKeyRequest, type GetSchemaByKeyResponse, type GetSchemaRequest, type GetSchemaResponse, type IdentificationData, type IdentificationDataIdOneOf, type ListSiteSchemasOptions, type ListSiteSchemasRequest, type ListSiteSchemasResponse, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PicassoAssigned, type PicassoUnassigned, type PreviewFields, type QuerySchemasRequest, type QuerySchemasResponse, type RestoreInfo, type Schema, type SchemaCreatedEnvelope, type SchemaDeletedEnvelope, type SchemaField, type SchemaKey, SchemaScope, type SchemaScopeWithLiterals, type SchemaUpdatedEnvelope, type SchemasQueryBuilder, type SchemasQueryResult, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioUnassigned, type UpdateSchema, type UpdateSchemaRequest, type UpdateSchemaResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createSchema, deleteSchema, getSchema, getSchemaByKey, listSiteSchemas, onSchemaCreated, onSchemaDeleted, onSchemaUpdated, querySchemas, updateSchema };