@or-sdk/ccp 1.4.1-beta.3240.0 → 1.4.1-beta.3244.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 (18) hide show
  1. package/dist/cjs/api/environmentsApi.js.map +1 -1
  2. package/dist/cjs/constants.js +6 -6
  3. package/dist/cjs/constants.js.map +1 -1
  4. package/dist/cjs/types.js.map +1 -1
  5. package/dist/esm/api/environmentsApi.js.map +1 -1
  6. package/dist/esm/constants.js +5 -5
  7. package/dist/esm/constants.js.map +1 -1
  8. package/dist/esm/types.js.map +1 -1
  9. package/dist/types/api/environmentsApi.d.ts +2 -2
  10. package/dist/types/api/environmentsApi.d.ts.map +1 -1
  11. package/dist/types/constants.d.ts +1 -1
  12. package/dist/types/constants.d.ts.map +1 -1
  13. package/dist/types/types.d.ts +17 -10
  14. package/dist/types/types.d.ts.map +1 -1
  15. package/package.json +1 -1
  16. package/src/api/environmentsApi.ts +20 -8
  17. package/src/constants.ts +1 -1
  18. package/src/types.ts +27 -11
package/dist/cjs/api/environmentsApi.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"environmentsApi.js","sourceRoot":"","sources":["../../../src/api/environmentsApi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,qCAAoC;AAEpC;IAA6C,mCAAO;IAApD;;QACmB,iBAAW,GAAG,qBAAqB,CAAC;;IAoBvD,CAAC;IAXc,yCAAe,GAA5B;4DACE,MAAgC,EAChC,EAA+B;gBAA/B,qBAA6B,EAAE,KAAA,EAA7B,MAAM,YAAA;;;4BAED,WAAM,IAAI,CAAC,OAAO,CAAC;4BACxB,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,UAAG,IAAI,CAAC,WAAW,CAAE;4BAC5B,MAAM,QAAA;4BACN,MAAM,QAAA;yBACP,CAAC,EAAA;4BALF,WAAO,SAKL,EAAC;;;;KACJ;IACH,sBAAC;AAAD,CAAC,AArBD,CAA6C,iBAAO,GAqBnD"}
1
+ {"version":3,"file":"environmentsApi.js","sourceRoot":"","sources":["../../../src/api/environmentsApi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,qCAAoC;AAEpC;IAA6C,mCAAO;IAApD;;QACmB,iBAAW,GAAG,qBAAqB,CAAC;;IA2BvD,CAAC;IAXc,yCAAe,GAA5B;4DACE,MAAgC,EAChC,EAA+B;gBAA/B,qBAA6B,EAAE,KAAA,EAA7B,MAAM,YAAA;;;4BAED,WAAM,IAAI,CAAC,OAAO,CAAC;4BACxB,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,UAAG,IAAI,CAAC,WAAW,CAAE;4BAC5B,MAAM,QAAA;4BACN,MAAM,QAAA;yBACP,CAAC,EAAA;4BALF,WAAO,SAKL,EAAC;;;;KACJ;IACH,sBAAC;AAAD,CAAC,AA5BD,CAA6C,iBAAO,GA4BnD"}
package/dist/cjs/constants.js CHANGED
@@ -1,10 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OrderDirection = exports.SERVICE_KEY = void 0;
3
+ exports.SortOrder = exports.SERVICE_KEY = void 0;
4
4
  exports.SERVICE_KEY = 'customer-portal-api';
5
- var OrderDirection;
6
- (function (OrderDirection) {
7
- OrderDirection["ASC"] = "ASC";
8
- OrderDirection["DESC"] = "DESC";
9
- })(OrderDirection || (exports.OrderDirection = OrderDirection = {}));
5
+ var SortOrder;
6
+ (function (SortOrder) {
7
+ SortOrder["ASC"] = "ASC";
8
+ SortOrder["DESC"] = "DESC";
9
+ })(SortOrder || (exports.SortOrder = SortOrder = {}));
10
10
  //# sourceMappingURL=constants.js.map
package/dist/cjs/constants.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,qBAAqB,CAAC;AAEjD,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,+BAAa,CAAA;AACf,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,qBAAqB,CAAC;AAEjD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}
package/dist/cjs/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,4DAA0C"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAIA,4DAA0C"}
package/dist/esm/api/environmentsApi.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"environmentsApi.js","sourceRoot":"","sources":["../../../src/api/environmentsApi.ts"],"names":[],"mappings":";;;;;;;;;AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IAApD;;QACmB,gBAAW,GAAG,qBAAqB,CAAC;IAoBvD,CAAC;IAXc,eAAe;6DAC1B,MAAgC,EAChC,EAAE,MAAM,KAAqB,EAAE;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE;gBAC5B,MAAM;gBACN,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;CACF"}
1
+ {"version":3,"file":"environmentsApi.js","sourceRoot":"","sources":["../../../src/api/environmentsApi.ts"],"names":[],"mappings":";;;;;;;;;AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IAApD;;QACmB,gBAAW,GAAG,qBAAqB,CAAC;IA2BvD,CAAC;IAXc,eAAe;6DAC1B,MAAgC,EAChC,EAAE,MAAM,KAAqB,EAAE;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE;gBAC5B,MAAM;gBACN,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;CACF"}
package/dist/esm/constants.js CHANGED
@@ -1,7 +1,7 @@
1
1
  export const SERVICE_KEY = 'customer-portal-api';
