@wix/multilingual 1.0.42 → 1.0.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/multilingual",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.44",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
"@wix/multilingual_entity-mapper": "1.0.11",
|
|
22
22
|
"@wix/multilingual_machine-translation": "1.0.27",
|
|
23
23
|
"@wix/multilingual_site-translator": "1.0.12",
|
|
24
|
-
"@wix/multilingual_translation-contents": "1.0.
|
|
25
|
-
"@wix/multilingual_translation-published-contents": "1.0.
|
|
26
|
-
"@wix/multilingual_translation-schemas": "1.0.
|
|
24
|
+
"@wix/multilingual_translation-contents": "1.0.19",
|
|
25
|
+
"@wix/multilingual_translation-published-contents": "1.0.6",
|
|
26
|
+
"@wix/multilingual_translation-schemas": "1.0.17"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"glob": "^10.4.1",
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"fqdn": ""
|
|
49
49
|
}
|
|
50
50
|
},
|
|
51
|
-
"falconPackageHash": "
|
|
51
|
+
"falconPackageHash": "533cd9ace5f178277c466dc6a2609f40b8ccf608a488498a666f68f0"
|
|
52
52
|
}
|
|
@@ -532,7 +532,7 @@ interface PublishedContent {
|
|
|
532
532
|
/** Schema key of the published content. */
|
|
533
533
|
schemaKey?: SchemaKey$1;
|
|
534
534
|
/**
|
|
535
|
-
* A unique
|
|
535
|
+
* A unique identifier defined by the app developer to differentiate translation content for various entities within the site. For example, if an app developer is creating translation content for blog posts, the `entityId` can be `'blog-posts-1'`.
|
|
536
536
|
* @readonly
|
|
537
537
|
*/
|
|
538
538
|
entityId?: string;
|
|
@@ -572,15 +572,15 @@ declare enum SchemaScope$1 {
|
|
|
572
572
|
SITE = "SITE"
|
|
573
573
|
}
|
|
574
574
|
interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
575
|
-
/** Plain text
|
|
575
|
+
/** Plain text. */
|
|
576
576
|
textValue?: string;
|
|
577
|
-
/** Rich content
|
|
577
|
+
/** Rich content. */
|
|
578
578
|
richContent?: RichContent$2;
|
|
579
|
-
/**
|
|
579
|
+
/** Wix Media Manager image. */
|
|
580
580
|
image?: string;
|
|
581
|
-
/**
|
|
581
|
+
/** Wix Media Manager video. */
|
|
582
582
|
video?: string;
|
|
583
|
-
/**
|
|
583
|
+
/** Wix Media Manager document. */
|
|
584
584
|
document?: string;
|
|
585
585
|
/**
|
|
586
586
|
* Unique string identifier that links a specific content field to its corresponding field in the schema.
|
|
@@ -592,15 +592,15 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
|
592
592
|
}
|
|
593
593
|
/** @oneof */
|
|
594
594
|
interface PublishedContentFieldValueOneOf {
|
|
595
|
-
/** Plain text
|
|
595
|
+
/** Plain text. */
|
|
596
596
|
textValue?: string;
|
|
597
|
-
/** Rich content
|
|
597
|
+
/** Rich content. */
|
|
598
598
|
richContent?: RichContent$2;
|
|
599
|
-
/**
|
|
599
|
+
/** Wix Media Manager image. */
|
|
600
600
|
image?: string;
|
|
601
|
-
/**
|
|
601
|
+
/** Wix Media Manager video. */
|
|
602
602
|
video?: string;
|
|
603
|
-
/**
|
|
603
|
+
/** Wix Media Manager document. */
|
|
604
604
|
document?: string;
|
|
605
605
|
}
|
|
606
606
|
interface RichContent$2 {
|
|
@@ -2437,7 +2437,19 @@ interface PublishedContentQueryBuilder {
|
|
|
2437
2437
|
declare function queryPublishedContent$1(httpClient: HttpClient): QueryPublishedContentSignature;
|
|
2438
2438
|
interface QueryPublishedContentSignature {
|
|
2439
2439
|
/**
|
|
2440
|
-
*
|
|
2440
|
+
* Retrieves a list of published translation content given the provided paging, filtering, and sorting. Up to 100 published content items can be returned per request.
|
|
2441
|
+
*
|
|
2442
|
+
* The default `sort` is `id` in `ASC`.
|
|
2443
|
+
*
|
|
2444
|
+
* The following query filter fields are required:
|
|
2445
|
+
*
|
|
2446
|
+
* + `schemaKey.appId`
|
|
2447
|
+
* + `schemaKey.entityType`
|
|
2448
|
+
* + `schemaKey.scope`
|
|
2449
|
+
*
|
|
2450
|
+
* For additional field support for filters and sorting, see [Translation Published Content: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-published-content/sort-and-filter).
|
|
2451
|
+
*
|
|
2452
|
+
* To learn how to query translation consent items, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
2441
2453
|
*/
|
|
2442
2454
|
(): PublishedContentQueryBuilder;
|
|
2443
2455
|
}
|
|
@@ -2450,15 +2462,21 @@ declare function createEventModule$2<T extends EventDefinition<any, string>>(eve
|
|
|
2450
2462
|
declare const queryPublishedContent: BuildRESTFunction<typeof queryPublishedContent$1> & typeof queryPublishedContent$1;
|
|
2451
2463
|
|
|
2452
2464
|
type _publicOnPublishedContentCreatedType = typeof onPublishedContentCreated$1;
|
|
2453
|
-
/**
|
|
2465
|
+
/**
|
|
2466
|
+
* Triggered when published content is created.
|
|
2467
|
+
*/
|
|
2454
2468
|
declare const onPublishedContentCreated: ReturnType<typeof createEventModule$2<_publicOnPublishedContentCreatedType>>;
|
|
2455
2469
|
|
|
2456
2470
|
type _publicOnPublishedContentUpdatedType = typeof onPublishedContentUpdated$1;
|
|
2457
|
-
/**
|
|
2471
|
+
/**
|
|
2472
|
+
* Triggered when published content is updated.
|
|
2473
|
+
*/
|
|
2458
2474
|
declare const onPublishedContentUpdated: ReturnType<typeof createEventModule$2<_publicOnPublishedContentUpdatedType>>;
|
|
2459
2475
|
|
|
2460
2476
|
type _publicOnPublishedContentDeletedType = typeof onPublishedContentDeleted$1;
|
|
2461
|
-
/**
|
|
2477
|
+
/**
|
|
2478
|
+
* Triggered when published content is deleted.
|
|
2479
|
+
*/
|
|
2462
2480
|
declare const onPublishedContentDeleted: ReturnType<typeof createEventModule$2<_publicOnPublishedContentDeletedType>>;
|
|
2463
2481
|
|
|
2464
2482
|
type context$4_ExtendedFields = ExtendedFields;
|
|
@@ -4876,9 +4894,9 @@ interface Content {
|
|
|
4876
4894
|
_updatedDate?: Date;
|
|
4877
4895
|
}
|
|
4878
4896
|
interface ContentField extends ContentFieldValueOneOf {
|
|
4879
|
-
/**
|
|
4897
|
+
/** Plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
|
|
4880
4898
|
textValue?: string;
|
|
4881
|
-
/**
|
|
4899
|
+
/** Rich content. */
|
|
4882
4900
|
richContent?: RichContent;
|
|
4883
4901
|
/** Wix Media Manager image. */
|
|
4884
4902
|
image?: string;
|
|
@@ -4914,9 +4932,9 @@ interface ContentField extends ContentFieldValueOneOf {
|
|
|
4914
4932
|
}
|
|
4915
4933
|
/** @oneof */
|
|
4916
4934
|
interface ContentFieldValueOneOf {
|
|
4917
|
-
/**
|
|
4935
|
+
/** Plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
|
|
4918
4936
|
textValue?: string;
|
|
4919
|
-
/**
|
|
4937
|
+
/** Rich content. */
|
|
4920
4938
|
richContent?: RichContent;
|
|
4921
4939
|
/** Wix Media Manager image. */
|
|
4922
4940
|
image?: string;
|
|
@@ -6787,7 +6805,7 @@ interface AggregationResultsResultOneOf {
|
|
|
6787
6805
|
interface BulkCreateContentRequest {
|
|
6788
6806
|
/** List of translation content. */
|
|
6789
6807
|
contents: Content[];
|
|
6790
|
-
/** Whether to include the created translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
6808
|
+
/** Whether to include the created translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
6791
6809
|
returnEntity?: boolean;
|
|
6792
6810
|
}
|
|
6793
6811
|
interface BulkCreateContentResponse {
|
|
@@ -6831,7 +6849,7 @@ interface BulkActionMetadata {
|
|
|
6831
6849
|
interface BulkUpdateContentRequest {
|
|
6832
6850
|
/** Contents to be updated. TODO: think again if we want to increase maxSize */
|
|
6833
6851
|
contents: BulkUpdateContentRequestMaskedContent[];
|
|
6834
|
-
/** Whether to include the updated translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
6852
|
+
/** Whether to include the updated translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
6835
6853
|
returnEntity?: boolean;
|
|
6836
6854
|
}
|
|
6837
6855
|
interface BulkUpdateContentRequestMaskedContent {
|
|
@@ -7596,11 +7614,11 @@ interface SearchContentsOptions {
|
|
|
7596
7614
|
search?: CursorSearch;
|
|
7597
7615
|
}
|
|
7598
7616
|
interface BulkCreateContentOptions {
|
|
7599
|
-
/** Whether to include the created translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
7617
|
+
/** Whether to include the created translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
7600
7618
|
returnEntity?: boolean;
|
|
7601
7619
|
}
|
|
7602
7620
|
interface BulkUpdateContentOptions {
|
|
7603
|
-
/** Whether to include the updated translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
7621
|
+
/** Whether to include the updated translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
7604
7622
|
returnEntity?: boolean;
|
|
7605
7623
|
}
|
|
7606
7624
|
interface BulkUpdateContentByKeyOptions {
|
|
@@ -7676,7 +7694,7 @@ interface QueryContentsSignature {
|
|
|
7676
7694
|
*
|
|
7677
7695
|
* The default `sort` is `id` in `ASC`.
|
|
7678
7696
|
*
|
|
7679
|
-
* For field support for filters and sorting, see [Translation Content: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/
|
|
7697
|
+
* For field support for filters and sorting, see [Translation Content: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/sort-filter-and-search).
|
|
7680
7698
|
*
|
|
7681
7699
|
* To learn how to query translation consent items, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
7682
7700
|
*/
|
|
@@ -8295,6 +8313,17 @@ interface Cursors {
|
|
|
8295
8313
|
interface ListSiteSchemasRequest {
|
|
8296
8314
|
/** 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`. */
|
|
8297
8315
|
paging?: CursorPaging;
|
|
8316
|
+
/** ID of app that created the schema. */
|
|
8317
|
+
appId?: string | null;
|
|
8318
|
+
/** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
|
|
8319
|
+
entityType?: string | null;
|
|
8320
|
+
/**
|
|
8321
|
+
* Scope of the translation schema.
|
|
8322
|
+
* Supported values:
|
|
8323
|
+
* + `GLOBAL`: A global schema for all sites.
|
|
8324
|
+
* + `SITE`: A custom schema for a specific site.
|
|
8325
|
+
*/
|
|
8326
|
+
scope?: SchemaScope;
|
|
8298
8327
|
}
|
|
8299
8328
|
interface ListSiteSchemasResponse {
|
|
8300
8329
|
/** List of translation schemas. */
|
|
@@ -8847,6 +8876,17 @@ interface SchemasQueryBuilder {
|
|
|
8847
8876
|
interface ListSiteSchemasOptions {
|
|
8848
8877
|
/** 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`. */
|
|
8849
8878
|
paging?: CursorPaging;
|
|
8879
|
+
/** ID of app that created the schema. */
|
|
8880
|
+
appId?: string | null;
|
|
8881
|
+
/** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
|
|
8882
|
+
entityType?: string | null;
|
|
8883
|
+
/**
|
|
8884
|
+
* Scope of the translation schema.
|
|
8885
|
+
* Supported values:
|
|
8886
|
+
* + `GLOBAL`: A global schema for all sites.
|
|
8887
|
+
* + `SITE`: A custom schema for a specific site.
|
|
8888
|
+
*/
|
|
8889
|
+
scope?: SchemaScope;
|
|
8850
8890
|
}
|
|
8851
8891
|
|
|
8852
8892
|
declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
|
|
@@ -8876,7 +8916,7 @@ interface QuerySchemasSignature {
|
|
|
8876
8916
|
*
|
|
8877
8917
|
* The default `sort` is `id` in `ASC`.
|
|
8878
8918
|
*
|
|
8879
|
-
* For a detailed list of supported operations, see [Translation Schema: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/
|
|
8919
|
+
* For a detailed list of supported operations, see [Translation Schema: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/sort-and-filter).
|
|
8880
8920
|
* To learn how to query translation schemas, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
8881
8921
|
*/
|
|
8882
8922
|
(options?: QuerySchemasOptions | undefined): SchemasQueryBuilder;
|
|
@@ -8900,15 +8940,21 @@ declare const querySchemas: BuildRESTFunction<typeof querySchemas$1> & typeof qu
|
|
|
8900
8940
|
declare const listSiteSchemas: BuildRESTFunction<typeof listSiteSchemas$1> & typeof listSiteSchemas$1;
|
|
8901
8941
|
|
|
8902
8942
|
type _publicOnSchemaCreatedType = typeof onSchemaCreated$1;
|
|
8903
|
-
/**
|
|
8943
|
+
/**
|
|
8944
|
+
* Triggered when a translation schema is created.
|
|
8945
|
+
*/
|
|
8904
8946
|
declare const onSchemaCreated: ReturnType<typeof createEventModule<_publicOnSchemaCreatedType>>;
|
|
8905
8947
|
|
|
8906
8948
|
type _publicOnSchemaUpdatedType = typeof onSchemaUpdated$1;
|
|
8907
|
-
/**
|
|
8949
|
+
/**
|
|
8950
|
+
* Triggered when a translation schema is updated.
|
|
8951
|
+
*/
|
|
8908
8952
|
declare const onSchemaUpdated: ReturnType<typeof createEventModule<_publicOnSchemaUpdatedType>>;
|
|
8909
8953
|
|
|
8910
8954
|
type _publicOnSchemaDeletedType = typeof onSchemaDeleted$1;
|
|
8911
|
-
/**
|
|
8955
|
+
/**
|
|
8956
|
+
* Triggered when a translation schema is deleted.
|
|
8957
|
+
*/
|
|
8912
8958
|
declare const onSchemaDeleted: ReturnType<typeof createEventModule<_publicOnSchemaDeletedType>>;
|
|
8913
8959
|
|
|
8914
8960
|
type context_ActionEvent = ActionEvent;
|
|
@@ -532,7 +532,7 @@ interface PublishedContent {
|
|
|
532
532
|
/** Schema key of the published content. */
|
|
533
533
|
schemaKey?: SchemaKey$1;
|
|
534
534
|
/**
|
|
535
|
-
* A unique
|
|
535
|
+
* A unique identifier defined by the app developer to differentiate translation content for various entities within the site. For example, if an app developer is creating translation content for blog posts, the `entityId` can be `'blog-posts-1'`.
|
|
536
536
|
* @readonly
|
|
537
537
|
*/
|
|
538
538
|
entityId?: string;
|
|
@@ -572,15 +572,15 @@ declare enum SchemaScope$1 {
|
|
|
572
572
|
SITE = "SITE"
|
|
573
573
|
}
|
|
574
574
|
interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
575
|
-
/** Plain text
|
|
575
|
+
/** Plain text. */
|
|
576
576
|
textValue?: string;
|
|
577
|
-
/** Rich content
|
|
577
|
+
/** Rich content. */
|
|
578
578
|
richContent?: RichContent$2;
|
|
579
|
-
/**
|
|
579
|
+
/** Wix Media Manager image. */
|
|
580
580
|
image?: string;
|
|
581
|
-
/**
|
|
581
|
+
/** Wix Media Manager video. */
|
|
582
582
|
video?: string;
|
|
583
|
-
/**
|
|
583
|
+
/** Wix Media Manager document. */
|
|
584
584
|
document?: string;
|
|
585
585
|
/**
|
|
586
586
|
* Unique string identifier that links a specific content field to its corresponding field in the schema.
|
|
@@ -592,15 +592,15 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
|
592
592
|
}
|
|
593
593
|
/** @oneof */
|
|
594
594
|
interface PublishedContentFieldValueOneOf {
|
|
595
|
-
/** Plain text
|
|
595
|
+
/** Plain text. */
|
|
596
596
|
textValue?: string;
|
|
597
|
-
/** Rich content
|
|
597
|
+
/** Rich content. */
|
|
598
598
|
richContent?: RichContent$2;
|
|
599
|
-
/**
|
|
599
|
+
/** Wix Media Manager image. */
|
|
600
600
|
image?: string;
|
|
601
|
-
/**
|
|
601
|
+
/** Wix Media Manager video. */
|
|
602
602
|
video?: string;
|
|
603
|
-
/**
|
|
603
|
+
/** Wix Media Manager document. */
|
|
604
604
|
document?: string;
|
|
605
605
|
}
|
|
606
606
|
interface RichContent$2 {
|
|
@@ -2437,7 +2437,19 @@ interface PublishedContentQueryBuilder {
|
|
|
2437
2437
|
declare function queryPublishedContent$1(httpClient: HttpClient): QueryPublishedContentSignature;
|
|
2438
2438
|
interface QueryPublishedContentSignature {
|
|
2439
2439
|
/**
|
|
2440
|
-
*
|
|
2440
|
+
* Retrieves a list of published translation content given the provided paging, filtering, and sorting. Up to 100 published content items can be returned per request.
|
|
2441
|
+
*
|
|
2442
|
+
* The default `sort` is `id` in `ASC`.
|
|
2443
|
+
*
|
|
2444
|
+
* The following query filter fields are required:
|
|
2445
|
+
*
|
|
2446
|
+
* + `schemaKey.appId`
|
|
2447
|
+
* + `schemaKey.entityType`
|
|
2448
|
+
* + `schemaKey.scope`
|
|
2449
|
+
*
|
|
2450
|
+
* For additional field support for filters and sorting, see [Translation Published Content: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-published-content/sort-and-filter).
|
|
2451
|
+
*
|
|
2452
|
+
* To learn how to query translation consent items, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
2441
2453
|
*/
|
|
2442
2454
|
(): PublishedContentQueryBuilder;
|
|
2443
2455
|
}
|
|
@@ -2450,15 +2462,21 @@ declare function createEventModule$2<T extends EventDefinition<any, string>>(eve
|
|
|
2450
2462
|
declare const queryPublishedContent: BuildRESTFunction<typeof queryPublishedContent$1> & typeof queryPublishedContent$1;
|
|
2451
2463
|
|
|
2452
2464
|
type _publicOnPublishedContentCreatedType = typeof onPublishedContentCreated$1;
|
|
2453
|
-
/**
|
|
2465
|
+
/**
|
|
2466
|
+
* Triggered when published content is created.
|
|
2467
|
+
*/
|
|
2454
2468
|
declare const onPublishedContentCreated: ReturnType<typeof createEventModule$2<_publicOnPublishedContentCreatedType>>;
|
|
2455
2469
|
|
|
2456
2470
|
type _publicOnPublishedContentUpdatedType = typeof onPublishedContentUpdated$1;
|
|
2457
|
-
/**
|
|
2471
|
+
/**
|
|
2472
|
+
* Triggered when published content is updated.
|
|
2473
|
+
*/
|
|
2458
2474
|
declare const onPublishedContentUpdated: ReturnType<typeof createEventModule$2<_publicOnPublishedContentUpdatedType>>;
|
|
2459
2475
|
|
|
2460
2476
|
type _publicOnPublishedContentDeletedType = typeof onPublishedContentDeleted$1;
|
|
2461
|
-
/**
|
|
2477
|
+
/**
|
|
2478
|
+
* Triggered when published content is deleted.
|
|
2479
|
+
*/
|
|
2462
2480
|
declare const onPublishedContentDeleted: ReturnType<typeof createEventModule$2<_publicOnPublishedContentDeletedType>>;
|
|
2463
2481
|
|
|
2464
2482
|
type index_d$4_ExtendedFields = ExtendedFields;
|
|
@@ -4876,9 +4894,9 @@ interface Content {
|
|
|
4876
4894
|
_updatedDate?: Date;
|
|
4877
4895
|
}
|
|
4878
4896
|
interface ContentField extends ContentFieldValueOneOf {
|
|
4879
|
-
/**
|
|
4897
|
+
/** Plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
|
|
4880
4898
|
textValue?: string;
|
|
4881
|
-
/**
|
|
4899
|
+
/** Rich content. */
|
|
4882
4900
|
richContent?: RichContent;
|
|
4883
4901
|
/** Wix Media Manager image. */
|
|
4884
4902
|
image?: string;
|
|
@@ -4914,9 +4932,9 @@ interface ContentField extends ContentFieldValueOneOf {
|
|
|
4914
4932
|
}
|
|
4915
4933
|
/** @oneof */
|
|
4916
4934
|
interface ContentFieldValueOneOf {
|
|
4917
|
-
/**
|
|
4935
|
+
/** Plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
|
|
4918
4936
|
textValue?: string;
|
|
4919
|
-
/**
|
|
4937
|
+
/** Rich content. */
|
|
4920
4938
|
richContent?: RichContent;
|
|
4921
4939
|
/** Wix Media Manager image. */
|
|
4922
4940
|
image?: string;
|
|
@@ -6787,7 +6805,7 @@ interface AggregationResultsResultOneOf {
|
|
|
6787
6805
|
interface BulkCreateContentRequest {
|
|
6788
6806
|
/** List of translation content. */
|
|
6789
6807
|
contents: Content[];
|
|
6790
|
-
/** Whether to include the created translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
6808
|
+
/** Whether to include the created translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
6791
6809
|
returnEntity?: boolean;
|
|
6792
6810
|
}
|
|
6793
6811
|
interface BulkCreateContentResponse {
|
|
@@ -6831,7 +6849,7 @@ interface BulkActionMetadata {
|
|
|
6831
6849
|
interface BulkUpdateContentRequest {
|
|
6832
6850
|
/** Contents to be updated. TODO: think again if we want to increase maxSize */
|
|
6833
6851
|
contents: BulkUpdateContentRequestMaskedContent[];
|
|
6834
|
-
/** Whether to include the updated translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
6852
|
+
/** Whether to include the updated translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
6835
6853
|
returnEntity?: boolean;
|
|
6836
6854
|
}
|
|
6837
6855
|
interface BulkUpdateContentRequestMaskedContent {
|
|
@@ -7596,11 +7614,11 @@ interface SearchContentsOptions {
|
|
|
7596
7614
|
search?: CursorSearch;
|
|
7597
7615
|
}
|
|
7598
7616
|
interface BulkCreateContentOptions {
|
|
7599
|
-
/** Whether to include the created translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
7617
|
+
/** Whether to include the created translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
7600
7618
|
returnEntity?: boolean;
|
|
7601
7619
|
}
|
|
7602
7620
|
interface BulkUpdateContentOptions {
|
|
7603
|
-
/** Whether to include the updated translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
7621
|
+
/** Whether to include the updated translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
7604
7622
|
returnEntity?: boolean;
|
|
7605
7623
|
}
|
|
7606
7624
|
interface BulkUpdateContentByKeyOptions {
|
|
@@ -7676,7 +7694,7 @@ interface QueryContentsSignature {
|
|
|
7676
7694
|
*
|
|
7677
7695
|
* The default `sort` is `id` in `ASC`.
|
|
7678
7696
|
*
|
|
7679
|
-
* For field support for filters and sorting, see [Translation Content: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/
|
|
7697
|
+
* For field support for filters and sorting, see [Translation Content: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/sort-filter-and-search).
|
|
7680
7698
|
*
|
|
7681
7699
|
* To learn how to query translation consent items, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
7682
7700
|
*/
|
|
@@ -8295,6 +8313,17 @@ interface Cursors {
|
|
|
8295
8313
|
interface ListSiteSchemasRequest {
|
|
8296
8314
|
/** 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`. */
|
|
8297
8315
|
paging?: CursorPaging;
|
|
8316
|
+
/** ID of app that created the schema. */
|
|
8317
|
+
appId?: string | null;
|
|
8318
|
+
/** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
|
|
8319
|
+
entityType?: string | null;
|
|
8320
|
+
/**
|
|
8321
|
+
* Scope of the translation schema.
|
|
8322
|
+
* Supported values:
|
|
8323
|
+
* + `GLOBAL`: A global schema for all sites.
|
|
8324
|
+
* + `SITE`: A custom schema for a specific site.
|
|
8325
|
+
*/
|
|
8326
|
+
scope?: SchemaScope;
|
|
8298
8327
|
}
|
|
8299
8328
|
interface ListSiteSchemasResponse {
|
|
8300
8329
|
/** List of translation schemas. */
|
|
@@ -8847,6 +8876,17 @@ interface SchemasQueryBuilder {
|
|
|
8847
8876
|
interface ListSiteSchemasOptions {
|
|
8848
8877
|
/** 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`. */
|
|
8849
8878
|
paging?: CursorPaging;
|
|
8879
|
+
/** ID of app that created the schema. */
|
|
8880
|
+
appId?: string | null;
|
|
8881
|
+
/** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
|
|
8882
|
+
entityType?: string | null;
|
|
8883
|
+
/**
|
|
8884
|
+
* Scope of the translation schema.
|
|
8885
|
+
* Supported values:
|
|
8886
|
+
* + `GLOBAL`: A global schema for all sites.
|
|
8887
|
+
* + `SITE`: A custom schema for a specific site.
|
|
8888
|
+
*/
|
|
8889
|
+
scope?: SchemaScope;
|
|
8850
8890
|
}
|
|
8851
8891
|
|
|
8852
8892
|
declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
|
|
@@ -8876,7 +8916,7 @@ interface QuerySchemasSignature {
|
|
|
8876
8916
|
*
|
|
8877
8917
|
* The default `sort` is `id` in `ASC`.
|
|
8878
8918
|
*
|
|
8879
|
-
* For a detailed list of supported operations, see [Translation Schema: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/
|
|
8919
|
+
* For a detailed list of supported operations, see [Translation Schema: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-schema/sort-and-filter).
|
|
8880
8920
|
* To learn how to query translation schemas, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
8881
8921
|
*/
|
|
8882
8922
|
(options?: QuerySchemasOptions | undefined): SchemasQueryBuilder;
|
|
@@ -8900,15 +8940,21 @@ declare const querySchemas: BuildRESTFunction<typeof querySchemas$1> & typeof qu
|
|
|
8900
8940
|
declare const listSiteSchemas: BuildRESTFunction<typeof listSiteSchemas$1> & typeof listSiteSchemas$1;
|
|
8901
8941
|
|
|
8902
8942
|
type _publicOnSchemaCreatedType = typeof onSchemaCreated$1;
|
|
8903
|
-
/**
|
|
8943
|
+
/**
|
|
8944
|
+
* Triggered when a translation schema is created.
|
|
8945
|
+
*/
|
|
8904
8946
|
declare const onSchemaCreated: ReturnType<typeof createEventModule<_publicOnSchemaCreatedType>>;
|
|
8905
8947
|
|
|
8906
8948
|
type _publicOnSchemaUpdatedType = typeof onSchemaUpdated$1;
|
|
8907
|
-
/**
|
|
8949
|
+
/**
|
|
8950
|
+
* Triggered when a translation schema is updated.
|
|
8951
|
+
*/
|
|
8908
8952
|
declare const onSchemaUpdated: ReturnType<typeof createEventModule<_publicOnSchemaUpdatedType>>;
|
|
8909
8953
|
|
|
8910
8954
|
type _publicOnSchemaDeletedType = typeof onSchemaDeleted$1;
|
|
8911
|
-
/**
|
|
8955
|
+
/**
|
|
8956
|
+
* Triggered when a translation schema is deleted.
|
|
8957
|
+
*/
|
|
8912
8958
|
declare const onSchemaDeleted: ReturnType<typeof createEventModule<_publicOnSchemaDeletedType>>;
|
|
8913
8959
|
|
|
8914
8960
|
type index_d_ActionEvent = ActionEvent;
|
|
@@ -47,7 +47,7 @@ interface PublishedContent$1 {
|
|
|
47
47
|
/** Schema key of the published content. */
|
|
48
48
|
schemaKey?: SchemaKey$3;
|
|
49
49
|
/**
|
|
50
|
-
* A unique
|
|
50
|
+
* A unique identifier defined by the app developer to differentiate translation content for various entities within the site. For example, if an app developer is creating translation content for blog posts, the `entityId` can be `'blog-posts-1'`.
|
|
51
51
|
* @readonly
|
|
52
52
|
*/
|
|
53
53
|
entityId?: string;
|
|
@@ -87,15 +87,15 @@ declare enum SchemaScope$3 {
|
|
|
87
87
|
SITE = "SITE"
|
|
88
88
|
}
|
|
89
89
|
interface PublishedContentField$1 extends PublishedContentFieldValueOneOf$1 {
|
|
90
|
-
/** Plain text
|
|
90
|
+
/** Plain text. */
|
|
91
91
|
textValue?: string;
|
|
92
|
-
/** Rich content
|
|
92
|
+
/** Rich content. */
|
|
93
93
|
richContent?: RichContent$5;
|
|
94
|
-
/**
|
|
94
|
+
/** Wix Media Manager image. */
|
|
95
95
|
image?: Image$5;
|
|
96
|
-
/**
|
|
96
|
+
/** Wix Media Manager video. */
|
|
97
97
|
video?: VideoV2$1;
|
|
98
|
-
/**
|
|
98
|
+
/** Wix Media Manager document. */
|
|
99
99
|
document?: Document$1;
|
|
100
100
|
/**
|
|
101
101
|
* Unique string identifier that links a specific content field to its corresponding field in the schema.
|
|
@@ -107,15 +107,15 @@ interface PublishedContentField$1 extends PublishedContentFieldValueOneOf$1 {
|
|
|
107
107
|
}
|
|
108
108
|
/** @oneof */
|
|
109
109
|
interface PublishedContentFieldValueOneOf$1 {
|
|
110
|
-
/** Plain text
|
|
110
|
+
/** Plain text. */
|
|
111
111
|
textValue?: string;
|
|
112
|
-
/** Rich content
|
|
112
|
+
/** Rich content. */
|
|
113
113
|
richContent?: RichContent$5;
|
|
114
|
-
/**
|
|
114
|
+
/** Wix Media Manager image. */
|
|
115
115
|
image?: Image$5;
|
|
116
|
-
/**
|
|
116
|
+
/** Wix Media Manager video. */
|
|
117
117
|
video?: VideoV2$1;
|
|
118
|
-
/**
|
|
118
|
+
/** Wix Media Manager document. */
|
|
119
119
|
document?: Document$1;
|
|
120
120
|
}
|
|
121
121
|
interface RichContent$5 {
|
|
@@ -1775,7 +1775,7 @@ interface PublishedContent {
|
|
|
1775
1775
|
/** Schema key of the published content. */
|
|
1776
1776
|
schemaKey?: SchemaKey$2;
|
|
1777
1777
|
/**
|
|
1778
|
-
* A unique
|
|
1778
|
+
* A unique identifier defined by the app developer to differentiate translation content for various entities within the site. For example, if an app developer is creating translation content for blog posts, the `entityId` can be `'blog-posts-1'`.
|
|
1779
1779
|
* @readonly
|
|
1780
1780
|
*/
|
|
1781
1781
|
entityId?: string;
|
|
@@ -1815,15 +1815,15 @@ declare enum SchemaScope$2 {
|
|
|
1815
1815
|
SITE = "SITE"
|
|
1816
1816
|
}
|
|
1817
1817
|
interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
1818
|
-
/** Plain text
|
|
1818
|
+
/** Plain text. */
|
|
1819
1819
|
textValue?: string;
|
|
1820
|
-
/** Rich content
|
|
1820
|
+
/** Rich content. */
|
|
1821
1821
|
richContent?: RichContent$4;
|
|
1822
|
-
/**
|
|
1822
|
+
/** Wix Media Manager image. */
|
|
1823
1823
|
image?: string;
|
|
1824
|
-
/**
|
|
1824
|
+
/** Wix Media Manager video. */
|
|
1825
1825
|
video?: string;
|
|
1826
|
-
/**
|
|
1826
|
+
/** Wix Media Manager document. */
|
|
1827
1827
|
document?: string;
|
|
1828
1828
|
/**
|
|
1829
1829
|
* Unique string identifier that links a specific content field to its corresponding field in the schema.
|
|
@@ -1835,15 +1835,15 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
|
|
|
1835
1835
|
}
|
|
1836
1836
|
/** @oneof */
|
|
1837
1837
|
interface PublishedContentFieldValueOneOf {
|
|
1838
|
-
/** Plain text
|
|
1838
|
+
/** Plain text. */
|
|
1839
1839
|
textValue?: string;
|
|
1840
|
-
/** Rich content
|
|
1840
|
+
/** Rich content. */
|
|
1841
1841
|
richContent?: RichContent$4;
|
|
1842
|
-
/**
|
|
1842
|
+
/** Wix Media Manager image. */
|
|
1843
1843
|
image?: string;
|
|
1844
|
-
/**
|
|
1844
|
+
/** Wix Media Manager video. */
|
|
1845
1845
|
video?: string;
|
|
1846
|
-
/**
|
|
1846
|
+
/** Wix Media Manager document. */
|
|
1847
1847
|
document?: string;
|
|
1848
1848
|
}
|
|
1849
1849
|
interface RichContent$4 {
|
|
@@ -7851,9 +7851,9 @@ interface Content$1 {
|
|
|
7851
7851
|
updatedDate?: Date;
|
|
7852
7852
|
}
|
|
7853
7853
|
interface ContentField$1 extends ContentFieldValueOneOf$1 {
|
|
7854
|
-
/**
|
|
7854
|
+
/** Plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
|
|
7855
7855
|
textValue?: string;
|
|
7856
|
-
/**
|
|
7856
|
+
/** Rich content. */
|
|
7857
7857
|
richContent?: RichContent$1;
|
|
7858
7858
|
/** Wix Media Manager image. */
|
|
7859
7859
|
image?: Image$1;
|
|
@@ -7889,9 +7889,9 @@ interface ContentField$1 extends ContentFieldValueOneOf$1 {
|
|
|
7889
7889
|
}
|
|
7890
7890
|
/** @oneof */
|
|
7891
7891
|
interface ContentFieldValueOneOf$1 {
|
|
7892
|
-
/**
|
|
7892
|
+
/** Plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
|
|
7893
7893
|
textValue?: string;
|
|
7894
|
-
/**
|
|
7894
|
+
/** Rich content. */
|
|
7895
7895
|
richContent?: RichContent$1;
|
|
7896
7896
|
/** Wix Media Manager image. */
|
|
7897
7897
|
image?: Image$1;
|
|
@@ -9731,7 +9731,7 @@ interface AggregationResultsResultOneOf$1 {
|
|
|
9731
9731
|
interface BulkCreateContentRequest$1 {
|
|
9732
9732
|
/** List of translation content. */
|
|
9733
9733
|
contents: Content$1[];
|
|
9734
|
-
/** Whether to include the created translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
9734
|
+
/** Whether to include the created translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
9735
9735
|
returnEntity?: boolean;
|
|
9736
9736
|
}
|
|
9737
9737
|
interface BulkCreateContentResponse$1 {
|
|
@@ -9775,7 +9775,7 @@ interface BulkActionMetadata$1 {
|
|
|
9775
9775
|
interface BulkUpdateContentRequest$1 {
|
|
9776
9776
|
/** Contents to be updated. TODO: think again if we want to increase maxSize */
|
|
9777
9777
|
contents: BulkUpdateContentRequestMaskedContent$1[];
|
|
9778
|
-
/** Whether to include the updated translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
9778
|
+
/** Whether to include the updated translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
9779
9779
|
returnEntity?: boolean;
|
|
9780
9780
|
}
|
|
9781
9781
|
interface BulkUpdateContentRequestMaskedContent$1 {
|
|
@@ -9996,9 +9996,9 @@ interface Content {
|
|
|
9996
9996
|
_updatedDate?: Date;
|
|
9997
9997
|
}
|
|
9998
9998
|
interface ContentField extends ContentFieldValueOneOf {
|
|
9999
|
-
/**
|
|
9999
|
+
/** Plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
|
|
10000
10000
|
textValue?: string;
|
|
10001
|
-
/**
|
|
10001
|
+
/** Rich content. */
|
|
10002
10002
|
richContent?: RichContent;
|
|
10003
10003
|
/** Wix Media Manager image. */
|
|
10004
10004
|
image?: string;
|
|
@@ -10034,9 +10034,9 @@ interface ContentField extends ContentFieldValueOneOf {
|
|
|
10034
10034
|
}
|
|
10035
10035
|
/** @oneof */
|
|
10036
10036
|
interface ContentFieldValueOneOf {
|
|
10037
|
-
/**
|
|
10037
|
+
/** Plain text. Use this field if the corresponding schema `fields.type` is `SHORT_TEXT`, `LONG_TEXT`, `HTML`, or `IMAGE_LINK`. */
|
|
10038
10038
|
textValue?: string;
|
|
10039
|
-
/**
|
|
10039
|
+
/** Rich content. */
|
|
10040
10040
|
richContent?: RichContent;
|
|
10041
10041
|
/** Wix Media Manager image. */
|
|
10042
10042
|
image?: string;
|
|
@@ -11821,7 +11821,7 @@ interface AggregationResultsResultOneOf {
|
|
|
11821
11821
|
interface BulkCreateContentRequest {
|
|
11822
11822
|
/** List of translation content. */
|
|
11823
11823
|
contents: Content[];
|
|
11824
|
-
/** Whether to include the created translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
11824
|
+
/** Whether to include the created translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
11825
11825
|
returnEntity?: boolean;
|
|
11826
11826
|
}
|
|
11827
11827
|
interface BulkCreateContentResponse {
|
|
@@ -11865,7 +11865,7 @@ interface BulkActionMetadata {
|
|
|
11865
11865
|
interface BulkUpdateContentRequest {
|
|
11866
11866
|
/** Contents to be updated. TODO: think again if we want to increase maxSize */
|
|
11867
11867
|
contents: BulkUpdateContentRequestMaskedContent[];
|
|
11868
|
-
/** Whether to include the updated translation content in the response. Set to `true` to receive the translation content in the response. */
|
|
11868
|
+
/** Whether to include the updated translation content items in the response. Set to `true` to receive the translation content items in the response. */
|
|
11869
11869
|
returnEntity?: boolean;
|
|
11870
11870
|
}
|
|
11871
11871
|
interface BulkUpdateContentRequestMaskedContent {
|
|
@@ -12304,6 +12304,17 @@ interface Cursors$1 {
|
|
|
12304
12304
|
interface ListSiteSchemasRequest$1 {
|
|
12305
12305
|
/** 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`. */
|
|
12306
12306
|
paging?: CursorPaging$1;
|
|
12307
|
+
/** ID of app that created the schema. */
|
|
12308
|
+
appId?: string | null;
|
|
12309
|
+
/** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
|
|
12310
|
+
entityType?: string | null;
|
|
12311
|
+
/**
|
|
12312
|
+
* Scope of the translation schema.
|
|
12313
|
+
* Supported values:
|
|
12314
|
+
* + `GLOBAL`: A global schema for all sites.
|
|
12315
|
+
* + `SITE`: A custom schema for a specific site.
|
|
12316
|
+
*/
|
|
12317
|
+
scope?: SchemaScope$1;
|
|
12307
12318
|
}
|
|
12308
12319
|
interface ListSiteSchemasResponse$1 {
|
|
12309
12320
|
/** List of translation schemas. */
|
|
@@ -12550,6 +12561,17 @@ interface Cursors {
|
|
|
12550
12561
|
interface ListSiteSchemasRequest {
|
|
12551
12562
|
/** 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`. */
|
|
12552
12563
|
paging?: CursorPaging;
|
|
12564
|
+
/** ID of app that created the schema. */
|
|
12565
|
+
appId?: string | null;
|
|
12566
|
+
/** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
|
|
12567
|
+
entityType?: string | null;
|
|
12568
|
+
/**
|
|
12569
|
+
* Scope of the translation schema.
|
|
12570
|
+
* Supported values:
|
|
12571
|
+
* + `GLOBAL`: A global schema for all sites.
|
|
12572
|
+
* + `SITE`: A custom schema for a specific site.
|
|
12573
|
+
*/
|
|
12574
|
+
scope?: SchemaScope;
|
|
12553
12575
|
}
|
|
12554
12576
|
interface ListSiteSchemasResponse {
|
|
12555
12577
|
/** List of translation schemas. */
|