@unified-api/typescript-sdk 2.80.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.
Files changed (120) hide show
  1. package/examples/package-lock.json +1 -1
  2. package/jsr.json +1 -1
  3. package/lib/config.d.ts +3 -3
  4. package/lib/config.js +3 -3
  5. package/package.json +1 -1
  6. package/sdk/models/shared/kmspage.d.ts +2 -0
  7. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  8. package/sdk/models/shared/kmspage.js +4 -0
  9. package/sdk/models/shared/kmspage.js.map +1 -1
  10. package/src/lib/config.ts +3 -3
  11. package/src/sdk/models/shared/kmspage.ts +6 -0
  12. package/docs/sdks/account/README.md +0 -489
  13. package/docs/sdks/accounting/README.md +0 -7221
  14. package/docs/sdks/activity/README.md +0 -489
  15. package/docs/sdks/apicall/README.md +0 -159
  16. package/docs/sdks/application/README.md +0 -489
  17. package/docs/sdks/applicationstatus/README.md +0 -85
  18. package/docs/sdks/ats/README.md +0 -3953
  19. package/docs/sdks/auth/README.md +0 -167
  20. package/docs/sdks/balancesheet/README.md +0 -165
  21. package/docs/sdks/bill/README.md +0 -489
  22. package/docs/sdks/branch/README.md +0 -507
  23. package/docs/sdks/busy/README.md +0 -85
  24. package/docs/sdks/calendar/README.md +0 -1713
  25. package/docs/sdks/call/README.md +0 -85
  26. package/docs/sdks/candidate/README.md +0 -489
  27. package/docs/sdks/cashflow/README.md +0 -165
  28. package/docs/sdks/category/README.md +0 -971
  29. package/docs/sdks/change/README.md +0 -165
  30. package/docs/sdks/channel/README.md +0 -165
  31. package/docs/sdks/class/README.md +0 -507
  32. package/docs/sdks/collection/README.md +0 -501
  33. package/docs/sdks/comment/README.md +0 -1495
  34. package/docs/sdks/commerce/README.md +0 -2465
  35. package/docs/sdks/commit/README.md +0 -501
  36. package/docs/sdks/company/README.md +0 -1543
  37. package/docs/sdks/connection/README.md +0 -513
  38. package/docs/sdks/contact/README.md +0 -1453
  39. package/docs/sdks/course/README.md +0 -501
  40. package/docs/sdks/creditmemo/README.md +0 -489
  41. package/docs/sdks/crm/README.md +0 -2899
  42. package/docs/sdks/customer/README.md +0 -489
  43. package/docs/sdks/deal/README.md +0 -489
  44. package/docs/sdks/device/README.md +0 -501
  45. package/docs/sdks/document/README.md +0 -489
  46. package/docs/sdks/embedding/README.md +0 -87
  47. package/docs/sdks/employee/README.md +0 -489
  48. package/docs/sdks/enrich/README.md +0 -163
  49. package/docs/sdks/event/README.md +0 -971
  50. package/docs/sdks/expense/README.md +0 -489
  51. package/docs/sdks/file/README.md +0 -489
  52. package/docs/sdks/genai/README.md +0 -325
  53. package/docs/sdks/group/README.md +0 -983
  54. package/docs/sdks/hris/README.md +0 -3251
  55. package/docs/sdks/instructor/README.md +0 -489
  56. package/docs/sdks/integration/README.md +0 -239
  57. package/docs/sdks/interview/README.md +0 -489
  58. package/docs/sdks/inventory/README.md +0 -501
  59. package/docs/sdks/invoice/README.md +0 -489
  60. package/docs/sdks/issue/README.md +0 -159
  61. package/docs/sdks/item/README.md +0 -489
  62. package/docs/sdks/job/README.md +0 -489
  63. package/docs/sdks/journal/README.md +0 -489
  64. package/docs/sdks/kms/README.md +0 -1495
  65. package/docs/sdks/lead/README.md +0 -489
  66. package/docs/sdks/link/README.md +0 -983
  67. package/docs/sdks/list/README.md +0 -489
  68. package/docs/sdks/lms/README.md +0 -1965
  69. package/docs/sdks/location/README.md +0 -983
  70. package/docs/sdks/login/README.md +0 -87
  71. package/docs/sdks/martech/README.md +0 -971
  72. package/docs/sdks/member/README.md +0 -489
  73. package/docs/sdks/message/README.md +0 -489
  74. package/docs/sdks/messaging/README.md +0 -647
  75. package/docs/sdks/metadata/README.md +0 -507
  76. package/docs/sdks/model/README.md +0 -165
  77. package/docs/sdks/note/README.md +0 -489
  78. package/docs/sdks/order/README.md +0 -489
  79. package/docs/sdks/organization/README.md +0 -647
  80. package/docs/sdks/package/README.md +0 -165
  81. package/docs/sdks/page/README.md +0 -507
  82. package/docs/sdks/passthrough/README.md +0 -647
  83. package/docs/sdks/payment/README.md +0 -1769
  84. package/docs/sdks/payout/README.md +0 -165
  85. package/docs/sdks/payslip/README.md +0 -165
  86. package/docs/sdks/person/README.md +0 -85
  87. package/docs/sdks/pipeline/README.md +0 -489
  88. package/docs/sdks/profitloss/README.md +0 -165
  89. package/docs/sdks/project/README.md +0 -489
  90. package/docs/sdks/prompt/README.md +0 -87
  91. package/docs/sdks/pullrequest/README.md +0 -489
  92. package/docs/sdks/purchaseorder/README.md +0 -489
  93. package/docs/sdks/recording/README.md +0 -647
  94. package/docs/sdks/refund/README.md +0 -165
  95. package/docs/sdks/repo/README.md +0 -2459
  96. package/docs/sdks/report/README.md +0 -165
  97. package/docs/sdks/repository/README.md +0 -501
  98. package/docs/sdks/request/README.md +0 -489
  99. package/docs/sdks/review/README.md +0 -501
  100. package/docs/sdks/salesorder/README.md +0 -489
  101. package/docs/sdks/scim/README.md +0 -983
  102. package/docs/sdks/scorecard/README.md +0 -489
  103. package/docs/sdks/space/README.md +0 -501
  104. package/docs/sdks/storage/README.md +0 -489
  105. package/docs/sdks/student/README.md +0 -489
  106. package/docs/sdks/subscription/README.md +0 -489
  107. package/docs/sdks/task/README.md +0 -1629
  108. package/docs/sdks/taxrate/README.md +0 -489
  109. package/docs/sdks/ticket/README.md +0 -489
  110. package/docs/sdks/ticketing/README.md +0 -1935
  111. package/docs/sdks/timeoff/README.md +0 -165
  112. package/docs/sdks/timeshift/README.md +0 -513
  113. package/docs/sdks/transaction/README.md +0 -489
  114. package/docs/sdks/trialbalance/README.md +0 -165
  115. package/docs/sdks/uc/README.md +0 -1543
  116. package/docs/sdks/unified/README.md +0 -1697
  117. package/docs/sdks/user/README.md +0 -489
  118. package/docs/sdks/verification/README.md +0 -647
  119. package/docs/sdks/webhook/README.md +0 -655
  120. package/examples/README.md +0 -31
