@unified-api/typescript-sdk 2.9.22 → 2.9.24

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 (219) hide show
  1. package/FUNCTIONS.md +1 -1
  2. package/README.md +20 -8
  3. package/docs/sdks/account/README.md +12 -12
  4. package/docs/sdks/accounting/README.md +76 -76
  5. package/docs/sdks/activity/README.md +12 -12
  6. package/docs/sdks/application/README.md +12 -12
  7. package/docs/sdks/applicationstatus/README.md +2 -2
  8. package/docs/sdks/ats/README.md +90 -90
  9. package/docs/sdks/auth/README.md +4 -4
  10. package/docs/sdks/call/README.md +2 -2
  11. package/docs/sdks/candidate/README.md +12 -12
  12. package/docs/sdks/channel/README.md +4 -4
  13. package/docs/sdks/collection/README.md +12 -12
  14. package/docs/sdks/comment/README.md +494 -0
  15. package/docs/sdks/commerce/README.md +48 -48
  16. package/docs/sdks/company/README.md +30 -30
  17. package/docs/sdks/contact/README.md +36 -36
  18. package/docs/sdks/crm/README.md +72 -72
  19. package/docs/sdks/customer/README.md +12 -12
  20. package/docs/sdks/deal/README.md +12 -12
  21. package/docs/sdks/document/README.md +12 -12
  22. package/docs/sdks/employee/README.md +12 -12
  23. package/docs/sdks/enrich/README.md +4 -4
  24. package/docs/sdks/event/README.md +12 -12
  25. package/docs/sdks/file/README.md +12 -12
  26. package/docs/sdks/genai/README.md +4 -4
  27. package/docs/sdks/group/README.md +12 -12
  28. package/docs/sdks/hris/README.md +56 -56
  29. package/docs/sdks/integration/README.md +4 -4
  30. package/docs/sdks/interview/README.md +12 -12
  31. package/docs/sdks/inventory/README.md +12 -12
  32. package/docs/sdks/invoice/README.md +12 -12
  33. package/docs/sdks/item/README.md +12 -12
  34. package/docs/sdks/job/README.md +12 -12
  35. package/docs/sdks/journal/README.md +12 -12
  36. package/docs/sdks/kms/README.md +518 -24
  37. package/docs/sdks/lead/README.md +12 -12
  38. package/docs/sdks/link/README.md +12 -12
  39. package/docs/sdks/list/README.md +12 -12
  40. package/docs/sdks/location/README.md +24 -24
  41. package/docs/sdks/login/README.md +2 -2
  42. package/docs/sdks/martech/README.md +24 -24
  43. package/docs/sdks/member/README.md +12 -12
  44. package/docs/sdks/message/README.md +12 -12
  45. package/docs/sdks/messaging/README.md +16 -16
  46. package/docs/sdks/model/README.md +2 -2
  47. package/docs/sdks/note/README.md +12 -12
  48. package/docs/sdks/organization/README.md +4 -4
  49. package/docs/sdks/page/README.md +12 -12
  50. package/docs/sdks/passthrough/README.md +28 -28
  51. package/docs/sdks/payment/README.md +32 -32
  52. package/docs/sdks/payout/README.md +4 -4
  53. package/docs/sdks/payslip/README.md +4 -4
  54. package/docs/sdks/person/README.md +2 -2
  55. package/docs/sdks/pipeline/README.md +12 -12
  56. package/docs/sdks/project/README.md +12 -12
  57. package/docs/sdks/prompt/README.md +2 -2
  58. package/docs/sdks/refund/README.md +4 -4
  59. package/docs/sdks/scorecard/README.md +12 -12
  60. package/docs/sdks/space/README.md +12 -12
  61. package/docs/sdks/storage/README.md +12 -12
  62. package/docs/sdks/task/README.md +24 -24
  63. package/docs/sdks/taxrate/README.md +12 -12
  64. package/docs/sdks/ticket/README.md +12 -12
  65. package/docs/sdks/ticketing/README.md +36 -36
  66. package/docs/sdks/timeoff/README.md +4 -4
  67. package/docs/sdks/transaction/README.md +12 -12
  68. package/docs/sdks/uc/README.md +14 -14
  69. package/docs/sdks/unified/README.md +4 -4
  70. package/funcs/commentCreateKmsComment.d.ts +13 -0
  71. package/funcs/commentCreateKmsComment.d.ts.map +1 -0
  72. package/funcs/commentCreateKmsComment.js +104 -0
  73. package/funcs/commentCreateKmsComment.js.map +1 -0
  74. package/funcs/commentGetKmsComment.d.ts +13 -0
  75. package/funcs/commentGetKmsComment.d.ts.map +1 -0
  76. package/funcs/commentGetKmsComment.js +107 -0
  77. package/funcs/commentGetKmsComment.js.map +1 -0
  78. package/funcs/commentListKmsComments.d.ts +13 -0
  79. package/funcs/commentListKmsComments.d.ts.map +1 -0
  80. package/funcs/commentListKmsComments.js +113 -0
  81. package/funcs/commentListKmsComments.js.map +1 -0
  82. package/funcs/commentPatchKmsComment.d.ts +13 -0
  83. package/funcs/commentPatchKmsComment.d.ts.map +1 -0
  84. package/funcs/commentPatchKmsComment.js +108 -0
  85. package/funcs/commentPatchKmsComment.js.map +1 -0
  86. package/funcs/commentRemoveKmsComment.d.ts +12 -0
  87. package/funcs/commentRemoveKmsComment.d.ts.map +1 -0
  88. package/funcs/commentRemoveKmsComment.js +105 -0
  89. package/funcs/commentRemoveKmsComment.js.map +1 -0
  90. package/funcs/commentUpdateKmsComment.d.ts +13 -0
  91. package/funcs/commentUpdateKmsComment.d.ts.map +1 -0
  92. package/funcs/commentUpdateKmsComment.js +108 -0
  93. package/funcs/commentUpdateKmsComment.js.map +1 -0
  94. package/funcs/kmsCreateKmsComment.d.ts +13 -0
  95. package/funcs/kmsCreateKmsComment.d.ts.map +1 -0
  96. package/funcs/kmsCreateKmsComment.js +104 -0
  97. package/funcs/kmsCreateKmsComment.js.map +1 -0
  98. package/funcs/kmsGetKmsComment.d.ts +13 -0
  99. package/funcs/kmsGetKmsComment.d.ts.map +1 -0
  100. package/funcs/kmsGetKmsComment.js +107 -0
  101. package/funcs/kmsGetKmsComment.js.map +1 -0
  102. package/funcs/kmsListKmsComments.d.ts +13 -0
  103. package/funcs/kmsListKmsComments.d.ts.map +1 -0
  104. package/funcs/kmsListKmsComments.js +113 -0
  105. package/funcs/kmsListKmsComments.js.map +1 -0
  106. package/funcs/kmsPatchKmsComment.d.ts +13 -0
  107. package/funcs/kmsPatchKmsComment.d.ts.map +1 -0
  108. package/funcs/kmsPatchKmsComment.js +108 -0
  109. package/funcs/kmsPatchKmsComment.js.map +1 -0
  110. package/funcs/kmsRemoveKmsComment.d.ts +12 -0
  111. package/funcs/kmsRemoveKmsComment.d.ts.map +1 -0
  112. package/funcs/kmsRemoveKmsComment.js +105 -0
  113. package/funcs/kmsRemoveKmsComment.js.map +1 -0
  114. package/funcs/kmsUpdateKmsComment.d.ts +13 -0
  115. package/funcs/kmsUpdateKmsComment.d.ts.map +1 -0
  116. package/funcs/kmsUpdateKmsComment.js +108 -0
  117. package/funcs/kmsUpdateKmsComment.js.map +1 -0
  118. package/jsr.json +1 -1
  119. package/lib/config.d.ts +3 -3
  120. package/lib/config.js +3 -3
  121. package/lib/schemas.d.ts +1 -1
  122. package/lib/schemas.d.ts.map +1 -1
  123. package/lib/schemas.js +4 -1
  124. package/lib/schemas.js.map +1 -1
  125. package/package.json +1 -1
  126. package/sdk/comment.d.ts +24 -0
  127. package/sdk/comment.d.ts.map +1 -1
  128. package/sdk/comment.js +42 -0
  129. package/sdk/comment.js.map +1 -1
  130. package/sdk/kms.d.ts +24 -0
  131. package/sdk/kms.d.ts.map +1 -1
  132. package/sdk/kms.js +42 -0
  133. package/sdk/kms.js.map +1 -1
  134. package/sdk/models/operations/createkmscomment.d.ts +40 -0
  135. package/sdk/models/operations/createkmscomment.d.ts.map +1 -0
  136. package/sdk/models/operations/createkmscomment.js +75 -0
  137. package/sdk/models/operations/createkmscomment.js.map +1 -0
  138. package/sdk/models/operations/getkmscomment.d.ts +42 -0
  139. package/sdk/models/operations/getkmscomment.d.ts.map +1 -0
  140. package/sdk/models/operations/getkmscomment.js +72 -0
  141. package/sdk/models/operations/getkmscomment.js.map +1 -0
  142. package/sdk/models/operations/index.d.ts +6 -0
  143. package/sdk/models/operations/index.d.ts.map +1 -1
  144. package/sdk/models/operations/index.js +6 -0
  145. package/sdk/models/operations/index.js.map +1 -1
  146. package/sdk/models/operations/listkmscomments.d.ts +61 -0
  147. package/sdk/models/operations/listkmscomments.d.ts.map +1 -0
  148. package/sdk/models/operations/listkmscomments.js +95 -0
  149. package/sdk/models/operations/listkmscomments.js.map +1 -0
  150. package/sdk/models/operations/patchkmscomment.d.ts +45 -0
  151. package/sdk/models/operations/patchkmscomment.d.ts.map +1 -0
  152. package/sdk/models/operations/patchkmscomment.js +77 -0
  153. package/sdk/models/operations/patchkmscomment.js.map +1 -0
  154. package/sdk/models/operations/removekmscomment.d.ts +66 -0
  155. package/sdk/models/operations/removekmscomment.d.ts.map +1 -0
  156. package/sdk/models/operations/removekmscomment.js +105 -0
  157. package/sdk/models/operations/removekmscomment.js.map +1 -0
  158. package/sdk/models/operations/updatekmscomment.d.ts +45 -0
  159. package/sdk/models/operations/updatekmscomment.d.ts.map +1 -0
  160. package/sdk/models/operations/updatekmscomment.js +77 -0
  161. package/sdk/models/operations/updatekmscomment.js.map +1 -0
  162. package/sdk/models/shared/index.d.ts +1 -0
  163. package/sdk/models/shared/index.d.ts.map +1 -1
  164. package/sdk/models/shared/index.js +1 -0
  165. package/sdk/models/shared/index.js.map +1 -1
  166. package/sdk/models/shared/integrationsupport.d.ts +32 -0
  167. package/sdk/models/shared/integrationsupport.d.ts.map +1 -1
  168. package/sdk/models/shared/integrationsupport.js +34 -5
  169. package/sdk/models/shared/integrationsupport.js.map +1 -1
  170. package/sdk/models/shared/kmscomment.d.ts +108 -0
  171. package/sdk/models/shared/kmscomment.d.ts.map +1 -0
  172. package/sdk/models/shared/kmscomment.js +139 -0
  173. package/sdk/models/shared/kmscomment.js.map +1 -0
  174. package/sdk/models/shared/kmspage.d.ts +5 -2
  175. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  176. package/sdk/models/shared/kmspage.js +3 -2
  177. package/sdk/models/shared/kmspage.js.map +1 -1
  178. package/sdk/models/shared/repoorganization.d.ts +5 -0
  179. package/sdk/models/shared/repoorganization.d.ts.map +1 -1
  180. package/sdk/models/shared/repoorganization.js +4 -0
  181. package/sdk/models/shared/repoorganization.js.map +1 -1
  182. package/sdk/models/shared/webhook.d.ts +3 -0
  183. package/sdk/models/shared/webhook.d.ts.map +1 -1
  184. package/sdk/models/shared/webhook.js +1 -0
  185. package/sdk/models/shared/webhook.js.map +1 -1
  186. package/sdk/sdk.d.ts +2 -2
  187. package/sdk/sdk.d.ts.map +1 -1
  188. package/sdk/sdk.js +3 -3
  189. package/sdk/sdk.js.map +1 -1
  190. package/src/funcs/commentCreateKmsComment.ts +135 -0
  191. package/src/funcs/commentGetKmsComment.ts +138 -0
  192. package/src/funcs/commentListKmsComments.ts +144 -0
  193. package/src/funcs/commentPatchKmsComment.ts +139 -0
  194. package/src/funcs/commentRemoveKmsComment.ts +141 -0
  195. package/src/funcs/commentUpdateKmsComment.ts +139 -0
  196. package/src/funcs/kmsCreateKmsComment.ts +135 -0
  197. package/src/funcs/kmsGetKmsComment.ts +138 -0
  198. package/src/funcs/kmsListKmsComments.ts +144 -0
  199. package/src/funcs/kmsPatchKmsComment.ts +139 -0
  200. package/src/funcs/kmsRemoveKmsComment.ts +141 -0
  201. package/src/funcs/kmsUpdateKmsComment.ts +139 -0
  202. package/src/lib/config.ts +3 -3
  203. package/src/lib/schemas.ts +5 -0
  204. package/src/sdk/comment.ts +90 -0
  205. package/src/sdk/kms.ts +90 -0
  206. package/src/sdk/models/operations/createkmscomment.ts +92 -0
  207. package/src/sdk/models/operations/getkmscomment.ts +92 -0
  208. package/src/sdk/models/operations/index.ts +6 -0
  209. package/src/sdk/models/operations/listkmscomments.ts +134 -0
  210. package/src/sdk/models/operations/patchkmscomment.ts +99 -0
  211. package/src/sdk/models/operations/removekmscomment.ts +151 -0
  212. package/src/sdk/models/operations/updatekmscomment.ts +99 -0
  213. package/src/sdk/models/shared/index.ts +1 -0
  214. package/src/sdk/models/shared/integrationsupport.ts +38 -0
  215. package/src/sdk/models/shared/kmscomment.ts +174 -0
  216. package/src/sdk/models/shared/kmspage.ts +5 -4
  217. package/src/sdk/models/shared/repoorganization.ts +9 -0
  218. package/src/sdk/models/shared/webhook.ts +1 -0
  219. package/src/sdk/sdk.ts +5 -5
