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

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

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

package/src/app/metadata/country-association.ts

@@ -1,15 +1,15 @@
-import Joi from 'joi';
-
-/** @description Country code association with an alternate service name */
-export interface CountryAssociation {
-  FromCountry: string;
-  AlternateServiceName?: string;
-}
-
-export const CountryAssociationSchema = Joi.object({
-  FromCountry: Joi.string()
-    .required()
-    .length(2)
-    .message('FromCountry must be the ISO Alpha-2 country code'),
-  AlternateServiceName: Joi.string().optional(),
-});
+import Joi from 'joi';
+
+/** @description Country code association with an alternate service name */
+export interface CountryAssociation {
+  FromCountry: string;
+  AlternateServiceName?: string;
+}
+
+export const CountryAssociationSchema = Joi.object({
+  FromCountry: Joi.string()
+    .required()
+    .length(2)
+    .message('FromCountry must be the ISO Alpha-2 country code'),
+  AlternateServiceName: Joi.string().optional(),
+});

package/src/app/metadata/custom-validators/file-exists.ts

@@ -1,8 +1,8 @@
-import { existsSync } from 'fs';
-
-export const fileExists = (value: string, helpers: any) => {
-  if (existsSync(value)) {
-    return value;
-  }
-  throw new Error("the file doesn't exist");
-};
+import { existsSync } from 'fs';
+
+export const fileExists = (value: string, helpers: any) => {
+  if (existsSync(value)) {
+    return value;
+  }
+  throw new Error("the file doesn't exist");
+};

package/src/app/metadata/diagnostic-routes.ts

@@ -1,5 +1,5 @@
-export default interface DiagnosticRoutes {
-  Liveness?: string;
-  Readiness?: string;
-  Version?: string;
-}
+export default interface DiagnosticRoutes {
+  Liveness?: string;
+  Readiness?: string;
+  Version?: string;
+}

package/src/app/metadata/enums.ts

@@ -1,56 +1,56 @@
-export enum CarrierAttribute {
-  ManifestDigital = 'ManifestDigital',
-  ManifestPhysical = 'ManifestPhysical',
-  Consolidator = 'Consolidator',
-  Regional = 'Regional',
-  RequiresInboundWebhook = 'RequiresInboundWebhook',
-  DetailedStatuses = 'DetailedStatuses',
-  ProofOfDelivery = 'ProofOfDelivery',
-}
-
-export enum ShippingServiceAttribute {
-  Returns = 'Returns',
-  MultiPackage = 'MultiPackage',
-  Tracking = 'Tracking',
-  ConsolidatorService = 'ConsolidatorService',
-  AutomatedTrackingAllowed = 'AutomatedTrackingAllowed',
-  ManifestDigital = 'ManifestDigital',
-  ManifestPhysical = 'ManifestPhysical',
-  SameDayService = 'SameDayService',
-  Tip = 'Tip',
-  DeliveryWindow = 'DeliveryWindow',
-  PickupOnLabelCreation = 'PickupOnLabelCreation',
-  PaperlessLabel = 'PaperlessLabel',
-  InboundTrackingUpdates = 'InboundTrackingUpdates',
-  AllowsShippingToServicePoint = 'AllowsShippingToServicePoint',
-  AllowsShippingOnSunday = 'AllowsShippingOnSunday',
-}
-
-export enum SupportedLabelSize {
-  Inches4x6 = 'Inches4x6',
-  Inches4x8 = 'Inches4x8',
-}
-
-export enum ServiceClass {
-  Unspecified = 'Unspecified',
-  Ground = 'Ground',
-  OneDay = 'OneDay',
-  OneDayEarly = 'OneDayEarly',
-  OneDayEarlyAm = 'OneDayEarlyAm',
-  TwoDay = 'TwoDay',
-  TwoDayEarly = 'TwoDayEarly',
-  ThreeDay = 'ThreeDay',
-}
-
-export enum ServiceGrade {
-  Unspecified = 'Unspecified',
-  Economy = 'Economy',
-  Expedited = 'Expedited',
-  Overnight = 'Overnight',
-  Standard = 'Standard',
-}
-
-export enum RequiredProperty {
-  Weight = 'Weight',
-  Dimensions = 'Dimensions',
-}
+export enum CarrierAttribute {
+  ManifestDigital = 'ManifestDigital',
+  ManifestPhysical = 'ManifestPhysical',
+  Consolidator = 'Consolidator',
+  Regional = 'Regional',
+  RequiresInboundWebhook = 'RequiresInboundWebhook',
+  DetailedStatuses = 'DetailedStatuses',
+  ProofOfDelivery = 'ProofOfDelivery',
+}
+
+export enum ShippingServiceAttribute {
+  Returns = 'Returns',
+  MultiPackage = 'MultiPackage',
+  Tracking = 'Tracking',
+  ConsolidatorService = 'ConsolidatorService',
+  AutomatedTrackingAllowed = 'AutomatedTrackingAllowed',
+  ManifestDigital = 'ManifestDigital',
+  ManifestPhysical = 'ManifestPhysical',
+  SameDayService = 'SameDayService',
+  Tip = 'Tip',
+  DeliveryWindow = 'DeliveryWindow',
+  PickupOnLabelCreation = 'PickupOnLabelCreation',
+  PaperlessLabel = 'PaperlessLabel',
+  InboundTrackingUpdates = 'InboundTrackingUpdates',
+  AllowsShippingToServicePoint = 'AllowsShippingToServicePoint',
+  AllowsShippingOnSunday = 'AllowsShippingOnSunday',
+}
+
+export enum SupportedLabelSize {
+  Inches4x6 = 'Inches4x6',
+  Inches4x8 = 'Inches4x8',
+}
+
+export enum ServiceClass {
+  Unspecified = 'Unspecified',
+  Ground = 'Ground',
+  OneDay = 'OneDay',
+  OneDayEarly = 'OneDayEarly',
+  OneDayEarlyAm = 'OneDayEarlyAm',
+  TwoDay = 'TwoDay',
+  TwoDayEarly = 'TwoDayEarly',
+  ThreeDay = 'ThreeDay',
+}
+
+export enum ServiceGrade {
+  Unspecified = 'Unspecified',
+  Economy = 'Economy',
+  Expedited = 'Expedited',
+  Overnight = 'Overnight',
+  Standard = 'Standard',
+}
+
+export enum RequiredProperty {
+  Weight = 'Weight',
+  Dimensions = 'Dimensions',
+}

