ultracart_rest_api_v2_typescript 3.9.0 → 3.9.3

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.0
1
+ ## ultracart_rest_api_v2_typescript@3.9.3
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.0 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.9.3 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
58
+ | 3.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
59
+ | 3.9.1 | 03/03/2022 | javascript sdk package.json bug fix |
57
60
  | 3.9.0 | 03/03/2022 | removed ultra_cart_rest_api_v2.d.ts from javascript sdk because typescript sdk exists now |
58
61
  | 3.8.8 | 03/02/2022 | bug fix for ruby sdk, uri.escape deprecated in 3.x |
59
62
  | 3.8.7 | 03/02/2022 | bug fix for ruby sdk, uri.escape deprecated in 3.x |
package/api.ts CHANGED
@@ -2004,6 +2004,116 @@ export interface BaseResponse {
2004
2004
  warning?: Warning;
2005
2005
  }
2006
2006
 
2007
+ /**
2008
+ *
2009
+ * @export
2010
+ * @interface Browser
2011
+ */
2012
+ export interface Browser {
2013
+ /**
2014
+ *
2015
+ * @type {BrowserDevice}
2016
+ * @memberof Browser
2017
+ */
2018
+ device?: BrowserDevice;
2019
+ /**
2020
+ *
2021
+ * @type {BrowserOS}
2022
+ * @memberof Browser
2023
+ */
2024
+ os?: BrowserOS;
2025
+ /**
2026
+ *
2027
+ * @type {BrowserUserAgent}
2028
+ * @memberof Browser
2029
+ */
2030
+ user_agent?: BrowserUserAgent;
2031
+ }
2032
+
2033
+ /**
2034
+ *
2035
+ * @export
2036
+ * @interface BrowserDevice
2037
+ */
2038
+ export interface BrowserDevice {
2039
+ /**
2040
+ *
2041
+ * @type {string}
2042
+ * @memberof BrowserDevice
2043
+ */
2044
+ family?: string;
2045
+ }
2046
+
2047
+ /**
2048
+ *
2049
+ * @export
2050
+ * @interface BrowserOS
2051
+ */
2052
+ export interface BrowserOS {
2053
+ /**
2054
+ *
2055
+ * @type {string}
2056
+ * @memberof BrowserOS
2057
+ */
2058
+ family?: string;
2059
+ /**
2060
+ *
2061
+ * @type {string}
2062
+ * @memberof BrowserOS
2063
+ */
2064
+ major?: string;
2065
+ /**
2066
+ *
2067
+ * @type {string}
2068
+ * @memberof BrowserOS
2069
+ */
2070
+ minor?: string;
2071
+ /**
2072
+ *
2073
+ * @type {string}
2074
+ * @memberof BrowserOS
2075
+ */
2076
+ patch?: string;
2077
+ /**
2078
+ *
2079
+ * @type {string}
2080
+ * @memberof BrowserOS
2081
+ */
2082
+ patch_minor?: string;
2083
+ }
2084
+
2085
+ /**
2086
+ *
2087
+ * @export
2088
+ * @interface BrowserUserAgent
2089
+ */
2090
+ export interface BrowserUserAgent {
2091
+ /**
2092
+ *
2093
+ * @type {string}
2094
+ * @memberof BrowserUserAgent
2095
+ */
2096
+ family?: string;
2097
+ /**
2098
+ *
2099
+ * @type {string}
2100
+ * @memberof BrowserUserAgent
2101
+ */
2102
+ major?: string;
2103
+ /**
2104
+ *
2105
+ * @type {string}
2106
+ * @memberof BrowserUserAgent
2107
+ */
2108
+ minor?: string;
2109
+ /**
2110
+ *
2111
+ * @type {string}
2112
+ * @memberof BrowserUserAgent
2113
+ */
2114
+ patch?: string;
2115
+ }
2116
+
2007
2117
  /**
2008
2118
  *
2009
2119
  * @export
@@ -2016,6 +2126,12 @@ export interface Cart {
2016
2126
  * @memberof Cart
2017
2127
  */
2018
2128
  affiliate?: CartAffiliate;
