ultracart_rest_api_v2_typescript 4.0.80-RC → 4.0.82-RC
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/.openapi-generator/FILES +1 -0
- package/README.md +4 -2
- package/dist/apis/OrderApi.d.ts +28 -1
- package/dist/apis/OrderApi.js +59 -0
- package/dist/models/AffiliateClick.d.ts +12 -0
- package/dist/models/AffiliateClick.js +4 -0
- package/dist/models/Conversation.d.ts +6 -0
- package/dist/models/Conversation.js +2 -0
- package/dist/models/OrderRefundableResponse.d.ts +54 -0
- package/dist/models/OrderRefundableResponse.js +53 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/OrderApi.ts +64 -0
- package/src/models/AffiliateClick.ts +16 -0
- package/src/models/Conversation.ts +8 -0
- package/src/models/OrderRefundableResponse.ts +107 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -565,6 +565,7 @@ src/models/OrderProperty.ts
|
|
|
565
565
|
src/models/OrderQuery.ts
|
|
566
566
|
src/models/OrderQueryBatch.ts
|
|
567
567
|
src/models/OrderQuote.ts
|
|
568
|
+
src/models/OrderRefundableResponse.ts
|
|
568
569
|
src/models/OrderReplacement.ts
|
|
569
570
|
src/models/OrderReplacementItem.ts
|
|
570
571
|
src/models/OrderReplacementResponse.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.0.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@4.0.82-RC
|
|
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.82-RC --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.82-RC | 11/15/2022 | order api new method is order refundable |
|
|
58
|
+
| 4.0.81-RC | 11/15/2022 | increase order property length to 10k char |
|
|
57
59
|
| 4.0.80-RC | 11/14/2022 | conversations - add allowed values for update agent status |
|
|
58
60
|
| 4.0.79-RC | 11/09/2022 | conversations - add an enum of event typing |
|
|
59
61
|
| 4.0.78-RC | 11/04/2022 | new coupon type percent based on msrp |
|
package/dist/apis/OrderApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderFormat, OrderFormatResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrdersResponse } from '../models';
|
|
13
|
+
import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderByTokenQuery, OrderFormat, OrderFormatResponse, OrderPackingSlipResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrdersResponse } from '../models';
|
|
14
14
|
export interface AdjustOrderTotalRequest {
|
|
15
15
|
orderId: string;
|
|
16
16
|
desiredTotal: string;
|
|
@@ -99,6 +99,9 @@ export interface InsertOrderRequest {
|
|
|
99
99
|
order: Order;
|
|
100
100
|
expand?: string;
|
|
101
101
|
}
|
|
102
|
+
export interface IsRefundableOrderRequest {
|
|
103
|
+
orderId: string;
|
|
104
|
+
}
|
|
102
105
|
export interface ProcessPaymentRequest {
|
|
103
106
|
orderId: string;
|
|
104
107
|
processPaymentRequest: OrderProcessPaymentRequest;
|
|
@@ -405,6 +408,20 @@ export interface OrderApiInterface {
|
|
|
405
408
|
* Insert an order
|
|
406
409
|
*/
|
|
407
410
|
insertOrder(requestParameters: InsertOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
|
|
411
|
+
/**
|
|
412
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
413
|
+
* @summary Determine if an order can be refunded
|
|
414
|
+
* @param {string} orderId The order id to check for refundable order.
|
|
415
|
+
* @param {*} [options] Override http request option.
|
|
416
|
+
* @throws {RequiredError}
|
|
417
|
+
* @memberof OrderApiInterface
|
|
418
|
+
*/
|
|
419
|
+
isRefundableOrderRaw(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefundableResponse>>;
|
|
420
|
+
/**
|
|
421
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
422
|
+
* Determine if an order can be refunded
|
|
423
|
+
*/
|
|
424
|
+
isRefundableOrder(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefundableResponse>;
|
|
408
425
|
/**
|
|
409
426
|
* Process payment on order
|
|
410
427
|
* @summary Process payment
|
|
@@ -680,6 +697,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
|
|
|
680
697
|
* Insert an order
|
|
681
698
|
*/
|
|
682
699
|
insertOrder(requestParameters: InsertOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
|
|
700
|
+
/**
|
|
701
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
702
|
+
* Determine if an order can be refunded
|
|
703
|
+
*/
|
|
704
|
+
isRefundableOrderRaw(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefundableResponse>>;
|
|
705
|
+
/**
|
|
706
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
707
|
+
* Determine if an order can be refunded
|
|
708
|
+
*/
|
|
709
|
+
isRefundableOrder(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefundableResponse>;
|
|
683
710
|
/**
|
|
684
711
|
* Process payment on order
|
|
685
712
|
* Process payment
|
package/dist/apis/OrderApi.js
CHANGED
|
@@ -1155,6 +1155,65 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
1155
1155
|
});
|
|
1156
1156
|
});
|
|
1157
1157
|
};
|
|
1158
|
+
/**
|
|
1159
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
1160
|
+
* Determine if an order can be refunded
|
|
1161
|
+
*/
|
|
1162
|
+
OrderApi.prototype.isRefundableOrderRaw = function (requestParameters, initOverrides) {
|
|
1163
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1164
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
1165
|
+
return __generator(this, function (_c) {
|
|
1166
|
+
switch (_c.label) {
|
|
1167
|
+
case 0:
|
|
1168
|
+
if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
|
|
1169
|
+
throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling isRefundableOrder.');
|
|
1170
|
+
}
|
|
1171
|
+
queryParameters = {};
|
|
1172
|
+
headerParameters = {};
|
|
1173
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1174
|
+
// oauth required
|
|
1175
|
+
_a = headerParameters;
|
|
1176
|
+
_b = "Authorization";
|
|
1177
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_write"])];
|
|
1178
|
+
case 1:
|
|
1179
|
+
// oauth required
|
|
1180
|
+
_a[_b] = _c.sent();
|
|
1181
|
+
_c.label = 2;
|
|
1182
|
+
case 2:
|
|
1183
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1184
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1185
|
+
}
|
|
1186
|
+
return [4 /*yield*/, this.request({
|
|
1187
|
+
path: "/order/orders/{order_id}/refundable".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
|
|
1188
|
+
method: 'GET',
|
|
1189
|
+
headers: headerParameters,
|
|
1190
|
+
query: queryParameters,
|
|
1191
|
+
}, initOverrides)];
|
|
1192
|
+
case 3:
|
|
1193
|
+
response = _c.sent();
|
|
1194
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderRefundableResponseFromJSON)(jsonValue); })];
|
|
1195
|
+
}
|
|
1196
|
+
});
|
|
1197
|
+
});
|
|
1198
|
+
};
|
|
1199
|
+
/**
|
|
1200
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
1201
|
+
* Determine if an order can be refunded
|
|
1202
|
+
*/
|
|
1203
|
+
OrderApi.prototype.isRefundableOrder = function (requestParameters, initOverrides) {
|
|
1204
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1205
|
+
var response;
|
|
1206
|
+
return __generator(this, function (_a) {
|
|
1207
|
+
switch (_a.label) {
|
|
1208
|
+
case 0: return [4 /*yield*/, this.isRefundableOrderRaw(requestParameters, initOverrides)];
|
|
1209
|
+
case 1:
|
|
1210
|
+
response = _a.sent();
|
|
1211
|
+
return [4 /*yield*/, response.value()];
|
|
1212
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
1213
|
+
}
|
|
1214
|
+
});
|
|
1215
|
+
});
|
|
1216
|
+
};
|
|
1158
1217
|
/**
|
|
1159
1218
|
* Process payment on order
|
|
1160
1219
|
* Process payment
|
|
@@ -76,12 +76,24 @@ export interface AffiliateClick {
|
|
|
76
76
|
* @memberof AffiliateClick
|
|
77
77
|
*/
|
|
78
78
|
referrer_query_string?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Screen recording UUID
|
|
81
|
+
* @type {string}
|
|
82
|
+
* @memberof AffiliateClick
|
|
83
|
+
*/
|
|
84
|
+
screen_recording_uuid?: string;
|
|
79
85
|
/**
|
|
80
86
|
* Sub ID value passed on the click
|
|
81
87
|
* @type {string}
|
|
82
88
|
* @memberof AffiliateClick
|
|
83
89
|
*/
|
|
84
90
|
sub_id?: string;
|
|
91
|
+
/**
|
|
92
|
+
* UC Analytics Identifier
|
|
93
|
+
* @type {string}
|
|
94
|
+
* @memberof AffiliateClick
|
|
95
|
+
*/
|
|
96
|
+
ucacid?: string;
|
|
85
97
|
}
|
|
86
98
|
export declare function AffiliateClickFromJSON(json: any): AffiliateClick;
|
|
87
99
|
export declare function AffiliateClickFromJSONTyped(json: any, ignoreDiscriminator: boolean): AffiliateClick;
|
|
@@ -35,7 +35,9 @@ function AffiliateClickFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
35
35
|
'link': !(0, runtime_1.exists)(json, 'link') ? undefined : (0, AffiliateLink_1.AffiliateLinkFromJSON)(json['link']),
|
|
36
36
|
'referrer': !(0, runtime_1.exists)(json, 'referrer') ? undefined : json['referrer'],
|
|
37
37
|
'referrer_query_string': !(0, runtime_1.exists)(json, 'referrer_query_string') ? undefined : json['referrer_query_string'],
|
|
38
|
+
'screen_recording_uuid': !(0, runtime_1.exists)(json, 'screen_recording_uuid') ? undefined : json['screen_recording_uuid'],
|
|
38
39
|
'sub_id': !(0, runtime_1.exists)(json, 'sub_id') ? undefined : json['sub_id'],
|
|
40
|
+
'ucacid': !(0, runtime_1.exists)(json, 'ucacid') ? undefined : json['ucacid'],
|
|
39
41
|
};
|
|
40
42
|
}
|
|
41
43
|
exports.AffiliateClickFromJSONTyped = AffiliateClickFromJSONTyped;
|
|
@@ -57,7 +59,9 @@ function AffiliateClickToJSON(value) {
|
|
|
57
59
|
'link': (0, AffiliateLink_1.AffiliateLinkToJSON)(value.link),
|
|
58
60
|
'referrer': value.referrer,
|
|
59
61
|
'referrer_query_string': value.referrer_query_string,
|
|
62
|
+
'screen_recording_uuid': value.screen_recording_uuid,
|
|
60
63
|
'sub_id': value.sub_id,
|
|
64
|
+
'ucacid': value.ucacid,
|
|
61
65
|
};
|
|
62
66
|
}
|
|
63
67
|
exports.AffiliateClickToJSON = AffiliateClickToJSON;
|
|
@@ -17,6 +17,12 @@ import { ConversationParticipant } from './ConversationParticipant';
|
|
|
17
17
|
* @interface Conversation
|
|
18
18
|
*/
|
|
19
19
|
export interface Conversation {
|
|
20
|
+
/**
|
|
21
|
+
* The base language iso code for the StoreFront that everything is translated into
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof Conversation
|
|
24
|
+
*/
|
|
25
|
+
base_language_iso_code?: string;
|
|
20
26
|
/**
|
|
21
27
|
*
|
|
22
28
|
* @type {boolean}
|
|
@@ -33,6 +33,7 @@ function ConversationFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
33
33
|
return json;
|
|
34
34
|
}
|
|
35
35
|
return {
|
|
36
|
+
'base_language_iso_code': !(0, runtime_1.exists)(json, 'base_language_iso_code') ? undefined : json['base_language_iso_code'],
|
|
36
37
|
'closed': !(0, runtime_1.exists)(json, 'closed') ? undefined : json['closed'],
|
|
37
38
|
'conversation_arn': !(0, runtime_1.exists)(json, 'conversation_arn') ? undefined : json['conversation_arn'],
|
|
38
39
|
'conversation_uuid': !(0, runtime_1.exists)(json, 'conversation_uuid') ? undefined : json['conversation_uuid'],
|
|
@@ -60,6 +61,7 @@ function ConversationToJSON(value) {
|
|
|
60
61
|
return null;
|
|
61
62
|
}
|
|
62
63
|
return {
|
|
64
|
+
'base_language_iso_code': value.base_language_iso_code,
|
|
63
65
|
'closed': value.closed,
|
|
64
66
|
'conversation_arn': value.conversation_arn,
|
|
65
67
|
'conversation_uuid': value.conversation_uuid,
|
|
@@ -0,0 +1,54 @@
|
|
|
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
|
+
import { ModelError } from './ModelError';
|
|
13
|
+
import { ResponseMetadata } from './ResponseMetadata';
|
|
14
|
+
import { Warning } from './Warning';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface OrderRefundableResponse
|
|
19
|
+
*/
|
|
20
|
+
export interface OrderRefundableResponse {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {ModelError}
|
|
24
|
+
* @memberof OrderRefundableResponse
|
|
25
|
+
*/
|
|
26
|
+
error?: ModelError;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {ResponseMetadata}
|
|
30
|
+
* @memberof OrderRefundableResponse
|
|
31
|
+
*/
|
|
32
|
+
metadata?: ResponseMetadata;
|
|
33
|
+
/**
|
|
34
|
+
* Whether the order is refundable or not.
|
|
35
|
+
* @type {boolean}
|
|
36
|
+
* @memberof OrderRefundableResponse
|
|
37
|
+
*/
|
|
38
|
+
refundable?: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Indicates if API call was successful
|
|
41
|
+
* @type {boolean}
|
|
42
|
+
* @memberof OrderRefundableResponse
|
|
43
|
+
*/
|
|
44
|
+
success?: boolean;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {Warning}
|
|
48
|
+
* @memberof OrderRefundableResponse
|
|
49
|
+
*/
|
|
50
|
+
warning?: Warning;
|
|
51
|
+
}
|
|
52
|
+
export declare function OrderRefundableResponseFromJSON(json: any): OrderRefundableResponse;
|
|
53
|
+
export declare function OrderRefundableResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderRefundableResponse;
|
|
54
|
+
export declare function OrderRefundableResponseToJSON(value?: OrderRefundableResponse | null): any;
|
|
@@ -0,0 +1,53 @@
|
|
|
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.OrderRefundableResponseToJSON = exports.OrderRefundableResponseFromJSONTyped = exports.OrderRefundableResponseFromJSON = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var ModelError_1 = require("./ModelError");
|
|
19
|
+
var ResponseMetadata_1 = require("./ResponseMetadata");
|
|
20
|
+
var Warning_1 = require("./Warning");
|
|
21
|
+
function OrderRefundableResponseFromJSON(json) {
|
|
22
|
+
return OrderRefundableResponseFromJSONTyped(json, false);
|
|
23
|
+
}
|
|
24
|
+
exports.OrderRefundableResponseFromJSON = OrderRefundableResponseFromJSON;
|
|
25
|
+
function OrderRefundableResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
26
|
+
if ((json === undefined) || (json === null)) {
|
|
27
|
+
return json;
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
31
|
+
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
32
|
+
'refundable': !(0, runtime_1.exists)(json, 'refundable') ? undefined : json['refundable'],
|
|
33
|
+
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
34
|
+
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
exports.OrderRefundableResponseFromJSONTyped = OrderRefundableResponseFromJSONTyped;
|
|
38
|
+
function OrderRefundableResponseToJSON(value) {
|
|
39
|
+
if (value === undefined) {
|
|
40
|
+
return undefined;
|
|
41
|
+
}
|
|
42
|
+
if (value === null) {
|
|
43
|
+
return null;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
47
|
+
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
48
|
+
'refundable': value.refundable,
|
|
49
|
+
'success': value.success,
|
|
50
|
+
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
exports.OrderRefundableResponseToJSON = OrderRefundableResponseToJSON;
|
package/dist/models/index.d.ts
CHANGED
|
@@ -540,6 +540,7 @@ export * from './OrderProperty';
|
|
|
540
540
|
export * from './OrderQuery';
|
|
541
541
|
export * from './OrderQueryBatch';
|
|
542
542
|
export * from './OrderQuote';
|
|
543
|
+
export * from './OrderRefundableResponse';
|
|
543
544
|
export * from './OrderReplacement';
|
|
544
545
|
export * from './OrderReplacementItem';
|
|
545
546
|
export * from './OrderReplacementResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -558,6 +558,7 @@ __exportStar(require("./OrderProperty"), exports);
|
|
|
558
558
|
__exportStar(require("./OrderQuery"), exports);
|
|
559
559
|
__exportStar(require("./OrderQueryBatch"), exports);
|
|
560
560
|
__exportStar(require("./OrderQuote"), exports);
|
|
561
|
+
__exportStar(require("./OrderRefundableResponse"), exports);
|
|
561
562
|
__exportStar(require("./OrderReplacement"), exports);
|
|
562
563
|
__exportStar(require("./OrderReplacementItem"), exports);
|
|
563
564
|
__exportStar(require("./OrderReplacementResponse"), exports);
|
package/package.json
CHANGED
package/src/apis/OrderApi.ts
CHANGED
|
@@ -57,6 +57,9 @@ import {
|
|
|
57
57
|
OrderQueryBatch,
|
|
58
58
|
OrderQueryBatchFromJSON,
|
|
59
59
|
OrderQueryBatchToJSON,
|
|
60
|
+
OrderRefundableResponse,
|
|
61
|
+
OrderRefundableResponseFromJSON,
|
|
62
|
+
OrderRefundableResponseToJSON,
|
|
60
63
|
OrderReplacement,
|
|
61
64
|
OrderReplacementFromJSON,
|
|
62
65
|
OrderReplacementToJSON,
|
|
@@ -177,6 +180,10 @@ export interface InsertOrderRequest {
|
|
|
177
180
|
expand?: string;
|
|
178
181
|
}
|
|
179
182
|
|
|
183
|
+
export interface IsRefundableOrderRequest {
|
|
184
|
+
orderId: string;
|
|
185
|
+
}
|
|
186
|
+
|
|
180
187
|
export interface ProcessPaymentRequest {
|
|
181
188
|
orderId: string;
|
|
182
189
|
processPaymentRequest: OrderProcessPaymentRequest;
|
|
@@ -522,6 +529,22 @@ export interface OrderApiInterface {
|
|
|
522
529
|
*/
|
|
523
530
|
insertOrder(requestParameters: InsertOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
|
|
524
531
|
|
|
532
|
+
/**
|
|
533
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
534
|
+
* @summary Determine if an order can be refunded
|
|
535
|
+
* @param {string} orderId The order id to check for refundable order.
|
|
536
|
+
* @param {*} [options] Override http request option.
|
|
537
|
+
* @throws {RequiredError}
|
|
538
|
+
* @memberof OrderApiInterface
|
|
539
|
+
*/
|
|
540
|
+
isRefundableOrderRaw(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefundableResponse>>;
|
|
541
|
+
|
|
542
|
+
/**
|
|
543
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
544
|
+
* Determine if an order can be refunded
|
|
545
|
+
*/
|
|
546
|
+
isRefundableOrder(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefundableResponse>;
|
|
547
|
+
|
|
525
548
|
/**
|
|
526
549
|
* Process payment on order
|
|
527
550
|
* @summary Process payment
|
|
@@ -1491,6 +1514,47 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
|
|
|
1491
1514
|
return await response.value();
|
|
1492
1515
|
}
|
|
1493
1516
|
|
|
1517
|
+
/**
|
|
1518
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
1519
|
+
* Determine if an order can be refunded
|
|
1520
|
+
*/
|
|
1521
|
+
async isRefundableOrderRaw(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefundableResponse>> {
|
|
1522
|
+
if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
|
|
1523
|
+
throw new runtime.RequiredError('orderId','Required parameter requestParameters.orderId was null or undefined when calling isRefundableOrder.');
|
|
1524
|
+
}
|
|
1525
|
+
|
|
1526
|
+
const queryParameters: any = {};
|
|
1527
|
+
|
|
1528
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1529
|
+
|
|
1530
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
1531
|
+
// oauth required
|
|
1532
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["order_write"]);
|
|
1533
|
+
}
|
|
1534
|
+
|
|
1535
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1536
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1537
|
+
}
|
|
1538
|
+
|
|
1539
|
+
const response = await this.request({
|
|
1540
|
+
path: `/order/orders/{order_id}/refundable`.replace(`{${"order_id"}}`, encodeURIComponent(String(requestParameters.orderId))),
|
|
1541
|
+
method: 'GET',
|
|
1542
|
+
headers: headerParameters,
|
|
1543
|
+
query: queryParameters,
|
|
1544
|
+
}, initOverrides);
|
|
1545
|
+
|
|
1546
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => OrderRefundableResponseFromJSON(jsonValue));
|
|
1547
|
+
}
|
|
1548
|
+
|
|
1549
|
+
/**
|
|
1550
|
+
* Determine if an order can be refunded based upon payment method and age
|
|
1551
|
+
* Determine if an order can be refunded
|
|
1552
|
+
*/
|
|
1553
|
+
async isRefundableOrder(requestParameters: IsRefundableOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefundableResponse> {
|
|
1554
|
+
const response = await this.isRefundableOrderRaw(requestParameters, initOverrides);
|
|
1555
|
+
return await response.value();
|
|
1556
|
+
}
|
|
1557
|
+
|
|
1494
1558
|
/**
|
|
1495
1559
|
* Process payment on order
|
|
1496
1560
|
* Process payment
|
|
@@ -86,12 +86,24 @@ export interface AffiliateClick {
|
|
|
86
86
|
* @memberof AffiliateClick
|
|
87
87
|
*/
|
|
88
88
|
referrer_query_string?: string;
|
|
89
|
+
/**
|
|
90
|
+
* Screen recording UUID
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof AffiliateClick
|
|
93
|
+
*/
|
|
94
|
+
screen_recording_uuid?: string;
|
|
89
95
|
/**
|
|
90
96
|
* Sub ID value passed on the click
|
|
91
97
|
* @type {string}
|
|
92
98
|
* @memberof AffiliateClick
|
|
93
99
|
*/
|
|
94
100
|
sub_id?: string;
|
|
101
|
+
/**
|
|
102
|
+
* UC Analytics Identifier
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof AffiliateClick
|
|
105
|
+
*/
|
|
106
|
+
ucacid?: string;
|
|
95
107
|
}
|
|
96
108
|
|
|
97
109
|
export function AffiliateClickFromJSON(json: any): AffiliateClick {
|
|
@@ -114,7 +126,9 @@ export function AffiliateClickFromJSONTyped(json: any, ignoreDiscriminator: bool
|
|
|
114
126
|
'link': !exists(json, 'link') ? undefined : AffiliateLinkFromJSON(json['link']),
|
|
115
127
|
'referrer': !exists(json, 'referrer') ? undefined : json['referrer'],
|
|
116
128
|
'referrer_query_string': !exists(json, 'referrer_query_string') ? undefined : json['referrer_query_string'],
|
|
129
|
+
'screen_recording_uuid': !exists(json, 'screen_recording_uuid') ? undefined : json['screen_recording_uuid'],
|
|
117
130
|
'sub_id': !exists(json, 'sub_id') ? undefined : json['sub_id'],
|
|
131
|
+
'ucacid': !exists(json, 'ucacid') ? undefined : json['ucacid'],
|
|
118
132
|
};
|
|
119
133
|
}
|
|
120
134
|
|
|
@@ -137,7 +151,9 @@ export function AffiliateClickToJSON(value?: AffiliateClick | null): any {
|
|
|
137
151
|
'link': AffiliateLinkToJSON(value.link),
|
|
138
152
|
'referrer': value.referrer,
|
|
139
153
|
'referrer_query_string': value.referrer_query_string,
|
|
154
|
+
'screen_recording_uuid': value.screen_recording_uuid,
|
|
140
155
|
'sub_id': value.sub_id,
|
|
156
|
+
'ucacid': value.ucacid,
|
|
141
157
|
};
|
|
142
158
|
}
|
|
143
159
|
|
|
@@ -32,6 +32,12 @@ import {
|
|
|
32
32
|
* @interface Conversation
|
|
33
33
|
*/
|
|
34
34
|
export interface Conversation {
|
|
35
|
+
/**
|
|
36
|
+
* The base language iso code for the StoreFront that everything is translated into
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof Conversation
|
|
39
|
+
*/
|
|
40
|
+
base_language_iso_code?: string;
|
|
35
41
|
/**
|
|
36
42
|
*
|
|
37
43
|
* @type {boolean}
|
|
@@ -151,6 +157,7 @@ export function ConversationFromJSONTyped(json: any, ignoreDiscriminator: boolea
|
|
|
151
157
|
}
|
|
152
158
|
return {
|
|
153
159
|
|
|
160
|
+
'base_language_iso_code': !exists(json, 'base_language_iso_code') ? undefined : json['base_language_iso_code'],
|
|
154
161
|
'closed': !exists(json, 'closed') ? undefined : json['closed'],
|
|
155
162
|
'conversation_arn': !exists(json, 'conversation_arn') ? undefined : json['conversation_arn'],
|
|
156
163
|
'conversation_uuid': !exists(json, 'conversation_uuid') ? undefined : json['conversation_uuid'],
|
|
@@ -179,6 +186,7 @@ export function ConversationToJSON(value?: Conversation | null): any {
|
|
|
179
186
|
}
|
|
180
187
|
return {
|
|
181
188
|
|
|
189
|
+
'base_language_iso_code': value.base_language_iso_code,
|
|
182
190
|
'closed': value.closed,
|
|
183
191
|
'conversation_arn': value.conversation_arn,
|
|
184
192
|
'conversation_uuid': value.conversation_uuid,
|
|
@@ -0,0 +1,107 @@
|
|
|
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
|
+
import {
|
|
17
|
+
ModelError,
|
|
18
|
+
ModelErrorFromJSON,
|
|
19
|
+
ModelErrorFromJSONTyped,
|
|
20
|
+
ModelErrorToJSON,
|
|
21
|
+
} from './ModelError';
|
|
22
|
+
import {
|
|
23
|
+
ResponseMetadata,
|
|
24
|
+
ResponseMetadataFromJSON,
|
|
25
|
+
ResponseMetadataFromJSONTyped,
|
|
26
|
+
ResponseMetadataToJSON,
|
|
27
|
+
} from './ResponseMetadata';
|
|
28
|
+
import {
|
|
29
|
+
Warning,
|
|
30
|
+
WarningFromJSON,
|
|
31
|
+
WarningFromJSONTyped,
|
|
32
|
+
WarningToJSON,
|
|
33
|
+
} from './Warning';
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @export
|
|
38
|
+
* @interface OrderRefundableResponse
|
|
39
|
+
*/
|
|
40
|
+
export interface OrderRefundableResponse {
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @type {ModelError}
|
|
44
|
+
* @memberof OrderRefundableResponse
|
|
45
|
+
*/
|
|
46
|
+
error?: ModelError;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {ResponseMetadata}
|
|
50
|
+
* @memberof OrderRefundableResponse
|
|
51
|
+
*/
|
|
52
|
+
metadata?: ResponseMetadata;
|
|
53
|
+
/**
|
|
54
|
+
* Whether the order is refundable or not.
|
|
55
|
+
* @type {boolean}
|
|
56
|
+
* @memberof OrderRefundableResponse
|
|
57
|
+
*/
|
|
58
|
+
refundable?: boolean;
|
|
59
|
+
/**
|
|
60
|
+
* Indicates if API call was successful
|
|
61
|
+
* @type {boolean}
|
|
62
|
+
* @memberof OrderRefundableResponse
|
|
63
|
+
*/
|
|
64
|
+
success?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {Warning}
|
|
68
|
+
* @memberof OrderRefundableResponse
|
|
69
|
+
*/
|
|
70
|
+
warning?: Warning;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function OrderRefundableResponseFromJSON(json: any): OrderRefundableResponse {
|
|
74
|
+
return OrderRefundableResponseFromJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function OrderRefundableResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderRefundableResponse {
|
|
78
|
+
if ((json === undefined) || (json === null)) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
|
|
83
|
+
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
84
|
+
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
85
|
+
'refundable': !exists(json, 'refundable') ? undefined : json['refundable'],
|
|
86
|
+
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
87
|
+
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function OrderRefundableResponseToJSON(value?: OrderRefundableResponse | null): any {
|
|
92
|
+
if (value === undefined) {
|
|
93
|
+
return undefined;
|
|
94
|
+
}
|
|
95
|
+
if (value === null) {
|
|
96
|
+
return null;
|
|
97
|
+
}
|
|
98
|
+
return {
|
|
99
|
+
|
|
100
|
+
'error': ModelErrorToJSON(value.error),
|
|
101
|
+
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
102
|
+
'refundable': value.refundable,
|
|
103
|
+
'success': value.success,
|
|
104
|
+
'warning': WarningToJSON(value.warning),
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -542,6 +542,7 @@ export * from './OrderProperty';
|
|
|
542
542
|
export * from './OrderQuery';
|
|
543
543
|
export * from './OrderQueryBatch';
|
|
544
544
|
export * from './OrderQuote';
|
|
545
|
+
export * from './OrderRefundableResponse';
|
|
545
546
|
export * from './OrderReplacement';
|
|
546
547
|
export * from './OrderReplacementItem';
|
|
547
548
|
export * from './OrderReplacementResponse';
|