ultracart_rest_api_v2_typescript 4.0.58-RC → 4.0.61-RC

package/.openapi-generator/FILES

@@ -573,6 +573,8 @@ src/models/RegisterAffiliateClickRequest.ts
 src/models/RegisterAffiliateClickResponse.ts
 src/models/ResponseMetadata.ts
 src/models/ResultSet.ts
+src/models/RulerValidationRequest.ts
+src/models/RulerValidationResponse.ts
 src/models/ScreenRecording.ts
 src/models/ScreenRecordingAdPlatform.ts
 src/models/ScreenRecordingFilter.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.58-RC
+## ultracart_rest_api_v2_typescript@4.0.61-RC
 
 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.58-RC --save
+npm install ultracart_rest_api_v2_typescript@4.0.61-RC --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
+| 4.0.60-RC | 09/02/2022 | customer editor added loyal ledger descriptions |
+| 4.0.59-RC | 08/30/2022 | storefront comm fields for sms configuration |
 | 4.0.58-RC | 08/26/2022 | postcard address fields for comm sequence testing |
 | 4.0.57-RC | 08/22/2022 | exposing individual reviews within item.review object |
 | 4.0.56-RC | 08/19/2022 | order api - added cell phone fields for sms |

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, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, 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, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, RulerValidationRequest, RulerValidationResponse, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
 export interface AddToLibraryRequest {
     addLibraryRequest: AddLibraryItemRequest;
 }
@@ -678,6 +678,9 @@ export interface UpdateTwilioAccountRequest {
     espTwilioUuid: string;
     twilio: Twilio;
 }
+export interface ValidateRulerRequest {
+    rulerValidateRequest: RulerValidationRequest;
+}
 /**
  * StorefrontApi - interface
  *
@@ -3026,6 +3029,19 @@ export interface StorefrontApiInterface {
      * Update Twilio account
      */
     updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
+    /**
+     *
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} rulerValidateRequest Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>>;
+    /**
+     * Validate AWS Event Ruler
+     */
+    validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse>;
 }
 /**
  *
@@ -4391,4 +4407,12 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
      * Update Twilio account
      */
     updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
+    /**
+     * Validate AWS Event Ruler
+     */
+    validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>>;
+    /**
+     * Validate AWS Event Ruler
+     */
+    validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse>;
 }

package/dist/apis/StorefrontApi.js

@@ -10573,6 +10573,68 @@ var StorefrontApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Validate AWS Event Ruler
+     */
+    StorefrontApi.prototype.validateRulerRaw = 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.rulerValidateRequest === null || requestParameters.rulerValidateRequest === undefined) {
+                            throw new runtime.RequiredError('rulerValidateRequest', 'Required parameter requestParameters.rulerValidateRequest was null or undefined when calling validateRuler.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        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_write"])];
+                    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/ruler/validate",
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.RulerValidationRequestToJSON)(requestParameters.rulerValidateRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.RulerValidationResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Validate AWS Event Ruler
+     */
+    StorefrontApi.prototype.validateRuler = 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.validateRulerRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return StorefrontApi;
 }(runtime.BaseAPI));
 exports.StorefrontApi = StorefrontApi;

package/dist/models/CustomerEditorValues.d.ts

