@robosystems/client 2.9.2 → 2.10.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.d.ts CHANGED
@@ -263,7 +263,7 @@ export type AssertMetricsRequest = {
263
263
  /**
264
264
  * Entity Id
265
265
  *
266
- * Entity to assert for. Defaults to the graph's earliest-created entity (the primary entity for single-entity graphs).
266
+ * The entity the asserted values belong to, by id. Omit for the group parent.
267
267
  */
268
268
  entity_id?: string | null;
269
269
  /**
@@ -1141,7 +1141,7 @@ export type BindTextBlockRequest = {
1141
1141
  /**
1142
1142
  * Entity Id
1143
1143
  *
1144
- * Entity the fact belongs to; defaults to the primary entity.
1144
+ * Entity the fact belongs to, by id; omit for the group parent.
1145
1145
  */
1146
1146
  entity_id?: string | null;
1147
1147
  };
@@ -1366,7 +1366,7 @@ export type ChangeReportingStyleRequest = {
1366
1366
  /**
1367
1367
  * Entity Id
1368
1368
  *
1369
- * Target entity. Omit to target the graph's primary (earliest-created) entity — the single-entity default.
1369
+ * The entity whose style to change, by id. Omit for the group parent.
1370
1370
  */
1371
1371
  entity_id?: string | null;
1372
1372
  };
@@ -1914,7 +1914,7 @@ export type ComputeMetricsRequest = {
1914
1914
  /**
1915
1915
  * Entity Id
1916
1916
  *
1917
- * Entity to compute for. Defaults to the graph's earliest-created entity (the primary entity for single-entity graphs).
1917
+ * The entity whose metrics to compute, by id. Omit for the group parent.
1918
1918
  */
1919
1919
  entity_id?: string | null;
1920
1920
  /**
@@ -2917,7 +2917,7 @@ export type CreateForecastRequest = {
2917
2917
  /**
2918
2918
  * Entity Id
2919
2919
  *
2920
- * Entity the scenario belongs to. Defaults to the graph's earliest-created entity (single-entity convention).
2920
+ * The entity the scenario belongs to, by id: its history and its computed months are that entity's books. Omit for the group parent.
2921
2921
  */
2922
2922
  entity_id?: string | null;
2923
2923
  };
@@ -3246,6 +3246,12 @@ export type CreateScheduleRequest = {
3246
3246
  * Schedule name
3247
3247
  */
3248
3248
  name: string;
3249
+ /**
3250
+ * Entity Id
3251
+ *
3252
+ * The entity whose books the schedule belongs to, by id. Omit for the group parent. Its facts, obligations and closing entries land in that entity's books, against that entity's own accounts.
3253
+ */
3254
+ entity_id?: string | null;
3249
3255
  /**
3250
3256
  * Taxonomy Id
3251
3257
  *
@@ -7544,6 +7550,12 @@ export type InformationBlockEnvelope = {
7544
7550
  * Qname of the named Disclosure this block corresponds to (e.g., 'disclosures:BalanceSheet'), when an inbound reportedDisclosure-requiresDisclosure arc identifies one. Null for tenant-authored blocks without a Disclosure mapping.
7545
7551
  */
7546
7552
  disclosure_id?: string | null;
7553
+ /**
7554
+ * Entity Id
7555
+ *
7556
+ * The entity whose books the envelope reads. A schedule, reconciliation or forecast is one entity's own and always reads its owner's; a block shared by the group (statements, metrics) reads the entity asked for, else the group parent. Null on the library and on a graph with no entity yet.
7557
+ */
7558
+ entity_id?: string | null;
7547
7559
  information_model: InformationModelResponse;
7548
7560
  artifact: ArtifactResponse;
7549
7561
  /**
package/types.gen.ts CHANGED
@@ -273,7 +273,7 @@ export type AssertMetricsRequest = {
273
273
  /**
274
274
  * Entity Id
275
275
  *
276
- * Entity to assert for. Defaults to the graph's earliest-created entity (the primary entity for single-entity graphs).
276
+ * The entity the asserted values belong to, by id. Omit for the group parent.
277
277
  */
278
278
  entity_id?: string | null;
279
279
  /**
@@ -1172,7 +1172,7 @@ export type BindTextBlockRequest = {
1172
1172
  /**
1173
1173
  * Entity Id
1174
1174
  *
1175
- * Entity the fact belongs to; defaults to the primary entity.
1175
+ * Entity the fact belongs to, by id; omit for the group parent.
1176
1176
  */
1177
1177
  entity_id?: string | null;
1178
1178
  };
@@ -1404,7 +1404,7 @@ export type ChangeReportingStyleRequest = {
1404
1404
  /**
1405
1405
  * Entity Id
1406
1406
  *
1407
- * Target entity. Omit to target the graph's primary (earliest-created) entity — the single-entity default.
1407
+ * The entity whose style to change, by id. Omit for the group parent.
1408
1408
  */
1409
1409
  entity_id?: string | null;
1410
1410
  };
@@ -1965,7 +1965,7 @@ export type ComputeMetricsRequest = {
1965
1965
  /**
1966
1966
  * Entity Id
1967
1967
  *
1968
- * Entity to compute for. Defaults to the graph's earliest-created entity (the primary entity for single-entity graphs).
1968
+ * The entity whose metrics to compute, by id. Omit for the group parent.
1969
1969
  */
1970
1970
  entity_id?: string | null;
1971
1971
  /**
@@ -2985,7 +2985,7 @@ export type CreateForecastRequest = {
2985
2985
  /**
2986
2986
  * Entity Id
2987
2987
  *
2988
- * Entity the scenario belongs to. Defaults to the graph's earliest-created entity (single-entity convention).
2988
+ * The entity the scenario belongs to, by id: its history and its computed months are that entity's books. Omit for the group parent.
2989
2989
  */
2990
2990
  entity_id?: string | null;
2991
2991
  };
@@ -3324,6 +3324,12 @@ export type CreateScheduleRequest = {
3324
3324
  * Schedule name
3325
3325
  */
3326
3326
  name: string;
3327
+ /**
3328
+ * Entity Id
3329
+ *
3330
+ * The entity whose books the schedule belongs to, by id. Omit for the group parent. Its facts, obligations and closing entries land in that entity's books, against that entity's own accounts.
3331
+ */
3332
+ entity_id?: string | null;
3327
3333
  /**
3328
3334
  * Taxonomy Id
3329
3335
  *
@@ -7722,6 +7728,12 @@ export type InformationBlockEnvelope = {
7722
7728
  * Qname of the named Disclosure this block corresponds to (e.g., 'disclosures:BalanceSheet'), when an inbound reportedDisclosure-requiresDisclosure arc identifies one. Null for tenant-authored blocks without a Disclosure mapping.
7723
7729
  */
7724
7730
  disclosure_id?: string | null;
7731
+ /**
7732
+ * Entity Id
7733
+ *
7734
+ * The entity whose books the envelope reads. A schedule, reconciliation or forecast is one entity's own and always reads its owner's; a block shared by the group (statements, metrics) reads the entity asked for, else the group parent. Null on the library and on a graph with no entity yet.
7735
+ */
7736
+ entity_id?: string | null;
7725
7737
  information_model: InformationModelResponse;
7726
7738
  artifact: ArtifactResponse;
7727
7739
  /**