@erp-galoper/types 1.0.1911 → 1.0.1913
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/openapi.ts +148 -13
- package/package.json +1 -1
package/openapi.ts
CHANGED
|
@@ -2404,6 +2404,41 @@ export interface paths {
|
|
|
2404
2404
|
patch?: never;
|
|
2405
2405
|
trace?: never;
|
|
2406
2406
|
};
|
|
2407
|
+
"/api/v1/common/logs/count/": {
|
|
2408
|
+
parameters: {
|
|
2409
|
+
query?: never;
|
|
2410
|
+
header?: never;
|
|
2411
|
+
path?: never;
|
|
2412
|
+
cookie?: never;
|
|
2413
|
+
};
|
|
2414
|
+
/**
|
|
2415
|
+
* Get Logs Count
|
|
2416
|
+
* @description Endpoint to get log counts for a specific model or all models when logModelName is omitted.
|
|
2417
|
+
*
|
|
2418
|
+
* Returns an overall count and a monthly breakdown by log type (Created, Changed, Deleted).
|
|
2419
|
+
* Supports the same query parameters as the logs route so counts match active filters.
|
|
2420
|
+
*
|
|
2421
|
+
* Possible Responses:
|
|
2422
|
+
* - 200: LogsCountResponseSchema
|
|
2423
|
+
* - 403: permissionDenied
|
|
2424
|
+
* - 400:
|
|
2425
|
+
* - startDateAndEndDateAreRequiredForCustomPeriodType
|
|
2426
|
+
* - startDateShouldBeGreaterThanEndDate
|
|
2427
|
+
* - invalidFilterFormat
|
|
2428
|
+
* - 500: internalServerError
|
|
2429
|
+
*
|
|
2430
|
+
* Permission Key:
|
|
2431
|
+
* logs: ["view"]
|
|
2432
|
+
*/
|
|
2433
|
+
get: operations["common_views_get_logs_count"];
|
|
2434
|
+
put?: never;
|
|
2435
|
+
post?: never;
|
|
2436
|
+
delete?: never;
|
|
2437
|
+
options?: never;
|
|
2438
|
+
head?: never;
|
|
2439
|
+
patch?: never;
|
|
2440
|
+
trace?: never;
|
|
2441
|
+
};
|
|
2407
2442
|
"/api/v1/common/get-model-names/": {
|
|
2408
2443
|
parameters: {
|
|
2409
2444
|
query?: never;
|
|
@@ -30349,6 +30384,43 @@ export interface components {
|
|
|
30349
30384
|
/** New */
|
|
30350
30385
|
new?: string | null;
|
|
30351
30386
|
};
|
|
30387
|
+
/** LogTypeCount */
|
|
30388
|
+
LogTypeCount: {
|
|
30389
|
+
/**
|
|
30390
|
+
* Created
|
|
30391
|
+
* @default 0
|
|
30392
|
+
*/
|
|
30393
|
+
Created: number;
|
|
30394
|
+
/**
|
|
30395
|
+
* Changed
|
|
30396
|
+
* @default 0
|
|
30397
|
+
*/
|
|
30398
|
+
Changed: number;
|
|
30399
|
+
/**
|
|
30400
|
+
* Deleted
|
|
30401
|
+
* @default 0
|
|
30402
|
+
*/
|
|
30403
|
+
Deleted: number;
|
|
30404
|
+
};
|
|
30405
|
+
/** LogsCountResponseSchema */
|
|
30406
|
+
LogsCountResponseSchema: {
|
|
30407
|
+
/** Total */
|
|
30408
|
+
total: number;
|
|
30409
|
+
logType: components["schemas"]["LogTypeCount"];
|
|
30410
|
+
/**
|
|
30411
|
+
* Monthly
|
|
30412
|
+
* @default []
|
|
30413
|
+
*/
|
|
30414
|
+
monthly: components["schemas"]["MonthlyLogCount"][];
|
|
30415
|
+
};
|
|
30416
|
+
/** MonthlyLogCount */
|
|
30417
|
+
MonthlyLogCount: {
|
|
30418
|
+
/** Month */
|
|
30419
|
+
month: string;
|
|
30420
|
+
/** Total */
|
|
30421
|
+
total: number;
|
|
30422
|
+
logType: components["schemas"]["LogTypeCount"];
|
|
30423
|
+
};
|
|
30352
30424
|
/**
|
|
30353
30425
|
* CombinedModelName
|
|
30354
30426
|
* @enum {string}
|
|
@@ -59652,9 +59724,9 @@ export interface components {
|
|
|
59652
59724
|
*/
|
|
59653
59725
|
CurrencyAmountSchema: {
|
|
59654
59726
|
/** Primary */
|
|
59655
|
-
primary:
|
|
59727
|
+
primary: string;
|
|
59656
59728
|
/** Secondary */
|
|
59657
|
-
secondary:
|
|
59729
|
+
secondary: string;
|
|
59658
59730
|
};
|
|
59659
59731
|
/**
|
|
59660
59732
|
* IUOMGroupValuationSchema
|
|
@@ -59872,7 +59944,7 @@ export interface components {
|
|
|
59872
59944
|
* Profitmargin
|
|
59873
59945
|
* @description Profit margin percentage
|
|
59874
59946
|
*/
|
|
59875
|
-
profitMargin:
|
|
59947
|
+
profitMargin: string | null;
|
|
59876
59948
|
};
|
|
59877
59949
|
/**
|
|
59878
59950
|
* SalesTotalsSchema
|
|
@@ -59899,7 +59971,7 @@ export interface components {
|
|
|
59899
59971
|
totalCost: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
59900
59972
|
grossProfit: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
59901
59973
|
/** Profitmargin */
|
|
59902
|
-
profitMargin:
|
|
59974
|
+
profitMargin: string | null;
|
|
59903
59975
|
};
|
|
59904
59976
|
/** SalesByCategoryListSchema */
|
|
59905
59977
|
SalesByCategoryListSchema: {
|
|
@@ -59933,12 +60005,12 @@ export interface components {
|
|
|
59933
60005
|
cost: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
59934
60006
|
grossProfit: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
59935
60007
|
/** Profitmargin */
|
|
59936
|
-
profitMargin:
|
|
60008
|
+
profitMargin: string | null;
|
|
59937
60009
|
/**
|
|
59938
60010
|
* Contributionpercentage
|
|
59939
60011
|
* @description Category's contribution to total sales
|
|
59940
60012
|
*/
|
|
59941
|
-
contributionPercentage:
|
|
60013
|
+
contributionPercentage: string;
|
|
59942
60014
|
};
|
|
59943
60015
|
/** SalesByBrandListSchema */
|
|
59944
60016
|
SalesByBrandListSchema: {
|
|
@@ -59972,7 +60044,7 @@ export interface components {
|
|
|
59972
60044
|
cost: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
59973
60045
|
grossProfit: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
59974
60046
|
/** Profitmargin */
|
|
59975
|
-
profitMargin:
|
|
60047
|
+
profitMargin: string | null;
|
|
59976
60048
|
};
|
|
59977
60049
|
/** CustomerSummarySchema */
|
|
59978
60050
|
CustomerSummarySchema: {
|
|
@@ -60020,7 +60092,7 @@ export interface components {
|
|
|
60020
60092
|
cost: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
60021
60093
|
grossProfit: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
60022
60094
|
/** Profitmargin */
|
|
60023
|
-
profitMargin:
|
|
60095
|
+
profitMargin: string | null;
|
|
60024
60096
|
};
|
|
60025
60097
|
/** SalesBySalespersonListSchema */
|
|
60026
60098
|
SalesBySalespersonListSchema: {
|
|
@@ -60047,7 +60119,7 @@ export interface components {
|
|
|
60047
60119
|
cost: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
60048
60120
|
grossProfit: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
60049
60121
|
/** Profitmargin */
|
|
60050
|
-
profitMargin:
|
|
60122
|
+
profitMargin: string | null;
|
|
60051
60123
|
averageInvoiceValue: components["schemas"]["CurrencyAmountSchema"];
|
|
60052
60124
|
};
|
|
60053
60125
|
/** SalespersonSummarySchema */
|
|
@@ -60103,7 +60175,7 @@ export interface components {
|
|
|
60103
60175
|
cost: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
60104
60176
|
grossProfit: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
60105
60177
|
/** Profitmargin */
|
|
60106
|
-
profitMargin:
|
|
60178
|
+
profitMargin: string | null;
|
|
60107
60179
|
};
|
|
60108
60180
|
/** WarehouseSummarySchema */
|
|
60109
60181
|
WarehouseSummarySchema: {
|
|
@@ -60151,7 +60223,7 @@ export interface components {
|
|
|
60151
60223
|
costOfGoodsSold: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
60152
60224
|
grossProfit: components["schemas"]["CurrencyAmountSchema"] | null;
|
|
60153
60225
|
/** Grossmarginpercentage */
|
|
60154
|
-
grossMarginPercentage:
|
|
60226
|
+
grossMarginPercentage: string | null;
|
|
60155
60227
|
averageOrderValue: components["schemas"]["CurrencyAmountSchema"];
|
|
60156
60228
|
/** Averageitemsperorder */
|
|
60157
60229
|
averageItemsPerOrder: number;
|
|
@@ -60197,7 +60269,7 @@ export interface components {
|
|
|
60197
60269
|
* Growthpercentage
|
|
60198
60270
|
* @description Month-over-month growth
|
|
60199
60271
|
*/
|
|
60200
|
-
growthPercentage?:
|
|
60272
|
+
growthPercentage?: string | null;
|
|
60201
60273
|
};
|
|
60202
60274
|
/**
|
|
60203
60275
|
* SalesTrendSchema
|
|
@@ -60240,7 +60312,7 @@ export interface components {
|
|
|
60240
60312
|
* Growthpercentage
|
|
60241
60313
|
* @description Week-over-week growth
|
|
60242
60314
|
*/
|
|
60243
|
-
growthPercentage?:
|
|
60315
|
+
growthPercentage?: string | null;
|
|
60244
60316
|
};
|
|
60245
60317
|
/** ReceivablesByCustomerRegionContactSchema */
|
|
60246
60318
|
ReceivablesByCustomerRegionContactSchema: {
|
|
@@ -67664,6 +67736,69 @@ export interface operations {
|
|
|
67664
67736
|
};
|
|
67665
67737
|
};
|
|
67666
67738
|
};
|
|
67739
|
+
common_views_get_logs_count: {
|
|
67740
|
+
parameters: {
|
|
67741
|
+
query?: {
|
|
67742
|
+
/** @description Filter by module/model. When omitted, logs from all modules are returned. */
|
|
67743
|
+
logModelName?: components["schemas"]["LogModelName"] | null;
|
|
67744
|
+
logType?: "Created" | "Changed" | "Deleted";
|
|
67745
|
+
/** @description by default periodType is set to date filtration in user settings, Period type: thisMonth, thisYear, lastMonth, custom, ... */
|
|
67746
|
+
periodType?: "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisFiscalYear" | "lastFiscalYear" | "custom" | "today" | "all";
|
|
67747
|
+
/** @description Start date for custom range (YYYY-MM-DD), this required if the period type is custom */
|
|
67748
|
+
startDate?: string | null;
|
|
67749
|
+
/** @description End date for custom range (YYYY-MM-DD), this required if the period type is custom */
|
|
67750
|
+
endDate?: string | null;
|
|
67751
|
+
/** @description Filter by user ID */
|
|
67752
|
+
user?: string;
|
|
67753
|
+
/** @description Filter by specific document ID */
|
|
67754
|
+
documentId?: string;
|
|
67755
|
+
/** @description Search */
|
|
67756
|
+
search?: string | null;
|
|
67757
|
+
};
|
|
67758
|
+
header?: never;
|
|
67759
|
+
path?: never;
|
|
67760
|
+
cookie?: never;
|
|
67761
|
+
};
|
|
67762
|
+
requestBody?: never;
|
|
67763
|
+
responses: {
|
|
67764
|
+
/** @description OK */
|
|
67765
|
+
200: {
|
|
67766
|
+
headers: {
|
|
67767
|
+
[name: string]: unknown;
|
|
67768
|
+
};
|
|
67769
|
+
content: {
|
|
67770
|
+
"application/json": components["schemas"]["LogsCountResponseSchema"];
|
|
67771
|
+
};
|
|
67772
|
+
};
|
|
67773
|
+
/** @description Bad Request */
|
|
67774
|
+
400: {
|
|
67775
|
+
headers: {
|
|
67776
|
+
[name: string]: unknown;
|
|
67777
|
+
};
|
|
67778
|
+
content: {
|
|
67779
|
+
"application/json": components["schemas"]["ErrorMessages"];
|
|
67780
|
+
};
|
|
67781
|
+
};
|
|
67782
|
+
/** @description Forbidden */
|
|
67783
|
+
403: {
|
|
67784
|
+
headers: {
|
|
67785
|
+
[name: string]: unknown;
|
|
67786
|
+
};
|
|
67787
|
+
content: {
|
|
67788
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
67789
|
+
};
|
|
67790
|
+
};
|
|
67791
|
+
/** @description Internal Server Error */
|
|
67792
|
+
500: {
|
|
67793
|
+
headers: {
|
|
67794
|
+
[name: string]: unknown;
|
|
67795
|
+
};
|
|
67796
|
+
content: {
|
|
67797
|
+
"application/json": components["schemas"]["MessageResponse"];
|
|
67798
|
+
};
|
|
67799
|
+
};
|
|
67800
|
+
};
|
|
67801
|
+
};
|
|
67667
67802
|
common_views_get_model_names: {
|
|
67668
67803
|
parameters: {
|
|
67669
67804
|
query?: {
|