@shipengine/connect-carrier-api 4.34.1-alpha-gold-28569.0 → 4.35.0-alpha.0

package/lib/app/metadata/carrier-app-metadata.d.ts

@@ -11,5 +11,11 @@ export interface CarrierAppMetadata {
     Carriers: Carrier[];
     /** @description Indicates whether the integration was developed by the carrier themselves (true) or by ShipStation (false) */
     IsSelfIntegrated?: boolean;
+    /**
+     * @description Strips the distributed-tracing headers that the platform's APM agents (New Relic,
+     * Sentry) add to outbound http/https requests: traceparent, tracestate, newrelic, sentry-trace and
+     * baggage. Enable this when the carrier's API rejects requests carrying them. Defaults to false.
+     */
+    SuppressOutboundTracingHeaders?: boolean;
 }
 export declare const CarrierAppMetadataSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/carrier-app-metadata.js

@@ -15,5 +15,6 @@ exports.CarrierAppMetadataSchema = joi_1.default.object({
         .message('There must be at least 1 Carrier defined')
         .items(_1.CarrierSchema),
     IsSelfIntegrated: joi_1.default.boolean().strict().optional(),
+    SuppressOutboundTracingHeaders: joi_1.default.boolean().strict().optional(),
 });
 //# sourceMappingURL=carrier-app-metadata.js.map

package/lib/app/metadata/carrier-app-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"carrier-app-metadata.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-app-metadata.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAAuF;AAe1E,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,0BAAuB,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE;SAClB,MAAM,CAAC,IAAI,CAAC;SACZ,QAAQ,EAAE;SACV,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,0CAA0C,CAAC;SACnD,KAAK,CAAC,gBAAa,CAAC;IACvB,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC"}
+{"version":3,"file":"carrier-app-metadata.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-app-metadata.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAAuF;AAqB1E,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,0BAAuB,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE;SAClB,MAAM,CAAC,IAAI,CAAC;SACZ,QAAQ,EAAE;SACV,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,0CAA0C,CAAC;SACnD,KAAK,CAAC,gBAAa,CAAC;IACvB,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnD,8BAA8B,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClE,CAAC,CAAC"}

package/lib/requests/create-label-request.d.ts

@@ -33,6 +33,8 @@ export declare class CreateLabelRequest extends BaseRequest {
     attachments?: Document[];
     /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
     carrier_pickup_window?: TimeWindow;
+    /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
+    delivery_window?: TimeWindow;
     /** @description Unique identifier for the carrier rate */
     carrier_rate_id?: string;
     /** @description Display schemes that the label will be returned in. Label is returned by default */

package/lib/requests/create-label-request.js

@@ -34,6 +34,8 @@ class CreateLabelRequest extends base_request_1.BaseRequest {
     attachments;
     /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
     carrier_pickup_window;
+    /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
+    delivery_window;
     /** @description Unique identifier for the carrier rate */
     carrier_rate_id;
     /** @description Display schemes that the label will be returned in. Label is returned by default */

package/lib/requests/create-label-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAuB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;IACjD,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,yBAAyB,CAAU;IACnC,YAAY,CAAqB;IACjC,YAAY,CAAkB;IAC9B,YAAY,CAAgB;IAC5B,qDAAqD;IACrD,aAAa,CAAW;IACxB,2FAA2F;IAC3F,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,oDAAoD;IACpD,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;IAC/B,YAAY,CAAqB;IACjC,iBAAiB,CAAmB;IACpC,mEAAmE;IACnE,QAAQ,CAAW;IACnB,yDAAyD;IACzD,aAAa,CAAW;IACxB,SAAS,CAAU;IACnB,cAAc,CAAsB;IACpC,wBAAwB,CAA0B;IAClD,WAAW,CAAc;IACzB,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0DAA0D;IAC1D,eAAe,CAAU;IACzB,oGAAoG;IACpG,eAAe,CAAmB;IAClC,OAAO,CAAW;IAClB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,8HAA8H;IAC9H,2BAA2B,CAA6B;CACzD;AAxCD,gDAwCC"}
+{"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAuB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;IACjD,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,yBAAyB,CAAU;IACnC,YAAY,CAAqB;IACjC,YAAY,CAAkB;IAC9B,YAAY,CAAgB;IAC5B,qDAAqD;IACrD,aAAa,CAAW;IACxB,2FAA2F;IAC3F,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,oDAAoD;IACpD,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;IAC/B,YAAY,CAAqB;IACjC,iBAAiB,CAAmB;IACpC,mEAAmE;IACnE,QAAQ,CAAW;IACnB,yDAAyD;IACzD,aAAa,CAAW;IACxB,SAAS,CAAU;IACnB,cAAc,CAAsB;IACpC,wBAAwB,CAA0B;IAClD,WAAW,CAAc;IACzB,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,0DAA0D;IAC1D,eAAe,CAAU;IACzB,oGAAoG;IACpG,eAAe,CAAmB;IAClC,OAAO,CAAW;IAClB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,8HAA8H;IAC9H,2BAA2B,CAA6B;CACzD;AA1CD,gDA0CC"}

package/lib/requests/get-rates-request.d.ts

@@ -21,6 +21,8 @@ export declare class GetRatesRequest extends BaseRequest {
     fulfillment_plan_details?: FulfillmentPlanDetails;
     /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
     carrier_pickup_window?: TimeWindow;
+    /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
+    delivery_window?: TimeWindow;
     /** Items included in the shipment */
     items?: ShipmentItem[];
     /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */

package/lib/requests/get-rates-request.js

@@ -21,6 +21,8 @@ class GetRatesRequest extends base_request_1.BaseRequest {
     fulfillment_plan_details;
     /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
     carrier_pickup_window;
+    /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
+    delivery_window;
     /** Items included in the shipment */
     items;
     /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */

package/lib/requests/get-rates-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAkB7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;IAC9C,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,yBAAyB,CAAU;IACnC,YAAY,CAAqB;IACjC,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAW;IAClB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,eAAe,CAAgB;IAC/B,aAAa,CAAW;IACxB,QAAQ,CAAW;IACnB,wBAAwB,CAA0B;IAClD,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,qCAAqC;IACrC,KAAK,CAAkB;IACvB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,oGAAoG;IACpG,eAAe,CAAmB;IAClC,8HAA8H;IAC9H,2BAA2B,CAA6B;CACzD;AA1BD,0CA0BC"}
+{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAkB7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;IAC9C,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,yBAAyB,CAAU;IACnC,YAAY,CAAqB;IACjC,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAW;IAClB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,eAAe,CAAgB;IAC/B,aAAa,CAAW;IACxB,QAAQ,CAAW;IACnB,wBAAwB,CAA0B;IAClD,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,qCAAqC;IACrC,KAAK,CAAkB;IACvB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,oGAAoG;IACpG,eAAe,CAAmB;IAClC,8HAA8H;IAC9H,2BAA2B,CAA6B;CACzD;AA5BD,0CA4BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.34.1-alpha-gold-28569.0",
+  "version": "4.35.0-alpha.0",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.52.1"
+    "version": "1.53.1"
   },
   "paths": {
     "/Register": {
@@ -1727,6 +1727,9 @@
           "carrier_pickup_window": {
             "$ref": "#/components/schemas/TimeWindow"
           },
+          "delivery_window": {
+            "$ref": "#/components/schemas/TimeWindow"
+          },
           "carrier_rate_id": {
             "type": "string",
             "description": "Unique identifier for the carrier rate",
@@ -2949,6 +2952,9 @@
           "carrier_pickup_window": {
             "$ref": "#/components/schemas/TimeWindow"
           },
+          "delivery_window": {
+            "$ref": "#/components/schemas/TimeWindow"
+          },
           "display_schemes": {
             "type": "array",
             "items": {
@@ -6361,4 +6367,4 @@
       "description": ""
     }
   ]
-}
+}

package/src/app/metadata/carrier-app-metadata.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from 'vitest';
+import { CarrierAppMetadataSchema } from './carrier-app-metadata';
+
+const suppressionErrors = (SuppressOutboundTracingHeaders: unknown) =>
+  CarrierAppMetadataSchema.validate(
+    { Id: 'id', Name: 'name', Carriers: [{}], SuppressOutboundTracingHeaders },
+    { allowUnknown: true, abortEarly: false },
+  ).error?.details.filter((detail) => detail.path[0] === 'SuppressOutboundTracingHeaders') ?? [];
+
+describe('CarrierAppMetadataSchema.SuppressOutboundTracingHeaders', () => {
+  it.each([undefined, true, false])('accepts %s', (value) => {
+    expect(suppressionErrors(value)).toEqual([]);
+  });
+
+  it.each(['true', 1, ['baggage']])('rejects %j', (value) => {
+    expect(suppressionErrors(value)).toHaveLength(1);
+  });
+});

package/src/app/metadata/carrier-app-metadata.ts

@@ -12,6 +12,12 @@ export interface CarrierAppMetadata {
   Carriers: Carrier[];
   /** @description Indicates whether the integration was developed by the carrier themselves (true) or by ShipStation (false) */
   IsSelfIntegrated?: boolean;
+  /**
+   * @description Strips the distributed-tracing headers that the platform's APM agents (New Relic,
+   * Sentry) add to outbound http/https requests: traceparent, tracestate, newrelic, sentry-trace and
+   * baggage. Enable this when the carrier's API rejects requests carrying them. Defaults to false.
+   */
+  SuppressOutboundTracingHeaders?: boolean;
 }
 
 export const CarrierAppMetadataSchema = Joi.object({
@@ -25,4 +31,5 @@ export const CarrierAppMetadataSchema = Joi.object({
     .message('There must be at least 1 Carrier defined')
     .items(CarrierSchema),
   IsSelfIntegrated: Joi.boolean().strict().optional(),
+  SuppressOutboundTracingHeaders: Joi.boolean().strict().optional(),
 });

package/src/requests/create-label-request.ts

@@ -53,6 +53,8 @@ export class CreateLabelRequest extends BaseRequest {
   attachments?: Document[];
   /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
   carrier_pickup_window?: TimeWindow;
+  /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
+  delivery_window?: TimeWindow;
   /** @description Unique identifier for the carrier rate */
   carrier_rate_id?: string;
   /** @description Display schemes that the label will be returned in. Label is returned by default */

package/src/requests/get-rates-request.ts

@@ -35,6 +35,8 @@ export class GetRatesRequest extends BaseRequest {
   fulfillment_plan_details?: FulfillmentPlanDetails;
   /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
   carrier_pickup_window?: TimeWindow;
+  /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
+  delivery_window?: TimeWindow;
   /** Items included in the shipment */
   items?: ShipmentItem[];
   /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */