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