@shipengine/connect-carrier-api 2.2.2 → 2.2.3

package/src/models/addresses/address-base.ts

@@ -1,35 +1,34 @@
 import { AddressResidentialIndicator } from './address-residential-indicator';
 
 export class AddressBase {
-  /** @description Name of the contact */
+  /** @description The full name of the contact contact associated with the address */
   name?: string;
-  /** @description First or given name of the contact */
+  /** @description The first name of the contact associated with the address */
   first_name?: string;
-  /** @description Last or family name of the contact  */
+  /** @description The last name of the contact associated with the address */
   last_name?: string;
-  /** @description Email of the contact */
+  /** @description The email of the contact associated with the address */
   email?: string;
-  /** @description Phone number of the contact. Cannot include newline chars. */
-
+  /** @description The phone number of the contact associated with the address (No Newline Characters) */
   phone_number?: string;
-  /** @description Company name, if applicable. Cannot include newline chars. */
+  /** @description The name of the company associated with this address (No Newline Characters) max length 100 characters */
   company_name?: string;
-  /** @description Address fields separated by line. Up to 100 chars per line. Cannot include newline chars. */
+  /** @description The address lines of the address (No Newline Characters) max length 100 characters */
   address_lines?: string[];
-  /** @description City or locality. Cannot contain newline chars. */
+  /** @description City or locality (No Newline Characters) */
   city_locality?: string;
-  /** @description State or province. Cannot contain newline chars. */
+  /** @description State or province (No Newline Characters) */
   state_province?: string;
-  /** @description Zip or postal code. Cannot include newline chars. */
+  /** @description Zip or postal code (No Newline Characters) */
   postal_code!: string;
-  /** @description ISO 3166-1 two-letter country code  */
+  /** @description ISO 3166-1 two-letter country code max length 2 characters  */
   country_code!: string;
   /** @description Whether the address is residential or commercial */
   address_residential_indicator?: AddressResidentialIndicator;
   /** @description Whether the country of the shipment address is a member of the EU */
   is_eu?: boolean;
-  /** @description Metadata for this address */
+  /** @description Additional metadata provided for specific requests */
   address_metadata?: { [key: string]: string };
-  /** @description Instructions to help the carrier navigate to the address. */
+  /** @description Instructions to help the carrier navigate to the address */
   instructions?: string;
 }

package/src/models/addresses/address-residential-indicator.ts

@@ -1,6 +1,9 @@
 /** @description Used for indicating whether an address is residential or commercial */
 export enum AddressResidentialIndicator {
+  /** @description Indicates that it is unknown whether or not the address is in a residential or commercial area */
   Unknown = 'unknown',
+  /** @description Indicates that the address is in a residential area */
   Yes = 'yes',
+  /** @description Indicates that the address is not in a residential area */
   No = 'no',
 }

package/src/models/addresses/ship-from-display.ts

@@ -1,3 +1,4 @@
 import { AddressBase } from './address-base';
 
+/** @description The address that should be displayed on the label as the ship from location */
 export class ShipFromDisplay extends AddressBase {}

package/src/models/addresses/ship-from.ts

@@ -1,6 +1,7 @@
 import { AddressBase } from './address-base';
 import { TaxIdentifier } from '../taxes/tax-identifier';
 
