@wix/multilingual 1.0.57 → 1.0.59
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 +5 -5
- package/type-bundles/context.bundle.d.ts +271 -148
- package/type-bundles/index.bundle.d.ts +271 -148
- package/type-bundles/meta.bundle.d.ts +333 -267
|
@@ -2816,9 +2816,18 @@ interface PublishedContentQueryBuilder {
|
|
|
2816
2816
|
declare function queryPublishedContent$1(httpClient: HttpClient): QueryPublishedContentSignature;
|
|
2817
2817
|
interface QueryPublishedContentSignature {
|
|
2818
2818
|
/**
|
|
2819
|
-
*
|
|
2819
|
+
* Creates a query to retrieve a list of translation content items.
|
|
2820
2820
|
*
|
|
2821
|
-
* The
|
|
2821
|
+
* The `queryPublishedContent()` function builds a query to retrieve a list of translation content items and returns a `PublishedContentQueryBuilder` object.
|
|
2822
|
+
*
|
|
2823
|
+
* 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-published-content/published-content-query-builder/find) function.
|
|
2824
|
+
*
|
|
2825
|
+
* You can refine the query by chaining `PublishedContentQueryBuilder` functions onto the query. `PublishedContentQueryBuilder` functions enable you to filter, sort, and control the results that `queryPublishedContent()` returns.
|
|
2826
|
+
*
|
|
2827
|
+
* `queryPublishedContent()` runs with the following `PublishedContentQueryBuilder` defaults which you can override:
|
|
2828
|
+
*
|
|
2829
|
+
* + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/limit)
|
|
2830
|
+
* + [`ascending('id')`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/ascending)
|
|
2822
2831
|
*
|
|
2823
2832
|
* The following query filter fields are required:
|
|
2824
2833
|
*
|
|
@@ -2826,9 +2835,7 @@ interface QueryPublishedContentSignature {
|
|
|
2826
2835
|
* + `schemaKey.entityType`
|
|
2827
2836
|
* + `schemaKey.scope`
|
|
2828
2837
|
*
|
|
2829
|
-
*
|
|
2830
|
-
*
|
|
2831
|
-
* To learn how to query translation consent items, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
|
|
2838
|
+
* The following `PublishedContentQueryBuilder` functions are supported for `queryPublishedContent()`. 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-published-content/published-content-query-result/items) property in `PublishedContentQueryResult`.
|
|
2832
2839
|
*/
|
|
2833
2840
|
(): PublishedContentQueryBuilder;
|
|
2834
2841
|
}
|
|
@@ -5317,11 +5324,11 @@ interface ContentField extends ContentFieldValueOneOf {
|
|
|
5317
5324
|
*/
|
|
5318
5325
|
published?: boolean;
|
|
5319
5326
|
/**
|
|
5320
|
-
*
|
|
5327
|
+
* **Required.** The source that updated the translation content.
|
|
5321
5328
|
* Supported values:
|
|
5322
5329
|
* + `USER`: The Wix user.
|
|
5323
5330
|
* + `EXTERNAL_APP`: An external translation app.
|
|
5324
|
-
* + `MACHINE`: Machine
|
|
5331
|
+
* + `MACHINE`: Machine translation service.
|
|
5325
5332
|
*/
|
|
5326
5333
|
updatedBy?: UpdaterIdentity;
|
|
5327
5334
|
/**
|
|
@@ -6808,18 +6815,18 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
6808
6815
|
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
6809
6816
|
*/
|
|
6810
6817
|
sort?: Sorting$1[];
|
|
6811
|
-
/** Aggregations
|
|
6818
|
+
/** Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
|
|
6812
6819
|
aggregations?: Aggregation[];
|
|
6813
6820
|
/** Free text to match in searchable fields. */
|
|
6814
6821
|
search?: SearchDetails;
|
|
6815
6822
|
/**
|
|
6816
6823
|
* UTC offset or IANA time zone. Valid values are
|
|
6817
6824
|
* ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
6818
|
-
* and IANA time zone IDs, such as Europe/Rome
|
|
6825
|
+
* and IANA time zone IDs, such as Europe/Rome.
|
|
6819
6826
|
*
|
|
6820
6827
|
* Affects all filters and aggregations returned values.
|
|
6821
6828
|
* You may override this behavior in a specific filter by providing
|
|
6822
|
-
* timestamps including time zone.
|
|
6829
|
+
* timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
|
|
6823
6830
|
*/
|
|
6824
6831
|
timeZone?: string | null;
|
|
6825
6832
|
}
|
|
@@ -6833,25 +6840,25 @@ interface CursorSearchPagingMethodOneOf {
|
|
|
6833
6840
|
cursorPaging?: CursorPaging$1;
|
|
6834
6841
|
}
|
|
6835
6842
|
interface Aggregation extends AggregationKindOneOf {
|
|
6836
|
-
/** Value aggregation */
|
|
6843
|
+
/** Value aggregation. */
|
|
6837
6844
|
value?: ValueAggregation;
|
|
6838
|
-
/** Range aggregation */
|
|
6845
|
+
/** Range aggregation. */
|
|
6839
6846
|
range?: RangeAggregation;
|
|
6840
|
-
/** Scalar aggregation */
|
|
6847
|
+
/** Scalar aggregation. */
|
|
6841
6848
|
scalar?: ScalarAggregation;
|
|
6842
|
-
/** Date histogram aggregation */
|
|
6849
|
+
/** Date histogram aggregation. */
|
|
6843
6850
|
dateHistogram?: DateHistogramAggregation;
|
|
6844
|
-
/** Nested aggregation */
|
|
6851
|
+
/** Nested aggregation. */
|
|
6845
6852
|
nested?: NestedAggregation;
|
|
6846
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
6853
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
6847
6854
|
name?: string | null;
|
|
6848
|
-
/** Type of aggregation, client must provide matching aggregation field below */
|
|
6855
|
+
/** Type of aggregation, client must provide matching aggregation field below. */
|
|
6849
6856
|
type?: AggregationType;
|
|
6850
|
-
/** Field to aggregate by, use dot notation to specify json path */
|
|
6857
|
+
/** Field to aggregate by, use dot notation to specify json path. */
|
|
6851
6858
|
fieldPath?: string;
|
|
6852
6859
|
/**
|
|
6853
|
-
*
|
|
6854
|
-
* @deprecated
|
|
6860
|
+
* Deprecated. Use `nested` instead.
|
|
6861
|
+
* @deprecated Deprecated. Use `nested` instead.
|
|
6855
6862
|
* @replacedBy kind.nested
|
|
6856
6863
|
* @targetRemovalDate 2024-03-30
|
|
6857
6864
|
*/
|
|
@@ -6859,96 +6866,96 @@ interface Aggregation extends AggregationKindOneOf {
|
|
|
6859
6866
|
}
|
|
6860
6867
|
/** @oneof */
|
|
6861
6868
|
interface AggregationKindOneOf {
|
|
6862
|
-
/** Value aggregation */
|
|
6869
|
+
/** Value aggregation. */
|
|
6863
6870
|
value?: ValueAggregation;
|
|
6864
|
-
/** Range aggregation */
|
|
6871
|
+
/** Range aggregation. */
|
|
6865
6872
|
range?: RangeAggregation;
|
|
6866
|
-
/** Scalar aggregation */
|
|
6873
|
+
/** Scalar aggregation. */
|
|
6867
6874
|
scalar?: ScalarAggregation;
|
|
6868
|
-
/** Date histogram aggregation */
|
|
6875
|
+
/** Date histogram aggregation. */
|
|
6869
6876
|
dateHistogram?: DateHistogramAggregation;
|
|
6870
|
-
/** Nested aggregation */
|
|
6877
|
+
/** Nested aggregation. */
|
|
6871
6878
|
nested?: NestedAggregation;
|
|
6872
6879
|
}
|
|
6873
6880
|
interface RangeBucket {
|
|
6874
|
-
/** Inclusive lower bound of the range. Required if to is not
|
|
6881
|
+
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
6875
6882
|
from?: number | null;
|
|
6876
|
-
/** Exclusive upper bound of the range. Required if from is not
|
|
6883
|
+
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
6877
6884
|
to?: number | null;
|
|
6878
6885
|
}
|
|
6879
6886
|
declare enum SortType {
|
|
6880
|
-
/**
|
|
6887
|
+
/** Sort by number of matches. */
|
|
6881
6888
|
COUNT = "COUNT",
|
|
6882
|
-
/**
|
|
6889
|
+
/** Sort by value of the field alphabetically. */
|
|
6883
6890
|
VALUE = "VALUE"
|
|
6884
6891
|
}
|
|
6885
6892
|
declare enum SortDirection {
|
|
6886
|
-
/**
|
|
6893
|
+
/** Sort in descending order. */
|
|
6887
6894
|
DESC = "DESC",
|
|
6888
|
-
/**
|
|
6895
|
+
/** Sort in ascending order. */
|
|
6889
6896
|
ASC = "ASC"
|
|
6890
6897
|
}
|
|
6891
6898
|
declare enum MissingValues {
|
|
6892
|
-
/**
|
|
6899
|
+
/** Exclude missing values from the aggregation results. */
|
|
6893
6900
|
EXCLUDE = "EXCLUDE",
|
|
6894
|
-
/**
|
|
6901
|
+
/** Include missing values in the aggregation results. */
|
|
6895
6902
|
INCLUDE = "INCLUDE"
|
|
6896
6903
|
}
|
|
6897
6904
|
interface IncludeMissingValuesOptions {
|
|
6898
|
-
/**
|
|
6905
|
+
/** Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
|
|
6899
6906
|
addToBucket?: string;
|
|
6900
6907
|
}
|
|
6901
6908
|
declare enum ScalarType {
|
|
6902
6909
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
6903
|
-
/** Count of distinct values */
|
|
6910
|
+
/** Count of distinct values. */
|
|
6904
6911
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
6905
|
-
/** Minimum value */
|
|
6912
|
+
/** Minimum value. */
|
|
6906
6913
|
MIN = "MIN",
|
|
6907
|
-
/** Maximum value */
|
|
6914
|
+
/** Maximum value. */
|
|
6908
6915
|
MAX = "MAX",
|
|
6909
|
-
/** Sum of values */
|
|
6916
|
+
/** Sum of values. */
|
|
6910
6917
|
SUM = "SUM",
|
|
6911
|
-
/** Average of values */
|
|
6918
|
+
/** Average of values. */
|
|
6912
6919
|
AVG = "AVG"
|
|
6913
6920
|
}
|
|
6914
6921
|
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
6915
|
-
/** Options for including missing values */
|
|
6922
|
+
/** Options for including missing values. */
|
|
6916
6923
|
includeOptions?: IncludeMissingValuesOptions;
|
|
6917
|
-
/**
|
|
6924
|
+
/** Whether to sort by number of matches or value of the field. */
|
|
6918
6925
|
sortType?: SortType;
|
|
6919
|
-
/**
|
|
6926
|
+
/** Whether to sort in ascending or descending order. */
|
|
6920
6927
|
sortDirection?: SortDirection;
|
|
6921
|
-
/** How many aggregations
|
|
6928
|
+
/** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
|
|
6922
6929
|
limit?: number | null;
|
|
6923
|
-
/**
|
|
6930
|
+
/** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
|
|
6924
6931
|
missingValues?: MissingValues;
|
|
6925
6932
|
}
|
|
6926
6933
|
/** @oneof */
|
|
6927
6934
|
interface ValueAggregationOptionsOneOf {
|
|
6928
|
-
/** Options for including missing values */
|
|
6935
|
+
/** Options for including missing values. */
|
|
6929
6936
|
includeOptions?: IncludeMissingValuesOptions;
|
|
6930
6937
|
}
|
|
6931
6938
|
declare enum NestedAggregationType {
|
|
6932
6939
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
6933
|
-
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
6940
|
+
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
6934
6941
|
VALUE = "VALUE",
|
|
6935
|
-
/** An aggregation, where user can define set of ranges - each representing a bucket */
|
|
6942
|
+
/** An aggregation, where user can define set of ranges - each representing a bucket. */
|
|
6936
6943
|
RANGE = "RANGE",
|
|
6937
|
-
/** A single-value metric aggregation
|
|
6944
|
+
/** A single-value metric aggregation. For example, min, max, sum, avg. */
|
|
6938
6945
|
SCALAR = "SCALAR",
|
|
6939
|
-
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
|
|
6946
|
+
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
|
|
6940
6947
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
6941
6948
|
}
|
|
6942
6949
|
interface RangeAggregation {
|
|
6943
|
-
/** List of range buckets, where during aggregation each entity will be placed in the first bucket
|
|
6950
|
+
/** List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds. */
|
|
6944
6951
|
buckets?: RangeBucket[];
|
|
6945
6952
|
}
|
|
6946
6953
|
interface ScalarAggregation {
|
|
6947
|
-
/** Define the operator for the scalar aggregation */
|
|
6954
|
+
/** Define the operator for the scalar aggregation. */
|
|
6948
6955
|
type?: ScalarType;
|
|
6949
6956
|
}
|
|
6950
6957
|
interface DateHistogramAggregation {
|
|
6951
|
-
/** Interval for date histogram aggregation */
|
|
6958
|
+
/** Interval for date histogram aggregation. */
|
|
6952
6959
|
interval?: Interval;
|
|
6953
6960
|
}
|
|
6954
6961
|
declare enum Interval {
|
|
@@ -6969,77 +6976,77 @@ declare enum Interval {
|
|
|
6969
6976
|
SECOND = "SECOND"
|
|
6970
6977
|
}
|
|
6971
6978
|
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
6972
|
-
/** Value aggregation */
|
|
6979
|
+
/** Value aggregation. */
|
|
6973
6980
|
value?: ValueAggregation;
|
|
6974
|
-
/** Range aggregation */
|
|
6981
|
+
/** Range aggregation. */
|
|
6975
6982
|
range?: RangeAggregation;
|
|
6976
|
-
/** Scalar aggregation */
|
|
6983
|
+
/** Scalar aggregation. */
|
|
6977
6984
|
scalar?: ScalarAggregation;
|
|
6978
|
-
/** Date histogram aggregation */
|
|
6985
|
+
/** Date histogram aggregation. */
|
|
6979
6986
|
dateHistogram?: DateHistogramAggregation;
|
|
6980
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
6987
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
6981
6988
|
name?: string | null;
|
|
6982
|
-
/** Type of aggregation, client must provide matching aggregation field below */
|
|
6989
|
+
/** Type of aggregation, client must provide matching aggregation field below. */
|
|
6983
6990
|
type?: NestedAggregationType;
|
|
6984
|
-
/** Field to aggregate by, use
|
|
6991
|
+
/** Field to aggregate by, use dot notation to specify json path. */
|
|
6985
6992
|
fieldPath?: string;
|
|
6986
6993
|
}
|
|
6987
6994
|
/** @oneof */
|
|
6988
6995
|
interface NestedAggregationItemKindOneOf {
|
|
6989
|
-
/** Value aggregation */
|
|
6996
|
+
/** Value aggregation. */
|
|
6990
6997
|
value?: ValueAggregation;
|
|
6991
|
-
/** Range aggregation */
|
|
6998
|
+
/** Range aggregation. */
|
|
6992
6999
|
range?: RangeAggregation;
|
|
6993
|
-
/** Scalar aggregation */
|
|
7000
|
+
/** Scalar aggregation. */
|
|
6994
7001
|
scalar?: ScalarAggregation;
|
|
6995
|
-
/** Date histogram aggregation */
|
|
7002
|
+
/** Date histogram aggregation. */
|
|
6996
7003
|
dateHistogram?: DateHistogramAggregation;
|
|
6997
7004
|
}
|
|
6998
7005
|
declare enum AggregationType {
|
|
6999
7006
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
7000
|
-
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
7007
|
+
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
7001
7008
|
VALUE = "VALUE",
|
|
7002
|
-
/** An aggregation, where user can define set of ranges - each representing a bucket */
|
|
7009
|
+
/** An aggregation, where user can define set of ranges - each representing a bucket. */
|
|
7003
7010
|
RANGE = "RANGE",
|
|
7004
|
-
/** A single-value metric aggregation
|
|
7011
|
+
/** A single-value metric aggregation. For example, min, max, sum, avg. */
|
|
7005
7012
|
SCALAR = "SCALAR",
|
|
7006
7013
|
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
|
|
7007
7014
|
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
7008
|
-
/** Multi-level aggregation, where each next aggregation is nested within previous one */
|
|
7015
|
+
/** Multi-level aggregation, where each next aggregation is nested within previous one. */
|
|
7009
7016
|
NESTED = "NESTED"
|
|
7010
7017
|
}
|
|
7011
|
-
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
7018
|
+
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
|
|
7012
7019
|
interface NestedAggregation {
|
|
7013
|
-
/** Flattened list of aggregations, where each next aggregation is nested within previous one */
|
|
7020
|
+
/** Flattened list of aggregations, where each next aggregation is nested within previous one. */
|
|
7014
7021
|
nestedAggregations?: NestedAggregationItem[];
|
|
7015
7022
|
}
|
|
7016
7023
|
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
7017
|
-
/** Value aggregation configuration */
|
|
7024
|
+
/** Value aggregation configuration. */
|
|
7018
7025
|
value?: ValueAggregation;
|
|
7019
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
7026
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
7020
7027
|
name?: string | null;
|
|
7021
|
-
/** Field to aggregate by */
|
|
7028
|
+
/** Field to aggregate by. */
|
|
7022
7029
|
fieldPath?: string;
|
|
7023
7030
|
}
|
|
7024
7031
|
/** @oneof */
|
|
7025
7032
|
interface GroupByAggregationKindOneOf {
|
|
7026
|
-
/** Value aggregation configuration */
|
|
7033
|
+
/** Value aggregation configuration. */
|
|
7027
7034
|
value?: ValueAggregation;
|
|
7028
7035
|
}
|
|
7029
7036
|
interface SearchDetails {
|
|
7030
|
-
/** Defines how separate search terms in `expression` are combined */
|
|
7037
|
+
/** Defines how separate search terms in `expression` are combined. */
|
|
7031
7038
|
mode?: Mode;
|
|
7032
|
-
/** Search term or expression */
|
|
7039
|
+
/** Search term or expression. */
|
|
7033
7040
|
expression?: string | null;
|
|
7034
|
-
/** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
|
|
7041
|
+
/** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path. */
|
|
7035
7042
|
fields?: string[];
|
|
7036
|
-
/**
|
|
7043
|
+
/** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
|
|
7037
7044
|
fuzzy?: boolean;
|
|
7038
7045
|
}
|
|
7039
7046
|
declare enum Mode {
|
|
7040
|
-
/** Any of the search terms must be present */
|
|
7047
|
+
/** Any of the search terms must be present. */
|
|
7041
7048
|
OR = "OR",
|
|
7042
|
-
/** All search terms must be present */
|
|
7049
|
+
/** All search terms must be present. */
|
|
7043
7050
|
AND = "AND"
|
|
7044
7051
|
}
|
|
7045
7052
|
interface SearchContentsResponse {
|
|
@@ -7051,164 +7058,164 @@ interface SearchContentsResponse {
|
|
|
7051
7058
|
aggregationData?: AggregationData;
|
|
7052
7059
|
}
|
|
7053
7060
|
interface AggregationData {
|
|
7054
|
-
/** key = aggregation name (as derived from search request) */
|
|
7061
|
+
/** key = aggregation name (as derived from search request). */
|
|
7055
7062
|
results?: AggregationResults[];
|
|
7056
7063
|
}
|
|
7057
7064
|
interface ValueAggregationResult {
|
|
7058
|
-
/** Value of the field */
|
|
7065
|
+
/** Value of the field. */
|
|
7059
7066
|
value?: string;
|
|
7060
|
-
/** Count of entities with this value */
|
|
7067
|
+
/** Count of entities with this value. */
|
|
7061
7068
|
count?: number;
|
|
7062
7069
|
}
|
|
7063
7070
|
interface RangeAggregationResult {
|
|
7064
|
-
/** Inclusive lower bound of the range */
|
|
7071
|
+
/** Inclusive lower bound of the range. */
|
|
7065
7072
|
from?: number | null;
|
|
7066
|
-
/** Exclusive upper bound of the range */
|
|
7073
|
+
/** Exclusive upper bound of the range. */
|
|
7067
7074
|
to?: number | null;
|
|
7068
|
-
/** Count of entities in this range */
|
|
7075
|
+
/** Count of entities in this range. */
|
|
7069
7076
|
count?: number;
|
|
7070
7077
|
}
|
|
7071
7078
|
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
7072
|
-
/** Value aggregation results */
|
|
7079
|
+
/** Value aggregation results. */
|
|
7073
7080
|
values?: ValueResults;
|
|
7074
|
-
/** Range aggregation results */
|
|
7081
|
+
/** Range aggregation results. */
|
|
7075
7082
|
ranges?: RangeResults;
|
|
7076
|
-
/** Scalar aggregation results */
|
|
7083
|
+
/** Scalar aggregation results. */
|
|
7077
7084
|
scalar?: AggregationResultsScalarResult;
|
|
7078
|
-
/** User-defined name of aggregation, matches the one provided in request */
|
|
7085
|
+
/** User-defined name of aggregation, matches the one provided in request. */
|
|
7079
7086
|
name?: string;
|
|
7080
|
-
/** Type of aggregation that matches result */
|
|
7087
|
+
/** Type of aggregation that matches result. */
|
|
7081
7088
|
type?: AggregationType;
|
|
7082
|
-
/** Field to aggregate by, matches the one provided in request */
|
|
7089
|
+
/** Field to aggregate by, matches the one provided in request. */
|
|
7083
7090
|
fieldPath?: string;
|
|
7084
7091
|
}
|
|
7085
7092
|
/** @oneof */
|
|
7086
7093
|
interface NestedAggregationResultsResultOneOf {
|
|
7087
|
-
/** Value aggregation results */
|
|
7094
|
+
/** Value aggregation results. */
|
|
7088
7095
|
values?: ValueResults;
|
|
7089
|
-
/** Range aggregation results */
|
|
7096
|
+
/** Range aggregation results. */
|
|
7090
7097
|
ranges?: RangeResults;
|
|
7091
|
-
/** Scalar aggregation results */
|
|
7098
|
+
/** Scalar aggregation results. */
|
|
7092
7099
|
scalar?: AggregationResultsScalarResult;
|
|
7093
7100
|
}
|
|
7094
7101
|
interface ValueResults {
|
|
7095
|
-
/** List of value aggregations */
|
|
7102
|
+
/** List of value aggregations. */
|
|
7096
7103
|
results?: ValueAggregationResult[];
|
|
7097
7104
|
}
|
|
7098
7105
|
interface RangeResults {
|
|
7099
|
-
/** List of ranges returned in same order as requested */
|
|
7106
|
+
/** List of ranges returned in same order as requested. */
|
|
7100
7107
|
results?: RangeAggregationResult[];
|
|
7101
7108
|
}
|
|
7102
7109
|
interface AggregationResultsScalarResult {
|
|
7103
|
-
/** Type of scalar aggregation */
|
|
7110
|
+
/** Type of scalar aggregation. */
|
|
7104
7111
|
type?: ScalarType;
|
|
7105
|
-
/** Value of the scalar aggregation */
|
|
7112
|
+
/** Value of the scalar aggregation. */
|
|
7106
7113
|
value?: number;
|
|
7107
7114
|
}
|
|
7108
7115
|
interface NestedValueAggregationResult {
|
|
7109
|
-
/** Value of the field */
|
|
7116
|
+
/** Value of the field. */
|
|
7110
7117
|
value?: string;
|
|
7111
|
-
/** Nested aggregations */
|
|
7118
|
+
/** Nested aggregations. */
|
|
7112
7119
|
nestedResults?: NestedAggregationResults;
|
|
7113
7120
|
}
|
|
7114
7121
|
interface ValueResult {
|
|
7115
|
-
/** Value of the field */
|
|
7122
|
+
/** Value of the field. */
|
|
7116
7123
|
value?: string;
|
|
7117
|
-
/** Count of entities with this value */
|
|
7124
|
+
/** Count of entities with this value. */
|
|
7118
7125
|
count?: number | null;
|
|
7119
7126
|
}
|
|
7120
7127
|
interface RangeResult {
|
|
7121
|
-
/** Inclusive lower bound of the range */
|
|
7128
|
+
/** Inclusive lower bound of the range. */
|
|
7122
7129
|
from?: number | null;
|
|
7123
|
-
/** Exclusive upper bound of the range */
|
|
7130
|
+
/** Exclusive upper bound of the range. */
|
|
7124
7131
|
to?: number | null;
|
|
7125
|
-
/** Count of entities in this range */
|
|
7132
|
+
/** Count of entities in this range. */
|
|
7126
7133
|
count?: number | null;
|
|
7127
7134
|
}
|
|
7128
7135
|
interface ScalarResult {
|
|
7129
|
-
/** Value of the scalar aggregation */
|
|
7136
|
+
/** Value of the scalar aggregation. */
|
|
7130
7137
|
value?: number;
|
|
7131
7138
|
}
|
|
7132
7139
|
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
7133
|
-
/** Value aggregation result */
|
|
7140
|
+
/** Value aggregation result. */
|
|
7134
7141
|
value?: ValueResult;
|
|
7135
|
-
/** Range aggregation result */
|
|
7142
|
+
/** Range aggregation result. */
|
|
7136
7143
|
range?: RangeResult;
|
|
7137
|
-
/** Scalar aggregation result */
|
|
7144
|
+
/** Scalar aggregation result. */
|
|
7138
7145
|
scalar?: ScalarResult;
|
|
7139
|
-
/** Date histogram aggregation result */
|
|
7146
|
+
/** Date histogram aggregation result. */
|
|
7140
7147
|
dateHistogram?: ValueResult;
|
|
7141
7148
|
}
|
|
7142
7149
|
/** @oneof */
|
|
7143
7150
|
interface NestedResultValueResultOneOf {
|
|
7144
|
-
/** Value aggregation result */
|
|
7151
|
+
/** Value aggregation result. */
|
|
7145
7152
|
value?: ValueResult;
|
|
7146
|
-
/** Range aggregation result */
|
|
7153
|
+
/** Range aggregation result. */
|
|
7147
7154
|
range?: RangeResult;
|
|
7148
|
-
/** Scalar aggregation result */
|
|
7155
|
+
/** Scalar aggregation result. */
|
|
7149
7156
|
scalar?: ScalarResult;
|
|
7150
|
-
/** Date histogram aggregation result */
|
|
7157
|
+
/** Date histogram aggregation result. */
|
|
7151
7158
|
dateHistogram?: ValueResult;
|
|
7152
7159
|
}
|
|
7153
7160
|
interface Results {
|
|
7154
|
-
/** List of nested aggregations */
|
|
7161
|
+
/** List of nested aggregations. */
|
|
7155
7162
|
results?: Record<string, NestedResultValue>;
|
|
7156
7163
|
}
|
|
7157
7164
|
interface DateHistogramResult {
|
|
7158
|
-
/** Date in ISO 8601 format */
|
|
7165
|
+
/** Date in ISO 8601 format. */
|
|
7159
7166
|
value?: string;
|
|
7160
|
-
/** Count of documents in the bucket */
|
|
7167
|
+
/** Count of documents in the bucket. */
|
|
7161
7168
|
count?: number;
|
|
7162
7169
|
}
|
|
7163
7170
|
interface GroupByValueResults {
|
|
7164
|
-
/** List of value aggregations */
|
|
7171
|
+
/** List of value aggregations. */
|
|
7165
7172
|
results?: NestedValueAggregationResult[];
|
|
7166
7173
|
}
|
|
7167
7174
|
interface DateHistogramResults {
|
|
7168
|
-
/** List of date histogram aggregations */
|
|
7175
|
+
/** List of date histogram aggregations. */
|
|
7169
7176
|
results?: DateHistogramResult[];
|
|
7170
7177
|
}
|
|
7171
7178
|
/**
|
|
7172
|
-
* Results of `NESTED` aggregation type in a flattened form
|
|
7173
|
-
*
|
|
7179
|
+
* Results of `NESTED` aggregation type in a flattened form.
|
|
7180
|
+
* Aggregations in resulting array are keyed by requested aggregation `name`.
|
|
7174
7181
|
*/
|
|
7175
7182
|
interface NestedResults {
|
|
7176
|
-
/** List of nested aggregations */
|
|
7183
|
+
/** List of nested aggregations. */
|
|
7177
7184
|
results?: Results[];
|
|
7178
7185
|
}
|
|
7179
7186
|
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
7180
|
-
/** Value aggregation results */
|
|
7187
|
+
/** Value aggregation results. */
|
|
7181
7188
|
values?: ValueResults;
|
|
7182
|
-
/** Range aggregation results */
|
|
7189
|
+
/** Range aggregation results. */
|
|
7183
7190
|
ranges?: RangeResults;
|
|
7184
|
-
/** Scalar aggregation results */
|
|
7191
|
+
/** Scalar aggregation results. */
|
|
7185
7192
|
scalar?: AggregationResultsScalarResult;
|
|
7186
|
-
/** Group by value aggregation results */
|
|
7193
|
+
/** Group by value aggregation results. */
|
|
7187
7194
|
groupedByValue?: GroupByValueResults;
|
|
7188
|
-
/** Date histogram aggregation results */
|
|
7195
|
+
/** Date histogram aggregation results. */
|
|
7189
7196
|
dateHistogram?: DateHistogramResults;
|
|
7190
|
-
/** Nested aggregation results */
|
|
7197
|
+
/** Nested aggregation results. */
|
|
7191
7198
|
nested?: NestedResults;
|
|
7192
|
-
/** User-defined name of aggregation as derived from search request */
|
|
7199
|
+
/** User-defined name of aggregation as derived from search request. */
|
|
7193
7200
|
name?: string;
|
|
7194
|
-
/** Type of aggregation that must match provided kind as derived from search request */
|
|
7201
|
+
/** Type of aggregation that must match provided kind as derived from search request. */
|
|
7195
7202
|
type?: AggregationType;
|
|
7196
|
-
/** Field to aggregate by as derived from search request */
|
|
7203
|
+
/** Field to aggregate by as derived from search request. */
|
|
7197
7204
|
fieldPath?: string;
|
|
7198
7205
|
}
|
|
7199
7206
|
/** @oneof */
|
|
7200
7207
|
interface AggregationResultsResultOneOf {
|
|
7201
|
-
/** Value aggregation results */
|
|
7208
|
+
/** Value aggregation results. */
|
|
7202
7209
|
values?: ValueResults;
|
|
7203
|
-
/** Range aggregation results */
|
|
7210
|
+
/** Range aggregation results. */
|
|
7204
7211
|
ranges?: RangeResults;
|
|
7205
|
-
/** Scalar aggregation results */
|
|
7212
|
+
/** Scalar aggregation results. */
|
|
7206
7213
|
scalar?: AggregationResultsScalarResult;
|
|
7207
|
-
/** Group by value aggregation results */
|
|
7214
|
+
/** Group by value aggregation results. */
|
|
7208
7215
|
groupedByValue?: GroupByValueResults;
|
|
7209
|
-
/** Date histogram aggregation results */
|
|
7216
|
+
/** Date histogram aggregation results. */
|
|
7210
7217
|
dateHistogram?: DateHistogramResults;
|
|
7211
|
-
/** Nested aggregation results */
|
|
7218
|
+
/** Nested aggregation results. */
|
|
7212
7219
|
nested?: NestedResults;
|
|
7213
7220
|
}
|
|
7214
7221
|
interface BulkCreateContentRequest {
|
|
@@ -8067,9 +8074,11 @@ interface UpdateContentSignature {
|
|
|
8067
8074
|
* To remove a field, pass the field key with an empty object as the value. For example:
|
|
8068
8075
|
*
|
|
8069
8076
|
* ```json
|
|
8077
|
+
* {
|
|
8070
8078
|
* "fields": {
|
|
8071
8079
|
* "title": {}
|
|
8072
8080
|
* }
|
|
8081
|
+
* }
|
|
8073
8082
|
* ```
|
|
8074
8083
|
* @param - Translation content ID.
|
|
8075
8084
|
* @returns Updated translation content.
|
|
@@ -8083,10 +8092,12 @@ interface UpdateContentByKeySignature {
|
|
|
8083
8092
|
*
|
|
8084
8093
|
* To remove a field, pass the field key with an empty object as the value. For example:
|
|
8085
8094
|
*
|
|
8086
|
-
* ```
|
|
8095
|
+
* ```json
|
|
8096
|
+
* {
|
|
8087
8097
|
* "fields": {
|
|
8088
8098
|
* "title": {}
|
|
8089
8099
|
* }
|
|
8100
|
+
* }
|
|
8090
8101
|
* ```
|
|
8091
8102
|
* @param - Content to update.
|
|
8092
8103
|
*/
|
|
@@ -8103,13 +8114,20 @@ interface DeleteContentSignature {
|
|
|
8103
8114
|
declare function queryContents$1(httpClient: HttpClient): QueryContentsSignature;
|
|
8104
8115
|
interface QueryContentsSignature {
|
|
8105
8116
|
/**
|
|
8106
|
-
*
|
|
8117
|
+
* Creates a query to retrieve a list of translation content items.
|
|
8107
8118
|
*
|
|
8108
|
-
* The
|
|
8119
|
+
* The `queryContents()` function builds a query to retrieve a list of translation content items and returns a `ContentsQueryBuilder` object.
|
|
8109
8120
|
*
|
|
8110
|
-
*
|
|
8121
|
+
* 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-content/contents-query-builder/find) function.
|
|
8111
8122
|
*
|
|
8112
|
-
*
|
|
8123
|
+
* You can refine the query by chaining `ContentsQueryBuilder` functions onto the query. `ContentsQueryBuilder` functions enable you to filter, sort, and control the results that `queryContents()` returns.
|
|
8124
|
+
*
|
|
8125
|
+
* `queryContents()` runs with the following `ContentsQueryBuilder` defaults which you can override:
|
|
8126
|
+
*
|
|
8127
|
+
* + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-content/contents-query-builder/limit)
|
|
8128
|
+
* + [`ascending('id')`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-content/contents-query-builder/ascending)
|
|
8129
|
+
*
|
|
8130
|
+
* The following `ContentsQueryBuilder` functions are supported for `queryContents()`. 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-content/contents-query-result/items) property in `ContentsQueryResult`.
|
|
8113
8131
|
*/
|
|
8114
8132
|
(options?: QueryContentsOptions | undefined): ContentsQueryBuilder;
|
|
8115
8133
|
}
|
|
@@ -8122,7 +8140,7 @@ interface SearchContentsSignature {
|
|
|
8122
8140
|
*
|
|
8123
8141
|
* Use this method to search translation content fields on a site for a given expression, and/or to perform data aggregations on a site's translation content fields.
|
|
8124
8142
|
*
|
|
8125
|
-
* For field support for filters, sorting, and free-text searching see [Translation Content: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/
|
|
8143
|
+
* For field support for filters, sorting, and free-text searching see [Translation Content: Supported Filters, Sorting, and Search](https://dev.wix.com/docs/rest/business-management/multilingual/translation/translation-content/sort-filter-and-search).
|
|
8126
8144
|
*
|
|
8127
8145
|
* To learn more about working with the search query, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
8128
8146
|
*/
|
|
@@ -8146,9 +8164,11 @@ interface BulkUpdateContentSignature {
|
|
|
8146
8164
|
* To remove a field, pass the field key with an empty object as the value. For example:
|
|
8147
8165
|
*
|
|
8148
8166
|
* ```json
|
|
8167
|
+
* {
|
|
8149
8168
|
* "fields": {
|
|
8150
8169
|
* "title": {}
|
|
8151
8170
|
* }
|
|
8171
|
+
* }
|
|
8152
8172
|
* ```
|
|
8153
8173
|
* @param - Translation content items to update.
|
|
8154
8174
|
*/
|
|
@@ -8162,9 +8182,11 @@ interface BulkUpdateContentByKeySignature {
|
|
|
8162
8182
|
* To remove a field, pass the field key with an empty object as the value. For example:
|
|
8163
8183
|
*
|
|
8164
8184
|
* ```json
|
|
8185
|
+
* {
|
|
8165
8186
|
* "fields": {
|
|
8166
8187
|
* "title": {}
|
|
8167
8188
|
* }
|
|
8189
|
+
* }
|
|
8168
8190
|
* ```
|
|
8169
8191
|
* @param - Translation content items to update.
|
|
8170
8192
|
*/
|
|
@@ -8600,7 +8622,7 @@ interface SchemaField {
|
|
|
8600
8622
|
*/
|
|
8601
8623
|
_id?: string;
|
|
8602
8624
|
/**
|
|
8603
|
-
*
|
|
8625
|
+
* **Required.** Field type.
|
|
8604
8626
|
* Supported values:
|
|
8605
8627
|
* + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
|
|
8606
8628
|
* + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
|
|
@@ -8659,7 +8681,7 @@ interface PreviewFields {
|
|
|
8659
8681
|
}
|
|
8660
8682
|
interface CreateSchemaRequest {
|
|
8661
8683
|
/** Translation schema to create. */
|
|
8662
|
-
schema
|
|
8684
|
+
schema: Schema;
|
|
8663
8685
|
}
|
|
8664
8686
|
interface CreateSchemaResponse {
|
|
8665
8687
|
/** Newly created translation schema. */
|
|
@@ -8683,7 +8705,7 @@ interface GetSchemaByKeyResponse {
|
|
|
8683
8705
|
}
|
|
8684
8706
|
interface UpdateSchemaRequest {
|
|
8685
8707
|
/** Translation schema to update. */
|
|
8686
|
-
schema
|
|
8708
|
+
schema: Schema;
|
|
8687
8709
|
}
|
|
8688
8710
|
interface UpdateSchemaResponse {
|
|
8689
8711
|
/** Updated Schema. */
|
|
@@ -8691,7 +8713,7 @@ interface UpdateSchemaResponse {
|
|
|
8691
8713
|
}
|
|
8692
8714
|
interface DeleteSchemaRequest {
|
|
8693
8715
|
/** ID of the translation schema to delete. */
|
|
8694
|
-
schemaId
|
|
8716
|
+
schemaId: string;
|
|
8695
8717
|
}
|
|
8696
8718
|
interface DeleteSchemaResponse {
|
|
8697
8719
|
}
|
|
@@ -9195,12 +9217,18 @@ interface SchemaKeyNonNullableFields {
|
|
|
9195
9217
|
interface SchemaNonNullableFields {
|
|
9196
9218
|
key?: SchemaKeyNonNullableFields;
|
|
9197
9219
|
}
|
|
9220
|
+
interface CreateSchemaResponseNonNullableFields {
|
|
9221
|
+
schema?: SchemaNonNullableFields;
|
|
9222
|
+
}
|
|
9198
9223
|
interface GetSchemaResponseNonNullableFields {
|
|
9199
9224
|
schema?: SchemaNonNullableFields;
|
|
9200
9225
|
}
|
|
9201
9226
|
interface GetSchemaByKeyResponseNonNullableFields {
|
|
9202
9227
|
schema?: SchemaNonNullableFields;
|
|
9203
9228
|
}
|
|
9229
|
+
interface UpdateSchemaResponseNonNullableFields {
|
|
9230
|
+
schema?: SchemaNonNullableFields;
|
|
9231
|
+
}
|
|
9204
9232
|
interface QuerySchemasResponseNonNullableFields {
|
|
9205
9233
|
schemas: SchemaNonNullableFields[];
|
|
9206
9234
|
}
|
|
@@ -9282,6 +9310,50 @@ interface GetSchemaByKeyIdentifiers {
|
|
|
9282
9310
|
*/
|
|
9283
9311
|
keyScope?: SchemaScope;
|
|
9284
9312
|
}
|
|
9313
|
+
interface UpdateSchema {
|
|
9314
|
+
/**
|
|
9315
|
+
* Translation schema ID.
|
|
9316
|
+
* @readonly
|
|
9317
|
+
*/
|
|
9318
|
+
_id?: string | null;
|
|
9319
|
+
/** Translation schema unique key identifier. */
|
|
9320
|
+
key?: SchemaKey;
|
|
9321
|
+
/** List of fields for the translation schema. This property uses a string to map to a `SchemaField` (`Map<string, SchemaField>`). The string serves as a key, which you'll need to access each field in the schema and when adding translation content. */
|
|
9322
|
+
fields?: Record<string, SchemaField>;
|
|
9323
|
+
/** Fields displayed in content previews. For example, a product name for a product translation schema. */
|
|
9324
|
+
previewFields?: PreviewFields;
|
|
9325
|
+
/**
|
|
9326
|
+
* Whether the translation schema is hidden from the site.
|
|
9327
|
+
*
|
|
9328
|
+
* Default: `false`
|
|
9329
|
+
*/
|
|
9330
|
+
hidden?: boolean | null;
|
|
9331
|
+
/** Translation schema name displayed in the https://support.wix.com/en/article/wix-multilingual-using-the-translation-manager. */
|
|
9332
|
+
displayName?: string | null;
|
|
9333
|
+
/** A reference to the parent schema. For example, if the schema is for a menu item, this property would contain the schema ID of the menu it belongs to. */
|
|
9334
|
+
parentId?: string | null;
|
|
9335
|
+
/**
|
|
9336
|
+
* Revision number, which increments by 1 each time the schema is updated. To prevent conflicting changes, the existing `revision` must be used when updating a schema.
|
|
9337
|
+
* @readonly
|
|
9338
|
+
*/
|
|
9339
|
+
revision?: string | null;
|
|
9340
|
+
/**
|
|
9341
|
+
* Date and time the translation schema was created.
|
|
9342
|
+
* @readonly
|
|
9343
|
+
*/
|
|
9344
|
+
_createdDate?: Date;
|
|
9345
|
+
/**
|
|
9346
|
+
* Date and time the translation schema was updated.
|
|
9347
|
+
* @readonly
|
|
9348
|
+
*/
|
|
9349
|
+
_updatedDate?: Date;
|
|
9350
|
+
/**
|
|
9351
|
+
* Whether to duplicate the translated content when a site containing the translation schema and content is duplicated.
|
|
9352
|
+
*
|
|
9353
|
+
* Default: `false`
|
|
9354
|
+
*/
|
|
9355
|
+
duplicateContent?: boolean | null;
|
|
9356
|
+
}
|
|
9285
9357
|
interface QuerySchemasOptions {
|
|
9286
9358
|
}
|
|
9287
9359
|
interface QueryCursorResult {
|
|
@@ -9357,6 +9429,15 @@ interface ListSiteSchemasOptions {
|
|
|
9357
9429
|
scope?: SchemaScope;
|
|
9358
9430
|
}
|
|
9359
9431
|
|
|
9432
|
+
declare function createSchema$1(httpClient: HttpClient): CreateSchemaSignature;
|
|
9433
|
+
interface CreateSchemaSignature {
|
|
9434
|
+
/**
|
|
9435
|
+
* Creates a translation schema.
|
|
9436
|
+
* @param - Translation schema to create.
|
|
9437
|
+
* @returns Newly created translation schema.
|
|
9438
|
+
*/
|
|
9439
|
+
(schema: Schema): Promise<Schema & SchemaNonNullableFields>;
|
|
9440
|
+
}
|
|
9360
9441
|
declare function getSchema$1(httpClient: HttpClient): GetSchemaSignature;
|
|
9361
9442
|
interface GetSchemaSignature {
|
|
9362
9443
|
/**
|
|
@@ -9373,6 +9454,39 @@ interface GetSchemaByKeySignature {
|
|
|
9373
9454
|
*/
|
|
9374
9455
|
(identifiers: GetSchemaByKeyIdentifiers, key: GetSchemaByKey): Promise<GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields>;
|
|
9375
9456
|
}
|
|
9457
|
+
declare function updateSchema$1(httpClient: HttpClient): UpdateSchemaSignature;
|
|
9458
|
+
interface UpdateSchemaSignature {
|
|
9459
|
+
/**
|
|
9460
|
+
* Updates a translation schema.
|
|
9461
|
+
*
|
|
9462
|
+
* To remove a field, pass the field key with an empty object as the value. For example:
|
|
9463
|
+
*
|
|
9464
|
+
* ```json
|
|
9465
|
+
* {
|
|
9466
|
+
* "fields": {
|
|
9467
|
+
* "title": {}
|
|
9468
|
+
* }
|
|
9469
|
+
* }
|
|
9470
|
+
* ```
|
|
9471
|
+
*
|
|
9472
|
+
* <blockquote class="caution">
|
|
9473
|
+
* <strong>Caution:</strong>
|
|
9474
|
+
*
|
|
9475
|
+
* Removing a schema field makes the corresponding content field unavailable.
|
|
9476
|
+
* </blockquote>
|
|
9477
|
+
* @param - Translation schema ID.
|
|
9478
|
+
* @returns Updated Schema.
|
|
9479
|
+
*/
|
|
9480
|
+
(_id: string | null, schema: UpdateSchema): Promise<Schema & SchemaNonNullableFields>;
|
|
9481
|
+
}
|
|
9482
|
+
declare function deleteSchema$1(httpClient: HttpClient): DeleteSchemaSignature;
|
|
9483
|
+
interface DeleteSchemaSignature {
|
|
9484
|
+
/**
|
|
9485
|
+
* Deletes a translation schema.
|
|
9486
|
+
* @param - ID of the translation schema to delete.
|
|
9487
|
+
*/
|
|
9488
|
+
(schemaId: string): Promise<void>;
|
|
9489
|
+
}
|
|
9376
9490
|
declare function querySchemas$1(httpClient: HttpClient): QuerySchemasSignature;
|
|
9377
9491
|
interface QuerySchemasSignature {
|
|
9378
9492
|
/**
|
|
@@ -9420,8 +9534,11 @@ declare global {
|
|
|
9420
9534
|
|
|
9421
9535
|
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
9422
9536
|
|
|
9537
|
+
declare const createSchema: MaybeContext<BuildRESTFunction<typeof createSchema$1> & typeof createSchema$1>;
|
|
9423
9538
|
declare const getSchema: MaybeContext<BuildRESTFunction<typeof getSchema$1> & typeof getSchema$1>;
|
|
9424
9539
|
declare const getSchemaByKey: MaybeContext<BuildRESTFunction<typeof getSchemaByKey$1> & typeof getSchemaByKey$1>;
|
|
9540
|
+
declare const updateSchema: MaybeContext<BuildRESTFunction<typeof updateSchema$1> & typeof updateSchema$1>;
|
|
9541
|
+
declare const deleteSchema: MaybeContext<BuildRESTFunction<typeof deleteSchema$1> & typeof deleteSchema$1>;
|
|
9425
9542
|
declare const querySchemas: MaybeContext<BuildRESTFunction<typeof querySchemas$1> & typeof querySchemas$1>;
|
|
9426
9543
|
declare const listSiteSchemas: MaybeContext<BuildRESTFunction<typeof listSiteSchemas$1> & typeof listSiteSchemas$1>;
|
|
9427
9544
|
|
|
@@ -9448,6 +9565,7 @@ type index_d_Asset = Asset;
|
|
|
9448
9565
|
type index_d_BaseEventMetadata = BaseEventMetadata;
|
|
9449
9566
|
type index_d_CreateSchemaRequest = CreateSchemaRequest;
|
|
9450
9567
|
type index_d_CreateSchemaResponse = CreateSchemaResponse;
|
|
9568
|
+
type index_d_CreateSchemaResponseNonNullableFields = CreateSchemaResponseNonNullableFields;
|
|
9451
9569
|
type index_d_CursorPaging = CursorPaging;
|
|
9452
9570
|
type index_d_CursorPagingMetadata = CursorPagingMetadata;
|
|
9453
9571
|
type index_d_CursorQuery = CursorQuery;
|
|
@@ -9525,13 +9643,17 @@ type index_d_State = State;
|
|
|
9525
9643
|
declare const index_d_State: typeof State;
|
|
9526
9644
|
type index_d_StudioAssigned = StudioAssigned;
|
|
9527
9645
|
type index_d_StudioUnassigned = StudioUnassigned;
|
|
9646
|
+
type index_d_UpdateSchema = UpdateSchema;
|
|
9528
9647
|
type index_d_UpdateSchemaRequest = UpdateSchemaRequest;
|
|
9529
9648
|
type index_d_UpdateSchemaResponse = UpdateSchemaResponse;
|
|
9649
|
+
type index_d_UpdateSchemaResponseNonNullableFields = UpdateSchemaResponseNonNullableFields;
|
|
9530
9650
|
type index_d_WebhookIdentityType = WebhookIdentityType;
|
|
9531
9651
|
declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
|
|
9532
9652
|
type index_d__publicOnSchemaCreatedType = _publicOnSchemaCreatedType;
|
|
9533
9653
|
type index_d__publicOnSchemaDeletedType = _publicOnSchemaDeletedType;
|
|
9534
9654
|
type index_d__publicOnSchemaUpdatedType = _publicOnSchemaUpdatedType;
|
|
9655
|
+
declare const index_d_createSchema: typeof createSchema;
|
|
9656
|
+
declare const index_d_deleteSchema: typeof deleteSchema;
|
|
9535
9657
|
declare const index_d_getSchema: typeof getSchema;
|
|
9536
9658
|
declare const index_d_getSchemaByKey: typeof getSchemaByKey;
|
|
9537
9659
|
declare const index_d_listSiteSchemas: typeof listSiteSchemas;
|
|
@@ -9539,8 +9661,9 @@ declare const index_d_onSchemaCreated: typeof onSchemaCreated;
|
|
|
9539
9661
|
declare const index_d_onSchemaDeleted: typeof onSchemaDeleted;
|
|
9540
9662
|
declare const index_d_onSchemaUpdated: typeof onSchemaUpdated;
|
|
9541
9663
|
declare const index_d_querySchemas: typeof querySchemas;
|
|
9664
|
+
declare const index_d_updateSchema: typeof updateSchema;
|
|
9542
9665
|
declare namespace index_d {
|
|
9543
|
-
export { type index_d_ActionEvent as ActionEvent, type index_d_Asset as Asset, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CreateSchemaRequest as CreateSchemaRequest, type index_d_CreateSchemaResponse as CreateSchemaResponse, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DeleteContext as DeleteContext, type index_d_DeleteSchemaRequest as DeleteSchemaRequest, type index_d_DeleteSchemaResponse as DeleteSchemaResponse, index_d_DeleteStatus as DeleteStatus, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, index_d_FieldType as FieldType, type index_d_GetSchemaByKey as GetSchemaByKey, type index_d_GetSchemaByKeyIdentifiers as GetSchemaByKeyIdentifiers, type index_d_GetSchemaByKeyRequest as GetSchemaByKeyRequest, type index_d_GetSchemaByKeyResponse as GetSchemaByKeyResponse, type index_d_GetSchemaByKeyResponseNonNullableFields as GetSchemaByKeyResponseNonNullableFields, type index_d_GetSchemaRequest as GetSchemaRequest, type index_d_GetSchemaResponse as GetSchemaResponse, type index_d_GetSchemaResponseNonNullableFields as GetSchemaResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_ListSiteSchemasOptions as ListSiteSchemasOptions, type index_d_ListSiteSchemasRequest as ListSiteSchemasRequest, type index_d_ListSiteSchemasResponse as ListSiteSchemasResponse, type index_d_ListSiteSchemasResponseNonNullableFields as ListSiteSchemasResponseNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type index_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, index_d_Namespace as Namespace, type index_d_NamespaceChanged as NamespaceChanged, type index_d_PreviewFields as PreviewFields, type index_d_QuerySchemasOptions as QuerySchemasOptions, type index_d_QuerySchemasRequest as QuerySchemasRequest, type index_d_QuerySchemasResponse as QuerySchemasResponse, type index_d_QuerySchemasResponseNonNullableFields as QuerySchemasResponseNonNullableFields, type index_d_RestoreInfo as RestoreInfo, type index_d_Schema as Schema, type index_d_SchemaCreatedEnvelope as SchemaCreatedEnvelope, type index_d_SchemaDeletedEnvelope as SchemaDeletedEnvelope, type index_d_SchemaField as SchemaField, type index_d_SchemaKey as SchemaKey, type index_d_SchemaNonNullableFields as SchemaNonNullableFields, index_d_SchemaScope as SchemaScope, type index_d_SchemaUpdatedEnvelope as SchemaUpdatedEnvelope, type index_d_SchemasQueryBuilder as SchemasQueryBuilder, type index_d_SchemasQueryResult as SchemasQueryResult, type index_d_ServiceProvisioned as ServiceProvisioned, type index_d_ServiceRemoved as ServiceRemoved, type index_d_SiteCreated as SiteCreated, index_d_SiteCreatedContext as SiteCreatedContext, type index_d_SiteDeleted as SiteDeleted, type index_d_SiteHardDeleted as SiteHardDeleted, type index_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type index_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type index_d_SitePublished as SitePublished, type index_d_SiteRenamed as SiteRenamed, type index_d_SiteTransferred as SiteTransferred, type index_d_SiteUndeleted as SiteUndeleted, type index_d_SiteUnpublished as SiteUnpublished, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_State as State, type index_d_StudioAssigned as StudioAssigned, type index_d_StudioUnassigned as StudioUnassigned, type index_d_UpdateSchemaRequest as UpdateSchemaRequest, type index_d_UpdateSchemaResponse as UpdateSchemaResponse, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnSchemaCreatedType as _publicOnSchemaCreatedType, type index_d__publicOnSchemaDeletedType as _publicOnSchemaDeletedType, type index_d__publicOnSchemaUpdatedType as _publicOnSchemaUpdatedType, index_d_getSchema as getSchema, index_d_getSchemaByKey as getSchemaByKey, index_d_listSiteSchemas as listSiteSchemas, index_d_onSchemaCreated as onSchemaCreated, index_d_onSchemaDeleted as onSchemaDeleted, index_d_onSchemaUpdated as onSchemaUpdated, onSchemaCreated$1 as publicOnSchemaCreated, onSchemaDeleted$1 as publicOnSchemaDeleted, onSchemaUpdated$1 as publicOnSchemaUpdated, index_d_querySchemas as querySchemas };
|
|
9666
|
+
export { type index_d_ActionEvent as ActionEvent, type index_d_Asset as Asset, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CreateSchemaRequest as CreateSchemaRequest, type index_d_CreateSchemaResponse as CreateSchemaResponse, type index_d_CreateSchemaResponseNonNullableFields as CreateSchemaResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DeleteContext as DeleteContext, type index_d_DeleteSchemaRequest as DeleteSchemaRequest, type index_d_DeleteSchemaResponse as DeleteSchemaResponse, index_d_DeleteStatus as DeleteStatus, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, index_d_FieldType as FieldType, type index_d_GetSchemaByKey as GetSchemaByKey, type index_d_GetSchemaByKeyIdentifiers as GetSchemaByKeyIdentifiers, type index_d_GetSchemaByKeyRequest as GetSchemaByKeyRequest, type index_d_GetSchemaByKeyResponse as GetSchemaByKeyResponse, type index_d_GetSchemaByKeyResponseNonNullableFields as GetSchemaByKeyResponseNonNullableFields, type index_d_GetSchemaRequest as GetSchemaRequest, type index_d_GetSchemaResponse as GetSchemaResponse, type index_d_GetSchemaResponseNonNullableFields as GetSchemaResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_ListSiteSchemasOptions as ListSiteSchemasOptions, type index_d_ListSiteSchemasRequest as ListSiteSchemasRequest, type index_d_ListSiteSchemasResponse as ListSiteSchemasResponse, type index_d_ListSiteSchemasResponseNonNullableFields as ListSiteSchemasResponseNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type index_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, index_d_Namespace as Namespace, type index_d_NamespaceChanged as NamespaceChanged, type index_d_PreviewFields as PreviewFields, type index_d_QuerySchemasOptions as QuerySchemasOptions, type index_d_QuerySchemasRequest as QuerySchemasRequest, type index_d_QuerySchemasResponse as QuerySchemasResponse, type index_d_QuerySchemasResponseNonNullableFields as QuerySchemasResponseNonNullableFields, type index_d_RestoreInfo as RestoreInfo, type index_d_Schema as Schema, type index_d_SchemaCreatedEnvelope as SchemaCreatedEnvelope, type index_d_SchemaDeletedEnvelope as SchemaDeletedEnvelope, type index_d_SchemaField as SchemaField, type index_d_SchemaKey as SchemaKey, type index_d_SchemaNonNullableFields as SchemaNonNullableFields, index_d_SchemaScope as SchemaScope, type index_d_SchemaUpdatedEnvelope as SchemaUpdatedEnvelope, type index_d_SchemasQueryBuilder as SchemasQueryBuilder, type index_d_SchemasQueryResult as SchemasQueryResult, type index_d_ServiceProvisioned as ServiceProvisioned, type index_d_ServiceRemoved as ServiceRemoved, type index_d_SiteCreated as SiteCreated, index_d_SiteCreatedContext as SiteCreatedContext, type index_d_SiteDeleted as SiteDeleted, type index_d_SiteHardDeleted as SiteHardDeleted, type index_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type index_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type index_d_SitePublished as SitePublished, type index_d_SiteRenamed as SiteRenamed, type index_d_SiteTransferred as SiteTransferred, type index_d_SiteUndeleted as SiteUndeleted, type index_d_SiteUnpublished as SiteUnpublished, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_State as State, type index_d_StudioAssigned as StudioAssigned, type index_d_StudioUnassigned as StudioUnassigned, type index_d_UpdateSchema as UpdateSchema, type index_d_UpdateSchemaRequest as UpdateSchemaRequest, type index_d_UpdateSchemaResponse as UpdateSchemaResponse, type index_d_UpdateSchemaResponseNonNullableFields as UpdateSchemaResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnSchemaCreatedType as _publicOnSchemaCreatedType, type index_d__publicOnSchemaDeletedType as _publicOnSchemaDeletedType, type index_d__publicOnSchemaUpdatedType as _publicOnSchemaUpdatedType, index_d_createSchema as createSchema, index_d_deleteSchema as deleteSchema, index_d_getSchema as getSchema, index_d_getSchemaByKey as getSchemaByKey, index_d_listSiteSchemas as listSiteSchemas, index_d_onSchemaCreated as onSchemaCreated, index_d_onSchemaDeleted as onSchemaDeleted, index_d_onSchemaUpdated as onSchemaUpdated, onSchemaCreated$1 as publicOnSchemaCreated, onSchemaDeleted$1 as publicOnSchemaDeleted, onSchemaUpdated$1 as publicOnSchemaUpdated, index_d_querySchemas as querySchemas, index_d_updateSchema as updateSchema };
|
|
9544
9667
|
}
|
|
9545
9668
|
|
|
9546
9669
|
export { index_d$5 as entityMapper, index_d$3 as machineTranslation, index_d$2 as siteTranslator, index_d$1 as translationContents, index_d$4 as translationPublishedContents, index_d as translationSchemas };
|