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

package/src/finances_2024_06_19/model/Context.js

@@ -0,0 +1,308 @@
+/**
+ * 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 './AmazonPayContext.js'
+import { BusinessContext } from './BusinessContext.js'
+import { DeferredContext } from './DeferredContext.js'
+import { PaymentsContext } from './PaymentsContext.js'
+import { ProductContext } from './ProductContext.js'
+import { TimeRangeContext } from './TimeRangeContext.js'
+
+/**
+ * The Context model module.
+ * @module finances_2024_06_19/model/Context
+ * @version 2024-06-19
+ */
+export class Context {
+  /**
+   * Constructs a new <code>Context</code>.
+   * Additional Information about the item.
+   * @alias module:finances_2024_06_19/model/Context
+   * @class
+   * @implements module:finances_2024_06_19/model/AmazonPayContext
+   * @implements module:finances_2024_06_19/model/ProductContext
+   * @implements module:finances_2024_06_19/model/PaymentsContext
+   * @implements module:finances_2024_06_19/model/DeferredContext
+   * @implements module:finances_2024_06_19/model/BusinessContext
+   * @implements module:finances_2024_06_19/model/TimeRangeContext
+   * @param contextType {String}
+   */
+  constructor (contextType) {
+    AmazonPayContext.call(this)
+    ProductContext.call(this)
+    PaymentsContext.call(this)
+    DeferredContext.call(this)
+    BusinessContext.call(this)
+    TimeRangeContext.call(this)
+    this.contextType = contextType
+  }
+
+  /**
+   * Constructs a <code>Context</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/Context} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/Context} The populated <code>Context</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 Context()
+      AmazonPayContext.constructFromObject(data, obj)
+      ProductContext.constructFromObject(data, obj)
+      PaymentsContext.constructFromObject(data, obj)
+      DeferredContext.constructFromObject(data, obj)
+      BusinessContext.constructFromObject(data, obj)
+      TimeRangeContext.constructFromObject(data, obj)
+      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') }
+      if (data.hasOwnProperty('asin')) { obj.asin = ApiClient.convertToType(data.asin, 'String') }
+      if (data.hasOwnProperty('sku')) { obj.sku = ApiClient.convertToType(data.sku, 'String') }
+      if (data.hasOwnProperty('quantityShipped')) { obj.quantityShipped = ApiClient.convertToType(data.quantityShipped, 'Number') }
+      if (data.hasOwnProperty('fulfillmentNetwork')) { obj.fulfillmentNetwork = ApiClient.convertToType(data.fulfillmentNetwork, 'String') }
+      if (data.hasOwnProperty('paymentType')) { obj.paymentType = ApiClient.convertToType(data.paymentType, 'String') }
+      if (data.hasOwnProperty('paymentMethod')) { obj.paymentMethod = ApiClient.convertToType(data.paymentMethod, 'String') }
+      if (data.hasOwnProperty('paymentReference')) { obj.paymentReference = ApiClient.convertToType(data.paymentReference, 'String') }
+      if (data.hasOwnProperty('paymentDate')) { obj.paymentDate = ApiClient.convertToType(data.paymentDate, 'Date') }
+      if (data.hasOwnProperty('deferralReason')) { obj.deferralReason = ApiClient.convertToType(data.deferralReason, 'String') }
+      if (data.hasOwnProperty('maturityDate')) { obj.maturityDate = ApiClient.convertToType(data.maturityDate, 'Date') }
+      if (data.hasOwnProperty('startTime')) { obj.startTime = ApiClient.convertToType(data.startTime, 'Date') }
+      if (data.hasOwnProperty('endTime')) { obj.endTime = ApiClient.convertToType(data.endTime, 'Date') }
+      if (data.hasOwnProperty('contextType')) { obj.contextType = ApiClient.convertToType(data.contextType, 'String') }
+    }
+    return obj
+  }
+}
+
+/**
+ * Allowed values for the <code>storeName</code> property.
+ * @enum {String}
+ * @readonly
+ */
+Context.StoreNameEnum = {
+
+  /**
+     * value: "AMAZON_HAUL"
+     * @const
+     */
+  AMAZON_HAUL: 'AMAZON_HAUL'
+}
+
+/**
+ * The store name associated with the transaction.
+ * @member {module:finances_2024_06_19/model/Context.StoreNameEnum} storeName
+ */
+Context.prototype.storeName = undefined
+
+/**
+ * Order type of the transaction.
+ * @member {String} orderType
+ */
+Context.prototype.orderType = undefined
+
+/**
+ * Channel details of related transaction.
+ * @member {String} channel
+ */
+Context.prototype.channel = undefined
+
+/**
+ * Amazon Standard Identification Number (ASIN) of the item.
+ * @member {String} asin
+ */
+Context.prototype.asin = undefined
+
+/**
+ * Stock keeping unit (SKU) of the item.
+ * @member {String} sku
+ */
+Context.prototype.sku = undefined
+
+/**
+ * Quantity of the item shipped.
+ * @member {Number} quantityShipped
+ */
+Context.prototype.quantityShipped = undefined
+
+/**
+ * Fulfillment network of the item.
+ * @member {String} fulfillmentNetwork
+ */
+Context.prototype.fulfillmentNetwork = undefined
+
+/**
+ * Type of payment made.
+ * @member {String} paymentType
+ */
+Context.prototype.paymentType = undefined
+
+/**
+ * Method of payment made.
+ * @member {String} paymentMethod
+ */
+Context.prototype.paymentMethod = undefined
+
+/**
+ * Reference number of payment made.
+ * @member {String} paymentReference
+ */
+Context.prototype.paymentReference = undefined
+
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} paymentDate
+ */
+Context.prototype.paymentDate = undefined
+
+/**
+ * The deferral policy applied to the transaction.  **Examples:** `B2B` (invoiced orders), `DD7` (delivery date policy)
+ * @member {String} deferralReason
+ */
+Context.prototype.deferralReason = undefined
+
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} maturityDate
+ */
+Context.prototype.maturityDate = undefined
+
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} startTime
+ */
+Context.prototype.startTime = undefined
+
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} endTime
+ */
+Context.prototype.endTime = undefined
+
+/**
+ * @member {String} contextType
+ */
+Context.prototype.contextType = undefined
+
+// Implement AmazonPayContext interface:
+/**
+ * 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
+
+// Implement ProductContext interface:
+/**
+ * Amazon Standard Identification Number (ASIN) of the item.
+ * @member {String} asin
+ */
+ProductContext.prototype.asin = undefined
+
+/**
+ * Stock keeping unit (SKU) of the item.
+ * @member {String} sku
+ */
+ProductContext.prototype.sku = undefined
+
+/**
+ * Quantity of the item shipped.
+ * @member {Number} quantityShipped
+ */
+ProductContext.prototype.quantityShipped = undefined
+
+/**
+ * Fulfillment network of the item.
+ * @member {String} fulfillmentNetwork
+ */
+ProductContext.prototype.fulfillmentNetwork = undefined
+
+// Implement PaymentsContext interface:
+/**
+ * Type of payment made.
+ * @member {String} paymentType
+ */
+PaymentsContext.prototype.paymentType = undefined
+
+/**
+ * Method of payment made.
+ * @member {String} paymentMethod
+ */
+PaymentsContext.prototype.paymentMethod = undefined
+
+/**
+ * Reference number of payment made.
+ * @member {String} paymentReference
+ */
+PaymentsContext.prototype.paymentReference = undefined
+
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} paymentDate
+ */
+PaymentsContext.prototype.paymentDate = undefined
+
+// Implement DeferredContext interface:
+/**
+ * The deferral policy applied to the transaction.  **Examples:** `B2B` (invoiced orders), `DD7` (delivery date policy)
+ * @member {String} deferralReason
+ */
+DeferredContext.prototype.deferralReason = undefined
+
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} maturityDate
+ */
+DeferredContext.prototype.maturityDate = undefined
+
+// Implement BusinessContext interface:
+/**
+ * The store name associated with the transaction.
+ * @member {module:finances_2024_06_19/model/BusinessContext.StoreNameEnum} storeName
+ */
+BusinessContext.prototype.storeName = undefined
+
+// Implement TimeRangeContext interface:
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} startTime
+ */
+TimeRangeContext.prototype.startTime = undefined
+
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} endTime
+ */
+TimeRangeContext.prototype.endTime = undefined

package/src/finances_2024_06_19/model/Currency.js

@@ -0,0 +1,69 @@
+/**
+ * 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 Currency model module.
+ * @module finances_2024_06_19/model/Currency
+ * @version 2024-06-19
+ */
+export class Currency {
+  /**
+   * Constructs a new <code>Currency</code>.
+   * A currency type and amount.
+   * @alias module:finances_2024_06_19/model/Currency
+   * @class
+   */
+  constructor () {
+  }
+
+  /**
+   * Constructs a <code>Currency</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/Currency} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/Currency} The populated <code>Currency</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 Currency()
+      if (data.hasOwnProperty('currencyCode')) { obj.currencyCode = ApiClient.convertToType(data.currencyCode, 'String') }
+      if (data.hasOwnProperty('currencyAmount')) { obj.currencyAmount = ApiClient.convertToType(data.currencyAmount, 'Number') }
+    }
+    return obj
+  }
+}
+
+/**
+ * The three-digit currency code in ISO 4217 format.
+ * @member {String} currencyCode
+ */
+Currency.prototype.currencyCode = undefined
+
+/**
+ * Fields with a schema type of BigDecimal are a signed decimal number (for example CurrencyAmount).
+ * @member {Number} currencyAmount
+ */
+Currency.prototype.currencyAmount = undefined

package/src/finances_2024_06_19/model/DeferredContext.js

@@ -0,0 +1,69 @@
+/**
+ * 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 DeferredContext model module.
+ * @module finances_2024_06_19/model/DeferredContext
+ * @version 2024-06-19
+ */
+export class DeferredContext {
+  /**
+   * Constructs a new <code>DeferredContext</code>.
+   * Additional information related to Deferred transactions.
+   * @alias module:finances_2024_06_19/model/DeferredContext
+   * @class
+   */
+  constructor () {
+  }
+
+  /**
+   * Constructs a <code>DeferredContext</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/DeferredContext} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/DeferredContext} The populated <code>DeferredContext</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 DeferredContext()
+      if (data.hasOwnProperty('deferralReason')) { obj.deferralReason = ApiClient.convertToType(data.deferralReason, 'String') }
+      if (data.hasOwnProperty('maturityDate')) { obj.maturityDate = ApiClient.convertToType(data.maturityDate, 'Date') }
+    }
+    return obj
+  }
+}
+
+/**
+ * The deferral policy applied to the transaction.  **Examples:** `B2B` (invoiced orders), `DD7` (delivery date policy)
+ * @member {String} deferralReason
+ */
+DeferredContext.prototype.deferralReason = undefined
+
+/**
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
+ * @member {Date} maturityDate
+ */
+DeferredContext.prototype.maturityDate = undefined

package/src/finances_2024_06_19/model/Error.js

@@ -0,0 +1,80 @@
+/**
+ * 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 Error model module.
+ * @module finances_2024_06_19/model/Error
+ * @version 2024-06-19
+ */
+export class Error {
+  /**
+   * Constructs a new <code>Error</code>.
+   * 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.
+   * @param message {String} A message that describes the error condition.
+   */
+  constructor (code, message) {
+    this.code = code
+    this.message = message
+  }
+
+  /**
+   * Constructs a <code>Error</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/Error} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/Error} The populated <code>Error</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 Error()
+      if (data.hasOwnProperty('code')) { obj.code = ApiClient.convertToType(data.code, 'String') }
+      if (data.hasOwnProperty('message')) { obj.message = ApiClient.convertToType(data.message, 'String') }
+      if (data.hasOwnProperty('details')) { obj.details = ApiClient.convertToType(data.details, 'String') }
+    }
+    return obj
+  }
+}
+
+/**
+ * An error code that identifies the type of error that occurred.
+ * @member {String} code
+ */
+Error.prototype.code = undefined
+
+/**
+ * A message that describes the error condition.
+ * @member {String} message
+ */
+Error.prototype.message = undefined
+
+/**
+ * Additional details that can help the caller understand or fix the issue.
+ * @member {String} details
+ */
+Error.prototype.details = undefined

package/src/finances_2024_06_19/model/ErrorList.js

@@ -0,0 +1,65 @@
+/**
+ * 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 { Error } from './Error.js'
+
+/**
+ * The ErrorList model module.
+ * @module finances_2024_06_19/model/ErrorList
+ * @version 2024-06-19
+ */
+export class ErrorList {
+  /**
+   * Constructs a new <code>ErrorList</code>.
+   * A list of error responses returned when a request is unsuccessful.
+   * @alias module:finances_2024_06_19/model/ErrorList
+   * @class
+   * @param errors {Array.<module:finances_2024_06_19/model/Error>} Error response returned when the request is unsuccessful.
+   */
+  constructor (errors) {
+    this.errors = errors
+  }
+
+  /**
+   * Constructs a <code>ErrorList</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/ErrorList} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/ErrorList} The populated <code>ErrorList</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 ErrorList()
+      if (data.hasOwnProperty('errors')) { obj.errors = ApiClient.convertToType(data.errors, [Error]) }
+    }
+    return obj
+  }
+}
+
+/**
+ * Error response returned when the request is unsuccessful.
+ * @member {Array.<module:finances_2024_06_19/model/Error>} errors
+ */
+ErrorList.prototype.errors = undefined

package/src/finances_2024_06_19/model/Item.js

@@ -0,0 +1,93 @@
+/**
+ * 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 { Breakdown } from './Breakdown.js'
+import { Context } from './Context.js'
+import { Currency } from './Currency.js'
+import { ItemRelatedIdentifier } from './ItemRelatedIdentifier.js'
+
+/**
+ * The Item model module.
+ * @module finances_2024_06_19/model/Item
+ * @version 2024-06-19
+ */
+export class Item {
+  /**
+   * Constructs a new <code>Item</code>.
+   * Additional information about the items in Transaction.
+   * @alias module:finances_2024_06_19/model/Item
+   * @class
+   */
+  constructor () {
+  }
+
+  /**
+   * Constructs a <code>Item</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/Item} obj Optional instance to populate.
+   * @return {module:finances_2024_06_19/model/Item} The populated <code>Item</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 Item()
+      if (data.hasOwnProperty('description')) { obj.description = ApiClient.convertToType(data.description, 'String') }
+      if (data.hasOwnProperty('relatedIdentifiers')) { obj.relatedIdentifiers = ApiClient.convertToType(data.relatedIdentifiers, [ItemRelatedIdentifier]) }
+      if (data.hasOwnProperty('totalAmount')) { obj.totalAmount = Currency.constructFromObject(data.totalAmount) }
+      if (data.hasOwnProperty('breakdowns')) { obj.breakdowns = ApiClient.convertToType(data.breakdowns, [Breakdown]) }
+      if (data.hasOwnProperty('contexts')) { obj.contexts = ApiClient.convertToType(data.contexts, [Context]) }
+    }
+    return obj
+  }
+}
+
+/**
+ * Description of items in the transaction
+ * @member {String} description
+ */
+Item.prototype.description = undefined
+
+/**
+ * Related Business identifiers of the item in Transaction.
+ * @member {Array.<module:finances_2024_06_19/model/ItemRelatedIdentifier>} relatedIdentifiers
+ */
+Item.prototype.relatedIdentifiers = undefined
+
+/**
+ * @member {module:finances_2024_06_19/model/Currency} totalAmount
+ */
+Item.prototype.totalAmount = 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
+ */
+Item.prototype.breakdowns = undefined
+
+/**
+ * List of additional Information about the item.
+ * @member {Array.<module:finances_2024_06_19/model/Context>} contexts
+ */
+Item.prototype.contexts = undefined