@vario-software/types 2026.16.1 → 2026.17.0

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.
@@ -4,7 +4,8 @@ import {
4
4
  AccountRelation, AdditionalParameter, ApiCreatableReference,
5
5
  ApiObjectReference, Article, Article$Metric,
6
6
  ArticleAvailabilityDetermination, ArticleIdentifier, ArticleListing,
7
- ArticlePrintLabelSettings, ArticleSerialNumber, ArticleSupplier, Contact,
7
+ ArticlePrintLabelSettings, ArticleSerialNumber, ArticleStorage,
8
+ ArticleSupplier, BulkTransferRequestApi, BulkTransferResult, Contact,
8
9
  CountryReference, CreateNewDocumentRequest, CrmActivity, CrmActivityType,
9
10
  CrmChecklistItem, CrmDeal, CrmDealTopic, CrmObjectRef, CrmParticipant,
10
11
  CrmPriority, CrmProject, CrmReference, CrmReminder, CrmState, CrmSubType,
@@ -45,11 +46,12 @@ import {
45
46
  ScriptingDateTime, SecureHttpClient, SequencerConfiguration,
46
47
  SequencerConfigurationDetail, SerialNumberWithQuantityApi, ShelfDocument,
47
48
  ShelfDocumentAttribution, ShelfDocumentType, ShelfFile, ShelfFileMetaData,
48
- ShelfShare, ShelfTranslatableText, StorageBinRef, SubFileInfo, Supplier,
49
- TagDto, TaxIdForeignCountry, TextEnumCreate, TextEnumGet, TssSignature,
50
- UnitTypeReference, UpdateDocumentRequest, User, VariantAttribute,
51
- VariantAttributeListing, VariantDescription, VariantSchema, VariantValue,
52
- VariantValueListing
49
+ ShelfShare, ShelfTranslatableText, Stock, StockMovementManualApi,
50
+ StockTransferApi, StockTransferResult, StorageBinRef, SubFileInfo,
51
+ Supplier, TagDto, TaxIdForeignCountry, TextEnumCreate, TextEnumGet,
52
+ TssSignature, UnitTypeReference, UpdateDocumentRequest, User,
53
+ VariantAttribute, VariantAttributeListing, VariantDescription,
54
+ VariantSchema, VariantValue, VariantValueListing
53
55
  } from "./types"
54
56
 
55
57
  /**
@@ -375,17 +377,17 @@ export interface ArticleScriptingService {
375
377
  *
376
378
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
377
379
  * @param {number} articleId - ID des zu druckenden Artikels
378
- * @param {number} labelCount - Anzahl der zu druckenden Etiketten
379
380
  */
380
- addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
381
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
381
382
 
382
383
  /**
383
384
  * Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
384
385
  *
385
386
  * @param {string} batchIdentifier - ID des Etikettendrucklaufs
386
387
  * @param {number} articleId - ID des zu druckenden Artikels
388
+ * @param {number} labelCount - Anzahl der zu druckenden Etiketten
387
389
  */
388
- addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
390
+ addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
389
391
 
390
392
  /**
391
393
  * Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
@@ -557,6 +559,66 @@ export interface ArticleScriptingService {
557
559
  update(toUpdate: Article, languageCode: string): Article;
558
560
  }
559
561
 
562
+ /**
563
+ * Service zur Verarbeitung von Artikel-Lager-Beziehungen im Skripten
564
+ */
565
+ export interface ArticleStorageScriptingService {
566
+
567
+ /**
568
+ * Persistiert ein DTO
569
+ *
570
+ * @param {ArticleStorage} toCreate - Das zu persistierende DTO
571
+ * @return {ArticleStorage} Das persistierte DTO
572
+ */
573
+ create(toCreate: ArticleStorage): ArticleStorage;
574
+
575
+ /**
576
+ * Löscht eine Entity
577
+ *
578
+ * @param {number} id - ID der zu löschenden Entity
579
+ */
580
+ deleteById(id: number): void;
581
+
582
+ /**
583
+ * Erstellt eine neue DTO-Instanz
584
+ *
585
+ * @return {ArticleStorage} Die neue DTO-Instanz
586
+ */
587
+ getNewDto(): ArticleStorage;
588
+
589
+ /**
590
+ * Liest eine Liste von DTOs
591
+ *
592
+ * @param {Array<number>} ids - Die Liste der gelesenen DTOs
593
+ * @return {Array<ArticleStorage>} Die Liste der gelesenen DTOs
594
+ */
595
+ readAllById(ids: Array<number>): Array<ArticleStorage>;
596
+
597
+ /**
598
+ * Liest ein DTO
599
+ *
600
+ * @param {number} id - ID vom zu lesenden DTO
601
+ * @return {ArticleStorage} Das gelesene DTO
602
+ */
603
+ readById(id: number): ArticleStorage;
604
+
605
+ /**
606
+ * Persistiert eine DTO
607
+ *
608
+ * @param {ArticleStorage} toStore - Das zu persistierende DTO
609
+ * @return {ArticleStorage} Das persistierte DTO
610
+ */
611
+ store(toStore: ArticleStorage): ArticleStorage;
612
+
613
+ /**
614
+ * Aktualisiert ein persistiertes DTO
615
+ *
616
+ * @param {ArticleStorage} toUpdate - Die zu aktualisierende Entity
617
+ * @return {ArticleStorage} Das aktualisierte DTO
618
+ */
619
+ update(toUpdate: ArticleStorage): ArticleStorage;
620
+ }
621
+
560
622
  /**
561
623
  * Service zur Verarbeitung von Artikel-Lieferantenbeziehungen im Skripten
562
624
  */
@@ -1362,20 +1424,20 @@ export interface DocumentScriptingService {
1362
1424
  * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
1363
1425
  *
1364
1426
  * @param {number} documentId - ID des zu kopierenden Belegs
1365
- * @param {string} targetDocumentType - Ziel-Belegart der Kopie
1366
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1427
+ * @param {string} targetDocumentTypeLabel - Ziel-Belegart der Kopie
1367
1428
  * @return {Document} Der kopierte Beleg
1368
1429
  */
1369
- copy(documentId: number, targetDocumentType: string, additionalParameters: Array<AdditionalParameter>): Document;
1430
+ copy(documentId: number, targetDocumentTypeLabel: string): Document;
1370
1431
 
1371
1432
  /**
1372
1433
  * Kopiert einen Beleg in die vorgegebene Ziel-Belegart
1373
1434
  *
1374
1435
  * @param {number} documentId - ID des zu kopierenden Belegs
1375
- * @param {string} targetDocumentTypeLabel - Ziel-Belegart der Kopie
1436
+ * @param {string} targetDocumentType - Ziel-Belegart der Kopie
1437
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1376
1438
  * @return {Document} Der kopierte Beleg
1377
1439
  */
1378
- copy(documentId: number, targetDocumentTypeLabel: string): Document;
1440
+ copy(documentId: number, targetDocumentType: string, additionalParameters: Array<AdditionalParameter>): Document;
1379
1441
 
1380
1442
  /**
1381
1443
  * Erstellt einen neuen Beleg
@@ -1389,35 +1451,35 @@ export interface DocumentScriptingService {
1389
1451
  * Löst einen Beleg auf
1390
1452
  *
1391
1453
  * @param {number} documentId - ID des aufzulösenden Belegs
1392
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1393
1454
  * @return {Document} Der aufgelöste Beleg
1394
1455
  */
1395
- dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1456
+ dissolve(documentId: number): Document;
1396
1457
 
1397
1458
  /**
1398
1459
  * Löst einen Beleg auf
1399
1460
  *
1400
1461
  * @param {number} documentId - ID des aufzulösenden Belegs
1462
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1401
1463
  * @return {Document} Der aufgelöste Beleg
1402
1464
  */
1403
- dissolve(documentId: number): Document;
1465
+ dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1404
1466
 
1405
1467
  /**
1406
1468
  * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
1407
1469
  *
1408
1470
  * @param {number} documentId - ID des Belegs
1409
- * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1410
1471
  * @return {Document} Der Beleg in Bearbeitung
1411
1472
  */
1412
- edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1473
+ edit(documentId: number): Document;
1413
1474
 
1414
1475
  /**
1415
1476
  * Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
1416
1477
  *
1417
1478
  * @param {number} documentId - ID des Belegs
1479
+ * @param {Array<AdditionalParameter>} additionalParameters - Zusätzliche Parameter
1418
1480
  * @return {Document} Der Beleg in Bearbeitung
1419
1481
  */
1420
- edit(documentId: number): Document;
1482
+ edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
1421
1483
 
1422
1484
  /**
1423
1485
  * Erstellt ein AdditionalParameter-Objekt
@@ -1520,16 +1582,16 @@ export interface DocumentScriptingService {
1520
1582
  * Versendet einen Beleg per Mail
1521
1583
  *
1522
1584
  * @param {number} documentId - ID des zu versendenden Belegs
1523
- * @param {string} reportGroupIdentifier -
1524
1585
  */
1525
- sendViaMail(documentId: number, reportGroupIdentifier: string): void;
1586
+ sendViaMail(documentId: number): void;
1526
1587
 
1527
1588
  /**
1528
1589
  * Versendet einen Beleg per Mail
1529
1590
  *
1530
1591
  * @param {number} documentId - ID des zu versendenden Belegs
1592
+ * @param {string} reportGroupIdentifier -
1531
1593
  */
1532
- sendViaMail(documentId: number): void;
1594
+ sendViaMail(documentId: number, reportGroupIdentifier: string): void;
1533
1595
 
1534
1596
  /**
1535
1597
  * Überführt einen Beleg in einen anderen Status
@@ -2396,26 +2458,26 @@ export interface ScriptingServiceList {
2396
2458
  */
2397
2459
  crmTaskService: CrmTaskScriptingService;
2398
2460
 
2399
- /**
2400
- * Service zur Verarbeitung von Accounts
2401
- */
2402
- accountService: AccountScriptingService;
2403
-
2404
2461
  /**
2405
2462
  * Service zur Verarbeitung von Shelf-Documents
2406
2463
  */
2407
2464
  shelfDocumentService: ShelfDocumentScriptingService;
2408
2465
 
2409
2466
  /**
2410
- * Verwaltung von Versandarten
2467
+ * Service zur Verarbeitung von Accounts
2411
2468
  */
2412
- deliveryMethodService: DeliveryMethodScriptingService;
2469
+ accountService: AccountScriptingService;
2413
2470
 
2414
2471
  /**
2415
2472
  * Logging im Scripting
2416
2473
  */
2417
2474
  logger: LoggingScriptingService;
2418
2475
 
2476
+ /**
2477
+ * Verwaltung von Versandarten
2478
+ */
2479
+ deliveryMethodService: DeliveryMethodScriptingService;
2480
+
2419
2481
  /**
2420
2482
  * Service zur Verarbeitung von Deals
2421
2483
  */
@@ -2432,14 +2494,14 @@ export interface ScriptingServiceList {
2432
2494
  productGroupService: ProductGroupScriptingService;
2433
2495
 
2434
2496
  /**
2435
- * Service zur Verarbeitung von Hauptwarengruppen im Skripten
2497
+ * Ausgabe-Support Methoden
2436
2498
  */
2437
- productMainGroupService: ProductMainGroupScriptingService;
2499
+ outputHelper: ScriptOutputHelperService;
2438
2500
 
2439
2501
  /**
2440
- * Ausgabe-Support Methoden
2502
+ * Service zur Verarbeitung von Hauptwarengruppen im Skripten
2441
2503
  */
2442
- outputHelper: ScriptOutputHelperService;
2504
+ productMainGroupService: ProductMainGroupScriptingService;
2443
2505
 
2444
2506
  /**
2445
2507
  * Erstellt DTOs zur Verwendung im Skript
@@ -2482,15 +2544,25 @@ export interface ScriptingServiceList {
2482
2544
  variantValueListingService: VariantValueListingScriptingService;
2483
2545
 
2484
2546
  /**
2485
- * Verwaltung von Zahlungsarten
2547
+ * Service zur Verarbeitung von Artikel-Lager-Beziehungen im Skripten
2486
2548
  */
2487
- paymentMethodService: PaymentMethodScriptingService;
2549
+ articleStorageService: ArticleStorageScriptingService;
2488
2550
 
2489
2551
  /**
2490
2552
  * Anfragen von neuen Zählerkreis-Nummern
2491
2553
  */
2492
2554
  freeSequencerService: FreeSequencerScriptingService;
2493
2555
 
2556
+ /**
2557
+ * Verwaltung von Zahlungsarten
2558
+ */
2559
+ paymentMethodService: PaymentMethodScriptingService;
2560
+
2561
+ /**
2562
+ * Service zur Bestandsabfrage und Lagerbuchung in Skripten
2563
+ */
2564
+ stockService: StockScriptingService;
2565
+
2494
2566
  /**
2495
2567
  * Service zur Verarbeitung von Variantenwerten in Skripten
2496
2568
  */
@@ -2594,18 +2666,18 @@ export interface ScriptingUtilities {
2594
2666
  * Erstellt eine neue BigDecimal-Instanz
2595
2667
  *
2596
2668
  * @param {object} value - Der Quell-Wert
2669
+ * @param {number} scale - Anzahl Nachkommastellen
2597
2670
  * @return {number} Ein BigDecimal-Wert
2598
2671
  */
2599
- newBigDecimal(value: object): number;
2672
+ newBigDecimal(value: object, scale: number): number;
2600
2673
 
2601
2674
  /**
2602
2675
  * Erstellt eine neue BigDecimal-Instanz
2603
2676
  *
2604
2677
  * @param {object} value - Der Quell-Wert
2605
- * @param {number} scale - Anzahl Nachkommastellen
2606
2678
  * @return {number} Ein BigDecimal-Wert
2607
2679
  */
2608
- newBigDecimal(value: object, scale: number): number;
2680
+ newBigDecimal(value: object): number;
2609
2681
 
2610
2682
  /**
2611
2683
  * Erstellt eine API-Referenz
@@ -2705,6 +2777,72 @@ export interface ShelfDocumentScriptingService {
2705
2777
  updateAttribution(attribution: ShelfDocumentAttribution): ShelfDocumentAttribution;
2706
2778
  }
2707
2779
 
2780
+ /**
2781
+ * Service zur Bestandsabfrage und Lagerbuchung in Skripten
2782
+ */
2783
+ export interface StockScriptingService {
2784
+
2785
+ /**
2786
+ * Führt eine Stapel-Lagerumbuchung durch
2787
+ *
2788
+ * @param {BulkTransferRequestApi} bulkStockTransfer - Anweisungen für die Lagerumbuchungen
2789
+ * @return {BulkTransferResult} Ergebnis der Stapel-Lagerumbuchung
2790
+ */
2791
+ bookBulkStockTransfer(bulkStockTransfer: BulkTransferRequestApi): BulkTransferResult;
2792
+
2793
+ /**
2794
+ * Bucht eine manuelle Lagerbewegung
2795
+ *
2796
+ * @param {StockMovementManualApi} stockMovementManual - Infos zur Durchführung der manuellen Lagerbuchung
2797
+ * @return {Stock} Neuer Bestand auf dem Lagerplatz zu dem Artikel
2798
+ */
2799
+ bookManualStockMovement(stockMovementManual: StockMovementManualApi): Stock;
2800
+
2801
+ /**
2802
+ * Bucht eine Umlagerung
2803
+ *
2804
+ * @param {StockTransferApi} stockTransfer - Details zur Umlagerung
2805
+ * @return {StockTransferResult} Neuer Bestand von Quell- und Ziel-Lagerplatz zu dem Artikel
2806
+ */
2807
+ bookStockTransfer(stockTransfer: StockTransferApi): StockTransferResult;
2808
+
2809
+ /**
2810
+ * Liefert alle Bestände zu einem Artikel auf einem Lagerplatz
2811
+ *
2812
+ * @param {number} articleId - ID des Artikels
2813
+ * @param {number} storageBinId - ID des Lagerplatzes
2814
+ * @return {Array<Stock>} Liste der Bestände
2815
+ */
2816
+ findAllByArticleAndStorageBin(articleId: number, storageBinId: number): Array<Stock>;
2817
+
2818
+ /**
2819
+ * Liefert alle Bestände zu einem Artikel in einem Lager
2820
+ *
2821
+ * @param {number} articleId - ID des Artikels
2822
+ * @param {number} storageId - ID des Lagers
2823
+ * @return {Array<Stock>} Liste der Bestände
2824
+ */
2825
+ findByArticleAndStorage(articleId: number, storageId: number): Array<Stock>;
2826
+
2827
+ /**
2828
+ * Liefert alle Bestände zu einer Artikel-Seriennummer in einem Lager
2829
+ *
2830
+ * @param {number} articleSerialNumberId - ID der Artikel-Seriennummer
2831
+ * @param {number} storageId - ID des Lagers
2832
+ * @return {Array<Stock>} Liste der Bestände
2833
+ */
2834
+ findByArticleSerialNumberAndStorage(articleSerialNumberId: number, storageId: number): Array<Stock>;
2835
+
2836
+ /**
2837
+ * Liefert den Bestand zu einer Artikel-Seriennummer auf einem Lagerplatz
2838
+ *
2839
+ * @param {number} articleSerialNumberId - ID der Artikel-Seriennummer
2840
+ * @param {number} storageBinId - ID des Lagerplatzes
2841
+ * @return {Stock} Ggf. der gefundene Bestand
2842
+ */
2843
+ findByArticleSerialNumberAndStorageBin(articleSerialNumberId: number, storageBinId: number): Stock;
2844
+ }
2845
+
2708
2846
  /**
2709
2847
  * Service zur Verwendung von Tags
2710
2848
  */
@@ -3350,6 +3488,20 @@ export interface dtoFactory {
3350
3488
  */
3351
3489
  createArticleSerialNumber(): ArticleSerialNumber;
3352
3490
 
3491
+ /**
3492
+ * Erstellt einen neue Instanz von BulkTransferRequestApi
3493
+ *
3494
+ * @return {BulkTransferRequestApi} Neue Instanz von BulkTransferRequestApi
3495
+ */
3496
+ createBulkTransferRequestApi(): BulkTransferRequestApi;
3497
+
3498
+ /**
3499
+ * Erstellt einen neue Instanz von BulkTransferResult
3500
+ *
3501
+ * @return {BulkTransferResult} Neue Instanz von BulkTransferResult
3502
+ */
3503
+ createBulkTransferResult(): BulkTransferResult;
3504
+
3353
3505
  /**
3354
3506
  * Erstellt einen neue Instanz von Contact
3355
3507
  *
@@ -4008,6 +4160,34 @@ export interface dtoFactory {
4008
4160
  */
4009
4161
  createShelfTranslatableText(): ShelfTranslatableText;
4010
4162
 
4163
+ /**
4164
+ * Erstellt einen neue Instanz von Stock
4165
+ *
4166
+ * @return {Stock} Neue Instanz von Stock
4167
+ */
4168
+ createStock(): Stock;
4169
+
4170
+ /**
4171
+ * Erstellt einen neue Instanz von StockMovementManualApi
4172
+ *
4173
+ * @return {StockMovementManualApi} Neue Instanz von StockMovementManualApi
4174
+ */
4175
+ createStockMovementManualApi(): StockMovementManualApi;
4176
+
4177
+ /**
4178
+ * Erstellt einen neue Instanz von StockTransferApi
4179
+ *
4180
+ * @return {StockTransferApi} Neue Instanz von StockTransferApi
4181
+ */
4182
+ createStockTransferApi(): StockTransferApi;
4183
+
4184
+ /**
4185
+ * Erstellt einen neue Instanz von StockTransferResult
4186
+ *
4187
+ * @return {StockTransferResult} Neue Instanz von StockTransferResult
4188
+ */
4189
+ createStockTransferResult(): StockTransferResult;
4190
+
4011
4191
  /**
4012
4192
  * Erstellt einen neue Instanz von StorageBinRef
4013
4193
  *