@vario-software/types 2026.34.2 → 2026.34.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 +1 -1
- package/scripting/services.d.ts +61 -61
- package/scripting/types.d.ts +326 -326
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vario-software/types",
|
|
3
|
-
"version": "2026.34.
|
|
3
|
+
"version": "2026.34.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",
|
package/scripting/services.d.ts
CHANGED
|
@@ -571,39 +571,36 @@ 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
|
|
574
575
|
*/
|
|
575
|
-
addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
|
|
576
|
+
addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
|
|
576
577
|
|
|
577
578
|
/**
|
|
578
579
|
* Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
|
|
579
580
|
*
|
|
580
581
|
* @param {string} batchIdentifier - ID des Etikettendrucklaufs
|
|
581
582
|
* @param {number} articleId - ID des zu druckenden Artikels
|
|
583
|
+
* @param {number} articleSerialNumberId - ID der zu druckenden Seriennummer
|
|
582
584
|
* @param {number} labelCount - Anzahl der zu druckenden Etiketten
|
|
583
585
|
*/
|
|
584
|
-
addLabelToPrintBatch(batchIdentifier: string, articleId: number, labelCount: number): void;
|
|
586
|
+
addLabelToPrintBatch(batchIdentifier: string, articleId: number, articleSerialNumberId: number, labelCount: number): void;
|
|
585
587
|
|
|
586
588
|
/**
|
|
587
589
|
* Fügt Informationen zum Druck Etiketten zu einem Artikel zu einem Etikettendrucklauf hinzu
|
|
588
590
|
*
|
|
589
591
|
* @param {string} batchIdentifier - ID des Etikettendrucklaufs
|
|
590
592
|
* @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
|
|
594
|
+
addLabelToPrintBatch(batchIdentifier: string, articleId: number): void;
|
|
595
595
|
|
|
596
596
|
/**
|
|
597
|
-
* Persistiert einen
|
|
598
|
-
Die Texte werden zur Sprache der eigenen Adresse gespeichert.
|
|
599
|
-
|
|
597
|
+
* Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
|
|
600
598
|
*
|
|
601
599
|
* @param {Article} toCreate - Der zu persistierende Artikel
|
|
602
|
-
* @param {
|
|
603
|
-
* @
|
|
604
|
-
* @return {Article} Der gespeicherte Haupt-Artikel
|
|
600
|
+
* @param {string} languageCode -
|
|
601
|
+
* @return {Article} Der persistierte Artikel
|
|
605
602
|
*/
|
|
606
|
-
create(toCreate: Article,
|
|
603
|
+
create(toCreate: Article, languageCode: string): Article;
|
|
607
604
|
|
|
608
605
|
/**
|
|
609
606
|
* Persistiert einen Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert
|
|
@@ -614,13 +611,16 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
|
|
|
614
611
|
create(toCreate: Article): Article;
|
|
615
612
|
|
|
616
613
|
/**
|
|
617
|
-
* Persistiert einen Artikel
|
|
614
|
+
* Persistiert einen Haupt-Artikel und die dazugehörigen Gebinde-Artikel.
|
|
615
|
+
Die Texte werden zur Sprache der eigenen Adresse gespeichert.
|
|
616
|
+
|
|
618
617
|
*
|
|
619
618
|
* @param {Article} toCreate - Der zu persistierende Artikel
|
|
620
|
-
* @param {
|
|
621
|
-
* @
|
|
619
|
+
* @param {number} bundleSchemaId - ID des Gebindeschemas, das als Vorlage verwendet werden soll
|
|
620
|
+
* @param {boolean} useSameNumberForAllArticles - Gleiche Artikelnummer für alle Gebindeartikel verwenden?
|
|
621
|
+
* @return {Article} Der gespeicherte Haupt-Artikel
|
|
622
622
|
*/
|
|
623
|
-
create(toCreate: Article,
|
|
623
|
+
create(toCreate: Article, bundleSchemaId: number, useSameNumberForAllArticles: boolean): Article;
|
|
624
624
|
|
|
625
625
|
/**
|
|
626
626
|
* Deaktiviert ein DTO
|
|
@@ -707,21 +707,21 @@ 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
|
|
710
|
+
* Liest einen Artikel mit Texten zur Sprache der eigenen Adresse
|
|
711
711
|
*
|
|
712
712
|
* @param {number} id - ID vom zu lesenden Artikel
|
|
713
|
-
* @param {string} languageCode - Zu verwendende Sprache
|
|
714
713
|
* @return {Article} Der gelesene Artikel
|
|
715
714
|
*/
|
|
716
|
-
readById(id: number
|
|
715
|
+
readById(id: number): Article;
|
|
717
716
|
|
|
718
717
|
/**
|
|
719
|
-
* Liest einen Artikel mit Texten zur Sprache
|
|
718
|
+
* Liest einen Artikel mit Texten zur Sprache languageCode
|
|
720
719
|
*
|
|
721
720
|
* @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): Article;
|
|
724
|
+
readById(id: number, languageCode: string): Article;
|
|
725
725
|
|
|
726
726
|
/**
|
|
727
727
|
* Liest einen Artikel über die Artikelnummer mit Texten zur Sprache {@code languageCode}
|
|
@@ -741,21 +741,21 @@ Die Texte werden zur Sprache der eigenen Adresse gespeichert.
|
|
|
741
741
|
readByNumber(articleNumber: string): Article;
|
|
742
742
|
|
|
743
743
|
/**
|
|
744
|
-
* Persistiert einen Artikel. Die Texte werden zur Sprache
|
|
744
|
+
* Persistiert einen Artikel. Die Texte werden zur Sprache der eigenen Adresse gespeichert
|
|
745
745
|
*
|
|
746
746
|
* @param {Article} toStore - Der zu persistierende Artikel
|
|
747
|
-
* @param {string} languageCode -
|
|
748
747
|
* @return {Article} Der persistierte Artikel
|
|
749
748
|
*/
|
|
750
|
-
store(toStore: Article
|
|
749
|
+
store(toStore: Article): Article;
|
|
751
750
|
|
|
752
751
|
/**
|
|
753
|
-
* Persistiert einen Artikel. Die Texte werden zur Sprache
|
|
752
|
+
* Persistiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
|
|
754
753
|
*
|
|
755
754
|
* @param {Article} toStore - Der zu persistierende Artikel
|
|
755
|
+
* @param {string} languageCode -
|
|
756
756
|
* @return {Article} Der persistierte Artikel
|
|
757
757
|
*/
|
|
758
|
-
store(toStore: Article): Article;
|
|
758
|
+
store(toStore: Article, languageCode: string): Article;
|
|
759
759
|
|
|
760
760
|
/**
|
|
761
761
|
* Aktualisiert einen Artikel. Die Texte werden zur Sprache {@code languageCode} gespeichert
|
|
@@ -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
|
|
1891
1890
|
* @return {Document} Der aufgelöste Beleg
|
|
1892
1891
|
*/
|
|
1893
|
-
dissolve(documentId: number
|
|
1892
|
+
dissolve(documentId: number): Document;
|
|
1894
1893
|
|
|
1895
1894
|
/**
|
|
1896
1895
|
* Löst einen Beleg auf
|
|
1897
1896
|
*
|
|
1898
1897
|
* @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): Document;
|
|
1901
|
+
dissolve(documentId: number, additionalParameters: Array<AdditionalParameter>): 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
|
|
1907
1908
|
* @return {Document} Der Beleg in Bearbeitung
|
|
1908
1909
|
*/
|
|
1909
|
-
edit(documentId: number): Document;
|
|
1910
|
+
edit(documentId: number, additionalParameters: Array<AdditionalParameter>): Document;
|
|
1910
1911
|
|
|
1911
1912
|
/**
|
|
1912
1913
|
* Startet die Bearbeitung eines Belegs (Transition SAVED -> EDIT)
|
|
1913
1914
|
*
|
|
1914
1915
|
* @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
|
|
1918
|
+
edit(documentId: number): Document;
|
|
1919
1919
|
|
|
1920
1920
|
/**
|
|
1921
1921
|
* Erstellt ein AdditionalParameter-Objekt
|
|
@@ -2961,26 +2961,26 @@ export interface ScriptingServiceList {
|
|
|
2961
2961
|
*/
|
|
2962
2962
|
crmTaskService: CrmTaskScriptingService;
|
|
2963
2963
|
|
|
2964
|
-
/**
|
|
2965
|
-
* Service zur Verarbeitung von Shelf-Documents
|
|
2966
|
-
*/
|
|
2967
|
-
shelfDocumentService: ShelfDocumentScriptingService;
|
|
2968
|
-
|
|
2969
2964
|
/**
|
|
2970
2965
|
* Service zur Verarbeitung von Accounts
|
|
2971
2966
|
*/
|
|
2972
2967
|
accountService: AccountScriptingService;
|
|
2973
2968
|
|
|
2974
2969
|
/**
|
|
2975
|
-
*
|
|
2970
|
+
* Service zur Verarbeitung von Shelf-Documents
|
|
2976
2971
|
*/
|
|
2977
|
-
|
|
2972
|
+
shelfDocumentService: ShelfDocumentScriptingService;
|
|
2978
2973
|
|
|
2979
2974
|
/**
|
|
2980
2975
|
* Verwaltung von Versandarten
|
|
2981
2976
|
*/
|
|
2982
2977
|
deliveryMethodService: DeliveryMethodScriptingService;
|
|
2983
2978
|
|
|
2979
|
+
/**
|
|
2980
|
+
* Logging im Scripting
|
|
2981
|
+
*/
|
|
2982
|
+
logger: LoggingScriptingService;
|
|
2983
|
+
|
|
2984
2984
|
/**
|
|
2985
2985
|
* Service zur Verarbeitung von Deals
|
|
2986
2986
|
*/
|
|
@@ -3002,14 +3002,14 @@ export interface ScriptingServiceList {
|
|
|
3002
3002
|
textTemplateService: TextTemplateScriptingService;
|
|
3003
3003
|
|
|
3004
3004
|
/**
|
|
3005
|
-
*
|
|
3005
|
+
* Service zur Verarbeitung von Hauptwarengruppen im Skripten
|
|
3006
3006
|
*/
|
|
3007
|
-
|
|
3007
|
+
productMainGroupService: ProductMainGroupScriptingService;
|
|
3008
3008
|
|
|
3009
3009
|
/**
|
|
3010
|
-
*
|
|
3010
|
+
* Ausgabe-Support Methoden
|
|
3011
3011
|
*/
|
|
3012
|
-
|
|
3012
|
+
outputHelper: ScriptOutputHelperService;
|
|
3013
3013
|
|
|
3014
3014
|
/**
|
|
3015
3015
|
* Service zur Verarbeitung von Account-Listings in Skripten
|
|
@@ -3037,14 +3037,14 @@ export interface ScriptingServiceList {
|
|
|
3037
3037
|
utils: ScriptingUtilities;
|
|
3038
3038
|
|
|
3039
3039
|
/**
|
|
3040
|
-
* Service zur Verarbeitung von
|
|
3040
|
+
* Service zur Verarbeitung von Artikel-Kundenbeziehungen im Skripten
|
|
3041
3041
|
*/
|
|
3042
|
-
|
|
3042
|
+
articleCustomerService: ArticleCustomerScriptingService;
|
|
3043
3043
|
|
|
3044
3044
|
/**
|
|
3045
|
-
* Service zur Verarbeitung von
|
|
3045
|
+
* Service zur Verarbeitung von Variantenschemas in Skripten
|
|
3046
3046
|
*/
|
|
3047
|
-
|
|
3047
|
+
variantSchemaService: VariantSchemaScriptingService;
|
|
3048
3048
|
|
|
3049
3049
|
/**
|
|
3050
3050
|
* Service zur Verarbeitung von Artikeln im Skripten
|
|
@@ -3072,14 +3072,14 @@ export interface ScriptingServiceList {
|
|
|
3072
3072
|
articleStorageService: ArticleStorageScriptingService;
|
|
3073
3073
|
|
|
3074
3074
|
/**
|
|
3075
|
-
*
|
|
3075
|
+
* Verwaltung von Zahlungsarten
|
|
3076
3076
|
*/
|
|
3077
|
-
|
|
3077
|
+
paymentMethodService: PaymentMethodScriptingService;
|
|
3078
3078
|
|
|
3079
3079
|
/**
|
|
3080
|
-
*
|
|
3080
|
+
* Anfragen von neuen Zählerkreis-Nummern
|
|
3081
3081
|
*/
|
|
3082
|
-
|
|
3082
|
+
freeSequencerService: FreeSequencerScriptingService;
|
|
3083
3083
|
|
|
3084
3084
|
/**
|
|
3085
3085
|
* Service zur Verarbeitung von AssetsTypen in Skripten
|
|
@@ -3092,14 +3092,14 @@ export interface ScriptingServiceList {
|
|
|
3092
3092
|
stockService: StockScriptingService;
|
|
3093
3093
|
|
|
3094
3094
|
/**
|
|
3095
|
-
* Service zur Verarbeitung von
|
|
3095
|
+
* Service zur Verarbeitung von Assets in Skripten
|
|
3096
3096
|
*/
|
|
3097
|
-
|
|
3097
|
+
assetService: AssetScriptingService;
|
|
3098
3098
|
|
|
3099
3099
|
/**
|
|
3100
|
-
* Service zur Verarbeitung von
|
|
3100
|
+
* Service zur Verarbeitung von Variantenwerten in Skripten
|
|
3101
3101
|
*/
|
|
3102
|
-
|
|
3102
|
+
variantValueService: VariantValueScriptingService;
|
|
3103
3103
|
|
|
3104
3104
|
/**
|
|
3105
3105
|
* Service zur Verarbeitung von ScenarioActualValue
|
|
@@ -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
|
|
3268
|
+
* Lädt eine Datei von einer URL 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'
|
|
3273
3271
|
* @param {string} documentTypeKey - Schlüssel der Dokumentenart
|
|
3274
3272
|
* @return {ShelfDocument} Das neu erstellte DMS-Dokument
|
|
3275
3273
|
*/
|
|
3276
|
-
downloadIntoDMS(url: string,
|
|
3274
|
+
downloadIntoDMS(url: string, documentTypeKey: string): ShelfDocument;
|
|
3277
3275
|
|
|
3278
3276
|
/**
|
|
3279
|
-
* Lädt eine Datei von einer URL herunter und erstellt ein neues DMS-Dokument
|
|
3277
|
+
* Lädt eine Datei von einer URL mit Authentifizierung herunter und erstellt ein neues DMS-Dokument
|
|
3280
3278
|
*
|
|
3281
3279
|
* @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, documentTypeKey: string): ShelfDocument;
|
|
3285
|
+
downloadIntoDMS(url: string, authenticationType: EScriptingAuthenticationType, authValue: string, documentTypeKey: string): ShelfDocument;
|
|
3286
3286
|
|
|
3287
3287
|
/**
|
|
3288
3288
|
* Findet ein Dokumentenart über ihren Schlüssel
|