@springtree/eva-services-bi 1.2.0 → 1.3.0

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/CHANGELOG.md CHANGED
@@ -3,6 +3,41 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # 1.3.0 (2021-11-26)
7
+
8
+
9
+ ### Features
10
+
11
+ * **typings:** update to latest ([ea0a930](https://github.com/springtreesolutions/eva-sdk-repo/commit/ea0a930452790bd1ff569072c0916dbac217e2f3))
12
+
13
+
14
+
15
+
16
+
17
+ ## 1.2.3 (2021-08-03)
18
+
19
+ **Note:** Version bump only for package @springtree/eva-services-bi
20
+
21
+
22
+
23
+
24
+
25
+ ## 1.2.2 (2021-03-08)
26
+
27
+ **Note:** Version bump only for package @springtree/eva-services-bi
28
+
29
+
30
+
31
+
32
+
33
+ ## 1.2.1 (2021-02-22)
34
+
35
+ **Note:** Version bump only for package @springtree/eva-services-bi
36
+
37
+
38
+
39
+
40
+
6
41
  # 1.2.0 (2021-02-22)
7
42
 
8
43
 
@@ -1,5 +1,18 @@
1
1
  import { IEvaServiceDefinition } from '@springtree/eva-services-core';
2
2
  export declare namespace BI {
3
+ /**
4
+ * Returns data that can be displayed as graphs in the frontend. This data is provided by an external system. When no external system is configured, mockdata will be returned.
5
+ *
6
+ * @export
7
+ * @class GetCustomerCharts
8
+ * @implements {EvaService}
9
+ */
10
+ class GetCustomerCharts implements IEvaServiceDefinition {
11
+ name: string;
12
+ path: string;
13
+ request?: EVA.BI.GetCustomerCharts;
14
+ response?: EVA.BI.GetChartsResponse;
15
+ }
3
16
  /**
4
17
  * TODO: Needs documentation
5
18
  *
@@ -15,19 +28,19 @@ export declare namespace BI {
15
28
  }
16
29
  /**
17
30
  * Gets BI data based on the given Labels.
18
-
19
- * `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
20
- * `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
21
- * `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
22
- * A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
23
- * A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
24
- * A `Date` for a single date point in time
25
-
26
- Optionally, you can supply the following parameters;
27
-
28
- * `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
29
- * `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
30
- * `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
31
+
32
+ * `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
33
+ * `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
34
+ * `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
35
+ * A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
36
+ * A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
37
+ * A `Date` for a single date point in time
38
+
39
+ Optionally, you can supply the following parameters;
40
+
41
+ * `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
42
+ * `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
43
+ * `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
31
44
  *
32
45
  * @export
33
46
  * @class GetData
@@ -80,12 +93,12 @@ export declare namespace BI {
80
93
  }
81
94
  /**
82
95
  * Retrieves a list of stores the current user has the `ViewReports` rights for, nested in a BI-specific tree for use in the BI app. The response contains
83
- one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
84
-
85
- From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
86
-
87
- Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
88
- and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
96
+ one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
97
+
98
+ From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
99
+
100
+ Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
101
+ and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
89
102
  *
90
103
  * @export
91
104
  * @class GetStoresForUser
@@ -1 +1 @@
1
- {"version":3,"file":"EVA.BI.Services.d.ts","sourceRoot":"","sources":["../src/EVA.BI.Services.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,yBAAiB,EAAE,CAAC;IAElB;;;;;;OAMG;IACH,MAAa,aAAc,YAAW,qBAAqB;QACzD,IAAI,SAAsB;QAC1B,IAAI,SAA2B;QAC/B,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,aAAa,CAAC;QAC/B,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,qBAAqB,CAAC;KACzC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAa,OAAQ,YAAW,qBAAqB;QACnD,IAAI,SAAgB;QACpB,IAAI,SAAqB;QACzB,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC;QACzB,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,eAAe,CAAC;KACnC;IAED;;;;;;OAMG;IACH,MAAa,SAAU,YAAW,qBAAqB;QACrD,IAAI,SAAkB;QACtB,IAAI,SAAuB;QAC3B,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAC3B,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC;KACrC;IAED;;;;;;OAMG;IACH,MAAa,cAAe,YAAW,qBAAqB;QAC1D,IAAI,SAAuB;QAC3B,IAAI,SAA4B;QAChC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,cAAc,CAAC;QAChC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,sBAAsB,CAAC;KAC1C;IAED;;;;;;OAMG;IACH,MAAa,kBAAmB,YAAW,qBAAqB;QAC9D,IAAI,SAA2B;QAC/B,IAAI,SAAgC;QACpC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,kBAAkB,CAAC;QACpC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,0BAA0B,CAAC;KAC9C;IAED;;;;;;;;;;;;OAYG;IACH,MAAa,gBAAiB,YAAW,qBAAqB;QAC5D,IAAI,SAAyB;QAC7B,IAAI,SAA8B;QAClC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,gBAAgB,CAAC;QAClC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,wBAAwB,CAAC;KAC5C;CACF"}
1
+ {"version":3,"file":"EVA.BI.Services.d.ts","sourceRoot":"","sources":["../src/EVA.BI.Services.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAEpE,yBAAiB,EAAE,CAAC;IAElB;;;;;;OAMG;IACH,MAAa,iBAAkB,YAAW,qBAAqB;QAC7D,IAAI,SAA0B;QAC9B,IAAI,SAA+B;QACnC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC;KACrC;IAED;;;;;;OAMG;IACH,MAAa,aAAc,YAAW,qBAAqB;QACzD,IAAI,SAAsB;QAC1B,IAAI,SAA2B;QAC/B,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,aAAa,CAAC;QAC/B,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,qBAAqB,CAAC;KACzC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAa,OAAQ,YAAW,qBAAqB;QACnD,IAAI,SAAgB;QACpB,IAAI,SAAqB;QACzB,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC;QACzB,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,eAAe,CAAC;KACnC;IAED;;;;;;OAMG;IACH,MAAa,SAAU,YAAW,qBAAqB;QACrD,IAAI,SAAkB;QACtB,IAAI,SAAuB;QAC3B,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QAC3B,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC;KACrC;IAED;;;;;;OAMG;IACH,MAAa,cAAe,YAAW,qBAAqB;QAC1D,IAAI,SAAuB;QAC3B,IAAI,SAA4B;QAChC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,cAAc,CAAC;QAChC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,sBAAsB,CAAC;KAC1C;IAED;;;;;;OAMG;IACH,MAAa,kBAAmB,YAAW,qBAAqB;QAC9D,IAAI,SAA2B;QAC/B,IAAI,SAAgC;QACpC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,kBAAkB,CAAC;QACpC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,0BAA0B,CAAC;KAC9C;IAED;;;;;;;;;;;;OAYG;IACH,MAAa,gBAAiB,YAAW,qBAAqB;QAC5D,IAAI,SAAyB;QAC7B,IAAI,SAA8B;QAClC,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,gBAAgB,CAAC;QAClC,QAAQ,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,wBAAwB,CAAC;KAC5C;CACF"}
@@ -1,5 +1,19 @@
1
1
  export var BI;
2
2
  (function (BI) {
3
+ /**
4
+ * Returns data that can be displayed as graphs in the frontend. This data is provided by an external system. When no external system is configured, mockdata will be returned.
5
+ *
6
+ * @export
7
+ * @class GetCustomerCharts
8
+ * @implements {EvaService}
9
+ */
10
+ class GetCustomerCharts {
11
+ constructor() {
12
+ this.name = 'BI:GetCustomerCharts';
13
+ this.path = '/api/bi/GetCustomerCharts';
14
+ }
15
+ }
16
+ BI.GetCustomerCharts = GetCustomerCharts;
3
17
  /**
4
18
  * TODO: Needs documentation
5
19
  *
@@ -16,19 +30,19 @@ export var BI;
16
30
  BI.GetDailyStats = GetDailyStats;
17
31
  /**
18
32
  * Gets BI data based on the given Labels.
19
-
20
- * `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
21
- * `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
22
- * `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
23
- * A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
24
- * A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
25
- * A `Date` for a single date point in time
26
-
27
- Optionally, you can supply the following parameters;
28
-
29
- * `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
30
- * `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
31
- * `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
33
+
34
+ * `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
35
+ * `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
36
+ * `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
37
+ * A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
38
+ * A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
39
+ * A `Date` for a single date point in time
40
+
41
+ Optionally, you can supply the following parameters;
42
+
43
+ * `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
44
+ * `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
45
+ * `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
32
46
  *
33
47
  * @export
34
48
  * @class GetData
@@ -85,12 +99,12 @@ export var BI;
85
99
  BI.GetPopularProducts = GetPopularProducts;
86
100
  /**
87
101
  * Retrieves a list of stores the current user has the `ViewReports` rights for, nested in a BI-specific tree for use in the BI app. The response contains
88
- one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
89
-
90
- From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
91
-
92
- Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
93
- and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
102
+ one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
103
+
104
+ From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
105
+
106
+ Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
107
+ and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
94
108
  *
95
109
  * @export
96
110
  * @class GetStoresForUser
@@ -1 +1 @@
1
- {"version":3,"file":"EVA.BI.Services.js","sourceRoot":"","sources":["../src/EVA.BI.Services.ts"],"names":[],"mappings":"AAEA,MAAM,KAAW,EAAE,CAwGlB;AAxGD,WAAiB,EAAE;IAEjB;;;;;;OAMG;IACH,MAAa,aAAa;QAA1B;YACE,SAAI,GAAG,kBAAkB,CAAC;YAC1B,SAAI,GAAG,uBAAuB,CAAC;QAGjC,CAAC;KAAA;IALY,gBAAa,gBAKzB,CAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAa,OAAO;QAApB;YACE,SAAI,GAAG,YAAY,CAAC;YACpB,SAAI,GAAG,iBAAiB,CAAC;QAG3B,CAAC;KAAA;IALY,UAAO,UAKnB,CAAA;IAED;;;;;;OAMG;IACH,MAAa,SAAS;QAAtB;YACE,SAAI,GAAG,cAAc,CAAC;YACtB,SAAI,GAAG,mBAAmB,CAAC;QAG7B,CAAC;KAAA;IALY,YAAS,YAKrB,CAAA;IAED;;;;;;OAMG;IACH,MAAa,cAAc;QAA3B;YACE,SAAI,GAAG,mBAAmB,CAAC;YAC3B,SAAI,GAAG,wBAAwB,CAAC;QAGlC,CAAC;KAAA;IALY,iBAAc,iBAK1B,CAAA;IAED;;;;;;OAMG;IACH,MAAa,kBAAkB;QAA/B;YACE,SAAI,GAAG,uBAAuB,CAAC;YAC/B,SAAI,GAAG,4BAA4B,CAAC;QAGtC,CAAC;KAAA;IALY,qBAAkB,qBAK9B,CAAA;IAED;;;;;;;;;;;;OAYG;IACH,MAAa,gBAAgB;QAA7B;YACE,SAAI,GAAG,qBAAqB,CAAC;YAC7B,SAAI,GAAG,0BAA0B,CAAC;QAGpC,CAAC;KAAA;IALY,mBAAgB,mBAK5B,CAAA;AACH,CAAC,EAxGgB,EAAE,KAAF,EAAE,QAwGlB"}
1
+ {"version":3,"file":"EVA.BI.Services.js","sourceRoot":"","sources":["../src/EVA.BI.Services.ts"],"names":[],"mappings":"AAEE,MAAM,KAAW,EAAE,CAsHlB;AAtHD,WAAiB,EAAE;IAEjB;;;;;;OAMG;IACH,MAAa,iBAAiB;QAA9B;YACE,SAAI,GAAG,sBAAsB,CAAC;YAC9B,SAAI,GAAG,2BAA2B,CAAC;QAGrC,CAAC;KAAA;IALY,oBAAiB,oBAK7B,CAAA;IAED;;;;;;OAMG;IACH,MAAa,aAAa;QAA1B;YACE,SAAI,GAAG,kBAAkB,CAAC;YAC1B,SAAI,GAAG,uBAAuB,CAAC;QAGjC,CAAC;KAAA;IALY,gBAAa,gBAKzB,CAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAa,OAAO;QAApB;YACE,SAAI,GAAG,YAAY,CAAC;YACpB,SAAI,GAAG,iBAAiB,CAAC;QAG3B,CAAC;KAAA;IALY,UAAO,UAKnB,CAAA;IAED;;;;;;OAMG;IACH,MAAa,SAAS;QAAtB;YACE,SAAI,GAAG,cAAc,CAAC;YACtB,SAAI,GAAG,mBAAmB,CAAC;QAG7B,CAAC;KAAA;IALY,YAAS,YAKrB,CAAA;IAED;;;;;;OAMG;IACH,MAAa,cAAc;QAA3B;YACE,SAAI,GAAG,mBAAmB,CAAC;YAC3B,SAAI,GAAG,wBAAwB,CAAC;QAGlC,CAAC;KAAA;IALY,iBAAc,iBAK1B,CAAA;IAED;;;;;;OAMG;IACH,MAAa,kBAAkB;QAA/B;YACE,SAAI,GAAG,uBAAuB,CAAC;YAC/B,SAAI,GAAG,4BAA4B,CAAC;QAGtC,CAAC;KAAA;IALY,qBAAkB,qBAK9B,CAAA;IAED;;;;;;;;;;;;OAYG;IACH,MAAa,gBAAgB;QAA7B;YACE,SAAI,GAAG,qBAAqB,CAAC;YAC7B,SAAI,GAAG,0BAA0B,CAAC;QAGpC,CAAC;KAAA;IALY,mBAAgB,mBAK5B,CAAA;AACH,CAAC,EAtHgB,EAAE,KAAF,EAAE,QAsHlB"}
@@ -1,5 +1,19 @@
1
1
  var BI;
2
2
  (function (BI) {
3
+ /**
4
+ * Returns data that can be displayed as graphs in the frontend. This data is provided by an external system. When no external system is configured, mockdata will be returned.
5
+ *
6
+ * @export
7
+ * @class GetCustomerCharts
8
+ * @implements {EvaService}
9
+ */
10
+ class GetCustomerCharts {
11
+ constructor() {
12
+ this.name = 'BI:GetCustomerCharts';
13
+ this.path = '/api/bi/GetCustomerCharts';
14
+ }
15
+ }
16
+ BI.GetCustomerCharts = GetCustomerCharts;
3
17
  /**
4
18
  * TODO: Needs documentation
5
19
  *
@@ -16,19 +30,19 @@ var BI;
16
30
  BI.GetDailyStats = GetDailyStats;
17
31
  /**
18
32
  * Gets BI data based on the given Labels.
19
-
20
- * `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
21
- * `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
22
- * `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
23
- * A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
24
- * A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
25
- * A `Date` for a single date point in time
26
-
27
- Optionally, you can supply the following parameters;
28
-
29
- * `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
30
- * `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
31
- * `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
33
+
34
+ * `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
35
+ * `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
36
+ * `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
37
+ * A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
38
+ * A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
39
+ * A `Date` for a single date point in time
40
+
41
+ Optionally, you can supply the following parameters;
42
+
43
+ * `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
44
+ * `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
45
+ * `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
32
46
  *
33
47
  * @export
34
48
  * @class GetData
@@ -85,12 +99,12 @@ var BI;
85
99
  BI.GetPopularProducts = GetPopularProducts;
86
100
  /**
87
101
  * Retrieves a list of stores the current user has the `ViewReports` rights for, nested in a BI-specific tree for use in the BI app. The response contains
88
- one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
89
-
90
- From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
91
-
92
- Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
93
- and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
102
+ one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
103
+
104
+ From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
105
+
106
+ Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
107
+ and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
94
108
  *
95
109
  * @export
96
110
  * @class GetStoresForUser
@@ -1 +1 @@
1
- {"version":3,"file":"eva-services-bi.es5.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"eva-services-bi.es5.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
@@ -2,10 +2,24 @@
2
2
  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
3
3
  typeof define === 'function' && define.amd ? define(['exports'], factory) :
4
4
  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.evaServicesBi = {}));
5
- }(this, (function (exports) { 'use strict';
5
+ })(this, (function (exports) { 'use strict';
6
6
 
7
7
  exports.BI = void 0;
8
8
  (function (BI) {
9
+ /**
10
+ * Returns data that can be displayed as graphs in the frontend. This data is provided by an external system. When no external system is configured, mockdata will be returned.
11
+ *
12
+ * @export
13
+ * @class GetCustomerCharts
14
+ * @implements {EvaService}
15
+ */
16
+ class GetCustomerCharts {
17
+ constructor() {
18
+ this.name = 'BI:GetCustomerCharts';
19
+ this.path = '/api/bi/GetCustomerCharts';
20
+ }
21
+ }
22
+ BI.GetCustomerCharts = GetCustomerCharts;
9
23
  /**
10
24
  * TODO: Needs documentation
11
25
  *
@@ -22,19 +36,19 @@
22
36
  BI.GetDailyStats = GetDailyStats;
23
37
  /**
24
38
  * Gets BI data based on the given Labels.
25
-
26
- * `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
27
- * `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
28
- * `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
29
- * A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
30
- * A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
31
- * A `Date` for a single date point in time
32
-
33
- Optionally, you can supply the following parameters;
34
-
35
- * `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
36
- * `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
37
- * `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
39
+
40
+ * `OrganizationUnitID` is the organization unit you want data from; this may be a container unit or a shop alike
41
+ * `Labels` define the data you want to retrieve; use `GetLabels` to find the available labels in this instance
42
+ * `Timeframe` defines the range of dates you want to accumulate, where you have three options available;
43
+ * A `Period` with a `Year` and then either a `Month` or a `Week` (ISO)
44
+ * A `Range` with a `From` and `To` date and a `Grain` to define the amount of detail within this period
45
+ * A `Date` for a single date point in time
46
+
47
+ Optionally, you can supply the following parameters;
48
+
49
+ * `Series` is an array where you can specify which `Series` to retrieve; current values include `Actual` and `LFL`
50
+ * `GroupBy` defines the 'rotation' to view the data in; by default you'll see data per `Label`, but you can rotate for a ranking view using `OrganizationUnit` or a more detailed view using `Name`
51
+ * `Mock` allows you to override the base `BI:Mock` setting to switch between mocked- and live data
38
52
  *
39
53
  * @export
40
54
  * @class GetData
@@ -91,12 +105,12 @@
91
105
  BI.GetPopularProducts = GetPopularProducts;
92
106
  /**
93
107
  * Retrieves a list of stores the current user has the `ViewReports` rights for, nested in a BI-specific tree for use in the BI app. The response contains
94
- one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
95
-
96
- From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
97
-
98
- Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
99
- and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
108
+ one root node, from which you can traverse its Children (and its Children.Children, and its... you get it).
109
+
110
+ From outside in, these are the types you will *always* find: `Root` (5), `Country` (4), `Region` (3), `City` (2) and `Shop` (1).
111
+
112
+ Note that when a user does not have rights on a specific level (e.g. you may see a Region, but not the Country above), this node will have ID `-1`
113
+ and Name `Unknown`. Needless to point out, but note you cannot use the ID `-1` as a value for the `GetData` service `OrganizationUnitID` parameter.
100
114
  *
101
115
  * @export
102
116
  * @class GetStoresForUser
@@ -113,5 +127,5 @@
113
127
 
114
128
  Object.defineProperty(exports, '__esModule', { value: true });
115
129
 
116
- })));
130
+ }));
117
131
  //# sourceMappingURL=eva-services-bi.umd.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"eva-services-bi.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"eva-services-bi.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@springtree/eva-services-bi",
3
- "version": "1.2.0",
3
+ "version": "1.3.0",
4
4
  "description": "The EVA service repository for EVA.BI",
5
5
  "keywords": [],
6
6
  "author": "SpringTree <info@springtree.nl>",
@@ -33,5 +33,5 @@
33
33
  "peerDependencies": {
34
34
  "@springtree/eva-services-core": "^1.0.0"
35
35
  },
36
- "gitHead": "cb577fbacec27ff608acd662cfc6ff81cdde768e"
36
+ "gitHead": "6424b18cbe6f14c3e21cb59971e8bf88d2c3f9e7"
37
37
  }