@robosystems/client 1.6.1 → 1.8.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.
package/sdk/types.gen.ts CHANGED
@@ -848,12 +848,6 @@ export type BackupListResponse = {
848
848
  * Whether this is a shared repository (limits apply)
849
849
  */
850
850
  is_shared_repository?: boolean;
851
- /**
852
- * Restore Supported
853
- *
854
- * Whether backups on this graph can be restored. False for entity graphs, which are materialized from the extensions database (use the materialize operation instead), and for shared repositories, which are platform-managed and download-only. True for subgraphs of an entity graph: only the parent is materialized, so a subgraph has no other recovery path.
855
- */
856
- restore_supported?: boolean;
857
851
  /**
858
852
  * Download quota for shared repositories
859
853
  */
@@ -882,6 +876,18 @@ export type BackupResponse = {
882
876
  * Backup Type
883
877
  */
884
878
  backup_type: string;
879
+ /**
880
+ * Initiated By
881
+ *
882
+ * Who started this backup. 'user' is one you requested and it counts against the tier's daily backup limit; 'scheduled' is taken nightly on your behalf and does not.
883
+ */
884
+ initiated_by?: string;
885
+ /**
886
+ * Memory Included
887
+ *
888
+ * Whether the archive carries this graph's semantic memory store. Null for backups taken before memory was included, which make no claim either way — distinct from false, which means the graph had none.
889
+ */
890
+ memory_included?: boolean | null;
885
891
  /**
886
892
  * Status
887
893
  */
@@ -1146,6 +1152,100 @@ export type BindTextBlockResponse = {
1146
1152
  replaced: boolean;
1147
1153
  };
1148
1154
 
1155
+ /**
1156
+ * BlockSourceGraphOperation
1157
+ *
1158
+ * Bar a graph from sharing reports into this one.
1159
+ */
1160
+ export type BlockSourceGraphOperation = {
1161
+ /**
1162
+ * Source Graph Id
1163
+ *
1164
+ * Graph ID to block. Read it off the `source_graph_id` provenance field of a report that was shared to you.
1165
+ */
1166
+ source_graph_id: string;
1167
+ /**
1168
+ * Reason
1169
+ *
1170
+ * Free-form note for your own records. Never disclosed to the sender.
1171
+ */
1172
+ reason?: string | null;
1173
+ /**
1174
+ * Purge
1175
+ *
1176
+ * Also delete every report already shared in from this source, with their fact sets and facts. Reports you authored are never touched.
1177
+ */
1178
+ purge?: boolean;
1179
+ };
1180
+
1181
+ /**
1182
+ * BlockSourceGraphResult
1183
+ *
1184
+ * Outcome of a block, including anything the purge removed.
1185
+ */
1186
+ export type BlockSourceGraphResult = {
1187
+ /**
1188
+ * The block record.
1189
+ */
1190
+ block: BlockedSourceGraphResponse;
1191
+ /**
1192
+ * Already Blocked
1193
+ *
1194
+ * True when the source was already blocked and this call was a no-op apart from any purge.
1195
+ */
1196
+ already_blocked?: boolean;
1197
+ /**
1198
+ * Purged Report Count
1199
+ *
1200
+ * Number of previously-shared reports deleted from this graph. Zero unless `purge` was set.
1201
+ */
1202
+ purged_report_count?: number;
1203
+ };
1204
+
1205
+ /**
1206
+ * BlockedSourceGraphResponse
1207
+ *
1208
+ * One blocked source graph.
1209
+ */
1210
+ export type BlockedSourceGraphResponse = {
1211
+ /**
1212
+ * Id
1213
+ *
1214
+ * Block row identifier (ULID).
1215
+ */
1216
+ id: string;
1217
+ /**
1218
+ * Source Graph Id
1219
+ *
1220
+ * The blocked sender's graph ID.
1221
+ */
1222
+ source_graph_id: string;
1223
+ /**
1224
+ * Source Graph Name
1225
+ *
1226
+ * Display name of the blocked graph (if known).
1227
+ */
1228
+ source_graph_name?: string | null;
1229
+ /**
1230
+ * Blocked By
1231
+ *
1232
+ * User ID that created the block.
1233
+ */
1234
+ blocked_by: string;
1235
+ /**
1236
+ * Blocked At
1237
+ *
1238
+ * When the block was created.
1239
+ */
1240
+ blocked_at: string;
1241
+ /**
1242
+ * Reason
1243
+ *
1244
+ * Recipient's own note, if given.
1245
+ */
1246
+ reason?: string | null;
1247
+ };
1248
+
1149
1249
  /**
1150
1250
  * CancelSubscriptionRequest
1151
1251
  *
@@ -1650,6 +1750,12 @@ export type ComputeForecastResponse = {
1650
1750
  * Months Computed
1651
1751
  */
1652
1752
  months_computed?: Array<ForecastMonthLite>;
1753
+ /**
1754
+ * Halted At
1755
+ *
1756
+ * Month (``YYYY-MM``) where the walk stopped because verification failed, or null if it ran the full horizon. Each month's opening balances are the previous month's closing balances, so computing past a failure yields months derived from a known-wrong one rather than merely unverified months. When set, ``months_computed`` ends at this month and is shorter than ``months``; the failing month's facts are kept so the failure can be inspected.
1757
+ */
1758
+ halted_at?: string | null;
1653
1759
  /**
1654
1760
  * Skipped
1655
1761
  */
@@ -5837,7 +5943,7 @@ export type ForecastMonthLite = {
5837
5943
  /**
5838
5944
  * Verification Passed
5839
5945
  *
5840
- * Whether every rule evaluated against the month's scenario sets passed (None = no rules ran for the month).
5946
+ * Whether every rule evaluated against the month's scenario sets passed. Three states, and the third is not the first: ``true`` = rules ran and all passed; ``false`` = at least one failed or errored, which halts the walk (see ``halted_at``); ``null`` = **no rules ran**, so the month is unverified rather than verified. Treat null as absence of evidence, never as a pass.
5841
5947
  */
5842
5948
  verification_passed?: boolean | null;
5843
5949
  /**
@@ -9149,6 +9255,98 @@ export type OperationEnvelopeBindTextBlockResponse = {
9149
9255
  idempotentReplay?: boolean;
9150
9256
  };
9151
9257
 
9258
+ /**
9259
+ * OperationEnvelope[BlockSourceGraphResult]
9260
+ */
9261
+ export type OperationEnvelopeBlockSourceGraphResult = {
9262
+ /**
9263
+ * Operation
9264
+ *
9265
+ * Kebab-case operation name
9266
+ */
9267
+ operation: string;
9268
+ /**
9269
+ * Operationid
9270
+ *
9271
+ * op_-prefixed ULID for audit and SSE correlation
9272
+ */
9273
+ operationId: string;
9274
+ /**
9275
+ * Status
9276
+ *
9277
+ * Operation lifecycle state
9278
+ */
9279
+ status: 'completed' | 'pending' | 'failed';
9280
+ /**
9281
+ * Command-specific result payload
9282
+ */
9283
+ result?: BlockSourceGraphResult | null;
9284
+ /**
9285
+ * At
9286
+ *
9287
+ * ISO-8601 UTC timestamp
9288
+ */
9289
+ at: string;
9290
+ /**
9291
+ * Createdby
9292
+ *
9293
+ * User ID that initiated the operation (null for legacy callers)
9294
+ */
9295
+ createdBy?: string | null;
9296
+ /**
9297
+ * Idempotentreplay
9298
+ *
9299
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9300
+ */
9301
+ idempotentReplay?: boolean;
9302
+ };
9303
+
9304
+ /**
9305
+ * OperationEnvelope[BlockedSourceGraphResponse]
9306
+ */
9307
+ export type OperationEnvelopeBlockedSourceGraphResponse = {
9308
+ /**
9309
+ * Operation
9310
+ *
9311
+ * Kebab-case operation name
9312
+ */
9313
+ operation: string;
9314
+ /**
9315
+ * Operationid
9316
+ *
9317
+ * op_-prefixed ULID for audit and SSE correlation
9318
+ */
9319
+ operationId: string;
9320
+ /**
9321
+ * Status
9322
+ *
9323
+ * Operation lifecycle state
9324
+ */
9325
+ status: 'completed' | 'pending' | 'failed';
9326
+ /**
9327
+ * Command-specific result payload
9328
+ */
9329
+ result?: BlockedSourceGraphResponse | null;
9330
+ /**
9331
+ * At
9332
+ *
9333
+ * ISO-8601 UTC timestamp
9334
+ */
9335
+ at: string;
9336
+ /**
9337
+ * Createdby
9338
+ *
9339
+ * User ID that initiated the operation (null for legacy callers)
9340
+ */
9341
+ createdBy?: string | null;
9342
+ /**
9343
+ * Idempotentreplay
9344
+ *
9345
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9346
+ */
9347
+ idempotentReplay?: boolean;
9348
+ };
9349
+
9152
9350
  /**
9153
9351
  * OperationEnvelope[ChangeReportingStyleResponse]
9154
9352
  */
@@ -10391,6 +10589,52 @@ export type OperationEnvelopeReportResponse = {
10391
10589
  idempotentReplay?: boolean;
10392
10590
  };
10393
10591
 
10592
+ /**
10593
+ * OperationEnvelope[RevokeReportShareResponse]
10594
+ */
10595
+ export type OperationEnvelopeRevokeReportShareResponse = {
10596
+ /**
10597
+ * Operation
10598
+ *
10599
+ * Kebab-case operation name
10600
+ */
10601
+ operation: string;
10602
+ /**
10603
+ * Operationid
10604
+ *
10605
+ * op_-prefixed ULID for audit and SSE correlation
10606
+ */
10607
+ operationId: string;
10608
+ /**
10609
+ * Status
10610
+ *
10611
+ * Operation lifecycle state
10612
+ */
10613
+ status: 'completed' | 'pending' | 'failed';
10614
+ /**
10615
+ * Command-specific result payload
10616
+ */
10617
+ result?: RevokeReportShareResponse | null;
10618
+ /**
10619
+ * At
10620
+ *
10621
+ * ISO-8601 UTC timestamp
10622
+ */
10623
+ at: string;
10624
+ /**
10625
+ * Createdby
10626
+ *
10627
+ * User ID that initiated the operation (null for legacy callers)
10628
+ */
10629
+ createdBy?: string | null;
10630
+ /**
10631
+ * Idempotentreplay
10632
+ *
10633
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
10634
+ */
10635
+ idempotentReplay?: boolean;
10636
+ };
10637
+
10394
10638
  /**
10395
10639
  * OperationEnvelope[ScheduleCreatedResponse]
10396
10640
  */
@@ -11223,34 +11467,18 @@ export type OrgUsageSummary = {
11223
11467
  * Total Storage Gb
11224
11468
  */
11225
11469
  total_storage_gb: number;
11226
- /**
11227
- * Total Api Calls
11228
- */
11229
- total_api_calls: number;
11230
11470
  /**
11231
11471
  * Daily Avg Credits
11232
11472
  */
11233
11473
  daily_avg_credits: number;
11234
- /**
11235
- * Daily Avg Api Calls
11236
- */
11237
- daily_avg_api_calls: number;
11238
11474
  /**
11239
11475
  * Projected Monthly Credits
11240
11476
  */
11241
11477
  projected_monthly_credits: number;
11242
- /**
11243
- * Projected Monthly Api Calls
11244
- */
11245
- projected_monthly_api_calls: number;
11246
11478
  /**
11247
11479
  * Credits Limit
11248
11480
  */
11249
11481
  credits_limit: number | null;
11250
- /**
11251
- * Api Calls Limit
11252
- */
11253
- api_calls_limit: number | null;
11254
11482
  /**
11255
11483
  * Storage Limit Gb
11256
11484
  */
@@ -12838,29 +13066,55 @@ export type ResolvedReportInfo = {
12838
13066
  export type ResponseMode = 'auto' | 'sync' | 'async' | 'stream';
12839
13067
 
12840
13068
  /**
12841
- * RestoreBackupOp
13069
+ * RevokeReportShareOperation
12842
13070
  *
12843
- * Body for the restore-backup operation.
13071
+ * Withdraw a shared Report from one recipient graph.
12844
13072
  */
12845
- export type RestoreBackupOp = {
13073
+ export type RevokeReportShareOperation = {
12846
13074
  /**
12847
- * Backup Id
13075
+ * Target Graph Id
12848
13076
  *
12849
- * Backup identifier to restore from
13077
+ * Recipient graph whose copy should be withdrawn.
12850
13078
  */
12851
- backup_id: string;
13079
+ target_graph_id: string;
12852
13080
  /**
12853
- * Create System Backup
13081
+ * Report Id
12854
13082
  *
12855
- * Create a system backup of existing database before restore
13083
+ * The Report whose share to withdraw.
12856
13084
  */
12857
- create_system_backup?: boolean;
13085
+ report_id: string;
13086
+ };
13087
+
13088
+ /**
13089
+ * RevokeReportShareResponse
13090
+ *
13091
+ * Outcome of withdrawing a shared report from one recipient.
13092
+ */
13093
+ export type RevokeReportShareResponse = {
12858
13094
  /**
12859
- * Verify After Restore
13095
+ * Report Id
12860
13096
  *
12861
- * Verify database integrity after restore
13097
+ * The report whose share was revoked.
12862
13098
  */
12863
- verify_after_restore?: boolean;
13099
+ report_id: string;
13100
+ /**
13101
+ * Target Graph Id
13102
+ *
13103
+ * Recipient the copy was pulled from.
13104
+ */
13105
+ target_graph_id: string;
13106
+ /**
13107
+ * Revoked At
13108
+ *
13109
+ * When the share was revoked.
13110
+ */
13111
+ revoked_at: string;
13112
+ /**
13113
+ * Copy Deleted
13114
+ *
13115
+ * True when a copy was found and deleted in the recipient's schema. False when the recipient had already deleted it themselves — the share is still marked revoked.
13116
+ */
13117
+ copy_deleted: boolean;
12864
13118
  };
12865
13119
 
12866
13120
  /**
@@ -15299,6 +15553,20 @@ export type TransitionFilingStatusRequest = {
15299
15553
  target_status: string;
15300
15554
  };
15301
15555
 
15556
+ /**
15557
+ * UnblockSourceGraphOperation
15558
+ *
15559
+ * Lift a block on a source graph.
15560
+ */
15561
+ export type UnblockSourceGraphOperation = {
15562
+ /**
15563
+ * Source Graph Id
15564
+ *
15565
+ * Graph ID to unblock.
15566
+ */
15567
+ source_graph_id: string;
15568
+ };
15569
+
15302
15570
  /**
15303
15571
  * UpcomingInvoice
15304
15572
  *
@@ -21826,70 +22094,6 @@ export type CreateBackupResponses = {
21826
22094
 
21827
22095
  export type CreateBackupResponse = CreateBackupResponses[keyof CreateBackupResponses];
21828
22096
 
21829
- export type RestoreBackupData = {
21830
- body: RestoreBackupOp;
21831
- headers?: {
21832
- /**
21833
- * Idempotency-Key
21834
- */
21835
- 'Idempotency-Key'?: string | null;
21836
- };
21837
- path: {
21838
- /**
21839
- * Graph Id
21840
- */
21841
- graph_id: string;
21842
- };
21843
- query?: never;
21844
- url: '/v1/graphs/{graph_id}/operations/restore-backup';
21845
- };
21846
-
21847
- export type RestoreBackupErrors = {
21848
- /**
21849
- * Invalid request
21850
- */
21851
- 400: ErrorResponse;
21852
- /**
21853
- * Authentication required
21854
- */
21855
- 401: ErrorResponse;
21856
- /**
21857
- * Access denied
21858
- */
21859
- 403: ErrorResponse;
21860
- /**
21861
- * Resource not found
21862
- */
21863
- 404: ErrorResponse;
21864
- /**
21865
- * Idempotency-Key conflict — key reused with different body
21866
- */
21867
- 409: ErrorResponse;
21868
- /**
21869
- * Validation error
21870
- */
21871
- 422: ErrorResponse;
21872
- /**
21873
- * Rate limit exceeded
21874
- */
21875
- 429: ErrorResponse;
21876
- /**
21877
- * Internal server error
21878
- */
21879
- 500: ErrorResponse;
21880
- };
21881
-
21882
- export type RestoreBackupError = RestoreBackupErrors[keyof RestoreBackupErrors];
21883
-
21884
- export type RestoreBackupResponses = {
21885
- /**
21886
- * Successful Response
21887
- */
21888
- 202: OperationEnvelope;
21889
- };
21890
-
21891
- export type RestoreBackupResponse = RestoreBackupResponses[keyof RestoreBackupResponses];
21892
-
21893
22097
  export type ChangeTierData = {
21894
22098
  body: ChangeTierOp;
21895
22099
  headers?: {
@@ -26313,6 +26517,70 @@ export type ShareReportResponses = {
26313
26517
 
26314
26518
  export type ShareReportResponse2 = ShareReportResponses[keyof ShareReportResponses];
26315
26519
 
26520
+ export type RevokeReportShareData = {
26521
+ body: RevokeReportShareOperation;
26522
+ headers?: {
26523
+ /**
26524
+ * Idempotency-Key
26525
+ */
26526
+ 'Idempotency-Key'?: string | null;
26527
+ };
26528
+ path: {
26529
+ /**
26530
+ * Graph Id
26531
+ */
26532
+ graph_id: string;
26533
+ };
26534
+ query?: never;
26535
+ url: '/extensions/roboledger/{graph_id}/operations/revoke-report-share';
26536
+ };
26537
+
26538
+ export type RevokeReportShareErrors = {
26539
+ /**
26540
+ * Invalid request
26541
+ */
26542
+ 400: ErrorResponse;
26543
+ /**
26544
+ * Authentication required
26545
+ */
26546
+ 401: ErrorResponse;
26547
+ /**
26548
+ * Access denied
26549
+ */
26550
+ 403: ErrorResponse;
26551
+ /**
26552
+ * Resource not found
26553
+ */
26554
+ 404: ErrorResponse;
26555
+ /**
26556
+ * Idempotency-Key conflict — key reused with different body
26557
+ */
26558
+ 409: ErrorResponse;
26559
+ /**
26560
+ * Validation error
26561
+ */
26562
+ 422: ErrorResponse;
26563
+ /**
26564
+ * Rate limit exceeded
26565
+ */
26566
+ 429: ErrorResponse;
26567
+ /**
26568
+ * Internal server error
26569
+ */
26570
+ 500: ErrorResponse;
26571
+ };
26572
+
26573
+ export type RevokeReportShareError = RevokeReportShareErrors[keyof RevokeReportShareErrors];
26574
+
26575
+ export type RevokeReportShareResponses = {
26576
+ /**
26577
+ * Successful Response
26578
+ */
26579
+ 200: OperationEnvelopeRevokeReportShareResponse;
26580
+ };
26581
+
26582
+ export type RevokeReportShareResponse2 = RevokeReportShareResponses[keyof RevokeReportShareResponses];
26583
+
26316
26584
  export type FileReportData = {
26317
26585
  body: FileReportRequest;
26318
26586
  headers?: {
@@ -26761,6 +27029,134 @@ export type RemovePublishListMemberResponses = {
26761
27029
 
26762
27030
  export type RemovePublishListMemberResponse = RemovePublishListMemberResponses[keyof RemovePublishListMemberResponses];
26763
27031
 
27032
+ export type BlockSourceGraphData = {
27033
+ body: BlockSourceGraphOperation;
27034
+ headers?: {
27035
+ /**
27036
+ * Idempotency-Key
27037
+ */
27038
+ 'Idempotency-Key'?: string | null;
27039
+ };
27040
+ path: {
27041
+ /**
27042
+ * Graph Id
27043
+ */
27044
+ graph_id: string;
27045
+ };
27046
+ query?: never;
27047
+ url: '/extensions/roboledger/{graph_id}/operations/block-source-graph';
27048
+ };
27049
+
27050
+ export type BlockSourceGraphErrors = {
27051
+ /**
27052
+ * Invalid request
27053
+ */
27054
+ 400: ErrorResponse;
27055
+ /**
27056
+ * Authentication required
27057
+ */
27058
+ 401: ErrorResponse;
27059
+ /**
27060
+ * Access denied
27061
+ */
27062
+ 403: ErrorResponse;
27063
+ /**
27064
+ * Resource not found
27065
+ */
27066
+ 404: ErrorResponse;
27067
+ /**
27068
+ * Idempotency-Key conflict — key reused with different body
27069
+ */
27070
+ 409: ErrorResponse;
27071
+ /**
27072
+ * Validation error
27073
+ */
27074
+ 422: ErrorResponse;
27075
+ /**
27076
+ * Rate limit exceeded
27077
+ */
27078
+ 429: ErrorResponse;
27079
+ /**
27080
+ * Internal server error
27081
+ */
27082
+ 500: ErrorResponse;
27083
+ };
27084
+
27085
+ export type BlockSourceGraphError = BlockSourceGraphErrors[keyof BlockSourceGraphErrors];
27086
+
27087
+ export type BlockSourceGraphResponses = {
27088
+ /**
27089
+ * Successful Response
27090
+ */
27091
+ 200: OperationEnvelopeBlockSourceGraphResult;
27092
+ };
27093
+
27094
+ export type BlockSourceGraphResponse = BlockSourceGraphResponses[keyof BlockSourceGraphResponses];
27095
+
27096
+ export type UnblockSourceGraphData = {
27097
+ body: UnblockSourceGraphOperation;
27098
+ headers?: {
27099
+ /**
27100
+ * Idempotency-Key
27101
+ */
27102
+ 'Idempotency-Key'?: string | null;
27103
+ };
27104
+ path: {
27105
+ /**
27106
+ * Graph Id
27107
+ */
27108
+ graph_id: string;
27109
+ };
27110
+ query?: never;
27111
+ url: '/extensions/roboledger/{graph_id}/operations/unblock-source-graph';
27112
+ };
27113
+
27114
+ export type UnblockSourceGraphErrors = {
27115
+ /**
27116
+ * Invalid request
27117
+ */
27118
+ 400: ErrorResponse;
27119
+ /**
27120
+ * Authentication required
27121
+ */
27122
+ 401: ErrorResponse;
27123
+ /**
27124
+ * Access denied
27125
+ */
27126
+ 403: ErrorResponse;
27127
+ /**
27128
+ * Resource not found
27129
+ */
27130
+ 404: ErrorResponse;
27131
+ /**
27132
+ * Idempotency-Key conflict — key reused with different body
27133
+ */
27134
+ 409: ErrorResponse;
27135
+ /**
27136
+ * Validation error
27137
+ */
27138
+ 422: ErrorResponse;
27139
+ /**
27140
+ * Rate limit exceeded
27141
+ */
27142
+ 429: ErrorResponse;
27143
+ /**
27144
+ * Internal server error
27145
+ */
27146
+ 500: ErrorResponse;
27147
+ };
27148
+
27149
+ export type UnblockSourceGraphError = UnblockSourceGraphErrors[keyof UnblockSourceGraphErrors];
27150
+
27151
+ export type UnblockSourceGraphResponses = {
27152
+ /**
27153
+ * Successful Response
27154
+ */
27155
+ 200: OperationEnvelopeBlockedSourceGraphResponse;
27156
+ };
27157
+
27158
+ export type UnblockSourceGraphResponse = UnblockSourceGraphResponses[keyof UnblockSourceGraphResponses];
27159
+
26764
27160
  export type LiveFinancialStatementData = {
26765
27161
  body: LiveFinancialStatementRequest;
26766
27162
  headers?: {