@sp-api-sdk/invoices-api-2024-06-19 2.1.3 → 3.0.0

package/dist/es/api-model/models/invoices-attributes.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

package/dist/es/api-model/models/invoices-document.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

package/dist/es/api-model/models/model-error.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

package/dist/es/api-model/models/transaction-identifier.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

package/dist/es/client.js

@@ -1,80 +0,0 @@
-import { createAxiosInstance } from '@sp-api-sdk/common';
-import { Configuration, InvoicesApi } from './api-model';
-export const clientRateLimits = [
-    {
-        method: 'get',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/attributes$'),
-        rate: 1,
-        burst: 1,
-    },
-    {
-        method: 'get',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/documents/[^/]*$'),
-        rate: 0.0167,
-        burst: 1,
-    },
-    {
-        method: 'post',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/exports$'),
-        rate: 0.167,
-        burst: 1,
-    },
-    {
-        method: 'get',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/exports$'),
-        rate: 0.1,
-        burst: 20,
-    },
-    {
-        method: 'get',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/exports/[^/]*$'),
-        rate: 2,
-        burst: 15,
-    },
-    {
-        method: 'post',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/governmentInvoiceRequests$'),
-        rate: 0.0167,
-        burst: 1,
-    },
-    {
-        method: 'get',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/governmentInvoiceRequests$'),
-        rate: 0.0167,
-        burst: 1,
-    },
-    {
-        method: 'get',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/governmentInvoiceRequests/[^/]*$'),
-        rate: 0.0167,
-        burst: 1,
-    },
-    {
-        method: 'get',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/invoices$'),
-        rate: 0.1,
-        burst: 20,
-    },
-    {
-        method: 'get',
-        // eslint-disable-next-line prefer-regex-literals
-        urlRegex: new RegExp('^/tax/invoices/2024-06-19/invoices/[^/]*$'),
-        rate: 2,
-        burst: 15,
-    },
-];
-export class InvoicesApiClient extends InvoicesApi {
-    constructor(configuration) {
-        const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
-        super(new Configuration(), endpoint, axios);
-    }
-}

package/dist/es/index.js

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

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

@@ -1,12 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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/invoices-api';

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

@@ -1,42 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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, RawAxiosRequestConfig } from 'axios';
-export declare const BASE_PATH: string;
-export declare const COLLECTION_FORMATS: {
-    csv: string;
-    ssv: string;
-    tsv: string;
-    pipes: string;
-};
-export interface RequestArgs {
-    url: string;
-    options: RawAxiosRequestConfig;
-}
-export declare class BaseAPI {
-    protected basePath: string;
-    protected axios: AxiosInstance;
-    protected configuration: Configuration | undefined;
-    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
-}
-export declare class RequiredError extends Error {
-    field: string;
-    constructor(field: string, msg?: string);
-}
-interface ServerMap {
-    [key: string]: {
-        url: string;
-        description: string;
-    }[];
-}
-export declare const operationServerMap: ServerMap;
-export {};

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

@@ -1,34 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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 { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from 'axios';
-export declare const DUMMY_BASE_URL = "https://example.com";
-/**
- *
- * @throws {RequiredError}
- */
-export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
- */
-export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
-export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-export declare const toPathString: (url: URL) => string;
-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

@@ -1,98 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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 Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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/attribute-option.d.ts

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * The definition of the attribute option.
- */
-export interface AttributeOption {
-    /**
-     * The description of the attribute value.
-     */
-    'description'?: string;
-    /**
-     * The possible values for the attribute option.
-     */
-    'value'?: string;
-}

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

@@ -1,48 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Additional information about a carrier.
- */
-export interface CarrierDetailsContext {
-    /**
-     * The name of the carrier, as registered in state and federal tax authorities.
-     */
-    'name'?: string;
-    /**
-     * The address of the carrier, as registered in state and federal tax authorities.
-     */
-    'address'?: string;
-    /**
-     * Type of additional information.
-     */
-    'contextType'?: string;
-    /**
-     * Tax Identification number of the carrier.
-     */
-    'federalTaxId'?: string;
-    /**
-     * The code of the federal subdivision in which the carrier is registered.
-     */
-    'regionCode'?: string;
-    /**
-     * The regional tax registration number of the carrier.
-     */
-    'regionTaxId'?: string;
-    /**
-     * The identifier for the carrier vehicle as printed in its registration plate.
-     */
-    'vehicleLicensePlate'?: string;
-    /**
-     * The code of the federal subdivision in which the carrier vehicle is registered.
-     */
-    'vehicleRegistrationRegionCode'?: string;
-}

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

@@ -1,20 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * A list of error responses that are returned when a request is unsuccessful.
- */
-export interface ErrorList {
-    /**
-     * List of errors.
-     */
-    'errors': Array<Error>;
-}

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

@@ -1,52 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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 { FileFormat } from './file-format';
-import type { TransactionIdentifier } from './transaction-identifier';
-/**
- * The information required to create the export request.
- */
-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.
-     */
-    '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.
-     */
-    'dateStart'?: string;
-    /**
-     * The external ID of the invoices you want included in the response.
-     */
-    'externalInvoiceId'?: string;
-    'fileFormat'?: FileFormat;
-    /**
-     * The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
-     */
-    'invoiceType'?: string;
-    /**
-     * The ID of the marketplace from which you want the invoices.
-     */
-    'marketplaceId': string;
-    /**
-     * The series number of the invoices you want included in the response.
-     */
-    '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
-     */
-    'statuses'?: Array<string>;
-    'transactionIdentifier'?: TransactionIdentifier;
-    /**
-     * The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options
-     */
-    'transactionType'?: string;
-}

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

@@ -1,20 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Success.
- */
-export interface ExportInvoicesResponse {
-    /**
-     * The export identifier.
-     */
-    'exportId'?: string;
-}

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

@@ -1,21 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * The current status of the request.
- */
-export declare const ExportStatus: {
-    readonly Requested: "REQUESTED";
-    readonly Processing: "PROCESSING";
-    readonly Done: "DONE";
-    readonly Error: "ERROR";
-};
-export type ExportStatus = typeof ExportStatus[keyof typeof ExportStatus];

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

@@ -1,38 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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 { ExportStatus } from './export-status';
-/**
- * Detailed information about the export.
- */
-export interface Export {
-    /**
-     * When the export generation fails, this attribute contains a description of the error.
-     */
-    'errorMessage'?: string;
-    /**
-     * The export identifier.
-     */
-    '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.
-     */
-    '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.
-     */
-    '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`.
-     */
-    'invoicesDocumentIds'?: Array<string>;
-    'status'?: ExportStatus;
-}

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

@@ -1,18 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Supported invoice file extensions.
- */
-export declare const FileFormat: {
-    readonly Xml: "XML";
-};
-export type FileFormat = typeof FileFormat[keyof typeof FileFormat];

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

@@ -1,18 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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 { Invoice } from './invoice';
-/**
- * Success.
- */
-export interface GetInvoiceResponse {
-    'invoice'?: Invoice;
-}

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

@@ -1,18 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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 { InvoicesAttributes } from './invoices-attributes';
-/**
- * Success.
- */
-export interface GetInvoicesAttributesResponse {
-    'invoicesAttributes'?: InvoicesAttributes;
-}

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

@@ -1,18 +0,0 @@
-/**
- * The Selling Partner API for Invoices.
- * Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
- *
- * The version of the OpenAPI document: 2024-06-19
- *
- *
- * 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 { InvoicesDocument } from './invoices-document';
-/**
- * Success.
- */
-export interface GetInvoicesDocumentResponse {
-    'invoicesDocument'?: InvoicesDocument;
-}