@springtree/eva-services-core-management 3.0.0-beta.1 → 3.0.0-beta.10
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 +496 -90
- package/lib/eva-services-core-management.d.ts.map +1 -1
- package/lib/eva-services-core-management.js.map +1 -1
- package/lib/eva-services-core-management.services.d.ts +75 -33
- package/lib/eva-services-core-management.services.d.ts.map +1 -1
- package/lib/eva-services-core-management.services.js +75 -33
- package/lib/eva-services-core-management.services.js.map +1 -1
- package/package.json +3 -3
|
@@ -717,11 +717,6 @@ export interface GetCaseByIDResponse {
|
|
|
717
717
|
*/
|
|
718
718
|
SummaryLastModifiedByID?: string;
|
|
719
719
|
Title?: string;
|
|
720
|
-
/**
|
|
721
|
-
* Entity type: CaseTopic
|
|
722
|
-
*/
|
|
723
|
-
TopicID?: string;
|
|
724
|
-
TopicName?: string;
|
|
725
720
|
}
|
|
726
721
|
export interface CasesGetCaseByIDResponse_CaseRepair {
|
|
727
722
|
CompletionTime?: string;
|
|
@@ -751,6 +746,7 @@ export interface CasesGetCaseByIDResponse_CaseTopicData {
|
|
|
751
746
|
TopicName?: string;
|
|
752
747
|
}
|
|
753
748
|
export interface CasesGetCaseByIDResponse_CustomerInfo {
|
|
749
|
+
BackendID?: string;
|
|
754
750
|
EmailAddress?: string;
|
|
755
751
|
FirstName?: string;
|
|
756
752
|
FullName?: string;
|
|
@@ -1078,7 +1074,6 @@ export interface PushCase {
|
|
|
1078
1074
|
AssignedOrganizationUnitBackendID?: string;
|
|
1079
1075
|
Assignee?: CasesPushCase_PushCaseAssignee;
|
|
1080
1076
|
BackendID: string;
|
|
1081
|
-
BackendSystemID?: string;
|
|
1082
1077
|
CaseRelatedItems?: CasesPushCase_PushCaseRelatedItems;
|
|
1083
1078
|
ClosingTime?: string;
|
|
1084
1079
|
CustomFields?: Record<string, TAnyValue | null>;
|
|
@@ -2055,7 +2050,16 @@ export interface UnsetSetting {
|
|
|
2055
2050
|
/**
|
|
2056
2051
|
* Entity type: OrganizationUnit
|
|
2057
2052
|
*/
|
|
2058
|
-
OrganizationUnitID
|
|
2053
|
+
OrganizationUnitID?: string;
|
|
2054
|
+
/**
|
|
2055
|
+
* Entity type: OrganizationUnitSet
|
|
2056
|
+
* Setting are not stored on sets, the set is evaluated when this service is called, and the unsetting is applied to all OrganizationUnits in the set.
|
|
2057
|
+
*/
|
|
2058
|
+
OrganizationUnitSetID?: string;
|
|
2059
|
+
/**
|
|
2060
|
+
* When a Value is given, the setting will only be removed when the Value matches.
|
|
2061
|
+
*/
|
|
2062
|
+
Value?: string;
|
|
2059
2063
|
}
|
|
2060
2064
|
export interface CreateCostPriceCalculation {
|
|
2061
2065
|
BackendID?: string;
|
|
@@ -2567,6 +2571,19 @@ export interface UpdateCustomField {
|
|
|
2567
2571
|
TypeKey: string | null | undefined;
|
|
2568
2572
|
}
|
|
2569
2573
|
/**
|
|
2574
|
+
* Add required custom fields to ManualDiscount
|
|
2575
|
+
*/
|
|
2576
|
+
export interface AddRequiredCustomFieldsToManualDiscount {
|
|
2577
|
+
/**
|
|
2578
|
+
* Entity type: CustomField
|
|
2579
|
+
*/
|
|
2580
|
+
CustomFieldIDs: string[];
|
|
2581
|
+
/**
|
|
2582
|
+
* Entity type: Discount
|
|
2583
|
+
*/
|
|
2584
|
+
DiscountID: string;
|
|
2585
|
+
}
|
|
2586
|
+
/**
|
|
2570
2587
|
* Add security roles to ManualDiscount
|
|
2571
2588
|
*/
|
|
2572
2589
|
export interface AddRolesToManualDiscount {
|
|
@@ -2654,6 +2671,10 @@ export interface CreateDiscount {
|
|
|
2654
2671
|
OrganizationUnitSetID: string;
|
|
2655
2672
|
PromotionLabel?: string;
|
|
2656
2673
|
/**
|
|
2674
|
+
* For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
|
|
2675
|
+
*/
|
|
2676
|
+
RequiredCustomFields?: string[];
|
|
2677
|
+
/**
|
|
2657
2678
|
* Entity type: OrganizationUnit
|
|
2658
2679
|
*/
|
|
2659
2680
|
RestitutionOrganizationUnitID?: string;
|
|
@@ -2985,6 +3006,7 @@ export interface GetDiscountByIDResponse {
|
|
|
2985
3006
|
* Entity type: DiscountCampaign
|
|
2986
3007
|
*/
|
|
2987
3008
|
CampaignID?: string;
|
|
3009
|
+
CannotApplyToOwnOrder: boolean;
|
|
2988
3010
|
CompliancyRule: DataModelsDiscountCompliancyRule;
|
|
2989
3011
|
ConditionType: DataModelsDiscountConditionTypes;
|
|
2990
3012
|
Conditions?: DiscountsGetDiscountByIDResponse_DiscountCondition[];
|
|
@@ -3049,6 +3071,7 @@ export interface GetDiscountByIDResponse {
|
|
|
3049
3071
|
OrganizationUnitSetName?: string;
|
|
3050
3072
|
OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
|
|
3051
3073
|
PromotionLabel?: string;
|
|
3074
|
+
RequiredCustomFields?: string[];
|
|
3052
3075
|
/**
|
|
3053
3076
|
* Entity type: OrganizationUnit
|
|
3054
3077
|
*/
|
|
@@ -3539,6 +3562,55 @@ export interface MoveDiscountLayer {
|
|
|
3539
3562
|
ID: string;
|
|
3540
3563
|
}
|
|
3541
3564
|
/**
|
|
3565
|
+
* Push a DiscountCoupon
|
|
3566
|
+
*/
|
|
3567
|
+
export interface PushDiscountCoupons {
|
|
3568
|
+
Coupons?: DiscountsPushDiscountCoupons_PushedCoupon[];
|
|
3569
|
+
/**
|
|
3570
|
+
* Entity type: Discount
|
|
3571
|
+
*/
|
|
3572
|
+
DiscountID?: string;
|
|
3573
|
+
}
|
|
3574
|
+
export interface DiscountsPushDiscountCoupons_PushedCoupon {
|
|
3575
|
+
CouponCode?: string;
|
|
3576
|
+
IsActive?: boolean;
|
|
3577
|
+
MaximumUsage?: number;
|
|
3578
|
+
/**
|
|
3579
|
+
* Entity type: Order
|
|
3580
|
+
*/
|
|
3581
|
+
OrderID?: string;
|
|
3582
|
+
/**
|
|
3583
|
+
* Entity type: User
|
|
3584
|
+
*/
|
|
3585
|
+
UserID?: string;
|
|
3586
|
+
}
|
|
3587
|
+
export interface PushDiscountCouponsResponse {
|
|
3588
|
+
CreatedCoupons?: DiscountsPushDiscountCouponsResponse_CreatedCoupon[];
|
|
3589
|
+
Error?: ServiceError;
|
|
3590
|
+
Metadata?: ResponseMessageMetadata;
|
|
3591
|
+
}
|
|
3592
|
+
export interface DiscountsPushDiscountCouponsResponse_CreatedCoupon {
|
|
3593
|
+
/**
|
|
3594
|
+
* Entity type: DiscountCoupon
|
|
3595
|
+
*/
|
|
3596
|
+
ID: string;
|
|
3597
|
+
IsDuplicateCoupon: boolean;
|
|
3598
|
+
}
|
|
3599
|
+
/**
|
|
3600
|
+
* Remove required custom fields from ManualDiscount
|
|
3601
|
+
*/
|
|
3602
|
+
export interface RemoveRequiredCustomFieldsFromManualDiscount {
|
|
3603
|
+
/**
|
|
3604
|
+
* Entity type: CustomField
|
|
3605
|
+
*/
|
|
3606
|
+
CustomFieldIDs?: string[];
|
|
3607
|
+
/**
|
|
3608
|
+
* Entity type: Discount
|
|
3609
|
+
*/
|
|
3610
|
+
DiscountID: string;
|
|
3611
|
+
RemoveAllRequiredCustomFields?: boolean;
|
|
3612
|
+
}
|
|
3613
|
+
/**
|
|
3542
3614
|
* Remove security roles from ManualDiscount
|
|
3543
3615
|
*/
|
|
3544
3616
|
export interface RemoveRolesFromManualDiscount {
|
|
@@ -3623,6 +3695,15 @@ export interface DiscountsSearchDiscountsByQueryResponse_DiscountDto {
|
|
|
3623
3695
|
UserUsageReloadStrategy?: string;
|
|
3624
3696
|
}
|
|
3625
3697
|
/**
|
|
3698
|
+
* Takes in all discount layers and sets their sequences. All layers except the system layer are required.
|
|
3699
|
+
*/
|
|
3700
|
+
export interface SetDiscountLayerSequences {
|
|
3701
|
+
/**
|
|
3702
|
+
* Entity type: DiscountLayer
|
|
3703
|
+
*/
|
|
3704
|
+
Layers: string[];
|
|
3705
|
+
}
|
|
3706
|
+
/**
|
|
3626
3707
|
* Update an existing discount
|
|
3627
3708
|
*/
|
|
3628
3709
|
export interface UpdateDiscount {
|
|
@@ -3689,6 +3770,10 @@ export interface UpdateDiscount {
|
|
|
3689
3770
|
OrganizationUnitSetID: string;
|
|
3690
3771
|
PromotionLabel?: string;
|
|
3691
3772
|
/**
|
|
3773
|
+
* For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
|
|
3774
|
+
*/
|
|
3775
|
+
RequiredCustomFields: string[] | null | undefined;
|
|
3776
|
+
/**
|
|
3692
3777
|
* Entity type: OrganizationUnit
|
|
3693
3778
|
*/
|
|
3694
3779
|
RestitutionOrganizationUnitID?: string;
|
|
@@ -3842,24 +3927,6 @@ export interface UploadCouponExcelResponse {
|
|
|
3842
3927
|
IsProcessedAsync: boolean;
|
|
3843
3928
|
Metadata?: ResponseMessageMetadata;
|
|
3844
3929
|
}
|
|
3845
|
-
export interface UploadCouponExcel_Async {
|
|
3846
|
-
/**
|
|
3847
|
-
* Entity type: Blob
|
|
3848
|
-
*/
|
|
3849
|
-
BlobID?: string;
|
|
3850
|
-
/**
|
|
3851
|
-
* Entity type: Discount
|
|
3852
|
-
*/
|
|
3853
|
-
DiscountID: string;
|
|
3854
|
-
}
|
|
3855
|
-
export interface UploadCouponExcel_AsyncResponse {
|
|
3856
|
-
Error?: ServiceError;
|
|
3857
|
-
JobID?: string;
|
|
3858
|
-
Metadata?: ResponseMessageMetadata;
|
|
3859
|
-
}
|
|
3860
|
-
export interface UploadCouponExcel_AsyncResult {
|
|
3861
|
-
JobID?: string;
|
|
3862
|
-
}
|
|
3863
3930
|
/**
|
|
3864
3931
|
* Validates the given discount information
|
|
3865
3932
|
*/
|
|
@@ -3918,6 +3985,10 @@ export interface ValidateDiscount {
|
|
|
3918
3985
|
*/
|
|
3919
3986
|
OrganizationUnitSetID: string;
|
|
3920
3987
|
/**
|
|
3988
|
+
* For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
|
|
3989
|
+
*/
|
|
3990
|
+
RequiredCustomFields?: string[];
|
|
3991
|
+
/**
|
|
3921
3992
|
* Entity type: OrganizationUnit
|
|
3922
3993
|
*/
|
|
3923
3994
|
RestitutionOrganizationUnitID?: string;
|
|
@@ -4474,6 +4545,10 @@ export interface GiftCardsListGiftCardConfigurationsResponse_GiftCardConfigurati
|
|
|
4474
4545
|
* `ProductGiftCard`: an item that describes the giftcard properties of a product with type GiftCard
|
|
4475
4546
|
*/
|
|
4476
4547
|
export interface ListProductGiftCards {
|
|
4548
|
+
/**
|
|
4549
|
+
* Entity type: ProductPropertyType
|
|
4550
|
+
*/
|
|
4551
|
+
IncludedProductProperties?: string[];
|
|
4477
4552
|
PageConfig?: PageConfig<GiftCardsListProductGiftCardsFilter>;
|
|
4478
4553
|
}
|
|
4479
4554
|
export interface ListProductGiftCardsResponse {
|
|
@@ -4496,6 +4571,7 @@ export interface GiftCardsListProductGiftCardsResponse_ProductGiftCardDto {
|
|
|
4496
4571
|
*/
|
|
4497
4572
|
ID: string;
|
|
4498
4573
|
IsDigital: boolean;
|
|
4574
|
+
Product?: SearchIProductSearchItem;
|
|
4499
4575
|
/**
|
|
4500
4576
|
* Entity type: Product
|
|
4501
4577
|
*/
|
|
@@ -5018,26 +5094,26 @@ export interface AddLoyaltyProgramPriceList {
|
|
|
5018
5094
|
PriceListID: string;
|
|
5019
5095
|
}
|
|
5020
5096
|
/**
|
|
5021
|
-
*
|
|
5097
|
+
* Add a custom field requirement to the loyalty program. NOTE THAT a custom field can only be set once as a requirement.
|
|
5022
5098
|
*/
|
|
5023
|
-
export interface
|
|
5099
|
+
export interface AddLoyaltyProgramRequiredCustomField {
|
|
5024
5100
|
/**
|
|
5025
|
-
* Entity type:
|
|
5101
|
+
* Entity type: CustomField
|
|
5026
5102
|
*/
|
|
5027
|
-
|
|
5103
|
+
CustomFieldID: string;
|
|
5104
|
+
/**
|
|
5105
|
+
* Entity type: LoyaltyProgram
|
|
5106
|
+
*/
|
|
5107
|
+
LoyaltyProgramID: string;
|
|
5028
5108
|
}
|
|
5029
5109
|
/**
|
|
5030
|
-
*
|
|
5110
|
+
* Archive a point awarding rule
|
|
5031
5111
|
*/
|
|
5032
|
-
export interface
|
|
5033
|
-
/**
|
|
5034
|
-
* Entity type: LoyaltyProgramPaymentType
|
|
5035
|
-
*/
|
|
5036
|
-
LoyaltyProgramPaymentTypeID: string;
|
|
5112
|
+
export interface ArchivePointAwardingRule {
|
|
5037
5113
|
/**
|
|
5038
|
-
* Entity type:
|
|
5114
|
+
* Entity type: PointAwardingRule
|
|
5039
5115
|
*/
|
|
5040
|
-
|
|
5116
|
+
ID: string;
|
|
5041
5117
|
}
|
|
5042
5118
|
/**
|
|
5043
5119
|
* Attach a loyalty program to an order
|
|
@@ -5055,6 +5131,9 @@ export interface AttachLoyaltyProgramToOrder {
|
|
|
5055
5131
|
* Entity type: User
|
|
5056
5132
|
*/
|
|
5057
5133
|
UserID?: string;
|
|
5134
|
+
/**
|
|
5135
|
+
* When set, the UserID will also become required so we can verify the UserIdentifier.
|
|
5136
|
+
*/
|
|
5058
5137
|
UserIdentifier?: string;
|
|
5059
5138
|
}
|
|
5060
5139
|
/**
|
|
@@ -5212,6 +5291,7 @@ export interface CreateLoyaltyProgramPaymentType {
|
|
|
5212
5291
|
* Entity type: PaymentType
|
|
5213
5292
|
*/
|
|
5214
5293
|
PaymentTypeID: string;
|
|
5294
|
+
ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
|
|
5215
5295
|
Required?: boolean;
|
|
5216
5296
|
Sequence?: number;
|
|
5217
5297
|
TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
@@ -5255,6 +5335,10 @@ export interface CreateLoyaltyProgramResponse {
|
|
|
5255
5335
|
*/
|
|
5256
5336
|
ID: string;
|
|
5257
5337
|
Metadata?: ResponseMessageMetadata;
|
|
5338
|
+
/**
|
|
5339
|
+
* Entity type: Subscription
|
|
5340
|
+
*/
|
|
5341
|
+
SubscriptionID: string;
|
|
5258
5342
|
}
|
|
5259
5343
|
/**
|
|
5260
5344
|
* Create a point awarding rule.
|
|
@@ -5373,19 +5457,6 @@ export interface DetachLoyaltyProgramFromOrder {
|
|
|
5373
5457
|
OrderID: string;
|
|
5374
5458
|
}
|
|
5375
5459
|
/**
|
|
5376
|
-
* Detach a product limitation from a payment type.
|
|
5377
|
-
*/
|
|
5378
|
-
export interface DetachLoyaltyProgramProductLimitationFromPaymentType {
|
|
5379
|
-
/**
|
|
5380
|
-
* Entity type: LoyaltyProgramPaymentType
|
|
5381
|
-
*/
|
|
5382
|
-
LoyaltyProgramPaymentTypeID: string;
|
|
5383
|
-
/**
|
|
5384
|
-
* Entity type: LoyaltyProgramProductLimitation
|
|
5385
|
-
*/
|
|
5386
|
-
LoyaltyProgramProductLimitationID: string;
|
|
5387
|
-
}
|
|
5388
|
-
/**
|
|
5389
5460
|
* Disable a point awarding rule
|
|
5390
5461
|
*/
|
|
5391
5462
|
export interface DisablePointAwardingRule {
|
|
@@ -5522,6 +5593,7 @@ export interface GetLoyaltyProgramPaymentTypeResponse {
|
|
|
5522
5593
|
*/
|
|
5523
5594
|
PaymentTypeID: string;
|
|
5524
5595
|
PaymentTypeName?: string;
|
|
5596
|
+
ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
|
|
5525
5597
|
Required: boolean;
|
|
5526
5598
|
Sequence: number;
|
|
5527
5599
|
TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
@@ -5637,6 +5709,34 @@ export interface GetLoyaltyProgramResponse {
|
|
|
5637
5709
|
UserMaximumUsage?: number;
|
|
5638
5710
|
}
|
|
5639
5711
|
/**
|
|
5712
|
+
* Get the available loyalty program payment methods for the given order.
|
|
5713
|
+
*/
|
|
5714
|
+
export interface GetOrderLoyaltyProgramPaymentTypes {
|
|
5715
|
+
/**
|
|
5716
|
+
* Entity type: Order
|
|
5717
|
+
*/
|
|
5718
|
+
OrderID: string;
|
|
5719
|
+
}
|
|
5720
|
+
export interface GetOrderLoyaltyProgramPaymentTypesResponse {
|
|
5721
|
+
Error?: ServiceError;
|
|
5722
|
+
Metadata?: ResponseMessageMetadata;
|
|
5723
|
+
Options?: LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option[];
|
|
5724
|
+
}
|
|
5725
|
+
export interface LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option {
|
|
5726
|
+
BackendID?: string;
|
|
5727
|
+
/**
|
|
5728
|
+
* Entity type: LoyaltyProgramPaymentType
|
|
5729
|
+
*/
|
|
5730
|
+
ID: string;
|
|
5731
|
+
/**
|
|
5732
|
+
* Entity type: PaymentType
|
|
5733
|
+
*/
|
|
5734
|
+
PaymentTypeID: string;
|
|
5735
|
+
PaymentTypeName?: string;
|
|
5736
|
+
Required: boolean;
|
|
5737
|
+
Sequence: number;
|
|
5738
|
+
}
|
|
5739
|
+
/**
|
|
5640
5740
|
* Get loyalty point rule.
|
|
5641
5741
|
*/
|
|
5642
5742
|
export interface GetPointAwardingRule {
|
|
@@ -5853,10 +5953,50 @@ export interface LoyaltyListLoyaltyProgramProductLimitationsResponse_Item {
|
|
|
5853
5953
|
*/
|
|
5854
5954
|
ID: string;
|
|
5855
5955
|
Name?: string;
|
|
5956
|
+
/**
|
|
5957
|
+
* The quantity limit over the entire product limitation product set per order.
|
|
5958
|
+
*/
|
|
5959
|
+
OverallQuantityLimitPerOrder?: number;
|
|
5960
|
+
/**
|
|
5961
|
+
* The quantity limit over the entire product limitation product set per user.
|
|
5962
|
+
*/
|
|
5963
|
+
OverallQuantityLimitPerUser?: number;
|
|
5964
|
+
/**
|
|
5965
|
+
* The quantity limit per product within the product limitation product set per order.
|
|
5966
|
+
*/
|
|
5856
5967
|
QuantityLimitPerOrder?: number;
|
|
5968
|
+
/**
|
|
5969
|
+
* The quantity limit per product within the product limitation product set per user.
|
|
5970
|
+
*/
|
|
5857
5971
|
QuantityLimitPerUser?: number;
|
|
5858
5972
|
}
|
|
5859
5973
|
/**
|
|
5974
|
+
* List the loyalty program CustomFieldRequirements
|
|
5975
|
+
*/
|
|
5976
|
+
export interface ListLoyaltyProgramRequiredCustomFields {
|
|
5977
|
+
InitialPageConfig?: PageTokenConfig<Record<string, string | null> | null>;
|
|
5978
|
+
/**
|
|
5979
|
+
* Entity type: LoyaltyProgram
|
|
5980
|
+
*/
|
|
5981
|
+
LoyaltyProgramID: string;
|
|
5982
|
+
PageToken?: string;
|
|
5983
|
+
}
|
|
5984
|
+
export interface ListLoyaltyProgramRequiredCustomFieldsResponse {
|
|
5985
|
+
Error?: ServiceError;
|
|
5986
|
+
Metadata?: ResponseMessageMetadata;
|
|
5987
|
+
NextPageToken?: string;
|
|
5988
|
+
PreviousPageToken?: string;
|
|
5989
|
+
Results?: LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField[];
|
|
5990
|
+
}
|
|
5991
|
+
export interface LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField {
|
|
5992
|
+
BackendID?: string;
|
|
5993
|
+
/**
|
|
5994
|
+
* Entity type: CustomField
|
|
5995
|
+
*/
|
|
5996
|
+
ID: string;
|
|
5997
|
+
Name?: string;
|
|
5998
|
+
}
|
|
5999
|
+
/**
|
|
5860
6000
|
* List the LoyaltyPrograms
|
|
5861
6001
|
*/
|
|
5862
6002
|
export interface ListLoyaltyPrograms {
|
|
@@ -5926,6 +6066,14 @@ export interface LoyaltyListPointAwardingRulesResponse_Rule {
|
|
|
5926
6066
|
export interface LoyaltyLoyaltyProgramProductLimitationData {
|
|
5927
6067
|
Filters?: Record<string, SearchFilterModel>;
|
|
5928
6068
|
/**
|
|
6069
|
+
* The quantity limit over the entire product limitation product set per order.
|
|
6070
|
+
*/
|
|
6071
|
+
OverallQuantityLimitPerOrder?: number;
|
|
6072
|
+
/**
|
|
6073
|
+
* The quantity limit over the entire product limitation product set per user.
|
|
6074
|
+
*/
|
|
6075
|
+
OverallQuantityLimitPerUser?: number;
|
|
6076
|
+
/**
|
|
5929
6077
|
* Entity type: Product
|
|
5930
6078
|
*/
|
|
5931
6079
|
ProductIDs?: string[];
|
|
@@ -5933,17 +6081,25 @@ export interface LoyaltyLoyaltyProgramProductLimitationData {
|
|
|
5933
6081
|
* Entity type: ProductSearchTemplate
|
|
5934
6082
|
*/
|
|
5935
6083
|
ProductSearchID?: string;
|
|
6084
|
+
/**
|
|
6085
|
+
* The quantity limit per product within the product limitation product set per order.
|
|
6086
|
+
*/
|
|
5936
6087
|
QuantityLimitPerOrder?: number;
|
|
6088
|
+
/**
|
|
6089
|
+
* The quantity limit per product within the product limitation product set per user.
|
|
6090
|
+
*/
|
|
5937
6091
|
QuantityLimitPerUser?: number;
|
|
5938
6092
|
}
|
|
5939
6093
|
/**
|
|
5940
6094
|
* Push a LoyaltyProgram.
|
|
6095
|
+
* If it doesn't exist it will be created, otherwise is will be updated.
|
|
6096
|
+
* Sub entities will also be created or updated, but will not be removed.
|
|
5941
6097
|
*/
|
|
5942
|
-
export interface
|
|
6098
|
+
export interface LoyaltyPushLoyaltyProgram {
|
|
5943
6099
|
/**
|
|
5944
6100
|
* Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
|
|
5945
6101
|
*/
|
|
5946
|
-
AllowUnsubscribeBy
|
|
6102
|
+
AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType;
|
|
5947
6103
|
/**
|
|
5948
6104
|
* When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
|
|
5949
6105
|
* When false, the loyalty program will automatically be applied if all conditions are met.
|
|
@@ -5971,7 +6127,7 @@ export interface PushLoyaltyProgram {
|
|
|
5971
6127
|
* Entity type: LoyaltyProgram
|
|
5972
6128
|
*/
|
|
5973
6129
|
ID: string;
|
|
5974
|
-
LoyaltyPointUsageOptions
|
|
6130
|
+
LoyaltyPointUsageOptions: DataModelsLoyaltyPointUsageOptions;
|
|
5975
6131
|
/**
|
|
5976
6132
|
* Entity type: LoyaltyProgramGroup
|
|
5977
6133
|
*/
|
|
@@ -5981,12 +6137,12 @@ export interface PushLoyaltyProgram {
|
|
|
5981
6137
|
OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
|
|
5982
6138
|
PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
|
|
5983
6139
|
PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
|
|
5984
|
-
PointExpirationPolicyData?: TAnyValue
|
|
6140
|
+
PointExpirationPolicyData?: Record<string, TAnyValue>;
|
|
5985
6141
|
PointExpirationPolicyType?: string;
|
|
5986
|
-
PointPendingPolicyData?: TAnyValue
|
|
6142
|
+
PointPendingPolicyData?: Record<string, TAnyValue>;
|
|
5987
6143
|
PointPendingPolicyType?: string;
|
|
5988
6144
|
/**
|
|
5989
|
-
* Entity type:
|
|
6145
|
+
* Entity type: PriceList
|
|
5990
6146
|
*/
|
|
5991
6147
|
PriceLists?: string[];
|
|
5992
6148
|
ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
|
|
@@ -6005,6 +6161,7 @@ export interface PushLoyaltyProgram {
|
|
|
6005
6161
|
* 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.
|
|
6006
6162
|
*/
|
|
6007
6163
|
RequireManualUserIdentifier?: boolean;
|
|
6164
|
+
RequiredCustomFields?: string[];
|
|
6008
6165
|
/**
|
|
6009
6166
|
* 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.
|
|
6010
6167
|
* Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
|
|
@@ -6022,7 +6179,7 @@ export interface PushLoyaltyProgram {
|
|
|
6022
6179
|
/**
|
|
6023
6180
|
* Handling when a user is unsubscribed and re-subscribes.
|
|
6024
6181
|
*/
|
|
6025
|
-
ResubscribeHandling
|
|
6182
|
+
ResubscribeHandling: DataModelsResubscribeHandlingType;
|
|
6026
6183
|
StartDate?: string;
|
|
6027
6184
|
Status: DataModelsLoyaltyProgramStatus;
|
|
6028
6185
|
UserBudget?: number;
|
|
@@ -6047,7 +6204,7 @@ export interface PushLoyaltyProgram {
|
|
|
6047
6204
|
UserMaximumUsage?: number;
|
|
6048
6205
|
}
|
|
6049
6206
|
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition {
|
|
6050
|
-
Data: TAnyValue
|
|
6207
|
+
Data: Record<string, TAnyValue>;
|
|
6051
6208
|
/**
|
|
6052
6209
|
* Entity type: LoyaltyProgramCondition
|
|
6053
6210
|
*/
|
|
@@ -6073,7 +6230,7 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
|
|
|
6073
6230
|
* Entity type: PaymentType
|
|
6074
6231
|
*/
|
|
6075
6232
|
PaymentTypeID: string;
|
|
6076
|
-
ProductLimitation?:
|
|
6233
|
+
ProductLimitation?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData;
|
|
6077
6234
|
Required?: boolean;
|
|
6078
6235
|
Sequence?: number;
|
|
6079
6236
|
TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
@@ -6081,10 +6238,40 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
|
|
|
6081
6238
|
UserBudgetDeduction: DataModelsUserBudgetDeduction;
|
|
6082
6239
|
UserMaximumUsage?: number;
|
|
6083
6240
|
}
|
|
6241
|
+
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData {
|
|
6242
|
+
Filters?: Record<string, SearchFilterModel>;
|
|
6243
|
+
/**
|
|
6244
|
+
* The quantity limit over the entire product limitation product set per order.
|
|
6245
|
+
*/
|
|
6246
|
+
OverallQuantityLimitPerOrder?: number;
|
|
6247
|
+
/**
|
|
6248
|
+
* The quantity limit over the entire product limitation product set per user.
|
|
6249
|
+
*/
|
|
6250
|
+
OverallQuantityLimitPerUser?: number;
|
|
6251
|
+
/**
|
|
6252
|
+
* Entity type: Product
|
|
6253
|
+
*/
|
|
6254
|
+
ProductIDs?: string[];
|
|
6255
|
+
/**
|
|
6256
|
+
* Entity type: ProductSearchTemplate
|
|
6257
|
+
*/
|
|
6258
|
+
ProductSearchID?: string;
|
|
6259
|
+
/**
|
|
6260
|
+
* The quantity limit per product within the product limitation product set per order.
|
|
6261
|
+
*/
|
|
6262
|
+
QuantityLimitPerOrder?: number;
|
|
6263
|
+
/**
|
|
6264
|
+
* The quantity limit per product within the product limitation product set per user.
|
|
6265
|
+
*/
|
|
6266
|
+
QuantityLimitPerUser?: number;
|
|
6267
|
+
}
|
|
6084
6268
|
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation {
|
|
6269
|
+
ApplyToPriceList?: boolean;
|
|
6085
6270
|
Filters?: Record<string, SearchFilterModel>;
|
|
6086
6271
|
ID: string;
|
|
6087
6272
|
Name: string;
|
|
6273
|
+
OverallQuantityLimitPerOrder?: number;
|
|
6274
|
+
OverallQuantityLimitPerUser?: number;
|
|
6088
6275
|
/**
|
|
6089
6276
|
* Entity type: Product
|
|
6090
6277
|
*/
|
|
@@ -6118,9 +6305,42 @@ export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRule {
|
|
|
6118
6305
|
}
|
|
6119
6306
|
export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition {
|
|
6120
6307
|
Data?: LoyaltyRulesIPointAwardingConditionData;
|
|
6121
|
-
ID
|
|
6308
|
+
ID: string;
|
|
6122
6309
|
Type: 'ORDERAMOUNT' | 'PRODUCT' | 'USERCUSTOMFIELD';
|
|
6123
6310
|
}
|
|
6311
|
+
export interface PushLoyaltyProgramGroupResponse {
|
|
6312
|
+
Error?: ServiceError;
|
|
6313
|
+
/**
|
|
6314
|
+
* Entity type: LoyaltyProgram
|
|
6315
|
+
*/
|
|
6316
|
+
ID: string;
|
|
6317
|
+
Metadata?: ResponseMessageMetadata;
|
|
6318
|
+
}
|
|
6319
|
+
export interface PushLoyaltyProgramGroup_Async {
|
|
6320
|
+
Budget?: number;
|
|
6321
|
+
/**
|
|
6322
|
+
* Entity type: Currency
|
|
6323
|
+
*/
|
|
6324
|
+
BudgetCurrencyID?: string;
|
|
6325
|
+
DeactivateWhenBudgetIsReached?: boolean;
|
|
6326
|
+
EndDate?: string;
|
|
6327
|
+
/**
|
|
6328
|
+
* Entity type: LoyaltyProgramGroup
|
|
6329
|
+
*/
|
|
6330
|
+
ID: string;
|
|
6331
|
+
Name: string;
|
|
6332
|
+
StartDate?: string;
|
|
6333
|
+
Status: DataModelsLoyaltyProgramStatus;
|
|
6334
|
+
TaxExemptionCode?: string;
|
|
6335
|
+
}
|
|
6336
|
+
export interface PushLoyaltyProgramGroup_AsyncResponse {
|
|
6337
|
+
Error?: ServiceError;
|
|
6338
|
+
JobID?: string;
|
|
6339
|
+
Metadata?: ResponseMessageMetadata;
|
|
6340
|
+
}
|
|
6341
|
+
export interface PushLoyaltyProgramGroup_AsyncResult {
|
|
6342
|
+
JobID?: string;
|
|
6343
|
+
}
|
|
6124
6344
|
export interface PushLoyaltyProgramResponse {
|
|
6125
6345
|
Error?: ServiceError;
|
|
6126
6346
|
/**
|
|
@@ -6128,6 +6348,126 @@ export interface PushLoyaltyProgramResponse {
|
|
|
6128
6348
|
*/
|
|
6129
6349
|
ID: string;
|
|
6130
6350
|
Metadata?: ResponseMessageMetadata;
|
|
6351
|
+
/**
|
|
6352
|
+
* Entity type: Subscription
|
|
6353
|
+
*/
|
|
6354
|
+
SubscriptionID: string;
|
|
6355
|
+
}
|
|
6356
|
+
export interface PushLoyaltyProgram_Async {
|
|
6357
|
+
/**
|
|
6358
|
+
* Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
|
|
6359
|
+
*/
|
|
6360
|
+
AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType;
|
|
6361
|
+
/**
|
|
6362
|
+
* When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
|
|
6363
|
+
* When false, the loyalty program will automatically be applied if all conditions are met.
|
|
6364
|
+
*/
|
|
6365
|
+
ApplyManuallyOnly?: boolean;
|
|
6366
|
+
/**
|
|
6367
|
+
* When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
|
|
6368
|
+
* When false, the customer will not be subscribed.
|
|
6369
|
+
*
|
|
6370
|
+
* This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
|
|
6371
|
+
*/
|
|
6372
|
+
AutoSubscribeCustomer?: boolean;
|
|
6373
|
+
Budget?: number;
|
|
6374
|
+
/**
|
|
6375
|
+
* Entity type: Currency
|
|
6376
|
+
*/
|
|
6377
|
+
BudgetCurrencyID?: string;
|
|
6378
|
+
Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
|
|
6379
|
+
Data?: TAnyValue;
|
|
6380
|
+
DeactivateWhenBudgetIsReached?: boolean;
|
|
6381
|
+
Description?: string;
|
|
6382
|
+
EndDate?: string;
|
|
6383
|
+
Handler: string;
|
|
6384
|
+
/**
|
|
6385
|
+
* Entity type: LoyaltyProgram
|
|
6386
|
+
*/
|
|
6387
|
+
ID: string;
|
|
6388
|
+
LoyaltyPointUsageOptions: DataModelsLoyaltyPointUsageOptions;
|
|
6389
|
+
/**
|
|
6390
|
+
* Entity type: LoyaltyProgramGroup
|
|
6391
|
+
*/
|
|
6392
|
+
LoyaltyProgramGroupID?: string;
|
|
6393
|
+
Name: string;
|
|
6394
|
+
Options: DataModelsLoyaltyProgramOptions;
|
|
6395
|
+
OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
|
|
6396
|
+
PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
|
|
6397
|
+
PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
|
|
6398
|
+
PointExpirationPolicyData?: Record<string, TAnyValue>;
|
|
6399
|
+
PointExpirationPolicyType?: string;
|
|
6400
|
+
PointPendingPolicyData?: Record<string, TAnyValue>;
|
|
6401
|
+
PointPendingPolicyType?: string;
|
|
6402
|
+
/**
|
|
6403
|
+
* Entity type: PriceList
|
|
6404
|
+
*/
|
|
6405
|
+
PriceLists?: string[];
|
|
6406
|
+
ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
|
|
6407
|
+
ReactivateProgramWhenPossible?: boolean;
|
|
6408
|
+
ReloadPolicy?: string;
|
|
6409
|
+
/**
|
|
6410
|
+
* When true, the loyalty program will only be applied when a customer is attached to the order.
|
|
6411
|
+
*
|
|
6412
|
+
* When false, the loyalty program can be attached to the order even if there is no customer attached.
|
|
6413
|
+
*/
|
|
6414
|
+
RequireCustomer?: boolean;
|
|
6415
|
+
/**
|
|
6416
|
+
* When set to true, subscribing the user will require a UserIdentifier to be given.
|
|
6417
|
+
* Attention!
|
|
6418
|
+
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6419
|
+
* 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.
|
|
6420
|
+
*/
|
|
6421
|
+
RequireManualUserIdentifier?: boolean;
|
|
6422
|
+
RequiredCustomFields?: string[];
|
|
6423
|
+
/**
|
|
6424
|
+
* 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.
|
|
6425
|
+
* Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
|
|
6426
|
+
*
|
|
6427
|
+
* When false, the loyalty program can be attached to the order if a customer is attached that isn't already subscribed to the loyalty program.
|
|
6428
|
+
*/
|
|
6429
|
+
RequiresSubscribedCustomer?: boolean;
|
|
6430
|
+
/**
|
|
6431
|
+
* When true, the order will require that the attached customer on the order will be validated by providing the UserIdentifier in the `AttachBenefitProgramToOrder` service.
|
|
6432
|
+
* Also, this will make the `RequireCustomer` and `RequiresSubscribedCustomer` automatically true and `AutoSubscribeCustomer` false.
|
|
6433
|
+
*
|
|
6434
|
+
* When false, this validation isn't required.
|
|
6435
|
+
*/
|
|
6436
|
+
RequiresSubscriptionValidation?: boolean;
|
|
6437
|
+
/**
|
|
6438
|
+
* Handling when a user is unsubscribed and re-subscribes.
|
|
6439
|
+
*/
|
|
6440
|
+
ResubscribeHandling: DataModelsResubscribeHandlingType;
|
|
6441
|
+
StartDate?: string;
|
|
6442
|
+
Status: DataModelsLoyaltyProgramStatus;
|
|
6443
|
+
UserBudget?: number;
|
|
6444
|
+
/**
|
|
6445
|
+
* Attention!
|
|
6446
|
+
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6447
|
+
* 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.
|
|
6448
|
+
*/
|
|
6449
|
+
UserIdentifierPrefix?: string;
|
|
6450
|
+
/**
|
|
6451
|
+
* Attention!
|
|
6452
|
+
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6453
|
+
* 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.
|
|
6454
|
+
*/
|
|
6455
|
+
UserIdentifierStartNumber?: string;
|
|
6456
|
+
/**
|
|
6457
|
+
* Attention!
|
|
6458
|
+
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6459
|
+
* 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.
|
|
6460
|
+
*/
|
|
6461
|
+
UserIdentifierSuffix?: string;
|
|
6462
|
+
UserMaximumUsage?: number;
|
|
6463
|
+
}
|
|
6464
|
+
export interface PushLoyaltyProgram_AsyncResponse {
|
|
6465
|
+
Error?: ServiceError;
|
|
6466
|
+
JobID?: string;
|
|
6467
|
+
Metadata?: ResponseMessageMetadata;
|
|
6468
|
+
}
|
|
6469
|
+
export interface PushLoyaltyProgram_AsyncResult {
|
|
6470
|
+
JobID?: string;
|
|
6131
6471
|
}
|
|
6132
6472
|
/**
|
|
6133
6473
|
* Rebalance loyalty points of a user
|
|
@@ -6172,6 +6512,33 @@ export interface RemoveLoyaltyProgramPriceList {
|
|
|
6172
6512
|
PriceListID: string;
|
|
6173
6513
|
}
|
|
6174
6514
|
/**
|
|
6515
|
+
* Removes a custom field requirement from a loyalty program.
|
|
6516
|
+
*/
|
|
6517
|
+
export interface RemoveLoyaltyProgramRequiredCustomField {
|
|
6518
|
+
/**
|
|
6519
|
+
* Entity type: CustomField
|
|
6520
|
+
*/
|
|
6521
|
+
CustomFieldID: string;
|
|
6522
|
+
/**
|
|
6523
|
+
* Entity type: LoyaltyProgram
|
|
6524
|
+
*/
|
|
6525
|
+
LoyaltyProgramID: string;
|
|
6526
|
+
}
|
|
6527
|
+
/**
|
|
6528
|
+
* Set the optional loyalty program payment types for the order.
|
|
6529
|
+
*/
|
|
6530
|
+
export interface SetOrderLoyaltyProgramPaymentTypes {
|
|
6531
|
+
/**
|
|
6532
|
+
* Entity type: Order
|
|
6533
|
+
*/
|
|
6534
|
+
OrderID: string;
|
|
6535
|
+
/**
|
|
6536
|
+
* Entity type: LoyaltyProgramPaymentType
|
|
6537
|
+
* When left empty no optional payment types will be available. Required payment types cannot be unselected.
|
|
6538
|
+
*/
|
|
6539
|
+
SelectedLoyaltyProgramPaymentTypes: string[];
|
|
6540
|
+
}
|
|
6541
|
+
/**
|
|
6175
6542
|
* Update an existing LoyaltyProgram
|
|
6176
6543
|
*/
|
|
6177
6544
|
export interface UpdateLoyaltyProgram {
|
|
@@ -6346,6 +6713,7 @@ export interface UpdateLoyaltyProgramPaymentType {
|
|
|
6346
6713
|
ID: string;
|
|
6347
6714
|
MaximumAmountPerOrder?: number;
|
|
6348
6715
|
MaximumPercentageOfUserBudgetPerOrder?: number;
|
|
6716
|
+
ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
|
|
6349
6717
|
Required?: boolean;
|
|
6350
6718
|
Sequence?: number;
|
|
6351
6719
|
TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
@@ -6908,18 +7276,6 @@ export interface GetCheckoutOptionHandlersResponse {
|
|
|
6908
7276
|
Metadata?: ResponseMessageMetadata;
|
|
6909
7277
|
}
|
|
6910
7278
|
/**
|
|
6911
|
-
* Get the CheckoutOptions
|
|
6912
|
-
*/
|
|
6913
|
-
export interface GetCheckoutOptions {
|
|
6914
|
-
IncludeInactive?: boolean;
|
|
6915
|
-
}
|
|
6916
|
-
export interface GetCheckoutOptionsResponse {
|
|
6917
|
-
Categories?: OrdersCheckoutOptionCategoryDto[];
|
|
6918
|
-
Error?: ServiceError;
|
|
6919
|
-
Metadata?: ResponseMessageMetadata;
|
|
6920
|
-
Options?: OrdersCheckoutOptionDto[];
|
|
6921
|
-
}
|
|
6922
|
-
/**
|
|
6923
7279
|
* Returns a single refund reason.
|
|
6924
7280
|
*/
|
|
6925
7281
|
export interface GetRefundCorrectionReason {
|
|
@@ -7533,6 +7889,7 @@ export interface CreateCashHandler {
|
|
|
7533
7889
|
* Entity type: Currency
|
|
7534
7890
|
*/
|
|
7535
7891
|
CurrencyID: string;
|
|
7892
|
+
MaxAmountPerOrder?: number;
|
|
7536
7893
|
Name: string;
|
|
7537
7894
|
RoundingFactor: number;
|
|
7538
7895
|
}
|
|
@@ -7660,6 +8017,7 @@ export interface GetCashHandlerByIDResponse {
|
|
|
7660
8017
|
CurrencyID?: string;
|
|
7661
8018
|
Error?: ServiceError;
|
|
7662
8019
|
ID: string;
|
|
8020
|
+
MaxAmountPerOrder?: number;
|
|
7663
8021
|
Metadata?: ResponseMessageMetadata;
|
|
7664
8022
|
Name?: string;
|
|
7665
8023
|
RoundingFactor: number;
|
|
@@ -7718,6 +8076,7 @@ export interface OrganizationUnitsListCashHandlersResponse_CashHandlerDto {
|
|
|
7718
8076
|
* Entity type: CashHandler
|
|
7719
8077
|
*/
|
|
7720
8078
|
ID: string;
|
|
8079
|
+
MaxAmountPerOrder?: number;
|
|
7721
8080
|
Name?: string;
|
|
7722
8081
|
RoundingFactor: number;
|
|
7723
8082
|
}
|
|
@@ -7785,18 +8144,19 @@ export interface SetOrganizationUnitSupplierData {
|
|
|
7785
8144
|
* Update an existing CashHandler
|
|
7786
8145
|
*/
|
|
7787
8146
|
export interface UpdateCashHandler {
|
|
7788
|
-
BankNotes
|
|
7789
|
-
Coins
|
|
8147
|
+
BankNotes?: number[];
|
|
8148
|
+
Coins?: number[];
|
|
7790
8149
|
/**
|
|
7791
8150
|
* Entity type: Currency
|
|
7792
8151
|
*/
|
|
7793
|
-
CurrencyID
|
|
8152
|
+
CurrencyID?: string;
|
|
7794
8153
|
/**
|
|
7795
8154
|
* Entity type: CashHandler
|
|
7796
8155
|
*/
|
|
7797
8156
|
ID: string;
|
|
7798
|
-
|
|
7799
|
-
|
|
8157
|
+
MaxAmountPerOrder: number | null | undefined;
|
|
8158
|
+
Name?: string;
|
|
8159
|
+
RoundingFactor?: number;
|
|
7800
8160
|
}
|
|
7801
8161
|
/**
|
|
7802
8162
|
* Update an existing OpeningHoursType
|
|
@@ -8849,6 +9209,10 @@ export interface CreatePriceListAdjustment {
|
|
|
8849
9209
|
PriceListID: string;
|
|
8850
9210
|
PricingGroupID?: string;
|
|
8851
9211
|
Sequence?: number;
|
|
9212
|
+
/**
|
|
9213
|
+
* 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.
|
|
9214
|
+
*/
|
|
9215
|
+
SkipRecalculation?: boolean;
|
|
8852
9216
|
Type: string;
|
|
8853
9217
|
}
|
|
8854
9218
|
export interface CreatePriceListAdjustmentResponse {
|
|
@@ -8945,6 +9309,10 @@ export interface DeletePriceListAdjustment {
|
|
|
8945
9309
|
* Entity type: PriceListAdjustment
|
|
8946
9310
|
*/
|
|
8947
9311
|
ID: string;
|
|
9312
|
+
/**
|
|
9313
|
+
* 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.
|
|
9314
|
+
*/
|
|
9315
|
+
SkipRecalculation?: boolean;
|
|
8948
9316
|
}
|
|
8949
9317
|
/**
|
|
8950
9318
|
* Delete a PriceListManualInputAdjustment
|
|
@@ -9419,6 +9787,10 @@ export interface UpdatePriceListAdjustment {
|
|
|
9419
9787
|
ParentAdjustmentID?: string;
|
|
9420
9788
|
PricingGroupID: string | null | undefined;
|
|
9421
9789
|
Sequence?: number;
|
|
9790
|
+
/**
|
|
9791
|
+
* 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.
|
|
9792
|
+
*/
|
|
9793
|
+
SkipRecalculation?: boolean;
|
|
9422
9794
|
Type: string;
|
|
9423
9795
|
}
|
|
9424
9796
|
/**
|
|
@@ -10789,7 +11161,6 @@ export interface CreateShippingCost {
|
|
|
10789
11161
|
* Entity type: ShippingMethod
|
|
10790
11162
|
*/
|
|
10791
11163
|
ShippingMethodID?: string;
|
|
10792
|
-
UnitPriceInTax?: number;
|
|
10793
11164
|
ZipCodes?: string[];
|
|
10794
11165
|
}
|
|
10795
11166
|
export interface CreateShippingCostResponse {
|
|
@@ -10841,16 +11212,23 @@ export interface CreateShippingMethodTransportationTime {
|
|
|
10841
11212
|
* Creates a new ShippingRestriction.
|
|
10842
11213
|
*/
|
|
10843
11214
|
export interface CreateShippingRestriction {
|
|
11215
|
+
/**
|
|
11216
|
+
* When set to `true`, the script will be leading for the entire order. Default is `true`
|
|
11217
|
+
*/
|
|
11218
|
+
CheckScriptOnly?: boolean;
|
|
10844
11219
|
/**
|
|
10845
11220
|
* Entity type: Country
|
|
11221
|
+
* Required when there is no ScriptID set or CheckScriptOnly is 'false'
|
|
10846
11222
|
*/
|
|
10847
|
-
CountryID
|
|
11223
|
+
CountryID?: string;
|
|
10848
11224
|
/**
|
|
10849
11225
|
* Entity type: OrganizationUnit
|
|
11226
|
+
* Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
|
|
10850
11227
|
*/
|
|
10851
11228
|
OrganizationUnitID?: string;
|
|
10852
11229
|
/**
|
|
10853
11230
|
* Entity type: OrganizationUnitSet
|
|
11231
|
+
* Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
|
|
10854
11232
|
*/
|
|
10855
11233
|
OrganizationUnitSetID?: string;
|
|
10856
11234
|
/**
|
|
@@ -11016,7 +11394,6 @@ export interface GetShippingCostByIDResponse {
|
|
|
11016
11394
|
OrganizationUnitName?: string;
|
|
11017
11395
|
ShippingMethodID?: string;
|
|
11018
11396
|
ShippingMethodName?: string;
|
|
11019
|
-
UnitPriceInTax: number;
|
|
11020
11397
|
ZipCodes?: string[];
|
|
11021
11398
|
}
|
|
11022
11399
|
/**
|
|
@@ -11061,6 +11438,7 @@ export interface GetShippingRestrictionByID {
|
|
|
11061
11438
|
ID: string;
|
|
11062
11439
|
}
|
|
11063
11440
|
export interface GetShippingRestrictionByIDResponse {
|
|
11441
|
+
CheckScriptOnly: boolean;
|
|
11064
11442
|
CountryID?: string;
|
|
11065
11443
|
CountryName?: string;
|
|
11066
11444
|
Error?: ServiceError;
|
|
@@ -11069,7 +11447,7 @@ export interface GetShippingRestrictionByIDResponse {
|
|
|
11069
11447
|
OrganizationUnitID?: string;
|
|
11070
11448
|
OrganizationUnitName?: string;
|
|
11071
11449
|
OrganizationUnitSetDescription?: string;
|
|
11072
|
-
OrganizationUnitSetID
|
|
11450
|
+
OrganizationUnitSetID?: string;
|
|
11073
11451
|
OrganizationUnitSetName?: string;
|
|
11074
11452
|
OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
|
|
11075
11453
|
ProductPropertyTypeID?: string;
|
|
@@ -11243,7 +11621,6 @@ export interface ShippingShippingCostDto {
|
|
|
11243
11621
|
OrganizationUnitName?: string;
|
|
11244
11622
|
ShippingMethodID?: string;
|
|
11245
11623
|
ShippingMethodName?: string;
|
|
11246
|
-
UnitPriceInTax: number;
|
|
11247
11624
|
ZipCodes?: string[];
|
|
11248
11625
|
}
|
|
11249
11626
|
export interface ShippingShippingRestrictionDto {
|
|
@@ -11265,9 +11642,9 @@ export interface ShippingShippingRestrictionDto {
|
|
|
11265
11642
|
/**
|
|
11266
11643
|
* Entity type: OrganizationUnitSet
|
|
11267
11644
|
*/
|
|
11268
|
-
OrganizationUnitSetID
|
|
11645
|
+
OrganizationUnitSetID?: string;
|
|
11269
11646
|
OrganizationUnitSetName?: string;
|
|
11270
|
-
OrganizationUnitSetType
|
|
11647
|
+
OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
|
|
11271
11648
|
/**
|
|
11272
11649
|
* Entity type: ProductPropertyType
|
|
11273
11650
|
*/
|
|
@@ -11362,7 +11739,6 @@ export interface UpdateShippingCost {
|
|
|
11362
11739
|
* Entity type: ShippingMethod
|
|
11363
11740
|
*/
|
|
11364
11741
|
ShippingMethodID?: string;
|
|
11365
|
-
UnitPriceInTax?: number;
|
|
11366
11742
|
ZipCodes?: string[];
|
|
11367
11743
|
}
|
|
11368
11744
|
/**
|
|
@@ -11419,6 +11795,10 @@ export interface UpdateShippingMethodTransportationTime {
|
|
|
11419
11795
|
* Updates a ShippingRestriction.
|
|
11420
11796
|
*/
|
|
11421
11797
|
export interface UpdateShippingRestriction {
|
|
11798
|
+
/**
|
|
11799
|
+
* When set to `true`, the script will be leading for the entire order.
|
|
11800
|
+
*/
|
|
11801
|
+
CheckScriptOnly?: boolean;
|
|
11422
11802
|
/**
|
|
11423
11803
|
* Entity type: Country
|
|
11424
11804
|
*/
|
|
@@ -11507,6 +11887,7 @@ export interface CreateStockAllocationRule {
|
|
|
11507
11887
|
*/
|
|
11508
11888
|
export interface CreateStockLabel {
|
|
11509
11889
|
Description?: string;
|
|
11890
|
+
DisplayName?: string;
|
|
11510
11891
|
LedgerClassID?: string;
|
|
11511
11892
|
Name: string;
|
|
11512
11893
|
}
|
|
@@ -11592,12 +11973,13 @@ export interface UpdateStockAllocationRule {
|
|
|
11592
11973
|
* Update the description or ledgerclass of StockLabel
|
|
11593
11974
|
*/
|
|
11594
11975
|
export interface UpdateStockLabel {
|
|
11595
|
-
Description
|
|
11976
|
+
Description: string | null | undefined;
|
|
11977
|
+
DisplayName: string | null | undefined;
|
|
11596
11978
|
/**
|
|
11597
11979
|
* Entity type: StockLabel
|
|
11598
11980
|
*/
|
|
11599
11981
|
ID: string;
|
|
11600
|
-
LedgerClassID
|
|
11982
|
+
LedgerClassID: string | null | undefined;
|
|
11601
11983
|
}
|
|
11602
11984
|
/**
|
|
11603
11985
|
* A service to upload an Excel containing StockAllocationRules that should be created or updated according to the values specified in the sheet.
|
|
@@ -11872,6 +12254,7 @@ export interface CreateUserOriginResponse {
|
|
|
11872
12254
|
* Creates a new UserRequirement and returns the ID of the new record.
|
|
11873
12255
|
*/
|
|
11874
12256
|
export interface CreateUserRequirement {
|
|
12257
|
+
AccountType?: DataModelsUserAccountType;
|
|
11875
12258
|
CustomValidators?: Record<string, TAnyValue | null>;
|
|
11876
12259
|
Display?: boolean;
|
|
11877
12260
|
Preferred?: boolean;
|
|
@@ -12307,6 +12690,7 @@ export interface GetUserRequirement {
|
|
|
12307
12690
|
ID: string;
|
|
12308
12691
|
}
|
|
12309
12692
|
export interface GetUserRequirementResponse {
|
|
12693
|
+
AccountType?: DataModelsUserAccountType;
|
|
12310
12694
|
CustomValidators?: Record<string, TAnyValue | null>;
|
|
12311
12695
|
Display: boolean;
|
|
12312
12696
|
Error?: ServiceError;
|
|
@@ -12530,6 +12914,7 @@ export interface ListUserRequirementsResponse {
|
|
|
12530
12914
|
Result?: PagedResult<UsersListUserRequirementsResponse_UserRequirementDto>;
|
|
12531
12915
|
}
|
|
12532
12916
|
export interface UsersListUserRequirementsResponse_UserRequirementDto {
|
|
12917
|
+
AccountType?: DataModelsUserAccountType;
|
|
12533
12918
|
CustomValidators?: Record<string, TAnyValue | null>;
|
|
12534
12919
|
Display: boolean;
|
|
12535
12920
|
/**
|
|
@@ -12658,6 +13043,7 @@ export interface UpdateSubscriptionUserRequirements {
|
|
|
12658
13043
|
Requirements: UsersUpdateSubscriptionUserRequirements_UserRequirementDto[];
|
|
12659
13044
|
}
|
|
12660
13045
|
export interface UsersUpdateSubscriptionUserRequirements_UserRequirementDto {
|
|
13046
|
+
AccountType: DataModelsUserAccountType | undefined;
|
|
12661
13047
|
CustomValidators: Record<string, TAnyValue | null> | null | undefined;
|
|
12662
13048
|
Display?: boolean;
|
|
12663
13049
|
/**
|
|
@@ -12688,6 +13074,7 @@ export interface UpdateUserOrigin {
|
|
|
12688
13074
|
* Updates an existing UserRequirement.
|
|
12689
13075
|
*/
|
|
12690
13076
|
export interface UpdateUserRequirement {
|
|
13077
|
+
AccountType: DataModelsUserAccountType | undefined;
|
|
12691
13078
|
CustomValidators: Record<string, TAnyValue | null> | null | undefined;
|
|
12692
13079
|
Display?: boolean;
|
|
12693
13080
|
/**
|
|
@@ -12732,6 +13119,7 @@ export interface UpdateUserRequirementSetRequirements {
|
|
|
12732
13119
|
Requirements?: UsersUpdateUserRequirementSetRequirements_UserRequirementDto[];
|
|
12733
13120
|
}
|
|
12734
13121
|
export interface UsersUpdateUserRequirementSetRequirements_UserRequirementDto {
|
|
13122
|
+
AccountType: DataModelsUserAccountType | undefined;
|
|
12735
13123
|
CustomValidators: Record<string, TAnyValue | null> | null | undefined;
|
|
12736
13124
|
Display?: boolean;
|
|
12737
13125
|
/**
|
|
@@ -13689,7 +14077,7 @@ export interface EVACoreServicesUsersListUserBoughtProductsResponse_BoughtProduc
|
|
|
13689
14077
|
WarrantyExpiryDate?: string;
|
|
13690
14078
|
}
|
|
13691
14079
|
/**
|
|
13692
|
-
* Push bought products for users. Only accepts
|
|
14080
|
+
* Push bought products for users. Only accepts 10000 users per request
|
|
13693
14081
|
*/
|
|
13694
14082
|
export interface EVACoreServicesUsersPushBoughtProductsForUsers {
|
|
13695
14083
|
BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
|
|
@@ -13703,16 +14091,34 @@ export interface EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProd
|
|
|
13703
14091
|
}
|
|
13704
14092
|
export interface PushBoughtProductsForUsersResponse {
|
|
13705
14093
|
Error?: ServiceError;
|
|
13706
|
-
FailedBoughtProductsForUsers?:
|
|
14094
|
+
FailedBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser[];
|
|
13707
14095
|
Metadata?: ResponseMessageMetadata;
|
|
14096
|
+
SuccessfulBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser[];
|
|
13708
14097
|
}
|
|
13709
|
-
export interface
|
|
14098
|
+
export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct {
|
|
14099
|
+
ProductBackendID?: string;
|
|
13710
14100
|
/**
|
|
13711
14101
|
* Entity type: Product
|
|
13712
14102
|
*/
|
|
13713
14103
|
ProductID: string;
|
|
13714
14104
|
SerialNumber?: string;
|
|
13715
14105
|
}
|
|
14106
|
+
export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser {
|
|
14107
|
+
BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
|
|
14108
|
+
UserBackendID?: string;
|
|
14109
|
+
/**
|
|
14110
|
+
* Entity type: User
|
|
14111
|
+
*/
|
|
14112
|
+
UserID: string;
|
|
14113
|
+
}
|
|
14114
|
+
export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser {
|
|
14115
|
+
BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
|
|
14116
|
+
UserBackendID?: string;
|
|
14117
|
+
/**
|
|
14118
|
+
* Entity type: User
|
|
14119
|
+
*/
|
|
14120
|
+
UserID: string;
|
|
14121
|
+
}
|
|
13716
14122
|
export interface PushBoughtProductsForUsers_Async {
|
|
13717
14123
|
BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
|
|
13718
14124
|
}
|