ultracart_rest_api_v2_typescript 3.9.1 → 3.9.2

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.9.1
1
+ ## ultracart_rest_api_v2_typescript@3.9.2
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.9.1 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.9.2 --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.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
57
58
  | 3.9.1 | 03/03/2022 | javascript sdk package.json bug fix |
58
59
  | 3.9.0 | 03/03/2022 | removed ultra_cart_rest_api_v2.d.ts from javascript sdk because typescript sdk exists now |
59
60
  | 3.8.8 | 03/02/2022 | bug fix for ruby sdk, uri.escape deprecated in 3.x |
package/api.ts CHANGED
@@ -490,6 +490,12 @@ export interface AddLibraryItemRequest {
490
490
  * @memberof AddLibraryItemRequest
491
491
  */
492
492
  cjson?: string;
493
+ /**
494
+ * Additional Cjson to be added to library, notably for the postcard which has a front and back.
495
+ * @type {string}
496
+ * @memberof AddLibraryItemRequest
497
+ */
498
+ cjson2?: string;
493
499
  /**
494
500
  * flow, campaign, cjson, email, transactional_email, postcard or upsell
495
501
  * @type {string}
@@ -2004,6 +2010,116 @@ export interface BaseResponse {
2004
2010
  warning?: Warning;
2005
2011
  }
2006
2012
 
2013
+ /**
2014
+ *
2015
+ * @export
2016
+ * @interface Browser
2017
+ */
2018
+ export interface Browser {
2019
+ /**
2020
+ *
2021
+ * @type {BrowserDevice}
2022
+ * @memberof Browser
2023
+ */
2024
+ device?: BrowserDevice;
2025
+ /**
2026
+ *
2027
+ * @type {BrowserOS}
2028
+ * @memberof Browser
2029
+ */
2030
+ os?: BrowserOS;
2031
+ /**
2032
+ *
2033
+ * @type {BrowserUserAgent}
2034
+ * @memberof Browser
2035
+ */
2036
+ user_agent?: BrowserUserAgent;
2037
+ }
2038
+
2039
+ /**
2040
+ *
2041
+ * @export
2042
+ * @interface BrowserDevice
2043
+ */
2044
+ export interface BrowserDevice {
2045
+ /**
2046
+ *
2047
+ * @type {string}
2048
+ * @memberof BrowserDevice
2049
+ */
2050
+ family?: string;
2051
+ }
2052
+
2053
+ /**
2054
+ *
2055
+ * @export
2056
+ * @interface BrowserOS
2057
+ */
2058
+ export interface BrowserOS {
2059
+ /**
2060
+ *
2061
+ * @type {string}
2062
+ * @memberof BrowserOS
2063
+ */
2064
+ family?: string;
2065
+ /**
2066
+ *
2067
+ * @type {string}
2068
+ * @memberof BrowserOS
2069
+ */
2070
+ major?: string;
2071
+ /**
2072
+ *
2073
+ * @type {string}
2074
+ * @memberof BrowserOS
2075
+ */
2076
+ minor?: string;
2077
+ /**
2078
+ *
2079
+ * @type {string}
2080
+ * @memberof BrowserOS
2081
+ */
2082
+ patch?: string;
2083
+ /**
2084
+ *
2085
+ * @type {string}
2086
+ * @memberof BrowserOS
2087
+ */
2088
+ patch_minor?: string;
2089
+ }
2090
+
2091
+ /**
2092
+ *
2093
+ * @export
2094
+ * @interface BrowserUserAgent
2095
+ */
2096
+ export interface BrowserUserAgent {
2097
+ /**
2098
+ *
2099
+ * @type {string}
2100
+ * @memberof BrowserUserAgent
2101
+ */
2102
+ family?: string;
2103
+ /**
2104
+ *
2105
+ * @type {string}
2106
+ * @memberof BrowserUserAgent
2107
+ */
2108
+ major?: string;
2109
+ /**
2110
+ *
2111
+ * @type {string}
2112
+ * @memberof BrowserUserAgent
2113
+ */
2114
+ minor?: string;
2115
+ /**
2116
+ *
2117
+ * @type {string}
2118
+ * @memberof BrowserUserAgent
2119
+ */
2120
+ patch?: string;
2121
+ }
2122
+
2007
2123
  /**
2008
2124
  *
2009
2125
  * @export
@@ -2016,6 +2132,12 @@ export interface Cart {
2016
2132
  * @memberof Cart
2017
2133
  */
2018
2134
  affiliate?: CartAffiliate;
2135
+ /**
2136
+ * The affiliate network pixel identifier associated with the cart
2137
+ * @type {number}
2138
+ * @memberof Cart
2139
+ */
2140
+ affiliate_network_pixel_oid?: number;
2019
2141
  /**
2020
2142
  * The ISO-4217 three letter base currency code of the account
2021
2143
  * @type {string}
@@ -9389,6 +9511,12 @@ export interface DistributionCenter {
9389
9511
  * @memberof DistributionCenter
9390
9512
  */
9391
9513
  state?: string;
9514
+ /**
9515
+ * True if monetary amounts should be zeroed before transmission
9516
+ * @type {boolean}
9517
+ * @memberof DistributionCenter
9518
+ */
9519
+ transmit_blank_costs?: boolean;
9392
9520
  /**
9393
9521
  * Transport mechanism for this distribution center
9394
9522
  * @type {string}
@@ -10319,6 +10447,54 @@ export interface EmailCommseqPostcard {
10319
10447
  * @memberof EmailCommseqPostcard
10320
10448
  */
10321
10449
  postcard_front_container_uuid?: string;
10450
+ /**
10451
+ * URL to screenshot (back) in large form factor full page
10452
+ * @type {string}
10453
+ * @memberof EmailCommseqPostcard
10454
+ */
10455
+ screenshot_back_large_full_url?: string;
10456
+ /**
10457
+ * URL to screenshot (back) in large form factor viewport
10458
+ * @type {string}
10459
+ * @memberof EmailCommseqPostcard
10460
+ */
10461
+ screenshot_back_large_viewport_url?: string;
10462
+ /**
10463
+ * URL to screenshot (back) in small form factor full page
10464
+ * @type {string}
10465
+ * @memberof EmailCommseqPostcard
10466
+ */
10467
+ screenshot_back_small_full_url?: string;
10468
+ /**
10469
+ * URL to screenshot (back) in small form factor viewport
10470
+ * @type {string}
10471
+ * @memberof EmailCommseqPostcard
10472
+ */
10473
+ screenshot_back_small_viewport_url?: string;
10474
+ /**
10475
+ * URL to screenshot in large form factor full page
10476
+ * @type {string}
10477
+ * @memberof EmailCommseqPostcard
10478
+ */
10479
+ screenshot_large_full_url?: string;
10480
+ /**
10481
+ * URL to screenshot in large form factor viewport
10482
+ * @type {string}
10483
+ * @memberof EmailCommseqPostcard
10484
+ */
10485
+ screenshot_large_viewport_url?: string;
10486
+ /**
10487
+ * URL to screenshot in small form factor full page
10488
+ * @type {string}
10489
+ * @memberof EmailCommseqPostcard
10490
+ */
10491
+ screenshot_small_full_url?: string;
10492
+ /**
10493
+ * URL to screenshot in small form factor viewport
10494
+ * @type {string}
10495
+ * @memberof EmailCommseqPostcard
10496
+ */
10497
+ screenshot_small_viewport_url?: string;
10322
10498
  /**
10323
10499
  * Storefront oid
10324
10500
  * @type {number}
@@ -15346,6 +15522,12 @@ export interface GiftCertificate {
15346
15522
  * @memberof GiftCertificate
15347
15523
  */
15348
15524
  code?: string;
15525
+ /**
15526
+ * This is the customer profile oid associated with this internally managed gift certificate.
15527
+ * @type {number}
15528
+ * @memberof GiftCertificate
15529
+ */
15530
+ customer_profile_oid?: number;
15349
15531
  /**
15350
15532
  * True if this gift certificate was deleted.
15351
15533
  * @type {boolean}
@@ -15370,6 +15552,12 @@ export interface GiftCertificate {
15370
15552
  * @memberof GiftCertificate
15371
15553
  */
15372
15554
  gift_certificate_oid?: number;
15555
+ /**
15556
+ * This is an internally managed gift certificate associated with the loyalty cash rewards program.
15557
+ * @type {boolean}
15558
+ * @memberof GiftCertificate
15559
+ */
15560
+ internal?: boolean;
15373
15561
  /**
15374
15562
  * A list of all ledger activity for this gift certificate.
15375
15563
  * @type {Array<GiftCertificateLedgerEntry>}
@@ -20353,6 +20541,12 @@ export interface ItemTax {
20353
20541
  * @memberof ItemTax
20354
20542
  */
20355
20543
  tax_free?: boolean;
20544
+ /**
20545
+ * Tax product type
20546
+ * @type {string}
20547
+ * @memberof ItemTax
20548
+ */
20549
+ tax_product_type?: ItemTax.TaxProductTypeEnum;
20356
20550
  /**
20357
20551
  * Taxable cost if different than regular cost
20358
20552
  * @type {number}
@@ -20361,6 +20555,23 @@ export interface ItemTax {
20361
20555
  taxable_cost?: number;
20362
20556
  }
20363
20557
 
20558
+ /**
20559
+ * @export
20560
+ * @namespace ItemTax
20561
+ */
20562
+ export namespace ItemTax {
20563
+ /**
20564
+ * @export
20565
+ * @enum {string}
20566
+ */
20567
+ export enum TaxProductTypeEnum {
20568
+ Empty = <any> '',
20569
+ Digital = <any> 'digital',
20570
+ Physical = <any> 'physical',
20571
+ Service = <any> 'service'
20572
+ }
20573
+ }
20574
+
20364
20575
  /**
20365
20576
  *
20366
20577
  * @export
@@ -22457,6 +22668,12 @@ export interface OrderChannelPartner {
22457
22668
  * @interface OrderCheckout
22458
22669
  */
22459
22670
  export interface OrderCheckout {
22671
+ /**
22672
+ *
22673
+ * @type {Browser}
22674
+ * @memberof OrderCheckout
22675
+ */
22676
+ browser?: Browser;
22460
22677
  /**
22461
22678
  * Comments from the customer. Rarely used on the single page checkout.
22462
22679
  * @type {string}
@@ -22517,6 +22734,12 @@ export interface OrderCheckout {
22517
22734
  * @memberof OrderCheckout
22518
22735
  */
22519
22736
  screen_branding_theme_code?: string;
22737
+ /**
22738
+ * Screen size small, medium or large
22739
+ * @type {string}
22740
+ * @memberof OrderCheckout
22741
+ */
22742
+ screen_size?: string;
22520
22743
  /**
22521
22744
  * StoreFront host name associated with the order
22522
22745
  * @type {string}
@@ -23395,6 +23618,12 @@ export interface OrderItem {
23395
23618
  * @memberof OrderItem
23396
23619
  */
23397
23620
  tax_free?: boolean;
23621
+ /**
23622
+ * Type of product for tax purposes (self or UltraCart Managed taxes)
23623
+ * @type {string}
23624
+ * @memberof OrderItem
23625
+ */
23626
+ tax_product_type?: OrderItem.TaxProductTypeEnum;
23398
23627
  /**
23399
23628
  *
23400
23629
  * @type {Currency}
@@ -23445,6 +23674,23 @@ export interface OrderItem {
23445
23674
  width?: Distance;
23446
23675
  }
23447
23676
 
23677
+ /**
23678
+ * @export
23679
+ * @namespace OrderItem
23680
+ */
23681
+ export namespace OrderItem {
23682
+ /**
23683
+ * @export
23684
+ * @enum {string}
23685
+ */
23686
+ export enum TaxProductTypeEnum {
23687
+ Empty = <any> '',
23688
+ Digital = <any> 'digital',
23689
+ Physical = <any> 'physical',
23690
+ Service = <any> 'service'
23691
+ }
23692
+ }
23693
+
23448
23694
  /**
23449
23695
  *
23450
23696
  * @export
@@ -31886,6 +32132,24 @@ export interface TaxProviderUltraCartState {
31886
32132
  * @memberof TaxProviderUltraCartState
31887
32133
  */
31888
32134
  enabled?: boolean;
32135
+ /**
32136
+ * True if digital items are exempt from sales tax in this state.
32137
+ * @type {boolean}
32138
+ * @memberof TaxProviderUltraCartState
32139
+ */
32140
+ exempt_digital_items?: boolean;
32141
+ /**
32142
+ * True if physical items are exempt from sales tax in this state.
32143
+ * @type {boolean}
32144
+ * @memberof TaxProviderUltraCartState
32145
+ */
32146
+ exempt_physical_items?: boolean;
32147
+ /**
32148
+ * True if service items are exempt from sales tax in this state.
32149
+ * @type {boolean}
32150
+ * @memberof TaxProviderUltraCartState
32151
+ */
32152
+ exempt_service_items?: boolean;
31889
32153
  /**
31890
32154
  * State Code (2 digits)
31891
32155
  * @type {string}
@@ -32034,6 +32298,24 @@ export interface TaxState {
32034
32298
  * @memberof TaxState
32035
32299
  */
32036
32300
  dont_collect_state?: boolean;
32301
+ /**
32302
+ * True if digital items are exempt from sales tax in this state.
32303
+ * @type {boolean}
32304
+ * @memberof TaxState
32305
+ */
32306
+ exempt_digital_items?: boolean;
32307
+ /**
32308
+ * True if physical items are exempt from sales tax in this state.
32309
+ * @type {boolean}
32310
+ * @memberof TaxState
32311
+ */
32312
+ exempt_physical_items?: boolean;
32313
+ /**
32314
+ * True if service items are exempt from sales tax in this state.
32315
+ * @type {boolean}
32316
+ * @memberof TaxState
32317
+ */
32318
+ exempt_service_items?: boolean;
32037
32319
  /**
32038
32320
  * State code
32039
32321
  * @type {string}
package/dist/api.d.ts CHANGED
@@ -464,6 +464,12 @@ export interface AddLibraryItemRequest {
464
464
  * @memberof AddLibraryItemRequest
465
465
  */
466
466
  cjson?: string;
467
+ /**
468
+ * Additional Cjson to be added to library, notably for the postcard which has a front and back.
469
+ * @type {string}
470
+ * @memberof AddLibraryItemRequest
471
+ */
472
+ cjson2?: string;
467
473
  /**
468
474
  * flow, campaign, cjson, email, transactional_email, postcard or upsell
469
475
  * @type {string}
@@ -1949,6 +1955,112 @@ export interface BaseResponse {
1949
1955
  */
1950
1956
  warning?: Warning;
1951
1957
  }
1958
+ /**
1959
+ *
1960
+ * @export
1961
+ * @interface Browser
1962
+ */
1963
+ export interface Browser {
1964
+ /**
1965
+ *
1966
+ * @type {BrowserDevice}
1967
+ * @memberof Browser
1968
+ */
1969
+ device?: BrowserDevice;
1970
+ /**
1971
+ *
1972
+ * @type {BrowserOS}
1973
+ * @memberof Browser
1974
+ */
1975
+ os?: BrowserOS;
1976
+ /**
1977
+ *
1978
+ * @type {BrowserUserAgent}
1979
+ * @memberof Browser
1980
+ */
1981
+ user_agent?: BrowserUserAgent;
1982
+ }
1983
+ /**
1984
+ *
1985
+ * @export
1986
+ * @interface BrowserDevice
1987
+ */
1988
+ export interface BrowserDevice {
1989
+ /**
1990
+ *
1991
+ * @type {string}
1992
+ * @memberof BrowserDevice
1993
+ */
1994
+ family?: string;
1995
+ }
1996
+ /**
1997
+ *
1998
+ * @export
1999
+ * @interface BrowserOS
2000
+ */
2001
+ export interface BrowserOS {
2002
+ /**
2003
+ *
2004
+ * @type {string}
2005
+ * @memberof BrowserOS
2006
+ */
2007
+ family?: string;
2008
+ /**
2009
+ *
2010
+ * @type {string}
2011
+ * @memberof BrowserOS
2012
+ */
2013
+ major?: string;
2014
+ /**
2015
+ *
2016
+ * @type {string}
2017
+ * @memberof BrowserOS
2018
+ */
2019
+ minor?: string;
2020
+ /**
2021
+ *
2022
+ * @type {string}
2023
+ * @memberof BrowserOS
2024
+ */
2025
+ patch?: string;
2026
+ /**
2027
+ *
2028
+ * @type {string}
2029
+ * @memberof BrowserOS
2030
+ */
2031
+ patch_minor?: string;
2032
+ }
2033
+ /**
2034
+ *
2035
+ * @export
2036
+ * @interface BrowserUserAgent
2037
+ */
2038
+ export interface BrowserUserAgent {
2039
+ /**
2040
+ *
2041
+ * @type {string}
2042
+ * @memberof BrowserUserAgent
2043
+ */
2044
+ family?: string;
2045
+ /**
2046
+ *
2047
+ * @type {string}
2048
+ * @memberof BrowserUserAgent
2049
+ */
2050
+ major?: string;
2051
+ /**
2052
+ *
2053
+ * @type {string}
2054
+ * @memberof BrowserUserAgent
2055
+ */
2056
+ minor?: string;
2057
+ /**
2058
+ *
2059
+ * @type {string}
2060
+ * @memberof BrowserUserAgent
2061
+ */
2062
+ patch?: string;
2063
+ }
1952
2064
  /**
1953
2065
  *
1954
2066
  * @export
@@ -1961,6 +2073,12 @@ export interface Cart {
1961
2073
  * @memberof Cart
1962
2074
  */
1963
2075
  affiliate?: CartAffiliate;
2076
+ /**
2077
+ * The affiliate network pixel identifier associated with the cart
2078
+ * @type {number}
2079
+ * @memberof Cart
2080
+ */
2081
+ affiliate_network_pixel_oid?: number;
1964
2082
  /**
1965
2083
  * The ISO-4217 three letter base currency code of the account
1966
2084
  * @type {string}
@@ -9167,6 +9285,12 @@ export interface DistributionCenter {
9167
9285
  * @memberof DistributionCenter
9168
9286
  */
9169
9287
  state?: string;
9288
+ /**
9289
+ * True if monetary amounts should be zeroed before transmission
9290
+ * @type {boolean}
9291
+ * @memberof DistributionCenter
9292
+ */
9293
+ transmit_blank_costs?: boolean;
9170
9294
  /**
9171
9295
  * Transport mechanism for this distribution center
9172
9296
  * @type {string}
@@ -10079,6 +10203,54 @@ export interface EmailCommseqPostcard {
10079
10203
  * @memberof EmailCommseqPostcard
10080
10204
  */
10081
10205
  postcard_front_container_uuid?: string;
10206
+ /**
10207
+ * URL to screenshot (back) in large form factor full page
10208
+ * @type {string}
10209
+ * @memberof EmailCommseqPostcard
10210
+ */
10211
+ screenshot_back_large_full_url?: string;
10212
+ /**
10213
+ * URL to screenshot (back) in large form factor viewport
10214
+ * @type {string}
10215
+ * @memberof EmailCommseqPostcard
10216
+ */
10217
+ screenshot_back_large_viewport_url?: string;
10218
+ /**
10219
+ * URL to screenshot (back) in small form factor full page
10220
+ * @type {string}
10221
+ * @memberof EmailCommseqPostcard
10222
+ */
10223
+ screenshot_back_small_full_url?: string;
10224
+ /**
10225
+ * URL to screenshot (back) in small form factor viewport
10226
+ * @type {string}
10227
+ * @memberof EmailCommseqPostcard
10228
+ */
10229
+ screenshot_back_small_viewport_url?: string;
10230
+ /**
10231
+ * URL to screenshot in large form factor full page
10232
+ * @type {string}
10233
+ * @memberof EmailCommseqPostcard
10234
+ */
10235
+ screenshot_large_full_url?: string;
10236
+ /**
10237
+ * URL to screenshot in large form factor viewport
10238
+ * @type {string}
10239
+ * @memberof EmailCommseqPostcard
10240
+ */
10241
+ screenshot_large_viewport_url?: string;
10242
+ /**
10243
+ * URL to screenshot in small form factor full page
10244
+ * @type {string}
10245
+ * @memberof EmailCommseqPostcard
10246
+ */
10247
+ screenshot_small_full_url?: string;
10248
+ /**
10249
+ * URL to screenshot in small form factor viewport
10250
+ * @type {string}
10251
+ * @memberof EmailCommseqPostcard
10252
+ */
10253
+ screenshot_small_viewport_url?: string;
10082
10254
  /**
10083
10255
  * Storefront oid
10084
10256
  * @type {number}
@@ -15002,6 +15174,12 @@ export interface GiftCertificate {
15002
15174
  * @memberof GiftCertificate
15003
15175
  */
15004
15176
  code?: string;
15177
+ /**
15178
+ * This is the customer profile oid associated with this internally managed gift certificate.
15179
+ * @type {number}
15180
+ * @memberof GiftCertificate
15181
+ */
15182
+ customer_profile_oid?: number;
15005
15183
  /**
15006
15184
  * True if this gift certificate was deleted.
15007
15185
  * @type {boolean}
@@ -15026,6 +15204,12 @@ export interface GiftCertificate {
15026
15204
  * @memberof GiftCertificate
15027
15205
  */
15028
15206
  gift_certificate_oid?: number;
15207
+ /**
15208
+ * This is an internally managed gift certificate associated with the loyalty cash rewards program.
15209
+ * @type {boolean}
15210
+ * @memberof GiftCertificate
15211
+ */
15212
+ internal?: boolean;
15029
15213
  /**
15030
15214
  * A list of all ledger activity for this gift certificate.
15031
15215
  * @type {Array<GiftCertificateLedgerEntry>}
@@ -19914,6 +20098,12 @@ export interface ItemTax {
19914
20098
  * @memberof ItemTax
19915
20099
  */
19916
20100
  tax_free?: boolean;
20101
+ /**
20102
+ * Tax product type
20103
+ * @type {string}
20104
+ * @memberof ItemTax
20105
+ */
20106
+ tax_product_type?: ItemTax.TaxProductTypeEnum;
19917
20107
  /**
19918
20108
  * Taxable cost if different than regular cost
19919
20109
  * @type {number}
@@ -19921,6 +20111,22 @@ export interface ItemTax {
19921
20111
  */
19922
20112
  taxable_cost?: number;
19923
20113
  }
20114
+ /**
20115
+ * @export
20116
+ * @namespace ItemTax
20117
+ */
20118
+ export declare namespace ItemTax {
20119
+ /**
20120
+ * @export
20121
+ * @enum {string}
20122
+ */
20123
+ enum TaxProductTypeEnum {
20124
+ Empty,
20125
+ Digital,
20126
+ Physical,
20127
+ Service
20128
+ }
20129
+ }
19924
20130
  /**
19925
20131
  *
19926
20132
  * @export
@@ -21973,6 +22179,12 @@ export interface OrderChannelPartner {
21973
22179
  * @interface OrderCheckout
21974
22180
  */
21975
22181
  export interface OrderCheckout {
22182
+ /**
22183
+ *
22184
+ * @type {Browser}
22185
+ * @memberof OrderCheckout
22186
+ */
22187
+ browser?: Browser;
21976
22188
  /**
21977
22189
  * Comments from the customer. Rarely used on the single page checkout.
21978
22190
  * @type {string}
@@ -22033,6 +22245,12 @@ export interface OrderCheckout {
22033
22245
  * @memberof OrderCheckout
22034
22246
  */
22035
22247
  screen_branding_theme_code?: string;
22248
+ /**
22249
+ * Screen size small, medium or large
22250
+ * @type {string}
22251
+ * @memberof OrderCheckout
22252
+ */
22253
+ screen_size?: string;
22036
22254
  /**
22037
22255
  * StoreFront host name associated with the order
22038
22256
  * @type {string}
@@ -22898,6 +23116,12 @@ export interface OrderItem {
22898
23116
  * @memberof OrderItem
22899
23117
  */
22900
23118
  tax_free?: boolean;
23119
+ /**
23120
+ * Type of product for tax purposes (self or UltraCart Managed taxes)
23121
+ * @type {string}
23122
+ * @memberof OrderItem
23123
+ */
23124
+ tax_product_type?: OrderItem.TaxProductTypeEnum;
22901
23125
  /**
22902
23126
  *
22903
23127
  * @type {Currency}
@@ -22947,6 +23171,22 @@ export interface OrderItem {
22947
23171
  */
22948
23172
  width?: Distance;
22949
23173
  }
23174
+ /**
23175
+ * @export
23176
+ * @namespace OrderItem
23177
+ */
23178
+ export declare namespace OrderItem {
23179
+ /**
23180
+ * @export
23181
+ * @enum {string}
23182
+ */
23183
+ enum TaxProductTypeEnum {
23184
+ Empty,
23185
+ Digital,
23186
+ Physical,
23187
+ Service
23188
+ }
23189
+ }
22950
23190
  /**
22951
23191
  *
22952
23192
  * @export
@@ -31218,6 +31458,24 @@ export interface TaxProviderUltraCartState {
31218
31458
  * @memberof TaxProviderUltraCartState
31219
31459
  */
31220
31460
  enabled?: boolean;
31461
+ /**
31462
+ * True if digital items are exempt from sales tax in this state.
31463
+ * @type {boolean}
31464
+ * @memberof TaxProviderUltraCartState
31465
+ */
31466
+ exempt_digital_items?: boolean;
31467
+ /**
31468
+ * True if physical items are exempt from sales tax in this state.
31469
+ * @type {boolean}
31470
+ * @memberof TaxProviderUltraCartState
31471
+ */
31472
+ exempt_physical_items?: boolean;
31473
+ /**
31474
+ * True if service items are exempt from sales tax in this state.
31475
+ * @type {boolean}
31476
+ * @memberof TaxProviderUltraCartState
31477
+ */
31478
+ exempt_service_items?: boolean;
31221
31479
  /**
31222
31480
  * State Code (2 digits)
31223
31481
  * @type {string}
@@ -31364,6 +31622,24 @@ export interface TaxState {
31364
31622
  * @memberof TaxState
31365
31623
  */
31366
31624
  dont_collect_state?: boolean;
31625
+ /**
31626
+ * True if digital items are exempt from sales tax in this state.
31627
+ * @type {boolean}
31628
+ * @memberof TaxState
31629
+ */
31630
+ exempt_digital_items?: boolean;
31631
+ /**
31632
+ * True if physical items are exempt from sales tax in this state.
31633
+ * @type {boolean}
31634
+ * @memberof TaxState
31635
+ */
31636
+ exempt_physical_items?: boolean;
31637
+ /**
31638
+ * True if service items are exempt from sales tax in this state.
31639
+ * @type {boolean}
31640
+ * @memberof TaxState
31641
+ */
31642
+ exempt_service_items?: boolean;
31367
31643
  /**
31368
31644
  * State code
31369
31645
  * @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.Webhook = exports.TransactionGatewaysRequest = exports.TempMultimedia = exports.RtgThemeRestriction = exports.RotatingTransactionGateway = exports.PaymentsThemeTransactionType = exports.PaymentsConfigurationTestMethod = exports.PaymentsConfigurationSezzle = exports.PaymentsConfigurationRestrictions = exports.PaymentsConfigurationPayPal = exports.PaymentsConfigurationCreditCardType = exports.PaymentsConfigurationAmazon = exports.PaymentsConfigurationAffirm = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailCommseqStep = exports.Distance = exports.CheckoutHandoffRequest = 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.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.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConfigurationApi = exports.ConfigurationApiFactory = exports.ConfigurationApiFp = exports.ConfigurationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = 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 = void 0;
31
+ exports.TempMultimedia = exports.RtgThemeRestriction = exports.RotatingTransactionGateway = exports.PaymentsThemeTransactionType = exports.PaymentsConfigurationTestMethod = exports.PaymentsConfigurationSezzle = exports.PaymentsConfigurationRestrictions = exports.PaymentsConfigurationPayPal = exports.PaymentsConfigurationCreditCardType = exports.PaymentsConfigurationAmazon = exports.PaymentsConfigurationAffirm = 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.EmailCommseqStep = exports.Distance = exports.CheckoutHandoffRequest = 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.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.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConfigurationApi = exports.ConfigurationApiFactory = exports.ConfigurationApiFp = exports.ConfigurationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TransactionGatewaysRequest = 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 = 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(/\/+$/, "");
@@ -519,6 +519,24 @@ var ItemTag;
519
519
  TagTypeEnum[TagTypeEnum["Customer"] = 'customer'] = "Customer";
520
520
  })(TagTypeEnum = ItemTag.TagTypeEnum || (ItemTag.TagTypeEnum = {}));
521
521
  })(ItemTag = exports.ItemTag || (exports.ItemTag = {}));
522
+ /**
523
+ * @export
524
+ * @namespace ItemTax
525
+ */
526
+ var ItemTax;
527
+ (function (ItemTax) {
528
+ /**
529
+ * @export
530
+ * @enum {string}
531
+ */
532
+ var TaxProductTypeEnum;
533
+ (function (TaxProductTypeEnum) {
534
+ TaxProductTypeEnum[TaxProductTypeEnum["Empty"] = ''] = "Empty";
535
+ TaxProductTypeEnum[TaxProductTypeEnum["Digital"] = 'digital'] = "Digital";
536
+ TaxProductTypeEnum[TaxProductTypeEnum["Physical"] = 'physical'] = "Physical";
537
+ TaxProductTypeEnum[TaxProductTypeEnum["Service"] = 'service'] = "Service";
538
+ })(TaxProductTypeEnum = ItemTax.TaxProductTypeEnum || (ItemTax.TaxProductTypeEnum = {}));
539
+ })(ItemTax = exports.ItemTax || (exports.ItemTax = {}));
522
540
  /**
523
541
  * @export
524
542
  * @namespace ItemThirdPartyEmailMarketing
@@ -658,6 +676,24 @@ var OrderFraudScore;
658
676
  BinMatchEnum[BinMatchEnum["Yes"] = 'Yes'] = "Yes";
659
677
  })(BinMatchEnum = OrderFraudScore.BinMatchEnum || (OrderFraudScore.BinMatchEnum = {}));
660
678
  })(OrderFraudScore = exports.OrderFraudScore || (exports.OrderFraudScore = {}));
679
+ /**
680
+ * @export
681
+ * @namespace OrderItem
682
+ */
683
+ var OrderItem;
684
+ (function (OrderItem) {
685
+ /**
686
+ * @export
687
+ * @enum {string}
688
+ */
689
+ var TaxProductTypeEnum;
690
+ (function (TaxProductTypeEnum) {
691
+ TaxProductTypeEnum[TaxProductTypeEnum["Empty"] = ''] = "Empty";
692
+ TaxProductTypeEnum[TaxProductTypeEnum["Digital"] = 'digital'] = "Digital";
693
+ TaxProductTypeEnum[TaxProductTypeEnum["Physical"] = 'physical'] = "Physical";
694
+ TaxProductTypeEnum[TaxProductTypeEnum["Service"] = 'service'] = "Service";
695
+ })(TaxProductTypeEnum = OrderItem.TaxProductTypeEnum || (OrderItem.TaxProductTypeEnum = {}));
696
+ })(OrderItem = exports.OrderItem || (exports.OrderItem = {}));
661
697
  /**
662
698
  * @export
663
699
  * @namespace OrderItemOption
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.9.1",
3
+ "version": "3.9.2",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [