@passly-nl/data 1.2.1 → 1.3.0

package/src/service/MerchantStatisticsSalesService.ts

@@ -1,8 +1,7 @@
 import { BaseResponse, BaseService, QueryString } from '@basmilius/http-client';
-import type { ApexOptions } from 'apexcharts';
 import type { DateTime } from 'luxon';
-import { StatisticsSalesAdapter } from '#data/adapter';
-import type { StatisticsSalesLifetimeTotalsDto, StatisticsSalesPurchaseBehaviorDto, StatisticsSalesTransactionSuccessRateDto } from '#data/dto';
+import { StatisticsChartAdapter, StatisticsSalesAdapter } from '#data/adapter';
+import type { StatisticsChartDto, StatisticsPieChartDto, StatisticsSalesDiscountEfficacyDto, StatisticsSalesFailedTransactionReasonDto, StatisticsSalesLifetimeTotalsDto, StatisticsSalesOrderValueDistributionDto, StatisticsSalesPurchaseBehaviorDto, StatisticsSalesRepeatPurchaseVelocityDto, StatisticsSalesTransactionSuccessRateDto } from '#data/dto';
 
 export class MerchantStatisticsSalesService extends BaseService {
     async getLifetimeTotals(merchantId: string): Promise<BaseResponse<StatisticsSalesLifetimeTotalsDto>> {
@@ -15,14 +14,14 @@ export class MerchantStatisticsSalesService extends BaseService {
             .runAdapter(StatisticsSalesAdapter.parseLifetimeTotals);
     }
 
-    async getPaymentMethodsChart(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<ApexOptions>> {
+    async getPaymentMethodsChart(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsPieChartDto>> {
         return await this
             .request(`/merchants/${merchantId}/statistics/sales/payment-methods-chart/${from.toSQLDate()}/${to.toSQLDate()}`)
             .method('get')
             .queryString(QueryString.builder()
                 .append('language', 'nl'))
             .bearerToken()
-            .run();
+            .runAdapter(StatisticsChartAdapter.parsePie);
     }
 
     async getPurchaseBehavior(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsSalesPurchaseBehaviorDto>> {
@@ -35,24 +34,24 @@ export class MerchantStatisticsSalesService extends BaseService {
             .runAdapter(StatisticsSalesAdapter.parsePurchaseBehavior);
     }
 
-    async getRevenueTrend(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<ApexOptions>> {
+    async getRevenueTrend(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsChartDto>> {
         return await this
             .request(`/merchants/${merchantId}/statistics/sales/revenue-trend/${from.toSQLDate()}/${to.toSQLDate()}`)
             .method('get')
             .queryString(QueryString.builder()
                 .append('language', 'nl'))
             .bearerToken()
-            .run();
+            .runAdapter(StatisticsChartAdapter.parseChart);
     }
 
-    async getSalesByDayOfWeek(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<ApexOptions>> {
+    async getSalesByDayOfWeek(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsChartDto>> {
         return await this
             .request(`/merchants/${merchantId}/statistics/sales/sales-by-day-of-week/${from.toSQLDate()}/${to.toSQLDate()}`)
             .method('get')
             .queryString(QueryString.builder()
                 .append('language', 'nl'))
             .bearerToken()
-            .run();
+            .runAdapter(StatisticsChartAdapter.parseChart);
     }
 
     async getTransactionSuccessRate(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsSalesTransactionSuccessRateDto>> {
@@ -64,4 +63,74 @@ export class MerchantStatisticsSalesService extends BaseService {
             .bearerToken()
             .runAdapter(StatisticsSalesAdapter.parseTransactionSuccessRate);
     }
+
+    async getDiscountEfficacy(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsSalesDiscountEfficacyDto>> {
+        return await this
+            .request(`/merchants/${merchantId}/statistics/sales/discount-efficacy/${from.toSQLDate()}/${to.toSQLDate()}`)
+            .method('get')
+            .queryString(QueryString.builder()
+                .append('language', 'nl'))
+            .bearerToken()
+            .runAdapter(StatisticsSalesAdapter.parseDiscountEfficacy);
+    }
+
+    async getCartAbandonmentTrend(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsChartDto>> {
+        return await this
+            .request(`/merchants/${merchantId}/statistics/sales/cart-abandonment-trend/${from.toSQLDate()}/${to.toSQLDate()}`)
+            .method('get')
+            .queryString(QueryString.builder()
+                .append('language', 'nl'))
+            .bearerToken()
+            .runAdapter(StatisticsChartAdapter.parseChart);
+    }
+
+    async getOrderValueDistribution(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsSalesOrderValueDistributionDto>> {
+        return await this
+            .request(`/merchants/${merchantId}/statistics/sales/order-value-distribution/${from.toSQLDate()}/${to.toSQLDate()}`)
+            .method('get')
+            .queryString(QueryString.builder()
+                .append('language', 'nl'))
+            .bearerToken()
+            .runAdapter(StatisticsSalesAdapter.parseOrderValueDistribution);
+    }
+
+    async getFailedTransactionReasons(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsSalesFailedTransactionReasonDto[]>> {
+        return await this
+            .request(`/merchants/${merchantId}/statistics/sales/failed-transaction-reasons/${from.toSQLDate()}/${to.toSQLDate()}`)
+            .method('get')
+            .queryString(QueryString.builder()
+                .append('language', 'nl'))
+            .bearerToken()
+            .runArrayAdapter(StatisticsSalesAdapter.parseFailedTransactionReason);
+    }
+
+    async getOrderOriginDistribution(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsPieChartDto>> {
+        return await this
+            .request(`/merchants/${merchantId}/statistics/sales/order-origin-distribution/${from.toSQLDate()}/${to.toSQLDate()}`)
+            .method('get')
+            .queryString(QueryString.builder()
+                .append('language', 'nl'))
+            .bearerToken()
+            .runAdapter(StatisticsChartAdapter.parsePie);
+    }
+
+    async getRepeatPurchaseVelocity(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsSalesRepeatPurchaseVelocityDto>> {
+        return await this
+            .request(`/merchants/${merchantId}/statistics/sales/repeat-purchase-velocity/${from.toSQLDate()}/${to.toSQLDate()}`)
+            .method('get')
+            .queryString(QueryString.builder()
+                .append('language', 'nl'))
+            .bearerToken()
+            .runAdapter(StatisticsSalesAdapter.parseRepeatPurchaseVelocity);
+    }
+
+    async getAverageTicketPriceTrend(merchantId: string, from: DateTime, to: DateTime): Promise<BaseResponse<StatisticsChartDto>> {
+        return await this
+            .request(`/merchants/${merchantId}/statistics/sales/average-ticket-price-trend/${from.toSQLDate()}/${to.toSQLDate()}`)
+            .method('get')
+            .queryString(QueryString.builder()
+                .append('language', 'nl'))
+            .bearerToken()
+            .runAdapter(StatisticsChartAdapter.parseChart);
+    }
 }

package/src/service/MerchantStatisticsService.ts

@@ -1,17 +1,6 @@
 import { BaseResponse, BaseService, QueryString } from '@basmilius/http-client';
-import type { ApexOptions } from 'apexcharts';
 
 export class MerchantStatisticsService extends BaseService {
-    async getRevenueTrend(merchantId: string): Promise<BaseResponse<ApexOptions>> {
-        return await this
-            .request(`/merchants/${merchantId}/statistics/revenue-trend`)
-            .method('get')
-            .queryString(QueryString.builder()
-                .append('language', 'nl'))
-            .bearerToken()
-            .run();
-    }
-
     async getStatus(merchantId: string): Promise<BaseResponse<boolean>> {
         return await this
             .request(`/merchants/${merchantId}/statistics/status`)

package/src/service/index.ts

@@ -45,8 +45,10 @@ export * from './MerchantStatisticsBuyersService';
 export * from './MerchantStatisticsEventsService';
 export * from './MerchantStatisticsGrowthService';
 export * from './MerchantStatisticsInsightsService';
+export * from './MerchantStatisticsMarketingService';
 export * from './MerchantStatisticsOperationsService';
 export * from './MerchantStatisticsOverviewService';
+export * from './MerchantStatisticsRefundsService';
 export * from './MerchantStatisticsSalesService';
 export * from './MerchantAiChatService';
 export * from './MerchantAiSettingsService';

package/src/types/index.ts

@@ -16,5 +16,6 @@ export type * from './payment';
 export type * from './product';
 export type * from './publicShop';
 export type * from './refund';
+export type * from './statistics';
 export type * from './subscription';
 export type * from './ticket';

package/src/types/statistics.ts

@@ -0,0 +1,32 @@
+export type StatisticsChartValueType =
+    | 'count'
+    | 'integer'
+    | 'currency'
+    | 'percentage'
+    | 'duration';
+
+export type StatisticsChartSeriesKind =
+    | 'line'
+    | 'area'
+    | 'bar';
+
+export type StatisticsChartDataPoint = {
+    readonly value: number;
+    readonly formatted?: string;
+};
+
+export interface StatisticsChartSeries {
+    readonly name: string | null;
+    readonly valueType: StatisticsChartValueType;
+    readonly data: readonly (number | null | StatisticsChartDataPoint)[];
+    readonly type: StatisticsChartSeriesKind | null;
+    readonly axisIndex: number | null;
+    readonly zIndex: number | null;
+    readonly currency: string | null;
+}
+
+export interface StatisticsPieSlice {
+    readonly label: string;
+    readonly value: number;
+    readonly formatted: string | null;
+}

package/src/adapter/EventStatisticsSalesAdapter.ts

@@ -1,21 +0,0 @@
-import { adapter, ForeignData } from '@basmilius/http-client';
-import { DateTimeAdapter } from '#data/adapter';
-import { EventStatisticsSalesFlowChartDto, EventStatisticsSalesFlowChartSeriesDto } from '#data/dto';
-
-@adapter
-export class EventStatisticsSalesAdapter {
-    static parseSalesFlowChart(data: ForeignData): EventStatisticsSalesFlowChartDto {
-        return new EventStatisticsSalesFlowChartDto(
-            data.series.map(EventStatisticsSalesAdapter.parseSalesFlowChartSeries),
-            data.xaxis.categories.map(DateTimeAdapter.parseDateTime)
-        );
-    }
-
-    static parseSalesFlowChartSeries(data: ForeignData): EventStatisticsSalesFlowChartSeriesDto {
-        return new EventStatisticsSalesFlowChartSeriesDto(
-            data.name,
-            data.data,
-            data.zIndex
-        );
-    }
-}

package/src/dto/eventStatistics/EventStatisticsSalesFlowChartDto.ts

@@ -1,66 +0,0 @@
-import { dto } from '@basmilius/http-client';
-import type { DateTime } from 'luxon';
-
-@dto
-export class EventStatisticsSalesFlowChartSeriesDto {
-    get name(): string {
-        return this.#name;
-    }
-
-    set name(value: string) {
-        this.#name = value;
-    }
-
-    get data(): number[] {
-        return this.#data;
-    }
-
-    set data(value: number[]) {
-        this.#data = value;
-    }
-
-    get zIndex(): number {
-        return this.#zIndex;
-    }
-
-    set zIndex(value: number) {
-        this.#zIndex = value;
-    }
-
-    #name: string;
-    #data: number[];
-    #zIndex: number;
-
-    constructor(name: string, data: number[], zIndex: number) {
-        this.#name = name;
-        this.#data = data;
-        this.#zIndex = zIndex;
-    }
-}
-
-@dto
-export class EventStatisticsSalesFlowChartDto {
-    get series(): EventStatisticsSalesFlowChartSeriesDto[] {
-        return this.#series;
-    }
-
-    set series(value: EventStatisticsSalesFlowChartSeriesDto[]) {
-        this.#series = value;
-    }
-
-    get categories(): DateTime[] {
-        return this.#categories;
-    }
-
-    set categories(value: DateTime[]) {
-        this.#categories = value;
-    }
-
-    #series: EventStatisticsSalesFlowChartSeriesDto[];
-    #categories: DateTime[];
-
-    constructor(series: EventStatisticsSalesFlowChartSeriesDto[], categories: DateTime[]) {
-        this.#series = series;
-        this.#categories = categories;
-    }
-}

package/src/dto/statistics/StatisticsOperationsTasksOverviewDto.ts

@@ -1,69 +0,0 @@
-import { dto } from '@basmilius/http-client';
-import type { StatisticsOperationsTaskAssigneeDto } from '#data/dto';
-
-@dto
-export class StatisticsOperationsTasksOverviewDto {
-    get open(): number {
-        return this.#open;
-    }
-
-    set open(value: number) {
-        this.#open = value;
-    }
-
-    get inProgress(): number {
-        return this.#inProgress;
-    }
-
-    set inProgress(value: number) {
-        this.#inProgress = value;
-    }
-
-    get resolved(): number {
-        return this.#resolved;
-    }
-
-    set resolved(value: number) {
-        this.#resolved = value;
-    }
-
-    get canceled(): number {
-        return this.#canceled;
-    }
-
-    set canceled(value: number) {
-        this.#canceled = value;
-    }
-
-    get averageResolveTimeSeconds(): number {
-        return this.#averageResolveTimeSeconds;
-    }
-
-    set averageResolveTimeSeconds(value: number) {
-        this.#averageResolveTimeSeconds = value;
-    }
-
-    get topAssignees(): StatisticsOperationsTaskAssigneeDto[] {
-        return this.#topAssignees;
-    }
-
-    set topAssignees(value: StatisticsOperationsTaskAssigneeDto[]) {
-        this.#topAssignees = value;
-    }
-
-    #open: number;
-    #inProgress: number;
-    #resolved: number;
-    #canceled: number;
-    #averageResolveTimeSeconds: number;
-    #topAssignees: StatisticsOperationsTaskAssigneeDto[];
-
-    constructor(open: number, inProgress: number, resolved: number, canceled: number, averageResolveTimeSeconds: number, topAssignees: StatisticsOperationsTaskAssigneeDto[]) {
-        this.#open = open;
-        this.#inProgress = inProgress;
-        this.#resolved = resolved;
-        this.#canceled = canceled;
-        this.#averageResolveTimeSeconds = averageResolveTimeSeconds;
-        this.#topAssignees = topAssignees;
-    }
-}