@shipengine/connect-carrier-api 2.1.21 → 2.2.0

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/lib/models/addresses/address-base.d.ts

@@ -30,4 +30,6 @@ export declare class AddressBase {
     address_metadata?: {
         [key: string]: string;
     };
+    /** @description Instructions to help the carrier navigate to the address. */
+    instructions?: string;
 }

package/lib/models/addresses/address-base.js.map

@@ -1 +1 @@
-{"version":3,"file":"address-base.js","sourceRoot":"","sources":["../../../src/models/addresses/address-base.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;CA8BvB;AA9BD,kCA8BC"}
+{"version":3,"file":"address-base.js","sourceRoot":"","sources":["../../../src/models/addresses/address-base.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;CAgCvB;AAhCD,kCAgCC"}

package/lib/models/billing/billing-categories.d.ts

@@ -1,3 +1,4 @@
+import Joi from 'joi';
 /** @description Category for a billing line item */
 export declare enum BillingCategories {
     Uncategorized = "uncategorized",
@@ -23,3 +24,4 @@ export declare enum BillingCategories {
     /** @description Amount to be paid to the driver, used for local delivery and courier services. */
     Tip = "tip"
 }
+export declare const BillingCategoriesSchema: Joi.StringSchema;

package/lib/models/billing/billing-categories.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BillingCategories = void 0;
+exports.BillingCategoriesSchema = exports.BillingCategories = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Category for a billing line item */
 var BillingCategories;
 (function (BillingCategories) {
@@ -27,4 +29,5 @@ var BillingCategories;
     /** @description Amount to be paid to the driver, used for local delivery and courier services. */
     BillingCategories["Tip"] = "tip";
 })(BillingCategories = exports.BillingCategories || (exports.BillingCategories = {}));
+exports.BillingCategoriesSchema = joi_1.default.string().valid(...Object.values(BillingCategories));
 //# sourceMappingURL=billing-categories.js.map

package/lib/models/billing/billing-categories.js.map

@@ -1 +1 @@
-{"version":3,"file":"billing-categories.js","sourceRoot":"","sources":["../../../src/models/billing/billing-categories.ts"],"names":[],"mappings":";;;AAAA,oDAAoD;AACpD,IAAY,iBAuBX;AAvBD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,oFAAoF;IACpF,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;IACrB,+CAA0B,CAAA;IAC1B,uDAAkC,CAAA;IAClC,sCAAiB,CAAA;IACjB,gCAAW,CAAA;IACX,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,mDAA8B,CAAA;IAC9B,sCAAiB,CAAA;IACjB,wEAAwE;IACxE,iDAA4B,CAAA;IAC5B,iDAAiD;IACjD,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;IACnB,oDAA+B,CAAA;IAC/B,kGAAkG;IAClG,gCAAW,CAAA;AACb,CAAC,EAvBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAuB5B"}
+{"version":3,"file":"billing-categories.js","sourceRoot":"","sources":["../../../src/models/billing/billing-categories.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,oDAAoD;AACpD,IAAY,iBAuBX;AAvBD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,oFAAoF;IACpF,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;IACrB,+CAA0B,CAAA;IAC1B,uDAAkC,CAAA;IAClC,sCAAiB,CAAA;IACjB,gCAAW,CAAA;IACX,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,mDAA8B,CAAA;IAC9B,sCAAiB,CAAA;IACjB,wEAAwE;IACxE,iDAA4B,CAAA;IAC5B,iDAAiD;IACjD,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;IACnB,oDAA+B,CAAA;IAC/B,kGAAkG;IAClG,gCAAW,CAAA;AACb,CAAC,EAvBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAuB5B;AAEY,QAAA,uBAAuB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CACvD,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CACpC,CAAC"}

package/lib/models/billing/billing-line-item.d.ts

@@ -1,5 +1,6 @@
 import { BillingCategories } from './billing-categories';
 import { Currency } from '../currency';
+import Joi from 'joi';
 /** @description Basic structure of each charge or line item */
 export declare class BillingLineItem {
     billing_category: BillingCategories;
@@ -8,3 +9,4 @@ export declare class BillingLineItem {
     memo?: string;
     amount: Currency;
 }
+export declare const BillingLineItemSchema: Joi.ObjectSchema<any>;

package/lib/models/billing/billing-line-item.js

@@ -1,8 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BillingLineItem = void 0;
+exports.BillingLineItemSchema = exports.BillingLineItem = void 0;
+const tslib_1 = require("tslib");
+const billing_categories_1 = require("./billing-categories");
+const currency_1 = require("../currency");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Basic structure of each charge or line item */
 class BillingLineItem {
 }
 exports.BillingLineItem = BillingLineItem;
+exports.BillingLineItemSchema = joi_1.default.object({
+    billing_category: billing_categories_1.BillingCategoriesSchema.required(),
+    carrier_description: joi_1.default.string().optional().empty(),
+    carrier_billing_code: joi_1.default.string().optional().empty(),
+    memo: joi_1.default.string().optional().empty(),
+    amount: currency_1.CurrencySchema.required(),
+});
 //# sourceMappingURL=billing-line-item.js.map

package/lib/models/billing/billing-line-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"billing-line-item.js","sourceRoot":"","sources":["../../../src/models/billing/billing-line-item.ts"],"names":[],"mappings":";;;AAGA,+DAA+D;AAC/D,MAAa,eAAe;CAM3B;AAND,0CAMC"}
+{"version":3,"file":"billing-line-item.js","sourceRoot":"","sources":["../../../src/models/billing/billing-line-item.ts"],"names":[],"mappings":";;;;AAAA,6DAG8B;AAC9B,0CAAuD;AACvD,sDAAsB;AAEtB,+DAA+D;AAC/D,MAAa,eAAe;CAM3B;AAND,0CAMC;AAEY,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,gBAAgB,EAAE,4CAAuB,CAAC,QAAQ,EAAE;IACpD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,MAAM,EAAE,yBAAc,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}

package/lib/models/currency.d.ts

@@ -1,5 +1,7 @@
+import Joi from 'joi';
 /** @description Basic structure for defining an amount of money and its currency */
 export declare class Currency {
     currency: string;
     amount: string;
 }
+export declare const CurrencySchema: Joi.ObjectSchema<any>;

package/lib/models/currency.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Currency = void 0;
+exports.CurrencySchema = exports.Currency = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Basic structure for defining an amount of money and its currency */
 class Currency {
 }
 exports.Currency = Currency;
+exports.CurrencySchema = joi_1.default.object({
+    currency: joi_1.default.string().required(),
+    amount: joi_1.default.string().required(),
+});
 //# sourceMappingURL=currency.js.map

package/lib/models/currency.js.map

@@ -1 +1 @@
-{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/models/currency.ts"],"names":[],"mappings":";;;AAAA,oFAAoF;AACpF,MAAa,QAAQ;CAGpB;AAHD,4BAGC"}
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/models/currency.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,oFAAoF;AACpF,MAAa,QAAQ;CAGpB;AAHD,4BAGC;AAEY,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC"}

package/lib/models/documents/document-type.d.ts

@@ -1,3 +1,4 @@
+import Joi from 'joi';
 /** @description Types of documents */
 export declare enum DocumentType {
     Label = "label",
@@ -5,3 +6,4 @@ export declare enum DocumentType {
     CommercialInvoice = "commercial_invoice",
     BillOfLading = "bill_of_lading"
 }
+export declare const DocumentTypeSchema: Joi.StringSchema;

package/lib/models/documents/document-type.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentType = void 0;
+exports.DocumentTypeSchema = exports.DocumentType = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Types of documents */
 var DocumentType;
 (function (DocumentType) {
@@ -9,4 +11,5 @@ var DocumentType;
     DocumentType["CommercialInvoice"] = "commercial_invoice";
     DocumentType["BillOfLading"] = "bill_of_lading";
 })(DocumentType = exports.DocumentType || (exports.DocumentType = {}));
+exports.DocumentTypeSchema = joi_1.default.string().valid(...Object.values(DocumentType));
 //# sourceMappingURL=document-type.js.map

package/lib/models/documents/document-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"document-type.js","sourceRoot":"","sources":["../../../src/models/documents/document-type.ts"],"names":[],"mappings":";;;AAAA,sCAAsC;AACtC,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,+BAAe,CAAA;IACf,4CAA4B,CAAA;IAC5B,wDAAwC,CAAA;IACxC,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB"}
+{"version":3,"file":"document-type.js","sourceRoot":"","sources":["../../../src/models/documents/document-type.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,sCAAsC;AACtC,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,+BAAe,CAAA;IACf,4CAA4B,CAAA;IAC5B,wDAAwC,CAAA;IACxC,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAClD,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAC/B,CAAC"}

package/lib/models/documents/document.d.ts

@@ -1,8 +1,10 @@
 import { DocumentType } from './document-type';
 import { DocumentFormat } from '../labels/document-formats';
+import Joi from 'joi';
 /** @description Basic structure for a document */
 export declare class Document {
     type: DocumentType[];
     data: string;
     format: DocumentFormat;
 }
+export declare const DocumentSchema: Joi.ObjectSchema<any>;

package/lib/models/documents/document.js

@@ -1,8 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Document = void 0;
+exports.DocumentSchema = exports.Document = void 0;
+const tslib_1 = require("tslib");
+const document_type_1 = require("./document-type");
+const document_formats_1 = require("../labels/document-formats");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Basic structure for a document */
 class Document {
 }
 exports.Document = Document;
+exports.DocumentSchema = joi_1.default.object({
+    type: joi_1.default.array().required().min(1).items(document_type_1.DocumentTypeSchema),
+    data: joi_1.default.string().required(),
+    format: document_formats_1.DocumentFormatSchema.required(),
+});
 //# sourceMappingURL=document.js.map

package/lib/models/documents/document.js.map

@@ -1 +1 @@
-{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../src/models/documents/document.ts"],"names":[],"mappings":";;;AAGA,kDAAkD;AAClD,MAAa,QAAQ;CAIpB;AAJD,4BAIC"}
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../src/models/documents/document.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,iEAGoC;AACpC,sDAAsB;AAEtB,kDAAkD;AAClD,MAAa,QAAQ;CAIpB;AAJD,4BAIC;AACY,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,kCAAkB,CAAC;IAC7D,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,uCAAoB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC"}

package/lib/models/identifier.d.ts

@@ -1,5 +1,7 @@
+import Joi from 'joi';
 /** @description Key value pair to allow custom properties */
 export declare class Identifier {
     type: string;
     value: string;
 }
+export declare const IdentifierSchema: Joi.ObjectSchema<any>;

package/lib/models/identifier.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Identifier = void 0;
+exports.IdentifierSchema = exports.Identifier = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Key value pair to allow custom properties */
 class Identifier {
 }
 exports.Identifier = Identifier;
+exports.IdentifierSchema = joi_1.default.object({
+    type: joi_1.default.string().required(),
+    value: joi_1.default.string().required(),
+});
 //# sourceMappingURL=identifier.js.map

package/lib/models/identifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"identifier.js","sourceRoot":"","sources":["../../src/models/identifier.ts"],"names":[],"mappings":";;;AAAA,6DAA6D;AAC7D,MAAa,UAAU;CAGtB;AAHD,gCAGC"}
+{"version":3,"file":"identifier.js","sourceRoot":"","sources":["../../src/models/identifier.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,6DAA6D;AAC7D,MAAa,UAAU;CAGtB;AAHD,gCAGC;AAEY,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC"}

package/lib/models/inbound-content-types.d.ts

@@ -1,5 +1,7 @@
+import Joi from 'joi';
 /** @description Types of inbound content */
 export declare enum InboundDataContentTypes {
     /** @description Tracking information */
     Tracking = "tracking"
 }
+export declare const InboundDataContentTypesSchema: Joi.StringSchema;

package/lib/models/inbound-content-types.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InboundDataContentTypes = void 0;
+exports.InboundDataContentTypesSchema = exports.InboundDataContentTypes = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Types of inbound content */
 var InboundDataContentTypes;
 (function (InboundDataContentTypes) {
     /** @description Tracking information */
     InboundDataContentTypes["Tracking"] = "tracking";
 })(InboundDataContentTypes = exports.InboundDataContentTypes || (exports.InboundDataContentTypes = {}));
+exports.InboundDataContentTypesSchema = joi_1.default.string().valid(...Object.values(InboundDataContentTypes));
 //# sourceMappingURL=inbound-content-types.js.map

package/lib/models/inbound-content-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"inbound-content-types.js","sourceRoot":"","sources":["../../src/models/inbound-content-types.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAC5C,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,wCAAwC;IACxC,gDAAqB,CAAA;AACvB,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC"}
+{"version":3,"file":"inbound-content-types.js","sourceRoot":"","sources":["../../src/models/inbound-content-types.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,4CAA4C;AAC5C,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,wCAAwC;IACxC,gDAAqB,CAAA;AACvB,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC;AACY,QAAA,6BAA6B,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC7D,GAAG,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAC1C,CAAC"}

package/lib/models/labels/document-formats.d.ts

@@ -1,6 +1,8 @@
+import Joi from 'joi';
 /** @description Label data type */
 export declare enum DocumentFormat {
     Pdf = "PDF",
     Zpl = "ZPL",
     Png = "PNG"
 }
+export declare const DocumentFormatSchema: Joi.StringSchema;

package/lib/models/labels/document-formats.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentFormat = void 0;
+exports.DocumentFormatSchema = exports.DocumentFormat = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Label data type */
 var DocumentFormat;
 (function (DocumentFormat) {
@@ -8,4 +10,5 @@ var DocumentFormat;
     DocumentFormat["Zpl"] = "ZPL";
     DocumentFormat["Png"] = "PNG";
 })(DocumentFormat = exports.DocumentFormat || (exports.DocumentFormat = {}));
+exports.DocumentFormatSchema = joi_1.default.string().valid(...Object.values(DocumentFormat));
 //# sourceMappingURL=document-formats.js.map

package/lib/models/labels/document-formats.js.map

@@ -1 +1 @@
-{"version":3,"file":"document-formats.js","sourceRoot":"","sources":["../../../src/models/labels/document-formats.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,6BAAW,CAAA;IACX,6BAAW,CAAA;AACb,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB"}
+{"version":3,"file":"document-formats.js","sourceRoot":"","sources":["../../../src/models/labels/document-formats.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,mCAAmC;AACnC,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,6BAAW,CAAA;IACX,6BAAW,CAAA;AACb,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AACY,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CACpD,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CACjC,CAAC"}

package/lib/models/labels/form-download.d.ts

@@ -1,4 +1,6 @@
+import Joi from 'joi';
 import { ResourceDownload } from '../resource-download';
 export declare class FormDownload extends ResourceDownload {
     form_data?: string;
 }
+export declare const FormDownloadSchema: Joi.ObjectSchema<any>;

package/lib/models/labels/form-download.js

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormDownload = void 0;
+exports.FormDownloadSchema = exports.FormDownload = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 const resource_download_1 = require("../resource-download");
 class FormDownload extends resource_download_1.ResourceDownload {
 }
 exports.FormDownload = FormDownload;
+exports.FormDownloadSchema = resource_download_1.ResourceDownloadSchema.keys({
+    form_data: joi_1.default.string().optional().empty(),
+});
 //# sourceMappingURL=form-download.js.map

package/lib/models/labels/form-download.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-download.js","sourceRoot":"","sources":["../../../src/models/labels/form-download.ts"],"names":[],"mappings":";;;AAAA,4DAAwD;AAExD,MAAa,YAAa,SAAQ,oCAAgB;CAEjD;AAFD,oCAEC"}
+{"version":3,"file":"form-download.js","sourceRoot":"","sources":["../../../src/models/labels/form-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAgF;AAEhF,MAAa,YAAa,SAAQ,oCAAgB;CAEjD;AAFD,oCAEC;AAEY,QAAA,kBAAkB,GAAG,0CAAsB,CAAC,IAAI,CAAC;IAC5D,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC3C,CAAC,CAAC"}

package/lib/models/labels/label-download.d.ts

@@ -1,4 +1,6 @@
+import Joi from 'joi';
 import { ResourceDownload } from '../resource-download';
 export declare class LabelDownload extends ResourceDownload {
     label_data?: string;
 }
+export declare const LabelDownloadSchema: Joi.ObjectSchema<any>;

package/lib/models/labels/label-download.js

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LabelDownload = void 0;
+exports.LabelDownloadSchema = exports.LabelDownload = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 const resource_download_1 = require("../resource-download");
 class LabelDownload extends resource_download_1.ResourceDownload {
 }
 exports.LabelDownload = LabelDownload;
+exports.LabelDownloadSchema = resource_download_1.ResourceDownloadSchema.keys({
+    label_data: joi_1.default.string().optional().empty(),
+});
 //# sourceMappingURL=label-download.js.map

package/lib/models/labels/label-download.js.map

@@ -1 +1 @@
-{"version":3,"file":"label-download.js","sourceRoot":"","sources":["../../../src/models/labels/label-download.ts"],"names":[],"mappings":";;;AAAA,4DAAwD;AAExD,MAAa,aAAc,SAAQ,oCAAgB;CAElD;AAFD,sCAEC"}
+{"version":3,"file":"label-download.js","sourceRoot":"","sources":["../../../src/models/labels/label-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAgF;AAEhF,MAAa,aAAc,SAAQ,oCAAgB;CAElD;AAFD,sCAEC;AAEY,QAAA,mBAAmB,GAAG,0CAAsB,CAAC,IAAI,CAAC;IAC7D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC5C,CAAC,CAAC"}

package/lib/models/labels/label-package.d.ts

@@ -1,5 +1,6 @@
 import { Identifier } from '../identifier';
 import { Document } from '../documents';
+import Joi from 'joi';
 /** @description Package information provided by the carrier */
 export declare class LabelPackage {
     tracking_number?: string;
@@ -7,3 +8,4 @@ export declare class LabelPackage {
     alternative_identifiers?: Identifier[];
     documents?: Document[];
 }
+export declare const LabelPackageSchema: Joi.ObjectSchema<any>;

package/lib/models/labels/label-package.js

@@ -1,8 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LabelPackage = void 0;
+exports.LabelPackageSchema = exports.LabelPackage = void 0;
+const tslib_1 = require("tslib");
+const identifier_1 = require("../identifier");
+const documents_1 = require("../documents");
+const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Package information provided by the carrier */
 class LabelPackage {
 }
 exports.LabelPackage = LabelPackage;
+exports.LabelPackageSchema = joi_1.default.object({
+    tracking_number: joi_1.default.string().optional().empty(),
+    alternative_identifiers: joi_1.default.array().optional().items(identifier_1.IdentifierSchema),
+    documents: joi_1.default.array().optional().items(documents_1.DocumentSchema),
+});
 //# sourceMappingURL=label-package.js.map

package/lib/models/labels/label-package.js.map

@@ -1 +1 @@
-{"version":3,"file":"label-package.js","sourceRoot":"","sources":["../../../src/models/labels/label-package.ts"],"names":[],"mappings":";;;AAGA,+DAA+D;AAC/D,MAAa,YAAY;CAKxB;AALD,oCAKC"}
+{"version":3,"file":"label-package.js","sourceRoot":"","sources":["../../../src/models/labels/label-package.ts"],"names":[],"mappings":";;;;AAAA,8CAA6D;AAC7D,4CAAwD;AACxD,sDAAsB;AAEtB,+DAA+D;AAC/D,MAAa,YAAY;CAKxB;AALD,oCAKC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,6BAAgB,CAAC;IACvE,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0BAAc,CAAC;CACxD,CAAC,CAAC"}

package/lib/models/labels/void-response.d.ts

@@ -1,4 +1,5 @@
-import { BillingLineItem } from '..';
+import Joi from 'joi';
+import { BillingLineItem } from '../billing';
 /** @description Basic structure for a response to void a label */
 export declare class VoidResponse {
     /** @description Id for the void response */
@@ -10,3 +11,4 @@ export declare class VoidResponse {
     /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee. */
     billing_line_items?: BillingLineItem[];
 }
+export declare const VoidResponseSchema: Joi.ObjectSchema<any>;

package/lib/models/labels/void-response.js

@@ -1,8 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VoidResponse = void 0;
+exports.VoidResponseSchema = exports.VoidResponse = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const billing_1 = require("../billing");
 /** @description Basic structure for a response to void a label */
 class VoidResponse {
 }
 exports.VoidResponse = VoidResponse;
+exports.VoidResponseSchema = joi_1.default.object({
+    void_request_id: joi_1.default.string().required(),
+    message: joi_1.default.string().optional().empty(),
+    errors: joi_1.default.array().optional().items(joi_1.default.string()),
+    billing_line_items: joi_1.default.array().optional().items(billing_1.BillingLineItemSchema),
+});
 //# sourceMappingURL=void-response.js.map

package/lib/models/labels/void-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"void-response.js","sourceRoot":"","sources":["../../../src/models/labels/void-response.ts"],"names":[],"mappings":";;;AAEA,kEAAkE;AAClE,MAAa,YAAY;CASxB;AATD,oCASC"}
+{"version":3,"file":"void-response.js","sourceRoot":"","sources":["../../../src/models/labels/void-response.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wCAAoE;AACpE,kEAAkE;AAClE,MAAa,YAAY;CASxB;AATD,oCASC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAClD,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+BAAqB,CAAC;CACxE,CAAC,CAAC"}

package/lib/models/manifests/manifest.d.ts

@@ -1,3 +1,4 @@
+import Joi from 'joi';
 import { ResourceDownload } from '../resource-download';
 /** @description Basic structure of a manifest */
 export declare class Manifest {
@@ -6,3 +7,4 @@ export declare class Manifest {
     document_href?: string;
     document_data?: string;
 }
+export declare const ManifestSchema: Joi.ObjectSchema<any>;