@shipengine/connect-carrier-api 4.16.6 → 4.16.8-beta.1

package/src/app/metadata/monoauth.ts

@@ -1,168 +1,168 @@
-import Joi from 'joi';
-
-export class Parameter {
-  /** @description The name of the parameter */
-  name!: string;
-  /** @description The value associated with the parameter */
-  value!: string;
-}
-
-export const MethodSchema = Joi.string().valid(
-  'GET',
-  'POST',
-  'DELETE',
-  'PUT',
-  'get',
-  'post',
-  'delete',
-  'put',
-);
-
-export const ParameterSchema = Joi.object({
-  name: Joi.string().required(),
-  value: Joi.string().required(),
-});
-
-export 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 const DateTimeConfigurationSchema = Joi.object({
-  path: Joi.string().required(),
-  date_time_format: Joi.string().required(),
-});
-
-export 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 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 const MapOfStringsSchema = Joi.object().pattern(Joi.string(), Joi.string());
-
-export const ResponseTransformationConfigurationSchema = Joi.object({
-  access_token: Joi.string().required(),
-  token_type: Joi.string().required(),
-  refresh_token: Joi.string().optional(),
-  expires_in: Joi.string().optional(),
-  expires_at: DateTimeConfigurationSchema.optional(),
-  connection_context: MapOfStringsSchema.optional(),
-});
-
-export class AccessToken {
-  /** @description OAuth1 only. The url to obtain the temporary Access (aka Request) Token to start a flow **/
-  url_template!: string;
-}
-
-export const AccessTokenSchema = Joi.object({
-  url_template: Joi.string().required(),
-});
-
-export 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 const RequestTokenConfigurationSchema = Joi.object({
-  url_template: Joi.string().required(),
-  query_parameters: Joi.array().optional().items(ParameterSchema),
-  method: MethodSchema.optional(),
-  body: Joi.array().optional().items(ParameterSchema),
-  headers: Joi.array().optional().items(ParameterSchema),
-  response: ResponseTransformationConfigurationSchema.optional(),
-});
-
-export 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 const RefreshTokenConfigurationSchema = Joi.object({
-  url_template: Joi.string().required(),
-  query_parameters: Joi.array().optional().items(ParameterSchema),
-  method: MethodSchema.optional(),
-  body: Joi.array().optional().items(ParameterSchema),
-  headers: Joi.array().optional().items(ParameterSchema),
-  response: ResponseTransformationConfigurationSchema.optional(),
-});
-
-export class NonceConfiguration {
-  name!: string;
-}
-
-export const NonceConfigurationSchema = Joi.object({
-  name: Joi.string().required(),
-});
-
-export 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 const AuthorizationConfigurationSchema = Joi.object({
-  url_template: Joi.string().required(),
-  query_parameters: Joi.array().optional().items(ParameterSchema),
-  method: MethodSchema.optional(),
-  body: Joi.array().optional().items(ParameterSchema),
-  headers: Joi.array().optional().items(ParameterSchema),
-  nonce: NonceConfigurationSchema.optional(),
-});
+import Joi from 'joi';
+
+export class Parameter {
+  /** @description The name of the parameter */
+  name!: string;
+  /** @description The value associated with the parameter */
+  value!: string;
+}
+
+export const MethodSchema = Joi.string().valid(
+  'GET',
+  'POST',
+  'DELETE',
+  'PUT',
+  'get',
+  'post',
+  'delete',
+  'put',
+);
+
+export const ParameterSchema = Joi.object({
+  name: Joi.string().required(),
+  value: Joi.string().required(),
+});
+
+export 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 const DateTimeConfigurationSchema = Joi.object({
+  path: Joi.string().required(),
+  date_time_format: Joi.string().required(),
+});
+
+export 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 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 const MapOfStringsSchema = Joi.object().pattern(Joi.string(), Joi.string());
+
+export const ResponseTransformationConfigurationSchema = Joi.object({
+  access_token: Joi.string().required(),
+  token_type: Joi.string().required(),
+  refresh_token: Joi.string().optional(),
+  expires_in: Joi.string().optional(),
+  expires_at: DateTimeConfigurationSchema.optional(),
+  connection_context: MapOfStringsSchema.optional(),
+});
+
+export class AccessToken {
+  /** @description OAuth1 only. The url to obtain the temporary Access (aka Request) Token to start a flow **/
+  url_template!: string;
+}
+
+export const AccessTokenSchema = Joi.object({
+  url_template: Joi.string().required(),
+});
+
+export 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 const RequestTokenConfigurationSchema = Joi.object({
+  url_template: Joi.string().required(),
+  query_parameters: Joi.array().optional().items(ParameterSchema),
+  method: MethodSchema.optional(),
+  body: Joi.array().optional().items(ParameterSchema),
+  headers: Joi.array().optional().items(ParameterSchema),
+  response: ResponseTransformationConfigurationSchema.optional(),
+});
+
+export 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 const RefreshTokenConfigurationSchema = Joi.object({
+  url_template: Joi.string().required(),
+  query_parameters: Joi.array().optional().items(ParameterSchema),
+  method: MethodSchema.optional(),
+  body: Joi.array().optional().items(ParameterSchema),
+  headers: Joi.array().optional().items(ParameterSchema),
+  response: ResponseTransformationConfigurationSchema.optional(),
+});
+
+export class NonceConfiguration {
+  name!: string;
+}
+
+export const NonceConfigurationSchema = Joi.object({
+  name: Joi.string().required(),
+});
+
+export 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 const AuthorizationConfigurationSchema = Joi.object({
+  url_template: Joi.string().required(),
+  query_parameters: Joi.array().optional().items(ParameterSchema),
+  method: MethodSchema.optional(),
+  body: Joi.array().optional().items(ParameterSchema),
+  headers: Joi.array().optional().items(ParameterSchema),
+  nonce: NonceConfigurationSchema.optional(),
+});

package/src/app/metadata/native-rating-configuration.ts

@@ -1,22 +1,22 @@
-import Joi from 'joi';
-import { fileExists } from './custom-validators/file-exists';
-import { RateCard, RateCardSchema } from './rate-card';
-
-/** Configuration for attaching Native Rating to a carrier */
-export interface NativeRatingConfiguration {
-  /** @description Default rate card to use for rating */
-  DefaultRateCardId?: string;
-  /** @description Can users manage their own rates */
-  SupportsUserManagedRates?: boolean;
-  /** Path to rating logic and rate card data for this carrier */
-  Path?: string;
-  /** Array of rate cards for the carrier */
-  RateCards?: RateCard[];
-}
-
-export const NativeRatingConfigurationSchema = Joi.object({
-  DefaultRateCardId: Joi.string().optional(),
-  SupportsUserManagedRates: Joi.boolean().optional(),
-  Path: Joi.string().optional().custom(fileExists, 'implementation path exists'),
-  RateCards: Joi.array().optional().items(RateCardSchema).unique('Id'),
-});
+import Joi from 'joi';
+import { fileExists } from './custom-validators/file-exists';
+import { RateCard, RateCardSchema } from './rate-card';
+
+/** Configuration for attaching Native Rating to a carrier */
+export interface NativeRatingConfiguration {
+  /** @description Default rate card to use for rating */
+  DefaultRateCardId?: string;
+  /** @description Can users manage their own rates */
+  SupportsUserManagedRates?: boolean;
+  /** Path to rating logic and rate card data for this carrier */
+  Path?: string;
+  /** Array of rate cards for the carrier */
+  RateCards?: RateCard[];
+}
+
+export const NativeRatingConfigurationSchema = Joi.object({
+  DefaultRateCardId: Joi.string().optional(),
+  SupportsUserManagedRates: Joi.boolean().optional(),
+  Path: Joi.string().optional().custom(fileExists, 'implementation path exists'),
+  RateCards: Joi.array().optional().items(RateCardSchema).unique('Id'),
+});

package/src/app/metadata/normalized-errors.ts

@@ -1,22 +1,22 @@
-import Joi from 'joi';
-
-export interface NormalizedErrors {
-  /** Original carrier error or regex which represent carrier error */
-  source_error: string;
-  /** Pattern based on which method will try to match original carrier error. Allowed values "fixed", "regex" */
-  match_pattern: string;
-  /** Short description of error */
-  error_code: string;
-  /** Custom error message which will replace standardized error message in response */
-  override_custom_error_message?: string;
-  /** Module api code when error is related to specific module, not for whole integration */
-  source_api_code?: string;
-}
-
-export const NormalizedErrorsConfigurationSchema = Joi.object({
-  source_error: Joi.string().required(),
-  match_pattern: Joi.string().required(),
-  error_code: Joi.string().required(),
-  override_custom_error_message: Joi.string().optional(),
-  source_api_code: Joi.string().optional(),
-});
+import Joi from 'joi';
+
+export interface NormalizedErrors {
+  /** Original carrier error or regex which represent carrier error */
+  source_error: string;
+  /** Pattern based on which method will try to match original carrier error. Allowed values "fixed", "regex" */
+  match_pattern: string;
+  /** Short description of error */
+  error_code: string;
+  /** Custom error message which will replace standardized error message in response */
+  override_custom_error_message?: string;
+  /** Module api code when error is related to specific module, not for whole integration */
+  source_api_code?: string;
+}
+
+export const NormalizedErrorsConfigurationSchema = Joi.object({
+  source_error: Joi.string().required(),
+  match_pattern: Joi.string().required(),
+  error_code: Joi.string().required(),
+  override_custom_error_message: Joi.string().optional(),
+  source_api_code: Joi.string().optional(),
+});

package/src/app/metadata/package-rating-group-dimensions.ts

@@ -1,34 +1,34 @@
-import Joi from 'joi';
-import { DimensionUnit } from '../../models';
-import { DimensionUnitSchema } from '../../models/units/dimension-unit-schema';
-
-/** @description Dimensions specific to a package rate class */
-export interface PackageRatingGroupDimensions {
-  /** @description Unit of the dimensions */
-  Unit: DimensionUnit;
-  /** @description Length of the package */
-  Length?: number;
-  /** @description Width of the package */
-  Width?: number;
-  /** @description Height of the package */
-  Height?: number;
-  /** @description Girth of the package as defined by the carrier */
-  Girth?: number;
-  /** @description No two sides exceed this amount */
-  NoTwoSides?: number;
-  /** @description Length plus girth should not exceed this amount */
-  LengthPlusGirth?: number;
-  /** @description Volume of the package */
-  Volume?: number;
-}
-
-export const PackageRatingGroupDimensionsSchema = Joi.object({
-  Unit: DimensionUnitSchema.required(),
-  Length: Joi.number().min(0).optional(),
-  Width: Joi.number().min(0).optional(),
-  Height: Joi.number().min(0).optional(),
-  NoTwoSides: Joi.number().min(0).optional(),
-  LengthPlusGirth: Joi.number().min(0).optional(),
-  Girth: Joi.number().min(0).optional(),
-  Volume: Joi.number().min(0).optional(),
-});
+import Joi from 'joi';
+import { DimensionUnit } from '../../models';
+import { DimensionUnitSchema } from '../../models/units/dimension-unit-schema';
+
+/** @description Dimensions specific to a package rate class */
+export interface PackageRatingGroupDimensions {
+  /** @description Unit of the dimensions */
+  Unit: DimensionUnit;
+  /** @description Length of the package */
+  Length?: number;
+  /** @description Width of the package */
+  Width?: number;
+  /** @description Height of the package */
+  Height?: number;
+  /** @description Girth of the package as defined by the carrier */
+  Girth?: number;
+  /** @description No two sides exceed this amount */
+  NoTwoSides?: number;
+  /** @description Length plus girth should not exceed this amount */
+  LengthPlusGirth?: number;
+  /** @description Volume of the package */
+  Volume?: number;
+}
+
+export const PackageRatingGroupDimensionsSchema = Joi.object({
+  Unit: DimensionUnitSchema.required(),
+  Length: Joi.number().min(0).optional(),
+  Width: Joi.number().min(0).optional(),
+  Height: Joi.number().min(0).optional(),
+  NoTwoSides: Joi.number().min(0).optional(),
+  LengthPlusGirth: Joi.number().min(0).optional(),
+  Girth: Joi.number().min(0).optional(),
+  Volume: Joi.number().min(0).optional(),
+});

