@amazon-sp-api-release/amazon-sp-api-sdk-js 1.6.1-alpha.0 → 1.7.0

package/src/finances_2024_06_19/model/Context.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -117,7 +117,7 @@ Context.StoreNameEnum = {
 Context.prototype.storeName = undefined
 
 /**
- * Order type of the transaction.
+ * The transaction's order type.
  * @member {String} orderType
  * @type {String}
  */
@@ -131,56 +131,56 @@ Context.prototype.orderType = undefined
 Context.prototype.channel = undefined
 
 /**
- * Amazon Standard Identification Number (ASIN) of the item.
+ * The Amazon Standard Identification Number (ASIN) of the item.
  * @member {String} asin
  * @type {String}
  */
 Context.prototype.asin = undefined
 
 /**
- * Stock keeping unit (SKU) of the item.
+ * The Stock Keeping Unit (SKU) of the item.
  * @member {String} sku
  * @type {String}
  */
 Context.prototype.sku = undefined
 
 /**
- * Quantity of the item shipped.
+ * The quantity of the item shipped.
  * @member {Number} quantityShipped
  * @type {Number}
  */
 Context.prototype.quantityShipped = undefined
 
 /**
- * Fulfillment network of the item.
+ * The fulfillment network of the item.
  * @member {String} fulfillmentNetwork
  * @type {String}
  */
 Context.prototype.fulfillmentNetwork = undefined
 
 /**
- * Type of payment made.
+ * The type of payment.
  * @member {String} paymentType
  * @type {String}
  */
 Context.prototype.paymentType = undefined
 
 /**
- * Method of payment made.
+ * The method of payment.
  * @member {String} paymentMethod
  * @type {String}
  */
 Context.prototype.paymentMethod = undefined
 
 /**
- * Reference number of payment made.
+ * The reference number of the payment.
  * @member {String} paymentReference
  * @type {String}
  */
 Context.prototype.paymentReference = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} paymentDate
  * @type {Date}
  */
@@ -194,21 +194,21 @@ Context.prototype.paymentDate = undefined
 Context.prototype.deferralReason = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} maturityDate
  * @type {Date}
  */
 Context.prototype.maturityDate = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} startTime
  * @type {Date}
  */
 Context.prototype.startTime = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} endTime
  * @type {Date}
  */
@@ -222,14 +222,14 @@ Context.prototype.contextType = undefined
 
 // Implement AmazonPayContext interface:
 /**
- * Store name related to transaction.
+ * The name of the store that is related to the transaction.
  * @member {String} storeName
  * @type {String}
  */
 AmazonPayContext.prototype.storeName = undefined
 
 /**
- * Order type of the transaction.
+ * The transaction's order type.
  * @member {String} orderType
  * @type {String}
  */
@@ -244,28 +244,28 @@ AmazonPayContext.prototype.channel = undefined
 
 // Implement ProductContext interface:
 /**
- * Amazon Standard Identification Number (ASIN) of the item.
+ * The Amazon Standard Identification Number (ASIN) of the item.
  * @member {String} asin
  * @type {String}
  */
 ProductContext.prototype.asin = undefined
 
 /**
- * Stock keeping unit (SKU) of the item.
+ * The Stock Keeping Unit (SKU) of the item.
  * @member {String} sku
  * @type {String}
  */
 ProductContext.prototype.sku = undefined
 
 /**
- * Quantity of the item shipped.
+ * The quantity of the item shipped.
  * @member {Number} quantityShipped
  * @type {Number}
  */
 ProductContext.prototype.quantityShipped = undefined
 
 /**
- * Fulfillment network of the item.
+ * The fulfillment network of the item.
  * @member {String} fulfillmentNetwork
  * @type {String}
  */
@@ -273,28 +273,28 @@ ProductContext.prototype.fulfillmentNetwork = undefined
 
 // Implement PaymentsContext interface:
 /**
- * Type of payment made.
+ * The type of payment.
  * @member {String} paymentType
  * @type {String}
  */
 PaymentsContext.prototype.paymentType = undefined
 
 /**
- * Method of payment made.
+ * The method of payment.
  * @member {String} paymentMethod
  * @type {String}
  */
 PaymentsContext.prototype.paymentMethod = undefined
 
 /**
- * Reference number of payment made.
+ * The reference number of the payment.
  * @member {String} paymentReference
  * @type {String}
  */
 PaymentsContext.prototype.paymentReference = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} paymentDate
  * @type {Date}
  */
@@ -309,7 +309,7 @@ PaymentsContext.prototype.paymentDate = undefined
 DeferredContext.prototype.deferralReason = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} maturityDate
  * @type {Date}
  */
@@ -325,14 +325,14 @@ BusinessContext.prototype.storeName = undefined
 
 // Implement TimeRangeContext interface:
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} startTime
  * @type {Date}
  */
 TimeRangeContext.prototype.startTime = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} endTime
  * @type {Date}
  */

package/src/finances_2024_06_19/model/Currency.d.ts

@@ -19,7 +19,7 @@ export class Currency {
      */
     currencyCode: string;
     /**
-     * Fields with a schema type of BigDecimal are a signed decimal number (for example CurrencyAmount).
+     * A signed decimal number.
      * @member {Number} currencyAmount
      * @type {Number}
      */

package/src/finances_2024_06_19/model/Currency.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -64,7 +64,7 @@ export class Currency {
 Currency.prototype.currencyCode = undefined
 
 /**
- * Fields with a schema type of BigDecimal are a signed decimal number (for example CurrencyAmount).
+ * A signed decimal number.
  * @member {Number} currencyAmount
  * @type {Number}
  */

package/src/finances_2024_06_19/model/DeferredContext.d.ts

@@ -19,7 +19,7 @@ export class DeferredContext {
      */
     deferralReason: string;
     /**
-     * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
      * @member {Date} maturityDate
      * @type {Date}
      */

package/src/finances_2024_06_19/model/DeferredContext.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -21,7 +21,7 @@ import { ApiClient } from '../ApiClient.js'
 export class DeferredContext {
   /**
    * Constructs a new <code>DeferredContext</code>.
-   * Additional information related to Deferred transactions.
+   * Additional information related to deferred transactions.
    * @alias module:finances_2024_06_19/model/DeferredContext
    * @class
    */
@@ -64,7 +64,7 @@ export class DeferredContext {
 DeferredContext.prototype.deferralReason = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} maturityDate
  * @type {Date}
  */

package/src/finances_2024_06_19/model/Error.d.ts

@@ -14,7 +14,7 @@ export class Error {
     static constructFromObject(data: any, obj: Error): Error;
     /**
      * Constructs a new <code>Error</code>.
-     * Error response returned when the request is unsuccessful.
+     * An error response returned when the request is unsuccessful.
      * @alias module:finances_2024_06_19/model/Error
      * @class
      * @param code {String} An error code that identifies the type of error that occurred.

package/src/finances_2024_06_19/model/Error.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -21,7 +21,7 @@ import { ApiClient } from '../ApiClient.js'
 export class Error {
   /**
    * Constructs a new <code>Error</code>.
-   * Error response returned when the request is unsuccessful.
+   * An error response returned when the request is unsuccessful.
    * @alias module:finances_2024_06_19/model/Error
    * @class
    * @param code {String} An error code that identifies the type of error that occurred.

package/src/finances_2024_06_19/model/ErrorList.d.ts

@@ -17,7 +17,7 @@ export class ErrorList {
      * A list of error responses returned when a request is unsuccessful.
      * @alias module:finances_2024_06_19/model/ErrorList
      * @class
-     * @param errors {[Error]} Error response returned when the request is unsuccessful.
+     * @param errors {[Error]} The error responses that are returned when the request is unsuccessful.
      */
     constructor(errors: [Error]);
     errors: [Error];

package/src/finances_2024_06_19/model/ErrorList.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -25,7 +25,7 @@ export class ErrorList {
    * A list of error responses returned when a request is unsuccessful.
    * @alias module:finances_2024_06_19/model/ErrorList
    * @class
-   * @param errors {[Error]} Error response returned when the request is unsuccessful.
+   * @param errors {[Error]} The error responses that are returned when the request is unsuccessful.
    */
   constructor (errors) {
     this.errors = errors
@@ -59,7 +59,7 @@ export class ErrorList {
 }
 
 /**
- * Error response returned when the request is unsuccessful.
+ * The error responses that are returned when the request is unsuccessful.
  * @member {[Error]} errors
  * @type {[Error]}
  */

package/src/finances_2024_06_19/model/Item.d.ts

@@ -13,13 +13,13 @@ export class Item {
      */
     static constructFromObject(data: any, obj: Item): Item;
     /**
-     * Description of items in the transaction
+     * A description of the items in a transaction.
      * @member {String} description
      * @type {String}
      */
     description: string;
     /**
-     * Related Business identifiers of the item in Transaction.
+     * Related business identifiers of the item in the transaction.
      * @member {[ItemRelatedIdentifier]} relatedIdentifiers
      * @type {[ItemRelatedIdentifier]}
      */
@@ -36,7 +36,7 @@ export class Item {
      */
     breakdowns: [Breakdown];
     /**
-     * List of additional Information about the item.
+     * A list of additional information about the item.
      * @member {[Context]} contexts
      * @type {[Context]}
      */

package/src/finances_2024_06_19/model/Item.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -25,7 +25,7 @@ import { ItemRelatedIdentifier } from './ItemRelatedIdentifier.js'
 export class Item {
   /**
    * Constructs a new <code>Item</code>.
-   * Additional information about the items in Transaction.
+   * Additional information about the items in a transaction.
    * @alias module:finances_2024_06_19/model/Item
    * @class
    */
@@ -64,14 +64,14 @@ export class Item {
 }
 
 /**
- * Description of items in the transaction
+ * A description of the items in a transaction.
  * @member {String} description
  * @type {String}
  */
 Item.prototype.description = undefined
 
 /**
- * Related Business identifiers of the item in Transaction.
+ * Related business identifiers of the item in the transaction.
  * @member {[ItemRelatedIdentifier]} relatedIdentifiers
  * @type {[ItemRelatedIdentifier]}
  */
@@ -91,7 +91,7 @@ Item.prototype.totalAmount = undefined
 Item.prototype.breakdowns = undefined
 
 /**
- * List of additional Information about the item.
+ * A list of additional information about the item.
  * @member {[Context]} contexts
  * @type {[Context]}
  */

package/src/finances_2024_06_19/model/ItemRelatedIdentifier.d.ts

@@ -19,7 +19,7 @@ export class ItemRelatedIdentifier {
      */
     itemRelatedIdentifierName: string;
     /**
-     * Corresponding value of ItemRelatedIdentifierName
+     * Corresponding value to `ItemRelatedIdentifierName`.
      * @member {String} itemRelatedIdentifierValue
      * @type {String}
      */

package/src/finances_2024_06_19/model/ItemRelatedIdentifier.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -95,7 +95,7 @@ ItemRelatedIdentifier.ItemRelatedIdentifierNameEnum = {
 ItemRelatedIdentifier.prototype.itemRelatedIdentifierName = undefined
 
 /**
- * Corresponding value of ItemRelatedIdentifierName
+ * Corresponding value to `ItemRelatedIdentifierName`.
  * @member {String} itemRelatedIdentifierValue
  * @type {String}
  */

package/src/finances_2024_06_19/model/ListTransactionsResponse.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *

package/src/finances_2024_06_19/model/MarketplaceDetails.d.ts

@@ -19,7 +19,7 @@ export class MarketplaceDetails {
      */
     marketplaceId: string;
     /**
-     * The name of the marketplace where the transaction occurred.   Example: 'Amazon.com','Amazon.in'
+     * The name of the marketplace where the transaction occurred. For example: `Amazon.com`,`Amazon.in`
      * @member {String} marketplaceName
      * @type {String}
      */

package/src/finances_2024_06_19/model/MarketplaceDetails.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -64,7 +64,7 @@ export class MarketplaceDetails {
 MarketplaceDetails.prototype.marketplaceId = undefined
 
 /**
- * The name of the marketplace where the transaction occurred.   Example: 'Amazon.com','Amazon.in'
+ * The name of the marketplace where the transaction occurred. For example: `Amazon.com`,`Amazon.in`
  * @member {String} marketplaceName
  * @type {String}
  */

package/src/finances_2024_06_19/model/PaymentsContext.d.ts

@@ -13,25 +13,25 @@ export class PaymentsContext {
      */
     static constructFromObject(data: any, obj: PaymentsContext): PaymentsContext;
     /**
-     * Type of payment made.
+     * The type of payment.
      * @member {String} paymentType
      * @type {String}
      */
     paymentType: string;
     /**
-     * Method of payment made.
+     * The method of payment.
      * @member {String} paymentMethod
      * @type {String}
      */
     paymentMethod: string;
     /**
-     * Reference number of payment made.
+     * The reference number of the payment.
      * @member {String} paymentReference
      * @type {String}
      */
     paymentReference: string;
     /**
-     * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+     * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
      * @member {Date} paymentDate
      * @type {Date}
      */

package/src/finances_2024_06_19/model/PaymentsContext.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -21,7 +21,7 @@ import { ApiClient } from '../ApiClient.js'
 export class PaymentsContext {
   /**
    * Constructs a new <code>PaymentsContext</code>.
-   * Additional information related to Payments related transactions.
+   * Additional information related to payments-related transactions.
    * @alias module:finances_2024_06_19/model/PaymentsContext
    * @class
    */
@@ -59,28 +59,28 @@ export class PaymentsContext {
 }
 
 /**
- * Type of payment made.
+ * The type of payment.
  * @member {String} paymentType
  * @type {String}
  */
 PaymentsContext.prototype.paymentType = undefined
 
 /**
- * Method of payment made.
+ * The method of payment.
  * @member {String} paymentMethod
  * @type {String}
  */
 PaymentsContext.prototype.paymentMethod = undefined
 
 /**
- * Reference number of payment made.
+ * The reference number of the payment.
  * @member {String} paymentReference
  * @type {String}
  */
 PaymentsContext.prototype.paymentReference = undefined
 
 /**
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
  * @member {Date} paymentDate
  * @type {Date}
  */

package/src/finances_2024_06_19/model/ProductContext.d.ts

@@ -13,25 +13,25 @@ export class ProductContext {
      */
     static constructFromObject(data: any, obj: ProductContext): ProductContext;
     /**
-     * Amazon Standard Identification Number (ASIN) of the item.
+     * The Amazon Standard Identification Number (ASIN) of the item.
      * @member {String} asin
      * @type {String}
      */
     asin: string;
     /**
-     * Stock keeping unit (SKU) of the item.
+     * The Stock Keeping Unit (SKU) of the item.
      * @member {String} sku
      * @type {String}
      */
     sku: string;
     /**
-     * Quantity of the item shipped.
+     * The quantity of the item shipped.
      * @member {Number} quantityShipped
      * @type {Number}
      */
     quantityShipped: number;
     /**
-     * Fulfillment network of the item.
+     * The fulfillment network of the item.
      * @member {String} fulfillmentNetwork
      * @type {String}
      */

package/src/finances_2024_06_19/model/ProductContext.js

@@ -1,6 +1,6 @@
 /**
  * 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 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
  *
@@ -59,28 +59,28 @@ export class ProductContext {
 }
 
 /**
- * Amazon Standard Identification Number (ASIN) of the item.
+ * The Amazon Standard Identification Number (ASIN) of the item.
  * @member {String} asin
  * @type {String}
  */
 ProductContext.prototype.asin = undefined
 
 /**
- * Stock keeping unit (SKU) of the item.
+ * The Stock Keeping Unit (SKU) of the item.
  * @member {String} sku
  * @type {String}
  */
 ProductContext.prototype.sku = undefined
 
 /**
- * Quantity of the item shipped.
+ * The quantity of the item shipped.
  * @member {Number} quantityShipped
  * @type {Number}
  */
 ProductContext.prototype.quantityShipped = undefined
 
 /**
- * Fulfillment network of the item.
+ * The fulfillment network of the item.
  * @member {String} fulfillmentNetwork
  * @type {String}
  */

package/src/finances_2024_06_19/model/RelatedIdentifier.d.ts

@@ -13,13 +13,13 @@ export class RelatedIdentifier {
      */
     static constructFromObject(data: any, obj: RelatedIdentifier): RelatedIdentifier;
     /**
-     * Enumerated set of related business identifier names.
+     * An enumerated set of related business identifier names.
      * @member {String} relatedIdentifierName
      * @type {String}
      */
     relatedIdentifierName: string;
     /**
-     * Corresponding value of RelatedIdentifierName
+     * Corresponding value of `RelatedIdentifierName`.
      * @member {String} relatedIdentifierValue
      * @type {String}
      */