ultracart_rest_api_v2_typescript 3.9.5 → 3.9.6

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.5
1
+ ## ultracart_rest_api_v2_typescript@3.9.6
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.5 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.9.6 --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.6 | 04/25/2022 | storefront communications email magic link setting |
57
58
  | 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
58
59
  | 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
59
60
  | 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
package/api.ts CHANGED
@@ -1226,6 +1226,12 @@ export interface AutoOrder {
1226
1226
  * @memberof AutoOrder
1227
1227
  */
1228
1228
  cancel_downgrade?: boolean;
1229
+ /**
1230
+ * The reason this auto order was canceled by either merchant or customer
1231
+ * @type {string}
1232
+ * @memberof AutoOrder
1233
+ */
1234
+ cancel_reason?: string;
1229
1235
  /**
1230
1236
  * True if the auto order was canceled because the customer purchased an upgrade item
1231
1237
  * @type {boolean}
@@ -10081,6 +10087,12 @@ export interface EmailCommseqEmail {
10081
10087
  * @memberof EmailCommseqEmail
10082
10088
  */
10083
10089
  library_item_oid?: number;
10090
+ /**
10091
+ * True if email links should contain magic link tokens to log the customer in automatically
10092
+ * @type {boolean}
10093
+ * @memberof EmailCommseqEmail
10094
+ */
10095
+ magic_link?: boolean;
10084
10096
  /**
10085
10097
  * Merchant ID
10086
10098
  * @type {string}
@@ -12776,6 +12788,12 @@ export interface EmailPerformance {
12776
12788
  * @memberof EmailPerformance
12777
12789
  */
12778
12790
  delivered_count?: number;
12791
+ /**
12792
+ * Loyalty Program Type
12793
+ * @type {string}
12794
+ * @memberof EmailPerformance
12795
+ */
12796
+ loyalty_program_type?: EmailPerformance.LoyaltyProgramTypeEnum;
12779
12797
  /**
12780
12798
  * Maximum active customers allowed under their billing plan
12781
12799
  * @type {number}
@@ -12862,6 +12880,22 @@ export interface EmailPerformance {
12862
12880
  transactional_send_count?: number;
12863
12881
  }
12864
12882
 
12883
+ /**
12884
+ * @export
12885
+ * @namespace EmailPerformance
12886
+ */
12887
+ export namespace EmailPerformance {
12888
+ /**
12889
+ * @export
12890
+ * @enum {string}
12891
+ */
12892
+ export enum LoyaltyProgramTypeEnum {
12893
+ Disabled = <any> 'disabled',
12894
+ Points = <any> 'points',
12895
+ Cashback = <any> 'cashback'
12896
+ }
12897
+ }
12898
+
12865
12899
  /**
12866
12900
  *
12867
12901
  * @export
@@ -22344,6 +22378,12 @@ export interface OrderAutoOrder {
22344
22378
  * @memberof OrderAutoOrder
22345
22379
  */
22346
22380
  cancel_downgrade?: boolean;
22381
+ /**
22382
+ * The reason this auto order was canceled by either merchant or customer
22383
+ * @type {string}
22384
+ * @memberof OrderAutoOrder
22385
+ */
22386
+ cancel_reason?: string;
22347
22387
  /**
22348
22388
  * True if the auto order was canceled because the customer purchased an upgrade item
22349
22389
  * @type {boolean}
package/dist/api.d.ts CHANGED
@@ -1187,6 +1187,12 @@ export interface AutoOrder {
1187
1187
  * @memberof AutoOrder
1188
1188
  */
1189
1189
  cancel_downgrade?: boolean;
1190
+ /**
1191
+ * The reason this auto order was canceled by either merchant or customer
1192
+ * @type {string}
1193
+ * @memberof AutoOrder
1194
+ */
1195
+ cancel_reason?: string;
1190
1196
  /**
1191
1197
  * True if the auto order was canceled because the customer purchased an upgrade item
1192
1198
  * @type {boolean}
@@ -9843,6 +9849,12 @@ export interface EmailCommseqEmail {
9843
9849
  * @memberof EmailCommseqEmail
9844
9850
  */
9845
9851
  library_item_oid?: number;
9852
+ /**
9853
+ * True if email links should contain magic link tokens to log the customer in automatically
9854
+ * @type {boolean}
9855
+ * @memberof EmailCommseqEmail
9856
+ */
9857
+ magic_link?: boolean;
9846
9858
  /**
9847
9859
  * Merchant ID
9848
9860
  * @type {string}
@@ -12480,6 +12492,12 @@ export interface EmailPerformance {
12480
12492
  * @memberof EmailPerformance
12481
12493
  */
12482
12494
  delivered_count?: number;
12495
+ /**
12496
+ * Loyalty Program Type
12497
+ * @type {string}
12498
+ * @memberof EmailPerformance
12499
+ */
12500
+ loyalty_program_type?: EmailPerformance.LoyaltyProgramTypeEnum;
12483
12501
  /**
12484
12502
  * Maximum active customers allowed under their billing plan
12485
12503
  * @type {number}
@@ -12565,6 +12583,21 @@ export interface EmailPerformance {
12565
12583
  */
12566
12584
  transactional_send_count?: number;
12567
12585
  }
