ultracart_rest_api_v2_typescript 4.1.98 → 4.1.100

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.98
+## ultracart_rest_api_v2_typescript@4.1.100
 
 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.98 --save
+npm install ultracart_rest_api_v2_typescript@4.1.100 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.100 | 06/05/2026 | webhook log summary filtering |
+| 4.1.99 | 06/05/2026 | added webhook name and merchant_comments |
 | 4.1.98 | 06/04/2026 | coupon - new coupon type for amount off items with free shipping |
 | 4.1.97 | 06/03/2026 | fraud api alpha version |
 | 4.1.96 | 06/03/2026 | fraud api alpha build |

package/dist/apis/WebhookApi.d.ts

@@ -23,6 +23,15 @@ export interface GetWebhookLogRequest {
 }
 export interface GetWebhookLogSummariesRequest {
     webhookOid: number;
+    requestId?: string;
+    beginDate?: string;
+    endDate?: string;
+    status?: string;
+    success?: boolean;
+    event?: string;
+    orderId?: string;
+    request?: string;
+    duration?: number;
     limit?: number;
     offset?: number;
     since?: string;
@@ -113,6 +122,15 @@ export interface WebhookApiInterface {
      * Retrieves the log summary information for a given webhook.  This is useful for displaying all the various logs that can be viewed.
      * @summary Retrieve the log summaries
      * @param {number} webhookOid The webhook oid to retrieve log summaries for.
+     * @param {string} [requestId] Filter by request id
+     * @param {string} [beginDate] Filter to deliveries on or after this date/time
+     * @param {string} [endDate] Filter to deliveries on or before this date/time
+     * @param {string} [status] Filter by HTTP status code
+     * @param {boolean} [success] Filter by success (true) or failure (false)
+     * @param {string} [event] Filter by an event name contained in the delivery
+     * @param {string} [orderId] Filter by an order id contained in the delivery
+     * @param {string} [request] Filter by text contained in the request payload
+     * @param {number} [duration] Filter to deliveries that took at least this many milliseconds
      * @param {number} [limit] The maximum number of records to return on this one API call.
      * @param {number} [offset] Pagination of the record set.  Offset is a zero based index.
      * @param {string} [since] Fetch log summaries that have been delivered since this date/time.

package/dist/apis/WebhookApi.js

@@ -325,6 +325,33 @@ var WebhookApi = /** @class */ (function (_super) {
                             throw new runtime.RequiredError('webhookOid', 'Required parameter requestParameters.webhookOid was null or undefined when calling getWebhookLogSummaries.');
                         }
                         queryParameters = {};
+                        if (requestParameters.requestId !== undefined) {
+                            queryParameters['requestId'] = requestParameters.requestId;
+                        }
+                        if (requestParameters.beginDate !== undefined) {
+                            queryParameters['beginDate'] = requestParameters.beginDate;
+                        }
+                        if (requestParameters.endDate !== undefined) {
+                            queryParameters['endDate'] = requestParameters.endDate;
+                        }
+                        if (requestParameters.status !== undefined) {
+                            queryParameters['status'] = requestParameters.status;
+                        }
+                        if (requestParameters.success !== undefined) {
+                            queryParameters['success'] = requestParameters.success;
+                        }
+                        if (requestParameters.event !== undefined) {
+                            queryParameters['event'] = requestParameters.event;
+                        }
+                        if (requestParameters.orderId !== undefined) {
+                            queryParameters['orderId'] = requestParameters.orderId;
+                        }
+                        if (requestParameters.request !== undefined) {
+                            queryParameters['request'] = requestParameters.request;
+                        }
+                        if (requestParameters.duration !== undefined) {
+                            queryParameters['duration'] = requestParameters.duration;
+                        }
                         if (requestParameters.limit !== undefined) {
                             queryParameters['_limit'] = requestParameters.limit;
                         }

package/dist/models/Webhook.d.ts

@@ -101,12 +101,24 @@ export interface Webhook {
      * @memberof Webhook
      */
     maximum_size?: number;
+    /**
+     * Merchant comments about this webhook
+     * @type {string}
+     * @memberof Webhook
+     */
+    merchant_comments?: string;
     /**
      * The UltraCart merchant ID that owns this webhook
      * @type {string}
      * @memberof Webhook
      */
     merchant_id?: string;
+    /**
+     * Friendly name to help identify this webhook
+     * @type {string}
+     * @memberof Webhook
+     */
+    name?: string;
     /**
      * The next time UltraCart will attempt delivery if failures have been occurring
      * @type {string}

package/dist/models/Webhook.js

@@ -63,7 +63,9 @@ function WebhookFromJSONTyped(json, ignoreDiscriminator) {
         'iam_secret_key': !(0, runtime_1.exists)(json, 'iam_secret_key') ? undefined : json['iam_secret_key'],
         'maximum_events': !(0, runtime_1.exists)(json, 'maximum_events') ? undefined : json['maximum_events'],
         'maximum_size': !(0, runtime_1.exists)(json, 'maximum_size') ? undefined : json['maximum_size'],
+        'merchant_comments': !(0, runtime_1.exists)(json, 'merchant_comments') ? undefined : json['merchant_comments'],
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
         'next_retry_after': !(0, runtime_1.exists)(json, 'next_retry_after') ? undefined : json['next_retry_after'],
         'pending': !(0, runtime_1.exists)(json, 'pending') ? undefined : json['pending'],
         'webhook_oid': !(0, runtime_1.exists)(json, 'webhook_oid') ? undefined : json['webhook_oid'],
@@ -93,7 +95,9 @@ function WebhookToJSON(value) {
         'iam_secret_key': value.iam_secret_key,
         'maximum_events': value.maximum_events,
         'maximum_size': value.maximum_size,
+        'merchant_comments': value.merchant_comments,
         'merchant_id': value.merchant_id,
+        'name': value.name,
         'next_retry_after': value.next_retry_after,
         'pending': value.pending,
         'webhook_oid': value.webhook_oid,

package/dist/models/WebhookLog.d.ts

@@ -28,6 +28,18 @@ export interface WebhookLog {
      * @memberof WebhookLog
      */
     duration?: number;
+    /**
+     * Event names contained in this delivery
+     * @type {Array<string>}
+     * @memberof WebhookLog
+     */
+    event_names?: Array<string>;
+    /**
+     * Order ids contained in this delivery
+     * @type {Array<string>}
+     * @memberof WebhookLog
+     */
+    order_ids?: Array<string>;
     /**
      * Number of milliseconds of delay caused by queuing
      * @type {number}

package/dist/models/WebhookLog.js

@@ -35,6 +35,8 @@ function WebhookLogFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'delivery_dts': !(0, runtime_1.exists)(json, 'delivery_dts') ? undefined : json['delivery_dts'],
         'duration': !(0, runtime_1.exists)(json, 'duration') ? undefined : json['duration'],
+        'event_names': !(0, runtime_1.exists)(json, 'event_names') ? undefined : json['event_names'],
+        'order_ids': !(0, runtime_1.exists)(json, 'order_ids') ? undefined : json['order_ids'],
         'queue_delay': !(0, runtime_1.exists)(json, 'queue_delay') ? undefined : json['queue_delay'],
         'request': !(0, runtime_1.exists)(json, 'request') ? undefined : json['request'],
         'request_headers': !(0, runtime_1.exists)(json, 'request_headers') ? undefined : (json['request_headers'].map(HTTPHeader_1.HTTPHeaderFromJSON)),
@@ -58,6 +60,8 @@ function WebhookLogToJSON(value) {
     return {
         'delivery_dts': value.delivery_dts,
         'duration': value.duration,
+        'event_names': value.event_names,
+        'order_ids': value.order_ids,
         'queue_delay': value.queue_delay,
         'request': value.request,
         'request_headers': value.request_headers === undefined ? undefined : (value.request_headers.map(HTTPHeader_1.HTTPHeaderToJSON)),

package/dist/models/WebhookLogSummary.d.ts

@@ -21,12 +21,36 @@ export interface WebhookLogSummary {
      * @memberof WebhookLogSummary
      */
     delivery_dts?: string;
+    /**
+     * Number of milliseconds to process the notification
+     * @type {number}
+     * @memberof WebhookLogSummary
+     */
+    duration?: number;
+    /**
+     * Event names contained in this delivery
+     * @type {Array<string>}
+     * @memberof WebhookLogSummary
+     */
+    event_names?: Array<string>;
+    /**
+     * Order ids contained in this delivery
+     * @type {Array<string>}
+     * @memberof WebhookLogSummary
+     */
+    order_ids?: Array<string>;
     /**
      * Request id
      * @type {string}
      * @memberof WebhookLogSummary
      */
     request_id?: string;
+    /**
+     * HTTP status code received from the server
+     * @type {number}
+     * @memberof WebhookLogSummary
+     */
+    status_code?: number;
     /**
      * True if the notification was successful
      * @type {boolean}

package/dist/models/WebhookLogSummary.js

@@ -33,7 +33,11 @@ function WebhookLogSummaryFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'delivery_dts': !(0, runtime_1.exists)(json, 'delivery_dts') ? undefined : json['delivery_dts'],
+        'duration': !(0, runtime_1.exists)(json, 'duration') ? undefined : json['duration'],
+        'event_names': !(0, runtime_1.exists)(json, 'event_names') ? undefined : json['event_names'],
+        'order_ids': !(0, runtime_1.exists)(json, 'order_ids') ? undefined : json['order_ids'],
         'request_id': !(0, runtime_1.exists)(json, 'request_id') ? undefined : json['request_id'],
+        'status_code': !(0, runtime_1.exists)(json, 'status_code') ? undefined : json['status_code'],
         'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
     };
 }
@@ -47,7 +51,11 @@ function WebhookLogSummaryToJSON(value) {
     }
     return {
         'delivery_dts': value.delivery_dts,
+        'duration': value.duration,
+        'event_names': value.event_names,
+        'order_ids': value.order_ids,
         'request_id': value.request_id,
+        'status_code': value.status_code,
         'success': value.success,
     };
 }

package/package.json

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

package/src/apis/WebhookApi.ts

@@ -56,6 +56,15 @@ export interface GetWebhookLogRequest {
 
 export interface GetWebhookLogSummariesRequest {
     webhookOid: number;
+    requestId?: string;
+    beginDate?: string;
+    endDate?: string;
+    status?: string;
+    success?: boolean;
+    event?: string;
+    orderId?: string;
+    request?: string;
+    duration?: number;
     limit?: number;
     offset?: number;
     since?: string;
@@ -159,6 +168,15 @@ export interface WebhookApiInterface {
      * Retrieves the log summary information for a given webhook.  This is useful for displaying all the various logs that can be viewed. 
      * @summary Retrieve the log summaries
      * @param {number} webhookOid The webhook oid to retrieve log summaries for.
+     * @param {string} [requestId] Filter by request id
+     * @param {string} [beginDate] Filter to deliveries on or after this date/time
+     * @param {string} [endDate] Filter to deliveries on or before this date/time
+     * @param {string} [status] Filter by HTTP status code
+     * @param {boolean} [success] Filter by success (true) or failure (false)
+     * @param {string} [event] Filter by an event name contained in the delivery
+     * @param {string} [orderId] Filter by an order id contained in the delivery
+     * @param {string} [request] Filter by text contained in the request payload
+     * @param {number} [duration] Filter to deliveries that took at least this many milliseconds
      * @param {number} [limit] The maximum number of records to return on this one API call.
      * @param {number} [offset] Pagination of the record set.  Offset is a zero based index.
      * @param {string} [since] Fetch log summaries that have been delivered since this date/time.
@@ -429,6 +447,42 @@ export class WebhookApi extends runtime.BaseAPI implements WebhookApiInterface {
 
         const queryParameters: any = {};
 
+        if (requestParameters.requestId !== undefined) {
+            queryParameters['requestId'] = requestParameters.requestId;
+        }
+
+        if (requestParameters.beginDate !== undefined) {
+            queryParameters['beginDate'] = requestParameters.beginDate;
+        }
+
+        if (requestParameters.endDate !== undefined) {
+            queryParameters['endDate'] = requestParameters.endDate;
+        }
+
+        if (requestParameters.status !== undefined) {
+            queryParameters['status'] = requestParameters.status;
+        }
+
+        if (requestParameters.success !== undefined) {
+            queryParameters['success'] = requestParameters.success;
+        }
+
+        if (requestParameters.event !== undefined) {
+            queryParameters['event'] = requestParameters.event;
+        }
+
+        if (requestParameters.orderId !== undefined) {
+            queryParameters['orderId'] = requestParameters.orderId;
+        }
+
+        if (requestParameters.request !== undefined) {
+            queryParameters['request'] = requestParameters.request;
+        }
+
+        if (requestParameters.duration !== undefined) {
+            queryParameters['duration'] = requestParameters.duration;
+        }
+
         if (requestParameters.limit !== undefined) {
             queryParameters['_limit'] = requestParameters.limit;
         }

package/src/models/Webhook.ts

@@ -116,12 +116,24 @@ export interface Webhook {
      * @memberof Webhook
      */
     maximum_size?: number;
+    /**
+     * Merchant comments about this webhook
+     * @type {string}
+     * @memberof Webhook
+     */
+    merchant_comments?: string;
     /**
      * The UltraCart merchant ID that owns this webhook
      * @type {string}
      * @memberof Webhook
      */
     merchant_id?: string;
+    /**
+     * Friendly name to help identify this webhook
+     * @type {string}
+     * @memberof Webhook
+     */
+    name?: string;
     /**
      * The next time UltraCart will attempt delivery if failures have been occurring
      * @type {string}
@@ -203,7 +215,9 @@ export function WebhookFromJSONTyped(json: any, ignoreDiscriminator: boolean): W
         'iam_secret_key': !exists(json, 'iam_secret_key') ? undefined : json['iam_secret_key'],
         'maximum_events': !exists(json, 'maximum_events') ? undefined : json['maximum_events'],
         'maximum_size': !exists(json, 'maximum_size') ? undefined : json['maximum_size'],
+        'merchant_comments': !exists(json, 'merchant_comments') ? undefined : json['merchant_comments'],
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
         'next_retry_after': !exists(json, 'next_retry_after') ? undefined : json['next_retry_after'],
         'pending': !exists(json, 'pending') ? undefined : json['pending'],
         'webhook_oid': !exists(json, 'webhook_oid') ? undefined : json['webhook_oid'],
@@ -234,7 +248,9 @@ export function WebhookToJSON(value?: Webhook | null): any {
         'iam_secret_key': value.iam_secret_key,
         'maximum_events': value.maximum_events,
         'maximum_size': value.maximum_size,
+        'merchant_comments': value.merchant_comments,
         'merchant_id': value.merchant_id,
+        'name': value.name,
         'next_retry_after': value.next_retry_after,
         'pending': value.pending,
         'webhook_oid': value.webhook_oid,

package/src/models/WebhookLog.ts

@@ -38,6 +38,18 @@ export interface WebhookLog {
      * @memberof WebhookLog
      */
     duration?: number;
+    /**
+     * Event names contained in this delivery
+     * @type {Array<string>}
+     * @memberof WebhookLog
+     */
+    event_names?: Array<string>;
+    /**
+     * Order ids contained in this delivery
+     * @type {Array<string>}
+     * @memberof WebhookLog
+     */
+    order_ids?: Array<string>;
     /**
      * Number of milliseconds of delay caused by queuing
      * @type {number}
@@ -123,6 +135,8 @@ export function WebhookLogFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         
         'delivery_dts': !exists(json, 'delivery_dts') ? undefined : json['delivery_dts'],
         'duration': !exists(json, 'duration') ? undefined : json['duration'],
+        'event_names': !exists(json, 'event_names') ? undefined : json['event_names'],
+        'order_ids': !exists(json, 'order_ids') ? undefined : json['order_ids'],
         'queue_delay': !exists(json, 'queue_delay') ? undefined : json['queue_delay'],
         'request': !exists(json, 'request') ? undefined : json['request'],
         'request_headers': !exists(json, 'request_headers') ? undefined : ((json['request_headers'] as Array<any>).map(HTTPHeaderFromJSON)),
@@ -147,6 +161,8 @@ export function WebhookLogToJSON(value?: WebhookLog | null): any {
         
         'delivery_dts': value.delivery_dts,
         'duration': value.duration,
+        'event_names': value.event_names,
+        'order_ids': value.order_ids,
         'queue_delay': value.queue_delay,
         'request': value.request,
         'request_headers': value.request_headers === undefined ? undefined : ((value.request_headers as Array<any>).map(HTTPHeaderToJSON)),

package/src/models/WebhookLogSummary.ts

@@ -25,12 +25,36 @@ export interface WebhookLogSummary {
      * @memberof WebhookLogSummary
      */
     delivery_dts?: string;
+    /**
+     * Number of milliseconds to process the notification
+     * @type {number}
+     * @memberof WebhookLogSummary
+     */
+    duration?: number;
+    /**
+     * Event names contained in this delivery
+     * @type {Array<string>}
+     * @memberof WebhookLogSummary
+     */
+    event_names?: Array<string>;
+    /**
+     * Order ids contained in this delivery
+     * @type {Array<string>}
+     * @memberof WebhookLogSummary
+     */
+    order_ids?: Array<string>;
     /**
      * Request id
      * @type {string}
      * @memberof WebhookLogSummary
      */
     request_id?: string;
+    /**
+     * HTTP status code received from the server
+     * @type {number}
+     * @memberof WebhookLogSummary
+     */
+    status_code?: number;
     /**
      * True if the notification was successful
      * @type {boolean}
@@ -61,7 +85,11 @@ export function WebhookLogSummaryFromJSONTyped(json: any, ignoreDiscriminator: b
     return {
         
         'delivery_dts': !exists(json, 'delivery_dts') ? undefined : json['delivery_dts'],
+        'duration': !exists(json, 'duration') ? undefined : json['duration'],
+        'event_names': !exists(json, 'event_names') ? undefined : json['event_names'],
+        'order_ids': !exists(json, 'order_ids') ? undefined : json['order_ids'],
         'request_id': !exists(json, 'request_id') ? undefined : json['request_id'],
+        'status_code': !exists(json, 'status_code') ? undefined : json['status_code'],
         'success': !exists(json, 'success') ? undefined : json['success'],
     };
 }
@@ -76,7 +104,11 @@ export function WebhookLogSummaryToJSON(value?: WebhookLogSummary | null): any {
     return {
         
         'delivery_dts': value.delivery_dts,
+        'duration': value.duration,
+        'event_names': value.event_names,
+        'order_ids': value.order_ids,
         'request_id': value.request_id,
+        'status_code': value.status_code,
         'success': value.success,
     };
 }