@sp-api-sdk/finances-api-v0 4.0.1 → 4.0.3

package/dist/types/api-model/models/coupon-payment-event.d.ts

@@ -14,56 +14,29 @@ import type { Currency } from './currency';
 import type { FeeComponent } from './fee-component';
 /**
  * An event related to coupon payments.
- * @export
- * @interface CouponPaymentEvent
  */
 export interface CouponPaymentEvent {
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof CouponPaymentEvent
      */
     'PostedDate'?: string;
     /**
      * A coupon identifier.
-     * @type {string}
-     * @memberof CouponPaymentEvent
      */
     'CouponId'?: string;
     /**
      * The description provided by the seller when they created the coupon.
-     * @type {string}
-     * @memberof CouponPaymentEvent
      */
     'SellerCouponDescription'?: string;
     /**
      * The number of coupon clips or redemptions.
-     * @type {number}
-     * @memberof CouponPaymentEvent
      */
     'ClipOrRedemptionCount'?: number;
     /**
      * A payment event identifier.
-     * @type {string}
-     * @memberof CouponPaymentEvent
      */
     'PaymentEventId'?: string;
-    /**
-     *
-     * @type {FeeComponent}
-     * @memberof CouponPaymentEvent
-     */
     'FeeComponent'?: FeeComponent;
-    /**
-     *
-     * @type {ChargeComponent}
-     * @memberof CouponPaymentEvent
-     */
     'ChargeComponent'?: ChargeComponent;
-    /**
-     *
-     * @type {Currency}
-     * @memberof CouponPaymentEvent
-     */
     'TotalAmount'?: Currency;
 }

package/dist/types/api-model/models/currency.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * A currency type and amount.
- * @export
- * @interface Currency
  */
 export interface Currency {
     /**
      * The three-digit currency code in ISO 4217 format.
-     * @type {string}
-     * @memberof Currency
      */
     'CurrencyCode'?: string;
     /**
      * Fields with a schema type of BigDecimal are a signed decimal number (for example CurrencyAmount).
-     * @type {number}
-     * @memberof Currency
      */
     'CurrencyAmount'?: number;
 }

package/dist/types/api-model/models/debt-recovery-event.d.ts

@@ -14,38 +14,20 @@ import type { Currency } from './currency';
 import type { DebtRecoveryItem } from './debt-recovery-item';
 /**
  * A debt payment or debt adjustment.
- * @export
- * @interface DebtRecoveryEvent
  */
 export interface DebtRecoveryEvent {
     /**
      * The debt recovery type.  Possible values:  * DebtPayment  * DebtPaymentFailure  * DebtAdjustment
-     * @type {string}
-     * @memberof DebtRecoveryEvent
      */
     'DebtRecoveryType'?: string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof DebtRecoveryEvent
-     */
     'RecoveryAmount'?: Currency;
-    /**
-     *
-     * @type {Currency}
-     * @memberof DebtRecoveryEvent
-     */
     'OverPaymentCredit'?: Currency;
     /**
      * A list of debt recovery item information.
-     * @type {Array<DebtRecoveryItem>}
-     * @memberof DebtRecoveryEvent
      */
     'DebtRecoveryItemList'?: Array<DebtRecoveryItem>;
     /**
      * A list of payment instruments.
-     * @type {Array<ChargeInstrument>}
-     * @memberof DebtRecoveryEvent
      */
     'ChargeInstrumentList'?: Array<ChargeInstrument>;
 }

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

@@ -12,32 +12,16 @@
 import type { Currency } from './currency';
 /**
  * An item of a debt payment or debt adjustment.
- * @export
- * @interface DebtRecoveryItem
  */
 export interface DebtRecoveryItem {
-    /**
-     *
-     * @type {Currency}
-     * @memberof DebtRecoveryItem
-     */
     'RecoveryAmount'?: Currency;
-    /**
-     *
-     * @type {Currency}
-     * @memberof DebtRecoveryItem
-     */
     'OriginalAmount'?: Currency;
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof DebtRecoveryItem
      */
     'GroupBeginDate'?: string;
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof DebtRecoveryItem
      */
     'GroupEndDate'?: string;
 }

package/dist/types/api-model/models/direct-payment.d.ts

