@wix/auto_sdk_ecom_order-transactions 1.0.5 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -341,7 +341,7 @@ export interface Refund {
341
341
  */
342
342
  createdDate?: Date | null;
343
343
  /**
344
- * Aggregated refund status
344
+ * Aggregated refund summary.
345
345
  * @readonly
346
346
  */
347
347
  summary?: AggregatedRefundSummary;
@@ -488,29 +488,29 @@ export interface ShippingRefund {
488
488
  amount?: Price;
489
489
  }
490
490
  export interface AggregatedRefundSummary {
491
- /** Total refund amount requested */
491
+ /** Total amount requested for refund. */
492
492
  requestedRefund?: Price;
493
- /** Pending refund amount */
493
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
494
494
  pendingRefund?: Price;
495
- /** Refunded amount: portion of requested_refund_amount that succeeded */
495
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
496
496
  refunded?: Price;
497
- /** Failed refund amount: portion of requested_refund_amount that failed */
497
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
498
498
  failedRefundAmount?: Price;
499
- /** `true`: at least one refund transaction is still in PENDING status */
499
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
500
500
  pending?: boolean;
501
- /** Breakdown of refunded items. Available only after refund is completed */
501
+ /** Breakdown of refunded items. Available only after refund is complete. */
502
502
  breakdown?: RefundItemsBreakdown;
503
503
  }
504
504
  export interface RefundItemsBreakdown {
505
505
  /**
506
- * Refunded line items and amount refunded for each of them.
506
+ * Refunded line items and the amount refunded for each.
507
507
  * @maxSize 300
508
508
  */
509
509
  lineItems?: LineItemRefundSummary[];
510
510
  }
511
511
  export interface LineItemRefundSummary {
512
512
  /**
513
- * Line item ID the refunded line item.
513
+ * ID of the refunded line item.
514
514
  * @format GUID
515
515
  */
516
516
  lineItemId?: string;
@@ -341,7 +341,7 @@ export interface Refund {
341
341
  */
342
342
  _createdDate?: Date | null;
343
343
  /**
344
- * Aggregated refund status
344
+ * Aggregated refund summary.
345
345
  * @readonly
346
346
  */
347
347
  summary?: AggregatedRefundSummary;
@@ -488,29 +488,29 @@ export interface ShippingRefund {
488
488
  amount?: Price;
489
489
  }
490
490
  export interface AggregatedRefundSummary {
491
- /** Total refund amount requested */
491
+ /** Total amount requested for refund. */
492
492
  requestedRefund?: Price;
493
- /** Pending refund amount */
493
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
494
494
  pendingRefund?: Price;
495
- /** Refunded amount: portion of requested_refund_amount that succeeded */
495
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
496
496
  refunded?: Price;
497
- /** Failed refund amount: portion of requested_refund_amount that failed */
497
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
498
498
  failedRefundAmount?: Price;
499
- /** `true`: at least one refund transaction is still in PENDING status */
499
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
500
500
  pending?: boolean;
501
- /** Breakdown of refunded items. Available only after refund is completed */
501
+ /** Breakdown of refunded items. Available only after refund is complete. */
502
502
  breakdown?: RefundItemsBreakdown;
503
503
  }
504
504
  export interface RefundItemsBreakdown {
505
505
  /**
506
- * Refunded line items and amount refunded for each of them.
506
+ * Refunded line items and the amount refunded for each.
507
507
  * @maxSize 300
508
508
  */
509
509
  lineItems?: LineItemRefundSummary[];
510
510
  }
511
511
  export interface LineItemRefundSummary {
512
512
  /**
513
- * Line item ID the refunded line item.
513
+ * ID of the refunded line item.
514
514
  * @format GUID
515
515
  */
516
516
  lineItemId?: string;
@@ -341,7 +341,7 @@ export interface Refund {
341
341
  */
342
342
  createdDate?: Date | null;
343
343
  /**
344
- * Aggregated refund status
344
+ * Aggregated refund summary.
345
345
  * @readonly
346
346
  */
347
347
  summary?: AggregatedRefundSummary;
@@ -488,29 +488,29 @@ export interface ShippingRefund {
488
488
  amount?: Price;
489
489
  }
490
490
  export interface AggregatedRefundSummary {
491
- /** Total refund amount requested */
491
+ /** Total amount requested for refund. */
492
492
  requestedRefund?: Price;
493
- /** Pending refund amount */
493
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
494
494
  pendingRefund?: Price;
495
- /** Refunded amount: portion of requested_refund_amount that succeeded */
495
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
496
496
  refunded?: Price;
497
- /** Failed refund amount: portion of requested_refund_amount that failed */
497
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
498
498
  failedRefundAmount?: Price;
499
- /** `true`: at least one refund transaction is still in PENDING status */
499
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
500
500
  pending?: boolean;
501
- /** Breakdown of refunded items. Available only after refund is completed */
501
+ /** Breakdown of refunded items. Available only after refund is complete. */
502
502
  breakdown?: RefundItemsBreakdown;
503
503
  }
504
504
  export interface RefundItemsBreakdown {
505
505
  /**
506
- * Refunded line items and amount refunded for each of them.
506
+ * Refunded line items and the amount refunded for each.
507
507
  * @maxSize 300
508
508
  */
509
509
  lineItems?: LineItemRefundSummary[];
510
510
  }
511
511
  export interface LineItemRefundSummary {
512
512
  /**
513
- * Line item ID the refunded line item.
513
+ * ID of the refunded line item.
514
514
  * @format GUID
515
515
  */
516
516
  lineItemId?: string;
@@ -341,7 +341,7 @@ export interface Refund {
341
341
  */
342
342
  _createdDate?: Date | null;
343
343
  /**
344
- * Aggregated refund status
344
+ * Aggregated refund summary.
345
345
  * @readonly
346
346
  */
347
347
  summary?: AggregatedRefundSummary;
@@ -488,29 +488,29 @@ export interface ShippingRefund {
488
488
  amount?: Price;
489
489
  }
490
490
  export interface AggregatedRefundSummary {
491
- /** Total refund amount requested */
491
+ /** Total amount requested for refund. */
492
492
  requestedRefund?: Price;
493
- /** Pending refund amount */
493
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
494
494
  pendingRefund?: Price;
495
- /** Refunded amount: portion of requested_refund_amount that succeeded */
495
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
496
496
  refunded?: Price;
497
- /** Failed refund amount: portion of requested_refund_amount that failed */
497
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
498
498
  failedRefundAmount?: Price;
499
- /** `true`: at least one refund transaction is still in PENDING status */
499
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
500
500
  pending?: boolean;
501
- /** Breakdown of refunded items. Available only after refund is completed */
501
+ /** Breakdown of refunded items. Available only after refund is complete. */
502
502
  breakdown?: RefundItemsBreakdown;
503
503
  }
504
504
  export interface RefundItemsBreakdown {
505
505
  /**
506
- * Refunded line items and amount refunded for each of them.
506
+ * Refunded line items and the amount refunded for each.
507
507
  * @maxSize 300
508
508
  */
509
509
  lineItems?: LineItemRefundSummary[];
510
510
  }
511
511
  export interface LineItemRefundSummary {
512
512
  /**
513
- * Line item ID the refunded line item.
513
+ * ID of the refunded line item.
514
514
  * @format GUID
515
515
  */
516
516
  lineItemId?: string;
@@ -341,7 +341,7 @@ export interface Refund {
341
341
  */
342
342
  createdDate?: Date | null;
343
343
  /**
344
- * Aggregated refund status
344
+ * Aggregated refund summary.
345
345
  * @readonly
346
346
  */
347
347
  summary?: AggregatedRefundSummary;
@@ -488,29 +488,29 @@ export interface ShippingRefund {
488
488
  amount?: Price;
489
489
  }
490
490
  export interface AggregatedRefundSummary {
491
- /** Total refund amount requested */
491
+ /** Total amount requested for refund. */
492
492
  requestedRefund?: Price;
493
- /** Pending refund amount */
493
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
494
494
  pendingRefund?: Price;
495
- /** Refunded amount: portion of requested_refund_amount that succeeded */
495
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
496
496
  refunded?: Price;
497
- /** Failed refund amount: portion of requested_refund_amount that failed */
497
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
498
498
  failedRefundAmount?: Price;
499
- /** `true`: at least one refund transaction is still in PENDING status */
499
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
500
500
  pending?: boolean;
501
- /** Breakdown of refunded items. Available only after refund is completed */
501
+ /** Breakdown of refunded items. Available only after refund is complete. */
502
502
  breakdown?: RefundItemsBreakdown;
503
503
  }
504
504
  export interface RefundItemsBreakdown {
505
505
  /**
506
- * Refunded line items and amount refunded for each of them.
506
+ * Refunded line items and the amount refunded for each.
507
507
  * @maxSize 300
508
508
  */
509
509
  lineItems?: LineItemRefundSummary[];
510
510
  }
511
511
  export interface LineItemRefundSummary {
512
512
  /**
513
- * Line item ID the refunded line item.
513
+ * ID of the refunded line item.
514
514
  * @format GUID
515
515
  */
516
516
  lineItemId?: string;
@@ -382,7 +382,7 @@ export interface Refund {
382
382
  */
383
383
  _createdDate?: Date | null;
384
384
  /**
385
- * Aggregated refund status
385
+ * Aggregated refund summary.
386
386
  * @readonly
387
387
  */
388
388
  summary?: AggregatedRefundSummary;
@@ -529,29 +529,29 @@ export interface ShippingRefund {
529
529
  amount?: Price;
530
530
  }
531
531
  export interface AggregatedRefundSummary {
532
- /** Total refund amount requested */
532
+ /** Total amount requested for refund. */
533
533
  requestedRefund?: Price;
534
- /** Pending refund amount */
534
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
535
535
  pendingRefund?: Price;
536
- /** Refunded amount: portion of requested_refund_amount that succeeded */
536
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
537
537
  refunded?: Price;
538
- /** Failed refund amount: portion of requested_refund_amount that failed */
538
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
539
539
  failedRefundAmount?: Price;
540
- /** `true`: at least one refund transaction is still in PENDING status */
540
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
541
541
  pending?: boolean;
542
- /** Breakdown of refunded items. Available only after refund is completed */
542
+ /** Breakdown of refunded items. Available only after refund is complete. */
543
543
  breakdown?: RefundItemsBreakdown;
544
544
  }
545
545
  export interface RefundItemsBreakdown {
546
546
  /**
547
- * Refunded line items and amount refunded for each of them.
547
+ * Refunded line items and the amount refunded for each.
548
548
  * @maxSize 300
549
549
  */
550
550
  lineItems?: LineItemRefundSummary[];
551
551
  }
552
552
  export interface LineItemRefundSummary {
553
553
  /**
554
- * Line item ID the refunded line item.
554
+ * ID of the refunded line item.
555
555
  * @format GUID
556
556
  */
557
557
  lineItemId?: string;
@@ -341,7 +341,7 @@ export interface Refund {
341
341
  */
342
342
  createdDate?: Date | null;
343
343
  /**
344
- * Aggregated refund status
344
+ * Aggregated refund summary.
345
345
  * @readonly
346
346
  */
347
347
  summary?: AggregatedRefundSummary;
@@ -488,29 +488,29 @@ export interface ShippingRefund {
488
488
  amount?: Price;
489
489
  }
490
490
  export interface AggregatedRefundSummary {
491
- /** Total refund amount requested */
491
+ /** Total amount requested for refund. */
492
492
  requestedRefund?: Price;
493
- /** Pending refund amount */
493
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
494
494
  pendingRefund?: Price;
495
- /** Refunded amount: portion of requested_refund_amount that succeeded */
495
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
496
496
  refunded?: Price;
497
- /** Failed refund amount: portion of requested_refund_amount that failed */
497
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
498
498
  failedRefundAmount?: Price;
499
- /** `true`: at least one refund transaction is still in PENDING status */
499
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
500
500
  pending?: boolean;
501
- /** Breakdown of refunded items. Available only after refund is completed */
501
+ /** Breakdown of refunded items. Available only after refund is complete. */
502
502
  breakdown?: RefundItemsBreakdown;
503
503
  }
504
504
  export interface RefundItemsBreakdown {
505
505
  /**
506
- * Refunded line items and amount refunded for each of them.
506
+ * Refunded line items and the amount refunded for each.
507
507
  * @maxSize 300
508
508
  */
509
509
  lineItems?: LineItemRefundSummary[];
510
510
  }
511
511
  export interface LineItemRefundSummary {
512
512
  /**
513
- * Line item ID the refunded line item.
513
+ * ID of the refunded line item.
514
514
  * @format GUID
515
515
  */
516
516
  lineItemId?: string;
@@ -382,7 +382,7 @@ export interface Refund {
382
382
  */
383
383
  _createdDate?: Date | null;
384
384
  /**
385
- * Aggregated refund status
385
+ * Aggregated refund summary.
386
386
  * @readonly
387
387
  */
388
388
  summary?: AggregatedRefundSummary;
@@ -529,29 +529,29 @@ export interface ShippingRefund {
529
529
  amount?: Price;
530
530
  }
531
531
  export interface AggregatedRefundSummary {
532
- /** Total refund amount requested */
532
+ /** Total amount requested for refund. */
533
533
  requestedRefund?: Price;
534
- /** Pending refund amount */
534
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
535
535
  pendingRefund?: Price;
536
- /** Refunded amount: portion of requested_refund_amount that succeeded */
536
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
537
537
  refunded?: Price;
538
- /** Failed refund amount: portion of requested_refund_amount that failed */
538
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
539
539
  failedRefundAmount?: Price;
540
- /** `true`: at least one refund transaction is still in PENDING status */
540
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
541
541
  pending?: boolean;
542
- /** Breakdown of refunded items. Available only after refund is completed */
542
+ /** Breakdown of refunded items. Available only after refund is complete. */
543
543
  breakdown?: RefundItemsBreakdown;
544
544
  }
545
545
  export interface RefundItemsBreakdown {
546
546
  /**
547
- * Refunded line items and amount refunded for each of them.
547
+ * Refunded line items and the amount refunded for each.
548
548
  * @maxSize 300
549
549
  */
550
550
  lineItems?: LineItemRefundSummary[];
551
551
  }
552
552
  export interface LineItemRefundSummary {
553
553
  /**
554
- * Line item ID the refunded line item.
554
+ * ID of the refunded line item.
555
555
  * @format GUID
556
556
  */
557
557
  lineItemId?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_ecom_order-transactions",
3
- "version": "1.0.5",
3
+ "version": "1.0.6",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -48,5 +48,5 @@
48
48
  "fqdn": "wix.ecom.v1.order_transactions"
49
49
  }
50
50
  },
51
- "falconPackageHash": "332dfc3a35a87868feef3aa9dc505fb72394ed0ebc8c66ba9e44af1e"
51
+ "falconPackageHash": "3858a58be7ba5f635e2ff3099a185417a6901a32caf2bca58bcf1954"
52
52
  }