ultracart_rest_api_v2_typescript 3.10.126 → 3.10.128

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.10.126
1
+ ## ultracart_rest_api_v2_typescript@3.10.128
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.126 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.128 --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.128 | 04/10/2023 | data warehouse internal dev |
58
+ | 3.10.127 | 03/29/2023 | internal development |
57
59
  | 3.10.126 | 03/22/2023 | data warehouse internal dev |
58
60
  | 3.10.125 | 03/22/2023 | dw initial framework |
59
61
  | 3.10.124 | 03/22/2023 | order api - refundable response added manual_because_multiple_charges boolean field |
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
@@ -20063,12 +20089,42 @@ export interface Experiment {
20063
20089
  * @memberof Experiment
20064
20090
  */
20065
20091
  objective_parameter?: string;
20092
+ /**
20093
+ * The current iteration of the OpenAI related experiment
20094
+ * @type {number}
20095
+ * @memberof Experiment
20096
+ */
20097
+ openai_current_iteration?: number;
20098
+ /**
20099
+ * The type of OpenAI element being experimented on
20100
+ * @type {string}
20101
+ * @memberof Experiment
20102
+ */
20103
+ openai_element_type?: Experiment.OpenaiElementTypeEnum;
20104
+ /**
20105
+ * The type of OpenAI model used
20106
+ * @type {string}
20107
+ * @memberof Experiment
20108
+ */
20109
+ openai_model?: string;
20110
+ /**
20111
+ * The total number of iterations to perform on the experiment
20112
+ * @type {number}
20113
+ * @memberof Experiment
20114
+ */
20115
+ openai_total_iterations?: number;
20066
20116
  /**
20067
20117
  * Type of optimization
20068
20118
  * @type {string}
20069
20119
  * @memberof Experiment
20070
20120
  */
20071
20121
  optimization_type?: string;
20122
+ /**
20123
+ * Statistics p-value for the experiment
20124
+ * @type {number}
20125
+ * @memberof Experiment
20126
+ */
20127
+ p_value?: number;
20072
20128
  /**
20073
20129
  * Total number of sessions in the experiment
20074
20130
  * @type {number}
@@ -20118,6 +20174,15 @@ export interface Experiment {
20118
20174
  * @namespace Experiment
20119
20175
  */
20120
20176
  export namespace Experiment {
20177
+ /**
20178
+ * @export
20179
+ * @enum {string}
20180
+ */
20181
+ export enum OpenaiElementTypeEnum {
20182
+ Headline = <any> 'headline',
20183
+ Text = <any> 'text',
20184
+ Textblock = <any> 'textblock'
20185
+ }
20121
20186
  /**
20122
20187
  * @export
20123
20188
  * @enum {string}
@@ -33875,72 +33940,6 @@ export namespace ReportDataSetSchema {
33875
33940
  }
33876
33941
  }
33877
33942
 
33878
- /**
33879
- *
33880
- * @export
33881
- * @interface ReportDataSetSummary
33882
- */
33883
- export interface ReportDataSetSummary {
33884
- /**
33885
- * A unique identifier assigned to the data set that is returned.
33886
- * @type {string}
33887
- * @memberof ReportDataSetSummary
33888
- */
33889
- data_set_uuid?: string;
33890
- /**
33891
- * Error message if the query failed.
33892
- * @type {string}
33893
- * @memberof ReportDataSetSummary
33894
- */
33895
- error_message?: string;
33896
- /**
33897
- * An identifier that can be used to help match up the returned data set
33898
- * @type {string}
33899
- * @memberof ReportDataSetSummary
33900
- */
33901
- for_object_id?: string;
33902
- /**
33903
- * The type of object this data set is for
33904
- * @type {string}
33905
- * @memberof ReportDataSetSummary
33906
- */
33907
- for_object_type?: ReportDataSetSummary.ForObjectTypeEnum;
33908
- /**
33909
- * The total number of results
33910
- * @type {number}
33911
- * @memberof ReportDataSetSummary
33912
- */
33913
- max_results?: number;
33914
- /**
33915
- * The schema associated with the data set.
33916
- * @type {Array<ReportDataSetSchema>}
33917
- * @memberof ReportDataSetSummary
33918
- */
33919
- schema?: Array<ReportDataSetSchema>;
33920
- /**
33921
- * Any other data that needs to be returned with the response to help the UI
33922
- * @type {string}
33923
- * @memberof ReportDataSetSummary
33924
- */
33925
- user_data?: string;
33926
- }
33927
-
33928
- /**
33929
- * @export
33930
- * @namespace ReportDataSetSummary
33931
- */
33932
- export namespace ReportDataSetSummary {
33933
- /**
33934
- * @export
33935
- * @enum {string}
33936
- */
33937
- export enum ForObjectTypeEnum {
33938
- Schema = <any> 'schema',
33939
- Filter = <any> 'filter',
33940
- Visualization = <any> 'visualization'
33941
- }
33942
- }
33943
-
33944
33943
  /**
33945
33944
  *
33946
33945
  * @export
@@ -34035,6 +34034,84 @@ export namespace ReportDataSourceSchema {
34035
34034
  }
34036
34035
  }
34037
34036
 
34037
+ /**
34038
+ *
34039
+ * @export
34040
+ * @interface ReportDryRunQueriesRequest
34041
+ */
34042
+ export interface ReportDryRunQueriesRequest {
34043
+ /**
34044
+ *
34045
+ * @type {string}
34046
+ * @memberof ReportDryRunQueriesRequest
34047
+ */
34048
+ connection_id?: string;
34049
+ /**
34050
+ *
34051
+ * @type {string}
34052
+ * @memberof ReportDryRunQueriesRequest
34053
+ */
34054
+ default_dataset_id?: string;
34055
+ /**
34056
+ *
34057
+ * @type {string}
34058
+ * @memberof ReportDryRunQueriesRequest
34059
+ */
34060
+ default_project_id?: string;
34061
+ /**
34062
+ *
34063
+ * @type {string}
34064
+ * @memberof ReportDryRunQueriesRequest
34065
+ */
34066
+ merchant_id?: string;
34067
+ /**
34068
+ *
34069
+ * @type {Array<ReportDataSetQuery>}
34070
+ * @memberof ReportDryRunQueriesRequest
34071
+ */
34072
+ queries?: Array<ReportDataSetQuery>;
34073
+ /**
34074
+ *
34075
+ * @type {string}
34076
+ * @memberof ReportDryRunQueriesRequest
34077
+ */
34078
+ security_level?: string;
34079
+ }
34080
+
34081
+ /**
34082
+ *
34083
+ * @export
34084
+ * @interface ReportDryRunQueriesResponse
34085
+ */
34086
+ export interface ReportDryRunQueriesResponse {
34087
+ /**
34088
+ *
34089
+ * @type {Array<ReportDryRunQueryResult>}
34090
+ * @memberof ReportDryRunQueriesResponse
34091
+ */
34092
+ dry_run_query_results?: Array<ReportDryRunQueryResult>;
34093
+ }
34094
+
34095
+ /**
34096
+ *
34097
+ * @export
34098
+ * @interface ReportDryRunQueryResult
34099
+ */
34100
+ export interface ReportDryRunQueryResult {
34101
+ /**
34102
+ *
34103
+ * @type {string}
34104
+ * @memberof ReportDryRunQueryResult
34105
+ */
34106
+ error_message?: string;
34107
+ /**
34108
+ *
34109
+ * @type {number}
34110
+ * @memberof ReportDryRunQueryResult
34111
+ */
34112
+ total_bytes_processed?: number;
34113
+ }
34114
+
34038
34115
  /**
34039
34116
  *
34040
34117
  * @export
@@ -34447,10 +34524,10 @@ export interface ReportWebsocketEvent {
34447
34524
  event_type?: ReportWebsocketEvent.EventTypeEnum;
34448
34525
  /**
34449
34526
  *
34450
- * @type {ReportDataSetSummary}
34527
+ * @type {ReportDataSet}
34451
34528
  * @memberof ReportWebsocketEvent
34452
34529
  */
34453
- query_completion?: ReportDataSetSummary;
34530
+ query_completion?: ReportDataSet;
34454
34531
  }
34455
34532
 
34456
34533
  /**
@@ -54427,6 +54504,61 @@ export const DatawarehouseApiFetchParamCreator = function (configuration?: Confi
54427
54504
  options: localVarRequestOptions,
54428
54505
  };
54429
54506
  },
54507
+ /**
54508
+ * Dry run the report queries
54509
+ * @summary Dry run the report queries
54510
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
54511
+ * @param {*} [options] Override http request option.
54512
+ * @throws {RequiredError}
54513
+ */
54514
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options: any = {}): FetchArgs {
54515
+ // verify required parameter 'query_request' is not null or undefined
54516
+ if (query_request === null || query_request === undefined) {
54517
+ throw new RequiredError('query_request','Required parameter query_request was null or undefined when calling dryRunReportQueries.');
54518
+ }
54519
+ const localVarPath = `/datawarehouse/reports/dryrun`;
54520
+ const localVarUrlObj = url.parse(localVarPath, true);
54521
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
54522
+ const localVarHeaderParameter = {} as any;
54523
+ const localVarQueryParameter = {} as any;
54524
+
54525
+ if(configuration && configuration.apiVersion) {
54526
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
54527
+ }
54528
+
54529
+
54530
+
54531
+ // authentication ultraCartOauth required
54532
+ // oauth required
54533
+ if (configuration && configuration.accessToken) {
54534
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
54535
+ ? configuration.accessToken("ultraCartOauth", [])
54536
+ : configuration.accessToken;
54537
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
54538
+ }
54539
+
54540
+ // authentication ultraCartSimpleApiKey required
54541
+ if (configuration && configuration.apiKey) {
54542
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
54543
+ ? configuration.apiKey("x-ultracart-simple-key")
54544
+ : configuration.apiKey;
54545
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
54546
+ }
54547
+
54548
+ localVarHeaderParameter['Content-Type'] = 'application/json';
54549
+
54550
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
54551
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
54552
+ delete localVarUrlObj.search;
54553
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
54554
+ const needsSerialization = (<any>"ReportDryRunQueriesRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
54555
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(query_request || {}) : (query_request || "");
54556
+
54557
+ return {
54558
+ url: url.format(localVarUrlObj),
54559
+ options: localVarRequestOptions,
54560
+ };
54561
+ },
54430
54562
  /**
54431
54563
  * Execute the report queries
54432
54564
  * @summary Execute the report queries
@@ -54882,6 +55014,27 @@ export const DatawarehouseApiFp = function(configuration?: Configuration) {
54882
55014
  });
54883
55015
  };
54884
55016
  },
55017
+ /**
55018
+ * Dry run the report queries
55019
+ * @summary Dry run the report queries
55020
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
55021
+ * @param {*} [options] Override http request option.
55022
+ * @throws {RequiredError}
55023
+ */
55024
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ReportDryRunQueriesResponse> {
55025
+ const localVarFetchArgs = DatawarehouseApiFetchParamCreator(configuration).dryRunReportQueries(query_request, options);
55026
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
55027
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
55028
+
55029
+ if (response.status >= 200 && response.status < 300) {
55030
+ return response.json();
55031
+
55032
+ } else {
55033
+ throw response;
55034
+ }
55035
+ });
55036
+ };
55037
+ },
54885
55038
  /**
54886
55039
  * Execute the report queries
54887
55040
  * @summary Execute the report queries
@@ -55069,6 +55222,16 @@ export const DatawarehouseApiFactory = function (configuration?: Configuration,
55069
55222
  deleteReport(report_oid: number, options?: any) {
55070
55223
  return DatawarehouseApiFp(configuration).deleteReport(report_oid, options)(fetch, basePath);
55071
55224
  },
55225
+ /**
55226
+ * Dry run the report queries
55227
+ * @summary Dry run the report queries
55228
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
55229
+ * @param {*} [options] Override http request option.
55230
+ * @throws {RequiredError}
55231
+ */
55232
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any) {
55233
+ return DatawarehouseApiFp(configuration).dryRunReportQueries(query_request, options)(fetch, basePath);
55234
+ },
55072
55235
  /**
55073
55236
  * Execute the report queries
55074
55237
  * @summary Execute the report queries
@@ -55168,6 +55331,16 @@ export interface DatawarehouseApiInterface {
55168
55331
  */
55169
55332
  deleteReport(report_oid: number, options?: any): Promise<{}>;
55170
55333
 
55334
+ /**
55335
+ * Dry run the report queries
55336
+ * @summary Dry run the report queries
55337
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
55338
+ * @param {*} [options] Override http request option.
55339
+ * @throws {RequiredError}
55340
+ * @memberof DatawarehouseApiInterface
55341
+ */
55342
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
55343
+
55171
55344
  /**
55172
55345
  * Execute the report queries
55173
55346
  * @summary Execute the report queries
@@ -55269,6 +55442,18 @@ export class DatawarehouseApi extends BaseAPI implements DatawarehouseApiInterfa
55269
55442
  return DatawarehouseApiFp(this.configuration).deleteReport(report_oid, options)(this.fetch, this.basePath);
55270
55443
  }
55271
55444
 
55445
+ /**
55446
+ * Dry run the report queries
55447
+ * @summary Dry run the report queries
55448
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
55449
+ * @param {*} [options] Override http request option.
55450
+ * @throws {RequiredError}
55451
+ * @memberof DatawarehouseApi
55452
+ */
55453
+ public dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any) {
55454
+ return DatawarehouseApiFp(this.configuration).dryRunReportQueries(query_request, options)(this.fetch, this.basePath);
55455
+ }
55456
+
55272
55457
  /**
55273
55458
  * Execute the report queries
55274
55459
  * @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
@@ -19613,12 +19638,42 @@ export interface Experiment {
19613
19638
  * @memberof Experiment
19614
19639
  */
19615
19640
  objective_parameter?: string;
19641
+ /**
19642
+ * The current iteration of the OpenAI related experiment
19643
+ * @type {number}
19644
+ * @memberof Experiment
19645
+ */
19646
+ openai_current_iteration?: number;
19647
+ /**
19648
+ * The type of OpenAI element being experimented on
19649
+ * @type {string}
19650
+ * @memberof Experiment
19651
+ */
19652
+ openai_element_type?: Experiment.OpenaiElementTypeEnum;
19653
+ /**
19654
+ * The type of OpenAI model used
19655
+ * @type {string}
19656
+ * @memberof Experiment
19657
+ */
19658
+ openai_model?: string;
19659
+ /**
19660
+ * The total number of iterations to perform on the experiment
19661
+ * @type {number}
19662
+ * @memberof Experiment
19663
+ */
19664
+ openai_total_iterations?: number;
19616
19665
  /**
19617
19666
  * Type of optimization
19618
19667
  * @type {string}
19619
19668
  * @memberof Experiment
19620
19669
  */
19621
19670
  optimization_type?: string;
19671
+ /**
19672
+ * Statistics p-value for the experiment
19673
+ * @type {number}
19674
+ * @memberof Experiment
19675
+ */
19676
+ p_value?: number;
19622
19677
  /**
19623
19678
  * Total number of sessions in the experiment
19624
19679
  * @type {number}
@@ -19667,6 +19722,15 @@ export interface Experiment {
19667
19722
  * @namespace Experiment
19668
19723
  */
19669
19724
  export declare namespace Experiment {
19725
+ /**
19726
+ * @export
19727
+ * @enum {string}
19728
+ */
19729
+ enum OpenaiElementTypeEnum {
19730
+ Headline,
19731
+ Text,
19732
+ Textblock
19733
+ }
19670
19734
  /**
19671
19735
  * @export
19672
19736
  * @enum {string}
@@ -33165,70 +33229,6 @@ export declare namespace ReportDataSetSchema {
33165
33229
  TIMESTAMP
33166
33230
  }
33167
33231
  }
33168
- /**
33169
- *
33170
- * @export
33171
- * @interface ReportDataSetSummary
33172
- */
33173
- export interface ReportDataSetSummary {
33174
- /**
33175
- * A unique identifier assigned to the data set that is returned.
33176
- * @type {string}
33177
- * @memberof ReportDataSetSummary
33178
- */
33179
- data_set_uuid?: string;
33180
- /**
33181
- * Error message if the query failed.
33182
- * @type {string}
33183
- * @memberof ReportDataSetSummary
33184
- */
33185
- error_message?: string;
33186
- /**
33187
- * An identifier that can be used to help match up the returned data set
33188
- * @type {string}
33189
- * @memberof ReportDataSetSummary
33190
- */
33191
- for_object_id?: string;
33192
- /**
33193
- * The type of object this data set is for
33194
- * @type {string}
33195
- * @memberof ReportDataSetSummary
33196
- */
33197
- for_object_type?: ReportDataSetSummary.ForObjectTypeEnum;
33198
- /**
33199
- * The total number of results
33200
- * @type {number}
33201
- * @memberof ReportDataSetSummary
33202
- */
33203
- max_results?: number;
33204
- /**
33205
- * The schema associated with the data set.
33206
- * @type {Array<ReportDataSetSchema>}
33207
- * @memberof ReportDataSetSummary
33208
- */
33209
- schema?: Array<ReportDataSetSchema>;
33210
- /**
33211
- * Any other data that needs to be returned with the response to help the UI
33212
- * @type {string}
33213
- * @memberof ReportDataSetSummary
33214
- */
33215
- user_data?: string;
33216
- }
33217
- /**
33218
- * @export
33219
- * @namespace ReportDataSetSummary
33220
- */
33221
- export declare namespace ReportDataSetSummary {
33222
- /**
33223
- * @export
33224
- * @enum {string}
33225
- */
33226
- enum ForObjectTypeEnum {
33227
- Schema,
33228
- Filter,
33229
- Visualization
33230
- }
33231
- }
33232
33232
  /**
33233
33233
  *
33234
33234
  * @export
@@ -33320,6 +33320,81 @@ export declare namespace ReportDataSourceSchema {
33320
33320
  TIMESTAMP
33321
33321
  }
33322
33322
  }
33323
+ /**
33324
+ *
33325
+ * @export
33326
+ * @interface ReportDryRunQueriesRequest
33327
+ */
33328
+ export interface ReportDryRunQueriesRequest {
33329
+ /**
33330
+ *
33331
+ * @type {string}
33332
+ * @memberof ReportDryRunQueriesRequest
33333
+ */
33334
+ connection_id?: string;
33335
+ /**
33336
+ *
33337
+ * @type {string}
33338
+ * @memberof ReportDryRunQueriesRequest
33339
+ */
33340
+ default_dataset_id?: string;
33341
+ /**
33342
+ *
33343
+ * @type {string}
33344
+ * @memberof ReportDryRunQueriesRequest
33345
+ */
33346
+ default_project_id?: string;
33347
+ /**
33348
+ *
33349
+ * @type {string}
33350
+ * @memberof ReportDryRunQueriesRequest
33351
+ */
33352
+ merchant_id?: string;
33353
+ /**
33354
+ *
33355
+ * @type {Array<ReportDataSetQuery>}
33356
+ * @memberof ReportDryRunQueriesRequest
33357
+ */
33358
+ queries?: Array<ReportDataSetQuery>;
33359
+ /**
33360
+ *
33361
+ * @type {string}
33362
+ * @memberof ReportDryRunQueriesRequest
33363
+ */
33364
+ security_level?: string;
33365
+ }
33366
+ /**
33367
+ *
33368
+ * @export
33369
+ * @interface ReportDryRunQueriesResponse
33370
+ */
33371
+ export interface ReportDryRunQueriesResponse {
33372
+ /**
33373
+ *
33374
+ * @type {Array<ReportDryRunQueryResult>}
33375
+ * @memberof ReportDryRunQueriesResponse
33376
+ */
33377
+ dry_run_query_results?: Array<ReportDryRunQueryResult>;
33378
+ }
33379
+ /**
33380
+ *
33381
+ * @export
33382
+ * @interface ReportDryRunQueryResult
33383
+ */
33384
+ export interface ReportDryRunQueryResult {
33385
+ /**
33386
+ *
33387
+ * @type {string}
33388
+ * @memberof ReportDryRunQueryResult
33389
+ */
33390
+ error_message?: string;
33391
+ /**
33392
+ *
33393
+ * @type {number}
33394
+ * @memberof ReportDryRunQueryResult
33395
+ */
33396
+ total_bytes_processed?: number;
33397
+ }
33323
33398
  /**
33324
33399
  *
33325
33400
  * @export
@@ -33720,10 +33795,10 @@ export interface ReportWebsocketEvent {
33720
33795
  event_type?: ReportWebsocketEvent.EventTypeEnum;
33721
33796
  /**
33722
33797
  *
33723
- * @type {ReportDataSetSummary}
33798
+ * @type {ReportDataSet}
33724
33799
  * @memberof ReportWebsocketEvent
33725
33800
  */
33726
- query_completion?: ReportDataSetSummary;
33801
+ query_completion?: ReportDataSet;
33727
33802
  }
33728
33803
  /**
33729
33804
  * @export
@@ -45107,6 +45182,14 @@ export declare const DatawarehouseApiFetchParamCreator: (configuration?: Configu
45107
45182
  * @throws {RequiredError}
45108
45183
  */
45109
45184
  deleteReport(report_oid: number, options?: any): FetchArgs;
45185
+ /**
45186
+ * Dry run the report queries
45187
+ * @summary Dry run the report queries
45188
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
45189
+ * @param {*} [options] Override http request option.
45190
+ * @throws {RequiredError}
45191
+ */
45192
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): FetchArgs;
45110
45193
  /**
45111
45194
  * Execute the report queries
45112
45195
  * @summary Execute the report queries
@@ -45185,6 +45268,14 @@ export declare const DatawarehouseApiFp: (configuration?: Configuration) => {
45185
45268
  * @throws {RequiredError}
45186
45269
  */
45187
45270
  deleteReport(report_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
45271
+ /**
45272
+ * Dry run the report queries
45273
+ * @summary Dry run the report queries
45274
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
45275
+ * @param {*} [options] Override http request option.
45276
+ * @throws {RequiredError}
45277
+ */
45278
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ReportDryRunQueriesResponse>;
45188
45279
  /**
45189
45280
  * Execute the report queries
45190
45281
  * @summary Execute the report queries
@@ -45263,6 +45354,14 @@ export declare const DatawarehouseApiFactory: (configuration?: Configuration, fe
45263
45354
  * @throws {RequiredError}
45264
45355
  */
45265
45356
  deleteReport(report_oid: number, options?: any): Promise<Response>;
45357
+ /**
45358
+ * Dry run the report queries
45359
+ * @summary Dry run the report queries
45360
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
45361
+ * @param {*} [options] Override http request option.
45362
+ * @throws {RequiredError}
45363
+ */
45364
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
45266
45365
  /**
45267
45366
  * Execute the report queries
45268
45367
  * @summary Execute the report queries
@@ -45343,6 +45442,15 @@ export interface DatawarehouseApiInterface {
45343
45442
  * @memberof DatawarehouseApiInterface
45344
45443
  */
45345
45444
  deleteReport(report_oid: number, options?: any): Promise<{}>;
45445
+ /**
45446
+ * Dry run the report queries
45447
+ * @summary Dry run the report queries
45448
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
45449
+ * @param {*} [options] Override http request option.
45450
+ * @throws {RequiredError}
45451
+ * @memberof DatawarehouseApiInterface
45452
+ */
45453
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
45346
45454
  /**
45347
45455
  * Execute the report queries
45348
45456
  * @summary Execute the report queries
@@ -45432,6 +45540,15 @@ export declare class DatawarehouseApi extends BaseAPI implements DatawarehouseAp
45432
45540
  * @memberof DatawarehouseApi
45433
45541
  */
45434
45542
  deleteReport(report_oid: number, options?: any): Promise<Response>;
45543
+ /**
45544
+ * Dry run the report queries
45545
+ * @summary Dry run the report queries
45546
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
45547
+ * @param {*} [options] Override http request option.
45548
+ * @throws {RequiredError}
45549
+ * @memberof DatawarehouseApi
45550
+ */
45551
+ dryRunReportQueries(query_request: ReportDryRunQueriesRequest, options?: any): Promise<ReportDryRunQueriesResponse>;
45435
45552
  /**
45436
45553
  * Execute the report queries
45437
45554
  * @summary Execute the report queries
package/dist/api.js CHANGED
@@ -29,8 +29,8 @@ var __extends = (this && this.__extends) || (function () {
29
29
  })();
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
31
  exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
- exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSummary = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = void 0;
33
- exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = void 0;
32
+ exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = void 0;
33
+ exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = void 0;
34
34
  var url = require("url");
35
35
  var portableFetch = require("portable-fetch");
36
36
  var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -721,6 +721,16 @@ var EmailPerformance;
721
721
  */
722
722
  var Experiment;
723
723
  (function (Experiment) {
724
+ /**
725
+ * @export
726
+ * @enum {string}
727
+ */
728
+ var OpenaiElementTypeEnum;
729
+ (function (OpenaiElementTypeEnum) {
730
+ OpenaiElementTypeEnum[OpenaiElementTypeEnum["Headline"] = 'headline'] = "Headline";
731
+ OpenaiElementTypeEnum[OpenaiElementTypeEnum["Text"] = 'text'] = "Text";
732
+ OpenaiElementTypeEnum[OpenaiElementTypeEnum["Textblock"] = 'textblock'] = "Textblock";
733
+ })(OpenaiElementTypeEnum = Experiment.OpenaiElementTypeEnum || (Experiment.OpenaiElementTypeEnum = {}));
724
734
  /**
725
735
  * @export
726
736
  * @enum {string}
@@ -1332,23 +1342,6 @@ var ReportDataSetSchema;
1332
1342
  TypeEnum[TypeEnum["TIMESTAMP"] = 'TIMESTAMP'] = "TIMESTAMP";
1333
1343
  })(TypeEnum = ReportDataSetSchema.TypeEnum || (ReportDataSetSchema.TypeEnum = {}));
1334
1344
  })(ReportDataSetSchema = exports.ReportDataSetSchema || (exports.ReportDataSetSchema = {}));
1335
- /**
1336
- * @export
1337
- * @namespace ReportDataSetSummary
1338
- */
1339
- var ReportDataSetSummary;
1340
- (function (ReportDataSetSummary) {
1341
- /**
1342
- * @export
1343
- * @enum {string}
1344
- */
1345
- var ForObjectTypeEnum;
1346
- (function (ForObjectTypeEnum) {
1347
- ForObjectTypeEnum[ForObjectTypeEnum["Schema"] = 'schema'] = "Schema";
1348
- ForObjectTypeEnum[ForObjectTypeEnum["Filter"] = 'filter'] = "Filter";
1349
- ForObjectTypeEnum[ForObjectTypeEnum["Visualization"] = 'visualization'] = "Visualization";
1350
- })(ForObjectTypeEnum = ReportDataSetSummary.ForObjectTypeEnum || (ReportDataSetSummary.ForObjectTypeEnum = {}));
1351
- })(ReportDataSetSummary = exports.ReportDataSetSummary || (exports.ReportDataSetSummary = {}));
1352
1345
  /**
1353
1346
  * @export
1354
1347
  * @namespace ReportDataSourceSchema
@@ -13666,6 +13659,54 @@ var DatawarehouseApiFetchParamCreator = function (configuration) {
13666
13659
  options: localVarRequestOptions,
13667
13660
  };
13668
13661
  },
13662
+ /**
13663
+ * Dry run the report queries
13664
+ * @summary Dry run the report queries
13665
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
13666
+ * @param {*} [options] Override http request option.
13667
+ * @throws {RequiredError}
13668
+ */
13669
+ dryRunReportQueries: function (query_request, options) {
13670
+ if (options === void 0) { options = {}; }
13671
+ // verify required parameter 'query_request' is not null or undefined
13672
+ if (query_request === null || query_request === undefined) {
13673
+ throw new RequiredError('query_request', 'Required parameter query_request was null or undefined when calling dryRunReportQueries.');
13674
+ }
13675
+ var localVarPath = "/datawarehouse/reports/dryrun";
13676
+ var localVarUrlObj = url.parse(localVarPath, true);
13677
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
13678
+ var localVarHeaderParameter = {};
13679
+ var localVarQueryParameter = {};
13680
+ if (configuration && configuration.apiVersion) {
13681
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
13682
+ }
13683
+ // authentication ultraCartOauth required
13684
+ // oauth required
13685
+ if (configuration && configuration.accessToken) {
13686
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
13687
+ ? configuration.accessToken("ultraCartOauth", [])
13688
+ : configuration.accessToken;
13689
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
13690
+ }
13691
+ // authentication ultraCartSimpleApiKey required
13692
+ if (configuration && configuration.apiKey) {
13693
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
13694
+ ? configuration.apiKey("x-ultracart-simple-key")
13695
+ : configuration.apiKey;
13696
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
13697
+ }
13698
+ localVarHeaderParameter['Content-Type'] = 'application/json';
13699
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
13700
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
13701
+ delete localVarUrlObj.search;
13702
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
13703
+ var needsSerialization = ("ReportDryRunQueriesRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
13704
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(query_request || {}) : (query_request || "");
13705
+ return {
13706
+ url: url.format(localVarUrlObj),
13707
+ options: localVarRequestOptions,
13708
+ };
13709
+ },
13669
13710
  /**
13670
13711
  * Execute the report queries
13671
13712
  * @summary Execute the report queries
@@ -14071,6 +14112,28 @@ var DatawarehouseApiFp = function (configuration) {
14071
14112
  });
14072
14113
  };
14073
14114
  },
14115
+ /**
14116
+ * Dry run the report queries
14117
+ * @summary Dry run the report queries
14118
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
14119
+ * @param {*} [options] Override http request option.
14120
+ * @throws {RequiredError}
14121
+ */
14122
+ dryRunReportQueries: function (query_request, options) {
14123
+ var localVarFetchArgs = (0, exports.DatawarehouseApiFetchParamCreator)(configuration).dryRunReportQueries(query_request, options);
14124
+ return function (fetch, basePath) {
14125
+ if (fetch === void 0) { fetch = portableFetch; }
14126
+ if (basePath === void 0) { basePath = BASE_PATH; }
14127
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
14128
+ if (response.status >= 200 && response.status < 300) {
14129
+ return response.json();
14130
+ }
14131
+ else {
14132
+ throw response;
14133
+ }
14134
+ });
14135
+ };
14136
+ },
14074
14137
  /**
14075
14138
  * Execute the report queries
14076
14139
  * @summary Execute the report queries
@@ -14266,6 +14329,16 @@ var DatawarehouseApiFactory = function (configuration, fetch, basePath) {
14266
14329
  deleteReport: function (report_oid, options) {
14267
14330
  return (0, exports.DatawarehouseApiFp)(configuration).deleteReport(report_oid, options)(fetch, basePath);
14268
14331
  },
14332
+ /**
14333
+ * Dry run the report queries
14334
+ * @summary Dry run the report queries
14335
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
14336
+ * @param {*} [options] Override http request option.
14337
+ * @throws {RequiredError}
14338
+ */
14339
+ dryRunReportQueries: function (query_request, options) {
14340
+ return (0, exports.DatawarehouseApiFp)(configuration).dryRunReportQueries(query_request, options)(fetch, basePath);
14341
+ },
14269
14342
  /**
14270
14343
  * Execute the report queries
14271
14344
  * @summary Execute the report queries
@@ -14371,6 +14444,17 @@ var DatawarehouseApi = /** @class */ (function (_super) {
14371
14444
  DatawarehouseApi.prototype.deleteReport = function (report_oid, options) {
14372
14445
  return (0, exports.DatawarehouseApiFp)(this.configuration).deleteReport(report_oid, options)(this.fetch, this.basePath);
14373
14446
  };
14447
+ /**
14448
+ * Dry run the report queries
14449
+ * @summary Dry run the report queries
14450
+ * @param {ReportDryRunQueriesRequest} query_request Dry run request
14451
+ * @param {*} [options] Override http request option.
14452
+ * @throws {RequiredError}
14453
+ * @memberof DatawarehouseApi
14454
+ */
14455
+ DatawarehouseApi.prototype.dryRunReportQueries = function (query_request, options) {
14456
+ return (0, exports.DatawarehouseApiFp)(this.configuration).dryRunReportQueries(query_request, options)(this.fetch, this.basePath);
14457
+ };
14374
14458
  /**
14375
14459
  * Execute the report queries
14376
14460
  * @summary Execute the report queries
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.126",
3
+ "version": "3.10.128",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [