@or-sdk/bots 1.6.1-beta.4013.0 → 1.6.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.
- package/CHANGELOG.md +8 -0
- package/dist/types/Bots.d.ts +56 -0
- package/dist/types/Bots.d.ts.map +1 -1
- package/dist/types/types.d.ts +24 -0
- package/dist/types/types.d.ts.map +1 -1
- package/package.json +6 -5
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.6.1](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/bots@1.6.0...@or-sdk/bots@1.6.1) (2026-02-25)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @or-sdk/bots
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
## [1.6.0](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/bots@1.5.1...@or-sdk/bots@1.6.0) (2026-02-24)
|
|
7
15
|
|
|
8
16
|
|
package/dist/types/Bots.d.ts
CHANGED
|
@@ -6,15 +6,71 @@ export declare class Bots implements Taggable<Bot> {
|
|
|
6
6
|
private readonly dataHubSvc;
|
|
7
7
|
private readonly tags;
|
|
8
8
|
constructor(params: BotsConfig);
|
|
9
|
+
/**
|
|
10
|
+
* List bots
|
|
11
|
+
* ```typescript
|
|
12
|
+
* const botList = await bots.listBots();
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
9
15
|
listBots(params?: ListBotsParams, paginationOptions?: PaginationOptions): Promise<List<Bot>>;
|
|
16
|
+
/**
|
|
17
|
+
* Get bot
|
|
18
|
+
* ```typescript
|
|
19
|
+
* const bot = await bots.getBot('bot-id');
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
10
22
|
getBot(id: string, params?: GetBotsParams): Promise<Bot>;
|
|
23
|
+
/**
|
|
24
|
+
* Save bot
|
|
25
|
+
*
|
|
26
|
+
* If source contains existing id - existing bot will be updated
|
|
27
|
+
* ```typescript
|
|
28
|
+
* const savedBot = await bots.saveBot(botSource);
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
11
31
|
saveBot(source: Bot): Promise<Bot>;
|
|
32
|
+
/**
|
|
33
|
+
* Delete bot
|
|
34
|
+
* ```typescript
|
|
35
|
+
* await bots.deleteBot('bot-id');
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
12
38
|
deleteBot(botId: string, temporarily?: boolean, context?: CheckProgressContext): Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* Recover bot
|
|
41
|
+
* ```typescript
|
|
42
|
+
* await bots.recoverBot('bot-id');
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
13
45
|
recoverBot(botId: string): Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
* Download bot template to account
|
|
48
|
+
* ```typescript
|
|
49
|
+
* const result = await bots.downloadTemplate('bot-template-id');
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
14
52
|
downloadTemplate(botTemplateId: string): Promise<DownloadTemplateResult>;
|
|
53
|
+
/**
|
|
54
|
+
* Add tags
|
|
55
|
+
* ```typescript
|
|
56
|
+
* const bot = await bots.addTags(botSource, tagIdsArr);
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
15
59
|
addTags(source: Bot, tagNames: string[]): Promise<Bot>;
|
|
60
|
+
/**
|
|
61
|
+
* Remove tags
|
|
62
|
+
* ```typescript
|
|
63
|
+
* const bot = await bots.removeTags(botSource, tagIdsArr);
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
16
66
|
removeTags(source: Bot, tagNames: string[]): Promise<Bot>;
|
|
17
67
|
uploaderBotImage({ path, fileModel, cacheControl }: BotUploadIcon): Promise<string>;
|
|
68
|
+
/**
|
|
69
|
+
* List bot categories
|
|
70
|
+
* ```typescript
|
|
71
|
+
* const categories = await bots.listBotCategories();
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
18
74
|
listBotCategories(): Promise<BotCategoriesResponse>;
|
|
19
75
|
}
|
|
20
76
|
//# sourceMappingURL=Bots.d.ts.map
|
package/dist/types/Bots.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Bots.d.ts","sourceRoot":"","sources":["../../src/Bots.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAuB,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAQ,QAAQ,EAA0C,MAAM,cAAc,CAAC;AAItF,OAAO,EACL,UAAU,EACV,GAAG,EACH,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,aAAa,EACb,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB,qBAAa,IAAK,YAAW,QAAQ,CAAC,GAAG,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;gBAEhB,MAAM,EAAE,UAAU;
|
|
1
|
+
{"version":3,"file":"Bots.d.ts","sourceRoot":"","sources":["../../src/Bots.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAuB,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAQ,QAAQ,EAA0C,MAAM,cAAc,CAAC;AAItF,OAAO,EACL,UAAU,EACV,GAAG,EACH,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,aAAa,EACb,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB,qBAAa,IAAK,YAAW,QAAQ,CAAC,GAAG,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;gBAEhB,MAAM,EAAE,UAAU;IAmB9B;;;;;OAKG;IACU,QAAQ,CAAC,MAAM,GAAE,cAAmB,EAAE,iBAAiB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAgCjH;;;;;OAKG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,aAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAWzE;;;;;;;OAOG;IACU,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAkB/C;;;;;OAKG;IACU,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,UAAO,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcxG;;;;;OAKG;IACU,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrD;;;;;OAKG;IACU,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAarF;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAgBnE;;;;;OAKG;IACU,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAgBzD,gBAAgB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,YAA8B,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAoClH;;;;;OAKG;IACU,iBAAiB,IAAI,OAAO,CAAC,qBAAqB,CAAC;CAQjE"}
|
package/dist/types/types.d.ts
CHANGED
|
@@ -1,9 +1,24 @@
|
|
|
1
1
|
import { Token } from '@or-sdk/base';
|
|
2
2
|
export type BotsConfig = {
|
|
3
|
+
/**
|
|
4
|
+
* token
|
|
5
|
+
*/
|
|
3
6
|
token: Token;
|
|
7
|
+
/**
|
|
8
|
+
* Url of OneReach service discovery api
|
|
9
|
+
*/
|
|
4
10
|
discoveryUrl?: string;
|
|
11
|
+
/**
|
|
12
|
+
* Account ID for cross-account requests (super admin only)
|
|
13
|
+
*/
|
|
5
14
|
accountId?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Url of OneReach DataHubSvc api
|
|
17
|
+
*/
|
|
6
18
|
dataHubSvcUrl?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Api feature
|
|
21
|
+
*/
|
|
7
22
|
feature?: string;
|
|
8
23
|
};
|
|
9
24
|
export type Bot = {
|
|
@@ -73,10 +88,19 @@ export type BotUploadIcon = {
|
|
|
73
88
|
cacheControl: string;
|
|
74
89
|
fileModel: File;
|
|
75
90
|
};
|
|
91
|
+
/**
|
|
92
|
+
* Single parameter for the Bot Configuration settings.
|
|
93
|
+
*/
|
|
76
94
|
export type BotConfigParam = {
|
|
95
|
+
/**
|
|
96
|
+
* UUID identifier. For the new records must be created on a client.
|
|
97
|
+
*/
|
|
77
98
|
id: string;
|
|
78
99
|
key: string;
|
|
79
100
|
type: 'string' | 'number' | 'boolean' | 'json' | 'null';
|
|
101
|
+
/**
|
|
102
|
+
* Parameter value corresponding to the `type`. JSON is stores as a serialized string.
|
|
103
|
+
*/
|
|
80
104
|
value: string | number | boolean | null;
|
|
81
105
|
};
|
|
82
106
|
export type DeleteBotProgress = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,UAAU,GAAG;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG;IAChB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;QAC1B,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE;YACN,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE;QACZ,MAAM,EAAE;YACN,GAAG,EAAE,MAAM,CAAC;YACZ,MAAM,EAAE,MAAM,CAAC;YACf,MAAM,EAAE,MAAM,CAAC;YACf,YAAY,EAAE,MAAM,CAAC;YACrB,iBAAiB,EAAE,MAAM,CAAC;YAC1B,iBAAiB,EAAE,MAAM,CAAC;YAC1B,kBAAkB,EAAE,MAAM,CAAC;YAC3B,sBAAsB,EAAE,MAAM,CAAC;YAC/B,eAAe,CAAC,EAAE,MAAM,CAAC;SAC1B,CAAC;QACF,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;IACxD;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAGF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAA;CACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@or-sdk/bots",
|
|
3
|
-
"version": "1.6.1
|
|
3
|
+
"version": "1.6.1",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -18,9 +18,9 @@
|
|
|
18
18
|
"dev": "pnpm build:watch:esm"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@or-sdk/base": "^0.44.0
|
|
22
|
-
"@or-sdk/data-hub-svc": "^2.3.1
|
|
23
|
-
"@or-sdk/tags": "^1.1.1
|
|
21
|
+
"@or-sdk/base": "^0.44.0",
|
|
22
|
+
"@or-sdk/data-hub-svc": "^2.3.1",
|
|
23
|
+
"@or-sdk/tags": "^1.1.1"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
26
|
"concurrently": "9.0.1",
|
|
@@ -28,5 +28,6 @@
|
|
|
28
28
|
},
|
|
29
29
|
"publishConfig": {
|
|
30
30
|
"access": "public"
|
|
31
|
-
}
|
|
31
|
+
},
|
|
32
|
+
"gitHead": "7d3b49250a670964dfe9e8e50e95417761c5473f"
|
|
32
33
|
}
|