@or-sdk/ccp 10.14.2-beta.921.0 → 10.14.2
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/AGENTS.md +47 -0
- package/dist/cjs/api/usersApi/index.js +0 -17
- package/dist/cjs/api/usersApi/index.js.map +1 -1
- package/dist/esm/api/usersApi/index.js +0 -9
- package/dist/esm/api/usersApi/index.js.map +1 -1
- package/dist/types/api/usersApi/index.d.ts +0 -1
- package/dist/types/api/usersApi/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/api/usersApi/index.ts +0 -13
package/AGENTS.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# SDK Package Guide
|
|
2
|
+
|
|
3
|
+
## Responsibility
|
|
4
|
+
|
|
5
|
+
`@or-sdk/ccp`: TypeScript SDK for Customer Care Portal API contracts. It is a
|
|
6
|
+
published package consumed by the Customer Care Portal UI and downstream
|
|
7
|
+
clients.
|
|
8
|
+
|
|
9
|
+
## Local Rules
|
|
10
|
+
|
|
11
|
+
- Keep SDK APIs aligned with current backend contracts.
|
|
12
|
+
- Public API is exported from `src/index.ts`; additions or signature changes are
|
|
13
|
+
downstream-visible.
|
|
14
|
+
- Preserve strong typing; avoid `any`.
|
|
15
|
+
- Keep public SDK surface backward-compatible unless the task explicitly defines
|
|
16
|
+
a breaking change.
|
|
17
|
+
- Keep request parameter names, response shapes, pagination, sorting, and error
|
|
18
|
+
behavior consistent with the API.
|
|
19
|
+
- Do not manually edit generated `dist/` output; rebuild it with package
|
|
20
|
+
scripts when needed.
|
|
21
|
+
|
|
22
|
+
## Local Run and Validation
|
|
23
|
+
|
|
24
|
+
- Build the SDK with:
|
|
25
|
+
```bash
|
|
26
|
+
pnpm sdk build
|
|
27
|
+
```
|
|
28
|
+
- Watch ESM output during local development with:
|
|
29
|
+
```bash
|
|
30
|
+
pnpm sdk dev
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Release Notes
|
|
34
|
+
|
|
35
|
+
- Do not manually bump package or Lerna versions unless the release task
|
|
36
|
+
explicitly requires it.
|
|
37
|
+
- CI publishes prerelease SDK builds on merge requests and release builds from
|
|
38
|
+
the default branch.
|
|
39
|
+
- Call out SDK contract changes in the MR description under the `CCP SDK`
|
|
40
|
+
section.
|
|
41
|
+
|
|
42
|
+
## Local Documentation
|
|
43
|
+
|
|
44
|
+
- Document SDK contract or behavior changes in a focused feature doc under
|
|
45
|
+
`AGENTS/features/` when relevant.
|
|
46
|
+
- If contract strategy or cross-package architecture changes, add an ADR file.
|
|
47
|
+
- Avoid adding implementation notes to shared index README files.
|
|
@@ -91,23 +91,6 @@ var UsersApi = (function (_super) {
|
|
|
91
91
|
});
|
|
92
92
|
});
|
|
93
93
|
};
|
|
94
|
-
UsersApi.prototype.resendInvite = function (environmentId_1, accountId_1, userId_1) {
|
|
95
|
-
return __awaiter(this, arguments, void 0, function (environmentId, accountId, userId, _a) {
|
|
96
|
-
var _b = _a === void 0 ? {} : _a, signal = _b.signal;
|
|
97
|
-
return __generator(this, function (_c) {
|
|
98
|
-
switch (_c.label) {
|
|
99
|
-
case 0: return [4, this.apiCall({
|
|
100
|
-
method: 'POST',
|
|
101
|
-
route: "".concat(this.apiBasePath, "/").concat(environmentId, "/").concat(accountId, "/").concat(userId, "/resend-invite"),
|
|
102
|
-
signal: signal,
|
|
103
|
-
})];
|
|
104
|
-
case 1:
|
|
105
|
-
_c.sent();
|
|
106
|
-
return [2];
|
|
107
|
-
}
|
|
108
|
-
});
|
|
109
|
-
});
|
|
110
|
-
};
|
|
111
94
|
UsersApi.prototype.updateUser = function (environmentId_1, accountId_1, userId_1, data_1) {
|
|
112
95
|
return __awaiter(this, arguments, void 0, function (environmentId, accountId, userId, data, _a) {
|
|
113
96
|
var _b = _a === void 0 ? {} : _a, signal = _b.signal;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/usersApi/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,sCAAqC;AAErC;IAAsC,4BAAO;IAA7C;;QACmB,iBAAW,GAAG,cAAc,CAAC;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/usersApi/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,sCAAqC;AAErC;IAAsC,4BAAO;IAA7C;;QACmB,iBAAW,GAAG,cAAc,CAAC;;IAsEhD,CAAC;IApEO,8BAAW,GAAjB;4DACE,aAAqB,EACrB,SAAiB,EACjB,OAAwB,EACxB,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,cAAI,aAAa,cAAI,SAAS,CAAE;4BAC1D,MAAM,EAAE,OAAO;4BACf,MAAM,QAAA;yBACP,CAAC,EAAA;4BALF,WAAO,SAKL,EAAC;;;;KACJ;IAEK,6BAAU,GAAhB;4DACE,aAAqB,EACrB,SAAiB,EACjB,IAAmB,EACnB,EAA+B;gBAA/B,qBAA6B,EAAE,KAAA,EAA7B,MAAM,YAAA;;;4BAED,WAAM,IAAI,CAAC,OAAO,CAAC;4BACxB,MAAM,EAAE,MAAM;4BACd,KAAK,EAAE,UAAG,IAAI,CAAC,WAAW,cAAI,aAAa,cAAI,SAAS,CAAE;4BAC1D,IAAI,MAAA;4BACJ,MAAM,QAAA;yBACP,CAAC,EAAA;4BALF,WAAO,SAKL,EAAC;;;;KACJ;IAEK,6BAAU,GAAhB;4DACE,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,IAAmB,EACnB,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,cAAI,aAAa,cAAI,SAAS,cAAI,MAAM,CAAE;4BACpE,IAAI,MAAA;4BACJ,MAAM,QAAA;yBACP,CAAC,EAAA;4BALF,WAAO,SAKL,EAAC;;;;KACJ;IAEK,6BAAU,GAAhB;4DACE,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,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,cAAI,aAAa,cAAI,SAAS,cAAI,MAAM,YAAS;4BAC3E,MAAM,QAAA;yBACP,CAAC,EAAA;4BAJF,WAAO,SAIL,EAAC;;;;KACJ;IAEK,8BAAW,GAAjB;4DACE,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,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,cAAI,aAAa,cAAI,SAAS,cAAI,MAAM,aAAU;4BAC5E,MAAM,QAAA;yBACP,CAAC,EAAA;4BAJF,WAAO,SAIL,EAAC;;;;KACJ;IACH,eAAC;AAAD,CAAC,AAvED,CAAsC,iBAAO,GAuE5C"}
|
|
@@ -33,15 +33,6 @@ export default class UsersApi extends BaseApi {
|
|
|
33
33
|
});
|
|
34
34
|
});
|
|
35
35
|
}
|
|
36
|
-
resendInvite(environmentId_1, accountId_1, userId_1) {
|
|
37
|
-
return __awaiter(this, arguments, void 0, function* (environmentId, accountId, userId, { signal } = {}) {
|
|
38
|
-
yield this.apiCall({
|
|
39
|
-
method: 'POST',
|
|
40
|
-
route: `${this.apiBasePath}/${environmentId}/${accountId}/${userId}/resend-invite`,
|
|
41
|
-
signal,
|
|
42
|
-
});
|
|
43
|
-
});
|
|
44
|
-
}
|
|
45
36
|
updateUser(environmentId_1, accountId_1, userId_1, data_1) {
|
|
46
37
|
return __awaiter(this, arguments, void 0, function* (environmentId, accountId, userId, data, { signal } = {}) {
|
|
47
38
|
return yield this.apiCall({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/usersApi/index.ts"],"names":[],"mappings":";;;;;;;;;AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,OAAO;IAA7C;;QACmB,gBAAW,GAAG,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/usersApi/index.ts"],"names":[],"mappings":";;;;;;;;;AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,OAAO;IAA7C;;QACmB,gBAAW,GAAG,cAAc,CAAC;IAsEhD,CAAC;IApEO,WAAW;6DACf,aAAqB,EACrB,SAAiB,EACjB,OAAwB,EACxB,EAAE,MAAM,KAAqB,EAAE;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,IAAI,aAAa,IAAI,SAAS,EAAE;gBAC1D,MAAM,EAAE,OAAO;gBACf,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,UAAU;6DACd,aAAqB,EACrB,SAAiB,EACjB,IAAmB,EACnB,EAAE,MAAM,KAAqB,EAAE;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,IAAI,aAAa,IAAI,SAAS,EAAE;gBAC1D,IAAI;gBACJ,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,UAAU;6DACd,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,IAAmB,EACnB,EAAE,MAAM,KAAqB,EAAE;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,IAAI,aAAa,IAAI,SAAS,IAAI,MAAM,EAAE;gBACpE,IAAI;gBACJ,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,UAAU;6DACd,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,EAAE,MAAM,KAAqB,EAAE;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,IAAI,aAAa,IAAI,SAAS,IAAI,MAAM,SAAS;gBAC3E,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,WAAW;6DACf,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,EAAE,MAAM,KAAqB,EAAE;YAE/B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,IAAI,aAAa,IAAI,SAAS,IAAI,MAAM,UAAU;gBAC5E,MAAM;aACP,CAAC,CAAC;QACL,CAAC;KAAA;CACF"}
|
|
@@ -5,7 +5,6 @@ export default class UsersApi extends BaseApi {
|
|
|
5
5
|
private readonly apiBasePath;
|
|
6
6
|
getAllUsers(environmentId: string, accountId: string, filters?: FilterUsersDto, { signal }?: OptionalParams): Promise<PaginatedResponse<UserDto>>;
|
|
7
7
|
createUser(environmentId: string, accountId: string, data: CreateUserDto, { signal }?: OptionalParams): Promise<UserDto>;
|
|
8
|
-
resendInvite(environmentId: string, accountId: string, userId: string, { signal }?: OptionalParams): Promise<void>;
|
|
9
8
|
updateUser(environmentId: string, accountId: string, userId: string, data: UpdateUserDto, { signal }?: OptionalParams): Promise<UserDto>;
|
|
10
9
|
enableUser(environmentId: string, accountId: string, userId: string, { signal }?: OptionalParams): Promise<{
|
|
11
10
|
message: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/usersApi/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEnG,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,OAAO;IAC3C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAkB;IAExC,WAAW,CACf,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,EACxB,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAShC,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,aAAa,EACnB,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC,OAAO,CAAC;IASb,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/usersApi/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEnG,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,OAAO;IAC3C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAkB;IAExC,WAAW,CACf,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,cAAc,EACxB,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAShC,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,aAAa,EACnB,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC,OAAO,CAAC;IASb,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,aAAa,EACnB,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC,OAAO,CAAC;IASb,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAQzB,WAAW,CACf,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,EAAE,MAAM,EAAE,GAAE,cAAmB,GAC9B,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAOhC"}
|
package/package.json
CHANGED
|
@@ -34,19 +34,6 @@ export default class UsersApi extends BaseApi {
|
|
|
34
34
|
});
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
-
async resendInvite(
|
|
38
|
-
environmentId: string,
|
|
39
|
-
accountId: string,
|
|
40
|
-
userId: string,
|
|
41
|
-
{ signal }: OptionalParams = {},
|
|
42
|
-
): Promise<void> {
|
|
43
|
-
await this.apiCall({
|
|
44
|
-
method: 'POST',
|
|
45
|
-
route: `${this.apiBasePath}/${environmentId}/${accountId}/${userId}/resend-invite`,
|
|
46
|
-
signal,
|
|
47
|
-
});
|
|
48
|
-
}
|
|
49
|
-
|
|
50
37
|
async updateUser(
|
|
51
38
|
environmentId: string,
|
|
52
39
|
accountId: string,
|