@sp-api-sdk/finances-api-2024-06-19 3.3.3 → 4.0.0

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

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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.
- */
-/**
- * Information about the line of business associated with a transaction.
- */
-export interface BusinessContext {
-    /**
-     * The store name associated with the transaction.
-     */
-    'storeName'?: BusinessContextStoreNameEnum;
-}
-export declare const BusinessContextStoreNameEnum: {
-    readonly AmazonHaul: "AMAZON_HAUL";
-};
-export type BusinessContextStoreNameEnum = typeof BusinessContextStoreNameEnum[keyof typeof BusinessContextStoreNameEnum];

package/dist/types/api-model/models/context-all-of.d.ts

@@ -1,14 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 interface ContextAllOf {
-    'contextType': string;
-}

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

@@ -1,23 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 { AmazonPayContext } from './amazon-pay-context';
-import type { BusinessContext } from './business-context';
-import type { ContextAllOf } from './context-all-of';
-import type { DeferredContext } from './deferred-context';
-import type { PaymentsContext } from './payments-context';
-import type { ProductContext } from './product-context';
-import type { TimeRangeContext } from './time-range-context';
-/**
- * @type Context
- * Additional Information about the item.
- */
-export type Context = AmazonPayContext & BusinessContext & ContextAllOf & DeferredContext & PaymentsContext & ProductContext & TimeRangeContext;

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

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 currency type and amount.
- */
-export interface Currency {
-    /**
-     * The three-digit currency code in ISO 4217 format.
-     */
-    'currencyCode'?: string;
-    /**
-     * A signed decimal number.
-     */
-    'currencyAmount'?: number;
-}

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

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 related to deferred transactions.
- */
-export interface DeferredContext {
-    /**
-     * The deferral policy applied to the transaction.  **Examples:** `B2B` (invoiced orders), `DD7` (delivery date policy)
-     */
-    'deferralReason'?: string;
-    /**
-     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
-     */
-    'maturityDate'?: string;
-}

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

@@ -1,20 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 returned when a request is unsuccessful.
- */
-export interface ErrorList {
-    /**
-     * The error responses that are returned when the request is unsuccessful.
-     */
-    'errors': Array<Error>;
-}

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

@@ -1,20 +0,0 @@
-export * from './amazon-pay-context';
-export * from './breakdown';
-export * from './business-context';
-export * from './context';
-export * from './context-all-of';
-export * from './currency';
-export * from './deferred-context';
-export * from './error-list';
-export * from './item';
-export * from './item-related-identifier';
-export * from './list-transactions-response';
-export * from './marketplace-details';
-export * from './model-error';
-export * from './payments-context';
-export * from './product-context';
-export * from './related-identifier';
-export * from './selling-partner-metadata';
-export * from './time-range-context';
-export * from './transaction';
-export * from './transactions-payload';

package/dist/types/api-model/models/item-related-identifier.d.ts

@@ -1,31 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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.
- */
-/**
- * Related business identifiers of the item.
- */
-export interface ItemRelatedIdentifier {
-    /**
-     * Enumerated set of related item identifier names for the item.
-     */
-    'itemRelatedIdentifierName'?: ItemRelatedIdentifierItemRelatedIdentifierNameEnum;
-    /**
-     * Corresponding value to `ItemRelatedIdentifierName`.
-     */
-    'itemRelatedIdentifierValue'?: string;
-}
-export declare const ItemRelatedIdentifierItemRelatedIdentifierNameEnum: {
-    readonly OrderAdjustmentItemId: "ORDER_ADJUSTMENT_ITEM_ID";
-    readonly CouponId: "COUPON_ID";
-    readonly RemovalShipmentItemId: "REMOVAL_SHIPMENT_ITEM_ID";
-    readonly TransactionId: "TRANSACTION_ID";
-};
-export type ItemRelatedIdentifierItemRelatedIdentifierNameEnum = typeof ItemRelatedIdentifierItemRelatedIdentifierNameEnum[keyof typeof ItemRelatedIdentifierItemRelatedIdentifierNameEnum];

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

@@ -1,37 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 { Breakdown } from './breakdown';
-import type { Context } from './context';
-import type { Currency } from './currency';
-import type { ItemRelatedIdentifier } from './item-related-identifier';
-/**
- * Additional information about the items in a transaction.
- */
-export interface Item {
-    /**
-     * A description of the items in a transaction.
-     */
-    'description'?: string;
-    /**
-     * Related business identifiers of the item in the transaction.
-     */
-    'relatedIdentifiers'?: Array<ItemRelatedIdentifier>;
-    'totalAmount'?: Currency;
-    /**
-     * A list of breakdowns that detail how the total amount is calculated for the transaction.
-     */
-    'breakdowns'?: Array<Breakdown>;
-    /**
-     * A list of additional information about the item.
-     */
-    'contexts'?: Array<Context>;
-}

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

@@ -1,18 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 { TransactionsPayload } from './transactions-payload';
-/**
- * The response schema for the `listTransactions` operation.
- */
-export interface ListTransactionsResponse {
-    'payload'?: TransactionsPayload;
-}

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

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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.
- */
-/**
- * Information about the marketplace where the transaction occurred.
- */
-export interface MarketplaceDetails {
-    /**
-     * The identifier of the marketplace where the transaction occurred. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
-     */
-    'marketplaceId'?: string;
-    /**
-     * The name of the marketplace where the transaction occurred. For example: `Amazon.com`,`Amazon.in`
-     */
-    'marketplaceName'?: string;
-}

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

@@ -1,28 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 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/payments-context.d.ts

@@ -1,32 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 related to payments-related transactions.
- */
-export interface PaymentsContext {
-    /**
-     * The type of payment.
-     */
-    'paymentType'?: string;
-    /**
-     * The method of payment.
-     */
-    'paymentMethod'?: string;
-    /**
-     * The reference number of the payment.
-     */
-    'paymentReference'?: string;
-    /**
-     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
-     */
-    'paymentDate'?: string;
-}

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

@@ -1,32 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 related to the product.
- */
-export interface ProductContext {
-    /**
-     * The Amazon Standard Identification Number (ASIN) of the item.
-     */
-    'asin'?: string;
-    /**
-     * The Stock Keeping Unit (SKU) of the item.
-     */
-    'sku'?: string;
-    /**
-     * The quantity of the item shipped.
-     */
-    'quantityShipped'?: number;
-    /**
-     * The fulfillment network of the item.
-     */
-    'fulfillmentNetwork'?: string;
-}

package/dist/types/api-model/models/related-identifier.d.ts

@@ -1,37 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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.
- */
-/**
- * Related business identifier of the transaction.
- */
-export interface RelatedIdentifier {
-    /**
-     * An enumerated set of related business identifier names.
-     */
-    'relatedIdentifierName'?: RelatedIdentifierRelatedIdentifierNameEnum;
-    /**
-     * Corresponding value of `RelatedIdentifierName`.
-     */
-    'relatedIdentifierValue'?: string;
-}
-export declare const RelatedIdentifierRelatedIdentifierNameEnum: {
-    readonly OrderId: "ORDER_ID";
-    readonly ShipmentId: "SHIPMENT_ID";
-    readonly FinancialEventGroupId: "FINANCIAL_EVENT_GROUP_ID";
-    readonly RefundId: "REFUND_ID";
-    readonly InvoiceId: "INVOICE_ID";
-    readonly DisbursementId: "DISBURSEMENT_ID";
-    readonly TransferId: "TRANSFER_ID";
-    readonly DeferredTransactionId: "DEFERRED_TRANSACTION_ID";
-    readonly ReleaseTransactionId: "RELEASE_TRANSACTION_ID";
-    readonly SettlementId: "SETTLEMENT_ID";
-};
-export type RelatedIdentifierRelatedIdentifierNameEnum = typeof RelatedIdentifierRelatedIdentifierNameEnum[keyof typeof RelatedIdentifierRelatedIdentifierNameEnum];

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

@@ -1,28 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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.
- */
-/**
- * Metadata that describes the seller.
- */
-export interface SellingPartnerMetadata {
-    /**
-     * A unique seller identifier.
-     */
-    'sellingPartnerId'?: string;
-    /**
-     * The type of account in the transaction.
-     */
-    'accountType'?: string;
-    /**
-     * The identifier of the marketplace where the transaction occurred. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
-     */
-    'marketplaceId'?: string;
-}

package/dist/types/api-model/models/time-range-context.d.ts

@@ -1,24 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 that is related to the time range of the transaction.
- */
-export interface TimeRangeContext {
-    /**
-     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
-     */
-    'startTime'?: string;
-    /**
-     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
-     */
-    'endTime'?: string;
-}

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

@@ -1,62 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 { Breakdown } from './breakdown';
-import type { Context } from './context';
-import type { Currency } from './currency';
-import type { Item } from './item';
-import type { MarketplaceDetails } from './marketplace-details';
-import type { RelatedIdentifier } from './related-identifier';
-import type { SellingPartnerMetadata } from './selling-partner-metadata';
-/**
- * All the information related to a transaction.
- */
-export interface Transaction {
-    'sellingPartnerMetadata'?: SellingPartnerMetadata;
-    /**
-     * Related business identifiers of the transaction.
-     */
-    'relatedIdentifiers'?: Array<RelatedIdentifier>;
-    /**
-     * The type of transaction.  **Possible value:** `Shipment`
-     */
-    'transactionType'?: string;
-    /**
-     * The unique identifier of the transaction.
-     */
-    'transactionId'?: string;
-    /**
-     * The status of the transaction.  **Possible values:**  * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
-     */
-    'transactionStatus'?: string;
-    /**
-     * Describes the reasons for the transaction.  **Example:** \'Order Payment\', \'Refund Order\'
-     */
-    'description'?: string;
-    /**
-     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
-     */
-    'postedDate'?: string;
-    'totalAmount'?: Currency;
-    'marketplaceDetails'?: MarketplaceDetails;
-    /**
-     * A list of items in the transaction.
-     */
-    'items'?: Array<Item>;
-    /**
-     * A list of additional information about the item.
-     */
-    'contexts'?: Array<Context>;
-    /**
-     * A list of breakdowns that detail how the total amount is calculated for the transaction.
-     */
-    'breakdowns'?: Array<Breakdown>;
-}

package/dist/types/api-model/models/transactions-payload.d.ts

@@ -1,25 +0,0 @@
-/**
- * The Selling Partner API for Finances
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
- *
- * 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 { Transaction } from './transaction';
-/**
- * The payload for the `listTransactions` operation.
- */
-export interface TransactionsPayload {
-    /**
-     * 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.
-     */
-    'nextToken'?: string;
-    /**
-     * A list of transactions within the specified time period.
-     */
-    'transactions'?: Array<Transaction>;
-}

package/dist/types/client.d.ts

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