import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common"; import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios"; //#region src/api-model/configuration.d.ts /** * 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. */ interface AWSv4Configuration { options?: { region?: string; service?: string; }; credentials?: { accessKeyId?: string; secretAccessKey?: string; sessionToken?: string; }; } interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); awsv4?: AWSv4Configuration; basePath?: string; serverIndex?: number; baseOptions?: any; formDataCtor?: new () => any; } declare class Configuration { /** * parameter for apiKey security * @param name security name */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * 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 | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * 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; } //#endregion //#region src/api-model/base.d.ts interface RequestArgs { url: string; options: RawAxiosRequestConfig; } declare class BaseAPI { protected basePath: string; protected axios: AxiosInstance; protected configuration: Configuration | undefined; constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance); } //#endregion //#region src/api-model/models/amazon-pay-context.d.ts /** * 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 Amazon Pay. */ export interface AmazonPayContext { /** * The name of the store that is related to the transaction. */ 'storeName'?: string; /** * The order type of the transaction. */ 'orderType'?: string; /** * The channel of the transaction. For example: `MFN`. */ 'channel'?: string; } //#endregion //#region src/api-model/models/currency.d.ts /** * 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; } //#endregion //#region src/api-model/models/partner-metadata.d.ts /** * 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 PartnerMetadata { /** * The unique seller identifier. */ 'partnerId'?: string; /** * The type of account. */ '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 a marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). */ 'marketplaceId'?: string; } //#endregion //#region src/api-model/models/balance.d.ts /** * All information relevant to a balance. */ export interface Balance { 'partnerMetadata'?: PartnerMetadata; /** * The type of balance. */ 'balanceType'?: BalanceBalanceTypeEnum; 'amount'?: Currency; /** * A list of balances that comprise this balance. */ 'balances'?: Array; /** * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. */ 'asOfDate'?: string; /** * The date and time when the balance was last updated, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The value is in the marketplace\'s local time zone. This field is present for point-in-time balance queries (when no `asOfDate` query parameter is provided). Null for ending balance queries. */ 'lastUpdatedTime'?: string; } export declare const BalanceBalanceTypeEnum: { readonly Available: "AVAILABLE"; readonly Reserved: "RESERVED"; readonly AccountLevelReserve: "ACCOUNT_LEVEL_RESERVE"; readonly Deferred: "DEFERRED"; readonly Total: "TOTAL"; }; export type BalanceBalanceTypeEnum = typeof BalanceBalanceTypeEnum[keyof typeof BalanceBalanceTypeEnum]; //#endregion //#region src/api-model/models/breakdown.d.ts /** * Details about the movement of money in the financial transaction. */ export interface Breakdown { /** * The type of charge. */ 'breakdownType'?: string; 'breakdownAmount'?: Currency; /** * A list of breakdowns that detail how the total amount is calculated for the transaction. */ 'breakdowns'?: Array; } //#endregion //#region src/api-model/models/business-context.d.ts /** * 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]; //#endregion //#region src/api-model/models/context-all-of.d.ts /** * 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 { /** * The type of context. */ 'contextType': string; } //#endregion //#region src/api-model/models/deferred-context.d.ts /** * 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; } //#endregion //#region src/api-model/models/payments-context.d.ts /** * 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; } //#endregion //#region src/api-model/models/product-context.d.ts /** * 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; } //#endregion //#region src/api-model/models/time-range-context.d.ts /** * 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; } //#endregion //#region src/api-model/models/context.d.ts /** * @type Context * Additional information about the item. */ export type Context = AmazonPayContext & BusinessContext & ContextAllOf & DeferredContext & PaymentsContext & ProductContext & TimeRangeContext; //#endregion //#region src/api-model/models/error-list.d.ts /** * 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; } //#endregion //#region src/api-model/models/item-related-identifier.d.ts /** * 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]; //#endregion //#region src/api-model/models/item.d.ts /** * Additional information about an item 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; 'totalAmount'?: Currency; /** * A list of breakdowns that detail how the total amount is calculated for the transaction. */ 'breakdowns'?: Array; /** * A list of additional information about the item. */ 'contexts'?: Array; } //#endregion //#region src/api-model/models/list-balances-response.d.ts /** * The response to the `listBalances` operation. */ export interface ListBalancesResponse { /** * A list of balances. */ 'balances'?: Array; /** * A token to retrieve the next page of results. If null, no more results are available. */ 'nextToken'?: string; } //#endregion //#region src/api-model/models/marketplace-details.d.ts /** * 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 a 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; } //#endregion //#region src/api-model/models/related-identifier.d.ts /** * 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]; //#endregion //#region src/api-model/models/selling-partner-metadata.d.ts /** * 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 { /** * The 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 a marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). */ 'marketplaceId'?: string; } //#endregion //#region src/api-model/models/transaction.d.ts /** * All the information related to a transaction. */ export interface Transaction { 'sellingPartnerMetadata'?: SellingPartnerMetadata; /** * Related business identifiers of the transaction. */ 'relatedIdentifiers'?: Array; /** * 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; /** * A list of additional information about the item. */ 'contexts'?: Array; /** * A list of breakdowns that detail how the total amount is calculated for the transaction. */ 'breakdowns'?: Array; } //#endregion //#region src/api-model/models/transactions-payload.d.ts /** * 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; } //#endregion //#region src/api-model/models/list-transactions-response.d.ts /** * The response to the `listTransactions` operation. */ export interface ListTransactionsResponse { 'payload'?: TransactionsPayload; } //#endregion //#region src/api-model/models/model-error.d.ts /** * 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; } //#endregion //#region src/api-model/models/summary.d.ts /** * Contains all information related to the financial summary. */ export interface Summary { 'partnerMetadata'?: PartnerMetadata; 'netProceeds'?: Currency; /** * Related business identifiers of the transaction. */ 'relatedIdentifiers'?: Array; /** * A list of breakdowns that detail how the total amount is calculated for the transaction. */ 'breakdowns'?: Array; /** * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. */ 'periodStart'?: string; /** * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. */ 'periodEnd'?: string; } //#endregion //#region src/api-model/models/summary-response.d.ts /** * The response to the `listSummary` operation. */ export interface SummaryResponse { /** * A list of financial summaries. */ 'summaries'?: Array; /** * A token to retrieve the next page of results. If null, no more results are available. */ 'nextToken'?: string; } //#endregion //#region src/api-model/api/finances-api.d.ts /** * FinancesApi - axios parameter creator */ export declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve a balance. This balance can be a past balances at a specified date, or a current balance. Sub-balances are listed by account type and marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} [marketplaceIds] The marketplaces from which to retrieve balances. If omitted, balances from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {string} [balanceType] The type of balance to include in the response. If omitted, all balance types may be included in the response. **Possible values:** `AVAILABLE`, `RESERVED`, `TOTAL`, `DEFERRED`, `ACCOUNT_LEVEL_RESERVE` * @param {string} [accountType] The type of account to include in the response. * @param {string} [asOfDate] The date from which you want to retrieve balances. If provided, the response includes historical balances at the specified date. The value must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. If omitted, the point in time balance is provided. * @param {string} [nextToken] A token that you use to retrieve subsequent pages of results. When there are more than 500 results available, the response will include a `nextToken` 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. Repeat this process until the `nextToken` value is null to retrieve all results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBalances: (marketplaceIds?: Array, balanceType?: string, accountType?: string, asOfDate?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve the financial summary for the specified time period or settlement period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} [marketplaceIds] The marketplaces from which to retrieve summaries. If omitted, summaries from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {string} [accountType] The type of account to include in the response. * @param {string} [relatedIdentifierName] The name of the `relatedIdentifier`. The only possible value is `SETTLEMENT_ID`, the settlement ID associated with the summary. * @param {string} [relatedIdentifierValue] The value of the `relatedIdentifier`. * @param {string} [periodStart] The start of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or after the specified date. The value must be formatted in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. * @param {string} [periodEnd] The end of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or before the specified date. The value must be formatted in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. * @param {string} [nextToken] A token that you use to retrieve subsequent pages of results. When there are more results available, the response will include a `nextToken` 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. Repeat this process until the `nextToken` value is null to retrieve all results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSummary: (marketplaceIds?: Array, accountType?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, periodStart?: string, periodEnd?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Note:** If you want to retrieve MFN orders in the US store, do not supply the `marketplaceId` parameter. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @param {string} [postedAfter] The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier. * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request. * @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for a marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {string} [transactionStatus] 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. * @param {string} [relatedIdentifierName] The name of the `relatedIdentifier`. **Possible values:** * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. * `ORDER_ID`: the order ID associated with the transaction. **Note:** `FINANCIAL_EVENT_GROUP_ID` and `ORDER_ID` are the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes. * @param {string} [relatedIdentifierValue] The value of the `relatedIdentifier`. * @param {string} [nextToken] 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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTransactions: (postedAfter?: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * FinancesApi - functional programming interface */ export declare const FinancesApiFp: (configuration?: Configuration) => { /** * Retrieve a balance. This balance can be a past balances at a specified date, or a current balance. Sub-balances are listed by account type and marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} [marketplaceIds] The marketplaces from which to retrieve balances. If omitted, balances from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {string} [balanceType] The type of balance to include in the response. If omitted, all balance types may be included in the response. **Possible values:** `AVAILABLE`, `RESERVED`, `TOTAL`, `DEFERRED`, `ACCOUNT_LEVEL_RESERVE` * @param {string} [accountType] The type of account to include in the response. * @param {string} [asOfDate] The date from which you want to retrieve balances. If provided, the response includes historical balances at the specified date. The value must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. If omitted, the point in time balance is provided. * @param {string} [nextToken] A token that you use to retrieve subsequent pages of results. When there are more than 500 results available, the response will include a `nextToken` 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. Repeat this process until the `nextToken` value is null to retrieve all results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBalances(marketplaceIds?: Array, balanceType?: string, accountType?: string, asOfDate?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the financial summary for the specified time period or settlement period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {Array} [marketplaceIds] The marketplaces from which to retrieve summaries. If omitted, summaries from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {string} [accountType] The type of account to include in the response. * @param {string} [relatedIdentifierName] The name of the `relatedIdentifier`. The only possible value is `SETTLEMENT_ID`, the settlement ID associated with the summary. * @param {string} [relatedIdentifierValue] The value of the `relatedIdentifier`. * @param {string} [periodStart] The start of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or after the specified date. The value must be formatted in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. * @param {string} [periodEnd] The end of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or before the specified date. The value must be formatted in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. * @param {string} [nextToken] A token that you use to retrieve subsequent pages of results. When there are more results available, the response will include a `nextToken` 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. Repeat this process until the `nextToken` value is null to retrieve all results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSummary(marketplaceIds?: Array, accountType?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, periodStart?: string, periodEnd?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Note:** If you want to retrieve MFN orders in the US store, do not supply the `marketplaceId` parameter. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @param {string} [postedAfter] The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier. * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request. * @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for a marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). * @param {string} [transactionStatus] 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. * @param {string} [relatedIdentifierName] The name of the `relatedIdentifier`. **Possible values:** * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. * `ORDER_ID`: the order ID associated with the transaction. **Note:** `FINANCIAL_EVENT_GROUP_ID` and `ORDER_ID` are the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes. * @param {string} [relatedIdentifierValue] The value of the `relatedIdentifier`. * @param {string} [nextToken] 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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTransactions(postedAfter?: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FinancesApi - factory interface */ export declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve a balance. This balance can be a past balances at a specified date, or a current balance. Sub-balances are listed by account type and marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FinancesApiListBalancesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBalances(requestParameters?: FinancesApiListBalancesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve the financial summary for the specified time period or settlement period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FinancesApiListSummaryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSummary(requestParameters?: FinancesApiListSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Note:** If you want to retrieve MFN orders in the US store, do not supply the `marketplaceId` parameter. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @param {FinancesApiListTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTransactions(requestParameters?: FinancesApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for listBalances operation in FinancesApi. */ export interface FinancesApiListBalancesRequest { /** * The marketplaces from which to retrieve balances. If omitted, balances from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). */ readonly marketplaceIds?: Array; /** * The type of balance to include in the response. If omitted, all balance types may be included in the response. **Possible values:** `AVAILABLE`, `RESERVED`, `TOTAL`, `DEFERRED`, `ACCOUNT_LEVEL_RESERVE` */ readonly balanceType?: string; /** * The type of account to include in the response. */ readonly accountType?: string; /** * The date from which you want to retrieve balances. If provided, the response includes historical balances at the specified date. The value must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. If omitted, the point in time balance is provided. */ readonly asOfDate?: string; /** * A token that you use to retrieve subsequent pages of results. When there are more than 500 results available, the response will include a `nextToken` 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. Repeat this process until the `nextToken` value is null to retrieve all results. */ readonly nextToken?: string; } /** * Request parameters for listSummary operation in FinancesApi. */ export interface FinancesApiListSummaryRequest { /** * The marketplaces from which to retrieve summaries. If omitted, summaries from all applicable marketplaces may be returned. To find the marketplace ID for a region, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). */ readonly marketplaceIds?: Array; /** * The type of account to include in the response. */ readonly accountType?: string; /** * The name of the `relatedIdentifier`. The only possible value is `SETTLEMENT_ID`, the settlement ID associated with the summary. */ readonly relatedIdentifierName?: string; /** * The value of the `relatedIdentifier`. */ readonly relatedIdentifierValue?: string; /** * The start of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or after the specified date. The value must be formatted in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. */ readonly periodStart?: string; /** * The end of the period for which to retrieve summaries. When provided, the response will only include summaries with transactions that occurred on or before the specified date. The value must be formatted in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date format. */ readonly periodEnd?: string; /** * A token that you use to retrieve subsequent pages of results. When there are more results available, the response will include a `nextToken` 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. Repeat this process until the `nextToken` value is null to retrieve all results. */ readonly nextToken?: string; } /** * Request parameters for listTransactions operation in FinancesApi. */ export interface FinancesApiListTransactionsRequest { /** * The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier. */ readonly postedAfter?: string; /** * The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request. */ readonly postedBefore?: string; /** * The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for a marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids). */ readonly marketplaceId?: 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. */ readonly transactionStatus?: string; /** * The name of the `relatedIdentifier`. **Possible values:** * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. * `ORDER_ID`: the order ID associated with the transaction. **Note:** `FINANCIAL_EVENT_GROUP_ID` and `ORDER_ID` are the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes. */ readonly relatedIdentifierName?: string; /** * The value of the `relatedIdentifier`. */ readonly relatedIdentifierValue?: 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. */ readonly nextToken?: string; } /** * FinancesApi - object-oriented interface */ export declare class FinancesApi extends BaseAPI { /** * Retrieve a balance. This balance can be a past balances at a specified date, or a current balance. Sub-balances are listed by account type and marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FinancesApiListBalancesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBalances(requestParameters?: FinancesApiListBalancesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve the financial summary for the specified time period or settlement period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that apply to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {FinancesApiListSummaryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSummary(requestParameters?: FinancesApiListSummaryRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Note:** If you want to retrieve MFN orders in the US store, do not supply the `marketplaceId` parameter. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits). * @param {FinancesApiListTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTransactions(requestParameters?: FinancesApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise>; } //#endregion //#region src/client.d.ts export declare const clientRateLimits: RateLimit[]; export declare class FinancesApiClient extends FinancesApi { constructor(configuration: ClientConfiguration); } //#endregion //# sourceMappingURL=index.d.ts.map