@truetms/truetms-node 0.3.3 → 0.4.1

package/src/graphql/shipments.graphql

@@ -0,0 +1,403 @@
+query getShipmentList(
+  $search: String
+  $sort: ShipmentSort
+  $skip: Int
+  $take: Int
+  $status: Status
+  $receiverId: String
+  $excludePastShipments: Boolean
+  $filter: JSON
+  $orderBy: [OrderByItem!]
+) {
+  shipments(
+    search: $search
+    sort: $sort
+    skip: $skip
+    take: $take
+    status: $status
+    filter: $filter
+    orderBy: $orderBy
+    excludeRecurrentShipments: true
+    excludeRotationShipments: true
+    receiverId: $receiverId
+    excludePastShipments: $excludePastShipments
+  ) {
+    data {
+      _id
+      shipmentNumber
+      purchaseOrderNumbers
+      billOfLadingNumbers
+      referenceNumbers
+      ticketNumbers
+      status
+      trailerType
+      additionalTrailerTypes
+      shipmentLocations {
+        _id
+        locationType
+        timeWindows {
+          fromDate
+          toDate
+        }
+        shippedGoods {
+          _id
+          goodProfileId
+          label
+          quantity
+          unit
+          weight
+          supplierId
+        }
+        shipper {
+          _id
+        }
+      }
+      route {
+        locations {
+          _id
+          locationType
+          location {
+            latitude
+            longitude
+          }
+          name
+          addressLabel
+          addressTimezone
+          shipper {
+            _id
+            name
+            address {
+              label
+            }
+            addressTimezone
+          }
+          receiver {
+            _id
+            name
+            address {
+              label
+            }
+            addressTimezone
+          }
+          timeWindows {
+            fromDate
+            toDate
+          }
+        }
+        firstPickupTime
+        lastDropoffTime
+      }
+      tripId
+      trip {
+        _id
+        tripNumber
+        driver
+        tractor
+        trailer
+        driverEntity {
+          _id
+          firstname
+          lastname
+          phoneNumber
+          status
+        }
+        tractorEntity {
+          _id
+          serialNumber
+          licenseNumber
+          status
+        }
+        trailerEntity {
+          _id
+          serialNumber
+          licenseNumber
+          status
+          type
+        }
+        carrier
+        carrierEntity {
+          _id
+          name
+          contact {
+            firstname
+            lastname
+            phoneNumber
+          }
+          status
+          type
+          address {
+            label
+            coordinates {
+              latitude
+              longitude
+            }
+          }
+        }
+      }
+      isSplit
+      isFromSplit
+      isFromRotation
+      parentShipment {
+        _id
+      }
+      tags
+      customFields {
+        key
+        value
+      }
+      groupIds
+    }
+    count
+  }
+}
+
+query getShipmentDetails($id: String!) {
+  shipmentById(id: $id) {
+    _id
+    shipmentNumber
+    commodityType
+    events {
+      _id
+      coordinates {
+        altitude
+        heading
+        latitude
+        longitude
+        speed
+      }
+      createdBy
+      date
+      shipmentLocation
+      type
+      label
+      description
+      metadata
+    }
+    issues {
+      _id
+      type
+      content
+      date
+      shipmentLocation
+      delayAmount
+    }
+    constraints {
+      type
+      value
+      unit
+    }
+    documents {
+      _id
+      associatedCharge
+      accessLevel
+      isBillable
+      name
+      type
+      url
+      shipper {
+        _id
+        name
+      }
+      receiver {
+        _id
+        name
+      }
+    }
+    notes {
+      _id
+      accessLevel
+      receiver {
+        _id
+        name
+      }
+      shipper {
+        _id
+        name
+      }
+      content
+    }
+    customer {
+      _id
+      name
+      referenceNumberTypes
+      address {
+        coordinates {
+          latitude
+          longitude
+        }
+        label
+      }
+      contact {
+        firstname
+        lastname
+        phoneNumber
+      }
+      name
+      type
+    }
+    purchaseOrderNumbers
+    billOfLadingNumbers
+    referenceNumbers
+    purchaseOrderNumbers
+    billOfLadingNumbers
+    referenceNumbers
+    ticketNumbers
+    status
+    shipmentLocations {
+      _id
+      name
+      addressLabel
+      addressTimezone
+      addressTimezone
+      shipper {
+        _id
+        name
+        address {
+          coordinates {
+            latitude
+            latitude
+          }
+          label
+        }
+        addressTimezone
+      }
+      receiver {
+        _id
+        name
+        address {
+          coordinates {
+            latitude
+            latitude
+          }
+          label
+        }
+        addressTimezone
+      }
+      shippedGoods {
+        _id
+        quantity
+        weight
+        label
+        unit
+        goodProfileId
+        supplierId
+        pinCode
+      }
+      receivedGoods {
+        goodId
+        quantity
+        goodProfileId
+        shipperId
+        supplierId
+        pinCode
+      }
+      timeWindows {
+        fromDate
+        toDate
+      }
+      location {
+        latitude
+        longitude
+      }
+      locationType
+    }
+    constraints {
+      type
+      value
+      unit
+    }
+    charges {
+      _id
+      total
+      label
+      rate
+      unit
+      unitType
+      reimburseToDriver
+      relatedTransactionId
+      billingRule {
+        _id
+        label
+        referenceNumber
+      }
+      document {
+        name
+        url
+      }
+      taxable
+    }
+    expenses {
+      _id
+      label
+      rate
+      unit
+      unitType
+      reimburseToDriver
+      document {
+        name
+        url
+      }
+      customFields {
+        key
+        value
+      }
+    }
+    route {
+      routeDistance
+      predictedLoadedDistance
+      locations {
+        _id
+        shipper {
+          _id
+        }
+        receiver {
+          _id
+        }
+        timeWindows {
+          fromDate
+          toDate
+        }
+      }
+      firstPickupTime
+    }
+    createdBy
+    trailerType
+    additionalTrailerTypes
+    loadType
+    tripId
+    reasonForCancellation
+    isSplit
+    isFromSplit
+    childShipmentIds
+    recurrence {
+      freq
+      interval
+      dtstart
+      until
+      byweekday {
+        weekday
+        n
+      }
+      count
+      bysetpos
+      bymonth
+      bymonthday
+      bynmonthday
+      byyearday
+      byweekno
+      byhour
+      byminute
+      bysecond
+    }
+    dailyRotationCount
+    parentShipment {
+      _id
+    }
+    tags
+    customFields {
+      key
+      value
+    }
+    groupIds
+  }
+}

package/src/graphql/trips.graphql

@@ -95,3 +95,189 @@ query listTrips(
     }
   }
 }
+
+query getTripDetails($id: String!) {
+  tripById(id: $id) {
+    _id
+    tripNumber
+    status
+    routeDistance
+    totalDistance
+    loadedDistance
+    firstPickupTime
+    shipmentLocations {
+      _id
+      name
+      addressLabel
+      addressTimezone
+      location {
+        latitude
+        longitude
+      }
+      locationType
+      shipper {
+        _id
+        name
+        address {
+          label
+        }
+        addressTimezone
+      }
+      timeWindows {
+        fromDate
+        toDate
+      }
+      receiver {
+        _id
+        name
+        address {
+          label
+        }
+        addressTimezone
+      }
+      shippedGoods {
+        _id
+        label
+        quantity
+        weight
+        unit
+        goodProfileId
+        supplierId
+        pinCode
+      }
+      receivedGoods {
+        goodId
+        quantity
+        goodProfileId
+      }
+      arrivalTime
+      waitingDuration
+      setupDuration
+      serviceDuration
+      shipmentId
+    }
+    violations {
+      cause
+      duration
+      locationId
+    }
+    shipments {
+      _id
+      isFromSplit
+      isFromRotation
+      parentShipment {
+        _id
+      }
+      shipmentNumber
+      referenceNumbers
+      status
+      charges {
+        _id
+        rate
+        unit
+        total
+      }
+      trailerType
+      additionalTrailerTypes
+      events {
+        _id
+        type
+        label
+        description
+        date
+        shipmentLocation
+        coordinates {
+          latitude
+          longitude
+        }
+        metadata
+      }
+      customer {
+        _id
+        code
+        name
+      }
+      route {
+        locations {
+          locationType
+          shipper {
+            _id
+            name
+            address {
+              label
+            }
+            addressTimezone
+          }
+          receiver {
+            _id
+            name
+            address {
+              label
+            }
+            addressTimezone
+          }
+          timeWindows {
+            fromDate
+            toDate
+          }
+        }
+      }
+    }
+    polyline
+    trailer {
+      _id
+      type
+      serialNumber
+    }
+    additionalTrailers {
+      _id
+      type
+      serialNumber
+    }
+    tractor {
+      _id
+      serialNumber
+    }
+    driver {
+      _id
+      firstname
+      lastname
+    }
+    trailerCompartmentAssignments {
+      trailerId
+      compartmentId
+      commodityId
+      quantity
+      targetStorageFacilityId
+    }
+    carrier {
+      _id
+      name
+      code
+      contact {
+        email
+      }
+      additionalContacts {
+        email
+        includeInInvoicing
+      }
+    }
+    additionalTrailers {
+      _id
+      type
+      serialNumber
+    }
+    lastTrailerLocation {
+      latitude
+      longitude
+      heading
+      speed
+    }
+    lastTrailerLocationDate
+    tags
+    customFields {
+      key
+      value
+    }
+  }
+}

package/src/sdk/index.ts

@@ -3,6 +3,7 @@ import TrueTMSBusinessEntitiesSdk from "./businessEntities";
 import TrueTMSDriverSdk from "./drivers";
 import TrueTMSDriverSettlementsSdk from "./driverSettlements";
 import TrueTMSInvoicesSdk from "./invoices";
+import TrueTMSShipmentsSdk from "./shipments";
 import TrueTMSStorageFacilityReadingsSdk from "./storageFacilityReadings";
 import TrueTMSTractorsSdk from "./tractors";
 import TrueTMSTransactionsSdk from "./transactions";
@@ -27,6 +28,7 @@ class TrueTMS {
   public businessEntities: TrueTMSBusinessEntitiesSdk;
   public trips: TrueTMSTripsSdk;
   public storageFacilityReadings: TrueTMSStorageFacilityReadingsSdk;
+  public shipments: TrueTMSShipmentsSdk;
 
   constructor(private options: TrueTMSOptions) {
     this.drivers = new TrueTMSDriverSdk(options);
@@ -38,6 +40,7 @@ class TrueTMS {
     this.transactions = new TrueTMSTransactionsSdk(options);
     this.businessEntities = new TrueTMSBusinessEntitiesSdk(options);
     this.trips = new TrueTMSTripsSdk(options);
+    this.shipments = new TrueTMSShipmentsSdk(options);
     this.storageFacilityReadings = new TrueTMSStorageFacilityReadingsSdk(
       options
     );

package/src/sdk/shipments.ts

@@ -0,0 +1,11 @@
+import { TrueTMSOptions, authenticateApiCall } from ".";
+import trueTmsGraphqlClient from "../providers/truetms-graphql-client";
+
+class TrueTMSShipmentsSdk {
+  constructor(private options: TrueTMSOptions) {}
+
+  getShipmentList = authenticateApiCall(trueTmsGraphqlClient.getShipmentList);
+  getShipmentDetails = authenticateApiCall(trueTmsGraphqlClient.getShipmentDetails);
+}
+
+export default TrueTMSShipmentsSdk;

package/src/sdk/trips.ts

@@ -5,6 +5,8 @@ class TrueTMSTripsSdk {
   constructor(private options: TrueTMSOptions) {}
 
   listTrips = authenticateApiCall(trueTmsGraphqlClient.listTrips);
+  getTripList = authenticateApiCall(trueTmsGraphqlClient.listTrips);
+  getTripDetails = authenticateApiCall(trueTmsGraphqlClient.getTripDetails);
 }
 
 export default TrueTMSTripsSdk;