ultracart_rest_api_v2_typescript 4.0.229 → 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 +4 -2
- package/dist/apis/OrderApi.d.ts +2 -0
- package/dist/apis/OrderApi.js +3 -0
- package/dist/apis/StorefrontApi.d.ts +26 -0
- package/dist/apis/StorefrontApi.js +61 -0
- package/dist/models/OrderQueryBatch.d.ts +14 -0
- package/dist/models/OrderQueryBatch.js +10 -1
- package/dist/models/SelfConfig.d.ts +12 -0
- package/dist/models/SelfConfig.js +4 -0
- package/dist/models/Twilio.d.ts +0 -24
- package/dist/models/Twilio.js +0 -8
- package/dist/models/UltraCartConfig.d.ts +12 -0
- package/dist/models/UltraCartConfig.js +4 -0
- package/package.json +1 -1
- package/src/apis/OrderApi.ts +6 -0
- package/src/apis/StorefrontApi.ts +67 -0
- package/src/models/OrderQueryBatch.ts +19 -0
- package/src/models/SelfConfig.ts +16 -0
- package/src/models/Twilio.ts +0 -32
- package/src/models/UltraCartConfig.ts +16 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.0.
|
|
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.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@4.0.231 --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.231 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
|
|
58
|
+
| 4.0.230 | 06/24/2024 | conversation object cleanup |
|
|
57
59
|
| 4.0.229 | 06/14/2024 | pbx menu - add say voice property |
|
|
58
60
|
| 4.0.228 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
|
|
59
61
|
| 4.0.227 | 06/03/2024 | conversationPbxPhoneNumber - fix serialized name for phone number UUID |
|
package/dist/apis/OrderApi.d.ts
CHANGED
|
@@ -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}
|
package/dist/apis/OrderApi.js
CHANGED
|
@@ -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
|
}
|
|
@@ -616,6 +616,10 @@ export interface SubscribeToEmailListRequest {
|
|
|
616
616
|
emailListUuid: string;
|
|
617
617
|
customers: Array<EmailCustomer>;
|
|
618
618
|
}
|
|
619
|
+
export interface SunsetEmailSegmentRequest {
|
|
620
|
+
storefrontOid: number;
|
|
621
|
+
emailSegmentUuid: string;
|
|
622
|
+
}
|
|
619
623
|
export interface UnfavoriteScreenRecordingRequest {
|
|
620
624
|
storefrontOid: number;
|
|
621
625
|
screenRecordingUuid: string;
|
|
@@ -2876,6 +2880,20 @@ export interface StorefrontApiInterface {
|
|
|
2876
2880
|
* Subscribe customers to email list
|
|
2877
2881
|
*/
|
|
2878
2882
|
subscribeToEmailList(requestParameters: SubscribeToEmailListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailListSubscribeResponse>;
|
|
2883
|
+
/**
|
|
2884
|
+
*
|
|
2885
|
+
* @summary Sunset email segment
|
|
2886
|
+
* @param {number} storefrontOid
|
|
2887
|
+
* @param {string} emailSegmentUuid
|
|
2888
|
+
* @param {*} [options] Override http request option.
|
|
2889
|
+
* @throws {RequiredError}
|
|
2890
|
+
* @memberof StorefrontApiInterface
|
|
2891
|
+
*/
|
|
2892
|
+
sunsetEmailSegmentRaw(requestParameters: SunsetEmailSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
2893
|
+
/**
|
|
2894
|
+
* Sunset email segment
|
|
2895
|
+
*/
|
|
2896
|
+
sunsetEmailSegment(requestParameters: SunsetEmailSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
2879
2897
|
/**
|
|
2880
2898
|
* Remove favorite flag on screen recording
|
|
2881
2899
|
* @summary Remove favorite flag on screen recording
|
|
@@ -4503,6 +4521,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
|
|
|
4503
4521
|
* Subscribe customers to email list
|
|
4504
4522
|
*/
|
|
4505
4523
|
subscribeToEmailList(requestParameters: SubscribeToEmailListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailListSubscribeResponse>;
|
|
4524
|
+
/**
|
|
4525
|
+
* Sunset email segment
|
|
4526
|
+
*/
|
|
4527
|
+
sunsetEmailSegmentRaw(requestParameters: SunsetEmailSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
4528
|
+
/**
|
|
4529
|
+
* Sunset email segment
|
|
4530
|
+
*/
|
|
4531
|
+
sunsetEmailSegment(requestParameters: SunsetEmailSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
4506
4532
|
/**
|
|
4507
4533
|
* Remove favorite flag on screen recording
|
|
4508
4534
|
* Remove favorite flag on screen recording
|
|
@@ -9638,6 +9638,67 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
9638
9638
|
});
|
|
9639
9639
|
});
|
|
9640
9640
|
};
|
|
9641
|
+
/**
|
|
9642
|
+
* Sunset email segment
|
|
9643
|
+
*/
|
|
9644
|
+
StorefrontApi.prototype.sunsetEmailSegmentRaw = function (requestParameters, initOverrides) {
|
|
9645
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
9646
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
9647
|
+
return __generator(this, function (_c) {
|
|
9648
|
+
switch (_c.label) {
|
|
9649
|
+
case 0:
|
|
9650
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
9651
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling sunsetEmailSegment.');
|
|
9652
|
+
}
|
|
9653
|
+
if (requestParameters.emailSegmentUuid === null || requestParameters.emailSegmentUuid === undefined) {
|
|
9654
|
+
throw new runtime.RequiredError('emailSegmentUuid', 'Required parameter requestParameters.emailSegmentUuid was null or undefined when calling sunsetEmailSegment.');
|
|
9655
|
+
}
|
|
9656
|
+
queryParameters = {};
|
|
9657
|
+
headerParameters = {};
|
|
9658
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
9659
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
9660
|
+
}
|
|
9661
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
9662
|
+
// oauth required
|
|
9663
|
+
_a = headerParameters;
|
|
9664
|
+
_b = "Authorization";
|
|
9665
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_write"])];
|
|
9666
|
+
case 1:
|
|
9667
|
+
// oauth required
|
|
9668
|
+
_a[_b] = _c.sent();
|
|
9669
|
+
_c.label = 2;
|
|
9670
|
+
case 2:
|
|
9671
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
9672
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
9673
|
+
}
|
|
9674
|
+
return [4 /*yield*/, this.request({
|
|
9675
|
+
path: "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("email_segment_uuid", "}"), encodeURIComponent(String(requestParameters.emailSegmentUuid))),
|
|
9676
|
+
method: 'PUT',
|
|
9677
|
+
headers: headerParameters,
|
|
9678
|
+
query: queryParameters,
|
|
9679
|
+
}, initOverrides)];
|
|
9680
|
+
case 3:
|
|
9681
|
+
response = _c.sent();
|
|
9682
|
+
return [2 /*return*/, new runtime.VoidApiResponse(response)];
|
|
9683
|
+
}
|
|
9684
|
+
});
|
|
9685
|
+
});
|
|
9686
|
+
};
|
|
9687
|
+
/**
|
|
9688
|
+
* Sunset email segment
|
|
9689
|
+
*/
|
|
9690
|
+
StorefrontApi.prototype.sunsetEmailSegment = function (requestParameters, initOverrides) {
|
|
9691
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
9692
|
+
return __generator(this, function (_a) {
|
|
9693
|
+
switch (_a.label) {
|
|
9694
|
+
case 0: return [4 /*yield*/, this.sunsetEmailSegmentRaw(requestParameters, initOverrides)];
|
|
9695
|
+
case 1:
|
|
9696
|
+
_a.sent();
|
|
9697
|
+
return [2 /*return*/];
|
|
9698
|
+
}
|
|
9699
|
+
});
|
|
9700
|
+
});
|
|
9701
|
+
};
|
|
9641
9702
|
/**
|
|
9642
9703
|
* Remove favorite flag on screen recording
|
|
9643
9704
|
* Remove favorite flag on screen recording
|
|
@@ -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
|
}
|
package/dist/models/Twilio.d.ts
CHANGED
|
@@ -33,12 +33,6 @@ export interface Twilio {
|
|
|
33
33
|
* @memberof Twilio
|
|
34
34
|
*/
|
|
35
35
|
api_key_name?: string;
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
* @type {string}
|
|
39
|
-
* @memberof Twilio
|
|
40
|
-
*/
|
|
41
|
-
api_key_secret?: string;
|
|
42
36
|
/**
|
|
43
37
|
*
|
|
44
38
|
* @type {string}
|
|
@@ -69,24 +63,6 @@ export interface Twilio {
|
|
|
69
63
|
* @memberof Twilio
|
|
70
64
|
*/
|
|
71
65
|
phone_numbers?: Array<string>;
|
|
72
|
-
/**
|
|
73
|
-
*
|
|
74
|
-
* @type {string}
|
|
75
|
-
* @memberof Twilio
|
|
76
|
-
*/
|
|
77
|
-
private_key_pem?: string;
|
|
78
|
-
/**
|
|
79
|
-
*
|
|
80
|
-
* @type {string}
|
|
81
|
-
* @memberof Twilio
|
|
82
|
-
*/
|
|
83
|
-
public_key_pem?: string;
|
|
84
|
-
/**
|
|
85
|
-
*
|
|
86
|
-
* @type {string}
|
|
87
|
-
* @memberof Twilio
|
|
88
|
-
*/
|
|
89
|
-
public_key_sid?: string;
|
|
90
66
|
/**
|
|
91
67
|
*
|
|
92
68
|
* @type {string}
|
package/dist/models/Twilio.js
CHANGED
|
@@ -27,15 +27,11 @@ function TwilioFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
27
27
|
'account_sid': !(0, runtime_1.exists)(json, 'account_sid') ? undefined : json['account_sid'],
|
|
28
28
|
'api_key_id': !(0, runtime_1.exists)(json, 'api_key_id') ? undefined : json['api_key_id'],
|
|
29
29
|
'api_key_name': !(0, runtime_1.exists)(json, 'api_key_name') ? undefined : json['api_key_name'],
|
|
30
|
-
'api_key_secret': !(0, runtime_1.exists)(json, 'api_key_secret') ? undefined : json['api_key_secret'],
|
|
31
30
|
'auth_token': !(0, runtime_1.exists)(json, 'auth_token') ? undefined : json['auth_token'],
|
|
32
31
|
'esp_twilio_uuid': !(0, runtime_1.exists)(json, 'esp_twilio_uuid') ? undefined : json['esp_twilio_uuid'],
|
|
33
32
|
'inbound_twiml_app_sid': !(0, runtime_1.exists)(json, 'inbound_twiml_app_sid') ? undefined : json['inbound_twiml_app_sid'],
|
|
34
33
|
'outbound_twiml_app_sid': !(0, runtime_1.exists)(json, 'outbound_twiml_app_sid') ? undefined : json['outbound_twiml_app_sid'],
|
|
35
34
|
'phone_numbers': !(0, runtime_1.exists)(json, 'phone_numbers') ? undefined : json['phone_numbers'],
|
|
36
|
-
'private_key_pem': !(0, runtime_1.exists)(json, 'private_key_pem') ? undefined : json['private_key_pem'],
|
|
37
|
-
'public_key_pem': !(0, runtime_1.exists)(json, 'public_key_pem') ? undefined : json['public_key_pem'],
|
|
38
|
-
'public_key_sid': !(0, runtime_1.exists)(json, 'public_key_sid') ? undefined : json['public_key_sid'],
|
|
39
35
|
'twilio_workspace_sid': !(0, runtime_1.exists)(json, 'twilio_workspace_sid') ? undefined : json['twilio_workspace_sid'],
|
|
40
36
|
};
|
|
41
37
|
}
|
|
@@ -51,15 +47,11 @@ function TwilioToJSON(value) {
|
|
|
51
47
|
'account_sid': value.account_sid,
|
|
52
48
|
'api_key_id': value.api_key_id,
|
|
53
49
|
'api_key_name': value.api_key_name,
|
|
54
|
-
'api_key_secret': value.api_key_secret,
|
|
55
50
|
'auth_token': value.auth_token,
|
|
56
51
|
'esp_twilio_uuid': value.esp_twilio_uuid,
|
|
57
52
|
'inbound_twiml_app_sid': value.inbound_twiml_app_sid,
|
|
58
53
|
'outbound_twiml_app_sid': value.outbound_twiml_app_sid,
|
|
59
54
|
'phone_numbers': value.phone_numbers,
|
|
60
|
-
'private_key_pem': value.private_key_pem,
|
|
61
|
-
'public_key_pem': value.public_key_pem,
|
|
62
|
-
'public_key_sid': value.public_key_sid,
|
|
63
55
|
'twilio_workspace_sid': value.twilio_workspace_sid,
|
|
64
56
|
};
|
|
65
57
|
}
|
|
@@ -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
package/src/apis/OrderApi.ts
CHANGED
|
@@ -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
|
}
|
|
@@ -1202,6 +1202,11 @@ export interface SubscribeToEmailListRequest {
|
|
|
1202
1202
|
customers: Array<EmailCustomer>;
|
|
1203
1203
|
}
|
|
1204
1204
|
|
|
1205
|
+
export interface SunsetEmailSegmentRequest {
|
|
1206
|
+
storefrontOid: number;
|
|
1207
|
+
emailSegmentUuid: string;
|
|
1208
|
+
}
|
|
1209
|
+
|
|
1205
1210
|
export interface UnfavoriteScreenRecordingRequest {
|
|
1206
1211
|
storefrontOid: number;
|
|
1207
1212
|
screenRecordingUuid: string;
|
|
@@ -3788,6 +3793,22 @@ export interface StorefrontApiInterface {
|
|
|
3788
3793
|
*/
|
|
3789
3794
|
subscribeToEmailList(requestParameters: SubscribeToEmailListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailListSubscribeResponse>;
|
|
3790
3795
|
|
|
3796
|
+
/**
|
|
3797
|
+
*
|
|
3798
|
+
* @summary Sunset email segment
|
|
3799
|
+
* @param {number} storefrontOid
|
|
3800
|
+
* @param {string} emailSegmentUuid
|
|
3801
|
+
* @param {*} [options] Override http request option.
|
|
3802
|
+
* @throws {RequiredError}
|
|
3803
|
+
* @memberof StorefrontApiInterface
|
|
3804
|
+
*/
|
|
3805
|
+
sunsetEmailSegmentRaw(requestParameters: SunsetEmailSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
3806
|
+
|
|
3807
|
+
/**
|
|
3808
|
+
* Sunset email segment
|
|
3809
|
+
*/
|
|
3810
|
+
sunsetEmailSegment(requestParameters: SunsetEmailSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
3811
|
+
|
|
3791
3812
|
/**
|
|
3792
3813
|
* Remove favorite flag on screen recording
|
|
3793
3814
|
* @summary Remove favorite flag on screen recording
|
|
@@ -11445,6 +11466,52 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
|
|
|
11445
11466
|
return await response.value();
|
|
11446
11467
|
}
|
|
11447
11468
|
|
|
11469
|
+
/**
|
|
11470
|
+
* Sunset email segment
|
|
11471
|
+
*/
|
|
11472
|
+
async sunsetEmailSegmentRaw(requestParameters: SunsetEmailSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
11473
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
11474
|
+
throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling sunsetEmailSegment.');
|
|
11475
|
+
}
|
|
11476
|
+
|
|
11477
|
+
if (requestParameters.emailSegmentUuid === null || requestParameters.emailSegmentUuid === undefined) {
|
|
11478
|
+
throw new runtime.RequiredError('emailSegmentUuid','Required parameter requestParameters.emailSegmentUuid was null or undefined when calling sunsetEmailSegment.');
|
|
11479
|
+
}
|
|
11480
|
+
|
|
11481
|
+
const queryParameters: any = {};
|
|
11482
|
+
|
|
11483
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
11484
|
+
|
|
11485
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
11486
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
11487
|
+
}
|
|
11488
|
+
|
|
11489
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
11490
|
+
// oauth required
|
|
11491
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["storefront_write"]);
|
|
11492
|
+
}
|
|
11493
|
+
|
|
11494
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
11495
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
11496
|
+
}
|
|
11497
|
+
|
|
11498
|
+
const response = await this.request({
|
|
11499
|
+
path: `/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"email_segment_uuid"}}`, encodeURIComponent(String(requestParameters.emailSegmentUuid))),
|
|
11500
|
+
method: 'PUT',
|
|
11501
|
+
headers: headerParameters,
|
|
11502
|
+
query: queryParameters,
|
|
11503
|
+
}, initOverrides);
|
|
11504
|
+
|
|
11505
|
+
return new runtime.VoidApiResponse(response);
|
|
11506
|
+
}
|
|
11507
|
+
|
|
11508
|
+
/**
|
|
11509
|
+
* Sunset email segment
|
|
11510
|
+
*/
|
|
11511
|
+
async sunsetEmailSegment(requestParameters: SunsetEmailSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
11512
|
+
await this.sunsetEmailSegmentRaw(requestParameters, initOverrides);
|
|
11513
|
+
}
|
|
11514
|
+
|
|
11448
11515
|
/**
|
|
11449
11516
|
* Remove favorite flag on screen recording
|
|
11450
11517
|
* Remove favorite flag on screen recording
|
|
@@ -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
|
|
package/src/models/SelfConfig.ts
CHANGED
|
@@ -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
|
}
|
package/src/models/Twilio.ts
CHANGED
|
@@ -37,12 +37,6 @@ export interface Twilio {
|
|
|
37
37
|
* @memberof Twilio
|
|
38
38
|
*/
|
|
39
39
|
api_key_name?: string;
|
|
40
|
-
/**
|
|
41
|
-
*
|
|
42
|
-
* @type {string}
|
|
43
|
-
* @memberof Twilio
|
|
44
|
-
*/
|
|
45
|
-
api_key_secret?: string;
|
|
46
40
|
/**
|
|
47
41
|
*
|
|
48
42
|
* @type {string}
|
|
@@ -73,24 +67,6 @@ export interface Twilio {
|
|
|
73
67
|
* @memberof Twilio
|
|
74
68
|
*/
|
|
75
69
|
phone_numbers?: Array<string>;
|
|
76
|
-
/**
|
|
77
|
-
*
|
|
78
|
-
* @type {string}
|
|
79
|
-
* @memberof Twilio
|
|
80
|
-
*/
|
|
81
|
-
private_key_pem?: string;
|
|
82
|
-
/**
|
|
83
|
-
*
|
|
84
|
-
* @type {string}
|
|
85
|
-
* @memberof Twilio
|
|
86
|
-
*/
|
|
87
|
-
public_key_pem?: string;
|
|
88
|
-
/**
|
|
89
|
-
*
|
|
90
|
-
* @type {string}
|
|
91
|
-
* @memberof Twilio
|
|
92
|
-
*/
|
|
93
|
-
public_key_sid?: string;
|
|
94
70
|
/**
|
|
95
71
|
*
|
|
96
72
|
* @type {string}
|
|
@@ -112,15 +88,11 @@ export function TwilioFromJSONTyped(json: any, ignoreDiscriminator: boolean): Tw
|
|
|
112
88
|
'account_sid': !exists(json, 'account_sid') ? undefined : json['account_sid'],
|
|
113
89
|
'api_key_id': !exists(json, 'api_key_id') ? undefined : json['api_key_id'],
|
|
114
90
|
'api_key_name': !exists(json, 'api_key_name') ? undefined : json['api_key_name'],
|
|
115
|
-
'api_key_secret': !exists(json, 'api_key_secret') ? undefined : json['api_key_secret'],
|
|
116
91
|
'auth_token': !exists(json, 'auth_token') ? undefined : json['auth_token'],
|
|
117
92
|
'esp_twilio_uuid': !exists(json, 'esp_twilio_uuid') ? undefined : json['esp_twilio_uuid'],
|
|
118
93
|
'inbound_twiml_app_sid': !exists(json, 'inbound_twiml_app_sid') ? undefined : json['inbound_twiml_app_sid'],
|
|
119
94
|
'outbound_twiml_app_sid': !exists(json, 'outbound_twiml_app_sid') ? undefined : json['outbound_twiml_app_sid'],
|
|
120
95
|
'phone_numbers': !exists(json, 'phone_numbers') ? undefined : json['phone_numbers'],
|
|
121
|
-
'private_key_pem': !exists(json, 'private_key_pem') ? undefined : json['private_key_pem'],
|
|
122
|
-
'public_key_pem': !exists(json, 'public_key_pem') ? undefined : json['public_key_pem'],
|
|
123
|
-
'public_key_sid': !exists(json, 'public_key_sid') ? undefined : json['public_key_sid'],
|
|
124
96
|
'twilio_workspace_sid': !exists(json, 'twilio_workspace_sid') ? undefined : json['twilio_workspace_sid'],
|
|
125
97
|
};
|
|
126
98
|
}
|
|
@@ -137,15 +109,11 @@ export function TwilioToJSON(value?: Twilio | null): any {
|
|
|
137
109
|
'account_sid': value.account_sid,
|
|
138
110
|
'api_key_id': value.api_key_id,
|
|
139
111
|
'api_key_name': value.api_key_name,
|
|
140
|
-
'api_key_secret': value.api_key_secret,
|
|
141
112
|
'auth_token': value.auth_token,
|
|
142
113
|
'esp_twilio_uuid': value.esp_twilio_uuid,
|
|
143
114
|
'inbound_twiml_app_sid': value.inbound_twiml_app_sid,
|
|
144
115
|
'outbound_twiml_app_sid': value.outbound_twiml_app_sid,
|
|
145
116
|
'phone_numbers': value.phone_numbers,
|
|
146
|
-
'private_key_pem': value.private_key_pem,
|
|
147
|
-
'public_key_pem': value.public_key_pem,
|
|
148
|
-
'public_key_sid': value.public_key_sid,
|
|
149
117
|
'twilio_workspace_sid': value.twilio_workspace_sid,
|
|
150
118
|
};
|
|
151
119
|
}
|
|
@@ -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
|
}
|