@shipengine/connect-carrier-api 2.1.22 → 2.1.23

package/lib/app/internal/{carrier-app-specificaion.d.ts → carrier-app-specification.d.ts}

@@ -1,5 +1,6 @@
+import { AuthSpecification } from '../metadata/auth-specification';
 import { ShippingProviderConnector } from '../metadata/shipping-provider-connector';
-import { CarrierSpecification } from './carrier-specificaion';
+import { CarrierSpecification } from './carrier-specification';
 /** @description This represents a single integration which may contain multiple carrier sources */
 export interface CarrierAppSpecification {
     /** @description The id for this integration */
@@ -8,6 +9,8 @@ export interface CarrierAppSpecification {
     Name: string;
     /** @description Information about the connector */
     Connector: ShippingProviderConnector;
+    /** @description The specification for authorizing with this carrier */
+    AuthProcess?: AuthSpecification;
     /** @description A list of carrier sources associated with this integration */
     Carriers: CarrierSpecification[];
 }

package/lib/app/internal/{carrier-app-specificaion.js → carrier-app-specification.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=carrier-app-specificaion.js.map
+//# sourceMappingURL=carrier-app-specification.js.map

package/lib/app/internal/carrier-app-specification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"carrier-app-specification.js","sourceRoot":"","sources":["../../../src/app/internal/carrier-app-specification.ts"],"names":[],"mappings":""}

package/lib/app/internal/{carrier-specificaion.js → carrier-specification.js}

@@ -59,4 +59,4 @@ class CarrierSpecification {
     }
 }
 exports.CarrierSpecification = CarrierSpecification;
-//# sourceMappingURL=carrier-specificaion.js.map
+//# sourceMappingURL=carrier-specification.js.map

package/lib/app/internal/carrier-specification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"carrier-specification.js","sourceRoot":"","sources":["../../../src/app/internal/carrier-specification.ts"],"names":[],"mappings":";;;AAoBO,MAAM,kBAAkB,GAAG,CAChC,OAAkC,EACJ,EAAE;IAChC,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,GAAG,GAAqB,EAAE,CAAC;IACjC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QAC3C,MAAM,IAAI,GAAG,GAAyB,CAAC;QACvC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,IAAI,CAA8B,CAAC;QACzE,GAAG,CAAC,IAAI,CAAC;YACP,IAAI;YACJ,WAAW;YACX,IAAI;SACL,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAjBW,QAAA,kBAAkB,sBAiB7B;AAEK,MAAM,oBAAoB,GAAG,CAClC,KAA8B,EACV,EAAE;IACtB,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,EAAE,CAAC;KACX;IACD,MAAM,GAAG,GAAuB,EAAE,CAAC;IACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAQ,EAAE,EAAE;QACtC,MAAM,aAAa,GAAG,KAA+B,CAAC;QACtD,MAAM,IAAI,GAAG,GAA2B,CAAC;QACzC,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAW,CAAC;QAC3C,GAAG,CAAC,IAAI,CAAC;YACP,IAAI;YACJ,IAAI;SACL,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAjBW,QAAA,oBAAoB,wBAiB/B;AAEF,gEAAgE;AAChE,MAAa,oBAAoB;IAoB/B,YAAY,UAAmB;QAC7B,IAAI,CAAC,MAAM,GAAG;YACZ,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI;YAC/B,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI;SAChC,CAAC;QACF,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,eAAe,GAAG,0BAAkB,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QACtE,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC,yBAAyB,CAAC;QACtE,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,wBAAwB,GAAG,4BAAoB,CAClD,UAAU,CAAC,wBAAwB,CACpC,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IAC5C,CAAC;CACF;AA1CD,oDA0CC"}

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

@@ -1,11 +1,13 @@
 import { CarrierAppDefinition } from '../carrier-app-definition';
 import { ShippingProviderConnector } from '../metadata/shipping-provider-connector';
-import { CarrierAppSpecification } from './carrier-app-specificaion';
-import { CarrierSpecification } from './carrier-specificaion';
+import { CarrierAppSpecification } from './carrier-app-specification';
+import { CarrierSpecification } from './carrier-specification';
+import { AuthSpecification } from '../metadata/auth-specification';
 export declare class Metadata implements CarrierAppSpecification {
     Id: string;
     Name: string;
     Connector: ShippingProviderConnector;
+    AuthProcess?: AuthSpecification;
     Carriers: CarrierSpecification[];
     constructor(app: CarrierAppDefinition);
 }

package/lib/app/internal/metadata.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Metadata = void 0;
-const carrier_specificaion_1 = require("./carrier-specificaion");
+const carrier_specification_1 = require("./carrier-specification");
 const fn = (name) => ({
     Name: name,
     IsSandboxed: false,
@@ -38,7 +38,11 @@ class Metadata {
     constructor(app) {
         this.Id = app.Metadata.Id;
         this.Name = app.Metadata.Name;
-        this.Carriers = app.Metadata.Carriers.map((c) => new carrier_specificaion_1.CarrierSpecification(c));
+        this.AuthProcess = app.Metadata.AuthProcess;
+        if (this.AuthProcess) {
+            this.AuthProcess.Identifier.Version = '2.0';
+        }
+        this.Carriers = app.Metadata.Carriers.map((c) => new carrier_specification_1.CarrierSpecification(c));
         this.Connector = {
             DiagnosticRoutes: {
                 Liveness: '/diagnostics/liveness',

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

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/app/internal/metadata.ts"],"names":[],"mappings":";;;AAKA,iEAA8D;AAE9D,MAAM,EAAE,GAAG,CAAC,IAAY,EAAyB,EAAE,CAAC,CAAC;IACnD,IAAI,EAAE,IAAI;IACV,WAAW,EAAE,KAAK;CACnB,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,GAAyB,EAA2B,EAAE;IAC1E,MAAM,GAAG,GAA4B,EAAE,CAAC;IAExC,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;KAC1B;IAED,IAAI,GAAG,CAAC,WAAW,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;KAC7B;IAED,IAAI,GAAG,CAAC,UAAU,EAAE;QAClB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;KAC5B;IAED,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;KAChC;IAED,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;KAChC;IAED,IAAI,GAAG,CAAC,YAAY,EAAE;QACpB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;KAC9B;IAED,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;KAC1B;IAED,IAAI,GAAG,CAAC,KAAK,EAAE;QACb,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;KACvB;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAa,QAAQ;IAMnB,YAAY,GAAyB;QACnC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,2CAAoB,CAAC,CAAC,CAAC,CACnC,CAAC;QAEF,IAAI,CAAC,SAAS,GAAG;YACf,gBAAgB,EAAE;gBAChB,QAAQ,EAAE,uBAAuB;gBACjC,SAAS,EAAE,wBAAwB;gBACnC,OAAO,EAAE,sBAAsB;aAChC;YACD,UAAU,EAAE,OAAO;YACnB,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;CACF;AAvBD,4BAuBC"}
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/app/internal/metadata.ts"],"names":[],"mappings":";;;AAKA,mEAA+D;AAG/D,MAAM,EAAE,GAAG,CAAC,IAAY,EAAyB,EAAE,CAAC,CAAC;IACnD,IAAI,EAAE,IAAI;IACV,WAAW,EAAE,KAAK;CACnB,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,GAAyB,EAA2B,EAAE;IAC1E,MAAM,GAAG,GAA4B,EAAE,CAAC;IAExC,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;KAC1B;IAED,IAAI,GAAG,CAAC,WAAW,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;KAC7B;IAED,IAAI,GAAG,CAAC,UAAU,EAAE;QAClB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;KAC5B;IAED,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;KAChC;IAED,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;KAChC;IAED,IAAI,GAAG,CAAC,YAAY,EAAE;QACpB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;KAC9B;IAED,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;KAC1B;IAED,IAAI,GAAG,CAAC,KAAK,EAAE;QACb,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;KACvB;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAa,QAAQ;IAOnB,YAAY,GAAyB;QACnC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC5C,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;SAC7C;QACD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,4CAAoB,CAAC,CAAC,CAAC,CACnC,CAAC;QAEF,IAAI,CAAC,SAAS,GAAG;YACf,gBAAgB,EAAE;gBAChB,QAAQ,EAAE,uBAAuB;gBACjC,SAAS,EAAE,wBAAwB;gBACnC,OAAO,EAAE,sBAAsB;aAChC;YACD,UAAU,EAAE,OAAO;YACnB,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;CACF;AA5BD,4BA4BC"}

package/lib/app/metadata/auth-identifier.d.ts

@@ -0,0 +1,10 @@
+import Joi from 'joi';
+export declare enum AuthenticationType {
+    OAuth = "oauth"
+}
+export declare class AuthIdentifier {
+    AuthenticationType: AuthenticationType;
+    Version?: string;
+    IsSandbox?: boolean;
+}
+export declare const AuthIdentifierSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/auth-identifier.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthIdentifierSchema = exports.AuthIdentifier = exports.AuthenticationType = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+var AuthenticationType;
+(function (AuthenticationType) {
+    AuthenticationType["OAuth"] = "oauth";
+})(AuthenticationType = exports.AuthenticationType || (exports.AuthenticationType = {}));
+class AuthIdentifier {
+}
+exports.AuthIdentifier = AuthIdentifier;
+exports.AuthIdentifierSchema = joi_1.default.object({
+    AuthenticationType: joi_1.default.string().required().valid('oauth'),
+    Version: joi_1.default.string().optional(),
+    IsSandbox: joi_1.default.bool().optional(),
+});
+//# sourceMappingURL=auth-identifier.js.map

package/lib/app/metadata/auth-identifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-identifier.js","sourceRoot":"","sources":["../../../src/app/metadata/auth-identifier.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,qCAAe,CAAA;AACjB,CAAC,EAFW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAE7B;AAED,MAAa,cAAc;CAI1B;AAJD,wCAIC;AAEY,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,kBAAkB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;IAC1D,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,aAAG,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC"}

package/lib/app/metadata/auth-specification.d.ts

@@ -0,0 +1,19 @@
+import { AuthIdentifier } from './auth-identifier';
+import { AccessToken, AuthorizationConfiguration, Parameter, RefreshTokenConfiguration, RequestTokenConfiguration } from './monoauth';
+import Joi from 'joi';
+/** @description Used to specify information about an integrations authentication */
+export declare class AuthSpecification {
+    /** @description Identify the type of Auth being used by the integration */
+    Identifier: AuthIdentifier;
+    /** @description Added to allow oauth 1.0 to work. */
+    access_token?: AccessToken;
+    /** @description Authorization: the beginning of an OAuth2.0 flow that ensures the user is logged in and approves access to the Resource. */
+    authorization?: AuthorizationConfiguration;
+    /** @description Request Token: server-server code for token exchange */
+    request_token?: RequestTokenConfiguration;
+    /** @description Refresh Token: server-server refresh token exchange for access token **NOTE: sometimes a new RT is also created** */
+    refresh_token?: RefreshTokenConfiguration;
+    /** @description Advanced configurations used for oauth 1.0 */
+    advanced_configuration?: Parameter[];
+}
+export declare const AuthSpecificationSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/auth-specification.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthSpecificationSchema = exports.AuthSpecification = void 0;
+const tslib_1 = require("tslib");
+const auth_identifier_1 = require("./auth-identifier");
+const monoauth_1 = require("./monoauth");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+/** @description Used to specify information about an integrations authentication */
+class AuthSpecification {
+}
+exports.AuthSpecification = AuthSpecification;
+exports.AuthSpecificationSchema = joi_1.default.object({
+    Identifier: auth_identifier_1.AuthIdentifierSchema,
+    access_token: monoauth_1.AccessTokenSchema.optional(),
+    authorization: monoauth_1.AuthorizationConfigurationSchema.optional(),
+    request_token: monoauth_1.RequestTokenConfigurationSchema.optional(),
+    refresh_token: monoauth_1.RefreshTokenConfigurationSchema.optional(),
+    advanced_configuration: joi_1.default.array().optional().items(monoauth_1.ParameterSchema),
+});
+//# sourceMappingURL=auth-specification.js.map

package/lib/app/metadata/auth-specification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-specification.js","sourceRoot":"","sources":["../../../src/app/metadata/auth-specification.ts"],"names":[],"mappings":";;;;AAAA,uDAAyE;AACzE,yCAWoB;AACpB,sDAAsB;AAEtB,oFAAoF;AACpF,MAAa,iBAAiB;CAa7B;AAbD,8CAaC;AAEY,QAAA,uBAAuB,GAAG,aAAG,CAAC,MAAM,CAAC;IAChD,UAAU,EAAE,sCAAoB;IAChC,YAAY,EAAE,4BAAiB,CAAC,QAAQ,EAAE;IAC1C,aAAa,EAAE,2CAAgC,CAAC,QAAQ,EAAE;IAC1D,aAAa,EAAE,0CAA+B,CAAC,QAAQ,EAAE;IACzD,aAAa,EAAE,0CAA+B,CAAC,QAAQ,EAAE;IACzD,sBAAsB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0BAAe,CAAC;CACtE,CAAC,CAAC"}

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

@@ -1,10 +1,12 @@
 import Joi from 'joi';
-import { Carrier } from './carrier';
+import { AuthSpecification, Carrier } from '.';
 export interface CarrierAppMetadata {
     /** @description Id of the carrier app */
     Id: string;
     /** @description Name of the carrier */
     Name: string;
+    /** @description The specification for authorizing with this order source */
+    AuthProcess?: AuthSpecification;
     /** @description List of carriers for the app */
     Carriers: Carrier[];
 }

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

@@ -3,17 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CarrierAppMetadataSchema = void 0;
 const tslib_1 = require("tslib");
 const joi_1 = tslib_1.__importDefault(require("joi"));
-const carrier_1 = require("./carrier");
+const _1 = require(".");
 exports.CarrierAppMetadataSchema = joi_1.default.object({
     Id: joi_1.default.string()
         .uuid({ version: ['uuidv4'] })
         .required(),
     Name: joi_1.default.string().required(),
+    AuthProcess: _1.AuthSpecificationSchema.optional(),
     Carriers: joi_1.default.array()
         .unique('Id')
         .required()
         .min(1)
         .message('There must be at least 1 Carrier defined')
-        .items(carrier_1.CarrierSchema),
+        .items(_1.CarrierSchema),
 });
 //# 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,uCAAmD;AAWtC,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE;SACb,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;SAC7B,QAAQ,EAAE;IACb,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,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,uBAAa,CAAC;CACxB,CAAC,CAAC"}
+{"version":3,"file":"carrier-app-metadata.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-app-metadata.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAKW;AAaE,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE;SACb,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;SAC7B,QAAQ,EAAE;IACb,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;CACxB,CAAC,CAAC"}

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

@@ -1,7 +1,9 @@
 export * from './account-modals';
+export * from './auth-identifier';
+export * from './auth-specification';
+export * from './carrier';
 export * from './carrier-app-metadata';
 export * from './carrier-attributes';
-export * from './carrier';
 export * from './confirmation-type';
 export * from './country-association';
 export * from './diagnostic-routes';
@@ -9,6 +11,7 @@ export * from './enums';
 export * from './function';
 export * from './label-formats';
 export * from './label-sizes';
+export * from './monoauth';
 export * from './package-type';
 export * from './service-class';
 export * from './service-grade';

package/lib/app/metadata/index.js

@@ -2,9 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./account-modals"), exports);
+tslib_1.__exportStar(require("./auth-identifier"), exports);
+tslib_1.__exportStar(require("./auth-specification"), exports);
+tslib_1.__exportStar(require("./carrier"), exports);
 tslib_1.__exportStar(require("./carrier-app-metadata"), exports);
 tslib_1.__exportStar(require("./carrier-attributes"), exports);
-tslib_1.__exportStar(require("./carrier"), exports);
 tslib_1.__exportStar(require("./confirmation-type"), exports);
 tslib_1.__exportStar(require("./country-association"), exports);
 tslib_1.__exportStar(require("./diagnostic-routes"), exports);
@@ -12,6 +14,7 @@ tslib_1.__exportStar(require("./enums"), exports);
 tslib_1.__exportStar(require("./function"), exports);
 tslib_1.__exportStar(require("./label-formats"), exports);
 tslib_1.__exportStar(require("./label-sizes"), exports);
+tslib_1.__exportStar(require("./monoauth"), exports);
 tslib_1.__exportStar(require("./package-type"), exports);
 tslib_1.__exportStar(require("./service-class"), exports);
 tslib_1.__exportStar(require("./service-grade"), exports);

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,iEAAuC;AACvC,+DAAqC;AACrC,oDAA0B;AAC1B,8DAAoC;AACpC,gEAAsC;AACtC,8DAAoC;AACpC,kDAAwB;AACxB,qDAA2B;AAC3B,0DAAgC;AAChC,wDAA8B;AAC9B,yDAA+B;AAC/B,0DAAgC;AAChC,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,4DAAkC;AAClC,wEAA8C;AAC9C,6DAAmC"}
+{"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,yDAA+B;AAC/B,0DAAgC;AAChC,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,4DAAkC;AAClC,wEAA8C;AAC9C,6DAAmC"}

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

@@ -0,0 +1,102 @@
+import Joi from 'joi';
+export declare class Parameter {
+    /** @description The name of the parameter */
+    name: string;
+    /** @description The value associated with the parameter */
+    value: string;
+}
+export declare const MethodSchema: Joi.StringSchema;
+export declare const ParameterSchema: Joi.ObjectSchema<any>;
+export declare class DateTimeConfiguration {
+    /** @description JSONPath to the JSON element containing the date-time */
+    path: string;
+    /** @description DateTime format string compliant with
+     * https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings */
+    date_time_format: string;
+}
+export declare const DateTimeConfigurationSchema: Joi.ObjectSchema<any>;
+export declare type MapOfStrings = {
+    [key: string]: string;
+};
+/** @description Optional configuration to take full control of parsing and extracting fields
+ * from the integration's JSON response body.
+ * Note for JSONPath: strings not starting with $ are interpreted as string literals
+ */
+export declare class ResponseTransformationConfiguration {
+    /** @description JSONPath to the JSON element for access_token. */
+    access_token: string;
+    /** @description JSONPath to the JSON element for token_type */
+    token_type: string;
+    /** @description JSONPath to the JSON element for refresh_token */
+    refresh_token?: string;
+    /** @description JSONPath to the JSON element for expires_in. Mutually exclusive with expires_at */
+    expires_in?: string;
+    /** @description Configuration for parsing a date-time, when the integration is lacking expires_in.
+     * Mutually exclusive with expires_in.
+     */
+    expires_at?: DateTimeConfiguration;
+    /** @description Optional collection of properties to include in the connection_context sent back with the auth flow result.
+     *  Property value may be JSONPath or a string literal.
+     *  E.g.
+     *  "connection_context": {
+     *    "account_number": "$.data.account_number"
+     *  }
+     */
+    connection_context?: MapOfStrings;
+}
+export declare const MapOfStringsSchema: Joi.ObjectSchema<any>;
+export declare const ResponseTransformationConfigurationSchema: Joi.ObjectSchema<any>;
+export declare class AccessToken {
+    /** @description OAuth1 only. The url to obtain the temporary Access (aka Request) Token to start a flow **/
+    url_template: string;
+}
+export declare const AccessTokenSchema: Joi.ObjectSchema<any>;
+export declare class RequestTokenConfiguration {
+    /** @description The url to obtain the access token using the authorization code on the backend @example "http://{auth_state:store_name}.store.com/admin/oauth/request", "http://store.com/oauth/request" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration when exchanging the code for the token. These are built using ContentType */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when requesting a token */
+    headers?: Parameter[];
+    /** @description Response payload parsing */
+    response?: ResponseTransformationConfiguration;
+}
+export declare const RequestTokenConfigurationSchema: Joi.ObjectSchema<any>;
+export declare class RefreshTokenConfiguration {
+    /** @description The url to refresh the access token using the authorization code on the backend @example "http://{auth_state:store_name}.store.com/admin/oauth/refresh", "http://store.com/oauth/refresh" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration during the server-server refresh token request. These are built using the content type specified in the headers array. */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when refreshing a token */
+    headers?: Parameter[];
+    /** @description Response payload parsing */
+    response?: ResponseTransformationConfiguration;
+}
+export declare const RefreshTokenConfigurationSchema: Joi.ObjectSchema<any>;
+export declare class NonceConfiguration {
+    name: string;
+}
+export declare const NonceConfigurationSchema: Joi.ObjectSchema<any>;
+export declare class AuthorizationConfiguration {
+    /** @description The url to obtain the access token using the authorization code on the backend @example "http://{auth_state:store_name}.store.com/admin/oauth/authorize", "http://store.com/oauth/authorize" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration during the server-server authorization request. These are built using the content type specified in the headers array. */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when authorizing a token */
+    headers?: Parameter[];
+    /** @description A nonce query parameter included on the accept request, then returned and validated on the redirect request */
+    nonce?: NonceConfiguration;
+}
+export declare const AuthorizationConfigurationSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/monoauth.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthorizationConfigurationSchema = exports.AuthorizationConfiguration = exports.NonceConfigurationSchema = exports.NonceConfiguration = exports.RefreshTokenConfigurationSchema = exports.RefreshTokenConfiguration = exports.RequestTokenConfigurationSchema = exports.RequestTokenConfiguration = exports.AccessTokenSchema = exports.AccessToken = exports.ResponseTransformationConfigurationSchema = exports.MapOfStringsSchema = exports.ResponseTransformationConfiguration = exports.DateTimeConfigurationSchema = exports.DateTimeConfiguration = exports.ParameterSchema = exports.MethodSchema = exports.Parameter = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+class Parameter {
+}
+exports.Parameter = Parameter;
+exports.MethodSchema = joi_1.default.string().valid('GET', 'POST', 'DELETE', 'PUT', 'get', 'post', 'delete', 'put');
+exports.ParameterSchema = joi_1.default.object({
+    name: joi_1.default.string().required(),
+    value: joi_1.default.string().required(),
+});
+class DateTimeConfiguration {
+}
+exports.DateTimeConfiguration = DateTimeConfiguration;
+exports.DateTimeConfigurationSchema = joi_1.default.object({
+    path: joi_1.default.string().required(),
+    date_time_format: joi_1.default.string().required(),
+});
+/** @description Optional configuration to take full control of parsing and extracting fields
+ * from the integration's JSON response body.
+ * Note for JSONPath: strings not starting with $ are interpreted as string literals
+ */
+class ResponseTransformationConfiguration {
+}
+exports.ResponseTransformationConfiguration = ResponseTransformationConfiguration;
+exports.MapOfStringsSchema = joi_1.default.object().pattern(joi_1.default.string(), joi_1.default.string());
+exports.ResponseTransformationConfigurationSchema = joi_1.default.object({
+    access_token: joi_1.default.string().required(),
+    token_type: joi_1.default.string().required(),
+    refresh_token: joi_1.default.string().optional(),
+    expires_in: joi_1.default.string().optional(),
+    expires_at: exports.DateTimeConfigurationSchema.optional(),
+    connection_context: exports.MapOfStringsSchema.optional(),
+});
+class AccessToken {
+}
+exports.AccessToken = AccessToken;
+exports.AccessTokenSchema = joi_1.default.object({
+    url_template: joi_1.default.string().required(),
+});
+class RequestTokenConfiguration {
+}
+exports.RequestTokenConfiguration = RequestTokenConfiguration;
+exports.RequestTokenConfigurationSchema = joi_1.default.object({
+    url_template: joi_1.default.string().required(),
+    query_parameters: joi_1.default.array().optional().items(exports.ParameterSchema),
+    method: exports.MethodSchema.optional(),
+    body: joi_1.default.array().optional().items(exports.ParameterSchema),
+    headers: joi_1.default.array().optional().items(exports.ParameterSchema),
+    response: exports.ResponseTransformationConfigurationSchema.optional(),
+});
+class RefreshTokenConfiguration {
+}
+exports.RefreshTokenConfiguration = RefreshTokenConfiguration;
+exports.RefreshTokenConfigurationSchema = joi_1.default.object({
+    url_template: joi_1.default.string().required(),
+    query_parameters: joi_1.default.array().optional().items(exports.ParameterSchema),
+    method: exports.MethodSchema.optional(),
+    body: joi_1.default.array().optional().items(exports.ParameterSchema),
+    headers: joi_1.default.array().optional().items(exports.ParameterSchema),
+    response: exports.ResponseTransformationConfigurationSchema.optional(),
+});
+class NonceConfiguration {
+}
+exports.NonceConfiguration = NonceConfiguration;
+exports.NonceConfigurationSchema = joi_1.default.object({
+    name: joi_1.default.string().required(),
+});
+class AuthorizationConfiguration {
+}
+exports.AuthorizationConfiguration = AuthorizationConfiguration;
+exports.AuthorizationConfigurationSchema = joi_1.default.object({
+    url_template: joi_1.default.string().required(),
+    query_parameters: joi_1.default.array().optional().items(exports.ParameterSchema),
+    method: exports.MethodSchema.optional(),
+    body: joi_1.default.array().optional().items(exports.ParameterSchema),
+    headers: joi_1.default.array().optional().items(exports.ParameterSchema),
+    nonce: exports.NonceConfigurationSchema.optional(),
+});
+//# sourceMappingURL=monoauth.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"monoauth.js","sourceRoot":"","sources":["../../../src/app/metadata/monoauth.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,MAAa,SAAS;CAKrB;AALD,8BAKC;AAEY,QAAA,YAAY,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC5C,KAAK,EACL,MAAM,EACN,QAAQ,EACR,KAAK,EACL,KAAK,EACL,MAAM,EACN,QAAQ,EACR,KAAK,CACN,CAAC;AAEW,QAAA,eAAe,GAAG,aAAG,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAa,qBAAqB;CAMjC;AAND,sDAMC;AAEY,QAAA,2BAA2B,GAAG,aAAG,CAAC,MAAM,CAAC;IACpD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAC;AAMH;;;GAGG;AACH,MAAa,mCAAmC;CAqB/C;AArBD,kFAqBC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CACpD,aAAG,CAAC,MAAM,EAAE,EACZ,aAAG,CAAC,MAAM,EAAE,CACb,CAAC;AAEW,QAAA,yCAAyC,GAAG,aAAG,CAAC,MAAM,CAAC;IAClE,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,UAAU,EAAE,mCAA2B,CAAC,QAAQ,EAAE;IAClD,kBAAkB,EAAE,0BAAkB,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC;AAEH,MAAa,WAAW;CAGvB;AAHD,kCAGC;AAEY,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC;AAEH,MAAa,yBAAyB;CAarC;AAbD,8DAaC;AAEY,QAAA,+BAA+B,GAAG,aAAG,CAAC,MAAM,CAAC;IACxD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IAC/D,MAAM,EAAE,oBAAY,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IACnD,OAAO,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IACtD,QAAQ,EAAE,iDAAyC,CAAC,QAAQ,EAAE;CAC/D,CAAC,CAAC;AAEH,MAAa,yBAAyB;CAarC;AAbD,8DAaC;AAEY,QAAA,+BAA+B,GAAG,aAAG,CAAC,MAAM,CAAC;IACxD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IAC/D,MAAM,EAAE,oBAAY,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IACnD,OAAO,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IACtD,QAAQ,EAAE,iDAAyC,CAAC,QAAQ,EAAE;CAC/D,CAAC,CAAC;AAEH,MAAa,kBAAkB;CAE9B;AAFD,gDAEC;AAEY,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC;AAEH,MAAa,0BAA0B;CAatC;AAbD,gEAaC;AAEY,QAAA,gCAAgC,GAAG,aAAG,CAAC,MAAM,CAAC;IACzD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IAC/D,MAAM,EAAE,oBAAY,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IACnD,OAAO,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAe,CAAC;IACtD,KAAK,EAAE,gCAAwB,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "2.1.22",
+  "version": "2.1.23",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://github.com/ShipEngine/connect",
   "main": "./lib/index.js",

package/src/app/carrier-app.ts

@@ -5,7 +5,7 @@ import { resolve } from 'path';
 import { readFileSync, existsSync } from 'fs';
 
 import { Metadata } from './internal/metadata';
-import { CarrierSpecification } from './internal/carrier-specificaion';
+import { CarrierSpecification } from './internal/carrier-specification';
 import { CarrierAppMetadataSchema } from './metadata';
 import {
   RegisterResponseSchema,

package/src/app/internal/{carrier-app-specificaion.ts → carrier-app-specification.ts}

@@ -1,5 +1,6 @@
+import { AuthSpecification } from '../metadata/auth-specification';
 import { ShippingProviderConnector } from '../metadata/shipping-provider-connector';
-import { CarrierSpecification } from './carrier-specificaion';
+import { CarrierSpecification } from './carrier-specification';
 
 /** @description This represents a single integration which may contain multiple carrier sources */
 export interface CarrierAppSpecification {
@@ -9,6 +10,8 @@ export interface CarrierAppSpecification {
   Name: string;
   /** @description Information about the connector */
   Connector: ShippingProviderConnector;
+  /** @description The specification for authorizing with this carrier */
+  AuthProcess?: AuthSpecification;
   /** @description A list of carrier sources associated with this integration */
   Carriers: CarrierSpecification[];
 }

package/src/app/internal/metadata.ts

@@ -2,8 +2,9 @@ import { CarrierAppDefinition } from '../carrier-app-definition';
 import { ShippingProviderConnector } from '../metadata/shipping-provider-connector';
 import { FunctionSpecification } from '../metadata/function';
 
-import { CarrierAppSpecification } from './carrier-app-specificaion';
-import { CarrierSpecification } from './carrier-specificaion';
+import { CarrierAppSpecification } from './carrier-app-specification';
+import { CarrierSpecification } from './carrier-specification';
+import { AuthSpecification } from '../metadata/auth-specification';
 
 const fn = (name: string): FunctionSpecification => ({
   Name: name,
@@ -52,11 +53,16 @@ export class Metadata implements CarrierAppSpecification {
   Id: string;
   Name: string;
   Connector: ShippingProviderConnector;
+  AuthProcess?: AuthSpecification;
   Carriers: CarrierSpecification[];
 
   constructor(app: CarrierAppDefinition) {
     this.Id = app.Metadata.Id;
     this.Name = app.Metadata.Name;
+    this.AuthProcess = app.Metadata.AuthProcess;
+    if (this.AuthProcess) {
+      this.AuthProcess.Identifier.Version = '2.0';
+    }
     this.Carriers = app.Metadata.Carriers.map(
       (c) => new CarrierSpecification(c),
     );

package/src/app/metadata/auth-identifier.ts

@@ -0,0 +1,17 @@
+import Joi from 'joi';
+
+export enum AuthenticationType {
+  OAuth = 'oauth',
+}
+
+export class AuthIdentifier {
+  AuthenticationType!: AuthenticationType;
+  Version?: string;
+  IsSandbox?: boolean;
+}
+
+export const AuthIdentifierSchema = Joi.object({
+  AuthenticationType: Joi.string().required().valid('oauth'),
+  Version: Joi.string().optional(),
+  IsSandbox: Joi.bool().optional(),
+});

package/src/app/metadata/auth-specification.ts

@@ -0,0 +1,39 @@
+import { AuthIdentifier, AuthIdentifierSchema } from './auth-identifier';
+import {
+  AccessToken,
+  AccessTokenSchema,
+  AuthorizationConfiguration,
+  AuthorizationConfigurationSchema,
+  Parameter,
+  ParameterSchema,
+  RefreshTokenConfiguration,
+  RefreshTokenConfigurationSchema,
+  RequestTokenConfiguration,
+  RequestTokenConfigurationSchema,
+} from './monoauth';
+import Joi from 'joi';
+
+/** @description Used to specify information about an integrations authentication */
+export class AuthSpecification {
+  /** @description Identify the type of Auth being used by the integration */
+  Identifier!: AuthIdentifier;
+  /** @description Added to allow oauth 1.0 to work. */
+  access_token?: AccessToken;
+  /** @description Authorization: the beginning of an OAuth2.0 flow that ensures the user is logged in and approves access to the Resource. */
+  authorization?: AuthorizationConfiguration;
+  /** @description Request Token: server-server code for token exchange */
+  request_token?: RequestTokenConfiguration;
+  /** @description Refresh Token: server-server refresh token exchange for access token **NOTE: sometimes a new RT is also created** */
+  refresh_token?: RefreshTokenConfiguration;
+  /** @description Advanced configurations used for oauth 1.0 */
+  advanced_configuration?: Parameter[];
+}
+
+export const AuthSpecificationSchema = Joi.object({
+  Identifier: AuthIdentifierSchema,
+  access_token: AccessTokenSchema.optional(),
+  authorization: AuthorizationConfigurationSchema.optional(),
+  request_token: RequestTokenConfigurationSchema.optional(),
+  refresh_token: RefreshTokenConfigurationSchema.optional(),
+  advanced_configuration: Joi.array().optional().items(ParameterSchema),
+});

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

@@ -1,11 +1,18 @@
 import Joi from 'joi';
-import { Carrier, CarrierSchema } from './carrier';
+import {
+  AuthSpecification,
+  AuthSpecificationSchema,
+  Carrier,
+  CarrierSchema,
+} from '.';
 
 export interface CarrierAppMetadata {
   /** @description Id of the carrier app */
   Id: string;
   /** @description Name of the carrier */
   Name: string;
+  /** @description The specification for authorizing with this order source */
+  AuthProcess?: AuthSpecification;
   /** @description List of carriers for the app */
   Carriers: Carrier[];
 }
@@ -15,6 +22,7 @@ export const CarrierAppMetadataSchema = Joi.object({
     .uuid({ version: ['uuidv4'] })
     .required(),
   Name: Joi.string().required(),
+  AuthProcess: AuthSpecificationSchema.optional(),
   Carriers: Joi.array()
     .unique('Id')
     .required()

package/src/app/metadata/index.ts

@@ -1,7 +1,9 @@
 export * from './account-modals';
+export * from './auth-identifier';
+export * from './auth-specification';
+export * from './carrier';
 export * from './carrier-app-metadata';
 export * from './carrier-attributes';
-export * from './carrier';
 export * from './confirmation-type';
 export * from './country-association';
 export * from './diagnostic-routes';
@@ -9,6 +11,7 @@ export * from './enums';
 export * from './function';
 export * from './label-formats';
 export * from './label-sizes';
+export * from './monoauth';
 export * from './package-type';
 export * from './service-class';
 export * from './service-grade';