@unified-api/typescript-sdk 2.73.9 → 2.73.11

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 (273) hide show
  1. package/README.md +15 -3
  2. package/bin/mcp-server.js +4587 -3584
  3. package/bin/mcp-server.js.map +33 -14
  4. package/docs/sdks/account/README.md +6 -0
  5. package/docs/sdks/accounting/README.md +558 -0
  6. package/docs/sdks/activity/README.md +6 -0
  7. package/docs/sdks/apicall/README.md +2 -0
  8. package/docs/sdks/application/README.md +6 -0
  9. package/docs/sdks/applicationstatus/README.md +1 -0
  10. package/docs/sdks/ats/README.md +49 -0
  11. package/docs/sdks/auth/README.md +3 -1
  12. package/docs/sdks/balancesheet/README.md +2 -0
  13. package/docs/sdks/bill/README.md +6 -0
  14. package/docs/sdks/branch/README.md +6 -0
  15. package/docs/sdks/busy/README.md +1 -0
  16. package/docs/sdks/calendar/README.md +21 -0
  17. package/docs/sdks/call/README.md +1 -0
  18. package/docs/sdks/candidate/README.md +6 -0
  19. package/docs/sdks/category/README.md +489 -0
  20. package/docs/sdks/channel/README.md +2 -0
  21. package/docs/sdks/class/README.md +6 -0
  22. package/docs/sdks/collection/README.md +6 -0
  23. package/docs/sdks/comment/README.md +18 -0
  24. package/docs/sdks/commerce/README.md +30 -0
  25. package/docs/sdks/commit/README.md +6 -0
  26. package/docs/sdks/company/README.md +19 -0
  27. package/docs/sdks/connection/README.md +7 -1
  28. package/docs/sdks/contact/README.md +18 -0
  29. package/docs/sdks/course/README.md +6 -0
  30. package/docs/sdks/creditmemo/README.md +6 -0
  31. package/docs/sdks/crm/README.md +36 -0
  32. package/docs/sdks/customer/README.md +6 -0
  33. package/docs/sdks/deal/README.md +6 -0
  34. package/docs/sdks/device/README.md +6 -0
  35. package/docs/sdks/document/README.md +6 -0
  36. package/docs/sdks/employee/README.md +6 -0
  37. package/docs/sdks/enrich/README.md +2 -0
  38. package/docs/sdks/event/README.md +12 -0
  39. package/docs/sdks/file/README.md +6 -0
  40. package/docs/sdks/genai/README.md +2 -0
  41. package/docs/sdks/group/README.md +12 -0
  42. package/docs/sdks/hris/README.md +40 -0
  43. package/docs/sdks/instructor/README.md +6 -0
  44. package/docs/sdks/integration/README.md +4 -1
  45. package/docs/sdks/interview/README.md +6 -0
  46. package/docs/sdks/inventory/README.md +6 -0
  47. package/docs/sdks/invoice/README.md +6 -0
  48. package/docs/sdks/issue/README.md +1 -0
  49. package/docs/sdks/item/README.md +6 -0
  50. package/docs/sdks/job/README.md +6 -0
  51. package/docs/sdks/journal/README.md +6 -0
  52. package/docs/sdks/kms/README.md +18 -0
  53. package/docs/sdks/lead/README.md +6 -0
  54. package/docs/sdks/link/README.md +12 -0
  55. package/docs/sdks/list/README.md +6 -0
  56. package/docs/sdks/lms/README.md +24 -0
  57. package/docs/sdks/location/README.md +12 -0
  58. package/docs/sdks/login/README.md +1 -0
  59. package/docs/sdks/martech/README.md +12 -0
  60. package/docs/sdks/member/README.md +6 -0
  61. package/docs/sdks/message/README.md +6 -0
  62. package/docs/sdks/messaging/README.md +8 -0
  63. package/docs/sdks/metadata/README.md +6 -0
  64. package/docs/sdks/model/README.md +1 -0
  65. package/docs/sdks/note/README.md +6 -0
  66. package/docs/sdks/order/README.md +6 -0
  67. package/docs/sdks/organization/README.md +8 -0
  68. package/docs/sdks/page/README.md +6 -0
  69. package/docs/sdks/passthrough/README.md +8 -0
  70. package/docs/sdks/payment/README.md +22 -0
  71. package/docs/sdks/payout/README.md +2 -0
  72. package/docs/sdks/payslip/README.md +2 -0
  73. package/docs/sdks/person/README.md +1 -0
  74. package/docs/sdks/pipeline/README.md +6 -0
  75. package/docs/sdks/profitloss/README.md +2 -0
  76. package/docs/sdks/project/README.md +6 -0
  77. package/docs/sdks/prompt/README.md +1 -0
  78. package/docs/sdks/pullrequest/README.md +6 -0
  79. package/docs/sdks/purchaseorder/README.md +6 -0
  80. package/docs/sdks/recording/README.md +8 -0
  81. package/docs/sdks/refund/README.md +2 -0
  82. package/docs/sdks/repo/README.md +30 -0
  83. package/docs/sdks/report/README.md +2 -0
  84. package/docs/sdks/repository/README.md +6 -0
  85. package/docs/sdks/review/README.md +6 -0
  86. package/docs/sdks/salesorder/README.md +6 -0
  87. package/docs/sdks/scim/README.md +12 -0
  88. package/docs/sdks/scorecard/README.md +6 -0
  89. package/docs/sdks/space/README.md +6 -0
  90. package/docs/sdks/storage/README.md +6 -0
  91. package/docs/sdks/student/README.md +6 -0
  92. package/docs/sdks/subscription/README.md +6 -0
  93. package/docs/sdks/task/README.md +18 -0
  94. package/docs/sdks/taxrate/README.md +6 -0
  95. package/docs/sdks/ticket/README.md +6 -0
  96. package/docs/sdks/ticketing/README.md +18 -0
  97. package/docs/sdks/timeoff/README.md +2 -0
  98. package/docs/sdks/timeshift/README.md +6 -0
  99. package/docs/sdks/transaction/README.md +6 -0
  100. package/docs/sdks/trialbalance/README.md +2 -0
  101. package/docs/sdks/uc/README.md +19 -0
  102. package/docs/sdks/unified/README.md +22 -2
  103. package/docs/sdks/user/README.md +6 -0
  104. package/docs/sdks/webhook/README.md +8 -0
  105. package/examples/README.md +5 -0
  106. package/examples/accountingCreateAccountingAccount.example.ts +2 -0
  107. package/examples/package-lock.json +6 -5
  108. package/funcs/accountingCreateAccountingCategory.d.ts +15 -0
  109. package/funcs/accountingCreateAccountingCategory.d.ts.map +1 -0
  110. package/funcs/accountingCreateAccountingCategory.js +114 -0
  111. package/funcs/accountingCreateAccountingCategory.js.map +1 -0
  112. package/funcs/accountingGetAccountingCategory.d.ts +15 -0
  113. package/funcs/accountingGetAccountingCategory.d.ts.map +1 -0
  114. package/funcs/accountingGetAccountingCategory.js +115 -0
  115. package/funcs/accountingGetAccountingCategory.js.map +1 -0
  116. package/funcs/accountingListAccountingCategories.d.ts +15 -0
  117. package/funcs/accountingListAccountingCategories.d.ts.map +1 -0
  118. package/funcs/accountingListAccountingCategories.js +119 -0
  119. package/funcs/accountingListAccountingCategories.js.map +1 -0
  120. package/funcs/accountingPatchAccountingCategory.d.ts +15 -0
  121. package/funcs/accountingPatchAccountingCategory.d.ts.map +1 -0
  122. package/funcs/accountingPatchAccountingCategory.js +118 -0
  123. package/funcs/accountingPatchAccountingCategory.js.map +1 -0
  124. package/funcs/accountingRemoveAccountingCategory.d.ts +14 -0
  125. package/funcs/accountingRemoveAccountingCategory.d.ts.map +1 -0
  126. package/funcs/accountingRemoveAccountingCategory.js +112 -0
  127. package/funcs/accountingRemoveAccountingCategory.js.map +1 -0
  128. package/funcs/accountingUpdateAccountingCategory.d.ts +15 -0
  129. package/funcs/accountingUpdateAccountingCategory.d.ts.map +1 -0
  130. package/funcs/accountingUpdateAccountingCategory.js +118 -0
  131. package/funcs/accountingUpdateAccountingCategory.js.map +1 -0
  132. package/funcs/unifiedCreateUnifiedConnection.d.ts +1 -1
  133. package/funcs/unifiedCreateUnifiedConnection.js +1 -1
  134. package/funcs/unifiedGetUnifiedIntegrationAuth.d.ts +1 -1
  135. package/funcs/unifiedGetUnifiedIntegrationAuth.js +1 -1
  136. package/jsr.json +1 -1
  137. package/lib/config.d.ts +3 -3
  138. package/lib/config.js +3 -3
  139. package/lib/config.js.map +1 -1
  140. package/mcp-server/mcp-server.js +1 -1
  141. package/mcp-server/mcp-server.js.map +1 -1
  142. package/mcp-server/server.d.ts.map +1 -1
  143. package/mcp-server/server.js +13 -1
  144. package/mcp-server/server.js.map +1 -1
  145. package/mcp-server/tools/accountingCreateAccountingCategory.d.ts +8 -0
  146. package/mcp-server/tools/accountingCreateAccountingCategory.d.ts.map +1 -0
  147. package/mcp-server/tools/accountingCreateAccountingCategory.js +52 -0
  148. package/mcp-server/tools/accountingCreateAccountingCategory.js.map +1 -0
  149. package/mcp-server/tools/accountingGetAccountingCategory.d.ts +8 -0
  150. package/mcp-server/tools/accountingGetAccountingCategory.d.ts.map +1 -0
  151. package/mcp-server/tools/accountingGetAccountingCategory.js +52 -0
  152. package/mcp-server/tools/accountingGetAccountingCategory.js.map +1 -0
  153. package/mcp-server/tools/accountingListAccountingCategories.d.ts +8 -0
  154. package/mcp-server/tools/accountingListAccountingCategories.d.ts.map +1 -0
  155. package/mcp-server/tools/accountingListAccountingCategories.js +52 -0
  156. package/mcp-server/tools/accountingListAccountingCategories.js.map +1 -0
  157. package/mcp-server/tools/accountingPatchAccountingCategory.d.ts +8 -0
  158. package/mcp-server/tools/accountingPatchAccountingCategory.d.ts.map +1 -0
  159. package/mcp-server/tools/accountingPatchAccountingCategory.js +52 -0
  160. package/mcp-server/tools/accountingPatchAccountingCategory.js.map +1 -0
  161. package/mcp-server/tools/accountingRemoveAccountingCategory.d.ts +8 -0
  162. package/mcp-server/tools/accountingRemoveAccountingCategory.d.ts.map +1 -0
  163. package/mcp-server/tools/accountingRemoveAccountingCategory.js +51 -0
  164. package/mcp-server/tools/accountingRemoveAccountingCategory.js.map +1 -0
  165. package/mcp-server/tools/accountingUpdateAccountingCategory.d.ts +8 -0
  166. package/mcp-server/tools/accountingUpdateAccountingCategory.d.ts.map +1 -0
  167. package/mcp-server/tools/accountingUpdateAccountingCategory.js +52 -0
  168. package/mcp-server/tools/accountingUpdateAccountingCategory.js.map +1 -0
  169. package/mcp-server/tools/unifiedCreateUnifiedConnection.js +1 -1
  170. package/mcp-server/tools/unifiedCreateUnifiedConnection.js.map +1 -1
  171. package/mcp-server/tools/unifiedGetUnifiedIntegrationAuth.js +1 -1
  172. package/package.json +4 -6
  173. package/sdk/accounting.d.ts +24 -0
  174. package/sdk/accounting.d.ts.map +1 -1
  175. package/sdk/accounting.js +42 -0
  176. package/sdk/accounting.js.map +1 -1
  177. package/sdk/auth.d.ts +1 -1
  178. package/sdk/auth.js +1 -1
  179. package/sdk/category.d.ts +30 -0
  180. package/sdk/category.d.ts.map +1 -0
  181. package/sdk/category.js +54 -0
  182. package/sdk/category.js.map +1 -0
  183. package/sdk/connection.d.ts +1 -1
  184. package/sdk/connection.js +1 -1
  185. package/sdk/integration.d.ts +1 -1
  186. package/sdk/integration.js +1 -1
  187. package/sdk/models/operations/createaccountingcategory.d.ts +45 -0
  188. package/sdk/models/operations/createaccountingcategory.d.ts.map +1 -0
  189. package/sdk/models/operations/createaccountingcategory.js +77 -0
  190. package/sdk/models/operations/createaccountingcategory.js.map +1 -0
  191. package/sdk/models/operations/getaccountingcategory.d.ts +47 -0
  192. package/sdk/models/operations/getaccountingcategory.d.ts.map +1 -0
  193. package/sdk/models/operations/getaccountingcategory.js +74 -0
  194. package/sdk/models/operations/getaccountingcategory.js.map +1 -0
  195. package/sdk/models/operations/index.d.ts +6 -0
  196. package/sdk/models/operations/index.d.ts.map +1 -1
  197. package/sdk/models/operations/index.js +6 -0
  198. package/sdk/models/operations/index.js.map +1 -1
  199. package/sdk/models/operations/listaccountingcategories.d.ts +65 -0
  200. package/sdk/models/operations/listaccountingcategories.d.ts.map +1 -0
  201. package/sdk/models/operations/listaccountingcategories.js +90 -0
  202. package/sdk/models/operations/listaccountingcategories.js.map +1 -0
  203. package/sdk/models/operations/patchaccountingcategory.d.ts +50 -0
  204. package/sdk/models/operations/patchaccountingcategory.d.ts.map +1 -0
  205. package/sdk/models/operations/patchaccountingcategory.js +79 -0
  206. package/sdk/models/operations/patchaccountingcategory.js.map +1 -0
  207. package/sdk/models/operations/removeaccountingcategory.d.ts +66 -0
  208. package/sdk/models/operations/removeaccountingcategory.d.ts.map +1 -0
  209. package/sdk/models/operations/removeaccountingcategory.js +105 -0
  210. package/sdk/models/operations/removeaccountingcategory.js.map +1 -0
  211. package/sdk/models/operations/updateaccountingcategory.d.ts +50 -0
  212. package/sdk/models/operations/updateaccountingcategory.d.ts.map +1 -0
  213. package/sdk/models/operations/updateaccountingcategory.js +79 -0
  214. package/sdk/models/operations/updateaccountingcategory.js.map +1 -0
  215. package/sdk/models/shared/accountingcategory.d.ts +47 -0
  216. package/sdk/models/shared/accountingcategory.d.ts.map +1 -0
  217. package/sdk/models/shared/accountingcategory.js +90 -0
  218. package/sdk/models/shared/accountingcategory.js.map +1 -0
  219. package/sdk/models/shared/accountinglineitem.d.ts +2 -0
  220. package/sdk/models/shared/accountinglineitem.d.ts.map +1 -1
  221. package/sdk/models/shared/accountinglineitem.js +4 -0
  222. package/sdk/models/shared/accountinglineitem.js.map +1 -1
  223. package/sdk/models/shared/calendareventrecurrence.d.ts +38 -0
  224. package/sdk/models/shared/calendareventrecurrence.d.ts.map +1 -1
  225. package/sdk/models/shared/calendareventrecurrence.js +46 -1
  226. package/sdk/models/shared/calendareventrecurrence.js.map +1 -1
  227. package/sdk/models/shared/index.d.ts +1 -0
  228. package/sdk/models/shared/index.d.ts.map +1 -1
  229. package/sdk/models/shared/index.js +1 -0
  230. package/sdk/models/shared/index.js.map +1 -1
  231. package/sdk/sdk.d.ts +3 -0
  232. package/sdk/sdk.d.ts.map +1 -1
  233. package/sdk/sdk.js +4 -0
  234. package/sdk/sdk.js.map +1 -1
  235. package/sdk/unified.d.ts +2 -2
  236. package/sdk/unified.js +2 -2
  237. package/src/funcs/accountingCreateAccountingCategory.ts +173 -0
  238. package/src/funcs/accountingGetAccountingCategory.ts +176 -0
  239. package/src/funcs/accountingListAccountingCategories.ts +178 -0
  240. package/src/funcs/accountingPatchAccountingCategory.ts +179 -0
  241. package/src/funcs/accountingRemoveAccountingCategory.ts +181 -0
  242. package/src/funcs/accountingUpdateAccountingCategory.ts +179 -0
  243. package/src/funcs/unifiedCreateUnifiedConnection.ts +1 -1
  244. package/src/funcs/unifiedGetUnifiedIntegrationAuth.ts +1 -1
  245. package/src/lib/config.ts +3 -3
  246. package/src/mcp-server/mcp-server.ts +1 -1
  247. package/src/mcp-server/server.ts +13 -1
  248. package/src/mcp-server/tools/accountingCreateAccountingCategory.ts +37 -0
  249. package/src/mcp-server/tools/accountingGetAccountingCategory.ts +36 -0
  250. package/src/mcp-server/tools/accountingListAccountingCategories.ts +37 -0
  251. package/src/mcp-server/tools/accountingPatchAccountingCategory.ts +37 -0
  252. package/src/mcp-server/tools/accountingRemoveAccountingCategory.ts +35 -0
  253. package/src/mcp-server/tools/accountingUpdateAccountingCategory.ts +37 -0
  254. package/src/mcp-server/tools/unifiedCreateUnifiedConnection.ts +1 -1
  255. package/src/mcp-server/tools/unifiedGetUnifiedIntegrationAuth.ts +1 -1
  256. package/src/sdk/accounting.ts +90 -0
  257. package/src/sdk/auth.ts +1 -1
  258. package/src/sdk/category.ts +100 -0
  259. package/src/sdk/connection.ts +1 -1
  260. package/src/sdk/integration.ts +1 -1
  261. package/src/sdk/models/operations/createaccountingcategory.ts +101 -0
  262. package/src/sdk/models/operations/getaccountingcategory.ts +101 -0
  263. package/src/sdk/models/operations/index.ts +6 -0
  264. package/src/sdk/models/operations/listaccountingcategories.ts +135 -0
  265. package/src/sdk/models/operations/patchaccountingcategory.ts +108 -0
  266. package/src/sdk/models/operations/removeaccountingcategory.ts +155 -0
  267. package/src/sdk/models/operations/updateaccountingcategory.ts +108 -0
  268. package/src/sdk/models/shared/accountingcategory.ts +111 -0
  269. package/src/sdk/models/shared/accountinglineitem.ts +6 -0
  270. package/src/sdk/models/shared/calendareventrecurrence.ts +71 -0
  271. package/src/sdk/models/shared/index.ts +1 -0
  272. package/src/sdk/sdk.ts +6 -0
  273. package/src/sdk/unified.ts +2 -2
