@gradientedge/commercetools-utils 5.30.0 → 5.31.0

package/dist/cjs/types/models/business-unit-search.d.ts

@@ -0,0 +1,114 @@
+/**
+ * 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/.
+ */
+import { BusinessUnitIndexingStatus } from './project.js';
+import { SearchSorting, _SearchQuery } from './search.js';
+export interface BusinessUnitIndexingProgress {
+    /**
+     *	The number of Business Units successfully indexed.
+     *
+     */
+    readonly indexed: number;
+    /**
+     *	The number of Business Units that failed to be indexed.
+     *
+     */
+    readonly failed: number;
+    /**
+     *	The estimated total number of Business Units to be indexed.
+     *
+     */
+    readonly estimatedTotal: number;
+}
+export interface BusinessUnitPagedSearchResponse {
+    /**
+     *	Total number of results matching the query.
+     *
+     */
+    readonly total: number;
+    /**
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
+     */
+    readonly limit: number;
+    /**
+     *	Number of [elements skipped](/../api/general-concepts#offset).
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *	Search result containing the Business Units matching the search query.
+     *
+     *
+     */
+    readonly results: BusinessUnitSearchResult[];
+}
+export interface BusinessUnitSearchIndexingStatusResponse {
+    /**
+     *	Current status of indexing the Business Unit Search.
+     *
+     */
+    readonly status: BusinessUnitIndexingStatus;
+    /**
+     *	Progress of indexing. Only available when indexing is in progress.
+     *
+     */
+    readonly states?: BusinessUnitIndexingProgress;
+    /**
+     *	Date and time (UTC) when the last indexing started.
+     *
+     */
+    readonly startedAt?: string;
+    /**
+     *	Time when the status was last modified.
+     *
+     */
+    readonly lastModifiedAt?: string;
+    /**
+     *	Indicates how many times the system tried to start indexing after failed attempts. The counter is set to null after an indexing finished successfully.
+     *
+     *
+     */
+    readonly retryCount?: number;
+}
+export interface BusinessUnitSearchRequest {
+    /**
+     *	The Business Unit Search query.
+     *
+     */
+    readonly query?: _SearchQuery;
+    /**
+     *	Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.
+     *
+     */
+    readonly sort?: SearchSorting[];
+    /**
+     *	The maximum number of search results to be returned.
+     *
+     */
+    readonly limit?: number;
+    /**
+     *	The number of search results to be skipped in the response for pagination.
+     *
+     */
+    readonly offset?: number;
+}
+export interface BusinessUnitSearchResult {
+    /**
+     *	`id` of the [BusinessUnit](ctp:api:type:BusinessUnit) matching the search query.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	How closely this customer matches the search query.
+     *
+     *
+     */
+    readonly relevance: number;
+}
+//# sourceMappingURL=business-unit-search.d.ts.map

package/dist/cjs/types/models/business-unit-search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"business-unit-search.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/models/business-unit-search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAA;AACzD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAEzD,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;CAChC;AACD,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,wBAAwB,EAAE,CAAA;CAC7C;AACD,MAAM,WAAW,wCAAwC;IACvD;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,0BAA0B,CAAA;IAC3C;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,4BAA4B,CAAA;IAC9C;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAC7B;AACD,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,CAAA;IAC/B;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AACD,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B"}

package/dist/cjs/types/models/business-unit-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=business-unit-search.js.map

package/dist/cjs/types/models/business-unit-search.js.map

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