12586
+ /**
12587
+ * @export
12588
+ * @namespace EmailPerformance
12589
+ */
12590
+ export declare namespace EmailPerformance {
12591
+ /**
12592
+ * @export
12593
+ * @enum {string}
12594
+ */
12595
+ enum LoyaltyProgramTypeEnum {
12596
+ Disabled,
12597
+ Points,
12598
+ Cashback
12599
+ }
12600
+ }
12568
12601
  /**
12569
12602
  *
12570
12603
  * @export
@@ -21860,6 +21893,12 @@ export interface OrderAutoOrder {
21860
21893
  * @memberof OrderAutoOrder
21861
21894
  */
21862
21895
  cancel_downgrade?: boolean;
21896
+ /**
21897
+ * The reason this auto order was canceled by either merchant or customer
21898
+ * @type {string}
21899
+ * @memberof OrderAutoOrder
21900
+ */
21901
+ cancel_reason?: string;
21863
21902
  /**
21864
21903
  * True if the auto order was canceled because the customer purchased an upgrade item
21865
21904
  * @type {boolean}
package/dist/api.js CHANGED
@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
28
28
  };
29
29
  })();
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
- exports.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;
31
+ 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.EmailPerformance = 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.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 = exports.TempMultimedia = void 0;
33
+ exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = 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(/\/+$/, "");
@@ -344,6 +344,23 @@ var EmailCommseqStep;
344
344
  TypeEnum[TypeEnum["End"] = 'end'] = "End";
345
345
  })(TypeEnum = EmailCommseqStep.TypeEnum || (EmailCommseqStep.TypeEnum = {}));
346
346
  })(EmailCommseqStep = exports.EmailCommseqStep || (exports.EmailCommseqStep = {}));
347
+ /**
348
+ * @export
349
+ * @namespace EmailPerformance
350
+ */
351
+ var EmailPerformance;
352
+ (function (EmailPerformance) {
353
+ /**
354
+ * @export
355
+ * @enum {string}
356
+ */
357
+ var LoyaltyProgramTypeEnum;
358
+ (function (LoyaltyProgramTypeEnum) {
359
+ LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Disabled"] = 'disabled'] = "Disabled";
360
+ LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Points"] = 'points'] = "Points";
361
+ LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Cashback"] = 'cashback'] = "Cashback";
362
+ })(LoyaltyProgramTypeEnum = EmailPerformance.LoyaltyProgramTypeEnum || (EmailPerformance.LoyaltyProgramTypeEnum = {}));
363
+ })(EmailPerformance = exports.EmailPerformance || (exports.EmailPerformance = {}));
347
364
  /**
348
365
  * @export
349
366
  * @namespace Experiment
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.9.5",
3
+ "version": "3.9.6",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [