@or-sdk/ccp 2.2.2-beta.3548.0 → 2.2.2-beta.3550.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 (127) hide show
  1. package/dist/cjs/Ccp.js +4 -0
  2. package/dist/cjs/Ccp.js.map +1 -1
  3. package/dist/cjs/api/contracts-api/contractsApi.js +136 -0
  4. package/dist/cjs/api/contracts-api/contractsApi.js.map +1 -0
  5. package/dist/cjs/api/contracts-api/types.js.map +1 -0
  6. package/dist/cjs/api/custom-skus-api/customSkusApi.js +92 -0
  7. package/dist/cjs/api/custom-skus-api/customSkusApi.js.map +1 -0
  8. package/dist/cjs/api/custom-skus-api/types.js +3 -0
  9. package/dist/cjs/api/custom-skus-api/types.js.map +1 -0
  10. package/dist/cjs/api/index.js +10 -2
  11. package/dist/cjs/api/index.js.map +1 -1
  12. package/dist/cjs/api/patterns-api/constants.js +9 -0
  13. package/dist/cjs/api/patterns-api/constants.js.map +1 -0
  14. package/dist/cjs/api/patterns-api/patternsApi.js +107 -0
  15. package/dist/cjs/api/patterns-api/patternsApi.js.map +1 -0
  16. package/dist/cjs/api/patterns-api/types.js +3 -0
  17. package/dist/cjs/api/patterns-api/types.js.map +1 -0
  18. package/dist/cjs/api/{reporting-api/reportingApi.js → reportingApi.js} +3 -64
  19. package/dist/cjs/api/reportingApi.js.map +1 -0
  20. package/dist/cjs/api/tiers-api/tiersApi.js +78 -0
  21. package/dist/cjs/api/tiers-api/tiersApi.js.map +1 -0
  22. package/dist/cjs/api/tiers-api/types.js +3 -0
  23. package/dist/cjs/api/tiers-api/types.js.map +1 -0
  24. package/dist/cjs/constants.js +16 -0
  25. package/dist/cjs/constants.js.map +1 -1
  26. package/dist/cjs/index.js +1 -0
  27. package/dist/cjs/index.js.map +1 -1
  28. package/dist/cjs/types.js +4 -1
  29. package/dist/cjs/types.js.map +1 -1
  30. package/dist/cjs/{api/reporting-api/utils/adaptParams.js → utils.js} +1 -1
  31. package/dist/cjs/utils.js.map +1 -0
  32. package/dist/esm/Ccp.js +5 -1
  33. package/dist/esm/Ccp.js.map +1 -1
  34. package/dist/esm/api/contracts-api/contractsApi.js +62 -0
  35. package/dist/esm/api/contracts-api/contractsApi.js.map +1 -0
  36. package/dist/esm/api/contracts-api/types.js.map +1 -0
  37. package/dist/esm/api/custom-skus-api/customSkusApi.js +34 -0
  38. package/dist/esm/api/custom-skus-api/customSkusApi.js.map +1 -0
  39. package/dist/esm/api/custom-skus-api/types.js +2 -0
  40. package/dist/esm/api/custom-skus-api/types.js.map +1 -0
  41. package/dist/esm/api/index.js +5 -1
  42. package/dist/esm/api/index.js.map +1 -1
  43. package/dist/esm/api/patterns-api/constants.js +6 -0
  44. package/dist/esm/api/patterns-api/constants.js.map +1 -0
  45. package/dist/esm/api/patterns-api/patternsApi.js +44 -0
  46. package/dist/esm/api/patterns-api/patternsApi.js.map +1 -0
  47. package/dist/esm/api/patterns-api/types.js +2 -0
  48. package/dist/esm/api/patterns-api/types.js.map +1 -0
  49. package/dist/esm/api/reportingApi.js +28 -0
  50. package/dist/esm/api/reportingApi.js.map +1 -0
  51. package/dist/esm/api/tiers-api/tiersApi.js +25 -0
  52. package/dist/esm/api/tiers-api/tiersApi.js.map +1 -0
  53. package/dist/esm/api/tiers-api/types.js +2 -0
  54. package/dist/esm/api/tiers-api/types.js.map +1 -0
  55. package/dist/esm/constants.js +2 -0
  56. package/dist/esm/constants.js.map +1 -1
  57. package/dist/esm/index.js +1 -0
  58. package/dist/esm/index.js.map +1 -1
  59. package/dist/esm/types.js +4 -1
  60. package/dist/esm/types.js.map +1 -1
  61. package/dist/esm/{api/reporting-api/utils/adaptParams.js → utils.js} +1 -1
  62. package/dist/esm/utils.js.map +1 -0
  63. package/dist/types/Ccp.d.ts +5 -1
  64. package/dist/types/Ccp.d.ts.map +1 -1
  65. package/dist/types/api/contracts-api/contractsApi.d.ts +12 -0
  66. package/dist/types/api/contracts-api/contractsApi.d.ts.map +1 -0
  67. package/dist/types/api/contracts-api/types.d.ts +108 -0
  68. package/dist/types/api/contracts-api/types.d.ts.map +1 -0
  69. package/dist/types/api/custom-skus-api/customSkusApi.d.ts +8 -0
  70. package/dist/types/api/custom-skus-api/customSkusApi.d.ts.map +1 -0
  71. package/dist/types/api/custom-skus-api/types.d.ts +14 -0
  72. package/dist/types/api/custom-skus-api/types.d.ts.map +1 -0
  73. package/dist/types/api/index.d.ts +5 -1
  74. package/dist/types/api/index.d.ts.map +1 -1
  75. package/dist/types/api/patterns-api/constants.d.ts +5 -0
  76. package/dist/types/api/patterns-api/constants.d.ts.map +1 -0
  77. package/dist/types/api/patterns-api/patternsApi.d.ts +9 -0
  78. package/dist/types/api/patterns-api/patternsApi.d.ts.map +1 -0
  79. package/dist/types/api/patterns-api/types.d.ts +26 -0
  80. package/dist/types/api/patterns-api/types.d.ts.map +1 -0
  81. package/dist/types/api/reportingApi.d.ts +7 -0
  82. package/dist/types/api/reportingApi.d.ts.map +1 -0
  83. package/dist/types/api/tiers-api/tiersApi.d.ts +7 -0
  84. package/dist/types/api/tiers-api/tiersApi.d.ts.map +1 -0
  85. package/dist/types/api/tiers-api/types.d.ts +13 -0
  86. package/dist/types/api/tiers-api/types.d.ts.map +1 -0
  87. package/dist/types/constants.d.ts +2 -0
  88. package/dist/types/constants.d.ts.map +1 -1
  89. package/dist/types/index.d.ts +1 -0
  90. package/dist/types/index.d.ts.map +1 -1
  91. package/dist/types/types.d.ts +23 -1
  92. package/dist/types/types.d.ts.map +1 -1
  93. package/dist/types/{api/reporting-api/utils/adaptParams.d.ts → utils.d.ts} +1 -1
  94. package/dist/types/utils.d.ts.map +1 -0
  95. package/package.json +1 -1
  96. package/src/Ccp.ts +12 -0
  97. package/src/api/contracts-api/contractsApi.ts +67 -0
  98. package/src/api/contracts-api/types.ts +117 -0
  99. package/src/api/custom-skus-api/customSkusApi.ts +29 -0
  100. package/src/api/custom-skus-api/types.ts +15 -0
  101. package/src/api/index.ts +5 -1
  102. package/src/api/patterns-api/constants.ts +4 -0
  103. package/src/api/patterns-api/patternsApi.ts +44 -0
  104. package/src/api/patterns-api/types.ts +30 -0
  105. package/src/api/reportingApi.ts +27 -0
  106. package/src/api/tiers-api/tiersApi.ts +17 -0
  107. package/src/api/tiers-api/types.ts +12 -0
  108. package/src/constants.ts +3 -0
  109. package/src/index.ts +1 -0
  110. package/src/types.ts +26 -1
  111. package/dist/cjs/api/reporting-api/reportingApi.js.map +0 -1
  112. package/dist/cjs/api/reporting-api/types.js.map +0 -1
  113. package/dist/cjs/api/reporting-api/utils/adaptParams.js.map +0 -1
  114. package/dist/esm/api/reporting-api/reportingApi.js +0 -60
  115. package/dist/esm/api/reporting-api/reportingApi.js.map +0 -1
  116. package/dist/esm/api/reporting-api/types.js.map +0 -1
  117. package/dist/esm/api/reporting-api/utils/adaptParams.js.map +0 -1
  118. package/dist/types/api/reporting-api/reportingApi.d.ts +0 -10
  119. package/dist/types/api/reporting-api/reportingApi.d.ts.map +0 -1
  120. package/dist/types/api/reporting-api/types.d.ts +0 -46
  121. package/dist/types/api/reporting-api/types.d.ts.map +0 -1
  122. package/dist/types/api/reporting-api/utils/adaptParams.d.ts.map +0 -1
  123. package/src/api/reporting-api/reportingApi.ts +0 -108
  124. package/src/api/reporting-api/types.ts +0 -49
  125. /package/dist/cjs/api/{reporting-api → contracts-api}/types.js +0 -0
  126. /package/dist/esm/api/{reporting-api → contracts-api}/types.js +0 -0
  127. /package/src/{api/reporting-api/utils/adaptParams.ts → utils.ts} +0 -0
