@vario-software/types 2026.33.2 → 2026.33.3

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.33.2",
3
+ "version": "2026.33.3",
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",
@@ -485,21 +485,21 @@ export interface ArticleListingScriptingService {
485
485
  getNewDto(): ArticleListing;
486
486
 
487
487
  /**
488
- * Liest alle Listings zu einem Artikel mit Texten zur Sprache languageCode
488
+ * Liest alle Listings zu einem Artikel
489
489
  *
490
490
  * @param {number} articleId - ID des Artikels
491
- * @param {string} languageCode - Zu verwendende Sprache
492
491
  * @return {Array<ArticleListing>} Liste der Listings
493
492
  */
494
- readAllByArticleId(articleId: number, languageCode: string): Array<ArticleListing>;
493
+ readAllByArticleId(articleId: number): Array<ArticleListing>;
495
494
 
496
495
  /**
497
- * Liest alle Listings zu einem Artikel
496
+ * Liest alle Listings zu einem Artikel mit Texten zur Sprache languageCode
498
497
  *
499
498
  * @param {number} articleId - ID des Artikels
499
+ * @param {string} languageCode - Zu verwendende Sprache
500
500
  * @return {Array<ArticleListing>} Liste der Listings
501
501
  */
502
- readAllByArticleId(articleId: number): Array<ArticleListing>;
502
+ readAllByArticleId(articleId: number, languageCode: string): Array<ArticleListing>;
503
503
 
504
504
  /**
505
505
  * Liest eine Liste von DTOs
@@ -555,35 +555,27 @@ export interface ArticleScriptingService {
555
555
  *
556
556
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
557
557
  * @param {number} articleId - ID des zu druckenden Artikels
558
- * @param {number} articleSerialNumberId - ID der zu druckenden Seriennummer
559
- * @param {number} labelCount - Anzahl der zu druckenden Etiketten
560
558
  */
561
- addLabelToPrintBatch(batchIdentifier: string, articleId: number, articleSerialNumberId: number, labelCount: number): void;
559
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
562
560
 
563
561
  /**
564
562
  * Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
565
563
  *
566
564
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
567
565
  * @param {number} articleId - ID des zu druckenden Artikels
566
+ * @param {number} articleSerialNumberId - ID der zu druckenden Seriennummer
568
567
  * @param {number} labelCount - Anzahl der zu druckenden Etiketten
569
568
  */
570
- addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
569
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number, articleSerialNumberId: number, labelCount: number): void;
571
570
 
572
571
  /**
573
572
  * Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
574
573
  *
575
574
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
576
575
  * @param {number} articleId - ID des zu druckenden Artikels
576
+ * @param {number} labelCount - Anzahl der zu druckenden Etiketten
577
577
  */
578
- addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
579
-
580
- /**
581
- * Persistiert einen Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert
582
- *
583
- * @param {Article} toCreate - Der zu persistierende Artikel
584
- * @return {Article} Der persistierte Artikel
585
- */
586
- create(toCreate: Article): Article;
578
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
587
579
 
588
580
  /**
589
581
  * Persistiert einen Haupt-Artikel und die dazugehörigen Gebinde-Artikel.
@@ -597,6 +589,14 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
597
589
  */
598
590
  create(toCreate: Article, bundleSchemaId: number, useSameNumberForAllArticles: boolean): Article;
599
591
 
592
+ /**
593
+ * Persistiert einen Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert
594
+ *
595
+ * @param {Article} toCreate - Der zu persistierende Artikel
596
+ * @return {Article} Der persistierte Artikel
597
+ */
598
+ create(toCreate: Article): Article;
599
+
600
600
  /**
601
601
  * Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
602
602
  *
@@ -633,16 +633,16 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
633
633
  * Führt einen Etikettendrucklauf aus
634
634
  *
635
635
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
636
- * @param {string} reportGroupIdentifier - Name einer Etiketten-Report-Gruppe
637
636
  */
638
- executeLabelPrintBatch(batchIdentifier: string, reportGroupIdentifier: string): void;
637
+ executeLabelPrintBatch(batchIdentifier: string): void;
639
638
 
640
639
  /**
641
640
  * Führt einen Etikettendrucklauf aus
642
641
  *
643
642
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
643
+ * @param {string} reportGroupIdentifier - Name einer Etiketten-Report-Gruppe
644
644
  */
645
- executeLabelPrintBatch(batchIdentifier: string): void;
645
+ executeLabelPrintBatch(batchIdentifier: string, reportGroupIdentifier: string): void;
646
646
 
647
647
  /**
648
648
  * Liefert die Einkaufsrabatte zu einem Artikel
@@ -691,21 +691,21 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
691
691
  newLabelPrintBatchIdentifier(): string;
692
692
 
693
693
  /**
694
- * Liest einen Artikel mit Texten zur Sprache der eigenen Adresse
694
+ * Liest einen Artikel mit Texten zur Sprache languageCode
695
695
  *
696
696
  * @param {number} id - ID vom zu lesenden Artikel
697
+ * @param {string} languageCode - Zu verwendende Sprache
697
698
  * @return {Article} Der gelesene Artikel
698
699
  */
699
- readById(id: number): Article;
700
+ readById(id: number, languageCode: string): Article;
700
701
 
701
702
  /**
702
- * Liest einen Artikel mit Texten zur Sprache languageCode
703
+ * Liest einen Artikel mit Texten zur Sprache der eigenen Adresse
703
704
  *
704
705
  * @param {number} id - ID vom zu lesenden Artikel
705
- * @param {string} languageCode - Zu verwendende Sprache
706
706
  * @return {Article} Der gelesene Artikel
707
707
  */
708
- readById(id: number, languageCode: string): Article;
708
+ readById(id: number): Article;
709
709
 
710
710
  /**
711
711
  * Liest einen Artikel über die Artikelnummer mit Texten zur Sprache der eigenen Adresse
@@ -1827,37 +1827,37 @@ export interface DocumentScriptingService {
1827
1827
  * Bricht die Bearbeitung eines Belegs ab (Transition EDIT -> SAVED)
1828
1828
  *
1829
1829
  * @param {number} documentId - ID des Belegs
1830
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1830
1831
  * @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
1831
1832
  */
1832
- cancel(documentId: number): Document;
1833
+ cancel(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1833
1834
 
1834
1835
  /**
1835
1836
  * Bricht die Bearbeitung eines Belegs ab (Transition EDIT -> SAVED)
1836
1837
  *
1837
1838
  * @param {number} documentId - ID des Belegs
1838
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1839
1839
  * @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
1840
1840
  */
1841
- cancel(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1841
+ cancel(documentId: number): Document;
1842
1842
 
1843
1843
  /**
1844
1844
  * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
1845
1845
  *
1846
1846
  * @param {number} documentId - ID des zu kopierenden Belegs
1847
- * @param {string} targetDocumentType - Ziel-Belegart der Kopie
1848
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1847
+ * @param {string} targetDocumentTypeLabel - Ziel-Belegart der Kopie
1849
1848
  * @return {Document} Der kopierte Beleg
1850
1849
  */
1851
- copy(documentId: number, targetDocumentType: string, additionalParameters: Array<AdditionalParameter>): Document;
1850
+ copy(documentId: number, targetDocumentTypeLabel: string): Document;
1852
1851
 
1853
1852
  /**
1854
1853
  * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
1855
1854
  *
1856
1855
  * @param {number} documentId - ID des zu kopierenden Belegs
1857
- * @param {string} targetDocumentTypeLabel - Ziel-Belegart der Kopie
1856
+ * @param {string} targetDocumentType - Ziel-Belegart der Kopie
1857
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1858
1858
  * @return {Document} Der kopierte Beleg
1859
1859
  */
1860
- copy(documentId: number, targetDocumentTypeLabel: string): Document;
1860
+ copy(documentId: number, targetDocumentType: string, additionalParameters: Array<AdditionalParameter>): Document;
1861
1861
 
1862
1862
  /**
1863
1863
  * Erstellt einen neuen Beleg
@@ -1888,18 +1888,18 @@ export interface DocumentScriptingService {
1888
1888
  * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
1889
1889
  *
1890
1890
  * @param {number} documentId - ID des Belegs
1891
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1891
1892
  * @return {Document} Der Beleg in Bearbeitung
1892
1893
  */
1893
- edit(documentId: number): Document;
1894
+ edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1894
1895
 
1895
1896
  /**
1896
1897
  * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
1897
1898
  *
1898
1899
  * @param {number} documentId - ID des Belegs
1899
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1900
1900
  * @return {Document} Der Beleg in Bearbeitung
1901
1901
  */
1902
- edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1902
+ edit(documentId: number): Document;
1903
1903
 
1904
1904
  /**
1905
1905
  * Erstellt ein AdditionalParameter-Objekt
@@ -2946,14 +2946,14 @@ export interface ScriptingServiceList {
2946
2946
  crmTaskService: CrmTaskScriptingService;
2947
2947
 
2948
2948
  /**
2949
- * Service zur Verarbeitung von Shelf-Documents
2949
+ * Service zur Verarbeitung von Accounts
2950
2950
  */
2951
- shelfDocumentService: ShelfDocumentScriptingService;
2951
+ accountService: AccountScriptingService;
2952
2952
 
2953
2953
  /**
2954
- * Service zur Verarbeitung von Accounts
2954
+ * Service zur Verarbeitung von Shelf-Documents
2955
2955
  */
2956
- accountService: AccountScriptingService;
2956
+ shelfDocumentService: ShelfDocumentScriptingService;
2957
2957
 
2958
2958
  /**
2959
2959
  * Verwaltung von Versandarten
@@ -3249,24 +3249,24 @@ export interface ShelfDocumentScriptingService {
3249
3249
  deleteAttribution(attributionId: number): void;
3250
3250
 
3251
3251
  /**
3252
- * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
3252
+ * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
3253
3253
  *
3254
3254
  * @param {string} url - Download-URL
3255
- * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
3256
- * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
3257
3255
  * @param {string} documentTypeKey - Schlüssel der Dokumentenart
3258
3256
  * @return {ShelfDocument} Das neu erstellte DMS-Dokument
3259
3257
  */
3260
- downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
3258
+ downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
3261
3259
 
3262
3260
  /**
3263
- * Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
3261
+ * Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
3264
3262
  *
3265
3263
  * @param {string} url - Download-URL
3264
+ * @param {EScriptingAuthenticationType} authenticationType - Art der Authentifizierung (BASIC_AUTH, BEARER_TOKEN)
3265
+ * @param {string} authValue - Authentifizierungswert — Platzhalter (z.B. {{secret:myApi:token}}) oder Klartext. Bei BASIC_AUTH im Format 'username:password'
3266
3266
  * @param {string} documentTypeKey - Schlüssel der Dokumentenart
3267
3267
  * @return {ShelfDocument} Das neu erstellte DMS-Dokument
3268
3268
  */
3269
- downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
3269
+ downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
3270
3270
 
3271
3271
  /**
3272
3272
  * Findet ein Dokumentenart über ihren Schlüssel