@robosystems/client 1.8.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.
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  [![npm version](https://badge.fury.io/js/@robosystems%2Fclient.svg)](https://www.npmjs.com/package/@robosystems/client)
4
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
5
 
6
- Official TypeScript Client for the RoboSystems Financial Knowledge Graph API. Access comprehensive financial data including accounting transactions, financial reports, and advanced graph analytics through a type-safe, modern TypeScript interface.
6
+ Official TypeScript client for the RoboSystems financial intelligence platform — accounting, financial reporting, and investment management over a knowledge graph API. Type-safe and modern, generated from the OpenAPI spec, with GraphQL reads and idempotent operation writes.
7
7
 
8
8
  ## Features
9
9
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "1.8.0",
4
- "description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
3
+ "version": "1.8.1",
4
+ "description": "TypeScript client library for the RoboSystems financial intelligence platform",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "bin": {
package/sdk/sdk.gen.d.ts CHANGED
@@ -272,7 +272,7 @@ export declare const listOperators: <ThrowOnError extends boolean = false>(optio
272
272
  /**
273
273
  * Auto-select Operator for Query
274
274
  *
275
- * Routes to the best operator for your query. Operators: `financial` (SEC, accounting), `research` (deep analysis), `rag` (knowledge base, free). Credit cost by mode: `quick` 5-10, `standard` 15-25, `extended` 30-75. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
275
+ * Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
276
276
  */
277
277
  export declare const autoSelectOperator: <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => import("./client").RequestResult<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError, "fields">;
278
278
  /**
@@ -282,7 +282,7 @@ export declare const getOperatorMetadata: <ThrowOnError extends boolean = false>
282
282
  /**
283
283
  * Execute Specific Operator
284
284
  *
285
- * Available: `financial` (SEC filings, accounting), `research` (deep analysis), `rag` (retrieval, no credits). Execution strategy auto-selected; override with `?mode=sync|async`.
285
+ * Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Execution strategy auto-selected; override with `?mode=sync|async`.
286
286
  */
287
287
  export declare const executeSpecificOperator: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => import("./client").RequestResult<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError, "fields">;
288
288
  /**
package/sdk/sdk.gen.js CHANGED
@@ -537,7 +537,7 @@ exports.listOperators = listOperators;
537
537
  /**
538
538
  * Auto-select Operator for Query
539
539
  *
540
- * Routes to the best operator for your query. Operators: `financial` (SEC, accounting), `research` (deep analysis), `rag` (knowledge base, free). Credit cost by mode: `quick` 5-10, `standard` 15-25, `extended` 30-75. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
540
+ * Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
541
541
  */
542
542
  const autoSelectOperator = (options) => (options.client ?? client_gen_1.client).post({
543
543
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -561,7 +561,7 @@ exports.getOperatorMetadata = getOperatorMetadata;
561
561
  /**
562
562
  * Execute Specific Operator
563
563
  *
564
- * Available: `financial` (SEC filings, accounting), `research` (deep analysis), `rag` (retrieval, no credits). Execution strategy auto-selected; override with `?mode=sync|async`.
564
+ * Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Execution strategy auto-selected; override with `?mode=sync|async`.
565
565
  */
566
566
  const executeSpecificOperator = (options) => (options.client ?? client_gen_1.client).post({
567
567
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
package/sdk/sdk.gen.ts CHANGED
@@ -549,7 +549,7 @@ export const listOperators = <ThrowOnError extends boolean = false>(options: Opt
549
549
  /**
550
550
  * Auto-select Operator for Query
551
551
  *
552
- * Routes to the best operator for your query. Operators: `financial` (SEC, accounting), `research` (deep analysis), `rag` (knowledge base, free). Credit cost by mode: `quick` 5-10, `standard` 15-25, `extended` 30-75. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
552
+ * Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
553
553
  */
554
554
  export const autoSelectOperator = <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => (options.client ?? client).post<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>({
555
555
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -573,7 +573,7 @@ export const getOperatorMetadata = <ThrowOnError extends boolean = false>(option
573
573
  /**
574
574
  * Execute Specific Operator
575
575
  *
576
- * Available: `financial` (SEC filings, accounting), `research` (deep analysis), `rag` (retrieval, no credits). Execution strategy auto-selected; override with `?mode=sync|async`.
576
+ * Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Execution strategy auto-selected; override with `?mode=sync|async`.
577
577
  */
578
578
  export const executeSpecificOperator = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => (options.client ?? client).post<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>({
579
579
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -1167,6 +1167,12 @@ export type BlockSourceGraphResult = {
1167
1167
  * Number of previously-shared reports deleted from this graph. Zero unless `purge` was set.
1168
1168
  */
1169
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>;
1170
1176
  };
1171
1177
  /**
1172
1178
  * BlockedSourceGraphResponse
@@ -8216,7 +8222,7 @@ export type LiveFinancialStatementRequest = {
8216
8222
  /**
8217
8223
  * Statement Type
8218
8224
  *
8219
- * income_statement | balance_sheet | equity_statement
8225
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement
8220
8226
  */
8221
8227
  statement_type: string;
8222
8228
  /**
@@ -13913,9 +13919,11 @@ export type SqlStatementRequest = {
13913
13919
  /**
13914
13920
  * Parameters
13915
13921
  *
13916
- * 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.
13917
13923
  */
13918
- parameters?: Array<unknown> | null;
13924
+ parameters?: Array<unknown> | {
13925
+ [key: string]: unknown;
13926
+ } | null;
13919
13927
  };
13920
13928
  /**
13921
13929
  * SqlStatementResponse
package/sdk/types.gen.ts CHANGED
@@ -1200,6 +1200,12 @@ export type BlockSourceGraphResult = {
1200
1200
  * Number of previously-shared reports deleted from this graph. Zero unless `purge` was set.
1201
1201
  */
1202
1202
  purged_report_count?: number;
1203
+ /**
1204
+ * Purged Report Ids
1205
+ *
1206
+ * Ids of the previously-shared reports deleted from this graph. Empty unless `purge` was set.
1207
+ */
1208
+ purged_report_ids?: Array<string>;
1203
1209
  };
1204
1210
 
1205
1211
  /**
@@ -8412,7 +8418,7 @@ export type LiveFinancialStatementRequest = {
8412
8418
  /**
8413
8419
  * Statement Type
8414
8420
  *
8415
- * income_statement | balance_sheet | equity_statement
8421
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement
8416
8422
  */
8417
8423
  statement_type: string;
8418
8424
  /**
@@ -14259,9 +14265,11 @@ export type SqlStatementRequest = {
14259
14265
  /**
14260
14266
  * Parameters
14261
14267
  *
14262
- * Query parameters for safe value substitution. ALWAYS use parameters instead of string concatenation.
14268
+ * 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.
14263
14269
  */
14264
- parameters?: Array<unknown> | null;
14270
+ parameters?: Array<unknown> | {
14271
+ [key: string]: unknown;
14272
+ } | null;
14265
14273
  };
14266
14274
 
14267
14275
  /**
package/sdk.gen.d.ts CHANGED
@@ -272,7 +272,7 @@ export declare const listOperators: <ThrowOnError extends boolean = false>(optio
272
272
  /**
273
273
  * Auto-select Operator for Query
274
274
  *
275
- * Routes to the best operator for your query. Operators: `financial` (SEC, accounting), `research` (deep analysis), `rag` (knowledge base, free). Credit cost by mode: `quick` 5-10, `standard` 15-25, `extended` 30-75. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
275
+ * Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
276
276
  */
277
277
  export declare const autoSelectOperator: <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => import("./client").RequestResult<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError, "fields">;
278
278
  /**
@@ -282,7 +282,7 @@ export declare const getOperatorMetadata: <ThrowOnError extends boolean = false>
282
282
  /**
283
283
  * Execute Specific Operator
284
284
  *
285
- * Available: `financial` (SEC filings, accounting), `research` (deep analysis), `rag` (retrieval, no credits). Execution strategy auto-selected; override with `?mode=sync|async`.
285
+ * Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Execution strategy auto-selected; override with `?mode=sync|async`.
286
286
  */
287
287
  export declare const executeSpecificOperator: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => import("./client").RequestResult<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError, "fields">;
288
288
  /**
package/sdk.gen.js CHANGED
@@ -537,7 +537,7 @@ exports.listOperators = listOperators;
537
537
  /**
538
538
  * Auto-select Operator for Query
539
539
  *
540
- * Routes to the best operator for your query. Operators: `financial` (SEC, accounting), `research` (deep analysis), `rag` (knowledge base, free). Credit cost by mode: `quick` 5-10, `standard` 15-25, `extended` 30-75. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
540
+ * Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
541
541
  */
542
542
  const autoSelectOperator = (options) => (options.client ?? client_gen_1.client).post({
543
543
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -561,7 +561,7 @@ exports.getOperatorMetadata = getOperatorMetadata;
561
561
  /**
562
562
  * Execute Specific Operator
563
563
  *
564
- * Available: `financial` (SEC filings, accounting), `research` (deep analysis), `rag` (retrieval, no credits). Execution strategy auto-selected; override with `?mode=sync|async`.
564
+ * Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Execution strategy auto-selected; override with `?mode=sync|async`.
565
565
  */
566
566
  const executeSpecificOperator = (options) => (options.client ?? client_gen_1.client).post({
567
567
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
package/sdk.gen.ts CHANGED
@@ -549,7 +549,7 @@ export const listOperators = <ThrowOnError extends boolean = false>(options: Opt
549
549
  /**
550
550
  * Auto-select Operator for Query
551
551
  *
552
- * Routes to the best operator for your query. Operators: `financial` (SEC, accounting), `research` (deep analysis), `rag` (knowledge base, free). Credit cost by mode: `quick` 5-10, `standard` 15-25, `extended` 30-75. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
552
+ * Routes to the best operator for your query. Operators: `cypher` (answers natural-language questions by querying the graph; supports `quick`, `standard`, `extended`) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. Execution strategy (sync/SSE/async) auto-selected; override with `?mode=sync|async`.
553
553
  */
554
554
  export const autoSelectOperator = <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => (options.client ?? client).post<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>({
555
555
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -573,7 +573,7 @@ export const getOperatorMetadata = <ThrowOnError extends boolean = false>(option
573
573
  /**
574
574
  * Execute Specific Operator
575
575
  *
576
- * Available: `financial` (SEC filings, accounting), `research` (deep analysis), `rag` (retrieval, no credits). Execution strategy auto-selected; override with `?mode=sync|async`.
576
+ * Available: `cypher` (natural-language questions answered by querying the graph; RAG retrieval is one of its capabilities, not a separate operator) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Execution strategy auto-selected; override with `?mode=sync|async`.
577
577
  */
578
578
  export const executeSpecificOperator = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => (options.client ?? client).post<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>({
579
579
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
package/types.gen.d.ts CHANGED
@@ -1167,6 +1167,12 @@ export type BlockSourceGraphResult = {
1167
1167
  * Number of previously-shared reports deleted from this graph. Zero unless `purge` was set.
1168
1168
  */
1169
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>;
1170
1176
  };
1171
1177
  /**
1172
1178
  * BlockedSourceGraphResponse
@@ -8216,7 +8222,7 @@ export type LiveFinancialStatementRequest = {
8216
8222
  /**
8217
8223
  * Statement Type
8218
8224
  *
8219
- * income_statement | balance_sheet | equity_statement
8225
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement
8220
8226
  */
8221
8227
  statement_type: string;
8222
8228
  /**
@@ -13913,9 +13919,11 @@ export type SqlStatementRequest = {
13913
13919
  /**
13914
13920
  * Parameters
13915
13921
  *
13916
- * 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.
13917
13923
  */
13918
- parameters?: Array<unknown> | null;
13924
+ parameters?: Array<unknown> | {
13925
+ [key: string]: unknown;
13926
+ } | null;
13919
13927
  };
13920
13928
  /**
13921
13929
  * SqlStatementResponse
package/types.gen.ts CHANGED
@@ -1200,6 +1200,12 @@ export type BlockSourceGraphResult = {
1200
1200
  * Number of previously-shared reports deleted from this graph. Zero unless `purge` was set.
1201
1201
  */
1202
1202
  purged_report_count?: number;
1203
+ /**
1204
+ * Purged Report Ids
1205
+ *
1206
+ * Ids of the previously-shared reports deleted from this graph. Empty unless `purge` was set.
1207
+ */
1208
+ purged_report_ids?: Array<string>;
1203
1209
  };
1204
1210
 
1205
1211
  /**
@@ -8412,7 +8418,7 @@ export type LiveFinancialStatementRequest = {
8412
8418
  /**
8413
8419
  * Statement Type
8414
8420
  *
8415
- * income_statement | balance_sheet | equity_statement
8421
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement
8416
8422
  */
8417
8423
  statement_type: string;
8418
8424
  /**
@@ -14259,9 +14265,11 @@ export type SqlStatementRequest = {
14259
14265
  /**
14260
14266
  * Parameters
14261
14267
  *
14262
- * Query parameters for safe value substitution. ALWAYS use parameters instead of string concatenation.
14268
+ * 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.
14263
14269
  */
14264
- parameters?: Array<unknown> | null;
14270
+ parameters?: Array<unknown> | {
14271
+ [key: string]: unknown;
14272
+ } | null;
14265
14273
  };
14266
14274
 
14267
14275
  /**