@wix/auto_sdk_multilingual_translation-schemas 1.0.23 → 1.0.24

package/build/index.d.mts

@@ -0,0 +1,118 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { S as Schema, G as GetSchemaByKeyIdentifiers, a as GetSchemaByKeyResponse, U as UpdateSchema, Q as QuerySchemasOptions, 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-C2dk9sn4.mjs';
+export { ai as ActionEvent, I as Asset, am as BaseEventMetadata, C as CreateSchemaRequest, m as CreateSchemaResponse, y as CursorPaging, A as CursorPagingMetadata, v as CursorQuery, w as CursorQueryPagingMethodOneOf, B as Cursors, R as DeleteContext, s as DeleteSchemaRequest, t as DeleteSchemaResponse, D as DeleteStatus, ac as DomainEvent, ad as DomainEventBodyOneOf, ab as Empty, ae as EntityCreatedEvent, ah as EntityDeletedEvent, ag as EntityUpdatedEvent, an as EventMetadata, F as FieldType, p as GetSchemaByKeyRequest, n as GetSchemaRequest, o as GetSchemaResponse, ak as IdentificationData, al as IdentificationDataIdOneOf, E as ListSiteSchemasRequest, aj as MessageEnvelope, M as MetaSiteSpecialEvent, H as MetaSiteSpecialEventPayloadOneOf, N as Namespace, a2 as NamespaceChanged, a7 as OdeditorAssigned, a8 as OdeditorUnassigned, a9 as PicassoAssigned, aa as PicassoUnassigned, P as PreviewFields, u as QuerySchemasRequest, z as QuerySchemasResponse, af as RestoreInfo, l as SchemaField, k as SchemaKey, g as SchemaScope, ao as SchemasQueryResult, _ as ServiceProvisioned, $ as ServiceRemoved, J as SiteCreated, j as SiteCreatedContext, O as SiteDeleted, a1 as SiteHardDeleted, Y as SiteMarkedAsTemplate, Z as SiteMarkedAsWixSite, V as SitePublished, a6 as SitePurgedExternally, a0 as SiteRenamed, K as SiteTransferred, T as SiteUndeleted, X as SiteUnpublished, a5 as SiteUrlChanged, h as SortOrder, x as Sorting, i as State, a3 as StudioAssigned, a4 as StudioUnassigned, q as UpdateSchemaRequest, r as UpdateSchemaResponse, W as WebhookIdentityType } from './multilingual-translation-v1-schema-translation-schemas.universal-C2dk9sn4.mjs';
+
+declare function createSchema$1(httpClient: HttpClient): CreateSchemaSignature;
+interface CreateSchemaSignature {
+    /**
+     * Creates a translation schema.
+     * @param - Translation schema to create.
+     * @returns Newly created translation schema.
+     */
+    (schema: Schema): Promise<Schema>;
+}
+declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
+interface GetSchemaSignature {
+    /**
+     * Retrieves a translation schema by ID.
+     * @param - ID of the translation schema to retrieve.
+     * @returns The requested translation schema.
+     */
+    (schemaId: string): Promise<Schema>;
+}
+declare function getSchemaByKey$1(httpClient: HttpClient): GetSchemaByKeySignature;
+interface GetSchemaByKeySignature {
+    /**
+     * Retrieves a translation schema by key.
+     */
+    (identifiers: GetSchemaByKeyIdentifiers): Promise<GetSchemaByKeyResponse>;
+}
+declare function updateSchema$1(httpClient: HttpClient): UpdateSchemaSignature;
+interface UpdateSchemaSignature {
+    /**
+     * 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 - Translation schema ID.
+     * @returns Updated Schema.
+     */
+    (_id: string, schema: UpdateSchema): Promise<Schema>;
+}
+declare function deleteSchema$1(httpClient: HttpClient): DeleteSchemaSignature;
+interface DeleteSchemaSignature {
+    /**
+     * Deletes a translation schema.
+     * @param - ID of the translation schema to delete.
+     */
+    (schemaId: string): Promise<void>;
+}
+declare function querySchemas$1(httpClient: HttpClient): QuerySchemasSignature;
+interface QuerySchemasSignature {
+    /**
+     * 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`.
+     */
+    (options?: QuerySchemasOptions | undefined): SchemasQueryBuilder;
+}
+declare function listSiteSchemas$1(httpClient: HttpClient): ListSiteSchemasSignature;
+interface ListSiteSchemasSignature {
+    /**
+     * Retrieves a list of all translation schemas associated with a site, regardless of which app created them.
+     */
+    (options?: ListSiteSchemasOptions | undefined): Promise<ListSiteSchemasResponse>;
+}
+declare const onSchemaCreated$1: EventDefinition<SchemaCreatedEnvelope, "wix.multilingual.translation.v1.schema_created">;
+declare const onSchemaDeleted$1: EventDefinition<SchemaDeletedEnvelope, "wix.multilingual.translation.v1.schema_deleted">;
+declare const onSchemaUpdated$1: EventDefinition<SchemaUpdatedEnvelope, "wix.multilingual.translation.v1.schema_updated">;
+
+declare const createSchema: MaybeContext<BuildRESTFunction<typeof createSchema$1> & typeof createSchema$1>;
+declare const getSchema: MaybeContext<BuildRESTFunction<typeof getSchema$1> & typeof getSchema$1>;
+declare const getSchemaByKey: MaybeContext<BuildRESTFunction<typeof getSchemaByKey$1> & typeof getSchemaByKey$1>;
+declare const updateSchema: MaybeContext<BuildRESTFunction<typeof updateSchema$1> & typeof updateSchema$1>;
+declare const deleteSchema: MaybeContext<BuildRESTFunction<typeof deleteSchema$1> & typeof deleteSchema$1>;
+declare const querySchemas: MaybeContext<BuildRESTFunction<typeof querySchemas$1> & typeof querySchemas$1>;
+declare const listSiteSchemas: MaybeContext<BuildRESTFunction<typeof listSiteSchemas$1> & typeof listSiteSchemas$1>;
+/**
+ * Triggered when translation schema is created.
+ */
+declare const onSchemaCreated: BuildEventDefinition<typeof onSchemaCreated$1>;
+/**
+ * Triggered when translation schema is deleted.
+ */
+declare const onSchemaDeleted: BuildEventDefinition<typeof onSchemaDeleted$1>;
+/**
+ * Triggered when translation schema is updated.
+ */
+declare const onSchemaUpdated: BuildEventDefinition<typeof onSchemaUpdated$1>;
+
+export { GetSchemaByKeyIdentifiers, GetSchemaByKeyResponse, ListSiteSchemasOptions, ListSiteSchemasResponse, QuerySchemasOptions, Schema, SchemaCreatedEnvelope, SchemaDeletedEnvelope, SchemaUpdatedEnvelope, SchemasQueryBuilder, UpdateSchema, createSchema, deleteSchema, getSchema, getSchemaByKey, listSiteSchemas, onSchemaCreated, onSchemaDeleted, onSchemaUpdated, querySchemas, updateSchema };

package/build/index.d.ts

@@ -0,0 +1,118 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { S as Schema, G as GetSchemaByKeyIdentifiers, a as GetSchemaByKeyResponse, U as UpdateSchema, Q as QuerySchemasOptions, 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-C2dk9sn4.js';
+export { ai as ActionEvent, I as Asset, am as BaseEventMetadata, C as CreateSchemaRequest, m as CreateSchemaResponse, y as CursorPaging, A as CursorPagingMetadata, v as CursorQuery, w as CursorQueryPagingMethodOneOf, B as Cursors, R as DeleteContext, s as DeleteSchemaRequest, t as DeleteSchemaResponse, D as DeleteStatus, ac as DomainEvent, ad as DomainEventBodyOneOf, ab as Empty, ae as EntityCreatedEvent, ah as EntityDeletedEvent, ag as EntityUpdatedEvent, an as EventMetadata, F as FieldType, p as GetSchemaByKeyRequest, n as GetSchemaRequest, o as GetSchemaResponse, ak as IdentificationData, al as IdentificationDataIdOneOf, E as ListSiteSchemasRequest, aj as MessageEnvelope, M as MetaSiteSpecialEvent, H as MetaSiteSpecialEventPayloadOneOf, N as Namespace, a2 as NamespaceChanged, a7 as OdeditorAssigned, a8 as OdeditorUnassigned, a9 as PicassoAssigned, aa as PicassoUnassigned, P as PreviewFields, u as QuerySchemasRequest, z as QuerySchemasResponse, af as RestoreInfo, l as SchemaField, k as SchemaKey, g as SchemaScope, ao as SchemasQueryResult, _ as ServiceProvisioned, $ as ServiceRemoved, J as SiteCreated, j as SiteCreatedContext, O as SiteDeleted, a1 as SiteHardDeleted, Y as SiteMarkedAsTemplate, Z as SiteMarkedAsWixSite, V as SitePublished, a6 as SitePurgedExternally, a0 as SiteRenamed, K as SiteTransferred, T as SiteUndeleted, X as SiteUnpublished, a5 as SiteUrlChanged, h as SortOrder, x as Sorting, i as State, a3 as StudioAssigned, a4 as StudioUnassigned, q as UpdateSchemaRequest, r as UpdateSchemaResponse, W as WebhookIdentityType } from './multilingual-translation-v1-schema-translation-schemas.universal-C2dk9sn4.js';
+
+declare function createSchema$1(httpClient: HttpClient): CreateSchemaSignature;
+interface CreateSchemaSignature {
+    /**
+     * Creates a translation schema.
+     * @param - Translation schema to create.
+     * @returns Newly created translation schema.
+     */
+    (schema: Schema): Promise<Schema>;
+}
+declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
+interface GetSchemaSignature {
+    /**
+     * Retrieves a translation schema by ID.
+     * @param - ID of the translation schema to retrieve.
+     * @returns The requested translation schema.
+     */
+    (schemaId: string): Promise<Schema>;
+}
+declare function getSchemaByKey$1(httpClient: HttpClient): GetSchemaByKeySignature;
+interface GetSchemaByKeySignature {
+    /**
+     * Retrieves a translation schema by key.
+     */
+    (identifiers: GetSchemaByKeyIdentifiers): Promise<GetSchemaByKeyResponse>;
+}
+declare function updateSchema$1(httpClient: HttpClient): UpdateSchemaSignature;
+interface UpdateSchemaSignature {
+    /**
+     * 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 - Translation schema ID.
+     * @returns Updated Schema.
+     */
+    (_id: string, schema: UpdateSchema): Promise<Schema>;
+}
+declare function deleteSchema$1(httpClient: HttpClient): DeleteSchemaSignature;
+interface DeleteSchemaSignature {
+    /**
+     * Deletes a translation schema.
+     * @param - ID of the translation schema to delete.
+     */
+    (schemaId: string): Promise<void>;
+}
+declare function querySchemas$1(httpClient: HttpClient): QuerySchemasSignature;
+interface QuerySchemasSignature {
+    /**
+     * 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`.
+     */
+    (options?: QuerySchemasOptions | undefined): SchemasQueryBuilder;
+}
+declare function listSiteSchemas$1(httpClient: HttpClient): ListSiteSchemasSignature;
+interface ListSiteSchemasSignature {
+    /**
+     * Retrieves a list of all translation schemas associated with a site, regardless of which app created them.
+     */
+    (options?: ListSiteSchemasOptions | undefined): Promise<ListSiteSchemasResponse>;
+}
+declare const onSchemaCreated$1: EventDefinition<SchemaCreatedEnvelope, "wix.multilingual.translation.v1.schema_created">;
+declare const onSchemaDeleted$1: EventDefinition<SchemaDeletedEnvelope, "wix.multilingual.translation.v1.schema_deleted">;
+declare const onSchemaUpdated$1: EventDefinition<SchemaUpdatedEnvelope, "wix.multilingual.translation.v1.schema_updated">;
+
+declare const createSchema: MaybeContext<BuildRESTFunction<typeof createSchema$1> & typeof createSchema$1>;
+declare const getSchema: MaybeContext<BuildRESTFunction<typeof getSchema$1> & typeof getSchema$1>;
+declare const getSchemaByKey: MaybeContext<BuildRESTFunction<typeof getSchemaByKey$1> & typeof getSchemaByKey$1>;
+declare const updateSchema: MaybeContext<BuildRESTFunction<typeof updateSchema$1> & typeof updateSchema$1>;
+declare const deleteSchema: MaybeContext<BuildRESTFunction<typeof deleteSchema$1> & typeof deleteSchema$1>;
+declare const querySchemas: MaybeContext<BuildRESTFunction<typeof querySchemas$1> & typeof querySchemas$1>;
+declare const listSiteSchemas: MaybeContext<BuildRESTFunction<typeof listSiteSchemas$1> & typeof listSiteSchemas$1>;
+/**
+ * Triggered when translation schema is created.
+ */
+declare const onSchemaCreated: BuildEventDefinition<typeof onSchemaCreated$1>;
+/**
+ * Triggered when translation schema is deleted.
+ */
+declare const onSchemaDeleted: BuildEventDefinition<typeof onSchemaDeleted$1>;
+/**
+ * Triggered when translation schema is updated.
+ */
+declare const onSchemaUpdated: BuildEventDefinition<typeof onSchemaUpdated$1>;
+
+export { GetSchemaByKeyIdentifiers, GetSchemaByKeyResponse, ListSiteSchemasOptions, ListSiteSchemasResponse, QuerySchemasOptions, Schema, SchemaCreatedEnvelope, SchemaDeletedEnvelope, SchemaUpdatedEnvelope, SchemasQueryBuilder, UpdateSchema, createSchema, deleteSchema, getSchema, getSchemaByKey, listSiteSchemas, onSchemaCreated, onSchemaDeleted, onSchemaUpdated, querySchemas, updateSchema };