@amazon-sp-api-release/amazon-sp-api-sdk-js 1.1.0 → 1.3.0

package/src/finances_2024_06_19/api/DefaultApi.js

@@ -0,0 +1,125 @@
+/**
+ * The 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 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 { ApiClient } from '../ApiClient.js'
+import { ErrorList } from '../model/ErrorList.js'
+import { ListTransactionsResponse } from '../model/ListTransactionsResponse.js'
+import { SuperagentRateLimiter } from '../../../helper/SuperagentRateLimiter.mjs'
+import { DefaultRateLimitFetcher } from '../../../helper/DefaultRateLimitFetcher.mjs'
+
+/**
+* Default service.
+* @module finances_2024_06_19/api/DefaultApi
+* @version 2024-06-19
+*/
+export class DefaultApi {
+  // Private memeber stores the default rate limiters
+  #defaultRateLimiterMap
+
+  /**
+    * Constructs a new DefaultApi.
+    * @alias module:finances_2024_06_19/api/DefaultApi
+    * @class
+    * @param {module:finances_2024_06_19/ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:finances_2024_06_19/ApiClient#instance} if unspecified.
+    */
+  constructor (apiClient) {
+    this.apiClient = apiClient || ApiClient.instance
+    this.initializeDefaultRateLimiterMap()
+  }
+
+  /**
+     * Initialize rate limiters for API operations
+     */
+  initializeDefaultRateLimiterMap () {
+    this.#defaultRateLimiterMap = new Map()
+    const defaultRateLimitFetcher = new DefaultRateLimitFetcher()
+    const operations = [
+      'DefaultApi-listTransactions'
+    ]
+
+    for (const operation of operations) {
+      const config = defaultRateLimitFetcher.getLimit(operation)
+      this.#defaultRateLimiterMap.set(operation, new SuperagentRateLimiter(config))
+    }
+  }
+
+  /**
+     * Get rate limiter for a specific operation
+     * @param {String} operation name
+     */
+  getRateLimiter (operation) {
+    return this.#defaultRateLimiterMap.get(operation)
+  }
+
+  /**
+     * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours.  **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 {Date} 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.
+     * @param {Object} opts Optional parameters
+     * @param {Date} opts.postedBefore A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
+     * @param {String} opts.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 your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     * @param {String} opts.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} opts.nextToken A string token returned in the response of your previous request.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:finances_2024_06_19/model/ListTransactionsResponse} and HTTP response
+     */
+  listTransactionsWithHttpInfo (postedAfter, opts) {
+    opts = opts || {}
+    const postBody = null
+
+    // verify the required parameter 'postedAfter' is set
+    if (postedAfter === undefined || postedAfter === null) {
+      throw new Error("Missing the required parameter 'postedAfter' when calling listTransactions")
+    }
+
+    const pathParams = {
+    }
+    const queryParams = {
+      postedAfter,
+      postedBefore: opts.postedBefore,
+      marketplaceId: opts.marketplaceId,
+      transactionStatus: opts.transactionStatus,
+      nextToken: opts.nextToken
+    }
+    const headerParams = {
+    }
+    const formParams = {
+    }
+
+    const contentTypes = []
+    const accepts = ['application/json']
+    const returnType = ListTransactionsResponse
+
+    return this.apiClient.callApi('DefaultApi-listTransactions',
+      '/finances/2024-06-19/transactions', 'GET',
+      pathParams, queryParams, headerParams, formParams, postBody,
+      contentTypes, accepts, returnType, this.getRateLimiter('DefaultApi-listTransactions')
+    )
+  }
+
+  /**
+     * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours.  **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 {Date} 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.
+     * @param {Object} opts Optional parameters
+     * @param {Date} opts.postedBefore A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
+     * @param {String} opts.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 your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     * @param {String} opts.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} opts.nextToken A string token returned in the response of your previous request.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:finances_2024_06_19/model/ListTransactionsResponse}
+     */
+  listTransactions (postedAfter, opts) {
+    return this.listTransactionsWithHttpInfo(postedAfter, opts)
+      .then(function (response_and_data) {
+        return response_and_data.data
+      })
+  }
+}

package/src/finances_2024_06_19/index.js

@@ -0,0 +1,168 @@
+/**
+ * The 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 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 { ApiClient } from './ApiClient.js'
+import { AmazonPayContext } from './model/AmazonPayContext.js'
+import { Breakdown } from './model/Breakdown.js'
+import { BusinessContext } from './model/BusinessContext.js'
+import { Context } from './model/Context.js'
+import { Currency } from './model/Currency.js'
+import { DeferredContext } from './model/DeferredContext.js'
+import { Error } from './model/Error.js'
+import { ErrorList } from './model/ErrorList.js'
+import { Item } from './model/Item.js'
+import { ItemRelatedIdentifier } from './model/ItemRelatedIdentifier.js'
+import { ListTransactionsResponse } from './model/ListTransactionsResponse.js'
+import { MarketplaceDetails } from './model/MarketplaceDetails.js'
+import { PaymentsContext } from './model/PaymentsContext.js'
+import { ProductContext } from './model/ProductContext.js'
+import { RelatedIdentifier } from './model/RelatedIdentifier.js'
+import { SellingPartnerMetadata } from './model/SellingPartnerMetadata.js'
+import { TimeRangeContext } from './model/TimeRangeContext.js'
+import { Transaction } from './model/Transaction.js'
+import { TransactionsPayload } from './model/TransactionsPayload.js'
+import { DefaultApi } from './api/DefaultApi.js'
+
+/**
+* The Selling Partner API for Finances helps you obtain financial information relevant to a seller&#39;s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes..<br>
+* The <code>index</code> module provides access to constructors for all the classes which comprise the public API.
+* @module finances_2024_06_19/index
+* @version 2024-06-19
+*/
+export {
+  /**
+     * The ApiClient constructor.
+     * @property {module:finances_2024_06_19/ApiClient}
+     */
+  ApiClient,
+
+  /**
+     * The AmazonPayContext model constructor.
+     * @property {module:finances_2024_06_19/model/AmazonPayContext}
+     */
+  AmazonPayContext,
+
+  /**
+     * The Breakdown model constructor.
+     * @property {module:finances_2024_06_19/model/Breakdown}
+     */
+  Breakdown,
+
+  /**
+     * The BusinessContext model constructor.
+     * @property {module:finances_2024_06_19/model/BusinessContext}
+     */
+  BusinessContext,
+
+  /**
+     * The Context model constructor.
+     * @property {module:finances_2024_06_19/model/Context}
+     */
+  Context,
+
+  /**
+     * The Currency model constructor.
+     * @property {module:finances_2024_06_19/model/Currency}
+     */
+  Currency,
+
+  /**
+     * The DeferredContext model constructor.
+     * @property {module:finances_2024_06_19/model/DeferredContext}
+     */
+  DeferredContext,
+
+  /**
+     * The Error model constructor.
+     * @property {module:finances_2024_06_19/model/Error}
+     */
+  Error,
+
+  /**
+     * The ErrorList model constructor.
+     * @property {module:finances_2024_06_19/model/ErrorList}
+     */
+  ErrorList,
+
+  /**
+     * The Item model constructor.
+     * @property {module:finances_2024_06_19/model/Item}
+     */
+  Item,
+
+  /**
+     * The ItemRelatedIdentifier model constructor.
+     * @property {module:finances_2024_06_19/model/ItemRelatedIdentifier}
+     */
+  ItemRelatedIdentifier,
+
+  /**
+     * The ListTransactionsResponse model constructor.
+     * @property {module:finances_2024_06_19/model/ListTransactionsResponse}
+     */
+  ListTransactionsResponse,
+
+  /**
+     * The MarketplaceDetails model constructor.
+     * @property {module:finances_2024_06_19/model/MarketplaceDetails}
+     */
+  MarketplaceDetails,
+
+  /**
+     * The PaymentsContext model constructor.
+     * @property {module:finances_2024_06_19/model/PaymentsContext}
+     */
+  PaymentsContext,
+
+  /**
+     * The ProductContext model constructor.
+     * @property {module:finances_2024_06_19/model/ProductContext}
+     */
+  ProductContext,
+
+  /**
+     * The RelatedIdentifier model constructor.
+     * @property {module:finances_2024_06_19/model/RelatedIdentifier}
+     */
+  RelatedIdentifier,
+
+  /**
+     * The SellingPartnerMetadata model constructor.
+     * @property {module:finances_2024_06_19/model/SellingPartnerMetadata}
+     */
+  SellingPartnerMetadata,
+
+  /**
+     * The TimeRangeContext model constructor.
+     * @property {module:finances_2024_06_19/model/TimeRangeContext}
+     */
+  TimeRangeContext,
+
+  /**
+     * The Transaction model constructor.
+     * @property {module:finances_2024_06_19/model/Transaction}
+     */
+  Transaction,
+
+  /**
+     * The TransactionsPayload model constructor.
+     * @property {module:finances_2024_06_19/model/TransactionsPayload}
+     */
+  TransactionsPayload,
+
+  /**
+    * The DefaultApi service constructor.
+    * @property {module:finances_2024_06_19/api/DefaultApi}
+    */
+  DefaultApi
+}

