@sp-api-sdk/finances-api-2024-06-19 1.1.0

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

@@ -0,0 +1,52 @@
+/**
+ * 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
+ */
+export interface Item {
+    /**
+     * A description of the items in a transaction.
+     * @type {string}
+     * @memberof Item
+     */
+    'description'?: string;
+    /**
+     * Related business identifiers of the item in the transaction.
+     * @type {Array<ItemRelatedIdentifier>}
+     * @memberof Item
+     */
+    'relatedIdentifiers'?: Array<ItemRelatedIdentifier>;
+    /**
+     *
+     * @type {Currency}
+     * @memberof Item
+     */
+    'totalAmount'?: Currency;
+    /**
+     * A list of breakdowns that provide details on how the total amount is calculated for the transaction.
+     * @type {Array<Breakdown>}
+     * @memberof Item
+     */
+    'breakdowns'?: Array<Breakdown>;
+    /**
+     * A list of additional information about the item.
+     * @type {Array<Context>}
+     * @memberof Item
+     */
+    'contexts'?: Array<Context>;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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 response schema for the `listTransactions` operation.
+ * @export
+ * @interface ListTransactionsResponse
+ */
+export interface ListTransactionsResponse {
+    /**
+     * The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
+     * @type {string}
+     * @memberof ListTransactionsResponse
+     */
+    'nextToken'?: string;
+    /**
+     * A list of transactions within the specified time period.
+     * @type {Array<Transaction>}
+     * @memberof ListTransactionsResponse
+     */
+    'transactions'?: Array<Transaction>;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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
+ */
+export interface MarketplaceDetails {
+    /**
+     * The identifier of the marketplace where the transaction occured.
+     * @type {string}
+     * @memberof MarketplaceDetails
+     */
+    'marketplaceId'?: string;
+    /**
+     * The name of the marketplace where the transaction occurred. For example: `Amazon.com`,`Amazon.in`
+     * @type {string}
+     * @memberof MarketplaceDetails
+     */
+    'marketplaceName'?: string;
+}

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

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

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

@@ -0,0 +1,42 @@
+/**
+ * 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
+ */
+export interface PaymentsContext {
+    /**
+     * The type of payment.
+     * @type {string}
+     * @memberof PaymentsContext
+     */
+    'paymentType'?: string;
+    /**
+     * The method of payment.
+     * @type {string}
+     * @memberof PaymentsContext
+     */
+    'paymentMethod'?: string;
+    /**
+     * The reference number of the payment.
+     * @type {string}
+     * @memberof PaymentsContext
+     */
+    'paymentReference'?: string;
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @type {string}
+     * @memberof PaymentsContext
+     */
+    'paymentDate'?: string;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * 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
+ */
+export interface ProductContext {
+    /**
+     * The Amazon Standard Identification Number (ASIN) of the item.
+     * @type {string}
+     * @memberof ProductContext
+     */
+    'asin'?: string;
+    /**
+     * The Stock Keeping Unit (SKU) of the item.
+     * @type {string}
+     * @memberof ProductContext
+     */
+    'sku'?: string;
+    /**
+     * The quantity of the item shipped.
+     * @type {number}
+     * @memberof ProductContext
+     */
+    'quantityShipped'?: number;
+    /**
+     * The fulfillment network of the item.
+     * @type {string}
+     * @memberof ProductContext
+     */
+    'fulfillmentNetwork'?: string;
+}

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

@@ -0,0 +1,41 @@
+/**
+ * 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
+ */
+export interface RelatedIdentifier {
+    /**
+     * An enumerated set of related business identifier names.
+     * @type {string}
+     * @memberof RelatedIdentifier
+     */
+    'relatedIdentifierName'?: RelatedIdentifierRelatedIdentifierNameEnum;
+    /**
+     * Corresponding value of `RelatedIdentifierName`.
+     * @type {string}
+     * @memberof RelatedIdentifier
+     */
+    'relatedIdentifierValue'?: string;
+}
+export declare const RelatedIdentifierRelatedIdentifierNameEnum: {
+    readonly OrderId: "ORDER_ID";
+    readonly ShipmentId: "SHIPMENT_ID";
+    readonly EventGroupId: "EVENT_GROUP_ID";
+    readonly RefundId: "REFUND_ID";
+    readonly InvoiceId: "INVOICE_ID";
+    readonly DisbursementId: "DISBURSEMENT_ID";
+    readonly TransferId: "TRANSFER_ID";
+    readonly DeferredTransactionId: "DEFERRED_TRANSACTION_ID";
+};
+export type RelatedIdentifierRelatedIdentifierNameEnum = typeof RelatedIdentifierRelatedIdentifierNameEnum[keyof typeof RelatedIdentifierRelatedIdentifierNameEnum];

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

@@ -0,0 +1,36 @@
+/**
+ * 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
+ */
+export interface SellingPartnerMetadata {
+    /**
+     * A unique seller identifier.
+     * @type {string}
+     * @memberof SellingPartnerMetadata
+     */
+    'sellingPartnerId'?: string;
+    /**
+     * The type of account in the transaction.
+     * @type {string}
+     * @memberof SellingPartnerMetadata
+     */
+    'accountType'?: string;
+    /**
+     * The identifier of the marketplace where the transaction occurred.
+     * @type {string}
+     * @memberof SellingPartnerMetadata
+     */
+    'marketplaceId'?: string;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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
+ */
+export interface TimeRangeContext {
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @type {string}
+     * @memberof TimeRangeContext
+     */
+    'startTime'?: string;
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @type {string}
+     * @memberof TimeRangeContext
+     */
+    'endTime'?: string;
+}

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

@@ -0,0 +1,97 @@
+/**
+ * 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
+ */
+export interface Transaction {
+    /**
+     *
+     * @type {SellingPartnerMetadata}
+     * @memberof Transaction
+     */
+    'sellingPartnerMetadata'?: SellingPartnerMetadata;
+    /**
+     * Related business identifiers of the transaction.
+     * @type {Array<RelatedIdentifier>}
+     * @memberof Transaction
+     */
+    'relatedIdentifiers'?: Array<RelatedIdentifier>;
+    /**
+     * The type of transaction.  **Possible value:** `Shipment`
+     * @type {string}
+     * @memberof Transaction
+     */
+    'transactionType'?: string;
+    /**
+     * The unique identifier of the transaction.
+     * @type {string}
+     * @memberof Transaction
+     */
+    'transactionId'?: string;
+    /**
+     * The status of the transaction.   **Possible values:**  * `Deferred` * `Released`
+     * @type {string}
+     * @memberof Transaction
+     */
+    'transactionStatus'?: string;
+    /**
+     * Describes the reasons for the transaction.  **Example:** \'Order Payment\', \'Refund Order\'
+     * @type {string}
+     * @memberof Transaction
+     */
+    'description'?: string;
+    /**
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
+     * @type {string}
+     * @memberof Transaction
+     */
+    'postedDate'?: string;
+    /**
+     *
+     * @type {Currency}
+     * @memberof Transaction
+     */
+    'totalAmount'?: Currency;
+    /**
+     *
+     * @type {MarketplaceDetails}
+     * @memberof Transaction
+     */
+    'marketplaceDetails'?: MarketplaceDetails;
+    /**
+     * A list of items in the transaction.
+     * @type {Array<Item>}
+     * @memberof Transaction
+     */
+    'items'?: Array<Item>;
+    /**
+     * A list of additional information about the item.
+     * @type {Array<Context>}
+     * @memberof Transaction
+     */
+    'contexts'?: Array<Context>;
+    /**
+     * A list of breakdowns that provide details on how the total amount is calculated for the transaction.
+     * @type {Array<Breakdown>}
+     * @memberof Transaction
+     */
+    'breakdowns'?: Array<Breakdown>;
+}

package/dist/types/src/client.d.ts

@@ -0,0 +1,6 @@
+import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
+import { DefaultApi } from './api-model';
+export declare const clientRateLimits: RateLimit[];
+export declare class FinancesApiClient extends DefaultApi {
+    constructor(configuration: ClientConfiguration);
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@sp-api-sdk/finances-api-2024-06-19",
+  "author": "Bertrand Marron <bertrand@bizon.solutions>",
+  "description": "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.",
+  "version": "1.1.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/types/index.d.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "dist"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "dependencies": {
+    "@sp-api-sdk/common": "2.0.14",
+    "axios": "^1.7.7"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bizon/selling-partner-api-sdk.git",
+    "directory": "clients/finances-api-2024-06-19"
+  },
+  "bugs": {
+    "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
+  },
+  "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/finances-api-2024-06-19",
+  "keywords": [
+    "amazon",
+    "bizon",
+    "marketplace web services",
+    "mws",
+    "selling partner api",
+    "sp api",
+    "sp sdk",
+    "finances api"
+  ],
+  "gitHead": "92609cb0381b1cd32bb0e0f75e1dc4d5acaabe11"
+}