@shipengine/connect-carrier-api 4.4.0 → 4.4.2

package/lib/app/metadata/account-connection-specification.d.ts

@@ -0,0 +1,14 @@
+import Joi from 'joi';
+import { ConnectionNames } from './connection-names-configuration';
+export declare class AccountConnectionSpecification {
+    /** @description A Connection Name is an optional feature that an integration may provide. A
+     * common use of connections is to provide the ability to connect to a sandbox or production
+     * endpoint. This collection must be a unique set of strings representing a list of connections
+     * that a user may choose to use. When present {@link DefaultConnectionName} must also be
+     * populated.*/
+    ConnectionNames?: ConnectionNames[];
+    /** @description The default connection name to use if a connection name is not selected. This
+     * value must match a value in {@link ConnectionNames}*/
+    DefaultConnectionName?: ConnectionNames;
+}
+export declare const AccountConnectionSpecificationSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/account-connection-specification.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountConnectionSpecificationSchema = exports.AccountConnectionSpecification = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const connection_names_configuration_1 = require("./connection-names-configuration");
+class AccountConnectionSpecification {
+    /** @description A Connection Name is an optional feature that an integration may provide. A
+     * common use of connections is to provide the ability to connect to a sandbox or production
+     * endpoint. This collection must be a unique set of strings representing a list of connections
+     * that a user may choose to use. When present {@link DefaultConnectionName} must also be
+     * populated.*/
+    ConnectionNames;
+    /** @description The default connection name to use if a connection name is not selected. This
+     * value must match a value in {@link ConnectionNames}*/
+    DefaultConnectionName;
+}
+exports.AccountConnectionSpecification = AccountConnectionSpecification;
+exports.AccountConnectionSpecificationSchema = joi_1.default.object({
+    ConnectionNames: joi_1.default.array().items(connection_names_configuration_1.ConnectionNamesSchema).optional().unique(),
+    DefaultConnectionName: connection_names_configuration_1.ConnectionNamesSchema.required().optional(),
+}).and('ConnectionNames', 'DefaultConnectionName'); // and is "all or nothing"; if one is present the other must be.
+//# sourceMappingURL=account-connection-specification.js.map

package/lib/app/metadata/account-connection-specification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-connection-specification.js","sourceRoot":"","sources":["../../../src/app/metadata/account-connection-specification.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,qFAA0F;AAE1F,MAAa,8BAA8B;IACzC;;;;mBAIe;IACf,eAAe,CAAqB;IACpC;4DACwD;IACxD,qBAAqB,CAAmB;CACzC;AAVD,wEAUC;AAEY,QAAA,oCAAoC,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7D,eAAe,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,sDAAqB,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE;IAC7E,qBAAqB,EAAE,sDAAqB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACnE,CAAC,CAAC,GAAG,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,CAAC,CAAC,gEAAgE"}

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

@@ -11,6 +11,7 @@ import Joi from 'joi';
 import { NativeRatingConfiguration } from './native-rating-configuration';
 import { Zone } from './zone';
 import { PackageRatingGroup } from './package-rating-group';
+import { AccountConnectionSpecification } from './account-connection-specification';
 /** @description Basic structure for each carrier */
 export interface Carrier {
     /** @description Defines UI Modals for connecting and updating settings */
@@ -58,5 +59,7 @@ export interface Carrier {
     Zones?: Zone[];
     /** @description List of package rating groups for the carrier */
     PackageRatingGroups?: PackageRatingGroup[];
+    /** @description Specifies account connection information */
+    AccountConnection?: AccountConnectionSpecification;
 }
 export declare const CarrierSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/carrier.js

@@ -17,6 +17,7 @@ const file_exists_1 = require("./custom-validators/file-exists");
 const zone_1 = require("./zone");
 const connect_runtime_1 = require("@shipengine/connect-runtime");
 const package_rating_group_1 = require("./package-rating-group");
+const account_connection_specification_1 = require("./account-connection-specification");
 exports.CarrierSchema = joi_1.default.object({
     AccountModals: account_modals_1.AccountModalsSchema.required(),
     PackageTypes: joi_1.default.array().optional().items(package_type_1.PackageTypeSchema).unique('Id'),
@@ -53,12 +54,9 @@ exports.CarrierSchema = joi_1.default.object({
             .message('Images.Logo must be a svg file.'),
     }).required(),
     NativeRating: native_rating_configuration_1.NativeRatingConfigurationSchema.optional(),
-    DocumentTemplate: joi_1.default.string()
-        .optional()
-        .custom(file_exists_1.fileExists, 'template exists')
-        .pattern(new RegExp('^.*.carrier$'))
-        .message('Template file must have .carrier extension.'),
+    DocumentTemplate: joi_1.default.string().optional().custom(file_exists_1.fileExists, 'template exists'),
     Zones: joi_1.default.array().optional().items(zone_1.ZoneSchema).unique('ApiCode'),
     PackageRatingGroups: joi_1.default.array().optional().items(package_rating_group_1.PackageRatingGroupSchema).unique('Id'),
+    AccountConnection: account_connection_specification_1.AccountConnectionSpecificationSchema.optional(),
 }).with('DocumentTemplate', 'ApiCode');
 //# sourceMappingURL=carrier.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier.ts"],"names":[],"mappings":";;;;AAAA,qDAAsE;AACtE,iDAAgE;AAChE,yDAA4E;AAC5E,uDAA6F;AAC7F,+DAAqF;AACrF,6DAAwF;AACxF,mDAA2E;AAC3E,+CAAqE;AACrE,2DAA2F;AAC3F,sDAAsB;AACtB,+EAGuC;AACvC,iEAA6D;AAC7D,iCAA0C;AAE1C,iEAAqF;AACrF,iEAAsF;AAmDzE,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,oCAAmB,CAAC,QAAQ,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAiB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1E,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,wCAAqB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAClF,eAAe,EAAE,gDAA8B,CAAC,QAAQ,EAAE;IAC1D,yBAAyB,EAAE,aAAG,CAAC,KAAK,EAAE;SACnC,QAAQ,EAAE;SACV,KAAK,CAAC,8CAAwB,CAAC;SAC/B,MAAM,CAAC,aAAa,CAAC;IACxB,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAC9E,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAAsB,CAAC,CAAC,MAAM,EAAE;IAC3E,wBAAwB,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACjE,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAA0B,CAAC,CAAC,MAAM,EAAE;IACpF,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;SACtB,QAAQ,EAAE;SACV,OAAO,CACN,IAAI,MAAM,CACR,iGAAiG,CAClG,CACF;SACA,OAAO,CAAC,qBAAqB,CAAC;SAC9B,GAAG,CAAC,GAAG,CAAC;IACX,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAClD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;IAChF,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,aAAG,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;QAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;KAC9C,CAAC,CAAC,QAAQ,EAAE;IACb,YAAY,EAAE,6DAA+B,CAAC,QAAQ,EAAE;IACxD,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE;SAC3B,QAAQ,EAAE;SACV,MAAM,CAAC,wBAAU,EAAE,iBAAiB,CAAC;SACrC,OAAO,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,CAAC;SACnC,OAAO,CAAC,6CAA6C,CAAC;IACzD,KAAK,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iBAAU,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;IACjE,mBAAmB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAAwB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;CACzF,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC"}
+{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier.ts"],"names":[],"mappings":";;;;AAAA,qDAAsE;AACtE,iDAAgE;AAChE,yDAA4E;AAC5E,uDAA6F;AAC7F,+DAAqF;AACrF,6DAAwF;AACxF,mDAA2E;AAC3E,+CAAqE;AACrE,2DAA2F;AAC3F,sDAAsB;AACtB,+EAGuC;AACvC,iEAA6D;AAC7D,iCAA0C;AAE1C,iEAAqF;AACrF,iEAAsF;AACtF,yFAG4C;AAqD/B,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,oCAAmB,CAAC,QAAQ,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAiB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1E,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,wCAAqB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAClF,eAAe,EAAE,gDAA8B,CAAC,QAAQ,EAAE;IAC1D,yBAAyB,EAAE,aAAG,CAAC,KAAK,EAAE;SACnC,QAAQ,EAAE;SACV,KAAK,CAAC,8CAAwB,CAAC;SAC/B,MAAM,CAAC,aAAa,CAAC;IACxB,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAC9E,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAAsB,CAAC,CAAC,MAAM,EAAE;IAC3E,wBAAwB,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACjE,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAA0B,CAAC,CAAC,MAAM,EAAE;IACpF,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;SACtB,QAAQ,EAAE;SACV,OAAO,CACN,IAAI,MAAM,CACR,iGAAiG,CAClG,CACF;SACA,OAAO,CAAC,qBAAqB,CAAC;SAC9B,GAAG,CAAC,GAAG,CAAC;IACX,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAClD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;IAChF,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,aAAG,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;QAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;KAC9C,CAAC,CAAC,QAAQ,EAAE;IACb,YAAY,EAAE,6DAA+B,CAAC,QAAQ,EAAE;IACxD,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,wBAAU,EAAE,iBAAiB,CAAC;IAC/E,KAAK,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iBAAU,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;IACjE,mBAAmB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAAwB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IACxF,iBAAiB,EAAE,uEAAoC,CAAC,QAAQ,EAAE;CACnE,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC"}

package/lib/app/metadata/connection-names-configuration.d.ts

@@ -0,0 +1,13 @@
+import Joi from 'joi';
+export type ConnectionNames = 'sandbox' | 'production' | string;
+export declare class ConnectionNamesConfiguration {
+    /** @description A unique list of connection names that the integration supports. */
+    connection_names: {
+        [key in ConnectionNames]: any;
+    };
+    /** @description The connection name that will be used when none is selected. */
+    default_connection_name: ConnectionNames;
+}
+export declare const ConnectionNamesSchema: Joi.AlternativesSchema;
+export declare const MapOfObjectsSchema: Joi.ObjectSchema<any>;
+export declare const ConnectionNamesConfigurationSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/connection-names-configuration.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionNamesConfigurationSchema = exports.MapOfObjectsSchema = exports.ConnectionNamesSchema = exports.ConnectionNamesConfiguration = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+class ConnectionNamesConfiguration {
+    /** @description A unique list of connection names that the integration supports. */
+    connection_names;
+    /** @description The connection name that will be used when none is selected. */
+    default_connection_name;
+}
+exports.ConnectionNamesConfiguration = ConnectionNamesConfiguration;
+exports.ConnectionNamesSchema = joi_1.default.alternatives().try('sandbox', 'production');
+exports.MapOfObjectsSchema = joi_1.default.object().pattern(exports.ConnectionNamesSchema, joi_1.default.object());
+exports.ConnectionNamesConfigurationSchema = joi_1.default.object({
+    connection_names: exports.MapOfObjectsSchema.required(),
+    default_connection_name: exports.ConnectionNamesSchema.required(),
+});
+//# sourceMappingURL=connection-names-configuration.js.map

package/lib/app/metadata/connection-names-configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection-names-configuration.js","sourceRoot":"","sources":["../../../src/app/metadata/connection-names-configuration.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAItB,MAAa,4BAA4B;IACvC,oFAAoF;IACpF,gBAAgB,CAEd;IACF,gFAAgF;IAChF,uBAAuB,CAAmB;CAC3C;AAPD,oEAOC;AAEY,QAAA,qBAAqB,GAAG,aAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;AACxE,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,6BAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,CAAC;AAC/E,QAAA,kCAAkC,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3D,gBAAgB,EAAE,0BAAkB,CAAC,QAAQ,EAAE;IAC/C,uBAAuB,EAAE,6BAAqB,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC"}

package/lib/app/metadata/index.d.ts

@@ -23,3 +23,5 @@ export * from './shipping-option';
 export * from './shipping-provider-connector';
 export * from './shipping-service';
 export * from './zone';
+export * from './connection-names-configuration';
+export * from './account-connection-specification';

package/lib/app/metadata/index.js

@@ -26,4 +26,6 @@ tslib_1.__exportStar(require("./shipping-option"), exports);
 tslib_1.__exportStar(require("./shipping-provider-connector"), exports);
 tslib_1.__exportStar(require("./shipping-service"), exports);
 tslib_1.__exportStar(require("./zone"), exports);
+tslib_1.__exportStar(require("./connection-names-configuration"), exports);
+tslib_1.__exportStar(require("./account-connection-specification"), exports);
 //# sourceMappingURL=index.js.map

package/lib/app/metadata/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/metadata/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,4DAAkC;AAClC,+DAAqC;AACrC,oDAA0B;AAC1B,iEAAuC;AACvC,+DAAqC;AACrC,8DAAoC;AACpC,gEAAsC;AACtC,8DAAoC;AACpC,kDAAwB;AACxB,qDAA2B;AAC3B,0DAAgC;AAChC,wDAA8B;AAC9B,qDAA2B;AAC3B,wEAA8C;AAC9C,yDAA+B;AAC/B,sDAA4B;AAC5B,0DAAgC;AAChC,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,4DAAkC;AAClC,wEAA8C;AAC9C,6DAAmC;AACnC,iDAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/metadata/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,4DAAkC;AAClC,+DAAqC;AACrC,oDAA0B;AAC1B,iEAAuC;AACvC,+DAAqC;AACrC,8DAAoC;AACpC,gEAAsC;AACtC,8DAAoC;AACpC,kDAAwB;AACxB,qDAA2B;AAC3B,0DAAgC;AAChC,wDAA8B;AAC9B,qDAA2B;AAC3B,wEAA8C;AAC9C,yDAA+B;AAC/B,sDAA4B;AAC5B,0DAAgC;AAChC,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,4DAAkC;AAClC,wEAA8C;AAC9C,6DAAmC;AACnC,iDAAuB;AACvB,2EAAiD;AACjD,6EAAmD"}

package/lib/requests/base-request.d.ts

@@ -1,3 +1,4 @@
+import { ConnectionNames } from '../app/metadata/connection-names-configuration';
 import { Authorization } from '../models';
 export declare class BaseRequest {
     transaction_id: string;
@@ -5,4 +6,6 @@ export declare class BaseRequest {
     metadata?: {
         [key: string]: any;
     };
+    /** @description The name of the connection used, if this app has {@link ConnectionNamesConfiguration} defined*/
+    connection_name?: ConnectionNames;
 }

package/lib/requests/base-request.js

@@ -5,6 +5,8 @@ class BaseRequest {
     transaction_id;
     authorization;
     metadata;
+    /** @description The name of the connection used, if this app has {@link ConnectionNamesConfiguration} defined*/
+    connection_name;
 }
 exports.BaseRequest = BaseRequest;
 //# sourceMappingURL=base-request.js.map

package/lib/requests/base-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-request.js","sourceRoot":"","sources":["../../src/requests/base-request.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;IACtB,cAAc,CAAU;IACxB,aAAa,CAAiB;IAC9B,QAAQ,CAA0B;CACnC;AAJD,kCAIC"}
+{"version":3,"file":"base-request.js","sourceRoot":"","sources":["../../src/requests/base-request.ts"],"names":[],"mappings":";;;AAGA,MAAa,WAAW;IACtB,cAAc,CAAU;IACxB,aAAa,CAAiB;IAC9B,QAAQ,CAA0B;IAClC,gHAAgH;IAChH,eAAe,CAAmB;CACnC;AAND,kCAMC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.4.0",
+  "version": "4.4.2",
   "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.19.0"
+    "version": "1.19.1"
   },
   "paths": {
     "/Register": {
@@ -853,6 +853,11 @@
             "type": "object",
             "additionalProperties": { },
             "nullable": true
+          },
+          "connection_name": {
+            "type": "string",
+            "description": "The name of the connection to use, if this app has connection names defined",
+            "nullable": true
           }
         },
         "additionalProperties": false

package/src/app/metadata/account-connection-specification.ts

@@ -0,0 +1,19 @@
+import Joi from 'joi';
+import { ConnectionNames, ConnectionNamesSchema } from './connection-names-configuration';
+
+export class AccountConnectionSpecification {
+  /** @description A Connection Name is an optional feature that an integration may provide. A
+   * common use of connections is to provide the ability to connect to a sandbox or production
+   * endpoint. This collection must be a unique set of strings representing a list of connections
+   * that a user may choose to use. When present {@link DefaultConnectionName} must also be
+   * populated.*/
+  ConnectionNames?: ConnectionNames[];
+  /** @description The default connection name to use if a connection name is not selected. This
+   * value must match a value in {@link ConnectionNames}*/
+  DefaultConnectionName?: ConnectionNames;
+}
+
+export const AccountConnectionSpecificationSchema = Joi.object({
+  ConnectionNames: Joi.array().items(ConnectionNamesSchema).optional().unique(),
+  DefaultConnectionName: ConnectionNamesSchema.required().optional(),
+}).and('ConnectionNames', 'DefaultConnectionName'); // and is "all or nothing"; if one is present the other must be.

package/src/app/metadata/carrier.ts

@@ -17,6 +17,10 @@ import { Zone, ZoneSchema } from './zone';
 
 import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
 import { PackageRatingGroup, PackageRatingGroupSchema } from './package-rating-group';
+import {
+  AccountConnectionSpecification,
+  AccountConnectionSpecificationSchema,
+} from './account-connection-specification';
 
 /** @description Basic structure for each carrier */
 export interface Carrier {
@@ -65,6 +69,8 @@ export interface Carrier {
   Zones?: Zone[];
   /** @description List of package rating groups for the carrier */
   PackageRatingGroups?: PackageRatingGroup[];
+  /** @description Specifies account connection information */
+  AccountConnection?: AccountConnectionSpecification;
 }
 
 export const CarrierSchema = Joi.object({
@@ -107,11 +113,8 @@ export const CarrierSchema = Joi.object({
       .message('Images.Logo must be a svg file.'),
   }).required(),
   NativeRating: NativeRatingConfigurationSchema.optional(),
-  DocumentTemplate: Joi.string()
-    .optional()
-    .custom(fileExists, 'template exists')
-    .pattern(new RegExp('^.*.carrier$'))
-    .message('Template file must have .carrier extension.'),
+  DocumentTemplate: Joi.string().optional().custom(fileExists, 'template exists'),
   Zones: Joi.array().optional().items(ZoneSchema).unique('ApiCode'),
   PackageRatingGroups: Joi.array().optional().items(PackageRatingGroupSchema).unique('Id'),
+  AccountConnection: AccountConnectionSpecificationSchema.optional(),
 }).with('DocumentTemplate', 'ApiCode');

package/src/app/metadata/connection-names-configuration.ts

@@ -0,0 +1,19 @@
+import Joi from 'joi';
+
+export type ConnectionNames = 'sandbox' | 'production' | string;
+
+export class ConnectionNamesConfiguration {
+  /** @description A unique list of connection names that the integration supports. */
+  connection_names!: {
+    [key in ConnectionNames]: any;
+  };
+  /** @description The connection name that will be used when none is selected. */
+  default_connection_name!: ConnectionNames;
+}
+
+export const ConnectionNamesSchema = Joi.alternatives().try('sandbox', 'production');
+export const MapOfObjectsSchema = Joi.object().pattern(ConnectionNamesSchema, Joi.object());
+export const ConnectionNamesConfigurationSchema = Joi.object({
+  connection_names: MapOfObjectsSchema.required(),
+  default_connection_name: ConnectionNamesSchema.required(),
+});

package/src/app/metadata/index.ts

@@ -23,3 +23,5 @@ export * from './shipping-option';
 export * from './shipping-provider-connector';
 export * from './shipping-service';
 export * from './zone';
+export * from './connection-names-configuration';
+export * from './account-connection-specification';

package/src/requests/base-request.ts

@@ -1,7 +1,10 @@
+import { ConnectionNames } from '../app/metadata/connection-names-configuration';
 import { Authorization } from '../models';
 
 export class BaseRequest {
   transaction_id!: string;
   authorization?: Authorization;
   metadata?: { [key: string]: any };
+  /** @description The name of the connection used, if this app has {@link ConnectionNamesConfiguration} defined*/
+  connection_name?: ConnectionNames;
 }