+/** @description The address for where the shipment will be shipped from */
 export class ShipFrom extends AddressBase {
   /** @description Tax IDs associated with the exporter */
   tax_identifiers?: TaxIdentifier[];

package/src/models/addresses/ship-to.ts

@@ -1,6 +1,7 @@
 import { AddressBase } from './address-base';
 import { TaxIdentifier } from '../taxes/tax-identifier';
 
+/** @description The address that a shipment will be delivered to */
 export class ShipTo extends AddressBase {
   /** @description Tax IDs associated with the consignee */
   tax_identifiers?: TaxIdentifier[];

package/src/models/advanced-options.ts

@@ -12,7 +12,7 @@ export class AdvancedOptions {
   bill_duties_to_sender?: boolean;
   /** @description Whether Saturday delivery is permissible  */
   saturday_delivery?: boolean;
-  /** @description Amount to be paid to the driver, used for local delivery and courier services. */
+  /** @description Amount to be paid to the driver, used for local delivery and courier services */
   tip?: Currency;
   /** @description Any other custom shipping options */
   [key: string]: any;

package/src/models/authorization.ts

@@ -1,4 +1,6 @@
 export class Authorization {
+  /** @description The access token used to authorize the request */
   access_token?: string;
+  /** @description Optional - any additional information required to authorize the request */
   connection_context?: any;
 }

package/src/models/billing/billing-categories.ts

@@ -22,7 +22,7 @@ export enum BillingCategories {
   Oversize = 'oversize',
   Returns = 'returns',
   Notifications = 'notifications',
-  /** @description Amount to be paid to the driver, used for local delivery and courier services. */
+  /** @description Amount to be paid to the driver, used for local delivery and courier services */
   Tip = 'tip',
 }
 

package/src/models/billing/billing-line-item.ts

@@ -7,17 +7,22 @@ import Joi from 'joi';
 
 /** @description Basic structure of each charge or line item */
 export class BillingLineItem {
+  /** A generalized category for what type of billing line item this is */
   billing_category!: BillingCategories;
+  /** @description If the carrier provides a description from their API about the billing charge (not specific to the user). Maximum length of 100 characters. */
   carrier_description?: string;
+  /** @description If the carrier provides a billing code for */
   carrier_billing_code?: string;
+  /** @description This will often be empty; however, if there was additionally specific information about the charge it should go here, could also be a reference number. Maximum length of 250 characters. */
   memo?: string;
+  /** @description Total amount of the line item */
   amount!: Currency;
 }
 
 export const BillingLineItemSchema = Joi.object({
   billing_category: BillingCategoriesSchema.required(),
-  carrier_description: Joi.string().optional().empty(),
+  carrier_description: Joi.string().optional().empty().max(100),
   carrier_billing_code: Joi.string().optional().empty(),
-  memo: Joi.string().optional().empty(),
+  memo: Joi.string().optional().empty().max(250),
   amount: CurrencySchema.required(),
 });

package/src/models/confirmation-types.ts

@@ -1,13 +1,13 @@
 /** @description Types of delivery confirmation */
 export enum ConfirmationTypes {
-  /** @description No confirmation is requested. */
+  /** @description No confirmation is requested */
   None = 'None',
-  /** @description Delivery confirmation is requested. */
+  /** @description Delivery confirmation is requested */
   Delivery = 'Delivery',
-  /** @description A signature is required. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present). */
+  /** @description A signature is required. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present) */
   Signature = 'Signature',
-  /** @description A signature of an adult is required. */
+  /** @description A signature of an adult is required */
   AdultSignature = 'AdultSignature',
-  /** @description Only supported by FedEx. The signature of somebody at the address is required. */
+  /** @description Only supported by FedEx. The signature of somebody at the address is required */
   DirectSignature = 'DirectSignature',
 }

package/src/models/currency.ts

@@ -2,7 +2,9 @@ import Joi from 'joi';
 
 /** @description Basic structure for defining an amount of money and its currency */
 export class Currency {
+  /** @description The ISO 4217 Currency Code (USD, EUR, etc) https://www.iso.org/iso-4217-currency-codes.html */
   currency!: string;
+  /** @description The amount */
   amount!: string;
 }
 

package/src/models/customs/customs-content-types.ts

@@ -1,9 +1,13 @@
 /** @description Denotes the type of content for customs  */
 export enum CustomsContentTypes {
+  /** @description This is generalized merchandise that someone has purchased */
   Merchandise = 'merchandise',
+  /** @description Documents that are being shipped */
   Documents = 'documents',
+  /** @description An item that is being shipped as a gift (not purchased) */
   Gift = 'gift',
-  /** @description e.g. a flooring sample */
+  /** @description Sample goods that are being shipped */
   Sample = 'sample',
+  /** @description Items that are being returned */
   ReturnedGoods = 'returned_goods',
 }

package/src/models/customs/customs-item.ts

@@ -1,14 +1,22 @@
 import { Currency } from '../currency';
 import { WeightDetails } from '../units';
 
-/** @description Basic structure of an item in a customs declaration */
+/** @description This model represents the customs declaration for a single item */
 export class CustomsItem {
+  /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
   description?: string;
+  /** @description The user specified count of items in this declaration. This value should be 1 or greater */
   quantity?: number;
+  /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
   value?: Currency;
+  /** @description The user specified declared country of origin of this customs item */
   country_of_origin?: string;
+  /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
   harmonized_tariff_code?: string;
+  /** @description The user specified SKU of this customs item. This field is completely free form. */
   sku?: string;
+  /** @description The user specified SKU description of this customs item. This field is completely free form. */
   sku_description?: string;
+  /** @description Detailed information about the weight of this item */
   item_weight?: WeightDetails;
 }

package/src/models/customs/customs-non-delivery.ts

@@ -1,5 +1,7 @@
 /** @description Denotes the action that should be taken when a shipment is not deliverable */
 export enum CustomsNonDelivery {
+  /** @description Make an attempt to return this package to sender if unable to deliver */
   ReturnToSender = 'return_to_sender',
+  /** @description Do not make an attempt to return this package to sender if unable to deliver */
   TreatAsAbandoned = 'treat_as_abandoned',
 }

package/src/models/customs/customs.ts

@@ -3,11 +3,16 @@ import { CustomsNonDelivery } from './customs-non-delivery';
 import { CustomsItem } from './customs-item';
 import { Currency } from '../currency';
 
-/** @description Basic structure for a customs declaration. */
+/** @description Basic structure for a customs declaration */
 export class Customs {
+  /** @description Indicates the type of contents associated with this shipment */
   contents?: CustomsContentTypes;
+  /** @description Indicates what the seller would like done in case of an issue with delivery */
   non_delivery?: CustomsNonDelivery;
+  /** @description A list of customs items to declare */
   customs_items!: CustomsItem[];
+  /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
   buyer_shipping_amount_paid?: Currency;
+  /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
   duties_paid?: Currency;
 }

package/src/models/documents/document-type.ts

@@ -2,9 +2,13 @@ import Joi from 'joi';
 
 /** @description Types of documents */
 export enum DocumentType {
+  /** @description A shipping label */
   Label = 'label',
+  /** @description A form that lists the details of goods that are being imported or exported when a citizen or visitor enters a customs territory (country's borders) */
   CustomsForm = 'customs_form',
+  /** @description A legal document issued by the seller (exporter) to the buyer (importer) in an international transaction and serves as a contract and a proof of sale between the buyer and seller */
   CommercialInvoice = 'commercial_invoice',
+  /** @description A legal document issued by a carrier to a shipper that details the type, quantity, and destination of the goods being carried (does not indicate the ownership of goods nor does it carry a title to the goods being sold) */
   BillOfLading = 'bill_of_lading',
 }
 

package/src/models/documents/document.ts

@@ -7,8 +7,11 @@ import Joi from 'joi';
 
 /** @description Basic structure for a document */
 export class Document {
+  /** @description The document type(s) being returned. In most cases this is just a single document type; however, some carriers return multiple document types in the same PDF or ZPL */
   type!: DocumentType[];
+  /** @description Base64 encoded data for the document */
   data!: string;
+  /** @description The format the document is in (Pdf, Zpl, etc) */
   format!: DocumentFormat;
 }
 export const DocumentSchema = Joi.object({

package/src/models/errors/detailed-error.ts

@@ -1,6 +1,6 @@
 import { StandardizedErrorCode } from './standardized-error-code';
 
-/** @description Basic structure for an error */
+/** @deprecated Please Use Runtime Errors */
 export class DetailedError {
   standardized_error_code!: StandardizedErrorCode;
   external_error_code?: string;

package/src/models/errors/standardized-error-code.ts

@@ -1,4 +1,4 @@
-/** @description Error codes for DetailedError */
+/** @deprecated Please Use Runtime Errors */
 export enum StandardizedErrorCode {
   Generic = 0,
   Serialization = 1,

package/src/models/fulfillment-plans/fulfillment-plan-details.ts

@@ -2,9 +2,12 @@ import { Identifier } from '../identifier';
 import { FulfillmentPlanItems } from './fulfillment-plan-items';
 import { RawExternalSource } from './raw-external-source';
 
-/** @description Basic structure for a fulfillment plan */
+/** @description This model contains information about the fulfillment plan. */
 export class FulfillmentPlanDetails {
+  /** @description A list of identifiers for the sales order. */
   external_sales_order_identifiers?: Identifier[];
+  /** @description Information about the fulfillment plan item. */
   items?: FulfillmentPlanItems[];
+  /** @description This model represents a raw external source of information */
   raw_external_source?: RawExternalSource;
 }

package/src/models/fulfillment-plans/fulfillment-plan-items.ts

@@ -2,12 +2,12 @@ import { Identifier } from '../identifier';
 
 /** @description Information about the fulfillment plan for a set of items */
 export class FulfillmentPlanItems {
-  /** @description List of identifiers for the sales order */
+  /** @description A list of identifiers for the sales order */
   external_sales_order_identifiers?: Identifier[];
-  /** @description List of identifiers specific to the selling channel */
+  /** @description A list of identifiers specific to the selling channel */
   external_product_identifiers?: Identifier[];
-  /** @description Name of the item */
+  /** @description The name of the item */
   name?: string;
-  /** @description Number of items */
+  /** @description The number of items */
   quantity?: number;
 }

package/src/models/fulfillment-plans/raw-external-source.ts

@@ -1,3 +1,5 @@
+/** @description This model represents a raw external source of information. */
 export class RawExternalSource {
+  /** @description Canonical representation of the fulfillment plan's and/or sales order's original source */
   marketplace_code?: string;
 }

package/src/models/labels/form-download.ts

@@ -1,7 +1,9 @@
 import Joi from 'joi';
 import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
+/** @description This provides any additional forms that go with the label. For example, customs forms. Exactly one of the keys should be populated. Set href is the forms should be downloaded separately. Set data if the forms are returned directly in the response. */
 export class FormDownload extends ResourceDownload {
+  /** @description The base64 encoded resource data. */
   form_data?: string;
 }
 

package/src/models/labels/label-download.ts

@@ -1,7 +1,9 @@
 import Joi from 'joi';
 import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
+/** @description This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response. */
 export class LabelDownload extends ResourceDownload {
+  /** @description The base64 encoded resource data. */
   label_data?: string;
 }
 

package/src/models/labels/label-package.ts

@@ -4,9 +4,11 @@ import Joi from 'joi';
 
 /** @description Package information provided by the carrier */
 export class LabelPackage {
+  /** @description Tracking number for the package */
   tracking_number?: string;
   /** @description Non-tracking alternative ids associated with this package */
   alternative_identifiers?: Identifier[];
+  /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
   documents?: Document[];
 }
 

package/src/models/labels/return-label-details.ts

@@ -1,4 +1,5 @@
 /** @description Basic structure for a return label */
 export class ReturnLabelDetails {
+  /** @description A return merchandise authorization (RMA) is an associated number assigned to process the return, this number is often printed on the label, and used when the original shipper processes the inbound return. */
   rma_number?: string;
 }

package/src/models/labels/void-request.ts

@@ -3,6 +3,8 @@ import { ShipFrom } from '../addresses';
 
 /** @description Basic structure for a request to void a label */
 export class VoidRequest extends ShippedShipment {
+  /** @description Uniquely identifies this request to void a label. Must be returned in a void response. */
   void_request_id!: string;
+  /** @description The location the shipment was shipped from */
   ship_from!: ShipFrom;
 }

package/src/models/labels/void-response.ts

@@ -8,7 +8,7 @@ export class VoidResponse {
   message?: string;
   /** @description Any errors from attempting to void */
   errors?: string[];
-  /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee. */
+  /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee */
   billing_line_items?: BillingLineItem[];
 }
 

package/src/models/manifests/label.ts

@@ -1,5 +1,7 @@
 /** @description Basic structure of a manifest label */
 export class Label {
+  /** @description The carrier tracking number for this shipment */
   tracking_number?: string;
+  /** @description The carrier specific identifier for this shipment */
   carrier_transaction_id?: string;
 }

package/src/models/manifests/manifest.ts

@@ -1,11 +1,15 @@
 import Joi from 'joi';
 import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
-/** @description Basic structure of a manifest */
+/** @description This model represents a single manifest created with a shipping provider. */
 export class Manifest {
+  /** @description The unique identifier for this manifest. */
   manifest_id?: string;
+  /** @description The resource and where it can be downloaded */
   document_download?: ResourceDownload;
+  /** @deprecated This property is no longer used please use the document_download */
   document_href?: string;
+  /** @deprecated This property is no longer used please use the document_download */
   document_data?: string;
 }
 

package/src/models/package.ts

@@ -7,10 +7,16 @@ import { Customs } from './customs';
 
 /** @description Basic structure for a package */
 export class Package {
+  /** @description Package code defined for the carrier in ShipEngine. */
   package_code?: string;
+  /** @description Details about the dimensions of the package */
   dimension_details?: DimensionDetails;
+  /** @description Details about the weight of the package */
   weight_details?: WeightDetails;
+  /** @description The insured value of this package. */
   insured_value!: Currency;
+  /** @description The message the seller requested to have on their label */
   label_messages?: LabelMessage;
+  /** @description Basic structure for a customs declaration (Only available on international shipments) */
   customs?: Customs;
 }

package/src/models/pickup/cancellation-details.ts

@@ -2,6 +2,7 @@ import { CancellationReason } from './cancellation-reason';
 
 /** @description Basic structure for a cancellation */
 export class CancellationDetails {
+  /** @description The reason the pickup has been cancelled */
   reason!: CancellationReason;
   /** @description Additional properties about cancellation */
   cancellation_options?: { [key: string]: string };

package/src/models/pickup/pickup-confirmation.ts

@@ -7,8 +7,11 @@ import {
 
 /** @description Basic structure for a pickup confirmation */
 export class PickupConfirmation {
+  /** @description The primary confirmation ID for this request. */
   confirmation_id?: string;
+  /** @description Other identifiers potentially needed in other calls. */
   alternate_identifiers?: Identifier[];
+  /** @description List of the shipments added for this pickup. */
   shipment_identifiers?: ShipmentIdentifier[];
 }
 export const PickupConfirmationSchema = Joi.object({

package/src/models/pickup/pickup-contact-details.ts

@@ -1,8 +1,13 @@
-/** @description Contact details */
+/** @description Contact information for the person who will be present for the pickup. */
 export class PickupContactDetails {
+  /** @description The first name of the person who will be there for the pickup. */
   first_name!: string;
+  /** @description The last name of the person who will be there for the pickup. */
   last_name?: string;
+  /** @description The e-mail address of the person who will be there for the pickup. */
   email!: string;
+  /** @description The phone number of the person who will be there for the pickup. */
   phone_number!: string;
+  /** @description The phone extension of the person who will be there for the pickup. */
   phone_number_extension?: string;
 }

package/src/models/pickup/pickup-location-details.ts

@@ -2,6 +2,7 @@ import { ShipFrom } from '../addresses/ship-from';
 
 /** @description Location details for pickup */
 export class PickupLocationDetails {
+  /** @description The address the pickup will take place */
   pickup_address?: ShipFrom;
   /** @description Any notes that may be helpful for a driver to find the pickup location */
   location_notes?: string;

package/src/models/pickup/pickup-package.ts

@@ -5,11 +5,18 @@ import { Dimensions } from '../units/dimensions';
 
 /** @description Basic structure for a package to be picked up */
 export class PickupPackage {
+  /** @description The carrier tracking number for this shipment */
   tracking_number?: string;
+  /** @description Alternative identifiers associated with this package */
   alternative_identifiers?: Identifier[];
+  /** @description Details about the dimensions of the package */
   dimension_details?: DimensionDetails;
+  /** @description Details about the weight of the package */
   weight_details?: WeightDetails;
+  /** @description The code associated with the package type */
   package_code?: string;
+  /** @deprectated Please use the weight_details property */
   weight?: number;
+  /** @deprectated Please use the dimension_details property */
   dimensions?: Dimensions;
 }

package/src/models/pickup/pickup-shipment-details.ts

@@ -2,6 +2,7 @@ import { ShippedShipment } from './shipped-shipment';
 
 /** @description Details for a pickup shipment */
 export class PickupShipmentDetails {
+  /** @description Service category for the carrier (ground, express, next_day) */
   pickup_service_code?: string;
   /** @description List of shipments to be picked up */
   shipments?: ShippedShipment[];

package/src/models/pickup/pickup-window.ts

@@ -1,10 +1,14 @@
 import Joi from 'joi';
 
-/** @description Time window for pickup */
+/** @description This model represents a window of time a pickup could be made. */
 export class PickupWindow {
+  /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones */
   time_zone_iana!: string;
+  /** @description The local date the pickup will occur. Formatted per https://tools.ietf.org/html/rfc3339 */
   pickup_date!: string;
+  /** @description The time relative to the time_zone_iana that the carrier says that the pickup could occur. Formatted per https://tools.ietf.org/html/rfc3339 */
   start_time?: string;
+  /** @description The end of the window when the pickup could be made relative to the time_zone_iana. Formatted per https://tools.ietf.org/html/rfc3339 */
   end_time?: string;
 }
 export const PickupWindowSchema = Joi.object({

package/src/models/pickup/shipment-identifier.ts

@@ -3,7 +3,9 @@ import { Identifier, IdentifierSchema } from '../identifier';
 
 /** @description Identifier object for shiments */
 export class ShipmentIdentifier {
+  /** @description The carrier tracking number for this shipment */
   tracking_number?: string;
+  /** @description A list of alternate identifiers that can be used to identify a shipment */
   alternate_identifiers?: Identifier[];
 }
 

package/src/models/pickup/shipped-package.ts

@@ -5,11 +5,18 @@ import { Dimensions } from '../units/dimensions';
 
 /** @description Basic structure for a package that has been shipped */
 export class ShippedPackage {
+  /** @description The carrier tracking number associated with this package */
   tracking_number?: string;
+  /** @description Alternative identifiers associated with this package */
   alternative_identifiers?: Identifier[];
+  /** @description Details about the dimensions of the package */
   dimension_details?: DimensionDetails;
+  /** @description Details about the weight of the package */
   weight_details?: WeightDetails;
+  /** @description The code associated with the package type */
   package_code?: string;
+  /** @deprectated Please use the weight_details property */
   weight?: number;
+  /** @deprectated Please use the dimension_details property */
   dimensions?: Dimensions;
 }

package/src/models/pickup/shipped-shipment.ts

@@ -6,11 +6,17 @@ import { ShippedPackage } from './shipped-package';
 
 /** @description Basic structure for a shipment that has been shipped */
 export class ShippedShipment extends Label {
+  /** @description The carrier tracking number associated with this package */
   tracking_number?: string;
+  /** @description The address that a shipment will be delivered to */
   ship_to?: ShipTo;
+  /** @description Non-tracking alternative ids associated with this shipment */
   alternative_identifiers?: Identifier[];
+  /** @description The service code used for this shipment */
   service_code?: string;
+  /** @description The list of packages associated with this shipment */
   packages?: ShippedPackage[];
+  /** @description Advanced shipping options (Contains Alcohol, Non Machinable, etc) */
   advanced_options?: AdvancedOptions;
 }
 

package/src/models/rates/rate.ts

@@ -7,6 +7,7 @@ import { TimeWindow, TimeWindowSchema } from '../time-window';
 
 /** @description Basic structure for a rate */
 export class Rate {
+  /** @description The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine. If this field is missing, the rate will be discarded. */
   service_code?: string;
   /** @description ISO 8601 formatted date for shipment */
   ship_datetime?: string;
@@ -26,10 +27,7 @@ export class Rate {
   delivery_window?: TimeWindow;
   /** @description Unique identifier for the carrier rate */
   carrier_rate_id?: string;
-  /** @description DateTime after which the rate will no longer be accepted.
-   * ISO 8601 format, with local offset.
-   * Example: 2021-08-20T14:38:36.859237-05:00
-   */
+  /** @description DateTime after which the rate will no longer be accepted. ISO 8601 format, with local offset. Example: 2021-08-20T14:38:36.859237-05:00 */
   expiration_datetime?: string;
 }
 

package/src/models/registration/credentials.ts

@@ -2,7 +2,9 @@ import Joi from 'joi';
 
 /** @description Basic structure for credentials */
 export class Credentials {
+  /** @description The username, used as the unique identifier for the account */
   username!: string;
+  /** @description The password that will be sent in future requests */
   password!: string;
 }
 

package/src/models/resource-download.ts

@@ -2,7 +2,9 @@ import Joi from 'joi';
 
 /** @description Basic structure for a resource to download */
 export class ResourceDownload {
+  /** @deprecated This property is not used by the platform */
   href?: string;
+  /** @description Base64 encoded data for the resource */
   data?: string;
 }