2129
+ /**
2130
+ * The affiliate network pixel identifier associated with the cart
2131
+ * @type {number}
2132
+ * @memberof Cart
2133
+ */
2134
+ affiliate_network_pixel_oid?: number;
2019
2135
  /**
2020
2136
  * The ISO-4217 three letter base currency code of the account
2021
2137
  * @type {string}
@@ -9389,6 +9505,12 @@ export interface DistributionCenter {
9389
9505
  * @memberof DistributionCenter
9390
9506
  */
9391
9507
  state?: string;
9508
+ /**
9509
+ * True if monetary amounts should be zeroed before transmission
9510
+ * @type {boolean}
9511
+ * @memberof DistributionCenter
9512
+ */
9513
+ transmit_blank_costs?: boolean;
9392
9514
  /**
9393
9515
  * Transport mechanism for this distribution center
9394
9516
  * @type {string}
@@ -10319,6 +10441,18 @@ export interface EmailCommseqPostcard {
10319
10441
  * @memberof EmailCommseqPostcard
10320
10442
  */
10321
10443
  postcard_front_container_uuid?: string;
10444
+ /**
10445
+ * URL for front screenshot
10446
+ * @type {string}
10447
+ * @memberof EmailCommseqPostcard
10448
+ */
10449
+ screenshot_front_url?: string;
10450
+ /**
10451
+ * URL for back screenshot
10452
+ * @type {string}
10453
+ * @memberof EmailCommseqPostcard
10454
+ */
10455
+ screenshot_small_full_url?: string;
10322
10456
  /**
10323
10457
  * Storefront oid
10324
10458
  * @type {number}
@@ -11060,6 +11194,56 @@ export interface EmailCommseqWebhookSendTestRequest {
11060
11194
  order_id?: string;
11061
11195
  }
11062
11196
 
11197
+ /**
11198
+ *
11199
+ * @export
11200
+ * @interface EmailCommseqWebhookSendTestResponse
11201
+ */
11202
+ export interface EmailCommseqWebhookSendTestResponse {
11203
+ /**
11204
+ *
11205
+ * @type {ModelError}
11206
+ * @memberof EmailCommseqWebhookSendTestResponse
11207
+ */
11208
+ error?: ModelError;
11209
+ /**
11210
+ *
11211
+ * @type {ResponseMetadata}
11212
+ * @memberof EmailCommseqWebhookSendTestResponse
11213
+ */
11214
+ metadata?: ResponseMetadata;
11215
+ /**
11216
+ * HTTP Request
11217
+ * @type {string}
11218
+ * @memberof EmailCommseqWebhookSendTestResponse
11219
+ */
11220
+ request?: string;
11221
+ /**
11222
+ * HTTP Response
11223
+ * @type {string}
11224
+ * @memberof EmailCommseqWebhookSendTestResponse
11225
+ */
11226
+ response?: string;
11227
+ /**
11228
+ * HTTP Status Code
11229
+ * @type {number}
11230
+ * @memberof EmailCommseqWebhookSendTestResponse
11231
+ */
11232
+ status_code?: number;
11233
+ /**
11234
+ * Indicates if API call was successful
11235
+ * @type {boolean}
11236
+ * @memberof EmailCommseqWebhookSendTestResponse
11237
+ */
11238
+ success?: boolean;
11239
+ /**
11240
+ *
11241
+ * @type {Warning}
11242
+ * @memberof EmailCommseqWebhookSendTestResponse
11243
+ */
11244
+ warning?: Warning;
11245
+ }
11246
+
11063
11247
  /**
11064
11248
  *
11065
11249
  * @export
@@ -15346,6 +15530,12 @@ export interface GiftCertificate {
15346
15530
  * @memberof GiftCertificate
15347
15531
  */
15348
15532
  code?: string;
15533
+ /**
15534
+ * This is the customer profile oid associated with this internally managed gift certificate.
15535
+ * @type {number}
15536
+ * @memberof GiftCertificate
15537
+ */
15538
+ customer_profile_oid?: number;
15349
15539
  /**
15350
15540
  * True if this gift certificate was deleted.
15351
15541
  * @type {boolean}
@@ -15370,6 +15560,12 @@ export interface GiftCertificate {
15370
15560
  * @memberof GiftCertificate
15371
15561
  */
15372
15562
  gift_certificate_oid?: number;
15563
+ /**
15564
+ * This is an internally managed gift certificate associated with the loyalty cash rewards program.
15565
+ * @type {boolean}
15566
+ * @memberof GiftCertificate
15567
+ */
15568
+ internal?: boolean;
15373
15569
  /**
15374
15570
  * A list of all ledger activity for this gift certificate.
15375
15571
  * @type {Array<GiftCertificateLedgerEntry>}
@@ -20353,6 +20549,12 @@ export interface ItemTax {
20353
20549
  * @memberof ItemTax
20354
20550
  */
20355
20551
  tax_free?: boolean;
20552
+ /**
20553
+ * Tax product type
20554
+ * @type {string}
20555
+ * @memberof ItemTax
20556
+ */
20557
+ tax_product_type?: ItemTax.TaxProductTypeEnum;
20356
20558
  /**
20357
20559
  * Taxable cost if different than regular cost
20358
20560
  * @type {number}
@@ -20361,6 +20563,23 @@ export interface ItemTax {
20361
20563
  taxable_cost?: number;
20362
20564
  }
20363
20565
 
20566
+ /**
20567
+ * @export
20568
+ * @namespace ItemTax
20569
+ */
20570
+ export namespace ItemTax {
20571
+ /**
20572
+ * @export
20573
+ * @enum {string}
20574
+ */
20575
+ export enum TaxProductTypeEnum {
20576
+ Empty = <any> '',
20577
+ Digital = <any> 'digital',
20578
+ Physical = <any> 'physical',
20579
+ Service = <any> 'service'
20580
+ }
20581
+ }
20582
+
20364
20583
  /**
20365
20584
  *
20366
20585
  * @export
@@ -22457,6 +22676,12 @@ export interface OrderChannelPartner {
22457
22676
  * @interface OrderCheckout
22458
22677
  */
