ultracart_rest_api_v2_typescript 4.0.62-RC → 4.0.63-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.
- package/.openapi-generator/FILES +2 -0
- package/README.md +3 -2
- package/dist/apis/StorefrontApi.d.ts +27 -1
- package/dist/apis/StorefrontApi.js +63 -0
- package/dist/models/EmailPostcardTracking.d.ts +171 -0
- package/dist/models/EmailPostcardTracking.js +90 -0
- package/dist/models/EmailPostcardTrackingResponse.d.ts +55 -0
- package/dist/models/EmailPostcardTrackingResponse.js +54 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
- package/src/apis/StorefrontApi.ts +71 -0
- package/src/models/EmailPostcardTracking.ts +248 -0
- package/src/models/EmailPostcardTrackingResponse.ts +113 -0
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -342,6 +342,8 @@ src/models/EmailPlan.ts
|
|
|
342
342
|
src/models/EmailPlanAdditional.ts
|
|
343
343
|
src/models/EmailPlanResponse.ts
|
|
344
344
|
src/models/EmailPostcardStat.ts
|
|
345
|
+
src/models/EmailPostcardTracking.ts
|
|
346
|
+
src/models/EmailPostcardTrackingResponse.ts
|
|
345
347
|
src/models/EmailSegment.ts
|
|
346
348
|
src/models/EmailSegmentArchiveResponse.ts
|
|
347
349
|
src/models/EmailSegmentCustomer.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.0.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@4.0.63-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.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@4.0.63-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.63-RC | 09/13/2022 | storefront comms - postcard tracking |
|
|
57
58
|
| 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
|
|
58
59
|
| 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
|
|
59
60
|
| 4.0.60-RC | 09/02/2022 | customer editor added loyal ledger descriptions |
|
|
@@ -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, 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, RulerValidationRequest, RulerValidationResponse, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontsResponse, 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, EmailPostcardTrackingResponse, 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, RulerValidationRequest, RulerValidationResponse, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
|
|
14
14
|
export interface AddToLibraryRequest {
|
|
15
15
|
addLibraryRequest: AddLibraryItemRequest;
|
|
16
16
|
}
|
|
@@ -163,6 +163,10 @@ export interface GetEmailCommseqPostcardStatsRequest {
|
|
|
163
163
|
commseqUuid: string;
|
|
164
164
|
statsRequest: EmailStatPostcardSummaryRequest;
|
|
165
165
|
}
|
|
166
|
+
export interface GetEmailCommseqPostcardTrackingRequest {
|
|
167
|
+
storefrontOid: number;
|
|
168
|
+
commseqPostcardUuid: string;
|
|
169
|
+
}
|
|
166
170
|
export interface GetEmailCommseqStatOverallRequest {
|
|
167
171
|
storefrontOid: number;
|
|
168
172
|
commseqUuid: string;
|
|
@@ -1244,6 +1248,20 @@ export interface StorefrontApiInterface {
|
|
|
1244
1248
|
* Get email communication sequence postcard stats
|
|
1245
1249
|
*/
|
|
1246
1250
|
getEmailCommseqPostcardStats(requestParameters: GetEmailCommseqPostcardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatPostcardSummaryResponse>;
|
|
1251
|
+
/**
|
|
1252
|
+
*
|
|
1253
|
+
* @summary Get email communication postcard tracking
|
|
1254
|
+
* @param {number} storefrontOid
|
|
1255
|
+
* @param {string} commseqPostcardUuid
|
|
1256
|
+
* @param {*} [options] Override http request option.
|
|
1257
|
+
* @throws {RequiredError}
|
|
1258
|
+
* @memberof StorefrontApiInterface
|
|
1259
|
+
*/
|
|
1260
|
+
getEmailCommseqPostcardTrackingRaw(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailPostcardTrackingResponse>>;
|
|
1261
|
+
/**
|
|
1262
|
+
* Get email communication postcard tracking
|
|
1263
|
+
*/
|
|
1264
|
+
getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
|
|
1247
1265
|
/**
|
|
1248
1266
|
*
|
|
1249
1267
|
* @summary Get communication sequence stats overall
|
|
@@ -3375,6 +3393,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
|
|
|
3375
3393
|
* Get email communication sequence postcard stats
|
|
3376
3394
|
*/
|
|
3377
3395
|
getEmailCommseqPostcardStats(requestParameters: GetEmailCommseqPostcardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatPostcardSummaryResponse>;
|
|
3396
|
+
/**
|
|
3397
|
+
* Get email communication postcard tracking
|
|
3398
|
+
*/
|
|
3399
|
+
getEmailCommseqPostcardTrackingRaw(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailPostcardTrackingResponse>>;
|
|
3400
|
+
/**
|
|
3401
|
+
* Get email communication postcard tracking
|
|
3402
|
+
*/
|
|
3403
|
+
getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
|
|
3378
3404
|
/**
|
|
3379
3405
|
* Get communication sequence stats overall
|
|
3380
3406
|
*/
|
|
@@ -2577,6 +2577,69 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
2577
2577
|
});
|
|
2578
2578
|
});
|
|
2579
2579
|
};
|
|
2580
|
+
/**
|
|
2581
|
+
* Get email communication postcard tracking
|
|
2582
|
+
*/
|
|
2583
|
+
StorefrontApi.prototype.getEmailCommseqPostcardTrackingRaw = function (requestParameters, initOverrides) {
|
|
2584
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2585
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
2586
|
+
return __generator(this, function (_c) {
|
|
2587
|
+
switch (_c.label) {
|
|
2588
|
+
case 0:
|
|
2589
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
2590
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqPostcardTracking.');
|
|
2591
|
+
}
|
|
2592
|
+
if (requestParameters.commseqPostcardUuid === null || requestParameters.commseqPostcardUuid === undefined) {
|
|
2593
|
+
throw new runtime.RequiredError('commseqPostcardUuid', 'Required parameter requestParameters.commseqPostcardUuid was null or undefined when calling getEmailCommseqPostcardTracking.');
|
|
2594
|
+
}
|
|
2595
|
+
queryParameters = {};
|
|
2596
|
+
headerParameters = {};
|
|
2597
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2598
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
2599
|
+
}
|
|
2600
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
2601
|
+
// oauth required
|
|
2602
|
+
_a = headerParameters;
|
|
2603
|
+
_b = "Authorization";
|
|
2604
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
|
|
2605
|
+
case 1:
|
|
2606
|
+
// oauth required
|
|
2607
|
+
_a[_b] = _c.sent();
|
|
2608
|
+
_c.label = 2;
|
|
2609
|
+
case 2:
|
|
2610
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2611
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
2612
|
+
}
|
|
2613
|
+
return [4 /*yield*/, this.request({
|
|
2614
|
+
path: "/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_postcard_uuid", "}"), encodeURIComponent(String(requestParameters.commseqPostcardUuid))),
|
|
2615
|
+
method: 'GET',
|
|
2616
|
+
headers: headerParameters,
|
|
2617
|
+
query: queryParameters,
|
|
2618
|
+
}, initOverrides)];
|
|
2619
|
+
case 3:
|
|
2620
|
+
response = _c.sent();
|
|
2621
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailPostcardTrackingResponseFromJSON)(jsonValue); })];
|
|
2622
|
+
}
|
|
2623
|
+
});
|
|
2624
|
+
});
|
|
2625
|
+
};
|
|
2626
|
+
/**
|
|
2627
|
+
* Get email communication postcard tracking
|
|
2628
|
+
*/
|
|
2629
|
+
StorefrontApi.prototype.getEmailCommseqPostcardTracking = function (requestParameters, initOverrides) {
|
|
2630
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2631
|
+
var response;
|
|
2632
|
+
return __generator(this, function (_a) {
|
|
2633
|
+
switch (_a.label) {
|
|
2634
|
+
case 0: return [4 /*yield*/, this.getEmailCommseqPostcardTrackingRaw(requestParameters, initOverrides)];
|
|
2635
|
+
case 1:
|
|
2636
|
+
response = _a.sent();
|
|
2637
|
+
return [4 /*yield*/, response.value()];
|
|
2638
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
2639
|
+
}
|
|
2640
|
+
});
|
|
2641
|
+
});
|
|
2642
|
+
};
|
|
2580
2643
|
/**
|
|
2581
2644
|
* Get communication sequence stats overall
|
|
2582
2645
|
*/
|
|
@@ -0,0 +1,171 @@
|
|
|
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 EmailPostcardTracking
|
|
16
|
+
*/
|
|
17
|
+
export interface EmailPostcardTracking {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof EmailPostcardTracking
|
|
22
|
+
*/
|
|
23
|
+
commseq_postcard_uuid?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof EmailPostcardTracking
|
|
28
|
+
*/
|
|
29
|
+
commseq_step_uuid?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof EmailPostcardTracking
|
|
34
|
+
*/
|
|
35
|
+
commseq_uuid?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Conversion date time.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof EmailPostcardTracking
|
|
40
|
+
*/
|
|
41
|
+
conversion_dts?: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof EmailPostcardTracking
|
|
46
|
+
*/
|
|
47
|
+
cost?: number;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof EmailPostcardTracking
|
|
52
|
+
*/
|
|
53
|
+
customer_uuid?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Delivered date time.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof EmailPostcardTracking
|
|
58
|
+
*/
|
|
59
|
+
delivered_dts?: string;
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof EmailPostcardTracking
|
|
64
|
+
*/
|
|
65
|
+
from_address_line1?: string;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof EmailPostcardTracking
|
|
70
|
+
*/
|
|
71
|
+
from_address_line2?: string;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof EmailPostcardTracking
|
|
76
|
+
*/
|
|
77
|
+
from_city?: string;
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof EmailPostcardTracking
|
|
82
|
+
*/
|
|
83
|
+
from_name?: string;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof EmailPostcardTracking
|
|
88
|
+
*/
|
|
89
|
+
from_state?: string;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof EmailPostcardTracking
|
|
94
|
+
*/
|
|
95
|
+
from_zip?: string;
|
|
96
|
+
/**
|
|
97
|
+
* Mailed date time.
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof EmailPostcardTracking
|
|
100
|
+
*/
|
|
101
|
+
mailed_dts?: string;
|
|
102
|
+
/**
|
|
103
|
+
*
|
|
104
|
+
* @type {string}
|
|
105
|
+
* @memberof EmailPostcardTracking
|
|
106
|
+
*/
|
|
107
|
+
order_id?: string;
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @type {string}
|
|
111
|
+
* @memberof EmailPostcardTracking
|
|
112
|
+
*/
|
|
113
|
+
postcard_tracking_uuid?: string;
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @type {string}
|
|
117
|
+
* @memberof EmailPostcardTracking
|
|
118
|
+
*/
|
|
119
|
+
status?: string;
|
|
120
|
+
/**
|
|
121
|
+
* Submit date time.
|
|
122
|
+
* @type {string}
|
|
123
|
+
* @memberof EmailPostcardTracking
|
|
124
|
+
*/
|
|
125
|
+
submit_dts?: string;
|
|
126
|
+
/**
|
|
127
|
+
*
|
|
128
|
+
* @type {string}
|
|
129
|
+
* @memberof EmailPostcardTracking
|
|
130
|
+
*/
|
|
131
|
+
to_address_line1?: string;
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
* @type {string}
|
|
135
|
+
* @memberof EmailPostcardTracking
|
|
136
|
+
*/
|
|
137
|
+
to_address_line2?: string;
|
|
138
|
+
/**
|
|
139
|
+
*
|
|
140
|
+
* @type {string}
|
|
141
|
+
* @memberof EmailPostcardTracking
|
|
142
|
+
*/
|
|
143
|
+
to_city?: string;
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof EmailPostcardTracking
|
|
148
|
+
*/
|
|
149
|
+
to_name?: string;
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
* @type {string}
|
|
153
|
+
* @memberof EmailPostcardTracking
|
|
154
|
+
*/
|
|
155
|
+
to_state?: string;
|
|
156
|
+
/**
|
|
157
|
+
*
|
|
158
|
+
* @type {string}
|
|
159
|
+
* @memberof EmailPostcardTracking
|
|
160
|
+
*/
|
|
161
|
+
to_zip?: string;
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @type {string}
|
|
165
|
+
* @memberof EmailPostcardTracking
|
|
166
|
+
*/
|
|
167
|
+
tracking_description?: string;
|
|
168
|
+
}
|
|
169
|
+
export declare function EmailPostcardTrackingFromJSON(json: any): EmailPostcardTracking;
|
|
170
|
+
export declare function EmailPostcardTrackingFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailPostcardTracking;
|
|
171
|
+
export declare function EmailPostcardTrackingToJSON(value?: EmailPostcardTracking | null): any;
|
|
@@ -0,0 +1,90 @@
|
|
|
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.EmailPostcardTrackingToJSON = exports.EmailPostcardTrackingFromJSONTyped = exports.EmailPostcardTrackingFromJSON = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
function EmailPostcardTrackingFromJSON(json) {
|
|
19
|
+
return EmailPostcardTrackingFromJSONTyped(json, false);
|
|
20
|
+
}
|
|
21
|
+
exports.EmailPostcardTrackingFromJSON = EmailPostcardTrackingFromJSON;
|
|
22
|
+
function EmailPostcardTrackingFromJSONTyped(json, ignoreDiscriminator) {
|
|
23
|
+
if ((json === undefined) || (json === null)) {
|
|
24
|
+
return json;
|
|
25
|
+
}
|
|
26
|
+
return {
|
|
27
|
+
'commseq_postcard_uuid': !(0, runtime_1.exists)(json, 'commseq_postcard_uuid') ? undefined : json['commseq_postcard_uuid'],
|
|
28
|
+
'commseq_step_uuid': !(0, runtime_1.exists)(json, 'commseq_step_uuid') ? undefined : json['commseq_step_uuid'],
|
|
29
|
+
'commseq_uuid': !(0, runtime_1.exists)(json, 'commseq_uuid') ? undefined : json['commseq_uuid'],
|
|
30
|
+
'conversion_dts': !(0, runtime_1.exists)(json, 'conversion_dts') ? undefined : json['conversion_dts'],
|
|
31
|
+
'cost': !(0, runtime_1.exists)(json, 'cost') ? undefined : json['cost'],
|
|
32
|
+
'customer_uuid': !(0, runtime_1.exists)(json, 'customer_uuid') ? undefined : json['customer_uuid'],
|
|
33
|
+
'delivered_dts': !(0, runtime_1.exists)(json, 'delivered_dts') ? undefined : json['delivered_dts'],
|
|
34
|
+
'from_address_line1': !(0, runtime_1.exists)(json, 'from_address_line1') ? undefined : json['from_address_line1'],
|
|
35
|
+
'from_address_line2': !(0, runtime_1.exists)(json, 'from_address_line2') ? undefined : json['from_address_line2'],
|
|
36
|
+
'from_city': !(0, runtime_1.exists)(json, 'from_city') ? undefined : json['from_city'],
|
|
37
|
+
'from_name': !(0, runtime_1.exists)(json, 'from_name') ? undefined : json['from_name'],
|
|
38
|
+
'from_state': !(0, runtime_1.exists)(json, 'from_state') ? undefined : json['from_state'],
|
|
39
|
+
'from_zip': !(0, runtime_1.exists)(json, 'from_zip') ? undefined : json['from_zip'],
|
|
40
|
+
'mailed_dts': !(0, runtime_1.exists)(json, 'mailed_dts') ? undefined : json['mailed_dts'],
|
|
41
|
+
'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
|
|
42
|
+
'postcard_tracking_uuid': !(0, runtime_1.exists)(json, 'postcard_tracking_uuid') ? undefined : json['postcard_tracking_uuid'],
|
|
43
|
+
'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
|
|
44
|
+
'submit_dts': !(0, runtime_1.exists)(json, 'submit_dts') ? undefined : json['submit_dts'],
|
|
45
|
+
'to_address_line1': !(0, runtime_1.exists)(json, 'to_address_line1') ? undefined : json['to_address_line1'],
|
|
46
|
+
'to_address_line2': !(0, runtime_1.exists)(json, 'to_address_line2') ? undefined : json['to_address_line2'],
|
|
47
|
+
'to_city': !(0, runtime_1.exists)(json, 'to_city') ? undefined : json['to_city'],
|
|
48
|
+
'to_name': !(0, runtime_1.exists)(json, 'to_name') ? undefined : json['to_name'],
|
|
49
|
+
'to_state': !(0, runtime_1.exists)(json, 'to_state') ? undefined : json['to_state'],
|
|
50
|
+
'to_zip': !(0, runtime_1.exists)(json, 'to_zip') ? undefined : json['to_zip'],
|
|
51
|
+
'tracking_description': !(0, runtime_1.exists)(json, 'tracking_description') ? undefined : json['tracking_description'],
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
exports.EmailPostcardTrackingFromJSONTyped = EmailPostcardTrackingFromJSONTyped;
|
|
55
|
+
function EmailPostcardTrackingToJSON(value) {
|
|
56
|
+
if (value === undefined) {
|
|
57
|
+
return undefined;
|
|
58
|
+
}
|
|
59
|
+
if (value === null) {
|
|
60
|
+
return null;
|
|
61
|
+
}
|
|
62
|
+
return {
|
|
63
|
+
'commseq_postcard_uuid': value.commseq_postcard_uuid,
|
|
64
|
+
'commseq_step_uuid': value.commseq_step_uuid,
|
|
65
|
+
'commseq_uuid': value.commseq_uuid,
|
|
66
|
+
'conversion_dts': value.conversion_dts,
|
|
67
|
+
'cost': value.cost,
|
|
68
|
+
'customer_uuid': value.customer_uuid,
|
|
69
|
+
'delivered_dts': value.delivered_dts,
|
|
70
|
+
'from_address_line1': value.from_address_line1,
|
|
71
|
+
'from_address_line2': value.from_address_line2,
|
|
72
|
+
'from_city': value.from_city,
|
|
73
|
+
'from_name': value.from_name,
|
|
74
|
+
'from_state': value.from_state,
|
|
75
|
+
'from_zip': value.from_zip,
|
|
76
|
+
'mailed_dts': value.mailed_dts,
|
|
77
|
+
'order_id': value.order_id,
|
|
78
|
+
'postcard_tracking_uuid': value.postcard_tracking_uuid,
|
|
79
|
+
'status': value.status,
|
|
80
|
+
'submit_dts': value.submit_dts,
|
|
81
|
+
'to_address_line1': value.to_address_line1,
|
|
82
|
+
'to_address_line2': value.to_address_line2,
|
|
83
|
+
'to_city': value.to_city,
|
|
84
|
+
'to_name': value.to_name,
|
|
85
|
+
'to_state': value.to_state,
|
|
86
|
+
'to_zip': value.to_zip,
|
|
87
|
+
'tracking_description': value.tracking_description,
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
exports.EmailPostcardTrackingToJSON = EmailPostcardTrackingToJSON;
|
|
@@ -0,0 +1,55 @@
|
|
|
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 { EmailPostcardTracking } from './EmailPostcardTracking';
|
|
13
|
+
import { ModelError } from './ModelError';
|
|
14
|
+
import { ResponseMetadata } from './ResponseMetadata';
|
|
15
|
+
import { Warning } from './Warning';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface EmailPostcardTrackingResponse
|
|
20
|
+
*/
|
|
21
|
+
export interface EmailPostcardTrackingResponse {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {ModelError}
|
|
25
|
+
* @memberof EmailPostcardTrackingResponse
|
|
26
|
+
*/
|
|
27
|
+
error?: ModelError;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {ResponseMetadata}
|
|
31
|
+
* @memberof EmailPostcardTrackingResponse
|
|
32
|
+
*/
|
|
33
|
+
metadata?: ResponseMetadata;
|
|
34
|
+
/**
|
|
35
|
+
* Indicates if API call was successful
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
* @memberof EmailPostcardTrackingResponse
|
|
38
|
+
*/
|
|
39
|
+
success?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {EmailPostcardTracking}
|
|
43
|
+
* @memberof EmailPostcardTrackingResponse
|
|
44
|
+
*/
|
|
45
|
+
tracking?: EmailPostcardTracking;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {Warning}
|
|
49
|
+
* @memberof EmailPostcardTrackingResponse
|
|
50
|
+
*/
|
|
51
|
+
warning?: Warning;
|
|
52
|
+
}
|
|
53
|
+
export declare function EmailPostcardTrackingResponseFromJSON(json: any): EmailPostcardTrackingResponse;
|
|
54
|
+
export declare function EmailPostcardTrackingResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailPostcardTrackingResponse;
|
|
55
|
+
export declare function EmailPostcardTrackingResponseToJSON(value?: EmailPostcardTrackingResponse | null): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
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.EmailPostcardTrackingResponseToJSON = exports.EmailPostcardTrackingResponseFromJSONTyped = exports.EmailPostcardTrackingResponseFromJSON = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var EmailPostcardTracking_1 = require("./EmailPostcardTracking");
|
|
19
|
+
var ModelError_1 = require("./ModelError");
|
|
20
|
+
var ResponseMetadata_1 = require("./ResponseMetadata");
|
|
21
|
+
var Warning_1 = require("./Warning");
|
|
22
|
+
function EmailPostcardTrackingResponseFromJSON(json) {
|
|
23
|
+
return EmailPostcardTrackingResponseFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
exports.EmailPostcardTrackingResponseFromJSON = EmailPostcardTrackingResponseFromJSON;
|
|
26
|
+
function EmailPostcardTrackingResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
27
|
+
if ((json === undefined) || (json === null)) {
|
|
28
|
+
return json;
|
|
29
|
+
}
|
|
30
|
+
return {
|
|
31
|
+
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
32
|
+
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
33
|
+
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
34
|
+
'tracking': !(0, runtime_1.exists)(json, 'tracking') ? undefined : (0, EmailPostcardTracking_1.EmailPostcardTrackingFromJSON)(json['tracking']),
|
|
35
|
+
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
exports.EmailPostcardTrackingResponseFromJSONTyped = EmailPostcardTrackingResponseFromJSONTyped;
|
|
39
|
+
function EmailPostcardTrackingResponseToJSON(value) {
|
|
40
|
+
if (value === undefined) {
|
|
41
|
+
return undefined;
|
|
42
|
+
}
|
|
43
|
+
if (value === null) {
|
|
44
|
+
return null;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
48
|
+
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
49
|
+
'success': value.success,
|
|
50
|
+
'tracking': (0, EmailPostcardTracking_1.EmailPostcardTrackingToJSON)(value.tracking),
|
|
51
|
+
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
exports.EmailPostcardTrackingResponseToJSON = EmailPostcardTrackingResponseToJSON;
|
package/dist/models/index.d.ts
CHANGED
|
@@ -317,6 +317,8 @@ export * from './EmailPlan';
|
|
|
317
317
|
export * from './EmailPlanAdditional';
|
|
318
318
|
export * from './EmailPlanResponse';
|
|
319
319
|
export * from './EmailPostcardStat';
|
|
320
|
+
export * from './EmailPostcardTracking';
|
|
321
|
+
export * from './EmailPostcardTrackingResponse';
|
|
320
322
|
export * from './EmailSegment';
|
|
321
323
|
export * from './EmailSegmentArchiveResponse';
|
|
322
324
|
export * from './EmailSegmentCustomer';
|
package/dist/models/index.js
CHANGED
|
@@ -335,6 +335,8 @@ __exportStar(require("./EmailPlan"), exports);
|
|
|
335
335
|
__exportStar(require("./EmailPlanAdditional"), exports);
|
|
336
336
|
__exportStar(require("./EmailPlanResponse"), exports);
|
|
337
337
|
__exportStar(require("./EmailPostcardStat"), exports);
|
|
338
|
+
__exportStar(require("./EmailPostcardTracking"), exports);
|
|
339
|
+
__exportStar(require("./EmailPostcardTrackingResponse"), exports);
|
|
338
340
|
__exportStar(require("./EmailSegment"), exports);
|
|
339
341
|
__exportStar(require("./EmailSegmentArchiveResponse"), exports);
|
|
340
342
|
__exportStar(require("./EmailSegmentCustomer"), exports);
|
package/package.json
CHANGED
|
@@ -219,6 +219,9 @@ import {
|
|
|
219
219
|
EmailPlanResponse,
|
|
220
220
|
EmailPlanResponseFromJSON,
|
|
221
221
|
EmailPlanResponseToJSON,
|
|
222
|
+
EmailPostcardTrackingResponse,
|
|
223
|
+
EmailPostcardTrackingResponseFromJSON,
|
|
224
|
+
EmailPostcardTrackingResponseToJSON,
|
|
222
225
|
EmailSegment,
|
|
223
226
|
EmailSegmentFromJSON,
|
|
224
227
|
EmailSegmentToJSON,
|
|
@@ -614,6 +617,11 @@ export interface GetEmailCommseqPostcardStatsRequest {
|
|
|
614
617
|
statsRequest: EmailStatPostcardSummaryRequest;
|
|
615
618
|
}
|
|
616
619
|
|
|
620
|
+
export interface GetEmailCommseqPostcardTrackingRequest {
|
|
621
|
+
storefrontOid: number;
|
|
622
|
+
commseqPostcardUuid: string;
|
|
623
|
+
}
|
|
624
|
+
|
|
617
625
|
export interface GetEmailCommseqStatOverallRequest {
|
|
618
626
|
storefrontOid: number;
|
|
619
627
|
commseqUuid: string;
|
|
@@ -1895,6 +1903,22 @@ export interface StorefrontApiInterface {
|
|
|
1895
1903
|
*/
|
|
1896
1904
|
getEmailCommseqPostcardStats(requestParameters: GetEmailCommseqPostcardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatPostcardSummaryResponse>;
|
|
1897
1905
|
|
|
1906
|
+
/**
|
|
1907
|
+
*
|
|
1908
|
+
* @summary Get email communication postcard tracking
|
|
1909
|
+
* @param {number} storefrontOid
|
|
1910
|
+
* @param {string} commseqPostcardUuid
|
|
1911
|
+
* @param {*} [options] Override http request option.
|
|
1912
|
+
* @throws {RequiredError}
|
|
1913
|
+
* @memberof StorefrontApiInterface
|
|
1914
|
+
*/
|
|
1915
|
+
getEmailCommseqPostcardTrackingRaw(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailPostcardTrackingResponse>>;
|
|
1916
|
+
|
|
1917
|
+
/**
|
|
1918
|
+
* Get email communication postcard tracking
|
|
1919
|
+
*/
|
|
1920
|
+
getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
|
|
1921
|
+
|
|
1898
1922
|
/**
|
|
1899
1923
|
*
|
|
1900
1924
|
* @summary Get communication sequence stats overall
|
|
@@ -5818,6 +5842,53 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
|
|
|
5818
5842
|
return await response.value();
|
|
5819
5843
|
}
|
|
5820
5844
|
|
|
5845
|
+
/**
|
|
5846
|
+
* Get email communication postcard tracking
|
|
5847
|
+
*/
|
|
5848
|
+
async getEmailCommseqPostcardTrackingRaw(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailPostcardTrackingResponse>> {
|
|
5849
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
5850
|
+
throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqPostcardTracking.');
|
|
5851
|
+
}
|
|
5852
|
+
|
|
5853
|
+
if (requestParameters.commseqPostcardUuid === null || requestParameters.commseqPostcardUuid === undefined) {
|
|
5854
|
+
throw new runtime.RequiredError('commseqPostcardUuid','Required parameter requestParameters.commseqPostcardUuid was null or undefined when calling getEmailCommseqPostcardTracking.');
|
|
5855
|
+
}
|
|
5856
|
+
|
|
5857
|
+
const queryParameters: any = {};
|
|
5858
|
+
|
|
5859
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
5860
|
+
|
|
5861
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
5862
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
5863
|
+
}
|
|
5864
|
+
|
|
5865
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
5866
|
+
// oauth required
|
|
5867
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["storefront_read"]);
|
|
5868
|
+
}
|
|
5869
|
+
|
|
5870
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
5871
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
5872
|
+
}
|
|
5873
|
+
|
|
5874
|
+
const response = await this.request({
|
|
5875
|
+
path: `/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"commseq_postcard_uuid"}}`, encodeURIComponent(String(requestParameters.commseqPostcardUuid))),
|
|
5876
|
+
method: 'GET',
|
|
5877
|
+
headers: headerParameters,
|
|
5878
|
+
query: queryParameters,
|
|
5879
|
+
}, initOverrides);
|
|
5880
|
+
|
|
5881
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => EmailPostcardTrackingResponseFromJSON(jsonValue));
|
|
5882
|
+
}
|
|
5883
|
+
|
|
5884
|
+
/**
|
|
5885
|
+
* Get email communication postcard tracking
|
|
5886
|
+
*/
|
|
5887
|
+
async getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse> {
|
|
5888
|
+
const response = await this.getEmailCommseqPostcardTrackingRaw(requestParameters, initOverrides);
|
|
5889
|
+
return await response.value();
|
|
5890
|
+
}
|
|
5891
|
+
|
|
5821
5892
|
/**
|
|
5822
5893
|
* Get communication sequence stats overall
|
|
5823
5894
|
*/
|
|
@@ -0,0 +1,248 @@
|
|
|
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 EmailPostcardTracking
|
|
20
|
+
*/
|
|
21
|
+
export interface EmailPostcardTracking {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof EmailPostcardTracking
|
|
26
|
+
*/
|
|
27
|
+
commseq_postcard_uuid?: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof EmailPostcardTracking
|
|
32
|
+
*/
|
|
33
|
+
commseq_step_uuid?: string;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof EmailPostcardTracking
|
|
38
|
+
*/
|
|
39
|
+
commseq_uuid?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Conversion date time.
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof EmailPostcardTracking
|
|
44
|
+
*/
|
|
45
|
+
conversion_dts?: string;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {number}
|
|
49
|
+
* @memberof EmailPostcardTracking
|
|
50
|
+
*/
|
|
51
|
+
cost?: number;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof EmailPostcardTracking
|
|
56
|
+
*/
|
|
57
|
+
customer_uuid?: string;
|
|
58
|
+
/**
|
|
59
|
+
* Delivered date time.
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof EmailPostcardTracking
|
|
62
|
+
*/
|
|
63
|
+
delivered_dts?: string;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof EmailPostcardTracking
|
|
68
|
+
*/
|
|
69
|
+
from_address_line1?: string;
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @type {string}
|
|
73
|
+
* @memberof EmailPostcardTracking
|
|
74
|
+
*/
|
|
75
|
+
from_address_line2?: string;
|
|
76
|
+
/**
|
|
77
|
+
*
|
|
78
|
+
* @type {string}
|
|
79
|
+
* @memberof EmailPostcardTracking
|
|
80
|
+
*/
|
|
81
|
+
from_city?: string;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @type {string}
|
|
85
|
+
* @memberof EmailPostcardTracking
|
|
86
|
+
*/
|
|
87
|
+
from_name?: string;
|
|
88
|
+
/**
|
|
89
|
+
*
|
|
90
|
+
* @type {string}
|
|
91
|
+
* @memberof EmailPostcardTracking
|
|
92
|
+
*/
|
|
93
|
+
from_state?: string;
|
|
94
|
+
/**
|
|
95
|
+
*
|
|
96
|
+
* @type {string}
|
|
97
|
+
* @memberof EmailPostcardTracking
|
|
98
|
+
*/
|
|
99
|
+
from_zip?: string;
|
|
100
|
+
/**
|
|
101
|
+
* Mailed date time.
|
|
102
|
+
* @type {string}
|
|
103
|
+
* @memberof EmailPostcardTracking
|
|
104
|
+
*/
|
|
105
|
+
mailed_dts?: string;
|
|
106
|
+
/**
|
|
107
|
+
*
|
|
108
|
+
* @type {string}
|
|
109
|
+
* @memberof EmailPostcardTracking
|
|
110
|
+
*/
|
|
111
|
+
order_id?: string;
|
|
112
|
+
/**
|
|
113
|
+
*
|
|
114
|
+
* @type {string}
|
|
115
|
+
* @memberof EmailPostcardTracking
|
|
116
|
+
*/
|
|
117
|
+
postcard_tracking_uuid?: string;
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @type {string}
|
|
121
|
+
* @memberof EmailPostcardTracking
|
|
122
|
+
*/
|
|
123
|
+
status?: string;
|
|
124
|
+
/**
|
|
125
|
+
* Submit date time.
|
|
126
|
+
* @type {string}
|
|
127
|
+
* @memberof EmailPostcardTracking
|
|
128
|
+
*/
|
|
129
|
+
submit_dts?: string;
|
|
130
|
+
/**
|
|
131
|
+
*
|
|
132
|
+
* @type {string}
|
|
133
|
+
* @memberof EmailPostcardTracking
|
|
134
|
+
*/
|
|
135
|
+
to_address_line1?: string;
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
* @type {string}
|
|
139
|
+
* @memberof EmailPostcardTracking
|
|
140
|
+
*/
|
|
141
|
+
to_address_line2?: string;
|
|
142
|
+
/**
|
|
143
|
+
*
|
|
144
|
+
* @type {string}
|
|
145
|
+
* @memberof EmailPostcardTracking
|
|
146
|
+
*/
|
|
147
|
+
to_city?: string;
|
|
148
|
+
/**
|
|
149
|
+
*
|
|
150
|
+
* @type {string}
|
|
151
|
+
* @memberof EmailPostcardTracking
|
|
152
|
+
*/
|
|
153
|
+
to_name?: string;
|
|
154
|
+
/**
|
|
155
|
+
*
|
|
156
|
+
* @type {string}
|
|
157
|
+
* @memberof EmailPostcardTracking
|
|
158
|
+
*/
|
|
159
|
+
to_state?: string;
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @type {string}
|
|
163
|
+
* @memberof EmailPostcardTracking
|
|
164
|
+
*/
|
|
165
|
+
to_zip?: string;
|
|
166
|
+
/**
|
|
167
|
+
*
|
|
168
|
+
* @type {string}
|
|
169
|
+
* @memberof EmailPostcardTracking
|
|
170
|
+
*/
|
|
171
|
+
tracking_description?: string;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
export function EmailPostcardTrackingFromJSON(json: any): EmailPostcardTracking {
|
|
175
|
+
return EmailPostcardTrackingFromJSONTyped(json, false);
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
export function EmailPostcardTrackingFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailPostcardTracking {
|
|
179
|
+
if ((json === undefined) || (json === null)) {
|
|
180
|
+
return json;
|
|
181
|
+
}
|
|
182
|
+
return {
|
|
183
|
+
|
|
184
|
+
'commseq_postcard_uuid': !exists(json, 'commseq_postcard_uuid') ? undefined : json['commseq_postcard_uuid'],
|
|
185
|
+
'commseq_step_uuid': !exists(json, 'commseq_step_uuid') ? undefined : json['commseq_step_uuid'],
|
|
186
|
+
'commseq_uuid': !exists(json, 'commseq_uuid') ? undefined : json['commseq_uuid'],
|
|
187
|
+
'conversion_dts': !exists(json, 'conversion_dts') ? undefined : json['conversion_dts'],
|
|
188
|
+
'cost': !exists(json, 'cost') ? undefined : json['cost'],
|
|
189
|
+
'customer_uuid': !exists(json, 'customer_uuid') ? undefined : json['customer_uuid'],
|
|
190
|
+
'delivered_dts': !exists(json, 'delivered_dts') ? undefined : json['delivered_dts'],
|
|
191
|
+
'from_address_line1': !exists(json, 'from_address_line1') ? undefined : json['from_address_line1'],
|
|
192
|
+
'from_address_line2': !exists(json, 'from_address_line2') ? undefined : json['from_address_line2'],
|
|
193
|
+
'from_city': !exists(json, 'from_city') ? undefined : json['from_city'],
|
|
194
|
+
'from_name': !exists(json, 'from_name') ? undefined : json['from_name'],
|
|
195
|
+
'from_state': !exists(json, 'from_state') ? undefined : json['from_state'],
|
|
196
|
+
'from_zip': !exists(json, 'from_zip') ? undefined : json['from_zip'],
|
|
197
|
+
'mailed_dts': !exists(json, 'mailed_dts') ? undefined : json['mailed_dts'],
|
|
198
|
+
'order_id': !exists(json, 'order_id') ? undefined : json['order_id'],
|
|
199
|
+
'postcard_tracking_uuid': !exists(json, 'postcard_tracking_uuid') ? undefined : json['postcard_tracking_uuid'],
|
|
200
|
+
'status': !exists(json, 'status') ? undefined : json['status'],
|
|
201
|
+
'submit_dts': !exists(json, 'submit_dts') ? undefined : json['submit_dts'],
|
|
202
|
+
'to_address_line1': !exists(json, 'to_address_line1') ? undefined : json['to_address_line1'],
|
|
203
|
+
'to_address_line2': !exists(json, 'to_address_line2') ? undefined : json['to_address_line2'],
|
|
204
|
+
'to_city': !exists(json, 'to_city') ? undefined : json['to_city'],
|
|
205
|
+
'to_name': !exists(json, 'to_name') ? undefined : json['to_name'],
|
|
206
|
+
'to_state': !exists(json, 'to_state') ? undefined : json['to_state'],
|
|
207
|
+
'to_zip': !exists(json, 'to_zip') ? undefined : json['to_zip'],
|
|
208
|
+
'tracking_description': !exists(json, 'tracking_description') ? undefined : json['tracking_description'],
|
|
209
|
+
};
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
export function EmailPostcardTrackingToJSON(value?: EmailPostcardTracking | null): any {
|
|
213
|
+
if (value === undefined) {
|
|
214
|
+
return undefined;
|
|
215
|
+
}
|
|
216
|
+
if (value === null) {
|
|
217
|
+
return null;
|
|
218
|
+
}
|
|
219
|
+
return {
|
|
220
|
+
|
|
221
|
+
'commseq_postcard_uuid': value.commseq_postcard_uuid,
|
|
222
|
+
'commseq_step_uuid': value.commseq_step_uuid,
|
|
223
|
+
'commseq_uuid': value.commseq_uuid,
|
|
224
|
+
'conversion_dts': value.conversion_dts,
|
|
225
|
+
'cost': value.cost,
|
|
226
|
+
'customer_uuid': value.customer_uuid,
|
|
227
|
+
'delivered_dts': value.delivered_dts,
|
|
228
|
+
'from_address_line1': value.from_address_line1,
|
|
229
|
+
'from_address_line2': value.from_address_line2,
|
|
230
|
+
'from_city': value.from_city,
|
|
231
|
+
'from_name': value.from_name,
|
|
232
|
+
'from_state': value.from_state,
|
|
233
|
+
'from_zip': value.from_zip,
|
|
234
|
+
'mailed_dts': value.mailed_dts,
|
|
235
|
+
'order_id': value.order_id,
|
|
236
|
+
'postcard_tracking_uuid': value.postcard_tracking_uuid,
|
|
237
|
+
'status': value.status,
|
|
238
|
+
'submit_dts': value.submit_dts,
|
|
239
|
+
'to_address_line1': value.to_address_line1,
|
|
240
|
+
'to_address_line2': value.to_address_line2,
|
|
241
|
+
'to_city': value.to_city,
|
|
242
|
+
'to_name': value.to_name,
|
|
243
|
+
'to_state': value.to_state,
|
|
244
|
+
'to_zip': value.to_zip,
|
|
245
|
+
'tracking_description': value.tracking_description,
|
|
246
|
+
};
|
|
247
|
+
}
|
|
248
|
+
|
|
@@ -0,0 +1,113 @@
|
|
|
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
|
+
EmailPostcardTracking,
|
|
18
|
+
EmailPostcardTrackingFromJSON,
|
|
19
|
+
EmailPostcardTrackingFromJSONTyped,
|
|
20
|
+
EmailPostcardTrackingToJSON,
|
|
21
|
+
} from './EmailPostcardTracking';
|
|
22
|
+
import {
|
|
23
|
+
ModelError,
|
|
24
|
+
ModelErrorFromJSON,
|
|
25
|
+
ModelErrorFromJSONTyped,
|
|
26
|
+
ModelErrorToJSON,
|
|
27
|
+
} from './ModelError';
|
|
28
|
+
import {
|
|
29
|
+
ResponseMetadata,
|
|
30
|
+
ResponseMetadataFromJSON,
|
|
31
|
+
ResponseMetadataFromJSONTyped,
|
|
32
|
+
ResponseMetadataToJSON,
|
|
33
|
+
} from './ResponseMetadata';
|
|
34
|
+
import {
|
|
35
|
+
Warning,
|
|
36
|
+
WarningFromJSON,
|
|
37
|
+
WarningFromJSONTyped,
|
|
38
|
+
WarningToJSON,
|
|
39
|
+
} from './Warning';
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface EmailPostcardTrackingResponse
|
|
45
|
+
*/
|
|
46
|
+
export interface EmailPostcardTrackingResponse {
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {ModelError}
|
|
50
|
+
* @memberof EmailPostcardTrackingResponse
|
|
51
|
+
*/
|
|
52
|
+
error?: ModelError;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {ResponseMetadata}
|
|
56
|
+
* @memberof EmailPostcardTrackingResponse
|
|
57
|
+
*/
|
|
58
|
+
metadata?: ResponseMetadata;
|
|
59
|
+
/**
|
|
60
|
+
* Indicates if API call was successful
|
|
61
|
+
* @type {boolean}
|
|
62
|
+
* @memberof EmailPostcardTrackingResponse
|
|
63
|
+
*/
|
|
64
|
+
success?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {EmailPostcardTracking}
|
|
68
|
+
* @memberof EmailPostcardTrackingResponse
|
|
69
|
+
*/
|
|
70
|
+
tracking?: EmailPostcardTracking;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {Warning}
|
|
74
|
+
* @memberof EmailPostcardTrackingResponse
|
|
75
|
+
*/
|
|
76
|
+
warning?: Warning;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function EmailPostcardTrackingResponseFromJSON(json: any): EmailPostcardTrackingResponse {
|
|
80
|
+
return EmailPostcardTrackingResponseFromJSONTyped(json, false);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function EmailPostcardTrackingResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailPostcardTrackingResponse {
|
|
84
|
+
if ((json === undefined) || (json === null)) {
|
|
85
|
+
return json;
|
|
86
|
+
}
|
|
87
|
+
return {
|
|
88
|
+
|
|
89
|
+
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
90
|
+
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
91
|
+
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
92
|
+
'tracking': !exists(json, 'tracking') ? undefined : EmailPostcardTrackingFromJSON(json['tracking']),
|
|
93
|
+
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export function EmailPostcardTrackingResponseToJSON(value?: EmailPostcardTrackingResponse | null): any {
|
|
98
|
+
if (value === undefined) {
|
|
99
|
+
return undefined;
|
|
100
|
+
}
|
|
101
|
+
if (value === null) {
|
|
102
|
+
return null;
|
|
103
|
+
}
|
|
104
|
+
return {
|
|
105
|
+
|
|
106
|
+
'error': ModelErrorToJSON(value.error),
|
|
107
|
+
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
108
|
+
'success': value.success,
|
|
109
|
+
'tracking': EmailPostcardTrackingToJSON(value.tracking),
|
|
110
|
+
'warning': WarningToJSON(value.warning),
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -319,6 +319,8 @@ export * from './EmailPlan';
|
|
|
319
319
|
export * from './EmailPlanAdditional';
|
|
320
320
|
export * from './EmailPlanResponse';
|
|
321
321
|
export * from './EmailPostcardStat';
|
|
322
|
+
export * from './EmailPostcardTracking';
|
|
323
|
+
export * from './EmailPostcardTrackingResponse';
|
|
322
324
|
export * from './EmailSegment';
|
|
323
325
|
export * from './EmailSegmentArchiveResponse';
|
|
324
326
|
export * from './EmailSegmentCustomer';
|