ultracart_rest_api_v2_typescript 3.10.68 → 3.10.70

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.68
1
+ ## ultracart_rest_api_v2_typescript@3.10.70
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.68 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.70 --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.70 | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
58
+ | 3.10.69 | 11/21/2022 | conversation context method |
57
59
  | 3.10.68 | 11/21/2022 | adjusted conversation event model |
58
60
  | 3.10.67 | 11/15/2022 | conversation methods bug fix |
59
61
  | 3.10.66 | 11/15/2022 | conversations - enw events for add coupon and items |
package/api.ts CHANGED
@@ -7219,6 +7219,44 @@ export interface ConversationTwilioAccount {
7219
7219
  twilio_phone_numbers?: Array<string>;
7220
7220
  }
7221
7221
 
7222
+ /**
7223
+ *
7224
+ * @export
7225
+ * @interface ConversationWebchatContext
7226
+ */
7227
+ export interface ConversationWebchatContext {
7228
+ /**
7229
+ *
7230
+ * @type {Cart}
7231
+ * @memberof ConversationWebchatContext
7232
+ */
7233
+ cart?: Cart;
7234
+ /**
7235
+ *
7236
+ * @type {string}
7237
+ * @memberof ConversationWebchatContext
7238
+ */
7239
+ current_url?: string;
7240
+ /**
7241
+ *
7242
+ * @type {Array<HitPageView>}
7243
+ * @memberof ConversationWebchatContext
7244
+ */
7245
+ page_view?: Array<HitPageView>;
7246
+ /**
7247
+ *
7248
+ * @type {HitSessionStart}
7249
+ * @memberof ConversationWebchatContext
7250
+ */
7251
+ session_start?: HitSessionStart;
7252
+ /**
7253
+ *
7254
+ * @type {HitSessionUtm}
7255
+ * @memberof ConversationWebchatContext
7256
+ */
7257
+ session_utm?: HitSessionUtm;
7258
+ }
7259
+
7222
7260
  /**
7223
7261
  *
7224
7262
  * @export
@@ -7621,7 +7659,8 @@ export namespace ConversationWebsocketMessage {
7621
7659
  ReadMessage = <any> 'read message',
7622
7660
  Typing = <any> 'typing',
7623
7661
  AddCoupon = <any> 'add coupon',
7624
- AddItem = <any> 'add item'
7662
+ AddItem = <any> 'add item',
7663
+ WebchatContext = <any> 'webchat context'
7625
7664
  }
7626
7665
  /**
7627
7666
  * @export
@@ -9303,6 +9342,18 @@ export interface CouponPercentOffMsrpItems {
9303
9342
  * @memberof CouponPercentOffMsrpItems
9304
9343
  */
9305
9344
  limit?: number;
9345
+ /**
9346
+ * The (optional) minimum cumulative msrp of qualifying items.
9347
+ * @type {number}
9348
+ * @memberof CouponPercentOffMsrpItems
9349
+ */
9350
+ minimum_cumulative_msrp?: number;
9351
+ /**
9352
+ * The (optional) minimum subtotal of qualifying items.
9353
+ * @type {number}
9354
+ * @memberof CouponPercentOffMsrpItems
9355
+ */
9356
+ minimum_subtotal?: number;
9306
9357
  }
9307
9358
 
9308
9359
  /**
@@ -19663,6 +19714,308 @@ export interface HTTPHeader {
19663
19714
  value?: string;
19664
19715
  }
19665
19716
 
19717
+ /**
19718
+ *
19719
+ * @export
19720
+ * @interface HitPageView
19721
+ */
19722
+ export interface HitPageView {
19723
+ /**
19724
+ *
19725
+ * @type {boolean}
19726
+ * @memberof HitPageView
19727
+ */
19728
+ bounce?: boolean;
19729
+ /**
19730
+ *
19731
+ * @type {Array<HitPageViewMetaData>}
19732
+ * @memberof HitPageView
19733
+ */
19734
+ meta_data?: Array<HitPageViewMetaData>;
19735
+ /**
19736
+ *
19737
+ * @type {string}
19738
+ * @memberof HitPageView
19739
+ */
19740
+ method?: string;
19741
+ /**
19742
+ *
19743
+ * @type {boolean}
19744
+ * @memberof HitPageView
19745
+ */
19746
+ prefetch?: boolean;
19747
+ /**
19748
+ *
19749
+ * @type {string}
19750
+ * @memberof HitPageView
19751
+ */
19752
+ query?: string;
19753
+ /**
19754
+ *
19755
+ * @type {boolean}
19756
+ * @memberof HitPageView
19757
+ */
19758
+ recording?: boolean;
19759
+ /**
19760
+ *
19761
+ * @type {boolean}
19762
+ * @memberof HitPageView
19763
+ */
19764
+ redirect?: boolean;
19765
+ /**
19766
+ *
19767
+ * @type {string}
19768
+ * @memberof HitPageView
19769
+ */
19770
+ referrer?: string;
19771
+ /**
19772
+ *
19773
+ * @type {number}
19774
+ * @memberof HitPageView
19775
+ */
19776
+ time_on_page?: number;
19777
+ /**
19778
+ *
19779
+ * @type {string}
19780
+ * @memberof HitPageView
19781
+ */
19782
+ title?: string;
19783
+ /**
19784
+ *
19785
+ * @type {string}
19786
+ * @memberof HitPageView
19787
+ */
19788
+ url?: string;
19789
+ }
19790
+
19791
+ /**
19792
+ *
19793
+ * @export
19794
+ * @interface HitPageViewMetaData
19795
+ */
19796
+ export interface HitPageViewMetaData {
19797
+ /**
19798
+ *
19799
+ * @type {string}
19800
+ * @memberof HitPageViewMetaData
19801
+ */
19802
+ key?: string;
19803
+ /**
19804
+ *
19805
+ * @type {string}
19806
+ * @memberof HitPageViewMetaData
19807
+ */
19808
+ value?: string;
19809
+ }
19810
+
19811
+ /**
19812
+ *
19813
+ * @export
19814
+ * @interface HitSessionStart
19815
+ */
19816
+ export interface HitSessionStart {
19817
+ /**
19818
+ *
19819
+ * @type {boolean}
19820
+ * @memberof HitSessionStart
19821
+ */
19822
+ bot?: boolean;
19823
+ /**
19824
+ *
19825
+ * @type {boolean}
19826
+ * @memberof HitSessionStart
19827
+ */
19828
+ bounce?: boolean;
19829
+ /**
19830
+ *
19831
+ * @type {string}
19832
+ * @memberof HitSessionStart
19833
+ */
19834
+ channel?: string;
19835
+ /**
19836
+ *
19837
+ * @type {boolean}
19838
+ * @memberof HitSessionStart
19839
+ */
19840
+ device_switch_detected?: boolean;
19841
+ /**
19842
+ *
19843
+ * @type {boolean}
19844
+ * @memberof HitSessionStart
19845
+ */
19846
+ fake_bot?: boolean;
19847
+ /**
19848
+ *
19849
+ * @type {string}
19850
+ * @memberof HitSessionStart
19851
+ */
19852
+ geolocation_country?: string;
19853
+ /**
19854
+ *
19855
+ * @type {number}
19856
+ * @memberof HitSessionStart
19857
+ */
19858
+ geolocation_latitude?: number;
19859
+ /**
19860
+ *
19861
+ * @type {number}
19862
+ * @memberof HitSessionStart
19863
+ */
19864
+ geolocation_longitude?: number;
19865
+ /**
19866
+ *
19867
+ * @type {string}
19868
+ * @memberof HitSessionStart
19869
+ */
19870
+ geolocation_province?: string;
19871
+ /**
19872
+ *
19873
+ * @type {boolean}
19874
+ * @memberof HitSessionStart
19875
+ */
19876
+ no_cookie_support?: boolean;
19877
+ /**
19878
+ *
19879
+ * @type {boolean}
19880
+ * @memberof HitSessionStart
19881
+ */
19882
+ prefetch?: boolean;
19883
+ /**
19884
+ *
19885
+ * @type {string}
19886
+ * @memberof HitSessionStart
19887
+ */
19888
+ referrer?: string;
19889
+ /**
19890
+ *
19891
+ * @type {number}
19892
+ * @memberof HitSessionStart
19893
+ */
19894
+ screen_height?: number;
19895
+ /**
19896
+ *
19897
+ * @type {number}
19898
+ * @memberof HitSessionStart
19899
+ */
19900
+ screen_width?: number;
19901
+ /**
19902
+ *
19903
+ * @type {number}
19904
+ * @memberof HitSessionStart
19905
+ */
19906
+ time_on_Site?: number;
19907
+ /**
19908
+ *
19909
+ * @type {string}
19910
+ * @memberof HitSessionStart
19911
+ */
19912
+ user_agent?: string;
19913
+ /**
19914
+ *
19915
+ * @type {string}
19916
+ * @memberof HitSessionStart
19917
+ */
19918
+ user_ip?: string;
19919
+ }
19920
+
19921
+ /**
19922
+ *
19923
+ * @export
19924
+ * @interface HitSessionUtm
19925
+ */
19926
+ export interface HitSessionUtm {
19927
+ /**
19928
+ *
19929
+ * @type {string}
19930
+ * @memberof HitSessionUtm
19931
+ */
19932
+ fb_ad_id?: string;
19933
+ /**
19934
+ *
19935
+ * @type {string}
19936
+ * @memberof HitSessionUtm
19937
+ */
19938
+ fbclid?: string;
19939
+ /**
19940
+ *
19941
+ * @type {string}
19942
+ * @memberof HitSessionUtm
19943
+ */
19944
+ gbraid?: string;
19945
+ /**
19946
+ *
19947
+ * @type {string}
19948
+ * @memberof HitSessionUtm
19949
+ */
19950
+ gclid?: string;
19951
+ /**
19952
+ *
19953
+ * @type {string}
19954
+ * @memberof HitSessionUtm
19955
+ */
19956
+ msclkid?: string;
19957
+ /**
19958
+ *
19959
+ * @type {string}
19960
+ * @memberof HitSessionUtm
19961
+ */
19962
+ ttclid?: string;
19963
+ /**
19964
+ *
19965
+ * @type {string}
19966
+ * @memberof HitSessionUtm
19967
+ */
19968
+ uc_message_id?: string;
19969
+ /**
19970
+ *
19971
+ * @type {string}
19972
+ * @memberof HitSessionUtm
19973
+ */
19974
+ utm_campaign?: string;
19975
+ /**
19976
+ *
19977
+ * @type {string}
19978
+ * @memberof HitSessionUtm
19979
+ */
19980
+ utm_content?: string;
19981
+ /**
19982
+ *
19983
+ * @type {string}
19984
+ * @memberof HitSessionUtm
19985
+ */
19986
+ utm_id?: string;
19987
+ /**
19988
+ *
19989
+ * @type {string}
19990
+ * @memberof HitSessionUtm
19991
+ */
19992
+ utm_medium?: string;
19993
+ /**
19994
+ *
19995
+ * @type {string}
19996
+ * @memberof HitSessionUtm
19997
+ */
19998
+ utm_source?: string;
19999
+ /**
20000
+ *
20001
+ * @type {string}
20002
+ * @memberof HitSessionUtm
20003
+ */
20004
+ utm_term?: string;
20005
+ /**
20006
+ *
20007
+ * @type {string}
20008
+ * @memberof HitSessionUtm
20009
+ */
20010
+ vmcid?: string;
20011
+ /**
20012
+ *
20013
+ * @type {string}
20014
+ * @memberof HitSessionUtm
20015
+ */
20016
+ wbraid?: string;
20017
+ }
20018
+
19666
20019
  /**
19667
20020
  *
19668
20021
  * @export
@@ -41189,6 +41542,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
41189
41542
  options: localVarRequestOptions,
41190
41543
  };
41191
41544
  },
41545
+ /**
41546
+ * Get a webchat conversation context
41547
+ * @summary Get a webchat conversation context
41548
+ * @param {string} conversation_uuid
41549
+ * @param {*} [options] Override http request option.
41550
+ * @throws {RequiredError}
41551
+ */
41552
+ getConversationContext(conversation_uuid: string, options: any = {}): FetchArgs {
41553
+ // verify required parameter 'conversation_uuid' is not null or undefined
41554
+ if (conversation_uuid === null || conversation_uuid === undefined) {
41555
+ throw new RequiredError('conversation_uuid','Required parameter conversation_uuid was null or undefined when calling getConversationContext.');
41556
+ }
41557
+ const localVarPath = `/conversation/conversations/{conversation_uuid}/context`
41558
+ .replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(conversation_uuid)));
41559
+ const localVarUrlObj = url.parse(localVarPath, true);
41560
+ const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
41561
+ const localVarHeaderParameter = {} as any;
41562
+ const localVarQueryParameter = {} as any;
41563
+
41564
+ if(configuration && configuration.apiVersion) {
41565
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
41566
+ }
41567
+
41568
+
41569
+
41570
+ // authentication ultraCartOauth required
41571
+ // oauth required
41572
+ if (configuration && configuration.accessToken) {
41573
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
41574
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
41575
+ : configuration.accessToken;
41576
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
41577
+ }
41578
+
41579
+ // authentication ultraCartSimpleApiKey required
41580
+ if (configuration && configuration.apiKey) {
41581
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
41582
+ ? configuration.apiKey("x-ultracart-simple-key")
41583
+ : configuration.apiKey;
41584
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
41585
+ }
41586
+
41587
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
41588
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
41589
+ delete localVarUrlObj.search;
41590
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
41591
+
41592
+ return {
41593
+ url: url.format(localVarUrlObj),
41594
+ options: localVarRequestOptions,
41595
+ };
41596
+ },
41192
41597
  /**
41193
41598
  * Retrieve conversation messages since a particular time
41194
41599
  * @summary Retrieve conversation messages
@@ -41707,6 +42112,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
41707
42112
  });
41708
42113
  };
41709
42114
  },
42115
+ /**
42116
+ * Get a webchat conversation context
42117
+ * @summary Get a webchat conversation context
42118
+ * @param {string} conversation_uuid
42119
+ * @param {*} [options] Override http request option.
42120
+ * @throws {RequiredError}
42121
+ */
42122
+ getConversationContext(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatContext> {
42123
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationContext(conversation_uuid, options);
42124
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
42125
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
42126
+
42127
+ if (response.status >= 200 && response.status < 300) {
42128
+ return response.json();
42129
+
42130
+ } else {
42131
+ throw response;
42132
+ }
42133
+ });
42134
+ };
42135
+ },
41710
42136
  /**
41711
42137
  * Retrieve conversation messages since a particular time
41712
42138
  * @summary Retrieve conversation messages
@@ -41918,6 +42344,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
41918
42344
  getConversation(conversation_uuid: string, limit?: number, options?: any) {
41919
42345
  return ConversationApiFp(configuration).getConversation(conversation_uuid, limit, options)(fetch, basePath);
41920
42346
  },
42347
+ /**
42348
+ * Get a webchat conversation context
42349
+ * @summary Get a webchat conversation context
42350
+ * @param {string} conversation_uuid
42351
+ * @param {*} [options] Override http request option.
42352
+ * @throws {RequiredError}
42353
+ */
42354
+ getConversationContext(conversation_uuid: string, options?: any) {
42355
+ return ConversationApiFp(configuration).getConversationContext(conversation_uuid, options)(fetch, basePath);
42356
+ },
41921
42357
  /**
41922
42358
  * Retrieve conversation messages since a particular time
41923
42359
  * @summary Retrieve conversation messages
@@ -42041,6 +42477,16 @@ export interface ConversationApiInterface {
42041
42477
  */
42042
42478
  getConversation(conversation_uuid: string, limit?: number, options?: any): Promise<ConversationResponse>;
42043
42479
 
42480
+ /**
42481
+ * Get a webchat conversation context
42482
+ * @summary Get a webchat conversation context
42483
+ * @param {string} conversation_uuid
42484
+ * @param {*} [options] Override http request option.
42485
+ * @throws {RequiredError}
42486
+ * @memberof ConversationApiInterface
42487
+ */
42488
+ getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
42489
+
42044
42490
  /**
42045
42491
  * Retrieve conversation messages since a particular time
42046
42492
  * @summary Retrieve conversation messages
@@ -42170,6 +42616,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
42170
42616
  return ConversationApiFp(this.configuration).getConversation(conversation_uuid, limit, options)(this.fetch, this.basePath);
42171
42617
  }
42172
42618
 
42619
+ /**
42620
+ * Get a webchat conversation context
42621
+ * @summary Get a webchat conversation context
42622
+ * @param {string} conversation_uuid
42623
+ * @param {*} [options] Override http request option.
42624
+ * @throws {RequiredError}
42625
+ * @memberof ConversationApi
42626
+ */
42627
+ public getConversationContext(conversation_uuid: string, options?: any) {
42628
+ return ConversationApiFp(this.configuration).getConversationContext(conversation_uuid, options)(this.fetch, this.basePath);
42629
+ }
42630
+
42173
42631
  /**
42174
42632
  * Retrieve conversation messages since a particular time
42175
42633
  * @summary Retrieve conversation messages
package/dist/api.d.ts CHANGED
@@ -7046,6 +7046,43 @@ export interface ConversationTwilioAccount {
7046
7046
  */
7047
7047
  twilio_phone_numbers?: Array<string>;
7048
7048
  }
7049
+ /**
7050
+ *
7051
+ * @export
7052
+ * @interface ConversationWebchatContext
7053
+ */
7054
+ export interface ConversationWebchatContext {
7055
+ /**
7056
+ *
7057
+ * @type {Cart}
7058
+ * @memberof ConversationWebchatContext
7059
+ */
7060
+ cart?: Cart;
7061
+ /**
7062
+ *
7063
+ * @type {string}
7064
+ * @memberof ConversationWebchatContext
7065
+ */
7066
+ current_url?: string;
7067
+ /**
7068
+ *
7069
+ * @type {Array<HitPageView>}
7070
+ * @memberof ConversationWebchatContext
7071
+ */
7072
+ page_view?: Array<HitPageView>;
7073
+ /**
7074
+ *
7075
+ * @type {HitSessionStart}
7076
+ * @memberof ConversationWebchatContext
7077
+ */
7078
+ session_start?: HitSessionStart;
7079
+ /**
7080
+ *
7081
+ * @type {HitSessionUtm}
7082
+ * @memberof ConversationWebchatContext
7083
+ */
7084
+ session_utm?: HitSessionUtm;
7085
+ }
7049
7086
  /**
7050
7087
  *
7051
7088
  * @export
@@ -7440,7 +7477,8 @@ export declare namespace ConversationWebsocketMessage {
7440
7477
  ReadMessage,
7441
7478
  Typing,
7442
7479
  AddCoupon,
7443
- AddItem
7480
+ AddItem,
7481
+ WebchatContext
7444
7482
  }
7445
7483
  /**
7446
7484
  * @export
@@ -9079,6 +9117,18 @@ export interface CouponPercentOffMsrpItems {
9079
9117
  * @memberof CouponPercentOffMsrpItems
9080
9118
  */
9081
9119
  limit?: number;
9120
+ /**
9121
+ * The (optional) minimum cumulative msrp of qualifying items.
9122
+ * @type {number}
9123
+ * @memberof CouponPercentOffMsrpItems
9124
+ */
9125
+ minimum_cumulative_msrp?: number;
9126
+ /**
9127
+ * The (optional) minimum subtotal of qualifying items.
9128
+ * @type {number}
9129
+ * @memberof CouponPercentOffMsrpItems
9130
+ */
9131
+ minimum_subtotal?: number;
9082
9132
  }
9083
9133
  /**
9084
9134
  *
@@ -19232,6 +19282,304 @@ export interface HTTPHeader {
19232
19282
  */
19233
19283
  value?: string;
19234
19284
  }
19285
+ /**
19286
+ *
19287
+ * @export
19288
+ * @interface HitPageView
19289
+ */
19290
+ export interface HitPageView {
19291
+ /**
19292
+ *
19293
+ * @type {boolean}
19294
+ * @memberof HitPageView
19295
+ */
19296
+ bounce?: boolean;
19297
+ /**
19298
+ *
19299
+ * @type {Array<HitPageViewMetaData>}
19300
+ * @memberof HitPageView
19301
+ */
19302
+ meta_data?: Array<HitPageViewMetaData>;
19303
+ /**
19304
+ *
19305
+ * @type {string}
19306
+ * @memberof HitPageView
19307
+ */
19308
+ method?: string;
19309
+ /**
19310
+ *
19311
+ * @type {boolean}
19312
+ * @memberof HitPageView
19313
+ */
19314
+ prefetch?: boolean;
19315
+ /**
19316
+ *
19317
+ * @type {string}
19318
+ * @memberof HitPageView
19319
+ */
19320
+ query?: string;
19321
+ /**
19322
+ *
19323
+ * @type {boolean}
19324
+ * @memberof HitPageView
19325
+ */
19326
+ recording?: boolean;
19327
+ /**
19328
+ *
19329
+ * @type {boolean}
19330
+ * @memberof HitPageView
19331
+ */
19332
+ redirect?: boolean;
19333
+ /**
19334
+ *
19335
+ * @type {string}
19336
+ * @memberof HitPageView
19337
+ */
19338
+ referrer?: string;
19339
+ /**
19340
+ *
19341
+ * @type {number}
19342
+ * @memberof HitPageView
19343
+ */
19344
+ time_on_page?: number;
19345
+ /**
19346
+ *
19347
+ * @type {string}
19348
+ * @memberof HitPageView
19349
+ */
19350
+ title?: string;
19351
+ /**
19352
+ *
19353
+ * @type {string}
19354
+ * @memberof HitPageView
19355
+ */
19356
+ url?: string;
19357
+ }
19358
+ /**
19359
+ *
19360
+ * @export
19361
+ * @interface HitPageViewMetaData
19362
+ */
19363
+ export interface HitPageViewMetaData {
19364
+ /**
19365
+ *
19366
+ * @type {string}
19367
+ * @memberof HitPageViewMetaData
19368
+ */
19369
+ key?: string;
19370
+ /**
19371
+ *
19372
+ * @type {string}
19373
+ * @memberof HitPageViewMetaData
19374
+ */
19375
+ value?: string;
19376
+ }
19377
+ /**
19378
+ *
19379
+ * @export
19380
+ * @interface HitSessionStart
19381
+ */
19382
+ export interface HitSessionStart {
19383
+ /**
19384
+ *
19385
+ * @type {boolean}
19386
+ * @memberof HitSessionStart
19387
+ */
19388
+ bot?: boolean;
19389
+ /**
19390
+ *
19391
+ * @type {boolean}
19392
+ * @memberof HitSessionStart
19393
+ */
19394
+ bounce?: boolean;
19395
+ /**
19396
+ *
19397
+ * @type {string}
19398
+ * @memberof HitSessionStart
19399
+ */
19400
+ channel?: string;
19401
+ /**
19402
+ *
19403
+ * @type {boolean}
19404
+ * @memberof HitSessionStart
19405
+ */
19406
+ device_switch_detected?: boolean;
19407
+ /**
19408
+ *
19409
+ * @type {boolean}
19410
+ * @memberof HitSessionStart
19411
+ */
19412
+ fake_bot?: boolean;
19413
+ /**
19414
+ *
19415
+ * @type {string}
19416
+ * @memberof HitSessionStart
19417
+ */
19418
+ geolocation_country?: string;
19419
+ /**
19420
+ *
19421
+ * @type {number}
19422
+ * @memberof HitSessionStart
19423
+ */
19424
+ geolocation_latitude?: number;
19425
+ /**
19426
+ *
19427
+ * @type {number}
19428
+ * @memberof HitSessionStart
19429
+ */
19430
+ geolocation_longitude?: number;
19431
+ /**
19432
+ *
19433
+ * @type {string}
19434
+ * @memberof HitSessionStart
19435
+ */
19436
+ geolocation_province?: string;
19437
+ /**
19438
+ *
19439
+ * @type {boolean}
19440
+ * @memberof HitSessionStart
19441
+ */
19442
+ no_cookie_support?: boolean;
19443
+ /**
19444
+ *
19445
+ * @type {boolean}
19446
+ * @memberof HitSessionStart
19447
+ */
19448
+ prefetch?: boolean;
19449
+ /**
19450
+ *
19451
+ * @type {string}
19452
+ * @memberof HitSessionStart
19453
+ */
19454
+ referrer?: string;
19455
+ /**
19456
+ *
19457
+ * @type {number}
19458
+ * @memberof HitSessionStart
19459
+ */
19460
+ screen_height?: number;
19461
+ /**
19462
+ *
19463
+ * @type {number}
19464
+ * @memberof HitSessionStart
19465
+ */
19466
+ screen_width?: number;
19467
+ /**
19468
+ *
19469
+ * @type {number}
19470
+ * @memberof HitSessionStart
19471
+ */
19472
+ time_on_Site?: number;
19473
+ /**
19474
+ *
19475
+ * @type {string}
19476
+ * @memberof HitSessionStart
19477
+ */
19478
+ user_agent?: string;
19479
+ /**
19480
+ *
19481
+ * @type {string}
19482
+ * @memberof HitSessionStart
19483
+ */
19484
+ user_ip?: string;
19485
+ }
19486
+ /**
19487
+ *
19488
+ * @export
19489
+ * @interface HitSessionUtm
19490
+ */
19491
+ export interface HitSessionUtm {
19492
+ /**
19493
+ *
19494
+ * @type {string}
19495
+ * @memberof HitSessionUtm
19496
+ */
19497
+ fb_ad_id?: string;
19498
+ /**
19499
+ *
19500
+ * @type {string}
19501
+ * @memberof HitSessionUtm
19502
+ */
19503
+ fbclid?: string;
19504
+ /**
19505
+ *
19506
+ * @type {string}
19507
+ * @memberof HitSessionUtm
19508
+ */
19509
+ gbraid?: string;
19510
+ /**
19511
+ *
19512
+ * @type {string}
19513
+ * @memberof HitSessionUtm
19514
+ */
19515
+ gclid?: string;
19516
+ /**
19517
+ *
19518
+ * @type {string}
19519
+ * @memberof HitSessionUtm
19520
+ */
19521
+ msclkid?: string;
19522
+ /**
19523
+ *
19524
+ * @type {string}
19525
+ * @memberof HitSessionUtm
19526
+ */
19527
+ ttclid?: string;
19528
+ /**
19529
+ *
19530
+ * @type {string}
19531
+ * @memberof HitSessionUtm
19532
+ */
19533
+ uc_message_id?: string;
19534
+ /**
19535
+ *
19536
+ * @type {string}
19537
+ * @memberof HitSessionUtm
19538
+ */
19539
+ utm_campaign?: string;
19540
+ /**
19541
+ *
19542
+ * @type {string}
19543
+ * @memberof HitSessionUtm
19544
+ */
19545
+ utm_content?: string;
19546
+ /**
19547
+ *
19548
+ * @type {string}
19549
+ * @memberof HitSessionUtm
19550
+ */
19551
+ utm_id?: string;
19552
+ /**
19553
+ *
19554
+ * @type {string}
19555
+ * @memberof HitSessionUtm
19556
+ */
19557
+ utm_medium?: string;
19558
+ /**
19559
+ *
19560
+ * @type {string}
19561
+ * @memberof HitSessionUtm
19562
+ */
19563
+ utm_source?: string;
19564
+ /**
19565
+ *
19566
+ * @type {string}
19567
+ * @memberof HitSessionUtm
19568
+ */
19569
+ utm_term?: string;
19570
+ /**
19571
+ *
19572
+ * @type {string}
19573
+ * @memberof HitSessionUtm
19574
+ */
19575
+ vmcid?: string;
19576
+ /**
19577
+ *
19578
+ * @type {string}
19579
+ * @memberof HitSessionUtm
19580
+ */
19581
+ wbraid?: string;
19582
+ }
19235
19583
  /**
19236
19584
  *
19237
19585
  * @export
@@ -37320,6 +37668,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
37320
37668
  * @throws {RequiredError}
37321
37669
  */
37322
37670
  getConversation(conversation_uuid: string, limit?: number, options?: any): FetchArgs;
37671
+ /**
37672
+ * Get a webchat conversation context
37673
+ * @summary Get a webchat conversation context
37674
+ * @param {string} conversation_uuid
37675
+ * @param {*} [options] Override http request option.
37676
+ * @throws {RequiredError}
37677
+ */
37678
+ getConversationContext(conversation_uuid: string, options?: any): FetchArgs;
37323
37679
  /**
37324
37680
  * Retrieve conversation messages since a particular time
37325
37681
  * @summary Retrieve conversation messages
@@ -37418,6 +37774,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
37418
37774
  * @throws {RequiredError}
37419
37775
  */
37420
37776
  getConversation(conversation_uuid: string, limit?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationResponse>;
37777
+ /**
37778
+ * Get a webchat conversation context
37779
+ * @summary Get a webchat conversation context
37780
+ * @param {string} conversation_uuid
37781
+ * @param {*} [options] Override http request option.
37782
+ * @throws {RequiredError}
37783
+ */
37784
+ getConversationContext(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatContext>;
37421
37785
  /**
37422
37786
  * Retrieve conversation messages since a particular time
37423
37787
  * @summary Retrieve conversation messages
@@ -37516,6 +37880,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
37516
37880
  * @throws {RequiredError}
37517
37881
  */
37518
37882
  getConversation(conversation_uuid: string, limit?: number, options?: any): Promise<ConversationResponse>;
37883
+ /**
37884
+ * Get a webchat conversation context
37885
+ * @summary Get a webchat conversation context
37886
+ * @param {string} conversation_uuid
37887
+ * @param {*} [options] Override http request option.
37888
+ * @throws {RequiredError}
37889
+ */
37890
+ getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
37519
37891
  /**
37520
37892
  * Retrieve conversation messages since a particular time
37521
37893
  * @summary Retrieve conversation messages
@@ -37618,6 +37990,15 @@ export interface ConversationApiInterface {
37618
37990
  * @memberof ConversationApiInterface
37619
37991
  */
37620
37992
  getConversation(conversation_uuid: string, limit?: number, options?: any): Promise<ConversationResponse>;
37993
+ /**
37994
+ * Get a webchat conversation context
37995
+ * @summary Get a webchat conversation context
37996
+ * @param {string} conversation_uuid
37997
+ * @param {*} [options] Override http request option.
37998
+ * @throws {RequiredError}
37999
+ * @memberof ConversationApiInterface
38000
+ */
38001
+ getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
37621
38002
  /**
37622
38003
  * Retrieve conversation messages since a particular time
37623
38004
  * @summary Retrieve conversation messages
@@ -37729,6 +38110,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
37729
38110
  * @memberof ConversationApi
37730
38111
  */
37731
38112
  getConversation(conversation_uuid: string, limit?: number, options?: any): Promise<ConversationResponse>;
38113
+ /**
38114
+ * Get a webchat conversation context
38115
+ * @summary Get a webchat conversation context
38116
+ * @param {string} conversation_uuid
38117
+ * @param {*} [options] Override http request option.
38118
+ * @throws {RequiredError}
38119
+ * @memberof ConversationApi
38120
+ */
38121
+ getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
37732
38122
  /**
37733
38123
  * Retrieve conversation messages since a particular time
37734
38124
  * @summary Retrieve conversation messages
package/dist/api.js CHANGED
@@ -507,6 +507,7 @@ var ConversationWebsocketMessage;
507
507
  EventTypeEnum[EventTypeEnum["Typing"] = 'typing'] = "Typing";
508
508
  EventTypeEnum[EventTypeEnum["AddCoupon"] = 'add coupon'] = "AddCoupon";
509
509
  EventTypeEnum[EventTypeEnum["AddItem"] = 'add item'] = "AddItem";
510
+ EventTypeEnum[EventTypeEnum["WebchatContext"] = 'webchat context'] = "WebchatContext";
510
511
  })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
511
512
  /**
512
513
  * @export
@@ -5589,6 +5590,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
5589
5590
  options: localVarRequestOptions,
5590
5591
  };
5591
5592
  },
5593
+ /**
5594
+ * Get a webchat conversation context
5595
+ * @summary Get a webchat conversation context
5596
+ * @param {string} conversation_uuid
5597
+ * @param {*} [options] Override http request option.
5598
+ * @throws {RequiredError}
5599
+ */
5600
+ getConversationContext: function (conversation_uuid, options) {
5601
+ if (options === void 0) { options = {}; }
5602
+ // verify required parameter 'conversation_uuid' is not null or undefined
5603
+ if (conversation_uuid === null || conversation_uuid === undefined) {
5604
+ throw new RequiredError('conversation_uuid', 'Required parameter conversation_uuid was null or undefined when calling getConversationContext.');
5605
+ }
5606
+ var localVarPath = "/conversation/conversations/{conversation_uuid}/context"
5607
+ .replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(conversation_uuid)));
5608
+ var localVarUrlObj = url.parse(localVarPath, true);
5609
+ var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
5610
+ var localVarHeaderParameter = {};
5611
+ var localVarQueryParameter = {};
5612
+ if (configuration && configuration.apiVersion) {
5613
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
5614
+ }
5615
+ // authentication ultraCartOauth required
5616
+ // oauth required
5617
+ if (configuration && configuration.accessToken) {
5618
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
5619
+ ? configuration.accessToken("ultraCartOauth", ["conversation_write"])
5620
+ : configuration.accessToken;
5621
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
5622
+ }
5623
+ // authentication ultraCartSimpleApiKey required
5624
+ if (configuration && configuration.apiKey) {
5625
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
5626
+ ? configuration.apiKey("x-ultracart-simple-key")
5627
+ : configuration.apiKey;
5628
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
5629
+ }
5630
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
5631
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
5632
+ delete localVarUrlObj.search;
5633
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
5634
+ return {
5635
+ url: url.format(localVarUrlObj),
5636
+ options: localVarRequestOptions,
5637
+ };
5638
+ },
5592
5639
  /**
5593
5640
  * Retrieve conversation messages since a particular time
5594
5641
  * @summary Retrieve conversation messages
@@ -6055,6 +6102,28 @@ var ConversationApiFp = function (configuration) {
6055
6102
  });
6056
6103
  };
6057
6104
  },
6105
+ /**
6106
+ * Get a webchat conversation context
6107
+ * @summary Get a webchat conversation context
6108
+ * @param {string} conversation_uuid
6109
+ * @param {*} [options] Override http request option.
6110
+ * @throws {RequiredError}
6111
+ */
6112
+ getConversationContext: function (conversation_uuid, options) {
6113
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationContext(conversation_uuid, options);
6114
+ return function (fetch, basePath) {
6115
+ if (fetch === void 0) { fetch = portableFetch; }
6116
+ if (basePath === void 0) { basePath = BASE_PATH; }
6117
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
6118
+ if (response.status >= 200 && response.status < 300) {
6119
+ return response.json();
6120
+ }
6121
+ else {
6122
+ throw response;
6123
+ }
6124
+ });
6125
+ };
6126
+ },
6058
6127
  /**
6059
6128
  * Retrieve conversation messages since a particular time
6060
6129
  * @summary Retrieve conversation messages
@@ -6274,6 +6343,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
6274
6343
  getConversation: function (conversation_uuid, limit, options) {
6275
6344
  return (0, exports.ConversationApiFp)(configuration).getConversation(conversation_uuid, limit, options)(fetch, basePath);
6276
6345
  },
6346
+ /**
6347
+ * Get a webchat conversation context
6348
+ * @summary Get a webchat conversation context
6349
+ * @param {string} conversation_uuid
6350
+ * @param {*} [options] Override http request option.
6351
+ * @throws {RequiredError}
6352
+ */
6353
+ getConversationContext: function (conversation_uuid, options) {
6354
+ return (0, exports.ConversationApiFp)(configuration).getConversationContext(conversation_uuid, options)(fetch, basePath);
6355
+ },
6277
6356
  /**
6278
6357
  * Retrieve conversation messages since a particular time
6279
6358
  * @summary Retrieve conversation messages
@@ -6405,6 +6484,17 @@ var ConversationApi = /** @class */ (function (_super) {
6405
6484
  ConversationApi.prototype.getConversation = function (conversation_uuid, limit, options) {
6406
6485
  return (0, exports.ConversationApiFp)(this.configuration).getConversation(conversation_uuid, limit, options)(this.fetch, this.basePath);
6407
6486
  };
6487
+ /**
6488
+ * Get a webchat conversation context
6489
+ * @summary Get a webchat conversation context
6490
+ * @param {string} conversation_uuid
6491
+ * @param {*} [options] Override http request option.
6492
+ * @throws {RequiredError}
6493
+ * @memberof ConversationApi
6494
+ */
6495
+ ConversationApi.prototype.getConversationContext = function (conversation_uuid, options) {
6496
+ return (0, exports.ConversationApiFp)(this.configuration).getConversationContext(conversation_uuid, options)(this.fetch, this.basePath);
6497
+ };
6408
6498
  /**
6409
6499
  * Retrieve conversation messages since a particular time
6410
6500
  * @summary Retrieve conversation messages
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.68",
3
+ "version": "3.10.70",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [