@sp-api-sdk/finances-api-v0 1.7.4 → 1.7.8

package/README.md

@@ -2,6 +2,15 @@
 
 The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
 
+[![npm version](https://badgen.net/npm/v/@sp-api-sdk/finances-api-v0)](https://www.npmjs.com/package/@sp-api-sdk/finances-api-v0)
+[![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)
+
+## Documentation
+
+Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/finances-api/financesV0.md).
+
+Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_finances_api_v0.html) for this API client.
+
 ## Installing
 
 ```sh
@@ -19,26 +28,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
 import {FinancesApiClient} from '@sp-api-sdk/finances-api-v0'
 
 const auth = new SellingPartnerApiAuth({
-  clientId: '',
-  clientSecret: '',
-  refreshToken: '',
-  secretAccessKey: '',
+  clientId: process.env.LWA_CLIENT_ID,
+  clientSecret: process.env.LWA_CLIENT_SECRET,
+  refreshToken: 'Atzr|…',
   accessKeyId: '',
-  region: '',
+  secretAccessKey: '',
   role: {
-    arn: '',
-  }
+    arn: 'arn:aws:iam::…',
+  },
 })
 
 const client = new FinancesApiClient({
   auth,
-  region: 'eu' // or 'eu-west-1'
+  region: 'eu',
 })
 ```
 
-## Handle Rate Limiting
+## Rate Limiting
 
-If you want to let the SDK retry after each 429 responses, instanciate the client like this:
+In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
 
 ```javascript
 const client = new FinancesApiClient({
@@ -46,13 +54,28 @@ const client = new FinancesApiClient({
   region: 'eu',
   rateLimiting: {
     retry: true,
-    onRetry: (retryInfo) => console.log(retryInfo) // Optional
-  }
+    // Optionally specify a callback that will be called on every retry.
+    onRetry: (retryInfo) => {
+      console.log(retryInfo)
+    },
+  },
 })
 ```
 
-The SDK gets the rate limits for each routes from the API documentation
+The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/finances-api/financesV0.md)).
+
+## License
+
+MIT
 
-## API documentation
+## Miscellaneous
 
-See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/finances-api/financesV0.md)
+```
+    ╚⊙ ⊙╝
+  ╚═(███)═╝
+ ╚═(███)═╝
+╚═(███)═╝
+ ╚═(███)═╝
+  ╚═(███)═╝
+   ╚═(███)═╝
+```

package/dist/cjs/src/client.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FinancesApiClient = exports.RATE_LIMITS = void 0;
+exports.FinancesApiClient = exports.clientRateLimits = void 0;
 /* eslint-disable prefer-regex-literals */
 const common_1 = require("@sp-api-sdk/common");
 const api_model_1 = require("./api-model");
 const error_1 = require("./error");
-exports.RATE_LIMITS = [
+exports.clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/finances/v0/financialEventGroups$'),
@@ -33,20 +33,23 @@ exports.RATE_LIMITS = [
 ];
 class FinancesApiClient extends api_model_1.DefaultApi {
     constructor(parameters) {
-        const region = common_1.awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = common_1.sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new error_1.FinancesApiError(`Unknown region: ${parameters.region}`);
+        }
         const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = { ...clientParameters, region };
+        const axiosParameters = {
+            ...clientParameters,
+            region: config.awsRegion,
+        };
         if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = exports.RATE_LIMITS;
+            axiosParameters.rateLimits = exports.clientRateLimits;
             axiosParameters.onRetry = rateLimiting.onRetry;
         }
         const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
         const configuration = new api_model_1.Configuration();
         const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = common_1.endpoints[environment][region];
-        if (!endpoint) {
-            throw new error_1.FinancesApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

package/dist/es/src/client.js

@@ -1,8 +1,8 @@
 /* eslint-disable prefer-regex-literals */
-import { endpoints, awsRegionByCode, createAxiosInstance } from '@sp-api-sdk/common';
+import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
 import { Configuration, DefaultApi } from './api-model';
 import { FinancesApiError } from './error';
-export const RATE_LIMITS = [
+export const clientRateLimits = [
     {
         method: 'get',
         urlRegex: new RegExp('^/finances/v0/financialEventGroups$'),
@@ -30,20 +30,23 @@ export const RATE_LIMITS = [
 ];
 export class FinancesApiClient extends DefaultApi {
     constructor(parameters) {
-        const region = awsRegionByCode[parameters.region] ?? parameters.region;
+        const config = sellingPartnerRegions[parameters.region];
+        if (!config) {
+            throw new FinancesApiError(`Unknown region: ${parameters.region}`);
+        }
         const { rateLimiting, ...clientParameters } = parameters;
-        const axiosParameters = { ...clientParameters, region };
+        const axiosParameters = {
+            ...clientParameters,
+            region: config.awsRegion,
+        };
         if (rateLimiting?.retry) {
-            axiosParameters.rateLimits = RATE_LIMITS;
+            axiosParameters.rateLimits = clientRateLimits;
             axiosParameters.onRetry = rateLimiting.onRetry;
         }
         const axiosInstance = createAxiosInstance(axiosParameters);
         const configuration = new Configuration();
         const environment = parameters.sandbox ? 'sandbox' : 'production';
-        const endpoint = endpoints[environment][region];
-        if (!endpoint) {
-            throw new FinancesApiError(`Unknown region : ${region}`);
-        }
+        const endpoint = config.endpoints[environment];
         super(configuration, endpoint, axiosInstance);
     }
 }

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

@@ -272,7 +272,7 @@ export declare class DefaultApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    listFinancialEventGroups(requestParameters?: DefaultApiListFinancialEventGroupsRequest, options?: any): Promise<import("axios").AxiosResponse<ListFinancialEventGroupsResponse>>;
+    listFinancialEventGroups(requestParameters?: DefaultApiListFinancialEventGroupsRequest, options?: any): Promise<import("axios").AxiosResponse<ListFinancialEventGroupsResponse, any>>;
     /**
      * Returns financial events for the specified data range.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
@@ -280,7 +280,7 @@ export declare class DefaultApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    listFinancialEvents(requestParameters?: DefaultApiListFinancialEventsRequest, options?: any): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse>>;
+    listFinancialEvents(requestParameters?: DefaultApiListFinancialEventsRequest, options?: any): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any>>;
     /**
      * Returns all financial events for the specified financial event group.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {DefaultApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
@@ -288,7 +288,7 @@ export declare class DefaultApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    listFinancialEventsByGroupId(requestParameters: DefaultApiListFinancialEventsByGroupIdRequest, options?: any): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse>>;
+    listFinancialEventsByGroupId(requestParameters: DefaultApiListFinancialEventsByGroupIdRequest, options?: any): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any>>;
     /**
      * Returns all financial events for the specified order.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
      * @param {DefaultApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
@@ -296,5 +296,5 @@ export declare class DefaultApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    listFinancialEventsByOrderId(requestParameters: DefaultApiListFinancialEventsByOrderIdRequest, options?: any): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse>>;
+    listFinancialEventsByOrderId(requestParameters: DefaultApiListFinancialEventsByOrderIdRequest, options?: any): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any>>;
 }

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

@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any, any>>;

package/dist/types/src/api-model/models/removal-shipment-adjustment-event.d.ts

@@ -11,7 +11,7 @@
  */
 import { RemovalShipmentItemAdjustment } from './removal-shipment-item-adjustment';
 /**
- * A financial adjustment event for FBA liquidated inventory.  Possible adjustment:  * Positive values - Buyer needs to pay more amount to Amazon. E.g. charge was wrongly calculated 0$ instead of 100$ due to system error.   * Negative Values - Buyer get refund. E.g. Buyer receives less items or damaged items and as part of their adjustment buyer gets refund.
+ * A financial adjustment event for FBA liquidated inventory. A positive value indicates money owed to Amazon by the buyer (for example, when the charge was incorrectly calculated as less than it should be). A negative value indicates a full or partial refund owed to the buyer (for example, when the buyer receives damaged items or fewer items than ordered).
  * @export
  * @interface RemovalShipmentAdjustmentEvent
  */

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

@@ -1,11 +1,11 @@
-import { onRetry } from '@sp-api-sdk/common';
-import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
+import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
 import { DefaultApi } from './api-model';
-export declare const RATE_LIMITS: RateLimit[];
+export declare const clientRateLimits: RateLimit[];
 export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
+    region: SellingPartnerRegion;
     rateLimiting?: {
         retry: boolean;
-        onRetry?: onRetry;
+        onRetry?: OnRetryHandler;
     };
 }
 export declare class FinancesApiClient extends DefaultApi {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/finances-api-v0",
   "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
   "description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.",
-  "version": "1.7.4",
+  "version": "1.7.8",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -25,9 +25,9 @@
     "test": "NODE_ENV='test' yarn jest"
   },
   "dependencies": {
-    "@sp-api-sdk/auth": "^1.9.4",
-    "@sp-api-sdk/common": "^1.7.6",
-    "axios": "^0.21.1"
+    "@sp-api-sdk/auth": "^1.9.6",
+    "@sp-api-sdk/common": "^1.7.8",
+    "axios": "^0.24.0"
   },
   "repository": {
     "type": "git",
@@ -48,5 +48,5 @@
     "sp sdk",
     "finances api"
   ],
-  "gitHead": "5dbdf09e0f74182eaa9b6c5f9ef0c931b0aa3089"
+  "gitHead": "1bc9d6bf0dbbb02703122faa0c5e3e2505a20a97"
 }

package/dist/cjs/src/api-model/models/tdsreimbursement-event.js

@@ -1,15 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Selling Partner API for Finances
- * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
- *
- * The version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/es/src/api-model/models/tdsreimbursement-event.js

@@ -1,14 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Selling Partner API for Finances
- * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
- *
- * The version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export {};

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

@@ -1,37 +0,0 @@
-/**
- * Selling Partner API for Finances
- * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
- *
- * The version of the OpenAPI document: v0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { Currency } from './currency';
-/**
- * A tax deduction at source (TDS) claim reimbursement event on the seller\'s account.
- * @export
- * @interface TDSReimbursementEvent
- */
-export interface TDSReimbursementEvent {
-    /**
-     *
-     * @type {string}
-     * @memberof TDSReimbursementEvent
-     */
-    PostedDate?: string;
-    /**
-     * A tax deduction at source (TDS) claim identifier.
-     * @type {string}
-     * @memberof TDSReimbursementEvent
-     */
-    TdsOrderId?: string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof TDSReimbursementEvent
-     */
-    ReimbursedAmount?: Currency;
-}