@robosystems/client 0.3.22 → 0.3.24
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/artifacts/LedgerClient.d.ts +14 -0
- package/artifacts/LedgerClient.js +3 -0
- package/artifacts/LedgerClient.ts +26 -0
- package/artifacts/graphql/generated/graphql.d.ts +92 -1
- package/artifacts/graphql/generated/graphql.ts +96 -1
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +4 -3
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +9 -1
- package/sdk/sdk.gen.js +20 -3
- package/sdk/sdk.gen.ts +18 -1
- package/sdk/types.gen.d.ts +172 -12
- package/sdk/types.gen.ts +179 -12
- package/sdk.gen.d.ts +9 -1
- package/sdk.gen.js +20 -3
- package/sdk.gen.ts +18 -1
- package/types.gen.d.ts +172 -12
- package/types.gen.ts +179 -12
package/types.gen.ts
CHANGED
|
@@ -1054,6 +1054,28 @@ export type CancelSubscriptionRequest = {
|
|
|
1054
1054
|
confirm?: string | null;
|
|
1055
1055
|
};
|
|
1056
1056
|
|
|
1057
|
+
/**
|
|
1058
|
+
* ChangeReportingStyleOp
|
|
1059
|
+
*
|
|
1060
|
+
* Body for the change-reporting-style operation (Phase 2 of §3.2).
|
|
1061
|
+
*
|
|
1062
|
+
* Switches the graph to a different Reporting Style. The target Style
|
|
1063
|
+
* must be a library- or customer-authored Structure with
|
|
1064
|
+
* ``structure_type='reporting_style'`` and a complete composition
|
|
1065
|
+
* (one Network per required statement type — BS / IS / CF / SE). Filed
|
|
1066
|
+
* Reports are unaffected because each ``Report`` already pins its own
|
|
1067
|
+
* ``structure_id`` per FactSet at create-time; new reports use the new
|
|
1068
|
+
* Style. Idempotent on the same target id.
|
|
1069
|
+
*/
|
|
1070
|
+
export type ChangeReportingStyleOp = {
|
|
1071
|
+
/**
|
|
1072
|
+
* Reporting Style Id
|
|
1073
|
+
*
|
|
1074
|
+
* Structure id of the target Reporting Style (e.g., `025f5d48-12ce-5d65-b9eb-4f137a10ef06` for the library-seeded Default Style). Must resolve to a Structure with structure_type='reporting_style' that has a complete composition in the graph's tenant schema.
|
|
1075
|
+
*/
|
|
1076
|
+
reporting_style_id: string;
|
|
1077
|
+
};
|
|
1078
|
+
|
|
1057
1079
|
/**
|
|
1058
1080
|
* ChangeTierOp
|
|
1059
1081
|
*
|
|
@@ -1249,6 +1271,20 @@ export type ClosePeriodResponse = {
|
|
|
1249
1271
|
* Whether close_target was auto-advanced because it was reached
|
|
1250
1272
|
*/
|
|
1251
1273
|
target_auto_advanced?: boolean;
|
|
1274
|
+
/**
|
|
1275
|
+
* Rule Summary
|
|
1276
|
+
*
|
|
1277
|
+
* Aggregated rule-eval outcome across every schedule Structure with facts in the closed period — keys: pass/fail/error/skipped. None when no schedules had facts in the period (§3.8 auto-run on close).
|
|
1278
|
+
*/
|
|
1279
|
+
rule_summary?: {
|
|
1280
|
+
[key: string]: number;
|
|
1281
|
+
} | null;
|
|
1282
|
+
/**
|
|
1283
|
+
* Evaluated Structure Ids
|
|
1284
|
+
*
|
|
1285
|
+
* ids of schedule Structures whose rules were evaluated during the close. Pairs with rule_summary.
|
|
1286
|
+
*/
|
|
1287
|
+
evaluated_structure_ids?: Array<string>;
|
|
1252
1288
|
};
|
|
1253
1289
|
|
|
1254
1290
|
/**
|
|
@@ -2002,7 +2038,7 @@ export type CreateGraphRequest = {
|
|
|
2002
2038
|
export type CreateInformationBlockRequest = ({
|
|
2003
2039
|
block_type: 'schedule';
|
|
2004
2040
|
} & CreateScheduleArm) | ({
|
|
2005
|
-
block_type: 'balance_sheet' | 'cash_flow_statement' | 'equity_statement' | 'income_statement' | 'metric';
|
|
2041
|
+
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric';
|
|
2006
2042
|
} & CreateLegacyArm);
|
|
2007
2043
|
|
|
2008
2044
|
/**
|
|
@@ -3018,7 +3054,7 @@ export type DeleteGraphOp = {
|
|
|
3018
3054
|
export type DeleteInformationBlockRequest = ({
|
|
3019
3055
|
block_type: 'schedule';
|
|
3020
3056
|
} & DeleteScheduleArm) | ({
|
|
3021
|
-
block_type: 'balance_sheet' | 'cash_flow_statement' | 'equity_statement' | 'income_statement' | 'metric';
|
|
3057
|
+
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric';
|
|
3022
3058
|
} & DeleteLegacyArm);
|
|
3023
3059
|
|
|
3024
3060
|
/**
|
|
@@ -4326,6 +4362,14 @@ export type FactLite = {
|
|
|
4326
4362
|
* Element Id
|
|
4327
4363
|
*/
|
|
4328
4364
|
element_id: string;
|
|
4365
|
+
/**
|
|
4366
|
+
* Element Name
|
|
4367
|
+
*/
|
|
4368
|
+
element_name?: string | null;
|
|
4369
|
+
/**
|
|
4370
|
+
* Element Qname
|
|
4371
|
+
*/
|
|
4372
|
+
element_qname?: string | null;
|
|
4329
4373
|
/**
|
|
4330
4374
|
* Value
|
|
4331
4375
|
*/
|
|
@@ -4681,9 +4725,33 @@ export type FiscalCalendarResponse = {
|
|
|
4681
4725
|
/**
|
|
4682
4726
|
* Blockers
|
|
4683
4727
|
*
|
|
4684
|
-
* Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed'
|
|
4728
|
+
* Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations'
|
|
4685
4729
|
*/
|
|
4686
4730
|
blockers?: Array<string>;
|
|
4731
|
+
/**
|
|
4732
|
+
* Pending Obligation Count
|
|
4733
|
+
*
|
|
4734
|
+
* Number of pending schedule_entry_due events blocking close. Non-zero only when `pending_obligations` is in `blockers`.
|
|
4735
|
+
*/
|
|
4736
|
+
pending_obligation_count?: number;
|
|
4737
|
+
/**
|
|
4738
|
+
* Pending Obligation Sample
|
|
4739
|
+
*
|
|
4740
|
+
* Sample of up to 5 pending obligations (schedule_id, schedule_name, period, event_id) ordered by occurred_at. Use `list-event-blocks` with event_type=schedule_entry_due&status=pending for the full set.
|
|
4741
|
+
*/
|
|
4742
|
+
pending_obligation_sample?: Array<PendingObligationDetailResponse>;
|
|
4743
|
+
/**
|
|
4744
|
+
* Earliest Pending Period
|
|
4745
|
+
*
|
|
4746
|
+
* Earliest period (YYYY-MM) with a pending obligation blocking close. Null when no pending_obligations blocker is active.
|
|
4747
|
+
*/
|
|
4748
|
+
earliest_pending_period?: string | null;
|
|
4749
|
+
/**
|
|
4750
|
+
* Sync Stale Days
|
|
4751
|
+
*
|
|
4752
|
+
* Days the most recent sync is stale relative to the period to close. Populated only when `sync_stale` is in `blockers` and last_sync_at exists (null when there's a connection but no sync has ever run).
|
|
4753
|
+
*/
|
|
4754
|
+
sync_stale_days?: number | null;
|
|
4687
4755
|
/**
|
|
4688
4756
|
* Last Close At
|
|
4689
4757
|
*/
|
|
@@ -5668,6 +5736,12 @@ export type InformationBlockEnvelope = {
|
|
|
5668
5736
|
* Display name of the source taxonomy.
|
|
5669
5737
|
*/
|
|
5670
5738
|
taxonomy_name?: string | null;
|
|
5739
|
+
/**
|
|
5740
|
+
* Disclosure Id
|
|
5741
|
+
*
|
|
5742
|
+
* 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.
|
|
5743
|
+
*/
|
|
5744
|
+
disclosure_id?: string | null;
|
|
5671
5745
|
information_model: InformationModelResponse;
|
|
5672
5746
|
artifact: ArtifactResponse;
|
|
5673
5747
|
/**
|
|
@@ -8573,6 +8647,35 @@ export type PaymentMethod = {
|
|
|
8573
8647
|
is_default: boolean;
|
|
8574
8648
|
};
|
|
8575
8649
|
|
|
8650
|
+
/**
|
|
8651
|
+
* PendingObligationDetailResponse
|
|
8652
|
+
*
|
|
8653
|
+
* One pending schedule-derived obligation blocking close.
|
|
8654
|
+
*
|
|
8655
|
+
* Surfaced on `FiscalCalendarResponse` when `pending_obligations` is in
|
|
8656
|
+
* the blockers list so callers can name which schedules to promote.
|
|
8657
|
+
*/
|
|
8658
|
+
export type PendingObligationDetailResponse = {
|
|
8659
|
+
/**
|
|
8660
|
+
* Event Id
|
|
8661
|
+
*/
|
|
8662
|
+
event_id: string;
|
|
8663
|
+
/**
|
|
8664
|
+
* Schedule Id
|
|
8665
|
+
*/
|
|
8666
|
+
schedule_id?: string | null;
|
|
8667
|
+
/**
|
|
8668
|
+
* Schedule Name
|
|
8669
|
+
*/
|
|
8670
|
+
schedule_name?: string | null;
|
|
8671
|
+
/**
|
|
8672
|
+
* Period
|
|
8673
|
+
*
|
|
8674
|
+
* Period in YYYY-MM format
|
|
8675
|
+
*/
|
|
8676
|
+
period: string;
|
|
8677
|
+
};
|
|
8678
|
+
|
|
8576
8679
|
/**
|
|
8577
8680
|
* PerformanceInsights
|
|
8578
8681
|
*
|
|
@@ -12405,7 +12508,7 @@ export type UpdateEventHandlerRequest = {
|
|
|
12405
12508
|
export type UpdateInformationBlockRequest = ({
|
|
12406
12509
|
block_type: 'schedule';
|
|
12407
12510
|
} & UpdateScheduleArm) | ({
|
|
12408
|
-
block_type: 'balance_sheet' | 'cash_flow_statement' | 'equity_statement' | 'income_statement' | 'metric';
|
|
12511
|
+
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric';
|
|
12409
12512
|
} & UpdateLegacyArm);
|
|
12410
12513
|
|
|
12411
12514
|
/**
|
|
@@ -13050,11 +13153,11 @@ export type ViewProjections = {
|
|
|
13050
13153
|
* a typed construction path at the API boundary.
|
|
13051
13154
|
*
|
|
13052
13155
|
* Statement-family blocks (balance_sheet, income_statement,
|
|
13053
|
-
* cash_flow_statement, equity_statement) are
|
|
13054
|
-
* `create-report`, not this endpoint. Metric blocks
|
|
13055
|
-
* but their evaluator has not shipped. Calling this
|
|
13056
|
-
* of these block types returns HTTP 501 with a hint
|
|
13057
|
-
* correct construction path.
|
|
13156
|
+
* cash_flow_statement, equity_statement, comprehensive_income) are
|
|
13157
|
+
* constructed via `create-report`, not this endpoint. Metric blocks
|
|
13158
|
+
* are recognized but their evaluator has not shipped. Calling this
|
|
13159
|
+
* endpoint with one of these block types returns HTTP 501 with a hint
|
|
13160
|
+
* pointing to the correct construction path.
|
|
13058
13161
|
*/
|
|
13059
13162
|
export type CreateLegacyArm = {
|
|
13060
13163
|
/**
|
|
@@ -13062,7 +13165,7 @@ export type CreateLegacyArm = {
|
|
|
13062
13165
|
*
|
|
13063
13166
|
* Statement-family or metric block type. The endpoint returns 501 for these values — statements are constructed via `create-report`; metric construction is pending.
|
|
13064
13167
|
*/
|
|
13065
|
-
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'metric';
|
|
13168
|
+
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'metric';
|
|
13066
13169
|
/**
|
|
13067
13170
|
* Payload
|
|
13068
13171
|
*
|
|
@@ -13110,7 +13213,7 @@ export type DeleteLegacyArm = {
|
|
|
13110
13213
|
*
|
|
13111
13214
|
* Statement-family or metric block type. Deletion returns 501 — statements are library-seeded (archive the underlying Report instead); metric deletion is pending.
|
|
13112
13215
|
*/
|
|
13113
|
-
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'metric';
|
|
13216
|
+
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'metric';
|
|
13114
13217
|
/**
|
|
13115
13218
|
* Payload
|
|
13116
13219
|
*
|
|
@@ -13157,7 +13260,7 @@ export type UpdateLegacyArm = {
|
|
|
13157
13260
|
*
|
|
13158
13261
|
* Statement-family or metric block type. Updates return 501 — statement Structures are library-seeded; metric updates are pending.
|
|
13159
13262
|
*/
|
|
13160
|
-
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'metric';
|
|
13263
|
+
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'metric';
|
|
13161
13264
|
/**
|
|
13162
13265
|
* Payload
|
|
13163
13266
|
*
|
|
@@ -17897,6 +18000,70 @@ export type OpChangeTierResponses = {
|
|
|
17897
18000
|
|
|
17898
18001
|
export type OpChangeTierResponse = OpChangeTierResponses[keyof OpChangeTierResponses];
|
|
17899
18002
|
|
|
18003
|
+
export type OpChangeReportingStyleData = {
|
|
18004
|
+
body: ChangeReportingStyleOp;
|
|
18005
|
+
headers?: {
|
|
18006
|
+
/**
|
|
18007
|
+
* Idempotency-Key
|
|
18008
|
+
*/
|
|
18009
|
+
'Idempotency-Key'?: string | null;
|
|
18010
|
+
};
|
|
18011
|
+
path: {
|
|
18012
|
+
/**
|
|
18013
|
+
* Graph Id
|
|
18014
|
+
*/
|
|
18015
|
+
graph_id: string;
|
|
18016
|
+
};
|
|
18017
|
+
query?: never;
|
|
18018
|
+
url: '/v1/graphs/{graph_id}/operations/change-reporting-style';
|
|
18019
|
+
};
|
|
18020
|
+
|
|
18021
|
+
export type OpChangeReportingStyleErrors = {
|
|
18022
|
+
/**
|
|
18023
|
+
* Invalid request
|
|
18024
|
+
*/
|
|
18025
|
+
400: ErrorResponse;
|
|
18026
|
+
/**
|
|
18027
|
+
* Authentication required
|
|
18028
|
+
*/
|
|
18029
|
+
401: ErrorResponse;
|
|
18030
|
+
/**
|
|
18031
|
+
* Access denied
|
|
18032
|
+
*/
|
|
18033
|
+
403: ErrorResponse;
|
|
18034
|
+
/**
|
|
18035
|
+
* Resource not found
|
|
18036
|
+
*/
|
|
18037
|
+
404: ErrorResponse;
|
|
18038
|
+
/**
|
|
18039
|
+
* Idempotency-Key conflict — key reused with different body
|
|
18040
|
+
*/
|
|
18041
|
+
409: ErrorResponse;
|
|
18042
|
+
/**
|
|
18043
|
+
* Validation error
|
|
18044
|
+
*/
|
|
18045
|
+
422: ErrorResponse;
|
|
18046
|
+
/**
|
|
18047
|
+
* Rate limit exceeded
|
|
18048
|
+
*/
|
|
18049
|
+
429: ErrorResponse;
|
|
18050
|
+
/**
|
|
18051
|
+
* Internal server error
|
|
18052
|
+
*/
|
|
18053
|
+
500: ErrorResponse;
|
|
18054
|
+
};
|
|
18055
|
+
|
|
18056
|
+
export type OpChangeReportingStyleError = OpChangeReportingStyleErrors[keyof OpChangeReportingStyleErrors];
|
|
18057
|
+
|
|
18058
|
+
export type OpChangeReportingStyleResponses = {
|
|
18059
|
+
/**
|
|
18060
|
+
* Successful Response
|
|
18061
|
+
*/
|
|
18062
|
+
200: OperationEnvelope;
|
|
18063
|
+
};
|
|
18064
|
+
|
|
18065
|
+
export type OpChangeReportingStyleResponse = OpChangeReportingStyleResponses[keyof OpChangeReportingStyleResponses];
|
|
18066
|
+
|
|
17900
18067
|
export type OpMaterializeData = {
|
|
17901
18068
|
body: MaterializeOp;
|
|
17902
18069
|
headers?: {
|