@or-sdk/ccp 2.2.2-beta.3541.0 → 2.2.2-beta.3545.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 (126) hide show
  1. package/dist/cjs/Ccp.js +0 -4
  2. package/dist/cjs/Ccp.js.map +1 -1
  3. package/dist/cjs/api/index.js +2 -10
  4. package/dist/cjs/api/index.js.map +1 -1
  5. package/dist/cjs/api/{reportingApi.js → reporting-api/reportingApi.js} +19 -3
  6. package/dist/cjs/api/reporting-api/reportingApi.js.map +1 -0
  7. package/dist/cjs/api/reporting-api/types.js.map +1 -0
  8. package/dist/cjs/{utils.js → api/reporting-api/utils/adaptParams.js} +1 -1
  9. package/dist/cjs/api/reporting-api/utils/adaptParams.js.map +1 -0
  10. package/dist/cjs/constants.js +0 -16
  11. package/dist/cjs/constants.js.map +1 -1
  12. package/dist/cjs/index.js +0 -1
  13. package/dist/cjs/index.js.map +1 -1
  14. package/dist/cjs/types.js +1 -4
  15. package/dist/cjs/types.js.map +1 -1
  16. package/dist/esm/Ccp.js +1 -5
  17. package/dist/esm/Ccp.js.map +1 -1
  18. package/dist/esm/api/index.js +1 -5
  19. package/dist/esm/api/index.js.map +1 -1
  20. package/dist/esm/api/{reportingApi.js → reporting-api/reportingApi.js} +12 -2
  21. package/dist/esm/api/reporting-api/reportingApi.js.map +1 -0
  22. package/dist/esm/api/reporting-api/types.js.map +1 -0
  23. package/dist/esm/{utils.js → api/reporting-api/utils/adaptParams.js} +1 -1
  24. package/dist/esm/api/reporting-api/utils/adaptParams.js.map +1 -0
  25. package/dist/esm/constants.js +0 -2
  26. package/dist/esm/constants.js.map +1 -1
  27. package/dist/esm/index.js +0 -1
  28. package/dist/esm/index.js.map +1 -1
  29. package/dist/esm/types.js +1 -4
  30. package/dist/esm/types.js.map +1 -1
  31. package/dist/types/Ccp.d.ts +1 -5
  32. package/dist/types/Ccp.d.ts.map +1 -1
  33. package/dist/types/api/index.d.ts +1 -5
  34. package/dist/types/api/index.d.ts.map +1 -1
  35. package/dist/types/api/reporting-api/reportingApi.d.ts +9 -0
  36. package/dist/types/api/reporting-api/reportingApi.d.ts.map +1 -0
  37. package/dist/types/api/reporting-api/types.d.ts +46 -0
  38. package/dist/types/api/reporting-api/types.d.ts.map +1 -0
  39. package/dist/types/{utils.d.ts → api/reporting-api/utils/adaptParams.d.ts} +1 -1
  40. package/dist/types/api/reporting-api/utils/adaptParams.d.ts.map +1 -0
  41. package/dist/types/constants.d.ts +0 -2
  42. package/dist/types/constants.d.ts.map +1 -1
  43. package/dist/types/index.d.ts +0 -1
  44. package/dist/types/index.d.ts.map +1 -1
  45. package/dist/types/types.d.ts +1 -23
  46. package/dist/types/types.d.ts.map +1 -1
  47. package/package.json +1 -1
  48. package/src/Ccp.ts +0 -12
  49. package/src/api/index.ts +1 -5
  50. package/src/api/reporting-api/reportingApi.ts +61 -0
  51. package/src/api/reporting-api/types.ts +49 -0
  52. package/src/constants.ts +0 -3
  53. package/src/index.ts +0 -1
  54. package/src/types.ts +1 -26
  55. package/dist/cjs/api/contracts-api/contractsApi.js +0 -136
  56. package/dist/cjs/api/contracts-api/contractsApi.js.map +0 -1
  57. package/dist/cjs/api/contracts-api/types.js.map +0 -1
  58. package/dist/cjs/api/custom-skus-api/customSkusApi.js +0 -92
  59. package/dist/cjs/api/custom-skus-api/customSkusApi.js.map +0 -1
  60. package/dist/cjs/api/custom-skus-api/types.js +0 -3
  61. package/dist/cjs/api/custom-skus-api/types.js.map +0 -1
  62. package/dist/cjs/api/patterns-api/constants.js +0 -9
  63. package/dist/cjs/api/patterns-api/constants.js.map +0 -1
  64. package/dist/cjs/api/patterns-api/patternsApi.js +0 -107
  65. package/dist/cjs/api/patterns-api/patternsApi.js.map +0 -1
  66. package/dist/cjs/api/patterns-api/types.js +0 -3
  67. package/dist/cjs/api/patterns-api/types.js.map +0 -1
  68. package/dist/cjs/api/reportingApi.js.map +0 -1
  69. package/dist/cjs/api/tiers-api/tiersApi.js +0 -78
  70. package/dist/cjs/api/tiers-api/tiersApi.js.map +0 -1
  71. package/dist/cjs/api/tiers-api/types.js +0 -3
  72. package/dist/cjs/api/tiers-api/types.js.map +0 -1
  73. package/dist/cjs/utils.js.map +0 -1
  74. package/dist/esm/api/contracts-api/contractsApi.js +0 -62
  75. package/dist/esm/api/contracts-api/contractsApi.js.map +0 -1
  76. package/dist/esm/api/contracts-api/types.js.map +0 -1
  77. package/dist/esm/api/custom-skus-api/customSkusApi.js +0 -34
  78. package/dist/esm/api/custom-skus-api/customSkusApi.js.map +0 -1
  79. package/dist/esm/api/custom-skus-api/types.js +0 -2
  80. package/dist/esm/api/custom-skus-api/types.js.map +0 -1
  81. package/dist/esm/api/patterns-api/constants.js +0 -6
  82. package/dist/esm/api/patterns-api/constants.js.map +0 -1
  83. package/dist/esm/api/patterns-api/patternsApi.js +0 -44
  84. package/dist/esm/api/patterns-api/patternsApi.js.map +0 -1
  85. package/dist/esm/api/patterns-api/types.js +0 -2
  86. package/dist/esm/api/patterns-api/types.js.map +0 -1
  87. package/dist/esm/api/reportingApi.js.map +0 -1
  88. package/dist/esm/api/tiers-api/tiersApi.js +0 -25
  89. package/dist/esm/api/tiers-api/tiersApi.js.map +0 -1
  90. package/dist/esm/api/tiers-api/types.js +0 -2
  91. package/dist/esm/api/tiers-api/types.js.map +0 -1
  92. package/dist/esm/utils.js.map +0 -1
  93. package/dist/types/api/contracts-api/contractsApi.d.ts +0 -12
  94. package/dist/types/api/contracts-api/contractsApi.d.ts.map +0 -1
  95. package/dist/types/api/contracts-api/types.d.ts +0 -112
  96. package/dist/types/api/contracts-api/types.d.ts.map +0 -1
  97. package/dist/types/api/custom-skus-api/customSkusApi.d.ts +0 -8
  98. package/dist/types/api/custom-skus-api/customSkusApi.d.ts.map +0 -1
  99. package/dist/types/api/custom-skus-api/types.d.ts +0 -14
  100. package/dist/types/api/custom-skus-api/types.d.ts.map +0 -1
  101. package/dist/types/api/patterns-api/constants.d.ts +0 -5
  102. package/dist/types/api/patterns-api/constants.d.ts.map +0 -1
  103. package/dist/types/api/patterns-api/patternsApi.d.ts +0 -9
  104. package/dist/types/api/patterns-api/patternsApi.d.ts.map +0 -1
  105. package/dist/types/api/patterns-api/types.d.ts +0 -26
  106. package/dist/types/api/patterns-api/types.d.ts.map +0 -1
  107. package/dist/types/api/reportingApi.d.ts +0 -7
  108. package/dist/types/api/reportingApi.d.ts.map +0 -1
  109. package/dist/types/api/tiers-api/tiersApi.d.ts +0 -7
  110. package/dist/types/api/tiers-api/tiersApi.d.ts.map +0 -1
  111. package/dist/types/api/tiers-api/types.d.ts +0 -13
  112. package/dist/types/api/tiers-api/types.d.ts.map +0 -1
  113. package/dist/types/utils.d.ts.map +0 -1
  114. package/src/api/contracts-api/contractsApi.ts +0 -67
  115. package/src/api/contracts-api/types.ts +0 -121
  116. package/src/api/custom-skus-api/customSkusApi.ts +0 -29
  117. package/src/api/custom-skus-api/types.ts +0 -15
  118. package/src/api/patterns-api/constants.ts +0 -4
  119. package/src/api/patterns-api/patternsApi.ts +0 -44
  120. package/src/api/patterns-api/types.ts +0 -30
  121. package/src/api/reportingApi.ts +0 -27
  122. package/src/api/tiers-api/tiersApi.ts +0 -17
  123. package/src/api/tiers-api/types.ts +0 -12
  124. /package/dist/cjs/api/{contracts-api → reporting-api}/types.js +0 -0
  125. /package/dist/esm/api/{contracts-api → reporting-api}/types.js +0 -0
  126. /package/src/{utils.ts → api/reporting-api/utils/adaptParams.ts} +0 -0
