@tillhub/javascript-sdk 4.89.0 → 4.90.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
@@ -1,3 +1,11 @@
1
+ # [4.90.0](https://github.com/tillhub/tillhub-sdk-javascript/compare/v4.89.0...v4.90.0) (2023-09-06)
2
+
3
+
4
+ ### Features
5
+
6
+ * **stock management:** add getAll method for consignment notes entity ([a74c6ef](https://github.com/tillhub/tillhub-sdk-javascript/commit/a74c6ef77db5a5ec116fdb909abc5db11c796ae5))
7
+ * **stock management:** fix linting issues ([4eb5fd9](https://github.com/tillhub/tillhub-sdk-javascript/commit/4eb5fd91964359ad8a77be6e3cae29843e5d1b85))
8
+
1
9
  # [4.89.0](https://github.com/tillhub/tillhub-sdk-javascript/compare/v4.88.0...v4.89.0) (2023-09-05)
2
10
 
3
11
 
@@ -1,9 +1,31 @@
1
1
  import { Client } from '../client';
2
+ import { BaseError } from '../errors';
2
3
  import { UriHelper } from '../uri-helper';
3
4
  import { ThBaseHandler } from '../base';
5
+ export interface ConsignmentNotesResponse {
6
+ data?: ConsignmentNote[];
7
+ metadata?: Record<string, unknown>;
8
+ msg?: string;
9
+ next?: () => Promise<ConsignmentNotesResponse>;
10
+ }
11
+ export interface ConsignmentNote {
12
+ id: string;
13
+ createdAt?: string;
14
+ createdBy?: string;
15
+ purchaseOrder?: {
16
+ id?: string;
17
+ };
18
+ consignmentNoteNumber: string;
19
+ }
4
20
  export interface ConsignmentNotesOptions {
5
- user?: string;
6
21
  base?: string;
22
+ limit?: number;
23
+ uri?: string;
24
+ query?: ConsignmentNotesQuery;
25
+ }
26
+ export interface ConsignmentNotesQuery {
27
+ consignmentNoteNumber?: string;
28
+ [key: string]: any;
7
29
  }
8
30
  export interface ConsignmentNotesPdfResponse {
9
31
  data?: string;
@@ -17,5 +39,11 @@ export declare class ConsignmentNotes extends ThBaseHandler {
17
39
  options: ConsignmentNotesOptions;
18
40
  uriHelper: UriHelper;
19
41
  constructor(options: ConsignmentNotesOptions, http: Client);
42
+ getAll(options?: ConsignmentNotesOptions | undefined): Promise<ConsignmentNotesResponse>;
20
43
  pdfUri(consignmentNoteId: string): Promise<ConsignmentNotesPdfResponse>;
21
44
  }
45
+ export declare class ConsignmentNotesFetchFailed extends BaseError {
46
+ message: string;
47
+ name: string;
48
+ constructor(message?: string, properties?: Record<string, unknown>);
49
+ }
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ConsignmentNotes = void 0;
3
+ exports.ConsignmentNotesFetchFailed = exports.ConsignmentNotes = 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,9 +20,44 @@ var ConsignmentNotes = (function (_super) {
20
20
  _this.uriHelper = new uri_helper_1.UriHelper(_this.endpoint, _this.options);
21
21
  return _this;
22
22
  }
23
+ ConsignmentNotes.prototype.getAll = function (options) {
24
+ var _a;
25
+ return tslib_1.__awaiter(this, void 0, void 0, function () {
26
+ var next, base, uri, response_1, error_1;
27
+ var _this = this;
28
+ return tslib_1.__generator(this, function (_b) {
29
+ switch (_b.label) {
30
+ case 0:
31
+ _b.trys.push([0, 2, , 3]);
32
+ base = this.uriHelper.generateBaseUri();
33
+ uri = this.uriHelper.generateUriWithQuery(base, options);
34
+ return [4, this.http.getClient().get(uri)];
35
+ case 1:
36
+ response_1 = _b.sent();
37
+ if (response_1.status !== 200) {
38
+ throw new ConsignmentNotesFetchFailed(undefined, { status: response_1.status });
39
+ }
40
+ if ((_a = response_1.data.cursor) === null || _a === void 0 ? void 0 : _a.next) {
41
+ next = function () {
42
+ return _this.getAll({ uri: response_1.data.cursor.next });
43
+ };
44
+ }
45
+ return [2, {
46
+ data: response_1.data.results,
47
+ metadata: { count: response_1.data.count, cursor: response_1.data.cursor },
48
+ next: next
49
+ }];
50
+ case 2:
51
+ error_1 = _b.sent();
52
+ throw new ConsignmentNotesFetchFailed(error_1.message, { error: error_1 });
53
+ case 3: return [2];
54
+ }
55
+ });
56
+ });
57
+ };
23
58
  ConsignmentNotes.prototype.pdfUri = function (consignmentNoteId) {
24
59
  return tslib_1.__awaiter(this, void 0, void 0, function () {
25
- var base, uri, response, pdfObj, error_1;
60
+ var base, uri, response, pdfObj, error_2;
26
61
  return tslib_1.__generator(this, function (_a) {
27
62
  switch (_a.label) {
28
63
  case 0:
@@ -39,8 +74,8 @@ var ConsignmentNotes = (function (_super) {
39
74
  filename: pdfObj.filename
40
75
  }];
41
76
  case 2:
42
- error_1 = _a.sent();
43
- throw new ConsignmentNotesPdfFailed(error_1.message);
77
+ error_2 = _a.sent();
78
+ throw new ConsignmentNotesPdfFailed(error_2.message);
44
79
  case 3: return [2];
45
80
  }
46
81
  });
@@ -50,6 +85,19 @@ var ConsignmentNotes = (function (_super) {
50
85
  return ConsignmentNotes;
51
86
  }(base_1.ThBaseHandler));
52
87
  exports.ConsignmentNotes = ConsignmentNotes;
88
+ var ConsignmentNotesFetchFailed = (function (_super) {
89
+ tslib_1.__extends(ConsignmentNotesFetchFailed, _super);
90
+ function ConsignmentNotesFetchFailed(message, properties) {
91
+ if (message === void 0) { message = 'Could not fetch the consignment notes'; }
92
+ var _this = _super.call(this, message, properties) || this;
93
+ _this.message = message;
94
+ _this.name = 'ConsignmentNotesFetchFailed';
95
+ Object.setPrototypeOf(_this, ConsignmentNotesFetchFailed.prototype);
96
+ return _this;
97
+ }
98
+ return ConsignmentNotesFetchFailed;
99
+ }(errors_1.BaseError));
100
+ exports.ConsignmentNotesFetchFailed = ConsignmentNotesFetchFailed;
53
101
  var ConsignmentNotesPdfFailed = (function (_super) {
54
102
  tslib_1.__extends(ConsignmentNotesPdfFailed, _super);
55
103
  function ConsignmentNotesPdfFailed(message, properties) {
@@ -1 +1 @@
1
- {"version":3,"file":"consignment_notes.js","sourceRoot":"","sources":["../../src/v0/consignment_notes.ts"],"names":[],"mappings":";;;;AACA,oCAAqC;AACrC,4CAAyC;AACzC,gCAAuC;AAavC;IAAsC,4CAAa;IAOjD,0BAAa,OAAgC,EAAE,IAAY;;QAA3D,YACE,kBAAM,IAAI,EAAE;YACV,QAAQ,EAAE,gBAAgB,CAAC,YAAY;YACvC,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,gBAAgB,CAAC,YAAY,CAAA;QAC7C,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,iCAAM,GAAZ,UAAc,iBAAyB;;;;;;;wBAE7B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,MAAI,iBAAiB,SAAM,CAAC,CAAA;wBAClE,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAA;wBAEpC,WAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAA;;wBAA/C,QAAQ,GAAG,SAAoC;wBAC/C,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;wBAEvC,WAAO;gCACL,IAAI,EAAE,MAAM,CAAC,aAAa;gCAC1B,WAAW,EAAE,MAAM,CAAC,WAAW;gCAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ;6BAC1B,EAAA;;;wBAED,MAAM,IAAI,yBAAyB,CAAC,OAAK,CAAC,OAAO,CAAC,CAAA;;;;;KAErD;IAnCa,6BAAY,GAAG,2BAA2B,CAAA;IAoC1D,uBAAC;CAAA,AArCD,CAAsC,oBAAa,GAqClD;AArCY,4CAAgB;AAuC7B;IAAwC,qDAAS;IAE/C,mCACS,OAA0C,EACjD,UAAoC;QAD7B,wBAAA,EAAA,kCAA0C;QADnD,YAIE,kBAAM,OAAO,EAAE,UAAU,CAAC,SAE3B;QALQ,aAAO,GAAP,OAAO,CAAmC;QAF5C,UAAI,GAAG,2BAA2B,CAAA;QAMvC,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAA;;IAClE,CAAC;IACH,gCAAC;AAAD,CAAC,AATD,CAAwC,kBAAS,GAShD"}
1
+ {"version":3,"file":"consignment_notes.js","sourceRoot":"","sources":["../../src/v0/consignment_notes.ts"],"names":[],"mappings":";;;;AACA,oCAAqC;AACrC,4CAAyC;AACzC,gCAAuC;AAoCvC;IAAsC,4CAAa;IAOjD,0BAAa,OAAgC,EAAE,IAAY;;QAA3D,YACE,kBAAM,IAAI,EAAE;YACV,QAAQ,EAAE,gBAAgB,CAAC,YAAY;YACvC,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,gBAAgB,CAAC,YAAY,CAAA;QAC7C,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,iCAAM,GAAZ,UAAc,OAA6C;;;;;;;;;wBAIjD,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAA;wBACvC,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;wBAE7C,WAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAA;;wBAA/C,aAAW,SAAoC;wBAErD,IAAI,UAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;4BAC3B,MAAM,IAAI,2BAA2B,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,UAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;yBAC9E;wBAED,UAAI,UAAQ,CAAC,IAAI,CAAC,MAAM,0CAAE,IAAI,EAAE;4BAC9B,IAAI,GAAG;gCACL,OAAA,KAAI,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,UAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;4BAA/C,CAA+C,CAAA;yBAClD;wBAED,WAAO;gCACL,IAAI,EAAE,UAAQ,CAAC,IAAI,CAAC,OAAO;gCAC3B,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,UAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;gCACtE,IAAI,MAAA;6BACL,EAAA;;;wBAED,MAAM,IAAI,2BAA2B,CAAC,OAAK,CAAC,OAAO,EAAE,EAAE,KAAK,SAAA,EAAE,CAAC,CAAA;;;;;KAElE;IAEK,iCAAM,GAAZ,UAAc,iBAAyB;;;;;;;wBAE7B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,MAAI,iBAAiB,SAAM,CAAC,CAAA;wBAClE,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAA;wBAEpC,WAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAA;;wBAA/C,QAAQ,GAAG,SAAoC;wBAC/C,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;wBAEvC,WAAO;gCACL,IAAI,EAAE,MAAM,CAAC,aAAa;gCAC1B,WAAW,EAAE,MAAM,CAAC,WAAW;gCAC/B,QAAQ,EAAE,MAAM,CAAC,QAAQ;6BAC1B,EAAA;;;wBAED,MAAM,IAAI,yBAAyB,CAAC,OAAK,CAAC,OAAO,CAAC,CAAA;;;;;KAErD;IA/Da,6BAAY,GAAG,2BAA2B,CAAA;IAgE1D,uBAAC;CAAA,AAjED,CAAsC,oBAAa,GAiElD;AAjEY,4CAAgB;AAmE7B;IAAiD,uDAAS;IAExD,qCACS,OAAyD,EAChE,UAAoC;QAD7B,wBAAA,EAAA,iDAAyD;QADlE,YAIE,kBAAM,OAAO,EAAE,UAAU,CAAC,SAE3B;QALQ,aAAO,GAAP,OAAO,CAAkD;QAF3D,UAAI,GAAG,6BAA6B,CAAA;QAMzC,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAA;;IACpE,CAAC;IACH,kCAAC;AAAD,CAAC,AATD,CAAiD,kBAAS,GASzD;AATY,kEAA2B;AAUxC;IAAwC,qDAAS;IAE/C,mCACS,OAA0C,EACjD,UAAoC;QAD7B,wBAAA,EAAA,kCAA0C;QADnD,YAIE,kBAAM,OAAO,EAAE,UAAU,CAAC,SAE3B;QALQ,aAAO,GAAP,OAAO,CAAmC;QAF5C,UAAI,GAAG,2BAA2B,CAAA;QAMvC,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAA;;IAClE,CAAC;IACH,gCAAC;AAAD,CAAC,AATD,CAAwC,kBAAS,GAShD"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tillhub/javascript-sdk",
3
- "version": "4.89.0",
3
+ "version": "4.90.0",
4
4
  "description": "The JavaScript (Browser) SDK for the Tillhub API.",
5
5
  "keywords": [],
6
6
  "main": "dist/tillhub-js.js",