@@ -47,6 +47,12 @@ export interface CustomerEditorValues {
      * @memberof CustomerEditorValues
      */
     countries?: Array<Country>;
+    /**
+     * loyalty_ledger_descriptions
+     * @type {Array<string>}
+     * @memberof CustomerEditorValues
+     */
+    loyalty_ledger_descriptions?: Array<string>;
     /**
      * loyalty_program_type
      * @type {string}

package/dist/models/CustomerEditorValues.js

@@ -31,6 +31,7 @@ function CustomerEditorValuesFromJSONTyped(json, ignoreDiscriminator) {
         'card_exp_years': !(0, runtime_1.exists)(json, 'card_exp_years') ? undefined : json['card_exp_years'],
         'card_types': !(0, runtime_1.exists)(json, 'card_types') ? undefined : json['card_types'],
         'countries': !(0, runtime_1.exists)(json, 'countries') ? undefined : (json['countries'].map(Country_1.CountryFromJSON)),
+        'loyalty_ledger_descriptions': !(0, runtime_1.exists)(json, 'loyalty_ledger_descriptions') ? undefined : json['loyalty_ledger_descriptions'],
         'loyalty_program_type': !(0, runtime_1.exists)(json, 'loyalty_program_type') ? undefined : json['loyalty_program_type'],
         'qb_classes': !(0, runtime_1.exists)(json, 'qb_classes') ? undefined : json['qb_classes'],
         'sales_rep_codes': !(0, runtime_1.exists)(json, 'sales_rep_codes') ? undefined : json['sales_rep_codes'],
@@ -52,6 +53,7 @@ function CustomerEditorValuesToJSON(value) {
         'card_exp_years': value.card_exp_years,
         'card_types': value.card_types,
         'countries': value.countries === undefined ? undefined : (value.countries.map(Country_1.CountryToJSON)),
+        'loyalty_ledger_descriptions': value.loyalty_ledger_descriptions,
         'loyalty_program_type': value.loyalty_program_type,
         'qb_classes': value.qb_classes,
         'sales_rep_codes': value.sales_rep_codes,

package/dist/models/EmailCampaign.d.ts

@@ -142,6 +142,18 @@ export interface EmailCampaign {
      * @memberof EmailCampaign
      */
     screenshot_large_full_url?: string;
+    /**
+     * Twilio Account UUID.  Null for none
+     * @type {string}
+     * @memberof EmailCampaign
+     */
+    sms_esp_twilio_uuid?: string;
+    /**
+     * Twilio SMS Phone Number.  Null for none
+     * @type {string}
+     * @memberof EmailCampaign
+     */
+    sms_phone_number?: string;
     /**
      * Status of the campaign of draft, archived, and sent
      * @type {string}

package/dist/models/EmailCampaign.js

@@ -46,6 +46,8 @@ function EmailCampaignFromJSONTyped(json, ignoreDiscriminator) {
         'revenue_per_customer_formatted': !(0, runtime_1.exists)(json, 'revenue_per_customer_formatted') ? undefined : json['revenue_per_customer_formatted'],
         'scheduled_dts': !(0, runtime_1.exists)(json, 'scheduled_dts') ? undefined : json['scheduled_dts'],
         'screenshot_large_full_url': !(0, runtime_1.exists)(json, 'screenshot_large_full_url') ? undefined : json['screenshot_large_full_url'],
+        'sms_esp_twilio_uuid': !(0, runtime_1.exists)(json, 'sms_esp_twilio_uuid') ? undefined : json['sms_esp_twilio_uuid'],
+        'sms_phone_number': !(0, runtime_1.exists)(json, 'sms_phone_number') ? undefined : json['sms_phone_number'],
         'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
         'status_dts': !(0, runtime_1.exists)(json, 'status_dts') ? undefined : json['status_dts'],
         'storefront_oid': !(0, runtime_1.exists)(json, 'storefront_oid') ? undefined : json['storefront_oid'],
@@ -81,6 +83,8 @@ function EmailCampaignToJSON(value) {
         'revenue_per_customer_formatted': value.revenue_per_customer_formatted,
         'scheduled_dts': value.scheduled_dts,
         'screenshot_large_full_url': value.screenshot_large_full_url,
+        'sms_esp_twilio_uuid': value.sms_esp_twilio_uuid,
+        'sms_phone_number': value.sms_phone_number,
         'status': value.status,
         'status_dts': value.status_dts,
         'storefront_oid': value.storefront_oid,

package/dist/models/EmailFlow.d.ts

@@ -147,6 +147,18 @@ export interface EmailFlow {
      * @memberof EmailFlow
      */
     screenshot_large_full_url?: string;
+    /**
+     * Twilio Account UUID.  Null for none
+     * @type {string}
+     * @memberof EmailFlow
+     */
+    sms_esp_twilio_uuid?: string;
+    /**
+     * Twilio SMS Phone Number.  Null for none
+     * @type {string}
+     * @memberof EmailFlow
+     */
+    sms_phone_number?: string;
     /**
      * Status of the campaign of draft, archived, active, and inactive
      * @type {string}

package/dist/models/EmailFlow.js

@@ -46,6 +46,8 @@ function EmailFlowFromJSONTyped(json, ignoreDiscriminator) {
         'revenue_formatted': !(0, runtime_1.exists)(json, 'revenue_formatted') ? undefined : json['revenue_formatted'],
         'revenue_per_customer_formatted': !(0, runtime_1.exists)(json, 'revenue_per_customer_formatted') ? undefined : json['revenue_per_customer_formatted'],
         'screenshot_large_full_url': !(0, runtime_1.exists)(json, 'screenshot_large_full_url') ? undefined : json['screenshot_large_full_url'],
+        'sms_esp_twilio_uuid': !(0, runtime_1.exists)(json, 'sms_esp_twilio_uuid') ? undefined : json['sms_esp_twilio_uuid'],
+        'sms_phone_number': !(0, runtime_1.exists)(json, 'sms_phone_number') ? undefined : json['sms_phone_number'],
         'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
         'status_dts': !(0, runtime_1.exists)(json, 'status_dts') ? undefined : json['status_dts'],
         'storefront_oid': !(0, runtime_1.exists)(json, 'storefront_oid') ? undefined : json['storefront_oid'],
@@ -85,6 +87,8 @@ function EmailFlowToJSON(value) {
         'revenue_formatted': value.revenue_formatted,
         'revenue_per_customer_formatted': value.revenue_per_customer_formatted,
         'screenshot_large_full_url': value.screenshot_large_full_url,
+        'sms_esp_twilio_uuid': value.sms_esp_twilio_uuid,
+        'sms_phone_number': value.sms_phone_number,
         'status': value.status,
         'status_dts': value.status_dts,
         'storefront_oid': value.storefront_oid,

package/dist/models/EmailSettings.d.ts

@@ -69,6 +69,18 @@ export interface EmailSettings {
      * @memberof EmailSettings
      */
     postcard_from_state?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailSettings
+     */
+    sms_esp_twilio_uuid?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailSettings
+     */
+    sms_phone_number?: string;
     /**
      *
      * @type {string}

package/dist/models/EmailSettings.js

@@ -33,6 +33,8 @@ function EmailSettingsFromJSONTyped(json, ignoreDiscriminator) {
         'postcard_from_name': !(0, runtime_1.exists)(json, 'postcard_from_name') ? undefined : json['postcard_from_name'],
         'postcard_from_postal_code': !(0, runtime_1.exists)(json, 'postcard_from_postal_code') ? undefined : json['postcard_from_postal_code'],
         'postcard_from_state': !(0, runtime_1.exists)(json, 'postcard_from_state') ? undefined : json['postcard_from_state'],
+        'sms_esp_twilio_uuid': !(0, runtime_1.exists)(json, 'sms_esp_twilio_uuid') ? undefined : json['sms_esp_twilio_uuid'],
+        'sms_phone_number': !(0, runtime_1.exists)(json, 'sms_phone_number') ? undefined : json['sms_phone_number'],
         'transactional_esp_domain_user': !(0, runtime_1.exists)(json, 'transactional_esp_domain_user') ? undefined : json['transactional_esp_domain_user'],
         'transactional_esp_domain_uuid': !(0, runtime_1.exists)(json, 'transactional_esp_domain_uuid') ? undefined : json['transactional_esp_domain_uuid'],
         'transactional_esp_friendly_name': !(0, runtime_1.exists)(json, 'transactional_esp_friendly_name') ? undefined : json['transactional_esp_friendly_name'],
@@ -56,6 +58,8 @@ function EmailSettingsToJSON(value) {
         'postcard_from_name': value.postcard_from_name,
         'postcard_from_postal_code': value.postcard_from_postal_code,
         'postcard_from_state': value.postcard_from_state,
+        'sms_esp_twilio_uuid': value.sms_esp_twilio_uuid,
+        'sms_phone_number': value.sms_phone_number,
         'transactional_esp_domain_user': value.transactional_esp_domain_user,
         'transactional_esp_domain_uuid': value.transactional_esp_domain_uuid,
         'transactional_esp_friendly_name': value.transactional_esp_friendly_name,

package/dist/models/RulerValidationRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 RulerValidationRequest
+ */
+export interface RulerValidationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof RulerValidationRequest
+     */
+    ruler?: string;
+}
+export declare function RulerValidationRequestFromJSON(json: any): RulerValidationRequest;
+export declare function RulerValidationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RulerValidationRequest;
+export declare function RulerValidationRequestToJSON(value?: RulerValidationRequest | null): any;

package/dist/models/RulerValidationRequest.js

@@ -0,0 +1,42 @@
+"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.RulerValidationRequestToJSON = exports.RulerValidationRequestFromJSONTyped = exports.RulerValidationRequestFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function RulerValidationRequestFromJSON(json) {
+    return RulerValidationRequestFromJSONTyped(json, false);
+}
+exports.RulerValidationRequestFromJSON = RulerValidationRequestFromJSON;
+function RulerValidationRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'ruler': !(0, runtime_1.exists)(json, 'ruler') ? undefined : json['ruler'],
+    };
+}
+exports.RulerValidationRequestFromJSONTyped = RulerValidationRequestFromJSONTyped;
+function RulerValidationRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'ruler': value.ruler,
+    };
+}
+exports.RulerValidationRequestToJSON = RulerValidationRequestToJSON;

package/dist/models/RulerValidationResponse.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 RulerValidationResponse
+ */
+export interface RulerValidationResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof RulerValidationResponse
+     */
+    error_message?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RulerValidationResponse
+     */
+    valid?: boolean;
+}
+export declare function RulerValidationResponseFromJSON(json: any): RulerValidationResponse;
+export declare function RulerValidationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RulerValidationResponse;
+export declare function RulerValidationResponseToJSON(value?: RulerValidationResponse | null): any;

package/dist/models/RulerValidationResponse.js

@@ -0,0 +1,44 @@
+"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.RulerValidationResponseToJSON = exports.RulerValidationResponseFromJSONTyped = exports.RulerValidationResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function RulerValidationResponseFromJSON(json) {
+    return RulerValidationResponseFromJSONTyped(json, false);
+}
+exports.RulerValidationResponseFromJSON = RulerValidationResponseFromJSON;
+function RulerValidationResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error_message': !(0, runtime_1.exists)(json, 'error_message') ? undefined : json['error_message'],
+        'valid': !(0, runtime_1.exists)(json, 'valid') ? undefined : json['valid'],
+    };
+}
+exports.RulerValidationResponseFromJSONTyped = RulerValidationResponseFromJSONTyped;
+function RulerValidationResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error_message': value.error_message,
+        'valid': value.valid,
+    };
+}
+exports.RulerValidationResponseToJSON = RulerValidationResponseToJSON;

package/dist/models/index.d.ts

@@ -548,6 +548,8 @@ export * from './RegisterAffiliateClickRequest';
 export * from './RegisterAffiliateClickResponse';
 export * from './ResponseMetadata';
 export * from './ResultSet';
+export * from './RulerValidationRequest';
+export * from './RulerValidationResponse';
 export * from './ScreenRecording';
 export * from './ScreenRecordingAdPlatform';
 export * from './ScreenRecordingFilter';

package/dist/models/index.js

@@ -566,6 +566,8 @@ __exportStar(require("./RegisterAffiliateClickRequest"), exports);
 __exportStar(require("./RegisterAffiliateClickResponse"), exports);
 __exportStar(require("./ResponseMetadata"), exports);
 __exportStar(require("./ResultSet"), exports);
+__exportStar(require("./RulerValidationRequest"), exports);
+__exportStar(require("./RulerValidationResponse"), exports);
 __exportStar(require("./ScreenRecording"), exports);
 __exportStar(require("./ScreenRecordingAdPlatform"), exports);
 __exportStar(require("./ScreenRecordingFilter"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.58-RC",
+  "version": "4.0.61-RC",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/StorefrontApi.ts

@@ -333,6 +333,12 @@ import {
     PublishLibraryItemRequest,
     PublishLibraryItemRequestFromJSON,
     PublishLibraryItemRequestToJSON,
+    RulerValidationRequest,
+    RulerValidationRequestFromJSON,
+    RulerValidationRequestToJSON,
+    RulerValidationResponse,
+    RulerValidationResponseFromJSON,
+    RulerValidationResponseToJSON,
     ScreenRecordingHeatmapIndexRequest,
     ScreenRecordingHeatmapIndexRequestFromJSON,
     ScreenRecordingHeatmapIndexRequestToJSON,
@@ -1242,6 +1248,10 @@ export interface UpdateTwilioAccountRequest {
     twilio: Twilio;
 }
 
+export interface ValidateRulerRequest {
+    rulerValidateRequest: RulerValidationRequest;
+}
+
 /**
  * StorefrontApi - interface
  * 
@@ -3918,6 +3928,21 @@ export interface StorefrontApiInterface {
      */
     updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
 
+    /**
+     * 
+     * @summary Validate AWS Event Ruler
+     * @param {RulerValidationRequest} rulerValidateRequest Ruler Validate Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StorefrontApiInterface
+     */
+    validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>>;
+
+    /**
+     * Validate AWS Event Ruler
+     */
+    validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse>;
+
 }
 
 /**
@@ -11879,4 +11904,50 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
         return await response.value();
     }
 
+    /**
+     * Validate AWS Event Ruler
+     */
+    async validateRulerRaw(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RulerValidationResponse>> {
+        if (requestParameters.rulerValidateRequest === null || requestParameters.rulerValidateRequest === undefined) {
+            throw new runtime.RequiredError('rulerValidateRequest','Required parameter requestParameters.rulerValidateRequest was null or undefined when calling validateRuler.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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_write"]);
+        }
+
+        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/ruler/validate`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RulerValidationRequestToJSON(requestParameters.rulerValidateRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RulerValidationResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Validate AWS Event Ruler
+     */
+    async validateRuler(requestParameters: ValidateRulerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RulerValidationResponse> {
+        const response = await this.validateRulerRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/models/CustomerEditorValues.ts

@@ -62,6 +62,12 @@ export interface CustomerEditorValues {
      * @memberof CustomerEditorValues
      */
     countries?: Array<Country>;
+    /**
+     * loyalty_ledger_descriptions
+     * @type {Array<string>}
+     * @memberof CustomerEditorValues
+     */
+    loyalty_ledger_descriptions?: Array<string>;
     /**
      * loyalty_program_type
      * @type {string}
@@ -109,6 +115,7 @@ export function CustomerEditorValuesFromJSONTyped(json: any, ignoreDiscriminator
         'card_exp_years': !exists(json, 'card_exp_years') ? undefined : json['card_exp_years'],
         'card_types': !exists(json, 'card_types') ? undefined : json['card_types'],
         'countries': !exists(json, 'countries') ? undefined : ((json['countries'] as Array<any>).map(CountryFromJSON)),
+        'loyalty_ledger_descriptions': !exists(json, 'loyalty_ledger_descriptions') ? undefined : json['loyalty_ledger_descriptions'],
         'loyalty_program_type': !exists(json, 'loyalty_program_type') ? undefined : json['loyalty_program_type'],
         'qb_classes': !exists(json, 'qb_classes') ? undefined : json['qb_classes'],
         'sales_rep_codes': !exists(json, 'sales_rep_codes') ? undefined : json['sales_rep_codes'],
@@ -131,6 +138,7 @@ export function CustomerEditorValuesToJSON(value?: CustomerEditorValues | null):
         'card_exp_years': value.card_exp_years,
         'card_types': value.card_types,
         'countries': value.countries === undefined ? undefined : ((value.countries as Array<any>).map(CountryToJSON)),
+        'loyalty_ledger_descriptions': value.loyalty_ledger_descriptions,
         'loyalty_program_type': value.loyalty_program_type,
         'qb_classes': value.qb_classes,
         'sales_rep_codes': value.sales_rep_codes,

package/src/models/EmailCampaign.ts

@@ -152,6 +152,18 @@ export interface EmailCampaign {
      * @memberof EmailCampaign
      */
     screenshot_large_full_url?: string;
+    /**
+     * Twilio Account UUID.  Null for none
+     * @type {string}
+     * @memberof EmailCampaign
+     */
+    sms_esp_twilio_uuid?: string;
+    /**
+     * Twilio SMS Phone Number.  Null for none
+     * @type {string}
+     * @memberof EmailCampaign
+     */
+    sms_phone_number?: string;
     /**
      * Status of the campaign of draft, archived, and sent
      * @type {string}
@@ -203,6 +215,8 @@ export function EmailCampaignFromJSONTyped(json: any, ignoreDiscriminator: boole
         'revenue_per_customer_formatted': !exists(json, 'revenue_per_customer_formatted') ? undefined : json['revenue_per_customer_formatted'],
         'scheduled_dts': !exists(json, 'scheduled_dts') ? undefined : json['scheduled_dts'],
         'screenshot_large_full_url': !exists(json, 'screenshot_large_full_url') ? undefined : json['screenshot_large_full_url'],
+        'sms_esp_twilio_uuid': !exists(json, 'sms_esp_twilio_uuid') ? undefined : json['sms_esp_twilio_uuid'],
+        'sms_phone_number': !exists(json, 'sms_phone_number') ? undefined : json['sms_phone_number'],
         'status': !exists(json, 'status') ? undefined : json['status'],
         'status_dts': !exists(json, 'status_dts') ? undefined : json['status_dts'],
         'storefront_oid': !exists(json, 'storefront_oid') ? undefined : json['storefront_oid'],
@@ -239,6 +253,8 @@ export function EmailCampaignToJSON(value?: EmailCampaign | null): any {
         'revenue_per_customer_formatted': value.revenue_per_customer_formatted,
         'scheduled_dts': value.scheduled_dts,
         'screenshot_large_full_url': value.screenshot_large_full_url,
+        'sms_esp_twilio_uuid': value.sms_esp_twilio_uuid,
+        'sms_phone_number': value.sms_phone_number,
         'status': value.status,
         'status_dts': value.status_dts,
         'storefront_oid': value.storefront_oid,

package/src/models/EmailFlow.ts

@@ -151,6 +151,18 @@ export interface EmailFlow {
      * @memberof EmailFlow
      */
     screenshot_large_full_url?: string;
+    /**
+     * Twilio Account UUID.  Null for none
+     * @type {string}
+     * @memberof EmailFlow
+     */
+    sms_esp_twilio_uuid?: string;
+    /**
+     * Twilio SMS Phone Number.  Null for none
+     * @type {string}
+     * @memberof EmailFlow
+     */
+    sms_phone_number?: string;
     /**
      * Status of the campaign of draft, archived, active, and inactive
      * @type {string}
@@ -221,6 +233,8 @@ export function EmailFlowFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'revenue_formatted': !exists(json, 'revenue_formatted') ? undefined : json['revenue_formatted'],
         'revenue_per_customer_formatted': !exists(json, 'revenue_per_customer_formatted') ? undefined : json['revenue_per_customer_formatted'],
         'screenshot_large_full_url': !exists(json, 'screenshot_large_full_url') ? undefined : json['screenshot_large_full_url'],
+        'sms_esp_twilio_uuid': !exists(json, 'sms_esp_twilio_uuid') ? undefined : json['sms_esp_twilio_uuid'],
+        'sms_phone_number': !exists(json, 'sms_phone_number') ? undefined : json['sms_phone_number'],
         'status': !exists(json, 'status') ? undefined : json['status'],
         'status_dts': !exists(json, 'status_dts') ? undefined : json['status_dts'],
         'storefront_oid': !exists(json, 'storefront_oid') ? undefined : json['storefront_oid'],
@@ -261,6 +275,8 @@ export function EmailFlowToJSON(value?: EmailFlow | null): any {
         'revenue_formatted': value.revenue_formatted,
         'revenue_per_customer_formatted': value.revenue_per_customer_formatted,
         'screenshot_large_full_url': value.screenshot_large_full_url,
+        'sms_esp_twilio_uuid': value.sms_esp_twilio_uuid,
+        'sms_phone_number': value.sms_phone_number,
         'status': value.status,
         'status_dts': value.status_dts,
         'storefront_oid': value.storefront_oid,

package/src/models/EmailSettings.ts

@@ -73,6 +73,18 @@ export interface EmailSettings {
      * @memberof EmailSettings
      */
     postcard_from_state?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailSettings
+     */
+    sms_esp_twilio_uuid?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailSettings
+     */
+    sms_phone_number?: string;
     /**
      * 
      * @type {string}
@@ -112,6 +124,8 @@ export function EmailSettingsFromJSONTyped(json: any, ignoreDiscriminator: boole
         'postcard_from_name': !exists(json, 'postcard_from_name') ? undefined : json['postcard_from_name'],
         'postcard_from_postal_code': !exists(json, 'postcard_from_postal_code') ? undefined : json['postcard_from_postal_code'],
         'postcard_from_state': !exists(json, 'postcard_from_state') ? undefined : json['postcard_from_state'],
+        'sms_esp_twilio_uuid': !exists(json, 'sms_esp_twilio_uuid') ? undefined : json['sms_esp_twilio_uuid'],
+        'sms_phone_number': !exists(json, 'sms_phone_number') ? undefined : json['sms_phone_number'],
         'transactional_esp_domain_user': !exists(json, 'transactional_esp_domain_user') ? undefined : json['transactional_esp_domain_user'],
         'transactional_esp_domain_uuid': !exists(json, 'transactional_esp_domain_uuid') ? undefined : json['transactional_esp_domain_uuid'],
         'transactional_esp_friendly_name': !exists(json, 'transactional_esp_friendly_name') ? undefined : json['transactional_esp_friendly_name'],
@@ -136,6 +150,8 @@ export function EmailSettingsToJSON(value?: EmailSettings | null): any {
         'postcard_from_name': value.postcard_from_name,
         'postcard_from_postal_code': value.postcard_from_postal_code,
         'postcard_from_state': value.postcard_from_state,
+        'sms_esp_twilio_uuid': value.sms_esp_twilio_uuid,
+        'sms_phone_number': value.sms_phone_number,
         'transactional_esp_domain_user': value.transactional_esp_domain_user,
         'transactional_esp_domain_uuid': value.transactional_esp_domain_uuid,
         'transactional_esp_friendly_name': value.transactional_esp_friendly_name,

package/src/models/RulerValidationRequest.ts

@@ -0,0 +1,56 @@
+/* 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 RulerValidationRequest
+ */
+export interface RulerValidationRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RulerValidationRequest
+     */
+    ruler?: string;
+}
+
+export function RulerValidationRequestFromJSON(json: any): RulerValidationRequest {
+    return RulerValidationRequestFromJSONTyped(json, false);
+}
+
+export function RulerValidationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RulerValidationRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'ruler': !exists(json, 'ruler') ? undefined : json['ruler'],
+    };
+}
+
+export function RulerValidationRequestToJSON(value?: RulerValidationRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'ruler': value.ruler,
+    };
+}
+

package/src/models/RulerValidationResponse.ts

@@ -0,0 +1,64 @@
+/* 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 RulerValidationResponse
+ */
+export interface RulerValidationResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof RulerValidationResponse
+     */
+    error_message?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RulerValidationResponse
+     */
+    valid?: boolean;
+}
+
+export function RulerValidationResponseFromJSON(json: any): RulerValidationResponse {
+    return RulerValidationResponseFromJSONTyped(json, false);
+}
+
+export function RulerValidationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RulerValidationResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error_message': !exists(json, 'error_message') ? undefined : json['error_message'],
+        'valid': !exists(json, 'valid') ? undefined : json['valid'],
+    };
+}
+
+export function RulerValidationResponseToJSON(value?: RulerValidationResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error_message': value.error_message,
+        'valid': value.valid,
+    };
+}
+

package/src/models/index.ts

@@ -550,6 +550,8 @@ export * from './RegisterAffiliateClickRequest';
 export * from './RegisterAffiliateClickResponse';
 export * from './ResponseMetadata';
 export * from './ResultSet';
+export * from './RulerValidationRequest';
+export * from './RulerValidationResponse';
 export * from './ScreenRecording';
 export * from './ScreenRecordingAdPlatform';
 export * from './ScreenRecordingFilter';