@sp-api-sdk/shipping-api-v2 2.1.4 → 2.1.6

package/dist/types/api-model/base.d.ts

@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

package/dist/types/api-model/common.d.ts

@@ -12,54 +12,17 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/api-model/configuration.d.ts

@@ -23,49 +23,32 @@ export declare class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**

package/dist/types/api-model/models/access-point-details.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * AccessPointDetails object
- * @export
- * @interface AccessPointDetails
  */
 export interface AccessPointDetails {
     /**
      * Unique identifier for the access point
-     * @type {string}
-     * @memberof AccessPointDetails
      */
     'accessPointId'?: string;
 }

package/dist/types/api-model/models/access-point-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The type of access point, like counter (HELIX), lockers, etc.
- * @export
- * @enum {string}
  */
 export declare const AccessPointType: {
     readonly Helix: "HELIX";

package/dist/types/api-model/models/access-point.d.ts

@@ -16,68 +16,37 @@ import type { ExceptionOperatingHours } from './exception-operating-hours';
 import type { OperatingHours } from './operating-hours';
 /**
  * Access point details
- * @export
- * @interface AccessPoint
  */
 export interface AccessPoint {
     /**
      * Unique identifier for the access point
-     * @type {string}
-     * @memberof AccessPoint
      */
     'accessPointId'?: string;
     /**
      * Name of entity (store/hub etc) where this access point is located
-     * @type {string}
-     * @memberof AccessPoint
      */
     'name'?: string;
     /**
      * Timezone of access point
-     * @type {string}
-     * @memberof AccessPoint
      */
     'timezone'?: string;
-    /**
-     *
-     * @type {AccessPointType}
-     * @memberof AccessPoint
-     */
     'type'?: AccessPointType;
-    /**
-     *
-     * @type {AccessibilityAttributes}
-     * @memberof AccessPoint
-     */
     'accessibilityAttributes'?: AccessibilityAttributes;
-    /**
-     *
-     * @type {Address}
-     * @memberof AccessPoint
-     */
     'address'?: Address;
     /**
      * Exception operating hours for Access Point
-     * @type {Array<ExceptionOperatingHours>}
-     * @memberof AccessPoint
      */
     'exceptionOperatingHours'?: Array<ExceptionOperatingHours>;
     /**
      * Assistance type enum for Access point i.e. STAFF_ASSISTED or SELF_ASSISTED
-     * @type {string}
-     * @memberof AccessPoint
      */
     'assistanceType'?: AccessPointAssistanceTypeEnum;
     /**
      * The score of access point, based on proximity to postal code and sorting preference. This can be used to sort access point results on shipper\'s end.
-     * @type {string}
-     * @memberof AccessPoint
      */
     'score'?: string;
     /**
      * Map of day of the week to operating hours of that day
-     * @type {{ [key: string]: OperatingHours; }}
-     * @memberof AccessPoint
      */
     'standardOperatingHours'?: {
         [key: string]: OperatingHours;

package/dist/types/api-model/models/accessibility-attributes.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Defines the accessibility details of the access point.
- * @export
- * @interface AccessibilityAttributes
  */
 export interface AccessibilityAttributes {
     /**
      * The approximate distance of access point from input postalCode\'s centroid.
-     * @type {string}
-     * @memberof AccessibilityAttributes
      */
     'distance'?: string;
     /**
      * The approximate (static) drive time from input postal code\'s centroid.
-     * @type {number}
-     * @memberof AccessibilityAttributes
      */
     'driveTime'?: number;
 }

package/dist/types/api-model/models/account-status.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Account Status.
- * @export
- * @enum {string}
  */
 export declare const AccountStatus: {
     readonly Active: "ACTIVE";

package/dist/types/api-model/models/account-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Shipper Account Type.
- * @export
- * @enum {string}
  */
 export declare const AccountType: {
     readonly ShipperAccount: "SHIPPER_ACCOUNT";

package/dist/types/api-model/models/active-account.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Active Account Details
- * @export
- * @interface ActiveAccount
  */
 export interface ActiveAccount {
     /**
      * Identifier for the seller\'s carrier account.
-     * @type {string}
-     * @memberof ActiveAccount
      */
     'accountId'?: string;
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof ActiveAccount
      */
     'carrierId'?: string;
 }

package/dist/types/api-model/models/address.d.ts

@@ -12,80 +12,51 @@
 import type { Geocode } from './geocode';
 /**
  * The address.
- * @export
- * @interface Address
  */
 export interface Address {
     /**
      * The name of the person, business or institution at the address.
-     * @type {string}
-     * @memberof Address
      */
     'name': string;
     /**
      * The first line of the address.
-     * @type {string}
-     * @memberof Address
      */
     'addressLine1': string;
     /**
      * Additional address information, if required.
-     * @type {string}
-     * @memberof Address
      */
     'addressLine2'?: string;
     /**
      * Additional address information, if required.
-     * @type {string}
-     * @memberof Address
      */
     'addressLine3'?: string;
     /**
      * The name of the business or institution associated with the address.
-     * @type {string}
-     * @memberof Address
      */
     'companyName'?: string;
     /**
      * The state, county or region where the person, business or institution is located.
-     * @type {string}
-     * @memberof Address
      */
     'stateOrRegion': string;
     /**
      * The city or town where the person, business or institution is located.
-     * @type {string}
-     * @memberof Address
      */
     'city': string;
     /**
      * The two digit country code. Follows ISO 3166-1 alpha-2 format.
-     * @type {string}
-     * @memberof Address
      */
     'countryCode': string;
     /**
      * The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
-     * @type {string}
-     * @memberof Address
      */
     'postalCode': string;
     /**
      * The email address of the contact associated with the address.
-     * @type {string}
-     * @memberof Address
      */
     'email'?: string;
     /**
      * The phone number of the person, business or institution located at that address, including the country calling code.
-     * @type {string}
-     * @memberof Address
      */
     'phoneNumber'?: string;
-    /**
-     *
-     * @type {Geocode}
-     * @memberof Address
-     */
     'geocode'?: Geocode;
 }

package/dist/types/api-model/models/amazon-order-details.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * Amazon order information. This is required if the shipment source channel is Amazon.
- * @export
- * @interface AmazonOrderDetails
  */
 export interface AmazonOrderDetails {
     /**
      * The Amazon order ID associated with the Amazon order fulfilled by this shipment.
-     * @type {string}
-     * @memberof AmazonOrderDetails
      */
     'orderId': string;
 }

package/dist/types/api-model/models/amazon-shipment-details.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * Amazon shipment information.
- * @export
- * @interface AmazonShipmentDetails
  */
 export interface AmazonShipmentDetails {
     /**
      * This attribute is required only for a Direct Fulfillment shipment. This is the encrypted shipment ID.
-     * @type {string}
-     * @memberof AmazonShipmentDetails
      */
     'shipmentId': string;
 }

package/dist/types/api-model/models/available-value-added-service-group.d.ts

@@ -12,32 +12,22 @@
 import type { ValueAddedService } from './value-added-service';
 /**
  * The value-added services available for purchase with a shipping service offering.
- * @export
- * @interface AvailableValueAddedServiceGroup
  */
 export interface AvailableValueAddedServiceGroup {
     /**
      * The type of the value-added service group.
-     * @type {string}
-     * @memberof AvailableValueAddedServiceGroup
      */
     'groupId': string;
     /**
      * The name of the value-added service group.
-     * @type {string}
-     * @memberof AvailableValueAddedServiceGroup
      */
     'groupDescription': string;
     /**
      * When true, one or more of the value-added services listed must be specified.
-     * @type {boolean}
-     * @memberof AvailableValueAddedServiceGroup
      */
     'isRequired': boolean;
     /**
      * A list of optional value-added services available for purchase with a shipping service offering.
-     * @type {Array<ValueAddedService>}
-     * @memberof AvailableValueAddedServiceGroup
      */
     'valueAddedServices'?: Array<ValueAddedService>;
 }

package/dist/types/api-model/models/benefits.d.ts

@@ -12,20 +12,14 @@
 import type { ExcludedBenefit } from './excluded-benefit';
 /**
  * Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC.
- * @export
- * @interface Benefits
  */
 export interface Benefits {
     /**
      * A list of included benefits.
-     * @type {Array<string>}
-     * @memberof Benefits
      */
     'includedBenefits': Array<string>;
     /**
      * A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation
-     * @type {Array<ExcludedBenefit>}
-     * @memberof Benefits
      */
     'excludedBenefits': Array<ExcludedBenefit>;
 }

package/dist/types/api-model/models/cancel-shipment-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * Response schema for the cancelShipment operation.
- * @export
- * @interface CancelShipmentResponse
  */
 export interface CancelShipmentResponse {
     /**
      * The payload for the cancelShipment operation.
-     * @type {{ [key: string]: object; }}
-     * @memberof CancelShipmentResponse
      */
     'payload'?: {
         [key: string]: object;

package/dist/types/api-model/models/carrier-account-attribute.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * Attribute Properties required by carrier
- * @export
- * @interface CarrierAccountAttribute
  */
 export interface CarrierAccountAttribute {
     /**
      * Attribute Name .
-     * @type {string}
-     * @memberof CarrierAccountAttribute
      */
     'attributeName'?: string;
     /**
      * Property Group.
-     * @type {string}
-     * @memberof CarrierAccountAttribute
      */
     'propertyGroup'?: string;
     /**
      * Value .
-     * @type {string}
-     * @memberof CarrierAccountAttribute
      */
     'value'?: string;
 }

package/dist/types/api-model/models/carrier-account-input.d.ts

@@ -13,56 +13,35 @@ import type { InputType } from './input-type';
 import type { ValidationMetadata } from './validation-metadata';
 /**
  * Info About CarrierAccountInput
- * @export
- * @interface CarrierAccountInput
  */
 export interface CarrierAccountInput {
     /**
      * descriptionLocalizationKey value .
-     * @type {string}
-     * @memberof CarrierAccountInput
      */
     'descriptionLocalizationKey'?: string;
     /**
      * name value .
-     * @type {string}
-     * @memberof CarrierAccountInput
      */
     'name'?: string;
     /**
      * groupName value .
-     * @type {string}
-     * @memberof CarrierAccountInput
      */
     'groupName'?: string;
-    /**
-     *
-     * @type {InputType}
-     * @memberof CarrierAccountInput
-     */
     'inputType'?: InputType;
     /**
      * mandatory or not  value .
-     * @type {boolean}
-     * @memberof CarrierAccountInput
      */
     'isMandatory'?: boolean;
     /**
      * is value is Confidential .
-     * @type {boolean}
-     * @memberof CarrierAccountInput
      */
     'isConfidential'?: boolean;
     /**
      * is value is hidden .
-     * @type {boolean}
-     * @memberof CarrierAccountInput
      */
     'isHidden'?: boolean;
     /**
      * A list of ValidationMetadata
-     * @type {Array<ValidationMetadata>}
-     * @memberof CarrierAccountInput
      */
     'validationMetadata'?: Array<ValidationMetadata>;
 }

package/dist/types/api-model/models/carrier-account.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Carrier Account details used to fetch rates.
- * @export
- * @interface CarrierAccount
  */
 export interface CarrierAccount {
     /**
      * Identifier for the seller\'s carrier account.
-     * @type {string}
-     * @memberof CarrierAccount
      */
     'carrierAccountId': string;
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof CarrierAccount
      */
     'carrierId': string;
 }

package/dist/types/api-model/models/carrier.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * Carrier Related Info
- * @export
- * @interface Carrier
  */
 export interface Carrier {
     /**
      * The carrier identifier for the offering, provided by the carrier.
-     * @type {string}
-     * @memberof Carrier
      */
     'id': string;
     /**
      * The carrier name for the offering.
-     * @type {string}
-     * @memberof Carrier
      */
     'name': string;
 }

package/dist/types/api-model/models/channel-details.d.ts

@@ -14,26 +14,9 @@ import type { AmazonShipmentDetails } from './amazon-shipment-details';
 import type { ChannelType } from './channel-type';
 /**
  * Shipment source channel related information.
- * @export
- * @interface ChannelDetails
  */
 export interface ChannelDetails {
-    /**
-     *
-     * @type {ChannelType}
-     * @memberof ChannelDetails
-     */
     'channelType': ChannelType;
-    /**
-     *
-     * @type {AmazonOrderDetails}
-     * @memberof ChannelDetails
-     */
     'amazonOrderDetails'?: AmazonOrderDetails;
-    /**
-     *
-     * @type {AmazonShipmentDetails}
-     * @memberof ChannelDetails
-     */
     'amazonShipmentDetails'?: AmazonShipmentDetails;
 }

package/dist/types/api-model/models/channel-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * The shipment source channel type.
- * @export
- * @enum {string}
  */
 export declare const ChannelType: {
     readonly Amazon: "AMAZON";

package/dist/types/api-model/models/charge-component.d.ts

@@ -12,20 +12,11 @@
 import type { Currency } from './currency';
 /**
  * The type and amount of a charge applied on a package.
- * @export
- * @interface ChargeComponent
  */
 export interface ChargeComponent {
-    /**
-     *
-     * @type {Currency}
-     * @memberof ChargeComponent
-     */
     'amount'?: Currency;
     /**
      * The type of charge.
-     * @type {string}
-     * @memberof ChargeComponent
      */
     'chargeType'?: ChargeComponentChargeTypeEnum;
 }