@robosystems/client 0.5.12 → 0.5.13

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.
@@ -511,7 +511,7 @@ export type BackupCreateRequest = {
511
511
  /**
512
512
  * Retention Days
513
513
  *
514
- * Retention period in days
514
+ * Retention period in days, further capped to the graph tier's maximum (7/30/90). 90 is the hard ceiling: the storage lifecycle expires backup objects then regardless of the requested value.
515
515
  */
516
516
  retention_days?: number;
517
517
  /**
@@ -5489,7 +5489,7 @@ export type GraphLimitsResponse = {
5489
5489
  /**
5490
5490
  * Subscription Tier
5491
5491
  *
5492
- * User's subscription tier
5492
+ * Rate-limit tier enforced for requests to this graph
5493
5493
  */
5494
5494
  subscription_tier: string;
5495
5495
  /**
@@ -6027,7 +6027,7 @@ export type GraphTierInstance = {
6027
6027
  /**
6028
6028
  * Memory Mb
6029
6029
  *
6030
- * Memory allocated to your graph in megabytes
6030
+ * LadybugDB memory budget for the whole instance in megabytes (below physical RAM after OS overhead; not a per-graph allocation)
6031
6031
  */
6032
6032
  memory_mb: number;
6033
6033
  /**
@@ -7473,7 +7473,7 @@ export type ListSubgraphsResponse = {
7473
7473
  /**
7474
7474
  * Subgraphs Enabled
7475
7475
  *
7476
- * Whether subgraphs are enabled for this tier (requires Large/XLarge tier)
7476
+ * Whether subgraphs are enabled for this tier
7477
7477
  */
7478
7478
  subgraphs_enabled: boolean;
7479
7479
  /**
@@ -7579,6 +7579,72 @@ export type LiveFinancialStatementRequest = {
7579
7579
  */
7580
7580
  limit?: number;
7581
7581
  };
7582
+ /**
7583
+ * LiveFinancialStatementResponse
7584
+ *
7585
+ * Rendered OLTP-backed ad-hoc statement.
7586
+ */
7587
+ export type LiveFinancialStatementResponse = {
7588
+ /**
7589
+ * Graph Id
7590
+ */
7591
+ graph_id: string;
7592
+ /**
7593
+ * Statement Type
7594
+ */
7595
+ statement_type: string;
7596
+ /**
7597
+ * Periods
7598
+ */
7599
+ periods: Array<PeriodSpec>;
7600
+ /**
7601
+ * Facts
7602
+ */
7603
+ facts: Array<LiveStatementFactRow>;
7604
+ /**
7605
+ * Fact Count
7606
+ */
7607
+ fact_count: number;
7608
+ /**
7609
+ * Unmapped Count
7610
+ */
7611
+ unmapped_count?: number;
7612
+ /**
7613
+ * Truncated
7614
+ */
7615
+ truncated?: boolean;
7616
+ };
7617
+ /**
7618
+ * LiveStatementFactRow
7619
+ *
7620
+ * A single row of an OLTP-backed ad-hoc statement.
7621
+ */
7622
+ export type LiveStatementFactRow = {
7623
+ /**
7624
+ * Qname
7625
+ */
7626
+ qname: string;
7627
+ /**
7628
+ * Name
7629
+ */
7630
+ name: string;
7631
+ /**
7632
+ * Trait
7633
+ */
7634
+ trait?: string | null;
7635
+ /**
7636
+ * Values
7637
+ */
7638
+ values: Array<number | null>;
7639
+ /**
7640
+ * Depth
7641
+ */
7642
+ depth?: number;
7643
+ /**
7644
+ * Is Subtotal
7645
+ */
7646
+ is_subtotal?: boolean;
7647
+ };
7582
7648
  /**
7583
7649
  * LoginRequest
7584
7650
  *
@@ -7861,6 +7927,37 @@ export type OAuthCallbackRequest = {
7861
7927
  */
7862
7928
  error_description?: string | null;
7863
7929
  };
7930
+ /**
7931
+ * OAuthCallbackResponse
7932
+ *
7933
+ * Result of completing an OAuth authorization flow.
7934
+ */
7935
+ export type OAuthCallbackResponse = {
7936
+ /**
7937
+ * Success
7938
+ *
7939
+ * Whether the connection was established
7940
+ */
7941
+ success: boolean;
7942
+ /**
7943
+ * Message
7944
+ *
7945
+ * Human-readable outcome of the exchange
7946
+ */
7947
+ message: string;
7948
+ /**
7949
+ * Connection Id
7950
+ *
7951
+ * Connection the authorization was linked to
7952
+ */
7953
+ connection_id: string;
7954
+ /**
7955
+ * Auto Sync Task Id
7956
+ *
7957
+ * Task id of the initial sync started after connecting, or null when no sync was kicked off
7958
+ */
7959
+ auto_sync_task_id?: string | null;
7960
+ };
7864
7961
  /**
7865
7962
  * OAuthInitRequest
7866
7963
  *
@@ -9075,6 +9172,51 @@ export type OperationEnvelopeLedgerEntityResponse = {
9075
9172
  */
9076
9173
  idempotentReplay?: boolean;
9077
9174
  };
9175
+ /**
9176
+ * OperationEnvelope[LiveFinancialStatementResponse]
9177
+ */
9178
+ export type OperationEnvelopeLiveFinancialStatementResponse = {
9179
+ /**
9180
+ * Operation
9181
+ *
9182
+ * Kebab-case operation name
9183
+ */
9184
+ operation: string;
9185
+ /**
9186
+ * Operationid
9187
+ *
9188
+ * op_-prefixed ULID for audit and SSE correlation
9189
+ */
9190
+ operationId: string;
9191
+ /**
9192
+ * Status
9193
+ *
9194
+ * Operation lifecycle state
9195
+ */
9196
+ status: 'completed' | 'pending' | 'failed';
9197
+ /**
9198
+ * Command-specific result payload
9199
+ */
9200
+ result?: LiveFinancialStatementResponse | null;
9201
+ /**
9202
+ * At
9203
+ *
9204
+ * ISO-8601 UTC timestamp
9205
+ */
9206
+ at: string;
9207
+ /**
9208
+ * Createdby
9209
+ *
9210
+ * User ID that initiated the operation (null for legacy callers)
9211
+ */
9212
+ createdBy?: string | null;
9213
+ /**
9214
+ * Idempotentreplay
9215
+ *
9216
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9217
+ */
9218
+ idempotentReplay?: boolean;
9219
+ };
9078
9220
  /**
9079
9221
  * OperationEnvelope[PortfolioBlockEnvelope]
9080
9222
  */
@@ -17084,8 +17226,9 @@ export type OauthCallbackResponses = {
17084
17226
  /**
17085
17227
  * Successful Response
17086
17228
  */
17087
- 200: unknown;
17229
+ 200: OAuthCallbackResponse;
17088
17230
  };
