ultracart_rest_api_v2_typescript 3.10.32 → 3.10.35

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.32
1
+ ## ultracart_rest_api_v2_typescript@3.10.35
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.32 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.35 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.35 | 08/05/2022 | conversation adjustments for ES integration |
58
+ | 3.10.34 | 08/05/2022 | conversations query by medium and stats fixes |
59
+ | 3.10.33 | 08/03/2022 | conversation summary participants |
57
60
  | 3.10.32 | 08/03/2022 | more conversation events |
58
61
  | 3.10.31 | 08/02/2022 | storefront communication sequence test method |
59
62
  | 3.10.30 | 08/01/2022 | conversation event refinement |
package/api.ts CHANGED
@@ -6277,12 +6277,48 @@ export interface Conversation {
6277
6277
  * @memberof Conversation
6278
6278
  */
6279
6279
  conversation_uuid?: string;
6280
+ /**
6281
+ *
6282
+ * @type {string}
6283
+ * @memberof Conversation
6284
+ */
6285
+ last_conversation_message_body?: string;
6286
+ /**
6287
+ *
6288
+ * @type {string}
6289
+ * @memberof Conversation
6290
+ */
6291
+ last_conversation_participant_arn?: string;
6292
+ /**
6293
+ *
6294
+ * @type {string}
6295
+ * @memberof Conversation
6296
+ */
6297
+ last_conversation_participant_name?: string;
6298
+ /**
6299
+ * Last message date/time
6300
+ * @type {string}
6301
+ * @memberof Conversation
6302
+ */
6303
+ last_message_dts?: string;
6304
+ /**
6305
+ * The communication medium of the customer.
6306
+ * @type {string}
6307
+ * @memberof Conversation
6308
+ */
6309
+ medium?: Conversation.MediumEnum;
6280
6310
  /**
6281
6311
  *
6282
6312
  * @type {string}
6283
6313
  * @memberof Conversation
6284
6314
  */
6285
6315
  merchant_id?: string;
6316
+ /**
6317
+ *
6318
+ * @type {number}
6319
+ * @memberof Conversation
6320
+ */
6321
+ message_count?: number;
6286
6322
  /**
6287
6323
  *
6288
6324
  * @type {Array<ConversationMessage>}
@@ -6295,6 +6331,39 @@ export interface Conversation {
6295
6331
  * @memberof Conversation
6296
6332
  */
6297
6333
  participants?: Array<ConversationParticipant>;
6334
+ /**
6335
+ * Start of the conversation date/time
6336
+ * @type {string}
6337
+ * @memberof Conversation
6338
+ */
6339
+ start_dts?: string;
6340
+ /**
6341
+ *
6342
+ * @type {boolean}
6343
+ * @memberof Conversation
6344
+ */
6345
+ unread_messages?: boolean;
6346
+ /**
6347
+ *
6348
+ * @type {boolean}
6349
+ * @memberof Conversation
6350
+ */
6351
+ visible?: boolean;
6352
+ }
6353
+
6354
+ /**
6355
+ * @export
6356
+ * @namespace Conversation
6357
+ */
6358
+ export namespace Conversation {
6359
+ /**
6360
+ * @export
6361
+ * @enum {string}
6362
+ */
6363
+ export enum MediumEnum {
6364
+ Sms = <any> 'sms',
6365
+ Websocket = <any> 'websocket'
6366
+ }
6298
6367
  }
6299
6368
 
6300
6369
  /**
@@ -6520,12 +6589,24 @@ export interface ConversationMessage {
6520
6589
  * @memberof ConversationMessage
6521
6590
  */
6522
6591
  client_message_id?: string;
6592
+ /**
6593
+ *
6594
+ * @type {string}
6595
+ * @memberof ConversationMessage
6596
+ */
6597
+ conversation_message_uuid?: string;
6523
6598
  /**
6524
6599
  *
6525
6600
  * @type {Array<string>}
6526
6601
  * @memberof ConversationMessage
6527
6602
  */
6528
6603
  media_urls?: Array<string>;
6604
+ /**
6605
+ *
6606
+ * @type {string}
6607
+ * @memberof ConversationMessage
6608
+ */
6609
+ merchant_id?: string;
6529
6610
  /**
6530
6611
  * Message date/time
6531
6612
  * @type {string}
@@ -6821,6 +6902,12 @@ export interface ConversationSummary {
6821
6902
  * @memberof ConversationSummary
6822
6903
  */
6823
6904
  last_message_dts?: string;
6905
+ /**
6906
+ * The communication medium of the customer.
6907
+ * @type {string}
6908
+ * @memberof ConversationSummary
6909
+ */
6910
+ medium?: ConversationSummary.MediumEnum;
6824
6911
  /**
6825
6912
  *
6826
6913
  * @type {string}
@@ -6833,6 +6920,12 @@ export interface ConversationSummary {
6833
6920
  * @memberof ConversationSummary
6834
6921
  */
6835
6922
  message_count?: number;
6923
+ /**
6924
+ *
6925
+ * @type {Array<ConversationParticipant>}
6926
+ * @memberof ConversationSummary
6927
+ */
6928
+ participants?: Array<ConversationParticipant>;
6836
6929
  /**
6837
6930
  * Start of the conversation date/time
6838
6931
  * @type {string}
@@ -6853,6 +6946,21 @@ export interface ConversationSummary {
6853
6946
  visible?: boolean;
6854
6947
  }
6855
6948
 
6949
+ /**
6950
+ * @export
6951
+ * @namespace ConversationSummary
6952
+ */
6953
+ export namespace ConversationSummary {
6954
+ /**
6955
+ * @export
6956
+ * @enum {string}
6957
+ */
6958
+ export enum MediumEnum {
6959
+ Sms = <any> 'sms',
6960
+ Websocket = <any> 'websocket'
6961
+ }
6962
+ }
6963
+
6856
6964
  /**
6857
6965
  *
6858
6966
  * @export
@@ -7135,6 +7243,12 @@ export interface ConversationWebsocketMessage {
7135
7243
  * @memberof ConversationWebsocketMessage
7136
7244
  */
7137
7245
  event_new_message?: ConversationSummary;
7246
+ /**
7247
+ *
7248
+ * @type {ConversationSummary}
7249
+ * @memberof ConversationWebsocketMessage
7250
+ */
7251
+ event_participant_update?: ConversationSummary;
7138
7252
  /**
7139
7253
  *
7140
7254
  * @type {ConversationEventQueuePosition}
@@ -7202,7 +7316,8 @@ export namespace ConversationWebsocketMessage {
7202
7316
  NewMessage = <any> 'new message',
7203
7317
  UpdatedMessage = <any> 'updated message',
7204
7318
  QueueStatusUpdate = <any> 'queue status update',
7205
- Rrweb = <any> 'rrweb'
7319
+ Rrweb = <any> 'rrweb',
7320
+ ParticipantUpdate = <any> 'participant update'
7206
7321
  }
7207
7322
  /**
7208
7323
  * @export
@@ -39294,12 +39409,13 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
39294
39409
  /**
39295
39410
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39296
39411
  * @summary Retrieve a list of conversation summaries newest to oldest
39412
+ * @param {string} [medium]
39297
39413
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
39298
39414
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
39299
39415
  * @param {*} [options] Override http request option.
39300
39416
  * @throws {RequiredError}
39301
39417
  */
39302
- getConversations(_limit?: number, _offset?: number, options: any = {}): FetchArgs {
39418
+ getConversations(medium?: string, _limit?: number, _offset?: number, options: any = {}): FetchArgs {
39303
39419
  const localVarPath = `/conversation/conversations`;
39304
39420
  const localVarUrlObj = url.parse(localVarPath, true);
39305
39421
  const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
@@ -39329,6 +39445,10 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
39329
39445
  localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
39330
39446
  }
39331
39447
 
39448
+ if (medium !== undefined) {
39449
+ localVarQueryParameter['medium'] = medium;
39450
+ }
39451
+
39332
39452
  if (_limit !== undefined) {
39333
39453
  localVarQueryParameter['_limit'] = _limit;
39334
39454
  }
@@ -39661,13 +39781,14 @@ export const ConversationApiFp = function(configuration?: Configuration) {
39661
39781
  /**
39662
39782
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39663
39783
  * @summary Retrieve a list of conversation summaries newest to oldest
39784
+ * @param {string} [medium]
39664
39785
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
39665
39786
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
39666
39787
  * @param {*} [options] Override http request option.
39667
39788
  * @throws {RequiredError}
39668
39789
  */
39669
- getConversations(_limit?: number, _offset?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationsResponse> {
39670
- const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversations(_limit, _offset, options);
39790
+ getConversations(medium?: string, _limit?: number, _offset?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationsResponse> {
39791
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversations(medium, _limit, _offset, options);
39671
39792
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
39672
39793
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
39673
39794
 
@@ -39815,13 +39936,14 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
39815
39936
  /**
39816
39937
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39817
39938
  * @summary Retrieve a list of conversation summaries newest to oldest
39939
+ * @param {string} [medium]
39818
39940
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
39819
39941
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
39820
39942
  * @param {*} [options] Override http request option.
39821
39943
  * @throws {RequiredError}
39822
39944
  */
39823
- getConversations(_limit?: number, _offset?: number, options?: any) {
39824
- return ConversationApiFp(configuration).getConversations(_limit, _offset, options)(fetch, basePath);
39945
+ getConversations(medium?: string, _limit?: number, _offset?: number, options?: any) {
39946
+ return ConversationApiFp(configuration).getConversations(medium, _limit, _offset, options)(fetch, basePath);
39825
39947
  },
39826
39948
  /**
39827
39949
  * Join a conversation
@@ -39914,13 +40036,14 @@ export interface ConversationApiInterface {
39914
40036
  /**
39915
40037
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
39916
40038
  * @summary Retrieve a list of conversation summaries newest to oldest
40039
+ * @param {string} [medium]
39917
40040
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
39918
40041
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
39919
40042
  * @param {*} [options] Override http request option.
39920
40043
  * @throws {RequiredError}
39921
40044
  * @memberof ConversationApiInterface
39922
40045
  */
39923
- getConversations(_limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
40046
+ getConversations(medium?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
39924
40047
 
39925
40048
  /**
39926
40049
  * Join a conversation
@@ -40021,14 +40144,15 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
40021
40144
  /**
40022
40145
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
40023
40146
  * @summary Retrieve a list of conversation summaries newest to oldest
40147
+ * @param {string} [medium]
40024
40148
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
40025
40149
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
40026
40150
  * @param {*} [options] Override http request option.
40027
40151
  * @throws {RequiredError}
40028
40152
  * @memberof ConversationApi
40029
40153
  */
40030
- public getConversations(_limit?: number, _offset?: number, options?: any) {
40031
- return ConversationApiFp(this.configuration).getConversations(_limit, _offset, options)(this.fetch, this.basePath);
40154
+ public getConversations(medium?: string, _limit?: number, _offset?: number, options?: any) {
40155
+ return ConversationApiFp(this.configuration).getConversations(medium, _limit, _offset, options)(this.fetch, this.basePath);
40032
40156
  }
40033
40157
 
40034
40158
  /**
package/dist/api.d.ts CHANGED
@@ -6130,12 +6130,48 @@ export interface Conversation {
6130
6130
  * @memberof Conversation
6131
6131
  */
6132
6132
  conversation_uuid?: string;
6133
+ /**
6134
+ *
6135
+ * @type {string}
6136
+ * @memberof Conversation
6137
+ */
6138
+ last_conversation_message_body?: string;
6139
+ /**
6140
+ *
6141
+ * @type {string}
6142
+ * @memberof Conversation
6143
+ */
6144
+ last_conversation_participant_arn?: string;
6145
+ /**
6146
+ *
6147
+ * @type {string}
6148
+ * @memberof Conversation
6149
+ */
6150
+ last_conversation_participant_name?: string;
6151
+ /**
6152
+ * Last message date/time
6153
+ * @type {string}
6154
+ * @memberof Conversation
6155
+ */
6156
+ last_message_dts?: string;
6157
+ /**
6158
+ * The communication medium of the customer.
6159
+ * @type {string}
6160
+ * @memberof Conversation
6161
+ */
6162
+ medium?: Conversation.MediumEnum;
6133
6163
  /**
6134
6164
  *
6135
6165
  * @type {string}
6136
6166
  * @memberof Conversation
6137
6167
  */
6138
6168
  merchant_id?: string;
6169
+ /**
6170
+ *
6171
+ * @type {number}
6172
+ * @memberof Conversation
6173
+ */
6174
+ message_count?: number;
6139
6175
  /**
6140
6176
  *
6141
6177
  * @type {Array<ConversationMessage>}
@@ -6148,6 +6184,38 @@ export interface Conversation {
6148
6184
  * @memberof Conversation
6149
6185
  */
6150
6186
  participants?: Array<ConversationParticipant>;
6187
+ /**
6188
+ * Start of the conversation date/time
6189
+ * @type {string}
6190
+ * @memberof Conversation
6191
+ */
6192
+ start_dts?: string;
6193
+ /**
6194
+ *
6195
+ * @type {boolean}
6196
+ * @memberof Conversation
6197
+ */
6198
+ unread_messages?: boolean;
6199
+ /**
6200
+ *
6201
+ * @type {boolean}
6202
+ * @memberof Conversation
6203
+ */
6204
+ visible?: boolean;
6205
+ }
6206
+ /**
6207
+ * @export
6208
+ * @namespace Conversation
6209
+ */
6210
+ export declare namespace Conversation {
6211
+ /**
6212
+ * @export
6213
+ * @enum {string}
6214
+ */
6215
+ enum MediumEnum {
6216
+ Sms,
6217
+ Websocket
6218
+ }
6151
6219
  }
6152
6220
  /**
6153
6221
  *
@@ -6366,12 +6434,24 @@ export interface ConversationMessage {
6366
6434
  * @memberof ConversationMessage
6367
6435
  */
6368
6436
  client_message_id?: string;
6437
+ /**
6438
+ *
6439
+ * @type {string}
6440
+ * @memberof ConversationMessage
6441
+ */
6442
+ conversation_message_uuid?: string;
6369
6443
  /**
6370
6444
  *
6371
6445
  * @type {Array<string>}
6372
6446
  * @memberof ConversationMessage
6373
6447
  */
6374
6448
  media_urls?: Array<string>;
6449
+ /**
6450
+ *
6451
+ * @type {string}
6452
+ * @memberof ConversationMessage
6453
+ */
6454
+ merchant_id?: string;
6375
6455
  /**
6376
6456
  * Message date/time
6377
6457
  * @type {string}
@@ -6658,6 +6738,12 @@ export interface ConversationSummary {
6658
6738
  * @memberof ConversationSummary
6659
6739
  */
6660
6740
  last_message_dts?: string;
6741
+ /**
6742
+ * The communication medium of the customer.
6743
+ * @type {string}
6744
+ * @memberof ConversationSummary
6745
+ */
6746
+ medium?: ConversationSummary.MediumEnum;
6661
6747
  /**
6662
6748
  *
6663
6749
  * @type {string}
@@ -6670,6 +6756,12 @@ export interface ConversationSummary {
6670
6756
  * @memberof ConversationSummary
6671
6757
  */
6672
6758
  message_count?: number;
6759
+ /**
6760
+ *
6761
+ * @type {Array<ConversationParticipant>}
6762
+ * @memberof ConversationSummary
6763
+ */
6764
+ participants?: Array<ConversationParticipant>;
6673
6765
  /**
6674
6766
  * Start of the conversation date/time
6675
6767
  * @type {string}
@@ -6689,6 +6781,20 @@ export interface ConversationSummary {
6689
6781
  */
6690
6782
  visible?: boolean;
6691
6783
  }
6784
+ /**
6785
+ * @export
6786
+ * @namespace ConversationSummary
6787
+ */
6788
+ export declare namespace ConversationSummary {
6789
+ /**
6790
+ * @export
6791
+ * @enum {string}
6792
+ */
6793
+ enum MediumEnum {
6794
+ Sms,
6795
+ Websocket
6796
+ }
6797
+ }
6692
6798
  /**
6693
6799
  *
6694
6800
  * @export
@@ -6965,6 +7071,12 @@ export interface ConversationWebsocketMessage {
6965
7071
  * @memberof ConversationWebsocketMessage
6966
7072
  */
6967
7073
  event_new_message?: ConversationSummary;
7074
+ /**
7075
+ *
7076
+ * @type {ConversationSummary}
7077
+ * @memberof ConversationWebsocketMessage
7078
+ */
7079
+ event_participant_update?: ConversationSummary;
6968
7080
  /**
6969
7081
  *
6970
7082
  * @type {ConversationEventQueuePosition}
@@ -7031,7 +7143,8 @@ export declare namespace ConversationWebsocketMessage {
7031
7143
  NewMessage,
7032
7144
  UpdatedMessage,
7033
7145
  QueueStatusUpdate,
7034
- Rrweb
7146
+ Rrweb,
7147
+ ParticipantUpdate
7035
7148
  }
7036
7149
  /**
7037
7150
  * @export
@@ -35416,12 +35529,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
35416
35529
  /**
35417
35530
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35418
35531
  * @summary Retrieve a list of conversation summaries newest to oldest
35532
+ * @param {string} [medium]
35419
35533
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
35420
35534
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
35421
35535
  * @param {*} [options] Override http request option.
35422
35536
  * @throws {RequiredError}
35423
35537
  */
35424
- getConversations(_limit?: number, _offset?: number, options?: any): FetchArgs;
35538
+ getConversations(medium?: string, _limit?: number, _offset?: number, options?: any): FetchArgs;
35425
35539
  /**
35426
35540
  * Join a conversation
35427
35541
  * @summary Join a conversation
@@ -35494,12 +35608,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
35494
35608
  /**
35495
35609
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35496
35610
  * @summary Retrieve a list of conversation summaries newest to oldest
35611
+ * @param {string} [medium]
35497
35612
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
35498
35613
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
35499
35614
  * @param {*} [options] Override http request option.
35500
35615
  * @throws {RequiredError}
35501
35616
  */
35502
- getConversations(_limit?: number, _offset?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationsResponse>;
35617
+ getConversations(medium?: string, _limit?: number, _offset?: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationsResponse>;
35503
35618
  /**
35504
35619
  * Join a conversation
35505
35620
  * @summary Join a conversation
@@ -35572,12 +35687,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
35572
35687
  /**
35573
35688
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35574
35689
  * @summary Retrieve a list of conversation summaries newest to oldest
35690
+ * @param {string} [medium]
35575
35691
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
35576
35692
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
35577
35693
  * @param {*} [options] Override http request option.
35578
35694
  * @throws {RequiredError}
35579
35695
  */
35580
- getConversations(_limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
35696
+ getConversations(medium?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
35581
35697
  /**
35582
35698
  * Join a conversation
35583
35699
  * @summary Join a conversation
@@ -35655,13 +35771,14 @@ export interface ConversationApiInterface {
35655
35771
  /**
35656
35772
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35657
35773
  * @summary Retrieve a list of conversation summaries newest to oldest
35774
+ * @param {string} [medium]
35658
35775
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
35659
35776
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
35660
35777
  * @param {*} [options] Override http request option.
35661
35778
  * @throws {RequiredError}
35662
35779
  * @memberof ConversationApiInterface
35663
35780
  */
35664
- getConversations(_limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
35781
+ getConversations(medium?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
35665
35782
  /**
35666
35783
  * Join a conversation
35667
35784
  * @summary Join a conversation
@@ -35744,13 +35861,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
35744
35861
  /**
35745
35862
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
35746
35863
  * @summary Retrieve a list of conversation summaries newest to oldest
35864
+ * @param {string} [medium]
35747
35865
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
35748
35866
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
35749
35867
  * @param {*} [options] Override http request option.
35750
35868
  * @throws {RequiredError}
35751
35869
  * @memberof ConversationApi
35752
35870
  */
35753
- getConversations(_limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
35871
+ getConversations(medium?: string, _limit?: number, _offset?: number, options?: any): Promise<ConversationsResponse>;
35754
35872
  /**
35755
35873
  * Join a conversation
35756
35874
  * @summary Join a conversation
package/dist/api.js CHANGED
@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
28
28
  };
29
29
  })();
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
- exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
- exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = void 0;
33
- exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = void 0;
31
+ exports.Weight = exports.Webhook = exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationSummary = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
+ exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = void 0;
33
+ exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = void 0;
34
34
  var url = require("url");
35
35
  var portableFetch = require("portable-fetch");
36
36
  var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -359,6 +359,22 @@ var CheckoutHandoffRequest;
359
359
  OperationEnum[OperationEnum["Sezzle"] = 'sezzle'] = "Sezzle";
360
360
  })(OperationEnum = CheckoutHandoffRequest.OperationEnum || (CheckoutHandoffRequest.OperationEnum = {}));
361
361
  })(CheckoutHandoffRequest = exports.CheckoutHandoffRequest || (exports.CheckoutHandoffRequest = {}));
362
+ /**
363
+ * @export
364
+ * @namespace Conversation
365
+ */
366
+ var Conversation;
367
+ (function (Conversation) {
368
+ /**
369
+ * @export
370
+ * @enum {string}
371
+ */
372
+ var MediumEnum;
373
+ (function (MediumEnum) {
374
+ MediumEnum[MediumEnum["Sms"] = 'sms'] = "Sms";
375
+ MediumEnum[MediumEnum["Websocket"] = 'websocket'] = "Websocket";
376
+ })(MediumEnum = Conversation.MediumEnum || (Conversation.MediumEnum = {}));
377
+ })(Conversation = exports.Conversation || (exports.Conversation = {}));
362
378
  /**
363
379
  * @export
364
380
  * @namespace ConversationEventRRWeb
@@ -391,6 +407,22 @@ var ConversationMessage;
391
407
  TypeEnum[TypeEnum["Notice"] = 'notice'] = "Notice";
392
408
  })(TypeEnum = ConversationMessage.TypeEnum || (ConversationMessage.TypeEnum = {}));
393
409
  })(ConversationMessage = exports.ConversationMessage || (exports.ConversationMessage = {}));
410
+ /**
411
+ * @export
412
+ * @namespace ConversationSummary
413
+ */
414
+ var ConversationSummary;
415
+ (function (ConversationSummary) {
416
+ /**
417
+ * @export
418
+ * @enum {string}
419
+ */
420
+ var MediumEnum;
421
+ (function (MediumEnum) {
422
+ MediumEnum[MediumEnum["Sms"] = 'sms'] = "Sms";
423
+ MediumEnum[MediumEnum["Websocket"] = 'websocket'] = "Websocket";
424
+ })(MediumEnum = ConversationSummary.MediumEnum || (ConversationSummary.MediumEnum = {}));
425
+ })(ConversationSummary = exports.ConversationSummary || (exports.ConversationSummary = {}));
394
426
  /**
395
427
  * @export
396
428
  * @namespace ConversationWebsocketMessage
@@ -411,6 +443,7 @@ var ConversationWebsocketMessage;
411
443
  EventTypeEnum[EventTypeEnum["UpdatedMessage"] = 'updated message'] = "UpdatedMessage";
412
444
  EventTypeEnum[EventTypeEnum["QueueStatusUpdate"] = 'queue status update'] = "QueueStatusUpdate";
413
445
  EventTypeEnum[EventTypeEnum["Rrweb"] = 'rrweb'] = "Rrweb";
446
+ EventTypeEnum[EventTypeEnum["ParticipantUpdate"] = 'participant update'] = "ParticipantUpdate";
414
447
  })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
415
448
  /**
416
449
  * @export
@@ -5536,12 +5569,13 @@ var ConversationApiFetchParamCreator = function (configuration) {
5536
5569
  /**
5537
5570
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
5538
5571
  * @summary Retrieve a list of conversation summaries newest to oldest
5572
+ * @param {string} [medium]
5539
5573
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
5540
5574
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
5541
5575
  * @param {*} [options] Override http request option.
5542
5576
  * @throws {RequiredError}
5543
5577
  */
5544
- getConversations: function (_limit, _offset, options) {
5578
+ getConversations: function (medium, _limit, _offset, options) {
5545
5579
  if (options === void 0) { options = {}; }
5546
5580
  var localVarPath = "/conversation/conversations";
5547
5581
  var localVarUrlObj = url.parse(localVarPath, true);
@@ -5566,6 +5600,9 @@ var ConversationApiFetchParamCreator = function (configuration) {
5566
5600
  : configuration.apiKey;
5567
5601
  localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
5568
5602
  }
5603
+ if (medium !== undefined) {
5604
+ localVarQueryParameter['medium'] = medium;
5605
+ }
5569
5606
  if (_limit !== undefined) {
5570
5607
  localVarQueryParameter['_limit'] = _limit;
5571
5608
  }
@@ -5873,13 +5910,14 @@ var ConversationApiFp = function (configuration) {
5873
5910
  /**
5874
5911
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
5875
5912
  * @summary Retrieve a list of conversation summaries newest to oldest
5913
+ * @param {string} [medium]
5876
5914
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
5877
5915
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
5878
5916
  * @param {*} [options] Override http request option.
5879
5917
  * @throws {RequiredError}
5880
5918
  */
5881
- getConversations: function (_limit, _offset, options) {
5882
- var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversations(_limit, _offset, options);
5919
+ getConversations: function (medium, _limit, _offset, options) {
5920
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversations(medium, _limit, _offset, options);
5883
5921
  return function (fetch, basePath) {
5884
5922
  if (fetch === void 0) { fetch = portableFetch; }
5885
5923
  if (basePath === void 0) { basePath = BASE_PATH; }
@@ -6032,13 +6070,14 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
6032
6070
  /**
6033
6071
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
6034
6072
  * @summary Retrieve a list of conversation summaries newest to oldest
6073
+ * @param {string} [medium]
6035
6074
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
6036
6075
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
6037
6076
  * @param {*} [options] Override http request option.
6038
6077
  * @throws {RequiredError}
6039
6078
  */
6040
- getConversations: function (_limit, _offset, options) {
6041
- return (0, exports.ConversationApiFp)(configuration).getConversations(_limit, _offset, options)(fetch, basePath);
6079
+ getConversations: function (medium, _limit, _offset, options) {
6080
+ return (0, exports.ConversationApiFp)(configuration).getConversations(medium, _limit, _offset, options)(fetch, basePath);
6042
6081
  },
6043
6082
  /**
6044
6083
  * Join a conversation
@@ -6140,14 +6179,15 @@ var ConversationApi = /** @class */ (function (_super) {
6140
6179
  /**
6141
6180
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
6142
6181
  * @summary Retrieve a list of conversation summaries newest to oldest
6182
+ * @param {string} [medium]
6143
6183
  * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
6144
6184
  * @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
6145
6185
  * @param {*} [options] Override http request option.
6146
6186
  * @throws {RequiredError}
6147
6187
  * @memberof ConversationApi
6148
6188
  */
6149
- ConversationApi.prototype.getConversations = function (_limit, _offset, options) {
6150
- return (0, exports.ConversationApiFp)(this.configuration).getConversations(_limit, _offset, options)(this.fetch, this.basePath);
6189
+ ConversationApi.prototype.getConversations = function (medium, _limit, _offset, options) {
6190
+ return (0, exports.ConversationApiFp)(this.configuration).getConversations(medium, _limit, _offset, options)(this.fetch, this.basePath);
6151
6191
  };
6152
6192
  /**
6153
6193
  * Join a conversation
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.32",
3
+ "version": "3.10.35",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [