ultracart_rest_api_v2_typescript 3.11.48 → 3.11.50
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.
- package/README.md +4 -2
- package/api.ts +59 -7
- package/dist/api.d.ts +58 -7
- package/dist/api.js +21 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.11.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.11.50
|
|
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.11.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.11.50 --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.11.50 | 01/27/2026 | conversations - refinements to support hardware phones |
|
|
58
|
+
| 3.11.49 | 01/26/2026 | no changes - testing changes to build automation |
|
|
57
59
|
| 3.11.48 | 01/26/2026 | conversation - hardware phone methods and objects |
|
|
58
60
|
| 3.11.47 | 01/26/2026 | conversation - agent auth object chat admin/user properties |
|
|
59
61
|
| 3.11.46 | 01/26/2026 | cart - expose utm array for use in abandon webhook only |
|
package/api.ts
CHANGED
|
@@ -9578,6 +9578,12 @@ export interface ConversationPbxAgent {
|
|
|
9578
9578
|
* @memberof ConversationPbxAgent
|
|
9579
9579
|
*/
|
|
9580
9580
|
ai?: boolean;
|
|
9581
|
+
/**
|
|
9582
|
+
* The call routing preference
|
|
9583
|
+
* @type {string}
|
|
9584
|
+
* @memberof ConversationPbxAgent
|
|
9585
|
+
*/
|
|
9586
|
+
call_routing_preference?: ConversationPbxAgent.CallRoutingPreferenceEnum;
|
|
9581
9587
|
/**
|
|
9582
9588
|
* Cellphone number of agent in E.164 format
|
|
9583
9589
|
* @type {string}
|
|
@@ -9596,18 +9602,18 @@ export interface ConversationPbxAgent {
|
|
|
9596
9602
|
* @memberof ConversationPbxAgent
|
|
9597
9603
|
*/
|
|
9598
9604
|
extension?: number;
|
|
9599
|
-
/**
|
|
9600
|
-
* True if calls to this agent should be forwarded to their cellphone
|
|
9601
|
-
* @type {boolean}
|
|
9602
|
-
* @memberof ConversationPbxAgent
|
|
9603
|
-
*/
|
|
9604
|
-
forward_calls_to_cellphone?: boolean;
|
|
9605
9605
|
/**
|
|
9606
9606
|
* Full name
|
|
9607
9607
|
* @type {string}
|
|
9608
9608
|
* @memberof ConversationPbxAgent
|
|
9609
9609
|
*/
|
|
9610
9610
|
full_name?: string;
|
|
9611
|
+
/**
|
|
9612
|
+
* Array of hardware phones UUIDs associated with this agent
|
|
9613
|
+
* @type {Array<string>}
|
|
9614
|
+
* @memberof ConversationPbxAgent
|
|
9615
|
+
*/
|
|
9616
|
+
hardware_phone_uuids?: Array<string>;
|
|
9611
9617
|
/**
|
|
9612
9618
|
* Agent login
|
|
9613
9619
|
* @type {string}
|
|
@@ -9626,6 +9632,12 @@ export interface ConversationPbxAgent {
|
|
|
9626
9632
|
* @memberof ConversationPbxAgent
|
|
9627
9633
|
*/
|
|
9628
9634
|
personal_conversation_pbx_voicemail_mailbox_uuid?: string;
|
|
9635
|
+
/**
|
|
9636
|
+
* The hardware phone that will be dialed on an incoming call if routing preference is hardware_phone
|
|
9637
|
+
* @type {string}
|
|
9638
|
+
* @memberof ConversationPbxAgent
|
|
9639
|
+
*/
|
|
9640
|
+
preferred_hardware_phone_uuid?: string;
|
|
9629
9641
|
/**
|
|
9630
9642
|
* True if outgoing calls should be automatically recorded
|
|
9631
9643
|
* @type {boolean}
|
|
@@ -9676,6 +9688,22 @@ export interface ConversationPbxAgent {
|
|
|
9676
9688
|
voicemail?: boolean;
|
|
9677
9689
|
}
|
|
9678
9690
|
|
|
9691
|
+
/**
|
|
9692
|
+
* @export
|
|
9693
|
+
* @namespace ConversationPbxAgent
|
|
9694
|
+
*/
|
|
9695
|
+
export namespace ConversationPbxAgent {
|
|
9696
|
+
/**
|
|
9697
|
+
* @export
|
|
9698
|
+
* @enum {string}
|
|
9699
|
+
*/
|
|
9700
|
+
export enum CallRoutingPreferenceEnum {
|
|
9701
|
+
Softphone = <any> 'softphone',
|
|
9702
|
+
HardwarePhone = <any> 'hardware_phone',
|
|
9703
|
+
Cellphone = <any> 'cellphone'
|
|
9704
|
+
}
|
|
9705
|
+
}
|
|
9706
|
+
|
|
9679
9707
|
/**
|
|
9680
9708
|
*
|
|
9681
9709
|
* @export
|
|
@@ -10239,6 +10267,18 @@ export interface ConversationPbxCustomerSnapshotResponse {
|
|
|
10239
10267
|
* @interface ConversationPbxHardwarePhone
|
|
10240
10268
|
*/
|
|
10241
10269
|
export interface ConversationPbxHardwarePhone {
|
|
10270
|
+
/**
|
|
10271
|
+
* Admin Username
|
|
10272
|
+
* @type {string}
|
|
10273
|
+
* @memberof ConversationPbxHardwarePhone
|
|
10274
|
+
*/
|
|
10275
|
+
admin_username?: string;
|
|
10276
|
+
/**
|
|
10277
|
+
* Associated Agent UUID
|
|
10278
|
+
* @type {string}
|
|
10279
|
+
* @memberof ConversationPbxHardwarePhone
|
|
10280
|
+
*/
|
|
10281
|
+
conversation_pbx_agent_uuid?: string;
|
|
10242
10282
|
/**
|
|
10243
10283
|
* Conversation Pbx Hardware Phone UUID
|
|
10244
10284
|
* @type {string}
|
|
@@ -10300,7 +10340,13 @@ export interface ConversationPbxHardwarePhone {
|
|
|
10300
10340
|
*/
|
|
10301
10341
|
sip_domain?: string;
|
|
10302
10342
|
/**
|
|
10303
|
-
* SIP
|
|
10343
|
+
* SIP Edge Location
|
|
10344
|
+
* @type {string}
|
|
10345
|
+
* @memberof ConversationPbxHardwarePhone
|
|
10346
|
+
*/
|
|
10347
|
+
sip_edge_location?: string;
|
|
10348
|
+
/**
|
|
10349
|
+
* SIP Password (only on create or regenerate password requests)
|
|
10304
10350
|
* @type {string}
|
|
10305
10351
|
* @memberof ConversationPbxHardwarePhone
|
|
10306
10352
|
*/
|
|
@@ -10311,6 +10357,12 @@ export interface ConversationPbxHardwarePhone {
|
|
|
10311
10357
|
* @memberof ConversationPbxHardwarePhone
|
|
10312
10358
|
*/
|
|
10313
10359
|
sip_username?: string;
|
|
10360
|
+
/**
|
|
10361
|
+
* Twilio Credential SID
|
|
10362
|
+
* @type {string}
|
|
10363
|
+
* @memberof ConversationPbxHardwarePhone
|
|
10364
|
+
*/
|
|
10365
|
+
twilio_credential_sid?: string;
|
|
10314
10366
|
/**
|
|
10315
10367
|
* Updated At
|
|
10316
10368
|
* @type {any}
|
package/dist/api.d.ts
CHANGED
|
@@ -9355,6 +9355,12 @@ export interface ConversationPbxAgent {
|
|
|
9355
9355
|
* @memberof ConversationPbxAgent
|
|
9356
9356
|
*/
|
|
9357
9357
|
ai?: boolean;
|
|
9358
|
+
/**
|
|
9359
|
+
* The call routing preference
|
|
9360
|
+
* @type {string}
|
|
9361
|
+
* @memberof ConversationPbxAgent
|
|
9362
|
+
*/
|
|
9363
|
+
call_routing_preference?: ConversationPbxAgent.CallRoutingPreferenceEnum;
|
|
9358
9364
|
/**
|
|
9359
9365
|
* Cellphone number of agent in E.164 format
|
|
9360
9366
|
* @type {string}
|
|
@@ -9373,18 +9379,18 @@ export interface ConversationPbxAgent {
|
|
|
9373
9379
|
* @memberof ConversationPbxAgent
|
|
9374
9380
|
*/
|
|
9375
9381
|
extension?: number;
|
|
9376
|
-
/**
|
|
9377
|
-
* True if calls to this agent should be forwarded to their cellphone
|
|
9378
|
-
* @type {boolean}
|
|
9379
|
-
* @memberof ConversationPbxAgent
|
|
9380
|
-
*/
|
|
9381
|
-
forward_calls_to_cellphone?: boolean;
|
|
9382
9382
|
/**
|
|
9383
9383
|
* Full name
|
|
9384
9384
|
* @type {string}
|
|
9385
9385
|
* @memberof ConversationPbxAgent
|
|
9386
9386
|
*/
|
|
9387
9387
|
full_name?: string;
|
|
9388
|
+
/**
|
|
9389
|
+
* Array of hardware phones UUIDs associated with this agent
|
|
9390
|
+
* @type {Array<string>}
|
|
9391
|
+
* @memberof ConversationPbxAgent
|
|
9392
|
+
*/
|
|
9393
|
+
hardware_phone_uuids?: Array<string>;
|
|
9388
9394
|
/**
|
|
9389
9395
|
* Agent login
|
|
9390
9396
|
* @type {string}
|
|
@@ -9403,6 +9409,12 @@ export interface ConversationPbxAgent {
|
|
|
9403
9409
|
* @memberof ConversationPbxAgent
|
|
9404
9410
|
*/
|
|
9405
9411
|
personal_conversation_pbx_voicemail_mailbox_uuid?: string;
|
|
9412
|
+
/**
|
|
9413
|
+
* The hardware phone that will be dialed on an incoming call if routing preference is hardware_phone
|
|
9414
|
+
* @type {string}
|
|
9415
|
+
* @memberof ConversationPbxAgent
|
|
9416
|
+
*/
|
|
9417
|
+
preferred_hardware_phone_uuid?: string;
|
|
9406
9418
|
/**
|
|
9407
9419
|
* True if outgoing calls should be automatically recorded
|
|
9408
9420
|
* @type {boolean}
|
|
@@ -9452,6 +9464,21 @@ export interface ConversationPbxAgent {
|
|
|
9452
9464
|
*/
|
|
9453
9465
|
voicemail?: boolean;
|
|
9454
9466
|
}
|
|
9467
|
+
/**
|
|
9468
|
+
* @export
|
|
9469
|
+
* @namespace ConversationPbxAgent
|
|
9470
|
+
*/
|
|
9471
|
+
export declare namespace ConversationPbxAgent {
|
|
9472
|
+
/**
|
|
9473
|
+
* @export
|
|
9474
|
+
* @enum {string}
|
|
9475
|
+
*/
|
|
9476
|
+
enum CallRoutingPreferenceEnum {
|
|
9477
|
+
Softphone,
|
|
9478
|
+
HardwarePhone,
|
|
9479
|
+
Cellphone
|
|
9480
|
+
}
|
|
9481
|
+
}
|
|
9455
9482
|
/**
|
|
9456
9483
|
*
|
|
9457
9484
|
* @export
|
|
@@ -10002,6 +10029,18 @@ export interface ConversationPbxCustomerSnapshotResponse {
|
|
|
10002
10029
|
* @interface ConversationPbxHardwarePhone
|
|
10003
10030
|
*/
|
|
10004
10031
|
export interface ConversationPbxHardwarePhone {
|
|
10032
|
+
/**
|
|
10033
|
+
* Admin Username
|
|
10034
|
+
* @type {string}
|
|
10035
|
+
* @memberof ConversationPbxHardwarePhone
|
|
10036
|
+
*/
|
|
10037
|
+
admin_username?: string;
|
|
10038
|
+
/**
|
|
10039
|
+
* Associated Agent UUID
|
|
10040
|
+
* @type {string}
|
|
10041
|
+
* @memberof ConversationPbxHardwarePhone
|
|
10042
|
+
*/
|
|
10043
|
+
conversation_pbx_agent_uuid?: string;
|
|
10005
10044
|
/**
|
|
10006
10045
|
* Conversation Pbx Hardware Phone UUID
|
|
10007
10046
|
* @type {string}
|
|
@@ -10063,7 +10102,13 @@ export interface ConversationPbxHardwarePhone {
|
|
|
10063
10102
|
*/
|
|
10064
10103
|
sip_domain?: string;
|
|
10065
10104
|
/**
|
|
10066
|
-
* SIP
|
|
10105
|
+
* SIP Edge Location
|
|
10106
|
+
* @type {string}
|
|
10107
|
+
* @memberof ConversationPbxHardwarePhone
|
|
10108
|
+
*/
|
|
10109
|
+
sip_edge_location?: string;
|
|
10110
|
+
/**
|
|
10111
|
+
* SIP Password (only on create or regenerate password requests)
|
|
10067
10112
|
* @type {string}
|
|
10068
10113
|
* @memberof ConversationPbxHardwarePhone
|
|
10069
10114
|
*/
|
|
@@ -10074,6 +10119,12 @@ export interface ConversationPbxHardwarePhone {
|
|
|
10074
10119
|
* @memberof ConversationPbxHardwarePhone
|
|
10075
10120
|
*/
|
|
10076
10121
|
sip_username?: string;
|
|
10122
|
+
/**
|
|
10123
|
+
* Twilio Credential SID
|
|
10124
|
+
* @type {string}
|
|
10125
|
+
* @memberof ConversationPbxHardwarePhone
|
|
10126
|
+
*/
|
|
10127
|
+
twilio_credential_sid?: string;
|
|
10077
10128
|
/**
|
|
10078
10129
|
* Updated At
|
|
10079
10130
|
* @type {any}
|
package/dist/api.js
CHANGED
|
@@ -28,10 +28,10 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
28
28
|
};
|
|
29
29
|
})();
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
|
-
exports.
|
|
32
|
-
exports.
|
|
33
|
-
exports.
|
|
34
|
-
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 = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = void 0;
|
|
31
|
+
exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.CustomerQuery = exports.Coupon = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationVirtualAgentCapabilities = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationPbxVoicemailMessageSummary = exports.ConversationPbxVoicemailMessage = exports.ConversationPbxVoicemailMailbox = exports.ConversationPbxTimeBasedMapping = exports.ConversationPbxQueue = exports.ConversationPbxPhoneNumberPurchaseRequest = exports.ConversationPbxPhoneNumber = exports.ConversationPbxMenuMapping = exports.ConversationPbxMenu = exports.ConversationPbxAvailablePhoneNumber = exports.ConversationPbxAgent = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationMcpServer = 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.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.OrderQueryBatch = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderCurrentStageHistory = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = void 0;
|
|
33
|
+
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 = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChannelPartnerApi = void 0;
|
|
34
|
+
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 = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = void 0;
|
|
35
35
|
var url = require("url");
|
|
36
36
|
var portableFetch = require("portable-fetch");
|
|
37
37
|
var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
|
|
@@ -614,6 +614,23 @@ var ConversationMessageTransportStatus;
|
|
|
614
614
|
StatusEnum[StatusEnum["PINPOINTERROR"] = 'PINPOINT_ERROR'] = "PINPOINTERROR";
|
|
615
615
|
})(StatusEnum = ConversationMessageTransportStatus.StatusEnum || (ConversationMessageTransportStatus.StatusEnum = {}));
|
|
616
616
|
})(ConversationMessageTransportStatus = exports.ConversationMessageTransportStatus || (exports.ConversationMessageTransportStatus = {}));
|
|
617
|
+
/**
|
|
618
|
+
* @export
|
|
619
|
+
* @namespace ConversationPbxAgent
|
|
620
|
+
*/
|
|
621
|
+
var ConversationPbxAgent;
|
|
622
|
+
(function (ConversationPbxAgent) {
|
|
623
|
+
/**
|
|
624
|
+
* @export
|
|
625
|
+
* @enum {string}
|
|
626
|
+
*/
|
|
627
|
+
var CallRoutingPreferenceEnum;
|
|
628
|
+
(function (CallRoutingPreferenceEnum) {
|
|
629
|
+
CallRoutingPreferenceEnum[CallRoutingPreferenceEnum["Softphone"] = 'softphone'] = "Softphone";
|
|
630
|
+
CallRoutingPreferenceEnum[CallRoutingPreferenceEnum["HardwarePhone"] = 'hardware_phone'] = "HardwarePhone";
|
|
631
|
+
CallRoutingPreferenceEnum[CallRoutingPreferenceEnum["Cellphone"] = 'cellphone'] = "Cellphone";
|
|
632
|
+
})(CallRoutingPreferenceEnum = ConversationPbxAgent.CallRoutingPreferenceEnum || (ConversationPbxAgent.CallRoutingPreferenceEnum = {}));
|
|
633
|
+
})(ConversationPbxAgent = exports.ConversationPbxAgent || (exports.ConversationPbxAgent = {}));
|
|
617
634
|
/**
|
|
618
635
|
* @export
|
|
619
636
|
* @namespace ConversationPbxAvailablePhoneNumber
|