@springtree/eva-services-core-management 3.0.0-beta.1 → 3.0.0-beta.11
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 +514 -72
- 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 +87 -21
- package/lib/eva-services-core-management.services.d.ts.map +1 -1
- package/lib/eva-services-core-management.services.js +87 -21
- 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;
|
|
@@ -2940,6 +2961,24 @@ export interface GenerateDiscountCoupons {
|
|
|
2940
2961
|
Quantity?: number;
|
|
2941
2962
|
Suffix?: string;
|
|
2942
2963
|
}
|
|
2964
|
+
export interface GenerateDiscountCoupons_Async {
|
|
2965
|
+
/**
|
|
2966
|
+
* Entity type: Discount
|
|
2967
|
+
*/
|
|
2968
|
+
DiscountID: string;
|
|
2969
|
+
MaximumUsage?: number;
|
|
2970
|
+
Prefix?: string;
|
|
2971
|
+
Quantity?: number;
|
|
2972
|
+
Suffix?: string;
|
|
2973
|
+
}
|
|
2974
|
+
export interface GenerateDiscountCoupons_AsyncResponse {
|
|
2975
|
+
Error?: ServiceError;
|
|
2976
|
+
JobID?: string;
|
|
2977
|
+
Metadata?: ResponseMessageMetadata;
|
|
2978
|
+
}
|
|
2979
|
+
export interface GenerateDiscountCoupons_AsyncResult {
|
|
2980
|
+
JobID?: string;
|
|
2981
|
+
}
|
|
2943
2982
|
/**
|
|
2944
2983
|
* Get a coupon by it's token. When a customer calls this service, the service will only resolve tokens from coupons on which the user is registered. Employees and API's can resolve all coupon tokens.
|
|
2945
2984
|
*/
|
|
@@ -2985,6 +3024,7 @@ export interface GetDiscountByIDResponse {
|
|
|
2985
3024
|
* Entity type: DiscountCampaign
|
|
2986
3025
|
*/
|
|
2987
3026
|
CampaignID?: string;
|
|
3027
|
+
CannotApplyToOwnOrder: boolean;
|
|
2988
3028
|
CompliancyRule: DataModelsDiscountCompliancyRule;
|
|
2989
3029
|
ConditionType: DataModelsDiscountConditionTypes;
|
|
2990
3030
|
Conditions?: DiscountsGetDiscountByIDResponse_DiscountCondition[];
|
|
@@ -3049,6 +3089,7 @@ export interface GetDiscountByIDResponse {
|
|
|
3049
3089
|
OrganizationUnitSetName?: string;
|
|
3050
3090
|
OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
|
|
3051
3091
|
PromotionLabel?: string;
|
|
3092
|
+
RequiredCustomFields?: string[];
|
|
3052
3093
|
/**
|
|
3053
3094
|
* Entity type: OrganizationUnit
|
|
3054
3095
|
*/
|
|
@@ -3539,6 +3580,55 @@ export interface MoveDiscountLayer {
|
|
|
3539
3580
|
ID: string;
|
|
3540
3581
|
}
|
|
3541
3582
|
/**
|
|
3583
|
+
* Push a DiscountCoupon
|
|
3584
|
+
*/
|
|
3585
|
+
export interface PushDiscountCoupons {
|
|
3586
|
+
Coupons?: DiscountsPushDiscountCoupons_PushedCoupon[];
|
|
3587
|
+
/**
|
|
3588
|
+
* Entity type: Discount
|
|
3589
|
+
*/
|
|
3590
|
+
DiscountID?: string;
|
|
3591
|
+
}
|
|
3592
|
+
export interface DiscountsPushDiscountCoupons_PushedCoupon {
|
|
3593
|
+
CouponCode?: string;
|
|
3594
|
+
IsActive?: boolean;
|
|
3595
|
+
MaximumUsage?: number;
|
|
3596
|
+
/**
|
|
3597
|
+
* Entity type: Order
|
|
3598
|
+
*/
|
|
3599
|
+
OrderID?: string;
|
|
3600
|
+
/**
|
|
3601
|
+
* Entity type: User
|
|
3602
|
+
*/
|
|
3603
|
+
UserID?: string;
|
|
3604
|
+
}
|
|
3605
|
+
export interface PushDiscountCouponsResponse {
|
|
3606
|
+
CreatedCoupons?: DiscountsPushDiscountCouponsResponse_CreatedCoupon[];
|
|
3607
|
+
Error?: ServiceError;
|
|
3608
|
+
Metadata?: ResponseMessageMetadata;
|
|
3609
|
+
}
|
|
3610
|
+
export interface DiscountsPushDiscountCouponsResponse_CreatedCoupon {
|
|
3611
|
+
/**
|
|
3612
|
+
* Entity type: DiscountCoupon
|
|
3613
|
+
*/
|
|
3614
|
+
ID: string;
|
|
3615
|
+
IsDuplicateCoupon: boolean;
|
|
3616
|
+
}
|
|
3617
|
+
/**
|
|
3618
|
+
* Remove required custom fields from ManualDiscount
|
|
3619
|
+
*/
|
|
3620
|
+
export interface RemoveRequiredCustomFieldsFromManualDiscount {
|
|
3621
|
+
/**
|
|
3622
|
+
* Entity type: CustomField
|
|
3623
|
+
*/
|
|
3624
|
+
CustomFieldIDs?: string[];
|
|
3625
|
+
/**
|
|
3626
|
+
* Entity type: Discount
|
|
3627
|
+
*/
|
|
3628
|
+
DiscountID: string;
|
|
3629
|
+
RemoveAllRequiredCustomFields?: boolean;
|
|
3630
|
+
}
|
|
3631
|
+
/**
|
|
3542
3632
|
* Remove security roles from ManualDiscount
|
|
3543
3633
|
*/
|
|
3544
3634
|
export interface RemoveRolesFromManualDiscount {
|
|
@@ -3623,6 +3713,15 @@ export interface DiscountsSearchDiscountsByQueryResponse_DiscountDto {
|
|
|
3623
3713
|
UserUsageReloadStrategy?: string;
|
|
3624
3714
|
}
|
|
3625
3715
|
/**
|
|
3716
|
+
* Takes in all discount layers and sets their sequences. All layers except the system layer are required.
|
|
3717
|
+
*/
|
|
3718
|
+
export interface SetDiscountLayerSequences {
|
|
3719
|
+
/**
|
|
3720
|
+
* Entity type: DiscountLayer
|
|
3721
|
+
*/
|
|
3722
|
+
Layers: string[];
|
|
3723
|
+
}
|
|
3724
|
+
/**
|
|
3626
3725
|
* Update an existing discount
|
|
3627
3726
|
*/
|
|
3628
3727
|
export interface UpdateDiscount {
|
|
@@ -3689,6 +3788,10 @@ export interface UpdateDiscount {
|
|
|
3689
3788
|
OrganizationUnitSetID: string;
|
|
3690
3789
|
PromotionLabel?: string;
|
|
3691
3790
|
/**
|
|
3791
|
+
* For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
|
|
3792
|
+
*/
|
|
3793
|
+
RequiredCustomFields: string[] | null | undefined;
|
|
3794
|
+
/**
|
|
3692
3795
|
* Entity type: OrganizationUnit
|
|
3693
3796
|
*/
|
|
3694
3797
|
RestitutionOrganizationUnitID?: string;
|
|
@@ -3918,6 +4021,10 @@ export interface ValidateDiscount {
|
|
|
3918
4021
|
*/
|
|
3919
4022
|
OrganizationUnitSetID: string;
|
|
3920
4023
|
/**
|
|
4024
|
+
* For a manual discount, these will indicate custom fields that need to be filled in order to apply the discount.
|
|
4025
|
+
*/
|
|
4026
|
+
RequiredCustomFields?: string[];
|
|
4027
|
+
/**
|
|
3921
4028
|
* Entity type: OrganizationUnit
|
|
3922
4029
|
*/
|
|
3923
4030
|
RestitutionOrganizationUnitID?: string;
|
|
@@ -4474,6 +4581,10 @@ export interface GiftCardsListGiftCardConfigurationsResponse_GiftCardConfigurati
|
|
|
4474
4581
|
* `ProductGiftCard`: an item that describes the giftcard properties of a product with type GiftCard
|
|
4475
4582
|
*/
|
|
4476
4583
|
export interface ListProductGiftCards {
|
|
4584
|
+
/**
|
|
4585
|
+
* Entity type: ProductPropertyType
|
|
4586
|
+
*/
|
|
4587
|
+
IncludedProductProperties?: string[];
|
|
4477
4588
|
PageConfig?: PageConfig<GiftCardsListProductGiftCardsFilter>;
|
|
4478
4589
|
}
|
|
4479
4590
|
export interface ListProductGiftCardsResponse {
|
|
@@ -4496,6 +4607,7 @@ export interface GiftCardsListProductGiftCardsResponse_ProductGiftCardDto {
|
|
|
4496
4607
|
*/
|
|
4497
4608
|
ID: string;
|
|
4498
4609
|
IsDigital: boolean;
|
|
4610
|
+
Product?: SearchIProductSearchItem;
|
|
4499
4611
|
/**
|
|
4500
4612
|
* Entity type: Product
|
|
4501
4613
|
*/
|
|
@@ -5018,26 +5130,26 @@ export interface AddLoyaltyProgramPriceList {
|
|
|
5018
5130
|
PriceListID: string;
|
|
5019
5131
|
}
|
|
5020
5132
|
/**
|
|
5021
|
-
*
|
|
5133
|
+
* Add a custom field requirement to the loyalty program. NOTE THAT a custom field can only be set once as a requirement.
|
|
5022
5134
|
*/
|
|
5023
|
-
export interface
|
|
5135
|
+
export interface AddLoyaltyProgramRequiredCustomField {
|
|
5024
5136
|
/**
|
|
5025
|
-
* Entity type:
|
|
5137
|
+
* Entity type: CustomField
|
|
5026
5138
|
*/
|
|
5027
|
-
|
|
5139
|
+
CustomFieldID: string;
|
|
5140
|
+
/**
|
|
5141
|
+
* Entity type: LoyaltyProgram
|
|
5142
|
+
*/
|
|
5143
|
+
LoyaltyProgramID: string;
|
|
5028
5144
|
}
|
|
5029
5145
|
/**
|
|
5030
|
-
*
|
|
5146
|
+
* Archive a point awarding rule
|
|
5031
5147
|
*/
|
|
5032
|
-
export interface
|
|
5033
|
-
/**
|
|
5034
|
-
* Entity type: LoyaltyProgramPaymentType
|
|
5035
|
-
*/
|
|
5036
|
-
LoyaltyProgramPaymentTypeID: string;
|
|
5148
|
+
export interface ArchivePointAwardingRule {
|
|
5037
5149
|
/**
|
|
5038
|
-
* Entity type:
|
|
5150
|
+
* Entity type: PointAwardingRule
|
|
5039
5151
|
*/
|
|
5040
|
-
|
|
5152
|
+
ID: string;
|
|
5041
5153
|
}
|
|
5042
5154
|
/**
|
|
5043
5155
|
* Attach a loyalty program to an order
|
|
@@ -5055,6 +5167,9 @@ export interface AttachLoyaltyProgramToOrder {
|
|
|
5055
5167
|
* Entity type: User
|
|
5056
5168
|
*/
|
|
5057
5169
|
UserID?: string;
|
|
5170
|
+
/**
|
|
5171
|
+
* When set, the UserID will also become required so we can verify the UserIdentifier.
|
|
5172
|
+
*/
|
|
5058
5173
|
UserIdentifier?: string;
|
|
5059
5174
|
}
|
|
5060
5175
|
/**
|
|
@@ -5212,6 +5327,7 @@ export interface CreateLoyaltyProgramPaymentType {
|
|
|
5212
5327
|
* Entity type: PaymentType
|
|
5213
5328
|
*/
|
|
5214
5329
|
PaymentTypeID: string;
|
|
5330
|
+
ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
|
|
5215
5331
|
Required?: boolean;
|
|
5216
5332
|
Sequence?: number;
|
|
5217
5333
|
TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
@@ -5255,6 +5371,10 @@ export interface CreateLoyaltyProgramResponse {
|
|
|
5255
5371
|
*/
|
|
5256
5372
|
ID: string;
|
|
5257
5373
|
Metadata?: ResponseMessageMetadata;
|
|
5374
|
+
/**
|
|
5375
|
+
* Entity type: Subscription
|
|
5376
|
+
*/
|
|
5377
|
+
SubscriptionID: string;
|
|
5258
5378
|
}
|
|
5259
5379
|
/**
|
|
5260
5380
|
* Create a point awarding rule.
|
|
@@ -5373,19 +5493,6 @@ export interface DetachLoyaltyProgramFromOrder {
|
|
|
5373
5493
|
OrderID: string;
|
|
5374
5494
|
}
|
|
5375
5495
|
/**
|
|
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
5496
|
* Disable a point awarding rule
|
|
5390
5497
|
*/
|
|
5391
5498
|
export interface DisablePointAwardingRule {
|
|
@@ -5522,6 +5629,7 @@ export interface GetLoyaltyProgramPaymentTypeResponse {
|
|
|
5522
5629
|
*/
|
|
5523
5630
|
PaymentTypeID: string;
|
|
5524
5631
|
PaymentTypeName?: string;
|
|
5632
|
+
ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
|
|
5525
5633
|
Required: boolean;
|
|
5526
5634
|
Sequence: number;
|
|
5527
5635
|
TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
@@ -5637,6 +5745,34 @@ export interface GetLoyaltyProgramResponse {
|
|
|
5637
5745
|
UserMaximumUsage?: number;
|
|
5638
5746
|
}
|
|
5639
5747
|
/**
|
|
5748
|
+
* Get the available loyalty program payment methods for the given order.
|
|
5749
|
+
*/
|
|
5750
|
+
export interface GetOrderLoyaltyProgramPaymentTypes {
|
|
5751
|
+
/**
|
|
5752
|
+
* Entity type: Order
|
|
5753
|
+
*/
|
|
5754
|
+
OrderID: string;
|
|
5755
|
+
}
|
|
5756
|
+
export interface GetOrderLoyaltyProgramPaymentTypesResponse {
|
|
5757
|
+
Error?: ServiceError;
|
|
5758
|
+
Metadata?: ResponseMessageMetadata;
|
|
5759
|
+
Options?: LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option[];
|
|
5760
|
+
}
|
|
5761
|
+
export interface LoyaltyGetOrderLoyaltyProgramPaymentTypesResponse_Option {
|
|
5762
|
+
BackendID?: string;
|
|
5763
|
+
/**
|
|
5764
|
+
* Entity type: LoyaltyProgramPaymentType
|
|
5765
|
+
*/
|
|
5766
|
+
ID: string;
|
|
5767
|
+
/**
|
|
5768
|
+
* Entity type: PaymentType
|
|
5769
|
+
*/
|
|
5770
|
+
PaymentTypeID: string;
|
|
5771
|
+
PaymentTypeName?: string;
|
|
5772
|
+
Required: boolean;
|
|
5773
|
+
Sequence: number;
|
|
5774
|
+
}
|
|
5775
|
+
/**
|
|
5640
5776
|
* Get loyalty point rule.
|
|
5641
5777
|
*/
|
|
5642
5778
|
export interface GetPointAwardingRule {
|
|
@@ -5853,10 +5989,50 @@ export interface LoyaltyListLoyaltyProgramProductLimitationsResponse_Item {
|
|
|
5853
5989
|
*/
|
|
5854
5990
|
ID: string;
|
|
5855
5991
|
Name?: string;
|
|
5992
|
+
/**
|
|
5993
|
+
* The quantity limit over the entire product limitation product set per order.
|
|
5994
|
+
*/
|
|
5995
|
+
OverallQuantityLimitPerOrder?: number;
|
|
5996
|
+
/**
|
|
5997
|
+
* The quantity limit over the entire product limitation product set per user.
|
|
5998
|
+
*/
|
|
5999
|
+
OverallQuantityLimitPerUser?: number;
|
|
6000
|
+
/**
|
|
6001
|
+
* The quantity limit per product within the product limitation product set per order.
|
|
6002
|
+
*/
|
|
5856
6003
|
QuantityLimitPerOrder?: number;
|
|
6004
|
+
/**
|
|
6005
|
+
* The quantity limit per product within the product limitation product set per user.
|
|
6006
|
+
*/
|
|
5857
6007
|
QuantityLimitPerUser?: number;
|
|
5858
6008
|
}
|
|
5859
6009
|
/**
|
|
6010
|
+
* List the loyalty program CustomFieldRequirements
|
|
6011
|
+
*/
|
|
6012
|
+
export interface ListLoyaltyProgramRequiredCustomFields {
|
|
6013
|
+
InitialPageConfig?: PageTokenConfig<Record<string, string | null> | null>;
|
|
6014
|
+
/**
|
|
6015
|
+
* Entity type: LoyaltyProgram
|
|
6016
|
+
*/
|
|
6017
|
+
LoyaltyProgramID: string;
|
|
6018
|
+
PageToken?: string;
|
|
6019
|
+
}
|
|
6020
|
+
export interface ListLoyaltyProgramRequiredCustomFieldsResponse {
|
|
6021
|
+
Error?: ServiceError;
|
|
6022
|
+
Metadata?: ResponseMessageMetadata;
|
|
6023
|
+
NextPageToken?: string;
|
|
6024
|
+
PreviousPageToken?: string;
|
|
6025
|
+
Results?: LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField[];
|
|
6026
|
+
}
|
|
6027
|
+
export interface LoyaltyListLoyaltyProgramRequiredCustomFieldsResponse_CustomField {
|
|
6028
|
+
BackendID?: string;
|
|
6029
|
+
/**
|
|
6030
|
+
* Entity type: CustomField
|
|
6031
|
+
*/
|
|
6032
|
+
ID: string;
|
|
6033
|
+
Name?: string;
|
|
6034
|
+
}
|
|
6035
|
+
/**
|
|
5860
6036
|
* List the LoyaltyPrograms
|
|
5861
6037
|
*/
|
|
5862
6038
|
export interface ListLoyaltyPrograms {
|
|
@@ -5926,6 +6102,14 @@ export interface LoyaltyListPointAwardingRulesResponse_Rule {
|
|
|
5926
6102
|
export interface LoyaltyLoyaltyProgramProductLimitationData {
|
|
5927
6103
|
Filters?: Record<string, SearchFilterModel>;
|
|
5928
6104
|
/**
|
|
6105
|
+
* The quantity limit over the entire product limitation product set per order.
|
|
6106
|
+
*/
|
|
6107
|
+
OverallQuantityLimitPerOrder?: number;
|
|
6108
|
+
/**
|
|
6109
|
+
* The quantity limit over the entire product limitation product set per user.
|
|
6110
|
+
*/
|
|
6111
|
+
OverallQuantityLimitPerUser?: number;
|
|
6112
|
+
/**
|
|
5929
6113
|
* Entity type: Product
|
|
5930
6114
|
*/
|
|
5931
6115
|
ProductIDs?: string[];
|
|
@@ -5933,17 +6117,25 @@ export interface LoyaltyLoyaltyProgramProductLimitationData {
|
|
|
5933
6117
|
* Entity type: ProductSearchTemplate
|
|
5934
6118
|
*/
|
|
5935
6119
|
ProductSearchID?: string;
|
|
6120
|
+
/**
|
|
6121
|
+
* The quantity limit per product within the product limitation product set per order.
|
|
6122
|
+
*/
|
|
5936
6123
|
QuantityLimitPerOrder?: number;
|
|
6124
|
+
/**
|
|
6125
|
+
* The quantity limit per product within the product limitation product set per user.
|
|
6126
|
+
*/
|
|
5937
6127
|
QuantityLimitPerUser?: number;
|
|
5938
6128
|
}
|
|
5939
6129
|
/**
|
|
5940
6130
|
* Push a LoyaltyProgram.
|
|
6131
|
+
* If it doesn't exist it will be created, otherwise is will be updated.
|
|
6132
|
+
* Sub entities will also be created or updated, but will not be removed.
|
|
5941
6133
|
*/
|
|
5942
|
-
export interface
|
|
6134
|
+
export interface LoyaltyPushLoyaltyProgram {
|
|
5943
6135
|
/**
|
|
5944
6136
|
* Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
|
|
5945
6137
|
*/
|
|
5946
|
-
AllowUnsubscribeBy
|
|
6138
|
+
AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType;
|
|
5947
6139
|
/**
|
|
5948
6140
|
* When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
|
|
5949
6141
|
* When false, the loyalty program will automatically be applied if all conditions are met.
|
|
@@ -5971,7 +6163,7 @@ export interface PushLoyaltyProgram {
|
|
|
5971
6163
|
* Entity type: LoyaltyProgram
|
|
5972
6164
|
*/
|
|
5973
6165
|
ID: string;
|
|
5974
|
-
LoyaltyPointUsageOptions
|
|
6166
|
+
LoyaltyPointUsageOptions: DataModelsLoyaltyPointUsageOptions;
|
|
5975
6167
|
/**
|
|
5976
6168
|
* Entity type: LoyaltyProgramGroup
|
|
5977
6169
|
*/
|
|
@@ -5981,12 +6173,12 @@ export interface PushLoyaltyProgram {
|
|
|
5981
6173
|
OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
|
|
5982
6174
|
PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
|
|
5983
6175
|
PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
|
|
5984
|
-
PointExpirationPolicyData?: TAnyValue
|
|
6176
|
+
PointExpirationPolicyData?: Record<string, TAnyValue>;
|
|
5985
6177
|
PointExpirationPolicyType?: string;
|
|
5986
|
-
PointPendingPolicyData?: TAnyValue
|
|
6178
|
+
PointPendingPolicyData?: Record<string, TAnyValue>;
|
|
5987
6179
|
PointPendingPolicyType?: string;
|
|
5988
6180
|
/**
|
|
5989
|
-
* Entity type:
|
|
6181
|
+
* Entity type: PriceList
|
|
5990
6182
|
*/
|
|
5991
6183
|
PriceLists?: string[];
|
|
5992
6184
|
ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
|
|
@@ -6005,6 +6197,7 @@ export interface PushLoyaltyProgram {
|
|
|
6005
6197
|
* 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
6198
|
*/
|
|
6007
6199
|
RequireManualUserIdentifier?: boolean;
|
|
6200
|
+
RequiredCustomFields?: string[];
|
|
6008
6201
|
/**
|
|
6009
6202
|
* 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
6203
|
* Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
|
|
@@ -6022,7 +6215,7 @@ export interface PushLoyaltyProgram {
|
|
|
6022
6215
|
/**
|
|
6023
6216
|
* Handling when a user is unsubscribed and re-subscribes.
|
|
6024
6217
|
*/
|
|
6025
|
-
ResubscribeHandling
|
|
6218
|
+
ResubscribeHandling: DataModelsResubscribeHandlingType;
|
|
6026
6219
|
StartDate?: string;
|
|
6027
6220
|
Status: DataModelsLoyaltyProgramStatus;
|
|
6028
6221
|
UserBudget?: number;
|
|
@@ -6047,7 +6240,7 @@ export interface PushLoyaltyProgram {
|
|
|
6047
6240
|
UserMaximumUsage?: number;
|
|
6048
6241
|
}
|
|
6049
6242
|
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition {
|
|
6050
|
-
Data: TAnyValue
|
|
6243
|
+
Data: Record<string, TAnyValue>;
|
|
6051
6244
|
/**
|
|
6052
6245
|
* Entity type: LoyaltyProgramCondition
|
|
6053
6246
|
*/
|
|
@@ -6073,7 +6266,7 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
|
|
|
6073
6266
|
* Entity type: PaymentType
|
|
6074
6267
|
*/
|
|
6075
6268
|
PaymentTypeID: string;
|
|
6076
|
-
ProductLimitation?:
|
|
6269
|
+
ProductLimitation?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData;
|
|
6077
6270
|
Required?: boolean;
|
|
6078
6271
|
Sequence?: number;
|
|
6079
6272
|
TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
@@ -6081,10 +6274,40 @@ export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType {
|
|
|
6081
6274
|
UserBudgetDeduction: DataModelsUserBudgetDeduction;
|
|
6082
6275
|
UserMaximumUsage?: number;
|
|
6083
6276
|
}
|
|
6277
|
+
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType_ProductLimitationData {
|
|
6278
|
+
Filters?: Record<string, SearchFilterModel>;
|
|
6279
|
+
/**
|
|
6280
|
+
* The quantity limit over the entire product limitation product set per order.
|
|
6281
|
+
*/
|
|
6282
|
+
OverallQuantityLimitPerOrder?: number;
|
|
6283
|
+
/**
|
|
6284
|
+
* The quantity limit over the entire product limitation product set per user.
|
|
6285
|
+
*/
|
|
6286
|
+
OverallQuantityLimitPerUser?: number;
|
|
6287
|
+
/**
|
|
6288
|
+
* Entity type: Product
|
|
6289
|
+
*/
|
|
6290
|
+
ProductIDs?: string[];
|
|
6291
|
+
/**
|
|
6292
|
+
* Entity type: ProductSearchTemplate
|
|
6293
|
+
*/
|
|
6294
|
+
ProductSearchID?: string;
|
|
6295
|
+
/**
|
|
6296
|
+
* The quantity limit per product within the product limitation product set per order.
|
|
6297
|
+
*/
|
|
6298
|
+
QuantityLimitPerOrder?: number;
|
|
6299
|
+
/**
|
|
6300
|
+
* The quantity limit per product within the product limitation product set per user.
|
|
6301
|
+
*/
|
|
6302
|
+
QuantityLimitPerUser?: number;
|
|
6303
|
+
}
|
|
6084
6304
|
export interface LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation {
|
|
6305
|
+
ApplyToPriceList?: boolean;
|
|
6085
6306
|
Filters?: Record<string, SearchFilterModel>;
|
|
6086
6307
|
ID: string;
|
|
6087
6308
|
Name: string;
|
|
6309
|
+
OverallQuantityLimitPerOrder?: number;
|
|
6310
|
+
OverallQuantityLimitPerUser?: number;
|
|
6088
6311
|
/**
|
|
6089
6312
|
* Entity type: Product
|
|
6090
6313
|
*/
|
|
@@ -6118,9 +6341,42 @@ export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRule {
|
|
|
6118
6341
|
}
|
|
6119
6342
|
export interface LoyaltyPushLoyaltyProgram_PushPointAwardingRuleCondition {
|
|
6120
6343
|
Data?: LoyaltyRulesIPointAwardingConditionData;
|
|
6121
|
-
ID
|
|
6344
|
+
ID: string;
|
|
6122
6345
|
Type: 'ORDERAMOUNT' | 'PRODUCT' | 'USERCUSTOMFIELD';
|
|
6123
6346
|
}
|
|
6347
|
+
export interface PushLoyaltyProgramGroupResponse {
|
|
6348
|
+
Error?: ServiceError;
|
|
6349
|
+
/**
|
|
6350
|
+
* Entity type: LoyaltyProgram
|
|
6351
|
+
*/
|
|
6352
|
+
ID: string;
|
|
6353
|
+
Metadata?: ResponseMessageMetadata;
|
|
6354
|
+
}
|
|
6355
|
+
export interface PushLoyaltyProgramGroup_Async {
|
|
6356
|
+
Budget?: number;
|
|
6357
|
+
/**
|
|
6358
|
+
* Entity type: Currency
|
|
6359
|
+
*/
|
|
6360
|
+
BudgetCurrencyID?: string;
|
|
6361
|
+
DeactivateWhenBudgetIsReached?: boolean;
|
|
6362
|
+
EndDate?: string;
|
|
6363
|
+
/**
|
|
6364
|
+
* Entity type: LoyaltyProgramGroup
|
|
6365
|
+
*/
|
|
6366
|
+
ID: string;
|
|
6367
|
+
Name: string;
|
|
6368
|
+
StartDate?: string;
|
|
6369
|
+
Status: DataModelsLoyaltyProgramStatus;
|
|
6370
|
+
TaxExemptionCode?: string;
|
|
6371
|
+
}
|
|
6372
|
+
export interface PushLoyaltyProgramGroup_AsyncResponse {
|
|
6373
|
+
Error?: ServiceError;
|
|
6374
|
+
JobID?: string;
|
|
6375
|
+
Metadata?: ResponseMessageMetadata;
|
|
6376
|
+
}
|
|
6377
|
+
export interface PushLoyaltyProgramGroup_AsyncResult {
|
|
6378
|
+
JobID?: string;
|
|
6379
|
+
}
|
|
6124
6380
|
export interface PushLoyaltyProgramResponse {
|
|
6125
6381
|
Error?: ServiceError;
|
|
6126
6382
|
/**
|
|
@@ -6128,6 +6384,126 @@ export interface PushLoyaltyProgramResponse {
|
|
|
6128
6384
|
*/
|
|
6129
6385
|
ID: string;
|
|
6130
6386
|
Metadata?: ResponseMessageMetadata;
|
|
6387
|
+
/**
|
|
6388
|
+
* Entity type: Subscription
|
|
6389
|
+
*/
|
|
6390
|
+
SubscriptionID: string;
|
|
6391
|
+
}
|
|
6392
|
+
export interface PushLoyaltyProgram_Async {
|
|
6393
|
+
/**
|
|
6394
|
+
* Indicates if the subscription can be unsubscribed and if so, who can do the unsubscribe.
|
|
6395
|
+
*/
|
|
6396
|
+
AllowUnsubscribeBy: DataModelsAllowUnsubscribeByType;
|
|
6397
|
+
/**
|
|
6398
|
+
* When true, the loyalty program will not automatically be applied to the order when a customer is attached and all conditions are met.
|
|
6399
|
+
* When false, the loyalty program will automatically be applied if all conditions are met.
|
|
6400
|
+
*/
|
|
6401
|
+
ApplyManuallyOnly?: boolean;
|
|
6402
|
+
/**
|
|
6403
|
+
* When true, if a non anonymous customer is attached to the order they will be automatically subscribed on finishing the order.
|
|
6404
|
+
* When false, the customer will not be subscribed.
|
|
6405
|
+
*
|
|
6406
|
+
* This is ignore when`RequiresSubscribedCustomer` or `RequiresSubscriptionValidation` is set to true.
|
|
6407
|
+
*/
|
|
6408
|
+
AutoSubscribeCustomer?: boolean;
|
|
6409
|
+
Budget?: number;
|
|
6410
|
+
/**
|
|
6411
|
+
* Entity type: Currency
|
|
6412
|
+
*/
|
|
6413
|
+
BudgetCurrencyID?: string;
|
|
6414
|
+
Conditions?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramCondition[];
|
|
6415
|
+
Data?: TAnyValue;
|
|
6416
|
+
DeactivateWhenBudgetIsReached?: boolean;
|
|
6417
|
+
Description?: string;
|
|
6418
|
+
EndDate?: string;
|
|
6419
|
+
Handler: string;
|
|
6420
|
+
/**
|
|
6421
|
+
* Entity type: LoyaltyProgram
|
|
6422
|
+
*/
|
|
6423
|
+
ID: string;
|
|
6424
|
+
LoyaltyPointUsageOptions: DataModelsLoyaltyPointUsageOptions;
|
|
6425
|
+
/**
|
|
6426
|
+
* Entity type: LoyaltyProgramGroup
|
|
6427
|
+
*/
|
|
6428
|
+
LoyaltyProgramGroupID?: string;
|
|
6429
|
+
Name: string;
|
|
6430
|
+
Options: DataModelsLoyaltyProgramOptions;
|
|
6431
|
+
OrganizationUnitSets?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramOrganizationUnitSet[];
|
|
6432
|
+
PaymentTypes?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramPaymentType[];
|
|
6433
|
+
PointAwardingRules?: LoyaltyPushLoyaltyProgram_PushPointAwardingRule[];
|
|
6434
|
+
PointExpirationPolicyData?: Record<string, TAnyValue>;
|
|
6435
|
+
PointExpirationPolicyType?: string;
|
|
6436
|
+
PointPendingPolicyData?: Record<string, TAnyValue>;
|
|
6437
|
+
PointPendingPolicyType?: string;
|
|
6438
|
+
/**
|
|
6439
|
+
* Entity type: PriceList
|
|
6440
|
+
*/
|
|
6441
|
+
PriceLists?: string[];
|
|
6442
|
+
ProductLimitations?: LoyaltyPushLoyaltyProgram_PushLoyaltyProgramProductLimitation[];
|
|
6443
|
+
ReactivateProgramWhenPossible?: boolean;
|
|
6444
|
+
ReloadPolicy?: string;
|
|
6445
|
+
/**
|
|
6446
|
+
* When true, the loyalty program will only be applied when a customer is attached to the order.
|
|
6447
|
+
*
|
|
6448
|
+
* When false, the loyalty program can be attached to the order even if there is no customer attached.
|
|
6449
|
+
*/
|
|
6450
|
+
RequireCustomer?: boolean;
|
|
6451
|
+
/**
|
|
6452
|
+
* When set to true, subscribing the user will require a UserIdentifier to be given.
|
|
6453
|
+
* Attention!
|
|
6454
|
+
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6455
|
+
* 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.
|
|
6456
|
+
*/
|
|
6457
|
+
RequireManualUserIdentifier?: boolean;
|
|
6458
|
+
RequiredCustomFields?: string[];
|
|
6459
|
+
/**
|
|
6460
|
+
* 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.
|
|
6461
|
+
* Also, this will make the `RequireCustomer` automatically true and `AutoSubscribeCustomer` false.
|
|
6462
|
+
*
|
|
6463
|
+
* 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.
|
|
6464
|
+
*/
|
|
6465
|
+
RequiresSubscribedCustomer?: boolean;
|
|
6466
|
+
/**
|
|
6467
|
+
* When true, the order will require that the attached customer on the order will be validated by providing the UserIdentifier in the `AttachBenefitProgramToOrder` service.
|
|
6468
|
+
* Also, this will make the `RequireCustomer` and `RequiresSubscribedCustomer` automatically true and `AutoSubscribeCustomer` false.
|
|
6469
|
+
*
|
|
6470
|
+
* When false, this validation isn't required.
|
|
6471
|
+
*/
|
|
6472
|
+
RequiresSubscriptionValidation?: boolean;
|
|
6473
|
+
/**
|
|
6474
|
+
* Handling when a user is unsubscribed and re-subscribes.
|
|
6475
|
+
*/
|
|
6476
|
+
ResubscribeHandling: DataModelsResubscribeHandlingType;
|
|
6477
|
+
StartDate?: string;
|
|
6478
|
+
Status: DataModelsLoyaltyProgramStatus;
|
|
6479
|
+
UserBudget?: number;
|
|
6480
|
+
/**
|
|
6481
|
+
* Attention!
|
|
6482
|
+
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6483
|
+
* 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.
|
|
6484
|
+
*/
|
|
6485
|
+
UserIdentifierPrefix?: string;
|
|
6486
|
+
/**
|
|
6487
|
+
* Attention!
|
|
6488
|
+
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6489
|
+
* 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.
|
|
6490
|
+
*/
|
|
6491
|
+
UserIdentifierStartNumber?: string;
|
|
6492
|
+
/**
|
|
6493
|
+
* Attention!
|
|
6494
|
+
* This value will be used to create a subscription when either `RequiredCustomer` or `AutoSubscribeCustomer` is set to true.
|
|
6495
|
+
* 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.
|
|
6496
|
+
*/
|
|
6497
|
+
UserIdentifierSuffix?: string;
|
|
6498
|
+
UserMaximumUsage?: number;
|
|
6499
|
+
}
|
|
6500
|
+
export interface PushLoyaltyProgram_AsyncResponse {
|
|
6501
|
+
Error?: ServiceError;
|
|
6502
|
+
JobID?: string;
|
|
6503
|
+
Metadata?: ResponseMessageMetadata;
|
|
6504
|
+
}
|
|
6505
|
+
export interface PushLoyaltyProgram_AsyncResult {
|
|
6506
|
+
JobID?: string;
|
|
6131
6507
|
}
|
|
6132
6508
|
/**
|
|
6133
6509
|
* Rebalance loyalty points of a user
|
|
@@ -6172,6 +6548,33 @@ export interface RemoveLoyaltyProgramPriceList {
|
|
|
6172
6548
|
PriceListID: string;
|
|
6173
6549
|
}
|
|
6174
6550
|
/**
|
|
6551
|
+
* Removes a custom field requirement from a loyalty program.
|
|
6552
|
+
*/
|
|
6553
|
+
export interface RemoveLoyaltyProgramRequiredCustomField {
|
|
6554
|
+
/**
|
|
6555
|
+
* Entity type: CustomField
|
|
6556
|
+
*/
|
|
6557
|
+
CustomFieldID: string;
|
|
6558
|
+
/**
|
|
6559
|
+
* Entity type: LoyaltyProgram
|
|
6560
|
+
*/
|
|
6561
|
+
LoyaltyProgramID: string;
|
|
6562
|
+
}
|
|
6563
|
+
/**
|
|
6564
|
+
* Set the optional loyalty program payment types for the order.
|
|
6565
|
+
*/
|
|
6566
|
+
export interface SetOrderLoyaltyProgramPaymentTypes {
|
|
6567
|
+
/**
|
|
6568
|
+
* Entity type: Order
|
|
6569
|
+
*/
|
|
6570
|
+
OrderID: string;
|
|
6571
|
+
/**
|
|
6572
|
+
* Entity type: LoyaltyProgramPaymentType
|
|
6573
|
+
* When left empty no optional payment types will be available. Required payment types cannot be unselected.
|
|
6574
|
+
*/
|
|
6575
|
+
SelectedLoyaltyProgramPaymentTypes: string[];
|
|
6576
|
+
}
|
|
6577
|
+
/**
|
|
6175
6578
|
* Update an existing LoyaltyProgram
|
|
6176
6579
|
*/
|
|
6177
6580
|
export interface UpdateLoyaltyProgram {
|
|
@@ -6346,6 +6749,7 @@ export interface UpdateLoyaltyProgramPaymentType {
|
|
|
6346
6749
|
ID: string;
|
|
6347
6750
|
MaximumAmountPerOrder?: number;
|
|
6348
6751
|
MaximumPercentageOfUserBudgetPerOrder?: number;
|
|
6752
|
+
ProductLimitation?: LoyaltyLoyaltyProgramProductLimitationData;
|
|
6349
6753
|
Required?: boolean;
|
|
6350
6754
|
Sequence?: number;
|
|
6351
6755
|
TaxHandling: DataModelsLoyaltyPaymentTaxHandlingType;
|
|
@@ -6908,18 +7312,6 @@ export interface GetCheckoutOptionHandlersResponse {
|
|
|
6908
7312
|
Metadata?: ResponseMessageMetadata;
|
|
6909
7313
|
}
|
|
6910
7314
|
/**
|
|
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
7315
|
* Returns a single refund reason.
|
|
6924
7316
|
*/
|
|
6925
7317
|
export interface GetRefundCorrectionReason {
|
|
@@ -7533,6 +7925,7 @@ export interface CreateCashHandler {
|
|
|
7533
7925
|
* Entity type: Currency
|
|
7534
7926
|
*/
|
|
7535
7927
|
CurrencyID: string;
|
|
7928
|
+
MaxAmountPerOrder?: number;
|
|
7536
7929
|
Name: string;
|
|
7537
7930
|
RoundingFactor: number;
|
|
7538
7931
|
}
|
|
@@ -7660,6 +8053,7 @@ export interface GetCashHandlerByIDResponse {
|
|
|
7660
8053
|
CurrencyID?: string;
|
|
7661
8054
|
Error?: ServiceError;
|
|
7662
8055
|
ID: string;
|
|
8056
|
+
MaxAmountPerOrder?: number;
|
|
7663
8057
|
Metadata?: ResponseMessageMetadata;
|
|
7664
8058
|
Name?: string;
|
|
7665
8059
|
RoundingFactor: number;
|
|
@@ -7718,6 +8112,7 @@ export interface OrganizationUnitsListCashHandlersResponse_CashHandlerDto {
|
|
|
7718
8112
|
* Entity type: CashHandler
|
|
7719
8113
|
*/
|
|
7720
8114
|
ID: string;
|
|
8115
|
+
MaxAmountPerOrder?: number;
|
|
7721
8116
|
Name?: string;
|
|
7722
8117
|
RoundingFactor: number;
|
|
7723
8118
|
}
|
|
@@ -7785,18 +8180,19 @@ export interface SetOrganizationUnitSupplierData {
|
|
|
7785
8180
|
* Update an existing CashHandler
|
|
7786
8181
|
*/
|
|
7787
8182
|
export interface UpdateCashHandler {
|
|
7788
|
-
BankNotes
|
|
7789
|
-
Coins
|
|
8183
|
+
BankNotes?: number[];
|
|
8184
|
+
Coins?: number[];
|
|
7790
8185
|
/**
|
|
7791
8186
|
* Entity type: Currency
|
|
7792
8187
|
*/
|
|
7793
|
-
CurrencyID
|
|
8188
|
+
CurrencyID?: string;
|
|
7794
8189
|
/**
|
|
7795
8190
|
* Entity type: CashHandler
|
|
7796
8191
|
*/
|
|
7797
8192
|
ID: string;
|
|
7798
|
-
|
|
7799
|
-
|
|
8193
|
+
MaxAmountPerOrder: number | null | undefined;
|
|
8194
|
+
Name?: string;
|
|
8195
|
+
RoundingFactor?: number;
|
|
7800
8196
|
}
|
|
7801
8197
|
/**
|
|
7802
8198
|
* Update an existing OpeningHoursType
|
|
@@ -8849,6 +9245,10 @@ export interface CreatePriceListAdjustment {
|
|
|
8849
9245
|
PriceListID: string;
|
|
8850
9246
|
PricingGroupID?: string;
|
|
8851
9247
|
Sequence?: number;
|
|
9248
|
+
/**
|
|
9249
|
+
* 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.
|
|
9250
|
+
*/
|
|
9251
|
+
SkipRecalculation?: boolean;
|
|
8852
9252
|
Type: string;
|
|
8853
9253
|
}
|
|
8854
9254
|
export interface CreatePriceListAdjustmentResponse {
|
|
@@ -8945,6 +9345,10 @@ export interface DeletePriceListAdjustment {
|
|
|
8945
9345
|
* Entity type: PriceListAdjustment
|
|
8946
9346
|
*/
|
|
8947
9347
|
ID: string;
|
|
9348
|
+
/**
|
|
9349
|
+
* 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.
|
|
9350
|
+
*/
|
|
9351
|
+
SkipRecalculation?: boolean;
|
|
8948
9352
|
}
|
|
8949
9353
|
/**
|
|
8950
9354
|
* Delete a PriceListManualInputAdjustment
|
|
@@ -9419,6 +9823,10 @@ export interface UpdatePriceListAdjustment {
|
|
|
9419
9823
|
ParentAdjustmentID?: string;
|
|
9420
9824
|
PricingGroupID: string | null | undefined;
|
|
9421
9825
|
Sequence?: number;
|
|
9826
|
+
/**
|
|
9827
|
+
* 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.
|
|
9828
|
+
*/
|
|
9829
|
+
SkipRecalculation?: boolean;
|
|
9422
9830
|
Type: string;
|
|
9423
9831
|
}
|
|
9424
9832
|
/**
|
|
@@ -10789,7 +11197,6 @@ export interface CreateShippingCost {
|
|
|
10789
11197
|
* Entity type: ShippingMethod
|
|
10790
11198
|
*/
|
|
10791
11199
|
ShippingMethodID?: string;
|
|
10792
|
-
UnitPriceInTax?: number;
|
|
10793
11200
|
ZipCodes?: string[];
|
|
10794
11201
|
}
|
|
10795
11202
|
export interface CreateShippingCostResponse {
|
|
@@ -10841,16 +11248,23 @@ export interface CreateShippingMethodTransportationTime {
|
|
|
10841
11248
|
* Creates a new ShippingRestriction.
|
|
10842
11249
|
*/
|
|
10843
11250
|
export interface CreateShippingRestriction {
|
|
11251
|
+
/**
|
|
11252
|
+
* When set to `true`, the script will be leading for the entire order. Default is `true`
|
|
11253
|
+
*/
|
|
11254
|
+
CheckScriptOnly?: boolean;
|
|
10844
11255
|
/**
|
|
10845
11256
|
* Entity type: Country
|
|
11257
|
+
* Required when there is no ScriptID set or CheckScriptOnly is 'false'
|
|
10846
11258
|
*/
|
|
10847
|
-
CountryID
|
|
11259
|
+
CountryID?: string;
|
|
10848
11260
|
/**
|
|
10849
11261
|
* Entity type: OrganizationUnit
|
|
11262
|
+
* Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
|
|
10850
11263
|
*/
|
|
10851
11264
|
OrganizationUnitID?: string;
|
|
10852
11265
|
/**
|
|
10853
11266
|
* Entity type: OrganizationUnitSet
|
|
11267
|
+
* Either an OrganizationUnitID or an OrganizationUnitSetID is required when there is no ScriptID set or CheckScriptOnly is 'false'
|
|
10854
11268
|
*/
|
|
10855
11269
|
OrganizationUnitSetID?: string;
|
|
10856
11270
|
/**
|
|
@@ -11016,7 +11430,6 @@ export interface GetShippingCostByIDResponse {
|
|
|
11016
11430
|
OrganizationUnitName?: string;
|
|
11017
11431
|
ShippingMethodID?: string;
|
|
11018
11432
|
ShippingMethodName?: string;
|
|
11019
|
-
UnitPriceInTax: number;
|
|
11020
11433
|
ZipCodes?: string[];
|
|
11021
11434
|
}
|
|
11022
11435
|
/**
|
|
@@ -11061,6 +11474,7 @@ export interface GetShippingRestrictionByID {
|
|
|
11061
11474
|
ID: string;
|
|
11062
11475
|
}
|
|
11063
11476
|
export interface GetShippingRestrictionByIDResponse {
|
|
11477
|
+
CheckScriptOnly: boolean;
|
|
11064
11478
|
CountryID?: string;
|
|
11065
11479
|
CountryName?: string;
|
|
11066
11480
|
Error?: ServiceError;
|
|
@@ -11069,7 +11483,7 @@ export interface GetShippingRestrictionByIDResponse {
|
|
|
11069
11483
|
OrganizationUnitID?: string;
|
|
11070
11484
|
OrganizationUnitName?: string;
|
|
11071
11485
|
OrganizationUnitSetDescription?: string;
|
|
11072
|
-
OrganizationUnitSetID
|
|
11486
|
+
OrganizationUnitSetID?: string;
|
|
11073
11487
|
OrganizationUnitSetName?: string;
|
|
11074
11488
|
OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
|
|
11075
11489
|
ProductPropertyTypeID?: string;
|
|
@@ -11243,7 +11657,6 @@ export interface ShippingShippingCostDto {
|
|
|
11243
11657
|
OrganizationUnitName?: string;
|
|
11244
11658
|
ShippingMethodID?: string;
|
|
11245
11659
|
ShippingMethodName?: string;
|
|
11246
|
-
UnitPriceInTax: number;
|
|
11247
11660
|
ZipCodes?: string[];
|
|
11248
11661
|
}
|
|
11249
11662
|
export interface ShippingShippingRestrictionDto {
|
|
@@ -11265,9 +11678,9 @@ export interface ShippingShippingRestrictionDto {
|
|
|
11265
11678
|
/**
|
|
11266
11679
|
* Entity type: OrganizationUnitSet
|
|
11267
11680
|
*/
|
|
11268
|
-
OrganizationUnitSetID
|
|
11681
|
+
OrganizationUnitSetID?: string;
|
|
11269
11682
|
OrganizationUnitSetName?: string;
|
|
11270
|
-
OrganizationUnitSetType
|
|
11683
|
+
OrganizationUnitSetType?: DataModelsOrganizationUnitSetTypes;
|
|
11271
11684
|
/**
|
|
11272
11685
|
* Entity type: ProductPropertyType
|
|
11273
11686
|
*/
|
|
@@ -11362,7 +11775,6 @@ export interface UpdateShippingCost {
|
|
|
11362
11775
|
* Entity type: ShippingMethod
|
|
11363
11776
|
*/
|
|
11364
11777
|
ShippingMethodID?: string;
|
|
11365
|
-
UnitPriceInTax?: number;
|
|
11366
11778
|
ZipCodes?: string[];
|
|
11367
11779
|
}
|
|
11368
11780
|
/**
|
|
@@ -11419,6 +11831,10 @@ export interface UpdateShippingMethodTransportationTime {
|
|
|
11419
11831
|
* Updates a ShippingRestriction.
|
|
11420
11832
|
*/
|
|
11421
11833
|
export interface UpdateShippingRestriction {
|
|
11834
|
+
/**
|
|
11835
|
+
* When set to `true`, the script will be leading for the entire order.
|
|
11836
|
+
*/
|
|
11837
|
+
CheckScriptOnly?: boolean;
|
|
11422
11838
|
/**
|
|
11423
11839
|
* Entity type: Country
|
|
11424
11840
|
*/
|
|
@@ -11507,6 +11923,7 @@ export interface CreateStockAllocationRule {
|
|
|
11507
11923
|
*/
|
|
11508
11924
|
export interface CreateStockLabel {
|
|
11509
11925
|
Description?: string;
|
|
11926
|
+
DisplayName?: string;
|
|
11510
11927
|
LedgerClassID?: string;
|
|
11511
11928
|
Name: string;
|
|
11512
11929
|
}
|
|
@@ -11592,12 +12009,13 @@ export interface UpdateStockAllocationRule {
|
|
|
11592
12009
|
* Update the description or ledgerclass of StockLabel
|
|
11593
12010
|
*/
|
|
11594
12011
|
export interface UpdateStockLabel {
|
|
11595
|
-
Description
|
|
12012
|
+
Description: string | null | undefined;
|
|
12013
|
+
DisplayName: string | null | undefined;
|
|
11596
12014
|
/**
|
|
11597
12015
|
* Entity type: StockLabel
|
|
11598
12016
|
*/
|
|
11599
12017
|
ID: string;
|
|
11600
|
-
LedgerClassID
|
|
12018
|
+
LedgerClassID: string | null | undefined;
|
|
11601
12019
|
}
|
|
11602
12020
|
/**
|
|
11603
12021
|
* A service to upload an Excel containing StockAllocationRules that should be created or updated according to the values specified in the sheet.
|
|
@@ -11872,6 +12290,7 @@ export interface CreateUserOriginResponse {
|
|
|
11872
12290
|
* Creates a new UserRequirement and returns the ID of the new record.
|
|
11873
12291
|
*/
|
|
11874
12292
|
export interface CreateUserRequirement {
|
|
12293
|
+
AccountType?: DataModelsUserAccountType;
|
|
11875
12294
|
CustomValidators?: Record<string, TAnyValue | null>;
|
|
11876
12295
|
Display?: boolean;
|
|
11877
12296
|
Preferred?: boolean;
|
|
@@ -12307,6 +12726,7 @@ export interface GetUserRequirement {
|
|
|
12307
12726
|
ID: string;
|
|
12308
12727
|
}
|
|
12309
12728
|
export interface GetUserRequirementResponse {
|
|
12729
|
+
AccountType?: DataModelsUserAccountType;
|
|
12310
12730
|
CustomValidators?: Record<string, TAnyValue | null>;
|
|
12311
12731
|
Display: boolean;
|
|
12312
12732
|
Error?: ServiceError;
|
|
@@ -12530,6 +12950,7 @@ export interface ListUserRequirementsResponse {
|
|
|
12530
12950
|
Result?: PagedResult<UsersListUserRequirementsResponse_UserRequirementDto>;
|
|
12531
12951
|
}
|
|
12532
12952
|
export interface UsersListUserRequirementsResponse_UserRequirementDto {
|
|
12953
|
+
AccountType?: DataModelsUserAccountType;
|
|
12533
12954
|
CustomValidators?: Record<string, TAnyValue | null>;
|
|
12534
12955
|
Display: boolean;
|
|
12535
12956
|
/**
|
|
@@ -12658,6 +13079,7 @@ export interface UpdateSubscriptionUserRequirements {
|
|
|
12658
13079
|
Requirements: UsersUpdateSubscriptionUserRequirements_UserRequirementDto[];
|
|
12659
13080
|
}
|
|
12660
13081
|
export interface UsersUpdateSubscriptionUserRequirements_UserRequirementDto {
|
|
13082
|
+
AccountType: DataModelsUserAccountType | undefined;
|
|
12661
13083
|
CustomValidators: Record<string, TAnyValue | null> | null | undefined;
|
|
12662
13084
|
Display?: boolean;
|
|
12663
13085
|
/**
|
|
@@ -12688,6 +13110,7 @@ export interface UpdateUserOrigin {
|
|
|
12688
13110
|
* Updates an existing UserRequirement.
|
|
12689
13111
|
*/
|
|
12690
13112
|
export interface UpdateUserRequirement {
|
|
13113
|
+
AccountType: DataModelsUserAccountType | undefined;
|
|
12691
13114
|
CustomValidators: Record<string, TAnyValue | null> | null | undefined;
|
|
12692
13115
|
Display?: boolean;
|
|
12693
13116
|
/**
|
|
@@ -12732,6 +13155,7 @@ export interface UpdateUserRequirementSetRequirements {
|
|
|
12732
13155
|
Requirements?: UsersUpdateUserRequirementSetRequirements_UserRequirementDto[];
|
|
12733
13156
|
}
|
|
12734
13157
|
export interface UsersUpdateUserRequirementSetRequirements_UserRequirementDto {
|
|
13158
|
+
AccountType: DataModelsUserAccountType | undefined;
|
|
12735
13159
|
CustomValidators: Record<string, TAnyValue | null> | null | undefined;
|
|
12736
13160
|
Display?: boolean;
|
|
12737
13161
|
/**
|
|
@@ -13689,7 +14113,7 @@ export interface EVACoreServicesUsersListUserBoughtProductsResponse_BoughtProduc
|
|
|
13689
14113
|
WarrantyExpiryDate?: string;
|
|
13690
14114
|
}
|
|
13691
14115
|
/**
|
|
13692
|
-
* Push bought products for users. Only accepts
|
|
14116
|
+
* Push bought products for users. Only accepts 10000 users per request
|
|
13693
14117
|
*/
|
|
13694
14118
|
export interface EVACoreServicesUsersPushBoughtProductsForUsers {
|
|
13695
14119
|
BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
|
|
@@ -13703,16 +14127,34 @@ export interface EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProd
|
|
|
13703
14127
|
}
|
|
13704
14128
|
export interface PushBoughtProductsForUsersResponse {
|
|
13705
14129
|
Error?: ServiceError;
|
|
13706
|
-
FailedBoughtProductsForUsers?:
|
|
14130
|
+
FailedBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser[];
|
|
13707
14131
|
Metadata?: ResponseMessageMetadata;
|
|
14132
|
+
SuccessfulBoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser[];
|
|
13708
14133
|
}
|
|
13709
|
-
export interface
|
|
14134
|
+
export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct {
|
|
14135
|
+
ProductBackendID?: string;
|
|
13710
14136
|
/**
|
|
13711
14137
|
* Entity type: Product
|
|
13712
14138
|
*/
|
|
13713
14139
|
ProductID: string;
|
|
13714
14140
|
SerialNumber?: string;
|
|
13715
14141
|
}
|
|
14142
|
+
export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_FailedUserBoughtProductsForUser {
|
|
14143
|
+
BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
|
|
14144
|
+
UserBackendID?: string;
|
|
14145
|
+
/**
|
|
14146
|
+
* Entity type: User
|
|
14147
|
+
*/
|
|
14148
|
+
UserID: string;
|
|
14149
|
+
}
|
|
14150
|
+
export interface EVACoreServicesUsersPushBoughtProductsForUsersResponse_SuccessfulUserBoughtProductsForUser {
|
|
14151
|
+
BoughtProducts?: EVACoreServicesUsersPushBoughtProductsForUsersResponse_BoughtProduct[];
|
|
14152
|
+
UserBackendID?: string;
|
|
14153
|
+
/**
|
|
14154
|
+
* Entity type: User
|
|
14155
|
+
*/
|
|
14156
|
+
UserID: string;
|
|
14157
|
+
}
|
|
13716
14158
|
export interface PushBoughtProductsForUsers_Async {
|
|
13717
14159
|
BoughtProductsForUsers?: EVACoreServicesUsersPushBoughtProductsForUsers_PushedBoughtProductForUser[];
|
|
13718
14160
|
}
|