@shipengine/connect-carrier-api 4.16.11 → 4.17.0-beta

package/lib/models/limit-identifier-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const LimitIdentifierSchema: Joi.ObjectSchema<any>;

package/lib/models/limit-identifier-schema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LimitIdentifierSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const limit_identifier_type_schema_1 = require("./limit-identifier-type-schema");
+exports.LimitIdentifierSchema = joi_1.default.object({
+    type: limit_identifier_type_schema_1.LimitIdentifierTypeSchema.required(),
+    value: joi_1.default.string().required(),
+});
+//# sourceMappingURL=limit-identifier-schema.js.map

package/lib/models/limit-identifier-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limit-identifier-schema.js","sourceRoot":"","sources":["../../src/models/limit-identifier-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iFAA2E;AAE9D,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,wDAAyB,CAAC,QAAQ,EAAE;IAC1C,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC"}

package/lib/models/limit-identifier-type-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const LimitIdentifierTypeSchema: Joi.StringSchema;

package/lib/models/limit-identifier-type-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LimitIdentifierTypeSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const limit_identifier_type_1 = require("./limit-identifier-type");
+exports.LimitIdentifierTypeSchema = joi_1.default.string().valid(...Object.values(limit_identifier_type_1.LimitIdentifierType));
+//# sourceMappingURL=limit-identifier-type-schema.js.map

package/lib/models/limit-identifier-type-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limit-identifier-type-schema.js","sourceRoot":"","sources":["../../src/models/limit-identifier-type-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mEAA8D;AAEjD,QAAA,yBAAyB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,2CAAmB,CAAC,CAAC,CAAC"}

package/lib/models/limit-identifier-type.d.ts

@@ -0,0 +1,3 @@
+export declare enum LimitIdentifierType {
+    Track = "track"
+}

package/lib/models/limit-identifier-type.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LimitIdentifierType = void 0;
+var LimitIdentifierType;
+(function (LimitIdentifierType) {
+    LimitIdentifierType["Track"] = "track";
+})(LimitIdentifierType || (exports.LimitIdentifierType = LimitIdentifierType = {}));
+//# sourceMappingURL=limit-identifier-type.js.map

package/lib/models/limit-identifier-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limit-identifier-type.js","sourceRoot":"","sources":["../../src/models/limit-identifier-type.ts"],"names":[],"mappings":";;;AAAA,IAAY,mBAEX;AAFD,WAAY,mBAAmB;IAC7B,sCAAe,CAAA;AACjB,CAAC,EAFW,mBAAmB,mCAAnB,mBAAmB,QAE9B"}

package/lib/models/limit-identifier.d.ts

@@ -0,0 +1,5 @@
+import { LimitIdentifierType } from './limit-identifier-type';
+export declare class LimitIdentifier {
+    type: LimitIdentifierType;
+    value: string;
+}

package/lib/models/limit-identifier.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LimitIdentifier = void 0;
+class LimitIdentifier {
+    type;
+    value;
+}
+exports.LimitIdentifier = LimitIdentifier;
+//# sourceMappingURL=limit-identifier.js.map

package/lib/models/limit-identifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limit-identifier.js","sourceRoot":"","sources":["../../src/models/limit-identifier.ts"],"names":[],"mappings":";;;AAEA,MAAa,eAAe;IAC1B,IAAI,CAAuB;IAC3B,KAAK,CAAU;CAChB;AAHD,0CAGC"}

package/lib/responses/create-label-response-schema.js

@@ -14,6 +14,7 @@ const relay_point_details_schema_1 = require("../models/relay-points/relay-point
 const time_window_schema_1 = require("../models/time-window-schema");
 const paperless_details_schema_1 = require("../models/labels/paperless-details-schema");
 const pudo_location_schema_1 = require("../models/addresses/pudo-location-schema");
+const limit_identifier_schema_1 = require("../models/limit-identifier-schema");
 exports.CreateLabelResponseSchema = base_response_schema_1.BaseResponseSchema.keys({
     transaction_id: joi_1.default.string().required(),
     label_download: label_download_schema_1.LabelDownloadSchema.optional(),
@@ -33,5 +34,6 @@ exports.CreateLabelResponseSchema = base_response_schema_1.BaseResponseSchema.ke
     relay_points: relay_point_details_schema_1.RelayPointDetailsSchema.optional(),
     dropoff_location: pudo_location_schema_1.PudoLocationSchema.optional(),
     pickup_location: pudo_location_schema_1.PudoLocationSchema.optional(),
+    limit_identifiers: joi_1.default.array().optional().items(limit_identifier_schema_1.LimitIdentifierSchema),
 });
 //# sourceMappingURL=create-label-response-schema.js.map

package/lib/responses/create-label-response-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-label-response-schema.js","sourceRoot":"","sources":["../../src/responses/create-label-response-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA4D;AAC5D,yFAAmF;AACnF,yEAAqE;AACrE,mEAA+D;AAC/D,gFAA2E;AAC3E,kFAA6E;AAC7E,gFAA2E;AAC3E,kGAA4F;AAC5F,qEAAgE;AAChE,wFAAmF;AACnF,mFAA8E;AAEjE,QAAA,yBAAyB,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAC/D,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,cAAc,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC9C,aAAa,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC5C,iBAAiB,EAAE,iDAAsB,CAAC,QAAQ,EAAE;IACpD,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAc,CAAC;IACvD,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,yCAAkB,CAAC;IAC1D,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gDAAqB,CAAC;IACvE,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,SAAS,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC;IACvE,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,yBAAyB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1D,qBAAqB,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAC5C,YAAY,EAAE,oDAAuB,CAAC,QAAQ,EAAE;IAChD,gBAAgB,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC/C,eAAe,EAAE,yCAAkB,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC"}
+{"version":3,"file":"create-label-response-schema.js","sourceRoot":"","sources":["../../src/responses/create-label-response-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA4D;AAC5D,yFAAmF;AACnF,yEAAqE;AACrE,mEAA+D;AAC/D,gFAA2E;AAC3E,kFAA6E;AAC7E,gFAA2E;AAC3E,kGAA4F;AAC5F,qEAAgE;AAChE,wFAAmF;AACnF,mFAA8E;AAC9E,+EAA0E;AAE7D,QAAA,yBAAyB,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAC/D,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,cAAc,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC9C,aAAa,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC5C,iBAAiB,EAAE,iDAAsB,CAAC,QAAQ,EAAE;IACpD,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAc,CAAC;IACvD,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,yCAAkB,CAAC;IAC1D,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gDAAqB,CAAC;IACvE,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,SAAS,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC;IACvE,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,yBAAyB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1D,qBAAqB,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAC5C,YAAY,EAAE,oDAAuB,CAAC,QAAQ,EAAE;IAChD,gBAAgB,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC/C,eAAe,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC9C,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAAqB,CAAC;CACvE,CAAC,CAAC"}

package/lib/responses/create-label-response.d.ts

@@ -1,6 +1,7 @@
 import { BaseResponse } from './base-response';
 import { LabelDownload, FormDownload, Document, BillingLineItem, LabelPackage, Identifier, TimeWindow, RelayPointDetails, PaperlessDetails, PudoLocation } from '../models';
 import { CarrierWeight } from '../models/units/carrier-weight';
+import { LimitIdentifier } from '../models/limit-identifier';
 /** @description Basic structure for a response to create a label */
 export declare class CreateLabelResponse extends BaseResponse {
     transaction_id: string;
@@ -24,4 +25,5 @@ export declare class CreateLabelResponse extends BaseResponse {
     dropoff_location?: PudoLocation;
     pickup_location?: PudoLocation;
     carrier_weight?: CarrierWeight;
+    limit_identifiers?: LimitIdentifier[];
 }

package/lib/responses/create-label-response.js

@@ -25,6 +25,7 @@ class CreateLabelResponse extends base_response_1.BaseResponse {
     dropoff_location;
     pickup_location;
     carrier_weight;
+    limit_identifiers;
 }
 exports.CreateLabelResponse = CreateLabelResponse;
 //# sourceMappingURL=create-label-response.js.map

package/lib/responses/create-label-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-label-response.js","sourceRoot":"","sources":["../../src/responses/create-label-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAe/C,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,cAAc,CAAU;IACxB,cAAc,CAAiB;IAC/B,aAAa,CAAgB;IAC7B,iBAAiB,CAAoB;IACrC,SAAS,CAAc;IACvB,QAAQ,CAAkB;IAC1B,kBAAkB,CAAqB;IACvC,eAAe,CAAU;IACzB,YAAY,CAAU;IACtB,SAAS,CAAW;IACpB,uBAAuB,CAAgB;IACvC,2BAA2B,CAAU;IACrC,yBAAyB,CAAU;IACnC,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,YAAY,CAAqB;IACjC,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;IAC/B,cAAc,CAAiB;CAChC;AAtBD,kDAsBC"}
+{"version":3,"file":"create-label-response.js","sourceRoot":"","sources":["../../src/responses/create-label-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAgB/C,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,cAAc,CAAU;IACxB,cAAc,CAAiB;IAC/B,aAAa,CAAgB;IAC7B,iBAAiB,CAAoB;IACrC,SAAS,CAAc;IACvB,QAAQ,CAAkB;IAC1B,kBAAkB,CAAqB;IACvC,eAAe,CAAU;IACzB,YAAY,CAAU;IACtB,SAAS,CAAW;IACpB,uBAAuB,CAAgB;IACvC,2BAA2B,CAAU;IACrC,yBAAyB,CAAU;IACnC,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,YAAY,CAAqB;IACjC,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;IAC/B,cAAc,CAAiB;IAC/B,iBAAiB,CAAqB;CACvC;AAvBD,kDAuBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.16.11",
+  "version": "4.17.0-beta",
   "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.28.10"
+    "version": "1.29.0"
   },
   "paths": {
     "/Register": {
@@ -1819,6 +1819,14 @@
             "description": "Alternative identifiers associated with this shipment.",
             "nullable": true
           },
+          "limit_identifiers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/LimitIdentifier"
+            },
+            "description": "An array that defines rate/usage limit identifiers applicable to specific functionalities within the integration. Each entry represents a unique limit configuration tied to a functionality (e.g., \"track,\" \"createLabel\").",
+            "nullable": true
+          },
           "estimated_delivery_datetime": {
             "type": "string",
             "description": "The estimated date and time for when the shipment will be delivered. Formatted per the\r\nhttps://tools.ietf.org/html/rfc3339 spec.",
@@ -3072,6 +3080,29 @@
         "additionalProperties": false,
         "description": "A key value pair, allowing custom properties to be stored."
       },
+      "LimitIdentifier": {
+        "required": [
+          "type",
+          "value"
+        ],
+        "type": "object",
+        "properties": {
+          "type": {
+            "$ref": "#/components/schemas/LimitIdentifierType"
+          },
+          "value": {
+            "type": "string",
+            "description": "A unique identifier referencing the specific rate/usage limit configuration in the Rate Limiter."
+          }
+        }
+      },
+      "LimitIdentifierType": {
+        "type": "string",
+        "description": "The name of the functionality associated with this limit (e.g., \"track\").",
+        "enum": [
+          "track"
+        ]
+      },
       "ImportTrackingEventsRequest": {
         "required": [
           "transaction_id"
@@ -5838,4 +5869,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}

package/src/models/limit-identifier-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { LimitIdentifierTypeSchema } from './limit-identifier-type-schema';
+
+export const LimitIdentifierSchema = Joi.object({
+  type: LimitIdentifierTypeSchema.required(),
+  value: Joi.string().required(),
+});

package/src/models/limit-identifier-type-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { LimitIdentifierType } from './limit-identifier-type';
+
+export const LimitIdentifierTypeSchema = Joi.string().valid(...Object.values(LimitIdentifierType));

package/src/models/limit-identifier-type.ts

@@ -0,0 +1,3 @@
+export enum LimitIdentifierType {
+  Track = 'track',
+}

package/src/models/limit-identifier.ts

@@ -0,0 +1,6 @@
+import { LimitIdentifierType } from './limit-identifier-type';
+
+export class LimitIdentifier {
+  type!: LimitIdentifierType;
+  value!: string;
+}

package/src/responses/create-label-response-schema.ts

@@ -10,6 +10,7 @@ import { RelayPointDetailsSchema } from '../models/relay-points/relay-point-deta
 import { TimeWindowSchema } from '../models/time-window-schema';
 import { PaperlessDetailsSchema } from '../models/labels/paperless-details-schema';
 import { PudoLocationSchema } from '../models/addresses/pudo-location-schema';
+import { LimitIdentifierSchema } from '../models/limit-identifier-schema';
 
 export const CreateLabelResponseSchema = BaseResponseSchema.keys({
   transaction_id: Joi.string().required(),
@@ -30,4 +31,5 @@ export const CreateLabelResponseSchema = BaseResponseSchema.keys({
   relay_points: RelayPointDetailsSchema.optional(),
   dropoff_location: PudoLocationSchema.optional(),
   pickup_location: PudoLocationSchema.optional(),
+  limit_identifiers: Joi.array().optional().items(LimitIdentifierSchema),
 });

package/src/responses/create-label-response.ts

@@ -12,6 +12,7 @@ import {
   PudoLocation,
 } from '../models';
 import { CarrierWeight } from '../models/units/carrier-weight';
+import { LimitIdentifier } from '../models/limit-identifier';
 
 /** @description Basic structure for a response to create a label */
 export class CreateLabelResponse extends BaseResponse {
@@ -36,4 +37,5 @@ export class CreateLabelResponse extends BaseResponse {
   dropoff_location?: PudoLocation;
   pickup_location?: PudoLocation;
   carrier_weight?: CarrierWeight;
+  limit_identifiers?: LimitIdentifier[];
 }