ultracart_rest_api_v2_typescript 4.0.47-RC → 4.0.48-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.
@@ -283,6 +283,8 @@ src/models/EmailCommseqPostcardSendTestResponse.ts
283
283
  src/models/EmailCommseqPostcardsRequest.ts
284
284
  src/models/EmailCommseqPostcardsResponse.ts
285
285
  src/models/EmailCommseqResponse.ts
286
+ src/models/EmailCommseqSequenceTestRequest.ts
287
+ src/models/EmailCommseqSequenceTestResponse.ts
286
288
  src/models/EmailCommseqStat.ts
287
289
  src/models/EmailCommseqStatResponse.ts
288
290
  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.48-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.48-RC --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 4.0.48-RC | 08/02/2022 | storefront communication sequence test method |
57
58
  | 4.0.47-RC | 08/01/2022 | conversation event refinement |
58
59
  | 4.0.46-RC | 07/29/2022 | conversation development |
59
60
  | 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,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;
@@ -258,6 +258,8 @@ export * from './EmailCommseqPostcardSendTestResponse';
258
258
  export * from './EmailCommseqPostcardsRequest';
259
259
  export * from './EmailCommseqPostcardsResponse';
260
260
  export * from './EmailCommseqResponse';
261
+ export * from './EmailCommseqSequenceTestRequest';
262
+ export * from './EmailCommseqSequenceTestResponse';
261
263
  export * from './EmailCommseqStat';
262
264
  export * from './EmailCommseqStatResponse';
263
265
  export * from './EmailCommseqStep';
@@ -276,6 +276,8 @@ __exportStar(require("./EmailCommseqPostcardSendTestResponse"), exports);
276
276
  __exportStar(require("./EmailCommseqPostcardsRequest"), exports);
277
277
  __exportStar(require("./EmailCommseqPostcardsResponse"), exports);
278
278
  __exportStar(require("./EmailCommseqResponse"), exports);
279
+ __exportStar(require("./EmailCommseqSequenceTestRequest"), exports);
280
+ __exportStar(require("./EmailCommseqSequenceTestResponse"), exports);
279
281
  __exportStar(require("./EmailCommseqStat"), exports);
280
282
  __exportStar(require("./EmailCommseqStatResponse"), exports);
281
283
  __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.48-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,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
+
@@ -260,6 +260,8 @@ export * from './EmailCommseqPostcardSendTestResponse';
260
260
  export * from './EmailCommseqPostcardsRequest';
261
261
  export * from './EmailCommseqPostcardsResponse';
262
262
  export * from './EmailCommseqResponse';
263
+ export * from './EmailCommseqSequenceTestRequest';
264
+ export * from './EmailCommseqSequenceTestResponse';
263
265
  export * from './EmailCommseqStat';
264
266
  export * from './EmailCommseqStatResponse';
265
267
  export * from './EmailCommseqStep';