2
- export var OrderDirection;
3
- (function (OrderDirection) {
4
- OrderDirection["ASC"] = "ASC";
5
- OrderDirection["DESC"] = "DESC";
6
- })(OrderDirection || (OrderDirection = {}));
2
+ export var SortOrder;
3
+ (function (SortOrder) {
4
+ SortOrder["ASC"] = "ASC";
5
+ SortOrder["DESC"] = "DESC";
6
+ })(SortOrder || (SortOrder = {}));
7
7
  //# sourceMappingURL=constants.js.map
package/dist/esm/constants.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAEjD,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,+BAAa,CAAA;AACf,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAEjD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}
package/dist/esm/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAEA,cAAc,2BAA2B,CAAC"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAIA,cAAc,2BAA2B,CAAC"}
package/dist/types/api/environmentsApi.d.ts CHANGED
@@ -1,7 +1,7 @@
1
- import { Environment, EnvironmentRequestParams, OptionalParams } from '../types';
1
+ import { Environment, EnvironmentRequestParams, OptionalParams, PaginatedResponse } from '../types';
2
2
  import { BaseApi } from './baseApi';
3
3
  export default class EnvironmentsApi extends BaseApi {
4
4
  private readonly apiBasePath;
5
- getEnvironments(params: EnvironmentRequestParams, { signal }?: OptionalParams): Promise<Environment[]>;
5
+ getEnvironments(params: EnvironmentRequestParams, { signal }?: OptionalParams): Promise<PaginatedResponse<Environment>>;
6
6
  }
7
7
  //# sourceMappingURL=environmentsApi.d.ts.map
