@sp-api-sdk/shipping-api-v2 1.1.0

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

@@ -0,0 +1,12 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from './api/shipping-api';

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

@@ -0,0 +1,54 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosInstance, AxiosRequestConfig } 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: AxiosRequestConfig;
+}
+/**
+ *
+ * @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);
+}

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

@@ -0,0 +1,66 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/// <reference types="node" />
+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, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

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

@@ -0,0 +1,83 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+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;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/types/src/api-model/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

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

@@ -0,0 +1,24 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AccessPointDetails
+ */
+export interface AccessPointDetails {
+    /**
+     * Unique identifier for the access point
+     * @type {string}
+     * @memberof AccessPointDetails
+     */
+    'accessPointId'?: string;
+}

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

@@ -0,0 +1,27 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The type of access point, like counter (HELIX), lockers, etc.
+ * @export
+ * @enum {string}
+ */
+export declare const AccessPointType: {
+    readonly Helix: "HELIX";
+    readonly CampusLocker: "CAMPUS_LOCKER";
+    readonly OmniLocker: "OMNI_LOCKER";
+    readonly OdinLocker: "ODIN_LOCKER";
+    readonly DobbyLocker: "DOBBY_LOCKER";
+    readonly CoreLocker: "CORE_LOCKER";
+    readonly _3P: "3P";
+    readonly CampusRoom: "CAMPUS_ROOM";
+};
+export type AccessPointType = typeof AccessPointType[keyof typeof AccessPointType];

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

@@ -0,0 +1,90 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AccessPointType } from './access-point-type';
+import { AccessibilityAttributes } from './accessibility-attributes';
+import { Address } from './address';
+import { ExceptionOperatingHours } from './exception-operating-hours';
+import { 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;
+    /**
+     *
+     * @type {Array<ExceptionOperatingHours>}
+     * @memberof AccessPoint
+     */
+    'exceptionOperatingHours'?: Array<ExceptionOperatingHours>;
+    /**
+     *
+     * @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;
+    };
+}
+export declare const AccessPointAssistanceTypeEnum: {
+    readonly StaffAssisted: "STAFF_ASSISTED";
+    readonly SelfAssisted: "SELF_ASSISTED";
+};
+export type AccessPointAssistanceTypeEnum = typeof AccessPointAssistanceTypeEnum[keyof typeof AccessPointAssistanceTypeEnum];

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

@@ -0,0 +1,30 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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/src/api-model/models/account-status.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Account Status.
+ * @export
+ * @enum {string}
+ */
+export declare const AccountStatus: {
+    readonly Active: "ACTIVE";
+    readonly Inactive: "INACTIVE";
+    readonly Pending: "PENDING";
+    readonly Suspended: "SUSPENDED";
+};
+export type AccountStatus = typeof AccountStatus[keyof typeof AccountStatus];

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

@@ -0,0 +1,22 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Shipper Account Type.
+ * @export
+ * @enum {string}
+ */
+export declare const AccountType: {
+    readonly ShipperAccount: "SHIPPER_ACCOUNT";
+    readonly ShipperAccountWithInvoice: "SHIPPER_ACCOUNT_WITH_INVOICE";
+    readonly AmazonAccount: "AMAZON_ACCOUNT";
+};
+export type AccountType = typeof AccountType[keyof typeof AccountType];

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

@@ -0,0 +1,30 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Active Account Details
+ * @export
+ * @interface ActiveAccount
+ */
+export interface ActiveAccount {
+    /**
+     * Account Id associated with this 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/src/api-model/models/address.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { 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/src/api-model/models/amazon-order-details.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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/src/api-model/models/amazon-shipment-details.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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/src/api-model/models/available-value-added-service-group.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Amazon Shipping API
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
+ *
+ * The version of the OpenAPI document: v2
+ * Contact: swa-api-core@amazon.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { 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>;
+}