ultracart_rest_api_v2_typescript 3.10.70 → 3.10.72

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.70
1
+ ## ultracart_rest_api_v2_typescript@3.10.72
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.70 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.72 --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.72 | 11/30/2022 | order item - addl fields for linking kits to kit components |
58
+ | 3.10.71 | 11/29/2022 | converstation marked convo read method |
57
59
  | 3.10.70 | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
58
60
  | 3.10.69 | 11/21/2022 | conversation context method |
59
61
  | 3.10.68 | 11/21/2022 | adjusted conversation event model |
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>}
@@ -27957,6 +27963,12 @@ export interface OrderItem {
27957
27963
  * @memberof OrderItem
27958
27964
  */
27959
27965
  height?: Distance;
27966
+ /**
27967
+ * Index of the item on the order (one based index)
27968
+ * @type {number}
27969
+ * @memberof OrderItem
27970
+ */
27971
+ item_index?: number;
27960
27972
  /**
27961
27973
  * Item reference object identifier used to linked to auto order item record
27962
27974
  * @type {number}
@@ -28029,6 +28041,18 @@ export interface OrderItem {
28029
28041
  * @memberof OrderItem
28030
28042
  */
28031
28043
  packed_by_user?: string;
28044
+ /**
28045
+ * If this item is a kit component, this is the item index of the parent item (kit)
28046
+ * @type {number}
28047
+ * @memberof OrderItem
28048
+ */
28049
+ parent_item_index?: number;
28050
+ /**
28051
+ * If this item is a kit component, this is the item id of the parent item (kit)
28052
+ * @type {string}
28053
+ * @memberof OrderItem
28054
+ */
28055
+ parent_merchant_item_id?: string;
28032
28056
  /**
28033
28057
  * Perishable class of the item
28034
28058
  * @type {string}
@@ -41898,6 +41922,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
41898
41922
 
41899
41923
 
41900
41924
 
41925
+ // authentication ultraCartOauth required
41926
+ // oauth required
41927
+ if (configuration && configuration.accessToken) {
41928
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
41929
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
41930
+ : configuration.accessToken;
41931
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
41932
+ }
41933
+
41934
+ // authentication ultraCartSimpleApiKey required
41935
+ if (configuration && configuration.apiKey) {
41936
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
41937
+ ? configuration.apiKey("x-ultracart-simple-key")
41938
+ : configuration.apiKey;
41939
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
41940
+ }
41941
+
41942
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
41943
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
41944
+ delete localVarUrlObj.search;
41945
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
41946
+
41947
+ return {
41948
+ url: url.format(localVarUrlObj),
41949
+ options: localVarRequestOptions,
41950
+ };
41951
+ },
41952
+ /**
41953
+ * Mark a conversation as read
41954
+ * @summary Mark a conversation as read
41955
+ * @param {string} conversation_uuid
41956
+ * @param {*} [options] Override http request option.
41957
+ * @throws {RequiredError}
41958
+ */
41959
+ markReadConversation(conversation_uuid: string, options: any = {}): FetchArgs {
41960
+ // verify required parameter 'conversation_uuid' is not null or undefined
41961
+ if (conversation_uuid === null || conversation_uuid === undefined) {
41962
+ throw new RequiredError('conversation_uuid','Required parameter conversation_uuid was null or undefined when calling markReadConversation.');
41963
+ }
41964
+ const localVarPath = `/conversation/conversations/{conversation_uuid}/markread`
41965
+ .replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(conversation_uuid)));
41966
+ const localVarUrlObj = url.parse(localVarPath, true);
41967
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
41968
+ const localVarHeaderParameter = {} as any;
41969
+ const localVarQueryParameter = {} as any;
41970
+
41971
+ if(configuration && configuration.apiVersion) {
41972
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
41973
+ }
41974
+
41975
+
41976
+
41901
41977
  // authentication ultraCartOauth required
41902
41978
  // oauth required
41903
41979
  if (configuration && configuration.accessToken) {
@@ -42263,6 +42339,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
42263
42339
  });
42264
42340
  };
42265
42341
  },
42342
+ /**
42343
+ * Mark a conversation as read
42344
+ * @summary Mark a conversation as read
42345
+ * @param {string} conversation_uuid
42346
+ * @param {*} [options] Override http request option.
42347
+ * @throws {RequiredError}
42348
+ */
42349
+ markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
42350
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).markReadConversation(conversation_uuid, options);
42351
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
42352
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
42353
+
42354
+ if (response.status >= 200 && response.status < 300) {
42355
+ return response;
42356
+
42357
+ } else {
42358
+ throw response;
42359
+ }
42360
+ });
42361
+ };
42362
+ },
42266
42363
  /**
42267
42364
  * Start a new conversation
42268
42365
  * @summary Start a conversation
@@ -42418,6 +42515,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
42418
42515
  leaveConversation(conversation_uuid: string, options?: any) {
42419
42516
  return ConversationApiFp(configuration).leaveConversation(conversation_uuid, options)(fetch, basePath);
42420
42517
  },
42518
+ /**
42519
+ * Mark a conversation as read
42520
+ * @summary Mark a conversation as read
42521
+ * @param {string} conversation_uuid
42522
+ * @param {*} [options] Override http request option.
42523
+ * @throws {RequiredError}
42524
+ */
42525
+ markReadConversation(conversation_uuid: string, options?: any) {
42526
+ return ConversationApiFp(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
42527
+ },
42421
42528
  /**
42422
42529
  * Start a new conversation
42423
42530
  * @summary Start a conversation
@@ -42551,6 +42658,16 @@ export interface ConversationApiInterface {
42551
42658
  */
42552
42659
  leaveConversation(conversation_uuid: string, options?: any): Promise<{}>;
42553
42660
 
42661
+ /**
42662
+ * Mark a conversation as read
42663
+ * @summary Mark a conversation as read
42664
+ * @param {string} conversation_uuid
42665
+ * @param {*} [options] Override http request option.
42666
+ * @throws {RequiredError}
42667
+ * @memberof ConversationApiInterface
42668
+ */
42669
+ markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
42670
+
42554
42671
  /**
42555
42672
  * Start a new conversation
42556
42673
  * @summary Start a conversation
@@ -42704,6 +42821,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
42704
42821
  return ConversationApiFp(this.configuration).leaveConversation(conversation_uuid, options)(this.fetch, this.basePath);
42705
42822
  }
42706
42823
 
42824
+ /**
42825
+ * Mark a conversation as read
42826
+ * @summary Mark a conversation as read
42827
+ * @param {string} conversation_uuid
42828
+ * @param {*} [options] Override http request option.
42829
+ * @throws {RequiredError}
42830
+ * @memberof ConversationApi
42831
+ */
42832
+ public markReadConversation(conversation_uuid: string, options?: any) {
42833
+ return ConversationApiFp(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
42834
+ }
42835
+
42707
42836
  /**
42708
42837
  * Start a new conversation
42709
42838
  * @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>}
@@ -27373,6 +27379,12 @@ export interface OrderItem {
27373
27379
  * @memberof OrderItem
27374
27380
  */
27375
27381
  height?: Distance;
27382
+ /**
27383
+ * Index of the item on the order (one based index)
27384
+ * @type {number}
27385
+ * @memberof OrderItem
27386
+ */
27387
+ item_index?: number;
27376
27388
  /**
27377
27389
  * Item reference object identifier used to linked to auto order item record
27378
27390
  * @type {number}
@@ -27445,6 +27457,18 @@ export interface OrderItem {
27445
27457
  * @memberof OrderItem
27446
27458
  */
27447
27459
  packed_by_user?: string;
27460
+ /**
27461
+ * If this item is a kit component, this is the item index of the parent item (kit)
27462
+ * @type {number}
27463
+ * @memberof OrderItem
27464
+ */
27465
+ parent_item_index?: number;
27466
+ /**
27467
+ * If this item is a kit component, this is the item id of the parent item (kit)
27468
+ * @type {string}
27469
+ * @memberof OrderItem
27470
+ */
27471
+ parent_merchant_item_id?: string;
27448
27472
  /**
27449
27473
  * Perishable class of the item
27450
27474
  * @type {string}
@@ -37728,6 +37752,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
37728
37752
  * @throws {RequiredError}
37729
37753
  */
37730
37754
  leaveConversation(conversation_uuid: string, options?: any): FetchArgs;
37755
+ /**
37756
+ * Mark a conversation as read
37757
+ * @summary Mark a conversation as read
37758
+ * @param {string} conversation_uuid
37759
+ * @param {*} [options] Override http request option.
37760
+ * @throws {RequiredError}
37761
+ */
37762
+ markReadConversation(conversation_uuid: string, options?: any): FetchArgs;
37731
37763
  /**
37732
37764
  * Start a new conversation
37733
37765
  * @summary Start a conversation
@@ -37834,6 +37866,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
37834
37866
  * @throws {RequiredError}
37835
37867
  */
37836
37868
  leaveConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
37869
+ /**
37870
+ * Mark a conversation as read
37871
+ * @summary Mark a conversation as read
37872
+ * @param {string} conversation_uuid
37873
+ * @param {*} [options] Override http request option.
37874
+ * @throws {RequiredError}
37875
+ */
37876
+ markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
37837
37877
  /**
37838
37878
  * Start a new conversation
37839
37879
  * @summary Start a conversation
@@ -37940,6 +37980,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
37940
37980
  * @throws {RequiredError}
37941
37981
  */
37942
37982
  leaveConversation(conversation_uuid: string, options?: any): Promise<Response>;
37983
+ /**
37984
+ * Mark a conversation as read
37985
+ * @summary Mark a conversation as read
37986
+ * @param {string} conversation_uuid
37987
+ * @param {*} [options] Override http request option.
37988
+ * @throws {RequiredError}
37989
+ */
37990
+ markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
37943
37991
  /**
37944
37992
  * Start a new conversation
37945
37993
  * @summary Start a conversation
@@ -38057,6 +38105,15 @@ export interface ConversationApiInterface {
38057
38105
  * @memberof ConversationApiInterface
38058
38106
  */
38059
38107
  leaveConversation(conversation_uuid: string, options?: any): Promise<{}>;
38108
+ /**
38109
+ * Mark a conversation as read
38110
+ * @summary Mark a conversation as read
38111
+ * @param {string} conversation_uuid
38112
+ * @param {*} [options] Override http request option.
38113
+ * @throws {RequiredError}
38114
+ * @memberof ConversationApiInterface
38115
+ */
38116
+ markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
38060
38117
  /**
38061
38118
  * Start a new conversation
38062
38119
  * @summary Start a conversation
@@ -38177,6 +38234,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
38177
38234
  * @memberof ConversationApi
38178
38235
  */
38179
38236
  leaveConversation(conversation_uuid: string, options?: any): Promise<Response>;
38237
+ /**
38238
+ * Mark a conversation as read
38239
+ * @summary Mark a conversation as read
38240
+ * @param {string} conversation_uuid
38241
+ * @param {*} [options] Override http request option.
38242
+ * @throws {RequiredError}
38243
+ * @memberof ConversationApi
38244
+ */
38245
+ markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
38180
38246
  /**
38181
38247
  * Start a new conversation
38182
38248
  * @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.70",
3
+ "version": "3.10.72",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [