Update doc link for carrier method templates, added doc and sample ap…

…p link to order methods templates
ShipEngine · Dec 9, 2020 · b8359cb · b8359cb
1 parent 5e152d0
commit b8359cb
Show file tree

Hide file tree

Showing 22 changed files with 80 additions and 34 deletions.
diff --git a/templates/carrier/methods/cancel-pickups.js b/templates/carrier/methods/cancel-pickups.js
@@ -2,10 +2,10 @@
 
 /**
  * Cancels one or more previously-scheduled pickups
- * 
+ *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/cancel-pickups
- * 
+ * https://connect.shipengine.com/docs/reference/methods/cancel-pickups
+ *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/freightco/cancel-pickups.js
  */

diff --git a/templates/carrier/methods/cancel-pickups.ts b/templates/carrier/methods/cancel-pickups.ts
@@ -8,8 +8,8 @@ import { Session } from "./session";
 /**
  * Cancels one or more previously-scheduled pickups
  *
- * See an example implementation below
- * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/carrier/src/methods/cancel-pickups.ts
+ * View documentation here:
+ * https://connect.shipengine.com/docs/reference/methods/cancel-pickups
 
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/src/methods/cancel-pickups.ts

diff --git a/templates/carrier/methods/cancel-shipments.js b/templates/carrier/methods/cancel-shipments.js
@@ -5,8 +5,8 @@
  * this may include voiding labels, refunding charges, and/or removing the shipment from the day's manifest.
  *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/cancel-shipments
- * 
+ * https://connect.shipengine.com/docs/reference/methods/cancel-shipments
+ *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/cargo-inc/src/cancel-shipments.js
  */

diff --git a/templates/carrier/methods/cancel-shipments.ts b/templates/carrier/methods/cancel-shipments.ts
@@ -10,7 +10,7 @@ import { Session } from "./session";
  * this may include voiding labels, refunding charges, and/or removing the shipment from the day's manifest.
  *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/cancel-shipments
+ * https://connect.shipengine.com/docs/reference/methods/cancel-shipments
  *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/src/methods/cancel-shipments.ts

diff --git a/templates/carrier/methods/connect.js b/templates/carrier/methods/connect.js
@@ -1,10 +1,10 @@
 "use strict";
 /**
  * Logs in using the username and password entered on the login form
- * 
+ *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/connect
- * 
+ * https://connect.shipengine.com/docs/reference/methods/connect
+ *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/freightco/connect.js
  */

diff --git a/templates/carrier/methods/connect.ts b/templates/carrier/methods/connect.ts
@@ -7,7 +7,7 @@ interface ConnectionFormData {}
  * Logs in using the username and password entered on the login form
  *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/connect
+ * https://connect.shipengine.com/docs/reference/methods/connect
  *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/src/methods/connect.ts

diff --git a/templates/carrier/methods/create-manifest.js b/templates/carrier/methods/create-manifest.js
@@ -2,10 +2,10 @@
 
 /**
  * Creates an end-of-day manifest
- * 
+ *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/create-manifest
- * 
+ * https://connect.shipengine.com/docs/reference/methods/create-manifest
+ *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/cargo-inc/src/create-manifest.js
  */

diff --git a/templates/carrier/methods/create-manifest.ts b/templates/carrier/methods/create-manifest.ts
@@ -9,7 +9,7 @@ import { Session } from "./session";
  * Creates an end-of-day manifest
  *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/create-manifest
+ * https://connect.shipengine.com/docs/reference/methods/create-manifest
  *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/src/methods/create-manifest.ts

diff --git a/templates/carrier/methods/create-shipment.js b/templates/carrier/methods/create-shipment.js
@@ -4,8 +4,8 @@
  * Generates a shipping label and tracking number for a shipment
  *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/create-shipment
- * 
+ * https://connect.shipengine.com/docs/reference/methods/create-shipment
+ *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/freightco/carrier/create-shipment.js
  */

diff --git a/templates/carrier/methods/create-shipment.ts b/templates/carrier/methods/create-shipment.ts
@@ -9,7 +9,7 @@ import { Session } from "./session";
  * Generates a shipping label and tracking number for a shipment
  *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/create-shipment
+ * https://connect.shipengine.com/docs/reference/methods/create-shipment
  *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/carrier/src/methods/create-shipment.ts

diff --git a/templates/carrier/methods/rate-shipment.js b/templates/carrier/methods/rate-shipment.js
@@ -2,10 +2,10 @@
 
 /**
  * Generates shipping rates for a shipment
- * 
+ *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/rate-shipment
- * 
+ * https://connect.shipengine.com/docs/reference/methods/rate-shipment
+ *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/freightco/carrier/rate-shipment.js
  */

diff --git a/templates/carrier/methods/rate-shipment.ts b/templates/carrier/methods/rate-shipment.ts
@@ -8,7 +8,7 @@ import { Session } from "./session";
 /**
  * Generates shipping rates for a shipment
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/rate-shipment
+ * https://connect.shipengine.com/docs/reference/methods/rate-shipment
  *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/carrier/src/methods/rate-shipment.ts

diff --git a/templates/carrier/methods/schedule-pickup.js b/templates/carrier/methods/schedule-pickup.js
@@ -2,10 +2,10 @@
 
 /**
  * Schedules a pick-up at a specific time and location
- * 
+ *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/schedule-pickup
- * 
+ * https://connect.shipengine.com/docs/reference/methods/schedule-pickup
+ *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/freightco/schedule-pickup.js
  */

diff --git a/templates/carrier/methods/schedule-pickup.ts b/templates/carrier/methods/schedule-pickup.ts
@@ -9,7 +9,7 @@ import { Session } from "./session";
  * Schedules a pick-up at a specific time and location
  *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/schedule-pickup
+ * https://connect.shipengine.com/docs/reference/methods/schedule-pickup
  *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/carrier/src/methods/schedule-pickup.ts

diff --git a/templates/carrier/methods/track-shipment.js b/templates/carrier/methods/track-shipment.js
@@ -2,10 +2,10 @@
 
 /**
  * Returns tracking information for a shipment
- * 
+ *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/track-shipment
- * 
+ * https://connect.shipengine.com/docs/reference/methods/track-shipment
+ *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/cargo-inc/src/track-shipment.js
  */

diff --git a/templates/carrier/methods/track-shipment.ts b/templates/carrier/methods/track-shipment.ts
@@ -9,7 +9,7 @@ import { Session } from "./session";
  * Returns tracking information for a shipment
  *
  * View documentation here:
- * https://shipenginestag:439bd542@shipenginestag.wpengine.com/docs/integration-platform/reference/methods/track-shipment
+ * https://connect.shipengine.com/docs/reference/methods/track-shipment
  *
  * View sample implementation here:
  * https://github.com/ShipEngine/connect-samples/blob/master/parcel-post/src/methods/track-shipment.ts

diff --git a/templates/order-source/methods/acknowledge-orders.js b/templates/order-source/methods/acknowledge-orders.js
@@ -1,6 +1,15 @@
+
 /**
  * Called when an order has been imported into a marketplace.
+ *
+ * View documentation here:
+ * https://connect.shipengine.com/docs/reference/methods/acknowledge-orders
+ *
+ * View sample implementation here:
+ * https://github.com/ShipEngine/connect-samples/blob/master/southwest-products/src/methods/acknowledge-orders.js
+ *
  */
+
 async function acknowledgeOrders(transaction, notifications) {
   throw new Error("NotImplementedError");
   // STEP 1: Validation

diff --git a/templates/order-source/methods/acknowledge-orders.ts b/templates/order-source/methods/acknowledge-orders.ts
@@ -1,10 +1,16 @@
 import { AcknowledgedSalesOrder, SalesOrderNotification, Transaction } from "@shipengine/connect";
 import { Session } from "./session";
 
-
 /**
  * Called when an order has been imported into a marketplace.
+ *
+ * View documentation here:
+ * https://connect.shipengine.com/docs/reference/methods/acknowledge-orders
+ *
+ * View sample implementation here:
+ * https://github.com/ShipEngine/connect-samples/blob/master/iBuy/src/methods/acknowledge-orders.ts
  */
+
 export default async function acknowledgeOrders(
   transaction: Transaction<Session>,
   notifications: SalesOrderNotification[],

diff --git a/templates/order-source/methods/get-sales-order-by-date.js b/templates/order-source/methods/get-sales-order-by-date.js
@@ -2,7 +2,15 @@
 
 /**
  * Retrieve existing sales orders based on a date range.
+ *
+ * View documentation here:
+ * https://connect.shipengine.com/docs/reference/methods/get-sales-orders-by-date
+ *
+ * View sample implementation here:
+ * https://github.com/ShipEngine/connect-samples/blob/master/southwest-products/src/methods/get-sales-orders-by-date.js
+ *
  */
+
 async function getSalesOrdersByDate(transaction, range) {
   throw new Error("NotImplementedError");
   // STEP 1: Validation
@@ -11,4 +19,4 @@ async function getSalesOrdersByDate(transaction, range) {
   // Step 4: Create the output data that ShipEngine expects
 }
 
-module.exports = getSalesOrdersByDate;
+module.exports = getSalesOrdersByDate;
diff --git a/templates/order-source/methods/get-sales-order-by-date.ts b/templates/order-source/methods/get-sales-order-by-date.ts
@@ -4,6 +4,13 @@ import { Session } from "./session";
 
 /**
  * Retrieve existing sales orders based on a date range.
+ *
+ * View documentation here:
+ * https://connect.shipengine.com/docs/reference/methods/get-sales-orders-by-date
+ *
+ * View sample implementation here:
+ * https://github.com/ShipEngine/connect-samples/blob/master/iBuy/src/methods/get-sales-orders-by-date.ts
+ *
  */
 export default async function getSalesOrdersByDate(
   transaction: Transaction<Session>,

diff --git a/templates/order-source/methods/shipment-created.js b/templates/order-source/methods/shipment-created.js
@@ -2,6 +2,14 @@
 
 /**
  * Called when shipment is created
+ *
+ *
+ * View documentation here:
+ * https://connect.shipengine.com/docs/reference/methods/shipment-created
+ *
+ * View sample implementation here:
+ * https://github.com/ShipEngine/connect-samples/blob/master/southwest-products/src/methods/shipment-created.js
+ *
  */
 async function shipmentCreated(transaction, shipment) {
   throw new Error("NotImplementedError");
@@ -11,4 +19,4 @@ async function shipmentCreated(transaction, shipment) {
   // Step 4: Create the output data that ShipEngine expects
 }
 
-module.exports = shipmentCreated;
+module.exports = shipmentCreated;
diff --git a/templates/order-source/methods/shipment-created.ts b/templates/order-source/methods/shipment-created.ts
@@ -3,6 +3,14 @@ import { Session } from "./session";
 
 /**
  * Called when shipment is created
+ *
+ *
+ * View documentation here:
+ * https://connect.shipengine.com/docs/reference/methods/shipment-created
+ *
+ * View sample implementation here:
+ * https://github.com/ShipEngine/connect-samples/blob/master/southwest-products/src/methods/shipment-created.js
+ *
  */
 export default async function shipmentCreated(
   transaction: Transaction<Session>,