@robosystems/client 2.20.2 → 2.21.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.ts CHANGED
@@ -1182,12 +1182,6 @@ export type BackupDownloadUrlResponse = {
1182
1182
  * Backup operation limits.
1183
1183
  */
1184
1184
  export type BackupLimits = {
1185
- /**
1186
- * Max Backup Size Gb
1187
- *
1188
- * Maximum backup size in GB
1189
- */
1190
- max_backup_size_gb: number;
1191
1185
  /**
1192
1186
  * Backup Retention Days
1193
1187
  *
@@ -1197,9 +1191,15 @@ export type BackupLimits = {
1197
1191
  /**
1198
1192
  * Max Backups Per Day
1199
1193
  *
1200
- * Maximum backups per day
1194
+ * Maximum user-initiated backups per day (-1 for unlimited)
1201
1195
  */
1202
1196
  max_backups_per_day: number;
1197
+ /**
1198
+ * Max Downloads Per Month
1199
+ *
1200
+ * Backup downloads allowed per user per calendar month (UTC)
1201
+ */
1202
+ max_downloads_per_month?: number | null;
1203
1203
  };
1204
1204
 
1205
1205
  /**
@@ -2694,7 +2694,7 @@ export type ConsolidationProposal = {
2694
2694
  /**
2695
2695
  * Posting Date
2696
2696
  *
2697
- * The month's last day.
2697
+ * The month's last day; for an opening, the eve of the consolidation entity's first month.
2698
2698
  */
2699
2699
  posting_date: string;
2700
2700
  /**
@@ -2715,6 +2715,12 @@ export type ConsolidationProposal = {
2715
2715
  * The entry's lines; they balance.
2716
2716
  */
2717
2717
  lines: Array<ConsolidationProposalLine>;
2718
+ /**
2719
+ * Opening
2720
+ *
2721
+ * Part of the consolidation entity's opening balance: what the members' history before the group's first month already needed eliminated, so the consolidated statements open on it rather than move by it. Proposing records it, posted, replacing the earlier one until the first close.
2722
+ */
2723
+ opening?: boolean;
2718
2724
  };
2719
2725
 
2720
2726
  /**
@@ -2909,6 +2915,12 @@ export type ConsolidationWorksheetResponse = {
2909
2915
  * The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
2910
2916
  */
2911
2917
  period: PeriodSpec;
2918
+ /**
2919
+ * Omitted Periods
2920
+ *
2921
+ * Windows the worksheet does not total, as live-financial-statement leaves them out: before a summed entity's books begin, or, on a cash flow or equity statement, one a member joined or left the group within. When it names `period`, `rows` is empty.
2922
+ */
2923
+ omitted_periods?: Array<PeriodSpec>;
2912
2924
  /**
2913
2925
  * Columns
2914
2926
  *
@@ -2974,39 +2986,15 @@ export type ContentLimits = {
2974
2986
  /**
2975
2987
  * CopyOperationLimits
2976
2988
  *
2977
- * Copy/ingestion operation limits.
2989
+ * File upload limits.
2978
2990
  */
2979
2991
  export type CopyOperationLimits = {
2980
2992
  /**
2981
2993
  * Max File Size Gb
2982
2994
  *
2983
- * Maximum file size in GB
2995
+ * Maximum upload file size in GB
2984
2996
  */
2985
2997
  max_file_size_gb: number;
2986
- /**
2987
- * Timeout Seconds
2988
- *
2989
- * Operation timeout in seconds
2990
- */
2991
- timeout_seconds: number;
2992
- /**
2993
- * Concurrent Operations
2994
- *
2995
- * Maximum concurrent operations
2996
- */
2997
- concurrent_operations: number;
2998
- /**
2999
- * Max Files Per Operation
3000
- *
3001
- * Maximum files per operation
3002
- */
3003
- max_files_per_operation: number;
3004
- /**
3005
- * Daily Copy Operations
3006
- *
3007
- * Daily operation limit
3008
- */
3009
- daily_copy_operations: number;
3010
2998
  /**
3011
2999
  * Supported Formats
3012
3000
  *
@@ -3310,7 +3298,7 @@ export type CreateEntityRequest = {
3310
3298
  /**
3311
3299
  * Joined On
3312
3300
  *
3313
- * The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Omit for a subsidiary formed by the parent; give the acquisition month for one acquired, whose books in this graph then hold only what follows it.
3301
+ * The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Omit for a subsidiary formed by the parent; give the acquisition month for one acquired, whose books in this graph then hold only what follows it. Refused on the consolidation entity.
3314
3302
  */
3315
3303
  joined_on?: string | null;
3316
3304
  /**
@@ -3915,7 +3903,7 @@ export type CreateReportRequest = {
3915
3903
  /**
3916
3904
  * Entity Id
3917
3905
  *
3918
- * The entity the report is for, by id. Omit for the entity whose chart `mapping_id` maps from (the group parent on a one-entity graph). Named alongside a mapping of another entity's chart, it is refused.
3906
+ * The entity the report is for, by id. Omit for the entity whose chart `mapping_id` maps from (the group parent on a one-entity graph). Named alongside a mapping of another entity's chart, it is refused. The consolidation entity's report is the group's consolidated statements.
3919
3907
  */
3920
3908
  entity_id?: string | null;
3921
3909
  /**
@@ -7713,21 +7701,21 @@ export type GraphLimitsResponse = {
7713
7701
  */
7714
7702
  is_shared_repository: boolean;
7715
7703
  /**
7716
- * Storage limits and usage
7704
+ * Storage limits and usage (user graphs only)
7717
7705
  */
7718
- storage: StorageLimits;
7706
+ storage?: StorageLimits | null;
7719
7707
  /**
7720
7708
  * Query operation limits
7721
7709
  */
7722
7710
  queries: QueryLimits;
7723
7711
  /**
7724
- * Copy/ingestion operation limits
7712
+ * File upload limits (user graphs only)
7725
7713
  */
7726
- copy_operations: CopyOperationLimits;
7714
+ copy_operations?: CopyOperationLimits | null;
7727
7715
  /**
7728
- * Backup operation limits
7716
+ * Backup operation limits (user graphs only)
7729
7717
  */
7730
- backups: BackupLimits;
7718
+ backups?: BackupLimits | null;
7731
7719
  /**
7732
7720
  * API rate limits
7733
7721
  */
@@ -8154,7 +8142,7 @@ export type GraphSubscriptionTier = {
8154
8142
  /**
8155
8143
  * Instance Storage Limit Gb
8156
8144
  *
8157
- * Soft storage cap for the instance in GB
8145
+ * Instance storage cap in GB; ingest and materialize are refused above it
8158
8146
  */
8159
8147
  instance_storage_limit_gb?: number;
8160
8148
  };
@@ -8201,12 +8189,6 @@ export type GraphSubscriptions = {
8201
8189
  * Backup configuration for a tier.
8202
8190
  */
8203
8191
  export type GraphTierBackup = {
8204
- /**
8205
- * Max Backup Size Gb
8206
- *
8207
- * Maximum backup size in GB
8208
- */
8209
- max_backup_size_gb: number;
8210
8192
  /**
8211
8193
  * Backup Retention Days
8212
8194
  *
@@ -8224,39 +8206,15 @@ export type GraphTierBackup = {
8224
8206
  /**
8225
8207
  * GraphTierCopyOperations
8226
8208
  *
8227
- * Copy operation limits for a tier.
8209
+ * File upload limits for a tier.
8228
8210
  */
8229
8211
  export type GraphTierCopyOperations = {
8230
8212
  /**
8231
8213
  * Max File Size Gb
8232
8214
  *
8233
- * Maximum file size in GB
8215
+ * Maximum upload file size in GB
8234
8216
  */
8235
8217
  max_file_size_gb: number;
8236
- /**
8237
- * Timeout Seconds
8238
- *
8239
- * Operation timeout in seconds
8240
- */
8241
- timeout_seconds: number;
8242
- /**
8243
- * Concurrent Operations
8244
- *
8245
- * Maximum concurrent operations
8246
- */
8247
- concurrent_operations: number;
8248
- /**
8249
- * Max Files Per Operation
8250
- *
8251
- * Maximum files per operation
8252
- */
8253
- max_files_per_operation: number;
8254
- /**
8255
- * Daily Copy Operations
8256
- *
8257
- * Daily operation limit
8258
- */
8259
- daily_copy_operations: number;
8260
8218
  };
8261
8219
 
8262
8220
  /**
@@ -8386,7 +8344,7 @@ export type GraphTierLimits = {
8386
8344
  */
8387
8345
  max_subgraphs: number | null;
8388
8346
  /**
8389
- * Copy operation limits
8347
+ * File upload limits
8390
8348
  */
8391
8349
  copy_operations: GraphTierCopyOperations;
8392
8350
  /**
@@ -9089,7 +9047,7 @@ export type InstanceUsage = {
9089
9047
  /**
9090
9048
  * Limit Gb
9091
9049
  *
9092
- * Soft storage limit for this tier in GB
9050
+ * Instance storage cap in GB; ingest and materialize are refused above it
9093
9051
  */
9094
9052
  limit_gb: number;
9095
9053
  /**
@@ -10501,7 +10459,7 @@ export type LiveFinancialStatementResponse = {
10501
10459
  /**
10502
10460
  * Omitted Periods
10503
10461
  *
10504
- * Columns left out because they reach back before the books begin: on books that start from an opening balance, a flow statement column that starts before the first day it covers, or a balance sheet dated before it. They would show a partial figure, not the months before the books.
10462
+ * Columns left out because they reach back before the books begin: on books that start from an opening balance, a flow statement column that starts before the first day it covers, or a balance sheet dated before it. They would show a partial figure, not the months before the books. On a group read, also a cash flow or equity statement column a member joined or left the group within.
10505
10463
  */
10506
10464
  omitted_periods?: Array<PeriodSpec>;
10507
10465
  /**
@@ -16170,27 +16128,21 @@ export type QueryLimits = {
16170
16128
  /**
16171
16129
  * Max Timeout Seconds
16172
16130
  *
16173
- * Maximum query timeout in seconds
16131
+ * Per-query time ceiling the graph engine enforces, in seconds
16174
16132
  */
16175
16133
  max_timeout_seconds: number;
16176
16134
  /**
16177
16135
  * Chunk Size
16178
16136
  *
16179
- * Maximum chunk size for result streaming
16137
+ * Default rows per streamed chunk (a request may set chunk_size, 10-10,000)
16180
16138
  */
16181
16139
  chunk_size: number;
16182
16140
  /**
16183
16141
  * Max Rows Per Query
16184
16142
  *
16185
- * Maximum rows returned per query
16143
+ * Rows a non-streaming Cypher query returns before it stops (the response sets `truncated`); a streamed query returns up to 1,000,000
16186
16144
  */
16187
16145
  max_rows_per_query: number;
16188
- /**
16189
- * Concurrent Queries
16190
- *
16191
- * Maximum concurrent queries allowed
16192
- */
16193
- concurrent_queries: number;
16194
16146
  };
16195
16147
 
16196
16148
  /**
@@ -19651,7 +19603,7 @@ export type StorageLimits = {
19651
19603
  /**
19652
19604
  * Max Storage Gb
19653
19605
  *
19654
- * Maximum storage limit in GB
19606
+ * Instance storage cap in GB; ingest and materialize are refused above it
19655
19607
  */
19656
19608
  max_storage_gb: number;
19657
19609
  /**
@@ -21219,13 +21171,13 @@ export type UpdateEntityRequest = {
21219
21171
  /**
21220
21172
  * Joined On
21221
21173
  *
21222
- * The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Pass null to clear it.
21174
+ * The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Pass null to clear it. Refused on the consolidation entity.
21223
21175
  */
21224
21176
  joined_on?: string | null;
21225
21177
  /**
21226
21178
  * Left On
21227
21179
  *
21228
- * The month this entity left the group, as any date in it; null is a member still. The consolidated statements include it through that month and leave it out after. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Must not precede `joined_on`. Set it when a subsidiary is sold, dissolved or deconsolidated; its closed months and stamped statements stay readable under the group. Pass null to reopen membership.
21180
+ * The month this entity left the group, as any date in it; null is a member still. The consolidated statements include it through that month and leave it out after. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Must not precede `joined_on`. Set it when a subsidiary is sold, dissolved or deconsolidated; its closed months and stamped statements stay readable under the group. Pass null to reopen membership. Refused on the consolidation entity.
21229
21181
  */
21230
21182
  left_on?: string | null;
21231
21183
  };