ultracart_rest_api_v2_typescript 4.0.240 → 4.0.241

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.
@@ -642,6 +642,7 @@ src/models/OrderByTokenQuery.ts
642
642
  src/models/OrderChannelPartner.ts
643
643
  src/models/OrderCheckout.ts
644
644
  src/models/OrderCoupon.ts
645
+ src/models/OrderCurrentStageHistory.ts
645
646
  src/models/OrderDigitalItem.ts
646
647
  src/models/OrderDigitalOrder.ts
647
648
  src/models/OrderEdi.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.240
1
+ ## ultracart_rest_api_v2_typescript@4.0.241
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). 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 ultracart_rest_api_v2_typescript@4.0.240 --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.241 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 4.0.241 | 02/06/2025 | added storefront_host_name to channel partner order object |
57
58
  | 4.0.240 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
58
59
  | 4.0.239 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
59
60
  | 4.0.238 | 12/13/2024 | added user and group ids to conversation agent auth object |
@@ -539,6 +539,12 @@ export interface ChannelPartnerOrder {
539
539
  * @memberof ChannelPartnerOrder
540
540
  */
541
541
  store_if_payment_declines?: boolean;
542
+ /**
543
+ * StoreFront host name associated with the order
544
+ * @type {string}
545
+ * @memberof ChannelPartnerOrder
546
+ */
547
+ storefront_host_name?: string;
542
548
  /**
543
549
  * The optional shipping county used to determine exact taxes
544
550
  * @type {string}
@@ -144,6 +144,7 @@ function ChannelPartnerOrderFromJSONTyped(json, ignoreDiscriminator) {
144
144
  'special_instructions': !(0, runtime_1.exists)(json, 'special_instructions') ? undefined : json['special_instructions'],
145
145
  'store_completed': !(0, runtime_1.exists)(json, 'store_completed') ? undefined : json['store_completed'],
146
146
  'store_if_payment_declines': !(0, runtime_1.exists)(json, 'store_if_payment_declines') ? undefined : json['store_if_payment_declines'],
147
+ 'storefront_host_name': !(0, runtime_1.exists)(json, 'storefront_host_name') ? undefined : json['storefront_host_name'],
147
148
  'tax_county': !(0, runtime_1.exists)(json, 'tax_county') ? undefined : json['tax_county'],
148
149
  'tax_exempt': !(0, runtime_1.exists)(json, 'tax_exempt') ? undefined : json['tax_exempt'],
149
150
  'transaction': !(0, runtime_1.exists)(json, 'transaction') ? undefined : (0, ChannelPartnerOrderTransaction_1.ChannelPartnerOrderTransactionFromJSON)(json['transaction']),
@@ -246,6 +247,7 @@ function ChannelPartnerOrderToJSON(value) {
246
247
  'special_instructions': value.special_instructions,
247
248
  'store_completed': value.store_completed,
248
249
  'store_if_payment_declines': value.store_if_payment_declines,
250
+ 'storefront_host_name': value.storefront_host_name,
249
251
  'tax_county': value.tax_county,
250
252
  'tax_exempt': value.tax_exempt,
251
253
  'transaction': (0, ChannelPartnerOrderTransaction_1.ChannelPartnerOrderTransactionToJSON)(value.transaction),
@@ -34,7 +34,7 @@ export interface CustomerAttachment {
34
34
  */
35
35
  file_name?: string;
36
36
  /**
37
- * Mime typoe
37
+ * Mime type
38
38
  * @type {string}
39
39
  * @memberof CustomerAttachment
40
40
  */
@@ -39,6 +39,12 @@ export interface ItemReview {
39
39
  * @memberof ItemReview
40
40
  */
41
41
  helpful_yes_votes?: number;
42
+ /**
43
+ * Merchant Reply (set to an empty string to remove)
44
+ * @type {string}
45
+ * @memberof ItemReview
46
+ */
47
+ merchant_reply?: string;
42
48
  /**
43
49
  *
44
50
  * @type {string}
@@ -37,6 +37,7 @@ function ItemReviewFromJSONTyped(json, ignoreDiscriminator) {
37
37
  'featured': !(0, runtime_1.exists)(json, 'featured') ? undefined : json['featured'],
38
38
  'helperful_no_votes': !(0, runtime_1.exists)(json, 'helperful_no_votes') ? undefined : json['helperful_no_votes'],
39
39
  'helpful_yes_votes': !(0, runtime_1.exists)(json, 'helpful_yes_votes') ? undefined : json['helpful_yes_votes'],
40
+ 'merchant_reply': !(0, runtime_1.exists)(json, 'merchant_reply') ? undefined : json['merchant_reply'],
40
41
  'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
41
42
  'overall': !(0, runtime_1.exists)(json, 'overall') ? undefined : json['overall'],
42
43
  'rating_name1': !(0, runtime_1.exists)(json, 'rating_name1') ? undefined : json['rating_name1'],
@@ -85,6 +86,7 @@ function ItemReviewToJSON(value) {
85
86
  'featured': value.featured,
86
87
  'helperful_no_votes': value.helperful_no_votes,
87
88
  'helpful_yes_votes': value.helpful_yes_votes,
89
+ 'merchant_reply': value.merchant_reply,
88
90
  'order_id': value.order_id,
89
91
  'overall': value.overall,
90
92
  'rating_name1': value.rating_name1,
@@ -17,6 +17,7 @@ import { OrderBuysafe } from './OrderBuysafe';
17
17
  import { OrderChannelPartner } from './OrderChannelPartner';
18
18
  import { OrderCheckout } from './OrderCheckout';
19
19
  import { OrderCoupon } from './OrderCoupon';
20
+ import { OrderCurrentStageHistory } from './OrderCurrentStageHistory';
20
21
  import { OrderDigitalOrder } from './OrderDigitalOrder';
21
22
  import { OrderEdi } from './OrderEdi';
22
23
  import { OrderFraudScore } from './OrderFraudScore';
@@ -102,6 +103,12 @@ export interface Order {
102
103
  * @memberof Order
103
104
  */
104
105
  current_stage?: OrderCurrentStageEnum;
106
+ /**
107
+ * History of the changes to the current_stage field
108
+ * @type {Array<OrderCurrentStageHistory>}
109
+ * @memberof Order
110
+ */
111
+ current_stage_histories?: Array<OrderCurrentStageHistory>;
105
112
  /**
106
113
  *
107
114
  * @type {Customer}
@@ -23,6 +23,7 @@ var OrderBuysafe_1 = require("./OrderBuysafe");
23
23
  var OrderChannelPartner_1 = require("./OrderChannelPartner");
24
24
  var OrderCheckout_1 = require("./OrderCheckout");
25
25
  var OrderCoupon_1 = require("./OrderCoupon");
26
+ var OrderCurrentStageHistory_1 = require("./OrderCurrentStageHistory");
26
27
  var OrderDigitalOrder_1 = require("./OrderDigitalOrder");
27
28
  var OrderEdi_1 = require("./OrderEdi");
28
29
  var OrderFraudScore_1 = require("./OrderFraudScore");
@@ -79,6 +80,7 @@ function OrderFromJSONTyped(json, ignoreDiscriminator) {
79
80
  'creation_dts': !(0, runtime_1.exists)(json, 'creation_dts') ? undefined : json['creation_dts'],
80
81
  'currency_code': !(0, runtime_1.exists)(json, 'currency_code') ? undefined : json['currency_code'],
81
82
  'current_stage': !(0, runtime_1.exists)(json, 'current_stage') ? undefined : json['current_stage'],
83
+ 'current_stage_histories': !(0, runtime_1.exists)(json, 'current_stage_histories') ? undefined : (json['current_stage_histories'].map(OrderCurrentStageHistory_1.OrderCurrentStageHistoryFromJSON)),
82
84
  'customer_profile': !(0, runtime_1.exists)(json, 'customer_profile') ? undefined : (0, Customer_1.CustomerFromJSON)(json['customer_profile']),
83
85
  'digital_order': !(0, runtime_1.exists)(json, 'digital_order') ? undefined : (0, OrderDigitalOrder_1.OrderDigitalOrderFromJSON)(json['digital_order']),
84
86
  'edi': !(0, runtime_1.exists)(json, 'edi') ? undefined : (0, OrderEdi_1.OrderEdiFromJSON)(json['edi']),
@@ -128,6 +130,7 @@ function OrderToJSON(value) {
128
130
  'creation_dts': value.creation_dts,
129
131
  'currency_code': value.currency_code,
130
132
  'current_stage': value.current_stage,
133
+ 'current_stage_histories': value.current_stage_histories === undefined ? undefined : (value.current_stage_histories.map(OrderCurrentStageHistory_1.OrderCurrentStageHistoryToJSON)),
131
134
  'customer_profile': (0, Customer_1.CustomerToJSON)(value.customer_profile),
132
135
  'digital_order': (0, OrderDigitalOrder_1.OrderDigitalOrderToJSON)(value.digital_order),
133
136
  'edi': (0, OrderEdi_1.OrderEdiToJSON)(value.edi),
@@ -0,0 +1,77 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface OrderCurrentStageHistory
16
+ */
17
+ export interface OrderCurrentStageHistory {
18
+ /**
19
+ * New stage that the order is in.
20
+ * @type {string}
21
+ * @memberof OrderCurrentStageHistory
22
+ */
23
+ after_stage?: OrderCurrentStageHistoryAfterStageEnum;
24
+ /**
25
+ * Previous stage that the order was in.
26
+ * @type {string}
27
+ * @memberof OrderCurrentStageHistory
28
+ */
29
+ before_stage?: OrderCurrentStageHistoryBeforeStageEnum;
30
+ /**
31
+ * Date/time that the stage transitioned
32
+ * @type {string}
33
+ * @memberof OrderCurrentStageHistory
34
+ */
35
+ transition_dts?: string;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const OrderCurrentStageHistoryAfterStageEnum: {
41
+ readonly AccountsReceivable: "Accounts Receivable";
42
+ readonly PendingClearance: "Pending Clearance";
43
+ readonly FraudReview: "Fraud Review";
44
+ readonly Rejected: "Rejected";
45
+ readonly ShippingDepartment: "Shipping Department";
46
+ readonly CompletedOrder: "Completed Order";
47
+ readonly QuoteRequest: "Quote Request";
48
+ readonly QuoteSent: "Quote Sent";
49
+ readonly LeastCostRouting: "Least Cost Routing";
50
+ readonly Unknown: "Unknown";
51
+ readonly PreOrdered: "Pre-ordered";
52
+ readonly AdvancedOrderRouting: "Advanced Order Routing";
53
+ readonly Hold: "Hold";
54
+ };
55
+ export type OrderCurrentStageHistoryAfterStageEnum = typeof OrderCurrentStageHistoryAfterStageEnum[keyof typeof OrderCurrentStageHistoryAfterStageEnum];
56
+ /**
57
+ * @export
58
+ */
59
+ export declare const OrderCurrentStageHistoryBeforeStageEnum: {
60
+ readonly AccountsReceivable: "Accounts Receivable";
61
+ readonly PendingClearance: "Pending Clearance";
62
+ readonly FraudReview: "Fraud Review";
63
+ readonly Rejected: "Rejected";
64
+ readonly ShippingDepartment: "Shipping Department";
65
+ readonly CompletedOrder: "Completed Order";
66
+ readonly QuoteRequest: "Quote Request";
67
+ readonly QuoteSent: "Quote Sent";
68
+ readonly LeastCostRouting: "Least Cost Routing";
69
+ readonly Unknown: "Unknown";
70
+ readonly PreOrdered: "Pre-ordered";
71
+ readonly AdvancedOrderRouting: "Advanced Order Routing";
72
+ readonly Hold: "Hold";
73
+ };
74
+ export type OrderCurrentStageHistoryBeforeStageEnum = typeof OrderCurrentStageHistoryBeforeStageEnum[keyof typeof OrderCurrentStageHistoryBeforeStageEnum];
75
+ export declare function OrderCurrentStageHistoryFromJSON(json: any): OrderCurrentStageHistory;
76
+ export declare function OrderCurrentStageHistoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCurrentStageHistory;
77
+ export declare function OrderCurrentStageHistoryToJSON(value?: OrderCurrentStageHistory | null): any;
@@ -0,0 +1,82 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.OrderCurrentStageHistoryToJSON = exports.OrderCurrentStageHistoryFromJSONTyped = exports.OrderCurrentStageHistoryFromJSON = exports.OrderCurrentStageHistoryBeforeStageEnum = exports.OrderCurrentStageHistoryAfterStageEnum = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * @export
20
+ */
21
+ exports.OrderCurrentStageHistoryAfterStageEnum = {
22
+ AccountsReceivable: 'Accounts Receivable',
23
+ PendingClearance: 'Pending Clearance',
24
+ FraudReview: 'Fraud Review',
25
+ Rejected: 'Rejected',
26
+ ShippingDepartment: 'Shipping Department',
27
+ CompletedOrder: 'Completed Order',
28
+ QuoteRequest: 'Quote Request',
29
+ QuoteSent: 'Quote Sent',
30
+ LeastCostRouting: 'Least Cost Routing',
31
+ Unknown: 'Unknown',
32
+ PreOrdered: 'Pre-ordered',
33
+ AdvancedOrderRouting: 'Advanced Order Routing',
34
+ Hold: 'Hold'
35
+ };
36
+ /**
37
+ * @export
38
+ */
39
+ exports.OrderCurrentStageHistoryBeforeStageEnum = {
40
+ AccountsReceivable: 'Accounts Receivable',
41
+ PendingClearance: 'Pending Clearance',
42
+ FraudReview: 'Fraud Review',
43
+ Rejected: 'Rejected',
44
+ ShippingDepartment: 'Shipping Department',
45
+ CompletedOrder: 'Completed Order',
46
+ QuoteRequest: 'Quote Request',
47
+ QuoteSent: 'Quote Sent',
48
+ LeastCostRouting: 'Least Cost Routing',
49
+ Unknown: 'Unknown',
50
+ PreOrdered: 'Pre-ordered',
51
+ AdvancedOrderRouting: 'Advanced Order Routing',
52
+ Hold: 'Hold'
53
+ };
54
+ function OrderCurrentStageHistoryFromJSON(json) {
55
+ return OrderCurrentStageHistoryFromJSONTyped(json, false);
56
+ }
57
+ exports.OrderCurrentStageHistoryFromJSON = OrderCurrentStageHistoryFromJSON;
58
+ function OrderCurrentStageHistoryFromJSONTyped(json, ignoreDiscriminator) {
59
+ if ((json === undefined) || (json === null)) {
60
+ return json;
61
+ }
62
+ return {
63
+ 'after_stage': !(0, runtime_1.exists)(json, 'after_stage') ? undefined : json['after_stage'],
64
+ 'before_stage': !(0, runtime_1.exists)(json, 'before_stage') ? undefined : json['before_stage'],
65
+ 'transition_dts': !(0, runtime_1.exists)(json, 'transition_dts') ? undefined : json['transition_dts'],
66
+ };
67
+ }
68
+ exports.OrderCurrentStageHistoryFromJSONTyped = OrderCurrentStageHistoryFromJSONTyped;
69
+ function OrderCurrentStageHistoryToJSON(value) {
70
+ if (value === undefined) {
71
+ return undefined;
72
+ }
73
+ if (value === null) {
74
+ return null;
75
+ }
76
+ return {
77
+ 'after_stage': value.after_stage,
78
+ 'before_stage': value.before_stage,
79
+ 'transition_dts': value.transition_dts,
80
+ };
81
+ }
82
+ exports.OrderCurrentStageHistoryToJSON = OrderCurrentStageHistoryToJSON;
@@ -34,6 +34,12 @@ export interface OrderItem {
34
34
  * @memberof OrderItem
35
35
  */
36
36
  activation_codes?: Array<string>;
37
+ /**
38
+ *
39
+ * @type {Currency}
40
+ * @memberof OrderItem
41
+ */
42
+ actual_cogs?: Currency;
37
43
  /**
38
44
  *
39
45
  * @type {Currency}
@@ -42,6 +42,7 @@ function OrderItemFromJSONTyped(json, ignoreDiscriminator) {
42
42
  return {
43
43
  'accounting_code': !(0, runtime_1.exists)(json, 'accounting_code') ? undefined : json['accounting_code'],
44
44
  'activation_codes': !(0, runtime_1.exists)(json, 'activation_codes') ? undefined : json['activation_codes'],
45
+ 'actual_cogs': !(0, runtime_1.exists)(json, 'actual_cogs') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['actual_cogs']),
45
46
  'arbitrary_unit_cost': !(0, runtime_1.exists)(json, 'arbitrary_unit_cost') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['arbitrary_unit_cost']),
46
47
  'auto_order_last_rebill_dts': !(0, runtime_1.exists)(json, 'auto_order_last_rebill_dts') ? undefined : json['auto_order_last_rebill_dts'],
47
48
  'auto_order_schedule': !(0, runtime_1.exists)(json, 'auto_order_schedule') ? undefined : json['auto_order_schedule'],
@@ -118,6 +119,7 @@ function OrderItemToJSON(value) {
118
119
  return {
119
120
  'accounting_code': value.accounting_code,
120
121
  'activation_codes': value.activation_codes,
122
+ 'actual_cogs': (0, Currency_1.CurrencyToJSON)(value.actual_cogs),
121
123
  'arbitrary_unit_cost': (0, Currency_1.CurrencyToJSON)(value.arbitrary_unit_cost),
122
124
  'auto_order_last_rebill_dts': value.auto_order_last_rebill_dts,
123
125
  'auto_order_schedule': value.auto_order_schedule,
@@ -22,12 +22,36 @@ export interface OrderSummary {
22
22
  * @memberof OrderSummary
23
23
  */
24
24
  actual_fulfillment?: Currency;
25
+ /**
26
+ *
27
+ * @type {Currency}
28
+ * @memberof OrderSummary
29
+ */
30
+ actual_other_cost?: Currency;
25
31
  /**
26
32
  *
27
33
  * @type {Currency}
28
34
  * @memberof OrderSummary
29
35
  */
30
36
  actual_payment_processing?: Currency;
37
+ /**
38
+ *
39
+ * @type {Currency}
40
+ * @memberof OrderSummary
41
+ */
42
+ actual_profit?: Currency;
43
+ /**
44
+ * Actual profit has been analyzed
45
+ * @type {boolean}
46
+ * @memberof OrderSummary
47
+ */
48
+ actual_profit_analyzed?: boolean;
49
+ /**
50
+ * Actual profit needs review
51
+ * @type {boolean}
52
+ * @memberof OrderSummary
53
+ */
54
+ actual_profit_review?: boolean;
31
55
  /**
32
56
  *
33
57
  * @type {Currency}
@@ -26,7 +26,11 @@ function OrderSummaryFromJSONTyped(json, ignoreDiscriminator) {
26
26
  }
27
27
  return {
28
28
  'actual_fulfillment': !(0, runtime_1.exists)(json, 'actual_fulfillment') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['actual_fulfillment']),
29
+ 'actual_other_cost': !(0, runtime_1.exists)(json, 'actual_other_cost') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['actual_other_cost']),
29
30
  'actual_payment_processing': !(0, runtime_1.exists)(json, 'actual_payment_processing') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['actual_payment_processing']),
31
+ 'actual_profit': !(0, runtime_1.exists)(json, 'actual_profit') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['actual_profit']),
32
+ 'actual_profit_analyzed': !(0, runtime_1.exists)(json, 'actual_profit_analyzed') ? undefined : json['actual_profit_analyzed'],
33
+ 'actual_profit_review': !(0, runtime_1.exists)(json, 'actual_profit_review') ? undefined : json['actual_profit_review'],
30
34
  'actual_shipping': !(0, runtime_1.exists)(json, 'actual_shipping') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['actual_shipping']),
31
35
  'arbitrary_shipping_handling_total': !(0, runtime_1.exists)(json, 'arbitrary_shipping_handling_total') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['arbitrary_shipping_handling_total']),
32
36
  'health_benefit_card_amount': !(0, runtime_1.exists)(json, 'health_benefit_card_amount') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['health_benefit_card_amount']),
@@ -59,7 +63,11 @@ function OrderSummaryToJSON(value) {
59
63
  }
60
64
  return {
61
65
  'actual_fulfillment': (0, Currency_1.CurrencyToJSON)(value.actual_fulfillment),
66
+ 'actual_other_cost': (0, Currency_1.CurrencyToJSON)(value.actual_other_cost),
62
67
  'actual_payment_processing': (0, Currency_1.CurrencyToJSON)(value.actual_payment_processing),
68
+ 'actual_profit': (0, Currency_1.CurrencyToJSON)(value.actual_profit),
69
+ 'actual_profit_analyzed': value.actual_profit_analyzed,
70
+ 'actual_profit_review': value.actual_profit_review,
63
71
  'actual_shipping': (0, Currency_1.CurrencyToJSON)(value.actual_shipping),
64
72
  'arbitrary_shipping_handling_total': (0, Currency_1.CurrencyToJSON)(value.arbitrary_shipping_handling_total),
65
73
  'health_benefit_card_amount': (0, Currency_1.CurrencyToJSON)(value.health_benefit_card_amount),
@@ -615,6 +615,7 @@ export * from './OrderByTokenQuery';
615
615
  export * from './OrderChannelPartner';
616
616
  export * from './OrderCheckout';
617
617
  export * from './OrderCoupon';
618
+ export * from './OrderCurrentStageHistory';
618
619
  export * from './OrderDigitalItem';
619
620
  export * from './OrderDigitalOrder';
620
621
  export * from './OrderEdi';
@@ -633,6 +633,7 @@ __exportStar(require("./OrderByTokenQuery"), exports);
633
633
  __exportStar(require("./OrderChannelPartner"), exports);
634
634
  __exportStar(require("./OrderCheckout"), exports);
635
635
  __exportStar(require("./OrderCoupon"), exports);
636
+ __exportStar(require("./OrderCurrentStageHistory"), exports);
636
637
  __exportStar(require("./OrderDigitalItem"), exports);
637
638
  __exportStar(require("./OrderDigitalOrder"), exports);
638
639
  __exportStar(require("./OrderEdi"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.0.240",
3
+ "version": "4.0.241",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -554,6 +554,12 @@ export interface ChannelPartnerOrder {
554
554
  * @memberof ChannelPartnerOrder
555
555
  */
556
556
  store_if_payment_declines?: boolean;
557
+ /**
558
+ * StoreFront host name associated with the order
559
+ * @type {string}
560
+ * @memberof ChannelPartnerOrder
561
+ */
562
+ storefront_host_name?: string;
557
563
  /**
558
564
  * The optional shipping county used to determine exact taxes
559
565
  * @type {string}
@@ -716,6 +722,7 @@ export function ChannelPartnerOrderFromJSONTyped(json: any, ignoreDiscriminator:
716
722
  'special_instructions': !exists(json, 'special_instructions') ? undefined : json['special_instructions'],
717
723
  'store_completed': !exists(json, 'store_completed') ? undefined : json['store_completed'],
718
724
  'store_if_payment_declines': !exists(json, 'store_if_payment_declines') ? undefined : json['store_if_payment_declines'],
725
+ 'storefront_host_name': !exists(json, 'storefront_host_name') ? undefined : json['storefront_host_name'],
719
726
  'tax_county': !exists(json, 'tax_county') ? undefined : json['tax_county'],
720
727
  'tax_exempt': !exists(json, 'tax_exempt') ? undefined : json['tax_exempt'],
721
728
  'transaction': !exists(json, 'transaction') ? undefined : ChannelPartnerOrderTransactionFromJSON(json['transaction']),
@@ -819,6 +826,7 @@ export function ChannelPartnerOrderToJSON(value?: ChannelPartnerOrder | null): a
819
826
  'special_instructions': value.special_instructions,
820
827
  'store_completed': value.store_completed,
821
828
  'store_if_payment_declines': value.store_if_payment_declines,
829
+ 'storefront_host_name': value.storefront_host_name,
822
830
  'tax_county': value.tax_county,
823
831
  'tax_exempt': value.tax_exempt,
824
832
  'transaction': ChannelPartnerOrderTransactionToJSON(value.transaction),
@@ -38,7 +38,7 @@ export interface CustomerAttachment {
38
38
  */
39
39
  file_name?: string;
40
40
  /**
41
- * Mime typoe
41
+ * Mime type
42
42
  * @type {string}
43
43
  * @memberof CustomerAttachment
44
44
  */
@@ -43,6 +43,12 @@ export interface ItemReview {
43
43
  * @memberof ItemReview
44
44
  */
45
45
  helpful_yes_votes?: number;
46
+ /**
47
+ * Merchant Reply (set to an empty string to remove)
48
+ * @type {string}
49
+ * @memberof ItemReview
50
+ */
51
+ merchant_reply?: string;
46
52
  /**
47
53
  *
48
54
  * @type {string}
@@ -270,6 +276,7 @@ export function ItemReviewFromJSONTyped(json: any, ignoreDiscriminator: boolean)
270
276
  'featured': !exists(json, 'featured') ? undefined : json['featured'],
271
277
  'helperful_no_votes': !exists(json, 'helperful_no_votes') ? undefined : json['helperful_no_votes'],
272
278
  'helpful_yes_votes': !exists(json, 'helpful_yes_votes') ? undefined : json['helpful_yes_votes'],
279
+ 'merchant_reply': !exists(json, 'merchant_reply') ? undefined : json['merchant_reply'],
273
280
  'order_id': !exists(json, 'order_id') ? undefined : json['order_id'],
274
281
  'overall': !exists(json, 'overall') ? undefined : json['overall'],
275
282
  'rating_name1': !exists(json, 'rating_name1') ? undefined : json['rating_name1'],
@@ -319,6 +326,7 @@ export function ItemReviewToJSON(value?: ItemReview | null): any {
319
326
  'featured': value.featured,
320
327
  'helperful_no_votes': value.helperful_no_votes,
321
328
  'helpful_yes_votes': value.helpful_yes_votes,
329
+ 'merchant_reply': value.merchant_reply,
322
330
  'order_id': value.order_id,
323
331
  'overall': value.overall,
324
332
  'rating_name1': value.rating_name1,
@@ -61,6 +61,12 @@ import {
61
61
  OrderCouponFromJSONTyped,
62
62
  OrderCouponToJSON,
63
63
  } from './OrderCoupon';
64
+ import {
65
+ OrderCurrentStageHistory,
66
+ OrderCurrentStageHistoryFromJSON,
67
+ OrderCurrentStageHistoryFromJSONTyped,
68
+ OrderCurrentStageHistoryToJSON,
69
+ } from './OrderCurrentStageHistory';
64
70
  import {
65
71
  OrderDigitalOrder,
66
72
  OrderDigitalOrderFromJSON,
@@ -242,6 +248,12 @@ export interface Order {
242
248
  * @memberof Order
243
249
  */
244
250
  current_stage?: OrderCurrentStageEnum;
251
+ /**
252
+ * History of the changes to the current_stage field
253
+ * @type {Array<OrderCurrentStageHistory>}
254
+ * @memberof Order
255
+ */
256
+ current_stage_histories?: Array<OrderCurrentStageHistory>;
245
257
  /**
246
258
  *
247
259
  * @type {Customer}
@@ -454,6 +466,7 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
454
466
  'creation_dts': !exists(json, 'creation_dts') ? undefined : json['creation_dts'],
455
467
  'currency_code': !exists(json, 'currency_code') ? undefined : json['currency_code'],
456
468
  'current_stage': !exists(json, 'current_stage') ? undefined : json['current_stage'],
469
+ 'current_stage_histories': !exists(json, 'current_stage_histories') ? undefined : ((json['current_stage_histories'] as Array<any>).map(OrderCurrentStageHistoryFromJSON)),
457
470
  'customer_profile': !exists(json, 'customer_profile') ? undefined : CustomerFromJSON(json['customer_profile']),
458
471
  'digital_order': !exists(json, 'digital_order') ? undefined : OrderDigitalOrderFromJSON(json['digital_order']),
459
472
  'edi': !exists(json, 'edi') ? undefined : OrderEdiFromJSON(json['edi']),
@@ -504,6 +517,7 @@ export function OrderToJSON(value?: Order | null): any {
504
517
  'creation_dts': value.creation_dts,
505
518
  'currency_code': value.currency_code,
506
519
  'current_stage': value.current_stage,
520
+ 'current_stage_histories': value.current_stage_histories === undefined ? undefined : ((value.current_stage_histories as Array<any>).map(OrderCurrentStageHistoryToJSON)),
507
521
  'customer_profile': CustomerToJSON(value.customer_profile),
508
522
  'digital_order': OrderDigitalOrderToJSON(value.digital_order),
509
523
  'edi': OrderEdiToJSON(value.edi),
@@ -0,0 +1,114 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface OrderCurrentStageHistory
20
+ */
21
+ export interface OrderCurrentStageHistory {
22
+ /**
23
+ * New stage that the order is in.
24
+ * @type {string}
25
+ * @memberof OrderCurrentStageHistory
26
+ */
27
+ after_stage?: OrderCurrentStageHistoryAfterStageEnum;
28
+ /**
29
+ * Previous stage that the order was in.
30
+ * @type {string}
31
+ * @memberof OrderCurrentStageHistory
32
+ */
33
+ before_stage?: OrderCurrentStageHistoryBeforeStageEnum;
34
+ /**
35
+ * Date/time that the stage transitioned
36
+ * @type {string}
37
+ * @memberof OrderCurrentStageHistory
38
+ */
39
+ transition_dts?: string;
40
+ }
41
+
42
+
43
+ /**
44
+ * @export
45
+ */
46
+ export const OrderCurrentStageHistoryAfterStageEnum = {
47
+ AccountsReceivable: 'Accounts Receivable',
48
+ PendingClearance: 'Pending Clearance',
49
+ FraudReview: 'Fraud Review',
50
+ Rejected: 'Rejected',
51
+ ShippingDepartment: 'Shipping Department',
52
+ CompletedOrder: 'Completed Order',
53
+ QuoteRequest: 'Quote Request',
54
+ QuoteSent: 'Quote Sent',
55
+ LeastCostRouting: 'Least Cost Routing',
56
+ Unknown: 'Unknown',
57
+ PreOrdered: 'Pre-ordered',
58
+ AdvancedOrderRouting: 'Advanced Order Routing',
59
+ Hold: 'Hold'
60
+ } as const;
61
+ export type OrderCurrentStageHistoryAfterStageEnum = typeof OrderCurrentStageHistoryAfterStageEnum[keyof typeof OrderCurrentStageHistoryAfterStageEnum];
62
+
63
+ /**
64
+ * @export
65
+ */
66
+ export const OrderCurrentStageHistoryBeforeStageEnum = {
67
+ AccountsReceivable: 'Accounts Receivable',
68
+ PendingClearance: 'Pending Clearance',
69
+ FraudReview: 'Fraud Review',
70
+ Rejected: 'Rejected',
71
+ ShippingDepartment: 'Shipping Department',
72
+ CompletedOrder: 'Completed Order',
73
+ QuoteRequest: 'Quote Request',
74
+ QuoteSent: 'Quote Sent',
75
+ LeastCostRouting: 'Least Cost Routing',
76
+ Unknown: 'Unknown',
77
+ PreOrdered: 'Pre-ordered',
78
+ AdvancedOrderRouting: 'Advanced Order Routing',
79
+ Hold: 'Hold'
80
+ } as const;
81
+ export type OrderCurrentStageHistoryBeforeStageEnum = typeof OrderCurrentStageHistoryBeforeStageEnum[keyof typeof OrderCurrentStageHistoryBeforeStageEnum];
82
+
83
+
84
+ export function OrderCurrentStageHistoryFromJSON(json: any): OrderCurrentStageHistory {
85
+ return OrderCurrentStageHistoryFromJSONTyped(json, false);
86
+ }
87
+
88
+ export function OrderCurrentStageHistoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCurrentStageHistory {
89
+ if ((json === undefined) || (json === null)) {
90
+ return json;
91
+ }
92
+ return {
93
+
94
+ 'after_stage': !exists(json, 'after_stage') ? undefined : json['after_stage'],
95
+ 'before_stage': !exists(json, 'before_stage') ? undefined : json['before_stage'],
96
+ 'transition_dts': !exists(json, 'transition_dts') ? undefined : json['transition_dts'],
97
+ };
98
+ }
99
+
100
+ export function OrderCurrentStageHistoryToJSON(value?: OrderCurrentStageHistory | null): any {
101
+ if (value === undefined) {
102
+ return undefined;
103
+ }
104
+ if (value === null) {
105
+ return null;
106
+ }
107
+ return {
108
+
109
+ 'after_stage': value.after_stage,
110
+ 'before_stage': value.before_stage,
111
+ 'transition_dts': value.transition_dts,
112
+ };
113
+ }
114
+
@@ -74,6 +74,12 @@ export interface OrderItem {
74
74
  * @memberof OrderItem
75
75
  */
76
76
  activation_codes?: Array<string>;
77
+ /**
78
+ *
79
+ * @type {Currency}
80
+ * @memberof OrderItem
81
+ */
82
+ actual_cogs?: Currency;
77
83
  /**
78
84
  *
79
85
  * @type {Currency}
@@ -479,6 +485,7 @@ export function OrderItemFromJSONTyped(json: any, ignoreDiscriminator: boolean):
479
485
 
480
486
  'accounting_code': !exists(json, 'accounting_code') ? undefined : json['accounting_code'],
481
487
  'activation_codes': !exists(json, 'activation_codes') ? undefined : json['activation_codes'],
488
+ 'actual_cogs': !exists(json, 'actual_cogs') ? undefined : CurrencyFromJSON(json['actual_cogs']),
482
489
  'arbitrary_unit_cost': !exists(json, 'arbitrary_unit_cost') ? undefined : CurrencyFromJSON(json['arbitrary_unit_cost']),
483
490
  'auto_order_last_rebill_dts': !exists(json, 'auto_order_last_rebill_dts') ? undefined : json['auto_order_last_rebill_dts'],
484
491
  'auto_order_schedule': !exists(json, 'auto_order_schedule') ? undefined : json['auto_order_schedule'],
@@ -556,6 +563,7 @@ export function OrderItemToJSON(value?: OrderItem | null): any {
556
563
 
557
564
  'accounting_code': value.accounting_code,
558
565
  'activation_codes': value.activation_codes,
566
+ 'actual_cogs': CurrencyToJSON(value.actual_cogs),
559
567
  'arbitrary_unit_cost': CurrencyToJSON(value.arbitrary_unit_cost),
560
568
  'auto_order_last_rebill_dts': value.auto_order_last_rebill_dts,
561
569
  'auto_order_schedule': value.auto_order_schedule,
@@ -32,12 +32,36 @@ export interface OrderSummary {
32
32
  * @memberof OrderSummary
33
33
  */
34
34
  actual_fulfillment?: Currency;
35
+ /**
36
+ *
37
+ * @type {Currency}
38
+ * @memberof OrderSummary
39
+ */
40
+ actual_other_cost?: Currency;
35
41
  /**
36
42
  *
37
43
  * @type {Currency}
38
44
  * @memberof OrderSummary
39
45
  */
40
46
  actual_payment_processing?: Currency;
47
+ /**
48
+ *
49
+ * @type {Currency}
50
+ * @memberof OrderSummary
51
+ */
52
+ actual_profit?: Currency;
53
+ /**
54
+ * Actual profit has been analyzed
55
+ * @type {boolean}
56
+ * @memberof OrderSummary
57
+ */
58
+ actual_profit_analyzed?: boolean;
59
+ /**
60
+ * Actual profit needs review
61
+ * @type {boolean}
62
+ * @memberof OrderSummary
63
+ */
64
+ actual_profit_review?: boolean;
41
65
  /**
42
66
  *
43
67
  * @type {Currency}
@@ -171,7 +195,11 @@ export function OrderSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolea
171
195
  return {
172
196
 
173
197
  'actual_fulfillment': !exists(json, 'actual_fulfillment') ? undefined : CurrencyFromJSON(json['actual_fulfillment']),
198
+ 'actual_other_cost': !exists(json, 'actual_other_cost') ? undefined : CurrencyFromJSON(json['actual_other_cost']),
174
199
  'actual_payment_processing': !exists(json, 'actual_payment_processing') ? undefined : CurrencyFromJSON(json['actual_payment_processing']),
200
+ 'actual_profit': !exists(json, 'actual_profit') ? undefined : CurrencyFromJSON(json['actual_profit']),
201
+ 'actual_profit_analyzed': !exists(json, 'actual_profit_analyzed') ? undefined : json['actual_profit_analyzed'],
202
+ 'actual_profit_review': !exists(json, 'actual_profit_review') ? undefined : json['actual_profit_review'],
175
203
  'actual_shipping': !exists(json, 'actual_shipping') ? undefined : CurrencyFromJSON(json['actual_shipping']),
176
204
  'arbitrary_shipping_handling_total': !exists(json, 'arbitrary_shipping_handling_total') ? undefined : CurrencyFromJSON(json['arbitrary_shipping_handling_total']),
177
205
  'health_benefit_card_amount': !exists(json, 'health_benefit_card_amount') ? undefined : CurrencyFromJSON(json['health_benefit_card_amount']),
@@ -205,7 +233,11 @@ export function OrderSummaryToJSON(value?: OrderSummary | null): any {
205
233
  return {
206
234
 
207
235
  'actual_fulfillment': CurrencyToJSON(value.actual_fulfillment),
236
+ 'actual_other_cost': CurrencyToJSON(value.actual_other_cost),
208
237
  'actual_payment_processing': CurrencyToJSON(value.actual_payment_processing),
238
+ 'actual_profit': CurrencyToJSON(value.actual_profit),
239
+ 'actual_profit_analyzed': value.actual_profit_analyzed,
240
+ 'actual_profit_review': value.actual_profit_review,
209
241
  'actual_shipping': CurrencyToJSON(value.actual_shipping),
210
242
  'arbitrary_shipping_handling_total': CurrencyToJSON(value.arbitrary_shipping_handling_total),
211
243
  'health_benefit_card_amount': CurrencyToJSON(value.health_benefit_card_amount),
@@ -617,6 +617,7 @@ export * from './OrderByTokenQuery';
617
617
  export * from './OrderChannelPartner';
618
618
  export * from './OrderCheckout';
619
619
  export * from './OrderCoupon';
620
+ export * from './OrderCurrentStageHistory';
620
621
  export * from './OrderDigitalItem';
621
622
  export * from './OrderDigitalOrder';
622
623
  export * from './OrderEdi';