ultracart_rest_api_v2_typescript 3.10.35 → 3.10.36

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.35
+## ultracart_rest_api_v2_typescript@3.10.36
 
 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.35 --save
+npm install ultracart_rest_api_v2_typescript@3.10.36 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.36 | 08/10/2022 | conversation event refactoring |
 | 3.10.35 | 08/05/2022 | conversation adjustments for ES integration |
 | 3.10.34 | 08/05/2022 | conversations query by medium and stats fixes |
 | 3.10.33 | 08/03/2022 | conversation summary participants |

package/api.ts

@@ -6533,6 +6533,32 @@ export namespace ConversationEventRRWeb {
     }
 }
 
+/**
+ * 
+ * @export
+ * @interface ConversationEventReadMessage
+ */
+export interface ConversationEventReadMessage {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConversationEventReadMessage
+     */
+    conversation_message_uuid?: string;
+    /**
+     * Message date/time
+     * @type {string}
+     * @memberof ConversationEventReadMessage
+     */
+    message_dts?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationEventReadMessage
+     */
+    message_epoch?: number;
+}
+
 /**
  * 
  * @export
@@ -6613,6 +6639,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     message_dts?: string;
+    /**
+     * Message epoch milliseconds
+     * @type {number}
+     * @memberof ConversationMessage
+     */
+    message_epoch?: number;
     /**
      * 
      * @type {Array<ConversationMessageTransportStatus>}
@@ -6661,11 +6693,35 @@ export interface ConversationMessageTransportStatus {
      */
     conversation_participant_arn?: string;
     /**
-     * 
+     * The status of the message transport
      * @type {string}
      * @memberof ConversationMessageTransportStatus
      */
-    status?: string;
+    status?: ConversationMessageTransportStatus.StatusEnum;
+}
+
+/**
+ * @export
+ * @namespace ConversationMessageTransportStatus
+ */
+export namespace ConversationMessageTransportStatus {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum StatusEnum {
+        Accepted = <any> 'accepted',
+        Scheduled = <any> 'scheduled',
+        Queued = <any> 'queued',
+        Sending = <any> 'sending',
+        Sent = <any> 'sent',
+        Read = <any> 'read',
+        TWILIOCREDENTIALSMISSING = <any> 'TWILIO_CREDENTIALS_MISSING',
+        SENTTOTWILIO = <any> 'SENT_TO_TWILIO',
+        TWILIOERROR = <any> 'TWILIO_ERROR',
+        SENTTOPINPOINT = <any> 'SENT_TO_PINPOINT',
+        PINPOINTERROR = <any> 'PINPOINT_ERROR'
+    }
 }
 
 /**
@@ -6774,6 +6830,12 @@ export interface ConversationParticipant {
      * @memberof ConversationParticipant
      */
     status?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationParticipant
+     */
+    unread_messages?: number;
 }
 
 /**
@@ -7261,6 +7323,12 @@ export interface ConversationWebsocketMessage {
      * @memberof ConversationWebsocketMessage
      */
     event_queue_status_update?: ConversationWebchatQueueStatus;
+    /**
+     * 
+     * @type {ConversationEventReadMessage}
+     * @memberof ConversationWebsocketMessage
+     */
+    event_read_message?: ConversationEventReadMessage;
     /**
      * 
      * @type {ConversationEventRRWeb}
@@ -7317,7 +7385,8 @@ export namespace ConversationWebsocketMessage {
         UpdatedMessage = <any> 'updated message',
         QueueStatusUpdate = <any> 'queue status update',
         Rrweb = <any> 'rrweb',
-        ParticipantUpdate = <any> 'participant update'
+        ParticipantUpdate = <any> 'participant update',
+        ReadMessage = <any> 'read message'
     }
     /**
      * @export
@@ -8827,6 +8896,12 @@ export interface CouponMultipleAmountsOffItems {
  * @interface CouponNoDiscount
  */
 export interface CouponNoDiscount {
+    /**
+     * This property does nothing but is included in this object to ensure the object is generated by our sdk builders.
+     * @type {boolean}
+     * @memberof CouponNoDiscount
+     */
+    ignore_this_property?: boolean;
 }
 
 /**

package/dist/api.d.ts

@@ -6379,6 +6379,31 @@ export declare namespace ConversationEventRRWeb {
         Events
     }
 }
+/**
+ *
+ * @export
+ * @interface ConversationEventReadMessage
+ */
+export interface ConversationEventReadMessage {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationEventReadMessage
+     */
+    conversation_message_uuid?: string;
+    /**
+     * Message date/time
+     * @type {string}
+     * @memberof ConversationEventReadMessage
+     */
+    message_dts?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationEventReadMessage
+     */
+    message_epoch?: number;
+}
 /**
  *
  * @export
@@ -6458,6 +6483,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     message_dts?: string;
+    /**
+     * Message epoch milliseconds
+     * @type {number}
+     * @memberof ConversationMessage
+     */
+    message_epoch?: number;
     /**
      *
      * @type {Array<ConversationMessageTransportStatus>}
@@ -6504,11 +6535,34 @@ export interface ConversationMessageTransportStatus {
      */
     conversation_participant_arn?: string;
     /**
-     *
+     * The status of the message transport
      * @type {string}
      * @memberof ConversationMessageTransportStatus
      */
