@gradientedge/commercetools-utils 5.27.2 → 5.28.0

package/dist/cjs/types/models/search.d.ts

@@ -0,0 +1,334 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+/**
+ *	Possible values for the `fieldType` property on [query expressions](/../api/search-query-language#query-expressions) indicating the data type of the `field`.
+ */
+export type SearchFieldType = 'boolean' | 'date' | 'datetime' | 'enum' | 'lenum' | 'ltext' | 'money' | 'number' | 'reference' | 'set_boolean' | 'set_date' | 'set_datetime' | 'set_enum' | 'set_lenum' | 'set_ltext' | 'set_money' | 'set_number' | 'set_reference' | 'set_text' | 'set_time' | 'text' | 'time' | string;
+export type SearchMatchType = 'all' | 'any' | string;
+export interface SearchMatchingVariant {
+    /**
+     *	Unique identifier of the variant.
+     *
+     */
+    readonly id: number;
+    /**
+     *	SKU of the matching variant.
+     *
+     */
+    readonly sku?: string;
+}
+export interface SearchQuery {
+}
+export type _SearchQuery = SearchQuery | _SearchCompoundExpression | _SearchQueryExpression;
+export interface SearchCompoundExpression extends SearchQuery {
+}
+export type _SearchCompoundExpression = SearchCompoundExpression | SearchAndExpression | SearchFilterExpression | SearchNotExpression | SearchOrExpression;
+export interface SearchAndExpression extends SearchCompoundExpression {
+    /**
+     *
+     */
+    readonly and: SearchQuery[];
+}
+export interface SearchFilterExpression extends SearchCompoundExpression {
+    /**
+     *
+     */
+    readonly filter: SearchQueryExpression[];
+}
+export interface SearchNotExpression extends SearchCompoundExpression {
+    /**
+     *
+     */
+    readonly not: SearchQuery[];
+}
+export interface SearchOrExpression extends SearchCompoundExpression {
+    /**
+     *
+     */
+    readonly or: SearchQuery[];
+}
+export interface SearchQueryExpression extends SearchQuery {
+}
+export type _SearchQueryExpression = SearchQueryExpression | SearchDateRangeExpression | SearchDateTimeRangeExpression | SearchExactExpression | SearchExistsExpression | SearchFullTextExpression | SearchFullTextPrefixExpression | SearchLongRangeExpression | SearchNumberRangeExpression | SearchPrefixExpression | SearchTimeRangeExpression | SearchWildCardExpression;
+export interface SearchDateRangeExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly range: SearchDateRangeValue;
+}
+export interface SearchDateTimeRangeExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly range: SearchDateTimeRangeValue;
+}
+export interface SearchExactExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly exact: SearchAnyValue;
+}
+export interface SearchExistsExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly exists: SearchExistsValue;
+}
+export interface SearchFullTextExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly fullText: SearchFullTextValue;
+}
+export interface SearchFullTextPrefixExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly fullTextPrefix: SearchFullTextPrefixValue;
+}
+export interface SearchLongRangeExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly range: SearchLongRangeValue;
+}
+export interface SearchNumberRangeExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly range: SearchNumberRangeValue;
+}
+export interface SearchPrefixExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly prefix: SearchAnyValue;
+}
+export interface SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly field: string;
+    /**
+     *
+     */
+    readonly boost?: number;
+    /**
+     *	Possible values for the `fieldType` property on [query expressions](/../api/search-query-language#query-expressions) indicating the data type of the `field`.
+     *
+     */
+    readonly fieldType?: SearchFieldType;
+}
+export type _SearchQueryExpressionValue = SearchQueryExpressionValue | SearchAnyValue | SearchDateRangeValue | SearchDateTimeRangeValue | SearchExistsValue | SearchFullTextPrefixValue | SearchFullTextValue | SearchLongRangeValue | SearchNumberRangeValue | SearchTimeRangeValue;
+export interface SearchAnyValue extends SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly value: any;
+    /**
+     *	String value specifying linguistic and regional preferences using the [IETF language tag format](https://en.wikipedia.org/wiki/IETF_language_tag), as described in [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). The format combines language, script, and region using hyphen-separated subtags. For example: `en`, `en-US`, `zh-Hans-SG`.
+     *
+     *
+     */
+    readonly language?: string;
+    /**
+     *
+     */
+    readonly caseInsensitive?: boolean;
+}
+export interface SearchDateRangeValue extends SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly gte?: string;
+    /**
+     *
+     */
+    readonly gt?: string;
+    /**
+     *
+     */
+    readonly lte?: string;
+    /**
+     *
+     */
+    readonly lt?: string;
+}
+export interface SearchDateTimeRangeValue extends SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly gte?: string;
+    /**
+     *
+     */
+    readonly gt?: string;
+    /**
+     *
+     */
+    readonly lte?: string;
+    /**
+     *
+     */
+    readonly lt?: string;
+}
+export interface SearchExistsValue extends SearchQueryExpressionValue {
+    /**
+     *	String value specifying linguistic and regional preferences using the [IETF language tag format](https://en.wikipedia.org/wiki/IETF_language_tag), as described in [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). The format combines language, script, and region using hyphen-separated subtags. For example: `en`, `en-US`, `zh-Hans-SG`.
+     *
+     *
+     */
+    readonly language?: string;
+}
+export interface SearchFullTextPrefixValue extends SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly value: any;
+    /**
+     *	String value specifying linguistic and regional preferences using the [IETF language tag format](https://en.wikipedia.org/wiki/IETF_language_tag), as described in [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). The format combines language, script, and region using hyphen-separated subtags. For example: `en`, `en-US`, `zh-Hans-SG`.
+     *
+     *
+     */
+    readonly language?: string;
+    /**
+     *
+     */
+    readonly mustMatch?: SearchMatchType;
+}
+export interface SearchFullTextValue extends SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly value: any;
+    /**
+     *	String value specifying linguistic and regional preferences using the [IETF language tag format](https://en.wikipedia.org/wiki/IETF_language_tag), as described in [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). The format combines language, script, and region using hyphen-separated subtags. For example: `en`, `en-US`, `zh-Hans-SG`.
+     *
+     *
+     */
+    readonly language?: string;
+    /**
+     *
+     */
+    readonly mustMatch?: SearchMatchType;
+}
+export interface SearchLongRangeValue extends SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly gte?: number;
+    /**
+     *
+     */
+    readonly gt?: number;
+    /**
+     *
+     */
+    readonly lte?: number;
+    /**
+     *
+     */
+    readonly lt?: number;
+}
+export interface SearchNumberRangeValue extends SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly gte?: number;
+    /**
+     *
+     */
+    readonly gt?: number;
+    /**
+     *
+     */
+    readonly lte?: number;
+    /**
+     *
+     */
+    readonly lt?: number;
+}
+/**
+ *	For set-type fields, only a single value of the set is taken into account for sorting.
+ *	The sort mode determines whether the minimum or maximum value, or a calculated statistical value should be used as sorting value.
+ *
+ */
+export type SearchSortMode = 'avg' | 'max' | 'min' | 'sum' | string;
+export type SearchSortOrder = 'asc' | 'desc' | string;
+/**
+ *	Sorting parameters provided with a Search request.
+ *
+ */
+export interface SearchSorting {
+    /**
+     *	Use any searchable field of the resource as sort criterion, or `"score"` to sort by relevance score calculated by the API.
+     *
+     *
+     */
+    readonly field: string;
+    /**
+     *	String value specifying linguistic and regional preferences using the [IETF language tag format](https://en.wikipedia.org/wiki/IETF_language_tag), as described in [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). The format combines language, script, and region using hyphen-separated subtags. For example: `en`, `en-US`, `zh-Hans-SG`.
+     *
+     *
+     */
+    readonly language?: string;
+    /**
+     *	Specify the order in which the search results should be sorted.
+     *	Can be `asc` for ascending, or `desc` for descending order.
+     *
+     *
+     */
+    readonly order: SearchSortOrder;
+    /**
+     *	Specify the sort mode to be applied for a set-type `field`.
+     *
+     *
+     */
+    readonly mode?: SearchSortMode;
+    /**
+     *	Provide the data type of the given `field`.
+     *
+     *
+     */
+    readonly fieldType?: SearchFieldType;
+    /**
+     *	Allows you to apply a [sort filter](/../api/search-query-language#sort-filter).
+     *
+     *
+     */
+    readonly filter?: _SearchQueryExpression;
+}
+export interface SearchTimeRangeExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly range: SearchTimeRangeValue;
+}
+export interface SearchTimeRangeValue extends SearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly gte?: string;
+    /**
+     *
+     */
+    readonly gt?: string;
+    /**
+     *
+     */
+    readonly lte?: string;
+    /**
+     *
+     */
+    readonly lt?: string;
+}
+export interface SearchWildCardExpression extends SearchQueryExpression {
+    /**
+     *
+     */
+    readonly wildcard: SearchAnyValue;
+}
+//# sourceMappingURL=search.d.ts.map

