ultracart_rest_api_v2_typescript 3.10.199 → 3.10.201

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.199
+## ultracart_rest_api_v2_typescript@3.10.201
 
 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@3.10.199 --save
+npm install ultracart_rest_api_v2_typescript@3.10.201 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.201 | 05/14/2024 | conversation pbx - allowed value constants on the action |
+| 3.10.200 | 05/13/2024 | conversation pbx - bug fix on camelCase property names |
 | 3.10.199 | 05/13/2024 | conversation pbx - allow nullable day of week in time range |
 | 3.10.198 | 05/08/2024 | added echeck fields to channel partner order import |
 | 3.10.197 | 05/02/2024 | conversation - new method to load pbx audio usage |

package/api.ts

@@ -9264,9 +9264,9 @@ export interface ConversationPbxMenuMapping {
      * @type {string}
      * @memberof ConversationPbxMenuMapping
      */
-    action?: string;
+    action?: ConversationPbxMenuMapping.ActionEnum;
     /**
-     * Action target
+     * Action target.  This is the UUID associated with the configuration object of that particular type.
      * @type {string}
      * @memberof ConversationPbxMenuMapping
      */
@@ -9285,6 +9285,24 @@ export interface ConversationPbxMenuMapping {
     speech?: string;
 }
 
+/**
+ * @export
+ * @namespace ConversationPbxMenuMapping
+ */
+export namespace ConversationPbxMenuMapping {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum ActionEnum {
+        TimeBased = <any> 'time based',
+        Menu = <any> 'menu',
+        Queue = <any> 'queue',
+        Voicemail = <any> 'voicemail',
+        Agent = <any> 'agent'
+    }
+}
+
 /**
  * 
  * @export
@@ -9372,9 +9390,9 @@ export interface ConversationPbxPhoneNumber {
      * @type {string}
      * @memberof ConversationPbxPhoneNumber
      */
-    action?: string;
+    action?: ConversationPbxPhoneNumber.ActionEnum;
     /**
-     * Action target
+     * Action target.  This is the UUID associated with the configuration object of that particular type.
      * @type {string}
      * @memberof ConversationPbxPhoneNumber
      */
@@ -9399,6 +9417,24 @@ export interface ConversationPbxPhoneNumber {
     phone_number?: string;
 }
 
+/**
+ * @export
+ * @namespace ConversationPbxPhoneNumber
+ */
+export namespace ConversationPbxPhoneNumber {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum ActionEnum {
+        TimeBased = <any> 'time based',
+        Menu = <any> 'menu',
+        Queue = <any> 'queue',
+        Voicemail = <any> 'voicemail',
+        Agent = <any> 'agent'
+    }
+}
+
 /**
  * 
  * @export
@@ -9716,25 +9752,25 @@ export interface ConversationPbxTimeBased {
      * @type {string}
      * @memberof ConversationPbxTimeBased
      */
-    conversationPbxTimeBasedUuid?: string;
+    conversation_pbx_time_based_uuid?: string;
     /**
      * 
      * @type {ConversationPbxTimeBasedMappingConfig}
      * @memberof ConversationPbxTimeBased
      */
-    mappingConfig?: ConversationPbxTimeBasedMappingConfig;
+    mapping_config?: ConversationPbxTimeBasedMappingConfig;
     /**
      * 
      * @type {string}
      * @memberof ConversationPbxTimeBased
      */
-    merchantId?: string;
+    merchant_id?: string;
     /**
      * 
      * @type {string}
      * @memberof ConversationPbxTimeBased
      */
-    timeBasedName?: string;
+    time_based_name?: string;
 }
 
 /**
@@ -9748,9 +9784,9 @@ export interface ConversationPbxTimeBasedMapping {
      * @type {string}
      * @memberof ConversationPbxTimeBasedMapping
      */
-    action?: string;
+    action?: ConversationPbxTimeBasedMapping.ActionEnum;
     /**
-     * Action target
+     * Action target.  This is the UUID associated with the configuration object of that particular type.
      * @type {string}
      * @memberof ConversationPbxTimeBasedMapping
      */
@@ -9769,6 +9805,24 @@ export interface ConversationPbxTimeBasedMapping {
     time_range_uuid?: string;
 }
 
+/**
+ * @export
+ * @namespace ConversationPbxTimeBasedMapping
+ */
+export namespace ConversationPbxTimeBasedMapping {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum ActionEnum {
+        TimeBased = <any> 'time based',
+        Menu = <any> 'menu',
+        Queue = <any> 'queue',
+        Voicemail = <any> 'voicemail',
+        Agent = <any> 'agent'
+    }
+}
+
 /**
  * 
  * @export

package/dist/api.d.ts

@@ -9045,9 +9045,9 @@ export interface ConversationPbxMenuMapping {
      * @type {string}
      * @memberof ConversationPbxMenuMapping
      */
-    action?: string;
+    action?: ConversationPbxMenuMapping.ActionEnum;
     /**
-     * Action target
+     * Action target.  This is the UUID associated with the configuration object of that particular type.
      * @type {string}
      * @memberof ConversationPbxMenuMapping
      */
@@ -9065,6 +9065,23 @@ export interface ConversationPbxMenuMapping {
      */
     speech?: string;
 }
+/**
+ * @export
+ * @namespace ConversationPbxMenuMapping
+ */
+export declare namespace ConversationPbxMenuMapping {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum ActionEnum {
+        TimeBased,
+        Menu,
+        Queue,
+        Voicemail,
+        Agent
+    }
+}
 /**
  *
  * @export
@@ -9150,9 +9167,9 @@ export interface ConversationPbxPhoneNumber {
      * @type {string}
      * @memberof ConversationPbxPhoneNumber
      */
-    action?: string;
+    action?: ConversationPbxPhoneNumber.ActionEnum;
     /**
-     * Action target
+     * Action target.  This is the UUID associated with the configuration object of that particular type.
      * @type {string}
      * @memberof ConversationPbxPhoneNumber
      */
@@ -9176,6 +9193,23 @@ export interface ConversationPbxPhoneNumber {
      */
     phone_number?: string;
 }
+/**
+ * @export
+ * @namespace ConversationPbxPhoneNumber
+ */
+export declare namespace ConversationPbxPhoneNumber {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum ActionEnum {
+        TimeBased,
+        Menu,
+        Queue,
+        Voicemail,
+        Agent
+    }
+}
 /**
  *
  * @export
@@ -9487,25 +9521,25 @@ export interface ConversationPbxTimeBased {
      * @type {string}
      * @memberof ConversationPbxTimeBased
      */
-    conversationPbxTimeBasedUuid?: string;
+    conversation_pbx_time_based_uuid?: string;
     /**
      *
      * @type {ConversationPbxTimeBasedMappingConfig}
      * @memberof ConversationPbxTimeBased
      */
-    mappingConfig?: ConversationPbxTimeBasedMappingConfig;
+    mapping_config?: ConversationPbxTimeBasedMappingConfig;
     /**
      *
      * @type {string}
      * @memberof ConversationPbxTimeBased
      */
-    merchantId?: string;
+    merchant_id?: string;
     /**
      *
      * @type {string}
      * @memberof ConversationPbxTimeBased
      */
-    timeBasedName?: string;
+    time_based_name?: string;
 }
 /**
  *
@@ -9518,9 +9552,9 @@ export interface ConversationPbxTimeBasedMapping {
      * @type {string}
      * @memberof ConversationPbxTimeBasedMapping
      */
-    action?: string;
+    action?: ConversationPbxTimeBasedMapping.ActionEnum;
     /**
-     * Action target
+     * Action target.  This is the UUID associated with the configuration object of that particular type.
      * @type {string}
      * @memberof ConversationPbxTimeBasedMapping
      */
@@ -9538,6 +9572,23 @@ export interface ConversationPbxTimeBasedMapping {
      */
     time_range_uuid?: string;
 }
+/**
+ * @export
+ * @namespace ConversationPbxTimeBasedMapping
+ */
+export declare namespace ConversationPbxTimeBasedMapping {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum ActionEnum {
+        TimeBased,
+        Menu,
+        Queue,
+        Voicemail,
+        Agent
+    }
+}
 /**
  *
  * @export

package/dist/api.js

@@ -28,10 +28,10 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.Coupon = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationPbxVoicemailMessageSummary = exports.ConversationPbxVoicemailMessage = exports.ConversationPbxVoicemailMailbox = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
-exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = void 0;
-exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = void 0;
-exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = void 0;
+exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.Coupon = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationPbxVoicemailMessageSummary = exports.ConversationPbxVoicemailMessage = exports.ConversationPbxVoicemailMailbox = exports.ConversationPbxTimeBasedMapping = exports.ConversationPbxPhoneNumber = exports.ConversationPbxMenuMapping = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
+exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = void 0;
+exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = void 0;
+exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = void 0;
 var url = require("url");
 var portableFetch = require("portable-fetch");
 var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -581,6 +581,63 @@ var ConversationMessageTransportStatus;
         StatusEnum[StatusEnum["PINPOINTERROR"] = 'PINPOINT_ERROR'] = "PINPOINTERROR";
     })(StatusEnum = ConversationMessageTransportStatus.StatusEnum || (ConversationMessageTransportStatus.StatusEnum = {}));
 })(ConversationMessageTransportStatus = exports.ConversationMessageTransportStatus || (exports.ConversationMessageTransportStatus = {}));
+/**
+ * @export
+ * @namespace ConversationPbxMenuMapping
+ */
+var ConversationPbxMenuMapping;
+(function (ConversationPbxMenuMapping) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var ActionEnum;
+    (function (ActionEnum) {
+        ActionEnum[ActionEnum["TimeBased"] = 'time based'] = "TimeBased";
+        ActionEnum[ActionEnum["Menu"] = 'menu'] = "Menu";
+        ActionEnum[ActionEnum["Queue"] = 'queue'] = "Queue";
+        ActionEnum[ActionEnum["Voicemail"] = 'voicemail'] = "Voicemail";
+        ActionEnum[ActionEnum["Agent"] = 'agent'] = "Agent";
+    })(ActionEnum = ConversationPbxMenuMapping.ActionEnum || (ConversationPbxMenuMapping.ActionEnum = {}));
+})(ConversationPbxMenuMapping = exports.ConversationPbxMenuMapping || (exports.ConversationPbxMenuMapping = {}));
+/**
+ * @export
+ * @namespace ConversationPbxPhoneNumber
+ */
+var ConversationPbxPhoneNumber;
+(function (ConversationPbxPhoneNumber) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var ActionEnum;
+    (function (ActionEnum) {
+        ActionEnum[ActionEnum["TimeBased"] = 'time based'] = "TimeBased";
+        ActionEnum[ActionEnum["Menu"] = 'menu'] = "Menu";
+        ActionEnum[ActionEnum["Queue"] = 'queue'] = "Queue";
+        ActionEnum[ActionEnum["Voicemail"] = 'voicemail'] = "Voicemail";
+        ActionEnum[ActionEnum["Agent"] = 'agent'] = "Agent";
+    })(ActionEnum = ConversationPbxPhoneNumber.ActionEnum || (ConversationPbxPhoneNumber.ActionEnum = {}));
+})(ConversationPbxPhoneNumber = exports.ConversationPbxPhoneNumber || (exports.ConversationPbxPhoneNumber = {}));
+/**
+ * @export
+ * @namespace ConversationPbxTimeBasedMapping
+ */
+var ConversationPbxTimeBasedMapping;
+(function (ConversationPbxTimeBasedMapping) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var ActionEnum;
+    (function (ActionEnum) {
+        ActionEnum[ActionEnum["TimeBased"] = 'time based'] = "TimeBased";
+        ActionEnum[ActionEnum["Menu"] = 'menu'] = "Menu";
+        ActionEnum[ActionEnum["Queue"] = 'queue'] = "Queue";
+        ActionEnum[ActionEnum["Voicemail"] = 'voicemail'] = "Voicemail";
+        ActionEnum[ActionEnum["Agent"] = 'agent'] = "Agent";
+    })(ActionEnum = ConversationPbxTimeBasedMapping.ActionEnum || (ConversationPbxTimeBasedMapping.ActionEnum = {}));
+})(ConversationPbxTimeBasedMapping = exports.ConversationPbxTimeBasedMapping || (exports.ConversationPbxTimeBasedMapping = {}));
 /**
  * @export
  * @namespace ConversationPbxVoicemailMailbox

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.199",
+  "version": "3.10.201",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [