ultracart_rest_api_v2_typescript 3.10.22 → 3.10.23

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.22
1
+ ## ultracart_rest_api_v2_typescript@3.10.23
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.22 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.23 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.23 | 07/25/2022 | conversations - add a websocket message model |
57
58
  | 3.10.22 | 07/20/2022 | conversation participant name added |
58
59
  | 3.10.21 | 07/18/2022 | twilio dev |
59
60
  | 3.10.20 | 07/14/2022 | Add channel storefront_oid to the customer activity record |
package/api.ts CHANGED
@@ -1392,6 +1392,12 @@ export interface AutoOrder {
1392
1392
  * @memberof AutoOrder
1393
1393
  */
1394
1394
  logs?: Array<AutoOrderLog>;
1395
+ /**
1396
+ *
1397
+ * @type {AutoOrderManagement}
1398
+ * @memberof AutoOrder
1399
+ */
1400
+ management?: AutoOrderManagement;
1395
1401
  /**
1396
1402
  * The next time that the auto order will be attempted for processing
1397
1403
  * @type {string}
@@ -1754,6 +1760,20 @@ export interface AutoOrderLog {
1754
1760
  log_message?: string;
1755
1761
  }
1756
1762
 
1763
+ /**
1764
+ *
1765
+ * @export
1766
+ * @interface AutoOrderManagement
1767
+ */
1768
+ export interface AutoOrderManagement {
1769
+ /**
1770
+ * URL where the customer can go to update their billing information.
1771
+ * @type {string}
1772
+ * @memberof AutoOrderManagement
1773
+ */
1774
+ update_billing_url?: string;
1775
+ }
1776
+
1757
1777
  /**
1758
1778
  *
1759
1779
  * @export
@@ -6274,47 +6294,93 @@ export interface Conversation {
6274
6294
  /**
6275
6295
  *
6276
6296
  * @export
6277
- * @interface ConversationAgentAuthResponse
6297
+ * @interface ConversationAgentAuth
6278
6298
  */
6279
- export interface ConversationAgentAuthResponse {
6299
+ export interface ConversationAgentAuth {
6280
6300
  /**
6281
6301
  *
6282
6302
  * @type {string}
6283
- * @memberof ConversationAgentAuthResponse
6303
+ * @memberof ConversationAgentAuth
6284
6304
  */
6285
6305
  conversation_participant_arn?: string;
6286
6306
  /**
6287
6307
  *
6288
6308
  * @type {string}
6289
- * @memberof ConversationAgentAuthResponse
6309
+ * @memberof ConversationAgentAuth
6290
6310
  */
6291
6311
  conversation_participant_name?: string;
6292
6312
  /**
6293
6313
  *
6294
6314
  * @type {string}
6295
- * @memberof ConversationAgentAuthResponse
6315
+ * @memberof ConversationAgentAuth
6296
6316
  */
6297
6317
  jwt?: string;
6298
6318
  /**
6299
6319
  *
6300
6320
  * @type {string}
6301
- * @memberof ConversationAgentAuthResponse
6321
+ * @memberof ConversationAgentAuth
6302
6322
  */
6303
6323
  merchant_id?: string;
6304
6324
  /**
6305
6325
  *
6306
6326
  * @type {Array<string>}
6307
- * @memberof ConversationAgentAuthResponse
6327
+ * @memberof ConversationAgentAuth
6308
6328
  */
6309
6329
  twilio_phone_numbers?: Array<string>;
6310
6330
  /**
6311
6331
  *
6312
6332
  * @type {string}
6313
- * @memberof ConversationAgentAuthResponse
6333
+ * @memberof ConversationAgentAuth
6314
6334
  */
6315
6335
  websocket_url?: string;
6316
6336
  }
6317
6337
 
6338
+ /**
6339
+ *
6340
+ * @export
6341
+ * @interface ConversationAgentAuthResponse
6342
+ */
6343
+ export interface ConversationAgentAuthResponse {
6344
+ /**
6345
+ *
6346
+ * @type {ConversationAgentAuth}
6347
+ * @memberof ConversationAgentAuthResponse
6348
+ */
6349
+ agent_auth?: ConversationAgentAuth;
6350
+ /**
6351
+ *
6352
+ * @type {ModelError}
6353
+ * @memberof ConversationAgentAuthResponse
6354
+ */
6355
+ error?: ModelError;
6356
+ /**
6357
+ *
6358
+ * @type {ResponseMetadata}
6359
+ * @memberof ConversationAgentAuthResponse
6360
+ */
6361
+ metadata?: ResponseMetadata;
6362
+ /**
6363
+ * Indicates if API call was successful
6364
+ * @type {boolean}
6365
+ * @memberof ConversationAgentAuthResponse
6366
+ */
6367
+ success?: boolean;
6368
+ /**
6369
+ *
6370
+ * @type {Warning}
6371
+ * @memberof ConversationAgentAuthResponse
6372
+ */
6373
+ warning?: Warning;
6374
+ }
6375
+
6376
+ /**
6377
+ *
6378
+ * @export
6379
+ * @interface ConversationEventQueuePosition
6380
+ */
6381
+ export interface ConversationEventQueuePosition {
6382
+ }
6383
+
6318
6384
  /**
6319
6385
  *
6320
6386
  * @export
@@ -6379,6 +6445,64 @@ export interface ConversationMessageTransportStatus {
6379
6445
  status?: string;
6380
6446
  }
6381
6447
 
6448
+ /**
6449
+ *
6450
+ * @export
6451
+ * @interface ConversationMultimediaUploadUrl
6452
+ */
6453
+ export interface ConversationMultimediaUploadUrl {
6454
+ /**
6455
+ *
6456
+ * @type {string}
6457
+ * @memberof ConversationMultimediaUploadUrl
6458
+ */
6459
+ key?: string;
6460
+ /**
6461
+ *
6462
+ * @type {string}
6463
+ * @memberof ConversationMultimediaUploadUrl
6464
+ */
6465
+ url?: string;
6466
+ }
6467
+
6468
+ /**
6469
+ *
6470
+ * @export
6471
+ * @interface ConversationMultimediaUploadUrlResponse
6472
+ */
6473
+ export interface ConversationMultimediaUploadUrlResponse {
6474
+ /**
6475
+ *
6476
+ * @type {ConversationMultimediaUploadUrl}
6477
+ * @memberof ConversationMultimediaUploadUrlResponse
6478
+ */
6479
+ conversation_multimedia_upload_url?: ConversationMultimediaUploadUrl;
6480
+ /**
6481
+ *
6482
+ * @type {ModelError}
6483
+ * @memberof ConversationMultimediaUploadUrlResponse
6484
+ */
6485
+ error?: ModelError;
6486
+ /**
6487
+ *
6488
+ * @type {ResponseMetadata}
6489
+ * @memberof ConversationMultimediaUploadUrlResponse
6490
+ */
6491
+ metadata?: ResponseMetadata;
6492
+ /**
6493
+ * Indicates if API call was successful
6494
+ * @type {boolean}
6495
+ * @memberof ConversationMultimediaUploadUrlResponse
6496
+ */
6497
+ success?: boolean;
6498
+ /**
6499
+ *
6500
+ * @type {Warning}
6501
+ * @memberof ConversationMultimediaUploadUrlResponse
6502
+ */
6503
+ warning?: Warning;
6504
+ }
6505
+
6382
6506
  /**
6383
6507
  *
6384
6508
  * @export
@@ -6429,6 +6553,44 @@ export interface ConversationParticipant {
6429
6553
  status?: string;
6430
6554
  }
6431
6555
 
6556
+ /**
6557
+ *
6558
+ * @export
6559
+ * @interface ConversationResponse
6560
+ */
6561
+ export interface ConversationResponse {
6562
+ /**
6563
+ *
6564
+ * @type {Conversation}
6565
+ * @memberof ConversationResponse
6566
+ */
6567
+ conversation?: Conversation;
6568
+ /**
6569
+ *
6570
+ * @type {ModelError}
6571
+ * @memberof ConversationResponse
6572
+ */
6573
+ error?: ModelError;
6574
+ /**
6575
+ *
6576
+ * @type {ResponseMetadata}
6577
+ * @memberof ConversationResponse
6578
+ */
6579
+ metadata?: ResponseMetadata;
6580
+ /**
6581
+ * Indicates if API call was successful
6582
+ * @type {boolean}
6583
+ * @memberof ConversationResponse
6584
+ */
6585
+ success?: boolean;
6586
+ /**
6587
+ *
6588
+ * @type {Warning}
6589
+ * @memberof ConversationResponse
6590
+ */
6591
+ warning?: Warning;
6592
+ }
6593
+
6432
6594
  /**
6433
6595
  *
6434
6596
  * @export
@@ -6447,6 +6609,12 @@ export interface ConversationStartRequest {
6447
6609
  * @memberof ConversationStartRequest
6448
6610
  */
6449
6611
  conversation_arn?: string;
6612
+ /**
6613
+ *
6614
+ * @type {string}
6615
+ * @memberof ConversationStartRequest
6616
+ */
6617
+ conversation_webchat_queue_uuid?: string;
6450
6618
  }
6451
6619
 
6452
6620
  /**
@@ -6457,16 +6625,10 @@ export interface ConversationStartRequest {
6457
6625
  export interface ConversationStartResponse {
6458
6626
  /**
6459
6627
  *
6460
- * @type {string}
6461
- * @memberof ConversationStartResponse
6462
- */
6463
- conversation_arn?: string;
6464
- /**
6465
- *
6466
- * @type {string}
6628
+ * @type {Conversation}
6467
6629
  * @memberof ConversationStartResponse
6468
6630
  */
6469
- conversation_uuid?: string;
6631
+ conversation?: Conversation;
6470
6632
  }
6471
6633
 
6472
6634
  /**
@@ -6531,6 +6693,96 @@ export interface ConversationSummary {
6531
6693
  unread_messages?: boolean;
6532
6694
  }
6533
6695
 
6696
+ /**
6697
+ *
6698
+ * @export
6699
+ * @interface ConversationWebsocketMessage
6700
+ */
6701
+ export interface ConversationWebsocketMessage {
6702
+ /**
6703
+ * Conversation UUID if the websocket message is tied to a specific conversation
6704
+ * @type {string}
6705
+ * @memberof ConversationWebsocketMessage
6706
+ */
6707
+ conversation_uuid?: string;
6708
+ /**
6709
+ *
6710
+ * @type {Conversation}
6711
+ * @memberof ConversationWebsocketMessage
6712
+ */
6713
+ event_conversation_closed?: Conversation;
6714
+ /**
6715
+ *
6716
+ * @type {Conversation}
6717
+ * @memberof ConversationWebsocketMessage
6718
+ */
6719
+ event_new_conversation?: Conversation;
6720
+ /**
6721
+ *
6722
+ * @type {ConversationMessage}
6723
+ * @memberof ConversationWebsocketMessage
6724
+ */
6725
+ event_new_message?: ConversationMessage;
6726
+ /**
6727
+ *
6728
+ * @type {ConversationEventQueuePosition}
6729
+ * @memberof ConversationWebsocketMessage
6730
+ */
6731
+ event_queue_position?: ConversationEventQueuePosition;
6732
+ /**
6733
+ * Type of event
6734
+ * @type {string}
6735
+ * @memberof ConversationWebsocketMessage
6736
+ */
6737
+ event_type?: ConversationWebsocketMessage.EventTypeEnum;
6738
+ /**
6739
+ *
6740
+ * @type {ConversationMessage}
6741
+ * @memberof ConversationWebsocketMessage
6742
+ */
6743
+ event_updated_message?: ConversationMessage;
6744
+ /**
6745
+ *
6746
+ * @type {ConversationMessage}
6747
+ * @memberof ConversationWebsocketMessage
6748
+ */
6749
+ message?: ConversationMessage;
6750
+ /**
6751
+ * Type of message
6752
+ * @type {string}
6753
+ * @memberof ConversationWebsocketMessage
6754
+ */
6755
+ type?: ConversationWebsocketMessage.TypeEnum;
6756
+ }
6757
+
6758
+ /**
6759
+ * @export
6760
+ * @namespace ConversationWebsocketMessage
6761
+ */
6762
+ export namespace ConversationWebsocketMessage {
6763
+ /**
6764
+ * @export
6765
+ * @enum {string}
6766
+ */
6767
+ export enum EventTypeEnum {
6768
+ QueuePosition = <any> 'queue position',
6769
+ WebchatStartConversation = <any> 'webchat start conversation',
6770
+ ConversationClosed = <any> 'conversation closed',
6771
+ NewConversation = <any> 'new conversation',
6772
+ NewMessage = <any> 'new message',
6773
+ UpdatedMessage = <any> 'updated message'
6774
+ }
6775
+ /**
6776
+ * @export
6777
+ * @enum {string}
6778
+ */
6779
+ export enum TypeEnum {
6780
+ Message = <any> 'message',
6781
+ Event = <any> 'event',
6782
+ Ping = <any> 'ping'
6783
+ }
6784
+ }
6785
+
6534
6786
  /**
6535
6787
  *
6536
6788
  * @export
@@ -38723,7 +38975,7 @@ export const ConversationApiFp = function(configuration?: Configuration) {
38723
38975
  * @param {*} [options] Override http request option.
38724
38976
  * @throws {RequiredError}
38725
38977
  */
