ultracart_rest_api_v2_typescript 3.10.21 → 3.10.24

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.21
1
+ ## ultracart_rest_api_v2_typescript@3.10.24
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.21 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.24 --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.24 | 07/25/2022 | conversations bug fixes |
58
+ | 3.10.23 | 07/25/2022 | conversations - add a websocket message model |
59
+ | 3.10.22 | 07/20/2022 | conversation participant name added |
57
60
  | 3.10.21 | 07/18/2022 | twilio dev |
58
61
  | 3.10.20 | 07/14/2022 | Add channel storefront_oid to the customer activity record |
59
62
  | 3.10.19 | 07/11/2022 | Customer API - mergeCustomer method |
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,41 +6294,105 @@ 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
6310
+ */
6311
+ conversation_participant_name?: string;
6312
+ /**
6313
+ *
6314
+ * @type {string}
6315
+ * @memberof ConversationAgentAuth
6290
6316
  */
6291
6317
  jwt?: string;
6292
6318
  /**
6293
6319
  *
6294
6320
  * @type {string}
6295
- * @memberof ConversationAgentAuthResponse
6321
+ * @memberof ConversationAgentAuth
6296
6322
  */
6297
6323
  merchant_id?: string;
6298
6324
  /**
6299
6325
  *
6300
6326
  * @type {Array<string>}
6301
- * @memberof ConversationAgentAuthResponse
6327
+ * @memberof ConversationAgentAuth
6302
6328
  */
6303
6329
  twilio_phone_numbers?: Array<string>;
6304
6330
  /**
6305
6331
  *
6306
6332
  * @type {string}
6307
- * @memberof ConversationAgentAuthResponse
6333
+ * @memberof ConversationAgentAuth
6308
6334
  */
6309
6335
  websocket_url?: string;
6310
6336
  }
6311
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
+ * True if agents are logged into the queue
6384
+ * @type {boolean}
6385
+ * @memberof ConversationEventQueuePosition
6386
+ */
6387
+ available?: boolean;
6388
+ /**
6389
+ * Position in the queue. Value will be -1 if they cant be found in the queue.
6390
+ * @type {number}
6391
+ * @memberof ConversationEventQueuePosition
6392
+ */
6393
+ position?: number;
6394
+ }
6395
+
6312
6396
  /**
6313
6397
  *
6314
6398
  * @export
@@ -6345,6 +6429,90 @@ export interface ConversationMessage {
6345
6429
  * @memberof ConversationMessage
6346
6430
  */
6347
6431
  message_dts?: string;
6432
+ /**
6433
+ *
6434
+ * @type {Array<ConversationMessageTransportStatus>}
6435
+ * @memberof ConversationMessage
6436
+ */
6437
+ transport_statuses?: Array<ConversationMessageTransportStatus>;
6438
+ }
6439
+
6440
+ /**
6441
+ *
6442
+ * @export
6443
+ * @interface ConversationMessageTransportStatus
6444
+ */
6445
+ export interface ConversationMessageTransportStatus {
6446
+ /**
6447
+ *
6448
+ * @type {string}
6449
+ * @memberof ConversationMessageTransportStatus
6450
+ */
6451
+ conversation_participant_arn?: string;
6452
+ /**
6453
+ *
6454
+ * @type {string}
6455
+ * @memberof ConversationMessageTransportStatus
6456
+ */
6457
+ status?: string;
6458
+ }
6459
+
6460
+ /**
6461
+ *
6462
+ * @export
6463
+ * @interface ConversationMultimediaUploadUrl
6464
+ */
6465
+ export interface ConversationMultimediaUploadUrl {
6466
+ /**
6467
+ *
6468
+ * @type {string}
6469
+ * @memberof ConversationMultimediaUploadUrl
6470
+ */
6471
+ key?: string;
6472
+ /**
6473
+ *
6474
+ * @type {string}
6475
+ * @memberof ConversationMultimediaUploadUrl
6476
+ */
6477
+ url?: string;
6478
+ }
6479
+
6480
+ /**
6481
+ *
6482
+ * @export
6483
+ * @interface ConversationMultimediaUploadUrlResponse
6484
+ */
6485
+ export interface ConversationMultimediaUploadUrlResponse {
6486
+ /**
6487
+ *
6488
+ * @type {ConversationMultimediaUploadUrl}
6489
+ * @memberof ConversationMultimediaUploadUrlResponse
6490
+ */
6491
+ conversation_multimedia_upload_url?: ConversationMultimediaUploadUrl;
6492
+ /**
6493
+ *
6494
+ * @type {ModelError}
6495
+ * @memberof ConversationMultimediaUploadUrlResponse
6496
+ */
6497
+ error?: ModelError;
6498
+ /**
6499
+ *
6500
+ * @type {ResponseMetadata}
6501
+ * @memberof ConversationMultimediaUploadUrlResponse
6502
+ */
6503
+ metadata?: ResponseMetadata;
6504
+ /**
6505
+ * Indicates if API call was successful
6506
+ * @type {boolean}
6507
+ * @memberof ConversationMultimediaUploadUrlResponse
6508
+ */
6509
+ success?: boolean;
6510
+ /**
6511
+ *
6512
+ * @type {Warning}
6513
+ * @memberof ConversationMultimediaUploadUrlResponse
6514
+ */
6515
+ warning?: Warning;
6348
6516
  }
6349
6517
 
6350
6518
  /**
@@ -6397,6 +6565,44 @@ export interface ConversationParticipant {
6397
6565
  status?: string;
6398
6566
  }
6399
6567
 
6568
+ /**
6569
+ *
6570
+ * @export
6571
+ * @interface ConversationResponse
6572
+ */
6573
+ export interface ConversationResponse {
6574
+ /**
6575
+ *
6576
+ * @type {Conversation}
6577
+ * @memberof ConversationResponse
6578
+ */
6579
+ conversation?: Conversation;
6580
+ /**
6581
+ *
6582
+ * @type {ModelError}
6583
+ * @memberof ConversationResponse
6584
+ */
6585
+ error?: ModelError;
6586
+ /**
6587
+ *
6588
+ * @type {ResponseMetadata}
6589
+ * @memberof ConversationResponse
6590
+ */
6591
+ metadata?: ResponseMetadata;
6592
+ /**
6593
+ * Indicates if API call was successful
6594
+ * @type {boolean}
6595
+ * @memberof ConversationResponse
6596
+ */
6597
+ success?: boolean;
6598
+ /**
6599
+ *
6600
+ * @type {Warning}
6601
+ * @memberof ConversationResponse
6602
+ */
6603
+ warning?: Warning;
6604
+ }
6605
+
6400
6606
  /**
6401
6607
  *
6402
6608
  * @export
@@ -6415,6 +6621,12 @@ export interface ConversationStartRequest {
6415
6621
  * @memberof ConversationStartRequest
6416
6622
  */
6417
6623
  conversation_arn?: string;
6624
+ /**
6625
+ *
6626
+ * @type {string}
6627
+ * @memberof ConversationStartRequest
6628
+ */
6629
+ conversation_webchat_queue_uuid?: string;
6418
6630
  }
6419
6631
 
6420
6632
  /**
@@ -6425,16 +6637,10 @@ export interface ConversationStartRequest {
6425
6637
  export interface ConversationStartResponse {
6426
6638
  /**
6427
6639
  *
6428
- * @type {string}
6429
- * @memberof ConversationStartResponse
6430
- */
6431
- conversation_arn?: string;
6432
- /**
6433
- *
6434
- * @type {string}
6640
+ * @type {Conversation}
6435
6641
  * @memberof ConversationStartResponse
6436
6642
  */
6437
- conversation_uuid?: string;
6643
+ conversation?: Conversation;
6438
6644
  }
6439
6645
 
6440
6646
  /**
@@ -6499,6 +6705,96 @@ export interface ConversationSummary {
6499
6705
  unread_messages?: boolean;
6500
6706
  }
6501
6707
 
6708
+ /**
6709
+ *
6710
+ * @export
6711
+ * @interface ConversationWebsocketMessage
6712
+ */
6713
+ export interface ConversationWebsocketMessage {
6714
+ /**
6715
+ * Conversation UUID if the websocket message is tied to a specific conversation
6716
+ * @type {string}
6717
+ * @memberof ConversationWebsocketMessage
6718
+ */
6719
+ conversation_uuid?: string;
6720
+ /**
6721
+ *
6722
+ * @type {Conversation}
6723
+ * @memberof ConversationWebsocketMessage
6724
+ */
6725
+ event_conversation_closed?: Conversation;
6726
+ /**
6727
+ *
6728
+ * @type {Conversation}
6729
+ * @memberof ConversationWebsocketMessage
6730
+ */
6731
+ event_new_conversation?: Conversation;
6732
+ /**
6733
+ *
6734
+ * @type {Conversation}
6735
+ * @memberof ConversationWebsocketMessage
6736
+ */
6737
+ event_new_message?: Conversation;
6738
+ /**
6739
+ *
6740
+ * @type {ConversationEventQueuePosition}
6741
+ * @memberof ConversationWebsocketMessage
6742
+ */
6743
+ event_queue_position?: ConversationEventQueuePosition;
6744
+ /**
6745
+ * Type of event
6746
+ * @type {string}
6747
+ * @memberof ConversationWebsocketMessage
6748
+ */
6749
+ event_type?: ConversationWebsocketMessage.EventTypeEnum;
6750
+ /**
6751
+ *
6752
+ * @type {ConversationMessage}
6753
+ * @memberof ConversationWebsocketMessage
6754
+ */
6755
+ event_updated_message?: ConversationMessage;
6756
+ /**
6757
+ *
6758
+ * @type {ConversationMessage}
6759
+ * @memberof ConversationWebsocketMessage
6760
+ */
6761
+ message?: ConversationMessage;
6762
+ /**
6763
+ * Type of message
6764
+ * @type {string}
6765
+ * @memberof ConversationWebsocketMessage
6766
+ */
6767
+ type?: ConversationWebsocketMessage.TypeEnum;
6768
+ }
6769
+
6770
+ /**
6771
+ * @export
6772
+ * @namespace ConversationWebsocketMessage
6773
+ */
6774
+ export namespace ConversationWebsocketMessage {
6775
+ /**
6776
+ * @export
6777
+ * @enum {string}
6778
+ */
6779
+ export enum EventTypeEnum {
6780
+ QueuePosition = <any> 'queue position',
6781
+ WebchatStartConversation = <any> 'webchat start conversation',
6782
+ ConversationClosed = <any> 'conversation closed',
6783
+ NewConversation = <any> 'new conversation',
6784
+ NewMessage = <any> 'new message',
6785
+ UpdatedMessage = <any> 'updated message'
6786
+ }
6787
+ /**
6788
+ * @export
6789
+ * @enum {string}
6790
+ */
6791
+ export enum TypeEnum {
6792
+ Message = <any> 'message',
6793
+ Event = <any> 'event',
6794
+ Ping = <any> 'ping'
6795
+ }
6796
+ }
6797
+
6502
6798
  /**
6503
6799
  *
6504
6800
  * @export
@@ -38691,7 +38987,7 @@ export const ConversationApiFp = function(configuration?: Configuration) {
38691
38987
  * @param {*} [options] Override http request option.
38692
38988
  * @throws {RequiredError}
38693
38989
  */
38694
- getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Conversation> {
38990
+ getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationResponse> {
38695
38991
  const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversation(conversation_uuid, options);
38696
38992
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
38697
38993
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -38712,13 +39008,13 @@ export const ConversationApiFp = function(configuration?: Configuration) {
38712
39008
  * @param {*} [options] Override http request option.
38713
39009
  * @throws {RequiredError}
38714
39010
  */
38715
- getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
39011
+ getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse> {
38716
39012
  const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationMultimediaUploadUrl(extension, options);
38717
39013
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
38718
39014
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
38719
39015
 
38720
39016
  if (response.status >= 200 && response.status < 300) {
38721
- return response;
39017
+ return response.json();
38722
39018
 
38723
39019
  } else {
38724
39020
  throw response;
@@ -38916,7 +39212,7 @@ export interface ConversationApiInterface {
38916
39212
  * @throws {RequiredError}
38917
39213
  * @memberof ConversationApiInterface
38918
39214
  */
38919
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
39215
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
38920
39216
 
38921
39217
  /**
38922
39218
  * Get a presigned conersation multimedia upload URL
@@ -38926,7 +39222,7 @@ export interface ConversationApiInterface {
38926
39222
  * @throws {RequiredError}
38927
39223
  * @memberof ConversationApiInterface
38928
39224
  */
38929
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<{}>;
39225
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
38930
39226
 
38931
39227
  /**
38932
39228
  * 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,40 +6146,102 @@ 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
6162
+ */
6163
+ conversation_participant_name?: string;
6164
+ /**
6165
+ *
6166
+ * @type {string}
6167
+ * @memberof ConversationAgentAuth
6143
6168
  */
6144
6169
  jwt?: string;
6145
6170
  /**
6146
6171
  *
6147
6172
  * @type {string}
6148
- * @memberof ConversationAgentAuthResponse
6173
+ * @memberof ConversationAgentAuth
6149
6174
  */
6150
6175
  merchant_id?: string;
6151
6176
  /**
6152
6177
  *
6153
6178
  * @type {Array<string>}
6154
- * @memberof ConversationAgentAuthResponse
6179
+ * @memberof ConversationAgentAuth
6155
6180
  */
6156
6181
  twilio_phone_numbers?: Array<string>;
6157
6182
  /**
6158
6183
  *
6159
6184
  * @type {string}
6160
- * @memberof ConversationAgentAuthResponse
6185
+ * @memberof ConversationAgentAuth
6161
6186
  */
6162
6187
  websocket_url?: string;
6163
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
+ /**
6233
+ * True if agents are logged into the queue
6234
+ * @type {boolean}
6235
+ * @memberof ConversationEventQueuePosition
6236
+ */
6237
+ available?: boolean;
6238
+ /**
6239
+ * Position in the queue. Value will be -1 if they cant be found in the queue.
6240
+ * @type {number}
6241
+ * @memberof ConversationEventQueuePosition
6242
+ */
6243
+ position?: number;
6244
+ }
6164
6245
  /**
6165
6246
  *
6166
6247
  * @export
@@ -6197,6 +6278,87 @@ export interface ConversationMessage {
6197
6278
  * @memberof ConversationMessage
6198
6279
  */
6199
6280
  message_dts?: string;
6281
+ /**
6282
+ *
6283
+ * @type {Array<ConversationMessageTransportStatus>}
6284
+ * @memberof ConversationMessage
6285
+ */
6286
+ transport_statuses?: Array<ConversationMessageTransportStatus>;
6287
+ }
6288
+ /**
6289
+ *
6290
+ * @export
6291
+ * @interface ConversationMessageTransportStatus
6292
+ */
6293
+ export interface ConversationMessageTransportStatus {
6294
+ /**
6295
+ *
6296
+ * @type {string}
6297
+ * @memberof ConversationMessageTransportStatus
6298
+ */
6299
+ conversation_participant_arn?: string;
6300
+ /**
6301
+ *
6302
+ * @type {string}
6303
+ * @memberof ConversationMessageTransportStatus
6304
+ */
6305
+ status?: string;
6306
+ }
6307
+ /**
6308
+ *
6309
+ * @export
6310
+ * @interface ConversationMultimediaUploadUrl
6311
+ */
6312
+ export interface ConversationMultimediaUploadUrl {
6313
+ /**
6314
+ *
6315
+ * @type {string}
6316
+ * @memberof ConversationMultimediaUploadUrl
6317
+ */
6318
+ key?: string;
6319
+ /**
6320
+ *
6321
+ * @type {string}
6322
+ * @memberof ConversationMultimediaUploadUrl
6323
+ */
6324
+ url?: string;
6325
+ }
6326
+ /**
6327
+ *
6328
+ * @export
6329
+ * @interface ConversationMultimediaUploadUrlResponse
6330
+ */
6331
+ export interface ConversationMultimediaUploadUrlResponse {
6332
+ /**
6333
+ *
6334
+ * @type {ConversationMultimediaUploadUrl}
6335
+ * @memberof ConversationMultimediaUploadUrlResponse
6336
+ */
6337
+ conversation_multimedia_upload_url?: ConversationMultimediaUploadUrl;
6338
+ /**
6339
+ *
6340
+ * @type {ModelError}
6341
+ * @memberof ConversationMultimediaUploadUrlResponse
6342
+ */
6343
+ error?: ModelError;
6344
+ /**
6345
+ *
6346
+ * @type {ResponseMetadata}
6347
+ * @memberof ConversationMultimediaUploadUrlResponse
6348
+ */
6349
+ metadata?: ResponseMetadata;
6350
+ /**
6351
+ * Indicates if API call was successful
6352
+ * @type {boolean}
6353
+ * @memberof ConversationMultimediaUploadUrlResponse
6354
+ */
6355
+ success?: boolean;
6356
+ /**
6357
+ *
6358
+ * @type {Warning}
6359
+ * @memberof ConversationMultimediaUploadUrlResponse
6360
+ */
6361
+ warning?: Warning;
6200
6362
  }
6201
6363
  /**
6202
6364
  *
@@ -6247,6 +6409,43 @@ export interface ConversationParticipant {
6247
6409
  */
6248
6410
  status?: string;
6249
6411
  }
6412
+ /**
6413
+ *
6414
+ * @export
6415
+ * @interface ConversationResponse
6416
+ */
6417
+ export interface ConversationResponse {
6418
+ /**
6419
+ *
6420
+ * @type {Conversation}
6421
+ * @memberof ConversationResponse
6422
+ */
6423
+ conversation?: Conversation;
6424
+ /**
6425
+ *
6426
+ * @type {ModelError}
6427
+ * @memberof ConversationResponse
6428
+ */
6429
+ error?: ModelError;
6430
+ /**
6431
+ *
6432
+ * @type {ResponseMetadata}
6433
+ * @memberof ConversationResponse
6434
+ */
6435
+ metadata?: ResponseMetadata;
6436
+ /**
6437
+ * Indicates if API call was successful
6438
+ * @type {boolean}
6439
+ * @memberof ConversationResponse
6440
+ */
6441
+ success?: boolean;
6442
+ /**
6443
+ *
6444
+ * @type {Warning}
6445
+ * @memberof ConversationResponse
6446
+ */
6447
+ warning?: Warning;
6448
+ }
6250
6449
  /**
6251
6450
  *
6252
6451
  * @export
@@ -6265,6 +6464,12 @@ export interface ConversationStartRequest {
6265
6464
  * @memberof ConversationStartRequest
6266
6465
  */
6267
6466
  conversation_arn?: string;
6467
+ /**
6468
+ *
6469
+ * @type {string}
6470
+ * @memberof ConversationStartRequest
6471
+ */
6472
+ conversation_webchat_queue_uuid?: string;
6268
6473
  }
6269
6474
  /**
6270
6475
  *
@@ -6274,16 +6479,10 @@ export interface ConversationStartRequest {
6274
6479
  export interface ConversationStartResponse {
6275
6480
  /**
6276
6481
  *
6277
- * @type {string}
6482
+ * @type {Conversation}
6278
6483
  * @memberof ConversationStartResponse
6279
6484
  */
6280
- conversation_arn?: string;
6281
- /**
6282
- *
6283
- * @type {string}
6284
- * @memberof ConversationStartResponse
6285
- */
6286
- conversation_uuid?: string;
6485
+ conversation?: Conversation;
6287
6486
  }
6288
6487
  /**
6289
6488
  *
@@ -6346,6 +6545,94 @@ export interface ConversationSummary {
6346
6545
  */
6347
6546
  unread_messages?: boolean;
6348
6547
  }
6548
+ /**
6549
+ *
6550
+ * @export
6551
+ * @interface ConversationWebsocketMessage
6552
+ */
6553
+ export interface ConversationWebsocketMessage {
6554
+ /**
6555
+ * Conversation UUID if the websocket message is tied to a specific conversation
6556
+ * @type {string}
6557
+ * @memberof ConversationWebsocketMessage
6558
+ */
6559
+ conversation_uuid?: string;
6560
+ /**
6561
+ *
6562
+ * @type {Conversation}
6563
+ * @memberof ConversationWebsocketMessage
6564
+ */
6565
+ event_conversation_closed?: Conversation;
6566
+ /**
6567
+ *
6568
+ * @type {Conversation}
6569
+ * @memberof ConversationWebsocketMessage
6570
+ */
6571
+ event_new_conversation?: Conversation;
6572
+ /**
6573
+ *
6574
+ * @type {Conversation}
6575
+ * @memberof ConversationWebsocketMessage
6576
+ */
6577
+ event_new_message?: Conversation;
6578
+ /**
6579
+ *
6580
+ * @type {ConversationEventQueuePosition}
6581
+ * @memberof ConversationWebsocketMessage
6582
+ */
6583
+ event_queue_position?: ConversationEventQueuePosition;
6584
+ /**
6585
+ * Type of event
6586
+ * @type {string}
6587
+ * @memberof ConversationWebsocketMessage
6588
+ */
6589
+ event_type?: ConversationWebsocketMessage.EventTypeEnum;
6590
+ /**
6591
+ *
6592
+ * @type {ConversationMessage}
6593
+ * @memberof ConversationWebsocketMessage
6594
+ */
6595
+ event_updated_message?: ConversationMessage;
6596
+ /**
6597
+ *
6598
+ * @type {ConversationMessage}
6599
+ * @memberof ConversationWebsocketMessage
6600
+ */
6601
+ message?: ConversationMessage;
6602
+ /**
6603
+ * Type of message
6604
+ * @type {string}
6605
+ * @memberof ConversationWebsocketMessage
6606
+ */
6607
+ type?: ConversationWebsocketMessage.TypeEnum;
6608
+ }
6609
+ /**
6610
+ * @export
6611
+ * @namespace ConversationWebsocketMessage
6612
+ */
6613
+ export declare namespace ConversationWebsocketMessage {
6614
+ /**
6615
+ * @export
6616
+ * @enum {string}
6617
+ */
6618
+ enum EventTypeEnum {
6619
+ QueuePosition,
6620
+ WebchatStartConversation,
6621
+ ConversationClosed,
6622
+ NewConversation,
6623
+ NewMessage,
6624
+ UpdatedMessage
6625
+ }
6626
+ /**
6627
+ * @export
6628
+ * @enum {string}
6629
+ */
6630
+ enum TypeEnum {
6631
+ Message,
6632
+ Event,
6633
+ Ping
6634
+ }
6635
+ }
6349
6636
  /**
6350
6637
  *
6351
6638
  * @export
@@ -34675,7 +34962,7 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34675
34962
  * @param {*} [options] Override http request option.
34676
34963
  * @throws {RequiredError}
34677
34964
  */
34678
- getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Conversation>;
34965
+ getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationResponse>;
34679
34966
  /**
34680
34967
  * Get a presigned conersation multimedia upload URL
34681
34968
  * @summary Get a presigned conersation multimedia upload URL
@@ -34683,7 +34970,7 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34683
34970
  * @param {*} [options] Override http request option.
34684
34971
  * @throws {RequiredError}
34685
34972
  */
34686
- getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
34973
+ getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse>;
34687
34974
  /**
34688
34975
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34689
34976
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34737,7 +35024,7 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
34737
35024
  * @param {*} [options] Override http request option.
34738
35025
  * @throws {RequiredError}
34739
35026
  */
34740
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35027
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34741
35028
  /**
34742
35029
  * Get a presigned conersation multimedia upload URL
34743
35030
  * @summary Get a presigned conersation multimedia upload URL
@@ -34745,7 +35032,7 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
34745
35032
  * @param {*} [options] Override http request option.
34746
35033
  * @throws {RequiredError}
34747
35034
  */
34748
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<Response>;
35035
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34749
35036
  /**
34750
35037
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34751
35038
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34802,7 +35089,7 @@ export interface ConversationApiInterface {
34802
35089
  * @throws {RequiredError}
34803
35090
  * @memberof ConversationApiInterface
34804
35091
  */
34805
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35092
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34806
35093
  /**
34807
35094
  * Get a presigned conersation multimedia upload URL
34808
35095
  * @summary Get a presigned conersation multimedia upload URL
@@ -34811,7 +35098,7 @@ export interface ConversationApiInterface {
34811
35098
  * @throws {RequiredError}
34812
35099
  * @memberof ConversationApiInterface
34813
35100
  */
34814
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<{}>;
35101
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34815
35102
  /**
34816
35103
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34817
35104
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34873,7 +35160,7 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
34873
35160
  * @throws {RequiredError}
34874
35161
  * @memberof ConversationApi
34875
35162
  */
34876
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35163
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34877
35164
  /**
34878
35165
  * Get a presigned conersation multimedia upload URL
34879
35166
  * @summary Get a presigned conersation multimedia upload URL
@@ -34882,7 +35169,7 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
34882
35169
  * @throws {RequiredError}
34883
35170
  * @memberof ConversationApi
34884
35171
  */
34885
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<Response>;
35172
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34886
35173
  /**
34887
35174
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34888
35175
  * @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.21",
3
+ "version": "3.10.24",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [