@unified-api/typescript-sdk 1.0.0 → 1.0.2

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 (196) hide show
  1. package/README.md +54 -700
  2. package/dist/sdk/accounting.d.ts +0 -40
  3. package/dist/sdk/accounting.js +44 -696
  4. package/dist/sdk/link.d.ts +31 -0
  5. package/dist/sdk/link.js +503 -0
  6. package/dist/sdk/models/operations/{createaccountingpayment.d.ts → createpaymentlink.d.ts} +7 -7
  7. package/dist/sdk/models/operations/createpaymentlink.js +95 -0
  8. package/dist/sdk/models/operations/createpaymentpayment.d.ts +28 -0
  9. package/dist/sdk/models/operations/{createaccountingpayment.js → createpaymentpayment.js} +20 -20
  10. package/dist/sdk/models/operations/getpaymentlink.d.ts +35 -0
  11. package/dist/sdk/models/operations/getpaymentlink.js +99 -0
  12. package/dist/sdk/models/operations/{getaccountingpayment.d.ts → getpaymentpayment.d.ts} +6 -6
  13. package/dist/sdk/models/operations/{getaccountingpayment.js → getpaymentpayment.js} +20 -20
  14. package/dist/sdk/models/operations/{getaccountingpayout.d.ts → getpaymentpayout.d.ts} +6 -6
  15. package/dist/sdk/models/operations/{getaccountingpayout.js → getpaymentpayout.js} +20 -20
  16. package/dist/sdk/models/operations/{getaccountingrefund.d.ts → getpaymentrefund.d.ts} +6 -6
  17. package/dist/sdk/models/operations/{getaccountingrefund.js → getpaymentrefund.js} +20 -20
  18. package/dist/sdk/models/operations/getunifiedintegrationauth.d.ts +6 -4
  19. package/dist/sdk/models/operations/getunifiedintegrationauth.js +6 -4
  20. package/dist/sdk/models/operations/index.d.ts +16 -10
  21. package/dist/sdk/models/operations/index.js +16 -10
  22. package/dist/sdk/models/operations/listpaymentlinks.d.ts +51 -0
  23. package/dist/sdk/models/operations/listpaymentlinks.js +127 -0
  24. package/dist/sdk/models/operations/{listaccountingpayments.d.ts → listpaymentpayments.d.ts} +6 -6
  25. package/dist/sdk/models/operations/{listaccountingpayments.js → listpaymentpayments.js} +28 -28
  26. package/dist/sdk/models/operations/{listaccountingpayouts.d.ts → listpaymentpayouts.d.ts} +6 -6
  27. package/dist/sdk/models/operations/{listaccountingpayouts.js → listpaymentpayouts.js} +26 -26
  28. package/dist/sdk/models/operations/{listaccountingrefunds.d.ts → listpaymentrefunds.d.ts} +6 -6
  29. package/dist/sdk/models/operations/{listaccountingrefunds.js → listpaymentrefunds.js} +27 -27
  30. package/dist/sdk/models/operations/listunifiedconnections.d.ts +2 -1
  31. package/dist/sdk/models/operations/listunifiedconnections.js +1 -0
  32. package/dist/sdk/models/operations/listunifiedintegrations.d.ts +2 -1
  33. package/dist/sdk/models/operations/listunifiedintegrations.js +1 -0
  34. package/dist/sdk/models/operations/listunifiedintegrationworkspaces.d.ts +2 -1
  35. package/dist/sdk/models/operations/listunifiedintegrationworkspaces.js +1 -0
  36. package/dist/sdk/models/operations/patchpaymentlink.d.ts +32 -0
  37. package/dist/sdk/models/operations/patchpaymentlink.js +99 -0
  38. package/dist/sdk/models/operations/{patchaccountingpayment.d.ts → patchpaymentpayment.d.ts} +7 -7
  39. package/dist/sdk/models/operations/{patchaccountingpayment.js → patchpaymentpayment.js} +21 -21
  40. package/dist/sdk/models/operations/removepaymentlink.d.ts +30 -0
  41. package/dist/sdk/models/operations/{removeaccountingpayment.js → removepaymentlink.js} +17 -17
  42. package/dist/sdk/models/operations/{removeaccountingpayment.d.ts → removepaymentpayment.d.ts} +2 -2
  43. package/dist/sdk/models/operations/removepaymentpayment.js +71 -0
  44. package/dist/sdk/models/operations/updatepaymentlink.d.ts +32 -0
  45. package/dist/sdk/models/operations/updatepaymentlink.js +99 -0
  46. package/dist/sdk/models/operations/{updateaccountingpayment.d.ts → updatepaymentpayment.d.ts} +7 -7
  47. package/dist/sdk/models/operations/{updateaccountingpayment.js → updatepaymentpayment.js} +21 -21
  48. package/dist/sdk/models/shared/accountinginvoice.d.ts +1 -0
  49. package/dist/sdk/models/shared/accountinginvoice.js +5 -0
  50. package/dist/sdk/models/shared/index.d.ts +5 -3
  51. package/dist/sdk/models/shared/index.js +5 -3
  52. package/dist/sdk/models/shared/paymenntlinklineitem.d.ts +20 -0
  53. package/dist/sdk/models/shared/paymenntlinklineitem.js +137 -0
  54. package/dist/sdk/models/shared/paymentlink.d.ts +15 -0
  55. package/dist/sdk/models/shared/paymentlink.js +105 -0
  56. package/dist/sdk/models/shared/{accountingpayment.d.ts → paymentpayment.d.ts} +1 -1
  57. package/dist/sdk/models/shared/{accountingpayment.js → paymentpayment.js} +18 -18
  58. package/dist/sdk/models/shared/{accountingpayout.d.ts → paymentpayout.d.ts} +3 -3
  59. package/dist/sdk/models/shared/{accountingpayout.js → paymentpayout.js} +21 -21
  60. package/dist/sdk/models/shared/{accountingrefund.d.ts → paymentrefund.d.ts} +3 -3
  61. package/dist/sdk/models/shared/{accountingrefund.js → paymentrefund.js} +23 -23
  62. package/dist/sdk/models/shared/propertyconnectioncategories.d.ts +2 -1
  63. package/dist/sdk/models/shared/propertyconnectioncategories.js +1 -0
  64. package/dist/sdk/models/shared/propertyconnectionpermissions.d.ts +6 -4
  65. package/dist/sdk/models/shared/propertyconnectionpermissions.js +6 -4
  66. package/dist/sdk/models/shared/propertyintegrationcategories.d.ts +2 -1
  67. package/dist/sdk/models/shared/propertyintegrationcategories.js +1 -0
  68. package/dist/sdk/models/shared/webhook.d.ts +4 -3
  69. package/dist/sdk/models/shared/webhook.js +4 -3
  70. package/dist/sdk/payment.d.ts +46 -6
  71. package/dist/sdk/payment.js +705 -53
  72. package/dist/sdk/payout.d.ts +2 -2
  73. package/dist/sdk/payout.js +11 -11
  74. package/dist/sdk/refund.d.ts +2 -2
  75. package/dist/sdk/refund.js +11 -11
  76. package/dist/sdk/sdk.d.ts +5 -3
  77. package/dist/sdk/sdk.js +7 -5
  78. package/docs/sdk/models/operations/categories.md +2 -1
  79. package/docs/sdk/models/operations/createpaymentlinkrequest.md +9 -0
  80. package/docs/sdk/models/operations/createpaymentlinkresponse.md +11 -0
  81. package/docs/sdk/models/operations/createpaymentpaymentrequest.md +9 -0
  82. package/docs/sdk/models/operations/createpaymentpaymentresponse.md +11 -0
  83. package/docs/sdk/models/operations/getpaymentlinkrequest.md +10 -0
  84. package/docs/sdk/models/operations/getpaymentlinkresponse.md +11 -0
  85. package/docs/sdk/models/operations/{getaccountingpaymentrequest.md → getpaymentpaymentrequest.md} +1 -1
  86. package/docs/sdk/models/operations/getpaymentpaymentresponse.md +11 -0
  87. package/docs/sdk/models/operations/{getaccountingpayoutrequest.md → getpaymentpayoutrequest.md} +1 -1
  88. package/docs/sdk/models/operations/getpaymentpayoutresponse.md +11 -0
  89. package/docs/sdk/models/operations/{getaccountingrefundrequest.md → getpaymentrefundrequest.md} +1 -1
  90. package/docs/sdk/models/operations/getpaymentrefundresponse.md +11 -0
  91. package/docs/sdk/models/operations/listpaymentlinksrequest.md +17 -0
  92. package/docs/sdk/models/operations/listpaymentlinksresponse.md +11 -0
  93. package/docs/sdk/models/operations/{listaccountingpaymentsrequest.md → listpaymentpaymentsrequest.md} +1 -1
  94. package/docs/sdk/models/operations/listpaymentpaymentsresponse.md +11 -0
  95. package/docs/sdk/models/operations/{listaccountingpayoutsrequest.md → listpaymentpayoutsrequest.md} +1 -1
  96. package/docs/sdk/models/operations/listpaymentpayoutsresponse.md +11 -0
  97. package/docs/sdk/models/operations/{listaccountingrefundsrequest.md → listpaymentrefundsrequest.md} +1 -1
  98. package/docs/sdk/models/operations/listpaymentrefundsresponse.md +11 -0
  99. package/docs/sdk/models/operations/listunifiedintegrationsqueryparamcategories.md +2 -1
  100. package/docs/sdk/models/operations/patchpaymentlinkrequest.md +10 -0
  101. package/docs/sdk/models/operations/patchpaymentlinkresponse.md +11 -0
  102. package/docs/sdk/models/operations/patchpaymentpaymentrequest.md +10 -0
  103. package/docs/sdk/models/operations/patchpaymentpaymentresponse.md +11 -0
  104. package/docs/sdk/models/operations/queryparamcategories.md +2 -1
  105. package/docs/sdk/models/operations/{removeaccountingpaymentrequest.md → removepaymentlinkrequest.md} +2 -2
  106. package/docs/sdk/models/operations/{removeaccountingpaymentresponse.md → removepaymentlinkresponse.md} +1 -1
  107. package/docs/sdk/models/operations/removepaymentpaymentrequest.md +9 -0
  108. package/docs/sdk/models/operations/removepaymentpaymentresponse.md +11 -0
  109. package/docs/sdk/models/operations/scopes.md +6 -4
  110. package/docs/sdk/models/operations/updatepaymentlinkrequest.md +10 -0
  111. package/docs/sdk/models/operations/updatepaymentlinkresponse.md +11 -0
  112. package/docs/sdk/models/operations/updatepaymentpaymentrequest.md +10 -0
  113. package/docs/sdk/models/operations/updatepaymentpaymentresponse.md +11 -0
  114. package/docs/sdk/models/shared/accountinginvoice.md +2 -1
  115. package/docs/sdk/models/shared/objecttype.md +4 -3
  116. package/docs/sdk/models/shared/paymenntlinklineitem.md +24 -0
  117. package/docs/sdk/models/shared/paymentlink.md +18 -0
  118. package/docs/sdk/models/shared/{accountingpayment.md → paymentpayment.md} +1 -1
  119. package/docs/sdk/models/shared/paymentpayout.md +15 -0
  120. package/docs/sdk/models/shared/{accountingpayoutstatus.md → paymentpayoutstatus.md} +1 -1
  121. package/docs/sdk/models/shared/paymentrefund.md +17 -0
  122. package/docs/sdk/models/shared/{accountingrefundstatus.md → paymentrefundstatus.md} +1 -1
  123. package/docs/sdk/models/shared/propertyconnectioncategories.md +2 -1
  124. package/docs/sdk/models/shared/propertyconnectionpermissions.md +6 -4
  125. package/docs/sdk/models/shared/propertyintegrationcategories.md +2 -1
  126. package/package.json +1 -1
  127. package/docs/sdk/models/operations/createaccountingpaymentrequest.md +0 -9
  128. package/docs/sdk/models/operations/createaccountingpaymentresponse.md +0 -11
  129. package/docs/sdk/models/operations/getaccountingpaymentresponse.md +0 -11
  130. package/docs/sdk/models/operations/getaccountingpayoutresponse.md +0 -11
  131. package/docs/sdk/models/operations/getaccountingrefundresponse.md +0 -11
  132. package/docs/sdk/models/operations/listaccountingpaymentsresponse.md +0 -11
  133. package/docs/sdk/models/operations/listaccountingpayoutsresponse.md +0 -11
  134. package/docs/sdk/models/operations/listaccountingrefundsresponse.md +0 -11
  135. package/docs/sdk/models/operations/patchaccountingpaymentrequest.md +0 -10
  136. package/docs/sdk/models/operations/patchaccountingpaymentresponse.md +0 -11
  137. package/docs/sdk/models/operations/updateaccountingpaymentrequest.md +0 -10
  138. package/docs/sdk/models/operations/updateaccountingpaymentresponse.md +0 -11
  139. package/docs/sdk/models/shared/accountingpayout.md +0 -15
  140. package/docs/sdk/models/shared/accountingrefund.md +0 -17
  141. package/docs/sdks/account/README.md +0 -312
  142. package/docs/sdks/accounting/README.md +0 -2198
  143. package/docs/sdks/activity/README.md +0 -321
  144. package/docs/sdks/apicall/README.md +0 -95
  145. package/docs/sdks/application/README.md +0 -333
  146. package/docs/sdks/applicationstatus/README.md +0 -54
  147. package/docs/sdks/ats/README.md +0 -2488
  148. package/docs/sdks/auth/README.md +0 -103
  149. package/docs/sdks/call/README.md +0 -54
  150. package/docs/sdks/candidate/README.md +0 -369
  151. package/docs/sdks/collection/README.md +0 -348
  152. package/docs/sdks/commerce/README.md +0 -1371
  153. package/docs/sdks/company/README.md +0 -517
  154. package/docs/sdks/connection/README.md +0 -359
  155. package/docs/sdks/contact/README.md +0 -1028
  156. package/docs/sdks/crm/README.md +0 -2048
  157. package/docs/sdks/customer/README.md +0 -348
  158. package/docs/sdks/deal/README.md +0 -315
  159. package/docs/sdks/document/README.md +0 -309
  160. package/docs/sdks/employee/README.md +0 -363
  161. package/docs/sdks/enrich/README.md +0 -97
  162. package/docs/sdks/event/README.md +0 -390
  163. package/docs/sdks/file/README.md +0 -330
  164. package/docs/sdks/group/README.md +0 -327
  165. package/docs/sdks/hris/README.md +0 -685
  166. package/docs/sdks/integration/README.md +0 -155
  167. package/docs/sdks/interview/README.md +0 -318
  168. package/docs/sdks/inventory/README.md +0 -309
  169. package/docs/sdks/invoice/README.md +0 -324
  170. package/docs/sdks/issue/README.md +0 -49
  171. package/docs/sdks/item/README.md +0 -417
  172. package/docs/sdks/job/README.md +0 -396
  173. package/docs/sdks/lead/README.md +0 -336
  174. package/docs/sdks/list/README.md +0 -306
  175. package/docs/sdks/location/README.md +0 -312
  176. package/docs/sdks/login/README.md +0 -52
  177. package/docs/sdks/martech/README.md +0 -643
  178. package/docs/sdks/member/README.md +0 -342
  179. package/docs/sdks/note/README.md +0 -306
  180. package/docs/sdks/organization/README.md +0 -104
  181. package/docs/sdks/passthrough/README.md +0 -249
  182. package/docs/sdks/payment/README.md +0 -306
  183. package/docs/sdks/payout/README.md +0 -104
  184. package/docs/sdks/person/README.md +0 -51
  185. package/docs/sdks/pipeline/README.md +0 -306
  186. package/docs/sdks/refund/README.md +0 -104
  187. package/docs/sdks/scorecard/README.md +0 -324
  188. package/docs/sdks/storage/README.md +0 -330
  189. package/docs/sdks/taxrate/README.md +0 -312
  190. package/docs/sdks/ticket/README.md +0 -318
  191. package/docs/sdks/ticketing/README.md +0 -962
  192. package/docs/sdks/transaction/README.md +0 -327
  193. package/docs/sdks/uc/README.md +0 -388
  194. package/docs/sdks/unified/README.md +0 -929
  195. package/docs/sdks/unifiedto/README.md +0 -9
  196. package/docs/sdks/webhook/README.md +0 -291
package/docs/sdks/unified/README.md DELETED
@@ -1,929 +0,0 @@
1
- # Unified
2
- (*unified*)
3
-
4
- ### Available Operations
5
-
6
- * [createUnifiedConnection](#createunifiedconnection) - Create connection
7
- * [createUnifiedWebhook](#createunifiedwebhook) - Create webhook subscription
8
- * [getUnifiedApicall](#getunifiedapicall) - Retrieve specific API Call by its ID
9
- * [getUnifiedConnection](#getunifiedconnection) - Retrieve connection
10
- * [getUnifiedIntegrationAuth](#getunifiedintegrationauth) - Create connection indirectly
11
- * [getUnifiedWebhook](#getunifiedwebhook) - Retrieve webhook by its ID
12
- * [listUnifiedApicalls](#listunifiedapicalls) - Returns API Calls
13
- * [listUnifiedConnections](#listunifiedconnections) - List all connections
14
- * [listUnifiedIntegrationWorkspaces](#listunifiedintegrationworkspaces) - Returns all activated integrations in a workspace
15
- * [listUnifiedIntegrations](#listunifiedintegrations) - Returns all integrations
16
- * [listUnifiedIssues](#listunifiedissues) - List support issues
17
- * [listUnifiedWebhooks](#listunifiedwebhooks) - Returns all registered webhooks
18
- * [patchUnifiedConnection](#patchunifiedconnection) - Update connection
19
- * [patchUnifiedWebhookTrigger](#patchunifiedwebhooktrigger) - Trigger webhook
20
- * [removeUnifiedConnection](#removeunifiedconnection) - Remove connection
21
- * [removeUnifiedWebhook](#removeunifiedwebhook) - Remove webhook subscription
22
- * [updateUnifiedConnection](#updateunifiedconnection) - Update connection
23
- * [updateUnifiedWebhookTrigger](#updateunifiedwebhooktrigger) - Trigger webhook
24
-
25
- ## createUnifiedConnection
26
-
27
- Create connection
28
-
29
- ### Example Usage
30
-
31
- ```typescript
32
- import { UnifiedTo } from "@unified-api/typescript-sdk";
33
- import { PropertyConnectionCategories, PropertyConnectionPermissions } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
34
-
35
- async function run() {
36
- const sdk = new UnifiedTo({
37
- security: {
38
- jwt: "<YOUR_API_KEY_HERE>",
39
- },
40
- });
41
-
42
- const res = await sdk.unified.createUnifiedConnection({
43
- auth: {
44
- emails: [
45
- "<value>",
46
- ],
47
- meta: {
48
- "key": "<value>",
49
- },
50
- otherAuthInfo: [
51
- "<value>",
52
- ],
53
- },
54
- categories: [
55
- PropertyConnectionCategories.Commerce,
56
- ],
57
- cursorsCache: [
58
- {
59
- "key": "<value>",
60
- },
61
- ],
62
- integrationType: "<value>",
63
- permissions: [
64
- PropertyConnectionPermissions.AtsCandidateRead,
65
- ],
66
- });
67
-
68
- if (res.statusCode == 200) {
69
- // handle response
70
- }
71
- }
72
-
73
- run();
74
- ```
75
-
76
- ### Parameters
77
-
78
- | Parameter | Type | Required | Description |
79
- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
80
- | `request` | [shared.Connection](../../sdk/models/shared/connection.md) | :heavy_check_mark: | The request object to use for the request. |
81
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
82
-
83
-
84
- ### Response
85
-
86
- **Promise<[operations.CreateUnifiedConnectionResponse](../../sdk/models/operations/createunifiedconnectionresponse.md)>**
87
- ### Errors
88
-
89
- | Error Object | Status Code | Content Type |
90
- | --------------- | --------------- | --------------- |
91
- | errors.SDKError | 4xx-5xx | */* |
92
-
93
- ## createUnifiedWebhook
94
-
95
- The data payload received by your server is described at https://docs.unified.to/unified/overview. The `interval` field can be set as low as 1 minute for paid accounts, and 60 minutes for free accounts.
96
-
97
- ### Example Usage
98
-
99
- ```typescript
100
- import { UnifiedTo } from "@unified-api/typescript-sdk";
101
- import { Event, ObjectType, WebhookWebhookType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
102
-
103
- async function run() {
104
- const sdk = new UnifiedTo({
105
- security: {
106
- jwt: "<YOUR_API_KEY_HERE>",
107
- },
108
- });
109
-
110
- const res = await sdk.unified.createUnifiedWebhook({
111
- webhook: {
112
- connectionId: "<value>",
113
- event: Event.Created,
114
- hookUrl: "<value>",
115
- meta: {
116
- "key": "<value>",
117
- },
118
- objectType: ObjectType.AccountingAccount,
119
- runs: [
120
- "<value>",
121
- ],
122
- },
123
- });
124
-
125
- if (res.statusCode == 200) {
126
- // handle response
127
- }
128
- }
129
-
130
- run();
131
- ```
132
-
133
- ### Parameters
134
-
135
- | Parameter | Type | Required | Description |
136
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
137
- | `request` | [operations.CreateUnifiedWebhookRequest](../../sdk/models/operations/createunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
138
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
139
-
140
-
141
- ### Response
142
-
143
- **Promise<[operations.CreateUnifiedWebhookResponse](../../sdk/models/operations/createunifiedwebhookresponse.md)>**
144
- ### Errors
145
-
146
- | Error Object | Status Code | Content Type |
147
- | --------------- | --------------- | --------------- |
148
- | errors.SDKError | 4xx-5xx | */* |
149
-
150
- ## getUnifiedApicall
151
-
152
- Retrieve specific API Call by its ID
153
-
154
- ### Example Usage
155
-
156
- ```typescript
157
- import { UnifiedTo } from "@unified-api/typescript-sdk";
158
-
159
- async function run() {
160
- const sdk = new UnifiedTo({
161
- security: {
162
- jwt: "<YOUR_API_KEY_HERE>",
163
- },
164
- });
165
-
166
- const res = await sdk.unified.getUnifiedApicall({
167
- id: "<id>",
168
- });
169
-
170
- if (res.statusCode == 200) {
171
- // handle response
172
- }
173
- }
174
-
175
- run();
176
- ```
177
-
178
- ### Parameters
179
-
180
- | Parameter | Type | Required | Description |
181
- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
182
- | `request` | [operations.GetUnifiedApicallRequest](../../sdk/models/operations/getunifiedapicallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
183
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
184
-
185
-
186
- ### Response
187
-
188
- **Promise<[operations.GetUnifiedApicallResponse](../../sdk/models/operations/getunifiedapicallresponse.md)>**
189
- ### Errors
190
-
191
- | Error Object | Status Code | Content Type |
192
- | --------------- | --------------- | --------------- |
193
- | errors.SDKError | 4xx-5xx | */* |
194
-
195
- ## getUnifiedConnection
196
-
197
- Retrieve connection
198
-
199
- ### Example Usage
200
-
201
- ```typescript
202
- import { UnifiedTo } from "@unified-api/typescript-sdk";
203
-
204
- async function run() {
205
- const sdk = new UnifiedTo({
206
- security: {
207
- jwt: "<YOUR_API_KEY_HERE>",
208
- },
209
- });
210
-
211
- const res = await sdk.unified.getUnifiedConnection({
212
- id: "<id>",
213
- });
214
-
215
- if (res.statusCode == 200) {
216
- // handle response
217
- }
218
- }
219
-
220
- run();
221
- ```
222
-
223
- ### Parameters
224
-
225
- | Parameter | Type | Required | Description |
226
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
227
- | `request` | [operations.GetUnifiedConnectionRequest](../../sdk/models/operations/getunifiedconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
228
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
229
-
230
-
231
- ### Response
232
-
233
- **Promise<[operations.GetUnifiedConnectionResponse](../../sdk/models/operations/getunifiedconnectionresponse.md)>**
234
- ### Errors
235
-
236
- | Error Object | Status Code | Content Type |
237
- | --------------- | --------------- | --------------- |
238
- | errors.SDKError | 4xx-5xx | */* |
239
-
240
- ## getUnifiedIntegrationAuth
241
-
242
- Returns an authorization URL for the specified integration. Once a successful authorization occurs, a new connection is created.
243
-
244
- ### Example Usage
245
-
246
- ```typescript
247
- import { UnifiedTo } from "@unified-api/typescript-sdk";
248
- import { Scopes } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
249
-
250
- async function run() {
251
- const sdk = new UnifiedTo({
252
- security: {
253
- jwt: "<YOUR_API_KEY_HERE>",
254
- },
255
- });
256
-
257
- const res = await sdk.unified.getUnifiedIntegrationAuth({
258
- integrationType: "<value>",
259
- scopes: [
260
- Scopes.HrisEmployeeWrite,
261
- ],
262
- workspaceId: "<value>",
263
- });
264
-
265
- if (res.statusCode == 200) {
266
- // handle response
267
- }
268
- }
269
-
270
- run();
271
- ```
272
-
273
- ### Parameters
274
-
275
- | Parameter | Type | Required | Description |
276
- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
277
- | `request` | [operations.GetUnifiedIntegrationAuthRequest](../../sdk/models/operations/getunifiedintegrationauthrequest.md) | :heavy_check_mark: | The request object to use for the request. |
278
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
279
-
280
-
281
- ### Response
282
-
283
- **Promise<[operations.GetUnifiedIntegrationAuthResponse](../../sdk/models/operations/getunifiedintegrationauthresponse.md)>**
284
- ### Errors
285
-
286
- | Error Object | Status Code | Content Type |
287
- | --------------- | --------------- | --------------- |
288
- | errors.SDKError | 4xx-5xx | */* |
289
-
290
- ## getUnifiedWebhook
291
-
292
- Retrieve webhook by its ID
293
-
294
- ### Example Usage
295
-
296
- ```typescript
297
- import { UnifiedTo } from "@unified-api/typescript-sdk";
298
-
299
- async function run() {
300
- const sdk = new UnifiedTo({
301
- security: {
302
- jwt: "<YOUR_API_KEY_HERE>",
303
- },
304
- });
305
-
306
- const res = await sdk.unified.getUnifiedWebhook({
307
- id: "<id>",
308
- });
309
-
310
- if (res.statusCode == 200) {
311
- // handle response
312
- }
313
- }
314
-
315
- run();
316
- ```
317
-
318
- ### Parameters
319
-
320
- | Parameter | Type | Required | Description |
321
- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
322
- | `request` | [operations.GetUnifiedWebhookRequest](../../sdk/models/operations/getunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
323
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
324
-
325
-
326
- ### Response
327
-
328
- **Promise<[operations.GetUnifiedWebhookResponse](../../sdk/models/operations/getunifiedwebhookresponse.md)>**
329
- ### Errors
330
-
331
- | Error Object | Status Code | Content Type |
332
- | --------------- | --------------- | --------------- |
333
- | errors.SDKError | 4xx-5xx | */* |
334
-
335
- ## listUnifiedApicalls
336
-
337
- Returns API Calls
338
-
339
- ### Example Usage
340
-
341
- ```typescript
342
- import { UnifiedTo } from "@unified-api/typescript-sdk";
343
-
344
- async function run() {
345
- const sdk = new UnifiedTo({
346
- security: {
347
- jwt: "<YOUR_API_KEY_HERE>",
348
- },
349
- });
350
-
351
- const res = await sdk.unified.listUnifiedApicalls({});
352
-
353
- if (res.statusCode == 200) {
354
- // handle response
355
- }
356
- }
357
-
358
- run();
359
- ```
360
-
361
- ### Parameters
362
-
363
- | Parameter | Type | Required | Description |
364
- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
365
- | `request` | [operations.ListUnifiedApicallsRequest](../../sdk/models/operations/listunifiedapicallsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
366
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
367
-
368
-
369
- ### Response
370
-
371
- **Promise<[operations.ListUnifiedApicallsResponse](../../sdk/models/operations/listunifiedapicallsresponse.md)>**
372
- ### Errors
373
-
374
- | Error Object | Status Code | Content Type |
375
- | --------------- | --------------- | --------------- |
376
- | errors.SDKError | 4xx-5xx | */* |
377
-
378
- ## listUnifiedConnections
379
-
380
- List all connections
381
-
382
- ### Example Usage
383
-
384
- ```typescript
385
- import { UnifiedTo } from "@unified-api/typescript-sdk";
386
- import { Categories } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
387
-
388
- async function run() {
389
- const sdk = new UnifiedTo({
390
- security: {
391
- jwt: "<YOUR_API_KEY_HERE>",
392
- },
393
- });
394
-
395
- const res = await sdk.unified.listUnifiedConnections({
396
- categories: [
397
- Categories.Martech,
398
- ],
399
- });
400
-
401
- if (res.statusCode == 200) {
402
- // handle response
403
- }
404
- }
405
-
406
- run();
407
- ```
408
-
409
- ### Parameters
410
-
411
- | Parameter | Type | Required | Description |
412
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
413
- | `request` | [operations.ListUnifiedConnectionsRequest](../../sdk/models/operations/listunifiedconnectionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
414
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
415
-
416
-
417
- ### Response
418
-
419
- **Promise<[operations.ListUnifiedConnectionsResponse](../../sdk/models/operations/listunifiedconnectionsresponse.md)>**
420
- ### Errors
421
-
422
- | Error Object | Status Code | Content Type |
423
- | --------------- | --------------- | --------------- |
424
- | errors.SDKError | 4xx-5xx | */* |
425
-
426
- ## listUnifiedIntegrationWorkspaces
427
-
428
- No authentication required as this is to be used by front-end interface
429
-
430
- ### Example Usage
431
-
432
- ```typescript
433
- import { UnifiedTo } from "@unified-api/typescript-sdk";
434
- import { QueryParamCategories } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
435
-
436
- async function run() {
437
- const sdk = new UnifiedTo({
438
- security: {
439
- jwt: "<YOUR_API_KEY_HERE>",
440
- },
441
- });
442
-
443
- const res = await sdk.unified.listUnifiedIntegrationWorkspaces({
444
- categories: [
445
- QueryParamCategories.Accounting,
446
- ],
447
- workspaceId: "<value>",
448
- });
449
-
450
- if (res.statusCode == 200) {
451
- // handle response
452
- }
453
- }
454
-
455
- run();
456
- ```
457
-
458
- ### Parameters
459
-
460
- | Parameter | Type | Required | Description |
461
- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
462
- | `request` | [operations.ListUnifiedIntegrationWorkspacesRequest](../../sdk/models/operations/listunifiedintegrationworkspacesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
463
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
464
-
465
-
466
- ### Response
467
-
468
- **Promise<[operations.ListUnifiedIntegrationWorkspacesResponse](../../sdk/models/operations/listunifiedintegrationworkspacesresponse.md)>**
469
- ### Errors
470
-
471
- | Error Object | Status Code | Content Type |
472
- | --------------- | --------------- | --------------- |
473
- | errors.SDKError | 4xx-5xx | */* |
474
-
475
- ## listUnifiedIntegrations
476
-
477
- Returns all integrations
478
-
479
- ### Example Usage
480
-
481
- ```typescript
482
- import { UnifiedTo } from "@unified-api/typescript-sdk";
483
- import { ListUnifiedIntegrationsQueryParamCategories } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
484
-
485
- async function run() {
486
- const sdk = new UnifiedTo({
487
- security: {
488
- jwt: "<YOUR_API_KEY_HERE>",
489
- },
490
- });
491
-
492
- const res = await sdk.unified.listUnifiedIntegrations({
493
- categories: [
494
- ListUnifiedIntegrationsQueryParamCategories.Crm,
495
- ],
496
- });
497
-
498
- if (res.statusCode == 200) {
499
- // handle response
500
- }
501
- }
502
-
503
- run();
504
- ```
505
-
506
- ### Parameters
507
-
508
- | Parameter | Type | Required | Description |
509
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
510
- | `request` | [operations.ListUnifiedIntegrationsRequest](../../sdk/models/operations/listunifiedintegrationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
511
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
512
-
513
-
514
- ### Response
515
-
516
- **Promise<[operations.ListUnifiedIntegrationsResponse](../../sdk/models/operations/listunifiedintegrationsresponse.md)>**
517
- ### Errors
518
-
519
- | Error Object | Status Code | Content Type |
520
- | --------------- | --------------- | --------------- |
521
- | errors.SDKError | 4xx-5xx | */* |
522
-
523
- ## listUnifiedIssues
524
-
525
- List support issues
526
-
527
- ### Example Usage
528
-
529
- ```typescript
530
- import { UnifiedTo } from "@unified-api/typescript-sdk";
531
-
532
- async function run() {
533
- const sdk = new UnifiedTo({
534
- security: {
535
- jwt: "<YOUR_API_KEY_HERE>",
536
- },
537
- });
538
-
539
- const res = await sdk.unified.listUnifiedIssues({});
540
-
541
- if (res.statusCode == 200) {
542
- // handle response
543
- }
544
- }
545
-
546
- run();
547
- ```
548
-
549
- ### Parameters
550
-
551
- | Parameter | Type | Required | Description |
552
- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
553
- | `request` | [operations.ListUnifiedIssuesRequest](../../sdk/models/operations/listunifiedissuesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
554
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
555
-
556
-
557
- ### Response
558
-
559
- **Promise<[operations.ListUnifiedIssuesResponse](../../sdk/models/operations/listunifiedissuesresponse.md)>**
560
- ### Errors
561
-
562
- | Error Object | Status Code | Content Type |
563
- | --------------- | --------------- | --------------- |
564
- | errors.SDKError | 4xx-5xx | */* |
565
-
566
- ## listUnifiedWebhooks
567
-
568
- Returns all registered webhooks
569
-
570
- ### Example Usage
571
-
572
- ```typescript
573
- import { UnifiedTo } from "@unified-api/typescript-sdk";
574
-
575
- async function run() {
576
- const sdk = new UnifiedTo({
577
- security: {
578
- jwt: "<YOUR_API_KEY_HERE>",
579
- },
580
- });
581
-
582
- const res = await sdk.unified.listUnifiedWebhooks({});
583
-
584
- if (res.statusCode == 200) {
585
- // handle response
586
- }
587
- }
588
-
589
- run();
590
- ```
591
-
592
- ### Parameters
593
-
594
- | Parameter | Type | Required | Description |
595
- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
596
- | `request` | [operations.ListUnifiedWebhooksRequest](../../sdk/models/operations/listunifiedwebhooksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
597
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
598
-
599
-
600
- ### Response
601
-
602
- **Promise<[operations.ListUnifiedWebhooksResponse](../../sdk/models/operations/listunifiedwebhooksresponse.md)>**
603
- ### Errors
604
-
605
- | Error Object | Status Code | Content Type |
606
- | --------------- | --------------- | --------------- |
607
- | errors.SDKError | 4xx-5xx | */* |
608
-
609
- ## patchUnifiedConnection
610
-
611
- Update connection
612
-
613
- ### Example Usage
614
-
615
- ```typescript
616
- import { UnifiedTo } from "@unified-api/typescript-sdk";
617
- import { PropertyConnectionCategories, PropertyConnectionPermissions } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
618
-
619
- async function run() {
620
- const sdk = new UnifiedTo({
621
- security: {
622
- jwt: "<YOUR_API_KEY_HERE>",
623
- },
624
- });
625
-
626
- const res = await sdk.unified.patchUnifiedConnection({
627
- connection: {
628
- auth: {
629
- emails: [
630
- "<value>",
631
- ],
632
- meta: {
633
- "key": "<value>",
634
- },
635
- otherAuthInfo: [
636
- "<value>",
637
- ],
638
- },
639
- categories: [
640
- PropertyConnectionCategories.Ticketing,
641
- ],
642
- cursorsCache: [
643
- {
644
- "key": "<value>",
645
- },
646
- ],
647
- integrationType: "<value>",
648
- permissions: [
649
- PropertyConnectionPermissions.CrmLeadWrite,
650
- ],
651
- },
652
- id: "<id>",
653
- });
654
-
655
- if (res.statusCode == 200) {
656
- // handle response
657
- }
658
- }
659
-
660
- run();
661
- ```
662
-
663
- ### Parameters
664
-
665
- | Parameter | Type | Required | Description |
666
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
667
- | `request` | [operations.PatchUnifiedConnectionRequest](../../sdk/models/operations/patchunifiedconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
668
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
669
-
670
-
671
- ### Response
672
-
673
- **Promise<[operations.PatchUnifiedConnectionResponse](../../sdk/models/operations/patchunifiedconnectionresponse.md)>**
674
- ### Errors
675
-
676
- | Error Object | Status Code | Content Type |
677
- | --------------- | --------------- | --------------- |
678
- | errors.SDKError | 4xx-5xx | */* |
679
-
680
- ## patchUnifiedWebhookTrigger
681
-
682
- Trigger webhook
683
-
684
- ### Example Usage
685
-
686
- ```typescript
687
- import { UnifiedTo } from "@unified-api/typescript-sdk";
688
-
689
- async function run() {
690
- const sdk = new UnifiedTo({
691
- security: {
692
- jwt: "<YOUR_API_KEY_HERE>",
693
- },
694
- });
695
-
696
- const res = await sdk.unified.patchUnifiedWebhookTrigger({
697
- id: "<id>",
698
- });
699
-
700
- if (res.statusCode == 200) {
701
- // handle response
702
- }
703
- }
704
-
705
- run();
706
- ```
707
-
708
- ### Parameters
709
-
710
- | Parameter | Type | Required | Description |
711
- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
712
- | `request` | [operations.PatchUnifiedWebhookTriggerRequest](../../sdk/models/operations/patchunifiedwebhooktriggerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
713
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
714
-
715
-
716
- ### Response
717
-
718
- **Promise<[operations.PatchUnifiedWebhookTriggerResponse](../../sdk/models/operations/patchunifiedwebhooktriggerresponse.md)>**
719
- ### Errors
720
-
721
- | Error Object | Status Code | Content Type |
722
- | --------------- | --------------- | --------------- |
723
- | errors.SDKError | 4xx-5xx | */* |
724
-
725
- ## removeUnifiedConnection
726
-
727
- Remove connection
728
-
729
- ### Example Usage
730
-
731
- ```typescript
732
- import { UnifiedTo } from "@unified-api/typescript-sdk";
733
-
734
- async function run() {
735
- const sdk = new UnifiedTo({
736
- security: {
737
- jwt: "<YOUR_API_KEY_HERE>",
738
- },
739
- });
740
-
741
- const res = await sdk.unified.removeUnifiedConnection({
742
- id: "<id>",
743
- });
744
-
745
- if (res.statusCode == 200) {
746
- // handle response
747
- }
748
- }
749
-
750
- run();
751
- ```
752
-
753
- ### Parameters
754
-
755
- | Parameter | Type | Required | Description |
756
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
757
- | `request` | [operations.RemoveUnifiedConnectionRequest](../../sdk/models/operations/removeunifiedconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
758
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
759
-
760
-
761
- ### Response
762
-
763
- **Promise<[operations.RemoveUnifiedConnectionResponse](../../sdk/models/operations/removeunifiedconnectionresponse.md)>**
764
- ### Errors
765
-
766
- | Error Object | Status Code | Content Type |
767
- | --------------- | --------------- | --------------- |
768
- | errors.SDKError | 4xx-5xx | */* |
769
-
770
- ## removeUnifiedWebhook
771
-
772
- Remove webhook subscription
773
-
774
- ### Example Usage
775
-
776
- ```typescript
777
- import { UnifiedTo } from "@unified-api/typescript-sdk";
778
-
779
- async function run() {
780
- const sdk = new UnifiedTo({
781
- security: {
782
- jwt: "<YOUR_API_KEY_HERE>",
783
- },
784
- });
785
-
786
- const res = await sdk.unified.removeUnifiedWebhook({
787
- id: "<id>",
788
- });
789
-
790
- if (res.statusCode == 200) {
791
- // handle response
792
- }
793
- }
794
-
795
- run();
796
- ```
797
-
798
- ### Parameters
799
-
800
- | Parameter | Type | Required | Description |
801
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
802
- | `request` | [operations.RemoveUnifiedWebhookRequest](../../sdk/models/operations/removeunifiedwebhookrequest.md) | :heavy_check_mark: | The request object to use for the request. |
803
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
804
-
805
-
806
- ### Response
807
-
808
- **Promise<[operations.RemoveUnifiedWebhookResponse](../../sdk/models/operations/removeunifiedwebhookresponse.md)>**
809
- ### Errors
810
-
811
- | Error Object | Status Code | Content Type |
812
- | --------------- | --------------- | --------------- |
813
- | errors.SDKError | 4xx-5xx | */* |
814
-
815
- ## updateUnifiedConnection
816
-
817
- Update connection
818
-
819
- ### Example Usage
820
-
821
- ```typescript
822
- import { UnifiedTo } from "@unified-api/typescript-sdk";
823
- import { PropertyConnectionCategories, PropertyConnectionPermissions } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
824
-
825
- async function run() {
826
- const sdk = new UnifiedTo({
827
- security: {
828
- jwt: "<YOUR_API_KEY_HERE>",
829
- },
830
- });
831
-
832
- const res = await sdk.unified.updateUnifiedConnection({
833
- connection: {
834
- auth: {
835
- emails: [
836
- "<value>",
837
- ],
838
- meta: {
839
- "key": "<value>",
840
- },
841
- otherAuthInfo: [
842
- "<value>",
843
- ],
844
- },
845
- categories: [
846
- PropertyConnectionCategories.Accounting,
847
- ],
848
- cursorsCache: [
849
- {
850
- "key": "<value>",
851
- },
852
- ],
853
- integrationType: "<value>",
854
- permissions: [
855
- PropertyConnectionPermissions.AtsCompanyRead,
856
- ],
857
- },
858
- id: "<id>",
859
- });
860
-
861
- if (res.statusCode == 200) {
862
- // handle response
863
- }
864
- }
865
-
866
- run();
867
- ```
868
-
869
- ### Parameters
870
-
871
- | Parameter | Type | Required | Description |
872
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
873
- | `request` | [operations.UpdateUnifiedConnectionRequest](../../sdk/models/operations/updateunifiedconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
874
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
875
-
876
-
877
- ### Response
878
-
879
- **Promise<[operations.UpdateUnifiedConnectionResponse](../../sdk/models/operations/updateunifiedconnectionresponse.md)>**
880
- ### Errors
881
-
882
- | Error Object | Status Code | Content Type |
883
- | --------------- | --------------- | --------------- |
884
- | errors.SDKError | 4xx-5xx | */* |
885
-
886
- ## updateUnifiedWebhookTrigger
887
-
888
- Trigger webhook
889
-
890
- ### Example Usage
891
-
892
- ```typescript
893
- import { UnifiedTo } from "@unified-api/typescript-sdk";
894
-
895
- async function run() {
896
- const sdk = new UnifiedTo({
897
- security: {
898
- jwt: "<YOUR_API_KEY_HERE>",
899
- },
900
- });
901
-
902
- const res = await sdk.unified.updateUnifiedWebhookTrigger({
903
- id: "<id>",
904
- });
905
-
906
- if (res.statusCode == 200) {
907
- // handle response
908
- }
909
- }
910
-
911
- run();
912
- ```
913
-
914
- ### Parameters
915
-
916
- | Parameter | Type | Required | Description |
917
- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
918
- | `request` | [operations.UpdateUnifiedWebhookTriggerRequest](../../sdk/models/operations/updateunifiedwebhooktriggerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
919
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
920
-
921
-
922
- ### Response
923
-
924
- **Promise<[operations.UpdateUnifiedWebhookTriggerResponse](../../sdk/models/operations/updateunifiedwebhooktriggerresponse.md)>**
925
- ### Errors
926
-
927
- | Error Object | Status Code | Content Type |
928
- | --------------- | --------------- | --------------- |
929
- | errors.SDKError | 4xx-5xx | */* |