ultracart_rest_api_v2_typescript 3.10.127 → 3.10.129
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 +220 -1
- package/dist/api.d.ts +150 -1
- package/dist/api.js +92 -0
- 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.129
|
|
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.129 --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.129 | 04/11/2023 | missing sezzle payment constant |
|
|
58
|
+
| 3.10.128 | 04/10/2023 | data warehouse internal dev |
|
|
57
59
|
| 3.10.127 | 03/29/2023 | internal development |
|
|
58
60
|
| 3.10.126 | 03/22/2023 | data warehouse internal dev |
|
|
59
61
|
| 3.10.125 | 03/22/2023 | dw initial framework |
|
package/api.ts
CHANGED
|
@@ -162,6 +162,12 @@ export interface AccountsReceivableRetryConfig {
|
|
|
162
162
|
* @memberof AccountsReceivableRetryConfig
|
|
163
163
|
*/
|
|
164
164
|
reject_at_end?: boolean;
|
|
165
|
+
/**
|
|
166
|
+
* Array of key/value pairs that when found in the response cause the rejection of the transaction.
|
|
167
|
+
* @type {Array<AccountsReceivableRetryTransactionReject>}
|
|
168
|
+
* @memberof AccountsReceivableRetryConfig
|
|
169
|
+
*/
|
|
170
|
+
transaction_rejects?: Array<AccountsReceivableRetryTransactionReject>;
|
|
165
171
|
/**
|
|
166
172
|
* True if the account is currently in trial mode. Set to false to exit trial mode.
|
|
167
173
|
* @type {boolean}
|
|
@@ -428,6 +434,26 @@ export interface AccountsReceivableRetryStatsResponse {
|
|
|
428
434
|
warning?: Warning;
|
|
429
435
|
}
|
|
430
436
|
|
|
437
|
+
/**
|
|
438
|
+
*
|
|
439
|
+
* @export
|
|
440
|
+
* @interface AccountsReceivableRetryTransactionReject
|
|
441
|
+
*/
|
|
442
|
+
export interface AccountsReceivableRetryTransactionReject {
|
|
443
|
+
/**
|
|
444
|
+
* Transaction response name
|
|
445
|
+
* @type {string}
|
|
446
|
+
* @memberof AccountsReceivableRetryTransactionReject
|
|
447
|
+
*/
|
|
448
|
+
name?: string;
|
|
449
|
+
/**
|
|
450
|
+
* Transaction response value
|
|
451
|
+
* @type {string}
|
|
452
|
+
* @memberof AccountsReceivableRetryTransactionReject
|
|
453
|
+
*/
|
|
454
|
+
value?: string;
|
|
455
|
+
}
|
|
456
|
+
|
|
431
457
|
/**
|
|
432
458
|
*
|
|
433
459
|
* @export
|
|
@@ -20093,6 +20119,12 @@ export interface Experiment {
|
|
|
20093
20119
|
* @memberof Experiment
|
|
20094
20120
|
*/
|
|
20095
20121
|
optimization_type?: string;
|
|
20122
|
+
/**
|
|
20123
|
+
* Estimated sessions needed to achieve P95
|
|
20124
|
+
* @type {number}
|
|
20125
|
+
* @memberof Experiment
|
|
20126
|
+
*/
|
|
20127
|
+
p95_sessions_needed?: number;
|
|
20096
20128
|
/**
|
|
20097
20129
|
* Statistics p-value for the experiment
|
|
20098
20130
|
* @type {number}
|
|
@@ -30767,7 +30799,8 @@ export namespace OrderPayment {
|
|
|
30767
30799
|
Unknown = <any> 'Unknown',
|
|
30768
30800
|
WireTransfer = <any> 'Wire Transfer',
|
|
30769
30801
|
Walmart = <any> 'Walmart',
|
|
30770
|
-
ShopCom = <any> 'Shop.com'
|
|
30802
|
+
ShopCom = <any> 'Shop.com',
|
|
30803
|
+
Sezzle = <any> 'Sezzle'
|
|
30771
30804
|
}
|
|
30772
30805
|
/**
|
|
30773
30806
|
* @export
|
|
@@ -34008,6 +34041,84 @@ export namespace ReportDataSourceSchema {
|
|
|
34008
34041
|
}
|
|
34009
34042
|
}
|
|
34010
34043
|
|
|
34044
|
+
/**
|
|
34045
|
+
*
|
|
34046
|
+
* @export
|
|
34047
|
+
* @interface ReportDryRunQueriesRequest
|
|
34048
|
+
*/
|
|
34049
|
+
export interface ReportDryRunQueriesRequest {
|
|
34050
|
+
/**
|
|
34051
|
+
*
|
|
34052
|
+
* @type {string}
|
|
34053
|
+
* @memberof ReportDryRunQueriesRequest
|
|
34054
|
+
*/
|
|
34055
|
+
connection_id?: string;
|
|
34056
|
+
/**
|
|
34057
|
+
*
|
|
34058
|
+
* @type {string}
|
|
34059
|
+
* @memberof ReportDryRunQueriesRequest
|
|
34060
|
+
*/
|
|
34061
|
+
default_dataset_id?: string;
|
|
34062
|
+
/**
|
|
34063
|
+
*
|
|
34064
|
+
* @type {string}
|
|
34065
|
+
* @memberof ReportDryRunQueriesRequest
|
|
34066
|
+
*/
|
|
34067
|
+
default_project_id?: string;
|
|
34068
|
+
/**
|
|
34069
|
+
*
|
|
34070
|
+
* @type {string}
|
|
34071
|
+
* @memberof ReportDryRunQueriesRequest
|
|
34072
|
+
*/
|
|
34073
|
+
merchant_id?: string;
|
|
34074
|
+
/**
|
|
34075
|
+
*
|
|
34076
|
+
* @type {Array<ReportDataSetQuery>}
|
|
34077
|
+
* @memberof ReportDryRunQueriesRequest
|
|
34078
|
+
*/
|
|
34079
|
+
queries?: Array<ReportDataSetQuery>;
|
|
34080
|
+
/**
|
|
34081
|
+
*
|
|
34082
|
+
* @type {string}
|
|
34083
|
+
* @memberof ReportDryRunQueriesRequest
|
|
34084
|
+
*/
|
|
34085
|
+
security_level?: string;
|
|
34086
|
+
}
|
|
34087
|
+
|
|
34088
|
+
/**
|
|
34089
|
+
*
|
|
34090
|
+
* @export
|
|
34091
|
+
* @interface ReportDryRunQueriesResponse
|
|
34092
|
+
*/
|
|
34093
|
+
export interface ReportDryRunQueriesResponse {
|
|
34094
|
+
/**
|
|
34095
|
+
*
|
|
34096
|
+
* @type {Array<ReportDryRunQueryResult>}
|
|
34097
|
+
* @memberof ReportDryRunQueriesResponse
|
|
34098
|
+
*/
|
|
34099
|
+
dry_run_query_results?: Array<ReportDryRunQueryResult>;
|
|
34100
|
+
}
|
|
34101
|
+
|
|
34102
|
+
/**
|
|
34103
|
+
*
|
|
34104
|
+
* @export
|
|
34105
|
+
* @interface ReportDryRunQueryResult
|
|
34106
|
+
*/
|
|
34107
|
+
export interface ReportDryRunQueryResult {
|
|
34108
|
+
/**
|
|
34109
|
+
*
|
|
34110
|
+
* @type {string}
|
|
34111
|
+
* @memberof ReportDryRunQueryResult
|
|
34112
|
+
*/
|
|
34113
|
+
error_message?: string;
|
|
34114
|
+
/**
|
|
34115
|
+
*
|
|
34116
|
+
* @type {number}
|
|
34117
|
+
* @memberof ReportDryRunQueryResult
|
|
34118
|
+
*/
|
|
34119
|
+
total_bytes_processed?: number;
|
|
34120
|
+
}
|
|
34121
|
+
|
|
34011
34122
|
/**
|
|
34012
34123
|
*
|
|
34013
34124
|
* @export
|
|
@@ -54400,6 +54511,61 @@ export const DatawarehouseApiFetchParamCreator = function (configuration?: Confi
|
|
|
54400
54511
|
options: localVarRequestOptions,
|
|
54401
54512
|
};
|
|
54402
54513
|
},
|
|
54514
|
+
/**
|
|
54515
|
+
* Dry run the report queries
|
|
54516
|
+
* @summary Dry run the report queries
|
|
54517
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
54518
|
+
* @param {*} [options] Override http request option.
|
|
54519
|
+
* @throws {RequiredError}
|
|
54520
|
+
*/
|
|
54521
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options: any = {}): FetchArgs {
|
|
54522
|
+
// verify required parameter 'query_request' is not null or undefined
|
|
54523
|
+
if (query_request === null || query_request === undefined) {
|
|
54524
|
+
throw new RequiredError('query_request','Required parameter query_request was null or undefined when calling dryRunReportQueries.');
|
|
54525
|
+
}
|
|
54526
|
+
const localVarPath = `/datawarehouse/reports/dryrun`;
|
|
54527
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
54528
|
+
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
54529
|
+
const localVarHeaderParameter = {} as any;
|
|
54530
|
+
const localVarQueryParameter = {} as any;
|
|
54531
|
+
|
|
54532
|
+
if(configuration && configuration.apiVersion) {
|
|
54533
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
54534
|
+
}
|
|
54535
|
+
|
|
54536
|
+
|
|
54537
|
+
|
|
54538
|
+
// authentication ultraCartOauth required
|
|
54539
|
+
// oauth required
|
|
54540
|
+
if (configuration && configuration.accessToken) {
|
|
54541
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
54542
|
+
? configuration.accessToken("ultraCartOauth", [])
|
|
54543
|
+
: configuration.accessToken;
|
|
54544
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
54545
|
+
}
|
|
54546
|
+
|
|
54547
|
+
// authentication ultraCartSimpleApiKey required
|
|
54548
|
+
if (configuration && configuration.apiKey) {
|
|
54549
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
54550
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
54551
|
+
: configuration.apiKey;
|
|
54552
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
54553
|
+
}
|
|
54554
|
+
|
|
54555
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
54556
|
+
|
|
54557
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
54558
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
54559
|
+
delete localVarUrlObj.search;
|
|
54560
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
54561
|
+
const needsSerialization = (<any>"ReportDryRunQueriesRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
54562
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(query_request || {}) : (query_request || "");
|
|
54563
|
+
|
|
54564
|
+
return {
|
|
54565
|
+
url: url.format(localVarUrlObj),
|
|
54566
|
+
options: localVarRequestOptions,
|
|
54567
|
+
};
|
|
54568
|
+
},
|
|
54403
54569
|
/**
|
|
54404
54570
|
* Execute the report queries
|
|
54405
54571
|
* @summary Execute the report queries
|
|
@@ -54855,6 +55021,27 @@ export const DatawarehouseApiFp = function(configuration?: Configuration) {
|
|
|
54855
55021
|
});
|
|
54856
55022
|
};
|
|
54857
55023
|
},
|
|
55024
|
+
/**
|
|
55025
|
+
* Dry run the report queries
|
|
55026
|
+
* @summary Dry run the report queries
|
|
55027
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
55028
|
+
* @param {*} [options] Override http request option.
|
|
55029
|
+
* @throws {RequiredError}
|
|
55030
|
+
*/
|
|
55031
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ReportDryRunQueriesResponse> {
|
|
55032
|
+
const localVarFetchArgs = DatawarehouseApiFetchParamCreator(configuration).dryRunReportQueries(query_request, options);
|
|
55033
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
55034
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
55035
|
+
|
|
55036
|
+
if (response.status >= 200 && response.status < 300) {
|
|
55037
|
+
return response.json();
|
|
55038
|
+
|
|
55039
|
+
} else {
|
|
55040
|
+
throw response;
|
|
55041
|
+
}
|
|
55042
|
+
});
|
|
55043
|
+
};
|
|
55044
|
+
},
|
|
54858
55045
|
/**
|
|
54859
55046
|
* Execute the report queries
|
|
54860
55047
|
* @summary Execute the report queries
|
|
@@ -55042,6 +55229,16 @@ export const DatawarehouseApiFactory = function (configuration?: Configuration,
|
|
|
55042
55229
|
deleteReport(report_oid: number, options?: any) {
|
|
55043
55230
|
return DatawarehouseApiFp(configuration).deleteReport(report_oid, options)(fetch, basePath);
|
|
55044
55231
|
},
|
|
55232
|
+
/**
|
|
55233
|
+
* Dry run the report queries
|
|
55234
|
+
* @summary Dry run the report queries
|
|
55235
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
55236
|
+
* @param {*} [options] Override http request option.
|
|
55237
|
+
* @throws {RequiredError}
|
|
55238
|
+
*/
|
|
55239
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any) {
|
|
55240
|
+
return DatawarehouseApiFp(configuration).dryRunReportQueries(query_request, options)(fetch, basePath);
|
|
55241
|
+
},
|
|
55045
55242
|
/**
|
|
55046
55243
|
* Execute the report queries
|
|
55047
55244
|
* @summary Execute the report queries
|
|
@@ -55141,6 +55338,16 @@ export interface DatawarehouseApiInterface {
|
|
|
55141
55338
|
*/
|
|
55142
55339
|
deleteReport(report_oid: number, options?: any): Promise<{}>;
|
|
55143
55340
|
|
|
55341
|
+
/**
|
|
55342
|
+
* Dry run the report queries
|
|
55343
|
+
* @summary Dry run the report queries
|
|
55344
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
55345
|
+
* @param {*} [options] Override http request option.
|
|
55346
|
+
* @throws {RequiredError}
|
|
55347
|
+
* @memberof DatawarehouseApiInterface
|
|
55348
|
+
*/
|
|
55349
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
|
|
55350
|
+
|
|
55144
55351
|
/**
|
|
55145
55352
|
* Execute the report queries
|
|
55146
55353
|
* @summary Execute the report queries
|
|
@@ -55242,6 +55449,18 @@ export class DatawarehouseApi extends BaseAPI implements DatawarehouseApiInterfa
|
|
|
55242
55449
|
return DatawarehouseApiFp(this.configuration).deleteReport(report_oid, options)(this.fetch, this.basePath);
|
|
55243
55450
|
}
|
|
55244
55451
|
|
|
55452
|
+
/**
|
|
55453
|
+
* Dry run the report queries
|
|
55454
|
+
* @summary Dry run the report queries
|
|
55455
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
55456
|
+
* @param {*} [options] Override http request option.
|
|
55457
|
+
* @throws {RequiredError}
|
|
55458
|
+
* @memberof DatawarehouseApi
|
|
55459
|
+
*/
|
|
55460
|
+
public dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any) {
|
|
55461
|
+
return DatawarehouseApiFp(this.configuration).dryRunReportQueries(query_request, options)(this.fetch, this.basePath);
|
|
55462
|
+
}
|
|
55463
|
+
|
|
55245
55464
|
/**
|
|
55246
55465
|
* Execute the report queries
|
|
55247
55466
|
* @summary Execute the report queries
|
package/dist/api.d.ts
CHANGED
|
@@ -144,6 +144,12 @@ export interface AccountsReceivableRetryConfig {
|
|
|
144
144
|
* @memberof AccountsReceivableRetryConfig
|
|
145
145
|
*/
|
|
146
146
|
reject_at_end?: boolean;
|
|
147
|
+
/**
|
|
148
|
+
* Array of key/value pairs that when found in the response cause the rejection of the transaction.
|
|
149
|
+
* @type {Array<AccountsReceivableRetryTransactionReject>}
|
|
150
|
+
* @memberof AccountsReceivableRetryConfig
|
|
151
|
+
*/
|
|
152
|
+
transaction_rejects?: Array<AccountsReceivableRetryTransactionReject>;
|
|
147
153
|
/**
|
|
148
154
|
* True if the account is currently in trial mode. Set to false to exit trial mode.
|
|
149
155
|
* @type {boolean}
|
|
@@ -403,6 +409,25 @@ export interface AccountsReceivableRetryStatsResponse {
|
|
|
403
409
|
*/
|
|
404
410
|
warning?: Warning;
|
|
405
411
|
}
|
|
412
|
+
/**
|
|
413
|
+
*
|
|
414
|
+
* @export
|
|
415
|
+
* @interface AccountsReceivableRetryTransactionReject
|
|
416
|
+
*/
|
|
417
|
+
export interface AccountsReceivableRetryTransactionReject {
|
|
418
|
+
/**
|
|
419
|
+
* Transaction response name
|
|
420
|
+
* @type {string}
|
|
421
|
+
* @memberof AccountsReceivableRetryTransactionReject
|
|
422
|
+
*/
|
|
423
|
+
name?: string;
|
|
424
|
+
/**
|
|
425
|
+
* Transaction response value
|
|
426
|
+
* @type {string}
|
|
427
|
+
* @memberof AccountsReceivableRetryTransactionReject
|
|
428
|
+
*/
|
|
429
|
+
value?: string;
|
|
430
|
+
}
|
|
406
431
|
/**
|
|
407
432
|
*
|
|
408
433
|
* @export
|
|
@@ -19643,6 +19668,12 @@ export interface Experiment {
|
|
|
19643
19668
|
* @memberof Experiment
|
|
19644
19669
|
*/
|
|
19645
19670
|
optimization_type?: string;
|
|
19671
|
+
/**
|
|
19672
|
+
* Estimated sessions needed to achieve P95
|
|
19673
|
+
* @type {number}
|
|
19674
|
+
* @memberof Experiment
|
|
19675
|
+
*/
|
|
19676
|
+
p95_sessions_needed?: number;
|
|
19646
19677
|
/**
|
|
19647
19678
|
* Statistics p-value for the experiment
|
|
19648
19679
|
* @type {number}
|
|
@@ -30119,7 +30150,8 @@ export declare namespace OrderPayment {
|
|
|
30119
30150
|
Unknown,
|
|
30120
30151
|
WireTransfer,
|
|
30121
30152
|
Walmart,
|
|
30122
|
-
ShopCom
|
|
30153
|
+
ShopCom,
|
|
30154
|
+
Sezzle
|
|
30123
30155
|
}
|
|
30124
30156
|
/**
|
|
30125
30157
|
* @export
|
|
@@ -33295,6 +33327,81 @@ export declare namespace ReportDataSourceSchema {
|
|
|
33295
33327
|
TIMESTAMP
|
|
33296
33328
|
}
|
|
33297
33329
|
}
|
|
33330
|
+
/**
|
|
33331
|
+
*
|
|
33332
|
+
* @export
|
|
33333
|
+
* @interface ReportDryRunQueriesRequest
|
|
33334
|
+
*/
|
|
33335
|
+
export interface ReportDryRunQueriesRequest {
|
|
33336
|
+
/**
|
|
33337
|
+
*
|
|
33338
|
+
* @type {string}
|
|
33339
|
+
* @memberof ReportDryRunQueriesRequest
|
|
33340
|
+
*/
|
|
33341
|
+
connection_id?: string;
|
|
33342
|
+
/**
|
|
33343
|
+
*
|
|
33344
|
+
* @type {string}
|
|
33345
|
+
* @memberof ReportDryRunQueriesRequest
|
|
33346
|
+
*/
|
|
33347
|
+
default_dataset_id?: string;
|
|
33348
|
+
/**
|
|
33349
|
+
*
|
|
33350
|
+
* @type {string}
|
|
33351
|
+
* @memberof ReportDryRunQueriesRequest
|
|
33352
|
+
*/
|
|
33353
|
+
default_project_id?: string;
|
|
33354
|
+
/**
|
|
33355
|
+
*
|
|
33356
|
+
* @type {string}
|
|
33357
|
+
* @memberof ReportDryRunQueriesRequest
|
|
33358
|
+
*/
|
|
33359
|
+
merchant_id?: string;
|
|
33360
|
+
/**
|
|
33361
|
+
*
|
|
33362
|
+
* @type {Array<ReportDataSetQuery>}
|
|
33363
|
+
* @memberof ReportDryRunQueriesRequest
|
|
33364
|
+
*/
|
|
33365
|
+
queries?: Array<ReportDataSetQuery>;
|
|
33366
|
+
/**
|
|
33367
|
+
*
|
|
33368
|
+
* @type {string}
|
|
33369
|
+
* @memberof ReportDryRunQueriesRequest
|
|
33370
|
+
*/
|
|
33371
|
+
security_level?: string;
|
|
33372
|
+
}
|
|
33373
|
+
/**
|
|
33374
|
+
*
|
|
33375
|
+
* @export
|
|
33376
|
+
* @interface ReportDryRunQueriesResponse
|
|
33377
|
+
*/
|
|
33378
|
+
export interface ReportDryRunQueriesResponse {
|
|
33379
|
+
/**
|
|
33380
|
+
*
|
|
33381
|
+
* @type {Array<ReportDryRunQueryResult>}
|
|
33382
|
+
* @memberof ReportDryRunQueriesResponse
|
|
33383
|
+
*/
|
|
33384
|
+
dry_run_query_results?: Array<ReportDryRunQueryResult>;
|
|
33385
|
+
}
|
|
33386
|
+
/**
|
|
33387
|
+
*
|
|
33388
|
+
* @export
|
|
33389
|
+
* @interface ReportDryRunQueryResult
|
|
33390
|
+
*/
|
|
33391
|
+
export interface ReportDryRunQueryResult {
|
|
33392
|
+
/**
|
|
33393
|
+
*
|
|
33394
|
+
* @type {string}
|
|
33395
|
+
* @memberof ReportDryRunQueryResult
|
|
33396
|
+
*/
|
|
33397
|
+
error_message?: string;
|
|
33398
|
+
/**
|
|
33399
|
+
*
|
|
33400
|
+
* @type {number}
|
|
33401
|
+
* @memberof ReportDryRunQueryResult
|
|
33402
|
+
*/
|
|
33403
|
+
total_bytes_processed?: number;
|
|
33404
|
+
}
|
|
33298
33405
|
/**
|
|
33299
33406
|
*
|
|
33300
33407
|
* @export
|
|
@@ -45082,6 +45189,14 @@ export declare const DatawarehouseApiFetchParamCreator: (configuration?: Configu
|
|
|
45082
45189
|
* @throws {RequiredError}
|
|
45083
45190
|
*/
|
|
45084
45191
|
deleteReport(report_oid: number, options?: any): FetchArgs;
|
|
45192
|
+
/**
|
|
45193
|
+
* Dry run the report queries
|
|
45194
|
+
* @summary Dry run the report queries
|
|
45195
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
45196
|
+
* @param {*} [options] Override http request option.
|
|
45197
|
+
* @throws {RequiredError}
|
|
45198
|
+
*/
|
|
45199
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): FetchArgs;
|
|
45085
45200
|
/**
|
|
45086
45201
|
* Execute the report queries
|
|
45087
45202
|
* @summary Execute the report queries
|
|
@@ -45160,6 +45275,14 @@ export declare const DatawarehouseApiFp: (configuration?: Configuration) => {
|
|
|
45160
45275
|
* @throws {RequiredError}
|
|
45161
45276
|
*/
|
|
45162
45277
|
deleteReport(report_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
|
|
45278
|
+
/**
|
|
45279
|
+
* Dry run the report queries
|
|
45280
|
+
* @summary Dry run the report queries
|
|
45281
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
45282
|
+
* @param {*} [options] Override http request option.
|
|
45283
|
+
* @throws {RequiredError}
|
|
45284
|
+
*/
|
|
45285
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ReportDryRunQueriesResponse>;
|
|
45163
45286
|
/**
|
|
45164
45287
|
* Execute the report queries
|
|
45165
45288
|
* @summary Execute the report queries
|
|
@@ -45238,6 +45361,14 @@ export declare const DatawarehouseApiFactory: (configuration?: Configuration, fe
|
|
|
45238
45361
|
* @throws {RequiredError}
|
|
45239
45362
|
*/
|
|
45240
45363
|
deleteReport(report_oid: number, options?: any): Promise<Response>;
|
|
45364
|
+
/**
|
|
45365
|
+
* Dry run the report queries
|
|
45366
|
+
* @summary Dry run the report queries
|
|
45367
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
45368
|
+
* @param {*} [options] Override http request option.
|
|
45369
|
+
* @throws {RequiredError}
|
|
45370
|
+
*/
|
|
45371
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
|
|
45241
45372
|
/**
|
|
45242
45373
|
* Execute the report queries
|
|
45243
45374
|
* @summary Execute the report queries
|
|
@@ -45318,6 +45449,15 @@ export interface DatawarehouseApiInterface {
|
|
|
45318
45449
|
* @memberof DatawarehouseApiInterface
|
|
45319
45450
|
*/
|
|
45320
45451
|
deleteReport(report_oid: number, options?: any): Promise<{}>;
|
|
45452
|
+
/**
|
|
45453
|
+
* Dry run the report queries
|
|
45454
|
+
* @summary Dry run the report queries
|
|
45455
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
45456
|
+
* @param {*} [options] Override http request option.
|
|
45457
|
+
* @throws {RequiredError}
|
|
45458
|
+
* @memberof DatawarehouseApiInterface
|
|
45459
|
+
*/
|
|
45460
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
|
|
45321
45461
|
/**
|
|
45322
45462
|
* Execute the report queries
|
|
45323
45463
|
* @summary Execute the report queries
|
|
@@ -45407,6 +45547,15 @@ export declare class DatawarehouseApi extends BaseAPI implements DatawarehouseAp
|
|
|
45407
45547
|
* @memberof DatawarehouseApi
|
|
45408
45548
|
*/
|
|
45409
45549
|
deleteReport(report_oid: number, options?: any): Promise<Response>;
|
|
45550
|
+
/**
|
|
45551
|
+
* Dry run the report queries
|
|
45552
|
+
* @summary Dry run the report queries
|
|
45553
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
45554
|
+
* @param {*} [options] Override http request option.
|
|
45555
|
+
* @throws {RequiredError}
|
|
45556
|
+
* @memberof DatawarehouseApi
|
|
45557
|
+
*/
|
|
45558
|
+
dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
|
|
45410
45559
|
/**
|
|
45411
45560
|
* Execute the report queries
|
|
45412
45561
|
* @summary Execute the report queries
|
package/dist/api.js
CHANGED
|
@@ -1142,6 +1142,7 @@ var OrderPayment;
|
|
|
1142
1142
|
PaymentMethodEnum[PaymentMethodEnum["WireTransfer"] = 'Wire Transfer'] = "WireTransfer";
|
|
1143
1143
|
PaymentMethodEnum[PaymentMethodEnum["Walmart"] = 'Walmart'] = "Walmart";
|
|
1144
1144
|
PaymentMethodEnum[PaymentMethodEnum["ShopCom"] = 'Shop.com'] = "ShopCom";
|
|
1145
|
+
PaymentMethodEnum[PaymentMethodEnum["Sezzle"] = 'Sezzle'] = "Sezzle";
|
|
1145
1146
|
})(PaymentMethodEnum = OrderPayment.PaymentMethodEnum || (OrderPayment.PaymentMethodEnum = {}));
|
|
1146
1147
|
/**
|
|
1147
1148
|
* @export
|
|
@@ -13659,6 +13660,54 @@ var DatawarehouseApiFetchParamCreator = function (configuration) {
|
|
|
13659
13660
|
options: localVarRequestOptions,
|
|
13660
13661
|
};
|
|
13661
13662
|
},
|
|
13663
|
+
/**
|
|
13664
|
+
* Dry run the report queries
|
|
13665
|
+
* @summary Dry run the report queries
|
|
13666
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
13667
|
+
* @param {*} [options] Override http request option.
|
|
13668
|
+
* @throws {RequiredError}
|
|
13669
|
+
*/
|
|
13670
|
+
dryRunReportQueries: function (query_request, options) {
|
|
13671
|
+
if (options === void 0) { options = {}; }
|
|
13672
|
+
// verify required parameter 'query_request' is not null or undefined
|
|
13673
|
+
if (query_request === null || query_request === undefined) {
|
|
13674
|
+
throw new RequiredError('query_request', 'Required parameter query_request was null or undefined when calling dryRunReportQueries.');
|
|
13675
|
+
}
|
|
13676
|
+
var localVarPath = "/datawarehouse/reports/dryrun";
|
|
13677
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
13678
|
+
var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
13679
|
+
var localVarHeaderParameter = {};
|
|
13680
|
+
var localVarQueryParameter = {};
|
|
13681
|
+
if (configuration && configuration.apiVersion) {
|
|
13682
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
13683
|
+
}
|
|
13684
|
+
// authentication ultraCartOauth required
|
|
13685
|
+
// oauth required
|
|
13686
|
+
if (configuration && configuration.accessToken) {
|
|
13687
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
13688
|
+
? configuration.accessToken("ultraCartOauth", [])
|
|
13689
|
+
: configuration.accessToken;
|
|
13690
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
13691
|
+
}
|
|
13692
|
+
// authentication ultraCartSimpleApiKey required
|
|
13693
|
+
if (configuration && configuration.apiKey) {
|
|
13694
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
13695
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
13696
|
+
: configuration.apiKey;
|
|
13697
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
13698
|
+
}
|
|
13699
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
13700
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
13701
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
13702
|
+
delete localVarUrlObj.search;
|
|
13703
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
13704
|
+
var needsSerialization = ("ReportDryRunQueriesRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
13705
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(query_request || {}) : (query_request || "");
|
|
13706
|
+
return {
|
|
13707
|
+
url: url.format(localVarUrlObj),
|
|
13708
|
+
options: localVarRequestOptions,
|
|
13709
|
+
};
|
|
13710
|
+
},
|
|
13662
13711
|
/**
|
|
13663
13712
|
* Execute the report queries
|
|
13664
13713
|
* @summary Execute the report queries
|
|
@@ -14064,6 +14113,28 @@ var DatawarehouseApiFp = function (configuration) {
|
|
|
14064
14113
|
});
|
|
14065
14114
|
};
|
|
14066
14115
|
},
|
|
14116
|
+
/**
|
|
14117
|
+
* Dry run the report queries
|
|
14118
|
+
* @summary Dry run the report queries
|
|
14119
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
14120
|
+
* @param {*} [options] Override http request option.
|
|
14121
|
+
* @throws {RequiredError}
|
|
14122
|
+
*/
|
|
14123
|
+
dryRunReportQueries: function (query_request, options) {
|
|
14124
|
+
var localVarFetchArgs = (0, exports.DatawarehouseApiFetchParamCreator)(configuration).dryRunReportQueries(query_request, options);
|
|
14125
|
+
return function (fetch, basePath) {
|
|
14126
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
14127
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
14128
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
14129
|
+
if (response.status >= 200 && response.status < 300) {
|
|
14130
|
+
return response.json();
|
|
14131
|
+
}
|
|
14132
|
+
else {
|
|
14133
|
+
throw response;
|
|
14134
|
+
}
|
|
14135
|
+
});
|
|
14136
|
+
};
|
|
14137
|
+
},
|
|
14067
14138
|
/**
|
|
14068
14139
|
* Execute the report queries
|
|
14069
14140
|
* @summary Execute the report queries
|
|
@@ -14259,6 +14330,16 @@ var DatawarehouseApiFactory = function (configuration, fetch, basePath) {
|
|
|
14259
14330
|
deleteReport: function (report_oid, options) {
|
|
14260
14331
|
return (0, exports.DatawarehouseApiFp)(configuration).deleteReport(report_oid, options)(fetch, basePath);
|
|
14261
14332
|
},
|
|
14333
|
+
/**
|
|
14334
|
+
* Dry run the report queries
|
|
14335
|
+
* @summary Dry run the report queries
|
|
14336
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
14337
|
+
* @param {*} [options] Override http request option.
|
|
14338
|
+
* @throws {RequiredError}
|
|
14339
|
+
*/
|
|
14340
|
+
dryRunReportQueries: function (query_request, options) {
|
|
14341
|
+
return (0, exports.DatawarehouseApiFp)(configuration).dryRunReportQueries(query_request, options)(fetch, basePath);
|
|
14342
|
+
},
|
|
14262
14343
|
/**
|
|
14263
14344
|
* Execute the report queries
|
|
14264
14345
|
* @summary Execute the report queries
|
|
@@ -14364,6 +14445,17 @@ var DatawarehouseApi = /** @class */ (function (_super) {
|
|
|
14364
14445
|
DatawarehouseApi.prototype.deleteReport = function (report_oid, options) {
|
|
14365
14446
|
return (0, exports.DatawarehouseApiFp)(this.configuration).deleteReport(report_oid, options)(this.fetch, this.basePath);
|
|
14366
14447
|
};
|
|
14448
|
+
/**
|
|
14449
|
+
* Dry run the report queries
|
|
14450
|
+
* @summary Dry run the report queries
|
|
14451
|
+
* @param {ReportDryRunQueriesRequest} query_request Dry run request
|
|
14452
|
+
* @param {*} [options] Override http request option.
|
|
14453
|
+
* @throws {RequiredError}
|
|
14454
|
+
* @memberof DatawarehouseApi
|
|
14455
|
+
*/
|
|
14456
|
+
DatawarehouseApi.prototype.dryRunReportQueries = function (query_request, options) {
|
|
14457
|
+
return (0, exports.DatawarehouseApiFp)(this.configuration).dryRunReportQueries(query_request, options)(this.fetch, this.basePath);
|
|
14458
|
+
};
|
|
14367
14459
|
/**
|
|
14368
14460
|
* Execute the report queries
|
|
14369
14461
|
* @summary Execute the report queries
|