codeforge-main-middesk-api-sdk 1.0.0 → 1.2.0

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 (225) hide show
  1. package/README.md +106 -2
  2. package/dist/channels/http_client.d.ts +382 -4
  3. package/dist/channels/http_client.d.ts.map +1 -1
  4. package/dist/channels/http_client.js +1322 -336
  5. package/dist/channels/http_client.js.map +1 -1
  6. package/dist/client/MiddeskClient.d.ts +156 -0
  7. package/dist/client/MiddeskClient.d.ts.map +1 -1
  8. package/dist/client/MiddeskClient.js +153 -4
  9. package/dist/client/MiddeskClient.js.map +1 -1
  10. package/dist/headers/CreateSubAccountApiKeyHeaders.d.ts +10 -0
  11. package/dist/headers/CreateSubAccountApiKeyHeaders.d.ts.map +1 -0
  12. package/dist/headers/CreateSubAccountApiKeyHeaders.js +35 -0
  13. package/dist/headers/CreateSubAccountApiKeyHeaders.js.map +1 -0
  14. package/dist/headers/CreateSubAccountHeaders.d.ts +10 -0
  15. package/dist/headers/CreateSubAccountHeaders.d.ts.map +1 -0
  16. package/dist/headers/CreateSubAccountHeaders.js +35 -0
  17. package/dist/headers/CreateSubAccountHeaders.js.map +1 -0
  18. package/dist/headers/DeleteSubAccountApiKeyHeaders.d.ts +10 -0
  19. package/dist/headers/DeleteSubAccountApiKeyHeaders.d.ts.map +1 -0
  20. package/dist/headers/DeleteSubAccountApiKeyHeaders.js +35 -0
  21. package/dist/headers/DeleteSubAccountApiKeyHeaders.js.map +1 -0
  22. package/dist/headers/GetSubAccountHeaders.d.ts +10 -0
  23. package/dist/headers/GetSubAccountHeaders.d.ts.map +1 -0
  24. package/dist/headers/GetSubAccountHeaders.js +35 -0
  25. package/dist/headers/GetSubAccountHeaders.js.map +1 -0
  26. package/dist/headers/ListSubAccountApiKeysHeaders.d.ts +10 -0
  27. package/dist/headers/ListSubAccountApiKeysHeaders.d.ts.map +1 -0
  28. package/dist/headers/ListSubAccountApiKeysHeaders.js +35 -0
  29. package/dist/headers/ListSubAccountApiKeysHeaders.js.map +1 -0
  30. package/dist/headers/ListSubAccountsHeaders.d.ts +10 -0
  31. package/dist/headers/ListSubAccountsHeaders.d.ts.map +1 -0
  32. package/dist/headers/ListSubAccountsHeaders.js +35 -0
  33. package/dist/headers/ListSubAccountsHeaders.js.map +1 -0
  34. package/dist/headers/UpdateSubAccountHeaders.d.ts +10 -0
  35. package/dist/headers/UpdateSubAccountHeaders.d.ts.map +1 -0
  36. package/dist/headers/UpdateSubAccountHeaders.js +35 -0
  37. package/dist/headers/UpdateSubAccountHeaders.js.map +1 -0
  38. package/dist/index.d.ts +53 -1
  39. package/dist/index.d.ts.map +1 -1
  40. package/dist/index.js +61 -6
  41. package/dist/index.js.map +1 -1
  42. package/dist/parameters/CreateSubAccountApiKeyParameters.d.ts +47 -0
  43. package/dist/parameters/CreateSubAccountApiKeyParameters.d.ts.map +1 -0
  44. package/dist/parameters/CreateSubAccountApiKeyParameters.js +105 -0
  45. package/dist/parameters/CreateSubAccountApiKeyParameters.js.map +1 -0
  46. package/dist/parameters/DeleteSubAccountApiKeyParameters.d.ts +54 -0
  47. package/dist/parameters/DeleteSubAccountApiKeyParameters.d.ts.map +1 -0
  48. package/dist/parameters/DeleteSubAccountApiKeyParameters.js +127 -0
  49. package/dist/parameters/DeleteSubAccountApiKeyParameters.js.map +1 -0
  50. package/dist/parameters/GetDocumentDownloadUrlParameters.d.ts +18 -0
  51. package/dist/parameters/GetDocumentDownloadUrlParameters.d.ts.map +1 -1
  52. package/dist/parameters/GetDocumentDownloadUrlParameters.js +60 -0
  53. package/dist/parameters/GetDocumentDownloadUrlParameters.js.map +1 -1
  54. package/dist/parameters/GetDocumentDownloadUrlRequestDisposition.d.ts +6 -0
  55. package/dist/parameters/GetDocumentDownloadUrlRequestDisposition.d.ts.map +1 -0
  56. package/dist/parameters/GetDocumentDownloadUrlRequestDisposition.js +3 -0
  57. package/dist/parameters/GetDocumentDownloadUrlRequestDisposition.js.map +1 -0
  58. package/dist/parameters/GetSubAccountParameters.d.ts +47 -0
  59. package/dist/parameters/GetSubAccountParameters.d.ts.map +1 -0
  60. package/dist/parameters/GetSubAccountParameters.js +105 -0
  61. package/dist/parameters/GetSubAccountParameters.js.map +1 -0
  62. package/dist/parameters/ListSubAccountApiKeysParameters.d.ts +71 -0
  63. package/dist/parameters/ListSubAccountApiKeysParameters.d.ts.map +1 -0
  64. package/dist/parameters/ListSubAccountApiKeysParameters.js +198 -0
  65. package/dist/parameters/ListSubAccountApiKeysParameters.js.map +1 -0
  66. package/dist/parameters/ListSubAccountsParameters.d.ts +83 -0
  67. package/dist/parameters/ListSubAccountsParameters.d.ts.map +1 -0
  68. package/dist/parameters/ListSubAccountsParameters.js +240 -0
  69. package/dist/parameters/ListSubAccountsParameters.js.map +1 -0
  70. package/dist/parameters/ListSubAccountsRequestEnabled.d.ts +6 -0
  71. package/dist/parameters/ListSubAccountsRequestEnabled.d.ts.map +1 -0
  72. package/dist/parameters/ListSubAccountsRequestEnabled.js +3 -0
  73. package/dist/parameters/ListSubAccountsRequestEnabled.js.map +1 -0
  74. package/dist/parameters/ListSubAccountsRequestSortBy.d.ts +6 -0
  75. package/dist/parameters/ListSubAccountsRequestSortBy.d.ts.map +1 -0
  76. package/dist/parameters/ListSubAccountsRequestSortBy.js +3 -0
  77. package/dist/parameters/ListSubAccountsRequestSortBy.js.map +1 -0
  78. package/dist/parameters/ListSubAccountsRequestSortOrder.d.ts +6 -0
  79. package/dist/parameters/ListSubAccountsRequestSortOrder.d.ts.map +1 -0
  80. package/dist/parameters/ListSubAccountsRequestSortOrder.js +3 -0
  81. package/dist/parameters/ListSubAccountsRequestSortOrder.js.map +1 -0
  82. package/dist/parameters/SearchJurisdictionsParameters.d.ts +0 -7
  83. package/dist/parameters/SearchJurisdictionsParameters.d.ts.map +1 -1
  84. package/dist/parameters/SearchJurisdictionsParameters.js +0 -27
  85. package/dist/parameters/SearchJurisdictionsParameters.js.map +1 -1
  86. package/dist/parameters/UpdateSubAccountParameters.d.ts +47 -0
  87. package/dist/parameters/UpdateSubAccountParameters.d.ts.map +1 -0
  88. package/dist/parameters/UpdateSubAccountParameters.js +105 -0
  89. package/dist/parameters/UpdateSubAccountParameters.js.map +1 -0
  90. package/dist/payloads/AgentsRun.d.ts +4 -0
  91. package/dist/payloads/AgentsRun.d.ts.map +1 -1
  92. package/dist/payloads/ApiKey.d.ts +17 -0
  93. package/dist/payloads/ApiKey.d.ts.map +1 -0
  94. package/dist/payloads/ApiKey.js +3 -0
  95. package/dist/payloads/ApiKey.js.map +1 -0
  96. package/dist/payloads/ApiKeyApiVersion.d.ts +6 -0
  97. package/dist/payloads/ApiKeyApiVersion.d.ts.map +1 -0
  98. package/dist/payloads/ApiKeyApiVersion.js +9 -0
  99. package/dist/payloads/ApiKeyApiVersion.js.map +1 -0
  100. package/dist/payloads/ApiKeyObject.d.ts +5 -0
  101. package/dist/payloads/ApiKeyObject.d.ts.map +1 -0
  102. package/dist/payloads/ApiKeyObject.js +8 -0
  103. package/dist/payloads/ApiKeyObject.js.map +1 -0
  104. package/dist/payloads/BusinessRequest.d.ts +1 -1
  105. package/dist/payloads/CreateSubAccountApiKeyRequest.d.ts +7 -0
  106. package/dist/payloads/CreateSubAccountApiKeyRequest.d.ts.map +1 -0
  107. package/dist/payloads/CreateSubAccountApiKeyRequest.js +3 -0
  108. package/dist/payloads/CreateSubAccountApiKeyRequest.js.map +1 -0
  109. package/dist/payloads/CreateSubAccountApiKeyResponse.d.ts +5 -0
  110. package/dist/payloads/CreateSubAccountApiKeyResponse.d.ts.map +1 -0
  111. package/dist/payloads/CreateSubAccountApiKeyResponse.js +3 -0
  112. package/dist/payloads/CreateSubAccountApiKeyResponse.js.map +1 -0
  113. package/dist/payloads/CreateSubAccountRequest.d.ts +51 -0
  114. package/dist/payloads/CreateSubAccountRequest.d.ts.map +1 -0
  115. package/dist/payloads/CreateSubAccountRequest.js +3 -0
  116. package/dist/payloads/CreateSubAccountRequest.js.map +1 -0
  117. package/dist/payloads/CreateSubAccountResponse.d.ts +5 -0
  118. package/dist/payloads/CreateSubAccountResponse.d.ts.map +1 -0
  119. package/dist/payloads/CreateSubAccountResponse.js +3 -0
  120. package/dist/payloads/CreateSubAccountResponse.js.map +1 -0
  121. package/dist/payloads/DeleteSubAccountApiKeyResponse.d.ts +3 -0
  122. package/dist/payloads/DeleteSubAccountApiKeyResponse.d.ts.map +1 -0
  123. package/dist/payloads/DeleteSubAccountApiKeyResponse.js +3 -0
  124. package/dist/payloads/DeleteSubAccountApiKeyResponse.js.map +1 -0
  125. package/dist/payloads/ErrorResponseErrorsItem.d.ts +4 -0
  126. package/dist/payloads/ErrorResponseErrorsItem.d.ts.map +1 -1
  127. package/dist/payloads/GetDocumentDownloadUrlRequestDisposition.d.ts +5 -0
  128. package/dist/payloads/GetDocumentDownloadUrlRequestDisposition.d.ts.map +1 -0
  129. package/dist/payloads/GetDocumentDownloadUrlRequestDisposition.js +8 -0
  130. package/dist/payloads/GetDocumentDownloadUrlRequestDisposition.js.map +1 -0
  131. package/dist/payloads/GetSubAccountResponse.d.ts +5 -0
  132. package/dist/payloads/GetSubAccountResponse.d.ts.map +1 -0
  133. package/dist/payloads/GetSubAccountResponse.js +3 -0
  134. package/dist/payloads/GetSubAccountResponse.js.map +1 -0
  135. package/dist/payloads/LienStatus.d.ts +2 -1
  136. package/dist/payloads/LienStatus.d.ts.map +1 -1
  137. package/dist/payloads/LienStatus.js +1 -0
  138. package/dist/payloads/LienStatus.js.map +1 -1
  139. package/dist/payloads/LienStatusCategory.d.ts +2 -1
  140. package/dist/payloads/LienStatusCategory.d.ts.map +1 -1
  141. package/dist/payloads/LienStatusCategory.js +1 -0
  142. package/dist/payloads/LienStatusCategory.js.map +1 -1
  143. package/dist/payloads/ListSubAccountApiKeysResponse.d.ts +5 -0
  144. package/dist/payloads/ListSubAccountApiKeysResponse.d.ts.map +1 -0
  145. package/dist/payloads/ListSubAccountApiKeysResponse.js +3 -0
  146. package/dist/payloads/ListSubAccountApiKeysResponse.js.map +1 -0
  147. package/dist/payloads/ListSubAccountApiKeysResponse1.d.ts +9 -0
  148. package/dist/payloads/ListSubAccountApiKeysResponse1.d.ts.map +1 -0
  149. package/dist/payloads/ListSubAccountApiKeysResponse1.js +3 -0
  150. package/dist/payloads/ListSubAccountApiKeysResponse1.js.map +1 -0
  151. package/dist/payloads/ListSubAccountApiKeysResponse2.d.ts +9 -0
  152. package/dist/payloads/ListSubAccountApiKeysResponse2.d.ts.map +1 -0
  153. package/dist/payloads/ListSubAccountApiKeysResponse2.js +3 -0
  154. package/dist/payloads/ListSubAccountApiKeysResponse2.js.map +1 -0
  155. package/dist/payloads/ListSubAccountsRequestEnabled.d.ts +6 -0
  156. package/dist/payloads/ListSubAccountsRequestEnabled.d.ts.map +1 -0
  157. package/dist/payloads/ListSubAccountsRequestEnabled.js +9 -0
  158. package/dist/payloads/ListSubAccountsRequestEnabled.js.map +1 -0
  159. package/dist/payloads/ListSubAccountsRequestSortBy.d.ts +5 -0
  160. package/dist/payloads/ListSubAccountsRequestSortBy.d.ts.map +1 -0
  161. package/dist/payloads/ListSubAccountsRequestSortBy.js +8 -0
  162. package/dist/payloads/ListSubAccountsRequestSortBy.js.map +1 -0
  163. package/dist/payloads/ListSubAccountsRequestSortOrder.d.ts +6 -0
  164. package/dist/payloads/ListSubAccountsRequestSortOrder.d.ts.map +1 -0
  165. package/dist/payloads/ListSubAccountsRequestSortOrder.js +9 -0
  166. package/dist/payloads/ListSubAccountsRequestSortOrder.js.map +1 -0
  167. package/dist/payloads/ListSubAccountsResponse.d.ts +5 -0
  168. package/dist/payloads/ListSubAccountsResponse.d.ts.map +1 -0
  169. package/dist/payloads/ListSubAccountsResponse.js +3 -0
  170. package/dist/payloads/ListSubAccountsResponse.js.map +1 -0
  171. package/dist/payloads/ListSubAccountsResponse1.d.ts +9 -0
  172. package/dist/payloads/ListSubAccountsResponse1.d.ts.map +1 -0
  173. package/dist/payloads/ListSubAccountsResponse1.js +3 -0
  174. package/dist/payloads/ListSubAccountsResponse1.js.map +1 -0
  175. package/dist/payloads/ListSubAccountsResponse2.d.ts +9 -0
  176. package/dist/payloads/ListSubAccountsResponse2.d.ts.map +1 -0
  177. package/dist/payloads/ListSubAccountsResponse2.js +3 -0
  178. package/dist/payloads/ListSubAccountsResponse2.js.map +1 -0
  179. package/dist/payloads/SubAccount.d.ts +18 -0
  180. package/dist/payloads/SubAccount.d.ts.map +1 -0
  181. package/dist/payloads/SubAccount.js +3 -0
  182. package/dist/payloads/SubAccount.js.map +1 -0
  183. package/dist/payloads/SubAccountApiKeyCreateParamEnvironment.d.ts +6 -0
  184. package/dist/payloads/SubAccountApiKeyCreateParamEnvironment.d.ts.map +1 -0
  185. package/dist/payloads/SubAccountApiKeyCreateParamEnvironment.js +9 -0
  186. package/dist/payloads/SubAccountApiKeyCreateParamEnvironment.js.map +1 -0
  187. package/dist/payloads/SubAccountCreateParamContact.d.ts +11 -0
  188. package/dist/payloads/SubAccountCreateParamContact.d.ts.map +1 -0
  189. package/dist/payloads/SubAccountCreateParamContact.js +3 -0
  190. package/dist/payloads/SubAccountCreateParamContact.js.map +1 -0
  191. package/dist/payloads/SubAccountCreateParamProductsItem.d.ts +30 -0
  192. package/dist/payloads/SubAccountCreateParamProductsItem.d.ts.map +1 -0
  193. package/dist/payloads/SubAccountCreateParamProductsItem.js +33 -0
  194. package/dist/payloads/SubAccountCreateParamProductsItem.js.map +1 -0
  195. package/dist/payloads/SubAccountCreateParamSubVertical.d.ts +32 -0
  196. package/dist/payloads/SubAccountCreateParamSubVertical.d.ts.map +1 -0
  197. package/dist/payloads/SubAccountCreateParamSubVertical.js +35 -0
  198. package/dist/payloads/SubAccountCreateParamSubVertical.js.map +1 -0
  199. package/dist/payloads/SubAccountCreateParamUseCase.d.ts +43 -0
  200. package/dist/payloads/SubAccountCreateParamUseCase.d.ts.map +1 -0
  201. package/dist/payloads/SubAccountCreateParamUseCase.js +46 -0
  202. package/dist/payloads/SubAccountCreateParamUseCase.js.map +1 -0
  203. package/dist/payloads/SubAccountCreateParamVertical.d.ts +14 -0
  204. package/dist/payloads/SubAccountCreateParamVertical.d.ts.map +1 -0
  205. package/dist/payloads/SubAccountCreateParamVertical.js +17 -0
  206. package/dist/payloads/SubAccountCreateParamVertical.js.map +1 -0
  207. package/dist/payloads/SubAccountObject.d.ts +5 -0
  208. package/dist/payloads/SubAccountObject.d.ts.map +1 -0
  209. package/dist/payloads/SubAccountObject.js +8 -0
  210. package/dist/payloads/SubAccountObject.js.map +1 -0
  211. package/dist/payloads/SubmittedAddressComponent.d.ts +2 -2
  212. package/dist/payloads/SubmittedAddressComponent.d.ts.map +1 -1
  213. package/dist/payloads/UpdateSubAccountRequest.d.ts +5 -0
  214. package/dist/payloads/UpdateSubAccountRequest.d.ts.map +1 -0
  215. package/dist/payloads/UpdateSubAccountRequest.js +3 -0
  216. package/dist/payloads/UpdateSubAccountRequest.js.map +1 -0
  217. package/dist/payloads/UpdateSubAccountResponse.d.ts +5 -0
  218. package/dist/payloads/UpdateSubAccountResponse.d.ts.map +1 -0
  219. package/dist/payloads/UpdateSubAccountResponse.js +3 -0
  220. package/dist/payloads/UpdateSubAccountResponse.js.map +1 -0
  221. package/dist/types/Types.d.ts +2 -2
  222. package/dist/types/Types.d.ts.map +1 -1
  223. package/dist/types/Types.js +30 -1
  224. package/dist/types/Types.js.map +1 -1
  225. package/package.json +4 -1
@@ -24,6 +24,9 @@ import { CreateWebhookRequest } from './../payloads/CreateWebhookRequest.js';
24
24
  import { UpdateWebhookRequest } from './../payloads/UpdateWebhookRequest.js';
25
25
  import { CreateWebhookEventSchemaRequest } from './../payloads/CreateWebhookEventSchemaRequest.js';
26
26
  import { UpdateWebhookEventSchemaRequest } from './../payloads/UpdateWebhookEventSchemaRequest.js';
27
+ import { CreateSubAccountRequest } from './../payloads/CreateSubAccountRequest.js';
28
+ import { UpdateSubAccountRequest } from './../payloads/UpdateSubAccountRequest.js';
29
+ import { CreateSubAccountApiKeyRequest } from './../payloads/CreateSubAccountApiKeyRequest.js';
27
30
  import { ListBusinessesResponse } from './../payloads/ListBusinessesResponse.js';
28
31
  import { CreateBusinessResponse } from './../payloads/CreateBusinessResponse.js';
29
32
  import { GetBusinessResponse } from './../payloads/GetBusinessResponse.js';
@@ -92,6 +95,12 @@ import { GetDocumentDownloadUrlResponse } from './../payloads/GetDocumentDownloa
92
95
  import { GetRiskAssessmentsResponse } from './../payloads/GetRiskAssessmentsResponse.js';
