ultracart_rest_api_v2_typescript 3.10.127 → 3.10.128

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.127
+## ultracart_rest_api_v2_typescript@3.10.128
 
 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@3.10.127 --save
+npm install ultracart_rest_api_v2_typescript@3.10.128 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.128 | 04/10/2023 | data warehouse internal dev |
 | 3.10.127 | 03/29/2023 | internal development |
 | 3.10.126 | 03/22/2023 | data warehouse internal dev |
 | 3.10.125 | 03/22/2023 | dw initial framework |

package/api.ts

@@ -162,6 +162,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}
@@ -428,6 +434,26 @@ export interface AccountsReceivableRetryStatsResponse {
     warning?: Warning;
 }
 
+/**
+ * 
+ * @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
@@ -34008,6 +34034,84 @@ export namespace ReportDataSourceSchema {
     }
 }
 
+/**
+ * 
+ * @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
+ * @interface ReportDryRunQueriesResponse
+ */
+export interface ReportDryRunQueriesResponse {
+    /**
+     * 
+     * @type {Array<ReportDryRunQueryResult>}
+     * @memberof ReportDryRunQueriesResponse
+     */
+    dry_run_query_results?: Array<ReportDryRunQueryResult>;
+}
+
+/**
+ * 
+ * @export
+ * @interface ReportDryRunQueryResult
+ */
+export interface ReportDryRunQueryResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDryRunQueryResult
+     */
+    error_message?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReportDryRunQueryResult
+     */
+    total_bytes_processed?: number;
+}
+
 /**
  * 
  * @export
@@ -54400,6 +54504,61 @@ export const DatawarehouseApiFetchParamCreator = function (configuration?: Confi
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Dry run the report queries 
+         * @summary Dry run the report queries
+         * @param {ReportDryRunQueriesRequest} query_request Dry run request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options: any = {}): FetchArgs {
+            // verify required parameter 'query_request' is not null or undefined
+            if (query_request === null || query_request === undefined) {
+                throw new RequiredError('query_request','Required parameter query_request was null or undefined when calling dryRunReportQueries.');
+            }
+            const localVarPath = `/datawarehouse/reports/dryrun`;
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", [])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            const needsSerialization = (<any>"ReportDryRunQueriesRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(query_request || {}) : (query_request || "");
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Execute the report queries 
          * @summary Execute the report queries
@@ -54855,6 +55014,27 @@ export const DatawarehouseApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Dry run the report queries 
+         * @summary Dry run the report queries
+         * @param {ReportDryRunQueriesRequest} query_request Dry run request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ReportDryRunQueriesResponse> {
+            const localVarFetchArgs = DatawarehouseApiFetchParamCreator(configuration).dryRunReportQueries(query_request, options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Execute the report queries 
          * @summary Execute the report queries
@@ -55042,6 +55222,16 @@ export const DatawarehouseApiFactory = function (configuration?: Configuration,
         deleteReport(report_oid: number, options?: any) {
             return DatawarehouseApiFp(configuration).deleteReport(report_oid, options)(fetch, basePath);
         },
+        /**
+         * Dry run the report queries 
+         * @summary Dry run the report queries
+         * @param {ReportDryRunQueriesRequest} query_request Dry run request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any) {
+            return DatawarehouseApiFp(configuration).dryRunReportQueries(query_request, options)(fetch, basePath);
+        },
         /**
          * Execute the report queries 
          * @summary Execute the report queries
@@ -55141,6 +55331,16 @@ export interface DatawarehouseApiInterface {
      */
     deleteReport(report_oid: number, options?: any): Promise<{}>;
 
+    /**
+     * Dry run the report queries 
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} query_request Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
+
     /**
      * Execute the report queries 
      * @summary Execute the report queries
@@ -55242,6 +55442,18 @@ export class DatawarehouseApi extends BaseAPI implements DatawarehouseApiInterfa
         return DatawarehouseApiFp(this.configuration).deleteReport(report_oid, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Dry run the report queries 
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} query_request Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApi
+     */
+    public dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any) {
+        return DatawarehouseApiFp(this.configuration).dryRunReportQueries(query_request, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Execute the report queries 
      * @summary Execute the report queries

package/dist/api.d.ts

@@ -144,6 +144,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}
@@ -403,6 +409,25 @@ export interface AccountsReceivableRetryStatsResponse {
      */
     warning?: Warning;
 }
+/**
+ *
+ * @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
@@ -33295,6 +33320,81 @@ export declare namespace ReportDataSourceSchema {
         TIMESTAMP
     }
 }
+/**
+ *
+ * @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
+ * @interface ReportDryRunQueriesResponse
+ */
+export interface ReportDryRunQueriesResponse {
+    /**
+     *
+     * @type {Array<ReportDryRunQueryResult>}
+     * @memberof ReportDryRunQueriesResponse
+     */
+    dry_run_query_results?: Array<ReportDryRunQueryResult>;
+}
+/**
+ *
+ * @export
+ * @interface ReportDryRunQueryResult
+ */
+export interface ReportDryRunQueryResult {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDryRunQueryResult
+     */
+    error_message?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ReportDryRunQueryResult
+     */
+    total_bytes_processed?: number;
+}
 /**
  *
  * @export
@@ -45082,6 +45182,14 @@ export declare const DatawarehouseApiFetchParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     deleteReport(report_oid: number, options?: any): FetchArgs;
+    /**
+     * Dry run the report queries
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} query_request Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): FetchArgs;
     /**
      * Execute the report queries
      * @summary Execute the report queries
@@ -45160,6 +45268,14 @@ export declare const DatawarehouseApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteReport(report_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
+    /**
+     * Dry run the report queries
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} query_request Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ReportDryRunQueriesResponse>;
     /**
      * Execute the report queries
      * @summary Execute the report queries
@@ -45238,6 +45354,14 @@ export declare const DatawarehouseApiFactory: (configuration?: Configuration, fe
      * @throws {RequiredError}
      */
     deleteReport(report_oid: number, options?: any): Promise<Response>;
+    /**
+     * Dry run the report queries
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} query_request Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
     /**
      * Execute the report queries
      * @summary Execute the report queries
@@ -45318,6 +45442,15 @@ export interface DatawarehouseApiInterface {
      * @memberof DatawarehouseApiInterface
      */
     deleteReport(report_oid: number, options?: any): Promise<{}>;
+    /**
+     * Dry run the report queries
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} query_request Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApiInterface
+     */
+    dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
     /**
      * Execute the report queries
      * @summary Execute the report queries
@@ -45407,6 +45540,15 @@ export declare class DatawarehouseApi extends BaseAPI implements DatawarehouseAp
      * @memberof DatawarehouseApi
      */
     deleteReport(report_oid: number, options?: any): Promise<Response>;
+    /**
+     * Dry run the report queries
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} query_request Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApi
+     */
+    dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
     /**
      * Execute the report queries
      * @summary Execute the report queries

package/dist/api.js

@@ -13659,6 +13659,54 @@ var DatawarehouseApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Dry run the report queries
+         * @summary Dry run the report queries
+         * @param {ReportDryRunQueriesRequest} query_request Dry run request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        dryRunReportQueries: function (query_request, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'query_request' is not null or undefined
+            if (query_request === null || query_request === undefined) {
+                throw new RequiredError('query_request', 'Required parameter query_request was null or undefined when calling dryRunReportQueries.');
+            }
+            var localVarPath = "/datawarehouse/reports/dryrun";
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", [])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            var needsSerialization = ("ReportDryRunQueriesRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(query_request || {}) : (query_request || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Execute the report queries
          * @summary Execute the report queries
@@ -14064,6 +14112,28 @@ var DatawarehouseApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Dry run the report queries
+         * @summary Dry run the report queries
+         * @param {ReportDryRunQueriesRequest} query_request Dry run request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        dryRunReportQueries: function (query_request, options) {
+            var localVarFetchArgs = (0, exports.DatawarehouseApiFetchParamCreator)(configuration).dryRunReportQueries(query_request, options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Execute the report queries
          * @summary Execute the report queries
@@ -14259,6 +14329,16 @@ var DatawarehouseApiFactory = function (configuration, fetch, basePath) {
         deleteReport: function (report_oid, options) {
             return (0, exports.DatawarehouseApiFp)(configuration).deleteReport(report_oid, options)(fetch, basePath);
         },
+        /**
+         * Dry run the report queries
+         * @summary Dry run the report queries
+         * @param {ReportDryRunQueriesRequest} query_request Dry run request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        dryRunReportQueries: function (query_request, options) {
+            return (0, exports.DatawarehouseApiFp)(configuration).dryRunReportQueries(query_request, options)(fetch, basePath);
+        },
         /**
          * Execute the report queries
          * @summary Execute the report queries
@@ -14364,6 +14444,17 @@ var DatawarehouseApi = /** @class */ (function (_super) {
     DatawarehouseApi.prototype.deleteReport = function (report_oid, options) {
         return (0, exports.DatawarehouseApiFp)(this.configuration).deleteReport(report_oid, options)(this.fetch, this.basePath);
     };
+    /**
+     * Dry run the report queries
+     * @summary Dry run the report queries
+     * @param {ReportDryRunQueriesRequest} query_request Dry run request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DatawarehouseApi
+     */
+    DatawarehouseApi.prototype.dryRunReportQueries = function (query_request, options) {
+        return (0, exports.DatawarehouseApiFp)(this.configuration).dryRunReportQueries(query_request, options)(this.fetch, this.basePath);
+    };
     /**
      * Execute the report queries
      * @summary Execute the report queries

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.127",
+  "version": "3.10.128",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [