ultracart_rest_api_v2_typescript 3.9.1 → 3.9.4

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.4
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.4 --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.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
58
+ | 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
59
+ | 3.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
57
60
  | 3.9.1 | 03/03/2022 | javascript sdk package.json bug fix |
58
61
  | 3.9.0 | 03/03/2022 | removed ultra_cart_rest_api_v2.d.ts from javascript sdk because typescript sdk exists now |
59
62
  | 3.8.8 | 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}
@@ -8216,6 +8332,18 @@ export interface CustomerLoyalty {
8216
8332
  * @memberof CustomerLoyalty
8217
8333
  */
8218
8334
  current_points?: number;
8335
+ /**
8336
+ * Loyalty Cashback / Store credit balance (internal gift certificate balance)
8337
+ * @type {string}
8338
+ * @memberof CustomerLoyalty
8339
+ */
8340
+ internal_gift_certificate_balance?: string;
8341
+ /**
8342
+ * Internal gift certificate oid used to tracking loyalty cashback / store credit.
8343
+ * @type {number}
8344
+ * @memberof CustomerLoyalty
8345
+ */
8346
+ internal_gift_certificate_oid?: number;
8219
8347
  /**
8220
8348
  * Ledger entries
8221
8349
  * @type {Array<CustomerLoyaltyLedger>}
@@ -9389,6 +9517,12 @@ export interface DistributionCenter {
9389
9517
  * @memberof DistributionCenter
9390
9518
  */
9391
9519
  state?: string;
9520
+ /**
9521
+ * True if monetary amounts should be zeroed before transmission
9522
+ * @type {boolean}
9523
+ * @memberof DistributionCenter
9524
+ */
9525
+ transmit_blank_costs?: boolean;
9392
9526
  /**
9393
9527
  * Transport mechanism for this distribution center
9394
9528
  * @type {string}
@@ -10319,6 +10453,18 @@ export interface EmailCommseqPostcard {
10319
10453
  * @memberof EmailCommseqPostcard
10320
10454
  */
10321
10455
  postcard_front_container_uuid?: string;
10456
+ /**
10457
+ * URL for front screenshot
10458
+ * @type {string}
10459
+ * @memberof EmailCommseqPostcard
10460
+ */
10461
+ screenshot_front_url?: string;
10462
+ /**
10463
+ * URL for back screenshot
10464
+ * @type {string}
10465
+ * @memberof EmailCommseqPostcard
10466
+ */
10467
+ screenshot_small_full_url?: string;
10322
10468
  /**
10323
10469
  * Storefront oid
10324
10470
  * @type {number}
@@ -11060,6 +11206,56 @@ export interface EmailCommseqWebhookSendTestRequest {
11060
11206
  order_id?: string;
11061
11207
  }
11062
11208
 
11209
+ /**
11210
+ *
11211
+ * @export
11212
+ * @interface EmailCommseqWebhookSendTestResponse
11213
+ */
11214
+ export interface EmailCommseqWebhookSendTestResponse {
11215
+ /**
11216
+ *
11217
+ * @type {ModelError}
11218
+ * @memberof EmailCommseqWebhookSendTestResponse
11219
+ */
11220
+ error?: ModelError;
11221
+ /**
11222
+ *
11223
+ * @type {ResponseMetadata}
11224
+ * @memberof EmailCommseqWebhookSendTestResponse
11225
+ */
11226
+ metadata?: ResponseMetadata;
11227
+ /**
11228
+ * HTTP Request
11229
+ * @type {string}
11230
+ * @memberof EmailCommseqWebhookSendTestResponse
11231
+ */
11232
+ request?: string;
11233
+ /**
11234
+ * HTTP Response
11235
+ * @type {string}
11236
+ * @memberof EmailCommseqWebhookSendTestResponse
11237
+ */
11238
+ response?: string;
11239
+ /**
11240
+ * HTTP Status Code
11241
+ * @type {number}
11242
+ * @memberof EmailCommseqWebhookSendTestResponse
11243
+ */
11244
+ status_code?: number;
11245
+ /**
11246
+ * Indicates if API call was successful
11247
+ * @type {boolean}
11248
+ * @memberof EmailCommseqWebhookSendTestResponse
11249
+ */
11250
+ success?: boolean;
11251
+ /**
11252
+ *
11253
+ * @type {Warning}
11254
+ * @memberof EmailCommseqWebhookSendTestResponse
11255
+ */
11256
+ warning?: Warning;
11257
+ }
11258
+
11063
11259
  /**
11064
11260
  *
11065
11261
  * @export
@@ -11410,6 +11606,12 @@ export interface EmailDomain {
11410
11606
  * @memberof EmailDomain
11411
11607
  */
11412
11608
  provider?: string;
11609
+ /**
11610
+ *
11611
+ * @type {VerificationRecord}
11612
+ * @memberof EmailDomain
11613
+ */
11614
+ spf?: VerificationRecord;
11413
11615
  /**
11414
11616
  *
11415
11617
  * @type {string}
@@ -15346,6 +15548,12 @@ export interface GiftCertificate {
15346
15548
  * @memberof GiftCertificate
15347
15549
  */
15348
15550
  code?: string;
15551
+ /**
15552
+ * This is the customer profile oid associated with this internally managed gift certificate.
15553
+ * @type {number}
15554
+ * @memberof GiftCertificate
15555
+ */
15556
+ customer_profile_oid?: number;
15349
15557
  /**
15350
15558
  * True if this gift certificate was deleted.
15351
15559
  * @type {boolean}
@@ -15370,6 +15578,12 @@ export interface GiftCertificate {
15370
15578
  * @memberof GiftCertificate
15371
15579
  */
15372
15580
  gift_certificate_oid?: number;
15581
+ /**
15582
+ * This is an internally managed gift certificate associated with the loyalty cash rewards program.
15583
+ * @type {boolean}
15584
+ * @memberof GiftCertificate
15585
+ */
15586
+ internal?: boolean;
15373
15587
  /**
15374
15588
  * A list of all ledger activity for this gift certificate.
15375
15589
  * @type {Array<GiftCertificateLedgerEntry>}
@@ -20353,6 +20567,12 @@ export interface ItemTax {
20353
20567
  * @memberof ItemTax
20354
20568
  */
20355
20569
  tax_free?: boolean;
20570
+ /**
20571
+ * Tax product type
20572
+ * @type {string}
20573
+ * @memberof ItemTax
20574
+ */
20575
+ tax_product_type?: ItemTax.TaxProductTypeEnum;
20356
20576
  /**
20357
20577
  * Taxable cost if different than regular cost
20358
20578
  * @type {number}
@@ -20361,6 +20581,23 @@ export interface ItemTax {
20361
20581
  taxable_cost?: number;
20362
20582
  }
20363
20583
 
20584
+ /**
20585
+ * @export
20586
+ * @namespace ItemTax
20587
+ */
20588
+ export namespace ItemTax {
20589
+ /**
20590
+ * @export
20591
+ * @enum {string}
20592
+ */
20593
+ export enum TaxProductTypeEnum {
20594
+ Empty = <any> '',
20595
+ Digital = <any> 'digital',
20596
+ Physical = <any> 'physical',
20597
+ Service = <any> 'service'
20598
+ }
20599
+ }
20600
+
20364
20601
  /**
20365
20602
  *
20366
20603
  * @export
@@ -22457,6 +22694,12 @@ export interface OrderChannelPartner {
22457
22694
  * @interface OrderCheckout
22458
22695
  */
22459
22696
  export interface OrderCheckout {
22697
+ /**
22698
+ *
22699
+ * @type {Browser}
22700
+ * @memberof OrderCheckout
22701
+ */
22702
+ browser?: Browser;
22460
22703
  /**
22461
22704
  * Comments from the customer. Rarely used on the single page checkout.
22462
22705
  * @type {string}
@@ -22517,6 +22760,12 @@ export interface OrderCheckout {
22517
22760
  * @memberof OrderCheckout
22518
22761
  */
22519
22762
  screen_branding_theme_code?: string;
22763
+ /**
22764
+ * Screen size small, medium or large
22765
+ * @type {string}
22766
+ * @memberof OrderCheckout
22767
+ */
22768
+ screen_size?: string;
22520
22769
  /**
22521
22770
  * StoreFront host name associated with the order
22522
22771
  * @type {string}
@@ -23395,6 +23644,12 @@ export interface OrderItem {
23395
23644
  * @memberof OrderItem
23396
23645
  */
23397
23646
  tax_free?: boolean;
23647
+ /**
23648
+ * Type of product for tax purposes (self or UltraCart Managed taxes)
23649
+ * @type {string}
23650
+ * @memberof OrderItem
23651
+ */
23652
+ tax_product_type?: OrderItem.TaxProductTypeEnum;
23398
23653
  /**
23399
23654
  *
23400
23655
  * @type {Currency}
@@ -23445,6 +23700,23 @@ export interface OrderItem {
23445
23700
  width?: Distance;
23446
23701
  }
23447
23702
 
23703
+ /**
23704
+ * @export
23705
+ * @namespace OrderItem
23706
+ */
23707
+ export namespace OrderItem {
23708
+ /**
23709
+ * @export
23710
+ * @enum {string}
23711
+ */
23712
+ export enum TaxProductTypeEnum {
23713
+ Empty = <any> '',
23714
+ Digital = <any> 'digital',
23715
+ Physical = <any> 'physical',
23716
+ Service = <any> 'service'
23717
+ }
23718
+ }
23719
+
23448
23720
  /**
23449
23721
  *
23450
23722
  * @export
@@ -31886,6 +32158,24 @@ export interface TaxProviderUltraCartState {
31886
32158
  * @memberof TaxProviderUltraCartState
31887
32159
  */
31888
32160
  enabled?: boolean;
32161
+ /**
32162
+ * True if digital items are exempt from sales tax in this state.
32163
+ * @type {boolean}
32164
+ * @memberof TaxProviderUltraCartState
32165
+ */
32166
+ exempt_digital_items?: boolean;
32167
+ /**
32168
+ * True if physical items are exempt from sales tax in this state.
32169
+ * @type {boolean}
32170
+ * @memberof TaxProviderUltraCartState
32171
+ */
32172
+ exempt_physical_items?: boolean;
32173
+ /**
32174
+ * True if service items are exempt from sales tax in this state.
32175
+ * @type {boolean}
32176
+ * @memberof TaxProviderUltraCartState
32177
+ */
32178
+ exempt_service_items?: boolean;
31889
32179
  /**
31890
32180
  * State Code (2 digits)
31891
32181
  * @type {string}
@@ -32034,6 +32324,24 @@ export interface TaxState {
32034
32324
  * @memberof TaxState
32035
32325
  */
32036
32326
  dont_collect_state?: boolean;
32327
+ /**
32328
+ * True if digital items are exempt from sales tax in this state.
32329
+ * @type {boolean}
32330
+ * @memberof TaxState
32331
+ */
32332
+ exempt_digital_items?: boolean;
32333
+ /**
32334
+ * True if physical items are exempt from sales tax in this state.
32335
+ * @type {boolean}
32336
+ * @memberof TaxState
32337
+ */
32338
+ exempt_physical_items?: boolean;
32339
+ /**
32340
+ * True if service items are exempt from sales tax in this state.
32341
+ * @type {boolean}
32342
+ * @memberof TaxState
32343
+ */
32344
+ exempt_service_items?: boolean;
32037
32345
  /**
32038
32346
  * State code
32039
32347
  * @type {string}
@@ -65228,7 +65536,7 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
65228
65536
  * @param {*} [options] Override http request option.
65229
65537
  * @throws {RequiredError}
65230
65538
  */
65231
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqEmailSendTestResponse> {
65539
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse> {
65232
65540
  const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).sendWebhookTest(storefront_oid, email_commseq_webhook_test_request, options);
65233
65541
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
65234
65542
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -69099,7 +69407,7 @@ export interface StorefrontApiInterface {
69099
69407
  * @throws {RequiredError}
69100
69408
  * @memberof StorefrontApiInterface
69101
69409
  */
69102
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
69410
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
69103
69411
 
69104
69412
  /**
69105
69413
  *
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}
@@ -8013,6 +8125,18 @@ export interface CustomerLoyalty {
8013
8125
  * @memberof CustomerLoyalty
8014
8126
  */
8015
8127
  current_points?: number;
8128
+ /**
8129
+ * Loyalty Cashback / Store credit balance (internal gift certificate balance)
8130
+ * @type {string}
8131
+ * @memberof CustomerLoyalty
8132
+ */
8133
+ internal_gift_certificate_balance?: string;
8134
+ /**
8135
+ * Internal gift certificate oid used to tracking loyalty cashback / store credit.
8136
+ * @type {number}
8137
+ * @memberof CustomerLoyalty
8138
+ */
8139
+ internal_gift_certificate_oid?: number;
8016
8140
  /**
8017
8141
  * Ledger entries
8018
8142
  * @type {Array<CustomerLoyaltyLedger>}
@@ -9167,6 +9291,12 @@ export interface DistributionCenter {
9167
9291
  * @memberof DistributionCenter
9168
9292
  */
9169
9293
  state?: string;
9294
+ /**
9295
+ * True if monetary amounts should be zeroed before transmission
9296
+ * @type {boolean}
9297
+ * @memberof DistributionCenter
9298
+ */
9299
+ transmit_blank_costs?: boolean;
9170
9300
  /**
9171
9301
  * Transport mechanism for this distribution center
9172
9302
  * @type {string}
@@ -10079,6 +10209,18 @@ export interface EmailCommseqPostcard {
10079
10209
  * @memberof EmailCommseqPostcard
10080
10210
  */
10081
10211
  postcard_front_container_uuid?: string;
10212
+ /**
10213
+ * URL for front screenshot
10214
+ * @type {string}
10215
+ * @memberof EmailCommseqPostcard
10216
+ */
10217
+ screenshot_front_url?: string;
10218
+ /**
10219
+ * URL for back screenshot
10220
+ * @type {string}
10221
+ * @memberof EmailCommseqPostcard
10222
+ */
10223
+ screenshot_small_full_url?: string;
10082
10224
  /**
10083
10225
  * Storefront oid
10084
10226
  * @type {number}
@@ -10806,6 +10948,55 @@ export interface EmailCommseqWebhookSendTestRequest {
10806
10948
  */
10807
10949
  order_id?: string;
10808
10950
  }
10951
+ /**
10952
+ *
10953
+ * @export
10954
+ * @interface EmailCommseqWebhookSendTestResponse
10955
+ */
10956
+ export interface EmailCommseqWebhookSendTestResponse {
10957
+ /**
10958
+ *
10959
+ * @type {ModelError}
10960
+ * @memberof EmailCommseqWebhookSendTestResponse
10961
+ */
10962
+ error?: ModelError;
10963
+ /**
10964
+ *
10965
+ * @type {ResponseMetadata}
10966
+ * @memberof EmailCommseqWebhookSendTestResponse
10967
+ */
10968
+ metadata?: ResponseMetadata;
10969
+ /**
10970
+ * HTTP Request
10971
+ * @type {string}
10972
+ * @memberof EmailCommseqWebhookSendTestResponse
10973
+ */
10974
+ request?: string;
10975
+ /**
10976
+ * HTTP Response
10977
+ * @type {string}
10978
+ * @memberof EmailCommseqWebhookSendTestResponse
10979
+ */
10980
+ response?: string;
10981
+ /**
10982
+ * HTTP Status Code
10983
+ * @type {number}
10984
+ * @memberof EmailCommseqWebhookSendTestResponse
10985
+ */
10986
+ status_code?: number;
10987
+ /**
10988
+ * Indicates if API call was successful
10989
+ * @type {boolean}
10990
+ * @memberof EmailCommseqWebhookSendTestResponse
10991
+ */
10992
+ success?: boolean;
10993
+ /**
10994
+ *
10995
+ * @type {Warning}
10996
+ * @memberof EmailCommseqWebhookSendTestResponse
10997
+ */
10998
+ warning?: Warning;
10999
+ }
10809
11000
  /**
10810
11001
  *
10811
11002
  * @export
@@ -11149,6 +11340,12 @@ export interface EmailDomain {
11149
11340
  * @memberof EmailDomain
11150
11341
  */
11151
11342
  provider?: string;
11343
+ /**
11344
+ *
11345
+ * @type {VerificationRecord}
11346
+ * @memberof EmailDomain
11347
+ */
11348
+ spf?: VerificationRecord;
11152
11349
  /**
11153
11350
  *
11154
11351
  * @type {string}
@@ -15002,6 +15199,12 @@ export interface GiftCertificate {
15002
15199
  * @memberof GiftCertificate
15003
15200
  */
15004
15201
  code?: string;
15202
+ /**
15203
+ * This is the customer profile oid associated with this internally managed gift certificate.
15204
+ * @type {number}
15205
+ * @memberof GiftCertificate
15206
+ */
15207
+ customer_profile_oid?: number;
15005
15208
  /**
15006
15209
  * True if this gift certificate was deleted.
15007
15210
  * @type {boolean}
@@ -15026,6 +15229,12 @@ export interface GiftCertificate {
15026
15229
  * @memberof GiftCertificate
15027
15230
  */
15028
15231
  gift_certificate_oid?: number;
15232
+ /**
15233
+ * This is an internally managed gift certificate associated with the loyalty cash rewards program.
15234
+ * @type {boolean}
15235
+ * @memberof GiftCertificate
15236
+ */
15237
+ internal?: boolean;
15029
15238
  /**
15030
15239
  * A list of all ledger activity for this gift certificate.
15031
15240
  * @type {Array<GiftCertificateLedgerEntry>}
@@ -19914,6 +20123,12 @@ export interface ItemTax {
19914
20123
  * @memberof ItemTax
19915
20124
  */
19916
20125
  tax_free?: boolean;
20126
+ /**
20127
+ * Tax product type
20128
+ * @type {string}
20129
+ * @memberof ItemTax
20130
+ */
20131
+ tax_product_type?: ItemTax.TaxProductTypeEnum;
19917
20132
  /**
19918
20133
  * Taxable cost if different than regular cost
19919
20134
  * @type {number}
@@ -19921,6 +20136,22 @@ export interface ItemTax {
19921
20136
  */
19922
20137
  taxable_cost?: number;
19923
20138
  }
20139
+ /**
20140
+ * @export
20141
+ * @namespace ItemTax
20142
+ */
20143
+ export declare namespace ItemTax {
20144
+ /**
20145
+ * @export
20146
+ * @enum {string}
20147
+ */
20148
+ enum TaxProductTypeEnum {
20149
+ Empty,
20150
+ Digital,
20151
+ Physical,
20152
+ Service
20153
+ }
20154
+ }
19924
20155
  /**
19925
20156
  *
19926
20157
  * @export
@@ -21973,6 +22204,12 @@ export interface OrderChannelPartner {
21973
22204
  * @interface OrderCheckout
21974
22205
  */
21975
22206
  export interface OrderCheckout {
22207
+ /**
22208
+ *
22209
+ * @type {Browser}
22210
+ * @memberof OrderCheckout
22211
+ */
22212
+ browser?: Browser;
21976
22213
  /**
21977
22214
  * Comments from the customer. Rarely used on the single page checkout.
21978
22215
  * @type {string}
@@ -22033,6 +22270,12 @@ export interface OrderCheckout {
22033
22270
  * @memberof OrderCheckout
22034
22271
  */
22035
22272
  screen_branding_theme_code?: string;
22273
+ /**
22274
+ * Screen size small, medium or large
22275
+ * @type {string}
22276
+ * @memberof OrderCheckout
22277
+ */
22278
+ screen_size?: string;
22036
22279
  /**
22037
22280
  * StoreFront host name associated with the order
22038
22281
  * @type {string}
@@ -22898,6 +23141,12 @@ export interface OrderItem {
22898
23141
  * @memberof OrderItem
22899
23142
  */
22900
23143
  tax_free?: boolean;
23144
+ /**
23145
+ * Type of product for tax purposes (self or UltraCart Managed taxes)
23146
+ * @type {string}
23147
+ * @memberof OrderItem
23148
+ */
23149
+ tax_product_type?: OrderItem.TaxProductTypeEnum;
22901
23150
  /**
22902
23151
  *
22903
23152
  * @type {Currency}
@@ -22947,6 +23196,22 @@ export interface OrderItem {
22947
23196
  */
22948
23197
  width?: Distance;
22949
23198
  }
23199
+ /**
23200
+ * @export
23201
+ * @namespace OrderItem
23202
+ */
23203
+ export declare namespace OrderItem {
23204
+ /**
23205
+ * @export
23206
+ * @enum {string}
23207
+ */
23208
+ enum TaxProductTypeEnum {
23209
+ Empty,
23210
+ Digital,
23211
+ Physical,
23212
+ Service
23213
+ }
23214
+ }
22950
23215
  /**
22951
23216
  *
22952
23217
  * @export
@@ -31218,6 +31483,24 @@ export interface TaxProviderUltraCartState {
31218
31483
  * @memberof TaxProviderUltraCartState
31219
31484
  */
31220
31485
  enabled?: boolean;
31486
+ /**
31487
+ * True if digital items are exempt from sales tax in this state.
31488
+ * @type {boolean}
31489
+ * @memberof TaxProviderUltraCartState
31490
+ */
31491
+ exempt_digital_items?: boolean;
31492
+ /**
31493
+ * True if physical items are exempt from sales tax in this state.
31494
+ * @type {boolean}
31495
+ * @memberof TaxProviderUltraCartState
31496
+ */
31497
+ exempt_physical_items?: boolean;
31498
+ /**
31499
+ * True if service items are exempt from sales tax in this state.
31500
+ * @type {boolean}
31501
+ * @memberof TaxProviderUltraCartState
31502
+ */
31503
+ exempt_service_items?: boolean;
31221
31504
  /**
31222
31505
  * State Code (2 digits)
31223
31506
  * @type {string}
@@ -31364,6 +31647,24 @@ export interface TaxState {
31364
31647
  * @memberof TaxState
31365
31648
  */
31366
31649
  dont_collect_state?: boolean;
31650
+ /**
31651
+ * True if digital items are exempt from sales tax in this state.
31652
+ * @type {boolean}
31653
+ * @memberof TaxState
31654
+ */
31655
+ exempt_digital_items?: boolean;
31656
+ /**
31657
+ * True if physical items are exempt from sales tax in this state.
31658
+ * @type {boolean}
31659
+ * @memberof TaxState
31660
+ */
31661
+ exempt_physical_items?: boolean;
31662
+ /**
31663
+ * True if service items are exempt from sales tax in this state.
31664
+ * @type {boolean}
31665
+ * @memberof TaxState
31666
+ */
31667
+ exempt_service_items?: boolean;
31367
31668
  /**
31368
31669
  * State code
31369
31670
  * @type {string}
@@ -43488,7 +43789,7 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
43488
43789
  * @param {*} [options] Override http request option.
43489
43790
  * @throws {RequiredError}
43490
43791
  */
43491
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqEmailSendTestResponse>;
43792
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse>;
43492
43793
  /**
43493
43794
  *
43494
43795
  * @summary Start email campaign
@@ -44957,7 +45258,7 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
44957
45258
  * @param {*} [options] Override http request option.
44958
45259
  * @throws {RequiredError}
44959
45260
  */
44960
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
45261
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
44961
45262
  /**
44962
45263
  *
44963
45264
  * @summary Start email campaign
@@ -46562,7 +46863,7 @@ export interface StorefrontApiInterface {
46562
46863
  * @throws {RequiredError}
46563
46864
  * @memberof StorefrontApiInterface
46564
46865
  */
46565
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
46866
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
46566
46867
  /**
46567
46868
  *
46568
46869
  * @summary Start email campaign
@@ -48193,7 +48494,7 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
48193
48494
  * @throws {RequiredError}
48194
48495
  * @memberof StorefrontApi
48195
48496
  */
48196
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
48497
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
48197
48498
  /**
48198
48499
  *
48199
48500
  * @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.1",
3
+ "version": "3.9.4",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [