@robosystems/client 0.3.16 → 0.3.17

package/artifacts/LedgerClient.d.ts

@@ -1,6 +1,6 @@
 import type { AutoMapElementsOperation, CreateAgentRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteMappingAssociationOperation, DeleteTaxonomyBlockRequest, EvaluateRulesRequest, FinancialStatementAnalysisRequest, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, OperationEnvelope, UpdateAgentRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest } from '../types.gen';
 import type { TokenProvider } from './graphql/client';
-import { type GetInformationBlockQuery, type GetLedgerAccountRollupsQuery, type GetLedgerAccountTreeQuery, type GetLedgerClosingBookStructuresQuery, type GetLedgerEntityQuery, type GetLedgerFiscalCalendarQuery, type GetLedgerMappedTrialBalanceQuery, type GetLedgerMappingCoverageQuery, type GetLedgerMappingQuery, type GetLedgerPeriodCloseStatusQuery, type GetLedgerPeriodDraftsQuery, type GetLedgerPublishListQuery, type GetLedgerReportingTaxonomyQuery, type GetLedgerReportPackageQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type GetLedgerSummaryQuery, type GetLedgerTransactionQuery, type GetLedgerTrialBalanceQuery, type ListInformationBlocksQuery, type ListLedgerAccountsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery } from './graphql/generated/graphql';
+import { type GetInformationBlockQuery, type GetLedgerAccountRollupsQuery, type GetLedgerAccountTreeQuery, type GetLedgerAgentQuery, type GetLedgerClosingBookStructuresQuery, type GetLedgerEntityQuery, type GetLedgerEventBlockQuery, type GetLedgerFiscalCalendarQuery, type GetLedgerMappedTrialBalanceQuery, type GetLedgerMappingCoverageQuery, type GetLedgerMappingQuery, type GetLedgerPeriodCloseStatusQuery, type GetLedgerPeriodDraftsQuery, type GetLedgerPublishListQuery, type GetLedgerReportingTaxonomyQuery, type GetLedgerReportPackageQuery, type GetLedgerReportQuery, type GetLedgerStatementQuery, type GetLedgerSummaryQuery, type GetLedgerTransactionQuery, type GetLedgerTrialBalanceQuery, type ListInformationBlocksQuery, type ListLedgerAccountsQuery, type ListLedgerAgentsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerEventBlocksQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery } from './graphql/generated/graphql';
 export type LedgerEntity = NonNullable<GetLedgerEntityQuery['entity']>;
 export type LedgerEntitySummary = ListLedgerEntitiesQuery['entities'][number];
 export type LedgerSummary = NonNullable<GetLedgerSummaryQuery['summary']>;
@@ -13,6 +13,10 @@ export type LedgerMappedTrialBalance = NonNullable<GetLedgerMappedTrialBalanceQu
 export type LedgerTransactionList = NonNullable<ListLedgerTransactionsQuery['transactions']>;
 export type LedgerTransactionListItem = LedgerTransactionList['transactions'][number];
 export type LedgerTransaction = NonNullable<GetLedgerTransactionQuery['transaction']>;
+export type LedgerEventBlock = ListLedgerEventBlocksQuery['eventBlocks'][number];
+export type LedgerEventBlockDetail = NonNullable<GetLedgerEventBlockQuery['eventBlock']>;
+export type LedgerAgent = ListLedgerAgentsQuery['agents'][number];
+export type LedgerAgentDetail = NonNullable<GetLedgerAgentQuery['agent']>;
 export type LedgerReportingTaxonomy = NonNullable<GetLedgerReportingTaxonomyQuery['reportingTaxonomy']>;
 export type LedgerTaxonomyList = NonNullable<ListLedgerTaxonomiesQuery['taxonomies']>;
 export type LedgerTaxonomy = LedgerTaxonomyList['taxonomies'][number];
@@ -196,6 +200,38 @@ export declare class LedgerClient {
     }): Promise<LedgerTransactionList | null>;
     /** Get transaction detail with entries + line items. */
     getTransaction(graphId: string, transactionId: string): Promise<LedgerTransaction | null>;
