@springtree/eva-services-core-management 3.0.0-beta.20 → 3.0.0-beta.22

package/lib/eva-services-core-management.d.ts

@@ -691,7 +691,7 @@ export interface GetCaseByIDResponse {
     * Entity type: CustomField
     */
     CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
-    Customer?: CasesGetCaseByIDResponse_CustomerInfo;
+    Customer?: CasesGetCaseByIDResponse_UserInfo;
     /**
     * Entity type: User
     */
@@ -752,6 +752,7 @@ export interface CasesGetCaseByIDResponse_CaseRepair {
     * Entity type: Repair
     */
     ID: string;
+    RepairAssignee?: CasesGetCaseByIDResponse_UserInfo;
     RepairTask?: CasesGetCaseByIDResponse_CaseRepairTask;
     SerialNumber?: string;
     SerialNumberRegistrationStatus?: DataModelsSerialNumberRegistrationStatus;
@@ -774,14 +775,6 @@ export interface CasesGetCaseByIDResponse_CaseTopicData {
     TopicID?: string;
     TopicName?: string;
 }
-export interface CasesGetCaseByIDResponse_CustomerInfo {
-    BackendID?: string;
-    EmailAddress?: string;
-    FirstName?: string;
-    FullName?: string;
-    LastName?: string;
-    PhoneNumber?: string;
-}
 export interface CasesGetCaseByIDResponse_RelatedItem {
     /**
     * Entity type: CaseRelatedItem
@@ -811,6 +804,18 @@ export interface CasesGetCaseByIDResponse_User {
     ID?: string;
     LastName?: string;
 }
+export interface CasesGetCaseByIDResponse_UserInfo {
+    BackendID?: string;
+    EmailAddress?: string;
+    FirstName?: string;
+    FullName?: string;
+    /**
+    * Entity type: User
+    */
+    ID: string;
+    LastName?: string;
+    PhoneNumber?: string;
+}
 /**
 * Get case interaction
 */
@@ -1107,6 +1112,12 @@ export interface PushCase {
     Assignee?: CasesPushCase_PushCaseAssignee;
     BackendID: string;
     CaseRelatedItems?: CasesPushCase_PushCaseRelatedItems;
+    /**
+    * The topic that this case is a part of. If a BackendID is provided and a CaseTopic exists with that ID, that CaseTopic is used, no matter what Name or ParentBackendID are passed and if they match.
+    *   If no CaseTopic exists with the given BackendID, but one does exist with the given Name and ParentBackendID, that CaseTopic is used instead, disregarding what BackendID was passed in the request.
+    *   If none of these conditions are met, a new CaseTopic is created.
+    */
+    CaseTopic?: CasesPushCase_PushCaseTopic;
     ClosingTime?: string;
     CustomFields?: Record<string, TAnyValue | null>;
     Customer?: CasesPushCase_PushCaseCustomer;
@@ -1124,7 +1135,7 @@ export interface PushCase {
     Status: string;
     Summary?: string;
     Title: string;
-    Topic: string;
+    Topic?: string;
     /**
     * Setting this to true will update the case information if it already exists instead of throwing an error.
     */
@@ -1245,6 +1256,17 @@ export interface CasesPushCase_PushCaseRelatedItems {
     */
     OrderID?: string;
 }
+export interface CasesPushCase_PushCaseTopic {
+    BackendID: string;
+    /**
+    * Required if pushing and creating a previously non-existent CaseTopic
+    */
+    Name?: string;
+    /**
+    * Provide a ParentID, or nothing if the CaseTopic should be root-level.
+    */
+    ParentBackendID?: string;
+}
 export interface PushCaseResponse {
     Error?: ServiceError;
     /**
@@ -4789,7 +4811,10 @@ export interface CreateDevice {
     * Entity type: Station
     */
     StationID?: string;
-    TypeID: string;
+    /**
+    * Entity type: DeviceType
+    */
+    TypeID?: number;
 }
 export interface CreateDeviceResponse {
     Error?: ServiceError;
@@ -5055,7 +5080,10 @@ export interface UpdateDevice {
     * Entity type: Station
     */
     StationID?: string | null;
-    TypeID?: string;
+    /**
+    * Entity type: DeviceType
+    */
+    TypeID?: number;
 }
 /**
 * Updates an existing OpenCashDrawerReason with a new Name and Description.
@@ -5192,6 +5220,9 @@ export interface UpdateInquiry {
     Name?: string;
     OneTimeUseOnly?: boolean;
     PromptUser?: boolean;
+    /**
+    * Entity type: Script
+    */
     ScriptID?: string | null;
 }
 /**
@@ -6745,6 +6776,9 @@ export interface UpdateLoyaltyProgram {
     */
     ID: string;
     LoyaltyPointUsageOptions?: DataModelsLoyaltyPointUsageOptions;
+    /**
+    * Entity type: LoyaltyProgramGroup
+    */
     LoyaltyProgramGroupID?: string | null;
     Name?: string;
     Options?: DataModelsLoyaltyProgramOptions;
@@ -7216,13 +7250,22 @@ export interface PreviewMessageTemplateResponse {
     Url?: string;
 }
 export interface SendSampleMailMessageTemplate {
+    /**
+    * Entity type: Country
+    */
     CountryID?: string;
     Destination?: DataModelsMessageTemplateDestinations;
     EmailAddress?: string;
     Helpers?: string;
+    /**
+    * Entity type: Language
+    */
     LanguageID?: string;
     Layout?: string;
     Name?: string;
+    /**
+    * Entity type: OrganizationUnit
+    */
     OrganizationUnitID?: string;
     SampleData?: Record<string, TAnyValue>;
     Template?: string;
@@ -7276,7 +7319,7 @@ export interface OrdersCheckoutOptionDto {
     CategoryName: string;
     ConfigData?: Record<string, TAnyValue>;
     Description?: string;
-    Handler: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SerialNumberValidation' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
+    Handler: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
     /**
     * Entity type: CheckoutOption
     */
@@ -7305,7 +7348,7 @@ export interface CreateCheckoutOption {
     CategoryID?: string;
     Data?: OrdersCheckoutOptionsICheckoutOptionConfigData;
     Description?: string;
-    Handler: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SerialNumberValidation' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
+    Handler: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
     IsActive?: boolean;
     Name: string;
     /**
@@ -7710,7 +7753,7 @@ export interface UpdateCheckoutOption {
     CategoryID?: string | null;
     Data?: OrdersCheckoutOptionsICheckoutOptionConfigData | null;
     Description?: string | null;
-    Handler?: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SerialNumberValidation' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
+    Handler?: 'Certification' | 'CustomerReferences' | 'CustomFieldLine' | 'CustomField' | 'Delivery' | 'ElectronicInvoice' | 'FiscalID' | 'FiscalRemark' | 'GiftWrapping' | 'LotteryNumber' | 'OrderBackendIdentifier' | 'PartialShipment' | 'PickupPoint' | 'ProductSearchTemplate' | 'QuickBuy' | 'Remark' | 'RequestedDate' | 'SoldBy' | 'TaxExempt' | 'TaxRegistrationNumber' | 'VerifyOrder' | 'SignOrder' | 'GlobalBlue';
     /**
     * Entity type: CheckoutOption
     */
@@ -8049,6 +8092,19 @@ export interface PreviewOrganizationUnitSetResponse {
     Set?: OrganizationUnitSetsOrganizationUnitSetDetails;
 }
 /**
+* Takes in all subsets of an organization unit set and sets their sequences. All subsets are required.
+*/
+export interface SetOrganizationUnitSubsetSequences {
+    /**
+    * Entity type: OrganizationUnitSet
+    */
+    OrganizationUnitSetID: string;
+    /**
+    * Entity type: OrganizationUnitSet
+    */
+    SubsetIDs: string[];
+}
+/**
 * Updates an OrganizationUnitSet.
 *
 *   Optionally a definition can be provided, which defines a set of filters.
@@ -8198,6 +8254,9 @@ export interface DeleteOrganizationUnitCurrency {
     ID: string;
 }
 export interface DeleteOrganizationUnitGroup {
+    /**
+    * Entity type: OrganizationUnitGroup
+    */
     ID: string;
 }
 /**
@@ -8828,6 +8887,9 @@ export interface ListPaymentTransactionSettlements {
     MerchantReference?: string;
     PaymentReference?: string;
     SubType?: string;
+    /**
+    * Entity type: PaymentTransactionSettlementType
+    */
     TypeID?: string;
 }
 /**
@@ -10974,6 +11036,9 @@ export interface RightsFunctionalityWithScope {
     Scope?: SecurityFunctionalityScope;
 }
 export interface GetAvailableRoles {
+    /**
+    * Entity type: User
+    */
     UserID: string;
 }
 export interface GetAvailableRolesResponse {
@@ -11488,6 +11553,9 @@ export interface CreateShippingCost {
 }
 export interface CreateShippingCostResponse {
     Error?: ServiceError;
+    /**
+    * Entity type: ShippingCost
+    */
     ID: string;
     Metadata?: ResponseMessageMetadata;
 }
@@ -11500,6 +11568,10 @@ export interface CreateShippingMethod {
     */
     CarrierID: string;
     Code?: string;
+    /**
+    * Optional additional custom fields
+    */
+    CustomFields?: DataModelsCustomFieldKeyValue[];
     DeliveryType?: DataModelsShippingMethodDeliveryTypes;
     ExcludeProductsFromShippingMethod?: boolean;
     Handler?: string;
@@ -11617,6 +11689,9 @@ export interface DeletePackage {
 * Delete a `ShippingCost`
 */
 export interface DeleteShippingCost {
+    /**
+    * Entity type: ShippingCost
+    */
     ID: string;
 }
 /**
@@ -11728,15 +11803,30 @@ export interface GetShippingCostByID {
 export interface GetShippingCostByIDResponse {
     Amount: number;
     BackendID?: string;
+    /**
+    * Entity type: Country
+    */
     CountryID?: string;
+    /**
+    * Entity type: Currency
+    */
     CurrencyID?: string;
     Error?: ServiceError;
+    /**
+    * Entity type: ShippingCost
+    */
     ID: string;
     MaximumOrderAmount?: number;
     Metadata?: ResponseMessageMetadata;
     MinimumOrderAmount?: number;
+    /**
+    * Entity type: OrganizationUnit
+    */
     OrganizationUnitID?: string;
     OrganizationUnitName?: string;
+    /**
+    * Entity type: ShippingMethod
+    */
     ShippingMethodID?: string;
     ShippingMethodName?: string;
     ZipCodes?: string[];
@@ -11758,6 +11848,10 @@ export interface GetShippingMethodByIDResponse {
     CarrierID: string;
     CarrierName?: string;
     Code?: string;
+    /**
+    * Entity type: CustomField
+    */
+    CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
     DeliveryType: DataModelsShippingMethodDeliveryTypes;
     Error?: ServiceError;
     ExcludeProductsFromShippingMethod: boolean;
@@ -11851,6 +11945,10 @@ export interface ShippingListManagementShippingMethodsResponse_Data {
     CarrierID: string;
     CarrierName?: string;
     Code?: string;
+    /**
+    * Entity type: CustomField
+    */
+    CustomFieldValuesWithOptions?: Record<string, DataModelsCustomFieldValueWithOptions>;
     DeliveryType: DataModelsShippingMethodDeliveryTypes;
     Handler?: string;
     /**
@@ -11984,13 +12082,28 @@ export interface RemovePackageFromCarrier {
 export interface ShippingShippingCostDto {
     Amount: number;
     BackendID?: string;
+    /**
+    * Entity type: Country
+    */
     CountryID?: string;
+    /**
+    * Entity type: Currency
+    */
     CurrencyID?: string;
+    /**
+    * Entity type: ShippingCost
+    */
     ID: string;
     MaximumOrderAmount?: number;
     MinimumOrderAmount?: number;
+    /**
+    * Entity type: OrganizationUnit
+    */
     OrganizationUnitID?: string;
     OrganizationUnitName?: string;
+    /**
+    * Entity type: ShippingMethod
+    */
     ShippingMethodID?: string;
     ShippingMethodName?: string;
     ZipCodes?: string[];
@@ -12100,6 +12213,9 @@ export interface UpdateShippingCost {
     * Entity type: Currency
     */
     CurrencyID: string;
+    /**
+    * Entity type: ShippingCost
+    */
     ID: string;
     MaximumOrderAmount?: number;
     MinimumOrderAmount?: number;
@@ -12122,6 +12238,7 @@ export interface UpdateShippingMethod {
     */
     CarrierID: string;
     Code?: string;
+    CustomFields?: DataModelsCustomFieldKeyValue[] | null;
     DeliveryType?: DataModelsShippingMethodDeliveryTypes;
     ExcludeProductsFromShippingMethod?: boolean;
     Handler?: string;
@@ -12192,6 +12309,9 @@ export interface UpdateShippingRestriction {
     */
     ProductPropertyTypeID?: string | null;
     ProductPropertyTypeValues?: string[] | null;
+    /**
+    * Entity type: ProductSearchTemplate
+    */
     ProductSearchTemplateID?: string | null;
     /**
     * Entity type: Script
@@ -12340,6 +12460,9 @@ export interface ListStockAllocationRulesResponse {
 * Reallocates the stock for a StockLocationRule with `Type` = `Limitation`.
 */
 export interface RefillStockAllocation {
+    /**
+    * Entity type: StockAllocationRule
+    */
     ID: string;
     ValueOverride?: number;
 }