ultracart_rest_api_v2_typescript 3.11.11 → 3.11.13

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.11.11
1
+ ## ultracart_rest_api_v2_typescript@3.11.13
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install ultracart_rest_api_v2_typescript@3.11.11 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.11.13 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.11.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |
58
+ | 3.11.12 | 05/19/2025 | conversations - AI agent capabilities method |
57
59
  | 3.11.11 | 05/19/2025 | conversations - virtual AI budgets |
58
60
  | 3.11.10 | 05/06/2025 | conversation - ConversationAgentProfile.user_id added for agent profiles call |
59
61
  | 3.11.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
package/api.ts CHANGED
@@ -7138,6 +7138,18 @@ export interface Conversation {
7138
7138
  * @memberof Conversation
7139
7139
  */
7140
7140
  unread_messages?: boolean;
7141
+ /**
7142
+ * True if a virtual agent answered the conversation
7143
+ * @type {boolean}
7144
+ * @memberof Conversation
7145
+ */
7146
+ virtual_agent?: boolean;
7147
+ /**
7148
+ * The cost of this conversation performed by the virtual agent
7149
+ * @type {number}
7150
+ * @memberof Conversation
7151
+ */
7152
+ virtual_agent_cost?: number;
7141
7153
  /**
7142
7154
  *
7143
7155
  * @type {boolean}
@@ -11311,6 +11323,106 @@ export interface ConversationVirtualAgentBudgetResponse {
11311
11323
  warning?: Warning;
11312
11324
  }
11313
11325
 
11326
+ /**
11327
+ *
11328
+ * @export
11329
+ * @interface ConversationVirtualAgentCapabilities
11330
+ */
11331
+ export interface ConversationVirtualAgentCapabilities {
11332
+ /**
11333
+ *
11334
+ * @type {boolean}
11335
+ * @memberof ConversationVirtualAgentCapabilities
11336
+ */
11337
+ cancel_subscription?: boolean;
11338
+ /**
11339
+ *
11340
+ * @type {boolean}
11341
+ * @memberof ConversationVirtualAgentCapabilities
11342
+ */
11343
+ delay_subscription?: boolean;
11344
+ /**
11345
+ *
11346
+ * @type {boolean}
11347
+ * @memberof ConversationVirtualAgentCapabilities
11348
+ */
11349
+ lookup_order_information?: boolean;
11350
+ /**
11351
+ *
11352
+ * @type {boolean}
11353
+ * @memberof ConversationVirtualAgentCapabilities
11354
+ */
11355
+ lookup_subscription_information?: boolean;
11356
+ /**
11357
+ *
11358
+ * @type {boolean}
11359
+ * @memberof ConversationVirtualAgentCapabilities
11360
+ */
11361
+ open_support_ticket?: boolean;
11362
+ /**
11363
+ *
11364
+ * @type {boolean}
11365
+ * @memberof ConversationVirtualAgentCapabilities
11366
+ */
11367
+ pause_subscription?: boolean;
11368
+ /**
11369
+ *
11370
+ * @type {boolean}
11371
+ * @memberof ConversationVirtualAgentCapabilities
11372
+ */
11373
+ resume_subscription?: boolean;
11374
+ /**
11375
+ *
11376
+ * @type {boolean}
11377
+ * @memberof ConversationVirtualAgentCapabilities
11378
+ */
11379
+ transfer_chat_to_live_agent?: boolean;
11380
+ /**
11381
+ *
11382
+ * @type {boolean}
11383
+ * @memberof ConversationVirtualAgentCapabilities
11384
+ */
11385
+ update_subscription_credit_card?: boolean;
11386
+ }
11387
+
11388
+ /**
11389
+ *
11390
+ * @export
11391
+ * @interface ConversationVirtualAgentCapabilitiesResponse
11392
+ */
11393
+ export interface ConversationVirtualAgentCapabilitiesResponse {
11394
+ /**
11395
+ *
11396
+ * @type {ConversationVirtualAgentCapabilities}
11397
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11398
+ */
11399
+ capabilities?: ConversationVirtualAgentCapabilities;
11400
+ /**
11401
+ *
11402
+ * @type {ModelError}
11403
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11404
+ */
11405
+ error?: ModelError;
11406
+ /**
11407
+ *
11408
+ * @type {ResponseMetadata}
11409
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11410
+ */
11411
+ metadata?: ResponseMetadata;
11412
+ /**
11413
+ * Indicates if API call was successful
11414
+ * @type {boolean}
11415
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11416
+ */
11417
+ success?: boolean;
11418
+ /**
11419
+ *
11420
+ * @type {Warning}
11421
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11422
+ */
11423
+ warning?: Warning;
11424
+ }
11425
+
11314
11426
  /**
11315
11427
  *
11316
11428
  * @export
@@ -29320,6 +29432,12 @@ export interface ItemRestriction {
29320
29432
  * @memberof ItemRestriction
29321
29433
  */
29322
29434
  exclude_from_free_promotion?: boolean;
29435
+ /**
29436
+ * Exclude from loyalty. Must be set to true or false to save. Null is ignored for backwards SDK compatibility
29437
+ * @type {boolean}
29438
+ * @memberof ItemRestriction
29439
+ */
29440
+ exclude_from_loyalty?: boolean;
29323
29441
  /**
29324
29442
  * Items
29325
29443
  * @type {Array<ItemRestrictionItem>}
@@ -54918,6 +55036,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
54918
55036
 
54919
55037
 
54920
55038
 
55039
+ // authentication ultraCartOauth required
55040
+ // oauth required
55041
+ if (configuration && configuration.accessToken) {
55042
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
55043
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
55044
+ : configuration.accessToken;
55045
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
55046
+ }
55047
+
55048
+ // authentication ultraCartSimpleApiKey required
55049
+ if (configuration && configuration.apiKey) {
55050
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
55051
+ ? configuration.apiKey("x-ultracart-simple-key")
55052
+ : configuration.apiKey;
55053
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
55054
+ }
55055
+
55056
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
55057
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
55058
+ delete localVarUrlObj.search;
55059
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
55060
+
55061
+ return {
55062
+ url: url.format(localVarUrlObj),
55063
+ options: localVarRequestOptions,
55064
+ };
55065
+ },
55066
+ /**
55067
+ * Retrieve virtual agent capabilities
55068
+ * @summary Get virtual agent capabilities
55069
+ * @param {*} [options] Override http request option.
55070
+ * @throws {RequiredError}
55071
+ */
55072
+ getVirtualAgentCapabilities(options: any = {}): FetchArgs {
55073
+ const localVarPath = `/conversation/virtualagent/capabilities`;
55074
+ const localVarUrlObj = url.parse(localVarPath, true);
55075
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
55076
+ const localVarHeaderParameter = {} as any;
55077
+ const localVarQueryParameter = {} as any;
55078
+
55079
+ if(configuration && configuration.apiVersion) {
55080
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
55081
+ }
55082
+
55083
+
55084
+
54921
55085
  // authentication ultraCartOauth required
54922
55086
  // oauth required
54923
55087
  if (configuration && configuration.accessToken) {
@@ -56762,6 +56926,61 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
56762
56926
  const needsSerialization = (<any>"ConversationVirtualAgentBudget" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
56763
56927
  localVarRequestOptions.body = needsSerialization ? JSON.stringify(virtual_agent_budget || {}) : (virtual_agent_budget || "");
56764
56928
 
56929
+ return {
56930
+ url: url.format(localVarUrlObj),
56931
+ options: localVarRequestOptions,
56932
+ };
56933
+ },
56934
+ /**
56935
+ * Update virtual agent capabilities
56936
+ * @summary Update virtual agent capabilities
56937
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
56938
+ * @param {*} [options] Override http request option.
56939
+ * @throws {RequiredError}
56940
+ */
56941
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options: any = {}): FetchArgs {
56942
+ // verify required parameter 'virtual_agent_capabilities' is not null or undefined
56943
+ if (virtual_agent_capabilities === null || virtual_agent_capabilities === undefined) {
56944
+ throw new RequiredError('virtual_agent_capabilities','Required parameter virtual_agent_capabilities was null or undefined when calling updateVirtualAgentCapabilities.');
56945
+ }
56946
+ const localVarPath = `/conversation/virtualagent/capabilities`;
56947
+ const localVarUrlObj = url.parse(localVarPath, true);
56948
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
56949
+ const localVarHeaderParameter = {} as any;
56950
+ const localVarQueryParameter = {} as any;
56951
+
56952
+ if(configuration && configuration.apiVersion) {
56953
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
56954
+ }
56955
+
56956
+
56957
+
56958
+ // authentication ultraCartOauth required
56959
+ // oauth required
56960
+ if (configuration && configuration.accessToken) {
56961
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
56962
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
56963
+ : configuration.accessToken;
56964
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
56965
+ }
56966
+
56967
+ // authentication ultraCartSimpleApiKey required
56968
+ if (configuration && configuration.apiKey) {
56969
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
56970
+ ? configuration.apiKey("x-ultracart-simple-key")
56971
+ : configuration.apiKey;
56972
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
56973
+ }
56974
+
56975
+ localVarHeaderParameter['Content-Type'] = 'application/json';
56976
+
56977
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
56978
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
56979
+ delete localVarUrlObj.search;
56980
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
56981
+ const needsSerialization = (<any>"ConversationVirtualAgentCapabilities" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
56982
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(virtual_agent_capabilities || {}) : (virtual_agent_capabilities || "");
56983
+
56765
56984
  return {
56766
56985
  url: url.format(localVarUrlObj),
56767
56986
  options: localVarRequestOptions,
@@ -57897,6 +58116,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
57897
58116
  });
57898
58117
  };
57899
58118
  },
58119
+ /**
58120
+ * Retrieve virtual agent capabilities
58121
+ * @summary Get virtual agent capabilities
58122
+ * @param {*} [options] Override http request option.
58123
+ * @throws {RequiredError}
58124
+ */
58125
+ getVirtualAgentCapabilities(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationVirtualAgentCapabilitiesResponse> {
58126
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getVirtualAgentCapabilities(options);
58127
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
58128
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
58129
+
58130
+ if (response.status >= 200 && response.status < 300) {
58131
+ return response.json();
58132
+
58133
+ } else {
58134
+ throw response;
58135
+ }
58136
+ });
58137
+ };
58138
+ },
57900
58139
  /**
57901
58140
  * Insert a canned message
57902
58141
  * @summary Insert a canned message
@@ -58583,6 +58822,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
58583
58822
  });
58584
58823
  };
58585
58824
  },
58825
+ /**
58826
+ * Update virtual agent capabilities
58827
+ * @summary Update virtual agent capabilities
58828
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
58829
+ * @param {*} [options] Override http request option.
58830
+ * @throws {RequiredError}
58831
+ */
58832
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationVirtualAgentCapabilitiesResponse> {
58833
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).updateVirtualAgentCapabilities(virtual_agent_capabilities, options);
58834
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
58835
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
58836
+
58837
+ if (response.status >= 200 && response.status < 300) {
58838
+ return response.json();
58839
+
58840
+ } else {
58841
+ throw response;
58842
+ }
58843
+ });
58844
+ };
58845
+ },
58586
58846
  }
