@itentialopensource/adapter-pitney_bowes 0.1.1

package/report/creationReport.json

@@ -0,0 +1,480 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "Standard adapter errors available for use",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.48.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 70
+    },
+    {
+      "owner": "adapterJS",
+      "description": "Lines of code generated in adapter.js",
+      "value": 3599
+    },
+    {
+      "owner": "adapterJS",
+      "description": "Number of Functions added to adapter.js",
+      "value": 27
+    },
+    {
+      "owner": "pronghornJson",
+      "description": "Number of Methods added to pronghorn.json",
+      "value": 27
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 338
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 200
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the CALLS.md",
+      "value": 171
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the AUTH.md",
+      "value": 40
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SYSTEMINFO.md",
+      "value": 11
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 2231
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 117
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 1402
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 32
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for Authentication entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for CarrierInfo entity",
+      "value": 4
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for RateParcels entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for Shipment entity",
+      "value": 4
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for Manifests entity",
+      "value": 3
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for TransactionReports entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for Pickup entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for AddressValidation entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for ParcelProtection entity",
+      "value": 4
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for Tracking entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for CrossBorderQuotes entity",
+      "value": 2
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for Container entity",
+      "value": 1
+    },
+    {
+      "owner": "actionJson",
+      "description": "Total number of actions",
+      "value": 27
+    },
+    {
+      "owner": "actionJson",
+      "description": "Total number of entities",
+      "value": 12
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for Authentication entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for CarrierInfo entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for RateParcels entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for Shipment entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for Manifests entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for TransactionReports entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for Pickup entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for AddressValidation entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for ParcelProtection entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for Tracking entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for CrossBorderQuotes entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for Container entity",
+      "value": 1
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Total number of schemas",
+      "value": 12
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for Authentication entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for CarrierInfo entity",
+      "value": 1
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for RateParcels entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for Shipment entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for Manifests entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for TransactionReports entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for Pickup entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for AddressValidation entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for ParcelProtection entity",
+      "value": 3
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for Tracking entity",
+      "value": 1
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for CrossBorderQuotes entity",
+      "value": 1
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for Container entity",
+      "value": 0
+    },
+    {
+      "owner": "mockdata",
+      "description": "Total number of mock data files",
+      "value": 6
+    },
+    {
+      "owner": "actionJson",
+      "description": "Number of actions for .system entity",
+      "value": 2
+    },
+    {
+      "owner": "schemaJson",
+      "description": "Number of schemas for .system entity",
+      "value": 3
+    },
+    {
+      "owner": "mockdata",
+      "description": "Number of mock data files for .system entity",
+      "value": 2
+    },
+    {
+      "owner": "System",
+      "description": "System entity files",
+      "value": 6
+    },
+    {
+      "owner": "usecases",
+      "description": "Number of workflows",
+      "value": 0
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1788
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 38
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 9020
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 149
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 82
+    }
+  ],
+  "warnings": [],
+  "apiParsingReport": {
+    "no_mockdata": [
+      {
+        "fnName": "oauthToken",
+        "method": "post",
+        "path": "/oauth/token"
+      },
+      {
+        "fnName": "getCarrierServiceRules",
+        "method": "get",
+        "path": "/shippingservices/v1/information/rules/rating-services"
+      },
+      {
+        "fnName": "getCarrierSupportedDestination",
+        "method": "get",
+        "path": "/shippingservices/v1/countries"
+      },
+      {
+        "fnName": "getCarrierFacilities",
+        "method": "post",
+        "path": "/shippingservices/v1/carrier-facility"
+      },
+      {
+        "fnName": "rateParcel",
+        "method": "post",
+        "path": "/shippingservices/v1/rates"
+      },
+      {
+        "fnName": "createShipmentLabel",
+        "method": "post",
+        "path": "/shippingservices/v1/shipments"
+      },
+      {
+        "fnName": "retryShipment",
+        "method": "get",
+        "path": "/shippingservices/v1/shipments"
+      },
+      {
+        "fnName": "reprintShipment",
+        "method": "get",
+        "path": "/shippingservices/v1/shipments/{shipmentId}"
+      },
+      {
+        "fnName": "cancelShipment",
+        "method": "delete",
+        "path": "/shippingservices/v1/shipments/{shipmentId}"
+      },
+      {
+        "fnName": "createManifest",
+        "method": "post",
+        "path": "/shippingservices/v1/manifests"
+      },
+      {
+        "fnName": "retryManifest",
+        "method": "get",
+        "path": "/shippingservices/v1/manifests"
+      },
+      {
+        "fnName": "reprintManifest",
+        "method": "get",
+        "path": "/shippingservices/v1/manifests/{manifestId}"
+      },
+      {
+        "fnName": "getTransactionReport",
+        "method": "get",
+        "path": "/v4/ledger/developers/{developerId}/transactions/reports"
+      },
+      {
+        "fnName": "getPickupschedule",
+        "method": "post",
+        "path": "/shippingservices/v1/pickups/schedule"
+      },
+      {
+        "fnName": "cancelPickup",
+        "method": "post",
+        "path": "/shippingservices/v1/pickups/{pickupId}/cancel"
+      },
+      {
+        "fnName": "verifyAddress",
+        "method": "post",
+        "path": "/shippingservices/v1/addresses/verify"
+      },
+      {
+        "fnName": "verifyAndSuggestAddress",
+        "method": "post",
+        "path": "/shippingservices/v1/addresses/verify-suggest"
+      },
+      {
+        "fnName": "getParcelProtectionReports",
+        "method": "get",
+        "path": "/shippingservices/v1/parcel-protection/{developerId}/policies"
+      },
+      {
+        "fnName": "getTrackingDetails",
+        "method": "get",
+        "path": "/shippingservices/v1/tracking/{trackingNumber}"
+      },
+      {
+        "fnName": "predictedHSCode",
+        "method": "post",
+        "path": "/shippingservices/v1/crossborder/hs-classification/items"
+      },
+      {
+        "fnName": "getContainerizedParcelsLabels",
+        "method": "post",
+        "path": "/shippingservices/v1/container-manifest"
+      }
+    ],
+    "errors": [],
+    "warnings": [],
+    "callsTotal": 27,
+    "callsConverted": 27,
+    "no_mockdata_num": 21
+  }
+}

package/sampleProperties.json

@@ -0,0 +1,197 @@
+{
+  "id": "Adapter-pitney_bowes",
+  "type": "PitneyBowes",
+  "properties": {
+    "host": "localhost",
+    "port": 443,
+    "base_path": "/",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "request_token",
+      "username": "",
+      "password": "",
+      "token": "token",
+      "token_timeout": 1800000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Authorization",
+      "auth_field_format": "Bearer {token}",
+      "auth_logging": true,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "client_credentials"
+    },
+    "healthcheck": {
+      "type": "none",
+      "frequency": 60000,
+      "query_object": {}
+    },
+    "request": {
+      "number_redirects": 0,
+      "number_retries": 3,
+      "limit_retry_error": [
+        0
+      ],
+      "failover_codes": [],
+      "attempt_timeout": 5000,
+      "global_request": {
+        "payload": {},
+        "uriOptions": {},
+        "addlHeaders": {
+          "Authorization": "Basic base64<key>:<secret>"
+        },
+        "authData": {}
+      },
+      "healthcheck_on_timeout": true,
+      "return_raw": false,
+      "archiving": false,
+      "return_request": false
+    },
+    "throttle": {
+      "throttle_enabled": false,
+      "number_pronghorns": 1,
+      "sync_async": "sync",
+      "max_in_queue": 1000,
+      "concurrent_max": 1,
+      "expire_timeout": 0,
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
+    },
+    "proxy": {
+      "enabled": false,
+      "host": "",
+      "port": 1,
+      "protocol": "http",
+      "username": "",
+      "password": ""
+    },
+    "ssl": {
+      "ecdhCurve": "",
+      "enabled": false,
+      "accept_invalid_cert": false,
+      "ca_file": "",
+      "key_file": "",
+      "cert_file": "",
+      "secure_protocol": "",
+      "ciphers": ""
+    },
+    "mongo": {
+      "host": "",
+      "port": 0,
+      "database": "",
+      "username": "",
+      "password": "",
+      "replSet": "",
+      "db_ssl": {
+        "enabled": false,
+        "accept_invalid_cert": false,
+        "ca_file": "",
+        "key_file": "",
+        "cert_file": ""
+      }
+    },
+    "devicebroker": {
+      "getDevice": [
+        {
+          "path": "/get/devices/{id}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/get/devices/{id}/status",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "status",
+            "statusValue": "online"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/get/devices/{id}/configPart1",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
+    }
+  },
+  "groups": [],
+  "brokers": [],
+  "logLevel": "none",
+  "timeout": 120000
+}