ultracart_rest_api_v2_typescript 3.11.44 → 3.11.46
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 +212 -0
- package/dist/api.d.ts +211 -0
- 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.46
|
|
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.46 --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.46 | 01/26/2026 | cart - expose utm array for use in abandon webhook only |
|
|
58
|
+
| 3.11.45 | 01/26/2026 | added multimedia file size to ItemContentMultimedia object |
|
|
57
59
|
| 3.11.44 | 01/26/2026 | conversations - ConversationDepartmentMember expose a flag for if the agent is AI |
|
|
58
60
|
| 3.11.43 | 01/14/2026 | coupons - generate one time coupons prefix support (optional) |
|
|
59
61
|
| 3.11.42 | 01/13/2026 | conversations - pbx methods for phone number purchasing |
|
package/api.ts
CHANGED
|
@@ -2575,6 +2575,12 @@ export interface Cart {
|
|
|
2575
2575
|
* @memberof Cart
|
|
2576
2576
|
*/
|
|
2577
2577
|
upsell_after?: CartUpsellAfter;
|
|
2578
|
+
/**
|
|
2579
|
+
* UTM clicks. The zero index is the most recent (last) UTM click. Only available in BigQuery and on an abandon webhook.
|
|
2580
|
+
* @type {Array<CartUtm>}
|
|
2581
|
+
* @memberof Cart
|
|
2582
|
+
*/
|
|
2583
|
+
utms?: Array<CartUtm>;
|
|
2578
2584
|
}
|
|
2579
2585
|
|
|
2580
2586
|
/**
|
|
@@ -5316,6 +5322,206 @@ export interface CartUpsellAfter {
|
|
|
5316
5322
|
upsell_path_variation?: string;
|
|
5317
5323
|
}
|
|
5318
5324
|
|
|
5325
|
+
/**
|
|
5326
|
+
*
|
|
5327
|
+
* @export
|
|
5328
|
+
* @interface CartUtm
|
|
5329
|
+
*/
|
|
5330
|
+
export interface CartUtm {
|
|
5331
|
+
/**
|
|
5332
|
+
*
|
|
5333
|
+
* @type {number}
|
|
5334
|
+
* @memberof CartUtm
|
|
5335
|
+
*/
|
|
5336
|
+
attribution_first_click_subtotal?: number;
|
|
5337
|
+
/**
|
|
5338
|
+
*
|
|
5339
|
+
* @type {number}
|
|
5340
|
+
* @memberof CartUtm
|
|
5341
|
+
*/
|
|
5342
|
+
attribution_first_click_total?: number;
|
|
5343
|
+
/**
|
|
5344
|
+
*
|
|
5345
|
+
* @type {number}
|
|
5346
|
+
* @memberof CartUtm
|
|
5347
|
+
*/
|
|
5348
|
+
attribution_last_click_subtotal?: number;
|
|
5349
|
+
/**
|
|
5350
|
+
*
|
|
5351
|
+
* @type {number}
|
|
5352
|
+
* @memberof CartUtm
|
|
5353
|
+
*/
|
|
5354
|
+
attribution_last_click_total?: number;
|
|
5355
|
+
/**
|
|
5356
|
+
*
|
|
5357
|
+
* @type {number}
|
|
5358
|
+
* @memberof CartUtm
|
|
5359
|
+
*/
|
|
5360
|
+
attribution_linear_subtotal?: number;
|
|
5361
|
+
/**
|
|
5362
|
+
*
|
|
5363
|
+
* @type {number}
|
|
5364
|
+
* @memberof CartUtm
|
|
5365
|
+
*/
|
|
5366
|
+
attribution_linear_total?: number;
|
|
5367
|
+
/**
|
|
5368
|
+
*
|
|
5369
|
+
* @type {number}
|
|
5370
|
+
* @memberof CartUtm
|
|
5371
|
+
*/
|
|
5372
|
+
attribution_position_based_subtotal?: number;
|
|
5373
|
+
/**
|
|
5374
|
+
*
|
|
5375
|
+
* @type {number}
|
|
5376
|
+
* @memberof CartUtm
|
|
5377
|
+
*/
|
|
5378
|
+
attribution_position_based_total?: number;
|
|
5379
|
+
/**
|
|
5380
|
+
* Date/time that the click happened
|
|
5381
|
+
* @type {string}
|
|
5382
|
+
* @memberof CartUtm
|
|
5383
|
+
*/
|
|
5384
|
+
click_dts?: string;
|
|
5385
|
+
/**
|
|
5386
|
+
*
|
|
5387
|
+
* @type {string}
|
|
5388
|
+
* @memberof CartUtm
|
|
5389
|
+
*/
|
|
5390
|
+
facebook_ad_id?: string;
|
|
5391
|
+
/**
|
|
5392
|
+
*
|
|
5393
|
+
* @type {string}
|
|
5394
|
+
* @memberof CartUtm
|
|
5395
|
+
*/
|
|
5396
|
+
fbclid?: string;
|
|
5397
|
+
/**
|
|
5398
|
+
*
|
|
5399
|
+
* @type {string}
|
|
5400
|
+
* @memberof CartUtm
|
|
5401
|
+
*/
|
|
5402
|
+
gbraid?: string;
|
|
5403
|
+
/**
|
|
5404
|
+
*
|
|
5405
|
+
* @type {string}
|
|
5406
|
+
* @memberof CartUtm
|
|
5407
|
+
*/
|
|
5408
|
+
glcid?: string;
|
|
5409
|
+
/**
|
|
5410
|
+
*
|
|
5411
|
+
* @type {string}
|
|
5412
|
+
* @memberof CartUtm
|
|
5413
|
+
*/
|
|
5414
|
+
itm_campaign?: string;
|
|
5415
|
+
/**
|
|
5416
|
+
*
|
|
5417
|
+
* @type {string}
|
|
5418
|
+
* @memberof CartUtm
|
|
5419
|
+
*/
|
|
5420
|
+
itm_content?: string;
|
|
5421
|
+
/**
|
|
5422
|
+
*
|
|
5423
|
+
* @type {string}
|
|
5424
|
+
* @memberof CartUtm
|
|
5425
|
+
*/
|
|
5426
|
+
itm_id?: string;
|
|
5427
|
+
/**
|
|
5428
|
+
*
|
|
5429
|
+
* @type {string}
|
|
5430
|
+
* @memberof CartUtm
|
|
5431
|
+
*/
|
|
5432
|
+
itm_medium?: string;
|
|
5433
|
+
/**
|
|
5434
|
+
*
|
|
5435
|
+
* @type {string}
|
|
5436
|
+
* @memberof CartUtm
|
|
5437
|
+
*/
|
|
5438
|
+
itm_source?: string;
|
|
5439
|
+
/**
|
|
5440
|
+
*
|
|
5441
|
+
* @type {string}
|
|
5442
|
+
* @memberof CartUtm
|
|
5443
|
+
*/
|
|
5444
|
+
itm_term?: string;
|
|
5445
|
+
/**
|
|
5446
|
+
*
|
|
5447
|
+
* @type {string}
|
|
5448
|
+
* @memberof CartUtm
|
|
5449
|
+
*/
|
|
5450
|
+
msclkid?: string;
|
|
5451
|
+
/**
|
|
5452
|
+
*
|
|
5453
|
+
* @type {string}
|
|
5454
|
+
* @memberof CartUtm
|
|
5455
|
+
*/
|
|
5456
|
+
short_code?: string;
|
|
5457
|
+
/**
|
|
5458
|
+
*
|
|
5459
|
+
* @type {boolean}
|
|
5460
|
+
* @memberof CartUtm
|
|
5461
|
+
*/
|
|
5462
|
+
short_code_backup?: boolean;
|
|
5463
|
+
/**
|
|
5464
|
+
*
|
|
5465
|
+
* @type {string}
|
|
5466
|
+
* @memberof CartUtm
|
|
5467
|
+
*/
|
|
5468
|
+
ttclid?: string;
|
|
5469
|
+
/**
|
|
5470
|
+
*
|
|
5471
|
+
* @type {string}
|
|
5472
|
+
* @memberof CartUtm
|
|
5473
|
+
*/
|
|
5474
|
+
uc_message_id?: string;
|
|
5475
|
+
/**
|
|
5476
|
+
*
|
|
5477
|
+
* @type {string}
|
|
5478
|
+
* @memberof CartUtm
|
|
5479
|
+
*/
|
|
5480
|
+
utm_campaign?: string;
|
|
5481
|
+
/**
|
|
5482
|
+
*
|
|
5483
|
+
* @type {string}
|
|
5484
|
+
* @memberof CartUtm
|
|
5485
|
+
*/
|
|
5486
|
+
utm_content?: string;
|
|
5487
|
+
/**
|
|
5488
|
+
*
|
|
5489
|
+
* @type {string}
|
|
5490
|
+
* @memberof CartUtm
|
|
5491
|
+
*/
|
|
5492
|
+
utm_id?: string;
|
|
5493
|
+
/**
|
|
5494
|
+
*
|
|
5495
|
+
* @type {string}
|
|
5496
|
+
* @memberof CartUtm
|
|
5497
|
+
*/
|
|
5498
|
+
utm_medium?: string;
|
|
5499
|
+
/**
|
|
5500
|
+
*
|
|
5501
|
+
* @type {string}
|
|
5502
|
+
* @memberof CartUtm
|
|
5503
|
+
*/
|
|
5504
|
+
utm_source?: string;
|
|
5505
|
+
/**
|
|
5506
|
+
*
|
|
5507
|
+
* @type {string}
|
|
5508
|
+
* @memberof CartUtm
|
|
5509
|
+
*/
|
|
5510
|
+
utm_term?: string;
|
|
5511
|
+
/**
|
|
5512
|
+
*
|
|
5513
|
+
* @type {string}
|
|
5514
|
+
* @memberof CartUtm
|
|
5515
|
+
*/
|
|
5516
|
+
vmcid?: string;
|
|
5517
|
+
/**
|
|
5518
|
+
*
|
|
5519
|
+
* @type {string}
|
|
5520
|
+
* @memberof CartUtm
|
|
5521
|
+
*/
|
|
5522
|
+
wbraid?: string;
|
|
5523
|
+
}
|
|
5524
|
+
|
|
5319
5525
|
/**
|
|
5320
5526
|
*
|
|
5321
5527
|
* @export
|
|
@@ -29011,6 +29217,12 @@ export interface ItemContentMultimedia {
|
|
|
29011
29217
|
* @memberof ItemContentMultimedia
|
|
29012
29218
|
*/
|
|
29013
29219
|
placeholder?: boolean;
|
|
29220
|
+
/**
|
|
29221
|
+
* Size of the file in bytes if known
|
|
29222
|
+
* @type {number}
|
|
29223
|
+
* @memberof ItemContentMultimedia
|
|
29224
|
+
*/
|
|
29225
|
+
size?: number;
|
|
29014
29226
|
/**
|
|
29015
29227
|
* Temporary multimedia object identifier assigned if uploading new multimedia
|
|
29016
29228
|
* @type {number}
|
package/dist/api.d.ts
CHANGED
|
@@ -2509,6 +2509,12 @@ export interface Cart {
|
|
|
2509
2509
|
* @memberof Cart
|
|
2510
2510
|
*/
|
|
2511
2511
|
upsell_after?: CartUpsellAfter;
|
|
2512
|
+
/**
|
|
2513
|
+
* UTM clicks. The zero index is the most recent (last) UTM click. Only available in BigQuery and on an abandon webhook.
|
|
2514
|
+
* @type {Array<CartUtm>}
|
|
2515
|
+
* @memberof Cart
|
|
2516
|
+
*/
|
|
2517
|
+
utms?: Array<CartUtm>;
|
|
2512
2518
|
}
|
|
2513
2519
|
/**
|
|
2514
2520
|
*
|
|
@@ -5188,6 +5194,205 @@ export interface CartUpsellAfter {
|
|
|
5188
5194
|
*/
|
|
5189
5195
|
upsell_path_variation?: string;
|
|
5190
5196
|
}
|
|
5197
|
+
/**
|
|
5198
|
+
*
|
|
5199
|
+
* @export
|
|
5200
|
+
* @interface CartUtm
|
|
5201
|
+
*/
|
|
5202
|
+
export interface CartUtm {
|
|
5203
|
+
/**
|
|
5204
|
+
*
|
|
5205
|
+
* @type {number}
|
|
5206
|
+
* @memberof CartUtm
|
|
5207
|
+
*/
|
|
5208
|
+
attribution_first_click_subtotal?: number;
|
|
5209
|
+
/**
|
|
5210
|
+
*
|
|
5211
|
+
* @type {number}
|
|
5212
|
+
* @memberof CartUtm
|
|
5213
|
+
*/
|
|
5214
|
+
attribution_first_click_total?: number;
|
|
5215
|
+
/**
|
|
5216
|
+
*
|
|
5217
|
+
* @type {number}
|
|
5218
|
+
* @memberof CartUtm
|
|
5219
|
+
*/
|
|
5220
|
+
attribution_last_click_subtotal?: number;
|
|
5221
|
+
/**
|
|
5222
|
+
*
|
|
5223
|
+
* @type {number}
|
|
5224
|
+
* @memberof CartUtm
|
|
5225
|
+
*/
|
|
5226
|
+
attribution_last_click_total?: number;
|
|
5227
|
+
/**
|
|
5228
|
+
*
|
|
5229
|
+
* @type {number}
|
|
5230
|
+
* @memberof CartUtm
|
|
5231
|
+
*/
|
|
5232
|
+
attribution_linear_subtotal?: number;
|
|
5233
|
+
/**
|
|
5234
|
+
*
|
|
5235
|
+
* @type {number}
|
|
5236
|
+
* @memberof CartUtm
|
|
5237
|
+
*/
|
|
5238
|
+
attribution_linear_total?: number;
|
|
5239
|
+
/**
|
|
5240
|
+
*
|
|
5241
|
+
* @type {number}
|
|
5242
|
+
* @memberof CartUtm
|
|
5243
|
+
*/
|
|
5244
|
+
attribution_position_based_subtotal?: number;
|
|
5245
|
+
/**
|
|
5246
|
+
*
|
|
5247
|
+
* @type {number}
|
|
5248
|
+
* @memberof CartUtm
|
|
5249
|
+
*/
|
|
5250
|
+
attribution_position_based_total?: number;
|
|
5251
|
+
/**
|
|
5252
|
+
* Date/time that the click happened
|
|
5253
|
+
* @type {string}
|
|
5254
|
+
* @memberof CartUtm
|
|
5255
|
+
*/
|
|
5256
|
+
click_dts?: string;
|
|
5257
|
+
/**
|
|
5258
|
+
*
|
|
5259
|
+
* @type {string}
|
|
5260
|
+
* @memberof CartUtm
|
|
5261
|
+
*/
|
|
5262
|
+
facebook_ad_id?: string;
|
|
5263
|
+
/**
|
|
5264
|
+
*
|
|
5265
|
+
* @type {string}
|
|
5266
|
+
* @memberof CartUtm
|
|
5267
|
+
*/
|
|
5268
|
+
fbclid?: string;
|
|
5269
|
+
/**
|
|
5270
|
+
*
|
|
5271
|
+
* @type {string}
|
|
5272
|
+
* @memberof CartUtm
|
|
5273
|
+
*/
|
|
5274
|
+
gbraid?: string;
|
|
5275
|
+
/**
|
|
5276
|
+
*
|
|
5277
|
+
* @type {string}
|
|
5278
|
+
* @memberof CartUtm
|
|
5279
|
+
*/
|
|
5280
|
+
glcid?: string;
|
|
5281
|
+
/**
|
|
5282
|
+
*
|
|
5283
|
+
* @type {string}
|
|
5284
|
+
* @memberof CartUtm
|
|
5285
|
+
*/
|
|
5286
|
+
itm_campaign?: string;
|
|
5287
|
+
/**
|
|
5288
|
+
*
|
|
5289
|
+
* @type {string}
|
|
5290
|
+
* @memberof CartUtm
|
|
5291
|
+
*/
|
|
5292
|
+
itm_content?: string;
|
|
5293
|
+
/**
|
|
5294
|
+
*
|
|
5295
|
+
* @type {string}
|
|
5296
|
+
* @memberof CartUtm
|
|
5297
|
+
*/
|
|
5298
|
+
itm_id?: string;
|
|
5299
|
+
/**
|
|
5300
|
+
*
|
|
5301
|
+
* @type {string}
|
|
5302
|
+
* @memberof CartUtm
|
|
5303
|
+
*/
|
|
5304
|
+
itm_medium?: string;
|
|
5305
|
+
/**
|
|
5306
|
+
*
|
|
5307
|
+
* @type {string}
|
|
5308
|
+
* @memberof CartUtm
|
|
5309
|
+
*/
|
|
5310
|
+
itm_source?: string;
|
|
5311
|
+
/**
|
|
5312
|
+
*
|
|
5313
|
+
* @type {string}
|
|
5314
|
+
* @memberof CartUtm
|
|
5315
|
+
*/
|
|
5316
|
+
itm_term?: string;
|
|
5317
|
+
/**
|
|
5318
|
+
*
|
|
5319
|
+
* @type {string}
|
|
5320
|
+
* @memberof CartUtm
|
|
5321
|
+
*/
|
|
5322
|
+
msclkid?: string;
|
|
5323
|
+
/**
|
|
5324
|
+
*
|
|
5325
|
+
* @type {string}
|
|
5326
|
+
* @memberof CartUtm
|
|
5327
|
+
*/
|
|
5328
|
+
short_code?: string;
|
|
5329
|
+
/**
|
|
5330
|
+
*
|
|
5331
|
+
* @type {boolean}
|
|
5332
|
+
* @memberof CartUtm
|
|
5333
|
+
*/
|
|
5334
|
+
short_code_backup?: boolean;
|
|
5335
|
+
/**
|
|
5336
|
+
*
|
|
5337
|
+
* @type {string}
|
|
5338
|
+
* @memberof CartUtm
|
|
5339
|
+
*/
|
|
5340
|
+
ttclid?: string;
|
|
5341
|
+
/**
|
|
5342
|
+
*
|
|
5343
|
+
* @type {string}
|
|
5344
|
+
* @memberof CartUtm
|
|
5345
|
+
*/
|
|
5346
|
+
uc_message_id?: string;
|
|
5347
|
+
/**
|
|
5348
|
+
*
|
|
5349
|
+
* @type {string}
|
|
5350
|
+
* @memberof CartUtm
|
|
5351
|
+
*/
|
|
5352
|
+
utm_campaign?: string;
|
|
5353
|
+
/**
|
|
5354
|
+
*
|
|
5355
|
+
* @type {string}
|
|
5356
|
+
* @memberof CartUtm
|
|
5357
|
+
*/
|
|
5358
|
+
utm_content?: string;
|
|
5359
|
+
/**
|
|
5360
|
+
*
|
|
5361
|
+
* @type {string}
|
|
5362
|
+
* @memberof CartUtm
|
|
5363
|
+
*/
|
|
5364
|
+
utm_id?: string;
|
|
5365
|
+
/**
|
|
5366
|
+
*
|
|
5367
|
+
* @type {string}
|
|
5368
|
+
* @memberof CartUtm
|
|
5369
|
+
*/
|
|
5370
|
+
utm_medium?: string;
|
|
5371
|
+
/**
|
|
5372
|
+
*
|
|
5373
|
+
* @type {string}
|
|
5374
|
+
* @memberof CartUtm
|
|
5375
|
+
*/
|
|
5376
|
+
utm_source?: string;
|
|
5377
|
+
/**
|
|
5378
|
+
*
|
|
5379
|
+
* @type {string}
|
|
5380
|
+
* @memberof CartUtm
|
|
5381
|
+
*/
|
|
5382
|
+
utm_term?: string;
|
|
5383
|
+
/**
|
|
5384
|
+
*
|
|
5385
|
+
* @type {string}
|
|
5386
|
+
* @memberof CartUtm
|
|
5387
|
+
*/
|
|
5388
|
+
vmcid?: string;
|
|
5389
|
+
/**
|
|
5390
|
+
*
|
|
5391
|
+
* @type {string}
|
|
5392
|
+
* @memberof CartUtm
|
|
5393
|
+
*/
|
|
5394
|
+
wbraid?: string;
|
|
5395
|
+
}
|
|
5191
5396
|
/**
|
|
5192
5397
|
*
|
|
5193
5398
|
* @export
|
|
@@ -28382,6 +28587,12 @@ export interface ItemContentMultimedia {
|
|
|
28382
28587
|
* @memberof ItemContentMultimedia
|
|
28383
28588
|
*/
|
|
28384
28589
|
placeholder?: boolean;
|
|
28590
|
+
/**
|
|
28591
|
+
* Size of the file in bytes if known
|
|
28592
|
+
* @type {number}
|
|
28593
|
+
* @memberof ItemContentMultimedia
|
|
28594
|
+
*/
|
|
28595
|
+
size?: number;
|
|
28385
28596
|
/**
|
|
28386
28597
|
* Temporary multimedia object identifier assigned if uploading new multimedia
|
|
28387
28598
|
* @type {number}
|