@robosystems/client 2.2.1 → 2.2.2

package/artifacts/LedgerClient.d.ts

@@ -1,7 +1,8 @@
 import type { AssociationResponse, AutoMapElementsOperation, BindTextBlockRequest, BindTextBlockResponse, BlockedSourceGraphResponse, BlockSourceGraphResult, ComputeMetricsRequest, ComputeMetricsResponse, CreateAgentRequest, CreateEventBlockRequest, CreateEventHandlerRequest, CreateInformationBlockRequest, CreateMappingAssociationOperation, CreateTaxonomyBlockRequest, CreateViewRequest, DeleteInformationBlockRequest, DeleteInformationBlockResponse, DeleteMappingAssociationOperation, DeleteResult, DeleteTaxonomyBlockRequest, DeleteTaxonomyBlockResponse, EntityTaxonomyResponse, EvaluateRulesRequest, EvaluateRulesResponse, EventBlockEnvelope, EventHandlerResponse, FinancialStatementAnalysisRequest, FinancialStatementAnalysisResponse, InformationBlockEnvelope, InitializeChartOfAccountsRequest, JournalEntryResponse, LedgerAgentResponse, LinkEntityTaxonomyRequest, LiveFinancialStatementRequest, LiveFinancialStatementResponse, OperationEnvelope, PreviewEventBlockResponse, PublishListMemberResponse, PublishListResponse, ReportResponse, RevokeReportShareResponse, ShareReportResponse, TaxonomyBlockEnvelope, UpdateAgentRequest, UpdateEntityRequest, UpdateEventBlockRequest, UpdateEventHandlerRequest, UpdateInformationBlockRequest, UpdateJournalEntryRequest, UpdateTaxonomyBlockRequest, ViewResponse } 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 ListChartTemplatesQuery, type ListInformationBlocksQuery, type ListLedgerAccountsQuery, type ListLedgerAgentsQuery, type ListLedgerBlockedSourceGraphsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerEventBlocksQuery, type ListLedgerJournalEntriesQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery, type MappingCandidatesQuery, type ReportDownloadFormat } 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 ListChartTemplatesQuery, type ListInformationBlocksQuery, type ListLedgerAccountsQuery, type ListLedgerAgentsQuery, type ListLedgerBlockedSourceGraphsQuery, type ListLedgerElementsQuery, type ListLedgerEntitiesQuery, type ListLedgerEventBlocksQuery, type ListLedgerJournalEntriesQuery, type ListLedgerMappingsQuery, type ListLedgerPublishListsQuery, type ListLedgerReportsQuery, type ListLedgerStructuresQuery, type ListLedgerTaxonomiesQuery, type ListLedgerTransactionsQuery, type ListLedgerUnmappedElementsQuery, type MappingCandidatesQuery, type ReportDownloadFormat, type ReportLifecycle } from './graphql/generated/graphql';
 export { GraphQLError } from './graphql/client';
+export type { ReportLifecycle };
 export type LedgerEntity = NonNullable<GetLedgerEntityQuery['entity']>;
 export type LedgerEntitySummary = ListLedgerEntitiesQuery['entities'][number];
 export type LedgerSummary = NonNullable<GetLedgerSummaryQuery['summary']>;