package/dist/types/api/environmentsApi.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"environmentsApi.d.ts","sourceRoot":"","sources":["../../../src/api/environmentsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAEjF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IAClD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyB;IASxC,eAAe,CAC1B,MAAM,EAAE,wBAAwB,EAChC,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC,WAAW,EAAE,CAAC;CAQ1B"}
1
+ {"version":3,"file":"environmentsApi.d.ts","sourceRoot":"","sources":["../../../src/api/environmentsApi.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,wBAAwB,EACxB,cAAc,EACd,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IAClD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyB;IAgBxC,eAAe,CAC1B,MAAM,EAAE,wBAAwB,EAChC,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;CAQ3C"}
package/dist/types/constants.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export declare const SERVICE_KEY = "customer-portal-api";
2
- export declare enum OrderDirection {
2
+ export declare enum SortOrder {
3
3
  ASC = "ASC",
4
4
  DESC = "DESC"
5
5
  }
package/dist/types/constants.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,wBAAwB,CAAC;AAEjD,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,wBAAwB,CAAC;AAEjD,oBAAY,SAAS;IACnB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd"}
package/dist/types/types.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { OrderDirection, Token } from '@or-sdk/base';
2
+ import { SortOrder } from './constants';
2
3
  export * from './api/customers-api/types';
3
4
  export type CcpConfig = {
4
5
  token: Token;
@@ -10,11 +11,23 @@ export type CcpConfig = {
10
11
  export type OptionalParams = {
11
12
  signal?: AbortSignal;
12
13
  };
13
- export type ApiRequestParams = {
14
+ export type ApiParamsRequestDto = {
15
+ page?: number;
16
+ limit?: number;
17
+ sortBy?: string;
18
+ sortOrder?: SortOrder;
19
+ };
20
+ export type PaginatedResponse<T> = {
21
+ total: number;
22
+ page: number;
23
+ limit: number;
24
+ data: T[];
25
+ };
26
+ export type ApiRequestClientId = {
14
27
  clientId: string;
15
28
  };
16
29
  export type EnvironmentStatus = 'ACTIVE' | 'NOT ACTIVE';
17
- export type EnvironmentRequestParams = ApiRequestParams & {
30
+ export type EnvironmentRequestParams = ApiRequestClientId & ApiParamsRequestDto & {
18
31
  id?: string;
19
32
  friendlyName?: string;
20
33
  status?: EnvironmentStatus;
@@ -31,7 +44,7 @@ export type Environment = {
31
44
  authUrl?: string;
32
45
  };
33
46
  export type AccountStatus = 'ACTIVE' | 'INACTIVE';
34
- export type AccountRequestParams = ApiRequestParams & {
47
+ export type AccountRequestParams = ApiRequestClientId & {
35
48
  id?: string;
36
49
  accountName?: string;
37
50
  environmentId?: string;
@@ -68,7 +81,7 @@ export interface Flow {
68
81
  isDeleted?: boolean;
69
82
  url?: string;
70
83
  }
71
- export type UsageRequestParams = ApiRequestParams & {
84
+ export type UsageRequestParams = ApiRequestClientId & {
72
85
  dateFrom: Date;
73
86
  dateTo: Date;
74
87
  tiers?: boolean;
@@ -104,12 +117,6 @@ export type UpdatePaymentProvider = {
104
117
  export type UpdateProvider = {
105
118
  name: string;
106
119
  };
107
- export type PaginatedResponse<T> = {
108
- data: T[];
109
- total: number;
110
- limit: number;
111
- page: number;
112
- };
113
120
  export type Pagination = {
114
121
  page?: number;
115
122
  pageSize?: number;
package/dist/types/types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErD,cAAc,2BAA2B,CAAC;AAC1C,MAAM,MAAM,SAAS,GAAG;IAItB,KAAK,EAAE,KAAK,CAAC;IAIb,YAAY,CAAC,EAAE,MAAM,CAAC;IAItB,SAAS,CAAC,EAAE,MAAM,CAAC;IAInB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,YAAY,CAAC;AAExD,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,CAAC;AAElD,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;CAC3C;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG;IAClD,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,WAAW,KAAK;IACpB,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;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,cAAc,2BAA2B,CAAC;AAC1C,MAAM,MAAM,SAAS,GAAG;IAItB,KAAK,EAAE,KAAK,CAAC;IAIb,YAAY,CAAC,EAAE,MAAM,CAAC;IAItB,SAAS,CAAC,EAAE,MAAM,CAAC;IAInB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAGF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,EAAE,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAGF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,YAAY,CAAC;AAExD,MAAM,MAAM,wBAAwB,GAAG,kBAAkB,GAAG,mBAAmB,GAAG;IAChF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAGF,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,CAAC;AAElD,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,GAAG;IACtD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;CAC3C;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,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,WAAW,KAAK;IACpB,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;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAOF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/ccp",
3
- "version": "1.4.1-beta.3240.0",
3
+ "version": "1.4.1-beta.3244.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
package/src/api/environmentsApi.ts CHANGED
@@ -1,4 +1,9 @@
1
- import { Environment, EnvironmentRequestParams, OptionalParams } from '../types';
1
+ import {
2
+ Environment,
3
+ EnvironmentRequestParams,
4
+ OptionalParams,
5
+ PaginatedResponse,
6
+ } from '../types';
2
7
 
3
8
  import { BaseApi } from './baseApi';
4
9
 
@@ -6,16 +11,23 @@ export default class EnvironmentsApi extends BaseApi {
6
11
  private readonly apiBasePath = 'api/v1/environments';
7
12
 
8
13
  /**
9
- * @description get client's environments
10
- * @param clientId
11
- * @param id
12
- * @param friendlyName
13
- * @param status
14
- */
14
+ * @description get clients' environments
15
+ * @param[0] {EnvironmentRequestParams} params - query parameters
16
+ * @param {string} params.clientId - customer id
17
+ * @param {string} [params.id] - environment id
18
+ * @param {string} [params.friendlyName] - name of the environment
19
+ * @param {string} [params.status] - ACTIVE | NOT ACTIVE
20
+ * @param {boolean} [params.billable] - true | false
21
+ * @param {number} [params.page] - page number, default 1
22
+ * @param {number} [params.limit] - number of items per page, default 50
23
+ * @param {string} [params.sortBy] - sort by field, default createdAt
24
+ * @param {string} [params.sortOrder] - sort order, default ASC
25
+ * @returns {Promise<PaginatedResponse<Environment>>} - list of environments
26
+ */
15
27
  public async getEnvironments(
16
28
  params: EnvironmentRequestParams,
17
29
  { signal }: OptionalParams = {}
18
- ): Promise<Environment[]> {
30
+ ): Promise<PaginatedResponse<Environment>> {
19
31
  return await this.apiCall({
20
32
  method: 'GET',
21
33
  route: `${this.apiBasePath}`,
package/src/constants.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export const SERVICE_KEY = 'customer-portal-api';
2
2
 
3
- export enum OrderDirection {
3
+ export enum SortOrder {
4
4
  ASC = 'ASC',
5
5
  DESC = 'DESC',
6
6
  }
package/src/types.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  import { OrderDirection, Token } from '@or-sdk/base';
2
2
 
3
+ import { SortOrder } from './constants';
4
+
3
5
  export * from './api/customers-api/types';
4
6
  export type CcpConfig = {
5
7
  /**
@@ -25,18 +27,33 @@ export type CcpConfig = {
25
27
  withApiErrorLog?: boolean;
26
28
  };
27
29
 
30
+ // shared types
28
31
  export type OptionalParams = {
29
32
  signal?: AbortSignal;
30
33
  };
31
34
 
35
+ export type ApiParamsRequestDto = {
36
+ page?: number;
37
+ limit?: number;
38
+ sortBy?: string;
39
+ sortOrder?: SortOrder;
40
+ };
32
41
 
33
- export type ApiRequestParams = {
42
+ export type PaginatedResponse<T> = {
43
+ total: number;
44
+ page: number;
45
+ limit: number;
46
+ data: T[];
47
+ };
48
+
49
+ export type ApiRequestClientId = {
34
50
  clientId: string;
35
51
  };
36
52
 
53
+ // Environment types
37
54
  export type EnvironmentStatus = 'ACTIVE' | 'NOT ACTIVE';
38
55
 
39
- export type EnvironmentRequestParams = ApiRequestParams & {
56
+ export type EnvironmentRequestParams = ApiRequestClientId & ApiParamsRequestDto & {
40
57
  id?: string;
41
58
  friendlyName?: string;
42
59
  status?: EnvironmentStatus;
@@ -54,9 +71,10 @@ export type Environment = {
54
71
  authUrl?: string;
55
72
  };
56
73
 
74
+ // Account types
57
75
  export type AccountStatus = 'ACTIVE' | 'INACTIVE';
58
76
 
59
- export type AccountRequestParams = ApiRequestParams & {
77
+ export type AccountRequestParams = ApiRequestClientId & {
60
78
  id?: string;
61
79
  accountName?: string;
62
80
  environmentId?: string;
@@ -97,7 +115,7 @@ export interface Flow {
97
115
  url?: string;
98
116
  }
99
117
 
100
- export type UsageRequestParams = ApiRequestParams & {
118
+ export type UsageRequestParams = ApiRequestClientId & {
101
119
  dateFrom: Date;
102
120
  dateTo: Date;
103
121
  tiers?: boolean;
@@ -140,13 +158,11 @@ export type UpdateProvider = {
140
158
  name: string;
141
159
  };
142
160
 
143
- export type PaginatedResponse<T> = {
144
- data: T[];
145
- total: number;
146
- limit: number;
147
- page: number;
148
- };
149
-
161
+ /**
162
+ * TODO:
163
+ * - use ApiParamsRequestDto for sdk consistency
164
+ * - update all sdk methods to use ApiParamsRequestDto
165
+ * */
150
166
  export type Pagination = {
151
167
  page?: number;
152
168
  pageSize?: number;