ultracart_rest_api_v2_typescript 4.0.47-RC → 4.0.50-RC

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.
@@ -145,6 +145,7 @@ src/models/ConversationAgentAuth.ts
145
145
  src/models/ConversationAgentAuthResponse.ts
146
146
  src/models/ConversationEventQueuePosition.ts
147
147
  src/models/ConversationEventRRWeb.ts
148
+ src/models/ConversationEventTyping.ts
148
149
  src/models/ConversationMessage.ts
149
150
  src/models/ConversationMessageTransportStatus.ts
150
151
  src/models/ConversationMultimediaUploadUrl.ts
@@ -283,6 +284,8 @@ src/models/EmailCommseqPostcardSendTestResponse.ts
283
284
  src/models/EmailCommseqPostcardsRequest.ts
284
285
  src/models/EmailCommseqPostcardsResponse.ts
285
286
  src/models/EmailCommseqResponse.ts
287
+ src/models/EmailCommseqSequenceTestRequest.ts
288
+ src/models/EmailCommseqSequenceTestResponse.ts
286
289
  src/models/EmailCommseqStat.ts
287
290
  src/models/EmailCommseqStatResponse.ts
288
291
  src/models/EmailCommseqStep.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.47-RC
1
+ ## ultracart_rest_api_v2_typescript@4.0.50-RC
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@4.0.47-RC --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.50-RC --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
+ | 4.0.50-RC | 08/03/2022 | conversation summary participants |
58
+ | 4.0.49-RC | 08/03/2022 | more conversation events |
59
+ | 4.0.48-RC | 08/02/2022 | storefront communication sequence test method |
57
60
  | 4.0.47-RC | 08/01/2022 | conversation event refinement |
58
61
  | 4.0.46-RC | 07/29/2022 | conversation development |
59
62
  | 4.0.45-RC | 07/28/2022 | conversation bug fixes |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AddLibraryItemRequest, ApplyLibraryItemRequest, ApplyLibraryItemResponse, BaseResponse, CountriesResponse, EmailBaseTemplateListResponse, EmailCampaign, EmailCampaignFolder, EmailCampaignFolderResponse, EmailCampaignFoldersResponse, EmailCampaignResponse, EmailCampaignsResponse, EmailClicksResponse, EmailCommseq, EmailCommseqEmail, EmailCommseqEmailResponse, EmailCommseqEmailSendTestRequest, EmailCommseqEmailSendTestResponse, EmailCommseqEmailsRequest, EmailCommseqEmailsResponse, EmailCommseqPostcard, EmailCommseqPostcardResponse, EmailCommseqPostcardSendTestRequest, EmailCommseqPostcardSendTestResponse, EmailCommseqPostcardsRequest, EmailCommseqPostcardsResponse, EmailCommseqResponse, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
13
+ import { AddLibraryItemRequest, ApplyLibraryItemRequest, ApplyLibraryItemResponse, BaseResponse, CountriesResponse, EmailBaseTemplateListResponse, EmailCampaign, EmailCampaignFolder, EmailCampaignFolderResponse, EmailCampaignFoldersResponse, EmailCampaignResponse, EmailCampaignsResponse, EmailClicksResponse, EmailCommseq, EmailCommseqEmail, EmailCommseqEmailResponse, EmailCommseqEmailSendTestRequest, EmailCommseqEmailSendTestResponse, EmailCommseqEmailsRequest, EmailCommseqEmailsResponse, EmailCommseqPostcard, EmailCommseqPostcardResponse, EmailCommseqPostcardSendTestRequest, EmailCommseqPostcardSendTestResponse, EmailCommseqPostcardsRequest, EmailCommseqPostcardsResponse, EmailCommseqResponse, EmailCommseqSequenceTestRequest, EmailCommseqSequenceTestResponse, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
14
14
  export interface AddToLibraryRequest {
15
15
  addLibraryRequest: AddLibraryItemRequest;
16
16
  }
@@ -553,6 +553,11 @@ export interface SendWebhookTestRequest {
553
553
  storefrontOid: number;
554
554
  emailCommseqWebhookTestRequest: EmailCommseqWebhookSendTestRequest;
555
555
  }
556
+ export interface SequenceTestRequest {
557
+ storefrontOid: number;
558
+ commseqUuid: string;
559
+ emailCommseqSequenceTestRequest: EmailCommseqSequenceTestRequest;
560
+ }
556
561
  export interface StartEmailCampaignRequest {
557
562
  storefrontOid: number;
558
563
  emailCampaignUuid: string;
@@ -2610,6 +2615,21 @@ export interface StorefrontApiInterface {
2610
2615
  * Send webhook test
2611
2616
  */
2612
2617
  sendWebhookTest(requestParameters: SendWebhookTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqWebhookSendTestResponse>;
2618
+ /**
2619
+ *
2620
+ * @summary Sequence test
2621
+ * @param {number} storefrontOid
2622
+ * @param {string} commseqUuid
2623
+ * @param {EmailCommseqSequenceTestRequest} emailCommseqSequenceTestRequest Commseq test request
2624
+ * @param {*} [options] Override http request option.
2625
+ * @throws {RequiredError}
2626
+ * @memberof StorefrontApiInterface
2627
+ */
2628
+ sequenceTestRaw(requestParameters: SequenceTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailCommseqSequenceTestResponse>>;
2629
+ /**
2630
+ * Sequence test
2631
+ */
2632
+ sequenceTest(requestParameters: SequenceTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqSequenceTestResponse>;
2613
2633
  /**
2614
2634
  *
2615
2635
  * @summary Start email campaign
@@ -4127,6 +4147,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
4127
4147
  * Send webhook test
4128
4148
  */
4129
4149
  sendWebhookTest(requestParameters: SendWebhookTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqWebhookSendTestResponse>;
4150
+ /**
4151
+ * Sequence test
4152
+ */
4153
+ sequenceTestRaw(requestParameters: SequenceTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailCommseqSequenceTestResponse>>;
4154
+ /**
4155
+ * Sequence test
4156
+ */
4157
+ sequenceTest(requestParameters: SequenceTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqSequenceTestResponse>;
4130
4158
  /**
4131
4159
  * Start email campaign
4132
4160
  */
@@ -8723,6 +8723,74 @@ var StorefrontApi = /** @class */ (function (_super) {
8723
8723
  });
8724
8724
  });
8725
8725
  };
8726
+ /**
8727
+ * Sequence test
8728
+ */
8729
+ StorefrontApi.prototype.sequenceTestRaw = function (requestParameters, initOverrides) {
8730
+ return __awaiter(this, void 0, void 0, function () {
8731
+ var queryParameters, headerParameters, _a, _b, response;
8732
+ return __generator(this, function (_c) {
8733
+ switch (_c.label) {
8734
+ case 0:
8735
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
8736
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling sequenceTest.');
8737
+ }
8738
+ if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
8739
+ throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling sequenceTest.');
8740
+ }
8741
+ if (requestParameters.emailCommseqSequenceTestRequest === null || requestParameters.emailCommseqSequenceTestRequest === undefined) {
8742
+ throw new runtime.RequiredError('emailCommseqSequenceTestRequest', 'Required parameter requestParameters.emailCommseqSequenceTestRequest was null or undefined when calling sequenceTest.');
8743
+ }
8744
+ queryParameters = {};
8745
+ headerParameters = {};
8746
+ headerParameters['Content-Type'] = 'application/json';
8747
+ if (this.configuration && this.configuration.apiKey) {
8748
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
8749
+ }
8750
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
8751
+ // oauth required
8752
+ _a = headerParameters;
8753
+ _b = "Authorization";
8754
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_write"])];
8755
+ case 1:
8756
+ // oauth required
8757
+ _a[_b] = _c.sent();
8758
+ _c.label = 2;
8759
+ case 2:
8760
+ if (this.configuration && this.configuration.apiKey) {
8761
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
8762
+ }
8763
+ return [4 /*yield*/, this.request({
8764
+ path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))),
8765
+ method: 'POST',
8766
+ headers: headerParameters,
8767
+ query: queryParameters,
8768
+ body: (0, models_1.EmailCommseqSequenceTestRequestToJSON)(requestParameters.emailCommseqSequenceTestRequest),
8769
+ }, initOverrides)];
8770
+ case 3:
8771
+ response = _c.sent();
8772
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailCommseqSequenceTestResponseFromJSON)(jsonValue); })];
8773
+ }
8774
+ });
8775
+ });
8776
+ };
8777
+ /**
8778
+ * Sequence test
8779
+ */
8780
+ StorefrontApi.prototype.sequenceTest = function (requestParameters, initOverrides) {
8781
+ return __awaiter(this, void 0, void 0, function () {
8782
+ var response;
8783
+ return __generator(this, function (_a) {
8784
+ switch (_a.label) {
8785
+ case 0: return [4 /*yield*/, this.sequenceTestRaw(requestParameters, initOverrides)];
8786
+ case 1:
8787
+ response = _a.sent();
8788
+ return [4 /*yield*/, response.value()];
8789
+ case 2: return [2 /*return*/, _a.sent()];
8790
+ }
8791
+ });
8792
+ });
8793
+ };
8726
8794
  /**
8727
8795
  * Start email campaign
8728
8796
  */
