@unified-api/typescript-sdk 2.73.19 → 2.73.21
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/README.md +16 -0
- package/bin/mcp-server.js +4542 -3185
- package/bin/mcp-server.js.map +40 -13
- package/docs/sdks/category/README.md +482 -0
- package/docs/sdks/embedding/README.md +87 -0
- package/docs/sdks/genai/README.md +160 -0
- package/docs/sdks/hris/README.md +30 -6
- package/docs/sdks/model/README.md +80 -0
- package/docs/sdks/ticketing/README.md +482 -0
- package/docs/sdks/timeshift/README.md +30 -6
- package/examples/package-lock.json +1 -1
- package/funcs/categoryCreateTicketingCategory.d.ts +15 -0
- package/funcs/categoryCreateTicketingCategory.d.ts.map +1 -0
- package/funcs/categoryCreateTicketingCategory.js +122 -0
- package/funcs/categoryCreateTicketingCategory.js.map +1 -0
- package/funcs/categoryGetTicketingCategory.d.ts +15 -0
- package/funcs/categoryGetTicketingCategory.d.ts.map +1 -0
- package/funcs/categoryGetTicketingCategory.js +125 -0
- package/funcs/categoryGetTicketingCategory.js.map +1 -0
- package/funcs/categoryListTicketingCategories.d.ts +15 -0
- package/funcs/categoryListTicketingCategories.d.ts.map +1 -0
- package/funcs/categoryListTicketingCategories.js +129 -0
- package/funcs/categoryListTicketingCategories.js.map +1 -0
- package/funcs/categoryPatchTicketingCategory.d.ts +15 -0
- package/funcs/categoryPatchTicketingCategory.d.ts.map +1 -0
- package/funcs/categoryPatchTicketingCategory.js +126 -0
- package/funcs/categoryPatchTicketingCategory.js.map +1 -0
- package/funcs/categoryRemoveTicketingCategory.d.ts +14 -0
- package/funcs/categoryRemoveTicketingCategory.d.ts.map +1 -0
- package/funcs/categoryRemoveTicketingCategory.js +122 -0
- package/funcs/categoryRemoveTicketingCategory.js.map +1 -0
- package/funcs/categoryUpdateTicketingCategory.d.ts +15 -0
- package/funcs/categoryUpdateTicketingCategory.d.ts.map +1 -0
- package/funcs/categoryUpdateTicketingCategory.js +126 -0
- package/funcs/categoryUpdateTicketingCategory.js.map +1 -0
- package/funcs/genaiCreateGenaiEmbedding.d.ts +15 -0
- package/funcs/genaiCreateGenaiEmbedding.d.ts.map +1 -0
- package/funcs/genaiCreateGenaiEmbedding.js +122 -0
- package/funcs/genaiCreateGenaiEmbedding.js.map +1 -0
- package/funcs/genaiGetGenaiModel.d.ts +15 -0
- package/funcs/genaiGetGenaiModel.d.ts.map +1 -0
- package/funcs/genaiGetGenaiModel.js +125 -0
- package/funcs/genaiGetGenaiModel.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +17 -1
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/categoryCreateTicketingCategory.d.ts +8 -0
- package/mcp-server/tools/categoryCreateTicketingCategory.d.ts.map +1 -0
- package/mcp-server/tools/categoryCreateTicketingCategory.js +62 -0
- package/mcp-server/tools/categoryCreateTicketingCategory.js.map +1 -0
- package/mcp-server/tools/categoryGetTicketingCategory.d.ts +8 -0
- package/mcp-server/tools/categoryGetTicketingCategory.d.ts.map +1 -0
- package/mcp-server/tools/categoryGetTicketingCategory.js +62 -0
- package/mcp-server/tools/categoryGetTicketingCategory.js.map +1 -0
- package/mcp-server/tools/categoryListTicketingCategories.d.ts +8 -0
- package/mcp-server/tools/categoryListTicketingCategories.d.ts.map +1 -0
- package/mcp-server/tools/categoryListTicketingCategories.js +62 -0
- package/mcp-server/tools/categoryListTicketingCategories.js.map +1 -0
- package/mcp-server/tools/categoryPatchTicketingCategory.d.ts +8 -0
- package/mcp-server/tools/categoryPatchTicketingCategory.d.ts.map +1 -0
- package/mcp-server/tools/categoryPatchTicketingCategory.js +62 -0
- package/mcp-server/tools/categoryPatchTicketingCategory.js.map +1 -0
- package/mcp-server/tools/categoryRemoveTicketingCategory.d.ts +8 -0
- package/mcp-server/tools/categoryRemoveTicketingCategory.d.ts.map +1 -0
- package/mcp-server/tools/categoryRemoveTicketingCategory.js +61 -0
- package/mcp-server/tools/categoryRemoveTicketingCategory.js.map +1 -0
- package/mcp-server/tools/categoryUpdateTicketingCategory.d.ts +8 -0
- package/mcp-server/tools/categoryUpdateTicketingCategory.d.ts.map +1 -0
- package/mcp-server/tools/categoryUpdateTicketingCategory.js +62 -0
- package/mcp-server/tools/categoryUpdateTicketingCategory.js.map +1 -0
- package/mcp-server/tools/genaiCreateGenaiEmbedding.d.ts +8 -0
- package/mcp-server/tools/genaiCreateGenaiEmbedding.d.ts.map +1 -0
- package/mcp-server/tools/genaiCreateGenaiEmbedding.js +62 -0
- package/mcp-server/tools/genaiCreateGenaiEmbedding.js.map +1 -0
- package/mcp-server/tools/genaiGetGenaiModel.d.ts +8 -0
- package/mcp-server/tools/genaiGetGenaiModel.d.ts.map +1 -0
- package/mcp-server/tools/genaiGetGenaiModel.js +62 -0
- package/mcp-server/tools/genaiGetGenaiModel.js.map +1 -0
- package/package.json +1 -1
- package/sdk/category.d.ts +24 -0
- package/sdk/category.d.ts.map +1 -1
- package/sdk/category.js +42 -0
- package/sdk/category.js.map +1 -1
- package/sdk/embedding.d.ts +10 -0
- package/sdk/embedding.d.ts.map +1 -0
- package/sdk/embedding.js +19 -0
- package/sdk/embedding.js.map +1 -0
- package/sdk/genai.d.ts +8 -0
- package/sdk/genai.d.ts.map +1 -1
- package/sdk/genai.js +14 -0
- package/sdk/genai.js.map +1 -1
- package/sdk/model.d.ts +4 -0
- package/sdk/model.d.ts.map +1 -1
- package/sdk/model.js +7 -0
- package/sdk/model.js.map +1 -1
- package/sdk/models/operations/creategenaiembedding.d.ts +45 -0
- package/sdk/models/operations/creategenaiembedding.d.ts.map +1 -0
- package/sdk/models/operations/creategenaiembedding.js +87 -0
- package/sdk/models/operations/creategenaiembedding.js.map +1 -0
- package/sdk/models/operations/createticketingcategory.d.ts +45 -0
- package/sdk/models/operations/createticketingcategory.d.ts.map +1 -0
- package/sdk/models/operations/createticketingcategory.js +87 -0
- package/sdk/models/operations/createticketingcategory.js.map +1 -0
- package/sdk/models/operations/getgenaimodel.d.ts +47 -0
- package/sdk/models/operations/getgenaimodel.d.ts.map +1 -0
- package/sdk/models/operations/getgenaimodel.js +84 -0
- package/sdk/models/operations/getgenaimodel.js.map +1 -0
- package/sdk/models/operations/getticketingcategory.d.ts +47 -0
- package/sdk/models/operations/getticketingcategory.d.ts.map +1 -0
- package/sdk/models/operations/getticketingcategory.js +84 -0
- package/sdk/models/operations/getticketingcategory.js.map +1 -0
- package/sdk/models/operations/index.d.ts +8 -0
- package/sdk/models/operations/index.d.ts.map +1 -1
- package/sdk/models/operations/index.js +8 -0
- package/sdk/models/operations/index.js.map +1 -1
- package/sdk/models/operations/listticketingcategories.d.ts +65 -0
- package/sdk/models/operations/listticketingcategories.d.ts.map +1 -0
- package/sdk/models/operations/listticketingcategories.js +100 -0
- package/sdk/models/operations/listticketingcategories.js.map +1 -0
- package/sdk/models/operations/patchticketingcategory.d.ts +50 -0
- package/sdk/models/operations/patchticketingcategory.d.ts.map +1 -0
- package/sdk/models/operations/patchticketingcategory.js +89 -0
- package/sdk/models/operations/patchticketingcategory.js.map +1 -0
- package/sdk/models/operations/removeticketingcategory.d.ts +66 -0
- package/sdk/models/operations/removeticketingcategory.d.ts.map +1 -0
- package/sdk/models/operations/removeticketingcategory.js +115 -0
- package/sdk/models/operations/removeticketingcategory.js.map +1 -0
- package/sdk/models/operations/updateticketingcategory.d.ts +50 -0
- package/sdk/models/operations/updateticketingcategory.d.ts.map +1 -0
- package/sdk/models/operations/updateticketingcategory.js +89 -0
- package/sdk/models/operations/updateticketingcategory.js.map +1 -0
- package/sdk/models/shared/genaiembedding.d.ts +76 -0
- package/sdk/models/shared/genaiembedding.d.ts.map +1 -0
- package/sdk/models/shared/genaiembedding.js +134 -0
- package/sdk/models/shared/genaiembedding.js.map +1 -0
- package/sdk/models/shared/genaiembeddingcontent.d.ts +29 -0
- package/sdk/models/shared/genaiembeddingcontent.d.ts.map +1 -0
- package/sdk/models/shared/genaiembeddingcontent.js +69 -0
- package/sdk/models/shared/genaiembeddingcontent.js.map +1 -0
- package/sdk/models/shared/hriscompensation.d.ts +2 -0
- package/sdk/models/shared/hriscompensation.d.ts.map +1 -1
- package/sdk/models/shared/hriscompensation.js +11 -0
- package/sdk/models/shared/hriscompensation.js.map +1 -1
- package/sdk/models/shared/hristimeshift.d.ts +6 -6
- package/sdk/models/shared/hristimeshift.d.ts.map +1 -1
- package/sdk/models/shared/hristimeshift.js +6 -8
- package/sdk/models/shared/hristimeshift.js.map +1 -1
- package/sdk/models/shared/index.d.ts +3 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +3 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/propertyconnectionpermissions.d.ts +4 -0
- package/sdk/models/shared/propertyconnectionpermissions.d.ts.map +1 -1
- package/sdk/models/shared/propertyconnectionpermissions.js +4 -0
- package/sdk/models/shared/propertyconnectionpermissions.js.map +1 -1
- package/sdk/models/shared/ticketingcategory.d.ts +47 -0
- package/sdk/models/shared/ticketingcategory.d.ts.map +1 -0
- package/sdk/models/shared/ticketingcategory.js +100 -0
- package/sdk/models/shared/ticketingcategory.js.map +1 -0
- package/sdk/models/shared/ticketingticket.d.ts +2 -0
- package/sdk/models/shared/ticketingticket.d.ts.map +1 -1
- package/sdk/models/shared/ticketingticket.js +4 -0
- package/sdk/models/shared/ticketingticket.js.map +1 -1
- package/sdk/models/shared/webhook.d.ts +2 -0
- package/sdk/models/shared/webhook.d.ts.map +1 -1
- package/sdk/models/shared/webhook.js +2 -0
- package/sdk/models/shared/webhook.js.map +1 -1
- package/sdk/sdk.d.ts +3 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +4 -0
- package/sdk/sdk.js.map +1 -1
- package/sdk/ticketing.d.ts +24 -0
- package/sdk/ticketing.d.ts.map +1 -1
- package/sdk/ticketing.js +42 -0
- package/sdk/ticketing.js.map +1 -1
- package/src/funcs/categoryCreateTicketingCategory.ts +171 -0
- package/src/funcs/categoryGetTicketingCategory.ts +176 -0
- package/src/funcs/categoryListTicketingCategories.ts +178 -0
- package/src/funcs/categoryPatchTicketingCategory.ts +177 -0
- package/src/funcs/categoryRemoveTicketingCategory.ts +181 -0
- package/src/funcs/categoryUpdateTicketingCategory.ts +177 -0
- package/src/funcs/genaiCreateGenaiEmbedding.ts +171 -0
- package/src/funcs/genaiGetGenaiModel.ts +173 -0
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +17 -1
- package/src/mcp-server/tools/categoryCreateTicketingCategory.ts +36 -0
- package/src/mcp-server/tools/categoryGetTicketingCategory.ts +35 -0
- package/src/mcp-server/tools/categoryListTicketingCategories.ts +36 -0
- package/src/mcp-server/tools/categoryPatchTicketingCategory.ts +36 -0
- package/src/mcp-server/tools/categoryRemoveTicketingCategory.ts +34 -0
- package/src/mcp-server/tools/categoryUpdateTicketingCategory.ts +36 -0
- package/src/mcp-server/tools/genaiCreateGenaiEmbedding.ts +35 -0
- package/src/mcp-server/tools/genaiGetGenaiModel.ts +35 -0
- package/src/sdk/category.ts +90 -0
- package/src/sdk/embedding.ts +25 -0
- package/src/sdk/genai.ts +30 -0
- package/src/sdk/model.ts +15 -0
- package/src/sdk/models/operations/creategenaiembedding.ts +101 -0
- package/src/sdk/models/operations/createticketingcategory.ts +101 -0
- package/src/sdk/models/operations/getgenaimodel.ts +99 -0
- package/src/sdk/models/operations/getticketingcategory.ts +101 -0
- package/src/sdk/models/operations/index.ts +8 -0
- package/src/sdk/models/operations/listticketingcategories.ts +135 -0
- package/src/sdk/models/operations/patchticketingcategory.ts +108 -0
- package/src/sdk/models/operations/removeticketingcategory.ts +155 -0
- package/src/sdk/models/operations/updateticketingcategory.ts +108 -0
- package/src/sdk/models/shared/genaiembedding.ts +166 -0
- package/src/sdk/models/shared/genaiembeddingcontent.ts +66 -0
- package/src/sdk/models/shared/hriscompensation.ts +13 -0
- package/src/sdk/models/shared/hristimeshift.ts +12 -14
- package/src/sdk/models/shared/index.ts +3 -0
- package/src/sdk/models/shared/propertyconnectionpermissions.ts +4 -0
- package/src/sdk/models/shared/ticketingcategory.ts +111 -0
- package/src/sdk/models/shared/ticketingticket.ts +6 -0
- package/src/sdk/models/shared/webhook.ts +2 -0
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/ticketing.ts +90 -0
|
@@ -5,9 +5,90 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
+
* [createGenaiEmbedding](#creategenaiembedding) - Create an embedding
|
|
8
9
|
* [createGenaiPrompt](#creategenaiprompt) - Create a prompt
|
|
10
|
+
* [getGenaiModel](#getgenaimodel) - Retrieve a model
|
|
9
11
|
* [listGenaiModels](#listgenaimodels) - List all models
|
|
10
12
|
|
|
13
|
+
## createGenaiEmbedding
|
|
14
|
+
|
|
15
|
+
Create an embedding
|
|
16
|
+
|
|
17
|
+
### Example Usage
|
|
18
|
+
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="createGenaiEmbedding" method="post" path="/genai/{connection_id}/embedding" -->
|
|
20
|
+
```typescript
|
|
21
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
22
|
+
|
|
23
|
+
const unifiedTo = new UnifiedTo({
|
|
24
|
+
security: {
|
|
25
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
async function run() {
|
|
30
|
+
const result = await unifiedTo.genai.createGenaiEmbedding({
|
|
31
|
+
genaiEmbedding: {},
|
|
32
|
+
connectionId: "<id>",
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
console.log(result);
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
run();
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Standalone function
|
|
42
|
+
|
|
43
|
+
The standalone function version of this method:
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
47
|
+
import { genaiCreateGenaiEmbedding } from "@unified-api/typescript-sdk/funcs/genaiCreateGenaiEmbedding.js";
|
|
48
|
+
|
|
49
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
50
|
+
// You can create one instance of it to use across an application.
|
|
51
|
+
const unifiedTo = new UnifiedToCore({
|
|
52
|
+
security: {
|
|
53
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
54
|
+
},
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
async function run() {
|
|
58
|
+
const res = await genaiCreateGenaiEmbedding(unifiedTo, {
|
|
59
|
+
genaiEmbedding: {},
|
|
60
|
+
connectionId: "<id>",
|
|
61
|
+
});
|
|
62
|
+
if (res.ok) {
|
|
63
|
+
const { value: result } = res;
|
|
64
|
+
console.log(result);
|
|
65
|
+
} else {
|
|
66
|
+
console.log("genaiCreateGenaiEmbedding failed:", res.error);
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
run();
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
| Parameter | Type | Required | Description |
|
|
76
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
77
|
+
| `request` | [operations.CreateGenaiEmbeddingRequest](../../sdk/models/operations/creategenaiembeddingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
78
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
79
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
80
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
81
|
+
|
|
82
|
+
### Response
|
|
83
|
+
|
|
84
|
+
**Promise\<[shared.GenaiEmbedding](../../sdk/models/shared/genaiembedding.md)\>**
|
|
85
|
+
|
|
86
|
+
### Errors
|
|
87
|
+
|
|
88
|
+
| Error Type | Status Code | Content Type |
|
|
89
|
+
| --------------- | --------------- | --------------- |
|
|
90
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
91
|
+
|
|
11
92
|
## createGenaiPrompt
|
|
12
93
|
|
|
13
94
|
Create a prompt
|
|
@@ -87,6 +168,85 @@ run();
|
|
|
87
168
|
| --------------- | --------------- | --------------- |
|
|
88
169
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
89
170
|
|
|
171
|
+
## getGenaiModel
|
|
172
|
+
|
|
173
|
+
Retrieve a model
|
|
174
|
+
|
|
175
|
+
### Example Usage
|
|
176
|
+
|
|
177
|
+
<!-- UsageSnippet language="typescript" operationID="getGenaiModel" method="get" path="/genai/{connection_id}/model/{id}" -->
|
|
178
|
+
```typescript
|
|
179
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
180
|
+
|
|
181
|
+
const unifiedTo = new UnifiedTo({
|
|
182
|
+
security: {
|
|
183
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
184
|
+
},
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
async function run() {
|
|
188
|
+
const result = await unifiedTo.genai.getGenaiModel({
|
|
189
|
+
connectionId: "<id>",
|
|
190
|
+
id: "<id>",
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
console.log(result);
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
run();
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Standalone function
|
|
200
|
+
|
|
201
|
+
The standalone function version of this method:
|
|
202
|
+
|
|
203
|
+
```typescript
|
|
204
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
205
|
+
import { genaiGetGenaiModel } from "@unified-api/typescript-sdk/funcs/genaiGetGenaiModel.js";
|
|
206
|
+
|
|
207
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
208
|
+
// You can create one instance of it to use across an application.
|
|
209
|
+
const unifiedTo = new UnifiedToCore({
|
|
210
|
+
security: {
|
|
211
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
212
|
+
},
|
|
213
|
+
});
|
|
214
|
+
|
|
215
|
+
async function run() {
|
|
216
|
+
const res = await genaiGetGenaiModel(unifiedTo, {
|
|
217
|
+
connectionId: "<id>",
|
|
218
|
+
id: "<id>",
|
|
219
|
+
});
|
|
220
|
+
if (res.ok) {
|
|
221
|
+
const { value: result } = res;
|
|
222
|
+
console.log(result);
|
|
223
|
+
} else {
|
|
224
|
+
console.log("genaiGetGenaiModel failed:", res.error);
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
run();
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
### Parameters
|
|
232
|
+
|
|
233
|
+
| Parameter | Type | Required | Description |
|
|
234
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
235
|
+
| `request` | [operations.GetGenaiModelRequest](../../sdk/models/operations/getgenaimodelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
236
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
237
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
238
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
239
|
+
|
|
240
|
+
### Response
|
|
241
|
+
|
|
242
|
+
**Promise\<[shared.GenaiModel](../../sdk/models/shared/genaimodel.md)\>**
|
|
243
|
+
|
|
244
|
+
### Errors
|
|
245
|
+
|
|
246
|
+
| Error Type | Status Code | Content Type |
|
|
247
|
+
| --------------- | --------------- | --------------- |
|
|
248
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
249
|
+
|
|
90
250
|
## listGenaiModels
|
|
91
251
|
|
|
92
252
|
List all models
|
package/docs/sdks/hris/README.md
CHANGED
|
@@ -463,7 +463,11 @@ const unifiedTo = new UnifiedTo({
|
|
|
463
463
|
|
|
464
464
|
async function run() {
|
|
465
465
|
const result = await unifiedTo.hris.createHrisTimeshift({
|
|
466
|
-
hrisTimeshift: {
|
|
466
|
+
hrisTimeshift: {
|
|
467
|
+
employeeUserId: "<id>",
|
|
468
|
+
endAt: new Date("2025-10-18T00:03:45.822Z"),
|
|
469
|
+
startAt: new Date("2024-06-03T05:33:48.715Z"),
|
|
470
|
+
},
|
|
467
471
|
connectionId: "<id>",
|
|
468
472
|
});
|
|
469
473
|
|
|
@@ -491,7 +495,11 @@ const unifiedTo = new UnifiedToCore({
|
|
|
491
495
|
|
|
492
496
|
async function run() {
|
|
493
497
|
const res = await hrisCreateHrisTimeshift(unifiedTo, {
|
|
494
|
-
hrisTimeshift: {
|
|
498
|
+
hrisTimeshift: {
|
|
499
|
+
employeeUserId: "<id>",
|
|
500
|
+
endAt: new Date("2025-10-18T00:03:45.822Z"),
|
|
501
|
+
startAt: new Date("2024-06-03T05:33:48.715Z"),
|
|
502
|
+
},
|
|
495
503
|
connectionId: "<id>",
|
|
496
504
|
});
|
|
497
505
|
if (res.ok) {
|
|
@@ -2199,7 +2207,11 @@ const unifiedTo = new UnifiedTo({
|
|
|
2199
2207
|
|
|
2200
2208
|
async function run() {
|
|
2201
2209
|
const result = await unifiedTo.hris.patchHrisTimeshift({
|
|
2202
|
-
hrisTimeshift: {
|
|
2210
|
+
hrisTimeshift: {
|
|
2211
|
+
employeeUserId: "<id>",
|
|
2212
|
+
endAt: new Date("2023-11-17T18:53:02.172Z"),
|
|
2213
|
+
startAt: new Date("2023-01-19T02:48:41.002Z"),
|
|
2214
|
+
},
|
|
2203
2215
|
connectionId: "<id>",
|
|
2204
2216
|
id: "<id>",
|
|
2205
2217
|
});
|
|
@@ -2228,7 +2240,11 @@ const unifiedTo = new UnifiedToCore({
|
|
|
2228
2240
|
|
|
2229
2241
|
async function run() {
|
|
2230
2242
|
const res = await hrisPatchHrisTimeshift(unifiedTo, {
|
|
2231
|
-
hrisTimeshift: {
|
|
2243
|
+
hrisTimeshift: {
|
|
2244
|
+
employeeUserId: "<id>",
|
|
2245
|
+
endAt: new Date("2023-11-17T18:53:02.172Z"),
|
|
2246
|
+
startAt: new Date("2023-01-19T02:48:41.002Z"),
|
|
2247
|
+
},
|
|
2232
2248
|
connectionId: "<id>",
|
|
2233
2249
|
id: "<id>",
|
|
2234
2250
|
});
|
|
@@ -3163,7 +3179,11 @@ const unifiedTo = new UnifiedTo({
|
|
|
3163
3179
|
|
|
3164
3180
|
async function run() {
|
|
3165
3181
|
const result = await unifiedTo.hris.updateHrisTimeshift({
|
|
3166
|
-
hrisTimeshift: {
|
|
3182
|
+
hrisTimeshift: {
|
|
3183
|
+
employeeUserId: "<id>",
|
|
3184
|
+
endAt: new Date("2025-03-03T22:04:09.340Z"),
|
|
3185
|
+
startAt: new Date("2024-05-30T21:19:58.772Z"),
|
|
3186
|
+
},
|
|
3167
3187
|
connectionId: "<id>",
|
|
3168
3188
|
id: "<id>",
|
|
3169
3189
|
});
|
|
@@ -3192,7 +3212,11 @@ const unifiedTo = new UnifiedToCore({
|
|
|
3192
3212
|
|
|
3193
3213
|
async function run() {
|
|
3194
3214
|
const res = await hrisUpdateHrisTimeshift(unifiedTo, {
|
|
3195
|
-
hrisTimeshift: {
|
|
3215
|
+
hrisTimeshift: {
|
|
3216
|
+
employeeUserId: "<id>",
|
|
3217
|
+
endAt: new Date("2025-03-03T22:04:09.340Z"),
|
|
3218
|
+
startAt: new Date("2024-05-30T21:19:58.772Z"),
|
|
3219
|
+
},
|
|
3196
3220
|
connectionId: "<id>",
|
|
3197
3221
|
id: "<id>",
|
|
3198
3222
|
});
|
|
@@ -5,8 +5,88 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
+
* [getGenaiModel](#getgenaimodel) - Retrieve a model
|
|
8
9
|
* [listGenaiModels](#listgenaimodels) - List all models
|
|
9
10
|
|
|
11
|
+
## getGenaiModel
|
|
12
|
+
|
|
13
|
+
Retrieve a model
|
|
14
|
+
|
|
15
|
+
### Example Usage
|
|
16
|
+
|
|
17
|
+
<!-- UsageSnippet language="typescript" operationID="getGenaiModel" method="get" path="/genai/{connection_id}/model/{id}" -->
|
|
18
|
+
```typescript
|
|
19
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
20
|
+
|
|
21
|
+
const unifiedTo = new UnifiedTo({
|
|
22
|
+
security: {
|
|
23
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
24
|
+
},
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
async function run() {
|
|
28
|
+
const result = await unifiedTo.model.getGenaiModel({
|
|
29
|
+
connectionId: "<id>",
|
|
30
|
+
id: "<id>",
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
console.log(result);
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
run();
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Standalone function
|
|
40
|
+
|
|
41
|
+
The standalone function version of this method:
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
45
|
+
import { genaiGetGenaiModel } from "@unified-api/typescript-sdk/funcs/genaiGetGenaiModel.js";
|
|
46
|
+
|
|
47
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
48
|
+
// You can create one instance of it to use across an application.
|
|
49
|
+
const unifiedTo = new UnifiedToCore({
|
|
50
|
+
security: {
|
|
51
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
52
|
+
},
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
async function run() {
|
|
56
|
+
const res = await genaiGetGenaiModel(unifiedTo, {
|
|
57
|
+
connectionId: "<id>",
|
|
58
|
+
id: "<id>",
|
|
59
|
+
});
|
|
60
|
+
if (res.ok) {
|
|
61
|
+
const { value: result } = res;
|
|
62
|
+
console.log(result);
|
|
63
|
+
} else {
|
|
64
|
+
console.log("genaiGetGenaiModel failed:", res.error);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
run();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
|
|
73
|
+
| Parameter | Type | Required | Description |
|
|
74
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
75
|
+
| `request` | [operations.GetGenaiModelRequest](../../sdk/models/operations/getgenaimodelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
76
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
77
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
78
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
79
|
+
|
|
80
|
+
### Response
|
|
81
|
+
|
|
82
|
+
**Promise\<[shared.GenaiModel](../../sdk/models/shared/genaimodel.md)\>**
|
|
83
|
+
|
|
84
|
+
### Errors
|
|
85
|
+
|
|
86
|
+
| Error Type | Status Code | Content Type |
|
|
87
|
+
| --------------- | --------------- | --------------- |
|
|
88
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
89
|
+
|
|
10
90
|
## listGenaiModels
|
|
11
91
|
|
|
12
92
|
List all models
|