@unified-api/typescript-sdk 2.9.4 → 2.9.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/FUNCTIONS.md +108 -0
  2. package/README.md +36 -15
  3. package/RUNTIMES.md +22 -0
  4. package/docs/sdks/account/README.md +501 -0
  5. package/docs/sdks/accounting/README.md +3629 -0
  6. package/docs/sdks/activity/README.md +501 -0
  7. package/docs/sdks/apicall/README.md +165 -0
  8. package/docs/sdks/application/README.md +501 -0
  9. package/docs/sdks/applicationstatus/README.md +88 -0
  10. package/docs/sdks/ats/README.md +3710 -0
  11. package/docs/sdks/auth/README.md +173 -0
  12. package/docs/sdks/branch/README.md +501 -0
  13. package/docs/sdks/call/README.md +88 -0
  14. package/docs/sdks/candidate/README.md +501 -0
  15. package/docs/sdks/channel/README.md +171 -0
  16. package/docs/sdks/class/README.md +501 -0
  17. package/docs/sdks/collection/README.md +501 -0
  18. package/docs/sdks/commerce/README.md +2477 -0
  19. package/docs/sdks/commit/README.md +501 -0
  20. package/docs/sdks/company/README.md +1240 -0
  21. package/docs/sdks/connection/README.md +485 -0
  22. package/docs/sdks/contact/README.md +1489 -0
  23. package/docs/sdks/course/README.md +501 -0
  24. package/docs/sdks/crm/README.md +2971 -0
  25. package/docs/sdks/customer/README.md +501 -0
  26. package/docs/sdks/deal/README.md +501 -0
  27. package/docs/sdks/document/README.md +501 -0
  28. package/docs/sdks/employee/README.md +501 -0
  29. package/docs/sdks/enrich/README.md +169 -0
  30. package/docs/sdks/event/README.md +501 -0
  31. package/docs/sdks/file/README.md +501 -0
  32. package/docs/sdks/genai/README.md +169 -0
  33. package/docs/sdks/group/README.md +995 -0
  34. package/docs/sdks/hris/README.md +2311 -0
  35. package/docs/sdks/instructor/README.md +501 -0
  36. package/docs/sdks/integration/README.md +248 -0
  37. package/docs/sdks/interview/README.md +501 -0
  38. package/docs/sdks/inventory/README.md +501 -0
  39. package/docs/sdks/invoice/README.md +501 -0
  40. package/docs/sdks/issue/README.md +84 -0
  41. package/docs/sdks/item/README.md +501 -0
  42. package/docs/sdks/job/README.md +501 -0
  43. package/docs/sdks/journal/README.md +501 -0
  44. package/docs/sdks/kms/README.md +995 -0
  45. package/docs/sdks/lead/README.md +501 -0
  46. package/docs/sdks/link/README.md +501 -0
  47. package/docs/sdks/list/README.md +501 -0
  48. package/docs/sdks/lms/README.md +1983 -0
  49. package/docs/sdks/location/README.md +995 -0
  50. package/docs/sdks/login/README.md +90 -0
  51. package/docs/sdks/martech/README.md +995 -0
  52. package/docs/sdks/member/README.md +501 -0
  53. package/docs/sdks/message/README.md +501 -0
  54. package/docs/sdks/messaging/README.md +665 -0
  55. package/docs/sdks/metadata/README.md +501 -0
  56. package/docs/sdks/model/README.md +88 -0
  57. package/docs/sdks/note/README.md +501 -0
  58. package/docs/sdks/order/README.md +501 -0
  59. package/docs/sdks/organization/README.md +665 -0
  60. package/docs/sdks/page/README.md +501 -0
  61. package/docs/sdks/passthrough/README.md +671 -0
  62. package/docs/sdks/payment/README.md +1323 -0
  63. package/docs/sdks/payout/README.md +171 -0
  64. package/docs/sdks/payslip/README.md +171 -0
  65. package/docs/sdks/person/README.md +88 -0
  66. package/docs/sdks/pipeline/README.md +501 -0
  67. package/docs/sdks/project/README.md +501 -0
  68. package/docs/sdks/prompt/README.md +88 -0
  69. package/docs/sdks/pullrequest/README.md +501 -0
  70. package/docs/sdks/refund/README.md +171 -0
  71. package/docs/sdks/repo/README.md +2477 -0
  72. package/docs/sdks/repository/README.md +501 -0
  73. package/docs/sdks/scim/README.md +995 -0
  74. package/docs/sdks/scorecard/README.md +501 -0
  75. package/docs/sdks/space/README.md +501 -0
  76. package/docs/sdks/storage/README.md +501 -0
  77. package/docs/sdks/student/README.md +501 -0
  78. package/docs/sdks/task/README.md +995 -0
  79. package/docs/sdks/taxrate/README.md +501 -0
  80. package/docs/sdks/ticket/README.md +501 -0
  81. package/docs/sdks/ticketing/README.md +1489 -0
  82. package/docs/sdks/timeoff/README.md +171 -0
  83. package/docs/sdks/transaction/README.md +501 -0
  84. package/docs/sdks/uc/README.md +582 -0
  85. package/docs/sdks/unified/README.md +1601 -0
  86. package/docs/sdks/unifiedto/README.md +7 -0
  87. package/docs/sdks/user/README.md +501 -0
  88. package/docs/sdks/webhook/README.md +647 -0
  89. package/lib/config.d.ts +3 -3
  90. package/lib/config.js +3 -3
  91. package/lib/primitives.d.ts +2 -0
  92. package/lib/primitives.d.ts.map +1 -1
  93. package/lib/primitives.js +53 -0
  94. package/lib/primitives.js.map +1 -1
  95. package/package.json +3 -1
  96. package/sdk/models/shared/index.d.ts +1 -0
  97. package/sdk/models/shared/index.d.ts.map +1 -1
  98. package/sdk/models/shared/index.js +1 -0
  99. package/sdk/models/shared/index.js.map +1 -1
  100. package/sdk/models/shared/kmspage.d.ts +5 -0
  101. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  102. package/sdk/models/shared/kmspage.js +7 -0
  103. package/sdk/models/shared/kmspage.js.map +1 -1
  104. package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
  105. package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
  106. package/sdk/models/shared/kmspagemetadata.js +63 -0
  107. package/sdk/models/shared/kmspagemetadata.js.map +1 -0
  108. package/sdk/models/shared/kmsspace.d.ts +2 -0
  109. package/sdk/models/shared/kmsspace.d.ts.map +1 -1
  110. package/sdk/models/shared/kmsspace.js +4 -0
  111. package/sdk/models/shared/kmsspace.js.map +1 -1
  112. package/sdk/models/shared/security.d.ts +2 -2
  113. package/sdk/models/shared/security.d.ts.map +1 -1
  114. package/sdk/models/shared/security.js +2 -2
  115. package/sdk/models/shared/security.js.map +1 -1
  116. package/sdk/types/operations.d.ts +5 -3
  117. package/sdk/types/operations.d.ts.map +1 -1
  118. package/sdk/types/operations.js +3 -0
  119. package/sdk/types/operations.js.map +1 -1
  120. package/src/lib/config.ts +3 -3
  121. package/src/lib/primitives.ts +62 -0
  122. package/src/sdk/models/shared/index.ts +1 -0
  123. package/src/sdk/models/shared/kmspage.ts +16 -0
  124. package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
  125. package/src/sdk/models/shared/kmsspace.ts +6 -0
  126. package/src/sdk/models/shared/security.ts +4 -4
  127. package/src/sdk/types/operations.ts +11 -5
@@ -0,0 +1,671 @@
1
+ # Passthrough
2
+ (*passthrough*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [createPassthroughJson](#createpassthroughjson) - Passthrough POST
9
+ * [createPassthroughRaw](#createpassthroughraw) - Passthrough POST
10
+ * [listPassthroughs](#listpassthroughs) - Passthrough GET
11
+ * [patchPassthroughJson](#patchpassthroughjson) - Passthrough PUT
12
+ * [patchPassthroughRaw](#patchpassthroughraw) - Passthrough PUT
13
+ * [removePassthrough](#removepassthrough) - Passthrough DELETE
14
+ * [updatePassthroughJson](#updatepassthroughjson) - Passthrough PUT
15
+ * [updatePassthroughRaw](#updatepassthroughraw) - Passthrough PUT
16
+
17
+ ## createPassthroughJson
18
+
19
+ Passthrough POST
20
+
21
+ ### Example Usage
22
+
23
+ ```typescript
24
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
25
+
26
+ const unifiedTo = new UnifiedTo({
27
+ security: {
28
+ jwt: "<YOUR_API_KEY_HERE>",
29
+ },
30
+ });
31
+
32
+ async function run() {
33
+ const result = await unifiedTo.passthrough.createPassthroughJson({
34
+ connectionId: "<value>",
35
+ path: "/etc/periodic",
36
+ });
37
+
38
+ // Handle the result
39
+ console.log(result);
40
+ }
41
+
42
+ run();
43
+ ```
44
+
45
+ ### Standalone function
46
+
47
+ The standalone function version of this method:
48
+
49
+ ```typescript
50
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
51
+ import { passthroughCreatePassthroughJson } from "@unified-api/typescript-sdk/funcs/passthroughCreatePassthroughJson.js";
52
+
53
+ // Use `UnifiedToCore` for best tree-shaking performance.
54
+ // You can create one instance of it to use across an application.
55
+ const unifiedTo = new UnifiedToCore({
56
+ security: {
57
+ jwt: "<YOUR_API_KEY_HERE>",
58
+ },
59
+ });
60
+
61
+ async function run() {
62
+ const res = await passthroughCreatePassthroughJson(unifiedTo, {
63
+ connectionId: "<value>",
64
+ path: "/etc/periodic",
65
+ });
66
+
67
+ if (!res.ok) {
68
+ throw res.error;
69
+ }
70
+
71
+ const { value: result } = res;
72
+
73
+ // Handle the result
74
+ console.log(result);
75
+ }
76
+
77
+ run();
78
+ ```
79
+
80
+ ### Parameters
81
+
82
+ | Parameter | Type | Required | Description |
83
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
84
+ | `request` | [operations.CreatePassthroughJsonRequest](../../sdk/models/operations/createpassthroughjsonrequest.md) | :heavy_check_mark: | The request object to use for the request. |
85
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
86
+ | `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. |
87
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
88
+
89
+ ### Response
90
+
91
+ **Promise\<[operations.CreatePassthroughJsonResponse](../../sdk/models/operations/createpassthroughjsonresponse.md)\>**
92
+
93
+ ### Errors
94
+
95
+ | Error Type | Status Code | Content Type |
96
+ | --------------- | --------------- | --------------- |
97
+ | errors.SDKError | 4XX, 5XX | \*/\* |
98
+
99
+ ## createPassthroughRaw
100
+
101
+ Passthrough POST
102
+
103
+ ### Example Usage
104
+
105
+ ```typescript
106
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
107
+
108
+ const unifiedTo = new UnifiedTo({
109
+ security: {
110
+ jwt: "<YOUR_API_KEY_HERE>",
111
+ },
112
+ });
113
+
114
+ async function run() {
115
+ const result = await unifiedTo.passthrough.createPassthroughRaw({
116
+ connectionId: "<value>",
117
+ path: "/etc/periodic",
118
+ });
119
+
120
+ // Handle the result
121
+ console.log(result);
122
+ }
123
+
124
+ run();
125
+ ```
126
+
127
+ ### Standalone function
128
+
129
+ The standalone function version of this method:
130
+
131
+ ```typescript
132
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
133
+ import { passthroughCreatePassthroughRaw } from "@unified-api/typescript-sdk/funcs/passthroughCreatePassthroughRaw.js";
134
+
135
+ // Use `UnifiedToCore` for best tree-shaking performance.
136
+ // You can create one instance of it to use across an application.
137
+ const unifiedTo = new UnifiedToCore({
138
+ security: {
139
+ jwt: "<YOUR_API_KEY_HERE>",
140
+ },
141
+ });
142
+
143
+ async function run() {
144
+ const res = await passthroughCreatePassthroughRaw(unifiedTo, {
145
+ connectionId: "<value>",
146
+ path: "/etc/periodic",
147
+ });
148
+
149
+ if (!res.ok) {
150
+ throw res.error;
151
+ }
152
+
153
+ const { value: result } = res;
154
+
155
+ // Handle the result
156
+ console.log(result);
157
+ }
158
+
159
+ run();
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ | Parameter | Type | Required | Description |
165
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
166
+ | `request` | [operations.CreatePassthroughRawRequest](../../sdk/models/operations/createpassthroughrawrequest.md) | :heavy_check_mark: | The request object to use for the request. |
167
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
168
+ | `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. |
169
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
170
+
171
+ ### Response
172
+
173
+ **Promise\<[operations.CreatePassthroughRawResponse](../../sdk/models/operations/createpassthroughrawresponse.md)\>**
174
+
175
+ ### Errors
176
+
177
+ | Error Type | Status Code | Content Type |
178
+ | --------------- | --------------- | --------------- |
179
+ | errors.SDKError | 4XX, 5XX | \*/\* |
180
+
181
+ ## listPassthroughs
182
+
183
+ Passthrough GET
184
+
185
+ ### Example Usage
186
+
187
+ ```typescript
188
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
189
+
190
+ const unifiedTo = new UnifiedTo({
191
+ security: {
192
+ jwt: "<YOUR_API_KEY_HERE>",
193
+ },
194
+ });
195
+
196
+ async function run() {
197
+ const result = await unifiedTo.passthrough.listPassthroughs({
198
+ connectionId: "<value>",
199
+ path: "/selinux",
200
+ });
201
+
202
+ // Handle the result
203
+ console.log(result);
204
+ }
205
+
206
+ run();
207
+ ```
208
+
209
+ ### Standalone function
210
+
211
+ The standalone function version of this method:
212
+
213
+ ```typescript
214
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
215
+ import { passthroughListPassthroughs } from "@unified-api/typescript-sdk/funcs/passthroughListPassthroughs.js";
216
+
217
+ // Use `UnifiedToCore` for best tree-shaking performance.
218
+ // You can create one instance of it to use across an application.
219
+ const unifiedTo = new UnifiedToCore({
220
+ security: {
221
+ jwt: "<YOUR_API_KEY_HERE>",
222
+ },
223
+ });
224
+
225
+ async function run() {
226
+ const res = await passthroughListPassthroughs(unifiedTo, {
227
+ connectionId: "<value>",
228
+ path: "/selinux",
229
+ });
230
+
231
+ if (!res.ok) {
232
+ throw res.error;
233
+ }
234
+
235
+ const { value: result } = res;
236
+
237
+ // Handle the result
238
+ console.log(result);
239
+ }
240
+
241
+ run();
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ | Parameter | Type | Required | Description |
247
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
248
+ | `request` | [operations.ListPassthroughsRequest](../../sdk/models/operations/listpassthroughsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
249
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
250
+ | `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. |
251
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
252
+
253
+ ### Response
254
+
255
+ **Promise\<[operations.ListPassthroughsResponse](../../sdk/models/operations/listpassthroughsresponse.md)\>**
256
+
257
+ ### Errors
258
+
259
+ | Error Type | Status Code | Content Type |
260
+ | --------------- | --------------- | --------------- |
261
+ | errors.SDKError | 4XX, 5XX | \*/\* |
262
+
263
+ ## patchPassthroughJson
264
+
265
+ Passthrough PUT
266
+
267
+ ### Example Usage
268
+
269
+ ```typescript
270
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
271
+
272
+ const unifiedTo = new UnifiedTo({
273
+ security: {
274
+ jwt: "<YOUR_API_KEY_HERE>",
275
+ },
276
+ });
277
+
278
+ async function run() {
279
+ const result = await unifiedTo.passthrough.patchPassthroughJson({
280
+ connectionId: "<value>",
281
+ path: "/mnt",
282
+ });
283
+
284
+ // Handle the result
285
+ console.log(result);
286
+ }
287
+
288
+ run();
289
+ ```
290
+
291
+ ### Standalone function
292
+
293
+ The standalone function version of this method:
294
+
295
+ ```typescript
296
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
297
+ import { passthroughPatchPassthroughJson } from "@unified-api/typescript-sdk/funcs/passthroughPatchPassthroughJson.js";
298
+
299
+ // Use `UnifiedToCore` for best tree-shaking performance.
300
+ // You can create one instance of it to use across an application.
301
+ const unifiedTo = new UnifiedToCore({
302
+ security: {
303
+ jwt: "<YOUR_API_KEY_HERE>",
304
+ },
305
+ });
306
+
307
+ async function run() {
308
+ const res = await passthroughPatchPassthroughJson(unifiedTo, {
309
+ connectionId: "<value>",
310
+ path: "/mnt",
311
+ });
312
+
313
+ if (!res.ok) {
314
+ throw res.error;
315
+ }
316
+
317
+ const { value: result } = res;
318
+
319
+ // Handle the result
320
+ console.log(result);
321
+ }
322
+
323
+ run();
324
+ ```
325
+
326
+ ### Parameters
327
+
328
+ | Parameter | Type | Required | Description |
329
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
330
+ | `request` | [operations.PatchPassthroughJsonRequest](../../sdk/models/operations/patchpassthroughjsonrequest.md) | :heavy_check_mark: | The request object to use for the request. |
331
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
332
+ | `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. |
333
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
334
+
335
+ ### Response
336
+
337
+ **Promise\<[operations.PatchPassthroughJsonResponse](../../sdk/models/operations/patchpassthroughjsonresponse.md)\>**
338
+
339
+ ### Errors
340
+
341
+ | Error Type | Status Code | Content Type |
342
+ | --------------- | --------------- | --------------- |
343
+ | errors.SDKError | 4XX, 5XX | \*/\* |
344
+
345
+ ## patchPassthroughRaw
346
+
347
+ Passthrough PUT
348
+
349
+ ### Example Usage
350
+
351
+ ```typescript
352
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
353
+
354
+ const unifiedTo = new UnifiedTo({
355
+ security: {
356
+ jwt: "<YOUR_API_KEY_HERE>",
357
+ },
358
+ });
359
+
360
+ async function run() {
361
+ const result = await unifiedTo.passthrough.patchPassthroughRaw({
362
+ connectionId: "<value>",
363
+ path: "/mnt",
364
+ });
365
+
366
+ // Handle the result
367
+ console.log(result);
368
+ }
369
+
370
+ run();
371
+ ```
372
+
373
+ ### Standalone function
374
+
375
+ The standalone function version of this method:
376
+
377
+ ```typescript
378
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
379
+ import { passthroughPatchPassthroughRaw } from "@unified-api/typescript-sdk/funcs/passthroughPatchPassthroughRaw.js";
380
+
381
+ // Use `UnifiedToCore` for best tree-shaking performance.
382
+ // You can create one instance of it to use across an application.
383
+ const unifiedTo = new UnifiedToCore({
384
+ security: {
385
+ jwt: "<YOUR_API_KEY_HERE>",
386
+ },
387
+ });
388
+
389
+ async function run() {
390
+ const res = await passthroughPatchPassthroughRaw(unifiedTo, {
391
+ connectionId: "<value>",
392
+ path: "/mnt",
393
+ });
394
+
395
+ if (!res.ok) {
396
+ throw res.error;
397
+ }
398
+
399
+ const { value: result } = res;
400
+
401
+ // Handle the result
402
+ console.log(result);
403
+ }
404
+
405
+ run();
406
+ ```
407
+
408
+ ### Parameters
409
+
410
+ | Parameter | Type | Required | Description |
411
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
412
+ | `request` | [operations.PatchPassthroughRawRequest](../../sdk/models/operations/patchpassthroughrawrequest.md) | :heavy_check_mark: | The request object to use for the request. |
413
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
414
+ | `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. |
415
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
416
+
417
+ ### Response
418
+
419
+ **Promise\<[operations.PatchPassthroughRawResponse](../../sdk/models/operations/patchpassthroughrawresponse.md)\>**
420
+
421
+ ### Errors
422
+
423
+ | Error Type | Status Code | Content Type |
424
+ | --------------- | --------------- | --------------- |
425
+ | errors.SDKError | 4XX, 5XX | \*/\* |
426
+
427
+ ## removePassthrough
428
+
429
+ Passthrough DELETE
430
+
431
+ ### Example Usage
432
+
433
+ ```typescript
434
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
435
+
436
+ const unifiedTo = new UnifiedTo({
437
+ security: {
438
+ jwt: "<YOUR_API_KEY_HERE>",
439
+ },
440
+ });
441
+
442
+ async function run() {
443
+ const result = await unifiedTo.passthrough.removePassthrough({
444
+ connectionId: "<value>",
445
+ path: "/Applications",
446
+ });
447
+
448
+ // Handle the result
449
+ console.log(result);
450
+ }
451
+
452
+ run();
453
+ ```
454
+
455
+ ### Standalone function
456
+
457
+ The standalone function version of this method:
458
+
459
+ ```typescript
460
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
461
+ import { passthroughRemovePassthrough } from "@unified-api/typescript-sdk/funcs/passthroughRemovePassthrough.js";
462
+
463
+ // Use `UnifiedToCore` for best tree-shaking performance.
464
+ // You can create one instance of it to use across an application.
465
+ const unifiedTo = new UnifiedToCore({
466
+ security: {
467
+ jwt: "<YOUR_API_KEY_HERE>",
468
+ },
469
+ });
470
+
471
+ async function run() {
472
+ const res = await passthroughRemovePassthrough(unifiedTo, {
473
+ connectionId: "<value>",
474
+ path: "/Applications",
475
+ });
476
+
477
+ if (!res.ok) {
478
+ throw res.error;
479
+ }
480
+
481
+ const { value: result } = res;
482
+
483
+ // Handle the result
484
+ console.log(result);
485
+ }
486
+
487
+ run();
488
+ ```
489
+
490
+ ### Parameters
491
+
492
+ | Parameter | Type | Required | Description |
493
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
494
+ | `request` | [operations.RemovePassthroughRequest](../../sdk/models/operations/removepassthroughrequest.md) | :heavy_check_mark: | The request object to use for the request. |
495
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
496
+ | `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. |
497
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
498
+
499
+ ### Response
500
+
501
+ **Promise\<[operations.RemovePassthroughResponse](../../sdk/models/operations/removepassthroughresponse.md)\>**
502
+
503
+ ### Errors
504
+
505
+ | Error Type | Status Code | Content Type |
506
+ | --------------- | --------------- | --------------- |
507
+ | errors.SDKError | 4XX, 5XX | \*/\* |
508
+
509
+ ## updatePassthroughJson
510
+
511
+ Passthrough PUT
512
+
513
+ ### Example Usage
514
+
515
+ ```typescript
516
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
517
+
518
+ const unifiedTo = new UnifiedTo({
519
+ security: {
520
+ jwt: "<YOUR_API_KEY_HERE>",
521
+ },
522
+ });
523
+
524
+ async function run() {
525
+ const result = await unifiedTo.passthrough.updatePassthroughJson({
526
+ connectionId: "<value>",
527
+ path: "/dev",
528
+ });
529
+
530
+ // Handle the result
531
+ console.log(result);
532
+ }
533
+
534
+ run();
535
+ ```
536
+
537
+ ### Standalone function
538
+
539
+ The standalone function version of this method:
540
+
541
+ ```typescript
542
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
543
+ import { passthroughUpdatePassthroughJson } from "@unified-api/typescript-sdk/funcs/passthroughUpdatePassthroughJson.js";
544
+
545
+ // Use `UnifiedToCore` for best tree-shaking performance.
546
+ // You can create one instance of it to use across an application.
547
+ const unifiedTo = new UnifiedToCore({
548
+ security: {
549
+ jwt: "<YOUR_API_KEY_HERE>",
550
+ },
551
+ });
552
+
553
+ async function run() {
554
+ const res = await passthroughUpdatePassthroughJson(unifiedTo, {
555
+ connectionId: "<value>",
556
+ path: "/dev",
557
+ });
558
+
559
+ if (!res.ok) {
560
+ throw res.error;
561
+ }
562
+
563
+ const { value: result } = res;
564
+
565
+ // Handle the result
566
+ console.log(result);
567
+ }
568
+
569
+ run();
570
+ ```
571
+
572
+ ### Parameters
573
+
574
+ | Parameter | Type | Required | Description |
575
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
576
+ | `request` | [operations.UpdatePassthroughJsonRequest](../../sdk/models/operations/updatepassthroughjsonrequest.md) | :heavy_check_mark: | The request object to use for the request. |
577
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
578
+ | `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. |
579
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
580
+
581
+ ### Response
582
+
583
+ **Promise\<[operations.UpdatePassthroughJsonResponse](../../sdk/models/operations/updatepassthroughjsonresponse.md)\>**
584
+
585
+ ### Errors
586
+
587
+ | Error Type | Status Code | Content Type |
588
+ | --------------- | --------------- | --------------- |
589
+ | errors.SDKError | 4XX, 5XX | \*/\* |
590
+
591
+ ## updatePassthroughRaw
592
+
593
+ Passthrough PUT
594
+
595
+ ### Example Usage
596
+
597
+ ```typescript
598
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
599
+
600
+ const unifiedTo = new UnifiedTo({
601
+ security: {
602
+ jwt: "<YOUR_API_KEY_HERE>",
603
+ },
604
+ });
605
+
606
+ async function run() {
607
+ const result = await unifiedTo.passthrough.updatePassthroughRaw({
608
+ connectionId: "<value>",
609
+ path: "/dev",
610
+ });
611
+
612
+ // Handle the result
613
+ console.log(result);
614
+ }
615
+
616
+ run();
617
+ ```
618
+
619
+ ### Standalone function
620
+
621
+ The standalone function version of this method:
622
+
623
+ ```typescript
624
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
625
+ import { passthroughUpdatePassthroughRaw } from "@unified-api/typescript-sdk/funcs/passthroughUpdatePassthroughRaw.js";
626
+
627
+ // Use `UnifiedToCore` for best tree-shaking performance.
628
+ // You can create one instance of it to use across an application.
629
+ const unifiedTo = new UnifiedToCore({
630
+ security: {
631
+ jwt: "<YOUR_API_KEY_HERE>",
632
+ },
633
+ });
634
+
635
+ async function run() {
636
+ const res = await passthroughUpdatePassthroughRaw(unifiedTo, {
637
+ connectionId: "<value>",
638
+ path: "/dev",
639
+ });
640
+
641
+ if (!res.ok) {
642
+ throw res.error;
643
+ }
644
+
645
+ const { value: result } = res;
646
+
647
+ // Handle the result
648
+ console.log(result);
649
+ }
650
+
651
+ run();
652
+ ```
653
+
654
+ ### Parameters
655
+
656
+ | Parameter | Type | Required | Description |
657
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
658
+ | `request` | [operations.UpdatePassthroughRawRequest](../../sdk/models/operations/updatepassthroughrawrequest.md) | :heavy_check_mark: | The request object to use for the request. |
659
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
660
+ | `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. |
661
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
662
+
663
+ ### Response
664
+
665
+ **Promise\<[operations.UpdatePassthroughRawResponse](../../sdk/models/operations/updatepassthroughrawresponse.md)\>**
666
+
667
+ ### Errors
668
+
669
+ | Error Type | Status Code | Content Type |
670
+ | --------------- | --------------- | --------------- |
671
+ | errors.SDKError | 4XX, 5XX | \*/\* |