@attlaz/client 1.89.0 → 1.90.0

package/dist/Pulse/Service/PulseStatisticsEndpoint.d.ts

@@ -3,6 +3,8 @@ import { CollectionResult } from '../../Model/Result/CollectionResult.js';
 import { Endpoint } from '../../Service/Endpoint.js';
 import { PriceIndexSnapshotEntry } from '../Model/PriceIndexSnapshotEntry.js';
 import { TopCompetitor } from '../Model/TopCompetitor.js';
+/** Which axis the products are bucketed on. */
+export type ProductSegmentType = 'price' | 'profit';
 /** How many products fall in a segment now versus the previous period. */
 export type ProductsSegment = {
     code: string;
@@ -24,9 +26,19 @@ export declare class PulseStatisticsEndpoint extends Endpoint {
     /** Headline figures (products tracked, matches, competitors …) against the previous period. */
     getAccountSummary(catalogId: CatalogId | string): Promise<CollectionResult<MarketSummaryEntry>>;
     /** Distribution of the catalog's products across price or profit segments. */
-    getProductSegments(catalogId: CatalogId | string): Promise<CollectionResult<ProductsSegment>>;
-    /** The competitors with the most matches against this catalog. */
-    getTopCompetitors(catalogId: CatalogId | string): Promise<CollectionResult<TopCompetitor>>;
-    /** Price index per competitor over time, for charting. */
-    getPriceIndexHistory(catalogId: CatalogId | string, competitor?: string | null): Promise<CollectionResult<PriceIndexSnapshotEntry>>;
+    getProductSegments(catalogId: CatalogId | string, type?: ProductSegmentType | null): Promise<CollectionResult<ProductsSegment>>;
+    /**
+     * The competitors with the most matches against this catalog. `period` is the number of days
+     * the comparison against the previous period spans.
+     */
+    getTopCompetitors(catalogId: CatalogId | string, limit?: number | null, period?: number | null): Promise<CollectionResult<TopCompetitor>>;
+    /**
+     * Price index per competitor over time, for charting. Pass the competitors to include, and
+     * optionally a product group to scope to and a date range (`YYYY-MM-DD`).
+     */
+    getPriceIndexHistory(catalogId: CatalogId | string, competitorIds?: string[], options?: {
+        group?: string;
+        from?: string;
+        to?: string;
+    }): Promise<CollectionResult<PriceIndexSnapshotEntry>>;
 }

package/dist/Pulse/Service/PulseStatisticsEndpoint.js

@@ -17,22 +17,48 @@ export class PulseStatisticsEndpoint extends Endpoint {
         }));
     }
     /** Distribution of the catalog's products across price or profit segments. */
-    async getProductSegments(catalogId) {
-        return await this.requestCollection('/pulse/catalogs/' + catalogId.toString() + '/statistics/product-segments', (raw) => ({
+    async getProductSegments(catalogId, type = null) {
+        const queryString = new QueryString('/pulse/catalogs/' + catalogId.toString() + '/statistics/product-segments');
+        if (type !== null) {
+            queryString.set('type', type);
+        }
+        return await this.requestCollection(queryString, (raw) => ({
             code: raw.code,
             current: raw.current ?? 0,
             previous: raw.previous ?? 0,
         }));
     }
-    /** The competitors with the most matches against this catalog. */
-    async getTopCompetitors(catalogId) {
-        return await this.requestCollection('/pulse/catalogs/' + catalogId.toString() + '/statistics/top-competitors', TopCompetitor.parse);
+    /**
+     * The competitors with the most matches against this catalog. `period` is the number of days
+     * the comparison against the previous period spans.
+     */
+    async getTopCompetitors(catalogId, limit = null, period = null) {
+        const queryString = new QueryString('/pulse/catalogs/' + catalogId.toString() + '/statistics/top-competitors');
+        if (limit !== null) {
+            queryString.set('limit', limit);
+        }
+        if (period !== null) {
+            queryString.set('period', period);
+        }
+        return await this.requestCollection(queryString, TopCompetitor.parse);
     }
-    /** Price index per competitor over time, for charting. */
-    async getPriceIndexHistory(catalogId, competitor = null) {
+    /**
+     * Price index per competitor over time, for charting. Pass the competitors to include, and
+     * optionally a product group to scope to and a date range (`YYYY-MM-DD`).
+     */
+    async getPriceIndexHistory(catalogId, competitorIds = [], options = {}) {
         const queryString = new QueryString('/pulse/catalogs/' + catalogId.toString() + '/statistics/price-index-history');
-        if (competitor !== null) {
-            queryString.set('competitor', competitor);
+        if (competitorIds.length > 0) {
+            queryString.set('competitor', competitorIds.join(','));
+        }
+        if (options.group) {
+            queryString.set('group', options.group);
+        }
+        if (options.from) {
+            queryString.set('from', options.from);
+        }
+        if (options.to) {
+            queryString.set('to', options.to);
         }
         return await this.requestCollection(queryString, PriceIndexSnapshotEntry.parse);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@attlaz/client",
-  "version": "1.89.0",
+  "version": "1.90.0",
   "description": "Javascript Client to access Attlaz API",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",