@@ -12,20 +12,11 @@
 import type { Currency } from './currency';
 /**
  * A payment made directly to a seller.
- * @export
- * @interface DirectPayment
  */
 export interface DirectPayment {
     /**
      * The type of payment.  Possible values:  * StoredValueCardRevenue - The amount that is deducted from the seller\'s account because the seller received money through a stored value card.  * StoredValueCardRefund - The amount that Amazon returns to the seller if the order that is bought using a stored value card is refunded.  * PrivateLabelCreditCardRevenue - The amount that is deducted from the seller\'s account because the seller received money through a private label credit card offered by Amazon.  * PrivateLabelCreditCardRefund - The amount that Amazon returns to the seller if the order that is bought using a private label credit card offered by Amazon is refunded.  * CollectOnDeliveryRevenue - The COD amount that the seller collected directly from the buyer.  * CollectOnDeliveryRefund - The amount that Amazon refunds to the buyer if an order paid for by COD is refunded.
-     * @type {string}
-     * @memberof DirectPayment
      */
     'DirectPaymentType'?: string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof DirectPayment
-     */
     'DirectPaymentAmount'?: Currency;
 }

package/dist/types/api-model/models/failed-adhoc-disbursement-event.d.ts

@@ -12,50 +12,31 @@
 import type { Currency } from './currency';
 /**
  * Failed ad hoc disbursement event list.
- * @export
- * @interface FailedAdhocDisbursementEvent
  */
 export interface FailedAdhocDisbursementEvent {
     /**
      * The type of fund transfer.   Example \"Refund\"
-     * @type {string}
-     * @memberof FailedAdhocDisbursementEvent
      */
     'FundsTransfersType'?: string;
     /**
      * The transfer identifier.
-     * @type {string}
-     * @memberof FailedAdhocDisbursementEvent
      */
     'TransferId'?: string;
     /**
      * The disbursement identifier.
-     * @type {string}
-     * @memberof FailedAdhocDisbursementEvent
      */
     'DisbursementId'?: string;
     /**
      * The type of payment for disbursement.   Example `CREDIT_CARD`
-     * @type {string}
-     * @memberof FailedAdhocDisbursementEvent
      */
     'PaymentDisbursementType'?: string;
     /**
      * The status of the failed `AdhocDisbursement`.   Example `HARD_DECLINED`
-     * @type {string}
-     * @memberof FailedAdhocDisbursementEvent
      */
     'Status'?: string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof FailedAdhocDisbursementEvent
-     */
     'TransferAmount'?: Currency;
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof FailedAdhocDisbursementEvent
      */
     'PostedDate'?: string;
 }

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

@@ -12,32 +12,16 @@
 import type { Currency } from './currency';
 /**
  * A payment event for Fulfillment by Amazon (FBA) inventory liquidation. This event is used only in the US marketplace.
- * @export
- * @interface FBALiquidationEvent
  */
 export interface FBALiquidationEvent {
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof FBALiquidationEvent
      */
     'PostedDate'?: string;
     /**
      * The identifier for the original removal order.
-     * @type {string}
-     * @memberof FBALiquidationEvent
      */
     'OriginalRemovalOrderId'?: string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof FBALiquidationEvent
-     */
     'LiquidationProceedsAmount'?: Currency;
-    /**
-     *
-     * @type {Currency}
-     * @memberof FBALiquidationEvent
-     */
     'LiquidationFeeAmount'?: Currency;
 }

package/dist/types/api-model/models/fee-component.d.ts

@@ -12,20 +12,11 @@
 import type { Currency } from './currency';
 /**
  * A fee associated with the event.
- * @export
- * @interface FeeComponent
  */
 export interface FeeComponent {
     /**
      * The type of fee. For more information about Selling on Amazon fees, see [Selling on Amazon Fee Schedule](https://sellercentral.amazon.com/gp/help/200336920) on Seller Central. For more information about Fulfillment by Amazon fees, see [FBA features, services and fees](https://sellercentral.amazon.com/gp/help/201074400) on Seller Central.
-     * @type {string}
-     * @memberof FeeComponent
      */
     'FeeType'?: string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof FeeComponent
-     */
     'FeeAmount'?: Currency;
 }

package/dist/types/api-model/models/financial-event-group.d.ts

@@ -12,74 +12,41 @@
 import type { Currency } from './currency';
 /**
  * Information related to a financial event group.
- * @export
- * @interface FinancialEventGroup
  */
 export interface FinancialEventGroup {
     /**
      * A unique identifier for the financial event group.
-     * @type {string}
-     * @memberof FinancialEventGroup
      */
     'FinancialEventGroupId'?: string;
     /**
      * The processing status of the financial event group indicates whether the balance of the financial event group is settled.  Possible values:  * Open  * Closed
-     * @type {string}
-     * @memberof FinancialEventGroup
      */
     'ProcessingStatus'?: string;
     /**
      * The status of the fund transfer.
-     * @type {string}
-     * @memberof FinancialEventGroup
      */
     'FundTransferStatus'?: string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof FinancialEventGroup
-     */
     'OriginalTotal'?: Currency;
-    /**
-     *
-     * @type {Currency}
-     * @memberof FinancialEventGroup
-     */
     'ConvertedTotal'?: Currency;
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof FinancialEventGroup
      */
     'FundTransferDate'?: string;
     /**
      * The trace identifier used by sellers to look up transactions externally.
-     * @type {string}
-     * @memberof FinancialEventGroup
      */
     'TraceId'?: string;
     /**
      * The account tail of the payment instrument.
-     * @type {string}
-     * @memberof FinancialEventGroup
      */
     'AccountTail'?: string;
-    /**
-     *
-     * @type {Currency}
-     * @memberof FinancialEventGroup
-     */
     'BeginningBalance'?: Currency;
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof FinancialEventGroup
      */
     'FinancialEventGroupStart'?: string;
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof FinancialEventGroup
      */
     'FinancialEventGroupEnd'?: string;
 }

package/dist/types/api-model/models/financial-events.d.ts

@@ -39,206 +39,138 @@ import type { TrialShipmentEvent } from './trial-shipment-event';
 import type { ValueAddedServiceChargeEvent } from './value-added-service-charge-event';
 /**
  * Contains all information related to a financial event.
- * @export
- * @interface FinancialEvents
  */
 export interface FinancialEvents {
     /**
      * A list of shipment event information.
-     * @type {Array<ShipmentEvent>}
-     * @memberof FinancialEvents
      */
     'ShipmentEventList'?: Array<ShipmentEvent>;
     /**
      * A list of `ShipmentEvent` items.
-     * @type {Array<ShipmentEvent>}
-     * @memberof FinancialEvents
      */
     'ShipmentSettleEventList'?: Array<ShipmentEvent>;
     /**
      * A list of shipment event information.
-     * @type {Array<ShipmentEvent>}
-     * @memberof FinancialEvents
      */
     'RefundEventList'?: Array<ShipmentEvent>;
     /**
      * A list of shipment event information.
-     * @type {Array<ShipmentEvent>}
-     * @memberof FinancialEvents
      */
     'GuaranteeClaimEventList'?: Array<ShipmentEvent>;
     /**
      * A list of shipment event information.
-     * @type {Array<ShipmentEvent>}
-     * @memberof FinancialEvents
      */
     'ChargebackEventList'?: Array<ShipmentEvent>;
     /**
      * A list of events related to the seller\'s Pay with Amazon account.
-     * @type {Array<PayWithAmazonEvent>}
-     * @memberof FinancialEvents
      */
     'PayWithAmazonEventList'?: Array<PayWithAmazonEvent>;
     /**
      * A list of information about solution provider credits.
-     * @type {Array<SolutionProviderCreditEvent>}
-     * @memberof FinancialEvents
      */
     'ServiceProviderCreditEventList'?: Array<SolutionProviderCreditEvent>;
     /**
      * A list of information about Retrocharge or RetrochargeReversal events.
-     * @type {Array<RetrochargeEvent>}
-     * @memberof FinancialEvents
      */
     'RetrochargeEventList'?: Array<RetrochargeEvent>;
     /**
      * A list of rental transaction event information.
-     * @type {Array<RentalTransactionEvent>}
-     * @memberof FinancialEvents
      */
     'RentalTransactionEventList'?: Array<RentalTransactionEvent>;
     /**
      * A list of sponsored products payment events.
-     * @type {Array<ProductAdsPaymentEvent>}
-     * @memberof FinancialEvents
      */
     'ProductAdsPaymentEventList'?: Array<ProductAdsPaymentEvent>;
     /**
      * A list of information about service fee events.
-     * @type {Array<ServiceFeeEvent>}
-     * @memberof FinancialEvents
      */
     'ServiceFeeEventList'?: Array<ServiceFeeEvent>;
     /**
      * A list of payment events for deal-related fees.
-     * @type {Array<SellerDealPaymentEvent>}
-     * @memberof FinancialEvents
      */
     'SellerDealPaymentEventList'?: Array<SellerDealPaymentEvent>;
     /**
      * A list of debt recovery event information.
-     * @type {Array<DebtRecoveryEvent>}
-     * @memberof FinancialEvents
      */
     'DebtRecoveryEventList'?: Array<DebtRecoveryEvent>;
     /**
      * A list of loan servicing events.
-     * @type {Array<LoanServicingEvent>}
-     * @memberof FinancialEvents
      */
     'LoanServicingEventList'?: Array<LoanServicingEvent>;
     /**
      * A list of adjustment event information for the seller\'s account.
-     * @type {Array<AdjustmentEvent>}
-     * @memberof FinancialEvents
      */
     'AdjustmentEventList'?: Array<AdjustmentEvent>;
     /**
      * A list of SAFETReimbursementEvents.
-     * @type {Array<SAFETReimbursementEvent>}
-     * @memberof FinancialEvents
      */
     'SAFETReimbursementEventList'?: Array<SAFETReimbursementEvent>;
     /**
      * A list of information about fee events for the Early Reviewer Program.
-     * @type {Array<SellerReviewEnrollmentPaymentEvent>}
-     * @memberof FinancialEvents
      */
     'SellerReviewEnrollmentPaymentEventList'?: Array<SellerReviewEnrollmentPaymentEvent>;
     /**
      * A list of FBA inventory liquidation payment events.
-     * @type {Array<FBALiquidationEvent>}
-     * @memberof FinancialEvents
      */
     'FBALiquidationEventList'?: Array<FBALiquidationEvent>;
     /**
      * A list of coupon payment event information.
-     * @type {Array<CouponPaymentEvent>}
-     * @memberof FinancialEvents
      */
     'CouponPaymentEventList'?: Array<CouponPaymentEvent>;
     /**
      * A list of fee events related to Amazon Imaging services.
-     * @type {Array<ImagingServicesFeeEvent>}
-     * @memberof FinancialEvents
      */
     'ImagingServicesFeeEventList'?: Array<ImagingServicesFeeEvent>;
     /**
      * A list of network commingling transaction events.
-     * @type {Array<NetworkComminglingTransactionEvent>}
-     * @memberof FinancialEvents
      */
     'NetworkComminglingTransactionEventList'?: Array<NetworkComminglingTransactionEvent>;
     /**
      * A list of expense information related to an affordability promotion.
-     * @type {Array<AffordabilityExpenseEvent>}
-     * @memberof FinancialEvents
      */
     'AffordabilityExpenseEventList'?: Array<AffordabilityExpenseEvent>;
     /**
      * A list of expense information related to an affordability promotion.
-     * @type {Array<AffordabilityExpenseEvent>}
-     * @memberof FinancialEvents
      */
     'AffordabilityExpenseReversalEventList'?: Array<AffordabilityExpenseEvent>;
     /**
      * A list of removal shipment event information.
-     * @type {Array<RemovalShipmentEvent>}
-     * @memberof FinancialEvents
      */
     'RemovalShipmentEventList'?: Array<RemovalShipmentEvent>;
     /**
      * A comma-delimited list of Removal shipmentAdjustment details for FBA inventory.
-     * @type {Array<RemovalShipmentAdjustmentEvent>}
-     * @memberof FinancialEvents
      */
     'RemovalShipmentAdjustmentEventList'?: Array<RemovalShipmentAdjustmentEvent>;
     /**
      * A list of information about trial shipment financial events.
-     * @type {Array<TrialShipmentEvent>}
-     * @memberof FinancialEvents
      */
     'TrialShipmentEventList'?: Array<TrialShipmentEvent>;
     /**
      * A list of `TDSReimbursementEvent` items.
-     * @type {Array<TDSReimbursementEvent>}
-     * @memberof FinancialEvents
      */
     'TDSReimbursementEventList'?: Array<TDSReimbursementEvent>;
     /**
      * A list of `AdhocDisbursement` events.
-     * @type {Array<AdhocDisbursementEvent>}
-     * @memberof FinancialEvents
      */
     'AdhocDisbursementEventList'?: Array<AdhocDisbursementEvent>;
     /**
      * A list of `TaxWithholding` events.
-     * @type {Array<TaxWithholdingEvent>}
-     * @memberof FinancialEvents
      */
     'TaxWithholdingEventList'?: Array<TaxWithholdingEvent>;
     /**
      * A list of charge refund events.
-     * @type {Array<ChargeRefundEvent>}
-     * @memberof FinancialEvents
      */
     'ChargeRefundEventList'?: Array<ChargeRefundEvent>;
     /**
      * A list of `FailedAdhocDisbursementEvent`s.
-     * @type {Array<FailedAdhocDisbursementEvent>}
-     * @memberof FinancialEvents
      */
     'FailedAdhocDisbursementEventList'?: Array<FailedAdhocDisbursementEvent>;
     /**
      * A list of `ValueAddedServiceCharge` events.
-     * @type {Array<ValueAddedServiceChargeEvent>}
-     * @memberof FinancialEvents
      */
     'ValueAddedServiceChargeEventList'?: Array<ValueAddedServiceChargeEvent>;
     /**
      * A list of `CapacityReservationBillingEvent` events.
-     * @type {Array<CapacityReservationBillingEvent>}
-     * @memberof FinancialEvents
      */
     'CapacityReservationBillingEventList'?: Array<CapacityReservationBillingEvent>;
 }

package/dist/types/api-model/models/imaging-services-fee-event.d.ts

@@ -12,32 +12,22 @@
 import type { FeeComponent } from './fee-component';
 /**
  * A fee event related to Amazon Imaging services.
- * @export
- * @interface ImagingServicesFeeEvent
  */
 export interface ImagingServicesFeeEvent {
     /**
      * The identifier for the imaging services request.
-     * @type {string}
-     * @memberof ImagingServicesFeeEvent
      */
     'ImagingRequestBillingItemID'?: string;
     /**
      * The Amazon Standard Identification Number (ASIN) of the item for which the imaging service was requested.
-     * @type {string}
-     * @memberof ImagingServicesFeeEvent
      */
     'ASIN'?: string;
     /**
      * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
-     * @type {string}
-     * @memberof ImagingServicesFeeEvent
      */
     'PostedDate'?: string;
     /**
      * A list of fee component information.
-     * @type {Array<FeeComponent>}
-     * @memberof ImagingServicesFeeEvent
      */
     'FeeList'?: Array<FeeComponent>;
 }

package/dist/types/api-model/models/list-financial-event-groups-payload.d.ts

@@ -12,20 +12,14 @@
 import type { FinancialEventGroup } from './financial-event-group';
 /**
  * The payload for the listFinancialEventGroups operation.
- * @export
- * @interface ListFinancialEventGroupsPayload
  */
 export interface ListFinancialEventGroupsPayload {
     /**
      * When present and not empty, pass this string token in the next request to return the next response page.
-     * @type {string}
-     * @memberof ListFinancialEventGroupsPayload
      */
     'NextToken'?: string;
     /**
      * A list of financial event group information.
-     * @type {Array<FinancialEventGroup>}
-     * @memberof ListFinancialEventGroupsPayload
      */
     'FinancialEventGroupList'?: Array<FinancialEventGroup>;
 }

package/dist/types/api-model/models/list-financial-event-groups-response.d.ts

@@ -12,20 +12,11 @@
 import type { ListFinancialEventGroupsPayload } from './list-financial-event-groups-payload';
 /**
  * The response schema for the listFinancialEventGroups operation.
- * @export
- * @interface ListFinancialEventGroupsResponse
  */
 export interface ListFinancialEventGroupsResponse {
-    /**
-     *
-     * @type {ListFinancialEventGroupsPayload}
-     * @memberof ListFinancialEventGroupsResponse
-     */
     'payload'?: ListFinancialEventGroupsPayload;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof ListFinancialEventGroupsResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/list-financial-events-payload.d.ts

@@ -12,20 +12,11 @@
 import type { FinancialEvents } from './financial-events';
 /**
  * The payload for the listFinancialEvents operation.
- * @export
- * @interface ListFinancialEventsPayload
  */
 export interface ListFinancialEventsPayload {
     /**
      * When present and not empty, pass this string token in the next request to return the next response page.
-     * @type {string}
-     * @memberof ListFinancialEventsPayload
      */
     'NextToken'?: string;
-    /**
-     *
-     * @type {FinancialEvents}
-     * @memberof ListFinancialEventsPayload
-     */
     'FinancialEvents'?: FinancialEvents;
 }

package/dist/types/api-model/models/list-financial-events-response.d.ts

@@ -12,20 +12,11 @@
 import type { ListFinancialEventsPayload } from './list-financial-events-payload';
 /**
  * The response schema for the listFinancialEvents operation.
- * @export
- * @interface ListFinancialEventsResponse
  */
 export interface ListFinancialEventsResponse {
-    /**
-     *
-     * @type {ListFinancialEventsPayload}
-     * @memberof ListFinancialEventsResponse
-     */
     'payload'?: ListFinancialEventsPayload;
     /**
      * A list of error responses returned when a request is unsuccessful.
-     * @type {Array<Error>}
-     * @memberof ListFinancialEventsResponse
      */
     'errors'?: Array<Error>;
 }