@sp-api-sdk/invoices-api-2024-06-19 2.0.5 → 2.0.7

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

@@ -23,7 +23,6 @@ import type { GetInvoicesExportsResponse } from '../models';
 import type { GetInvoicesResponse } from '../models';
 /**
  * InvoicesApi - axios parameter creator
- * @export
  */
 export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -97,7 +96,6 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
 };
 /**
  * InvoicesApi - functional programming interface
- * @export
  */
 export declare const InvoicesApiFp: (configuration?: Configuration) => {
     /**
@@ -171,7 +169,6 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
 };
 /**
  * InvoicesApi - factory interface
- * @export
  */
 export declare const InvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -226,214 +223,145 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
 };
 /**
  * Request parameters for createInvoicesExport operation in InvoicesApi.
- * @export
- * @interface InvoicesApiCreateInvoicesExportRequest
  */
 export interface InvoicesApiCreateInvoicesExportRequest {
     /**
      * Information required to create the export request.
-     * @type {ExportInvoicesRequest}
-     * @memberof InvoicesApiCreateInvoicesExport
      */
     readonly body: ExportInvoicesRequest;
 }
 /**
  * Request parameters for getInvoice operation in InvoicesApi.
- * @export
- * @interface InvoicesApiGetInvoiceRequest
  */
 export interface InvoicesApiGetInvoiceRequest {
     /**
      * The marketplace from which you want the invoice.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoice
      */
     readonly marketplaceId: string;
     /**
      * The invoice identifier.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoice
      */
     readonly invoiceId: string;
 }
 /**
  * Request parameters for getInvoices operation in InvoicesApi.
- * @export
- * @interface InvoicesApiGetInvoicesRequest
  */
 export interface InvoicesApiGetInvoicesRequest {
     /**
      * The response includes only the invoices that match the specified marketplace.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly marketplaceId: string;
     /**
      * The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly transactionIdentifierName?: string;
     /**
      * The maximum number of invoices you want to return in a single call.  Minimum: 1  Maximum: 200
-     * @type {number}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly pageSize?: number;
     /**
      * The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly dateEnd?: string;
     /**
      * The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly transactionType?: string;
     /**
      * The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly transactionIdentifierId?: string;
     /**
      * The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly dateStart?: string;
     /**
      * Return invoices with the specified series number.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly series?: string;
     /**
      * The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. 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.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly nextToken?: string;
     /**
      * Sort the invoices in the response in ascending or descending order.
-     * @type {'DESC' | 'ASC'}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly sortOrder?: GetInvoicesSortOrderEnum;
     /**
      * The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly invoiceType?: string;
     /**
      * A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options.  Min count: 1
-     * @type {Array<string>}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly statuses?: Array<string>;
     /**
      * Return invoices that match this external ID. This is typically the Government Invoice ID.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly externalInvoiceId?: string;
     /**
      * The attribute by which you want to sort the invoices in the response.
-     * @type {'START_DATE_TIME'}
-     * @memberof InvoicesApiGetInvoices
      */
     readonly sortBy?: GetInvoicesSortByEnum;
 }
 /**
  * Request parameters for getInvoicesAttributes operation in InvoicesApi.
- * @export
- * @interface InvoicesApiGetInvoicesAttributesRequest
  */
 export interface InvoicesApiGetInvoicesAttributesRequest {
     /**
      * The marketplace identifier.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoicesAttributes
      */
     readonly marketplaceId: string;
 }
 /**
  * Request parameters for getInvoicesDocument operation in InvoicesApi.
- * @export
- * @interface InvoicesApiGetInvoicesDocumentRequest
  */
 export interface InvoicesApiGetInvoicesDocumentRequest {
     /**
      * The export document identifier.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoicesDocument
      */
     readonly invoicesDocumentId: string;
 }
 /**
  * Request parameters for getInvoicesExport operation in InvoicesApi.
- * @export
- * @interface InvoicesApiGetInvoicesExportRequest
  */
 export interface InvoicesApiGetInvoicesExportRequest {
     /**
      * The unique identifier for the export.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoicesExport
      */
     readonly exportId: string;
 }
 /**
  * Request parameters for getInvoicesExports operation in InvoicesApi.
- * @export
- * @interface InvoicesApiGetInvoicesExportsRequest
  */
 export interface InvoicesApiGetInvoicesExportsRequest {
     /**
      * The returned exports match the specified marketplace.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoicesExports
      */
     readonly marketplaceId: string;
     /**
      * The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoicesExports
      */
     readonly dateStart?: string;
     /**
      * The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. 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 &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoicesExports
      */
     readonly nextToken?: string;
     /**
      * The maximum number of invoices to return in a single call.  Minimum: 1  Maximum: 100
-     * @type {number}
-     * @memberof InvoicesApiGetInvoicesExports
      */
     readonly pageSize?: number;
     /**
      * The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request.
-     * @type {string}
-     * @memberof InvoicesApiGetInvoicesExports
      */
     readonly dateEnd?: string;
     /**
      * Return exports matching the status specified.
-     * @type {'REQUESTED' | 'PROCESSING' | 'DONE' | 'ERROR'}
-     * @memberof InvoicesApiGetInvoicesExports
      */
     readonly status?: GetInvoicesExportsStatusEnum;
 }
 /**
  * InvoicesApi - object-oriented interface
- * @export
- * @class InvoicesApi
- * @extends {BaseAPI}
  */
 export declare class InvoicesApi extends BaseAPI {
     /**
@@ -441,7 +369,6 @@ export declare class InvoicesApi extends BaseAPI {
      * @param {InvoicesApiCreateInvoicesExportRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InvoicesApi
      */
     createInvoicesExport(requestParameters: InvoicesApiCreateInvoicesExportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ExportInvoicesResponse, any>>;
     /**
@@ -449,7 +376,6 @@ export declare class InvoicesApi extends BaseAPI {
      * @param {InvoicesApiGetInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InvoicesApi
      */
     getInvoice(requestParameters: InvoicesApiGetInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoiceResponse, any>>;
     /**
@@ -457,7 +383,6 @@ export declare class InvoicesApi extends BaseAPI {
      * @param {InvoicesApiGetInvoicesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InvoicesApi
      */
     getInvoices(requestParameters: InvoicesApiGetInvoicesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesResponse, any>>;
     /**
@@ -465,7 +390,6 @@ export declare class InvoicesApi extends BaseAPI {
      * @param {InvoicesApiGetInvoicesAttributesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InvoicesApi
      */
     getInvoicesAttributes(requestParameters: InvoicesApiGetInvoicesAttributesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesAttributesResponse, any>>;
     /**
@@ -473,7 +397,6 @@ export declare class InvoicesApi extends BaseAPI {
      * @param {InvoicesApiGetInvoicesDocumentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InvoicesApi
      */
     getInvoicesDocument(requestParameters: InvoicesApiGetInvoicesDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesDocumentResponse, any>>;
     /**
@@ -481,7 +404,6 @@ export declare class InvoicesApi extends BaseAPI {
      * @param {InvoicesApiGetInvoicesExportRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InvoicesApi
      */
     getInvoicesExport(requestParameters: InvoicesApiGetInvoicesExportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesExportResponse, any>>;
     /**
@@ -489,28 +411,18 @@ export declare class InvoicesApi extends BaseAPI {
      * @param {InvoicesApiGetInvoicesExportsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof InvoicesApi
      */
     getInvoicesExports(requestParameters: InvoicesApiGetInvoicesExportsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesExportsResponse, any>>;
 }
-/**
- * @export
- */
 export declare const GetInvoicesSortOrderEnum: {
     readonly Desc: "DESC";
     readonly Asc: "ASC";
 };
 export type GetInvoicesSortOrderEnum = typeof GetInvoicesSortOrderEnum[keyof typeof GetInvoicesSortOrderEnum];
-/**
- * @export
- */
 export declare const GetInvoicesSortByEnum: {
     readonly StartDateTime: "START_DATE_TIME";
 };
 export type GetInvoicesSortByEnum = typeof GetInvoicesSortByEnum[keyof typeof GetInvoicesSortByEnum];
-/**
- * @export
- */
 export declare const GetInvoicesExportsStatusEnum: {
     readonly Requested: "REQUESTED";
     readonly Processing: "PROCESSING";

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/attribute-option.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * The definition of the attribute option.
- * @export
- * @interface AttributeOption
  */
 export interface AttributeOption {
     /**
      * The description of the attribute value.
-     * @type {string}
-     * @memberof AttributeOption
      */
     'description'?: string;
     /**
      * The possible values for the attribute option.
-     * @type {string}
-     * @memberof AttributeOption
      */
     'value'?: string;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * A list of error responses that are returned when a request is unsuccessful.
- * @export
- * @interface ErrorList
  */
 export interface ErrorList {
     /**
      * List of errors.
-     * @type {Array<Error>}
-     * @memberof ErrorList
      */
     'errors': Array<Error>;
 }

package/dist/types/api-model/models/export-invoices-request.d.ts

@@ -13,68 +13,40 @@ import type { FileFormat } from './file-format';
 import type { TransactionIdentifier } from './transaction-identifier';
 /**
  * The information required to create the export request.
- * @export
- * @interface ExportInvoicesRequest
  */
 export interface ExportInvoicesRequest {
     /**
      * The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the time of the request.
-     * @type {string}
-     * @memberof ExportInvoicesRequest
      */
     'dateEnd'?: string;
     /**
      * The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.
-     * @type {string}
-     * @memberof ExportInvoicesRequest
      */
     'dateStart'?: string;
     /**
      * The external ID of the invoices you want included in the response.
-     * @type {string}
-     * @memberof ExportInvoicesRequest
      */
     'externalInvoiceId'?: string;
-    /**
-     *
-     * @type {FileFormat}
-     * @memberof ExportInvoicesRequest
-     */
     'fileFormat'?: FileFormat;
     /**
      * The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
-     * @type {string}
-     * @memberof ExportInvoicesRequest
      */
     'invoiceType'?: string;
     /**
      * The ID of the marketplace from which you want the invoices.
-     * @type {string}
-     * @memberof ExportInvoicesRequest
      */
     'marketplaceId': string;
     /**
      * The series number of the invoices you want included in the response.
-     * @type {string}
-     * @memberof ExportInvoicesRequest
      */
     'series'?: string;
     /**
      * A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options.  Min count: 1
-     * @type {Array<string>}
-     * @memberof ExportInvoicesRequest
      */
     'statuses'?: Array<string>;
-    /**
-     *
-     * @type {TransactionIdentifier}
-     * @memberof ExportInvoicesRequest
-     */
     'transactionIdentifier'?: TransactionIdentifier;
     /**
      * The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options
-     * @type {string}
-     * @memberof ExportInvoicesRequest
      */
     'transactionType'?: string;
 }

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

@@ -11,14 +11,10 @@
  */
 /**
  * Success.
- * @export
- * @interface ExportInvoicesResponse
  */
 export interface ExportInvoicesResponse {
     /**
      * The export identifier.
-     * @type {string}
-     * @memberof ExportInvoicesResponse
      */
     'exportId'?: string;
 }

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

@@ -11,8 +11,6 @@
  */
 /**
  * The current status of the request.
- * @export
- * @enum {string}
  */
 export declare const ExportStatus: {
     readonly Requested: "REQUESTED";

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

@@ -12,44 +12,27 @@
 import type { ExportStatus } from './export-status';
 /**
  * Detailed information about the export.
- * @export
- * @interface Export
  */
 export interface Export {
     /**
      * When the export generation fails, this attribute contains a description of the error.
-     * @type {string}
-     * @memberof Export
      */
     'errorMessage'?: string;
     /**
      * The export identifier.
-     * @type {string}
-     * @memberof Export
      */
     'exportId'?: string;
     /**
      * The date and time when the export generation finished. Vales are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
-     * @type {string}
-     * @memberof Export
      */
     'generateExportFinishedAt'?: string;
     /**
      * The date and time when the export generation started. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
-     * @type {string}
-     * @memberof Export
      */
     'generateExportStartedAt'?: string;
     /**
      * The identifier for the export documents. To get the information required to retrieve the export document\'s contents, pass each ID in the `getInvoicesDocument` operation.  This list is empty until the status is `DONE`.
-     * @type {Array<string>}
-     * @memberof Export
      */
     'invoicesDocumentIds'?: Array<string>;
-    /**
-     *
-     * @type {ExportStatus}
-     * @memberof Export
-     */
     'status'?: ExportStatus;
 }

package/dist/types/api-model/models/file-format.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Supported invoice file extensions.
- * @export
- * @enum {string}
  */
 export declare const FileFormat: {
     readonly Xml: "XML";

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

@@ -12,14 +12,7 @@
 import type { Invoice } from './invoice';
 /**
  * Success.
- * @export
- * @interface GetInvoiceResponse
  */
 export interface GetInvoiceResponse {
-    /**
-     *
-     * @type {Invoice}
-     * @memberof GetInvoiceResponse
-     */
     'invoice'?: Invoice;
 }