ultracart_rest_api_v2_typescript 3.11.20 → 3.11.22
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 +504 -1
- package/dist/api.d.ts +291 -1
- package/dist/api.js +297 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.11.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.11.22
|
|
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.11.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.11.22 --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.11.22 | 10/06/2025 | added Customer.fax back into object model |
|
|
58
|
+
| 3.11.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
|
57
59
|
| 3.11.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
|
58
60
|
| 3.11.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
|
59
61
|
| 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
|
package/api.ts
CHANGED
|
@@ -14857,6 +14857,12 @@ export interface CustomReportAccountConfig {
|
|
|
14857
14857
|
* @memberof CustomReportAccountConfig
|
|
14858
14858
|
*/
|
|
14859
14859
|
opt_in_date?: string;
|
|
14860
|
+
/**
|
|
14861
|
+
*
|
|
14862
|
+
* @type {boolean}
|
|
14863
|
+
* @memberof CustomReportAccountConfig
|
|
14864
|
+
*/
|
|
14865
|
+
read_only?: boolean;
|
|
14860
14866
|
/**
|
|
14861
14867
|
*
|
|
14862
14868
|
* @type {number}
|
|
@@ -14909,6 +14915,108 @@ export interface CustomReportAccountConfigResponse {
|
|
|
14909
14915
|
warning?: Warning;
|
|
14910
14916
|
}
|
|
14911
14917
|
|
|
14918
|
+
/**
|
|
14919
|
+
*
|
|
14920
|
+
* @export
|
|
14921
|
+
* @interface CustomReportAnalysisRequest
|
|
14922
|
+
*/
|
|
14923
|
+
export interface CustomReportAnalysisRequest {
|
|
14924
|
+
/**
|
|
14925
|
+
*
|
|
14926
|
+
* @type {string}
|
|
14927
|
+
* @memberof CustomReportAnalysisRequest
|
|
14928
|
+
*/
|
|
14929
|
+
png_url?: string;
|
|
14930
|
+
/**
|
|
14931
|
+
*
|
|
14932
|
+
* @type {string}
|
|
14933
|
+
* @memberof CustomReportAnalysisRequest
|
|
14934
|
+
*/
|
|
14935
|
+
result_url?: string;
|
|
14936
|
+
}
|
|
14937
|
+
|
|
14938
|
+
/**
|
|
14939
|
+
*
|
|
14940
|
+
* @export
|
|
14941
|
+
* @interface CustomReportAnalysisResponse
|
|
14942
|
+
*/
|
|
14943
|
+
export interface CustomReportAnalysisResponse {
|
|
14944
|
+
/**
|
|
14945
|
+
*
|
|
14946
|
+
* @type {ModelError}
|
|
14947
|
+
* @memberof CustomReportAnalysisResponse
|
|
14948
|
+
*/
|
|
14949
|
+
error?: ModelError;
|
|
14950
|
+
/**
|
|
14951
|
+
*
|
|
14952
|
+
* @type {string}
|
|
14953
|
+
* @memberof CustomReportAnalysisResponse
|
|
14954
|
+
*/
|
|
14955
|
+
html?: string;
|
|
14956
|
+
/**
|
|
14957
|
+
*
|
|
14958
|
+
* @type {ResponseMetadata}
|
|
14959
|
+
* @memberof CustomReportAnalysisResponse
|
|
14960
|
+
*/
|
|
14961
|
+
metadata?: ResponseMetadata;
|
|
14962
|
+
/**
|
|
14963
|
+
* Indicates if API call was successful
|
|
14964
|
+
* @type {boolean}
|
|
14965
|
+
* @memberof CustomReportAnalysisResponse
|
|
14966
|
+
*/
|
|
14967
|
+
success?: boolean;
|
|
14968
|
+
/**
|
|
14969
|
+
*
|
|
14970
|
+
* @type {Warning}
|
|
14971
|
+
* @memberof CustomReportAnalysisResponse
|
|
14972
|
+
*/
|
|
14973
|
+
warning?: Warning;
|
|
14974
|
+
}
|
|
14975
|
+
|
|
14976
|
+
/**
|
|
14977
|
+
*
|
|
14978
|
+
* @export
|
|
14979
|
+
* @interface CustomReportChartPngUploadResponse
|
|
14980
|
+
*/
|
|
14981
|
+
export interface CustomReportChartPngUploadResponse {
|
|
14982
|
+
/**
|
|
14983
|
+
*
|
|
14984
|
+
* @type {ModelError}
|
|
14985
|
+
* @memberof CustomReportChartPngUploadResponse
|
|
14986
|
+
*/
|
|
14987
|
+
error?: ModelError;
|
|
14988
|
+
/**
|
|
14989
|
+
*
|
|
14990
|
+
* @type {ResponseMetadata}
|
|
14991
|
+
* @memberof CustomReportChartPngUploadResponse
|
|
14992
|
+
*/
|
|
14993
|
+
metadata?: ResponseMetadata;
|
|
14994
|
+
/**
|
|
14995
|
+
*
|
|
14996
|
+
* @type {string}
|
|
14997
|
+
* @memberof CustomReportChartPngUploadResponse
|
|
14998
|
+
*/
|
|
14999
|
+
signed_download_url?: string;
|
|
15000
|
+
/**
|
|
15001
|
+
*
|
|
15002
|
+
* @type {string}
|
|
15003
|
+
* @memberof CustomReportChartPngUploadResponse
|
|
15004
|
+
*/
|
|
15005
|
+
signed_upload_url?: string;
|
|
15006
|
+
/**
|
|
15007
|
+
* Indicates if API call was successful
|
|
15008
|
+
* @type {boolean}
|
|
15009
|
+
* @memberof CustomReportChartPngUploadResponse
|
|
15010
|
+
*/
|
|
15011
|
+
success?: boolean;
|
|
15012
|
+
/**
|
|
15013
|
+
*
|
|
15014
|
+
* @type {Warning}
|
|
15015
|
+
* @memberof CustomReportChartPngUploadResponse
|
|
15016
|
+
*/
|
|
15017
|
+
warning?: Warning;
|
|
15018
|
+
}
|
|
15019
|
+
|
|
14912
15020
|
/**
|
|
14913
15021
|
*
|
|
14914
15022
|
* @export
|
|
@@ -15449,6 +15557,12 @@ export interface Customer {
|
|
|
15449
15557
|
* @memberof Customer
|
|
15450
15558
|
*/
|
|
15451
15559
|
exempt_shipping_handling_charge?: boolean;
|
|
15560
|
+
/**
|
|
15561
|
+
* Fax Number
|
|
15562
|
+
* @type {string}
|
|
15563
|
+
* @memberof Customer
|
|
15564
|
+
*/
|
|
15565
|
+
fax?: string;
|
|
15452
15566
|
/**
|
|
15453
15567
|
* FedEx account number
|
|
15454
15568
|
* @type {string}
|
|
@@ -31393,6 +31507,12 @@ export interface ItemShippingMethod {
|
|
|
31393
31507
|
* @memberof ItemShippingMethod
|
|
31394
31508
|
*/
|
|
31395
31509
|
shipping_method_validity?: ItemShippingMethod.ShippingMethodValidityEnum;
|
|
31510
|
+
/**
|
|
31511
|
+
* Ships separately
|
|
31512
|
+
* @type {boolean}
|
|
31513
|
+
* @memberof ItemShippingMethod
|
|
31514
|
+
*/
|
|
31515
|
+
ships_separately?: boolean;
|
|
31396
31516
|
/**
|
|
31397
31517
|
* Signature required
|
|
31398
31518
|
* @type {boolean}
|
|
@@ -31444,7 +31564,7 @@ export interface ItemShippingPackageRequirement {
|
|
|
31444
31564
|
*/
|
|
31445
31565
|
export interface ItemTag {
|
|
31446
31566
|
/**
|
|
31447
|
-
*
|
|
31567
|
+
* tag_type
|
|
31448
31568
|
* @type {string}
|
|
31449
31569
|
* @memberof ItemTag
|
|
31450
31570
|
*/
|
|
@@ -35557,6 +35677,7 @@ export namespace OrderPayment {
|
|
|
35557
35677
|
Check = <any> 'Check',
|
|
35558
35678
|
COD = <any> 'COD',
|
|
35559
35679
|
CreditCard = <any> 'Credit Card',
|
|
35680
|
+
Crypto = <any> 'Crypto',
|
|
35560
35681
|
EBay = <any> 'eBay',
|
|
35561
35682
|
ECheck = <any> 'eCheck',
|
|
35562
35683
|
GoogleShopping = <any> 'Google Shopping',
|
|
@@ -38483,6 +38604,38 @@ export interface RegisterAffiliateClickResponse {
|
|
|
38483
38604
|
registered?: boolean;
|
|
38484
38605
|
}
|
|
38485
38606
|
|
|
38607
|
+
/**
|
|
38608
|
+
*
|
|
38609
|
+
* @export
|
|
38610
|
+
* @interface ReplaceOrderItemIdRequest
|
|
38611
|
+
*/
|
|
38612
|
+
export interface ReplaceOrderItemIdRequest {
|
|
38613
|
+
/**
|
|
38614
|
+
* Index of the item on the order. Must match order.items[].item_index
|
|
38615
|
+
* @type {number}
|
|
38616
|
+
* @memberof ReplaceOrderItemIdRequest
|
|
38617
|
+
*/
|
|
38618
|
+
item_index?: number;
|
|
38619
|
+
/**
|
|
38620
|
+
* Item ID
|
|
38621
|
+
* @type {string}
|
|
38622
|
+
* @memberof ReplaceOrderItemIdRequest
|
|
38623
|
+
*/
|
|
38624
|
+
merchant_item_id?: string;
|
|
38625
|
+
/**
|
|
38626
|
+
* Order ID
|
|
38627
|
+
* @type {string}
|
|
38628
|
+
* @memberof ReplaceOrderItemIdRequest
|
|
38629
|
+
*/
|
|
38630
|
+
order_id?: string;
|
|
38631
|
+
/**
|
|
38632
|
+
* Replacement Item ID
|
|
38633
|
+
* @type {string}
|
|
38634
|
+
* @memberof ReplaceOrderItemIdRequest
|
|
38635
|
+
*/
|
|
38636
|
+
replacement_merchant_item_id?: string;
|
|
38637
|
+
}
|
|
38638
|
+
|
|
38486
38639
|
/**
|
|
38487
38640
|
*
|
|
38488
38641
|
* @export
|
|
@@ -67176,6 +67329,67 @@ export class CustomerApi extends BaseAPI implements CustomerApiInterface {
|
|
|
67176
67329
|
*/
|
|
67177
67330
|
export const DatawarehouseApiFetchParamCreator = function (configuration?: Configuration) {
|
|
67178
67331
|
return {
|
|
67332
|
+
/**
|
|
67333
|
+
* Analyze a custom report on the UltraCart account.
|
|
67334
|
+
* @summary Analyze a custom report
|
|
67335
|
+
* @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
|
|
67336
|
+
* @param {number} custom_report_oid The report oid to analyze.
|
|
67337
|
+
* @param {*} [options] Override http request option.
|
|
67338
|
+
* @throws {RequiredError}
|
|
67339
|
+
*/
|
|
67340
|
+
analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options: any = {}): FetchArgs {
|
|
67341
|
+
// verify required parameter 'analyze_request' is not null or undefined
|
|
67342
|
+
if (analyze_request === null || analyze_request === undefined) {
|
|
67343
|
+
throw new RequiredError('analyze_request','Required parameter analyze_request was null or undefined when calling analyzeCustomReport.');
|
|
67344
|
+
}
|
|
67345
|
+
// verify required parameter 'custom_report_oid' is not null or undefined
|
|
67346
|
+
if (custom_report_oid === null || custom_report_oid === undefined) {
|
|
67347
|
+
throw new RequiredError('custom_report_oid','Required parameter custom_report_oid was null or undefined when calling analyzeCustomReport.');
|
|
67348
|
+
}
|
|
67349
|
+
const localVarPath = `/datawarehouse/custom_reports/{custom_report_oid}/analysis`
|
|
67350
|
+
.replace(`{${"custom_report_oid"}}`, encodeURIComponent(String(custom_report_oid)));
|
|
67351
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
67352
|
+
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
67353
|
+
const localVarHeaderParameter = {} as any;
|
|
67354
|
+
const localVarQueryParameter = {} as any;
|
|
67355
|
+
|
|
67356
|
+
if(configuration && configuration.apiVersion) {
|
|
67357
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
67358
|
+
}
|
|
67359
|
+
|
|
67360
|
+
|
|
67361
|
+
|
|
67362
|
+
// authentication ultraCartOauth required
|
|
67363
|
+
// oauth required
|
|
67364
|
+
if (configuration && configuration.accessToken) {
|
|
67365
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
67366
|
+
? configuration.accessToken("ultraCartOauth", [])
|
|
67367
|
+
: configuration.accessToken;
|
|
67368
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
67369
|
+
}
|
|
67370
|
+
|
|
67371
|
+
// authentication ultraCartSimpleApiKey required
|
|
67372
|
+
if (configuration && configuration.apiKey) {
|
|
67373
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
67374
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
67375
|
+
: configuration.apiKey;
|
|
67376
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
67377
|
+
}
|
|
67378
|
+
|
|
67379
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
67380
|
+
|
|
67381
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
67382
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
67383
|
+
delete localVarUrlObj.search;
|
|
67384
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
67385
|
+
const needsSerialization = (<any>"CustomReportAnalysisRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
67386
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(analyze_request || {}) : (analyze_request || "");
|
|
67387
|
+
|
|
67388
|
+
return {
|
|
67389
|
+
url: url.format(localVarUrlObj),
|
|
67390
|
+
options: localVarRequestOptions,
|
|
67391
|
+
};
|
|
67392
|
+
},
|
|
67179
67393
|
/**
|
|
67180
67394
|
* Delete a custom dashboard on the UltraCart account.
|
|
67181
67395
|
* @summary Delete a custom dashboard
|
|
@@ -67837,6 +68051,58 @@ export const DatawarehouseApiFetchParamCreator = function (configuration?: Confi
|
|
|
67837
68051
|
|
|
67838
68052
|
|
|
67839
68053
|
|
|
68054
|
+
// authentication ultraCartOauth required
|
|
68055
|
+
// oauth required
|
|
68056
|
+
if (configuration && configuration.accessToken) {
|
|
68057
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
68058
|
+
? configuration.accessToken("ultraCartOauth", [])
|
|
68059
|
+
: configuration.accessToken;
|
|
68060
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
68061
|
+
}
|
|
68062
|
+
|
|
68063
|
+
// authentication ultraCartSimpleApiKey required
|
|
68064
|
+
if (configuration && configuration.apiKey) {
|
|
68065
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
68066
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
68067
|
+
: configuration.apiKey;
|
|
68068
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
68069
|
+
}
|
|
68070
|
+
|
|
68071
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
68072
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
68073
|
+
delete localVarUrlObj.search;
|
|
68074
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
68075
|
+
|
|
68076
|
+
return {
|
|
68077
|
+
url: url.format(localVarUrlObj),
|
|
68078
|
+
options: localVarRequestOptions,
|
|
68079
|
+
};
|
|
68080
|
+
},
|
|
68081
|
+
/**
|
|
68082
|
+
* Upload a PNG of a custom report chart
|
|
68083
|
+
* @summary Upload a PNG of a custom report chart
|
|
68084
|
+
* @param {number} custom_report_oid The report oid to upload a chart PNG for.
|
|
68085
|
+
* @param {*} [options] Override http request option.
|
|
68086
|
+
* @throws {RequiredError}
|
|
68087
|
+
*/
|
|
68088
|
+
getCustomReportChartPngUploadUrl(custom_report_oid: number, options: any = {}): FetchArgs {
|
|
68089
|
+
// verify required parameter 'custom_report_oid' is not null or undefined
|
|
68090
|
+
if (custom_report_oid === null || custom_report_oid === undefined) {
|
|
68091
|
+
throw new RequiredError('custom_report_oid','Required parameter custom_report_oid was null or undefined when calling getCustomReportChartPngUploadUrl.');
|
|
68092
|
+
}
|
|
68093
|
+
const localVarPath = `/datawarehouse/custom_reports/{custom_report_oid}/chart_png`
|
|
68094
|
+
.replace(`{${"custom_report_oid"}}`, encodeURIComponent(String(custom_report_oid)));
|
|
68095
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
68096
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
68097
|
+
const localVarHeaderParameter = {} as any;
|
|
68098
|
+
const localVarQueryParameter = {} as any;
|
|
68099
|
+
|
|
68100
|
+
if(configuration && configuration.apiVersion) {
|
|
68101
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
68102
|
+
}
|
|
68103
|
+
|
|
68104
|
+
|
|
68105
|
+
|
|
67840
68106
|
// authentication ultraCartOauth required
|
|
67841
68107
|
// oauth required
|
|
67842
68108
|
if (configuration && configuration.accessToken) {
|
|
@@ -68704,6 +68970,28 @@ export const DatawarehouseApiFetchParamCreator = function (configuration?: Confi
|
|
|
68704
68970
|
*/
|
|
68705
68971
|
export const DatawarehouseApiFp = function(configuration?: Configuration) {
|
|
68706
68972
|
return {
|
|
68973
|
+
/**
|
|
68974
|
+
* Analyze a custom report on the UltraCart account.
|
|
68975
|
+
* @summary Analyze a custom report
|
|
68976
|
+
* @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
|
|
68977
|
+
* @param {number} custom_report_oid The report oid to analyze.
|
|
68978
|
+
* @param {*} [options] Override http request option.
|
|
68979
|
+
* @throws {RequiredError}
|
|
68980
|
+
*/
|
|
68981
|
+
analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomReportAnalysisResponse> {
|
|
68982
|
+
const localVarFetchArgs = DatawarehouseApiFetchParamCreator(configuration).analyzeCustomReport(analyze_request, custom_report_oid, options);
|
|
68983
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
68984
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
68985
|
+
|
|
68986
|
+
if (response.status >= 200 && response.status < 300) {
|
|
68987
|
+
return response.json();
|
|
68988
|
+
|
|
68989
|
+
} else {
|
|
68990
|
+
throw response;
|
|
68991
|
+
}
|
|
68992
|
+
});
|
|
68993
|
+
};
|
|
68994
|
+
},
|
|
68707
68995
|
/**
|
|
68708
68996
|
* Delete a custom dashboard on the UltraCart account.
|
|
68709
68997
|
* @summary Delete a custom dashboard
|
|
@@ -68977,6 +69265,27 @@ export const DatawarehouseApiFp = function(configuration?: Configuration) {
|
|
|
68977
69265
|
});
|
|
68978
69266
|
};
|
|
68979
69267
|
},
|
|
69268
|
+
/**
|
|
69269
|
+
* Upload a PNG of a custom report chart
|
|
69270
|
+
* @summary Upload a PNG of a custom report chart
|
|
69271
|
+
* @param {number} custom_report_oid The report oid to upload a chart PNG for.
|
|
69272
|
+
* @param {*} [options] Override http request option.
|
|
69273
|
+
* @throws {RequiredError}
|
|
69274
|
+
*/
|
|
69275
|
+
getCustomReportChartPngUploadUrl(custom_report_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomReportChartPngUploadResponse> {
|
|
69276
|
+
const localVarFetchArgs = DatawarehouseApiFetchParamCreator(configuration).getCustomReportChartPngUploadUrl(custom_report_oid, options);
|
|
69277
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
69278
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
69279
|
+
|
|
69280
|
+
if (response.status >= 200 && response.status < 300) {
|
|
69281
|
+
return response.json();
|
|
69282
|
+
|
|
69283
|
+
} else {
|
|
69284
|
+
throw response;
|
|
69285
|
+
}
|
|
69286
|
+
});
|
|
69287
|
+
};
|
|
69288
|
+
},
|
|
68980
69289
|
/**
|
|
68981
69290
|
* Retrieve a custom reports
|
|
68982
69291
|
* @summary Get custom reports
|
|
@@ -69305,6 +69614,17 @@ export const DatawarehouseApiFp = function(configuration?: Configuration) {
|
|
|
69305
69614
|
*/
|
|
69306
69615
|
export const DatawarehouseApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
|
|
69307
69616
|
return {
|
|
69617
|
+
/**
|
|
69618
|
+
* Analyze a custom report on the UltraCart account.
|
|
69619
|
+
* @summary Analyze a custom report
|
|
69620
|
+
* @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
|
|
69621
|
+
* @param {number} custom_report_oid The report oid to analyze.
|
|
69622
|
+
* @param {*} [options] Override http request option.
|
|
69623
|
+
* @throws {RequiredError}
|
|
69624
|
+
*/
|
|
69625
|
+
analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options?: any) {
|
|
69626
|
+
return DatawarehouseApiFp(configuration).analyzeCustomReport(analyze_request, custom_report_oid, options)(fetch, basePath);
|
|
69627
|
+
},
|
|
69308
69628
|
/**
|
|
69309
69629
|
* Delete a custom dashboard on the UltraCart account.
|
|
69310
69630
|
* @summary Delete a custom dashboard
|
|
@@ -69435,6 +69755,16 @@ export const DatawarehouseApiFactory = function (configuration?: Configuration,
|
|
|
69435
69755
|
getCustomReportAccountConfig(options?: any) {
|
|
69436
69756
|
return DatawarehouseApiFp(configuration).getCustomReportAccountConfig(options)(fetch, basePath);
|
|
69437
69757
|
},
|
|
69758
|
+
/**
|
|
69759
|
+
* Upload a PNG of a custom report chart
|
|
69760
|
+
* @summary Upload a PNG of a custom report chart
|
|
69761
|
+
* @param {number} custom_report_oid The report oid to upload a chart PNG for.
|
|
69762
|
+
* @param {*} [options] Override http request option.
|
|
69763
|
+
* @throws {RequiredError}
|
|
69764
|
+
*/
|
|
69765
|
+
getCustomReportChartPngUploadUrl(custom_report_oid: number, options?: any) {
|
|
69766
|
+
return DatawarehouseApiFp(configuration).getCustomReportChartPngUploadUrl(custom_report_oid, options)(fetch, basePath);
|
|
69767
|
+
},
|
|
69438
69768
|
/**
|
|
69439
69769
|
* Retrieve a custom reports
|
|
69440
69770
|
* @summary Get custom reports
|
|
@@ -69598,6 +69928,17 @@ export const DatawarehouseApiFactory = function (configuration?: Configuration,
|
|
|
69598
69928
|
* @interface DatawarehouseApi
|
|
69599
69929
|
*/
|
|
69600
69930
|
export interface DatawarehouseApiInterface {
|
|
69931
|
+
/**
|
|
69932
|
+
* Analyze a custom report on the UltraCart account.
|
|
69933
|
+
* @summary Analyze a custom report
|
|
69934
|
+
* @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
|
|
69935
|
+
* @param {number} custom_report_oid The report oid to analyze.
|
|
69936
|
+
* @param {*} [options] Override http request option.
|
|
69937
|
+
* @throws {RequiredError}
|
|
69938
|
+
* @memberof DatawarehouseApiInterface
|
|
69939
|
+
*/
|
|
69940
|
+
analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options?: any): Promise<CustomReportAnalysisResponse>;
|
|
69941
|
+
|
|
69601
69942
|
/**
|
|
69602
69943
|
* Delete a custom dashboard on the UltraCart account.
|
|
69603
69944
|
* @summary Delete a custom dashboard
|
|
@@ -69728,6 +70069,16 @@ export interface DatawarehouseApiInterface {
|
|
|
69728
70069
|
*/
|
|
69729
70070
|
getCustomReportAccountConfig(options?: any): Promise<CustomReportAccountConfigResponse>;
|
|
69730
70071
|
|
|
70072
|
+
/**
|
|
70073
|
+
* Upload a PNG of a custom report chart
|
|
70074
|
+
* @summary Upload a PNG of a custom report chart
|
|
70075
|
+
* @param {number} custom_report_oid The report oid to upload a chart PNG for.
|
|
70076
|
+
* @param {*} [options] Override http request option.
|
|
70077
|
+
* @throws {RequiredError}
|
|
70078
|
+
* @memberof DatawarehouseApiInterface
|
|
70079
|
+
*/
|
|
70080
|
+
getCustomReportChartPngUploadUrl(custom_report_oid: number, options?: any): Promise<CustomReportChartPngUploadResponse>;
|
|
70081
|
+
|
|
69731
70082
|
/**
|
|
69732
70083
|
* Retrieve a custom reports
|
|
69733
70084
|
* @summary Get custom reports
|
|
@@ -69891,6 +70242,19 @@ export interface DatawarehouseApiInterface {
|
|
|
69891
70242
|
* @extends {BaseAPI}
|
|
69892
70243
|
*/
|
|
69893
70244
|
export class DatawarehouseApi extends BaseAPI implements DatawarehouseApiInterface {
|
|
70245
|
+
/**
|
|
70246
|
+
* Analyze a custom report on the UltraCart account.
|
|
70247
|
+
* @summary Analyze a custom report
|
|
70248
|
+
* @param {CustomReportAnalysisRequest} analyze_request Request to analyze custom report
|
|
70249
|
+
* @param {number} custom_report_oid The report oid to analyze.
|
|
70250
|
+
* @param {*} [options] Override http request option.
|
|
70251
|
+
* @throws {RequiredError}
|
|
70252
|
+
* @memberof DatawarehouseApi
|
|
70253
|
+
*/
|
|
70254
|
+
public analyzeCustomReport(analyze_request: CustomReportAnalysisRequest, custom_report_oid: number, options?: any) {
|
|
70255
|
+
return DatawarehouseApiFp(this.configuration).analyzeCustomReport(analyze_request, custom_report_oid, options)(this.fetch, this.basePath);
|
|
70256
|
+
}
|
|
70257
|
+
|
|
69894
70258
|
/**
|
|
69895
70259
|
* Delete a custom dashboard on the UltraCart account.
|
|
69896
70260
|
* @summary Delete a custom dashboard
|
|
@@ -70047,6 +70411,18 @@ export class DatawarehouseApi extends BaseAPI implements DatawarehouseApiInterfa
|
|
|
70047
70411
|
return DatawarehouseApiFp(this.configuration).getCustomReportAccountConfig(options)(this.fetch, this.basePath);
|
|
70048
70412
|
}
|
|
70049
70413
|
|
|
70414
|
+
/**
|
|
70415
|
+
* Upload a PNG of a custom report chart
|
|
70416
|
+
* @summary Upload a PNG of a custom report chart
|
|
70417
|
+
* @param {number} custom_report_oid The report oid to upload a chart PNG for.
|
|
70418
|
+
* @param {*} [options] Override http request option.
|
|
70419
|
+
* @throws {RequiredError}
|
|
70420
|
+
* @memberof DatawarehouseApi
|
|
70421
|
+
*/
|
|
70422
|
+
public getCustomReportChartPngUploadUrl(custom_report_oid: number, options?: any) {
|
|
70423
|
+
return DatawarehouseApiFp(this.configuration).getCustomReportChartPngUploadUrl(custom_report_oid, options)(this.fetch, this.basePath);
|
|
70424
|
+
}
|
|
70425
|
+
|
|
70050
70426
|
/**
|
|
70051
70427
|
* Retrieve a custom reports
|
|
70052
70428
|
* @summary Get custom reports
|
|
@@ -77152,6 +77528,72 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
|
|
|
77152
77528
|
options: localVarRequestOptions,
|
|
77153
77529
|
};
|
|
77154
77530
|
},
|
|
77531
|
+
/**
|
|
77532
|
+
* Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
|
|
77533
|
+
* @summary Replaces an order item id
|
|
77534
|
+
* @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
|
|
77535
|
+
* @param {string} order_id The order id to update.
|
|
77536
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
77537
|
+
* @param {*} [options] Override http request option.
|
|
77538
|
+
* @throws {RequiredError}
|
|
77539
|
+
*/
|
|
77540
|
+
replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options: any = {}): FetchArgs {
|
|
77541
|
+
// verify required parameter 'replace_order_item_id_request' is not null or undefined
|
|
77542
|
+
if (replace_order_item_id_request === null || replace_order_item_id_request === undefined) {
|
|
77543
|
+
throw new RequiredError('replace_order_item_id_request','Required parameter replace_order_item_id_request was null or undefined when calling replaceOrderItemMerchantItemId.');
|
|
77544
|
+
}
|
|
77545
|
+
// verify required parameter 'order_id' is not null or undefined
|
|
77546
|
+
if (order_id === null || order_id === undefined) {
|
|
77547
|
+
throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling replaceOrderItemMerchantItemId.');
|
|
77548
|
+
}
|
|
77549
|
+
const localVarPath = `/order/orders/{order_id}/replace_item_id`
|
|
77550
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
|
|
77551
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
77552
|
+
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
77553
|
+
const localVarHeaderParameter = {} as any;
|
|
77554
|
+
const localVarQueryParameter = {} as any;
|
|
77555
|
+
|
|
77556
|
+
if(configuration && configuration.apiVersion) {
|
|
77557
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
77558
|
+
}
|
|
77559
|
+
|
|
77560
|
+
|
|
77561
|
+
|
|
77562
|
+
// authentication ultraCartOauth required
|
|
77563
|
+
// oauth required
|
|
77564
|
+
if (configuration && configuration.accessToken) {
|
|
77565
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
77566
|
+
? configuration.accessToken("ultraCartOauth", ["order_write"])
|
|
77567
|
+
: configuration.accessToken;
|
|
77568
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
77569
|
+
}
|
|
77570
|
+
|
|
77571
|
+
// authentication ultraCartSimpleApiKey required
|
|
77572
|
+
if (configuration && configuration.apiKey) {
|
|
77573
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
77574
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
77575
|
+
: configuration.apiKey;
|
|
77576
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
77577
|
+
}
|
|
77578
|
+
|
|
77579
|
+
if (_expand !== undefined) {
|
|
77580
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
77581
|
+
}
|
|
77582
|
+
|
|
77583
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
77584
|
+
|
|
77585
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
77586
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
77587
|
+
delete localVarUrlObj.search;
|
|
77588
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
77589
|
+
const needsSerialization = (<any>"ReplaceOrderItemIdRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
77590
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(replace_order_item_id_request || {}) : (replace_order_item_id_request || "");
|
|
77591
|
+
|
|
77592
|
+
return {
|
|
77593
|
+
url: url.format(localVarUrlObj),
|
|
77594
|
+
options: localVarRequestOptions,
|
|
77595
|
+
};
|
|
77596
|
+
},
|
|
77155
77597
|
/**
|
|
77156
77598
|
* Create a replacement order based upon a previous order
|
|
77157
77599
|
* @summary Replacement order
|
|
@@ -78071,6 +78513,29 @@ export const OrderApiFp = function(configuration?: Configuration) {
|
|
|
78071
78513
|
});
|
|
78072
78514
|
};
|
|
78073
78515
|
},
|
|
78516
|
+
/**
|
|
78517
|
+
* Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
|
|
78518
|
+
* @summary Replaces an order item id
|
|
78519
|
+
* @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
|
|
78520
|
+
* @param {string} order_id The order id to update.
|
|
78521
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
78522
|
+
* @param {*} [options] Override http request option.
|
|
78523
|
+
* @throws {RequiredError}
|
|
78524
|
+
*/
|
|
78525
|
+
replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
|
|
78526
|
+
const localVarFetchArgs = OrderApiFetchParamCreator(configuration).replaceOrderItemMerchantItemId(replace_order_item_id_request, order_id, _expand, options);
|
|
78527
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
78528
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
78529
|
+
|
|
78530
|
+
if (response.status >= 200 && response.status < 300) {
|
|
78531
|
+
return response.json();
|
|
78532
|
+
|
|
78533
|
+
} else {
|
|
78534
|
+
throw response;
|
|
78535
|
+
}
|
|
78536
|
+
});
|
|
78537
|
+
};
|
|
78538
|
+
},
|
|
78074
78539
|
/**
|
|
78075
78540
|
* Create a replacement order based upon a previous order
|
|
78076
78541
|
* @summary Replacement order
|
|
@@ -78505,6 +78970,18 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
|
|
|
78505
78970
|
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any) {
|
|
78506
78971
|
return OrderApiFp(configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(fetch, basePath);
|
|
78507
78972
|
},
|
|
78973
|
+
/**
|
|
78974
|
+
* Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
|
|
78975
|
+
* @summary Replaces an order item id
|
|
78976
|
+
* @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
|
|
78977
|
+
* @param {string} order_id The order id to update.
|
|
78978
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
78979
|
+
* @param {*} [options] Override http request option.
|
|
78980
|
+
* @throws {RequiredError}
|
|
78981
|
+
*/
|
|
78982
|
+
replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options?: any) {
|
|
78983
|
+
return OrderApiFp(configuration).replaceOrderItemMerchantItemId(replace_order_item_id_request, order_id, _expand, options)(fetch, basePath);
|
|
78984
|
+
},
|
|
78508
78985
|
/**
|
|
78509
78986
|
* Create a replacement order based upon a previous order
|
|
78510
78987
|
* @summary Replacement order
|
|
@@ -78862,6 +79339,18 @@ export interface OrderApiInterface {
|
|
|
78862
79339
|
*/
|
|
78863
79340
|
refundOrder(order: Order, order_id: string, reject_after_refund?: boolean, skip_customer_notification?: boolean, auto_order_cancel?: boolean, manual_refund?: boolean, reverse_affiliate_transactions?: boolean, issue_store_credit?: boolean, auto_order_cancel_reason?: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
78864
79341
|
|
|
79342
|
+
/**
|
|
79343
|
+
* Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
|
|
79344
|
+
* @summary Replaces an order item id
|
|
79345
|
+
* @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
|
|
79346
|
+
* @param {string} order_id The order id to update.
|
|
79347
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
79348
|
+
* @param {*} [options] Override http request option.
|
|
79349
|
+
* @throws {RequiredError}
|
|
79350
|
+
* @memberof OrderApiInterface
|
|
79351
|
+
*/
|
|
79352
|
+
replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
79353
|
+
|
|
78865
79354
|
/**
|
|
78866
79355
|
* Create a replacement order based upon a previous order
|
|
78867
79356
|
* @summary Replacement order
|
|
@@ -79263,6 +79752,20 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
|
|
|
79263
79752
|
return OrderApiFp(this.configuration).refundOrder(order, order_id, reject_after_refund, skip_customer_notification, auto_order_cancel, manual_refund, reverse_affiliate_transactions, issue_store_credit, auto_order_cancel_reason, _expand, options)(this.fetch, this.basePath);
|
|
79264
79753
|
}
|
|
79265
79754
|
|
|
79755
|
+
/**
|
|
79756
|
+
* Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.
|
|
79757
|
+
* @summary Replaces an order item id
|
|
79758
|
+
* @param {ReplaceOrderItemIdRequest} replace_order_item_id_request Replacement Request
|
|
79759
|
+
* @param {string} order_id The order id to update.
|
|
79760
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
79761
|
+
* @param {*} [options] Override http request option.
|
|
79762
|
+
* @throws {RequiredError}
|
|
79763
|
+
* @memberof OrderApi
|
|
79764
|
+
*/
|
|
79765
|
+
public replaceOrderItemMerchantItemId(replace_order_item_id_request: ReplaceOrderItemIdRequest, order_id: string, _expand?: string, options?: any) {
|
|
79766
|
+
return OrderApiFp(this.configuration).replaceOrderItemMerchantItemId(replace_order_item_id_request, order_id, _expand, options)(this.fetch, this.basePath);
|
|
79767
|
+
}
|
|
79768
|
+
|
|
79266
79769
|
/**
|
|
79267
79770
|
* Create a replacement order based upon a previous order
|
|
79268
79771
|
* @summary Replacement order
|