@robosystems/client 0.3.29 → 0.3.30

package/artifacts/LedgerClient.d.ts

@@ -1,4 +1,4 @@
-import type { AssociationResponse, AutoMapElementsOperation, CreateAgentRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteInformationBlockResponse, DeleteMappingAssociationOperation, DeleteResult, DeleteTaxonomyBlockRequest, DeleteTaxonomyBlockResponse, EntityTaxonomyResponse, EvaluateRulesRequest, EvaluateRulesResponse, EventBlockEnvelope, EventHandlerResponse, FinancialStatementAnalysisRequest, InformationBlockEnvelope, JournalEntryResponse, LedgerAgentResponse, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, OperationEnvelope, PreviewEventBlockResponse, PublishListMemberResponse, PublishListResponse, ReportResponse, ShareReportResponse, TaxonomyBlockEnvelope, UpdateAgentRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest } from '../types.gen';
+import type { AssociationResponse, AutoMapElementsOperation, CreateAgentRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateInformationBlockRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteInformationBlockRequest, DeleteInformationBlockResponse, DeleteMappingAssociationOperation, DeleteResult, DeleteTaxonomyBlockRequest, DeleteTaxonomyBlockResponse, EntityTaxonomyResponse, EvaluateRulesRequest, EvaluateRulesResponse, EventBlockEnvelope, EventHandlerResponse, FinancialStatementAnalysisRequest, InformationBlockEnvelope, JournalEntryResponse, LedgerAgentResponse, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, OperationEnvelope, PreviewEventBlockResponse, PublishListMemberResponse, PublishListResponse, ReportResponse, ShareReportResponse, TaxonomyBlockEnvelope, UpdateAgentRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateInformationBlockRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest } from '../types.gen';
 import type { TokenProvider } from './graphql/client';
 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']>;
@@ -345,6 +345,30 @@ export declare class LedgerClient {
         offset?: number;
     }): Promise<InformationBlockList>;
     /** Create a new schedule with pre-generated monthly facts. */