@@ -716,8 +717,15 @@ export declare class LedgerClient {
      * inline and this resolves with the published report header.
      */
     createReport(graphId: string, options: CreateReportOptions): Promise<ReportResponse>;
-    /** List all reports for a graph (includes received shared reports). */
-    listReports(graphId: string): Promise<ReportListItem[]>;
+    /**
+     * List reports for a graph (includes received shared reports).
+     *
+     * `lifecycle` defaults to `CURRENT`, which leaves archived reports out;
+     * `ARCHIVED` returns only those, `ALL` every report.
+     */
+    listReports(graphId: string, options?: {
+        lifecycle?: ReportLifecycle;
+    }): Promise<ReportListItem[]>;
     /** Get a single report with its period list + available structures. */
     getReport(graphId: string, reportId: string): Promise<Report | null>;
     /**
@@ -785,9 +793,10 @@ export declare class LedgerClient {
     fileReport(graphId: string, reportId: string): Promise<ReportResponse>;
     /**
      * Move a Report along the non-file legs of the filing lifecycle
-     * (draft ↔ under_review, filed → archived). Use ``fileReport`` to
-     * reach 'filed' so the audit fields land cleanly. Synchronous —
-     * resolves with the updated report header.
+     * (draft ↔ under_review, filed ↔ archived). Archiving takes a filed
+     * report off the current list without deleting it; unarchiving returns
+     * it to 'filed'. Use ``fileReport`` to file a draft so the audit fields
+     * land cleanly. Synchronous — resolves with the updated report header.
      */
     transitionFilingStatus(graphId: string, reportId: string, targetStatus: string): Promise<ReportResponse>;
     /** Check if a report was received via sharing (vs locally created). */

package/artifacts/LedgerClient.js

@@ -880,9 +880,14 @@ class LedgerClient {
         const envelope = await this.callOperation('Create report', (0, sdk_gen_1.createReport)({ path: { graph_id: graphId }, body }));
         return this.requireResult('Create report', envelope.result);
     }
-    /** List all reports for a graph (includes received shared reports). */
-    async listReports(graphId) {
-        const list = await this.gqlQuery(graphId, graphql_1.ListLedgerReportsDocument, undefined, 'List reports', (data) => data.reports);
+    /**
+     * List reports for a graph (includes received shared reports).
+     *
+     * `lifecycle` defaults to `CURRENT`, which leaves archived reports out;
+     * `ARCHIVED` returns only those, `ALL` every report.
+     */
+    async listReports(graphId, options = {}) {
+        const list = await this.gqlQuery(graphId, graphql_1.ListLedgerReportsDocument, options.lifecycle ? { lifecycle: options.lifecycle } : undefined, 'List reports', (data) => data.reports);
         return list?.reports ?? [];
     }
     /** Get a single report with its period list + available structures. */
@@ -1001,9 +1006,10 @@ class LedgerClient {
     }
     /**
      * Move a Report along the non-file legs of the filing lifecycle
-     * (draft ↔ under_review, filed → archived). Use ``fileReport`` to
-     * reach 'filed' so the audit fields land cleanly. Synchronous —
-     * resolves with the updated report header.
+     * (draft ↔ under_review, filed ↔ archived). Archiving takes a filed
+     * report off the current list without deleting it; unarchiving returns
+     * it to 'filed'. Use ``fileReport`` to file a draft so the audit fields
+     * land cleanly. Synchronous — resolves with the updated report header.
      */
     async transitionFilingStatus(graphId, reportId, targetStatus) {
         const body = {

package/artifacts/LedgerClient.ts

@@ -221,11 +221,13 @@ import {
   type ListLedgerUnmappedElementsQuery,
   type MappingCandidatesQuery,
   type ReportDownloadFormat,
+  type ReportLifecycle,
 } from './graphql/generated/graphql'
 
 // Re-export the structured GraphQL error type so consumers importing
 // from the `@robosystems/client/ledger` subpath can `instanceof` it.
 export { GraphQLError } from './graphql/client'
+export type { ReportLifecycle }
 
 // ── Friendly types derived from GraphQL codegen ────────────────────────
 //
@@ -2155,12 +2157,20 @@ export class LedgerClient {
     return this.requireResult('Create report', envelope.result)
   }
 
-  /** List all reports for a graph (includes received shared reports). */
-  async listReports(graphId: string): Promise<ReportListItem[]> {
+  /**
+   * List reports for a graph (includes received shared reports).
+   *
+   * `lifecycle` defaults to `CURRENT`, which leaves archived reports out;
+   * `ARCHIVED` returns only those, `ALL` every report.
+   */
+  async listReports(
+    graphId: string,
+    options: { lifecycle?: ReportLifecycle } = {}
+  ): Promise<ReportListItem[]> {
     const list = await this.gqlQuery(
       graphId,
       ListLedgerReportsDocument,
-      undefined,
+      options.lifecycle ? { lifecycle: options.lifecycle } : undefined,
       'List reports',
       (data) => data.reports
     )
@@ -2343,9 +2353,10 @@ export class LedgerClient {
 
   /**
    * Move a Report along the non-file legs of the filing lifecycle
-   * (draft ↔ under_review, filed → archived). Use ``fileReport`` to
-   * reach 'filed' so the audit fields land cleanly. Synchronous —
-   * resolves with the updated report header.
+   * (draft ↔ under_review, filed ↔ archived). Archiving takes a filed
+   * report off the current list without deleting it; unarchiving returns
+   * it to 'filed'. Use ``fileReport`` to file a draft so the audit fields
+   * land cleanly. Synchronous — resolves with the updated report header.
    */
   async transitionFilingStatus(
     graphId: string,

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

@@ -10,6 +10,7 @@ export type Incremental<T> = T | {
 };
 import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
 export type ReportDownloadFormat = 'HOLON_JSONLD' | 'TAVI' | 'XBRL_2_1';
+export type ReportLifecycle = 'ALL' | 'ARCHIVED' | 'CURRENT';
 export type GetInvestorHoldingsQueryVariables = Exact<{
     portfolioId: string;
 }>;
@@ -1615,7 +1616,7 @@ export type GetLedgerReportingTaxonomyQuery = {
     } | null;
 };
 export type ListLedgerReportsQueryVariables = Exact<{
-    [key: string]: never;
+    lifecycle?: ReportLifecycle;
 }>;
 export type ListLedgerReportsQuery = {
     reports: {
@@ -1624,6 +1625,7 @@ export type ListLedgerReportsQuery = {
             name: string;
             taxonomyId: string;
             generationStatus: string;
+            filingStatus: string;
             periodType: string;
             periodStart: string | null;
             periodEnd: string | null;

package/artifacts/graphql/generated/graphql.js

@@ -4322,12 +4322,30 @@ exports.ListLedgerReportsDocument = {
             kind: 'OperationDefinition',
             operation: 'query',
             name: { kind: 'Name', value: 'ListLedgerReports' },
+            variableDefinitions: [
+                {
+                    kind: 'VariableDefinition',
+                    variable: { kind: 'Variable', name: { kind: 'Name', value: 'lifecycle' } },
+                    type: {
+                        kind: 'NonNullType',
+                        type: { kind: 'NamedType', name: { kind: 'Name', value: 'ReportLifecycle' } },
+                    },
+                    defaultValue: { kind: 'EnumValue', value: 'CURRENT' },
+                },
+            ],
             selectionSet: {
                 kind: 'SelectionSet',
                 selections: [
                     {
                         kind: 'Field',
                         name: { kind: 'Name', value: 'reports' },
+                        arguments: [
+                            {
+                                kind: 'Argument',
+                                name: { kind: 'Name', value: 'lifecycle' },
+                                value: { kind: 'Variable', name: { kind: 'Name', value: 'lifecycle' } },
+                            },
+                        ],
                         selectionSet: {
                             kind: 'SelectionSet',
                             selections: [
@@ -4341,6 +4359,7 @@ exports.ListLedgerReportsDocument = {
                                             { kind: 'Field', name: { kind: 'Name', value: 'name' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'generationStatus' } },
+                                            { kind: 'Field', name: { kind: 'Name', value: 'filingStatus' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'periodType' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'periodStart' } },
                                             { kind: 'Field', name: { kind: 'Name', value: 'periodEnd' } },

package/artifacts/graphql/generated/graphql.ts

@@ -6,6 +6,8 @@ export type Incremental<T> =
 import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'
 export type ReportDownloadFormat = 'HOLON_JSONLD' | 'TAVI' | 'XBRL_2_1'
 
+export type ReportLifecycle = 'ALL' | 'ARCHIVED' | 'CURRENT'
+
 export type GetInvestorHoldingsQueryVariables = Exact<{
   portfolioId: string
 }>
@@ -1559,7 +1561,9 @@ export type GetLedgerReportingTaxonomyQuery = {
   } | null
 }
 
-export type ListLedgerReportsQueryVariables = Exact<{ [key: string]: never }>
+export type ListLedgerReportsQueryVariables = Exact<{
+  lifecycle?: ReportLifecycle
+}>
 
 export type ListLedgerReportsQuery = {
   reports: {
@@ -1568,6 +1572,7 @@ export type ListLedgerReportsQuery = {
       name: string
       taxonomyId: string
       generationStatus: string
+      filingStatus: string
       periodType: string
       periodStart: string | null
       periodEnd: string | null
@@ -6372,12 +6377,30 @@ export const ListLedgerReportsDocument = {
       kind: 'OperationDefinition',
       operation: 'query',
       name: { kind: 'Name', value: 'ListLedgerReports' },
+      variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'lifecycle' } },
+          type: {
+            kind: 'NonNullType',
+            type: { kind: 'NamedType', name: { kind: 'Name', value: 'ReportLifecycle' } },
+          },
+          defaultValue: { kind: 'EnumValue', value: 'CURRENT' },
+        },
+      ],
       selectionSet: {
         kind: 'SelectionSet',
         selections: [
           {
             kind: 'Field',
             name: { kind: 'Name', value: 'reports' },
+            arguments: [
+              {
+                kind: 'Argument',
+                name: { kind: 'Name', value: 'lifecycle' },
+                value: { kind: 'Variable', name: { kind: 'Name', value: 'lifecycle' } },
+              },
+            ],
             selectionSet: {
               kind: 'SelectionSet',
               selections: [
@@ -6391,6 +6414,7 @@ export const ListLedgerReportsDocument = {
                       { kind: 'Field', name: { kind: 'Name', value: 'name' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'taxonomyId' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'generationStatus' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'filingStatus' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'periodType' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'periodStart' } },
                       { kind: 'Field', name: { kind: 'Name', value: 'periodEnd' } },

package/artifacts/graphql/queries/ledger/reports.d.ts

@@ -1,5 +1,8 @@
 /**
- * All report definitions for this graph, most recent first.
+ * Report definitions for this graph, most recent first.
+ *
+ * `lifecycle` defaults to `CURRENT` (archived reports left out); `ARCHIVED`
+ * returns only those, `ALL` every report.
  *
  * Includes both native reports (generated from this graph's books) and
  * shared reports (materialized from another graph via a publish list).

package/artifacts/graphql/queries/ledger/reports.js

@@ -3,20 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LIST_REPORTS = void 0;
 const graphql_request_1 = require("graphql-request");
 /**
- * All report definitions for this graph, most recent first.
+ * Report definitions for this graph, most recent first.
+ *
+ * `lifecycle` defaults to `CURRENT` (archived reports left out); `ARCHIVED`
+ * returns only those, `ALL` every report.
  *
  * Includes both native reports (generated from this graph's books) and
  * shared reports (materialized from another graph via a publish list).
  * `sourceGraphId` / `sourceReportId` / `sharedAt` identify shared reports.
  */
 exports.LIST_REPORTS = (0, graphql_request_1.gql) `
-  query ListLedgerReports {
-    reports {
+  query ListLedgerReports($lifecycle: ReportLifecycle! = CURRENT) {
+    reports(lifecycle: $lifecycle) {
       reports {
         id
         name
         taxonomyId
         generationStatus
+        filingStatus
         periodType
         periodStart
         periodEnd

package/artifacts/graphql/queries/ledger/reports.ts

@@ -1,20 +1,24 @@
 import { gql } from 'graphql-request'
 
 /**
- * All report definitions for this graph, most recent first.
+ * Report definitions for this graph, most recent first.
+ *
+ * `lifecycle` defaults to `CURRENT` (archived reports left out); `ARCHIVED`
+ * returns only those, `ALL` every report.
  *
  * Includes both native reports (generated from this graph's books) and
  * shared reports (materialized from another graph via a publish list).
  * `sourceGraphId` / `sourceReportId` / `sharedAt` identify shared reports.
  */
 export const LIST_REPORTS = gql`
-  query ListLedgerReports {
-    reports {
+  query ListLedgerReports($lifecycle: ReportLifecycle! = CURRENT) {
+    reports(lifecycle: $lifecycle) {
       reports {
         id
         name
         taxonomyId
         generationStatus
+        filingStatus
         periodType
         periodStart
         periodEnd

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robosystems/client",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "TypeScript client library for the RoboSystems financial intelligence platform",
   "main": "index.js",
   "types": "index.d.ts",

package/sdk/sdk.gen.d.ts

@@ -1152,7 +1152,7 @@ export declare const fileReport: <ThrowOnError extends boolean = false>(options:
 /**
  * Transition Filing Status
  *
- * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed → archived). Use 'file-report' to reach 'filed' so audit fields land cleanly.
+ * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed ↔ archived). Archiving takes a filed report off the current list without deleting it; unarchiving returns it to 'filed'. Use 'file-report' to file a draft so audit fields land cleanly.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */

package/sdk/sdk.gen.js

@@ -2373,7 +2373,7 @@ exports.fileReport = fileReport;
 /**
  * Transition Filing Status
  *
- * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed → archived). Use 'file-report' to reach 'filed' so audit fields land cleanly.
+ * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed ↔ archived). Archiving takes a filed report off the current list without deleting it; unarchiving returns it to 'filed'. Use 'file-report' to file a draft so audit fields land cleanly.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */

package/sdk/sdk.gen.ts

@@ -2385,7 +2385,7 @@ export const fileReport = <ThrowOnError extends boolean = false>(options: Option
 /**
  * Transition Filing Status
  *
- * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed → archived). Use 'file-report' to reach 'filed' so audit fields land cleanly.
+ * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed ↔ archived). Archiving takes a filed report off the current list without deleting it; unarchiving returns it to 'filed'. Use 'file-report' to file a draft so audit fields land cleanly.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */

package/sdk/types.gen.d.ts

@@ -16751,10 +16751,11 @@ export type TransactionTemplateLeg = {
  *
  * Generic filing-status transition — escape hatch for non-file moves.
  *
- * Used for `draft → under_review` (submit for review) and
- * `filed → archived` (supersede / retire). Filing the package goes
- * through :class:`FileReportRequest` so `filed_at` / `filed_by`
- * audit fields land cleanly.
+ * Used for `draft ↔ under_review` (submit for review, or send back),
+ * `filed → archived` (take a filed report off the current list) and
+ * `archived → filed` (bring it back). Filing a draft goes through
+ * :class:`FileReportRequest` so `filed_at` / `filed_by` audit fields
+ * land cleanly.
  */
 export type TransitionFilingStatusRequest = {
     /**
@@ -16766,7 +16767,7 @@ export type TransitionFilingStatusRequest = {
     /**
      * Target Status
      *
-     * Target lifecycle state: `under_review` (submit a draft for review) or `archived` (supersede / retire a filed report). Reaching `filed` goes through `file-report` so audit fields land cleanly.
+     * Target lifecycle state: `under_review` (submit a draft for review), `draft` (send it back), `archived` (take a filed report off the current list; it stays a record) or `filed` (unarchive). Filing a draft goes through `file-report` so audit fields land cleanly.
      */
     target_status: string;
 };

package/sdk/types.gen.ts

@@ -17169,10 +17169,11 @@ export type TransactionTemplateLeg = {
  *
  * Generic filing-status transition — escape hatch for non-file moves.
  *
- * Used for `draft → under_review` (submit for review) and
- * `filed → archived` (supersede / retire). Filing the package goes
- * through :class:`FileReportRequest` so `filed_at` / `filed_by`
- * audit fields land cleanly.
+ * Used for `draft ↔ under_review` (submit for review, or send back),
+ * `filed → archived` (take a filed report off the current list) and
+ * `archived → filed` (bring it back). Filing a draft goes through
+ * :class:`FileReportRequest` so `filed_at` / `filed_by` audit fields
+ * land cleanly.
  */
 export type TransitionFilingStatusRequest = {
     /**
@@ -17184,7 +17185,7 @@ export type TransitionFilingStatusRequest = {
     /**
      * Target Status
      *
-     * Target lifecycle state: `under_review` (submit a draft for review) or `archived` (supersede / retire a filed report). Reaching `filed` goes through `file-report` so audit fields land cleanly.
+     * Target lifecycle state: `under_review` (submit a draft for review), `draft` (send it back), `archived` (take a filed report off the current list; it stays a record) or `filed` (unarchive). Filing a draft goes through `file-report` so audit fields land cleanly.
      */
     target_status: string;
 };

package/sdk.gen.d.ts

@@ -1152,7 +1152,7 @@ export declare const fileReport: <ThrowOnError extends boolean = false>(options:
 /**
  * Transition Filing Status
  *
- * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed → archived). Use 'file-report' to reach 'filed' so audit fields land cleanly.
+ * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed ↔ archived). Archiving takes a filed report off the current list without deleting it; unarchiving returns it to 'filed'. Use 'file-report' to file a draft so audit fields land cleanly.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */

package/sdk.gen.js

@@ -2373,7 +2373,7 @@ exports.fileReport = fileReport;
 /**
  * Transition Filing Status
  *
- * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed → archived). Use 'file-report' to reach 'filed' so audit fields land cleanly.
+ * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed ↔ archived). Archiving takes a filed report off the current list without deleting it; unarchiving returns it to 'filed'. Use 'file-report' to file a draft so audit fields land cleanly.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */

package/sdk.gen.ts

@@ -2385,7 +2385,7 @@ export const fileReport = <ThrowOnError extends boolean = false>(options: Option
 /**
  * Transition Filing Status
  *
- * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed → archived). Use 'file-report' to reach 'filed' so audit fields land cleanly.
+ * Move a Report along the non-file legs of the filing lifecycle (draft ↔ under_review, filed ↔ archived). Archiving takes a filed report off the current list without deleting it; unarchiving returns it to 'filed'. Use 'file-report' to file a draft so audit fields land cleanly.
  *
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
  */

package/types.gen.d.ts

@@ -16751,10 +16751,11 @@ export type TransactionTemplateLeg = {
  *
  * Generic filing-status transition — escape hatch for non-file moves.
  *
- * Used for `draft → under_review` (submit for review) and
- * `filed → archived` (supersede / retire). Filing the package goes
- * through :class:`FileReportRequest` so `filed_at` / `filed_by`
- * audit fields land cleanly.
+ * Used for `draft ↔ under_review` (submit for review, or send back),
+ * `filed → archived` (take a filed report off the current list) and
+ * `archived → filed` (bring it back). Filing a draft goes through
+ * :class:`FileReportRequest` so `filed_at` / `filed_by` audit fields
+ * land cleanly.
  */
 export type TransitionFilingStatusRequest = {
     /**
@@ -16766,7 +16767,7 @@ export type TransitionFilingStatusRequest = {
     /**
      * Target Status
      *
-     * Target lifecycle state: `under_review` (submit a draft for review) or `archived` (supersede / retire a filed report). Reaching `filed` goes through `file-report` so audit fields land cleanly.
+     * Target lifecycle state: `under_review` (submit a draft for review), `draft` (send it back), `archived` (take a filed report off the current list; it stays a record) or `filed` (unarchive). Filing a draft goes through `file-report` so audit fields land cleanly.
      */
     target_status: string;
 };

package/types.gen.ts

@@ -17169,10 +17169,11 @@ export type TransactionTemplateLeg = {
  *
  * Generic filing-status transition — escape hatch for non-file moves.
  *
- * Used for `draft → under_review` (submit for review) and
- * `filed → archived` (supersede / retire). Filing the package goes
- * through :class:`FileReportRequest` so `filed_at` / `filed_by`
- * audit fields land cleanly.
+ * Used for `draft ↔ under_review` (submit for review, or send back),
+ * `filed → archived` (take a filed report off the current list) and
+ * `archived → filed` (bring it back). Filing a draft goes through
+ * :class:`FileReportRequest` so `filed_at` / `filed_by` audit fields
+ * land cleanly.
  */
 export type TransitionFilingStatusRequest = {
     /**
@@ -17184,7 +17185,7 @@ export type TransitionFilingStatusRequest = {
     /**
      * Target Status
      *
-     * Target lifecycle state: `under_review` (submit a draft for review) or `archived` (supersede / retire a filed report). Reaching `filed` goes through `file-report` so audit fields land cleanly.
+     * Target lifecycle state: `under_review` (submit a draft for review), `draft` (send it back), `archived` (take a filed report off the current list; it stays a record) or `filed` (unarchive). Filing a draft goes through `file-report` so audit fields land cleanly.
      */
     target_status: string;
 };