@@ -0,0 +1,139 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { UnifiedToCore } from "../core.js";
6
+ import { encodeFormQuery, encodeJSON, encodeSimple } from "../lib/encodings.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { safeParse } from "../lib/schemas.js";
10
+ import { RequestOptions } from "../lib/sdks.js";
11
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
+ import { pathToFunc } from "../lib/url.js";
13
+ import {
14
+ ConnectionError,
15
+ InvalidRequestError,
16
+ RequestAbortedError,
17
+ RequestTimeoutError,
18
+ UnexpectedClientError,
19
+ } from "../sdk/models/errors/httpclienterrors.js";
20
+ import { SDKError } from "../sdk/models/errors/sdkerror.js";
21
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
22
+ import * as operations from "../sdk/models/operations/index.js";
23
+ import * as shared from "../sdk/models/shared/index.js";
24
+ import { Result } from "../sdk/types/fp.js";
25
+
26
+ /**
27
+ * Update a comment
28
+ */
29
+ export async function kmsPatchKmsComment(
30
+ client: UnifiedToCore,
31
+ request: operations.PatchKmsCommentRequest,
32
+ options?: RequestOptions,
33
+ ): Promise<
34
+ Result<
35
+ shared.KmsComment,
36
+ | SDKError
37
+ | SDKValidationError
38
+ | UnexpectedClientError
39
+ | InvalidRequestError
40
+ | RequestAbortedError
41
+ | RequestTimeoutError
42
+ | ConnectionError
43
+ >
44
+ > {
45
+ const parsed = safeParse(
46
+ request,
47
+ (value) => operations.PatchKmsCommentRequest$outboundSchema.parse(value),
48
+ "Input validation failed",
49
+ );
50
+ if (!parsed.ok) {
51
+ return parsed;
52
+ }
53
+ const payload = parsed.value;
54
+ const body = encodeJSON("body", payload.KmsComment, { explode: true });
55
+
56
+ const pathParams = {
57
+ connection_id: encodeSimple("connection_id", payload.connection_id, {
58
+ explode: false,
59
+ charEncoding: "percent",
60
+ }),
61
+ id: encodeSimple("id", payload.id, {
62
+ explode: false,
63
+ charEncoding: "percent",
64
+ }),
65
+ };
66
+
67
+ const path = pathToFunc("/kms/{connection_id}/comment/{id}")(pathParams);
68
+
69
+ const query = encodeFormQuery({
70
+ "fields": payload.fields,
71
+ });
72
+
73
+ const headers = new Headers(compactMap({
74
+ "Content-Type": "application/json",
75
+ Accept: "application/json",
76
+ }));
77
+
78
+ const securityInput = await extractSecurity(client._options.security);
79
+ const requestSecurity = resolveGlobalSecurity(securityInput);
80
+
81
+ const context = {
82
+ operationID: "patchKmsComment",
83
+ oAuth2Scopes: [],
84
+
85
+ resolvedSecurity: requestSecurity,
86
+
87
+ securitySource: client._options.security,
88
+ retryConfig: options?.retries
89
+ || client._options.retryConfig
90
+ || { strategy: "none" },
91
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
92
+ };
93
+
94
+ const requestRes = client._createRequest(context, {
95
+ security: requestSecurity,
96
+ method: "PATCH",
97
+ baseURL: options?.serverURL,
98
+ path: path,
99
+ headers: headers,
100
+ query: query,
101
+ body: body,
102
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
103
+ }, options);
104
+ if (!requestRes.ok) {
105
+ return requestRes;
106
+ }
107
+ const req = requestRes.value;
108
+
109
+ const doResult = await client._do(req, {
110
+ context,
111
+ errorCodes: ["4XX", "5XX"],
112
+ retryConfig: context.retryConfig,
113
+ retryCodes: context.retryCodes,
114
+ });
115
+ if (!doResult.ok) {
116
+ return doResult;
117
+ }
118
+ const response = doResult.value;
119
+
120
+ const [result] = await M.match<
121
+ shared.KmsComment,
122
+ | SDKError
123
+ | SDKValidationError
124
+ | UnexpectedClientError
125
+ | InvalidRequestError
126
+ | RequestAbortedError
127
+ | RequestTimeoutError
128
+ | ConnectionError
129
+ >(
130
+ M.json(200, shared.KmsComment$inboundSchema),
131
+ M.fail("4XX"),
132
+ M.fail("5XX"),
133
+ )(response);
134
+ if (!result.ok) {
135
+ return result;
136
+ }
137
+
138
+ return result;
139
+ }
@@ -0,0 +1,141 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { UnifiedToCore } from "../core.js";
6
+ import { encodeSimple } from "../lib/encodings.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { safeParse } from "../lib/schemas.js";
10
+ import { RequestOptions } from "../lib/sdks.js";
11
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
+ import { pathToFunc } from "../lib/url.js";
13
+ import {
14
+ ConnectionError,
15
+ InvalidRequestError,
16
+ RequestAbortedError,
17
+ RequestTimeoutError,
18
+ UnexpectedClientError,
19
+ } from "../sdk/models/errors/httpclienterrors.js";
20
+ import { SDKError } from "../sdk/models/errors/sdkerror.js";
21
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
22
+ import * as operations from "../sdk/models/operations/index.js";
23
+ import { Result } from "../sdk/types/fp.js";
24
+
25
+ /**
26
+ * Remove a comment
27
+ */
28
+ export async function kmsRemoveKmsComment(
29
+ client: UnifiedToCore,
30
+ request: operations.RemoveKmsCommentRequest,
31
+ options?: RequestOptions,
32
+ ): Promise<
33
+ Result<
34
+ operations.RemoveKmsCommentResponse | undefined,
35
+ | SDKError
36
+ | SDKValidationError
37
+ | UnexpectedClientError
38
+ | InvalidRequestError
39
+ | RequestAbortedError
40
+ | RequestTimeoutError
41
+ | ConnectionError
42
+ >
43
+ > {
44
+ const parsed = safeParse(
45
+ request,
46
+ (value) => operations.RemoveKmsCommentRequest$outboundSchema.parse(value),
47
+ "Input validation failed",
48
+ );
49
+ if (!parsed.ok) {
50
+ return parsed;
51
+ }
52
+ const payload = parsed.value;
53
+ const body = null;
54
+
55
+ const pathParams = {
56
+ connection_id: encodeSimple("connection_id", payload.connection_id, {
57
+ explode: false,
58
+ charEncoding: "percent",
59
+ }),
60
+ id: encodeSimple("id", payload.id, {
61
+ explode: false,
62
+ charEncoding: "percent",
63
+ }),
64
+ };
65
+
66
+ const path = pathToFunc("/kms/{connection_id}/comment/{id}")(pathParams);
67
+
68
+ const headers = new Headers(compactMap({
69
+ Accept: "*/*",
70
+ }));
71
+
72
+ const securityInput = await extractSecurity(client._options.security);
73
+ const requestSecurity = resolveGlobalSecurity(securityInput);
74
+
75
+ const context = {
76
+ operationID: "removeKmsComment",
77
+ oAuth2Scopes: [],
78
+
79
+ resolvedSecurity: requestSecurity,
80
+
81
+ securitySource: client._options.security,
82
+ retryConfig: options?.retries
83
+ || client._options.retryConfig
84
+ || { strategy: "none" },
85
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
86
+ };
87
+
88
+ const requestRes = client._createRequest(context, {
89
+ security: requestSecurity,
90
+ method: "DELETE",
91
+ baseURL: options?.serverURL,
92
+ path: path,
93
+ headers: headers,
94
+ body: body,
95
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
96
+ }, options);
97
+ if (!requestRes.ok) {
98
+ return requestRes;
99
+ }
100
+ const req = requestRes.value;
101
+
102
+ const doResult = await client._do(req, {
103
+ context,
104
+ errorCodes: ["4XX", "5XX"],
105
+ retryConfig: context.retryConfig,
106
+ retryCodes: context.retryCodes,
107
+ });
108
+ if (!doResult.ok) {
109
+ return doResult;
110
+ }
111
+ const response = doResult.value;
112
+
113
+ const responseFields = {
114
+ HttpMeta: { Response: response, Request: req },
115
+ };
116
+
117
+ const [result] = await M.match<
118
+ operations.RemoveKmsCommentResponse | undefined,
119
+ | SDKError
120
+ | SDKValidationError
121
+ | UnexpectedClientError
122
+ | InvalidRequestError
123
+ | RequestAbortedError
124
+ | RequestTimeoutError
125
+ | ConnectionError
126
+ >(
127
+ M.nil(200, operations.RemoveKmsCommentResponse$inboundSchema.optional()),
128
+ M.fail("4XX"),
129
+ M.fail("5XX"),
130
+ M.nil(
131
+ "default",
132
+ operations.RemoveKmsCommentResponse$inboundSchema.optional(),
133
+ { hdrs: true },
134
+ ),
135
+ )(response, { extraFields: responseFields });
136
+ if (!result.ok) {
137
+ return result;
138
+ }
139
+
140
+ return result;
141
+ }
@@ -0,0 +1,139 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { UnifiedToCore } from "../core.js";
6
+ import { encodeFormQuery, encodeJSON, encodeSimple } from "../lib/encodings.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { safeParse } from "../lib/schemas.js";
10
+ import { RequestOptions } from "../lib/sdks.js";
11
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
+ import { pathToFunc } from "../lib/url.js";
13
+ import {
14
+ ConnectionError,
15
+ InvalidRequestError,
16
+ RequestAbortedError,
17
+ RequestTimeoutError,
18
+ UnexpectedClientError,
19
+ } from "../sdk/models/errors/httpclienterrors.js";
20
+ import { SDKError } from "../sdk/models/errors/sdkerror.js";
21
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
22
+ import * as operations from "../sdk/models/operations/index.js";
23
+ import * as shared from "../sdk/models/shared/index.js";
24
+ import { Result } from "../sdk/types/fp.js";
25
+
26
+ /**
27
+ * Update a comment
28
+ */
29
+ export async function kmsUpdateKmsComment(
30
+ client: UnifiedToCore,
31
+ request: operations.UpdateKmsCommentRequest,
32
+ options?: RequestOptions,
33
+ ): Promise<
34
+ Result<
35
+ shared.KmsComment,
36
+ | SDKError
37
+ | SDKValidationError
38
+ | UnexpectedClientError
39
+ | InvalidRequestError
40
+ | RequestAbortedError
41
+ | RequestTimeoutError
42
+ | ConnectionError
43
+ >
44
+ > {
45
+ const parsed = safeParse(
46
+ request,
47
+ (value) => operations.UpdateKmsCommentRequest$outboundSchema.parse(value),
48
+ "Input validation failed",
49
+ );
50
+ if (!parsed.ok) {
51
+ return parsed;
52
+ }
53
+ const payload = parsed.value;
54
+ const body = encodeJSON("body", payload.KmsComment, { explode: true });
55
+
56
+ const pathParams = {
57
+ connection_id: encodeSimple("connection_id", payload.connection_id, {
58
+ explode: false,
59
+ charEncoding: "percent",
60
+ }),
61
+ id: encodeSimple("id", payload.id, {
62
+ explode: false,
63
+ charEncoding: "percent",
64
+ }),
65
+ };
66
+
67
+ const path = pathToFunc("/kms/{connection_id}/comment/{id}")(pathParams);
68
+
69
+ const query = encodeFormQuery({
70
+ "fields": payload.fields,
71
+ });
72
+
73
+ const headers = new Headers(compactMap({
74
+ "Content-Type": "application/json",
75
+ Accept: "application/json",
76
+ }));
77
+
78
+ const securityInput = await extractSecurity(client._options.security);
79
+ const requestSecurity = resolveGlobalSecurity(securityInput);
80
+
81
+ const context = {
82
+ operationID: "updateKmsComment",
83
+ oAuth2Scopes: [],
84
+
85
+ resolvedSecurity: requestSecurity,
86
+
87
+ securitySource: client._options.security,
88
+ retryConfig: options?.retries
89
+ || client._options.retryConfig
90
+ || { strategy: "none" },
91
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
92
+ };
93
+
94
+ const requestRes = client._createRequest(context, {
95
+ security: requestSecurity,
96
+ method: "PUT",
97
+ baseURL: options?.serverURL,
98
+ path: path,
99
+ headers: headers,
100
+ query: query,
101
+ body: body,
102
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
103
+ }, options);
104
+ if (!requestRes.ok) {
105
+ return requestRes;
106
+ }
107
+ const req = requestRes.value;
108
+
109
+ const doResult = await client._do(req, {
110
+ context,
111
+ errorCodes: ["4XX", "5XX"],
112
+ retryConfig: context.retryConfig,
113
+ retryCodes: context.retryCodes,
114
+ });
115
+ if (!doResult.ok) {
116
+ return doResult;
117
+ }
118
+ const response = doResult.value;
119
+
120
+ const [result] = await M.match<
121
+ shared.KmsComment,
122
+ | SDKError
123
+ | SDKValidationError
124
+ | UnexpectedClientError
125
+ | InvalidRequestError
126
+ | RequestAbortedError
127
+ | RequestTimeoutError
128
+ | ConnectionError
129
+ >(
130
+ M.json(200, shared.KmsComment$inboundSchema),
131
+ M.fail("4XX"),
132
+ M.fail("5XX"),
133
+ )(response);
134
+ if (!result.ok) {
135
+ return result;
136
+ }
137
+
138
+ return result;
139
+ }
package/src/lib/config.ts CHANGED
@@ -65,8 +65,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
65
65
  export const SDK_METADATA = {
66
66
  language: "typescript",
67
67
  openapiDocVersion: "1.0",
68
- sdkVersion: "2.9.22",
69
- genVersion: "2.493.21",
68
+ sdkVersion: "2.9.24",
69
+ genVersion: "2.493.34",
70
70
  userAgent:
71
- "speakeasy-sdk/typescript 2.9.22 2.493.21 1.0 @unified-api/typescript-sdk",
71
+ "speakeasy-sdk/typescript 2.9.24 2.493.34 1.0 @unified-api/typescript-sdk",
72
72
  } as const;
