@vario-software/types 2026.27.0 → 2026.28.0

package/scripting/services.d.ts

@@ -12,7 +12,7 @@ import {
     CrmReminder, CrmState, CrmSubType, CrmTask, CrmTaskParticipant, 
     CrmTypedDocumentRef, CrmTypedDocumentRefList, CurrencyReference, Customer, 
     DangerousGoodInformation, DealNotificationEventConfig, DeliveryMethod, 
-    DeliveryTerm, Document, DocumentAdditionalInfo, 
+    DeliveryTerm, DmsOutputStream, Document, DocumentAdditionalInfo, 
     DocumentAdditionalInfo$IncomingGoodsTarget, 
     DocumentAdditionalInfo$IncomingGoodsTargetOfLine, 
     DocumentAdditionalInfo$OrderIntoPickingConvertResult, 
@@ -28,34 +28,36 @@ import {
     DocumentTransferToStateRequest, DocumentTransferToTypeRequest, 
     DocumentType, DocumentTypeFollowUp, DocumentTypeLabel, DocumentTypeState, 
     DummySerialNumberStockTransferApi, ECrmPriorityType, 
-    ECrmSpecialDocumentRefType, ECrmType, EScriptingAuthenticationType, 
-    EShelfDocumentDeletionState, FabricationComponentForProduction, 
-    FabricationDefectiveRequest, FabricationProduceRequest, 
-    FabricationRemainingComponent, FabricationRevertRequest, 
-    FabricationSerialNumber, Group, OpenItem, PaymentMethod, PaymentTerm, 
-    PaymentTermRef, PickTrolley, PickTrolleyBox, Picklist, PicklistLine, 
-    PicklistLineBooking, PicklistLineComponent, PicklistTemplate, 
-    PicklistTemplate$DateRange, PicklistTemplate$OrderSelectionOptions, 
+    ECrmSpecialDocumentRefType, ECrmType, ELinebreakType, 
+    EScriptingAuthenticationType, EShelfDocumentDeletionState, 
+    FabricationComponentForProduction, FabricationDefectiveRequest, 
+    FabricationProduceRequest, FabricationRemainingComponent, 
+    FabricationRevertRequest, FabricationSerialNumber, Group, OpenItem, 
+    PaymentMethod, PaymentTerm, PaymentTermRef, PickTrolley, PickTrolleyBox, 
+    Picklist, PicklistLine, PicklistLineBooking, PicklistLineComponent, 
+    PicklistTemplate, PicklistTemplate$DateRange, 
+    PicklistTemplate$OrderSelectionOptions, 
     PicklistTemplate$PicklistCreationOptions, 
     PicklistTemplate$PicklistProcessingOptions, 
-    PicklistTemplate$PicklistScript, PriceSelectionCriteria, Product, 
-    ProductArticleRef, ProductDiscount, ProductGroup, ProductMainGroup, 
-    ProductPrice, RecommendedRetailPrice, RequestDocument, RequestDocumentLine, 
-    RequestDocumentLineBooking, RequestDocumentLineCommission, 
-    RequestDocumentLineFabricationDetail, 
+    PicklistTemplate$PicklistScript, PlainScriptingWriter, 
+    PriceSelectionCriteria, Product, ProductArticleRef, ProductDiscount, 
+    ProductGroup, ProductMainGroup, ProductPrice, RecommendedRetailPrice, 
+    RequestDocument, RequestDocumentLine, RequestDocumentLineBooking, 
+    RequestDocumentLineCommission, RequestDocumentLineFabricationDetail, 
     RequestDocumentLineShippingCostDetail, RequestDocumentPriceModifier, 
     RequestDocumentText, RevenueCalculation, SalesAgent, Scenario, 
     ScenarioActualValue, ScenarioDimension, ScenarioDimensionValue, 
-    ScriptOutputRequest, ScriptingDate, ScriptingDateTime, SecureHttpClient, 
+    ScriptOutputRequest, ScriptingDate, ScriptingDateTime, 
+    ScriptingOutputStream, ScriptingXmlWriter, SecureHttpClient, 
     SequencerConfiguration, SequencerConfigurationDetail, 
     SerialNumberWithQuantityApi, ShelfDocument, ShelfDocumentAttribution, 
     ShelfDocumentType, ShelfFile, ShelfFileMetaData, ShelfShare, 
     ShelfTranslatableText, Stock, StockMovementManualApi, StockTransferApi, 
-    StockTransferResult, StorageBinRef, SubFileInfo, Supplier, TagDto, 
-    TaxIdForeignCountry, TextEnumCreate, TextEnumGet, TssSignature, 
-    UnitTypeReference, UpdateDocumentRequest, User, VariantAttribute, 
-    VariantAttributeListing, VariantDescription, VariantSchema, VariantValue, 
-    VariantValueListing, VariantValueReference
+    StockTransferResult, StorageBinRef, StringCollectorOutputStream, 
+    SubFileInfo, Supplier, TagDto, TaxIdForeignCountry, TextEnumCreate, 
+    TextEnumGet, TssSignature, UnitTypeReference, UpdateDocumentRequest, User, 
+    VariantAttribute, VariantAttributeListing, VariantDescription, 
+    VariantSchema, VariantValue, VariantValueListing, VariantValueReference
 } from "./types"
 
 /**
@@ -1771,20 +1773,20 @@ export interface DocumentScriptingService {
      * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
      * 
      * @param {number} documentId - ID des zu kopierenden Belegs
-     * @param {string} targetDocumentType - Ziel-Belegart der Kopie
-     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
+     * @param {string} targetDocumentTypeLabel - Ziel-Belegart der Kopie
      * @return {Document} Der kopierte Beleg
      */
-    copy(documentId: number, targetDocumentType: string, additionalParameters: Array<AdditionalParameter>): Document;
+    copy(documentId: number, targetDocumentTypeLabel: string): Document;
 
     /**
      * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
      * 
      * @param {number} documentId - ID des zu kopierenden Belegs
-     * @param {string} targetDocumentTypeLabel - Ziel-Belegart der Kopie
+     * @param {string} targetDocumentType - Ziel-Belegart der Kopie
+     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
      * @return {Document} Der kopierte Beleg
      */
-    copy(documentId: number, targetDocumentTypeLabel: string): Document;
+    copy(documentId: number, targetDocumentType: string, additionalParameters: Array<AdditionalParameter>): Document;
 
     /**
      * Erstellt einen neuen Beleg
@@ -1815,18 +1817,18 @@ export interface DocumentScriptingService {
      * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
      * 
      * @param {number} documentId - ID des Belegs
+     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
      * @return {Document} Der Beleg in Bearbeitung
      */
-    edit(documentId: number): Document;
+    edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
 
     /**
      * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
      * 
      * @param {number} documentId - ID des Belegs
-     * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
      * @return {Document} Der Beleg in Bearbeitung
      */
-    edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
+    edit(documentId: number): Document;
 
     /**
      * Erstellt ein AdditionalParameter-Objekt
@@ -1929,16 +1931,16 @@ export interface DocumentScriptingService {
      * Versendet einen Beleg per Mail
      * 
      * @param {number} documentId - ID des zu versendenden Belegs
+     * @param {string} reportGroupIdentifier - 
      */
-    sendViaMail(documentId: number): void;
+    sendViaMail(documentId: number, reportGroupIdentifier: string): void;
 
     /**
      * Versendet einen Beleg per Mail
      * 
      * @param {number} documentId - ID des zu versendenden Belegs
-     * @param {string} reportGroupIdentifier - 
      */
-    sendViaMail(documentId: number, reportGroupIdentifier: string): void;
+    sendViaMail(documentId: number): void;
 
     /**
      * Überführt einen Beleg in einen anderen Status
@@ -2799,6 +2801,46 @@ export interface ScriptOutputHelperService {
     createOutputRequest(): ScriptOutputRequest;
 }
 
+/**
+ * Factory zum Erzeugen von Writern und OutputStreams
+ */
+export interface ScriptingIOFactory {
+
+    /**
+     * Erzeugt einen Writer für einfache Texte ohne besondere Formatierungs- oder Syntax-Unterstützung mit Standard-Zeilenumbruch (Windows).
+     * 
+     * @param {ScriptingOutputStream} destination - Ziel-Stream, in den geschrieben wird
+     * @return {PlainScriptingWriter} Der erzeugte Writer
+     */
+    createPlainWriter(destination: ScriptingOutputStream): PlainScriptingWriter;
+
+    /**
+     * Wie createPlainWriter(ScriptingOutputStream), aber mit einstellbarer Zeichenfolge für Zeilenumbrüche
+     * 
+     * @param {ScriptingOutputStream} destination - Ziel-Stream, in den geschrieben wird
+     * @param {ELinebreakType} linebreakType - Zeichenfolge für einen Zeilenumbruch
+     * @return {PlainScriptingWriter} Der erzeugte Writer
+     */
+    createPlainWriter(destination: ScriptingOutputStream, linebreakType: ELinebreakType): PlainScriptingWriter;
+
+    /**
+     * Erzeugt einen StringCollector, der geschriebene Daten als String sammelt.
+     * 
+     * @return {StringCollectorOutputStream} Der erzeugte StringCollector
+     */
+    createStringCollector(): StringCollectorOutputStream;
+
+    /**
+     * Erzeugt einen XmlWriter, der in den übergebenen Stream schreibt.
+     * 
+     * @param {ScriptingOutputStream} destination - Ziel-Stream, in den geschrieben wird
+     * @param {string} encoding - Encoding (z.B. UTF-8)
+     * @param {boolean} prettyPrint - besser leserlich formatieren?
+     * @return {ScriptingXmlWriter} Der erzeugte XmlWriter
+     */
+    createXmlWriter(destination: ScriptingOutputStream, encoding: string, prettyPrint: boolean): ScriptingXmlWriter;
+}
+
 /**
  * Services
  */
@@ -2819,26 +2861,26 @@ export interface ScriptingServiceList {
      */
     crmTaskService: CrmTaskScriptingService;
 
-    /**
-     * Service zur Verarbeitung von Accounts
-     */
-    accountService: AccountScriptingService;
-
     /**
      * Service zur Verarbeitung von Shelf-Documents
      */
     shelfDocumentService: ShelfDocumentScriptingService;
 
     /**
-     * Verwaltung von Versandarten
+     * Service zur Verarbeitung von Accounts
      */
-    deliveryMethodService: DeliveryMethodScriptingService;
+    accountService: AccountScriptingService;
 
     /**
      * Logging im Scripting
      */
     logger: LoggingScriptingService;
 
+    /**
+     * Verwaltung von Versandarten
+     */
+    deliveryMethodService: DeliveryMethodScriptingService;
+
     /**
      * Service zur Verarbeitung von Deals
      */
@@ -2855,14 +2897,14 @@ export interface ScriptingServiceList {
     productGroupService: ProductGroupScriptingService;
 
     /**
-     * Service zur Verarbeitung von Hauptwarengruppen im Skripten
+     * Ausgabe-Support Methoden
      */
-    productMainGroupService: ProductMainGroupScriptingService;
+    outputHelper: ScriptOutputHelperService;
 
     /**
-     * Ausgabe-Support Methoden
+     * Service zur Verarbeitung von Hauptwarengruppen im Skripten
      */
-    outputHelper: ScriptOutputHelperService;
+    productMainGroupService: ProductMainGroupScriptingService;
 
     /**
      * Service zur Verarbeitung von Account-Listings in Skripten
@@ -2874,6 +2916,11 @@ export interface ScriptingServiceList {
      */
     dtoFactory: dtoFactory;
 
+    /**
+     * Factory zum Erzeugen von Writern und OutputStreams
+     */
+    ioFactory: ScriptingIOFactory;
+
     /**
      * Service zur Verarbeitung von Produktpreisen in Skripten
      */
@@ -2885,14 +2932,14 @@ export interface ScriptingServiceList {
     utils: ScriptingUtilities;
 
     /**
-     * Service zur Verarbeitung von Artikel-Kundenbeziehungen im Skripten
+     * Service zur Verarbeitung von Variantenschemas in Skripten
      */
-    articleCustomerService: ArticleCustomerScriptingService;
+    variantSchemaService: VariantSchemaScriptingService;
 
     /**
-     * Service zur Verarbeitung von Variantenschemas in Skripten
+     * Service zur Verarbeitung von Artikel-Kundenbeziehungen im Skripten
      */
-    variantSchemaService: VariantSchemaScriptingService;
+    articleCustomerService: ArticleCustomerScriptingService;
 
     /**
      * Service zur Verarbeitung von Artikeln im Skripten
@@ -2920,14 +2967,14 @@ export interface ScriptingServiceList {
     articleStorageService: ArticleStorageScriptingService;
 
     /**
-     * Verwaltung von Zahlungsarten
+     * Anfragen von neuen Zählerkreis-Nummern
      */
-    paymentMethodService: PaymentMethodScriptingService;
+    freeSequencerService: FreeSequencerScriptingService;
 
     /**
-     * Anfragen von neuen Zählerkreis-Nummern
+     * Verwaltung von Zahlungsarten
      */
-    freeSequencerService: FreeSequencerScriptingService;
+    paymentMethodService: PaymentMethodScriptingService;
 
     /**
      * Service zur Verarbeitung von AssetsTypen in Skripten
@@ -2940,14 +2987,14 @@ export interface ScriptingServiceList {
     stockService: StockScriptingService;
 
     /**
-     * Service zur Verarbeitung von Assets in Skripten
+     * Service zur Verarbeitung von Variantenwerten in Skripten
      */
-    assetService: AssetScriptingService;
+    variantValueService: VariantValueScriptingService;
 
     /**
-     * Service zur Verarbeitung von Variantenwerten in Skripten
+     * Service zur Verarbeitung von Assets in Skripten
      */
-    variantValueService: VariantValueScriptingService;
+    assetService: AssetScriptingService;
 
     /**
      * Service zur Verarbeitung von ScenarioActualValue
@@ -3079,6 +3126,15 @@ export interface ScriptingUtilities {
  */
 export interface ShelfDocumentScriptingService {
 
+    /**
+     * Legt ein Dokument an. Der Inhalt muss noch separat hochgeladen werden.
+     * 
+     * @param {string} fileName - Dateiname
+     * @param {string} documentTypeKey - Schlüssel des Dokumenttypen
+     * @return {ShelfDocument} Das angelegte Dokument
+     */
+    create(fileName: string, documentTypeKey: string): ShelfDocument;
+
     /**
      * Erstellt eine neue Verknüpfung zwischen einem DMS-Dokument und einem Geschäftsobjekt
      * 
@@ -3087,6 +3143,15 @@ export interface ShelfDocumentScriptingService {
      */
     createAttribution(attribution: ShelfDocumentAttribution): ShelfDocumentAttribution;
 
+    /**
+     * Erzeugt einen OutputStream, der geschriebene Daten als Datei ins DMS lädt.
+     * 
+     * @param {number} shelfDocumentId - ID des Dokuments
+     * @param {string} fileName - Dateiname
+     * @return {DmsOutputStream} Der erzeugte OutputStream
+     */
+    createDmsOutputStream(shelfDocumentId: number, fileName: string): DmsOutputStream;
+
     /**
      * Löscht eine DMS-Verknüpfung
      * 
@@ -3095,24 +3160,24 @@ export interface ShelfDocumentScriptingService {
     deleteAttribution(attributionId: number): void;
 
     /**
-     * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
+     * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
      * 
      * @param {string} url - Download-URL
+     * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
+     * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
      * @param {string} documentTypeKey - Schlüssel der Dokumentenart
      * @return {ShelfDocument} Das neu erstellte DMS-Dokument
      */
-    downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
+    downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
 
     /**
-     * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
+     * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
      * 
      * @param {string} url - Download-URL
-     * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
-     * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
      * @param {string} documentTypeKey - Schlüssel der Dokumentenart
      * @return {ShelfDocument} Das neu erstellte DMS-Dokument
      */
-    downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
+    downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
 
     /**
      * Findet ein Dokumentenart über ihren Schlüssel