@unified-api/typescript-sdk 2.9.3 → 2.9.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/FUNCTIONS.md +108 -0
  2. package/README.md +36 -15
  3. package/RUNTIMES.md +22 -0
  4. package/docs/sdks/account/README.md +501 -0
  5. package/docs/sdks/accounting/README.md +3629 -0
  6. package/docs/sdks/activity/README.md +501 -0
  7. package/docs/sdks/apicall/README.md +165 -0
  8. package/docs/sdks/application/README.md +501 -0
  9. package/docs/sdks/applicationstatus/README.md +88 -0
  10. package/docs/sdks/ats/README.md +3710 -0
  11. package/docs/sdks/auth/README.md +173 -0
  12. package/docs/sdks/branch/README.md +501 -0
  13. package/docs/sdks/call/README.md +88 -0
  14. package/docs/sdks/candidate/README.md +501 -0
  15. package/docs/sdks/channel/README.md +171 -0
  16. package/docs/sdks/class/README.md +501 -0
  17. package/docs/sdks/collection/README.md +501 -0
  18. package/docs/sdks/commerce/README.md +2477 -0
  19. package/docs/sdks/commit/README.md +501 -0
  20. package/docs/sdks/company/README.md +1240 -0
  21. package/docs/sdks/connection/README.md +485 -0
  22. package/docs/sdks/contact/README.md +1489 -0
  23. package/docs/sdks/course/README.md +501 -0
  24. package/docs/sdks/crm/README.md +2971 -0
  25. package/docs/sdks/customer/README.md +501 -0
  26. package/docs/sdks/deal/README.md +501 -0
  27. package/docs/sdks/document/README.md +501 -0
  28. package/docs/sdks/employee/README.md +501 -0
  29. package/docs/sdks/enrich/README.md +169 -0
  30. package/docs/sdks/event/README.md +501 -0
  31. package/docs/sdks/file/README.md +501 -0
  32. package/docs/sdks/genai/README.md +169 -0
  33. package/docs/sdks/group/README.md +995 -0
  34. package/docs/sdks/hris/README.md +2311 -0
  35. package/docs/sdks/instructor/README.md +501 -0
  36. package/docs/sdks/integration/README.md +248 -0
  37. package/docs/sdks/interview/README.md +501 -0
  38. package/docs/sdks/inventory/README.md +501 -0
  39. package/docs/sdks/invoice/README.md +501 -0
  40. package/docs/sdks/issue/README.md +84 -0
  41. package/docs/sdks/item/README.md +501 -0
  42. package/docs/sdks/job/README.md +501 -0
  43. package/docs/sdks/journal/README.md +501 -0
  44. package/docs/sdks/kms/README.md +995 -0
  45. package/docs/sdks/lead/README.md +501 -0
  46. package/docs/sdks/link/README.md +501 -0
  47. package/docs/sdks/list/README.md +501 -0
  48. package/docs/sdks/lms/README.md +1983 -0
  49. package/docs/sdks/location/README.md +995 -0
  50. package/docs/sdks/login/README.md +90 -0
  51. package/docs/sdks/martech/README.md +995 -0
  52. package/docs/sdks/member/README.md +501 -0
  53. package/docs/sdks/message/README.md +501 -0
  54. package/docs/sdks/messaging/README.md +665 -0
  55. package/docs/sdks/metadata/README.md +501 -0
  56. package/docs/sdks/model/README.md +88 -0
  57. package/docs/sdks/note/README.md +501 -0
  58. package/docs/sdks/order/README.md +501 -0
  59. package/docs/sdks/organization/README.md +665 -0
  60. package/docs/sdks/page/README.md +501 -0
  61. package/docs/sdks/passthrough/README.md +671 -0
  62. package/docs/sdks/payment/README.md +1323 -0
  63. package/docs/sdks/payout/README.md +171 -0
  64. package/docs/sdks/payslip/README.md +171 -0
  65. package/docs/sdks/person/README.md +88 -0
  66. package/docs/sdks/pipeline/README.md +501 -0
  67. package/docs/sdks/project/README.md +501 -0
  68. package/docs/sdks/prompt/README.md +88 -0
  69. package/docs/sdks/pullrequest/README.md +501 -0
  70. package/docs/sdks/refund/README.md +171 -0
  71. package/docs/sdks/repo/README.md +2477 -0
  72. package/docs/sdks/repository/README.md +501 -0
  73. package/docs/sdks/scim/README.md +995 -0
  74. package/docs/sdks/scorecard/README.md +501 -0
  75. package/docs/sdks/space/README.md +501 -0
  76. package/docs/sdks/storage/README.md +501 -0
  77. package/docs/sdks/student/README.md +501 -0
  78. package/docs/sdks/task/README.md +995 -0
  79. package/docs/sdks/taxrate/README.md +501 -0
  80. package/docs/sdks/ticket/README.md +501 -0
  81. package/docs/sdks/ticketing/README.md +1489 -0
  82. package/docs/sdks/timeoff/README.md +171 -0
  83. package/docs/sdks/transaction/README.md +501 -0
  84. package/docs/sdks/uc/README.md +582 -0
  85. package/docs/sdks/unified/README.md +1601 -0
  86. package/docs/sdks/unifiedto/README.md +7 -0
  87. package/docs/sdks/user/README.md +501 -0
  88. package/docs/sdks/webhook/README.md +647 -0
  89. package/lib/config.d.ts +3 -3
  90. package/lib/config.js +3 -3
  91. package/lib/primitives.d.ts +2 -0
  92. package/lib/primitives.d.ts.map +1 -1
  93. package/lib/primitives.js +53 -0
  94. package/lib/primitives.js.map +1 -1
  95. package/package.json +3 -1
  96. package/sdk/models/shared/index.d.ts +1 -0
  97. package/sdk/models/shared/index.d.ts.map +1 -1
  98. package/sdk/models/shared/index.js +1 -0
  99. package/sdk/models/shared/index.js.map +1 -1
  100. package/sdk/models/shared/kmspage.d.ts +5 -0
  101. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  102. package/sdk/models/shared/kmspage.js +7 -0
  103. package/sdk/models/shared/kmspage.js.map +1 -1
  104. package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
  105. package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
  106. package/sdk/models/shared/kmspagemetadata.js +63 -0
  107. package/sdk/models/shared/kmspagemetadata.js.map +1 -0
  108. package/sdk/models/shared/kmsspace.d.ts +2 -0
  109. package/sdk/models/shared/kmsspace.d.ts.map +1 -1
  110. package/sdk/models/shared/kmsspace.js +4 -0
  111. package/sdk/models/shared/kmsspace.js.map +1 -1
  112. package/sdk/models/shared/security.d.ts +2 -2
  113. package/sdk/models/shared/security.d.ts.map +1 -1
  114. package/sdk/models/shared/security.js +2 -2
  115. package/sdk/models/shared/security.js.map +1 -1
  116. package/sdk/types/operations.d.ts +5 -3
  117. package/sdk/types/operations.d.ts.map +1 -1
  118. package/sdk/types/operations.js +3 -0
  119. package/sdk/types/operations.js.map +1 -1
  120. package/src/lib/config.ts +3 -3
  121. package/src/lib/primitives.ts +62 -0
  122. package/src/sdk/models/shared/index.ts +1 -0
  123. package/src/sdk/models/shared/kmspage.ts +16 -0
  124. package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
  125. package/src/sdk/models/shared/kmsspace.ts +6 -0
  126. package/src/sdk/models/shared/security.ts +4 -4
  127. package/src/sdk/types/operations.ts +11 -5
@@ -0,0 +1,1240 @@
1
+ # Company
2
+ (*company*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [createCrmCompany](#createcrmcompany) - Create a company
9
+ * [createHrisCompany](#createhriscompany) - Create a company
10
+ * [getAtsCompany](#getatscompany) - Retrieve a company
11
+ * [getCrmCompany](#getcrmcompany) - Retrieve a company
12
+ * [getHrisCompany](#gethriscompany) - Retrieve a company
13
+ * [listAtsCompanies](#listatscompanies) - List all companies
14
+ * [listCrmCompanies](#listcrmcompanies) - List all companies
15
+ * [listEnrichCompanies](#listenrichcompanies) - Retrieve enrichment information for a company
16
+ * [listHrisCompanies](#listhriscompanies) - List all companies
17
+ * [patchCrmCompany](#patchcrmcompany) - Update a company
18
+ * [patchHrisCompany](#patchhriscompany) - Update a company
19
+ * [removeCrmCompany](#removecrmcompany) - Remove a company
20
+ * [removeHrisCompany](#removehriscompany) - Remove a company
21
+ * [updateCrmCompany](#updatecrmcompany) - Update a company
22
+ * [updateHrisCompany](#updatehriscompany) - Update a company
23
+
24
+ ## createCrmCompany
25
+
26
+ Create a company
27
+
28
+ ### Example Usage
29
+
30
+ ```typescript
31
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
32
+
33
+ const unifiedTo = new UnifiedTo({
34
+ security: {
35
+ jwt: "<YOUR_API_KEY_HERE>",
36
+ },
37
+ });
38
+
39
+ async function run() {
40
+ const result = await unifiedTo.company.createCrmCompany({
41
+ connectionId: "<value>",
42
+ });
43
+
44
+ // Handle the result
45
+ console.log(result);
46
+ }
47
+
48
+ run();
49
+ ```
50
+
51
+ ### Standalone function
52
+
53
+ The standalone function version of this method:
54
+
55
+ ```typescript
56
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
57
+ import { companyCreateCrmCompany } from "@unified-api/typescript-sdk/funcs/companyCreateCrmCompany.js";
58
+
59
+ // Use `UnifiedToCore` for best tree-shaking performance.
60
+ // You can create one instance of it to use across an application.
61
+ const unifiedTo = new UnifiedToCore({
62
+ security: {
63
+ jwt: "<YOUR_API_KEY_HERE>",
64
+ },
65
+ });
66
+
67
+ async function run() {
68
+ const res = await companyCreateCrmCompany(unifiedTo, {
69
+ connectionId: "<value>",
70
+ });
71
+
72
+ if (!res.ok) {
73
+ throw res.error;
74
+ }
75
+
76
+ const { value: result } = res;
77
+
78
+ // Handle the result
79
+ console.log(result);
80
+ }
81
+
82
+ run();
83
+ ```
84
+
85
+ ### Parameters
86
+
87
+ | Parameter | Type | Required | Description |
88
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
89
+ | `request` | [operations.CreateCrmCompanyRequest](../../sdk/models/operations/createcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
90
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
91
+ | `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. |
92
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
93
+
94
+ ### Response
95
+
96
+ **Promise\<[shared.CrmCompany](../../sdk/models/shared/crmcompany.md)\>**
97
+
98
+ ### Errors
99
+
100
+ | Error Type | Status Code | Content Type |
101
+ | --------------- | --------------- | --------------- |
102
+ | errors.SDKError | 4XX, 5XX | \*/\* |
103
+
104
+ ## createHrisCompany
105
+
106
+ Create a company
107
+
108
+ ### Example Usage
109
+
110
+ ```typescript
111
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
112
+
113
+ const unifiedTo = new UnifiedTo({
114
+ security: {
115
+ jwt: "<YOUR_API_KEY_HERE>",
116
+ },
117
+ });
118
+
119
+ async function run() {
120
+ const result = await unifiedTo.company.createHrisCompany({
121
+ connectionId: "<value>",
122
+ });
123
+
124
+ // Handle the result
125
+ console.log(result);
126
+ }
127
+
128
+ run();
129
+ ```
130
+
131
+ ### Standalone function
132
+
133
+ The standalone function version of this method:
134
+
135
+ ```typescript
136
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
137
+ import { companyCreateHrisCompany } from "@unified-api/typescript-sdk/funcs/companyCreateHrisCompany.js";
138
+
139
+ // Use `UnifiedToCore` for best tree-shaking performance.
140
+ // You can create one instance of it to use across an application.
141
+ const unifiedTo = new UnifiedToCore({
142
+ security: {
143
+ jwt: "<YOUR_API_KEY_HERE>",
144
+ },
145
+ });
146
+
147
+ async function run() {
148
+ const res = await companyCreateHrisCompany(unifiedTo, {
149
+ connectionId: "<value>",
150
+ });
151
+
152
+ if (!res.ok) {
153
+ throw res.error;
154
+ }
155
+
156
+ const { value: result } = res;
157
+
158
+ // Handle the result
159
+ console.log(result);
160
+ }
161
+
162
+ run();
163
+ ```
164
+
165
+ ### Parameters
166
+
167
+ | Parameter | Type | Required | Description |
168
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
169
+ | `request` | [operations.CreateHrisCompanyRequest](../../sdk/models/operations/createhriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
170
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
171
+ | `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. |
172
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
173
+
174
+ ### Response
175
+
176
+ **Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
177
+
178
+ ### Errors
179
+
180
+ | Error Type | Status Code | Content Type |
181
+ | --------------- | --------------- | --------------- |
182
+ | errors.SDKError | 4XX, 5XX | \*/\* |
183
+
184
+ ## getAtsCompany
185
+
186
+ Retrieve a company
187
+
188
+ ### Example Usage
189
+
190
+ ```typescript
191
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
192
+
193
+ const unifiedTo = new UnifiedTo({
194
+ security: {
195
+ jwt: "<YOUR_API_KEY_HERE>",
196
+ },
197
+ });
198
+
199
+ async function run() {
200
+ const result = await unifiedTo.company.getAtsCompany({
201
+ connectionId: "<value>",
202
+ id: "<id>",
203
+ });
204
+
205
+ // Handle the result
206
+ console.log(result);
207
+ }
208
+
209
+ run();
210
+ ```
211
+
212
+ ### Standalone function
213
+
214
+ The standalone function version of this method:
215
+
216
+ ```typescript
217
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
218
+ import { companyGetAtsCompany } from "@unified-api/typescript-sdk/funcs/companyGetAtsCompany.js";
219
+
220
+ // Use `UnifiedToCore` for best tree-shaking performance.
221
+ // You can create one instance of it to use across an application.
222
+ const unifiedTo = new UnifiedToCore({
223
+ security: {
224
+ jwt: "<YOUR_API_KEY_HERE>",
225
+ },
226
+ });
227
+
228
+ async function run() {
229
+ const res = await companyGetAtsCompany(unifiedTo, {
230
+ connectionId: "<value>",
231
+ id: "<id>",
232
+ });
233
+
234
+ if (!res.ok) {
235
+ throw res.error;
236
+ }
237
+
238
+ const { value: result } = res;
239
+
240
+ // Handle the result
241
+ console.log(result);
242
+ }
243
+
244
+ run();
245
+ ```
246
+
247
+ ### Parameters
248
+
249
+ | Parameter | Type | Required | Description |
250
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
251
+ | `request` | [operations.GetAtsCompanyRequest](../../sdk/models/operations/getatscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
252
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
253
+ | `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. |
254
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
255
+
256
+ ### Response
257
+
258
+ **Promise\<[shared.AtsCompany](../../sdk/models/shared/atscompany.md)\>**
259
+
260
+ ### Errors
261
+
262
+ | Error Type | Status Code | Content Type |
263
+ | --------------- | --------------- | --------------- |
264
+ | errors.SDKError | 4XX, 5XX | \*/\* |
265
+
266
+ ## getCrmCompany
267
+
268
+ Retrieve a company
269
+
270
+ ### Example Usage
271
+
272
+ ```typescript
273
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
274
+
275
+ const unifiedTo = new UnifiedTo({
276
+ security: {
277
+ jwt: "<YOUR_API_KEY_HERE>",
278
+ },
279
+ });
280
+
281
+ async function run() {
282
+ const result = await unifiedTo.company.getCrmCompany({
283
+ connectionId: "<value>",
284
+ id: "<id>",
285
+ });
286
+
287
+ // Handle the result
288
+ console.log(result);
289
+ }
290
+
291
+ run();
292
+ ```
293
+
294
+ ### Standalone function
295
+
296
+ The standalone function version of this method:
297
+
298
+ ```typescript
299
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
300
+ import { companyGetCrmCompany } from "@unified-api/typescript-sdk/funcs/companyGetCrmCompany.js";
301
+
302
+ // Use `UnifiedToCore` for best tree-shaking performance.
303
+ // You can create one instance of it to use across an application.
304
+ const unifiedTo = new UnifiedToCore({
305
+ security: {
306
+ jwt: "<YOUR_API_KEY_HERE>",
307
+ },
308
+ });
309
+
310
+ async function run() {
311
+ const res = await companyGetCrmCompany(unifiedTo, {
312
+ connectionId: "<value>",
313
+ id: "<id>",
314
+ });
315
+
316
+ if (!res.ok) {
317
+ throw res.error;
318
+ }
319
+
320
+ const { value: result } = res;
321
+
322
+ // Handle the result
323
+ console.log(result);
324
+ }
325
+
326
+ run();
327
+ ```
328
+
329
+ ### Parameters
330
+
331
+ | Parameter | Type | Required | Description |
332
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
333
+ | `request` | [operations.GetCrmCompanyRequest](../../sdk/models/operations/getcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
334
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
335
+ | `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. |
336
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
337
+
338
+ ### Response
339
+
340
+ **Promise\<[shared.CrmCompany](../../sdk/models/shared/crmcompany.md)\>**
341
+
342
+ ### Errors
343
+
344
+ | Error Type | Status Code | Content Type |
345
+ | --------------- | --------------- | --------------- |
346
+ | errors.SDKError | 4XX, 5XX | \*/\* |
347
+
348
+ ## getHrisCompany
349
+
350
+ Retrieve a company
351
+
352
+ ### Example Usage
353
+
354
+ ```typescript
355
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
356
+
357
+ const unifiedTo = new UnifiedTo({
358
+ security: {
359
+ jwt: "<YOUR_API_KEY_HERE>",
360
+ },
361
+ });
362
+
363
+ async function run() {
364
+ const result = await unifiedTo.company.getHrisCompany({
365
+ connectionId: "<value>",
366
+ id: "<id>",
367
+ });
368
+
369
+ // Handle the result
370
+ console.log(result);
371
+ }
372
+
373
+ run();
374
+ ```
375
+
376
+ ### Standalone function
377
+
378
+ The standalone function version of this method:
379
+
380
+ ```typescript
381
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
382
+ import { companyGetHrisCompany } from "@unified-api/typescript-sdk/funcs/companyGetHrisCompany.js";
383
+
384
+ // Use `UnifiedToCore` for best tree-shaking performance.
385
+ // You can create one instance of it to use across an application.
386
+ const unifiedTo = new UnifiedToCore({
387
+ security: {
388
+ jwt: "<YOUR_API_KEY_HERE>",
389
+ },
390
+ });
391
+
392
+ async function run() {
393
+ const res = await companyGetHrisCompany(unifiedTo, {
394
+ connectionId: "<value>",
395
+ id: "<id>",
396
+ });
397
+
398
+ if (!res.ok) {
399
+ throw res.error;
400
+ }
401
+
402
+ const { value: result } = res;
403
+
404
+ // Handle the result
405
+ console.log(result);
406
+ }
407
+
408
+ run();
409
+ ```
410
+
411
+ ### Parameters
412
+
413
+ | Parameter | Type | Required | Description |
414
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
415
+ | `request` | [operations.GetHrisCompanyRequest](../../sdk/models/operations/gethriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
416
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
417
+ | `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. |
418
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
419
+
420
+ ### Response
421
+
422
+ **Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
423
+
424
+ ### Errors
425
+
426
+ | Error Type | Status Code | Content Type |
427
+ | --------------- | --------------- | --------------- |
428
+ | errors.SDKError | 4XX, 5XX | \*/\* |
429
+
430
+ ## listAtsCompanies
431
+
432
+ List all companies
433
+
434
+ ### Example Usage
435
+
436
+ ```typescript
437
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
438
+
439
+ const unifiedTo = new UnifiedTo({
440
+ security: {
441
+ jwt: "<YOUR_API_KEY_HERE>",
442
+ },
443
+ });
444
+
445
+ async function run() {
446
+ const result = await unifiedTo.company.listAtsCompanies({
447
+ connectionId: "<value>",
448
+ });
449
+
450
+ // Handle the result
451
+ console.log(result);
452
+ }
453
+
454
+ run();
455
+ ```
456
+
457
+ ### Standalone function
458
+
459
+ The standalone function version of this method:
460
+
461
+ ```typescript
462
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
463
+ import { companyListAtsCompanies } from "@unified-api/typescript-sdk/funcs/companyListAtsCompanies.js";
464
+
465
+ // Use `UnifiedToCore` for best tree-shaking performance.
466
+ // You can create one instance of it to use across an application.
467
+ const unifiedTo = new UnifiedToCore({
468
+ security: {
469
+ jwt: "<YOUR_API_KEY_HERE>",
470
+ },
471
+ });
472
+
473
+ async function run() {
474
+ const res = await companyListAtsCompanies(unifiedTo, {
475
+ connectionId: "<value>",
476
+ });
477
+
478
+ if (!res.ok) {
479
+ throw res.error;
480
+ }
481
+
482
+ const { value: result } = res;
483
+
484
+ // Handle the result
485
+ console.log(result);
486
+ }
487
+
488
+ run();
489
+ ```
490
+
491
+ ### Parameters
492
+
493
+ | Parameter | Type | Required | Description |
494
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
495
+ | `request` | [operations.ListAtsCompaniesRequest](../../sdk/models/operations/listatscompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
496
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
497
+ | `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. |
498
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
499
+
500
+ ### Response
501
+
502
+ **Promise\<[shared.AtsCompany[]](../../models/.md)\>**
503
+
504
+ ### Errors
505
+
506
+ | Error Type | Status Code | Content Type |
507
+ | --------------- | --------------- | --------------- |
508
+ | errors.SDKError | 4XX, 5XX | \*/\* |
509
+
510
+ ## listCrmCompanies
511
+
512
+ List all companies
513
+
514
+ ### Example Usage
515
+
516
+ ```typescript
517
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
518
+
519
+ const unifiedTo = new UnifiedTo({
520
+ security: {
521
+ jwt: "<YOUR_API_KEY_HERE>",
522
+ },
523
+ });
524
+
525
+ async function run() {
526
+ const result = await unifiedTo.company.listCrmCompanies({
527
+ connectionId: "<value>",
528
+ });
529
+
530
+ // Handle the result
531
+ console.log(result);
532
+ }
533
+
534
+ run();
535
+ ```
536
+
537
+ ### Standalone function
538
+
539
+ The standalone function version of this method:
540
+
541
+ ```typescript
542
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
543
+ import { companyListCrmCompanies } from "@unified-api/typescript-sdk/funcs/companyListCrmCompanies.js";
544
+
545
+ // Use `UnifiedToCore` for best tree-shaking performance.
546
+ // You can create one instance of it to use across an application.
547
+ const unifiedTo = new UnifiedToCore({
548
+ security: {
549
+ jwt: "<YOUR_API_KEY_HERE>",
550
+ },
551
+ });
552
+
553
+ async function run() {
554
+ const res = await companyListCrmCompanies(unifiedTo, {
555
+ connectionId: "<value>",
556
+ });
557
+
558
+ if (!res.ok) {
559
+ throw res.error;
560
+ }
561
+
562
+ const { value: result } = res;
563
+
564
+ // Handle the result
565
+ console.log(result);
566
+ }
567
+
568
+ run();
569
+ ```
570
+
571
+ ### Parameters
572
+
573
+ | Parameter | Type | Required | Description |
574
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
575
+ | `request` | [operations.ListCrmCompaniesRequest](../../sdk/models/operations/listcrmcompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
576
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
577
+ | `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. |
578
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
579
+
580
+ ### Response
581
+
582
+ **Promise\<[shared.CrmCompany[]](../../models/.md)\>**
583
+
584
+ ### Errors
585
+
586
+ | Error Type | Status Code | Content Type |
587
+ | --------------- | --------------- | --------------- |
588
+ | errors.SDKError | 4XX, 5XX | \*/\* |
589
+
590
+ ## listEnrichCompanies
591
+
592
+ Retrieve enrichment information for a company
593
+
594
+ ### Example Usage
595
+
596
+ ```typescript
597
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
598
+
599
+ const unifiedTo = new UnifiedTo({
600
+ security: {
601
+ jwt: "<YOUR_API_KEY_HERE>",
602
+ },
603
+ });
604
+
605
+ async function run() {
606
+ const result = await unifiedTo.company.listEnrichCompanies({
607
+ connectionId: "<value>",
608
+ });
609
+
610
+ // Handle the result
611
+ console.log(result);
612
+ }
613
+
614
+ run();
615
+ ```
616
+
617
+ ### Standalone function
618
+
619
+ The standalone function version of this method:
620
+
621
+ ```typescript
622
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
623
+ import { companyListEnrichCompanies } from "@unified-api/typescript-sdk/funcs/companyListEnrichCompanies.js";
624
+
625
+ // Use `UnifiedToCore` for best tree-shaking performance.
626
+ // You can create one instance of it to use across an application.
627
+ const unifiedTo = new UnifiedToCore({
628
+ security: {
629
+ jwt: "<YOUR_API_KEY_HERE>",
630
+ },
631
+ });
632
+
633
+ async function run() {
634
+ const res = await companyListEnrichCompanies(unifiedTo, {
635
+ connectionId: "<value>",
636
+ });
637
+
638
+ if (!res.ok) {
639
+ throw res.error;
640
+ }
641
+
642
+ const { value: result } = res;
643
+
644
+ // Handle the result
645
+ console.log(result);
646
+ }
647
+
648
+ run();
649
+ ```
650
+
651
+ ### Parameters
652
+
653
+ | Parameter | Type | Required | Description |
654
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
655
+ | `request` | [operations.ListEnrichCompaniesRequest](../../sdk/models/operations/listenrichcompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
656
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
657
+ | `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. |
658
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
659
+
660
+ ### Response
661
+
662
+ **Promise\<[shared.EnrichCompany](../../sdk/models/shared/enrichcompany.md)\>**
663
+
664
+ ### Errors
665
+
666
+ | Error Type | Status Code | Content Type |
667
+ | --------------- | --------------- | --------------- |
668
+ | errors.SDKError | 4XX, 5XX | \*/\* |
669
+
670
+ ## listHrisCompanies
671
+
672
+ List all companies
673
+
674
+ ### Example Usage
675
+
676
+ ```typescript
677
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
678
+
679
+ const unifiedTo = new UnifiedTo({
680
+ security: {
681
+ jwt: "<YOUR_API_KEY_HERE>",
682
+ },
683
+ });
684
+
685
+ async function run() {
686
+ const result = await unifiedTo.company.listHrisCompanies({
687
+ connectionId: "<value>",
688
+ });
689
+
690
+ // Handle the result
691
+ console.log(result);
692
+ }
693
+
694
+ run();
695
+ ```
696
+
697
+ ### Standalone function
698
+
699
+ The standalone function version of this method:
700
+
701
+ ```typescript
702
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
703
+ import { companyListHrisCompanies } from "@unified-api/typescript-sdk/funcs/companyListHrisCompanies.js";
704
+
705
+ // Use `UnifiedToCore` for best tree-shaking performance.
706
+ // You can create one instance of it to use across an application.
707
+ const unifiedTo = new UnifiedToCore({
708
+ security: {
709
+ jwt: "<YOUR_API_KEY_HERE>",
710
+ },
711
+ });
712
+
713
+ async function run() {
714
+ const res = await companyListHrisCompanies(unifiedTo, {
715
+ connectionId: "<value>",
716
+ });
717
+
718
+ if (!res.ok) {
719
+ throw res.error;
720
+ }
721
+
722
+ const { value: result } = res;
723
+
724
+ // Handle the result
725
+ console.log(result);
726
+ }
727
+
728
+ run();
729
+ ```
730
+
731
+ ### Parameters
732
+
733
+ | Parameter | Type | Required | Description |
734
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
735
+ | `request` | [operations.ListHrisCompaniesRequest](../../sdk/models/operations/listhriscompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
736
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
737
+ | `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. |
738
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
739
+
740
+ ### Response
741
+
742
+ **Promise\<[shared.HrisCompany[]](../../models/.md)\>**
743
+
744
+ ### Errors
745
+
746
+ | Error Type | Status Code | Content Type |
747
+ | --------------- | --------------- | --------------- |
748
+ | errors.SDKError | 4XX, 5XX | \*/\* |
749
+
750
+ ## patchCrmCompany
751
+
752
+ Update a company
753
+
754
+ ### Example Usage
755
+
756
+ ```typescript
757
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
758
+
759
+ const unifiedTo = new UnifiedTo({
760
+ security: {
761
+ jwt: "<YOUR_API_KEY_HERE>",
762
+ },
763
+ });
764
+
765
+ async function run() {
766
+ const result = await unifiedTo.company.patchCrmCompany({
767
+ connectionId: "<value>",
768
+ id: "<id>",
769
+ });
770
+
771
+ // Handle the result
772
+ console.log(result);
773
+ }
774
+
775
+ run();
776
+ ```
777
+
778
+ ### Standalone function
779
+
780
+ The standalone function version of this method:
781
+
782
+ ```typescript
783
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
784
+ import { companyPatchCrmCompany } from "@unified-api/typescript-sdk/funcs/companyPatchCrmCompany.js";
785
+
786
+ // Use `UnifiedToCore` for best tree-shaking performance.
787
+ // You can create one instance of it to use across an application.
788
+ const unifiedTo = new UnifiedToCore({
789
+ security: {
790
+ jwt: "<YOUR_API_KEY_HERE>",
791
+ },
792
+ });
793
+
794
+ async function run() {
795
+ const res = await companyPatchCrmCompany(unifiedTo, {
796
+ connectionId: "<value>",
797
+ id: "<id>",
798
+ });
799
+
800
+ if (!res.ok) {
801
+ throw res.error;
802
+ }
803
+
804
+ const { value: result } = res;
805
+
806
+ // Handle the result
807
+ console.log(result);
808
+ }
809
+
810
+ run();
811
+ ```
812
+
813
+ ### Parameters
814
+
815
+ | Parameter | Type | Required | Description |
816
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
817
+ | `request` | [operations.PatchCrmCompanyRequest](../../sdk/models/operations/patchcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
818
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
819
+ | `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. |
820
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
821
+
822
+ ### Response
823
+
824
+ **Promise\<[shared.CrmCompany](../../sdk/models/shared/crmcompany.md)\>**
825
+
826
+ ### Errors
827
+
828
+ | Error Type | Status Code | Content Type |
829
+ | --------------- | --------------- | --------------- |
830
+ | errors.SDKError | 4XX, 5XX | \*/\* |
831
+
832
+ ## patchHrisCompany
833
+
834
+ Update a company
835
+
836
+ ### Example Usage
837
+
838
+ ```typescript
839
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
840
+
841
+ const unifiedTo = new UnifiedTo({
842
+ security: {
843
+ jwt: "<YOUR_API_KEY_HERE>",
844
+ },
845
+ });
846
+
847
+ async function run() {
848
+ const result = await unifiedTo.company.patchHrisCompany({
849
+ connectionId: "<value>",
850
+ id: "<id>",
851
+ });
852
+
853
+ // Handle the result
854
+ console.log(result);
855
+ }
856
+
857
+ run();
858
+ ```
859
+
860
+ ### Standalone function
861
+
862
+ The standalone function version of this method:
863
+
864
+ ```typescript
865
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
866
+ import { companyPatchHrisCompany } from "@unified-api/typescript-sdk/funcs/companyPatchHrisCompany.js";
867
+
868
+ // Use `UnifiedToCore` for best tree-shaking performance.
869
+ // You can create one instance of it to use across an application.
870
+ const unifiedTo = new UnifiedToCore({
871
+ security: {
872
+ jwt: "<YOUR_API_KEY_HERE>",
873
+ },
874
+ });
875
+
876
+ async function run() {
877
+ const res = await companyPatchHrisCompany(unifiedTo, {
878
+ connectionId: "<value>",
879
+ id: "<id>",
880
+ });
881
+
882
+ if (!res.ok) {
883
+ throw res.error;
884
+ }
885
+
886
+ const { value: result } = res;
887
+
888
+ // Handle the result
889
+ console.log(result);
890
+ }
891
+
892
+ run();
893
+ ```
894
+
895
+ ### Parameters
896
+
897
+ | Parameter | Type | Required | Description |
898
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
899
+ | `request` | [operations.PatchHrisCompanyRequest](../../sdk/models/operations/patchhriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
900
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
901
+ | `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. |
902
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
903
+
904
+ ### Response
905
+
906
+ **Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
907
+
908
+ ### Errors
909
+
910
+ | Error Type | Status Code | Content Type |
911
+ | --------------- | --------------- | --------------- |
912
+ | errors.SDKError | 4XX, 5XX | \*/\* |
913
+
914
+ ## removeCrmCompany
915
+
916
+ Remove a company
917
+
918
+ ### Example Usage
919
+
920
+ ```typescript
921
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
922
+
923
+ const unifiedTo = new UnifiedTo({
924
+ security: {
925
+ jwt: "<YOUR_API_KEY_HERE>",
926
+ },
927
+ });
928
+
929
+ async function run() {
930
+ const result = await unifiedTo.company.removeCrmCompany({
931
+ connectionId: "<value>",
932
+ id: "<id>",
933
+ });
934
+
935
+ // Handle the result
936
+ console.log(result);
937
+ }
938
+
939
+ run();
940
+ ```
941
+
942
+ ### Standalone function
943
+
944
+ The standalone function version of this method:
945
+
946
+ ```typescript
947
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
948
+ import { companyRemoveCrmCompany } from "@unified-api/typescript-sdk/funcs/companyRemoveCrmCompany.js";
949
+
950
+ // Use `UnifiedToCore` for best tree-shaking performance.
951
+ // You can create one instance of it to use across an application.
952
+ const unifiedTo = new UnifiedToCore({
953
+ security: {
954
+ jwt: "<YOUR_API_KEY_HERE>",
955
+ },
956
+ });
957
+
958
+ async function run() {
959
+ const res = await companyRemoveCrmCompany(unifiedTo, {
960
+ connectionId: "<value>",
961
+ id: "<id>",
962
+ });
963
+
964
+ if (!res.ok) {
965
+ throw res.error;
966
+ }
967
+
968
+ const { value: result } = res;
969
+
970
+ // Handle the result
971
+ console.log(result);
972
+ }
973
+
974
+ run();
975
+ ```
976
+
977
+ ### Parameters
978
+
979
+ | Parameter | Type | Required | Description |
980
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
981
+ | `request` | [operations.RemoveCrmCompanyRequest](../../sdk/models/operations/removecrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
982
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
983
+ | `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. |
984
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
985
+
986
+ ### Response
987
+
988
+ **Promise\<[operations.RemoveCrmCompanyResponse](../../sdk/models/operations/removecrmcompanyresponse.md)\>**
989
+
990
+ ### Errors
991
+
992
+ | Error Type | Status Code | Content Type |
993
+ | --------------- | --------------- | --------------- |
994
+ | errors.SDKError | 4XX, 5XX | \*/\* |
995
+
996
+ ## removeHrisCompany
997
+
998
+ Remove a company
999
+
1000
+ ### Example Usage
1001
+
1002
+ ```typescript
1003
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1004
+
1005
+ const unifiedTo = new UnifiedTo({
1006
+ security: {
1007
+ jwt: "<YOUR_API_KEY_HERE>",
1008
+ },
1009
+ });
1010
+
1011
+ async function run() {
1012
+ const result = await unifiedTo.company.removeHrisCompany({
1013
+ connectionId: "<value>",
1014
+ id: "<id>",
1015
+ });
1016
+
1017
+ // Handle the result
1018
+ console.log(result);
1019
+ }
1020
+
1021
+ run();
1022
+ ```
1023
+
1024
+ ### Standalone function
1025
+
1026
+ The standalone function version of this method:
1027
+
1028
+ ```typescript
1029
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1030
+ import { companyRemoveHrisCompany } from "@unified-api/typescript-sdk/funcs/companyRemoveHrisCompany.js";
1031
+
1032
+ // Use `UnifiedToCore` for best tree-shaking performance.
1033
+ // You can create one instance of it to use across an application.
1034
+ const unifiedTo = new UnifiedToCore({
1035
+ security: {
1036
+ jwt: "<YOUR_API_KEY_HERE>",
1037
+ },
1038
+ });
1039
+
1040
+ async function run() {
1041
+ const res = await companyRemoveHrisCompany(unifiedTo, {
1042
+ connectionId: "<value>",
1043
+ id: "<id>",
1044
+ });
1045
+
1046
+ if (!res.ok) {
1047
+ throw res.error;
1048
+ }
1049
+
1050
+ const { value: result } = res;
1051
+
1052
+ // Handle the result
1053
+ console.log(result);
1054
+ }
1055
+
1056
+ run();
1057
+ ```
1058
+
1059
+ ### Parameters
1060
+
1061
+ | Parameter | Type | Required | Description |
1062
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1063
+ | `request` | [operations.RemoveHrisCompanyRequest](../../sdk/models/operations/removehriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1064
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1065
+ | `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. |
1066
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1067
+
1068
+ ### Response
1069
+
1070
+ **Promise\<[operations.RemoveHrisCompanyResponse](../../sdk/models/operations/removehriscompanyresponse.md)\>**
1071
+
1072
+ ### Errors
1073
+
1074
+ | Error Type | Status Code | Content Type |
1075
+ | --------------- | --------------- | --------------- |
1076
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1077
+
1078
+ ## updateCrmCompany
1079
+
1080
+ Update a company
1081
+
1082
+ ### Example Usage
1083
+
1084
+ ```typescript
1085
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1086
+
1087
+ const unifiedTo = new UnifiedTo({
1088
+ security: {
1089
+ jwt: "<YOUR_API_KEY_HERE>",
1090
+ },
1091
+ });
1092
+
1093
+ async function run() {
1094
+ const result = await unifiedTo.company.updateCrmCompany({
1095
+ connectionId: "<value>",
1096
+ id: "<id>",
1097
+ });
1098
+
1099
+ // Handle the result
1100
+ console.log(result);
1101
+ }
1102
+
1103
+ run();
1104
+ ```
1105
+
1106
+ ### Standalone function
1107
+
1108
+ The standalone function version of this method:
1109
+
1110
+ ```typescript
1111
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1112
+ import { companyUpdateCrmCompany } from "@unified-api/typescript-sdk/funcs/companyUpdateCrmCompany.js";
1113
+
1114
+ // Use `UnifiedToCore` for best tree-shaking performance.
1115
+ // You can create one instance of it to use across an application.
1116
+ const unifiedTo = new UnifiedToCore({
1117
+ security: {
1118
+ jwt: "<YOUR_API_KEY_HERE>",
1119
+ },
1120
+ });
1121
+
1122
+ async function run() {
1123
+ const res = await companyUpdateCrmCompany(unifiedTo, {
1124
+ connectionId: "<value>",
1125
+ id: "<id>",
1126
+ });
1127
+
1128
+ if (!res.ok) {
1129
+ throw res.error;
1130
+ }
1131
+
1132
+ const { value: result } = res;
1133
+
1134
+ // Handle the result
1135
+ console.log(result);
1136
+ }
1137
+
1138
+ run();
1139
+ ```
1140
+
1141
+ ### Parameters
1142
+
1143
+ | Parameter | Type | Required | Description |
1144
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1145
+ | `request` | [operations.UpdateCrmCompanyRequest](../../sdk/models/operations/updatecrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1146
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1147
+ | `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. |
1148
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1149
+
1150
+ ### Response
1151
+
1152
+ **Promise\<[shared.CrmCompany](../../sdk/models/shared/crmcompany.md)\>**
1153
+
1154
+ ### Errors
1155
+
1156
+ | Error Type | Status Code | Content Type |
1157
+ | --------------- | --------------- | --------------- |
1158
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1159
+
1160
+ ## updateHrisCompany
1161
+
1162
+ Update a company
1163
+
1164
+ ### Example Usage
1165
+
1166
+ ```typescript
1167
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1168
+
1169
+ const unifiedTo = new UnifiedTo({
1170
+ security: {
1171
+ jwt: "<YOUR_API_KEY_HERE>",
1172
+ },
1173
+ });
1174
+
1175
+ async function run() {
1176
+ const result = await unifiedTo.company.updateHrisCompany({
1177
+ connectionId: "<value>",
1178
+ id: "<id>",
1179
+ });
1180
+
1181
+ // Handle the result
1182
+ console.log(result);
1183
+ }
1184
+
1185
+ run();
1186
+ ```
1187
+
1188
+ ### Standalone function
1189
+
1190
+ The standalone function version of this method:
1191
+
1192
+ ```typescript
1193
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1194
+ import { companyUpdateHrisCompany } from "@unified-api/typescript-sdk/funcs/companyUpdateHrisCompany.js";
1195
+
1196
+ // Use `UnifiedToCore` for best tree-shaking performance.
1197
+ // You can create one instance of it to use across an application.
1198
+ const unifiedTo = new UnifiedToCore({
1199
+ security: {
1200
+ jwt: "<YOUR_API_KEY_HERE>",
1201
+ },
1202
+ });
1203
+
1204
+ async function run() {
1205
+ const res = await companyUpdateHrisCompany(unifiedTo, {
1206
+ connectionId: "<value>",
1207
+ id: "<id>",
1208
+ });
1209
+
1210
+ if (!res.ok) {
1211
+ throw res.error;
1212
+ }
1213
+
1214
+ const { value: result } = res;
1215
+
1216
+ // Handle the result
1217
+ console.log(result);
1218
+ }
1219
+
1220
+ run();
1221
+ ```
1222
+
1223
+ ### Parameters
1224
+
1225
+ | Parameter | Type | Required | Description |
1226
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1227
+ | `request` | [operations.UpdateHrisCompanyRequest](../../sdk/models/operations/updatehriscompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1228
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1229
+ | `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. |
1230
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1231
+
1232
+ ### Response
1233
+
1234
+ **Promise\<[shared.HrisCompany](../../sdk/models/shared/hriscompany.md)\>**
1235
+
1236
+ ### Errors
1237
+
1238
+ | Error Type | Status Code | Content Type |
1239
+ | --------------- | --------------- | --------------- |
1240
+ | errors.SDKError | 4XX, 5XX | \*/\* |