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