@robosystems/client 2.20.1 → 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.
@@ -96,7 +96,7 @@ export type AcceptSuggestionLine = {
96
96
  /**
97
97
  * Reason
98
98
  *
99
- * 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).
99
+ * 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), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
100
100
  */
101
101
  reason?: string | null;
102
102
  /**
@@ -298,10 +298,16 @@ export type AddPublishListMembersOperation = {
298
298
  /**
299
299
  * AgentClassification
300
300
  *
301
- * A counterparty's default account, learned from committed lines or set by
302
- * hand.
301
+ * A counterparty's default account for one entity's lines, learned from
302
+ * committed lines or set by hand.
303
303
  */
304
304
  export type AgentClassification = {
305
+ /**
306
+ * Entity Id
307
+ *
308
+ * The entity whose lines it is for.
309
+ */
310
+ entity_id: string;
305
311
  /**
306
312
  * Element Id
307
313
  *
@@ -1145,12 +1151,6 @@ export type BackupDownloadUrlResponse = {
1145
1151
  * Backup operation limits.
1146
1152
  */
1147
1153
  export type BackupLimits = {
1148
- /**
1149
- * Max Backup Size Gb
1150
- *
1151
- * Maximum backup size in GB
1152
- */
1153
- max_backup_size_gb: number;
1154
1154
  /**
1155
1155
  * Backup Retention Days
1156
1156
  *
@@ -1160,9 +1160,15 @@ export type BackupLimits = {
1160
1160
  /**
1161
1161
  * Max Backups Per Day
1162
1162
  *
1163
- * Maximum backups per day
1163
+ * Maximum user-initiated backups per day (-1 for unlimited)
1164
1164
  */
1165
1165
  max_backups_per_day: number;
1166
+ /**
1167
+ * Max Downloads Per Month
1168
+ *
1169
+ * Backup downloads allowed per user per calendar month (UTC)
1170
+ */
1171
+ max_downloads_per_month?: number | null;
1166
1172
  };
1167
1173
  /**
1168
1174
  * BackupListResponse
@@ -2622,7 +2628,7 @@ export type ConsolidationProposal = {
2622
2628
  /**
2623
2629
  * Posting Date
2624
2630
  *
2625
- * The month's last day.
2631
+ * The month's last day; for an opening, the eve of the consolidation entity's first month.
2626
2632
  */
2627
2633
  posting_date: string;
2628
2634
  /**
@@ -2643,6 +2649,12 @@ export type ConsolidationProposal = {
2643
2649
  * The entry's lines; they balance.
2644
2650
  */
2645
2651
  lines: Array<ConsolidationProposalLine>;
2652
+ /**
2653
+ * Opening
2654
+ *
2655
+ * 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.
2656
+ */
2657
+ opening?: boolean;
2646
2658
  };
2647
2659
  /**
2648
2660
  * ConsolidationProposalLine
@@ -2832,6 +2844,12 @@ export type ConsolidationWorksheetResponse = {
2832
2844
  * The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
2833
2845
  */
2834
2846
  period: PeriodSpec;
2847
+ /**
2848
+ * Omitted Periods
2849
+ *
2850
+ * 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.
2851
+ */
2852
+ omitted_periods?: Array<PeriodSpec>;
2835
2853
  /**
2836
2854
  * Columns
2837
2855
  *
@@ -2895,39 +2913,15 @@ export type ContentLimits = {
2895
2913
  /**
2896
2914
  * CopyOperationLimits
2897
2915
  *
2898
- * Copy/ingestion operation limits.
2916
+ * File upload limits.
2899
2917
  */
2900
2918
  export type CopyOperationLimits = {
2901
2919
  /**
2902
2920
  * Max File Size Gb
2903
2921
  *
2904
- * Maximum file size in GB
2922
+ * Maximum upload file size in GB
2905
2923
  */
2906
2924
  max_file_size_gb: number;
2907
- /**
2908
- * Timeout Seconds
2909
- *
2910
- * Operation timeout in seconds
2911
- */
2912
- timeout_seconds: number;
2913
- /**
2914
- * Concurrent Operations
2915
- *
2916
- * Maximum concurrent operations
2917
- */
2918
- concurrent_operations: number;
2919
- /**
2920
- * Max Files Per Operation
2921
- *
2922
- * Maximum files per operation
2923
- */
2924
- max_files_per_operation: number;
2925
- /**
2926
- * Daily Copy Operations
2927
- *
2928
- * Daily operation limit
2929
- */
2930
- daily_copy_operations: number;
2931
2925
  /**
2932
2926
  * Supported Formats
2933
2927
  *
@@ -3224,7 +3218,7 @@ export type CreateEntityRequest = {
3224
3218
  /**
3225
3219
  * Joined On
3226
3220
  *
3227
- * 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.
3221
+ * 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.
3228
3222
  */
3229
3223
  joined_on?: string | null;
3230
3224
  /**
@@ -3819,7 +3813,7 @@ export type CreateReportRequest = {
3819
3813
  /**
3820
3814
  * Entity Id
3821
3815
  *
3822
- * 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.
3816
+ * 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.
3823
3817
  */
3824
3818
  entity_id?: string | null;
3825
3819
  /**
@@ -7530,21 +7524,21 @@ export type GraphLimitsResponse = {
7530
7524
  */
7531
7525
  is_shared_repository: boolean;
7532
7526
  /**
7533
- * Storage limits and usage
7527
+ * Storage limits and usage (user graphs only)
7534
7528
  */
7535
- storage: StorageLimits;
7529
+ storage?: StorageLimits | null;
7536
7530
  /**
7537
7531
  * Query operation limits
7538
7532
  */
7539
7533
  queries: QueryLimits;
7540
7534
  /**
7541
- * Copy/ingestion operation limits
7535
+ * File upload limits (user graphs only)
7542
7536
  */
7543
- copy_operations: CopyOperationLimits;
7537
+ copy_operations?: CopyOperationLimits | null;
7544
7538
  /**
7545
- * Backup operation limits
7539
+ * Backup operation limits (user graphs only)
7546
7540
  */
7547
- backups: BackupLimits;
7541
+ backups?: BackupLimits | null;
7548
7542
  /**
7549
7543
  * API rate limits
7550
7544
  */
@@ -7963,7 +7957,7 @@ export type GraphSubscriptionTier = {
7963
7957
  /**
7964
7958
  * Instance Storage Limit Gb
7965
7959
  *
7966
- * Soft storage cap for the instance in GB
7960
+ * Instance storage cap in GB; ingest and materialize are refused above it
7967
7961
  */
7968
7962
  instance_storage_limit_gb?: number;
7969
7963
  };
@@ -8008,12 +8002,6 @@ export type GraphSubscriptions = {
8008
8002
  * Backup configuration for a tier.
8009
8003
  */
8010
8004
  export type GraphTierBackup = {
8011
- /**
8012
- * Max Backup Size Gb
8013
- *
8014
- * Maximum backup size in GB
8015
- */
8016
- max_backup_size_gb: number;
8017
8005
  /**
8018
8006
  * Backup Retention Days
8019
8007
  *
@@ -8030,39 +8018,15 @@ export type GraphTierBackup = {
8030
8018
  /**
8031
8019
  * GraphTierCopyOperations
8032
8020
  *
8033
- * Copy operation limits for a tier.
8021
+ * File upload limits for a tier.
8034
8022
  */
8035
8023
  export type GraphTierCopyOperations = {
8036
8024
  /**
8037
8025
  * Max File Size Gb
8038
8026
  *
8039
- * Maximum file size in GB
8027
+ * Maximum upload file size in GB
8040
8028
  */
8041
8029
  max_file_size_gb: number;
8042
- /**
8043
- * Timeout Seconds
8044
- *
8045
- * Operation timeout in seconds
8046
- */
8047
- timeout_seconds: number;
8048
- /**
8049
- * Concurrent Operations
8050
- *
8051
- * Maximum concurrent operations
8052
- */
8053
- concurrent_operations: number;
8054
- /**
8055
- * Max Files Per Operation
8056
- *
8057
- * Maximum files per operation
8058
- */
8059
- max_files_per_operation: number;
8060
- /**
8061
- * Daily Copy Operations
8062
- *
8063
- * Daily operation limit
8064
- */
8065
- daily_copy_operations: number;
8066
8030
  };
8067
8031
  /**
8068
8032
  * GraphTierInfo
@@ -8189,7 +8153,7 @@ export type GraphTierLimits = {
8189
8153
  */
8190
8154
  max_subgraphs: number | null;
8191
8155
  /**
8192
- * Copy operation limits
8156
+ * File upload limits
8193
8157
  */
8194
8158
  copy_operations: GraphTierCopyOperations;
8195
8159
  /**
@@ -8877,7 +8841,7 @@ export type InstanceUsage = {
8877
8841
  /**
8878
8842
  * Limit Gb
8879
8843
  *
8880
- * Soft storage limit for this tier in GB
8844
+ * Instance storage cap in GB; ingest and materialize are refused above it
8881
8845
  */
8882
8846
  limit_gb: number;
8883
8847
  /**
@@ -9261,13 +9225,13 @@ export type LearnClassificationDefaultsResponse = {
9261
9225
  /**
9262
9226
  * Agents Learned
9263
9227
  *
9264
- * Counterparties given a default from their committed lines.
9228
+ * Defaults learned from committed lines, one per counterparty and entity.
9265
9229
  */
9266
9230
  agents_learned: number;
9267
9231
  /**
9268
9232
  * Agents Kept
9269
9233
  *
9270
- * Counterparties that already had a default, left as they were.
9234
+ * Counterparty and entity pairs that already had a default, left as they were.
9271
9235
  */
9272
9236
  agents_kept: number;
9273
9237
  /**
@@ -9354,9 +9318,15 @@ export type LedgerAgentResponse = {
9354
9318
  */
9355
9319
  is_1099_recipient: boolean;
9356
9320
  /**
9357
- * The default account its bank lines are suggested.
9321
+ * The default account the group parent's bank lines are suggested.
9358
9322
  */
9359
9323
  classification?: AgentClassification | null;
9324
+ /**
9325
+ * Classifications
9326
+ *
9327
+ * The default account for each entity's bank lines, one per entity.
9328
+ */
9329
+ classifications?: Array<AgentClassification>;
9360
9330
  /**
9361
9331
  * Created At
9362
9332
  */
@@ -10257,7 +10227,7 @@ export type LiveFinancialStatementResponse = {
10257
10227
  /**
10258
10228
  * Omitted Periods
10259
10229
  *
10260
- * 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.
10230
+ * 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.
10261
10231
  */
10262
10232
  omitted_periods?: Array<PeriodSpec>;
10263
10233
  /**
@@ -15785,27 +15755,21 @@ export type QueryLimits = {
15785
15755
  /**
15786
15756
  * Max Timeout Seconds
15787
15757
  *
15788
- * Maximum query timeout in seconds
15758
+ * Per-query time ceiling the graph engine enforces, in seconds
15789
15759
  */
15790
15760
  max_timeout_seconds: number;
15791
15761
  /**
15792
15762
  * Chunk Size
15793
15763
  *
15794
- * Maximum chunk size for result streaming
15764
+ * Default rows per streamed chunk (a request may set chunk_size, 10-10,000)
15795
15765
  */
15796
15766
  chunk_size: number;
15797
15767
  /**
15798
15768
  * Max Rows Per Query
15799
15769
  *
15800
- * Maximum rows returned per query
15770
+ * Rows a non-streaming Cypher query returns before it stops (the response sets `truncated`); a streamed query returns up to 1,000,000
15801
15771
  */
15802
15772
  max_rows_per_query: number;
15803
- /**
15804
- * Concurrent Queries
15805
- *
15806
- * Maximum concurrent queries allowed
15807
- */
15808
- concurrent_queries: number;
15809
15773
  };
15810
15774
  /**
15811
15775
  * QuickBooksConnectionConfig
@@ -19183,7 +19147,7 @@ export type StorageLimits = {
19183
19147
  /**
19184
19148
  * Max Storage Gb
19185
19149
  *
19186
- * Maximum storage limit in GB
19150
+ * Instance storage cap in GB; ingest and materialize are refused above it
19187
19151
  */
19188
19152
  max_storage_gb: number;
19189
19153
  /**
@@ -20572,6 +20536,12 @@ export type UpdateAgentRequest = {
20572
20536
  * `suggest` offers the default on each line; `always_ask` offers none, for a counterparty whose lines go to different accounts. Omit to keep.
20573
20537
  */
20574
20538
  classification_mode?: 'suggest' | 'always_ask' | null;
20539
+ /**
20540
+ * Classification Entity Id
20541
+ *
20542
+ * The entity whose bank lines the default above is for. Each entity keeps its own default, on its own chart. Omit for the group parent.
20543
+ */
20544
+ classification_entity_id?: string | null;
20575
20545
  /**
20576
20546
  * Metadata Patch
20577
20547
  *
@@ -20709,13 +20679,13 @@ export type UpdateEntityRequest = {
20709
20679
  /**
20710
20680
  * Joined On
20711
20681
  *
20712
- * 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.
20682
+ * 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.
20713
20683
  */
20714
20684
  joined_on?: string | null;
20715
20685
  /**
20716
20686
  * Left On
20717
20687
  *
20718
- * 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.
20688
+ * 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.
20719
20689
  */
20720
20690
  left_on?: string | null;
20721
20691
  };