@robosystems/client 0.2.36 → 0.2.38

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.
@@ -2131,6 +2131,10 @@ export type DetailedTransactionsResponse = {
2131
2131
  * A document in the document list.
2132
2132
  */
2133
2133
  export type DocumentListItem = {
2134
+ /**
2135
+ * Document Id
2136
+ */
2137
+ document_id: string;
2134
2138
  /**
2135
2139
  * Document Title
2136
2140
  */
@@ -3709,6 +3713,137 @@ export type InvoicesResponse = {
3709
3713
  */
3710
3714
  has_more: boolean;
3711
3715
  };
3716
+ /**
3717
+ * LedgerEntityResponse
3718
+ *
3719
+ * Entity details from the extensions OLTP database.
3720
+ */
3721
+ export type LedgerEntityResponse = {
3722
+ /**
3723
+ * Id
3724
+ */
3725
+ id: string;
3726
+ /**
3727
+ * Name
3728
+ */
3729
+ name: string;
3730
+ /**
3731
+ * Legal Name
3732
+ */
3733
+ legal_name?: string | null;
3734
+ /**
3735
+ * Uri
3736
+ */
3737
+ uri?: string | null;
3738
+ /**
3739
+ * Cik
3740
+ */
3741
+ cik?: string | null;
3742
+ /**
3743
+ * Ticker
3744
+ */
3745
+ ticker?: string | null;
3746
+ /**
3747
+ * Exchange
3748
+ */
3749
+ exchange?: string | null;
3750
+ /**
3751
+ * Sic
3752
+ */
3753
+ sic?: string | null;
3754
+ /**
3755
+ * Sic Description
3756
+ */
3757
+ sic_description?: string | null;
3758
+ /**
3759
+ * Category
3760
+ */
3761
+ category?: string | null;
3762
+ /**
3763
+ * State Of Incorporation
3764
+ */
3765
+ state_of_incorporation?: string | null;
3766
+ /**
3767
+ * Fiscal Year End
3768
+ */
3769
+ fiscal_year_end?: string | null;
3770
+ /**
3771
+ * Tax Id
3772
+ */
3773
+ tax_id?: string | null;
3774
+ /**
3775
+ * Lei
3776
+ */
3777
+ lei?: string | null;
3778
+ /**
3779
+ * Industry
3780
+ */
3781
+ industry?: string | null;
3782
+ /**
3783
+ * Entity Type
3784
+ */
3785
+ entity_type?: string | null;
3786
+ /**
3787
+ * Phone
3788
+ */
3789
+ phone?: string | null;
3790
+ /**
3791
+ * Website
3792
+ */
3793
+ website?: string | null;
3794
+ /**
3795
+ * Status
3796
+ */
3797
+ status?: string;
3798
+ /**
3799
+ * Is Parent
3800
+ */
3801
+ is_parent?: boolean;
3802
+ /**
3803
+ * Parent Entity Id
3804
+ */
3805
+ parent_entity_id?: string | null;
3806
+ /**
3807
+ * Source
3808
+ */
3809
+ source?: string;
3810
+ /**
3811
+ * Source Id
3812
+ */
3813
+ source_id?: string | null;
3814
+ /**
3815
+ * Connection Id
3816
+ */
3817
+ connection_id?: string | null;
3818
+ /**
3819
+ * Address Line1
3820
+ */
3821
+ address_line1?: string | null;
3822
+ /**
3823
+ * Address City
3824
+ */
3825
+ address_city?: string | null;
3826
+ /**
3827
+ * Address State
3828
+ */
3829
+ address_state?: string | null;
3830
+ /**
3831
+ * Address Postal Code
3832
+ */
3833
+ address_postal_code?: string | null;
3834
+ /**
3835
+ * Address Country
3836
+ */
3837
+ address_country?: string | null;
3838
+ /**
3839
+ * Created At
3840
+ */
3841
+ created_at?: string | null;
3842
+ /**
3843
+ * Updated At
3844
+ */
3845
+ updated_at?: string | null;
3846
+ };
3712
3847
  /**
3713
3848
  * LedgerEntryResponse
3714
3849
  */
@@ -4133,6 +4268,12 @@ export type MaterializeRequest = {
4133
4268
  * Validate limits without executing materialization. Returns usage, limits, and warnings.
4134
4269
  */
4135
4270
  dry_run?: boolean;
4271
+ /**
4272
+ * Source
4273
+ *
4274
+ * Data source for materialization. Auto-detected from graph type if not specified. 'staged' materializes from uploaded files (generic graphs). 'extensions' materializes from the extensions OLTP database (entity graphs).
4275
+ */
4276
+ source?: string | null;
4136
4277
  };
4137
4278
  /**
4138
4279
  * MaterializeResponse
@@ -6278,6 +6419,101 @@ export type UpdateApiKeyRequest = {
6278
6419
  */
6279
6420
  description?: string | null;
6280
6421
  };
6422
+ /**
6423
+ * UpdateEntityRequest
6424
+ *
6425
+ * Request to update entity details. Only provided fields are updated.
6426
+ */
6427
+ export type UpdateEntityRequest = {
6428
+ /**
6429
+ * Name
6430
+ */
6431
+ name?: string | null;
6432
+ /**
6433
+ * Legal Name
6434
+ */
6435
+ legal_name?: string | null;
6436
+ /**
6437
+ * Uri
6438
+ */
6439
+ uri?: string | null;
6440
+ /**
6441
+ * Cik
6442
+ */
6443
+ cik?: string | null;
6444
+ /**
6445
+ * Ticker
6446
+ */
6447
+ ticker?: string | null;
6448
+ /**
6449
+ * Exchange
6450
+ */
6451
+ exchange?: string | null;
6452
+ /**
6453
+ * Sic
6454
+ */
6455
+ sic?: string | null;
6456
+ /**
6457
+ * Sic Description
6458
+ */
6459
+ sic_description?: string | null;
6460
+ /**
6461
+ * Category
6462
+ */
6463
+ category?: string | null;
6464
+ /**
6465
+ * State Of Incorporation
6466
+ */
6467
+ state_of_incorporation?: string | null;
6468
+ /**
6469
+ * Fiscal Year End
6470
+ */
6471
+ fiscal_year_end?: string | null;
6472
+ /**
6473
+ * Tax Id
6474
+ */
6475
+ tax_id?: string | null;
6476
+ /**
6477
+ * Lei
6478
+ */
6479
+ lei?: string | null;
6480
+ /**
6481
+ * Industry
6482
+ */
6483
+ industry?: string | null;
6484
+ /**
6485
+ * Entity Type
6486
+ */
6487
+ entity_type?: string | null;
6488
+ /**
6489
+ * Phone
6490
+ */
6491
+ phone?: string | null;
6492
+ /**
6493
+ * Website
6494
+ */
6495
+ website?: string | null;
6496
+ /**
6497
+ * Address Line1
6498
+ */
6499
+ address_line1?: string | null;
6500
+ /**
6501
+ * Address City
6502
+ */
6503
+ address_city?: string | null;
6504
+ /**
6505
+ * Address State
6506
+ */
6507
+ address_state?: string | null;
6508
+ /**
6509
+ * Address Postal Code
6510
+ */
6511
+ address_postal_code?: string | null;
6512
+ /**
6513
+ * Address Country
6514
+ */
6515
+ address_country?: string | null;
6516
+ };
6281
6517
  /**
6282
6518
  * UpdateMemberRoleRequest
6283
6519
  *
@@ -10341,6 +10577,56 @@ export type GetCheckoutStatusResponses = {
10341
10577
  200: CheckoutStatusResponse;
10342
10578
  };
10343
10579
  export type GetCheckoutStatusResponse = GetCheckoutStatusResponses[keyof GetCheckoutStatusResponses];
10580
+ export type GetLedgerEntityData = {
10581
+ body?: never;
10582
+ path: {
10583
+ /**
10584
+ * Graph Id
10585
+ */
10586
+ graph_id: string;
10587
+ };
10588
+ query?: never;
10589
+ url: '/v1/ledger/{graph_id}/entity';
10590
+ };
10591
+ export type GetLedgerEntityErrors = {
10592
+ /**
10593
+ * Validation Error
10594
+ */
10595
+ 422: HttpValidationError;
10596
+ };
10597
+ export type GetLedgerEntityError = GetLedgerEntityErrors[keyof GetLedgerEntityErrors];
10598
+ export type GetLedgerEntityResponses = {
10599
+ /**
10600
+ * Successful Response
10601
+ */
10602
+ 200: LedgerEntityResponse;
10603
+ };
10604
+ export type GetLedgerEntityResponse = GetLedgerEntityResponses[keyof GetLedgerEntityResponses];
10605
+ export type UpdateLedgerEntityData = {
10606
+ body: UpdateEntityRequest;
10607
+ path: {
10608
+ /**
10609
+ * Graph Id
10610
+ */
10611
+ graph_id: string;
10612
+ };
10613
+ query?: never;
10614
+ url: '/v1/ledger/{graph_id}/entity';
10615
+ };
10616
+ export type UpdateLedgerEntityErrors = {
10617
+ /**
10618
+ * Validation Error
10619
+ */
10620
+ 422: HttpValidationError;
10621
+ };
10622
+ export type UpdateLedgerEntityError = UpdateLedgerEntityErrors[keyof UpdateLedgerEntityErrors];
10623
+ export type UpdateLedgerEntityResponses = {
10624
+ /**
10625
+ * Successful Response
10626
+ */
10627
+ 200: LedgerEntityResponse;
10628
+ };
10629
+ export type UpdateLedgerEntityResponse = UpdateLedgerEntityResponses[keyof UpdateLedgerEntityResponses];
10344
10630
  export type ListLedgerAccountsData = {
10345
10631
  body?: never;
10346
10632
  path: {
package/sdk/types.gen.ts CHANGED
@@ -2192,6 +2192,10 @@ export type DetailedTransactionsResponse = {
2192
2192
  * A document in the document list.
2193
2193
  */
2194
2194
  export type DocumentListItem = {
2195
+ /**
2196
+ * Document Id
2197
+ */
2198
+ document_id: string;
2195
2199
  /**
2196
2200
  * Document Title
2197
2201
  */
@@ -3808,6 +3812,138 @@ export type InvoicesResponse = {
3808
3812
  has_more: boolean;
3809
3813
  };
3810
3814
 
3815
+ /**
3816
+ * LedgerEntityResponse
3817
+ *
3818
+ * Entity details from the extensions OLTP database.
3819
+ */
3820
+ export type LedgerEntityResponse = {
3821
+ /**
3822
+ * Id
3823
+ */
3824
+ id: string;
3825
+ /**
3826
+ * Name
3827
+ */
3828
+ name: string;
3829
+ /**
3830
+ * Legal Name
3831
+ */
3832
+ legal_name?: string | null;
3833
+ /**
3834
+ * Uri
3835
+ */
3836
+ uri?: string | null;
3837
+ /**
3838
+ * Cik
3839
+ */
3840
+ cik?: string | null;
3841
+ /**
3842
+ * Ticker
3843
+ */
3844
+ ticker?: string | null;
3845
+ /**
3846
+ * Exchange
3847
+ */
3848
+ exchange?: string | null;
3849
+ /**
3850
+ * Sic
3851
+ */
3852
+ sic?: string | null;
3853
+ /**
3854
+ * Sic Description
3855
+ */
3856
+ sic_description?: string | null;
3857
+ /**
3858
+ * Category
3859
+ */
3860
+ category?: string | null;
3861
+ /**
3862
+ * State Of Incorporation
3863
+ */
3864
+ state_of_incorporation?: string | null;
3865
+ /**
3866
+ * Fiscal Year End
3867
+ */
3868
+ fiscal_year_end?: string | null;
3869
+ /**
3870
+ * Tax Id
3871
+ */
3872
+ tax_id?: string | null;
3873
+ /**
3874
+ * Lei
3875
+ */
3876
+ lei?: string | null;
3877
+ /**
3878
+ * Industry
3879
+ */
3880
+ industry?: string | null;
3881
+ /**
3882
+ * Entity Type
3883
+ */
3884
+ entity_type?: string | null;
3885
+ /**
3886
+ * Phone
3887
+ */
3888
+ phone?: string | null;
3889
+ /**
3890
+ * Website
3891
+ */
3892
+ website?: string | null;
3893
+ /**
3894
+ * Status
3895
+ */
3896
+ status?: string;
3897
+ /**
3898
+ * Is Parent
3899
+ */
3900
+ is_parent?: boolean;
3901
+ /**
3902
+ * Parent Entity Id
3903
+ */
3904
+ parent_entity_id?: string | null;
3905
+ /**
3906
+ * Source
3907
+ */
3908
+ source?: string;
3909
+ /**
3910
+ * Source Id
3911
+ */
3912
+ source_id?: string | null;
3913
+ /**
3914
+ * Connection Id
3915
+ */
3916
+ connection_id?: string | null;
3917
+ /**
3918
+ * Address Line1
3919
+ */
3920
+ address_line1?: string | null;
3921
+ /**
3922
+ * Address City
3923
+ */
3924
+ address_city?: string | null;
3925
+ /**
3926
+ * Address State
3927
+ */
3928
+ address_state?: string | null;
3929
+ /**
3930
+ * Address Postal Code
3931
+ */
3932
+ address_postal_code?: string | null;
3933
+ /**
3934
+ * Address Country
3935
+ */
3936
+ address_country?: string | null;
3937
+ /**
3938
+ * Created At
3939
+ */
3940
+ created_at?: string | null;
3941
+ /**
3942
+ * Updated At
3943
+ */
3944
+ updated_at?: string | null;
3945
+ };
3946
+
3811
3947
  /**
3812
3948
  * LedgerEntryResponse
3813
3949
  */
@@ -4243,6 +4379,12 @@ export type MaterializeRequest = {
4243
4379
  * Validate limits without executing materialization. Returns usage, limits, and warnings.
4244
4380
  */
4245
4381
  dry_run?: boolean;
4382
+ /**
4383
+ * Source
4384
+ *
4385
+ * Data source for materialization. Auto-detected from graph type if not specified. 'staged' materializes from uploaded files (generic graphs). 'extensions' materializes from the extensions OLTP database (entity graphs).
4386
+ */
4387
+ source?: string | null;
4246
4388
  };
4247
4389
 
4248
4390
  /**
@@ -6457,6 +6599,102 @@ export type UpdateApiKeyRequest = {
6457
6599
  description?: string | null;
6458
6600
  };
6459
6601
 
6602
+ /**
6603
+ * UpdateEntityRequest
6604
+ *
6605
+ * Request to update entity details. Only provided fields are updated.
6606
+ */
6607
+ export type UpdateEntityRequest = {
6608
+ /**
6609
+ * Name
6610
+ */
6611
+ name?: string | null;
6612
+ /**
6613
+ * Legal Name
6614
+ */
6615
+ legal_name?: string | null;
6616
+ /**
6617
+ * Uri
6618
+ */
6619
+ uri?: string | null;
6620
+ /**
6621
+ * Cik
6622
+ */
6623
+ cik?: string | null;
6624
+ /**
6625
+ * Ticker
6626
+ */
6627
+ ticker?: string | null;
6628
+ /**
6629
+ * Exchange
6630
+ */
6631
+ exchange?: string | null;
6632
+ /**
6633
+ * Sic
6634
+ */
6635
+ sic?: string | null;
6636
+ /**
6637
+ * Sic Description
6638
+ */
6639
+ sic_description?: string | null;
6640
+ /**
6641
+ * Category
6642
+ */
6643
+ category?: string | null;
6644
+ /**
6645
+ * State Of Incorporation
6646
+ */
6647
+ state_of_incorporation?: string | null;
6648
+ /**
6649
+ * Fiscal Year End
6650
+ */
6651
+ fiscal_year_end?: string | null;
6652
+ /**
6653
+ * Tax Id
6654
+ */
6655
+ tax_id?: string | null;
6656
+ /**
6657
+ * Lei
6658
+ */
6659
+ lei?: string | null;
6660
+ /**
6661
+ * Industry
6662
+ */
6663
+ industry?: string | null;
6664
+ /**
6665
+ * Entity Type
6666
+ */
6667
+ entity_type?: string | null;
6668
+ /**
6669
+ * Phone
6670
+ */
6671
+ phone?: string | null;
6672
+ /**
6673
+ * Website
6674
+ */
6675
+ website?: string | null;
6676
+ /**
6677
+ * Address Line1
6678
+ */
6679
+ address_line1?: string | null;
6680
+ /**
6681
+ * Address City
6682
+ */
6683
+ address_city?: string | null;
6684
+ /**
6685
+ * Address State
6686
+ */
6687
+ address_state?: string | null;
6688
+ /**
6689
+ * Address Postal Code
6690
+ */
6691
+ address_postal_code?: string | null;
6692
+ /**
6693
+ * Address Country
6694
+ */
6695
+ address_country?: string | null;
6696
+ };
6697
+
6460
6698
  /**
6461
6699
  * UpdateMemberRoleRequest
6462
6700
  *
@@ -11065,6 +11303,66 @@ export type GetCheckoutStatusResponses = {
11065
11303
 
11066
11304
  export type GetCheckoutStatusResponse = GetCheckoutStatusResponses[keyof GetCheckoutStatusResponses];
11067
11305
 
11306
+ export type GetLedgerEntityData = {
11307
+ body?: never;
11308
+ path: {
11309
+ /**
11310
+ * Graph Id
11311
+ */
11312
+ graph_id: string;
11313
+ };
11314
+ query?: never;
11315
+ url: '/v1/ledger/{graph_id}/entity';
11316
+ };
11317
+
11318
+ export type GetLedgerEntityErrors = {
11319
+ /**
11320
+ * Validation Error
11321
+ */
11322
+ 422: HttpValidationError;
11323
+ };
11324
+
11325
+ export type GetLedgerEntityError = GetLedgerEntityErrors[keyof GetLedgerEntityErrors];
11326
+
11327
+ export type GetLedgerEntityResponses = {
11328
+ /**
11329
+ * Successful Response
11330
+ */
11331
+ 200: LedgerEntityResponse;
11332
+ };
11333
+
11334
+ export type GetLedgerEntityResponse = GetLedgerEntityResponses[keyof GetLedgerEntityResponses];
11335
+
11336
+ export type UpdateLedgerEntityData = {
11337
+ body: UpdateEntityRequest;
11338
+ path: {
11339
+ /**
11340
+ * Graph Id
11341
+ */
11342
+ graph_id: string;
11343
+ };
11344
+ query?: never;
11345
+ url: '/v1/ledger/{graph_id}/entity';
11346
+ };
11347
+
11348
+ export type UpdateLedgerEntityErrors = {
11349
+ /**
11350
+ * Validation Error
11351
+ */
11352
+ 422: HttpValidationError;
11353
+ };
11354
+
11355
+ export type UpdateLedgerEntityError = UpdateLedgerEntityErrors[keyof UpdateLedgerEntityErrors];
11356
+
11357
+ export type UpdateLedgerEntityResponses = {
11358
+ /**
11359
+ * Successful Response
11360
+ */
11361
+ 200: LedgerEntityResponse;
11362
+ };
11363
+
11364
+ export type UpdateLedgerEntityResponse = UpdateLedgerEntityResponses[keyof UpdateLedgerEntityResponses];
11365
+
11068
11366
  export type ListLedgerAccountsData = {
11069
11367
  body?: never;
11070
11368
  path: {
@@ -0,0 +1,77 @@
1
+ import type { BulkDocumentUploadResponse, DocumentListResponse, DocumentSection, DocumentUploadResponse, SearchResponse } from '../sdk/types.gen';
2
+ export interface DocumentSearchOptions {
3
+ /** Filter by source type (xbrl_textblock, narrative_section, ixbrl_disclosure, uploaded_doc, memory) */
4
+ sourceType?: string;
5
+ /** Filter by ticker, CIK, or entity name */
6
+ entity?: string;
7
+ /** Filter by SEC form type (10-K, 10-Q) */
8
+ formType?: string;
9
+ /** Filter by section ID (item_1, item_1a, item_7, etc.) */
10
+ section?: string;
11
+ /** Filter by XBRL element qname (e.g., us-gaap:Goodwill) */
12
+ element?: string;
13
+ /** Filter by fiscal year */
14
+ fiscalYear?: number;
15
+ /** Filter filings on or after date (YYYY-MM-DD) */
16
+ dateFrom?: string;
17
+ /** Filter filings on or before date (YYYY-MM-DD) */
18
+ dateTo?: string;
19
+ /** Max results to return (default: 10) */
20
+ size?: number;
21
+ /** Pagination offset */
22
+ offset?: number;
23
+ }
24
+ export interface DocumentUploadOptions {
25
+ /** Optional tags for filtering */
26
+ tags?: string[];
27
+ /** Optional folder/category */
28
+ folder?: string;
29
+ /** Optional external ID for upsert behavior */
30
+ externalId?: string;
31
+ }
32
+ export declare class DocumentClient {
33
+ private config;
34
+ constructor(config: {
35
+ baseUrl: string;
36
+ credentials?: 'include' | 'same-origin' | 'omit';
37
+ headers?: Record<string, string>;
38
+ token?: string;
39
+ });
40
+ /**
41
+ * Upload a markdown document for text indexing.
42
+ *
43
+ * The document is sectioned on headings, embedded, and indexed
44
+ * into OpenSearch for full-text and semantic search.
45
+ */
46
+ upload(graphId: string, title: string, content: string, options?: DocumentUploadOptions): Promise<DocumentUploadResponse>;
47
+ /**
48
+ * Upload multiple markdown documents (max 50 per request).
49
+ */
50
+ uploadBulk(graphId: string, documents: Array<{
51
+ title: string;
52
+ content: string;
53
+ tags?: string[];
54
+ folder?: string;
55
+ externalId?: string;
56
+ }>): Promise<BulkDocumentUploadResponse>;
57
+ /**
58
+ * Search documents with hybrid (BM25 + kNN) search.
59
+ */
60
+ search(graphId: string, query: string, options?: DocumentSearchOptions): Promise<SearchResponse>;
61
+ /**
62
+ * Retrieve the full text of a document section by ID.
63
+ *
64
+ * @returns DocumentSection or null if not found.
65
+ */
66
+ getSection(graphId: string, documentId: string): Promise<DocumentSection | null>;
67
+ /**
68
+ * List indexed documents for a graph.
69
+ */
70
+ list(graphId: string, sourceType?: string): Promise<DocumentListResponse>;
71
+ /**
72
+ * Delete a document and all its sections.
73
+ *
74
+ * @returns true if deleted, false if not found.
75
+ */
76
+ delete(graphId: string, documentId: string): Promise<boolean>;
77
+ }