ultracart_rest_api_v2_typescript 3.10.125 → 3.10.126
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 +3 -2
- package/api.ts +101 -0
- package/dist/api.d.ts +97 -0
- package/dist/api.js +35 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.10.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.10.126
|
|
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@3.10.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.10.126 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.126 | 03/22/2023 | data warehouse internal dev |
|
|
57
58
|
| 3.10.125 | 03/22/2023 | dw initial framework |
|
|
58
59
|
| 3.10.124 | 03/22/2023 | order api - refundable response added manual_because_multiple_charges boolean field |
|
|
59
60
|
| 3.10.123 | 03/21/2023 | order api - new stage named Hold |
|
package/api.ts
CHANGED
|
@@ -33875,6 +33875,72 @@ export namespace ReportDataSetSchema {
|
|
|
33875
33875
|
}
|
|
33876
33876
|
}
|
|
33877
33877
|
|
|
33878
|
+
/**
|
|
33879
|
+
*
|
|
33880
|
+
* @export
|
|
33881
|
+
* @interface ReportDataSetSummary
|
|
33882
|
+
*/
|
|
33883
|
+
export interface ReportDataSetSummary {
|
|
33884
|
+
/**
|
|
33885
|
+
* A unique identifier assigned to the data set that is returned.
|
|
33886
|
+
* @type {string}
|
|
33887
|
+
* @memberof ReportDataSetSummary
|
|
33888
|
+
*/
|
|
33889
|
+
data_set_uuid?: string;
|
|
33890
|
+
/**
|
|
33891
|
+
* Error message if the query failed.
|
|
33892
|
+
* @type {string}
|
|
33893
|
+
* @memberof ReportDataSetSummary
|
|
33894
|
+
*/
|
|
33895
|
+
error_message?: string;
|
|
33896
|
+
/**
|
|
33897
|
+
* An identifier that can be used to help match up the returned data set
|
|
33898
|
+
* @type {string}
|
|
33899
|
+
* @memberof ReportDataSetSummary
|
|
33900
|
+
*/
|
|
33901
|
+
for_object_id?: string;
|
|
33902
|
+
/**
|
|
33903
|
+
* The type of object this data set is for
|
|
33904
|
+
* @type {string}
|
|
33905
|
+
* @memberof ReportDataSetSummary
|
|
33906
|
+
*/
|
|
33907
|
+
for_object_type?: ReportDataSetSummary.ForObjectTypeEnum;
|
|
33908
|
+
/**
|
|
33909
|
+
* The total number of results
|
|
33910
|
+
* @type {number}
|
|
33911
|
+
* @memberof ReportDataSetSummary
|
|
33912
|
+
*/
|
|
33913
|
+
max_results?: number;
|
|
33914
|
+
/**
|
|
33915
|
+
* The schema associated with the data set.
|
|
33916
|
+
* @type {Array<ReportDataSetSchema>}
|
|
33917
|
+
* @memberof ReportDataSetSummary
|
|
33918
|
+
*/
|
|
33919
|
+
schema?: Array<ReportDataSetSchema>;
|
|
33920
|
+
/**
|
|
33921
|
+
* Any other data that needs to be returned with the response to help the UI
|
|
33922
|
+
* @type {string}
|
|
33923
|
+
* @memberof ReportDataSetSummary
|
|
33924
|
+
*/
|
|
33925
|
+
user_data?: string;
|
|
33926
|
+
}
|
|
33927
|
+
|
|
33928
|
+
/**
|
|
33929
|
+
* @export
|
|
33930
|
+
* @namespace ReportDataSetSummary
|
|
33931
|
+
*/
|
|
33932
|
+
export namespace ReportDataSetSummary {
|
|
33933
|
+
/**
|
|
33934
|
+
* @export
|
|
33935
|
+
* @enum {string}
|
|
33936
|
+
*/
|
|
33937
|
+
export enum ForObjectTypeEnum {
|
|
33938
|
+
Schema = <any> 'schema',
|
|
33939
|
+
Filter = <any> 'filter',
|
|
33940
|
+
Visualization = <any> 'visualization'
|
|
33941
|
+
}
|
|
33942
|
+
}
|
|
33943
|
+
|
|
33878
33944
|
/**
|
|
33879
33945
|
*
|
|
33880
33946
|
* @export
|
|
@@ -34367,6 +34433,41 @@ export interface ReportResponse {
|
|
|
34367
34433
|
warning?: Warning;
|
|
34368
34434
|
}
|
|
34369
34435
|
|
|
34436
|
+
/**
|
|
34437
|
+
*
|
|
34438
|
+
* @export
|
|
34439
|
+
* @interface ReportWebsocketEvent
|
|
34440
|
+
*/
|
|
34441
|
+
export interface ReportWebsocketEvent {
|
|
34442
|
+
/**
|
|
34443
|
+
* Event type
|
|
34444
|
+
* @type {string}
|
|
34445
|
+
* @memberof ReportWebsocketEvent
|
|
34446
|
+
*/
|
|
34447
|
+
event_type?: ReportWebsocketEvent.EventTypeEnum;
|
|
34448
|
+
/**
|
|
34449
|
+
*
|
|
34450
|
+
* @type {ReportDataSetSummary}
|
|
34451
|
+
* @memberof ReportWebsocketEvent
|
|
34452
|
+
*/
|
|
34453
|
+
query_completion?: ReportDataSetSummary;
|
|
34454
|
+
}
|
|
34455
|
+
|
|
34456
|
+
/**
|
|
34457
|
+
* @export
|
|
34458
|
+
* @namespace ReportWebsocketEvent
|
|
34459
|
+
*/
|
|
34460
|
+
export namespace ReportWebsocketEvent {
|
|
34461
|
+
/**
|
|
34462
|
+
* @export
|
|
34463
|
+
* @enum {string}
|
|
34464
|
+
*/
|
|
34465
|
+
export enum EventTypeEnum {
|
|
34466
|
+
Ping = <any> 'ping',
|
|
34467
|
+
QueryCompletion = <any> 'query completion'
|
|
34468
|
+
}
|
|
34469
|
+
}
|
|
34470
|
+
|
|
34370
34471
|
/**
|
|
34371
34472
|
*
|
|
34372
34473
|
* @export
|
package/dist/api.d.ts
CHANGED
|
@@ -33165,6 +33165,70 @@ export declare namespace ReportDataSetSchema {
|
|
|
33165
33165
|
TIMESTAMP
|
|
33166
33166
|
}
|
|
33167
33167
|
}
|
|
33168
|
+
/**
|
|
33169
|
+
*
|
|
33170
|
+
* @export
|
|
33171
|
+
* @interface ReportDataSetSummary
|
|
33172
|
+
*/
|
|
33173
|
+
export interface ReportDataSetSummary {
|
|
33174
|
+
/**
|
|
33175
|
+
* A unique identifier assigned to the data set that is returned.
|
|
33176
|
+
* @type {string}
|
|
33177
|
+
* @memberof ReportDataSetSummary
|
|
33178
|
+
*/
|
|
33179
|
+
data_set_uuid?: string;
|
|
33180
|
+
/**
|
|
33181
|
+
* Error message if the query failed.
|
|
33182
|
+
* @type {string}
|
|
33183
|
+
* @memberof ReportDataSetSummary
|
|
33184
|
+
*/
|
|
33185
|
+
error_message?: string;
|
|
33186
|
+
/**
|
|
33187
|
+
* An identifier that can be used to help match up the returned data set
|
|
33188
|
+
* @type {string}
|
|
33189
|
+
* @memberof ReportDataSetSummary
|
|
33190
|
+
*/
|
|
33191
|
+
for_object_id?: string;
|
|
33192
|
+
/**
|
|
33193
|
+
* The type of object this data set is for
|
|
33194
|
+
* @type {string}
|
|
33195
|
+
* @memberof ReportDataSetSummary
|
|
33196
|
+
*/
|
|
33197
|
+
for_object_type?: ReportDataSetSummary.ForObjectTypeEnum;
|
|
33198
|
+
/**
|
|
33199
|
+
* The total number of results
|
|
33200
|
+
* @type {number}
|
|
33201
|
+
* @memberof ReportDataSetSummary
|
|
33202
|
+
*/
|
|
33203
|
+
max_results?: number;
|
|
33204
|
+
/**
|
|
33205
|
+
* The schema associated with the data set.
|
|
33206
|
+
* @type {Array<ReportDataSetSchema>}
|
|
33207
|
+
* @memberof ReportDataSetSummary
|
|
33208
|
+
*/
|
|
33209
|
+
schema?: Array<ReportDataSetSchema>;
|
|
33210
|
+
/**
|
|
33211
|
+
* Any other data that needs to be returned with the response to help the UI
|
|
33212
|
+
* @type {string}
|
|
33213
|
+
* @memberof ReportDataSetSummary
|
|
33214
|
+
*/
|
|
33215
|
+
user_data?: string;
|
|
33216
|
+
}
|
|
33217
|
+
/**
|
|
33218
|
+
* @export
|
|
33219
|
+
* @namespace ReportDataSetSummary
|
|
33220
|
+
*/
|
|
33221
|
+
export declare namespace ReportDataSetSummary {
|
|
33222
|
+
/**
|
|
33223
|
+
* @export
|
|
33224
|
+
* @enum {string}
|
|
33225
|
+
*/
|
|
33226
|
+
enum ForObjectTypeEnum {
|
|
33227
|
+
Schema,
|
|
33228
|
+
Filter,
|
|
33229
|
+
Visualization
|
|
33230
|
+
}
|
|
33231
|
+
}
|
|
33168
33232
|
/**
|
|
33169
33233
|
*
|
|
33170
33234
|
* @export
|
|
@@ -33642,6 +33706,39 @@ export interface ReportResponse {
|
|
|
33642
33706
|
*/
|
|
33643
33707
|
warning?: Warning;
|
|
33644
33708
|
}
|
|
33709
|
+
/**
|
|
33710
|
+
*
|
|
33711
|
+
* @export
|
|
33712
|
+
* @interface ReportWebsocketEvent
|
|
33713
|
+
*/
|
|
33714
|
+
export interface ReportWebsocketEvent {
|
|
33715
|
+
/**
|
|
33716
|
+
* Event type
|
|
33717
|
+
* @type {string}
|
|
33718
|
+
* @memberof ReportWebsocketEvent
|
|
33719
|
+
*/
|
|
33720
|
+
event_type?: ReportWebsocketEvent.EventTypeEnum;
|
|
33721
|
+
/**
|
|
33722
|
+
*
|
|
33723
|
+
* @type {ReportDataSetSummary}
|
|
33724
|
+
* @memberof ReportWebsocketEvent
|
|
33725
|
+
*/
|
|
33726
|
+
query_completion?: ReportDataSetSummary;
|
|
33727
|
+
}
|
|
33728
|
+
/**
|
|
33729
|
+
* @export
|
|
33730
|
+
* @namespace ReportWebsocketEvent
|
|
33731
|
+
*/
|
|
33732
|
+
export declare namespace ReportWebsocketEvent {
|
|
33733
|
+
/**
|
|
33734
|
+
* @export
|
|
33735
|
+
* @enum {string}
|
|
33736
|
+
*/
|
|
33737
|
+
enum EventTypeEnum {
|
|
33738
|
+
Ping,
|
|
33739
|
+
QueryCompletion
|
|
33740
|
+
}
|
|
33741
|
+
}
|
|
33645
33742
|
/**
|
|
33646
33743
|
*
|
|
33647
33744
|
* @export
|
package/dist/api.js
CHANGED
|
@@ -29,8 +29,8 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
29
29
|
})();
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
31
|
exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
|
|
32
|
-
exports.
|
|
33
|
-
exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = void 0;
|
|
32
|
+
exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSummary = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = void 0;
|
|
33
|
+
exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = void 0;
|
|
34
34
|
var url = require("url");
|
|
35
35
|
var portableFetch = require("portable-fetch");
|
|
36
36
|
var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
|
|
@@ -1332,6 +1332,23 @@ var ReportDataSetSchema;
|
|
|
1332
1332
|
TypeEnum[TypeEnum["TIMESTAMP"] = 'TIMESTAMP'] = "TIMESTAMP";
|
|
1333
1333
|
})(TypeEnum = ReportDataSetSchema.TypeEnum || (ReportDataSetSchema.TypeEnum = {}));
|
|
1334
1334
|
})(ReportDataSetSchema = exports.ReportDataSetSchema || (exports.ReportDataSetSchema = {}));
|
|
1335
|
+
/**
|
|
1336
|
+
* @export
|
|
1337
|
+
* @namespace ReportDataSetSummary
|
|
1338
|
+
*/
|
|
1339
|
+
var ReportDataSetSummary;
|
|
1340
|
+
(function (ReportDataSetSummary) {
|
|
1341
|
+
/**
|
|
1342
|
+
* @export
|
|
1343
|
+
* @enum {string}
|
|
1344
|
+
*/
|
|
1345
|
+
var ForObjectTypeEnum;
|
|
1346
|
+
(function (ForObjectTypeEnum) {
|
|
1347
|
+
ForObjectTypeEnum[ForObjectTypeEnum["Schema"] = 'schema'] = "Schema";
|
|
1348
|
+
ForObjectTypeEnum[ForObjectTypeEnum["Filter"] = 'filter'] = "Filter";
|
|
1349
|
+
ForObjectTypeEnum[ForObjectTypeEnum["Visualization"] = 'visualization'] = "Visualization";
|
|
1350
|
+
})(ForObjectTypeEnum = ReportDataSetSummary.ForObjectTypeEnum || (ReportDataSetSummary.ForObjectTypeEnum = {}));
|
|
1351
|
+
})(ReportDataSetSummary = exports.ReportDataSetSummary || (exports.ReportDataSetSummary = {}));
|
|
1335
1352
|
/**
|
|
1336
1353
|
* @export
|
|
1337
1354
|
* @namespace ReportDataSourceSchema
|
|
@@ -1431,6 +1448,22 @@ var ReportPageVisualizationMetric;
|
|
|
1431
1448
|
AggregationEnum[AggregationEnum["Avg"] = 'avg'] = "Avg";
|
|
1432
1449
|
})(AggregationEnum = ReportPageVisualizationMetric.AggregationEnum || (ReportPageVisualizationMetric.AggregationEnum = {}));
|
|
1433
1450
|
})(ReportPageVisualizationMetric = exports.ReportPageVisualizationMetric || (exports.ReportPageVisualizationMetric = {}));
|
|
1451
|
+
/**
|
|
1452
|
+
* @export
|
|
1453
|
+
* @namespace ReportWebsocketEvent
|
|
1454
|
+
*/
|
|
1455
|
+
var ReportWebsocketEvent;
|
|
1456
|
+
(function (ReportWebsocketEvent) {
|
|
1457
|
+
/**
|
|
1458
|
+
* @export
|
|
1459
|
+
* @enum {string}
|
|
1460
|
+
*/
|
|
1461
|
+
var EventTypeEnum;
|
|
1462
|
+
(function (EventTypeEnum) {
|
|
1463
|
+
EventTypeEnum[EventTypeEnum["Ping"] = 'ping'] = "Ping";
|
|
1464
|
+
EventTypeEnum[EventTypeEnum["QueryCompletion"] = 'query completion'] = "QueryCompletion";
|
|
1465
|
+
})(EventTypeEnum = ReportWebsocketEvent.EventTypeEnum || (ReportWebsocketEvent.EventTypeEnum = {}));
|
|
1466
|
+
})(ReportWebsocketEvent = exports.ReportWebsocketEvent || (exports.ReportWebsocketEvent = {}));
|
|
1434
1467
|
/**
|
|
1435
1468
|
* @export
|
|
1436
1469
|
* @namespace TempMultimedia
|