ultracart_rest_api_v2_typescript 4.0.240 → 4.0.242

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.
Files changed (46) hide show
  1. package/.openapi-generator/FILES +3 -2
  2. package/README.md +4 -2
  3. package/dist/apis/FulfillmentApi.d.ts +9 -9
  4. package/dist/apis/FulfillmentApi.js +3 -3
  5. package/dist/apis/OauthApi.d.ts +1 -1
  6. package/dist/apis/WebhookApi.d.ts +5 -5
  7. package/dist/apis/WebhookApi.js +1 -1
  8. package/dist/models/ChannelPartnerOrder.d.ts +6 -0
  9. package/dist/models/ChannelPartnerOrder.js +2 -0
  10. package/dist/models/CustomerAttachment.d.ts +1 -1
  11. package/dist/models/ItemPaymentProcessing.d.ts +6 -0
  12. package/dist/models/ItemPaymentProcessing.js +2 -0
  13. package/dist/models/ItemReview.d.ts +6 -0
  14. package/dist/models/ItemReview.js +2 -0
  15. package/dist/models/Order.d.ts +7 -0
  16. package/dist/models/Order.js +3 -0
  17. package/dist/models/OrderCurrentStageHistory.d.ts +77 -0
  18. package/dist/models/OrderCurrentStageHistory.js +82 -0
  19. package/dist/models/OrderItem.d.ts +6 -0
  20. package/dist/models/OrderItem.js +2 -0
  21. package/dist/models/OrderSummary.d.ts +24 -0
  22. package/dist/models/OrderSummary.js +8 -0
  23. package/dist/models/WebhookReflow.d.ts +33 -0
  24. package/dist/models/WebhookReflow.js +44 -0
  25. package/dist/models/WebhookReflowResponse.d.ts +55 -0
  26. package/dist/models/WebhookReflowResponse.js +54 -0
  27. package/dist/models/index.d.ts +3 -2
  28. package/dist/models/index.js +3 -2
  29. package/package.json +1 -1
  30. package/src/apis/FulfillmentApi.ts +12 -9
  31. package/src/apis/OauthApi.ts +1 -1
  32. package/src/apis/WebhookApi.ts +8 -8
  33. package/src/models/ChannelPartnerOrder.ts +8 -0
  34. package/src/models/CustomerAttachment.ts +1 -1
  35. package/src/models/ItemPaymentProcessing.ts +8 -0
  36. package/src/models/ItemReview.ts +8 -0
  37. package/src/models/Order.ts +14 -0
  38. package/src/models/OrderCurrentStageHistory.ts +114 -0
  39. package/src/models/OrderItem.ts +8 -0
  40. package/src/models/OrderSummary.ts +32 -0
  41. package/src/models/WebhookReflow.ts +64 -0
  42. package/src/models/{WebhookSampleRequestResponse.ts → WebhookReflowResponse.ts} +23 -23
  43. package/src/models/index.ts +3 -2
  44. package/dist/models/WebhookSampleRequest.d.ts +0 -46
  45. package/dist/models/WebhookSampleRequestResponse.d.ts +0 -55
  46. package/src/models/WebhookSampleRequest.ts +0 -87
@@ -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
@@ -856,9 +857,9 @@ src/models/WebhookLog.ts
856
857
  src/models/WebhookLogResponse.ts
857
858
  src/models/WebhookLogSummariesResponse.ts
858
859
  src/models/WebhookLogSummary.ts
860
+ src/models/WebhookReflow.ts
861
+ src/models/WebhookReflowResponse.ts
859
862
  src/models/WebhookResponse.ts
860
- src/models/WebhookSampleRequest.ts
861
- src/models/WebhookSampleRequestResponse.ts
862
863
  src/models/WebhooksResponse.ts
863
864
  src/models/Weight.ts
864
865
  src/models/WorkflowAgentAuth.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.242
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.242 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 4.0.242 | 02/18/2025 | small bug fixes for incorrect return types on several methods |
58
+ | 4.0.241 | 02/06/2025 | added storefront_host_name to channel partner order object |
57
59
  | 4.0.240 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
58
60
  | 4.0.239 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
59
61
  | 4.0.238 | 12/13/2024 | added user and group ids to conversation agent auth object |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { DistributionCentersResponse, FulfillmentInventory, FulfillmentShipment, OrdersResponse } from '../models';
13
+ import { DistributionCentersResponse, FulfillmentInventory, FulfillmentShipment, OrderPackingSlipResponse, OrdersResponse } from '../models';
14
14
  export interface AcknowledgeOrdersRequest {
15
15
  distributionCenterCode: string;
16
16
  orderIds: Array<string>;
@@ -61,14 +61,14 @@ export interface FulfillmentApiInterface {
61
61
  * @throws {RequiredError}
62
62
  * @memberof FulfillmentApiInterface
63
63
  */
64
- generatePackingSlipRaw(requestParameters: GeneratePackingSlipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrdersResponse>>;
64
+ generatePackingSlipRaw(requestParameters: GeneratePackingSlipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPackingSlipResponse>>;
65
65
  /**
66
66
  * The packing slip PDF that is returned is base 64 encoded
67
67
  * Generate a packing slip for this order for the given distribution center.
68
68
  */
69
- generatePackingSlip(requestParameters: GeneratePackingSlipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
69
+ generatePackingSlip(requestParameters: GeneratePackingSlipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPackingSlipResponse>;
70
70
  /**
71
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
71
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
72
72
  * @summary Retrieve orders queued up for this distribution center.
73
73
  * @param {string} distributionCenterCode Distribution center code
74
74
  * @param {*} [options] Override http request option.
@@ -77,7 +77,7 @@ export interface FulfillmentApiInterface {
77
77
  */
78
78
  getDistributionCenterOrdersRaw(requestParameters: GetDistributionCenterOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrdersResponse>>;
79
79
  /**
80
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
80
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
81
81
  * Retrieve orders queued up for this distribution center.
82
82
  */
83
83
  getDistributionCenterOrders(requestParameters: GetDistributionCenterOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
@@ -143,19 +143,19 @@ export declare class FulfillmentApi extends runtime.BaseAPI implements Fulfillme
143
143
  * The packing slip PDF that is returned is base 64 encoded
144
144
  * Generate a packing slip for this order for the given distribution center.
145
145
  */
146
- generatePackingSlipRaw(requestParameters: GeneratePackingSlipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrdersResponse>>;
146
+ generatePackingSlipRaw(requestParameters: GeneratePackingSlipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPackingSlipResponse>>;
147
147
  /**
148
148
  * The packing slip PDF that is returned is base 64 encoded
149
149
  * Generate a packing slip for this order for the given distribution center.
150
150
  */
151
- generatePackingSlip(requestParameters: GeneratePackingSlipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
151
+ generatePackingSlip(requestParameters: GeneratePackingSlipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPackingSlipResponse>;
152
152
  /**
153
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
153
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
154
154
  * Retrieve orders queued up for this distribution center.
155
155
  */
156
156
  getDistributionCenterOrdersRaw(requestParameters: GetDistributionCenterOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrdersResponse>>;
157
157
  /**
158
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
158
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
159
159
  * Retrieve orders queued up for this distribution center.
160
160
  */
161
161
  getDistributionCenterOrders(requestParameters: GetDistributionCenterOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
@@ -176,7 +176,7 @@ var FulfillmentApi = /** @class */ (function (_super) {
176
176
  }, initOverrides)];
177
177
  case 3:
178
178
  response = _c.sent();
179
- return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrdersResponseFromJSON)(jsonValue); })];
179
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderPackingSlipResponseFromJSON)(jsonValue); })];
180
180
  }
181
181
  });
182
182
  });
@@ -200,7 +200,7 @@ var FulfillmentApi = /** @class */ (function (_super) {
200
200
  });
201
201
  };
202
202
  /**
203
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
203
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
204
204
  * Retrieve orders queued up for this distribution center.
205
205
  */
206
206
  FulfillmentApi.prototype.getDistributionCenterOrdersRaw = function (requestParameters, initOverrides) {
@@ -241,7 +241,7 @@ var FulfillmentApi = /** @class */ (function (_super) {
241
241
  });
242
242
  };
243
243
  /**
244
- * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
244
+ * Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You\'ll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.
245
245
  * Retrieve orders queued up for this distribution center.
246
246
  */
247
247
  FulfillmentApi.prototype.getDistributionCenterOrders = function (requestParameters, initOverrides) {
@@ -35,7 +35,7 @@ export interface OauthApiInterface {
35
35
  * @param {string} clientId The OAuth application client_id.
36
36
  * @param {string} grantType Type of grant
37
37
  * @param {string} [code] Authorization code received back from the browser redirect
38
- * @param {string} [redirectUri] The URI that you redirect the browser to to start the authorization process
38
+ * @param {string} [redirectUri] The URI that you redirect the browser to start the authorization process
39
39
  * @param {string} [refreshToken] The refresh token received during the original grant_type&#x3D;authorization_code that can be used to return a new access token
40
40
  * @param {*} [options] Override http request option.
41
41
  * @throws {RequiredError}
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { Webhook, WebhookLogResponse, WebhookLogSummariesResponse, WebhookResponse, WebhookSampleRequestResponse, WebhooksResponse } from '../models';
13
+ import { Webhook, WebhookLogResponse, WebhookLogSummariesResponse, WebhookReflowResponse, WebhookResponse, WebhooksResponse } from '../models';
14
14
  export interface DeleteWebhookRequest {
15
15
  webhookOid: number;
16
16
  }
@@ -154,12 +154,12 @@ export interface WebhookApiInterface {
154
154
  * @throws {RequiredError}
155
155
  * @memberof WebhookApiInterface
156
156
  */
157
- resendEventRaw(requestParameters: ResendEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookSampleRequestResponse>>;
157
+ resendEventRaw(requestParameters: ResendEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookReflowResponse>>;
158
158
  /**
159
159
  * This method will resend events to the webhook endpoint. This method can be used for example to send all the existing items on an account to a webhook.
160
160
  * Resend events to the webhook endpoint.
161
161
  */
162
- resendEvent(requestParameters: ResendEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookSampleRequestResponse>;
162
+ resendEvent(requestParameters: ResendEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookReflowResponse>;
163
163
  /**
164
164
  * Update a webhook on the account
165
165
  * @summary Update a webhook
@@ -245,12 +245,12 @@ export declare class WebhookApi extends runtime.BaseAPI implements WebhookApiInt
245
245
  * This method will resend events to the webhook endpoint. This method can be used for example to send all the existing items on an account to a webhook.
246
246
  * Resend events to the webhook endpoint.
247
247
  */
248
- resendEventRaw(requestParameters: ResendEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookSampleRequestResponse>>;
248
+ resendEventRaw(requestParameters: ResendEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookReflowResponse>>;
249
249
  /**
250
250
  * This method will resend events to the webhook endpoint. This method can be used for example to send all the existing items on an account to a webhook.
251
251
  * Resend events to the webhook endpoint.
252
252
  */
253
- resendEvent(requestParameters: ResendEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookSampleRequestResponse>;
253
+ resendEvent(requestParameters: ResendEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookReflowResponse>;
254
254
  /**
255
255
  * Update a webhook on the account
256
256
  * Update a webhook
@@ -495,7 +495,7 @@ var WebhookApi = /** @class */ (function (_super) {
495
495
  }, initOverrides)];
496
496
  case 3:
497
497
  response = _c.sent();
498
- return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.WebhookSampleRequestResponseFromJSON)(jsonValue); })];
498
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.WebhookReflowResponseFromJSON)(jsonValue); })];
499
499
  }
500
500
  });
501
501
  });
@@ -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
  */
@@ -21,6 +21,12 @@ export interface ItemPaymentProcessing {
21
21
  * @memberof ItemPaymentProcessing
22
22
  */
23
23
  block_prepaid?: boolean;
24
+ /**
25
+ * True if this item should block any refund attempts
26
+ * @type {boolean}
27
+ * @memberof ItemPaymentProcessing
28
+ */
29
+ block_refunds?: boolean;
24
30
  /**
25
31
  * Credit card transaction type
26
32
  * @type {string}
@@ -25,6 +25,7 @@ function ItemPaymentProcessingFromJSONTyped(json, ignoreDiscriminator) {
25
25
  }
26
26
  return {
27
27
  'block_prepaid': !(0, runtime_1.exists)(json, 'block_prepaid') ? undefined : json['block_prepaid'],
28
+ 'block_refunds': !(0, runtime_1.exists)(json, 'block_refunds') ? undefined : json['block_refunds'],
28
29
  'credit_card_transaction_type': !(0, runtime_1.exists)(json, 'credit_card_transaction_type') ? undefined : json['credit_card_transaction_type'],
29
30
  'no_realtime_charge': !(0, runtime_1.exists)(json, 'no_realtime_charge') ? undefined : json['no_realtime_charge'],
30
31
  'payment_method_validity': !(0, runtime_1.exists)(json, 'payment_method_validity') ? undefined : json['payment_method_validity'],
@@ -41,6 +42,7 @@ function ItemPaymentProcessingToJSON(value) {
41
42
  }
42
43
  return {
43
44
  'block_prepaid': value.block_prepaid,
45
+ 'block_refunds': value.block_refunds,
44
46
  'credit_card_transaction_type': value.credit_card_transaction_type,
45
47
  'no_realtime_charge': value.no_realtime_charge,
46
48
  'payment_method_validity': value.payment_method_validity,
@@ -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),
@@ -0,0 +1,33 @@
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 WebhookReflow
16
+ */
17
+ export interface WebhookReflow {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof WebhookReflow
22
+ */
23
+ event_name?: string;
24
+ /**
25
+ *
26
+ * @type {boolean}
27
+ * @memberof WebhookReflow
28
+ */
29
+ queued?: boolean;
30
+ }
31
+ export declare function WebhookReflowFromJSON(json: any): WebhookReflow;
32
+ export declare function WebhookReflowFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookReflow;
33
+ export declare function WebhookReflowToJSON(value?: WebhookReflow | null): any;