package/src/finances_2024_06_19/model/AmazonPayContext.js

@@ -0,0 +1,76 @@
+/**
+ * The 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 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 { ApiClient } from '../ApiClient.js'
+
+/**
+ * The AmazonPayContext model module.
+ * @module finances_2024_06_19/model/AmazonPayContext
+ * @version 2024-06-19
+ */
+export class AmazonPayContext {
+  /**
+   * Constructs a new <code>AmazonPayContext</code>.
+   * Additional information related to Amazon Pay.
+   * @alias module:finances_2024_06_19/model/AmazonPayContext
+   * @class
+   */
+  constructor () {
+  }
+
+  /**
+   * Constructs a <code>AmazonPayContext</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:finances_2024_06_19/model/AmazonPayContext} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/AmazonPayContext} The populated <code>AmazonPayContext</code> instance.
+   */
+  static constructFromObject (data, obj) {
+    if (data) {
+      switch (typeof data) {
+        case 'string':
+          obj = String(data)
+          break
+        case 'number':
+          obj = Number(data)
+          break
+        case 'boolean':
+          obj = Boolean(data)
+          break
+      }
+      obj = obj || new AmazonPayContext()
+      if (data.hasOwnProperty('storeName')) { obj.storeName = ApiClient.convertToType(data.storeName, 'String') }
+      if (data.hasOwnProperty('orderType')) { obj.orderType = ApiClient.convertToType(data.orderType, 'String') }
+      if (data.hasOwnProperty('channel')) { obj.channel = ApiClient.convertToType(data.channel, 'String') }
+    }
+    return obj
+  }
+}
+
+/**
+ * Store name related to transaction.
+ * @member {String} storeName
+ */
+AmazonPayContext.prototype.storeName = undefined
+
+/**
+ * Order type of the transaction.
+ * @member {String} orderType
+ */
+AmazonPayContext.prototype.orderType = undefined
+
+/**
+ * Channel details of related transaction.
+ * @member {String} channel
+ */
+AmazonPayContext.prototype.channel = undefined

package/src/finances_2024_06_19/model/Breakdown.js

@@ -0,0 +1,76 @@
+/**
+ * The 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 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 { ApiClient } from '../ApiClient.js'
+import { Currency } from './Currency.js'
+
+/**
+ * The Breakdown model module.
+ * @module finances_2024_06_19/model/Breakdown
+ * @version 2024-06-19
+ */
+export class Breakdown {
+  /**
+   * Constructs a new <code>Breakdown</code>.
+   * Breakdown provides details regarding the money movement under the financial transaction. Breakdowns get categorized further into breakdown types, breakdown amounts, and further breakdowns into a hierarchical structure.
+   * @alias module:finances_2024_06_19/model/Breakdown
+   * @class
+   */
+  constructor () {
+  }
+
+  /**
+   * Constructs a <code>Breakdown</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:finances_2024_06_19/model/Breakdown} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/Breakdown} The populated <code>Breakdown</code> instance.
+   */
+  static constructFromObject (data, obj) {
+    if (data) {
+      switch (typeof data) {
+        case 'string':
+          obj = String(data)
+          break
+        case 'number':
+          obj = Number(data)
+          break
+        case 'boolean':
+          obj = Boolean(data)
+          break
+      }
+      obj = obj || new Breakdown()
+      if (data.hasOwnProperty('breakdownType')) { obj.breakdownType = ApiClient.convertToType(data.breakdownType, 'String') }
+      if (data.hasOwnProperty('breakdownAmount')) { obj.breakdownAmount = Currency.constructFromObject(data.breakdownAmount) }
+      if (data.hasOwnProperty('breakdowns')) { obj.breakdowns = ApiClient.convertToType(data.breakdowns, [Breakdown]) }
+    }
+    return obj
+  }
+}
+
+/**
+ * The type of charge.
+ * @member {String} breakdownType
+ */
+Breakdown.prototype.breakdownType = undefined
+
+/**
+ * @member {module:finances_2024_06_19/model/Currency} breakdownAmount
+ */
+Breakdown.prototype.breakdownAmount = undefined
+
+/**
+ * A list of breakdowns that detail how the total amount is calculated for the transaction.
+ * @member {Array.<module:finances_2024_06_19/model/Breakdown>} breakdowns
+ */
+Breakdown.prototype.breakdowns = undefined

package/src/finances_2024_06_19/model/BusinessContext.js

@@ -0,0 +1,76 @@
+/**
+ * The 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 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 { ApiClient } from '../ApiClient.js'
+
+/**
+ * The BusinessContext model module.
+ * @module finances_2024_06_19/model/BusinessContext
+ * @version 2024-06-19
+ */
+export class BusinessContext {
+  /**
+   * Constructs a new <code>BusinessContext</code>.
+   * Information about the line of business associated with a transaction.
+   * @alias module:finances_2024_06_19/model/BusinessContext
+   * @class
+   */
+  constructor () {
+  }
+
+  /**
+   * Constructs a <code>BusinessContext</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:finances_2024_06_19/model/BusinessContext} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/BusinessContext} The populated <code>BusinessContext</code> instance.
+   */
+  static constructFromObject (data, obj) {
+    if (data) {
+      switch (typeof data) {
+        case 'string':
+          obj = String(data)
+          break
+        case 'number':
+          obj = Number(data)
+          break
+        case 'boolean':
+          obj = Boolean(data)
+          break
+      }
+      obj = obj || new BusinessContext()
+      if (data.hasOwnProperty('storeName')) { obj.storeName = ApiClient.convertToType(data.storeName, 'String') }
+    }
+    return obj
+  }
+}
+
+/**
+ * Allowed values for the <code>storeName</code> property.
+ * @enum {String}
+ * @readonly
+ */
+BusinessContext.StoreNameEnum = {
+
+  /**
+     * value: "AMAZON_HAUL"
+     * @const
+     */
+  AMAZON_HAUL: 'AMAZON_HAUL'
+}
+
+/**
+ * The store name associated with the transaction.
+ * @member {module:finances_2024_06_19/model/BusinessContext.StoreNameEnum} storeName
+ */
+BusinessContext.prototype.storeName = undefined