38726
- getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Conversation> {
38978
+ getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationResponse> {
38727
38979
  const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversation(conversation_uuid, options);
38728
38980
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
38729
38981
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -38744,13 +38996,13 @@ export const ConversationApiFp = function(configuration?: Configuration) {
38744
38996
  * @param {*} [options] Override http request option.
38745
38997
  * @throws {RequiredError}
38746
38998
  */
38747
- getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
38999
+ getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse> {
38748
39000
  const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationMultimediaUploadUrl(extension, options);
38749
39001
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
38750
39002
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
38751
39003
 
38752
39004
  if (response.status >= 200 && response.status < 300) {
38753
- return response;
39005
+ return response.json();
38754
39006
 
38755
39007
  } else {
38756
39008
  throw response;
@@ -38948,7 +39200,7 @@ export interface ConversationApiInterface {
38948
39200
  * @throws {RequiredError}
38949
39201
  * @memberof ConversationApiInterface
38950
39202
  */
38951
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
39203
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
38952
39204
 
38953
39205
  /**
38954
39206
  * Get a presigned conersation multimedia upload URL
@@ -38958,7 +39210,7 @@ export interface ConversationApiInterface {
38958
39210
  * @throws {RequiredError}
38959
39211
  * @memberof ConversationApiInterface
38960
39212
  */
38961
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<{}>;
39213
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
38962
39214
 
38963
39215
  /**
38964
39216
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
package/dist/api.d.ts CHANGED
@@ -1351,6 +1351,12 @@ export interface AutoOrder {
1351
1351
  * @memberof AutoOrder
1352
1352
  */
1353
1353
  logs?: Array<AutoOrderLog>;
1354
+ /**
1355
+ *
1356
+ * @type {AutoOrderManagement}
1357
+ * @memberof AutoOrder
1358
+ */
1359
+ management?: AutoOrderManagement;
1354
1360
  /**
1355
1361
  * The next time that the auto order will be attempted for processing
1356
1362
  * @type {string}
@@ -1704,6 +1710,19 @@ export interface AutoOrderLog {
1704
1710
  */
1705
1711
  log_message?: string;
1706
1712
  }
1713
+ /**
1714
+ *
1715
+ * @export
1716
+ * @interface AutoOrderManagement
1717
+ */
1718
+ export interface AutoOrderManagement {
1719
+ /**
1720
+ * URL where the customer can go to update their billing information.
1721
+ * @type {string}
1722
+ * @memberof AutoOrderManagement
1723
+ */
1724
+ update_billing_url?: string;
1725
+ }
1707
1726
  /**
1708
1727
  *
1709
1728
  * @export
@@ -6127,46 +6146,90 @@ export interface Conversation {
6127
6146
  /**
6128
6147
  *
6129
6148
  * @export
6130
- * @interface ConversationAgentAuthResponse
6149
+ * @interface ConversationAgentAuth
6131
6150
  */
6132
- export interface ConversationAgentAuthResponse {
6151
+ export interface ConversationAgentAuth {
6133
6152
  /**
6134
6153
  *
6135
6154
  * @type {string}
6136
- * @memberof ConversationAgentAuthResponse
6155
+ * @memberof ConversationAgentAuth
6137
6156
  */
6138
6157
  conversation_participant_arn?: string;
6139
6158
  /**
6140
6159
  *
6141
6160
  * @type {string}
6142
- * @memberof ConversationAgentAuthResponse
6161
+ * @memberof ConversationAgentAuth
6143
6162
  */
6144
6163
  conversation_participant_name?: string;
6145
6164
  /**
6146
6165
  *
6147
6166
  * @type {string}
6148
- * @memberof ConversationAgentAuthResponse
6167
+ * @memberof ConversationAgentAuth
6149
6168
  */
6150
6169
  jwt?: string;
6151
6170
  /**
6152
6171
  *
6153
6172
  * @type {string}
6154
- * @memberof ConversationAgentAuthResponse
6173
+ * @memberof ConversationAgentAuth
6155
6174
  */
6156
6175
  merchant_id?: string;
6157
6176
  /**
6158
6177
  *
6159
6178
  * @type {Array<string>}
6160
- * @memberof ConversationAgentAuthResponse
6179
+ * @memberof ConversationAgentAuth
6161
6180
  */
6162
6181
  twilio_phone_numbers?: Array<string>;
6163
6182
  /**
6164
6183
  *
6165
6184
  * @type {string}
6166
- * @memberof ConversationAgentAuthResponse
6185
+ * @memberof ConversationAgentAuth
6167
6186
  */
6168
6187
  websocket_url?: string;
6169
6188
  }
6189
+ /**
6190
+ *
6191
+ * @export
6192
+ * @interface ConversationAgentAuthResponse
6193
+ */
6194
+ export interface ConversationAgentAuthResponse {
6195
+ /**
6196
+ *
6197
+ * @type {ConversationAgentAuth}
6198
+ * @memberof ConversationAgentAuthResponse
6199
+ */
6200
+ agent_auth?: ConversationAgentAuth;
6201
+ /**
6202
+ *
6203
+ * @type {ModelError}
6204
+ * @memberof ConversationAgentAuthResponse
6205
+ */
6206
+ error?: ModelError;
6207
+ /**
6208
+ *
6209
+ * @type {ResponseMetadata}
6210
+ * @memberof ConversationAgentAuthResponse
6211
+ */
6212
+ metadata?: ResponseMetadata;
6213
+ /**
6214
+ * Indicates if API call was successful
6215
+ * @type {boolean}
6216
+ * @memberof ConversationAgentAuthResponse
6217
+ */
6218
+ success?: boolean;
6219
+ /**
6220
+ *
6221
+ * @type {Warning}
6222
+ * @memberof ConversationAgentAuthResponse
6223
+ */
6224
+ warning?: Warning;
6225
+ }
6226
+ /**
6227
+ *
6228
+ * @export
6229
+ * @interface ConversationEventQueuePosition
6230
+ */
6231
+ export interface ConversationEventQueuePosition {
6232
+ }
6170
6233
  /**
6171
6234
  *
6172
6235
  * @export
@@ -6229,6 +6292,62 @@ export interface ConversationMessageTransportStatus {
6229
6292
  */
6230
6293
  status?: string;
6231
6294
  }
6295
+ /**
6296
+ *
6297
+ * @export
6298
+ * @interface ConversationMultimediaUploadUrl
6299
+ */
6300
+ export interface ConversationMultimediaUploadUrl {
6301
+ /**
6302
+ *
6303
+ * @type {string}
6304
+ * @memberof ConversationMultimediaUploadUrl
6305
+ */
6306
+ key?: string;
6307
+ /**
6308
+ *
6309
+ * @type {string}
6310
+ * @memberof ConversationMultimediaUploadUrl
6311
+ */
6312
+ url?: string;
6313
+ }
6314
+ /**
6315
+ *
6316
+ * @export
6317
+ * @interface ConversationMultimediaUploadUrlResponse
6318
+ */
6319
+ export interface ConversationMultimediaUploadUrlResponse {
6320
+ /**
6321
+ *
6322
+ * @type {ConversationMultimediaUploadUrl}
6323
+ * @memberof ConversationMultimediaUploadUrlResponse
6324
+ */
6325
+ conversation_multimedia_upload_url?: ConversationMultimediaUploadUrl;
6326
+ /**
6327
+ *
6328
+ * @type {ModelError}
6329
+ * @memberof ConversationMultimediaUploadUrlResponse
6330
+ */
6331
+ error?: ModelError;
6332
+ /**
6333
+ *
6334
+ * @type {ResponseMetadata}
6335
+ * @memberof ConversationMultimediaUploadUrlResponse
6336
+ */
6337
+ metadata?: ResponseMetadata;
6338
+ /**
6339
+ * Indicates if API call was successful
6340
+ * @type {boolean}
6341
+ * @memberof ConversationMultimediaUploadUrlResponse
6342
+ */
6343
+ success?: boolean;
6344
+ /**
6345
+ *
6346
+ * @type {Warning}
6347
+ * @memberof ConversationMultimediaUploadUrlResponse
6348
+ */
6349
+ warning?: Warning;
6350
+ }
6232
6351
  /**
6233
6352
  *
6234
6353
  * @export
@@ -6278,6 +6397,43 @@ export interface ConversationParticipant {
6278
6397
  */
6279
6398
  status?: string;
6280
6399
  }
6400
+ /**
6401
+ *
6402
+ * @export
6403
+ * @interface ConversationResponse
6404
+ */
6405
+ export interface ConversationResponse {
6406
+ /**
6407
+ *
6408
+ * @type {Conversation}
6409
+ * @memberof ConversationResponse
6410
+ */
6411
+ conversation?: Conversation;
6412
+ /**
6413
+ *
6414
+ * @type {ModelError}
6415
+ * @memberof ConversationResponse
6416
+ */
6417
+ error?: ModelError;
6418
+ /**
6419
+ *
6420
+ * @type {ResponseMetadata}
6421
+ * @memberof ConversationResponse
6422
+ */
6423
+ metadata?: ResponseMetadata;
6424
+ /**
6425
+ * Indicates if API call was successful
6426
+ * @type {boolean}
6427
+ * @memberof ConversationResponse
6428
+ */
6429
+ success?: boolean;
6430
+ /**
6431
+ *
6432
+ * @type {Warning}
6433
+ * @memberof ConversationResponse
6434
+ */
6435
+ warning?: Warning;
6436
+ }
6281
6437
  /**
6282
6438
  *
6283
6439
  * @export
@@ -6296,6 +6452,12 @@ export interface ConversationStartRequest {
6296
6452
  * @memberof ConversationStartRequest
6297
6453
  */
6298
6454
  conversation_arn?: string;
6455
+ /**
6456
+ *
6457
+ * @type {string}
6458
+ * @memberof ConversationStartRequest
6459
+ */
6460
+ conversation_webchat_queue_uuid?: string;
6299
6461
  }
6300
6462
  /**
6301
6463
  *
@@ -6305,16 +6467,10 @@ export interface ConversationStartRequest {
6305
6467
  export interface ConversationStartResponse {
6306
6468
  /**
6307
6469
  *
6308
- * @type {string}
6309
- * @memberof ConversationStartResponse
6310
- */
6311
- conversation_arn?: string;
6312
- /**
6313
- *
6314
- * @type {string}
6470
+ * @type {Conversation}
6315
6471
  * @memberof ConversationStartResponse
6316
6472
  */
6317
- conversation_uuid?: string;
6473
+ conversation?: Conversation;
6318
6474
  }
6319
6475
  /**
6320
6476
  *
@@ -6377,6 +6533,94 @@ export interface ConversationSummary {
6377
6533
  */
6378
6534
  unread_messages?: boolean;
6379
6535
  }
6536
+ /**
6537
+ *
6538
+ * @export
6539
+ * @interface ConversationWebsocketMessage
6540
+ */
6541
+ export interface ConversationWebsocketMessage {
6542
+ /**
6543
+ * Conversation UUID if the websocket message is tied to a specific conversation
6544
+ * @type {string}
6545
+ * @memberof ConversationWebsocketMessage
6546
+ */
6547
+ conversation_uuid?: string;
6548
+ /**
6549
+ *
6550
+ * @type {Conversation}
6551
+ * @memberof ConversationWebsocketMessage
6552
+ */
6553
+ event_conversation_closed?: Conversation;
6554
+ /**
6555
+ *
6556
+ * @type {Conversation}
6557
+ * @memberof ConversationWebsocketMessage
6558
+ */
6559
+ event_new_conversation?: Conversation;
6560
+ /**
6561
+ *
6562
+ * @type {ConversationMessage}
6563
+ * @memberof ConversationWebsocketMessage
6564
+ */
6565
+ event_new_message?: ConversationMessage;
6566
+ /**
6567
+ *
6568
+ * @type {ConversationEventQueuePosition}
6569
+ * @memberof ConversationWebsocketMessage
6570
+ */
6571
+ event_queue_position?: ConversationEventQueuePosition;
6572
+ /**
6573
+ * Type of event
6574
+ * @type {string}
6575
+ * @memberof ConversationWebsocketMessage
6576
+ */
6577
+ event_type?: ConversationWebsocketMessage.EventTypeEnum;
6578
+ /**
6579
+ *
6580
+ * @type {ConversationMessage}
6581
+ * @memberof ConversationWebsocketMessage
6582
+ */
6583
+ event_updated_message?: ConversationMessage;
6584
+ /**
6585
+ *
6586
+ * @type {ConversationMessage}
6587
+ * @memberof ConversationWebsocketMessage
6588
+ */
6589
+ message?: ConversationMessage;
6590
+ /**
6591
+ * Type of message
6592
+ * @type {string}
6593
+ * @memberof ConversationWebsocketMessage
6594
+ */
6595
+ type?: ConversationWebsocketMessage.TypeEnum;
6596
+ }
6597
+ /**
6598
+ * @export
6599
+ * @namespace ConversationWebsocketMessage
6600
+ */
6601
+ export declare namespace ConversationWebsocketMessage {
6602
+ /**
6603
+ * @export
6604
+ * @enum {string}
6605
+ */
6606
+ enum EventTypeEnum {
6607
+ QueuePosition,
6608
+ WebchatStartConversation,
6609
+ ConversationClosed,
6610
+ NewConversation,
6611
+ NewMessage,
6612
+ UpdatedMessage
6613
+ }
6614
+ /**
6615
+ * @export
6616
+ * @enum {string}
6617
+ */
6618
+ enum TypeEnum {
6619
+ Message,
6620
+ Event,
6621
+ Ping
6622
+ }
6623
+ }
6380
6624
  /**
6381
6625
  *
6382
6626
  * @export
@@ -34706,7 +34950,7 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34706
34950
  * @param {*} [options] Override http request option.
34707
34951
  * @throws {RequiredError}
34708
34952
  */
34709
- getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Conversation>;
34953
+ getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationResponse>;
34710
34954
  /**
34711
34955
  * Get a presigned conersation multimedia upload URL
34712
34956
  * @summary Get a presigned conersation multimedia upload URL
@@ -34714,7 +34958,7 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34714
34958
  * @param {*} [options] Override http request option.
34715
34959
  * @throws {RequiredError}
34716
34960
  */
34717
- getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
34961
+ getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse>;
34718
34962
  /**
34719
34963
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34720
34964
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34768,7 +35012,7 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
34768
35012
  * @param {*} [options] Override http request option.
34769
35013
  * @throws {RequiredError}
34770
35014
  */
34771
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35015
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34772
35016
  /**
34773
35017
  * Get a presigned conersation multimedia upload URL
34774
35018
  * @summary Get a presigned conersation multimedia upload URL
@@ -34776,7 +35020,7 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
34776
35020
  * @param {*} [options] Override http request option.
34777
35021
  * @throws {RequiredError}
34778
35022
  */
34779
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<Response>;
35023
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34780
35024
  /**
34781
35025
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34782
35026
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34833,7 +35077,7 @@ export interface ConversationApiInterface {
34833
35077
  * @throws {RequiredError}
34834
35078
  * @memberof ConversationApiInterface
34835
35079
  */
34836
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35080
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34837
35081
  /**
34838
35082
  * Get a presigned conersation multimedia upload URL
34839
35083
  * @summary Get a presigned conersation multimedia upload URL
@@ -34842,7 +35086,7 @@ export interface ConversationApiInterface {
34842
35086
  * @throws {RequiredError}
34843
35087
  * @memberof ConversationApiInterface
34844
35088
  */
34845
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<{}>;
35089
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34846
35090
  /**
34847
35091
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34848
35092
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34904,7 +35148,7 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
34904
35148
  * @throws {RequiredError}
34905
35149
  * @memberof ConversationApi
34906
35150
  */
34907
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35151
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34908
35152
  /**
34909
35153
  * Get a presigned conersation multimedia upload URL
34910
35154
  * @summary Get a presigned conersation multimedia upload URL
@@ -34913,7 +35157,7 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
34913
35157
  * @throws {RequiredError}
34914
35158
  * @memberof ConversationApi
34915
35159
  */
34916
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<Response>;
35160
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34917
35161
  /**
34918
35162
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34919
35163
  * @summary Retrieve a list of conversation summaries newest to oldest
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.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = 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.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.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = 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 = 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 = void 0;
31
+ exports.AffiliateApi = exports.AffiliateApiFactory = 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.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.OrderApiFp = exports.OrderApiFetchParamCreator = 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 = 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 = 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,36 @@ 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 ConversationWebsocketMessage
365
+ */
366
+ var ConversationWebsocketMessage;
367
+ (function (ConversationWebsocketMessage) {
368
+ /**
369
+ * @export
370
+ * @enum {string}
371
+ */
372
+ var EventTypeEnum;
373
+ (function (EventTypeEnum) {
374
+ EventTypeEnum[EventTypeEnum["QueuePosition"] = 'queue position'] = "QueuePosition";
375
+ EventTypeEnum[EventTypeEnum["WebchatStartConversation"] = 'webchat start conversation'] = "WebchatStartConversation";
376
+ EventTypeEnum[EventTypeEnum["ConversationClosed"] = 'conversation closed'] = "ConversationClosed";
377
+ EventTypeEnum[EventTypeEnum["NewConversation"] = 'new conversation'] = "NewConversation";
378
+ EventTypeEnum[EventTypeEnum["NewMessage"] = 'new message'] = "NewMessage";
379
+ EventTypeEnum[EventTypeEnum["UpdatedMessage"] = 'updated message'] = "UpdatedMessage";
380
+ })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
381
+ /**
382
+ * @export
383
+ * @enum {string}
384
+ */
385
+ var TypeEnum;
386
+ (function (TypeEnum) {
387
+ TypeEnum[TypeEnum["Message"] = 'message'] = "Message";
388
+ TypeEnum[TypeEnum["Event"] = 'event'] = "Event";
389
+ TypeEnum[TypeEnum["Ping"] = 'ping'] = "Ping";
390
+ })(TypeEnum = ConversationWebsocketMessage.TypeEnum || (ConversationWebsocketMessage.TypeEnum = {}));
391
+ })(ConversationWebsocketMessage = exports.ConversationWebsocketMessage || (exports.ConversationWebsocketMessage = {}));
362
392
  /**
363
393
  * @export
364
394
  * @namespace Distance
@@ -5682,7 +5712,7 @@ var ConversationApiFp = function (configuration) {
5682
5712
  if (basePath === void 0) { basePath = BASE_PATH; }
5683
5713
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
5684
5714
  if (response.status >= 200 && response.status < 300) {
5685
- return response;
5715
+ return response.json();
5686
5716
  }
5687
5717
  else {
5688
5718
  throw response;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.22",
3
+ "version": "3.10.23",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [