feat: refactor shipment functions to standardize service naming and improve parameter handling

Author: nicosammito

actions/gls-action/src/functions/cancelShipmentFunction.ts

@@ -1,3 +1,5 @@
+//TODO: Why is the request data here wrapped within a object and isn't a direct parameter
+
 import {
     Description,
     DisplayMessage,
@@ -40,7 +42,7 @@ export class CancelShipmentFunction {
             if (typeof error === "string") {
                 throw new RuntimeError("ERROR_CREATING_GLS_SHIPMENT", error);
             }
-            throw new RuntimeError("ERROR_CREATING_GLS_SHIPMENT", "An error occurred while creating the shipment.");
+            throw new RuntimeError("ERROR_CREATING_GLS_SHIPMENT", "An error occurred while cancelling the GLS shipment.");
         }
     }
 }

actions/gls-action/src/functions/getAllowedServicesFunction.ts

@@ -1,3 +1,5 @@
+//TODO: Why is the request data here wrapped within a object and isn't a direct parameter of 3
+
 import axios from "axios";
 import {
     Description,
@@ -49,7 +51,7 @@ export class GetAllowedServicesFunction {
             if (typeof error === "string") {
                 throw new RuntimeError("ERROR_CREATING_GLS_SHIPMENT", error);
             }
-            throw new RuntimeError("ERROR_CREATING_GLS_SHIPMENT", "An error occurred while creating the shipment.");
+            throw new RuntimeError("ERROR_CREATING_GLS_SHIPMENT", "An error occurred while fetching the allowed GLS services.");
         }
     }
 }

actions/gls-action/src/functions/getEndOfDayReportFunction.ts

@@ -1,3 +1,5 @@
+//TODO: Why is the request data here wrapped within a object and isn't a direct parameter
+
 import axios from "axios";
 import {
     Description,

actions/gls-action/src/functions/reprintParcelFunction.ts

@@ -1,3 +1,5 @@
+//TODO: Outsource this into seperate functions for trackid, parcelnumber, references, etc.
+
 import axios from "axios";
 import {
     Description,

actions/gls-action/src/functions/services/_shared.ts

@@ -1,7 +1,7 @@
 import { Parameter } from "@code0-tech/hercules";
 
 export const SHARED_SERVICE_SIGNATURE =
-    "shipment: GLS_SHIPMENT_WITHOUT_SERVICES, printingOptions: GLS_PRINTING_OPTIONS, returnOptions?: GLS_RETURN_OPTIONS, customContent?: GLS_CUSTOM_CONTENT";
+    "shipment: GLS_SHIPMENT_WITHOUT_SERVICES, printingOptions: GLS_PRINTING_OPTIONS, customContent?: GLS_CUSTOM_CONTENT, returnOptions?: GLS_RETURN_OPTIONS";
 
 export const SharedShipmentParameter = Parameter({
     runtimeName: "shipment",

actions/gls-action/src/functions/services/createAddresseeOnlyShipmentFunction.ts

@@ -45,6 +45,6 @@ export class CreateAddresseeOnlyShipmentFunction {
         customContent?: CustomContent,
         returnOptions?: ReturnOptions
     ): Promise<CreateParcelsResponse> {
-        return postShipmentHelper(context, [{ AddresseeOnlyService: {} }], shipment, printingOptions, customContent, returnOptions);
+        return postShipmentHelper(context, [{ Service: { ServiceName: "service_addresseeonly" } }], shipment, printingOptions, customContent, returnOptions);
     }
 }

actions/gls-action/src/functions/services/createDeliveryNextWorkingDayShipmentFunction.ts

@@ -49,6 +49,6 @@ export class CreateDeliveryNextWorkingDayShipmentFunction {
         if (shipment.Product != "EXPRESS") {
             throw new RuntimeError("INVALID_PRODUCT", "The product for Delivery Next Working Day service must be EXPRESS.");
         }
-        return postShipmentHelper(context, [{ EOB: {} }], shipment, printingOptions, customContent, returnOptions);
+        return postShipmentHelper(context, [{ Service: { ServiceName: "service_eob" } }], shipment, printingOptions, customContent, returnOptions);
     }
 }

actions/gls-action/src/functions/services/createDeliverySaturdayShipmentFunction.ts

@@ -43,6 +43,6 @@ export class CreateDeliverySaturdayShipmentFunction {
         if (shipment.Product != "EXPRESS") {
             throw new RuntimeError("INVALID_PRODUCT", "The product for Delivery Saturday service must be EXPRESS.");
         }
-        return postShipmentHelper(context, [{ SaturdayService: {} }], shipment, printingOptions, customContent, returnOptions);
+        return postShipmentHelper(context, [{ Service: { ServiceName: "service_Saturday" } }], shipment, printingOptions, customContent, returnOptions);
     }
 }

actions/gls-action/src/functions/services/createFlexDeliveryShipmentFunction.ts

@@ -1,5 +1,5 @@
 import {
-    Description,
+    Description, DisplayIcon,
     DisplayMessage,
     Documentation,
     FunctionContext,
@@ -24,7 +24,8 @@ import {
 @Identifier("createFlexDeliveryShipment")
 @Signature(`(${SHARED_SERVICE_SIGNATURE}): GLS_CREATE_PARCELS_RESPONSE`)
 @Name({ code: "en-US", content: "Create flex delivery shipment" })
-@DisplayMessage({ code: "en-US", content: "Create flex delivery shipment" })
+@DisplayIcon("tabler:truck-delivery")
+@DisplayMessage({ code: "en-US", content: "Send flex delivery shipment" })
 @Documentation({
     code: "en-US",
     content: "Creates a shipment with flexible delivery - the recipient can redirect or reschedule delivery.",
@@ -45,6 +46,6 @@ export class CreateFlexDeliveryShipmentFunction {
         customContent?: CustomContent,
         returnOptions?: ReturnOptions
     ): Promise<CreateParcelsResponse> {
-        return postShipmentHelper(context, [{ FlexDeliveryService: {} }], shipment, printingOptions, customContent, returnOptions);
+        return postShipmentHelper(context, [{ Service: { ServiceName: "service_flexdelivery" } }], shipment, printingOptions, customContent, returnOptions);
     }
 }

actions/gls-action/src/functions/services/createGuaranteed24ShipmentFunction.ts

@@ -45,6 +45,6 @@ export class CreateGuaranteed24ShipmentFunction {
         customContent?: CustomContent,
         returnOptions?: ReturnOptions
     ): Promise<CreateParcelsResponse> {
-        return postShipmentHelper(context, [{ Guaranteed24Service: {} }], shipment, printingOptions, customContent, returnOptions);
+        return postShipmentHelper(context, [{ Service: { ServiceName: "service_guaranteed24" } }], shipment, printingOptions, customContent, returnOptions);
     }
 }