ultracart_rest_api_v2_typescript 4.1.178 → 4.1.180
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 +8 -0
- package/README.md +4 -2
- package/dist/apis/AutoOrderApi.d.ts +28 -1
- package/dist/apis/AutoOrderApi.js +59 -0
- package/dist/apis/OrderApi.d.ts +88 -1
- package/dist/apis/OrderApi.js +188 -0
- package/dist/apis/SfvbApi.d.ts +61 -1
- package/dist/apis/SfvbApi.js +127 -0
- package/dist/models/OrderAssignRmaRequest.d.ts +31 -0
- package/dist/models/OrderAssignRmaRequest.js +50 -0
- package/dist/models/OrderAutoOrderUpdateBillingUrlResponse.d.ts +58 -0
- package/dist/models/OrderAutoOrderUpdateBillingUrlResponse.js +61 -0
- package/dist/models/SfvbBlogPostDetail.d.ts +20 -2
- package/dist/models/SfvbBlogPostDetail.js +6 -0
- package/dist/models/SfvbBlogPostRequest.d.ts +18 -0
- package/dist/models/SfvbBlogPostRequest.js +6 -0
- package/dist/models/SfvbRecording.d.ts +159 -0
- package/dist/models/SfvbRecording.js +94 -0
- package/dist/models/SfvbRecordingEvent.d.ts +50 -0
- package/dist/models/SfvbRecordingEvent.js +57 -0
- package/dist/models/SfvbRecordingEventsResponse.d.ts +49 -0
- package/dist/models/SfvbRecordingEventsResponse.js +56 -0
- package/dist/models/SfvbRecordingPageView.d.ts +105 -0
- package/dist/models/SfvbRecordingPageView.js +76 -0
- package/dist/models/SfvbRecordingParameter.d.ts +37 -0
- package/dist/models/SfvbRecordingParameter.js +52 -0
- package/dist/models/SfvbRecordingResponse.d.ts +32 -0
- package/dist/models/SfvbRecordingResponse.js +51 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/package.json +1 -1
- package/src/apis/AutoOrderApi.ts +64 -0
- package/src/apis/OrderApi.ts +210 -0
- package/src/apis/SfvbApi.ts +146 -0
- package/src/models/OrderAssignRmaRequest.ts +67 -0
- package/src/models/OrderAutoOrderUpdateBillingUrlResponse.ts +118 -0
- package/src/models/SfvbBlogPostDetail.ts +26 -2
- package/src/models/SfvbBlogPostRequest.ts +24 -0
- package/src/models/SfvbRecording.ts +248 -0
- package/src/models/SfvbRecordingEvent.ts +98 -0
- package/src/models/SfvbRecordingEventsResponse.ts +91 -0
- package/src/models/SfvbRecordingPageView.ts +176 -0
- package/src/models/SfvbRecordingParameter.ts +75 -0
- package/src/models/SfvbRecordingResponse.ts +74 -0
- package/src/models/index.ts +8 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -818,8 +818,10 @@ src/models/Order.ts
|
|
|
818
818
|
src/models/OrderAddItemsAndReleaseRequest.ts
|
|
819
819
|
src/models/OrderAffiliate.ts
|
|
820
820
|
src/models/OrderAffiliateLedger.ts
|
|
821
|
+
src/models/OrderAssignRmaRequest.ts
|
|
821
822
|
src/models/OrderAssignToAffiliateRequest.ts
|
|
822
823
|
src/models/OrderAutoOrder.ts
|
|
824
|
+
src/models/OrderAutoOrderUpdateBillingUrlResponse.ts
|
|
823
825
|
src/models/OrderBilling.ts
|
|
824
826
|
src/models/OrderBuysafe.ts
|
|
825
827
|
src/models/OrderByTokenQuery.ts
|
|
@@ -1075,6 +1077,12 @@ src/models/SfvbPreviewAccessResponse.ts
|
|
|
1075
1077
|
src/models/SfvbPreviewSessionRequest.ts
|
|
1076
1078
|
src/models/SfvbPreviewSessionResponse.ts
|
|
1077
1079
|
src/models/SfvbPreviewUrlResponse.ts
|
|
1080
|
+
src/models/SfvbRecording.ts
|
|
1081
|
+
src/models/SfvbRecordingEvent.ts
|
|
1082
|
+
src/models/SfvbRecordingEventsResponse.ts
|
|
1083
|
+
src/models/SfvbRecordingPageView.ts
|
|
1084
|
+
src/models/SfvbRecordingParameter.ts
|
|
1085
|
+
src/models/SfvbRecordingResponse.ts
|
|
1078
1086
|
src/models/SfvbRenderRequest.ts
|
|
1079
1087
|
src/models/SfvbRenderResponse.ts
|
|
1080
1088
|
src/models/SfvbServerLog.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.180
|
|
3
3
|
|
|
4
4
|
Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
|
|
5
5
|
|
|
6
6
|
Installation
|
|
7
7
|
|
|
8
8
|
```
|
|
9
|
-
npm install ultracart_rest_api_v2_typescript@4.1.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.180 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
|
|
|
84
84
|
|
|
85
85
|
| Version | Date | Comments |
|
|
86
86
|
| --: | :-: | --- |
|
|
87
|
+
| 4.1.180 | 10/02/2026 | sfvb internal builder |
|
|
88
|
+
| 4.1.179 | 10/01/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.178 | 09/30/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.177 | 09/30/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderCancelReasonsResponse, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPaymentUpdateRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderRebillResponse, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse } from '../models';
|
|
13
|
+
import { AutoOrder, AutoOrderAddonItemsUpdateRequest, AutoOrderCancelReasonsResponse, AutoOrderConsolidate, AutoOrderEmailsResponse, AutoOrderItemCancelRequest, AutoOrderPaymentUpdateRequest, AutoOrderPropertiesUpdateRequest, AutoOrderQuery, AutoOrderQueryBatch, AutoOrderRebillResponse, AutoOrderResponse, AutoOrdersRequest, AutoOrdersResponse, OrderAutoOrderUpdateBillingUrlResponse } from '../models';
|
|
14
14
|
export interface AttemptAutoOrderRebillRequest {
|
|
15
15
|
autoOrderOid: number;
|
|
16
16
|
expand?: string;
|
|
@@ -45,6 +45,9 @@ export interface GetAutoOrderByReferenceOrderIdRequest {
|
|
|
45
45
|
export interface GetAutoOrderEmailsRequest {
|
|
46
46
|
autoOrderOid: number;
|
|
47
47
|
}
|
|
48
|
+
export interface GetAutoOrderUpdateBillingUrlRequest {
|
|
49
|
+
autoOrderOid: number;
|
|
50
|
+
}
|
|
48
51
|
export interface GetAutoOrdersRequest {
|
|
49
52
|
autoOrderCode?: string;
|
|
50
53
|
originalOrderId?: string;
|
|
@@ -262,6 +265,20 @@ export interface AutoOrderApiInterface {
|
|
|
262
265
|
* Retrieve email delivery information for this auto order.
|
|
263
266
|
*/
|
|
264
267
|
getAutoOrderEmails(requestParameters: GetAutoOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderEmailsResponse>;
|
|
268
|
+
/**
|
|
269
|
+
* Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
|
|
270
|
+
* @summary Generate an auto order update billing url
|
|
271
|
+
* @param {number} autoOrderOid The auto order oid to generate the update billing url for.
|
|
272
|
+
* @param {*} [options] Override http request option.
|
|
273
|
+
* @throws {RequiredError}
|
|
274
|
+
* @memberof AutoOrderApiInterface
|
|
275
|
+
*/
|
|
276
|
+
getAutoOrderUpdateBillingUrlRaw(requestParameters: GetAutoOrderUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAutoOrderUpdateBillingUrlResponse>>;
|
|
277
|
+
/**
|
|
278
|
+
* Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
|
|
279
|
+
* Generate an auto order update billing url
|
|
280
|
+
*/
|
|
281
|
+
getAutoOrderUpdateBillingUrl(requestParameters: GetAutoOrderUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAutoOrderUpdateBillingUrlResponse>;
|
|
265
282
|
/**
|
|
266
283
|
* Retrieves auto orders from the account. If no parameters are specified, all auto orders will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
267
284
|
* @summary Retrieve auto orders
|
|
@@ -542,6 +559,16 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
|
|
|
542
559
|
* Retrieve email delivery information for this auto order.
|
|
543
560
|
*/
|
|
544
561
|
getAutoOrderEmails(requestParameters: GetAutoOrderEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderEmailsResponse>;
|
|
562
|
+
/**
|
|
563
|
+
* Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
|
|
564
|
+
* Generate an auto order update billing url
|
|
565
|
+
*/
|
|
566
|
+
getAutoOrderUpdateBillingUrlRaw(requestParameters: GetAutoOrderUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAutoOrderUpdateBillingUrlResponse>>;
|
|
567
|
+
/**
|
|
568
|
+
* Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
|
|
569
|
+
* Generate an auto order update billing url
|
|
570
|
+
*/
|
|
571
|
+
getAutoOrderUpdateBillingUrl(requestParameters: GetAutoOrderUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAutoOrderUpdateBillingUrlResponse>;
|
|
545
572
|
/**
|
|
546
573
|
* Retrieves auto orders from the account. If no parameters are specified, all auto orders will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
547
574
|
* Retrieve auto orders
|
|
@@ -634,6 +634,65 @@ var AutoOrderApi = /** @class */ (function (_super) {
|
|
|
634
634
|
});
|
|
635
635
|
});
|
|
636
636
|
};
|
|
637
|
+
/**
|
|
638
|
+
* Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
|
|
639
|
+
* Generate an auto order update billing url
|
|
640
|
+
*/
|
|
641
|
+
AutoOrderApi.prototype.getAutoOrderUpdateBillingUrlRaw = function (requestParameters, initOverrides) {
|
|
642
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
643
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
644
|
+
return __generator(this, function (_c) {
|
|
645
|
+
switch (_c.label) {
|
|
646
|
+
case 0:
|
|
647
|
+
if (requestParameters.autoOrderOid === null || requestParameters.autoOrderOid === undefined) {
|
|
648
|
+
throw new runtime.RequiredError('autoOrderOid', 'Required parameter requestParameters.autoOrderOid was null or undefined when calling getAutoOrderUpdateBillingUrl.');
|
|
649
|
+
}
|
|
650
|
+
queryParameters = {};
|
|
651
|
+
headerParameters = {};
|
|
652
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
653
|
+
// oauth required
|
|
654
|
+
_a = headerParameters;
|
|
655
|
+
_b = "Authorization";
|
|
656
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["auto_order_write"])];
|
|
657
|
+
case 1:
|
|
658
|
+
// oauth required
|
|
659
|
+
_a[_b] = _c.sent();
|
|
660
|
+
_c.label = 2;
|
|
661
|
+
case 2:
|
|
662
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
663
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
664
|
+
}
|
|
665
|
+
return [4 /*yield*/, this.request({
|
|
666
|
+
path: "/auto_order/auto_orders/{auto_order_oid}/update_billing_url".replace("{".concat("auto_order_oid", "}"), encodeURIComponent(String(requestParameters.autoOrderOid))),
|
|
667
|
+
method: 'GET',
|
|
668
|
+
headers: headerParameters,
|
|
669
|
+
query: queryParameters,
|
|
670
|
+
}, initOverrides)];
|
|
671
|
+
case 3:
|
|
672
|
+
response = _c.sent();
|
|
673
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderAutoOrderUpdateBillingUrlResponseFromJSON)(jsonValue); })];
|
|
674
|
+
}
|
|
675
|
+
});
|
|
676
|
+
});
|
|
677
|
+
};
|
|
678
|
+
/**
|
|
679
|
+
* Generates the url a customer can use to update the billing information on this auto order. This is the same url sent in the auto order update billing email.
|
|
680
|
+
* Generate an auto order update billing url
|
|
681
|
+
*/
|
|
682
|
+
AutoOrderApi.prototype.getAutoOrderUpdateBillingUrl = function (requestParameters, initOverrides) {
|
|
683
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
684
|
+
var response;
|
|
685
|
+
return __generator(this, function (_a) {
|
|
686
|
+
switch (_a.label) {
|
|
687
|
+
case 0: return [4 /*yield*/, this.getAutoOrderUpdateBillingUrlRaw(requestParameters, initOverrides)];
|
|
688
|
+
case 1:
|
|
689
|
+
response = _a.sent();
|
|
690
|
+
return [4 /*yield*/, response.value()];
|
|
691
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
692
|
+
}
|
|
693
|
+
});
|
|
694
|
+
});
|
|
695
|
+
};
|
|
637
696
|
/**
|
|
638
697
|
* Retrieves auto orders from the account. If no parameters are specified, all auto orders will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
639
698
|
* Retrieve auto orders
|
package/dist/apis/OrderApi.d.ts
CHANGED
|
@@ -10,11 +10,16 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderCustomerActivityResponse, OrderEdiDocumentsResponse, OrderEmailsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderPageViewHistoryResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
|
|
13
|
+
import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignRmaRequest, OrderAssignToAffiliateRequest, OrderAutoOrderUpdateBillingUrlResponse, OrderByTokenQuery, OrderCustomerActivityResponse, OrderEdiDocumentsResponse, OrderEmailsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderPageViewHistoryResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
|
|
14
14
|
export interface AdjustOrderTotalRequest {
|
|
15
15
|
orderId: string;
|
|
16
16
|
desiredTotal: string;
|
|
17
17
|
}
|
|
18
|
+
export interface AssignRmaRequest {
|
|
19
|
+
orderId: string;
|
|
20
|
+
assignRmaRequest: OrderAssignRmaRequest;
|
|
21
|
+
expand?: string;
|
|
22
|
+
}
|
|
18
23
|
export interface AssignToAffiliateRequest {
|
|
19
24
|
orderId: string;
|
|
20
25
|
assignToAffiliateRequest: OrderAssignToAffiliateRequest;
|
|
@@ -130,6 +135,13 @@ export interface GetOrdersByQueryRequest {
|
|
|
130
135
|
sort?: string;
|
|
131
136
|
expand?: string;
|
|
132
137
|
}
|
|
138
|
+
export interface GetOrdersByRmaRequest {
|
|
139
|
+
rma: string;
|
|
140
|
+
expand?: string;
|
|
141
|
+
}
|
|
142
|
+
export interface GetUpdateBillingUrlRequest {
|
|
143
|
+
orderId: string;
|
|
144
|
+
}
|
|
133
145
|
export interface HeldOrderAddItemsAndReleaseRequest {
|
|
134
146
|
orderId: string;
|
|
135
147
|
addItemsAndReleaseRequest: OrderAddItemsAndReleaseRequest;
|
|
@@ -213,6 +225,22 @@ export interface OrderApiInterface {
|
|
|
213
225
|
* Adjusts an order total
|
|
214
226
|
*/
|
|
215
227
|
adjustOrderTotal(requestParameters: AdjustOrderTotalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
|
|
228
|
+
/**
|
|
229
|
+
* Associates an RMA number with an order. Any existing RMA on the order is replaced.
|
|
230
|
+
* @summary Associates an RMA with an order
|
|
231
|
+
* @param {string} orderId The order id to associate the RMA with.
|
|
232
|
+
* @param {OrderAssignRmaRequest} assignRmaRequest Assign RMA request
|
|
233
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
234
|
+
* @param {*} [options] Override http request option.
|
|
235
|
+
* @throws {RequiredError}
|
|
236
|
+
* @memberof OrderApiInterface
|
|
237
|
+
*/
|
|
238
|
+
assignRmaRaw(requestParameters: AssignRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
|
|
239
|
+
/**
|
|
240
|
+
* Associates an RMA number with an order. Any existing RMA on the order is replaced.
|
|
241
|
+
* Associates an RMA with an order
|
|
242
|
+
*/
|
|
243
|
+
assignRma(requestParameters: AssignRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
|
|
216
244
|
/**
|
|
217
245
|
* Assigns an order to an affiliate.
|
|
218
246
|
* @summary Assigns an order to an affiliate
|
|
@@ -596,6 +624,35 @@ export interface OrderApiInterface {
|
|
|
596
624
|
* Retrieve orders by query
|
|
597
625
|
*/
|
|
598
626
|
getOrdersByQuery(requestParameters: GetOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
|
|
627
|
+
/**
|
|
628
|
+
* Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
|
|
629
|
+
* @summary Retrieve orders by RMA
|
|
630
|
+
* @param {string} rma The RMA number to search for.
|
|
631
|
+
* @param {string} [expand] The object expansion to perform on the result. See documentation for examples
|
|
632
|
+
* @param {*} [options] Override http request option.
|
|
633
|
+
* @throws {RequiredError}
|
|
634
|
+
* @memberof OrderApiInterface
|
|
635
|
+
*/
|
|
636
|
+
getOrdersByRmaRaw(requestParameters: GetOrdersByRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrdersResponse>>;
|
|
637
|
+
/**
|
|
638
|
+
* Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
|
|
639
|
+
* Retrieve orders by RMA
|
|
640
|
+
*/
|
|
641
|
+
getOrdersByRma(requestParameters: GetOrdersByRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
|
|
642
|
+
/**
|
|
643
|
+
* Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
|
|
644
|
+
* @summary Generate an auto order update billing url
|
|
645
|
+
* @param {string} orderId The order id to generate the update billing url for.
|
|
646
|
+
* @param {*} [options] Override http request option.
|
|
647
|
+
* @throws {RequiredError}
|
|
648
|
+
* @memberof OrderApiInterface
|
|
649
|
+
*/
|
|
650
|
+
getUpdateBillingUrlRaw(requestParameters: GetUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAutoOrderUpdateBillingUrlResponse>>;
|
|
651
|
+
/**
|
|
652
|
+
* Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
|
|
653
|
+
* Generate an auto order update billing url
|
|
654
|
+
*/
|
|
655
|
+
getUpdateBillingUrl(requestParameters: GetUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAutoOrderUpdateBillingUrlResponse>;
|
|
599
656
|
/**
|
|
600
657
|
* This method adds items to an order in the hold stage and releases it
|
|
601
658
|
* @summary Add items and release a held order
|
|
@@ -826,6 +883,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
|
|
|
826
883
|
* Adjusts an order total
|
|
827
884
|
*/
|
|
828
885
|
adjustOrderTotal(requestParameters: AdjustOrderTotalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
|
|
886
|
+
/**
|
|
887
|
+
* Associates an RMA number with an order. Any existing RMA on the order is replaced.
|
|
888
|
+
* Associates an RMA with an order
|
|
889
|
+
*/
|
|
890
|
+
assignRmaRaw(requestParameters: AssignRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
|
|
891
|
+
/**
|
|
892
|
+
* Associates an RMA number with an order. Any existing RMA on the order is replaced.
|
|
893
|
+
* Associates an RMA with an order
|
|
894
|
+
*/
|
|
895
|
+
assignRma(requestParameters: AssignRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
|
|
829
896
|
/**
|
|
830
897
|
* Assigns an order to an affiliate.
|
|
831
898
|
* Assigns an order to an affiliate
|
|
@@ -1066,6 +1133,26 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
|
|
|
1066
1133
|
* Retrieve orders by query
|
|
1067
1134
|
*/
|
|
1068
1135
|
getOrdersByQuery(requestParameters: GetOrdersByQueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
|
|
1138
|
+
* Retrieve orders by RMA
|
|
1139
|
+
*/
|
|
1140
|
+
getOrdersByRmaRaw(requestParameters: GetOrdersByRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrdersResponse>>;
|
|
1141
|
+
/**
|
|
1142
|
+
* Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
|
|
1143
|
+
* Retrieve orders by RMA
|
|
1144
|
+
*/
|
|
1145
|
+
getOrdersByRma(requestParameters: GetOrdersByRmaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrdersResponse>;
|
|
1146
|
+
/**
|
|
1147
|
+
* Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
|
|
1148
|
+
* Generate an auto order update billing url
|
|
1149
|
+
*/
|
|
1150
|
+
getUpdateBillingUrlRaw(requestParameters: GetUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAutoOrderUpdateBillingUrlResponse>>;
|
|
1151
|
+
/**
|
|
1152
|
+
* Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
|
|
1153
|
+
* Generate an auto order update billing url
|
|
1154
|
+
*/
|
|
1155
|
+
getUpdateBillingUrl(requestParameters: GetUpdateBillingUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAutoOrderUpdateBillingUrlResponse>;
|
|
1069
1156
|
/**
|
|
1070
1157
|
* This method adds items to an order in the hold stage and releases it
|
|
1071
1158
|
* Add items and release a held order
|
package/dist/apis/OrderApi.js
CHANGED
|
@@ -137,6 +137,73 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
137
137
|
});
|
|
138
138
|
});
|
|
139
139
|
};
|
|
140
|
+
/**
|
|
141
|
+
* Associates an RMA number with an order. Any existing RMA on the order is replaced.
|
|
142
|
+
* Associates an RMA with an order
|
|
143
|
+
*/
|
|
144
|
+
OrderApi.prototype.assignRmaRaw = function (requestParameters, initOverrides) {
|
|
145
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
146
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
147
|
+
return __generator(this, function (_c) {
|
|
148
|
+
switch (_c.label) {
|
|
149
|
+
case 0:
|
|
150
|
+
if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
|
|
151
|
+
throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling assignRma.');
|
|
152
|
+
}
|
|
153
|
+
if (requestParameters.assignRmaRequest === null || requestParameters.assignRmaRequest === undefined) {
|
|
154
|
+
throw new runtime.RequiredError('assignRmaRequest', 'Required parameter requestParameters.assignRmaRequest was null or undefined when calling assignRma.');
|
|
155
|
+
}
|
|
156
|
+
queryParameters = {};
|
|
157
|
+
if (requestParameters.expand !== undefined) {
|
|
158
|
+
queryParameters['_expand'] = requestParameters.expand;
|
|
159
|
+
}
|
|
160
|
+
headerParameters = {};
|
|
161
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
162
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
163
|
+
// oauth required
|
|
164
|
+
_a = headerParameters;
|
|
165
|
+
_b = "Authorization";
|
|
166
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_write"])];
|
|
167
|
+
case 1:
|
|
168
|
+
// oauth required
|
|
169
|
+
_a[_b] = _c.sent();
|
|
170
|
+
_c.label = 2;
|
|
171
|
+
case 2:
|
|
172
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
173
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
174
|
+
}
|
|
175
|
+
return [4 /*yield*/, this.request({
|
|
176
|
+
path: "/order/orders/{order_id}/rma".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
|
|
177
|
+
method: 'POST',
|
|
178
|
+
headers: headerParameters,
|
|
179
|
+
query: queryParameters,
|
|
180
|
+
body: (0, models_1.OrderAssignRmaRequestToJSON)(requestParameters.assignRmaRequest),
|
|
181
|
+
}, initOverrides)];
|
|
182
|
+
case 3:
|
|
183
|
+
response = _c.sent();
|
|
184
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderResponseFromJSON)(jsonValue); })];
|
|
185
|
+
}
|
|
186
|
+
});
|
|
187
|
+
});
|
|
188
|
+
};
|
|
189
|
+
/**
|
|
190
|
+
* Associates an RMA number with an order. Any existing RMA on the order is replaced.
|
|
191
|
+
* Associates an RMA with an order
|
|
192
|
+
*/
|
|
193
|
+
OrderApi.prototype.assignRma = function (requestParameters, initOverrides) {
|
|
194
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
195
|
+
var response;
|
|
196
|
+
return __generator(this, function (_a) {
|
|
197
|
+
switch (_a.label) {
|
|
198
|
+
case 0: return [4 /*yield*/, this.assignRmaRaw(requestParameters, initOverrides)];
|
|
199
|
+
case 1:
|
|
200
|
+
response = _a.sent();
|
|
201
|
+
return [4 /*yield*/, response.value()];
|
|
202
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
203
|
+
}
|
|
204
|
+
});
|
|
205
|
+
});
|
|
206
|
+
};
|
|
140
207
|
/**
|
|
141
208
|
* Assigns an order to an affiliate.
|
|
142
209
|
* Assigns an order to an affiliate
|
|
@@ -1703,6 +1770,127 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
1703
1770
|
});
|
|
1704
1771
|
});
|
|
1705
1772
|
};
|
|
1773
|
+
/**
|
|
1774
|
+
* Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
|
|
1775
|
+
* Retrieve orders by RMA
|
|
1776
|
+
*/
|
|
1777
|
+
OrderApi.prototype.getOrdersByRmaRaw = function (requestParameters, initOverrides) {
|
|
1778
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1779
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
1780
|
+
return __generator(this, function (_c) {
|
|
1781
|
+
switch (_c.label) {
|
|
1782
|
+
case 0:
|
|
1783
|
+
if (requestParameters.rma === null || requestParameters.rma === undefined) {
|
|
1784
|
+
throw new runtime.RequiredError('rma', 'Required parameter requestParameters.rma was null or undefined when calling getOrdersByRma.');
|
|
1785
|
+
}
|
|
1786
|
+
queryParameters = {};
|
|
1787
|
+
if (requestParameters.expand !== undefined) {
|
|
1788
|
+
queryParameters['_expand'] = requestParameters.expand;
|
|
1789
|
+
}
|
|
1790
|
+
headerParameters = {};
|
|
1791
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1792
|
+
// oauth required
|
|
1793
|
+
_a = headerParameters;
|
|
1794
|
+
_b = "Authorization";
|
|
1795
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_read"])];
|
|
1796
|
+
case 1:
|
|
1797
|
+
// oauth required
|
|
1798
|
+
_a[_b] = _c.sent();
|
|
1799
|
+
_c.label = 2;
|
|
1800
|
+
case 2:
|
|
1801
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1802
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1803
|
+
}
|
|
1804
|
+
return [4 /*yield*/, this.request({
|
|
1805
|
+
path: "/order/orders/rma/{rma}".replace("{".concat("rma", "}"), encodeURIComponent(String(requestParameters.rma))),
|
|
1806
|
+
method: 'GET',
|
|
1807
|
+
headers: headerParameters,
|
|
1808
|
+
query: queryParameters,
|
|
1809
|
+
}, initOverrides)];
|
|
1810
|
+
case 3:
|
|
1811
|
+
response = _c.sent();
|
|
1812
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrdersResponseFromJSON)(jsonValue); })];
|
|
1813
|
+
}
|
|
1814
|
+
});
|
|
1815
|
+
});
|
|
1816
|
+
};
|
|
1817
|
+
/**
|
|
1818
|
+
* Retrieves the orders associated with the specified RMA number. The RMA must be an exact value; wildcards are not permitted.
|
|
1819
|
+
* Retrieve orders by RMA
|
|
1820
|
+
*/
|
|
1821
|
+
OrderApi.prototype.getOrdersByRma = function (requestParameters, initOverrides) {
|
|
1822
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1823
|
+
var response;
|
|
1824
|
+
return __generator(this, function (_a) {
|
|
1825
|
+
switch (_a.label) {
|
|
1826
|
+
case 0: return [4 /*yield*/, this.getOrdersByRmaRaw(requestParameters, initOverrides)];
|
|
1827
|
+
case 1:
|
|
1828
|
+
response = _a.sent();
|
|
1829
|
+
return [4 /*yield*/, response.value()];
|
|
1830
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
1831
|
+
}
|
|
1832
|
+
});
|
|
1833
|
+
});
|
|
1834
|
+
};
|
|
1835
|
+
/**
|
|
1836
|
+
* Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
|
|
1837
|
+
* Generate an auto order update billing url
|
|
1838
|
+
*/
|
|
1839
|
+
OrderApi.prototype.getUpdateBillingUrlRaw = function (requestParameters, initOverrides) {
|
|
1840
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1841
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
1842
|
+
return __generator(this, function (_c) {
|
|
1843
|
+
switch (_c.label) {
|
|
1844
|
+
case 0:
|
|
1845
|
+
if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
|
|
1846
|
+
throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling getUpdateBillingUrl.');
|
|
1847
|
+
}
|
|
1848
|
+
queryParameters = {};
|
|
1849
|
+
headerParameters = {};
|
|
1850
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1851
|
+
// oauth required
|
|
1852
|
+
_a = headerParameters;
|
|
1853
|
+
_b = "Authorization";
|
|
1854
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_write"])];
|
|
1855
|
+
case 1:
|
|
1856
|
+
// oauth required
|
|
1857
|
+
_a[_b] = _c.sent();
|
|
1858
|
+
_c.label = 2;
|
|
1859
|
+
case 2:
|
|
1860
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1861
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
1862
|
+
}
|
|
1863
|
+
return [4 /*yield*/, this.request({
|
|
1864
|
+
path: "/order/orders/{order_id}/auto_order_update_billing_url".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
|
|
1865
|
+
method: 'GET',
|
|
1866
|
+
headers: headerParameters,
|
|
1867
|
+
query: queryParameters,
|
|
1868
|
+
}, initOverrides)];
|
|
1869
|
+
case 3:
|
|
1870
|
+
response = _c.sent();
|
|
1871
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderAutoOrderUpdateBillingUrlResponseFromJSON)(jsonValue); })];
|
|
1872
|
+
}
|
|
1873
|
+
});
|
|
1874
|
+
});
|
|
1875
|
+
};
|
|
1876
|
+
/**
|
|
1877
|
+
* Generates the url a customer can use to update the billing information on the auto order associated with this order. This is the same url sent in the auto order update billing email.
|
|
1878
|
+
* Generate an auto order update billing url
|
|
1879
|
+
*/
|
|
1880
|
+
OrderApi.prototype.getUpdateBillingUrl = function (requestParameters, initOverrides) {
|
|
1881
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1882
|
+
var response;
|
|
1883
|
+
return __generator(this, function (_a) {
|
|
1884
|
+
switch (_a.label) {
|
|
1885
|
+
case 0: return [4 /*yield*/, this.getUpdateBillingUrlRaw(requestParameters, initOverrides)];
|
|
1886
|
+
case 1:
|
|
1887
|
+
response = _a.sent();
|
|
1888
|
+
return [4 /*yield*/, response.value()];
|
|
1889
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
1890
|
+
}
|
|
1891
|
+
});
|
|
1892
|
+
});
|
|
1893
|
+
};
|
|
1706
1894
|
/**
|
|
1707
1895
|
* This method adds items to an order in the hold stage and releases it
|
|
1708
1896
|
* Add items and release a held order
|
package/dist/apis/SfvbApi.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 { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -189,6 +189,15 @@ export interface GetSfvbPreviewUrlRequest {
|
|
|
189
189
|
previewSessionId: string;
|
|
190
190
|
path?: string;
|
|
191
191
|
}
|
|
192
|
+
export interface GetSfvbRecordingRequest {
|
|
193
|
+
storefrontOid: number;
|
|
194
|
+
screenRecordingUuid: string;
|
|
195
|
+
}
|
|
196
|
+
export interface GetSfvbRecordingPageViewEventsRequest {
|
|
197
|
+
storefrontOid: number;
|
|
198
|
+
screenRecordingUuid: string;
|
|
199
|
+
screenRecordingPageViewUuid: string;
|
|
200
|
+
}
|
|
192
201
|
export interface GetSfvbServerLogRequest {
|
|
193
202
|
storefrontOid: number;
|
|
194
203
|
logId: string;
|
|
@@ -1123,6 +1132,37 @@ export interface SfvbApiInterface {
|
|
|
1123
1132
|
* URL that renders a preview session
|
|
1124
1133
|
*/
|
|
1125
1134
|
getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
|
|
1135
|
+
/**
|
|
1136
|
+
* One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
1137
|
+
* @summary Get a screen recording
|
|
1138
|
+
* @param {number} storefrontOid
|
|
1139
|
+
* @param {string} screenRecordingUuid
|
|
1140
|
+
* @param {*} [options] Override http request option.
|
|
1141
|
+
* @throws {RequiredError}
|
|
1142
|
+
* @memberof SfvbApiInterface
|
|
1143
|
+
*/
|
|
1144
|
+
getSfvbRecordingRaw(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingResponse>>;
|
|
1145
|
+
/**
|
|
1146
|
+
* One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
1147
|
+
* Get a screen recording
|
|
1148
|
+
*/
|
|
1149
|
+
getSfvbRecording(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingResponse>;
|
|
1150
|
+
/**
|
|
1151
|
+
* The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
1152
|
+
* @summary Get one recorded page view\'s replay events
|
|
1153
|
+
* @param {number} storefrontOid
|
|
1154
|
+
* @param {string} screenRecordingUuid
|
|
1155
|
+
* @param {string} screenRecordingPageViewUuid
|
|
1156
|
+
* @param {*} [options] Override http request option.
|
|
1157
|
+
* @throws {RequiredError}
|
|
1158
|
+
* @memberof SfvbApiInterface
|
|
1159
|
+
*/
|
|
1160
|
+
getSfvbRecordingPageViewEventsRaw(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingEventsResponse>>;
|
|
1161
|
+
/**
|
|
1162
|
+
* The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
1163
|
+
* Get one recorded page view\'s replay events
|
|
1164
|
+
*/
|
|
1165
|
+
getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
|
|
1126
1166
|
/**
|
|
1127
1167
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
1128
1168
|
* @summary Get one storefront render log
|
|
@@ -2524,6 +2564,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2524
2564
|
* URL that renders a preview session
|
|
2525
2565
|
*/
|
|
2526
2566
|
getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
|
|
2567
|
+
/**
|
|
2568
|
+
* One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
2569
|
+
* Get a screen recording
|
|
2570
|
+
*/
|
|
2571
|
+
getSfvbRecordingRaw(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingResponse>>;
|
|
2572
|
+
/**
|
|
2573
|
+
* One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
2574
|
+
* Get a screen recording
|
|
2575
|
+
*/
|
|
2576
|
+
getSfvbRecording(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingResponse>;
|
|
2577
|
+
/**
|
|
2578
|
+
* The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
2579
|
+
* Get one recorded page view\'s replay events
|
|
2580
|
+
*/
|
|
2581
|
+
getSfvbRecordingPageViewEventsRaw(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingEventsResponse>>;
|
|
2582
|
+
/**
|
|
2583
|
+
* The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
2584
|
+
* Get one recorded page view\'s replay events
|
|
2585
|
+
*/
|
|
2586
|
+
getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
|
|
2527
2587
|
/**
|
|
2528
2588
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
2529
2589
|
* Get one storefront render log
|