@@ -1,121 +0,0 @@
1
- import { ApiParamsRequestDto } from '../../types';
2
-
3
- export type Contract = {
4
- id: string;
5
- customerId?: string;
6
- customerName?: string;
7
- currency?: string;
8
- startDate?: Date;
9
- endDate?: Date;
10
- lateFees?: string;
11
- minimumCustomSupportFee?: number;
12
- minimumPlatformSupportFee?: number;
13
- minimumUsageCommitFee?: number;
14
- name?: string;
15
- paymentTerms?: string;
16
- poNumber?: string;
17
- skuExclusions?: string[];
18
- slackMessageId?: string;
19
- status?: string;
20
- tiers?: string[];
21
- usagePrepaymentBucket?: number;
22
- variablePlatformSupportFee?: number;
23
- credits?: CreditResponse[];
24
- otherFees?: OtherFeeResponse[];
25
- };
26
-
27
- export type Credit = {
28
- sku: string;
29
- value: number;
30
- quantity: number;
31
- category: string;
32
- friendlyName: string;
33
- startDate: Date;
34
- endDate: Date;
35
- };
36
-
37
- export type OtherFee = {
38
- sku: string;
39
- value: number;
40
- quantity: number;
41
- category: string;
42
- friendlyName: string;
43
- startDate: Date;
44
- endDate: Date;
45
- };
46
-
47
- export type CreditResponse = {
48
- id: string;
49
- sku: string;
50
- category: string;
51
- friendlyName: string;
52
- value: number;
53
- quantity: number;
54
- startDate: Date;
55
- endDate: Date;
56
- };
57
-
58
- export type OtherFeeResponse = {
59
- id: string;
60
- sku: string;
61
- category: string;
62
- friendlyName: string;
63
- value: number;
64
- quantity: number;
65
- startDate: Date;
66
- endDate: Date;
67
- };
68
-
69
- export type ContractSearchParams = {
70
- id?: string[];
71
- customerId?: string[];
72
- tier?: string;
73
- search?: string;
74
- } & ApiParamsRequestDto;
75
-
76
-
77
- export type CreateContractDto = {
78
- customerId?: string;
79
- customerName?: string;
80
- currency?: string;
81
- startDate?: Date;
82
- endDate?: Date;
83
- lateFees?: string;
84
- minimumCustomSupportFee?: number;
85
- minimumPlatformSupportFee?: number;
86
- minimumUsageCommitFee?: number;
87
- name?: string;
88
- paymentTerms?: string;
89
- poNumber?: string;
90
- skuExclusions?: string[];
91
- slackMessageId?: string;
92
- status?: string;
93
- tiers?: string[];
94
- usagePrepaymentBucket?: number;
95
- variablePlatformSupportFee?: number;
96
- credits?: Credit[];
97
- otherFees?: OtherFee[];
98
- };
99
-
100
-
101
- export type UpdateContractDto = {
102
- customerId?: string;
103
- currency?: string;
104
- lateFees?: string;
105
- minimumCustomSupportFee?: number;
106
- minimumPlatformSupportFee?: number;
107
- minimumUsageCommitFee?: number;
108
- name?: string;
109
- paymentTerms?: string;
110
- poNumber?: string;
111
- skuExclusions?: string[];
112
- slackMessageId?: string;
113
- status?: string;
114
- tiers?: string[];
115
- usagePrepaymentBucket?: number;
116
- variablePlatformSupportFee?: number;
117
- startDate?: Date;
118
- endDate?: Date;
119
- credits?: Credit[];
120
- otherFees?: OtherFee[];
121
- };
@@ -1,29 +0,0 @@
1
- import { BaseApi } from '../baseApi';
2
-
3
- import { CustomSku, UpdateCustomSkusDto } from './types';
4
-
5
- export default class CustomSkusApi extends BaseApi {
6
- private readonly apiBasePath = 'api/v1/custom-skus';
7
-
8
- /**
9
- * @description get all custom skus
10
- */
11
- public async listOfCustomSkus(): Promise<CustomSku[]> {
12
- return await this.apiCall({
13
- method: 'GET',
14
- route: `${this.apiBasePath}/list`,
15
- });
16
- }
17
-
18
- /**
19
- * Create or update custom skus
20
- * @param data skus data
21
- */
22
- async updateCustomSkus(data: UpdateCustomSkusDto): Promise<CustomSku[]> {
23
- return await this.apiCall({
24
- method: 'POST',
25
- route: `${this.apiBasePath}`,
26
- data,
27
- });
28
- }
29
- }
@@ -1,15 +0,0 @@
1
- export type CustomSku = {
2
- category: string;
3
- contractId: string;
4
- startDate: Date;
5
- endDate: Date;
6
- price: number;
7
- sku: string;
8
- customerId: string;
9
- };
10
-
11
-
12
- export type UpdateCustomSkusDto = {
13
- contractId: string;
14
- skus: CustomSku[];
15
- };
@@ -1,4 +0,0 @@
1
- export enum PatternStatuses {
2
- active = 'ACTIVE',
3
- deleted = 'DELETED',
4
- }
@@ -1,44 +0,0 @@
1
- import { BaseApi } from '../baseApi';
2
-
3
- import { CreatePatternDto, Pattern, UpdatePatternDto } from './types';
4
-
5
-
6
- export default class PatternsApi extends BaseApi {
7
- private readonly apiBasePath = 'api/v1/patterns';
8
-
9
- /**
10
- * @description get billing patterns
11
- */
12
- public async getAllPatterns(): Promise<Pattern[]> {
13
- return await this.apiCall({
14
- method: 'GET',
15
- route: `${this.apiBasePath}`,
16
- });
17
- }
18
-
19
- /**
20
- * Update pattern
21
- * @param contractId contract ID
22
- * @param data Updated pattern data
23
- */
24
- async updatePattern(contractId: string, data: UpdatePatternDto): Promise<Pattern> {
25
- return await this.apiCall({
26
- method: 'PUT',
27
- route: `${this.apiBasePath}`,
28
- params: { contractId },
29
- data,
30
- });
31
- }
32
-
33
- /**
34
- * Create pattern
35
- * @param data pattern data
36
- */
37
- async createPattern(data: CreatePatternDto): Promise<Pattern> {
38
- return await this.apiCall({
39
- method: 'POST',
40
- route: `${this.apiBasePath}`,
41
- data,
42
- });
43
- }
44
- }
@@ -1,30 +0,0 @@
1
- import { PatternStatuses } from './constants';
2
-
3
- export type PatternCategory = {
4
- id: string;
5
- skus: string[];
6
- exclude: boolean;
7
- category: string;
8
- };
9
-
10
- export type PatternCategoriesConfigurationInterface = {
11
- usageCategories?: PatternCategory[];
12
- pdePrepaymentCategories?: PatternCategory[];
13
- platformSupportCategories?: PatternCategory[];
14
- usagePrepaymentCategories?: PatternCategory[];
15
- };
16
-
17
- export type Pattern = {
18
- id: string;
19
- contractId: string;
20
- customerId?: string;
21
- status: PatternStatuses;
22
- pattern: PatternCategoriesConfigurationInterface;
23
- };
24
-
25
- export type CreatePatternDto = Omit<Pattern, 'id'>;
26
-
27
- export type UpdatePatternDto = {
28
- status?: PatternStatuses;
29
- pattern?: PatternCategoriesConfigurationInterface;
30
- };
@@ -1,27 +0,0 @@
1
- import { UsageRequestParams, Usage, OptionalParams } from '../types';
2
- import { adaptParams } from '../utils';
3
-
4
- import { BaseApi } from './baseApi';
5
-
6
- export default class ReportingApi extends BaseApi {
7
- private readonly apiBasePath = 'api/v1';
8
-
9
- /**
10
- * @description get usage traffic
11
- * @param clientId string
12
- * @param dateFrom Date
13
- * @param dateTo Date
14
- * @param tiers boolean
15
- * @param environments string[]
16
- * @param accounts string[]
17
- * @param categories string[]
18
- */
19
- public async getUsage(params: UsageRequestParams, { signal }: OptionalParams = {}): Promise<Usage[]> {
20
- return await this.apiCall({
21
- method: 'GET',
22
- route: `${this.apiBasePath}/usage`,
23
- params: adaptParams<UsageRequestParams>(params),
24
- signal,
25
- });
26
- }
27
- }
@@ -1,17 +0,0 @@
1
- import { BaseApi } from '../baseApi';
2
-
3
- import { Tier } from './types';
4
-
5
- export default class TiersApi extends BaseApi {
6
- private readonly apiBasePath = 'api/v1/tiers';
7
-
8
- /**
9
- * @description get all tiers
10
- */
11
- public async listOfTiers(): Promise<Tier[]> {
12
- return await this.apiCall({
13
- method: 'GET',
14
- route: `${this.apiBasePath}/list`,
15
- });
16
- }
17
- }
@@ -1,12 +0,0 @@
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
- }