+    /**
+     * List captured event blocks for the inbox surface.
+     *
+     * Pass `status: 'captured'` for the default un-reviewed view. Use
+     * `eventType` filters like `'invoice_issued'` / `'bill_received'` to
+     * narrow by source class. Approve/reject via `updateEventBlock`.
+     */
+    listEventBlocks(graphId: string, options?: {
+        eventType?: string;
+        eventCategory?: string;
+        status?: string;
+        agentId?: string;
+        source?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<LedgerEventBlock[]>;
+    /** Get event block detail (carries the metadata blob with nested entries). */
+    getEventBlock(graphId: string, eventId: string): Promise<LedgerEventBlockDetail | null>;
+    /**
+     * List agents — REA-aligned counterparties (customers, vendors,
+     * employees). Defaults to active agents only; pass `isActive: null`
+     * to include deactivated ones.
+     */
+    listAgents(graphId: string, options?: {
+        agentType?: string;
+        source?: string;
+        isActive?: boolean | null;
+        limit?: number;
+        offset?: number;
+    }): Promise<LedgerAgent[]>;
+    /** Get agent detail by id. */
+    getAgent(graphId: string, agentId: string): Promise<LedgerAgentDetail | null>;
     /** Trial balance by raw CoA account. */
     getTrialBalance(graphId: string, options?: {
         startDate?: string;

package/artifacts/LedgerClient.js

@@ -76,6 +76,48 @@ class LedgerClient {
     async getTransaction(graphId, transactionId) {
         return this.gqlQuery(graphId, graphql_1.GetLedgerTransactionDocument, { transactionId }, 'Get transaction', (data) => data.transaction);
     }
+    // ── Event Blocks (Inbox) ────────────────────────────────────────────
+    /**
+     * List captured event blocks for the inbox surface.
+     *
+     * Pass `status: 'captured'` for the default un-reviewed view. Use
+     * `eventType` filters like `'invoice_issued'` / `'bill_received'` to
+     * narrow by source class. Approve/reject via `updateEventBlock`.
+     */
+    async listEventBlocks(graphId, options) {
+        return this.gqlQuery(graphId, graphql_1.ListLedgerEventBlocksDocument, {
+            eventType: options?.eventType ?? null,
+            eventCategory: options?.eventCategory ?? null,
+            status: options?.status ?? null,
+            agentId: options?.agentId ?? null,
+            source: options?.source ?? null,
+            limit: options?.limit ?? 50,
+            offset: options?.offset ?? 0,
+        }, 'List event blocks', (data) => data.eventBlocks);
+    }
+    /** Get event block detail (carries the metadata blob with nested entries). */
+    async getEventBlock(graphId, eventId) {
+        return this.gqlQuery(graphId, graphql_1.GetLedgerEventBlockDocument, { id: eventId }, 'Get event block', (data) => data.eventBlock);
+    }
+    // ── Agents (REA counterparties) ─────────────────────────────────────
+    /**
+     * List agents — REA-aligned counterparties (customers, vendors,
+     * employees). Defaults to active agents only; pass `isActive: null`
+     * to include deactivated ones.
+     */
+    async listAgents(graphId, options) {
+        return this.gqlQuery(graphId, graphql_1.ListLedgerAgentsDocument, {
+            agentType: options?.agentType ?? null,
+            source: options?.source ?? null,
+            isActive: options?.isActive === undefined ? true : options.isActive,
+            limit: options?.limit ?? 50,
+            offset: options?.offset ?? 0,
+        }, 'List agents', (data) => data.agents);
+    }
+    /** Get agent detail by id. */
+    async getAgent(graphId, agentId) {
+        return this.gqlQuery(graphId, graphql_1.GetLedgerAgentDocument, { id: agentId }, 'Get agent', (data) => data.agent);
+    }
     // ── Trial Balance ──────────────────────────────────────────────────
     /** Trial balance by raw CoA account. */
     async getTrialBalance(graphId, options) {

package/artifacts/LedgerClient.ts

@@ -107,8 +107,10 @@ import {
   GetInformationBlockDocument,
   GetLedgerAccountRollupsDocument,
   GetLedgerAccountTreeDocument,
+  GetLedgerAgentDocument,
   GetLedgerClosingBookStructuresDocument,
   GetLedgerEntityDocument,
+  GetLedgerEventBlockDocument,
   GetLedgerFiscalCalendarDocument,
   GetLedgerMappedTrialBalanceDocument,
   GetLedgerMappingCoverageDocument,
@@ -125,8 +127,10 @@ import {
   GetLedgerTrialBalanceDocument,
   ListInformationBlocksDocument,
   ListLedgerAccountsDocument,
+  ListLedgerAgentsDocument,
   ListLedgerElementsDocument,
   ListLedgerEntitiesDocument,
+  ListLedgerEventBlocksDocument,
   ListLedgerMappingsDocument,
   ListLedgerPublishListsDocument,
   ListLedgerReportsDocument,
@@ -137,8 +141,10 @@ import {
   type GetInformationBlockQuery,
   type GetLedgerAccountRollupsQuery,
   type GetLedgerAccountTreeQuery,
+  type GetLedgerAgentQuery,
   type GetLedgerClosingBookStructuresQuery,
   type GetLedgerEntityQuery,
+  type GetLedgerEventBlockQuery,
   type GetLedgerFiscalCalendarQuery,
   type GetLedgerMappedTrialBalanceQuery,
   type GetLedgerMappingCoverageQuery,
@@ -155,8 +161,10 @@ import {
   type GetLedgerTrialBalanceQuery,
   type ListInformationBlocksQuery,
   type ListLedgerAccountsQuery,
+  type ListLedgerAgentsQuery,
   type ListLedgerElementsQuery,
   type ListLedgerEntitiesQuery,
+  type ListLedgerEventBlocksQuery,
   type ListLedgerMappingsQuery,
   type ListLedgerPublishListsQuery,
   type ListLedgerReportsQuery,
@@ -192,6 +200,12 @@ export type LedgerTransactionList = NonNullable<ListLedgerTransactionsQuery['tra
 export type LedgerTransactionListItem = LedgerTransactionList['transactions'][number]
 export type LedgerTransaction = NonNullable<GetLedgerTransactionQuery['transaction']>
 
+export type LedgerEventBlock = ListLedgerEventBlocksQuery['eventBlocks'][number]
+export type LedgerEventBlockDetail = NonNullable<GetLedgerEventBlockQuery['eventBlock']>
+
+export type LedgerAgent = ListLedgerAgentsQuery['agents'][number]
+export type LedgerAgentDetail = NonNullable<GetLedgerAgentQuery['agent']>
+
 export type LedgerReportingTaxonomy = NonNullable<
   GetLedgerReportingTaxonomyQuery['reportingTaxonomy']
 >
@@ -577,6 +591,98 @@ export class LedgerClient {
     )
   }
 
+  // ── Event Blocks (Inbox) ────────────────────────────────────────────
+
+  /**
+   * List captured event blocks for the inbox surface.
+   *
+   * Pass `status: 'captured'` for the default un-reviewed view. Use
+   * `eventType` filters like `'invoice_issued'` / `'bill_received'` to
+   * narrow by source class. Approve/reject via `updateEventBlock`.
+   */
+  async listEventBlocks(
+    graphId: string,
+    options?: {
+      eventType?: string
+      eventCategory?: string
+      status?: string
+      agentId?: string
+      source?: string
+      limit?: number
+      offset?: number
+    }
+  ): Promise<LedgerEventBlock[]> {
+    return this.gqlQuery(
+      graphId,
+      ListLedgerEventBlocksDocument,
+      {
+        eventType: options?.eventType ?? null,
+        eventCategory: options?.eventCategory ?? null,
+        status: options?.status ?? null,
+        agentId: options?.agentId ?? null,
+        source: options?.source ?? null,
+        limit: options?.limit ?? 50,
+        offset: options?.offset ?? 0,
+      },
+      'List event blocks',
+      (data) => data.eventBlocks
+    )
+  }
+
+  /** Get event block detail (carries the metadata blob with nested entries). */
+  async getEventBlock(graphId: string, eventId: string): Promise<LedgerEventBlockDetail | null> {
+    return this.gqlQuery(
+      graphId,
+      GetLedgerEventBlockDocument,
+      { id: eventId },
+      'Get event block',
+      (data) => data.eventBlock
+    )
+  }
+
+  // ── Agents (REA counterparties) ─────────────────────────────────────
+
+  /**
+   * List agents — REA-aligned counterparties (customers, vendors,
+   * employees). Defaults to active agents only; pass `isActive: null`
+   * to include deactivated ones.
+   */
+  async listAgents(
+    graphId: string,
+    options?: {
+      agentType?: string
+      source?: string
+      isActive?: boolean | null
+      limit?: number
+      offset?: number
+    }
+  ): Promise<LedgerAgent[]> {
+    return this.gqlQuery(
+      graphId,
+      ListLedgerAgentsDocument,
+      {
+        agentType: options?.agentType ?? null,
+        source: options?.source ?? null,
+        isActive: options?.isActive === undefined ? true : options.isActive,
+        limit: options?.limit ?? 50,
+        offset: options?.offset ?? 0,
+      },
+      'List agents',
+      (data) => data.agents
+    )
+  }
+
+  /** Get agent detail by id. */
+  async getAgent(graphId: string, agentId: string): Promise<LedgerAgentDetail | null> {
+    return this.gqlQuery(
+      graphId,
+      GetLedgerAgentDocument,
+      { id: agentId },
+      'Get agent',
+      (data) => data.agent
+    )
+  }
+
   // ── Trial Balance ──────────────────────────────────────────────────
 
   /** Trial balance by raw CoA account. */

package/artifacts/graphql/generated/graphql.d.ts

@@ -1695,6 +1695,60 @@ export type ListLedgerAccountsQuery = {
         };
     } | null;
 };
+export type GetLedgerAgentQueryVariables = Exact<{
+    id: Scalars['String']['input'];
+}>;
+export type GetLedgerAgentQuery = {
+    agent: {
+        id: string;
+        agentType: string;
+        name: string;
+        legalName: string | null;
+        taxId: string | null;
+        registrationNumber: string | null;
+        duns: string | null;
+        lei: string | null;
+        email: string | null;
+        phone: string | null;
+        address: any | null;
+        source: string;
+        externalId: string | null;
+        isActive: boolean;
+        is1099Recipient: boolean;
+        createdAt: any | null;
+        updatedAt: any | null;
+        createdBy: string | null;
+    } | null;
+};
+export type ListLedgerAgentsQueryVariables = Exact<{
+    agentType: InputMaybe<Scalars['String']['input']>;
+    source: InputMaybe<Scalars['String']['input']>;
+    isActive?: InputMaybe<Scalars['Boolean']['input']>;
+    limit?: Scalars['Int']['input'];
+    offset?: Scalars['Int']['input'];
+}>;
+export type ListLedgerAgentsQuery = {
+    agents: Array<{
+        id: string;
+        agentType: string;
+        name: string;
+        legalName: string | null;
+        taxId: string | null;
+        registrationNumber: string | null;
+        duns: string | null;
+        lei: string | null;
+        email: string | null;
+        phone: string | null;
+        address: any | null;
+        source: string;
+        externalId: string | null;
+        isActive: boolean;
+        is1099Recipient: boolean;
+        createdAt: any | null;
+        updatedAt: any | null;
+        createdBy: string | null;
+    }>;
+};
 export type GetLedgerClosingBookStructuresQueryVariables = Exact<{
     [key: string]: never;
 }>;
@@ -1813,6 +1867,74 @@ export type GetLedgerEntityQuery = {
         updatedAt: string | null;
     } | null;
 };
+export type GetLedgerEventBlockQueryVariables = Exact<{
+    id: Scalars['String']['input'];
+}>;
+export type GetLedgerEventBlockQuery = {
+    eventBlock: {
+        id: string;
+        eventType: string;
+        eventCategory: string;
+        eventClass: string;
+        status: string;
+        occurredAt: any;
+        effectiveAt: any | null;
+        source: string;
+        externalId: string | null;
+        externalUrl: string | null;
+        amount: number | null;
+        currency: string;
+        description: string | null;
+        metadata: any;
+        dimensionIds: Array<string>;
+        agentId: string | null;
+        resourceType: string | null;
+        resourceElementId: string | null;
+        replacedByEventId: string | null;
+        replacesEventId: string | null;
+        obligatedByEventId: string | null;
+        dischargesEventId: string | null;
+        createdAt: any;
+        createdBy: string;
+    } | null;
+};
+export type ListLedgerEventBlocksQueryVariables = Exact<{
+    eventType: InputMaybe<Scalars['String']['input']>;
+    eventCategory: InputMaybe<Scalars['String']['input']>;
+    status: InputMaybe<Scalars['String']['input']>;
+    agentId: InputMaybe<Scalars['String']['input']>;
+    source: InputMaybe<Scalars['String']['input']>;
+    limit?: Scalars['Int']['input'];
+    offset?: Scalars['Int']['input'];
+}>;
+export type ListLedgerEventBlocksQuery = {
+    eventBlocks: Array<{
+        id: string;
+        eventType: string;
+        eventCategory: string;
+        eventClass: string;
+        status: string;
+        occurredAt: any;
+        effectiveAt: any | null;
+        source: string;
+        externalId: string | null;
+        externalUrl: string | null;
+        amount: number | null;
+        currency: string;
+        description: string | null;
+        metadata: any;
+        dimensionIds: Array<string>;
+        agentId: string | null;
+        resourceType: string | null;
+        resourceElementId: string | null;
+        replacedByEventId: string | null;
+        replacesEventId: string | null;
+        obligatedByEventId: string | null;
+        dischargesEventId: string | null;
+        createdAt: any;
+        createdBy: string;
+    }>;
+};
 export type GetLedgerFiscalCalendarQueryVariables = Exact<{
     [key: string]: never;
 }>;
@@ -2895,10 +3017,14 @@ export declare const GetInvestorSecurityDocument: DocumentNode<GetInvestorSecuri
 export declare const GetLedgerAccountRollupsDocument: DocumentNode<GetLedgerAccountRollupsQuery, GetLedgerAccountRollupsQueryVariables>;
 export declare const GetLedgerAccountTreeDocument: DocumentNode<GetLedgerAccountTreeQuery, GetLedgerAccountTreeQueryVariables>;
 export declare const ListLedgerAccountsDocument: DocumentNode<ListLedgerAccountsQuery, ListLedgerAccountsQueryVariables>;
+export declare const GetLedgerAgentDocument: DocumentNode<GetLedgerAgentQuery, GetLedgerAgentQueryVariables>;
+export declare const ListLedgerAgentsDocument: DocumentNode<ListLedgerAgentsQuery, ListLedgerAgentsQueryVariables>;
 export declare const GetLedgerClosingBookStructuresDocument: DocumentNode<GetLedgerClosingBookStructuresQuery, GetLedgerClosingBookStructuresQueryVariables>;
 export declare const ListLedgerElementsDocument: DocumentNode<ListLedgerElementsQuery, ListLedgerElementsQueryVariables>;
 export declare const ListLedgerEntitiesDocument: DocumentNode<ListLedgerEntitiesQuery, ListLedgerEntitiesQueryVariables>;
 export declare const GetLedgerEntityDocument: DocumentNode<GetLedgerEntityQuery, GetLedgerEntityQueryVariables>;
+export declare const GetLedgerEventBlockDocument: DocumentNode<GetLedgerEventBlockQuery, GetLedgerEventBlockQueryVariables>;
+export declare const ListLedgerEventBlocksDocument: DocumentNode<ListLedgerEventBlocksQuery, ListLedgerEventBlocksQueryVariables>;
 export declare const GetLedgerFiscalCalendarDocument: DocumentNode<GetLedgerFiscalCalendarQuery, GetLedgerFiscalCalendarQueryVariables>;
 export declare const GetInformationBlockDocument: DocumentNode<GetInformationBlockQuery, GetInformationBlockQueryVariables>;
 export declare const ListInformationBlocksDocument: DocumentNode<ListInformationBlocksQuery, ListInformationBlocksQueryVariables>;