@@ -0,0 +1,12 @@
1
+ export interface Tier {
2
+ adjustmentId: string;
3
+ adjustmentValue?: number;
4
+ maxUnit: number;
5
+ minUnit: number;
6
+ adjustmentValueCalculation?: number;
7
+ friendlyName: string;
8
+ pricingAdjustmentType?: string;
9
+ endDate: Date;
10
+ startDate: Date;
11
+ skus: string[];
12
+ }
package/src/constants.ts CHANGED
@@ -1,3 +1,6 @@
1
+ export * from './api/patterns-api/constants';
2
+ export * from './api/customers-api/constants';
3
+
1
4
  export const SERVICE_KEY = 'customer-portal-api';
2
5
 
3
6
  export enum SortOrder {
package/src/index.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  export { Ccp } from './Ccp';
2
2
  export * from './types';
3
+ export * from './constants';
package/src/types.ts CHANGED
@@ -3,7 +3,11 @@ import { OrderDirection, Token } from '@or-sdk/base';
3
3
  import { SortOrder } from './constants';
4
4
 
5
5
  export * from './api/customers-api/types';
6
- export * from './api/reporting-api/types';
6
+ export * from './api/contracts-api/types';
7
+ export * from './api/tiers-api/types';
8
+ export * from './api/custom-skus-api/types';
9
+ export * from './api/patterns-api/types';
10
+
7
11
 
8
12
  export type CcpConfig = {
9
13
  /**
@@ -104,6 +108,7 @@ export interface Mapping {
104
108
  export type Sku = {
105
109
  id: string;
106
110
  category?: string;
111
+ listRate?: string;
107
112
  friendlyName?: string;
108
113
  unit?: string;
109
114
  sku: string;
@@ -124,6 +129,26 @@ export interface Flow {
124
129
  url?: string;
125
130
  }
126
131
 
132
+ export type UsageRequestParams = ApiRequestClientId & {
133
+ dateFrom: Date;
134
+ dateTo: Date;
135
+ tiers?: boolean;
136
+ environments?: string[];
137
+ accounts?: string[];
138
+ categories?: string[];
139
+ };
140
+
141
+ export interface Usage {
142
+ date: Date;
143
+ sku: string;
144
+ units: number;
145
+ rate: number;
146
+ cost: number;
147
+ account_id: string;
148
+ environment_id: string;
149
+ flow_id: string;
150
+ }
151
+
127
152
  export type ListPaymentProviderParams = {
128
153
  id?: string;
129
154
  name?: string;
@@ -1 +0,0 @@
1
- {"version":3,"file":"reportingApi.js","sourceRoot":"","sources":["../../../../src/api/reporting-api/reportingApi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,sCAAqC;AAGrC,mDAAkD;AAElD;IAA0C,gCAAO;IAAjD;;QACmB,iBAAW,GAAG,QAAQ,CAAC;;IAoG1C,CAAC;IAnFc,+BAAQ,GAArB;4DAAsB,MAA0B,EAAE,EAA+B;gBAA/B,qBAA6B,EAAE,KAAA,EAA7B,MAAM,YAAA;;;4BACjD,WAAM,IAAI,CAAC,OAAO,CAAC;4BACxB,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,UAAG,IAAI,CAAC,WAAW,WAAQ;4BAClC,MAAM,EAAE,IAAA,yBAAW,EAAqB,MAAM,CAAC;4BAC/C,MAAM,QAAA;yBACP,CAAC,EAAA;4BALF,WAAO,SAKL,EAAC;;;;KACJ;IAkBY,mDAA4B,GAAzC;4DACE,OAA4B,EAC5B,OAA4B;YAA5B,wBAAA,EAAA,YAA4B;;;4BAErB,WAAM,IAAI,CAAC,OAAO,CAAC;4BACxB,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,UAAG,IAAI,CAAC,WAAW,mBAAgB;4BAC1C,MAAM,EAAE,OAAO;4BACf,MAAM,EAAE,OAAO,CAAC,MAAM;yBACvB,CAAC,EAAA;4BALF,WAAO,SAKL,EAAC;;;;KACJ;IAkBY,6CAAsB,GAAnC;4DACE,OAA4B,EAC5B,OAA4B;;;YAA5B,wBAAA,EAAA,YAA4B;;;;wBAExB,IAAI,GAAG,CAAC,CAAC;wBACT,YAAY,GAAG,CAAC,CAAC;wBACjB,OAAO,GAA2B,EAAE,CAAC;;;;wBAIpB,WAAM,IAAI,CAAC,4BAA4B,gCAEjD,OAAO,GACP,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,KACtC,IAAI,MAAA,KAEN,OAAO,CACR,EAAA;;wBAPK,QAAQ,GAAG,SAOhB;wBAED,IAAI,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,MAAM,CAAA;4BAAE,cAAM;wBACnC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;wBACxC,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC9B,IAAI,EAAE,CAAC;;;;wBAEP,MAAM,IAAI,KAAK,CAAC,8BAAuB,IAAI,eAAK,OAAK,CAAE,CAAC,CAAC;;4BAEpD,OAAO,CAAC,MAAM,IAAI,YAAY;;4BAEvC,WAAO,OAAO,EAAC;;;;KAChB;IACH,mBAAC;AAAD,CAAC,AArGD,CAA0C,iBAAO,GAqGhD"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/reporting-api/types.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"adaptParams.js","sourceRoot":"","sources":["../../../../../src/api/reporting-api/utils/adaptParams.ts"],"names":[],"mappings":";;AAAA,kCAQC;AARD,SAAgB,WAAW,CAAoC,MAAS;IACtE,IAAM,CAAC,GAAG,EAAiC,CAAC;IAE3C,MAAM,CAAC,OAAO,CAAC,MAAM,CAA+B,CAAC,OAAO,CAAC,UAAC,EAAM;YAAL,CAAC,QAAA,EAAE,CAAC,QAAA;QAClE,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;;YACjC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,CAAC;AACX,CAAC"}
@@ -1,60 +0,0 @@
1
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
- return new (P || (P = Promise))(function (resolve, reject) {
4
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
- step((generator = generator.apply(thisArg, _arguments || [])).next());
8
- });
9
- };
10
- import { BaseApi } from '../baseApi';
11
- import { adaptParams } from './utils/adaptParams';
12
- export default class ReportingApi extends BaseApi {
13
- constructor() {
14
- super(...arguments);
15
- this.apiBasePath = 'api/v1';
16
- }
17
- getUsage(params_1) {
18
- return __awaiter(this, arguments, void 0, function* (params, { signal } = {}) {
19
- return yield this.apiCall({
20
- method: 'GET',
21
- route: `${this.apiBasePath}/usage`,
22
- params: adaptParams(params),
23
- signal,
24
- });
25
- });
26
- }
27
- retrivePaginatedUsageTraffic(filters_1) {
28
- return __awaiter(this, arguments, void 0, function* (filters, options = {}) {
29
- return yield this.apiCall({
30
- method: 'GET',
31
- route: `${this.apiBasePath}/usage-traffic`,
32
- params: filters,
33
- signal: options.signal,
34
- });
35
- });
36
- }
37
- retriveAllUsageTraffic(filters_1) {
38
- return __awaiter(this, arguments, void 0, function* (filters, options = {}) {
39
- var _a;
40
- let page = 1;
41
- let totalRecords = 0;
42
- let results = [];
43
- do {
44
- try {
45
- const response = yield this.retrivePaginatedUsageTraffic(Object.assign(Object.assign(Object.assign({}, filters), (!filters.limit && { limit: 1000 })), { page }), options);
46
- if (!((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.length))
47
- break;
48
- results = results.concat(response.data);
49
- totalRecords = response.total;
50
- page++;
51
- }
52
- catch (error) {
53
- throw new Error(`Error fetching page ${page}: ${error}`);
54
- }
55
- } while (results.length <= totalRecords);
56
- return results;
57
- });
58
- }
59
- }
60
- //# sourceMappingURL=reportingApi.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"reportingApi.js","sourceRoot":"","sources":["../../../../src/api/reporting-api/reportingApi.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAGrC,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,OAAO;IAAjD;;QACmB,gBAAW,GAAG,QAAQ,CAAC;IAoG1C,CAAC;IAnFc,QAAQ;6DAAC,MAA0B,EAAE,EAAE,MAAM,KAAqB,EAAE;YAC/E,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,QAAQ;gBAClC,MAAM,EAAE,WAAW,CAAqB,MAAM,CAAC;gBAC/C,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;IAkBY,4BAA4B;6DACvC,OAA4B,EAC5B,UAA0B,EAAE;YAE5B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,gBAAgB;gBAC1C,MAAM,EAAE,OAAO;gBACf,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC,CAAC;QACL,CAAC;KAAA;IAkBY,sBAAsB;6DACjC,OAA4B,EAC5B,UAA0B,EAAE;;YAE5B,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,IAAI,YAAY,GAAG,CAAC,CAAC;YACrB,IAAI,OAAO,GAA2B,EAAE,CAAC;YAEzC,GAAG,CAAC;gBACF,IAAI,CAAC;oBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,4BAA4B,+CAEjD,OAAO,GACP,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,KACtC,IAAI,KAEN,OAAO,CACR,CAAC;oBAEF,IAAI,CAAC,CAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,MAAM,CAAA;wBAAE,MAAM;oBACnC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBACxC,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC;oBAC9B,IAAI,EAAE,CAAC;gBACT,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC,QAAQ,OAAO,CAAC,MAAM,IAAI,YAAY,EAAE;YAEzC,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;CACF"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/api/reporting-api/types.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"adaptParams.js","sourceRoot":"","sources":["../../../../../src/api/reporting-api/utils/adaptParams.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,WAAW,CAAoC,MAAS;IACtE,MAAM,CAAC,GAAG,EAAiC,CAAC;IAE3C,MAAM,CAAC,OAAO,CAAC,MAAM,CAA+B,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QACvE,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;;YACjC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,CAAC;AACX,CAAC"}
@@ -1,10 +0,0 @@
1
- import { Usage, OptionalParams, PaginatedResponse } from '../../types';
2
- import { BaseApi } from '../baseApi';
3
- import { FindUsageTrafficDto, UsageRequestParams, UsageTrafficDto } from './types';
4
- export default class ReportingApi extends BaseApi {
5
- private readonly apiBasePath;
6
- getUsage(params: UsageRequestParams, { signal }?: OptionalParams): Promise<Usage[]>;
7
- retrivePaginatedUsageTraffic(filters: FindUsageTrafficDto, options?: OptionalParams): Promise<PaginatedResponse<UsageTrafficDto>>;
8
- retriveAllUsageTraffic(filters: FindUsageTrafficDto, options?: OptionalParams): Promise<UsageTrafficDto[]>;
9
- }
10
- //# sourceMappingURL=reportingApi.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"reportingApi.d.ts","sourceRoot":"","sources":["../../../../src/api/reporting-api/reportingApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAGnF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,OAAO;IAC/C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAY;IAiB3B,QAAQ,CAAC,MAAM,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,GAAE,cAAmB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAyBvF,4BAA4B,CACvC,OAAO,EAAE,mBAAmB,EAC5B,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAyBjC,sBAAsB,CACjC,OAAO,EAAE,mBAAmB,EAC5B,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,eAAe,EAAE,CAAC;CA2B9B"}
@@ -1,46 +0,0 @@
1
- import { ApiParamsRequestDto, ApiRequestClientId } from '../../types';
2
- export type UsageRequestParams = ApiRequestClientId & {
3
- dateFrom: Date;
4
- dateTo: Date;
5
- tiers?: boolean;
6
- environments?: string[];
7
- accounts?: string[];
8
- categories?: string[];
9
- };
10
- export type Usage = {
11
- date: Date;
12
- sku: string;
13
- units: number;
14
- rate: number;
15
- cost: number;
16
- account_id: string;
17
- environment_id: string;
18
- flow_id: string;
19
- };
20
- export type FindUsageTrafficDto = ApiRequestClientId & {
21
- dateFrom: Date;
22
- dateTo: Date;
23
- environmentId?: string;
24
- accountId?: string;
25
- category?: string;
26
- sku?: string;
27
- flowId?: string;
28
- } & ApiParamsRequestDto;
29
- export type UsageTrafficDto = {
30
- id: string;
31
- environmentId?: string;
32
- accountId?: string;
33
- customerId?: string;
34
- sourceProvider: string;
35
- sourceId: string;
36
- dateFrom: Date;
37
- dateTo: Date;
38
- category: string;
39
- sku: string;
40
- amount: number;
41
- rate: number;
42
- sum: number;
43
- flowEvents: Array<object>;
44
- meta: object;
45
- };
46
- //# sourceMappingURL=types.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/api/reporting-api/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtE,MAAM,MAAM,kBAAkB,GAAG,kBAAkB,GAAG;IACpD,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,GAAG;IACrD,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GAAG,mBAAmB,CAAC;AAExB,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"adaptParams.d.ts","sourceRoot":"","sources":["../../../../../src/api/reporting-api/utils/adaptParams.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO;CAAE,CAQrG"}
@@ -1,108 +0,0 @@
1
- import { Usage, OptionalParams, PaginatedResponse } from '../../types';
2
- import { BaseApi } from '../baseApi';
3
-
4
- import { FindUsageTrafficDto, UsageRequestParams, UsageTrafficDto } from './types';
5
- import { adaptParams } from './utils/adaptParams';
6
-
7
- export default class ReportingApi extends BaseApi {
8
- private readonly apiBasePath = 'api/v1';
9
-
10
- /**
11
- * Fetches usage data based on the provided parameters.
12
- *
13
- * @param {UsageRequestParams} params - The parameters to filter usage data.
14
- * @param {string} params.clientId - Unique identifier for the client.
15
- * @param {Date} params.dateFrom - The start date for the usage data query.
16
- * @param {Date} params.dateTo - The end date for the usage data query.
17
- * @param {boolean} [params.tiers] - Optional filter to include tier information.
18
- * @param {string[]} [params.environments] - Optional filter to specify environments.
19
- * @param {string[]} [params.accounts] - Optional filter to specify accounts.
20
- * @param {string[]} [params.categories] - Optional filter to specify categories.
21
- * @param {OptionalParams} [options.signal={}] - Optional parameters.
22
- * @param {AbortSignal} [options.signal] - An abort signal to cancel the request if needed.
23
- * @returns {Promise<Usage[]>} - A promise that resolves to an array of Usage data.
24
- */
25
- public async getUsage(params: UsageRequestParams, { signal }: OptionalParams = {}): Promise<Usage[]> {
26
- return await this.apiCall({
27
- method: 'GET',
28
- route: `${this.apiBasePath}/usage`,
29
- params: adaptParams<UsageRequestParams>(params),
30
- signal,
31
- });
32
- }
33
-
34
- /**
35
- * Retrieves usage traffic based on specified filters.
36
- *
37
- * @param {FindUsageTrafficDto} filters - The filters to apply for retrieving usage traffic.
38
- * @param {string} filters.clientId - Unique identifier for the client.
39
- * @param {Date} filters.dateFrom - The start date for the traffic data query.
40
- * @param {Date} filters.dateTo - The end date for the traffic data query.
41
- * @param {string} [filters.environmentId] - Optional filter to specify the environment ID.
42
- * @param {string} [filters.accountId] - Optional filter to specify the account ID.
43
- * @param {string} [filters.category] - Optional filter to specify the category.
44
- * @param {string} [filters.sku] - Optional filter to specify the SKU.
45
- * @param {string} [filters.flowId] - Optional filter to specify the flow ID.
46
- * @param {OptionalParams} [options={}] - Optional parameters.
47
- * @param {AbortSignal} [options.signal] - An abort signal to cancel the request if needed.
48
- * @returns {Promise<PaginatedResponse<UsageTrafficDto>>} - A promise that resolves to an array of UsageTrafficDto data.
49
- */
50
- public async retrivePaginatedUsageTraffic(
51
- filters: FindUsageTrafficDto,
52
- options: OptionalParams = {}
53
- ): Promise<PaginatedResponse<UsageTrafficDto>> {
54
- return await this.apiCall({
55
- method: 'GET',
56
- route: `${this.apiBasePath}/usage-traffic`,
57
- params: filters,
58
- signal: options.signal,
59
- });
60
- }
61
-
62
- /**
63
- * Retrieves usage traffic based on specified filters.
64
- *
65
- * @param {FindUsageTrafficDto} filters - The filters to apply for retrieving usage traffic.
66
- * @param {string} filters.clientId - Unique identifier for the client.
67
- * @param {Date} filters.dateFrom - The start date for the traffic data query.
68
- * @param {Date} filters.dateTo - The end date for the traffic data query.
69
- * @param {string} [filters.environmentId] - Optional filter to specify the environment ID.
70
- * @param {string} [filters.accountId] - Optional filter to specify the account ID.
71
- * @param {string} [filters.category] - Optional filter to specify the category.
72
- * @param {string} [filters.sku] - Optional filter to specify the SKU.
73
- * @param {string} [filters.flowId] - Optional filter to specify the flow ID.
74
- * @param {OptionalParams} [options={}] - Optional parameters.
75
- * @param {AbortSignal} [options.signal] - An abort signal to cancel the request if needed.
76
- * @returns {Promise<UsageTrafficDto[]>} - A promise that resolves to an array of UsageTrafficDto data.
77
- */
78
- public async retriveAllUsageTraffic(
79
- filters: FindUsageTrafficDto,
80
- options: OptionalParams = {}
81
- ): Promise<UsageTrafficDto[]> {
82
- let page = 1;
83
- let totalRecords = 0;
84
- let results: Array<UsageTrafficDto> = [];
85
-
86
- do {
87
- try {
88
- const response = await this.retrivePaginatedUsageTraffic(
89
- {
90
- ...filters,
91
- ...(!filters.limit && { limit: 1000 }),
92
- page,
93
- },
94
- options
95
- );
96
-
97
- if (!response?.data?.length) break;
98
- results = results.concat(response.data);
99
- totalRecords = response.total;
100
- page++;
101
- } catch (error) {
102
- throw new Error(`Error fetching page ${page}: ${error}`);
103
- }
104
- } while (results.length <= totalRecords);
105
-
106
- return results;
107
- }
108
- }
@@ -1,49 +0,0 @@
1
- import { ApiParamsRequestDto, ApiRequestClientId } from '../../types';
2
-
3
- export type UsageRequestParams = ApiRequestClientId & {
4
- dateFrom: Date;
5
- dateTo: Date;
6
- tiers?: boolean;
7
- environments?: string[];
8
- accounts?: string[];
9
- categories?: string[];
10
- };
11
-
12
- export type Usage = {
13
- date: Date;
14
- sku: string;
15
- units: number;
16
- rate: number;
17
- cost: number;
18
- account_id: string;
19
- environment_id: string;
20
- flow_id: string;
21
- };
22
-
23
- export type FindUsageTrafficDto = ApiRequestClientId & {
24
- dateFrom: Date;
25
- dateTo: Date;
26
- environmentId?: string;
27
- accountId?: string;
28
- category?: string;
29
- sku?: string;
30
- flowId?: string;
31
- } & ApiParamsRequestDto;
32
-
33
- export type UsageTrafficDto = {
34
- id: string;
35
- environmentId?: string;
36
- accountId?: string;
37
- customerId?: string;
38
- sourceProvider: string;
39
- sourceId: string;
40
- dateFrom: Date;
41
- dateTo: Date;
42
- category: string;
43
- sku: string;
44
- amount: number;
45
- rate: number;
46
- sum: number;
47
- flowEvents: Array<object>;
48
- meta: object;
49
- };