22459
22678
  export interface OrderCheckout {
22679
+ /**
22680
+ *
22681
+ * @type {Browser}
22682
+ * @memberof OrderCheckout
22683
+ */
22684
+ browser?: Browser;
22460
22685
  /**
22461
22686
  * Comments from the customer. Rarely used on the single page checkout.
22462
22687
  * @type {string}
@@ -22517,6 +22742,12 @@ export interface OrderCheckout {
22517
22742
  * @memberof OrderCheckout
22518
22743
  */
22519
22744
  screen_branding_theme_code?: string;
22745
+ /**
22746
+ * Screen size small, medium or large
22747
+ * @type {string}
22748
+ * @memberof OrderCheckout
22749
+ */
22750
+ screen_size?: string;
22520
22751
  /**
22521
22752
  * StoreFront host name associated with the order
22522
22753
  * @type {string}
@@ -23395,6 +23626,12 @@ export interface OrderItem {
23395
23626
  * @memberof OrderItem
23396
23627
  */
23397
23628
  tax_free?: boolean;
23629
+ /**
23630
+ * Type of product for tax purposes (self or UltraCart Managed taxes)
23631
+ * @type {string}
23632
+ * @memberof OrderItem
23633
+ */
23634
+ tax_product_type?: OrderItem.TaxProductTypeEnum;
23398
23635
  /**
23399
23636
  *
23400
23637
  * @type {Currency}
@@ -23445,6 +23682,23 @@ export interface OrderItem {
23445
23682
  width?: Distance;
23446
23683
  }
23447
23684
 
23685
+ /**
23686
+ * @export
23687
+ * @namespace OrderItem
23688
+ */
23689
+ export namespace OrderItem {
23690
+ /**
23691
+ * @export
23692
+ * @enum {string}
23693
+ */
23694
+ export enum TaxProductTypeEnum {
23695
+ Empty = <any> '',
23696
+ Digital = <any> 'digital',
23697
+ Physical = <any> 'physical',
23698
+ Service = <any> 'service'
23699
+ }
23700
+ }
23701
+
23448
23702
  /**
23449
23703
  *
23450
23704
  * @export
@@ -31886,6 +32140,24 @@ export interface TaxProviderUltraCartState {
31886
32140
  * @memberof TaxProviderUltraCartState
31887
32141
  */
31888
32142
  enabled?: boolean;
32143
+ /**
32144
+ * True if digital items are exempt from sales tax in this state.
32145
+ * @type {boolean}
32146
+ * @memberof TaxProviderUltraCartState
32147
+ */
32148
+ exempt_digital_items?: boolean;
32149
+ /**
32150
+ * True if physical items are exempt from sales tax in this state.
32151
+ * @type {boolean}
32152
+ * @memberof TaxProviderUltraCartState
32153
+ */
32154
+ exempt_physical_items?: boolean;
32155
+ /**
32156
+ * True if service items are exempt from sales tax in this state.
32157
+ * @type {boolean}
32158
+ * @memberof TaxProviderUltraCartState
32159
+ */
32160
+ exempt_service_items?: boolean;
31889
32161
  /**
31890
32162
  * State Code (2 digits)
31891
32163
  * @type {string}
@@ -32034,6 +32306,24 @@ export interface TaxState {
32034
32306
  * @memberof TaxState
32035
32307
  */
32036
32308
  dont_collect_state?: boolean;
32309
+ /**
32310
+ * True if digital items are exempt from sales tax in this state.
32311
+ * @type {boolean}
32312
+ * @memberof TaxState
32313
+ */
32314
+ exempt_digital_items?: boolean;
32315
+ /**
32316
+ * True if physical items are exempt from sales tax in this state.
32317
+ * @type {boolean}
32318
+ * @memberof TaxState
32319
+ */
32320
+ exempt_physical_items?: boolean;
32321
+ /**
32322
+ * True if service items are exempt from sales tax in this state.
32323
+ * @type {boolean}
32324
+ * @memberof TaxState
32325
+ */
32326
+ exempt_service_items?: boolean;
32037
32327
  /**
32038
32328
  * State code
32039
32329
  * @type {string}
@@ -65228,7 +65518,7 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
65228
65518
  * @param {*} [options] Override http request option.
65229
65519
  * @throws {RequiredError}
65230
65520
  */
65231
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqEmailSendTestResponse> {
65521
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse> {
65232
65522
  const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).sendWebhookTest(storefront_oid, email_commseq_webhook_test_request, options);
65233
65523
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
65234
65524
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -69099,7 +69389,7 @@ export interface StorefrontApiInterface {
69099
69389
  * @throws {RequiredError}
69100
69390
  * @memberof StorefrontApiInterface
69101
69391
  */
69102
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
69392
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
69103
69393
 
69104
69394
  /**
69105
69395
  *
package/dist/api.d.ts CHANGED
@@ -1949,6 +1949,112 @@ export interface BaseResponse {
1949
1949
  */
1950
1950
  warning?: Warning;
1951
1951
  }
1952
+ /**
1953
+ *
1954
+ * @export
1955
+ * @interface Browser
1956
+ */
1957
+ export interface Browser {
1958
+ /**
1959
+ *
1960
+ * @type {BrowserDevice}
1961
+ * @memberof Browser
1962
+ */
1963
+ device?: BrowserDevice;
1964
+ /**
1965
+ *
1966
+ * @type {BrowserOS}
1967
+ * @memberof Browser
1968
+ */
1969
+ os?: BrowserOS;
1970
+ /**
1971
+ *
1972
+ * @type {BrowserUserAgent}
1973
+ * @memberof Browser
1974
+ */
1975
+ user_agent?: BrowserUserAgent;
1976
+ }
1977
+ /**
1978
+ *
1979
+ * @export
1980
+ * @interface BrowserDevice
1981
+ */
1982
+ export interface BrowserDevice {
1983
+ /**
1984
+ *
1985
+ * @type {string}
1986
+ * @memberof BrowserDevice
1987
+ */
1988
+ family?: string;
1989
+ }
1990
+ /**
1991
+ *
1992
+ * @export
1993
+ * @interface BrowserOS
1994
+ */
1995
+ export interface BrowserOS {
1996
+ /**
1997
+ *
1998
+ * @type {string}
1999
+ * @memberof BrowserOS
2000
+ */
2001
+ family?: string;
2002
+ /**
2003
+ *
2004
+ * @type {string}
2005
+ * @memberof BrowserOS
2006
+ */
2007
+ major?: string;
2008
+ /**
2009
+ *
2010
+ * @type {string}
2011
+ * @memberof BrowserOS
2012
+ */
2013
+ minor?: string;
2014
+ /**
2015
+ *
2016
+ * @type {string}
2017
+ * @memberof BrowserOS
2018
+ */
2019
+ patch?: string;
2020
+ /**
2021
+ *
2022
+ * @type {string}
2023
+ * @memberof BrowserOS
2024
+ */
2025
+ patch_minor?: string;
2026
+ }
2027
+ /**
2028
+ *
2029
+ * @export
2030
+ * @interface BrowserUserAgent
2031
+ */
2032
+ export interface BrowserUserAgent {
2033
+ /**
2034
+ *
2035
+ * @type {string}
2036
+ * @memberof BrowserUserAgent
2037
+ */
2038
+ family?: string;
2039
+ /**
2040
+ *
2041
+ * @type {string}
2042
+ * @memberof BrowserUserAgent
2043
+ */
2044
+ major?: string;
2045
+ /**
2046
+ *
2047
+ * @type {string}
2048
+ * @memberof BrowserUserAgent
2049
+ */
2050
+ minor?: string;
2051
+ /**
2052
+ *
2053
+ * @type {string}
2054
+ * @memberof BrowserUserAgent
2055
+ */
2056
+ patch?: string;
2057
+ }
1952
2058
  /**
1953
2059
  *
1954
2060
  * @export
@@ -1961,6 +2067,12 @@ export interface Cart {
1961
2067
  * @memberof Cart
1962
2068
  */
1963
2069
  affiliate?: CartAffiliate;
2070
+ /**
2071
+ * The affiliate network pixel identifier associated with the cart
2072
+ * @type {number}
2073
+ * @memberof Cart
2074
+ */
2075
+ affiliate_network_pixel_oid?: number;
1964
2076
  /**
1965
2077
  * The ISO-4217 three letter base currency code of the account
1966
2078
  * @type {string}
@@ -9167,6 +9279,12 @@ export interface DistributionCenter {
9167
9279
  * @memberof DistributionCenter
9168
9280
  */
9169
9281
  state?: string;
9282
+ /**
9283
+ * True if monetary amounts should be zeroed before transmission
9284
+ * @type {boolean}
9285
+ * @memberof DistributionCenter
9286
+ */
9287
+ transmit_blank_costs?: boolean;
9170
9288
  /**
9171
9289
  * Transport mechanism for this distribution center
9172
9290
  * @type {string}
@@ -10079,6 +10197,18 @@ export interface EmailCommseqPostcard {
10079
10197
  * @memberof EmailCommseqPostcard
10080
10198
  */
10081
10199
  postcard_front_container_uuid?: string;
10200
+ /**
10201
+ * URL for front screenshot
10202
+ * @type {string}
10203
+ * @memberof EmailCommseqPostcard
10204
+ */
10205
+ screenshot_front_url?: string;
10206
+ /**
10207
+ * URL for back screenshot
10208
+ * @type {string}
10209
+ * @memberof EmailCommseqPostcard
10210
+ */
10211
+ screenshot_small_full_url?: string;
10082
10212
  /**
10083
10213
  * Storefront oid
10084
10214
  * @type {number}
@@ -10806,6 +10936,55 @@ export interface EmailCommseqWebhookSendTestRequest {
10806
10936
  */
10807
10937
  order_id?: string;
10808
10938
  }
10939
+ /**
10940
+ *
10941
+ * @export
10942
+ * @interface EmailCommseqWebhookSendTestResponse
10943
+ */
10944
+ export interface EmailCommseqWebhookSendTestResponse {
10945
+ /**
10946
+ *
10947
+ * @type {ModelError}
10948
+ * @memberof EmailCommseqWebhookSendTestResponse
10949
+ */
10950
+ error?: ModelError;
10951
+ /**
10952
+ *
10953
+ * @type {ResponseMetadata}
10954
+ * @memberof EmailCommseqWebhookSendTestResponse
10955
+ */
10956
+ metadata?: ResponseMetadata;
10957
+ /**
10958
+ * HTTP Request
10959
+ * @type {string}
10960
+ * @memberof EmailCommseqWebhookSendTestResponse
10961
+ */
10962
+ request?: string;
10963
+ /**
10964
+ * HTTP Response
10965
+ * @type {string}
10966
+ * @memberof EmailCommseqWebhookSendTestResponse
10967
+ */
10968
+ response?: string;
10969
+ /**
10970
+ * HTTP Status Code
10971
+ * @type {number}
10972
+ * @memberof EmailCommseqWebhookSendTestResponse
10973
+ */
10974
+ status_code?: number;
10975
+ /**
10976
+ * Indicates if API call was successful
10977
+ * @type {boolean}
10978
+ * @memberof EmailCommseqWebhookSendTestResponse
10979
+ */
10980
+ success?: boolean;
10981
+ /**
10982
+ *
10983
+ * @type {Warning}
10984
+ * @memberof EmailCommseqWebhookSendTestResponse
10985
+ */
10986
+ warning?: Warning;
10987
+ }
10809
10988
  /**
10810
10989
  *
10811
10990
  * @export
@@ -15002,6 +15181,12 @@ export interface GiftCertificate {
15002
15181
  * @memberof GiftCertificate
15003
15182
  */
15004
15183
  code?: string;
15184
+ /**
15185
+ * This is the customer profile oid associated with this internally managed gift certificate.
15186
+ * @type {number}
15187
+ * @memberof GiftCertificate
15188
+ */
15189
+ customer_profile_oid?: number;
15005
15190
  /**
15006
15191
  * True if this gift certificate was deleted.
15007
15192
  * @type {boolean}
@@ -15026,6 +15211,12 @@ export interface GiftCertificate {
15026
15211
  * @memberof GiftCertificate
15027
15212
  */
15028
15213
  gift_certificate_oid?: number;
15214
+ /**
15215
+ * This is an internally managed gift certificate associated with the loyalty cash rewards program.
15216
+ * @type {boolean}
15217
+ * @memberof GiftCertificate
15218
+ */
15219
+ internal?: boolean;
15029
15220
  /**
15030
15221
  * A list of all ledger activity for this gift certificate.
15031
15222
  * @type {Array<GiftCertificateLedgerEntry>}
@@ -19914,6 +20105,12 @@ export interface ItemTax {
19914
20105
  * @memberof ItemTax
19915
20106
  */
19916
20107
  tax_free?: boolean;
20108
+ /**
20109
+ * Tax product type
20110
+ * @type {string}
20111
+ * @memberof ItemTax
20112
+ */
20113
+ tax_product_type?: ItemTax.TaxProductTypeEnum;
19917
20114
  /**
19918
20115
  * Taxable cost if different than regular cost
19919
20116
  * @type {number}
@@ -19921,6 +20118,22 @@ export interface ItemTax {
19921
20118
  */
19922
20119
  taxable_cost?: number;
19923
20120
  }
20121
+ /**
20122
+ * @export
20123
+ * @namespace ItemTax
20124
+ */
20125
+ export declare namespace ItemTax {
20126
+ /**
20127
+ * @export
20128
+ * @enum {string}
20129
+ */
20130
+ enum TaxProductTypeEnum {
20131
+ Empty,
20132
+ Digital,
20133
+ Physical,
20134
+ Service
20135
+ }
20136
+ }
19924
20137
  /**
19925
20138
  *
19926
20139
  * @export
@@ -21973,6 +22186,12 @@ export interface OrderChannelPartner {
21973
22186
  * @interface OrderCheckout
21974
22187
  */
21975
22188
  export interface OrderCheckout {
22189
+ /**
22190
+ *
22191
+ * @type {Browser}
22192
+ * @memberof OrderCheckout
22193
+ */
22194
+ browser?: Browser;
21976
22195
  /**
21977
22196
  * Comments from the customer. Rarely used on the single page checkout.
21978
22197
  * @type {string}
@@ -22033,6 +22252,12 @@ export interface OrderCheckout {
22033
22252
  * @memberof OrderCheckout
22034
22253
  */
22035
22254
  screen_branding_theme_code?: string;
22255
+ /**
22256
+ * Screen size small, medium or large
22257
+ * @type {string}
22258
+ * @memberof OrderCheckout
22259
+ */
22260
+ screen_size?: string;
22036
22261
  /**
22037
22262
  * StoreFront host name associated with the order
22038
22263
  * @type {string}
@@ -22898,6 +23123,12 @@ export interface OrderItem {
22898
23123
  * @memberof OrderItem
22899
23124
  */
22900
23125
  tax_free?: boolean;
23126
+ /**
23127
+ * Type of product for tax purposes (self or UltraCart Managed taxes)
23128
+ * @type {string}
23129
+ * @memberof OrderItem
23130
+ */
23131
+ tax_product_type?: OrderItem.TaxProductTypeEnum;
22901
23132
  /**
22902
23133
  *
22903
23134
  * @type {Currency}
@@ -22947,6 +23178,22 @@ export interface OrderItem {
22947
23178
  */
22948
23179
  width?: Distance;
22949
23180
  }
23181
+ /**
23182
+ * @export
23183
+ * @namespace OrderItem
23184
+ */
23185
+ export declare namespace OrderItem {
23186
+ /**
23187
+ * @export
23188
+ * @enum {string}
23189
+ */
23190
+ enum TaxProductTypeEnum {
23191
+ Empty,
23192
+ Digital,
23193
+ Physical,
23194
+ Service
23195
+ }
23196
+ }
22950
23197
  /**
22951
23198
  *
22952
23199
  * @export
@@ -31218,6 +31465,24 @@ export interface TaxProviderUltraCartState {
31218
31465
  * @memberof TaxProviderUltraCartState
31219
31466
  */
31220
31467
  enabled?: boolean;
31468
+ /**
31469
+ * True if digital items are exempt from sales tax in this state.
31470
+ * @type {boolean}
31471
+ * @memberof TaxProviderUltraCartState
31472
+ */
31473
+ exempt_digital_items?: boolean;
31474
+ /**
31475
+ * True if physical items are exempt from sales tax in this state.
31476
+ * @type {boolean}
31477
+ * @memberof TaxProviderUltraCartState
31478
+ */
31479
+ exempt_physical_items?: boolean;
31480
+ /**
31481
+ * True if service items are exempt from sales tax in this state.
31482
+ * @type {boolean}
31483
+ * @memberof TaxProviderUltraCartState
31484
+ */
31485
+ exempt_service_items?: boolean;
31221
31486
  /**
31222
31487
  * State Code (2 digits)
31223
31488
  * @type {string}
@@ -31364,6 +31629,24 @@ export interface TaxState {
31364
31629
  * @memberof TaxState
31365
31630
  */
31366
31631
  dont_collect_state?: boolean;
31632
+ /**
31633
+ * True if digital items are exempt from sales tax in this state.
31634
+ * @type {boolean}
31635
+ * @memberof TaxState
31636
+ */
31637
+ exempt_digital_items?: boolean;
31638
+ /**
31639
+ * True if physical items are exempt from sales tax in this state.
31640
+ * @type {boolean}
31641
+ * @memberof TaxState
31642
+ */
31643
+ exempt_physical_items?: boolean;
31644
+ /**
31645
+ * True if service items are exempt from sales tax in this state.
31646
+ * @type {boolean}
31647
+ * @memberof TaxState
31648
+ */
31649
+ exempt_service_items?: boolean;
31367
31650
  /**
31368
31651
  * State code
31369
31652
  * @type {string}
@@ -43488,7 +43771,7 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
43488
43771
  * @param {*} [options] Override http request option.
43489
43772
  * @throws {RequiredError}
43490
43773
  */
43491
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqEmailSendTestResponse>;
43774
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse>;
43492
43775
  /**
43493
43776
  *
43494
43777
  * @summary Start email campaign
@@ -44957,7 +45240,7 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
44957
45240
  * @param {*} [options] Override http request option.
44958
45241
  * @throws {RequiredError}
44959
45242
  */
44960
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
45243
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
44961
45244
  /**
44962
45245
  *
44963
45246
  * @summary Start email campaign
@@ -46562,7 +46845,7 @@ export interface StorefrontApiInterface {
46562
46845
  * @throws {RequiredError}
46563
46846
  * @memberof StorefrontApiInterface
46564
46847
  */
46565
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
46848
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
46566
46849
  /**
46567
46850
  *
46568
46851
  * @summary Start email campaign
@@ -48193,7 +48476,7 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
48193
48476
  * @throws {RequiredError}
48194
48477
  * @memberof StorefrontApi
48195
48478
  */
48196
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
48479
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
48197
48480
  /**
48198
48481
  *
48199
48482
  * @summary Start email campaign
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.0",
3
+ "version": "3.9.3",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [