ultracart_rest_api_v2_typescript 3.9.3 → 3.9.6

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.9.3
+## ultracart_rest_api_v2_typescript@3.9.6
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.9.3 --save
+npm install ultracart_rest_api_v2_typescript@3.9.6 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
+| 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
+| 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
 | 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
 | 3.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
 | 3.9.1 | 03/03/2022 | javascript sdk package.json bug fix |

package/api.ts

@@ -1226,6 +1226,12 @@ export interface AutoOrder {
      * @memberof AutoOrder
      */
     cancel_downgrade?: boolean;
+    /**
+     * The reason this auto order was canceled by either merchant or customer
+     * @type {string}
+     * @memberof AutoOrder
+     */
+    cancel_reason?: string;
     /**
      * True if the auto order was canceled because the customer purchased an upgrade item
      * @type {boolean}
@@ -8332,6 +8338,18 @@ export interface CustomerLoyalty {
      * @memberof CustomerLoyalty
      */
     current_points?: number;
+    /**
+     * Loyalty Cashback / Store credit balance (internal gift certificate balance)
+     * @type {string}
+     * @memberof CustomerLoyalty
+     */
+    internal_gift_certificate_balance?: string;
+    /**
+     * Internal gift certificate oid used to tracking loyalty cashback / store credit.
+     * @type {number}
+     * @memberof CustomerLoyalty
+     */
+    internal_gift_certificate_oid?: number;
     /**
      * Ledger entries
      * @type {Array<CustomerLoyaltyLedger>}
@@ -10069,6 +10087,12 @@ export interface EmailCommseqEmail {
      * @memberof EmailCommseqEmail
      */
     library_item_oid?: number;
+    /**
+     * True if email links should contain magic link tokens to log the customer in automatically
+     * @type {boolean}
+     * @memberof EmailCommseqEmail
+     */
+    magic_link?: boolean;
     /**
      * Merchant ID
      * @type {string}
@@ -10442,17 +10466,17 @@ export interface EmailCommseqPostcard {
      */
     postcard_front_container_uuid?: string;
     /**
-     * URL for front screenshot
+     * URL to screenshot of the back of the postcard
      * @type {string}
      * @memberof EmailCommseqPostcard
      */
-    screenshot_front_url?: string;
+    screenshot_back_url?: string;
     /**
-     * URL for back screenshot
+     * URL to screenshot of the front of the postcard
      * @type {string}
      * @memberof EmailCommseqPostcard
      */
-    screenshot_small_full_url?: string;
+    screenshot_front_url?: string;
     /**
      * Storefront oid
      * @type {number}
@@ -11594,6 +11618,12 @@ export interface EmailDomain {
      * @memberof EmailDomain
      */
     provider?: string;
+    /**
+     * 
+     * @type {VerificationRecord}
+     * @memberof EmailDomain
+     */
+    spf?: VerificationRecord;
     /**
      * 
      * @type {string}
@@ -12758,6 +12788,12 @@ export interface EmailPerformance {
      * @memberof EmailPerformance
      */
     delivered_count?: number;
+    /**
+     * Loyalty Program Type
+     * @type {string}
+     * @memberof EmailPerformance
+     */
+    loyalty_program_type?: EmailPerformance.LoyaltyProgramTypeEnum;
     /**
      * Maximum active customers allowed under their billing plan
      * @type {number}
@@ -12844,6 +12880,22 @@ export interface EmailPerformance {
     transactional_send_count?: number;
 }
 
+/**
+ * @export
+ * @namespace EmailPerformance
+ */
+export namespace EmailPerformance {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum LoyaltyProgramTypeEnum {
+        Disabled = <any> 'disabled',
+        Points = <any> 'points',
+        Cashback = <any> 'cashback'
+    }
+}
+
 /**
  * 
  * @export
@@ -22326,6 +22378,12 @@ export interface OrderAutoOrder {
      * @memberof OrderAutoOrder
      */
     cancel_downgrade?: boolean;
+    /**
+     * The reason this auto order was canceled by either merchant or customer
+     * @type {string}
+     * @memberof OrderAutoOrder
+     */
+    cancel_reason?: string;
     /**
      * True if the auto order was canceled because the customer purchased an upgrade item
      * @type {boolean}

package/dist/api.d.ts

@@ -1187,6 +1187,12 @@ export interface AutoOrder {
      * @memberof AutoOrder
      */
     cancel_downgrade?: boolean;
+    /**
+     * The reason this auto order was canceled by either merchant or customer
+     * @type {string}
+     * @memberof AutoOrder
+     */
+    cancel_reason?: string;
     /**
      * True if the auto order was canceled because the customer purchased an upgrade item
      * @type {boolean}
@@ -8125,6 +8131,18 @@ export interface CustomerLoyalty {
      * @memberof CustomerLoyalty
      */
     current_points?: number;
+    /**
+     * Loyalty Cashback / Store credit balance (internal gift certificate balance)
+     * @type {string}
+     * @memberof CustomerLoyalty
+     */
+    internal_gift_certificate_balance?: string;
+    /**
+     * Internal gift certificate oid used to tracking loyalty cashback / store credit.
+     * @type {number}
+     * @memberof CustomerLoyalty
+     */
+    internal_gift_certificate_oid?: number;
     /**
      * Ledger entries
      * @type {Array<CustomerLoyaltyLedger>}
@@ -9831,6 +9849,12 @@ export interface EmailCommseqEmail {
      * @memberof EmailCommseqEmail
      */
     library_item_oid?: number;
+    /**
+     * True if email links should contain magic link tokens to log the customer in automatically
+     * @type {boolean}
+     * @memberof EmailCommseqEmail
+     */
+    magic_link?: boolean;
     /**
      * Merchant ID
      * @type {string}
@@ -10198,17 +10222,17 @@ export interface EmailCommseqPostcard {
      */
     postcard_front_container_uuid?: string;
     /**
-     * URL for front screenshot
+     * URL to screenshot of the back of the postcard
      * @type {string}
      * @memberof EmailCommseqPostcard
      */
-    screenshot_front_url?: string;
+    screenshot_back_url?: string;
     /**
-     * URL for back screenshot
+     * URL to screenshot of the front of the postcard
      * @type {string}
      * @memberof EmailCommseqPostcard
      */
-    screenshot_small_full_url?: string;
+    screenshot_front_url?: string;
     /**
      * Storefront oid
      * @type {number}
@@ -11328,6 +11352,12 @@ export interface EmailDomain {
      * @memberof EmailDomain
      */
     provider?: string;
+    /**
+     *
+     * @type {VerificationRecord}
+     * @memberof EmailDomain
+     */
+    spf?: VerificationRecord;
     /**
      *
      * @type {string}
@@ -12462,6 +12492,12 @@ export interface EmailPerformance {
      * @memberof EmailPerformance
      */
     delivered_count?: number;
+    /**
+     * Loyalty Program Type
+     * @type {string}
+     * @memberof EmailPerformance
+     */
+    loyalty_program_type?: EmailPerformance.LoyaltyProgramTypeEnum;
     /**
      * Maximum active customers allowed under their billing plan
      * @type {number}
@@ -12547,6 +12583,21 @@ export interface EmailPerformance {
      */
     transactional_send_count?: number;
 }
+/**
+ * @export
+ * @namespace EmailPerformance
+ */
+export declare namespace EmailPerformance {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum LoyaltyProgramTypeEnum {
+        Disabled,
+        Points,
+        Cashback
+    }
+}
 /**
  *
  * @export
@@ -21842,6 +21893,12 @@ export interface OrderAutoOrder {
      * @memberof OrderAutoOrder
      */
     cancel_downgrade?: boolean;
+    /**
+     * The reason this auto order was canceled by either merchant or customer
+     * @type {string}
+     * @memberof OrderAutoOrder
+     */
+    cancel_reason?: string;
     /**
      * True if the auto order was canceled because the customer purchased an upgrade item
      * @type {boolean}

package/dist/api.js

@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
-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;
-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;
+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;
+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;
+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;
 var url = require("url");
 var portableFetch = require("portable-fetch");
 var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -344,6 +344,23 @@ var EmailCommseqStep;
         TypeEnum[TypeEnum["End"] = 'end'] = "End";
     })(TypeEnum = EmailCommseqStep.TypeEnum || (EmailCommseqStep.TypeEnum = {}));
 })(EmailCommseqStep = exports.EmailCommseqStep || (exports.EmailCommseqStep = {}));
+/**
+ * @export
+ * @namespace EmailPerformance
+ */
+var EmailPerformance;
+(function (EmailPerformance) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var LoyaltyProgramTypeEnum;
+    (function (LoyaltyProgramTypeEnum) {
+        LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Disabled"] = 'disabled'] = "Disabled";
+        LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Points"] = 'points'] = "Points";
+        LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Cashback"] = 'cashback'] = "Cashback";
+    })(LoyaltyProgramTypeEnum = EmailPerformance.LoyaltyProgramTypeEnum || (EmailPerformance.LoyaltyProgramTypeEnum = {}));
+})(EmailPerformance = exports.EmailPerformance || (exports.EmailPerformance = {}));
 /**
  * @export
  * @namespace Experiment

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.9.3",
+  "version": "3.9.6",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [