@tillhub/javascript-sdk 4.111.0 → 4.112.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.
Files changed (5) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/types/v4/analytics.d.ts +17 -9
  3. package/dist/v4/analytics.js +40 -4
  4. package/dist/v4/analytics.js.map +1 -1
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,10 @@
1
+ # [4.112.0](https://github.com/tillhub/tillhub-sdk-javascript/compare/v4.111.0...v4.112.0) (2023-12-13)
2
+
3
+
4
+ ### Features
5
+
6
+ * **home:** add get revenue method to analytics v4 ([a9d1379](https://github.com/tillhub/tillhub-sdk-javascript/commit/a9d13797ea4d1b30d499710eb1e8bc6b445896f4))
7
+
1
8
  # [4.111.0](https://github.com/tillhub/tillhub-sdk-javascript/compare/v4.110.0...v4.111.0) (2023-12-13)
2
9
 
3
10
 
package/dist/types/v4/analytics.d.ts CHANGED
@@ -6,22 +6,23 @@ export interface AnalyticsOptions {
6
6
  user?: string;
7
7
  base?: string;
8
8
  }
9
- export interface AnalyticsGetRevenueAverageQuery {
9
+ export interface AnalyticsQuery {
10
10
  compare?: boolean;
11
11
  branch?: string;
12
12
  end: Date;
13
13
  start: Date;
14
14
  }
15
- export interface AnalyticsGetRevenueAverageResponse {
15
+ export interface AnalyticsResponse {
16
16
  data: {
17
- series: Array<{
18
- period: 'current' | 'previous';
19
- data: number[];
20
- total: number;
21
- unit: string;
22
- }>;
17
+ series: AnalyticsResponseSeries[];
23
18
  };
24
19
  }
20
+ interface AnalyticsResponseSeries {
21
+ period: 'current' | 'previous';
22
+ data: number[];
23
+ total: number;
24
+ unit: string;
25
+ }
25
26
  export declare class Analytics extends ThBaseHandler {
26
27
  static baseEndpoint: string;
27
28
  endpoint: string;
@@ -29,10 +30,17 @@ export declare class Analytics extends ThBaseHandler {
29
30
  options: AnalyticsOptions;
30
31
  uriHelper: UriHelper;
31
32
  constructor(options: AnalyticsOptions, http: Client);
32
- getRevenueAverage(query?: AnalyticsGetRevenueAverageQuery): Promise<AnalyticsGetRevenueAverageResponse>;
33
+ getRevenue(query?: AnalyticsQuery): Promise<AnalyticsResponse>;
34
+ getRevenueAverage(query?: AnalyticsQuery): Promise<AnalyticsResponse>;
35
+ }
36
+ export declare class AnalyticsGetRevenueFailed extends BaseError {
37
+ message: string;
38
+ name: string;
39
+ constructor(message?: string, properties?: Record<string, unknown>);
33
40
  }
34
41
  export declare class AnalyticsGetRevenueAverageFailed extends BaseError {
35
42
  message: string;
36
43
  name: string;
37
44
  constructor(message?: string, properties?: Record<string, unknown>);
38
45
  }
46
+ export {};
package/dist/v4/analytics.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AnalyticsGetRevenueAverageFailed = exports.Analytics = void 0;
3
+ exports.AnalyticsGetRevenueAverageFailed = exports.AnalyticsGetRevenueFailed = exports.Analytics = void 0;
4
4
  var tslib_1 = require("tslib");
5
5
  var errors_1 = require("../errors");
6
6
  var uri_helper_1 = require("../uri-helper");
@@ -20,14 +20,14 @@ var Analytics = (function (_super) {
20
20
  _this.uriHelper = new uri_helper_1.UriHelper(_this.endpoint, _this.options);
21
21
  return _this;
22
22
  }
23
- Analytics.prototype.getRevenueAverage = function (query) {
23
+ Analytics.prototype.getRevenue = function (query) {
24
24
  return tslib_1.__awaiter(this, void 0, void 0, function () {
25
25
  var base, uri, response, error_1;
26
26
  return tslib_1.__generator(this, function (_a) {
27
27
  switch (_a.label) {
28
28
  case 0:
29
29
  _a.trys.push([0, 2, , 3]);
30
- base = this.uriHelper.generateBaseUri('/revenue/average');
30
+ base = this.uriHelper.generateBaseUri('/revenue');
31
31
  uri = this.uriHelper.generateUriWithQuery(base, query);
32
32
  return [4, this.http.getClient().get(uri)];
33
33
  case 1:
@@ -37,7 +37,30 @@ var Analytics = (function (_super) {
37
37
  }];
38
38
  case 2:
39
39
  error_1 = _a.sent();
40
- throw new AnalyticsGetRevenueAverageFailed(error_1.message);
40
+ throw new AnalyticsGetRevenueFailed(error_1.message);
41
+ case 3: return [2];
42
+ }
43
+ });
44
+ });
45
+ };
46
+ Analytics.prototype.getRevenueAverage = function (query) {
47
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
48
+ var base, uri, response, error_2;
49
+ return tslib_1.__generator(this, function (_a) {
50
+ switch (_a.label) {
51
+ case 0:
52
+ _a.trys.push([0, 2, , 3]);
53
+ base = this.uriHelper.generateBaseUri('/revenue/average');
54
+ uri = this.uriHelper.generateUriWithQuery(base, query);
55
+ return [4, this.http.getClient().get(uri)];
56
+ case 1:
57
+ response = _a.sent();
58
+ return [2, {
59
+ data: response.data.results[0]
60
+ }];
61
+ case 2:
62
+ error_2 = _a.sent();
63
+ throw new AnalyticsGetRevenueAverageFailed(error_2.message);
41
64
  case 3: return [2];
42
65
  }
43
66
  });
@@ -47,6 +70,19 @@ var Analytics = (function (_super) {
47
70
  return Analytics;
48
71
  }(base_1.ThBaseHandler));
49
72
  exports.Analytics = Analytics;
73
+ var AnalyticsGetRevenueFailed = (function (_super) {
74
+ tslib_1.__extends(AnalyticsGetRevenueFailed, _super);
75
+ function AnalyticsGetRevenueFailed(message, properties) {
76
+ if (message === void 0) { message = 'Could not get revenue'; }
77
+ var _this = _super.call(this, message, properties) || this;
78
+ _this.message = message;
79
+ _this.name = 'AnalyticsGetRevenueFailed';
80
+ Object.setPrototypeOf(_this, AnalyticsGetRevenueFailed.prototype);
81
+ return _this;
82
+ }
83
+ return AnalyticsGetRevenueFailed;
84
+ }(errors_1.BaseError));
85
+ exports.AnalyticsGetRevenueFailed = AnalyticsGetRevenueFailed;
50
86
  var AnalyticsGetRevenueAverageFailed = (function (_super) {
51
87
  tslib_1.__extends(AnalyticsGetRevenueAverageFailed, _super);
52
88
  function AnalyticsGetRevenueAverageFailed(message, properties) {
package/dist/v4/analytics.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../src/v4/analytics.ts"],"names":[],"mappings":";;;;AACA,oCAAqC;AACrC,4CAAyC;AACzC,gCAAuC;AAyBvC;IAA+B,qCAAa;IAO1C,mBAAa,OAAyB,EAAE,IAAY;;QAApD,YACE,kBAAM,IAAI,EAAE;YACV,QAAQ,EAAE,SAAS,CAAC,YAAY;YAChC,IAAI,QAAE,OAAO,CAAC,IAAI,mCAAI,yBAAyB;SAChD,CAAC,SAOH;QANC,KAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,KAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAEhB,KAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,YAAY,CAAA;QACtC,KAAI,CAAC,OAAO,CAAC,IAAI,SAAG,KAAI,CAAC,OAAO,CAAC,IAAI,mCAAI,yBAAyB,CAAA;QAClE,KAAI,CAAC,SAAS,GAAG,IAAI,sBAAS,CAAC,KAAI,CAAC,QAAQ,EAAE,KAAI,CAAC,OAAO,CAAC,CAAA;;IAC7D,CAAC;IAEK,qCAAiB,GAAvB,UACE,KAAuC;;;;;;;wBAG/B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAA;wBACzD,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;wBAE3C,WAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAA;;wBAA/C,QAAQ,GAAG,SAAoC;wBAErD,WAAO;gCACL,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;6BAC/B,EAAA;;;wBAED,MAAM,IAAI,gCAAgC,CAAC,OAAK,CAAC,OAAO,CAAC,CAAA;;;;;KAE5D;IAlCa,sBAAY,GAAG,mBAAmB,CAAA;IAmClD,gBAAC;CAAA,AApCD,CAA+B,oBAAa,GAoC3C;AApCY,8BAAS;AAsCtB;IAAsD,4DAAS;IAE7D,0CACS,OAAiD,EACxD,UAAoC;QAD7B,wBAAA,EAAA,yCAAiD;QAD1D,YAIE,kBAAM,OAAO,EAAE,UAAU,CAAC,SAE3B;QALQ,aAAO,GAAP,OAAO,CAA0C;QAFnD,UAAI,GAAG,kCAAkC,CAAA;QAM9C,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,gCAAgC,CAAC,SAAS,CAAC,CAAA;;IACzE,CAAC;IACH,uCAAC;AAAD,CAAC,AATD,CAAsD,kBAAS,GAS9D;AATY,4EAAgC"}
1
+ {"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../src/v4/analytics.ts"],"names":[],"mappings":";;;;AACA,oCAAqC;AACrC,4CAAyC;AACzC,gCAAuC;AA2BvC;IAA+B,qCAAa;IAO1C,mBAAa,OAAyB,EAAE,IAAY;;QAApD,YACE,kBAAM,IAAI,EAAE;YACV,QAAQ,EAAE,SAAS,CAAC,YAAY;YAChC,IAAI,QAAE,OAAO,CAAC,IAAI,mCAAI,yBAAyB;SAChD,CAAC,SAOH;QANC,KAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,KAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAEhB,KAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,YAAY,CAAA;QACtC,KAAI,CAAC,OAAO,CAAC,IAAI,SAAG,KAAI,CAAC,OAAO,CAAC,IAAI,mCAAI,yBAAyB,CAAA;QAClE,KAAI,CAAC,SAAS,GAAG,IAAI,sBAAS,CAAC,KAAI,CAAC,QAAQ,EAAE,KAAI,CAAC,OAAO,CAAC,CAAA;;IAC7D,CAAC;IAEK,8BAAU,GAAhB,UACE,KAAsB;;;;;;;wBAGd,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC,CAAA;wBACjD,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;wBAE3C,WAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAA;;wBAA/C,QAAQ,GAAG,SAAoC;wBAErD,WAAO;gCACL,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;6BAC/B,EAAA;;;wBAED,MAAM,IAAI,yBAAyB,CAAC,OAAK,CAAC,OAAO,CAAC,CAAA;;;;;KAErD;IAEK,qCAAiB,GAAvB,UACE,KAAsB;;;;;;;wBAGd,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAA;wBACzD,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;wBAE3C,WAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAA;;wBAA/C,QAAQ,GAAG,SAAoC;wBAErD,WAAO;gCACL,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;6BAC/B,EAAA;;;wBAED,MAAM,IAAI,gCAAgC,CAAC,OAAK,CAAC,OAAO,CAAC,CAAA;;;;;KAE5D;IAnDa,sBAAY,GAAG,mBAAmB,CAAA;IAoDlD,gBAAC;CAAA,AArDD,CAA+B,oBAAa,GAqD3C;AArDY,8BAAS;AAuDtB;IAA+C,qDAAS;IAEtD,mCACS,OAAyC,EAChD,UAAoC;QAD7B,wBAAA,EAAA,iCAAyC;QADlD,YAIE,kBAAM,OAAO,EAAE,UAAU,CAAC,SAE3B;QALQ,aAAO,GAAP,OAAO,CAAkC;QAF3C,UAAI,GAAG,2BAA2B,CAAA;QAMvC,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAA;;IAClE,CAAC;IACH,gCAAC;AAAD,CAAC,AATD,CAA+C,kBAAS,GASvD;AATY,8DAAyB;AAWtC;IAAsD,4DAAS;IAE7D,0CACS,OAAiD,EACxD,UAAoC;QAD7B,wBAAA,EAAA,yCAAiD;QAD1D,YAIE,kBAAM,OAAO,EAAE,UAAU,CAAC,SAE3B;QALQ,aAAO,GAAP,OAAO,CAA0C;QAFnD,UAAI,GAAG,kCAAkC,CAAA;QAM9C,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,gCAAgC,CAAC,SAAS,CAAC,CAAA;;IACzE,CAAC;IACH,uCAAC;AAAD,CAAC,AATD,CAAsD,kBAAS,GAS9D;AATY,4EAAgC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tillhub/javascript-sdk",
3
- "version": "4.111.0",
3
+ "version": "4.112.0",
4
4
  "description": "The JavaScript (Browser) SDK for the Tillhub API.",
5
5
  "keywords": [],
6
6
  "main": "dist/tillhub-js.js",