ultracart_rest_api_v2_typescript 4.1.17 → 4.1.18
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 +1 -0
- package/README.md +3 -2
- package/dist/apis/StorefrontApi.d.ts +25 -1
- package/dist/apis/StorefrontApi.js +60 -0
- package/dist/models/EmailEditorValuesResponse.d.ts +58 -0
- package/dist/models/EmailEditorValuesResponse.js +61 -0
- package/dist/models/EmailWebhookEditorValuesResponse.d.ts +0 -6
- package/dist/models/EmailWebhookEditorValuesResponse.js +0 -2
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/StorefrontApi.ts +65 -0
- package/src/models/EmailEditorValuesResponse.ts +118 -0
- package/src/models/EmailWebhookEditorValuesResponse.ts +0 -8
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -431,6 +431,7 @@ src/models/EmailDashboardActivityResponse.ts
|
|
|
431
431
|
src/models/EmailDashboardStatsResponse.ts
|
|
432
432
|
src/models/EmailDomain.ts
|
|
433
433
|
src/models/EmailEditorTokenResponse.ts
|
|
434
|
+
src/models/EmailEditorValuesResponse.ts
|
|
434
435
|
src/models/EmailFlow.ts
|
|
435
436
|
src/models/EmailFlowBackPopulateRequest.ts
|
|
436
437
|
src/models/EmailFlowBackPopulateResponse.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.18
|
|
3
3
|
|
|
4
4
|
Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
|
|
5
5
|
|
|
6
6
|
Installation
|
|
7
7
|
|
|
8
8
|
```
|
|
9
|
-
npm install ultracart_rest_api_v2_typescript@4.1.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.18 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
|
|
88
89
|
| 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
|
|
89
90
|
| 4.1.16 | 07/28/2025 | updated doc samples |
|
|
90
91
|
| 4.1.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
|
|
@@ -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, EmailRateLimitersResponse, 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, StoreFrontPageContentAttribute, 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, EmailEditorValuesResponse, 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, EmailRateLimitersResponse, 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, StoreFrontPageContentAttribute, 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,9 @@ export interface GetEmailCommseqRequest {
|
|
|
163
163
|
storefrontOid: number;
|
|
164
164
|
commseqUuid: string;
|
|
165
165
|
}
|
|
166
|
+
export interface GetEmailCommseqEditorValuesRequest {
|
|
167
|
+
storefrontOid: number;
|
|
168
|
+
}
|
|
166
169
|
export interface GetEmailCommseqEmailStatsRequest {
|
|
167
170
|
storefrontOid: number;
|
|
168
171
|
commseqUuid: string;
|
|
@@ -1306,6 +1309,19 @@ export interface StorefrontApiInterface {
|
|
|
1306
1309
|
* Get email commseq
|
|
1307
1310
|
*/
|
|
1308
1311
|
getEmailCommseq(requestParameters: GetEmailCommseqRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqResponse>;
|
|
1312
|
+
/**
|
|
1313
|
+
*
|
|
1314
|
+
* @summary Get email merchant specific editor values
|
|
1315
|
+
* @param {number} storefrontOid
|
|
1316
|
+
* @param {*} [options] Override http request option.
|
|
1317
|
+
* @throws {RequiredError}
|
|
1318
|
+
* @memberof StorefrontApiInterface
|
|
1319
|
+
*/
|
|
1320
|
+
getEmailCommseqEditorValuesRaw(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailEditorValuesResponse>>;
|
|
1321
|
+
/**
|
|
1322
|
+
* Get email merchant specific editor values
|
|
1323
|
+
*/
|
|
1324
|
+
getEmailCommseqEditorValues(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailEditorValuesResponse>;
|
|
1309
1325
|
/**
|
|
1310
1326
|
*
|
|
1311
1327
|
* @summary Get email communication sequence emails stats
|
|
@@ -3630,6 +3646,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
|
|
|
3630
3646
|
* Get email commseq
|
|
3631
3647
|
*/
|
|
3632
3648
|
getEmailCommseq(requestParameters: GetEmailCommseqRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqResponse>;
|
|
3649
|
+
/**
|
|
3650
|
+
* Get email merchant specific editor values
|
|
3651
|
+
*/
|
|
3652
|
+
getEmailCommseqEditorValuesRaw(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailEditorValuesResponse>>;
|
|
3653
|
+
/**
|
|
3654
|
+
* Get email merchant specific editor values
|
|
3655
|
+
*/
|
|
3656
|
+
getEmailCommseqEditorValues(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailEditorValuesResponse>;
|
|
3633
3657
|
/**
|
|
3634
3658
|
* Get email communication sequence emails stats
|
|
3635
3659
|
*/
|
|
@@ -2573,6 +2573,66 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
2573
2573
|
});
|
|
2574
2574
|
});
|
|
2575
2575
|
};
|
|
2576
|
+
/**
|
|
2577
|
+
* Get email merchant specific editor values
|
|
2578
|
+
*/
|
|
2579
|
+
StorefrontApi.prototype.getEmailCommseqEditorValuesRaw = function (requestParameters, initOverrides) {
|
|
2580
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2581
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
2582
|
+
return __generator(this, function (_c) {
|
|
2583
|
+
switch (_c.label) {
|
|
2584
|
+
case 0:
|
|
2585
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
2586
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqEditorValues.');
|
|
2587
|
+
}
|
|
2588
|
+
queryParameters = {};
|
|
2589
|
+
headerParameters = {};
|
|
2590
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2591
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
2592
|
+
}
|
|
2593
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
2594
|
+
// oauth required
|
|
2595
|
+
_a = headerParameters;
|
|
2596
|
+
_b = "Authorization";
|
|
2597
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
|
|
2598
|
+
case 1:
|
|
2599
|
+
// oauth required
|
|
2600
|
+
_a[_b] = _c.sent();
|
|
2601
|
+
_c.label = 2;
|
|
2602
|
+
case 2:
|
|
2603
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2604
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
2605
|
+
}
|
|
2606
|
+
return [4 /*yield*/, this.request({
|
|
2607
|
+
path: "/storefront/{storefront_oid}/email/commseqs/editorValues".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
|
|
2608
|
+
method: 'GET',
|
|
2609
|
+
headers: headerParameters,
|
|
2610
|
+
query: queryParameters,
|
|
2611
|
+
}, initOverrides)];
|
|
2612
|
+
case 3:
|
|
2613
|
+
response = _c.sent();
|
|
2614
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailEditorValuesResponseFromJSON)(jsonValue); })];
|
|
2615
|
+
}
|
|
2616
|
+
});
|
|
2617
|
+
});
|
|
2618
|
+
};
|
|
2619
|
+
/**
|
|
2620
|
+
* Get email merchant specific editor values
|
|
2621
|
+
*/
|
|
2622
|
+
StorefrontApi.prototype.getEmailCommseqEditorValues = function (requestParameters, initOverrides) {
|
|
2623
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2624
|
+
var response;
|
|
2625
|
+
return __generator(this, function (_a) {
|
|
2626
|
+
switch (_a.label) {
|
|
2627
|
+
case 0: return [4 /*yield*/, this.getEmailCommseqEditorValuesRaw(requestParameters, initOverrides)];
|
|
2628
|
+
case 1:
|
|
2629
|
+
response = _a.sent();
|
|
2630
|
+
return [4 /*yield*/, response.value()];
|
|
2631
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
2632
|
+
}
|
|
2633
|
+
});
|
|
2634
|
+
});
|
|
2635
|
+
};
|
|
2576
2636
|
/**
|
|
2577
2637
|
* Get email communication sequence emails stats
|
|
2578
2638
|
*/
|
|
@@ -0,0 +1,58 @@
|
|
|
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 EmailEditorValuesResponse
|
|
19
|
+
*/
|
|
20
|
+
export interface EmailEditorValuesResponse {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {ModelError}
|
|
24
|
+
* @memberof EmailEditorValuesResponse
|
|
25
|
+
*/
|
|
26
|
+
error?: ModelError;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {Array<string>}
|
|
30
|
+
* @memberof EmailEditorValuesResponse
|
|
31
|
+
*/
|
|
32
|
+
loyalty_tiers?: Array<string>;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {ResponseMetadata}
|
|
36
|
+
* @memberof EmailEditorValuesResponse
|
|
37
|
+
*/
|
|
38
|
+
metadata?: ResponseMetadata;
|
|
39
|
+
/**
|
|
40
|
+
* Indicates if API call was successful
|
|
41
|
+
* @type {boolean}
|
|
42
|
+
* @memberof EmailEditorValuesResponse
|
|
43
|
+
*/
|
|
44
|
+
success?: boolean;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {Warning}
|
|
48
|
+
* @memberof EmailEditorValuesResponse
|
|
49
|
+
*/
|
|
50
|
+
warning?: Warning;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Check if a given object implements the EmailEditorValuesResponse interface.
|
|
54
|
+
*/
|
|
55
|
+
export declare function instanceOfEmailEditorValuesResponse(value: object): boolean;
|
|
56
|
+
export declare function EmailEditorValuesResponseFromJSON(json: any): EmailEditorValuesResponse;
|
|
57
|
+
export declare function EmailEditorValuesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailEditorValuesResponse;
|
|
58
|
+
export declare function EmailEditorValuesResponseToJSON(value?: EmailEditorValuesResponse | null): any;
|
|
@@ -0,0 +1,61 @@
|
|
|
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.EmailEditorValuesResponseToJSON = exports.EmailEditorValuesResponseFromJSONTyped = exports.EmailEditorValuesResponseFromJSON = exports.instanceOfEmailEditorValuesResponse = 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
|
+
/**
|
|
22
|
+
* Check if a given object implements the EmailEditorValuesResponse interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfEmailEditorValuesResponse(value) {
|
|
25
|
+
var isInstance = true;
|
|
26
|
+
return isInstance;
|
|
27
|
+
}
|
|
28
|
+
exports.instanceOfEmailEditorValuesResponse = instanceOfEmailEditorValuesResponse;
|
|
29
|
+
function EmailEditorValuesResponseFromJSON(json) {
|
|
30
|
+
return EmailEditorValuesResponseFromJSONTyped(json, false);
|
|
31
|
+
}
|
|
32
|
+
exports.EmailEditorValuesResponseFromJSON = EmailEditorValuesResponseFromJSON;
|
|
33
|
+
function EmailEditorValuesResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if ((json === undefined) || (json === null)) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
39
|
+
'loyalty_tiers': !(0, runtime_1.exists)(json, 'loyalty_tiers') ? undefined : json['loyalty_tiers'],
|
|
40
|
+
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
41
|
+
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
42
|
+
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
exports.EmailEditorValuesResponseFromJSONTyped = EmailEditorValuesResponseFromJSONTyped;
|
|
46
|
+
function EmailEditorValuesResponseToJSON(value) {
|
|
47
|
+
if (value === undefined) {
|
|
48
|
+
return undefined;
|
|
49
|
+
}
|
|
50
|
+
if (value === null) {
|
|
51
|
+
return null;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
55
|
+
'loyalty_tiers': value.loyalty_tiers,
|
|
56
|
+
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
57
|
+
'success': value.success,
|
|
58
|
+
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
exports.EmailEditorValuesResponseToJSON = EmailEditorValuesResponseToJSON;
|
|
@@ -36,12 +36,6 @@ export interface EmailWebhookEditorValuesResponse {
|
|
|
36
36
|
* @memberof EmailWebhookEditorValuesResponse
|
|
37
37
|
*/
|
|
38
38
|
error?: ModelError;
|
|
39
|
-
/**
|
|
40
|
-
*
|
|
41
|
-
* @type {Array<string>}
|
|
42
|
-
* @memberof EmailWebhookEditorValuesResponse
|
|
43
|
-
*/
|
|
44
|
-
loyalty_tiers?: Array<string>;
|
|
45
39
|
/**
|
|
46
40
|
*
|
|
47
41
|
* @type {ResponseMetadata}
|
|
@@ -38,7 +38,6 @@ function EmailWebhookEditorValuesResponseFromJSONTyped(json, ignoreDiscriminator
|
|
|
38
38
|
'available_expansions': !(0, runtime_1.exists)(json, 'available_expansions') ? undefined : json['available_expansions'],
|
|
39
39
|
'available_tokens': !(0, runtime_1.exists)(json, 'available_tokens') ? undefined : json['available_tokens'],
|
|
40
40
|
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
41
|
-
'loyalty_tiers': !(0, runtime_1.exists)(json, 'loyalty_tiers') ? undefined : json['loyalty_tiers'],
|
|
42
41
|
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
43
42
|
'rest_object_type': !(0, runtime_1.exists)(json, 'rest_object_type') ? undefined : json['rest_object_type'],
|
|
44
43
|
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
@@ -57,7 +56,6 @@ function EmailWebhookEditorValuesResponseToJSON(value) {
|
|
|
57
56
|
'available_expansions': value.available_expansions,
|
|
58
57
|
'available_tokens': value.available_tokens,
|
|
59
58
|
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
60
|
-
'loyalty_tiers': value.loyalty_tiers,
|
|
61
59
|
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
62
60
|
'rest_object_type': value.rest_object_type,
|
|
63
61
|
'success': value.success,
|
package/dist/models/index.d.ts
CHANGED
|
@@ -404,6 +404,7 @@ export * from './EmailDashboardActivityResponse';
|
|
|
404
404
|
export * from './EmailDashboardStatsResponse';
|
|
405
405
|
export * from './EmailDomain';
|
|
406
406
|
export * from './EmailEditorTokenResponse';
|
|
407
|
+
export * from './EmailEditorValuesResponse';
|
|
407
408
|
export * from './EmailFlow';
|
|
408
409
|
export * from './EmailFlowBackPopulateRequest';
|
|
409
410
|
export * from './EmailFlowBackPopulateResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -422,6 +422,7 @@ __exportStar(require("./EmailDashboardActivityResponse"), exports);
|
|
|
422
422
|
__exportStar(require("./EmailDashboardStatsResponse"), exports);
|
|
423
423
|
__exportStar(require("./EmailDomain"), exports);
|
|
424
424
|
__exportStar(require("./EmailEditorTokenResponse"), exports);
|
|
425
|
+
__exportStar(require("./EmailEditorValuesResponse"), exports);
|
|
425
426
|
__exportStar(require("./EmailFlow"), exports);
|
|
426
427
|
__exportStar(require("./EmailFlowBackPopulateRequest"), exports);
|
|
427
428
|
__exportStar(require("./EmailFlowBackPopulateResponse"), exports);
|
package/package.json
CHANGED
|
@@ -144,6 +144,9 @@ import {
|
|
|
144
144
|
EmailEditorTokenResponse,
|
|
145
145
|
EmailEditorTokenResponseFromJSON,
|
|
146
146
|
EmailEditorTokenResponseToJSON,
|
|
147
|
+
EmailEditorValuesResponse,
|
|
148
|
+
EmailEditorValuesResponseFromJSON,
|
|
149
|
+
EmailEditorValuesResponseToJSON,
|
|
147
150
|
EmailFlow,
|
|
148
151
|
EmailFlowFromJSON,
|
|
149
152
|
EmailFlowToJSON,
|
|
@@ -647,6 +650,10 @@ export interface GetEmailCommseqRequest {
|
|
|
647
650
|
commseqUuid: string;
|
|
648
651
|
}
|
|
649
652
|
|
|
653
|
+
export interface GetEmailCommseqEditorValuesRequest {
|
|
654
|
+
storefrontOid: number;
|
|
655
|
+
}
|
|
656
|
+
|
|
650
657
|
export interface GetEmailCommseqEmailStatsRequest {
|
|
651
658
|
storefrontOid: number;
|
|
652
659
|
commseqUuid: string;
|
|
@@ -2003,6 +2010,21 @@ export interface StorefrontApiInterface {
|
|
|
2003
2010
|
*/
|
|
2004
2011
|
getEmailCommseq(requestParameters: GetEmailCommseqRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqResponse>;
|
|
2005
2012
|
|
|
2013
|
+
/**
|
|
2014
|
+
*
|
|
2015
|
+
* @summary Get email merchant specific editor values
|
|
2016
|
+
* @param {number} storefrontOid
|
|
2017
|
+
* @param {*} [options] Override http request option.
|
|
2018
|
+
* @throws {RequiredError}
|
|
2019
|
+
* @memberof StorefrontApiInterface
|
|
2020
|
+
*/
|
|
2021
|
+
getEmailCommseqEditorValuesRaw(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailEditorValuesResponse>>;
|
|
2022
|
+
|
|
2023
|
+
/**
|
|
2024
|
+
* Get email merchant specific editor values
|
|
2025
|
+
*/
|
|
2026
|
+
getEmailCommseqEditorValues(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailEditorValuesResponse>;
|
|
2027
|
+
|
|
2006
2028
|
/**
|
|
2007
2029
|
*
|
|
2008
2030
|
* @summary Get email communication sequence emails stats
|
|
@@ -6139,6 +6161,49 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
|
|
|
6139
6161
|
return await response.value();
|
|
6140
6162
|
}
|
|
6141
6163
|
|
|
6164
|
+
/**
|
|
6165
|
+
* Get email merchant specific editor values
|
|
6166
|
+
*/
|
|
6167
|
+
async getEmailCommseqEditorValuesRaw(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailEditorValuesResponse>> {
|
|
6168
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
6169
|
+
throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqEditorValues.');
|
|
6170
|
+
}
|
|
6171
|
+
|
|
6172
|
+
const queryParameters: any = {};
|
|
6173
|
+
|
|
6174
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
6175
|
+
|
|
6176
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
6177
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
6178
|
+
}
|
|
6179
|
+
|
|
6180
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
6181
|
+
// oauth required
|
|
6182
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["storefront_read"]);
|
|
6183
|
+
}
|
|
6184
|
+
|
|
6185
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
6186
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
6187
|
+
}
|
|
6188
|
+
|
|
6189
|
+
const response = await this.request({
|
|
6190
|
+
path: `/storefront/{storefront_oid}/email/commseqs/editorValues`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))),
|
|
6191
|
+
method: 'GET',
|
|
6192
|
+
headers: headerParameters,
|
|
6193
|
+
query: queryParameters,
|
|
6194
|
+
}, initOverrides);
|
|
6195
|
+
|
|
6196
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => EmailEditorValuesResponseFromJSON(jsonValue));
|
|
6197
|
+
}
|
|
6198
|
+
|
|
6199
|
+
/**
|
|
6200
|
+
* Get email merchant specific editor values
|
|
6201
|
+
*/
|
|
6202
|
+
async getEmailCommseqEditorValues(requestParameters: GetEmailCommseqEditorValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailEditorValuesResponse> {
|
|
6203
|
+
const response = await this.getEmailCommseqEditorValuesRaw(requestParameters, initOverrides);
|
|
6204
|
+
return await response.value();
|
|
6205
|
+
}
|
|
6206
|
+
|
|
6142
6207
|
/**
|
|
6143
6208
|
* Get email communication sequence emails stats
|
|
6144
6209
|
*/
|
|
@@ -0,0 +1,118 @@
|
|
|
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 EmailEditorValuesResponse
|
|
39
|
+
*/
|
|
40
|
+
export interface EmailEditorValuesResponse {
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @type {ModelError}
|
|
44
|
+
* @memberof EmailEditorValuesResponse
|
|
45
|
+
*/
|
|
46
|
+
error?: ModelError;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {Array<string>}
|
|
50
|
+
* @memberof EmailEditorValuesResponse
|
|
51
|
+
*/
|
|
52
|
+
loyalty_tiers?: Array<string>;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {ResponseMetadata}
|
|
56
|
+
* @memberof EmailEditorValuesResponse
|
|
57
|
+
*/
|
|
58
|
+
metadata?: ResponseMetadata;
|
|
59
|
+
/**
|
|
60
|
+
* Indicates if API call was successful
|
|
61
|
+
* @type {boolean}
|
|
62
|
+
* @memberof EmailEditorValuesResponse
|
|
63
|
+
*/
|
|
64
|
+
success?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {Warning}
|
|
68
|
+
* @memberof EmailEditorValuesResponse
|
|
69
|
+
*/
|
|
70
|
+
warning?: Warning;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Check if a given object implements the EmailEditorValuesResponse interface.
|
|
77
|
+
*/
|
|
78
|
+
export function instanceOfEmailEditorValuesResponse(value: object): boolean {
|
|
79
|
+
let isInstance = true;
|
|
80
|
+
|
|
81
|
+
return isInstance;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function EmailEditorValuesResponseFromJSON(json: any): EmailEditorValuesResponse {
|
|
85
|
+
return EmailEditorValuesResponseFromJSONTyped(json, false);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export function EmailEditorValuesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailEditorValuesResponse {
|
|
89
|
+
if ((json === undefined) || (json === null)) {
|
|
90
|
+
return json;
|
|
91
|
+
}
|
|
92
|
+
return {
|
|
93
|
+
|
|
94
|
+
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
95
|
+
'loyalty_tiers': !exists(json, 'loyalty_tiers') ? undefined : json['loyalty_tiers'],
|
|
96
|
+
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
97
|
+
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
98
|
+
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
99
|
+
};
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export function EmailEditorValuesResponseToJSON(value?: EmailEditorValuesResponse | null): any {
|
|
103
|
+
if (value === undefined) {
|
|
104
|
+
return undefined;
|
|
105
|
+
}
|
|
106
|
+
if (value === null) {
|
|
107
|
+
return null;
|
|
108
|
+
}
|
|
109
|
+
return {
|
|
110
|
+
|
|
111
|
+
'error': ModelErrorToJSON(value.error),
|
|
112
|
+
'loyalty_tiers': value.loyalty_tiers,
|
|
113
|
+
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
114
|
+
'success': value.success,
|
|
115
|
+
'warning': WarningToJSON(value.warning),
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
|
|
@@ -56,12 +56,6 @@ export interface EmailWebhookEditorValuesResponse {
|
|
|
56
56
|
* @memberof EmailWebhookEditorValuesResponse
|
|
57
57
|
*/
|
|
58
58
|
error?: ModelError;
|
|
59
|
-
/**
|
|
60
|
-
*
|
|
61
|
-
* @type {Array<string>}
|
|
62
|
-
* @memberof EmailWebhookEditorValuesResponse
|
|
63
|
-
*/
|
|
64
|
-
loyalty_tiers?: Array<string>;
|
|
65
59
|
/**
|
|
66
60
|
*
|
|
67
61
|
* @type {ResponseMetadata}
|
|
@@ -112,7 +106,6 @@ export function EmailWebhookEditorValuesResponseFromJSONTyped(json: any, ignoreD
|
|
|
112
106
|
'available_expansions': !exists(json, 'available_expansions') ? undefined : json['available_expansions'],
|
|
113
107
|
'available_tokens': !exists(json, 'available_tokens') ? undefined : json['available_tokens'],
|
|
114
108
|
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
115
|
-
'loyalty_tiers': !exists(json, 'loyalty_tiers') ? undefined : json['loyalty_tiers'],
|
|
116
109
|
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
117
110
|
'rest_object_type': !exists(json, 'rest_object_type') ? undefined : json['rest_object_type'],
|
|
118
111
|
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
@@ -132,7 +125,6 @@ export function EmailWebhookEditorValuesResponseToJSON(value?: EmailWebhookEdito
|
|
|
132
125
|
'available_expansions': value.available_expansions,
|
|
133
126
|
'available_tokens': value.available_tokens,
|
|
134
127
|
'error': ModelErrorToJSON(value.error),
|
|
135
|
-
'loyalty_tiers': value.loyalty_tiers,
|
|
136
128
|
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
137
129
|
'rest_object_type': value.rest_object_type,
|
|
138
130
|
'success': value.success,
|
package/src/models/index.ts
CHANGED
|
@@ -406,6 +406,7 @@ export * from './EmailDashboardActivityResponse';
|
|
|
406
406
|
export * from './EmailDashboardStatsResponse';
|
|
407
407
|
export * from './EmailDomain';
|
|
408
408
|
export * from './EmailEditorTokenResponse';
|
|
409
|
+
export * from './EmailEditorValuesResponse';
|
|
409
410
|
export * from './EmailFlow';
|
|
410
411
|
export * from './EmailFlowBackPopulateRequest';
|
|
411
412
|
export * from './EmailFlowBackPopulateResponse';
|