ultracart_rest_api_v2_typescript 4.0.223 → 4.0.224

package/.openapi-generator/FILES

@@ -443,6 +443,8 @@ src/models/EmailPlanResponse.ts
 src/models/EmailPostcardStat.ts
 src/models/EmailPostcardTracking.ts
 src/models/EmailPostcardTrackingResponse.ts
+src/models/EmailRateLimiter.ts
+src/models/EmailRateLimitersResponse.ts
 src/models/EmailSegment.ts
 src/models/EmailSegmentArchiveResponse.ts
 src/models/EmailSegmentCustomer.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.223
+## ultracart_rest_api_v2_typescript@4.0.224
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.223 --save
+npm install ultracart_rest_api_v2_typescript@4.0.224 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.224 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
 | 4.0.223 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |
 | 4.0.222 | 05/17/2024 | conv.pbx time based config - changed name from default to default_mapping |
 | 4.0.221 | 05/16/2024 | OrderPayment - constants for payment method Amazon Pay and Link |

package/dist/apis/StorefrontApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-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';
+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, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
 export interface AddToLibraryRequest {
     addLibraryRequest: AddLibraryItemRequest;
 }
@@ -177,6 +177,10 @@ export interface GetEmailCommseqPostcardTrackingRequest {
     storefrontOid: number;
     commseqPostcardUuid: string;
 }
+export interface GetEmailCommseqRateLimitersRequest {
+    storefrontOid: number;
+    commseqUuid: string;
+}
 export interface GetEmailCommseqSmsStatsRequest {
     storefrontOid: number;
     commseqUuid: string;
@@ -525,6 +529,10 @@ export interface ReleaseEmailCommseqStepWaitingRequest {
     commseqUuid: string;
     commseqStepUuid: string;
 }
+export interface ResetEmailCommseqRateLimitersRequest {
+    storefrontOid: number;
+    commseqUuid: string;
+}
 export interface ReviewRequest {
     storefrontOid: number;
     commseqEmailUuid: string;
@@ -1333,6 +1341,20 @@ export interface StorefrontApiInterface {
      * Get email communication postcard tracking
      */
     getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
+    /**
+     *
+     * @summary Get email commseq rate limiters
+     * @param {number} storefrontOid
+     * @param {string} commseqUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    getEmailCommseqRateLimitersRaw(requestParameters: GetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailRateLimitersResponse>>;
+    /**
+     * Get email commseq rate limiters
+     */
+    getEmailCommseqRateLimiters(requestParameters: GetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailRateLimitersResponse>;
     /**
      *
      * @summary Get email communication sequence sms stats
@@ -2593,6 +2615,20 @@ export interface StorefrontApiInterface {
      * Release email communication sequence customers waiting at the specified step
      */
     releaseEmailCommseqStepWaiting(requestParameters: ReleaseEmailCommseqStepWaitingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
+     * @param {number} storefrontOid
+     * @param {string} commseqUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    resetEmailCommseqRateLimitersRaw(requestParameters: ResetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Reset email commseq rate limiters (only callable by UltraCart Support)
+     */
+    resetEmailCommseqRateLimiters(requestParameters: ResetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      *
      * @summary Request a review of an email
@@ -3579,6 +3615,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
      * Get email communication postcard tracking
      */
     getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
+    /**
+     * Get email commseq rate limiters
+     */
+    getEmailCommseqRateLimitersRaw(requestParameters: GetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailRateLimitersResponse>>;
+    /**
+     * Get email commseq rate limiters
+     */
+    getEmailCommseqRateLimiters(requestParameters: GetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailRateLimitersResponse>;
     /**
      * Get email communication sequence sms stats
      */
@@ -4315,6 +4359,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
      * Release email communication sequence customers waiting at the specified step
      */
     releaseEmailCommseqStepWaiting(requestParameters: ReleaseEmailCommseqStepWaitingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reset email commseq rate limiters (only callable by UltraCart Support)
+     */
+    resetEmailCommseqRateLimitersRaw(requestParameters: ResetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Reset email commseq rate limiters (only callable by UltraCart Support)
+     */
+    resetEmailCommseqRateLimiters(requestParameters: ResetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Request a review of an email
      */

package/dist/apis/StorefrontApi.js

@@ -2772,6 +2772,69 @@ var StorefrontApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Get email commseq rate limiters
+     */
+    StorefrontApi.prototype.getEmailCommseqRateLimitersRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqRateLimiters.');
+                        }
+                        if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
+                            throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling getEmailCommseqRateLimiters.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+                        }
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailRateLimitersResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Get email commseq rate limiters
+     */
+    StorefrontApi.prototype.getEmailCommseqRateLimiters = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getEmailCommseqRateLimitersRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Get email communication sequence sms stats
      */
@@ -8428,6 +8491,67 @@ var StorefrontApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Reset email commseq rate limiters (only callable by UltraCart Support)
+     */
+    StorefrontApi.prototype.resetEmailCommseqRateLimitersRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling resetEmailCommseqRateLimiters.');
+                        }
+                        if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
+                            throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling resetEmailCommseqRateLimiters.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+                        }
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))),
+                                method: 'DELETE',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Reset email commseq rate limiters (only callable by UltraCart Support)
+     */
+    StorefrontApi.prototype.resetEmailCommseqRateLimiters = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.resetEmailCommseqRateLimitersRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Request a review of an email
      */

package/dist/models/EmailRateLimiter.d.ts

@@ -0,0 +1,39 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface EmailRateLimiter
+ */
+export interface EmailRateLimiter {
+    /**
+     *
+     * @type {number}
+     * @memberof EmailRateLimiter
+     */
+    available?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof EmailRateLimiter
+     */
+    limit?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailRateLimiter
+     */
+    name?: string;
+}
+export declare function EmailRateLimiterFromJSON(json: any): EmailRateLimiter;
+export declare function EmailRateLimiterFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailRateLimiter;
+export declare function EmailRateLimiterToJSON(value?: EmailRateLimiter | null): any;

package/dist/models/EmailRateLimiter.js

@@ -0,0 +1,46 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailRateLimiterToJSON = exports.EmailRateLimiterFromJSONTyped = exports.EmailRateLimiterFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function EmailRateLimiterFromJSON(json) {
+    return EmailRateLimiterFromJSONTyped(json, false);
+}
+exports.EmailRateLimiterFromJSON = EmailRateLimiterFromJSON;
+function EmailRateLimiterFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'available': !(0, runtime_1.exists)(json, 'available') ? undefined : json['available'],
+        'limit': !(0, runtime_1.exists)(json, 'limit') ? undefined : json['limit'],
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+    };
+}
+exports.EmailRateLimiterFromJSONTyped = EmailRateLimiterFromJSONTyped;
+function EmailRateLimiterToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'available': value.available,
+        'limit': value.limit,
+        'name': value.name,
+    };
+}
+exports.EmailRateLimiterToJSON = EmailRateLimiterToJSON;

package/dist/models/EmailRateLimitersResponse.d.ts

@@ -0,0 +1,55 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EmailRateLimiter } from './EmailRateLimiter';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface EmailRateLimitersResponse
+ */
+export interface EmailRateLimitersResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof EmailRateLimitersResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof EmailRateLimitersResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     *
+     * @type {Array<EmailRateLimiter>}
+     * @memberof EmailRateLimitersResponse
+     */
+    rate_limiters?: Array<EmailRateLimiter>;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof EmailRateLimitersResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof EmailRateLimitersResponse
+     */
+    warning?: Warning;
+}
+export declare function EmailRateLimitersResponseFromJSON(json: any): EmailRateLimitersResponse;
+export declare function EmailRateLimitersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailRateLimitersResponse;
+export declare function EmailRateLimitersResponseToJSON(value?: EmailRateLimitersResponse | null): any;

package/dist/models/EmailRateLimitersResponse.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailRateLimitersResponseToJSON = exports.EmailRateLimitersResponseFromJSONTyped = exports.EmailRateLimitersResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var EmailRateLimiter_1 = require("./EmailRateLimiter");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+function EmailRateLimitersResponseFromJSON(json) {
+    return EmailRateLimitersResponseFromJSONTyped(json, false);
+}
+exports.EmailRateLimitersResponseFromJSON = EmailRateLimitersResponseFromJSON;
+function EmailRateLimitersResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'rate_limiters': !(0, runtime_1.exists)(json, 'rate_limiters') ? undefined : (json['rate_limiters'].map(EmailRateLimiter_1.EmailRateLimiterFromJSON)),
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.EmailRateLimitersResponseFromJSONTyped = EmailRateLimitersResponseFromJSONTyped;
+function EmailRateLimitersResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'rate_limiters': value.rate_limiters === undefined ? undefined : (value.rate_limiters.map(EmailRateLimiter_1.EmailRateLimiterToJSON)),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.EmailRateLimitersResponseToJSON = EmailRateLimitersResponseToJSON;

package/dist/models/index.d.ts

@@ -416,6 +416,8 @@ export * from './EmailPlanResponse';
 export * from './EmailPostcardStat';
 export * from './EmailPostcardTracking';
 export * from './EmailPostcardTrackingResponse';
+export * from './EmailRateLimiter';
+export * from './EmailRateLimitersResponse';
 export * from './EmailSegment';
 export * from './EmailSegmentArchiveResponse';
 export * from './EmailSegmentCustomer';

package/dist/models/index.js

@@ -434,6 +434,8 @@ __exportStar(require("./EmailPlanResponse"), exports);
 __exportStar(require("./EmailPostcardStat"), exports);
 __exportStar(require("./EmailPostcardTracking"), exports);
 __exportStar(require("./EmailPostcardTrackingResponse"), exports);
+__exportStar(require("./EmailRateLimiter"), exports);
+__exportStar(require("./EmailRateLimitersResponse"), exports);
 __exportStar(require("./EmailSegment"), exports);
 __exportStar(require("./EmailSegmentArchiveResponse"), exports);
 __exportStar(require("./EmailSegmentCustomer"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.223",
+  "version": "4.0.224",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/StorefrontApi.ts

@@ -228,6 +228,9 @@ import {
     EmailPostcardTrackingResponse,
     EmailPostcardTrackingResponseFromJSON,
     EmailPostcardTrackingResponseToJSON,
+    EmailRateLimitersResponse,
+    EmailRateLimitersResponseFromJSON,
+    EmailRateLimitersResponseToJSON,
     EmailSegment,
     EmailSegmentFromJSON,
     EmailSegmentToJSON,
@@ -658,6 +661,11 @@ export interface GetEmailCommseqPostcardTrackingRequest {
     commseqPostcardUuid: string;
 }
 
+export interface GetEmailCommseqRateLimitersRequest {
+    storefrontOid: number;
+    commseqUuid: string;
+}
+
 export interface GetEmailCommseqSmsStatsRequest {
     storefrontOid: number;
     commseqUuid: string;
@@ -1090,6 +1098,11 @@ export interface ReleaseEmailCommseqStepWaitingRequest {
     commseqStepUuid: string;
 }
 
+export interface ResetEmailCommseqRateLimitersRequest {
+    storefrontOid: number;
+    commseqUuid: string;
+}
+
 export interface ReviewRequest {
     storefrontOid: number;
     commseqEmailUuid: string;
@@ -2026,6 +2039,22 @@ export interface StorefrontApiInterface {
      */
     getEmailCommseqPostcardTracking(requestParameters: GetEmailCommseqPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailPostcardTrackingResponse>;
 
+    /**
+     * 
+     * @summary Get email commseq rate limiters
+     * @param {number} storefrontOid 
+     * @param {string} commseqUuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    getEmailCommseqRateLimitersRaw(requestParameters: GetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailRateLimitersResponse>>;
+
+    /**
+     * Get email commseq rate limiters
+     */
+    getEmailCommseqRateLimiters(requestParameters: GetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailRateLimitersResponse>;
+
     /**
      * 
      * @summary Get email communication sequence sms stats
@@ -3464,6 +3493,22 @@ export interface StorefrontApiInterface {
      */
     releaseEmailCommseqStepWaiting(requestParameters: ReleaseEmailCommseqStepWaitingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * 
+     * @summary Reset email commseq rate limiters (only callable by UltraCart Support)
+     * @param {number} storefrontOid 
+     * @param {string} commseqUuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    resetEmailCommseqRateLimitersRaw(requestParameters: ResetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Reset email commseq rate limiters (only callable by UltraCart Support)
+     */
+    resetEmailCommseqRateLimiters(requestParameters: ResetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
     /**
      * 
      * @summary Request a review of an email
@@ -6201,6 +6246,53 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
         return await response.value();
     }
 
+    /**
+     * Get email commseq rate limiters
+     */
+    async getEmailCommseqRateLimitersRaw(requestParameters: GetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailRateLimitersResponse>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCommseqRateLimiters.');
+        }
+
+        if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
+            throw new runtime.RequiredError('commseqUuid','Required parameter requestParameters.commseqUuid was null or undefined when calling getEmailCommseqRateLimiters.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["storefront_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"commseq_uuid"}}`, encodeURIComponent(String(requestParameters.commseqUuid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => EmailRateLimitersResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get email commseq rate limiters
+     */
+    async getEmailCommseqRateLimiters(requestParameters: GetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailRateLimitersResponse> {
+        const response = await this.getEmailCommseqRateLimitersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Get email communication sequence sms stats
      */
@@ -10451,6 +10543,52 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
         await this.releaseEmailCommseqStepWaitingRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Reset email commseq rate limiters (only callable by UltraCart Support)
+     */
+    async resetEmailCommseqRateLimitersRaw(requestParameters: ResetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling resetEmailCommseqRateLimiters.');
+        }
+
+        if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
+            throw new runtime.RequiredError('commseqUuid','Required parameter requestParameters.commseqUuid was null or undefined when calling resetEmailCommseqRateLimiters.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["storefront_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"commseq_uuid"}}`, encodeURIComponent(String(requestParameters.commseqUuid))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Reset email commseq rate limiters (only callable by UltraCart Support)
+     */
+    async resetEmailCommseqRateLimiters(requestParameters: ResetEmailCommseqRateLimitersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.resetEmailCommseqRateLimitersRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Request a review of an email
      */

package/src/models/EmailRateLimiter.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface EmailRateLimiter
+ */
+export interface EmailRateLimiter {
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailRateLimiter
+     */
+    available?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailRateLimiter
+     */
+    limit?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailRateLimiter
+     */
+    name?: string;
+}
+
+export function EmailRateLimiterFromJSON(json: any): EmailRateLimiter {
+    return EmailRateLimiterFromJSONTyped(json, false);
+}
+
+export function EmailRateLimiterFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailRateLimiter {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'available': !exists(json, 'available') ? undefined : json['available'],
+        'limit': !exists(json, 'limit') ? undefined : json['limit'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+    };
+}
+
+export function EmailRateLimiterToJSON(value?: EmailRateLimiter | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'available': value.available,
+        'limit': value.limit,
+        'name': value.name,
+    };
+}
+

package/src/models/EmailRateLimitersResponse.ts

@@ -0,0 +1,113 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    EmailRateLimiter,
+    EmailRateLimiterFromJSON,
+    EmailRateLimiterFromJSONTyped,
+    EmailRateLimiterToJSON,
+} from './EmailRateLimiter';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface EmailRateLimitersResponse
+ */
+export interface EmailRateLimitersResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof EmailRateLimitersResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof EmailRateLimitersResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * 
+     * @type {Array<EmailRateLimiter>}
+     * @memberof EmailRateLimitersResponse
+     */
+    rate_limiters?: Array<EmailRateLimiter>;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof EmailRateLimitersResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof EmailRateLimitersResponse
+     */
+    warning?: Warning;
+}
+
+export function EmailRateLimitersResponseFromJSON(json: any): EmailRateLimitersResponse {
+    return EmailRateLimitersResponseFromJSONTyped(json, false);
+}
+
+export function EmailRateLimitersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailRateLimitersResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'rate_limiters': !exists(json, 'rate_limiters') ? undefined : ((json['rate_limiters'] as Array<any>).map(EmailRateLimiterFromJSON)),
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function EmailRateLimitersResponseToJSON(value?: EmailRateLimitersResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'rate_limiters': value.rate_limiters === undefined ? undefined : ((value.rate_limiters as Array<any>).map(EmailRateLimiterToJSON)),
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -418,6 +418,8 @@ export * from './EmailPlanResponse';
 export * from './EmailPostcardStat';
 export * from './EmailPostcardTracking';
 export * from './EmailPostcardTrackingResponse';
+export * from './EmailRateLimiter';
+export * from './EmailRateLimitersResponse';
 export * from './EmailSegment';
 export * from './EmailSegmentArchiveResponse';
 export * from './EmailSegmentCustomer';