@sp-api-sdk/fulfillment-inbound-api-2024-03-20 1.0.1

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

@@ -0,0 +1,12 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * 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/fba-inbound-api';

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

@@ -0,0 +1,54 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * 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 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * 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 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * 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 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * 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/address.d.ts

@@ -0,0 +1,66 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Specific details to identify a place.
+ * @export
+ * @interface Address
+ */
+export interface Address {
+    /**
+     * Street address information.
+     * @type {string}
+     * @memberof Address
+     */
+    'addressLine1': string;
+    /**
+     * Additional street address information.
+     * @type {string}
+     * @memberof Address
+     */
+    'addressLine2'?: string;
+    /**
+     * The city.
+     * @type {string}
+     * @memberof Address
+     */
+    'city': string;
+    /**
+     * The name of the business.
+     * @type {string}
+     * @memberof Address
+     */
+    'companyName'?: string;
+    /**
+     * The country code in two-character ISO 3166-1 alpha-2 format.
+     * @type {string}
+     * @memberof Address
+     */
+    'countryCode': string;
+    /**
+     * The name of the individual or business.
+     * @type {string}
+     * @memberof Address
+     */
+    'name': string;
+    /**
+     * The postal code.
+     * @type {string}
+     * @memberof Address
+     */
+    'postalCode': string;
+    /**
+     * The state or province code.
+     * @type {string}
+     * @memberof Address
+     */
+    'stateOrProvinceCode'?: string;
+}

package/dist/types/src/api-model/models/appointment-slot-time.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * An appointment slot time with a start and end.
+ * @export
+ * @interface AppointmentSlotTime
+ */
+export interface AppointmentSlotTime {
+    /**
+     * The end timestamp of the appointment in UTC.
+     * @type {string}
+     * @memberof AppointmentSlotTime
+     */
+    'endTime': string;
+    /**
+     * The start timestamp of the appointment in UTC.
+     * @type {string}
+     * @memberof AppointmentSlotTime
+     */
+    'startTime': string;
+}

package/dist/types/src/api-model/models/appointment-slot.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AppointmentSlotTime } from './appointment-slot-time';
+/**
+ * The fulfillment center appointment slot for the transportation option.
+ * @export
+ * @interface AppointmentSlot
+ */
+export interface AppointmentSlot {
+    /**
+     * An identifier to a self-ship appointment slot.
+     * @type {string}
+     * @memberof AppointmentSlot
+     */
+    'slotId': string;
+    /**
+     *
+     * @type {AppointmentSlotTime}
+     * @memberof AppointmentSlot
+     */
+    'slotTime': AppointmentSlotTime;
+}

package/dist/types/src/api-model/models/box-content-information-source.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Indication of how box content is meant to be provided.
+ * @export
+ * @enum {string}
+ */
+export declare const BoxContentInformationSource: {
+    readonly BoxContentProvided: "BOX_CONTENT_PROVIDED";
+    readonly ManualProcess: "MANUAL_PROCESS";
+    readonly Barcode2D: "BARCODE_2D";
+};
+export type BoxContentInformationSource = typeof BoxContentInformationSource[keyof typeof BoxContentInformationSource];

package/dist/types/src/api-model/models/box-content.d.ts

@@ -0,0 +1,56 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { LabelOwner } from './label-owner';
+import { PrepOwner } from './prep-owner';
+/**
+ * Specifies contents in a box. Each `BoxContent` minimally contains a mapping of an MSKU to the prep owner, label owner and its quantity in the box. It also contains the MSKU expiration date and manufacturing lot code if applicable.
+ * @export
+ * @interface BoxContent
+ */
+export interface BoxContent {
+    /**
+     * The date in ISO 8601 format for when the MSKU expires.
+     * @type {string}
+     * @memberof BoxContent
+     */
+    'expiration'?: string;
+    /**
+     *
+     * @type {LabelOwner}
+     * @memberof BoxContent
+     */
+    'labelOwner': LabelOwner;
+    /**
+     * The manufacturing lot code.
+     * @type {string}
+     * @memberof BoxContent
+     */
+    'manufacturingLotCode'?: string;
+    /**
+     * The merchant SKU, a merchant-supplied identifier for a specific SKU.
+     * @type {string}
+     * @memberof BoxContent
+     */
+    'msku': string;
+    /**
+     *
+     * @type {PrepOwner}
+     * @memberof BoxContent
+     */
+    'prepOwner': PrepOwner;
+    /**
+     * The number of units of the given MSKU in the box.
+     * @type {number}
+     * @memberof BoxContent
+     */
+    'quantityInBox': number;
+}

package/dist/types/src/api-model/models/box-input.d.ts

@@ -0,0 +1,64 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { BoxContent } from './box-content';
+import { BoxContentInformationSource } from './box-content-information-source';
+import { Dimensions } from './dimensions';
+import { Weight } from './weight';
+/**
+ * Input information for a given box.
+ * @export
+ * @interface BoxInput
+ */
+export interface BoxInput {
+    /**
+     * The ID of the box to update that was provided by Amazon. This ID is comprised of the external shipment ID         (which is generated after transportation has been confirmed) and the index of the box.
+     * @type {string}
+     * @memberof BoxInput
+     */
+    'boxId'?: string;
+    /**
+     *
+     * @type {BoxContentInformationSource}
+     * @memberof BoxInput
+     */
+    'contentInformationSource': BoxContentInformationSource;
+    /**
+     * The Contents of the box containing a list of MSKUs and their quantity. If `boxAttribute` is `BARCODE_2D` or `MANUAL_PROCESS`, user should provide ALL of the items that could be in the box, without specifying item quantities.
+     * @type {Array<BoxContent>}
+     * @memberof BoxInput
+     */
+    'contents'?: Array<BoxContent>;
+    /**
+     *
+     * @type {Dimensions}
+     * @memberof BoxInput
+     */
+    'dimensions': Dimensions;
+    /**
+     * The number of containers where all other properties like weight or dimensions are identical.
+     * @type {number}
+     * @memberof BoxInput
+     */
+    'quantity': number;
+    /**
+     * The seller-provided name for a \'type\' of box (or a group of boxes with the same contents), which will be used to identify all created boxes of that type. When providing bulk box information, this value must be unique from the other box types. When providing individual boxes with existing IDs, this value can be shared between many boxes that have the same contents.
+     * @type {string}
+     * @memberof BoxInput
+     */
+    'templateName': string;
+    /**
+     *
+     * @type {Weight}
+     * @memberof BoxInput
+     */
+    'weight': Weight;
+}

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

@@ -0,0 +1,70 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Dimensions } from './dimensions';
+import { Item } from './item';
+import { Region } from './region';
+import { Weight } from './weight';
+/**
+ * Contains information about a box that is used in the inbound plan. The box may contain an item and metadata about the box itself.
+ * @export
+ * @interface Box
+ */
+export interface Box {
+    /**
+     * The ID provided by Amazon that identifies a given box. This ID is comprised of the external shipment ID (which         is generated after transportation has been confirmed) and the index of the box.
+     * @type {string}
+     * @memberof Box
+     */
+    'boxId'?: string;
+    /**
+     *
+     * @type {Region}
+     * @memberof Box
+     */
+    'destinationRegion'?: Region;
+    /**
+     *
+     * @type {Dimensions}
+     * @memberof Box
+     */
+    'dimensions'?: Dimensions;
+    /**
+     * Items contained within the box.
+     * @type {Array<Item>}
+     * @memberof Box
+     */
+    'items'?: Array<Item>;
+    /**
+     * Primary key to uniquely identify a Package (Box or Pallet).
+     * @type {string}
+     * @memberof Box
+     */
+    'packageId': string;
+    /**
+     * The number of containers where all other properties like weight or dimensions are identical.
+     * @type {number}
+     * @memberof Box
+     */
+    'quantity'?: number;
+    /**
+     * Template name of the box.
+     * @type {string}
+     * @memberof Box
+     */
+    'templateName'?: string;
+    /**
+     *
+     * @type {Weight}
+     * @memberof Box
+     */
+    'weight'?: Weight;
+}

package/dist/types/src/api-model/models/cancel-inbound-plan-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The `cancelInboundPlan` response.
+ * @export
+ * @interface CancelInboundPlanResponse
+ */
+export interface CancelInboundPlanResponse {
+    /**
+     * UUID for the given operation.
+     * @type {string}
+     * @memberof CancelInboundPlanResponse
+     */
+    'operationId': string;
+}

package/dist/types/src/api-model/models/cancel-self-ship-appointment-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ReasonComment } from './reason-comment';
+/**
+ * The `cancelSelfShipAppointment` request.
+ * @export
+ * @interface CancelSelfShipAppointmentRequest
+ */
+export interface CancelSelfShipAppointmentRequest {
+    /**
+     *
+     * @type {ReasonComment}
+     * @memberof CancelSelfShipAppointmentRequest
+     */
+    'reasonComment'?: ReasonComment;
+}

package/dist/types/src/api-model/models/cancel-self-ship-appointment-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The `cancelSelfShipAppointment` response.
+ * @export
+ * @interface CancelSelfShipAppointmentResponse
+ */
+export interface CancelSelfShipAppointmentResponse {
+    /**
+     * UUID for the given operation.
+     * @type {string}
+     * @memberof CancelSelfShipAppointmentResponse
+     */
+    'operationId': string;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * The Selling Partner API for FBA inbound operations.
+ * The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
+ *
+ * The version of the OpenAPI document: 2024-03-20
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The carrier for the inbound shipment.
+ * @export
+ * @interface Carrier
+ */
+export interface Carrier {
+    /**
+     * The carrier code. For example, USPS or DHLEX.
+     * @type {string}
+     * @memberof Carrier
+     */
+    'alphaCode'?: string;
+    /**
+     * The name of the carrier.
+     * @type {string}
+     * @memberof Carrier
+     */
+    'name'?: string;
+}