@@ -0,0 +1,489 @@
1
+ # Category
2
+ (*category*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [createAccountingCategory](#createaccountingcategory) - Create a category
9
+ * [getAccountingCategory](#getaccountingcategory) - Retrieve a category
10
+ * [listAccountingCategories](#listaccountingcategories) - List all categories
11
+ * [patchAccountingCategory](#patchaccountingcategory) - Update a category
12
+ * [removeAccountingCategory](#removeaccountingcategory) - Remove a category
13
+ * [updateAccountingCategory](#updateaccountingcategory) - Update a category
14
+
15
+ ## createAccountingCategory
16
+
17
+ Create a category
18
+
19
+ ### Example Usage
20
+
21
+ <!-- UsageSnippet language="typescript" operationID="createAccountingCategory" method="post" path="/accounting/{connection_id}/category" -->
22
+ ```typescript
23
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
24
+
25
+ const unifiedTo = new UnifiedTo({
26
+ security: {
27
+ jwt: "<YOUR_API_KEY_HERE>",
28
+ },
29
+ });
30
+
31
+ async function run() {
32
+ const result = await unifiedTo.category.createAccountingCategory({
33
+ accountingCategory: {},
34
+ connectionId: "<id>",
35
+ });
36
+
37
+ console.log(result);
38
+ }
39
+
40
+ run();
41
+ ```
42
+
43
+ ### Standalone function
44
+
45
+ The standalone function version of this method:
46
+
47
+ ```typescript
48
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
49
+ import { accountingCreateAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingCategory.js";
50
+
51
+ // Use `UnifiedToCore` for best tree-shaking performance.
52
+ // You can create one instance of it to use across an application.
53
+ const unifiedTo = new UnifiedToCore({
54
+ security: {
55
+ jwt: "<YOUR_API_KEY_HERE>",
56
+ },
57
+ });
58
+
59
+ async function run() {
60
+ const res = await accountingCreateAccountingCategory(unifiedTo, {
61
+ accountingCategory: {},
62
+ connectionId: "<id>",
63
+ });
64
+ if (res.ok) {
65
+ const { value: result } = res;
66
+ console.log(result);
67
+ } else {
68
+ console.log("accountingCreateAccountingCategory failed:", res.error);
69
+ }
70
+ }
71
+
72
+ run();
73
+ ```
74
+
75
+ ### Parameters
76
+
77
+ | Parameter | Type | Required | Description |
78
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
79
+ | `request` | [operations.CreateAccountingCategoryRequest](../../sdk/models/operations/createaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
80
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
81
+ | `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. |
82
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
83
+
84
+ ### Response
85
+
86
+ **Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
87
+
88
+ ### Errors
89
+
90
+ | Error Type | Status Code | Content Type |
91
+ | --------------- | --------------- | --------------- |
92
+ | errors.SDKError | 4XX, 5XX | \*/\* |
93
+
94
+ ## getAccountingCategory
95
+
96
+ Retrieve a category
97
+
98
+ ### Example Usage
99
+
100
+ <!-- UsageSnippet language="typescript" operationID="getAccountingCategory" method="get" path="/accounting/{connection_id}/category/{id}" -->
101
+ ```typescript
102
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
103
+
104
+ const unifiedTo = new UnifiedTo({
105
+ security: {
106
+ jwt: "<YOUR_API_KEY_HERE>",
107
+ },
108
+ });
109
+
110
+ async function run() {
111
+ const result = await unifiedTo.category.getAccountingCategory({
112
+ connectionId: "<id>",
113
+ id: "<id>",
114
+ });
115
+
116
+ console.log(result);
117
+ }
118
+
119
+ run();
120
+ ```
121
+
122
+ ### Standalone function
123
+
124
+ The standalone function version of this method:
125
+
126
+ ```typescript
127
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
128
+ import { accountingGetAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingCategory.js";
129
+
130
+ // Use `UnifiedToCore` for best tree-shaking performance.
131
+ // You can create one instance of it to use across an application.
132
+ const unifiedTo = new UnifiedToCore({
133
+ security: {
134
+ jwt: "<YOUR_API_KEY_HERE>",
135
+ },
136
+ });
137
+
138
+ async function run() {
139
+ const res = await accountingGetAccountingCategory(unifiedTo, {
140
+ connectionId: "<id>",
141
+ id: "<id>",
142
+ });
143
+ if (res.ok) {
144
+ const { value: result } = res;
145
+ console.log(result);
146
+ } else {
147
+ console.log("accountingGetAccountingCategory failed:", res.error);
148
+ }
149
+ }
150
+
151
+ run();
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ | Parameter | Type | Required | Description |
157
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
+ | `request` | [operations.GetAccountingCategoryRequest](../../sdk/models/operations/getaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
159
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
160
+ | `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. |
161
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
162
+
163
+ ### Response
164
+
165
+ **Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
166
+
167
+ ### Errors
168
+
169
+ | Error Type | Status Code | Content Type |
170
+ | --------------- | --------------- | --------------- |
171
+ | errors.SDKError | 4XX, 5XX | \*/\* |
172
+
173
+ ## listAccountingCategories
174
+
175
+ List all categories
176
+
177
+ ### Example Usage
178
+
179
+ <!-- UsageSnippet language="typescript" operationID="listAccountingCategories" method="get" path="/accounting/{connection_id}/category" -->
180
+ ```typescript
181
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
182
+
183
+ const unifiedTo = new UnifiedTo({
184
+ security: {
185
+ jwt: "<YOUR_API_KEY_HERE>",
186
+ },
187
+ });
188
+
189
+ async function run() {
190
+ const result = await unifiedTo.category.listAccountingCategories({
191
+ connectionId: "<id>",
192
+ });
193
+
194
+ console.log(result);
195
+ }
196
+
197
+ run();
198
+ ```
199
+
200
+ ### Standalone function
201
+
202
+ The standalone function version of this method:
203
+
204
+ ```typescript
205
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
206
+ import { accountingListAccountingCategories } from "@unified-api/typescript-sdk/funcs/accountingListAccountingCategories.js";
207
+
208
+ // Use `UnifiedToCore` for best tree-shaking performance.
209
+ // You can create one instance of it to use across an application.
210
+ const unifiedTo = new UnifiedToCore({
211
+ security: {
212
+ jwt: "<YOUR_API_KEY_HERE>",
213
+ },
214
+ });
215
+
216
+ async function run() {
217
+ const res = await accountingListAccountingCategories(unifiedTo, {
218
+ connectionId: "<id>",
219
+ });
220
+ if (res.ok) {
221
+ const { value: result } = res;
222
+ console.log(result);
223
+ } else {
224
+ console.log("accountingListAccountingCategories failed:", res.error);
225
+ }
226
+ }
227
+
228
+ run();
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+ | Parameter | Type | Required | Description |
234
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
235
+ | `request` | [operations.ListAccountingCategoriesRequest](../../sdk/models/operations/listaccountingcategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
236
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
237
+ | `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. |
238
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
239
+
240
+ ### Response
241
+
242
+ **Promise\<[shared.AccountingCategory[]](../../models/.md)\>**
243
+
244
+ ### Errors
245
+
246
+ | Error Type | Status Code | Content Type |
247
+ | --------------- | --------------- | --------------- |
248
+ | errors.SDKError | 4XX, 5XX | \*/\* |
249
+
250
+ ## patchAccountingCategory
251
+
252
+ Update a category
253
+
254
+ ### Example Usage
255
+
256
+ <!-- UsageSnippet language="typescript" operationID="patchAccountingCategory" method="patch" path="/accounting/{connection_id}/category/{id}" -->
257
+ ```typescript
258
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
259
+
260
+ const unifiedTo = new UnifiedTo({
261
+ security: {
262
+ jwt: "<YOUR_API_KEY_HERE>",
263
+ },
264
+ });
265
+
266
+ async function run() {
267
+ const result = await unifiedTo.category.patchAccountingCategory({
268
+ accountingCategory: {},
269
+ connectionId: "<id>",
270
+ id: "<id>",
271
+ });
272
+
273
+ console.log(result);
274
+ }
275
+
276
+ run();
277
+ ```
278
+
279
+ ### Standalone function
280
+
281
+ The standalone function version of this method:
282
+
283
+ ```typescript
284
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
285
+ import { accountingPatchAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingCategory.js";
286
+
287
+ // Use `UnifiedToCore` for best tree-shaking performance.
288
+ // You can create one instance of it to use across an application.
289
+ const unifiedTo = new UnifiedToCore({
290
+ security: {
291
+ jwt: "<YOUR_API_KEY_HERE>",
292
+ },
293
+ });
294
+
295
+ async function run() {
296
+ const res = await accountingPatchAccountingCategory(unifiedTo, {
297
+ accountingCategory: {},
298
+ connectionId: "<id>",
299
+ id: "<id>",
300
+ });
301
+ if (res.ok) {
302
+ const { value: result } = res;
303
+ console.log(result);
304
+ } else {
305
+ console.log("accountingPatchAccountingCategory failed:", res.error);
306
+ }
307
+ }
308
+
309
+ run();
310
+ ```
311
+
312
+ ### Parameters
313
+
314
+ | Parameter | Type | Required | Description |
315
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
316
+ | `request` | [operations.PatchAccountingCategoryRequest](../../sdk/models/operations/patchaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
317
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
318
+ | `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. |
319
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
320
+
321
+ ### Response
322
+
323
+ **Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
324
+
325
+ ### Errors
326
+
327
+ | Error Type | Status Code | Content Type |
328
+ | --------------- | --------------- | --------------- |
329
+ | errors.SDKError | 4XX, 5XX | \*/\* |
330
+
331
+ ## removeAccountingCategory
332
+
333
+ Remove a category
334
+
335
+ ### Example Usage
336
+
337
+ <!-- UsageSnippet language="typescript" operationID="removeAccountingCategory" method="delete" path="/accounting/{connection_id}/category/{id}" -->
338
+ ```typescript
339
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
340
+
341
+ const unifiedTo = new UnifiedTo({
342
+ security: {
343
+ jwt: "<YOUR_API_KEY_HERE>",
344
+ },
345
+ });
346
+
347
+ async function run() {
348
+ const result = await unifiedTo.category.removeAccountingCategory({
349
+ connectionId: "<id>",
350
+ id: "<id>",
351
+ });
352
+
353
+ console.log(result);
354
+ }
355
+
356
+ run();
357
+ ```
358
+
359
+ ### Standalone function
360
+
361
+ The standalone function version of this method:
362
+
363
+ ```typescript
364
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
365
+ import { accountingRemoveAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingCategory.js";
366
+
367
+ // Use `UnifiedToCore` for best tree-shaking performance.
368
+ // You can create one instance of it to use across an application.
369
+ const unifiedTo = new UnifiedToCore({
370
+ security: {
371
+ jwt: "<YOUR_API_KEY_HERE>",
372
+ },
373
+ });
374
+
375
+ async function run() {
376
+ const res = await accountingRemoveAccountingCategory(unifiedTo, {
377
+ connectionId: "<id>",
378
+ id: "<id>",
379
+ });
380
+ if (res.ok) {
381
+ const { value: result } = res;
382
+ console.log(result);
383
+ } else {
384
+ console.log("accountingRemoveAccountingCategory failed:", res.error);
385
+ }
386
+ }
387
+
388
+ run();
389
+ ```
390
+
391
+ ### Parameters
392
+
393
+ | Parameter | Type | Required | Description |
394
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
395
+ | `request` | [operations.RemoveAccountingCategoryRequest](../../sdk/models/operations/removeaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
396
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
397
+ | `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. |
398
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
399
+
400
+ ### Response
401
+
402
+ **Promise\<[operations.RemoveAccountingCategoryResponse](../../sdk/models/operations/removeaccountingcategoryresponse.md)\>**
403
+
404
+ ### Errors
405
+
406
+ | Error Type | Status Code | Content Type |
407
+ | --------------- | --------------- | --------------- |
408
+ | errors.SDKError | 4XX, 5XX | \*/\* |
409
+
410
+ ## updateAccountingCategory
411
+
412
+ Update a category
413
+
414
+ ### Example Usage
415
+
416
+ <!-- UsageSnippet language="typescript" operationID="updateAccountingCategory" method="put" path="/accounting/{connection_id}/category/{id}" -->
417
+ ```typescript
418
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
419
+
420
+ const unifiedTo = new UnifiedTo({
421
+ security: {
422
+ jwt: "<YOUR_API_KEY_HERE>",
423
+ },
424
+ });
425
+
426
+ async function run() {
427
+ const result = await unifiedTo.category.updateAccountingCategory({
428
+ accountingCategory: {},
429
+ connectionId: "<id>",
430
+ id: "<id>",
431
+ });
432
+
433
+ console.log(result);
434
+ }
435
+
436
+ run();
437
+ ```
438
+
439
+ ### Standalone function
440
+
441
+ The standalone function version of this method:
442
+
443
+ ```typescript
444
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
445
+ import { accountingUpdateAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingCategory.js";
446
+
447
+ // Use `UnifiedToCore` for best tree-shaking performance.
448
+ // You can create one instance of it to use across an application.
449
+ const unifiedTo = new UnifiedToCore({
450
+ security: {
451
+ jwt: "<YOUR_API_KEY_HERE>",
452
+ },
453
+ });
454
+
455
+ async function run() {
456
+ const res = await accountingUpdateAccountingCategory(unifiedTo, {
457
+ accountingCategory: {},
458
+ connectionId: "<id>",
459
+ id: "<id>",
460
+ });
461
+ if (res.ok) {
462
+ const { value: result } = res;
463
+ console.log(result);
464
+ } else {
465
+ console.log("accountingUpdateAccountingCategory failed:", res.error);
466
+ }
467
+ }
468
+
469
+ run();
470
+ ```
471
+
472
+ ### Parameters
473
+
474
+ | Parameter | Type | Required | Description |
475
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
476
+ | `request` | [operations.UpdateAccountingCategoryRequest](../../sdk/models/operations/updateaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
477
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
478
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
479
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
480
+
481
+ ### Response
482
+
483
+ **Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
484
+
485
+ ### Errors
486
+
487
+ | Error Type | Status Code | Content Type |
488
+ | --------------- | --------------- | --------------- |
489
+ | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -14,6 +14,7 @@ Retrieve a channel
14
14
 
15
15
  ### Example Usage
16
16
 
17
+ <!-- UsageSnippet language="typescript" operationID="getMessagingChannel" method="get" path="/messaging/{connection_id}/channel/{id}" -->
17
18
  ```typescript
18
19
  import { UnifiedTo } from "@unified-api/typescript-sdk";
19
20
 
@@ -92,6 +93,7 @@ List all channels
92
93
 
93
94
  ### Example Usage
94
95
 
96
+ <!-- UsageSnippet language="typescript" operationID="listMessagingChannels" method="get" path="/messaging/{connection_id}/channel" -->
95
97
  ```typescript
96
98
  import { UnifiedTo } from "@unified-api/typescript-sdk";
97
99
 
@@ -18,6 +18,7 @@ Create a class
18
18
 
19
19
  ### Example Usage
20
20
 
21
+ <!-- UsageSnippet language="typescript" operationID="createLmsClass" method="post" path="/lms/{connection_id}/class" -->
21
22
  ```typescript
22
23
  import { UnifiedTo } from "@unified-api/typescript-sdk";
23
24
 
@@ -102,6 +103,7 @@ Retrieve a class
102
103
 
103
104
  ### Example Usage
104
105
 
106
+ <!-- UsageSnippet language="typescript" operationID="getLmsClass" method="get" path="/lms/{connection_id}/class/{id}" -->
105
107
  ```typescript
106
108
  import { UnifiedTo } from "@unified-api/typescript-sdk";
107
109
 
@@ -180,6 +182,7 @@ List all classes
180
182
 
181
183
  ### Example Usage
182
184
 
185
+ <!-- UsageSnippet language="typescript" operationID="listLmsClasses" method="get" path="/lms/{connection_id}/class" -->
183
186
  ```typescript
184
187
  import { UnifiedTo } from "@unified-api/typescript-sdk";
185
188
 
@@ -256,6 +259,7 @@ Update a class
256
259
 
257
260
  ### Example Usage
258
261
 
262
+ <!-- UsageSnippet language="typescript" operationID="patchLmsClass" method="patch" path="/lms/{connection_id}/class/{id}" -->
259
263
  ```typescript
260
264
  import { UnifiedTo } from "@unified-api/typescript-sdk";
261
265
 
@@ -342,6 +346,7 @@ Remove a class
342
346
 
343
347
  ### Example Usage
344
348
 
349
+ <!-- UsageSnippet language="typescript" operationID="removeLmsClass" method="delete" path="/lms/{connection_id}/class/{id}" -->
345
350
  ```typescript
346
351
  import { UnifiedTo } from "@unified-api/typescript-sdk";
347
352
 
@@ -420,6 +425,7 @@ Update a class
420
425
 
421
426
  ### Example Usage
422
427
 
428
+ <!-- UsageSnippet language="typescript" operationID="updateLmsClass" method="put" path="/lms/{connection_id}/class/{id}" -->
423
429
  ```typescript
424
430
  import { UnifiedTo } from "@unified-api/typescript-sdk";
425
431
 
@@ -18,6 +18,7 @@ Create a collection
18
18
 
19
19
  ### Example Usage
20
20
 
21
+ <!-- UsageSnippet language="typescript" operationID="createCommerceCollection" method="post" path="/commerce/{connection_id}/collection" -->
21
22
  ```typescript
22
23
  import { UnifiedTo } from "@unified-api/typescript-sdk";
23
24
 
@@ -100,6 +101,7 @@ Retrieve a collection
100
101
 
101
102
  ### Example Usage
102
103
 
104
+ <!-- UsageSnippet language="typescript" operationID="getCommerceCollection" method="get" path="/commerce/{connection_id}/collection/{id}" -->
103
105
  ```typescript
104
106
  import { UnifiedTo } from "@unified-api/typescript-sdk";
105
107
 
@@ -178,6 +180,7 @@ List all collections
178
180
 
179
181
  ### Example Usage
180
182
 
183
+ <!-- UsageSnippet language="typescript" operationID="listCommerceCollections" method="get" path="/commerce/{connection_id}/collection" -->
181
184
  ```typescript
182
185
  import { UnifiedTo } from "@unified-api/typescript-sdk";
183
186
 
@@ -254,6 +257,7 @@ Update a collection
254
257
 
255
258
  ### Example Usage
256
259
 
260
+ <!-- UsageSnippet language="typescript" operationID="patchCommerceCollection" method="patch" path="/commerce/{connection_id}/collection/{id}" -->
257
261
  ```typescript
258
262
  import { UnifiedTo } from "@unified-api/typescript-sdk";
259
263
 
@@ -338,6 +342,7 @@ Remove a collection
338
342
 
339
343
  ### Example Usage
340
344
 
345
+ <!-- UsageSnippet language="typescript" operationID="removeCommerceCollection" method="delete" path="/commerce/{connection_id}/collection/{id}" -->
341
346
  ```typescript
342
347
  import { UnifiedTo } from "@unified-api/typescript-sdk";
343
348
 
@@ -416,6 +421,7 @@ Update a collection
416
421
 
417
422
  ### Example Usage
418
423
 
424
+ <!-- UsageSnippet language="typescript" operationID="updateCommerceCollection" method="put" path="/commerce/{connection_id}/collection/{id}" -->
419
425
  ```typescript
420
426
  import { UnifiedTo } from "@unified-api/typescript-sdk";
421
427