@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/types.gen.d.ts CHANGED
@@ -822,12 +822,6 @@ export type BackupListResponse = {
822
822
  * Whether this is a shared repository (limits apply)
823
823
  */
824
824
  is_shared_repository?: boolean;
825
- /**
826
- * Restore Supported
827
- *
828
- * 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.
829
- */
830
- restore_supported?: boolean;
831
825
  /**
832
826
  * Download quota for shared repositories
833
827
  */
@@ -855,6 +849,18 @@ export type BackupResponse = {
855
849
  * Backup Type
856
850
  */
857
851
  backup_type: string;
852
+ /**
853
+ * Initiated By
854
+ *
855
+ * 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.
856
+ */
857
+ initiated_by?: string;
858
+ /**
859
+ * Memory Included
860
+ *
861
+ * 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.
862
+ */
863
+ memory_included?: boolean | null;
858
864
  /**
859
865
  * Status
860
866
  */
@@ -1114,6 +1120,97 @@ export type BindTextBlockResponse = {
1114
1120
  */
1115
1121
  replaced: boolean;
1116
1122
  };
1123
+ /**
1124
+ * BlockSourceGraphOperation
1125
+ *
1126
+ * Bar a graph from sharing reports into this one.
1127
+ */
1128
+ export type BlockSourceGraphOperation = {
1129
+ /**
1130
+ * Source Graph Id
1131
+ *
1132
+ * Graph ID to block. Read it off the `source_graph_id` provenance field of a report that was shared to you.
1133
+ */
1134
+ source_graph_id: string;
1135
+ /**
1136
+ * Reason
1137
+ *
1138
+ * Free-form note for your own records. Never disclosed to the sender.
1139
+ */
1140
+ reason?: string | null;
1141
+ /**
1142
+ * Purge
1143
+ *
1144
+ * Also delete every report already shared in from this source, with their fact sets and facts. Reports you authored are never touched.
1145
+ */
1146
+ purge?: boolean;
1147
+ };
1148
+ /**
1149
+ * BlockSourceGraphResult
1150
+ *
1151
+ * Outcome of a block, including anything the purge removed.
1152
+ */
1153
+ export type BlockSourceGraphResult = {
1154
+ /**
1155
+ * The block record.
1156
+ */
1157
+ block: BlockedSourceGraphResponse;
1158
+ /**
1159
+ * Already Blocked
1160
+ *
1161
+ * True when the source was already blocked and this call was a no-op apart from any purge.
1162
+ */
1163
+ already_blocked?: boolean;
1164
+ /**
1165
+ * Purged Report Count
1166
+ *
1167
+ * Number of previously-shared reports deleted from this graph. Zero unless `purge` was set.
1168
+ */
1169
+ purged_report_count?: number;
1170
+ };
1171
+ /**
1172
+ * BlockedSourceGraphResponse
1173
+ *
1174
+ * One blocked source graph.
1175
+ */
1176
+ export type BlockedSourceGraphResponse = {
1177
+ /**
1178
+ * Id
1179
+ *
1180
+ * Block row identifier (ULID).
1181
+ */
1182
+ id: string;
1183
+ /**
1184
+ * Source Graph Id
1185
+ *
1186
+ * The blocked sender's graph ID.
1187
+ */
1188
+ source_graph_id: string;
1189
+ /**
1190
+ * Source Graph Name
1191
+ *
1192
+ * Display name of the blocked graph (if known).
1193
+ */
1194
+ source_graph_name?: string | null;
1195
+ /**
1196
+ * Blocked By
1197
+ *
1198
+ * User ID that created the block.
1199
+ */
1200
+ blocked_by: string;
1201
+ /**
1202
+ * Blocked At
1203
+ *
1204
+ * When the block was created.
1205
+ */
1206
+ blocked_at: string;
1207
+ /**
1208
+ * Reason
1209
+ *
1210
+ * Recipient's own note, if given.
1211
+ */
1212
+ reason?: string | null;
1213
+ };
1117
1214
  /**
1118
1215
  * CancelSubscriptionRequest
1119
1216
  *
@@ -1605,6 +1702,12 @@ export type ComputeForecastResponse = {
1605
1702
  * Months Computed
1606
1703
  */
1607
1704
  months_computed?: Array<ForecastMonthLite>;
1705
+ /**
1706
+ * Halted At
1707
+ *
1708
+ * 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.
1709
+ */
1710
+ halted_at?: string | null;
1608
1711
  /**
1609
1712
  * Skipped
1610
1713
  */
@@ -5695,7 +5798,7 @@ export type ForecastMonthLite = {
5695
5798
  /**
5696
5799
  * Verification Passed
5697
5800
  *
5698
- * Whether every rule evaluated against the month's scenario sets passed (None = no rules ran for the month).
5801
+ * 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.
5699
5802
  */
5700
5803
  verification_passed?: boolean | null;
5701
5804
  /**
@@ -8933,6 +9036,96 @@ export type OperationEnvelopeBindTextBlockResponse = {
8933
9036
  */
8934
9037
  idempotentReplay?: boolean;
8935
9038
  };
9039
+ /**
9040
+ * OperationEnvelope[BlockSourceGraphResult]
9041
+ */
9042
+ export type OperationEnvelopeBlockSourceGraphResult = {
9043
+ /**
9044
+ * Operation
9045
+ *
9046
+ * Kebab-case operation name
9047
+ */
9048
+ operation: string;
9049
+ /**
9050
+ * Operationid
9051
+ *
9052
+ * op_-prefixed ULID for audit and SSE correlation
9053
+ */
9054
+ operationId: string;
9055
+ /**
9056
+ * Status
9057
+ *
9058
+ * Operation lifecycle state
9059
+ */
9060
+ status: 'completed' | 'pending' | 'failed';
9061
+ /**
9062
+ * Command-specific result payload
9063
+ */
9064
+ result?: BlockSourceGraphResult | null;
9065
+ /**
9066
+ * At
9067
+ *
9068
+ * ISO-8601 UTC timestamp
9069
+ */
9070
+ at: string;
9071
+ /**
9072
+ * Createdby
9073
+ *
9074
+ * User ID that initiated the operation (null for legacy callers)
9075
+ */
9076
+ createdBy?: string | null;
9077
+ /**
9078
+ * Idempotentreplay
9079
+ *
9080
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9081
+ */
9082
+ idempotentReplay?: boolean;
9083
+ };
9084
+ /**
9085
+ * OperationEnvelope[BlockedSourceGraphResponse]
9086
+ */
9087
+ export type OperationEnvelopeBlockedSourceGraphResponse = {
9088
+ /**
9089
+ * Operation
9090
+ *
9091
+ * Kebab-case operation name
9092
+ */
9093
+ operation: string;
9094
+ /**
9095
+ * Operationid
9096
+ *
9097
+ * op_-prefixed ULID for audit and SSE correlation
9098
+ */
9099
+ operationId: string;
9100
+ /**
9101
+ * Status
9102
+ *
9103
+ * Operation lifecycle state
9104
+ */
9105
+ status: 'completed' | 'pending' | 'failed';
9106
+ /**
9107
+ * Command-specific result payload
9108
+ */
9109
+ result?: BlockedSourceGraphResponse | null;
9110
+ /**
9111
+ * At
9112
+ *
9113
+ * ISO-8601 UTC timestamp
9114
+ */
9115
+ at: string;
9116
+ /**
9117
+ * Createdby
9118
+ *
9119
+ * User ID that initiated the operation (null for legacy callers)
9120
+ */
9121
+ createdBy?: string | null;
9122
+ /**
9123
+ * Idempotentreplay
9124
+ *
9125
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9126
+ */
9127
+ idempotentReplay?: boolean;
9128
+ };
8936
9129
  /**
8937
9130
  * OperationEnvelope[ChangeReportingStyleResponse]
8938
9131
  */
@@ -10148,6 +10341,51 @@ export type OperationEnvelopeReportResponse = {
10148
10341
  */
10149
10342
  idempotentReplay?: boolean;
10150
10343
  };
10344
+ /**
10345
+ * OperationEnvelope[RevokeReportShareResponse]
10346
+ */
10347
+ export type OperationEnvelopeRevokeReportShareResponse = {
10348
+ /**
10349
+ * Operation
10350
+ *
10351
+ * Kebab-case operation name
10352
+ */
10353
+ operation: string;
10354
+ /**
10355
+ * Operationid
10356
+ *
10357
+ * op_-prefixed ULID for audit and SSE correlation
10358
+ */
10359
+ operationId: string;
10360
+ /**
10361
+ * Status
10362
+ *
10363
+ * Operation lifecycle state
10364
+ */
10365
+ status: 'completed' | 'pending' | 'failed';
10366
+ /**
10367
+ * Command-specific result payload
10368
+ */
10369
+ result?: RevokeReportShareResponse | null;
10370
+ /**
10371
+ * At
10372
+ *
10373
+ * ISO-8601 UTC timestamp
10374
+ */
10375
+ at: string;
10376
+ /**
10377
+ * Createdby
10378
+ *
10379
+ * User ID that initiated the operation (null for legacy callers)
10380
+ */
10381
+ createdBy?: string | null;
10382
+ /**
10383
+ * Idempotentreplay
10384
+ *
10385
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
10386
+ */
10387
+ idempotentReplay?: boolean;
10388
+ };
10151
10389
  /**
10152
10390
  * OperationEnvelope[ScheduleCreatedResponse]
10153
10391
  */
@@ -10957,34 +11195,18 @@ export type OrgUsageSummary = {
10957
11195
  * Total Storage Gb
10958
11196
  */
10959
11197
  total_storage_gb: number;
10960
- /**
10961
- * Total Api Calls
10962
- */
10963
- total_api_calls: number;
10964
11198
  /**
10965
11199
  * Daily Avg Credits
10966
11200
  */
10967
11201
  daily_avg_credits: number;
10968
- /**
10969
- * Daily Avg Api Calls
10970
- */
10971
- daily_avg_api_calls: number;
10972
11202
  /**
10973
11203
  * Projected Monthly Credits
10974
11204
  */
10975
11205
  projected_monthly_credits: number;
10976
- /**
10977
- * Projected Monthly Api Calls
10978
- */
10979
- projected_monthly_api_calls: number;
10980
11206
  /**
10981
11207
  * Credits Limit
10982
11208
  */
10983
11209
  credits_limit: number | null;
10984
- /**
10985
- * Api Calls Limit
10986
- */
10987
- api_calls_limit: number | null;
10988
11210
  /**
10989
11211
  * Storage Limit Gb
10990
11212
  */
@@ -12531,29 +12753,54 @@ export type ResolvedReportInfo = {
12531
12753
  */
12532
12754
  export type ResponseMode = 'auto' | 'sync' | 'async' | 'stream';
12533
12755
  /**
12534
- * RestoreBackupOp
12756
+ * RevokeReportShareOperation
12535
12757
  *
12536
- * Body for the restore-backup operation.
12758
+ * Withdraw a shared Report from one recipient graph.
12537
12759
  */
12538
- export type RestoreBackupOp = {
12760
+ export type RevokeReportShareOperation = {
12539
12761
  /**
12540
- * Backup Id
12762
+ * Target Graph Id
12541
12763
  *
12542
- * Backup identifier to restore from
12764
+ * Recipient graph whose copy should be withdrawn.
12543
12765
  */
12544
- backup_id: string;
12766
+ target_graph_id: string;
12545
12767
  /**
12546
- * Create System Backup
12768
+ * Report Id
12547
12769
  *
12548
- * Create a system backup of existing database before restore
12770
+ * The Report whose share to withdraw.
12549
12771
  */
12550
- create_system_backup?: boolean;
12772
+ report_id: string;
12773
+ };
12774
+ /**
12775
+ * RevokeReportShareResponse
12776
+ *
12777
+ * Outcome of withdrawing a shared report from one recipient.
12778
+ */
12779
+ export type RevokeReportShareResponse = {
12551
12780
  /**
12552
- * Verify After Restore
12781
+ * Report Id
12553
12782
  *
12554
- * Verify database integrity after restore
12783
+ * The report whose share was revoked.
12555
12784
  */
12556
- verify_after_restore?: boolean;
12785
+ report_id: string;
12786
+ /**
12787
+ * Target Graph Id
12788
+ *
12789
+ * Recipient the copy was pulled from.
12790
+ */
12791
+ target_graph_id: string;
12792
+ /**
12793
+ * Revoked At
12794
+ *
12795
+ * When the share was revoked.
12796
+ */
12797
+ revoked_at: string;
12798
+ /**
12799
+ * Copy Deleted
12800
+ *
12801
+ * 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.
12802
+ */
12803
+ copy_deleted: boolean;
12557
12804
  };
12558
12805
  /**
12559
12806
  * RollforwardMechanics
@@ -14926,6 +15173,19 @@ export type TransitionFilingStatusRequest = {
14926
15173
  */
14927
15174
  target_status: string;
14928
15175
  };
15176
+ /**
15177
+ * UnblockSourceGraphOperation
15178
+ *
15179
+ * Lift a block on a source graph.
15180
+ */
15181
+ export type UnblockSourceGraphOperation = {
15182
+ /**
15183
+ * Source Graph Id
15184
+ *
15185
+ * Graph ID to unblock.
15186
+ */
15187
+ source_graph_id: string;
15188
+ };
14929
15189
  /**
14930
15190
  * UpcomingInvoice
14931
15191
  *
@@ -20965,65 +21225,6 @@ export type CreateBackupResponses = {
20965
21225
  202: OperationEnvelope;
20966
21226
  };
20967
21227
  export type CreateBackupResponse = CreateBackupResponses[keyof CreateBackupResponses];
20968
- export type RestoreBackupData = {
20969
- body: RestoreBackupOp;
20970
- headers?: {
20971
- /**
20972
- * Idempotency-Key
20973
- */
20974
- 'Idempotency-Key'?: string | null;
20975
- };
20976
- path: {
20977
- /**
20978
- * Graph Id
20979
- */
20980
- graph_id: string;
20981
- };
20982
- query?: never;
20983
- url: '/v1/graphs/{graph_id}/operations/restore-backup';
20984
- };
20985
- export type RestoreBackupErrors = {
20986
- /**
20987
- * Invalid request
20988
- */
20989
- 400: ErrorResponse;
20990
- /**
20991
- * Authentication required
20992
- */
20993
- 401: ErrorResponse;
20994
- /**
20995
- * Access denied
20996
- */
20997
- 403: ErrorResponse;
20998
- /**
20999
- * Resource not found
21000
- */
21001
- 404: ErrorResponse;
21002
- /**
21003
- * Idempotency-Key conflict — key reused with different body
21004
- */
21005
- 409: ErrorResponse;
21006
- /**
21007
- * Validation error
21008
- */
21009
- 422: ErrorResponse;
21010
- /**
21011
- * Rate limit exceeded
21012
- */
21013
- 429: ErrorResponse;
21014
- /**
21015
- * Internal server error
21016
- */
21017
- 500: ErrorResponse;
21018
- };
21019
- export type RestoreBackupError = RestoreBackupErrors[keyof RestoreBackupErrors];
21020
- export type RestoreBackupResponses = {
21021
- /**
21022
- * Successful Response
21023
- */
21024
- 202: OperationEnvelope;
21025
- };
21026
- export type RestoreBackupResponse = RestoreBackupResponses[keyof RestoreBackupResponses];
21027
21228
  export type ChangeTierData = {
21028
21229
  body: ChangeTierOp;
21029
21230
  headers?: {
@@ -25085,6 +25286,65 @@ export type ShareReportResponses = {
25085
25286
  200: OperationEnvelopeShareReportResponse;
25086
25287
  };
25087
25288
  export type ShareReportResponse2 = ShareReportResponses[keyof ShareReportResponses];
25289
+ export type RevokeReportShareData = {
25290
+ body: RevokeReportShareOperation;
25291
+ headers?: {
25292
+ /**
25293
+ * Idempotency-Key
25294
+ */
25295
+ 'Idempotency-Key'?: string | null;
25296
+ };
25297
+ path: {
25298
+ /**
25299
+ * Graph Id
25300
+ */
25301
+ graph_id: string;
25302
+ };
25303
+ query?: never;
25304
+ url: '/extensions/roboledger/{graph_id}/operations/revoke-report-share';
25305
+ };
25306
+ export type RevokeReportShareErrors = {
25307
+ /**
25308
+ * Invalid request
25309
+ */
25310
+ 400: ErrorResponse;
25311
+ /**
25312
+ * Authentication required
25313
+ */
25314
+ 401: ErrorResponse;
25315
+ /**
25316
+ * Access denied
25317
+ */
25318
+ 403: ErrorResponse;
25319
+ /**
25320
+ * Resource not found
25321
+ */
25322
+ 404: ErrorResponse;
25323
+ /**
25324
+ * Idempotency-Key conflict — key reused with different body
25325
+ */
25326
+ 409: ErrorResponse;
25327
+ /**
25328
+ * Validation error
25329
+ */
25330
+ 422: ErrorResponse;
25331
+ /**
25332
+ * Rate limit exceeded
25333
+ */
25334
+ 429: ErrorResponse;
25335
+ /**
25336
+ * Internal server error
25337
+ */
25338
+ 500: ErrorResponse;
25339
+ };
25340
+ export type RevokeReportShareError = RevokeReportShareErrors[keyof RevokeReportShareErrors];
25341
+ export type RevokeReportShareResponses = {
25342
+ /**
25343
+ * Successful Response
25344
+ */
25345
+ 200: OperationEnvelopeRevokeReportShareResponse;
25346
+ };
25347
+ export type RevokeReportShareResponse2 = RevokeReportShareResponses[keyof RevokeReportShareResponses];
25088
25348
  export type FileReportData = {
25089
25349
  body: FileReportRequest;
25090
25350
  headers?: {
@@ -25498,6 +25758,124 @@ export type RemovePublishListMemberResponses = {
25498
25758
  200: OperationEnvelopeDeleteResult;
25499
25759
  };
25500
25760
  export type RemovePublishListMemberResponse = RemovePublishListMemberResponses[keyof RemovePublishListMemberResponses];
25761
+ export type BlockSourceGraphData = {
25762
+ body: BlockSourceGraphOperation;
25763
+ headers?: {
25764
+ /**
25765
+ * Idempotency-Key
25766
+ */
25767
+ 'Idempotency-Key'?: string | null;
25768
+ };
25769
+ path: {
25770
+ /**
25771
+ * Graph Id
25772
+ */
25773
+ graph_id: string;
25774
+ };
25775
+ query?: never;
25776
+ url: '/extensions/roboledger/{graph_id}/operations/block-source-graph';
25777
+ };
25778
+ export type BlockSourceGraphErrors = {
25779
+ /**
25780
+ * Invalid request
25781
+ */
25782
+ 400: ErrorResponse;
25783
+ /**
25784
+ * Authentication required
25785
+ */
25786
+ 401: ErrorResponse;
25787
+ /**
25788
+ * Access denied
25789
+ */
25790
+ 403: ErrorResponse;
25791
+ /**
25792
+ * Resource not found
25793
+ */
25794
+ 404: ErrorResponse;
25795
+ /**
25796
+ * Idempotency-Key conflict — key reused with different body
25797
+ */
25798
+ 409: ErrorResponse;
25799
+ /**
25800
+ * Validation error
25801
+ */
25802
+ 422: ErrorResponse;
25803
+ /**
25804
+ * Rate limit exceeded
25805
+ */
25806
+ 429: ErrorResponse;
25807
+ /**
25808
+ * Internal server error
25809
+ */
25810
+ 500: ErrorResponse;
25811
+ };
25812
+ export type BlockSourceGraphError = BlockSourceGraphErrors[keyof BlockSourceGraphErrors];
25813
+ export type BlockSourceGraphResponses = {
25814
+ /**
25815
+ * Successful Response
25816
+ */
25817
+ 200: OperationEnvelopeBlockSourceGraphResult;
25818
+ };
25819
+ export type BlockSourceGraphResponse = BlockSourceGraphResponses[keyof BlockSourceGraphResponses];
25820
+ export type UnblockSourceGraphData = {
25821
+ body: UnblockSourceGraphOperation;
25822
+ headers?: {
25823
+ /**
25824
+ * Idempotency-Key
25825
+ */
25826
+ 'Idempotency-Key'?: string | null;
25827
+ };
25828
+ path: {
25829
+ /**
25830
+ * Graph Id
25831
+ */
25832
+ graph_id: string;
25833
+ };
25834
+ query?: never;
25835
+ url: '/extensions/roboledger/{graph_id}/operations/unblock-source-graph';
25836
+ };
25837
+ export type UnblockSourceGraphErrors = {
25838
+ /**
25839
+ * Invalid request
25840
+ */
25841
+ 400: ErrorResponse;
25842
+ /**
25843
+ * Authentication required
25844
+ */
25845
+ 401: ErrorResponse;
25846
+ /**
25847
+ * Access denied
25848
+ */
25849
+ 403: ErrorResponse;
25850
+ /**
25851
+ * Resource not found
25852
+ */
25853
+ 404: ErrorResponse;
25854
+ /**
25855
+ * Idempotency-Key conflict — key reused with different body
25856
+ */
25857
+ 409: ErrorResponse;
25858
+ /**
25859
+ * Validation error
25860
+ */
25861
+ 422: ErrorResponse;
25862
+ /**
25863
+ * Rate limit exceeded
25864
+ */
25865
+ 429: ErrorResponse;
25866
+ /**
25867
+ * Internal server error
25868
+ */
25869
+ 500: ErrorResponse;
25870
+ };
25871
+ export type UnblockSourceGraphError = UnblockSourceGraphErrors[keyof UnblockSourceGraphErrors];
25872
+ export type UnblockSourceGraphResponses = {
25873
+ /**
25874
+ * Successful Response
25875
+ */
25876
+ 200: OperationEnvelopeBlockedSourceGraphResponse;
25877
+ };
25878
+ export type UnblockSourceGraphResponse = UnblockSourceGraphResponses[keyof UnblockSourceGraphResponses];
25501
25879
  export type LiveFinancialStatementData = {
25502
25880
  body: LiveFinancialStatementRequest;
25503
25881
  headers?: {