ultracart_rest_api_v2_typescript 4.0.230 → 4.0.231

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.230
1
+ ## ultracart_rest_api_v2_typescript@4.0.231
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.230 --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.231 --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.231 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
57
58
  | 4.0.230 | 06/24/2024 | conversation object cleanup |
58
59
  | 4.0.229 | 06/14/2024 | pbx menu - add say voice property |
59
60
  | 4.0.228 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
@@ -123,6 +123,7 @@ export interface RefundOrderRequest {
123
123
  manualRefund?: boolean;
124
124
  reverseAffiliateTransactions?: boolean;
125
125
  issueStoreCredit?: boolean;
126
+ autoOrderCancelReason?: string;
126
127
  expand?: string;
127
128
  }
128
129
  export interface ReplacementRequest {
@@ -489,6 +490,7 @@ export interface OrderApiInterface {
489
490
  * @param {boolean} [manualRefund] Consider a manual refund done externally
490
491
  * @param {boolean} [reverseAffiliateTransactions] Reverse affiliate transactions
491
492
  * @param {boolean} [issueStoreCredit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
493
+ * @param {string} [autoOrderCancelReason] Reason for auto orders cancellation
492
494
  * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
493
495
  * @param {*} [options] Override http request option.
494
496
  * @throws {RequiredError}
@@ -1437,6 +1437,9 @@ var OrderApi = /** @class */ (function (_super) {
1437
1437
  if (requestParameters.issueStoreCredit !== undefined) {
1438
1438
  queryParameters['issue_store_credit'] = requestParameters.issueStoreCredit;
1439
1439
  }
1440
+ if (requestParameters.autoOrderCancelReason !== undefined) {
1441
+ queryParameters['auto_order_cancel_reason'] = requestParameters.autoOrderCancelReason;
1442
+ }
1440
1443
  if (requestParameters.expand !== undefined) {
1441
1444
  queryParameters['_expand'] = requestParameters.expand;
1442
1445
  }
@@ -21,7 +21,21 @@ export interface OrderQueryBatch {
21
21
  * @memberof OrderQueryBatch
22
22
  */
23
23
  order_ids?: Array<string>;
24
+ /**
25
+ * Query Target
26
+ * @type {string}
27
+ * @memberof OrderQueryBatch
28
+ */
29
+ query_target?: OrderQueryBatchQueryTargetEnum;
24
30
  }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const OrderQueryBatchQueryTargetEnum: {
35
+ readonly Origin: "origin";
36
+ readonly Cache: "cache";
37
+ };
38
+ export type OrderQueryBatchQueryTargetEnum = typeof OrderQueryBatchQueryTargetEnum[keyof typeof OrderQueryBatchQueryTargetEnum];
25
39
  export declare function OrderQueryBatchFromJSON(json: any): OrderQueryBatch;
26
40
  export declare function OrderQueryBatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderQueryBatch;
27
41
  export declare function OrderQueryBatchToJSON(value?: OrderQueryBatch | null): any;
@@ -13,8 +13,15 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.OrderQueryBatchToJSON = exports.OrderQueryBatchFromJSONTyped = exports.OrderQueryBatchFromJSON = void 0;
16
+ exports.OrderQueryBatchToJSON = exports.OrderQueryBatchFromJSONTyped = exports.OrderQueryBatchFromJSON = exports.OrderQueryBatchQueryTargetEnum = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ /**
19
+ * @export
20
+ */
21
+ exports.OrderQueryBatchQueryTargetEnum = {
22
+ Origin: 'origin',
23
+ Cache: 'cache'
24
+ };
18
25
  function OrderQueryBatchFromJSON(json) {
19
26
  return OrderQueryBatchFromJSONTyped(json, false);
20
27
  }
@@ -25,6 +32,7 @@ function OrderQueryBatchFromJSONTyped(json, ignoreDiscriminator) {
25
32
  }
26
33
  return {
27
34
  'order_ids': !(0, runtime_1.exists)(json, 'order_ids') ? undefined : json['order_ids'],
35
+ 'query_target': !(0, runtime_1.exists)(json, 'query_target') ? undefined : json['query_target'],
28
36
  };
29
37
  }
30
38
  exports.OrderQueryBatchFromJSONTyped = OrderQueryBatchFromJSONTyped;
@@ -37,6 +45,7 @@ function OrderQueryBatchToJSON(value) {
37
45
  }
38
46
  return {
39
47
  'order_ids': value.order_ids,
48
+ 'query_target': value.query_target,
40
49
  };
41
50
  }
42
51
  exports.OrderQueryBatchToJSON = OrderQueryBatchToJSON;
@@ -15,6 +15,18 @@
15
15
  * @interface SelfConfig
16
16
  */
17
17
  export interface SelfConfig {
18
+ /**
19
+ * True if the Colorado Retail Delivery Fee should not be collected
20
+ * @type {boolean}
21
+ * @memberof SelfConfig
22
+ */
23
+ exempt_from_colorado_retail_delivery_fee?: boolean;
24
+ /**
25
+ * True if the Minnesota Retail Delivery Fee should not be collected
26
+ * @type {boolean}
27
+ * @memberof SelfConfig
28
+ */
29
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
18
30
  /**
19
31
  * True if sales tax should be collected based on billing address instead of shipping address
20
32
  * @type {boolean}
@@ -24,6 +24,8 @@ function SelfConfigFromJSONTyped(json, ignoreDiscriminator) {
24
24
  return json;
25
25
  }
26
26
  return {
27
+ 'exempt_from_colorado_retail_delivery_fee': !(0, runtime_1.exists)(json, 'exempt_from_colorado_retail_delivery_fee') ? undefined : json['exempt_from_colorado_retail_delivery_fee'],
28
+ 'exempt_from_minnesota_retail_delivery_fee': !(0, runtime_1.exists)(json, 'exempt_from_minnesota_retail_delivery_fee') ? undefined : json['exempt_from_minnesota_retail_delivery_fee'],
27
29
  'tax_billing': !(0, runtime_1.exists)(json, 'tax_billing') ? undefined : json['tax_billing'],
28
30
  };
29
31
  }
@@ -36,6 +38,8 @@ function SelfConfigToJSON(value) {
36
38
  return null;
37
39
  }
38
40
  return {
41
+ 'exempt_from_colorado_retail_delivery_fee': value.exempt_from_colorado_retail_delivery_fee,
42
+ 'exempt_from_minnesota_retail_delivery_fee': value.exempt_from_minnesota_retail_delivery_fee,
39
43
  'tax_billing': value.tax_billing,
40
44
  };
41
45
  }
@@ -15,6 +15,18 @@
15
15
  * @interface UltraCartConfig
16
16
  */
17
17
  export interface UltraCartConfig {
18
+ /**
19
+ * True if the Colorado Retail Delivery Fee should not be collected
20
+ * @type {boolean}
21
+ * @memberof UltraCartConfig
22
+ */
23
+ exempt_from_colorado_retail_delivery_fee?: boolean;
24
+ /**
25
+ * True if the Minnesota Retail Delivery Fee should not be collected
26
+ * @type {boolean}
27
+ * @memberof UltraCartConfig
28
+ */
29
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
18
30
  /**
19
31
  * True if sales tax should be collected based on billing address instead of shipping address
20
32
  * @type {boolean}
@@ -24,6 +24,8 @@ function UltraCartConfigFromJSONTyped(json, ignoreDiscriminator) {
24
24
  return json;
25
25
  }
26
26
  return {
27
+ 'exempt_from_colorado_retail_delivery_fee': !(0, runtime_1.exists)(json, 'exempt_from_colorado_retail_delivery_fee') ? undefined : json['exempt_from_colorado_retail_delivery_fee'],
28
+ 'exempt_from_minnesota_retail_delivery_fee': !(0, runtime_1.exists)(json, 'exempt_from_minnesota_retail_delivery_fee') ? undefined : json['exempt_from_minnesota_retail_delivery_fee'],
27
29
  'tax_billing': !(0, runtime_1.exists)(json, 'tax_billing') ? undefined : json['tax_billing'],
28
30
  };
29
31
  }
@@ -36,6 +38,8 @@ function UltraCartConfigToJSON(value) {
36
38
  return null;
37
39
  }
38
40
  return {
41
+ 'exempt_from_colorado_retail_delivery_fee': value.exempt_from_colorado_retail_delivery_fee,
42
+ 'exempt_from_minnesota_retail_delivery_fee': value.exempt_from_minnesota_retail_delivery_fee,
39
43
  'tax_billing': value.tax_billing,
40
44
  };
41
45
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.0.230",
3
+ "version": "4.0.231",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -220,6 +220,7 @@ export interface RefundOrderRequest {
220
220
  manualRefund?: boolean;
221
221
  reverseAffiliateTransactions?: boolean;
222
222
  issueStoreCredit?: boolean;
223
+ autoOrderCancelReason?: string;
223
224
  expand?: string;
224
225
  }
225
226
 
@@ -633,6 +634,7 @@ export interface OrderApiInterface {
633
634
  * @param {boolean} [manualRefund] Consider a manual refund done externally
634
635
  * @param {boolean} [reverseAffiliateTransactions] Reverse affiliate transactions
635
636
  * @param {boolean} [issueStoreCredit] Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
637
+ * @param {string} [autoOrderCancelReason] Reason for auto orders cancellation
636
638
  * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
637
639
  * @param {*} [options] Override http request option.
638
640
  * @throws {RequiredError}
@@ -1808,6 +1810,10 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
1808
1810
  queryParameters['issue_store_credit'] = requestParameters.issueStoreCredit;
1809
1811
  }
1810
1812
 
1813
+ if (requestParameters.autoOrderCancelReason !== undefined) {
1814
+ queryParameters['auto_order_cancel_reason'] = requestParameters.autoOrderCancelReason;
1815
+ }
1816
+
1811
1817
  if (requestParameters.expand !== undefined) {
1812
1818
  queryParameters['_expand'] = requestParameters.expand;
1813
1819
  }
@@ -25,8 +25,25 @@ export interface OrderQueryBatch {
25
25
  * @memberof OrderQueryBatch
26
26
  */
27
27
  order_ids?: Array<string>;
28
+ /**
29
+ * Query Target
30
+ * @type {string}
31
+ * @memberof OrderQueryBatch
32
+ */
33
+ query_target?: OrderQueryBatchQueryTargetEnum;
28
34
  }
29
35
 
36
+
37
+ /**
38
+ * @export
39
+ */
40
+ export const OrderQueryBatchQueryTargetEnum = {
41
+ Origin: 'origin',
42
+ Cache: 'cache'
43
+ } as const;
44
+ export type OrderQueryBatchQueryTargetEnum = typeof OrderQueryBatchQueryTargetEnum[keyof typeof OrderQueryBatchQueryTargetEnum];
45
+
46
+
30
47
  export function OrderQueryBatchFromJSON(json: any): OrderQueryBatch {
31
48
  return OrderQueryBatchFromJSONTyped(json, false);
32
49
  }
@@ -38,6 +55,7 @@ export function OrderQueryBatchFromJSONTyped(json: any, ignoreDiscriminator: boo
38
55
  return {
39
56
 
40
57
  'order_ids': !exists(json, 'order_ids') ? undefined : json['order_ids'],
58
+ 'query_target': !exists(json, 'query_target') ? undefined : json['query_target'],
41
59
  };
42
60
  }
43
61
 
@@ -51,6 +69,7 @@ export function OrderQueryBatchToJSON(value?: OrderQueryBatch | null): any {
51
69
  return {
52
70
 
53
71
  'order_ids': value.order_ids,
72
+ 'query_target': value.query_target,
54
73
  };
55
74
  }
56
75
 
@@ -19,6 +19,18 @@ import { exists, mapValues } from '../runtime';
19
19
  * @interface SelfConfig
20
20
  */
21
21
  export interface SelfConfig {
22
+ /**
23
+ * True if the Colorado Retail Delivery Fee should not be collected
24
+ * @type {boolean}
25
+ * @memberof SelfConfig
26
+ */
27
+ exempt_from_colorado_retail_delivery_fee?: boolean;
28
+ /**
29
+ * True if the Minnesota Retail Delivery Fee should not be collected
30
+ * @type {boolean}
31
+ * @memberof SelfConfig
32
+ */
33
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
22
34
  /**
23
35
  * True if sales tax should be collected based on billing address instead of shipping address
24
36
  * @type {boolean}
@@ -37,6 +49,8 @@ export function SelfConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean)
37
49
  }
38
50
  return {
39
51
 
52
+ 'exempt_from_colorado_retail_delivery_fee': !exists(json, 'exempt_from_colorado_retail_delivery_fee') ? undefined : json['exempt_from_colorado_retail_delivery_fee'],
53
+ 'exempt_from_minnesota_retail_delivery_fee': !exists(json, 'exempt_from_minnesota_retail_delivery_fee') ? undefined : json['exempt_from_minnesota_retail_delivery_fee'],
40
54
  'tax_billing': !exists(json, 'tax_billing') ? undefined : json['tax_billing'],
41
55
  };
42
56
  }
@@ -50,6 +64,8 @@ export function SelfConfigToJSON(value?: SelfConfig | null): any {
50
64
  }
51
65
  return {
52
66
 
67
+ 'exempt_from_colorado_retail_delivery_fee': value.exempt_from_colorado_retail_delivery_fee,
68
+ 'exempt_from_minnesota_retail_delivery_fee': value.exempt_from_minnesota_retail_delivery_fee,
53
69
  'tax_billing': value.tax_billing,
54
70
  };
55
71
  }
@@ -19,6 +19,18 @@ import { exists, mapValues } from '../runtime';
19
19
  * @interface UltraCartConfig
20
20
  */
21
21
  export interface UltraCartConfig {
22
+ /**
23
+ * True if the Colorado Retail Delivery Fee should not be collected
24
+ * @type {boolean}
25
+ * @memberof UltraCartConfig
26
+ */
27
+ exempt_from_colorado_retail_delivery_fee?: boolean;
28
+ /**
29
+ * True if the Minnesota Retail Delivery Fee should not be collected
30
+ * @type {boolean}
31
+ * @memberof UltraCartConfig
32
+ */
33
+ exempt_from_minnesota_retail_delivery_fee?: boolean;
22
34
  /**
23
35
  * True if sales tax should be collected based on billing address instead of shipping address
24
36
  * @type {boolean}
@@ -37,6 +49,8 @@ export function UltraCartConfigFromJSONTyped(json: any, ignoreDiscriminator: boo
37
49
  }
38
50
  return {
39
51
 
52
+ 'exempt_from_colorado_retail_delivery_fee': !exists(json, 'exempt_from_colorado_retail_delivery_fee') ? undefined : json['exempt_from_colorado_retail_delivery_fee'],
53
+ 'exempt_from_minnesota_retail_delivery_fee': !exists(json, 'exempt_from_minnesota_retail_delivery_fee') ? undefined : json['exempt_from_minnesota_retail_delivery_fee'],
40
54
  'tax_billing': !exists(json, 'tax_billing') ? undefined : json['tax_billing'],
41
55
  };
42
56
  }
@@ -50,6 +64,8 @@ export function UltraCartConfigToJSON(value?: UltraCartConfig | null): any {
50
64
  }
51
65
  return {
52
66
 
67
+ 'exempt_from_colorado_retail_delivery_fee': value.exempt_from_colorado_retail_delivery_fee,
68
+ 'exempt_from_minnesota_retail_delivery_fee': value.exempt_from_minnesota_retail_delivery_fee,
53
69
  'tax_billing': value.tax_billing,
54
70
  };
55
71
  }