package/dist/cjs/types/models/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/models/search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,WAAW,GACX,aAAa,GACb,UAAU,GACV,cAAc,GACd,UAAU,GACV,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,eAAe,GACf,UAAU,GACV,UAAU,GACV,MAAM,GACN,MAAM,GACN,MAAM,CAAA;AACV,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AACpD,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,WAAW;CAAG;AAC/B,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,yBAAyB,GAAG,sBAAsB,CAAA;AAC3F,MAAM,WAAW,wBAAyB,SAAQ,WAAW;CAAG;AAChE,MAAM,MAAM,yBAAyB,GACjC,wBAAwB,GACxB,mBAAmB,GACnB,sBAAsB,GACtB,mBAAmB,GACnB,kBAAkB,CAAA;AACtB,MAAM,WAAW,mBAAoB,SAAQ,wBAAwB;IACnE;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,CAAA;CAC5B;AACD,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;IACtE;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,CAAA;CACzC;AACD,MAAM,WAAW,mBAAoB,SAAQ,wBAAwB;IACnE;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,CAAA;CAC5B;AACD,MAAM,WAAW,kBAAmB,SAAQ,wBAAwB;IAClE;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,WAAW,EAAE,CAAA;CAC3B;AACD,MAAM,WAAW,qBAAsB,SAAQ,WAAW;CAAG;AAC7D,MAAM,MAAM,sBAAsB,GAC9B,qBAAqB,GACrB,yBAAyB,GACzB,6BAA6B,GAC7B,qBAAqB,GACrB,sBAAsB,GACtB,wBAAwB,GACxB,8BAA8B,GAC9B,yBAAyB,GACzB,2BAA2B,GAC3B,sBAAsB,GACtB,yBAAyB,GACzB,wBAAwB,CAAA;AAC5B,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAAA;CACrC;AACD,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,wBAAwB,CAAA;CACzC;AACD,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAA;CAC/B;AACD,MAAM,WAAW,sBAAuB,SAAQ,qBAAqB;IACnE;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;CACnC;AACD,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACrE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAA;CACvC;AACD,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAC3E;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,yBAAyB,CAAA;CACnD;AACD,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAAA;CACrC;AACD,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,sBAAsB,CAAA;CACvC;AACD,MAAM,WAAW,sBAAuB,SAAQ,qBAAqB;IACnE;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAA;CAChC;AACD,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAA;CACrC;AACD,MAAM,MAAM,2BAA2B,GACnC,0BAA0B,GAC1B,cAAc,GACd,oBAAoB,GACpB,wBAAwB,GACxB,iBAAiB,GACjB,yBAAyB,GACzB,mBAAmB,GACnB,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,CAAA;AACxB,MAAM,WAAW,cAAe,SAAQ,0BAA0B;IAChE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;CACnC;AACD,MAAM,WAAW,oBAAqB,SAAQ,0BAA0B;IACtE;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,wBAAyB,SAAQ,0BAA0B;IAC1E;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,iBAAkB,SAAQ,0BAA0B;IACnE;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAC3B;AACD,MAAM,WAAW,yBAA0B,SAAQ,0BAA0B;IAC3E;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAA;CACrC;AACD,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;IACrE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAA;CACrC;AACD,MAAM,WAAW,oBAAqB,SAAQ,0BAA0B;IACtE;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,sBAAuB,SAAQ,0BAA0B;IACxE;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CACrB;AACD;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AACnE,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;AACrD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,sBAAsB,CAAA;CACzC;AACD,MAAM,WAAW,yBAA0B,SAAQ,qBAAqB;IACtE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAAA;CACrC;AACD,MAAM,WAAW,oBAAqB,SAAQ,0BAA0B;IACtE;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACrE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAA;CAClC"}

package/dist/cjs/types/models/search.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=search.js.map

package/dist/cjs/types/models/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../../src/lib/types/models/search.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}