@teemill/platform 0.58.0 → 0.60.0
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.
- package/README.md +2 -2
- package/api.ts +61 -9
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +60 -8
- package/dist/api.js +4 -2
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +60 -8
- package/dist/esm/api.js +4 -2
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AmendmentLog.md +5 -3
- package/docs/Order.md +13 -7
- package/docs/OrderItem.md +6 -4
- package/docs/OrderStatus.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.60.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.60.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.60.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -97,15 +97,22 @@ export interface AmendmentLog {
|
|
|
97
97
|
*/
|
|
98
98
|
'id': string;
|
|
99
99
|
/**
|
|
100
|
-
* A reference to the order
|
|
100
|
+
* A reference to the order that was amended.
|
|
101
101
|
*/
|
|
102
|
-
'
|
|
102
|
+
'orderId'?: string | null;
|
|
103
103
|
/**
|
|
104
|
-
* A reference to the
|
|
104
|
+
* A reference to the order item that was amended. Null for shipping_refund amendments.
|
|
105
105
|
*/
|
|
106
|
-
'
|
|
106
|
+
'orderItemId'?: string | null;
|
|
107
|
+
/**
|
|
108
|
+
* A reference to the top level order item that was amended, useful for finding the original item within a chain of exchanges, for example. Null for shipping_refund amendments.
|
|
109
|
+
*/
|
|
110
|
+
'originalOrderItemId'?: string | null;
|
|
107
111
|
'amendmentType': AmendmentLogAmendmentTypeEnum;
|
|
108
|
-
|
|
112
|
+
/**
|
|
113
|
+
* The quantity of the item that was amended, if applicable to the amendment type.
|
|
114
|
+
*/
|
|
115
|
+
'quantity'?: number | null;
|
|
109
116
|
/**
|
|
110
117
|
* ISO 8601 Timestamp
|
|
111
118
|
*/
|
|
@@ -114,7 +121,8 @@ export interface AmendmentLog {
|
|
|
114
121
|
|
|
115
122
|
export const AmendmentLogAmendmentTypeEnum = {
|
|
116
123
|
Refund: 'refund',
|
|
117
|
-
Exchange: 'exchange'
|
|
124
|
+
Exchange: 'exchange',
|
|
125
|
+
ShippingRefund: 'shipping_refund'
|
|
118
126
|
} as const;
|
|
119
127
|
|
|
120
128
|
export type AmendmentLogAmendmentTypeEnum = typeof AmendmentLogAmendmentTypeEnum[keyof typeof AmendmentLogAmendmentTypeEnum];
|
|
@@ -644,12 +652,42 @@ export interface Order {
|
|
|
644
652
|
'fulfillments'?: Array<Fulfillment>;
|
|
645
653
|
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
646
654
|
'items': Array<OrderItem>;
|
|
655
|
+
/**
|
|
656
|
+
* The total price of the order including tax and after discounts.
|
|
657
|
+
*/
|
|
647
658
|
'totalPrice'?: Price;
|
|
659
|
+
/**
|
|
660
|
+
* The total tax amount for the order.
|
|
661
|
+
*/
|
|
648
662
|
'taxPrice'?: Price;
|
|
663
|
+
/**
|
|
664
|
+
* The net items price (including shipping), excluding tax and after discounts.
|
|
665
|
+
*/
|
|
649
666
|
'subtotalPrice'?: Price;
|
|
667
|
+
/**
|
|
668
|
+
* The total discount amount applied to the order.
|
|
669
|
+
*/
|
|
650
670
|
'discountPrice'?: Price;
|
|
651
|
-
|
|
671
|
+
/**
|
|
672
|
+
* The total shipping cost for the order excluding tax.
|
|
673
|
+
*/
|
|
652
674
|
'shippingPrice'?: Price;
|
|
675
|
+
/**
|
|
676
|
+
* The total items price for the order excluding tax
|
|
677
|
+
*/
|
|
678
|
+
'itemsPrice'?: Price;
|
|
679
|
+
/**
|
|
680
|
+
* The coupon applied to the order, if any.
|
|
681
|
+
*/
|
|
682
|
+
'coupon'?: Coupon | null;
|
|
683
|
+
/**
|
|
684
|
+
* URL to page containing payment instructions for the payee. Only present when the order is in \'new\' status.
|
|
685
|
+
*/
|
|
686
|
+
'paymentLink'?: string | null;
|
|
687
|
+
/**
|
|
688
|
+
* URL to the order receipt page. Only present when the order is not in \'new\' status.
|
|
689
|
+
*/
|
|
690
|
+
'receiptLink'?: string | null;
|
|
653
691
|
'origin'?: Origin;
|
|
654
692
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
655
693
|
'project': Project;
|
|
@@ -700,12 +738,25 @@ export interface OrderItem {
|
|
|
700
738
|
* Images
|
|
701
739
|
*/
|
|
702
740
|
'images'?: Array<Image>;
|
|
741
|
+
/**
|
|
742
|
+
* Gross total with discount applied
|
|
743
|
+
*/
|
|
703
744
|
'totalPrice'?: Price;
|
|
704
745
|
/**
|
|
705
|
-
* This is an estimate until the order has been confirmed
|
|
746
|
+
* The tax amount for this line item after discounts. This is an estimate until the order has been confirmed.
|
|
706
747
|
*/
|
|
707
748
|
'taxPrice'?: Price;
|
|
749
|
+
/**
|
|
750
|
+
* The price for this line item, including tax and before discounts.
|
|
751
|
+
*/
|
|
708
752
|
'subtotalPrice'?: Price;
|
|
753
|
+
/**
|
|
754
|
+
* The net price for this line item, excluding tax and before discounts.
|
|
755
|
+
*/
|
|
756
|
+
'subtotalExTaxPrice'?: Price;
|
|
757
|
+
/**
|
|
758
|
+
* The discount amount applied to this line item.
|
|
759
|
+
*/
|
|
709
760
|
'discountPrice'?: Price;
|
|
710
761
|
'amendmentLogs'?: Array<AmendmentLog>;
|
|
711
762
|
}
|
|
@@ -728,6 +779,7 @@ export interface OrderPaymentMethod {
|
|
|
728
779
|
export const OrderStatus = {
|
|
729
780
|
New: 'new',
|
|
730
781
|
Paid: 'paid',
|
|
782
|
+
PaymentPending: 'payment_pending',
|
|
731
783
|
Processing: 'processing',
|
|
732
784
|
Complete: 'complete',
|
|
733
785
|
Refunded: 'refunded',
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.60.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -84,15 +84,22 @@ export interface AmendmentLog {
|
|
|
84
84
|
*/
|
|
85
85
|
'id': string;
|
|
86
86
|
/**
|
|
87
|
-
* A reference to the order
|
|
87
|
+
* A reference to the order that was amended.
|
|
88
88
|
*/
|
|
89
|
-
'
|
|
89
|
+
'orderId'?: string | null;
|
|
90
90
|
/**
|
|
91
|
-
* A reference to the
|
|
91
|
+
* A reference to the order item that was amended. Null for shipping_refund amendments.
|
|
92
92
|
*/
|
|
93
|
-
'
|
|
93
|
+
'orderItemId'?: string | null;
|
|
94
|
+
/**
|
|
95
|
+
* A reference to the top level order item that was amended, useful for finding the original item within a chain of exchanges, for example. Null for shipping_refund amendments.
|
|
96
|
+
*/
|
|
97
|
+
'originalOrderItemId'?: string | null;
|
|
94
98
|
'amendmentType': AmendmentLogAmendmentTypeEnum;
|
|
95
|
-
|
|
99
|
+
/**
|
|
100
|
+
* The quantity of the item that was amended, if applicable to the amendment type.
|
|
101
|
+
*/
|
|
102
|
+
'quantity'?: number | null;
|
|
96
103
|
/**
|
|
97
104
|
* ISO 8601 Timestamp
|
|
98
105
|
*/
|
|
@@ -101,6 +108,7 @@ export interface AmendmentLog {
|
|
|
101
108
|
export declare const AmendmentLogAmendmentTypeEnum: {
|
|
102
109
|
readonly Refund: "refund";
|
|
103
110
|
readonly Exchange: "exchange";
|
|
111
|
+
readonly ShippingRefund: "shipping_refund";
|
|
104
112
|
};
|
|
105
113
|
export type AmendmentLogAmendmentTypeEnum = typeof AmendmentLogAmendmentTypeEnum[keyof typeof AmendmentLogAmendmentTypeEnum];
|
|
106
114
|
export interface ApiError {
|
|
@@ -613,12 +621,42 @@ export interface Order {
|
|
|
613
621
|
'fulfillments'?: Array<Fulfillment>;
|
|
614
622
|
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
615
623
|
'items': Array<OrderItem>;
|
|
624
|
+
/**
|
|
625
|
+
* The total price of the order including tax and after discounts.
|
|
626
|
+
*/
|
|
616
627
|
'totalPrice'?: Price;
|
|
628
|
+
/**
|
|
629
|
+
* The total tax amount for the order.
|
|
630
|
+
*/
|
|
617
631
|
'taxPrice'?: Price;
|
|
632
|
+
/**
|
|
633
|
+
* The net items price (including shipping), excluding tax and after discounts.
|
|
634
|
+
*/
|
|
618
635
|
'subtotalPrice'?: Price;
|
|
636
|
+
/**
|
|
637
|
+
* The total discount amount applied to the order.
|
|
638
|
+
*/
|
|
619
639
|
'discountPrice'?: Price;
|
|
620
|
-
|
|
640
|
+
/**
|
|
641
|
+
* The total shipping cost for the order excluding tax.
|
|
642
|
+
*/
|
|
621
643
|
'shippingPrice'?: Price;
|
|
644
|
+
/**
|
|
645
|
+
* The total items price for the order excluding tax
|
|
646
|
+
*/
|
|
647
|
+
'itemsPrice'?: Price;
|
|
648
|
+
/**
|
|
649
|
+
* The coupon applied to the order, if any.
|
|
650
|
+
*/
|
|
651
|
+
'coupon'?: Coupon | null;
|
|
652
|
+
/**
|
|
653
|
+
* URL to page containing payment instructions for the payee. Only present when the order is in \'new\' status.
|
|
654
|
+
*/
|
|
655
|
+
'paymentLink'?: string | null;
|
|
656
|
+
/**
|
|
657
|
+
* URL to the order receipt page. Only present when the order is not in \'new\' status.
|
|
658
|
+
*/
|
|
659
|
+
'receiptLink'?: string | null;
|
|
622
660
|
'origin'?: Origin;
|
|
623
661
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
624
662
|
'project': Project;
|
|
@@ -667,12 +705,25 @@ export interface OrderItem {
|
|
|
667
705
|
* Images
|
|
668
706
|
*/
|
|
669
707
|
'images'?: Array<Image>;
|
|
708
|
+
/**
|
|
709
|
+
* Gross total with discount applied
|
|
710
|
+
*/
|
|
670
711
|
'totalPrice'?: Price;
|
|
671
712
|
/**
|
|
672
|
-
* This is an estimate until the order has been confirmed
|
|
713
|
+
* The tax amount for this line item after discounts. This is an estimate until the order has been confirmed.
|
|
673
714
|
*/
|
|
674
715
|
'taxPrice'?: Price;
|
|
716
|
+
/**
|
|
717
|
+
* The price for this line item, including tax and before discounts.
|
|
718
|
+
*/
|
|
675
719
|
'subtotalPrice'?: Price;
|
|
720
|
+
/**
|
|
721
|
+
* The net price for this line item, excluding tax and before discounts.
|
|
722
|
+
*/
|
|
723
|
+
'subtotalExTaxPrice'?: Price;
|
|
724
|
+
/**
|
|
725
|
+
* The discount amount applied to this line item.
|
|
726
|
+
*/
|
|
676
727
|
'discountPrice'?: Price;
|
|
677
728
|
'amendmentLogs'?: Array<AmendmentLog>;
|
|
678
729
|
}
|
|
@@ -694,6 +745,7 @@ export interface OrderPaymentMethod {
|
|
|
694
745
|
export declare const OrderStatus: {
|
|
695
746
|
readonly New: "new";
|
|
696
747
|
readonly Paid: "paid";
|
|
748
|
+
readonly PaymentPending: "payment_pending";
|
|
697
749
|
readonly Processing: "processing";
|
|
698
750
|
readonly Complete: "complete";
|
|
699
751
|
readonly Refunded: "refunded";
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform API
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.60.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -36,7 +36,8 @@ exports.AmendOrderRequestAmendmentsInnerActionEnum = {
|
|
|
36
36
|
};
|
|
37
37
|
exports.AmendmentLogAmendmentTypeEnum = {
|
|
38
38
|
Refund: 'refund',
|
|
39
|
-
Exchange: 'exchange'
|
|
39
|
+
Exchange: 'exchange',
|
|
40
|
+
ShippingRefund: 'shipping_refund'
|
|
40
41
|
};
|
|
41
42
|
exports.ApplicationPlacementEnum = {
|
|
42
43
|
Front: 'front',
|
|
@@ -58,6 +59,7 @@ exports.EnquiryStatusEnum = {
|
|
|
58
59
|
exports.OrderStatus = {
|
|
59
60
|
New: 'new',
|
|
60
61
|
Paid: 'paid',
|
|
62
|
+
PaymentPending: 'payment_pending',
|
|
61
63
|
Processing: 'processing',
|
|
62
64
|
Complete: 'complete',
|
|
63
65
|
Refunded: 'refunded',
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.60.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -84,15 +84,22 @@ export interface AmendmentLog {
|
|
|
84
84
|
*/
|
|
85
85
|
'id': string;
|
|
86
86
|
/**
|
|
87
|
-
* A reference to the order
|
|
87
|
+
* A reference to the order that was amended.
|
|
88
88
|
*/
|
|
89
|
-
'
|
|
89
|
+
'orderId'?: string | null;
|
|
90
90
|
/**
|
|
91
|
-
* A reference to the
|
|
91
|
+
* A reference to the order item that was amended. Null for shipping_refund amendments.
|
|
92
92
|
*/
|
|
93
|
-
'
|
|
93
|
+
'orderItemId'?: string | null;
|
|
94
|
+
/**
|
|
95
|
+
* A reference to the top level order item that was amended, useful for finding the original item within a chain of exchanges, for example. Null for shipping_refund amendments.
|
|
96
|
+
*/
|
|
97
|
+
'originalOrderItemId'?: string | null;
|
|
94
98
|
'amendmentType': AmendmentLogAmendmentTypeEnum;
|
|
95
|
-
|
|
99
|
+
/**
|
|
100
|
+
* The quantity of the item that was amended, if applicable to the amendment type.
|
|
101
|
+
*/
|
|
102
|
+
'quantity'?: number | null;
|
|
96
103
|
/**
|
|
97
104
|
* ISO 8601 Timestamp
|
|
98
105
|
*/
|
|
@@ -101,6 +108,7 @@ export interface AmendmentLog {
|
|
|
101
108
|
export declare const AmendmentLogAmendmentTypeEnum: {
|
|
102
109
|
readonly Refund: "refund";
|
|
103
110
|
readonly Exchange: "exchange";
|
|
111
|
+
readonly ShippingRefund: "shipping_refund";
|
|
104
112
|
};
|
|
105
113
|
export type AmendmentLogAmendmentTypeEnum = typeof AmendmentLogAmendmentTypeEnum[keyof typeof AmendmentLogAmendmentTypeEnum];
|
|
106
114
|
export interface ApiError {
|
|
@@ -613,12 +621,42 @@ export interface Order {
|
|
|
613
621
|
'fulfillments'?: Array<Fulfillment>;
|
|
614
622
|
'deliveryEstimates'?: DeliveryEstimates | null;
|
|
615
623
|
'items': Array<OrderItem>;
|
|
624
|
+
/**
|
|
625
|
+
* The total price of the order including tax and after discounts.
|
|
626
|
+
*/
|
|
616
627
|
'totalPrice'?: Price;
|
|
628
|
+
/**
|
|
629
|
+
* The total tax amount for the order.
|
|
630
|
+
*/
|
|
617
631
|
'taxPrice'?: Price;
|
|
632
|
+
/**
|
|
633
|
+
* The net items price (including shipping), excluding tax and after discounts.
|
|
634
|
+
*/
|
|
618
635
|
'subtotalPrice'?: Price;
|
|
636
|
+
/**
|
|
637
|
+
* The total discount amount applied to the order.
|
|
638
|
+
*/
|
|
619
639
|
'discountPrice'?: Price;
|
|
620
|
-
|
|
640
|
+
/**
|
|
641
|
+
* The total shipping cost for the order excluding tax.
|
|
642
|
+
*/
|
|
621
643
|
'shippingPrice'?: Price;
|
|
644
|
+
/**
|
|
645
|
+
* The total items price for the order excluding tax
|
|
646
|
+
*/
|
|
647
|
+
'itemsPrice'?: Price;
|
|
648
|
+
/**
|
|
649
|
+
* The coupon applied to the order, if any.
|
|
650
|
+
*/
|
|
651
|
+
'coupon'?: Coupon | null;
|
|
652
|
+
/**
|
|
653
|
+
* URL to page containing payment instructions for the payee. Only present when the order is in \'new\' status.
|
|
654
|
+
*/
|
|
655
|
+
'paymentLink'?: string | null;
|
|
656
|
+
/**
|
|
657
|
+
* URL to the order receipt page. Only present when the order is not in \'new\' status.
|
|
658
|
+
*/
|
|
659
|
+
'receiptLink'?: string | null;
|
|
622
660
|
'origin'?: Origin;
|
|
623
661
|
'statusHistory'?: Array<StatusHistoryItem>;
|
|
624
662
|
'project': Project;
|
|
@@ -667,12 +705,25 @@ export interface OrderItem {
|
|
|
667
705
|
* Images
|
|
668
706
|
*/
|
|
669
707
|
'images'?: Array<Image>;
|
|
708
|
+
/**
|
|
709
|
+
* Gross total with discount applied
|
|
710
|
+
*/
|
|
670
711
|
'totalPrice'?: Price;
|
|
671
712
|
/**
|
|
672
|
-
* This is an estimate until the order has been confirmed
|
|
713
|
+
* The tax amount for this line item after discounts. This is an estimate until the order has been confirmed.
|
|
673
714
|
*/
|
|
674
715
|
'taxPrice'?: Price;
|
|
716
|
+
/**
|
|
717
|
+
* The price for this line item, including tax and before discounts.
|
|
718
|
+
*/
|
|
675
719
|
'subtotalPrice'?: Price;
|
|
720
|
+
/**
|
|
721
|
+
* The net price for this line item, excluding tax and before discounts.
|
|
722
|
+
*/
|
|
723
|
+
'subtotalExTaxPrice'?: Price;
|
|
724
|
+
/**
|
|
725
|
+
* The discount amount applied to this line item.
|
|
726
|
+
*/
|
|
676
727
|
'discountPrice'?: Price;
|
|
677
728
|
'amendmentLogs'?: Array<AmendmentLog>;
|
|
678
729
|
}
|
|
@@ -694,6 +745,7 @@ export interface OrderPaymentMethod {
|
|
|
694
745
|
export declare const OrderStatus: {
|
|
695
746
|
readonly New: "new";
|
|
696
747
|
readonly Paid: "paid";
|
|
748
|
+
readonly PaymentPending: "payment_pending";
|
|
697
749
|
readonly Processing: "processing";
|
|
698
750
|
readonly Complete: "complete";
|
|
699
751
|
readonly Refunded: "refunded";
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.60.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -32,7 +32,8 @@ export const AmendOrderRequestAmendmentsInnerActionEnum = {
|
|
|
32
32
|
};
|
|
33
33
|
export const AmendmentLogAmendmentTypeEnum = {
|
|
34
34
|
Refund: 'refund',
|
|
35
|
-
Exchange: 'exchange'
|
|
35
|
+
Exchange: 'exchange',
|
|
36
|
+
ShippingRefund: 'shipping_refund'
|
|
36
37
|
};
|
|
37
38
|
export const ApplicationPlacementEnum = {
|
|
38
39
|
Front: 'front',
|
|
@@ -54,6 +55,7 @@ export const EnquiryStatusEnum = {
|
|
|
54
55
|
export const OrderStatus = {
|
|
55
56
|
New: 'new',
|
|
56
57
|
Paid: 'paid',
|
|
58
|
+
PaymentPending: 'payment_pending',
|
|
57
59
|
Processing: 'processing',
|
|
58
60
|
Complete: 'complete',
|
|
59
61
|
Refunded: 'refunded',
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/AmendmentLog.md
CHANGED
|
@@ -6,10 +6,11 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
-
**
|
|
10
|
-
**
|
|
9
|
+
**orderId** | **string** | A reference to the order that was amended. | [optional] [default to undefined]
|
|
10
|
+
**orderItemId** | **string** | A reference to the order item that was amended. Null for shipping_refund amendments. | [optional] [default to undefined]
|
|
11
|
+
**originalOrderItemId** | **string** | A reference to the top level order item that was amended, useful for finding the original item within a chain of exchanges, for example. Null for shipping_refund amendments. | [optional] [default to undefined]
|
|
11
12
|
**amendmentType** | **string** | | [default to undefined]
|
|
12
|
-
**quantity** | **number** |
|
|
13
|
+
**quantity** | **number** | The quantity of the item that was amended, if applicable to the amendment type. | [optional] [default to undefined]
|
|
13
14
|
**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
@@ -19,6 +20,7 @@ import { AmendmentLog } from '@teemill/platform';
|
|
|
19
20
|
|
|
20
21
|
const instance: AmendmentLog = {
|
|
21
22
|
id,
|
|
23
|
+
orderId,
|
|
22
24
|
orderItemId,
|
|
23
25
|
originalOrderItemId,
|
|
24
26
|
amendmentType,
|
package/docs/Order.md
CHANGED
|
@@ -20,12 +20,15 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) | | [optional] [readonly] [default to undefined]
|
|
21
21
|
**deliveryEstimates** | [**DeliveryEstimates**](DeliveryEstimates.md) | | [optional] [default to undefined]
|
|
22
22
|
**items** | [**Array<OrderItem>**](OrderItem.md) | | [default to undefined]
|
|
23
|
-
**totalPrice** | [**Price**](Price.md) |
|
|
24
|
-
**taxPrice** | [**Price**](Price.md) |
|
|
25
|
-
**subtotalPrice** | [**Price**](Price.md) |
|
|
26
|
-
**discountPrice** | [**Price**](Price.md) |
|
|
27
|
-
**
|
|
28
|
-
**
|
|
23
|
+
**totalPrice** | [**Price**](Price.md) | The total price of the order including tax and after discounts. | [optional] [default to undefined]
|
|
24
|
+
**taxPrice** | [**Price**](Price.md) | The total tax amount for the order. | [optional] [default to undefined]
|
|
25
|
+
**subtotalPrice** | [**Price**](Price.md) | The net items price (including shipping), excluding tax and after discounts. | [optional] [default to undefined]
|
|
26
|
+
**discountPrice** | [**Price**](Price.md) | The total discount amount applied to the order. | [optional] [default to undefined]
|
|
27
|
+
**shippingPrice** | [**Price**](Price.md) | The total shipping cost for the order excluding tax. | [optional] [default to undefined]
|
|
28
|
+
**itemsPrice** | [**Price**](Price.md) | The total items price for the order excluding tax | [optional] [default to undefined]
|
|
29
|
+
**coupon** | [**Coupon**](Coupon.md) | The coupon applied to the order, if any. | [optional] [default to undefined]
|
|
30
|
+
**paymentLink** | **string** | URL to page containing payment instructions for the payee. Only present when the order is in \'new\' status. | [optional] [default to undefined]
|
|
31
|
+
**receiptLink** | **string** | URL to the order receipt page. Only present when the order is not in \'new\' status. | [optional] [default to undefined]
|
|
29
32
|
**origin** | [**Origin**](Origin.md) | | [optional] [default to undefined]
|
|
30
33
|
**statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) | | [optional] [default to undefined]
|
|
31
34
|
**project** | [**Project**](Project.md) | | [default to undefined]
|
|
@@ -62,8 +65,11 @@ const instance: Order = {
|
|
|
62
65
|
taxPrice,
|
|
63
66
|
subtotalPrice,
|
|
64
67
|
discountPrice,
|
|
65
|
-
coupon,
|
|
66
68
|
shippingPrice,
|
|
69
|
+
itemsPrice,
|
|
70
|
+
coupon,
|
|
71
|
+
paymentLink,
|
|
72
|
+
receiptLink,
|
|
67
73
|
origin,
|
|
68
74
|
statusHistory,
|
|
69
75
|
project,
|
package/docs/OrderItem.md
CHANGED
|
@@ -12,10 +12,11 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**quantity** | **number** | | [default to undefined]
|
|
13
13
|
**name** | **string** | The name of the product | [optional] [default to undefined]
|
|
14
14
|
**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
|
|
15
|
-
**totalPrice** | [**Price**](Price.md) |
|
|
16
|
-
**taxPrice** | [**Price**](Price.md) | This is an estimate until the order has been confirmed | [optional] [readonly] [default to undefined]
|
|
17
|
-
**subtotalPrice** | [**Price**](Price.md) |
|
|
18
|
-
**
|
|
15
|
+
**totalPrice** | [**Price**](Price.md) | Gross total with discount applied | [optional] [readonly] [default to undefined]
|
|
16
|
+
**taxPrice** | [**Price**](Price.md) | The tax amount for this line item after discounts. This is an estimate until the order has been confirmed. | [optional] [readonly] [default to undefined]
|
|
17
|
+
**subtotalPrice** | [**Price**](Price.md) | The price for this line item, including tax and before discounts. | [optional] [readonly] [default to undefined]
|
|
18
|
+
**subtotalExTaxPrice** | [**Price**](Price.md) | The net price for this line item, excluding tax and before discounts. | [optional] [readonly] [default to undefined]
|
|
19
|
+
**discountPrice** | [**Price**](Price.md) | The discount amount applied to this line item. | [optional] [readonly] [default to undefined]
|
|
19
20
|
**amendmentLogs** | [**Array<AmendmentLog>**](AmendmentLog.md) | | [optional] [default to undefined]
|
|
20
21
|
|
|
21
22
|
## Example
|
|
@@ -34,6 +35,7 @@ const instance: OrderItem = {
|
|
|
34
35
|
totalPrice,
|
|
35
36
|
taxPrice,
|
|
36
37
|
subtotalPrice,
|
|
38
|
+
subtotalExTaxPrice,
|
|
37
39
|
discountPrice,
|
|
38
40
|
amendmentLogs,
|
|
39
41
|
};
|
package/docs/OrderStatus.md
CHANGED
package/index.ts
CHANGED