Merge pull request #28 from code0-tech/feat/#27

nicosammito · web-flow · commit 66fd9a7e537f · 2026-07-11T21:00:49.000+02:00
Unwrap GLS paramater functions
diff --git a/actions/gls-action/src/data_types/glsReprintParcel.ts b/actions/gls-action/src/data_types/glsReprintParcel.ts
@@ -1,5 +1,6 @@
 import { DisplayMessage, Identifier, Name, Schema } from "@code0-tech/hercules";
 import { z } from "zod";
+import { ReturnLabelsSchema } from "./glsPrintingOptions.js";
 
 export const ReprintParcelRequestDataSchema = z.object({
     TrackID: z.string().max(8).optional(),
@@ -9,10 +10,7 @@ export const ReprintParcelRequestDataSchema = z.object({
     PartnerParcelNumber: z.string().max(50).optional(),
     CreationDate: z.iso.date(),
     PrintingOptions: z.object({
-        ReturnLabels: z.object({
-            TemplateSet: z.enum(["NONE", "ZPL_200", "ZPL_300"]),
-            LabelFormat: z.enum(["PDF", "ZEBRA", "PNG", "PNG_200"]),
-        }),
+        ReturnLabels: ReturnLabelsSchema,
     }),
 });
 export type ReprintParcelRequestData = z.infer<typeof ReprintParcelRequestDataSchema>;
diff --git a/actions/gls-action/src/functions/cancelShipmentFunction.ts b/actions/gls-action/src/functions/cancelShipmentFunction.ts
@@ -1,7 +1,6 @@
-//TODO: Why is the request data here wrapped within a object and isn't a direct parameter
-
 import {
-    Description, DisplayIcon,
+    Description,
+    DisplayIcon,
     DisplayMessage,
     Documentation,
     FunctionContext,
@@ -11,17 +10,14 @@ import {
     RuntimeError,
     Signature,
 } from "@code0-tech/hercules";
-import { cancelShipment } from "../helpers.js";
-import {
-    CancelShipmentRequestData,
-    CancelShipmentResponseData,
-} from "../data_types/glsCancelShipment.js";
+import {cancelShipment} from "../helpers.js";
+import {CancelShipmentResponseData} from "../data_types/glsCancelShipment.js";
 
 @Identifier("cancelShipment")
 @DisplayIcon("codezero:gls")
-@Signature("(data: GLS_CANCEL_SHIPMENT_REQUEST_DATA): GLS_CANCEL_SHIPMENT_RESPONSE_DATA")
-@Name({ code: "en-US", content: "Cancel shipment" })
-@DisplayMessage({ code: "en-US", content: "Cancel shipment" })
+@Signature("(TrackID: string): GLS_CANCEL_SHIPMENT_RESPONSE_DATA")
+@Name({code: "en-US", content: "Cancel shipment"})
+@DisplayMessage({code: "en-US", content: "Cancel shipment"})
 @Documentation({
     code: "en-US",
     content: "Cancels an existing shipment by its Track ID. Only possible if the parcel has not yet been scanned.",
@@ -31,14 +27,16 @@ import {
     content: "Cancels an existing shipment by its Track ID. Only possible if the parcel has not yet been scanned.",
 })
 @Parameter({
-    runtimeName: "data",
-    name: [{ code: "en-US", content: "Data" }],
-    description: [{ code: "en-US", content: "The cancel shipment request data." }],
+    runtimeName: "TrackID",
+    name: [{code: "en-US", content: "Track ID"}],
+    description: [{code: "en-US", content: "The Track ID of the shipment to cancel."}],
 })
 export class CancelShipmentFunction {
-    async run(context: FunctionContext, data: CancelShipmentRequestData): Promise<CancelShipmentResponseData> {
+    async run(context: FunctionContext, TrackID: string): Promise<CancelShipmentResponseData> {
         try {
-            return await cancelShipment(data, context);
+            return await cancelShipment({
+                TrackID
+            }, context);
         } catch (error) {
             if (typeof error === "string") {
                 throw new RuntimeError("ERROR_CREATING_GLS_SHIPMENT", error);
diff --git a/actions/gls-action/src/functions/getAllowedServicesFunction.ts b/actions/gls-action/src/functions/getAllowedServicesFunction.ts
@@ -1,5 +1,3 @@
-//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, DisplayIcon,
@@ -14,14 +12,13 @@ import {
 } from "@code0-tech/hercules";
 import { getAuthToken } from "../helpers.js";
 import {
-    AllowedServicesRequestData,
     AllowedServicesResponseData,
     AllowedServicesResponseDataSchema,
 } from "../data_types/glsAllowedServices.js";
 
 @Identifier("getAllowedServices")
 @DisplayIcon("codezero:gls")
-@Signature("(data: GLS_ALLOWED_SERVICES_REQUEST_DATA): GLS_ALLOWED_SERVICES_RESPONSE_DATA")
+@Signature("(SourceCountryCode: string, SourceZIPCode: string, DestinationCountryCode: string, DestinationZIPCode: string, ContactID?: string): GLS_ALLOWED_SERVICES_RESPONSE_DATA")
 @Name({ code: "en-US", content: "Get allowed services" })
 @DisplayMessage({ code: "en-US", content: "Get allowed services" })
 @Documentation({
@@ -33,20 +30,62 @@ import {
     content: "Returns the GLS services available for a given origin/destination country and ZIP code combination.",
 })
 @Parameter({
-    runtimeName: "data",
-    name: [{ code: "en-US", content: "Data" }],
-    description: [{ code: "en-US", content: "The allowed services request data." }],
+    runtimeName: "SourceCountryCode",
+    name: [{ code: "en-US", content: "Source country code" }],
+    description: [{ code: "en-US", content: "The ISO alpha-2 country code of the origin. For example, DE for Germany." }],
+})
+@Parameter({
+    runtimeName: "SourceZIPCode",
+    name: [{ code: "en-US", content: "Source ZIP code" }],
+    description: [{ code: "en-US", content: "The ZIP code of the origin. Max length is 10 characters." }],
+})
+@Parameter({
+    runtimeName: "DestinationCountryCode",
+    name: [{ code: "en-US", content: "Destination country code" }],
+    description: [{ code: "en-US", content: "The ISO alpha-2 country code of the destination. For example, FR for France." }],
+})
+@Parameter({
+    runtimeName: "DestinationZIPCode",
+    name: [{ code: "en-US", content: "Destination ZIP code" }],
+    description: [{ code: "en-US", content: "The ZIP code of the destination. Max length is 10 characters." }],
+})
+@Parameter({
+    runtimeName: "ContactID",
+    name: [{ code: "en-US", content: "Contact ID" }],
+    description: [{ code: "en-US", content: "The GLS contact ID to use for the request." }],
+    optional: true,
 })
 export class GetAllowedServicesFunction {
-    async run(context: FunctionContext, data: AllowedServicesRequestData): Promise<AllowedServicesResponseData> {
+    async run(
+        context: FunctionContext,
+        SourceCountryCode: string,
+        SourceZIPCode: string,
+        DestinationCountryCode: string,
+        DestinationZIPCode: string,
+        ContactID?: string
+    ): Promise<AllowedServicesResponseData> {
         try {
             const url = context.matchedConfig.findConfig("ship_it_api_url") as string;
-            const result = await axios.post(`${url}/rs/shipments/allowedservices`, data, {
-                headers: {
-                    Authorization: `Bearer ${await getAuthToken(context)}`,
-                    "Content-Type": "application/glsVersion1+json",
+            const result = await axios.post(
+                `${url}/rs/shipments/allowedservices`,
+                {
+                    Source: {
+                        CountryCode: SourceCountryCode,
+                        ZIPCode: SourceZIPCode,
+                    },
+                    Destination: {
+                        CountryCode: DestinationCountryCode,
+                        ZIPCode: DestinationZIPCode,
+                    },
+                    ContactID,
                 },
-            });
+                {
+                    headers: {
+                        Authorization: `Bearer ${await getAuthToken(context)}`,
+                        "Content-Type": "application/glsVersion1+json",
+                    },
+                }
+            );
             return AllowedServicesResponseDataSchema.parse(result.data);
         } catch (error) {
             if (typeof error === "string") {
diff --git a/actions/gls-action/src/functions/getEndOfDayReportFunction.ts b/actions/gls-action/src/functions/getEndOfDayReportFunction.ts
@@ -1,5 +1,3 @@
-//TODO: Why is the request data here wrapped within a object and isn't a direct parameter
-
 import axios from "axios";
 import {
     Description, DisplayIcon,
@@ -14,14 +12,13 @@ import {
 } from "@code0-tech/hercules";
 import { getAuthToken } from "../helpers.js";
 import {
-    EndOfDayRequestData,
     EndOfDayResponseData,
     EndOfDayResponseDataSchema,
 } from "../data_types/glsEndOfDay.js";
 
 @Identifier("getEndOfDayReport")
 @DisplayIcon("codezero:gls")
-@Signature("(data: GLS_END_OF_DAY_REQUEST_DATA): GLS_END_OF_DAY_RESPONSE_DATA")
+@Signature("(date: string): GLS_END_OF_DAY_RESPONSE_DATA")
 @Name({ code: "en-US", content: "Get end of day report" })
 @DisplayMessage({ code: "en-US", content: "Get end of day report" })
 @Documentation({
@@ -33,17 +30,17 @@ import {
     content: "Retrieves all shipments dispatched on a given date. Useful for reconciliation and end-of-day processing.",
 })
 @Parameter({
-    runtimeName: "data",
-    name: [{ code: "en-US", content: "Data" }],
-    description: [{ code: "en-US", content: "The end of day report request data." }],
+    runtimeName: "date",
+    name: [{ code: "en-US", content: "Date" }],
+    description: [{ code: "en-US", content: "The dispatch date to retrieve shipments for, in ISO format (YYYY-MM-DD)." }],
 })
 export class GetEndOfDayReportFunction {
-    async run(context: FunctionContext, data: EndOfDayRequestData): Promise<EndOfDayResponseData> {
+    async run(context: FunctionContext, date: string): Promise<EndOfDayResponseData> {
         const url = context.matchedConfig.findConfig("ship_it_api_url") as string;
 
         try {
             const result = await axios.post(
-                `${url}/rs/shipments/endofday?date=${data.date}`,
+                `${url}/rs/shipments/endofday?date=${date}`,
                 {},
                 {
                     headers: {
diff --git a/actions/gls-action/src/functions/reprintParcelFunction.ts b/actions/gls-action/src/functions/reprintParcelFunction.ts
@@ -14,14 +14,14 @@ import {
 } from "@code0-tech/hercules";
 import { getAuthToken } from "../helpers.js";
 import {
-    ReprintParcelRequestData,
     ReprintParcelResponseData,
     ReprintParcelResponseDataSchema,
 } from "../data_types/glsReprintParcel.js";
+import { ReturnLabels } from "../data_types/glsPrintingOptions.js";
 
 @Identifier("reprintParcel")
 @DisplayIcon("codezero:gls")
-@Signature("(data: GLS_REPRINT_PARCEL_REQUEST_DATA): GLS_REPRINT_PARCEL_RESPONSE_DATA")
+@Signature("(CreationDate: string, TemplateSet: \"NONE\"|\"D_200\"|\"PF_4_I\"|\"PF_4_I_200\"|\"PF_4_I_300\"|\"PF_8_D_200\"|\"T_200_BF\"|\"T_300_BF\"|\"ZPL_200\"|\"ZPL_200_TRACKID_EAN_128\"|\"ZPL_200_TRACKID_CODE_39\"|\"ZPL_200_REFNO_EAN_128\"|\"ZPL_200_REFNO_CODE_39\"|\"ZPL_300\"|\"ZPL_300_TRACKID_EAN_128\"|\"ZPL_300_TRACKID_CODE_39\"|\"ZPL_300_REFNO_EAN_128\"|\"ZPL_300_REFNO_CODE_39\", LabelFormat: \"PDF\"|\"ZEBRA\"|\"INTERMEC\"|\"DATAMAX\"|\"TOSHIBA\"|\"PNG\", TrackID?: string, ParcelNumber?: number, ShipmentReference?: string, ShipmentUnitReference?: string, PartnerParcelNumber?: string): GLS_REPRINT_PARCEL_RESPONSE_DATA")
 @Name({ code: "en-US", content: "Reprint parcel" })
 @DisplayMessage({ code: "en-US", content: "Reprint parcel" })
 @Documentation({
@@ -33,21 +33,88 @@ import {
     content: "Reprints the label for an existing parcel.\nUse this if the original label is damaged, lost, or needs to be printed in a different format.",
 })
 @Parameter({
-    runtimeName: "data",
-    name: [{ code: "en-US", content: "Data" }],
-    description: [{ code: "en-US", content: "The reprint parcel request data." }],
+    runtimeName: "CreationDate",
+    name: [{ code: "en-US", content: "Creation date" }],
+    description: [{ code: "en-US", content: "The creation date of the parcel, in ISO format (YYYY-MM-DD)." }],
+})
+@Parameter({
+    runtimeName: "TemplateSet",
+    name: [{ code: "en-US", content: "Template set" }],
+    description: [{ code: "en-US", content: "The template set to use for the reprinted label." }],
+})
+@Parameter({
+    runtimeName: "LabelFormat",
+    name: [{ code: "en-US", content: "Label format" }],
+    description: [{ code: "en-US", content: "The format of the reprinted label." }],
+})
+@Parameter({
+    runtimeName: "TrackID",
+    name: [{ code: "en-US", content: "Track ID" }],
+    description: [{ code: "en-US", content: "The Track ID of the parcel to reprint. Max length is 8 characters." }],
+    optional: true,
+})
+@Parameter({
+    runtimeName: "ParcelNumber",
+    name: [{ code: "en-US", content: "Parcel number" }],
+    description: [{ code: "en-US", content: "The parcel number of the parcel to reprint." }],
+    optional: true,
+})
+@Parameter({
+    runtimeName: "ShipmentReference",
+    name: [{ code: "en-US", content: "Shipment reference" }],
+    description: [{ code: "en-US", content: "The shipment reference of the parcel to reprint. Max length is 40 characters." }],
+    optional: true,
+})
+@Parameter({
+    runtimeName: "ShipmentUnitReference",
+    name: [{ code: "en-US", content: "Shipment unit reference" }],
+    description: [{ code: "en-US", content: "The shipment unit reference of the parcel to reprint. Max length is 40 characters." }],
+    optional: true,
+})
+@Parameter({
+    runtimeName: "PartnerParcelNumber",
+    name: [{ code: "en-US", content: "Partner parcel number" }],
+    description: [{ code: "en-US", content: "The partner parcel number of the parcel to reprint. Max length is 50 characters." }],
+    optional: true,
 })
 export class ReprintParcelFunction {
-    async run(context: FunctionContext, data: ReprintParcelRequestData): Promise<ReprintParcelResponseData> {
+    async run(
+        context: FunctionContext,
+        CreationDate: string,
+        TemplateSet: ReturnLabels["TemplateSet"],
+        LabelFormat: ReturnLabels["LabelFormat"],
+        TrackID?: string,
+        ParcelNumber?: number,
+        ShipmentReference?: string,
+        ShipmentUnitReference?: string,
+        PartnerParcelNumber?: string
+    ): Promise<ReprintParcelResponseData> {
         const url = context.matchedConfig.findConfig("ship_it_api_url") as string;
 
         try {
-            const result = await axios.post(`${url}/rs/shipments/reprintparcel`, data, {
-                headers: {
-                    Authorization: `Bearer ${await getAuthToken(context)}`,
-                    "Content-Type": "application/glsVersion1+json",
+            const result = await axios.post(
+                `${url}/rs/shipments/reprintparcel`,
+                {
+                    TrackID,
+                    ParcelNumber,
+                    ShipmentReference,
+                    ShipmentUnitReference,
+                    PartnerParcelNumber,
+                    CreationDate,
+                    PrintingOptions: {
+                        ReturnLabels: {
+                            TemplateSet,
+                            LabelFormat,
+                        },
+                    },
                 },
-            });
+                {
+                    headers: {
+                        Authorization: `Bearer ${await getAuthToken(context)}`,
+                        "Content-Type": "application/glsVersion1+json",
+                    },
+                }
+            );
             return ReprintParcelResponseDataSchema.parse(result.data);
         } catch (error: any) {
             console.log(error);
diff --git a/actions/gls-action/src/functions/updateParcelWeightFunction.ts b/actions/gls-action/src/functions/updateParcelWeightFunction.ts
diff --git a/actions/gls-action/src/functions/validateShipmentFunction.ts b/actions/gls-action/src/functions/validateShipmentFunction.ts
