@springtree/eva-services-core-management 2.3.0 → 2.3.1

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.
@@ -13,6 +13,19 @@ export declare namespace CoreManagement {
13
13
  request?: EVA.Core.Management.AddBlobToCaseInteraction;
14
14
  response?: EVA.Core.EmptyResponseMessage;
15
15
  }
16
+ /**
17
+ * Add a price list to a loyalty program. NOTE THAT you can only add one pricelist per currency to a loyalty program.
18
+ *
19
+ * @export
20
+ * @class AddLoyaltyProgramPriceList
21
+ * @implements {EvaService}
22
+ */
23
+ class AddLoyaltyProgramPriceList implements IEvaServiceDefinition {
24
+ name: string;
25
+ path: string;
26
+ request?: EVA.Core.Management.AddLoyaltyProgramPriceList;
27
+ response?: EVA.Core.EmptyResponseMessage;
28
+ }
16
29
  /**
17
30
  * Add a package to a carrier
18
31
  *
@@ -185,6 +198,32 @@ But if the list is a mixed product list, all updates will be applied according t
185
198
  request?: EVA.Core.Management.AttachFunctionalitiesToRole;
186
199
  response?: EVA.Core.EmptyResponseMessage;
187
200
  }
201
+ /**
202
+ * Attach a product limitation to a payment type.
203
+ *
204
+ * @export
205
+ * @class AttachLoyaltyProgramProductLimitationToPaymentType
206
+ * @implements {EvaService}
207
+ */
208
+ class AttachLoyaltyProgramProductLimitationToPaymentType implements IEvaServiceDefinition {
209
+ name: string;
210
+ path: string;
211
+ request?: EVA.Core.Management.AttachLoyaltyProgramProductLimitationToPaymentType;
212
+ response?: EVA.Core.EmptyResponseMessage;
213
+ }
214
+ /**
215
+ * Attach a loyalty program to an order
216
+ *
217
+ * @export
218
+ * @class AttachLoyaltyProgramToOrder
219
+ * @implements {EvaService}
220
+ */
221
+ class AttachLoyaltyProgramToOrder implements IEvaServiceDefinition {
222
+ name: string;
223
+ path: string;
224
+ request?: EVA.Core.Management.AttachLoyaltyProgramToOrder;
225
+ response?: EVA.Core.EmptyResponseMessage;
226
+ }
188
227
  /**
189
228
  * Resets the Financial Periods for given OU and all children to which the auditing provider applies. **Use with care!**
190
229
  *
@@ -700,6 +739,58 @@ This PIN will only be valid for a limited amount of time, and only for the provi
700
739
  request?: EVA.Core.Management.CreateLoyaltyProgram;
701
740
  response?: EVA.Core.Management.CreateLoyaltyProgramResponse;
702
741
  }
742
+ /**
743
+ * Create a new LoyaltyProgramCondition
744
+ *
745
+ * @export
746
+ * @class CreateLoyaltyProgramCondition
747
+ * @implements {EvaService}
748
+ */
749
+ class CreateLoyaltyProgramCondition implements IEvaServiceDefinition {
750
+ name: string;
751
+ path: string;
752
+ request?: EVA.Core.Management.CreateLoyaltyProgramCondition;
753
+ response?: EVA.Core.Management.CreateLoyaltyProgramConditionResponse;
754
+ }
755
+ /**
756
+ * Create a new LoyaltyProgramGroup
757
+ *
758
+ * @export
759
+ * @class CreateLoyaltyProgramGroup
760
+ * @implements {EvaService}
761
+ */
762
+ class CreateLoyaltyProgramGroup implements IEvaServiceDefinition {
763
+ name: string;
764
+ path: string;
765
+ request?: EVA.Core.Management.CreateLoyaltyProgramGroup;
766
+ response?: EVA.Core.Management.CreateLoyaltyProgramGroupResponse;
767
+ }
768
+ /**
769
+ * Create a new LoyaltyProgramPaymentType
770
+ *
771
+ * @export
772
+ * @class CreateLoyaltyProgramPaymentType
773
+ * @implements {EvaService}
774
+ */
775
+ class CreateLoyaltyProgramPaymentType implements IEvaServiceDefinition {
776
+ name: string;
777
+ path: string;
778
+ request?: EVA.Core.Management.CreateLoyaltyProgramPaymentType;
779
+ response?: EVA.Core.Management.CreateLoyaltyProgramPaymentTypeResponse;
780
+ }
781
+ /**
782
+ * Create a loyalty program product limitation.
783
+ *
784
+ * @export
785
+ * @class CreateLoyaltyProgramProductLimitation
786
+ * @implements {EvaService}
787
+ */
788
+ class CreateLoyaltyProgramProductLimitation implements IEvaServiceDefinition {
789
+ name: string;
790
+ path: string;
791
+ request?: EVA.Core.Management.CreateLoyaltyProgramProductLimitation;
792
+ response?: EVA.Core.Management.CreateLoyaltyProgramProductLimitationResponse;
793
+ }
703
794
  /**
704
795
  * Create a new MessageTemplate
705
796
  *
@@ -1776,6 +1867,58 @@ Name is required
1776
1867
  request?: EVA.Core.Management.DeleteLoyaltyProgram;
1777
1868
  response?: EVA.Core.EmptyResponseMessage;
1778
1869
  }
1870
+ /**
1871
+ * Delete a LoyaltyProgramCondition
1872
+ *
1873
+ * @export
1874
+ * @class DeleteLoyaltyProgramCondition
1875
+ * @implements {EvaService}
1876
+ */
1877
+ class DeleteLoyaltyProgramCondition implements IEvaServiceDefinition {
1878
+ name: string;
1879
+ path: string;
1880
+ request?: EVA.Core.Management.DeleteLoyaltyProgramCondition;
1881
+ response?: EVA.Core.EmptyResponseMessage;
1882
+ }
1883
+ /**
1884
+ * Delete the LoyaltyProgramGroup
1885
+ *
1886
+ * @export
1887
+ * @class DeleteLoyaltyProgramGroup
1888
+ * @implements {EvaService}
1889
+ */
1890
+ class DeleteLoyaltyProgramGroup implements IEvaServiceDefinition {
1891
+ name: string;
1892
+ path: string;
1893
+ request?: EVA.Core.Management.DeleteLoyaltyProgramGroup;
1894
+ response?: EVA.Core.EmptyResponseMessage;
1895
+ }
1896
+ /**
1897
+ * Delete a LoyaltyProgramPaymentType
1898
+ *
1899
+ * @export
1900
+ * @class DeleteLoyaltyProgramPaymentType
1901
+ * @implements {EvaService}
1902
+ */
1903
+ class DeleteLoyaltyProgramPaymentType implements IEvaServiceDefinition {
1904
+ name: string;
1905
+ path: string;
1906
+ request?: EVA.Core.Management.DeleteLoyaltyProgramPaymentType;
1907
+ response?: EVA.Core.EmptyResponseMessage;
1908
+ }
1909
+ /**
1910
+ * Delete a loyalty program product limitation.
1911
+ *
1912
+ * @export
1913
+ * @class DeleteLoyaltyProgramProductLimitation
1914
+ * @implements {EvaService}
1915
+ */
1916
+ class DeleteLoyaltyProgramProductLimitation implements IEvaServiceDefinition {
1917
+ name: string;
1918
+ path: string;
1919
+ request?: EVA.Core.Management.DeleteLoyaltyProgramProductLimitation;
1920
+ response?: EVA.Core.EmptyResponseMessage;
1921
+ }
1779
1922
  /**
1780
1923
  * Delete a MessageTemplate
1781
1924
  *
@@ -2475,6 +2618,32 @@ File in state processing or processed can't be deleted due to generated financia
2475
2618
  request?: EVA.Core.Management.DetachFunctionalitiesFromRole;
2476
2619
  response?: EVA.Core.EmptyResponseMessage;
2477
2620
  }
2621
+ /**
2622
+ * Detach a loyalty program from an order
2623
+ *
2624
+ * @export
2625
+ * @class DetachLoyaltyProgramFromOrder
2626
+ * @implements {EvaService}
2627
+ */
2628
+ class DetachLoyaltyProgramFromOrder implements IEvaServiceDefinition {
2629
+ name: string;
2630
+ path: string;
2631
+ request?: EVA.Core.Management.DetachLoyaltyProgramFromOrder;
2632
+ response?: EVA.Core.EmptyResponseMessage;
2633
+ }
2634
+ /**
2635
+ * Detach a product limitation from a payment type.
2636
+ *
2637
+ * @export
2638
+ * @class DetachLoyaltyProgramProductLimitationFromPaymentType
2639
+ * @implements {EvaService}
2640
+ */
2641
+ class DetachLoyaltyProgramProductLimitationFromPaymentType implements IEvaServiceDefinition {
2642
+ name: string;
2643
+ path: string;
2644
+ request?: EVA.Core.Management.DetachLoyaltyProgramProductLimitationFromPaymentType;
2645
+ response?: EVA.Core.EmptyResponseMessage;
2646
+ }
2478
2647
  /**
2479
2648
  * Disable discounts
2480
2649
  *
@@ -3718,6 +3887,32 @@ At this moment the supported DeviceTypes are:
3718
3887
  request?: EVA.Core.Management.GetLoyaltyProgram;
3719
3888
  response?: EVA.Core.Management.GetLoyaltyProgramResponse;
3720
3889
  }
3890
+ /**
3891
+ * Get a LoyaltyProgramCondition
3892
+ *
3893
+ * @export
3894
+ * @class GetLoyaltyProgramCondition
3895
+ * @implements {EvaService}
3896
+ */
3897
+ class GetLoyaltyProgramCondition implements IEvaServiceDefinition {
3898
+ name: string;
3899
+ path: string;
3900
+ request?: EVA.Core.Management.GetLoyaltyProgramCondition;
3901
+ response?: EVA.Core.Management.GetLoyaltyProgramConditionResponse;
3902
+ }
3903
+ /**
3904
+ * Get a LoyaltyProgramGroup
3905
+ *
3906
+ * @export
3907
+ * @class GetLoyaltyProgramGroup
3908
+ * @implements {EvaService}
3909
+ */
3910
+ class GetLoyaltyProgramGroup implements IEvaServiceDefinition {
3911
+ name: string;
3912
+ path: string;
3913
+ request?: EVA.Core.Management.GetLoyaltyProgramGroup;
3914
+ response?: EVA.Core.Management.GetLoyaltyProgramGroupResponse;
3915
+ }
3721
3916
  /**
3722
3917
  * Get the available loyalty program handlers
3723
3918
  *
@@ -3731,6 +3926,32 @@ At this moment the supported DeviceTypes are:
3731
3926
  request?: EVA.Core.Management.GetLoyaltyProgramHandlers;
3732
3927
  response?: EVA.Core.Management.GetLoyaltyProgramHandlersResponse;
3733
3928
  }
3929
+ /**
3930
+ * Get a LoyaltyProgramPaymentType
3931
+ *
3932
+ * @export
3933
+ * @class GetLoyaltyProgramPaymentType
3934
+ * @implements {EvaService}
3935
+ */
3936
+ class GetLoyaltyProgramPaymentType implements IEvaServiceDefinition {
3937
+ name: string;
3938
+ path: string;
3939
+ request?: EVA.Core.Management.GetLoyaltyProgramPaymentType;
3940
+ response?: EVA.Core.Management.GetLoyaltyProgramPaymentTypeResponse;
3941
+ }
3942
+ /**
3943
+ * Get a loyalty program product limitations"
3944
+ *
3945
+ * @export
3946
+ * @class GetLoyaltyProgramProductLimitation
3947
+ * @implements {EvaService}
3948
+ */
3949
+ class GetLoyaltyProgramProductLimitation implements IEvaServiceDefinition {
3950
+ name: string;
3951
+ path: string;
3952
+ request?: EVA.Core.Management.GetLoyaltyProgramProductLimitation;
3953
+ response?: EVA.Core.Management.GetLoyaltyProgramProductLimitationResponse;
3954
+ }
3734
3955
  /**
3735
3956
  * Get a MessageTemplate
3736
3957
  *
@@ -5010,6 +5231,84 @@ or to get a specific product in an assortment by filtering on both.
5010
5231
  request?: EVA.Core.Management.ListInquiries;
5011
5232
  response?: EVA.Core.Management.ListInquiriesResponse;
5012
5233
  }
5234
+ /**
5235
+ * Lists all payment types under the Loyalty payment method that aren't already connected to a loyalty program.
5236
+ *
5237
+ * @export
5238
+ * @class ListLoyaltyPaymentMethodTypes
5239
+ * @implements {EvaService}
5240
+ */
5241
+ class ListLoyaltyPaymentMethodTypes implements IEvaServiceDefinition {
5242
+ name: string;
5243
+ path: string;
5244
+ request?: EVA.Core.Management.ListLoyaltyPaymentMethodTypes;
5245
+ response?: EVA.Core.Management.ListLoyaltyPaymentMethodTypesResponse;
5246
+ }
5247
+ /**
5248
+ * List the LoyaltyProgramCondition
5249
+ *
5250
+ * @export
5251
+ * @class ListLoyaltyProgramConditions
5252
+ * @implements {EvaService}
5253
+ */
5254
+ class ListLoyaltyProgramConditions implements IEvaServiceDefinition {
5255
+ name: string;
5256
+ path: string;
5257
+ request?: EVA.Core.Management.ListLoyaltyProgramConditions;
5258
+ response?: EVA.Core.Management.ListLoyaltyProgramConditionsResponse;
5259
+ }
5260
+ /**
5261
+ * List the LoyaltyProgramGroups
5262
+ *
5263
+ * @export
5264
+ * @class ListLoyaltyProgramGroups
5265
+ * @implements {EvaService}
5266
+ */
5267
+ class ListLoyaltyProgramGroups implements IEvaServiceDefinition {
5268
+ name: string;
5269
+ path: string;
5270
+ request?: EVA.Core.Management.ListLoyaltyProgramGroups;
5271
+ response?: EVA.Core.Management.ListLoyaltyProgramGroupsResponse;
5272
+ }
5273
+ /**
5274
+ * List the LoyaltyProgramPaymentType
5275
+ *
5276
+ * @export
5277
+ * @class ListLoyaltyProgramPaymentTypes
5278
+ * @implements {EvaService}
5279
+ */
5280
+ class ListLoyaltyProgramPaymentTypes implements IEvaServiceDefinition {
5281
+ name: string;
5282
+ path: string;
5283
+ request?: EVA.Core.Management.ListLoyaltyProgramPaymentTypes;
5284
+ response?: EVA.Core.Management.ListLoyaltyProgramPaymentTypesResponse;
5285
+ }
5286
+ /**
5287
+ * List the loyalty program pricelists
5288
+ *
5289
+ * @export
5290
+ * @class ListLoyaltyProgramPriceLists
5291
+ * @implements {EvaService}
5292
+ */
5293
+ class ListLoyaltyProgramPriceLists implements IEvaServiceDefinition {
5294
+ name: string;
5295
+ path: string;
5296
+ request?: EVA.Core.Management.ListLoyaltyProgramPriceLists;
5297
+ response?: EVA.Core.Management.ListLoyaltyProgramPriceListsResponse;
5298
+ }
5299
+ /**
5300
+ * List the loyalty program product limitations
5301
+ *
5302
+ * @export
5303
+ * @class ListLoyaltyProgramProductLimitations
5304
+ * @implements {EvaService}
5305
+ */
5306
+ class ListLoyaltyProgramProductLimitations implements IEvaServiceDefinition {
5307
+ name: string;
5308
+ path: string;
5309
+ request?: EVA.Core.Management.ListLoyaltyProgramProductLimitations;
5310
+ response?: EVA.Core.Management.ListLoyaltyProgramProductLimitationsResponse;
5311
+ }
5013
5312
  /**
5014
5313
  * List the LoyaltyPrograms
5015
5314
  *
@@ -6035,6 +6334,19 @@ Also the MessageTemplate `QRCodePrintingTemplate` can be configured in Stencil.
6035
6334
  request?: EVA.Core.Management.PushCase;
6036
6335
  response?: EVA.Core.Management.PushCaseResponse;
6037
6336
  }
6337
+ /**
6338
+ * Push a LoyaltyProgram.
6339
+ *
6340
+ * @export
6341
+ * @class PushLoyaltyProgram
6342
+ * @implements {EvaService}
6343
+ */
6344
+ class PushLoyaltyProgram implements IEvaServiceDefinition {
6345
+ name: string;
6346
+ path: string;
6347
+ request?: EVA.Core.Management.PushLoyaltyProgram;
6348
+ response?: EVA.Core.Management.PushLoyaltyProgramResponse;
6349
+ }
6038
6350
  /**
6039
6351
  * Push user bought product.
6040
6352
  *
@@ -6144,6 +6456,19 @@ NOTE THAT Balance can only be provided for loyalty subscriptions that have a EVA
6144
6456
  request?: EVA.Core.Management.RemoveCaseRelatedItems;
6145
6457
  response?: EVA.Core.EmptyResponseMessage;
6146
6458
  }
6459
+ /**
6460
+ * Removes a price list from a loyalty program.
6461
+ *
6462
+ * @export
6463
+ * @class RemoveLoyaltyProgramPriceList
6464
+ * @implements {EvaService}
6465
+ */
6466
+ class RemoveLoyaltyProgramPriceList implements IEvaServiceDefinition {
6467
+ name: string;
6468
+ path: string;
6469
+ request?: EVA.Core.Management.RemoveLoyaltyProgramPriceList;
6470
+ response?: EVA.Core.EmptyResponseMessage;
6471
+ }
6147
6472
  /**
6148
6473
  * Remove a package from a carrier
6149
6474
  *
@@ -6876,6 +7201,97 @@ When the budget is cleared or raised above the current `TotalDiscountGiven`, or
6876
7201
  request?: EVA.Core.Management.UpdateLoyaltyProgram;
6877
7202
  response?: EVA.Core.EmptyResponseMessage;
6878
7203
  }
7204
+ /**
7205
+ * Update the budget on the loyalty program group.
7206
+ ATTENTION! When the currency is changed, the used budget registration will be reset to 0!
7207
+ When the budget is lowered below the current used budget and the `DeactivateWhenBudgetIsReached` is set to true, all related programs will be deactivated.
7208
+ When the budget is cleared or raised above the current used budget, or `DeactivateWhenBudgetIsReached` is set to false, and the `ReactivateProgramsWhenPossible` is set to true, all programs that were deactivate by the group budget will be reactivated when possible.
7209
+ *
7210
+ * @export
7211
+ * @class UpdateLoyaltyProgramBudget
7212
+ * @implements {EvaService}
7213
+ */
7214
+ class UpdateLoyaltyProgramBudget implements IEvaServiceDefinition {
7215
+ name: string;
7216
+ path: string;
7217
+ request?: EVA.Core.Management.UpdateLoyaltyProgramBudget;
7218
+ response?: EVA.Core.EmptyResponseMessage;
7219
+ }
7220
+ /**
7221
+ * Update an existing LoyaltyProgramCondition
7222
+ *
7223
+ * @export
7224
+ * @class UpdateLoyaltyProgramCondition
7225
+ * @implements {EvaService}
7226
+ */
7227
+ class UpdateLoyaltyProgramCondition implements IEvaServiceDefinition {
7228
+ name: string;
7229
+ path: string;
7230
+ request?: EVA.Core.Management.UpdateLoyaltyProgramCondition;
7231
+ response?: EVA.Core.EmptyResponseMessage;
7232
+ }
7233
+ /**
7234
+ * Update an existing LoyaltyProgramGroup
7235
+
7236
+ ATTENTION!
7237
+ When the currency is changed, the budget usages will be reset to 0!
7238
+
7239
+ ATTENTION!
7240
+ When a change to Status, StartDate, EndDate or Currency leads to the group being deactivated, all related loyalty programs will also be deactivated.
7241
+ When a change to Status, StartDate, EndDate or Currency leads to the group being reactivate, all related loyalty programs will also be reactive when the option ReactivateProgramsWhenPossible is set to true. Otherwise all deactivated programs need to be manually reactivated.
7242
+ *
7243
+ * @export
7244
+ * @class UpdateLoyaltyProgramGroup
7245
+ * @implements {EvaService}
7246
+ */
7247
+ class UpdateLoyaltyProgramGroup implements IEvaServiceDefinition {
7248
+ name: string;
7249
+ path: string;
7250
+ request?: EVA.Core.Management.UpdateLoyaltyProgramGroup;
7251
+ response?: EVA.Core.EmptyResponseMessage;
7252
+ }
7253
+ /**
7254
+ * Update the budget on the loyalty program group.
7255
+ ATTENTION!
7256
+ When the budget is lowered below the current used budget and the `DeactivateWhenBudgetIsReached` is set to true, all related programs will be deactivated.
7257
+ When the budget is cleared or raised above the current used budget, or `DeactivateWhenBudgetIsReached` is set to false, and the `ReactivateProgramsWhenPossible` is set to true, all programs that were deactivate by the group budget will be reactivated when possible.
7258
+ *
7259
+ * @export
7260
+ * @class UpdateLoyaltyProgramGroupBudget
7261
+ * @implements {EvaService}
7262
+ */
7263
+ class UpdateLoyaltyProgramGroupBudget implements IEvaServiceDefinition {
7264
+ name: string;
7265
+ path: string;
7266
+ request?: EVA.Core.Management.UpdateLoyaltyProgramGroupBudget;
7267
+ response?: EVA.Core.EmptyResponseMessage;
7268
+ }
7269
+ /**
7270
+ * Update an existing LoyaltyProgramPaymentType
7271
+ *
7272
+ * @export
7273
+ * @class UpdateLoyaltyProgramPaymentType
7274
+ * @implements {EvaService}
7275
+ */
7276
+ class UpdateLoyaltyProgramPaymentType implements IEvaServiceDefinition {
7277
+ name: string;
7278
+ path: string;
7279
+ request?: EVA.Core.Management.UpdateLoyaltyProgramPaymentType;
7280
+ response?: EVA.Core.EmptyResponseMessage;
7281
+ }
7282
+ /**
7283
+ * Update a loyalty program product limitation.
7284
+ *
7285
+ * @export
7286
+ * @class UpdateLoyaltyProgramProductLimitation
7287
+ * @implements {EvaService}
7288
+ */
7289
+ class UpdateLoyaltyProgramProductLimitation implements IEvaServiceDefinition {
7290
+ name: string;
7291
+ path: string;
7292
+ request?: EVA.Core.Management.UpdateLoyaltyProgramProductLimitation;
7293
+ response?: EVA.Core.EmptyResponseMessage;
7294
+ }
6879
7295
  /**
6880
7296
  * Update an existing MessageTemplate
6881
7297
  *