@robosystems/client 2.12.1 → 2.13.1

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.
package/types.gen.ts CHANGED
@@ -80,6 +80,168 @@ export type ApiKeysResponse = {
80
80
  api_keys: Array<ApiKeyInfo>;
81
81
  };
82
82
 
83
+ /**
84
+ * AcceptSuggestionLine
85
+ *
86
+ * What the batch did with one line.
87
+ */
88
+ export type AcceptSuggestionLine = {
89
+ /**
90
+ * Event Id
91
+ *
92
+ * The line.
93
+ */
94
+ event_id: string;
95
+ /**
96
+ * Outcome
97
+ *
98
+ * What happened to it.
99
+ */
100
+ outcome: 'classified' | 'committed' | 'skipped';
101
+ /**
102
+ * Reason
103
+ *
104
+ * Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
105
+ */
106
+ reason?: string | null;
107
+ /**
108
+ * Detail
109
+ *
110
+ * The refusal's own words, when there was one.
111
+ */
112
+ detail?: string | null;
113
+ /**
114
+ * Element Id
115
+ *
116
+ * The account the suggestion names.
117
+ */
118
+ element_id?: string | null;
119
+ /**
120
+ * Description
121
+ *
122
+ * The line's description.
123
+ */
124
+ description?: string | null;
125
+ };
126
+
127
+ /**
128
+ * AcceptSuggestionsRequest
129
+ *
130
+ * Take the suggestion on every open bank line the filters select.
131
+ */
132
+ export type AcceptSuggestionsRequest = {
133
+ /**
134
+ * Entity Id
135
+ *
136
+ * The entity whose inbox to act on. Omit for the group parent.
137
+ */
138
+ entity_id?: string | null;
139
+ /**
140
+ * Event Ids
141
+ *
142
+ * Explicit lines, as from the inbox's multi-select; each is answered, even one that cannot be taken. The other filters still narrow them.
143
+ */
144
+ event_ids?: Array<string> | null;
145
+ /**
146
+ * Source
147
+ *
148
+ * Only lines from this feed (`plaid`, `mercury`).
149
+ */
150
+ source?: string | null;
151
+ /**
152
+ * Agent Id
153
+ *
154
+ * Only one counterparty's lines.
155
+ */
156
+ agent_id?: string | null;
157
+ /**
158
+ * Suggestion Source
159
+ *
160
+ * Only lines whose suggestion came from here: `agent_default` (the counterparty's learned default), `tier0` (the bank's category) or `ai`.
161
+ */
162
+ suggestion_source?: string | null;
163
+ /**
164
+ * Occurred From
165
+ *
166
+ * Only lines dated on or after this day.
167
+ */
168
+ occurred_from?: string | null;
169
+ /**
170
+ * Occurred To
171
+ *
172
+ * Only lines dated on or before this day.
173
+ */
174
+ occurred_to?: string | null;
175
+ /**
176
+ * Commit
177
+ *
178
+ * Post each taken line as well (captured → committed). Off, the lines are classified and wait for a person to post them.
179
+ */
180
+ commit?: boolean;
181
+ /**
182
+ * Limit
183
+ *
184
+ * At most this many lines per call, oldest first; `truncated` in the response says whether more matched.
185
+ */
186
+ limit?: number;
187
+ /**
188
+ * Dry Run
189
+ *
190
+ * Report what each line would do without writing. A closed month is found only when a line actually posts, so a real run can still skip one a dry run counted.
191
+ */
192
+ dry_run?: boolean;
193
+ };
194
+
195
+ /**
196
+ * AcceptSuggestionsResponse
197
+ *
198
+ * The batch's counts, and every line it looked at.
199
+ */
200
+ export type AcceptSuggestionsResponse = {
201
+ /**
202
+ * Selected
203
+ *
204
+ * Lines the filters matched, before the limit.
205
+ */
206
+ selected: number;
207
+ /**
208
+ * Classified
209
+ *
210
+ * Lines classified to their suggestion and left to post.
211
+ */
212
+ classified: number;
213
+ /**
214
+ * Committed
215
+ *
216
+ * Lines classified to their suggestion and posted.
217
+ */
218
+ committed: number;
219
+ /**
220
+ * Skipped
221
+ *
222
+ * Lines not taken, each with a reason.
223
+ */
224
+ skipped: number;
225
+ /**
226
+ * Truncated
227
+ *
228
+ * More lines matched than the limit allowed in this call.
229
+ */
230
+ truncated: boolean;
231
+ /**
232
+ * Dry Run
233
+ *
234
+ * Nothing was written.
235
+ */
236
+ dry_run: boolean;
237
+ /**
238
+ * Lines
239
+ *
240
+ * Each line looked at, oldest first.
241
+ */
242
+ lines: Array<AcceptSuggestionLine>;
243
+ };
244
+
83
245
  /**
84
246
  * AccountInfo
85
247
  *
@@ -508,6 +670,18 @@ export type AssociationResponse = {
508
670
  * Approved By
509
671
  */
510
672
  approved_by?: string | null;
673
+ /**
674
+ * Replaced Association Id
675
+ *
676
+ * The arc this write removed in the same transaction, when the call named one in `replaces_association_id`.
677
+ */
678
+ replaced_association_id?: string | null;
679
+ /**
680
+ * Reclassified Periods
681
+ *
682
+ * Closed months whose live statements now read through this arc while their stamped sets keep the answer as closed. Empty unless the write replaced an arc on an account with landed history in a closed month.
683
+ */
684
+ reclassified_periods?: Array<string>;
511
685
  };
512
686
 
513
687
  /**
@@ -3296,6 +3470,18 @@ export type CreateMappingAssociationOperation = {
3296
3470
  * Target mapping structure ID.
3297
3471
  */
3298
3472
  mapping_id: string;
3473
+ /**
3474
+ * Replaces Association Id
3475
+ *
3476
+ * The account's current mapping arc in this structure, removed in the same write: a remap in one call. When the account has landed history in a closed month the move is judged as a reclassification: allowed when the new concept sits on the same primary statement as the old one (the stamped statements keep the answer as closed; live renders follow the new arc; `reclassified_periods` names the months), refused when it crosses one.
3477
+ */
3478
+ replaces_association_id?: string | null;
3479
+ /**
3480
+ * Reason
3481
+ *
3482
+ * Why the account is reclassified. Recorded on the new arc beside the months it reaches.
3483
+ */
3484
+ reason?: string | null;
3299
3485
  };
3300
3486
 
3301
3487
  /**
@@ -3537,7 +3723,7 @@ export type CreateScheduleRequest = {
3537
3723
  /**
3538
3724
  * Closed Through
3539
3725
  *
3540
- * Watermark for onboarding. Facts with period_end ≤ this date are flagged 'historical' and their schedule_entry_due obligations are emitted 'voided', so the close workflow starts drafting at the first open period. Set this to the last day of the fiscal calendar's closed_through month (calendar '2026-05' → '2026-05-31') whether those months were actually closed in RoboLedger or just baseline-watermarked at initialization. Omitting it (when prior periods exist) leaves pre-watermark periods as 'pending' obligations that block the first close.
3726
+ * Watermark for onboarding. Facts with period_end ≤ this date are flagged 'historical' and their schedule_entry_due obligations are emitted 'voided', so the close workflow starts drafting at the first open period. Defaults to the calendar's history end: the last day of its closed_through month (calendar '2026-05' → '2026-05-31'), or the day before its first month when nothing has closed yet. An earlier date is raised to it, since an obligation there could never post; set a later one only to treat more months as already booked.
3541
3727
  */
3542
3728
  closed_through?: string | null;
3543
3729
  /**
@@ -6285,6 +6471,12 @@ export type FactSetLite = {
6285
6471
  provenance?: {
6286
6472
  [key: string]: unknown;
6287
6473
  } | null;
6474
+ /**
6475
+ * Created At
6476
+ *
6477
+ * When the set was computed. For a close-stamped canonical set (`report_id` null, type `report`) this is the month as closed on this date: its facts keep that answer while a live render reads through the mapping arcs as they stand now.
6478
+ */
6479
+ created_at?: string | null;
6288
6480
  };
6289
6481
 
6290
6482
  /**
@@ -10739,6 +10931,52 @@ export type OperationEnvelope = {
10739
10931
  idempotentReplay?: boolean;
10740
10932
  };
10741
10933
 
10934
+ /**
10935
+ * OperationEnvelope[AcceptSuggestionsResponse]
10936
+ */
10937
+ export type OperationEnvelopeAcceptSuggestionsResponse = {
10938
+ /**
10939
+ * Operation
10940
+ *
10941
+ * Kebab-case operation name
10942
+ */
10943
+ operation: string;
10944
+ /**
10945
+ * Operationid
10946
+ *
10947
+ * op_-prefixed ULID for audit and SSE correlation
10948
+ */
10949
+ operationId: string;
10950
+ /**
10951
+ * Status
10952
+ *
10953
+ * Operation lifecycle state
10954
+ */
10955
+ status: 'completed' | 'pending' | 'failed';
10956
+ /**
10957
+ * Command-specific result payload
10958
+ */
10959
+ result?: AcceptSuggestionsResponse | null;
10960
+ /**
10961
+ * At
10962
+ *
10963
+ * ISO-8601 UTC timestamp
10964
+ */
10965
+ at: string;
10966
+ /**
10967
+ * Createdby
10968
+ *
10969
+ * User ID that initiated the operation
10970
+ */
10971
+ createdBy?: string | null;
10972
+ /**
10973
+ * Idempotentreplay
10974
+ *
10975
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
10976
+ */
10977
+ idempotentReplay?: boolean;
10978
+ };
10979
+
10742
10980
  /**
10743
10981
  * OperationEnvelope[AssertMetricsResponse]
10744
10982
  */
@@ -15263,8 +15501,9 @@ export type ReadTextResponse = {
15263
15501
  * monthly_amount / period bounds on the Structure's metadata).
15264
15502
  *
15265
15503
  * The historical-vs-in-scope split is re-derived from the CURRENT fiscal
15266
- * calendar `closed_through`, so a rebuild re-scopes the schedule to
15267
- * today's close state. Use this to pick up a fixed generator (e.g. the
15504
+ * calendar (months through its `closed_through`, or before its first
15505
+ * month, are history), so a rebuild re-scopes the schedule to today's
15506
+ * close state. Use this to pick up a fixed generator (e.g. the
15268
15507
  * roll-forward direction fix) without orphaning obligations.
15269
15508
  */
15270
15509
  export type RebuildScheduleRequest = {
@@ -30771,6 +31010,70 @@ export type LearnClassificationDefaultsResponses = {
30771
31010
 
30772
31011
  export type LearnClassificationDefaultsResponse2 = LearnClassificationDefaultsResponses[keyof LearnClassificationDefaultsResponses];
30773
31012
 
31013
+ export type AcceptSuggestionsData = {
31014
+ body: AcceptSuggestionsRequest;
31015
+ headers?: {
31016
+ /**
31017
+ * Idempotency-Key
31018
+ */
31019
+ 'Idempotency-Key'?: string | null;
31020
+ };
31021
+ path: {
31022
+ /**
31023
+ * Graph Id
31024
+ */
31025
+ graph_id: string;
31026
+ };
31027
+ query?: never;
31028
+ url: '/extensions/roboledger/{graph_id}/operations/accept-suggestions';
31029
+ };
31030
+
31031
+ export type AcceptSuggestionsErrors = {
31032
+ /**
31033
+ * Invalid request
31034
+ */
31035
+ 400: ErrorResponse;
31036
+ /**
31037
+ * Authentication required
31038
+ */
31039
+ 401: ErrorResponse;
31040
+ /**
31041
+ * Access denied
31042
+ */
31043
+ 403: ErrorResponse;
31044
+ /**
31045
+ * Resource not found
31046
+ */
31047
+ 404: ErrorResponse;
31048
+ /**
31049
+ * Idempotency-Key conflict — key reused with different body
31050
+ */
31051
+ 409: ErrorResponse;
31052
+ /**
31053
+ * Validation error
31054
+ */
31055
+ 422: ErrorResponse;
31056
+ /**
31057
+ * Rate limit exceeded
31058
+ */
31059
+ 429: ErrorResponse;
31060
+ /**
31061
+ * Internal server error
31062
+ */
31063
+ 500: ErrorResponse;
31064
+ };
31065
+
31066
+ export type AcceptSuggestionsError = AcceptSuggestionsErrors[keyof AcceptSuggestionsErrors];
31067
+
31068
+ export type AcceptSuggestionsResponses = {
31069
+ /**
31070
+ * Successful Response
31071
+ */
31072
+ 200: OperationEnvelopeAcceptSuggestionsResponse;
31073
+ };
31074
+
31075
+ export type AcceptSuggestionsResponse2 = AcceptSuggestionsResponses[keyof AcceptSuggestionsResponses];
31076
+
30774
31077
  export type CreateEventBlockData = {
30775
31078
  body: CreateEventBlockRequest;
30776
31079
  headers?: {