93
96
  import { GetLatestRiskAssessmentResponse } from './../payloads/GetLatestRiskAssessmentResponse.js';
94
97
  import { GetRiskAssessmentResponse } from './../payloads/GetRiskAssessmentResponse.js';
98
+ import { ListSubAccountsResponse } from './../payloads/ListSubAccountsResponse.js';
99
+ import { CreateSubAccountResponse } from './../payloads/CreateSubAccountResponse.js';
100
+ import { GetSubAccountResponse } from './../payloads/GetSubAccountResponse.js';
101
+ import { UpdateSubAccountResponse } from './../payloads/UpdateSubAccountResponse.js';
102
+ import { ListSubAccountApiKeysResponse } from './../payloads/ListSubAccountApiKeysResponse.js';
103
+ import { CreateSubAccountApiKeyResponse } from './../payloads/CreateSubAccountApiKeyResponse.js';
95
104
  import { GetBusinessParameters, GetBusinessParametersInterface } from './../parameters/GetBusinessParameters.js';
96
105
  import { UpdateBusinessParameters, UpdateBusinessParametersInterface } from './../parameters/UpdateBusinessParameters.js';
97
106
  import { GetBusinessPdfParameters, GetBusinessPdfParametersInterface } from './../parameters/GetBusinessPdfParameters.js';
@@ -154,6 +163,12 @@ import { GetDocumentDownloadUrlParameters, GetDocumentDownloadUrlParametersInter
154
163
  import { GetRiskAssessmentsParameters, GetRiskAssessmentsParametersInterface } from './../parameters/GetRiskAssessmentsParameters.js';
155
164
  import { GetLatestRiskAssessmentParameters, GetLatestRiskAssessmentParametersInterface } from './../parameters/GetLatestRiskAssessmentParameters.js';
156
165
  import { GetRiskAssessmentParameters, GetRiskAssessmentParametersInterface } from './../parameters/GetRiskAssessmentParameters.js';
166
+ import { ListSubAccountsParameters, ListSubAccountsParametersInterface } from './../parameters/ListSubAccountsParameters.js';
167
+ import { GetSubAccountParameters, GetSubAccountParametersInterface } from './../parameters/GetSubAccountParameters.js';
168
+ import { UpdateSubAccountParameters, UpdateSubAccountParametersInterface } from './../parameters/UpdateSubAccountParameters.js';
169
+ import { ListSubAccountApiKeysParameters, ListSubAccountApiKeysParametersInterface } from './../parameters/ListSubAccountApiKeysParameters.js';
170
+ import { CreateSubAccountApiKeyParameters, CreateSubAccountApiKeyParametersInterface } from './../parameters/CreateSubAccountApiKeyParameters.js';
171
+ import { DeleteSubAccountApiKeyParameters, DeleteSubAccountApiKeyParametersInterface } from './../parameters/DeleteSubAccountApiKeyParameters.js';
157
172
  import { ListBusinessesHeaders } from './../headers/ListBusinessesHeaders.js';
158
173
  import { CreateBusinessHeaders } from './../headers/CreateBusinessHeaders.js';
159
174
  import { GetBusinessHeaders } from './../headers/GetBusinessHeaders.js';
@@ -232,6 +247,13 @@ import { GetDocumentDownloadUrlHeaders } from './../headers/GetDocumentDownloadU
232
247
  import { GetRiskAssessmentsHeaders } from './../headers/GetRiskAssessmentsHeaders.js';
233
248
  import { GetLatestRiskAssessmentHeaders } from './../headers/GetLatestRiskAssessmentHeaders.js';
234
249
  import { GetRiskAssessmentHeaders } from './../headers/GetRiskAssessmentHeaders.js';
250
+ import { ListSubAccountsHeaders } from './../headers/ListSubAccountsHeaders.js';
251
+ import { CreateSubAccountHeaders } from './../headers/CreateSubAccountHeaders.js';
252
+ import { GetSubAccountHeaders } from './../headers/GetSubAccountHeaders.js';
253
+ import { UpdateSubAccountHeaders } from './../headers/UpdateSubAccountHeaders.js';
254
+ import { ListSubAccountApiKeysHeaders } from './../headers/ListSubAccountApiKeysHeaders.js';
255
+ import { CreateSubAccountApiKeyHeaders } from './../headers/CreateSubAccountApiKeyHeaders.js';
256
+ import { DeleteSubAccountApiKeyHeaders } from './../headers/DeleteSubAccountApiKeyHeaders.js';
235
257
  /**
236
258
  * The global `Error`, captured under a name a payload model cannot take.
237
259
  *
@@ -251,9 +273,9 @@ export interface HttpResponse {
251
273
  statusText: string;
252
274
  headers?: Headers | Record<string, string>;
253
275
  json: () => Record<any, any> | Promise<Record<any, any>>;
254
- /** Reads the body as text. Provided by `fetch`; required for text responses and non-JSON error bodies. */
276
+ /** Reads the body as text. Provided by `fetch`; used for text responses, non-JSON error bodies, and the raw request escape hatch. */
255
277
  text?: () => string | Promise<string>;
256
- /** Reads the body as a `Blob`. Provided by `fetch`; required for binary responses. */
278
+ /** Reads the body as a `Blob`. Provided by `fetch`; used for binary responses and the raw request escape hatch. */
257
279
  blob?: () => Blob | Promise<Blob>;
258
280
  }
259
281
  /**
@@ -284,6 +306,76 @@ export declare class HttpError extends HttpGlobalError {
284
306
  body?: unknown;
285
307
  constructor(message: string, status: number, statusText: string, body?: unknown);
286
308
  }
309
+ /**
310
+ * Thrown for a 400 Bad Request response.
311
+ */
312
+ export declare class BadRequestError extends HttpError {
313
+ readonly status: 400;
314
+ constructor(message: string, statusText: string, body?: unknown);
315
+ }
316
+ /**
317
+ * Thrown for a 401 Unauthorized response.
318
+ */
319
+ export declare class AuthenticationError extends HttpError {
320
+ readonly status: 401;
321
+ constructor(message: string, statusText: string, body?: unknown);
322
+ }
323
+ /**
324
+ * Thrown for a 403 Forbidden response.
325
+ */
326
+ export declare class PermissionDeniedError extends HttpError {
327
+ readonly status: 403;
328
+ constructor(message: string, statusText: string, body?: unknown);
329
+ }
330
+ /**
331
+ * Thrown for a 404 Not Found response.
332
+ */
333
+ export declare class NotFoundError extends HttpError {
334
+ readonly status: 404;
335
+ constructor(message: string, statusText: string, body?: unknown);
336
+ }
337
+ /**
338
+ * Thrown for a 409 Conflict response.
339
+ */
340
+ export declare class ConflictError extends HttpError {
341
+ readonly status: 409;
342
+ constructor(message: string, statusText: string, body?: unknown);
343
+ }
344
+ /**
345
+ * Thrown for a 422 Unprocessable Entity response.
346
+ */
347
+ export declare class UnprocessableEntityError extends HttpError {
348
+ readonly status: 422;
349
+ constructor(message: string, statusText: string, body?: unknown);
350
+ }
351
+ /**
352
+ * Thrown for a 429 Too Many Requests response.
353
+ */
354
+ export declare class RateLimitError extends HttpError {
355
+ readonly status: 429;
356
+ constructor(message: string, statusText: string, body?: unknown);
357
+ }
358
+ /**
359
+ * Thrown for any response with a status of 500 or higher. `status` stays
360
+ * `number` since the range spans many codes - check it to tell a 500 from a
361
+ * 503.
362
+ */
363
+ export declare class InternalServerError extends HttpError {
364
+ constructor(message: string, status: number, statusText: string, body?: unknown);
365
+ }
366
+ /**
367
+ * Thrown when a single request attempt does not complete within `timeoutMs`.
368
+ *
369
+ * The timer is per attempt, not per call: a request that times out and then
370
+ * retries gets a fresh `timeoutMs` on the next attempt. Retryable under the
371
+ * same rule as a network error - unlike a caller-triggered `AbortSignal`,
372
+ * which is never retried.
373
+ */
374
+ export declare class TimeoutError extends HttpGlobalError {
375
+ url: string;
376
+ timeoutMs: number;
377
+ constructor(url: string, timeoutMs: number);
378
+ }
287
379
  /**
288
380
  * HTTP request parameters passed to the request hook
289
381
  */
@@ -293,6 +385,12 @@ export interface HttpRequestParams {
293
385
  method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
294
386
  credentials?: 'omit' | 'include' | 'same-origin';
295
387
  body?: any;
388
+ /**
389
+ * Aborts the request. Carries the caller's own `signal` (when set) merged
390
+ * with the per-attempt timeout signal `executeWithRetry` composes - streams
391
+ * additionally set it themselves so `break` can close the stream.
392
+ */
393
+ signal?: AbortSignal;
296
394
  }
297
395
  /**
298
396
  * Token response structure for OAuth2 flows
@@ -336,7 +434,11 @@ export interface HttpHooks {
336
434
  beforeRequest?: (params: HttpRequestParams) => HttpRequestParams | Promise<HttpRequestParams>;
337
435
  /**
338
436
  * The actual request implementation - allows swapping fetch for axios, etc.
339
- * Default: uses the global fetch (Node.js 18+)
437
+ * Wins over `fetch` on the client config, which is read only by the
438
+ * built-in default: this hook replaces the whole transport, so once it is
439
+ * set the `fetch` field is never consulted.
440
+ * Default: uses the global fetch, or the client's `fetch` config field
441
+ * when set (Node.js 20+).
340
442
  */
341
443
  makeRequest?: (params: HttpRequestParams) => Promise<HttpResponse>;
342
444
  /**
@@ -357,6 +459,20 @@ export interface HttpClientContext {
357
459
  auth?: AuthConfig;
358
460
  retry?: RetryConfig;
359
461
  hooks?: HttpHooks;
462
+ /**
463
+ * How long a single request attempt may take before it throws
464
+ * `TimeoutError`. Applied fresh to each retry attempt, not once per call.
465
+ * Default: `DEFAULT_TIMEOUT_MS` (60000). Ignored by streaming operations,
466
+ * which only support caller cancellation via `signal`.
467
+ */
468
+ timeoutMs?: number;
469
+ /**
470
+ * Swaps the `fetch` implementation the built-in `makeRequest` calls -
471
+ * the narrow transport seam for a proxy dispatcher or an instrumented
472
+ * fetch. Read only by the default `makeRequest`; `hooks.makeRequest`
473
+ * replaces the whole transport and never consults this field.
474
+ */
475
+ fetch?: typeof globalThis.fetch;
360
476
  additionalHeaders?: Record<string, string | string[]>;
361
477
  additionalQueryParams?: Record<string, string | number | boolean | undefined>;
362
478
  }
@@ -369,8 +485,42 @@ export declare class HttpHookCapabilityError extends HttpGlobalError {
369
485
  contentType: string;
370
486
  constructor(member: string, contentType: string);
371
487
  }
488
+ /**
489
+ * Options for the raw request escape hatch. `method` and `path` are the only
490
+ * required fields - everything else falls back to the client's shared
491
+ * configuration, exactly like a modeled operation's context.
492
+ */
493
+ export interface RawRequestOptions extends HttpClientContext {
494
+ method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
495
+ /** Joined onto `baseUrl` with the `URL` constructor - a leading `/` resolves from the origin, dropping any path segment `baseUrl` itself carries. */
496
+ path: string;
497
+ /** Applied together with `additionalQueryParams`. */
498
+ query?: Record<string, string | number | boolean | undefined>;
499
+ headers?: Record<string, string | string[]>;
500
+ /** A plain object is JSON-serialized with a JSON `Content-Type`; pass an already-encoded value (a `string`, `FormData`, ...) to send anything else. */
501
+ body?: unknown;
502
+ signal?: AbortSignal;
503
+ }
504
+ export interface RawRequestResult {
505
+ data: unknown;
506
+ response: HttpResponse;
507
+ }
508
+ /**
509
+ * Escape hatch for a request none of the generated operations model. Goes
510
+ * through the same pipeline every operation does - baseUrl joining through
511
+ * the `URL` constructor, `applyAuth`, `additionalHeaders`,
512
+ * `additionalQueryParams`, retries, the per-attempt `timeoutMs`, and hooks -
513
+ * and throws through the same `handleHttpError` on a non-OK response.
514
+ *
515
+ * `data` parses by the response's own `Content-Type` header: a JSON type via
516
+ * `response.json()`, a textual type via `response.text()`, and anything else
517
+ * as a `Blob`. A response with no `Content-Type` header is read as JSON.
518
+ */
519
+ export declare function request(options: RawRequestOptions): Promise<RawRequestResult>;
372
520
  export interface ListBusinessesContext extends HttpClientContext {
373
521
  requestHeaders?: ListBusinessesHeaders;
522
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
523
+ signal?: AbortSignal;
374
524
  }
375
525
  /**
376
526
  * List businesses
@@ -379,6 +529,8 @@ declare function listBusinesses(context?: ListBusinessesContext): Promise<HttpCl
379
529
  export interface CreateBusinessContext extends HttpClientContext {
380
530
  payload: CreateBusinessRequest;
381
531
  requestHeaders?: CreateBusinessHeaders;
532
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
533
+ signal?: AbortSignal;
382
534
  }
383
535
  /**
384
536
  * Create a business
@@ -387,6 +539,8 @@ declare function createBusiness(context: CreateBusinessContext): Promise<HttpCli
387
539
  export interface GetBusinessContext extends HttpClientContext {
388
540
  parameters: GetBusinessParametersInterface | GetBusinessParameters;
389
541
  requestHeaders?: GetBusinessHeaders;
542
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
543
+ signal?: AbortSignal;
390
544
  }
391
545
  /**
392
546
  * Retrieve a business
@@ -396,6 +550,8 @@ export interface UpdateBusinessContext extends HttpClientContext {
396
550
  payload: UpdateBusinessRequest;
397
551
  parameters: UpdateBusinessParametersInterface | UpdateBusinessParameters;
398
552
  requestHeaders?: UpdateBusinessHeaders;
553
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
554
+ signal?: AbortSignal;
399
555
  }
400
556
  /**
401
557
  * Update a business
@@ -404,6 +560,8 @@ declare function updateBusiness(context: UpdateBusinessContext): Promise<HttpCli
404
560
  export interface GetBusinessPdfContext extends HttpClientContext {
405
561
  parameters: GetBusinessPdfParametersInterface | GetBusinessPdfParameters;
406
562
  requestHeaders?: GetBusinessPdfHeaders;
563
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
564
+ signal?: AbortSignal;
407
565
  }
408
566
  /**
409
567
  * Retrieve a business PDF
@@ -412,6 +570,8 @@ declare function getBusinessPdf(context: GetBusinessPdfContext): Promise<HttpCli
412
570
  export interface ListOrdersContext extends HttpClientContext {
413
571
  parameters: ListOrdersParametersInterface | ListOrdersParameters;
414
572
  requestHeaders?: ListOrdersHeaders;
573
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
574
+ signal?: AbortSignal;
415
575
  }
416
576
  /**
417
577
  * List orders for a business
@@ -421,6 +581,8 @@ export interface CreateOrderContext extends HttpClientContext {
421
581
  payload: CreateOrderRequest;
422
582
  parameters: CreateOrderParametersInterface | CreateOrderParameters;
423
583
  requestHeaders?: CreateOrderHeaders;
584
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
585
+ signal?: AbortSignal;
424
586
  }
425
587
  /**
426
588
  * Create an order for a business
@@ -429,6 +591,8 @@ declare function createOrder(context: CreateOrderContext): Promise<HttpClientRes
429
591
  export interface GetOrderContext extends HttpClientContext {
430
592
  parameters: GetOrderParametersInterface | GetOrderParameters;
431
593
  requestHeaders?: GetOrderHeaders;
594
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
595
+ signal?: AbortSignal;
432
596
  }
433
597
  /**
434
598
  * Retrieve an order
@@ -437,6 +601,8 @@ declare function getOrder(context: GetOrderContext): Promise<HttpClientResponse<
437
601
  export interface GetOrderByIdContext extends HttpClientContext {
438
602
  parameters: GetOrderByIdParametersInterface | GetOrderByIdParameters;
439
603
  requestHeaders?: GetOrderByIdHeaders;
604
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
605
+ signal?: AbortSignal;
440
606
  }
441
607
  /**
442
608
  * Retrieve an order by ID
@@ -446,6 +612,8 @@ export interface UpdateOrderContext extends HttpClientContext {
446
612
  payload: UpdateOrderRequest;
447
613
  parameters: UpdateOrderParametersInterface | UpdateOrderParameters;
448
614
  requestHeaders?: UpdateOrderHeaders;
615
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
616
+ signal?: AbortSignal;
449
617
  }
450
618
  /**
451
619
  * Update an order
@@ -454,6 +622,8 @@ declare function updateOrder(context: UpdateOrderContext): Promise<HttpClientRes
454
622
  export interface ListBusinessBatchesContext extends HttpClientContext {
455
623
  parameters: ListBusinessBatchesParametersInterface | ListBusinessBatchesParameters;
456
624
  requestHeaders?: ListBusinessBatchesHeaders;
625
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
626
+ signal?: AbortSignal;
457
627
  }
458
628
  /**
459
629
  * List business batches
@@ -462,6 +632,8 @@ declare function listBusinessBatches(context: ListBusinessBatchesContext): Promi
462
632
  export interface CreateBusinessBatchContext extends HttpClientContext {
463
633
  payload: CreateBusinessBatchRequest;
464
634
  requestHeaders?: CreateBusinessBatchHeaders;
635
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
636
+ signal?: AbortSignal;
465
637
  }
466
638
  /**
467
639
  * Each CSV row consumes one business creation from the Sandbox account limit.
@@ -470,6 +642,8 @@ declare function createBusinessBatch(context: CreateBusinessBatchContext): Promi
470
642
  export interface GetBusinessBatchContext extends HttpClientContext {
471
643
  parameters: GetBusinessBatchParametersInterface | GetBusinessBatchParameters;
472
644
  requestHeaders?: GetBusinessBatchHeaders;
645
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
646
+ signal?: AbortSignal;
473
647
  }
474
648
  /**
475
649
  * Retrieve a business batch
@@ -478,6 +652,8 @@ declare function getBusinessBatch(context: GetBusinessBatchContext): Promise<Htt
478
652
  export interface GetBusinessBatchCsvContext extends HttpClientContext {
479
653
  parameters: GetBusinessBatchCsvParametersInterface | GetBusinessBatchCsvParameters;
480
654
  requestHeaders?: GetBusinessBatchCsvHeaders;
655
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
656
+ signal?: AbortSignal;
481
657
  }
482
658
  /**
483
659
  * Download business batch CSV
@@ -486,6 +662,8 @@ declare function getBusinessBatchCsv(context: GetBusinessBatchCsvContext): Promi
486
662
  export interface ListSignalsContext extends HttpClientContext {
487
663
  parameters: ListSignalsParametersInterface | ListSignalsParameters;
488
664
  requestHeaders?: ListSignalsHeaders;
665
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
666
+ signal?: AbortSignal;
489
667
  }
490
668
  /**
491
669
  * List signals
@@ -494,6 +672,8 @@ declare function listSignals(context: ListSignalsContext): Promise<HttpClientRes
494
672
  export interface CreateSignalContext extends HttpClientContext {
495
673
  payload: CreateSignalRequest;
496
674
  requestHeaders?: CreateSignalHeaders;
675
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
676
+ signal?: AbortSignal;
497
677
  }
498
678
  /**
499
679
  * Create a signal
@@ -502,6 +682,8 @@ declare function createSignal(context: CreateSignalContext): Promise<HttpClientR
502
682
  export interface GetSignalContext extends HttpClientContext {
503
683
  parameters: GetSignalParametersInterface | GetSignalParameters;
504
684
  requestHeaders?: GetSignalHeaders;
685
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
686
+ signal?: AbortSignal;
505
687
  }
506
688
  /**
507
689
  * Retrieve a signal
@@ -510,6 +692,8 @@ declare function getSignal(context: GetSignalContext): Promise<HttpClientRespons
510
692
  export interface GetBusinessMonitorContext extends HttpClientContext {
511
693
  parameters: GetBusinessMonitorParametersInterface | GetBusinessMonitorParameters;
512
694
  requestHeaders?: GetBusinessMonitorHeaders;
695
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
696
+ signal?: AbortSignal;
513
697
  }
514
698
  /**
515
699
  * Retrieve a monitor for a business
@@ -519,6 +703,8 @@ export interface CreateBusinessMonitorContext extends HttpClientContext {
519
703
  payload: MonitoringEventTypesParam;
520
704
  parameters: CreateBusinessMonitorParametersInterface | CreateBusinessMonitorParameters;
521
705
  requestHeaders?: CreateBusinessMonitorHeaders;
706
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
707
+ signal?: AbortSignal;
522
708
  }
523
709
  /**
524
710
  * Create a monitor for a business
@@ -528,6 +714,8 @@ export interface UpdateBusinessMonitorContext extends HttpClientContext {
528
714
  payload: MonitoringEventTypesParam;
529
715
  parameters: UpdateBusinessMonitorParametersInterface | UpdateBusinessMonitorParameters;
530
716
  requestHeaders?: UpdateBusinessMonitorHeaders;
717
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
718
+ signal?: AbortSignal;
531
719
  }
532
720
  /**
533
721
  * Update a monitor for a business
@@ -536,6 +724,8 @@ declare function updateBusinessMonitor(context: UpdateBusinessMonitorContext): P
536
724
  export interface DeleteBusinessMonitorContext extends HttpClientContext {
537
725
  parameters: DeleteBusinessMonitorParametersInterface | DeleteBusinessMonitorParameters;
538
726
  requestHeaders?: DeleteBusinessMonitorHeaders;
727
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
728
+ signal?: AbortSignal;
539
729
  }
540
730
  /**
541
731
  * Delete a monitor for a business
@@ -544,6 +734,8 @@ declare function deleteBusinessMonitor(context: DeleteBusinessMonitorContext): P
544
734
  export interface BulkDisableMonitorsContext extends HttpClientContext {
545
735
  payload: BulkDisableMonitorsRequest;
546
736
  requestHeaders?: BulkDisableMonitorsHeaders;
737
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
738
+ signal?: AbortSignal;
547
739
  }
548
740
  /**
549
741
  * Disables monitors for all businesses in the account. This operation is processed asynchronously. When monitor_types is omitted, all monitor types allowed for the account are disabled.
@@ -552,6 +744,8 @@ declare function bulkDisableMonitors(context: BulkDisableMonitorsContext): Promi
552
744
  export interface ListLiensContext extends HttpClientContext {
553
745
  parameters: ListLiensParametersInterface | ListLiensParameters;
554
746
  requestHeaders?: ListLiensHeaders;
747
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
748
+ signal?: AbortSignal;
555
749
  }
556
750
  /**
557
751
  * List liens for a business
@@ -561,6 +755,8 @@ export interface CreateLienContext extends HttpClientContext {
561
755
  payload: CreateLienRequest;
562
756
  parameters: CreateLienParametersInterface | CreateLienParameters;
563
757
  requestHeaders?: CreateLienHeaders;
758
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
759
+ signal?: AbortSignal;
564
760
  }
565
761
  /**
566
762
  * Create a lien for a business
@@ -570,6 +766,8 @@ export interface CreateLienFilingsInBatchContext extends HttpClientContext {
570
766
  payload: CreateLienFilingsInBatchRequest;
571
767
  parameters: CreateLienFilingsInBatchParametersInterface | CreateLienFilingsInBatchParameters;
572
768
  requestHeaders?: CreateLienFilingsInBatchHeaders;
769
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
770
+ signal?: AbortSignal;
573
771
  }
574
772
  /**
575
773
  * Creates multiple lien filings in a single request. Each entry is processed independently. Successful entries return lien objects, failed entries return per-item errors.
@@ -579,6 +777,8 @@ export interface CreateRegistrationContext extends HttpClientContext {
579
777
  payload: InternationalRegistrationRequestParam;
580
778
  parameters: CreateRegistrationParametersInterface | CreateRegistrationParameters;
581
779
  requestHeaders?: CreateRegistrationHeaders;
780
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
781
+ signal?: AbortSignal;
582
782
  }
583
783
  /**
584
784
  * Create a registration for a business
@@ -588,6 +788,8 @@ export interface CreateLienTerminationContext extends HttpClientContext {
588
788
  payload: CreateLienTerminationRequest;
589
789
  parameters: CreateLienTerminationParametersInterface | CreateLienTerminationParameters;
590
790
  requestHeaders?: CreateLienTerminationHeaders;
791
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
792
+ signal?: AbortSignal;
591
793
  }
592
794
  /**
593
795
  * Creates a lien termination or returns existing one if already terminated
@@ -596,6 +798,8 @@ declare function createLienTermination(context: CreateLienTerminationContext): P
596
798
  export interface ListBusinessPolicyResultsContext extends HttpClientContext {
597
799
  parameters: ListBusinessPolicyResultsParametersInterface | ListBusinessPolicyResultsParameters;
598
800
  requestHeaders?: ListBusinessPolicyResultsHeaders;
801
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
802
+ signal?: AbortSignal;
599
803
  }
600
804
  /**
601
805
  * Returns policy results for enabled policy versions only
@@ -604,6 +808,8 @@ declare function listBusinessPolicyResults(context: ListBusinessPolicyResultsCon
604
808
  export interface GetBusinessReviewContext extends HttpClientContext {
605
809
  parameters: GetBusinessReviewParametersInterface | GetBusinessReviewParameters;
606
810
  requestHeaders?: GetBusinessReviewHeaders;
811
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
812
+ signal?: AbortSignal;
607
813
  }
608
814
  /**
609
815
  * Returns the review associated with a business
@@ -612,6 +818,8 @@ declare function getBusinessReview(context: GetBusinessReviewContext): Promise<H
612
818
  export interface ListActionsContext extends HttpClientContext {
613
819
  parameters: ListActionsParametersInterface | ListActionsParameters;
614
820
  requestHeaders?: ListActionsHeaders;
821
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
822
+ signal?: AbortSignal;
615
823
  }
616
824
  /**
617
825
  * List actions for an object
@@ -620,6 +828,8 @@ declare function listActions(context: ListActionsContext): Promise<HttpClientRes
620
828
  export interface CreateActionContext extends HttpClientContext {
621
829
  payload: CreateActionRequest;
622
830
  requestHeaders?: CreateActionHeaders;
831
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
832
+ signal?: AbortSignal;
623
833
  }
624
834
  /**
625
835
  * Create an action on an object
@@ -628,6 +838,8 @@ declare function createAction(context: CreateActionContext): Promise<HttpClientR
628
838
  export interface GetActionContext extends HttpClientContext {
629
839
  parameters: GetActionParametersInterface | GetActionParameters;
630
840
  requestHeaders?: GetActionHeaders;
841
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
842
+ signal?: AbortSignal;
631
843
  }
632
844
  /**
633
845
  * Retrieve an action
@@ -635,6 +847,8 @@ export interface GetActionContext extends HttpClientContext {
635
847
  declare function getAction(context: GetActionContext): Promise<HttpClientResponse<GetActionResponse>>;
636
848
  export interface GetTinMatchAvailabilityContext extends HttpClientContext {
637
849
  requestHeaders?: GetTinMatchAvailabilityHeaders;
850
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
851
+ signal?: AbortSignal;
638
852
  }
639
853
  /**
640
854
  * Returns the availability status of the IRS TIN matching service
@@ -643,6 +857,8 @@ declare function getTinMatchAvailability(context?: GetTinMatchAvailabilityContex
643
857
  export interface GetBusinessWebsiteContext extends HttpClientContext {
644
858
  parameters: GetBusinessWebsiteParametersInterface | GetBusinessWebsiteParameters;
645
859
  requestHeaders?: GetBusinessWebsiteHeaders;
860
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
861
+ signal?: AbortSignal;
646
862
  }
647
863
  /**
648
864
  * Returns website analysis data including domain info, pages, and quality indicators
@@ -651,6 +867,8 @@ declare function getBusinessWebsite(context: GetBusinessWebsiteContext): Promise
651
867
  export interface ListConnectionsContext extends HttpClientContext {
652
868
  parameters: ListConnectionsParametersInterface | ListConnectionsParameters;
653
869
  requestHeaders?: ListConnectionsHeaders;
870
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
871
+ signal?: AbortSignal;
654
872
  }
655
873
  /**
656
874
  * Returns businesses connected to the specified business, ordered by confidence score. Each connection includes connecting people, addresses, and businesses that link them. Results are paginated.
@@ -659,6 +877,8 @@ declare function listConnections(context: ListConnectionsContext): Promise<HttpC
659
877
  export interface GetBusinessTimelineContext extends HttpClientContext {
660
878
  parameters: GetBusinessTimelineParametersInterface | GetBusinessTimelineParameters;
661
879
  requestHeaders?: GetBusinessTimelineHeaders;
880
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
881
+ signal?: AbortSignal;
662
882
  }
663
883
  /**
664
884
  * Returns a paginated list of timeline events for a business, providing a chronological record of changes observed on the business's Secretary of State registrations. Events are ordered by `occurred_at`, newest first.
@@ -669,6 +889,8 @@ declare function getBusinessTimeline(context: GetBusinessTimelineContext): Promi
669
889
  export interface ListRegistrationRequestsContext extends HttpClientContext {
670
890
  parameters: ListRegistrationRequestsParametersInterface | ListRegistrationRequestsParameters;
671
891
  requestHeaders?: ListRegistrationRequestsHeaders;
892
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
893
+ signal?: AbortSignal;
672
894
  }
673
895
  /**
674
896
  * List registration requests
@@ -677,6 +899,8 @@ declare function listRegistrationRequests(context: ListRegistrationRequestsConte
677
899
  export interface CreateRegistrationRequestContext extends HttpClientContext {
678
900
  payload: CreateRegistrationRequestRequest;
679
901
  requestHeaders?: CreateRegistrationRequestHeaders;
902
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
903
+ signal?: AbortSignal;
680
904
  }
681
905
  /**
682
906
  * Create a registration request
@@ -685,6 +909,8 @@ declare function createRegistrationRequest(context: CreateRegistrationRequestCon
685
909
  export interface GetRegistrationRequestContext extends HttpClientContext {
686
910
  parameters: GetRegistrationRequestParametersInterface | GetRegistrationRequestParameters;
687
911
  requestHeaders?: GetRegistrationRequestHeaders;
912
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
913
+ signal?: AbortSignal;
688
914
  }
689
915
  /**
690
916
  * Retrieve a registration request
@@ -693,6 +919,8 @@ declare function getRegistrationRequest(context: GetRegistrationRequestContext):
693
919
  export interface DeleteRegistrationRequestContext extends HttpClientContext {
694
920
  parameters: DeleteRegistrationRequestParametersInterface | DeleteRegistrationRequestParameters;
695
921
  requestHeaders?: DeleteRegistrationRequestHeaders;
922
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
923
+ signal?: AbortSignal;
696
924
  }
697
925
  /**
698
926
  * Delete a registration request
@@ -701,6 +929,8 @@ declare function deleteRegistrationRequest(context: DeleteRegistrationRequestCon
701
929
  export interface GetRegistrationRequestGuestDashboardContext extends HttpClientContext {
702
930
  parameters: GetRegistrationRequestGuestDashboardParametersInterface | GetRegistrationRequestGuestDashboardParameters;
703
931
  requestHeaders?: GetRegistrationRequestGuestDashboardHeaders;
932
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
933
+ signal?: AbortSignal;
704
934
  }
705
935
  /**
706
936
  * Fetch guest dashboard link for a registration request
@@ -709,6 +939,8 @@ declare function getRegistrationRequestGuestDashboard(context: GetRegistrationRe
709
939
  export interface ListInformationRequestsContext extends HttpClientContext {
710
940
  parameters: ListInformationRequestsParametersInterface | ListInformationRequestsParameters;
711
941
  requestHeaders?: ListInformationRequestsHeaders;
942
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
943
+ signal?: AbortSignal;
712
944
  }
713
945
  /**
714
946
  * List Information Requests
@@ -717,6 +949,8 @@ declare function listInformationRequests(context: ListInformationRequestsContext
717
949
  export interface CreateApplicationContext extends HttpClientContext {
718
950
  payload: CreateApplicationRequest;
719
951
  requestHeaders?: CreateApplicationHeaders;
952
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
953
+ signal?: AbortSignal;
720
954
  }
721
955
  /**
722
956
  * Create an application
@@ -725,6 +959,8 @@ declare function createApplication(context: CreateApplicationContext): Promise<H
725
959
  export interface CreateCompanyContext extends HttpClientContext {
726
960
  payload: CreateCompanyRequest;
727
961
  requestHeaders?: CreateCompanyHeaders;
962
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
963
+ signal?: AbortSignal;
728
964
  }
729
965
  /**
730
966
  * Create a company
@@ -733,6 +969,8 @@ declare function createCompany(context: CreateCompanyContext): Promise<HttpClien
733
969
  export interface SearchJurisdictionsContext extends HttpClientContext {
734
970
  parameters: SearchJurisdictionsParametersInterface | SearchJurisdictionsParameters;
735
971
  requestHeaders?: SearchJurisdictionsHeaders;
972
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
973
+ signal?: AbortSignal;
736
974
  }
737
975
  /**
738
976
  * Search for jurisdictions by name, PSD code, or other criteria. Supports filtering by state, tax type, and jurisdiction type. Results are paginated.
@@ -741,6 +979,8 @@ declare function searchJurisdictions(context: SearchJurisdictionsContext): Promi
741
979
  export interface ListJurisdictionsContext extends HttpClientContext {
742
980
  parameters: ListJurisdictionsParametersInterface | ListJurisdictionsParameters;
743
981
  requestHeaders?: ListJurisdictionsHeaders;
982
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
983
+ signal?: AbortSignal;
744
984
  }
745
985
  /**
746
986
  * Fetch supported local jurisdictions
@@ -749,6 +989,8 @@ declare function listJurisdictions(context: ListJurisdictionsContext): Promise<H
749
989
  export interface ListQuestionsContext extends HttpClientContext {
750
990
  parameters: ListQuestionsParametersInterface | ListQuestionsParameters;
751
991
  requestHeaders?: ListQuestionsHeaders;
992
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
993
+ signal?: AbortSignal;
752
994
  }
753
995
  /**
754
996
  * Retrieve the set of dynamic questions required for a registration in a given state or local jurisdiction. The questions returned depend on the jurisdiction and registration type.
@@ -757,6 +999,8 @@ declare function listQuestions(context: ListQuestionsContext): Promise<HttpClien
757
999
  export interface ListMailItemsContext extends HttpClientContext {
758
1000
  parameters: ListMailItemsParametersInterface | ListMailItemsParameters;
759
1001
  requestHeaders?: ListMailItemsHeaders;
1002
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1003
+ signal?: AbortSignal;
760
1004
  }
761
1005
  /**
762
1006
  * List mail items
@@ -765,6 +1009,8 @@ declare function listMailItems(context: ListMailItemsContext): Promise<HttpClien
765
1009
  export interface GetMailItemContext extends HttpClientContext {
766
1010
  parameters: GetMailItemParametersInterface | GetMailItemParameters;
767
1011
  requestHeaders?: GetMailItemHeaders;
1012
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1013
+ signal?: AbortSignal;
768
1014
  }
769
1015
  /**
770
1016
  * Retrieve a mail item
@@ -774,6 +1020,8 @@ export interface UpdateMailItemContext extends HttpClientContext {
774
1020
  payload: UpdateMailItemRequest;
775
1021
  parameters: UpdateMailItemParametersInterface | UpdateMailItemParameters;
776
1022
  requestHeaders?: UpdateMailItemHeaders;
1023
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1024
+ signal?: AbortSignal;
777
1025
  }
778
1026
  /**
779
1027
  * Update a mail item
@@ -781,6 +1029,8 @@ export interface UpdateMailItemContext extends HttpClientContext {
781
1029
  declare function updateMailItem(context: UpdateMailItemContext): Promise<HttpClientResponse<undefined>>;
782
1030
  export interface ListAgentsContext extends HttpClientContext {
783
1031
  requestHeaders?: ListAgentsHeaders;
1032
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1033
+ signal?: AbortSignal;
784
1034
  }
785
1035
  /**
786
1036
  * Returns a list of available agents for running workflows
@@ -789,6 +1039,8 @@ declare function listAgents(context?: ListAgentsContext): Promise<HttpClientResp
789
1039
  export interface GetAgentContext extends HttpClientContext {
790
1040
  parameters: GetAgentParametersInterface | GetAgentParameters;
791
1041
  requestHeaders?: GetAgentHeaders;
1042
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1043
+ signal?: AbortSignal;
792
1044
  }
793
1045
  /**
794
1046
  * Retrieves details of a specific agent
@@ -797,6 +1049,8 @@ declare function getAgent(context: GetAgentContext): Promise<HttpClientResponse<
797
1049
  export interface ListAgentThreadsContext extends HttpClientContext {
798
1050
  parameters: ListAgentThreadsParametersInterface | ListAgentThreadsParameters;
799
1051
  requestHeaders?: ListAgentThreadsHeaders;
1052
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1053
+ signal?: AbortSignal;
800
1054
  }
801
1055
  /**
802
1056
  * Returns a paginated list of agent threads
@@ -805,6 +1059,8 @@ declare function listAgentThreads(context: ListAgentThreadsContext): Promise<Htt
805
1059
  export interface CreateAgentThreadContext extends HttpClientContext {
806
1060
  payload: CreateAgentThreadRequest;
807
1061
  requestHeaders?: CreateAgentThreadHeaders;
1062
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1063
+ signal?: AbortSignal;
808
1064
  }
809
1065
  /**
810
1066
  * Creates a new agent thread for running agent workflows
@@ -813,6 +1069,8 @@ declare function createAgentThread(context: CreateAgentThreadContext): Promise<H
813
1069
  export interface GetAgentThreadContext extends HttpClientContext {
814
1070
  parameters: GetAgentThreadParametersInterface | GetAgentThreadParameters;
815
1071
  requestHeaders?: GetAgentThreadHeaders;
1072
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1073
+ signal?: AbortSignal;
816
1074
  }
817
1075
  /**
818
1076
  * Retrieves details of a specific agent thread
@@ -821,6 +1079,8 @@ declare function getAgentThread(context: GetAgentThreadContext): Promise<HttpCli
821
1079
  export interface ListAgentRunsContext extends HttpClientContext {
822
1080
  parameters: ListAgentRunsParametersInterface | ListAgentRunsParameters;
823
1081
  requestHeaders?: ListAgentRunsHeaders;
1082
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1083
+ signal?: AbortSignal;
824
1084
  }
825
1085
  /**
826
1086
  * Returns a paginated list of agent runs
@@ -829,6 +1089,8 @@ declare function listAgentRuns(context: ListAgentRunsContext): Promise<HttpClien
829
1089
  export interface CreateAgentRunContext extends HttpClientContext {
830
1090
  payload: CreateAgentRunRequest;
831
1091
  requestHeaders?: CreateAgentRunHeaders;
1092
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1093
+ signal?: AbortSignal;
832
1094
  }
833
1095
  /**
834
1096
  * Creates a new agent run
@@ -837,6 +1099,8 @@ declare function createAgentRun(context: CreateAgentRunContext): Promise<HttpCli
837
1099
  export interface GetAgentRunContext extends HttpClientContext {
838
1100
  parameters: GetAgentRunParametersInterface | GetAgentRunParameters;
839
1101
  requestHeaders?: GetAgentRunHeaders;
1102
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1103
+ signal?: AbortSignal;
840
1104
  }
841
1105
  /**
842
1106
  * Retrieves details of a specific agent run
@@ -846,6 +1110,8 @@ export interface SubmitAgentRunFeedbackContext extends HttpClientContext {
846
1110
  payload: SubmitAgentRunFeedbackRequest;
847
1111
  parameters: SubmitAgentRunFeedbackParametersInterface | SubmitAgentRunFeedbackParameters;
848
1112
  requestHeaders?: SubmitAgentRunFeedbackHeaders;
1113
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1114
+ signal?: AbortSignal;
849
1115
  }
850
1116
  /**
851
1117
  * Records a rating on an agent run artifact. The rating can be POSITIVE or NEGATIVE. Attribution defaults to the authenticated user; API-key callers are attributed to their account instead.
@@ -854,6 +1120,8 @@ declare function submitAgentRunFeedback(context: SubmitAgentRunFeedbackContext):
854
1120
  export interface StreamAgentRunEventsContext extends HttpClientContext {
855
1121
  parameters: StreamAgentRunEventsParametersInterface | StreamAgentRunEventsParameters;
856
1122
  requestHeaders?: StreamAgentRunEventsHeaders;
1123
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1124
+ signal?: AbortSignal;
857
1125
  }
858
1126
  /**
859
1127
  * Streams real-time events for an agent run using Server-Sent Events (SSE). Events are emitted in AG-UI format: `RUN_STARTED`, `STATE_SNAPSHOT`, and `RUN_FINISHED`.
@@ -862,6 +1130,8 @@ declare function streamAgentRunEvents(context: StreamAgentRunEventsContext): Pro
862
1130
  export interface AutocompleteBusinessIdentitiesContext extends HttpClientContext {
863
1131
  payload: AutocompleteBusinessIdentitiesRequest;
864
1132
  requestHeaders?: AutocompleteBusinessIdentitiesHeaders;
1133
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1134
+ signal?: AbortSignal;
865
1135
  }
866
1136
  /**
867
1137
  * Search for business identities using partial name matching. Returns matching businesses with names, addresses, people, and entity type.
@@ -870,6 +1140,8 @@ declare function autocompleteBusinessIdentities(context: AutocompleteBusinessIde
870
1140
  export interface BusinessContext extends HttpClientContext {
871
1141
  payload: BusinessRequest;
872
1142
  requestHeaders?: BusinessHeaders;
1143
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1144
+ signal?: AbortSignal;
873
1145
  }
874
1146
  /**
875
1147
  * Smart populate business attributes by searching with name and address, TIN, or website URL. Returns enriched business data.
@@ -878,6 +1150,8 @@ declare function business(context: BusinessContext): Promise<HttpClientResponse<
878
1150
  export interface ListWebhooksContext extends HttpClientContext {
879
1151
  parameters: ListWebhooksParametersInterface | ListWebhooksParameters;
880
1152
  requestHeaders?: ListWebhooksHeaders;
1153
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1154
+ signal?: AbortSignal;
881
1155
  }
882
1156
  /**
883
1157
  * List webhooks
@@ -886,6 +1160,8 @@ declare function listWebhooks(context: ListWebhooksContext): Promise<HttpClientR
886
1160
  export interface CreateWebhookContext extends HttpClientContext {
887
1161
  payload: CreateWebhookRequest;
888
1162
  requestHeaders?: CreateWebhookHeaders;
1163
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1164
+ signal?: AbortSignal;
889
1165
  }
890
1166
  /**
891
1167
  * Creates a webhook endpoint. Optional event_schemas may be supplied at creation time to customize `data.object` for supported event namespaces while preserving the normal webhook envelope.
@@ -894,6 +1170,8 @@ declare function createWebhook(context: CreateWebhookContext): Promise<HttpClien
894
1170
  export interface GetWebhookContext extends HttpClientContext {
895
1171
  parameters: GetWebhookParametersInterface | GetWebhookParameters;
896
1172
  requestHeaders?: GetWebhookHeaders;
1173
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1174
+ signal?: AbortSignal;
897
1175
  }
898
1176
  /**
899
1177
  * Retrieve a webhook
@@ -903,6 +1181,8 @@ export interface UpdateWebhookContext extends HttpClientContext {
903
1181
  payload: UpdateWebhookRequest;
904
1182
  parameters: UpdateWebhookParametersInterface | UpdateWebhookParameters;
905
1183
  requestHeaders?: UpdateWebhookHeaders;
1184
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1185
+ signal?: AbortSignal;
906
1186
  }
907
1187
  /**
908
1188
  * Updates webhook endpoint settings. Event schemas are managed through the nested event_schemas resource, not through webhook updates.
@@ -911,6 +1191,8 @@ declare function updateWebhook(context: UpdateWebhookContext): Promise<HttpClien
911
1191
  export interface DeleteWebhookContext extends HttpClientContext {
912
1192
  parameters: DeleteWebhookParametersInterface | DeleteWebhookParameters;
913
1193
  requestHeaders?: DeleteWebhookHeaders;
1194
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1195
+ signal?: AbortSignal;
914
1196
  }
915
1197
  /**
916
1198
  * Delete a webhook
@@ -919,6 +1201,8 @@ declare function deleteWebhook(context: DeleteWebhookContext): Promise<HttpClien
919
1201
  export interface ListWebhookEventSchemasContext extends HttpClientContext {
920
1202
  parameters: ListWebhookEventSchemasParametersInterface | ListWebhookEventSchemasParameters;
921
1203
  requestHeaders?: ListWebhookEventSchemasHeaders;
1204
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1205
+ signal?: AbortSignal;
922
1206
  }
923
1207
  /**
924
1208
  * Lists active custom GraphQL schemas configured for this webhook. Each schema applies to one supported event namespace.
@@ -928,6 +1212,8 @@ export interface CreateWebhookEventSchemaContext extends HttpClientContext {
928
1212
  payload: CreateWebhookEventSchemaRequest;
929
1213
  parameters: CreateWebhookEventSchemaParametersInterface | CreateWebhookEventSchemaParameters;
930
1214
  requestHeaders?: CreateWebhookEventSchemaHeaders;
1215
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1216
+ signal?: AbortSignal;
931
1217
  }
932
1218
  /**
933
1219
  * Creates a custom GraphQL schema for one webhook event namespace. For supported business events, the schema is a root-level Business selection set such as "{ id name runs { id agent } }".
@@ -936,6 +1222,8 @@ declare function createWebhookEventSchema(context: CreateWebhookEventSchemaConte
936
1222
  export interface GetWebhookEventSchemaContext extends HttpClientContext {
937
1223
  parameters: GetWebhookEventSchemaParametersInterface | GetWebhookEventSchemaParameters;
938
1224
  requestHeaders?: GetWebhookEventSchemaHeaders;
1225
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1226
+ signal?: AbortSignal;
939
1227
  }
940
1228
  /**
941
1229
  * Retrieves one active webhook event schema scoped to the parent webhook.
@@ -945,6 +1233,8 @@ export interface UpdateWebhookEventSchemaContext extends HttpClientContext {
945
1233
  payload: UpdateWebhookEventSchemaRequest;
946
1234
  parameters: UpdateWebhookEventSchemaParametersInterface | UpdateWebhookEventSchemaParameters;
947
1235
  requestHeaders?: UpdateWebhookEventSchemaHeaders;
1236
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1237
+ signal?: AbortSignal;
948
1238
  }
949
1239
  /**
950
1240
  * Updates the GraphQL selection set for a webhook event schema. The namespace is immutable. Changes apply to future event snapshots only.
@@ -953,12 +1243,16 @@ declare function updateWebhookEventSchema(context: UpdateWebhookEventSchemaConte
953
1243
  export interface DeleteWebhookEventSchemaContext extends HttpClientContext {
954
1244
  parameters: DeleteWebhookEventSchemaParametersInterface | DeleteWebhookEventSchemaParameters;
955
1245
  requestHeaders?: DeleteWebhookEventSchemaHeaders;
1246
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1247
+ signal?: AbortSignal;
956
1248
  }
957
1249
  /**
958
1250
  * Deletes a webhook event schema and resets that webhook event namespace to default delivery.
959
1251
  */
960
1252
  declare function deleteWebhookEventSchema(context: DeleteWebhookEventSchemaContext): Promise<HttpClientResponse<undefined>>;
961
1253
  export interface GetOidcKeysContext extends HttpClientContext {
1254
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1255
+ signal?: AbortSignal;
962
1256
  }
963
1257
  /**
964
1258
  * Returns the public keys used for OIDC JWT signature verification
@@ -967,6 +1261,8 @@ declare function getOidcKeys(context?: GetOidcKeysContext): Promise<HttpClientRe
967
1261
  export interface ListDocumentsContext extends HttpClientContext {
968
1262
  parameters: ListDocumentsParametersInterface | ListDocumentsParameters;
969
1263
  requestHeaders?: ListDocumentsHeaders;
1264
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1265
+ signal?: AbortSignal;
970
1266
  }
971
1267
  /**
972
1268
  * List documents for a business
@@ -975,6 +1271,8 @@ declare function listDocuments(context: ListDocumentsContext): Promise<HttpClien
975
1271
  export interface GetDocumentContext extends HttpClientContext {
976
1272
  parameters: GetDocumentParametersInterface | GetDocumentParameters;
977
1273
  requestHeaders?: GetDocumentHeaders;
1274
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1275
+ signal?: AbortSignal;
978
1276
  }
979
1277
  /**
980
1278
  * Get a document
@@ -983,6 +1281,8 @@ declare function getDocument(context: GetDocumentContext): Promise<HttpClientRes
983
1281
  export interface GetDocumentDownloadUrlContext extends HttpClientContext {
984
1282
  parameters: GetDocumentDownloadUrlParametersInterface | GetDocumentDownloadUrlParameters;
985
1283
  requestHeaders?: GetDocumentDownloadUrlHeaders;
1284
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1285
+ signal?: AbortSignal;
986
1286
  }
987
1287
  /**
988
1288
  * Get document download URL
@@ -991,6 +1291,8 @@ declare function getDocumentDownloadUrl(context: GetDocumentDownloadUrlContext):
991
1291
  export interface GetRiskAssessmentsContext extends HttpClientContext {
992
1292
  parameters: GetRiskAssessmentsParametersInterface | GetRiskAssessmentsParameters;
993
1293
  requestHeaders?: GetRiskAssessmentsHeaders;
1294
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1295
+ signal?: AbortSignal;
994
1296
  }
995
1297
  /**
996
1298
  * Retrieve a business's risk assessment history
@@ -999,6 +1301,8 @@ declare function getRiskAssessments(context: GetRiskAssessmentsContext): Promise
999
1301
  export interface GetLatestRiskAssessmentContext extends HttpClientContext {
1000
1302
  parameters: GetLatestRiskAssessmentParametersInterface | GetLatestRiskAssessmentParameters;
1001
1303
  requestHeaders?: GetLatestRiskAssessmentHeaders;
1304
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1305
+ signal?: AbortSignal;
1002
1306
  }
1003
1307
  /**
1004
1308
  * Retrieve the latest scored risk assessment for a business
@@ -1007,10 +1311,84 @@ declare function getLatestRiskAssessment(context: GetLatestRiskAssessmentContext
1007
1311
  export interface GetRiskAssessmentContext extends HttpClientContext {
1008
1312
  parameters: GetRiskAssessmentParametersInterface | GetRiskAssessmentParameters;
1009
1313
  requestHeaders?: GetRiskAssessmentHeaders;
1314
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1315
+ signal?: AbortSignal;
1010
1316
  }
1011
1317
  /**
1012
1318
  * Retrieve a risk assessment
1013
1319
  */
1014
1320
  declare function getRiskAssessment(context: GetRiskAssessmentContext): Promise<HttpClientResponse<GetRiskAssessmentResponse>>;
1015
- export { listBusinesses, createBusiness, getBusiness, updateBusiness, getBusinessPdf, listOrders, createOrder, getOrder, getOrderById, updateOrder, listBusinessBatches, createBusinessBatch, getBusinessBatch, getBusinessBatchCsv, listSignals, createSignal, getSignal, getBusinessMonitor, createBusinessMonitor, updateBusinessMonitor, deleteBusinessMonitor, bulkDisableMonitors, listLiens, createLien, createLienFilingsInBatch, createRegistration, createLienTermination, listBusinessPolicyResults, getBusinessReview, listActions, createAction, getAction, getTinMatchAvailability, getBusinessWebsite, listConnections, getBusinessTimeline, listRegistrationRequests, createRegistrationRequest, getRegistrationRequest, deleteRegistrationRequest, getRegistrationRequestGuestDashboard, listInformationRequests, createApplication, createCompany, searchJurisdictions, listJurisdictions, listQuestions, listMailItems, getMailItem, updateMailItem, listAgents, getAgent, listAgentThreads, createAgentThread, getAgentThread, listAgentRuns, createAgentRun, getAgentRun, submitAgentRunFeedback, streamAgentRunEvents, autocompleteBusinessIdentities, business, listWebhooks, createWebhook, getWebhook, updateWebhook, deleteWebhook, listWebhookEventSchemas, createWebhookEventSchema, getWebhookEventSchema, updateWebhookEventSchema, deleteWebhookEventSchema, getOidcKeys, listDocuments, getDocument, getDocumentDownloadUrl, getRiskAssessments, getLatestRiskAssessment, getRiskAssessment };
1321
+ export interface ListSubAccountsContext extends HttpClientContext {
1322
+ parameters: ListSubAccountsParametersInterface | ListSubAccountsParameters;
1323
+ requestHeaders?: ListSubAccountsHeaders;
1324
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1325
+ signal?: AbortSignal;
1326
+ }
1327
+ /**
1328
+ * Lists sub-accounts owned by the caller, newest first. q performs a case-insensitive substring search on name only; percent and underscore characters are treated literally.
1329
+ */
1330
+ declare function listSubAccounts(context: ListSubAccountsContext): Promise<HttpClientResponse<ListSubAccountsResponse>>;
1331
+ export interface CreateSubAccountContext extends HttpClientContext {
1332
+ payload: CreateSubAccountRequest;
1333
+ requestHeaders?: CreateSubAccountHeaders;
1334
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1335
+ signal?: AbortSignal;
1336
+ }
1337
+ /**
1338
+ * Creates a sub-account and provisions an initial sandbox API key. external_id is an idempotency key unique within the parent account: repeating a request with the same external_id returns the existing sub-account with 200 and no api_keys field. With inherit_products_from_parent enabled (the default), parent product changes cascade to the sub-account. When disabled, products is required and the sub-account is independent.
1339
+ */
1340
+ declare function createSubAccount(context: CreateSubAccountContext): Promise<HttpClientResponse<CreateSubAccountResponse>>;
1341
+ export interface GetSubAccountContext extends HttpClientContext {
1342
+ parameters: GetSubAccountParametersInterface | GetSubAccountParameters;
1343
+ requestHeaders?: GetSubAccountHeaders;
1344
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1345
+ signal?: AbortSignal;
1346
+ }
1347
+ /**
1348
+ * Returns a sub-account owned by the caller. IDs belonging to another parent return 404.
1349
+ */
1350
+ declare function getSubAccount(context: GetSubAccountContext): Promise<HttpClientResponse<GetSubAccountResponse>>;
1351
+ export interface UpdateSubAccountContext extends HttpClientContext {
1352
+ payload: UpdateSubAccountRequest;
1353
+ parameters: UpdateSubAccountParametersInterface | UpdateSubAccountParameters;
1354
+ requestHeaders?: UpdateSubAccountHeaders;
1355
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1356
+ signal?: AbortSignal;
1357
+ }
1358
+ /**
1359
+ * Activates or deactivates a sub-account. Deactivation causes every API key belonging to the sub-account to return 401, while retaining its data and keys. Re-enabling restores access.
1360
+ */
1361
+ declare function updateSubAccount(context: UpdateSubAccountContext): Promise<HttpClientResponse<UpdateSubAccountResponse>>;
1362
+ export interface ListSubAccountApiKeysContext extends HttpClientContext {
1363
+ parameters: ListSubAccountApiKeysParametersInterface | ListSubAccountApiKeysParameters;
1364
+ requestHeaders?: ListSubAccountApiKeysHeaders;
1365
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1366
+ signal?: AbortSignal;
1367
+ }
1368
+ /**
1369
+ * Lists active API keys for a sub-account owned by the caller. The response includes each key value; store and handle the response as a secret.
1370
+ */
1371
+ declare function listSubAccountApiKeys(context: ListSubAccountApiKeysContext): Promise<HttpClientResponse<ListSubAccountApiKeysResponse>>;
1372
+ export interface CreateSubAccountApiKeyContext extends HttpClientContext {
1373
+ payload: CreateSubAccountApiKeyRequest;
1374
+ parameters: CreateSubAccountApiKeyParametersInterface | CreateSubAccountApiKeyParameters;
1375
+ requestHeaders?: CreateSubAccountApiKeyHeaders;
1376
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1377
+ signal?: AbortSignal;
1378
+ }
1379
+ /**
1380
+ * Creates a sandbox or production API key for a sub-account. Treat the returned key value as a secret. For rotation, create a replacement, cut traffic over, then revoke the old key.
1381
+ */
1382
+ declare function createSubAccountApiKey(context: CreateSubAccountApiKeyContext): Promise<HttpClientResponse<CreateSubAccountApiKeyResponse>>;
1383
+ export interface DeleteSubAccountApiKeyContext extends HttpClientContext {
1384
+ parameters: DeleteSubAccountApiKeyParametersInterface | DeleteSubAccountApiKeyParameters;
1385
+ requestHeaders?: DeleteSubAccountApiKeyHeaders;
1386
+ /** Aborts the request. Composed with the per-attempt `timeoutMs` signal; a caller abort is never retried, unlike a timeout. */
1387
+ signal?: AbortSignal;
1388
+ }
1389
+ /**
1390
+ * Revokes an API key belonging to a sub-account. The key must belong to the specified sub-account, and the sub-account must belong to the caller.
1391
+ */
1392
+ declare function deleteSubAccountApiKey(context: DeleteSubAccountApiKeyContext): Promise<HttpClientResponse<undefined>>;
1393
+ export { listBusinesses, createBusiness, getBusiness, updateBusiness, getBusinessPdf, listOrders, createOrder, getOrder, getOrderById, updateOrder, listBusinessBatches, createBusinessBatch, getBusinessBatch, getBusinessBatchCsv, listSignals, createSignal, getSignal, getBusinessMonitor, createBusinessMonitor, updateBusinessMonitor, deleteBusinessMonitor, bulkDisableMonitors, listLiens, createLien, createLienFilingsInBatch, createRegistration, createLienTermination, listBusinessPolicyResults, getBusinessReview, listActions, createAction, getAction, getTinMatchAvailability, getBusinessWebsite, listConnections, getBusinessTimeline, listRegistrationRequests, createRegistrationRequest, getRegistrationRequest, deleteRegistrationRequest, getRegistrationRequestGuestDashboard, listInformationRequests, createApplication, createCompany, searchJurisdictions, listJurisdictions, listQuestions, listMailItems, getMailItem, updateMailItem, listAgents, getAgent, listAgentThreads, createAgentThread, getAgentThread, listAgentRuns, createAgentRun, getAgentRun, submitAgentRunFeedback, streamAgentRunEvents, autocompleteBusinessIdentities, business, listWebhooks, createWebhook, getWebhook, updateWebhook, deleteWebhook, listWebhookEventSchemas, createWebhookEventSchema, getWebhookEventSchema, updateWebhookEventSchema, deleteWebhookEventSchema, getOidcKeys, listDocuments, getDocument, getDocumentDownloadUrl, getRiskAssessments, getLatestRiskAssessment, getRiskAssessment, listSubAccounts, createSubAccount, getSubAccount, updateSubAccount, listSubAccountApiKeys, createSubAccountApiKey, deleteSubAccountApiKey };
1016
1394
  //# sourceMappingURL=http_client.d.ts.map