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

package/src/requests/start-tracking-request.ts

@@ -0,0 +1,9 @@
+import { BaseRequest } from './base-request';
+import { Identifier } from '../models/identifier';
+
+/**
+ * @description Request to start tracking shipments using identifiers
+ */
+export class StartTrackingRequest extends BaseRequest {
+  identifiers!: Identifier[];
+}

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

@@ -10,7 +10,6 @@ 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(),
@@ -31,5 +30,4 @@ 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,7 +12,6 @@ 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 {
@@ -37,5 +36,4 @@ export class CreateLabelResponse extends BaseResponse {
   dropoff_location?: PudoLocation;
   pickup_location?: PudoLocation;
   carrier_weight?: CarrierWeight;
-  limit_identifiers?: LimitIdentifier[];
 }

package/src/responses/index.ts

@@ -33,3 +33,5 @@ export * from './void-labels-response-schema';
 export * from './void-labels-response';
 export * from './update-settings-response-schema';
 export * from './update-settings-response';
+export * from './start-tracking-response';
+export * from './start-tracking-response-schema';

package/src/responses/start-tracking-response-schema.ts

@@ -0,0 +1,14 @@
+import Joi from 'joi';
+import { IdentifierSchema } from '../models/identifier-schema';
+import { BaseResponseSchema } from './base-response-schema';
+import { SubscriptionStatusSchema } from '../models/tracking/start-tracking-status-schema';
+
+export const SubscriptionResultSchema = Joi.object({
+  identifier: IdentifierSchema.required(),
+  status: SubscriptionStatusSchema,
+  message: Joi.string().required(),
+});
+
+export const StartTrackingResponseSchema = BaseResponseSchema.keys({
+  subscription_results: Joi.array().required().items(SubscriptionResultSchema),
+});

package/src/responses/start-tracking-response.ts

@@ -0,0 +1,16 @@
+import { BaseResponse } from './base-response';
+import { Identifier } from '../models';
+import { StartTrackingStatus } from '../models/tracking/start-tracking-status';
+
+/**
+ * @description Response from start tracking subscriptions
+ */
+export class StartTrackingResponse extends BaseResponse {
+  subscription_results!: SubscriptionResult[];
+}
+
+export interface SubscriptionResult {
+  identifier: Identifier;
+  status: StartTrackingStatus;
+  message: string;
+}