-    status?: string;
+    status?: ConversationMessageTransportStatus.StatusEnum;
+}
+/**
+ * @export
+ * @namespace ConversationMessageTransportStatus
+ */
+export declare namespace ConversationMessageTransportStatus {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum StatusEnum {
+        Accepted,
+        Scheduled,
+        Queued,
+        Sending,
+        Sent,
+        Read,
+        TWILIOCREDENTIALSMISSING,
+        SENTTOTWILIO,
+        TWILIOERROR,
+        SENTTOPINPOINT,
+        PINPOINTERROR
+    }
 }
 /**
  *
@@ -6614,6 +6668,12 @@ export interface ConversationParticipant {
      * @memberof ConversationParticipant
      */
     status?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationParticipant
+     */
+    unread_messages?: number;
 }
 /**
  *
@@ -7089,6 +7149,12 @@ export interface ConversationWebsocketMessage {
      * @memberof ConversationWebsocketMessage
      */
     event_queue_status_update?: ConversationWebchatQueueStatus;
+    /**
+     *
+     * @type {ConversationEventReadMessage}
+     * @memberof ConversationWebsocketMessage
+     */
+    event_read_message?: ConversationEventReadMessage;
     /**
      *
      * @type {ConversationEventRRWeb}
@@ -7144,7 +7210,8 @@ export declare namespace ConversationWebsocketMessage {
         UpdatedMessage,
         QueueStatusUpdate,
         Rrweb,
-        ParticipantUpdate
+        ParticipantUpdate,
+        ReadMessage
     }
     /**
      * @export
@@ -8616,6 +8683,12 @@ export interface CouponMultipleAmountsOffItems {
  * @interface CouponNoDiscount
  */
 export interface CouponNoDiscount {
+    /**
+     * This property does nothing but is included in this object to ensure the object is generated by our sdk builders.
+     * @type {boolean}
+     * @memberof CouponNoDiscount
+     */
+    ignore_this_property?: boolean;
 }
 /**
  *

package/dist/api.js

@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Weight = exports.Webhook = exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationSummary = exports.ConversationMessage = exports.ConversationEventRRWeb = 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.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.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = 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 = void 0;
-exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = 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 = void 0;
+exports.Webhook = exports.TempMultimedia = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.ConversationWebsocketMessage = exports.ConversationSummary = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationEventRRWeb = 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.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.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = 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.Weight = void 0;
+exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = 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 = void 0;
 var url = require("url");
 var portableFetch = require("portable-fetch");
 var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -407,6 +407,31 @@ var ConversationMessage;
         TypeEnum[TypeEnum["Notice"] = 'notice'] = "Notice";
     })(TypeEnum = ConversationMessage.TypeEnum || (ConversationMessage.TypeEnum = {}));
 })(ConversationMessage = exports.ConversationMessage || (exports.ConversationMessage = {}));
+/**
+ * @export
+ * @namespace ConversationMessageTransportStatus
+ */
+var ConversationMessageTransportStatus;
+(function (ConversationMessageTransportStatus) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var StatusEnum;
+    (function (StatusEnum) {
+        StatusEnum[StatusEnum["Accepted"] = 'accepted'] = "Accepted";
+        StatusEnum[StatusEnum["Scheduled"] = 'scheduled'] = "Scheduled";
+        StatusEnum[StatusEnum["Queued"] = 'queued'] = "Queued";
+        StatusEnum[StatusEnum["Sending"] = 'sending'] = "Sending";
+        StatusEnum[StatusEnum["Sent"] = 'sent'] = "Sent";
+        StatusEnum[StatusEnum["Read"] = 'read'] = "Read";
+        StatusEnum[StatusEnum["TWILIOCREDENTIALSMISSING"] = 'TWILIO_CREDENTIALS_MISSING'] = "TWILIOCREDENTIALSMISSING";
+        StatusEnum[StatusEnum["SENTTOTWILIO"] = 'SENT_TO_TWILIO'] = "SENTTOTWILIO";
+        StatusEnum[StatusEnum["TWILIOERROR"] = 'TWILIO_ERROR'] = "TWILIOERROR";
+        StatusEnum[StatusEnum["SENTTOPINPOINT"] = 'SENT_TO_PINPOINT'] = "SENTTOPINPOINT";
+        StatusEnum[StatusEnum["PINPOINTERROR"] = 'PINPOINT_ERROR'] = "PINPOINTERROR";
+    })(StatusEnum = ConversationMessageTransportStatus.StatusEnum || (ConversationMessageTransportStatus.StatusEnum = {}));
+})(ConversationMessageTransportStatus = exports.ConversationMessageTransportStatus || (exports.ConversationMessageTransportStatus = {}));
 /**
  * @export
  * @namespace ConversationSummary
@@ -444,6 +469,7 @@ var ConversationWebsocketMessage;
         EventTypeEnum[EventTypeEnum["QueueStatusUpdate"] = 'queue status update'] = "QueueStatusUpdate";
         EventTypeEnum[EventTypeEnum["Rrweb"] = 'rrweb'] = "Rrweb";
         EventTypeEnum[EventTypeEnum["ParticipantUpdate"] = 'participant update'] = "ParticipantUpdate";
+        EventTypeEnum[EventTypeEnum["ReadMessage"] = 'read message'] = "ReadMessage";
     })(EventTypeEnum = ConversationWebsocketMessage.EventTypeEnum || (ConversationWebsocketMessage.EventTypeEnum = {}));
     /**
      * @export

package/package.json

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