Update generated docs to comply with linter

Author: Taucher2003

actions/gls-action/scripts/generateDocs.ts

@@ -15,7 +15,7 @@ export function createGlsDocsConfig(): StandardActionDocsConfig {
             title: "Datatypes",
             description: "All data types registered by the GLS Action.",
             heading: "GLS Action Types",
-            intro: `The GLS Action registers the following data types with the Hercules platform. These types are used as inputs and outputs of the GLS functions and can be referenced in your flows.`,
+            intro: `The GLS Action registers the following data types with the Hercules platform.\nThese types are used as inputs and outputs of the GLS functions and can be referenced in your flows.`,
         },
         functionsCopy: {
             title: "Functions",
@@ -33,7 +33,8 @@ export function createGlsDocsConfig(): StandardActionDocsConfig {
             },
             {
                 heading: "Shipment functions",
-                intro: `All shipment functions accept a common set of parameters in addition to their type-specific parameters. They call the GLS ShipIT API (\`POST /rs/shipments\`) and return a \`GLS_CREATE_PARCELS_RESPONSE\`.
+                intro: `All shipment functions accept a common set of parameters in addition to their type-specific parameters.
+They call the GLS ShipIT API (\`POST /rs/shipments\`) and return a \`GLS_CREATE_PARCELS_RESPONSE\`.
 
 **Common parameters for all shipment functions:**
 

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

@@ -15,7 +15,7 @@ export default (sdk: ActionSdk) => {
                 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."
+                        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."
                     }
                 ],
                 displayMessage: [
@@ -33,7 +33,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         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.",
+                        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.",
                     }
                 ],
                 signature: "(data: GLS_REPRINT_PARCEL_REQUEST_DATA): GLS_REPRINT_PARCEL_RESPONSE_DATA",

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

@@ -15,7 +15,7 @@ export default (sdk: ActionSdk) => {
                 documentation: [
                     {
                         code: "en-US",
-                        content: "Validates a shipment against the GLS API without creating it. Use this before `createShipment` functions to catch errors early."
+                        content: "Validates a shipment against the GLS API without creating it.\nUse this before `createShipment` functions to catch errors early."
                     }
                 ],
                 displayMessage: [
@@ -33,7 +33,7 @@ export default (sdk: ActionSdk) => {
                 description: [
                     {
                         code: "en-US",
-                        content: "Validates a shipment against the GLS API without creating it. Use this before `createShipment` functions to catch errors early.",
+                        content: "Validates a shipment against the GLS API without creating it.\nUse this before `createShipment` functions to catch errors early.",
                     }
                 ],
                 signature: "(data: GLS_VALIDATE_SHIPMENT_REQUEST_DATA): GLS_VALIDATE_SHIPMENT_RESPONSE_DATA",

docs/Actions/GLS/functions.mdx

@@ -13,7 +13,6 @@ The GLS Action exposes functions grouped into three categories:
 
 ## Builder functions
 
-
 ### `createShipmentUnit`
 
 | Parameter | Name | Type | Required | Description |
@@ -27,8 +26,6 @@ The GLS Action exposes functions grouped into three categories:
 
 Return Type: [GLS_SHIPMENT_UNIT](./types.mdx#gls_shipment_unit)
 
-#
-
 Creates a GLS shipment unit (an individual parcel within a shipment).
 
 <FunctionCard definition={
@@ -159,8 +156,6 @@ Creates a GLS shipment unit (an individual parcel within a shipment).
 
 Return Type: [GLS_PRINTING_OPTIONS](./types.mdx#gls_printing_options)
 
-#
-
 Creates GLS printing options that control how labels are generated.
 
 <FunctionCard definition={
@@ -220,8 +215,6 @@ Creates GLS printing options that control how labels are generated.
 
 Return Type: [GLS_CUSTOM_CONTENT](./types.mdx#gls_custom_content)
 
-#
-
 Creates custom content settings for GLS labels, including logos and barcodes.
 
 <FunctionCard definition={
@@ -340,8 +333,6 @@ Creates custom content settings for GLS labels, including logos and barcodes.
 
 Return Type: [GLS_CONSIGNEE](./types.mdx#gls_consignee)
 
-#
-
 Creates a GLS consignee (recipient) object for use in shipments.
 
 <FunctionCard definition={
@@ -454,8 +445,6 @@ Creates a GLS consignee (recipient) object for use in shipments.
 
 Return Type: [GLS_ADDRESS](./types.mdx#gls_address)
 
-#
-
 Creates a GLS address object (`GLS_ADDRESS`) for use in shipments as consignee, shipper, or return address.
 
 <FunctionCard definition={
@@ -685,7 +674,8 @@ Creates a GLS address object (`GLS_ADDRESS`) for use in shipments as consignee,
 
 ## Shipment functions
 
-All shipment functions accept a common set of parameters in addition to their type-specific parameters. They call the GLS ShipIT API (`POST /rs/shipments`) and return a `GLS_CREATE_PARCELS_RESPONSE`.
+All shipment functions accept a common set of parameters in addition to their type-specific parameters.
+They call the GLS ShipIT API (`POST /rs/shipments`) and return a `GLS_CREATE_PARCELS_RESPONSE`.
 
 **Common parameters for all shipment functions:**
 
@@ -698,7 +688,6 @@ All shipment functions accept a common set of parameters in addition to their ty
 
 ---
 
-
 ### `createTyreShipment`
 
 | Parameter | Name | Type | Required | Description |
@@ -710,8 +699,6 @@ All shipment functions accept a common set of parameters in addition to their ty
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Creates a shipment specifically for tyre/wheel delivery (uses the GLS TyreService).
 
 <FunctionCard definition={
@@ -815,8 +802,6 @@ Creates a shipment specifically for tyre/wheel delivery (uses the GLS TyreServic
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Creates a shipment that requires a recipient signature upon delivery.
 
 <FunctionCard definition={
@@ -922,8 +907,6 @@ Creates a shipment that requires a recipient signature upon delivery.
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Creates a return shipment from a GLS Parcel Shop (customer drops off parcel at a shop).
 
 <FunctionCard definition={
@@ -1058,8 +1041,6 @@ Creates a return shipment from a GLS Parcel Shop (customer drops off parcel at a
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Delivers a parcel to a GLS Parcel Shop where the recipient can collect it.
 
 <FunctionCard definition={
@@ -1179,8 +1160,6 @@ Delivers a parcel to a GLS Parcel Shop where the recipient can collect it.
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Schedules a pickup from the consignee's address on a given date.
 
 <FunctionCard definition={
@@ -1303,8 +1282,6 @@ Schedules a pickup from the consignee's address on a given date.
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Delivers a parcel with identity verification - the driver checks the recipient's ID document.
 
 <FunctionCard definition={
@@ -1470,8 +1447,6 @@ Delivers a parcel with identity verification - the driver checks the recipient's
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Delivers a parcel with PIN and optional birthdate verification.
 
 <FunctionCard definition={
@@ -1605,8 +1580,6 @@ Delivers a parcel with PIN and optional birthdate verification.
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Creates a shipment with guaranteed delivery within 24 hours.
 
 <FunctionCard definition={
@@ -1710,8 +1683,6 @@ Creates a shipment with guaranteed delivery within 24 hours.
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Creates a shipment with flexible delivery - the recipient can redirect or reschedule delivery.
 
 <FunctionCard definition={
@@ -1817,8 +1788,6 @@ Creates a shipment with flexible delivery - the recipient can redirect or resche
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Delivers a new parcel while simultaneously picking up an existing one (exchange).
 
 <FunctionCard definition={
@@ -1953,8 +1922,6 @@ Delivers a new parcel while simultaneously picking up an existing one (exchange)
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Delivers a parcel to a designated deposit location (e.g. a garage or shed) without requiring a signature.
 
 <FunctionCard definition={
@@ -2073,8 +2040,6 @@ Delivers a parcel to a designated deposit location (e.g. a garage or shed) witho
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Creates an EXPRESS shipment for Saturday delivery.
 
 <FunctionCard definition={
@@ -2178,8 +2143,6 @@ Creates an EXPRESS shipment for Saturday delivery.
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Creates an EXPRESS shipment for delivery on the next working day (EOB service).
 
 <FunctionCard definition={
@@ -2289,8 +2252,6 @@ Creates an EXPRESS shipment for delivery on the next working day (EOB service).
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Delivers a parcel to a specific location within a workplace (building, floor, room).
 
 <FunctionCard definition={
@@ -2484,8 +2445,6 @@ Delivers a parcel to a specific location within a workplace (building, floor, ro
 
 Return Type: [GLS_CREATE_PARCELS_RESPONSE](./types.mdx#gls_create_parcels_response)
 
-#
-
 Creates a shipment that can only be delivered to the named addressee (no neighbor delivery).
 
 <FunctionCard definition={
@@ -2580,7 +2539,6 @@ Creates a shipment that can only be delivered to the named addressee (no neighbo
 
 ## API functions
 
-
 ### `validateShipment`
 
 | Parameter | Name | Type | Required | Description |
@@ -2589,16 +2547,15 @@ Creates a shipment that can only be delivered to the named addressee (no neighbo
 
 Return Type: [GLS_VALIDATE_SHIPMENT_RESPONSE_DATA](./types.mdx#gls_validate_shipment_response_data)
 
-#
-
-Validates a shipment against the GLS API without creating it. Use this before `createShipment` functions to catch errors early.
+Validates a shipment against the GLS API without creating it.
+Use this before `createShipment` functions to catch errors early.
 
 <FunctionCard definition={
 {
     "descriptions": [
         {
             "code": "en-US",
-            "content": "Validates a shipment against the GLS API without creating it. Use this before `createShipment` functions to catch errors early."
+            "content": "Validates a shipment against the GLS API without creating it.\nUse this before `createShipment` functions to catch errors early."
         }
     ],
     "names": [
@@ -2646,8 +2603,6 @@ Validates a shipment against the GLS API without creating it. Use this before `c
 
 Return Type: [GLS_END_OF_DAY_RESPONSE_DATA](./types.mdx#gls_end_of_day_response_data)
 
-#
-
 Updates the weight of an already-created parcel. Useful when the final weight is only known after packaging.
 
 <FunctionCard definition={
@@ -2703,16 +2658,15 @@ Updates the weight of an already-created parcel. Useful when the final weight is
 
 Return Type: [GLS_REPRINT_PARCEL_RESPONSE_DATA](./types.mdx#gls_reprint_parcel_response_data)
 
-#
-
-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.
+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.
 
 <FunctionCard definition={
 {
     "descriptions": [
         {
             "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."
+            "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."
         }
     ],
     "names": [
@@ -2760,8 +2714,6 @@ Reprints the label for an existing parcel. Use this if the original label is dam
 
 Return Type: [GLS_END_OF_DAY_RESPONSE_DATA](./types.mdx#gls_end_of_day_response_data)
 
-#
-
 Retrieves all shipments dispatched on a given date. Useful for reconciliation and end-of-day processing.
 
 <FunctionCard definition={
@@ -2817,8 +2769,6 @@ Retrieves all shipments dispatched on a given date. Useful for reconciliation an
 
 Return Type: [GLS_ALLOWED_SERVICES_RESPONSE_DATA](./types.mdx#gls_allowed_services_response_data)
 
-#
-
 Returns the GLS services available for a given origin/destination country and ZIP code combination.
 
 <FunctionCard definition={
@@ -2874,8 +2824,6 @@ Returns the GLS services available for a given origin/destination country and ZI
 
 Return Type: [GLS_CANCEL_SHIPMENT_RESPONSE_DATA](./types.mdx#gls_cancel_shipment_response_data)
 
-#
-
 Cancels an existing shipment by its Track ID. Only possible if the parcel has not yet been scanned.
 
 <FunctionCard definition={