ultracart_rest_api_v2_typescript 3.10.143 → 3.10.145
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/api.ts +51 -9
- package/dist/api.d.ts +39 -6
- package/dist/api.js +44 -10
- 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.145
|
|
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.145 --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
|
+
| 3.10.145 | 06/20/2023 | coupon add allowed values for usable_by and new OncePerNewCustomerForItem flag |
|
|
58
|
+
| 3.10.144 | 06/15/2023 | add pickup_dts to order.shipping object |
|
|
57
59
|
| 3.10.143 | 06/14/2023 | dw bi: add request_dts on the execute queries request and report data set objects |
|
|
58
60
|
| 3.10.142 | 06/09/2023 | distribution center pickup times |
|
|
59
61
|
| 3.10.141 | 06/08/2023 | customer profile qb tax exempt reason code field |
|
package/api.ts
CHANGED
|
@@ -9870,7 +9870,25 @@ export interface Coupon {
|
|
|
9870
9870
|
* @type {string}
|
|
9871
9871
|
* @memberof Coupon
|
|
9872
9872
|
*/
|
|
9873
|
-
usable_by?:
|
|
9873
|
+
usable_by?: Coupon.UsableByEnum;
|
|
9874
|
+
}
|
|
9875
|
+
|
|
9876
|
+
/**
|
|
9877
|
+
* @export
|
|
9878
|
+
* @namespace Coupon
|
|
9879
|
+
*/
|
|
9880
|
+
export namespace Coupon {
|
|
9881
|
+
/**
|
|
9882
|
+
* @export
|
|
9883
|
+
* @enum {string}
|
|
9884
|
+
*/
|
|
9885
|
+
export enum UsableByEnum {
|
|
9886
|
+
Anyone = <any> 'Anyone',
|
|
9887
|
+
UniqueCode = <any> 'UniqueCode',
|
|
9888
|
+
OncePerCustomer = <any> 'OncePerCustomer',
|
|
9889
|
+
OncePerNewCustomer = <any> 'OncePerNewCustomer',
|
|
9890
|
+
OncePerNewCustomerForItem = <any> 'OncePerNewCustomerForItem'
|
|
9891
|
+
}
|
|
9874
9892
|
}
|
|
9875
9893
|
|
|
9876
9894
|
/**
|
|
@@ -32338,6 +32356,12 @@ export interface OrderShipping {
|
|
|
32338
32356
|
* @memberof OrderShipping
|
|
32339
32357
|
*/
|
|
32340
32358
|
lift_gate?: boolean;
|
|
32359
|
+
/**
|
|
32360
|
+
* Date/time the order should be picked up locally.
|
|
32361
|
+
* @type {string}
|
|
32362
|
+
* @memberof OrderShipping
|
|
32363
|
+
*/
|
|
32364
|
+
pickup_dts?: string;
|
|
32341
32365
|
/**
|
|
32342
32366
|
* Postal code
|
|
32343
32367
|
* @type {string}
|
|
@@ -61337,10 +61361,12 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
61337
61361
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
61338
61362
|
* @summary Cancel an order
|
|
61339
61363
|
* @param {string} order_id The order id to cancel.
|
|
61364
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
61365
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
61340
61366
|
* @param {*} [options] Override http request option.
|
|
61341
61367
|
* @throws {RequiredError}
|
|
61342
61368
|
*/
|
|
61343
|
-
cancelOrder(order_id: string, options: any = {}): FetchArgs {
|
|
61369
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options: any = {}): FetchArgs {
|
|
61344
61370
|
// verify required parameter 'order_id' is not null or undefined
|
|
61345
61371
|
if (order_id === null || order_id === undefined) {
|
|
61346
61372
|
throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling cancelOrder.');
|
|
@@ -61375,6 +61401,14 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
61375
61401
|
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
61376
61402
|
}
|
|
61377
61403
|
|
|
61404
|
+
if (lock_self_ship_orders !== undefined) {
|
|
61405
|
+
localVarQueryParameter['lock_self_ship_orders'] = lock_self_ship_orders;
|
|
61406
|
+
}
|
|
61407
|
+
|
|
61408
|
+
if (skip_refund_and_hold !== undefined) {
|
|
61409
|
+
localVarQueryParameter['skip_refund_and_hold'] = skip_refund_and_hold;
|
|
61410
|
+
}
|
|
61411
|
+
|
|
61378
61412
|
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
61379
61413
|
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
61380
61414
|
delete localVarUrlObj.search;
|
|
@@ -62966,11 +63000,13 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
62966
63000
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
62967
63001
|
* @summary Cancel an order
|
|
62968
63002
|
* @param {string} order_id The order id to cancel.
|
|
63003
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
63004
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
62969
63005
|
* @param {*} [options] Override http request option.
|
|
62970
63006
|
* @throws {RequiredError}
|
|
62971
63007
|
*/
|
|
62972
|
-
cancelOrder(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse> {
|
|
62973
|
-
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).cancelOrder(order_id, options);
|
|
63008
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse> {
|
|
63009
|
+
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options);
|
|
62974
63010
|
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
62975
63011
|
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
62976
63012
|
|
|
@@ -63564,11 +63600,13 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
63564
63600
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
63565
63601
|
* @summary Cancel an order
|
|
63566
63602
|
* @param {string} order_id The order id to cancel.
|
|
63603
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
63604
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
63567
63605
|
* @param {*} [options] Override http request option.
|
|
63568
63606
|
* @throws {RequiredError}
|
|
63569
63607
|
*/
|
|
63570
|
-
cancelOrder(order_id: string, options?: any) {
|
|
63571
|
-
return OrderApiFp(configuration).cancelOrder(order_id, options)(fetch, basePath);
|
|
63608
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any) {
|
|
63609
|
+
return OrderApiFp(configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options)(fetch, basePath);
|
|
63572
63610
|
},
|
|
63573
63611
|
/**
|
|
63574
63612
|
* Delete an order on the UltraCart account.
|
|
@@ -63887,11 +63925,13 @@ export interface OrderApiInterface {
|
|
|
63887
63925
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
63888
63926
|
* @summary Cancel an order
|
|
63889
63927
|
* @param {string} order_id The order id to cancel.
|
|
63928
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
63929
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
63890
63930
|
* @param {*} [options] Override http request option.
|
|
63891
63931
|
* @throws {RequiredError}
|
|
63892
63932
|
* @memberof OrderApiInterface
|
|
63893
63933
|
*/
|
|
63894
|
-
cancelOrder(order_id: string, options?: any): Promise<BaseResponse>;
|
|
63934
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): Promise<BaseResponse>;
|
|
63895
63935
|
|
|
63896
63936
|
/**
|
|
63897
63937
|
* Delete an order on the UltraCart account.
|
|
@@ -64212,12 +64252,14 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
64212
64252
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
64213
64253
|
* @summary Cancel an order
|
|
64214
64254
|
* @param {string} order_id The order id to cancel.
|
|
64255
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
64256
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
64215
64257
|
* @param {*} [options] Override http request option.
|
|
64216
64258
|
* @throws {RequiredError}
|
|
64217
64259
|
* @memberof OrderApi
|
|
64218
64260
|
*/
|
|
64219
|
-
public cancelOrder(order_id: string, options?: any) {
|
|
64220
|
-
return OrderApiFp(this.configuration).cancelOrder(order_id, options)(this.fetch, this.basePath);
|
|
64261
|
+
public cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any) {
|
|
64262
|
+
return OrderApiFp(this.configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options)(this.fetch, this.basePath);
|
|
64221
64263
|
}
|
|
64222
64264
|
|
|
64223
64265
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -9640,7 +9640,24 @@ export interface Coupon {
|
|
|
9640
9640
|
* @type {string}
|
|
9641
9641
|
* @memberof Coupon
|
|
9642
9642
|
*/
|
|
9643
|
-
usable_by?:
|
|
9643
|
+
usable_by?: Coupon.UsableByEnum;
|
|
9644
|
+
}
|
|
9645
|
+
/**
|
|
9646
|
+
* @export
|
|
9647
|
+
* @namespace Coupon
|
|
9648
|
+
*/
|
|
9649
|
+
export declare namespace Coupon {
|
|
9650
|
+
/**
|
|
9651
|
+
* @export
|
|
9652
|
+
* @enum {string}
|
|
9653
|
+
*/
|
|
9654
|
+
enum UsableByEnum {
|
|
9655
|
+
Anyone,
|
|
9656
|
+
UniqueCode,
|
|
9657
|
+
OncePerCustomer,
|
|
9658
|
+
OncePerNewCustomer,
|
|
9659
|
+
OncePerNewCustomerForItem
|
|
9660
|
+
}
|
|
9644
9661
|
}
|
|
9645
9662
|
/**
|
|
9646
9663
|
*
|
|
@@ -31657,6 +31674,12 @@ export interface OrderShipping {
|
|
|
31657
31674
|
* @memberof OrderShipping
|
|
31658
31675
|
*/
|
|
31659
31676
|
lift_gate?: boolean;
|
|
31677
|
+
/**
|
|
31678
|
+
* Date/time the order should be picked up locally.
|
|
31679
|
+
* @type {string}
|
|
31680
|
+
* @memberof OrderShipping
|
|
31681
|
+
*/
|
|
31682
|
+
pickup_dts?: string;
|
|
31660
31683
|
/**
|
|
31661
31684
|
* Postal code
|
|
31662
31685
|
* @type {string}
|
|
@@ -48310,10 +48333,12 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
|
|
|
48310
48333
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
48311
48334
|
* @summary Cancel an order
|
|
48312
48335
|
* @param {string} order_id The order id to cancel.
|
|
48336
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
48337
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
48313
48338
|
* @param {*} [options] Override http request option.
|
|
48314
48339
|
* @throws {RequiredError}
|
|
48315
48340
|
*/
|
|
48316
|
-
cancelOrder(order_id: string, options?: any): FetchArgs;
|
|
48341
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): FetchArgs;
|
|
48317
48342
|
/**
|
|
48318
48343
|
* Delete an order on the UltraCart account.
|
|
48319
48344
|
* @summary Delete an order
|
|
@@ -48578,10 +48603,12 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
|
|
|
48578
48603
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
48579
48604
|
* @summary Cancel an order
|
|
48580
48605
|
* @param {string} order_id The order id to cancel.
|
|
48606
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
48607
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
48581
48608
|
* @param {*} [options] Override http request option.
|
|
48582
48609
|
* @throws {RequiredError}
|
|
48583
48610
|
*/
|
|
48584
|
-
cancelOrder(order_id: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse>;
|
|
48611
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse>;
|
|
48585
48612
|
/**
|
|
48586
48613
|
* Delete an order on the UltraCart account.
|
|
48587
48614
|
* @summary Delete an order
|
|
@@ -48846,10 +48873,12 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
|
|
|
48846
48873
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
48847
48874
|
* @summary Cancel an order
|
|
48848
48875
|
* @param {string} order_id The order id to cancel.
|
|
48876
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
48877
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
48849
48878
|
* @param {*} [options] Override http request option.
|
|
48850
48879
|
* @throws {RequiredError}
|
|
48851
48880
|
*/
|
|
48852
|
-
cancelOrder(order_id: string, options?: any): Promise<BaseResponse>;
|
|
48881
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): Promise<BaseResponse>;
|
|
48853
48882
|
/**
|
|
48854
48883
|
* Delete an order on the UltraCart account.
|
|
48855
48884
|
* @summary Delete an order
|
|
@@ -49116,11 +49145,13 @@ export interface OrderApiInterface {
|
|
|
49116
49145
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
49117
49146
|
* @summary Cancel an order
|
|
49118
49147
|
* @param {string} order_id The order id to cancel.
|
|
49148
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
49149
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
49119
49150
|
* @param {*} [options] Override http request option.
|
|
49120
49151
|
* @throws {RequiredError}
|
|
49121
49152
|
* @memberof OrderApiInterface
|
|
49122
49153
|
*/
|
|
49123
|
-
cancelOrder(order_id: string, options?: any): Promise<BaseResponse>;
|
|
49154
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): Promise<BaseResponse>;
|
|
49124
49155
|
/**
|
|
49125
49156
|
* Delete an order on the UltraCart account.
|
|
49126
49157
|
* @summary Delete an order
|
|
@@ -49412,11 +49443,13 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
49412
49443
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
49413
49444
|
* @summary Cancel an order
|
|
49414
49445
|
* @param {string} order_id The order id to cancel.
|
|
49446
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
49447
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
49415
49448
|
* @param {*} [options] Override http request option.
|
|
49416
49449
|
* @throws {RequiredError}
|
|
49417
49450
|
* @memberof OrderApi
|
|
49418
49451
|
*/
|
|
49419
|
-
cancelOrder(order_id: string, options?: any): Promise<BaseResponse>;
|
|
49452
|
+
cancelOrder(order_id: string, lock_self_ship_orders?: boolean, skip_refund_and_hold?: boolean, options?: any): Promise<BaseResponse>;
|
|
49420
49453
|
/**
|
|
49421
49454
|
* Delete an order on the UltraCart account.
|
|
49422
49455
|
* @summary Delete an order
|
package/dist/api.js
CHANGED
|
@@ -28,9 +28,10 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
28
28
|
};
|
|
29
29
|
})();
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
|
-
exports.
|
|
32
|
-
exports.
|
|
33
|
-
exports.
|
|
31
|
+
exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.Coupon = 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.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.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = void 0;
|
|
33
|
+
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 = exports.CustomerApiFp = void 0;
|
|
34
|
+
exports.WebhookApi = void 0;
|
|
34
35
|
var url = require("url");
|
|
35
36
|
var portableFetch = require("portable-fetch");
|
|
36
37
|
var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
|
|
@@ -662,6 +663,25 @@ var ConversationWebsocketMessage;
|
|
|
662
663
|
TypeEnum[TypeEnum["CheckQueuePosition"] = 'check queue position'] = "CheckQueuePosition";
|
|
663
664
|
})(TypeEnum = ConversationWebsocketMessage.TypeEnum || (ConversationWebsocketMessage.TypeEnum = {}));
|
|
664
665
|
})(ConversationWebsocketMessage = exports.ConversationWebsocketMessage || (exports.ConversationWebsocketMessage = {}));
|
|
666
|
+
/**
|
|
667
|
+
* @export
|
|
668
|
+
* @namespace Coupon
|
|
669
|
+
*/
|
|
670
|
+
var Coupon;
|
|
671
|
+
(function (Coupon) {
|
|
672
|
+
/**
|
|
673
|
+
* @export
|
|
674
|
+
* @enum {string}
|
|
675
|
+
*/
|
|
676
|
+
var UsableByEnum;
|
|
677
|
+
(function (UsableByEnum) {
|
|
678
|
+
UsableByEnum[UsableByEnum["Anyone"] = 'Anyone'] = "Anyone";
|
|
679
|
+
UsableByEnum[UsableByEnum["UniqueCode"] = 'UniqueCode'] = "UniqueCode";
|
|
680
|
+
UsableByEnum[UsableByEnum["OncePerCustomer"] = 'OncePerCustomer'] = "OncePerCustomer";
|
|
681
|
+
UsableByEnum[UsableByEnum["OncePerNewCustomer"] = 'OncePerNewCustomer'] = "OncePerNewCustomer";
|
|
682
|
+
UsableByEnum[UsableByEnum["OncePerNewCustomerForItem"] = 'OncePerNewCustomerForItem'] = "OncePerNewCustomerForItem";
|
|
683
|
+
})(UsableByEnum = Coupon.UsableByEnum || (Coupon.UsableByEnum = {}));
|
|
684
|
+
})(Coupon = exports.Coupon || (exports.Coupon = {}));
|
|
665
685
|
/**
|
|
666
686
|
* @export
|
|
667
687
|
* @namespace Distance
|
|
@@ -19072,10 +19092,12 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
19072
19092
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
19073
19093
|
* @summary Cancel an order
|
|
19074
19094
|
* @param {string} order_id The order id to cancel.
|
|
19095
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
19096
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
19075
19097
|
* @param {*} [options] Override http request option.
|
|
19076
19098
|
* @throws {RequiredError}
|
|
19077
19099
|
*/
|
|
19078
|
-
cancelOrder: function (order_id, options) {
|
|
19100
|
+
cancelOrder: function (order_id, lock_self_ship_orders, skip_refund_and_hold, options) {
|
|
19079
19101
|
if (options === void 0) { options = {}; }
|
|
19080
19102
|
// verify required parameter 'order_id' is not null or undefined
|
|
19081
19103
|
if (order_id === null || order_id === undefined) {
|
|
@@ -19105,6 +19127,12 @@ var OrderApiFetchParamCreator = function (configuration) {
|
|
|
19105
19127
|
: configuration.apiKey;
|
|
19106
19128
|
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
19107
19129
|
}
|
|
19130
|
+
if (lock_self_ship_orders !== undefined) {
|
|
19131
|
+
localVarQueryParameter['lock_self_ship_orders'] = lock_self_ship_orders;
|
|
19132
|
+
}
|
|
19133
|
+
if (skip_refund_and_hold !== undefined) {
|
|
19134
|
+
localVarQueryParameter['skip_refund_and_hold'] = skip_refund_and_hold;
|
|
19135
|
+
}
|
|
19108
19136
|
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
19109
19137
|
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
19110
19138
|
delete localVarUrlObj.search;
|
|
@@ -20492,11 +20520,13 @@ var OrderApiFp = function (configuration) {
|
|
|
20492
20520
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
20493
20521
|
* @summary Cancel an order
|
|
20494
20522
|
* @param {string} order_id The order id to cancel.
|
|
20523
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
20524
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
20495
20525
|
* @param {*} [options] Override http request option.
|
|
20496
20526
|
* @throws {RequiredError}
|
|
20497
20527
|
*/
|
|
20498
|
-
cancelOrder: function (order_id, options) {
|
|
20499
|
-
var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).cancelOrder(order_id, options);
|
|
20528
|
+
cancelOrder: function (order_id, lock_self_ship_orders, skip_refund_and_hold, options) {
|
|
20529
|
+
var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options);
|
|
20500
20530
|
return function (fetch, basePath) {
|
|
20501
20531
|
if (fetch === void 0) { fetch = portableFetch; }
|
|
20502
20532
|
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
@@ -21115,11 +21145,13 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
|
|
|
21115
21145
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
21116
21146
|
* @summary Cancel an order
|
|
21117
21147
|
* @param {string} order_id The order id to cancel.
|
|
21148
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
21149
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
21118
21150
|
* @param {*} [options] Override http request option.
|
|
21119
21151
|
* @throws {RequiredError}
|
|
21120
21152
|
*/
|
|
21121
|
-
cancelOrder: function (order_id, options) {
|
|
21122
|
-
return (0, exports.OrderApiFp)(configuration).cancelOrder(order_id, options)(fetch, basePath);
|
|
21153
|
+
cancelOrder: function (order_id, lock_self_ship_orders, skip_refund_and_hold, options) {
|
|
21154
|
+
return (0, exports.OrderApiFp)(configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options)(fetch, basePath);
|
|
21123
21155
|
},
|
|
21124
21156
|
/**
|
|
21125
21157
|
* Delete an order on the UltraCart account.
|
|
@@ -21444,12 +21476,14 @@ var OrderApi = /** @class */ (function (_super) {
|
|
|
21444
21476
|
* Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.
|
|
21445
21477
|
* @summary Cancel an order
|
|
21446
21478
|
* @param {string} order_id The order id to cancel.
|
|
21479
|
+
* @param {boolean} [lock_self_ship_orders] Flag to prevent a order shipping during a refund process
|
|
21480
|
+
* @param {boolean} [skip_refund_and_hold] Skip refund and move order to Held Orders department
|
|
21447
21481
|
* @param {*} [options] Override http request option.
|
|
21448
21482
|
* @throws {RequiredError}
|
|
21449
21483
|
* @memberof OrderApi
|
|
21450
21484
|
*/
|
|
21451
|
-
OrderApi.prototype.cancelOrder = function (order_id, options) {
|
|
21452
|
-
return (0, exports.OrderApiFp)(this.configuration).cancelOrder(order_id, options)(this.fetch, this.basePath);
|
|
21485
|
+
OrderApi.prototype.cancelOrder = function (order_id, lock_self_ship_orders, skip_refund_and_hold, options) {
|
|
21486
|
+
return (0, exports.OrderApiFp)(this.configuration).cancelOrder(order_id, lock_self_ship_orders, skip_refund_and_hold, options)(this.fetch, this.basePath);
|
|
21453
21487
|
};
|
|
21454
21488
|
/**
|
|
21455
21489
|
* Delete an order on the UltraCart account.
|