@springtree/eva-services-core-management 3.0.0-beta.14 → 3.0.0-beta.16
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/lib/eva-services-core-management.d.ts +422 -376
- package/lib/eva-services-core-management.d.ts.map +1 -1
- package/lib/eva-services-core-management.js +4 -0
- package/lib/eva-services-core-management.js.map +1 -1
- package/lib/eva-services-core-management.services.d.ts +7 -1
- package/lib/eva-services-core-management.services.d.ts.map +1 -1
- package/lib/eva-services-core-management.services.js +6 -0
- package/lib/eva-services-core-management.services.js.map +1 -1
- package/package.json +3 -3
|
@@ -29,6 +29,10 @@ export declare const enum Errors {
|
|
|
29
29
|
*/
|
|
30
30
|
Cultures_CurrencyAlreadyExists = "Cultures:CurrencyAlreadyExists",
|
|
31
31
|
/**
|
|
32
|
+
* Additional currency must differ from main currency.
|
|
33
|
+
*/
|
|
34
|
+
Cultures_AdditionalCurrencyMustDifferFromMainCurrency = "Cultures:AdditionalCurrencyMustDifferFromMainCurrency",
|
|
35
|
+
/**
|
|
32
36
|
* The selected cashhandler is not available for the given currency
|
|
33
37
|
*/
|
|
34
38
|
Cultures_CashHandlerCurrencyMismatch = "Cultures:CashHandlerCurrencyMismatch",
|
|
@@ -379,7 +383,7 @@ export interface ListAccountsResponse {
|
|
|
379
383
|
* Update an existing Account. Make sure all properties are filled.
|
|
380
384
|
*/
|
|
381
385
|
export interface UpdateAccount {
|
|
382
|
-
BackendCode
|
|
386
|
+
BackendCode?: string | null;
|
|
383
387
|
BookingFlags?: DataModelsBookingFlags;
|
|
384
388
|
/**
|
|
385
389
|
* Entity type: Account
|
|
@@ -387,7 +391,7 @@ export interface UpdateAccount {
|
|
|
387
391
|
ID: string;
|
|
388
392
|
Name?: string;
|
|
389
393
|
ObjectAccount?: string;
|
|
390
|
-
Subsidiary
|
|
394
|
+
Subsidiary?: string | null;
|
|
391
395
|
Type?: DataModelsAccountType;
|
|
392
396
|
}
|
|
393
397
|
export interface AuditingConfigurationResponse {
|
|
@@ -527,7 +531,7 @@ export interface CreateCase {
|
|
|
527
531
|
* Can only be set once. Can be updated when not set on create.
|
|
528
532
|
*/
|
|
529
533
|
OriginatingOrganizationUnitID?: string;
|
|
530
|
-
Priority
|
|
534
|
+
Priority?: DataModelsCasePriority;
|
|
531
535
|
Title: string;
|
|
532
536
|
/**
|
|
533
537
|
* Entity type: CaseTopic
|
|
@@ -543,7 +547,7 @@ export interface CreateCaseInteraction {
|
|
|
543
547
|
* Entity type: Case
|
|
544
548
|
*/
|
|
545
549
|
CaseID: string;
|
|
546
|
-
InteractionType
|
|
550
|
+
InteractionType?: DataModelsInteractionType;
|
|
547
551
|
Text: string;
|
|
548
552
|
}
|
|
549
553
|
export interface CreateCaseInteractionResponse {
|
|
@@ -566,7 +570,7 @@ export interface CreateCaseResponse {
|
|
|
566
570
|
* Creates a new case status
|
|
567
571
|
*/
|
|
568
572
|
export interface CreateCaseStatus {
|
|
569
|
-
Action
|
|
573
|
+
Action?: DataModelsCaseStatusAction;
|
|
570
574
|
BackendID?: string;
|
|
571
575
|
Color?: string;
|
|
572
576
|
Description?: string;
|
|
@@ -1094,7 +1098,7 @@ export interface PushCase {
|
|
|
1094
1098
|
CaseRelatedItems?: CasesPushCase_PushCaseRelatedItems;
|
|
1095
1099
|
ClosingTime?: string;
|
|
1096
1100
|
CustomFields?: Record<string, TAnyValue | null>;
|
|
1097
|
-
Customer
|
|
1101
|
+
Customer?: CasesPushCase_PushCaseCustomer;
|
|
1098
1102
|
Description: string;
|
|
1099
1103
|
/**
|
|
1100
1104
|
* Setting this to true will try to suppress as many event exports as possible that might result from this call.
|
|
@@ -1103,7 +1107,7 @@ export interface PushCase {
|
|
|
1103
1107
|
Interactions?: CasesPushCase_PushCaseInteraction[];
|
|
1104
1108
|
LastInteractionTime?: string;
|
|
1105
1109
|
OriginatingOrganizationUnitBackendID?: string;
|
|
1106
|
-
Priority
|
|
1110
|
+
Priority?: DataModelsCasePriority;
|
|
1107
1111
|
ReportingTime?: string;
|
|
1108
1112
|
Solution?: string;
|
|
1109
1113
|
Status: string;
|
|
@@ -1203,7 +1207,7 @@ export interface CasesPushCase_PushCaseInteraction {
|
|
|
1203
1207
|
*/
|
|
1204
1208
|
Delete?: boolean;
|
|
1205
1209
|
Text?: string;
|
|
1206
|
-
Type
|
|
1210
|
+
Type?: DataModelsInteractionType;
|
|
1207
1211
|
}
|
|
1208
1212
|
export interface CasesPushCase_PushCaseRelatedItem {
|
|
1209
1213
|
/**
|
|
@@ -1310,18 +1314,18 @@ export interface UpdateCase {
|
|
|
1310
1314
|
* Entity type: OrganizationUnit
|
|
1311
1315
|
* OU the case is assigned to. When set this will influence visibility.
|
|
1312
1316
|
*/
|
|
1313
|
-
AssignedOrganizationUnitID
|
|
1314
|
-
BackendID
|
|
1317
|
+
AssignedOrganizationUnitID?: string | null;
|
|
1318
|
+
BackendID?: string | null;
|
|
1315
1319
|
/**
|
|
1316
1320
|
* Optional additional custom fields
|
|
1317
1321
|
*/
|
|
1318
|
-
CustomFields
|
|
1322
|
+
CustomFields?: DataModelsCustomFieldKeyValue[] | null;
|
|
1319
1323
|
/**
|
|
1320
1324
|
* Entity type: User
|
|
1321
1325
|
*/
|
|
1322
|
-
CustomerID
|
|
1326
|
+
CustomerID?: string | null;
|
|
1323
1327
|
Description?: string;
|
|
1324
|
-
ExternalOrderIdentifier
|
|
1328
|
+
ExternalOrderIdentifier?: string | null;
|
|
1325
1329
|
/**
|
|
1326
1330
|
* Entity type: Case
|
|
1327
1331
|
*/
|
|
@@ -1330,7 +1334,7 @@ export interface UpdateCase {
|
|
|
1330
1334
|
* Entity type: OrganizationUnit
|
|
1331
1335
|
* Can only be set once. Can be updated when not set on create.
|
|
1332
1336
|
*/
|
|
1333
|
-
OriginatingOrganizationUnitID
|
|
1337
|
+
OriginatingOrganizationUnitID?: string | null;
|
|
1334
1338
|
Title?: string;
|
|
1335
1339
|
/**
|
|
1336
1340
|
* Entity type: CaseTopic
|
|
@@ -1341,7 +1345,7 @@ export interface UpdateCase {
|
|
|
1341
1345
|
* Update a case interaction
|
|
1342
1346
|
*/
|
|
1343
1347
|
export interface UpdateCaseInteraction {
|
|
1344
|
-
BackendID
|
|
1348
|
+
BackendID?: string | null;
|
|
1345
1349
|
/**
|
|
1346
1350
|
* Entity type: Interaction
|
|
1347
1351
|
*/
|
|
@@ -1355,7 +1359,7 @@ export interface UpdateCaseState {
|
|
|
1355
1359
|
/**
|
|
1356
1360
|
* Entity type: User
|
|
1357
1361
|
*/
|
|
1358
|
-
AssigneeID
|
|
1362
|
+
AssigneeID?: string | null;
|
|
1359
1363
|
/**
|
|
1360
1364
|
* Entity type: Case
|
|
1361
1365
|
*/
|
|
@@ -1364,7 +1368,7 @@ export interface UpdateCaseState {
|
|
|
1364
1368
|
/**
|
|
1365
1369
|
* The solution for the case
|
|
1366
1370
|
*/
|
|
1367
|
-
Solution
|
|
1371
|
+
Solution?: string | null;
|
|
1368
1372
|
/**
|
|
1369
1373
|
* Entity type: CaseStatus
|
|
1370
1374
|
*/
|
|
@@ -1380,9 +1384,9 @@ export interface UpdateCaseStateResponse {
|
|
|
1380
1384
|
*/
|
|
1381
1385
|
export interface UpdateCaseStatus {
|
|
1382
1386
|
Action?: DataModelsCaseStatusAction;
|
|
1383
|
-
BackendID
|
|
1384
|
-
Color
|
|
1385
|
-
Description
|
|
1387
|
+
BackendID?: string | null;
|
|
1388
|
+
Color?: string | null;
|
|
1389
|
+
Description?: string | null;
|
|
1386
1390
|
/**
|
|
1387
1391
|
* Entity type: CaseStatus
|
|
1388
1392
|
*/
|
|
@@ -1392,7 +1396,7 @@ export interface UpdateCaseStatus {
|
|
|
1392
1396
|
/**
|
|
1393
1397
|
* Entity type: Script
|
|
1394
1398
|
*/
|
|
1395
|
-
ScriptID
|
|
1399
|
+
ScriptID?: string | null;
|
|
1396
1400
|
}
|
|
1397
1401
|
/**
|
|
1398
1402
|
* Update an existing case summary.
|
|
@@ -1411,8 +1415,8 @@ export interface UpdateCaseSummary {
|
|
|
1411
1415
|
* Update a case topic
|
|
1412
1416
|
*/
|
|
1413
1417
|
export interface UpdateCaseTopic {
|
|
1414
|
-
BackendID
|
|
1415
|
-
Description
|
|
1418
|
+
BackendID?: string | null;
|
|
1419
|
+
Description?: string | null;
|
|
1416
1420
|
/**
|
|
1417
1421
|
* Entity type: CaseTopic
|
|
1418
1422
|
*/
|
|
@@ -1527,34 +1531,34 @@ export interface ListCompaniesResponse {
|
|
|
1527
1531
|
* Updates a Company. Fields not provided in the request are ignored.
|
|
1528
1532
|
*/
|
|
1529
1533
|
export interface UpdateCompany {
|
|
1530
|
-
AccountHolderName
|
|
1531
|
-
BIC
|
|
1532
|
-
BackendID
|
|
1533
|
-
ContactEmailAddress
|
|
1534
|
-
ContactPhoneNumber
|
|
1535
|
-
EntityType
|
|
1536
|
-
EstablishedDate
|
|
1537
|
-
FiscalID
|
|
1538
|
-
IBAN
|
|
1534
|
+
AccountHolderName?: string | null;
|
|
1535
|
+
BIC?: string | null;
|
|
1536
|
+
BackendID?: string | null;
|
|
1537
|
+
ContactEmailAddress?: string | null;
|
|
1538
|
+
ContactPhoneNumber?: string | null;
|
|
1539
|
+
EntityType?: string | null;
|
|
1540
|
+
EstablishedDate?: string | null;
|
|
1541
|
+
FiscalID?: string | null;
|
|
1542
|
+
IBAN?: string | null;
|
|
1539
1543
|
/**
|
|
1540
1544
|
* Entity type: Company
|
|
1541
1545
|
*/
|
|
1542
1546
|
ID: string;
|
|
1543
|
-
IndustryCode
|
|
1544
|
-
InvoiceAddress
|
|
1545
|
-
InvoiceEmailAddress
|
|
1546
|
-
LogoID
|
|
1547
|
-
Name
|
|
1548
|
-
RegistrationCity
|
|
1549
|
-
RegistrationCountryID
|
|
1550
|
-
RegistrationCountrySubdivisionID
|
|
1551
|
-
RegistrationNumber
|
|
1552
|
-
SocialCapital
|
|
1553
|
-
TaxOfficeNumber
|
|
1547
|
+
IndustryCode?: string | null;
|
|
1548
|
+
InvoiceAddress?: AddressesAddressDataDto;
|
|
1549
|
+
InvoiceEmailAddress?: string | null;
|
|
1550
|
+
LogoID?: string | null;
|
|
1551
|
+
Name?: string | null;
|
|
1552
|
+
RegistrationCity?: string | null;
|
|
1553
|
+
RegistrationCountryID?: string | null;
|
|
1554
|
+
RegistrationCountrySubdivisionID?: string | null;
|
|
1555
|
+
RegistrationNumber?: string | null;
|
|
1556
|
+
SocialCapital?: number | null;
|
|
1557
|
+
TaxOfficeNumber?: string | null;
|
|
1554
1558
|
Type?: DataModelsCompanyType;
|
|
1555
|
-
VatNumber
|
|
1556
|
-
VisitorsAddress
|
|
1557
|
-
WasteDisposalNumber
|
|
1559
|
+
VatNumber?: string | null;
|
|
1560
|
+
VisitorsAddress?: AddressesAddressDataDto;
|
|
1561
|
+
WasteDisposalNumber?: string | null;
|
|
1558
1562
|
}
|
|
1559
1563
|
export interface ValidateCompany {
|
|
1560
1564
|
AccountHolderName?: string;
|
|
@@ -1689,7 +1693,7 @@ export interface GetAppSettingsForOrganizationUnit {
|
|
|
1689
1693
|
* Entity type: OrganizationUnit
|
|
1690
1694
|
*/
|
|
1691
1695
|
OrganizationUnitID: string;
|
|
1692
|
-
SortDirection
|
|
1696
|
+
SortDirection?: SortDirection;
|
|
1693
1697
|
SortProperty?: string;
|
|
1694
1698
|
}
|
|
1695
1699
|
export interface GetAppSettingsForOrganizationUnitResponse {
|
|
@@ -1898,7 +1902,7 @@ export interface ListSettings {
|
|
|
1898
1902
|
*/
|
|
1899
1903
|
OrganizationUnitID: string;
|
|
1900
1904
|
ShowDeprecationsOnly?: boolean;
|
|
1901
|
-
SortDirection
|
|
1905
|
+
SortDirection?: SortDirection;
|
|
1902
1906
|
SortProperty?: string;
|
|
1903
1907
|
TypedFilter?: ConfigurationListSettingsTypedFilters;
|
|
1904
1908
|
}
|
|
@@ -1910,7 +1914,7 @@ export interface ListSettingsPerOrganizationUnit {
|
|
|
1910
1914
|
FunctionalityCategory?: string;
|
|
1911
1915
|
Key?: string;
|
|
1912
1916
|
ShowDeprecationsOnly?: boolean;
|
|
1913
|
-
SortDirection
|
|
1917
|
+
SortDirection?: SortDirection;
|
|
1914
1918
|
SortProperty?: string;
|
|
1915
1919
|
TypedFilter?: ConfigurationListSettingsTypedFilters;
|
|
1916
1920
|
}
|
|
@@ -2131,13 +2135,13 @@ export interface CostPriceCalculationsGetCostPriceCalculationsResponse_Item {
|
|
|
2131
2135
|
Name: string;
|
|
2132
2136
|
}
|
|
2133
2137
|
export interface UpdateCostPriceCalculation {
|
|
2134
|
-
BackendID
|
|
2138
|
+
BackendID?: string | null;
|
|
2135
2139
|
Factor?: number;
|
|
2136
2140
|
/**
|
|
2137
2141
|
* Entity type: CostPriceCalculation
|
|
2138
2142
|
*/
|
|
2139
2143
|
ID: string;
|
|
2140
|
-
Name
|
|
2144
|
+
Name?: string | null;
|
|
2141
2145
|
}
|
|
2142
2146
|
/**
|
|
2143
2147
|
* Create a new Culture
|
|
@@ -2322,7 +2326,7 @@ export interface CulturesListOrganizationUnitLanguagesResponse_OrganizationUnitL
|
|
|
2322
2326
|
*/
|
|
2323
2327
|
export interface CreateCustomField {
|
|
2324
2328
|
BackendID?: string;
|
|
2325
|
-
DataType
|
|
2329
|
+
DataType?: DataModelsCustomFieldDataTypes;
|
|
2326
2330
|
DisplayName?: string;
|
|
2327
2331
|
EnumValues?: Record<string, string | null>;
|
|
2328
2332
|
InputHint?: string;
|
|
@@ -2534,23 +2538,23 @@ export interface CustomFieldsListCustomFieldsResponse_CustomFieldDto {
|
|
|
2534
2538
|
* Set options for custom fields
|
|
2535
2539
|
*/
|
|
2536
2540
|
export interface SetCustomFieldOptions {
|
|
2537
|
-
CustomFieldDefaultValue
|
|
2541
|
+
CustomFieldDefaultValue?: DataModelsCustomFieldValue;
|
|
2538
2542
|
/**
|
|
2539
2543
|
* Entity type: CustomField
|
|
2540
2544
|
*/
|
|
2541
2545
|
CustomFieldID: string;
|
|
2542
|
-
EditableByUserTypes
|
|
2546
|
+
EditableByUserTypes?: UserTypes;
|
|
2543
2547
|
/**
|
|
2544
2548
|
* Entity type: Script
|
|
2545
2549
|
*/
|
|
2546
|
-
EligibilityScriptID
|
|
2547
|
-
IsRequired
|
|
2548
|
-
MaximumDate
|
|
2549
|
-
MaximumLength
|
|
2550
|
-
MaximumValue
|
|
2551
|
-
MinimumDate
|
|
2552
|
-
MinimumLength
|
|
2553
|
-
MinimumValue
|
|
2550
|
+
EligibilityScriptID?: string | null;
|
|
2551
|
+
IsRequired?: boolean | null;
|
|
2552
|
+
MaximumDate?: string | null;
|
|
2553
|
+
MaximumLength?: number | null;
|
|
2554
|
+
MaximumValue?: number | null;
|
|
2555
|
+
MinimumDate?: string | null;
|
|
2556
|
+
MinimumLength?: number | null;
|
|
2557
|
+
MinimumValue?: number | null;
|
|
2554
2558
|
/**
|
|
2555
2559
|
* Entity type: OrganizationUnitSet
|
|
2556
2560
|
*/
|
|
@@ -2558,8 +2562,8 @@ export interface SetCustomFieldOptions {
|
|
|
2558
2562
|
/**
|
|
2559
2563
|
* Entity type: Script
|
|
2560
2564
|
*/
|
|
2561
|
-
SecurityScriptID
|
|
2562
|
-
VisibleByUserTypes
|
|
2565
|
+
SecurityScriptID?: string | null;
|
|
2566
|
+
VisibleByUserTypes?: UserTypes;
|
|
2563
2567
|
}
|
|
2564
2568
|
export interface UnsetCustomFieldOptions {
|
|
2565
2569
|
/**
|
|
@@ -2575,17 +2579,17 @@ export interface UnsetCustomFieldOptions {
|
|
|
2575
2579
|
* Update an existing custom CustomField.
|
|
2576
2580
|
*/
|
|
2577
2581
|
export interface UpdateCustomField {
|
|
2578
|
-
BackendID
|
|
2579
|
-
DisplayName
|
|
2580
|
-
EnumValues
|
|
2582
|
+
BackendID?: string | null;
|
|
2583
|
+
DisplayName?: string | null;
|
|
2584
|
+
EnumValues?: Record<string, string | null> | null;
|
|
2581
2585
|
/**
|
|
2582
2586
|
* Entity type: CustomField
|
|
2583
2587
|
*/
|
|
2584
2588
|
ID: string;
|
|
2585
|
-
InputHint
|
|
2586
|
-
Name
|
|
2589
|
+
InputHint?: string | null;
|
|
2590
|
+
Name?: string | null;
|
|
2587
2591
|
Order?: number;
|
|
2588
|
-
TypeKey
|
|
2592
|
+
TypeKey?: string | null;
|
|
2589
2593
|
}
|
|
2590
2594
|
/**
|
|
2591
2595
|
* Add required custom fields to ManualDiscount
|
|
@@ -2636,8 +2640,8 @@ export interface CreateDiscount {
|
|
|
2636
2640
|
*/
|
|
2637
2641
|
CampaignID?: string;
|
|
2638
2642
|
CannotApplyToOwnOrder?: boolean;
|
|
2639
|
-
CompliancyRule
|
|
2640
|
-
ConditionType
|
|
2643
|
+
CompliancyRule?: DataModelsDiscountCompliancyRule;
|
|
2644
|
+
ConditionType?: DataModelsDiscountConditionTypes;
|
|
2641
2645
|
Conditions?: DiscountsCreateDiscount_DiscountConditionDto[];
|
|
2642
2646
|
CouponHandler?: string;
|
|
2643
2647
|
CouponsGeneratedByOtherDiscount?: boolean;
|
|
@@ -2656,10 +2660,10 @@ export interface CreateDiscount {
|
|
|
2656
2660
|
DaysApplicable?: DaysOfWeek;
|
|
2657
2661
|
DeactivateWhenBudgetReached?: boolean;
|
|
2658
2662
|
Description: string;
|
|
2659
|
-
DiscountOrderType
|
|
2663
|
+
DiscountOrderType?: DataModelsDiscountOrderTypes;
|
|
2660
2664
|
Enable?: boolean;
|
|
2661
2665
|
EndDate?: string;
|
|
2662
|
-
FinancialDispersion
|
|
2666
|
+
FinancialDispersion?: DataModelsFinancialDespersionType;
|
|
2663
2667
|
/**
|
|
2664
2668
|
* Entity type: Blob
|
|
2665
2669
|
*/
|
|
@@ -2700,7 +2704,7 @@ export interface CreateDiscount {
|
|
|
2700
2704
|
*/
|
|
2701
2705
|
RoleIDs?: string[];
|
|
2702
2706
|
StartDate?: string;
|
|
2703
|
-
Trigger
|
|
2707
|
+
Trigger?: DataModelsDiscountTriggers;
|
|
2704
2708
|
UserUsageLimit?: number;
|
|
2705
2709
|
UserUsageReloadStrategy?: string;
|
|
2706
2710
|
}
|
|
@@ -2749,12 +2753,12 @@ export interface CreateDiscountCouponResponse {
|
|
|
2749
2753
|
* Create a discount from the given template with the overwrites with the values given in the request.
|
|
2750
2754
|
*/
|
|
2751
2755
|
export interface CreateDiscountFromTemplate {
|
|
2752
|
-
BackendID
|
|
2756
|
+
BackendID?: string | null;
|
|
2753
2757
|
/**
|
|
2754
2758
|
* Entity type: DiscountCampaign
|
|
2755
2759
|
*/
|
|
2756
|
-
CampaignID
|
|
2757
|
-
CompliancyRule
|
|
2760
|
+
CampaignID?: string | null;
|
|
2761
|
+
CompliancyRule?: DataModelsDiscountCompliancyRule;
|
|
2758
2762
|
CreateAsActive?: boolean;
|
|
2759
2763
|
/**
|
|
2760
2764
|
* Entity type: Currency
|
|
@@ -2762,12 +2766,12 @@ export interface CreateDiscountFromTemplate {
|
|
|
2762
2766
|
CurrencyID: string;
|
|
2763
2767
|
Description: string;
|
|
2764
2768
|
EndDate?: string;
|
|
2765
|
-
FinancialDispersion
|
|
2769
|
+
FinancialDispersion?: DataModelsFinancialDespersionType;
|
|
2766
2770
|
/**
|
|
2767
2771
|
* Entity type: DiscountTemplate
|
|
2768
2772
|
*/
|
|
2769
2773
|
ID: string;
|
|
2770
|
-
ImageBlobID
|
|
2774
|
+
ImageBlobID?: string | null;
|
|
2771
2775
|
IsExclusive?: boolean;
|
|
2772
2776
|
/**
|
|
2773
2777
|
* Entity type: DiscountLayer
|
|
@@ -2776,16 +2780,16 @@ export interface CreateDiscountFromTemplate {
|
|
|
2776
2780
|
/**
|
|
2777
2781
|
* Entity type: LedgerClass
|
|
2778
2782
|
*/
|
|
2779
|
-
LedgerClassID
|
|
2783
|
+
LedgerClassID?: string | null;
|
|
2780
2784
|
LoyaltyPointWithdrawal?: number;
|
|
2781
2785
|
/**
|
|
2782
2786
|
* Entity type: LoyaltyProgram
|
|
2783
2787
|
*/
|
|
2784
2788
|
LoyaltyProgramID?: string;
|
|
2785
2789
|
MarketingDescription?: string;
|
|
2786
|
-
MaximumUsage
|
|
2787
|
-
MaximumUsagePerOrder
|
|
2788
|
-
MaximumUsagePerUser
|
|
2790
|
+
MaximumUsage?: number | null;
|
|
2791
|
+
MaximumUsagePerOrder?: number | null;
|
|
2792
|
+
MaximumUsagePerUser?: number | null;
|
|
2789
2793
|
NeedsReason?: boolean;
|
|
2790
2794
|
/**
|
|
2791
2795
|
* Entity type: OrganizationUnitSet
|
|
@@ -2797,8 +2801,8 @@ export interface CreateDiscountFromTemplate {
|
|
|
2797
2801
|
*/
|
|
2798
2802
|
RestitutionOrganizationUnitID?: string;
|
|
2799
2803
|
StartDate?: string;
|
|
2800
|
-
UserUsageLimit
|
|
2801
|
-
UserUsageReloadStrategy
|
|
2804
|
+
UserUsageLimit?: number | null;
|
|
2805
|
+
UserUsageReloadStrategy?: string | null;
|
|
2802
2806
|
}
|
|
2803
2807
|
/**
|
|
2804
2808
|
* Create a new DiscountLayer
|
|
@@ -2831,18 +2835,18 @@ export interface CreateDiscountResponse {
|
|
|
2831
2835
|
export interface CreateDiscountTemplate {
|
|
2832
2836
|
ActionData: DiscountsIDiscountActionData;
|
|
2833
2837
|
ActionType: 'V2:DISCOUNTAMOUNT' | 'V2:CUSTOMERAGE' | 'V2:TIEREDCUSTOMERAGE' | 'V2:GENERATEDISCOUNTCOUPON' | 'V2:GETAPRODUCT' | 'V2:LOYALTYTIEREDDISCOUNTAMOUNT' | 'V2:LOYALTYTIEREDDISCOUNTPERCENTAGE' | 'V2:ORDERTIEREDDISCOUNTAMOUNT' | 'V2:ORDERTIEREDDISCOUNTPERCENTAGE' | 'V2:ORIGINATINGORDERDISCOUNT' | 'V2:OTHERCOSTS' | 'V2:DISCOUNTPERCENTAGE' | 'V2:TIEREDPICKAPRODUCT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTSETDISCOUNTAMOUNT' | 'V2:PRODUCTSETFIXEDPRICE' | 'V2:PRODUCTSETFREEPRODUCT' | 'V2:PRODUCTSETDISCOUNTPERCENTAGE' | 'V2:CUSTOMFIELDVALUEDETERMINEDDISCOUNT' | 'DEFAULT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
|
|
2834
|
-
AppliesTo
|
|
2838
|
+
AppliesTo?: DataModelsDiscountAppliesTo;
|
|
2835
2839
|
BackendID?: string;
|
|
2836
2840
|
/**
|
|
2837
2841
|
* Entity type: DiscountCampaign
|
|
2838
2842
|
*/
|
|
2839
2843
|
CampaignID?: string;
|
|
2840
|
-
ConditionType
|
|
2844
|
+
ConditionType?: DataModelsDiscountConditionTypes;
|
|
2841
2845
|
Conditions?: DiscountsCreateDiscountTemplate_Condition[];
|
|
2842
2846
|
CouponHandler?: string;
|
|
2843
2847
|
CouponsGeneratedByOtherDiscount?: boolean;
|
|
2844
2848
|
Description: string;
|
|
2845
|
-
DiscountOrderType
|
|
2849
|
+
DiscountOrderType?: DataModelsDiscountOrderTypes;
|
|
2846
2850
|
ImageBlobID?: string;
|
|
2847
2851
|
IsActive?: boolean;
|
|
2848
2852
|
IsExclusive?: boolean;
|
|
@@ -2858,7 +2862,7 @@ export interface CreateDiscountTemplate {
|
|
|
2858
2862
|
* Entity type: OrganizationUnit
|
|
2859
2863
|
*/
|
|
2860
2864
|
RestitutionOrganizationUnitID?: string;
|
|
2861
|
-
Trigger
|
|
2865
|
+
Trigger?: DataModelsDiscountTriggers;
|
|
2862
2866
|
UserUsageLimit?: number;
|
|
2863
2867
|
UserUsageReloadStrategy?: string;
|
|
2864
2868
|
}
|
|
@@ -3752,10 +3756,10 @@ export interface UpdateDiscount {
|
|
|
3752
3756
|
*/
|
|
3753
3757
|
CampaignID?: string;
|
|
3754
3758
|
CannotApplyToOwnOrder?: boolean;
|
|
3755
|
-
CompliancyRule
|
|
3756
|
-
ConditionType
|
|
3759
|
+
CompliancyRule?: DataModelsDiscountCompliancyRule;
|
|
3760
|
+
ConditionType?: DataModelsDiscountConditionTypes;
|
|
3757
3761
|
Conditions?: DiscountsUpdateDiscount_DiscountConditionDto[];
|
|
3758
|
-
CouponHandler
|
|
3762
|
+
CouponHandler?: string | null;
|
|
3759
3763
|
CouponsGeneratedByOtherDiscount?: boolean;
|
|
3760
3764
|
/**
|
|
3761
3765
|
* Entity type: Currency
|
|
@@ -3764,7 +3768,7 @@ export interface UpdateDiscount {
|
|
|
3764
3768
|
/**
|
|
3765
3769
|
* Optional additional custom fields
|
|
3766
3770
|
*/
|
|
3767
|
-
CustomFields
|
|
3771
|
+
CustomFields?: DataModelsCustomFieldKeyValue[] | null;
|
|
3768
3772
|
/**
|
|
3769
3773
|
* Entity type: CustomField
|
|
3770
3774
|
*/
|
|
@@ -3772,10 +3776,10 @@ export interface UpdateDiscount {
|
|
|
3772
3776
|
DaysApplicable?: DaysOfWeek;
|
|
3773
3777
|
DeactivateWhenBudgetReached?: boolean;
|
|
3774
3778
|
Description: string;
|
|
3775
|
-
DiscountOrderType
|
|
3779
|
+
DiscountOrderType?: DataModelsDiscountOrderTypes;
|
|
3776
3780
|
Enable?: boolean;
|
|
3777
3781
|
EndDate?: string;
|
|
3778
|
-
FinancialDispersion
|
|
3782
|
+
FinancialDispersion?: DataModelsFinancialDespersionType;
|
|
3779
3783
|
/**
|
|
3780
3784
|
* Entity type: Discount
|
|
3781
3785
|
*/
|
|
@@ -3807,14 +3811,14 @@ export interface UpdateDiscount {
|
|
|
3807
3811
|
/**
|
|
3808
3812
|
* For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
|
|
3809
3813
|
*/
|
|
3810
|
-
RequiredCustomFields
|
|
3814
|
+
RequiredCustomFields?: string[] | null;
|
|
3811
3815
|
/**
|
|
3812
3816
|
* Entity type: OrganizationUnit
|
|
3813
3817
|
*/
|
|
3814
3818
|
RestitutionOrganizationUnitID?: string;
|
|
3815
3819
|
RoleIDs?: string[];
|
|
3816
3820
|
StartDate?: string;
|
|
3817
|
-
Trigger
|
|
3821
|
+
Trigger?: DataModelsDiscountTriggers;
|
|
3818
3822
|
UserUsageLimit?: number;
|
|
3819
3823
|
UserUsageReloadStrategy?: string;
|
|
3820
3824
|
}
|
|
@@ -3830,21 +3834,21 @@ export interface DiscountsUpdateDiscount_DiscountConditionDto {
|
|
|
3830
3834
|
* Update an existing DiscountCampaign
|
|
3831
3835
|
*/
|
|
3832
3836
|
export interface UpdateDiscountCampaign {
|
|
3833
|
-
BackendID
|
|
3834
|
-
BackendSystemID
|
|
3837
|
+
BackendID?: string | null;
|
|
3838
|
+
BackendSystemID?: string | null;
|
|
3835
3839
|
/**
|
|
3836
3840
|
* Entity type: Currency
|
|
3837
3841
|
*/
|
|
3838
|
-
CurrencyID
|
|
3839
|
-
Description
|
|
3840
|
-
EndDate
|
|
3842
|
+
CurrencyID?: string | null;
|
|
3843
|
+
Description?: string | null;
|
|
3844
|
+
EndDate?: string | null;
|
|
3841
3845
|
/**
|
|
3842
3846
|
* Entity type: DiscountCampaign
|
|
3843
3847
|
*/
|
|
3844
3848
|
ID: string;
|
|
3845
3849
|
KeepDiscountsWithinCampaignTimespan?: boolean;
|
|
3846
|
-
Name
|
|
3847
|
-
StartDate
|
|
3850
|
+
Name?: string | null;
|
|
3851
|
+
StartDate?: string | null;
|
|
3848
3852
|
}
|
|
3849
3853
|
/**
|
|
3850
3854
|
* Update the budget on the discount campaign.
|
|
@@ -3856,7 +3860,7 @@ export interface UpdateDiscountCampaignBudget {
|
|
|
3856
3860
|
/**
|
|
3857
3861
|
* Entity type: Currency
|
|
3858
3862
|
*/
|
|
3859
|
-
CurrencyID
|
|
3863
|
+
CurrencyID?: string | null;
|
|
3860
3864
|
DeactivateDiscountsWhenBudgetIsReached?: boolean;
|
|
3861
3865
|
/**
|
|
3862
3866
|
* Entity type: DiscountCampaign
|
|
@@ -3900,18 +3904,18 @@ export interface UpdateDiscountLayer {
|
|
|
3900
3904
|
export interface UpdateDiscountTemplate {
|
|
3901
3905
|
ActionData: DiscountsIDiscountActionData;
|
|
3902
3906
|
ActionType: 'V2:DISCOUNTAMOUNT' | 'V2:CUSTOMERAGE' | 'V2:TIEREDCUSTOMERAGE' | 'V2:GENERATEDISCOUNTCOUPON' | 'V2:GETAPRODUCT' | 'V2:LOYALTYTIEREDDISCOUNTAMOUNT' | 'V2:LOYALTYTIEREDDISCOUNTPERCENTAGE' | 'V2:ORDERTIEREDDISCOUNTAMOUNT' | 'V2:ORDERTIEREDDISCOUNTPERCENTAGE' | 'V2:ORIGINATINGORDERDISCOUNT' | 'V2:OTHERCOSTS' | 'V2:DISCOUNTPERCENTAGE' | 'V2:TIEREDPICKAPRODUCT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTSETDISCOUNTAMOUNT' | 'V2:PRODUCTSETFIXEDPRICE' | 'V2:PRODUCTSETFREEPRODUCT' | 'V2:PRODUCTSETDISCOUNTPERCENTAGE' | 'V2:CUSTOMFIELDVALUEDETERMINEDDISCOUNT' | 'DEFAULT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
|
|
3903
|
-
AppliesTo
|
|
3907
|
+
AppliesTo?: DataModelsDiscountAppliesTo;
|
|
3904
3908
|
BackendID?: string;
|
|
3905
3909
|
/**
|
|
3906
3910
|
* Entity type: DiscountCampaign
|
|
3907
3911
|
*/
|
|
3908
3912
|
CampaignID?: string;
|
|
3909
|
-
ConditionType
|
|
3913
|
+
ConditionType?: DataModelsDiscountConditionTypes;
|
|
3910
3914
|
Conditions?: DiscountsUpdateDiscountTemplate_Condition[];
|
|
3911
3915
|
CouponHandler?: string;
|
|
3912
3916
|
CouponsGeneratedByOtherDiscount?: boolean;
|
|
3913
3917
|
Description: string;
|
|
3914
|
-
DiscountOrderType
|
|
3918
|
+
DiscountOrderType?: DataModelsDiscountOrderTypes;
|
|
3915
3919
|
/**
|
|
3916
3920
|
* Entity type: DiscountTemplate
|
|
3917
3921
|
*/
|
|
@@ -3931,7 +3935,7 @@ export interface UpdateDiscountTemplate {
|
|
|
3931
3935
|
* Entity type: OrganizationUnit
|
|
3932
3936
|
*/
|
|
3933
3937
|
RestitutionOrganizationUnitID?: string;
|
|
3934
|
-
Trigger
|
|
3938
|
+
Trigger?: DataModelsDiscountTriggers;
|
|
3935
3939
|
UserUsageLimit?: number;
|
|
3936
3940
|
UserUsageReloadStrategy?: string;
|
|
3937
3941
|
}
|
|
@@ -3988,8 +3992,8 @@ export interface ValidateDiscount {
|
|
|
3988
3992
|
ActionType?: 'V2:DISCOUNTAMOUNT' | 'V2:CUSTOMERAGE' | 'V2:TIEREDCUSTOMERAGE' | 'V2:GENERATEDISCOUNTCOUPON' | 'V2:GETAPRODUCT' | 'V2:LOYALTYTIEREDDISCOUNTAMOUNT' | 'V2:LOYALTYTIEREDDISCOUNTPERCENTAGE' | 'V2:ORDERTIEREDDISCOUNTAMOUNT' | 'V2:ORDERTIEREDDISCOUNTPERCENTAGE' | 'V2:ORIGINATINGORDERDISCOUNT' | 'V2:OTHERCOSTS' | 'V2:DISCOUNTPERCENTAGE' | 'V2:TIEREDPICKAPRODUCT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTSETDISCOUNTAMOUNT' | 'V2:PRODUCTSETFIXEDPRICE' | 'V2:PRODUCTSETFREEPRODUCT' | 'V2:PRODUCTSETDISCOUNTPERCENTAGE' | 'V2:CUSTOMFIELDVALUEDETERMINEDDISCOUNT' | 'DEFAULT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
|
|
3989
3993
|
AppliesTo?: DataModelsDiscountAppliesTo;
|
|
3990
3994
|
BackendID?: string;
|
|
3991
|
-
CompliancyRule
|
|
3992
|
-
ConditionType
|
|
3995
|
+
CompliancyRule?: DataModelsDiscountCompliancyRule;
|
|
3996
|
+
ConditionType?: DataModelsDiscountConditionTypes;
|
|
3993
3997
|
Conditions?: DiscountsValidateDiscount_DiscountConditionDto[];
|
|
3994
3998
|
CouponHandler?: string;
|
|
3995
3999
|
CouponsGeneratedByOtherDiscount?: boolean;
|
|
@@ -4007,9 +4011,9 @@ export interface ValidateDiscount {
|
|
|
4007
4011
|
CustomUserUsageLimitFieldID?: string;
|
|
4008
4012
|
DaysApplicable?: DaysOfWeek;
|
|
4009
4013
|
Description?: string;
|
|
4010
|
-
DiscountOrderType
|
|
4014
|
+
DiscountOrderType?: DataModelsDiscountOrderTypes;
|
|
4011
4015
|
EndDate?: string;
|
|
4012
|
-
FinancialDispersion
|
|
4016
|
+
FinancialDispersion?: DataModelsFinancialDespersionType;
|
|
4013
4017
|
/**
|
|
4014
4018
|
* Entity type: Discount
|
|
4015
4019
|
*/
|
|
@@ -4046,7 +4050,7 @@ export interface ValidateDiscount {
|
|
|
4046
4050
|
*/
|
|
4047
4051
|
RestitutionOrganizationUnitID?: string;
|
|
4048
4052
|
StartDate: string;
|
|
4049
|
-
Trigger
|
|
4053
|
+
Trigger?: DataModelsDiscountTriggers;
|
|
4050
4054
|
}
|
|
4051
4055
|
export interface DiscountsValidateDiscount_DiscountConditionDto {
|
|
4052
4056
|
Data?: IConditionData;
|
|
@@ -4072,14 +4076,14 @@ export interface DiscountsValidateDiscountResponse_CustomFieldMessage {
|
|
|
4072
4076
|
export interface ValidateDiscountTemplate {
|
|
4073
4077
|
ActionData: DiscountsIDiscountActionData;
|
|
4074
4078
|
ActionType: 'V2:DISCOUNTAMOUNT' | 'V2:CUSTOMERAGE' | 'V2:TIEREDCUSTOMERAGE' | 'V2:GENERATEDISCOUNTCOUPON' | 'V2:GETAPRODUCT' | 'V2:LOYALTYTIEREDDISCOUNTAMOUNT' | 'V2:LOYALTYTIEREDDISCOUNTPERCENTAGE' | 'V2:ORDERTIEREDDISCOUNTAMOUNT' | 'V2:ORDERTIEREDDISCOUNTPERCENTAGE' | 'V2:ORIGINATINGORDERDISCOUNT' | 'V2:OTHERCOSTS' | 'V2:DISCOUNTPERCENTAGE' | 'V2:TIEREDPICKAPRODUCT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTAMOUNTTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTAMOUNT' | 'V2:PRODUCTQUANTITYTIEREDDISCOUNTPERCENTAGE' | 'V2:PRODUCTSETDISCOUNTAMOUNT' | 'V2:PRODUCTSETFIXEDPRICE' | 'V2:PRODUCTSETFREEPRODUCT' | 'V2:PRODUCTSETDISCOUNTPERCENTAGE' | 'V2:CUSTOMFIELDVALUEDETERMINEDDISCOUNT' | 'DEFAULT' | 'RITUALSEMPLOYEE' | 'V2:RITUALSEMPLOYEE';
|
|
4075
|
-
AppliesTo
|
|
4079
|
+
AppliesTo?: DataModelsDiscountAppliesTo;
|
|
4076
4080
|
BackendID?: string;
|
|
4077
|
-
ConditionType
|
|
4081
|
+
ConditionType?: DataModelsDiscountConditionTypes;
|
|
4078
4082
|
Conditions?: DiscountsValidateDiscountTemplate_Condition[];
|
|
4079
4083
|
CouponHandler?: string;
|
|
4080
4084
|
CouponsGeneratedByOtherDiscount?: boolean;
|
|
4081
4085
|
Description: string;
|
|
4082
|
-
DiscountOrderType
|
|
4086
|
+
DiscountOrderType?: DataModelsDiscountOrderTypes;
|
|
4083
4087
|
IsExclusive?: boolean;
|
|
4084
4088
|
/**
|
|
4085
4089
|
* Entity type: LedgerClass
|
|
@@ -4093,7 +4097,7 @@ export interface ValidateDiscountTemplate {
|
|
|
4093
4097
|
* Entity type: OrganizationUnit
|
|
4094
4098
|
*/
|
|
4095
4099
|
RestitutionOrganizationUnitID?: string;
|
|
4096
|
-
Trigger
|
|
4100
|
+
Trigger?: DataModelsDiscountTriggers;
|
|
4097
4101
|
UserUsageLimit?: number;
|
|
4098
4102
|
UserUsageReloadStrategy?: string;
|
|
4099
4103
|
}
|
|
@@ -4130,14 +4134,14 @@ export interface VerifyDiscount {
|
|
|
4130
4134
|
* Create a new entity field validator
|
|
4131
4135
|
*/
|
|
4132
4136
|
export interface CreateEntityFieldValidator {
|
|
4133
|
-
ApplyFor
|
|
4134
|
-
Entity
|
|
4137
|
+
ApplyFor?: DataModelsEntityFieldValidatorUserTypes;
|
|
4138
|
+
Entity?: DataModelsEntityFieldValidatorEntityTypes;
|
|
4135
4139
|
EntityFieldName: string;
|
|
4136
4140
|
/**
|
|
4137
4141
|
* This must be of object that inherits the class EntityFieldValidatorBase. For example StringEntityFieldValidator or DefaultEntityFieldValidator
|
|
4138
4142
|
*/
|
|
4139
4143
|
ValidatorData: EntityFieldValidatorsValidatorsEntityFieldValidatorBase;
|
|
4140
|
-
ValidatorType
|
|
4144
|
+
ValidatorType?: DataModelsEntityFieldValidatorType;
|
|
4141
4145
|
}
|
|
4142
4146
|
export interface CreateEntityFieldValidatorResponse {
|
|
4143
4147
|
Error?: ServiceError;
|
|
@@ -4218,7 +4222,7 @@ export interface UpdateEntityFieldValidator {
|
|
|
4218
4222
|
* Entity type: EntityFieldValidator
|
|
4219
4223
|
*/
|
|
4220
4224
|
ID: string;
|
|
4221
|
-
ValidatorData
|
|
4225
|
+
ValidatorData?: EntityFieldValidatorsValidatorsEntityFieldValidatorBase | null;
|
|
4222
4226
|
}
|
|
4223
4227
|
/**
|
|
4224
4228
|
* -
|
|
@@ -4301,7 +4305,7 @@ export interface FinanceCashExpenseTypeOrganizationUnitSet {
|
|
|
4301
4305
|
* An example of this might be tips left by a customer.
|
|
4302
4306
|
*/
|
|
4303
4307
|
export interface CreateCashExpenseType {
|
|
4304
|
-
AmountType
|
|
4308
|
+
AmountType?: DataModelsCashExpenseAmountTypes;
|
|
4305
4309
|
BackendID?: string;
|
|
4306
4310
|
Description?: string;
|
|
4307
4311
|
LedgerClassID?: string;
|
|
@@ -4444,7 +4448,7 @@ export interface FinanceListExchangeRatesResponse_ExchangeRateDto {
|
|
|
4444
4448
|
* Updates a cash expense type. All properties except for its Name can be updated.
|
|
4445
4449
|
*/
|
|
4446
4450
|
export interface UpdateCashExpenseType {
|
|
4447
|
-
AmountType
|
|
4451
|
+
AmountType?: DataModelsCashExpenseAmountTypes;
|
|
4448
4452
|
BackendID?: string;
|
|
4449
4453
|
Description?: string;
|
|
4450
4454
|
/**
|
|
@@ -4476,7 +4480,7 @@ export interface CreateGiftCardConfiguration {
|
|
|
4476
4480
|
Data?: TAnyValue;
|
|
4477
4481
|
Handler: string;
|
|
4478
4482
|
Name: string;
|
|
4479
|
-
UsageType
|
|
4483
|
+
UsageType?: GiftCardsConfigurationGiftCardConfigurationUsageTypes;
|
|
4480
4484
|
}
|
|
4481
4485
|
export interface CreateGiftCardConfigurationResponse {
|
|
4482
4486
|
Error?: ServiceError;
|
|
@@ -4641,8 +4645,8 @@ export interface UpdateGiftCardConfiguration {
|
|
|
4641
4645
|
/**
|
|
4642
4646
|
* Some gift card handlers are able to handle multiple types of cards. With this property you can set the card the handler should work with.
|
|
4643
4647
|
*/
|
|
4644
|
-
CardType
|
|
4645
|
-
Data
|
|
4648
|
+
CardType?: string | null;
|
|
4649
|
+
Data?: TAnyValue | null;
|
|
4646
4650
|
Handler?: string;
|
|
4647
4651
|
/**
|
|
4648
4652
|
* Entity type: GiftCardConfiguration
|
|
@@ -4658,11 +4662,11 @@ export interface UpdateProductGiftCard {
|
|
|
4658
4662
|
/**
|
|
4659
4663
|
* Communication options for digital giftcards
|
|
4660
4664
|
*/
|
|
4661
|
-
CommunicationOptions
|
|
4665
|
+
CommunicationOptions?: GiftCardsConfigurationProductGiftCardCommunicationOptions;
|
|
4662
4666
|
/**
|
|
4663
4667
|
* Entity type: GiftCardConfiguration
|
|
4664
4668
|
*/
|
|
4665
|
-
GiftCardConfigurationID
|
|
4669
|
+
GiftCardConfigurationID?: string | null;
|
|
4666
4670
|
/**
|
|
4667
4671
|
* Entity type: ProductGiftCard
|
|
4668
4672
|
*/
|
|
@@ -4683,7 +4687,7 @@ export interface CreateClientApplication {
|
|
|
4683
4687
|
BackendID: string;
|
|
4684
4688
|
Name: string;
|
|
4685
4689
|
NotificationConfiguration?: string;
|
|
4686
|
-
Type
|
|
4690
|
+
Type?: DataModelsClientApplicationType;
|
|
4687
4691
|
}
|
|
4688
4692
|
export interface CreateClientApplicationResponse {
|
|
4689
4693
|
Error?: ServiceError;
|
|
@@ -4936,17 +4940,17 @@ export interface UpdateClientApplication {
|
|
|
4936
4940
|
*/
|
|
4937
4941
|
ID: string;
|
|
4938
4942
|
Name?: string;
|
|
4939
|
-
NotificationConfiguration
|
|
4943
|
+
NotificationConfiguration?: string | null;
|
|
4940
4944
|
Type?: DataModelsClientApplicationType;
|
|
4941
4945
|
}
|
|
4942
4946
|
/**
|
|
4943
4947
|
* Updates a device
|
|
4944
4948
|
*/
|
|
4945
4949
|
export interface UpdateDevice {
|
|
4946
|
-
Address
|
|
4947
|
-
AssemblyName
|
|
4948
|
-
BackendID
|
|
4949
|
-
Data
|
|
4950
|
+
Address?: string | null;
|
|
4951
|
+
AssemblyName?: string | null;
|
|
4952
|
+
BackendID?: string | null;
|
|
4953
|
+
Data?: DevicesIDeviceTypeData | null;
|
|
4950
4954
|
/**
|
|
4951
4955
|
* Entity type: Device
|
|
4952
4956
|
*/
|
|
@@ -4955,15 +4959,15 @@ export interface UpdateDevice {
|
|
|
4955
4959
|
/**
|
|
4956
4960
|
* Entity type: OrganizationUnit
|
|
4957
4961
|
*/
|
|
4958
|
-
OrganizationUnitID
|
|
4962
|
+
OrganizationUnitID?: string | null;
|
|
4959
4963
|
/**
|
|
4960
4964
|
* Entity type: PrinterType
|
|
4961
4965
|
*/
|
|
4962
|
-
PrinterTypeID
|
|
4966
|
+
PrinterTypeID?: string | null;
|
|
4963
4967
|
/**
|
|
4964
4968
|
* Entity type: Station
|
|
4965
4969
|
*/
|
|
4966
|
-
StationID
|
|
4970
|
+
StationID?: string | null;
|
|
4967
4971
|
TypeID?: string;
|
|
4968
4972
|
}
|
|
4969
4973
|
/**
|
|
@@ -4991,11 +4995,11 @@ export interface UpdateOrganizationUnitPublicIpAddress {
|
|
|
4991
4995
|
* Updates a station.
|
|
4992
4996
|
*/
|
|
4993
4997
|
export interface UpdateStation {
|
|
4994
|
-
BackendID
|
|
4998
|
+
BackendID?: string | null;
|
|
4995
4999
|
/**
|
|
4996
5000
|
* Optional additional custom fields
|
|
4997
5001
|
*/
|
|
4998
|
-
CustomFields
|
|
5002
|
+
CustomFields?: DataModelsCustomFieldKeyValue[] | null;
|
|
4999
5003
|
/**
|
|
5000
5004
|
* Entity type: Station
|
|
5001
5005
|
*/
|
|
@@ -5100,7 +5104,7 @@ export interface ListInquiriesResponse {
|
|
|
5100
5104
|
* Update an inquiry
|
|
5101
5105
|
*/
|
|
5102
5106
|
export interface UpdateInquiry {
|
|
5103
|
-
Description
|
|
5107
|
+
Description?: string | null;
|
|
5104
5108
|
/**
|
|
5105
5109
|
* Entity type: Inquiry
|
|
5106
5110
|
*/
|
|
@@ -5108,13 +5112,13 @@ export interface UpdateInquiry {
|
|
|
5108
5112
|
Name?: string;
|
|
5109
5113
|
OneTimeUseOnly?: boolean;
|
|
5110
5114
|
PromptUser?: boolean;
|
|
5111
|
-
ScriptID
|
|
5115
|
+
ScriptID?: string | null;
|
|
5112
5116
|
}
|
|
5113
5117
|
/**
|
|
5114
5118
|
* Updates an inquiry item
|
|
5115
5119
|
*/
|
|
5116
5120
|
export interface UpdateInquiryItem {
|
|
5117
|
-
Description
|
|
5121
|
+
Description?: string | null;
|
|
5118
5122
|
/**
|
|
5119
5123
|
* Entity type: InquiryItem
|
|
5120
5124
|
*/
|
|
@@ -5221,7 +5225,7 @@ export interface CreateLoyaltyProgram {
|
|
|
5221
5225
|
LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
|
|
5222
5226
|
LoyaltyProgramGroupID?: string;
|
|
5223
5227
|
Name: string;
|
|
5224
|
-
Options
|
|
5228
|
+
Options?: DataModelsLoyaltyProgramOptions;
|
|
5225
5229
|
PointExpirationPolicyData?: Record<string, TAnyValue>;
|
|
5226
5230
|
PointExpirationPolicyType?: string;
|
|
5227
5231
|
PointPendingPolicyData?: Record<string, TAnyValue>;
|
|
@@ -5259,7 +5263,7 @@ export interface CreateLoyaltyProgram {
|
|
|
5259
5263
|
*/
|
|
5260
5264
|
ResubscribeHandling?: DataModelsResubscribeHandlingType;
|
|
5261
5265
|
StartDate?: string;
|
|
5262
|
-
Status
|
|
5266
|
+
Status?: DataModelsLoyaltyProgramStatus;
|
|
5263
5267
|
UserBudget?: number;
|
|
5264
5268
|
/**
|
|
5265
5269
|
* Attention!
|
|
@@ -5316,7 +5320,7 @@ export interface CreateLoyaltyProgramGroup {
|
|
|
5316
5320
|
EndDate?: string;
|
|
5317
5321
|
Name: string;
|
|
5318
5322
|
StartDate?: string;
|
|
5319
|
-
Status
|
|
5323
|
+
Status?: DataModelsLoyaltyProgramStatus;
|
|
5320
5324
|
TaxExemptionCode?: string;
|
|
5321
5325
|
}
|
|
5322
5326
|
export interface CreateLoyaltyProgramGroupResponse {
|
|
@@ -5331,6 +5335,7 @@ export interface CreateLoyaltyProgramGroupResponse {
|
|
|
5331
5335
|
* Create a new LoyaltyProgramPaymentType
|
|
5332
5336
|
*/
|
|
5333
5337
|
export interface CreateLoyaltyProgramPaymentType {
|
|
5338
|
+
AllowPartialPayment?: boolean;
|
|
5334
5339
|
BackendID?: string;
|
|
5335
5340
|
Budget?: number;
|
|
5336
5341
|
ExcludeFromProgramBudget?: boolean;
|
|
@@ -5347,9 +5352,9 @@ export interface CreateLoyaltyProgramPaymentType {
|
|
|
5347
5352
|
ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
|
|
5348
5353
|
Required?: boolean;
|
|
5349
5354
|
Sequence?: number;
|
|
5350
|
-
TaxHandling
|
|
5355
|
+
TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
5351
5356
|
UserBudget?: number;
|
|
5352
|
-
UserBudgetDeduction
|
|
5357
|
+
UserBudgetDeduction?: DataModelsUserBudgetDeduction;
|
|
5353
5358
|
UserMaximumUsage?: number;
|
|
5354
5359
|
}
|
|
5355
5360
|
export interface CreateLoyaltyProgramPaymentTypeResponse {
|
|
@@ -6152,7 +6157,7 @@ export interface LoyaltyPushLoyaltyProgram {
|
|
|
6152
6157
|
/**
|
|
6153
6158
|
* Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
|
|
6154
6159
|
*/
|
|
6155
|
-
AllowUnsubscribeBy
|
|
6160
|
+
AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
|
|
6156
6161
|
/**
|
|
6157
6162
|
* When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
|
|
6158
6163
|
* When false, the loyalty program will automatically be applied if all conditions are met.
|
|
@@ -6165,16 +6170,16 @@ export interface LoyaltyPushLoyaltyProgram {
|
|
|
6165
6170
|
* This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
|
|
6166
6171
|
*/
|
|
6167
6172
|
AutoSubscribeCustomer?: boolean;
|
|
6168
|
-
Budget
|
|
6173
|
+
Budget?: number | null;
|
|
6169
6174
|
/**
|
|
6170
6175
|
* Entity type: Currency
|
|
6171
6176
|
*/
|
|
6172
|
-
BudgetCurrencyID
|
|
6177
|
+
BudgetCurrencyID?: string | null;
|
|
6173
6178
|
Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
|
|
6174
|
-
Data
|
|
6179
|
+
Data?: TAnyValue | null;
|
|
6175
6180
|
DeactivateWhenBudgetIsReached?: boolean;
|
|
6176
|
-
Description
|
|
6177
|
-
EndDate
|
|
6181
|
+
Description?: string | null;
|
|
6182
|
+
EndDate?: string | null;
|
|
6178
6183
|
Handler?: string;
|
|
6179
6184
|
/**
|
|
6180
6185
|
* Entity type: LoyaltyProgram
|
|
@@ -6184,23 +6189,23 @@ export interface LoyaltyPushLoyaltyProgram {
|
|
|
6184
6189
|
/**
|
|
6185
6190
|
* Entity type: LoyaltyProgramGroup
|
|
6186
6191
|
*/
|
|
6187
|
-
LoyaltyProgramGroupID
|
|
6192
|
+
LoyaltyProgramGroupID?: string | null;
|
|
6188
6193
|
Name?: string;
|
|
6189
6194
|
Options?: DataModelsLoyaltyProgramOptions;
|
|
6190
6195
|
OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
|
|
6191
6196
|
PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
|
|
6192
6197
|
PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
|
|
6193
|
-
PointExpirationPolicyData
|
|
6194
|
-
PointExpirationPolicyType
|
|
6195
|
-
PointPendingPolicyData
|
|
6196
|
-
PointPendingPolicyType
|
|
6198
|
+
PointExpirationPolicyData?: Record<string, TAnyValue> | null;
|
|
6199
|
+
PointExpirationPolicyType?: string | null;
|
|
6200
|
+
PointPendingPolicyData?: Record<string, TAnyValue> | null;
|
|
6201
|
+
PointPendingPolicyType?: string | null;
|
|
6197
6202
|
/**
|
|
6198
6203
|
* Entity type: PriceList
|
|
6199
6204
|
*/
|
|
6200
6205
|
PriceLists?: string[];
|
|
6201
6206
|
ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
|
|
6202
6207
|
ReactivateProgramWhenPossible?: boolean;
|
|
6203
|
-
ReloadPolicy
|
|
6208
|
+
ReloadPolicy?: string | null;
|
|
6204
6209
|
/**
|
|
6205
6210
|
* When true, the loyalty program will only be applied when a customer is attached to the order.
|
|
6206
6211
|
*
|
|
@@ -6213,7 +6218,7 @@ export interface LoyaltyPushLoyaltyProgram {
|
|
|
6213
6218
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6214
6219
|
* When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
|
|
6215
6220
|
*/
|
|
6216
|
-
RequireManualUserIdentifier
|
|
6221
|
+
RequireManualUserIdentifier?: boolean | null;
|
|
6217
6222
|
RequiredCustomFields?: string[];
|
|
6218
6223
|
/**
|
|
6219
6224
|
* When true, the loyalty program will only be applied when a customer is attached to the order that is already subscribed to the loyalty program.
|
|
@@ -6232,29 +6237,29 @@ export interface LoyaltyPushLoyaltyProgram {
|
|
|
6232
6237
|
/**
|
|
6233
6238
|
* Handling when a user is unsubscribed and re-subscribes.
|
|
6234
6239
|
*/
|
|
6235
|
-
ResubscribeHandling
|
|
6236
|
-
StartDate
|
|
6240
|
+
ResubscribeHandling?: DataModelsResubscribeHandlingType;
|
|
6241
|
+
StartDate?: string | null;
|
|
6237
6242
|
Status?: DataModelsLoyaltyProgramStatus;
|
|
6238
|
-
UserBudget
|
|
6243
|
+
UserBudget?: number | null;
|
|
6239
6244
|
/**
|
|
6240
6245
|
* Attention!
|
|
6241
6246
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6242
6247
|
* When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
|
|
6243
6248
|
*/
|
|
6244
|
-
UserIdentifierPrefix
|
|
6249
|
+
UserIdentifierPrefix?: string | null;
|
|
6245
6250
|
/**
|
|
6246
6251
|
* Attention!
|
|
6247
6252
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6248
6253
|
* When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
|
|
6249
6254
|
*/
|
|
6250
|
-
UserIdentifierStartNumber
|
|
6255
|
+
UserIdentifierStartNumber?: string | null;
|
|
6251
6256
|
/**
|
|
6252
6257
|
* Attention!
|
|
6253
6258
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6254
6259
|
* When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
|
|
6255
6260
|
*/
|
|
6256
|
-
UserIdentifierSuffix
|
|
6257
|
-
UserMaximumUsage
|
|
6261
|
+
UserIdentifierSuffix?: string | null;
|
|
6262
|
+
UserMaximumUsage?: number | null;
|
|
6258
6263
|
}
|
|
6259
6264
|
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition {
|
|
6260
6265
|
Data: Record<string, TAnyValue>;
|
|
@@ -6271,6 +6276,7 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet
|
|
|
6271
6276
|
OrganizationUnitSetID?: string;
|
|
6272
6277
|
}
|
|
6273
6278
|
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
|
|
6279
|
+
AllowPartialPayment?: boolean;
|
|
6274
6280
|
Budget?: number;
|
|
6275
6281
|
ExcludeFromProgramBudget?: boolean;
|
|
6276
6282
|
/**
|
|
@@ -6286,9 +6292,9 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
|
|
|
6286
6292
|
ProductLimitation?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData;
|
|
6287
6293
|
Required?: boolean;
|
|
6288
6294
|
Sequence?: number;
|
|
6289
|
-
TaxHandling
|
|
6295
|
+
TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
6290
6296
|
UserBudget?: number;
|
|
6291
|
-
UserBudgetDeduction
|
|
6297
|
+
UserBudgetDeduction?: DataModelsUserBudgetDeduction;
|
|
6292
6298
|
UserMaximumUsage?: number;
|
|
6293
6299
|
}
|
|
6294
6300
|
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData {
|
|
@@ -6383,7 +6389,7 @@ export interface PushLoyaltyProgramGroup_Async {
|
|
|
6383
6389
|
ID: string;
|
|
6384
6390
|
Name: string;
|
|
6385
6391
|
StartDate?: string;
|
|
6386
|
-
Status
|
|
6392
|
+
Status?: DataModelsLoyaltyProgramStatus;
|
|
6387
6393
|
TaxExemptionCode?: string;
|
|
6388
6394
|
}
|
|
6389
6395
|
export interface PushLoyaltyProgramGroup_AsyncResponse {
|
|
@@ -6410,7 +6416,7 @@ export interface PushLoyaltyProgram_Async {
|
|
|
6410
6416
|
/**
|
|
6411
6417
|
* Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
|
|
6412
6418
|
*/
|
|
6413
|
-
AllowUnsubscribeBy
|
|
6419
|
+
AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
|
|
6414
6420
|
/**
|
|
6415
6421
|
* When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
|
|
6416
6422
|
* When false, the loyalty program will automatically be applied if all conditions are met.
|
|
@@ -6423,16 +6429,16 @@ export interface PushLoyaltyProgram_Async {
|
|
|
6423
6429
|
* This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
|
|
6424
6430
|
*/
|
|
6425
6431
|
AutoSubscribeCustomer?: boolean;
|
|
6426
|
-
Budget
|
|
6432
|
+
Budget?: number | null;
|
|
6427
6433
|
/**
|
|
6428
6434
|
* Entity type: Currency
|
|
6429
6435
|
*/
|
|
6430
|
-
BudgetCurrencyID
|
|
6436
|
+
BudgetCurrencyID?: string | null;
|
|
6431
6437
|
Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
|
|
6432
|
-
Data
|
|
6438
|
+
Data?: TAnyValue | null;
|
|
6433
6439
|
DeactivateWhenBudgetIsReached?: boolean;
|
|
6434
|
-
Description
|
|
6435
|
-
EndDate
|
|
6440
|
+
Description?: string | null;
|
|
6441
|
+
EndDate?: string | null;
|
|
6436
6442
|
Handler?: string;
|
|
6437
6443
|
/**
|
|
6438
6444
|
* Entity type: LoyaltyProgram
|
|
@@ -6442,23 +6448,23 @@ export interface PushLoyaltyProgram_Async {
|
|
|
6442
6448
|
/**
|
|
6443
6449
|
* Entity type: LoyaltyProgramGroup
|
|
6444
6450
|
*/
|
|
6445
|
-
LoyaltyProgramGroupID
|
|
6451
|
+
LoyaltyProgramGroupID?: string | null;
|
|
6446
6452
|
Name?: string;
|
|
6447
6453
|
Options?: DataModelsLoyaltyProgramOptions;
|
|
6448
6454
|
OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
|
|
6449
6455
|
PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
|
|
6450
6456
|
PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
|
|
6451
|
-
PointExpirationPolicyData
|
|
6452
|
-
PointExpirationPolicyType
|
|
6453
|
-
PointPendingPolicyData
|
|
6454
|
-
PointPendingPolicyType
|
|
6457
|
+
PointExpirationPolicyData?: Record<string, TAnyValue> | null;
|
|
6458
|
+
PointExpirationPolicyType?: string | null;
|
|
6459
|
+
PointPendingPolicyData?: Record<string, TAnyValue> | null;
|
|
6460
|
+
PointPendingPolicyType?: string | null;
|
|
6455
6461
|
/**
|
|
6456
6462
|
* Entity type: PriceList
|
|
6457
6463
|
*/
|
|
6458
6464
|
PriceLists?: string[];
|
|
6459
6465
|
ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
|
|
6460
6466
|
ReactivateProgramWhenPossible?: boolean;
|
|
6461
|
-
ReloadPolicy
|
|
6467
|
+
ReloadPolicy?: string | null;
|
|
6462
6468
|
/**
|
|
6463
6469
|
* When true, the loyalty program will only be applied when a customer is attached to the order.
|
|
6464
6470
|
*
|
|
@@ -6471,7 +6477,7 @@ export interface PushLoyaltyProgram_Async {
|
|
|
6471
6477
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6472
6478
|
* When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
|
|
6473
6479
|
*/
|
|
6474
|
-
RequireManualUserIdentifier
|
|
6480
|
+
RequireManualUserIdentifier?: boolean | null;
|
|
6475
6481
|
RequiredCustomFields?: string[];
|
|
6476
6482
|
/**
|
|
6477
6483
|
* When true, the loyalty program will only be applied when a customer is attached to the order that is already subscribed to the loyalty program.
|
|
@@ -6490,29 +6496,29 @@ export interface PushLoyaltyProgram_Async {
|
|
|
6490
6496
|
/**
|
|
6491
6497
|
* Handling when a user is unsubscribed and re-subscribes.
|
|
6492
6498
|
*/
|
|
6493
|
-
ResubscribeHandling
|
|
6494
|
-
StartDate
|
|
6499
|
+
ResubscribeHandling?: DataModelsResubscribeHandlingType;
|
|
6500
|
+
StartDate?: string | null;
|
|
6495
6501
|
Status?: DataModelsLoyaltyProgramStatus;
|
|
6496
|
-
UserBudget
|
|
6502
|
+
UserBudget?: number | null;
|
|
6497
6503
|
/**
|
|
6498
6504
|
* Attention!
|
|
6499
6505
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6500
6506
|
* When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
|
|
6501
6507
|
*/
|
|
6502
|
-
UserIdentifierPrefix
|
|
6508
|
+
UserIdentifierPrefix?: string | null;
|
|
6503
6509
|
/**
|
|
6504
6510
|
* Attention!
|
|
6505
6511
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6506
6512
|
* When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
|
|
6507
6513
|
*/
|
|
6508
|
-
UserIdentifierStartNumber
|
|
6514
|
+
UserIdentifierStartNumber?: string | null;
|
|
6509
6515
|
/**
|
|
6510
6516
|
* Attention!
|
|
6511
6517
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6512
6518
|
* When this is not the case on create, this can be introduced on update. This value cannot be changed after it is set in either the create or update.
|
|
6513
6519
|
*/
|
|
6514
|
-
UserIdentifierSuffix
|
|
6515
|
-
UserMaximumUsage
|
|
6520
|
+
UserIdentifierSuffix?: string | null;
|
|
6521
|
+
UserMaximumUsage?: number | null;
|
|
6516
6522
|
}
|
|
6517
6523
|
export interface PushLoyaltyProgram_AsyncResponse {
|
|
6518
6524
|
Error?: ServiceError;
|
|
@@ -6598,7 +6604,7 @@ export interface UpdateLoyaltyProgram {
|
|
|
6598
6604
|
/**
|
|
6599
6605
|
* Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
|
|
6600
6606
|
*/
|
|
6601
|
-
AllowUnsubscribeBy
|
|
6607
|
+
AllowUnsubscribeBy?: DataModelsAllowUnsubscribeByType;
|
|
6602
6608
|
/**
|
|
6603
6609
|
* When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
|
|
6604
6610
|
* When false, the loyalty program will automatically be applied if all conditions are met.
|
|
@@ -6611,27 +6617,27 @@ export interface UpdateLoyaltyProgram {
|
|
|
6611
6617
|
* This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
|
|
6612
6618
|
*/
|
|
6613
6619
|
AutoSubscribeCustomer?: boolean;
|
|
6614
|
-
BackendID
|
|
6620
|
+
BackendID?: string | null;
|
|
6615
6621
|
/**
|
|
6616
6622
|
* Entity type: Currency
|
|
6617
6623
|
*/
|
|
6618
|
-
BudgetCurrencyID
|
|
6619
|
-
Data
|
|
6620
|
-
Description
|
|
6621
|
-
EndDate
|
|
6624
|
+
BudgetCurrencyID?: string | null;
|
|
6625
|
+
Data?: TAnyValue | null;
|
|
6626
|
+
Description?: string | null;
|
|
6627
|
+
EndDate?: string | null;
|
|
6622
6628
|
/**
|
|
6623
6629
|
* Entity type: LoyaltyProgram
|
|
6624
6630
|
*/
|
|
6625
6631
|
ID: string;
|
|
6626
6632
|
LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
|
|
6627
|
-
LoyaltyProgramGroupID
|
|
6633
|
+
LoyaltyProgramGroupID?: string | null;
|
|
6628
6634
|
Name?: string;
|
|
6629
6635
|
Options?: DataModelsLoyaltyProgramOptions;
|
|
6630
|
-
PointExpirationPolicyData
|
|
6631
|
-
PointExpirationPolicyType
|
|
6632
|
-
PointPendingPolicyData
|
|
6633
|
-
PointPendingPolicyType
|
|
6634
|
-
ReloadPolicy
|
|
6636
|
+
PointExpirationPolicyData?: Record<string, TAnyValue> | null;
|
|
6637
|
+
PointExpirationPolicyType?: string | null;
|
|
6638
|
+
PointPendingPolicyData?: Record<string, TAnyValue> | null;
|
|
6639
|
+
PointPendingPolicyType?: string | null;
|
|
6640
|
+
ReloadPolicy?: string | null;
|
|
6635
6641
|
/**
|
|
6636
6642
|
* When true, the loyalty program will only be applied when a customer is attached to the order.
|
|
6637
6643
|
*
|
|
@@ -6644,7 +6650,7 @@ export interface UpdateLoyaltyProgram {
|
|
|
6644
6650
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6645
6651
|
* This value cannot be changed after it is set in either the create or update.
|
|
6646
6652
|
*/
|
|
6647
|
-
RequireManualUserIdentifier
|
|
6653
|
+
RequireManualUserIdentifier?: boolean | null;
|
|
6648
6654
|
/**
|
|
6649
6655
|
* When true, the loyalty program will only be applied when a customer is attached to the order that is already subscribed to the loyalty program.
|
|
6650
6656
|
* Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
|
|
@@ -6662,29 +6668,29 @@ export interface UpdateLoyaltyProgram {
|
|
|
6662
6668
|
/**
|
|
6663
6669
|
* Handling when a user is unsubscribed and re-subscribes.
|
|
6664
6670
|
*/
|
|
6665
|
-
ResubscribeHandling
|
|
6666
|
-
StartDate
|
|
6671
|
+
ResubscribeHandling?: DataModelsResubscribeHandlingType;
|
|
6672
|
+
StartDate?: string | null;
|
|
6667
6673
|
Status?: DataModelsLoyaltyProgramStatus;
|
|
6668
|
-
UserBudget
|
|
6674
|
+
UserBudget?: number | null;
|
|
6669
6675
|
/**
|
|
6670
6676
|
* Attention!
|
|
6671
6677
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6672
6678
|
* This value cannot be changed after it is set in either the create or update.
|
|
6673
6679
|
*/
|
|
6674
|
-
UserIdentifierPrefix
|
|
6680
|
+
UserIdentifierPrefix?: string | null;
|
|
6675
6681
|
/**
|
|
6676
6682
|
* Attention!
|
|
6677
6683
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6678
6684
|
* This value cannot be changed after it is set in either the create or update.
|
|
6679
6685
|
*/
|
|
6680
|
-
UserIdentifierStartNumber
|
|
6686
|
+
UserIdentifierStartNumber?: string | null;
|
|
6681
6687
|
/**
|
|
6682
6688
|
* Attention!
|
|
6683
6689
|
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6684
6690
|
* This value cannot be changed after it is set in either the create or update.
|
|
6685
6691
|
*/
|
|
6686
|
-
UserIdentifierSuffix
|
|
6687
|
-
UserMaximumUsage
|
|
6692
|
+
UserIdentifierSuffix?: string | null;
|
|
6693
|
+
UserMaximumUsage?: number | null;
|
|
6688
6694
|
}
|
|
6689
6695
|
/**
|
|
6690
6696
|
* Update the budget on the loyalty program group.
|
|
@@ -6722,21 +6728,21 @@ export interface UpdateLoyaltyProgramCondition {
|
|
|
6722
6728
|
* When a change to Status, StartDate, EndDate or Currency leads to the group being reactivate, all related loyalty programs will also be reactive when the option ReactivateProgramsWhenPossible is set to true. Otherwise all deactivated programs need to be manually reactivated.
|
|
6723
6729
|
*/
|
|
6724
6730
|
export interface UpdateLoyaltyProgramGroup {
|
|
6725
|
-
BackendID
|
|
6731
|
+
BackendID?: string | null;
|
|
6726
6732
|
/**
|
|
6727
6733
|
* Entity type: Currency
|
|
6728
6734
|
*/
|
|
6729
|
-
BudgetCurrencyID
|
|
6730
|
-
EndDate
|
|
6735
|
+
BudgetCurrencyID?: string | null;
|
|
6736
|
+
EndDate?: string | null;
|
|
6731
6737
|
/**
|
|
6732
6738
|
* Entity type: LoyaltyProgramGroup
|
|
6733
6739
|
*/
|
|
6734
6740
|
ID: string;
|
|
6735
|
-
Name
|
|
6741
|
+
Name?: string | null;
|
|
6736
6742
|
ReactivateProgramsWhenPossible?: boolean;
|
|
6737
|
-
StartDate
|
|
6743
|
+
StartDate?: string | null;
|
|
6738
6744
|
Status?: DataModelsLoyaltyProgramStatus;
|
|
6739
|
-
TaxExemptionCode
|
|
6745
|
+
TaxExemptionCode?: string | null;
|
|
6740
6746
|
}
|
|
6741
6747
|
/**
|
|
6742
6748
|
* Update the budget on the loyalty program group.
|
|
@@ -6757,6 +6763,7 @@ export interface UpdateLoyaltyProgramGroupBudget {
|
|
|
6757
6763
|
* Update an existing LoyaltyProgramPaymentType
|
|
6758
6764
|
*/
|
|
6759
6765
|
export interface UpdateLoyaltyProgramPaymentType {
|
|
6766
|
+
AllowPartialPayment?: boolean;
|
|
6760
6767
|
BackendID?: string;
|
|
6761
6768
|
Budget?: number;
|
|
6762
6769
|
ExcludeFromProgramBudget?: boolean;
|
|
@@ -6769,9 +6776,9 @@ export interface UpdateLoyaltyProgramPaymentType {
|
|
|
6769
6776
|
ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
|
|
6770
6777
|
Required?: boolean;
|
|
6771
6778
|
Sequence?: number;
|
|
6772
|
-
TaxHandling
|
|
6779
|
+
TaxHandling?: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
6773
6780
|
UserBudget?: number;
|
|
6774
|
-
UserBudgetDeduction
|
|
6781
|
+
UserBudgetDeduction?: DataModelsUserBudgetDeduction;
|
|
6775
6782
|
UserMaximumUsage?: number;
|
|
6776
6783
|
}
|
|
6777
6784
|
/**
|
|
@@ -6792,25 +6799,25 @@ export interface UpdateLoyaltyProgramProductLimitation {
|
|
|
6792
6799
|
*/
|
|
6793
6800
|
export interface UpdatePointAwardingRule {
|
|
6794
6801
|
ApplyRecursive?: boolean;
|
|
6795
|
-
BackendID
|
|
6802
|
+
BackendID?: string | null;
|
|
6796
6803
|
Conditions?: LoyaltyUpdatePointAwardingRule_Condition[];
|
|
6797
|
-
Description
|
|
6804
|
+
Description?: string | null;
|
|
6798
6805
|
Enabled?: boolean;
|
|
6799
|
-
EndDate
|
|
6806
|
+
EndDate?: string | null;
|
|
6800
6807
|
/**
|
|
6801
6808
|
* Entity type: PointAwardingRule
|
|
6802
6809
|
*/
|
|
6803
6810
|
ID: string;
|
|
6804
|
-
MarketingDescription
|
|
6811
|
+
MarketingDescription?: string | null;
|
|
6805
6812
|
Name?: string;
|
|
6806
6813
|
/**
|
|
6807
6814
|
* Entity type: OrganizationUnitSet
|
|
6808
6815
|
*/
|
|
6809
6816
|
OrganizationUnitSetID?: string;
|
|
6810
|
-
PointExpirationPolicyData
|
|
6811
|
-
PointExpirationPolicyType
|
|
6812
|
-
PointPendingPolicyData
|
|
6813
|
-
PointPendingPolicyType
|
|
6817
|
+
PointExpirationPolicyData?: Record<string, TAnyValue> | null;
|
|
6818
|
+
PointExpirationPolicyType?: string | null;
|
|
6819
|
+
PointPendingPolicyData?: Record<string, TAnyValue> | null;
|
|
6820
|
+
PointPendingPolicyType?: string | null;
|
|
6814
6821
|
PointsToAward?: number;
|
|
6815
6822
|
StartDate?: string;
|
|
6816
6823
|
}
|
|
@@ -6845,7 +6852,7 @@ export interface CreateMessageTemplate {
|
|
|
6845
6852
|
* Entity type: Country
|
|
6846
6853
|
*/
|
|
6847
6854
|
CountryID?: string;
|
|
6848
|
-
Destination
|
|
6855
|
+
Destination?: DataModelsMessageTemplateDestinations;
|
|
6849
6856
|
Footer?: string;
|
|
6850
6857
|
Header?: string;
|
|
6851
6858
|
Helpers?: string;
|
|
@@ -6862,7 +6869,7 @@ export interface CreateMessageTemplate {
|
|
|
6862
6869
|
OrganizationUnitID?: string;
|
|
6863
6870
|
PaperProperties?: DataModelsPaperProperties;
|
|
6864
6871
|
Template: string;
|
|
6865
|
-
Type
|
|
6872
|
+
Type?: DataModelsMessageTemplateTypes;
|
|
6866
6873
|
}
|
|
6867
6874
|
export interface CreateMessageTemplateResponse {
|
|
6868
6875
|
Error?: ServiceError;
|
|
@@ -7058,7 +7065,7 @@ export interface PreviewMessageTemplate {
|
|
|
7058
7065
|
* Entity type: Country
|
|
7059
7066
|
*/
|
|
7060
7067
|
CountryID?: string;
|
|
7061
|
-
Destination
|
|
7068
|
+
Destination?: DataModelsMessageTemplateDestinations;
|
|
7062
7069
|
Footer?: string;
|
|
7063
7070
|
/**
|
|
7064
7071
|
* A preview will be generated, even if device is known
|
|
@@ -7082,9 +7089,9 @@ export interface PreviewMessageTemplate {
|
|
|
7082
7089
|
* Entity type: Station
|
|
7083
7090
|
*/
|
|
7084
7091
|
StationID?: string;
|
|
7085
|
-
TargetContentType
|
|
7092
|
+
TargetContentType?: MessageTemplatesMessageTargetContentTypes;
|
|
7086
7093
|
Template: string;
|
|
7087
|
-
Type
|
|
7094
|
+
Type?: DataModelsMessageTemplateTypes;
|
|
7088
7095
|
}
|
|
7089
7096
|
export interface PreviewMessageTemplateResponse {
|
|
7090
7097
|
Error?: ServiceError;
|
|
@@ -7095,7 +7102,7 @@ export interface PreviewMessageTemplateResponse {
|
|
|
7095
7102
|
}
|
|
7096
7103
|
export interface SendSampleMailMessageTemplate {
|
|
7097
7104
|
CountryID?: string;
|
|
7098
|
-
Destination
|
|
7105
|
+
Destination?: DataModelsMessageTemplateDestinations;
|
|
7099
7106
|
EmailAddress?: string;
|
|
7100
7107
|
Helpers?: string;
|
|
7101
7108
|
LanguageID?: string;
|
|
@@ -7104,7 +7111,7 @@ export interface SendSampleMailMessageTemplate {
|
|
|
7104
7111
|
OrganizationUnitID?: string;
|
|
7105
7112
|
SampleData?: Record<string, TAnyValue>;
|
|
7106
7113
|
Template?: string;
|
|
7107
|
-
Type
|
|
7114
|
+
Type?: DataModelsMessageTemplateTypes;
|
|
7108
7115
|
}
|
|
7109
7116
|
/**
|
|
7110
7117
|
* Update an existing MessageTemplate
|
|
@@ -7113,11 +7120,11 @@ export interface UpdateMessageTemplate {
|
|
|
7113
7120
|
/**
|
|
7114
7121
|
* Entity type: Country
|
|
7115
7122
|
*/
|
|
7116
|
-
CountryID
|
|
7123
|
+
CountryID?: string | null;
|
|
7117
7124
|
Destination?: DataModelsMessageTemplateDestinations;
|
|
7118
|
-
Footer
|
|
7119
|
-
Header
|
|
7120
|
-
Helpers
|
|
7125
|
+
Footer?: string | null;
|
|
7126
|
+
Header?: string | null;
|
|
7127
|
+
Helpers?: string | null;
|
|
7121
7128
|
/**
|
|
7122
7129
|
* Entity type: MessageTemplate
|
|
7123
7130
|
*/
|
|
@@ -7126,14 +7133,14 @@ export interface UpdateMessageTemplate {
|
|
|
7126
7133
|
/**
|
|
7127
7134
|
* Entity type: Language
|
|
7128
7135
|
*/
|
|
7129
|
-
LanguageID
|
|
7130
|
-
Layout
|
|
7136
|
+
LanguageID?: string | null;
|
|
7137
|
+
Layout?: string | null;
|
|
7131
7138
|
Name?: string;
|
|
7132
7139
|
/**
|
|
7133
7140
|
* Entity type: OrganizationUnit
|
|
7134
7141
|
*/
|
|
7135
|
-
OrganizationUnitID
|
|
7136
|
-
PaperProperties
|
|
7142
|
+
OrganizationUnitID?: string | null;
|
|
7143
|
+
PaperProperties?: DataModelsPaperProperties;
|
|
7137
7144
|
Template?: string;
|
|
7138
7145
|
}
|
|
7139
7146
|
export interface OrdersCheckoutOptionCategoryDto {
|
|
@@ -7492,7 +7499,7 @@ export interface DeleteReturnReason {
|
|
|
7492
7499
|
* Get the reasons by type.
|
|
7493
7500
|
*/
|
|
7494
7501
|
export interface GetReturnReasonsByType {
|
|
7495
|
-
Type
|
|
7502
|
+
Type?: DataModelsReturnReasonType;
|
|
7496
7503
|
}
|
|
7497
7504
|
export interface GetReturnReasonsByTypeResponse {
|
|
7498
7505
|
Error?: ServiceError;
|
|
@@ -7552,8 +7559,8 @@ export interface OrdersReturnReasonsListReturnReasonsResponse_Reason {
|
|
|
7552
7559
|
* Update a return reason
|
|
7553
7560
|
*/
|
|
7554
7561
|
export interface UpdateReturnReason {
|
|
7555
|
-
BackendID
|
|
7556
|
-
Description
|
|
7562
|
+
BackendID?: string | null;
|
|
7563
|
+
Description?: string | null;
|
|
7557
7564
|
/**
|
|
7558
7565
|
* Entity type: ReturnReason
|
|
7559
7566
|
*/
|
|
@@ -7576,9 +7583,9 @@ export interface UpdateCheckoutOption {
|
|
|
7576
7583
|
/**
|
|
7577
7584
|
* Entity type: CheckoutOptionCategory
|
|
7578
7585
|
*/
|
|
7579
|
-
CategoryID
|
|
7580
|
-
Data
|
|
7581
|
-
Description
|
|
7586
|
+
CategoryID?: string | null;
|
|
7587
|
+
Data?: OrdersCheckoutOptionsICheckoutOptionConfigData | null;
|
|
7588
|
+
Description?: string | null;
|
|
7582
7589
|
Handler?: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SerialNumberValidation' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
|
|
7583
7590
|
/**
|
|
7584
7591
|
* Entity type: CheckoutOption
|
|
@@ -7589,18 +7596,18 @@ export interface UpdateCheckoutOption {
|
|
|
7589
7596
|
/**
|
|
7590
7597
|
* Entity type: OrganizationUnitSet
|
|
7591
7598
|
*/
|
|
7592
|
-
OrganizationUnitSetID
|
|
7599
|
+
OrganizationUnitSetID?: string | null;
|
|
7593
7600
|
/**
|
|
7594
7601
|
* Entity type: Script
|
|
7595
7602
|
*/
|
|
7596
|
-
ScriptID
|
|
7603
|
+
ScriptID?: string | null;
|
|
7597
7604
|
Sequence?: number;
|
|
7598
7605
|
}
|
|
7599
7606
|
/**
|
|
7600
7607
|
* Update an existing CheckoutOptionCategory
|
|
7601
7608
|
*/
|
|
7602
7609
|
export interface UpdateCheckoutOptionCategory {
|
|
7603
|
-
Description
|
|
7610
|
+
Description?: string | null;
|
|
7604
7611
|
/**
|
|
7605
7612
|
* Entity type: CheckoutOptionCategory
|
|
7606
7613
|
*/
|
|
@@ -7635,8 +7642,8 @@ export interface UpdateOrderLedgerTypeResponse {
|
|
|
7635
7642
|
Name?: string;
|
|
7636
7643
|
}
|
|
7637
7644
|
export interface UpdateRefundCorrectionReason {
|
|
7638
|
-
BackendID
|
|
7639
|
-
Description
|
|
7645
|
+
BackendID?: string | null;
|
|
7646
|
+
Description?: string | null;
|
|
7640
7647
|
/**
|
|
7641
7648
|
* Entity type: RefundCorrectionReason
|
|
7642
7649
|
*/
|
|
@@ -7652,8 +7659,8 @@ export interface UpdateRefundCorrectionReason {
|
|
|
7652
7659
|
* Update an existing UnitPriceCorrectionReason
|
|
7653
7660
|
*/
|
|
7654
7661
|
export interface UpdateUnitPriceCorrectionReason {
|
|
7655
|
-
BackendID
|
|
7656
|
-
Description
|
|
7662
|
+
BackendID?: string | null;
|
|
7663
|
+
Description?: string | null;
|
|
7657
7664
|
/**
|
|
7658
7665
|
* Entity type: UnitPriceCorrectionReason
|
|
7659
7666
|
*/
|
|
@@ -7683,7 +7690,7 @@ export interface CreateOrUpdateOrganizationUnitSubset {
|
|
|
7683
7690
|
* Entity type: OrganizationUnitSet
|
|
7684
7691
|
*/
|
|
7685
7692
|
SubsetID: string;
|
|
7686
|
-
Type
|
|
7693
|
+
Type?: DataModelsOrganizationUnitSetOperatorTypes;
|
|
7687
7694
|
}
|
|
7688
7695
|
/**
|
|
7689
7696
|
* Creates a new `OrganizationUnitSet`.
|
|
@@ -7715,14 +7722,14 @@ export interface CreateOrganizationUnitSet {
|
|
|
7715
7722
|
* When specified, adds the sets contained in Subsets as a subset of the new set.
|
|
7716
7723
|
*/
|
|
7717
7724
|
Subsets?: OrganizationUnitSetsCreateOrganizationUnitSet_OrganizationUnitSubSetDefinition[];
|
|
7718
|
-
Type
|
|
7725
|
+
Type?: DataModelsOrganizationUnitSetTypes;
|
|
7719
7726
|
}
|
|
7720
7727
|
export interface OrganizationUnitSetsCreateOrganizationUnitSet_OrganizationUnitSubSetDefinition {
|
|
7721
7728
|
/**
|
|
7722
7729
|
* Entity type: OrganizationUnitSet
|
|
7723
7730
|
*/
|
|
7724
7731
|
ID: string;
|
|
7725
|
-
OperatorType
|
|
7732
|
+
OperatorType?: DataModelsOrganizationUnitSetOperatorTypes;
|
|
7726
7733
|
}
|
|
7727
7734
|
/**
|
|
7728
7735
|
* Creates a new OrganizationUnitSetScope.
|
|
@@ -7886,7 +7893,7 @@ export interface OrganizationUnitSetsPreviewOrganizationUnitSet_PreviewOrganizat
|
|
|
7886
7893
|
* Entity type: OrganizationUnitSubset
|
|
7887
7894
|
*/
|
|
7888
7895
|
ID: string;
|
|
7889
|
-
OperatorType
|
|
7896
|
+
OperatorType?: DataModelsOrganizationUnitSetOperatorTypes;
|
|
7890
7897
|
SequenceNumber?: number;
|
|
7891
7898
|
}
|
|
7892
7899
|
export interface PreviewOrganizationUnitSetResponse {
|
|
@@ -7904,9 +7911,9 @@ export interface PreviewOrganizationUnitSetResponse {
|
|
|
7904
7911
|
* it, pass the definition you got back from the `GetOrganizationUnitSet` service.
|
|
7905
7912
|
*/
|
|
7906
7913
|
export interface UpdateOrganizationUnitSet {
|
|
7907
|
-
BackendID
|
|
7908
|
-
Definition
|
|
7909
|
-
Description
|
|
7914
|
+
BackendID?: string | null;
|
|
7915
|
+
Definition?: DataModelsOrganizationUnitSetDefinition;
|
|
7916
|
+
Description?: string | null;
|
|
7910
7917
|
/**
|
|
7911
7918
|
* Entity type: OrganizationUnitSet
|
|
7912
7919
|
*/
|
|
@@ -7915,7 +7922,7 @@ export interface UpdateOrganizationUnitSet {
|
|
|
7915
7922
|
/**
|
|
7916
7923
|
* Entity type: OrganizationUnitSetScope
|
|
7917
7924
|
*/
|
|
7918
|
-
ScopeID
|
|
7925
|
+
ScopeID?: string | null;
|
|
7919
7926
|
}
|
|
7920
7927
|
/**
|
|
7921
7928
|
* Updates a OrganizationUnitSetScope.
|
|
@@ -8207,7 +8214,7 @@ export interface UpdateCashHandler {
|
|
|
8207
8214
|
* Entity type: CashHandler
|
|
8208
8215
|
*/
|
|
8209
8216
|
ID: string;
|
|
8210
|
-
MaxAmountPerOrder
|
|
8217
|
+
MaxAmountPerOrder?: number | null;
|
|
8211
8218
|
Name?: string;
|
|
8212
8219
|
RoundingFactor?: number;
|
|
8213
8220
|
}
|
|
@@ -8300,15 +8307,15 @@ export interface UpdateOrganizationUnitRegularOpeningHours {
|
|
|
8300
8307
|
* When this OrganizationUnitSet doesn't have this PaymentType yet, it will be created. If it already exists the fields will be updated.
|
|
8301
8308
|
*/
|
|
8302
8309
|
export interface CreateOrUpdateOrganizationUnitSetPaymentType {
|
|
8303
|
-
AuthorizationExpirationInDays
|
|
8304
|
-
CaptureMoment
|
|
8310
|
+
AuthorizationExpirationInDays?: number | null;
|
|
8311
|
+
CaptureMoment?: DataModelsPaymentTypeCaptureMoment;
|
|
8305
8312
|
/**
|
|
8306
8313
|
* Entity type: Product
|
|
8307
8314
|
*/
|
|
8308
|
-
DigitalGiftCardProductID
|
|
8309
|
-
DisableForCarryOutOrders
|
|
8310
|
-
DisableForDeliveryOrders
|
|
8311
|
-
DisableForReserveOrders
|
|
8315
|
+
DigitalGiftCardProductID?: string | null;
|
|
8316
|
+
DisableForCarryOutOrders?: boolean | null;
|
|
8317
|
+
DisableForDeliveryOrders?: boolean | null;
|
|
8318
|
+
DisableForReserveOrders?: boolean | null;
|
|
8312
8319
|
/**
|
|
8313
8320
|
* Entity type: OrganizationUnitSet
|
|
8314
8321
|
*/
|
|
@@ -8317,7 +8324,7 @@ export interface CreateOrUpdateOrganizationUnitSetPaymentType {
|
|
|
8317
8324
|
* Entity type: PaymentType
|
|
8318
8325
|
*/
|
|
8319
8326
|
PaymentTypeID: string;
|
|
8320
|
-
RefundPriority
|
|
8327
|
+
RefundPriority?: number | null;
|
|
8321
8328
|
}
|
|
8322
8329
|
/**
|
|
8323
8330
|
* Create a new custom PaymentMethod.
|
|
@@ -8356,8 +8363,8 @@ export interface CreatePaymentType {
|
|
|
8356
8363
|
AutoFinalizeOnOrderPaid?: boolean;
|
|
8357
8364
|
BackendID?: string;
|
|
8358
8365
|
BackendRelationID?: string;
|
|
8359
|
-
CashJournalMethod
|
|
8360
|
-
Category
|
|
8366
|
+
CashJournalMethod?: DataModelsPaymentCashJournalMethod;
|
|
8367
|
+
Category?: DataModelsPaymentTypeCategory;
|
|
8361
8368
|
Code: string;
|
|
8362
8369
|
IsActive?: boolean;
|
|
8363
8370
|
/**
|
|
@@ -8371,7 +8378,7 @@ export interface CreatePaymentType {
|
|
|
8371
8378
|
*/
|
|
8372
8379
|
PaymentMethodID: string;
|
|
8373
8380
|
PrintOnDocuments?: boolean;
|
|
8374
|
-
ReturnAction
|
|
8381
|
+
ReturnAction?: DataModelsPaymentReturnActions;
|
|
8375
8382
|
Roles?: PaymentMethodsCreatePaymentType_PaymentTypeRole[];
|
|
8376
8383
|
/**
|
|
8377
8384
|
* Entity type: Script
|
|
@@ -8540,6 +8547,7 @@ export interface PaymentMethodsGetPaymentTypeCustomFieldsResponse_CustomFieldDto
|
|
|
8540
8547
|
BackendID?: string;
|
|
8541
8548
|
DataType: DataModelsCustomFieldDataTypes;
|
|
8542
8549
|
DisplayName?: string;
|
|
8550
|
+
EnumValues?: Record<string, string | null>;
|
|
8543
8551
|
/**
|
|
8544
8552
|
* Entity type: CustomField
|
|
8545
8553
|
*/
|
|
@@ -8897,7 +8905,7 @@ export interface UpdatePaymentMethod {
|
|
|
8897
8905
|
* Update the description of a PaymentTransactionLedgerType. Only custom made types can be updated.
|
|
8898
8906
|
*/
|
|
8899
8907
|
export interface UpdatePaymentTransactionLedgerType {
|
|
8900
|
-
Description
|
|
8908
|
+
Description?: string | null;
|
|
8901
8909
|
/**
|
|
8902
8910
|
* Entity type: PaymentTransactionLedgerType
|
|
8903
8911
|
*/
|
|
@@ -8908,8 +8916,8 @@ export interface UpdatePaymentTransactionLedgerType {
|
|
|
8908
8916
|
*/
|
|
8909
8917
|
export interface UpdatePaymentType {
|
|
8910
8918
|
AutoFinalizeOnOrderPaid?: boolean;
|
|
8911
|
-
BackendID
|
|
8912
|
-
BackendRelationID
|
|
8919
|
+
BackendID?: string | null;
|
|
8920
|
+
BackendRelationID?: string | null;
|
|
8913
8921
|
CashJournalMethod?: DataModelsPaymentCashJournalMethod;
|
|
8914
8922
|
Category?: DataModelsPaymentTypeCategory;
|
|
8915
8923
|
Code?: string;
|
|
@@ -8921,49 +8929,49 @@ export interface UpdatePaymentType {
|
|
|
8921
8929
|
/**
|
|
8922
8930
|
* Entity type: LedgerClass
|
|
8923
8931
|
*/
|
|
8924
|
-
LedgerClassID
|
|
8932
|
+
LedgerClassID?: string | null;
|
|
8925
8933
|
Name?: string;
|
|
8926
|
-
Options
|
|
8934
|
+
Options?: PaymentMethodsUpdatePaymentType_PaymentTypeOptionsMaybe;
|
|
8927
8935
|
/**
|
|
8928
8936
|
* Entity type: PaymentMethod
|
|
8929
8937
|
*/
|
|
8930
8938
|
PaymentMethodID?: string;
|
|
8931
8939
|
PrintOnDocuments?: boolean;
|
|
8932
8940
|
ReturnAction?: DataModelsPaymentReturnActions;
|
|
8933
|
-
Roles
|
|
8941
|
+
Roles?: PaymentMethodsUpdatePaymentType_PaymentTypeRole[] | null;
|
|
8934
8942
|
/**
|
|
8935
8943
|
* Entity type: Script
|
|
8936
8944
|
*/
|
|
8937
|
-
ScriptID
|
|
8945
|
+
ScriptID?: string | null;
|
|
8938
8946
|
}
|
|
8939
8947
|
export interface PaymentMethodsUpdatePaymentType_PaymentTypeOptionsMaybe {
|
|
8940
|
-
BlockOverPayments
|
|
8941
|
-
CanBeCancelled
|
|
8942
|
-
CanBeRefunded
|
|
8948
|
+
BlockOverPayments?: boolean | null;
|
|
8949
|
+
CanBeCancelled?: boolean | null;
|
|
8950
|
+
CanBeRefunded?: boolean | null;
|
|
8943
8951
|
/**
|
|
8944
8952
|
* Setting this to false results in refund only, will therefor only work with CanBeRefunded:true and CanRefundWithoutOriginalPaymentTransaction:true
|
|
8945
8953
|
*/
|
|
8946
|
-
CanBeUsedForPayments
|
|
8947
|
-
CanRefundWithoutOriginalPaymentTransaction
|
|
8954
|
+
CanBeUsedForPayments?: boolean | null;
|
|
8955
|
+
CanRefundWithoutOriginalPaymentTransaction?: boolean | null;
|
|
8948
8956
|
/**
|
|
8949
8957
|
* Entity type: GiftCardConfiguration
|
|
8950
8958
|
*/
|
|
8951
|
-
GiftCardConfigurationID
|
|
8959
|
+
GiftCardConfigurationID?: string | null;
|
|
8952
8960
|
/**
|
|
8953
8961
|
* Entity type: LoyaltyProgram
|
|
8954
8962
|
*/
|
|
8955
|
-
LoyaltyProgramID
|
|
8956
|
-
OnlyAvailableInLocalMode
|
|
8957
|
-
Pending
|
|
8958
|
-
PinHandler
|
|
8959
|
-
RefundPending
|
|
8960
|
-
RequiredFunctionality
|
|
8961
|
-
RequiredFunctionalityScope
|
|
8962
|
-
RequiredUserType
|
|
8963
|
-
RequiresAmount
|
|
8964
|
-
RequiresConfirmationForPayments
|
|
8965
|
-
RequiresConfirmationForRefunds
|
|
8966
|
-
RequiresInteractionForRefunds
|
|
8963
|
+
LoyaltyProgramID?: string | null;
|
|
8964
|
+
OnlyAvailableInLocalMode?: boolean | null;
|
|
8965
|
+
Pending?: boolean | null;
|
|
8966
|
+
PinHandler?: string | null;
|
|
8967
|
+
RefundPending?: boolean | null;
|
|
8968
|
+
RequiredFunctionality?: string | null;
|
|
8969
|
+
RequiredFunctionalityScope?: SecurityFunctionalityScope;
|
|
8970
|
+
RequiredUserType?: UserTypes;
|
|
8971
|
+
RequiresAmount?: boolean | null;
|
|
8972
|
+
RequiresConfirmationForPayments?: boolean | null;
|
|
8973
|
+
RequiresConfirmationForRefunds?: boolean | null;
|
|
8974
|
+
RequiresInteractionForRefunds?: boolean | null;
|
|
8967
8975
|
}
|
|
8968
8976
|
export interface PaymentMethodsUpdatePaymentType_PaymentTypeRole {
|
|
8969
8977
|
/**
|
|
@@ -9244,15 +9252,15 @@ export interface RemovePersonalizedPromotionProducts {
|
|
|
9244
9252
|
* Update an existing personalized promotion.
|
|
9245
9253
|
*/
|
|
9246
9254
|
export interface UpdatePersonalizedPromotion {
|
|
9247
|
-
BackendID
|
|
9248
|
-
Description
|
|
9255
|
+
BackendID?: string | null;
|
|
9256
|
+
Description?: string | null;
|
|
9249
9257
|
/**
|
|
9250
9258
|
* Entity type: PersonalizedPromotion
|
|
9251
9259
|
*/
|
|
9252
9260
|
ID: string;
|
|
9253
9261
|
LockAfterFirstApply?: boolean;
|
|
9254
|
-
MaximumDistinctProducts
|
|
9255
|
-
Name
|
|
9262
|
+
MaximumDistinctProducts?: number | null;
|
|
9263
|
+
Name?: string | null;
|
|
9256
9264
|
}
|
|
9257
9265
|
/**
|
|
9258
9266
|
* Create a new PriceList
|
|
@@ -9367,7 +9375,7 @@ export interface CreatePriceListResponse {
|
|
|
9367
9375
|
export interface CreatePriceListUsageType {
|
|
9368
9376
|
Description?: string;
|
|
9369
9377
|
Name: string;
|
|
9370
|
-
RequiredUserType
|
|
9378
|
+
RequiredUserType?: UserTypes;
|
|
9371
9379
|
}
|
|
9372
9380
|
export interface CreatePriceListUsageTypeResponse {
|
|
9373
9381
|
Error?: ServiceError;
|
|
@@ -9834,8 +9842,8 @@ export interface PricingPriceListDto {
|
|
|
9834
9842
|
* Update an existing PriceList
|
|
9835
9843
|
*/
|
|
9836
9844
|
export interface UpdatePriceList {
|
|
9837
|
-
BackendID
|
|
9838
|
-
BackendSystemID
|
|
9845
|
+
BackendID?: string | null;
|
|
9846
|
+
BackendSystemID?: string | null;
|
|
9839
9847
|
/**
|
|
9840
9848
|
* Entity type: Currency
|
|
9841
9849
|
*/
|
|
@@ -9848,13 +9856,13 @@ export interface UpdatePriceList {
|
|
|
9848
9856
|
IsActive?: boolean;
|
|
9849
9857
|
IsFinalSalePriceList?: boolean;
|
|
9850
9858
|
Name?: string;
|
|
9851
|
-
TimeZone
|
|
9859
|
+
TimeZone?: string | null;
|
|
9852
9860
|
}
|
|
9853
9861
|
/**
|
|
9854
9862
|
* Update an existing PriceListAdjustment
|
|
9855
9863
|
*/
|
|
9856
9864
|
export interface UpdatePriceListAdjustment {
|
|
9857
|
-
BackendID
|
|
9865
|
+
BackendID?: string | null;
|
|
9858
9866
|
Data?: PricingIPriceListAdjustmentData;
|
|
9859
9867
|
EffectiveDate: string;
|
|
9860
9868
|
ExpireDate?: string;
|
|
@@ -9869,7 +9877,7 @@ export interface UpdatePriceListAdjustment {
|
|
|
9869
9877
|
* Entity type: PriceListAdjustment
|
|
9870
9878
|
*/
|
|
9871
9879
|
ParentAdjustmentID?: string;
|
|
9872
|
-
PricingGroupID
|
|
9880
|
+
PricingGroupID?: string | null;
|
|
9873
9881
|
Sequence?: number;
|
|
9874
9882
|
/**
|
|
9875
9883
|
* If set to true, this will skip the recalculation of the price list after the adjustment is updated, defaults to false so it will always recalculate. Recalculation happens periodically thereafter.
|
|
@@ -9909,7 +9917,7 @@ export interface UpdatePriceListOrganizationUnit {
|
|
|
9909
9917
|
* Entity type: PriceListUsageType
|
|
9910
9918
|
*/
|
|
9911
9919
|
PriceListUsageTypeID: string;
|
|
9912
|
-
PricingGroupID
|
|
9920
|
+
PricingGroupID?: string | null;
|
|
9913
9921
|
/**
|
|
9914
9922
|
* Entity type: OrganizationUnit
|
|
9915
9923
|
*/
|
|
@@ -9921,7 +9929,7 @@ export interface UpdatePriceListUsageType {
|
|
|
9921
9929
|
* Entity type: PriceListUsageType
|
|
9922
9930
|
*/
|
|
9923
9931
|
ID: string;
|
|
9924
|
-
RequiredUserType
|
|
9932
|
+
RequiredUserType?: UserTypes;
|
|
9925
9933
|
}
|
|
9926
9934
|
/**
|
|
9927
9935
|
* Upload an excel file containing all ManualInputPriceListAdjustments for the given PriceListAdjustment. These will replace all exisiting adjustments.
|
|
@@ -10033,7 +10041,7 @@ export interface CreateProductBarcode {
|
|
|
10033
10041
|
*/
|
|
10034
10042
|
export interface CreateProductRequirement {
|
|
10035
10043
|
BackendID?: string;
|
|
10036
|
-
DataType
|
|
10044
|
+
DataType?: DataModelsProductRequirementDataTypes;
|
|
10037
10045
|
Handler?: string;
|
|
10038
10046
|
Name: string;
|
|
10039
10047
|
OrderType?: DataModelsOrderTypes;
|
|
@@ -10061,7 +10069,7 @@ export interface CreateProductSearchTemplate {
|
|
|
10061
10069
|
IncludeLeafProducts?: boolean;
|
|
10062
10070
|
MinimumRefreshInterval?: string;
|
|
10063
10071
|
Name: string;
|
|
10064
|
-
Type
|
|
10072
|
+
Type?: DataModelsProductSearchTemplateTypes;
|
|
10065
10073
|
}
|
|
10066
10074
|
export interface CreateProductSearchTemplateResponse {
|
|
10067
10075
|
Error?: ServiceError;
|
|
@@ -10096,7 +10104,7 @@ export interface CreateSupplierProduct {
|
|
|
10096
10104
|
Description?: string;
|
|
10097
10105
|
PreferredMinimumOrderQuantity?: number;
|
|
10098
10106
|
PrimitiveName: string;
|
|
10099
|
-
Status
|
|
10107
|
+
Status?: DataModelsProductStatus;
|
|
10100
10108
|
/**
|
|
10101
10109
|
* Entity type: OrganizationUnit
|
|
10102
10110
|
*/
|
|
@@ -10523,7 +10531,7 @@ export interface ProductsProductRequirementDto {
|
|
|
10523
10531
|
*/
|
|
10524
10532
|
export interface UpdateProductRequirement {
|
|
10525
10533
|
BackendID?: string;
|
|
10526
|
-
DataType
|
|
10534
|
+
DataType?: DataModelsProductRequirementDataTypes;
|
|
10527
10535
|
Handler?: string;
|
|
10528
10536
|
/**
|
|
10529
10537
|
* Entity type: ProductRequirement
|
|
@@ -10541,15 +10549,15 @@ export interface UpdateProductRequirement {
|
|
|
10541
10549
|
* Update an existing ProductSearchTemplate
|
|
10542
10550
|
*/
|
|
10543
10551
|
export interface UpdateProductSearchTemplate {
|
|
10544
|
-
AggregationOptions
|
|
10545
|
-
BackendID
|
|
10552
|
+
AggregationOptions?: Record<string, SearchAggregationFilterModel> | null;
|
|
10553
|
+
BackendID?: string | null;
|
|
10546
10554
|
Filters?: Record<string, SearchFilterModel>;
|
|
10547
10555
|
/**
|
|
10548
10556
|
* Entity type: ProductSearchTemplate
|
|
10549
10557
|
*/
|
|
10550
10558
|
ID: string;
|
|
10551
10559
|
IncludeLeafProducts?: boolean;
|
|
10552
|
-
MinimumRefreshInterval
|
|
10560
|
+
MinimumRefreshInterval?: string | null;
|
|
10553
10561
|
Name?: string;
|
|
10554
10562
|
Type?: DataModelsProductSearchTemplateTypes;
|
|
10555
10563
|
}
|
|
@@ -10584,7 +10592,7 @@ export interface UpdateSupplierProduct {
|
|
|
10584
10592
|
ID: string;
|
|
10585
10593
|
PreferredMinimumOrderQuantity?: number;
|
|
10586
10594
|
PrimitiveName: string;
|
|
10587
|
-
Status
|
|
10595
|
+
Status?: DataModelsProductStatus;
|
|
10588
10596
|
/**
|
|
10589
10597
|
* Entity type: TaxCode
|
|
10590
10598
|
*/
|
|
@@ -10749,8 +10757,8 @@ export interface DetachFunctionalitiesFromRole {
|
|
|
10749
10757
|
}
|
|
10750
10758
|
export interface RightsFunctionalityWithScope {
|
|
10751
10759
|
Functionality: string;
|
|
10752
|
-
RequiresElevation
|
|
10753
|
-
Scope
|
|
10760
|
+
RequiresElevation?: boolean;
|
|
10761
|
+
Scope?: SecurityFunctionalityScope;
|
|
10754
10762
|
}
|
|
10755
10763
|
export interface GetAvailableRoles {
|
|
10756
10764
|
UserID: string;
|
|
@@ -11053,17 +11061,17 @@ export interface SetUserRoles {
|
|
|
11053
11061
|
* Update a role.
|
|
11054
11062
|
*/
|
|
11055
11063
|
export interface UpdateRole {
|
|
11056
|
-
Code
|
|
11064
|
+
Code?: string | null;
|
|
11057
11065
|
/**
|
|
11058
11066
|
* If this is set, any users that have not logged in after said days will get disabled
|
|
11059
11067
|
*/
|
|
11060
|
-
DeactivateUserAfterInactiveDays
|
|
11068
|
+
DeactivateUserAfterInactiveDays?: number | null;
|
|
11061
11069
|
/**
|
|
11062
11070
|
* Entity type: Role
|
|
11063
11071
|
*/
|
|
11064
11072
|
ID: string;
|
|
11065
11073
|
Name?: string;
|
|
11066
|
-
UserType
|
|
11074
|
+
UserType?: UserTypes;
|
|
11067
11075
|
}
|
|
11068
11076
|
/**
|
|
11069
11077
|
* Update functionalities on a role.
|
|
@@ -11079,12 +11087,12 @@ export interface RightsUpdateRoleFunctionalities_FunctionalityToUpdate {
|
|
|
11079
11087
|
/**
|
|
11080
11088
|
* Scopes available only when elevated for this functionality. Should be set to `None (0)` for unscoped functionalities. To remove this functionality, set to `null`.
|
|
11081
11089
|
*/
|
|
11082
|
-
ElevationScope
|
|
11090
|
+
ElevationScope?: SecurityFunctionalityScope;
|
|
11083
11091
|
Functionality: string;
|
|
11084
11092
|
/**
|
|
11085
11093
|
* Scopes available for this functionality. Should be set to `None (0)` for unscoped functionalities. To remove this functionality, set to `null`.
|
|
11086
11094
|
*/
|
|
11087
|
-
Scope
|
|
11095
|
+
Scope?: SecurityFunctionalityScope;
|
|
11088
11096
|
}
|
|
11089
11097
|
export interface UpdateRoleSet {
|
|
11090
11098
|
BackendID?: string;
|
|
@@ -11261,7 +11269,7 @@ export interface CreateShippingMethod {
|
|
|
11261
11269
|
*/
|
|
11262
11270
|
CarrierID: string;
|
|
11263
11271
|
Code?: string;
|
|
11264
|
-
DeliveryType
|
|
11272
|
+
DeliveryType?: DataModelsShippingMethodDeliveryTypes;
|
|
11265
11273
|
ExcludeProductsFromShippingMethod?: boolean;
|
|
11266
11274
|
Handler?: string;
|
|
11267
11275
|
InvoicingHandledByCarrier?: boolean;
|
|
@@ -11325,7 +11333,7 @@ export interface CreateShippingRestriction {
|
|
|
11325
11333
|
* Entity type: Script
|
|
11326
11334
|
*/
|
|
11327
11335
|
ScriptID?: string;
|
|
11328
|
-
Type
|
|
11336
|
+
Type?: DataModelsShippingRestrictionType;
|
|
11329
11337
|
ZipCodeFrom?: string;
|
|
11330
11338
|
ZipCodeTo?: string;
|
|
11331
11339
|
}
|
|
@@ -11834,7 +11842,7 @@ export interface UpdateShippingMethod {
|
|
|
11834
11842
|
*/
|
|
11835
11843
|
CarrierID: string;
|
|
11836
11844
|
Code?: string;
|
|
11837
|
-
DeliveryType
|
|
11845
|
+
DeliveryType?: DataModelsShippingMethodDeliveryTypes;
|
|
11838
11846
|
ExcludeProductsFromShippingMethod?: boolean;
|
|
11839
11847
|
Handler?: string;
|
|
11840
11848
|
/**
|
|
@@ -11886,7 +11894,7 @@ export interface UpdateShippingRestriction {
|
|
|
11886
11894
|
/**
|
|
11887
11895
|
* Entity type: Country
|
|
11888
11896
|
*/
|
|
11889
|
-
CountryID
|
|
11897
|
+
CountryID?: string | null;
|
|
11890
11898
|
/**
|
|
11891
11899
|
* Entity type: ShippingRestriction
|
|
11892
11900
|
*/
|
|
@@ -11894,24 +11902,24 @@ export interface UpdateShippingRestriction {
|
|
|
11894
11902
|
/**
|
|
11895
11903
|
* Entity type: OrganizationUnit
|
|
11896
11904
|
*/
|
|
11897
|
-
OrganizationUnitID
|
|
11905
|
+
OrganizationUnitID?: string | null;
|
|
11898
11906
|
/**
|
|
11899
11907
|
* Entity type: OrganizationUnitSet
|
|
11900
11908
|
*/
|
|
11901
|
-
OrganizationUnitSetID
|
|
11909
|
+
OrganizationUnitSetID?: string | null;
|
|
11902
11910
|
/**
|
|
11903
11911
|
* Entity type: ProductPropertyType
|
|
11904
11912
|
*/
|
|
11905
|
-
ProductPropertyTypeID
|
|
11906
|
-
ProductPropertyTypeValues
|
|
11907
|
-
ProductSearchTemplateID
|
|
11913
|
+
ProductPropertyTypeID?: string | null;
|
|
11914
|
+
ProductPropertyTypeValues?: string[] | null;
|
|
11915
|
+
ProductSearchTemplateID?: string | null;
|
|
11908
11916
|
/**
|
|
11909
11917
|
* Entity type: Script
|
|
11910
11918
|
*/
|
|
11911
|
-
ScriptID
|
|
11919
|
+
ScriptID?: string | null;
|
|
11912
11920
|
Type?: DataModelsShippingRestrictionType;
|
|
11913
|
-
ZipCodeFrom
|
|
11914
|
-
ZipCodeTo
|
|
11921
|
+
ZipCodeFrom?: string | null;
|
|
11922
|
+
ZipCodeTo?: string | null;
|
|
11915
11923
|
}
|
|
11916
11924
|
/**
|
|
11917
11925
|
* Upload ShippingRestrictions. Expected format is an Excel file.
|
|
@@ -11960,9 +11968,9 @@ export interface CreateStockAllocationRule {
|
|
|
11960
11968
|
ProductSearchTemplateID?: string;
|
|
11961
11969
|
RefillPeriodInDays?: number;
|
|
11962
11970
|
StartDate?: string;
|
|
11963
|
-
Type
|
|
11971
|
+
Type?: DataModelsStockAllocationRuleTypes;
|
|
11964
11972
|
Value?: number;
|
|
11965
|
-
ValueType
|
|
11973
|
+
ValueType?: DataModelsStockAllocationRuleValueTypes;
|
|
11966
11974
|
}
|
|
11967
11975
|
/**
|
|
11968
11976
|
* Create a new StockLabel
|
|
@@ -12057,13 +12065,13 @@ export interface UpdateStockAllocationRule {
|
|
|
12057
12065
|
* Update the description or ledgerclass of StockLabel
|
|
12058
12066
|
*/
|
|
12059
12067
|
export interface UpdateStockLabel {
|
|
12060
|
-
Description
|
|
12061
|
-
DisplayName
|
|
12068
|
+
Description?: string | null;
|
|
12069
|
+
DisplayName?: string | null;
|
|
12062
12070
|
/**
|
|
12063
12071
|
* Entity type: StockLabel
|
|
12064
12072
|
*/
|
|
12065
12073
|
ID: string;
|
|
12066
|
-
LedgerClassID
|
|
12074
|
+
LedgerClassID?: string | null;
|
|
12067
12075
|
}
|
|
12068
12076
|
/**
|
|
12069
12077
|
* A service to upload an Excel containing StockAllocationRules that should be created or updated according to the values specified in the sheet.
|
|
@@ -12188,8 +12196,8 @@ export interface StockMutationsStockMutationReason {
|
|
|
12188
12196
|
* Update a custom or internal stock mutation reason. The name cannot be modified for internal reasons.
|
|
12189
12197
|
*/
|
|
12190
12198
|
export interface UpdateStockMutationReason {
|
|
12191
|
-
BackendID
|
|
12192
|
-
Description
|
|
12199
|
+
BackendID?: string | null;
|
|
12200
|
+
Description?: string | null;
|
|
12193
12201
|
/**
|
|
12194
12202
|
* Entity type: StockMutationReasons
|
|
12195
12203
|
*/
|
|
@@ -12343,7 +12351,7 @@ export interface CreateUserRequirement {
|
|
|
12343
12351
|
Display?: boolean;
|
|
12344
12352
|
Preferred?: boolean;
|
|
12345
12353
|
Property: string;
|
|
12346
|
-
RequiredFor
|
|
12354
|
+
RequiredFor?: UsersUserRequirementsUserRequirementFor;
|
|
12347
12355
|
/**
|
|
12348
12356
|
* Entity type: Script
|
|
12349
12357
|
*/
|
|
@@ -12360,7 +12368,7 @@ export interface CreateUserRequirement {
|
|
|
12360
12368
|
* Entity type: UserRequirementSet
|
|
12361
12369
|
*/
|
|
12362
12370
|
UserRequirementSetID?: string;
|
|
12363
|
-
UserType
|
|
12371
|
+
UserType?: UserTypes;
|
|
12364
12372
|
}
|
|
12365
12373
|
export interface CreateUserRequirementResponse {
|
|
12366
12374
|
Error?: ServiceError;
|
|
@@ -12525,16 +12533,16 @@ export interface CreateEmployeeUserResponse {
|
|
|
12525
12533
|
* Create or update employeedata for a user
|
|
12526
12534
|
*/
|
|
12527
12535
|
export interface CreateOrUpdateEmployeeData {
|
|
12528
|
-
EmployeeNumber
|
|
12529
|
-
Function
|
|
12536
|
+
EmployeeNumber?: string | null;
|
|
12537
|
+
Function?: string | null;
|
|
12530
12538
|
/**
|
|
12531
12539
|
* Entity type: User
|
|
12532
12540
|
*/
|
|
12533
|
-
ManagerID
|
|
12541
|
+
ManagerID?: string | null;
|
|
12534
12542
|
/**
|
|
12535
12543
|
* Entity type: OrganizationUnit
|
|
12536
12544
|
*/
|
|
12537
|
-
PrimaryOrganizationUnitID
|
|
12545
|
+
PrimaryOrganizationUnitID?: string | null;
|
|
12538
12546
|
/**
|
|
12539
12547
|
* Entity type: User
|
|
12540
12548
|
*/
|
|
@@ -13072,8 +13080,8 @@ export interface UpdateSubscription {
|
|
|
13072
13080
|
/**
|
|
13073
13081
|
* The (optional) BackendID of the subscription
|
|
13074
13082
|
*/
|
|
13075
|
-
BackendID
|
|
13076
|
-
Description
|
|
13083
|
+
BackendID?: string | null;
|
|
13084
|
+
Description?: string | null;
|
|
13077
13085
|
/**
|
|
13078
13086
|
* Entity type: Subscription
|
|
13079
13087
|
*/
|
|
@@ -13081,7 +13089,7 @@ export interface UpdateSubscription {
|
|
|
13081
13089
|
/**
|
|
13082
13090
|
* Entity type: Inquiry
|
|
13083
13091
|
*/
|
|
13084
|
-
InquiryID
|
|
13092
|
+
InquiryID?: string | null;
|
|
13085
13093
|
/**
|
|
13086
13094
|
* The name of the subscription
|
|
13087
13095
|
*/
|
|
@@ -13127,17 +13135,17 @@ export interface UpdateSubscriptionUserRequirements {
|
|
|
13127
13135
|
Requirements: UsersUpdateSubscriptionUserRequirements_UserRequirementDto[];
|
|
13128
13136
|
}
|
|
13129
13137
|
export interface UsersUpdateSubscriptionUserRequirements_UserRequirementDto {
|
|
13130
|
-
AccountType
|
|
13131
|
-
CustomValidators
|
|
13138
|
+
AccountType?: DataModelsUserAccountType;
|
|
13139
|
+
CustomValidators?: Record<string, TAnyValue | null> | null;
|
|
13132
13140
|
Display?: boolean;
|
|
13133
13141
|
/**
|
|
13134
13142
|
* Entity type: UserRequirement
|
|
13135
13143
|
*/
|
|
13136
13144
|
ID?: string;
|
|
13137
13145
|
Preferred?: boolean;
|
|
13138
|
-
Property
|
|
13146
|
+
Property?: string | null;
|
|
13139
13147
|
RequiredFor?: UsersUserRequirementsUserRequirementFor;
|
|
13140
|
-
UserType
|
|
13148
|
+
UserType?: UserTypes;
|
|
13141
13149
|
}
|
|
13142
13150
|
/**
|
|
13143
13151
|
* Update an existing UserOrigin
|
|
@@ -13158,24 +13166,24 @@ export interface UpdateUserOrigin {
|
|
|
13158
13166
|
* Updates an existing UserRequirement.
|
|
13159
13167
|
*/
|
|
13160
13168
|
export interface UpdateUserRequirement {
|
|
13161
|
-
AccountType
|
|
13162
|
-
CustomValidators
|
|
13169
|
+
AccountType?: DataModelsUserAccountType;
|
|
13170
|
+
CustomValidators?: Record<string, TAnyValue | null> | null;
|
|
13163
13171
|
Display?: boolean;
|
|
13164
13172
|
/**
|
|
13165
13173
|
* Entity type: UserRequirement
|
|
13166
13174
|
*/
|
|
13167
13175
|
ID: string;
|
|
13168
13176
|
Preferred?: boolean;
|
|
13169
|
-
Property
|
|
13177
|
+
Property?: string | null;
|
|
13170
13178
|
RequiredFor?: UsersUserRequirementsUserRequirementFor;
|
|
13171
13179
|
/**
|
|
13172
13180
|
* Entity type: Script
|
|
13173
13181
|
*/
|
|
13174
|
-
ScriptID
|
|
13182
|
+
ScriptID?: string | null;
|
|
13175
13183
|
/**
|
|
13176
13184
|
* Entity type: ShippingMethod
|
|
13177
13185
|
*/
|
|
13178
|
-
ShippingMethodID
|
|
13186
|
+
ShippingMethodID?: string | null;
|
|
13179
13187
|
UserType?: UserTypes;
|
|
13180
13188
|
}
|
|
13181
13189
|
/**
|
|
@@ -13186,7 +13194,7 @@ export interface UpdateUserRequirementSet {
|
|
|
13186
13194
|
* Entity type: UserRequirementSet
|
|
13187
13195
|
*/
|
|
13188
13196
|
ID: string;
|
|
13189
|
-
Name
|
|
13197
|
+
Name?: string;
|
|
13190
13198
|
/**
|
|
13191
13199
|
* Entity type: OrganizationUnitSet
|
|
13192
13200
|
*/
|
|
@@ -13203,25 +13211,25 @@ export interface UpdateUserRequirementSetRequirements {
|
|
|
13203
13211
|
Requirements?: UsersUpdateUserRequirementSetRequirements_UserRequirementDto[];
|
|
13204
13212
|
}
|
|
13205
13213
|
export interface UsersUpdateUserRequirementSetRequirements_UserRequirementDto {
|
|
13206
|
-
AccountType
|
|
13207
|
-
CustomValidators
|
|
13214
|
+
AccountType?: DataModelsUserAccountType;
|
|
13215
|
+
CustomValidators?: Record<string, TAnyValue | null> | null;
|
|
13208
13216
|
Display?: boolean;
|
|
13209
13217
|
/**
|
|
13210
13218
|
* Entity type: UserRequirement
|
|
13211
13219
|
*/
|
|
13212
13220
|
ID?: string;
|
|
13213
13221
|
Preferred?: boolean;
|
|
13214
|
-
Property
|
|
13222
|
+
Property?: string | null;
|
|
13215
13223
|
RequiredFor?: UsersUserRequirementsUserRequirementFor;
|
|
13216
13224
|
/**
|
|
13217
13225
|
* Entity type: Script
|
|
13218
13226
|
*/
|
|
13219
|
-
ScriptID
|
|
13227
|
+
ScriptID?: string | null;
|
|
13220
13228
|
/**
|
|
13221
13229
|
* Entity type: ShippingMethod
|
|
13222
13230
|
*/
|
|
13223
|
-
ShippingMethodID
|
|
13224
|
-
UserType
|
|
13231
|
+
ShippingMethodID?: string | null;
|
|
13232
|
+
UserType?: UserTypes;
|
|
13225
13233
|
}
|
|
13226
13234
|
/**
|
|
13227
13235
|
* Get the wishlist by ID.
|
|
@@ -13434,7 +13442,7 @@ export interface VisibilityGroupsListVisibilityGroupsResponse_VisibilityGroupDto
|
|
|
13434
13442
|
*/
|
|
13435
13443
|
export interface UpdateVisibilityGroup {
|
|
13436
13444
|
AllowCustomerStandardAccounts?: boolean;
|
|
13437
|
-
Description
|
|
13445
|
+
Description?: string | null;
|
|
13438
13446
|
/**
|
|
13439
13447
|
* Entity type: VisibilityGroup
|
|
13440
13448
|
*/
|
|
@@ -13469,7 +13477,7 @@ export interface EVACoreServicesAssortmentsAddProductsToAssortment_AssortmentPro
|
|
|
13469
13477
|
* Entity type: Product
|
|
13470
13478
|
*/
|
|
13471
13479
|
ProductID: string;
|
|
13472
|
-
ProductStatus
|
|
13480
|
+
ProductStatus?: DataModelsProductStatus;
|
|
13473
13481
|
ProductStatusesToIgnoreToChildProducts?: DataModelsProductStatus;
|
|
13474
13482
|
StartDate?: string;
|
|
13475
13483
|
}
|
|
@@ -13517,7 +13525,7 @@ export interface EVACoreServicesAssortmentsCreateAssortment_AssortmentProduct {
|
|
|
13517
13525
|
* Entity type: Product
|
|
13518
13526
|
*/
|
|
13519
13527
|
ProductID: string;
|
|
13520
|
-
ProductStatus
|
|
13528
|
+
ProductStatus?: DataModelsProductStatus;
|
|
13521
13529
|
StartDate?: string;
|
|
13522
13530
|
}
|
|
13523
13531
|
export interface CreateAssortmentResponse {
|
|
@@ -13763,7 +13771,7 @@ export interface ExportGeneralLedgerSummaryToExcel {
|
|
|
13763
13771
|
export interface CreateFraudItem {
|
|
13764
13772
|
Data?: string;
|
|
13765
13773
|
Object?: TAnyValue;
|
|
13766
|
-
Type
|
|
13774
|
+
Type?: DataModelsFraudDataType;
|
|
13767
13775
|
}
|
|
13768
13776
|
export interface CreateFraudItemResponse {
|
|
13769
13777
|
Error?: ServiceError;
|
|
@@ -13876,7 +13884,7 @@ export interface ListRestockedProducts {
|
|
|
13876
13884
|
export interface ListRestockedProductsResponse {
|
|
13877
13885
|
Error?: ServiceError;
|
|
13878
13886
|
Metadata?: ResponseMessageMetadata;
|
|
13879
|
-
Results?: Record<string,
|
|
13887
|
+
Results?: Record<string, string[] | null>;
|
|
13880
13888
|
}
|
|
13881
13889
|
/**
|
|
13882
13890
|
* List the Stock per product/stocklabel for a subset of OrganizationUnits.
|
|
@@ -13990,6 +13998,10 @@ export interface AddUserBoughtProductDetail {
|
|
|
13990
13998
|
* Entity type: OrderLine
|
|
13991
13999
|
*/
|
|
13992
14000
|
OrderLineID?: string;
|
|
14001
|
+
/**
|
|
14002
|
+
* Entity type: OrganizationUnit
|
|
14003
|
+
*/
|
|
14004
|
+
OrganizationUnitID?: string;
|
|
13993
14005
|
PurchaseDate?: string;
|
|
13994
14006
|
PurchasedQuantity?: number;
|
|
13995
14007
|
/**
|
|
@@ -14071,6 +14083,16 @@ export interface GetUserBoughtProduct {
|
|
|
14071
14083
|
*/
|
|
14072
14084
|
IncludedProductProperties?: string[];
|
|
14073
14085
|
}
|
|
14086
|
+
/**
|
|
14087
|
+
* Get a user bought product by a product's serial number.
|
|
14088
|
+
*/
|
|
14089
|
+
export interface GetUserBoughtProductBySerialNumber {
|
|
14090
|
+
/**
|
|
14091
|
+
* Entity type: ProductPropertyType
|
|
14092
|
+
*/
|
|
14093
|
+
IncludedProductProperties?: string[];
|
|
14094
|
+
SerialNumber: string;
|
|
14095
|
+
}
|
|
14074
14096
|
export interface GetUserBoughtProductResponse {
|
|
14075
14097
|
AdditionalWarrantyInfo?: string;
|
|
14076
14098
|
Details?: EVACoreServicesUsersGetUserBoughtProductResponse_Detail[];
|
|
@@ -14110,6 +14132,10 @@ export interface EVACoreServicesUsersGetUserBoughtProductResponse_Detail {
|
|
|
14110
14132
|
* Entity type: OrderLine
|
|
14111
14133
|
*/
|
|
14112
14134
|
OrderLineID?: string;
|
|
14135
|
+
/**
|
|
14136
|
+
* Entity type: OrganizationUnit
|
|
14137
|
+
*/
|
|
14138
|
+
OrganizationUnitID?: string;
|
|
14113
14139
|
PurchaseDate?: string;
|
|
14114
14140
|
PurchasedQuantity?: number;
|
|
14115
14141
|
}
|
|
@@ -14241,6 +14267,11 @@ export interface EVACoreServicesUsersPushUserBoughtProduct_PushedBoughtProductDe
|
|
|
14241
14267
|
* Entity type: OrderLine
|
|
14242
14268
|
*/
|
|
14243
14269
|
OrderLineID?: string;
|
|
14270
|
+
/**
|
|
14271
|
+
* Entity type: OrganizationUnit
|
|
14272
|
+
* Organization unit that the user bought product is registered in. Ignored when an order/line organization unit is present. When omitted, registration is under the current organization unit.
|
|
14273
|
+
*/
|
|
14274
|
+
OrganizationUnitID?: string;
|
|
14244
14275
|
PurchaseDate?: string;
|
|
14245
14276
|
PurchasedQuantity?: number;
|
|
14246
14277
|
}
|
|
@@ -14266,6 +14297,11 @@ export interface EVACoreServicesUsersPushedBoughtProduct_PushedBoughtProductDeta
|
|
|
14266
14297
|
* Entity type: OrderLine
|
|
14267
14298
|
*/
|
|
14268
14299
|
OrderLineID?: string;
|
|
14300
|
+
/**
|
|
14301
|
+
* Entity type: OrganizationUnit
|
|
14302
|
+
* Organization unit that the user bought product is registered in. Ignored when an order/line organization unit is present. When omitted, registration is under the current organization unit.
|
|
14303
|
+
*/
|
|
14304
|
+
OrganizationUnitID?: string;
|
|
14269
14305
|
PurchaseDate?: string;
|
|
14270
14306
|
PurchasedQuantity?: number;
|
|
14271
14307
|
}
|
|
@@ -14284,6 +14320,11 @@ export interface RegisterUserBoughtProduct {
|
|
|
14284
14320
|
*/
|
|
14285
14321
|
OrderLineID?: string;
|
|
14286
14322
|
/**
|
|
14323
|
+
* Entity type: OrganizationUnit
|
|
14324
|
+
* Organization unit that the user bought product is registered in. Ignored when an order/line organization unit is present. When omitted, registration is under the current organization unit.
|
|
14325
|
+
*/
|
|
14326
|
+
OrganizationUnitID?: string;
|
|
14327
|
+
/**
|
|
14287
14328
|
* Entity type: Product
|
|
14288
14329
|
*/
|
|
14289
14330
|
ProductID: string;
|
|
@@ -14312,6 +14353,11 @@ export interface UpdateUserBoughtProductDetail {
|
|
|
14312
14353
|
* Entity type: OrderLine
|
|
14313
14354
|
*/
|
|
14314
14355
|
OrderLineID?: string;
|
|
14356
|
+
/**
|
|
14357
|
+
* Entity type: OrganizationUnit
|
|
14358
|
+
* Organization unit that the user bought product is registered in. Ignored when an order/line organization unit is present. When omitted, registration is under the current organization unit.
|
|
14359
|
+
*/
|
|
14360
|
+
OrganizationUnitID?: string;
|
|
14315
14361
|
PurchaseDate?: string;
|
|
14316
14362
|
PurchasedQuantity?: number;
|
|
14317
14363
|
}
|