ultracart_rest_api_v2_typescript 3.10.119 → 3.10.121

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +4 -2
  2. package/api.ts +79 -0
  3. package/dist/api.d.ts +77 -0
  4. package/dist/api.js +21 -3
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.10.119
1
+ ## ultracart_rest_api_v2_typescript@3.10.121
2
2
 
3
3
  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:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install ultracart_rest_api_v2_typescript@3.10.119 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.121 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.121 | 03/01/2023 | convo - add sentiment record to conversation obj |
58
+ | 3.10.120 | 02/22/2023 | convo - customer initiated flag on engagement |
57
59
  | 3.10.119 | 02/20/2023 | refund reasons |
58
60
  | 3.10.118 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
59
61
  | 3.10.117 | 02/15/2023 | added auto order sorting by next_shipment_dts |
package/api.ts CHANGED
@@ -6655,6 +6655,12 @@ export interface Conversation {
6655
6655
  * @memberof Conversation
6656
6656
  */
6657
6657
  participants?: Array<ConversationParticipant>;
6658
+ /**
6659
+ *
6660
+ * @type {ConversationSentiment}
6661
+ * @memberof Conversation
6662
+ */
6663
+ sentiment?: ConversationSentiment;
6658
6664
  /**
6659
6665
  * Start of the conversation date/time
6660
6666
  * @type {string}
@@ -7304,6 +7310,12 @@ export interface ConversationEngagement {
7304
7310
  * @memberof ConversationEngagement
7305
7311
  */
7306
7312
  customer_greeting?: string;
7313
+ /**
7314
+ *
7315
+ * @type {boolean}
7316
+ * @memberof ConversationEngagement
7317
+ */
7318
+ customer_initiated?: boolean;
7307
7319
  /**
7308
7320
  *
7309
7321
  * @type {Array<number>}
@@ -8500,6 +8512,67 @@ export interface ConversationSearchResponse {
8500
8512
  total?: number;
8501
8513
  }
8502
8514
 
8515
+ /**
8516
+ *
8517
+ * @export
8518
+ * @interface ConversationSentiment
8519
+ */
8520
+ export interface ConversationSentiment {
8521
+ /**
8522
+ * The last time the detect sentiment was run on this conversation
8523
+ * @type {string}
8524
+ * @memberof ConversationSentiment
8525
+ */
8526
+ last_detect_sentiment?: string;
8527
+ /**
8528
+ * The mixed score
8529
+ * @type {number}
8530
+ * @memberof ConversationSentiment
8531
+ */
8532
+ mixed?: number;
8533
+ /**
8534
+ * The negative score
8535
+ * @type {number}
8536
+ * @memberof ConversationSentiment
8537
+ */
8538
+ negative?: number;
8539
+ /**
8540
+ * The neutral score
8541
+ * @type {number}
8542
+ * @memberof ConversationSentiment
8543
+ */
8544
+ neutral?: number;
8545
+ /**
8546
+ * The positive score
8547
+ * @type {number}
8548
+ * @memberof ConversationSentiment
8549
+ */
8550
+ positive?: number;
8551
+ /**
8552
+ * The overall sentiment
8553
+ * @type {string}
8554
+ * @memberof ConversationSentiment
8555
+ */
8556
+ sentiment?: ConversationSentiment.SentimentEnum;
8557
+ }
8558
+
8559
+ /**
8560
+ * @export
8561
+ * @namespace ConversationSentiment
8562
+ */
8563
+ export namespace ConversationSentiment {
8564
+ /**
8565
+ * @export
8566
+ * @enum {string}
8567
+ */
8568
+ export enum SentimentEnum {
8569
+ POSITIVE = <any> 'POSITIVE',
8570
+ NEUTRAL = <any> 'NEUTRAL',
8571
+ NEGATIVE = <any> 'NEGATIVE',
8572
+ MIXED = <any> 'MIXED'
8573
+ }
8574
+ }
8575
+
8503
8576
  /**
8504
8577
  *
8505
8578
  * @export
@@ -8624,6 +8697,12 @@ export interface ConversationSummary {
8624
8697
  * @memberof ConversationSummary
8625
8698
  */
8626
8699
  participants?: Array<ConversationParticipant>;
8700
+ /**
8701
+ *
8702
+ * @type {ConversationSentiment}
8703
+ * @memberof ConversationSummary
8704
+ */
8705
+ sentiment?: ConversationSentiment;
8627
8706
  /**
8628
8707
  * Start of the conversation date/time
8629
8708
  * @type {string}
package/dist/api.d.ts CHANGED
@@ -6502,6 +6502,12 @@ export interface Conversation {
6502
6502
  * @memberof Conversation
6503
6503
  */
6504
6504
  participants?: Array<ConversationParticipant>;
6505
+ /**
6506
+ *
6507
+ * @type {ConversationSentiment}
6508
+ * @memberof Conversation
6509
+ */
6510
+ sentiment?: ConversationSentiment;
6505
6511
  /**
6506
6512
  * Start of the conversation date/time
6507
6513
  * @type {string}
@@ -7131,6 +7137,12 @@ export interface ConversationEngagement {
7131
7137
  * @memberof ConversationEngagement
7132
7138
  */
7133
7139
  customer_greeting?: string;
7140
+ /**
7141
+ *
7142
+ * @type {boolean}
7143
+ * @memberof ConversationEngagement
7144
+ */
7145
+ customer_initiated?: boolean;
7134
7146
  /**
7135
7147
  *
7136
7148
  * @type {Array<number>}
@@ -8293,6 +8305,65 @@ export interface ConversationSearchResponse {
8293
8305
  */
8294
8306
  total?: number;
8295
8307
  }
8308
+ /**
8309
+ *
8310
+ * @export
8311
+ * @interface ConversationSentiment
8312
+ */
8313
+ export interface ConversationSentiment {
8314
+ /**
8315
+ * The last time the detect sentiment was run on this conversation
8316
+ * @type {string}
8317
+ * @memberof ConversationSentiment
8318
+ */
8319
+ last_detect_sentiment?: string;
8320
+ /**
8321
+ * The mixed score
8322
+ * @type {number}
8323
+ * @memberof ConversationSentiment
8324
+ */
8325
+ mixed?: number;
8326
+ /**
8327
+ * The negative score
8328
+ * @type {number}
8329
+ * @memberof ConversationSentiment
8330
+ */
8331
+ negative?: number;
8332
+ /**
8333
+ * The neutral score
8334
+ * @type {number}
8335
+ * @memberof ConversationSentiment
8336
+ */
8337
+ neutral?: number;
8338
+ /**
8339
+ * The positive score
8340
+ * @type {number}
8341
+ * @memberof ConversationSentiment
8342
+ */
8343
+ positive?: number;
8344
+ /**
8345
+ * The overall sentiment
8346
+ * @type {string}
8347
+ * @memberof ConversationSentiment
8348
+ */
8349
+ sentiment?: ConversationSentiment.SentimentEnum;
8350
+ }
8351
+ /**
8352
+ * @export
8353
+ * @namespace ConversationSentiment
8354
+ */
8355
+ export declare namespace ConversationSentiment {
8356
+ /**
8357
+ * @export
8358
+ * @enum {string}
8359
+ */
8360
+ enum SentimentEnum {
8361
+ POSITIVE,
8362
+ NEUTRAL,
8363
+ NEGATIVE,
8364
+ MIXED
8365
+ }
8366
+ }
8296
8367
  /**
8297
8368
  *
8298
8369
  * @export
@@ -8415,6 +8486,12 @@ export interface ConversationSummary {
8415
8486
  * @memberof ConversationSummary
8416
8487
  */
8417
8488
  participants?: Array<ConversationParticipant>;
8489
+ /**
8490
+ *
8491
+ * @type {ConversationSentiment}
8492
+ * @memberof ConversationSummary
8493
+ */
8494
+ sentiment?: ConversationSentiment;
8418
8495
  /**
8419
8496
  * Start of the conversation date/time
8420
8497
  * @type {string}
package/dist/api.js CHANGED
@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
28
28
  };
29
29
  })();
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
- 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.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = 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;
32
- 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 = exports.Webhook = exports.TempMultimedia = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = void 0;
33
- 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 = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = void 0;
31
+ 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.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationSummary = exports.ConversationSentiment = 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;
32
+ 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 = exports.Webhook = exports.TempMultimedia = exports.PointOfSaleReader = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = void 0;
33
+ 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 = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = void 0;
34
34
  var url = require("url");
35
35
  var portableFetch = require("portable-fetch");
36
36
  var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -551,6 +551,24 @@ var ConversationMessageTransportStatus;
551
551
  StatusEnum[StatusEnum["PINPOINTERROR"] = 'PINPOINT_ERROR'] = "PINPOINTERROR";
552
552
  })(StatusEnum = ConversationMessageTransportStatus.StatusEnum || (ConversationMessageTransportStatus.StatusEnum = {}));
553
553
  })(ConversationMessageTransportStatus = exports.ConversationMessageTransportStatus || (exports.ConversationMessageTransportStatus = {}));
554
+ /**
555
+ * @export
556
+ * @namespace ConversationSentiment
557
+ */
558
+ var ConversationSentiment;
559
+ (function (ConversationSentiment) {
560
+ /**
561
+ * @export
562
+ * @enum {string}
563
+ */
564
+ var SentimentEnum;
565
+ (function (SentimentEnum) {
566
+ SentimentEnum[SentimentEnum["POSITIVE"] = 'POSITIVE'] = "POSITIVE";
567
+ SentimentEnum[SentimentEnum["NEUTRAL"] = 'NEUTRAL'] = "NEUTRAL";
568
+ SentimentEnum[SentimentEnum["NEGATIVE"] = 'NEGATIVE'] = "NEGATIVE";
569
+ SentimentEnum[SentimentEnum["MIXED"] = 'MIXED'] = "MIXED";
570
+ })(SentimentEnum = ConversationSentiment.SentimentEnum || (ConversationSentiment.SentimentEnum = {}));
571
+ })(ConversationSentiment = exports.ConversationSentiment || (exports.ConversationSentiment = {}));
554
572
  /**
555
573
  * @export
556
574
  * @namespace ConversationSummary
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.119",
3
+ "version": "3.10.121",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [