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

package/dist/types/api-model/models/get-invoices-export-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 { Export } from './export';
-/**
- * Success.
- */
-export interface GetInvoicesExportResponse {
-    'export'?: Export;
-}

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

@@ -1,25 +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 { Export } from './export';
-/**
- * Success.
- */
-export interface GetInvoicesExportsResponse {
-    /**
-     * A list of exports.
-     */
-    'exports'?: Array<Export>;
-    /**
-     * This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters.
-     */
-    'nextToken'?: string;
-}

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

@@ -1,25 +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 GetInvoicesResponse {
-    /**
-     * A list of invoices.
-     */
-    'invoices'?: Array<Invoice>;
-    /**
-     * This token is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getInvoices` operation and include this token with the previous call parameters.
-     */
-    'nextToken'?: string;
-}

package/dist/types/api-model/models/government-invoice-creation-status.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.
- */
-/**
- * The current status of a government invoice creation request.
- */
-export declare const GovernmentInvoiceCreationStatus: {
-    readonly Processing: "PROCESSING";
-    readonly Success: "SUCCESS";
-    readonly Error: "ERROR";
-};
-export type GovernmentInvoiceCreationStatus = typeof GovernmentInvoiceCreationStatus[keyof typeof GovernmentInvoiceCreationStatus];

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

@@ -1,41 +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 { CarrierDetailsContext } from './carrier-details-context';
-/**
- * Information required to create the government invoice.
- */
-export interface GovernmentInvoiceRequest {
-    /**
-     * Object that contains additional invoice creation information
-     */
-    'contexts'?: Array<CarrierDetailsContext>;
-    /**
-     * The unique InboundPlan identifier in which the shipment is contained and for which the invoice will be created.
-     */
-    'inboundPlanId'?: string;
-    /**
-     * Marketplace specific classification of the invoice type. Check \'invoiceType\' options using \'getInvoicesAttributes\' operation.
-     */
-    'invoiceType': string;
-    /**
-     * The government invoices creation request will match the national authoritative source of the given marketplace.
-     */
-    'marketplaceId': string;
-    /**
-     * The unique shipment identifier to get an invoice for.
-     */
-    'shipmentId': string;
-    /**
-     * Marketplace specific classification of the transaction type that originated the invoice. Check \'transactionType\' options using \'getInvoicesAttributes\' operation.
-     */
-    'transactionType': string;
-}

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

@@ -1,27 +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 { GovernmentInvoiceCreationStatus } from './government-invoice-creation-status';
-import type { InvoiceError } from './invoice-error';
-/**
- * Success.
- */
-export interface GovernmentInvoiceStatusResponse {
-    /**
-     * The errors that occurred during invoice creation.
-     */
-    'invoiceErrors'?: Array<InvoiceError>;
-    /**
-     * Government Invoice ID of a successfully authorized invoice.
-     */
-    'invoiceExternalDocumentId'?: string;
-    'status'?: GovernmentInvoiceCreationStatus;
-}

package/dist/types/api-model/models/govt-invoice-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 { InvoiceDocument } from './invoice-document';
-/**
- * Success.
- */
-export interface GovtInvoiceDocumentResponse {
-    'invoiceDocument'?: InvoiceDocument;
-}

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

@@ -1,25 +0,0 @@
-export * from './attribute-option';
-export * from './carrier-details-context';
-export * from './error-list';
-export * from './export';
-export * from './export-invoices-request';
-export * from './export-invoices-response';
-export * from './export-status';
-export * from './file-format';
-export * from './get-invoice-response';
-export * from './get-invoices-attributes-response';
-export * from './get-invoices-document-response';
-export * from './get-invoices-export-response';
-export * from './get-invoices-exports-response';
-export * from './get-invoices-response';
-export * from './government-invoice-creation-status';
-export * from './government-invoice-request';
-export * from './government-invoice-status-response';
-export * from './govt-invoice-document-response';
-export * from './invoice';
-export * from './invoice-document';
-export * from './invoice-error';
-export * from './invoices-attributes';
-export * from './invoices-document';
-export * from './model-error';
-export * from './transaction-identifier';

package/dist/types/api-model/models/invoice-document.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.
- */
-/**
- * Object containing the documentId and a S3 pre-signed URL to download the specified document file.
- */
-export interface InvoiceDocument {
-    /**
-     * A pre-signed URL to download the invoice document in its original format. This URL expires after 30 seconds.
-     */
-    'invoiceDocumentUrl'?: string;
-}

package/dist/types/api-model/models/invoice-error.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.
- */
-/**
- * An invoice creation error occurrence.
- */
-export interface InvoiceError {
-    /**
-     * A text description of the error.
-     */
-    'description'?: string;
-    /**
-     * The code of the error.
-     */
-    'errorCode'?: string;
-}

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

@@ -1,57 +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 { TransactionIdentifier } from './transaction-identifier';
-/**
- * Provides detailed information about an invoice.
- */
-export interface Invoice {
-    /**
-     * The date and time the invoice is issued. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
-     */
-    'date'?: string;
-    /**
-     * If the invoice is in an error state, this attribute displays the error code.
-     */
-    'errorCode'?: string;
-    /**
-     * The invoice identifier that is used by an external party. This is typically the government agency that authorized the invoice.
-     */
-    'externalInvoiceId'?: string;
-    /**
-     * The response message from the government authority when there is an error during invoice issuance.
-     */
-    'govResponse'?: string;
-    /**
-     * The invoice identifier.
-     */
-    'id'?: string;
-    /**
-     * The classification of the invoice type. This varies across marketplaces. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
-     */
-    'invoiceType'?: string;
-    /**
-     * Use this identifier in conjunction with `externalInvoiceId` to identify invoices from the same seller.
-     */
-    'series'?: string;
-    /**
-     * The invoice status classification. Use the `getInvoicesAttributes` operation to check invoice status options.
-     */
-    'status'?: string;
-    /**
-     * List with identifiers for the transactions associated to the invoice.
-     */
-    'transactionIds'?: Array<TransactionIdentifier>;
-    /**
-     * Classification of the transaction that originated this invoice. Use the `getInvoicesAttributes` operation to check `transactionType` options.
-     */
-    'transactionType'?: string;
-}

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

@@ -1,33 +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 { AttributeOption } from './attribute-option';
-/**
- * An object that contains the invoice attributes definition.
- */
-export interface InvoicesAttributes {
-    /**
-     * A list of all the options that are available for the invoice status attribute.
-     */
-    'invoiceStatusOptions'?: Array<AttributeOption>;
-    /**
-     * A list of all the options that are available for the invoice type attribute.
-     */
-    'invoiceTypeOptions'?: Array<AttributeOption>;
-    /**
-     * A list of all the options that are available for the transaction identifier name attribute.
-     */
-    'transactionIdentifierNameOptions'?: Array<AttributeOption>;
-    /**
-     * A list of all the options that are available for the transaction type attribute.
-     */
-    'transactionTypeOptions'?: Array<AttributeOption>;
-}

package/dist/types/api-model/models/invoices-document.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.
- */
-/**
- * An object that contains the `documentId` and an S3 pre-signed URL that you can use to download the specified file.
- */
-export interface InvoicesDocument {
-    /**
-     * The identifier of the export document.
-     */
-    'invoicesDocumentId'?: string;
-    /**
-     * A pre-signed URL that you can use to download the invoices document in zip format. This URL expires after 30 seconds.
-     */
-    'invoicesDocumentUrl'?: string;
-}

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

@@ -1,28 +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 error response that is returned when the request is unsuccessful.
- */
-export interface ModelError {
-    /**
-     * An error code that identifies the type of error that occurred.
-     */
-    'code': string;
-    /**
-     * Additional details that can help the caller understand or fix the issue.
-     */
-    'details'?: string;
-    /**
-     * A message that describes the error condition.
-     */
-    'message': string;
-}

package/dist/types/api-model/models/transaction-identifier.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 identifier for a transaction.
- */
-export interface TransactionIdentifier {
-    /**
-     * The transaction identifier name. Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.
-     */
-    'name'?: string;
-    /**
-     * The transaction identifier.
-     */
-    'id'?: string;
-}

package/dist/types/client.d.ts

@@ -1,6 +0,0 @@
-import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
-import { InvoicesApi } from './api-model';
-export declare const clientRateLimits: RateLimit[];
-export declare class InvoicesApiClient extends InvoicesApi {
-    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';