feat: refactor getAllowedServicesFunction to accept individual parameters instead of a single object

Author: nicosammito

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,61 @@ 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." }],
 })
 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") {