@wix/auto_sdk_multilingual_translation-schemas 1.0.0

package/build/internal/es/src/multilingual-translation-v1-schema-translation-schemas.public.d.ts

@@ -0,0 +1,98 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { GetSchemaByKeyIdentifiers, GetSchemaByKeyResponse, GetSchemaByKeyResponseNonNullableFields, ListSiteSchemasOptions, ListSiteSchemasResponse, ListSiteSchemasResponseNonNullableFields, QuerySchemasOptions, Schema, SchemaCreatedEnvelope, SchemaDeletedEnvelope, SchemaNonNullableFields, SchemaUpdatedEnvelope, SchemasQueryBuilder, UpdateSchema } from './multilingual-translation-v1-schema-translation-schemas.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function createSchema(httpClient: HttpClient): CreateSchemaSignature;
+interface CreateSchemaSignature {
+    /**
+     * Creates a translation schema.
+     * @param - Translation schema to create.
+     * @returns Newly created translation schema.
+     */
+    (schema: Schema): Promise<Schema & SchemaNonNullableFields>;
+}
+export declare function getSchema(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 & SchemaNonNullableFields>;
+}
+export declare function getSchemaByKey(httpClient: HttpClient): GetSchemaByKeySignature;
+interface GetSchemaByKeySignature {
+    /**
+     * Retrieves a translation schema by key.
+     */
+    (identifiers: GetSchemaByKeyIdentifiers): Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
+}
+export declare function updateSchema(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 | null, schema: UpdateSchema): Promise<Schema & SchemaNonNullableFields>;
+}
+export declare function deleteSchema(httpClient: HttpClient): DeleteSchemaSignature;
+interface DeleteSchemaSignature {
+    /**
+     * Deletes a translation schema.
+     * @param - ID of the translation schema to delete.
+     */
+    (schemaId: string): Promise<void>;
+}
+export declare function querySchemas(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;
+}
+export declare function listSiteSchemas(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 & ListSiteSchemasResponseNonNullableFields>;
+}
+export declare const onSchemaCreated: EventDefinition<SchemaCreatedEnvelope, "wix.multilingual.translation.v1.schema_created">;
+export declare const onSchemaDeleted: EventDefinition<SchemaDeletedEnvelope, "wix.multilingual.translation.v1.schema_deleted">;
+export declare const onSchemaUpdated: EventDefinition<SchemaUpdatedEnvelope, "wix.multilingual.translation.v1.schema_updated">;
+export { ActionEvent, Asset, BaseEventMetadata, CreateSchemaRequest, CreateSchemaResponse, CreateSchemaResponseNonNullableFields, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteContext, DeleteSchemaRequest, DeleteSchemaResponse, DeleteStatus, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, FieldType, GetSchemaByKeyIdentifiers, GetSchemaByKeyRequest, GetSchemaByKeyResponse, GetSchemaByKeyResponseNonNullableFields, GetSchemaRequest, GetSchemaResponse, GetSchemaResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, ListSiteSchemasOptions, ListSiteSchemasRequest, ListSiteSchemasResponse, ListSiteSchemasResponseNonNullableFields, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, PreviewFields, QuerySchemasOptions, QuerySchemasRequest, QuerySchemasResponse, QuerySchemasResponseNonNullableFields, RestoreInfo, Schema, SchemaCreatedEnvelope, SchemaDeletedEnvelope, SchemaField, SchemaKey, SchemaNonNullableFields, SchemaScope, SchemaUpdatedEnvelope, SchemasQueryBuilder, SchemasQueryResult, ServiceProvisioned, ServiceRemoved, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SortOrder, Sorting, State, StudioAssigned, StudioUnassigned, UpdateSchema, UpdateSchemaRequest, UpdateSchemaResponse, UpdateSchemaResponseNonNullableFields, WebhookIdentityType, } from './multilingual-translation-v1-schema-translation-schemas.universal.js';

package/build/internal/es/src/multilingual-translation-v1-schema-translation-schemas.public.js

@@ -0,0 +1,86 @@
+import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
+import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { EventDefinition } from '@wix/sdk-types';
+import { createSchema as universalCreateSchema, deleteSchema as universalDeleteSchema, getSchema as universalGetSchema, getSchemaByKey as universalGetSchemaByKey, listSiteSchemas as universalListSiteSchemas, querySchemas as universalQuerySchemas, updateSchema as universalUpdateSchema, } from './multilingual-translation-v1-schema-translation-schemas.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/multilingual' };
+export function createSchema(httpClient) {
+    return (schema) => universalCreateSchema(schema, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getSchema(httpClient) {
+    return (schemaId) => universalGetSchema(schemaId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getSchemaByKey(httpClient) {
+    return (identifiers) => universalGetSchemaByKey(identifiers, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updateSchema(httpClient) {
+    return (_id, schema) => universalUpdateSchema(_id, schema, 
+    // @ts-ignore
+    { httpClient });
+}
+export function deleteSchema(httpClient) {
+    return (schemaId) => universalDeleteSchema(schemaId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function querySchemas(httpClient) {
+    return (options) => universalQuerySchemas(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function listSiteSchemas(httpClient) {
+    return (options) => universalListSiteSchemas(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export const onSchemaCreated = EventDefinition('wix.multilingual.translation.v1.schema_created', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+    {
+        transformFn: transformRESTFloatToSDKFloat,
+        paths: [{ path: 'entity.fields.index' }],
+    },
+])))();
+export const onSchemaDeleted = EventDefinition('wix.multilingual.translation.v1.schema_deleted', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'undefined.createdDate' },
+            { path: 'undefined.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+    {
+        transformFn: transformRESTFloatToSDKFloat,
+        paths: [{ path: 'undefined.fields.index' }],
+    },
+])))();
+export const onSchemaUpdated = EventDefinition('wix.multilingual.translation.v1.schema_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+    {
+        transformFn: transformRESTFloatToSDKFloat,
+        paths: [{ path: 'entity.fields.index' }],
+    },
+])))();
+export { DeleteStatus, FieldType, Namespace, SchemaScope, SiteCreatedContext, SortOrder, State, WebhookIdentityType, } from './multilingual-translation-v1-schema-translation-schemas.universal.js';
+//# sourceMappingURL=multilingual-translation-v1-schema-translation-schemas.public.js.map

package/build/internal/es/src/multilingual-translation-v1-schema-translation-schemas.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multilingual-translation-v1-schema-translation-schemas.public.js","sourceRoot":"","sources":["../../../../src/multilingual-translation-v1-schema-translation-schemas.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAeL,YAAY,IAAI,qBAAqB,EACrC,YAAY,IAAI,qBAAqB,EACrC,SAAS,IAAI,kBAAkB,EAC/B,cAAc,IAAI,uBAAuB,EACzC,eAAe,IAAI,wBAAwB,EAC3C,YAAY,IAAI,qBAAqB,EACrC,YAAY,IAAI,qBAAqB,GACtC,MAAM,uEAAuE,CAAC;AAE/E,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,mBAAmB,EAAE,CAAC;AAEhE,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,MAAc,EAAE,EAAE,CACxB,qBAAqB,CACnB,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,QAAgB,EAAE,EAAE,CAC1B,kBAAkB,CAChB,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,WAAsC,EAAE,EAAE,CAChD,uBAAuB,CACrB,WAAW;IACX,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,GAAkB,EAAE,MAAoB,EAAE,EAAE,CAClD,qBAAqB,CACnB,GAAG,EACH,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AA6BD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,QAAgB,EAAE,EAAE,CAC1B,qBAAqB,CACnB,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,OAA6B,EAAE,EAAE,CACvC,qBAAqB,CACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AA0BD,MAAM,UAAU,eAAe,CAC7B,UAAsB;IAEtB,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,wBAAwB,CACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAC5C,gDAAgD,EAChD,IAAI,EACJ,CAAC,KAA4B,EAAE,EAAE,CAC/B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;KACzC;CACF,CAAC,CACH,CACJ,EAAyB,CAAC;AAC3B,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAC5C,gDAAgD,EAChD,IAAI,EACJ,CAAC,KAA4B,EAAE,EAAE,CAC/B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC;KAC5C;CACF,CAAC,CACH,CACJ,EAAyB,CAAC;AAC3B,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAC5C,gDAAgD,EAChD,IAAI,EACJ,CAAC,KAA4B,EAAE,EAAE,CAC/B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;KACzC;CACF,CAAC,CACH,CACJ,EAAyB,CAAC;AAE3B,OAAO,EAeL,YAAY,EAQZ,SAAS,EAiBT,SAAS,EAcT,WAAW,EAOX,kBAAkB,EAUlB,SAAS,EAET,KAAK,EAOL,mBAAmB,GACpB,MAAM,uEAAuE,CAAC"}