ultracart_rest_api_v2_typescript 4.0.200 → 4.0.201
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 +5 -0
- package/README.md +3 -2
- package/dist/apis/StorefrontApi.d.ts +59 -1
- package/dist/apis/StorefrontApi.js +137 -0
- package/dist/models/EmailSmsOrder.d.ts +46 -0
- package/dist/models/EmailSmsOrder.js +49 -0
- package/dist/models/EmailSmsOrdersResponse.d.ts +55 -0
- package/dist/models/EmailSmsOrdersResponse.js +54 -0
- package/dist/models/EmailSmsStat.d.ts +201 -0
- package/dist/models/EmailSmsStat.js +100 -0
- package/dist/models/EmailStatSmsSummaryRequest.d.ts +33 -0
- package/dist/models/EmailStatSmsSummaryRequest.js +44 -0
- package/dist/models/EmailStatSmsSummaryResponse.d.ts +55 -0
- package/dist/models/EmailStatSmsSummaryResponse.js +54 -0
- package/dist/models/PricingTier.d.ts +6 -0
- package/dist/models/PricingTier.js +2 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/package.json +1 -1
- package/src/apis/StorefrontApi.ts +166 -0
- package/src/models/EmailSmsOrder.ts +87 -0
- package/src/models/EmailSmsOrdersResponse.ts +113 -0
- package/src/models/EmailSmsStat.ts +288 -0
- package/src/models/EmailStatSmsSummaryRequest.ts +64 -0
- package/src/models/EmailStatSmsSummaryResponse.ts +113 -0
- package/src/models/PricingTier.ts +8 -0
- package/src/models/index.ts +5 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -415,9 +415,14 @@ src/models/EmailSendingDomainResponse.ts
|
|
|
415
415
|
src/models/EmailSendingDomainsResponse.ts
|
|
416
416
|
src/models/EmailSettings.ts
|
|
417
417
|
src/models/EmailSettingsResponse.ts
|
|
418
|
+
src/models/EmailSmsOrder.ts
|
|
419
|
+
src/models/EmailSmsOrdersResponse.ts
|
|
420
|
+
src/models/EmailSmsStat.ts
|
|
418
421
|
src/models/EmailStat.ts
|
|
419
422
|
src/models/EmailStatPostcardSummaryRequest.ts
|
|
420
423
|
src/models/EmailStatPostcardSummaryResponse.ts
|
|
424
|
+
src/models/EmailStatSmsSummaryRequest.ts
|
|
425
|
+
src/models/EmailStatSmsSummaryResponse.ts
|
|
421
426
|
src/models/EmailStatSummaryRequest.ts
|
|
422
427
|
src/models/EmailStatSummaryResponse.ts
|
|
423
428
|
src/models/EmailStepStat.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.201
|
|
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.201 --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.201 | 02/27/2024 | esp - sms statistic layer |
|
|
57
58
|
| 4.0.200 | 02/20/2024 | Add tag support to CouponAmountOffItems, CouponBuyOneGetOneLimit, CouponDiscountItemWithItemPurchase, CouponFreeItemWithItemPurchase, CouponPercentOffItemsWithItemsPurchase |
|
|
58
59
|
| 4.0.199 | 01/16/2024 | order query - support searching by custom fields 8 through 10 |
|
|
59
60
|
| 4.0.198 | 01/12/2024 | workflow task - add properties array |
|
|
@@ -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, EmailCommseqSmsSendTestRequest, EmailCommseqSmsSendTestResponse, 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, FileManagerPageResponse, FileManagerUploadRequest, FileManagerUploadUrlResponse, 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, EmailCommseqSmsSendTestRequest, EmailCommseqSmsSendTestResponse, 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, EmailSmsOrdersResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSmsSummaryRequest, EmailStatSmsSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, FileManagerPageResponse, FileManagerUploadRequest, FileManagerUploadUrlResponse, 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
|
}
|
|
@@ -177,6 +177,11 @@ export interface GetEmailCommseqPostcardTrackingRequest {
|
|
|
177
177
|
storefrontOid: number;
|
|
178
178
|
commseqPostcardUuid: string;
|
|
179
179
|
}
|
|
180
|
+
export interface GetEmailCommseqSmsStatsRequest {
|
|
181
|
+
storefrontOid: number;
|
|
182
|
+
commseqUuid: string;
|
|
183
|
+
statsRequest: EmailStatSmsSummaryRequest;
|
|
184
|
+
}
|
|
180
185
|
export interface GetEmailCommseqStatOverallRequest {
|
|
181
186
|
storefrontOid: number;
|
|
182
187
|
commseqUuid: string;
|
|
@@ -338,6 +343,12 @@ export interface GetEmailSendingDomainStatusRequest {
|
|
|
338
343
|
export interface GetEmailSettingsRequest {
|
|
339
344
|
storefrontOid: number;
|
|
340
345
|
}
|
|
346
|
+
export interface GetEmailSmsOrdersRequest {
|
|
347
|
+
storefrontOid: number;
|
|
348
|
+
commseqUuid: string;
|
|
349
|
+
commseqStepUuid: string;
|
|
350
|
+
days?: number;
|
|
351
|
+
}
|
|
341
352
|
export interface GetEmailTemplateRequest {
|
|
342
353
|
storefrontOid: number;
|
|
343
354
|
emailTemplateOid: number;
|
|
@@ -1322,6 +1333,21 @@ export interface StorefrontApiInterface {
|
|
|
1322
1333
|
* Get email communication postcard tracking
|
|
1323
1334
|
*/
|
|
1324
1335
|
getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
|
|
1336
|
+
/**
|
|
1337
|
+
*
|
|
1338
|
+
* @summary Get email communication sequence sms stats
|
|
1339
|
+
* @param {number} storefrontOid
|
|
1340
|
+
* @param {string} commseqUuid
|
|
1341
|
+
* @param {EmailStatSmsSummaryRequest} statsRequest StatsRequest
|
|
1342
|
+
* @param {*} [options] Override http request option.
|
|
1343
|
+
* @throws {RequiredError}
|
|
1344
|
+
* @memberof StorefrontApiInterface
|
|
1345
|
+
*/
|
|
1346
|
+
getEmailCommseqSmsStatsRaw(requestParameters: GetEmailCommseqSmsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailStatSmsSummaryResponse>>;
|
|
1347
|
+
/**
|
|
1348
|
+
* Get email communication sequence sms stats
|
|
1349
|
+
*/
|
|
1350
|
+
getEmailCommseqSmsStats(requestParameters: GetEmailCommseqSmsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatSmsSummaryResponse>;
|
|
1325
1351
|
/**
|
|
1326
1352
|
*
|
|
1327
1353
|
* @summary Get communication sequence stats overall
|
|
@@ -1897,6 +1923,22 @@ export interface StorefrontApiInterface {
|
|
|
1897
1923
|
* Get email settings
|
|
1898
1924
|
*/
|
|
1899
1925
|
getEmailSettings(requestParameters: GetEmailSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSettingsResponse>;
|
|
1926
|
+
/**
|
|
1927
|
+
*
|
|
1928
|
+
* @summary Get email sms orders
|
|
1929
|
+
* @param {number} storefrontOid
|
|
1930
|
+
* @param {string} commseqUuid
|
|
1931
|
+
* @param {string} commseqStepUuid
|
|
1932
|
+
* @param {number} [days]
|
|
1933
|
+
* @param {*} [options] Override http request option.
|
|
1934
|
+
* @throws {RequiredError}
|
|
1935
|
+
* @memberof StorefrontApiInterface
|
|
1936
|
+
*/
|
|
1937
|
+
getEmailSmsOrdersRaw(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSmsOrdersResponse>>;
|
|
1938
|
+
/**
|
|
1939
|
+
* Get email sms orders
|
|
1940
|
+
*/
|
|
1941
|
+
getEmailSmsOrders(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSmsOrdersResponse>;
|
|
1900
1942
|
/**
|
|
1901
1943
|
*
|
|
1902
1944
|
* @summary Get email template
|
|
@@ -3537,6 +3579,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
|
|
|
3537
3579
|
* Get email communication postcard tracking
|
|
3538
3580
|
*/
|
|
3539
3581
|
getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
|
|
3582
|
+
/**
|
|
3583
|
+
* Get email communication sequence sms stats
|
|
3584
|
+
*/
|
|
3585
|
+
getEmailCommseqSmsStatsRaw(requestParameters: GetEmailCommseqSmsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailStatSmsSummaryResponse>>;
|
|
3586
|
+
/**
|
|
3587
|
+
* Get email communication sequence sms stats
|
|
3588
|
+
*/
|
|
3589
|
+
getEmailCommseqSmsStats(requestParameters: GetEmailCommseqSmsStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailStatSmsSummaryResponse>;
|
|
3540
3590
|
/**
|
|
3541
3591
|
* Get communication sequence stats overall
|
|
3542
3592
|
*/
|
|
@@ -3865,6 +3915,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
|
|
|
3865
3915
|
* Get email settings
|
|
3866
3916
|
*/
|
|
3867
3917
|
getEmailSettings(requestParameters: GetEmailSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSettingsResponse>;
|
|
3918
|
+
/**
|
|
3919
|
+
* Get email sms orders
|
|
3920
|
+
*/
|
|
3921
|
+
getEmailSmsOrdersRaw(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailSmsOrdersResponse>>;
|
|
3922
|
+
/**
|
|
3923
|
+
* Get email sms orders
|
|
3924
|
+
*/
|
|
3925
|
+
getEmailSmsOrders(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSmsOrdersResponse>;
|
|
3868
3926
|
/**
|
|
3869
3927
|
* Get email template
|
|
3870
3928
|
*/
|
|
@@ -2772,6 +2772,74 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
2772
2772
|
});
|
|
2773
2773
|
});
|
|
2774
2774
|
};
|
|
2775
|
+
/**
|
|
2776
|
+
* Get email communication sequence sms stats
|
|
2777
|
+
*/
|
|
2778
|
+
StorefrontApi.prototype.getEmailCommseqSmsStatsRaw = function (requestParameters, initOverrides) {
|
|
2779
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2780
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
2781
|
+
return __generator(this, function (_c) {
|
|
2782
|
+
switch (_c.label) {
|
|
2783
|
+
case 0:
|
|
2784
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
2785
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqSmsStats.');
|
|
2786
|
+
}
|
|
2787
|
+
if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
|
|
2788
|
+
throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling getEmailCommseqSmsStats.');
|
|
2789
|
+
}
|
|
2790
|
+
if (requestParameters.statsRequest === null || requestParameters.statsRequest === undefined) {
|
|
2791
|
+
throw new runtime.RequiredError('statsRequest', 'Required parameter requestParameters.statsRequest was null or undefined when calling getEmailCommseqSmsStats.');
|
|
2792
|
+
}
|
|
2793
|
+
queryParameters = {};
|
|
2794
|
+
headerParameters = {};
|
|
2795
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
2796
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2797
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
2798
|
+
}
|
|
2799
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
2800
|
+
// oauth required
|
|
2801
|
+
_a = headerParameters;
|
|
2802
|
+
_b = "Authorization";
|
|
2803
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
|
|
2804
|
+
case 1:
|
|
2805
|
+
// oauth required
|
|
2806
|
+
_a[_b] = _c.sent();
|
|
2807
|
+
_c.label = 2;
|
|
2808
|
+
case 2:
|
|
2809
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2810
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
2811
|
+
}
|
|
2812
|
+
return [4 /*yield*/, this.request({
|
|
2813
|
+
path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))),
|
|
2814
|
+
method: 'POST',
|
|
2815
|
+
headers: headerParameters,
|
|
2816
|
+
query: queryParameters,
|
|
2817
|
+
body: (0, models_1.EmailStatSmsSummaryRequestToJSON)(requestParameters.statsRequest),
|
|
2818
|
+
}, initOverrides)];
|
|
2819
|
+
case 3:
|
|
2820
|
+
response = _c.sent();
|
|
2821
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailStatSmsSummaryResponseFromJSON)(jsonValue); })];
|
|
2822
|
+
}
|
|
2823
|
+
});
|
|
2824
|
+
});
|
|
2825
|
+
};
|
|
2826
|
+
/**
|
|
2827
|
+
* Get email communication sequence sms stats
|
|
2828
|
+
*/
|
|
2829
|
+
StorefrontApi.prototype.getEmailCommseqSmsStats = function (requestParameters, initOverrides) {
|
|
2830
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2831
|
+
var response;
|
|
2832
|
+
return __generator(this, function (_a) {
|
|
2833
|
+
switch (_a.label) {
|
|
2834
|
+
case 0: return [4 /*yield*/, this.getEmailCommseqSmsStatsRaw(requestParameters, initOverrides)];
|
|
2835
|
+
case 1:
|
|
2836
|
+
response = _a.sent();
|
|
2837
|
+
return [4 /*yield*/, response.value()];
|
|
2838
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
2839
|
+
}
|
|
2840
|
+
});
|
|
2841
|
+
});
|
|
2842
|
+
};
|
|
2775
2843
|
/**
|
|
2776
2844
|
* Get communication sequence stats overall
|
|
2777
2845
|
*/
|
|
@@ -5366,6 +5434,75 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
5366
5434
|
});
|
|
5367
5435
|
});
|
|
5368
5436
|
};
|
|
5437
|
+
/**
|
|
5438
|
+
* Get email sms orders
|
|
5439
|
+
*/
|
|
5440
|
+
StorefrontApi.prototype.getEmailSmsOrdersRaw = function (requestParameters, initOverrides) {
|
|
5441
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5442
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
5443
|
+
return __generator(this, function (_c) {
|
|
5444
|
+
switch (_c.label) {
|
|
5445
|
+
case 0:
|
|
5446
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
5447
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailSmsOrders.');
|
|
5448
|
+
}
|
|
5449
|
+
if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
|
|
5450
|
+
throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling getEmailSmsOrders.');
|
|
5451
|
+
}
|
|
5452
|
+
if (requestParameters.commseqStepUuid === null || requestParameters.commseqStepUuid === undefined) {
|
|
5453
|
+
throw new runtime.RequiredError('commseqStepUuid', 'Required parameter requestParameters.commseqStepUuid was null or undefined when calling getEmailSmsOrders.');
|
|
5454
|
+
}
|
|
5455
|
+
queryParameters = {};
|
|
5456
|
+
if (requestParameters.days !== undefined) {
|
|
5457
|
+
queryParameters['days'] = requestParameters.days;
|
|
5458
|
+
}
|
|
5459
|
+
headerParameters = {};
|
|
5460
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
5461
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
5462
|
+
}
|
|
5463
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
5464
|
+
// oauth required
|
|
5465
|
+
_a = headerParameters;
|
|
5466
|
+
_b = "Authorization";
|
|
5467
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
|
|
5468
|
+
case 1:
|
|
5469
|
+
// oauth required
|
|
5470
|
+
_a[_b] = _c.sent();
|
|
5471
|
+
_c.label = 2;
|
|
5472
|
+
case 2:
|
|
5473
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
5474
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
5475
|
+
}
|
|
5476
|
+
return [4 /*yield*/, this.request({
|
|
5477
|
+
path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))).replace("{".concat("commseq_step_uuid", "}"), encodeURIComponent(String(requestParameters.commseqStepUuid))),
|
|
5478
|
+
method: 'GET',
|
|
5479
|
+
headers: headerParameters,
|
|
5480
|
+
query: queryParameters,
|
|
5481
|
+
}, initOverrides)];
|
|
5482
|
+
case 3:
|
|
5483
|
+
response = _c.sent();
|
|
5484
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailSmsOrdersResponseFromJSON)(jsonValue); })];
|
|
5485
|
+
}
|
|
5486
|
+
});
|
|
5487
|
+
});
|
|
5488
|
+
};
|
|
5489
|
+
/**
|
|
5490
|
+
* Get email sms orders
|
|
5491
|
+
*/
|
|
5492
|
+
StorefrontApi.prototype.getEmailSmsOrders = function (requestParameters, initOverrides) {
|
|
5493
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5494
|
+
var response;
|
|
5495
|
+
return __generator(this, function (_a) {
|
|
5496
|
+
switch (_a.label) {
|
|
5497
|
+
case 0: return [4 /*yield*/, this.getEmailSmsOrdersRaw(requestParameters, initOverrides)];
|
|
5498
|
+
case 1:
|
|
5499
|
+
response = _a.sent();
|
|
5500
|
+
return [4 /*yield*/, response.value()];
|
|
5501
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
5502
|
+
}
|
|
5503
|
+
});
|
|
5504
|
+
});
|
|
5505
|
+
};
|
|
5369
5506
|
/**
|
|
5370
5507
|
* Get email template
|
|
5371
5508
|
*/
|
|
@@ -0,0 +1,46 @@
|
|
|
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 { Currency } from './Currency';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface EmailSmsOrder
|
|
17
|
+
*/
|
|
18
|
+
export interface EmailSmsOrder {
|
|
19
|
+
/**
|
|
20
|
+
* email
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof EmailSmsOrder
|
|
23
|
+
*/
|
|
24
|
+
email?: string;
|
|
25
|
+
/**
|
|
26
|
+
* order_dts
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof EmailSmsOrder
|
|
29
|
+
*/
|
|
30
|
+
order_dts?: string;
|
|
31
|
+
/**
|
|
32
|
+
* order_id
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof EmailSmsOrder
|
|
35
|
+
*/
|
|
36
|
+
order_id?: string;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {Currency}
|
|
40
|
+
* @memberof EmailSmsOrder
|
|
41
|
+
*/
|
|
42
|
+
total?: Currency;
|
|
43
|
+
}
|
|
44
|
+
export declare function EmailSmsOrderFromJSON(json: any): EmailSmsOrder;
|
|
45
|
+
export declare function EmailSmsOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailSmsOrder;
|
|
46
|
+
export declare function EmailSmsOrderToJSON(value?: EmailSmsOrder | null): any;
|
|
@@ -0,0 +1,49 @@
|
|
|
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.EmailSmsOrderToJSON = exports.EmailSmsOrderFromJSONTyped = exports.EmailSmsOrderFromJSON = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var Currency_1 = require("./Currency");
|
|
19
|
+
function EmailSmsOrderFromJSON(json) {
|
|
20
|
+
return EmailSmsOrderFromJSONTyped(json, false);
|
|
21
|
+
}
|
|
22
|
+
exports.EmailSmsOrderFromJSON = EmailSmsOrderFromJSON;
|
|
23
|
+
function EmailSmsOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
24
|
+
if ((json === undefined) || (json === null)) {
|
|
25
|
+
return json;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
|
|
29
|
+
'order_dts': !(0, runtime_1.exists)(json, 'order_dts') ? undefined : json['order_dts'],
|
|
30
|
+
'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
|
|
31
|
+
'total': !(0, runtime_1.exists)(json, 'total') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['total']),
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
exports.EmailSmsOrderFromJSONTyped = EmailSmsOrderFromJSONTyped;
|
|
35
|
+
function EmailSmsOrderToJSON(value) {
|
|
36
|
+
if (value === undefined) {
|
|
37
|
+
return undefined;
|
|
38
|
+
}
|
|
39
|
+
if (value === null) {
|
|
40
|
+
return null;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'email': value.email,
|
|
44
|
+
'order_dts': value.order_dts,
|
|
45
|
+
'order_id': value.order_id,
|
|
46
|
+
'total': (0, Currency_1.CurrencyToJSON)(value.total),
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
exports.EmailSmsOrderToJSON = EmailSmsOrderToJSON;
|
|
@@ -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 { EmailSmsOrder } from './EmailSmsOrder';
|
|
13
|
+
import { ModelError } from './ModelError';
|
|
14
|
+
import { ResponseMetadata } from './ResponseMetadata';
|
|
15
|
+
import { Warning } from './Warning';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface EmailSmsOrdersResponse
|
|
20
|
+
*/
|
|
21
|
+
export interface EmailSmsOrdersResponse {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {ModelError}
|
|
25
|
+
* @memberof EmailSmsOrdersResponse
|
|
26
|
+
*/
|
|
27
|
+
error?: ModelError;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {ResponseMetadata}
|
|
31
|
+
* @memberof EmailSmsOrdersResponse
|
|
32
|
+
*/
|
|
33
|
+
metadata?: ResponseMetadata;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {Array<EmailSmsOrder>}
|
|
37
|
+
* @memberof EmailSmsOrdersResponse
|
|
38
|
+
*/
|
|
39
|
+
orders?: Array<EmailSmsOrder>;
|
|
40
|
+
/**
|
|
41
|
+
* Indicates if API call was successful
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof EmailSmsOrdersResponse
|
|
44
|
+
*/
|
|
45
|
+
success?: boolean;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {Warning}
|
|
49
|
+
* @memberof EmailSmsOrdersResponse
|
|
50
|
+
*/
|
|
51
|
+
warning?: Warning;
|
|
52
|
+
}
|
|
53
|
+
export declare function EmailSmsOrdersResponseFromJSON(json: any): EmailSmsOrdersResponse;
|
|
54
|
+
export declare function EmailSmsOrdersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailSmsOrdersResponse;
|
|
55
|
+
export declare function EmailSmsOrdersResponseToJSON(value?: EmailSmsOrdersResponse | 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.EmailSmsOrdersResponseToJSON = exports.EmailSmsOrdersResponseFromJSONTyped = exports.EmailSmsOrdersResponseFromJSON = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var EmailSmsOrder_1 = require("./EmailSmsOrder");
|
|
19
|
+
var ModelError_1 = require("./ModelError");
|
|
20
|
+
var ResponseMetadata_1 = require("./ResponseMetadata");
|
|
21
|
+
var Warning_1 = require("./Warning");
|
|
22
|
+
function EmailSmsOrdersResponseFromJSON(json) {
|
|
23
|
+
return EmailSmsOrdersResponseFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
exports.EmailSmsOrdersResponseFromJSON = EmailSmsOrdersResponseFromJSON;
|
|
26
|
+
function EmailSmsOrdersResponseFromJSONTyped(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
|
+
'orders': !(0, runtime_1.exists)(json, 'orders') ? undefined : (json['orders'].map(EmailSmsOrder_1.EmailSmsOrderFromJSON)),
|
|
34
|
+
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
35
|
+
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
exports.EmailSmsOrdersResponseFromJSONTyped = EmailSmsOrdersResponseFromJSONTyped;
|
|
39
|
+
function EmailSmsOrdersResponseToJSON(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
|
+
'orders': value.orders === undefined ? undefined : (value.orders.map(EmailSmsOrder_1.EmailSmsOrderToJSON)),
|
|
50
|
+
'success': value.success,
|
|
51
|
+
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
exports.EmailSmsOrdersResponseToJSON = EmailSmsOrdersResponseToJSON;
|