58587
58847
  };
58588
58848
 
@@ -59119,6 +59379,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
59119
59379
  getVirtualAgentBudget(options?: any) {
59120
59380
  return ConversationApiFp(configuration).getVirtualAgentBudget(options)(fetch, basePath);
59121
59381
  },
59382
+ /**
59383
+ * Retrieve virtual agent capabilities
59384
+ * @summary Get virtual agent capabilities
59385
+ * @param {*} [options] Override http request option.
59386
+ * @throws {RequiredError}
59387
+ */
59388
+ getVirtualAgentCapabilities(options?: any) {
59389
+ return ConversationApiFp(configuration).getVirtualAgentCapabilities(options)(fetch, basePath);
59390
+ },
59122
59391
  /**
59123
59392
  * Insert a canned message
59124
59393
  * @summary Insert a canned message
@@ -59453,6 +59722,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
59453
59722
  updateVirtualAgentBudget(virtual_agent_budget: ConversationVirtualAgentBudget, options?: any) {
59454
59723
  return ConversationApiFp(configuration).updateVirtualAgentBudget(virtual_agent_budget, options)(fetch, basePath);
59455
59724
  },
59725
+ /**
59726
+ * Update virtual agent capabilities
59727
+ * @summary Update virtual agent capabilities
59728
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
59729
+ * @param {*} [options] Override http request option.
59730
+ * @throws {RequiredError}
59731
+ */
59732
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any) {
59733
+ return ConversationApiFp(configuration).updateVirtualAgentCapabilities(virtual_agent_capabilities, options)(fetch, basePath);
59734
+ },
59456
59735
  };
59457
59736
  };
59458
59737
 
@@ -59989,6 +60268,15 @@ export interface ConversationApiInterface {
59989
60268
  */
59990
60269
  getVirtualAgentBudget(options?: any): Promise<ConversationVirtualAgentBudgetResponse>;
59991
60270
 
60271
+ /**
60272
+ * Retrieve virtual agent capabilities
60273
+ * @summary Get virtual agent capabilities
60274
+ * @param {*} [options] Override http request option.
60275
+ * @throws {RequiredError}
60276
+ * @memberof ConversationApiInterface
60277
+ */
60278
+ getVirtualAgentCapabilities(options?: any): Promise<ConversationVirtualAgentCapabilitiesResponse>;
60279
+
59992
60280
  /**
59993
60281
  * Insert a canned message
59994
60282
  * @summary Insert a canned message
@@ -60323,6 +60611,16 @@ export interface ConversationApiInterface {
60323
60611
  */
60324
60612
  updateVirtualAgentBudget(virtual_agent_budget: ConversationVirtualAgentBudget, options?: any): Promise<ConversationVirtualAgentBudgetResponse>;
60325
60613
 
60614
+ /**
60615
+ * Update virtual agent capabilities
60616
+ * @summary Update virtual agent capabilities
60617
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
60618
+ * @param {*} [options] Override http request option.
60619
+ * @throws {RequiredError}
60620
+ * @memberof ConversationApiInterface
60621
+ */
60622
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any): Promise<ConversationVirtualAgentCapabilitiesResponse>;
60623
+
60326
60624
  }
60327
60625
 
60328
60626
  /**
@@ -60967,6 +61265,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
60967
61265
  return ConversationApiFp(this.configuration).getVirtualAgentBudget(options)(this.fetch, this.basePath);
60968
61266
  }
60969
61267
 
61268
+ /**
61269
+ * Retrieve virtual agent capabilities
61270
+ * @summary Get virtual agent capabilities
61271
+ * @param {*} [options] Override http request option.
61272
+ * @throws {RequiredError}
61273
+ * @memberof ConversationApi
61274
+ */
61275
+ public getVirtualAgentCapabilities(options?: any) {
61276
+ return ConversationApiFp(this.configuration).getVirtualAgentCapabilities(options)(this.fetch, this.basePath);
61277
+ }
61278
+
60970
61279
  /**
60971
61280
  * Insert a canned message
60972
61281
  * @summary Insert a canned message
@@ -61365,6 +61674,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
61365
61674
  return ConversationApiFp(this.configuration).updateVirtualAgentBudget(virtual_agent_budget, options)(this.fetch, this.basePath);
61366
61675
  }
61367
61676
 
61677
+ /**
61678
+ * Update virtual agent capabilities
61679
+ * @summary Update virtual agent capabilities
61680
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
61681
+ * @param {*} [options] Override http request option.
61682
+ * @throws {RequiredError}
61683
+ * @memberof ConversationApi
61684
+ */
61685
+ public updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any) {
61686
+ return ConversationApiFp(this.configuration).updateVirtualAgentCapabilities(virtual_agent_capabilities, options)(this.fetch, this.basePath);
61687
+ }
61688
+
61368
61689
  }
61369
61690
 
61370
61691
  /**
package/dist/api.d.ts CHANGED
@@ -6978,6 +6978,18 @@ export interface Conversation {
6978
6978
  * @memberof Conversation
6979
6979
  */
6980
6980
  unread_messages?: boolean;
6981
+ /**
6982
+ * True if a virtual agent answered the conversation
6983
+ * @type {boolean}
6984
+ * @memberof Conversation
6985
+ */
6986
+ virtual_agent?: boolean;
6987
+ /**
6988
+ * The cost of this conversation performed by the virtual agent
6989
+ * @type {number}
6990
+ * @memberof Conversation
6991
+ */
6992
+ virtual_agent_cost?: number;
6981
6993
  /**
6982
6994
  *
6983
6995
  * @type {boolean}
@@ -11042,6 +11054,104 @@ export interface ConversationVirtualAgentBudgetResponse {
11042
11054
  */
11043
11055
  warning?: Warning;
11044
11056
  }
11057
+ /**
11058
+ *
11059
+ * @export
11060
+ * @interface ConversationVirtualAgentCapabilities
11061
+ */
11062
+ export interface ConversationVirtualAgentCapabilities {
11063
+ /**
11064
+ *
11065
+ * @type {boolean}
11066
+ * @memberof ConversationVirtualAgentCapabilities
11067
+ */
11068
+ cancel_subscription?: boolean;
11069
+ /**
11070
+ *
11071
+ * @type {boolean}
11072
+ * @memberof ConversationVirtualAgentCapabilities
11073
+ */
11074
+ delay_subscription?: boolean;
11075
+ /**
11076
+ *
11077
+ * @type {boolean}
11078
+ * @memberof ConversationVirtualAgentCapabilities
11079
+ */
11080
+ lookup_order_information?: boolean;
11081
+ /**
11082
+ *
11083
+ * @type {boolean}
11084
+ * @memberof ConversationVirtualAgentCapabilities
11085
+ */
11086
+ lookup_subscription_information?: boolean;
11087
+ /**
11088
+ *
11089
+ * @type {boolean}
11090
+ * @memberof ConversationVirtualAgentCapabilities
11091
+ */
11092
+ open_support_ticket?: boolean;
11093
+ /**
11094
+ *
11095
+ * @type {boolean}
11096
+ * @memberof ConversationVirtualAgentCapabilities
11097
+ */
11098
+ pause_subscription?: boolean;
11099
+ /**
11100
+ *
11101
+ * @type {boolean}
11102
+ * @memberof ConversationVirtualAgentCapabilities
11103
+ */
11104
+ resume_subscription?: boolean;
11105
+ /**
11106
+ *
11107
+ * @type {boolean}
11108
+ * @memberof ConversationVirtualAgentCapabilities
11109
+ */
11110
+ transfer_chat_to_live_agent?: boolean;
11111
+ /**
11112
+ *
11113
+ * @type {boolean}
11114
+ * @memberof ConversationVirtualAgentCapabilities
11115
+ */
11116
+ update_subscription_credit_card?: boolean;
11117
+ }
11118
+ /**
11119
+ *
11120
+ * @export
11121
+ * @interface ConversationVirtualAgentCapabilitiesResponse
11122
+ */
11123
+ export interface ConversationVirtualAgentCapabilitiesResponse {
11124
+ /**
11125
+ *
11126
+ * @type {ConversationVirtualAgentCapabilities}
11127
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11128
+ */
11129
+ capabilities?: ConversationVirtualAgentCapabilities;
11130
+ /**
11131
+ *
11132
+ * @type {ModelError}
11133
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11134
+ */
11135
+ error?: ModelError;
11136
+ /**
11137
+ *
11138
+ * @type {ResponseMetadata}
11139
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11140
+ */
11141
+ metadata?: ResponseMetadata;
11142
+ /**
11143
+ * Indicates if API call was successful
11144
+ * @type {boolean}
11145
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11146
+ */
11147
+ success?: boolean;
11148
+ /**
11149
+ *
11150
+ * @type {Warning}
11151
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
11152
+ */
11153
+ warning?: Warning;
11154
+ }
11045
11155
  /**
11046
11156
  *
11047
11157
  * @export
@@ -28698,6 +28808,12 @@ export interface ItemRestriction {
28698
28808
  * @memberof ItemRestriction
28699
28809
  */
28700
28810
  exclude_from_free_promotion?: boolean;
28811
+ /**
28812
+ * Exclude from loyalty. Must be set to true or false to save. Null is ignored for backwards SDK compatibility
28813
+ * @type {boolean}
28814
+ * @memberof ItemRestriction
28815
+ */
28816
+ exclude_from_loyalty?: boolean;
28701
28817
  /**
28702
28818
  * Items
28703
28819
  * @type {Array<ItemRestrictionItem>}
@@ -47758,6 +47874,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
47758
47874
  * @throws {RequiredError}
47759
47875
  */
47760
47876
  getVirtualAgentBudget(options?: any): FetchArgs;
47877
+ /**
47878
+ * Retrieve virtual agent capabilities
47879
+ * @summary Get virtual agent capabilities
47880
+ * @param {*} [options] Override http request option.
47881
+ * @throws {RequiredError}
47882
+ */
47883
+ getVirtualAgentCapabilities(options?: any): FetchArgs;
47761
47884
  /**
47762
47885
  * Insert a canned message
47763
47886
  * @summary Insert a canned message
@@ -48028,6 +48151,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
48028
48151
  * @throws {RequiredError}
48029
48152
  */
48030
48153
  updateVirtualAgentBudget(virtual_agent_budget: ConversationVirtualAgentBudget, options?: any): FetchArgs;
48154
+ /**
48155
+ * Update virtual agent capabilities
48156
+ * @summary Update virtual agent capabilities
48157
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
48158
+ * @param {*} [options] Override http request option.
48159
+ * @throws {RequiredError}
48160
+ */
48161
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any): FetchArgs;
48031
48162
  };
48032
48163
  /**
48033
48164
  * ConversationApi - functional programming interface
@@ -48453,6 +48584,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
48453
48584
  * @throws {RequiredError}
48454
48585
  */
48455
48586
  getVirtualAgentBudget(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationVirtualAgentBudgetResponse>;
48587
+ /**
48588
+ * Retrieve virtual agent capabilities
48589
+ * @summary Get virtual agent capabilities
48590
+ * @param {*} [options] Override http request option.
48591
+ * @throws {RequiredError}
48592
+ */
48593
+ getVirtualAgentCapabilities(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationVirtualAgentCapabilitiesResponse>;
48456
48594
  /**
48457
48595
  * Insert a canned message
48458
48596
  * @summary Insert a canned message
@@ -48723,6 +48861,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
48723
48861
  * @throws {RequiredError}
48724
48862
  */
48725
48863
  updateVirtualAgentBudget(virtual_agent_budget: ConversationVirtualAgentBudget, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationVirtualAgentBudgetResponse>;
48864
+ /**
48865
+ * Update virtual agent capabilities
48866
+ * @summary Update virtual agent capabilities
48867
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
48868
+ * @param {*} [options] Override http request option.
48869
+ * @throws {RequiredError}
48870
+ */
48871
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationVirtualAgentCapabilitiesResponse>;
48726
48872
  };
48727
48873
  /**
48728
48874
  * ConversationApi - factory interface
@@ -49148,6 +49294,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
49148
49294
  * @throws {RequiredError}
49149
49295
  */
49150
49296
  getVirtualAgentBudget(options?: any): Promise<ConversationVirtualAgentBudgetResponse>;
49297
+ /**
49298
+ * Retrieve virtual agent capabilities
49299
+ * @summary Get virtual agent capabilities
49300
+ * @param {*} [options] Override http request option.
49301
+ * @throws {RequiredError}
49302
+ */
49303
+ getVirtualAgentCapabilities(options?: any): Promise<ConversationVirtualAgentCapabilitiesResponse>;
49151
49304
  /**
49152
49305
  * Insert a canned message
49153
49306
  * @summary Insert a canned message
@@ -49418,6 +49571,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
49418
49571
  * @throws {RequiredError}
49419
49572
  */
49420
49573
  updateVirtualAgentBudget(virtual_agent_budget: ConversationVirtualAgentBudget, options?: any): Promise<ConversationVirtualAgentBudgetResponse>;
49574
+ /**
49575
+ * Update virtual agent capabilities
49576
+ * @summary Update virtual agent capabilities
49577
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
49578
+ * @param {*} [options] Override http request option.
49579
+ * @throws {RequiredError}
49580
+ */
49581
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any): Promise<ConversationVirtualAgentCapabilitiesResponse>;
49421
49582
  };
49422
49583
  /**
49423
49584
  * ConversationApi - interface
@@ -49898,6 +50059,14 @@ export interface ConversationApiInterface {
49898
50059
  * @memberof ConversationApiInterface
49899
50060
  */
49900
50061
  getVirtualAgentBudget(options?: any): Promise<ConversationVirtualAgentBudgetResponse>;
50062
+ /**
50063
+ * Retrieve virtual agent capabilities
50064
+ * @summary Get virtual agent capabilities
50065
+ * @param {*} [options] Override http request option.
50066
+ * @throws {RequiredError}
50067
+ * @memberof ConversationApiInterface
50068
+ */
50069
+ getVirtualAgentCapabilities(options?: any): Promise<ConversationVirtualAgentCapabilitiesResponse>;
49901
50070
  /**
49902
50071
  * Insert a canned message
49903
50072
  * @summary Insert a canned message
@@ -50200,6 +50369,15 @@ export interface ConversationApiInterface {
50200
50369
  * @memberof ConversationApiInterface
50201
50370
  */
50202
50371
  updateVirtualAgentBudget(virtual_agent_budget: ConversationVirtualAgentBudget, options?: any): Promise<ConversationVirtualAgentBudgetResponse>;
50372
+ /**
50373
+ * Update virtual agent capabilities
50374
+ * @summary Update virtual agent capabilities
50375
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
50376
+ * @param {*} [options] Override http request option.
50377
+ * @throws {RequiredError}
50378
+ * @memberof ConversationApiInterface
50379
+ */
50380
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any): Promise<ConversationVirtualAgentCapabilitiesResponse>;
50203
50381
  }
50204
50382
  /**
50205
50383
  * ConversationApi - object-oriented interface
@@ -50681,6 +50859,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
50681
50859
  * @memberof ConversationApi
50682
50860
  */
50683
50861
  getVirtualAgentBudget(options?: any): Promise<ConversationVirtualAgentBudgetResponse>;
50862
+ /**
50863
+ * Retrieve virtual agent capabilities
50864
+ * @summary Get virtual agent capabilities
50865
+ * @param {*} [options] Override http request option.
50866
+ * @throws {RequiredError}
50867
+ * @memberof ConversationApi
50868
+ */
50869
+ getVirtualAgentCapabilities(options?: any): Promise<ConversationVirtualAgentCapabilitiesResponse>;
50684
50870
  /**
50685
50871
  * Insert a canned message
50686
50872
  * @summary Insert a canned message
@@ -50983,6 +51169,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
50983
51169
  * @memberof ConversationApi
50984
51170
  */
50985
51171
  updateVirtualAgentBudget(virtual_agent_budget: ConversationVirtualAgentBudget, options?: any): Promise<ConversationVirtualAgentBudgetResponse>;
51172
+ /**
51173
+ * Update virtual agent capabilities
51174
+ * @summary Update virtual agent capabilities
51175
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
51176
+ * @param {*} [options] Override http request option.
51177
+ * @throws {RequiredError}
51178
+ * @memberof ConversationApi
51179
+ */
51180
+ updateVirtualAgentCapabilities(virtual_agent_capabilities: ConversationVirtualAgentCapabilities, options?: any): Promise<ConversationVirtualAgentCapabilitiesResponse>;
50986
51181
  }
50987
51182
  /**
50988
51183
  * CouponApi - fetch parameter creator
package/dist/api.js CHANGED
@@ -9959,6 +9959,46 @@ var ConversationApiFetchParamCreator = function (configuration) {
9959
9959
  options: localVarRequestOptions,
9960
9960
  };
9961
9961
  },
9962
+ /**
9963
+ * Retrieve virtual agent capabilities
9964
+ * @summary Get virtual agent capabilities
9965
+ * @param {*} [options] Override http request option.
9966
+ * @throws {RequiredError}
9967
+ */
9968
+ getVirtualAgentCapabilities: function (options) {
9969
+ if (options === void 0) { options = {}; }
9970
+ var localVarPath = "/conversation/virtualagent/capabilities";
9971
+ var localVarUrlObj = url.parse(localVarPath, true);
9972
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
9973
+ var localVarHeaderParameter = {};
9974
+ var localVarQueryParameter = {};
9975
+ if (configuration && configuration.apiVersion) {
9976
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
9977
+ }
9978
+ // authentication ultraCartOauth required
9979
+ // oauth required
9980
+ if (configuration && configuration.accessToken) {
9981
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
9982
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
9983
+ : configuration.accessToken;
9984
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
9985
+ }
9986
+ // authentication ultraCartSimpleApiKey required
9987
+ if (configuration && configuration.apiKey) {
9988
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
9989
+ ? configuration.apiKey("x-ultracart-simple-key")
9990
+ : configuration.apiKey;
9991
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
9992
+ }
9993
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
9994
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
9995
+ delete localVarUrlObj.search;
9996
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
9997
+ return {
9998
+ url: url.format(localVarUrlObj),
9999
+ options: localVarRequestOptions,
10000
+ };
10001
+ },
9962
10002
  /**
9963
10003
  * Insert a canned message
9964
10004
  * @summary Insert a canned message
@@ -11563,6 +11603,54 @@ var ConversationApiFetchParamCreator = function (configuration) {
11563
11603
  options: localVarRequestOptions,
11564
11604
  };
11565
11605
  },
11606
+ /**
11607
+ * Update virtual agent capabilities
11608
+ * @summary Update virtual agent capabilities
11609
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
11610
+ * @param {*} [options] Override http request option.
11611
+ * @throws {RequiredError}
11612
+ */
11613
+ updateVirtualAgentCapabilities: function (virtual_agent_capabilities, options) {
11614
+ if (options === void 0) { options = {}; }
11615
+ // verify required parameter 'virtual_agent_capabilities' is not null or undefined
11616
+ if (virtual_agent_capabilities === null || virtual_agent_capabilities === undefined) {
11617
+ throw new RequiredError('virtual_agent_capabilities', 'Required parameter virtual_agent_capabilities was null or undefined when calling updateVirtualAgentCapabilities.');
11618
+ }
11619
+ var localVarPath = "/conversation/virtualagent/capabilities";
11620
+ var localVarUrlObj = url.parse(localVarPath, true);
11621
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
11622
+ var localVarHeaderParameter = {};
11623
+ var localVarQueryParameter = {};
11624
+ if (configuration && configuration.apiVersion) {
11625
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
11626
+ }
11627
+ // authentication ultraCartOauth required
11628
+ // oauth required
11629
+ if (configuration && configuration.accessToken) {
11630
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
11631
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
11632
+ : configuration.accessToken;
11633
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
11634
+ }
11635
+ // authentication ultraCartSimpleApiKey required
11636
+ if (configuration && configuration.apiKey) {
11637
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
11638
+ ? configuration.apiKey("x-ultracart-simple-key")
11639
+ : configuration.apiKey;
11640
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
11641
+ }
11642
+ localVarHeaderParameter['Content-Type'] = 'application/json';
11643
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
11644
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
11645
+ delete localVarUrlObj.search;
11646
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
11647
+ var needsSerialization = ("ConversationVirtualAgentCapabilities" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
11648
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(virtual_agent_capabilities || {}) : (virtual_agent_capabilities || "");
11649
+ return {
11650
+ url: url.format(localVarUrlObj),
11651
+ options: localVarRequestOptions,
11652
+ };
11653
+ },
11566
11654
  };
11567
11655
  };
11568
11656
  exports.ConversationApiFetchParamCreator = ConversationApiFetchParamCreator;
@@ -12747,6 +12835,27 @@ var ConversationApiFp = function (configuration) {
12747
12835
  });
12748
12836
  };
12749
12837
  },
12838
+ /**
12839
+ * Retrieve virtual agent capabilities
12840
+ * @summary Get virtual agent capabilities
12841
+ * @param {*} [options] Override http request option.
12842
+ * @throws {RequiredError}
12843
+ */
12844
+ getVirtualAgentCapabilities: function (options) {
12845
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getVirtualAgentCapabilities(options);
12846
+ return function (fetch, basePath) {
12847
+ if (fetch === void 0) { fetch = portableFetch; }
12848
+ if (basePath === void 0) { basePath = BASE_PATH; }
12849
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
12850
+ if (response.status >= 200 && response.status < 300) {
12851
+ return response.json();
12852
+ }
12853
+ else {
12854
+ throw response;
12855
+ }
12856
+ });
12857
+ };
12858
+ },
12750
12859
  /**
12751
12860
  * Insert a canned message
12752
12861
  * @summary Insert a canned message
@@ -13465,6 +13574,28 @@ var ConversationApiFp = function (configuration) {
13465
13574
  });
13466
13575
  };
13467
13576
  },
13577
+ /**
13578
+ * Update virtual agent capabilities
13579
+ * @summary Update virtual agent capabilities
13580
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
13581
+ * @param {*} [options] Override http request option.
13582
+ * @throws {RequiredError}
13583
+ */
13584
+ updateVirtualAgentCapabilities: function (virtual_agent_capabilities, options) {
13585
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).updateVirtualAgentCapabilities(virtual_agent_capabilities, options);
13586
+ return function (fetch, basePath) {
13587
+ if (fetch === void 0) { fetch = portableFetch; }
13588
+ if (basePath === void 0) { basePath = BASE_PATH; }
13589
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
13590
+ if (response.status >= 200 && response.status < 300) {
13591
+ return response.json();
13592
+ }
13593
+ else {
13594
+ throw response;
13595
+ }
13596
+ });
13597
+ };
13598
+ },
13468
13599
  };
13469
13600
  };
13470
13601
  exports.ConversationApiFp = ConversationApiFp;
@@ -14001,6 +14132,15 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
14001
14132
  getVirtualAgentBudget: function (options) {
14002
14133
  return (0, exports.ConversationApiFp)(configuration).getVirtualAgentBudget(options)(fetch, basePath);
14003
14134
  },
14135
+ /**
14136
+ * Retrieve virtual agent capabilities
14137
+ * @summary Get virtual agent capabilities
14138
+ * @param {*} [options] Override http request option.
14139
+ * @throws {RequiredError}
14140
+ */
14141
+ getVirtualAgentCapabilities: function (options) {
14142
+ return (0, exports.ConversationApiFp)(configuration).getVirtualAgentCapabilities(options)(fetch, basePath);
14143
+ },
14004
14144
  /**
14005
14145
  * Insert a canned message
14006
14146
  * @summary Insert a canned message
@@ -14335,6 +14475,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
14335
14475
  updateVirtualAgentBudget: function (virtual_agent_budget, options) {
14336
14476
  return (0, exports.ConversationApiFp)(configuration).updateVirtualAgentBudget(virtual_agent_budget, options)(fetch, basePath);
14337
14477
  },
14478
+ /**
14479
+ * Update virtual agent capabilities
14480
+ * @summary Update virtual agent capabilities
14481
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
14482
+ * @param {*} [options] Override http request option.
14483
+ * @throws {RequiredError}
14484
+ */
14485
+ updateVirtualAgentCapabilities: function (virtual_agent_capabilities, options) {
14486
+ return (0, exports.ConversationApiFp)(configuration).updateVirtualAgentCapabilities(virtual_agent_capabilities, options)(fetch, basePath);
14487
+ },
14338
14488
  };
14339
14489
  };
14340
14490
  exports.ConversationApiFactory = ConversationApiFactory;
@@ -14930,6 +15080,16 @@ var ConversationApi = /** @class */ (function (_super) {
14930
15080
  ConversationApi.prototype.getVirtualAgentBudget = function (options) {
14931
15081
  return (0, exports.ConversationApiFp)(this.configuration).getVirtualAgentBudget(options)(this.fetch, this.basePath);
14932
15082
  };
15083
+ /**
15084
+ * Retrieve virtual agent capabilities
15085
+ * @summary Get virtual agent capabilities
15086
+ * @param {*} [options] Override http request option.
15087
+ * @throws {RequiredError}
15088
+ * @memberof ConversationApi
15089
+ */
15090
+ ConversationApi.prototype.getVirtualAgentCapabilities = function (options) {
15091
+ return (0, exports.ConversationApiFp)(this.configuration).getVirtualAgentCapabilities(options)(this.fetch, this.basePath);
15092
+ };
14933
15093
  /**
14934
15094
  * Insert a canned message
14935
15095
  * @summary Insert a canned message
@@ -15296,6 +15456,17 @@ var ConversationApi = /** @class */ (function (_super) {
15296
15456
  ConversationApi.prototype.updateVirtualAgentBudget = function (virtual_agent_budget, options) {
15297
15457
  return (0, exports.ConversationApiFp)(this.configuration).updateVirtualAgentBudget(virtual_agent_budget, options)(this.fetch, this.basePath);
15298
15458
  };
15459
+ /**
15460
+ * Update virtual agent capabilities
15461
+ * @summary Update virtual agent capabilities
15462
+ * @param {ConversationVirtualAgentCapabilities} virtual_agent_capabilities Virtual Agent Capabilities
15463
+ * @param {*} [options] Override http request option.
15464
+ * @throws {RequiredError}
15465
+ * @memberof ConversationApi
15466
+ */
15467
+ ConversationApi.prototype.updateVirtualAgentCapabilities = function (virtual_agent_capabilities, options) {
15468
+ return (0, exports.ConversationApiFp)(this.configuration).updateVirtualAgentCapabilities(virtual_agent_capabilities, options)(this.fetch, this.basePath);
15469
+ };
15299
15470
  return ConversationApi;
15300
15471
  }(BaseAPI));
15301
15472
  exports.ConversationApi = ConversationApi;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.11.11",
3
+ "version": "3.11.13",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [