@sp-api-sdk/external-fulfillment-returns-api-2024-09-11 1.1.12 → 2.0.0

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

@@ -1,98 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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.
- */
-interface AWSv4Configuration {
-    options?: {
-        region?: string;
-        service?: string;
-    };
-    credentials?: {
-        accessKeyId?: string;
-        secretAccessKey?: string;
-        sessionToken?: string;
-    };
-}
-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>);
-    awsv4?: AWSv4Configuration;
-    basePath?: string;
-    serverIndex?: number;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-export declare class Configuration {
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     */
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    /**
-     * parameter for basic security
-     */
-    username?: string;
-    /**
-     * parameter for basic security
-     */
-    password?: string;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * parameter for aws4 signature security
-     * @param {Object} AWS4Signature - AWS4 Signature security
-     * @param {string} options.region - aws region
-     * @param {string} options.service - name of the service.
-     * @param {string} credentials.accessKeyId - aws access key id
-     * @param {string} credentials.secretAccessKey - aws access key
-     * @param {string} credentials.sessionToken - aws session token
-     * @memberof Configuration
-     */
-    awsv4?: AWSv4Configuration;
-    /**
-     * override base path
-     */
-    basePath?: string;
-    /**
-     * override server index
-     */
-    serverIndex?: number;
-    /**
-     * base options for axios calls
-     */
-    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;
-}
-export {};

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

@@ -1,14 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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/api-model/models/error-list.d.ts

@@ -1,20 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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.
- */
-/**
- * An object containing a list of error responses returned when a request is unsuccessful.
- */
-export interface ErrorList {
-    /**
-     * A list of error responses returned when a request is unsuccessful.
-     */
-    'errors': Array<Error>;
-}

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

@@ -1,12 +0,0 @@
-export * from './error-list';
-export * from './invoice-information';
-export * from './marketplace-channel';
-export * from './marketplace-channel-details';
-export * from './model-error';
-export * from './otp-details';
-export * from './replanning-details';
-export * from './return';
-export * from './return-metadata';
-export * from './return-shipping-info';
-export * from './returns-response';
-export * from './tracking-info';

package/dist/types/api-model/models/invoice-information.d.ts

@@ -1,20 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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.
- */
-/**
- * Invoice-related information for the return created for Amazon SmartConnect.
- */
-export interface InvoiceInformation {
-    /**
-     * The unique ID of the invoice that corresponds to the return.
-     */
-    'id': string;
-}

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

@@ -1,42 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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 { MarketplaceChannel } from './marketplace-channel';
-/**
- * Marketplace channel-specific attributes for the return. These attributes are not mandatory and each channel can provide them differently.
- */
-export interface MarketplaceChannelDetails {
-    'marketplaceChannel'?: MarketplaceChannel;
-    /**
-     * The ID of the merchant or seller to whom this return is created in the marketplace.
-     */
-    'merchantId'?: string;
-    /**
-     * The marketplace-specific shipment ID.
-     */
-    'shipmentId'?: string;
-    /**
-     * The marketplace-specific customer order ID.
-     */
-    'customerOrderId'?: string;
-    /**
-     * The Amazon SmartConnect ID of the location to which this return is created.
-     */
-    'returnLocationId'?: string;
-    /**
-     * The Amazon SmartConnect SKU of the channel.
-     */
-    'channelSku'?: string;
-    /**
-     * The Amazon SmartConnect ID of the exchange order.
-     */
-    'exchangeOrderId'?: string;
-}

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

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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 marketplace and channel name.
- */
-export interface MarketplaceChannel {
-    /**
-     * The name of the marketplace.
-     */
-    'marketplaceName'?: string;
-    /**
-     * The name of the channel within the marketplace.
-     */
-    'channelName'?: string;
-}

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

@@ -1,28 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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.
- */
-/**
- * Error response returned when the request is unsuccessful.
- */
-export interface ModelError {
-    /**
-     * An error code that identifies the type of error that occurred.
-     */
-    'code': string;
-    /**
-     * A message that describes the error condition.
-     */
-    'message': string;
-    /**
-     * Additional details that can help the caller understand or fix the issue.
-     */
-    'details'?: string;
-}

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

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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.
- */
-/**
- * One-time password (OTP) details of the return item.
- */
-export interface OtpDetails {
-    /**
-     * One-time password to validate the return delivered to the seller.
-     */
-    'otp': string;
-    /**
-     * The UNIX timestamp of when the verification code expires.
-     */
-    'validTill': number;
-}

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

@@ -1,21 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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 { TrackingInfo } from './tracking-info';
-/**
- * Provides details about the replanned returns.
- */
-export interface ReplanningDetails {
-    /**
-     * A list of all the previous tracking information for the return.
-     */
-    'previousTrackingInfo'?: Array<TrackingInfo>;
-}

package/dist/types/api-model/models/return-metadata.d.ts

@@ -1,30 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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 { InvoiceInformation } from './invoice-information';
-/**
- * Metadata about the return item.
- */
-export interface ReturnMetadata {
-    /**
-     * The reason for the return.
-     */
-    'returnReason': string;
-    /**
-     * The RMA ID of the return.
-     */
-    'rmaId'?: string;
-    /**
-     * The SmartConnect ID of the fulfillment order for which the return was placed.
-     */
-    'fulfillmentOrderId'?: string;
-    'invoiceInformation'?: InvoiceInformation;
-}

package/dist/types/api-model/models/return-shipping-info.d.ts

@@ -1,27 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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 { TrackingInfo } from './tracking-info';
-/**
- * Information about the shipping of the return packages.
- */
-export interface ReturnShippingInfo {
-    /**
-     * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-     */
-    'deliveryDateTime'?: string;
-    /**
-     * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-     */
-    'pickupDateTime'?: string;
-    'forwardTrackingInfo'?: TrackingInfo;
-    'reverseTrackingInfo'?: TrackingInfo;
-}

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

@@ -1,104 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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 { MarketplaceChannelDetails } from './marketplace-channel-details';
-import type { OtpDetails } from './otp-details';
-import type { ReplanningDetails } from './replanning-details';
-import type { ReturnMetadata } from './return-metadata';
-import type { ReturnShippingInfo } from './return-shipping-info';
-/**
- * Information about the return item.
- */
-export interface Return {
-    /**
-     * The return item\'s ID.
-     */
-    'id': string;
-    /**
-     * The SmartConnect identifier for where the return item was dropped for delivery.
-     */
-    'returnLocationId'?: string;
-    /**
-     * The seller\'s identifier for the SKU.
-     */
-    'merchantSku'?: string;
-    /**
-     * The type of return.
-     */
-    'returnType': ReturnReturnTypeEnum;
-    /**
-     * The sub-type of return.
-     */
-    'returnSubType'?: ReturnReturnSubTypeEnum;
-    /**
-     * The total number of units in the return.
-     */
-    'numberOfUnits'?: number;
-    /**
-     * The current status of the return.
-     */
-    'status': ReturnStatusEnum;
-    /**
-     * The ID of the location that fulfilled the order.
-     */
-    'fulfillmentLocationId': string;
-    /**
-     * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-     */
-    'creationDateTime'?: string;
-    /**
-     * A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
-     */
-    'lastUpdatedDateTime': string;
-    'returnMetadata': ReturnMetadata;
-    'returnShippingInfo': ReturnShippingInfo;
-    'marketplaceChannelDetails': MarketplaceChannelDetails;
-    'otpDetails'?: OtpDetails;
-    /**
-     * The package delivery mode. This indicates whether the return was delivered to the seller with or without a one-time password (OTP).
-     */
-    'packageDeliveryMode'?: ReturnPackageDeliveryModeEnum;
-    'replanningDetails'?: ReplanningDetails;
-}
-export declare const ReturnReturnTypeEnum: {
-    readonly Customer: "CUSTOMER";
-    readonly Reject: "REJECT";
-};
-export type ReturnReturnTypeEnum = typeof ReturnReturnTypeEnum[keyof typeof ReturnReturnTypeEnum];
-export declare const ReturnReturnSubTypeEnum: {
-    readonly Normal: "NORMAL";
-    readonly Replacement: "REPLACEMENT";
-    readonly Exchange: "EXCHANGE";
-};
-export type ReturnReturnSubTypeEnum = typeof ReturnReturnSubTypeEnum[keyof typeof ReturnReturnSubTypeEnum];
-export declare const ReturnStatusEnum: {
-    readonly Created: "CREATED";
-    readonly CarrierNotifiedToPickUpFromCustomer: "CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER";
-    readonly CarrierOutForPickUpFromCustomer: "CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER";
-    readonly CustomerCancelledPickUp: "CUSTOMER_CANCELLED_PICK_UP";
-    readonly CustomerRescheduledPickUp: "CUSTOMER_RESCHEDULED_PICK_UP";
-    readonly PickedFromCustomer: "PICKED_FROM_CUSTOMER";
-    readonly InTransit: "IN_TRANSIT";
-    readonly OutForDelivery: "OUT_FOR_DELIVERY";
-    readonly Delivered: "DELIVERED";
-    readonly Replanned: "REPLANNED";
-    readonly CustomerDroppedOff: "CUSTOMER_DROPPED_OFF";
-    readonly PartiallyProcessed: "PARTIALLY_PROCESSED";
-    readonly Processed: "PROCESSED";
-    readonly Rejected: "REJECTED";
-    readonly Cancelled: "CANCELLED";
-};
-export type ReturnStatusEnum = typeof ReturnStatusEnum[keyof typeof ReturnStatusEnum];
-export declare const ReturnPackageDeliveryModeEnum: {
-    readonly WithOtp: "WITH_OTP";
-    readonly WithoutOtp: "WITHOUT_OTP";
-};
-export type ReturnPackageDeliveryModeEnum = typeof ReturnPackageDeliveryModeEnum[keyof typeof ReturnPackageDeliveryModeEnum];

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

@@ -1,25 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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 { Return } from './return';
-/**
- * The response to the `listReturns` operation.
- */
-export interface ReturnsResponse {
-    /**
-     * A list of returns.
-     */
-    'returns'?: Array<Return>;
-    /**
-     * A token that you use to retrieve the next page of results. The response includes `nextToken` when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
-     */
-    'nextToken'?: string;
-}

package/dist/types/api-model/models/tracking-info.d.ts

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Amazon External Fulfillment Return Item Processing
- * You can use the Amazon External Fulfillment Return Item Processing API to retrieve, track, and process return items through Amazon\'s External Fulfillment returns management system.
- *
- * The version of the OpenAPI document: 2024-09-11
- * Contact: marketplaceapitest@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.
- */
-/**
- * Information for tracking a return.
- */
-export interface TrackingInfo {
-    /**
-     * The name of the third party courier service used to ship the return package.
-     */
-    'carrierName': string;
-    /**
-     * The tracking ID of the return package.
-     */
-    'trackingId': string;
-}

package/dist/types/client.d.ts

@@ -1,6 +0,0 @@
-import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
-import { ExternalFulfillmentReturnsApi } from './api-model';
-export declare const clientRateLimits: RateLimit[];
-export declare class ExternalFulfillmentReturnsApiClient extends ExternalFulfillmentReturnsApi {
-    constructor(configuration: ClientConfiguration);
-}

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './client';
-export * from './api-model/api';
-export * from './api-model/models';