@@ -0,0 +1,39 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ConversationEventTyping
16
+ */
17
+ export interface ConversationEventTyping {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ConversationEventTyping
22
+ */
23
+ author_conversation_participant_arn?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof ConversationEventTyping
28
+ */
29
+ author_conversation_participant_name?: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof ConversationEventTyping
34
+ */
35
+ value?: string;
36
+ }
37
+ export declare function ConversationEventTypingFromJSON(json: any): ConversationEventTyping;
38
+ export declare function ConversationEventTypingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEventTyping;
39
+ export declare function ConversationEventTypingToJSON(value?: ConversationEventTyping | null): any;
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ConversationEventTypingToJSON = exports.ConversationEventTypingFromJSONTyped = exports.ConversationEventTypingFromJSON = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ function ConversationEventTypingFromJSON(json) {
19
+ return ConversationEventTypingFromJSONTyped(json, false);
20
+ }
21
+ exports.ConversationEventTypingFromJSON = ConversationEventTypingFromJSON;
22
+ function ConversationEventTypingFromJSONTyped(json, ignoreDiscriminator) {
23
+ if ((json === undefined) || (json === null)) {
24
+ return json;
25
+ }
26
+ return {
27
+ 'author_conversation_participant_arn': !(0, runtime_1.exists)(json, 'author_conversation_participant_arn') ? undefined : json['author_conversation_participant_arn'],
28
+ 'author_conversation_participant_name': !(0, runtime_1.exists)(json, 'author_conversation_participant_name') ? undefined : json['author_conversation_participant_name'],
29
+ 'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
30
+ };
31
+ }
32
+ exports.ConversationEventTypingFromJSONTyped = ConversationEventTypingFromJSONTyped;
33
+ function ConversationEventTypingToJSON(value) {
34
+ if (value === undefined) {
35
+ return undefined;
36
+ }
37
+ if (value === null) {
38
+ return null;
39
+ }
40
+ return {
41
+ 'author_conversation_participant_arn': value.author_conversation_participant_arn,
42
+ 'author_conversation_participant_name': value.author_conversation_participant_name,
43
+ 'value': value.value,
44
+ };
45
+ }
46
+ exports.ConversationEventTypingToJSON = ConversationEventTypingToJSON;
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { ConversationParticipant } from './ConversationParticipant';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -69,6 +70,12 @@ export interface ConversationSummary {
69
70
  * @memberof ConversationSummary
70
71
  */
71
72
  message_count?: number;
73
+ /**
74
+ *
75
+ * @type {Array<ConversationParticipant>}
76
+ * @memberof ConversationSummary
77
+ */
78
+ participants?: Array<ConversationParticipant>;
72
79
  /**
73
80
  * Start of the conversation date/time
74
81
  * @type {string}
@@ -15,6 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.ConversationSummaryToJSON = exports.ConversationSummaryFromJSONTyped = exports.ConversationSummaryFromJSON = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ var ConversationParticipant_1 = require("./ConversationParticipant");
18
19
  function ConversationSummaryFromJSON(json) {
19
20
  return ConversationSummaryFromJSONTyped(json, false);
20
21
  }
@@ -33,6 +34,7 @@ function ConversationSummaryFromJSONTyped(json, ignoreDiscriminator) {
33
34
  'last_message_dts': !(0, runtime_1.exists)(json, 'last_message_dts') ? undefined : json['last_message_dts'],
34
35
  'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
35
36
  'message_count': !(0, runtime_1.exists)(json, 'message_count') ? undefined : json['message_count'],
37
+ 'participants': !(0, runtime_1.exists)(json, 'participants') ? undefined : (json['participants'].map(ConversationParticipant_1.ConversationParticipantFromJSON)),
36
38
  'start_dts': !(0, runtime_1.exists)(json, 'start_dts') ? undefined : json['start_dts'],
37
39
  'unread_messages': !(0, runtime_1.exists)(json, 'unread_messages') ? undefined : json['unread_messages'],
38
40
  'visible': !(0, runtime_1.exists)(json, 'visible') ? undefined : json['visible'],
@@ -56,6 +58,7 @@ function ConversationSummaryToJSON(value) {
56
58
  'last_message_dts': value.last_message_dts,
57
59
  'merchant_id': value.merchant_id,
58
60
  'message_count': value.message_count,
61
+ 'participants': value.participants === undefined ? undefined : (value.participants.map(ConversationParticipant_1.ConversationParticipantToJSON)),
59
62
  'start_dts': value.start_dts,
60
63
  'unread_messages': value.unread_messages,
61
64
  'visible': value.visible,
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import { ConversationEventQueuePosition } from './ConversationEventQueuePosition';
13
13
  import { ConversationEventRRWeb } from './ConversationEventRRWeb';
14
+ import { ConversationEventTyping } from './ConversationEventTyping';
14
15
  import { ConversationMessage } from './ConversationMessage';
15
16
  import { ConversationSummary } from './ConversationSummary';
16
17
  import { ConversationWebchatQueueStatus } from './ConversationWebchatQueueStatus';
@@ -44,6 +45,12 @@ export interface ConversationWebsocketMessage {
44
45
  * @memberof ConversationWebsocketMessage
45
46
  */
46
47
  event_new_message?: ConversationSummary;
48
+ /**
49
+ *
50
+ * @type {ConversationSummary}
51
+ * @memberof ConversationWebsocketMessage
52
+ */
53
+ event_participant_update?: ConversationSummary;
47
54
  /**
48
55
  *
49
56
  * @type {ConversationEventQueuePosition}
@@ -68,6 +75,12 @@ export interface ConversationWebsocketMessage {
68
75
  * @memberof ConversationWebsocketMessage
69
76
  */
70
77
  event_type?: ConversationWebsocketMessageEventTypeEnum;
78
+ /**
79
+ *
80
+ * @type {ConversationEventTyping}
81
+ * @memberof ConversationWebsocketMessage
82
+ */
83
+ event_typing?: ConversationEventTyping;
71
84
  /**
72
85
  *
73
86
  * @type {ConversationMessage}
@@ -99,6 +112,7 @@ export declare const ConversationWebsocketMessageEventTypeEnum: {
99
112
  readonly UpdatedMessage: "updated message";
100
113
  readonly QueueStatusUpdate: "queue status update";
101
114
  readonly Rrweb: "rrweb";
115
+ readonly ParticipantUpdate: "participant update";
102
116
  };
103
117
  export declare type ConversationWebsocketMessageEventTypeEnum = typeof ConversationWebsocketMessageEventTypeEnum[keyof typeof ConversationWebsocketMessageEventTypeEnum];
104
118
  /**
@@ -17,6 +17,7 @@ exports.ConversationWebsocketMessageToJSON = exports.ConversationWebsocketMessag
17
17
  var runtime_1 = require("../runtime");
18
18
  var ConversationEventQueuePosition_1 = require("./ConversationEventQueuePosition");
19
19
  var ConversationEventRRWeb_1 = require("./ConversationEventRRWeb");
20
+ var ConversationEventTyping_1 = require("./ConversationEventTyping");
20
21
  var ConversationMessage_1 = require("./ConversationMessage");
21
22
  var ConversationSummary_1 = require("./ConversationSummary");
22
23
  var ConversationWebchatQueueStatus_1 = require("./ConversationWebchatQueueStatus");
@@ -31,7 +32,8 @@ exports.ConversationWebsocketMessageEventTypeEnum = {
31
32
  NewMessage: 'new message',
32
33
  UpdatedMessage: 'updated message',
33
34
  QueueStatusUpdate: 'queue status update',
34
- Rrweb: 'rrweb'
35
+ Rrweb: 'rrweb',
36
+ ParticipantUpdate: 'participant update'
35
37
  };
36
38
  /**
37
39
  * @export
@@ -55,10 +57,12 @@ function ConversationWebsocketMessageFromJSONTyped(json, ignoreDiscriminator) {
55
57
  'event_conversation_closed': !(0, runtime_1.exists)(json, 'event_conversation_closed') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_conversation_closed']),
56
58
  'event_new_conversation': !(0, runtime_1.exists)(json, 'event_new_conversation') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_new_conversation']),
57
59
  'event_new_message': !(0, runtime_1.exists)(json, 'event_new_message') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_new_message']),
60
+ 'event_participant_update': !(0, runtime_1.exists)(json, 'event_participant_update') ? undefined : (0, ConversationSummary_1.ConversationSummaryFromJSON)(json['event_participant_update']),
58
61
  'event_queue_position': !(0, runtime_1.exists)(json, 'event_queue_position') ? undefined : (0, ConversationEventQueuePosition_1.ConversationEventQueuePositionFromJSON)(json['event_queue_position']),
59
62
  'event_queue_status_update': !(0, runtime_1.exists)(json, 'event_queue_status_update') ? undefined : (0, ConversationWebchatQueueStatus_1.ConversationWebchatQueueStatusFromJSON)(json['event_queue_status_update']),
60
63
  'event_rrweb': !(0, runtime_1.exists)(json, 'event_rrweb') ? undefined : (0, ConversationEventRRWeb_1.ConversationEventRRWebFromJSON)(json['event_rrweb']),
61
64
  'event_type': !(0, runtime_1.exists)(json, 'event_type') ? undefined : json['event_type'],
65
+ 'event_typing': !(0, runtime_1.exists)(json, 'event_typing') ? undefined : (0, ConversationEventTyping_1.ConversationEventTypingFromJSON)(json['event_typing']),
62
66
  'event_updated_message': !(0, runtime_1.exists)(json, 'event_updated_message') ? undefined : (0, ConversationMessage_1.ConversationMessageFromJSON)(json['event_updated_message']),
63
67
  'message': !(0, runtime_1.exists)(json, 'message') ? undefined : (0, ConversationMessage_1.ConversationMessageFromJSON)(json['message']),
64
68
  'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
@@ -77,10 +81,12 @@ function ConversationWebsocketMessageToJSON(value) {
77
81
  'event_conversation_closed': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_conversation_closed),
78
82
  'event_new_conversation': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_new_conversation),
79
83
  'event_new_message': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_new_message),
84
+ 'event_participant_update': (0, ConversationSummary_1.ConversationSummaryToJSON)(value.event_participant_update),
80
85
  'event_queue_position': (0, ConversationEventQueuePosition_1.ConversationEventQueuePositionToJSON)(value.event_queue_position),
81
86
  'event_queue_status_update': (0, ConversationWebchatQueueStatus_1.ConversationWebchatQueueStatusToJSON)(value.event_queue_status_update),
82
87
  'event_rrweb': (0, ConversationEventRRWeb_1.ConversationEventRRWebToJSON)(value.event_rrweb),
83
88
  'event_type': value.event_type,
89
+ 'event_typing': (0, ConversationEventTyping_1.ConversationEventTypingToJSON)(value.event_typing),
84
90
  'event_updated_message': (0, ConversationMessage_1.ConversationMessageToJSON)(value.event_updated_message),
85
91
  'message': (0, ConversationMessage_1.ConversationMessageToJSON)(value.message),
86
92
  'type': value.type,
@@ -0,0 +1,69 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface EmailCommseqSequenceTestRequest
16
+ */
17
+ export interface EmailCommseqSequenceTestRequest {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof EmailCommseqSequenceTestRequest
22
+ */
23
+ cart_id?: string;
24
+ /**
25
+ *
26
+ * @type {Array<string>}
27
+ * @memberof EmailCommseqSequenceTestRequest
28
+ */
29
+ cart_item_ids?: Array<string>;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof EmailCommseqSequenceTestRequest
34
+ */
35
+ esp_commseq_uuid?: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof EmailCommseqSequenceTestRequest
40
+ */
41
+ name?: string;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof EmailCommseqSequenceTestRequest
46
+ */
47
+ order_id?: string;
48
+ /**
49
+ *
50
+ * @type {boolean}
51
+ * @memberof EmailCommseqSequenceTestRequest
52
+ */
53
+ please_review?: boolean;
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof EmailCommseqSequenceTestRequest
58
+ */
59
+ send_to_email?: string;
60
+ /**
61
+ *
62
+ * @type {boolean}
63
+ * @memberof EmailCommseqSequenceTestRequest
64
+ */
65
+ send_to_logged_in_user?: boolean;
66
+ }
67
+ export declare function EmailCommseqSequenceTestRequestFromJSON(json: any): EmailCommseqSequenceTestRequest;
68
+ export declare function EmailCommseqSequenceTestRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailCommseqSequenceTestRequest;
69
+ export declare function EmailCommseqSequenceTestRequestToJSON(value?: EmailCommseqSequenceTestRequest | null): any;
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.EmailCommseqSequenceTestRequestToJSON = exports.EmailCommseqSequenceTestRequestFromJSONTyped = exports.EmailCommseqSequenceTestRequestFromJSON = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ function EmailCommseqSequenceTestRequestFromJSON(json) {
19
+ return EmailCommseqSequenceTestRequestFromJSONTyped(json, false);
20
+ }
21
+ exports.EmailCommseqSequenceTestRequestFromJSON = EmailCommseqSequenceTestRequestFromJSON;
22
+ function EmailCommseqSequenceTestRequestFromJSONTyped(json, ignoreDiscriminator) {
23
+ if ((json === undefined) || (json === null)) {
24
+ return json;
25
+ }
26
+ return {
27
+ 'cart_id': !(0, runtime_1.exists)(json, 'cart_id') ? undefined : json['cart_id'],
28
+ 'cart_item_ids': !(0, runtime_1.exists)(json, 'cart_item_ids') ? undefined : json['cart_item_ids'],
29
+ 'esp_commseq_uuid': !(0, runtime_1.exists)(json, 'esp_commseq_uuid') ? undefined : json['esp_commseq_uuid'],
30
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
31
+ 'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
32
+ 'please_review': !(0, runtime_1.exists)(json, 'please_review') ? undefined : json['please_review'],
33
+ 'send_to_email': !(0, runtime_1.exists)(json, 'send_to_email') ? undefined : json['send_to_email'],
34
+ 'send_to_logged_in_user': !(0, runtime_1.exists)(json, 'send_to_logged_in_user') ? undefined : json['send_to_logged_in_user'],
35
+ };
36
+ }
37
+ exports.EmailCommseqSequenceTestRequestFromJSONTyped = EmailCommseqSequenceTestRequestFromJSONTyped;
38
+ function EmailCommseqSequenceTestRequestToJSON(value) {
39
+ if (value === undefined) {
40
+ return undefined;
41
+ }
42
+ if (value === null) {
43
+ return null;
44
+ }
45
+ return {
46
+ 'cart_id': value.cart_id,
47
+ 'cart_item_ids': value.cart_item_ids,
48
+ 'esp_commseq_uuid': value.esp_commseq_uuid,
49
+ 'name': value.name,
50
+ 'order_id': value.order_id,
51
+ 'please_review': value.please_review,
52
+ 'send_to_email': value.send_to_email,
53
+ 'send_to_logged_in_user': value.send_to_logged_in_user,
54
+ };
55
+ }
56
+ exports.EmailCommseqSequenceTestRequestToJSON = EmailCommseqSequenceTestRequestToJSON;
@@ -0,0 +1,48 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ModelError } from './ModelError';
13
+ import { ResponseMetadata } from './ResponseMetadata';
14
+ import { Warning } from './Warning';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface EmailCommseqSequenceTestResponse
19
+ */
20
+ export interface EmailCommseqSequenceTestResponse {
21
+ /**
22
+ *
23
+ * @type {ModelError}
24
+ * @memberof EmailCommseqSequenceTestResponse
25
+ */
26
+ error?: ModelError;
27
+ /**
28
+ *
29
+ * @type {ResponseMetadata}
30
+ * @memberof EmailCommseqSequenceTestResponse
31
+ */
32
+ metadata?: ResponseMetadata;
33
+ /**
34
+ * Indicates if API call was successful
35
+ * @type {boolean}
36
+ * @memberof EmailCommseqSequenceTestResponse
37
+ */
38
+ success?: boolean;
39
+ /**
40
+ *
41
+ * @type {Warning}
42
+ * @memberof EmailCommseqSequenceTestResponse
43
+ */
44
+ warning?: Warning;
45
+ }
46
+ export declare function EmailCommseqSequenceTestResponseFromJSON(json: any): EmailCommseqSequenceTestResponse;
47
+ export declare function EmailCommseqSequenceTestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailCommseqSequenceTestResponse;
48
+ export declare function EmailCommseqSequenceTestResponseToJSON(value?: EmailCommseqSequenceTestResponse | null): any;
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.EmailCommseqSequenceTestResponseToJSON = exports.EmailCommseqSequenceTestResponseFromJSONTyped = exports.EmailCommseqSequenceTestResponseFromJSON = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var ModelError_1 = require("./ModelError");
19
+ var ResponseMetadata_1 = require("./ResponseMetadata");
20
+ var Warning_1 = require("./Warning");
21
+ function EmailCommseqSequenceTestResponseFromJSON(json) {
22
+ return EmailCommseqSequenceTestResponseFromJSONTyped(json, false);
23
+ }
24
+ exports.EmailCommseqSequenceTestResponseFromJSON = EmailCommseqSequenceTestResponseFromJSON;
25
+ function EmailCommseqSequenceTestResponseFromJSONTyped(json, ignoreDiscriminator) {
26
+ if ((json === undefined) || (json === null)) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
31
+ 'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
32
+ 'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
33
+ 'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
34
+ };
35
+ }
36
+ exports.EmailCommseqSequenceTestResponseFromJSONTyped = EmailCommseqSequenceTestResponseFromJSONTyped;
37
+ function EmailCommseqSequenceTestResponseToJSON(value) {
38
+ if (value === undefined) {
39
+ return undefined;
40
+ }
41
+ if (value === null) {
42
+ return null;
43
+ }
44
+ return {
45
+ 'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
46
+ 'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
47
+ 'success': value.success,
48
+ 'warning': (0, Warning_1.WarningToJSON)(value.warning),
49
+ };
50
+ }
51
+ exports.EmailCommseqSequenceTestResponseToJSON = EmailCommseqSequenceTestResponseToJSON;
@@ -120,6 +120,7 @@ export * from './ConversationAgentAuth';
120
120
  export * from './ConversationAgentAuthResponse';
121
121
  export * from './ConversationEventQueuePosition';
122
122
  export * from './ConversationEventRRWeb';
123
+ export * from './ConversationEventTyping';
123
124
  export * from './ConversationMessage';
124
125
  export * from './ConversationMessageTransportStatus';
125
126
  export * from './ConversationMultimediaUploadUrl';
@@ -258,6 +259,8 @@ export * from './EmailCommseqPostcardSendTestResponse';
258
259
  export * from './EmailCommseqPostcardsRequest';
259
260
  export * from './EmailCommseqPostcardsResponse';
260
261
  export * from './EmailCommseqResponse';
262
+ export * from './EmailCommseqSequenceTestRequest';
263
+ export * from './EmailCommseqSequenceTestResponse';
261
264
  export * from './EmailCommseqStat';
262
265
  export * from './EmailCommseqStatResponse';
263
266
  export * from './EmailCommseqStep';
@@ -138,6 +138,7 @@ __exportStar(require("./ConversationAgentAuth"), exports);
138
138
  __exportStar(require("./ConversationAgentAuthResponse"), exports);
139
139
  __exportStar(require("./ConversationEventQueuePosition"), exports);
140
140
  __exportStar(require("./ConversationEventRRWeb"), exports);
141
+ __exportStar(require("./ConversationEventTyping"), exports);
141
142
  __exportStar(require("./ConversationMessage"), exports);
142
143
  __exportStar(require("./ConversationMessageTransportStatus"), exports);
143
144
  __exportStar(require("./ConversationMultimediaUploadUrl"), exports);
@@ -276,6 +277,8 @@ __exportStar(require("./EmailCommseqPostcardSendTestResponse"), exports);
276
277
  __exportStar(require("./EmailCommseqPostcardsRequest"), exports);
277
278
  __exportStar(require("./EmailCommseqPostcardsResponse"), exports);
278
279
  __exportStar(require("./EmailCommseqResponse"), exports);
280
+ __exportStar(require("./EmailCommseqSequenceTestRequest"), exports);
281
+ __exportStar(require("./EmailCommseqSequenceTestResponse"), exports);
279
282
  __exportStar(require("./EmailCommseqStat"), exports);
280
283
  __exportStar(require("./EmailCommseqStatResponse"), exports);
281
284
  __exportStar(require("./EmailCommseqStep"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.0.47-RC",
3
+ "version": "4.0.50-RC",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -96,6 +96,12 @@ import {
96
96
  EmailCommseqResponse,
97
97
  EmailCommseqResponseFromJSON,
98
98
  EmailCommseqResponseToJSON,
99
+ EmailCommseqSequenceTestRequest,
100
+ EmailCommseqSequenceTestRequestFromJSON,
101
+ EmailCommseqSequenceTestRequestToJSON,
102
+ EmailCommseqSequenceTestResponse,
103
+ EmailCommseqSequenceTestResponseFromJSON,
104
+ EmailCommseqSequenceTestResponseToJSON,
99
105
  EmailCommseqStatResponse,
100
106
  EmailCommseqStatResponseFromJSON,
101
107
  EmailCommseqStatResponseToJSON,
@@ -1081,6 +1087,12 @@ export interface SendWebhookTestRequest {
1081
1087
  emailCommseqWebhookTestRequest: EmailCommseqWebhookSendTestRequest;
1082
1088
  }
1083
1089
 
1090
+ export interface SequenceTestRequest {
1091
+ storefrontOid: number;
1092
+ commseqUuid: string;
1093
+ emailCommseqSequenceTestRequest: EmailCommseqSequenceTestRequest;
1094
+ }
1095
+
1084
1096
  export interface StartEmailCampaignRequest {
1085
1097
  storefrontOid: number;
1086
1098
  emailCampaignUuid: string;
@@ -3436,6 +3448,23 @@ export interface StorefrontApiInterface {
3436
3448
  */
3437
3449
  sendWebhookTest(requestParameters: SendWebhookTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqWebhookSendTestResponse>;
3438
3450
 
3451
+ /**
3452
+ *
3453
+ * @summary Sequence test
3454
+ * @param {number} storefrontOid
3455
+ * @param {string} commseqUuid
3456
+ * @param {EmailCommseqSequenceTestRequest} emailCommseqSequenceTestRequest Commseq test request
3457
+ * @param {*} [options] Override http request option.
3458
+ * @throws {RequiredError}
3459
+ * @memberof StorefrontApiInterface
3460
+ */
3461
+ sequenceTestRaw(requestParameters: SequenceTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailCommseqSequenceTestResponse>>;
3462
+
3463
+ /**
3464
+ * Sequence test
3465
+ */
3466
+ sequenceTest(requestParameters: SequenceTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqSequenceTestResponse>;
3467
+
3439
3468
  /**
3440
3469
  *
3441
3470
  * @summary Start email campaign
@@ -10390,6 +10419,60 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
10390
10419
  return await response.value();
10391
10420
  }
10392
10421
 
10422
+ /**
10423
+ * Sequence test
10424
+ */
10425
+ async sequenceTestRaw(requestParameters: SequenceTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailCommseqSequenceTestResponse>> {
10426
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
10427
+ throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling sequenceTest.');
10428
+ }
10429
+
10430
+ if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
10431
+ throw new runtime.RequiredError('commseqUuid','Required parameter requestParameters.commseqUuid was null or undefined when calling sequenceTest.');
10432
+ }
10433
+
10434
+ if (requestParameters.emailCommseqSequenceTestRequest === null || requestParameters.emailCommseqSequenceTestRequest === undefined) {
10435
+ throw new runtime.RequiredError('emailCommseqSequenceTestRequest','Required parameter requestParameters.emailCommseqSequenceTestRequest was null or undefined when calling sequenceTest.');
10436
+ }
10437
+
10438
+ const queryParameters: any = {};
10439
+
10440
+ const headerParameters: runtime.HTTPHeaders = {};
10441
+
10442
+ headerParameters['Content-Type'] = 'application/json';
10443
+
10444
+ if (this.configuration && this.configuration.apiKey) {
10445
+ headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
10446
+ }
10447
+
10448
+ if (this.configuration && this.configuration.accessToken) {
10449
+ // oauth required
10450
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["storefront_write"]);
10451
+ }
10452
+
10453
+ if (this.configuration && this.configuration.apiKey) {
10454
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
10455
+ }
10456
+
10457
+ const response = await this.request({
10458
+ path: `/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"commseq_uuid"}}`, encodeURIComponent(String(requestParameters.commseqUuid))),
10459
+ method: 'POST',
10460
+ headers: headerParameters,
10461
+ query: queryParameters,
10462
+ body: EmailCommseqSequenceTestRequestToJSON(requestParameters.emailCommseqSequenceTestRequest),
10463
+ }, initOverrides);
10464
+
10465
+ return new runtime.JSONApiResponse(response, (jsonValue) => EmailCommseqSequenceTestResponseFromJSON(jsonValue));
10466
+ }
10467
+
10468
+ /**
10469
+ * Sequence test
10470
+ */
10471
+ async sequenceTest(requestParameters: SequenceTestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqSequenceTestResponse> {
10472
+ const response = await this.sequenceTestRaw(requestParameters, initOverrides);
10473
+ return await response.value();
10474
+ }
10475
+
10393
10476
  /**
10394
10477
  * Start email campaign
10395
10478
  */
@@ -0,0 +1,72 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ConversationEventTyping
20
+ */
21
+ export interface ConversationEventTyping {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof ConversationEventTyping
26
+ */
27
+ author_conversation_participant_arn?: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof ConversationEventTyping
32
+ */
33
+ author_conversation_participant_name?: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof ConversationEventTyping
38
+ */
39
+ value?: string;
40
+ }
41
+
42
+ export function ConversationEventTypingFromJSON(json: any): ConversationEventTyping {
43
+ return ConversationEventTypingFromJSONTyped(json, false);
44
+ }
45
+
46
+ export function ConversationEventTypingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationEventTyping {
47
+ if ((json === undefined) || (json === null)) {
48
+ return json;
49
+ }
50
+ return {
51
+
52
+ 'author_conversation_participant_arn': !exists(json, 'author_conversation_participant_arn') ? undefined : json['author_conversation_participant_arn'],
53
+ 'author_conversation_participant_name': !exists(json, 'author_conversation_participant_name') ? undefined : json['author_conversation_participant_name'],
54
+ 'value': !exists(json, 'value') ? undefined : json['value'],
55
+ };
56
+ }
57
+
58
+ export function ConversationEventTypingToJSON(value?: ConversationEventTyping | null): any {
59
+ if (value === undefined) {
60
+ return undefined;
61
+ }
62
+ if (value === null) {
63
+ return null;
64
+ }
65
+ return {
66
+
67
+ 'author_conversation_participant_arn': value.author_conversation_participant_arn,
68
+ 'author_conversation_participant_name': value.author_conversation_participant_name,
69
+ 'value': value.value,
70
+ };
71
+ }
72
+
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { exists, mapValues } from '../runtime';
16
+ import {
17
+ ConversationParticipant,
18
+ ConversationParticipantFromJSON,
19
+ ConversationParticipantFromJSONTyped,
20
+ ConversationParticipantToJSON,
21
+ } from './ConversationParticipant';
22
+
16
23
  /**
17
24
  *
18
25
  * @export
@@ -73,6 +80,12 @@ export interface ConversationSummary {
73
80
  * @memberof ConversationSummary
74
81
  */
75
82
  message_count?: number;
83
+ /**
84
+ *
85
+ * @type {Array<ConversationParticipant>}
86
+ * @memberof ConversationSummary
87
+ */
88
+ participants?: Array<ConversationParticipant>;
76
89
  /**
77
90
  * Start of the conversation date/time
78
91
  * @type {string}
@@ -112,6 +125,7 @@ export function ConversationSummaryFromJSONTyped(json: any, ignoreDiscriminator:
112
125
  'last_message_dts': !exists(json, 'last_message_dts') ? undefined : json['last_message_dts'],
113
126
  'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
114
127
  'message_count': !exists(json, 'message_count') ? undefined : json['message_count'],
128
+ 'participants': !exists(json, 'participants') ? undefined : ((json['participants'] as Array<any>).map(ConversationParticipantFromJSON)),
115
129
  'start_dts': !exists(json, 'start_dts') ? undefined : json['start_dts'],
116
130
  'unread_messages': !exists(json, 'unread_messages') ? undefined : json['unread_messages'],
117
131
  'visible': !exists(json, 'visible') ? undefined : json['visible'],
@@ -136,6 +150,7 @@ export function ConversationSummaryToJSON(value?: ConversationSummary | null): a
136
150
  'last_message_dts': value.last_message_dts,
137
151
  'merchant_id': value.merchant_id,
138
152
  'message_count': value.message_count,
153
+ 'participants': value.participants === undefined ? undefined : ((value.participants as Array<any>).map(ConversationParticipantToJSON)),
139
154
  'start_dts': value.start_dts,
140
155
  'unread_messages': value.unread_messages,
141
156
  'visible': value.visible,
@@ -25,6 +25,12 @@ import {
25
25
  ConversationEventRRWebFromJSONTyped,
26
26
  ConversationEventRRWebToJSON,
27
27
  } from './ConversationEventRRWeb';
28
+ import {
29
+ ConversationEventTyping,
30
+ ConversationEventTypingFromJSON,
31
+ ConversationEventTypingFromJSONTyped,
32
+ ConversationEventTypingToJSON,
33
+ } from './ConversationEventTyping';
28
34
  import {
29
35
  ConversationMessage,
30
36
  ConversationMessageFromJSON,
@@ -74,6 +80,12 @@ export interface ConversationWebsocketMessage {
74
80
  * @memberof ConversationWebsocketMessage
75
81
  */
76
82
  event_new_message?: ConversationSummary;
83
+ /**
84
+ *
85
+ * @type {ConversationSummary}
86
+ * @memberof ConversationWebsocketMessage
87
+ */
88
+ event_participant_update?: ConversationSummary;
77
89
  /**
78
90
  *
79
91
  * @type {ConversationEventQueuePosition}
@@ -98,6 +110,12 @@ export interface ConversationWebsocketMessage {
98
110
  * @memberof ConversationWebsocketMessage
99
111
  */
100
112
  event_type?: ConversationWebsocketMessageEventTypeEnum;
113
+ /**
114
+ *
115
+ * @type {ConversationEventTyping}
116
+ * @memberof ConversationWebsocketMessage
117
+ */
118
+ event_typing?: ConversationEventTyping;
101
119
  /**
102
120
  *
103
121
  * @type {ConversationMessage}
@@ -130,7 +148,8 @@ export const ConversationWebsocketMessageEventTypeEnum = {
130
148
  NewMessage: 'new message',
131
149
  UpdatedMessage: 'updated message',
132
150
  QueueStatusUpdate: 'queue status update',
133
- Rrweb: 'rrweb'
151
+ Rrweb: 'rrweb',
152
+ ParticipantUpdate: 'participant update'
134
153
  } as const;
135
154
  export type ConversationWebsocketMessageEventTypeEnum = typeof ConversationWebsocketMessageEventTypeEnum[keyof typeof ConversationWebsocketMessageEventTypeEnum];
136
155
 
@@ -160,10 +179,12 @@ export function ConversationWebsocketMessageFromJSONTyped(json: any, ignoreDiscr
160
179
  'event_conversation_closed': !exists(json, 'event_conversation_closed') ? undefined : ConversationSummaryFromJSON(json['event_conversation_closed']),
161
180
  'event_new_conversation': !exists(json, 'event_new_conversation') ? undefined : ConversationSummaryFromJSON(json['event_new_conversation']),
162
181
  'event_new_message': !exists(json, 'event_new_message') ? undefined : ConversationSummaryFromJSON(json['event_new_message']),
182
+ 'event_participant_update': !exists(json, 'event_participant_update') ? undefined : ConversationSummaryFromJSON(json['event_participant_update']),
163
183
  'event_queue_position': !exists(json, 'event_queue_position') ? undefined : ConversationEventQueuePositionFromJSON(json['event_queue_position']),
164
184
  'event_queue_status_update': !exists(json, 'event_queue_status_update') ? undefined : ConversationWebchatQueueStatusFromJSON(json['event_queue_status_update']),
165
185
  'event_rrweb': !exists(json, 'event_rrweb') ? undefined : ConversationEventRRWebFromJSON(json['event_rrweb']),
166
186
  'event_type': !exists(json, 'event_type') ? undefined : json['event_type'],
187
+ 'event_typing': !exists(json, 'event_typing') ? undefined : ConversationEventTypingFromJSON(json['event_typing']),
167
188
  'event_updated_message': !exists(json, 'event_updated_message') ? undefined : ConversationMessageFromJSON(json['event_updated_message']),
168
189
  'message': !exists(json, 'message') ? undefined : ConversationMessageFromJSON(json['message']),
169
190
  'type': !exists(json, 'type') ? undefined : json['type'],
@@ -183,10 +204,12 @@ export function ConversationWebsocketMessageToJSON(value?: ConversationWebsocket
183
204
  'event_conversation_closed': ConversationSummaryToJSON(value.event_conversation_closed),
184
205
  'event_new_conversation': ConversationSummaryToJSON(value.event_new_conversation),
185
206
  'event_new_message': ConversationSummaryToJSON(value.event_new_message),
207
+ 'event_participant_update': ConversationSummaryToJSON(value.event_participant_update),
186
208
  'event_queue_position': ConversationEventQueuePositionToJSON(value.event_queue_position),
187
209
  'event_queue_status_update': ConversationWebchatQueueStatusToJSON(value.event_queue_status_update),
188
210
  'event_rrweb': ConversationEventRRWebToJSON(value.event_rrweb),
189
211
  'event_type': value.event_type,
212
+ 'event_typing': ConversationEventTypingToJSON(value.event_typing),
190
213
  'event_updated_message': ConversationMessageToJSON(value.event_updated_message),
191
214
  'message': ConversationMessageToJSON(value.message),
192
215
  'type': value.type,
@@ -0,0 +1,112 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface EmailCommseqSequenceTestRequest
20
+ */
21
+ export interface EmailCommseqSequenceTestRequest {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof EmailCommseqSequenceTestRequest
26
+ */
27
+ cart_id?: string;
28
+ /**
29
+ *
30
+ * @type {Array<string>}
31
+ * @memberof EmailCommseqSequenceTestRequest
32
+ */
33
+ cart_item_ids?: Array<string>;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof EmailCommseqSequenceTestRequest
38
+ */
39
+ esp_commseq_uuid?: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof EmailCommseqSequenceTestRequest
44
+ */
45
+ name?: string;
46
+ /**
47
+ *
48
+ * @type {string}
49
+ * @memberof EmailCommseqSequenceTestRequest
50
+ */
51
+ order_id?: string;
52
+ /**
53
+ *
54
+ * @type {boolean}
55
+ * @memberof EmailCommseqSequenceTestRequest
56
+ */
57
+ please_review?: boolean;
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof EmailCommseqSequenceTestRequest
62
+ */
63
+ send_to_email?: string;
64
+ /**
65
+ *
66
+ * @type {boolean}
67
+ * @memberof EmailCommseqSequenceTestRequest
68
+ */
69
+ send_to_logged_in_user?: boolean;
70
+ }
71
+
72
+ export function EmailCommseqSequenceTestRequestFromJSON(json: any): EmailCommseqSequenceTestRequest {
73
+ return EmailCommseqSequenceTestRequestFromJSONTyped(json, false);
74
+ }
75
+
76
+ export function EmailCommseqSequenceTestRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailCommseqSequenceTestRequest {
77
+ if ((json === undefined) || (json === null)) {
78
+ return json;
79
+ }
80
+ return {
81
+
82
+ 'cart_id': !exists(json, 'cart_id') ? undefined : json['cart_id'],
83
+ 'cart_item_ids': !exists(json, 'cart_item_ids') ? undefined : json['cart_item_ids'],
84
+ 'esp_commseq_uuid': !exists(json, 'esp_commseq_uuid') ? undefined : json['esp_commseq_uuid'],
85
+ 'name': !exists(json, 'name') ? undefined : json['name'],
86
+ 'order_id': !exists(json, 'order_id') ? undefined : json['order_id'],
87
+ 'please_review': !exists(json, 'please_review') ? undefined : json['please_review'],
88
+ 'send_to_email': !exists(json, 'send_to_email') ? undefined : json['send_to_email'],
89
+ 'send_to_logged_in_user': !exists(json, 'send_to_logged_in_user') ? undefined : json['send_to_logged_in_user'],
90
+ };
91
+ }
92
+
93
+ export function EmailCommseqSequenceTestRequestToJSON(value?: EmailCommseqSequenceTestRequest | null): any {
94
+ if (value === undefined) {
95
+ return undefined;
96
+ }
97
+ if (value === null) {
98
+ return null;
99
+ }
100
+ return {
101
+
102
+ 'cart_id': value.cart_id,
103
+ 'cart_item_ids': value.cart_item_ids,
104
+ 'esp_commseq_uuid': value.esp_commseq_uuid,
105
+ 'name': value.name,
106
+ 'order_id': value.order_id,
107
+ 'please_review': value.please_review,
108
+ 'send_to_email': value.send_to_email,
109
+ 'send_to_logged_in_user': value.send_to_logged_in_user,
110
+ };
111
+ }
112
+
@@ -0,0 +1,99 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ import {
17
+ ModelError,
18
+ ModelErrorFromJSON,
19
+ ModelErrorFromJSONTyped,
20
+ ModelErrorToJSON,
21
+ } from './ModelError';
22
+ import {
23
+ ResponseMetadata,
24
+ ResponseMetadataFromJSON,
25
+ ResponseMetadataFromJSONTyped,
26
+ ResponseMetadataToJSON,
27
+ } from './ResponseMetadata';
28
+ import {
29
+ Warning,
30
+ WarningFromJSON,
31
+ WarningFromJSONTyped,
32
+ WarningToJSON,
33
+ } from './Warning';
34
+
35
+ /**
36
+ *
37
+ * @export
38
+ * @interface EmailCommseqSequenceTestResponse
39
+ */
40
+ export interface EmailCommseqSequenceTestResponse {
41
+ /**
42
+ *
43
+ * @type {ModelError}
44
+ * @memberof EmailCommseqSequenceTestResponse
45
+ */
46
+ error?: ModelError;
47
+ /**
48
+ *
49
+ * @type {ResponseMetadata}
50
+ * @memberof EmailCommseqSequenceTestResponse
51
+ */
52
+ metadata?: ResponseMetadata;
53
+ /**
54
+ * Indicates if API call was successful
55
+ * @type {boolean}
56
+ * @memberof EmailCommseqSequenceTestResponse
57
+ */
58
+ success?: boolean;
59
+ /**
60
+ *
61
+ * @type {Warning}
62
+ * @memberof EmailCommseqSequenceTestResponse
63
+ */
64
+ warning?: Warning;
65
+ }
66
+
67
+ export function EmailCommseqSequenceTestResponseFromJSON(json: any): EmailCommseqSequenceTestResponse {
68
+ return EmailCommseqSequenceTestResponseFromJSONTyped(json, false);
69
+ }
70
+
71
+ export function EmailCommseqSequenceTestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailCommseqSequenceTestResponse {
72
+ if ((json === undefined) || (json === null)) {
73
+ return json;
74
+ }
75
+ return {
76
+
77
+ 'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
78
+ 'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
79
+ 'success': !exists(json, 'success') ? undefined : json['success'],
80
+ 'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
81
+ };
82
+ }
83
+
84
+ export function EmailCommseqSequenceTestResponseToJSON(value?: EmailCommseqSequenceTestResponse | null): any {
85
+ if (value === undefined) {
86
+ return undefined;
87
+ }
88
+ if (value === null) {
89
+ return null;
90
+ }
91
+ return {
92
+
93
+ 'error': ModelErrorToJSON(value.error),
94
+ 'metadata': ResponseMetadataToJSON(value.metadata),
95
+ 'success': value.success,
96
+ 'warning': WarningToJSON(value.warning),
97
+ };
98
+ }
99
+
@@ -122,6 +122,7 @@ export * from './ConversationAgentAuth';
122
122
  export * from './ConversationAgentAuthResponse';
123
123
  export * from './ConversationEventQueuePosition';
124
124
  export * from './ConversationEventRRWeb';
125
+ export * from './ConversationEventTyping';
125
126
  export * from './ConversationMessage';
126
127
  export * from './ConversationMessageTransportStatus';
127
128
  export * from './ConversationMultimediaUploadUrl';
@@ -260,6 +261,8 @@ export * from './EmailCommseqPostcardSendTestResponse';
260
261
  export * from './EmailCommseqPostcardsRequest';
261
262
  export * from './EmailCommseqPostcardsResponse';
262
263
  export * from './EmailCommseqResponse';
264
+ export * from './EmailCommseqSequenceTestRequest';
265
+ export * from './EmailCommseqSequenceTestResponse';
263
266
  export * from './EmailCommseqStat';
264
267
  export * from './EmailCommseqStatResponse';
265
268
  export * from './EmailCommseqStep';