@robosystems/client 1.7.0 → 1.8.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.
@@ -1120,6 +1120,103 @@ export type BindTextBlockResponse = {
1120
1120
  */
1121
1121
  replaced: boolean;
1122
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
+ * Purged Report Ids
1172
+ *
1173
+ * Ids of the previously-shared reports deleted from this graph. Empty unless `purge` was set.
1174
+ */
1175
+ purged_report_ids?: Array<string>;
1176
+ };
1177
+ /**
1178
+ * BlockedSourceGraphResponse
1179
+ *
1180
+ * One blocked source graph.
1181
+ */
1182
+ export type BlockedSourceGraphResponse = {
1183
+ /**
1184
+ * Id
1185
+ *
1186
+ * Block row identifier (ULID).
1187
+ */
1188
+ id: string;
1189
+ /**
1190
+ * Source Graph Id
1191
+ *
1192
+ * The blocked sender's graph ID.
1193
+ */
1194
+ source_graph_id: string;
1195
+ /**
1196
+ * Source Graph Name
1197
+ *
1198
+ * Display name of the blocked graph (if known).
1199
+ */
1200
+ source_graph_name?: string | null;
1201
+ /**
1202
+ * Blocked By
1203
+ *
1204
+ * User ID that created the block.
1205
+ */
1206
+ blocked_by: string;
1207
+ /**
1208
+ * Blocked At
1209
+ *
1210
+ * When the block was created.
1211
+ */
1212
+ blocked_at: string;
1213
+ /**
1214
+ * Reason
1215
+ *
1216
+ * Recipient's own note, if given.
1217
+ */
1218
+ reason?: string | null;
1219
+ };
1123
1220
  /**
1124
1221
  * CancelSubscriptionRequest
1125
1222
  *
@@ -8125,7 +8222,7 @@ export type LiveFinancialStatementRequest = {
8125
8222
  /**
8126
8223
  * Statement Type
8127
8224
  *
8128
- * income_statement | balance_sheet | equity_statement
8225
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement
8129
8226
  */
8130
8227
  statement_type: string;
8131
8228
  /**
@@ -8945,6 +9042,96 @@ export type OperationEnvelopeBindTextBlockResponse = {
8945
9042
  */
8946
9043
  idempotentReplay?: boolean;
8947
9044
  };
9045
+ /**
9046
+ * OperationEnvelope[BlockSourceGraphResult]
9047
+ */
9048
+ export type OperationEnvelopeBlockSourceGraphResult = {
9049
+ /**
9050
+ * Operation
9051
+ *
9052
+ * Kebab-case operation name
9053
+ */
9054
+ operation: string;
9055
+ /**
9056
+ * Operationid
9057
+ *
9058
+ * op_-prefixed ULID for audit and SSE correlation
9059
+ */
9060
+ operationId: string;
9061
+ /**
9062
+ * Status
9063
+ *
9064
+ * Operation lifecycle state
9065
+ */
9066
+ status: 'completed' | 'pending' | 'failed';
9067
+ /**
9068
+ * Command-specific result payload
9069
+ */
9070
+ result?: BlockSourceGraphResult | null;
9071
+ /**
9072
+ * At
9073
+ *
9074
+ * ISO-8601 UTC timestamp
9075
+ */
9076
+ at: string;
9077
+ /**
9078
+ * Createdby
9079
+ *
9080
+ * User ID that initiated the operation (null for legacy callers)
9081
+ */
9082
+ createdBy?: string | null;
9083
+ /**
9084
+ * Idempotentreplay
9085
+ *
9086
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9087
+ */
9088
+ idempotentReplay?: boolean;
9089
+ };
9090
+ /**
9091
+ * OperationEnvelope[BlockedSourceGraphResponse]
9092
+ */
9093
+ export type OperationEnvelopeBlockedSourceGraphResponse = {
9094
+ /**
9095
+ * Operation
9096
+ *
9097
+ * Kebab-case operation name
9098
+ */
9099
+ operation: string;
9100
+ /**
9101
+ * Operationid
9102
+ *
9103
+ * op_-prefixed ULID for audit and SSE correlation
9104
+ */
9105
+ operationId: string;
9106
+ /**
9107
+ * Status
9108
+ *
9109
+ * Operation lifecycle state
9110
+ */
9111
+ status: 'completed' | 'pending' | 'failed';
9112
+ /**
9113
+ * Command-specific result payload
9114
+ */
9115
+ result?: BlockedSourceGraphResponse | null;
9116
+ /**
9117
+ * At
9118
+ *
9119
+ * ISO-8601 UTC timestamp
9120
+ */
9121
+ at: string;
9122
+ /**
9123
+ * Createdby
9124
+ *
9125
+ * User ID that initiated the operation (null for legacy callers)
9126
+ */
9127
+ createdBy?: string | null;
9128
+ /**
9129
+ * Idempotentreplay
9130
+ *
9131
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9132
+ */
9133
+ idempotentReplay?: boolean;
9134
+ };
8948
9135
  /**
8949
9136
  * OperationEnvelope[ChangeReportingStyleResponse]
8950
9137
  */
@@ -10160,6 +10347,51 @@ export type OperationEnvelopeReportResponse = {
10160
10347
  */
10161
10348
  idempotentReplay?: boolean;
10162
10349
  };
10350
+ /**
10351
+ * OperationEnvelope[RevokeReportShareResponse]
10352
+ */
10353
+ export type OperationEnvelopeRevokeReportShareResponse = {
10354
+ /**
10355
+ * Operation
10356
+ *
10357
+ * Kebab-case operation name
10358
+ */
10359
+ operation: string;
10360
+ /**
10361
+ * Operationid
10362
+ *
10363
+ * op_-prefixed ULID for audit and SSE correlation
10364
+ */
10365
+ operationId: string;
10366
+ /**
10367
+ * Status
10368
+ *
10369
+ * Operation lifecycle state
10370
+ */
10371
+ status: 'completed' | 'pending' | 'failed';
10372
+ /**
10373
+ * Command-specific result payload
10374
+ */
10375
+ result?: RevokeReportShareResponse | null;
10376
+ /**
10377
+ * At
10378
+ *
10379
+ * ISO-8601 UTC timestamp
10380
+ */
10381
+ at: string;
10382
+ /**
10383
+ * Createdby
10384
+ *
10385
+ * User ID that initiated the operation (null for legacy callers)
10386
+ */
10387
+ createdBy?: string | null;
10388
+ /**
10389
+ * Idempotentreplay
10390
+ *
10391
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
10392
+ */
10393
+ idempotentReplay?: boolean;
10394
+ };
10163
10395
  /**
10164
10396
  * OperationEnvelope[ScheduleCreatedResponse]
10165
10397
  */
@@ -10969,34 +11201,18 @@ export type OrgUsageSummary = {
10969
11201
  * Total Storage Gb
10970
11202
  */
10971
11203
  total_storage_gb: number;
10972
- /**
10973
- * Total Api Calls
10974
- */
10975
- total_api_calls: number;
10976
11204
  /**
10977
11205
  * Daily Avg Credits
10978
11206
  */
10979
11207
  daily_avg_credits: number;
10980
- /**
10981
- * Daily Avg Api Calls
10982
- */
10983
- daily_avg_api_calls: number;
10984
11208
  /**
10985
11209
  * Projected Monthly Credits
10986
11210
  */
10987
11211
  projected_monthly_credits: number;
10988
- /**
10989
- * Projected Monthly Api Calls
10990
- */
10991
- projected_monthly_api_calls: number;
10992
11212
  /**
10993
11213
  * Credits Limit
10994
11214
  */
10995
11215
  credits_limit: number | null;
10996
- /**
10997
- * Api Calls Limit
10998
- */
10999
- api_calls_limit: number | null;
11000
11216
  /**
11001
11217
  * Storage Limit Gb
11002
11218
  */
@@ -12542,6 +12758,56 @@ export type ResolvedReportInfo = {
12542
12758
  * Response modes for execution.
12543
12759
  */
12544
12760
  export type ResponseMode = 'auto' | 'sync' | 'async' | 'stream';
12761
+ /**
12762
+ * RevokeReportShareOperation
12763
+ *
12764
+ * Withdraw a shared Report from one recipient graph.
12765
+ */
12766
+ export type RevokeReportShareOperation = {
12767
+ /**
12768
+ * Target Graph Id
12769
+ *
12770
+ * Recipient graph whose copy should be withdrawn.
12771
+ */
12772
+ target_graph_id: string;
12773
+ /**
12774
+ * Report Id
12775
+ *
12776
+ * The Report whose share to withdraw.
12777
+ */
12778
+ report_id: string;
12779
+ };
12780
+ /**
12781
+ * RevokeReportShareResponse
12782
+ *
12783
+ * Outcome of withdrawing a shared report from one recipient.
12784
+ */
12785
+ export type RevokeReportShareResponse = {
12786
+ /**
12787
+ * Report Id
12788
+ *
12789
+ * The report whose share was revoked.
12790
+ */
12791
+ report_id: string;
12792
+ /**
12793
+ * Target Graph Id
12794
+ *
12795
+ * Recipient the copy was pulled from.
12796
+ */
12797
+ target_graph_id: string;
12798
+ /**
12799
+ * Revoked At
12800
+ *
12801
+ * When the share was revoked.
12802
+ */
12803
+ revoked_at: string;
12804
+ /**
12805
+ * Copy Deleted
12806
+ *
12807
+ * 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.
12808
+ */
12809
+ copy_deleted: boolean;
12810
+ };
12545
12811
  /**
12546
12812
  * RollforwardMechanics
12547
12813
  *
@@ -13653,9 +13919,11 @@ export type SqlStatementRequest = {
13653
13919
  /**
13654
13920
  * Parameters
13655
13921
  *
13656
- * Query parameters for safe value substitution. ALWAYS use parameters instead of string concatenation.
13922
+ * Query parameters for safe value substitution. ALWAYS use parameters instead of string concatenation. Pass a list for positional placeholders (`?` or `$1`) and an object for named ones (`$param_name`) — the two forms cannot be mixed in one statement.
13657
13923
  */
13658
- parameters?: Array<unknown> | null;
13924
+ parameters?: Array<unknown> | {
13925
+ [key: string]: unknown;
13926
+ } | null;
13659
13927
  };
13660
13928
  /**
13661
13929
  * SqlStatementResponse
@@ -14913,6 +15181,19 @@ export type TransitionFilingStatusRequest = {
14913
15181
  */
14914
15182
  target_status: string;
14915
15183
  };
15184
+ /**
15185
+ * UnblockSourceGraphOperation
15186
+ *
15187
+ * Lift a block on a source graph.
15188
+ */
15189
+ export type UnblockSourceGraphOperation = {
15190
+ /**
15191
+ * Source Graph Id
15192
+ *
15193
+ * Graph ID to unblock.
15194
+ */
15195
+ source_graph_id: string;
15196
+ };
14916
15197
  /**
14917
15198
  * UpcomingInvoice
14918
15199
  *
@@ -25013,6 +25294,65 @@ export type ShareReportResponses = {
25013
25294
  200: OperationEnvelopeShareReportResponse;
25014
25295
  };
25015
25296
  export type ShareReportResponse2 = ShareReportResponses[keyof ShareReportResponses];
25297
+ export type RevokeReportShareData = {
25298
+ body: RevokeReportShareOperation;
25299
+ headers?: {
25300
+ /**
25301
+ * Idempotency-Key
25302
+ */
25303
+ 'Idempotency-Key'?: string | null;
25304
+ };
25305
+ path: {
25306
+ /**
25307
+ * Graph Id
25308
+ */
25309
+ graph_id: string;
25310
+ };
25311
+ query?: never;
25312
+ url: '/extensions/roboledger/{graph_id}/operations/revoke-report-share';
25313
+ };
25314
+ export type RevokeReportShareErrors = {
25315
+ /**
25316
+ * Invalid request
25317
+ */
25318
+ 400: ErrorResponse;
25319
+ /**
25320
+ * Authentication required
25321
+ */
25322
+ 401: ErrorResponse;
25323
+ /**
25324
+ * Access denied
25325
+ */
25326
+ 403: ErrorResponse;
25327
+ /**
25328
+ * Resource not found
25329
+ */
25330
+ 404: ErrorResponse;
25331
+ /**
25332
+ * Idempotency-Key conflict — key reused with different body
25333
+ */
25334
+ 409: ErrorResponse;
25335
+ /**
25336
+ * Validation error
25337
+ */
25338
+ 422: ErrorResponse;
25339
+ /**
25340
+ * Rate limit exceeded
25341
+ */
25342
+ 429: ErrorResponse;
25343
+ /**
25344
+ * Internal server error
25345
+ */
25346
+ 500: ErrorResponse;
25347
+ };
25348
+ export type RevokeReportShareError = RevokeReportShareErrors[keyof RevokeReportShareErrors];
25349
+ export type RevokeReportShareResponses = {
25350
+ /**
25351
+ * Successful Response
25352
+ */
25353
+ 200: OperationEnvelopeRevokeReportShareResponse;
25354
+ };
25355
+ export type RevokeReportShareResponse2 = RevokeReportShareResponses[keyof RevokeReportShareResponses];
25016
25356
  export type FileReportData = {
25017
25357
  body: FileReportRequest;
25018
25358
  headers?: {
@@ -25426,6 +25766,124 @@ export type RemovePublishListMemberResponses = {
25426
25766
  200: OperationEnvelopeDeleteResult;
25427
25767
  };
25428
25768
  export type RemovePublishListMemberResponse = RemovePublishListMemberResponses[keyof RemovePublishListMemberResponses];
25769
+ export type BlockSourceGraphData = {
25770
+ body: BlockSourceGraphOperation;
25771
+ headers?: {
25772
+ /**
25773
+ * Idempotency-Key
25774
+ */
25775
+ 'Idempotency-Key'?: string | null;
25776
+ };
25777
+ path: {
25778
+ /**
25779
+ * Graph Id
25780
+ */
25781
+ graph_id: string;
25782
+ };
25783
+ query?: never;
25784
+ url: '/extensions/roboledger/{graph_id}/operations/block-source-graph';
25785
+ };
25786
+ export type BlockSourceGraphErrors = {
25787
+ /**
25788
+ * Invalid request
25789
+ */
25790
+ 400: ErrorResponse;
25791
+ /**
25792
+ * Authentication required
25793
+ */
25794
+ 401: ErrorResponse;
25795
+ /**
25796
+ * Access denied
25797
+ */
25798
+ 403: ErrorResponse;
25799
+ /**
25800
+ * Resource not found
25801
+ */
25802
+ 404: ErrorResponse;
25803
+ /**
25804
+ * Idempotency-Key conflict — key reused with different body
25805
+ */
25806
+ 409: ErrorResponse;
25807
+ /**
25808
+ * Validation error
25809
+ */
25810
+ 422: ErrorResponse;
25811
+ /**
25812
+ * Rate limit exceeded
25813
+ */
25814
+ 429: ErrorResponse;
25815
+ /**
25816
+ * Internal server error
25817
+ */
25818
+ 500: ErrorResponse;
25819
+ };
25820
+ export type BlockSourceGraphError = BlockSourceGraphErrors[keyof BlockSourceGraphErrors];
25821
+ export type BlockSourceGraphResponses = {
25822
+ /**
25823
+ * Successful Response
25824
+ */
25825
+ 200: OperationEnvelopeBlockSourceGraphResult;
25826
+ };
25827
+ export type BlockSourceGraphResponse = BlockSourceGraphResponses[keyof BlockSourceGraphResponses];
25828
+ export type UnblockSourceGraphData = {
25829
+ body: UnblockSourceGraphOperation;
25830
+ headers?: {
25831
+ /**
25832
+ * Idempotency-Key
25833
+ */
25834
+ 'Idempotency-Key'?: string | null;
25835
+ };
25836
+ path: {
25837
+ /**
25838
+ * Graph Id
25839
+ */
25840
+ graph_id: string;
25841
+ };
25842
+ query?: never;
25843
+ url: '/extensions/roboledger/{graph_id}/operations/unblock-source-graph';
25844
+ };
25845
+ export type UnblockSourceGraphErrors = {
25846
+ /**
25847
+ * Invalid request
25848
+ */
25849
+ 400: ErrorResponse;
25850
+ /**
25851
+ * Authentication required
25852
+ */
25853
+ 401: ErrorResponse;
25854
+ /**
25855
+ * Access denied
25856
+ */
25857
+ 403: ErrorResponse;
25858
+ /**
25859
+ * Resource not found
25860
+ */
25861
+ 404: ErrorResponse;
25862
+ /**
25863
+ * Idempotency-Key conflict — key reused with different body
25864
+ */
25865
+ 409: ErrorResponse;
25866
+ /**
25867
+ * Validation error
25868
+ */
25869
+ 422: ErrorResponse;
25870
+ /**
25871
+ * Rate limit exceeded
25872
+ */
25873
+ 429: ErrorResponse;
25874
+ /**
25875
+ * Internal server error
25876
+ */
25877
+ 500: ErrorResponse;
25878
+ };
25879
+ export type UnblockSourceGraphError = UnblockSourceGraphErrors[keyof UnblockSourceGraphErrors];
25880
+ export type UnblockSourceGraphResponses = {
25881
+ /**
25882
+ * Successful Response
25883
+ */
25884
+ 200: OperationEnvelopeBlockedSourceGraphResponse;
25885
+ };
25886
+ export type UnblockSourceGraphResponse = UnblockSourceGraphResponses[keyof UnblockSourceGraphResponses];
25429
25887
  export type LiveFinancialStatementData = {
25430
25888
  body: LiveFinancialStatementRequest;
25431
25889
  headers?: {