@wix/auto_sdk_multilingual_translation-schemas 1.0.12 → 1.0.14

package/build/index.d.mts

@@ -0,0 +1,116 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } 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 } from './multilingual-translation-v1-schema-translation-schemas.universal-NgJpHCdB.mjs';
+export { ab as ActionEvent, B as Asset, af as BaseEventMetadata, C as CreateSchemaRequest, j as CreateSchemaResponse, v as CursorPaging, x as CursorPagingMetadata, s as CursorQuery, t as CursorQueryPagingMethodOneOf, y as Cursors, J as DeleteContext, p as DeleteSchemaRequest, q as DeleteSchemaResponse, D as DeleteStatus, a5 as DomainEvent, a6 as DomainEventBodyOneOf, a4 as Empty, a7 as EntityCreatedEvent, aa as EntityDeletedEvent, a9 as EntityUpdatedEvent, ag as EventMetadata, F as FieldType, m as GetSchemaByKeyRequest, k as GetSchemaRequest, l as GetSchemaResponse, ad as IdentificationData, ae as IdentificationDataIdOneOf, z as ListSiteSchemasRequest, ac as MessageEnvelope, M as MetaSiteSpecialEvent, A as MetaSiteSpecialEventPayloadOneOf, N as Namespace, $ as NamespaceChanged, P as PreviewFields, r as QuerySchemasRequest, w as QuerySchemasResponse, a8 as RestoreInfo, ah as SchemaCreatedEnvelope, ai as SchemaDeletedEnvelope, i as SchemaField, h as SchemaKey, d as SchemaScope, aj as SchemaUpdatedEnvelope, ak as SchemasQueryResult, X as ServiceProvisioned, Y as ServiceRemoved, E as SiteCreated, g as SiteCreatedContext, I as SiteDeleted, _ as SiteHardDeleted, T as SiteMarkedAsTemplate, V as SiteMarkedAsWixSite, O as SitePublished, a3 as SitePurgedExternally, Z as SiteRenamed, H as SiteTransferred, K as SiteUndeleted, R as SiteUnpublished, a2 as SiteUrlChanged, e as SortOrder, u as Sorting, f as State, a0 as StudioAssigned, a1 as StudioUnassigned, n as UpdateSchemaRequest, o as UpdateSchemaResponse, W as WebhookIdentityType } from './multilingual-translation-v1-schema-translation-schemas.universal-NgJpHCdB.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+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 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: ReturnType<typeof createEventModule<typeof publicOnSchemaCreated>>;
+/**
+ * Triggered when translation schema is deleted.
+ */
+declare const onSchemaDeleted: ReturnType<typeof createEventModule<typeof publicOnSchemaDeleted>>;
+/**
+ * Triggered when translation schema is updated.
+ */
+declare const onSchemaUpdated: ReturnType<typeof createEventModule<typeof publicOnSchemaUpdated>>;
+
+export { GetSchemaByKeyIdentifiers, GetSchemaByKeyResponse, ListSiteSchemasOptions, ListSiteSchemasResponse, QuerySchemasOptions, Schema, SchemasQueryBuilder, UpdateSchema, createSchema, deleteSchema, getSchema, getSchemaByKey, listSiteSchemas, onSchemaCreated, onSchemaDeleted, onSchemaUpdated, querySchemas, updateSchema };

package/build/index.d.ts

@@ -0,0 +1,116 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } 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 } from './multilingual-translation-v1-schema-translation-schemas.universal-NgJpHCdB.js';
+export { ab as ActionEvent, B as Asset, af as BaseEventMetadata, C as CreateSchemaRequest, j as CreateSchemaResponse, v as CursorPaging, x as CursorPagingMetadata, s as CursorQuery, t as CursorQueryPagingMethodOneOf, y as Cursors, J as DeleteContext, p as DeleteSchemaRequest, q as DeleteSchemaResponse, D as DeleteStatus, a5 as DomainEvent, a6 as DomainEventBodyOneOf, a4 as Empty, a7 as EntityCreatedEvent, aa as EntityDeletedEvent, a9 as EntityUpdatedEvent, ag as EventMetadata, F as FieldType, m as GetSchemaByKeyRequest, k as GetSchemaRequest, l as GetSchemaResponse, ad as IdentificationData, ae as IdentificationDataIdOneOf, z as ListSiteSchemasRequest, ac as MessageEnvelope, M as MetaSiteSpecialEvent, A as MetaSiteSpecialEventPayloadOneOf, N as Namespace, $ as NamespaceChanged, P as PreviewFields, r as QuerySchemasRequest, w as QuerySchemasResponse, a8 as RestoreInfo, ah as SchemaCreatedEnvelope, ai as SchemaDeletedEnvelope, i as SchemaField, h as SchemaKey, d as SchemaScope, aj as SchemaUpdatedEnvelope, ak as SchemasQueryResult, X as ServiceProvisioned, Y as ServiceRemoved, E as SiteCreated, g as SiteCreatedContext, I as SiteDeleted, _ as SiteHardDeleted, T as SiteMarkedAsTemplate, V as SiteMarkedAsWixSite, O as SitePublished, a3 as SitePurgedExternally, Z as SiteRenamed, H as SiteTransferred, K as SiteUndeleted, R as SiteUnpublished, a2 as SiteUrlChanged, e as SortOrder, u as Sorting, f as State, a0 as StudioAssigned, a1 as StudioUnassigned, n as UpdateSchemaRequest, o as UpdateSchemaResponse, W as WebhookIdentityType } from './multilingual-translation-v1-schema-translation-schemas.universal-NgJpHCdB.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+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 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: ReturnType<typeof createEventModule<typeof publicOnSchemaCreated>>;
+/**
+ * Triggered when translation schema is deleted.
+ */
+declare const onSchemaDeleted: ReturnType<typeof createEventModule<typeof publicOnSchemaDeleted>>;
+/**
+ * Triggered when translation schema is updated.
+ */
+declare const onSchemaUpdated: ReturnType<typeof createEventModule<typeof publicOnSchemaUpdated>>;
+
+export { GetSchemaByKeyIdentifiers, GetSchemaByKeyResponse, ListSiteSchemasOptions, ListSiteSchemasResponse, QuerySchemasOptions, Schema, SchemasQueryBuilder, UpdateSchema, createSchema, deleteSchema, getSchema, getSchemaByKey, listSiteSchemas, onSchemaCreated, onSchemaDeleted, onSchemaUpdated, querySchemas, updateSchema };