@invinite-org/invinite-data-cli 2.0.0 → 3.0.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.
@@ -337,40 +337,40 @@ invd earnings document --document-id <document_id> --output annual-report.pdf
337
337
  Financial statements (standardized & as-reported)
338
338
 
339
339
  ```bash
340
- # As-reported balance sheet (optional: --sort, --limit, --offset, --all)
340
+ # As-reported balance sheet (optional: --sort, --limit, --offset, --reported-only, --all)
341
341
  invd financials as-reported-balance-sheet -i AAPL -p annual --json
342
342
 
343
- # As-reported balance sheet (detailed) (optional: --sort, --limit, --offset, --with-formula, --all)
343
+ # As-reported balance sheet (detailed) (optional: --sort, --limit, --offset, --with-formula, --reported-only, --all)
344
344
  invd financials as-reported-balance-sheet-detailed -i AAPL -p annual --json
345
345
 
346
- # As-reported balance sheet (presentation) (optional: --sort, --limit, --offset, --all)
346
+ # As-reported balance sheet (presentation) (optional: --sort, --limit, --offset, --reported-only, --all)
347
347
  invd financials as-reported-balance-sheet-presentation -i AAPL -p annual --json
348
348
 
349
- # As-reported cash flow statement (optional: --sort, --limit, --offset, --all)
349
+ # As-reported cash flow statement (optional: --sort, --limit, --offset, --reported-only, --display-sign, --all)
350
350
  invd financials as-reported-cash-flow -i AAPL -p annual --json
351
351
 
352
- # As-reported cash flow statement (detailed) (optional: --sort, --limit, --offset, --with-formula, --all)
352
+ # As-reported cash flow statement (detailed) (optional: --sort, --limit, --offset, --with-formula, --reported-only, --display-sign, --all)
353
353
  invd financials as-reported-cash-flow-detailed -i AAPL -p annual --json
354
354
 
355
- # As-reported cash flow statement (presentation) (optional: --sort, --limit, --offset, --all)
355
+ # As-reported cash flow statement (presentation) (optional: --sort, --limit, --offset, --reported-only, --display-sign, --all)
356
356
  invd financials as-reported-cash-flow-presentation -i AAPL -p annual --json
357
357
 
358
- # As-reported income statement (optional: --sort, --limit, --offset, --all)
358
+ # As-reported income statement (optional: --sort, --limit, --offset, --reported-only, --all)
359
359
  invd financials as-reported-income-statement -i AAPL -p annual --json
360
360
 
361
- # As-reported income statement (detailed) (optional: --sort, --limit, --offset, --with-formula, --all)
361
+ # As-reported income statement (detailed) (optional: --sort, --limit, --offset, --with-formula, --reported-only, --all)
362
362
  invd financials as-reported-income-statement-detailed -i AAPL -p annual --json
363
363
 
364
- # As-reported income statement (presentation) (optional: --sort, --limit, --offset, --all)
364
+ # As-reported income statement (presentation) (optional: --sort, --limit, --offset, --reported-only, --all)
365
365
  invd financials as-reported-income-statement-presentation -i AAPL -p annual --json
366
366
 
367
- # As-reported snapshot (optional: --calendar-year, --calendar-quarter)
367
+ # As-reported snapshot (optional: --calendar-year, --calendar-quarter, --reported-only, --display-sign)
368
368
  invd financials as-reported-snapshot -i AAPL,MSFT -p annual --json
369
369
 
370
- # As-reported snapshot (detailed) (optional: --calendar-year, --calendar-quarter, --with-formula)
370
+ # As-reported snapshot (detailed) (optional: --calendar-year, --calendar-quarter, --reported-only, --display-sign, --with-formula)
371
371
  invd financials as-reported-snapshot-detailed -i AAPL,MSFT -p annual --json
372
372
 
373
- # As-reported snapshot (presentation) (optional: --calendar-year, --calendar-quarter)
373
+ # As-reported snapshot (presentation) (optional: --calendar-year, --calendar-quarter, --reported-only, --display-sign)
374
374
  invd financials as-reported-snapshot-presentation -i AAPL,MSFT -p annual --json
375
375
 
376
376
  # Standardized balance sheet (optional: --sort, --limit, --offset, --all)
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "specVersion": "1.0.0",
3
- "specSha256": "118ae607bfa397dde8e651ff1a871117efa93a2ee92517e781921346bb64db3a",
3
+ "specSha256": "f2359dda15915d63db6863c844c1ca07e9cfd365e1296a1901310967b79e24ce",
4
4
  "groups": [
5
5
  {
6
6
  "name": "company",
@@ -2266,6 +2266,19 @@
2266
2266
  "default": 0,
2267
2267
  "example": 0,
2268
2268
  "description": "Number of periods to skip for pagination"
2269
+ },
2270
+ {
2271
+ "name": "reported_only",
2272
+ "in": "query",
2273
+ "required": false,
2274
+ "type": "string",
2275
+ "enum": [
2276
+ "true",
2277
+ "false"
2278
+ ],
2279
+ "default": "false",
2280
+ "example": "true",
2281
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2269
2282
  }
2270
2283
  ],
2271
2284
  "view": "json",
@@ -2351,7 +2364,20 @@
2351
2364
  ],
2352
2365
  "default": "false",
2353
2366
  "example": "true",
2354
- "description": "Include formula in response"
2367
+ "description": "Include each derived fact's formula (its members and their values)"
2368
+ },
2369
+ {
2370
+ "name": "reported_only",
2371
+ "in": "query",
2372
+ "required": false,
2373
+ "type": "string",
2374
+ "enum": [
2375
+ "true",
2376
+ "false"
2377
+ ],
2378
+ "default": "false",
2379
+ "example": "true",
2380
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2355
2381
  }
2356
2382
  ],
2357
2383
  "view": "json",
@@ -2425,6 +2451,19 @@
2425
2451
  "default": 0,
2426
2452
  "example": 0,
2427
2453
  "description": "Number of periods to skip for pagination"
2454
+ },
2455
+ {
2456
+ "name": "reported_only",
2457
+ "in": "query",
2458
+ "required": false,
2459
+ "type": "string",
2460
+ "enum": [
2461
+ "true",
2462
+ "false"
2463
+ ],
2464
+ "default": "false",
2465
+ "example": "true",
2466
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2428
2467
  }
2429
2468
  ],
2430
2469
  "view": "json",
@@ -2498,6 +2537,32 @@
2498
2537
  "default": 0,
2499
2538
  "example": 0,
2500
2539
  "description": "Number of periods to skip for pagination"
2540
+ },
2541
+ {
2542
+ "name": "reported_only",
2543
+ "in": "query",
2544
+ "required": false,
2545
+ "type": "string",
2546
+ "enum": [
2547
+ "true",
2548
+ "false"
2549
+ ],
2550
+ "default": "false",
2551
+ "example": "true",
2552
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2553
+ },
2554
+ {
2555
+ "name": "display_sign",
2556
+ "in": "query",
2557
+ "required": false,
2558
+ "type": "string",
2559
+ "enum": [
2560
+ "as_filed",
2561
+ "cash_flow_direction"
2562
+ ],
2563
+ "default": "as_filed",
2564
+ "example": "as_filed",
2565
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
2501
2566
  }
2502
2567
  ],
2503
2568
  "view": "json",
@@ -2583,7 +2648,33 @@
2583
2648
  ],
2584
2649
  "default": "false",
2585
2650
  "example": "true",
2586
- "description": "Include formula in response"
2651
+ "description": "Include each derived fact's formula (its members and their values)"
2652
+ },
2653
+ {
2654
+ "name": "reported_only",
2655
+ "in": "query",
2656
+ "required": false,
2657
+ "type": "string",
2658
+ "enum": [
2659
+ "true",
2660
+ "false"
2661
+ ],
2662
+ "default": "false",
2663
+ "example": "true",
2664
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2665
+ },
2666
+ {
2667
+ "name": "display_sign",
2668
+ "in": "query",
2669
+ "required": false,
2670
+ "type": "string",
2671
+ "enum": [
2672
+ "as_filed",
2673
+ "cash_flow_direction"
2674
+ ],
2675
+ "default": "as_filed",
2676
+ "example": "as_filed",
2677
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
2587
2678
  }
2588
2679
  ],
2589
2680
  "view": "json",
@@ -2657,6 +2748,32 @@
2657
2748
  "default": 0,
2658
2749
  "example": 0,
2659
2750
  "description": "Number of periods to skip for pagination"
2751
+ },
2752
+ {
2753
+ "name": "reported_only",
2754
+ "in": "query",
2755
+ "required": false,
2756
+ "type": "string",
2757
+ "enum": [
2758
+ "true",
2759
+ "false"
2760
+ ],
2761
+ "default": "false",
2762
+ "example": "true",
2763
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2764
+ },
2765
+ {
2766
+ "name": "display_sign",
2767
+ "in": "query",
2768
+ "required": false,
2769
+ "type": "string",
2770
+ "enum": [
2771
+ "as_filed",
2772
+ "cash_flow_direction"
2773
+ ],
2774
+ "default": "as_filed",
2775
+ "example": "as_filed",
2776
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
2660
2777
  }
2661
2778
  ],
2662
2779
  "view": "json",
@@ -2730,6 +2847,19 @@
2730
2847
  "default": 0,
2731
2848
  "example": 0,
2732
2849
  "description": "Number of periods to skip for pagination"
2850
+ },
2851
+ {
2852
+ "name": "reported_only",
2853
+ "in": "query",
2854
+ "required": false,
2855
+ "type": "string",
2856
+ "enum": [
2857
+ "true",
2858
+ "false"
2859
+ ],
2860
+ "default": "false",
2861
+ "example": "true",
2862
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2733
2863
  }
2734
2864
  ],
2735
2865
  "view": "json",
@@ -2815,7 +2945,20 @@
2815
2945
  ],
2816
2946
  "default": "false",
2817
2947
  "example": "true",
2818
- "description": "Include formula in response"
2948
+ "description": "Include each derived fact's formula (its members and their values)"
2949
+ },
2950
+ {
2951
+ "name": "reported_only",
2952
+ "in": "query",
2953
+ "required": false,
2954
+ "type": "string",
2955
+ "enum": [
2956
+ "true",
2957
+ "false"
2958
+ ],
2959
+ "default": "false",
2960
+ "example": "true",
2961
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2819
2962
  }
2820
2963
  ],
2821
2964
  "view": "json",
@@ -2889,6 +3032,19 @@
2889
3032
  "default": 0,
2890
3033
  "example": 0,
2891
3034
  "description": "Number of periods to skip for pagination"
3035
+ },
3036
+ {
3037
+ "name": "reported_only",
3038
+ "in": "query",
3039
+ "required": false,
3040
+ "type": "string",
3041
+ "enum": [
3042
+ "true",
3043
+ "false"
3044
+ ],
3045
+ "default": "false",
3046
+ "example": "true",
3047
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2892
3048
  }
2893
3049
  ],
2894
3050
  "view": "json",
@@ -2945,6 +3101,32 @@
2945
3101
  "type": "integer",
2946
3102
  "example": 4,
2947
3103
  "description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
3104
+ },
3105
+ {
3106
+ "name": "reported_only",
3107
+ "in": "query",
3108
+ "required": false,
3109
+ "type": "string",
3110
+ "enum": [
3111
+ "true",
3112
+ "false"
3113
+ ],
3114
+ "default": "false",
3115
+ "example": "true",
3116
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
3117
+ },
3118
+ {
3119
+ "name": "display_sign",
3120
+ "in": "query",
3121
+ "required": false,
3122
+ "type": "string",
3123
+ "enum": [
3124
+ "as_filed",
3125
+ "cash_flow_direction"
3126
+ ],
3127
+ "default": "as_filed",
3128
+ "example": "as_filed",
3129
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
2948
3130
  }
2949
3131
  ],
2950
3132
  "view": "json",
@@ -2999,6 +3181,32 @@
2999
3181
  "example": 4,
3000
3182
  "description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
3001
3183
  },
3184
+ {
3185
+ "name": "reported_only",
3186
+ "in": "query",
3187
+ "required": false,
3188
+ "type": "string",
3189
+ "enum": [
3190
+ "true",
3191
+ "false"
3192
+ ],
3193
+ "default": "false",
3194
+ "example": "true",
3195
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
3196
+ },
3197
+ {
3198
+ "name": "display_sign",
3199
+ "in": "query",
3200
+ "required": false,
3201
+ "type": "string",
3202
+ "enum": [
3203
+ "as_filed",
3204
+ "cash_flow_direction"
3205
+ ],
3206
+ "default": "as_filed",
3207
+ "example": "as_filed",
3208
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
3209
+ },
3002
3210
  {
3003
3211
  "name": "with_formula",
3004
3212
  "in": "query",
@@ -3010,7 +3218,7 @@
3010
3218
  ],
3011
3219
  "default": "false",
3012
3220
  "example": "true",
3013
- "description": "Include formula in response"
3221
+ "description": "Include each derived fact's formula (its members and their values)"
3014
3222
  }
3015
3223
  ],
3016
3224
  "view": "json",
@@ -3064,6 +3272,32 @@
3064
3272
  "type": "integer",
3065
3273
  "example": 4,
3066
3274
  "description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
3275
+ },
3276
+ {
3277
+ "name": "reported_only",
3278
+ "in": "query",
3279
+ "required": false,
3280
+ "type": "string",
3281
+ "enum": [
3282
+ "true",
3283
+ "false"
3284
+ ],
3285
+ "default": "false",
3286
+ "example": "true",
3287
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
3288
+ },
3289
+ {
3290
+ "name": "display_sign",
3291
+ "in": "query",
3292
+ "required": false,
3293
+ "type": "string",
3294
+ "enum": [
3295
+ "as_filed",
3296
+ "cash_flow_direction"
3297
+ ],
3298
+ "default": "as_filed",
3299
+ "example": "as_filed",
3300
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
3067
3301
  }
3068
3302
  ],
3069
3303
  "view": "json",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/invinite-data-cli",
3
- "version": "2.0.0",
3
+ "version": "3.0.0",
4
4
  "type": "module",
5
5
  "description": "CLI for the Invinite Data API",
6
6
  "publishConfig": {