Add documentation for shipment-related functions

Author: Knerio

actions/gls-action/scripts/generateDocs.ts

@@ -362,11 +362,11 @@ ${JSON.stringify(generateDefinition, null, 4)}
 }
 
 run().then(async (sdk) => {
-    // writeFileSync(
-    //     "../../docs/Actions/GLS/types.mdx",
-    //     generateDatatypes(),
-    //     "utf8"
-    // )
+    writeFileSync(
+        "../../docs/Actions/GLS/types.mdx",
+        generateDatatypes(),
+        "utf8"
+    )
 
     writeFileSync(
         "../../docs/Actions/GLS/functions.mdx",

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

@@ -7,6 +7,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "cancelShipment",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Cancels an existing shipment by its Track ID. Only possible if the parcel has not yet been scanned."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -22,7 +28,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Cancels a GLS shipment.",
+                        content: "Cancels an existing shipment by its Track ID. Only possible if the parcel has not yet been scanned.",
                     }
                 ],
                 signature: "(data: GLS_CANCEL_SHIPMENT_REQUEST_DATA): GLS_CANCEL_SHIPMENT_RESPONSE_DATA",

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

@@ -12,6 +12,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "getAllowedServices",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Returns the GLS services available for a given origin/destination country and ZIP code combination."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -27,7 +33,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Returns the allowed GLS services for a given set of parameters.",
+                        content: "Returns the GLS services available for a given origin/destination country and ZIP code combination.",
                     }
                 ],
                 signature: "(data: GLS_ALLOWED_SERVICES_REQUEST_DATA): GLS_ALLOWED_SERVICES_RESPONSE_DATA",

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

@@ -8,6 +8,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "getEndOfDayReport",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Retrieves all shipments dispatched on a given date. Useful for reconciliation and end-of-day processing."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -23,7 +29,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Returns the GLS end of day report.",
+                        content: "Retrieves all shipments dispatched on a given date. Useful for reconciliation and end-of-day processing.",
                     }
                 ],
                 signature: "(data: GLS_END_OF_DAY_REQUEST_DATA): GLS_END_OF_DAY_RESPONSE_DATA",

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

@@ -12,6 +12,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "reprintParcel",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Reprints the label for an existing parcel. Use this if the original label is damaged, lost, or needs to be printed in a different format."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -27,7 +33,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Reprints the labels for a GLS parcel.",
+                        content: "Reprints the label for an existing parcel. Use this if the original label is damaged, lost, or needs to be printed in a different format.",
                     }
                 ],
                 signature: "(data: GLS_REPRINT_PARCEL_REQUEST_DATA): GLS_REPRINT_PARCEL_RESPONSE_DATA",

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

@@ -15,6 +15,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "createAddresseeOnlyShipment",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Creates a shipment that can only be delivered to the named addressee (no neighbor delivery)."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -30,7 +36,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Creates a GLS addressee only shipment.",
+                        content: "Creates a shipment that can only be delivered to the named addressee (no neighbor delivery).",
                     }
                 ],
                 signature: `(${DEFAULT_SIGNATURE_FOR_SERVICES}): GLS_CREATE_PARCELS_RESPONSE`,

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

@@ -15,6 +15,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "createDeliveryAtWorkShipment",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Delivers a parcel to a specific location within a workplace (building, floor, room)."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -30,7 +36,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Creates a GLS delivery at work shipment.",
+                        content: "Delivers a parcel to a specific location within a workplace (building, floor, room).",
                     }
                 ],
                 signature: `(recipientName: string, building: string, floor: number, ${DEFAULT_SIGNATURE_FOR_SERVICES}, alternateRecipientName?: string, room?: number, phonenumber?: string): GLS_CREATE_PARCELS_RESPONSE`,

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

@@ -15,6 +15,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "createDeliveryNextWorkingDayShipment",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Creates an EXPRESS shipment for delivery on the next working day (EOB service)."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -30,7 +36,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Creates a GLS delivery next working day shipment.",
+                        content: "Creates an EXPRESS shipment for delivery on the next working day (EOB service).",
                     }
                 ],
                 signature: `(${DEFAULT_SIGNATURE_FOR_SERVICES}): GLS_CREATE_PARCELS_RESPONSE`,

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

@@ -16,6 +16,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "createDeliverySaturdayShipment",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Creates an EXPRESS shipment for Saturday delivery."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -31,7 +37,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Creates a GLS delivery Saturday shipment.",
+                        content: "Creates an EXPRESS shipment for Saturday delivery.",
                     }
                 ],
                 signature: `(${DEFAULT_SIGNATURE_FOR_SERVICES}): GLS_CREATE_PARCELS_RESPONSE`,

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

@@ -16,6 +16,12 @@ export default (sdk: ActionSdk) => {
         {
             definition: {
                 runtimeName: "createDepositShipment",
+                documentation: [
+                    {
+                        code: "en-US",
+                        content: "Delivers a parcel to a designated deposit location (e.g. a garage or shed) without requiring a signature."
+                    }
+                ],
                 displayMessage: [
                     {
                         code: "en-US",
@@ -31,7 +37,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Creates a GLS deposit shipment.",
+                        content: "Delivers a parcel to a designated deposit location (e.g. a garage or shed) without requiring a signature.",
                     }
                 ],
                 signature: `(placeOfDeposit: string, ${DEFAULT_SIGNATURE_FOR_SERVICES}): GLS_CREATE_PARCELS_RESPONSE`,