@pexcode/dlis-sdk 1.0.0 → 1.1.1

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.
@@ -0,0 +1,7 @@
1
+ export declare enum ShippingZone {
2
+ NEARBY = "nearby",
3
+ LOCAL = "local",
4
+ REGIONAL = "regional",
5
+ NATIONAL = "national",
6
+ INTERNATIONAL = "international"
7
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ShippingZone = void 0;
4
+ /* generated using openapi-typescript-codegen -- do not edit */
5
+ /* istanbul ignore file */
6
+ /* tslint:disable */
7
+ /* eslint-disable */
8
+ var ShippingZone;
9
+ (function (ShippingZone) {
10
+ ShippingZone["NEARBY"] = "nearby";
11
+ ShippingZone["LOCAL"] = "local";
12
+ ShippingZone["REGIONAL"] = "regional";
13
+ ShippingZone["NATIONAL"] = "national";
14
+ ShippingZone["INTERNATIONAL"] = "international";
15
+ })(ShippingZone || (exports.ShippingZone = ShippingZone = {}));
@@ -2,6 +2,7 @@ import type { BranchId } from './BranchId';
2
2
  import type { CostId } from './CostId';
3
3
  import type { Currencies } from './Currencies';
4
4
  import type { PackageType } from './PackageType';
5
+ import type { ShippingZone } from './ShippingZone';
5
6
  import type { Sizes } from './Sizes';
6
7
  import type { TenantId } from './TenantId';
7
8
  export type costModelAttributes = {
@@ -10,6 +11,9 @@ export type costModelAttributes = {
10
11
  branchId: BranchId;
11
12
  type: PackageType;
12
13
  typeId: number;
14
+ /**
15
+ * true = V1 (enum size); false = V2 (numeric size/height/width)
16
+ */
13
17
  modelV1: boolean;
14
18
  costPerKilometer: number;
15
19
  costPerKg: number;
@@ -19,11 +23,28 @@ export type costModelAttributes = {
19
23
  cityBaseCosts: number;
20
24
  unit: string;
21
25
  currency: Currencies;
26
+ /**
27
+ * V2: package size (manual number). V1: unused (0).
28
+ */
22
29
  maxLong: number;
30
+ /**
31
+ * V2: package width
32
+ */
23
33
  maxWidth?: number;
34
+ /**
35
+ * V2: package height
36
+ */
37
+ maxHeight?: number;
38
+ /**
39
+ * V2 only: shipping coverage zone
40
+ */
41
+ shippingZone?: ShippingZone;
24
42
  weight: number;
25
43
  isDeleted: boolean;
26
44
  createdAt?: string;
27
45
  updatedAt?: string;
28
- size: Sizes;
46
+ /**
47
+ * V1 only: sm / md / lg. Optional for V2.
48
+ */
49
+ size?: Sizes;
29
50
  };
@@ -11,6 +11,7 @@ import type { PackageType } from './PackageType';
11
11
  import type { ProofOfDeliveryType } from './ProofOfDeliveryType';
12
12
  import type { SdkId } from './SdkId';
13
13
  import type { ShippingOption } from './ShippingOption';
14
+ import type { ShippingZone } from './ShippingZone';
14
15
  import type { Sizes } from './Sizes';
15
16
  import type { TenantId } from './TenantId';
16
17
  import type { UserId } from './UserId';
@@ -46,7 +47,14 @@ export type packagesAttributes = {
46
47
  updatedAt?: string;
47
48
  uuid: string;
48
49
  roadGroupId?: string;
49
- size: Sizes;
50
+ /**
51
+ * V1: sm/md/lg. V2: dimensions string e.g. "50×50×50".
52
+ */
53
+ size: (Sizes | string);
54
+ /**
55
+ * Copied from cost model V2 when created.
56
+ */
57
+ shippingZone?: ShippingZone;
50
58
  wa: boolean;
51
59
  kg: number;
52
60
  roadAt?: string;
@@ -0,0 +1,22 @@
1
+ import type { TenantId } from './TenantId';
2
+ import type { UserId } from './UserId';
3
+ export type tenantsAttributes = {
4
+ id: TenantId;
5
+ ownerId: UserId;
6
+ phone: string;
7
+ name: string;
8
+ avatar?: string;
9
+ address: string;
10
+ country?: string;
11
+ countryId: number;
12
+ cityId: number;
13
+ level: number;
14
+ availableOnlinePayment: boolean;
15
+ isDeleted: boolean;
16
+ confirmedAt?: string;
17
+ email: string;
18
+ status: number;
19
+ createdAt?: string;
20
+ updatedAt?: string;
21
+ blockedAt?: string;
22
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,45 +5,51 @@ import type { HttpSuccess } from '../models/HttpSuccess';
5
5
  import type { SdkInfoAttributes } from '../models/SdkInfoAttributes';
6
6
  import type { SdkLedgerOverview } from '../models/SdkLedgerOverview';
7
7
  import type { ShippingServiceData } from '../models/ShippingServiceData';
8
+ import type { tenantsAttributes } from '../models/tenantsAttributes';
8
9
  import type { CancelablePromise } from '../core/CancelablePromise';
9
10
  export declare class SdkControllerService {
10
11
  /**
11
- * @returns any Ok
12
+ * @returns branchesAttributes Ok
12
13
  * @throws ApiError
13
14
  */
14
15
  static getTenantBranches(): CancelablePromise<Array<branchesAttributes>>;
15
16
  /**
16
- * @returns any Ok
17
+ * @returns SdkInfoAttributes Ok
17
18
  * @throws ApiError
18
19
  */
19
20
  static getMyInfo(): CancelablePromise<SdkInfoAttributes>;
21
+ /**
22
+ * @returns tenantsAttributes Ok
23
+ * @throws ApiError
24
+ */
25
+ static getMyTenant(): CancelablePromise<tenantsAttributes>;
20
26
  /**
21
27
  * @param cityId
22
- * @returns any Ok
28
+ * @returns branchesAttributes Ok
23
29
  * @throws ApiError
24
30
  */
25
31
  static getListOfCity(cityId: number): CancelablePromise<Array<branchesAttributes>>;
26
32
  /**
27
33
  * @param requestBody
28
- * @returns any Ok
34
+ * @returns ShippingServiceData Ok
29
35
  * @throws ApiError
30
36
  */
31
37
  static calculateCost(requestBody: CalculateCostAttributes): CancelablePromise<ShippingServiceData>;
32
38
  /**
33
39
  * @param year
34
40
  * @param month
35
- * @returns any Ok
41
+ * @returns BranchLedgerAttributes Ok
36
42
  * @throws ApiError
37
43
  */
38
44
  static getLedgerList(year?: number, month?: number): CancelablePromise<Array<BranchLedgerAttributes>>;
39
45
  /**
40
- * @returns any Ok
46
+ * @returns SdkLedgerOverview Ok
41
47
  * @throws ApiError
42
48
  */
43
49
  static getLedgerOverView(): CancelablePromise<SdkLedgerOverview>;
44
50
  /**
45
51
  * @param requestBody
46
- * @returns any Ok
52
+ * @returns HttpSuccess Ok
47
53
  * @throws ApiError
48
54
  */
49
55
  static setWebhook(requestBody: {
@@ -5,7 +5,7 @@ const OpenAPI_1 = require("../core/OpenAPI");
5
5
  const request_1 = require("../core/request");
6
6
  class SdkControllerService {
7
7
  /**
8
- * @returns any Ok
8
+ * @returns branchesAttributes Ok
9
9
  * @throws ApiError
10
10
  */
11
11
  static getTenantBranches() {
@@ -15,7 +15,7 @@ class SdkControllerService {
15
15
  });
16
16
  }
17
17
  /**
18
- * @returns any Ok
18
+ * @returns SdkInfoAttributes Ok
19
19
  * @throws ApiError
20
20
  */
21
21
  static getMyInfo() {
@@ -24,9 +24,19 @@ class SdkControllerService {
24
24
  url: '/sdk/v2/me-info',
25
25
  });
26
26
  }
27
+ /**
28
+ * @returns tenantsAttributes Ok
29
+ * @throws ApiError
30
+ */
31
+ static getMyTenant() {
32
+ return (0, request_1.request)(OpenAPI_1.OpenAPI, {
33
+ method: 'GET',
34
+ url: '/sdk/v2/me-tenant',
35
+ });
36
+ }
27
37
  /**
28
38
  * @param cityId
29
- * @returns any Ok
39
+ * @returns branchesAttributes Ok
30
40
  * @throws ApiError
31
41
  */
32
42
  static getListOfCity(cityId) {
@@ -40,7 +50,7 @@ class SdkControllerService {
40
50
  }
41
51
  /**
42
52
  * @param requestBody
43
- * @returns any Ok
53
+ * @returns ShippingServiceData Ok
44
54
  * @throws ApiError
45
55
  */
46
56
  static calculateCost(requestBody) {
@@ -54,7 +64,7 @@ class SdkControllerService {
54
64
  /**
55
65
  * @param year
56
66
  * @param month
57
- * @returns any Ok
67
+ * @returns BranchLedgerAttributes Ok
58
68
  * @throws ApiError
59
69
  */
60
70
  static getLedgerList(year, month) {
@@ -68,7 +78,7 @@ class SdkControllerService {
68
78
  });
69
79
  }
70
80
  /**
71
- * @returns any Ok
81
+ * @returns SdkLedgerOverview Ok
72
82
  * @throws ApiError
73
83
  */
74
84
  static getLedgerOverView() {
@@ -79,7 +89,7 @@ class SdkControllerService {
79
89
  }
80
90
  /**
81
91
  * @param requestBody
82
- * @returns any Ok
92
+ * @returns HttpSuccess Ok
83
93
  * @throws ApiError
84
94
  */
85
95
  static setWebhook(requestBody) {
@@ -8,39 +8,41 @@ import type { CancelablePromise } from '../core/CancelablePromise';
8
8
  export declare class SdkPackagesControllerService {
9
9
  /**
10
10
  * @param id
11
- * @returns any Ok
11
+ * @returns packagesAttributes Ok
12
12
  * @throws ApiError
13
13
  */
14
14
  static getPackageDetails(id: PackageId): CancelablePromise<packagesAttributes>;
15
15
  /**
16
16
  * @param page
17
17
  * @param pageSize
18
- * @returns any Ok
18
+ * @returns packagesAttributes Ok
19
19
  * @throws ApiError
20
20
  */
21
21
  static getList(page?: number, pageSize?: number): CancelablePromise<Array<packagesAttributes>>;
22
22
  /**
23
23
  * @param requestBody
24
- * @returns any Ok
24
+ * @returns packagesAttributes Ok
25
25
  * @throws ApiError
26
26
  */
27
- static createNewPackage(requestBody: SdkPackagesCreationAttributes): CancelablePromise<packagesAttributes>;
27
+ static createNewPackage(requestBody: Array<SdkPackagesCreationAttributes>): CancelablePromise<Array<packagesAttributes>>;
28
28
  /**
29
- * @param id
30
- * @returns any Ok
29
+ * @param requestBody
30
+ * @returns HttpSuccess Ok
31
31
  * @throws ApiError
32
32
  */
33
- static sendDataToCEnter(id: PackageId): CancelablePromise<HttpSuccess>;
33
+ static sendDataToCEnter(requestBody: {
34
+ packageIds: Array<PackageId>;
35
+ }): CancelablePromise<HttpSuccess>;
34
36
  /**
35
37
  * @param id
36
- * @returns any Ok
38
+ * @returns HttpSuccess Ok
37
39
  * @throws ApiError
38
40
  */
39
41
  static canceled(id: PackageId): CancelablePromise<HttpSuccess>;
40
42
  /**
41
43
  * @param id
42
44
  * @param requestBody
43
- * @returns any Ok
45
+ * @returns HttpSuccess Ok
44
46
  * @throws ApiError
45
47
  */
46
48
  static reportPackage(id: PackageId, requestBody: {
@@ -48,7 +50,7 @@ export declare class SdkPackagesControllerService {
48
50
  }): CancelablePromise<HttpSuccess>;
49
51
  /**
50
52
  * @param requestBody
51
- * @returns any Ok
53
+ * @returns ClientAttributes Ok
52
54
  * @throws ApiError
53
55
  */
54
56
  static checkBlackList(requestBody: CheckBlackListAttribute): CancelablePromise<ClientAttributes>;
@@ -6,7 +6,7 @@ const request_1 = require("../core/request");
6
6
  class SdkPackagesControllerService {
7
7
  /**
8
8
  * @param id
9
- * @returns any Ok
9
+ * @returns packagesAttributes Ok
10
10
  * @throws ApiError
11
11
  */
12
12
  static getPackageDetails(id) {
@@ -21,7 +21,7 @@ class SdkPackagesControllerService {
21
21
  /**
22
22
  * @param page
23
23
  * @param pageSize
24
- * @returns any Ok
24
+ * @returns packagesAttributes Ok
25
25
  * @throws ApiError
26
26
  */
27
27
  static getList(page = 1, pageSize = 10) {
@@ -36,7 +36,7 @@ class SdkPackagesControllerService {
36
36
  }
37
37
  /**
38
38
  * @param requestBody
39
- * @returns any Ok
39
+ * @returns packagesAttributes Ok
40
40
  * @throws ApiError
41
41
  */
42
42
  static createNewPackage(requestBody) {
@@ -48,22 +48,21 @@ class SdkPackagesControllerService {
48
48
  });
49
49
  }
50
50
  /**
51
- * @param id
52
- * @returns any Ok
51
+ * @param requestBody
52
+ * @returns HttpSuccess Ok
53
53
  * @throws ApiError
54
54
  */
55
- static sendDataToCEnter(id) {
55
+ static sendDataToCEnter(requestBody) {
56
56
  return (0, request_1.request)(OpenAPI_1.OpenAPI, {
57
- method: 'GET',
58
- url: '/sdk/v2/packages/sentDataToCenter/{id}',
59
- path: {
60
- 'id': id,
61
- },
57
+ method: 'POST',
58
+ url: '/sdk/v2/packages/sentDataToCenter',
59
+ body: requestBody,
60
+ mediaType: 'application/json',
62
61
  });
63
62
  }
64
63
  /**
65
64
  * @param id
66
- * @returns any Ok
65
+ * @returns HttpSuccess Ok
67
66
  * @throws ApiError
68
67
  */
69
68
  static canceled(id) {
@@ -78,7 +77,7 @@ class SdkPackagesControllerService {
78
77
  /**
79
78
  * @param id
80
79
  * @param requestBody
81
- * @returns any Ok
80
+ * @returns HttpSuccess Ok
82
81
  * @throws ApiError
83
82
  */
84
83
  static reportPackage(id, requestBody) {
@@ -94,7 +93,7 @@ class SdkPackagesControllerService {
94
93
  }
95
94
  /**
96
95
  * @param requestBody
97
- * @returns any Ok
96
+ * @returns ClientAttributes Ok
98
97
  * @throws ApiError
99
98
  */
100
99
  static checkBlackList(requestBody) {
@@ -4,13 +4,13 @@ import type { CancelablePromise } from '../core/CancelablePromise';
4
4
  export declare class SdkRegionsControllerService {
5
5
  /**
6
6
  * @param regionId
7
- * @returns any Ok
7
+ * @returns citiesAttributes Ok
8
8
  * @throws ApiError
9
9
  */
10
10
  static getCities(regionId: number): CancelablePromise<Array<citiesAttributes>>;
11
11
  /**
12
12
  * @param countryId
13
- * @returns any Ok
13
+ * @returns regionsAttributes Ok
14
14
  * @throws ApiError
15
15
  */
16
16
  static getRegions(countryId: number): CancelablePromise<Array<regionsAttributes>>;
@@ -6,7 +6,7 @@ const request_1 = require("../core/request");
6
6
  class SdkRegionsControllerService {
7
7
  /**
8
8
  * @param regionId
9
- * @returns any Ok
9
+ * @returns citiesAttributes Ok
10
10
  * @throws ApiError
11
11
  */
12
12
  static getCities(regionId) {
@@ -20,7 +20,7 @@ class SdkRegionsControllerService {
20
20
  }
21
21
  /**
22
22
  * @param countryId
23
- * @returns any Ok
23
+ * @returns regionsAttributes Ok
24
24
  * @throws ApiError
25
25
  */
26
26
  static getRegions(countryId) {
package/dist/index.d.ts CHANGED
@@ -10,19 +10,21 @@ import { regionsAttributes } from "./api/models/regionsAttributes";
10
10
  import { citiesAttributes } from "./api/models/citiesAttributes";
11
11
  import { BranchLedgerAttributes } from "./api/models/BranchLedgerAttributes";
12
12
  import { SdkLedgerOverview } from "./api/models/SdkLedgerOverview";
13
+ import { tenantsAttributes } from "./api/models/tenantsAttributes";
13
14
  export declare class DLISystem {
14
15
  constructor(baseUrl: string, tokenKey: string);
15
16
  GetList(page?: number, pageSize?: number): Promise<packagesAttributes[]>;
16
17
  getCompanyListOfCity(cityId: number): Promise<branchesAttributes[]>;
17
18
  MyInfo(): Promise<SdkInfoAttributes>;
19
+ GetMyTenantInfo(): Promise<tenantsAttributes>;
18
20
  getTenantBranches(): Promise<branchesAttributes[]>;
19
21
  GetPackageDetails(id: string): Promise<packagesAttributes>;
20
22
  CheckBlackList(query: CheckBlackListAttribute): Promise<CheckBlackListAttribute>;
21
23
  CancelOne(id: string): Promise<HttpSuccess>;
22
24
  ReportOne(id: string, body: any): Promise<HttpSuccess>;
23
- CreatePackage(payload: SdkPackagesCreationAttributes): Promise<packagesAttributes>;
25
+ CreatePackage(payload: SdkPackagesCreationAttributes[]): Promise<packagesAttributes[]>;
24
26
  CalculateCost(params: CalculateCostAttributes): Promise<ShippingServiceData>;
25
- SendDataToCenter(id: string): Promise<HttpSuccess>;
27
+ SendDataToCenter(id: string[]): Promise<HttpSuccess>;
26
28
  GetRegionsList(countryId: number): Promise<regionsAttributes[]>;
27
29
  GetCitiesListInByRegion(regionId: number): Promise<citiesAttributes[]>;
28
30
  GetMyLedger(year?: number, month?: number): Promise<BranchLedgerAttributes[]>;
package/dist/index.js CHANGED
@@ -34,6 +34,13 @@ class DLISystem {
34
34
  }
35
35
  throw error;
36
36
  }
37
+ async GetMyTenantInfo() {
38
+ const { result, error } = await (0, api_handler_1.ApiCall)(() => SdkControllerService_1.SdkControllerService.getMyTenant());
39
+ if (result) {
40
+ return result;
41
+ }
42
+ throw error;
43
+ }
37
44
  async getTenantBranches() {
38
45
  const { result, error } = await (0, api_handler_1.ApiCall)(() => SdkControllerService_1.SdkControllerService.getTenantBranches());
39
46
  if (result) {
@@ -84,7 +91,7 @@ class DLISystem {
84
91
  throw error;
85
92
  }
86
93
  async SendDataToCenter(id) {
87
- const { result, error } = await (0, api_handler_1.ApiCall)(() => SdkPackagesControllerService_1.SdkPackagesControllerService.sendDataToCEnter(id));
94
+ const { result, error } = await (0, api_handler_1.ApiCall)(() => SdkPackagesControllerService_1.SdkPackagesControllerService.sendDataToCEnter({ packageIds: id }));
88
95
  if (result) {
89
96
  return result;
90
97
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pexcode/dlis-sdk",
3
- "version": "1.0.0",
3
+ "version": "1.1.1",
4
4
  "description": "This is a library published under Pexcode to help users and developers to use dlis API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",