@@ -1,507 +0,0 @@
1
- # Branch
2
- (*branch*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createRepoBranch](#createrepobranch) - Create a branch
9
- * [getRepoBranch](#getrepobranch) - Retrieve a branch
10
- * [listRepoBranches](#listrepobranches) - List all branches
11
- * [patchRepoBranch](#patchrepobranch) - Update a branch
12
- * [removeRepoBranch](#removerepobranch) - Remove a branch
13
- * [updateRepoBranch](#updaterepobranch) - Update a branch
14
-
15
- ## createRepoBranch
16
-
17
- Create a branch
18
-
19
- ### Example Usage
20
-
21
- <!-- UsageSnippet language="typescript" operationID="createRepoBranch" method="post" path="/repo/{connection_id}/branch" -->
22
- ```typescript
23
- import { UnifiedTo } from "@unified-api/typescript-sdk";
24
-
25
- const unifiedTo = new UnifiedTo({
26
- security: {
27
- jwt: "<YOUR_API_KEY_HERE>",
28
- },
29
- });
30
-
31
- async function run() {
32
- const result = await unifiedTo.branch.createRepoBranch({
33
- repoBranch: {
34
- name: "<value>",
35
- repoId: "<id>",
36
- },
37
- connectionId: "<id>",
38
- });
39
-
40
- console.log(result);
41
- }
42
-
43
- run();
44
- ```
45
-
46
- ### Standalone function
47
-
48
- The standalone function version of this method:
49
-
50
- ```typescript
51
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
52
- import { repoCreateRepoBranch } from "@unified-api/typescript-sdk/funcs/repoCreateRepoBranch.js";
53
-
54
- // Use `UnifiedToCore` for best tree-shaking performance.
55
- // You can create one instance of it to use across an application.
56
- const unifiedTo = new UnifiedToCore({
57
- security: {
58
- jwt: "<YOUR_API_KEY_HERE>",
59
- },
60
- });
61
-
62
- async function run() {
63
- const res = await repoCreateRepoBranch(unifiedTo, {
64
- repoBranch: {
65
- name: "<value>",
66
- repoId: "<id>",
67
- },
68
- connectionId: "<id>",
69
- });
70
- if (res.ok) {
71
- const { value: result } = res;
72
- console.log(result);
73
- } else {
74
- console.log("repoCreateRepoBranch failed:", res.error);
75
- }
76
- }
77
-
78
- run();
79
- ```
80
-
81
- ### Parameters
82
-
83
- | Parameter | Type | Required | Description |
84
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
85
- | `request` | [operations.CreateRepoBranchRequest](../../sdk/models/operations/createrepobranchrequest.md) | :heavy_check_mark: | The request object to use for the request. |
86
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
87
- | `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. |
88
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
89
-
90
- ### Response
91
-
92
- **Promise\<[shared.RepoBranch](../../sdk/models/shared/repobranch.md)\>**
93
-
94
- ### Errors
95
-
96
- | Error Type | Status Code | Content Type |
97
- | --------------- | --------------- | --------------- |
98
- | errors.SDKError | 4XX, 5XX | \*/\* |
99
-
100
- ## getRepoBranch
101
-
102
- Retrieve a branch
103
-
104
- ### Example Usage
105
-
106
- <!-- UsageSnippet language="typescript" operationID="getRepoBranch" method="get" path="/repo/{connection_id}/branch/{id}" -->
107
- ```typescript
108
- import { UnifiedTo } from "@unified-api/typescript-sdk";
109
-
110
- const unifiedTo = new UnifiedTo({
111
- security: {
112
- jwt: "<YOUR_API_KEY_HERE>",
113
- },
114
- });
115
-
116
- async function run() {
117
- const result = await unifiedTo.branch.getRepoBranch({
118
- connectionId: "<id>",
119
- id: "<id>",
120
- });
121
-
122
- console.log(result);
123
- }
124
-
125
- run();
126
- ```
127
-
128
- ### Standalone function
129
-
130
- The standalone function version of this method:
131
-
132
- ```typescript
133
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
134
- import { repoGetRepoBranch } from "@unified-api/typescript-sdk/funcs/repoGetRepoBranch.js";
135
-
136
- // Use `UnifiedToCore` for best tree-shaking performance.
137
- // You can create one instance of it to use across an application.
138
- const unifiedTo = new UnifiedToCore({
139
- security: {
140
- jwt: "<YOUR_API_KEY_HERE>",
141
- },
142
- });
143
-
144
- async function run() {
145
- const res = await repoGetRepoBranch(unifiedTo, {
146
- connectionId: "<id>",
147
- id: "<id>",
148
- });
149
- if (res.ok) {
150
- const { value: result } = res;
151
- console.log(result);
152
- } else {
153
- console.log("repoGetRepoBranch failed:", res.error);
154
- }
155
- }
156
-
157
- run();
158
- ```
159
-
160
- ### Parameters
161
-
162
- | Parameter | Type | Required | Description |
163
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
164
- | `request` | [operations.GetRepoBranchRequest](../../sdk/models/operations/getrepobranchrequest.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.RepoBranch](../../sdk/models/shared/repobranch.md)\>**
172
-
173
- ### Errors
174
-
175
- | Error Type | Status Code | Content Type |
176
- | --------------- | --------------- | --------------- |
177
- | errors.SDKError | 4XX, 5XX | \*/\* |
178
-
179
- ## listRepoBranches
180
-
181
- List all branches
182
-
183
- ### Example Usage
184
-
185
- <!-- UsageSnippet language="typescript" operationID="listRepoBranches" method="get" path="/repo/{connection_id}/branch" -->
186
- ```typescript
187
- import { UnifiedTo } from "@unified-api/typescript-sdk";
188
-
189
- const unifiedTo = new UnifiedTo({
190
- security: {
191
- jwt: "<YOUR_API_KEY_HERE>",
192
- },
193
- });
194
-
195
- async function run() {
196
- const result = await unifiedTo.branch.listRepoBranches({
197
- connectionId: "<id>",
198
- });
199
-
200
- console.log(result);
201
- }
202
-
203
- run();
204
- ```
205
-
206
- ### Standalone function
207
-
208
- The standalone function version of this method:
209
-
210
- ```typescript
211
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
212
- import { repoListRepoBranches } from "@unified-api/typescript-sdk/funcs/repoListRepoBranches.js";
213
-
214
- // Use `UnifiedToCore` for best tree-shaking performance.
215
- // You can create one instance of it to use across an application.
216
- const unifiedTo = new UnifiedToCore({
217
- security: {
218
- jwt: "<YOUR_API_KEY_HERE>",
219
- },
220
- });
221
-
222
- async function run() {
223
- const res = await repoListRepoBranches(unifiedTo, {
224
- connectionId: "<id>",
225
- });
226
- if (res.ok) {
227
- const { value: result } = res;
228
- console.log(result);
229
- } else {
230
- console.log("repoListRepoBranches failed:", res.error);
231
- }
232
- }
233
-
234
- run();
235
- ```
236
-
237
- ### Parameters
238
-
239
- | Parameter | Type | Required | Description |
240
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
241
- | `request` | [operations.ListRepoBranchesRequest](../../sdk/models/operations/listrepobranchesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
242
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
243
- | `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. |
244
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
245
-
246
- ### Response
247
-
248
- **Promise\<[shared.RepoBranch[]](../../models/.md)\>**
249
-
250
- ### Errors
251
-
252
- | Error Type | Status Code | Content Type |
253
- | --------------- | --------------- | --------------- |
254
- | errors.SDKError | 4XX, 5XX | \*/\* |
255
-
256
- ## patchRepoBranch
257
-
258
- Update a branch
259
-
260
- ### Example Usage
261
-
262
- <!-- UsageSnippet language="typescript" operationID="patchRepoBranch" method="patch" path="/repo/{connection_id}/branch/{id}" -->
263
- ```typescript
264
- import { UnifiedTo } from "@unified-api/typescript-sdk";
265
-
266
- const unifiedTo = new UnifiedTo({
267
- security: {
268
- jwt: "<YOUR_API_KEY_HERE>",
269
- },
270
- });
271
-
272
- async function run() {
273
- const result = await unifiedTo.branch.patchRepoBranch({
274
- repoBranch: {
275
- name: "<value>",
276
- repoId: "<id>",
277
- },
278
- connectionId: "<id>",
279
- id: "<id>",
280
- });
281
-
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 { repoPatchRepoBranch } from "@unified-api/typescript-sdk/funcs/repoPatchRepoBranch.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 repoPatchRepoBranch(unifiedTo, {
306
- repoBranch: {
307
- name: "<value>",
308
- repoId: "<id>",
309
- },
310
- connectionId: "<id>",
311
- id: "<id>",
312
- });
313
- if (res.ok) {
314
- const { value: result } = res;
315
- console.log(result);
316
- } else {
317
- console.log("repoPatchRepoBranch failed:", res.error);
318
- }
319
- }
320
-
321
- run();
322
- ```
323
-
324
- ### Parameters
325
-
326
- | Parameter | Type | Required | Description |
327
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
328
- | `request` | [operations.PatchRepoBranchRequest](../../sdk/models/operations/patchrepobranchrequest.md) | :heavy_check_mark: | The request object to use for the request. |
329
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
330
- | `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. |
331
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
332
-
333
- ### Response
334
-
335
- **Promise\<[shared.RepoBranch](../../sdk/models/shared/repobranch.md)\>**
336
-
337
- ### Errors
338
-
339
- | Error Type | Status Code | Content Type |
340
- | --------------- | --------------- | --------------- |
341
- | errors.SDKError | 4XX, 5XX | \*/\* |
342
-
343
- ## removeRepoBranch
344
-
345
- Remove a branch
346
-
347
- ### Example Usage
348
-
349
- <!-- UsageSnippet language="typescript" operationID="removeRepoBranch" method="delete" path="/repo/{connection_id}/branch/{id}" -->
350
- ```typescript
351
- import { UnifiedTo } from "@unified-api/typescript-sdk";
352
-
353
- const unifiedTo = new UnifiedTo({
354
- security: {
355
- jwt: "<YOUR_API_KEY_HERE>",
356
- },
357
- });
358
-
359
- async function run() {
360
- const result = await unifiedTo.branch.removeRepoBranch({
361
- connectionId: "<id>",
362
- id: "<id>",
363
- });
364
-
365
- console.log(result);
366
- }
367
-
368
- run();
369
- ```
370
-
371
- ### Standalone function
372
-
373
- The standalone function version of this method:
374
-
375
- ```typescript
376
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
377
- import { repoRemoveRepoBranch } from "@unified-api/typescript-sdk/funcs/repoRemoveRepoBranch.js";
378
-
379
- // Use `UnifiedToCore` for best tree-shaking performance.
380
- // You can create one instance of it to use across an application.
381
- const unifiedTo = new UnifiedToCore({
382
- security: {
383
- jwt: "<YOUR_API_KEY_HERE>",
384
- },
385
- });
386
-
387
- async function run() {
388
- const res = await repoRemoveRepoBranch(unifiedTo, {
389
- connectionId: "<id>",
390
- id: "<id>",
391
- });
392
- if (res.ok) {
393
- const { value: result } = res;
394
- console.log(result);
395
- } else {
396
- console.log("repoRemoveRepoBranch failed:", res.error);
397
- }
398
- }
399
-
400
- run();
401
- ```
402
-
403
- ### Parameters
404
-
405
- | Parameter | Type | Required | Description |
406
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
407
- | `request` | [operations.RemoveRepoBranchRequest](../../sdk/models/operations/removerepobranchrequest.md) | :heavy_check_mark: | The request object to use for the request. |
408
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
409
- | `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. |
410
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
411
-
412
- ### Response
413
-
414
- **Promise\<[operations.RemoveRepoBranchResponse](../../sdk/models/operations/removerepobranchresponse.md)\>**
415
-
416
- ### Errors
417
-
418
- | Error Type | Status Code | Content Type |
419
- | --------------- | --------------- | --------------- |
420
- | errors.SDKError | 4XX, 5XX | \*/\* |
421
-
422
- ## updateRepoBranch
423
-
424
- Update a branch
425
-
426
- ### Example Usage
427
-
428
- <!-- UsageSnippet language="typescript" operationID="updateRepoBranch" method="put" path="/repo/{connection_id}/branch/{id}" -->
429
- ```typescript
430
- import { UnifiedTo } from "@unified-api/typescript-sdk";
431
-
432
- const unifiedTo = new UnifiedTo({
433
- security: {
434
- jwt: "<YOUR_API_KEY_HERE>",
435
- },
436
- });
437
-
438
- async function run() {
439
- const result = await unifiedTo.branch.updateRepoBranch({
440
- repoBranch: {
441
- name: "<value>",
442
- repoId: "<id>",
443
- },
444
- connectionId: "<id>",
445
- id: "<id>",
446
- });
447
-
448
- console.log(result);
449
- }
450
-
451
- run();
452
- ```
453
-
454
- ### Standalone function
455
-
456
- The standalone function version of this method:
457
-
458
- ```typescript
459
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
460
- import { repoUpdateRepoBranch } from "@unified-api/typescript-sdk/funcs/repoUpdateRepoBranch.js";
461
-
462
- // Use `UnifiedToCore` for best tree-shaking performance.
463
- // You can create one instance of it to use across an application.
464
- const unifiedTo = new UnifiedToCore({
465
- security: {
466
- jwt: "<YOUR_API_KEY_HERE>",
467
- },
468
- });
469
-
470
- async function run() {
471
- const res = await repoUpdateRepoBranch(unifiedTo, {
472
- repoBranch: {
473
- name: "<value>",
474
- repoId: "<id>",
475
- },
476
- connectionId: "<id>",
477
- id: "<id>",
478
- });
479
- if (res.ok) {
480
- const { value: result } = res;
481
- console.log(result);
482
- } else {
483
- console.log("repoUpdateRepoBranch failed:", res.error);
484
- }
485
- }
486
-
487
- run();
488
- ```
489
-
490
- ### Parameters
491
-
492
- | Parameter | Type | Required | Description |
493
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
494
- | `request` | [operations.UpdateRepoBranchRequest](../../sdk/models/operations/updaterepobranchrequest.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\<[shared.RepoBranch](../../sdk/models/shared/repobranch.md)\>**
502
-
503
- ### Errors
504
-
505
- | Error Type | Status Code | Content Type |
506
- | --------------- | --------------- | --------------- |
507
- | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -1,85 +0,0 @@
1
- # Busy
2
- (*busy*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [listCalendarBusies](#listcalendarbusies) - List all busies
9
-
10
- ## listCalendarBusies
11
-
12
- List all busies
13
-
14
- ### Example Usage
15
-
16
- <!-- UsageSnippet language="typescript" operationID="listCalendarBusies" method="get" path="/calendar/{connection_id}/busy" -->
17
- ```typescript
18
- import { UnifiedTo } from "@unified-api/typescript-sdk";
19
-
20
- const unifiedTo = new UnifiedTo({
21
- security: {
22
- jwt: "<YOUR_API_KEY_HERE>",
23
- },
24
- });
25
-
26
- async function run() {
27
- const result = await unifiedTo.busy.listCalendarBusies({
28
- connectionId: "<id>",
29
- });
30
-
31
- console.log(result);
32
- }
33
-
34
- run();
35
- ```
36
-
37
- ### Standalone function
38
-
39
- The standalone function version of this method:
40
-
41
- ```typescript
42
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
43
- import { calendarListCalendarBusies } from "@unified-api/typescript-sdk/funcs/calendarListCalendarBusies.js";
44
-
45
- // Use `UnifiedToCore` for best tree-shaking performance.
46
- // You can create one instance of it to use across an application.
47
- const unifiedTo = new UnifiedToCore({
48
- security: {
49
- jwt: "<YOUR_API_KEY_HERE>",
50
- },
51
- });
52
-
53
- async function run() {
54
- const res = await calendarListCalendarBusies(unifiedTo, {
55
- connectionId: "<id>",
56
- });
57
- if (res.ok) {
58
- const { value: result } = res;
59
- console.log(result);
60
- } else {
61
- console.log("calendarListCalendarBusies failed:", res.error);
62
- }
63
- }
64
-
65
- run();
66
- ```
67
-
68
- ### Parameters
69
-
70
- | Parameter | Type | Required | Description |
71
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
72
- | `request` | [operations.ListCalendarBusiesRequest](../../sdk/models/operations/listcalendarbusiesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
73
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
74
- | `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. |
75
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
76
-
77
- ### Response
78
-
79
- **Promise\<[shared.CalendarBusy[]](../../models/.md)\>**
80
-
81
- ### Errors
82
-
83
- | Error Type | Status Code | Content Type |
84
- | --------------- | --------------- | --------------- |
85
- | errors.SDKError | 4XX, 5XX | \*/\* |