@@ -57,6 +57,7 @@ export function collectExtraKeys<
57
57
  >(
58
58
  obj: ZodObject<Shape, "strip", Catchall>,
59
59
  extrasKey: K,
60
+ optional: boolean,
60
61
  ): ZodEffects<
61
62
  typeof obj,
62
63
  & output<ZodObject<Shape, "strict">>
@@ -81,6 +82,10 @@ export function collectExtraKeys<
81
82
  delete val[key];
82
83
  }
83
84
 
85
+ if (optional && Object.keys(extras).length === 0) {
86
+ return val;
87
+ }
88
+
84
89
  return { ...val, [extrasKey]: extras };
85
90
  });
86
91
  }
@@ -2,11 +2,17 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
+ import { commentCreateKmsComment } from "../funcs/commentCreateKmsComment.js";
5
6
  import { commentCreateTaskComment } from "../funcs/commentCreateTaskComment.js";
7
+ import { commentGetKmsComment } from "../funcs/commentGetKmsComment.js";
6
8
  import { commentGetTaskComment } from "../funcs/commentGetTaskComment.js";
9
+ import { commentListKmsComments } from "../funcs/commentListKmsComments.js";
7
10
  import { commentListTaskComments } from "../funcs/commentListTaskComments.js";
11
+ import { commentPatchKmsComment } from "../funcs/commentPatchKmsComment.js";
8
12
  import { commentPatchTaskComment } from "../funcs/commentPatchTaskComment.js";
13
+ import { commentRemoveKmsComment } from "../funcs/commentRemoveKmsComment.js";
9
14
  import { commentRemoveTaskComment } from "../funcs/commentRemoveTaskComment.js";
15
+ import { commentUpdateKmsComment } from "../funcs/commentUpdateKmsComment.js";
10
16
  import { commentUpdateTaskComment } from "../funcs/commentUpdateTaskComment.js";
11
17
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
12
18
  import * as operations from "./models/operations/index.js";
@@ -14,6 +20,20 @@ import * as shared from "./models/shared/index.js";
14
20
  import { unwrapAsync } from "./types/fp.js";
15
21
 
16
22
  export class Comment extends ClientSDK {
23
+ /**
24
+ * Create a comment
25
+ */
26
+ async createKmsComment(
27
+ request: operations.CreateKmsCommentRequest,
28
+ options?: RequestOptions,
29
+ ): Promise<shared.KmsComment> {
30
+ return unwrapAsync(commentCreateKmsComment(
31
+ this,
32
+ request,
33
+ options,
34
+ ));
35
+ }
36
+
17
37
  /**
18
38
  * Create a comment
19
39
  */
@@ -28,6 +48,20 @@ export class Comment extends ClientSDK {
28
48
  ));
29
49
  }
30
50
 