package/src/app/metadata/function.ts

@@ -1,4 +1,4 @@
-export interface FunctionSpecification {
-  Name: string;
-  IsSandboxed: boolean;
-}
+export interface FunctionSpecification {
+  Name: string;
+  IsSandboxed: boolean;
+}

package/src/app/metadata/index.ts

@@ -1,27 +1,27 @@
-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 './confirmation-type';
-export * from './country-association';
-export * from './diagnostic-routes';
-export * from './enums';
-export * from './function';
-export * from './label-formats';
-export * from './label-sizes';
-export * from './monoauth';
-export * from './native-rating-configuration';
-export * from './package-type';
-export * from './rate-card';
-export * from './service-class';
-export * from './service-grade';
-export * from './service-required-properties';
-export * from './services-attributes';
-export * from './shipping-option';
-export * from './shipping-provider-connector';
-export * from './shipping-service';
-export * from './zone';
-export * from './connection-names-configuration';
-export * from './account-connection-specification';
+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 './confirmation-type';
+export * from './country-association';
+export * from './diagnostic-routes';
+export * from './enums';
+export * from './function';
+export * from './label-formats';
+export * from './label-sizes';
+export * from './monoauth';
+export * from './native-rating-configuration';
+export * from './package-type';
+export * from './rate-card';
+export * from './service-class';
+export * from './service-grade';
+export * from './service-required-properties';
+export * from './services-attributes';
+export * from './shipping-option';
+export * from './shipping-provider-connector';
+export * from './shipping-service';
+export * from './zone';
+export * from './connection-names-configuration';
+export * from './account-connection-specification';

package/src/app/metadata/label-formats.ts

@@ -1,9 +1,9 @@
-import Joi from 'joi';
-
-export enum LabelFormatsEnum {
-  PDF = 'PDF',
-  ZPL = 'ZPL',
-  PNG = 'PNG',
-}
-
-export const LabelFormatsEnumSchema = Joi.string().valid(...Object.values(LabelFormatsEnum));
+import Joi from 'joi';
+
+export enum LabelFormatsEnum {
+  PDF = 'PDF',
+  ZPL = 'ZPL',
+  PNG = 'PNG',
+}
+
+export const LabelFormatsEnumSchema = Joi.string().valid(...Object.values(LabelFormatsEnum));

package/src/app/metadata/label-sizes.ts

@@ -1,8 +1,8 @@
-import Joi from 'joi';
-
-export enum LabelSizesEnum {
-  Inches4x6 = 'Inches4x6',
-  Inches4x8 = 'Inches4x8',
-}
-
-export const LabelSizesEnumSchema = Joi.string().valid(...Object.values(LabelSizesEnum));
+import Joi from 'joi';
+
+export enum LabelSizesEnum {
+  Inches4x6 = 'Inches4x6',
+  Inches4x8 = 'Inches4x8',
+}
+
+export const LabelSizesEnumSchema = Joi.string().valid(...Object.values(LabelSizesEnum));

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(),
+});