ultracart_rest_api_v2_typescript 3.10.38 → 3.10.39
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 +3 -2
- package/api.ts +55 -3
- package/dist/api.d.ts +53 -2
- 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.10.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.10.39
|
|
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.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.10.39 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.10.39 | 08/19/2022 | order api - added cell phone fields for sms |
|
|
57
58
|
| 3.10.38 | 08/12/2022 | internal code to allow merchant login as customer |
|
|
58
59
|
| 3.10.37 | 08/11/2022 | fix entry_dts type on gift certificate ledger |
|
|
59
60
|
| 3.10.36 | 08/10/2022 | conversation event refactoring |
|
package/api.ts
CHANGED
|
@@ -3859,6 +3859,12 @@ export interface CartMarketing {
|
|
|
3859
3859
|
* @memberof CartMarketing
|
|
3860
3860
|
*/
|
|
3861
3861
|
advertising_source?: string;
|
|
3862
|
+
/**
|
|
3863
|
+
* True if the customer agrees to receiving marketing SMS messages
|
|
3864
|
+
* @type {boolean}
|
|
3865
|
+
* @memberof CartMarketing
|
|
3866
|
+
*/
|
|
3867
|
+
cell_phone_opt_in?: boolean;
|
|
3862
3868
|
/**
|
|
3863
3869
|
* True if the customer agrees to receiving marketing emails
|
|
3864
3870
|
* @type {boolean}
|
|
@@ -6824,6 +6830,12 @@ export interface ConversationParticipant {
|
|
|
6824
6830
|
* @memberof ConversationParticipant
|
|
6825
6831
|
*/
|
|
6826
6832
|
left_dts?: string;
|
|
6833
|
+
/**
|
|
6834
|
+
*
|
|
6835
|
+
* @type {string}
|
|
6836
|
+
* @memberof ConversationParticipant
|
|
6837
|
+
*/
|
|
6838
|
+
profile_image_url?: string;
|
|
6827
6839
|
/**
|
|
6828
6840
|
*
|
|
6829
6841
|
* @type {string}
|
|
@@ -7148,11 +7160,11 @@ export interface ConversationWebchatQueueStatus {
|
|
|
7148
7160
|
*/
|
|
7149
7161
|
export interface ConversationWebchatQueueStatusAgent {
|
|
7150
7162
|
/**
|
|
7151
|
-
*
|
|
7163
|
+
* Status of the agent
|
|
7152
7164
|
* @type {string}
|
|
7153
7165
|
* @memberof ConversationWebchatQueueStatusAgent
|
|
7154
7166
|
*/
|
|
7155
|
-
agent_status?:
|
|
7167
|
+
agent_status?: ConversationWebchatQueueStatusAgent.AgentStatusEnum;
|
|
7156
7168
|
/**
|
|
7157
7169
|
*
|
|
7158
7170
|
* @type {string}
|
|
@@ -7177,6 +7189,28 @@ export interface ConversationWebchatQueueStatusAgent {
|
|
|
7177
7189
|
* @memberof ConversationWebchatQueueStatusAgent
|
|
7178
7190
|
*/
|
|
7179
7191
|
next_round_robin?: boolean;
|
|
7192
|
+
/**
|
|
7193
|
+
* Profile image URL
|
|
7194
|
+
* @type {string}
|
|
7195
|
+
* @memberof ConversationWebchatQueueStatusAgent
|
|
7196
|
+
*/
|
|
7197
|
+
profile_image_url?: string;
|
|
7198
|
+
}
|
|
7199
|
+
|
|
7200
|
+
/**
|
|
7201
|
+
* @export
|
|
7202
|
+
* @namespace ConversationWebchatQueueStatusAgent
|
|
7203
|
+
*/
|
|
7204
|
+
export namespace ConversationWebchatQueueStatusAgent {
|
|
7205
|
+
/**
|
|
7206
|
+
* @export
|
|
7207
|
+
* @enum {string}
|
|
7208
|
+
*/
|
|
7209
|
+
export enum AgentStatusEnum {
|
|
7210
|
+
Available = <any> 'available',
|
|
7211
|
+
Busy = <any> 'busy',
|
|
7212
|
+
Unavailable = <any> 'unavailable'
|
|
7213
|
+
}
|
|
7180
7214
|
}
|
|
7181
7215
|
|
|
7182
7216
|
/**
|
|
@@ -25060,6 +25094,18 @@ export interface OrderBilling {
|
|
|
25060
25094
|
* @memberof OrderBilling
|
|
25061
25095
|
*/
|
|
25062
25096
|
cc_emails?: Array<string>;
|
|
25097
|
+
/**
|
|
25098
|
+
* Cell phone
|
|
25099
|
+
* @type {string}
|
|
25100
|
+
* @memberof OrderBilling
|
|
25101
|
+
*/
|
|
25102
|
+
cell_phone?: string;
|
|
25103
|
+
/**
|
|
25104
|
+
* Cell phone (E164 format)
|
|
25105
|
+
* @type {string}
|
|
25106
|
+
* @memberof OrderBilling
|
|
25107
|
+
*/
|
|
25108
|
+
cell_phone_e164?: string;
|
|
25063
25109
|
/**
|
|
25064
25110
|
* City
|
|
25065
25111
|
* @type {string}
|
|
@@ -26591,6 +26637,12 @@ export interface OrderMarketing {
|
|
|
26591
26637
|
* @memberof OrderMarketing
|
|
26592
26638
|
*/
|
|
26593
26639
|
advertising_source?: string;
|
|
26640
|
+
/**
|
|
26641
|
+
* True if the customer has opted into SMS marketing
|
|
26642
|
+
* @type {boolean}
|
|
26643
|
+
* @memberof OrderMarketing
|
|
26644
|
+
*/
|
|
26645
|
+
cell_phone_opt_in?: boolean;
|
|
26594
26646
|
/**
|
|
26595
26647
|
* True if the customer has opted into mailing list subscription
|
|
26596
26648
|
* @type {boolean}
|
|
@@ -59086,7 +59138,7 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
|
|
|
59086
59138
|
* @throws {RequiredError}
|
|
59087
59139
|
*/
|
|
59088
59140
|
getStoreFronts(options: any = {}): FetchArgs {
|
|
59089
|
-
const localVarPath = `/storefront
|
|
59141
|
+
const localVarPath = `/storefront`;
|
|
59090
59142
|
const localVarUrlObj = url.parse(localVarPath, true);
|
|
59091
59143
|
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
59092
59144
|
const localVarHeaderParameter = {} as any;
|
package/dist/api.d.ts
CHANGED
|
@@ -3768,6 +3768,12 @@ export interface CartMarketing {
|
|
|
3768
3768
|
* @memberof CartMarketing
|
|
3769
3769
|
*/
|
|
3770
3770
|
advertising_source?: string;
|
|
3771
|
+
/**
|
|
3772
|
+
* True if the customer agrees to receiving marketing SMS messages
|
|
3773
|
+
* @type {boolean}
|
|
3774
|
+
* @memberof CartMarketing
|
|
3775
|
+
*/
|
|
3776
|
+
cell_phone_opt_in?: boolean;
|
|
3771
3777
|
/**
|
|
3772
3778
|
* True if the customer agrees to receiving marketing emails
|
|
3773
3779
|
* @type {boolean}
|
|
@@ -6662,6 +6668,12 @@ export interface ConversationParticipant {
|
|
|
6662
6668
|
* @memberof ConversationParticipant
|
|
6663
6669
|
*/
|
|
6664
6670
|
left_dts?: string;
|
|
6671
|
+
/**
|
|
6672
|
+
*
|
|
6673
|
+
* @type {string}
|
|
6674
|
+
* @memberof ConversationParticipant
|
|
6675
|
+
*/
|
|
6676
|
+
profile_image_url?: string;
|
|
6665
6677
|
/**
|
|
6666
6678
|
*
|
|
6667
6679
|
* @type {string}
|
|
@@ -6978,11 +6990,11 @@ export interface ConversationWebchatQueueStatus {
|
|
|
6978
6990
|
*/
|
|
6979
6991
|
export interface ConversationWebchatQueueStatusAgent {
|
|
6980
6992
|
/**
|
|
6981
|
-
*
|
|
6993
|
+
* Status of the agent
|
|
6982
6994
|
* @type {string}
|
|
6983
6995
|
* @memberof ConversationWebchatQueueStatusAgent
|
|
6984
6996
|
*/
|
|
6985
|
-
agent_status?:
|
|
6997
|
+
agent_status?: ConversationWebchatQueueStatusAgent.AgentStatusEnum;
|
|
6986
6998
|
/**
|
|
6987
6999
|
*
|
|
6988
7000
|
* @type {string}
|
|
@@ -7007,6 +7019,27 @@ export interface ConversationWebchatQueueStatusAgent {
|
|
|
7007
7019
|
* @memberof ConversationWebchatQueueStatusAgent
|
|
7008
7020
|
*/
|
|
7009
7021
|
next_round_robin?: boolean;
|
|
7022
|
+
/**
|
|
7023
|
+
* Profile image URL
|
|
7024
|
+
* @type {string}
|
|
7025
|
+
* @memberof ConversationWebchatQueueStatusAgent
|
|
7026
|
+
*/
|
|
7027
|
+
profile_image_url?: string;
|
|
7028
|
+
}
|
|
7029
|
+
/**
|
|
7030
|
+
* @export
|
|
7031
|
+
* @namespace ConversationWebchatQueueStatusAgent
|
|
7032
|
+
*/
|
|
7033
|
+
export declare namespace ConversationWebchatQueueStatusAgent {
|
|
7034
|
+
/**
|
|
7035
|
+
* @export
|
|
7036
|
+
* @enum {string}
|
|
7037
|
+
*/
|
|
7038
|
+
enum AgentStatusEnum {
|
|
7039
|
+
Available,
|
|
7040
|
+
Busy,
|
|
7041
|
+
Unavailable
|
|
7042
|
+
}
|
|
7010
7043
|
}
|
|
7011
7044
|
/**
|
|
7012
7045
|
*
|
|
@@ -24519,6 +24552,18 @@ export interface OrderBilling {
|
|
|
24519
24552
|
* @memberof OrderBilling
|
|
24520
24553
|
*/
|
|
24521
24554
|
cc_emails?: Array<string>;
|
|
24555
|
+
/**
|
|
24556
|
+
* Cell phone
|
|
24557
|
+
* @type {string}
|
|
24558
|
+
* @memberof OrderBilling
|
|
24559
|
+
*/
|
|
24560
|
+
cell_phone?: string;
|
|
24561
|
+
/**
|
|
24562
|
+
* Cell phone (E164 format)
|
|
24563
|
+
* @type {string}
|
|
24564
|
+
* @memberof OrderBilling
|
|
24565
|
+
*/
|
|
24566
|
+
cell_phone_e164?: string;
|
|
24522
24567
|
/**
|
|
24523
24568
|
* City
|
|
24524
24569
|
* @type {string}
|
|
@@ -26022,6 +26067,12 @@ export interface OrderMarketing {
|
|
|
26022
26067
|
* @memberof OrderMarketing
|
|
26023
26068
|
*/
|
|
26024
26069
|
advertising_source?: string;
|
|
26070
|
+
/**
|
|
26071
|
+
* True if the customer has opted into SMS marketing
|
|
26072
|
+
* @type {boolean}
|
|
26073
|
+
* @memberof OrderMarketing
|
|
26074
|
+
*/
|
|
26075
|
+
cell_phone_opt_in?: boolean;
|
|
26025
26076
|
/**
|
|
26026
26077
|
* True if the customer has opted into mailing list subscription
|
|
26027
26078
|
* @type {boolean}
|
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.
|
|
32
|
-
exports.
|
|
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 = void 0;
|
|
31
|
+
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.ConversationWebchatQueueStatusAgent = 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;
|
|
32
|
+
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 = exports.Webhook = 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 = 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(/\/+$/, "");
|
|
@@ -448,6 +448,23 @@ var ConversationSummary;
|
|
|
448
448
|
MediumEnum[MediumEnum["Websocket"] = 'websocket'] = "Websocket";
|
|
449
449
|
})(MediumEnum = ConversationSummary.MediumEnum || (ConversationSummary.MediumEnum = {}));
|
|
450
450
|
})(ConversationSummary = exports.ConversationSummary || (exports.ConversationSummary = {}));
|
|
451
|
+
/**
|
|
452
|
+
* @export
|
|
453
|
+
* @namespace ConversationWebchatQueueStatusAgent
|
|
454
|
+
*/
|
|
455
|
+
var ConversationWebchatQueueStatusAgent;
|
|
456
|
+
(function (ConversationWebchatQueueStatusAgent) {
|
|
457
|
+
/**
|
|
458
|
+
* @export
|
|
459
|
+
* @enum {string}
|
|
460
|
+
*/
|
|
461
|
+
var AgentStatusEnum;
|
|
462
|
+
(function (AgentStatusEnum) {
|
|
463
|
+
AgentStatusEnum[AgentStatusEnum["Available"] = 'available'] = "Available";
|
|
464
|
+
AgentStatusEnum[AgentStatusEnum["Busy"] = 'busy'] = "Busy";
|
|
465
|
+
AgentStatusEnum[AgentStatusEnum["Unavailable"] = 'unavailable'] = "Unavailable";
|
|
466
|
+
})(AgentStatusEnum = ConversationWebchatQueueStatusAgent.AgentStatusEnum || (ConversationWebchatQueueStatusAgent.AgentStatusEnum = {}));
|
|
467
|
+
})(ConversationWebchatQueueStatusAgent = exports.ConversationWebchatQueueStatusAgent || (exports.ConversationWebchatQueueStatusAgent = {}));
|
|
451
468
|
/**
|
|
452
469
|
* @export
|
|
453
470
|
* @namespace ConversationWebsocketMessage
|
|
@@ -22258,7 +22275,7 @@ var StorefrontApiFetchParamCreator = function (configuration) {
|
|
|
22258
22275
|
*/
|
|
22259
22276
|
getStoreFronts: function (options) {
|
|
22260
22277
|
if (options === void 0) { options = {}; }
|
|
22261
|
-
var localVarPath = "/storefront
|
|
22278
|
+
var localVarPath = "/storefront";
|
|
22262
22279
|
var localVarUrlObj = url.parse(localVarPath, true);
|
|
22263
22280
|
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
22264
22281
|
var localVarHeaderParameter = {};
|