ultracart_rest_api_v2_typescript 3.10.69 → 3.10.71

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.69
1
+ ## ultracart_rest_api_v2_typescript@3.10.71
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.69 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.71 --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.71 | 11/29/2022 | converstation marked convo read method |
58
+ | 3.10.70 | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
57
59
  | 3.10.69 | 11/21/2022 | conversation context method |
58
60
  | 3.10.68 | 11/21/2022 | adjusted conversation event model |
59
61
  | 3.10.67 | 11/15/2022 | conversation methods bug fix |
package/api.ts CHANGED
@@ -6741,6 +6741,12 @@ export interface ConversationMessage {
6741
6741
  * @memberof ConversationMessage
6742
6742
  */
6743
6743
  conversation_message_uuid?: string;
6744
+ /**
6745
+ * Delay message transmission until date/time
6746
+ * @type {string}
6747
+ * @memberof ConversationMessage
6748
+ */
6749
+ delay_until_dts?: string;
6744
6750
  /**
6745
6751
  *
6746
6752
  * @type {Array<string>}
@@ -9342,6 +9348,18 @@ export interface CouponPercentOffMsrpItems {
9342
9348
  * @memberof CouponPercentOffMsrpItems
9343
9349
  */
9344
9350
  limit?: number;
9351
+ /**
9352
+ * The (optional) minimum cumulative msrp of qualifying items.
9353
+ * @type {number}
9354
+ * @memberof CouponPercentOffMsrpItems
9355
+ */
9356
+ minimum_cumulative_msrp?: number;
9357
+ /**
9358
+ * The (optional) minimum subtotal of qualifying items.
9359
+ * @type {number}
9360
+ * @memberof CouponPercentOffMsrpItems
9361
+ */
9362
+ minimum_subtotal?: number;
9345
9363
  }
9346
9364
 
9347
9365
  /**
@@ -41886,6 +41904,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
41886
41904
 
41887
41905
 
41888
41906
 
41907
+ // authentication ultraCartOauth required
41908
+ // oauth required
41909
+ if (configuration && configuration.accessToken) {
41910
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
41911
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
41912
+ : configuration.accessToken;
41913
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
41914
+ }
41915
+
41916
+ // authentication ultraCartSimpleApiKey required
41917
+ if (configuration && configuration.apiKey) {
41918
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
41919
+ ? configuration.apiKey("x-ultracart-simple-key")
41920
+ : configuration.apiKey;
41921
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
41922
+ }
41923
+
41924
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
41925
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
41926
+ delete localVarUrlObj.search;
41927
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
41928
+
41929
+ return {
41930
+ url: url.format(localVarUrlObj),
41931
+ options: localVarRequestOptions,
41932
+ };
41933
+ },
41934
+ /**
41935
+ * Mark a conversation as read
41936
+ * @summary Mark a conversation as read
41937
+ * @param {string} conversation_uuid
41938
+ * @param {*} [options] Override http request option.
41939
+ * @throws {RequiredError}
41940
+ */
41941
+ markReadConversation(conversation_uuid: string, options: any = {}): FetchArgs {
41942
+ // verify required parameter 'conversation_uuid' is not null or undefined
41943
+ if (conversation_uuid === null || conversation_uuid === undefined) {
41944
+ throw new RequiredError('conversation_uuid','Required parameter conversation_uuid was null or undefined when calling markReadConversation.');
41945
+ }
41946
+ const localVarPath = `/conversation/conversations/{conversation_uuid}/markread`
41947
+ .replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(conversation_uuid)));
41948
+ const localVarUrlObj = url.parse(localVarPath, true);
41949
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
41950
+ const localVarHeaderParameter = {} as any;
41951
+ const localVarQueryParameter = {} as any;
41952
+
41953
+ if(configuration && configuration.apiVersion) {
41954
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
41955
+ }
41956
+
41957
+
41958
+
41889
41959
  // authentication ultraCartOauth required
41890
41960
  // oauth required
41891
41961
  if (configuration && configuration.accessToken) {
@@ -42251,6 +42321,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
42251
42321
  });
42252
42322
  };
42253
42323
  },
42324
+ /**
42325
+ * Mark a conversation as read
42326
+ * @summary Mark a conversation as read
42327
+ * @param {string} conversation_uuid
42328
+ * @param {*} [options] Override http request option.
42329
+ * @throws {RequiredError}
42330
+ */
42331
+ markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
42332
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).markReadConversation(conversation_uuid, options);
42333
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
42334
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
42335
+
42336
+ if (response.status >= 200 && response.status < 300) {
42337
+ return response;
42338
+
42339
+ } else {
42340
+ throw response;
42341
+ }
42342
+ });
42343
+ };
42344
+ },
42254
42345
  /**
42255
42346
  * Start a new conversation
42256
42347
  * @summary Start a conversation
@@ -42406,6 +42497,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
42406
42497
  leaveConversation(conversation_uuid: string, options?: any) {
42407
42498
  return ConversationApiFp(configuration).leaveConversation(conversation_uuid, options)(fetch, basePath);
42408
42499
  },
42500
+ /**
42501
+ * Mark a conversation as read
42502
+ * @summary Mark a conversation as read
42503
+ * @param {string} conversation_uuid
42504
+ * @param {*} [options] Override http request option.
42505
+ * @throws {RequiredError}
42506
+ */
42507
+ markReadConversation(conversation_uuid: string, options?: any) {
42508
+ return ConversationApiFp(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
42509
+ },
42409
42510
  /**
42410
42511
  * Start a new conversation
42411
42512
  * @summary Start a conversation
@@ -42539,6 +42640,16 @@ export interface ConversationApiInterface {
42539
42640
  */
42540
42641
  leaveConversation(conversation_uuid: string, options?: any): Promise<{}>;
42541
42642
 
42643
+ /**
42644
+ * Mark a conversation as read
42645
+ * @summary Mark a conversation as read
42646
+ * @param {string} conversation_uuid
42647
+ * @param {*} [options] Override http request option.
42648
+ * @throws {RequiredError}
42649
+ * @memberof ConversationApiInterface
42650
+ */
42651
+ markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
42652
+
42542
42653
  /**
42543
42654
  * Start a new conversation
42544
42655
  * @summary Start a conversation
@@ -42692,6 +42803,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
42692
42803
  return ConversationApiFp(this.configuration).leaveConversation(conversation_uuid, options)(this.fetch, this.basePath);
42693
42804
  }
42694
42805
 
42806
+ /**
42807
+ * Mark a conversation as read
42808
+ * @summary Mark a conversation as read
42809
+ * @param {string} conversation_uuid
42810
+ * @param {*} [options] Override http request option.
42811
+ * @throws {RequiredError}
42812
+ * @memberof ConversationApi
42813
+ */
42814
+ public markReadConversation(conversation_uuid: string, options?: any) {
42815
+ return ConversationApiFp(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
42816
+ }
42817
+
42695
42818
  /**
42696
42819
  * Start a new conversation
42697
42820
  * @summary Start a conversation
package/dist/api.d.ts CHANGED
@@ -6582,6 +6582,12 @@ export interface ConversationMessage {
6582
6582
  * @memberof ConversationMessage
6583
6583
  */
6584
6584
  conversation_message_uuid?: string;
6585
+ /**
6586
+ * Delay message transmission until date/time
6587
+ * @type {string}
6588
+ * @memberof ConversationMessage
6589
+ */
6590
+ delay_until_dts?: string;
6585
6591
  /**
6586
6592
  *
6587
6593
  * @type {Array<string>}
@@ -9117,6 +9123,18 @@ export interface CouponPercentOffMsrpItems {
9117
9123
  * @memberof CouponPercentOffMsrpItems
9118
9124
  */
9119
9125
  limit?: number;
9126
+ /**
9127
+ * The (optional) minimum cumulative msrp of qualifying items.
9128
+ * @type {number}
9129
+ * @memberof CouponPercentOffMsrpItems
9130
+ */
9131
+ minimum_cumulative_msrp?: number;
9132
+ /**
9133
+ * The (optional) minimum subtotal of qualifying items.
9134
+ * @type {number}
9135
+ * @memberof CouponPercentOffMsrpItems
9136
+ */
9137
+ minimum_subtotal?: number;
9120
9138
  }
9121
9139
  /**
9122
9140
  *
@@ -37716,6 +37734,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
37716
37734
  * @throws {RequiredError}
37717
37735
  */
37718
37736
  leaveConversation(conversation_uuid: string, options?: any): FetchArgs;
37737
+ /**
37738
+ * Mark a conversation as read
37739
+ * @summary Mark a conversation as read
37740
+ * @param {string} conversation_uuid
37741
+ * @param {*} [options] Override http request option.
37742
+ * @throws {RequiredError}
37743
+ */
37744
+ markReadConversation(conversation_uuid: string, options?: any): FetchArgs;
37719
37745
  /**
37720
37746
  * Start a new conversation
37721
37747
  * @summary Start a conversation
@@ -37822,6 +37848,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
37822
37848
  * @throws {RequiredError}
37823
37849
  */
37824
37850
  leaveConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
37851
+ /**
37852
+ * Mark a conversation as read
37853
+ * @summary Mark a conversation as read
37854
+ * @param {string} conversation_uuid
37855
+ * @param {*} [options] Override http request option.
37856
+ * @throws {RequiredError}
37857
+ */
37858
+ markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
37825
37859
  /**
37826
37860
  * Start a new conversation
37827
37861
  * @summary Start a conversation
@@ -37928,6 +37962,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
37928
37962
  * @throws {RequiredError}
37929
37963
  */
37930
37964
  leaveConversation(conversation_uuid: string, options?: any): Promise<Response>;
37965
+ /**
37966
+ * Mark a conversation as read
37967
+ * @summary Mark a conversation as read
37968
+ * @param {string} conversation_uuid
37969
+ * @param {*} [options] Override http request option.
37970
+ * @throws {RequiredError}
37971
+ */
37972
+ markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
37931
37973
  /**
37932
37974
  * Start a new conversation
37933
37975
  * @summary Start a conversation
@@ -38045,6 +38087,15 @@ export interface ConversationApiInterface {
38045
38087
  * @memberof ConversationApiInterface
38046
38088
  */
38047
38089
  leaveConversation(conversation_uuid: string, options?: any): Promise<{}>;
38090
+ /**
38091
+ * Mark a conversation as read
38092
+ * @summary Mark a conversation as read
38093
+ * @param {string} conversation_uuid
38094
+ * @param {*} [options] Override http request option.
38095
+ * @throws {RequiredError}
38096
+ * @memberof ConversationApiInterface
38097
+ */
38098
+ markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
38048
38099
  /**
38049
38100
  * Start a new conversation
38050
38101
  * @summary Start a conversation
@@ -38165,6 +38216,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
38165
38216
  * @memberof ConversationApi
38166
38217
  */
38167
38218
  leaveConversation(conversation_uuid: string, options?: any): Promise<Response>;
38219
+ /**
38220
+ * Mark a conversation as read
38221
+ * @summary Mark a conversation as read
38222
+ * @param {string} conversation_uuid
38223
+ * @param {*} [options] Override http request option.
38224
+ * @throws {RequiredError}
38225
+ * @memberof ConversationApi
38226
+ */
38227
+ markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
38168
38228
  /**
38169
38229
  * Start a new conversation
38170
38230
  * @summary Start a conversation
package/dist/api.js CHANGED
@@ -5926,6 +5926,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
5926
5926
  options: localVarRequestOptions,
5927
5927
  };
5928
5928
  },
5929
+ /**
5930
+ * Mark a conversation as read
5931
+ * @summary Mark a conversation as read
5932
+ * @param {string} conversation_uuid
5933
+ * @param {*} [options] Override http request option.
5934
+ * @throws {RequiredError}
5935
+ */
5936
+ markReadConversation: function (conversation_uuid, options) {
5937
+ if (options === void 0) { options = {}; }
5938
+ // verify required parameter 'conversation_uuid' is not null or undefined
5939
+ if (conversation_uuid === null || conversation_uuid === undefined) {
5940
+ throw new RequiredError('conversation_uuid', 'Required parameter conversation_uuid was null or undefined when calling markReadConversation.');
5941
+ }
5942
+ var localVarPath = "/conversation/conversations/{conversation_uuid}/markread"
5943
+ .replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(conversation_uuid)));
5944
+ var localVarUrlObj = url.parse(localVarPath, true);
5945
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
5946
+ var localVarHeaderParameter = {};
5947
+ var localVarQueryParameter = {};
5948
+ if (configuration && configuration.apiVersion) {
5949
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
5950
+ }
5951
+ // authentication ultraCartOauth required
5952
+ // oauth required
5953
+ if (configuration && configuration.accessToken) {
5954
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
5955
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
5956
+ : configuration.accessToken;
5957
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
5958
+ }
5959
+ // authentication ultraCartSimpleApiKey required
5960
+ if (configuration && configuration.apiKey) {
5961
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
5962
+ ? configuration.apiKey("x-ultracart-simple-key")
5963
+ : configuration.apiKey;
5964
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
5965
+ }
5966
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
5967
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
5968
+ delete localVarUrlObj.search;
5969
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
5970
+ return {
5971
+ url: url.format(localVarUrlObj),
5972
+ options: localVarRequestOptions,
5973
+ };
5974
+ },
5929
5975
  /**
5930
5976
  * Start a new conversation
5931
5977
  * @summary Start a conversation
@@ -6260,6 +6306,28 @@ var ConversationApiFp = function (configuration) {
6260
6306
  });
6261
6307
  };
6262
6308
  },
6309
+ /**
6310
+ * Mark a conversation as read
6311
+ * @summary Mark a conversation as read
6312
+ * @param {string} conversation_uuid
6313
+ * @param {*} [options] Override http request option.
6314
+ * @throws {RequiredError}
6315
+ */
6316
+ markReadConversation: function (conversation_uuid, options) {
6317
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).markReadConversation(conversation_uuid, options);
6318
+ return function (fetch, basePath) {
6319
+ if (fetch === void 0) { fetch = portableFetch; }
6320
+ if (basePath === void 0) { basePath = BASE_PATH; }
6321
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
6322
+ if (response.status >= 200 && response.status < 300) {
6323
+ return response;
6324
+ }
6325
+ else {
6326
+ throw response;
6327
+ }
6328
+ });
6329
+ };
6330
+ },
6263
6331
  /**
6264
6332
  * Start a new conversation
6265
6333
  * @summary Start a conversation
@@ -6417,6 +6485,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
6417
6485
  leaveConversation: function (conversation_uuid, options) {
6418
6486
  return (0, exports.ConversationApiFp)(configuration).leaveConversation(conversation_uuid, options)(fetch, basePath);
6419
6487
  },
6488
+ /**
6489
+ * Mark a conversation as read
6490
+ * @summary Mark a conversation as read
6491
+ * @param {string} conversation_uuid
6492
+ * @param {*} [options] Override http request option.
6493
+ * @throws {RequiredError}
6494
+ */
6495
+ markReadConversation: function (conversation_uuid, options) {
6496
+ return (0, exports.ConversationApiFp)(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
6497
+ },
6420
6498
  /**
6421
6499
  * Start a new conversation
6422
6500
  * @summary Start a conversation
@@ -6565,6 +6643,17 @@ var ConversationApi = /** @class */ (function (_super) {
6565
6643
  ConversationApi.prototype.leaveConversation = function (conversation_uuid, options) {
6566
6644
  return (0, exports.ConversationApiFp)(this.configuration).leaveConversation(conversation_uuid, options)(this.fetch, this.basePath);
6567
6645
  };
6646
+ /**
6647
+ * Mark a conversation as read
6648
+ * @summary Mark a conversation as read
6649
+ * @param {string} conversation_uuid
6650
+ * @param {*} [options] Override http request option.
6651
+ * @throws {RequiredError}
6652
+ * @memberof ConversationApi
6653
+ */
6654
+ ConversationApi.prototype.markReadConversation = function (conversation_uuid, options) {
6655
+ return (0, exports.ConversationApiFp)(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
6656
+ };
6568
6657
  /**
6569
6658
  * Start a new conversation
6570
6659
  * @summary Start a conversation
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.69",
3
+ "version": "3.10.71",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [