ultracart_rest_api_v2_typescript 3.10.22 → 3.10.25

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.25
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.25 --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.25 | 07/25/2022 | conversation development |
58
+ | 3.10.24 | 07/25/2022 | conversations bug fixes |
59
+ | 3.10.23 | 07/25/2022 | conversations - add a websocket message model |
57
60
  | 3.10.22 | 07/20/2022 | conversation participant name added |
58
61
  | 3.10.21 | 07/18/2022 | twilio dev |
59
62
  | 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
@@ -6239,6 +6259,12 @@ export interface CityStateZip {
6239
6259
  * @interface Conversation
6240
6260
  */
6241
6261
  export interface Conversation {
6262
+ /**
6263
+ *
6264
+ * @type {boolean}
6265
+ * @memberof Conversation
6266
+ */
6267
+ closed?: boolean;
6242
6268
  /**
6243
6269
  *
6244
6270
  * @type {string}
@@ -6274,47 +6300,105 @@ export interface Conversation {
6274
6300
  /**
6275
6301
  *
6276
6302
  * @export
6277
- * @interface ConversationAgentAuthResponse
6303
+ * @interface ConversationAgentAuth
6278
6304
  */
6279
- export interface ConversationAgentAuthResponse {
6305
+ export interface ConversationAgentAuth {
6280
6306
  /**
6281
6307
  *
6282
6308
  * @type {string}
6283
- * @memberof ConversationAgentAuthResponse
6309
+ * @memberof ConversationAgentAuth
6284
6310
  */
6285
6311
  conversation_participant_arn?: string;
6286
6312
  /**
6287
6313
  *
6288
6314
  * @type {string}
6289
- * @memberof ConversationAgentAuthResponse
6315
+ * @memberof ConversationAgentAuth
6290
6316
  */
6291
6317
  conversation_participant_name?: string;
6292
6318
  /**
6293
6319
  *
6294
6320
  * @type {string}
6295
- * @memberof ConversationAgentAuthResponse
6321
+ * @memberof ConversationAgentAuth
6296
6322
  */
6297
6323
  jwt?: string;
6298
6324
  /**
6299
6325
  *
6300
6326
  * @type {string}
6301
- * @memberof ConversationAgentAuthResponse
6327
+ * @memberof ConversationAgentAuth
6302
6328
  */
6303
6329
  merchant_id?: string;
6304
6330
  /**
6305
6331
  *
6306
6332
  * @type {Array<string>}
6307
- * @memberof ConversationAgentAuthResponse
6333
+ * @memberof ConversationAgentAuth
6308
6334
  */
6309
6335
  twilio_phone_numbers?: Array<string>;
6310
6336
  /**
6311
6337
  *
6312
6338
  * @type {string}
6313
- * @memberof ConversationAgentAuthResponse
6339
+ * @memberof ConversationAgentAuth
6314
6340
  */
6315
6341
  websocket_url?: string;
6316
6342
  }
6317
6343
 
6344
+ /**
6345
+ *
6346
+ * @export
6347
+ * @interface ConversationAgentAuthResponse
6348
+ */
6349
+ export interface ConversationAgentAuthResponse {
6350
+ /**
6351
+ *
6352
+ * @type {ConversationAgentAuth}
6353
+ * @memberof ConversationAgentAuthResponse
6354
+ */
6355
+ agent_auth?: ConversationAgentAuth;
6356
+ /**
6357
+ *
6358
+ * @type {ModelError}
6359
+ * @memberof ConversationAgentAuthResponse
6360
+ */
6361
+ error?: ModelError;
6362
+ /**
6363
+ *
6364
+ * @type {ResponseMetadata}
6365
+ * @memberof ConversationAgentAuthResponse
6366
+ */
6367
+ metadata?: ResponseMetadata;
6368
+ /**
6369
+ * Indicates if API call was successful
6370
+ * @type {boolean}
6371
+ * @memberof ConversationAgentAuthResponse
6372
+ */
6373
+ success?: boolean;
6374
+ /**
6375
+ *
6376
+ * @type {Warning}
6377
+ * @memberof ConversationAgentAuthResponse
6378
+ */
6379
+ warning?: Warning;
6380
+ }
6381
+
6382
+ /**
6383
+ *
6384
+ * @export
6385
+ * @interface ConversationEventQueuePosition
6386
+ */
6387
+ export interface ConversationEventQueuePosition {
6388
+ /**
6389
+ * True if agents are logged into the queue
6390
+ * @type {boolean}
6391
+ * @memberof ConversationEventQueuePosition
6392
+ */
6393
+ available?: boolean;
6394
+ /**
6395
+ * Position in the queue. Value will be -1 if they cant be found in the queue.
6396
+ * @type {number}
6397
+ * @memberof ConversationEventQueuePosition
6398
+ */
6399
+ position?: number;
6400
+ }
6401
+
6318
6402
  /**
6319
6403
  *
6320
6404
  * @export
@@ -6379,6 +6463,64 @@ export interface ConversationMessageTransportStatus {
6379
6463
  status?: string;
6380
6464
  }
6381
6465
 
6466
+ /**
6467
+ *
6468
+ * @export
6469
+ * @interface ConversationMultimediaUploadUrl
6470
+ */
6471
+ export interface ConversationMultimediaUploadUrl {
6472
+ /**
6473
+ *
6474
+ * @type {string}
6475
+ * @memberof ConversationMultimediaUploadUrl
6476
+ */
6477
+ key?: string;
6478
+ /**
6479
+ *
6480
+ * @type {string}
6481
+ * @memberof ConversationMultimediaUploadUrl
6482
+ */
6483
+ url?: string;
6484
+ }
6485
+
6486
+ /**
6487
+ *
6488
+ * @export
6489
+ * @interface ConversationMultimediaUploadUrlResponse
6490
+ */
6491
+ export interface ConversationMultimediaUploadUrlResponse {
6492
+ /**
6493
+ *
6494
+ * @type {ConversationMultimediaUploadUrl}
6495
+ * @memberof ConversationMultimediaUploadUrlResponse
6496
+ */
6497
+ conversation_multimedia_upload_url?: ConversationMultimediaUploadUrl;
6498
+ /**
6499
+ *
6500
+ * @type {ModelError}
6501
+ * @memberof ConversationMultimediaUploadUrlResponse
6502
+ */
6503
+ error?: ModelError;
6504
+ /**
6505
+ *
6506
+ * @type {ResponseMetadata}
6507
+ * @memberof ConversationMultimediaUploadUrlResponse
6508
+ */
6509
+ metadata?: ResponseMetadata;
6510
+ /**
6511
+ * Indicates if API call was successful
6512
+ * @type {boolean}
6513
+ * @memberof ConversationMultimediaUploadUrlResponse
6514
+ */
6515
+ success?: boolean;
6516
+ /**
6517
+ *
6518
+ * @type {Warning}
6519
+ * @memberof ConversationMultimediaUploadUrlResponse
6520
+ */
6521
+ warning?: Warning;
6522
+ }
6523
+
6382
6524
  /**
6383
6525
  *
6384
6526
  * @export
@@ -6429,6 +6571,44 @@ export interface ConversationParticipant {
6429
6571
  status?: string;
6430
6572
  }
6431
6573
 
6574
+ /**
6575
+ *
6576
+ * @export
6577
+ * @interface ConversationResponse
6578
+ */
6579
+ export interface ConversationResponse {
6580
+ /**
6581
+ *
6582
+ * @type {Conversation}
6583
+ * @memberof ConversationResponse
6584
+ */
6585
+ conversation?: Conversation;
6586
+ /**
6587
+ *
6588
+ * @type {ModelError}
6589
+ * @memberof ConversationResponse
6590
+ */
6591
+ error?: ModelError;
6592
+ /**
6593
+ *
6594
+ * @type {ResponseMetadata}
6595
+ * @memberof ConversationResponse
6596
+ */
6597
+ metadata?: ResponseMetadata;
6598
+ /**
6599
+ * Indicates if API call was successful
6600
+ * @type {boolean}
6601
+ * @memberof ConversationResponse
6602
+ */
6603
+ success?: boolean;
6604
+ /**
6605
+ *
6606
+ * @type {Warning}
6607
+ * @memberof ConversationResponse
6608
+ */
6609
+ warning?: Warning;
6610
+ }
6611
+
6432
6612
  /**
6433
6613
  *
6434
6614
  * @export
@@ -6447,6 +6627,12 @@ export interface ConversationStartRequest {
6447
6627
  * @memberof ConversationStartRequest
6448
6628
  */
6449
6629
  conversation_arn?: string;
6630
+ /**
6631
+ *
6632
+ * @type {string}
6633
+ * @memberof ConversationStartRequest
6634
+ */
6635
+ conversation_webchat_queue_uuid?: string;
6450
6636
  }
6451
6637
 
6452
6638
  /**
@@ -6457,16 +6643,10 @@ export interface ConversationStartRequest {
6457
6643
  export interface ConversationStartResponse {
6458
6644
  /**
6459
6645
  *
6460
- * @type {string}
6646
+ * @type {Conversation}
6461
6647
  * @memberof ConversationStartResponse
6462
6648
  */
6463
- conversation_arn?: string;
6464
- /**
6465
- *
6466
- * @type {string}
6467
- * @memberof ConversationStartResponse
6468
- */
6469
- conversation_uuid?: string;
6649
+ conversation?: Conversation;
6470
6650
  }
6471
6651
 
6472
6652
  /**
@@ -6475,6 +6655,12 @@ export interface ConversationStartResponse {
6475
6655
  * @interface ConversationSummary
6476
6656
  */
6477
6657
  export interface ConversationSummary {
6658
+ /**
6659
+ *
6660
+ * @type {boolean}
6661
+ * @memberof ConversationSummary
6662
+ */
6663
+ closed?: boolean;
6478
6664
  /**
6479
6665
  *
6480
6666
  * @type {string}
@@ -6531,6 +6717,96 @@ export interface ConversationSummary {
6531
6717
  unread_messages?: boolean;
6532
6718
  }
6533
6719
 
6720
+ /**
6721
+ *
6722
+ * @export
6723
+ * @interface ConversationWebsocketMessage
6724
+ */
6725
+ export interface ConversationWebsocketMessage {
6726
+ /**
6727
+ * Conversation UUID if the websocket message is tied to a specific conversation
6728
+ * @type {string}
6729
+ * @memberof ConversationWebsocketMessage
6730
+ */
6731
+ conversation_uuid?: string;
6732
+ /**
6733
+ *
6734
+ * @type {ConversationSummary}
6735
+ * @memberof ConversationWebsocketMessage
6736
+ */
6737
+ event_conversation_closed?: ConversationSummary;
6738
+ /**
6739
+ *
6740
+ * @type {ConversationSummary}
6741
+ * @memberof ConversationWebsocketMessage
6742
+ */
6743
+ event_new_conversation?: ConversationSummary;
6744
+ /**
6745
+ *
6746
+ * @type {ConversationSummary}
6747
+ * @memberof ConversationWebsocketMessage
6748
+ */
6749
+ event_new_message?: ConversationSummary;
6750
+ /**
6751
+ *
6752
+ * @type {ConversationEventQueuePosition}
6753
+ * @memberof ConversationWebsocketMessage
6754
+ */
6755
+ event_queue_position?: ConversationEventQueuePosition;
6756
+ /**
6757
+ * Type of event
6758
+ * @type {string}
6759
+ * @memberof ConversationWebsocketMessage
6760
+ */
6761
+ event_type?: ConversationWebsocketMessage.EventTypeEnum;
6762
+ /**
6763
+ *
6764
+ * @type {ConversationMessage}
6765
+ * @memberof ConversationWebsocketMessage
6766
+ */
6767
+ event_updated_message?: ConversationMessage;
6768
+ /**
6769
+ *
6770
+ * @type {ConversationMessage}
6771
+ * @memberof ConversationWebsocketMessage
6772
+ */
6773
+ message?: ConversationMessage;
6774
+ /**
6775
+ * Type of message
6776
+ * @type {string}
6777
+ * @memberof ConversationWebsocketMessage
6778
+ */
6779
+ type?: ConversationWebsocketMessage.TypeEnum;
6780
+ }
6781
+
6782
+ /**
6783
+ * @export
6784
+ * @namespace ConversationWebsocketMessage
6785
+ */
6786
+ export namespace ConversationWebsocketMessage {
6787
+ /**
6788
+ * @export
6789
+ * @enum {string}
6790
+ */
6791
+ export enum EventTypeEnum {
6792
+ QueuePosition = <any> 'queue position',
6793
+ WebchatStartConversation = <any> 'webchat start conversation',
6794
+ ConversationClosed = <any> 'conversation closed',
6795
+ NewConversation = <any> 'new conversation',
6796
+ NewMessage = <any> 'new message',
6797
+ UpdatedMessage = <any> 'updated message'
6798
+ }
6799
+ /**
6800
+ * @export
6801
+ * @enum {string}
6802
+ */
6803
+ export enum TypeEnum {
6804
+ Message = <any> 'message',
6805
+ Event = <any> 'event',
6806
+ Ping = <any> 'ping'
6807
+ }
6808
+ }
6809
+
6534
6810
  /**
6535
6811
  *
6536
6812
  * @export
@@ -38723,7 +38999,7 @@ export const ConversationApiFp = function(configuration?: Configuration) {
38723
38999
  * @param {*} [options] Override http request option.
38724
39000
  * @throws {RequiredError}
38725
39001
  */
38726
- getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Conversation> {
39002
+ getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationResponse> {
38727
39003
  const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversation(conversation_uuid, options);
38728
39004
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
38729
39005
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -38744,13 +39020,13 @@ export const ConversationApiFp = function(configuration?: Configuration) {
38744
39020
  * @param {*} [options] Override http request option.
38745
39021
  * @throws {RequiredError}
38746
39022
  */
38747
- getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
39023
+ getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse> {
38748
39024
  const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationMultimediaUploadUrl(extension, options);
38749
39025
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
38750
39026
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
38751
39027
 
38752
39028
  if (response.status >= 200 && response.status < 300) {
38753
- return response;
39029
+ return response.json();
38754
39030
 
38755
39031
  } else {
38756
39032
  throw response;
@@ -38948,7 +39224,7 @@ export interface ConversationApiInterface {
38948
39224
  * @throws {RequiredError}
38949
39225
  * @memberof ConversationApiInterface
38950
39226
  */
38951
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
39227
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
38952
39228
 
38953
39229
  /**
38954
39230
  * Get a presigned conersation multimedia upload URL
@@ -38958,7 +39234,7 @@ export interface ConversationApiInterface {
38958
39234
  * @throws {RequiredError}
38959
39235
  * @memberof ConversationApiInterface
38960
39236
  */
38961
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<{}>;
39237
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
38962
39238
 
38963
39239
  /**
38964
39240
  * 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
@@ -6093,6 +6112,12 @@ export interface CityStateZip {
6093
6112
  * @interface Conversation
6094
6113
  */
6095
6114
  export interface Conversation {
6115
+ /**
6116
+ *
6117
+ * @type {boolean}
6118
+ * @memberof Conversation
6119
+ */
6120
+ closed?: boolean;
6096
6121
  /**
6097
6122
  *
6098
6123
  * @type {string}
@@ -6127,46 +6152,102 @@ export interface Conversation {
6127
6152
  /**
6128
6153
  *
6129
6154
  * @export
6130
- * @interface ConversationAgentAuthResponse
6155
+ * @interface ConversationAgentAuth
6131
6156
  */
6132
- export interface ConversationAgentAuthResponse {
6157
+ export interface ConversationAgentAuth {
6133
6158
  /**
6134
6159
  *
6135
6160
  * @type {string}
6136
- * @memberof ConversationAgentAuthResponse
6161
+ * @memberof ConversationAgentAuth
6137
6162
  */
6138
6163
  conversation_participant_arn?: string;
6139
6164
  /**
6140
6165
  *
6141
6166
  * @type {string}
6142
- * @memberof ConversationAgentAuthResponse
6167
+ * @memberof ConversationAgentAuth
6143
6168
  */
6144
6169
  conversation_participant_name?: string;
6145
6170
  /**
6146
6171
  *
6147
6172
  * @type {string}
6148
- * @memberof ConversationAgentAuthResponse
6173
+ * @memberof ConversationAgentAuth
6149
6174
  */
6150
6175
  jwt?: string;
6151
6176
  /**
6152
6177
  *
6153
6178
  * @type {string}
6154
- * @memberof ConversationAgentAuthResponse
6179
+ * @memberof ConversationAgentAuth
6155
6180
  */
6156
6181
  merchant_id?: string;
6157
6182
  /**
6158
6183
  *
6159
6184
  * @type {Array<string>}
6160
- * @memberof ConversationAgentAuthResponse
6185
+ * @memberof ConversationAgentAuth
6161
6186
  */
6162
6187
  twilio_phone_numbers?: Array<string>;
6163
6188
  /**
6164
6189
  *
6165
6190
  * @type {string}
6166
- * @memberof ConversationAgentAuthResponse
6191
+ * @memberof ConversationAgentAuth
6167
6192
  */
6168
6193
  websocket_url?: string;
6169
6194
  }
6195
+ /**
6196
+ *
6197
+ * @export
6198
+ * @interface ConversationAgentAuthResponse
6199
+ */
6200
+ export interface ConversationAgentAuthResponse {
6201
+ /**
6202
+ *
6203
+ * @type {ConversationAgentAuth}
6204
+ * @memberof ConversationAgentAuthResponse
6205
+ */
6206
+ agent_auth?: ConversationAgentAuth;
6207
+ /**
6208
+ *
6209
+ * @type {ModelError}
6210
+ * @memberof ConversationAgentAuthResponse
6211
+ */
6212
+ error?: ModelError;
6213
+ /**
6214
+ *
6215
+ * @type {ResponseMetadata}
6216
+ * @memberof ConversationAgentAuthResponse
6217
+ */
6218
+ metadata?: ResponseMetadata;
6219
+ /**
6220
+ * Indicates if API call was successful
6221
+ * @type {boolean}
6222
+ * @memberof ConversationAgentAuthResponse
6223
+ */
6224
+ success?: boolean;
6225
+ /**
6226
+ *
6227
+ * @type {Warning}
6228
+ * @memberof ConversationAgentAuthResponse
6229
+ */
6230
+ warning?: Warning;
6231
+ }
6232
+ /**
6233
+ *
6234
+ * @export
6235
+ * @interface ConversationEventQueuePosition
6236
+ */
6237
+ export interface ConversationEventQueuePosition {
6238
+ /**
6239
+ * True if agents are logged into the queue
6240
+ * @type {boolean}
6241
+ * @memberof ConversationEventQueuePosition
6242
+ */
6243
+ available?: boolean;
6244
+ /**
6245
+ * Position in the queue. Value will be -1 if they cant be found in the queue.
6246
+ * @type {number}
6247
+ * @memberof ConversationEventQueuePosition
6248
+ */
6249
+ position?: number;
6250
+ }
6170
6251
  /**
6171
6252
  *
6172
6253
  * @export
@@ -6229,6 +6310,62 @@ export interface ConversationMessageTransportStatus {
6229
6310
  */
6230
6311
  status?: string;
6231
6312
  }
6313
+ /**
6314
+ *
6315
+ * @export
6316
+ * @interface ConversationMultimediaUploadUrl
6317
+ */
6318
+ export interface ConversationMultimediaUploadUrl {
6319
+ /**
6320
+ *
6321
+ * @type {string}
6322
+ * @memberof ConversationMultimediaUploadUrl
6323
+ */
6324
+ key?: string;
6325
+ /**
6326
+ *
6327
+ * @type {string}
6328
+ * @memberof ConversationMultimediaUploadUrl
6329
+ */
6330
+ url?: string;
6331
+ }
6332
+ /**
6333
+ *
6334
+ * @export
6335
+ * @interface ConversationMultimediaUploadUrlResponse
6336
+ */
6337
+ export interface ConversationMultimediaUploadUrlResponse {
6338
+ /**
6339
+ *
6340
+ * @type {ConversationMultimediaUploadUrl}
6341
+ * @memberof ConversationMultimediaUploadUrlResponse
6342
+ */
6343
+ conversation_multimedia_upload_url?: ConversationMultimediaUploadUrl;
6344
+ /**
6345
+ *
6346
+ * @type {ModelError}
6347
+ * @memberof ConversationMultimediaUploadUrlResponse
6348
+ */
6349
+ error?: ModelError;
6350
+ /**
6351
+ *
6352
+ * @type {ResponseMetadata}
6353
+ * @memberof ConversationMultimediaUploadUrlResponse
6354
+ */
6355
+ metadata?: ResponseMetadata;
6356
+ /**
6357
+ * Indicates if API call was successful
6358
+ * @type {boolean}
6359
+ * @memberof ConversationMultimediaUploadUrlResponse
6360
+ */
6361
+ success?: boolean;
6362
+ /**
6363
+ *
6364
+ * @type {Warning}
6365
+ * @memberof ConversationMultimediaUploadUrlResponse
6366
+ */
6367
+ warning?: Warning;
6368
+ }
6232
6369
  /**
6233
6370
  *
6234
6371
  * @export
@@ -6278,6 +6415,43 @@ export interface ConversationParticipant {
6278
6415
  */
6279
6416
  status?: string;
6280
6417
  }
6418
+ /**
6419
+ *
6420
+ * @export
6421
+ * @interface ConversationResponse
6422
+ */
6423
+ export interface ConversationResponse {
6424
+ /**
6425
+ *
6426
+ * @type {Conversation}
6427
+ * @memberof ConversationResponse
6428
+ */
6429
+ conversation?: Conversation;
6430
+ /**
6431
+ *
6432
+ * @type {ModelError}
6433
+ * @memberof ConversationResponse
6434
+ */
6435
+ error?: ModelError;
6436
+ /**
6437
+ *
6438
+ * @type {ResponseMetadata}
6439
+ * @memberof ConversationResponse
6440
+ */
6441
+ metadata?: ResponseMetadata;
6442
+ /**
6443
+ * Indicates if API call was successful
6444
+ * @type {boolean}
6445
+ * @memberof ConversationResponse
6446
+ */
6447
+ success?: boolean;
6448
+ /**
6449
+ *
6450
+ * @type {Warning}
6451
+ * @memberof ConversationResponse
6452
+ */
6453
+ warning?: Warning;
6454
+ }
6281
6455
  /**
6282
6456
  *
6283
6457
  * @export
@@ -6296,6 +6470,12 @@ export interface ConversationStartRequest {
6296
6470
  * @memberof ConversationStartRequest
6297
6471
  */
6298
6472
  conversation_arn?: string;
6473
+ /**
6474
+ *
6475
+ * @type {string}
6476
+ * @memberof ConversationStartRequest
6477
+ */
6478
+ conversation_webchat_queue_uuid?: string;
6299
6479
  }
6300
6480
  /**
6301
6481
  *
@@ -6305,16 +6485,10 @@ export interface ConversationStartRequest {
6305
6485
  export interface ConversationStartResponse {
6306
6486
  /**
6307
6487
  *
6308
- * @type {string}
6488
+ * @type {Conversation}
6309
6489
  * @memberof ConversationStartResponse
6310
6490
  */
6311
- conversation_arn?: string;
6312
- /**
6313
- *
6314
- * @type {string}
6315
- * @memberof ConversationStartResponse
6316
- */
6317
- conversation_uuid?: string;
6491
+ conversation?: Conversation;
6318
6492
  }
6319
6493
  /**
6320
6494
  *
@@ -6322,6 +6496,12 @@ export interface ConversationStartResponse {
6322
6496
  * @interface ConversationSummary
6323
6497
  */
6324
6498
  export interface ConversationSummary {
6499
+ /**
6500
+ *
6501
+ * @type {boolean}
6502
+ * @memberof ConversationSummary
6503
+ */
6504
+ closed?: boolean;
6325
6505
  /**
6326
6506
  *
6327
6507
  * @type {string}
@@ -6377,6 +6557,94 @@ export interface ConversationSummary {
6377
6557
  */
6378
6558
  unread_messages?: boolean;
6379
6559
  }
6560
+ /**
6561
+ *
6562
+ * @export
6563
+ * @interface ConversationWebsocketMessage
6564
+ */
6565
+ export interface ConversationWebsocketMessage {
6566
+ /**
6567
+ * Conversation UUID if the websocket message is tied to a specific conversation
6568
+ * @type {string}
6569
+ * @memberof ConversationWebsocketMessage
6570
+ */
6571
+ conversation_uuid?: string;
6572
+ /**
6573
+ *
6574
+ * @type {ConversationSummary}
6575
+ * @memberof ConversationWebsocketMessage
6576
+ */
6577
+ event_conversation_closed?: ConversationSummary;
6578
+ /**
6579
+ *
6580
+ * @type {ConversationSummary}
6581
+ * @memberof ConversationWebsocketMessage
6582
+ */
6583
+ event_new_conversation?: ConversationSummary;
6584
+ /**
6585
+ *
6586
+ * @type {ConversationSummary}
6587
+ * @memberof ConversationWebsocketMessage
6588
+ */
6589
+ event_new_message?: ConversationSummary;
6590
+ /**
6591
+ *
6592
+ * @type {ConversationEventQueuePosition}
6593
+ * @memberof ConversationWebsocketMessage
6594
+ */
6595
+ event_queue_position?: ConversationEventQueuePosition;
6596
+ /**
6597
+ * Type of event
6598
+ * @type {string}
6599
+ * @memberof ConversationWebsocketMessage
6600
+ */
6601
+ event_type?: ConversationWebsocketMessage.EventTypeEnum;
6602
+ /**
6603
+ *
6604
+ * @type {ConversationMessage}
6605
+ * @memberof ConversationWebsocketMessage
6606
+ */
6607
+ event_updated_message?: ConversationMessage;
6608
+ /**
6609
+ *
6610
+ * @type {ConversationMessage}
6611
+ * @memberof ConversationWebsocketMessage
6612
+ */
6613
+ message?: ConversationMessage;
6614
+ /**
6615
+ * Type of message
6616
+ * @type {string}
6617
+ * @memberof ConversationWebsocketMessage
6618
+ */
6619
+ type?: ConversationWebsocketMessage.TypeEnum;
6620
+ }
6621
+ /**
6622
+ * @export
6623
+ * @namespace ConversationWebsocketMessage
6624
+ */
6625
+ export declare namespace ConversationWebsocketMessage {
6626
+ /**
6627
+ * @export
6628
+ * @enum {string}
6629
+ */
6630
+ enum EventTypeEnum {
6631
+ QueuePosition,
6632
+ WebchatStartConversation,
6633
+ ConversationClosed,
6634
+ NewConversation,
6635
+ NewMessage,
6636
+ UpdatedMessage
6637
+ }
6638
+ /**
6639
+ * @export
6640
+ * @enum {string}
6641
+ */
6642
+ enum TypeEnum {
6643
+ Message,
6644
+ Event,
6645
+ Ping
6646
+ }
6647
+ }
6380
6648
  /**
6381
6649
  *
6382
6650
  * @export
@@ -34706,7 +34974,7 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34706
34974
  * @param {*} [options] Override http request option.
34707
34975
  * @throws {RequiredError}
34708
34976
  */
34709
- getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Conversation>;
34977
+ getConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationResponse>;
34710
34978
  /**
34711
34979
  * Get a presigned conersation multimedia upload URL
34712
34980
  * @summary Get a presigned conersation multimedia upload URL
@@ -34714,7 +34982,7 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
34714
34982
  * @param {*} [options] Override http request option.
34715
34983
  * @throws {RequiredError}
34716
34984
  */
34717
- getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
34985
+ getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse>;
34718
34986
  /**
34719
34987
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34720
34988
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34768,7 +35036,7 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
34768
35036
  * @param {*} [options] Override http request option.
34769
35037
  * @throws {RequiredError}
34770
35038
  */
34771
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35039
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34772
35040
  /**
34773
35041
  * Get a presigned conersation multimedia upload URL
34774
35042
  * @summary Get a presigned conersation multimedia upload URL
@@ -34776,7 +35044,7 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
34776
35044
  * @param {*} [options] Override http request option.
34777
35045
  * @throws {RequiredError}
34778
35046
  */
34779
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<Response>;
35047
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34780
35048
  /**
34781
35049
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34782
35050
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34833,7 +35101,7 @@ export interface ConversationApiInterface {
34833
35101
  * @throws {RequiredError}
34834
35102
  * @memberof ConversationApiInterface
34835
35103
  */
34836
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35104
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34837
35105
  /**
34838
35106
  * Get a presigned conersation multimedia upload URL
34839
35107
  * @summary Get a presigned conersation multimedia upload URL
@@ -34842,7 +35110,7 @@ export interface ConversationApiInterface {
34842
35110
  * @throws {RequiredError}
34843
35111
  * @memberof ConversationApiInterface
34844
35112
  */
34845
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<{}>;
35113
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34846
35114
  /**
34847
35115
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34848
35116
  * @summary Retrieve a list of conversation summaries newest to oldest
@@ -34904,7 +35172,7 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
34904
35172
  * @throws {RequiredError}
34905
35173
  * @memberof ConversationApi
34906
35174
  */
34907
- getConversation(conversation_uuid: string, options?: any): Promise<Conversation>;
35175
+ getConversation(conversation_uuid: string, options?: any): Promise<ConversationResponse>;
34908
35176
  /**
34909
35177
  * Get a presigned conersation multimedia upload URL
34910
35178
  * @summary Get a presigned conersation multimedia upload URL
@@ -34913,7 +35181,7 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
34913
35181
  * @throws {RequiredError}
34914
35182
  * @memberof ConversationApi
34915
35183
  */
34916
- getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<Response>;
35184
+ getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
34917
35185
  /**
34918
35186
  * Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
34919
35187
  * @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.25",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [