@ai-matrx/api 0.0.0-stage → 0.1.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 (146) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/LICENSE +21 -0
  3. package/README.md +18 -2
  4. package/dist/account.cjs +670 -0
  5. package/dist/account.d.cts +3246 -0
  6. package/dist/account.d.ts +3246 -0
  7. package/dist/account.js +558 -0
  8. package/dist/agents.cjs +598 -0
  9. package/dist/agents.d.cts +3417 -0
  10. package/dist/agents.d.ts +3417 -0
  11. package/dist/agents.js +497 -0
  12. package/dist/ai.cjs +109 -0
  13. package/dist/ai.d.cts +493 -0
  14. package/dist/ai.d.ts +493 -0
  15. package/dist/ai.js +91 -0
  16. package/dist/apps.cjs +394 -0
  17. package/dist/apps.d.cts +1094 -0
  18. package/dist/apps.d.ts +1094 -0
  19. package/dist/apps.js +328 -0
  20. package/dist/architecture.cjs +1223 -0
  21. package/dist/architecture.d.cts +4701 -0
  22. package/dist/architecture.d.ts +4701 -0
  23. package/dist/architecture.js +1016 -0
  24. package/dist/audio.cjs +226 -0
  25. package/dist/audio.d.cts +723 -0
  26. package/dist/audio.d.ts +723 -0
  27. package/dist/audio.js +188 -0
  28. package/dist/chat.cjs +538 -0
  29. package/dist/chat.d.cts +2251 -0
  30. package/dist/chat.d.ts +2251 -0
  31. package/dist/chat.js +447 -0
  32. package/dist/chunk-2SXAAKGV.cjs +279 -0
  33. package/dist/chunk-AY5N6EA4.js +43 -0
  34. package/dist/chunk-BMQI7UET.cjs +48 -0
  35. package/dist/chunk-FNIYADWI.cjs +59 -0
  36. package/dist/chunk-KIEAFMKB.js +264 -0
  37. package/dist/chunk-UONBYRE4.js +1012 -0
  38. package/dist/chunk-YTEOFGFC.js +57 -0
  39. package/dist/chunk-YUDQWDCM.cjs +1047 -0
  40. package/dist/code.cjs +561 -0
  41. package/dist/code.d.cts +1976 -0
  42. package/dist/code.d.ts +1976 -0
  43. package/dist/code.js +467 -0
  44. package/dist/commerce.cjs +22 -0
  45. package/dist/commerce.d.cts +45 -0
  46. package/dist/commerce.d.ts +45 -0
  47. package/dist/commerce.js +18 -0
  48. package/dist/communications.cjs +215 -0
  49. package/dist/communications.d.cts +948 -0
  50. package/dist/communications.d.ts +948 -0
  51. package/dist/communications.js +179 -0
  52. package/dist/computer.cjs +330 -0
  53. package/dist/computer.d.cts +733 -0
  54. package/dist/computer.d.ts +733 -0
  55. package/dist/computer.js +275 -0
  56. package/dist/content.cjs +425 -0
  57. package/dist/content.d.cts +1796 -0
  58. package/dist/content.d.ts +1796 -0
  59. package/dist/content.js +354 -0
  60. package/dist/credentials.cjs +22 -0
  61. package/dist/credentials.d.cts +82 -0
  62. package/dist/credentials.d.ts +82 -0
  63. package/dist/credentials.js +1 -0
  64. package/dist/crm.cjs +271 -0
  65. package/dist/crm.d.cts +1731 -0
  66. package/dist/crm.d.ts +1731 -0
  67. package/dist/crm.js +226 -0
  68. package/dist/data.cjs +382 -0
  69. package/dist/data.d.cts +1860 -0
  70. package/dist/data.d.ts +1860 -0
  71. package/dist/data.js +318 -0
  72. package/dist/education.cjs +28 -0
  73. package/dist/education.d.cts +73 -0
  74. package/dist/education.d.ts +73 -0
  75. package/dist/education.js +23 -0
  76. package/dist/files.cjs +1330 -0
  77. package/dist/files.d.cts +4956 -0
  78. package/dist/files.d.ts +4956 -0
  79. package/dist/files.js +1104 -0
  80. package/dist/human-resources.cjs +178 -0
  81. package/dist/human-resources.d.cts +1208 -0
  82. package/dist/human-resources.d.ts +1208 -0
  83. package/dist/human-resources.js +148 -0
  84. package/dist/index-C2E-Cp19.d.ts +385 -0
  85. package/dist/index-wC2vtb70.d.cts +385 -0
  86. package/dist/index.cjs +1934 -0
  87. package/dist/index.d.cts +2006 -0
  88. package/dist/index.d.ts +2006 -0
  89. package/dist/index.js +1668 -0
  90. package/dist/integrations.cjs +5116 -0
  91. package/dist/integrations.d.cts +19213 -0
  92. package/dist/integrations.d.ts +19213 -0
  93. package/dist/integrations.js +4263 -0
  94. package/dist/intelligence.cjs +1305 -0
  95. package/dist/intelligence.d.cts +4658 -0
  96. package/dist/intelligence.d.ts +4658 -0
  97. package/dist/intelligence.js +1196 -0
  98. package/dist/knowledge.cjs +1113 -0
  99. package/dist/knowledge.d.cts +5427 -0
  100. package/dist/knowledge.d.ts +5427 -0
  101. package/dist/knowledge.js +921 -0
  102. package/dist/legal.cjs +225 -0
  103. package/dist/legal.d.cts +1038 -0
  104. package/dist/legal.d.ts +1038 -0
  105. package/dist/legal.js +187 -0
  106. package/dist/marketing.cjs +1155 -0
  107. package/dist/marketing.d.cts +7741 -0
  108. package/dist/marketing.d.ts +7741 -0
  109. package/dist/marketing.js +951 -0
  110. package/dist/masterwork.cjs +283 -0
  111. package/dist/masterwork.d.cts +1938 -0
  112. package/dist/masterwork.d.ts +1938 -0
  113. package/dist/masterwork.js +231 -0
  114. package/dist/media.cjs +610 -0
  115. package/dist/media.d.cts +2270 -0
  116. package/dist/media.d.ts +2270 -0
  117. package/dist/media.js +507 -0
  118. package/dist/net.cjs +67 -0
  119. package/dist/net.d.cts +204 -0
  120. package/dist/net.d.ts +204 -0
  121. package/dist/net.js +2 -0
  122. package/dist/platform.cjs +150 -0
  123. package/dist/platform.d.cts +572 -0
  124. package/dist/platform.d.ts +572 -0
  125. package/dist/platform.js +125 -0
  126. package/dist/publish.cjs +248 -0
  127. package/dist/publish.d.cts +1431 -0
  128. package/dist/publish.d.ts +1431 -0
  129. package/dist/publish.js +206 -0
  130. package/dist/schemas.cjs +2 -0
  131. package/dist/schemas.d.cts +1353 -0
  132. package/dist/schemas.d.ts +1353 -0
  133. package/dist/schemas.js +1 -0
  134. package/dist/stream.cjs +44 -0
  135. package/dist/stream.d.cts +2 -0
  136. package/dist/stream.d.ts +2 -0
  137. package/dist/stream.js +3 -0
  138. package/dist/web.cjs +1045 -0
  139. package/dist/web.d.cts +4186 -0
  140. package/dist/web.d.ts +4186 -0
  141. package/dist/web.js +867 -0
  142. package/dist/workflows.cjs +825 -0
  143. package/dist/workflows.d.cts +4699 -0
  144. package/dist/workflows.d.ts +4699 -0
  145. package/dist/workflows.js +686 -0
  146. package/package.json +418 -4
@@ -0,0 +1,1208 @@
1
+ import { A as Api, C as CallOptions } from './index-C2E-Cp19.js';
2
+ import { JsonValue } from './schemas.js';
3
+ import './credentials.js';
4
+
5
+ /**
6
+ * GENERATED by @ai-matrx/api scripts/generate.mjs from aidream/api-contract — never edit by hand.
7
+ * CONTRACT_SHA256 50a790edb39e682b46e0fa9e674faf5ce2a0ba7de2cd01930a497fca4c47844a
8
+ */
9
+
10
+ /** E-13's body, byte-for-byte against the frozen stub. */
11
+ type AccrualRunRequest = {
12
+ /** Organization context for the request; omitted to use the authenticated context. */
13
+ organization_id?: string | null;
14
+ /** Optional associated project selected by the caller. */
15
+ project_id?: string | null;
16
+ /** Optional associated task selected by the caller. */
17
+ task_id?: string | null;
18
+ /** Stable application slug that initiated the request. */
19
+ source_app?: string | null;
20
+ /** Stable feature slug within the source application. */
21
+ source_feature?: string | null;
22
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
23
+ initiation?: ("user" | "auto") | null;
24
+ /** The EVENT date the run accrues through. Never now() (§1.6 law 1). */
25
+ through_date: string;
26
+ scope: AccrualScopeOrg | AccrualScopePolicy | AccrualScopeEmployment;
27
+ mode?: "authoritative" | "prospective";
28
+ };
29
+ /** Named employments only — the offboarding run's final accrual uses this (§7 step 1). */
30
+ type AccrualScopeEmployment = {
31
+ kind: "employment";
32
+ employment_ids: string[];
33
+ };
34
+ /** Every in-range enrollment in the organization. */
35
+ type AccrualScopeOrg = {
36
+ kind: "org";
37
+ };
38
+ /** Every in-range enrollment on one policy. */
39
+ type AccrualScopePolicy = {
40
+ kind: "leave_policy";
41
+ leave_policy_id: string;
42
+ };
43
+ /** E-04 response — the typed supersession of the stub's open ``result`` (FREEZE D-3). */
44
+ type BreakPremiumCalcResponse = {
45
+ /** ALWAYS present. Computing a consequential result without a snapshot is a defect. */
46
+ snapshot_id: string;
47
+ prospective: boolean;
48
+ as_of: string;
49
+ jurisdiction_key: string;
50
+ engine: EngineRef;
51
+ rules_applied?: RuleApplied[];
52
+ flags?: CalcFlag[];
53
+ incomplete?: IncompleteFact[];
54
+ clamps?: Clamp[];
55
+ written?: WrittenRefs;
56
+ result: BreakPremiumCalcResult;
57
+ };
58
+ /** E-04's ``result``. */
59
+ type BreakPremiumCalcResult = {
60
+ workweek_id: string;
61
+ work_date: string;
62
+ meal_premium_owed: boolean;
63
+ rest_premium_owed: boolean;
64
+ lines?: BreakPremiumLine[];
65
+ money_withheld?: boolean;
66
+ };
67
+ /** A statutory meal or rest premium. */
68
+ type BreakPremiumLine = {
69
+ earning_code: "MEAL_PREMIUM" | "REST_PREMIUM";
70
+ hours?: string;
71
+ rate?: string | null;
72
+ amount?: string | null;
73
+ money_withheld?: boolean;
74
+ work_date: string;
75
+ attendance_exception_id?: string | null;
76
+ source_punch_ids?: string[];
77
+ };
78
+ /** A human-renderable reason something is missing, clamped or unverified. */
79
+ type CalcFlag = {
80
+ code: string;
81
+ class: string;
82
+ rule_id?: string | null;
83
+ jurisdiction_key?: string | null;
84
+ key?: string | null;
85
+ message: string;
86
+ };
87
+ /** The one request shape every ``/hr/calc/*`` endpoint shares. */
88
+ type CalcRequest = {
89
+ /** Organization context for the request; omitted to use the authenticated context. */
90
+ organization_id?: string | null;
91
+ /** Optional associated project selected by the caller. */
92
+ project_id?: string | null;
93
+ /** Optional associated task selected by the caller. */
94
+ task_id?: string | null;
95
+ /** Stable application slug that initiated the request. */
96
+ source_app?: string | null;
97
+ /** Stable feature slug within the source application. */
98
+ source_feature?: string | null;
99
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
100
+ initiation?: ("user" | "auto") | null;
101
+ subject: SubjectRef;
102
+ /** The EVENT date. Passing today's date for a past fact is a defect. */
103
+ as_of: string;
104
+ mode?: "authoritative" | "prospective";
105
+ parameters?: {
106
+ [key: string]: JsonValue;
107
+ };
108
+ recalculation_batch_id?: string | null;
109
+ /** Prospective mode ONLY, and only for a record that does not yet exist. Jurisdiction is otherwise READ from the stamped record. */
110
+ jurisdiction_key?: string | null;
111
+ };
112
+ /** One cap and what was left of it. ``remaining`` is ``None`` when the cap is not set. */
113
+ type CapDetail = {
114
+ cap?: string | null;
115
+ remaining?: string | null;
116
+ applied?: boolean;
117
+ };
118
+ /** E-06's 200. */
119
+ type CarryoverCalcResponse = {
120
+ /** ALWAYS present. Computing a consequential result without a snapshot is a defect. */
121
+ snapshot_id: string;
122
+ prospective: boolean;
123
+ as_of: string;
124
+ jurisdiction_key: string;
125
+ engine: EngineRef;
126
+ rules_applied?: RuleApplied[];
127
+ flags?: CalcFlag[];
128
+ incomplete?: IncompleteFact[];
129
+ clamps?: Clamp[];
130
+ written?: WrittenRefs;
131
+ result: CarryoverResult;
132
+ };
133
+ /** E-06's ``result`` — one enrollment's policy-year boundary. */
134
+ type CarryoverResult = {
135
+ employment_id: string;
136
+ leave_policy_id: string;
137
+ leave_enrollment_id: string;
138
+ policy_name: string;
139
+ policy_version: number;
140
+ eligible: boolean;
141
+ skip_reason?: string | null;
142
+ skip_detail?: string | null;
143
+ plan_year_end: string;
144
+ balance_at_boundary?: string | null;
145
+ carried_hours?: string | null;
146
+ forfeited_hours?: string | null;
147
+ carryover_hours_delta?: string;
148
+ forfeiture_withheld_as_unlawful?: boolean;
149
+ expiry_withheld_as_unlawful?: boolean;
150
+ carryover_expires_on?: string | null;
151
+ expiry_warning_days_not_yet_wired?: number[];
152
+ jurisdictions_considered?: string[];
153
+ jurisdictions_forbidding_forfeiture?: string[];
154
+ carryover_entry_id?: string | null;
155
+ forfeiture_entry_id?: string | null;
156
+ balance_after?: string | null;
157
+ occurred_on?: string | null;
158
+ period_key?: string | null;
159
+ idempotent_noop?: boolean;
160
+ compliance_exception_id?: string | null;
161
+ };
162
+ /** E-14's body. ``plan_year_end`` is the closing year's LAST DAY, not the new year's first. */
163
+ type CarryoverRunRequest = {
164
+ /** Organization context for the request; omitted to use the authenticated context. */
165
+ organization_id?: string | null;
166
+ /** Optional associated project selected by the caller. */
167
+ project_id?: string | null;
168
+ /** Optional associated task selected by the caller. */
169
+ task_id?: string | null;
170
+ /** Stable application slug that initiated the request. */
171
+ source_app?: string | null;
172
+ /** Stable feature slug within the source application. */
173
+ source_feature?: string | null;
174
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
175
+ initiation?: ("user" | "auto") | null;
176
+ plan_year_end: string;
177
+ scope: AccrualScopeOrg | AccrualScopePolicy | AccrualScopeEmployment;
178
+ mode?: "authoritative" | "prospective";
179
+ };
180
+ /** A statutory floor that overrode an organization's configured parameter. */
181
+ type Clamp = {
182
+ class: string;
183
+ from: string;
184
+ to: string;
185
+ reason: string;
186
+ };
187
+ /** EarningCodeTotal */
188
+ type EarningCodeTotal = {
189
+ earning_code: string;
190
+ hours: string;
191
+ amount?: string | null;
192
+ };
193
+ /** Which engine produced a figure, and at what deployed revision. */
194
+ type EngineRef = {
195
+ key: string;
196
+ /** Deployed git SHA of the engine that computed this. */
197
+ version: string;
198
+ };
199
+ /** E-12 — the elapsed-time detector lane. */
200
+ type ExceptionScanRequest = {
201
+ /** Organization context for the request; omitted to use the authenticated context. */
202
+ organization_id?: string | null;
203
+ /** Optional associated project selected by the caller. */
204
+ project_id?: string | null;
205
+ /** Optional associated task selected by the caller. */
206
+ task_id?: string | null;
207
+ /** Stable application slug that initiated the request. */
208
+ source_app?: string | null;
209
+ /** Stable feature slug within the source application. */
210
+ source_feature?: string | null;
211
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
212
+ initiation?: ("user" | "auto") | null;
213
+ location_ids?: string[] | null;
214
+ from: string;
215
+ to: string;
216
+ dry_run?: boolean;
217
+ };
218
+ /** ExportAcknowledgeBody */
219
+ type ExportAcknowledgeBody = {
220
+ /** Organization context for the request; omitted to use the authenticated context. */
221
+ organization_id?: string | null;
222
+ /** Optional associated project selected by the caller. */
223
+ project_id?: string | null;
224
+ /** Optional associated task selected by the caller. */
225
+ task_id?: string | null;
226
+ /** Stable application slug that initiated the request. */
227
+ source_app?: string | null;
228
+ /** Stable feature slug within the source application. */
229
+ source_feature?: string | null;
230
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
231
+ initiation?: ("user" | "auto") | null;
232
+ /** The receiving system's own reference. Opaque to us; we never parse it. */
233
+ acknowledgement_ref: string;
234
+ acknowledged_at?: string | null;
235
+ };
236
+ /** ExportAcknowledgeResponse */
237
+ type ExportAcknowledgeResponse = {
238
+ export_id: string;
239
+ delivery_state: "generated" | "sent" | "acknowledged" | "failed" | "superseded";
240
+ acknowledged_at: string;
241
+ };
242
+ /** E-23. **The reference envelope, never bytes and never a signed URL.** */
243
+ type ExportArtifactEnvelope = {
244
+ file_id: string;
245
+ sha256: string;
246
+ download_url: string;
247
+ };
248
+ /** ExportDelivery */
249
+ type ExportDelivery = {
250
+ mode?: "file" | "api";
251
+ /** Required when mode='api'; names the live provider binding to push through. */
252
+ binding_id?: string | null;
253
+ };
254
+ /** ExportFailBody */
255
+ type ExportFailBody = {
256
+ /** Organization context for the request; omitted to use the authenticated context. */
257
+ organization_id?: string | null;
258
+ /** Optional associated project selected by the caller. */
259
+ project_id?: string | null;
260
+ /** Optional associated task selected by the caller. */
261
+ task_id?: string | null;
262
+ /** Stable application slug that initiated the request. */
263
+ source_app?: string | null;
264
+ /** Stable feature slug within the source application. */
265
+ source_feature?: string | null;
266
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
267
+ initiation?: ("user" | "auto") | null;
268
+ /** Failure is recorded, not swallowed (§4.5). */
269
+ failure_reason: string;
270
+ };
271
+ /** ExportFailResponse */
272
+ type ExportFailResponse = {
273
+ export_id: string;
274
+ delivery_state: "generated" | "sent" | "acknowledged" | "failed" | "superseded";
275
+ failure_reason: string;
276
+ };
277
+ /** ExportFormatColumn */
278
+ type ExportFormatColumn = {
279
+ name: string;
280
+ source: string;
281
+ required: boolean;
282
+ };
283
+ /** One registry row. ``available`` is the D22 half: a format can be registered and refuse. */
284
+ type ExportFormatEntry = {
285
+ key: "quickbooks_online" | "quickbooks_iif" | "gusto_csv" | "adp_csv" | "generic_csv" | "json";
286
+ label: string;
287
+ /** `api` appears only where a LIVE provider binding exists for this format, so the shape does not change when a binding appears (§4.3). */
288
+ delivery: ("file" | "api")[];
289
+ media_type: string;
290
+ columns?: ExportFormatColumn[];
291
+ /** Identifiers this format needs mapped to the destination's own before an export can generate. Unmapped ⇒ 400 with details.unmapped[], never a file with blanks. */
292
+ requires_mapping?: string[];
293
+ supports_rates: boolean;
294
+ supports_adjustment_lines: boolean;
295
+ /** False = registered with its reason in `notes`, and generation refuses. */
296
+ available: boolean;
297
+ notes?: string | null;
298
+ };
299
+ /** ExportFormatsResponse */
300
+ type ExportFormatsResponse = {
301
+ formats: ExportFormatEntry[];
302
+ };
303
+ /** E-26. 🚨 **An ``acknowledged`` export can never be superseded, regenerated, or re-sent.** */
304
+ type ExportSupersedeBody = {
305
+ /** Organization context for the request; omitted to use the authenticated context. */
306
+ organization_id?: string | null;
307
+ /** Optional associated project selected by the caller. */
308
+ project_id?: string | null;
309
+ /** Optional associated task selected by the caller. */
310
+ task_id?: string | null;
311
+ /** Stable application slug that initiated the request. */
312
+ source_app?: string | null;
313
+ /** Stable feature slug within the source application. */
314
+ source_feature?: string | null;
315
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
316
+ initiation?: ("user" | "auto") | null;
317
+ reason: string;
318
+ };
319
+ /** A required applicability fact the resolver did not have. */
320
+ type IncompleteFact = {
321
+ class: string;
322
+ fact: string;
323
+ };
324
+ /** E-05's 200. ``snapshot_id`` is always present — computing without freezing is a defect. */
325
+ type LeaveAccrualCalcResponse = {
326
+ /** ALWAYS present. Computing a consequential result without a snapshot is a defect. */
327
+ snapshot_id: string;
328
+ prospective: boolean;
329
+ as_of: string;
330
+ jurisdiction_key: string;
331
+ engine: EngineRef;
332
+ rules_applied?: RuleApplied[];
333
+ flags?: CalcFlag[];
334
+ incomplete?: IncompleteFact[];
335
+ clamps?: Clamp[];
336
+ written?: WrittenRefs;
337
+ result: LeaveAccrualResult;
338
+ };
339
+ /** E-05's ``result`` — one enrollment's accrual through a date, with every intermediate. */
340
+ type LeaveAccrualResult = {
341
+ employment_id: string;
342
+ leave_policy_id: string;
343
+ leave_enrollment_id: string;
344
+ policy_name: string;
345
+ accrual_method: string;
346
+ policy_version: number;
347
+ eligible: boolean;
348
+ skip_reason?: string | null;
349
+ skip_detail?: string | null;
350
+ worked_to_date?: string | null;
351
+ accrual_rate?: string | null;
352
+ accrual_per_units?: string | null;
353
+ earned_to_date?: string | null;
354
+ posted_to_date?: string | null;
355
+ toward_next_unit?: string | null;
356
+ over_accrued?: boolean;
357
+ raw_earned?: string | null;
358
+ statutory_clamp_applied?: boolean;
359
+ annual_cap?: CapDetail;
360
+ balance_cap?: CapDetail;
361
+ hours_posted?: string;
362
+ prior_balance?: string | null;
363
+ balance_after?: string | null;
364
+ occurred_on?: string | null;
365
+ period_key?: string | null;
366
+ entry_id?: string | null;
367
+ idempotent_noop?: boolean;
368
+ compliance_exception_id?: string | null;
369
+ };
370
+ /** E-03 response — the typed supersession of the stub's open ``result`` (FREEZE D-3). */
371
+ type OvertimeCalcResponse = {
372
+ /** ALWAYS present. Computing a consequential result without a snapshot is a defect. */
373
+ snapshot_id: string;
374
+ prospective: boolean;
375
+ as_of: string;
376
+ jurisdiction_key: string;
377
+ engine: EngineRef;
378
+ rules_applied?: RuleApplied[];
379
+ flags?: CalcFlag[];
380
+ incomplete?: IncompleteFact[];
381
+ clamps?: Clamp[];
382
+ written?: WrittenRefs;
383
+ result: OvertimeCalcResult;
384
+ };
385
+ /** E-03's ``result`` — the workweek is the OT unit, never the pay period (AR 1.5). */
386
+ type OvertimeCalcResult = {
387
+ workweek_id: string;
388
+ week_start_local_date: string;
389
+ hours_worked: string;
390
+ hours_regular: string;
391
+ hours_overtime: string;
392
+ hours_doubletime: string;
393
+ hours_of_service: string;
394
+ /** The FLSA multi-rate answer. Null when the week is single-rate, and ALSO null when money is withheld — read `money_withheld` on the lines, never the null itself. */
395
+ weighted_average_regular_rate?: string | null;
396
+ /** True when the week spans more than one position assignment or rate. The UI must then show a Multiple rates marker and never a single week rate. */
397
+ multi_rate?: boolean;
398
+ rate_components?: RateComponent[];
399
+ lines?: OvertimeLine[];
400
+ money_withheld?: boolean;
401
+ };
402
+ /** The daily axis. */
403
+ type OvertimeDaily = {
404
+ hours_today: string;
405
+ daily_ot_at_hours?: string | null;
406
+ daily_dt_at_hours?: string | null;
407
+ };
408
+ /** E-55 — one employment, cheap enough for a clock screen to call on every punch. */
409
+ type OvertimeEvaluateRequest = {
410
+ /** Organization context for the request; omitted to use the authenticated context. */
411
+ organization_id?: string | null;
412
+ /** Optional associated project selected by the caller. */
413
+ project_id?: string | null;
414
+ /** Optional associated task selected by the caller. */
415
+ task_id?: string | null;
416
+ /** Stable application slug that initiated the request. */
417
+ source_app?: string | null;
418
+ /** Stable feature slug within the source application. */
419
+ source_feature?: string | null;
420
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
421
+ initiation?: ("user" | "auto") | null;
422
+ employment_id: string;
423
+ /** The evaluation instant. The workweek is DERIVED from it, never passed. */
424
+ as_of: string;
425
+ include_scheduled?: boolean;
426
+ };
427
+ /** E-55's response. */
428
+ type OvertimeEvaluateResponse = {
429
+ workweek_id: string;
430
+ week_start_local_date: string;
431
+ hours_worked_to_date: string;
432
+ hours_scheduled_remaining: string;
433
+ projected_week_hours: string;
434
+ thresholds?: OvertimeThreshold[];
435
+ daily: OvertimeDaily;
436
+ preapproval: OvertimePreapprovalState;
437
+ grace_minutes: number;
438
+ snapshot_id: string;
439
+ prospective?: true;
440
+ flags?: CalcFlag[];
441
+ incomplete?: IncompleteFact[];
442
+ };
443
+ /** One earning-code line the OT engine produced. */
444
+ type OvertimeLine = {
445
+ earning_code: string;
446
+ hours: string;
447
+ rate?: string | null;
448
+ amount?: string | null;
449
+ money_withheld?: boolean;
450
+ is_overtime?: boolean;
451
+ work_date: string;
452
+ work_interval_ids?: string[];
453
+ };
454
+ /** The pre-approval position for this employment and week. */
455
+ type OvertimePreapprovalState = {
456
+ required: boolean;
457
+ state: "none" | "requested" | "approved" | "denied" | "exceeded_without_approval";
458
+ workflow_instance_id?: string | null;
459
+ approved_hours?: string | null;
460
+ overtime_preapproval_id?: string | null;
461
+ };
462
+ /** E-56 — the async sweep behind the real-time alerts. */
463
+ type OvertimeScanRequest = {
464
+ /** Organization context for the request; omitted to use the authenticated context. */
465
+ organization_id?: string | null;
466
+ /** Optional associated project selected by the caller. */
467
+ project_id?: string | null;
468
+ /** Optional associated task selected by the caller. */
469
+ task_id?: string | null;
470
+ /** Stable application slug that initiated the request. */
471
+ source_app?: string | null;
472
+ /** Stable feature slug within the source application. */
473
+ source_feature?: string | null;
474
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
475
+ initiation?: ("user" | "auto") | null;
476
+ location_ids?: string[] | null;
477
+ thresholds?: string[] | null;
478
+ dry_run?: boolean;
479
+ };
480
+ /** OvertimeThreshold */
481
+ type OvertimeThreshold = {
482
+ /** e.g. `approaching`, `at_overtime`, `at_doubletime`, `seventh_day`. */
483
+ key: string;
484
+ at_hours: string;
485
+ crossed: boolean;
486
+ crosses_at?: string | null;
487
+ };
488
+ /** E-20. */
489
+ type PayrollExportBody = {
490
+ /** Organization context for the request; omitted to use the authenticated context. */
491
+ organization_id?: string | null;
492
+ /** Optional associated project selected by the caller. */
493
+ project_id?: string | null;
494
+ /** Optional associated task selected by the caller. */
495
+ task_id?: string | null;
496
+ /** Stable application slug that initiated the request. */
497
+ source_app?: string | null;
498
+ /** Stable feature slug within the source application. */
499
+ source_feature?: string | null;
500
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
501
+ initiation?: ("user" | "auto") | null;
502
+ pay_period_id: string;
503
+ export_format: "quickbooks_online" | "quickbooks_iif" | "gusto_csv" | "adp_csv" | "generic_csv" | "json";
504
+ /** The DOMAIN key — unique (organization_id, idempotency_key) on hr.payroll_export. §1.4: where the domain already owns the key, the domain wins; it is checked FIRST, before the platform claim matters. */
505
+ idempotency_key: string;
506
+ include_adjustments?: boolean;
507
+ includes_pii?: boolean;
508
+ delivery?: ExportDelivery;
509
+ };
510
+ /** E-19. Same inputs as E-20 and **creates no row** — looking is not an act with a record. */
511
+ type PayrollExportPreviewBody = {
512
+ /** Organization context for the request; omitted to use the authenticated context. */
513
+ organization_id?: string | null;
514
+ /** Optional associated project selected by the caller. */
515
+ project_id?: string | null;
516
+ /** Optional associated task selected by the caller. */
517
+ task_id?: string | null;
518
+ /** Stable application slug that initiated the request. */
519
+ source_app?: string | null;
520
+ /** Stable feature slug within the source application. */
521
+ source_feature?: string | null;
522
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
523
+ initiation?: ("user" | "auto") | null;
524
+ pay_period_id: string;
525
+ export_format: "quickbooks_online" | "quickbooks_iif" | "gusto_csv" | "adp_csv" | "generic_csv" | "json";
526
+ include_adjustments?: boolean;
527
+ /** §4.6 — SSN appears in no export except one explicitly flagged. True additionally requires the payroll.export_pii capability on top of payroll.export. */
528
+ includes_pii?: boolean;
529
+ };
530
+ /** E-19's answer: what a payroll administrator looks at before committing. */
531
+ type PayrollExportPreviewResponse = {
532
+ line_count: number;
533
+ total_hours: string;
534
+ total_amount?: string | null;
535
+ by_earning_code: EarningCodeTotal[];
536
+ employments_included: number;
537
+ warnings: string[];
538
+ blocking: string[];
539
+ };
540
+ /** E-22. */
541
+ type PayrollExportView = {
542
+ export_id: string;
543
+ export_version: number;
544
+ export_format: "quickbooks_online" | "quickbooks_iif" | "gusto_csv" | "adp_csv" | "generic_csv" | "json";
545
+ delivery_state: "generated" | "sent" | "acknowledged" | "failed" | "superseded";
546
+ line_count: number;
547
+ total_hours?: string | null;
548
+ total_amount?: string | null;
549
+ artifact_file_id?: string | null;
550
+ artifact_sha256?: string | null;
551
+ supersedes_export_id?: string | null;
552
+ acknowledgement_ref?: string | null;
553
+ failure_reason?: string | null;
554
+ };
555
+ /** E-27's projection. No secret material, by construction. */
556
+ type ProviderBindingView = {
557
+ binding_id: string;
558
+ organization_id?: string | null;
559
+ seam: "background_check" | "esign" | "payroll" | "benefits" | "everify";
560
+ provider_key: string;
561
+ display_name: string;
562
+ connector_kind: "rest" | "mcp" | "file" | "manual";
563
+ is_active: boolean;
564
+ capabilities: string[];
565
+ bound_at?: string | null;
566
+ };
567
+ /** ProviderBindingsResponse */
568
+ type ProviderBindingsResponse = {
569
+ bindings: ProviderBindingView[];
570
+ };
571
+ /** E-28 — the edge out. */
572
+ type ProviderDispatchBody = {
573
+ /** Organization context for the request; omitted to use the authenticated context. */
574
+ organization_id?: string | null;
575
+ /** Optional associated project selected by the caller. */
576
+ project_id?: string | null;
577
+ /** Optional associated task selected by the caller. */
578
+ task_id?: string | null;
579
+ /** Stable application slug that initiated the request. */
580
+ source_app?: string | null;
581
+ /** Stable feature slug within the source application. */
582
+ source_feature?: string | null;
583
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
584
+ initiation?: ("user" | "auto") | null;
585
+ seam: "background_check" | "esign" | "payroll" | "benefits" | "everify";
586
+ subject: SubjectRefBody;
587
+ /** null = resolve the org's active binding for this seam. */
588
+ provider_key?: string | null;
589
+ /** Seam-typed; the adapter maps it to the provider's wire format. What we KEEP is a summary — never this payload, which carries PII our tables must not duplicate. */
590
+ payload?: {
591
+ [key: string]: JsonValue;
592
+ };
593
+ };
594
+ /** E-29 — the org-recorded path, and D12's actual first shipping mode. */
595
+ type ProviderResultsBody = {
596
+ /** Organization context for the request; omitted to use the authenticated context. */
597
+ organization_id?: string | null;
598
+ /** Optional associated project selected by the caller. */
599
+ project_id?: string | null;
600
+ /** Optional associated task selected by the caller. */
601
+ task_id?: string | null;
602
+ /** Stable application slug that initiated the request. */
603
+ source_app?: string | null;
604
+ /** Stable feature slug within the source application. */
605
+ source_feature?: string | null;
606
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
607
+ initiation?: ("user" | "auto") | null;
608
+ seam: "background_check" | "esign" | "payroll" | "benefits" | "everify";
609
+ subject: SubjectRefBody;
610
+ external_status: string;
611
+ external_ref?: string | null;
612
+ result_summary: "clear" | "consider" | "ineligible" | "incomplete";
613
+ artifact_file_id?: string | null;
614
+ occurred_at: string;
615
+ };
616
+ /** ProviderResultsResponse */
617
+ type ProviderResultsResponse = {
618
+ recorded: boolean;
619
+ /** §3.6 invariant 1 — the provider's status MAPPED into our state machine. */
620
+ our_state: string;
621
+ /** Mirrored verbatim; never adopted as our state. */
622
+ external_status: string;
623
+ };
624
+ /** E-30 — poll. The MCP lane's only result path, since an MCP server has no webhook. */
625
+ type ProviderSyncBody = {
626
+ /** Organization context for the request; omitted to use the authenticated context. */
627
+ organization_id?: string | null;
628
+ /** Optional associated project selected by the caller. */
629
+ project_id?: string | null;
630
+ /** Optional associated task selected by the caller. */
631
+ task_id?: string | null;
632
+ /** Stable application slug that initiated the request. */
633
+ source_app?: string | null;
634
+ /** Stable feature slug within the source application. */
635
+ source_feature?: string | null;
636
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
637
+ initiation?: ("user" | "auto") | null;
638
+ seam: "background_check" | "esign" | "payroll" | "benefits" | "everify";
639
+ binding_id?: string | null;
640
+ subject_ids?: string[] | null;
641
+ };
642
+ /** E-31's body. ``200`` on a mapped event, ``202`` on one we recognize and do not consume. */
643
+ type ProviderWebhookAck = {
644
+ [key: string]: never;
645
+ };
646
+ /** One (rate, hours) pair behind a weighted-average regular rate. */
647
+ type RateComponent = {
648
+ position_assignment_id?: string | null;
649
+ position_title?: string | null;
650
+ rate: string;
651
+ hours: string;
652
+ product: string;
653
+ };
654
+ /** E-11 — the persisting engine run. */
655
+ type RecomputeRequest = {
656
+ /** Organization context for the request; omitted to use the authenticated context. */
657
+ organization_id?: string | null;
658
+ /** Optional associated project selected by the caller. */
659
+ project_id?: string | null;
660
+ /** Optional associated task selected by the caller. */
661
+ task_id?: string | null;
662
+ /** Stable application slug that initiated the request. */
663
+ source_app?: string | null;
664
+ /** Stable feature slug within the source application. */
665
+ source_feature?: string | null;
666
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
667
+ initiation?: ("user" | "auto") | null;
668
+ scope: RecomputeScopePayPeriod | RecomputeScopeEmploymentRange | RecomputeScopeWorkweek;
669
+ reason: string;
670
+ recalculation_batch_id?: string | null;
671
+ };
672
+ /** RecomputeScopeEmploymentRange */
673
+ type RecomputeScopeEmploymentRange = {
674
+ kind: "employment_range";
675
+ employment_ids: string[];
676
+ from: string;
677
+ to: string;
678
+ };
679
+ /** RecomputeScopePayPeriod */
680
+ type RecomputeScopePayPeriod = {
681
+ kind: "pay_period";
682
+ pay_period_id: string;
683
+ };
684
+ /** RecomputeScopeWorkweek */
685
+ type RecomputeScopeWorkweek = {
686
+ kind: "workweek";
687
+ workweek_ids: string[];
688
+ };
689
+ /** One jurisdiction rule that contributed to a result. */
690
+ type RuleApplied = {
691
+ class: string;
692
+ rule_id: string;
693
+ rule_version: number;
694
+ jurisdiction_key: string;
695
+ status: "active" | "advisory" | "draft";
696
+ };
697
+ /** Body of the hash-only sibling: fingerprint an identifier, store nothing. */
698
+ type SsnFingerprintRequest = {
699
+ /** §1.2 — must equal the X-Organization-Id header; a disagreement is 409. */
700
+ organization_id: string;
701
+ /** Optional associated project selected by the caller. */
702
+ project_id?: string | null;
703
+ /** Optional associated task selected by the caller. */
704
+ task_id?: string | null;
705
+ /** Stable application slug that initiated the request. */
706
+ source_app?: string | null;
707
+ /** Stable feature slug within the source application. */
708
+ source_feature?: string | null;
709
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
710
+ initiation?: ("user" | "auto") | null;
711
+ /** The candidate's identifier, sent once over TLS. Hashed and discarded — nothing is stored, nothing is echoed, and the value reaches no log and no audit row. */
712
+ ssn: string;
713
+ };
714
+ /** The digest, and nothing else. */
715
+ type SsnFingerprintResponse = {
716
+ /** Hex HMAC-SHA256 digest; pass verbatim as hr_duplicate_scan's ssn_hmac_hex. */
717
+ ssn_hmac_hex: string;
718
+ /** The hr.access_audit row recording the probe act. */
719
+ audit_id: string;
720
+ };
721
+ /** Body of the ONE confidential read that is server-side (SPEC-ACCESS §4.5). */
722
+ type SsnRevealRequest = {
723
+ /** §1.2 — must equal the X-Organization-Id header; a disagreement is 409. */
724
+ organization_id: string;
725
+ /** Optional associated project selected by the caller. */
726
+ project_id?: string | null;
727
+ /** Optional associated task selected by the caller. */
728
+ task_id?: string | null;
729
+ /** Stable application slug that initiated the request. */
730
+ source_app?: string | null;
731
+ /** Stable feature slug within the source application. */
732
+ source_feature?: string | null;
733
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
734
+ initiation?: ("user" | "auto") | null;
735
+ /** Why this reveal is happening; lands in the audit row. */
736
+ purpose: string;
737
+ /** Free-text justification; audited verbatim. Minimum length is a knob. */
738
+ justification: string;
739
+ };
740
+ /** The value, once. Served with ``Cache-Control: no-store`` and never logged. */
741
+ type SsnRevealResponse = {
742
+ ssn: string;
743
+ revealed_at: string;
744
+ /** The hr.access_audit row hr.reveal_ssn already wrote. */
745
+ audit_id: string;
746
+ };
747
+ /** Body of the intake act (SPEC-ACCESS §4.5, SPEC-EMPLOYEES §2.3). */
748
+ type SsnStoreRequest = {
749
+ /** §1.2 — must equal the X-Organization-Id header; a disagreement is 409. */
750
+ organization_id: string;
751
+ /** Optional associated project selected by the caller. */
752
+ project_id?: string | null;
753
+ /** Optional associated task selected by the caller. */
754
+ task_id?: string | null;
755
+ /** Stable application slug that initiated the request. */
756
+ source_app?: string | null;
757
+ /** Stable feature slug within the source application. */
758
+ source_feature?: string | null;
759
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
760
+ initiation?: ("user" | "auto") | null;
761
+ /** The identifier, sent once over TLS. Nine digits; hyphens and spaces are accepted and ignored. Never stored in plaintext, never logged, never echoed. */
762
+ ssn: string;
763
+ };
764
+ /** The acknowledgement. Carries **last four digits only** — never the value. */
765
+ type SsnStoreResponse = {
766
+ employee_private_id: string;
767
+ /** The four-digit hint the profile panel renders. */
768
+ ssn_last4: string;
769
+ /** True when this was the first collection; false when it replaced one. */
770
+ created: boolean;
771
+ stored_at: string;
772
+ /** The hr.access_audit row the door wrote for THIS submit. */
773
+ audit_id: string;
774
+ };
775
+ /** The entity token + id a calculation is *about*. */
776
+ type SubjectRef = {
777
+ /** Entity token, e.g. `hr_workweek`. Never `hr_employee`. */
778
+ type: string;
779
+ id: string;
780
+ };
781
+ /** §3.1 — a subject is never ``hr_employee``. */
782
+ type SubjectRefBody = {
783
+ type: string;
784
+ id: string;
785
+ };
786
+ /** E-21. Writes ``hr.access_audit action='export'`` and creates **no** ``hr.payroll_export`` */
787
+ type TimesheetExportBody = {
788
+ /** Organization context for the request; omitted to use the authenticated context. */
789
+ organization_id?: string | null;
790
+ /** Optional associated project selected by the caller. */
791
+ project_id?: string | null;
792
+ /** Optional associated task selected by the caller. */
793
+ task_id?: string | null;
794
+ /** Stable application slug that initiated the request. */
795
+ source_app?: string | null;
796
+ /** Stable feature slug within the source application. */
797
+ source_feature?: string | null;
798
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
799
+ initiation?: ("user" | "auto") | null;
800
+ pay_period_id?: string | null;
801
+ employment_ids?: string[] | null;
802
+ from?: string | null;
803
+ to?: string | null;
804
+ format: "pdf" | "csv";
805
+ };
806
+ /** Body of the letter-generation act (SPEC-EMPLOYEES §4.9). */
807
+ type VerificationLetterGenerateRequest = {
808
+ /** §1.2 — must equal the X-Organization-Id header; a disagreement is 409. */
809
+ organization_id: string;
810
+ /** Optional associated project selected by the caller. */
811
+ project_id?: string | null;
812
+ /** Optional associated task selected by the caller. */
813
+ task_id?: string | null;
814
+ /** Stable application slug that initiated the request. */
815
+ source_app?: string | null;
816
+ /** Stable feature slug within the source application. */
817
+ source_feature?: string | null;
818
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
819
+ initiation?: ("user" | "auto") | null;
820
+ /** Assert pay in the letter. Requires recorded employee consent. */
821
+ includes_compensation?: boolean;
822
+ /** Who the letter is addressed to; frozen into the snapshot verbatim. */
823
+ recipient?: string | null;
824
+ };
825
+ /** What was asserted, and the artifact that asserts it. */
826
+ type VerificationLetterGenerateResponse = {
827
+ letter_id: string;
828
+ artifact_file_id: string;
829
+ snapshot: {
830
+ [key: string]: JsonValue;
831
+ };
832
+ issued_at: string;
833
+ };
834
+ /** What a calculation actually persisted. */
835
+ type WrittenRefs = {
836
+ work_interval_ids?: string[];
837
+ workweek_id?: string | null;
838
+ leave_ledger_ids?: string[];
839
+ };
840
+ /** The 202 body. Not a new envelope — the runtime spine's existing surfaces, named. */
841
+ type aidream__services__hr__exports__models__AsyncAccepted = {
842
+ request_id: string;
843
+ execution_id: string;
844
+ status?: "queued";
845
+ poll: string;
846
+ events: string;
847
+ submitted_at: string;
848
+ };
849
+ /** The 202 body for every async HR endpoint. */
850
+ type aidream__services__hr__time__models__AsyncAccepted = {
851
+ request_id: string;
852
+ execution_id: string;
853
+ status?: "queued";
854
+ poll: string;
855
+ events: string;
856
+ submitted_at: string;
857
+ };
858
+ type HrIdentitySsnRevealArgs = {
859
+ path: {
860
+ identity_id: string;
861
+ };
862
+ body: SsnRevealRequest;
863
+ };
864
+ type HrIdentitySsnRevealResult = SsnRevealResponse;
865
+ /** Reveal a stored SSN once, audited */
866
+ /** `POST /hr/identity/{identity_id}/ssn/reveal` · aidream · auth user · org required */
867
+ declare function hrIdentitySsnReveal(api: Api, args: HrIdentitySsnRevealArgs, options?: CallOptions): Promise<HrIdentitySsnRevealResult>;
868
+ type HrIdentitySsnStoreArgs = {
869
+ path: {
870
+ identity_id: string;
871
+ };
872
+ body: SsnStoreRequest;
873
+ };
874
+ type HrIdentitySsnStoreResult = SsnStoreResponse;
875
+ /** Record a person's SSN, sealed server-side, audited */
876
+ /** `POST /hr/identity/{identity_id}/ssn` · aidream · auth user · org required */
877
+ declare function hrIdentitySsnStore(api: Api, args: HrIdentitySsnStoreArgs, options?: CallOptions): Promise<HrIdentitySsnStoreResult>;
878
+ type HrIdentitySsnFingerprintArgs = {
879
+ body: SsnFingerprintRequest;
880
+ };
881
+ type HrIdentitySsnFingerprintResult = SsnFingerprintResponse;
882
+ /** Keyed digest of an identifier for the pre-hire duplicate scan */
883
+ /** `POST /hr/identity/ssn/fingerprint` · aidream · auth user · org required */
884
+ declare function hrIdentitySsnFingerprint(api: Api, args: HrIdentitySsnFingerprintArgs, options?: CallOptions): Promise<HrIdentitySsnFingerprintResult>;
885
+ type HrVerificationLettersGenerateArgs = {
886
+ path: {
887
+ letter_id: string;
888
+ };
889
+ body: VerificationLetterGenerateRequest;
890
+ };
891
+ type HrVerificationLettersGenerateResult = VerificationLetterGenerateResponse;
892
+ /** Render an employment-verification letter and freeze its assertion */
893
+ /** `POST /hr/verification-letters/{letter_id}/generate` · aidream · auth user · org required */
894
+ declare function hrVerificationLettersGenerate(api: Api, args: HrVerificationLettersGenerateArgs, options?: CallOptions): Promise<HrVerificationLettersGenerateResult>;
895
+ type HrExportsFormatsListArgs = {
896
+ [key: string]: never;
897
+ };
898
+ type HrExportsFormatsListResult = ExportFormatsResponse;
899
+ /** The payroll export format registry */
900
+ /** `GET /hr/exports/formats` · aidream · auth user · org required */
901
+ declare function hrExportsFormatsList(api: Api, args?: HrExportsFormatsListArgs, options?: CallOptions): Promise<HrExportsFormatsListResult>;
902
+ type HrExportsPayrollPreviewArgs = {
903
+ body: PayrollExportPreviewBody;
904
+ };
905
+ type HrExportsPayrollPreviewResult = PayrollExportPreviewResponse;
906
+ /** Dry-run a payroll export without creating a record */
907
+ /** `POST /hr/exports/payroll/preview` · aidream · auth user · org required */
908
+ declare function hrExportsPayrollPreview(api: Api, args: HrExportsPayrollPreviewArgs, options?: CallOptions): Promise<HrExportsPayrollPreviewResult>;
909
+ type HrExportsPayrollCreateArgs = {
910
+ body: PayrollExportBody;
911
+ };
912
+ type HrExportsPayrollCreateResult = aidream__services__hr__exports__models__AsyncAccepted;
913
+ /** Generate a payroll export */
914
+ /** `POST /hr/exports/payroll` · aidream · auth user · org required */
915
+ declare function hrExportsPayrollCreate(api: Api, args: HrExportsPayrollCreateArgs, options?: CallOptions): Promise<HrExportsPayrollCreateResult>;
916
+ type HrExportsTimesheetCreateArgs = {
917
+ body: TimesheetExportBody;
918
+ };
919
+ type HrExportsTimesheetCreateResult = aidream__services__hr__exports__models__AsyncAccepted;
920
+ /** Render a timesheet report */
921
+ /** `POST /hr/exports/timesheet` · aidream · auth user · org required */
922
+ declare function hrExportsTimesheetCreate(api: Api, args: HrExportsTimesheetCreateArgs, options?: CallOptions): Promise<HrExportsTimesheetCreateResult>;
923
+ type HrExportsGetArgs = {
924
+ path: {
925
+ export_id: string;
926
+ };
927
+ };
928
+ type HrExportsGetResult = PayrollExportView;
929
+ /** Read one export's state */
930
+ /** `GET /hr/exports/{export_id}` · aidream · auth user · org required */
931
+ declare function hrExportsGet(api: Api, args: HrExportsGetArgs, options?: CallOptions): Promise<HrExportsGetResult>;
932
+ type HrExportsArtifactGetArgs = {
933
+ path: {
934
+ export_id: string;
935
+ };
936
+ };
937
+ type HrExportsArtifactGetResult = ExportArtifactEnvelope;
938
+ /** The artifact reference envelope */
939
+ /** `GET /hr/exports/{export_id}/artifact` · aidream · auth user · org required */
940
+ declare function hrExportsArtifactGet(api: Api, args: HrExportsArtifactGetArgs, options?: CallOptions): Promise<HrExportsArtifactGetResult>;
941
+ type HrExportsAcknowledgeArgs = {
942
+ path: {
943
+ export_id: string;
944
+ };
945
+ body: ExportAcknowledgeBody;
946
+ };
947
+ type HrExportsAcknowledgeResult = ExportAcknowledgeResponse;
948
+ /** Record that the receiving system confirmed this export */
949
+ /** `POST /hr/exports/{export_id}/acknowledge` · aidream · auth user · org required */
950
+ declare function hrExportsAcknowledge(api: Api, args: HrExportsAcknowledgeArgs, options?: CallOptions): Promise<HrExportsAcknowledgeResult>;
951
+ type HrExportsFailArgs = {
952
+ path: {
953
+ export_id: string;
954
+ };
955
+ body: ExportFailBody;
956
+ };
957
+ type HrExportsFailResult = ExportFailResponse;
958
+ /** Record that this export failed downstream */
959
+ /** `POST /hr/exports/{export_id}/fail` · aidream · auth user · org required */
960
+ declare function hrExportsFail(api: Api, args: HrExportsFailArgs, options?: CallOptions): Promise<HrExportsFailResult>;
961
+ type HrExportsSupersedeArgs = {
962
+ path: {
963
+ export_id: string;
964
+ };
965
+ body: ExportSupersedeBody;
966
+ };
967
+ type HrExportsSupersedeResult = aidream__services__hr__exports__models__AsyncAccepted;
968
+ /** Replace a generated or failed export with a new version */
969
+ /** `POST /hr/exports/{export_id}/supersede` · aidream · auth user · org required */
970
+ declare function hrExportsSupersede(api: Api, args: HrExportsSupersedeArgs, options?: CallOptions): Promise<HrExportsSupersedeResult>;
971
+ type HrProvidersBindingsListArgs = {
972
+ path: {
973
+ seam: string;
974
+ };
975
+ };
976
+ type HrProvidersBindingsListResult = ProviderBindingsResponse;
977
+ /** List an organization's provider bindings for one seam */
978
+ /** `GET /hr/providers/{seam}/bindings` · aidream · auth user · org required */
979
+ declare function hrProvidersBindingsList(api: Api, args: HrProvidersBindingsListArgs, options?: CallOptions): Promise<HrProvidersBindingsListResult>;
980
+ type HrProvidersDispatchArgs = {
981
+ path: {
982
+ seam: string;
983
+ };
984
+ body: ProviderDispatchBody;
985
+ };
986
+ type HrProvidersDispatchResult = aidream__services__hr__exports__models__AsyncAccepted;
987
+ /** Dispatch one subject across a provider seam */
988
+ /** `POST /hr/providers/{seam}/dispatch` · aidream · auth user · org required */
989
+ declare function hrProvidersDispatch(api: Api, args: HrProvidersDispatchArgs, options?: CallOptions): Promise<HrProvidersDispatchResult>;
990
+ type HrProvidersResultsRecordArgs = {
991
+ path: {
992
+ seam: string;
993
+ };
994
+ body: ProviderResultsBody;
995
+ };
996
+ type HrProvidersResultsRecordResult = ProviderResultsResponse;
997
+ /** Record a provider result the organization obtained itself */
998
+ /** `POST /hr/providers/{seam}/results` · aidream · auth user · org required */
999
+ declare function hrProvidersResultsRecord(api: Api, args: HrProvidersResultsRecordArgs, options?: CallOptions): Promise<HrProvidersResultsRecordResult>;
1000
+ type HrProvidersSyncArgs = {
1001
+ path: {
1002
+ seam: string;
1003
+ };
1004
+ body: ProviderSyncBody;
1005
+ };
1006
+ type HrProvidersSyncResult = aidream__services__hr__exports__models__AsyncAccepted;
1007
+ /** Poll a provider seam for outstanding results */
1008
+ /** `POST /hr/providers/{seam}/sync` · aidream · auth user · org required */
1009
+ declare function hrProvidersSync(api: Api, args: HrProvidersSyncArgs, options?: CallOptions): Promise<HrProvidersSyncResult>;
1010
+ type HrHooksProviderWebhookArgs = {
1011
+ path: {
1012
+ seam: string;
1013
+ provider_key: string;
1014
+ };
1015
+ };
1016
+ type HrHooksProviderWebhookResult = ProviderWebhookAck;
1017
+ /** Inbound provider webhook (HMAC-signed, no bearer) */
1018
+ /** `POST /hooks/providers/{seam}/{provider_key}` · aidream · auth scoped · org required */
1019
+ declare function hrHooksProviderWebhook(api: Api, args: HrHooksProviderWebhookArgs, options?: CallOptions): Promise<HrHooksProviderWebhookResult>;
1020
+ type HrCalcOvertimeArgs = {
1021
+ body: CalcRequest;
1022
+ };
1023
+ type HrCalcOvertimeResult = OvertimeCalcResponse;
1024
+ /** Overtime for one workweek */
1025
+ /** `POST /hr/calc/overtime` · aidream · auth user · org required */
1026
+ declare function hrCalcOvertime(api: Api, args: HrCalcOvertimeArgs, options?: CallOptions): Promise<HrCalcOvertimeResult>;
1027
+ type HrCalcBreakPremiumArgs = {
1028
+ body: CalcRequest;
1029
+ };
1030
+ type HrCalcBreakPremiumResult = BreakPremiumCalcResponse;
1031
+ /** Meal/rest premiums for one work date */
1032
+ /** `POST /hr/calc/break-premium` · aidream · auth user · org required */
1033
+ declare function hrCalcBreakPremium(api: Api, args: HrCalcBreakPremiumArgs, options?: CallOptions): Promise<HrCalcBreakPremiumResult>;
1034
+ type HrTimeOvertimeEvaluateArgs = {
1035
+ body: OvertimeEvaluateRequest;
1036
+ };
1037
+ type HrTimeOvertimeEvaluateResult = OvertimeEvaluateResponse;
1038
+ /** Approaching-OT evaluator for one employment */
1039
+ /** `POST /hr/time/overtime/evaluate` · aidream · auth user · org required */
1040
+ declare function hrTimeOvertimeEvaluate(api: Api, args: HrTimeOvertimeEvaluateArgs, options?: CallOptions): Promise<HrTimeOvertimeEvaluateResult>;
1041
+ type HrTimeRecomputeArgs = {
1042
+ body: RecomputeRequest;
1043
+ };
1044
+ type HrTimeRecomputeResult = aidream__services__hr__time__models__AsyncAccepted;
1045
+ /** Pair punches, round, write intervals, roll up workweeks, evaluate rules */
1046
+ /** `POST /hr/time/recompute` · aidream · auth user · org required */
1047
+ declare function hrTimeRecompute(api: Api, args: HrTimeRecomputeArgs, options?: CallOptions): Promise<HrTimeRecomputeResult>;
1048
+ type HrTimeExceptionsScanArgs = {
1049
+ body: ExceptionScanRequest;
1050
+ };
1051
+ type HrTimeExceptionsScanResult = aidream__services__hr__time__models__AsyncAccepted;
1052
+ /** Elapsed-time attendance-exception detectors over a window */
1053
+ /** `POST /hr/time/exceptions/scan` · aidream · auth user · org required */
1054
+ declare function hrTimeExceptionsScan(api: Api, args: HrTimeExceptionsScanArgs, options?: CallOptions): Promise<HrTimeExceptionsScanResult>;
1055
+ type HrTimeOvertimeScanArgs = {
1056
+ body: OvertimeScanRequest;
1057
+ };
1058
+ type HrTimeOvertimeScanResult = aidream__services__hr__time__models__AsyncAccepted;
1059
+ /** The async sweep behind the real-time approaching-OT alerts */
1060
+ /** `POST /hr/time/overtime/scan` · aidream · auth user · org required */
1061
+ declare function hrTimeOvertimeScan(api: Api, args: HrTimeOvertimeScanArgs, options?: CallOptions): Promise<HrTimeOvertimeScanResult>;
1062
+ type HrCalcLeaveAccrualArgs = {
1063
+ body: CalcRequest;
1064
+ };
1065
+ type HrCalcLeaveAccrualResult = LeaveAccrualCalcResponse;
1066
+ /** Accrual for one enrollment through a date */
1067
+ /** `POST /hr/calc/leave-accrual` · aidream · auth user · org required */
1068
+ declare function hrCalcLeaveAccrual(api: Api, args: HrCalcLeaveAccrualArgs, options?: CallOptions): Promise<HrCalcLeaveAccrualResult>;
1069
+ type HrCalcCarryoverArgs = {
1070
+ body: CalcRequest;
1071
+ };
1072
+ type HrCalcCarryoverResult = CarryoverCalcResponse;
1073
+ /** Plan-year carryover */
1074
+ /** `POST /hr/calc/carryover` · aidream · auth user · org required */
1075
+ declare function hrCalcCarryover(api: Api, args: HrCalcCarryoverArgs, options?: CallOptions): Promise<HrCalcCarryoverResult>;
1076
+ type HrAccrualsRunArgs = {
1077
+ body: AccrualRunRequest;
1078
+ };
1079
+ type HrAccrualsRunResult = aidream__services__hr__time__models__AsyncAccepted;
1080
+ /** Accrual run */
1081
+ /** `POST /hr/accruals/run` · aidream · auth user · org required */
1082
+ declare function hrAccrualsRun(api: Api, args: HrAccrualsRunArgs, options?: CallOptions): Promise<HrAccrualsRunResult>;
1083
+ type HrAccrualsCarryoverRunArgs = {
1084
+ body: CarryoverRunRequest;
1085
+ };
1086
+ type HrAccrualsCarryoverRunResult = aidream__services__hr__time__models__AsyncAccepted;
1087
+ /** Plan-year carryover run */
1088
+ /** `POST /hr/accruals/carryover/run` · aidream · auth user · org required */
1089
+ declare function hrAccrualsCarryoverRun(api: Api, args: HrAccrualsCarryoverRunArgs, options?: CallOptions): Promise<HrAccrualsCarryoverRunResult>;
1090
+ /** Every JSON operation of this domain by `METHOD path` — for path-keyed calls. */
1091
+ interface Operations {
1092
+ "POST /hr/identity/{identity_id}/ssn/reveal": {
1093
+ args: HrIdentitySsnRevealArgs;
1094
+ result: HrIdentitySsnRevealResult;
1095
+ };
1096
+ "POST /hr/identity/{identity_id}/ssn": {
1097
+ args: HrIdentitySsnStoreArgs;
1098
+ result: HrIdentitySsnStoreResult;
1099
+ };
1100
+ "POST /hr/identity/ssn/fingerprint": {
1101
+ args: HrIdentitySsnFingerprintArgs;
1102
+ result: HrIdentitySsnFingerprintResult;
1103
+ };
1104
+ "POST /hr/verification-letters/{letter_id}/generate": {
1105
+ args: HrVerificationLettersGenerateArgs;
1106
+ result: HrVerificationLettersGenerateResult;
1107
+ };
1108
+ "GET /hr/exports/formats": {
1109
+ args: HrExportsFormatsListArgs;
1110
+ result: HrExportsFormatsListResult;
1111
+ };
1112
+ "POST /hr/exports/payroll/preview": {
1113
+ args: HrExportsPayrollPreviewArgs;
1114
+ result: HrExportsPayrollPreviewResult;
1115
+ };
1116
+ "POST /hr/exports/payroll": {
1117
+ args: HrExportsPayrollCreateArgs;
1118
+ result: HrExportsPayrollCreateResult;
1119
+ };
1120
+ "POST /hr/exports/timesheet": {
1121
+ args: HrExportsTimesheetCreateArgs;
1122
+ result: HrExportsTimesheetCreateResult;
1123
+ };
1124
+ "GET /hr/exports/{export_id}": {
1125
+ args: HrExportsGetArgs;
1126
+ result: HrExportsGetResult;
1127
+ };
1128
+ "GET /hr/exports/{export_id}/artifact": {
1129
+ args: HrExportsArtifactGetArgs;
1130
+ result: HrExportsArtifactGetResult;
1131
+ };
1132
+ "POST /hr/exports/{export_id}/acknowledge": {
1133
+ args: HrExportsAcknowledgeArgs;
1134
+ result: HrExportsAcknowledgeResult;
1135
+ };
1136
+ "POST /hr/exports/{export_id}/fail": {
1137
+ args: HrExportsFailArgs;
1138
+ result: HrExportsFailResult;
1139
+ };
1140
+ "POST /hr/exports/{export_id}/supersede": {
1141
+ args: HrExportsSupersedeArgs;
1142
+ result: HrExportsSupersedeResult;
1143
+ };
1144
+ "GET /hr/providers/{seam}/bindings": {
1145
+ args: HrProvidersBindingsListArgs;
1146
+ result: HrProvidersBindingsListResult;
1147
+ };
1148
+ "POST /hr/providers/{seam}/dispatch": {
1149
+ args: HrProvidersDispatchArgs;
1150
+ result: HrProvidersDispatchResult;
1151
+ };
1152
+ "POST /hr/providers/{seam}/results": {
1153
+ args: HrProvidersResultsRecordArgs;
1154
+ result: HrProvidersResultsRecordResult;
1155
+ };
1156
+ "POST /hr/providers/{seam}/sync": {
1157
+ args: HrProvidersSyncArgs;
1158
+ result: HrProvidersSyncResult;
1159
+ };
1160
+ "POST /hooks/providers/{seam}/{provider_key}": {
1161
+ args: HrHooksProviderWebhookArgs;
1162
+ result: HrHooksProviderWebhookResult;
1163
+ };
1164
+ "POST /hr/calc/overtime": {
1165
+ args: HrCalcOvertimeArgs;
1166
+ result: HrCalcOvertimeResult;
1167
+ };
1168
+ "POST /hr/calc/break-premium": {
1169
+ args: HrCalcBreakPremiumArgs;
1170
+ result: HrCalcBreakPremiumResult;
1171
+ };
1172
+ "POST /hr/time/overtime/evaluate": {
1173
+ args: HrTimeOvertimeEvaluateArgs;
1174
+ result: HrTimeOvertimeEvaluateResult;
1175
+ };
1176
+ "POST /hr/time/recompute": {
1177
+ args: HrTimeRecomputeArgs;
1178
+ result: HrTimeRecomputeResult;
1179
+ };
1180
+ "POST /hr/time/exceptions/scan": {
1181
+ args: HrTimeExceptionsScanArgs;
1182
+ result: HrTimeExceptionsScanResult;
1183
+ };
1184
+ "POST /hr/time/overtime/scan": {
1185
+ args: HrTimeOvertimeScanArgs;
1186
+ result: HrTimeOvertimeScanResult;
1187
+ };
1188
+ "POST /hr/calc/leave-accrual": {
1189
+ args: HrCalcLeaveAccrualArgs;
1190
+ result: HrCalcLeaveAccrualResult;
1191
+ };
1192
+ "POST /hr/calc/carryover": {
1193
+ args: HrCalcCarryoverArgs;
1194
+ result: HrCalcCarryoverResult;
1195
+ };
1196
+ "POST /hr/accruals/run": {
1197
+ args: HrAccrualsRunArgs;
1198
+ result: HrAccrualsRunResult;
1199
+ };
1200
+ "POST /hr/accruals/carryover/run": {
1201
+ args: HrAccrualsCarryoverRunArgs;
1202
+ result: HrAccrualsCarryoverRunResult;
1203
+ };
1204
+ }
1205
+ /** Path-keyed call, scoped to this domain only (never a global path map). */
1206
+ declare function call<K extends keyof Operations>(api: Api, key: K, args?: Operations[K]["args"], options?: CallOptions): Promise<Operations[K]["result"]>;
1207
+
1208
+ export { type AccrualRunRequest, type AccrualScopeEmployment, type AccrualScopeOrg, type AccrualScopePolicy, type BreakPremiumCalcResponse, type BreakPremiumCalcResult, type BreakPremiumLine, type CalcFlag, type CalcRequest, type CapDetail, type CarryoverCalcResponse, type CarryoverResult, type CarryoverRunRequest, type Clamp, type EarningCodeTotal, type EngineRef, type ExceptionScanRequest, type ExportAcknowledgeBody, type ExportAcknowledgeResponse, type ExportArtifactEnvelope, type ExportDelivery, type ExportFailBody, type ExportFailResponse, type ExportFormatColumn, type ExportFormatEntry, type ExportFormatsResponse, type ExportSupersedeBody, type HrAccrualsCarryoverRunArgs, type HrAccrualsCarryoverRunResult, type HrAccrualsRunArgs, type HrAccrualsRunResult, type HrCalcBreakPremiumArgs, type HrCalcBreakPremiumResult, type HrCalcCarryoverArgs, type HrCalcCarryoverResult, type HrCalcLeaveAccrualArgs, type HrCalcLeaveAccrualResult, type HrCalcOvertimeArgs, type HrCalcOvertimeResult, type HrExportsAcknowledgeArgs, type HrExportsAcknowledgeResult, type HrExportsArtifactGetArgs, type HrExportsArtifactGetResult, type HrExportsFailArgs, type HrExportsFailResult, type HrExportsFormatsListArgs, type HrExportsFormatsListResult, type HrExportsGetArgs, type HrExportsGetResult, type HrExportsPayrollCreateArgs, type HrExportsPayrollCreateResult, type HrExportsPayrollPreviewArgs, type HrExportsPayrollPreviewResult, type HrExportsSupersedeArgs, type HrExportsSupersedeResult, type HrExportsTimesheetCreateArgs, type HrExportsTimesheetCreateResult, type HrHooksProviderWebhookArgs, type HrHooksProviderWebhookResult, type HrIdentitySsnFingerprintArgs, type HrIdentitySsnFingerprintResult, type HrIdentitySsnRevealArgs, type HrIdentitySsnRevealResult, type HrIdentitySsnStoreArgs, type HrIdentitySsnStoreResult, type HrProvidersBindingsListArgs, type HrProvidersBindingsListResult, type HrProvidersDispatchArgs, type HrProvidersDispatchResult, type HrProvidersResultsRecordArgs, type HrProvidersResultsRecordResult, type HrProvidersSyncArgs, type HrProvidersSyncResult, type HrTimeExceptionsScanArgs, type HrTimeExceptionsScanResult, type HrTimeOvertimeEvaluateArgs, type HrTimeOvertimeEvaluateResult, type HrTimeOvertimeScanArgs, type HrTimeOvertimeScanResult, type HrTimeRecomputeArgs, type HrTimeRecomputeResult, type HrVerificationLettersGenerateArgs, type HrVerificationLettersGenerateResult, type IncompleteFact, type LeaveAccrualCalcResponse, type LeaveAccrualResult, type Operations, type OvertimeCalcResponse, type OvertimeCalcResult, type OvertimeDaily, type OvertimeEvaluateRequest, type OvertimeEvaluateResponse, type OvertimeLine, type OvertimePreapprovalState, type OvertimeScanRequest, type OvertimeThreshold, type PayrollExportBody, type PayrollExportPreviewBody, type PayrollExportPreviewResponse, type PayrollExportView, type ProviderBindingView, type ProviderBindingsResponse, type ProviderDispatchBody, type ProviderResultsBody, type ProviderResultsResponse, type ProviderSyncBody, type ProviderWebhookAck, type RateComponent, type RecomputeRequest, type RecomputeScopeEmploymentRange, type RecomputeScopePayPeriod, type RecomputeScopeWorkweek, type RuleApplied, type SsnFingerprintRequest, type SsnFingerprintResponse, type SsnRevealRequest, type SsnRevealResponse, type SsnStoreRequest, type SsnStoreResponse, type SubjectRef, type SubjectRefBody, type TimesheetExportBody, type VerificationLetterGenerateRequest, type VerificationLetterGenerateResponse, type WrittenRefs, type aidream__services__hr__exports__models__AsyncAccepted, type aidream__services__hr__time__models__AsyncAccepted, call, hrAccrualsCarryoverRun, hrAccrualsRun, hrCalcBreakPremium, hrCalcCarryover, hrCalcLeaveAccrual, hrCalcOvertime, hrExportsAcknowledge, hrExportsArtifactGet, hrExportsFail, hrExportsFormatsList, hrExportsGet, hrExportsPayrollCreate, hrExportsPayrollPreview, hrExportsSupersede, hrExportsTimesheetCreate, hrHooksProviderWebhook, hrIdentitySsnFingerprint, hrIdentitySsnReveal, hrIdentitySsnStore, hrProvidersBindingsList, hrProvidersDispatch, hrProvidersResultsRecord, hrProvidersSync, hrTimeExceptionsScan, hrTimeOvertimeEvaluate, hrTimeOvertimeScan, hrTimeRecompute, hrVerificationLettersGenerate };