@unified-api/typescript-sdk 2.73.19 → 2.73.20
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 +4545 -3199
- package/bin/mcp-server.js.map +38 -11
- 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/model/README.md +80 -0
- package/docs/sdks/ticketing/README.md +482 -0
- 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/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/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
|
@@ -6,11 +6,17 @@
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
8
|
* [createAccountingCategory](#createaccountingcategory) - Create a category
|
|
9
|
+
* [createTicketingCategory](#createticketingcategory) - Create a category
|
|
9
10
|
* [getAccountingCategory](#getaccountingcategory) - Retrieve a category
|
|
11
|
+
* [getTicketingCategory](#getticketingcategory) - Retrieve a category
|
|
10
12
|
* [listAccountingCategories](#listaccountingcategories) - List all categories
|
|
13
|
+
* [listTicketingCategories](#listticketingcategories) - List all categories
|
|
11
14
|
* [patchAccountingCategory](#patchaccountingcategory) - Update a category
|
|
15
|
+
* [patchTicketingCategory](#patchticketingcategory) - Update a category
|
|
12
16
|
* [removeAccountingCategory](#removeaccountingcategory) - Remove a category
|
|
17
|
+
* [removeTicketingCategory](#removeticketingcategory) - Remove a category
|
|
13
18
|
* [updateAccountingCategory](#updateaccountingcategory) - Update a category
|
|
19
|
+
* [updateTicketingCategory](#updateticketingcategory) - Update a category
|
|
14
20
|
|
|
15
21
|
## createAccountingCategory
|
|
16
22
|
|
|
@@ -91,6 +97,85 @@ run();
|
|
|
91
97
|
| --------------- | --------------- | --------------- |
|
|
92
98
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
93
99
|
|
|
100
|
+
## createTicketingCategory
|
|
101
|
+
|
|
102
|
+
Create a category
|
|
103
|
+
|
|
104
|
+
### Example Usage
|
|
105
|
+
|
|
106
|
+
<!-- UsageSnippet language="typescript" operationID="createTicketingCategory" method="post" path="/ticketing/{connection_id}/category" -->
|
|
107
|
+
```typescript
|
|
108
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
109
|
+
|
|
110
|
+
const unifiedTo = new UnifiedTo({
|
|
111
|
+
security: {
|
|
112
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
113
|
+
},
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
async function run() {
|
|
117
|
+
const result = await unifiedTo.category.createTicketingCategory({
|
|
118
|
+
ticketingCategory: {},
|
|
119
|
+
connectionId: "<id>",
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
console.log(result);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
run();
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Standalone function
|
|
129
|
+
|
|
130
|
+
The standalone function version of this method:
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
134
|
+
import { categoryCreateTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryCreateTicketingCategory.js";
|
|
135
|
+
|
|
136
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
137
|
+
// You can create one instance of it to use across an application.
|
|
138
|
+
const unifiedTo = new UnifiedToCore({
|
|
139
|
+
security: {
|
|
140
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
141
|
+
},
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
async function run() {
|
|
145
|
+
const res = await categoryCreateTicketingCategory(unifiedTo, {
|
|
146
|
+
ticketingCategory: {},
|
|
147
|
+
connectionId: "<id>",
|
|
148
|
+
});
|
|
149
|
+
if (res.ok) {
|
|
150
|
+
const { value: result } = res;
|
|
151
|
+
console.log(result);
|
|
152
|
+
} else {
|
|
153
|
+
console.log("categoryCreateTicketingCategory failed:", res.error);
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
run();
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
| Parameter | Type | Required | Description |
|
|
163
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
164
|
+
| `request` | [operations.CreateTicketingCategoryRequest](../../sdk/models/operations/createticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
165
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
166
|
+
| `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. |
|
|
167
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
168
|
+
|
|
169
|
+
### Response
|
|
170
|
+
|
|
171
|
+
**Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
|
|
172
|
+
|
|
173
|
+
### Errors
|
|
174
|
+
|
|
175
|
+
| Error Type | Status Code | Content Type |
|
|
176
|
+
| --------------- | --------------- | --------------- |
|
|
177
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
178
|
+
|
|
94
179
|
## getAccountingCategory
|
|
95
180
|
|
|
96
181
|
Retrieve a category
|
|
@@ -170,6 +255,85 @@ run();
|
|
|
170
255
|
| --------------- | --------------- | --------------- |
|
|
171
256
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
172
257
|
|
|
258
|
+
## getTicketingCategory
|
|
259
|
+
|
|
260
|
+
Retrieve a category
|
|
261
|
+
|
|
262
|
+
### Example Usage
|
|
263
|
+
|
|
264
|
+
<!-- UsageSnippet language="typescript" operationID="getTicketingCategory" method="get" path="/ticketing/{connection_id}/category/{id}" -->
|
|
265
|
+
```typescript
|
|
266
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
267
|
+
|
|
268
|
+
const unifiedTo = new UnifiedTo({
|
|
269
|
+
security: {
|
|
270
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
271
|
+
},
|
|
272
|
+
});
|
|
273
|
+
|
|
274
|
+
async function run() {
|
|
275
|
+
const result = await unifiedTo.category.getTicketingCategory({
|
|
276
|
+
connectionId: "<id>",
|
|
277
|
+
id: "<id>",
|
|
278
|
+
});
|
|
279
|
+
|
|
280
|
+
console.log(result);
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
run();
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
### Standalone function
|
|
287
|
+
|
|
288
|
+
The standalone function version of this method:
|
|
289
|
+
|
|
290
|
+
```typescript
|
|
291
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
292
|
+
import { categoryGetTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryGetTicketingCategory.js";
|
|
293
|
+
|
|
294
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
295
|
+
// You can create one instance of it to use across an application.
|
|
296
|
+
const unifiedTo = new UnifiedToCore({
|
|
297
|
+
security: {
|
|
298
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
299
|
+
},
|
|
300
|
+
});
|
|
301
|
+
|
|
302
|
+
async function run() {
|
|
303
|
+
const res = await categoryGetTicketingCategory(unifiedTo, {
|
|
304
|
+
connectionId: "<id>",
|
|
305
|
+
id: "<id>",
|
|
306
|
+
});
|
|
307
|
+
if (res.ok) {
|
|
308
|
+
const { value: result } = res;
|
|
309
|
+
console.log(result);
|
|
310
|
+
} else {
|
|
311
|
+
console.log("categoryGetTicketingCategory failed:", res.error);
|
|
312
|
+
}
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
run();
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### Parameters
|
|
319
|
+
|
|
320
|
+
| Parameter | Type | Required | Description |
|
|
321
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
322
|
+
| `request` | [operations.GetTicketingCategoryRequest](../../sdk/models/operations/getticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
323
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
324
|
+
| `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. |
|
|
325
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
326
|
+
|
|
327
|
+
### Response
|
|
328
|
+
|
|
329
|
+
**Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
|
|
330
|
+
|
|
331
|
+
### Errors
|
|
332
|
+
|
|
333
|
+
| Error Type | Status Code | Content Type |
|
|
334
|
+
| --------------- | --------------- | --------------- |
|
|
335
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
336
|
+
|
|
173
337
|
## listAccountingCategories
|
|
174
338
|
|
|
175
339
|
List all categories
|
|
@@ -247,6 +411,83 @@ run();
|
|
|
247
411
|
| --------------- | --------------- | --------------- |
|
|
248
412
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
249
413
|
|
|
414
|
+
## listTicketingCategories
|
|
415
|
+
|
|
416
|
+
List all categories
|
|
417
|
+
|
|
418
|
+
### Example Usage
|
|
419
|
+
|
|
420
|
+
<!-- UsageSnippet language="typescript" operationID="listTicketingCategories" method="get" path="/ticketing/{connection_id}/category" -->
|
|
421
|
+
```typescript
|
|
422
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
423
|
+
|
|
424
|
+
const unifiedTo = new UnifiedTo({
|
|
425
|
+
security: {
|
|
426
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
427
|
+
},
|
|
428
|
+
});
|
|
429
|
+
|
|
430
|
+
async function run() {
|
|
431
|
+
const result = await unifiedTo.category.listTicketingCategories({
|
|
432
|
+
connectionId: "<id>",
|
|
433
|
+
});
|
|
434
|
+
|
|
435
|
+
console.log(result);
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
run();
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
### Standalone function
|
|
442
|
+
|
|
443
|
+
The standalone function version of this method:
|
|
444
|
+
|
|
445
|
+
```typescript
|
|
446
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
447
|
+
import { categoryListTicketingCategories } from "@unified-api/typescript-sdk/funcs/categoryListTicketingCategories.js";
|
|
448
|
+
|
|
449
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
450
|
+
// You can create one instance of it to use across an application.
|
|
451
|
+
const unifiedTo = new UnifiedToCore({
|
|
452
|
+
security: {
|
|
453
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
454
|
+
},
|
|
455
|
+
});
|
|
456
|
+
|
|
457
|
+
async function run() {
|
|
458
|
+
const res = await categoryListTicketingCategories(unifiedTo, {
|
|
459
|
+
connectionId: "<id>",
|
|
460
|
+
});
|
|
461
|
+
if (res.ok) {
|
|
462
|
+
const { value: result } = res;
|
|
463
|
+
console.log(result);
|
|
464
|
+
} else {
|
|
465
|
+
console.log("categoryListTicketingCategories failed:", res.error);
|
|
466
|
+
}
|
|
467
|
+
}
|
|
468
|
+
|
|
469
|
+
run();
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
### Parameters
|
|
473
|
+
|
|
474
|
+
| Parameter | Type | Required | Description |
|
|
475
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
476
|
+
| `request` | [operations.ListTicketingCategoriesRequest](../../sdk/models/operations/listticketingcategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
477
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
478
|
+
| `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. |
|
|
479
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
480
|
+
|
|
481
|
+
### Response
|
|
482
|
+
|
|
483
|
+
**Promise\<[shared.TicketingCategory[]](../../models/.md)\>**
|
|
484
|
+
|
|
485
|
+
### Errors
|
|
486
|
+
|
|
487
|
+
| Error Type | Status Code | Content Type |
|
|
488
|
+
| --------------- | --------------- | --------------- |
|
|
489
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
490
|
+
|
|
250
491
|
## patchAccountingCategory
|
|
251
492
|
|
|
252
493
|
Update a category
|
|
@@ -328,6 +569,87 @@ run();
|
|
|
328
569
|
| --------------- | --------------- | --------------- |
|
|
329
570
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
330
571
|
|
|
572
|
+
## patchTicketingCategory
|
|
573
|
+
|
|
574
|
+
Update a category
|
|
575
|
+
|
|
576
|
+
### Example Usage
|
|
577
|
+
|
|
578
|
+
<!-- UsageSnippet language="typescript" operationID="patchTicketingCategory" method="patch" path="/ticketing/{connection_id}/category/{id}" -->
|
|
579
|
+
```typescript
|
|
580
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
581
|
+
|
|
582
|
+
const unifiedTo = new UnifiedTo({
|
|
583
|
+
security: {
|
|
584
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
585
|
+
},
|
|
586
|
+
});
|
|
587
|
+
|
|
588
|
+
async function run() {
|
|
589
|
+
const result = await unifiedTo.category.patchTicketingCategory({
|
|
590
|
+
ticketingCategory: {},
|
|
591
|
+
connectionId: "<id>",
|
|
592
|
+
id: "<id>",
|
|
593
|
+
});
|
|
594
|
+
|
|
595
|
+
console.log(result);
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
run();
|
|
599
|
+
```
|
|
600
|
+
|
|
601
|
+
### Standalone function
|
|
602
|
+
|
|
603
|
+
The standalone function version of this method:
|
|
604
|
+
|
|
605
|
+
```typescript
|
|
606
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
607
|
+
import { categoryPatchTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryPatchTicketingCategory.js";
|
|
608
|
+
|
|
609
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
610
|
+
// You can create one instance of it to use across an application.
|
|
611
|
+
const unifiedTo = new UnifiedToCore({
|
|
612
|
+
security: {
|
|
613
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
614
|
+
},
|
|
615
|
+
});
|
|
616
|
+
|
|
617
|
+
async function run() {
|
|
618
|
+
const res = await categoryPatchTicketingCategory(unifiedTo, {
|
|
619
|
+
ticketingCategory: {},
|
|
620
|
+
connectionId: "<id>",
|
|
621
|
+
id: "<id>",
|
|
622
|
+
});
|
|
623
|
+
if (res.ok) {
|
|
624
|
+
const { value: result } = res;
|
|
625
|
+
console.log(result);
|
|
626
|
+
} else {
|
|
627
|
+
console.log("categoryPatchTicketingCategory failed:", res.error);
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
|
|
631
|
+
run();
|
|
632
|
+
```
|
|
633
|
+
|
|
634
|
+
### Parameters
|
|
635
|
+
|
|
636
|
+
| Parameter | Type | Required | Description |
|
|
637
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
638
|
+
| `request` | [operations.PatchTicketingCategoryRequest](../../sdk/models/operations/patchticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
639
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
640
|
+
| `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. |
|
|
641
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
642
|
+
|
|
643
|
+
### Response
|
|
644
|
+
|
|
645
|
+
**Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
|
|
646
|
+
|
|
647
|
+
### Errors
|
|
648
|
+
|
|
649
|
+
| Error Type | Status Code | Content Type |
|
|
650
|
+
| --------------- | --------------- | --------------- |
|
|
651
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
652
|
+
|
|
331
653
|
## removeAccountingCategory
|
|
332
654
|
|
|
333
655
|
Remove a category
|
|
@@ -407,6 +729,85 @@ run();
|
|
|
407
729
|
| --------------- | --------------- | --------------- |
|
|
408
730
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
409
731
|
|
|
732
|
+
## removeTicketingCategory
|
|
733
|
+
|
|
734
|
+
Remove a category
|
|
735
|
+
|
|
736
|
+
### Example Usage
|
|
737
|
+
|
|
738
|
+
<!-- UsageSnippet language="typescript" operationID="removeTicketingCategory" method="delete" path="/ticketing/{connection_id}/category/{id}" -->
|
|
739
|
+
```typescript
|
|
740
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
741
|
+
|
|
742
|
+
const unifiedTo = new UnifiedTo({
|
|
743
|
+
security: {
|
|
744
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
745
|
+
},
|
|
746
|
+
});
|
|
747
|
+
|
|
748
|
+
async function run() {
|
|
749
|
+
const result = await unifiedTo.category.removeTicketingCategory({
|
|
750
|
+
connectionId: "<id>",
|
|
751
|
+
id: "<id>",
|
|
752
|
+
});
|
|
753
|
+
|
|
754
|
+
console.log(result);
|
|
755
|
+
}
|
|
756
|
+
|
|
757
|
+
run();
|
|
758
|
+
```
|
|
759
|
+
|
|
760
|
+
### Standalone function
|
|
761
|
+
|
|
762
|
+
The standalone function version of this method:
|
|
763
|
+
|
|
764
|
+
```typescript
|
|
765
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
766
|
+
import { categoryRemoveTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryRemoveTicketingCategory.js";
|
|
767
|
+
|
|
768
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
769
|
+
// You can create one instance of it to use across an application.
|
|
770
|
+
const unifiedTo = new UnifiedToCore({
|
|
771
|
+
security: {
|
|
772
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
773
|
+
},
|
|
774
|
+
});
|
|
775
|
+
|
|
776
|
+
async function run() {
|
|
777
|
+
const res = await categoryRemoveTicketingCategory(unifiedTo, {
|
|
778
|
+
connectionId: "<id>",
|
|
779
|
+
id: "<id>",
|
|
780
|
+
});
|
|
781
|
+
if (res.ok) {
|
|
782
|
+
const { value: result } = res;
|
|
783
|
+
console.log(result);
|
|
784
|
+
} else {
|
|
785
|
+
console.log("categoryRemoveTicketingCategory failed:", res.error);
|
|
786
|
+
}
|
|
787
|
+
}
|
|
788
|
+
|
|
789
|
+
run();
|
|
790
|
+
```
|
|
791
|
+
|
|
792
|
+
### Parameters
|
|
793
|
+
|
|
794
|
+
| Parameter | Type | Required | Description |
|
|
795
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
796
|
+
| `request` | [operations.RemoveTicketingCategoryRequest](../../sdk/models/operations/removeticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
797
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
798
|
+
| `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. |
|
|
799
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
800
|
+
|
|
801
|
+
### Response
|
|
802
|
+
|
|
803
|
+
**Promise\<[operations.RemoveTicketingCategoryResponse](../../sdk/models/operations/removeticketingcategoryresponse.md)\>**
|
|
804
|
+
|
|
805
|
+
### Errors
|
|
806
|
+
|
|
807
|
+
| Error Type | Status Code | Content Type |
|
|
808
|
+
| --------------- | --------------- | --------------- |
|
|
809
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
810
|
+
|
|
410
811
|
## updateAccountingCategory
|
|
411
812
|
|
|
412
813
|
Update a category
|
|
@@ -484,6 +885,87 @@ run();
|
|
|
484
885
|
|
|
485
886
|
### Errors
|
|
486
887
|
|
|
888
|
+
| Error Type | Status Code | Content Type |
|
|
889
|
+
| --------------- | --------------- | --------------- |
|
|
890
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
891
|
+
|
|
892
|
+
## updateTicketingCategory
|
|
893
|
+
|
|
894
|
+
Update a category
|
|
895
|
+
|
|
896
|
+
### Example Usage
|
|
897
|
+
|
|
898
|
+
<!-- UsageSnippet language="typescript" operationID="updateTicketingCategory" method="put" path="/ticketing/{connection_id}/category/{id}" -->
|
|
899
|
+
```typescript
|
|
900
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
901
|
+
|
|
902
|
+
const unifiedTo = new UnifiedTo({
|
|
903
|
+
security: {
|
|
904
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
905
|
+
},
|
|
906
|
+
});
|
|
907
|
+
|
|
908
|
+
async function run() {
|
|
909
|
+
const result = await unifiedTo.category.updateTicketingCategory({
|
|
910
|
+
ticketingCategory: {},
|
|
911
|
+
connectionId: "<id>",
|
|
912
|
+
id: "<id>",
|
|
913
|
+
});
|
|
914
|
+
|
|
915
|
+
console.log(result);
|
|
916
|
+
}
|
|
917
|
+
|
|
918
|
+
run();
|
|
919
|
+
```
|
|
920
|
+
|
|
921
|
+
### Standalone function
|
|
922
|
+
|
|
923
|
+
The standalone function version of this method:
|
|
924
|
+
|
|
925
|
+
```typescript
|
|
926
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
927
|
+
import { categoryUpdateTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryUpdateTicketingCategory.js";
|
|
928
|
+
|
|
929
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
930
|
+
// You can create one instance of it to use across an application.
|
|
931
|
+
const unifiedTo = new UnifiedToCore({
|
|
932
|
+
security: {
|
|
933
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
934
|
+
},
|
|
935
|
+
});
|
|
936
|
+
|
|
937
|
+
async function run() {
|
|
938
|
+
const res = await categoryUpdateTicketingCategory(unifiedTo, {
|
|
939
|
+
ticketingCategory: {},
|
|
940
|
+
connectionId: "<id>",
|
|
941
|
+
id: "<id>",
|
|
942
|
+
});
|
|
943
|
+
if (res.ok) {
|
|
944
|
+
const { value: result } = res;
|
|
945
|
+
console.log(result);
|
|
946
|
+
} else {
|
|
947
|
+
console.log("categoryUpdateTicketingCategory failed:", res.error);
|
|
948
|
+
}
|
|
949
|
+
}
|
|
950
|
+
|
|
951
|
+
run();
|
|
952
|
+
```
|
|
953
|
+
|
|
954
|
+
### Parameters
|
|
955
|
+
|
|
956
|
+
| Parameter | Type | Required | Description |
|
|
957
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
958
|
+
| `request` | [operations.UpdateTicketingCategoryRequest](../../sdk/models/operations/updateticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
959
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
960
|
+
| `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. |
|
|
961
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
962
|
+
|
|
963
|
+
### Response
|
|
964
|
+
|
|
965
|
+
**Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
|
|
966
|
+
|
|
967
|
+
### Errors
|
|
968
|
+
|
|
487
969
|
| Error Type | Status Code | Content Type |
|
|
488
970
|
| --------------- | --------------- | --------------- |
|
|
489
971
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Embedding
|
|
2
|
+
(*embedding*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createGenaiEmbedding](#creategenaiembedding) - Create an embedding
|
|
9
|
+
|
|
10
|
+
## createGenaiEmbedding
|
|
11
|
+
|
|
12
|
+
Create an embedding
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="createGenaiEmbedding" method="post" path="/genai/{connection_id}/embedding" -->
|
|
17
|
+
```typescript
|
|
18
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
19
|
+
|
|
20
|
+
const unifiedTo = new UnifiedTo({
|
|
21
|
+
security: {
|
|
22
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
23
|
+
},
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
async function run() {
|
|
27
|
+
const result = await unifiedTo.embedding.createGenaiEmbedding({
|
|
28
|
+
genaiEmbedding: {},
|
|
29
|
+
connectionId: "<id>",
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
console.log(result);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
run();
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Standalone function
|
|
39
|
+
|
|
40
|
+
The standalone function version of this method:
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
44
|
+
import { genaiCreateGenaiEmbedding } from "@unified-api/typescript-sdk/funcs/genaiCreateGenaiEmbedding.js";
|
|
45
|
+
|
|
46
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
47
|
+
// You can create one instance of it to use across an application.
|
|
48
|
+
const unifiedTo = new UnifiedToCore({
|
|
49
|
+
security: {
|
|
50
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
51
|
+
},
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
async function run() {
|
|
55
|
+
const res = await genaiCreateGenaiEmbedding(unifiedTo, {
|
|
56
|
+
genaiEmbedding: {},
|
|
57
|
+
connectionId: "<id>",
|
|
58
|
+
});
|
|
59
|
+
if (res.ok) {
|
|
60
|
+
const { value: result } = res;
|
|
61
|
+
console.log(result);
|
|
62
|
+
} else {
|
|
63
|
+
console.log("genaiCreateGenaiEmbedding failed:", res.error);
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
run();
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Parameters
|
|
71
|
+
|
|
72
|
+
| Parameter | Type | Required | Description |
|
|
73
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
74
|
+
| `request` | [operations.CreateGenaiEmbeddingRequest](../../sdk/models/operations/creategenaiembeddingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
75
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
76
|
+
| `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. |
|
|
77
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
78
|
+
|
|
79
|
+
### Response
|
|
80
|
+
|
|
81
|
+
**Promise\<[shared.GenaiEmbedding](../../sdk/models/shared/genaiembedding.md)\>**
|
|
82
|
+
|
|
83
|
+
### Errors
|
|
84
|
+
|
|
85
|
+
| Error Type | Status Code | Content Type |
|
|
86
|
+
| --------------- | --------------- | --------------- |
|
|
87
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|