+    /**
+     * Create an Information Block of any registered block_type.
+     *
+     * Generic wrapper over `create-information-block`. Pass a typed
+     * `CreateInformationBlockRequest` body — the discriminator routes
+     * server-side to the correct dispatch handler. Convenience methods
+     * exist for specific block types (e.g. `createSchedule`); for
+     * block types without one (currently `rollforward`), use this
+     * generic entry.
+     */
+    createInformationBlock(graphId: string, body: CreateInformationBlockRequest, options?: {
+        idempotencyKey?: string;
+    }): Promise<InformationBlockEnvelope>;
+    /**
+     * Update an Information Block in place. Generic wrapper over
+     * `update-information-block`.
+     */
+    updateInformationBlock(graphId: string, body: UpdateInformationBlockRequest): Promise<InformationBlockEnvelope>;
+    /**
+     * Delete an Information Block. Generic wrapper over
+     * `delete-information-block`. Cascades through any facts /
+     * associations tied to the block.
+     */
+    deleteInformationBlock(graphId: string, body: DeleteInformationBlockRequest): Promise<DeleteInformationBlockResponse>;
     createSchedule(graphId: string, options: CreateScheduleOptions): Promise<ScheduleCreated>;
     /** Update mutable fields on a schedule (name, entry_template, metadata). */
     updateSchedule(graphId: string, structureId: string, options: {

package/artifacts/LedgerClient.js

@@ -254,6 +254,43 @@ class LedgerClient {
     }
     // ── Schedules ──────────────────────────────────────────────────────
     /** Create a new schedule with pre-generated monthly facts. */
+    /**
+     * Create an Information Block of any registered block_type.
+     *
+     * Generic wrapper over `create-information-block`. Pass a typed
+     * `CreateInformationBlockRequest` body — the discriminator routes
+     * server-side to the correct dispatch handler. Convenience methods
+     * exist for specific block types (e.g. `createSchedule`); for
+     * block types without one (currently `rollforward`), use this
+     * generic entry.
+     */
+    async createInformationBlock(graphId, body, options) {
+        const envelope = await this.callOperation('Create information block', (0, sdk_gen_1.opCreateInformationBlock)({
+            path: { graph_id: graphId },
+            body,
+            headers: options?.idempotencyKey
+                ? { 'Idempotency-Key': options.idempotencyKey }
+                : undefined,
+        }));
+        return this.requireResult('Create information block', envelope.result);
+    }
+    /**
+     * Update an Information Block in place. Generic wrapper over
+     * `update-information-block`.
+     */
+    async updateInformationBlock(graphId, body) {
+        const envelope = await this.callOperation('Update information block', (0, sdk_gen_1.opUpdateInformationBlock)({ path: { graph_id: graphId }, body }));
+        return this.requireResult('Update information block', envelope.result);
+    }
+    /**
+     * Delete an Information Block. Generic wrapper over
+     * `delete-information-block`. Cascades through any facts /
+     * associations tied to the block.
+     */
+    async deleteInformationBlock(graphId, body) {
+        const envelope = await this.callOperation('Delete information block', (0, sdk_gen_1.opDeleteInformationBlock)({ path: { graph_id: graphId }, body }));
+        return (envelope.result ?? { deleted: true });
+    }
     async createSchedule(graphId, options) {
         const body = {
             block_type: 'schedule',

package/artifacts/LedgerClient.ts

@@ -1050,6 +1050,65 @@ export class LedgerClient {
   // ── Schedules ──────────────────────────────────────────────────────
 
   /** Create a new schedule with pre-generated monthly facts. */
+  /**
+   * Create an Information Block of any registered block_type.
+   *
+   * Generic wrapper over `create-information-block`. Pass a typed
+   * `CreateInformationBlockRequest` body — the discriminator routes
+   * server-side to the correct dispatch handler. Convenience methods
+   * exist for specific block types (e.g. `createSchedule`); for
+   * block types without one (currently `rollforward`), use this
+   * generic entry.
+   */
+  async createInformationBlock(
+    graphId: string,
+    body: CreateInformationBlockRequest,
+    options?: { idempotencyKey?: string }
+  ): Promise<InformationBlockEnvelope> {
+    const envelope = await this.callOperation(
+      'Create information block',
+      opCreateInformationBlock({
+        path: { graph_id: graphId },
+        body,
+        headers: options?.idempotencyKey
+          ? { 'Idempotency-Key': options.idempotencyKey }
+          : undefined,
+      })
+    )
+    return this.requireResult('Create information block', envelope.result)
+  }
+
+  /**
+   * Update an Information Block in place. Generic wrapper over
+   * `update-information-block`.
+   */
+  async updateInformationBlock(
+    graphId: string,
+    body: UpdateInformationBlockRequest
+  ): Promise<InformationBlockEnvelope> {
+    const envelope = await this.callOperation(
+      'Update information block',
+      opUpdateInformationBlock({ path: { graph_id: graphId }, body })
+    )
+    return this.requireResult('Update information block', envelope.result)
+  }
+
+  /**
+   * Delete an Information Block. Generic wrapper over
+   * `delete-information-block`. Cascades through any facts /
+   * associations tied to the block.
+   */
+  async deleteInformationBlock(
+    graphId: string,
+    body: DeleteInformationBlockRequest
+  ): Promise<DeleteInformationBlockResponse> {
+    const envelope = await this.callOperation(
+      'Delete information block',
+      opDeleteInformationBlock({ path: { graph_id: graphId }, body })
+    )
+    return (envelope.result ?? { deleted: true }) as DeleteInformationBlockResponse
+  }
+
   async createSchedule(graphId: string, options: CreateScheduleOptions): Promise<ScheduleCreated> {
     const body: CreateInformationBlockRequest = {
       block_type: 'schedule',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robosystems/client",
-  "version": "0.3.29",
+  "version": "0.3.30",
   "description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
   "main": "index.js",
   "types": "index.d.ts",