ultracart_rest_api_v2_typescript 4.1.129 → 4.1.131

package/.openapi-generator/FILES

@@ -812,6 +812,7 @@ src/models/OrderChannelPartner.ts
 src/models/OrderCheckout.ts
 src/models/OrderCoupon.ts
 src/models/OrderCurrentStageHistory.ts
+src/models/OrderCustomerActivityResponse.ts
 src/models/OrderDigitalItem.ts
 src/models/OrderDigitalOrder.ts
 src/models/OrderEdi.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.129
+## ultracart_rest_api_v2_typescript@4.1.131
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.129 --save
+npm install ultracart_rest_api_v2_typescript@4.1.131 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.131 | 08/18/2026 | customer activity now returns the SF communications active flag and last_activity_dts |
+| 4.1.130 | 08/17/2026 | order api - new method to obtain customer activity similar to the customer endpoint for a profile |
 | 4.1.129 | 08/13/2026 | ChannelPartnerOrder and OrderChannelPartner were missing a property |
 | 4.1.128 | 08/13/2026 | channel partner - added arbitrary discount to ChannelPartnerOrder |
 | 4.1.127 | 08/13/2026 | added arbitrary discounts to order creation for historical imports |

package/dist/apis/AutoOrderApi.d.ts

@@ -348,7 +348,7 @@ export interface AutoOrderApiInterface {
      */
     pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
-     * Update an auto order on the UltraCart account.
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * @summary Update an auto order
      * @param {number} autoOrderOid The auto order oid to update.
      * @param {AutoOrder} autoOrder Auto order to update
@@ -360,7 +360,7 @@ export interface AutoOrderApiInterface {
      */
     updateAutoOrderRaw(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
     /**
-     * Update an auto order on the UltraCart account.
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update an auto order
      */
     updateAutoOrder(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
@@ -431,7 +431,7 @@ export interface AutoOrderApiInterface {
      */
     updateAutoOrderProperties(requestParameters: UpdateAutoOrderPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
-     * Update multiple auto orders on the UltraCart account.
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * @summary Update multiple auto orders
      * @param {AutoOrdersRequest} autoOrdersRequest Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
      * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
@@ -443,7 +443,7 @@ export interface AutoOrderApiInterface {
      */
     updateAutoOrdersBatchRaw(requestParameters: UpdateAutoOrdersBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrdersResponse>>;
     /**
-     * Update multiple auto orders on the UltraCart account.
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update multiple auto orders
      */
     updateAutoOrdersBatch(requestParameters: UpdateAutoOrdersBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;
@@ -583,12 +583,12 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
      */
     pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
-     * Update an auto order on the UltraCart account.
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update an auto order
      */
     updateAutoOrderRaw(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
     /**
-     * Update an auto order on the UltraCart account.
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update an auto order
      */
     updateAutoOrder(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
@@ -633,12 +633,12 @@ export declare class AutoOrderApi extends runtime.BaseAPI implements AutoOrderAp
      */
     updateAutoOrderProperties(requestParameters: UpdateAutoOrderPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
     /**
-     * Update multiple auto orders on the UltraCart account.
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update multiple auto orders
      */
     updateAutoOrdersBatchRaw(requestParameters: UpdateAutoOrdersBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrdersResponse>>;
     /**
-     * Update multiple auto orders on the UltraCart account.
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update multiple auto orders
      */
     updateAutoOrdersBatch(requestParameters: UpdateAutoOrdersBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;

package/dist/apis/AutoOrderApi.js

@@ -965,7 +965,7 @@ var AutoOrderApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Update an auto order on the UltraCart account.
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update an auto order
      */
     AutoOrderApi.prototype.updateAutoOrderRaw = function (requestParameters, initOverrides) {
@@ -1017,7 +1017,7 @@ var AutoOrderApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Update an auto order on the UltraCart account.
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update an auto order
      */
     AutoOrderApi.prototype.updateAutoOrder = function (requestParameters, initOverrides) {
@@ -1309,7 +1309,7 @@ var AutoOrderApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Update multiple auto orders on the UltraCart account.
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update multiple auto orders
      */
     AutoOrderApi.prototype.updateAutoOrdersBatchRaw = function (requestParameters, initOverrides) {
@@ -1361,7 +1361,7 @@ var AutoOrderApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Update multiple auto orders on the UltraCart account.
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable.
      * Update multiple auto orders
      */
     AutoOrderApi.prototype.updateAutoOrdersBatch = function (requestParameters, initOverrides) {

package/dist/apis/OrderApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderEdiDocumentsResponse, OrderEmailsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderPageViewHistoryResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
+import { AccountsReceivableRetryConfig, AccountsReceivableRetryConfigResponse, AccountsReceivableRetryStatsResponse, BaseResponse, Order, OrderAddItemsAndReleaseRequest, OrderAssignToAffiliateRequest, OrderByTokenQuery, OrderCustomerActivityResponse, OrderEdiDocumentsResponse, OrderEmailsResponse, OrderFormat, OrderFormatResponse, OrderInvoiceResponse, OrderPackingSlipResponse, OrderPageViewHistoryResponse, OrderProcessPaymentRequest, OrderProcessPaymentResponse, OrderQuery, OrderQueryBatch, OrderRefundableResponse, OrderReplacement, OrderReplacementResponse, OrderResponse, OrderTokenResponse, OrderUpsellCartRequest, OrderValidationRequest, OrderValidationResponse, OrdersResponse, ReplaceOrderItemIdRequest } from '../models';
 export interface AdjustOrderTotalRequest {
     orderId: string;
     desiredTotal: string;
@@ -69,6 +69,9 @@ export interface GetOrderByTokenRequest {
     orderByTokenQuery: OrderByTokenQuery;
     expand?: string;
 }
+export interface GetOrderCustomerActivityRequest {
+    orderId: string;
+}
 export interface GetOrderEdiDocumentsRequest {
     orderId: string;
 }
@@ -444,6 +447,20 @@ export interface OrderApiInterface {
      * Retrieve an order using a token
      */
     getOrderByToken(requestParameters: GetOrderByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead.
+     * @summary Retrieve customer activity for this order.
+     * @param {string} orderId The order id to retrieve customer activity for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getOrderCustomerActivityRaw(requestParameters: GetOrderCustomerActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderCustomerActivityResponse>>;
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead.
+     * Retrieve customer activity for this order.
+     */
+    getOrderCustomerActivity(requestParameters: GetOrderCustomerActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderCustomerActivityResponse>;
     /**
      * Retrieve EDI documents associated with this order.
      * @summary Retrieve EDI documents associated with this order.
@@ -969,6 +986,16 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Retrieve an order using a token
      */
     getOrderByToken(requestParameters: GetOrderByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead.
+     * Retrieve customer activity for this order.
+     */
+    getOrderCustomerActivityRaw(requestParameters: GetOrderCustomerActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderCustomerActivityResponse>>;
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead.
+     * Retrieve customer activity for this order.
+     */
+    getOrderCustomerActivity(requestParameters: GetOrderCustomerActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderCustomerActivityResponse>;
     /**
      * Retrieve EDI documents associated with this order.
      * Retrieve EDI documents associated with this order.

package/dist/apis/OrderApi.js

@@ -1113,6 +1113,65 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead.
+     * Retrieve customer activity for this order.
+     */
+    OrderApi.prototype.getOrderCustomerActivityRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+                            throw new runtime.RequiredError('orderId', 'Required parameter requestParameters.orderId was null or undefined when calling getOrderCustomerActivity.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/order/orders/{order_id}/customer_activity".replace("{".concat("order_id", "}"), encodeURIComponent(String(requestParameters.orderId))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.OrderCustomerActivityResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead.
+     * Retrieve customer activity for this order.
+     */
+    OrderApi.prototype.getOrderCustomerActivity = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getOrderCustomerActivityRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieve EDI documents associated with this order.
      * Retrieve EDI documents associated with this order.

package/dist/models/AutoOrder.d.ts

@@ -53,7 +53,7 @@ export interface AutoOrder {
      */
     cancel_downgrade?: boolean;
     /**
-     * The reason this auto order was canceled by either merchant or customer
+     * The reason this auto order was canceled by either merchant or customer. Supplying this when setting enabled to false records the change as a cancellation rather than a disable.
      * @type {string}
      * @memberof AutoOrder
      */
@@ -65,13 +65,13 @@ export interface AutoOrder {
      */
     cancel_upgrade?: boolean;
     /**
-     * The user that canceled the auto order
+     * The user that canceled the auto order. Supplying this when setting enabled to false records the change as a cancellation rather than a disable.
      * @type {string}
      * @memberof AutoOrder
      */
     canceled_by_user?: string;
     /**
-     * The date/time that the auto order was canceled
+     * The date/time that the auto order was canceled. Supply this to record an explicit cancellation time, otherwise it is stamped automatically when enabled is set to false along with cancel_reason or canceled_by_user.
      * @type {string}
      * @memberof AutoOrder
      */
@@ -89,7 +89,7 @@ export interface AutoOrder {
      */
     credit_card_attempt?: number;
     /**
-     * The date/time the auto order was disabled due to failed rebills
+     * The date/time the auto order was disabled, either by a failed rebill or by setting enabled to false without a cancellation
      * @type {string}
      * @memberof AutoOrder
      */
@@ -101,7 +101,7 @@ export interface AutoOrder {
      */
     emails?: Array<AutoOrderEmail>;
     /**
-     * True if this auto order is enabled
+     * True if this auto order is enabled. Setting this to false along with cancel_reason or canceled_by_user records the change as a cancellation and fires the auto order cancel notifications. Setting it to false without either field records a disable instead.
      * @type {boolean}
      * @memberof AutoOrder
      */

package/dist/models/Metric.d.ts

@@ -15,6 +15,12 @@
  * @interface Metric
  */
 export interface Metric {
+    /**
+     *
+     * @type {boolean}
+     * @memberof Metric
+     */
+    active?: boolean;
     /**
      *
      * @type {number}
@@ -39,6 +45,12 @@ export interface Metric {
      * @memberof Metric
      */
     last_30_formatted?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Metric
+     */
+    last_activity_dts?: string;
     /**
      *
      * @type {string}

package/dist/models/Metric.js

@@ -32,10 +32,12 @@ function MetricFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'active': !(0, runtime_1.exists)(json, 'active') ? undefined : json['active'],
         'all_time': !(0, runtime_1.exists)(json, 'all_time') ? undefined : json['all_time'],
         'all_time_formatted': !(0, runtime_1.exists)(json, 'all_time_formatted') ? undefined : json['all_time_formatted'],
         'last_30': !(0, runtime_1.exists)(json, 'last_30') ? undefined : json['last_30'],
         'last_30_formatted': !(0, runtime_1.exists)(json, 'last_30_formatted') ? undefined : json['last_30_formatted'],
+        'last_activity_dts': !(0, runtime_1.exists)(json, 'last_activity_dts') ? undefined : json['last_activity_dts'],
         'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
         'prior_30': !(0, runtime_1.exists)(json, 'prior_30') ? undefined : json['prior_30'],
         'prior_30_formatted': !(0, runtime_1.exists)(json, 'prior_30_formatted') ? undefined : json['prior_30_formatted'],
@@ -51,10 +53,12 @@ function MetricToJSON(value) {
         return null;
     }
     return {
+        'active': value.active,
         'all_time': value.all_time,
         'all_time_formatted': value.all_time_formatted,
         'last_30': value.last_30,
         'last_30_formatted': value.last_30_formatted,
+        'last_activity_dts': value.last_activity_dts,
         'name': value.name,
         'prior_30': value.prior_30,
         'prior_30_formatted': value.prior_30_formatted,

package/dist/models/OrderCustomerActivityResponse.d.ts

@@ -0,0 +1,65 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CustomerActivity } from './CustomerActivity';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface OrderCustomerActivityResponse
+ */
+export interface OrderCustomerActivityResponse {
+    /**
+     *
+     * @type {CustomerActivity}
+     * @memberof OrderCustomerActivityResponse
+     */
+    customer_activity?: CustomerActivity;
+    /**
+     * Email address on the order that the customer activity was retrieved for
+     * @type {string}
+     * @memberof OrderCustomerActivityResponse
+     */
+    email?: string;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof OrderCustomerActivityResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof OrderCustomerActivityResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderCustomerActivityResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof OrderCustomerActivityResponse
+     */
+    warning?: Warning;
+}
+/**
+ * Check if a given object implements the OrderCustomerActivityResponse interface.
+ */
+export declare function instanceOfOrderCustomerActivityResponse(value: object): boolean;
+export declare function OrderCustomerActivityResponseFromJSON(json: any): OrderCustomerActivityResponse;
+export declare function OrderCustomerActivityResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCustomerActivityResponse;
+export declare function OrderCustomerActivityResponseToJSON(value?: OrderCustomerActivityResponse | null): any;

package/dist/models/OrderCustomerActivityResponse.js

@@ -0,0 +1,64 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderCustomerActivityResponseToJSON = exports.OrderCustomerActivityResponseFromJSONTyped = exports.OrderCustomerActivityResponseFromJSON = exports.instanceOfOrderCustomerActivityResponse = void 0;
+var runtime_1 = require("../runtime");
+var CustomerActivity_1 = require("./CustomerActivity");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+/**
+ * Check if a given object implements the OrderCustomerActivityResponse interface.
+ */
+function instanceOfOrderCustomerActivityResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfOrderCustomerActivityResponse = instanceOfOrderCustomerActivityResponse;
+function OrderCustomerActivityResponseFromJSON(json) {
+    return OrderCustomerActivityResponseFromJSONTyped(json, false);
+}
+exports.OrderCustomerActivityResponseFromJSON = OrderCustomerActivityResponseFromJSON;
+function OrderCustomerActivityResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'customer_activity': !(0, runtime_1.exists)(json, 'customer_activity') ? undefined : (0, CustomerActivity_1.CustomerActivityFromJSON)(json['customer_activity']),
+        'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.OrderCustomerActivityResponseFromJSONTyped = OrderCustomerActivityResponseFromJSONTyped;
+function OrderCustomerActivityResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'customer_activity': (0, CustomerActivity_1.CustomerActivityToJSON)(value.customer_activity),
+        'email': value.email,
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.OrderCustomerActivityResponseToJSON = OrderCustomerActivityResponseToJSON;

package/dist/models/index.d.ts

@@ -783,6 +783,7 @@ export * from './OrderChannelPartner';
 export * from './OrderCheckout';
 export * from './OrderCoupon';
 export * from './OrderCurrentStageHistory';
+export * from './OrderCustomerActivityResponse';
 export * from './OrderDigitalItem';
 export * from './OrderDigitalOrder';
 export * from './OrderEdi';

package/dist/models/index.js

@@ -801,6 +801,7 @@ __exportStar(require("./OrderChannelPartner"), exports);
 __exportStar(require("./OrderCheckout"), exports);
 __exportStar(require("./OrderCoupon"), exports);
 __exportStar(require("./OrderCurrentStageHistory"), exports);
+__exportStar(require("./OrderCustomerActivityResponse"), exports);
 __exportStar(require("./OrderDigitalItem"), exports);
 __exportStar(require("./OrderDigitalOrder"), exports);
 __exportStar(require("./OrderEdi"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.129",
+  "version": "4.1.131",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/AutoOrderApi.ts

@@ -443,7 +443,7 @@ export interface AutoOrderApiInterface {
     pauseAutoOrder(requestParameters: PauseAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
 
     /**
-     * Update an auto order on the UltraCart account. 
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable. 
      * @summary Update an auto order
      * @param {number} autoOrderOid The auto order oid to update.
      * @param {AutoOrder} autoOrder Auto order to update
@@ -456,7 +456,7 @@ export interface AutoOrderApiInterface {
     updateAutoOrderRaw(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>>;
 
     /**
-     * Update an auto order on the UltraCart account. 
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable. 
      * Update an auto order
      */
     updateAutoOrder(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
@@ -536,7 +536,7 @@ export interface AutoOrderApiInterface {
     updateAutoOrderProperties(requestParameters: UpdateAutoOrderPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse>;
 
     /**
-     * Update multiple auto orders on the UltraCart account. 
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable. 
      * @summary Update multiple auto orders
      * @param {AutoOrdersRequest} autoOrdersRequest Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
      * @param {string} [expand] The object expansion to perform on the result.  See documentation for examples
@@ -549,7 +549,7 @@ export interface AutoOrderApiInterface {
     updateAutoOrdersBatchRaw(requestParameters: UpdateAutoOrdersBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrdersResponse>>;
 
     /**
-     * Update multiple auto orders on the UltraCart account. 
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable. 
      * Update multiple auto orders
      */
     updateAutoOrdersBatch(requestParameters: UpdateAutoOrdersBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse>;
@@ -1258,7 +1258,7 @@ export class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterfa
     }
 
     /**
-     * Update an auto order on the UltraCart account. 
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable. 
      * Update an auto order
      */
     async updateAutoOrderRaw(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrderResponse>> {
@@ -1305,7 +1305,7 @@ export class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterfa
     }
 
     /**
-     * Update an auto order on the UltraCart account. 
+     * Update an auto order on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable. 
      * Update an auto order
      */
     async updateAutoOrder(requestParameters: UpdateAutoOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrderResponse> {
@@ -1530,7 +1530,7 @@ export class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterfa
     }
 
     /**
-     * Update multiple auto orders on the UltraCart account. 
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable. 
      * Update multiple auto orders
      */
     async updateAutoOrdersBatchRaw(requestParameters: UpdateAutoOrdersBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AutoOrdersResponse>> {
@@ -1577,7 +1577,7 @@ export class AutoOrderApi extends runtime.BaseAPI implements AutoOrderApiInterfa
     }
 
     /**
-     * Update multiple auto orders on the UltraCart account. 
+     * Update multiple auto orders on the UltraCart account.  To cancel an auto order, set enabled to false and supply either cancel_reason or canceled_by_user, which records the change as a cancellation and fires the auto order cancel notifications.  Setting enabled to false without either field records a disable. 
      * Update multiple auto orders
      */
     async updateAutoOrdersBatch(requestParameters: UpdateAutoOrdersBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AutoOrdersResponse> {

package/src/apis/OrderApi.ts

@@ -42,6 +42,9 @@ import {
     OrderByTokenQuery,
     OrderByTokenQueryFromJSON,
     OrderByTokenQueryToJSON,
+    OrderCustomerActivityResponse,
+    OrderCustomerActivityResponseFromJSON,
+    OrderCustomerActivityResponseToJSON,
     OrderEdiDocumentsResponse,
     OrderEdiDocumentsResponseFromJSON,
     OrderEdiDocumentsResponseToJSON,
@@ -180,6 +183,10 @@ export interface GetOrderByTokenRequest {
     expand?: string;
 }
 
+export interface GetOrderCustomerActivityRequest {
+    orderId: string;
+}
+
 export interface GetOrderEdiDocumentsRequest {
     orderId: string;
 }
@@ -610,6 +617,22 @@ export interface OrderApiInterface {
      */
     getOrderByToken(requestParameters: GetOrderByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
 
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead. 
+     * @summary Retrieve customer activity for this order.
+     * @param {string} orderId The order id to retrieve customer activity for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getOrderCustomerActivityRaw(requestParameters: GetOrderCustomerActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderCustomerActivityResponse>>;
+
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead. 
+     * Retrieve customer activity for this order.
+     */
+    getOrderCustomerActivity(requestParameters: GetOrderCustomerActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderCustomerActivityResponse>;
+
     /**
      * Retrieve EDI documents associated with this order. 
      * @summary Retrieve EDI documents associated with this order.
@@ -1759,6 +1782,47 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
         return await response.value();
     }
 
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead. 
+     * Retrieve customer activity for this order.
+     */
+    async getOrderCustomerActivityRaw(requestParameters: GetOrderCustomerActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderCustomerActivityResponse>> {
+        if (requestParameters.orderId === null || requestParameters.orderId === undefined) {
+            throw new runtime.RequiredError('orderId','Required parameter requestParameters.orderId was null or undefined when calling getOrderCustomerActivity.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["order_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/order/orders/{order_id}/customer_activity`.replace(`{${"order_id"}}`, encodeURIComponent(String(requestParameters.orderId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrderCustomerActivityResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves the customer activity associated with the email address on this order.  This includes email engagement history, email list and segment membership, lifetime metrics and email suppression status.  A customer profile is not required and is not consulted, so this method works for guest orders that have never had a customer profile established.  For the page views captured during the session that placed the order, see the page view history method instead. 
+     * Retrieve customer activity for this order.
+     */
+    async getOrderCustomerActivity(requestParameters: GetOrderCustomerActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderCustomerActivityResponse> {
+        const response = await this.getOrderCustomerActivityRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve EDI documents associated with this order. 
      * Retrieve EDI documents associated with this order.

package/src/models/AutoOrder.ts

@@ -93,7 +93,7 @@ export interface AutoOrder {
      */
     cancel_downgrade?: boolean;
     /**
-     * The reason this auto order was canceled by either merchant or customer
+     * The reason this auto order was canceled by either merchant or customer. Supplying this when setting enabled to false records the change as a cancellation rather than a disable.
      * @type {string}
      * @memberof AutoOrder
      */
@@ -105,13 +105,13 @@ export interface AutoOrder {
      */
     cancel_upgrade?: boolean;
     /**
-     * The user that canceled the auto order
+     * The user that canceled the auto order. Supplying this when setting enabled to false records the change as a cancellation rather than a disable.
      * @type {string}
      * @memberof AutoOrder
      */
     canceled_by_user?: string;
     /**
-     * The date/time that the auto order was canceled
+     * The date/time that the auto order was canceled. Supply this to record an explicit cancellation time, otherwise it is stamped automatically when enabled is set to false along with cancel_reason or canceled_by_user.
      * @type {string}
      * @memberof AutoOrder
      */
@@ -129,7 +129,7 @@ export interface AutoOrder {
      */
     credit_card_attempt?: number;
     /**
-     * The date/time the auto order was disabled due to failed rebills
+     * The date/time the auto order was disabled, either by a failed rebill or by setting enabled to false without a cancellation
      * @type {string}
      * @memberof AutoOrder
      */
@@ -141,7 +141,7 @@ export interface AutoOrder {
      */
     emails?: Array<AutoOrderEmail>;
     /**
-     * True if this auto order is enabled
+     * True if this auto order is enabled. Setting this to false along with cancel_reason or canceled_by_user records the change as a cancellation and fires the auto order cancel notifications. Setting it to false without either field records a disable instead.
      * @type {boolean}
      * @memberof AutoOrder
      */

package/src/models/Metric.ts

@@ -19,6 +19,12 @@ import { exists, mapValues } from '../runtime';
  * @interface Metric
  */
 export interface Metric {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Metric
+     */
+    active?: boolean;
     /**
      * 
      * @type {number}
@@ -43,6 +49,12 @@ export interface Metric {
      * @memberof Metric
      */
     last_30_formatted?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Metric
+     */
+    last_activity_dts?: string;
     /**
      * 
      * @type {string}
@@ -90,10 +102,12 @@ export function MetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): Me
     }
     return {
         
+        'active': !exists(json, 'active') ? undefined : json['active'],
         'all_time': !exists(json, 'all_time') ? undefined : json['all_time'],
         'all_time_formatted': !exists(json, 'all_time_formatted') ? undefined : json['all_time_formatted'],
         'last_30': !exists(json, 'last_30') ? undefined : json['last_30'],
         'last_30_formatted': !exists(json, 'last_30_formatted') ? undefined : json['last_30_formatted'],
+        'last_activity_dts': !exists(json, 'last_activity_dts') ? undefined : json['last_activity_dts'],
         'name': !exists(json, 'name') ? undefined : json['name'],
         'prior_30': !exists(json, 'prior_30') ? undefined : json['prior_30'],
         'prior_30_formatted': !exists(json, 'prior_30_formatted') ? undefined : json['prior_30_formatted'],
@@ -110,10 +124,12 @@ export function MetricToJSON(value?: Metric | null): any {
     }
     return {
         
+        'active': value.active,
         'all_time': value.all_time,
         'all_time_formatted': value.all_time_formatted,
         'last_30': value.last_30,
         'last_30_formatted': value.last_30_formatted,
+        'last_activity_dts': value.last_activity_dts,
         'name': value.name,
         'prior_30': value.prior_30,
         'prior_30_formatted': value.prior_30_formatted,

package/src/models/OrderCustomerActivityResponse.ts

@@ -0,0 +1,132 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    CustomerActivity,
+    CustomerActivityFromJSON,
+    CustomerActivityFromJSONTyped,
+    CustomerActivityToJSON,
+} from './CustomerActivity';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface OrderCustomerActivityResponse
+ */
+export interface OrderCustomerActivityResponse {
+    /**
+     * 
+     * @type {CustomerActivity}
+     * @memberof OrderCustomerActivityResponse
+     */
+    customer_activity?: CustomerActivity;
+    /**
+     * Email address on the order that the customer activity was retrieved for
+     * @type {string}
+     * @memberof OrderCustomerActivityResponse
+     */
+    email?: string;
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof OrderCustomerActivityResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof OrderCustomerActivityResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof OrderCustomerActivityResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof OrderCustomerActivityResponse
+     */
+    warning?: Warning;
+}
+
+
+
+/**
+ * Check if a given object implements the OrderCustomerActivityResponse interface.
+ */
+export function instanceOfOrderCustomerActivityResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function OrderCustomerActivityResponseFromJSON(json: any): OrderCustomerActivityResponse {
+    return OrderCustomerActivityResponseFromJSONTyped(json, false);
+}
+
+export function OrderCustomerActivityResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCustomerActivityResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'customer_activity': !exists(json, 'customer_activity') ? undefined : CustomerActivityFromJSON(json['customer_activity']),
+        'email': !exists(json, 'email') ? undefined : json['email'],
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function OrderCustomerActivityResponseToJSON(value?: OrderCustomerActivityResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'customer_activity': CustomerActivityToJSON(value.customer_activity),
+        'email': value.email,
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -785,6 +785,7 @@ export * from './OrderChannelPartner';
 export * from './OrderCheckout';
 export * from './OrderCoupon';
 export * from './OrderCurrentStageHistory';
+export * from './OrderCustomerActivityResponse';
 export * from './OrderDigitalItem';
 export * from './OrderDigitalOrder';
 export * from './OrderEdi';