ultracart_rest_api_v2_typescript 4.1.120 → 4.1.121

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.120
+## ultracart_rest_api_v2_typescript@4.1.121
 
 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.120 --save
+npm install ultracart_rest_api_v2_typescript@4.1.121 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.121 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
 | 4.1.120 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
 | 4.1.119 | 07/15/2026 | order api - query transaction details for cache target |
 | 4.1.118 | 07/14/2026 | affiliate - send welcome letter method |

package/dist/apis/StorefrontApi.d.ts

@@ -223,6 +223,7 @@ export interface GetEmailCustomerDispatchLogsRequest {
     pageNumber?: number;
     pageSize?: number;
     scanForward?: boolean;
+    includeDetail?: boolean;
 }
 export interface GetEmailCustomerEditorUrlRequest {
     storefrontOid: number;
@@ -389,6 +390,7 @@ export interface GetEmailStepDispatchLogsRequest {
     until?: string;
     pageNumber?: number;
     pageSize?: number;
+    includeDetail?: boolean;
 }
 export interface GetEmailTemplateRequest {
     storefrontOid: number;
@@ -1526,6 +1528,7 @@ export interface StorefrontApiInterface {
      * @param {number} [pageNumber]
      * @param {number} [pageSize]
      * @param {boolean} [scanForward]
+     * @param {boolean} [includeDetail]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof StorefrontApiInterface
@@ -2090,7 +2093,7 @@ export interface StorefrontApiInterface {
      */
     getEmailStepDispatchLogDetail(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogDetailResponse>;
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
      * @summary Get a paginated, date-boundable dispatch-log feed for a step
      * @param {number} storefrontOid
      * @param {string} commseqUuid
@@ -2099,13 +2102,14 @@ export interface StorefrontApiInterface {
      * @param {string} [until]
      * @param {number} [pageNumber]
      * @param {number} [pageSize]
+     * @param {boolean} [includeDetail]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof StorefrontApiInterface
      */
     getEmailStepDispatchLogsRaw(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
      * Get a paginated, date-boundable dispatch-log feed for a step
      */
     getEmailStepDispatchLogs(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;
@@ -4194,12 +4198,12 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
      */
     getEmailStepDispatchLogDetail(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogDetailResponse>;
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
      * Get a paginated, date-boundable dispatch-log feed for a step
      */
     getEmailStepDispatchLogsRaw(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
      * Get a paginated, date-boundable dispatch-log feed for a step
      */
     getEmailStepDispatchLogs(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;

package/dist/apis/StorefrontApi.js

@@ -3387,6 +3387,9 @@ var StorefrontApi = /** @class */ (function (_super) {
                         if (requestParameters.scanForward !== undefined) {
                             queryParameters['scanForward'] = requestParameters.scanForward;
                         }
+                        if (requestParameters.includeDetail !== undefined) {
+                            queryParameters['includeDetail'] = requestParameters.includeDetail;
+                        }
                         headerParameters = {};
                         if (this.configuration && this.configuration.apiKey) {
                             headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
@@ -5916,7 +5919,7 @@ var StorefrontApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
      * Get a paginated, date-boundable dispatch-log feed for a step
      */
     StorefrontApi.prototype.getEmailStepDispatchLogsRaw = function (requestParameters, initOverrides) {
@@ -5947,6 +5950,9 @@ var StorefrontApi = /** @class */ (function (_super) {
                         if (requestParameters.pageSize !== undefined) {
                             queryParameters['pageSize'] = requestParameters.pageSize;
                         }
+                        if (requestParameters.includeDetail !== undefined) {
+                            queryParameters['includeDetail'] = requestParameters.includeDetail;
+                        }
                         headerParameters = {};
                         if (this.configuration && this.configuration.apiKey) {
                             headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
@@ -5978,7 +5984,7 @@ var StorefrontApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
      * Get a paginated, date-boundable dispatch-log feed for a step
      */
     StorefrontApi.prototype.getEmailStepDispatchLogs = function (requestParameters, initOverrides) {

package/dist/models/EmailDispatchLog.d.ts

@@ -15,6 +15,12 @@
  * @interface EmailDispatchLog
  */
 export interface EmailDispatchLog {
+    /**
+     * Dispatch detail text (free-form log of how the customer moved through the step)
+     * @type {string}
+     * @memberof EmailDispatchLog
+     */
+    detail?: string;
     /**
      * Customer email, resolved from the customer UUID for the page
      * @type {string}

package/dist/models/EmailDispatchLog.js

@@ -32,6 +32,7 @@ function EmailDispatchLogFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'detail': !(0, runtime_1.exists)(json, 'detail') ? undefined : json['detail'],
         'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
         'esp_commseq_step_uuid': !(0, runtime_1.exists)(json, 'esp_commseq_step_uuid') ? undefined : json['esp_commseq_step_uuid'],
         'esp_commseq_uuid': !(0, runtime_1.exists)(json, 'esp_commseq_uuid') ? undefined : json['esp_commseq_uuid'],
@@ -48,6 +49,7 @@ function EmailDispatchLogToJSON(value) {
         return null;
     }
     return {
+        'detail': value.detail,
         'email': value.email,
         'esp_commseq_step_uuid': value.esp_commseq_step_uuid,
         'esp_commseq_uuid': value.esp_commseq_uuid,

package/package.json

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

package/src/apis/StorefrontApi.ts

@@ -737,6 +737,7 @@ export interface GetEmailCustomerDispatchLogsRequest {
     pageNumber?: number;
     pageSize?: number;
     scanForward?: boolean;
+    includeDetail?: boolean;
 }
 
 export interface GetEmailCustomerEditorUrlRequest {
@@ -941,6 +942,7 @@ export interface GetEmailStepDispatchLogsRequest {
     until?: string;
     pageNumber?: number;
     pageSize?: number;
+    includeDetail?: boolean;
 }
 
 export interface GetEmailTemplateRequest {
@@ -2271,6 +2273,7 @@ export interface StorefrontApiInterface {
      * @param {number} [pageNumber] 
      * @param {number} [pageSize] 
      * @param {boolean} [scanForward] 
+     * @param {boolean} [includeDetail] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof StorefrontApiInterface
@@ -2915,7 +2918,7 @@ export interface StorefrontApiInterface {
     getEmailStepDispatchLogDetail(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogDetailResponse>;
 
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
      * @summary Get a paginated, date-boundable dispatch-log feed for a step
      * @param {number} storefrontOid 
      * @param {string} commseqUuid 
@@ -2924,6 +2927,7 @@ export interface StorefrontApiInterface {
      * @param {string} [until] 
      * @param {number} [pageNumber] 
      * @param {number} [pageSize] 
+     * @param {boolean} [includeDetail] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof StorefrontApiInterface
@@ -2931,7 +2935,7 @@ export interface StorefrontApiInterface {
     getEmailStepDispatchLogsRaw(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
 
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
      * Get a paginated, date-boundable dispatch-log feed for a step
      */
     getEmailStepDispatchLogs(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;
@@ -6949,6 +6953,10 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
             queryParameters['scanForward'] = requestParameters.scanForward;
         }
 
+        if (requestParameters.includeDetail !== undefined) {
+            queryParameters['includeDetail'] = requestParameters.includeDetail;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.apiKey) {
@@ -8847,7 +8855,7 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
     }
 
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
      * Get a paginated, date-boundable dispatch-log feed for a step
      */
     async getEmailStepDispatchLogsRaw(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>> {
@@ -8881,6 +8889,10 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
             queryParameters['pageSize'] = requestParameters.pageSize;
         }
 
+        if (requestParameters.includeDetail !== undefined) {
+            queryParameters['includeDetail'] = requestParameters.includeDetail;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.apiKey) {
@@ -8907,7 +8919,7 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
     }
 
     /**
-     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
+     * Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean unless includeDetail is passed as true, rendered from the DynamoDB keys; fetch a row\'s full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response \'more\' flag is false. since/until are inclusive ISO-8601 bounds on log_dts. 
      * Get a paginated, date-boundable dispatch-log feed for a step
      */
     async getEmailStepDispatchLogs(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse> {

package/src/models/EmailDispatchLog.ts

@@ -19,6 +19,12 @@ import { exists, mapValues } from '../runtime';
  * @interface EmailDispatchLog
  */
 export interface EmailDispatchLog {
+    /**
+     * Dispatch detail text (free-form log of how the customer moved through the step)
+     * @type {string}
+     * @memberof EmailDispatchLog
+     */
+    detail?: string;
     /**
      * Customer email, resolved from the customer UUID for the page
      * @type {string}
@@ -72,6 +78,7 @@ export function EmailDispatchLogFromJSONTyped(json: any, ignoreDiscriminator: bo
     }
     return {
         
+        'detail': !exists(json, 'detail') ? undefined : json['detail'],
         'email': !exists(json, 'email') ? undefined : json['email'],
         'esp_commseq_step_uuid': !exists(json, 'esp_commseq_step_uuid') ? undefined : json['esp_commseq_step_uuid'],
         'esp_commseq_uuid': !exists(json, 'esp_commseq_uuid') ? undefined : json['esp_commseq_uuid'],
@@ -89,6 +96,7 @@ export function EmailDispatchLogToJSON(value?: EmailDispatchLog | null): any {
     }
     return {
         
+        'detail': value.detail,
         'email': value.email,
         'esp_commseq_step_uuid': value.esp_commseq_step_uuid,
         'esp_commseq_uuid': value.esp_commseq_uuid,