ultracart_rest_api_v2_typescript 4.0.144 → 4.0.145

package/.openapi-generator/FILES

@@ -31,6 +31,7 @@ src/models/AccountsReceivableRetryStatAccount.ts
 src/models/AccountsReceivableRetryStatMetrics.ts
 src/models/AccountsReceivableRetryStatRevenue.ts
 src/models/AccountsReceivableRetryStatsResponse.ts
+src/models/AccountsReceivableRetryTransactionReject.ts
 src/models/Activity.ts
 src/models/AddLibraryItemRequest.ts
 src/models/AdjustInternalCertificateRequest.ts
@@ -660,6 +661,9 @@ src/models/ReportDataSetRow.ts
 src/models/ReportDataSetSchema.ts
 src/models/ReportDataSource.ts
 src/models/ReportDataSourceSchema.ts
+src/models/ReportDryRunQueriesRequest.ts
+src/models/ReportDryRunQueriesResponse.ts
+src/models/ReportDryRunQueryResult.ts
 src/models/ReportExecuteQueriesRequest.ts
 src/models/ReportFilter.ts
 src/models/ReportFilterConnection.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.144
+## ultracart_rest_api_v2_typescript@4.0.145
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.144 --save
+npm install ultracart_rest_api_v2_typescript@4.0.145 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.145 | 04/10/2023 | data warehouse internal dev |
 | 4.0.144 | 03/29/2023 | internal development |
 | 4.0.143 | 03/22/2023 | data warehouse internal dev |
 | 4.0.142 | 03/22/2023 | dw initial framework |

package/dist/apis/DatawarehouseApi.d.ts

@@ -10,10 +10,13 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
+import { Report, ReportAuthResponse, ReportDataSetPageResponse, ReportDataSetResponse, ReportDryRunQueriesRequest, ReportDryRunQueriesResponse, ReportExecuteQueriesRequest, ReportResponse, ReportsResponse } from '../models';
 export interface DeleteReportRequest {
     reportOid: number;
 }
+export interface DryRunReportQueriesRequest {
+    queryRequest: ReportDryRunQueriesRequest;
+}
 export interface ExecuteReportQueriesRequest {
     queryRequest: ReportExecuteQueriesRequest;
 }
@@ -55,6 +58,20 @@ export interface DatawarehouseApiInterface {
      * Delete a report
      */
     deleteReport(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Dry run the report queries
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} queryRequest Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    dryRunReportQueriesRaw(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportDryRunQueriesResponse>>;
+    /**
+     * Dry run the report queries
+     * Dry run the report queries
+     */
+    dryRunReportQueries(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDryRunQueriesResponse>;
     /**
      * Execute the report queries
      * @summary Execute the report queries
@@ -182,6 +199,16 @@ export declare class DatawarehouseApi extends runtime.BaseAPI implements Datawar
      * Delete a report
      */
     deleteReport(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Dry run the report queries
+     * Dry run the report queries
+     */
+    dryRunReportQueriesRaw(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportDryRunQueriesResponse>>;
+    /**
+     * Dry run the report queries
+     * Dry run the report queries
+     */
+    dryRunReportQueries(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDryRunQueriesResponse>;
     /**
      * Execute the report queries
      * Execute the report queries

package/dist/apis/DatawarehouseApi.js

@@ -132,6 +132,67 @@ var DatawarehouseApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Dry run the report queries
+     * Dry run the report queries
+     */
+    DatawarehouseApi.prototype.dryRunReportQueriesRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.queryRequest === null || requestParameters.queryRequest === undefined) {
+                            throw new runtime.RequiredError('queryRequest', 'Required parameter requestParameters.queryRequest was null or undefined when calling dryRunReportQueries.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/datawarehouse/reports/dryrun",
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ReportDryRunQueriesRequestToJSON)(requestParameters.queryRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ReportDryRunQueriesResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Dry run the report queries
+     * Dry run the report queries
+     */
+    DatawarehouseApi.prototype.dryRunReportQueries = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.dryRunReportQueriesRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Execute the report queries
      * Execute the report queries

package/dist/models/AccountsReceivableRetryConfig.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { AccountsReceivableRetryDayActivity } from './AccountsReceivableRetryDayActivity';
+import { AccountsReceivableRetryTransactionReject } from './AccountsReceivableRetryTransactionReject';
 /**
  *
  * @export
@@ -94,6 +95,12 @@ export interface AccountsReceivableRetryConfig {
      * @memberof AccountsReceivableRetryConfig
      */
     reject_at_end?: boolean;
+    /**
+     * Array of key/value pairs that when found in the response cause the rejection of the transaction.
+     * @type {Array<AccountsReceivableRetryTransactionReject>}
+     * @memberof AccountsReceivableRetryConfig
+     */
+    transaction_rejects?: Array<AccountsReceivableRetryTransactionReject>;
     /**
      * True if the account is currently in trial mode.  Set to false to exit trial mode.
      * @type {boolean}

package/dist/models/AccountsReceivableRetryConfig.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccountsReceivableRetryConfigToJSON = exports.AccountsReceivableRetryConfigFromJSONTyped = exports.AccountsReceivableRetryConfigFromJSON = void 0;
 var runtime_1 = require("../runtime");
 var AccountsReceivableRetryDayActivity_1 = require("./AccountsReceivableRetryDayActivity");
+var AccountsReceivableRetryTransactionReject_1 = require("./AccountsReceivableRetryTransactionReject");
 function AccountsReceivableRetryConfigFromJSON(json) {
     return AccountsReceivableRetryConfigFromJSONTyped(json, false);
 }
@@ -38,6 +39,7 @@ function AccountsReceivableRetryConfigFromJSONTyped(json, ignoreDiscriminator) {
         'process_linked_accounts': !(0, runtime_1.exists)(json, 'process_linked_accounts') ? undefined : json['process_linked_accounts'],
         'processing_percentage': !(0, runtime_1.exists)(json, 'processing_percentage') ? undefined : json['processing_percentage'],
         'reject_at_end': !(0, runtime_1.exists)(json, 'reject_at_end') ? undefined : json['reject_at_end'],
+        'transaction_rejects': !(0, runtime_1.exists)(json, 'transaction_rejects') ? undefined : (json['transaction_rejects'].map(AccountsReceivableRetryTransactionReject_1.AccountsReceivableRetryTransactionRejectFromJSON)),
         'trial_mode': !(0, runtime_1.exists)(json, 'trial_mode') ? undefined : json['trial_mode'],
         'trial_mode_expiration_dts': !(0, runtime_1.exists)(json, 'trial_mode_expiration_dts') ? undefined : json['trial_mode_expiration_dts'],
     };
@@ -64,6 +66,7 @@ function AccountsReceivableRetryConfigToJSON(value) {
         'process_linked_accounts': value.process_linked_accounts,
         'processing_percentage': value.processing_percentage,
         'reject_at_end': value.reject_at_end,
+        'transaction_rejects': value.transaction_rejects === undefined ? undefined : (value.transaction_rejects.map(AccountsReceivableRetryTransactionReject_1.AccountsReceivableRetryTransactionRejectToJSON)),
         'trial_mode': value.trial_mode,
         'trial_mode_expiration_dts': value.trial_mode_expiration_dts,
     };

package/dist/models/AccountsReceivableRetryTransactionReject.d.ts

@@ -0,0 +1,33 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AccountsReceivableRetryTransactionReject
+ */
+export interface AccountsReceivableRetryTransactionReject {
+    /**
+     * Transaction response name
+     * @type {string}
+     * @memberof AccountsReceivableRetryTransactionReject
+     */
+    name?: string;
+    /**
+     * Transaction response value
+     * @type {string}
+     * @memberof AccountsReceivableRetryTransactionReject
+     */
+    value?: string;
+}
+export declare function AccountsReceivableRetryTransactionRejectFromJSON(json: any): AccountsReceivableRetryTransactionReject;
+export declare function AccountsReceivableRetryTransactionRejectFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountsReceivableRetryTransactionReject;
+export declare function AccountsReceivableRetryTransactionRejectToJSON(value?: AccountsReceivableRetryTransactionReject | null): any;

package/dist/models/AccountsReceivableRetryTransactionReject.js

@@ -0,0 +1,44 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountsReceivableRetryTransactionRejectToJSON = exports.AccountsReceivableRetryTransactionRejectFromJSONTyped = exports.AccountsReceivableRetryTransactionRejectFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function AccountsReceivableRetryTransactionRejectFromJSON(json) {
+    return AccountsReceivableRetryTransactionRejectFromJSONTyped(json, false);
+}
+exports.AccountsReceivableRetryTransactionRejectFromJSON = AccountsReceivableRetryTransactionRejectFromJSON;
+function AccountsReceivableRetryTransactionRejectFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
+    };
+}
+exports.AccountsReceivableRetryTransactionRejectFromJSONTyped = AccountsReceivableRetryTransactionRejectFromJSONTyped;
+function AccountsReceivableRetryTransactionRejectToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'value': value.value,
+    };
+}
+exports.AccountsReceivableRetryTransactionRejectToJSON = AccountsReceivableRetryTransactionRejectToJSON;

package/dist/models/ReportDryRunQueriesRequest.d.ts

@@ -0,0 +1,58 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ReportDataSetQuery } from './ReportDataSetQuery';
+/**
+ *
+ * @export
+ * @interface ReportDryRunQueriesRequest
+ */
+export interface ReportDryRunQueriesRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    connection_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    default_dataset_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    default_project_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    merchant_id?: string;
+    /**
+     *
+     * @type {Array<ReportDataSetQuery>}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    queries?: Array<ReportDataSetQuery>;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    security_level?: string;
+}
+export declare function ReportDryRunQueriesRequestFromJSON(json: any): ReportDryRunQueriesRequest;
+export declare function ReportDryRunQueriesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDryRunQueriesRequest;
+export declare function ReportDryRunQueriesRequestToJSON(value?: ReportDryRunQueriesRequest | null): any;

package/dist/models/ReportDryRunQueriesRequest.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportDryRunQueriesRequestToJSON = exports.ReportDryRunQueriesRequestFromJSONTyped = exports.ReportDryRunQueriesRequestFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ReportDataSetQuery_1 = require("./ReportDataSetQuery");
+function ReportDryRunQueriesRequestFromJSON(json) {
+    return ReportDryRunQueriesRequestFromJSONTyped(json, false);
+}
+exports.ReportDryRunQueriesRequestFromJSON = ReportDryRunQueriesRequestFromJSON;
+function ReportDryRunQueriesRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'connection_id': !(0, runtime_1.exists)(json, 'connection_id') ? undefined : json['connection_id'],
+        'default_dataset_id': !(0, runtime_1.exists)(json, 'default_dataset_id') ? undefined : json['default_dataset_id'],
+        'default_project_id': !(0, runtime_1.exists)(json, 'default_project_id') ? undefined : json['default_project_id'],
+        'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'queries': !(0, runtime_1.exists)(json, 'queries') ? undefined : (json['queries'].map(ReportDataSetQuery_1.ReportDataSetQueryFromJSON)),
+        'security_level': !(0, runtime_1.exists)(json, 'security_level') ? undefined : json['security_level'],
+    };
+}
+exports.ReportDryRunQueriesRequestFromJSONTyped = ReportDryRunQueriesRequestFromJSONTyped;
+function ReportDryRunQueriesRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'connection_id': value.connection_id,
+        'default_dataset_id': value.default_dataset_id,
+        'default_project_id': value.default_project_id,
+        'merchant_id': value.merchant_id,
+        'queries': value.queries === undefined ? undefined : (value.queries.map(ReportDataSetQuery_1.ReportDataSetQueryToJSON)),
+        'security_level': value.security_level,
+    };
+}
+exports.ReportDryRunQueriesRequestToJSON = ReportDryRunQueriesRequestToJSON;

package/dist/models/ReportDryRunQueriesResponse.d.ts

@@ -0,0 +1,28 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ReportDryRunQueryResult } from './ReportDryRunQueryResult';
+/**
+ *
+ * @export
+ * @interface ReportDryRunQueriesResponse
+ */
+export interface ReportDryRunQueriesResponse {
+    /**
+     *
+     * @type {Array<ReportDryRunQueryResult>}
+     * @memberof ReportDryRunQueriesResponse
+     */
+    dry_run_query_results?: Array<ReportDryRunQueryResult>;
+}
+export declare function ReportDryRunQueriesResponseFromJSON(json: any): ReportDryRunQueriesResponse;
+export declare function ReportDryRunQueriesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDryRunQueriesResponse;
+export declare function ReportDryRunQueriesResponseToJSON(value?: ReportDryRunQueriesResponse | null): any;

package/dist/models/ReportDryRunQueriesResponse.js

@@ -0,0 +1,43 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportDryRunQueriesResponseToJSON = exports.ReportDryRunQueriesResponseFromJSONTyped = exports.ReportDryRunQueriesResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ReportDryRunQueryResult_1 = require("./ReportDryRunQueryResult");
+function ReportDryRunQueriesResponseFromJSON(json) {
+    return ReportDryRunQueriesResponseFromJSONTyped(json, false);
+}
+exports.ReportDryRunQueriesResponseFromJSON = ReportDryRunQueriesResponseFromJSON;
+function ReportDryRunQueriesResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'dry_run_query_results': !(0, runtime_1.exists)(json, 'dry_run_query_results') ? undefined : (json['dry_run_query_results'].map(ReportDryRunQueryResult_1.ReportDryRunQueryResultFromJSON)),
+    };
+}
+exports.ReportDryRunQueriesResponseFromJSONTyped = ReportDryRunQueriesResponseFromJSONTyped;
+function ReportDryRunQueriesResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'dry_run_query_results': value.dry_run_query_results === undefined ? undefined : (value.dry_run_query_results.map(ReportDryRunQueryResult_1.ReportDryRunQueryResultToJSON)),
+    };
+}
+exports.ReportDryRunQueriesResponseToJSON = ReportDryRunQueriesResponseToJSON;

package/dist/models/ReportDryRunQueryResult.d.ts

@@ -0,0 +1,33 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ReportDryRunQueryResult
+ */
+export interface ReportDryRunQueryResult {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDryRunQueryResult
+     */
+    error_message?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ReportDryRunQueryResult
+     */
+    total_bytes_processed?: number;
+}
+export declare function ReportDryRunQueryResultFromJSON(json: any): ReportDryRunQueryResult;
+export declare function ReportDryRunQueryResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDryRunQueryResult;
+export declare function ReportDryRunQueryResultToJSON(value?: ReportDryRunQueryResult | null): any;

package/dist/models/ReportDryRunQueryResult.js

@@ -0,0 +1,44 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportDryRunQueryResultToJSON = exports.ReportDryRunQueryResultFromJSONTyped = exports.ReportDryRunQueryResultFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function ReportDryRunQueryResultFromJSON(json) {
+    return ReportDryRunQueryResultFromJSONTyped(json, false);
+}
+exports.ReportDryRunQueryResultFromJSON = ReportDryRunQueryResultFromJSON;
+function ReportDryRunQueryResultFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error_message': !(0, runtime_1.exists)(json, 'error_message') ? undefined : json['error_message'],
+        'total_bytes_processed': !(0, runtime_1.exists)(json, 'total_bytes_processed') ? undefined : json['total_bytes_processed'],
+    };
+}
+exports.ReportDryRunQueryResultFromJSONTyped = ReportDryRunQueryResultFromJSONTyped;
+function ReportDryRunQueryResultToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error_message': value.error_message,
+        'total_bytes_processed': value.total_bytes_processed,
+    };
+}
+exports.ReportDryRunQueryResultToJSON = ReportDryRunQueryResultToJSON;

package/dist/models/index.d.ts

@@ -5,6 +5,7 @@ export * from './AccountsReceivableRetryStatAccount';
 export * from './AccountsReceivableRetryStatMetrics';
 export * from './AccountsReceivableRetryStatRevenue';
 export * from './AccountsReceivableRetryStatsResponse';
+export * from './AccountsReceivableRetryTransactionReject';
 export * from './Activity';
 export * from './AddLibraryItemRequest';
 export * from './AdjustInternalCertificateRequest';
@@ -634,6 +635,9 @@ export * from './ReportDataSetRow';
 export * from './ReportDataSetSchema';
 export * from './ReportDataSource';
 export * from './ReportDataSourceSchema';
+export * from './ReportDryRunQueriesRequest';
+export * from './ReportDryRunQueriesResponse';
+export * from './ReportDryRunQueryResult';
 export * from './ReportExecuteQueriesRequest';
 export * from './ReportFilter';
 export * from './ReportFilterConnection';

package/dist/models/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./AccountsReceivableRetryStatAccount"), exports);
 __exportStar(require("./AccountsReceivableRetryStatMetrics"), exports);
 __exportStar(require("./AccountsReceivableRetryStatRevenue"), exports);
 __exportStar(require("./AccountsReceivableRetryStatsResponse"), exports);
+__exportStar(require("./AccountsReceivableRetryTransactionReject"), exports);
 __exportStar(require("./Activity"), exports);
 __exportStar(require("./AddLibraryItemRequest"), exports);
 __exportStar(require("./AdjustInternalCertificateRequest"), exports);
@@ -652,6 +653,9 @@ __exportStar(require("./ReportDataSetRow"), exports);
 __exportStar(require("./ReportDataSetSchema"), exports);
 __exportStar(require("./ReportDataSource"), exports);
 __exportStar(require("./ReportDataSourceSchema"), exports);
+__exportStar(require("./ReportDryRunQueriesRequest"), exports);
+__exportStar(require("./ReportDryRunQueriesResponse"), exports);
+__exportStar(require("./ReportDryRunQueryResult"), exports);
 __exportStar(require("./ReportExecuteQueriesRequest"), exports);
 __exportStar(require("./ReportFilter"), exports);
 __exportStar(require("./ReportFilterConnection"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.144",
+  "version": "4.0.145",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/DatawarehouseApi.ts

@@ -30,6 +30,12 @@ import {
     ReportDataSetResponse,
     ReportDataSetResponseFromJSON,
     ReportDataSetResponseToJSON,
+    ReportDryRunQueriesRequest,
+    ReportDryRunQueriesRequestFromJSON,
+    ReportDryRunQueriesRequestToJSON,
+    ReportDryRunQueriesResponse,
+    ReportDryRunQueriesResponseFromJSON,
+    ReportDryRunQueriesResponseToJSON,
     ReportExecuteQueriesRequest,
     ReportExecuteQueriesRequestFromJSON,
     ReportExecuteQueriesRequestToJSON,
@@ -45,6 +51,10 @@ export interface DeleteReportRequest {
     reportOid: number;
 }
 
+export interface DryRunReportQueriesRequest {
+    queryRequest: ReportDryRunQueriesRequest;
+}
+
 export interface ExecuteReportQueriesRequest {
     queryRequest: ReportExecuteQueriesRequest;
 }
@@ -94,6 +104,22 @@ export interface DatawarehouseApiInterface {
      */
     deleteReport(requestParameters: DeleteReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Dry run the report queries 
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} queryRequest Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    dryRunReportQueriesRaw(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportDryRunQueriesResponse>>;
+
+    /**
+     * Dry run the report queries 
+     * Dry run the report queries
+     */
+    dryRunReportQueries(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDryRunQueriesResponse>;
+
     /**
      * Execute the report queries 
      * @summary Execute the report queries
@@ -269,6 +295,50 @@ export class DatawarehouseApi extends runtime.BaseAPI implements DatawarehouseAp
         await this.deleteReportRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Dry run the report queries 
+     * Dry run the report queries
+     */
+    async dryRunReportQueriesRaw(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReportDryRunQueriesResponse>> {
+        if (requestParameters.queryRequest === null || requestParameters.queryRequest === undefined) {
+            throw new runtime.RequiredError('queryRequest','Required parameter requestParameters.queryRequest was null or undefined when calling dryRunReportQueries.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/datawarehouse/reports/dryrun`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ReportDryRunQueriesRequestToJSON(requestParameters.queryRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReportDryRunQueriesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Dry run the report queries 
+     * Dry run the report queries
+     */
+    async dryRunReportQueries(requestParameters: DryRunReportQueriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReportDryRunQueriesResponse> {
+        const response = await this.dryRunReportQueriesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Execute the report queries 
      * Execute the report queries

package/src/models/AccountsReceivableRetryConfig.ts

@@ -19,6 +19,12 @@ import {
     AccountsReceivableRetryDayActivityFromJSONTyped,
     AccountsReceivableRetryDayActivityToJSON,
 } from './AccountsReceivableRetryDayActivity';
+import {
+    AccountsReceivableRetryTransactionReject,
+    AccountsReceivableRetryTransactionRejectFromJSON,
+    AccountsReceivableRetryTransactionRejectFromJSONTyped,
+    AccountsReceivableRetryTransactionRejectToJSON,
+} from './AccountsReceivableRetryTransactionReject';
 
 /**
  * 
@@ -104,6 +110,12 @@ export interface AccountsReceivableRetryConfig {
      * @memberof AccountsReceivableRetryConfig
      */
     reject_at_end?: boolean;
+    /**
+     * Array of key/value pairs that when found in the response cause the rejection of the transaction.
+     * @type {Array<AccountsReceivableRetryTransactionReject>}
+     * @memberof AccountsReceivableRetryConfig
+     */
+    transaction_rejects?: Array<AccountsReceivableRetryTransactionReject>;
     /**
      * True if the account is currently in trial mode.  Set to false to exit trial mode.
      * @type {boolean}
@@ -141,6 +153,7 @@ export function AccountsReceivableRetryConfigFromJSONTyped(json: any, ignoreDisc
         'process_linked_accounts': !exists(json, 'process_linked_accounts') ? undefined : json['process_linked_accounts'],
         'processing_percentage': !exists(json, 'processing_percentage') ? undefined : json['processing_percentage'],
         'reject_at_end': !exists(json, 'reject_at_end') ? undefined : json['reject_at_end'],
+        'transaction_rejects': !exists(json, 'transaction_rejects') ? undefined : ((json['transaction_rejects'] as Array<any>).map(AccountsReceivableRetryTransactionRejectFromJSON)),
         'trial_mode': !exists(json, 'trial_mode') ? undefined : json['trial_mode'],
         'trial_mode_expiration_dts': !exists(json, 'trial_mode_expiration_dts') ? undefined : json['trial_mode_expiration_dts'],
     };
@@ -168,6 +181,7 @@ export function AccountsReceivableRetryConfigToJSON(value?: AccountsReceivableRe
         'process_linked_accounts': value.process_linked_accounts,
         'processing_percentage': value.processing_percentage,
         'reject_at_end': value.reject_at_end,
+        'transaction_rejects': value.transaction_rejects === undefined ? undefined : ((value.transaction_rejects as Array<any>).map(AccountsReceivableRetryTransactionRejectToJSON)),
         'trial_mode': value.trial_mode,
         'trial_mode_expiration_dts': value.trial_mode_expiration_dts,
     };

package/src/models/AccountsReceivableRetryTransactionReject.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AccountsReceivableRetryTransactionReject
+ */
+export interface AccountsReceivableRetryTransactionReject {
+    /**
+     * Transaction response name
+     * @type {string}
+     * @memberof AccountsReceivableRetryTransactionReject
+     */
+    name?: string;
+    /**
+     * Transaction response value
+     * @type {string}
+     * @memberof AccountsReceivableRetryTransactionReject
+     */
+    value?: string;
+}
+
+export function AccountsReceivableRetryTransactionRejectFromJSON(json: any): AccountsReceivableRetryTransactionReject {
+    return AccountsReceivableRetryTransactionRejectFromJSONTyped(json, false);
+}
+
+export function AccountsReceivableRetryTransactionRejectFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountsReceivableRetryTransactionReject {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'value': !exists(json, 'value') ? undefined : json['value'],
+    };
+}
+
+export function AccountsReceivableRetryTransactionRejectToJSON(value?: AccountsReceivableRetryTransactionReject | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'value': value.value,
+    };
+}
+

package/src/models/ReportDryRunQueriesRequest.ts

@@ -0,0 +1,103 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ReportDataSetQuery,
+    ReportDataSetQueryFromJSON,
+    ReportDataSetQueryFromJSONTyped,
+    ReportDataSetQueryToJSON,
+} from './ReportDataSetQuery';
+
+/**
+ * 
+ * @export
+ * @interface ReportDryRunQueriesRequest
+ */
+export interface ReportDryRunQueriesRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    connection_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    default_dataset_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    default_project_id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    merchant_id?: string;
+    /**
+     * 
+     * @type {Array<ReportDataSetQuery>}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    queries?: Array<ReportDataSetQuery>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDryRunQueriesRequest
+     */
+    security_level?: string;
+}
+
+export function ReportDryRunQueriesRequestFromJSON(json: any): ReportDryRunQueriesRequest {
+    return ReportDryRunQueriesRequestFromJSONTyped(json, false);
+}
+
+export function ReportDryRunQueriesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDryRunQueriesRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'connection_id': !exists(json, 'connection_id') ? undefined : json['connection_id'],
+        'default_dataset_id': !exists(json, 'default_dataset_id') ? undefined : json['default_dataset_id'],
+        'default_project_id': !exists(json, 'default_project_id') ? undefined : json['default_project_id'],
+        'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'queries': !exists(json, 'queries') ? undefined : ((json['queries'] as Array<any>).map(ReportDataSetQueryFromJSON)),
+        'security_level': !exists(json, 'security_level') ? undefined : json['security_level'],
+    };
+}
+
+export function ReportDryRunQueriesRequestToJSON(value?: ReportDryRunQueriesRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'connection_id': value.connection_id,
+        'default_dataset_id': value.default_dataset_id,
+        'default_project_id': value.default_project_id,
+        'merchant_id': value.merchant_id,
+        'queries': value.queries === undefined ? undefined : ((value.queries as Array<any>).map(ReportDataSetQueryToJSON)),
+        'security_level': value.security_level,
+    };
+}
+

package/src/models/ReportDryRunQueriesResponse.ts

@@ -0,0 +1,63 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ReportDryRunQueryResult,
+    ReportDryRunQueryResultFromJSON,
+    ReportDryRunQueryResultFromJSONTyped,
+    ReportDryRunQueryResultToJSON,
+} from './ReportDryRunQueryResult';
+
+/**
+ * 
+ * @export
+ * @interface ReportDryRunQueriesResponse
+ */
+export interface ReportDryRunQueriesResponse {
+    /**
+     * 
+     * @type {Array<ReportDryRunQueryResult>}
+     * @memberof ReportDryRunQueriesResponse
+     */
+    dry_run_query_results?: Array<ReportDryRunQueryResult>;
+}
+
+export function ReportDryRunQueriesResponseFromJSON(json: any): ReportDryRunQueriesResponse {
+    return ReportDryRunQueriesResponseFromJSONTyped(json, false);
+}
+
+export function ReportDryRunQueriesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDryRunQueriesResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'dry_run_query_results': !exists(json, 'dry_run_query_results') ? undefined : ((json['dry_run_query_results'] as Array<any>).map(ReportDryRunQueryResultFromJSON)),
+    };
+}
+
+export function ReportDryRunQueriesResponseToJSON(value?: ReportDryRunQueriesResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'dry_run_query_results': value.dry_run_query_results === undefined ? undefined : ((value.dry_run_query_results as Array<any>).map(ReportDryRunQueryResultToJSON)),
+    };
+}
+

package/src/models/ReportDryRunQueryResult.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ReportDryRunQueryResult
+ */
+export interface ReportDryRunQueryResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDryRunQueryResult
+     */
+    error_message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReportDryRunQueryResult
+     */
+    total_bytes_processed?: number;
+}
+
+export function ReportDryRunQueryResultFromJSON(json: any): ReportDryRunQueryResult {
+    return ReportDryRunQueryResultFromJSONTyped(json, false);
+}
+
+export function ReportDryRunQueryResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportDryRunQueryResult {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error_message': !exists(json, 'error_message') ? undefined : json['error_message'],
+        'total_bytes_processed': !exists(json, 'total_bytes_processed') ? undefined : json['total_bytes_processed'],
+    };
+}
+
+export function ReportDryRunQueryResultToJSON(value?: ReportDryRunQueryResult | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error_message': value.error_message,
+        'total_bytes_processed': value.total_bytes_processed,
+    };
+}
+

package/src/models/index.ts

@@ -7,6 +7,7 @@ export * from './AccountsReceivableRetryStatAccount';
 export * from './AccountsReceivableRetryStatMetrics';
 export * from './AccountsReceivableRetryStatRevenue';
 export * from './AccountsReceivableRetryStatsResponse';
+export * from './AccountsReceivableRetryTransactionReject';
 export * from './Activity';
 export * from './AddLibraryItemRequest';
 export * from './AdjustInternalCertificateRequest';
@@ -636,6 +637,9 @@ export * from './ReportDataSetRow';
 export * from './ReportDataSetSchema';
 export * from './ReportDataSource';
 export * from './ReportDataSourceSchema';
+export * from './ReportDryRunQueriesRequest';
+export * from './ReportDryRunQueriesResponse';
+export * from './ReportDryRunQueryResult';
 export * from './ReportExecuteQueriesRequest';
 export * from './ReportFilter';
 export * from './ReportFilterConnection';