51
+ /**
52
+ * Retrieve a comment
53
+ */
54
+ async getKmsComment(
55
+ request: operations.GetKmsCommentRequest,
56
+ options?: RequestOptions,
57
+ ): Promise<shared.KmsComment> {
58
+ return unwrapAsync(commentGetKmsComment(
59
+ this,
60
+ request,
61
+ options,
62
+ ));
63
+ }
64
+
31
65
  /**
32
66
  * Retrieve a comment
33
67
  */
@@ -42,6 +76,20 @@ export class Comment extends ClientSDK {
42
76
  ));
43
77
  }
44
78
 
79
+ /**
80
+ * List all comments
81
+ */
82
+ async listKmsComments(
83
+ request: operations.ListKmsCommentsRequest,
84
+ options?: RequestOptions,
85
+ ): Promise<Array<shared.KmsComment>> {
86
+ return unwrapAsync(commentListKmsComments(
87
+ this,
88
+ request,
89
+ options,
90
+ ));
91
+ }
92
+
45
93
  /**
46
94
  * List all comments
47
95
  */
@@ -56,6 +104,20 @@ export class Comment extends ClientSDK {
56
104
  ));
57
105
  }
58
106
 
107
+ /**
108
+ * Update a comment
109
+ */
110
+ async patchKmsComment(
111
+ request: operations.PatchKmsCommentRequest,
112
+ options?: RequestOptions,
113
+ ): Promise<shared.KmsComment> {
114
+ return unwrapAsync(commentPatchKmsComment(
115
+ this,
116
+ request,
117
+ options,
118
+ ));
119
+ }
120
+
59
121
  /**
60
122
  * Update a comment
61
123
  */
@@ -70,6 +132,20 @@ export class Comment extends ClientSDK {
70
132
  ));
71
133
  }
72
134
 
135
+ /**
136
+ * Remove a comment
137
+ */
138
+ async removeKmsComment(
139
+ request: operations.RemoveKmsCommentRequest,
140
+ options?: RequestOptions,
141
+ ): Promise<operations.RemoveKmsCommentResponse | undefined> {
142
+ return unwrapAsync(commentRemoveKmsComment(
143
+ this,
144
+ request,
145
+ options,
146
+ ));
147
+ }
148
+
73
149
  /**
74
150
  * Remove a comment
75
151
  */
@@ -84,6 +160,20 @@ export class Comment extends ClientSDK {
84
160
  ));
85
161
  }
86
162
 
163
+ /**
164
+ * Update a comment
165
+ */
166
+ async updateKmsComment(
167
+ request: operations.UpdateKmsCommentRequest,
168
+ options?: RequestOptions,
169
+ ): Promise<shared.KmsComment> {
170
+ return unwrapAsync(commentUpdateKmsComment(
171
+ this,
172
+ request,
173
+ options,
174
+ ));
175
+ }
176
+
87
177
  /**
88
178
  * Update a comment
89
179
  */