@vario-software/types 2026.34.3 → 2026.34.4

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vario-software/types",
3
- "version": "2026.34.3",
3
+ "version": "2026.34.4",
4
4
  "description": "TypeScript type definitions for the VARIO Cloud platform: REST API schemas, app framework contexts and scripting interfaces. Provides type checking, autocompletion and IntelliSense in TypeScript and JavaScript projects.",
5
5
  "homepage": "https://developer.vario-software.de/",
6
6
  "bugs": "https://developer.vario-software.de/help-support",
@@ -571,27 +571,27 @@ export interface ArticleScriptingService {
571
571
  *
572
572
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
573
573
  * @param {number} articleId - ID des zu druckenden Artikels
574
- * @param {number} labelCount - Anzahl der zu druckenden Etiketten
575
574
  */
576
- addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
575
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
577
576
 
578
577
  /**
579
578
  * Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
580
579
  *
581
580
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
582
581
  * @param {number} articleId - ID des zu druckenden Artikels
583
- * @param {number} articleSerialNumberId - ID der zu druckenden Seriennummer
584
582
  * @param {number} labelCount - Anzahl der zu druckenden Etiketten
585
583
  */
586
- addLabelToPrintBatch(batchIdentifier: string, articleId: number, articleSerialNumberId: number, labelCount: number): void;
584
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
587
585
 
588
586
  /**
589
587
  * Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
590
588
  *
591
589
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
592
590
  * @param {number} articleId - ID des zu druckenden Artikels
591
+ * @param {number} articleSerialNumberId - ID der zu druckenden Seriennummer
592
+ * @param {number} labelCount - Anzahl der zu druckenden Etiketten
593
593
  */
594
- addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
594
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number, articleSerialNumberId: number, labelCount: number): void;
595
595
 
596
596
  /**
597
597
  * Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
@@ -602,14 +602,6 @@ export interface ArticleScriptingService {
602
602
  */
603
603
  create(toCreate: Article, languageCode: string): Article;
604
604
 
605
- /**
606
- * Persistiert einen Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert
607
- *
608
- * @param {Article} toCreate - Der zu persistierende Artikel
609
- * @return {Article} Der persistierte Artikel
610
- */
611
- create(toCreate: Article): Article;
612
-
613
605
  /**
614
606
  * Persistiert einen Haupt-Artikel und die dazugehörigen Gebinde-Artikel.
615
607
  Die Texte werden zur Sprache der eigenen Adresse gespeichert.
@@ -622,6 +614,14 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
622
614
  */
623
615
  create(toCreate: Article, bundleSchemaId: number, useSameNumberForAllArticles: boolean): Article;
624
616
 
617
+ /**
618
+ * Persistiert einen Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert
619
+ *
620
+ * @param {Article} toCreate - Der zu persistierende Artikel
621
+ * @return {Article} Der persistierte Artikel
622
+ */
623
+ create(toCreate: Article): Article;
624
+
625
625
  /**
626
626
  * Deaktiviert ein DTO
627
627
  *
@@ -707,38 +707,38 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
707
707
  newLabelPrintBatchIdentifier(): string;
708
708
 
709
709
  /**
710
- * Liest einen Artikel mit Texten zur Sprache der eigenen Adresse
710
+ * Liest einen Artikel mit Texten zur Sprache languageCode
711
711
  *
712
712
  * @param {number} id - ID vom zu lesenden Artikel
713
+ * @param {string} languageCode - Zu verwendende Sprache
713
714
  * @return {Article} Der gelesene Artikel
714
715
  */
715
- readById(id: number): Article;
716
+ readById(id: number, languageCode: string): Article;
716
717
 
717
718
  /**
718
- * Liest einen Artikel mit Texten zur Sprache languageCode
719
+ * Liest einen Artikel mit Texten zur Sprache der eigenen Adresse
719
720
  *
720
721
  * @param {number} id - ID vom zu lesenden Artikel
721
- * @param {string} languageCode - Zu verwendende Sprache
722
722
  * @return {Article} Der gelesene Artikel
723
723
  */
724
- readById(id: number, languageCode: string): Article;
724
+ readById(id: number): Article;
725
725
 
726
726
  /**
727
- * Liest einen Artikel über die Artikelnummer mit Texten zur Sprache {@code languageCode}
727
+ * Liest einen Artikel über die Artikelnummer mit Texten zur Sprache der eigenen Adresse
728
728
  *
729
729
  * @param {string} articleNumber - Eine Artikelnummer
730
- * @param {string} languageCode - Zu verwendende Sprache
731
730
  * @return {Article} Der gelesene Artikel
732
731
  */
733
- readByNumber(articleNumber: string, languageCode: string): Article;
732
+ readByNumber(articleNumber: string): Article;
734
733
 
735
734
  /**
736
- * Liest einen Artikel über die Artikelnummer mit Texten zur Sprache der eigenen Adresse
735
+ * Liest einen Artikel über die Artikelnummer mit Texten zur Sprache {@code languageCode}
737
736
  *
738
737
  * @param {string} articleNumber - Eine Artikelnummer
738
+ * @param {string} languageCode - Zu verwendende Sprache
739
739
  * @return {Article} Der gelesene Artikel
740
740
  */
741
- readByNumber(articleNumber: string): Article;
741
+ readByNumber(articleNumber: string, languageCode: string): Article;
742
742
 
743
743
  /**
744
744
  * Persistiert einen Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert
@@ -758,21 +758,21 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
758
758
  store(toStore: Article, languageCode: string): Article;
759
759
 
760
760
  /**
761
- * Aktualisiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
761
+ * Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
762
762
  *
763
763
  * @param {Article} toUpdate - Der zu persistierende Artikel
764
- * @param {string} languageCode -
765
764
  * @return {Article} Der aktualisiert Artikel
766
765
  */
767
- update(toUpdate: Article, languageCode: string): Article;
766
+ update(toUpdate: Article): Article;
768
767
 
769
768
  /**
770
- * Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
769
+ * Aktualisiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
771
770
  *
772
771
  * @param {Article} toUpdate - Der zu persistierende Artikel
772
+ * @param {string} languageCode -
773
773
  * @return {Article} Der aktualisiert Artikel
774
774
  */
775
- update(toUpdate: Article): Article;
775
+ update(toUpdate: Article, languageCode: string): Article;
776
776
  }
777
777
 
778
778
  /**
@@ -1843,18 +1843,18 @@ export interface DocumentScriptingService {
1843
1843
  * Bricht die Bearbeitung eines Belegs ab (Transition EDIT -> SAVED)
1844
1844
  *
1845
1845
  * @param {number} documentId - ID des Belegs
1846
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1846
1847
  * @return {Document} Der abgebrochene Beleg. Falls der Beleg erst angelegt und noch nicht gespeichert wurde, wird er gelöscht und es wird {@code null} zurückgeliefert
1847
1848
  */
1848
- cancel(documentId: number): Document;
1849
+ cancel(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1849
1850
 
1850
1851
  /**
1851
1852
  * Bricht die Bearbeitung eines Belegs ab (Transition EDIT -> SAVED)
1852
1853
  *
1853
1854
  * @param {number} documentId - ID des Belegs
1854
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1855
1855
  * @return {Document} Der abgebrochene Beleg. Falls der Beleg erst angelegt und noch nicht gespeichert wurde, wird er gelöscht und es wird {@code null} zurückgeliefert
1856
1856
  */
1857
- cancel(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1857
+ cancel(documentId: number): Document;
1858
1858
 
1859
1859
  /**
1860
1860
  * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
@@ -1887,35 +1887,35 @@ export interface DocumentScriptingService {
1887
1887
  * Löst einen Beleg auf
1888
1888
  *
1889
1889
  * @param {number} documentId - ID des aufzulösenden Belegs
1890
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1890
1891
  * @return {Document} Der aufgelöste Beleg
1891
1892
  */
1892
- dissolve(documentId: number): Document;
1893
+ dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1893
1894
 
1894
1895
  /**
1895
1896
  * Löst einen Beleg auf
1896
1897
  *
1897
1898
  * @param {number} documentId - ID des aufzulösenden Belegs
1898
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1899
1899
  * @return {Document} Der aufgelöste Beleg
1900
1900
  */
1901
- dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1901
+ dissolve(documentId: number): Document;
1902
1902
 
1903
1903
  /**
1904
1904
  * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
1905
1905
  *
1906
1906
  * @param {number} documentId - ID des Belegs
1907
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1908
1907
  * @return {Document} Der Beleg in Bearbeitung
1909
1908
  */
1910
- edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1909
+ edit(documentId: number): Document;
1911
1910
 
1912
1911
  /**
1913
1912
  * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
1914
1913
  *
1915
1914
  * @param {number} documentId - ID des Belegs
1915
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1916
1916
  * @return {Document} Der Beleg in Bearbeitung
1917
1917
  */
1918
- edit(documentId: number): Document;
1918
+ edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1919
1919
 
1920
1920
  /**
1921
1921
  * Erstellt ein AdditionalParameter-Objekt
@@ -2009,33 +2009,33 @@ export interface DocumentScriptingService {
2009
2009
  * Speichert einen Beleg (Transition EDIT -> SAVED)
2010
2010
  *
2011
2011
  * @param {number} documentId - ID des zu speichernden Belegs
2012
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
2012
2013
  * @return {Document} Der gespeicherte Beleg
2013
2014
  */
2014
- save(documentId: number): Document;
2015
+ save(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
2015
2016
 
2016
2017
  /**
2017
2018
  * Speichert einen Beleg (Transition EDIT -> SAVED)
2018
2019
  *
2019
2020
  * @param {number} documentId - ID des zu speichernden Belegs
2020
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
2021
2021
  * @return {Document} Der gespeicherte Beleg
2022
2022
  */
2023
- save(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
2023
+ save(documentId: number): Document;
2024
2024
 
2025
2025
  /**
2026
2026
  * Versendet einen Beleg per Mail
2027
2027
  *
2028
2028
  * @param {number} documentId - ID des zu versendenden Belegs
2029
+ * @param {string} reportGroupIdentifier -
2029
2030
  */
2030
- sendViaMail(documentId: number): void;
2031
+ sendViaMail(documentId: number, reportGroupIdentifier: string): void;
2031
2032
 
2032
2033
  /**
2033
2034
  * Versendet einen Beleg per Mail
2034
2035
  *
2035
2036
  * @param {number} documentId - ID des zu versendenden Belegs
2036
- * @param {string} reportGroupIdentifier -
2037
2037
  */
2038
- sendViaMail(documentId: number, reportGroupIdentifier: string): void;
2038
+ sendViaMail(documentId: number): void;
2039
2039
 
2040
2040
  /**
2041
2041
  * Überführt einen Beleg in einen anderen Status
@@ -3204,18 +3204,18 @@ export interface ScriptingUtilities {
3204
3204
  * Erstellt eine neue BigDecimal-Instanz
3205
3205
  *
3206
3206
  * @param {object} value - Der Quell-Wert
3207
+ * @param {number} scale - Anzahl Nachkommastellen
3207
3208
  * @return {number} Ein BigDecimal-Wert
3208
3209
  */
3209
- newBigDecimal(value: object): number;
3210
+ newBigDecimal(value: object, scale: number): number;
3210
3211
 
3211
3212
  /**
3212
3213
  * Erstellt eine neue BigDecimal-Instanz
3213
3214
  *
3214
3215
  * @param {object} value - Der Quell-Wert
3215
- * @param {number} scale - Anzahl Nachkommastellen
3216
3216
  * @return {number} Ein BigDecimal-Wert
3217
3217
  */
3218
- newBigDecimal(value: object, scale: number): number;
3218
+ newBigDecimal(value: object): number;
3219
3219
 
3220
3220
  /**
3221
3221
  * Erstellt eine API-Referenz
@@ -3265,24 +3265,24 @@ export interface ShelfDocumentScriptingService {
3265
3265
  deleteAttribution(attributionId: number): void;
3266
3266
 
3267
3267
  /**
3268
- * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
3268
+ * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
3269
3269
  *
3270
3270
  * @param {string} url - Download-URL
3271
+ * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
3272
+ * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
3271
3273
  * @param {string} documentTypeKey - Schlüssel der Dokumentenart
3272
3274
  * @return {ShelfDocument} Das neu erstellte DMS-Dokument
3273
3275
  */
3274
- downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
3276
+ downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
3275
3277
 
3276
3278
  /**
3277
- * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
3279
+ * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
3278
3280
  *
3279
3281
  * @param {string} url - Download-URL
3280
- * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
3281
- * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
3282
3282
  * @param {string} documentTypeKey - Schlüssel der Dokumentenart
3283
3283
  * @return {ShelfDocument} Das neu erstellte DMS-Dokument
3284
3284
  */
3285
- downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
3285
+ downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
3286
3286
 
3287
3287
  /**
3288
3288
  * Findet ein Dokumentenart über ihren Schlüssel