package/src/app/metadata/package-rating-group-weight.ts

@@ -1,16 +1,16 @@
-import Joi from 'joi';
-import { WeightUnit } from '../../models';
-import { WeightUnitSchema } from '../../models/units/weight-unit-schema';
-
-/** @description Weight of a package rating group */
-export interface PackageRatingGroupWeight {
-  /** @description Unit of the weight */
-  Unit: WeightUnit;
-  /** @description Actual weight value */
-  Value: number;
-}
-
-export const PackageRatingGroupWeightSchema = Joi.object({
-  Unit: WeightUnitSchema.required(),
-  Value: Joi.number().min(0),
-});
+import Joi from 'joi';
+import { WeightUnit } from '../../models';
+import { WeightUnitSchema } from '../../models/units/weight-unit-schema';
+
+/** @description Weight of a package rating group */
+export interface PackageRatingGroupWeight {
+  /** @description Unit of the weight */
+  Unit: WeightUnit;
+  /** @description Actual weight value */
+  Value: number;
+}
+
+export const PackageRatingGroupWeightSchema = Joi.object({
+  Unit: WeightUnitSchema.required(),
+  Value: Joi.number().min(0),
+});

package/src/app/metadata/package-rating-group.ts

@@ -1,34 +1,34 @@
-import Joi from 'joi';
-import {
-  PackageRatingGroupDimensions,
-  PackageRatingGroupDimensionsSchema,
-} from './package-rating-group-dimensions';
-import {
-  PackageRatingGroupWeight,
-  PackageRatingGroupWeightSchema,
-} from './package-rating-group-weight';
-
-/** @description Details about how packages are related to rates */
-export interface PackageRatingGroup {
-  /** @description Id of the rating group */
-  Id: string;
-  /** @description Id of the package type to which this rating group corresponds */
-  PackageTypeId: string;
-  /** @description Name of the package rating group */
-  Name: string;
-  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
-  CarrierPackageTypeCode: string;
-  /** @description Maximum allowable dimensions of packages for the rating group */
-  DimensionLimits?: PackageRatingGroupDimensions;
-  /** @description Maximum allowable weight of packages for the rating group */
-  MaxWeight?: PackageRatingGroupWeight;
-}
-
-export const PackageRatingGroupSchema = Joi.object({
-  Id: Joi.string().required().max(50),
-  PackageTypeId: Joi.string().uuid().required(),
-  Name: Joi.string().required().max(50),
-  CarrierPackageTypeCode: Joi.string().required().max(50), // Copied from package type validation
-  DimensionLimits: PackageRatingGroupDimensionsSchema.optional(),
-  MaxWeight: PackageRatingGroupWeightSchema.optional(),
-});
+import Joi from 'joi';
+import {
+  PackageRatingGroupDimensions,
+  PackageRatingGroupDimensionsSchema,
+} from './package-rating-group-dimensions';
+import {
+  PackageRatingGroupWeight,
+  PackageRatingGroupWeightSchema,
+} from './package-rating-group-weight';
+
+/** @description Details about how packages are related to rates */
+export interface PackageRatingGroup {
+  /** @description Id of the rating group */
+  Id: string;
+  /** @description Id of the package type to which this rating group corresponds */
+  PackageTypeId: string;
+  /** @description Name of the package rating group */
+  Name: string;
+  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
+  CarrierPackageTypeCode: string;
+  /** @description Maximum allowable dimensions of packages for the rating group */
+  DimensionLimits?: PackageRatingGroupDimensions;
+  /** @description Maximum allowable weight of packages for the rating group */
+  MaxWeight?: PackageRatingGroupWeight;
+}
+
+export const PackageRatingGroupSchema = Joi.object({
+  Id: Joi.string().required().max(50),
+  PackageTypeId: Joi.string().uuid().required(),
+  Name: Joi.string().required().max(50),
+  CarrierPackageTypeCode: Joi.string().required().max(50), // Copied from package type validation
+  DimensionLimits: PackageRatingGroupDimensionsSchema.optional(),
+  MaxWeight: PackageRatingGroupWeightSchema.optional(),
+});