@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,1713 +0,0 @@
1
- # Calendar
2
- (*calendar*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createCalendarCalendar](#createcalendarcalendar) - Create a calendar
9
- * [createCalendarEvent](#createcalendarevent) - Create an event
10
- * [createCalendarLink](#createcalendarlink) - Create a link
11
- * [getCalendarCalendar](#getcalendarcalendar) - Retrieve a calendar
12
- * [getCalendarEvent](#getcalendarevent) - Retrieve an event
13
- * [getCalendarLink](#getcalendarlink) - Retrieve a link
14
- * [getCalendarRecording](#getcalendarrecording) - Retrieve a recording
15
- * [listCalendarBusies](#listcalendarbusies) - List all busies
16
- * [listCalendarCalendars](#listcalendarcalendars) - List all calendars
17
- * [listCalendarEvents](#listcalendarevents) - List all events
18
- * [listCalendarLinks](#listcalendarlinks) - List all links
19
- * [listCalendarRecordings](#listcalendarrecordings) - List all recordings
20
- * [patchCalendarCalendar](#patchcalendarcalendar) - Update a calendar
21
- * [patchCalendarEvent](#patchcalendarevent) - Update an event
22
- * [patchCalendarLink](#patchcalendarlink) - Update a link
23
- * [removeCalendarCalendar](#removecalendarcalendar) - Remove a calendar
24
- * [removeCalendarEvent](#removecalendarevent) - Remove an event
25
- * [removeCalendarLink](#removecalendarlink) - Remove a link
26
- * [updateCalendarCalendar](#updatecalendarcalendar) - Update a calendar
27
- * [updateCalendarEvent](#updatecalendarevent) - Update an event
28
- * [updateCalendarLink](#updatecalendarlink) - Update a link
29
-
30
- ## createCalendarCalendar
31
-
32
- Create a calendar
33
-
34
- ### Example Usage
35
-
36
- <!-- UsageSnippet language="typescript" operationID="createCalendarCalendar" method="post" path="/calendar/{connection_id}/calendar" -->
37
- ```typescript
38
- import { UnifiedTo } from "@unified-api/typescript-sdk";
39
-
40
- const unifiedTo = new UnifiedTo({
41
- security: {
42
- jwt: "<YOUR_API_KEY_HERE>",
43
- },
44
- });
45
-
46
- async function run() {
47
- const result = await unifiedTo.calendar.createCalendarCalendar({
48
- calendarCalendar: {
49
- name: "<value>",
50
- },
51
- connectionId: "<id>",
52
- });
53
-
54
- console.log(result);
55
- }
56
-
57
- run();
58
- ```
59
-
60
- ### Standalone function
61
-
62
- The standalone function version of this method:
63
-
64
- ```typescript
65
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
66
- import { calendarCreateCalendarCalendar } from "@unified-api/typescript-sdk/funcs/calendarCreateCalendarCalendar.js";
67
-
68
- // Use `UnifiedToCore` for best tree-shaking performance.
69
- // You can create one instance of it to use across an application.
70
- const unifiedTo = new UnifiedToCore({
71
- security: {
72
- jwt: "<YOUR_API_KEY_HERE>",
73
- },
74
- });
75
-
76
- async function run() {
77
- const res = await calendarCreateCalendarCalendar(unifiedTo, {
78
- calendarCalendar: {
79
- name: "<value>",
80
- },
81
- connectionId: "<id>",
82
- });
83
- if (res.ok) {
84
- const { value: result } = res;
85
- console.log(result);
86
- } else {
87
- console.log("calendarCreateCalendarCalendar failed:", res.error);
88
- }
89
- }
90
-
91
- run();
92
- ```
93
-
94
- ### Parameters
95
-
96
- | Parameter | Type | Required | Description |
97
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
98
- | `request` | [operations.CreateCalendarCalendarRequest](../../sdk/models/operations/createcalendarcalendarrequest.md) | :heavy_check_mark: | The request object to use for the request. |
99
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
100
- | `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. |
101
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
102
-
103
- ### Response
104
-
105
- **Promise\<[shared.CalendarCalendar](../../sdk/models/shared/calendarcalendar.md)\>**
106
-
107
- ### Errors
108
-
109
- | Error Type | Status Code | Content Type |
110
- | --------------- | --------------- | --------------- |
111
- | errors.SDKError | 4XX, 5XX | \*/\* |
112
-
113
- ## createCalendarEvent
114
-
115
- Create an event
116
-
117
- ### Example Usage
118
-
119
- <!-- UsageSnippet language="typescript" operationID="createCalendarEvent" method="post" path="/calendar/{connection_id}/event" -->
120
- ```typescript
121
- import { UnifiedTo } from "@unified-api/typescript-sdk";
122
-
123
- const unifiedTo = new UnifiedTo({
124
- security: {
125
- jwt: "<YOUR_API_KEY_HERE>",
126
- },
127
- });
128
-
129
- async function run() {
130
- const result = await unifiedTo.calendar.createCalendarEvent({
131
- calendarEvent: {},
132
- connectionId: "<id>",
133
- });
134
-
135
- console.log(result);
136
- }
137
-
138
- run();
139
- ```
140
-
141
- ### Standalone function
142
-
143
- The standalone function version of this method:
144
-
145
- ```typescript
146
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
147
- import { calendarCreateCalendarEvent } from "@unified-api/typescript-sdk/funcs/calendarCreateCalendarEvent.js";
148
-
149
- // Use `UnifiedToCore` for best tree-shaking performance.
150
- // You can create one instance of it to use across an application.
151
- const unifiedTo = new UnifiedToCore({
152
- security: {
153
- jwt: "<YOUR_API_KEY_HERE>",
154
- },
155
- });
156
-
157
- async function run() {
158
- const res = await calendarCreateCalendarEvent(unifiedTo, {
159
- calendarEvent: {},
160
- connectionId: "<id>",
161
- });
162
- if (res.ok) {
163
- const { value: result } = res;
164
- console.log(result);
165
- } else {
166
- console.log("calendarCreateCalendarEvent failed:", res.error);
167
- }
168
- }
169
-
170
- run();
171
- ```
172
-
173
- ### Parameters
174
-
175
- | Parameter | Type | Required | Description |
176
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
177
- | `request` | [operations.CreateCalendarEventRequest](../../sdk/models/operations/createcalendareventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
178
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
179
- | `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. |
180
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
181
-
182
- ### Response
183
-
184
- **Promise\<[shared.CalendarEvent](../../sdk/models/shared/calendarevent.md)\>**
185
-
186
- ### Errors
187
-
188
- | Error Type | Status Code | Content Type |
189
- | --------------- | --------------- | --------------- |
190
- | errors.SDKError | 4XX, 5XX | \*/\* |
191
-
192
- ## createCalendarLink
193
-
194
- Create a link
195
-
196
- ### Example Usage
197
-
198
- <!-- UsageSnippet language="typescript" operationID="createCalendarLink" method="post" path="/calendar/{connection_id}/link" -->
199
- ```typescript
200
- import { UnifiedTo } from "@unified-api/typescript-sdk";
201
-
202
- const unifiedTo = new UnifiedTo({
203
- security: {
204
- jwt: "<YOUR_API_KEY_HERE>",
205
- },
206
- });
207
-
208
- async function run() {
209
- const result = await unifiedTo.calendar.createCalendarLink({
210
- calendarLink: {
211
- url: "https://misguided-thongs.info",
212
- },
213
- connectionId: "<id>",
214
- });
215
-
216
- console.log(result);
217
- }
218
-
219
- run();
220
- ```
221
-
222
- ### Standalone function
223
-
224
- The standalone function version of this method:
225
-
226
- ```typescript
227
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
228
- import { calendarCreateCalendarLink } from "@unified-api/typescript-sdk/funcs/calendarCreateCalendarLink.js";
229
-
230
- // Use `UnifiedToCore` for best tree-shaking performance.
231
- // You can create one instance of it to use across an application.
232
- const unifiedTo = new UnifiedToCore({
233
- security: {
234
- jwt: "<YOUR_API_KEY_HERE>",
235
- },
236
- });
237
-
238
- async function run() {
239
- const res = await calendarCreateCalendarLink(unifiedTo, {
240
- calendarLink: {
241
- url: "https://misguided-thongs.info",
242
- },
243
- connectionId: "<id>",
244
- });
245
- if (res.ok) {
246
- const { value: result } = res;
247
- console.log(result);
248
- } else {
249
- console.log("calendarCreateCalendarLink failed:", res.error);
250
- }
251
- }
252
-
253
- run();
254
- ```
255
-
256
- ### Parameters
257
-
258
- | Parameter | Type | Required | Description |
259
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
260
- | `request` | [operations.CreateCalendarLinkRequest](../../sdk/models/operations/createcalendarlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
261
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
262
- | `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. |
263
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
264
-
265
- ### Response
266
-
267
- **Promise\<[shared.CalendarLink](../../sdk/models/shared/calendarlink.md)\>**
268
-
269
- ### Errors
270
-
271
- | Error Type | Status Code | Content Type |
272
- | --------------- | --------------- | --------------- |
273
- | errors.SDKError | 4XX, 5XX | \*/\* |
274
-
275
- ## getCalendarCalendar
276
-
277
- Retrieve a calendar
278
-
279
- ### Example Usage
280
-
281
- <!-- UsageSnippet language="typescript" operationID="getCalendarCalendar" method="get" path="/calendar/{connection_id}/calendar/{id}" -->
282
- ```typescript
283
- import { UnifiedTo } from "@unified-api/typescript-sdk";
284
-
285
- const unifiedTo = new UnifiedTo({
286
- security: {
287
- jwt: "<YOUR_API_KEY_HERE>",
288
- },
289
- });
290
-
291
- async function run() {
292
- const result = await unifiedTo.calendar.getCalendarCalendar({
293
- connectionId: "<id>",
294
- id: "<id>",
295
- });
296
-
297
- console.log(result);
298
- }
299
-
300
- run();
301
- ```
302
-
303
- ### Standalone function
304
-
305
- The standalone function version of this method:
306
-
307
- ```typescript
308
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
309
- import { calendarGetCalendarCalendar } from "@unified-api/typescript-sdk/funcs/calendarGetCalendarCalendar.js";
310
-
311
- // Use `UnifiedToCore` for best tree-shaking performance.
312
- // You can create one instance of it to use across an application.
313
- const unifiedTo = new UnifiedToCore({
314
- security: {
315
- jwt: "<YOUR_API_KEY_HERE>",
316
- },
317
- });
318
-
319
- async function run() {
320
- const res = await calendarGetCalendarCalendar(unifiedTo, {
321
- connectionId: "<id>",
322
- id: "<id>",
323
- });
324
- if (res.ok) {
325
- const { value: result } = res;
326
- console.log(result);
327
- } else {
328
- console.log("calendarGetCalendarCalendar failed:", res.error);
329
- }
330
- }
331
-
332
- run();
333
- ```
334
-
335
- ### Parameters
336
-
337
- | Parameter | Type | Required | Description |
338
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
339
- | `request` | [operations.GetCalendarCalendarRequest](../../sdk/models/operations/getcalendarcalendarrequest.md) | :heavy_check_mark: | The request object to use for the request. |
340
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
341
- | `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. |
342
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
343
-
344
- ### Response
345
-
346
- **Promise\<[shared.CalendarCalendar](../../sdk/models/shared/calendarcalendar.md)\>**
347
-
348
- ### Errors
349
-
350
- | Error Type | Status Code | Content Type |
351
- | --------------- | --------------- | --------------- |
352
- | errors.SDKError | 4XX, 5XX | \*/\* |
353
-
354
- ## getCalendarEvent
355
-
356
- Retrieve an event
357
-
358
- ### Example Usage
359
-
360
- <!-- UsageSnippet language="typescript" operationID="getCalendarEvent" method="get" path="/calendar/{connection_id}/event/{id}" -->
361
- ```typescript
362
- import { UnifiedTo } from "@unified-api/typescript-sdk";
363
-
364
- const unifiedTo = new UnifiedTo({
365
- security: {
366
- jwt: "<YOUR_API_KEY_HERE>",
367
- },
368
- });
369
-
370
- async function run() {
371
- const result = await unifiedTo.calendar.getCalendarEvent({
372
- connectionId: "<id>",
373
- id: "<id>",
374
- });
375
-
376
- console.log(result);
377
- }
378
-
379
- run();
380
- ```
381
-
382
- ### Standalone function
383
-
384
- The standalone function version of this method:
385
-
386
- ```typescript
387
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
388
- import { calendarGetCalendarEvent } from "@unified-api/typescript-sdk/funcs/calendarGetCalendarEvent.js";
389
-
390
- // Use `UnifiedToCore` for best tree-shaking performance.
391
- // You can create one instance of it to use across an application.
392
- const unifiedTo = new UnifiedToCore({
393
- security: {
394
- jwt: "<YOUR_API_KEY_HERE>",
395
- },
396
- });
397
-
398
- async function run() {
399
- const res = await calendarGetCalendarEvent(unifiedTo, {
400
- connectionId: "<id>",
401
- id: "<id>",
402
- });
403
- if (res.ok) {
404
- const { value: result } = res;
405
- console.log(result);
406
- } else {
407
- console.log("calendarGetCalendarEvent failed:", res.error);
408
- }
409
- }
410
-
411
- run();
412
- ```
413
-
414
- ### Parameters
415
-
416
- | Parameter | Type | Required | Description |
417
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
418
- | `request` | [operations.GetCalendarEventRequest](../../sdk/models/operations/getcalendareventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
419
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
420
- | `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. |
421
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
422
-
423
- ### Response
424
-
425
- **Promise\<[shared.CalendarEvent](../../sdk/models/shared/calendarevent.md)\>**
426
-
427
- ### Errors
428
-
429
- | Error Type | Status Code | Content Type |
430
- | --------------- | --------------- | --------------- |
431
- | errors.SDKError | 4XX, 5XX | \*/\* |
432
-
433
- ## getCalendarLink
434
-
435
- Retrieve a link
436
-
437
- ### Example Usage
438
-
439
- <!-- UsageSnippet language="typescript" operationID="getCalendarLink" method="get" path="/calendar/{connection_id}/link/{id}" -->
440
- ```typescript
441
- import { UnifiedTo } from "@unified-api/typescript-sdk";
442
-
443
- const unifiedTo = new UnifiedTo({
444
- security: {
445
- jwt: "<YOUR_API_KEY_HERE>",
446
- },
447
- });
448
-
449
- async function run() {
450
- const result = await unifiedTo.calendar.getCalendarLink({
451
- connectionId: "<id>",
452
- id: "<id>",
453
- });
454
-
455
- console.log(result);
456
- }
457
-
458
- run();
459
- ```
460
-
461
- ### Standalone function
462
-
463
- The standalone function version of this method:
464
-
465
- ```typescript
466
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
467
- import { calendarGetCalendarLink } from "@unified-api/typescript-sdk/funcs/calendarGetCalendarLink.js";
468
-
469
- // Use `UnifiedToCore` for best tree-shaking performance.
470
- // You can create one instance of it to use across an application.
471
- const unifiedTo = new UnifiedToCore({
472
- security: {
473
- jwt: "<YOUR_API_KEY_HERE>",
474
- },
475
- });
476
-
477
- async function run() {
478
- const res = await calendarGetCalendarLink(unifiedTo, {
479
- connectionId: "<id>",
480
- id: "<id>",
481
- });
482
- if (res.ok) {
483
- const { value: result } = res;
484
- console.log(result);
485
- } else {
486
- console.log("calendarGetCalendarLink failed:", res.error);
487
- }
488
- }
489
-
490
- run();
491
- ```
492
-
493
- ### Parameters
494
-
495
- | Parameter | Type | Required | Description |
496
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
497
- | `request` | [operations.GetCalendarLinkRequest](../../sdk/models/operations/getcalendarlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
498
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
499
- | `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. |
500
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
501
-
502
- ### Response
503
-
504
- **Promise\<[shared.CalendarLink](../../sdk/models/shared/calendarlink.md)\>**
505
-
506
- ### Errors
507
-
508
- | Error Type | Status Code | Content Type |
509
- | --------------- | --------------- | --------------- |
510
- | errors.SDKError | 4XX, 5XX | \*/\* |
511
-
512
- ## getCalendarRecording
513
-
514
- Retrieve a recording
515
-
516
- ### Example Usage
517
-
518
- <!-- UsageSnippet language="typescript" operationID="getCalendarRecording" method="get" path="/calendar/{connection_id}/recording/{id}" -->
519
- ```typescript
520
- import { UnifiedTo } from "@unified-api/typescript-sdk";
521
-
522
- const unifiedTo = new UnifiedTo({
523
- security: {
524
- jwt: "<YOUR_API_KEY_HERE>",
525
- },
526
- });
527
-
528
- async function run() {
529
- const result = await unifiedTo.calendar.getCalendarRecording({
530
- connectionId: "<id>",
531
- id: "<id>",
532
- });
533
-
534
- console.log(result);
535
- }
536
-
537
- run();
538
- ```
539
-
540
- ### Standalone function
541
-
542
- The standalone function version of this method:
543
-
544
- ```typescript
545
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
546
- import { calendarGetCalendarRecording } from "@unified-api/typescript-sdk/funcs/calendarGetCalendarRecording.js";
547
-
548
- // Use `UnifiedToCore` for best tree-shaking performance.
549
- // You can create one instance of it to use across an application.
550
- const unifiedTo = new UnifiedToCore({
551
- security: {
552
- jwt: "<YOUR_API_KEY_HERE>",
553
- },
554
- });
555
-
556
- async function run() {
557
- const res = await calendarGetCalendarRecording(unifiedTo, {
558
- connectionId: "<id>",
559
- id: "<id>",
560
- });
561
- if (res.ok) {
562
- const { value: result } = res;
563
- console.log(result);
564
- } else {
565
- console.log("calendarGetCalendarRecording failed:", res.error);
566
- }
567
- }
568
-
569
- run();
570
- ```
571
-
572
- ### Parameters
573
-
574
- | Parameter | Type | Required | Description |
575
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
576
- | `request` | [operations.GetCalendarRecordingRequest](../../sdk/models/operations/getcalendarrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
577
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
578
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
579
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
580
-
581
- ### Response
582
-
583
- **Promise\<[shared.CalendarRecording](../../sdk/models/shared/calendarrecording.md)\>**
584
-
585
- ### Errors
586
-
587
- | Error Type | Status Code | Content Type |
588
- | --------------- | --------------- | --------------- |
589
- | errors.SDKError | 4XX, 5XX | \*/\* |
590
-
591
- ## listCalendarBusies
592
-
593
- List all busies
594
-
595
- ### Example Usage
596
-
597
- <!-- UsageSnippet language="typescript" operationID="listCalendarBusies" method="get" path="/calendar/{connection_id}/busy" -->
598
- ```typescript
599
- import { UnifiedTo } from "@unified-api/typescript-sdk";
600
-
601
- const unifiedTo = new UnifiedTo({
602
- security: {
603
- jwt: "<YOUR_API_KEY_HERE>",
604
- },
605
- });
606
-
607
- async function run() {
608
- const result = await unifiedTo.calendar.listCalendarBusies({
609
- connectionId: "<id>",
610
- });
611
-
612
- console.log(result);
613
- }
614
-
615
- run();
616
- ```
617
-
618
- ### Standalone function
619
-
620
- The standalone function version of this method:
621
-
622
- ```typescript
623
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
624
- import { calendarListCalendarBusies } from "@unified-api/typescript-sdk/funcs/calendarListCalendarBusies.js";
625
-
626
- // Use `UnifiedToCore` for best tree-shaking performance.
627
- // You can create one instance of it to use across an application.
628
- const unifiedTo = new UnifiedToCore({
629
- security: {
630
- jwt: "<YOUR_API_KEY_HERE>",
631
- },
632
- });
633
-
634
- async function run() {
635
- const res = await calendarListCalendarBusies(unifiedTo, {
636
- connectionId: "<id>",
637
- });
638
- if (res.ok) {
639
- const { value: result } = res;
640
- console.log(result);
641
- } else {
642
- console.log("calendarListCalendarBusies failed:", res.error);
643
- }
644
- }
645
-
646
- run();
647
- ```
648
-
649
- ### Parameters
650
-
651
- | Parameter | Type | Required | Description |
652
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
653
- | `request` | [operations.ListCalendarBusiesRequest](../../sdk/models/operations/listcalendarbusiesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
654
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
655
- | `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. |
656
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
657
-
658
- ### Response
659
-
660
- **Promise\<[shared.CalendarBusy[]](../../models/.md)\>**
661
-
662
- ### Errors
663
-
664
- | Error Type | Status Code | Content Type |
665
- | --------------- | --------------- | --------------- |
666
- | errors.SDKError | 4XX, 5XX | \*/\* |
667
-
668
- ## listCalendarCalendars
669
-
670
- List all calendars
671
-
672
- ### Example Usage
673
-
674
- <!-- UsageSnippet language="typescript" operationID="listCalendarCalendars" method="get" path="/calendar/{connection_id}/calendar" -->
675
- ```typescript
676
- import { UnifiedTo } from "@unified-api/typescript-sdk";
677
-
678
- const unifiedTo = new UnifiedTo({
679
- security: {
680
- jwt: "<YOUR_API_KEY_HERE>",
681
- },
682
- });
683
-
684
- async function run() {
685
- const result = await unifiedTo.calendar.listCalendarCalendars({
686
- connectionId: "<id>",
687
- });
688
-
689
- console.log(result);
690
- }
691
-
692
- run();
693
- ```
694
-
695
- ### Standalone function
696
-
697
- The standalone function version of this method:
698
-
699
- ```typescript
700
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
701
- import { calendarListCalendarCalendars } from "@unified-api/typescript-sdk/funcs/calendarListCalendarCalendars.js";
702
-
703
- // Use `UnifiedToCore` for best tree-shaking performance.
704
- // You can create one instance of it to use across an application.
705
- const unifiedTo = new UnifiedToCore({
706
- security: {
707
- jwt: "<YOUR_API_KEY_HERE>",
708
- },
709
- });
710
-
711
- async function run() {
712
- const res = await calendarListCalendarCalendars(unifiedTo, {
713
- connectionId: "<id>",
714
- });
715
- if (res.ok) {
716
- const { value: result } = res;
717
- console.log(result);
718
- } else {
719
- console.log("calendarListCalendarCalendars failed:", res.error);
720
- }
721
- }
722
-
723
- run();
724
- ```
725
-
726
- ### Parameters
727
-
728
- | Parameter | Type | Required | Description |
729
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
730
- | `request` | [operations.ListCalendarCalendarsRequest](../../sdk/models/operations/listcalendarcalendarsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
731
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
732
- | `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. |
733
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
734
-
735
- ### Response
736
-
737
- **Promise\<[shared.CalendarCalendar[]](../../models/.md)\>**
738
-
739
- ### Errors
740
-
741
- | Error Type | Status Code | Content Type |
742
- | --------------- | --------------- | --------------- |
743
- | errors.SDKError | 4XX, 5XX | \*/\* |
744
-
745
- ## listCalendarEvents
746
-
747
- List all events
748
-
749
- ### Example Usage
750
-
751
- <!-- UsageSnippet language="typescript" operationID="listCalendarEvents" method="get" path="/calendar/{connection_id}/event" -->
752
- ```typescript
753
- import { UnifiedTo } from "@unified-api/typescript-sdk";
754
-
755
- const unifiedTo = new UnifiedTo({
756
- security: {
757
- jwt: "<YOUR_API_KEY_HERE>",
758
- },
759
- });
760
-
761
- async function run() {
762
- const result = await unifiedTo.calendar.listCalendarEvents({
763
- connectionId: "<id>",
764
- });
765
-
766
- console.log(result);
767
- }
768
-
769
- run();
770
- ```
771
-
772
- ### Standalone function
773
-
774
- The standalone function version of this method:
775
-
776
- ```typescript
777
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
778
- import { calendarListCalendarEvents } from "@unified-api/typescript-sdk/funcs/calendarListCalendarEvents.js";
779
-
780
- // Use `UnifiedToCore` for best tree-shaking performance.
781
- // You can create one instance of it to use across an application.
782
- const unifiedTo = new UnifiedToCore({
783
- security: {
784
- jwt: "<YOUR_API_KEY_HERE>",
785
- },
786
- });
787
-
788
- async function run() {
789
- const res = await calendarListCalendarEvents(unifiedTo, {
790
- connectionId: "<id>",
791
- });
792
- if (res.ok) {
793
- const { value: result } = res;
794
- console.log(result);
795
- } else {
796
- console.log("calendarListCalendarEvents failed:", res.error);
797
- }
798
- }
799
-
800
- run();
801
- ```
802
-
803
- ### Parameters
804
-
805
- | Parameter | Type | Required | Description |
806
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
807
- | `request` | [operations.ListCalendarEventsRequest](../../sdk/models/operations/listcalendareventsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
808
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
809
- | `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. |
810
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
811
-
812
- ### Response
813
-
814
- **Promise\<[shared.CalendarEvent[]](../../models/.md)\>**
815
-
816
- ### Errors
817
-
818
- | Error Type | Status Code | Content Type |
819
- | --------------- | --------------- | --------------- |
820
- | errors.SDKError | 4XX, 5XX | \*/\* |
821
-
822
- ## listCalendarLinks
823
-
824
- List all links
825
-
826
- ### Example Usage
827
-
828
- <!-- UsageSnippet language="typescript" operationID="listCalendarLinks" method="get" path="/calendar/{connection_id}/link" -->
829
- ```typescript
830
- import { UnifiedTo } from "@unified-api/typescript-sdk";
831
-
832
- const unifiedTo = new UnifiedTo({
833
- security: {
834
- jwt: "<YOUR_API_KEY_HERE>",
835
- },
836
- });
837
-
838
- async function run() {
839
- const result = await unifiedTo.calendar.listCalendarLinks({
840
- connectionId: "<id>",
841
- });
842
-
843
- console.log(result);
844
- }
845
-
846
- run();
847
- ```
848
-
849
- ### Standalone function
850
-
851
- The standalone function version of this method:
852
-
853
- ```typescript
854
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
855
- import { calendarListCalendarLinks } from "@unified-api/typescript-sdk/funcs/calendarListCalendarLinks.js";
856
-
857
- // Use `UnifiedToCore` for best tree-shaking performance.
858
- // You can create one instance of it to use across an application.
859
- const unifiedTo = new UnifiedToCore({
860
- security: {
861
- jwt: "<YOUR_API_KEY_HERE>",
862
- },
863
- });
864
-
865
- async function run() {
866
- const res = await calendarListCalendarLinks(unifiedTo, {
867
- connectionId: "<id>",
868
- });
869
- if (res.ok) {
870
- const { value: result } = res;
871
- console.log(result);
872
- } else {
873
- console.log("calendarListCalendarLinks failed:", res.error);
874
- }
875
- }
876
-
877
- run();
878
- ```
879
-
880
- ### Parameters
881
-
882
- | Parameter | Type | Required | Description |
883
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
884
- | `request` | [operations.ListCalendarLinksRequest](../../sdk/models/operations/listcalendarlinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
885
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
886
- | `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. |
887
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
888
-
889
- ### Response
890
-
891
- **Promise\<[shared.CalendarLink[]](../../models/.md)\>**
892
-
893
- ### Errors
894
-
895
- | Error Type | Status Code | Content Type |
896
- | --------------- | --------------- | --------------- |
897
- | errors.SDKError | 4XX, 5XX | \*/\* |
898
-
899
- ## listCalendarRecordings
900
-
901
- List all recordings
902
-
903
- ### Example Usage
904
-
905
- <!-- UsageSnippet language="typescript" operationID="listCalendarRecordings" method="get" path="/calendar/{connection_id}/recording" -->
906
- ```typescript
907
- import { UnifiedTo } from "@unified-api/typescript-sdk";
908
-
909
- const unifiedTo = new UnifiedTo({
910
- security: {
911
- jwt: "<YOUR_API_KEY_HERE>",
912
- },
913
- });
914
-
915
- async function run() {
916
- const result = await unifiedTo.calendar.listCalendarRecordings({
917
- connectionId: "<id>",
918
- });
919
-
920
- console.log(result);
921
- }
922
-
923
- run();
924
- ```
925
-
926
- ### Standalone function
927
-
928
- The standalone function version of this method:
929
-
930
- ```typescript
931
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
932
- import { calendarListCalendarRecordings } from "@unified-api/typescript-sdk/funcs/calendarListCalendarRecordings.js";
933
-
934
- // Use `UnifiedToCore` for best tree-shaking performance.
935
- // You can create one instance of it to use across an application.
936
- const unifiedTo = new UnifiedToCore({
937
- security: {
938
- jwt: "<YOUR_API_KEY_HERE>",
939
- },
940
- });
941
-
942
- async function run() {
943
- const res = await calendarListCalendarRecordings(unifiedTo, {
944
- connectionId: "<id>",
945
- });
946
- if (res.ok) {
947
- const { value: result } = res;
948
- console.log(result);
949
- } else {
950
- console.log("calendarListCalendarRecordings failed:", res.error);
951
- }
952
- }
953
-
954
- run();
955
- ```
956
-
957
- ### Parameters
958
-
959
- | Parameter | Type | Required | Description |
960
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
961
- | `request` | [operations.ListCalendarRecordingsRequest](../../sdk/models/operations/listcalendarrecordingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
962
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
963
- | `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. |
964
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
965
-
966
- ### Response
967
-
968
- **Promise\<[shared.CalendarRecording[]](../../models/.md)\>**
969
-
970
- ### Errors
971
-
972
- | Error Type | Status Code | Content Type |
973
- | --------------- | --------------- | --------------- |
974
- | errors.SDKError | 4XX, 5XX | \*/\* |
975
-
976
- ## patchCalendarCalendar
977
-
978
- Update a calendar
979
-
980
- ### Example Usage
981
-
982
- <!-- UsageSnippet language="typescript" operationID="patchCalendarCalendar" method="patch" path="/calendar/{connection_id}/calendar/{id}" -->
983
- ```typescript
984
- import { UnifiedTo } from "@unified-api/typescript-sdk";
985
-
986
- const unifiedTo = new UnifiedTo({
987
- security: {
988
- jwt: "<YOUR_API_KEY_HERE>",
989
- },
990
- });
991
-
992
- async function run() {
993
- const result = await unifiedTo.calendar.patchCalendarCalendar({
994
- calendarCalendar: {
995
- name: "<value>",
996
- },
997
- connectionId: "<id>",
998
- id: "<id>",
999
- });
1000
-
1001
- console.log(result);
1002
- }
1003
-
1004
- run();
1005
- ```
1006
-
1007
- ### Standalone function
1008
-
1009
- The standalone function version of this method:
1010
-
1011
- ```typescript
1012
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1013
- import { calendarPatchCalendarCalendar } from "@unified-api/typescript-sdk/funcs/calendarPatchCalendarCalendar.js";
1014
-
1015
- // Use `UnifiedToCore` for best tree-shaking performance.
1016
- // You can create one instance of it to use across an application.
1017
- const unifiedTo = new UnifiedToCore({
1018
- security: {
1019
- jwt: "<YOUR_API_KEY_HERE>",
1020
- },
1021
- });
1022
-
1023
- async function run() {
1024
- const res = await calendarPatchCalendarCalendar(unifiedTo, {
1025
- calendarCalendar: {
1026
- name: "<value>",
1027
- },
1028
- connectionId: "<id>",
1029
- id: "<id>",
1030
- });
1031
- if (res.ok) {
1032
- const { value: result } = res;
1033
- console.log(result);
1034
- } else {
1035
- console.log("calendarPatchCalendarCalendar failed:", res.error);
1036
- }
1037
- }
1038
-
1039
- run();
1040
- ```
1041
-
1042
- ### Parameters
1043
-
1044
- | Parameter | Type | Required | Description |
1045
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1046
- | `request` | [operations.PatchCalendarCalendarRequest](../../sdk/models/operations/patchcalendarcalendarrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1047
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1048
- | `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. |
1049
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1050
-
1051
- ### Response
1052
-
1053
- **Promise\<[shared.CalendarCalendar](../../sdk/models/shared/calendarcalendar.md)\>**
1054
-
1055
- ### Errors
1056
-
1057
- | Error Type | Status Code | Content Type |
1058
- | --------------- | --------------- | --------------- |
1059
- | errors.SDKError | 4XX, 5XX | \*/\* |
1060
-
1061
- ## patchCalendarEvent
1062
-
1063
- Update an event
1064
-
1065
- ### Example Usage
1066
-
1067
- <!-- UsageSnippet language="typescript" operationID="patchCalendarEvent" method="patch" path="/calendar/{connection_id}/event/{id}" -->
1068
- ```typescript
1069
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1070
-
1071
- const unifiedTo = new UnifiedTo({
1072
- security: {
1073
- jwt: "<YOUR_API_KEY_HERE>",
1074
- },
1075
- });
1076
-
1077
- async function run() {
1078
- const result = await unifiedTo.calendar.patchCalendarEvent({
1079
- calendarEvent: {},
1080
- connectionId: "<id>",
1081
- id: "<id>",
1082
- });
1083
-
1084
- console.log(result);
1085
- }
1086
-
1087
- run();
1088
- ```
1089
-
1090
- ### Standalone function
1091
-
1092
- The standalone function version of this method:
1093
-
1094
- ```typescript
1095
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1096
- import { calendarPatchCalendarEvent } from "@unified-api/typescript-sdk/funcs/calendarPatchCalendarEvent.js";
1097
-
1098
- // Use `UnifiedToCore` for best tree-shaking performance.
1099
- // You can create one instance of it to use across an application.
1100
- const unifiedTo = new UnifiedToCore({
1101
- security: {
1102
- jwt: "<YOUR_API_KEY_HERE>",
1103
- },
1104
- });
1105
-
1106
- async function run() {
1107
- const res = await calendarPatchCalendarEvent(unifiedTo, {
1108
- calendarEvent: {},
1109
- connectionId: "<id>",
1110
- id: "<id>",
1111
- });
1112
- if (res.ok) {
1113
- const { value: result } = res;
1114
- console.log(result);
1115
- } else {
1116
- console.log("calendarPatchCalendarEvent failed:", res.error);
1117
- }
1118
- }
1119
-
1120
- run();
1121
- ```
1122
-
1123
- ### Parameters
1124
-
1125
- | Parameter | Type | Required | Description |
1126
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1127
- | `request` | [operations.PatchCalendarEventRequest](../../sdk/models/operations/patchcalendareventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1128
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1129
- | `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. |
1130
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1131
-
1132
- ### Response
1133
-
1134
- **Promise\<[shared.CalendarEvent](../../sdk/models/shared/calendarevent.md)\>**
1135
-
1136
- ### Errors
1137
-
1138
- | Error Type | Status Code | Content Type |
1139
- | --------------- | --------------- | --------------- |
1140
- | errors.SDKError | 4XX, 5XX | \*/\* |
1141
-
1142
- ## patchCalendarLink
1143
-
1144
- Update a link
1145
-
1146
- ### Example Usage
1147
-
1148
- <!-- UsageSnippet language="typescript" operationID="patchCalendarLink" method="patch" path="/calendar/{connection_id}/link/{id}" -->
1149
- ```typescript
1150
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1151
-
1152
- const unifiedTo = new UnifiedTo({
1153
- security: {
1154
- jwt: "<YOUR_API_KEY_HERE>",
1155
- },
1156
- });
1157
-
1158
- async function run() {
1159
- const result = await unifiedTo.calendar.patchCalendarLink({
1160
- calendarLink: {
1161
- url: "https://warm-hexagon.name/",
1162
- },
1163
- connectionId: "<id>",
1164
- id: "<id>",
1165
- });
1166
-
1167
- console.log(result);
1168
- }
1169
-
1170
- run();
1171
- ```
1172
-
1173
- ### Standalone function
1174
-
1175
- The standalone function version of this method:
1176
-
1177
- ```typescript
1178
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1179
- import { calendarPatchCalendarLink } from "@unified-api/typescript-sdk/funcs/calendarPatchCalendarLink.js";
1180
-
1181
- // Use `UnifiedToCore` for best tree-shaking performance.
1182
- // You can create one instance of it to use across an application.
1183
- const unifiedTo = new UnifiedToCore({
1184
- security: {
1185
- jwt: "<YOUR_API_KEY_HERE>",
1186
- },
1187
- });
1188
-
1189
- async function run() {
1190
- const res = await calendarPatchCalendarLink(unifiedTo, {
1191
- calendarLink: {
1192
- url: "https://warm-hexagon.name/",
1193
- },
1194
- connectionId: "<id>",
1195
- id: "<id>",
1196
- });
1197
- if (res.ok) {
1198
- const { value: result } = res;
1199
- console.log(result);
1200
- } else {
1201
- console.log("calendarPatchCalendarLink failed:", res.error);
1202
- }
1203
- }
1204
-
1205
- run();
1206
- ```
1207
-
1208
- ### Parameters
1209
-
1210
- | Parameter | Type | Required | Description |
1211
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1212
- | `request` | [operations.PatchCalendarLinkRequest](../../sdk/models/operations/patchcalendarlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1213
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1214
- | `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. |
1215
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1216
-
1217
- ### Response
1218
-
1219
- **Promise\<[shared.CalendarLink](../../sdk/models/shared/calendarlink.md)\>**
1220
-
1221
- ### Errors
1222
-
1223
- | Error Type | Status Code | Content Type |
1224
- | --------------- | --------------- | --------------- |
1225
- | errors.SDKError | 4XX, 5XX | \*/\* |
1226
-
1227
- ## removeCalendarCalendar
1228
-
1229
- Remove a calendar
1230
-
1231
- ### Example Usage
1232
-
1233
- <!-- UsageSnippet language="typescript" operationID="removeCalendarCalendar" method="delete" path="/calendar/{connection_id}/calendar/{id}" -->
1234
- ```typescript
1235
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1236
-
1237
- const unifiedTo = new UnifiedTo({
1238
- security: {
1239
- jwt: "<YOUR_API_KEY_HERE>",
1240
- },
1241
- });
1242
-
1243
- async function run() {
1244
- const result = await unifiedTo.calendar.removeCalendarCalendar({
1245
- connectionId: "<id>",
1246
- id: "<id>",
1247
- });
1248
-
1249
- console.log(result);
1250
- }
1251
-
1252
- run();
1253
- ```
1254
-
1255
- ### Standalone function
1256
-
1257
- The standalone function version of this method:
1258
-
1259
- ```typescript
1260
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1261
- import { calendarRemoveCalendarCalendar } from "@unified-api/typescript-sdk/funcs/calendarRemoveCalendarCalendar.js";
1262
-
1263
- // Use `UnifiedToCore` for best tree-shaking performance.
1264
- // You can create one instance of it to use across an application.
1265
- const unifiedTo = new UnifiedToCore({
1266
- security: {
1267
- jwt: "<YOUR_API_KEY_HERE>",
1268
- },
1269
- });
1270
-
1271
- async function run() {
1272
- const res = await calendarRemoveCalendarCalendar(unifiedTo, {
1273
- connectionId: "<id>",
1274
- id: "<id>",
1275
- });
1276
- if (res.ok) {
1277
- const { value: result } = res;
1278
- console.log(result);
1279
- } else {
1280
- console.log("calendarRemoveCalendarCalendar failed:", res.error);
1281
- }
1282
- }
1283
-
1284
- run();
1285
- ```
1286
-
1287
- ### Parameters
1288
-
1289
- | Parameter | Type | Required | Description |
1290
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1291
- | `request` | [operations.RemoveCalendarCalendarRequest](../../sdk/models/operations/removecalendarcalendarrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1292
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1293
- | `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. |
1294
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1295
-
1296
- ### Response
1297
-
1298
- **Promise\<[operations.RemoveCalendarCalendarResponse](../../sdk/models/operations/removecalendarcalendarresponse.md)\>**
1299
-
1300
- ### Errors
1301
-
1302
- | Error Type | Status Code | Content Type |
1303
- | --------------- | --------------- | --------------- |
1304
- | errors.SDKError | 4XX, 5XX | \*/\* |
1305
-
1306
- ## removeCalendarEvent
1307
-
1308
- Remove an event
1309
-
1310
- ### Example Usage
1311
-
1312
- <!-- UsageSnippet language="typescript" operationID="removeCalendarEvent" method="delete" path="/calendar/{connection_id}/event/{id}" -->
1313
- ```typescript
1314
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1315
-
1316
- const unifiedTo = new UnifiedTo({
1317
- security: {
1318
- jwt: "<YOUR_API_KEY_HERE>",
1319
- },
1320
- });
1321
-
1322
- async function run() {
1323
- const result = await unifiedTo.calendar.removeCalendarEvent({
1324
- connectionId: "<id>",
1325
- id: "<id>",
1326
- });
1327
-
1328
- console.log(result);
1329
- }
1330
-
1331
- run();
1332
- ```
1333
-
1334
- ### Standalone function
1335
-
1336
- The standalone function version of this method:
1337
-
1338
- ```typescript
1339
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1340
- import { calendarRemoveCalendarEvent } from "@unified-api/typescript-sdk/funcs/calendarRemoveCalendarEvent.js";
1341
-
1342
- // Use `UnifiedToCore` for best tree-shaking performance.
1343
- // You can create one instance of it to use across an application.
1344
- const unifiedTo = new UnifiedToCore({
1345
- security: {
1346
- jwt: "<YOUR_API_KEY_HERE>",
1347
- },
1348
- });
1349
-
1350
- async function run() {
1351
- const res = await calendarRemoveCalendarEvent(unifiedTo, {
1352
- connectionId: "<id>",
1353
- id: "<id>",
1354
- });
1355
- if (res.ok) {
1356
- const { value: result } = res;
1357
- console.log(result);
1358
- } else {
1359
- console.log("calendarRemoveCalendarEvent failed:", res.error);
1360
- }
1361
- }
1362
-
1363
- run();
1364
- ```
1365
-
1366
- ### Parameters
1367
-
1368
- | Parameter | Type | Required | Description |
1369
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1370
- | `request` | [operations.RemoveCalendarEventRequest](../../sdk/models/operations/removecalendareventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1371
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1372
- | `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. |
1373
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1374
-
1375
- ### Response
1376
-
1377
- **Promise\<[operations.RemoveCalendarEventResponse](../../sdk/models/operations/removecalendareventresponse.md)\>**
1378
-
1379
- ### Errors
1380
-
1381
- | Error Type | Status Code | Content Type |
1382
- | --------------- | --------------- | --------------- |
1383
- | errors.SDKError | 4XX, 5XX | \*/\* |
1384
-
1385
- ## removeCalendarLink
1386
-
1387
- Remove a link
1388
-
1389
- ### Example Usage
1390
-
1391
- <!-- UsageSnippet language="typescript" operationID="removeCalendarLink" method="delete" path="/calendar/{connection_id}/link/{id}" -->
1392
- ```typescript
1393
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1394
-
1395
- const unifiedTo = new UnifiedTo({
1396
- security: {
1397
- jwt: "<YOUR_API_KEY_HERE>",
1398
- },
1399
- });
1400
-
1401
- async function run() {
1402
- const result = await unifiedTo.calendar.removeCalendarLink({
1403
- connectionId: "<id>",
1404
- id: "<id>",
1405
- });
1406
-
1407
- console.log(result);
1408
- }
1409
-
1410
- run();
1411
- ```
1412
-
1413
- ### Standalone function
1414
-
1415
- The standalone function version of this method:
1416
-
1417
- ```typescript
1418
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1419
- import { calendarRemoveCalendarLink } from "@unified-api/typescript-sdk/funcs/calendarRemoveCalendarLink.js";
1420
-
1421
- // Use `UnifiedToCore` for best tree-shaking performance.
1422
- // You can create one instance of it to use across an application.
1423
- const unifiedTo = new UnifiedToCore({
1424
- security: {
1425
- jwt: "<YOUR_API_KEY_HERE>",
1426
- },
1427
- });
1428
-
1429
- async function run() {
1430
- const res = await calendarRemoveCalendarLink(unifiedTo, {
1431
- connectionId: "<id>",
1432
- id: "<id>",
1433
- });
1434
- if (res.ok) {
1435
- const { value: result } = res;
1436
- console.log(result);
1437
- } else {
1438
- console.log("calendarRemoveCalendarLink failed:", res.error);
1439
- }
1440
- }
1441
-
1442
- run();
1443
- ```
1444
-
1445
- ### Parameters
1446
-
1447
- | Parameter | Type | Required | Description |
1448
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1449
- | `request` | [operations.RemoveCalendarLinkRequest](../../sdk/models/operations/removecalendarlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1450
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1451
- | `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. |
1452
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1453
-
1454
- ### Response
1455
-
1456
- **Promise\<[operations.RemoveCalendarLinkResponse](../../sdk/models/operations/removecalendarlinkresponse.md)\>**
1457
-
1458
- ### Errors
1459
-
1460
- | Error Type | Status Code | Content Type |
1461
- | --------------- | --------------- | --------------- |
1462
- | errors.SDKError | 4XX, 5XX | \*/\* |
1463
-
1464
- ## updateCalendarCalendar
1465
-
1466
- Update a calendar
1467
-
1468
- ### Example Usage
1469
-
1470
- <!-- UsageSnippet language="typescript" operationID="updateCalendarCalendar" method="put" path="/calendar/{connection_id}/calendar/{id}" -->
1471
- ```typescript
1472
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1473
-
1474
- const unifiedTo = new UnifiedTo({
1475
- security: {
1476
- jwt: "<YOUR_API_KEY_HERE>",
1477
- },
1478
- });
1479
-
1480
- async function run() {
1481
- const result = await unifiedTo.calendar.updateCalendarCalendar({
1482
- calendarCalendar: {
1483
- name: "<value>",
1484
- },
1485
- connectionId: "<id>",
1486
- id: "<id>",
1487
- });
1488
-
1489
- console.log(result);
1490
- }
1491
-
1492
- run();
1493
- ```
1494
-
1495
- ### Standalone function
1496
-
1497
- The standalone function version of this method:
1498
-
1499
- ```typescript
1500
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1501
- import { calendarUpdateCalendarCalendar } from "@unified-api/typescript-sdk/funcs/calendarUpdateCalendarCalendar.js";
1502
-
1503
- // Use `UnifiedToCore` for best tree-shaking performance.
1504
- // You can create one instance of it to use across an application.
1505
- const unifiedTo = new UnifiedToCore({
1506
- security: {
1507
- jwt: "<YOUR_API_KEY_HERE>",
1508
- },
1509
- });
1510
-
1511
- async function run() {
1512
- const res = await calendarUpdateCalendarCalendar(unifiedTo, {
1513
- calendarCalendar: {
1514
- name: "<value>",
1515
- },
1516
- connectionId: "<id>",
1517
- id: "<id>",
1518
- });
1519
- if (res.ok) {
1520
- const { value: result } = res;
1521
- console.log(result);
1522
- } else {
1523
- console.log("calendarUpdateCalendarCalendar failed:", res.error);
1524
- }
1525
- }
1526
-
1527
- run();
1528
- ```
1529
-
1530
- ### Parameters
1531
-
1532
- | Parameter | Type | Required | Description |
1533
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1534
- | `request` | [operations.UpdateCalendarCalendarRequest](../../sdk/models/operations/updatecalendarcalendarrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1535
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1536
- | `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. |
1537
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1538
-
1539
- ### Response
1540
-
1541
- **Promise\<[shared.CalendarCalendar](../../sdk/models/shared/calendarcalendar.md)\>**
1542
-
1543
- ### Errors
1544
-
1545
- | Error Type | Status Code | Content Type |
1546
- | --------------- | --------------- | --------------- |
1547
- | errors.SDKError | 4XX, 5XX | \*/\* |
1548
-
1549
- ## updateCalendarEvent
1550
-
1551
- Update an event
1552
-
1553
- ### Example Usage
1554
-
1555
- <!-- UsageSnippet language="typescript" operationID="updateCalendarEvent" method="put" path="/calendar/{connection_id}/event/{id}" -->
1556
- ```typescript
1557
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1558
-
1559
- const unifiedTo = new UnifiedTo({
1560
- security: {
1561
- jwt: "<YOUR_API_KEY_HERE>",
1562
- },
1563
- });
1564
-
1565
- async function run() {
1566
- const result = await unifiedTo.calendar.updateCalendarEvent({
1567
- calendarEvent: {},
1568
- connectionId: "<id>",
1569
- id: "<id>",
1570
- });
1571
-
1572
- console.log(result);
1573
- }
1574
-
1575
- run();
1576
- ```
1577
-
1578
- ### Standalone function
1579
-
1580
- The standalone function version of this method:
1581
-
1582
- ```typescript
1583
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1584
- import { calendarUpdateCalendarEvent } from "@unified-api/typescript-sdk/funcs/calendarUpdateCalendarEvent.js";
1585
-
1586
- // Use `UnifiedToCore` for best tree-shaking performance.
1587
- // You can create one instance of it to use across an application.
1588
- const unifiedTo = new UnifiedToCore({
1589
- security: {
1590
- jwt: "<YOUR_API_KEY_HERE>",
1591
- },
1592
- });
1593
-
1594
- async function run() {
1595
- const res = await calendarUpdateCalendarEvent(unifiedTo, {
1596
- calendarEvent: {},
1597
- connectionId: "<id>",
1598
- id: "<id>",
1599
- });
1600
- if (res.ok) {
1601
- const { value: result } = res;
1602
- console.log(result);
1603
- } else {
1604
- console.log("calendarUpdateCalendarEvent failed:", res.error);
1605
- }
1606
- }
1607
-
1608
- run();
1609
- ```
1610
-
1611
- ### Parameters
1612
-
1613
- | Parameter | Type | Required | Description |
1614
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1615
- | `request` | [operations.UpdateCalendarEventRequest](../../sdk/models/operations/updatecalendareventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1616
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1617
- | `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. |
1618
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1619
-
1620
- ### Response
1621
-
1622
- **Promise\<[shared.CalendarEvent](../../sdk/models/shared/calendarevent.md)\>**
1623
-
1624
- ### Errors
1625
-
1626
- | Error Type | Status Code | Content Type |
1627
- | --------------- | --------------- | --------------- |
1628
- | errors.SDKError | 4XX, 5XX | \*/\* |
1629
-
1630
- ## updateCalendarLink
1631
-
1632
- Update a link
1633
-
1634
- ### Example Usage
1635
-
1636
- <!-- UsageSnippet language="typescript" operationID="updateCalendarLink" method="put" path="/calendar/{connection_id}/link/{id}" -->
1637
- ```typescript
1638
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1639
-
1640
- const unifiedTo = new UnifiedTo({
1641
- security: {
1642
- jwt: "<YOUR_API_KEY_HERE>",
1643
- },
1644
- });
1645
-
1646
- async function run() {
1647
- const result = await unifiedTo.calendar.updateCalendarLink({
1648
- calendarLink: {
1649
- url: "https://partial-hydrocarbon.info",
1650
- },
1651
- connectionId: "<id>",
1652
- id: "<id>",
1653
- });
1654
-
1655
- console.log(result);
1656
- }
1657
-
1658
- run();
1659
- ```
1660
-
1661
- ### Standalone function
1662
-
1663
- The standalone function version of this method:
1664
-
1665
- ```typescript
1666
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1667
- import { calendarUpdateCalendarLink } from "@unified-api/typescript-sdk/funcs/calendarUpdateCalendarLink.js";
1668
-
1669
- // Use `UnifiedToCore` for best tree-shaking performance.
1670
- // You can create one instance of it to use across an application.
1671
- const unifiedTo = new UnifiedToCore({
1672
- security: {
1673
- jwt: "<YOUR_API_KEY_HERE>",
1674
- },
1675
- });
1676
-
1677
- async function run() {
1678
- const res = await calendarUpdateCalendarLink(unifiedTo, {
1679
- calendarLink: {
1680
- url: "https://partial-hydrocarbon.info",
1681
- },
1682
- connectionId: "<id>",
1683
- id: "<id>",
1684
- });
1685
- if (res.ok) {
1686
- const { value: result } = res;
1687
- console.log(result);
1688
- } else {
1689
- console.log("calendarUpdateCalendarLink failed:", res.error);
1690
- }
1691
- }
1692
-
1693
- run();
1694
- ```
1695
-
1696
- ### Parameters
1697
-
1698
- | Parameter | Type | Required | Description |
1699
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1700
- | `request` | [operations.UpdateCalendarLinkRequest](../../sdk/models/operations/updatecalendarlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1701
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1702
- | `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. |
1703
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1704
-
1705
- ### Response
1706
-
1707
- **Promise\<[shared.CalendarLink](../../sdk/models/shared/calendarlink.md)\>**
1708
-
1709
- ### Errors
1710
-
1711
- | Error Type | Status Code | Content Type |
1712
- | --------------- | --------------- | --------------- |
1713
- | errors.SDKError | 4XX, 5XX | \*/\* |