17231
+ export type OauthCallbackResponse = OauthCallbackResponses[keyof OauthCallbackResponses];
17089
17232
  export type ListConnectionsData = {
17090
17233
  body?: never;
17091
17234
  path: {
@@ -24175,9 +24318,9 @@ export type LiveFinancialStatementResponses = {
24175
24318
  /**
24176
24319
  * Successful Response
24177
24320
  */
24178
- 200: OperationEnvelope;
24321
+ 200: OperationEnvelopeLiveFinancialStatementResponse;
24179
24322
  };
24180
- export type LiveFinancialStatementResponse = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
24323
+ export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
24181
24324
  export type BuildFactGridData = {
24182
24325
  body: CreateViewRequest;
24183
24326
  headers?: {
package/sdk/types.gen.ts CHANGED
@@ -529,7 +529,7 @@ export type BackupCreateRequest = {
529
529
  /**
530
530
  * Retention Days
531
531
  *
532
- * Retention period in days
532
+ * Retention period in days, further capped to the graph tier's maximum (7/30/90). 90 is the hard ceiling: the storage lifecycle expires backup objects then regardless of the requested value.
533
533
  */
534
534
  retention_days?: number;
535
535
  /**
@@ -5626,7 +5626,7 @@ export type GraphLimitsResponse = {
5626
5626
  /**
5627
5627
  * Subscription Tier
5628
5628
  *
5629
- * User's subscription tier
5629
+ * Rate-limit tier enforced for requests to this graph
5630
5630
  */
5631
5631
  subscription_tier: string;
5632
5632
  /**
@@ -6173,7 +6173,7 @@ export type GraphTierInstance = {
6173
6173
  /**
6174
6174
  * Memory Mb
6175
6175
  *
6176
- * Memory allocated to your graph in megabytes
6176
+ * LadybugDB memory budget for the whole instance in megabytes (below physical RAM after OS overhead; not a per-graph allocation)
6177
6177
  */
6178
6178
  memory_mb: number;
6179
6179
  /**
@@ -7649,7 +7649,7 @@ export type ListSubgraphsResponse = {
7649
7649
  /**
7650
7650
  * Subgraphs Enabled
7651
7651
  *
7652
- * Whether subgraphs are enabled for this tier (requires Large/XLarge tier)
7652
+ * Whether subgraphs are enabled for this tier
7653
7653
  */
7654
7654
  subgraphs_enabled: boolean;
7655
7655
  /**
@@ -7758,6 +7758,74 @@ export type LiveFinancialStatementRequest = {
7758
7758
  limit?: number;
7759
7759
  };
7760
7760
 
7761
+ /**
7762
+ * LiveFinancialStatementResponse
7763
+ *
7764
+ * Rendered OLTP-backed ad-hoc statement.
7765
+ */
7766
+ export type LiveFinancialStatementResponse = {
7767
+ /**
7768
+ * Graph Id
7769
+ */
7770
+ graph_id: string;
7771
+ /**
7772
+ * Statement Type
7773
+ */
7774
+ statement_type: string;
7775
+ /**
7776
+ * Periods
7777
+ */
7778
+ periods: Array<PeriodSpec>;
7779
+ /**
7780
+ * Facts
7781
+ */
7782
+ facts: Array<LiveStatementFactRow>;
7783
+ /**
7784
+ * Fact Count
7785
+ */
7786
+ fact_count: number;
7787
+ /**
7788
+ * Unmapped Count
7789
+ */
7790
+ unmapped_count?: number;
7791
+ /**
7792
+ * Truncated
7793
+ */
7794
+ truncated?: boolean;
7795
+ };
7796
+
7797
+ /**
7798
+ * LiveStatementFactRow
7799
+ *
7800
+ * A single row of an OLTP-backed ad-hoc statement.
7801
+ */
7802
+ export type LiveStatementFactRow = {
7803
+ /**
7804
+ * Qname
7805
+ */
7806
+ qname: string;
7807
+ /**
7808
+ * Name
7809
+ */
7810
+ name: string;
7811
+ /**
7812
+ * Trait
7813
+ */
7814
+ trait?: string | null;
7815
+ /**
7816
+ * Values
7817
+ */
7818
+ values: Array<number | null>;
7819
+ /**
7820
+ * Depth
7821
+ */
7822
+ depth?: number;
7823
+ /**
7824
+ * Is Subtotal
7825
+ */
7826
+ is_subtotal?: boolean;
7827
+ };
7828
+
7761
7829
  /**
7762
7830
  * LoginRequest
7763
7831
  *
@@ -8049,6 +8117,38 @@ export type OAuthCallbackRequest = {
8049
8117
  error_description?: string | null;
8050
8118
  };
8051
8119
 
8120
+ /**
8121
+ * OAuthCallbackResponse
8122
+ *
8123
+ * Result of completing an OAuth authorization flow.
8124
+ */
8125
+ export type OAuthCallbackResponse = {
8126
+ /**
8127
+ * Success
8128
+ *
8129
+ * Whether the connection was established
8130
+ */
8131
+ success: boolean;
8132
+ /**
8133
+ * Message
8134
+ *
8135
+ * Human-readable outcome of the exchange
8136
+ */
8137
+ message: string;
8138
+ /**
8139
+ * Connection Id
8140
+ *
8141
+ * Connection the authorization was linked to
8142
+ */
8143
+ connection_id: string;
8144
+ /**
8145
+ * Auto Sync Task Id
8146
+ *
8147
+ * Task id of the initial sync started after connecting, or null when no sync was kicked off
8148
+ */
8149
+ auto_sync_task_id?: string | null;
8150
+ };
8151
+
8052
8152
  /**
8053
8153
  * OAuthInitRequest
8054
8154
  *
@@ -9290,6 +9390,52 @@ export type OperationEnvelopeLedgerEntityResponse = {
9290
9390
  idempotentReplay?: boolean;
9291
9391
  };
9292
9392
 
9393
+ /**
9394
+ * OperationEnvelope[LiveFinancialStatementResponse]
9395
+ */
9396
+ export type OperationEnvelopeLiveFinancialStatementResponse = {
9397
+ /**
9398
+ * Operation
9399
+ *
9400
+ * Kebab-case operation name
9401
+ */
9402
+ operation: string;
9403
+ /**
9404
+ * Operationid
9405
+ *
9406
+ * op_-prefixed ULID for audit and SSE correlation
9407
+ */
9408
+ operationId: string;
9409
+ /**
9410
+ * Status
9411
+ *
9412
+ * Operation lifecycle state
9413
+ */
9414
+ status: 'completed' | 'pending' | 'failed';
9415
+ /**
9416
+ * Command-specific result payload
9417
+ */
9418
+ result?: LiveFinancialStatementResponse | null;
9419
+ /**
9420
+ * At
9421
+ *
9422
+ * ISO-8601 UTC timestamp
9423
+ */
9424
+ at: string;
9425
+ /**
9426
+ * Createdby
9427
+ *
9428
+ * User ID that initiated the operation (null for legacy callers)
9429
+ */
9430
+ createdBy?: string | null;
9431
+ /**
9432
+ * Idempotentreplay
9433
+ *
9434
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9435
+ */
9436
+ idempotentReplay?: boolean;
9437
+ };
9438
+
9293
9439
  /**
9294
9440
  * OperationEnvelope[PortfolioBlockEnvelope]
9295
9441
  */
@@ -17662,9 +17808,11 @@ export type OauthCallbackResponses = {
17662
17808
  /**
17663
17809
  * Successful Response
17664
17810
  */
17665
- 200: unknown;
17811
+ 200: OAuthCallbackResponse;
17666
17812
  };
17667
17813
 
17814
+ export type OauthCallbackResponse = OauthCallbackResponses[keyof OauthCallbackResponses];
17815
+
17668
17816
  export type ListConnectionsData = {
17669
17817
  body?: never;
17670
17818
  path: {
@@ -25377,10 +25525,10 @@ export type LiveFinancialStatementResponses = {
25377
25525
  /**
25378
25526
  * Successful Response
25379
25527
  */
25380
- 200: OperationEnvelope;
25528
+ 200: OperationEnvelopeLiveFinancialStatementResponse;
25381
25529
  };
25382
25530
 
25383
- export type LiveFinancialStatementResponse = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
25531
+ export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
25384
25532
 
25385
25533
  export type BuildFactGridData = {
25386
25534
  body: CreateViewRequest;
package/types.gen.d.ts CHANGED
@@ -511,7 +511,7 @@ export type BackupCreateRequest = {
511
511
  /**
512
512
  * Retention Days
513
513
  *
514
- * Retention period in days
514
+ * Retention period in days, further capped to the graph tier's maximum (7/30/90). 90 is the hard ceiling: the storage lifecycle expires backup objects then regardless of the requested value.
515
515
  */
516
516
  retention_days?: number;
517
517
  /**
@@ -5489,7 +5489,7 @@ export type GraphLimitsResponse = {
5489
5489
  /**
5490
5490
  * Subscription Tier
5491
5491
  *
5492
- * User's subscription tier
5492
+ * Rate-limit tier enforced for requests to this graph
5493
5493
  */
5494
5494
  subscription_tier: string;
5495
5495
  /**
@@ -6027,7 +6027,7 @@ export type GraphTierInstance = {
6027
6027
  /**
6028
6028
  * Memory Mb
6029
6029
  *
6030
- * Memory allocated to your graph in megabytes
6030
+ * LadybugDB memory budget for the whole instance in megabytes (below physical RAM after OS overhead; not a per-graph allocation)
6031
6031
  */
6032
6032
  memory_mb: number;
6033
6033
  /**
@@ -7473,7 +7473,7 @@ export type ListSubgraphsResponse = {
7473
7473
  /**
7474
7474
  * Subgraphs Enabled
7475
7475
  *
7476
- * Whether subgraphs are enabled for this tier (requires Large/XLarge tier)
7476
+ * Whether subgraphs are enabled for this tier
7477
7477
  */
7478
7478
  subgraphs_enabled: boolean;
7479
7479
  /**
@@ -7579,6 +7579,72 @@ export type LiveFinancialStatementRequest = {
7579
7579
  */
7580
7580
  limit?: number;
7581
7581
  };
7582
+ /**
7583
+ * LiveFinancialStatementResponse
7584
+ *
7585
+ * Rendered OLTP-backed ad-hoc statement.
7586
+ */
7587
+ export type LiveFinancialStatementResponse = {
7588
+ /**
7589
+ * Graph Id
7590
+ */
7591
+ graph_id: string;
7592
+ /**
7593
+ * Statement Type
7594
+ */
7595
+ statement_type: string;
7596
+ /**
7597
+ * Periods
7598
+ */
7599
+ periods: Array<PeriodSpec>;
7600
+ /**
7601
+ * Facts
7602
+ */
7603
+ facts: Array<LiveStatementFactRow>;
7604
+ /**
7605
+ * Fact Count
7606
+ */
7607
+ fact_count: number;
7608
+ /**
7609
+ * Unmapped Count
7610
+ */
7611
+ unmapped_count?: number;
7612
+ /**
7613
+ * Truncated
7614
+ */
7615
+ truncated?: boolean;
7616
+ };
7617
+ /**
7618
+ * LiveStatementFactRow
7619
+ *
7620
+ * A single row of an OLTP-backed ad-hoc statement.
7621
+ */
7622
+ export type LiveStatementFactRow = {
7623
+ /**
7624
+ * Qname
7625
+ */
7626
+ qname: string;
7627
+ /**
7628
+ * Name
7629
+ */
7630
+ name: string;
7631
+ /**
7632
+ * Trait
7633
+ */
7634
+ trait?: string | null;
7635
+ /**
7636
+ * Values
7637
+ */
7638
+ values: Array<number | null>;
7639
+ /**
7640
+ * Depth
7641
+ */
7642
+ depth?: number;
7643
+ /**
7644
+ * Is Subtotal
7645
+ */
7646
+ is_subtotal?: boolean;
7647
+ };
7582
7648
  /**
7583
7649
  * LoginRequest
7584
7650
  *
@@ -7861,6 +7927,37 @@ export type OAuthCallbackRequest = {
7861
7927
  */
7862
7928
  error_description?: string | null;
7863
7929
  };
7930
+ /**
7931
+ * OAuthCallbackResponse
7932
+ *
7933
+ * Result of completing an OAuth authorization flow.
7934
+ */
7935
+ export type OAuthCallbackResponse = {
7936
+ /**
7937
+ * Success
7938
+ *
7939
+ * Whether the connection was established
7940
+ */
7941
+ success: boolean;
7942
+ /**
7943
+ * Message
7944
+ *
7945
+ * Human-readable outcome of the exchange
7946
+ */
7947
+ message: string;
7948
+ /**
7949
+ * Connection Id
7950
+ *
7951
+ * Connection the authorization was linked to
7952
+ */
7953
+ connection_id: string;
7954
+ /**
7955
+ * Auto Sync Task Id
7956
+ *
7957
+ * Task id of the initial sync started after connecting, or null when no sync was kicked off
7958
+ */
7959
+ auto_sync_task_id?: string | null;
7960
+ };
7864
7961
  /**
7865
7962
  * OAuthInitRequest
7866
7963
  *
@@ -9075,6 +9172,51 @@ export type OperationEnvelopeLedgerEntityResponse = {
9075
9172
  */
9076
9173
  idempotentReplay?: boolean;
9077
9174
  };
9175
+ /**
9176
+ * OperationEnvelope[LiveFinancialStatementResponse]
9177
+ */
9178
+ export type OperationEnvelopeLiveFinancialStatementResponse = {
9179
+ /**
9180
+ * Operation
9181
+ *
9182
+ * Kebab-case operation name
9183
+ */
9184
+ operation: string;
9185
+ /**
9186
+ * Operationid
9187
+ *
9188
+ * op_-prefixed ULID for audit and SSE correlation
9189
+ */
9190
+ operationId: string;
9191
+ /**
9192
+ * Status
9193
+ *
9194
+ * Operation lifecycle state
9195
+ */
9196
+ status: 'completed' | 'pending' | 'failed';
9197
+ /**
9198
+ * Command-specific result payload
9199
+ */
9200
+ result?: LiveFinancialStatementResponse | null;
9201
+ /**
9202
+ * At
9203
+ *
9204
+ * ISO-8601 UTC timestamp
9205
+ */
9206
+ at: string;
9207
+ /**
9208
+ * Createdby
9209
+ *
9210
+ * User ID that initiated the operation (null for legacy callers)
9211
+ */
9212
+ createdBy?: string | null;
9213
+ /**
9214
+ * Idempotentreplay
9215
+ *
9216
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
9217
+ */
9218
+ idempotentReplay?: boolean;
9219
+ };
9078
9220
  /**
9079
9221
  * OperationEnvelope[PortfolioBlockEnvelope]
9080
9222
  */
@@ -17084,8 +17226,9 @@ export type OauthCallbackResponses = {
17084
17226
  /**
17085
17227
  * Successful Response
17086
17228
  */
17087
- 200: unknown;
17229
+ 200: OAuthCallbackResponse;
17088
17230
  };
17231
+ export type OauthCallbackResponse = OauthCallbackResponses[keyof OauthCallbackResponses];
17089
17232
  export type ListConnectionsData = {
17090
17233
  body?: never;
17091
17234
  path: {
@@ -24175,9 +24318,9 @@ export type LiveFinancialStatementResponses = {
24175
24318
  /**
24176
24319
  * Successful Response
24177
24320
  */
24178
- 200: OperationEnvelope;
24321
+ 200: OperationEnvelopeLiveFinancialStatementResponse;
24179
24322
  };
24180
- export type LiveFinancialStatementResponse = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
24323
+ export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
24181
24324
  export type BuildFactGridData = {
24182
24325
  body: CreateViewRequest;
24183
24326
  headers?: {